Merge pull request #19 from xtr-dev/dev

chore: remove deprecated Claude workflows

.github/workflows/claude-code-review.yml

@@ -12,11 +12,8 @@ on:
 
 jobs:
   claude-review:
-    # Optional: Filter by PR author
+    # Only allow bvdaakster to trigger reviews
-    # if: |
+    if: github.event.pull_request.user.login == 'bvdaakster'
-    #   github.event.pull_request.user.login == 'external-contributor' ||
-    #   github.event.pull_request.user.login == 'new-developer' ||
-    #   github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR'
     
     runs-on: ubuntu-latest
     permissions:

README.md

@@ -1,17 +1,19 @@
 # @xtr-dev/payload-billing
 
-A billing and payment provider plugin for PayloadCMS 3.x. Supports Stripe, Mollie, and local testing with comprehensive tracking.
+A billing and payment provider plugin for PayloadCMS 3.x. Supports Stripe, Mollie, and local testing with comprehensive tracking and flexible customer data management.
 
-⚠️ **Pre-release Warning**: This package is currently in active development (v0.0.x). Breaking changes may occur before v1.0.0. Not recommended for production use.
+⚠️ **Pre-release Warning**: This package is currently in active development (v0.1.x). Breaking changes may occur before v1.0.0. Not recommended for production use.
 
 ## Features
 
 - 💳 Multiple payment providers (Stripe, Mollie, Test)
-- 🧾 Invoice generation and management
+- 🧾 Invoice generation and management with embedded customer info
+- 👥 Flexible customer data management with relationship support
 - 📊 Complete payment tracking and history
 - 🪝 Secure webhook processing for all providers
 - 🧪 Built-in test provider for local development
 - 📱 Payment management in PayloadCMS admin
+- 🔄 Callback-based customer data syncing
 - 🔒 Full TypeScript support
 
 ## Installation
@@ -42,6 +44,8 @@ pnpm add @mollie/api-client
 
 ## Quick Start
 
+### Basic Configuration
+
 ```typescript
 import { buildConfig } from 'payload'
 import { billingPlugin, stripeProvider, mollieProvider } from '@xtr-dev/payload-billing'
@@ -70,6 +74,68 @@ export default buildConfig({
 })
 ```
 
+### With Customer Management
+
+```typescript
+import { billingPlugin, CustomerInfoExtractor } from '@xtr-dev/payload-billing'
+
+// Define how to extract customer info from your customer collection
+const customerExtractor: CustomerInfoExtractor = (customer) => ({
+  name: customer.name,
+  email: customer.email,
+  phone: customer.phone,
+  company: customer.company,
+  taxId: customer.taxId,
+  billingAddress: {
+    line1: customer.address.line1,
+    line2: customer.address.line2,
+    city: customer.address.city,
+    state: customer.address.state,
+    postalCode: customer.address.postalCode,
+    country: customer.address.country,
+  }
+})
+
+billingPlugin({
+  // ... providers
+  collections: {
+    payments: 'payments',
+    invoices: 'invoices',
+    refunds: 'refunds',
+  },
+  customerRelationSlug: 'customers', // Enable customer relationships
+  customerInfoExtractor: customerExtractor, // Auto-sync customer data
+})
+```
+
+### Custom Customer Data Extraction
+
+```typescript
+import { CustomerInfoExtractor } from '@xtr-dev/payload-billing'
+
+const customExtractor: CustomerInfoExtractor = (customer) => ({
+  name: customer.fullName,
+  email: customer.contactEmail,
+  phone: customer.phoneNumber,
+  company: customer.companyName,
+  taxId: customer.vatNumber,
+  billingAddress: {
+    line1: customer.billing.street,
+    line2: customer.billing.apartment,
+    city: customer.billing.city,
+    state: customer.billing.state,
+    postalCode: customer.billing.zip,
+    country: customer.billing.countryCode,
+  }
+})
+
+billingPlugin({
+  // ... other config
+  customerRelationSlug: 'clients',
+  customerInfoExtractor: customExtractor,
+})
+```
+
 ## Imports
 
 ```typescript
@@ -80,7 +146,17 @@ import { billingPlugin } from '@xtr-dev/payload-billing'
 import { stripeProvider, mollieProvider } from '@xtr-dev/payload-billing'
 
 // Types
-import type { PaymentProvider, Payment, Invoice, Refund } from '@xtr-dev/payload-billing'
+import type { 
+  PaymentProvider, 
+  Payment, 
+  Invoice, 
+  Refund,
+  BillingPluginConfig,
+  CustomerInfoExtractor,
+  MollieProviderConfig,
+  StripeProviderConfig,
+  ProviderData
+} from '@xtr-dev/payload-billing'
 ```
 
 ## Provider Types
