@oneblink/apps-react 9.0.0-beta.2 → 9.0.0-beta.3

package/dist/apps/payment-service.js

@@ -0,0 +1,182 @@
+import { paymentService } from '@oneblink/sdk-core';
+import OneBlinkAppsError from './services/errors/oneBlinkAppsError';
+import { generatePaymentConfiguration } from './services/api/payment';
+import utilsService from './services/utils';
+import BPOINTPaymentProvider from './services/payment-providers/BPOINTPaymentProvider';
+import CPPayPaymentProvider from './services/payment-providers/CPPayPaymentProvider';
+import NSWGovPayPaymentProvider from './services/payment-providers/NSWGovPayPaymentProvider';
+import WestpacQuickStreamPaymentProvider, * as westpacQuickStream from './services/payment-providers/WestpacQuickStreamPaymentProvider';
+import { replaceSubmissionFormatters } from './localisation-service';
+import { getSchedulingBooking, removeSchedulingBooking, } from './services/schedulingHandlers';
+const KEY = 'PAYMENT_SUBMISSION_RESULT';
+export { westpacQuickStream };
+function getPaymentProvider(formSubmissionResult, paymentSubmissionEvent) {
+    switch (paymentSubmissionEvent.type) {
+        case 'BPOINT': {
+            return new BPOINTPaymentProvider(paymentSubmissionEvent, formSubmissionResult);
+        }
+        case 'CP_PAY': {
+            return new CPPayPaymentProvider(paymentSubmissionEvent, formSubmissionResult);
+        }
+        case 'NSW_GOV_PAY': {
+            return new NSWGovPayPaymentProvider(paymentSubmissionEvent, formSubmissionResult);
+        }
+        case 'WESTPAC_QUICK_STREAM': {
+            return new WestpacQuickStreamPaymentProvider(paymentSubmissionEvent, formSubmissionResult);
+        }
+    }
+}
+/**
+ * Pass in query string parameters after a redirect back to your app after a
+ * payment is processed. This function will handle all payment submission events
+ * supported by OneBlink. Will return a Transaction and the submission result
+ * that was returned from `handlePaymentSubmissionEvent()` before redirecting to
+ * `payment.hostedFormUrl`.
+ *
+ * #### Example
+ *
+ * ```js
+ * import queryString from 'query-string'
+ *
+ * const query = queryString.parse(window.location.search)
+ * const { transaction, submissionResult } =
+ *   await paymentService.handlePaymentQuerystring(query)
+ * ```
+ *
+ * @param query
+ * @returns
+ */
+export async function handlePaymentQuerystring(query) {
+    const submissionResult = await utilsService.getLocalForageItem(KEY);
+    // If the current transaction does not match the submission
+    // we will display message to user indicating
+    // they are looking for the wrong transaction receipt.
+    if (!submissionResult) {
+        throw new OneBlinkAppsError('It looks like you are attempting to view a receipt for an unknown payment.');
+    }
+    if (!submissionResult.payment || !submissionResult.payment.submissionEvent) {
+        throw new OneBlinkAppsError('It looks like you are attempting to view a receipt for a misconfigured payment.');
+    }
+    const paymentProvider = getPaymentProvider(submissionResult, submissionResult.payment.submissionEvent);
+    if (!paymentProvider) {
+        throw new OneBlinkAppsError('It looks like you are attempting to view a receipt for an unsupported payment.');
+    }
+    const verifiedPaymentTransaction = await paymentProvider.verifyPaymentTransaction(query);
+    const schedulingBooking = await getSchedulingBooking(verifiedPaymentTransaction.submissionResult.submissionId);
+    if (schedulingBooking && verifiedPaymentTransaction.transaction.isSuccess) {
+        await removeSchedulingBooking(schedulingBooking.submissionId);
+    }
+    return {
+        ...verifiedPaymentTransaction,
+        schedulingBooking,
+    };
+}
+export function checkForPaymentSubmissionEvent(formSubmission) {
+    const result = paymentService.checkForPaymentEvent(formSubmission.definition, formSubmission.submission);
+    if (result) {
+        console.log('Form has a payment submission event with amount', result);
+    }
+    return result;
+}
+/**
+ * Handle a submission result with a payment submission event. Will throw an
+ * error if a transaction has already been made using this submission result.
+ * Will return `undefined` if the submission does not have an amount. Will
+ * return the submission result passed in with a `payment` property if the
+ * submission requires processing.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formSubmissionResult = {
+ *   submissionId: '89c6e98e-f56f-45fc-84fe-c4fc62331d34',
+ *   submissionTimestamp: '2020-07-29T01:03:26.573Z'
+ *   formsAppId: 1,
+ *   submission: {
+ *     form: 'data',
+ *     goes: 'here',
+ *     amount: 1.50,
+ *   }
+ *   definition: OneBlinkForm,
+ *   payment: null,
+ * }
+ * const paymentSubmissionEvent = {
+ *   type: 'CP_PAY',
+ *   configuration: {
+ *     elementId: '12663efc-4c6a-4e72-8505-559edfe3e92e',
+ *     gatewayId: '6658c5c4-e0db-483b-8af7-6a6464fe772c',
+ *   },
+ * }
+ * const paymentReceiptUrl = `${window.location.origin}/payment-receipt`
+ * const paymentSubmissionResult = await paymentService.handlePaymentSubmissionEvent({
+ *   formSubmissionResult,
+ *   paymentSubmissionEvent,
+ *   paymentReceiptUrl,
+ * })
+ * if (paymentSubmissionResult) {
+ *   window.location.href = paymentSubmissionResult.payment.hostedFormUrl
+ * }
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+export async function handlePaymentSubmissionEvent({ amount, formSubmissionResult, paymentSubmissionEvent, paymentReceiptUrl, paymentFormUrl, }) {
+    const paymentProvider = getPaymentProvider(formSubmissionResult, paymentSubmissionEvent);
+    if (!paymentProvider) {
+        throw new OneBlinkAppsError('It looks like you are attempting to make a payment using an unsupported payment method.');
+    }
+    const paymentConfiguration = await generatePaymentConfiguration(paymentProvider, {
+        amount,
+        redirectUrl: paymentReceiptUrl,
+        submissionId: formSubmissionResult.submissionId,
+        paymentFormUrl,
+    });
+    const payment = {
+        submissionEvent: paymentSubmissionEvent,
+        paymentReceiptUrl,
+        hostedFormUrl: paymentConfiguration.hostedFormUrl,
+        paymentFormUrl,
+        amount,
+    };
+    console.log('Created Payment configuration to start transaction', payment);
+    await utilsService.setLocalForageItem(KEY, {
+        ...formSubmissionResult,
+        scheduling: null,
+        payment,
+    });
+    return payment;
+}
+export async function getFormSubmissionResultPayment() {
+    var _a, _b;
+    const formSubmissionResult = await utilsService.getLocalForageItem(KEY);
+    if (!formSubmissionResult) {
+        throw new OneBlinkAppsError('It looks like you are attempting to complete a transaction for an unknown payment.');
+    }
+    if (!((_a = formSubmissionResult.payment) === null || _a === void 0 ? void 0 : _a.submissionEvent)) {
+        throw new OneBlinkAppsError('It looks like you are attempting to complete a transaction for a misconfigured payment.');
+    }
+    return {
+        formSubmissionResult,
+        paymentSubmissionEvent: (_b = formSubmissionResult.payment) === null || _b === void 0 ? void 0 : _b.submissionEvent,
+    };
+}
+/**
+ * Retrieve an array of detail items from a form submission payment.
+ *
+ * #### Example
+ *
+ * ```js
+ * const detailItems =
+ *   paymentService.getDisplayDetailsFromFormSubmissionPayment(
+ *     formSubmissionPayment,
+ *   )
+ * ```
+ *
+ * @param formSubmissionPayment
+ * @returns
+ */
+export function getDisplayDetailsFromFormSubmissionPayment(formSubmissionPayment) {
+    return paymentService.getDisplayDetailsFromFormSubmissionPayment(formSubmissionPayment, replaceSubmissionFormatters);
+}
+//# sourceMappingURL=payment-service.js.map

