@oneblink/sdk-core 10.0.0-beta.3 → 10.1.0-beta.1

package/dist/paymentService/getPaymentProvider.d.ts

@@ -0,0 +1,9 @@
+import { SubmissionTypes } from '@oneblink/types';
+import { PaymentProvider } from './types.js';
+/**
+ * Resolve the pure payment provider implementation for a payment type.
+ *
+ * @param type
+ * @returns
+ */
+export default function getPaymentProvider(type: SubmissionTypes.FormSubmissionPayment['type']): PaymentProvider<SubmissionTypes.FormSubmissionPayment>;

package/dist/paymentService/getPaymentProvider.js

@@ -0,0 +1,20 @@
+import bpointPaymentProvider from './providers/bpoint.js';
+import cpPayPaymentProvider from './providers/cpPay.js';
+import nswGovPayPaymentProvider from './providers/nswGovPay.js';
+import westpacQuickStreamPaymentProvider from './providers/westpacQuickStream.js';
+const paymentProvidersMap = {
+    BPOINT: bpointPaymentProvider,
+    CP_PAY: cpPayPaymentProvider,
+    NSW_GOV_PAY: nswGovPayPaymentProvider,
+    WESTPAC_QUICK_STREAM: westpacQuickStreamPaymentProvider,
+};
+/**
+ * Resolve the pure payment provider implementation for a payment type.
+ *
+ * @param type
+ * @returns
+ */
+export default function getPaymentProvider(type) {
+    return paymentProvidersMap[type];
+}
+//# sourceMappingURL=getPaymentProvider.js.map

package/dist/paymentService/getPaymentProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPaymentProvider.js","sourceRoot":"","sources":["../../src/paymentService/getPaymentProvider.ts"],"names":[],"mappings":"AAEA,OAAO,qBAAqB,MAAM,uBAAuB,CAAA;AACzD,OAAO,oBAAoB,MAAM,sBAAsB,CAAA;AACvD,OAAO,wBAAwB,MAAM,0BAA0B,CAAA;AAC/D,OAAO,iCAAiC,MAAM,mCAAmC,CAAA;AAEjF,MAAM,mBAAmB,GAGrB;IACF,MAAM,EAAE,qBAAqB;IAC7B,MAAM,EAAE,oBAAoB;IAC5B,WAAW,EAAE,wBAAwB;IACrC,oBAAoB,EAAE,iCAAiC;CACxD,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CACxC,IAAmD;IAEnD,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAA;AAClC,CAAC","sourcesContent":["import { SubmissionTypes } from '@oneblink/types'\r\nimport { PaymentProvider } from './types.js'\r\nimport bpointPaymentProvider from './providers/bpoint.js'\r\nimport cpPayPaymentProvider from './providers/cpPay.js'\r\nimport nswGovPayPaymentProvider from './providers/nswGovPay.js'\r\nimport westpacQuickStreamPaymentProvider from './providers/westpacQuickStream.js'\r\n\r\nconst paymentProvidersMap: Record<\r\n  SubmissionTypes.FormSubmissionPayment['type'],\r\n  PaymentProvider<SubmissionTypes.FormSubmissionPayment>\r\n> = {\r\n  BPOINT: bpointPaymentProvider,\r\n  CP_PAY: cpPayPaymentProvider,\r\n  NSW_GOV_PAY: nswGovPayPaymentProvider,\r\n  WESTPAC_QUICK_STREAM: westpacQuickStreamPaymentProvider,\r\n}\r\n\r\n/**\r\n * Resolve the pure payment provider implementation for a payment type.\r\n *\r\n * @param type\r\n * @returns\r\n */\r\nexport default function getPaymentProvider(\r\n  type: SubmissionTypes.FormSubmissionPayment['type'],\r\n): PaymentProvider<SubmissionTypes.FormSubmissionPayment> {\r\n  return paymentProvidersMap[type]\r\n}\r\n"]}

package/dist/paymentService/providers/bpoint.d.ts

@@ -0,0 +1,7 @@
+import { SubmissionTypes } from '@oneblink/types';
+import { PaymentProvider } from '../types.js';
+type BPOINTFormSubmissionPayment = Extract<SubmissionTypes.FormSubmissionPayment, {
+    type: 'BPOINT';
+}>;
+declare const bpointPaymentProvider: PaymentProvider<BPOINTFormSubmissionPayment>;
+export default bpointPaymentProvider;

package/dist/paymentService/providers/bpoint.js

@@ -0,0 +1,76 @@
+function getFormStorePayment(formSubmissionPayment) {
+    const providerTransactionId = formSubmissionPayment.paymentTransaction?.TxnNumber;
+    const providerReceiptNumber = formSubmissionPayment.paymentTransaction?.ReceiptNumber;
+    return {
+        status: formSubmissionPayment.status,
+        ...(providerTransactionId ? { providerTransactionId } : {}),
+        ...(providerReceiptNumber ? { providerReceiptNumber } : {}),
+    };
+}
+function getDisplayDetails(formSubmissionPayment, { formatCurrency, formatDateTime, }) {
+    const { paymentTransaction } = formSubmissionPayment;
+    if (!paymentTransaction) {
+        return;
+    }
+    const amountValue = paymentTransaction.Amount / 100;
+    const amount = {
+        value: amountValue,
+        formatted: formatCurrency(amountValue),
+    };
+    return {
+        amount,
+        paymentDisplayDetails: [
+            {
+                key: 'BPOINT_RECEIPT_NUMBER',
+                label: 'Receipt Number',
+                value: paymentTransaction.ReceiptNumber,
+            },
+            {
+                key: 'BPOINT_CRN1',
+                label: 'CRN 1',
+                value: paymentTransaction.Crn1,
+            },
+            {
+                key: 'BPOINT_CRN2',
+                label: 'CRN 2',
+                value: paymentTransaction.Crn2,
+            },
+            {
+                key: 'BPOINT_CRN3',
+                label: 'CRN 3',
+                value: paymentTransaction.Crn3,
+            },
+            {
+                key: 'BPOINT_BILLER_CODE',
+                label: 'Biller Code',
+                value: paymentTransaction.BillerCode,
+            },
+            {
+                key: 'BPOINT_CREDIT_CARD_MASK',
+                label: 'Card Number',
+                value: paymentTransaction.CardDetails.MaskedCardNumber,
+            },
+            {
+                key: 'BPOINT_AMOUNT',
+                label: 'Amount',
+                value: amount.formatted,
+            },
+            {
+                key: 'BPOINT_SURCHARGE_AMOUNT',
+                label: 'Surcharge Amount',
+                value: formatCurrency(paymentTransaction.AmountSurcharge / 100),
+            },
+            {
+                key: 'BPOINT_PROCESSED_DATE_TIME',
+                label: 'Processed Date Time',
+                value: formatDateTime(paymentTransaction.ProcessedDateTime),
+            },
+        ],
+    };
+}
+const bpointPaymentProvider = {
+    getFormStorePayment,
+    getDisplayDetails,
+};
+export default bpointPaymentProvider;
+//# sourceMappingURL=bpoint.js.map

package/dist/paymentService/providers/bpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bpoint.js","sourceRoot":"","sources":["../../../src/paymentService/providers/bpoint.ts"],"names":[],"mappings":"AAaA,SAAS,mBAAmB,CAC1B,qBAAkD;IAElD,MAAM,qBAAqB,GACzB,qBAAqB,CAAC,kBAAkB,EAAE,SAAS,CAAA;IACrD,MAAM,qBAAqB,GACzB,qBAAqB,CAAC,kBAAkB,EAAE,aAAa,CAAA;IAEzD,OAAO;QACL,MAAM,EAAE,qBAAqB,CAAC,MAAM;QACpC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC5D,CAAA;AACH,CAAC;AAED,SAAS,iBAAiB,CACxB,qBAAkD,EAClD,EACE,cAAc,EACd,cAAc,GACW;IAE3B,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAA;IACpD,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACxB,OAAM;IACR,CAAC;IACD,MAAM,WAAW,GAAG,kBAAkB,CAAC,MAAM,GAAG,GAAG,CAAA;IACnD,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,WAAW;QAClB,SAAS,EAAE,cAAc,CAAC,WAAW,CAAC;KACvC,CAAA;IACD,OAAO;QACL,MAAM;QACN,qBAAqB,EAAE;YACrB;gBACE,GAAG,EAAE,uBAAuB;gBAC5B,KAAK,EAAE,gBAAgB;gBACvB,KAAK,EAAE,kBAAkB,CAAC,aAAa;aACxC;YACD;gBACE,GAAG,EAAE,aAAa;gBAClB,KAAK,EAAE,OAAO;gBACd,KAAK,EAAE,kBAAkB,CAAC,IAAI;aAC/B;YACD;gBACE,GAAG,EAAE,aAAa;gBAClB,KAAK,EAAE,OAAO;gBACd,KAAK,EAAE,kBAAkB,CAAC,IAAI;aAC/B;YACD;gBACE,GAAG,EAAE,aAAa;gBAClB,KAAK,EAAE,OAAO;gBACd,KAAK,EAAE,kBAAkB,CAAC,IAAI;aAC/B;YACD;gBACE,GAAG,EAAE,oBAAoB;gBACzB,KAAK,EAAE,aAAa;gBACpB,KAAK,EAAE,kBAAkB,CAAC,UAAU;aACrC;YACD;gBACE,GAAG,EAAE,yBAAyB;gBAC9B,KAAK,EAAE,aAAa;gBACpB,KAAK,EAAE,kBAAkB,CAAC,WAAW,CAAC,gBAAgB;aACvD;YACD;gBACE,GAAG,EAAE,eAAe;gBACpB,KAAK,EAAE,QAAQ;gBACf,KAAK,EAAE,MAAM,CAAC,SAAS;aACxB;YACD;gBACE,GAAG,EAAE,yBAAyB;gBAC9B,KAAK,EAAE,kBAAkB;gBACzB,KAAK,EAAE,cAAc,CAAC,kBAAkB,CAAC,eAAe,GAAG,GAAG,CAAC;aAChE;YACD;gBACE,GAAG,EAAE,4BAA4B;gBACjC,KAAK,EAAE,qBAAqB;gBAC5B,KAAK,EAAE,cAAc,CAAC,kBAAkB,CAAC,iBAAiB,CAAC;aAC5D;SACF;KACF,CAAA;AACH,CAAC;AAED,MAAM,qBAAqB,GAAiD;IAC1E,mBAAmB;IACnB,iBAAiB;CAClB,CAAA;AAED,eAAe,qBAAqB,CAAA","sourcesContent":["import { SubmissionTypes } from '@oneblink/types'\r\nimport {\r\n  FormStorePayment,\r\n  PaymentDisplayDetailsResult,\r\n  PaymentDisplayFormatters,\r\n  PaymentProvider,\r\n} from '../types.js'\r\n\r\ntype BPOINTFormSubmissionPayment = Extract<\r\n  SubmissionTypes.FormSubmissionPayment,\r\n  { type: 'BPOINT' }\r\n>\r\n\r\nfunction getFormStorePayment(\r\n  formSubmissionPayment: BPOINTFormSubmissionPayment,\r\n): FormStorePayment {\r\n  const providerTransactionId =\r\n    formSubmissionPayment.paymentTransaction?.TxnNumber\r\n  const providerReceiptNumber =\r\n    formSubmissionPayment.paymentTransaction?.ReceiptNumber\r\n\r\n  return {\r\n    status: formSubmissionPayment.status,\r\n    ...(providerTransactionId ? { providerTransactionId } : {}),\r\n    ...(providerReceiptNumber ? { providerReceiptNumber } : {}),\r\n  }\r\n}\r\n\r\nfunction getDisplayDetails(\r\n  formSubmissionPayment: BPOINTFormSubmissionPayment,\r\n  {\r\n    formatCurrency,\r\n    formatDateTime,\r\n  }: PaymentDisplayFormatters,\r\n): PaymentDisplayDetailsResult | undefined {\r\n  const { paymentTransaction } = formSubmissionPayment\r\n  if (!paymentTransaction) {\r\n    return\r\n  }\r\n  const amountValue = paymentTransaction.Amount / 100\r\n  const amount = {\r\n    value: amountValue,\r\n    formatted: formatCurrency(amountValue),\r\n  }\r\n  return {\r\n    amount,\r\n    paymentDisplayDetails: [\r\n      {\r\n        key: 'BPOINT_RECEIPT_NUMBER',\r\n        label: 'Receipt Number',\r\n        value: paymentTransaction.ReceiptNumber,\r\n      },\r\n      {\r\n        key: 'BPOINT_CRN1',\r\n        label: 'CRN 1',\r\n        value: paymentTransaction.Crn1,\r\n      },\r\n      {\r\n        key: 'BPOINT_CRN2',\r\n        label: 'CRN 2',\r\n        value: paymentTransaction.Crn2,\r\n      },\r\n      {\r\n        key: 'BPOINT_CRN3',\r\n        label: 'CRN 3',\r\n        value: paymentTransaction.Crn3,\r\n      },\r\n      {\r\n        key: 'BPOINT_BILLER_CODE',\r\n        label: 'Biller Code',\r\n        value: paymentTransaction.BillerCode,\r\n      },\r\n      {\r\n        key: 'BPOINT_CREDIT_CARD_MASK',\r\n        label: 'Card Number',\r\n        value: paymentTransaction.CardDetails.MaskedCardNumber,\r\n      },\r\n      {\r\n        key: 'BPOINT_AMOUNT',\r\n        label: 'Amount',\r\n        value: amount.formatted,\r\n      },\r\n      {\r\n        key: 'BPOINT_SURCHARGE_AMOUNT',\r\n        label: 'Surcharge Amount',\r\n        value: formatCurrency(paymentTransaction.AmountSurcharge / 100),\r\n      },\r\n      {\r\n        key: 'BPOINT_PROCESSED_DATE_TIME',\r\n        label: 'Processed Date Time',\r\n        value: formatDateTime(paymentTransaction.ProcessedDateTime),\r\n      },\r\n    ],\r\n  }\r\n}\r\n\r\nconst bpointPaymentProvider: PaymentProvider<BPOINTFormSubmissionPayment> = {\r\n  getFormStorePayment,\r\n  getDisplayDetails,\r\n}\r\n\r\nexport default bpointPaymentProvider\r\n"]}

package/dist/paymentService/providers/cpPay.d.ts

