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

package/dist/apps/services/user-token.js

@@ -0,0 +1,33 @@
+let userToken = null;
+/**
+ * Set the User token being included in requests to the OneBlink API on behalf
+ * of the user.
+ *
+ * #### Example
+ *
+ * ```js
+ * authService.setUserToken('a value')
+ * ```
+ */
+export function setUserToken(token) {
+    userToken = token || null;
+}
+/**
+ * Can be used to retrieve the `userToken` passed to `setUserToken()`. Will be
+ * `undefined` if the token has not been set yet.
+ *
+ * #### Example
+ *
+ * ```js
+ * const userToken = authService.getUserToken()
+ * if (userToken) {
+ *   // Use token here...
+ * }
+ * ```
+ *
+ * @returns
+ */
+export function getUserToken() {
+    return userToken;
+}
+//# sourceMappingURL=user-token.js.map

package/dist/apps/services/user-token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-token.js","sourceRoot":"","sources":["../../../src/apps/services/user-token.ts"],"names":[],"mappings":"AAAA,IAAI,SAAS,GAA8B,IAAI,CAAA;AAE/C;;;;;;;;;GASG;AACH,MAAM,UAAU,YAAY,CAAC,KAAgC;IAC3D,SAAS,GAAG,KAAK,IAAI,IAAI,CAAA;AAC3B,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,YAAY;IAC1B,OAAO,SAAS,CAAA;AAClB,CAAC","sourcesContent":["let userToken: string | null | undefined = null\n\n/**\n * Set the User token being included in requests to the OneBlink API on behalf\n * of the user.\n *\n * #### Example\n *\n * ```js\n * authService.setUserToken('a value')\n * ```\n */\nexport function setUserToken(token: string | undefined | null): void {\n  userToken = token || null\n}\n\n/**\n * Can be used to retrieve the `userToken` passed to `setUserToken()`. Will be\n * `undefined` if the token has not been set yet.\n *\n * #### Example\n *\n * ```js\n * const userToken = authService.getUserToken()\n * if (userToken) {\n *   // Use token here...\n * }\n * ```\n *\n * @returns\n */\nexport function getUserToken() {\n  return userToken\n}\n"]}

package/dist/apps/services/utils.d.ts

@@ -0,0 +1,12 @@
+declare function getLocalForageKeys(keyPrefix: string): Promise<string[]>;
+declare function getLocalForageItem<T>(key: string): Promise<T | null>;
+declare function setLocalForageItem<T extends object>(key: string, originalData: T): Promise<T>;
+declare function removeLocalForageItem(key: string): Promise<void>;
+declare const _default: {
+    localForage: LocalForage;
+    getLocalForageItem: typeof getLocalForageItem;
+    setLocalForageItem: typeof setLocalForageItem;
+    removeLocalForageItem: typeof removeLocalForageItem;
+    getLocalForageKeys: typeof getLocalForageKeys;
+};
+export default _default;

package/dist/apps/services/utils.js

