@oneblink/sdk-core 10.0.0 → 10.1.0-beta.2

package/dist/paymentService.js

@@ -1,5 +1,6 @@
-import { conditionalLogicService, formElementsService } from './index.js';
-import { getRootElementValueById, } from './submissionService.js';
+import { calculationService, conditionalLogicService, formElementsService, } from './index.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.
@@ -51,13 +52,12 @@ export function checkForPaymentEvent({ definition, submission, submissionTimesta
         return;
     }
     console.log('Checking if submission with payment submission event needs processing');
-    const amountElement = formElementsService.findFormElement(definition.elements, (element) => element.id === paymentSubmissionEvent.configuration.elementId);
-    if (!amountElement || amountElement.type === 'page') {
-        console.log('Form has a payment submission event but the amount element does not exist, throwing error');
-        throw new Error('We could not find the configuration required to make a payment. Please contact your administrator to ensure your application configuration has been completed successfully.');
-    }
-    console.log('Found form element for payment submission event', amountElement);
-    const amount = getRootElementValueById(amountElement.id, definition.elements, submission);
+    const amount = resolvePaymentEventAmount({
+        configuration: paymentSubmissionEvent.configuration,
+        definition,
+        submission,
+        parseDayOnlyDate,
+    });
     if (!amount) {
         console.log('Form has a payment submission event but the amount has been entered as 0 or not at all, finishing as normal submission');
         return;
@@ -66,11 +66,41 @@ export function checkForPaymentEvent({ definition, submission, submissionTimesta
         console.log('Form has a payment submission event but the amount is not a number, throwing error');
         throw new Error('The configuration required to make a payment is incorrect. Please contact your administrator to ensure your application configuration has been completed successfully.');
     }
-    const result = {
+    return {
         paymentSubmissionEvent,
         amount,
     };
-    return result;
+}
+function resolvePaymentEventAmount({ configuration, definition, submission, parseDayOnlyDate, }) {
+    switch (configuration.amountType) {
+        case 'NUMBER': {
+            console.log('Using fixed payment amount from payment submission event configuration', configuration.paymentAmount);
+            return configuration.paymentAmount;
+        }
+        case 'EXPRESSION': {
+            console.log('Evaluating payment calculation from payment submission event configuration', configuration.paymentCalculation);
+            return calculationService.evaluateExpression({
+                expression: configuration.paymentCalculation,
+                submission,
+                formElements: definition.elements,
+                parseDayOnlyDate,
+            });
+        }
+        case 'FORM_ELEMENT':
+        default: {
+            if (!configuration.elementId) {
+                console.log('Form has a payment submission event but the amount configuration is missing, throwing error');
+                throw new Error('We could not find the configuration required to make a payment. Please contact your administrator to ensure your application configuration has been completed successfully.');
+            }
+            const amountElement = formElementsService.findFormElement(definition.elements, (element) => element.id === configuration.elementId);
+            if (!amountElement) {
+                console.log('Form has a payment submission event but the amount element does not exist, throwing error');
+                throw new Error('We could not find the configuration required to make a payment. Please contact your administrator to ensure your application configuration has been completed successfully.');
+            }
+            console.log('Found form element for payment submission event', amountElement);
+            return getRootElementValueById(amountElement.id, definition.elements, submission);
+        }
+    }
 }
 /**
  * Retrieve an array of detail items from a form submission payment.
@@ -95,290 +125,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,EACL,kBAAkB,EAClB,uBAAuB,EACvB,mBAAmB,GACpB,MAAM,YAAY,CAAA;AACnB,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,MAAM,GAAG,yBAAyB,CAAC;QACvC,aAAa,EAAE,sBAAsB,CAAC,aAAa;QACnD,UAAU;QACV,UAAU;QACV,gBAAgB;KACjB,CAAC,CAAA;IAEF,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,OAAO;QACL,sBAAsB;QACtB,MAAM;KACP,CAAA;AACH,CAAC;AAED,SAAS,yBAAyB,CAAC,EACjC,aAAa,EACb,UAAU,EACV,UAAU,EACV,gBAAgB,GAMjB;IACC,QAAQ,aAAa,CAAC,UAAU,EAAE,CAAC;QACjC,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,CAAC,GAAG,CACT,wEAAwE,EACxE,aAAa,CAAC,aAAa,CAC5B,CAAA;YACD,OAAO,aAAa,CAAC,aAAa,CAAA;QACpC,CAAC;QACD,KAAK,YAAY,CAAC,CAAC,CAAC;YAClB,OAAO,CAAC,GAAG,CACT,4EAA4E,EAC5E,aAAa,CAAC,kBAAkB,CACjC,CAAA;YACD,OAAO,kBAAkB,CAAC,kBAAkB,CAAC;gBAC3C,UAAU,EAAE,aAAa,CAAC,kBAAkB;gBAC5C,UAAU;gBACV,YAAY,EAAE,UAAU,CAAC,QAAQ;gBACjC,gBAAgB;aACjB,CAAC,CAAA;QACJ,CAAC;QACD,KAAK,cAAc,CAAC;QACpB,OAAO,CAAC,CAAC,CAAC;YACR,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC;gBAC7B,OAAO,CAAC,GAAG,CACT,6FAA6F,CAC9F,CAAA;gBACD,MAAM,IAAI,KAAK,CACb,6KAA6K,CAC9K,CAAA;YACH,CAAC;YAED,MAAM,aAAa,GAAG,mBAAmB,CAAC,eAAe,CACvD,UAAU,CAAC,QAAQ,EACnB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,aAAa,CAAC,SAAS,CACpD,CAAA;YACD,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO,CAAC,GAAG,CACT,2FAA2F,CAC5F,CAAA;gBACD,MAAM,IAAI,KAAK,CACb,6KAA6K,CAC9K,CAAA;YACH,CAAC;YAED,OAAO,CAAC,GAAG,CACT,iDAAiD,EACjD,aAAa,CACd,CAAA;YAED,OAAO,uBAAuB,CAC5B,aAAa,CAAC,EAAE,EAChB,UAAU,CAAC,QAAQ,EACnB,UAAU,CACX,CAAA;QACH,CAAC;IACH,CAAC;AACH,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 {\n  calculationService,\n  conditionalLogicService,\n  formElementsService,\n} 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 amount = resolvePaymentEventAmount({\n    configuration: paymentSubmissionEvent.configuration,\n    definition,\n    submission,\n    parseDayOnlyDate,\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  return {\n    paymentSubmissionEvent,\n    amount,\n  }\n}\n\nfunction resolvePaymentEventAmount({\n  configuration,\n  definition,\n  submission,\n  parseDayOnlyDate,\n}: {\n  configuration: SubmissionEventTypes.FormPaymentEvent['configuration']\n  definition: FormTypes.Form\n  submission: SubmissionTypes.S3SubmissionData['submission']\n  parseDayOnlyDate: ParseDayOnlyDate\n}): unknown {\n  switch (configuration.amountType) {\n    case 'NUMBER': {\n      console.log(\n        'Using fixed payment amount from payment submission event configuration',\n        configuration.paymentAmount,\n      )\n      return configuration.paymentAmount\n    }\n    case 'EXPRESSION': {\n      console.log(\n        'Evaluating payment calculation from payment submission event configuration',\n        configuration.paymentCalculation,\n      )\n      return calculationService.evaluateExpression({\n        expression: configuration.paymentCalculation,\n        submission,\n        formElements: definition.elements,\n        parseDayOnlyDate,\n      })\n    }\n    case 'FORM_ELEMENT':\n    default: {\n      if (!configuration.elementId) {\n        console.log(\n          'Form has a payment submission event but the amount configuration is missing, 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      const amountElement = formElementsService.findFormElement(\n        definition.elements,\n        (element) => element.id === configuration.elementId,\n      )\n      if (!amountElement) {\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(\n        'Found form element for payment submission event',\n        amountElement,\n      )\n\n      return getRootElementValueById(\n        amountElement.id,\n        definition.elements,\n        submission,\n      )\n    }\n  }\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,11 +1,14 @@
 {
   "name": "@oneblink/sdk-core",
   "description": "OneBlink SDK for JavaScript (works in Browsers and NodeJS)",
-  "version": "10.0.0",
+  "version": "10.1.0-beta.2",
   "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
   "bugs": {
     "url": "https://github.com/oneblink/sdk-core-js/issues"
   },
+  "dependencies": {
+    "morph-expressions": "^1.1.1"
+  },
   "devDependencies": {
     "@eslint/eslintrc": "^3.3.3",
     "@eslint/js": "^9.39.2",