@@ -0,0 +1,7 @@
+import { SubmissionTypes } from '@oneblink/types';
+import { PaymentProvider } from '../types.js';
+type CPPayFormSubmissionPayment = Extract<SubmissionTypes.FormSubmissionPayment, {
+    type: 'CP_PAY';
+}>;
+declare const cpPayPaymentProvider: PaymentProvider<CPPayFormSubmissionPayment>;
+export default cpPayPaymentProvider;

package/dist/paymentService/providers/cpPay.js

@@ -0,0 +1,119 @@
+function getFormStorePayment(formSubmissionPayment) {
+    const paymentTransaction = formSubmissionPayment.paymentTransaction;
+    const providerTransactionId = !paymentTransaction
+        ? undefined
+        : paymentTransaction.cpPayVersion === 'v2'
+            ? paymentTransaction.result.id
+            : paymentTransaction.transactionId;
+    const providerReceiptNumber = !paymentTransaction
+        ? undefined
+        : paymentTransaction.cpPayVersion === 'v2'
+            ? (paymentTransaction.result.externalReferenceId ?? undefined)
+            : (paymentTransaction.orderNumber ?? undefined);
+    return {
+        status: formSubmissionPayment.status,
+        ...(providerTransactionId ? { providerTransactionId } : {}),
+        ...(providerReceiptNumber ? { providerReceiptNumber } : {}),
+    };
+}
+function getDisplayDetails(formSubmissionPayment, { formatCurrency, formatDateTime }) {
+    const { paymentTransaction } = formSubmissionPayment;
+    if (!paymentTransaction) {
+        return;
+    }
+    const determineDetails = () => {
+        switch (paymentTransaction.cpPayVersion) {
+            case 'v2': {
+                return {
+                    transactionId: paymentTransaction.result.id,
+                    orderNumber: paymentTransaction.result.externalReferenceId ?? undefined,
+                    paymentType: paymentTransaction.result.paymentType,
+                    creditCardMask: paymentTransaction.result.lastFour
+                        ? `xxxx xxxx xxxx ${paymentTransaction.result.lastFour}`
+                        : undefined,
+                    amount: paymentTransaction.result.amount !== undefined
+                        ? {
+                            value: paymentTransaction.result.amount,
+                            formatted: formatCurrency(paymentTransaction.result.amount),
+                        }
+                        : {
+                            value: NaN,
+                            formatted: 'Unknown',
+                        },
+                    createdDateTime: paymentTransaction.result.createdOnUtc,
+                };
+            }
+            default: {
+                return {
+                    transactionId: paymentTransaction.transactionId,
+                    orderNumber: paymentTransaction.orderNumber ?? undefined,
+                    paymentType: paymentTransaction.paymentTypeId === 1
+                        ? 'Credit/Debit Card'
+                        : paymentTransaction.paymentTypeId === 2
+                            ? 'ACH'
+                            : undefined,
+                    creditCardMask: paymentTransaction.lastFour
+                        ? `xxxx xxxx xxxx ${paymentTransaction.lastFour}`
+                        : undefined,
+                    amount: {
+                        value: paymentTransaction.amount,
+                        formatted: formatCurrency(paymentTransaction.amount),
+                    },
+                    createdDateTime: paymentTransaction.createdAt,
+                };
+            }
+        }
+    };
+    const { transactionId, orderNumber, paymentType, creditCardMask, amount, createdDateTime, } = determineDetails();
+    const paymentDisplayDetails = [];
+    if (transactionId) {
+        paymentDisplayDetails.push({
+            key: 'CP_PAY_TRANSACTION_ID',
+            label: 'Transaction Id',
+            value: transactionId,
+        });
+    }
+    if (orderNumber) {
+        paymentDisplayDetails.push({
+            key: 'CP_PAY_ORDER_NUMBER',
+            label: 'Order Number',
+            value: orderNumber,
+        });
+    }
+    if (paymentType) {
+        paymentDisplayDetails.push({
+            key: 'CP_PAY_PAYMENT_TYPE',
+            label: 'Payment Type',
+            value: paymentType,
+        });
+    }
+    if (creditCardMask) {
+        paymentDisplayDetails.push({
+            key: 'CP_PAY_CREDIT_CARD_MASK',
+            label: 'Card Number',
+            value: creditCardMask,
+        });
+    }
+    paymentDisplayDetails.push({
+        key: 'CP_PAY_AMOUNT',
+        label: 'Amount',
+        value: amount.formatted,
+    });
+    if (createdDateTime) {
+        paymentDisplayDetails.push({
+            key: 'CP_PAY_CREATED_DATE_TIME',
+            label: 'Created At',
+            value: formatDateTime(createdDateTime),
+        });
+    }
+    return {
+        amount,
+        paymentDisplayDetails,
+    };
+}
+const cpPayPaymentProvider = {
+    getFormStorePayment,
+    getDisplayDetails,
+};
+export default cpPayPaymentProvider;
+//# sourceMappingURL=cpPay.js.map

package/dist/paymentService/providers/cpPay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cpPay.js","sourceRoot":"","sources":["../../../src/paymentService/providers/cpPay.ts"],"names":[],"mappings":"AAcA,SAAS,mBAAmB,CAC1B,qBAAiD;IAEjD,MAAM,kBAAkB,GAAG,qBAAqB,CAAC,kBAAkB,CAAA;IACnE,MAAM,qBAAqB,GAAG,CAAC,kBAAkB;QAC/C,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,kBAAkB,CAAC,YAAY,KAAK,IAAI;YACxC,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE;YAC9B,CAAC,CAAC,kBAAkB,CAAC,aAAa,CAAA;IACtC,MAAM,qBAAqB,GAAG,CAAC,kBAAkB;QAC/C,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,kBAAkB,CAAC,YAAY,KAAK,IAAI;YACxC,CAAC,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC,mBAAmB,IAAI,SAAS,CAAC;YAC9D,CAAC,CAAC,CAAC,kBAAkB,CAAC,WAAW,IAAI,SAAS,CAAC,CAAA;IAEnD,OAAO;QACL,MAAM,EAAE,qBAAqB,CAAC,MAAM;QACpC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC5D,CAAA;AACH,CAAC;AAED,SAAS,iBAAiB,CACxB,qBAAiD,EACjD,EAAE,cAAc,EAAE,cAAc,EAA4B;IAE5D,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAA;IACpD,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACxB,OAAM;IACR,CAAC;IAED,MAAM,gBAAgB,GAAG,GAAG,EAAE;QAC5B,QAAQ,kBAAkB,CAAC,YAAY,EAAE,CAAC;YACxC,KAAK,IAAI,CAAC,CAAC,CAAC;gBACV,OAAO;oBACL,aAAa,EAAE,kBAAkB,CAAC,MAAM,CAAC,EAAE;oBAC3C,WAAW,EACT,kBAAkB,CAAC,MAAM,CAAC,mBAAmB,IAAI,SAAS;oBAC5D,WAAW,EAAE,kBAAkB,CAAC,MAAM,CAAC,WAAW;oBAClD,cAAc,EAAE,kBAAkB,CAAC,MAAM,CAAC,QAAQ;wBAChD,CAAC,CAAC,kBAAkB,kBAAkB,CAAC,MAAM,CAAC,QAAQ,EAAE;wBACxD,CAAC,CAAC,SAAS;oBACb,MAAM,EACJ,kBAAkB,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS;wBAC5C,CAAC,CAAC;4BACE,KAAK,EAAE,kBAAkB,CAAC,MAAM,CAAC,MAAM;4BACvC,SAAS,EAAE,cAAc,CAAC,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC;yBAC5D;wBACH,CAAC,CAAC;4BACE,KAAK,EAAE,GAAG;4BACV,SAAS,EAAE,SAAS;yBACrB;oBACP,eAAe,EAAE,kBAAkB,CAAC,MAAM,CAAC,YAAY;iBACxD,CAAA;YACH,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,OAAO;oBACL,aAAa,EAAE,kBAAkB,CAAC,aAAa;oBAC/C,WAAW,EAAE,kBAAkB,CAAC,WAAW,IAAI,SAAS;oBACxD,WAAW,EACT,kBAAkB,CAAC,aAAa,KAAK,CAAC;wBACpC,CAAC,CAAC,mBAAmB;wBACrB,CAAC,CAAC,kBAAkB,CAAC,aAAa,KAAK,CAAC;4BACtC,CAAC,CAAC,KAAK;4BACP,CAAC,CAAC,SAAS;oBACjB,cAAc,EAAE,kBAAkB,CAAC,QAAQ;wBACzC,CAAC,CAAC,kBAAkB,kBAAkB,CAAC,QAAQ,EAAE;wBACjD,CAAC,CAAC,SAAS;oBACb,MAAM,EAAE;wBACN,KAAK,EAAE,kBAAkB,CAAC,MAAM;wBAChC,SAAS,EAAE,cAAc,CAAC,kBAAkB,CAAC,MAAM,CAAC;qBACrD;oBACD,eAAe,EAAE,kBAAkB,CAAC,SAAS;iBAC9C,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC,CAAA;IAED,MAAM,EACJ,aAAa,EACb,WAAW,EACX,WAAW,EACX,cAAc,EACd,MAAM,EACN,eAAe,GAChB,GAAG,gBAAgB,EAAE,CAAA;IACtB,MAAM,qBAAqB,GAA2B,EAAE,CAAA;IACxD,IAAI,aAAa,EAAE,CAAC;QAClB,qBAAqB,CAAC,IAAI,CAAC;YACzB,GAAG,EAAE,uBAAuB;YAC5B,KAAK,EAAE,gBAAgB;YACvB,KAAK,EAAE,aAAa;SACrB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,WAAW,EAAE,CAAC;QAChB,qBAAqB,CAAC,IAAI,CAAC;YACzB,GAAG,EAAE,qBAAqB;YAC1B,KAAK,EAAE,cAAc;YACrB,KAAK,EAAE,WAAW;SACnB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,WAAW,EAAE,CAAC;QAChB,qBAAqB,CAAC,IAAI,CAAC;YACzB,GAAG,EAAE,qBAAqB;YAC1B,KAAK,EAAE,cAAc;YACrB,KAAK,EAAE,WAAW;SACnB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,cAAc,EAAE,CAAC;QACnB,qBAAqB,CAAC,IAAI,CAAC;YACzB,GAAG,EAAE,yBAAyB;YAC9B,KAAK,EAAE,aAAa;YACpB,KAAK,EAAE,cAAc;SACtB,CAAC,CAAA;IACJ,CAAC;IACD,qBAAqB,CAAC,IAAI,CAAC;QACzB,GAAG,EAAE,eAAe;QACpB,KAAK,EAAE,QAAQ;QACf,KAAK,EAAE,MAAM,CAAC,SAAS;KACxB,CAAC,CAAA;IACF,IAAI,eAAe,EAAE,CAAC;QACpB,qBAAqB,CAAC,IAAI,CAAC;YACzB,GAAG,EAAE,0BAA0B;YAC/B,KAAK,EAAE,YAAY;YACnB,KAAK,EAAE,cAAc,CAAC,eAAe,CAAC;SACvC,CAAC,CAAA;IACJ,CAAC;IAED,OAAO;QACL,MAAM;QACN,qBAAqB;KACtB,CAAA;AACH,CAAC;AAED,MAAM,oBAAoB,GAAgD;IACxE,mBAAmB;IACnB,iBAAiB;CAClB,CAAA;AAED,eAAe,oBAAoB,CAAA","sourcesContent":["import { SubmissionTypes } from '@oneblink/types'\r\nimport {\r\n  FormStorePayment,\r\n  PaymentDisplayDetail,\r\n  PaymentDisplayDetailsResult,\r\n  PaymentDisplayFormatters,\r\n  PaymentProvider,\r\n} from '../types.js'\r\n\r\ntype CPPayFormSubmissionPayment = Extract<\r\n  SubmissionTypes.FormSubmissionPayment,\r\n  { type: 'CP_PAY' }\r\n>\r\n\r\nfunction getFormStorePayment(\r\n  formSubmissionPayment: CPPayFormSubmissionPayment,\r\n): FormStorePayment {\r\n  const paymentTransaction = formSubmissionPayment.paymentTransaction\r\n  const providerTransactionId = !paymentTransaction\r\n    ? undefined\r\n    : paymentTransaction.cpPayVersion === 'v2'\r\n      ? paymentTransaction.result.id\r\n      : paymentTransaction.transactionId\r\n  const providerReceiptNumber = !paymentTransaction\r\n    ? undefined\r\n    : paymentTransaction.cpPayVersion === 'v2'\r\n      ? (paymentTransaction.result.externalReferenceId ?? undefined)\r\n      : (paymentTransaction.orderNumber ?? undefined)\r\n\r\n  return {\r\n    status: formSubmissionPayment.status,\r\n    ...(providerTransactionId ? { providerTransactionId } : {}),\r\n    ...(providerReceiptNumber ? { providerReceiptNumber } : {}),\r\n  }\r\n}\r\n\r\nfunction getDisplayDetails(\r\n  formSubmissionPayment: CPPayFormSubmissionPayment,\r\n  { formatCurrency, formatDateTime }: PaymentDisplayFormatters,\r\n): PaymentDisplayDetailsResult | undefined {\r\n  const { paymentTransaction } = formSubmissionPayment\r\n  if (!paymentTransaction) {\r\n    return\r\n  }\r\n\r\n  const determineDetails = () => {\r\n    switch (paymentTransaction.cpPayVersion) {\r\n      case 'v2': {\r\n        return {\r\n          transactionId: paymentTransaction.result.id,\r\n          orderNumber:\r\n            paymentTransaction.result.externalReferenceId ?? undefined,\r\n          paymentType: paymentTransaction.result.paymentType,\r\n          creditCardMask: paymentTransaction.result.lastFour\r\n            ? `xxxx xxxx xxxx ${paymentTransaction.result.lastFour}`\r\n            : undefined,\r\n          amount:\r\n            paymentTransaction.result.amount !== undefined\r\n              ? {\r\n                  value: paymentTransaction.result.amount,\r\n                  formatted: formatCurrency(paymentTransaction.result.amount),\r\n                }\r\n              : {\r\n                  value: NaN,\r\n                  formatted: 'Unknown',\r\n                },\r\n          createdDateTime: paymentTransaction.result.createdOnUtc,\r\n        }\r\n      }\r\n      default: {\r\n        return {\r\n          transactionId: paymentTransaction.transactionId,\r\n          orderNumber: paymentTransaction.orderNumber ?? undefined,\r\n          paymentType:\r\n            paymentTransaction.paymentTypeId === 1\r\n              ? 'Credit/Debit Card'\r\n              : paymentTransaction.paymentTypeId === 2\r\n                ? 'ACH'\r\n                : undefined,\r\n          creditCardMask: paymentTransaction.lastFour\r\n            ? `xxxx xxxx xxxx ${paymentTransaction.lastFour}`\r\n            : undefined,\r\n          amount: {\r\n            value: paymentTransaction.amount,\r\n            formatted: formatCurrency(paymentTransaction.amount),\r\n          },\r\n          createdDateTime: paymentTransaction.createdAt,\r\n        }\r\n      }\r\n    }\r\n  }\r\n\r\n  const {\r\n    transactionId,\r\n    orderNumber,\r\n    paymentType,\r\n    creditCardMask,\r\n    amount,\r\n    createdDateTime,\r\n  } = determineDetails()\r\n  const paymentDisplayDetails: PaymentDisplayDetail[] = []\r\n  if (transactionId) {\r\n    paymentDisplayDetails.push({\r\n      key: 'CP_PAY_TRANSACTION_ID',\r\n      label: 'Transaction Id',\r\n      value: transactionId,\r\n    })\r\n  }\r\n  if (orderNumber) {\r\n    paymentDisplayDetails.push({\r\n      key: 'CP_PAY_ORDER_NUMBER',\r\n      label: 'Order Number',\r\n      value: orderNumber,\r\n    })\r\n  }\r\n  if (paymentType) {\r\n    paymentDisplayDetails.push({\r\n      key: 'CP_PAY_PAYMENT_TYPE',\r\n      label: 'Payment Type',\r\n      value: paymentType,\r\n    })\r\n  }\r\n  if (creditCardMask) {\r\n    paymentDisplayDetails.push({\r\n      key: 'CP_PAY_CREDIT_CARD_MASK',\r\n      label: 'Card Number',\r\n      value: creditCardMask,\r\n    })\r\n  }\r\n  paymentDisplayDetails.push({\r\n    key: 'CP_PAY_AMOUNT',\r\n    label: 'Amount',\r\n    value: amount.formatted,\r\n  })\r\n  if (createdDateTime) {\r\n    paymentDisplayDetails.push({\r\n      key: 'CP_PAY_CREATED_DATE_TIME',\r\n      label: 'Created At',\r\n      value: formatDateTime(createdDateTime),\r\n    })\r\n  }\r\n\r\n  return {\r\n    amount,\r\n    paymentDisplayDetails,\r\n  }\r\n}\r\n\r\nconst cpPayPaymentProvider: PaymentProvider<CPPayFormSubmissionPayment> = {\r\n  getFormStorePayment,\r\n  getDisplayDetails,\r\n}\r\n\r\nexport default cpPayPaymentProvider\r\n"]}

