@oneblink/apps-react 9.0.0-beta.1 → 9.0.0-beta.10

package/dist/apps/services/payment-providers/WestpacQuickStreamPaymentProvider.d.ts

@@ -0,0 +1,49 @@
+import { SubmissionEventTypes } from '@oneblink/types';
+import { BasePaymentConfigurationPayload, PaymentProvider } from '../../types/payments';
+import { FormSubmissionResult } from '../../types/submissions';
+export default class WestpacQuickStreamPaymentProvider implements PaymentProvider<SubmissionEventTypes.WestpacQuickStreamSubmissionEvent> {
+    constructor(paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent, formSubmissionResult: FormSubmissionResult);
+    formSubmissionResult: FormSubmissionResult;
+    paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent;
+    preparePaymentConfiguration(payload: BasePaymentConfigurationPayload): {
+        path: string;
+        payload: BasePaymentConfigurationPayload;
+    };
+    verifyPaymentTransaction(query: Record<string, unknown>): Promise<{
+        receiptItems: import("../../types/payments").PaymentReceiptItem[];
+        transaction: {
+            isSuccess: boolean;
+            errorMessage: string;
+        };
+        submissionResult: FormSubmissionResult;
+    }>;
+}
+export declare function getPaymentFormConfiguration({ formSubmissionResult, formSubmissionPaymentId, paymentSubmissionEvent, abortSignal, }: {
+    formSubmissionResult: FormSubmissionResult;
+    formSubmissionPaymentId: string;
+    paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent;
+    abortSignal: AbortSignal;
+}): Promise<{
+    supplierBusinessCode: string;
+    publishableApiKey: string;
+    isTestMode: boolean;
+}>;
+export declare function completeTransaction({ formSubmissionPaymentId, formSubmissionResult, paymentSubmissionEvent, singleUseTokenId, captchaSiteKey, captchaToken, abortSignal, }: {
+    formSubmissionPaymentId: string;
+    formSubmissionResult: FormSubmissionResult;
+    paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent;
+    singleUseTokenId: string;
+    captchaSiteKey: string;
+    captchaToken: string;
+    abortSignal?: AbortSignal;
+}): Promise<{
+    formSubmissionPayment: import("@oneblink/types/typescript/submissions").FormSubmissionPayment;
+    paymentReceiptUrl: string;
+}>;
+export declare function cancelPayment({ formSubmissionPaymentId, formSubmissionResult, abortSignal, }: {
+    formSubmissionPaymentId: string;
+    formSubmissionResult: FormSubmissionResult;
+    abortSignal?: AbortSignal;
+}): Promise<{
+    paymentReceiptUrl: string;
+}>;

package/dist/apps/services/payment-providers/WestpacQuickStreamPaymentProvider.js

