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

package/dist/apps/approvals-service.js

@@ -0,0 +1,987 @@
+import OneBlinkAppsError from './services/errors/oneBlinkAppsError';
+import { isOffline } from './offline-service';
+import { deleteRequest, getRequest, putRequest, searchRequest, postRequest, } from './services/fetch';
+import tenants from './tenants';
+import Sentry from './Sentry';
+/**
+ * Get an Object containing FormSubmissionApprovals assigned to the current user
+ * and the Form definitions in those approvals.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const {
+ *   formSubmissionApprovals,
+ *   formApprovalFlowInstances,
+ *   forms,
+ *   formSubmissionMeta,
+ * } = await approvalsService.getFormSubmissionApprovals(formAppId)
+ * ```
+ *
+ * @param formsAppId
+ * @param abortSignal
+ * @returns
+ */
+export async function getFormSubmissionApprovals(formsAppId, abortSignal) {
+    try {
+        return await getRequest(`${tenants.current.apiOrigin}/forms-apps/${formsAppId}/my-approvals`, abortSignal);
+    }
+    catch (err) {
+        Sentry.captureException(err);
+        console.error('Error retrieving form submission approvals', err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline and do not have a local copy of this app available, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot view your pending approvals without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this application. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * Get a single FormSubmissionApproval belonging to the given id.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formSubmissionApprovalId = 'd27966cc-128d-48a2-b681-6ad52012e113'
+ * const {
+ *   formSubmissionApproval,
+ *   formApprovalFlowInstance,
+ *   formSubmissionMeta,
+ *   form,
+ *   history,
+ * } = await approvalsService.getFormSubmissionApproval(
+ *   formSubmissionApprovalId,
+ * )
+ * ```
+ *
+ * @param formSubmissionApprovalId
+ * @param abortSignal
+ * @returns
+ */
+export async function getFormSubmissionApproval(formSubmissionApprovalId, abortSignal) {
+    try {
+        const result = await getRequest(`${tenants.current.apiOrigin}/form-submission-approvals/${formSubmissionApprovalId}`, abortSignal);
+        return result;
+    }
+    catch (err) {
+        Sentry.captureException(err);
+        console.error('Error retrieving form submission approval', err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline and do not have a local copy of this app available, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot action this pending submission without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this application. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * Update a single FormSubmissionApproval assigned to the current user.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formSubmissionApproval = {
+ *   id: 'd27966cc-128d-48a2-b681-6ad52012e113',
+ *   status: 'APPROVED',
+ *   username: 'email@example.com',
+ *   formApprovalFlowInstanceId: 1,
+ *   notificationEmailAddress: 'email@example.com',
+ *   notes: 'Great work!!!',
+ *   internalNotes: 'It was not really that great...',
+ *   cannedResponseKey: 'my_canned_response_key',
+ *   createdAt: '2021-02-21T22:57:56.257Z',
+ *   updatedAt: '2021-02-21T22:57:56.257Z',
+ * }
+ * const updatedFormSubmissionApproval =
+ *   await approvalsService.updateFormSubmissionApproval(
+ *     formSubmissionApproval,
+ *   )
+ * ```
+ *
+ * @param formSubmissionApproval
+ * @param abortSignal
+ * @returns
+ */
+export async function updateFormSubmissionApproval(formSubmissionApproval, abortSignal) {
+    try {
+        return await putRequest(`${tenants.current.apiOrigin}/form-submission-approvals/${formSubmissionApproval.id}`, formSubmissionApproval, abortSignal);
+    }
+    catch (err) {
+        Sentry.captureException(err);
+        console.error('Error updating form submission approval', err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot action this pending submission without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this application. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404:
+            case 409: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * @deprecated Use "reopenFormApprovalFlowInstance()" instead
+ * @internal
+ */
+export const reopenFormSubmissionApproval = reopenFormApprovalFlowInstance;
+/**
+ * As an administrator, reopen a submission that has been approved or denied.
+ *
+ * #### Example
+ *
+ * ```js
+ * await approvalsService.reopenFormApprovalFlowInstance({
+ *   formApprovalFlowInstanceId: 1,
+ *   notificationEmailAddress: 'email@example.com',
+ *   notes: 'Great work!!!',
+ *   internalNotes: 'It was not really that great...',
+ *   cannedResponseKey: 'my_canned_response_key',
+ * })
+ * ```
+ *
+ * @param options
+ * @param abortSignal
+ * @returns
+ */
+export async function reopenFormApprovalFlowInstance({ formApprovalFlowInstanceId, ...payload }, abortSignal) {
+    console.log('Reopening form approval flow instance', {
+        formApprovalFlowInstanceId,
+        ...payload,
+    });
+    try {
+        return await postRequest(`${tenants.current.apiOrigin}/form-approval-flow-instances/${formApprovalFlowInstanceId}/reopen`, payload, abortSignal);
+    }
+    catch (err) {
+        console.error('Error reopening form approval flow instance', err);
+        Sentry.captureException(err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot reopen this approval without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this approval. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404:
+            case 409: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * As an administrator, close a submission that has been approved.
+ *
+ * #### Example
+ *
+ * ```js
+ * await approvalsService.closeFormApprovalFlowInstance({
+ *   formApprovalFlowInstanceId: 1,
+ *   notificationEmailAddress: ['email@example.com'],
+ *   notes: 'Great work!!!',
+ *   internalNotes: 'It was not really that great...',
+ *   cannedResponseKey: 'my_canned_response_key',
+ * })
+ * ```
+ *
+ * @param options
+ * @param abortSignal
+ * @returns
+ */
+export async function closeFormApprovalFlowInstance({ formApprovalFlowInstanceId, ...payload }, abortSignal) {
+    console.log('Closing form approval flow instance', {
+        formApprovalFlowInstanceId,
+        ...payload,
+    });
+    try {
+        return await postRequest(`${tenants.current.apiOrigin}/form-approval-flow-instances/${formApprovalFlowInstanceId}/close`, payload, abortSignal);
+    }
+    catch (err) {
+        console.log('Error closing form approval flow instance', err);
+        Sentry.captureException(err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot close this approval without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this approval. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404:
+            case 409: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+export async function getFormApprovalFlows(formsAppId, abortSignal) {
+    try {
+        return await getRequest(`${tenants.current.apiOrigin}/forms-apps/${formsAppId}/form-approval-flows`, abortSignal);
+    }
+    catch (err) {
+        Sentry.captureException(err);
+        console.error('Error retrieving form approval flows', err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot access form approval flows without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this application. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * Get an Object containing approvals for the app regardless of approval groups
+ * and meta for paging. Must be an Approvals Administrator.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const limit = 50
+ * const offset = 0
+ * const { approvals, meta } =
+ *   await approvalsService.getFormSubmissionAdministrationApprovals({
+ *     formAppId,
+ *     limit,
+ *     offset,
+ *   })
+ * ```
+ *
+ * @param options
+ * @param abortSignal
+ * @returns
+ */
+export async function getFormSubmissionAdministrationApprovals({ formsAppId, ...rest }, abortSignal) {
+    try {
+        return await searchRequest(`${tenants.current.apiOrigin}/forms-apps/${formsAppId}/approvals`, {
+            ...rest,
+        }, abortSignal);
+    }
+    catch (err) {
+        Sentry.captureException(err);
+        console.error('Error retrieving administrator form submission approvals', err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline and do not have a local copy of this app available, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot view approvals without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this application. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * Get an array containing usernames that have updated approvals in the within
+ * the formsAppId associated with the passed `formsAppId`. Must be an Approvals
+ * Administrator.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const { usernames } =
+ *   await approvalsService.getFormApprovalUsernames(formsAppId)
+ * ```
+ *
+ * @param formsAppId
+ * @param abortSignal
+ * @returns
+ */
+export async function getFormApprovalUsernames(formsAppId, abortSignal) {
+    try {
+        return await getRequest(`${tenants.current.apiOrigin}/forms-apps/${formsAppId}/approvals/usernames`, abortSignal);
+    }
+    catch (err) {
+        Sentry.captureException(err);
+        console.error('Error retrieving form approval usernames', err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot access form approval usernames without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this application. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * Create an additional note for a form submission approval.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formSubmissionApprovalId = 'd96ff812-f263-4a66-868d-e259a1fe4157'
+ * const newFormSubmissionApprovalNote = {
+ *   note: 'this is my note',
+ * }
+ * const createdFormSubmissionApprovalNote =
+ *   await approvalsService.createApprovalAdditionalNote({
+ *     formSubmissionApprovalId,
+ *     newFormSubmissionApprovalNote,
+ *   })
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+export async function createApprovalAdditionalNote({ formSubmissionApprovalId, newFormSubmissionApprovalNote, abortSignal, }) {
+    try {
+        return await postRequest(`${tenants.current.apiOrigin}/form-submission-approvals/${formSubmissionApprovalId}/additional-notes`, newFormSubmissionApprovalNote, abortSignal);
+    }
+    catch (err) {
+        console.error('Error creating form submission approval note', err);
+        if (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) {
+            throw err;
+        }
+        Sentry.captureException(err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot create additional notes without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this application. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * Update an additional note for a form submission approval.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formSubmissionApprovalId = 'd96ff812-f263-4a66-868d-e259a1fe4157'
+ * const formSubmissionApprovalNote = {
+ *   id: '1e84dee3-0dc0-4abe-b2cf-d15d62fd9d0b',
+ *   note: 'this is my note',
+ *   createdAt: '2022-06-24T03:16:34.696Z',
+ *   createdBy: {
+ *     username: 'user@domain.com',
+ *   },
+ *   updatedAt: '2022-06-24T03:16:34.696Z',
+ *   lastUpdatedBy: {
+ *     username: 'user@domain.com',
+ *   },
+ * }
+ * const updatedFormSubmissionApprovalNote =
+ *   await approvalsService.updateApprovalAdditionalNote({
+ *     formSubmissionApprovalId,
+ *     formSubmissionApprovalNote,
+ *   })
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+export async function updateApprovalAdditionalNote({ formSubmissionApprovalId, formSubmissionApprovalNote, abortSignal, }) {
+    try {
+        return await putRequest(`${tenants.current.apiOrigin}/form-submission-approvals/${formSubmissionApprovalId}/additional-notes/${formSubmissionApprovalNote.id}`, formSubmissionApprovalNote, abortSignal);
+    }
+    catch (err) {
+        console.error('Error updating form submission approval note', err);
+        if (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) {
+            throw err;
+        }
+        Sentry.captureException(err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot update additional notes without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this application. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * Delete an additional note for a form submission approval.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formSubmissionApprovalId = 'd96ff812-f263-4a66-868d-e259a1fe4157'
+ * const formSubmissionApprovalNoteId = '1e84dee3-0dc0-4abe-b2cf-d15d62fd9d0b',
+ * const updatedFormSubmissionApprovalNote =
+ *   await approvalsService.deleteApprovalAdditionalNote({
+ *     formSubmissionApprovalId,
+ *     formSubmissionApprovalNoteId,
+ *   })
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+export async function deleteApprovalAdditionalNote({ formSubmissionApprovalId, formSubmissionApprovalNoteId, abortSignal, }) {
+    try {
+        return await deleteRequest(`${tenants.current.apiOrigin}/form-submission-approvals/${formSubmissionApprovalId}/additional-notes/${formSubmissionApprovalNoteId}`, abortSignal);
+    }
+    catch (err) {
+        console.error('Error updating form submission approval note', err);
+        if (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) {
+            throw err;
+        }
+        Sentry.captureException(err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot delete additional notes without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this application. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * Get the status of a single FormSubmissionApproval for the given id.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formSubmissionApprovalId = 'd27966cc-128d-48a2-b681-6ad52012e113'
+ * const { status } =
+ *   await approvalsService.getFormSubmissionApprovalStatus(
+ *     formSubmissionApprovalId,
+ *   )
+ * ```
+ *
+ * @param formSubmissionApprovalId
+ * @param abortSignal
+ * @returns
+ */
+export async function getFormSubmissionApprovalStatus(formSubmissionApprovalId, abortSignal) {
+    try {
+        const result = await getRequest(`${tenants.current.apiOrigin}/form-submission-approvals/${formSubmissionApprovalId}/status`, abortSignal);
+        return result;
+    }
+    catch (err) {
+        Sentry.captureException(err);
+        console.error('Error retrieving form submission approval status', err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline and do not have a local copy of this app available, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot action this pending submission without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this application. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+const possibleStatuses = [
+    {
+        label: 'Awaiting Approval',
+        value: 'PENDING',
+    },
+    {
+        label: 'Approved',
+        value: 'APPROVED',
+    },
+    {
+        label: 'Clarification Requested',
+        value: 'CLARIFICATION_REQUIRED',
+    },
+    {
+        label: 'Clarification Received',
+        value: 'CLARIFICATION_RECEIVED',
+    },
+    {
+        label: 'Denied',
+        value: 'CLOSED',
+    },
+];
+function findLatestFormSubmissionApproval(flowInstanceNode, formSubmissionApprovals) {
+    return formSubmissionApprovals.reduce((lastUpdatedFormSubmissionApproval, formSubmissionApproval) => {
+        if (formSubmissionApproval.stepLabel === flowInstanceNode.label &&
+            (!lastUpdatedFormSubmissionApproval ||
+                lastUpdatedFormSubmissionApproval.updatedAt <
+                    formSubmissionApproval.updatedAt)) {
+            return formSubmissionApproval;
+        }
+        return lastUpdatedFormSubmissionApproval;
+    }, undefined);
+}
+function getFormApprovalFlowInstanceNodes(steps) {
+    return steps.reduce((memo, step) => {
+        switch (step.type) {
+            case 'CONCURRENT': {
+                const parentStepLabelsId = step.nodes
+                    .map(({ label }) => label)
+                    .join('_');
+                for (const node of step.nodes) {
+                    const index = step.nodes.indexOf(node);
+                    memo.push({
+                        ...node,
+                        parentStepLabelsId,
+                        isConcurrentWithPrevious: index !== 0,
+                        isConcurrentWithNext: index < step.nodes.length - 1,
+                    });
+                }
+                break;
+            }
+            case 'STANDARD':
+            default: {
+                memo.push({
+                    ...step,
+                    isConcurrentWithPrevious: false,
+                    isConcurrentWithNext: false,
+                    parentStepLabelsId: step.label,
+                });
+                break;
+            }
+        }
+        return memo;
+    }, []);
+}
+/**
+ * Inputs a form approval flow instance and set of form submission approvals and
+ * returns a flattened array of nodes/steps with inlcuded metadata.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formApprovalFlowInstance = {
+ *   steps: [
+ *     {
+ *       type: 'STANDARD',
+ *       group: 'oneblink:administrator',
+ *       isSkipped: false,
+ *       label: 'Manager Approval',
+ *       approvalFormId: '1234',
+ *     },
+ *     {
+ *       type: 'CONCURRENT',
+ *       nodes: [
+ *         {
+ *           label: 'HR Review',
+ *           group: 'oneblink:administrator',
+ *           isSkipped: false,
+ *           approvalFormId: '1234',
+ *         },
+ *         {
+ *           label: 'Finance Review',
+ *           group: 'oneblink:administrator',
+ *           isSkipped: false,
+ *           approvalFormId: '1234',
+ *         },
+ *       ],
+ *     },
+ *   ],
+ * }
+ *
+ * const formSubmissionApprovals = [
+ *   {
+ *     id: 'approval1',
+ *     stepLabel: 'Manager Approval',
+ *     status: 'APPROVED',
+ *     createdAt: '2024-03-20T10:00:00Z',
+ *     updatedAt: '2024-03-20T10:00:00Z',
+ *     updatedBy: 'fake@fake.com',
+ *     group: 'oneblink:administrator',
+ *     approvalFormId: '1234',
+ *   },
+ * ]
+ *
+ * const nodesWithMeta = getFlowInstanceNodesWithMeta(
+ *   formApprovalFlowInstance,
+ *   formSubmissionApprovals,
+ * )
+ * ```
+ *
+ * @param formApprovalFlowInstance
+ * @param formSubmissionApprovals
+ * @returns ApprovalTypes.FlowInstanceNodeWithMeta[]
+ */
+export function getFlowInstanceNodesWithMeta(formApprovalFlowInstance, formSubmissionApprovals) {
+    const formApprovalFlowInstanceNodes = getFormApprovalFlowInstanceNodes(formApprovalFlowInstance.steps);
+    let isDenied = false;
+    let isClarificationRequired = false;
+    return formApprovalFlowInstanceNodes.map((step) => {
+        const associatedApproval = findLatestFormSubmissionApproval(step, formSubmissionApprovals);
+        const status = possibleStatuses.find(({ value }) => value === (associatedApproval === null || associatedApproval === void 0 ? void 0 : associatedApproval.status));
+        let isDeniedInConcurrentStep = false;
+        let isClarificationRequiredInConcurrentStep = false;
+        if ((status === null || status === void 0 ? void 0 : status.value) === 'PENDING') {
+            const siblingNodes = formApprovalFlowInstanceNodes.filter(({ parentStepLabelsId, label }) => parentStepLabelsId === step.parentStepLabelsId &&
+                label !== step.label);
+            for (const siblingNode of siblingNodes) {
+                const formSubmissionApproval = findLatestFormSubmissionApproval(siblingNode, formSubmissionApprovals);
+                if ((formSubmissionApproval === null || formSubmissionApproval === void 0 ? void 0 : formSubmissionApproval.status) === 'CLOSED') {
+                    isDeniedInConcurrentStep = true;
+                }
+                if ((formSubmissionApproval === null || formSubmissionApproval === void 0 ? void 0 : formSubmissionApproval.status) === 'CLARIFICATION_REQUIRED') {
+                    isClarificationRequiredInConcurrentStep = true;
+                }
+            }
+        }
+        const isAfterDeniedStep = isDenied;
+        if ((status === null || status === void 0 ? void 0 : status.value) === 'CLOSED') {
+            isDenied = true;
+        }
+        const isAfterClarificationRequiredStep = isClarificationRequired;
+        if ((status === null || status === void 0 ? void 0 : status.value) === 'CLARIFICATION_REQUIRED') {
+            isClarificationRequired = true;
+        }
+        let description = 'Awaiting previous approvals';
+        if (step.isSkipped) {
+            description = 'Skipped based on form submission';
+        }
+        else if (status) {
+            const updatedByText = (associatedApproval === null || associatedApproval === void 0 ? void 0 : associatedApproval.updatedBy)
+                ? ` by ${associatedApproval.updatedBy}`
+                : '';
+            description = `${status.label}${updatedByText}`;
+        }
+        else if (isAfterDeniedStep) {
+            description = 'Denied in a previous step';
+        }
+        else if (isAfterClarificationRequiredStep) {
+            description = 'Sent for clarification in a previous step';
+        }
+        return {
+            ...step,
+            status,
+            isDeniedInConcurrentStep,
+            isAfterDeniedStep,
+            isClarificationRequiredInConcurrentStep,
+            isAfterClarificationRequiredStep,
+            description,
+        };
+    });
+}
+//# sourceMappingURL=approvals-service.js.map