package/dist/paymentService/providers/nswGovPay.d.ts

@@ -0,0 +1,7 @@
+import { SubmissionTypes } from '@oneblink/types';
+import { PaymentProvider } from '../types.js';
+type NSWGovPayFormSubmissionPayment = Extract<SubmissionTypes.FormSubmissionPayment, {
+    type: 'NSW_GOV_PAY';
+}>;
+declare const nswGovPayPaymentProvider: PaymentProvider<NSWGovPayFormSubmissionPayment>;
+export default nswGovPayPaymentProvider;

package/dist/paymentService/providers/nswGovPay.js

@@ -0,0 +1,90 @@
+function getFormStorePayment(formSubmissionPayment) {
+    const providerTransactionId = formSubmissionPayment.paymentTransaction?.nswGovPayPaymentReference;
+    const providerReceiptNumber = formSubmissionPayment.paymentTransaction?.agencyCompletionPayment
+        ?.paymentCompletionReference;
+    return {
+        status: formSubmissionPayment.status,
+        ...(providerTransactionId ? { providerTransactionId } : {}),
+        ...(providerReceiptNumber ? { providerReceiptNumber } : {}),
+    };
+}
+function getDisplayDetails(formSubmissionPayment, { formatCurrency, formatDateTime, }) {
+    const { paymentTransaction } = formSubmissionPayment;
+    if (!paymentTransaction || !paymentTransaction.agencyCompletionPayment) {
+        return;
+    }
+    const amount = {
+        value: paymentTransaction.agencyCompletionPayment.amount,
+        formatted: formatCurrency(paymentTransaction.agencyCompletionPayment.amount),
+    };
+    return {
+        amount,
+        paymentDisplayDetails: [
+            {
+                key: 'NSW_GOV_PAY_COMPLETION_REFERENCE',
+                label: 'Completion Reference',
+                value: paymentTransaction.agencyCompletionPayment.paymentCompletionReference,
+            },
+            {
+                key: 'NSW_GOV_PAY_PAYMENT_REFERENCE',
+                label: 'Payment Reference',
+                value: paymentTransaction.agencyCompletionPayment.paymentReference,
+            },
+            {
+                key: 'NSW_GOV_PAY_BANK_REFERENCE',
+                label: 'Bank Reference',
+                value: paymentTransaction.agencyCompletionPayment.bankReference,
+            },
+            {
+                key: 'NSW_GOV_PAY_PAYMENT_METHOD',
+                label: 'Payment Method',
+                value: paymentTransaction.agencyCompletionPayment.paymentMethod,
+            },
+            ...(paymentTransaction.agencyCompletionPayment.paymentMethod === 'BPAY' &&
+                paymentTransaction.agencyCompletionPayment.bPay?.billerCode
+                ? [
+                    {
+                        key: 'NSW_GOV_PAY_BPAY_BILLER_CODE',
+                        label: 'BPay Biller Code',
+                        value: paymentTransaction.agencyCompletionPayment.bPay.billerCode,
+                    },
+                ]
+                : []),
+            ...(paymentTransaction.agencyCompletionPayment.paymentMethod === 'CARD'
+                ? [
+                    {
+                        key: 'NSW_GOV_PAY_CREDIT_CARD_NUMBER',
+                        label: 'Card Number',
+                        value: `xxxx xxxx xxxx ${paymentTransaction.agencyCompletionPayment.card?.last4Digits}`,
+                    },
+                ]
+                : []),
+            {
+                key: 'NSW_GOV_PAY_AMOUNT',
+                label: 'Amount',
+                value: amount.formatted,
+            },
+            {
+                key: 'NSW_GOV_PAY_SURCHARGE_AMOUNT',
+                label: 'Surcharge Amount',
+                value: formatCurrency(paymentTransaction.agencyCompletionPayment.surcharge),
+            },
+            {
+                key: 'NSW_GOV_PAY_SURCHARGE_GST',
+                label: 'Surcharge GST',
+                value: formatCurrency(paymentTransaction.agencyCompletionPayment.surchargeGst),
+            },
+            {
+                key: 'NSW_GOV_PAY_CREATED_DATE_TIME',
+                label: 'Created Date Time',
+                value: formatDateTime(formSubmissionPayment.createdAt),
+            },
+        ],
+    };
+}
+const nswGovPayPaymentProvider = {
+    getFormStorePayment,
+    getDisplayDetails,
+};
+export default nswGovPayPaymentProvider;
+//# sourceMappingURL=nswGovPay.js.map

package/dist/paymentService/providers/nswGovPay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nswGovPay.js","sourceRoot":"","sources":["../../../src/paymentService/providers/nswGovPay.ts"],"names":[],"mappings":"AAaA,SAAS,mBAAmB,CAC1B,qBAAqD;IAErD,MAAM,qBAAqB,GACzB,qBAAqB,CAAC,kBAAkB,EAAE,yBAAyB,CAAA;IACrE,MAAM,qBAAqB,GACzB,qBAAqB,CAAC,kBAAkB,EAAE,uBAAuB;QAC/D,EAAE,0BAA0B,CAAA;IAEhC,OAAO;QACL,MAAM,EAAE,qBAAqB,CAAC,MAAM;QACpC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC5D,CAAA;AACH,CAAC;AAED,SAAS,iBAAiB,CACxB,qBAAqD,EACrD,EACE,cAAc,EACd,cAAc,GACW;IAE3B,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAA;IACpD,IAAI,CAAC,kBAAkB,IAAI,CAAC,kBAAkB,CAAC,uBAAuB,EAAE,CAAC;QACvE,OAAM;IACR,CAAC;IAED,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,MAAM;QACxD,SAAS,EAAE,cAAc,CACvB,kBAAkB,CAAC,uBAAuB,CAAC,MAAM,CAClD;KACF,CAAA;IACD,OAAO;QACL,MAAM;QACN,qBAAqB,EAAE;YACrB;gBACE,GAAG,EAAE,kCAAkC;gBACvC,KAAK,EAAE,sBAAsB;gBAC7B,KAAK,EACH,kBAAkB,CAAC,uBAAuB,CAAC,0BAA0B;aACxE;YACD;gBACE,GAAG,EAAE,+BAA+B;gBACpC,KAAK,EAAE,mBAAmB;gBAC1B,KAAK,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,gBAAgB;aACnE;YACD;gBACE,GAAG,EAAE,4BAA4B;gBACjC,KAAK,EAAE,gBAAgB;gBACvB,KAAK,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,aAAa;aAChE;YACD;gBACE,GAAG,EAAE,4BAA4B;gBACjC,KAAK,EAAE,gBAAgB;gBACvB,KAAK,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,aAAa;aAChE;YACD,GAAG,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,aAAa,KAAK,MAAM;gBACvE,kBAAkB,CAAC,uBAAuB,CAAC,IAAI,EAAE,UAAU;gBACzD,CAAC,CAAC;oBACE;wBACE,GAAG,EAAE,8BAAuC;wBAC5C,KAAK,EAAE,kBAAkB;wBACzB,KAAK,EACH,kBAAkB,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU;qBAC7D;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;YACP,GAAG,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,aAAa,KAAK,MAAM;gBACrE,CAAC,CAAC;oBACE;wBACE,GAAG,EAAE,gCAAyC;wBAC9C,KAAK,EAAE,aAAa;wBACpB,KAAK,EAAE,kBAAkB,kBAAkB,CAAC,uBAAuB,CAAC,IAAI,EAAE,WAAW,EAAE;qBACxF;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;YACP;gBACE,GAAG,EAAE,oBAAoB;gBACzB,KAAK,EAAE,QAAQ;gBACf,KAAK,EAAE,MAAM,CAAC,SAAS;aACxB;YACD;gBACE,GAAG,EAAE,8BAA8B;gBACnC,KAAK,EAAE,kBAAkB;gBACzB,KAAK,EAAE,cAAc,CACnB,kBAAkB,CAAC,uBAAuB,CAAC,SAAS,CACrD;aACF;YACD;gBACE,GAAG,EAAE,2BAA2B;gBAChC,KAAK,EAAE,eAAe;gBACtB,KAAK,EAAE,cAAc,CACnB,kBAAkB,CAAC,uBAAuB,CAAC,YAAY,CACxD;aACF;YACD;gBACE,GAAG,EAAE,+BAA+B;gBACpC,KAAK,EAAE,mBAAmB;gBAC1B,KAAK,EAAE,cAAc,CAAC,qBAAqB,CAAC,SAAS,CAAC;aACvD;SACF;KACF,CAAA;AACH,CAAC;AAED,MAAM,wBAAwB,GAC5B;IACE,mBAAmB;IACnB,iBAAiB;CAClB,CAAA;AAEH,eAAe,wBAAwB,CAAA","sourcesContent":["import { SubmissionTypes } from '@oneblink/types'\r\nimport {\r\n  FormStorePayment,\r\n  PaymentDisplayDetailsResult,\r\n  PaymentDisplayFormatters,\r\n  PaymentProvider,\r\n} from '../types.js'\r\n\r\ntype NSWGovPayFormSubmissionPayment = Extract<\r\n  SubmissionTypes.FormSubmissionPayment,\r\n  { type: 'NSW_GOV_PAY' }\r\n>\r\n\r\nfunction getFormStorePayment(\r\n  formSubmissionPayment: NSWGovPayFormSubmissionPayment,\r\n): FormStorePayment {\r\n  const providerTransactionId =\r\n    formSubmissionPayment.paymentTransaction?.nswGovPayPaymentReference\r\n  const providerReceiptNumber =\r\n    formSubmissionPayment.paymentTransaction?.agencyCompletionPayment\r\n      ?.paymentCompletionReference\r\n\r\n  return {\r\n    status: formSubmissionPayment.status,\r\n    ...(providerTransactionId ? { providerTransactionId } : {}),\r\n    ...(providerReceiptNumber ? { providerReceiptNumber } : {}),\r\n  }\r\n}\r\n\r\nfunction getDisplayDetails(\r\n  formSubmissionPayment: NSWGovPayFormSubmissionPayment,\r\n  {\r\n    formatCurrency,\r\n    formatDateTime,\r\n  }: PaymentDisplayFormatters,\r\n): PaymentDisplayDetailsResult | undefined {\r\n  const { paymentTransaction } = formSubmissionPayment\r\n  if (!paymentTransaction || !paymentTransaction.agencyCompletionPayment) {\r\n    return\r\n  }\r\n\r\n  const amount = {\r\n    value: paymentTransaction.agencyCompletionPayment.amount,\r\n    formatted: formatCurrency(\r\n      paymentTransaction.agencyCompletionPayment.amount,\r\n    ),\r\n  }\r\n  return {\r\n    amount,\r\n    paymentDisplayDetails: [\r\n      {\r\n        key: 'NSW_GOV_PAY_COMPLETION_REFERENCE',\r\n        label: 'Completion Reference',\r\n        value:\r\n          paymentTransaction.agencyCompletionPayment.paymentCompletionReference,\r\n      },\r\n      {\r\n        key: 'NSW_GOV_PAY_PAYMENT_REFERENCE',\r\n        label: 'Payment Reference',\r\n        value: paymentTransaction.agencyCompletionPayment.paymentReference,\r\n      },\r\n      {\r\n        key: 'NSW_GOV_PAY_BANK_REFERENCE',\r\n        label: 'Bank Reference',\r\n        value: paymentTransaction.agencyCompletionPayment.bankReference,\r\n      },\r\n      {\r\n        key: 'NSW_GOV_PAY_PAYMENT_METHOD',\r\n        label: 'Payment Method',\r\n        value: paymentTransaction.agencyCompletionPayment.paymentMethod,\r\n      },\r\n      ...(paymentTransaction.agencyCompletionPayment.paymentMethod === 'BPAY' &&\r\n      paymentTransaction.agencyCompletionPayment.bPay?.billerCode\r\n        ? [\r\n            {\r\n              key: 'NSW_GOV_PAY_BPAY_BILLER_CODE' as const,\r\n              label: 'BPay Biller Code',\r\n              value:\r\n                paymentTransaction.agencyCompletionPayment.bPay.billerCode,\r\n            },\r\n          ]\r\n        : []),\r\n      ...(paymentTransaction.agencyCompletionPayment.paymentMethod === 'CARD'\r\n        ? [\r\n            {\r\n              key: 'NSW_GOV_PAY_CREDIT_CARD_NUMBER' as const,\r\n              label: 'Card Number',\r\n              value: `xxxx xxxx xxxx ${paymentTransaction.agencyCompletionPayment.card?.last4Digits}`,\r\n            },\r\n          ]\r\n        : []),\r\n      {\r\n        key: 'NSW_GOV_PAY_AMOUNT',\r\n        label: 'Amount',\r\n        value: amount.formatted,\r\n      },\r\n      {\r\n        key: 'NSW_GOV_PAY_SURCHARGE_AMOUNT',\r\n        label: 'Surcharge Amount',\r\n        value: formatCurrency(\r\n          paymentTransaction.agencyCompletionPayment.surcharge,\r\n        ),\r\n      },\r\n      {\r\n        key: 'NSW_GOV_PAY_SURCHARGE_GST',\r\n        label: 'Surcharge GST',\r\n        value: formatCurrency(\r\n          paymentTransaction.agencyCompletionPayment.surchargeGst,\r\n        ),\r\n      },\r\n      {\r\n        key: 'NSW_GOV_PAY_CREATED_DATE_TIME',\r\n        label: 'Created Date Time',\r\n        value: formatDateTime(formSubmissionPayment.createdAt),\r\n      },\r\n    ],\r\n  }\r\n}\r\n\r\nconst nswGovPayPaymentProvider: PaymentProvider<NSWGovPayFormSubmissionPayment> =\r\n  {\r\n    getFormStorePayment,\r\n    getDisplayDetails,\r\n  }\r\n\r\nexport default nswGovPayPaymentProvider\r\n"]}