@@ -0,0 +1,116 @@
+import replaceInjectablesWithSubmissionValues from '../replaceInjectablesWithSubmissionValues';
+import OneBlinkAppsError from '../errors/oneBlinkAppsError';
+import { generateAmountReceiptItem, generateCreditCardMaskReceiptItem, generateSubmissionIdReceiptItem, prepareReceiptItems, } from './receipt-items';
+import { cancelWestpacQuickStreamPayment, completeWestpacQuickStreamTransaction, getCustomFormPaymentConfiguration, } from '../api/payment';
+export default class WestpacQuickStreamPaymentProvider {
+    constructor(paymentSubmissionEvent, formSubmissionResult) {
+        this.formSubmissionResult = formSubmissionResult;
+        this.paymentSubmissionEvent = paymentSubmissionEvent;
+    }
+    preparePaymentConfiguration(payload) {
+        if (!payload.submissionId) {
+            throw new Error('Westpac QuickStream Payments require the "submissionId" option.');
+        }
+        if (!payload.paymentFormUrl) {
+            throw new Error('Westpac QuickStream Payments require the "paymentFormUrl" option.');
+        }
+        return {
+            path: `/forms/${this.formSubmissionResult.definition.id}/westpac-quick-stream-payment`,
+            payload,
+        };
+    }
+    async verifyPaymentTransaction(query) {
+        const { paymentReferenceNumber, receiptNumber, maskedCardNumber4Digits, summaryCode, responseDescription, totalAmount, } = query;
+        if (!paymentReferenceNumber ||
+            !receiptNumber ||
+            !summaryCode ||
+            !responseDescription ||
+            !totalAmount) {
+            throw new OneBlinkAppsError('Transactions can not be verified unless navigating here directly after a payment.');
+        }
+        if (this.formSubmissionResult.submissionId !== paymentReferenceNumber) {
+            throw new OneBlinkAppsError('It looks like you are attempting to view a receipt for the incorrect payment.');
+        }
+        return {
+            receiptItems: prepareReceiptItems([
+                generateSubmissionIdReceiptItem(this.formSubmissionResult.submissionId),
+                {
+                    className: 'ob-payment-receipt__transaction-id',
+                    valueClassName: 'cypress-payment-receipt-transaction-id',
+                    icon: 'shopping_cart',
+                    label: 'Receipt Number',
+                    value: receiptNumber,
+                    allowCopyToClipboard: true,
+                },
+                generateCreditCardMaskReceiptItem(maskedCardNumber4Digits),
+                generateAmountReceiptItem(parseFloat(totalAmount)),
+            ]),
+            transaction: {
+                isSuccess: summaryCode === '0',
+                errorMessage: responseDescription,
+            },
+            submissionResult: this.formSubmissionResult,
+        };
+    }
+}
+export async function getPaymentFormConfiguration({ formSubmissionResult, formSubmissionPaymentId, paymentSubmissionEvent, abortSignal, }) {
+    const { supplierBusinessCode, publishableApiKey, isTestMode } = await getCustomFormPaymentConfiguration(`/forms/${formSubmissionResult.definition.id}/westpac-quick-stream-payment/${formSubmissionPaymentId}`, {
+        integrationEnvironmentId: paymentSubmissionEvent.configuration.environmentId,
+    }, abortSignal);
+    return {
+        supplierBusinessCode,
+        publishableApiKey,
+        isTestMode,
+    };
+}
+export async function completeTransaction({ formSubmissionPaymentId, formSubmissionResult, paymentSubmissionEvent, singleUseTokenId, captchaSiteKey, captchaToken, abortSignal, }) {
+    var _a, _b;
+    if (!formSubmissionResult.payment) {
+        throw new Error('"formSubmissionResult.payment" must have a value to complete transactions');
+    }
+    const { formSubmissionPayment } = await completeWestpacQuickStreamTransaction(formSubmissionResult.definition.id, {
+        formSubmissionPaymentId,
+        singleUseTokenId,
+        integrationEnvironmentId: paymentSubmissionEvent.configuration.environmentId,
+        customerReferenceNumber: replaceInjectablesWithSubmissionValues(paymentSubmissionEvent.configuration.customerReferenceNumber, formSubmissionResult).text,
+        principalAmount: formSubmissionResult.payment.amount,
+        recaptcha: {
+            siteKey: captchaSiteKey,
+            token: captchaToken,
+        },
+    }, abortSignal);
+    const url = new URL(formSubmissionResult.payment.paymentReceiptUrl);
+    if (formSubmissionPayment.type === 'WESTPAC_QUICK_STREAM' &&
+        formSubmissionPayment.paymentTransaction) {
+        url.searchParams.append('paymentReferenceNumber', formSubmissionPayment.paymentTransaction.paymentReferenceNumber);
+        url.searchParams.append('receiptNumber', formSubmissionPayment.paymentTransaction.receiptNumber);
+        url.searchParams.append('totalAmount', formSubmissionPayment.paymentTransaction.totalAmount.amount.toString());
+        url.searchParams.append('summaryCode', formSubmissionPayment.paymentTransaction.summaryCode);
+        url.searchParams.append('responseDescription', formSubmissionPayment.paymentTransaction.responseDescription);
+        if ((_a = formSubmissionPayment.paymentTransaction.creditCard) === null || _a === void 0 ? void 0 : _a.maskedCardNumber4Digits) {
+            url.searchParams.append('maskedCardNumber4Digits', (_b = formSubmissionPayment.paymentTransaction.creditCard) === null || _b === void 0 ? void 0 : _b.maskedCardNumber4Digits);
+        }
+    }
+    return {
+        formSubmissionPayment,
+        paymentReceiptUrl: url.href,
+    };
+}
+export async function cancelPayment({ formSubmissionPaymentId, formSubmissionResult, abortSignal, }) {
+    if (!formSubmissionResult.payment) {
+        throw new Error('"formSubmissionResult.payment" must have a value to cancel payments');
+    }
+    await cancelWestpacQuickStreamPayment(formSubmissionResult.definition.id, formSubmissionPaymentId, abortSignal);
+    const url = new URL(formSubmissionResult.payment.paymentReceiptUrl);
+    if (formSubmissionResult.submissionId) {
+        url.searchParams.append('paymentReferenceNumber', formSubmissionResult.submissionId);
+    }
+    url.searchParams.append('receiptNumber', formSubmissionPaymentId);
+    url.searchParams.append('totalAmount', formSubmissionResult.payment.amount.toString());
+    url.searchParams.append('summaryCode', '1');
+    url.searchParams.append('responseDescription', 'Payment Cancelled');
+    return {
+        paymentReceiptUrl: url.href,
+    };
+}
+//# sourceMappingURL=WestpacQuickStreamPaymentProvider.js.map

