@oneblink/sdk-core 7.2.0-beta.1 → 7.3.0-beta.1

package/dist/paymentService.d.ts

@@ -1,4 +1,5 @@
 import { FormTypes, SubmissionEventTypes, SubmissionTypes } from '@oneblink/types';
+import { ReplaceInjectablesFormatters } from './submissionService';
 /**
  * Examine a submission and its form definition to validate whether a payment
  * workflow event needs to run.
@@ -17,3 +18,37 @@ export declare function checkForPaymentEvent(definition: FormTypes.Form, submiss
     paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent;
     amount: number;
 } | undefined;
+type PaymentDisplayDetail = {
+    label: string;
+    value: string;
+    /** A key to identify the detail */
+    key: string;
+};
+/**
+ * Retrieve an array of detail items from a form submission payment.
+ *
+ * #### Example
+ *
+ * ```js
+ * const detailItems =
+ *   paymentService.getDisplayDetailsFromFormSubmissionPayment({
+ *     formSubmissionPayment,
+ *     formatCurrency,
+ *   })
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+export declare const getDisplayDetailsFromFormSubmissionPayment: ({ formSubmissionPayment, formatCurrency, formatDateTime, }: {
+    /** The form submission payment to get the details from */
+    formSubmissionPayment: SubmissionTypes.FormSubmissionPayment;
+    /** A function to format any curreny values */
+    formatCurrency: ReplaceInjectablesFormatters['formatCurrency'];
+    /**
+     * A function to format any dates. If this is not passed, datetimes will be
+     * returned as iso strings.
+     */
+    formatDateTime: ReplaceInjectablesFormatters['formatDateTime'];
+}) => PaymentDisplayDetail[];
+export {};

