@oneblink/apps-react 4.1.0-beta.7 → 4.1.0

package/dist/hooks/useNullableState.js

@@ -1,5 +1,46 @@
 import * as React from 'react';
-export default function useNullableState(defaultValue) {
+/**
+ * This function is a react hook for state of type of your choosing. It comes
+ * with two memoized functions, one for setting state and one for clearing it.
+ *
+ * The items returned in the array can be destructured and named whatever you
+ * like:
+ *
+ * ```js
+ * import { useNullableState } from '@oneblink/apps-react'
+ *
+ * const startingProfile = {
+ *   name: 'Forest Gump',
+ *   profession: 'Military, Athlete, Other',
+ * }
+ *
+ * const [userProfile, setUserProfile, unsetUserProfile] =
+ *   useBooleanState(startingProfile)
+ * ```
+ *
+ * `setUserProfile` can then be called with an object of type `T` like:
+ *
+ * ```js
+ * setUserProfile({
+ *   name: 'Walter White',
+ *   profession: 'Chemistry Teacher (Secondary School), Other',
+ * })
+ * ```
+ *
+ * And `unsetUserProfile` can be called like:
+ *
+ * ```js
+ * unsetUserProfile()
+ * ```
+ *
+ * @typeParam T The type of the state
+ * @param defaultValue
+ * @returns
+ * @group Hooks
+ */
+export default function useNullableState(
+/** The starting state for the hook. */
+defaultValue) {
     const [state, setState] = React.useState(defaultValue);
     const unsetState = React.useCallback(() => setState(null), []);
     return [state, setState, unsetState];

package/dist/hooks/useNullableState.js.map

@@ -1 +1 @@
-{"version":3,"file":"useNullableState.js","sourceRoot":"","sources":["../../src/hooks/useNullableState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACtC,YAAsB;IAEtB,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;IACtD,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAA;IAC9D,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAA;AACtC,CAAC","sourcesContent":["import * as React from 'react'\n\nexport default function useNullableState<T>(\n  defaultValue: T | null,\n): [T | null, React.Dispatch<React.SetStateAction<T | null>>, () => void] {\n  const [state, setState] = React.useState(defaultValue)\n  const unsetState = React.useCallback(() => setState(null), [])\n  return [state, setState, unsetState]\n}\n"]}
+{"version":3,"file":"useNullableState.js","sourceRoot":"","sources":["../../src/hooks/useNullableState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB;AACtC,uCAAuC;AACvC,YAAsB;IAMtB,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;IACtD,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAA;IAC9D,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAA;AACtC,CAAC","sourcesContent":["import * as React from 'react'\n\n/**\n * This function is a react hook for state of type of your choosing. It comes\n * with two memoized functions, one for setting state and one for clearing it.\n *\n * The items returned in the array can be destructured and named whatever you\n * like:\n *\n * ```js\n * import { useNullableState } from '@oneblink/apps-react'\n *\n * const startingProfile = {\n *   name: 'Forest Gump',\n *   profession: 'Military, Athlete, Other',\n * }\n *\n * const [userProfile, setUserProfile, unsetUserProfile] =\n *   useBooleanState(startingProfile)\n * ```\n *\n * `setUserProfile` can then be called with an object of type `T` like:\n *\n * ```js\n * setUserProfile({\n *   name: 'Walter White',\n *   profession: 'Chemistry Teacher (Secondary School), Other',\n * })\n * ```\n *\n * And `unsetUserProfile` can be called like:\n *\n * ```js\n * unsetUserProfile()\n * ```\n *\n * @typeParam T The type of the state\n * @param defaultValue\n * @returns\n * @group Hooks\n */\nexport default function useNullableState<T>(\n  /** The starting state for the hook. */\n  defaultValue: T | null,\n): [\n  state: T | null,\n  setState: React.Dispatch<React.SetStateAction<T | null>>,\n  clearState: () => void,\n] {\n  const [state, setState] = React.useState(defaultValue)\n  const unsetState = React.useCallback(() => setState(null), [])\n  return [state, setState, unsetState]\n}\n"]}

package/dist/hooks/usePendingSubmissions.d.ts

@@ -0,0 +1,103 @@
+import * as React from 'react';
+import { submissionService } from '@oneblink/apps';
+/** The value returned from `usePendingSubmissions()` hook */
+export type PendingSubmissionsContextValue = {
+    /** `true` if the pending submissions are currently loading */
+    isLoading: boolean;
+    /** An Error object if loading pending submissions fails */
+    loadError: Error | null;
+    /**
+     * The submissions that were submitted offline and can be processed when back
+     * online
+     */
+    pendingSubmissions: submissionService.PendingFormSubmission[];
+    /** `true` submissions that where submitted offline are being processed */
+    isProcessingPendingQueue: boolean;
+    /** A function to trigger processing of the pending queue */
+    processPendingQueue: () => unknown;
+    /**
+     * A function to trigger loading of the submissions that were submitted
+     * offline
+     */
+    reloadPendingSubmissions: () => unknown;
+    /** A function to remove a submission from the pending submissions */
+    deletePendingSubmission: (pendingTimestamp: string) => unknown;
+    /** `true` if a submission being processed fails */
+    isShowingFailedNotification: boolean;
+    /** A function to hide the notification when a submission fails to process */
+    hideFailedNotification: () => unknown;
+    /** `true` if a submission being processed completes successfully. */
+    isShowingSuccessNotification: boolean;
+    /**
+     * A function to hide the notification after a submission completed
+     * successfully
+     */
+    hideSuccessNotification: () => unknown;
+};
+/**
+ * React Component that provides the context for the `usePendingSubmissions()`
+ * hook to be used by components further down your component tree. **It should
+ * only be included in your component tree once and ideally at the root of the
+ * application.**
+ *
+ * #### Example
+ *
+ * ```jsx
+ * import * as React from 'react'
+ * import {
+ *   PendingSubmissionsContextProvider,
+ *   usePendingSubmissions,
+ * } from '@oneblink/apps-react'
+ *
+ * function Component() {
+ *   const pendingSubmissionsContext = usePendingSubmissions()
+ *   // use pending submissions here
+ * }
+ *
+ * function App() {
+ *   return (
+ *     <PendingSubmissionsContextProvider
+ *       isPendingQueueEnabled
+ *       successNotificationTimeoutMs={3000}
+ *     >
+ *       <Component />
+ *     </PendingSubmissionsContextProvider>
+ *   )
+ * }
+ *
+ * const root = document.getElementById('root')
+ * if (root) {
+ *   ReactDOM.render(<App />, root)
+ * }
+ * ```
+ *
+ * @param props
+ * @returns
+ * @group Components
+ */
+export declare function PendingSubmissionsContextProvider({ isPendingQueueEnabled, successNotificationTimeoutMs, children, }: {
+    /**
+     * `true` if pending queue is enabled, otherwise `false`. Can be used prevent
+     * offline submissions from being processed.
+     */
+    isPendingQueueEnabled: boolean;
+    /**
+     * When a submission is processed successfully the
+     * `isShowingSuccessNotification` will be temporarily set to `true`, it will
+     * be set back to `false` after 5 seconds. This prop will allow you to
+     * customise how long to wait before hiding the notification with a
+     * milliseconds value.
+     */
+    successNotificationTimeoutMs?: number;
+    /** Your application components */
+    children: React.ReactNode;
+}): JSX.Element;
+/**
+ * React hook to get the context value for Pending Submissions. Will throw an
+ * Error if used outside of the `<PendingSubmissionsContextProvider />`
+ * component.
+ *
+ * @returns
+ * @group Hooks
+ */
+export default function usePendingSubmissions(): PendingSubmissionsContextValue;

package/dist/hooks/usePendingSubmissions.js

@@ -0,0 +1,195 @@
+import * as React from 'react';
+import { submissionService } from '@oneblink/apps';
+import useBooleanState from './useBooleanState';
+import useIsMounted from './useIsMounted';
+import useIsOffline from './useIsOffline';
+const defaultState = {
+    isLoading: false,
+    loadError: null,
+    pendingSubmissions: [],
+};
+const PendingSubmissionsContext = React.createContext(undefined);
+/**
+ * React Component that provides the context for the `usePendingSubmissions()`
+ * hook to be used by components further down your component tree. **It should
+ * only be included in your component tree once and ideally at the root of the
+ * application.**
+ *
+ * #### Example
+ *
+ * ```jsx
+ * import * as React from 'react'
+ * import {
+ *   PendingSubmissionsContextProvider,
+ *   usePendingSubmissions,
+ * } from '@oneblink/apps-react'
+ *
+ * function Component() {
+ *   const pendingSubmissionsContext = usePendingSubmissions()
+ *   // use pending submissions here
+ * }
+ *
+ * function App() {
+ *   return (
+ *     <PendingSubmissionsContextProvider
+ *       isPendingQueueEnabled
+ *       successNotificationTimeoutMs={3000}
+ *     >
+ *       <Component />
+ *     </PendingSubmissionsContextProvider>
+ *   )
+ * }
+ *
+ * const root = document.getElementById('root')
+ * if (root) {
+ *   ReactDOM.render(<App />, root)
+ * }
+ * ```
+ *
+ * @param props
+ * @returns
+ * @group Components
+ */
+export function PendingSubmissionsContextProvider({ isPendingQueueEnabled, successNotificationTimeoutMs = 5000, children, }) {
+    const isMounted = useIsMounted();
+    const isOffline = useIsOffline();
+    // Using a number as state so we can reset the timer used to close
+    // the snack bar each time a pending queue item is processed
+    const [submittedNotificationCount, setSubmittedNotificationCount] = React.useState(0);
+    const hideSuccessNotification = React.useCallback(() => {
+        setSubmittedNotificationCount(0);
+    }, []);
+    const [isShowingFailedNotification, showFailedNotification, hideFailedNotification,] = useBooleanState(false);
+    const [isProcessingPendingQueue, setIsProcessingPendingQueue] = React.useState(false);
+    const [state, setState] = React.useState(defaultState);
+    const processPendingQueue = React.useCallback(async () => {
+        if (isMounted.current) {
+            setIsProcessingPendingQueue(true);
+        }
+        await submissionService.processPendingQueue({
+            shouldRunExternalIdGeneration: true,
+            shouldRunServerValidation: true,
+        });
+        if (isMounted.current) {
+            setIsProcessingPendingQueue(false);
+        }
+    }, [isMounted]);
+    const reloadPendingSubmissions = React.useCallback(async () => {
+        if (isMounted.current) {
+            setState((currentState) => ({
+                isLoading: true,
+                loadError: null,
+                pendingSubmissions: currentState.pendingSubmissions,
+            }));
+        }
+        let newError = null;
+        let newPendingSubmissions = [];
+        try {
+            newPendingSubmissions =
+                await submissionService.getPendingQueueSubmissions();
+        }
+        catch (error) {
+            newError = error;
+        }
+        if (isMounted.current) {
+            setState({
+                isLoading: false,
+                loadError: newError,
+                pendingSubmissions: newPendingSubmissions,
+            });
+        }
+    }, [isMounted]);
+    React.useEffect(() => {
+        if (!isPendingQueueEnabled) {
+            return;
+        }
+        reloadPendingSubmissions();
+        return submissionService.registerPendingQueueListener((pendingSubmissions, action) => {
+            switch (action) {
+                case 'SUBMIT_SUCCEEDED': {
+                    setSubmittedNotificationCount((current) => current + 1);
+                    break;
+                }
+                case 'SUBMIT_FAILED': {
+                    showFailedNotification();
+                    break;
+                }
+                case 'SUBMIT_STARTED': {
+                    hideFailedNotification();
+                    break;
+                }
+                case 'ADDITION': {
+                    processPendingQueue();
+                    break;
+                }
+            }
+            setState({
+                isLoading: false,
+                pendingSubmissions,
+                loadError: null,
+            });
+        });
+    }, [
+        hideFailedNotification,
+        isPendingQueueEnabled,
+        processPendingQueue,
+        reloadPendingSubmissions,
+        showFailedNotification,
+    ]);
+    React.useEffect(() => {
+        if (!isOffline) {
+            processPendingQueue();
+        }
+    }, [isOffline, processPendingQueue]);
+    React.useEffect(() => {
+        if (submittedNotificationCount > 0) {
+            const timeoutId = setTimeout(() => {
+                hideSuccessNotification();
+            }, successNotificationTimeoutMs);
+            return () => {
+                clearTimeout(timeoutId);
+            };
+        }
+    }, [
+        hideSuccessNotification,
+        submittedNotificationCount,
+        successNotificationTimeoutMs,
+    ]);
+    const value = React.useMemo(() => ({
+        ...state,
+        isShowingFailedNotification,
+        hideFailedNotification,
+        isProcessingPendingQueue,
+        processPendingQueue,
+        reloadPendingSubmissions,
+        deletePendingSubmission: submissionService.deletePendingQueueSubmission,
+        isShowingSuccessNotification: submittedNotificationCount > 0,
+        hideSuccessNotification,
+    }), [
+        state,
+        isShowingFailedNotification,
+        hideFailedNotification,
+        isProcessingPendingQueue,
+        processPendingQueue,
+        reloadPendingSubmissions,
+        submittedNotificationCount,
+        hideSuccessNotification,
+    ]);
+    return (React.createElement(PendingSubmissionsContext.Provider, { value: value }, children));
+}
+/**
+ * React hook to get the context value for Pending Submissions. Will throw an
+ * Error if used outside of the `<PendingSubmissionsContextProvider />`
+ * component.
+ *
+ * @returns
+ * @group Hooks
+ */
+export default function usePendingSubmissions() {
+    const value = React.useContext(PendingSubmissionsContext);
+    if (!value) {
+        throw new Error(`"usePendingSubmissions" hook was used outside of the "<PendingSubmissionsContextProvider />" component's children.`);
+    }
+    return value;
+}
+//# sourceMappingURL=usePendingSubmissions.js.map

package/dist/hooks/usePendingSubmissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePendingSubmissions.js","sourceRoot":"","sources":["../../src/hooks/usePendingSubmissions.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,eAAe,MAAM,mBAAmB,CAAA;AAC/C,OAAO,YAAY,MAAM,gBAAgB,CAAA;AACzC,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAqCzC,MAAM,YAAY,GAAG;IACnB,SAAS,EAAE,KAAK;IAChB,SAAS,EAAE,IAAI;IACf,kBAAkB,EAAE,EAAE;CACvB,CAAA;AAED,MAAM,yBAAyB,GAAG,KAAK,CAAC,aAAa,CAEnD,SAAS,CAAC,CAAA;AAEZ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,UAAU,iCAAiC,CAAC,EAChD,qBAAqB,EACrB,4BAA4B,GAAG,IAAI,EACnC,QAAQ,GAiBT;IACC,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAChC,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAEhC,kEAAkE;IAClE,4DAA4D;IAC5D,MAAM,CAAC,0BAA0B,EAAE,6BAA6B,CAAC,GAC/D,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACrD,6BAA6B,CAAC,CAAC,CAAC,CAAA;IAClC,CAAC,EAAE,EAAE,CAAC,CAAA;IACN,MAAM,CACJ,2BAA2B,EAC3B,sBAAsB,EACtB,sBAAsB,EACvB,GAAG,eAAe,CAAC,KAAK,CAAC,CAAA;IAC1B,MAAM,CAAC,wBAAwB,EAAE,2BAA2B,CAAC,GAC3D,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IACvB,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAIrC,YAAY,CAAC,CAAA;IAEhB,MAAM,mBAAmB,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;QACvD,IAAI,SAAS,CAAC,OAAO,EAAE;YACrB,2BAA2B,CAAC,IAAI,CAAC,CAAA;SAClC;QAED,MAAM,iBAAiB,CAAC,mBAAmB,CAAC;YAC1C,6BAA6B,EAAE,IAAI;YACnC,yBAAyB,EAAE,IAAI;SAChC,CAAC,CAAA;QAEF,IAAI,SAAS,CAAC,OAAO,EAAE;YACrB,2BAA2B,CAAC,KAAK,CAAC,CAAA;SACnC;IACH,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAA;IAEf,MAAM,wBAAwB,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;QAC5D,IAAI,SAAS,CAAC,OAAO,EAAE;YACrB,QAAQ,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBAC1B,SAAS,EAAE,IAAI;gBACf,SAAS,EAAE,IAAI;gBACf,kBAAkB,EAAE,YAAY,CAAC,kBAAkB;aACpD,CAAC,CAAC,CAAA;SACJ;QACD,IAAI,QAAQ,GAAG,IAAI,CAAA;QACnB,IAAI,qBAAqB,GAA8C,EAAE,CAAA;QAEzE,IAAI;YACF,qBAAqB;gBACnB,MAAM,iBAAiB,CAAC,0BAA0B,EAAE,CAAA;SACvD;QAAC,OAAO,KAAK,EAAE;YACd,QAAQ,GAAG,KAAc,CAAA;SAC1B;QAED,IAAI,SAAS,CAAC,OAAO,EAAE;YACrB,QAAQ,CAAC;gBACP,SAAS,EAAE,KAAK;gBAChB,SAAS,EAAE,QAAQ;gBACnB,kBAAkB,EAAE,qBAAqB;aAC1C,CAAC,CAAA;SACH;IACH,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAA;IAEf,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,CAAC,qBAAqB,EAAE;YAC1B,OAAM;SACP;QACD,wBAAwB,EAAE,CAAA;QAC1B,OAAO,iBAAiB,CAAC,4BAA4B,CACnD,CAAC,kBAAkB,EAAE,MAAM,EAAE,EAAE;YAC7B,QAAQ,MAAM,EAAE;gBACd,KAAK,kBAAkB,CAAC,CAAC;oBACvB,6BAA6B,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,GAAG,CAAC,CAAC,CAAA;oBACvD,MAAK;iBACN;gBACD,KAAK,eAAe,CAAC,CAAC;oBACpB,sBAAsB,EAAE,CAAA;oBACxB,MAAK;iBACN;gBACD,KAAK,gBAAgB,CAAC,CAAC;oBACrB,sBAAsB,EAAE,CAAA;oBACxB,MAAK;iBACN;gBACD,KAAK,UAAU,CAAC,CAAC;oBACf,mBAAmB,EAAE,CAAA;oBACrB,MAAK;iBACN;aACF;YACD,QAAQ,CAAC;gBACP,SAAS,EAAE,KAAK;gBAChB,kBAAkB;gBAClB,SAAS,EAAE,IAAI;aAChB,CAAC,CAAA;QACJ,CAAC,CACF,CAAA;IACH,CAAC,EAAE;QACD,sBAAsB;QACtB,qBAAqB;QACrB,mBAAmB;QACnB,wBAAwB;QACxB,sBAAsB;KACvB,CAAC,CAAA;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,CAAC,SAAS,EAAE;YACd,mBAAmB,EAAE,CAAA;SACtB;IACH,CAAC,EAAE,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC,CAAA;IAEpC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,0BAA0B,GAAG,CAAC,EAAE;YAClC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;gBAChC,uBAAuB,EAAE,CAAA;YAC3B,CAAC,EAAE,4BAA4B,CAAC,CAAA;YAChC,OAAO,GAAG,EAAE;gBACV,YAAY,CAAC,SAAS,CAAC,CAAA;YACzB,CAAC,CAAA;SACF;IACH,CAAC,EAAE;QACD,uBAAuB;QACvB,0BAA0B;QAC1B,4BAA4B;KAC7B,CAAC,CAAA;IAEF,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CACzB,GAAG,EAAE,CAAC,CAAC;QACL,GAAG,KAAK;QACR,2BAA2B;QAC3B,sBAAsB;QACtB,wBAAwB;QACxB,mBAAmB;QACnB,wBAAwB;QACxB,uBAAuB,EAAE,iBAAiB,CAAC,4BAA4B;QACvE,4BAA4B,EAAE,0BAA0B,GAAG,CAAC;QAC5D,uBAAuB;KACxB,CAAC,EACF;QACE,KAAK;QACL,2BAA2B;QAC3B,sBAAsB;QACtB,wBAAwB;QACxB,mBAAmB;QACnB,wBAAwB;QACxB,0BAA0B;QAC1B,uBAAuB;KACxB,CACF,CAAA;IAED,OAAO,CACL,oBAAC,yBAAyB,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,IAC7C,QAAQ,CAC0B,CACtC,CAAA;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,qBAAqB;IAC3C,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,yBAAyB,CAAC,CAAA;IACzD,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,IAAI,KAAK,CACb,oHAAoH,CACrH,CAAA;KACF;IACD,OAAO,KAAK,CAAA;AACd,CAAC","sourcesContent":["import * as React from 'react'\nimport { submissionService } from '@oneblink/apps'\nimport useBooleanState from './useBooleanState'\nimport useIsMounted from './useIsMounted'\nimport useIsOffline from './useIsOffline'\n\n/** The value returned from `usePendingSubmissions()` hook */\nexport type PendingSubmissionsContextValue = {\n  /** `true` if the pending submissions are currently loading */\n  isLoading: boolean\n  /** An Error object if loading pending submissions fails */\n  loadError: Error | null\n  /**\n   * The submissions that were submitted offline and can be processed when back\n   * online\n   */\n  pendingSubmissions: submissionService.PendingFormSubmission[]\n  /** `true` submissions that where submitted offline are being processed */\n  isProcessingPendingQueue: boolean\n  /** A function to trigger processing of the pending queue */\n  processPendingQueue: () => unknown\n  /**\n   * A function to trigger loading of the submissions that were submitted\n   * offline\n   */\n  reloadPendingSubmissions: () => unknown\n  /** A function to remove a submission from the pending submissions */\n  deletePendingSubmission: (pendingTimestamp: string) => unknown\n  /** `true` if a submission being processed fails */\n  isShowingFailedNotification: boolean\n  /** A function to hide the notification when a submission fails to process */\n  hideFailedNotification: () => unknown\n  /** `true` if a submission being processed completes successfully. */\n  isShowingSuccessNotification: boolean\n  /**\n   * A function to hide the notification after a submission completed\n   * successfully\n   */\n  hideSuccessNotification: () => unknown\n}\n\nconst defaultState = {\n  isLoading: false,\n  loadError: null,\n  pendingSubmissions: [],\n}\n\nconst PendingSubmissionsContext = React.createContext<\n  PendingSubmissionsContextValue | undefined\n>(undefined)\n\n/**\n * React Component that provides the context for the `usePendingSubmissions()`\n * hook to be used by components further down your component tree. **It should\n * only be included in your component tree once and ideally at the root of the\n * application.**\n *\n * #### Example\n *\n * ```jsx\n * import * as React from 'react'\n * import {\n *   PendingSubmissionsContextProvider,\n *   usePendingSubmissions,\n * } from '@oneblink/apps-react'\n *\n * function Component() {\n *   const pendingSubmissionsContext = usePendingSubmissions()\n *   // use pending submissions here\n * }\n *\n * function App() {\n *   return (\n *     <PendingSubmissionsContextProvider\n *       isPendingQueueEnabled\n *       successNotificationTimeoutMs={3000}\n *     >\n *       <Component />\n *     </PendingSubmissionsContextProvider>\n *   )\n * }\n *\n * const root = document.getElementById('root')\n * if (root) {\n *   ReactDOM.render(<App />, root)\n * }\n * ```\n *\n * @param props\n * @returns\n * @group Components\n */\nexport function PendingSubmissionsContextProvider({\n  isPendingQueueEnabled,\n  successNotificationTimeoutMs = 5000,\n  children,\n}: {\n  /**\n   * `true` if pending queue is enabled, otherwise `false`. Can be used prevent\n   * offline submissions from being processed.\n   */\n  isPendingQueueEnabled: boolean\n  /**\n   * When a submission is processed successfully the\n   * `isShowingSuccessNotification` will be temporarily set to `true`, it will\n   * be set back to `false` after 5 seconds. This prop will allow you to\n   * customise how long to wait before hiding the notification with a\n   * milliseconds value.\n   */\n  successNotificationTimeoutMs?: number\n  /** Your application components */\n  children: React.ReactNode\n}) {\n  const isMounted = useIsMounted()\n  const isOffline = useIsOffline()\n\n  // Using a number as state so we can reset the timer used to close\n  // the snack bar each time a pending queue item is processed\n  const [submittedNotificationCount, setSubmittedNotificationCount] =\n    React.useState(0)\n  const hideSuccessNotification = React.useCallback(() => {\n    setSubmittedNotificationCount(0)\n  }, [])\n  const [\n    isShowingFailedNotification,\n    showFailedNotification,\n    hideFailedNotification,\n  ] = useBooleanState(false)\n  const [isProcessingPendingQueue, setIsProcessingPendingQueue] =\n    React.useState(false)\n  const [state, setState] = React.useState<{\n    isLoading: boolean\n    loadError: Error | null\n    pendingSubmissions: submissionService.PendingFormSubmission[]\n  }>(defaultState)\n\n  const processPendingQueue = React.useCallback(async () => {\n    if (isMounted.current) {\n      setIsProcessingPendingQueue(true)\n    }\n\n    await submissionService.processPendingQueue({\n      shouldRunExternalIdGeneration: true,\n      shouldRunServerValidation: true,\n    })\n\n    if (isMounted.current) {\n      setIsProcessingPendingQueue(false)\n    }\n  }, [isMounted])\n\n  const reloadPendingSubmissions = React.useCallback(async () => {\n    if (isMounted.current) {\n      setState((currentState) => ({\n        isLoading: true,\n        loadError: null,\n        pendingSubmissions: currentState.pendingSubmissions,\n      }))\n    }\n    let newError = null\n    let newPendingSubmissions: submissionService.PendingFormSubmission[] = []\n\n    try {\n      newPendingSubmissions =\n        await submissionService.getPendingQueueSubmissions()\n    } catch (error) {\n      newError = error as Error\n    }\n\n    if (isMounted.current) {\n      setState({\n        isLoading: false,\n        loadError: newError,\n        pendingSubmissions: newPendingSubmissions,\n      })\n    }\n  }, [isMounted])\n\n  React.useEffect(() => {\n    if (!isPendingQueueEnabled) {\n      return\n    }\n    reloadPendingSubmissions()\n    return submissionService.registerPendingQueueListener(\n      (pendingSubmissions, action) => {\n        switch (action) {\n          case 'SUBMIT_SUCCEEDED': {\n            setSubmittedNotificationCount((current) => current + 1)\n            break\n          }\n          case 'SUBMIT_FAILED': {\n            showFailedNotification()\n            break\n          }\n          case 'SUBMIT_STARTED': {\n            hideFailedNotification()\n            break\n          }\n          case 'ADDITION': {\n            processPendingQueue()\n            break\n          }\n        }\n        setState({\n          isLoading: false,\n          pendingSubmissions,\n          loadError: null,\n        })\n      },\n    )\n  }, [\n    hideFailedNotification,\n    isPendingQueueEnabled,\n    processPendingQueue,\n    reloadPendingSubmissions,\n    showFailedNotification,\n  ])\n\n  React.useEffect(() => {\n    if (!isOffline) {\n      processPendingQueue()\n    }\n  }, [isOffline, processPendingQueue])\n\n  React.useEffect(() => {\n    if (submittedNotificationCount > 0) {\n      const timeoutId = setTimeout(() => {\n        hideSuccessNotification()\n      }, successNotificationTimeoutMs)\n      return () => {\n        clearTimeout(timeoutId)\n      }\n    }\n  }, [\n    hideSuccessNotification,\n    submittedNotificationCount,\n    successNotificationTimeoutMs,\n  ])\n\n  const value = React.useMemo<PendingSubmissionsContextValue>(\n    () => ({\n      ...state,\n      isShowingFailedNotification,\n      hideFailedNotification,\n      isProcessingPendingQueue,\n      processPendingQueue,\n      reloadPendingSubmissions,\n      deletePendingSubmission: submissionService.deletePendingQueueSubmission,\n      isShowingSuccessNotification: submittedNotificationCount > 0,\n      hideSuccessNotification,\n    }),\n    [\n      state,\n      isShowingFailedNotification,\n      hideFailedNotification,\n      isProcessingPendingQueue,\n      processPendingQueue,\n      reloadPendingSubmissions,\n      submittedNotificationCount,\n      hideSuccessNotification,\n    ],\n  )\n\n  return (\n    <PendingSubmissionsContext.Provider value={value}>\n      {children}\n    </PendingSubmissionsContext.Provider>\n  )\n}\n\n/**\n * React hook to get the context value for Pending Submissions. Will throw an\n * Error if used outside of the `<PendingSubmissionsContextProvider />`\n * component.\n *\n * @returns\n * @group Hooks\n */\nexport default function usePendingSubmissions(): PendingSubmissionsContextValue {\n  const value = React.useContext(PendingSubmissionsContext)\n  if (!value) {\n    throw new Error(\n      `\"usePendingSubmissions\" hook was used outside of the \"<PendingSubmissionsContextProvider />\" component's children.`,\n    )\n  }\n  return value\n}\n"]}

package/dist/hooks/useReplaceableText.js

@@ -1,4 +1,4 @@
-import { localisationService } from '@oneblink/apps';
+import { localisationService, authService } from '@oneblink/apps';
 import * as React from 'react';
 import useFormSubmissionModel from './useFormSubmissionModelContext';
 import { useRepeatableSetIndexText } from '../form-elements/FormElementRepeatableSet';
@@ -9,6 +9,7 @@ export default function useReplaceableText(text) {
         return localisationService.replaceInjectablesWithElementValues(textWithIndex, {
             submission: formSubmissionModel,
             formElements: elements,
+            userProfile: authService.getUserProfile() || undefined,
         });
     }, [elements, formSubmissionModel, textWithIndex]);
 }

package/dist/hooks/useReplaceableText.js.map

@@ -1 +1 @@
-{"version":3,"file":"useReplaceableText.js","sourceRoot":"","sources":["../../src/hooks/useReplaceableText.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AACpD,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,sBAAsB,MAAM,iCAAiC,CAAA;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,2CAA2C,CAAA;AAErF,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,IAAY;IACrD,MAAM,aAAa,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;IACrD,MAAM,EAAE,mBAAmB,EAAE,QAAQ,EAAE,GAAG,sBAAsB,EAAE,CAAA;IAClE,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACxB,OAAO,mBAAmB,CAAC,mCAAmC,CAC5D,aAAa,EACb;YACE,UAAU,EAAE,mBAAmB;YAC/B,YAAY,EAAE,QAAQ;SACvB,CACF,CAAA;IACH,CAAC,EAAE,CAAC,QAAQ,EAAE,mBAAmB,EAAE,aAAa,CAAC,CAAC,CAAA;AACpD,CAAC","sourcesContent":["import { localisationService } from '@oneblink/apps'\nimport * as React from 'react'\nimport useFormSubmissionModel from './useFormSubmissionModelContext'\nimport { useRepeatableSetIndexText } from '../form-elements/FormElementRepeatableSet'\n\nexport default function useReplaceableText(text: string) {\n  const textWithIndex = useRepeatableSetIndexText(text)\n  const { formSubmissionModel, elements } = useFormSubmissionModel()\n  return React.useMemo(() => {\n    return localisationService.replaceInjectablesWithElementValues(\n      textWithIndex,\n      {\n        submission: formSubmissionModel,\n        formElements: elements,\n      },\n    )\n  }, [elements, formSubmissionModel, textWithIndex])\n}\n"]}
+{"version":3,"file":"useReplaceableText.js","sourceRoot":"","sources":["../../src/hooks/useReplaceableText.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACjE,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,sBAAsB,MAAM,iCAAiC,CAAA;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,2CAA2C,CAAA;AAErF,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,IAAY;IACrD,MAAM,aAAa,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;IACrD,MAAM,EAAE,mBAAmB,EAAE,QAAQ,EAAE,GAAG,sBAAsB,EAAE,CAAA;IAClE,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACxB,OAAO,mBAAmB,CAAC,mCAAmC,CAC5D,aAAa,EACb;YACE,UAAU,EAAE,mBAAmB;YAC/B,YAAY,EAAE,QAAQ;YACtB,WAAW,EAAE,WAAW,CAAC,cAAc,EAAE,IAAI,SAAS;SACvD,CACF,CAAA;IACH,CAAC,EAAE,CAAC,QAAQ,EAAE,mBAAmB,EAAE,aAAa,CAAC,CAAC,CAAA;AACpD,CAAC","sourcesContent":["import { localisationService, authService } from '@oneblink/apps'\nimport * as React from 'react'\nimport useFormSubmissionModel from './useFormSubmissionModelContext'\nimport { useRepeatableSetIndexText } from '../form-elements/FormElementRepeatableSet'\n\nexport default function useReplaceableText(text: string) {\n  const textWithIndex = useRepeatableSetIndexText(text)\n  const { formSubmissionModel, elements } = useFormSubmissionModel()\n  return React.useMemo(() => {\n    return localisationService.replaceInjectablesWithElementValues(\n      textWithIndex,\n      {\n        submission: formSubmissionModel,\n        formElements: elements,\n        userProfile: authService.getUserProfile() || undefined,\n      },\n    )\n  }, [elements, formSubmissionModel, textWithIndex])\n}\n"]}

package/dist/hooks/useSignUp.d.ts

@@ -1,3 +1,8 @@
+/**
+ * @param options
+ * @returns
+ * @group Hooks
+ */
 export default function useSignUp({ formsAppId, username, firstName, lastName, }: {
     formsAppId: number;
     username: string;

package/dist/hooks/useSignUp.js

@@ -1,5 +1,10 @@
 import * as React from 'react';
 import { authService, Sentry } from '@oneblink/apps';
+/**
+ * @param options
+ * @returns
+ * @group Hooks
+ */
 export default function useSignUp({ formsAppId, username, firstName, lastName, }) {
     const usernameValidation = React.useMemo(() => {
         // regex source: https://www.w3resource.com/javascript/form/email-validation.php#:~:text=To%20get%20a%20valid%20email,%5D%2B)*%24%2F.

package/dist/hooks/useSignUp.js.map

@@ -1 +1 @@
-{"version":3,"file":"useSignUp.js","sourceRoot":"","sources":["../../src/hooks/useSignUp.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAEpD,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,EAChC,UAAU,EACV,QAAQ,EACR,SAAS,EACT,QAAQ,GAMT;IACC,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QAC5C,qIAAqI;QACrI,OAAO;YACL,SAAS,EAAE,CAAC,QAAQ,CAAC,KAAK,CACxB,sEAAsE,CACvE;SACF,CAAA;IACH,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAA;IAEd,MAAM,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE,cAAc,CAAC,GAClE,KAAK,CAAC,QAAQ,CAIX;QACD,WAAW,EAAE,KAAK;QAClB,WAAW,EAAE,IAAI;QACjB,cAAc,EAAE,KAAK;KACtB,CAAC,CAAA;IAEJ,MAAM,gBAAgB,GAAG,KAAK,CAAC,WAAW,CACxC,GAAG,EAAE,CACH,cAAc,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC3B,GAAG,OAAO;QACV,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC,EACL,EAAE,CACH,CAAA;IAED,MAAM,qBAAqB,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;QACzD,IAAI,kBAAkB,CAAC,SAAS,EAAE;YAChC,cAAc,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBAC3B,GAAG,OAAO;gBACV,WAAW,EAAE,IAAI,KAAK,CAAC,oCAAoC,CAAC;aAC7D,CAAC,CAAC,CAAA;YACH,OAAM;SACP;QAED,cAAc,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAChC,GAAG,YAAY;YACf,WAAW,EAAE,IAAI;YACjB,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC,CAAA;QAEH,IAAI;YACF,MAAM,WAAW,CAAC,MAAM,CAAC;gBACvB,UAAU;gBACV,KAAK,EAAE,QAAQ;gBACf,SAAS;gBACT,QAAQ;aACT,CAAC,CAAA;YAEF,cAAc,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBAChC,GAAG,YAAY;gBACf,WAAW,EAAE,KAAK;gBAClB,cAAc,EAAE,IAAI;aACrB,CAAC,CAAC,CAAA;SACJ;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAC9B,cAAc,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBAChC,GAAG,YAAY;gBACf,WAAW,EAAE,KAAK;gBAClB,WAAW,EAAE,KAAc;aAC5B,CAAC,CAAC,CAAA;SACJ;IACH,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAA;IAE7E,OAAO;QACL,qBAAqB;QACrB,gBAAgB;QAChB,WAAW;QACX,WAAW;QACX,cAAc;QACd,kBAAkB;KACnB,CAAA;AACH,CAAC","sourcesContent":["import * as React from 'react'\nimport { authService, Sentry } from '@oneblink/apps'\n\nexport default function useSignUp({\n  formsAppId,\n  username,\n  firstName,\n  lastName,\n}: {\n  formsAppId: number\n  username: string\n  firstName?: string\n  lastName?: string\n}) {\n  const usernameValidation = React.useMemo(() => {\n    // regex source: https://www.w3resource.com/javascript/form/email-validation.php#:~:text=To%20get%20a%20valid%20email,%5D%2B)*%24%2F.\n    return {\n      isInvalid: !username.match(\n        /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$/,\n      ),\n    }\n  }, [username])\n\n  const [{ isSigningUp, signUpError, signUpComplete }, setSignUpState] =\n    React.useState<{\n      isSigningUp: boolean\n      signUpError: Error | null\n      signUpComplete: boolean\n    }>({\n      isSigningUp: false,\n      signUpError: null,\n      signUpComplete: false,\n    })\n\n  const clearSignUpError = React.useCallback(\n    () =>\n      setSignUpState((current) => ({\n        ...current,\n        signUpError: null,\n      })),\n    [],\n  )\n\n  const signUpWithUserDetails = React.useCallback(async () => {\n    if (usernameValidation.isInvalid) {\n      setSignUpState((current) => ({\n        ...current,\n        signUpError: new Error('Please enter a valid email address'),\n      }))\n      return\n    }\n\n    setSignUpState((currentState) => ({\n      ...currentState,\n      isSigningUp: true,\n      signUpError: null,\n    }))\n\n    try {\n      await authService.signUp({\n        formsAppId,\n        email: username,\n        firstName,\n        lastName,\n      })\n\n      setSignUpState((currentState) => ({\n        ...currentState,\n        isSigningUp: false,\n        signUpComplete: true,\n      }))\n    } catch (error) {\n      Sentry.captureException(error)\n      setSignUpState((currentState) => ({\n        ...currentState,\n        isSigningUp: false,\n        signUpError: error as Error,\n      }))\n    }\n  }, [firstName, formsAppId, lastName, username, usernameValidation.isInvalid])\n\n  return {\n    signUpWithUserDetails,\n    clearSignUpError,\n    isSigningUp,\n    signUpError,\n    signUpComplete,\n    usernameValidation,\n  }\n}\n"]}
+{"version":3,"file":"useSignUp.js","sourceRoot":"","sources":["../../src/hooks/useSignUp.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAEpD;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,EAChC,UAAU,EACV,QAAQ,EACR,SAAS,EACT,QAAQ,GAMT;IACC,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QAC5C,qIAAqI;QACrI,OAAO;YACL,SAAS,EAAE,CAAC,QAAQ,CAAC,KAAK,CACxB,sEAAsE,CACvE;SACF,CAAA;IACH,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAA;IAEd,MAAM,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE,cAAc,CAAC,GAClE,KAAK,CAAC,QAAQ,CAIX;QACD,WAAW,EAAE,KAAK;QAClB,WAAW,EAAE,IAAI;QACjB,cAAc,EAAE,KAAK;KACtB,CAAC,CAAA;IAEJ,MAAM,gBAAgB,GAAG,KAAK,CAAC,WAAW,CACxC,GAAG,EAAE,CACH,cAAc,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC3B,GAAG,OAAO;QACV,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC,EACL,EAAE,CACH,CAAA;IAED,MAAM,qBAAqB,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;QACzD,IAAI,kBAAkB,CAAC,SAAS,EAAE;YAChC,cAAc,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBAC3B,GAAG,OAAO;gBACV,WAAW,EAAE,IAAI,KAAK,CAAC,oCAAoC,CAAC;aAC7D,CAAC,CAAC,CAAA;YACH,OAAM;SACP;QAED,cAAc,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAChC,GAAG,YAAY;YACf,WAAW,EAAE,IAAI;YACjB,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC,CAAA;QAEH,IAAI;YACF,MAAM,WAAW,CAAC,MAAM,CAAC;gBACvB,UAAU;gBACV,KAAK,EAAE,QAAQ;gBACf,SAAS;gBACT,QAAQ;aACT,CAAC,CAAA;YAEF,cAAc,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBAChC,GAAG,YAAY;gBACf,WAAW,EAAE,KAAK;gBAClB,cAAc,EAAE,IAAI;aACrB,CAAC,CAAC,CAAA;SACJ;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAC9B,cAAc,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBAChC,GAAG,YAAY;gBACf,WAAW,EAAE,KAAK;gBAClB,WAAW,EAAE,KAAc;aAC5B,CAAC,CAAC,CAAA;SACJ;IACH,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAA;IAE7E,OAAO;QACL,qBAAqB;QACrB,gBAAgB;QAChB,WAAW;QACX,WAAW;QACX,cAAc;QACd,kBAAkB;KACnB,CAAA;AACH,CAAC","sourcesContent":["import * as React from 'react'\nimport { authService, Sentry } from '@oneblink/apps'\n\n/**\n * @param options\n * @returns\n * @group Hooks\n */\nexport default function useSignUp({\n  formsAppId,\n  username,\n  firstName,\n  lastName,\n}: {\n  formsAppId: number\n  username: string\n  firstName?: string\n  lastName?: string\n}) {\n  const usernameValidation = React.useMemo(() => {\n    // regex source: https://www.w3resource.com/javascript/form/email-validation.php#:~:text=To%20get%20a%20valid%20email,%5D%2B)*%24%2F.\n    return {\n      isInvalid: !username.match(\n        /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$/,\n      ),\n    }\n  }, [username])\n\n  const [{ isSigningUp, signUpError, signUpComplete }, setSignUpState] =\n    React.useState<{\n      isSigningUp: boolean\n      signUpError: Error | null\n      signUpComplete: boolean\n    }>({\n      isSigningUp: false,\n      signUpError: null,\n      signUpComplete: false,\n    })\n\n  const clearSignUpError = React.useCallback(\n    () =>\n      setSignUpState((current) => ({\n        ...current,\n        signUpError: null,\n      })),\n    [],\n  )\n\n  const signUpWithUserDetails = React.useCallback(async () => {\n    if (usernameValidation.isInvalid) {\n      setSignUpState((current) => ({\n        ...current,\n        signUpError: new Error('Please enter a valid email address'),\n      }))\n      return\n    }\n\n    setSignUpState((currentState) => ({\n      ...currentState,\n      isSigningUp: true,\n      signUpError: null,\n    }))\n\n    try {\n      await authService.signUp({\n        formsAppId,\n        email: username,\n        firstName,\n        lastName,\n      })\n\n      setSignUpState((currentState) => ({\n        ...currentState,\n        isSigningUp: false,\n        signUpComplete: true,\n      }))\n    } catch (error) {\n      Sentry.captureException(error)\n      setSignUpState((currentState) => ({\n        ...currentState,\n        isSigningUp: false,\n        signUpError: error as Error,\n      }))\n    }\n  }, [firstName, formsAppId, lastName, username, usernameValidation.isInvalid])\n\n  return {\n    signUpWithUserDetails,\n    clearSignUpError,\n    isSigningUp,\n    signUpError,\n    signUpComplete,\n    usernameValidation,\n  }\n}\n"]}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { OneBlinkFormUncontrolled as OneBlinkForm, OneBlinkFormControlled, } from './OneBlinkForm';
+export { OneBlinkFormBaseProps, OneBlinkFormControlledProps, OneBlinkFormUncontrolled as OneBlinkForm, OneBlinkFormControlled, } from './OneBlinkForm';
 export { default as OneBlinkAutoSaveForm } from './OneBlinkAutoSaveForm';
 export { default as OneBlinkReadOnlyForm } from './OneBlinkReadOnlyForm';
 export { OneBlinkFormStoreProvider } from './components/formStore/OneBlinkFormStoreProvider';
@@ -12,10 +12,12 @@ export { default as useBooleanState } from './hooks/useBooleanState';
 export { default as useNullableState } from './hooks/useNullableState';
 export { default as useClickOutsideElement } from './hooks/useClickOutsideElement';
 export { default as useIsOffline, IsOfflineContextProvider, } from './hooks/useIsOffline';
-export { default as useLogin } from './hooks/useLogin';
+export { default as useLogin, UseLoginValue } from './hooks/useLogin';
 export { default as useSignUp } from './hooks/useSignUp';
-export { default as useAuth, AuthContextProvider } from './hooks/useAuth';
-export { default as useLoadDataState } from './hooks/useLoadDataState';
+export { default as useAuth, AuthContextProvider, AuthContextValue, } from './hooks/useAuth';
+export { default as usePendingSubmissions, PendingSubmissionsContextProvider, PendingSubmissionsContextValue, } from './hooks/usePendingSubmissions';
+export { default as useDrafts, DraftsContextProvider, DraftsContextValue, } from './hooks/useDrafts';
+export { default as useLoadDataState, LoadDataState, } from './hooks/useLoadDataState';
 export { default as useFormSubmissionState } from './hooks/useFormSubmissionState';
 export { default as useFormSubmissionAutoSaveState } from './hooks/useFormSubmissionAutoSaveState';
 export { default as MuiV4CompatibleDatePicker } from './components/pickers/V4CompatibleDatePicker';
@@ -23,3 +25,4 @@ export { default as MuiV4CompatibleDateTimePicker } from './components/pickers/V
 export { default as MuiV4CompatibleTimePicker } from './components/pickers/V4CompatibleTimePicker';
 export { default as ProgressBar } from './components/renderer/ProgressBar';
 export { default as PaymentReceipt } from './PaymentReceipt';
+export * from './types/form';

package/dist/index.js

@@ -14,8 +14,10 @@ export { default as useClickOutsideElement } from './hooks/useClickOutsideElemen
 export { default as useIsOffline, IsOfflineContextProvider, } from './hooks/useIsOffline';
 export { default as useLogin } from './hooks/useLogin';
 export { default as useSignUp } from './hooks/useSignUp';
-export { default as useAuth, AuthContextProvider } from './hooks/useAuth';
-export { default as useLoadDataState } from './hooks/useLoadDataState';
+export { default as useAuth, AuthContextProvider, } from './hooks/useAuth';
+export { default as usePendingSubmissions, PendingSubmissionsContextProvider, } from './hooks/usePendingSubmissions';
+export { default as useDrafts, DraftsContextProvider, } from './hooks/useDrafts';
+export { default as useLoadDataState, } from './hooks/useLoadDataState';
 export { default as useFormSubmissionState } from './hooks/useFormSubmissionState';
 export { default as useFormSubmissionAutoSaveState } from './hooks/useFormSubmissionAutoSaveState';
 export { default as MuiV4CompatibleDatePicker } from './components/pickers/V4CompatibleDatePicker';
@@ -23,4 +25,5 @@ export { default as MuiV4CompatibleDateTimePicker } from './components/pickers/V
 export { default as MuiV4CompatibleTimePicker } from './components/pickers/V4CompatibleTimePicker';
 export { default as ProgressBar } from './components/renderer/ProgressBar';
 export { default as PaymentReceipt } from './PaymentReceipt';
+export * from './types/form';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,IAAI,YAAY,EACxC,sBAAsB,GACvB,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AACxE,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AACxE,OAAO,EAAE,yBAAyB,EAAE,MAAM,kDAAkD,CAAA;AAC5F,OAAO,EAAE,OAAO,IAAI,mCAAmC,EAAE,MAAM,4DAA4D,CAAA;AAC3H,OAAO,EAAE,OAAO,IAAI,8BAA8B,EAAE,MAAM,uDAAuD,CAAA;AACjH,OAAO,EAAE,OAAO,IAAI,+BAA+B,EAAE,MAAM,wDAAwD,CAAA;AACnH,OAAO,EAAE,OAAO,IAAI,8BAA8B,EAAE,MAAM,uDAAuD,CAAA;AACjH,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,+CAA+C,CAAA;AAEjG,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACpE,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AACtE,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,gCAAgC,CAAA;AAClF,OAAO,EACL,OAAO,IAAI,YAAY,EACvB,wBAAwB,GACzB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AACzE,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AACtE,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,gCAAgC,CAAA;AAClF,OAAO,EAAE,OAAO,IAAI,8BAA8B,EAAE,MAAM,wCAAwC,CAAA;AAElG,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,MAAM,6CAA6C,CAAA;AAClG,OAAO,EAAE,OAAO,IAAI,6BAA6B,EAAE,MAAM,iDAAiD,CAAA;AAC1G,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,MAAM,6CAA6C,CAAA;AAClG,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,mCAAmC,CAAA;AAC1E,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAA","sourcesContent":["export {\n  OneBlinkFormUncontrolled as OneBlinkForm,\n  OneBlinkFormControlled,\n} from './OneBlinkForm'\nexport { default as OneBlinkAutoSaveForm } from './OneBlinkAutoSaveForm'\nexport { default as OneBlinkReadOnlyForm } from './OneBlinkReadOnlyForm'\nexport { OneBlinkFormStoreProvider } from './components/formStore/OneBlinkFormStoreProvider'\nexport { default as OneBlinkFormStoreClearFiltersButton } from './components/formStore/OneBlinkFormStoreClearFiltersButton'\nexport { default as OneBlinkFormStoreColumnsButton } from './components/formStore/OneBlinkFormStoreColumnsButton'\nexport { default as OneBlinkFormStoreDownloadButton } from './components/formStore/OneBlinkFormStoreDownloadButton'\nexport { default as OneBlinkFormStoreRefreshButton } from './components/formStore/OneBlinkFormStoreRefreshButton'\nexport { default as OneBlinkFormStoreTable } from './components/formStore/OneBlinkFormStoreTable'\n\nexport { default as useIsMounted } from './hooks/useIsMounted'\nexport { default as useBooleanState } from './hooks/useBooleanState'\nexport { default as useNullableState } from './hooks/useNullableState'\nexport { default as useClickOutsideElement } from './hooks/useClickOutsideElement'\nexport {\n  default as useIsOffline,\n  IsOfflineContextProvider,\n} from './hooks/useIsOffline'\nexport { default as useLogin } from './hooks/useLogin'\nexport { default as useSignUp } from './hooks/useSignUp'\nexport { default as useAuth, AuthContextProvider } from './hooks/useAuth'\nexport { default as useLoadDataState } from './hooks/useLoadDataState'\nexport { default as useFormSubmissionState } from './hooks/useFormSubmissionState'\nexport { default as useFormSubmissionAutoSaveState } from './hooks/useFormSubmissionAutoSaveState'\n\nexport { default as MuiV4CompatibleDatePicker } from './components/pickers/V4CompatibleDatePicker'\nexport { default as MuiV4CompatibleDateTimePicker } from './components/pickers/V4CompatibleDateTimePicker'\nexport { default as MuiV4CompatibleTimePicker } from './components/pickers/V4CompatibleTimePicker'\nexport { default as ProgressBar } from './components/renderer/ProgressBar'\nexport { default as PaymentReceipt } from './PaymentReceipt'\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,wBAAwB,IAAI,YAAY,EACxC,sBAAsB,GACvB,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AACxE,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AACxE,OAAO,EAAE,yBAAyB,EAAE,MAAM,kDAAkD,CAAA;AAC5F,OAAO,EAAE,OAAO,IAAI,mCAAmC,EAAE,MAAM,4DAA4D,CAAA;AAC3H,OAAO,EAAE,OAAO,IAAI,8BAA8B,EAAE,MAAM,uDAAuD,CAAA;AACjH,OAAO,EAAE,OAAO,IAAI,+BAA+B,EAAE,MAAM,wDAAwD,CAAA;AACnH,OAAO,EAAE,OAAO,IAAI,8BAA8B,EAAE,MAAM,uDAAuD,CAAA;AACjH,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,+CAA+C,CAAA;AAEjG,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACpE,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AACtE,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,gCAAgC,CAAA;AAClF,OAAO,EACL,OAAO,IAAI,YAAY,EACvB,wBAAwB,GACzB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAiB,MAAM,kBAAkB,CAAA;AACrE,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,mBAAmB,GAEpB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,OAAO,IAAI,qBAAqB,EAChC,iCAAiC,GAElC,MAAM,+BAA+B,CAAA;AACtC,OAAO,EACL,OAAO,IAAI,SAAS,EACpB,qBAAqB,GAEtB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EACL,OAAO,IAAI,gBAAgB,GAE5B,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,gCAAgC,CAAA;AAClF,OAAO,EAAE,OAAO,IAAI,8BAA8B,EAAE,MAAM,wCAAwC,CAAA;AAElG,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,MAAM,6CAA6C,CAAA;AAClG,OAAO,EAAE,OAAO,IAAI,6BAA6B,EAAE,MAAM,iDAAiD,CAAA;AAC1G,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,MAAM,6CAA6C,CAAA;AAClG,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,mCAAmC,CAAA;AAC1E,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAE5D,cAAc,cAAc,CAAA","sourcesContent":["export {\n  OneBlinkFormBaseProps,\n  OneBlinkFormControlledProps,\n  OneBlinkFormUncontrolled as OneBlinkForm,\n  OneBlinkFormControlled,\n} from './OneBlinkForm'\nexport { default as OneBlinkAutoSaveForm } from './OneBlinkAutoSaveForm'\nexport { default as OneBlinkReadOnlyForm } from './OneBlinkReadOnlyForm'\nexport { OneBlinkFormStoreProvider } from './components/formStore/OneBlinkFormStoreProvider'\nexport { default as OneBlinkFormStoreClearFiltersButton } from './components/formStore/OneBlinkFormStoreClearFiltersButton'\nexport { default as OneBlinkFormStoreColumnsButton } from './components/formStore/OneBlinkFormStoreColumnsButton'\nexport { default as OneBlinkFormStoreDownloadButton } from './components/formStore/OneBlinkFormStoreDownloadButton'\nexport { default as OneBlinkFormStoreRefreshButton } from './components/formStore/OneBlinkFormStoreRefreshButton'\nexport { default as OneBlinkFormStoreTable } from './components/formStore/OneBlinkFormStoreTable'\n\nexport { default as useIsMounted } from './hooks/useIsMounted'\nexport { default as useBooleanState } from './hooks/useBooleanState'\nexport { default as useNullableState } from './hooks/useNullableState'\nexport { default as useClickOutsideElement } from './hooks/useClickOutsideElement'\nexport {\n  default as useIsOffline,\n  IsOfflineContextProvider,\n} from './hooks/useIsOffline'\nexport { default as useLogin, UseLoginValue } from './hooks/useLogin'\nexport { default as useSignUp } from './hooks/useSignUp'\nexport {\n  default as useAuth,\n  AuthContextProvider,\n  AuthContextValue,\n} from './hooks/useAuth'\nexport {\n  default as usePendingSubmissions,\n  PendingSubmissionsContextProvider,\n  PendingSubmissionsContextValue,\n} from './hooks/usePendingSubmissions'\nexport {\n  default as useDrafts,\n  DraftsContextProvider,\n  DraftsContextValue,\n} from './hooks/useDrafts'\nexport {\n  default as useLoadDataState,\n  LoadDataState,\n} from './hooks/useLoadDataState'\nexport { default as useFormSubmissionState } from './hooks/useFormSubmissionState'\nexport { default as useFormSubmissionAutoSaveState } from './hooks/useFormSubmissionAutoSaveState'\n\nexport { default as MuiV4CompatibleDatePicker } from './components/pickers/V4CompatibleDatePicker'\nexport { default as MuiV4CompatibleDateTimePicker } from './components/pickers/V4CompatibleDateTimePicker'\nexport { default as MuiV4CompatibleTimePicker } from './components/pickers/V4CompatibleTimePicker'\nexport { default as ProgressBar } from './components/renderer/ProgressBar'\nexport { default as PaymentReceipt } from './PaymentReceipt'\n\nexport * from './types/form'\n"]}

package/dist/services/checkBsbsAreInvalid.d.ts

@@ -1,3 +1,2 @@
-import { FormTypes } from '@oneblink/types';
-import { FormSubmissionModel } from '../types/form';
-export default function checkBsbsAreInvalid(form: FormTypes.Form, submission: FormSubmissionModel): boolean;
+import { FormTypes, SubmissionTypes } from '@oneblink/types';
+export default function checkBsbsAreInvalid(form: FormTypes.Form, submission: SubmissionTypes.S3SubmissionData['submission']): boolean;

package/dist/services/checkBsbsAreInvalid.js.map

@@ -1 +1 @@
-{"version":3,"file":"checkBsbsAreInvalid.js","sourceRoot":"","sources":["../../src/services/checkBsbsAreInvalid.ts"],"names":[],"mappings":"AAGA,SAAS,oCAAoC,CAC3C,YAAqC,EACrC,UAA+B;IAE/B,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;QACvC,QAAQ,WAAW,CAAC,IAAI,EAAE;YACxB,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC,CAAC;gBACX,OAAO,oCAAoC,CACzC,WAAW,CAAC,QAAQ,EACpB,UAAU,CACX,CAAA;aACF;YACD,KAAK,MAAM,CAAC,CAAC;gBACX,MAAM,gBAAgB,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBACrD,IAAI,CAAC,gBAAgB,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE;oBAC7D,MAAK;iBACN;gBACD,OAAO,oCAAoC,CACzC,WAAW,CAAC,QAAQ,IAAI,EAAE,EAC1B,gBAAuC,CACxC,CAAA;aACF;YACD,KAAK,eAAe,CAAC,CAAC;gBACpB,MAAM,OAAO,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBAC5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;oBAC3B,MAAK;iBACN;gBACD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC5B,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;wBACzB,oCAAoC,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAClE,CAAA;gBACH,CAAC,CAAC,CAAA;aACH;YACD,KAAK,KAAK,CAAC,CAAC;gBACV,MAAM,KAAK,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBAC1C,IAAI,CAAC,KAAK,EAAE;oBACV,MAAK;iBACN;gBACD,MAAM,QAAQ,GAAG,KAAwC,CAAA;gBACzD,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;oBAChC,OAAO,QAAQ,CAAC,SAAS,CAAA;iBAC1B;aACF;SACF;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,OAAO,UAAU,mBAAmB,CACzC,IAAoB,EACpB,UAA+B;IAE/B,OAAO,oCAAoC,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;AACxE,CAAC","sourcesContent":["import { FormTypes } from '@oneblink/types'\nimport { FormSubmissionModel } from '../types/form'\n\nfunction checkIfBsbsAreInvalidForFormElements(\n  formElements: FormTypes.FormElement[],\n  submission: FormSubmissionModel,\n): boolean {\n  return formElements.some((formElement) => {\n    switch (formElement.type) {\n      case 'section':\n      case 'page': {\n        return checkIfBsbsAreInvalidForFormElements(\n          formElement.elements,\n          submission,\n        )\n      }\n      case 'form': {\n        const nestedSubmission = submission[formElement.name]\n        if (!nestedSubmission || typeof nestedSubmission !== 'object') {\n          break\n        }\n        return checkIfBsbsAreInvalidForFormElements(\n          formElement.elements || [],\n          nestedSubmission as FormSubmissionModel,\n        )\n      }\n      case 'repeatableSet': {\n        const entries = submission[formElement.name]\n        if (!Array.isArray(entries)) {\n          break\n        }\n        return entries.some((entry) => {\n          return (\n            typeof entry === 'object' &&\n            checkIfBsbsAreInvalidForFormElements(formElement.elements, entry)\n          )\n        })\n      }\n      case 'bsb': {\n        const value = submission[formElement.name]\n        if (!value) {\n          break\n        }\n        const bsbValue = value as string | { isInvalid: boolean }\n        if (typeof bsbValue === 'object') {\n          return bsbValue.isInvalid\n        }\n      }\n    }\n  })\n}\n\nexport default function checkBsbsAreInvalid(\n  form: FormTypes.Form,\n  submission: FormSubmissionModel,\n): boolean {\n  return checkIfBsbsAreInvalidForFormElements(form.elements, submission)\n}\n"]}
+{"version":3,"file":"checkBsbsAreInvalid.js","sourceRoot":"","sources":["../../src/services/checkBsbsAreInvalid.ts"],"names":[],"mappings":"AAEA,SAAS,oCAAoC,CAC3C,YAAqC,EACrC,UAA0D;IAE1D,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;QACvC,QAAQ,WAAW,CAAC,IAAI,EAAE;YACxB,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC,CAAC;gBACX,OAAO,oCAAoC,CACzC,WAAW,CAAC,QAAQ,EACpB,UAAU,CACX,CAAA;aACF;YACD,KAAK,MAAM,CAAC,CAAC;gBACX,MAAM,gBAAgB,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBACrD,IAAI,CAAC,gBAAgB,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE;oBAC7D,MAAK;iBACN;gBACD,OAAO,oCAAoC,CACzC,WAAW,CAAC,QAAQ,IAAI,EAAE,EAC1B,gBAAkE,CACnE,CAAA;aACF;YACD,KAAK,eAAe,CAAC,CAAC;gBACpB,MAAM,OAAO,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBAC5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;oBAC3B,MAAK;iBACN;gBACD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC5B,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;wBACzB,oCAAoC,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAClE,CAAA;gBACH,CAAC,CAAC,CAAA;aACH;YACD,KAAK,KAAK,CAAC,CAAC;gBACV,MAAM,KAAK,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBAC1C,IAAI,CAAC,KAAK,EAAE;oBACV,MAAK;iBACN;gBACD,MAAM,QAAQ,GAAG,KAAwC,CAAA;gBACzD,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;oBAChC,OAAO,QAAQ,CAAC,SAAS,CAAA;iBAC1B;aACF;SACF;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,OAAO,UAAU,mBAAmB,CACzC,IAAoB,EACpB,UAA0D;IAE1D,OAAO,oCAAoC,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;AACxE,CAAC","sourcesContent":["import { FormTypes, SubmissionTypes } from '@oneblink/types'\n\nfunction checkIfBsbsAreInvalidForFormElements(\n  formElements: FormTypes.FormElement[],\n  submission: SubmissionTypes.S3SubmissionData['submission'],\n): boolean {\n  return formElements.some((formElement) => {\n    switch (formElement.type) {\n      case 'section':\n      case 'page': {\n        return checkIfBsbsAreInvalidForFormElements(\n          formElement.elements,\n          submission,\n        )\n      }\n      case 'form': {\n        const nestedSubmission = submission[formElement.name]\n        if (!nestedSubmission || typeof nestedSubmission !== 'object') {\n          break\n        }\n        return checkIfBsbsAreInvalidForFormElements(\n          formElement.elements || [],\n          nestedSubmission as SubmissionTypes.S3SubmissionData['submission'],\n        )\n      }\n      case 'repeatableSet': {\n        const entries = submission[formElement.name]\n        if (!Array.isArray(entries)) {\n          break\n        }\n        return entries.some((entry) => {\n          return (\n            typeof entry === 'object' &&\n            checkIfBsbsAreInvalidForFormElements(formElement.elements, entry)\n          )\n        })\n      }\n      case 'bsb': {\n        const value = submission[formElement.name]\n        if (!value) {\n          break\n        }\n        const bsbValue = value as string | { isInvalid: boolean }\n        if (typeof bsbValue === 'object') {\n          return bsbValue.isInvalid\n        }\n      }\n    }\n  })\n}\n\nexport default function checkBsbsAreInvalid(\n  form: FormTypes.Form,\n  submission: SubmissionTypes.S3SubmissionData['submission'],\n): boolean {\n  return checkIfBsbsAreInvalidForFormElements(form.elements, submission)\n}\n"]}

package/dist/services/checkIfAttachmentsExist.d.ts

@@ -1,5 +1,4 @@
-import { FormTypes } from '@oneblink/types';
+import { FormTypes, SubmissionTypes } from '@oneblink/types';
 import { attachmentsService } from '@oneblink/apps';
-import { FormSubmissionModel } from '../types/form';
 export declare function validateAttachmentExists(attachment: attachmentsService.Attachment, attachmentRetentionInDays: number | undefined): attachmentsService.AttachmentError | void;
-export default function checkIfAttachmentsExist(form: FormTypes.Form, submission: FormSubmissionModel, attachmentRetentionInDays: number | undefined): FormSubmissionModel | void;
+export default function checkIfAttachmentsExist(form: FormTypes.Form, submission: SubmissionTypes.S3SubmissionData['submission'], attachmentRetentionInDays: number | undefined): SubmissionTypes.S3SubmissionData['submission'] | void;

package/dist/services/checkIfAttachmentsExist.js.map

@@ -1 +1 @@
-{"version":3,"file":"checkIfAttachmentsExist.js","sourceRoot":"","sources":["../../src/services/checkIfAttachmentsExist.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAA;AAMjC,MAAM,UAAU,wBAAwB,CACtC,UAAyC,EACzC,yBAA6C;IAE7C,IAAI,UAAU,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,IAAI,CAAC,yBAAyB,EAAE;QAC3E,OAAM;KACP;IAED,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;IAClD,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;IACjD,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,yBAAyB,CAAC,CAAA;IACnE,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAA;IACtB,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE;QACjD,UAAU;QACV,SAAS;QACT,UAAU;KACX,CAAC,CAAA;IACF,6BAA6B;IAC7B,IAAI,SAAS,GAAG,GAAG,EAAE;QACnB,OAAM;KACP;IAED,MAAM,eAAe,GAAuC;QAC1D,IAAI,EAAE,OAAO;QACb,YAAY,EACV,6HAA6H;QAC/H,GAAG,EAAE,IAAI,EAAE;QACX,QAAQ,EAAE,UAAU,CAAC,QAAQ;QAC7B,SAAS,EAAE,UAAU,CAAC,SAAS;KAChC,CAAA;IACD,OAAO,eAAe,CAAA;AACxB,CAAC;AAED,SAAS,yBAAyB,CAChC,WAAoB,EACpB,yBAA6C;IAE7C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QAC/B,OAAM;KACP;IACD,MAAM,cAAc,GAAG,CAAC,GAAG,WAAW,CAAC,CAAA;IACvC,IAAI,UAAU,GAAG,KAAK,CAAA;IACtB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAC1D,MAAM,eAAe,GAAG,wBAAwB,CAC9C,cAAc,CAAC,KAAK,CAAkC,EACtD,yBAAyB,CAC1B,CAAA;QACD,IAAI,eAAe,EAAE;YACnB,UAAU,GAAG,IAAI,CAAA;YACjB,cAAc,CAAC,KAAK,CAAC,GAAG,eAAe,CAAA;SACxC;KACF;IACD,IAAI,UAAU,EAAE;QACd,OAAO,cAAc,CAAA;KACtB;AACH,CAAC;AAED,SAAS,sCAAsC,CAC7C,YAAqC,EACrC,UAA+B,EAC/B,yBAA6C;IAE7C,MAAM,MAAM,GAAwB;QAClC,GAAG,UAAU;KACd,CAAA;IACD,IAAI,UAAU,GAAG,KAAK,CAAA;IACtB,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACtC,QAAQ,WAAW,CAAC,IAAI,EAAE;YACxB,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC,CAAC;gBACX,MAAM,aAAa,GAAG,sCAAsC,CAC1D,WAAW,CAAC,QAAQ,EACpB,MAAM,EACN,yBAAyB,CAC1B,CAAA;gBACD,IAAI,aAAa,EAAE;oBACjB,UAAU,GAAG,IAAI,CAAA;oBACjB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;iBACrC;gBACD,MAAK;aACN;YACD,KAAK,MAAM,CAAC,CAAC;gBACX,MAAM,gBAAgB,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBACrD,IAAI,CAAC,gBAAgB,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE;oBAC7D,MAAK;iBACN;gBACD,MAAM,aAAa,GAAG,sCAAsC,CAC1D,WAAW,CAAC,QAAQ,IAAI,EAAE,EAC1B,gBAAuC,EACvC,yBAAyB,CAC1B,CAAA;gBACD,IAAI,aAAa,EAAE;oBACjB,UAAU,GAAG,IAAI,CAAA;oBACjB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,aAAa,CAAA;iBACzC;gBACD,MAAK;aACN;YACD,KAAK,eAAe,CAAC,CAAC;gBACpB,MAAM,OAAO,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBAC5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;oBAC3B,MAAK;iBACN;gBACD,MAAM,UAAU,GAAG,CAAC,GAAG,OAAO,CAAC,CAAA;gBAC/B,IAAI,eAAe,GAAG,KAAK,CAAA;gBAC3B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;oBACnD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAA;oBAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;wBAC7B,MAAM,QAAQ,GAAG,sCAAsC,CACrD,WAAW,CAAC,QAAQ,EACpB,KAAK,EACL,yBAAyB,CAC1B,CAAA;wBACD,IAAI,QAAQ,EAAE;4BACZ,eAAe,GAAG,IAAI,CAAA;4BACtB,UAAU,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAA;yBAC7B;qBACF;iBACF;gBACD,IAAI,eAAe,EAAE;oBACnB,UAAU,GAAG,IAAI,CAAA;oBACjB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,UAAU,CAAA;iBACtC;gBACD,MAAK;aACN;YACD,KAAK,QAAQ,CAAC;YACd,KAAK,MAAM,CAAC;YACZ,KAAK,YAAY,CAAC;YAClB,KAAK,OAAO,CAAC,CAAC;gBACZ,MAAM,KAAK,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBAC1C,IAAI,CAAC,KAAK,EAAE;oBACV,MAAK;iBACN;gBAED,8DAA8D;gBAC9D,QAAQ,WAAW,CAAC,IAAI,EAAE;oBACxB,KAAK,QAAQ,CAAC;oBACd,KAAK,MAAM,CAAC,CAAC;wBACX,MAAM,eAAe,GAAG,wBAAwB,CAC9C,KAAsC,EACtC,yBAAyB,CAC1B,CAAA;wBACD,IAAI,eAAe,EAAE;4BACnB,UAAU,GAAG,IAAI,CAAA;4BACjB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,eAAe,CAAA;yBAC3C;wBACD,MAAK;qBACN;oBACD,KAAK,YAAY,CAAC,CAAC;wBACjB,MAAM,cAAc,GAAG,yBAAyB,CAC7C,KAAoC,CAAC,KAAK,EAC3C,yBAAyB,CAC1B,CAAA;wBACD,IAAI,cAAc,EAAE;4BAClB,UAAU,GAAG,IAAI,CAAA;4BACjB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG;gCACzB,GAAI,KAAoC;gCACxC,KAAK,EAAE,cAAc;6BACtB,CAAA;yBACF;wBACD,MAAK;qBACN;oBACD,KAAK,OAAO,CAAC,CAAC;wBACZ,MAAM,cAAc,GAAG,yBAAyB,CAC9C,KAAK,EACL,yBAAyB,CAC1B,CAAA;wBACD,IAAI,cAAc,EAAE;4BAClB,UAAU,GAAG,IAAI,CAAA;4BACjB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,cAAc,CAAA;yBAC1C;wBACD,MAAK;qBACN;iBACF;aACF;SACF;KACF;IACD,IAAI,UAAU,EAAE;QACd,OAAO,MAAM,CAAA;KACd;AACH,CAAC;AAED,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAC7C,IAAoB,EACpB,UAA+B,EAC/B,yBAA6C;IAE7C,OAAO,sCAAsC,CAC3C,IAAI,CAAC,QAAQ,EACb,UAAU,EACV,yBAAyB,CAC1B,CAAA;AACH,CAAC","sourcesContent":["import { FormTypes } from '@oneblink/types'\nimport { v4 as uuid } from 'uuid'\nimport { attachmentsService } from '@oneblink/apps'\n\nimport { Value as FormElementComplianceValue } from '../form-elements/FormElementCompliance'\nimport { FormSubmissionModel } from '../types/form'\n\nexport function validateAttachmentExists(\n  attachment: attachmentsService.Attachment,\n  attachmentRetentionInDays: number | undefined,\n): attachmentsService.AttachmentError | void {\n  if (attachment.type || !attachment.uploadedAt || !attachmentRetentionInDays) {\n    return\n  }\n\n  const uploadedAt = new Date(attachment.uploadedAt)\n  const expiresAt = new Date(attachment.uploadedAt)\n  expiresAt.setDate(uploadedAt.getDate() + attachmentRetentionInDays)\n  const now = new Date()\n  console.log('Checking if attachment still exists', {\n    uploadedAt,\n    expiresAt,\n    attachment,\n  })\n  // check if attachment exists\n  if (expiresAt > now) {\n    return\n  }\n\n  const attachmentError: attachmentsService.AttachmentError = {\n    type: 'ERROR',\n    errorMessage:\n      \"This attachment has been removed based on your administrator's data retention policy, please remove it and upload it again.\",\n    _id: uuid(),\n    fileName: attachment.fileName,\n    isPrivate: attachment.isPrivate,\n  }\n  return attachmentError\n}\n\nfunction validateAttachmentsExists(\n  attachments: unknown,\n  attachmentRetentionInDays: number | undefined,\n): attachmentsService.Attachment[] | void {\n  if (!Array.isArray(attachments)) {\n    return\n  }\n  const newAttachments = [...attachments]\n  let hasChanges = false\n  for (let index = 0; index < newAttachments.length; index++) {\n    const attachmentError = validateAttachmentExists(\n      newAttachments[index] as attachmentsService.Attachment,\n      attachmentRetentionInDays,\n    )\n    if (attachmentError) {\n      hasChanges = true\n      newAttachments[index] = attachmentError\n    }\n  }\n  if (hasChanges) {\n    return newAttachments\n  }\n}\n\nfunction checkIfAttachmentsExistForFormElements(\n  formElements: FormTypes.FormElement[],\n  submission: FormSubmissionModel,\n  attachmentRetentionInDays: number | undefined,\n): FormSubmissionModel | void {\n  const result: FormSubmissionModel = {\n    ...submission,\n  }\n  let hasChanges = false\n  for (const formElement of formElements) {\n    switch (formElement.type) {\n      case 'section':\n      case 'page': {\n        const newSubmission = checkIfAttachmentsExistForFormElements(\n          formElement.elements,\n          result,\n          attachmentRetentionInDays,\n        )\n        if (newSubmission) {\n          hasChanges = true\n          Object.assign(result, newSubmission)\n        }\n        break\n      }\n      case 'form': {\n        const nestedSubmission = submission[formElement.name]\n        if (!nestedSubmission || typeof nestedSubmission !== 'object') {\n          break\n        }\n        const newSubmission = checkIfAttachmentsExistForFormElements(\n          formElement.elements || [],\n          nestedSubmission as FormSubmissionModel,\n          attachmentRetentionInDays,\n        )\n        if (newSubmission) {\n          hasChanges = true\n          result[formElement.name] = newSubmission\n        }\n        break\n      }\n      case 'repeatableSet': {\n        const entries = submission[formElement.name]\n        if (!Array.isArray(entries)) {\n          break\n        }\n        const newEntries = [...entries]\n        let hasEntryChanges = false\n        for (let index = 0; index < entries.length; index++) {\n          const entry = entries[index]\n          if (typeof entry === 'object') {\n            const newEntry = checkIfAttachmentsExistForFormElements(\n              formElement.elements,\n              entry,\n              attachmentRetentionInDays,\n            )\n            if (newEntry) {\n              hasEntryChanges = true\n              newEntries[index] = newEntry\n            }\n          }\n        }\n        if (hasEntryChanges) {\n          hasChanges = true\n          result[formElement.name] = newEntries\n        }\n        break\n      }\n      case 'camera':\n      case 'draw':\n      case 'compliance':\n      case 'files': {\n        const value = submission[formElement.name]\n        if (!value) {\n          break\n        }\n\n        // If the attachment has a type, it has not finished uploading\n        switch (formElement.type) {\n          case 'camera':\n          case 'draw': {\n            const attachmentError = validateAttachmentExists(\n              value as attachmentsService.Attachment,\n              attachmentRetentionInDays,\n            )\n            if (attachmentError) {\n              hasChanges = true\n              result[formElement.name] = attachmentError\n            }\n            break\n          }\n          case 'compliance': {\n            const newAttachments = validateAttachmentsExists(\n              (value as FormElementComplianceValue).files,\n              attachmentRetentionInDays,\n            )\n            if (newAttachments) {\n              hasChanges = true\n              result[formElement.name] = {\n                ...(value as FormElementComplianceValue),\n                files: newAttachments,\n              }\n            }\n            break\n          }\n          case 'files': {\n            const newAttachments = validateAttachmentsExists(\n              value,\n              attachmentRetentionInDays,\n            )\n            if (newAttachments) {\n              hasChanges = true\n              result[formElement.name] = newAttachments\n            }\n            break\n          }\n        }\n      }\n    }\n  }\n  if (hasChanges) {\n    return result\n  }\n}\n\nexport default function checkIfAttachmentsExist(\n  form: FormTypes.Form,\n  submission: FormSubmissionModel,\n  attachmentRetentionInDays: number | undefined,\n): FormSubmissionModel | void {\n  return checkIfAttachmentsExistForFormElements(\n    form.elements,\n    submission,\n    attachmentRetentionInDays,\n  )\n}\n"]}
+{"version":3,"file":"checkIfAttachmentsExist.js","sourceRoot":"","sources":["../../src/services/checkIfAttachmentsExist.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAA;AAKjC,MAAM,UAAU,wBAAwB,CACtC,UAAyC,EACzC,yBAA6C;IAE7C,IAAI,UAAU,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,IAAI,CAAC,yBAAyB,EAAE;QAC3E,OAAM;KACP;IAED,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;IAClD,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;IACjD,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,yBAAyB,CAAC,CAAA;IACnE,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAA;IACtB,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE;QACjD,UAAU;QACV,SAAS;QACT,UAAU;KACX,CAAC,CAAA;IACF,6BAA6B;IAC7B,IAAI,SAAS,GAAG,GAAG,EAAE;QACnB,OAAM;KACP;IAED,MAAM,eAAe,GAAuC;QAC1D,IAAI,EAAE,OAAO;QACb,YAAY,EACV,6HAA6H;QAC/H,GAAG,EAAE,IAAI,EAAE;QACX,QAAQ,EAAE,UAAU,CAAC,QAAQ;QAC7B,SAAS,EAAE,UAAU,CAAC,SAAS;KAChC,CAAA;IACD,OAAO,eAAe,CAAA;AACxB,CAAC;AAED,SAAS,yBAAyB,CAChC,WAAoB,EACpB,yBAA6C;IAE7C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QAC/B,OAAM;KACP;IACD,MAAM,cAAc,GAAG,CAAC,GAAG,WAAW,CAAC,CAAA;IACvC,IAAI,UAAU,GAAG,KAAK,CAAA;IACtB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAC1D,MAAM,eAAe,GAAG,wBAAwB,CAC9C,cAAc,CAAC,KAAK,CAAkC,EACtD,yBAAyB,CAC1B,CAAA;QACD,IAAI,eAAe,EAAE;YACnB,UAAU,GAAG,IAAI,CAAA;YACjB,cAAc,CAAC,KAAK,CAAC,GAAG,eAAe,CAAA;SACxC;KACF;IACD,IAAI,UAAU,EAAE;QACd,OAAO,cAAc,CAAA;KACtB;AACH,CAAC;AAED,SAAS,sCAAsC,CAC7C,YAAqC,EACrC,UAA0D,EAC1D,yBAA6C;IAE7C,MAAM,MAAM,GAAmD;QAC7D,GAAG,UAAU;KACd,CAAA;IACD,IAAI,UAAU,GAAG,KAAK,CAAA;IACtB,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACtC,QAAQ,WAAW,CAAC,IAAI,EAAE;YACxB,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC,CAAC;gBACX,MAAM,aAAa,GAAG,sCAAsC,CAC1D,WAAW,CAAC,QAAQ,EACpB,MAAM,EACN,yBAAyB,CAC1B,CAAA;gBACD,IAAI,aAAa,EAAE;oBACjB,UAAU,GAAG,IAAI,CAAA;oBACjB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;iBACrC;gBACD,MAAK;aACN;YACD,KAAK,MAAM,CAAC,CAAC;gBACX,MAAM,gBAAgB,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBACrD,IAAI,CAAC,gBAAgB,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE;oBAC7D,MAAK;iBACN;gBACD,MAAM,aAAa,GAAG,sCAAsC,CAC1D,WAAW,CAAC,QAAQ,IAAI,EAAE,EAC1B,gBAAkE,EAClE,yBAAyB,CAC1B,CAAA;gBACD,IAAI,aAAa,EAAE;oBACjB,UAAU,GAAG,IAAI,CAAA;oBACjB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,aAAa,CAAA;iBACzC;gBACD,MAAK;aACN;YACD,KAAK,eAAe,CAAC,CAAC;gBACpB,MAAM,OAAO,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBAC5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;oBAC3B,MAAK;iBACN;gBACD,MAAM,UAAU,GAAG,CAAC,GAAG,OAAO,CAAC,CAAA;gBAC/B,IAAI,eAAe,GAAG,KAAK,CAAA;gBAC3B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;oBACnD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAA;oBAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;wBAC7B,MAAM,QAAQ,GAAG,sCAAsC,CACrD,WAAW,CAAC,QAAQ,EACpB,KAAK,EACL,yBAAyB,CAC1B,CAAA;wBACD,IAAI,QAAQ,EAAE;4BACZ,eAAe,GAAG,IAAI,CAAA;4BACtB,UAAU,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAA;yBAC7B;qBACF;iBACF;gBACD,IAAI,eAAe,EAAE;oBACnB,UAAU,GAAG,IAAI,CAAA;oBACjB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,UAAU,CAAA;iBACtC;gBACD,MAAK;aACN;YACD,KAAK,QAAQ,CAAC;YACd,KAAK,MAAM,CAAC;YACZ,KAAK,YAAY,CAAC;YAClB,KAAK,OAAO,CAAC,CAAC;gBACZ,MAAM,KAAK,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBAC1C,IAAI,CAAC,KAAK,EAAE;oBACV,MAAK;iBACN;gBAED,8DAA8D;gBAC9D,QAAQ,WAAW,CAAC,IAAI,EAAE;oBACxB,KAAK,QAAQ,CAAC;oBACd,KAAK,MAAM,CAAC,CAAC;wBACX,MAAM,eAAe,GAAG,wBAAwB,CAC9C,KAAsC,EACtC,yBAAyB,CAC1B,CAAA;wBACD,IAAI,eAAe,EAAE;4BACnB,UAAU,GAAG,IAAI,CAAA;4BACjB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,eAAe,CAAA;yBAC3C;wBACD,MAAK;qBACN;oBACD,KAAK,YAAY,CAAC,CAAC;wBACjB,MAAM,cAAc,GAAG,yBAAyB,CAC7C,KAAoC,CAAC,KAAK,EAC3C,yBAAyB,CAC1B,CAAA;wBACD,IAAI,cAAc,EAAE;4BAClB,UAAU,GAAG,IAAI,CAAA;4BACjB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG;gCACzB,GAAI,KAAoC;gCACxC,KAAK,EAAE,cAAc;6BACtB,CAAA;yBACF;wBACD,MAAK;qBACN;oBACD,KAAK,OAAO,CAAC,CAAC;wBACZ,MAAM,cAAc,GAAG,yBAAyB,CAC9C,KAAK,EACL,yBAAyB,CAC1B,CAAA;wBACD,IAAI,cAAc,EAAE;4BAClB,UAAU,GAAG,IAAI,CAAA;4BACjB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,cAAc,CAAA;yBAC1C;wBACD,MAAK;qBACN;iBACF;aACF;SACF;KACF;IACD,IAAI,UAAU,EAAE;QACd,OAAO,MAAM,CAAA;KACd;AACH,CAAC;AAED,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAC7C,IAAoB,EACpB,UAA0D,EAC1D,yBAA6C;IAE7C,OAAO,sCAAsC,CAC3C,IAAI,CAAC,QAAQ,EACb,UAAU,EACV,yBAAyB,CAC1B,CAAA;AACH,CAAC","sourcesContent":["import { FormTypes, SubmissionTypes } from '@oneblink/types'\nimport { v4 as uuid } from 'uuid'\nimport { attachmentsService } from '@oneblink/apps'\n\nimport { Value as FormElementComplianceValue } from '../form-elements/FormElementCompliance'\n\nexport function validateAttachmentExists(\n  attachment: attachmentsService.Attachment,\n  attachmentRetentionInDays: number | undefined,\n): attachmentsService.AttachmentError | void {\n  if (attachment.type || !attachment.uploadedAt || !attachmentRetentionInDays) {\n    return\n  }\n\n  const uploadedAt = new Date(attachment.uploadedAt)\n  const expiresAt = new Date(attachment.uploadedAt)\n  expiresAt.setDate(uploadedAt.getDate() + attachmentRetentionInDays)\n  const now = new Date()\n  console.log('Checking if attachment still exists', {\n    uploadedAt,\n    expiresAt,\n    attachment,\n  })\n  // check if attachment exists\n  if (expiresAt > now) {\n    return\n  }\n\n  const attachmentError: attachmentsService.AttachmentError = {\n    type: 'ERROR',\n    errorMessage:\n      \"This attachment has been removed based on your administrator's data retention policy, please remove it and upload it again.\",\n    _id: uuid(),\n    fileName: attachment.fileName,\n    isPrivate: attachment.isPrivate,\n  }\n  return attachmentError\n}\n\nfunction validateAttachmentsExists(\n  attachments: unknown,\n  attachmentRetentionInDays: number | undefined,\n): attachmentsService.Attachment[] | void {\n  if (!Array.isArray(attachments)) {\n    return\n  }\n  const newAttachments = [...attachments]\n  let hasChanges = false\n  for (let index = 0; index < newAttachments.length; index++) {\n    const attachmentError = validateAttachmentExists(\n      newAttachments[index] as attachmentsService.Attachment,\n      attachmentRetentionInDays,\n    )\n    if (attachmentError) {\n      hasChanges = true\n      newAttachments[index] = attachmentError\n    }\n  }\n  if (hasChanges) {\n    return newAttachments\n  }\n}\n\nfunction checkIfAttachmentsExistForFormElements(\n  formElements: FormTypes.FormElement[],\n  submission: SubmissionTypes.S3SubmissionData['submission'],\n  attachmentRetentionInDays: number | undefined,\n): SubmissionTypes.S3SubmissionData['submission'] | void {\n  const result: SubmissionTypes.S3SubmissionData['submission'] = {\n    ...submission,\n  }\n  let hasChanges = false\n  for (const formElement of formElements) {\n    switch (formElement.type) {\n      case 'section':\n      case 'page': {\n        const newSubmission = checkIfAttachmentsExistForFormElements(\n          formElement.elements,\n          result,\n          attachmentRetentionInDays,\n        )\n        if (newSubmission) {\n          hasChanges = true\n          Object.assign(result, newSubmission)\n        }\n        break\n      }\n      case 'form': {\n        const nestedSubmission = submission[formElement.name]\n        if (!nestedSubmission || typeof nestedSubmission !== 'object') {\n          break\n        }\n        const newSubmission = checkIfAttachmentsExistForFormElements(\n          formElement.elements || [],\n          nestedSubmission as SubmissionTypes.S3SubmissionData['submission'],\n          attachmentRetentionInDays,\n        )\n        if (newSubmission) {\n          hasChanges = true\n          result[formElement.name] = newSubmission\n        }\n        break\n      }\n      case 'repeatableSet': {\n        const entries = submission[formElement.name]\n        if (!Array.isArray(entries)) {\n          break\n        }\n        const newEntries = [...entries]\n        let hasEntryChanges = false\n        for (let index = 0; index < entries.length; index++) {\n          const entry = entries[index]\n          if (typeof entry === 'object') {\n            const newEntry = checkIfAttachmentsExistForFormElements(\n              formElement.elements,\n              entry,\n              attachmentRetentionInDays,\n            )\n            if (newEntry) {\n              hasEntryChanges = true\n              newEntries[index] = newEntry\n            }\n          }\n        }\n        if (hasEntryChanges) {\n          hasChanges = true\n          result[formElement.name] = newEntries\n        }\n        break\n      }\n      case 'camera':\n      case 'draw':\n      case 'compliance':\n      case 'files': {\n        const value = submission[formElement.name]\n        if (!value) {\n          break\n        }\n\n        // If the attachment has a type, it has not finished uploading\n        switch (formElement.type) {\n          case 'camera':\n          case 'draw': {\n            const attachmentError = validateAttachmentExists(\n              value as attachmentsService.Attachment,\n              attachmentRetentionInDays,\n            )\n            if (attachmentError) {\n              hasChanges = true\n              result[formElement.name] = attachmentError\n            }\n            break\n          }\n          case 'compliance': {\n            const newAttachments = validateAttachmentsExists(\n              (value as FormElementComplianceValue).files,\n              attachmentRetentionInDays,\n            )\n            if (newAttachments) {\n              hasChanges = true\n              result[formElement.name] = {\n                ...(value as FormElementComplianceValue),\n                files: newAttachments,\n              }\n            }\n            break\n          }\n          case 'files': {\n            const newAttachments = validateAttachmentsExists(\n              value,\n              attachmentRetentionInDays,\n            )\n            if (newAttachments) {\n              hasChanges = true\n              result[formElement.name] = newAttachments\n            }\n            break\n          }\n        }\n      }\n    }\n  }\n  if (hasChanges) {\n    return result\n  }\n}\n\nexport default function checkIfAttachmentsExist(\n  form: FormTypes.Form,\n  submission: SubmissionTypes.S3SubmissionData['submission'],\n  attachmentRetentionInDays: number | undefined,\n): SubmissionTypes.S3SubmissionData['submission'] | void {\n  return checkIfAttachmentsExistForFormElements(\n    form.elements,\n    submission,\n    attachmentRetentionInDays,\n  )\n}\n"]}

package/dist/services/checkIfBsbsAreValidating.d.ts

@@ -1,3 +1,2 @@
-import { FormTypes } from '@oneblink/types';
-import { FormSubmissionModel } from '../types/form';
-export default function checkIfBsbsAreValidating(form: FormTypes.Form, submission: FormSubmissionModel): boolean;
+import { FormTypes, SubmissionTypes } from '@oneblink/types';
+export default function checkIfBsbsAreValidating(form: FormTypes.Form, submission: SubmissionTypes.S3SubmissionData['submission']): boolean;