@@ -0,0 +1,100 @@
+import { createInstance } from 'localforage';
+import _cloneDeep from 'lodash.clonedeep';
+const localForage = createInstance({
+    name: 'OneBlinkForms',
+    storeName: 'FORMS_V1',
+    description: 'Store of forms related data',
+});
+async function getLocalForageKeys(keyPrefix) {
+    const keys = await localForage.keys();
+    return keys.filter((key) => key.startsWith(keyPrefix));
+}
+function setValuesOnData(key, items, data) {
+    if (!data) {
+        return null;
+    }
+    Object.keys(data).forEach((property) => {
+        // @ts-expect-error
+        const value = data[property];
+        if (typeof value === 'string' && value.startsWith(key)) {
+            const item = items.find((item) => item && item.key === value);
+            // If we did not find the item that is suppose to be referenced
+            // by the `key` property, we will remove the data as something has
+            // gone wrong and the data has been lost to the IndexDB gods...
+            // @ts-expect-error
+            data[property] = item === null || item === void 0 ? void 0 : item.value;
+        }
+        else if (value !== null && typeof value === 'object') {
+            setValuesOnData(key, items, value);
+        }
+    });
+    return data;
+}
+async function getLocalForageItem(key) {
+    const localForageKeys = await getLocalForageKeys(key);
+    const items = [];
+    for (const localForageKey of localForageKeys) {
+        const item = await localForage.getItem(localForageKey);
+        items.push(item);
+    }
+    const rootItem = items.find((item) => item && item.key === key);
+    if (!rootItem || !rootItem.value) {
+        return null;
+    }
+    return setValuesOnData(key, items, rootItem.value);
+}
+function generateKeyValuesReducer(key, data, initialKeyValues) {
+    if (data === null) {
+        return;
+    }
+    Object.keys(data).reduce((keyValues, property) => {
+        // @ts-expect-error
+        const value = data[property];
+        if ((typeof value === 'string' && value.length > 25000) ||
+            value instanceof Blob) {
+            const newKey = `${key}_${property}`;
+            keyValues.keys.push(newKey);
+            keyValues.items.push({
+                key: newKey,
+                value,
+            });
+            // @ts-expect-error
+            data[property] = newKey;
+        }
+        else if (value !== null && typeof value === 'object') {
+            generateKeyValuesReducer(`${key}_${property}`, value, keyValues);
+        }
+        return keyValues;
+    }, initialKeyValues);
+}
+async function setLocalForageItem(key, originalData) {
+    const data = _cloneDeep(originalData);
+    await removeLocalForageItem(key);
+    const keyValues = {
+        keys: [key],
+        items: [{ key, value: data }],
+    };
+    generateKeyValuesReducer(key, data, keyValues);
+    for (const keyToSet of keyValues.keys) {
+        const index = keyValues.keys.findIndex((k) => k === keyToSet);
+        const item = keyValues.items[index];
+        if (item) {
+            await localForage.setItem(keyToSet, item);
+        }
+    }
+    return originalData;
+}
+async function removeLocalForageItem(key) {
+    const keysToDelete = await getLocalForageKeys(key);
+    for (const keyToDelete of keysToDelete) {
+        await localForage.removeItem(keyToDelete);
+    }
+}
+export default {
+    localForage,
+    getLocalForageItem,
+    setLocalForageItem,
+    removeLocalForageItem,
+    getLocalForageKeys,
+};
+//# sourceMappingURL=utils.js.map

