payload-billing/src/collections/refunds.ts

import type { AccessArgs, CollectionConfig } from 'payload'
import { BillingPluginConfig, defaults } from '../plugin/config'
import { extractSlug } from '../plugin/utils'
import { Payment } from '../plugin/types/index'

export function createRefundsCollection(pluginConfig: BillingPluginConfig): CollectionConfig {
  // TODO: finish collection overrides
  return {
    slug: extractSlug(pluginConfig.collections?.refunds || defaults.refundsCollection),
    access: {
      create: ({ req: { user } }: AccessArgs) => !!user,
      delete: ({ req: { user } }: AccessArgs) => !!user,
      read: ({ req: { user } }: AccessArgs) => !!user,
      update: ({ req: { user } }: AccessArgs) => !!user,
    },
    admin: {
      defaultColumns: ['id', 'payment', 'amount', 'currency', 'status', 'createdAt'],
      group: 'Billing',
      useAsTitle: 'id',
    },
    fields: [
      {
        name: 'providerId',
        type: 'text',
        admin: {
          description: 'The refund ID from the payment provider',
        },
        label: 'Provider Refund ID',
        required: true,
        unique: true,
      },
      {
        name: 'payment',
        type: 'relationship',
        admin: {
          position: 'sidebar',
        },
        relationTo: extractSlug(pluginConfig.collections?.payments || defaults.paymentsCollection),
        required: true,
      },
      {
        name: 'status',
        type: 'select',
        admin: {
          position: 'sidebar',
        },
        options: [
          { label: 'Pending', value: 'pending' },
          { label: 'Processing', value: 'processing' },
          { label: 'Succeeded', value: 'succeeded' },
          { label: 'Failed', value: 'failed' },
          { label: 'Canceled', value: 'canceled' },
        ],
        required: true,
      },
      {
        name: 'amount',
        type: 'number',
        admin: {
          description: 'Refund amount in cents',
        },
        min: 1,
        required: true,
      },
      {
        name: 'currency',
        type: 'text',
        admin: {
          description: 'ISO 4217 currency code (e.g., USD, EUR)',
        },
        maxLength: 3,
        required: true,
      },
      {
        name: 'reason',
        type: 'select',
        admin: {
          description: 'Reason for the refund',
        },
        options: [
          { label: 'Duplicate', value: 'duplicate' },
          { label: 'Fraudulent', value: 'fraudulent' },
          { label: 'Requested by Customer', value: 'requested_by_customer' },
          { label: 'Other', value: 'other' },
        ],
      },
      {
        name: 'description',
        type: 'textarea',
        admin: {
          description: 'Additional details about the refund',
        },
      },
      {
        name: 'metadata',
        type: 'json',
        admin: {
          description: 'Additional refund metadata',
        },
      },
      {
        name: 'providerData',
        type: 'json',
        admin: {
          description: 'Raw data from the payment provider',
          readOnly: true,
        },
      },
    ],
    hooks: {
      afterChange: [
        async ({ doc, operation, req }) => {
          if (operation === 'create') {
            req.payload.logger.info(`Refund created: ${doc.id} for payment: ${doc.payment}`)

            // Update the related payment's refund relationship
            try {
              const payment = await req.payload.findByID({
                id: typeof doc.payment === 'string' ? doc.payment : doc.payment.id,
                collection: extractSlug(pluginConfig.collections?.payments || defaults.paymentsCollection),
              }) as Payment

              const refundIds = Array.isArray(payment.refunds) ? payment.refunds : []
              await req.payload.update({
                id: typeof doc.payment === 'string' ? doc.payment : doc.payment.id,
                collection: extractSlug(pluginConfig.collections?.payments || defaults.paymentsCollection),
                data: {
                  refunds: [...refundIds, doc.id],
                },
              })
            } catch (error) {
              req.payload.logger.error(`Failed to update payment refunds: ${error}`)
            }
          }
        },
      ],
      beforeChange: [
        ({ data, operation }) => {
          if (operation === 'create') {
            // Validate amount format
            if (data.amount && !Number.isInteger(data.amount)) {
              throw new Error('Amount must be an integer (in cents)')
            }

            // Validate currency format
            if (data.currency) {
              data.currency = data.currency.toUpperCase()
              if (!/^[A-Z]{3}$/.test(data.currency)) {
                throw new Error('Currency must be a 3-letter ISO code')
              }
            }
          }
        },
      ],
    },
    timestamps: true,
  }
}