package/dist/paymentService/providers/westpacQuickStream.d.ts

@@ -0,0 +1,7 @@
+import { SubmissionTypes } from '@oneblink/types';
+import { PaymentProvider } from '../types.js';
+type WestpacQuickStreamFormSubmissionPayment = Extract<SubmissionTypes.FormSubmissionPayment, {
+    type: 'WESTPAC_QUICK_STREAM';
+}>;
+declare const westpacQuickStreamPaymentProvider: PaymentProvider<WestpacQuickStreamFormSubmissionPayment>;
+export default westpacQuickStreamPaymentProvider;

package/dist/paymentService/providers/westpacQuickStream.js

@@ -0,0 +1,64 @@
+function getFormStorePayment(formSubmissionPayment) {
+    const providerTransactionId = formSubmissionPayment.paymentTransaction?.paymentReferenceNumber;
+    const providerReceiptNumber = formSubmissionPayment.paymentTransaction?.receiptNumber;
+    return {
+        status: formSubmissionPayment.status,
+        ...(providerTransactionId ? { providerTransactionId } : {}),
+        ...(providerReceiptNumber ? { providerReceiptNumber } : {}),
+    };
+}
+function getDisplayDetails(formSubmissionPayment, { formatCurrency, formatDate }) {
+    const { paymentTransaction } = formSubmissionPayment;
+    if (!paymentTransaction) {
+        return;
+    }
+    const amount = {
+        value: paymentTransaction.totalAmount.amount,
+        formatted: formatCurrency(parseFloat(paymentTransaction.totalAmount.amount.toString())),
+    };
+    return {
+        amount,
+        paymentDisplayDetails: [
+            {
+                key: 'WESTPAC_QUICK_STREAM_RECEIPT_NUMBER',
+                label: 'Receipt Number',
+                value: paymentTransaction.receiptNumber,
+            },
+            {
+                key: 'WESTPAC_QUICK_STREAM_PAYMENT_REFERENCE_NUMBER',
+                label: 'Payment Reference',
+                value: paymentTransaction.paymentReferenceNumber,
+            },
+            {
+                key: 'WESTPAC_QUICK_STREAM_CUSTOMER_REFERENCE_NUMBER',
+                label: 'Customer Reference Number',
+                value: paymentTransaction.customerReferenceNumber,
+            },
+            {
+                key: 'WESTPAC_QUICK_STREAM_AMOUNT',
+                label: 'Amount',
+                value: amount.formatted,
+            },
+            ...(paymentTransaction.surchargeAmount.amount
+                ? [
+                    {
+                        key: 'WESTPAC_QUICK_STREAM_SURCHARGE_AMOUNT',
+                        label: 'Surcharge Amount',
+                        value: formatCurrency(parseFloat(paymentTransaction.surchargeAmount.amount.toString())),
+                    },
+                ]
+                : []),
+            {
+                key: 'WESTPAC_QUICK_STREAM_SETTLEMENT_DATE',
+                label: 'Settlement Date',
+                value: formatDate(paymentTransaction.settlementDate),
+            },
+        ],
+    };
+}
+const westpacQuickStreamPaymentProvider = {
+    getFormStorePayment,
+    getDisplayDetails,
+};
+export default westpacQuickStreamPaymentProvider;
+//# sourceMappingURL=westpacQuickStream.js.map

package/dist/paymentService/providers/westpacQuickStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"westpacQuickStream.js","sourceRoot":"","sources":["../../../src/paymentService/providers/westpacQuickStream.ts"],"names":[],"mappings":"AAaA,SAAS,mBAAmB,CAC1B,qBAA8D;IAE9D,MAAM,qBAAqB,GACzB,qBAAqB,CAAC,kBAAkB,EAAE,sBAAsB,CAAA;IAClE,MAAM,qBAAqB,GACzB,qBAAqB,CAAC,kBAAkB,EAAE,aAAa,CAAA;IAEzD,OAAO;QACL,MAAM,EAAE,qBAAqB,CAAC,MAAM;QACpC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC5D,CAAA;AACH,CAAC;AAED,SAAS,iBAAiB,CACxB,qBAA8D,EAC9D,EAAE,cAAc,EAAE,UAAU,EAA4B;IAExD,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAA;IACpD,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACxB,OAAM;IACR,CAAC;IAED,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,kBAAkB,CAAC,WAAW,CAAC,MAAM;QAC5C,SAAS,EAAE,cAAc,CACvB,UAAU,CAAC,kBAAkB,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAC7D;KACF,CAAA;IAED,OAAO;QACL,MAAM;QACN,qBAAqB,EAAE;YACrB;gBACE,GAAG,EAAE,qCAAqC;gBAC1C,KAAK,EAAE,gBAAgB;gBACvB,KAAK,EAAE,kBAAkB,CAAC,aAAa;aACxC;YACD;gBACE,GAAG,EAAE,+CAA+C;gBACpD,KAAK,EAAE,mBAAmB;gBAC1B,KAAK,EAAE,kBAAkB,CAAC,sBAAsB;aACjD;YACD;gBACE,GAAG,EAAE,gDAAgD;gBACrD,KAAK,EAAE,2BAA2B;gBAClC,KAAK,EAAE,kBAAkB,CAAC,uBAAuB;aAClD;YACD;gBACE,GAAG,EAAE,6BAA6B;gBAClC,KAAK,EAAE,QAAQ;gBACf,KAAK,EAAE,MAAM,CAAC,SAAS;aACxB;YACD,GAAG,CAAC,kBAAkB,CAAC,eAAe,CAAC,MAAM;gBAC3C,CAAC,CAAC;oBACE;wBACE,GAAG,EAAE,uCAAgD;wBACrD,KAAK,EAAE,kBAAkB;wBACzB,KAAK,EAAE,cAAc,CACnB,UAAU,CACR,kBAAkB,CAAC,eAAe,CAAC,MAAM,CAAC,QAAQ,EAAE,CACrD,CACF;qBACF;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;YACP;gBACE,GAAG,EAAE,sCAAsC;gBAC3C,KAAK,EAAE,iBAAiB;gBACxB,KAAK,EAAE,UAAU,CAAC,kBAAkB,CAAC,cAAc,CAAC;aACrD;SACF;KACF,CAAA;AACH,CAAC;AAED,MAAM,iCAAiC,GACrC;IACE,mBAAmB;IACnB,iBAAiB;CAClB,CAAA;AAEH,eAAe,iCAAiC,CAAA","sourcesContent":["import { SubmissionTypes } from '@oneblink/types'\r\nimport {\r\n  FormStorePayment,\r\n  PaymentDisplayDetailsResult,\r\n  PaymentDisplayFormatters,\r\n  PaymentProvider,\r\n} from '../types.js'\r\n\r\ntype WestpacQuickStreamFormSubmissionPayment = Extract<\r\n  SubmissionTypes.FormSubmissionPayment,\r\n  { type: 'WESTPAC_QUICK_STREAM' }\r\n>\r\n\r\nfunction getFormStorePayment(\r\n  formSubmissionPayment: WestpacQuickStreamFormSubmissionPayment,\r\n): FormStorePayment {\r\n  const providerTransactionId =\r\n    formSubmissionPayment.paymentTransaction?.paymentReferenceNumber\r\n  const providerReceiptNumber =\r\n    formSubmissionPayment.paymentTransaction?.receiptNumber\r\n\r\n  return {\r\n    status: formSubmissionPayment.status,\r\n    ...(providerTransactionId ? { providerTransactionId } : {}),\r\n    ...(providerReceiptNumber ? { providerReceiptNumber } : {}),\r\n  }\r\n}\r\n\r\nfunction getDisplayDetails(\r\n  formSubmissionPayment: WestpacQuickStreamFormSubmissionPayment,\r\n  { formatCurrency, formatDate }: PaymentDisplayFormatters,\r\n): PaymentDisplayDetailsResult | undefined {\r\n  const { paymentTransaction } = formSubmissionPayment\r\n  if (!paymentTransaction) {\r\n    return\r\n  }\r\n\r\n  const amount = {\r\n    value: paymentTransaction.totalAmount.amount,\r\n    formatted: formatCurrency(\r\n      parseFloat(paymentTransaction.totalAmount.amount.toString()),\r\n    ),\r\n  }\r\n\r\n  return {\r\n    amount,\r\n    paymentDisplayDetails: [\r\n      {\r\n        key: 'WESTPAC_QUICK_STREAM_RECEIPT_NUMBER',\r\n        label: 'Receipt Number',\r\n        value: paymentTransaction.receiptNumber,\r\n      },\r\n      {\r\n        key: 'WESTPAC_QUICK_STREAM_PAYMENT_REFERENCE_NUMBER',\r\n        label: 'Payment Reference',\r\n        value: paymentTransaction.paymentReferenceNumber,\r\n      },\r\n      {\r\n        key: 'WESTPAC_QUICK_STREAM_CUSTOMER_REFERENCE_NUMBER',\r\n        label: 'Customer Reference Number',\r\n        value: paymentTransaction.customerReferenceNumber,\r\n      },\r\n      {\r\n        key: 'WESTPAC_QUICK_STREAM_AMOUNT',\r\n        label: 'Amount',\r\n        value: amount.formatted,\r\n      },\r\n      ...(paymentTransaction.surchargeAmount.amount\r\n        ? [\r\n            {\r\n              key: 'WESTPAC_QUICK_STREAM_SURCHARGE_AMOUNT' as const,\r\n              label: 'Surcharge Amount',\r\n              value: formatCurrency(\r\n                parseFloat(\r\n                  paymentTransaction.surchargeAmount.amount.toString(),\r\n                ),\r\n              ),\r\n            },\r\n          ]\r\n        : []),\r\n      {\r\n        key: 'WESTPAC_QUICK_STREAM_SETTLEMENT_DATE',\r\n        label: 'Settlement Date',\r\n        value: formatDate(paymentTransaction.settlementDate),\r\n      },\r\n    ],\r\n  }\r\n}\r\n\r\nconst westpacQuickStreamPaymentProvider: PaymentProvider<WestpacQuickStreamFormSubmissionPayment> =\r\n  {\r\n    getFormStorePayment,\r\n    getDisplayDetails,\r\n  }\r\n\r\nexport default westpacQuickStreamPaymentProvider\r\n"]}

package/dist/paymentService/types.d.ts

@@ -0,0 +1,25 @@
+import { SubmissionEventTypes, SubmissionTypes } from '@oneblink/types';
+import { ReplaceInjectablesFormatters } from '../submissionService.js';
+export type FormStorePayment = NonNullable<SubmissionTypes.FormStoreRecord['payment']>;
+export type PaymentDisplayDetail = {
+    label: string;
+    value: string;
+    /** A unique key across payment providers to identify the detail */
+    key: SubmissionEventTypes.PaymentDisplayDetailKey;
+};
+export type PaymentDisplayDetailsResult = {
+    amount: {
+        value: number;
+        formatted: string;
+    };
+    paymentDisplayDetails: PaymentDisplayDetail[];
+};
+export type PaymentDisplayFormatters = Pick<ReplaceInjectablesFormatters, 'formatCurrency' | 'formatDate' | 'formatDateTime'>;
+/**
+ * Pure transforms for a payment provider. Implementations must not perform
+ * HTTP or other I/O — they only accept known types and return values.
+ */
+export interface PaymentProvider<T extends SubmissionTypes.FormSubmissionPayment> {
+    getFormStorePayment(formSubmissionPayment: T): FormStorePayment;
+    getDisplayDetails(formSubmissionPayment: T, formatters: PaymentDisplayFormatters): PaymentDisplayDetailsResult | undefined;
+}

package/dist/paymentService/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/paymentService/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/paymentService/types.ts"],"names":[],"mappings":"","sourcesContent":["import { SubmissionEventTypes, SubmissionTypes } from '@oneblink/types'\r\nimport { ReplaceInjectablesFormatters } from '../submissionService.js'\r\n\r\nexport type FormStorePayment = NonNullable<\r\n  SubmissionTypes.FormStoreRecord['payment']\r\n>\r\n\r\nexport type PaymentDisplayDetail = {\r\n  label: string\r\n  value: string\r\n  /** A unique key across payment providers to identify the detail */\r\n  key: SubmissionEventTypes.PaymentDisplayDetailKey\r\n}\r\n\r\nexport type PaymentDisplayDetailsResult = {\r\n  amount: {\r\n    value: number\r\n    formatted: string\r\n  }\r\n  paymentDisplayDetails: PaymentDisplayDetail[]\r\n}\r\n\r\nexport type PaymentDisplayFormatters = Pick<\r\n  ReplaceInjectablesFormatters,\r\n  'formatCurrency' | 'formatDate' | 'formatDateTime'\r\n>\r\n\r\n/**\r\n * Pure transforms for a payment provider. Implementations must not perform\r\n * HTTP or other I/O — they only accept known types and return values.\r\n */\r\nexport interface PaymentProvider<\r\n  T extends SubmissionTypes.FormSubmissionPayment,\r\n> {\r\n  getFormStorePayment(formSubmissionPayment: T): FormStorePayment\r\n  getDisplayDetails(\r\n    formSubmissionPayment: T,\r\n    formatters: PaymentDisplayFormatters,\r\n  ): PaymentDisplayDetailsResult | undefined\r\n}\r\n"]}

