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

package/dist/apps/tenants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../../src/apps/tenants.ts"],"names":[],"mappings":"AAoBA,MAAM,WAAW,GAAG,CAAC,MAAc,EAAE,EAAE;IACrC,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,OAAO;YACV,OAAO,KAAK,CAAA;QACd,KAAK,OAAO,CAAC;QACb;YACE,OAAO,KAAK,CAAA;IAChB,CAAC;AACH,CAAC,CAAA;AAED,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAE,EAAE;IAC5C,OAAO;QACL,MAAM,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YACpC,KAAK,EAAE,SAAS;YAChB,qBAAqB,EAAE,EAAE;SAC1B,CAAC;QACF,QAAQ,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YACtC,KAAK,EAAE,UAAU;YACjB,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC;SAC9B,CAAC;QACF,IAAI,EAAE,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YACpC,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;YAChB,GAAG,EAAE,SAAS;SACf,CAAC;QACF,QAAQ,EAAE,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YACxC,SAAS,EAAE,MAAM;SAClB,CAAC;QACF,IAAI,EAAE,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YACpC,SAAS,EAAE,OAAO;SACnB,CAAC;QACF,YAAY,EAAE,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC5C,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;SAClB,CAAC;KACH,CAAA;AACH,CAAC,CAAA;AAED,MAAM,OAAO,GAOT;IACF,IAAI,EAAE;QACJ,QAAQ,EAAE;YACR,SAAS,EAAE,gBAAgB;YAC3B,WAAW,EAAE,wBAAwB;YACrC,SAAS,EAAE,iCAAiC;YAC5C,cAAc,EACZ,yFAAyF;YAC3F,WAAW,EAAE,kBAAkB,CAAC,OAAO,CAAC;YACxC,IAAI,EAAE,UAAU;YAChB,gBAAgB,EAAE,cAAc;YAChC,YAAY,EAAE,QAAQ;YACtB,qBAAqB,EAAE,GAAG;SAC3B;QACD,SAAS,EAAE;YACT,SAAS,EAAE,WAAW;YACtB,WAAW,EAAE,oCAAoC;YACjD,SAAS,EAAE,+CAA+C;YAC1D,cAAc,EACZ,yFAAyF;YAC3F,WAAW,EAAE,kBAAkB,CAAC,OAAO,CAAC;YACxC,IAAI,EAAE,WAAW;YACjB,gBAAgB,EAAE,eAAe;YACjC,YAAY,EAAE,MAAM;YACpB,qBAAqB,EAAE,IAAI;SAC5B;QACD,UAAU,EAAE;YACV,SAAS,EAAE,WAAW;YACtB,WAAW,EAAE,2BAA2B;YACxC,SAAS,EAAE,sCAAsC;YACjD,cAAc,EAAE,yFAAyF;YACzG,WAAW,EAAE,kBAAkB,CAAC,OAAO,CAAC;YACxC,IAAI,EAAE,UAAU;YAChB,gBAAgB,EAAE,cAAc;YAChC,YAAY,EAAE,MAAM;YACpB,qBAAqB,EAAE,IAAI;SAC5B;KACF;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE;YACR,SAAS,EAAE,gBAAgB;YAC3B,WAAW,EAAE,mBAAmB;YAChC,SAAS,EAAE,4BAA4B;YACvC,cAAc,EACZ,yFAAyF;YAC3F,WAAW,EAAE,kBAAkB,CAAC,OAAO,CAAC;YACxC,IAAI,EAAE,UAAU;YAChB,gBAAgB,EAAE,cAAc;YAChC,YAAY,EAAE,QAAQ;YACtB,qBAAqB,EAAE,GAAG;SAC3B;QACD,SAAS,EAAE;YACT,SAAS,EAAE,WAAW;YACtB,WAAW,EAAE,+BAA+B;YAC5C,SAAS,EAAE,0CAA0C;YACrD,cAAc,EACZ,yFAAyF;YAC3F,WAAW,EAAE,kBAAkB,CAAC,OAAO,CAAC;YACxC,IAAI,EAAE,WAAW;YACjB,gBAAgB,EAAE,eAAe;YACjC,YAAY,EAAE,MAAM;YACpB,qBAAqB,EAAE,IAAI;SAC5B;QACD,UAAU,EAAE;YACV,SAAS,EAAE,WAAW;YACtB,WAAW,EAAE,sBAAsB;YACnC,SAAS,EAAE,iCAAiC;YAC5C,cAAc,EAAE,yFAAyF;YACzG,WAAW,EAAE,kBAAkB,CAAC,OAAO,CAAC;YACxC,IAAI,EAAE,UAAU;YAChB,gBAAgB,EAAE,cAAc;YAChC,YAAY,EAAE,MAAM;YACpB,qBAAqB,EAAE,IAAI;SAC5B;KACF;CACF,CAAA;AAED,MAAM,OAAO;IAGX;QACE,IAAI,CAAC,MAAM,GAAG,UAAU,CAAA;IAC1B,CAAC;IAED,IAAI,iBAAiB;QACnB,mBAAmB;QACnB,OAAO,MAAM,CAAC,yBAAyB,KAAK,MAAM,CAAA;IACpD,CAAC;IAED,IAAI,OAAO;QACT,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;YACpB,KAAK,WAAW;gBACd,OAAO,IAAI,CAAC,iBAAiB;oBAC3B,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS;oBACxB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAA;YAC5B,KAAK,YAAY;gBACf,OAAO,IAAI,CAAC,iBAAiB;oBAC3B,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU;oBACzB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAA;YAC7B,KAAK,UAAU,CAAC;YAChB;gBACE,OAAO,IAAI,CAAC,iBAAiB;oBAC3B,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ;oBACvB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAA;QAC7B,CAAC;IACH,CAAC;IAED,IAAI,MAAM;QACR,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;YACpB,KAAK,WAAW;gBACd,OAAO,OAAO,CAAA;YAChB,KAAK,UAAU,CAAC;YAChB;gBACE,OAAO,OAAO,CAAA;QAClB,CAAC;IACH,CAAC;IAED,WAAW;QACT,IAAI,CAAC,MAAM,GAAG,UAAU,CAAA;IAC1B,CAAC;IAED,aAAa;QACX,IAAI,CAAC,MAAM,GAAG,YAAY,CAAA;IAC5B,CAAC;IAED,YAAY;QACV,IAAI,CAAC,MAAM,GAAG,WAAW,CAAA;IAC3B,CAAC;CACF;AAED,eAAe,IAAI,OAAO,EAAE,CAAA","sourcesContent":["interface OneBlinkAppsTenant {\n  awsRegion: string\n  loginDomain: string\n  apiOrigin: string\n  vapidPublicKey: string\n  intlFormats: {\n    number: Intl.NumberFormat\n    currency: Intl.NumberFormat\n    date: Intl.DateTimeFormat\n    dateLong: Intl.DateTimeFormat\n    time: Intl.DateTimeFormat\n    olderIOSTime: Intl.DateTimeFormat\n  }\n  name: string\n  productShortName: string\n  distanceUnit: string\n  distanceUnitShortName: string\n}\ntype Locale = 'en-AU' | 'en-US'\n\nconst getCurrency = (locale: Locale) => {\n  switch (locale) {\n    case 'en-US':\n      return 'USD'\n    case 'en-AU':\n    default:\n      return 'AUD'\n  }\n}\n\nconst generateFormatters = (locale: Locale) => {\n  return {\n    number: new Intl.NumberFormat(locale, {\n      style: 'decimal',\n      maximumFractionDigits: 20,\n    }),\n    currency: new Intl.NumberFormat(locale, {\n      style: 'currency',\n      currency: getCurrency(locale),\n    }),\n    date: new Intl.DateTimeFormat(locale, {\n      year: 'numeric',\n      month: '2-digit',\n      day: '2-digit',\n    }),\n    dateLong: new Intl.DateTimeFormat(locale, {\n      dateStyle: 'full',\n    }),\n    time: new Intl.DateTimeFormat(locale, {\n      timeStyle: 'short',\n    }),\n    olderIOSTime: new Intl.DateTimeFormat(locale, {\n      hour: 'numeric',\n      minute: 'numeric',\n      second: 'numeric',\n    }),\n  }\n}\n\nconst tenants: Record<\n  'test' | 'prod',\n  {\n    oneblink: OneBlinkAppsTenant\n    civicplus: OneBlinkAppsTenant\n    oneblinkUS: OneBlinkAppsTenant\n  }\n> = {\n  test: {\n    oneblink: {\n      awsRegion: 'ap-southeast-2',\n      loginDomain: 'login.test.oneblink.io',\n      apiOrigin: 'https://auth-api.test.blinkm.io',\n      vapidPublicKey:\n        'BE5wtYdaQW3z7DWc08rzNlOwPuituVWFRLW_lUMD78ZJatFOjio8fYDHaIpQCRyeKsJ5j4kLaFU374J4dM90iUc',\n      intlFormats: generateFormatters('en-AU'),\n      name: 'OneBlink',\n      productShortName: 'OneBlink LcS',\n      distanceUnit: 'meters',\n      distanceUnitShortName: 'm',\n    },\n    civicplus: {\n      awsRegion: 'us-east-2',\n      loginDomain: 'login.test.transform.civicplus.com',\n      apiOrigin: 'https://auth-api.test.transform.civicplus.com',\n      vapidPublicKey:\n        'BLg2Dn9sYj1a0I3AcS22Fg71uubdMLwoemG8zfnPOljgFKB-5MR3FIxc2Mtt0AzM3zk2QWl3YzEy6EEwIUmz19k',\n      intlFormats: generateFormatters('en-US'),\n      name: 'CivicPlus',\n      productShortName: 'CivicOptimize',\n      distanceUnit: 'feet',\n      distanceUnitShortName: 'ft',\n    },\n    oneblinkUS: {\n      awsRegion: 'us-east-1',\n      loginDomain: 'login.test.us.oneblink.io',\n      apiOrigin: 'https://auth-api.test.us.oneblink.io',\n      vapidPublicKey: 'BF-WeCKYxp6R55nN5SX7L0_dVRAXlMdVRdsuvbiv0T7zP-yXTGTMw4F1O45pC0UdTk2m6DaOkZRzTJ1XWh2ByZw',\n      intlFormats: generateFormatters('en-US'),\n      name: 'OneBlink',\n      productShortName: 'OneBlink LcS',\n      distanceUnit: 'feet',\n      distanceUnitShortName: 'ft',\n    },\n  },\n  prod: {\n    oneblink: {\n      awsRegion: 'ap-southeast-2',\n      loginDomain: 'login.oneblink.io',\n      apiOrigin: 'https://auth-api.blinkm.io',\n      vapidPublicKey:\n        'BADH0JnMngI0uFKUnbC79VGXy5d6WutccnEvVuFBMx--BrZtFAHGTgOBiABJXmE8_VHC92_jK5K-2qdP2kZeius',\n      intlFormats: generateFormatters('en-AU'),\n      name: 'OneBlink',\n      productShortName: 'OneBlink LcS',\n      distanceUnit: 'meters',\n      distanceUnitShortName: 'm',\n    },\n    civicplus: {\n      awsRegion: 'us-east-2',\n      loginDomain: 'login.transform.civicplus.com',\n      apiOrigin: 'https://auth-api.transform.civicplus.com',\n      vapidPublicKey:\n        'BLoDtCutrC7tEd75x89zBaIyz3Fk8AeWOcABasV3YO4Tei5UO8WjJVPFyilNLYxeseaiKlgoa0DOh1HoR59M_G4',\n      intlFormats: generateFormatters('en-US'),\n      name: 'CivicPlus',\n      productShortName: 'CivicOptimize',\n      distanceUnit: 'feet',\n      distanceUnitShortName: 'ft',\n    },\n    oneblinkUS: {\n      awsRegion: 'us-east-1',\n      loginDomain: 'login.us.oneblink.io',\n      apiOrigin: 'https://auth-api.us.oneblink.io',\n      vapidPublicKey: 'BKL8Vk_U46_To07_fkVOAExQp8Zi_XjEDunLqCz8cYEXcX3Em0qMdMdROfT6MYb7EKIkUK1Ymgvf3tFnkYrKCfc',\n      intlFormats: generateFormatters('en-US'),\n      name: 'OneBlink',\n      productShortName: 'OneBlink LcS',\n      distanceUnit: 'feet',\n      distanceUnitShortName: 'ft',\n    },\n  },\n}\n\nclass Tenants {\n  tenant: 'oneblink' | 'civicplus' | 'oneblinkUS'\n\n  constructor() {\n    this.tenant = 'oneblink'\n  }\n\n  get isTestEnvironment() {\n    // @ts-expect-error\n    return window.ONEBLINK_APPS_ENVIRONMENT === 'test'\n  }\n\n  get current(): OneBlinkAppsTenant {\n    switch (this.tenant) {\n      case 'civicplus':\n        return this.isTestEnvironment\n          ? tenants.test.civicplus\n          : tenants.prod.civicplus\n      case 'oneblinkUS':\n        return this.isTestEnvironment\n          ? tenants.test.oneblinkUS\n          : tenants.prod.oneblinkUS\n      case 'oneblink':\n      default:\n        return this.isTestEnvironment\n          ? tenants.test.oneblink\n          : tenants.prod.oneblink\n    }\n  }\n\n  get locale() /* : string */ {\n    switch (this.tenant) {\n      case 'civicplus':\n        return 'en-US'\n      case 'oneblink':\n      default:\n        return 'en-AU'\n    }\n  }\n\n  useOneBlink() {\n    this.tenant = 'oneblink'\n  }\n\n  useOneBlinkUS() {\n    this.tenant = 'oneblinkUS'\n  }\n\n  useCivicPlus() {\n    this.tenant = 'civicplus'\n  }\n}\n\nexport default new Tenants()\n"]}

package/dist/apps/types/form.d.ts

@@ -0,0 +1,4 @@
+/** The form element name for accessing its submission data */
+export type FormElementKey = string;
+/** The submission data model to be submitted */
+export type FormSubmissionModel = Record<FormElementKey, unknown>;

package/dist/apps/types/form.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=form.js.map

package/dist/apps/types/form.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"form.js","sourceRoot":"","sources":["../../../src/apps/types/form.ts"],"names":[],"mappings":"","sourcesContent":["/** The form element name for accessing its submission data */\nexport type FormElementKey = string\n/** The submission data model to be submitted */\nexport type FormSubmissionModel = Record<FormElementKey, unknown>\n"]}

package/dist/apps/types/payments.d.ts

@@ -0,0 +1,45 @@
+import { SubmissionEventTypes } from '@oneblink/types';
+import { FormSubmissionResult } from './submissions';
+import { SchedulingBooking } from '../scheduling-service';
+export type PaymentReceiptItem = {
+    /** The label to represent the value */
+    label: string;
+    /** The value to display */
+    value: string;
+    /** A CSS class to add to the HTML element container */
+    className?: string;
+    /** A CSS class to add to the HTML element containing the value */
+    valueClassName?: string;
+    /** A [material icon](https://fonts.google.com/icons) */
+    icon?: string;
+    /** Display a button on the receipt item to copy the value to the clipboard */
+    allowCopyToClipboard: boolean;
+};
+export type VerifiedPaymentTransaction = {
+    receiptItems: PaymentReceiptItem[];
+    transaction: {
+        /** `true` if the transaction was successful */
+        isSuccess: boolean;
+        /** The error message to display if `isSuccess` is `false` */
+        errorMessage: string | undefined | null;
+    };
+    submissionResult: FormSubmissionResult;
+};
+export type HandlePaymentResult = VerifiedPaymentTransaction & {
+    schedulingBooking: SchedulingBooking | undefined;
+};
+export type BasePaymentConfigurationPayload = {
+    amount: number;
+    redirectUrl: string;
+    submissionId: string | null;
+    paymentFormUrl?: string;
+};
+export interface PaymentProvider<T extends SubmissionEventTypes.FormPaymentEvent> {
+    formSubmissionResult: FormSubmissionResult;
+    paymentSubmissionEvent: T;
+    preparePaymentConfiguration(basePayload: BasePaymentConfigurationPayload): {
+        path: string;
+        payload: BasePaymentConfigurationPayload;
+    };
+    verifyPaymentTransaction(query: Record<string, unknown>): Promise<VerifiedPaymentTransaction>;
+}

package/dist/apps/types/payments.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=payments.js.map

package/dist/apps/types/payments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments.js","sourceRoot":"","sources":["../../../src/apps/types/payments.ts"],"names":[],"mappings":"","sourcesContent":["import { SubmissionEventTypes } from '@oneblink/types'\nimport { FormSubmissionResult } from './submissions'\nimport { SchedulingBooking } from '../scheduling-service'\n\nexport type PaymentReceiptItem = {\n  /** The label to represent the value */\n  label: string\n  /** The value to display */\n  value: string\n  /** A CSS class to add to the HTML element container */\n  className?: string\n  /** A CSS class to add to the HTML element containing the value */\n  valueClassName?: string\n  /** A [material icon](https://fonts.google.com/icons) */\n  icon?: string\n  /** Display a button on the receipt item to copy the value to the clipboard */\n  allowCopyToClipboard: boolean\n}\n\nexport type VerifiedPaymentTransaction = {\n  receiptItems: PaymentReceiptItem[]\n  transaction: {\n    /** `true` if the transaction was successful */\n    isSuccess: boolean\n    /** The error message to display if `isSuccess` is `false` */\n    errorMessage: string | undefined | null\n  }\n  submissionResult: FormSubmissionResult\n}\n\nexport type HandlePaymentResult = VerifiedPaymentTransaction & {\n  schedulingBooking: SchedulingBooking | undefined\n}\n\nexport type BasePaymentConfigurationPayload = {\n  amount: number\n  redirectUrl: string\n  submissionId: string | null\n  paymentFormUrl?: string\n}\n\nexport interface PaymentProvider<\n  T extends SubmissionEventTypes.FormPaymentEvent,\n> {\n  formSubmissionResult: FormSubmissionResult\n  paymentSubmissionEvent: T\n\n  preparePaymentConfiguration(basePayload: BasePaymentConfigurationPayload): {\n    path: string\n    payload: BasePaymentConfigurationPayload\n  }\n\n  verifyPaymentTransaction(\n    query: Record<string, unknown>,\n  ): Promise<VerifiedPaymentTransaction>\n}\n"]}

package/dist/apps/types/scheduling.d.ts

@@ -0,0 +1,5 @@
+export type SchedulingUrlConfiguration = {
+    schedulingBookingUrl: string;
+    schedulingCancelUrl: string;
+    schedulingRescheduleUrl?: string;
+};

package/dist/apps/types/scheduling.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=scheduling.js.map

package/dist/apps/types/scheduling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduling.js","sourceRoot":"","sources":["../../../src/apps/types/scheduling.ts"],"names":[],"mappings":"","sourcesContent":["export type SchedulingUrlConfiguration = {\n  schedulingBookingUrl: string\n  schedulingCancelUrl: string\n  schedulingRescheduleUrl?: string\n}\n"]}

package/dist/apps/types/submissions.d.ts

@@ -0,0 +1,175 @@
+import { FormTypes, SubmissionEventTypes, SubmissionTypes, ScheduledTasksTypes } from '@oneblink/types';
+import { FormElement } from '@oneblink/types/typescript/forms';
+export { ProgressListener, ProgressListenerEvent } from '@oneblink/storage';
+export type BaseNewFormSubmission = {
+    /** The submission data */
+    submission: SubmissionTypes.S3SubmissionData['submission'];
+    /** The form definition when the draft was saved */
+    definition: FormTypes.Form;
+};
+export type NewDraftSubmission = BaseNewFormSubmission & {
+    /**
+     * Set to true if the submission should be uploaded in the background, false
+     * or undefined if the submission should be uploaded immediately
+     */
+    backgroundUpload?: boolean;
+    /** The element that was last updated before the draft was saved */
+    lastElementUpdated?: FormElement;
+    /** The state of sections before the draft was saved */
+    sectionState?: SubmissionTypes.NewS3SubmissionData['sectionState'];
+    /**
+     * The elapsed duration in seconds the user took to complete the submission
+     * before the draft was saved
+     */
+    previousElapsedDurationSeconds?: SubmissionTypes.NewS3SubmissionData['previousElapsedDurationSeconds'];
+};
+export type NewFormSubmission = BaseNewFormSubmission & {
+    /** The reCAPTCHA tokens to validate the submission */
+    recaptchas?: Array<{
+        /** The site key that was used to generate the reCAPTCHA token */
+        siteKey: string;
+        /** A reCAPTCHA token */
+        token: string;
+    }>;
+};
+export type BaseFormSubmission = {
+    /** The id of the job to submit */
+    jobId?: string;
+    /** The id of the Forms App submitting for */
+    externalId?: string;
+    /**
+     * The id of the previous form submission approval id. Only used when the form
+     * submission is in response to `CLARIFICATION_REQUIRED` approval.
+     */
+    previousFormSubmissionApprovalId?: string;
+    /**
+     * Will have a value if the user was attempting to complete a scheduled task
+     * via a form submission
+     */
+    taskCompletion?: {
+        /** The task */
+        task: ScheduledTasksTypes.Task;
+        /** The task action */
+        taskAction: ScheduledTasksTypes.TaskAction;
+        /** The task group */
+        taskGroup: ScheduledTasksTypes.TaskGroup | undefined;
+        /** The task group instance */
+        taskGroupInstance: ScheduledTasksTypes.TaskGroupInstance | undefined;
+        /**
+         * The URL to redirect the user to after completing the task via form
+         * submission
+         */
+        redirectUrl: string;
+    };
+};
+export type DraftSubmissionInput = NewDraftSubmission & BaseFormSubmission & {
+    /** The id of the Forms App submitting for */
+    formsAppId: number;
+    /** The title input by a user to identify the draft. */
+    title: string;
+};
+export type DraftSubmission = DraftSubmissionInput & {
+    /**
+     * The date and time (in ISO format) when this version of the draft was
+     * created.
+     */
+    createdAt: string;
+    /**
+     * The identifier for the parent draft record. Created client side to store
+     * the draft locally for offline capability
+     */
+    formSubmissionDraftId: string;
+};
+export type LocalFormSubmissionDraft = Omit<SubmissionTypes.FormSubmissionDraft, 'id' | 'versions'> & {
+    /**
+     * The versions of the draft data. `undefined` if it has not been uploaded
+     * remotely yet.
+     */
+    versions: SubmissionTypes.FormSubmissionDraftVersion[] | undefined;
+    /**
+     * The draft submission data. `undefined` if it has not been downloaded
+     * locally yet.
+     */
+    draftSubmission: DraftSubmission | undefined;
+    /** `true` if the draft was created by a public user (not logged in). */
+    isPublic?: boolean;
+};
+export type FormSubmission = NewFormSubmission & BaseFormSubmission & {
+    /** The id of the Forms App submitting for */
+    formsAppId?: number;
+    /** The id of the draft to clean up after successful submission */
+    formSubmissionDraftId?: string;
+    /** The id of the prefill data to clean up after successful submission */
+    preFillFormDataId: string | null;
+};
+export type FormSubmissionResult = FormSubmission & {
+    /**
+     * The identifier that represents the submission. `null` if the form
+     * submission was unsuccessful
+     */
+    submissionId: string | null;
+    /**
+     * The timestamp the form was submitted, `null` if the form submission was
+     * unsuccessful
+     */
+    submissionTimestamp: string | null;
+    /** `null` if the form submission does not require a payment */
+    payment: {
+        /** The amount required to pay */
+        amount: number;
+        /** The URL to redirect the user to after payment to display a receipt */
+        paymentReceiptUrl: string;
+        /**
+         * The URL to redirect the user to to make a payment for a form hosted by
+         * customer instead of payment provider
+         */
+        paymentFormUrl: string | undefined;
+        /** The URL to redirect the user to to complete the payment process */
+        hostedFormUrl: string;
+        /** The payment submission event */
+        submissionEvent: SubmissionEventTypes.FormPaymentEvent;
+    } | null;
+    /** `null` if the form submission does not require a booking */
+    scheduling: {
+        /** The URL to redirect the user to to complete the booking process */
+        bookingUrl: string;
+        /** The scheduling submission event */
+        submissionEvent: SubmissionEventTypes.FormSchedulingEvent;
+    } | null;
+    /**
+     * `true` if the submission was not submitted yet and was added to the pending
+     * queue
+     */
+    isInPendingQueue: boolean;
+    /** `true` if the submission was attempted offline */
+    isOffline: boolean;
+    /** True if the submission was attempted whilst attachments were uploading */
+    isUploadingAttachments: boolean;
+    /** Exists if the form allows PDF download */
+    /**
+     * @deprecated Only returned when legacy post submission download
+     *   configuration is in use. For non legacy configured forms, use
+     *   `downloadSubmissionPdfs` instead.
+     */
+    downloadSubmissionPdfUrl?: string;
+    downloadSubmissionPdfs?: Array<{
+        id: string;
+        configuration: SubmissionEventTypes.PDFConfiguration;
+        url: string;
+    }>;
+    /** The access token to download post-submission attachment urls and metadata. */
+    attachmentsAccessToken?: string;
+};
+export type PendingFormSubmission = FormSubmission & {
+    /** The date and time (in ISO format) the submission was attempted */
+    pendingTimestamp: string;
+    /** `true` if the submission is currently being processed by the pending queue */
+    isSubmitting?: boolean;
+    /** `true` if the submission is currently being edited */
+    isEditing?: boolean;
+    /**
+     * An error message that might be set while attempting to process the
+     * submission in the pending queue
+     */
+    error?: string;
+};

package/dist/apps/types/submissions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=submissions.js.map

package/dist/apps/types/submissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"submissions.js","sourceRoot":"","sources":["../../../src/apps/types/submissions.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  FormTypes,\n  SubmissionEventTypes,\n  SubmissionTypes,\n  ScheduledTasksTypes,\n} from '@oneblink/types'\nimport { FormElement } from '@oneblink/types/typescript/forms'\n\nexport { ProgressListener, ProgressListenerEvent } from '@oneblink/storage'\n\nexport type BaseNewFormSubmission = {\n  /** The submission data */\n  submission: SubmissionTypes.S3SubmissionData['submission']\n  /** The form definition when the draft was saved */\n  definition: FormTypes.Form\n}\n\nexport type NewDraftSubmission = BaseNewFormSubmission & {\n  /**\n   * Set to true if the submission should be uploaded in the background, false\n   * or undefined if the submission should be uploaded immediately\n   */\n  backgroundUpload?: boolean\n  /** The element that was last updated before the draft was saved */\n  lastElementUpdated?: FormElement\n  /** The state of sections before the draft was saved */\n  sectionState?: SubmissionTypes.NewS3SubmissionData['sectionState']\n  /**\n   * The elapsed duration in seconds the user took to complete the submission\n   * before the draft was saved\n   */\n\n  previousElapsedDurationSeconds?: SubmissionTypes.NewS3SubmissionData['previousElapsedDurationSeconds']\n}\n\nexport type NewFormSubmission = BaseNewFormSubmission & {\n  /** The reCAPTCHA tokens to validate the submission */\n  recaptchas?: Array<{\n    /** The site key that was used to generate the reCAPTCHA token */\n    siteKey: string\n    /** A reCAPTCHA token */\n    token: string\n  }>\n}\n\nexport type BaseFormSubmission = {\n  /** The id of the job to submit */\n  jobId?: string\n  /** The id of the Forms App submitting for */\n  externalId?: string\n  /**\n   * The id of the previous form submission approval id. Only used when the form\n   * submission is in response to `CLARIFICATION_REQUIRED` approval.\n   */\n  previousFormSubmissionApprovalId?: string\n  /**\n   * Will have a value if the user was attempting to complete a scheduled task\n   * via a form submission\n   */\n  taskCompletion?: {\n    /** The task */\n    task: ScheduledTasksTypes.Task\n    /** The task action */\n    taskAction: ScheduledTasksTypes.TaskAction\n    /** The task group */\n    taskGroup: ScheduledTasksTypes.TaskGroup | undefined\n    /** The task group instance */\n    taskGroupInstance: ScheduledTasksTypes.TaskGroupInstance | undefined\n    /**\n     * The URL to redirect the user to after completing the task via form\n     * submission\n     */\n    redirectUrl: string\n  }\n}\n\nexport type DraftSubmissionInput = NewDraftSubmission &\n  BaseFormSubmission & {\n    /** The id of the Forms App submitting for */\n    formsAppId: number\n    /** The title input by a user to identify the draft. */\n    title: string\n  }\n\nexport type DraftSubmission = DraftSubmissionInput & {\n  /**\n   * The date and time (in ISO format) when this version of the draft was\n   * created.\n   */\n  createdAt: string\n  /**\n   * The identifier for the parent draft record. Created client side to store\n   * the draft locally for offline capability\n   */\n  formSubmissionDraftId: string\n}\n\nexport type LocalFormSubmissionDraft = Omit<\n  SubmissionTypes.FormSubmissionDraft,\n  'id' | 'versions'\n> & {\n  /**\n   * The versions of the draft data. `undefined` if it has not been uploaded\n   * remotely yet.\n   */\n  versions: SubmissionTypes.FormSubmissionDraftVersion[] | undefined\n  /**\n   * The draft submission data. `undefined` if it has not been downloaded\n   * locally yet.\n   */\n  draftSubmission: DraftSubmission | undefined\n  /** `true` if the draft was created by a public user (not logged in). */\n  isPublic?: boolean\n}\n\nexport type FormSubmission = NewFormSubmission &\n  BaseFormSubmission & {\n    /** The id of the Forms App submitting for */\n    formsAppId?: number\n    /** The id of the draft to clean up after successful submission */\n    formSubmissionDraftId?: string\n    /** The id of the prefill data to clean up after successful submission */\n    preFillFormDataId: string | null\n  }\n\nexport type FormSubmissionResult = FormSubmission & {\n  /**\n   * The identifier that represents the submission. `null` if the form\n   * submission was unsuccessful\n   */\n  submissionId: string | null\n  /**\n   * The timestamp the form was submitted, `null` if the form submission was\n   * unsuccessful\n   */\n  submissionTimestamp: string | null\n  /** `null` if the form submission does not require a payment */\n  payment: {\n    /** The amount required to pay */\n    amount: number\n    /** The URL to redirect the user to after payment to display a receipt */\n    paymentReceiptUrl: string\n    /**\n     * The URL to redirect the user to to make a payment for a form hosted by\n     * customer instead of payment provider\n     */\n    paymentFormUrl: string | undefined\n    /** The URL to redirect the user to to complete the payment process */\n    hostedFormUrl: string\n    /** The payment submission event */\n    submissionEvent: SubmissionEventTypes.FormPaymentEvent\n  } | null\n  /** `null` if the form submission does not require a booking */\n  scheduling: {\n    /** The URL to redirect the user to to complete the booking process */\n    bookingUrl: string\n    /** The scheduling submission event */\n    submissionEvent: SubmissionEventTypes.FormSchedulingEvent\n  } | null\n  /**\n   * `true` if the submission was not submitted yet and was added to the pending\n   * queue\n   */\n  isInPendingQueue: boolean\n  /** `true` if the submission was attempted offline */\n  isOffline: boolean\n  /** True if the submission was attempted whilst attachments were uploading */\n  isUploadingAttachments: boolean\n  /** Exists if the form allows PDF download */\n  /**\n   * @deprecated Only returned when legacy post submission download\n   *   configuration is in use. For non legacy configured forms, use\n   *   `downloadSubmissionPdfs` instead.\n   */\n  downloadSubmissionPdfUrl?: string\n\n  downloadSubmissionPdfs?: Array<{\n    id: string\n    configuration: SubmissionEventTypes.PDFConfiguration\n    url: string\n  }>\n  /** The access token to download post-submission attachment urls and metadata. */\n  attachmentsAccessToken?: string\n}\n\nexport type PendingFormSubmission = FormSubmission & {\n  /** The date and time (in ISO format) the submission was attempted */\n  pendingTimestamp: string\n  /** `true` if the submission is currently being processed by the pending queue */\n  isSubmitting?: boolean\n  /** `true` if the submission is currently being edited */\n  isEditing?: boolean\n  /**\n   * An error message that might be set while attempting to process the\n   * submission in the pending queue\n   */\n  error?: string\n}\n"]}