package/dist/paymentService.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkForPaymentEvent = void 0;
+exports.getDisplayDetailsFromFormSubmissionPayment = exports.checkForPaymentEvent = void 0;
 const _1 = require(".");
 const submissionService_1 = require("./submissionService");
 /**
@@ -55,4 +55,279 @@ function checkForPaymentEvent(definition, submission) {
     return result;
 }
 exports.checkForPaymentEvent = checkForPaymentEvent;
+/**
+ * Retrieve an array of detail items from a form submission payment.
+ *
+ * #### Example
+ *
+ * ```js
+ * const detailItems =
+ *   paymentService.getDisplayDetailsFromFormSubmissionPayment({
+ *     formSubmissionPayment,
+ *     formatCurrency,
+ *   })
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+const getDisplayDetailsFromFormSubmissionPayment = ({ formSubmissionPayment, formatCurrency, formatDateTime, }) => {
+    var _a, _b;
+    switch (formSubmissionPayment.type) {
+        case 'NSW_GOV_PAY': {
+            const { paymentTransaction } = formSubmissionPayment;
+            if (!paymentTransaction || !paymentTransaction.agencyCompletionPayment) {
+                return [];
+            }
+            return [
+                {
+                    key: 'completionReference',
+                    label: 'Completion Reference',
+                    value: paymentTransaction.agencyCompletionPayment
+                        .paymentCompletionReference,
+                },
+                {
+                    key: 'paymentReference',
+                    label: 'Payment Reference',
+                    value: paymentTransaction.agencyCompletionPayment.paymentReference,
+                },
+                {
+                    key: 'bankReference',
+                    label: 'Bank Reference',
+                    value: paymentTransaction.agencyCompletionPayment.bankReference,
+                },
+                {
+                    key: 'paymentMethod',
+                    label: 'Payment Method',
+                    value: paymentTransaction.agencyCompletionPayment.paymentMethod,
+                },
+                ...(paymentTransaction.agencyCompletionPayment.paymentMethod ===
+                    'BPAY' && ((_a = paymentTransaction.agencyCompletionPayment.bPay) === null || _a === void 0 ? void 0 : _a.billerCode)
+                    ? [
+                        {
+                            key: 'billerCode',
+                            label: 'BPay Biller Code',
+                            value: paymentTransaction.agencyCompletionPayment.bPay.billerCode,
+                        },
+                    ]
+                    : []),
+                ...(paymentTransaction.agencyCompletionPayment.paymentMethod === 'CARD'
+                    ? [
+                        {
+                            key: 'creditCardMask',
+                            label: 'Card Number',
+                            value: `xxxx xxxx xxxx ${(_b = paymentTransaction.agencyCompletionPayment.card) === null || _b === void 0 ? void 0 : _b.last4Digits}`,
+                        },
+                    ]
+                    : []),
+                {
+                    key: 'amount',
+                    label: 'Amount',
+                    value: formatCurrency(paymentTransaction.agencyCompletionPayment.amount),
+                },
+                {
+                    key: 'surchargeAmount',
+                    label: 'Surcharge Amount',
+                    value: formatCurrency(paymentTransaction.agencyCompletionPayment.surcharge),
+                },
+                {
+                    key: 'surchargeGST',
+                    label: 'Surcharge GST',
+                    value: formatCurrency(paymentTransaction.agencyCompletionPayment.surchargeGst),
+                },
+                {
+                    key: 'createdDateTime',
+                    label: 'Created Date Time',
+                    value: formatDateTime(formSubmissionPayment.createdAt),
+                },
+            ];
+        }
+        case 'BPOINT': {
+            const { paymentTransaction } = formSubmissionPayment;
+            if (!paymentTransaction) {
+                return [];
+            }
+            return [
+                {
+                    key: 'receiptNumber',
+                    label: 'Receipt Number',
+                    value: paymentTransaction.ReceiptNumber,
+                },
+                {
+                    key: 'crn1',
+                    label: 'CRN 1',
+                    value: paymentTransaction.Crn1,
+                },
+                {
+                    key: 'crn2',
+                    label: 'CRN 2',
+                    value: paymentTransaction.Crn2,
+                },
+                {
+                    key: 'crn3',
+                    label: 'CRN 3',
+                    value: paymentTransaction.Crn3,
+                },
+                {
+                    key: 'billerCode',
+                    label: 'Biller Code',
+                    value: paymentTransaction.BillerCode,
+                },
+                {
+                    key: 'creditCardMask',
+                    label: 'Card Number',
+                    value: paymentTransaction.CardDetails.MaskedCardNumber,
+                },
+                {
+                    key: 'amount',
+                    label: 'Amount',
+                    value: formatCurrency(paymentTransaction.Amount / 100),
+                },
+                {
+                    key: 'surchargeAmount',
+                    label: 'Surcharge Amount',
+                    value: formatCurrency(paymentTransaction.AmountSurcharge / 100),
+                },
+                {
+                    key: 'processedDateTime',
+                    label: 'Processed Date Time',
+                    value: formatDateTime(paymentTransaction.ProcessedDateTime),
+                },
+            ];
+        }
+        case 'CP_PAY': {
+            const { paymentTransaction } = formSubmissionPayment;
+            if (!paymentTransaction) {
+                return [];
+            }
+            const determineDetails = () => {
+                var _a, _b;
+                switch (paymentTransaction.cpPayVersion) {
+                    case 'v2': {
+                        return {
+                            transactionId: paymentTransaction.result.id,
+                            orderNumber: (_a = paymentTransaction.result.externalReferenceId) !== null && _a !== void 0 ? _a : undefined,
+                            paymentType: paymentTransaction.result.paymentType,
+                            creditCardMask: paymentTransaction.result.lastFour
+                                ? `xxxx xxxx xxxx ${paymentTransaction.result.lastFour}`
+                                : undefined,
+                            amount: paymentTransaction.result.amount !== undefined
+                                ? formatCurrency(paymentTransaction.result.amount)
+                                : 'Unknown',
+                            createdDateTime: paymentTransaction.result.createdOnUtc,
+                        };
+                    }
+                    default: {
+                        return {
+                            transactionId: paymentTransaction.transactionId,
+                            orderNumber: (_b = paymentTransaction.orderNumber) !== null && _b !== void 0 ? _b : undefined,
+                            paymentType: paymentTransaction.paymentTypeId === 1
+                                ? 'Credit/Debit Card'
+                                : paymentTransaction.paymentTypeId === 2
+                                    ? 'ACH'
+                                    : undefined,
+                            creditCardMask: paymentTransaction.lastFour
+                                ? `xxxx xxxx xxxx ${paymentTransaction.lastFour}`
+                                : undefined,
+                            amount: formatCurrency(paymentTransaction.amount),
+                            createdDateTime: paymentTransaction.createdAt,
+                        };
+                    }
+                }
+            };
+            const { transactionId, orderNumber, paymentType, creditCardMask, amount, createdDateTime, } = determineDetails();
+            const result = [];
+            if (transactionId) {
+                result.push({
+                    key: 'transactionId',
+                    label: 'Transaction Id',
+                    value: transactionId,
+                });
+            }
+            if (orderNumber) {
+                result.push({
+                    key: 'orderNumber',
+                    label: 'Order Number',
+                    value: orderNumber,
+                });
+            }
+            if (paymentType) {
+                result.push({
+                    key: 'paymentType',
+                    label: 'Payment Type',
+                    value: paymentType,
+                });
+            }
+            if (creditCardMask) {
+                result.push({
+                    key: 'creditCardMask',
+                    label: 'Card Number',
+                    value: creditCardMask,
+                });
+            }
+            if (amount) {
+                result.push({
+                    key: 'amount',
+                    label: 'Amount',
+                    value: amount,
+                });
+            }
+            if (createdDateTime) {
+                result.push({
+                    key: 'createdDateTime',
+                    label: 'Created At',
+                    value: formatDateTime(createdDateTime),
+                });
+            }
+            return result;
+        }
+        case 'WESTPAC_QUICK_STREAM': {
+            const { paymentTransaction } = formSubmissionPayment;
+            if (!paymentTransaction) {
+                return [];
+            }
+            return [
+                {
+                    key: 'receiptNumber',
+                    label: 'Receipt Number',
+                    value: paymentTransaction.receiptNumber,
+                },
+                {
+                    key: 'paymentReferenceNumber',
+                    label: 'Payment Reference',
+                    value: paymentTransaction.paymentReferenceNumber,
+                },
+                {
+                    key: 'customerReferenceNumber',
+                    label: 'Customer Reference Number',
+                    value: paymentTransaction.customerReferenceNumber,
+                },
+                ...(paymentTransaction.totalAmount
+                    ? [
+                        {
+                            key: 'amount',
+                            label: 'Amount',
+                            value: formatCurrency(parseFloat(paymentTransaction.totalAmount.amount.toString())),
+                        },
+                    ]
+                    : []),
+                ...(paymentTransaction.surchargeAmount.amount
+                    ? [
+                        {
+                            key: 'surchargeAmount',
+                            label: 'Surcharge Amount',
+                            value: formatCurrency(parseFloat(paymentTransaction.surchargeAmount.amount.toString())),
+                        },
+                    ]
+                    : []),
+                {
+                    key: 'settlementDate',
+                    label: 'Settlement Date',
+                    value: formatDateTime(paymentTransaction.settlementDate),
+                },
+            ];
+        }
+    }
+};
+exports.getDisplayDetailsFromFormSubmissionPayment = getDisplayDetailsFromFormSubmissionPayment;
 //# sourceMappingURL=paymentService.js.map

package/dist/paymentService.js.map

@@ -1 +1 @@
-{"version":3,"file":"paymentService.js","sourceRoot":"","sources":["../src/paymentService.ts"],"names":[],"mappings":";;;AAKA,wBAAgE;AAChE,2DAA6D;AAE7D;;;;;;;;;;;;;GAaG;AACH,SAAgB,oBAAoB,CAClC,UAA0B,EAC1B,UAA0D;IAO1D,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,0BAAuB,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;aAClC,CAAC,CACH,CAAA;IACH,CAAC,CACF,CAAA;IAED,IAAI,CAAC,sBAAsB,EAAE;QAC3B,OAAM;KACP;IACD,OAAO,CAAC,GAAG,CACT,uEAAuE,CACxE,CAAA;IAED,MAAM,aAAa,GAAG,sBAAmB,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;QACnD,OAAO,CAAC,GAAG,CACT,2FAA2F,CAC5F,CAAA;QACD,MAAM,IAAI,KAAK,CACb,6KAA6K,CAC9K,CAAA;KACF;IAED,OAAO,CAAC,GAAG,CAAC,iDAAiD,EAAE,aAAa,CAAC,CAAA;IAE7E,MAAM,MAAM,GAAG,IAAA,2CAAuB,EACpC,aAAa,CAAC,EAAE,EAChB,UAAU,CAAC,QAAQ,EACnB,UAAU,CACX,CAAA;IAED,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,CAAC,GAAG,CACT,wHAAwH,CACzH,CAAA;QACD,OAAM;KACP;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,OAAO,CAAC,GAAG,CACT,oFAAoF,CACrF,CAAA;QACD,MAAM,IAAI,KAAK,CACb,wKAAwK,CACzK,CAAA;KACF;IAED,MAAM,MAAM,GAAG;QACb,sBAAsB;QACtB,MAAM;KACP,CAAA;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AA7ED,oDA6EC","sourcesContent":["import {\n  FormTypes,\n  SubmissionEventTypes,\n  SubmissionTypes,\n} from '@oneblink/types'\nimport { conditionalLogicService, formElementsService } from '.'\nimport { getRootElementValueById } from './submissionService'\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(form, submission)\n * ```\n *\n * @param definition\n * @param submission\n * @returns\n */\nexport function checkForPaymentEvent(\n  definition: FormTypes.Form,\n  submission: SubmissionTypes.S3SubmissionData['submission'],\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        })\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"]}
+{"version":3,"file":"paymentService.js","sourceRoot":"","sources":["../src/paymentService.ts"],"names":[],"mappings":";;;AAKA,wBAAgE;AAChE,2DAG4B;AAE5B;;;;;;;;;;;;;GAaG;AACH,SAAgB,oBAAoB,CAClC,UAA0B,EAC1B,UAA0D;IAO1D,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,0BAAuB,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;aAClC,CAAC,CACH,CAAA;IACH,CAAC,CACF,CAAA;IAED,IAAI,CAAC,sBAAsB,EAAE;QAC3B,OAAM;KACP;IACD,OAAO,CAAC,GAAG,CACT,uEAAuE,CACxE,CAAA;IAED,MAAM,aAAa,GAAG,sBAAmB,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;QACnD,OAAO,CAAC,GAAG,CACT,2FAA2F,CAC5F,CAAA;QACD,MAAM,IAAI,KAAK,CACb,6KAA6K,CAC9K,CAAA;KACF;IAED,OAAO,CAAC,GAAG,CAAC,iDAAiD,EAAE,aAAa,CAAC,CAAA;IAE7E,MAAM,MAAM,GAAG,IAAA,2CAAuB,EACpC,aAAa,CAAC,EAAE,EAChB,UAAU,CAAC,QAAQ,EACnB,UAAU,CACX,CAAA;IAED,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,CAAC,GAAG,CACT,wHAAwH,CACzH,CAAA;QACD,OAAM;KACP;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,OAAO,CAAC,GAAG,CACT,oFAAoF,CACrF,CAAA;QACD,MAAM,IAAI,KAAK,CACb,wKAAwK,CACzK,CAAA;KACF;IAED,MAAM,MAAM,GAAG;QACb,sBAAsB;QACtB,MAAM;KACP,CAAA;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AA7ED,oDA6EC;AASD;;;;;;;;;;;;;;;GAeG;AACI,MAAM,0CAA0C,GAAG,CAAC,EACzD,qBAAqB,EACrB,cAAc,EACd,cAAc,GAWf,EAA0B,EAAE;;IAC3B,QAAQ,qBAAqB,CAAC,IAAI,EAAE;QAClC,KAAK,aAAa,CAAC,CAAC;YAClB,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAA;YACpD,IAAI,CAAC,kBAAkB,IAAI,CAAC,kBAAkB,CAAC,uBAAuB,EAAE;gBACtE,OAAO,EAAE,CAAA;aACV;YACD,OAAO;gBACL;oBACE,GAAG,EAAE,qBAAqB;oBAC1B,KAAK,EAAE,sBAAsB;oBAC7B,KAAK,EACH,kBAAkB,CAAC,uBAAuB;yBACvC,0BAA0B;iBAChC;gBACD;oBACE,GAAG,EAAE,kBAAkB;oBACvB,KAAK,EAAE,mBAAmB;oBAC1B,KAAK,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,gBAAgB;iBACnE;gBACD;oBACE,GAAG,EAAE,eAAe;oBACpB,KAAK,EAAE,gBAAgB;oBACvB,KAAK,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,aAAa;iBAChE;gBACD;oBACE,GAAG,EAAE,eAAe;oBACpB,KAAK,EAAE,gBAAgB;oBACvB,KAAK,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,aAAa;iBAChE;gBACD,GAAG,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,aAAa;oBAC1D,MAAM,KAAI,MAAA,kBAAkB,CAAC,uBAAuB,CAAC,IAAI,0CAAE,UAAU,CAAA;oBACrE,CAAC,CAAC;wBACE;4BACE,GAAG,EAAE,YAAY;4BACjB,KAAK,EAAE,kBAAkB;4BACzB,KAAK,EACH,kBAAkB,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU;yBAC7D;qBACF;oBACH,CAAC,CAAC,EAAE,CAAC;gBACP,GAAG,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,aAAa,KAAK,MAAM;oBACrE,CAAC,CAAC;wBACE;4BACE,GAAG,EAAE,gBAAgB;4BACrB,KAAK,EAAE,aAAa;4BACpB,KAAK,EAAE,kBAAkB,MAAA,kBAAkB,CAAC,uBAAuB,CAAC,IAAI,0CAAE,WAAW,EAAE;yBACxF;qBACF;oBACH,CAAC,CAAC,EAAE,CAAC;gBACP;oBACE,GAAG,EAAE,QAAQ;oBACb,KAAK,EAAE,QAAQ;oBACf,KAAK,EAAE,cAAc,CACnB,kBAAkB,CAAC,uBAAuB,CAAC,MAAM,CAClD;iBACF;gBACD;oBACE,GAAG,EAAE,iBAAiB;oBACtB,KAAK,EAAE,kBAAkB;oBACzB,KAAK,EAAE,cAAc,CACnB,kBAAkB,CAAC,uBAAuB,CAAC,SAAS,CACrD;iBACF;gBACD;oBACE,GAAG,EAAE,cAAc;oBACnB,KAAK,EAAE,eAAe;oBACtB,KAAK,EAAE,cAAc,CACnB,kBAAkB,CAAC,uBAAuB,CAAC,YAAY,CACxD;iBACF;gBACD;oBACE,GAAG,EAAE,iBAAiB;oBACtB,KAAK,EAAE,mBAAmB;oBAC1B,KAAK,EAAE,cAAc,CAAC,qBAAqB,CAAC,SAAS,CAAC;iBACvD;aACF,CAAA;SACF;QACD,KAAK,QAAQ,CAAC,CAAC;YACb,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAA;YACpD,IAAI,CAAC,kBAAkB,EAAE;gBACvB,OAAO,EAAE,CAAA;aACV;YACD,OAAO;gBACL;oBACE,GAAG,EAAE,eAAe;oBACpB,KAAK,EAAE,gBAAgB;oBACvB,KAAK,EAAE,kBAAkB,CAAC,aAAa;iBACxC;gBACD;oBACE,GAAG,EAAE,MAAM;oBACX,KAAK,EAAE,OAAO;oBACd,KAAK,EAAE,kBAAkB,CAAC,IAAI;iBAC/B;gBACD;oBACE,GAAG,EAAE,MAAM;oBACX,KAAK,EAAE,OAAO;oBACd,KAAK,EAAE,kBAAkB,CAAC,IAAI;iBAC/B;gBACD;oBACE,GAAG,EAAE,MAAM;oBACX,KAAK,EAAE,OAAO;oBACd,KAAK,EAAE,kBAAkB,CAAC,IAAI;iBAC/B;gBACD;oBACE,GAAG,EAAE,YAAY;oBACjB,KAAK,EAAE,aAAa;oBACpB,KAAK,EAAE,kBAAkB,CAAC,UAAU;iBACrC;gBACD;oBACE,GAAG,EAAE,gBAAgB;oBACrB,KAAK,EAAE,aAAa;oBACpB,KAAK,EAAE,kBAAkB,CAAC,WAAW,CAAC,gBAAgB;iBACvD;gBACD;oBACE,GAAG,EAAE,QAAQ;oBACb,KAAK,EAAE,QAAQ;oBACf,KAAK,EAAE,cAAc,CAAC,kBAAkB,CAAC,MAAM,GAAG,GAAG,CAAC;iBACvD;gBACD;oBACE,GAAG,EAAE,iBAAiB;oBACtB,KAAK,EAAE,kBAAkB;oBACzB,KAAK,EAAE,cAAc,CAAC,kBAAkB,CAAC,eAAe,GAAG,GAAG,CAAC;iBAChE;gBACD;oBACE,GAAG,EAAE,mBAAmB;oBACxB,KAAK,EAAE,qBAAqB;oBAC5B,KAAK,EAAE,cAAc,CAAC,kBAAkB,CAAC,iBAAiB,CAAC;iBAC5D;aACF,CAAA;SACF;QACD,KAAK,QAAQ,CAAC,CAAC;YACb,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAA;YACpD,IAAI,CAAC,kBAAkB,EAAE;gBACvB,OAAO,EAAE,CAAA;aACV;YAED,MAAM,gBAAgB,GAAG,GAAG,EAAE;;gBAC5B,QAAQ,kBAAkB,CAAC,YAAY,EAAE;oBACvC,KAAK,IAAI,CAAC,CAAC;wBACT,OAAO;4BACL,aAAa,EAAE,kBAAkB,CAAC,MAAM,CAAC,EAAE;4BAC3C,WAAW,EACT,MAAA,kBAAkB,CAAC,MAAM,CAAC,mBAAmB,mCAAI,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,cAAc,CAAC,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC;gCAClD,CAAC,CAAC,SAAS;4BACf,eAAe,EAAE,kBAAkB,CAAC,MAAM,CAAC,YAAY;yBACxD,CAAA;qBACF;oBACD,OAAO,CAAC,CAAC;wBACP,OAAO;4BACL,aAAa,EAAE,kBAAkB,CAAC,aAAa;4BAC/C,WAAW,EAAE,MAAA,kBAAkB,CAAC,WAAW,mCAAI,SAAS;4BACxD,WAAW,EACT,kBAAkB,CAAC,aAAa,KAAK,CAAC;gCACpC,CAAC,CAAC,mBAAmB;gCACrB,CAAC,CAAC,kBAAkB,CAAC,aAAa,KAAK,CAAC;oCACxC,CAAC,CAAC,KAAK;oCACP,CAAC,CAAC,SAAS;4BACf,cAAc,EAAE,kBAAkB,CAAC,QAAQ;gCACzC,CAAC,CAAC,kBAAkB,kBAAkB,CAAC,QAAQ,EAAE;gCACjD,CAAC,CAAC,SAAS;4BACb,MAAM,EAAE,cAAc,CAAC,kBAAkB,CAAC,MAAM,CAAC;4BACjD,eAAe,EAAE,kBAAkB,CAAC,SAAS;yBAC9C,CAAA;qBACF;iBACF;YACH,CAAC,CAAA;YAED,MAAM,EACJ,aAAa,EACb,WAAW,EACX,WAAW,EACX,cAAc,EACd,MAAM,EACN,eAAe,GAChB,GAAG,gBAAgB,EAAE,CAAA;YACtB,MAAM,MAAM,GAAG,EAAE,CAAA;YACjB,IAAI,aAAa,EAAE;gBACjB,MAAM,CAAC,IAAI,CAAC;oBACV,GAAG,EAAE,eAAe;oBACpB,KAAK,EAAE,gBAAgB;oBACvB,KAAK,EAAE,aAAa;iBACrB,CAAC,CAAA;aACH;YACD,IAAI,WAAW,EAAE;gBACf,MAAM,CAAC,IAAI,CAAC;oBACV,GAAG,EAAE,aAAa;oBAClB,KAAK,EAAE,cAAc;oBACrB,KAAK,EAAE,WAAW;iBACnB,CAAC,CAAA;aACH;YACD,IAAI,WAAW,EAAE;gBACf,MAAM,CAAC,IAAI,CAAC;oBACV,GAAG,EAAE,aAAa;oBAClB,KAAK,EAAE,cAAc;oBACrB,KAAK,EAAE,WAAW;iBACnB,CAAC,CAAA;aACH;YACD,IAAI,cAAc,EAAE;gBAClB,MAAM,CAAC,IAAI,CAAC;oBACV,GAAG,EAAE,gBAAgB;oBACrB,KAAK,EAAE,aAAa;oBACpB,KAAK,EAAE,cAAc;iBACtB,CAAC,CAAA;aACH;YACD,IAAI,MAAM,EAAE;gBACV,MAAM,CAAC,IAAI,CAAC;oBACV,GAAG,EAAE,QAAQ;oBACb,KAAK,EAAE,QAAQ;oBACf,KAAK,EAAE,MAAM;iBACd,CAAC,CAAA;aACH;YACD,IAAI,eAAe,EAAE;gBACnB,MAAM,CAAC,IAAI,CAAC;oBACV,GAAG,EAAE,iBAAiB;oBACtB,KAAK,EAAE,YAAY;oBACnB,KAAK,EAAE,cAAc,CAAC,eAAe,CAAC;iBACvC,CAAC,CAAA;aACH;YAED,OAAO,MAAM,CAAA;SACd;QACD,KAAK,sBAAsB,CAAC,CAAC;YAC3B,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAA;YACpD,IAAI,CAAC,kBAAkB,EAAE;gBACvB,OAAO,EAAE,CAAA;aACV;YAED,OAAO;gBACL;oBACE,GAAG,EAAE,eAAe;oBACpB,KAAK,EAAE,gBAAgB;oBACvB,KAAK,EAAE,kBAAkB,CAAC,aAAa;iBACxC;gBACD;oBACE,GAAG,EAAE,wBAAwB;oBAC7B,KAAK,EAAE,mBAAmB;oBAC1B,KAAK,EAAE,kBAAkB,CAAC,sBAAsB;iBACjD;gBACD;oBACE,GAAG,EAAE,yBAAyB;oBAC9B,KAAK,EAAE,2BAA2B;oBAClC,KAAK,EAAE,kBAAkB,CAAC,uBAAuB;iBAClD;gBACD,GAAG,CAAC,kBAAkB,CAAC,WAAW;oBAChC,CAAC,CAAC;wBACE;4BACE,GAAG,EAAE,QAAQ;4BACb,KAAK,EAAE,QAAQ;4BACf,KAAK,EAAE,cAAc,CACnB,UAAU,CAAC,kBAAkB,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAC7D;yBACF;qBACF;oBACH,CAAC,CAAC,EAAE,CAAC;gBACP,GAAG,CAAC,kBAAkB,CAAC,eAAe,CAAC,MAAM;oBAC3C,CAAC,CAAC;wBACE;4BACE,GAAG,EAAE,iBAAiB;4BACtB,KAAK,EAAE,kBAAkB;4BACzB,KAAK,EAAE,cAAc,CACnB,UAAU,CACR,kBAAkB,CAAC,eAAe,CAAC,MAAM,CAAC,QAAQ,EAAE,CACrD,CACF;yBACF;qBACF;oBACH,CAAC,CAAC,EAAE,CAAC;gBACP;oBACE,GAAG,EAAE,gBAAgB;oBACrB,KAAK,EAAE,iBAAiB;oBACxB,KAAK,EAAE,cAAc,CAAC,kBAAkB,CAAC,cAAc,CAAC;iBACzD;aACF,CAAA;SACF;KACF;AACH,CAAC,CAAA;AAzSY,QAAA,0CAA0C,8CAyStD","sourcesContent":["import {\n  FormTypes,\n  SubmissionEventTypes,\n  SubmissionTypes,\n} from '@oneblink/types'\nimport { conditionalLogicService, formElementsService } from '.'\nimport {\n  getRootElementValueById,\n  ReplaceInjectablesFormatters,\n} from './submissionService'\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(form, submission)\n * ```\n *\n * @param definition\n * @param submission\n * @returns\n */\nexport function checkForPaymentEvent(\n  definition: FormTypes.Form,\n  submission: SubmissionTypes.S3SubmissionData['submission'],\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        })\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 key to identify the detail */\n  key: string\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 *     formatCurrency,\n *   })\n * ```\n *\n * @param options\n * @returns\n */\nexport const getDisplayDetailsFromFormSubmissionPayment = ({\n  formSubmissionPayment,\n  formatCurrency,\n  formatDateTime,\n}: {\n  /** The form submission payment to get the details from */\n  formSubmissionPayment: SubmissionTypes.FormSubmissionPayment\n  /** A function to format any curreny values */\n  formatCurrency: ReplaceInjectablesFormatters['formatCurrency']\n  /**\n   * A function to format any dates. If this is not passed, datetimes will be\n   * returned as iso strings.\n   */\n  formatDateTime: ReplaceInjectablesFormatters['formatDateTime']\n}): PaymentDisplayDetail[] => {\n  switch (formSubmissionPayment.type) {\n    case 'NSW_GOV_PAY': {\n      const { paymentTransaction } = formSubmissionPayment\n      if (!paymentTransaction || !paymentTransaction.agencyCompletionPayment) {\n        return []\n      }\n      return [\n        {\n          key: 'completionReference',\n          label: 'Completion Reference',\n          value:\n            paymentTransaction.agencyCompletionPayment\n              .paymentCompletionReference,\n        },\n        {\n          key: 'paymentReference',\n          label: 'Payment Reference',\n          value: paymentTransaction.agencyCompletionPayment.paymentReference,\n        },\n        {\n          key: 'bankReference',\n          label: 'Bank Reference',\n          value: paymentTransaction.agencyCompletionPayment.bankReference,\n        },\n        {\n          key: 'paymentMethod',\n          label: 'Payment Method',\n          value: paymentTransaction.agencyCompletionPayment.paymentMethod,\n        },\n        ...(paymentTransaction.agencyCompletionPayment.paymentMethod ===\n          'BPAY' && paymentTransaction.agencyCompletionPayment.bPay?.billerCode\n          ? [\n              {\n                key: 'billerCode',\n                label: 'BPay Biller Code',\n                value:\n                  paymentTransaction.agencyCompletionPayment.bPay.billerCode,\n              },\n            ]\n          : []),\n        ...(paymentTransaction.agencyCompletionPayment.paymentMethod === 'CARD'\n          ? [\n              {\n                key: 'creditCardMask',\n                label: 'Card Number',\n                value: `xxxx xxxx xxxx ${paymentTransaction.agencyCompletionPayment.card?.last4Digits}`,\n              },\n            ]\n          : []),\n        {\n          key: 'amount',\n          label: 'Amount',\n          value: formatCurrency(\n            paymentTransaction.agencyCompletionPayment.amount,\n          ),\n        },\n        {\n          key: 'surchargeAmount',\n          label: 'Surcharge Amount',\n          value: formatCurrency(\n            paymentTransaction.agencyCompletionPayment.surcharge,\n          ),\n        },\n        {\n          key: 'surchargeGST',\n          label: 'Surcharge GST',\n          value: formatCurrency(\n            paymentTransaction.agencyCompletionPayment.surchargeGst,\n          ),\n        },\n        {\n          key: 'createdDateTime',\n          label: 'Created Date Time',\n          value: formatDateTime(formSubmissionPayment.createdAt),\n        },\n      ]\n    }\n    case 'BPOINT': {\n      const { paymentTransaction } = formSubmissionPayment\n      if (!paymentTransaction) {\n        return []\n      }\n      return [\n        {\n          key: 'receiptNumber',\n          label: 'Receipt Number',\n          value: paymentTransaction.ReceiptNumber,\n        },\n        {\n          key: 'crn1',\n          label: 'CRN 1',\n          value: paymentTransaction.Crn1,\n        },\n        {\n          key: 'crn2',\n          label: 'CRN 2',\n          value: paymentTransaction.Crn2,\n        },\n        {\n          key: 'crn3',\n          label: 'CRN 3',\n          value: paymentTransaction.Crn3,\n        },\n        {\n          key: 'billerCode',\n          label: 'Biller Code',\n          value: paymentTransaction.BillerCode,\n        },\n        {\n          key: 'creditCardMask',\n          label: 'Card Number',\n          value: paymentTransaction.CardDetails.MaskedCardNumber,\n        },\n        {\n          key: 'amount',\n          label: 'Amount',\n          value: formatCurrency(paymentTransaction.Amount / 100),\n        },\n        {\n          key: 'surchargeAmount',\n          label: 'Surcharge Amount',\n          value: formatCurrency(paymentTransaction.AmountSurcharge / 100),\n        },\n        {\n          key: 'processedDateTime',\n          label: 'Processed Date Time',\n          value: formatDateTime(paymentTransaction.ProcessedDateTime),\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                  ? formatCurrency(paymentTransaction.result.amount)\n                  : 'Unknown',\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: formatCurrency(paymentTransaction.amount),\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 result = []\n      if (transactionId) {\n        result.push({\n          key: 'transactionId',\n          label: 'Transaction Id',\n          value: transactionId,\n        })\n      }\n      if (orderNumber) {\n        result.push({\n          key: 'orderNumber',\n          label: 'Order Number',\n          value: orderNumber,\n        })\n      }\n      if (paymentType) {\n        result.push({\n          key: 'paymentType',\n          label: 'Payment Type',\n          value: paymentType,\n        })\n      }\n      if (creditCardMask) {\n        result.push({\n          key: 'creditCardMask',\n          label: 'Card Number',\n          value: creditCardMask,\n        })\n      }\n      if (amount) {\n        result.push({\n          key: 'amount',\n          label: 'Amount',\n          value: amount,\n        })\n      }\n      if (createdDateTime) {\n        result.push({\n          key: 'createdDateTime',\n          label: 'Created At',\n          value: formatDateTime(createdDateTime),\n        })\n      }\n\n      return result\n    }\n    case 'WESTPAC_QUICK_STREAM': {\n      const { paymentTransaction } = formSubmissionPayment\n      if (!paymentTransaction) {\n        return []\n      }\n\n      return [\n        {\n          key: 'receiptNumber',\n          label: 'Receipt Number',\n          value: paymentTransaction.receiptNumber,\n        },\n        {\n          key: 'paymentReferenceNumber',\n          label: 'Payment Reference',\n          value: paymentTransaction.paymentReferenceNumber,\n        },\n        {\n          key: 'customerReferenceNumber',\n          label: 'Customer Reference Number',\n          value: paymentTransaction.customerReferenceNumber,\n        },\n        ...(paymentTransaction.totalAmount\n          ? [\n              {\n                key: 'amount',\n                label: 'Amount',\n                value: formatCurrency(\n                  parseFloat(paymentTransaction.totalAmount.amount.toString()),\n                ),\n              },\n            ]\n          : []),\n        ...(paymentTransaction.surchargeAmount.amount\n          ? [\n              {\n                key: 'surchargeAmount',\n                label: 'Surcharge Amount',\n                value: formatCurrency(\n                  parseFloat(\n                    paymentTransaction.surchargeAmount.amount.toString(),\n                  ),\n                ),\n              },\n            ]\n          : []),\n        {\n          key: 'settlementDate',\n          label: 'Settlement Date',\n          value: formatDateTime(paymentTransaction.settlementDate),\n        },\n      ]\n    }\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": "7.2.0-beta.1",
+  "version": "7.3.0-beta.1",
   "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
   "bugs": {
     "url": "https://github.com/oneblink/sdk-core-js/issues"