package/dist/paymentService.d.ts

@@ -1,6 +1,7 @@
 import { FormTypes, SubmissionEventTypes, SubmissionTypes } from '@oneblink/types';
-import { ReplaceInjectablesFormatters } from './submissionService.js';
 import { AddOffsetToDate, EndOfDay, ParseDayOnlyDate, StartOfDay } from './conditionalLogicService/types.js';
+import type { FormStorePayment, PaymentDisplayDetail, PaymentDisplayFormatters, PaymentDisplayDetailsResult } from './paymentService/types.js';
+export { FormStorePayment, PaymentDisplayDetail, PaymentDisplayDetailsResult, PaymentDisplayFormatters, };
 /**
  * Examine a submission and its form definition to validate whether a payment
  * workflow event needs to run.
@@ -48,12 +49,6 @@ export declare function checkForPaymentEvent({ definition, submission, submissio
     paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent;
     amount: number;
 } | undefined;
-type PaymentDisplayDetail = {
-    label: string;
-    value: string;
-    /** A unique key across payment providers to identify the detail */
-    key: SubmissionEventTypes.PaymentDisplayDetailKey;
-};
 /**
  * Retrieve an array of detail items from a form submission payment.
  *
@@ -77,11 +72,20 @@ type PaymentDisplayDetail = {
  */
 export declare const getDisplayDetailsFromFormSubmissionPayment: (
 /** The form submission payment to get the details from */
-formSubmissionPayment: SubmissionTypes.FormSubmissionPayment, { formatCurrency, formatDateTime, formatDate, }: Pick<ReplaceInjectablesFormatters, "formatCurrency" | "formatDate" | "formatDateTime">) => {
-    amount: {
-        value: number;
-        formatted: string;
-    };
-    paymentDisplayDetails: PaymentDisplayDetail[];
-} | undefined;
-export {};
+formSubmissionPayment: SubmissionTypes.FormSubmissionPayment, formatters: PaymentDisplayFormatters) => PaymentDisplayDetailsResult | undefined;
+/**
+ * Map a form submission payment to the Form Store payment property.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formStorePayment =
+ *   paymentService.getFormStorePaymentFromFormSubmissionPayment(
+ *     formSubmissionPayment,
+ *   )
+ * ```
+ *
+ * @param formSubmissionPayment
+ * @returns
+ */
+export declare function getFormStorePaymentFromFormSubmissionPayment(formSubmissionPayment: SubmissionTypes.FormSubmissionPayment): FormStorePayment;

package/dist/paymentService.js

@@ -1,5 +1,6 @@
 import { conditionalLogicService, formElementsService } from './index.js';
-import { getRootElementValueById, } from './submissionService.js';
+import { getRootElementValueById } from './submissionService.js';
+import getPaymentProvider from './paymentService/getPaymentProvider.js';
 /**
  * Examine a submission and its form definition to validate whether a payment
  * workflow event needs to run.
@@ -95,290 +96,25 @@ export function checkForPaymentEvent({ definition, submission, submissionTimesta
  */
 export const getDisplayDetailsFromFormSubmissionPayment = (
 /** The form submission payment to get the details from */
-formSubmissionPayment, { formatCurrency, formatDateTime, formatDate, }) => {
-    switch (formSubmissionPayment.type) {
-        case 'NSW_GOV_PAY': {
-            const { paymentTransaction } = formSubmissionPayment;
-            if (!paymentTransaction || !paymentTransaction.agencyCompletionPayment) {
-                return;
-            }
-            const amount = {
-                value: paymentTransaction.agencyCompletionPayment.amount,
-                formatted: formatCurrency(paymentTransaction.agencyCompletionPayment.amount),
-            };
-            return {
-                amount,
-                paymentDisplayDetails: [
-                    {
-                        key: 'NSW_GOV_PAY_COMPLETION_REFERENCE',
-                        label: 'Completion Reference',
-                        value: paymentTransaction.agencyCompletionPayment
-                            .paymentCompletionReference,
-                    },
-                    {
-                        key: 'NSW_GOV_PAY_PAYMENT_REFERENCE',
-                        label: 'Payment Reference',
-                        value: paymentTransaction.agencyCompletionPayment.paymentReference,
-                    },
-                    {
-                        key: 'NSW_GOV_PAY_BANK_REFERENCE',
-                        label: 'Bank Reference',
-                        value: paymentTransaction.agencyCompletionPayment.bankReference,
-                    },
-                    {
-                        key: 'NSW_GOV_PAY_PAYMENT_METHOD',
-                        label: 'Payment Method',
-                        value: paymentTransaction.agencyCompletionPayment.paymentMethod,
-                    },
-                    ...(paymentTransaction.agencyCompletionPayment.paymentMethod ===
-                        'BPAY' &&
-                        paymentTransaction.agencyCompletionPayment.bPay?.billerCode
-                        ? [
-                            {
-                                key: 'NSW_GOV_PAY_BPAY_BILLER_CODE',
-                                label: 'BPay Biller Code',
-                                value: paymentTransaction.agencyCompletionPayment.bPay.billerCode,
-                            },
-                        ]
-                        : []),
-                    ...(paymentTransaction.agencyCompletionPayment.paymentMethod ===
-                        'CARD'
-                        ? [
-                            {
-                                key: 'NSW_GOV_PAY_CREDIT_CARD_NUMBER',
-                                label: 'Card Number',
-                                value: `xxxx xxxx xxxx ${paymentTransaction.agencyCompletionPayment.card?.last4Digits}`,
-                            },
-                        ]
-                        : []),
-                    {
-                        key: 'NSW_GOV_PAY_AMOUNT',
-                        label: 'Amount',
-                        value: amount.formatted,
-                    },
-                    {
-                        key: 'NSW_GOV_PAY_SURCHARGE_AMOUNT',
-                        label: 'Surcharge Amount',
-                        value: formatCurrency(paymentTransaction.agencyCompletionPayment.surcharge),
-                    },
-                    {
-                        key: 'NSW_GOV_PAY_SURCHARGE_GST',
-                        label: 'Surcharge GST',
-                        value: formatCurrency(paymentTransaction.agencyCompletionPayment.surchargeGst),
-                    },
-                    {
-                        key: 'NSW_GOV_PAY_CREATED_DATE_TIME',
-                        label: 'Created Date Time',
-                        value: formatDateTime(formSubmissionPayment.createdAt),
-                    },
-                ],
-            };
-        }
-        case 'BPOINT': {
-            const { paymentTransaction } = formSubmissionPayment;
-            if (!paymentTransaction) {
-                return;
-            }
-            const amountValue = paymentTransaction.Amount / 100;
-            const amount = {
-                value: amountValue,
-                formatted: formatCurrency(amountValue),
-            };
-            return {
-                amount,
-                paymentDisplayDetails: [
-                    {
-                        key: 'BPOINT_RECEIPT_NUMBER',
-                        label: 'Receipt Number',
-                        value: paymentTransaction.ReceiptNumber,
-                    },
-                    {
-                        key: 'BPOINT_CRN1',
-                        label: 'CRN 1',
-                        value: paymentTransaction.Crn1,
-                    },
-                    {
-                        key: 'BPOINT_CRN2',
-                        label: 'CRN 2',
-                        value: paymentTransaction.Crn2,
-                    },
-                    {
-                        key: 'BPOINT_CRN3',
-                        label: 'CRN 3',
-                        value: paymentTransaction.Crn3,
-                    },
-                    {
-                        key: 'BPOINT_BILLER_CODE',
-                        label: 'Biller Code',
-                        value: paymentTransaction.BillerCode,
-                    },
-                    {
-                        key: 'BPOINT_CREDIT_CARD_MASK',
-                        label: 'Card Number',
-                        value: paymentTransaction.CardDetails.MaskedCardNumber,
-                    },
-                    {
-                        key: 'BPOINT_AMOUNT',
-                        label: 'Amount',
-                        value: amount.formatted,
-                    },
-                    {
-                        key: 'BPOINT_SURCHARGE_AMOUNT',
-                        label: 'Surcharge Amount',
-                        value: formatCurrency(paymentTransaction.AmountSurcharge / 100),
-                    },
-                    {
-                        key: 'BPOINT_PROCESSED_DATE_TIME',
-                        label: 'Processed Date Time',
-                        value: formatDateTime(paymentTransaction.ProcessedDateTime),
-                    },
-                ],
-            };
-        }
-        case 'CP_PAY': {
-            const { paymentTransaction } = formSubmissionPayment;
-            if (!paymentTransaction) {
-                return;
-            }
-            const determineDetails = () => {
-                switch (paymentTransaction.cpPayVersion) {
-                    case 'v2': {
-                        return {
-                            transactionId: paymentTransaction.result.id,
-                            orderNumber: paymentTransaction.result.externalReferenceId ?? undefined,
-                            paymentType: paymentTransaction.result.paymentType,
-                            creditCardMask: paymentTransaction.result.lastFour
-                                ? `xxxx xxxx xxxx ${paymentTransaction.result.lastFour}`
-                                : undefined,
-                            amount: paymentTransaction.result.amount !== undefined
-                                ? {
-                                    value: paymentTransaction.result.amount,
-                                    formatted: formatCurrency(paymentTransaction.result.amount),
-                                }
-                                : {
-                                    value: NaN,
-                                    formatted: 'Unknown',
-                                },
-                            createdDateTime: paymentTransaction.result.createdOnUtc,
-                        };
-                    }
-                    default: {
-                        return {
-                            transactionId: paymentTransaction.transactionId,
-                            orderNumber: paymentTransaction.orderNumber ?? undefined,
-                            paymentType: paymentTransaction.paymentTypeId === 1
-                                ? 'Credit/Debit Card'
-                                : paymentTransaction.paymentTypeId === 2
-                                    ? 'ACH'
-                                    : undefined,
-                            creditCardMask: paymentTransaction.lastFour
-                                ? `xxxx xxxx xxxx ${paymentTransaction.lastFour}`
-                                : undefined,
-                            amount: {
-                                value: paymentTransaction.amount,
-                                formatted: formatCurrency(paymentTransaction.amount),
-                            },
-                            createdDateTime: paymentTransaction.createdAt,
-                        };
-                    }
-                }
-            };
-            const { transactionId, orderNumber, paymentType, creditCardMask, amount, createdDateTime, } = determineDetails();
-            const paymentDisplayDetails = [];
-            if (transactionId) {
-                paymentDisplayDetails.push({
-                    key: 'CP_PAY_TRANSACTION_ID',
-                    label: 'Transaction Id',
-                    value: transactionId,
-                });
-            }
-            if (orderNumber) {
-                paymentDisplayDetails.push({
-                    key: 'CP_PAY_ORDER_NUMBER',
-                    label: 'Order Number',
-                    value: orderNumber,
-                });
-            }
-            if (paymentType) {
-                paymentDisplayDetails.push({
-                    key: 'CP_PAY_PAYMENT_TYPE',
-                    label: 'Payment Type',
-                    value: paymentType,
-                });
-            }
-            if (creditCardMask) {
-                paymentDisplayDetails.push({
-                    key: 'CP_PAY_CREDIT_CARD_MASK',
-                    label: 'Card Number',
-                    value: creditCardMask,
-                });
-            }
-            paymentDisplayDetails.push({
-                key: 'CP_PAY_AMOUNT',
-                label: 'Amount',
-                value: amount.formatted,
-            });
-            if (createdDateTime) {
-                paymentDisplayDetails.push({
-                    key: 'CP_PAY_CREATED_DATE_TIME',
-                    label: 'Created At',
-                    value: formatDateTime(createdDateTime),
-                });
-            }
-            return {
-                amount,
-                paymentDisplayDetails,
-            };
-        }
-        case 'WESTPAC_QUICK_STREAM': {
-            const { paymentTransaction } = formSubmissionPayment;
-            if (!paymentTransaction) {
-                return;
-            }
-            const amount = {
-                value: paymentTransaction.totalAmount.amount,
-                formatted: formatCurrency(parseFloat(paymentTransaction.totalAmount.amount.toString())),
-            };
-            return {
-                amount,
-                paymentDisplayDetails: [
-                    {
-                        key: 'WESTPAC_QUICK_STREAM_RECEIPT_NUMBER',
-                        label: 'Receipt Number',
-                        value: paymentTransaction.receiptNumber,
-                    },
-                    {
-                        key: 'WESTPAC_QUICK_STREAM_PAYMENT_REFERENCE_NUMBER',
-                        label: 'Payment Reference',
-                        value: paymentTransaction.paymentReferenceNumber,
-                    },
-                    {
-                        key: 'WESTPAC_QUICK_STREAM_CUSTOMER_REFERENCE_NUMBER',
-                        label: 'Customer Reference Number',
-                        value: paymentTransaction.customerReferenceNumber,
-                    },
-                    {
-                        key: 'WESTPAC_QUICK_STREAM_AMOUNT',
-                        label: 'Amount',
-                        value: amount.formatted,
-                    },
-                    ...(paymentTransaction.surchargeAmount.amount
-                        ? [
-                            {
-                                key: 'WESTPAC_QUICK_STREAM_SURCHARGE_AMOUNT',
-                                label: 'Surcharge Amount',
-                                value: formatCurrency(parseFloat(paymentTransaction.surchargeAmount.amount.toString())),
-                            },
-                        ]
-                        : []),
-                    {
-                        key: 'WESTPAC_QUICK_STREAM_SETTLEMENT_DATE',
-                        label: 'Settlement Date',
-                        value: formatDate(paymentTransaction.settlementDate),
-                    },
-                ],
-            };
-        }
-    }
+formSubmissionPayment, formatters) => {
+    return getPaymentProvider(formSubmissionPayment.type).getDisplayDetails(formSubmissionPayment, formatters);
 };