package/dist/apps/services/payment-providers/WestpacQuickStreamPaymentProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WestpacQuickStreamPaymentProvider.js","sourceRoot":"","sources":["../../../../src/apps/services/payment-providers/WestpacQuickStreamPaymentProvider.ts"],"names":[],"mappings":"AAMA,OAAO,sCAAsC,MAAM,2CAA2C,CAAA;AAC9F,OAAO,iBAAiB,MAAM,6BAA6B,CAAA;AAC3D,OAAO,EACL,yBAAyB,EACzB,iCAAiC,EACjC,+BAA+B,EAC/B,mBAAmB,GACpB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,+BAA+B,EAC/B,qCAAqC,EACrC,iCAAiC,GAClC,MAAM,gBAAgB,CAAA;AAEvB,MAAM,CAAC,OAAO,OAAO,iCAAiC;IAIpD,YACE,sBAA8E,EAC9E,oBAA0C;QAE1C,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAA;QAChD,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAA;IACtD,CAAC;IAKD,2BAA2B,CAAC,OAAwC;QAClE,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAA;QACH,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAA;QACH,CAAC;QACD,OAAO;YACL,IAAI,EAAE,UAAU,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,EAAE,+BAA+B;YACtF,OAAO;SACR,CAAA;IACH,CAAC;IAED,KAAK,CAAC,wBAAwB,CAAC,KAA8B;QAC3D,MAAM,EACJ,sBAAsB,EACtB,aAAa,EACb,uBAAuB,EACvB,WAAW,EACX,mBAAmB,EACnB,WAAW,GACZ,GAAG,KAOH,CAAA;QACD,IACE,CAAC,sBAAsB;YACvB,CAAC,aAAa;YACd,CAAC,WAAW;YACZ,CAAC,mBAAmB;YACpB,CAAC,WAAW,EACZ,CAAC;YACD,MAAM,IAAI,iBAAiB,CACzB,mFAAmF,CACpF,CAAA;QACH,CAAC;QACD,IAAI,IAAI,CAAC,oBAAoB,CAAC,YAAY,KAAK,sBAAsB,EAAE,CAAC;YACtE,MAAM,IAAI,iBAAiB,CACzB,+EAA+E,CAChF,CAAA;QACH,CAAC;QAED,OAAO;YACL,YAAY,EAAE,mBAAmB,CAAC;gBAChC,+BAA+B,CAAC,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC;gBACvE;oBACE,SAAS,EAAE,oCAAoC;oBAC/C,cAAc,EAAE,wCAAwC;oBACxD,IAAI,EAAE,eAAe;oBACrB,KAAK,EAAE,gBAAgB;oBACvB,KAAK,EAAE,aAAa;oBACpB,oBAAoB,EAAE,IAAI;iBAC3B;gBACD,iCAAiC,CAAC,uBAAuB,CAAC;gBAC1D,yBAAyB,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;aACnD,CAAC;YACF,WAAW,EAAE;gBACX,SAAS,EAAE,WAAW,KAAK,GAAG;gBAC9B,YAAY,EAAE,mBAAmB;aAClC;YACD,gBAAgB,EAAE,IAAI,CAAC,oBAAoB;SAC5C,CAAA;IACH,CAAC;CACF;AAED,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAC,EAChD,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EACtB,WAAW,GAMZ;IAKC,MAAM,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,UAAU,EAAE,GAC3D,MAAM,iCAAiC,CAKrC,UAAU,oBAAoB,CAAC,UAAU,CAAC,EAAE,iCAAiC,uBAAuB,EAAE,EACtG;QACE,wBAAwB,EACtB,sBAAsB,CAAC,aAAa,CAAC,aAAa;KACrD,EACD,WAAW,CACZ,CAAA;IAEH,OAAO;QACL,oBAAoB;QACpB,iBAAiB;QACjB,UAAU;KACX,CAAA;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,EACxC,uBAAuB,EACvB,oBAAoB,EACpB,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,WAAW,GASZ;;IACC,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAA;IACH,CAAC;IAED,MAAM,EAAE,qBAAqB,EAAE,GAAG,MAAM,qCAAqC,CAC3E,oBAAoB,CAAC,UAAU,CAAC,EAAE,EAClC;QACE,uBAAuB;QACvB,gBAAgB;QAChB,wBAAwB,EACtB,sBAAsB,CAAC,aAAa,CAAC,aAAa;QACpD,uBAAuB,EAAE,sCAAsC,CAC7D,sBAAsB,CAAC,aAAa,CAAC,uBAAuB,EAC5D,oBAAoB,CACrB,CAAC,IAAI;QACN,eAAe,EAAE,oBAAoB,CAAC,OAAO,CAAC,MAAM;QACpD,SAAS,EAAE;YACT,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,YAAY;SACpB;KACF,EACD,WAAW,CACZ,CAAA;IAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACnE,IACE,qBAAqB,CAAC,IAAI,KAAK,sBAAsB;QACrD,qBAAqB,CAAC,kBAAkB,EACxC,CAAC;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,wBAAwB,EACxB,qBAAqB,CAAC,kBAAkB,CAAC,sBAAsB,CAChE,CAAA;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,eAAe,EACf,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,CACvD,CAAA;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,aAAa,EACb,qBAAqB,CAAC,kBAAkB,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CACvE,CAAA;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,aAAa,EACb,qBAAqB,CAAC,kBAAkB,CAAC,WAAW,CACrD,CAAA;QACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,qBAAqB,EACrB,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC7D,CAAA;QACD,IACE,MAAA,qBAAqB,CAAC,kBAAkB,CAAC,UAAU,0CAC/C,uBAAuB,EAC3B,CAAC;YACD,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,yBAAyB,EACzB,MAAA,qBAAqB,CAAC,kBAAkB,CAAC,UAAU,0CAC/C,uBAAuB,CAC5B,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,qBAAqB;QACrB,iBAAiB,EAAE,GAAG,CAAC,IAAI;KAC5B,CAAA;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAClC,uBAAuB,EACvB,oBAAoB,EACpB,WAAW,GAKZ;IACC,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAA;IACH,CAAC;IAED,MAAM,+BAA+B,CACnC,oBAAoB,CAAC,UAAU,CAAC,EAAE,EAClC,uBAAuB,EACvB,WAAW,CACZ,CAAA;IAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACnE,IAAI,oBAAoB,CAAC,YAAY,EAAE,CAAC;QACtC,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,wBAAwB,EACxB,oBAAoB,CAAC,YAAY,CAClC,CAAA;IACH,CAAC;IACD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,eAAe,EAAE,uBAAuB,CAAC,CAAA;IACjE,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,aAAa,EACb,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAC/C,CAAA;IACD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;IAC3C,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,CAAA;IAEnE,OAAO;QACL,iBAAiB,EAAE,GAAG,CAAC,IAAI;KAC5B,CAAA;AACH,CAAC","sourcesContent":["import { SubmissionEventTypes } from '@oneblink/types'\nimport {\n  BasePaymentConfigurationPayload,\n  PaymentProvider,\n} from '../../types/payments'\nimport { FormSubmissionResult } from '../../types/submissions'\nimport replaceInjectablesWithSubmissionValues from '../replaceInjectablesWithSubmissionValues'\nimport OneBlinkAppsError from '../errors/oneBlinkAppsError'\nimport {\n  generateAmountReceiptItem,\n  generateCreditCardMaskReceiptItem,\n  generateSubmissionIdReceiptItem,\n  prepareReceiptItems,\n} from './receipt-items'\nimport {\n  cancelWestpacQuickStreamPayment,\n  completeWestpacQuickStreamTransaction,\n  getCustomFormPaymentConfiguration,\n} from '../api/payment'\n\nexport default class WestpacQuickStreamPaymentProvider\n  implements\n    PaymentProvider<SubmissionEventTypes.WestpacQuickStreamSubmissionEvent>\n{\n  constructor(\n    paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent,\n    formSubmissionResult: FormSubmissionResult,\n  ) {\n    this.formSubmissionResult = formSubmissionResult\n    this.paymentSubmissionEvent = paymentSubmissionEvent\n  }\n\n  formSubmissionResult: FormSubmissionResult\n  paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent\n\n  preparePaymentConfiguration(payload: BasePaymentConfigurationPayload) {\n    if (!payload.submissionId) {\n      throw new Error(\n        'Westpac QuickStream Payments require the \"submissionId\" option.',\n      )\n    }\n    if (!payload.paymentFormUrl) {\n      throw new Error(\n        'Westpac QuickStream Payments require the \"paymentFormUrl\" option.',\n      )\n    }\n    return {\n      path: `/forms/${this.formSubmissionResult.definition.id}/westpac-quick-stream-payment`,\n      payload,\n    }\n  }\n\n  async verifyPaymentTransaction(query: Record<string, unknown>) {\n    const {\n      paymentReferenceNumber,\n      receiptNumber,\n      maskedCardNumber4Digits,\n      summaryCode,\n      responseDescription,\n      totalAmount,\n    } = query as {\n      paymentReferenceNumber?: string\n      receiptNumber?: string\n      maskedCardNumber4Digits?: string\n      summaryCode?: string\n      responseDescription?: string\n      totalAmount?: string\n    }\n    if (\n      !paymentReferenceNumber ||\n      !receiptNumber ||\n      !summaryCode ||\n      !responseDescription ||\n      !totalAmount\n    ) {\n      throw new OneBlinkAppsError(\n        'Transactions can not be verified unless navigating here directly after a payment.',\n      )\n    }\n    if (this.formSubmissionResult.submissionId !== paymentReferenceNumber) {\n      throw new OneBlinkAppsError(\n        'It looks like you are attempting to view a receipt for the incorrect payment.',\n      )\n    }\n\n    return {\n      receiptItems: prepareReceiptItems([\n        generateSubmissionIdReceiptItem(this.formSubmissionResult.submissionId),\n        {\n          className: 'ob-payment-receipt__transaction-id',\n          valueClassName: 'cypress-payment-receipt-transaction-id',\n          icon: 'shopping_cart',\n          label: 'Receipt Number',\n          value: receiptNumber,\n          allowCopyToClipboard: true,\n        },\n        generateCreditCardMaskReceiptItem(maskedCardNumber4Digits),\n        generateAmountReceiptItem(parseFloat(totalAmount)),\n      ]),\n      transaction: {\n        isSuccess: summaryCode === '0',\n        errorMessage: responseDescription,\n      },\n      submissionResult: this.formSubmissionResult,\n    }\n  }\n}\n\nexport async function getPaymentFormConfiguration({\n  formSubmissionResult,\n  formSubmissionPaymentId,\n  paymentSubmissionEvent,\n  abortSignal,\n}: {\n  formSubmissionResult: FormSubmissionResult\n  formSubmissionPaymentId: string\n  paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent\n  abortSignal: AbortSignal\n}): Promise<{\n  supplierBusinessCode: string\n  publishableApiKey: string\n  isTestMode: boolean\n}> {\n  const { supplierBusinessCode, publishableApiKey, isTestMode } =\n    await getCustomFormPaymentConfiguration<{\n      supplierBusinessCode: string\n      publishableApiKey: string\n      isTestMode: boolean\n    }>(\n      `/forms/${formSubmissionResult.definition.id}/westpac-quick-stream-payment/${formSubmissionPaymentId}`,\n      {\n        integrationEnvironmentId:\n          paymentSubmissionEvent.configuration.environmentId,\n      },\n      abortSignal,\n    )\n\n  return {\n    supplierBusinessCode,\n    publishableApiKey,\n    isTestMode,\n  }\n}\n\nexport async function completeTransaction({\n  formSubmissionPaymentId,\n  formSubmissionResult,\n  paymentSubmissionEvent,\n  singleUseTokenId,\n  captchaSiteKey,\n  captchaToken,\n  abortSignal,\n}: {\n  formSubmissionPaymentId: string\n  formSubmissionResult: FormSubmissionResult\n  paymentSubmissionEvent: SubmissionEventTypes.WestpacQuickStreamSubmissionEvent\n  singleUseTokenId: string\n  captchaSiteKey: string\n  captchaToken: string\n  abortSignal?: AbortSignal\n}) {\n  if (!formSubmissionResult.payment) {\n    throw new Error(\n      '\"formSubmissionResult.payment\" must have a value to complete transactions',\n    )\n  }\n\n  const { formSubmissionPayment } = await completeWestpacQuickStreamTransaction(\n    formSubmissionResult.definition.id,\n    {\n      formSubmissionPaymentId,\n      singleUseTokenId,\n      integrationEnvironmentId:\n        paymentSubmissionEvent.configuration.environmentId,\n      customerReferenceNumber: replaceInjectablesWithSubmissionValues(\n        paymentSubmissionEvent.configuration.customerReferenceNumber,\n        formSubmissionResult,\n      ).text,\n      principalAmount: formSubmissionResult.payment.amount,\n      recaptcha: {\n        siteKey: captchaSiteKey,\n        token: captchaToken,\n      },\n    },\n    abortSignal,\n  )\n\n  const url = new URL(formSubmissionResult.payment.paymentReceiptUrl)\n  if (\n    formSubmissionPayment.type === 'WESTPAC_QUICK_STREAM' &&\n    formSubmissionPayment.paymentTransaction\n  ) {\n    url.searchParams.append(\n      'paymentReferenceNumber',\n      formSubmissionPayment.paymentTransaction.paymentReferenceNumber,\n    )\n    url.searchParams.append(\n      'receiptNumber',\n      formSubmissionPayment.paymentTransaction.receiptNumber,\n    )\n    url.searchParams.append(\n      'totalAmount',\n      formSubmissionPayment.paymentTransaction.totalAmount.amount.toString(),\n    )\n    url.searchParams.append(\n      'summaryCode',\n      formSubmissionPayment.paymentTransaction.summaryCode,\n    )\n    url.searchParams.append(\n      'responseDescription',\n      formSubmissionPayment.paymentTransaction.responseDescription,\n    )\n    if (\n      formSubmissionPayment.paymentTransaction.creditCard\n        ?.maskedCardNumber4Digits\n    ) {\n      url.searchParams.append(\n        'maskedCardNumber4Digits',\n        formSubmissionPayment.paymentTransaction.creditCard\n          ?.maskedCardNumber4Digits,\n      )\n    }\n  }\n\n  return {\n    formSubmissionPayment,\n    paymentReceiptUrl: url.href,\n  }\n}\n\nexport async function cancelPayment({\n  formSubmissionPaymentId,\n  formSubmissionResult,\n  abortSignal,\n}: {\n  formSubmissionPaymentId: string\n  formSubmissionResult: FormSubmissionResult\n  abortSignal?: AbortSignal\n}) {\n  if (!formSubmissionResult.payment) {\n    throw new Error(\n      '\"formSubmissionResult.payment\" must have a value to cancel payments',\n    )\n  }\n\n  await cancelWestpacQuickStreamPayment(\n    formSubmissionResult.definition.id,\n    formSubmissionPaymentId,\n    abortSignal,\n  )\n\n  const url = new URL(formSubmissionResult.payment.paymentReceiptUrl)\n  if (formSubmissionResult.submissionId) {\n    url.searchParams.append(\n      'paymentReferenceNumber',\n      formSubmissionResult.submissionId,\n    )\n  }\n  url.searchParams.append('receiptNumber', formSubmissionPaymentId)\n  url.searchParams.append(\n    'totalAmount',\n    formSubmissionResult.payment.amount.toString(),\n  )\n  url.searchParams.append('summaryCode', '1')\n  url.searchParams.append('responseDescription', 'Payment Cancelled')\n\n  return {\n    paymentReceiptUrl: url.href,\n  }\n}\n"]}