package/dist/components/ArcGISWebMap.d.ts

@@ -10,10 +10,10 @@ type Props = {
     onChange: FormElementValueChangeHandler<ArcGISWebMapElementValue>;
     automatedSnapshotFileName: string;
     'aria-describedby'?: string;
-    takeScreenShotRef: React.MutableRefObject<((view?: ArcGISTypes.ArcGISWebMapElementValue['view']) => Promise<{
+    takeScreenShotRef: React.RefObject<((view?: ArcGISTypes.ArcGISWebMapElementValue['view']) => Promise<{
         dataUrl: string;
-    }>) | undefined>;
+    }>) | null>;
 };
-declare function FormElementArcGISWebMap({ element, id, value, onChange, takeScreenShotRef, automatedSnapshotFileName, ...props }: Props): React.JSX.Element;
+declare function FormElementArcGISWebMap({ element, id, value, onChange, takeScreenShotRef, automatedSnapshotFileName, ...props }: Props): import("react/jsx-runtime").JSX.Element;
 declare const _default: React.MemoExoticComponent<typeof FormElementArcGISWebMap>;
 export default _default;

package/dist/components/ArcGISWebMap.js

@@ -1,3 +1,4 @@
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
 import * as React from 'react';
 import MapView from '@arcgis/core/views/MapView';
 import WebMap from '@arcgis/core/WebMap';
