@open-mercato/checkout 0.10.1-develop.7614.1.75d5ac1a6a → 0.10.1-develop.7618.1.ba9531c18e

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/README.md +1 -0
  3. package/dist/modules/checkout/__integration__/TC-CHKT-044-payer-fields.spec.js +104 -0
  4. package/dist/modules/checkout/__integration__/TC-CHKT-044-payer-fields.spec.js.map +7 -0
  5. package/dist/modules/checkout/commands/links.js +3 -0
  6. package/dist/modules/checkout/commands/links.js.map +2 -2
  7. package/dist/modules/checkout/commands/templates.js +7 -0
  8. package/dist/modules/checkout/commands/templates.js.map +2 -2
  9. package/dist/modules/checkout/components/LinkTemplateForm.js +18 -0
  10. package/dist/modules/checkout/components/LinkTemplateForm.js.map +2 -2
  11. package/dist/modules/checkout/lib/payerFieldRequirements.js +51 -0
  12. package/dist/modules/checkout/lib/payerFieldRequirements.js.map +7 -0
  13. package/package.json +5 -5
  14. package/src/modules/checkout/__integration__/TC-CHKT-044-payer-fields.spec.ts +129 -0
  15. package/src/modules/checkout/commands/__tests__/payer-fields.test.ts +160 -0
  16. package/src/modules/checkout/commands/links.ts +3 -0
  17. package/src/modules/checkout/commands/templates.ts +7 -0
  18. package/src/modules/checkout/components/LinkTemplateForm.tsx +27 -0
  19. package/src/modules/checkout/i18n/de.json +3 -0
  20. package/src/modules/checkout/i18n/en.json +3 -0
  21. package/src/modules/checkout/i18n/es.json +3 -0
  22. package/src/modules/checkout/i18n/ko.json +3 -0
  23. package/src/modules/checkout/i18n/pl.json +3 -0
  24. package/src/modules/checkout/lib/__tests__/payerFieldRequirements.test.ts +135 -0
  25. package/src/modules/checkout/lib/payerFieldRequirements.ts +72 -0