+/**
+ * Map a form submission payment to the Form Store payment property.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formStorePayment =
+ *   paymentService.getFormStorePaymentFromFormSubmissionPayment(
+ *     formSubmissionPayment,
+ *   )
+ * ```
+ *
+ * @param formSubmissionPayment
+ * @returns
+ */
+export function getFormStorePaymentFromFormSubmissionPayment(formSubmissionPayment) {
+    return getPaymentProvider(formSubmissionPayment.type).getFormStorePayment(formSubmissionPayment);
+}
 //# sourceMappingURL=paymentService.js.map

package/dist/paymentService.js.map

@@ -1 +1 @@
-{"version":3,"file":"paymentService.js","sourceRoot":"","sources":["../src/paymentService.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AACzE,OAAO,EACL,uBAAuB,GAExB,MAAM,wBAAwB,CAAA;AAQ/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,oBAAoB,CAAC,EACnC,UAAU,EACV,UAAU,EACV,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,EACb,UAAU,EACV,QAAQ,GAcT;IAMC,MAAM,uBAAuB,GAAG,UAAU,CAAC,aAAa,IAAI,EAAE,CAAA;IAC9D,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,IAAI,CACzD,CAAC,sBAAsB,EAAE,EAAE;QACzB,OAAO,CACL,sBAAsB;YACtB,uBAAuB,CAAC,6BAA6B,CAAC;gBACpD,aAAa,EAAE,CAAC,CAAC,sBAAsB,CAAC,oBAAoB;gBAC5D,gCAAgC,EAC9B,CAAC,CAAC,sBAAsB,CAAC,yCAAyC;gBACpE,qBAAqB,EACnB,sBAAsB,CAAC,8BAA8B,IAAI,EAAE;gBAC7D,UAAU,EAAE,UAAU;gBACtB,YAAY,EAAE,UAAU,CAAC,QAAQ;gBACjC,mBAAmB;gBACnB,gBAAgB;gBAChB,aAAa;gBACb,UAAU;gBACV,QAAQ;aACT,CAAC,CACH,CAAA;IACH,CAAC,CACF,CAAA;IAED,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC5B,OAAM;IACR,CAAC;IACD,OAAO,CAAC,GAAG,CACT,uEAAuE,CACxE,CAAA;IAED,MAAM,aAAa,GAAG,mBAAmB,CAAC,eAAe,CACvD,UAAU,CAAC,QAAQ,EACnB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,sBAAsB,CAAC,aAAa,CAAC,SAAS,CAC3E,CAAA;IACD,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACpD,OAAO,CAAC,GAAG,CACT,2FAA2F,CAC5F,CAAA;QACD,MAAM,IAAI,KAAK,CACb,6KAA6K,CAC9K,CAAA;IACH,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,iDAAiD,EAAE,aAAa,CAAC,CAAA;IAE7E,MAAM,MAAM,GAAG,uBAAuB,CACpC,aAAa,CAAC,EAAE,EAChB,UAAU,CAAC,QAAQ,EACnB,UAAU,CACX,CAAA;IAED,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,GAAG,CACT,wHAAwH,CACzH,CAAA;QACD,OAAM;IACR,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,CAAC,GAAG,CACT,oFAAoF,CACrF,CAAA;QACD,MAAM,IAAI,KAAK,CACb,wKAAwK,CACzK,CAAA;IACH,CAAC;IAED,MAAM,MAAM,GAAG;QACb,sBAAsB;QACtB,MAAM;KACP,CAAA;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AASD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,0CAA0C,GAAG;AACxD,0DAA0D;AAC1D,qBAA4D,EAC5D,EACE,cAAc,EACd,cAAc,EACd,UAAU,GAIX,EASW,EAAE;IACd,QAAQ,qBAAqB,CAAC,IAAI,EAAE,CAAC;QACnC,KAAK,aAAa,CAAC,CAAC,CAAC;YACnB,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAA;YACpD,IAAI,CAAC,kBAAkB,IAAI,CAAC,kBAAkB,CAAC,uBAAuB,EAAE,CAAC;gBACvE,OAAM;YACR,CAAC;YAED,MAAM,MAAM,GAAG;gBACb,KAAK,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,MAAM;gBACxD,SAAS,EAAE,cAAc,CACvB,kBAAkB,CAAC,uBAAuB,CAAC,MAAM,CAClD;aACF,CAAA;YACD,OAAO;gBACL,MAAM;gBACN,qBAAqB,EAAE;oBACrB;wBACE,GAAG,EAAE,kCAAkC;wBACvC,KAAK,EAAE,sBAAsB;wBAC7B,KAAK,EACH,kBAAkB,CAAC,uBAAuB;6BACvC,0BAA0B;qBAChC;oBACD;wBACE,GAAG,EAAE,+BAA+B;wBACpC,KAAK,EAAE,mBAAmB;wBAC1B,KAAK,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,gBAAgB;qBACnE;oBACD;wBACE,GAAG,EAAE,4BAA4B;wBACjC,KAAK,EAAE,gBAAgB;wBACvB,KAAK,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,aAAa;qBAChE;oBACD;wBACE,GAAG,EAAE,4BAA4B;wBACjC,KAAK,EAAE,gBAAgB;wBACvB,KAAK,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,aAAa;qBAChE;oBACD,GAAG,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,aAAa;wBAC1D,MAAM;wBACR,kBAAkB,CAAC,uBAAuB,CAAC,IAAI,EAAE,UAAU;wBACzD,CAAC,CAAC;4BACE;gCACE,GAAG,EAAE,8BAAuC;gCAC5C,KAAK,EAAE,kBAAkB;gCACzB,KAAK,EACH,kBAAkB,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU;6BAC7D;yBACF;wBACH,CAAC,CAAC,EAAE,CAAC;oBACP,GAAG,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,aAAa;wBAC5D,MAAM;wBACJ,CAAC,CAAC;4BACE;gCACE,GAAG,EAAE,gCAAyC;gCAC9C,KAAK,EAAE,aAAa;gCACpB,KAAK,EAAE,kBAAkB,kBAAkB,CAAC,uBAAuB,CAAC,IAAI,EAAE,WAAW,EAAE;6BACxF;yBACF;wBACH,CAAC,CAAC,EAAE,CAAC;oBACP;wBACE,GAAG,EAAE,oBAAoB;wBACzB,KAAK,EAAE,QAAQ;wBACf,KAAK,EAAE,MAAM,CAAC,SAAS;qBACxB;oBACD;wBACE,GAAG,EAAE,8BAA8B;wBACnC,KAAK,EAAE,kBAAkB;wBACzB,KAAK,EAAE,cAAc,CACnB,kBAAkB,CAAC,uBAAuB,CAAC,SAAS,CACrD;qBACF;oBACD;wBACE,GAAG,EAAE,2BAA2B;wBAChC,KAAK,EAAE,eAAe;wBACtB,KAAK,EAAE,cAAc,CACnB,kBAAkB,CAAC,uBAAuB,CAAC,YAAY,CACxD;qBACF;oBACD;wBACE,GAAG,EAAE,+BAA+B;wBACpC,KAAK,EAAE,mBAAmB;wBAC1B,KAAK,EAAE,cAAc,CAAC,qBAAqB,CAAC,SAAS,CAAC;qBACvD;iBACF;aACF,CAAA;QACH,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAA;YACpD,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACxB,OAAM;YACR,CAAC;YACD,MAAM,WAAW,GAAG,kBAAkB,CAAC,MAAM,GAAG,GAAG,CAAA;YACnD,MAAM,MAAM,GAAG;gBACb,KAAK,EAAE,WAAW;gBAClB,SAAS,EAAE,cAAc,CAAC,WAAW,CAAC;aACvC,CAAA;YACD,OAAO;gBACL,MAAM;gBACN,qBAAqB,EAAE;oBACrB;wBACE,GAAG,EAAE,uBAAuB;wBAC5B,KAAK,EAAE,gBAAgB;wBACvB,KAAK,EAAE,kBAAkB,CAAC,aAAa;qBACxC;oBACD;wBACE,GAAG,EAAE,aAAa;wBAClB,KAAK,EAAE,OAAO;wBACd,KAAK,EAAE,kBAAkB,CAAC,IAAI;qBAC/B;oBACD;wBACE,GAAG,EAAE,aAAa;wBAClB,KAAK,EAAE,OAAO;wBACd,KAAK,EAAE,kBAAkB,CAAC,IAAI;qBAC/B;oBACD;wBACE,GAAG,EAAE,aAAa;wBAClB,KAAK,EAAE,OAAO;wBACd,KAAK,EAAE,kBAAkB,CAAC,IAAI;qBAC/B;oBACD;wBACE,GAAG,EAAE,oBAAoB;wBACzB,KAAK,EAAE,aAAa;wBACpB,KAAK,EAAE,kBAAkB,CAAC,UAAU;qBACrC;oBACD;wBACE,GAAG,EAAE,yBAAyB;wBAC9B,KAAK,EAAE,aAAa;wBACpB,KAAK,EAAE,kBAAkB,CAAC,WAAW,CAAC,gBAAgB;qBACvD;oBACD;wBACE,GAAG,EAAE,eAAe;wBACpB,KAAK,EAAE,QAAQ;wBACf,KAAK,EAAE,MAAM,CAAC,SAAS;qBACxB;oBACD;wBACE,GAAG,EAAE,yBAAyB;wBAC9B,KAAK,EAAE,kBAAkB;wBACzB,KAAK,EAAE,cAAc,CAAC,kBAAkB,CAAC,eAAe,GAAG,GAAG,CAAC;qBAChE;oBACD;wBACE,GAAG,EAAE,4BAA4B;wBACjC,KAAK,EAAE,qBAAqB;wBAC5B,KAAK,EAAE,cAAc,CAAC,kBAAkB,CAAC,iBAAiB,CAAC;qBAC5D;iBACF;aACF,CAAA;QACH,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAA;YACpD,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACxB,OAAM;YACR,CAAC;YAED,MAAM,gBAAgB,GAAG,GAAG,EAAE;gBAC5B,QAAQ,kBAAkB,CAAC,YAAY,EAAE,CAAC;oBACxC,KAAK,IAAI,CAAC,CAAC,CAAC;wBACV,OAAO;4BACL,aAAa,EAAE,kBAAkB,CAAC,MAAM,CAAC,EAAE;4BAC3C,WAAW,EACT,kBAAkB,CAAC,MAAM,CAAC,mBAAmB,IAAI,SAAS;4BAC5D,WAAW,EAAE,kBAAkB,CAAC,MAAM,CAAC,WAAW;4BAClD,cAAc,EAAE,kBAAkB,CAAC,MAAM,CAAC,QAAQ;gCAChD,CAAC,CAAC,kBAAkB,kBAAkB,CAAC,MAAM,CAAC,QAAQ,EAAE;gCACxD,CAAC,CAAC,SAAS;4BACb,MAAM,EACJ,kBAAkB,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS;gCAC5C,CAAC,CAAC;oCACE,KAAK,EAAE,kBAAkB,CAAC,MAAM,CAAC,MAAM;oCACvC,SAAS,EAAE,cAAc,CACvB,kBAAkB,CAAC,MAAM,CAAC,MAAM,CACjC;iCACF;gCACH,CAAC,CAAC;oCACE,KAAK,EAAE,GAAG;oCACV,SAAS,EAAE,SAAS;iCACrB;4BACP,eAAe,EAAE,kBAAkB,CAAC,MAAM,CAAC,YAAY;yBACxD,CAAA;oBACH,CAAC;oBACD,OAAO,CAAC,CAAC,CAAC;wBACR,OAAO;4BACL,aAAa,EAAE,kBAAkB,CAAC,aAAa;4BAC/C,WAAW,EAAE,kBAAkB,CAAC,WAAW,IAAI,SAAS;4BACxD,WAAW,EACT,kBAAkB,CAAC,aAAa,KAAK,CAAC;gCACpC,CAAC,CAAC,mBAAmB;gCACrB,CAAC,CAAC,kBAAkB,CAAC,aAAa,KAAK,CAAC;oCACtC,CAAC,CAAC,KAAK;oCACP,CAAC,CAAC,SAAS;4BACjB,cAAc,EAAE,kBAAkB,CAAC,QAAQ;gCACzC,CAAC,CAAC,kBAAkB,kBAAkB,CAAC,QAAQ,EAAE;gCACjD,CAAC,CAAC,SAAS;4BACb,MAAM,EAAE;gCACN,KAAK,EAAE,kBAAkB,CAAC,MAAM;gCAChC,SAAS,EAAE,cAAc,CAAC,kBAAkB,CAAC,MAAM,CAAC;6BACrD;4BACD,eAAe,EAAE,kBAAkB,CAAC,SAAS;yBAC9C,CAAA;oBACH,CAAC;gBACH,CAAC;YACH,CAAC,CAAA;YAED,MAAM,EACJ,aAAa,EACb,WAAW,EACX,WAAW,EACX,cAAc,EACd,MAAM,EACN,eAAe,GAChB,GAAG,gBAAgB,EAAE,CAAA;YACtB,MAAM,qBAAqB,GAA2B,EAAE,CAAA;YACxD,IAAI,aAAa,EAAE,CAAC;gBAClB,qBAAqB,CAAC,IAAI,CAAC;oBACzB,GAAG,EAAE,uBAAuB;oBAC5B,KAAK,EAAE,gBAAgB;oBACvB,KAAK,EAAE,aAAa;iBACrB,CAAC,CAAA;YACJ,CAAC;YACD,IAAI,WAAW,EAAE,CAAC;gBAChB,qBAAqB,CAAC,IAAI,CAAC;oBACzB,GAAG,EAAE,qBAAqB;oBAC1B,KAAK,EAAE,cAAc;oBACrB,KAAK,EAAE,WAAW;iBACnB,CAAC,CAAA;YACJ,CAAC;YACD,IAAI,WAAW,EAAE,CAAC;gBAChB,qBAAqB,CAAC,IAAI,CAAC;oBACzB,GAAG,EAAE,qBAAqB;oBAC1B,KAAK,EAAE,cAAc;oBACrB,KAAK,EAAE,WAAW;iBACnB,CAAC,CAAA;YACJ,CAAC;YACD,IAAI,cAAc,EAAE,CAAC;gBACnB,qBAAqB,CAAC,IAAI,CAAC;oBACzB,GAAG,EAAE,yBAAyB;oBAC9B,KAAK,EAAE,aAAa;oBACpB,KAAK,EAAE,cAAc;iBACtB,CAAC,CAAA;YACJ,CAAC;YACD,qBAAqB,CAAC,IAAI,CAAC;gBACzB,GAAG,EAAE,eAAe;gBACpB,KAAK,EAAE,QAAQ;gBACf,KAAK,EAAE,MAAM,CAAC,SAAS;aACxB,CAAC,CAAA;YACF,IAAI,eAAe,EAAE,CAAC;gBACpB,qBAAqB,CAAC,IAAI,CAAC;oBACzB,GAAG,EAAE,0BAA0B;oBAC/B,KAAK,EAAE,YAAY;oBACnB,KAAK,EAAE,cAAc,CAAC,eAAe,CAAC;iBACvC,CAAC,CAAA;YACJ,CAAC;YAED,OAAO;gBACL,MAAM;gBACN,qBAAqB;aACtB,CAAA;QACH,CAAC;QACD,KAAK,sBAAsB,CAAC,CAAC,CAAC;YAC5B,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAA;YACpD,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACxB,OAAM;YACR,CAAC;YAED,MAAM,MAAM,GAAG;gBACb,KAAK,EAAE,kBAAkB,CAAC,WAAW,CAAC,MAAM;gBAC5C,SAAS,EAAE,cAAc,CACvB,UAAU,CAAC,kBAAkB,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAC7D;aACF,CAAA;YAED,OAAO;gBACL,MAAM;gBACN,qBAAqB,EAAE;oBACrB;wBACE,GAAG,EAAE,qCAAqC;wBAC1C,KAAK,EAAE,gBAAgB;wBACvB,KAAK,EAAE,kBAAkB,CAAC,aAAa;qBACxC;oBACD;wBACE,GAAG,EAAE,+CAA+C;wBACpD,KAAK,EAAE,mBAAmB;wBAC1B,KAAK,EAAE,kBAAkB,CAAC,sBAAsB;qBACjD;oBACD;wBACE,GAAG,EAAE,gDAAgD;wBACrD,KAAK,EAAE,2BAA2B;wBAClC,KAAK,EAAE,kBAAkB,CAAC,uBAAuB;qBAClD;oBACD;wBACE,GAAG,EAAE,6BAA6B;wBAClC,KAAK,EAAE,QAAQ;wBACf,KAAK,EAAE,MAAM,CAAC,SAAS;qBACxB;oBACD,GAAG,CAAC,kBAAkB,CAAC,eAAe,CAAC,MAAM;wBAC3C,CAAC,CAAC;4BACE;gCACE,GAAG,EAAE,uCAAgD;gCACrD,KAAK,EAAE,kBAAkB;gCACzB,KAAK,EAAE,cAAc,CACnB,UAAU,CACR,kBAAkB,CAAC,eAAe,CAAC,MAAM,CAAC,QAAQ,EAAE,CACrD,CACF;6BACF;yBACF;wBACH,CAAC,CAAC,EAAE,CAAC;oBACP;wBACE,GAAG,EAAE,sCAAsC;wBAC3C,KAAK,EAAE,iBAAiB;wBACxB,KAAK,EAAE,UAAU,CAAC,kBAAkB,CAAC,cAAc,CAAC;qBACrD;iBACF;aACF,CAAA;QACH,CAAC;IACH,CAAC;AACH,CAAC,CAAA","sourcesContent":["import {\n  FormTypes,\n  SubmissionEventTypes,\n  SubmissionTypes,\n} from '@oneblink/types'\nimport { conditionalLogicService, formElementsService } from './index.js'\nimport {\n  getRootElementValueById,\n  ReplaceInjectablesFormatters,\n} from './submissionService.js'\nimport {\n  AddOffsetToDate,\n  EndOfDay,\n  ParseDayOnlyDate,\n  StartOfDay,\n} from './conditionalLogicService/types.js'\n\n/**\n * Examine a submission and its form definition to validate whether a payment\n * workflow event needs to run.\n *\n * #### Example\n *\n * ```js\n * const result = paymentService.checkForPaymentEvent({\n *   definition: form,\n *   submission,\n *   submissionTimestamp,\n *   parseDayOnlyDate: (value) => new Date(`${value}T00:00:00.000Z`),\n *   addDaysToDate: (date, days) => {\n *     date.setUTCDate(date.getUTCDate() + days)\n *     return date\n *   },\n *   startOfDay: (date) => {\n *     date.setUTCHours(0, 0, 0, 0)\n *     return date\n *   },\n *   endOfDay: (date) => {\n *     date.setUTCHours(23, 59, 59, 999)\n *     return date\n *   },\n * })\n * ```\n *\n * @param options\n * @returns\n */\nexport function checkForPaymentEvent({\n  definition,\n  submission,\n  submissionTimestamp,\n  parseDayOnlyDate,\n  addDaysToDate,\n  startOfDay,\n  endOfDay,\n}: {\n  definition: FormTypes.Form\n  submission: SubmissionTypes.S3SubmissionData['submission']\n  /** ISO timestamp the form was submitted. When evaluating during submission, pass `new Date().toISOString()`. */\n  submissionTimestamp: string\n  /** Parse `YYYY-MM-DD` strings when evaluating date based predicates */\n  parseDayOnlyDate: ParseDayOnlyDate\n  /** Add days to a date when evaluating date based predicates */\n  addDaysToDate: AddOffsetToDate\n  /** Start of calendar day when evaluating date (not datetime) based predicates */\n  startOfDay: StartOfDay\n  /** End of calendar day when evaluating date (not datetime) based predicates */\n  endOfDay: EndOfDay\n}):\n  | {\n      paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent\n      amount: number\n    }\n  | undefined {\n  const paymentSubmissionEvents = definition.paymentEvents || []\n  const paymentSubmissionEvent = paymentSubmissionEvents.find(\n    (paymentSubmissionEvent) => {\n      return (\n        paymentSubmissionEvent &&\n        conditionalLogicService.evaluateConditionalPredicates({\n          isConditional: !!paymentSubmissionEvent.conditionallyExecute,\n          requiresAllConditionalPredicates:\n            !!paymentSubmissionEvent.requiresAllConditionallyExecutePredicates,\n          conditionalPredicates:\n            paymentSubmissionEvent.conditionallyExecutePredicates || [],\n          submission: submission,\n          formElements: definition.elements,\n          submissionTimestamp,\n          parseDayOnlyDate,\n          addDaysToDate,\n          startOfDay,\n          endOfDay,\n        })\n      )\n    },\n  )\n\n  if (!paymentSubmissionEvent) {\n    return\n  }\n  console.log(\n    'Checking if submission with payment submission event needs processing',\n  )\n\n  const amountElement = formElementsService.findFormElement(\n    definition.elements,\n    (element) => element.id === paymentSubmissionEvent.configuration.elementId,\n  )\n  if (!amountElement || amountElement.type === 'page') {\n    console.log(\n      'Form has a payment submission event but the amount element does not exist, throwing error',\n    )\n    throw new Error(\n      'We could not find the configuration required to make a payment. Please contact your administrator to ensure your application configuration has been completed successfully.',\n    )\n  }\n\n  console.log('Found form element for payment submission event', amountElement)\n\n  const amount = getRootElementValueById(\n    amountElement.id,\n    definition.elements,\n    submission,\n  )\n\n  if (!amount) {\n    console.log(\n      'Form has a payment submission event but the amount has been entered as 0 or not at all, finishing as normal submission',\n    )\n    return\n  }\n\n  if (typeof amount !== 'number') {\n    console.log(\n      'Form has a payment submission event but the amount is not a number, throwing error',\n    )\n    throw new Error(\n      'The configuration required to make a payment is incorrect. Please contact your administrator to ensure your application configuration has been completed successfully.',\n    )\n  }\n\n  const result = {\n    paymentSubmissionEvent,\n    amount,\n  }\n\n  return result\n}\n\ntype PaymentDisplayDetail = {\n  label: string\n  value: string\n  /** A unique key across payment providers to identify the detail */\n  key: SubmissionEventTypes.PaymentDisplayDetailKey\n}\n\n/**\n * Retrieve an array of detail items from a form submission payment.\n *\n * #### Example\n *\n * ```js\n * const detailItems =\n *   paymentService.getDisplayDetailsFromFormSubmissionPayment(\n *     formSubmissionPayment,\n *     {\n *       formatCurrency,\n *       formatDateTime,\n *       formatDate,\n *     },\n *   )\n * ```\n *\n * @param formSubmissionPayment\n * @param options\n * @returns\n */\nexport const getDisplayDetailsFromFormSubmissionPayment = (\n  /** The form submission payment to get the details from */\n  formSubmissionPayment: SubmissionTypes.FormSubmissionPayment,\n  {\n    formatCurrency,\n    formatDateTime,\n    formatDate,\n  }: Pick<\n    ReplaceInjectablesFormatters,\n    'formatCurrency' | 'formatDate' | 'formatDateTime'\n  >,\n):\n  | {\n      amount: {\n        value: number\n        formatted: string\n      }\n      paymentDisplayDetails: PaymentDisplayDetail[]\n    }\n  | undefined => {\n  switch (formSubmissionPayment.type) {\n    case 'NSW_GOV_PAY': {\n      const { paymentTransaction } = formSubmissionPayment\n      if (!paymentTransaction || !paymentTransaction.agencyCompletionPayment) {\n        return\n      }\n\n      const amount = {\n        value: paymentTransaction.agencyCompletionPayment.amount,\n        formatted: formatCurrency(\n          paymentTransaction.agencyCompletionPayment.amount,\n        ),\n      }\n      return {\n        amount,\n        paymentDisplayDetails: [\n          {\n            key: 'NSW_GOV_PAY_COMPLETION_REFERENCE',\n            label: 'Completion Reference',\n            value:\n              paymentTransaction.agencyCompletionPayment\n                .paymentCompletionReference,\n          },\n          {\n            key: 'NSW_GOV_PAY_PAYMENT_REFERENCE',\n            label: 'Payment Reference',\n            value: paymentTransaction.agencyCompletionPayment.paymentReference,\n          },\n          {\n            key: 'NSW_GOV_PAY_BANK_REFERENCE',\n            label: 'Bank Reference',\n            value: paymentTransaction.agencyCompletionPayment.bankReference,\n          },\n          {\n            key: 'NSW_GOV_PAY_PAYMENT_METHOD',\n            label: 'Payment Method',\n            value: paymentTransaction.agencyCompletionPayment.paymentMethod,\n          },\n          ...(paymentTransaction.agencyCompletionPayment.paymentMethod ===\n            'BPAY' &&\n          paymentTransaction.agencyCompletionPayment.bPay?.billerCode\n            ? [\n                {\n                  key: 'NSW_GOV_PAY_BPAY_BILLER_CODE' as const,\n                  label: 'BPay Biller Code',\n                  value:\n                    paymentTransaction.agencyCompletionPayment.bPay.billerCode,\n                },\n              ]\n            : []),\n          ...(paymentTransaction.agencyCompletionPayment.paymentMethod ===\n          'CARD'\n            ? [\n                {\n                  key: 'NSW_GOV_PAY_CREDIT_CARD_NUMBER' as const,\n                  label: 'Card Number',\n                  value: `xxxx xxxx xxxx ${paymentTransaction.agencyCompletionPayment.card?.last4Digits}`,\n                },\n              ]\n            : []),\n          {\n            key: 'NSW_GOV_PAY_AMOUNT',\n            label: 'Amount',\n            value: amount.formatted,\n          },\n          {\n            key: 'NSW_GOV_PAY_SURCHARGE_AMOUNT',\n            label: 'Surcharge Amount',\n            value: formatCurrency(\n              paymentTransaction.agencyCompletionPayment.surcharge,\n            ),\n          },\n          {\n            key: 'NSW_GOV_PAY_SURCHARGE_GST',\n            label: 'Surcharge GST',\n            value: formatCurrency(\n              paymentTransaction.agencyCompletionPayment.surchargeGst,\n            ),\n          },\n          {\n            key: 'NSW_GOV_PAY_CREATED_DATE_TIME',\n            label: 'Created Date Time',\n            value: formatDateTime(formSubmissionPayment.createdAt),\n          },\n        ],\n      }\n    }\n    case 'BPOINT': {\n      const { paymentTransaction } = formSubmissionPayment\n      if (!paymentTransaction) {\n        return\n      }\n      const amountValue = paymentTransaction.Amount / 100\n      const amount = {\n        value: amountValue,\n        formatted: formatCurrency(amountValue),\n      }\n      return {\n        amount,\n        paymentDisplayDetails: [\n          {\n            key: 'BPOINT_RECEIPT_NUMBER',\n            label: 'Receipt Number',\n            value: paymentTransaction.ReceiptNumber,\n          },\n          {\n            key: 'BPOINT_CRN1',\n            label: 'CRN 1',\n            value: paymentTransaction.Crn1,\n          },\n          {\n            key: 'BPOINT_CRN2',\n            label: 'CRN 2',\n            value: paymentTransaction.Crn2,\n          },\n          {\n            key: 'BPOINT_CRN3',\n            label: 'CRN 3',\n            value: paymentTransaction.Crn3,\n          },\n          {\n            key: 'BPOINT_BILLER_CODE',\n            label: 'Biller Code',\n            value: paymentTransaction.BillerCode,\n          },\n          {\n            key: 'BPOINT_CREDIT_CARD_MASK',\n            label: 'Card Number',\n            value: paymentTransaction.CardDetails.MaskedCardNumber,\n          },\n          {\n            key: 'BPOINT_AMOUNT',\n            label: 'Amount',\n            value: amount.formatted,\n          },\n          {\n            key: 'BPOINT_SURCHARGE_AMOUNT',\n            label: 'Surcharge Amount',\n            value: formatCurrency(paymentTransaction.AmountSurcharge / 100),\n          },\n          {\n            key: 'BPOINT_PROCESSED_DATE_TIME',\n            label: 'Processed Date Time',\n            value: formatDateTime(paymentTransaction.ProcessedDateTime),\n          },\n        ],\n      }\n    }\n    case 'CP_PAY': {\n      const { paymentTransaction } = formSubmissionPayment\n      if (!paymentTransaction) {\n        return\n      }\n\n      const determineDetails = () => {\n        switch (paymentTransaction.cpPayVersion) {\n          case 'v2': {\n            return {\n              transactionId: paymentTransaction.result.id,\n              orderNumber:\n                paymentTransaction.result.externalReferenceId ?? undefined,\n              paymentType: paymentTransaction.result.paymentType,\n              creditCardMask: paymentTransaction.result.lastFour\n                ? `xxxx xxxx xxxx ${paymentTransaction.result.lastFour}`\n                : undefined,\n              amount:\n                paymentTransaction.result.amount !== undefined\n                  ? {\n                      value: paymentTransaction.result.amount,\n                      formatted: formatCurrency(\n                        paymentTransaction.result.amount,\n                      ),\n                    }\n                  : {\n                      value: NaN,\n                      formatted: 'Unknown',\n                    },\n              createdDateTime: paymentTransaction.result.createdOnUtc,\n            }\n          }\n          default: {\n            return {\n              transactionId: paymentTransaction.transactionId,\n              orderNumber: paymentTransaction.orderNumber ?? undefined,\n              paymentType:\n                paymentTransaction.paymentTypeId === 1\n                  ? 'Credit/Debit Card'\n                  : paymentTransaction.paymentTypeId === 2\n                    ? 'ACH'\n                    : undefined,\n              creditCardMask: paymentTransaction.lastFour\n                ? `xxxx xxxx xxxx ${paymentTransaction.lastFour}`\n                : undefined,\n              amount: {\n                value: paymentTransaction.amount,\n                formatted: formatCurrency(paymentTransaction.amount),\n              },\n              createdDateTime: paymentTransaction.createdAt,\n            }\n          }\n        }\n      }\n\n      const {\n        transactionId,\n        orderNumber,\n        paymentType,\n        creditCardMask,\n        amount,\n        createdDateTime,\n      } = determineDetails()\n      const paymentDisplayDetails: PaymentDisplayDetail[] = []\n      if (transactionId) {\n        paymentDisplayDetails.push({\n          key: 'CP_PAY_TRANSACTION_ID',\n          label: 'Transaction Id',\n          value: transactionId,\n        })\n      }\n      if (orderNumber) {\n        paymentDisplayDetails.push({\n          key: 'CP_PAY_ORDER_NUMBER',\n          label: 'Order Number',\n          value: orderNumber,\n        })\n      }\n      if (paymentType) {\n        paymentDisplayDetails.push({\n          key: 'CP_PAY_PAYMENT_TYPE',\n          label: 'Payment Type',\n          value: paymentType,\n        })\n      }\n      if (creditCardMask) {\n        paymentDisplayDetails.push({\n          key: 'CP_PAY_CREDIT_CARD_MASK',\n          label: 'Card Number',\n          value: creditCardMask,\n        })\n      }\n      paymentDisplayDetails.push({\n        key: 'CP_PAY_AMOUNT',\n        label: 'Amount',\n        value: amount.formatted,\n      })\n      if (createdDateTime) {\n        paymentDisplayDetails.push({\n          key: 'CP_PAY_CREATED_DATE_TIME',\n          label: 'Created At',\n          value: formatDateTime(createdDateTime),\n        })\n      }\n\n      return {\n        amount,\n        paymentDisplayDetails,\n      }\n    }\n    case 'WESTPAC_QUICK_STREAM': {\n      const { paymentTransaction } = formSubmissionPayment\n      if (!paymentTransaction) {\n        return\n      }\n\n      const amount = {\n        value: paymentTransaction.totalAmount.amount,\n        formatted: formatCurrency(\n          parseFloat(paymentTransaction.totalAmount.amount.toString()),\n        ),\n      }\n\n      return {\n        amount,\n        paymentDisplayDetails: [\n          {\n            key: 'WESTPAC_QUICK_STREAM_RECEIPT_NUMBER',\n            label: 'Receipt Number',\n            value: paymentTransaction.receiptNumber,\n          },\n          {\n            key: 'WESTPAC_QUICK_STREAM_PAYMENT_REFERENCE_NUMBER',\n            label: 'Payment Reference',\n            value: paymentTransaction.paymentReferenceNumber,\n          },\n          {\n            key: 'WESTPAC_QUICK_STREAM_CUSTOMER_REFERENCE_NUMBER',\n            label: 'Customer Reference Number',\n            value: paymentTransaction.customerReferenceNumber,\n          },\n          {\n            key: 'WESTPAC_QUICK_STREAM_AMOUNT',\n            label: 'Amount',\n            value: amount.formatted,\n          },\n          ...(paymentTransaction.surchargeAmount.amount\n            ? [\n                {\n                  key: 'WESTPAC_QUICK_STREAM_SURCHARGE_AMOUNT' as const,\n                  label: 'Surcharge Amount',\n                  value: formatCurrency(\n                    parseFloat(\n                      paymentTransaction.surchargeAmount.amount.toString(),\n                    ),\n                  ),\n                },\n              ]\n            : []),\n          {\n            key: 'WESTPAC_QUICK_STREAM_SETTLEMENT_DATE',\n            label: 'Settlement Date',\n            value: formatDate(paymentTransaction.settlementDate),\n          },\n        ],\n      }\n    }\n  }\n}\n"]}
+{"version":3,"file":"paymentService.js","sourceRoot":"","sources":["../src/paymentService.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AACzE,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAA;AAOhE,OAAO,kBAAkB,MAAM,wCAAwC,CAAA;AAevE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,oBAAoB,CAAC,EACnC,UAAU,EACV,UAAU,EACV,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,EACb,UAAU,EACV,QAAQ,GAcT;IAMC,MAAM,uBAAuB,GAAG,UAAU,CAAC,aAAa,IAAI,EAAE,CAAA;IAC9D,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,IAAI,CACzD,CAAC,sBAAsB,EAAE,EAAE;QACzB,OAAO,CACL,sBAAsB;YACtB,uBAAuB,CAAC,6BAA6B,CAAC;gBACpD,aAAa,EAAE,CAAC,CAAC,sBAAsB,CAAC,oBAAoB;gBAC5D,gCAAgC,EAC9B,CAAC,CAAC,sBAAsB,CAAC,yCAAyC;gBACpE,qBAAqB,EACnB,sBAAsB,CAAC,8BAA8B,IAAI,EAAE;gBAC7D,UAAU,EAAE,UAAU;gBACtB,YAAY,EAAE,UAAU,CAAC,QAAQ;gBACjC,mBAAmB;gBACnB,gBAAgB;gBAChB,aAAa;gBACb,UAAU;gBACV,QAAQ;aACT,CAAC,CACH,CAAA;IACH,CAAC,CACF,CAAA;IAED,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC5B,OAAM;IACR,CAAC;IACD,OAAO,CAAC,GAAG,CACT,uEAAuE,CACxE,CAAA;IAED,MAAM,aAAa,GAAG,mBAAmB,CAAC,eAAe,CACvD,UAAU,CAAC,QAAQ,EACnB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,sBAAsB,CAAC,aAAa,CAAC,SAAS,CAC3E,CAAA;IACD,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACpD,OAAO,CAAC,GAAG,CACT,2FAA2F,CAC5F,CAAA;QACD,MAAM,IAAI,KAAK,CACb,6KAA6K,CAC9K,CAAA;IACH,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,iDAAiD,EAAE,aAAa,CAAC,CAAA;IAE7E,MAAM,MAAM,GAAG,uBAAuB,CACpC,aAAa,CAAC,EAAE,EAChB,UAAU,CAAC,QAAQ,EACnB,UAAU,CACX,CAAA;IAED,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,GAAG,CACT,wHAAwH,CACzH,CAAA;QACD,OAAM;IACR,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,CAAC,GAAG,CACT,oFAAoF,CACrF,CAAA;QACD,MAAM,IAAI,KAAK,CACb,wKAAwK,CACzK,CAAA;IACH,CAAC;IAED,MAAM,MAAM,GAAG;QACb,sBAAsB;QACtB,MAAM;KACP,CAAA;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,0CAA0C,GAAG;AACxD,0DAA0D;AAC1D,qBAA4D,EAC5D,UAAoC,EACK,EAAE;IAC3C,OAAO,kBAAkB,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,iBAAiB,CACrE,qBAAqB,EACrB,UAAU,CACX,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,4CAA4C,CAC1D,qBAA4D;IAE5D,OAAO,kBAAkB,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,mBAAmB,CACvE,qBAAqB,CACtB,CAAA;AACH,CAAC","sourcesContent":["import {\n  FormTypes,\n  SubmissionEventTypes,\n  SubmissionTypes,\n} from '@oneblink/types'\nimport { conditionalLogicService, formElementsService } from './index.js'\nimport { getRootElementValueById } from './submissionService.js'\nimport {\n  AddOffsetToDate,\n  EndOfDay,\n  ParseDayOnlyDate,\n  StartOfDay,\n} from './conditionalLogicService/types.js'\nimport getPaymentProvider from './paymentService/getPaymentProvider.js'\nimport type {\n  FormStorePayment,\n  PaymentDisplayDetail,\n  PaymentDisplayFormatters,\n  PaymentDisplayDetailsResult,\n} from './paymentService/types.js'\n\nexport {\n  FormStorePayment,\n  PaymentDisplayDetail,\n  PaymentDisplayDetailsResult,\n  PaymentDisplayFormatters,\n}\n\n/**\n * Examine a submission and its form definition to validate whether a payment\n * workflow event needs to run.\n *\n * #### Example\n *\n * ```js\n * const result = paymentService.checkForPaymentEvent({\n *   definition: form,\n *   submission,\n *   submissionTimestamp,\n *   parseDayOnlyDate: (value) => new Date(`${value}T00:00:00.000Z`),\n *   addDaysToDate: (date, days) => {\n *     date.setUTCDate(date.getUTCDate() + days)\n *     return date\n *   },\n *   startOfDay: (date) => {\n *     date.setUTCHours(0, 0, 0, 0)\n *     return date\n *   },\n *   endOfDay: (date) => {\n *     date.setUTCHours(23, 59, 59, 999)\n *     return date\n *   },\n * })\n * ```\n *\n * @param options\n * @returns\n */\nexport function checkForPaymentEvent({\n  definition,\n  submission,\n  submissionTimestamp,\n  parseDayOnlyDate,\n  addDaysToDate,\n  startOfDay,\n  endOfDay,\n}: {\n  definition: FormTypes.Form\n  submission: SubmissionTypes.S3SubmissionData['submission']\n  /** ISO timestamp the form was submitted. When evaluating during submission, pass `new Date().toISOString()`. */\n  submissionTimestamp: string\n  /** Parse `YYYY-MM-DD` strings when evaluating date based predicates */\n  parseDayOnlyDate: ParseDayOnlyDate\n  /** Add days to a date when evaluating date based predicates */\n  addDaysToDate: AddOffsetToDate\n  /** Start of calendar day when evaluating date (not datetime) based predicates */\n  startOfDay: StartOfDay\n  /** End of calendar day when evaluating date (not datetime) based predicates */\n  endOfDay: EndOfDay\n}):\n  | {\n      paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent\n      amount: number\n    }\n  | undefined {\n  const paymentSubmissionEvents = definition.paymentEvents || []\n  const paymentSubmissionEvent = paymentSubmissionEvents.find(\n    (paymentSubmissionEvent) => {\n      return (\n        paymentSubmissionEvent &&\n        conditionalLogicService.evaluateConditionalPredicates({\n          isConditional: !!paymentSubmissionEvent.conditionallyExecute,\n          requiresAllConditionalPredicates:\n            !!paymentSubmissionEvent.requiresAllConditionallyExecutePredicates,\n          conditionalPredicates:\n            paymentSubmissionEvent.conditionallyExecutePredicates || [],\n          submission: submission,\n          formElements: definition.elements,\n          submissionTimestamp,\n          parseDayOnlyDate,\n          addDaysToDate,\n          startOfDay,\n          endOfDay,\n        })\n      )\n    },\n  )\n\n  if (!paymentSubmissionEvent) {\n    return\n  }\n  console.log(\n    'Checking if submission with payment submission event needs processing',\n  )\n\n  const amountElement = formElementsService.findFormElement(\n    definition.elements,\n    (element) => element.id === paymentSubmissionEvent.configuration.elementId,\n  )\n  if (!amountElement || amountElement.type === 'page') {\n    console.log(\n      'Form has a payment submission event but the amount element does not exist, throwing error',\n    )\n    throw new Error(\n      'We could not find the configuration required to make a payment. Please contact your administrator to ensure your application configuration has been completed successfully.',\n    )\n  }\n\n  console.log('Found form element for payment submission event', amountElement)\n\n  const amount = getRootElementValueById(\n    amountElement.id,\n    definition.elements,\n    submission,\n  )\n\n  if (!amount) {\n    console.log(\n      'Form has a payment submission event but the amount has been entered as 0 or not at all, finishing as normal submission',\n    )\n    return\n  }\n\n  if (typeof amount !== 'number') {\n    console.log(\n      'Form has a payment submission event but the amount is not a number, throwing error',\n    )\n    throw new Error(\n      'The configuration required to make a payment is incorrect. Please contact your administrator to ensure your application configuration has been completed successfully.',\n    )\n  }\n\n  const result = {\n    paymentSubmissionEvent,\n    amount,\n  }\n\n  return result\n}\n\n/**\n * Retrieve an array of detail items from a form submission payment.\n *\n * #### Example\n *\n * ```js\n * const detailItems =\n *   paymentService.getDisplayDetailsFromFormSubmissionPayment(\n *     formSubmissionPayment,\n *     {\n *       formatCurrency,\n *       formatDateTime,\n *       formatDate,\n *     },\n *   )\n * ```\n *\n * @param formSubmissionPayment\n * @param options\n * @returns\n */\nexport const getDisplayDetailsFromFormSubmissionPayment = (\n  /** The form submission payment to get the details from */\n  formSubmissionPayment: SubmissionTypes.FormSubmissionPayment,\n  formatters: PaymentDisplayFormatters,\n): PaymentDisplayDetailsResult | undefined => {\n  return getPaymentProvider(formSubmissionPayment.type).getDisplayDetails(\n    formSubmissionPayment,\n    formatters,\n  )\n}\n\n/**\n * Map a form submission payment to the Form Store payment property.\n *\n * #### Example\n *\n * ```js\n * const formStorePayment =\n *   paymentService.getFormStorePaymentFromFormSubmissionPayment(\n *     formSubmissionPayment,\n *   )\n * ```\n *\n * @param formSubmissionPayment\n * @returns\n */\nexport function getFormStorePaymentFromFormSubmissionPayment(\n  formSubmissionPayment: SubmissionTypes.FormSubmissionPayment,\n): FormStorePayment {\n  return getPaymentProvider(formSubmissionPayment.type).getFormStorePayment(\n    formSubmissionPayment,\n  )\n}\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oneblink/sdk-core",
   "description": "OneBlink SDK for JavaScript (works in Browsers and NodeJS)",
-  "version": "10.0.0-beta.3",
+  "version": "10.1.0-beta.1",
   "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
   "bugs": {
     "url": "https://github.com/oneblink/sdk-core-js/issues"