@@ -16,43 +17,40 @@ import TextSymbol from '@arcgis/core/symbols/TextSymbol';
 import * as geometryEngine from '@arcgis/core/geometry/geometryEngine';
 import { Box, Divider, IconButton } from '@mui/material';
 import throttle from 'lodash.throttle';
-import { localisationService } from '@oneblink/apps';
+import { localisationService } from '../apps';
 import { v4 as uuid } from 'uuid';
 import OnLoading from '../components/renderer/OnLoading';
 import MaterialIcon from './MaterialIcon';
 import useIsPageVisible from '../hooks/useIsPageVisible';
 import '../styles/arcgis-external.css';
 function DrawingOptionsList({ options, sketchTool, onClose, sketchToolType, setSelectedGraphicAttributes, }) {
-    return (React.createElement("div", { className: "esri-widget" },
-        React.createElement(Box, { sx: {
-                display: 'flex',
-                alignItems: 'center',
-                justifyContent: 'space-between',
-            } },
-            React.createElement("b", { style: { padding: '0.5rem' } }, "Select an option"),
-            React.createElement(IconButton, { onClick: (e) => {
-                    e.stopPropagation();
-                    onClose();
-                }, size: "small", "data-cypress": "copy-to-clip-board-button" },
-                React.createElement(MaterialIcon, { fontSize: "small" }, "close"))),
-        React.createElement(Divider, { sx: { backgroundColor: 'unset', margin: '0px 8px' } }),
-        React.createElement(Box, { sx: { maxHeight: '200px', overflowY: 'auto' } }, options === null || options === void 0 ? void 0 : options.map(({ id, value, label, description }) => (React.createElement("div", { key: id, className: "ob-list__item is-clickable", style: { alignItems: 'center' }, onClick: () => {
-                onClose();
-                sketchTool === null || sketchTool === void 0 ? void 0 : sketchTool.create(sketchToolType);
-                setSelectedGraphicAttributes({ value, label, description });
-            } }, label))))));
+    if (!sketchTool.current)
+        return null;
+    return (_jsxs("div", { className: "esri-widget", children: [_jsxs(Box, { sx: {
+                    display: 'flex',
+                    alignItems: 'center',
+                    justifyContent: 'space-between',
+                }, children: [_jsx("b", { style: { padding: '0.5rem' }, children: "Select an option" }), _jsx(IconButton, { onClick: (e) => {
+                            e.stopPropagation();
+                            onClose();
+                        }, size: "small", "data-cypress": "copy-to-clip-board-button", children: _jsx(MaterialIcon, { fontSize: "small", children: "close" }) })] }), _jsx(Divider, { sx: { backgroundColor: 'unset', margin: '0px 8px' } }), _jsx(Box, { sx: { maxHeight: '200px', overflowY: 'auto' }, children: options === null || options === void 0 ? void 0 : options.map(({ id, value, label, description }) => (_jsx("div", { className: "ob-list__item is-clickable", style: { alignItems: 'center' }, onClick: () => {
+                        var _a;
+                        onClose();
+                        (_a = sketchTool === null || sketchTool === void 0 ? void 0 : sketchTool.current) === null || _a === void 0 ? void 0 : _a.create(sketchToolType);
+                        setSelectedGraphicAttributes({ value, label, description });
+                    }, children: label }, id))) })] }));
 }
 function FormElementArcGISWebMap({ element, id, value, onChange, takeScreenShotRef, automatedSnapshotFileName, ...props }) {
     var _a, _b;
     const ref = React.useRef(null);
-    const layerPanelRef = React.useRef();
-    const mapGalleryPanelRef = React.useRef();
-    const sketchToolRef = React.useRef();
-    const drawingLayerRef = React.useRef();
-    const selectedGraphicForUpdate = React.useRef();
-    const mapViewRef = React.useRef();
-    const measurementLayerRef = React.useRef();
-    const defaultLayersRef = React.useRef();
+    const layerPanelRef = React.useRef(null);
+    const mapGalleryPanelRef = React.useRef(null);
+    const sketchToolRef = React.useRef(null);
+    const drawingLayerRef = React.useRef(null);
+    const selectedGraphicForUpdate = React.useRef(undefined);
+    const mapViewRef = React.useRef(null);
+    const measurementLayerRef = React.useRef(null);
+    const defaultLayersRef = React.useRef(null);
     const [loadError, setLoadError] = React.useState();
     const [isLoading, setIsLoading] = React.useState(false);
     const isPageVisible = useIsPageVisible();
@@ -568,19 +566,11 @@ function FormElementArcGISWebMap({ element, id, value, onChange, takeScreenShotR
         }
     }, [isPageVisible, isLoading]);
     if (loadError) {
-        return (React.createElement("figure", { className: "ob-figure" },
-            React.createElement("div", { className: "figure-content has-text-centered" },
-                React.createElement(MaterialIcon, { className: "icon-large has-margin-bottom-6 has-text-warning" }, "error"),
-                React.createElement("h4", { className: "title is-4" }, "We were unable to display your web map"),
-                React.createElement("p", null, loadError.message))));
+        return (_jsx("figure", { className: "ob-figure", children: _jsxs("div", { className: "figure-content has-text-centered", children: [_jsx(MaterialIcon, { className: "icon-large has-margin-bottom-6 has-text-warning", children: "error" }), _jsx("h4", { className: "title is-4", children: "We were unable to display your web map" }), _jsx("p", { children: loadError.message })] }) }));
     }