package/dist/apps/payment-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment-service.js","sourceRoot":"","sources":["../../src/apps/payment-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,iBAAiB,MAAM,qCAAqC,CAAA;AACnE,OAAO,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAA;AACrE,OAAO,YAAY,MAAM,kBAAkB,CAAA;AAQ3C,OAAO,qBAAqB,MAAM,oDAAoD,CAAA;AACtF,OAAO,oBAAoB,MAAM,mDAAmD,CAAA;AACpF,OAAO,wBAAwB,MAAM,uDAAuD,CAAA;AAC5F,OAAO,iCAAiC,EAAE,KAAK,kBAAkB,MAAM,gEAAgE,CAAA;AACvI,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAA;AACpE,OAAO,EACL,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,+BAA+B,CAAA;AAEtC,MAAM,GAAG,GAAG,2BAA2B,CAAA;AAEvC,OAAO,EAA2C,kBAAkB,EAAE,CAAA;AAEtE,SAAS,kBAAkB,CACzB,oBAA0C,EAC1C,sBAA6D;IAE7D,QAAQ,sBAAsB,CAAC,IAAI,EAAE,CAAC;QACpC,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,IAAI,qBAAqB,CAC9B,sBAAsB,EACtB,oBAAoB,CACrB,CAAA;QACH,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,IAAI,oBAAoB,CAC7B,sBAAsB,EACtB,oBAAoB,CACrB,CAAA;QACH,CAAC;QACD,KAAK,aAAa,CAAC,CAAC,CAAC;YACnB,OAAO,IAAI,wBAAwB,CACjC,sBAAsB,EACtB,oBAAoB,CACrB,CAAA;QACH,CAAC;QACD,KAAK,sBAAsB,CAAC,CAAC,CAAC;YAC5B,OAAO,IAAI,iCAAiC,CAC1C,sBAAsB,EACtB,oBAAoB,CACrB,CAAA;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,KAA8B;IAE9B,MAAM,gBAAgB,GACpB,MAAM,YAAY,CAAC,kBAAkB,CAA8B,GAAG,CAAC,CAAA;IACzE,2DAA2D;IAC3D,6CAA6C;IAC7C,sDAAsD;IACtD,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,iBAAiB,CACzB,4EAA4E,CAC7E,CAAA;IACH,CAAC;IACD,IAAI,CAAC,gBAAgB,CAAC,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;QAC3E,MAAM,IAAI,iBAAiB,CACzB,iFAAiF,CAClF,CAAA;IACH,CAAC;IACD,MAAM,eAAe,GAAG,kBAAkB,CACxC,gBAAgB,EAChB,gBAAgB,CAAC,OAAO,CAAC,eAAe,CACzC,CAAA;IACD,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,iBAAiB,CACzB,gFAAgF,CACjF,CAAA;IACH,CAAC;IAED,MAAM,0BAA0B,GAC9B,MAAM,eAAe,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAA;IAEvD,MAAM,iBAAiB,GAAG,MAAM,oBAAoB,CAClD,0BAA0B,CAAC,gBAAgB,CAAC,YAAY,CACzD,CAAA;IACD,IAAI,iBAAiB,IAAI,0BAA0B,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;QAC1E,MAAM,uBAAuB,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAA;IAC/D,CAAC;IAED,OAAO;QACL,GAAG,0BAA0B;QAC7B,iBAAiB;KAClB,CAAA;AACH,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,cAA8B;IAM3E,MAAM,MAAM,GAAG,cAAc,CAAC,oBAAoB,CAChD,cAAc,CAAC,UAAU,EACzB,cAAc,CAAC,UAAU,CAC1B,CAAA;IACD,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,CAAC,GAAG,CAAC,iDAAiD,EAAE,MAAM,CAAC,CAAA;IACxE,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAAC,EACjD,MAAM,EACN,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,cAAc,GAOf;IACC,MAAM,eAAe,GAAG,kBAAkB,CACxC,oBAAoB,EACpB,sBAAsB,CACvB,CAAA;IACD,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,iBAAiB,CACzB,yFAAyF,CAC1F,CAAA;IACH,CAAC;IAED,MAAM,oBAAoB,GAAG,MAAM,4BAA4B,CAC7D,eAAe,EACf;QACE,MAAM;QACN,WAAW,EAAE,iBAAiB;QAC9B,YAAY,EAAE,oBAAoB,CAAC,YAAY;QAC/C,cAAc;KACf,CACF,CAAA;IAED,MAAM,OAAO,GAAG;QACd,eAAe,EAAE,sBAAsB;QACvC,iBAAiB;QACjB,aAAa,EAAE,oBAAoB,CAAC,aAAa;QACjD,cAAc;QACd,MAAM;KACP,CAAA;IACD,OAAO,CAAC,GAAG,CAAC,oDAAoD,EAAE,OAAO,CAAC,CAAA;IAE1E,MAAM,YAAY,CAAC,kBAAkB,CAAC,GAAG,EAAE;QACzC,GAAG,oBAAoB;QACvB,UAAU,EAAE,IAAI;QAChB,OAAO;KACR,CAAC,CAAA;IAEF,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,8BAA8B;;IAIlD,MAAM,oBAAoB,GACxB,MAAM,YAAY,CAAC,kBAAkB,CAA8B,GAAG,CAAC,CAAA;IAEzE,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC1B,MAAM,IAAI,iBAAiB,CACzB,oFAAoF,CACrF,CAAA;IACH,CAAC;IACD,IAAI,CAAC,CAAA,MAAA,oBAAoB,CAAC,OAAO,0CAAE,eAAe,CAAA,EAAE,CAAC;QACnD,MAAM,IAAI,iBAAiB,CACzB,yFAAyF,CAC1F,CAAA;IACH,CAAC;IAED,OAAO;QACL,oBAAoB;QACpB,sBAAsB,EAAE,MAAA,oBAAoB,CAAC,OAAO,0CAAE,eAAe;KACtE,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,0CAA0C,CACxD,qBAA4D;IAE5D,OAAO,cAAc,CAAC,0CAA0C,CAC9D,qBAAqB,EACrB,2BAA2B,CAC5B,CAAA;AACH,CAAC","sourcesContent":["import { paymentService } from '@oneblink/sdk-core'\nimport OneBlinkAppsError from './services/errors/oneBlinkAppsError'\nimport { generatePaymentConfiguration } from './services/api/payment'\nimport utilsService from './services/utils'\nimport { SubmissionEventTypes, SubmissionTypes } from '@oneblink/types'\nimport { FormSubmission, FormSubmissionResult } from './types/submissions'\nimport {\n  HandlePaymentResult,\n  PaymentProvider,\n  PaymentReceiptItem,\n} from './types/payments'\nimport BPOINTPaymentProvider from './services/payment-providers/BPOINTPaymentProvider'\nimport CPPayPaymentProvider from './services/payment-providers/CPPayPaymentProvider'\nimport NSWGovPayPaymentProvider from './services/payment-providers/NSWGovPayPaymentProvider'\nimport WestpacQuickStreamPaymentProvider, * as westpacQuickStream from './services/payment-providers/WestpacQuickStreamPaymentProvider'\nimport { replaceSubmissionFormatters } from './localisation-service'\nimport {\n  getSchedulingBooking,\n  removeSchedulingBooking,\n} from './services/schedulingHandlers'\n\nconst KEY = 'PAYMENT_SUBMISSION_RESULT'\n\nexport { HandlePaymentResult, PaymentReceiptItem, westpacQuickStream }\n\nfunction getPaymentProvider(\n  formSubmissionResult: FormSubmissionResult,\n  paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent,\n): PaymentProvider<SubmissionEventTypes.FormPaymentEvent> {\n  switch (paymentSubmissionEvent.type) {\n    case 'BPOINT': {\n      return new BPOINTPaymentProvider(\n        paymentSubmissionEvent,\n        formSubmissionResult,\n      )\n    }\n    case 'CP_PAY': {\n      return new CPPayPaymentProvider(\n        paymentSubmissionEvent,\n        formSubmissionResult,\n      )\n    }\n    case 'NSW_GOV_PAY': {\n      return new NSWGovPayPaymentProvider(\n        paymentSubmissionEvent,\n        formSubmissionResult,\n      )\n    }\n    case 'WESTPAC_QUICK_STREAM': {\n      return new WestpacQuickStreamPaymentProvider(\n        paymentSubmissionEvent,\n        formSubmissionResult,\n      )\n    }\n  }\n}\n\n/**\n * Pass in query string parameters after a redirect back to your app after a\n * payment is processed. This function will handle all payment submission events\n * supported by OneBlink. Will return a Transaction and the submission result\n * that was returned from `handlePaymentSubmissionEvent()` before redirecting to\n * `payment.hostedFormUrl`.\n *\n * #### Example\n *\n * ```js\n * import queryString from 'query-string'\n *\n * const query = queryString.parse(window.location.search)\n * const { transaction, submissionResult } =\n *   await paymentService.handlePaymentQuerystring(query)\n * ```\n *\n * @param query\n * @returns\n */\nexport async function handlePaymentQuerystring(\n  query: Record<string, unknown>,\n): Promise<HandlePaymentResult> {\n  const submissionResult =\n    await utilsService.getLocalForageItem<FormSubmissionResult | null>(KEY)\n  // If the current transaction does not match the submission\n  // we will display message to user indicating\n  // they are looking for the wrong transaction receipt.\n  if (!submissionResult) {\n    throw new OneBlinkAppsError(\n      'It looks like you are attempting to view a receipt for an unknown payment.',\n    )\n  }\n  if (!submissionResult.payment || !submissionResult.payment.submissionEvent) {\n    throw new OneBlinkAppsError(\n      'It looks like you are attempting to view a receipt for a misconfigured payment.',\n    )\n  }\n  const paymentProvider = getPaymentProvider(\n    submissionResult,\n    submissionResult.payment.submissionEvent,\n  )\n  if (!paymentProvider) {\n    throw new OneBlinkAppsError(\n      'It looks like you are attempting to view a receipt for an unsupported payment.',\n    )\n  }\n\n  const verifiedPaymentTransaction =\n    await paymentProvider.verifyPaymentTransaction(query)\n\n  const schedulingBooking = await getSchedulingBooking(\n    verifiedPaymentTransaction.submissionResult.submissionId,\n  )\n  if (schedulingBooking && verifiedPaymentTransaction.transaction.isSuccess) {\n    await removeSchedulingBooking(schedulingBooking.submissionId)\n  }\n\n  return {\n    ...verifiedPaymentTransaction,\n    schedulingBooking,\n  }\n}\n\nexport function checkForPaymentSubmissionEvent(formSubmission: FormSubmission):\n  | {\n      paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent\n      amount: number\n    }\n  | undefined {\n  const result = paymentService.checkForPaymentEvent(\n    formSubmission.definition,\n    formSubmission.submission,\n  )\n  if (result) {\n    console.log('Form has a payment submission event with amount', result)\n  }\n  return result\n}\n\n/**\n * Handle a submission result with a payment submission event. Will throw an\n * error if a transaction has already been made using this submission result.\n * Will return `undefined` if the submission does not have an amount. Will\n * return the submission result passed in with a `payment` property if the\n * submission requires processing.\n *\n * #### Example\n *\n * ```js\n * const formSubmissionResult = {\n *   submissionId: '89c6e98e-f56f-45fc-84fe-c4fc62331d34',\n *   submissionTimestamp: '2020-07-29T01:03:26.573Z'\n *   formsAppId: 1,\n *   submission: {\n *     form: 'data',\n *     goes: 'here',\n *     amount: 1.50,\n *   }\n *   definition: OneBlinkForm,\n *   payment: null,\n * }\n * const paymentSubmissionEvent = {\n *   type: 'CP_PAY',\n *   configuration: {\n *     elementId: '12663efc-4c6a-4e72-8505-559edfe3e92e',\n *     gatewayId: '6658c5c4-e0db-483b-8af7-6a6464fe772c',\n *   },\n * }\n * const paymentReceiptUrl = `${window.location.origin}/payment-receipt`\n * const paymentSubmissionResult = await paymentService.handlePaymentSubmissionEvent({\n *   formSubmissionResult,\n *   paymentSubmissionEvent,\n *   paymentReceiptUrl,\n * })\n * if (paymentSubmissionResult) {\n *   window.location.href = paymentSubmissionResult.payment.hostedFormUrl\n * }\n * ```\n *\n * @param options\n * @returns\n */\nexport async function handlePaymentSubmissionEvent({\n  amount,\n  formSubmissionResult,\n  paymentSubmissionEvent,\n  paymentReceiptUrl,\n  paymentFormUrl,\n}: {\n  amount: number\n  formSubmissionResult: FormSubmissionResult\n  paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent\n  paymentReceiptUrl: string\n  paymentFormUrl: string | undefined\n}): Promise<FormSubmissionResult['payment']> {\n  const paymentProvider = getPaymentProvider(\n    formSubmissionResult,\n    paymentSubmissionEvent,\n  )\n  if (!paymentProvider) {\n    throw new OneBlinkAppsError(\n      'It looks like you are attempting to make a payment using an unsupported payment method.',\n    )\n  }\n\n  const paymentConfiguration = await generatePaymentConfiguration(\n    paymentProvider,\n    {\n      amount,\n      redirectUrl: paymentReceiptUrl,\n      submissionId: formSubmissionResult.submissionId,\n      paymentFormUrl,\n    },\n  )\n\n  const payment = {\n    submissionEvent: paymentSubmissionEvent,\n    paymentReceiptUrl,\n    hostedFormUrl: paymentConfiguration.hostedFormUrl,\n    paymentFormUrl,\n    amount,\n  }\n  console.log('Created Payment configuration to start transaction', payment)\n\n  await utilsService.setLocalForageItem(KEY, {\n    ...formSubmissionResult,\n    scheduling: null,\n    payment,\n  })\n\n  return payment\n}\n\nexport async function getFormSubmissionResultPayment(): Promise<{\n  formSubmissionResult: FormSubmissionResult\n  paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent\n}> {\n  const formSubmissionResult =\n    await utilsService.getLocalForageItem<FormSubmissionResult | null>(KEY)\n\n  if (!formSubmissionResult) {\n    throw new OneBlinkAppsError(\n      'It looks like you are attempting to complete a transaction for an unknown payment.',\n    )\n  }\n  if (!formSubmissionResult.payment?.submissionEvent) {\n    throw new OneBlinkAppsError(\n      'It looks like you are attempting to complete a transaction for a misconfigured payment.',\n    )\n  }\n\n  return {\n    formSubmissionResult,\n    paymentSubmissionEvent: formSubmissionResult.payment?.submissionEvent,\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 * ```\n *\n * @param formSubmissionPayment\n * @returns\n */\nexport function getDisplayDetailsFromFormSubmissionPayment(\n  formSubmissionPayment: SubmissionTypes.FormSubmissionPayment,\n) {\n  return paymentService.getDisplayDetailsFromFormSubmissionPayment(\n    formSubmissionPayment,\n    replaceSubmissionFormatters,\n  )\n}\n"]}

package/dist/apps/prefill-service.d.ts

@@ -0,0 +1,14 @@
+import { getPrefillFormData } from './services/job-prefill';
+/**
+ * Remove prefill data form the local store.
+ *
+ * ```js
+ * const prefillFormDataId = '24faee0a-dca1-4c88-9100-9da2aae8e0ac'
+ * await prefillService.removePrefillFormData(prefillFormDataId)
+ * ```
+ *
+ * @param prefillFormDataId
+ * @returns
+ */
+export declare function removePrefillFormData(prefillFormDataId: string): Promise<void>;
+export { getPrefillFormData };

package/dist/apps/prefill-service.js

@@ -0,0 +1,19 @@
+import utilsService from './services/utils';
+import { getPrefillKey, getPrefillFormData } from './services/job-prefill';
+/**
+ * Remove prefill data form the local store.
+ *
+ * ```js
+ * const prefillFormDataId = '24faee0a-dca1-4c88-9100-9da2aae8e0ac'
+ * await prefillService.removePrefillFormData(prefillFormDataId)
+ * ```
+ *
+ * @param prefillFormDataId
+ * @returns
+ */
+export async function removePrefillFormData(prefillFormDataId) {
+    const key = getPrefillKey(prefillFormDataId);
+    return utilsService.removeLocalForageItem(key);
+}
+export { getPrefillFormData };
+//# sourceMappingURL=prefill-service.js.map

package/dist/apps/prefill-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefill-service.js","sourceRoot":"","sources":["../../src/apps/prefill-service.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAE1E;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,iBAAyB;IAEzB,MAAM,GAAG,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAA;IAC5C,OAAO,YAAY,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAA;AAChD,CAAC;AAED,OAAO,EAAE,kBAAkB,EAAE,CAAA","sourcesContent":["import utilsService from './services/utils'\nimport { getPrefillKey, getPrefillFormData } from './services/job-prefill'\n\n/**\n * Remove prefill data form the local store.\n *\n * ```js\n * const prefillFormDataId = '24faee0a-dca1-4c88-9100-9da2aae8e0ac'\n * await prefillService.removePrefillFormData(prefillFormDataId)\n * ```\n *\n * @param prefillFormDataId\n * @returns\n */\nexport async function removePrefillFormData(\n  prefillFormDataId: string,\n): Promise<void> {\n  const key = getPrefillKey(prefillFormDataId)\n  return utilsService.removeLocalForageItem(key)\n}\n\nexport { getPrefillFormData }\n"]}

package/dist/apps/scheduled-tasks-service.d.ts

@@ -0,0 +1,127 @@
+import { ScheduledTasksTypes } from '@oneblink/types';
+export interface TaskAvailability {
+    task: ScheduledTasksTypes.Task;
+    completedTask?: ScheduledTasksTypes.CompletedTask;
+    daysAvailable: number;
+}
+export interface TaskResponse extends TaskAvailability {
+    actions: ScheduledTasksTypes.TaskAction[];
+}
+/**
+ * Obtain all of the related Tasks for a specific Forms App
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const date = '2023-12-01'
+ * const tasks = await getTasksForFormsApp({ formsAppId, date })
+ * ```
+ *
+ * @param formsAppId
+ * @param abortSignal
+ * @returns
+ */
+export declare function getTasksForFormsApp({ formsAppId, date, abortSignal, }: {
+    formsAppId: number;
+    date: string;
+    abortSignal?: AbortSignal;
+}): Promise<{
+    taskResponses: TaskResponse[];
+}>;
+/**
+ * Obtain all of the tasks related to a Task Group Instances in a specific Forms
+ * App
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const taskGroupInstanceId = 'abc123'
+ * const date = '2023-12-01'
+ * const tasks = await getTaskGroupInstanceTasks({
+ *   formsAppId,
+ *   taskGroupInstanceId,
+ *   date,
+ * })
+ * ```
+ *
+ * @param formsAppId
+ * @param taskGroupInstanceId
+ * @param abortSignal
+ * @returns
+ */
+export declare function getTaskGroupInstanceTasks({ taskGroupInstanceId, date, formsAppId, abortSignal, }: {
+    taskGroupInstanceId: string;
+    date: string;
+    formsAppId: number;
+    abortSignal?: AbortSignal;
+}): Promise<{
+    taskResponses: TaskResponse[];
+    taskGroup: ScheduledTasksTypes.TaskGroup;
+    taskGroupInstance: ScheduledTasksTypes.TaskGroupInstance;
+}>;
+/**
+ * Obtain all of the Task Group instances for a specific Forms App
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const taskGroupInstances = await getTaskGroupInstances(formsAppId)
+ * ```
+ *
+ * @param formsAppId
+ * @param abortSignal
+ * @returns
+ */
+export declare function getTaskGroupInstances(formsAppId: number, abortSignal?: AbortSignal): Promise<{
+    taskGroupInstances: Array<ScheduledTasksTypes.TaskGroupInstance & {
+        taskAvailabilities: TaskAvailability[];
+        taskGroup: ScheduledTasksTypes.TaskGroup;
+    }>;
+}>;
+/**
+ * Complete the related Task for a specific Forms App
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const taskId = 2
+ * const completedTask = await scheduledTasksService.completeTask({
+ *   formsAppId,
+ *   taskId,
+ * })
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+export declare function completeTask({ formsAppId, taskId, taskActionId, taskGroupInstanceId, abortSignal, }: {
+    formsAppId: number;
+    taskId: string;
+    taskActionId: string;
+    taskGroupInstanceId: string | undefined;
+    abortSignal?: AbortSignal;
+}): Promise<ScheduledTasksTypes.CompletedTask>;
+/**
+ * Delete the completed task record related to a Task for a specific Forms App
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const taskId = 2
+ * const completedTask = await scheduledTasksService.completeTask({
+ *   formsAppId,
+ *   taskId,
+ * })
+ * await deleteCompletedTask(completedTask.id)
+ * ```
+ *
+ * @param id
+ * @param abortSignal
+ * @returns
+ */
+export declare function deleteCompletedTask(id: string, abortSignal?: AbortSignal): Promise<void>;

package/dist/apps/scheduled-tasks-service.js

@@ -0,0 +1,240 @@
+import tenants from './tenants';
+import Sentry from './Sentry';
+import { deleteRequest, getRequest, postRequest, } from './services/fetch';
+import { isOffline } from './offline-service';
+import OneBlinkAppsError from './services/errors/oneBlinkAppsError';
+async function getTasks(url, abortSignal) {
+    try {
+        return await getRequest(url, abortSignal);
+    }
+    catch (err) {
+        Sentry.captureException(err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline and do not have a local version of these scheduled tasks, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError('We could not find the forms app you are looking for. Please contact support if the problem persists.', {
+                    originalError: error,
+                    title: 'Unknown Forms App',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * Obtain all of the related Tasks for a specific Forms App
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const date = '2023-12-01'
+ * const tasks = await getTasksForFormsApp({ formsAppId, date })
+ * ```
+ *
+ * @param formsAppId
+ * @param abortSignal
+ * @returns
+ */
+export async function getTasksForFormsApp({ formsAppId, date, abortSignal, }) {
+    const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/scheduled-tasks?date=${date}`;
+    return await getTasks(url, abortSignal);
+}
+/**
+ * Obtain all of the tasks related to a Task Group Instances in a specific Forms
+ * App
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const taskGroupInstanceId = 'abc123'
+ * const date = '2023-12-01'
+ * const tasks = await getTaskGroupInstanceTasks({
+ *   formsAppId,
+ *   taskGroupInstanceId,
+ *   date,
+ * })
+ * ```
+ *
+ * @param formsAppId
+ * @param taskGroupInstanceId
+ * @param abortSignal
+ * @returns
+ */
+export async function getTaskGroupInstanceTasks({ taskGroupInstanceId, date, formsAppId, abortSignal, }) {
+    const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/scheduled-task-group-instances/${taskGroupInstanceId}?date=${date}`;
+    return await getTasks(url, abortSignal);
+}
+/**
+ * Obtain all of the Task Group instances for a specific Forms App
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const taskGroupInstances = await getTaskGroupInstances(formsAppId)
+ * ```
+ *
+ * @param formsAppId
+ * @param abortSignal
+ * @returns
+ */
+export async function getTaskGroupInstances(formsAppId, abortSignal) {
+    const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/scheduled-task-group-instances`;
+    try {
+        return await getRequest(url, abortSignal);
+    }
+    catch (err) {
+        Sentry.captureException(err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline and do not have a local version of these scheduled task groups, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError('We could not find the forms app you are looking for. Please contact support if the problem persists.', {
+                    originalError: error,
+                    title: 'Unknown Forms App',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * Complete the related Task for a specific Forms App
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const taskId = 2
+ * const completedTask = await scheduledTasksService.completeTask({
+ *   formsAppId,
+ *   taskId,
+ * })
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+export async function completeTask({ formsAppId, taskId, taskActionId, taskGroupInstanceId, abortSignal, }) {
+    const url = `${tenants.current.apiOrigin}/completed-tasks`;
+    try {
+        return await postRequest(url, { formsAppId, taskId, taskActionId, taskGroupInstanceId }, abortSignal);
+    }
+    catch (err) {
+        Sentry.captureException(err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to complete this task. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * Delete the completed task record related to a Task for a specific Forms App
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const taskId = 2
+ * const completedTask = await scheduledTasksService.completeTask({
+ *   formsAppId,
+ *   taskId,
+ * })
+ * await deleteCompletedTask(completedTask.id)
+ * ```
+ *
+ * @param id
+ * @param abortSignal
+ * @returns
+ */
+export async function deleteCompletedTask(id, abortSignal) {
+    const url = `${tenants.current.apiOrigin}/completed-tasks/${id}`;
+    try {
+        await deleteRequest(url, abortSignal);
+    }
+    catch (err) {
+        Sentry.captureException(err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to delete completed tasks. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+//# sourceMappingURL=scheduled-tasks-service.js.map

package/dist/apps/scheduled-tasks-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduled-tasks-service.js","sourceRoot":"","sources":["../../src/apps/scheduled-tasks-service.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,WAAW,CAAA;AAC/B,OAAO,MAAM,MAAM,UAAU,CAAA;AAC7B,OAAO,EAEL,aAAa,EACb,UAAU,EACV,WAAW,GACZ,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,iBAAiB,MAAM,qCAAqC,CAAA;AAYnE,KAAK,UAAU,QAAQ,CAIrB,GAAW,EAAE,WAAyB;IACtC,IAAI,CAAC;QACH,OAAO,MAAM,UAAU,CAAI,GAAG,EAAE,WAAW,CAAC,CAAA;IAC9C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAE5B,MAAM,KAAK,GAAG,GAAgB,CAAA;QAC9B,IAAI,SAAS,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,iBAAiB,CACzB,kIAAkI,EAClI;gBACE,aAAa,EAAE,KAAK;gBACpB,SAAS,EAAE,IAAI;aAChB,CACF,CAAA;QACH,CAAC;QACD,QAAQ,KAAK,CAAC,MAAM,EAAE,CAAC;YACrB,KAAK,GAAG,CAAC;YACT,KAAK,GAAG,CAAC,CAAC,CAAC;gBACT,MAAM,IAAI,iBAAiB,CACzB,sGAAsG,EACtG;oBACE,aAAa,EAAE,KAAK;oBACpB,KAAK,EAAE,mBAAmB;oBAC1B,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,IAAI,iBAAiB,CACzB,gFAAgF,EAChF;oBACE,aAAa,EAAE,KAAK;oBACpB,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,EACxC,UAAU,EACV,IAAI,EACJ,WAAW,GAKZ;IAGC,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,yBAAyB,IAAI,EAAE,CAAA;IAChG,OAAO,MAAM,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC,CAAA;AACzC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAAC,EAC9C,mBAAmB,EACnB,IAAI,EACJ,UAAU,EACV,WAAW,GAMZ;IACC,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,mCAAmC,mBAAmB,SAAS,IAAI,EAAE,CAAA;IACtI,OAAO,MAAM,QAAQ,CAIlB,GAAG,EAAE,WAAW,CAAC,CAAA;AACtB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,UAAkB,EAClB,WAAyB;IAEzB,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,iCAAiC,CAAA;IAClG,IAAI,CAAC;QACH,OAAO,MAAM,UAAU,CAOpB,GAAG,EAAE,WAAW,CAAC,CAAA;IACtB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAE5B,MAAM,KAAK,GAAG,GAAgB,CAAA;QAC9B,IAAI,SAAS,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,iBAAiB,CACzB,wIAAwI,EACxI;gBACE,aAAa,EAAE,KAAK;gBACpB,SAAS,EAAE,IAAI;aAChB,CACF,CAAA;QACH,CAAC;QACD,QAAQ,KAAK,CAAC,MAAM,EAAE,CAAC;YACrB,KAAK,GAAG,CAAC;YACT,KAAK,GAAG,CAAC,CAAC,CAAC;gBACT,MAAM,IAAI,iBAAiB,CACzB,sGAAsG,EACtG;oBACE,aAAa,EAAE,KAAK;oBACpB,KAAK,EAAE,mBAAmB;oBAC1B,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,IAAI,iBAAiB,CACzB,gFAAgF,EAChF;oBACE,aAAa,EAAE,KAAK;oBACpB,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AAEH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,EACjC,UAAU,EACV,MAAM,EACN,YAAY,EACZ,mBAAmB,EACnB,WAAW,GAOZ;IACC,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,kBAAkB,CAAA;IAC1D,IAAI,CAAC;QACH,OAAO,MAAM,WAAW,CACtB,GAAG,EACH,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,mBAAmB,EAAE,EACzD,WAAW,CACZ,CAAA;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAE5B,MAAM,KAAK,GAAG,GAAgB,CAAA;QAC9B,IAAI,SAAS,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,iBAAiB,CACzB,yEAAyE,EACzE;gBACE,aAAa,EAAE,KAAK;gBACpB,SAAS,EAAE,IAAI;aAChB,CACF,CAAA;QACH,CAAC;QACD,QAAQ,KAAK,CAAC,MAAM,EAAE,CAAC;YACrB,KAAK,GAAG,CAAC,CAAC,CAAC;gBACT,MAAM,IAAI,iBAAiB,CACzB,sHAAsH,EACtH;oBACE,aAAa,EAAE,KAAK;oBACpB,qBAAqB,EAAE,IAAI;oBAC3B,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;YACD,KAAK,GAAG,CAAC;YACT,KAAK,GAAG,CAAC,CAAC,CAAC;gBACT,MAAM,IAAI,iBAAiB,CAAC,KAAK,CAAC,OAAO,EAAE;oBACzC,KAAK,EAAE,iBAAiB;oBACxB,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CAAC,CAAA;YACJ,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,IAAI,iBAAiB,CACzB,gFAAgF,EAChF;oBACE,aAAa,EAAE,KAAK;oBACpB,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AAEH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,EAAU,EACV,WAAyB;IAEzB,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,oBAAoB,EAAE,EAAE,CAAA;IAChE,IAAI,CAAC;QACH,MAAM,aAAa,CAAC,GAAG,EAAE,WAAW,CAAC,CAAA;IACvC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAE5B,MAAM,KAAK,GAAG,GAAgB,CAAA;QAC9B,IAAI,SAAS,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,iBAAiB,CACzB,yEAAyE,EACzE;gBACE,aAAa,EAAE,KAAK;gBACpB,SAAS,EAAE,IAAI;aAChB,CACF,CAAA;QACH,CAAC;QACD,QAAQ,KAAK,CAAC,MAAM,EAAE,CAAC;YACrB,KAAK,GAAG,CAAC,CAAC,CAAC;gBACT,MAAM,IAAI,iBAAiB,CACzB,0HAA0H,EAC1H;oBACE,aAAa,EAAE,KAAK;oBACpB,qBAAqB,EAAE,IAAI;oBAC3B,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;YACD,KAAK,GAAG,CAAC;YACT,KAAK,GAAG,CAAC,CAAC,CAAC;gBACT,MAAM,IAAI,iBAAiB,CAAC,KAAK,CAAC,OAAO,EAAE;oBACzC,KAAK,EAAE,iBAAiB;oBACxB,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CAAC,CAAA;YACJ,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,IAAI,iBAAiB,CACzB,gFAAgF,EAChF;oBACE,aAAa,EAAE,KAAK;oBACpB,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC","sourcesContent":["import { ScheduledTasksTypes } from '@oneblink/types'\nimport tenants from './tenants'\nimport Sentry from './Sentry'\nimport {\n  HTTPError,\n  deleteRequest,\n  getRequest,\n  postRequest,\n} from './services/fetch'\nimport { isOffline } from './offline-service'\nimport OneBlinkAppsError from './services/errors/oneBlinkAppsError'\n\nexport interface TaskAvailability {\n  task: ScheduledTasksTypes.Task\n  completedTask?: ScheduledTasksTypes.CompletedTask\n  daysAvailable: number\n}\n\nexport interface TaskResponse extends TaskAvailability {\n  actions: ScheduledTasksTypes.TaskAction[]\n}\n\nasync function getTasks<\n  T extends {\n    taskResponses: TaskResponse[]\n  },\n>(url: string, abortSignal?: AbortSignal) {\n  try {\n    return await getRequest<T>(url, abortSignal)\n  } catch (err) {\n    Sentry.captureException(err)\n\n    const error = err as HTTPError\n    if (isOffline()) {\n      throw new OneBlinkAppsError(\n        'You are currently offline and do not have a local version of these scheduled tasks, please connect to the internet and try again',\n        {\n          originalError: error,\n          isOffline: true,\n        },\n      )\n    }\n    switch (error.status) {\n      case 400:\n      case 404: {\n        throw new OneBlinkAppsError(\n          'We could not find the forms app you are looking for. Please contact support if the problem persists.',\n          {\n            originalError: error,\n            title: 'Unknown Forms App',\n            httpStatusCode: error.status,\n          },\n        )\n      }\n      default: {\n        throw new OneBlinkAppsError(\n          'An unknown error has occurred. Please contact support if the problem persists.',\n          {\n            originalError: error,\n            httpStatusCode: error.status,\n          },\n        )\n      }\n    }\n  }\n}\n\n/**\n * Obtain all of the related Tasks for a specific Forms App\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * const date = '2023-12-01'\n * const tasks = await getTasksForFormsApp({ formsAppId, date })\n * ```\n *\n * @param formsAppId\n * @param abortSignal\n * @returns\n */\nexport async function getTasksForFormsApp({\n  formsAppId,\n  date,\n  abortSignal,\n}: {\n  formsAppId: number\n  date: string\n  abortSignal?: AbortSignal\n}): Promise<{\n  taskResponses: TaskResponse[]\n}> {\n  const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/scheduled-tasks?date=${date}`\n  return await getTasks(url, abortSignal)\n}\n\n/**\n * Obtain all of the tasks related to a Task Group Instances in a specific Forms\n * App\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * const taskGroupInstanceId = 'abc123'\n * const date = '2023-12-01'\n * const tasks = await getTaskGroupInstanceTasks({\n *   formsAppId,\n *   taskGroupInstanceId,\n *   date,\n * })\n * ```\n *\n * @param formsAppId\n * @param taskGroupInstanceId\n * @param abortSignal\n * @returns\n */\nexport async function getTaskGroupInstanceTasks({\n  taskGroupInstanceId,\n  date,\n  formsAppId,\n  abortSignal,\n}: {\n  taskGroupInstanceId: string\n  date: string\n  formsAppId: number\n  abortSignal?: AbortSignal\n}) {\n  const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/scheduled-task-group-instances/${taskGroupInstanceId}?date=${date}`\n  return await getTasks<{\n    taskResponses: TaskResponse[]\n    taskGroup: ScheduledTasksTypes.TaskGroup\n    taskGroupInstance: ScheduledTasksTypes.TaskGroupInstance\n  }>(url, abortSignal)\n}\n\n/**\n * Obtain all of the Task Group instances for a specific Forms App\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * const taskGroupInstances = await getTaskGroupInstances(formsAppId)\n * ```\n *\n * @param formsAppId\n * @param abortSignal\n * @returns\n */\nexport async function getTaskGroupInstances(\n  formsAppId: number,\n  abortSignal?: AbortSignal,\n) {\n  const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/scheduled-task-group-instances`\n  try {\n    return await getRequest<{\n      taskGroupInstances: Array<\n        ScheduledTasksTypes.TaskGroupInstance & {\n          taskAvailabilities: TaskAvailability[]\n          taskGroup: ScheduledTasksTypes.TaskGroup\n        }\n      >\n    }>(url, abortSignal)\n  } catch (err) {\n    Sentry.captureException(err)\n\n    const error = err as HTTPError\n    if (isOffline()) {\n      throw new OneBlinkAppsError(\n        'You are currently offline and do not have a local version of these scheduled task groups, please connect to the internet and try again',\n        {\n          originalError: error,\n          isOffline: true,\n        },\n      )\n    }\n    switch (error.status) {\n      case 400:\n      case 404: {\n        throw new OneBlinkAppsError(\n          'We could not find the forms app you are looking for. Please contact support if the problem persists.',\n          {\n            originalError: error,\n            title: 'Unknown Forms App',\n            httpStatusCode: error.status,\n          },\n        )\n      }\n      default: {\n        throw new OneBlinkAppsError(\n          'An unknown error has occurred. Please contact support if the problem persists.',\n          {\n            originalError: error,\n            httpStatusCode: error.status,\n          },\n        )\n      }\n    }\n  }\n}\n\n/**\n * Complete the related Task for a specific Forms App\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * const taskId = 2\n * const completedTask = await scheduledTasksService.completeTask({\n *   formsAppId,\n *   taskId,\n * })\n * ```\n *\n * @param options\n * @returns\n */\n\nexport async function completeTask({\n  formsAppId,\n  taskId,\n  taskActionId,\n  taskGroupInstanceId,\n  abortSignal,\n}: {\n  formsAppId: number\n  taskId: string\n  taskActionId: string\n  taskGroupInstanceId: string | undefined\n  abortSignal?: AbortSignal\n}): Promise<ScheduledTasksTypes.CompletedTask> {\n  const url = `${tenants.current.apiOrigin}/completed-tasks`\n  try {\n    return await postRequest<ScheduledTasksTypes.CompletedTask>(\n      url,\n      { formsAppId, taskId, taskActionId, taskGroupInstanceId },\n      abortSignal,\n    )\n  } catch (err) {\n    Sentry.captureException(err)\n\n    const error = err as HTTPError\n    if (isOffline()) {\n      throw new OneBlinkAppsError(\n        'You are currently offline, please connect to the internet and try again',\n        {\n          originalError: error,\n          isOffline: true,\n        },\n      )\n    }\n    switch (error.status) {\n      case 403: {\n        throw new OneBlinkAppsError(\n          'You do not have access to complete this task. Please contact your administrator to gain the correct level of access.',\n          {\n            originalError: error,\n            requiresAccessRequest: true,\n            httpStatusCode: error.status,\n          },\n        )\n      }\n      case 400:\n      case 404: {\n        throw new OneBlinkAppsError(error.message, {\n          title: 'Invalid Request',\n          httpStatusCode: error.status,\n        })\n      }\n      default: {\n        throw new OneBlinkAppsError(\n          'An unknown error has occurred. Please contact support if the problem persists.',\n          {\n            originalError: error,\n            httpStatusCode: error.status,\n          },\n        )\n      }\n    }\n  }\n}\n\n/**\n * Delete the completed task record related to a Task for a specific Forms App\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * const taskId = 2\n * const completedTask = await scheduledTasksService.completeTask({\n *   formsAppId,\n *   taskId,\n * })\n * await deleteCompletedTask(completedTask.id)\n * ```\n *\n * @param id\n * @param abortSignal\n * @returns\n */\n\nexport async function deleteCompletedTask(\n  id: string,\n  abortSignal?: AbortSignal,\n): Promise<void> {\n  const url = `${tenants.current.apiOrigin}/completed-tasks/${id}`\n  try {\n    await deleteRequest(url, abortSignal)\n  } catch (err) {\n    Sentry.captureException(err)\n\n    const error = err as HTTPError\n    if (isOffline()) {\n      throw new OneBlinkAppsError(\n        'You are currently offline, please connect to the internet and try again',\n        {\n          originalError: error,\n          isOffline: true,\n        },\n      )\n    }\n    switch (error.status) {\n      case 403: {\n        throw new OneBlinkAppsError(\n          'You do not have access to delete completed tasks. Please contact your administrator to gain the correct level of access.',\n          {\n            originalError: error,\n            requiresAccessRequest: true,\n            httpStatusCode: error.status,\n          },\n        )\n      }\n      case 400:\n      case 404: {\n        throw new OneBlinkAppsError(error.message, {\n          title: 'Invalid Request',\n          httpStatusCode: error.status,\n        })\n      }\n      default: {\n        throw new OneBlinkAppsError(\n          'An unknown error has occurred. Please contact support if the problem persists.',\n          {\n            originalError: error,\n            httpStatusCode: error.status,\n          },\n        )\n      }\n    }\n  }\n}\n"]}