package/dist/apps/services/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/apps/services/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,UAAU,MAAM,kBAAkB,CAAA;AAEzC,MAAM,WAAW,GAAG,cAAc,CAAC;IACjC,IAAI,EAAE,eAAe;IACrB,SAAS,EAAE,UAAU;IACrB,WAAW,EAAE,6BAA6B;CAC3C,CAAC,CAAA;AAEF,KAAK,UAAU,kBAAkB,CAAC,SAAiB;IACjD,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,CAAA;IACrC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;AACxD,CAAC;AAED,SAAS,eAAe,CACtB,GAAW,EACX,KAOC,EACD,IAAQ;IAER,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,IAAI,CAAA;IACb,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACrC,mBAAmB;QACnB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAA;QAE5B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,KAAK,KAAK,CAAC,CAAA;YAC7D,+DAA+D;YAC/D,kEAAkE;YAClE,+DAA+D;YAC/D,mBAAmB;YACnB,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,CAAA;QAC9B,CAAC;aAAM,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvD,eAAe,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;QACpC,CAAC;IACH,CAAC,CAAC,CAAA;IACF,OAAO,IAAI,CAAA;AACb,CAAC;AAED,KAAK,UAAU,kBAAkB,CAAI,GAAW;IAC9C,MAAM,eAAe,GAAG,MAAM,kBAAkB,CAAC,GAAG,CAAC,CAAA;IAErD,MAAM,KAAK,GAAG,EAAE,CAAA;IAChB,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE,CAAC;QAC7C,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,OAAO,CAGnC,cAAc,CAAC,CAAA;QAClB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,CAAA;IAC/D,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACjC,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO,eAAe,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAU,CAAC,CAAA;AACzD,CAAC;AAED,SAAS,wBAAwB,CAC/B,GAAW,EACX,IAAY,EACZ,gBAMC;IAED,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAM;IACR,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE;QAC/C,mBAAmB;QACnB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAA;QAE5B,IACE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;YACnD,KAAK,YAAY,IAAI,EACrB,CAAC;YACD,MAAM,MAAM,GAAG,GAAG,GAAG,IAAI,QAAQ,EAAE,CAAA;YACnC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAC3B,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;gBACnB,GAAG,EAAE,MAAM;gBACX,KAAK;aACN,CAAC,CAAA;YACF,mBAAmB;YACnB,IAAI,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAA;QACzB,CAAC;aAAM,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvD,wBAAwB,CAAC,GAAG,GAAG,IAAI,QAAQ,EAAE,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;QAClE,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC,EAAE,gBAAgB,CAAC,CAAA;AACtB,CAAC;AAED,KAAK,UAAU,kBAAkB,CAC/B,GAAW,EACX,YAAe;IAEf,MAAM,IAAI,GAAM,UAAU,CAAC,YAAY,CAAC,CAAA;IACxC,MAAM,qBAAqB,CAAC,GAAG,CAAC,CAAA;IAChC,MAAM,SAAS,GAAG;QAChB,IAAI,EAAE,CAAC,GAAG,CAAC;QACX,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;KAC9B,CAAA;IACD,wBAAwB,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IAC9C,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAA;QAC7D,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACnC,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;IACD,OAAO,YAAY,CAAA;AACrB,CAAC;AAED,KAAK,UAAU,qBAAqB,CAAC,GAAW;IAC9C,MAAM,YAAY,GAAG,MAAM,kBAAkB,CAAC,GAAG,CAAC,CAAA;IAClD,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACvC,MAAM,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;IAC3C,CAAC;AACH,CAAC;AAED,eAAe;IACb,WAAW;IACX,kBAAkB;IAClB,kBAAkB;IAClB,qBAAqB;IACrB,kBAAkB;CACnB,CAAA","sourcesContent":["import { createInstance } from 'localforage'\nimport _cloneDeep from 'lodash.clonedeep'\n\nconst localForage = createInstance({\n  name: 'OneBlinkForms',\n  storeName: 'FORMS_V1',\n  description: 'Store of forms related data',\n})\n\nasync function getLocalForageKeys(keyPrefix: string): Promise<string[]> {\n  const keys = await localForage.keys()\n  return keys.filter((key) => key.startsWith(keyPrefix))\n}\n\nfunction setValuesOnData<T>(\n  key: string,\n  items: Array<\n    | {\n        key: string\n        value: unknown\n      }\n    | undefined\n    | null\n  >,\n  data?: T,\n) {\n  if (!data) {\n    return null\n  }\n  Object.keys(data).forEach((property) => {\n    // @ts-expect-error\n    const value = data[property]\n\n    if (typeof value === 'string' && value.startsWith(key)) {\n      const item = items.find((item) => item && item.key === value)\n      // If we did not find the item that is suppose to be referenced\n      // by the `key` property, we will remove the data as something has\n      // gone wrong and the data has been lost to the IndexDB gods...\n      // @ts-expect-error\n      data[property] = item?.value\n    } else if (value !== null && typeof value === 'object') {\n      setValuesOnData(key, items, value)\n    }\n  })\n  return data\n}\n\nasync function getLocalForageItem<T>(key: string): Promise<T | null> {\n  const localForageKeys = await getLocalForageKeys(key)\n\n  const items = []\n  for (const localForageKey of localForageKeys) {\n    const item = await localForage.getItem<{\n      key: string\n      value: unknown\n    }>(localForageKey)\n    items.push(item)\n  }\n  const rootItem = items.find((item) => item && item.key === key)\n  if (!rootItem || !rootItem.value) {\n    return null\n  }\n  return setValuesOnData(key, items, rootItem.value as T)\n}\n\nfunction generateKeyValuesReducer(\n  key: string,\n  data: object,\n  initialKeyValues: {\n    keys: string[]\n    items: Array<{\n      key: string\n      value: unknown\n    }>\n  },\n) {\n  if (data === null) {\n    return\n  }\n  Object.keys(data).reduce((keyValues, property) => {\n    // @ts-expect-error\n    const value = data[property]\n\n    if (\n      (typeof value === 'string' && value.length > 25000) ||\n      value instanceof Blob\n    ) {\n      const newKey = `${key}_${property}`\n      keyValues.keys.push(newKey)\n      keyValues.items.push({\n        key: newKey,\n        value,\n      })\n      // @ts-expect-error\n      data[property] = newKey\n    } else if (value !== null && typeof value === 'object') {\n      generateKeyValuesReducer(`${key}_${property}`, value, keyValues)\n    }\n    return keyValues\n  }, initialKeyValues)\n}\n\nasync function setLocalForageItem<T extends object>(\n  key: string,\n  originalData: T,\n): Promise<T> {\n  const data: T = _cloneDeep(originalData)\n  await removeLocalForageItem(key)\n  const keyValues = {\n    keys: [key],\n    items: [{ key, value: data }],\n  }\n  generateKeyValuesReducer(key, data, keyValues)\n  for (const keyToSet of keyValues.keys) {\n    const index = keyValues.keys.findIndex((k) => k === keyToSet)\n    const item = keyValues.items[index]\n    if (item) {\n      await localForage.setItem(keyToSet, item)\n    }\n  }\n  return originalData\n}\n\nasync function removeLocalForageItem(key: string): Promise<void> {\n  const keysToDelete = await getLocalForageKeys(key)\n  for (const keyToDelete of keysToDelete) {\n    await localForage.removeItem(keyToDelete)\n  }\n}\n\nexport default {\n  localForage,\n  getLocalForageItem,\n  setLocalForageItem,\n  removeLocalForageItem,\n  getLocalForageKeys,\n}\n"]}

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

@@ -0,0 +1,226 @@
+import { registerPendingQueueListener, getPendingQueueSubmissions, cancelEditingPendingQueueSubmission, deletePendingQueueSubmission, editPendingQueueSubmission, registerPendingQueueAttachmentProgressListener, registerPendingQueueProgressListener, PendingQueueListener, PendingQueueAction } from './services/pending-queue';
+import { FormTypes, SubmissionTypes } from '@oneblink/types';
+import { SubmissionParams, ProgressListener, ProgressListenerEvent } from './services/submit';
+import { PendingFormSubmission, FormSubmission, FormSubmissionResult, BaseFormSubmission, NewDraftSubmission, NewFormSubmission, DraftSubmission, DraftSubmissionInput } from './types/submissions';
+import getPostSubmissionAttachments from './services/api/post-submission-attachment-urls';
+/**
+ * Force processing the pending queue. This must be called to process the
+ * pending queue and is best used when the application comes back online.
+ *
+ * ### Example
+ *
+ * ```js
+ * await submissionService.processPendingQueue()
+ * ```
+ *
+ * @returns
+ */
+declare function processPendingQueue({ shouldRunExternalIdGeneration, shouldRunServerValidation, }: {
+    shouldRunExternalIdGeneration: boolean;
+    shouldRunServerValidation: boolean;
+}): Promise<void>;
+/**
+ * Submit a FormSubmission. Offline submissions will be added to a pending queue
+ * and be processed using the `processPendingQueue()` function. FormSubmissions
+ * with payment submission events will return the FormSubmissionResult with a
+ * `payment` property set, this should be used to redirect the user to the
+ * payment URL. Will also handle cleaning up auto save data (if the
+ * `autoSaveKey` property is passed), locally stored drafts and prefill data.
+ *
+ * ### Example
+ *
+ * ```js
+ * const formSubmission = {
+ *   formsAppId: 1,
+ *   submission: {
+ *     form: 'data',
+ *     goes: 'here',
+ *   },
+ *   definition: OneBlinkForm,
+ *   captchaTokens: [],
+ *   formSubmissionDraftId: '2974602c-2c5b-4b46-b086-87ee9b2aa233',
+ *   jobId: 'bb37d1da-9cda-4950-a36a-22f58b25de3a',
+ *   preFillFormDataId: '7763f828-4aaf-49dc-9c1b-e2eeea8fa990',
+ *   externalId: 'external-id-set-by-developer',
+ * }
+ *
+ * // Pass paymentReceiptUrl if submission may require a payment
+ * const paymentReceiptUrl = `${window.location.origin}/payment-receipt`
+ *
+ * // Pass schedulingBookingUrlConfiguration if submission utilise scheduling
+ * const schedulingBookingUrlConfiguration = {
+ *   schedulingBookingUrl: 'https://my-website.com/booking',
+ *   schedulingRescheduleUrl: 'https://my-website.com/reschedule',
+ *   schedulingCancelUrl: 'https://my-website.com/cancel',
+ * }
+ * const submissionResult = await submissionService.submit({
+ *   formSubmission,
+ *   paymentReceiptUrl,
+ *   schedulingBookingUrlConfiguration,
+ * })
+ *
+ * if (submissionResult.scheduling) {
+ *   // Redirect user to booking form
+ *   window.location.href = submissionResult.scheduling.bookingUrl
+ *   return
+ * }
+ *
+ * if (submissionResult.payment) {
+ *   // Redirect user to payment form
+ *   window.location.href = submissionResult.payment.hostedFormUrl
+ *   return
+ * }
+ *
+ * if (submissionResult.isOffline) {
+ *   if (submissionResult.isInPendingQueue) {
+ *     // Display message to user that the submission
+ *     // has been added to the pending queue
+ *   } else {
+ *     // Display message to user that this submission can
+ *     // not be processed while offline (most likely because it requires a payment)
+ *   }
+ *   return
+ * }
+ *
+ * // submissionResult.submissionId and submissionResult.submissionTimestamp
+ * // will be set if the submission was successful
+ * ```
+ *
+ * @param params
+ * @returns
+ */
+declare function submit(params: SubmissionParams & {
+    autoSaveKey?: string;
+}): Promise<FormSubmissionResult>;
+/**
+ * Go back in the browser history or attempts to close the browser tab if there
+ * is no history.
+ *
+ * ### Example
+ *
+ * ```js
+ * try {
+ *   await submissionService.goBackOrCloseWindow()
+ * } catch (error) {
+ *   // Handle error while closing browser tab.
+ *   // Display message to user to close it manually
+ * }
+ * ```
+ *
+ * @returns
+ */
+declare function goBackOrCloseWindow(): Promise<void>;
+/**
+ * Action to cancel completing a form, currently goes back in the browser
+ * history or attempts to close the browser tab if there is no history.
+ *
+ * ### Example
+ *
+ * ```js
+ * const options = {
+ *   definition: OneBlinkForm,
+ *   externalId: 'external-id-set-by-developer',
+ * }
+ * // Only used for relative URLs
+ * const pushRelativePath = (path) => {
+ *   window.location.href = path
+ * }
+ * // Only used for aboslute URLS
+ * const replaceAbsolutePath = window.location.replace
+ *
+ * try {
+ *   await submissionService.executeCancelAction(options, {
+ *     onRedirectToRelativeUrl: pushRelativePath,
+ *     onRedirectToAbsoluteUrl: replaceAbsolutePath,
+ *   })
+ * } catch (error) {
+ *   // Handle error while closing browser tab.
+ *   // Display message to user to close it manually
+ * }
+ * ```
+ *
+ * @param options
+ * @param redirectConfig
+ */
+declare function executeCancelAction(formSubmissionResultOptions: {
+    definition: FormTypes.Form;
+    externalId: string | null;
+    taskCompletion?: FormSubmissionResult['taskCompletion'];
+}, { onRedirectToRelativeUrl, onRedirectToAbsoluteUrl, }: {
+    onRedirectToRelativeUrl: (url: string) => void;
+    onRedirectToAbsoluteUrl: (url: string) => void;
+}): Promise<void>;
+/**
+ * Execute the post submission action for a form after a successful form
+ * submission.
+ *
+ * ### Example
+ *
+ * ```js
+ * const formSubmissionResult = {
+ *   submissionId: '89c6e98e-f56f-45fc-84fe-c4fc62331d34',
+ *   submissionTimestamp: '2020-07-29T01:03:26.573Z'
+ *   formsAppId: 1,
+ *   submission: {
+ *     form: 'data',
+ *     goes: 'here'
+ *   },
+ *   definition: OneBlinkForm,
+ *   payment: {
+ *     hostedFormUrl: 'https://payment.com/transaction'
+ *   },
+ *   formSubmissionDraftId: '2974602c-2c5b-4b46-b086-87ee9b2aa233',
+ *   jobId: 'bb37d1da-9cda-4950-a36a-22f58b25de3a',
+ *   preFillFormDataId: '7763f828-4aaf-49dc-9c1b-e2eeea8fa990',
+ *   externalId: 'external-id-set-by-developer',
+ * }
+ * // Only used for relative URLs
+ * const pushRelativePath = (path) => {
+ *   window.location.href = path
+ * }
+ * // Only used for aboslute URLS
+ * const replaceAbsolutePath = window.location.replace
+ *
+ * try {
+ *   await submissionService.executePostSubmissionAction(formSubmissionResult, {
+ *     onRedirectToRelativeUrl: pushRelativePath,
+ *     onRedirectToAbsoluteUrl: replaceAbsolutePath,
+ *   })
+ * } catch (error) {
+ *   // Handle error while closing browser tab.
+ *   // Display message to user to close it manually
+ * }
+ * ```
+ *
+ * @param submissionResult
+ * @param redirectConfig
+ */
+declare function executePostSubmissionAction(submissionResult: FormSubmissionResult, { onRedirectToRelativeUrl, onRedirectToAbsoluteUrl, }: {
+    onRedirectToRelativeUrl: (url: string) => void;
+    onRedirectToAbsoluteUrl: (url: string) => void;
+}): Promise<void>;
+/**
+ * Retrieve submission data for a known formId and submissionId
+ *
+ * #### Example
+ *
+ * ```js
+ * const formId = 1
+ * const submissionId = 'fba95b9d-5a9c-463d-ab68-867f431e4120'
+ * const credentials = await formSubmissionService.getSubmissionData({
+ *   formId,
+ *   submissionId,
+ * })
+ * ```
+ *
+ * @param formId
+ * @param submissionId
+ * @param abortSignal
+ * @returns
+ */
+declare function getSubmissionData({ formId, submissionId, abortSignal, }: {
+    formId: number;
+    submissionId: string;
+    abortSignal?: AbortSignal;
+}): Promise<SubmissionTypes.S3SubmissionData>;
+export { submit, executePostSubmissionAction, executeCancelAction, goBackOrCloseWindow, getPendingQueueSubmissions, deletePendingQueueSubmission, editPendingQueueSubmission, cancelEditingPendingQueueSubmission, registerPendingQueueListener, processPendingQueue, BaseFormSubmission, NewDraftSubmission, NewFormSubmission, DraftSubmissionInput, DraftSubmission, FormSubmission, FormSubmissionResult, PendingFormSubmission, SubmissionParams, registerPendingQueueAttachmentProgressListener, registerPendingQueueProgressListener, ProgressListener, ProgressListenerEvent, PendingQueueListener, PendingQueueAction, getSubmissionData, getPostSubmissionAttachments, };