package/dist/apps/services/payment-providers/receipt-items.d.ts

@@ -0,0 +1,8 @@
+import { PaymentReceiptItem } from '../../types/payments';
+export declare function prepareReceiptItems(receiptItems: Array<PaymentReceiptItem | undefined>): PaymentReceiptItem[];
+export declare function generateSubmissionIdReceiptItem(submissionId: string | undefined | null): PaymentReceiptItem | undefined;
+export declare function generateCreditCardMaskReceiptItem(creditCardMask: string | undefined | null): PaymentReceiptItem | undefined;
+export declare function generateAmountReceiptItem(amount: number | undefined | null): PaymentReceiptItem | undefined;
+export declare function generateReceiptItem({ value, ...receiptItem }: Omit<PaymentReceiptItem, 'value'> & {
+    value: unknown;
+}): PaymentReceiptItem | undefined;

package/dist/apps/services/payment-providers/receipt-items.js

@@ -0,0 +1,58 @@
+import { localisationService } from '../..';
+export function prepareReceiptItems(receiptItems) {
+    return receiptItems.reduce((memo, receiptItem) => {
+        if (receiptItem) {
+            memo.push(receiptItem);
+        }
+        return memo;
+    }, []);
+}
+export function generateSubmissionIdReceiptItem(submissionId) {
+    if (!submissionId) {
+        return undefined;
+    }
+    return {
+        className: 'ob-payment-receipt__submission-id',
+        valueClassName: 'cypress-payment-receipt-submission-id',
+        icon: 'receipt',
+        label: 'Submission Id',
+        value: submissionId,
+        allowCopyToClipboard: true,
+    };
+}
+export function generateCreditCardMaskReceiptItem(creditCardMask) {
+    if (!creditCardMask) {
+        return undefined;
+    }
+    return {
+        className: 'ob-payment-receipt__card-number',
+        valueClassName: 'cypress-payment-receipt-card-number',
+        icon: 'credit_card',
+        label: 'Card Number',
+        value: creditCardMask,
+        allowCopyToClipboard: false,
+    };
+}
+export function generateAmountReceiptItem(amount) {
+    if (typeof amount !== 'number') {
+        return undefined;
+    }
+    return {
+        className: 'ob-payment-receipt__amount',
+        valueClassName: 'cypress-payment-receipt-amount',
+        icon: 'attach_money',
+        label: 'Amount',
+        value: localisationService.formatCurrency(amount),
+        allowCopyToClipboard: false,
+    };
+}
+export function generateReceiptItem({ value, ...receiptItem }) {
+    if (!value || typeof value !== 'string') {
+        return undefined;
+    }
+    return {
+        ...receiptItem,
+        value,
+    };
+}
+//# sourceMappingURL=receipt-items.js.map