@@ -0,0 +1,135 @@
1
+ import { CrudHttpError } from '@open-mercato/shared/lib/crud/errors'
2
+ import {
3
+ clearPaymentGatewayDescriptors,
4
+ registerPaymentGatewayDescriptor,
5
+ } from '@open-mercato/shared/modules/payment_gateways/types'
6
+ import { DEFAULT_CHECKOUT_CUSTOMER_FIELDS } from '../defaults'
7
+ import {
8
+ ensurePayerFieldsCollected,
9
+ findUncollectedPayerFields,
10
+ PAYER_FIELDS_NOT_COLLECTED_MESSAGE_KEY,
11
+ resolveRequiredPayerFields,
12
+ } from '../payerFieldRequirements'
13
+
14
+ function fieldsWith(overrides: Record<string, boolean | null>) {
15
+ return DEFAULT_CHECKOUT_CUSTOMER_FIELDS
16
+ .filter((field) => overrides[field.key] !== null)
17
+ .map((field) => (field.key in overrides ? { ...field, required: overrides[field.key] === true } : field))
18
+ }
19
+
20
+ describe('findUncollectedPayerFields', () => {
21
+ it('returns nothing when the provider requires no payer fields', () => {
22
+ expect(findUncollectedPayerFields({
23
+ requiredPayerFields: undefined,
24
+ collectCustomerDetails: false,
25
+ customerFieldsSchema: [],
26
+ })).toEqual([])
27
+ })
28
+
29
+ it('accepts the default customer fields, which require email and both name parts', () => {
30
+ expect(findUncollectedPayerFields({
31
+ requiredPayerFields: ['email', 'name'],
32
+ collectCustomerDetails: true,
33
+ customerFieldsSchema: DEFAULT_CHECKOUT_CUSTOMER_FIELDS,
34
+ })).toEqual([])
35
+ })
36
+
37
+ it('flags every required payer field when customer details are not collected', () => {
38
+ expect(findUncollectedPayerFields({
39
+ requiredPayerFields: ['email', 'name'],
40
+ collectCustomerDetails: false,
41
+ customerFieldsSchema: DEFAULT_CHECKOUT_CUSTOMER_FIELDS,
42
+ })).toEqual(['email', 'name'])
43
+ })
44
+
45
+ it('flags email when the email field is optional or missing', () => {
46
+ expect(findUncollectedPayerFields({
47
+ requiredPayerFields: ['email'],
48
+ collectCustomerDetails: true,
49
+ customerFieldsSchema: fieldsWith({ email: false }),
50
+ })).toEqual(['email'])
51
+ expect(findUncollectedPayerFields({
52
+ requiredPayerFields: ['email'],
53
+ collectCustomerDetails: true,
54
+ customerFieldsSchema: fieldsWith({ email: null }),
55
+ })).toEqual(['email'])
56
+ })
57
+
58
+ it('flags name unless both first and last name are required', () => {
59
+ expect(findUncollectedPayerFields({
60
+ requiredPayerFields: ['email', 'name'],
61
+ collectCustomerDetails: true,
62
+ customerFieldsSchema: fieldsWith({ lastName: false }),
63
+ })).toEqual(['name'])
64
+ })
65
+
66
+ it('treats a missing customer field list as collecting nothing and ignores unknown or duplicate entries', () => {
67
+ expect(findUncollectedPayerFields({
68
+ requiredPayerFields: ['name', 'name', 'phone'],
69
+ collectCustomerDetails: true,
70
+ customerFieldsSchema: null,
71
+ })).toEqual(['name'])
72
+ })
73
+ })
74
+
75
+ describe('ensurePayerFieldsCollected', () => {
76
+ beforeEach(() => {
77
+ clearPaymentGatewayDescriptors()
78
+ registerPaymentGatewayDescriptor({
79
+ providerKey: 'payer_required',
80
+ label: 'Payer required',
81
+ requiresPayerFields: ['email', 'name'],
82
+ })
83
+ registerPaymentGatewayDescriptor({ providerKey: 'no_payer', label: 'No payer data' })
84
+ })
85
+
86
+ afterAll(() => {
87
+ clearPaymentGatewayDescriptors()
88
+ })
89
+
90
+ it('resolves the declared payer fields from the descriptor registry', () => {
91
+ expect(resolveRequiredPayerFields(' payer_required ')).toEqual(['email', 'name'])
92
+ expect(resolveRequiredPayerFields('no_payer')).toEqual([])
93
+ expect(resolveRequiredPayerFields('unknown')).toEqual([])
94
+ expect(resolveRequiredPayerFields(null)).toEqual([])
95
+ })
96
+
97
+ it('throws a field-level 422 when the provider needs payer fields the link does not collect', () => {
98
+ let caught: unknown
99
+ try {
100
+ ensurePayerFieldsCollected({
101
+ gatewayProviderKey: 'payer_required',
102
+ collectCustomerDetails: false,
103
+ customerFieldsSchema: DEFAULT_CHECKOUT_CUSTOMER_FIELDS,
104
+ })
105
+ } catch (error) {
106
+ caught = error
107
+ }
108
+ expect(caught).toBeInstanceOf(CrudHttpError)
109
+ expect(caught).toMatchObject({
110
+ status: 422,
111
+ body: {
112
+ fieldErrors: { gatewayProviderKey: PAYER_FIELDS_NOT_COLLECTED_MESSAGE_KEY },
113
+ missingPayerFields: ['email', 'name'],
114
+ },
115
+ })
116
+ })
117
+
118
+ it('passes for a correctly configured link and for providers that declare nothing', () => {
119
+ expect(() => ensurePayerFieldsCollected({
120
+ gatewayProviderKey: 'payer_required',
121
+ collectCustomerDetails: true,
122
+ customerFieldsSchema: DEFAULT_CHECKOUT_CUSTOMER_FIELDS,
123
+ })).not.toThrow()
124
+ expect(() => ensurePayerFieldsCollected({
125
+ gatewayProviderKey: 'no_payer',
126
+ collectCustomerDetails: false,
127
+ customerFieldsSchema: [],
128
+ })).not.toThrow()
129
+ expect(() => ensurePayerFieldsCollected({
130
+ gatewayProviderKey: null,
131
+ collectCustomerDetails: false,
132
+ customerFieldsSchema: [],
133
+ })).not.toThrow()
134
+ })
135
+ })
@@ -0,0 +1,72 @@
1
+ import { CrudHttpError } from '@open-mercato/shared/lib/crud/errors'
2
+ import {
3
+ getPaymentGatewayDescriptor,
4
+ type PaymentGatewayPayerField,
5
+ } from '@open-mercato/shared/modules/payment_gateways/types'
6
+
7
+ export const PAYER_FIELDS_NOT_COLLECTED_MESSAGE_KEY = 'checkout.validation.gatewayProviderKey.payerFieldsNotCollected'
8
+
9
+ export const PAYER_FIELD_CUSTOMER_FIELD_KEYS: Readonly<Record<PaymentGatewayPayerField, readonly string[]>> = {
10
+ email: ['email'],
11
+ name: ['firstName', 'lastName'],
12
+ }
13
+
14
+ type CustomerFieldRequirementLike = {
15
+ key?: unknown
16
+ required?: unknown
17
+ }
18
+
19
+ export type PayerFieldCollectionInput = {
20
+ requiredPayerFields: readonly string[] | null | undefined
21
+ collectCustomerDetails: boolean | null | undefined
22
+ customerFieldsSchema: readonly CustomerFieldRequirementLike[] | null | undefined
23
+ }
24
+
25
+ export type CheckoutPayerFieldConfiguration = {
26
+ gatewayProviderKey?: string | null
27
+ collectCustomerDetails?: boolean | null
28
+ customerFieldsSchema?: readonly CustomerFieldRequirementLike[] | null
29
+ }
30
+
31
+ function isKnownPayerField(value: string): value is PaymentGatewayPayerField {
32
+ return Object.prototype.hasOwnProperty.call(PAYER_FIELD_CUSTOMER_FIELD_KEYS, value)
33
+ }
34
+
35
+ export function findUncollectedPayerFields(input: PayerFieldCollectionInput): PaymentGatewayPayerField[] {
36
+ const requested = Array.from(new Set(input.requiredPayerFields ?? [])).filter(isKnownPayerField)
37
+ if (requested.length === 0) return []
38
+ if (input.collectCustomerDetails === false) return requested
39
+
40
+ const requiredCustomerFieldKeys = new Set(
41
+ (input.customerFieldsSchema ?? [])
42
+ .filter((field) => field.required === true && typeof field.key === 'string')
43
+ .map((field) => field.key as string),
44
+ )
45
+
46
+ return requested.filter((payerField) =>
47
+ PAYER_FIELD_CUSTOMER_FIELD_KEYS[payerField].some((key) => !requiredCustomerFieldKeys.has(key)),
48
+ )
49
+ }
50
+
51
+ export function resolveRequiredPayerFields(providerKey: string | null | undefined): PaymentGatewayPayerField[] {
52
+ const normalizedProviderKey = typeof providerKey === 'string' ? providerKey.trim() : ''
53
+ if (!normalizedProviderKey) return []
54
+ return getPaymentGatewayDescriptor(normalizedProviderKey)?.requiresPayerFields ?? []
55
+ }
56
+
57
+ export function ensurePayerFieldsCollected(configuration: CheckoutPayerFieldConfiguration): void {
58
+ const missing = findUncollectedPayerFields({
59
+ requiredPayerFields: resolveRequiredPayerFields(configuration.gatewayProviderKey),
60
+ collectCustomerDetails: configuration.collectCustomerDetails,
61
+ customerFieldsSchema: configuration.customerFieldsSchema,
62
+ })
63
+ if (missing.length === 0) return
64
+
65
+ throw new CrudHttpError(422, {
66
+ error: 'Validation failed',
67
+ fieldErrors: {
68
+ gatewayProviderKey: PAYER_FIELDS_NOT_COLLECTED_MESSAGE_KEY,
69
+ },
70
+ missingPayerFields: missing,
71
+ })
72
+ }