@@ -99,9 +175,19 @@ Local development testing with configurable scenarios, automatic completion, deb
 The plugin adds these collections:
 
 - **payments** - Payment transactions with status and provider data
-- **invoices** - Invoice generation with line items and PDF support
+- **invoices** - Invoice generation with line items and embedded customer info
 - **refunds** - Refund tracking and management
 
+### Customer Data Management
+
+The plugin supports flexible customer data handling:
+
+1. **With Customer Relationship + Extractor**: Customer relationship required, customer info auto-populated and read-only, syncs automatically when customer changes
+
+2. **With Customer Relationship (no extractor)**: Customer relationship optional, customer info manually editable, either relationship OR customer info required
+
+3. **No Customer Collection**: Customer info fields always required and editable, no relationship field available
+
 ## Webhook Endpoints
 
 Automatic webhook endpoints are created for configured providers:

dev/payload-types.ts

@@ -158,7 +158,7 @@ export interface Payment {
   /**
    * The payment ID from the payment provider
    */
-  providerId: string;
+  providerId?: string | null;
   status: 'pending' | 'processing' | 'succeeded' | 'failed' | 'canceled' | 'refunded' | 'partially_refunded';
   /**
    * Amount in cents (e.g., 2000 = $20.00)
@@ -198,6 +198,7 @@ export interface Payment {
     | boolean
     | null;
   refunds?: (number | Refund)[] | null;
+  version?: number | null;
   updatedAt: string;
   createdAt: string;
 }
@@ -499,6 +500,7 @@ export interface PaymentsSelect<T extends boolean = true> {
   metadata?: T;
   providerData?: T;
   refunds?: T;
+  version?: T;
   updatedAt?: T;
   createdAt?: T;
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xtr-dev/payload-billing",
-  "version": "0.1.4",
+  "version": "0.1.7",
   "description": "PayloadCMS plugin for billing and payment provider integrations with tracking and local testing",
   "license": "MIT",
   "type": "module",
@@ -106,7 +106,7 @@
     "vitest": "^3.1.2"
   },
   "peerDependencies": {
-    "@mollie/api-client": "^3.7.0",
+    "@mollie/api-client": "^3.7.0 || ^4.0.0",
     "payload": "^3.37.0",
     "stripe": "^18.5.0"
   },

src/collections/hooks.ts

@@ -1,6 +1,6 @@
-import type { Payment } from '@/plugin/types'
+import type { Payment } from '../plugin/types/index.js'
 import type { Payload } from 'payload'
-import { useBillingPlugin } from '@/plugin'
+import { useBillingPlugin } from '../plugin/index.js'
 
 export const initProviderPayment = (payload: Payload, payment: Partial<Payment>) => {
   const billing = useBillingPlugin(payload)

src/collections/index.ts

@@ -1,3 +1,3 @@
-export { createInvoicesCollection } from './invoices'
+export { createInvoicesCollection } from './invoices.js'
-export { createPaymentsCollection } from './payments'
+export { createPaymentsCollection } from './payments.js'
-export { createRefundsCollection } from './refunds'
+export { createRefundsCollection } from './refunds.js'

src/collections/invoices.ts

@@ -5,10 +5,10 @@ import {
   CollectionBeforeValidateHook,
   CollectionConfig, Field,
 } from 'payload'
-import type { BillingPluginConfig} from '@/plugin/config';
+import type { BillingPluginConfig} from '../plugin/config.js';
-import { defaults } from '@/plugin/config'
+import { defaults } from '../plugin/config.js'
-import { extractSlug } from '@/plugin/utils'
+import { extractSlug } from '../plugin/utils.js'
-import type { Invoice } from '@/plugin/types/invoices'
+import type { Invoice } from '../plugin/types/invoices.js'
 
 export function createInvoicesCollection(pluginConfig: BillingPluginConfig): CollectionConfig {
   const {customerRelationSlug, customerInfoExtractor} = pluginConfig

src/collections/payments.ts

@@ -1,9 +1,9 @@
 import type { AccessArgs, CollectionBeforeChangeHook, CollectionConfig, Field } from 'payload'
-import type { BillingPluginConfig} from '@/plugin/config';
+import type { BillingPluginConfig} from '../plugin/config.js';
-import { defaults } from '@/plugin/config'
+import { defaults } from '../plugin/config.js'
-import { extractSlug } from '@/plugin/utils'
+import { extractSlug } from '../plugin/utils.js'
-import type { Payment } from '@/plugin/types/payments'
+import type { Payment } from '../plugin/types/payments.js'
-import { initProviderPayment } from '@/collections/hooks'
+import { initProviderPayment } from './hooks.js'
 
 export function createPaymentsCollection(pluginConfig: BillingPluginConfig): CollectionConfig {
   const overrides = typeof pluginConfig.collections?.payments === 'object' ? pluginConfig.collections?.payments : {}

src/collections/refunds.ts

@@ -1,7 +1,7 @@
 import type { AccessArgs, CollectionConfig } from 'payload'
-import { BillingPluginConfig, defaults } from '@/plugin/config'
+import { BillingPluginConfig, defaults } from '../plugin/config.js'
-import { extractSlug } from '@/plugin/utils'
+import { extractSlug } from '../plugin/utils.js'
-import { Payment } from '@/plugin/types'
+import { Payment } from '../plugin/types/index.js'
 
 export function createRefundsCollection(pluginConfig: BillingPluginConfig): CollectionConfig {
   // TODO: finish collection overrides

src/index.ts

@@ -1,4 +1,8 @@
 
-export { billingPlugin } from './plugin'
+export { billingPlugin } from './plugin/index.js'
-export type { BillingPluginConfig, CustomerInfoExtractor } from './plugin/config'
+export { mollieProvider, stripeProvider } from './providers/index.js'
-export type { Invoice, Payment, Refund } from './plugin/types'
+export type { BillingPluginConfig, CustomerInfoExtractor } from './plugin/config.js'
+export type { Invoice, Payment, Refund } from './plugin/types/index.js'
+export type { PaymentProvider, ProviderData } from './providers/types.js'
+export type { MollieProviderConfig } from './providers/mollie.js'
+export type { StripeProviderConfig } from './providers/stripe.js'

src/plugin/config.ts

@@ -1,6 +1,6 @@
 import { CollectionConfig } from 'payload'
-import { FieldsOverride } from '@/plugin/utils'
+import { FieldsOverride } from './utils.js'
-import { PaymentProvider } from '@/plugin/types'
+import { PaymentProvider } from './types/index.js'
 
 export const defaults = {
   paymentsCollection: 'payments',

src/plugin/index.ts

@@ -1,8 +1,8 @@
-import { createInvoicesCollection, createPaymentsCollection, createRefundsCollection } from '@/collections'
+import { createInvoicesCollection, createPaymentsCollection, createRefundsCollection } from '../collections/index.js'
-import type { BillingPluginConfig } from '@/plugin/config'
+import type { BillingPluginConfig } from './config.js'
 import type { Config, Payload } from 'payload'
-import { createSingleton } from '@/plugin/singleton'
+import { createSingleton } from './singleton.js'
-import type { PaymentProvider } from '@/providers'
+import type { PaymentProvider } from '../providers/index.js'
 
 const singleton = createSingleton(Symbol('billingPlugin'))
 

src/plugin/types/index.ts

@@ -1,5 +1,5 @@
-export * from './id'
+export * from './id.js'
-export * from './invoices'
+export * from './invoices.js'
-export * from './payments'
+export * from './payments.js'
-export * from './refunds'
+export * from './refunds.js'
-export * from '../../providers/types'
+export * from '../../providers/types.js'

src/plugin/types/invoices.ts

@@ -1,6 +1,5 @@
-import { Payment } from '@/plugin/types/payments'
+import { Payment } from './payments.js'
-
+import { Id } from './id.js'
-import { Id } from '@/plugin/types/id'
 
 export interface Invoice<TCustomer = unknown> {
   id: Id;

src/plugin/types/payments.ts

@@ -1,6 +1,6 @@
-import { Refund } from '@/plugin/types/refunds'
+import { Refund } from './refunds.js'
-import { Invoice } from '@/plugin/types/invoices'
+import { Invoice } from './invoices.js'
-import { Id } from '@/plugin/types/id'
+import { Id } from './id.js'
 
 export interface Payment {
   id: Id;

src/plugin/types/refunds.ts

@@ -1,4 +1,4 @@
-import { Payment } from '@/plugin/types/payments'
+import { Payment } from './payments.js'
 
 export interface Refund {
   id: number;

src/plugin/utils.ts

@@ -1,5 +1,5 @@
 import type { CollectionConfig, CollectionSlug, Field } from 'payload'
-import type { Id } from '@/plugin/types'
+import type { Id } from './types/index.js'
 
 export type FieldsOverride = (args: { defaultFields: Field[] }) => Field[]
 

src/providers/index.ts

@@ -1,4 +1,4 @@
-export * from './mollie'
+export * from './mollie.js'
-export * from './stripe'
+export * from './stripe.js'
-export * from './types'
+export * from './types.js'
-export * from './currency'
+export * from './currency.js'

src/providers/mollie.ts

@@ -1,7 +1,7 @@
-import type { Payment } from '@/plugin/types/payments'
+import type { Payment } from '../plugin/types/payments.js'
-import type { PaymentProvider } from '@/plugin/types'
+import type { PaymentProvider } from '../plugin/types/index.js'
 import type { Payload } from 'payload'
-import { createSingleton } from '@/plugin/singleton'
+import { createSingleton } from '../plugin/singleton.js'
 import type { createMollieClient, MollieClient } from '@mollie/api-client'
 import {
   webhookResponses,
@@ -10,8 +10,8 @@ import {
   updateInvoiceOnPaymentSuccess,
   handleWebhookError,
   validateProductionUrl
-} from './utils'
+} from './utils.js'
-import { formatAmountForProvider, isValidAmount, isValidCurrencyCode } from './currency'
+import { formatAmountForProvider, isValidAmount, isValidCurrencyCode } from './currency.js'
 
 const symbol = Symbol('mollie')
 export type MollieProviderConfig = Parameters<typeof createMollieClient>[0]

src/providers/stripe.ts

@@ -1,7 +1,7 @@
-import type { Payment } from '@/plugin/types/payments'
+import type { Payment } from '../plugin/types/payments.js'
-import type { PaymentProvider, ProviderData } from '@/plugin/types'
+import type { PaymentProvider, ProviderData } from '../plugin/types/index.js'
 import type { Payload } from 'payload'
-import { createSingleton } from '@/plugin/singleton'
+import { createSingleton } from '../plugin/singleton.js'
 import type Stripe from 'stripe'
 import {
   webhookResponses,
@@ -10,8 +10,8 @@ import {
   updateInvoiceOnPaymentSuccess,
   handleWebhookError,
   logWebhookEvent
-} from './utils'
+} from './utils.js'
-import { isValidAmount, isValidCurrencyCode } from './currency'
+import { isValidAmount, isValidCurrencyCode } from './currency.js'
 
 const symbol = Symbol('stripe')
 

src/providers/types.ts

@@ -1,6 +1,6 @@
-import type { Payment } from '@/plugin/types/payments'
+import type { Payment } from '../plugin/types/payments.js'
 import type { Config, Payload } from 'payload'
-import type { BillingPluginConfig } from '@/plugin/config'
+import type { BillingPluginConfig } from '../plugin/config.js'
 
 export type InitPayment = (payload: Payload, payment: Partial<Payment>) => Promise<Partial<Payment>>
 

src/providers/utils.ts

@@ -1,9 +1,9 @@
 import type { Payload } from 'payload'
-import type { Payment } from '@/plugin/types/payments'
+import type { Payment } from '../plugin/types/payments.js'
-import type { BillingPluginConfig } from '@/plugin/config'
+import type { BillingPluginConfig } from '../plugin/config.js'
-import type { ProviderData } from './types'
+import type { ProviderData } from './types.js'
-import { defaults } from '@/plugin/config'
+import { defaults } from '../plugin/config.js'
-import { extractSlug, toPayloadId } from '@/plugin/utils'
+import { extractSlug, toPayloadId } from '../plugin/utils.js'
 
 /**
  * Common webhook response utilities