package/dist/apps/services/payment-providers/receipt-items.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"receipt-items.js","sourceRoot":"","sources":["../../../../src/apps/services/payment-providers/receipt-items.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAA;AAG3C,MAAM,UAAU,mBAAmB,CACjC,YAAmD;IAEnD,OAAO,YAAY,CAAC,MAAM,CAAuB,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE;QACrE,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACxB,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC,EAAE,EAAE,CAAC,CAAA;AACR,CAAC;AAED,MAAM,UAAU,+BAA+B,CAC7C,YAAuC;IAEvC,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO;QACL,SAAS,EAAE,mCAAmC;QAC9C,cAAc,EAAE,uCAAuC;QACvD,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,eAAe;QACtB,KAAK,EAAE,YAAY;QACnB,oBAAoB,EAAE,IAAI;KAC3B,CAAA;AACH,CAAC;AAED,MAAM,UAAU,iCAAiC,CAC/C,cAAyC;IAEzC,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO;QACL,SAAS,EAAE,iCAAiC;QAC5C,cAAc,EAAE,qCAAqC;QACrD,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,cAAc;QACrB,oBAAoB,EAAE,KAAK;KAC5B,CAAA;AACH,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,MAAiC;IAEjC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO;QACL,SAAS,EAAE,4BAA4B;QACvC,cAAc,EAAE,gCAAgC;QAChD,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE,QAAQ;QACf,KAAK,EAAE,mBAAmB,CAAC,cAAc,CAAC,MAAM,CAAC;QACjD,oBAAoB,EAAE,KAAK;KAC5B,CAAA;AACH,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,EAClC,KAAK,EACL,GAAG,WAAW,EAGf;IACC,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO;QACL,GAAG,WAAW;QACd,KAAK;KACN,CAAA;AACH,CAAC","sourcesContent":["import { localisationService } from '../..'\nimport { PaymentReceiptItem } from '../../types/payments'\n\nexport function prepareReceiptItems(\n  receiptItems: Array<PaymentReceiptItem | undefined>,\n): PaymentReceiptItem[] {\n  return receiptItems.reduce<PaymentReceiptItem[]>((memo, receiptItem) => {\n    if (receiptItem) {\n      memo.push(receiptItem)\n    }\n    return memo\n  }, [])\n}\n\nexport function generateSubmissionIdReceiptItem(\n  submissionId: string | undefined | null,\n): PaymentReceiptItem | undefined {\n  if (!submissionId) {\n    return undefined\n  }\n  return {\n    className: 'ob-payment-receipt__submission-id',\n    valueClassName: 'cypress-payment-receipt-submission-id',\n    icon: 'receipt',\n    label: 'Submission Id',\n    value: submissionId,\n    allowCopyToClipboard: true,\n  }\n}\n\nexport function generateCreditCardMaskReceiptItem(\n  creditCardMask: string | undefined | null,\n): PaymentReceiptItem | undefined {\n  if (!creditCardMask) {\n    return undefined\n  }\n  return {\n    className: 'ob-payment-receipt__card-number',\n    valueClassName: 'cypress-payment-receipt-card-number',\n    icon: 'credit_card',\n    label: 'Card Number',\n    value: creditCardMask,\n    allowCopyToClipboard: false,\n  }\n}\n\nexport function generateAmountReceiptItem(\n  amount: number | undefined | null,\n): PaymentReceiptItem | undefined {\n  if (typeof amount !== 'number') {\n    return undefined\n  }\n  return {\n    className: 'ob-payment-receipt__amount',\n    valueClassName: 'cypress-payment-receipt-amount',\n    icon: 'attach_money',\n    label: 'Amount',\n    value: localisationService.formatCurrency(amount),\n    allowCopyToClipboard: false,\n  }\n}\n\nexport function generateReceiptItem({\n  value,\n  ...receiptItem\n}: Omit<PaymentReceiptItem, 'value'> & {\n  value: unknown\n}): PaymentReceiptItem | undefined {\n  if (!value || typeof value !== 'string') {\n    return undefined\n  }\n  return {\n    ...receiptItem,\n    value,\n  }\n}\n"]}