-    return (React.createElement(React.Fragment, null,
-        isLoading && (React.createElement("div", { className: "figure-content-absolute-center" },
-            React.createElement(OnLoading, { small: true }))),
-        React.createElement("div", { className: "arcgis-web-map", ref: ref, id: id, "aria-describedby": props['aria-describedby'] }),
-        React.createElement("div", { id: drawingOptionsContainerId }, !!activeSketchToolMenu && sketchToolRef.current && (React.createElement(DrawingOptionsList, { options: ((_b = (_a = element.allowedDrawingTools) === null || _a === void 0 ? void 0 : _a.find((tool) => tool.type === activeSketchToolMenu)) === null || _b === void 0 ? void 0 : _b.graphicAttributeOptions) || [], onClose: () => setActiveSketchToolMenu(undefined), setSelectedGraphicAttributes: (opt) => {
-                setSelectedGraphicAttributes(opt);
-            }, sketchToolType: activeSketchToolMenu, sketchTool: sketchToolRef.current })))));
+    return (_jsxs(_Fragment, { children: [isLoading && (_jsx("div", { className: "figure-content-absolute-center", children: _jsx(OnLoading, { small: true }) })), _jsx("div", { className: "arcgis-web-map", ref: ref, id: id, "aria-describedby": props['aria-describedby'] }), _jsx("div", { id: drawingOptionsContainerId, children: !!activeSketchToolMenu && sketchToolRef && (_jsx(DrawingOptionsList, { options: ((_b = (_a = element.allowedDrawingTools) === null || _a === void 0 ? void 0 : _a.find((tool) => tool.type === activeSketchToolMenu)) === null || _b === void 0 ? void 0 : _b.graphicAttributeOptions) || [], onClose: () => setActiveSketchToolMenu(undefined), setSelectedGraphicAttributes: (opt) => {
+                        setSelectedGraphicAttributes(opt);
+                    }, sketchToolType: activeSketchToolMenu, sketchTool: sketchToolRef })) })] }));
 }
 export default React.memo(FormElementArcGISWebMap);
 //# sourceMappingURL=ArcGISWebMap.js.map