mirror of
https://github.com/xtr-dev/payload-billing.git
synced 2025-12-10 19:03:23 +00:00
Core Plugin Enhancements: - Add afterChange hook to payments collection to auto-update linked invoice status to 'paid' when payment succeeds - Add afterChange hook to invoices collection for bidirectional payment-invoice relationship management - Add invoice status sync when manually marked as paid - Update plugin config types to support collection extension options Demo Application Features: - Add professional invoice view page with print-friendly layout (/invoice/[id]) - Add custom message field to payment creation form - Add invoice API endpoint to fetch complete invoice data with customer info - Add payment API endpoint to retrieve payment with invoice relationship - Update payment success page with "View Invoice" button - Implement beforeChange hook to copy custom message from payment metadata to invoice - Remove customer collection dependency - use direct customerInfo fields instead Documentation: - Update README with automatic status synchronization section - Add collection extension examples to demo README - Document new features: bidirectional relationships, status sync, invoice view Technical Improvements: - Fix total calculation in invoice API (use 'amount' field instead of 'total') - Add proper TypeScript types with CollectionSlug casting - Implement Next.js 15 async params pattern in API routes - Add customer name/email/company fields to payment creation form 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
133 lines
4.2 KiB
TypeScript
133 lines
4.2 KiB
TypeScript
import { sqliteAdapter } from '@payloadcms/db-sqlite'
|
|
import { lexicalEditor } from '@payloadcms/richtext-lexical'
|
|
import path from 'path'
|
|
import { buildConfig } from 'payload'
|
|
import sharp from 'sharp'
|
|
import { fileURLToPath } from 'url'
|
|
|
|
import { testEmailAdapter } from './helpers/testEmailAdapter'
|
|
import { seed } from './seed'
|
|
import billingPlugin from '../src/plugin'
|
|
import { testProvider } from '../src/providers'
|
|
|
|
const filename = fileURLToPath(import.meta.url)
|
|
const dirname = path.dirname(filename)
|
|
|
|
if (!process.env.ROOT_DIR) {
|
|
process.env.ROOT_DIR = dirname
|
|
}
|
|
|
|
const buildConfigWithSQLite = () => {
|
|
return buildConfig({
|
|
admin: {
|
|
importMap: {
|
|
baseDir: path.resolve(dirname),
|
|
},
|
|
},
|
|
collections: [
|
|
{
|
|
slug: 'posts',
|
|
fields: [],
|
|
},
|
|
{
|
|
slug: 'media',
|
|
fields: [],
|
|
upload: {
|
|
staticDir: path.resolve(dirname, 'media'),
|
|
},
|
|
},
|
|
// Note: No customers collection - the demo uses direct customerInfo fields on invoices
|
|
],
|
|
db: sqliteAdapter({
|
|
client: {
|
|
url: `file:${path.resolve(dirname, 'payload.sqlite')}`,
|
|
},
|
|
}),
|
|
editor: lexicalEditor(),
|
|
email: testEmailAdapter,
|
|
onInit: async (payload) => {
|
|
await seed(payload)
|
|
},
|
|
plugins: [
|
|
billingPlugin({
|
|
providers: [
|
|
testProvider({
|
|
enabled: true,
|
|
testModeIndicators: {
|
|
showWarningBanners: true,
|
|
showTestBadges: true,
|
|
consoleWarnings: true
|
|
},
|
|
customUiRoute: '/test-payment',
|
|
})
|
|
],
|
|
collections: {
|
|
payments: 'payments',
|
|
invoices: {
|
|
slug: 'invoices',
|
|
// Use extend to add custom fields and hooks to the invoice collection
|
|
extend: (config) => ({
|
|
...config,
|
|
fields: [
|
|
...(config.fields || []),
|
|
// Add a custom message field to invoices
|
|
{
|
|
name: 'customMessage',
|
|
type: 'textarea',
|
|
admin: {
|
|
description: 'Custom message from the payment (auto-populated)',
|
|
},
|
|
},
|
|
],
|
|
hooks: {
|
|
...config.hooks,
|
|
beforeChange: [
|
|
...(config.hooks?.beforeChange || []),
|
|
// Hook to copy the message from payment metadata to invoice
|
|
async ({ data, req, operation }) => {
|
|
// Only run on create operations
|
|
if (operation === 'create' && data.payment) {
|
|
try {
|
|
// Fetch the related payment
|
|
const payment = await req.payload.findByID({
|
|
collection: 'payments',
|
|
id: typeof data.payment === 'object' ? data.payment.id : data.payment,
|
|
})
|
|
|
|
// Copy the custom message from payment metadata to invoice
|
|
if (
|
|
payment?.metadata &&
|
|
typeof payment.metadata === 'object' &&
|
|
'customMessage' in payment.metadata &&
|
|
payment.metadata.customMessage
|
|
) {
|
|
data.customMessage = payment.metadata.customMessage as string
|
|
}
|
|
} catch (error) {
|
|
// Log error but don't fail the invoice creation
|
|
req.payload.logger.error('Failed to copy custom message to invoice:', error)
|
|
}
|
|
}
|
|
return data
|
|
},
|
|
],
|
|
},
|
|
}),
|
|
},
|
|
refunds: 'refunds',
|
|
},
|
|
// Note: No customerRelationSlug or customerInfoExtractor configured
|
|
// This allows the demo to work without a customer collection
|
|
// Invoices will use the direct customerInfo and billingAddress fields
|
|
}),
|
|
],
|
|
secret: process.env.PAYLOAD_SECRET || 'test-secret_key',
|
|
sharp,
|
|
typescript: {
|
|
outputFile: path.resolve(dirname, 'payload-types.ts'),
|
|
},
|
|
})
|
|
}
|
|
|
|
export default buildConfigWithSQLite()
|