package/dist/apps/services/pending-queue.d.ts

@@ -0,0 +1,150 @@
+import { FormSubmission, PendingFormSubmission, ProgressListener, ProgressListenerEvent } from '../types/submissions';
+export type PendingQueueAction = 'SUBMIT_STARTED' | 'SUBMIT_FAILED' | 'SUBMIT_SUCCEEDED' | 'ADDITION' | 'DELETION' | 'EDIT_STARTED' | 'EDIT_CANCELLED';
+export type PendingQueueListener = (results: PendingFormSubmission[], action: PendingQueueAction) => unknown;
+/**
+ * Register a listener function that will be passed an array of
+ * PendingFormSubmissions when the pending queue is modified.
+ *
+ * ### Example
+ *
+ * ```js
+ * const listener = async (pendingSubmissions) => {
+ *   // use pending submissions here...
+ * }
+ * const deregister =
+ *   await submissionService.registerPendingQueueListener(listener)
+ *
+ * // When no longer needed, remember to deregister the listener
+ * deregister()
+ * ```
+ *
+ * @param listener
+ * @returns
+ */
+export declare function registerPendingQueueListener(listener: PendingQueueListener): () => void;
+export declare function addFormSubmissionToPendingQueue(formSubmission: FormSubmission): Promise<void>;
+export declare function updatePendingQueueSubmission(pendingTimestamp: string, newSubmission: PendingFormSubmission, action: 'SUBMIT_FAILED' | 'SUBMIT_STARTED' | 'EDIT_STARTED' | 'EDIT_CANCELLED', skipSentry?: boolean): Promise<void>;
+/**
+ * Cancel editing a PendingFormSubmission based on the `pendingTimestamp`
+ * property. The function marks the submission as ready for processing by the
+ * pending queue
+ *
+ * ### Example
+ *
+ * ```js
+ * const pendingTimestamp = '2020-07-29T01:03:26.573Z'
+ *
+ * await submissionService.cancelEditingPendingQueueSubmission(
+ *   pendingTimestamp,
+ * )
+ * ```
+ *
+ * @param pendingTimestamp
+ */
+export declare function cancelEditingPendingQueueSubmission(pendingTimestamp: string): Promise<void>;
+/**
+ * Get an array of PendingFormSubmission
+ *
+ * ### Example
+ *
+ * ```js
+ * const pendingSubmission =
+ *   await submissionService.getPendingQueueSubmissions()
+ * // Display pending submissions to user...
+ * ```
+ *
+ * @returns
+ */
+export declare function getPendingQueueSubmissions(): Promise<PendingFormSubmission[]>;
+/**
+ * Delete a PendingFormSubmission before it is processed based on the
+ * `pendingTimestamp` property.
+ *
+ * ### Example
+ *
+ * ```js
+ * const pendingTimestamp = '2020-07-29T01:03:26.573Z'
+ * await submissionService.deletePendingQueueSubmission(pendingTimestamp)
+ * ```
+ *
+ * @param pendingTimestamp
+ */
+export declare function deletePendingQueueSubmission(pendingTimestamp: string): Promise<void>;
+/**
+ * Edit a PendingFormSubmission before it is processed based on the
+ * `pendingTimestamp` property. The function places the submission in an editing
+ * state preventing it from being processed by the pending queue and returns a
+ * prefill id and form id
+ *
+ * ### Example
+ *
+ * ```js
+ * const pendingTimestamp = '2020-07-29T01:03:26.573Z'
+ * const { preFillFormDataId, formId } =
+ *   await submissionService.editPendingQueueSubmission(pendingTimestamp)
+ * window.location.href = `https://mycoolforms.apps.oneblink.io/forms/${formId}?preFillFormDataId=${preFillFormDataId}`
+ * ```
+ *
+ * @param pendingTimestamp
+ */
+export declare function editPendingQueueSubmission(pendingTimestamp: string): Promise<{
+    preFillFormDataId: string;
+    formId: number;
+}>;
+export declare function removePendingQueueSubmission(pendingTimestamp: string, action: 'SUBMIT_SUCCEEDED' | 'DELETION'): Promise<void>;
+/**
+ * Register a listener function that will be passed a progress event when an
+ * attachment for an item in the pending queue is being processed.
+ *
+ * ### Example
+ *
+ * ```js
+ * const listener = async ({ progress }) => {
+ *   // update the UI to reflect the progress here...
+ * }
+ * const deregister =
+ *   await submissionService.registerPendingQueueAttachmentProgressListener(
+ *     attachment.id,
+ *     listener,
+ *   )
+ *
+ * // When no longer needed, remember to deregister the listener
+ * deregister()
+ * ```
+ *
+ * @param attachmentId
+ * @param listener
+ * @returns
+ */
+export declare function registerPendingQueueAttachmentProgressListener(attachmentId: string, listener: ProgressListener): () => void;
+export declare function executePendingQueueAttachmentProgressListeners(event: ProgressListenerEvent & {
+    attachmentId: string;
+}): void;
+/**
+ * Register a listener function that will be passed a progress event when an
+ * item in the pending queue is being processed.
+ *
+ * ### Example
+ *
+ * ```js
+ * const listener = async ({ progress }) => {
+ *   // update the UI to reflect the progress here...
+ * }
+ * const deregister =
+ *   await submissionService.registerPendingQueueProgressListener(
+ *     pendingQueueItem.pendingTimestamp,
+ *     listener,
+ *   )
+ *
+ * // When no longer needed, remember to deregister the listener
+ * deregister()
+ * ```
+ *
+ * @param pendingTimestamp
+ * @param listener
+ * @returns
+ */
+export declare function registerPendingQueueProgressListener(pendingTimestamp: string, listener: ProgressListener): () => void;
+export declare function executePendingQueueProgressListeners(event: ProgressListenerEvent & {
+    pendingTimestamp: string;
+}): void;