@frankieone/one-sdk 0.0.1-npm

package/dist/esm/modules/ocr/actions/mount.js

@@ -0,0 +1,81 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { feat } from '../../features.config.js';
+import { mkEventHub } from '../../common/index.js';
+import { useFormToReviewResults, } from '../../common/vendors/form/useForm.js';
+import { mkStartMethod } from './start.js';
+export const mkMountMethod = (deps) => {
+    var _a;
+    const { eventHub, recipe, oneSdkInstance } = deps;
+    const vendorName = recipe.ocr.provider.name;
+    // For Form component to be included after the "results" event, the recipe
+    // configuration provideReviewScreen must not be false
+    // and the vendor must be configured in `features.ts` with 'containsReviewScreen' = false.
+    // Form is not displayed for vendors which already have a review screen
+    const recipeProvideReviewScreen = (_a = recipe.ocr.provideReviewScreen) !== null && _a !== void 0 ? _a : true;
+    const containsReviewScreen = feat(`modules.ocr.containsReviewScreen.${vendorName}`);
+    const attachForm = !containsReviewScreen && recipeProvideReviewScreen;
+    return (domElementOrSelector) => __awaiter(void 0, void 0, void 0, function* () {
+        eventHub.emit('loading', true, { message: `Loading OCR vendor '${vendorName}'` });
+        const mountElement = typeof domElementOrSelector === 'string'
+            ? window.document.querySelector(domElementOrSelector)
+            : domElementOrSelector;
+        // when mounting, we also run the start method, which has its own logic to define if a new ocr capture is
+        // required or not, based on pre-existing document objects with ocrResults.
+        // 1) if ocr was already completed successfully, emit a results event
+        // 2) otherwise, emit input_required event
+        const privateEventHub = mkEventHub();
+        const internalStartMethod = mkStartMethod(Object.assign(Object.assign({}, deps), { eventHub: privateEventHub }));
+        // when private results event is captured, broadcast to public event
+        privateEventHub.on('results', useFormToReviewResults({
+            localEventHub: eventHub,
+            oneSdkInstance,
+            mountElement,
+            attachForm: attachForm,
+        }));
+        privateEventHub.on('input_required', () => {
+            loadAndInitialiseVendor(deps, domElementOrSelector);
+        });
+        yield internalStartMethod();
+    });
+};
+const loadAndInitialiseVendor = (deps, domElementOrSelector) => {
+    const { vendorLoader, eventHub, globalEventHub } = deps;
+    // Load and initialise vendor wrapper
+    // Which will automatically mount camera feed to an HTML element provided as the parameter above
+    vendorLoader({
+        vendorWrapperOptions: () => {
+            // Resolve the target HTML Element
+            const mountElement = typeof domElementOrSelector === 'string'
+                ? window.document.querySelector(domElementOrSelector)
+                : domElementOrSelector;
+            if (!mountElement)
+                throw new Error(`DOM Element ${domElementOrSelector} not found.`);
+            return {
+                eventHub,
+                mountElement,
+            };
+        },
+        onSuccess: (_, { vendorName }) => {
+            globalEventHub.emit('telemetry', {
+                eventName: 'OCR:MOUNT',
+                data: { vendor: vendorName },
+            });
+        },
+        onError: (error, { vendorName }) => {
+            globalEventHub.emit('telemetry', {
+                eventName: 'OCR:MOUNT:ERROR',
+                data: { vendor: vendorName },
+                error,
+            });
+        },
+    });
+};
+//# sourceMappingURL=mount.js.map

package/dist/esm/modules/ocr/actions/mount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mount.js","sourceRoot":"","sources":["../../../../../modules/ocr/actions/mount.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAEtC,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EACL,sBAAsB,GACvB,MAAM,qCAAqC,CAAC;AAK7C,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAQ1D,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAkB,EAAuC,EAAE;;IACvF,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IAClD,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;IAE5C,0EAA0E;IAC1E,sDAAsD;IACtD,0FAA0F;IAC1F,uEAAuE;IACvE,MAAM,yBAAyB,GAAG,MAAA,MAAM,CAAC,GAAG,CAAC,mBAAmB,mCAAI,IAAI,CAAC;IACzE,MAAM,oBAAoB,GAAG,IAAI,CAAC,oCAAoC,UAAU,EAAE,CAAC,CAAC;IACpF,MAAM,UAAU,GAAG,CAAC,oBAAoB,IAAI,yBAAyB,CAAC;IAEtE,OAAO,CAAO,oBAA0C,EAAE,EAAE;QAC1D,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,uBAAuB,UAAU,GAAG,EAAE,CAAC,CAAC;QAClF,MAAM,YAAY,GAChB,OAAO,oBAAoB,KAAK,QAAQ;YACtC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAc,oBAAoB,CAAC;YAClE,CAAC,CAAC,oBAAoB,CAAC;QAC3B,yGAAyG;QACzG,2EAA2E;QAC3E,qEAAqE;QACrE,0CAA0C;QAC1C,MAAM,eAAe,GAAG,UAAU,EAAU,CAAC;QAC7C,MAAM,mBAAmB,GAAG,aAAa,iCACpC,IAAI,KACP,QAAQ,EAAE,eAAe,IACzB,CAAC;QACH,oEAAoE;QACpE,eAAe,CAAC,EAAE,CAChB,SAAS,EACT,sBAAsB,CAAC;YACrB,aAAa,EAAE,QAAQ;YACvB,cAAc;YACd,YAAY;YACZ,UAAU,EAAE,UAAU;SACvB,CAAC,CACH,CAAC;QACF,eAAe,CAAC,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;YACxC,uBAAuB,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QACH,MAAM,mBAAmB,EAAE,CAAC;IAC9B,CAAC,CAAA,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAC9B,IAAkB,EAClB,oBAA0C,EAC1C,EAAE;IACF,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IACxD,qCAAqC;IACrC,gGAAgG;IAChG,YAAY,CAAC;QACX,oBAAoB,EAAE,GAAG,EAAE;YACzB,kCAAkC;YAClC,MAAM,YAAY,GAChB,OAAO,oBAAoB,KAAK,QAAQ;gBACtC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAc,oBAAoB,CAAC;gBAClE,CAAC,CAAC,oBAAoB,CAAC;YAC3B,IAAI,CAAC,YAAY;gBAAE,MAAM,IAAI,KAAK,CAAC,eAAe,oBAAoB,aAAa,CAAC,CAAC;YAErF,OAAO;gBACL,QAAQ;gBACR,YAAY;aACb,CAAC;QACJ,CAAC;QACD,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;YAC/B,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC/B,SAAS,EAAE,WAAW;gBACtB,IAAI,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE;aAC7B,CAAC,CAAC;QACL,CAAC;QACD,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;YACjC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC/B,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE;gBAC5B,KAAK;aACN,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/esm/modules/ocr/actions/start.d.ts

@@ -0,0 +1,78 @@
+import type { Accessors, EventHub, ReadonlyAccessors } from '../../common';
+import { Document } from '../../common/shared/models/Document';
+import type { CompleteStatus, FailedStatus, InputRequiredStatus, OCRClient, OCRResults } from '../../frankie-client/clients/OCRClient';
+import { OCRStatus } from '../../frankie-client/clients/OCRClient';
+import type { IndividualModule } from '../../individual';
+import type { OCRRecipeOptions } from './..';
+import type { GlobalEvents } from '../../sdk/types';
+import type { Events } from '../events';
+export type Dependencies = {
+    _expectedSide$: ReadonlyAccessors<'front' | 'back'>;
+    status$: Accessors<InputRequiredStatus | CompleteStatus>;
+    document$: Accessors<Document>;
+    files$: Accessors<File[]>;
+    individual: IndividualModule['moduleContext'];
+    eventHub: EventHub<Events>;
+    client: OCRClient;
+    isPreloaded$: Accessors<boolean>;
+    failedStatus$: Accessors<FailedStatus>;
+    globalEventHub: EventHub<GlobalEvents>;
+    maxDocumentCount: number;
+    documents: OCRRecipeOptions['documents'];
+};
+export type DependenciesWithInterrupt = Dependencies & {
+    interruptOCR: InterruptOCR;
+};
+type InterruptOCR = (e: {
+    message: string;
+    payload?: unknown;
+}) => void;
+/**
+ * Returns the start method called by customers to trigger the OCR flow
+ * It first generates two observables by branching off the OCR's internal state variables
+ * a) status$
+ *    Which will cycle on every new status and
+ *    will interrupt the cycle once the value of status is COMPLETE OR there is a forced interruption
+ * b) failedStatus$
+ *    Which will cycle on every new fail status, ignoring null values, issued when failures are resolved
+ *    Will be interrupted by any forced interruptions
+ *
+ * Forced interruptions occur when the function interruptOCR is called by either the customer or internally,
+ * when we reach an unrecoverable state. So far the unrecoverable states are
+ * - Receiving a status PROVIDER_OFFLINE form backend
+ * - File submission fails due to server/network issues
+ * - Receiving a status WAITING_OCR_RUN, reattempting automatically and failing with another WAITING_OCR_RUN
+ *
+ * Each of the subscriber callbacks will trigger a different part of the OCR flow via events:
+ * next => input_required, this one is triggered from both status$ and failedStatus$ observables
+ * - Will happen on every failed status and every new that *IS NOT*
+ * -- COMPLETE
+ * -- WAITING_OCR_RUN
+ * -- PROVIDER_OFFLINE
+ * complete => results
+ * - Will happen when the status is COMPLETE
+ * error => error
+ * - Will happen when the flow is interrupted by
+ * -- calling interruptOCR
+ * -- status is PROVIDER_OFFLINE
+ * -- WAITING_OCR_RUN is received twice in a row
+ * -- file submission fails
+ *
+ * Besides these, an exception is thrown from the function submitFile when
+ * - file is not of type "image"
+ * - file is missing a type property
+ *
+ * @param deps dependencies passed from the OCR module
+ * @returns { interruptOCR }, where interruptOCR forces the end of the OCR cycles
+ */
+export declare const mkStartMethod: (deps: Dependencies) => () => Promise<{
+    interruptOCR: () => void;
+}>;
+export declare const isOcrPreloaded: (d: Document) => boolean;
+export declare const resetCurrentStatus: (deps: DependenciesWithInterrupt) => Promise<void>;
+export declare const completeOCR: (deps: DependenciesWithInterrupt) => void;
+export declare const inputRequired: (status: OCRStatus, deps: DependenciesWithInterrupt) => void;
+export declare const mkProvideFile: (deps: DependenciesWithInterrupt) => (file: File) => void;
+export declare const mkEvaluateResults: (deps: DependenciesWithInterrupt) => (results: OCRResults, recursionFlag?: boolean) => void;
+export {};
+//# sourceMappingURL=start.d.ts.map

package/dist/esm/modules/ocr/actions/start.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"start.d.ts","sourceRoot":"","sources":["../../../../../modules/ocr/actions/start.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAG7E,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,SAAS,EACT,UAAU,EACX,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAIL,SAAS,EACV,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAExC,MAAM,MAAM,YAAY,GAAG;IACzB,cAAc,EAAE,iBAAiB,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC;IACpD,OAAO,EAAE,SAAS,CAAC,mBAAmB,GAAG,cAAc,CAAC,CAAC;IACzD,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC/B,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IAC1B,UAAU,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;IAC9C,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3B,MAAM,EAAE,SAAS,CAAC;IAClB,YAAY,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IACjC,aAAa,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;IACvC,cAAc,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;IACvC,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,YAAY,GAAG;IACrD,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AACF,KAAK,YAAY,GAAG,CAAC,CAAC,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,KAAK,IAAI,CAAC;AACxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,eAAO,MAAM,aAAa,SAAU,YAAY;;EAmF/C,CAAC;AACF,eAAO,MAAM,cAAc,MAAO,QAAQ,YAQzC,CAAC;AAQF,eAAO,MAAM,kBAAkB,SAAgB,yBAAyB,kBAkGvE,CAAC;AACF,eAAO,MAAM,WAAW,SAAU,yBAAyB,SAQ1D,CAAC;AACF,eAAO,MAAM,aAAa,WAChB,SAAS,QACX,yBAAyB,SAYhC,CAAC;AAEF,eAAO,MAAM,aAAa,SAAU,yBAAyB,YAAY,IAAI,SAqB5E,CAAC;AAEF,eAAO,MAAM,iBAAiB,SACrB,yBAAyB,eACrB,UAAU,kBACH,OAAO,SAyExB,CAAC"}

package/dist/esm/modules/ocr/actions/start.js

@@ -0,0 +1,305 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { filter, Subject, takeUntil, takeWhile } from 'rxjs';
+import { runOnce } from '../../common/index.js';
+import { OneSDKError } from '../../common/errors/OneSDKError.class.js';
+import { Document } from '../../common/shared/models/Document.js';
+import { isCompleteStatus, isFailedStatus, isInputRequiredStatus, OCRStatus, } from '../../frankie-client/clients/OCRClient.js';
+/**
+ * Returns the start method called by customers to trigger the OCR flow
+ * It first generates two observables by branching off the OCR's internal state variables
+ * a) status$
+ *    Which will cycle on every new status and
+ *    will interrupt the cycle once the value of status is COMPLETE OR there is a forced interruption
+ * b) failedStatus$
+ *    Which will cycle on every new fail status, ignoring null values, issued when failures are resolved
+ *    Will be interrupted by any forced interruptions
+ *
+ * Forced interruptions occur when the function interruptOCR is called by either the customer or internally,
+ * when we reach an unrecoverable state. So far the unrecoverable states are
+ * - Receiving a status PROVIDER_OFFLINE form backend
+ * - File submission fails due to server/network issues
+ * - Receiving a status WAITING_OCR_RUN, reattempting automatically and failing with another WAITING_OCR_RUN
+ *
+ * Each of the subscriber callbacks will trigger a different part of the OCR flow via events:
+ * next => input_required, this one is triggered from both status$ and failedStatus$ observables
+ * - Will happen on every failed status and every new that *IS NOT*
+ * -- COMPLETE
+ * -- WAITING_OCR_RUN
+ * -- PROVIDER_OFFLINE
+ * complete => results
+ * - Will happen when the status is COMPLETE
+ * error => error
+ * - Will happen when the flow is interrupted by
+ * -- calling interruptOCR
+ * -- status is PROVIDER_OFFLINE
+ * -- WAITING_OCR_RUN is received twice in a row
+ * -- file submission fails
+ *
+ * Besides these, an exception is thrown from the function submitFile when
+ * - file is not of type "image"
+ * - file is missing a type property
+ *
+ * @param deps dependencies passed from the OCR module
+ * @returns { interruptOCR }, where interruptOCR forces the end of the OCR cycles
+ */
+export const mkStartMethod = (deps) => () => __awaiter(void 0, void 0, void 0, function* () {
+    const { status$, failedStatus$, eventHub, document$, files$, isPreloaded$, globalEventHub, } = deps;
+    globalEventHub.emit('telemetry', 'OCR:START');
+    // If flow was interrupted with an error, interrupt observable as well
+    const interruptor = new Subject();
+    const interruptOCR = ({ message, payload = null, }) => interruptor.error({ message, payload });
+    // Loop until Status is COMPLETE, then unsubscribe automatically
+    // Repeated statuses do not trigger another cycle, so this assumes IDV always returns either a new
+    // status or a status flagging an issue
+    const statusUntilComplete$ = status$.observable.pipe(filter(Boolean), takeUntil(interruptor), takeWhile((status) => !isCompleteStatus(status)));
+    // Ignore null failures (when error is resolved). Run until interrupted
+    const failedStatusExceptNull$ = failedStatus$.observable.pipe(filter(Boolean), takeUntil(interruptor));
+    const depsWithInterrupt = Object.assign(Object.assign({}, deps), { interruptOCR });
+    const resetState = () => {
+        status$.setValue(null);
+        failedStatus$.setValue(null);
+        document$.setValue(null);
+        files$.setValue([]);
+        isPreloaded$.setValue(null);
+    };
+    // callbacks for
+    // 1) "loop"/"input_required" aka the "next" callback
+    // 2) "complete" when OCR status is OCR_COMPLETE
+    // 3) "error", when an uncaught error occurred, or interruptOCR is called
+    const subscriber = {
+        next: (newStatus) => {
+            // For each new status/failureStatus, trigger inputRequired part of the flow
+            // This callback is what implements the loops in the OCR Flow
+            inputRequired(newStatus, depsWithInterrupt);
+        },
+        complete: () => {
+            // when flow is flagged as completed by the operator takeWhile above
+            completeOCR(depsWithInterrupt);
+            resetState();
+        },
+        error: (e) => {
+            // when flow is interrupted by calling interruptOCR, which will in turn
+            // emit an error internally, trigerring this error callback
+            eventHub.emit('error', new OneSDKError('While executing OCR callbacks: ' + e.message, e.payload));
+            resetState();
+        },
+    };
+    // Before starting the OCR flow, analyse the existing documents to
+    // either continue a flow, or start a new one
+    yield resetCurrentStatus(depsWithInterrupt);
+    // register callbacks to each data stream
+    // - for each new status, handle "error", "complete" and "next"/loop callbacks
+    statusUntilComplete$.subscribe(subscriber);
+    // - for each new failed statuses, only handle the "next"/loop callback
+    failedStatusExceptNull$.subscribe(subscriber.next);
+    // expose interruptOCR() to allow interruption of an active flow, which unregister all listeners
+    return {
+        interruptOCR: () => interruptOCR({
+            message: 'OCR Flow interrupted externally',
+            payload: {
+                document: deps.document$.getValue(),
+                status: deps.status$.getValue(),
+                failedStatus: deps.failedStatus$.getValue(),
+            },
+        }),
+    };
+});
+export const isOcrPreloaded = (d) => {
+    var _a, _b;
+    // d.verified.{manual|electronic} can have boolean or null values
+    const { manual = null, electronic = null } = (_a = d.verified) !== null && _a !== void 0 ? _a : {};
+    if (!((_b = d.ocrResult) === null || _b === void 0 ? void 0 : _b.status))
+        return false;
+    if (manual === false)
+        return false;
+    if (electronic === false && manual !== true)
+        return false;
+    // COMPLETE, WAITING_FRONT, WAITING_BACK, WAITING_OCR_RUN, FAILED
+    return true;
+};
+// helpers
+const isOcrInterrupted = (status) => status === OCRStatus.WAITING_OCR_RUN;
+const isOcrWaitingOrComplete = (status) => isInputRequiredStatus(status) || isCompleteStatus(status);
+export const resetCurrentStatus = (deps) => __awaiter(void 0, void 0, void 0, function* () {
+    /**
+     * Resolve the status, the document object and the "isPreloaded" flag before initiating the ocr flow
+     * The only statuses that should come out of this function are COMPLETE, WAITING_FRONT and WAITING_BACK
+     *
+     * 1) Determine if any document already has any valid OCR results
+     * 1.a) has ocrResult.status
+     * 1.b) has no failed KYC (neither manually or electronically rejected). Here manual verification
+     * takes precedence for this decision.
+     */
+    const { individual, document$, status$, isPreloaded$, client, failedStatus$, interruptOCR, maxDocumentCount, } = deps;
+    const initialiseWith = (status, document, isPreloaded) => {
+        document$.setValue(document);
+        isPreloaded$.setValue(isPreloaded);
+        failedStatus$.setValue(null);
+        status$.setValue(status);
+    };
+    const startNewFlow = () => initialiseWith(OCRStatus.WAITING_FRONT, new Document(), false);
+    const retryLatest = () => __awaiter(void 0, void 0, void 0, function* () {
+        const { documentStatus, ocrDocument, } = yield client.rerun(latestOcrDocument.documentId);
+        if (allowAnotherDocument && isCompleteStatus(documentStatus))
+            return startNewFlow();
+        // Only if more ocr is allow by configuration AND If results are: WAITING_FRONT, WAITING_BACK, COMPLETE_OCR,
+        // use that status to continue the flow. COMPLETE_OCR will immediately cause a complete callback
+        if (isOcrWaitingOrComplete(documentStatus))
+            return initialiseWith(documentStatus, ocrDocument, true);
+        // IF attempt fails with PROVIDER_OFFLINE, interrupt flow
+        if (documentStatus === OCRStatus.PROVIDER_OFFLINE)
+            throw new Error('Provider is offline. Either switch providers and restart or skip OCR temporarily. ' +
+                `Status '${OCRStatus.PROVIDER_OFFLINE}'`);
+        return startNewFlow();
+    });
+    // Search for existing documents with ocr
+    const allDocuments = individual.access('documents');
+    const allOcrDocuments = allDocuments
+        .getValue()
+        .filter(isOcrPreloaded)
+        .sort((a, b) => +new Date(b.ocrResult.runDate) - +new Date(a.ocrResult.runDate));
+    const [latestOcrDocument] = allOcrDocuments;
+    // The numbered comments below describe each of the possible ways a new flow can be initialised
+    // Based on the list of existing documents
+    // 1) If there are no documents with OCR results, start a new flow
+    // This is the base scenario, where no OCR has been performed yet even if the entity already has documents
+    // At the moment we do not consider how old the OCR results are.
+    if (!latestOcrDocument)
+        return startNewFlow();
+    const latestOcrDocumentStatus = latestOcrDocument.ocrResult.status;
+    const allowAnotherDocument = (maxDocumentCount < 0)
+        || (maxDocumentCount > 1 && maxDocumentCount > allOcrDocuments.length);
+    // 2) If latest OCR document has a failed status, restart OCR capture for this same document object
+    if (isFailedStatus(latestOcrDocumentStatus)) {
+        // if failed status, use existing document with status WAITING_FRONT
+        return initialiseWith(OCRStatus.WAITING_FRONT, latestOcrDocument, true);
+    }
+    // 3) If latest OCR document was interrupted and we don't know the status, request API for a new status and reevaluate
+    if (isOcrInterrupted(latestOcrDocumentStatus)) {
+        return retryLatest().catch((e) => {
+            return interruptOCR({
+                message: e.message,
+                payload: e,
+            });
+        });
+    }
+    if (allowAnotherDocument && isCompleteStatus(latestOcrDocumentStatus)) {
+        return startNewFlow();
+    }
+    if (isOcrWaitingOrComplete(latestOcrDocumentStatus)) {
+        // WAITING_FRONT, WAITING_BACK, COMPLETE_OCR
+        return initialiseWith(latestOcrDocumentStatus, latestOcrDocument, true);
+        // anything else starts a new flow with WAITING_FRONT
+    }
+    return startNewFlow();
+});
+export const completeOCR = (deps) => {
+    const { document$, eventHub, individual, client } = deps;
+    const document = document$.getValue();
+    const entityId = client.entityId;
+    individual.updateDocument(document.documentId, document);
+    eventHub.emit('results', { document, entityId });
+};
+export const inputRequired = (status, deps) => {
+    const { document$, _expectedSide$, eventHub } = deps;
+    const document = document$.getValue();
+    const idType = document.idType === 'OTHER' ? null : document.idType;
+    const info = {
+        documentType: idType,
+        side: _expectedSide$.getValue(),
+    };
+    const message = 'Callback \'submitFile\' on event \'input_required\' called twice. Second call was ignored';
+    const provideFile = mkProvideFile(deps);
+    eventHub.emit('input_required', info, status, runOnce(provideFile, message));
+};
+export const mkProvideFile = (deps) => (file) => {
+    var _a;
+    const { files$, document$, client } = deps;
+    if (!file.type) {
+        throw new Error('File is missing mime type. Provide a \'type\' option in the File constructor');
+    }
+    if (!file.type.match(/^image/)) {
+        throw new Error('Invalid mime type. Provided files must be of type \'image\'');
+    }
+    files$.setValue([...files$.getValue(), file]);
+    const { documentId } = document$.getValue();
+    const evaluateResults = mkEvaluateResults(deps);
+    const hasAnyDigital = !!((_a = deps.documents) === null || _a === void 0 ? void 0 : _a.some(({ digital }) => digital));
+    const submit = documentId
+        ? () => client.updateOCRDocument(file, documentId)
+        : () => client.attachNewOCRDocument(file, hasAnyDigital);
+    submit()
+        .then(evaluateResults)
+        .catch((e) => {
+        deps.interruptOCR({ message: 'Error submitting file', payload: e });
+    });
+};
+export const mkEvaluateResults = (deps) => (results, recursionFlag) => {
+    const { _expectedSide$, document$, eventHub, status$, client, failedStatus$, interruptOCR, } = deps;
+    const { documentStatus, ocrDocument } = results;
+    // Update local document object first
+    const document = ocrDocument.clone();
+    document$.setValue(document);
+    // if not a failure and not a WAITING_OCR_RUN, emit logs to confirm file upload
+    if (!isFailedStatus(documentStatus) && documentStatus !== OCRStatus.WAITING_OCR_RUN) {
+        const expectedSide = _expectedSide$.getValue();
+        const expectedScanSide = expectedSide === 'front' ? 'F' : 'B';
+        const foundScan = ocrDocument.scans.find((s) => expectedScanSide === s.side);
+        if (foundScan) {
+            eventHub.emit('file_uploaded', {
+                fileName: foundScan.scanName,
+                mimeType: foundScan.mimeType,
+                scanId: foundScan.scanId,
+                statusAfterUpload: documentStatus,
+                statusBeforeUpload: status$.getValue(),
+            });
+        }
+        else {
+            eventHub.emit('warning', {
+                message: 'File was uploaded successfully, but there was an issue identifying it within the document payload: ' +
+                    `document.scans[].side didn't match expected side ${expectedSide} (${expectedScanSide}) `,
+            });
+        }
+    }
+    if (documentStatus === OCRStatus.PROVIDER_OFFLINE) {
+        interruptOCR({
+            message: 'Provider is offline. Either switch providers and restart or skip OCR temporarily. ' +
+                `Status ${OCRStatus.PROVIDER_OFFLINE}`,
+            payload: null,
+        });
+    }
+    else if (documentStatus === OCRStatus.WAITING_OCR_RUN) {
+        // If request previously returned WAITING_OCR_RUN, we tried again and got another WAITING_OCR_RUN,
+        // throw error, which will interruptOCR
+        if (recursionFlag)
+            throw new Error(`Two attempts to get OCR results failed with an unresolved "${OCRStatus.WAITING_OCR_RUN}". ` +
+                'This is a system failure.');
+        // If waiting_ocr_run is returned, try to rerun and reevaluate results
+        const evaluateResults = mkEvaluateResults(deps);
+        client
+            .rerun(ocrDocument.documentId)
+            .then((res) => evaluateResults(res, true))
+            .catch((e) => interruptOCR({
+            message: `Attempting to resolve the status ${OCRStatus.WAITING_OCR_RUN} resulted in an error`,
+            payload: e,
+        }));
+    }
+    else if (isFailedStatus(documentStatus)) {
+        // if failed, set failedStatus and keep status the same
+        failedStatus$.setValue(documentStatus);
+    }
+    else {
+        // otherwise, update status to new received status
+        failedStatus$.setValue(null);
+        status$.setValue(documentStatus);
+    }
+};
+//# sourceMappingURL=start.js.map

package/dist/esm/modules/ocr/actions/start.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start.js","sourceRoot":"","sources":["../../../../../modules/ocr/actions/start.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAG7D,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AAQjE,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACrB,SAAS,GACV,MAAM,0CAA0C,CAAC;AA0BlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAkB,EAAE,EAAE,CAAC,GAAS,EAAE;IAC9D,MAAM,EACJ,OAAO,EACP,aAAa,EACb,QAAQ,EACR,SAAS,EACT,MAAM,EACN,YAAY,EACZ,cAAc,GACf,GAAG,IAAI,CAAC;IACT,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAC9C,sEAAsE;IACtE,MAAM,WAAW,GAAG,IAAI,OAAO,EAAE,CAAC;IAClC,MAAM,YAAY,GAAiB,CAAC,EAClC,OAAO,EACP,OAAO,GAAG,IAAI,GACf,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAC9C,gEAAgE;IAChE,kGAAkG;IAClG,uCAAuC;IACvC,MAAM,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAClD,MAAM,CAAC,OAAO,CAAC,EACf,SAAS,CAAC,WAAW,CAAC,EACtB,SAAS,CAAC,CAAC,MAAiB,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAC5D,CAAC;IACF,uEAAuE;IACvE,MAAM,uBAAuB,GAAG,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;IACvG,MAAM,iBAAiB,mCAClB,IAAI,KACP,YAAY,GACb,CAAC;IACF,MAAM,UAAU,GAAG,GAAG,EAAE;QACtB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvB,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACpB,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC,CAAC;IACF,gBAAgB;IAChB,qDAAqD;IACrD,gDAAgD;IAChD,yEAAyE;IACzE,MAAM,UAAU,GAAG;QACjB,IAAI,EAAE,CAAC,SAAoB,EAAE,EAAE;YAC7B,4EAA4E;YAC5E,6DAA6D;YAC7D,aAAa,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;QAC9C,CAAC;QACD,QAAQ,EAAE,GAAG,EAAE;YACb,oEAAoE;YACpE,WAAW,CAAC,iBAAiB,CAAC,CAAC;YAC/B,UAAU,EAAE,CAAC;QACf,CAAC;QACD,KAAK,EAAE,CAAC,CAAwC,EAAE,EAAE;YAClD,uEAAuE;YACvE,2DAA2D;YAC3D,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,WAAW,CAAC,iCAAiC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YAClG,UAAU,EAAE,CAAC;QACf,CAAC;KACF,CAAC;IAEF,kEAAkE;IAClE,6CAA6C;IAC7C,MAAM,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;IAE5C,yCAAyC;IACzC,8EAA8E;IAC9E,oBAAoB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAC3C,uEAAuE;IACvE,uBAAuB,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEnD,gGAAgG;IAChG,OAAO;QACL,YAAY,EAAE,GAAG,EAAE,CACjB,YAAY,CAAC;YACX,OAAO,EAAE,iCAAiC;YAC1C,OAAO,EAAE;gBACP,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;gBACnC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;gBAC/B,YAAY,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;aAC5C;SACF,CAAC;KACL,CAAC;AACJ,CAAC,CAAA,CAAC;AACF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAW,EAAE,EAAE;;IAC5C,iEAAiE;IACjE,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,UAAU,GAAG,IAAI,EAAE,GAAG,MAAA,CAAC,CAAC,QAAQ,mCAAI,EAAE,CAAC;IAC9D,IAAI,CAAC,CAAA,MAAA,CAAC,CAAC,SAAS,0CAAE,MAAM,CAAA;QAAE,OAAO,KAAK,CAAC;IACvC,IAAI,MAAM,KAAK,KAAK;QAAE,OAAO,KAAK,CAAC;IACnC,IAAI,UAAU,KAAK,KAAK,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC1D,iEAAiE;IACjE,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,UAAU;AACV,MAAM,gBAAgB,GAAG,CAAC,MAAkB,EAAuC,EAAE,CACnF,MAAM,KAAK,SAAS,CAAC,eAAe,CAAC;AACvC,MAAM,sBAAsB,GAAG,CAAC,MAAkB,EAAkD,EAAE,CACpG,qBAAqB,CAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAE5D,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAO,IAA+B,EAAE,EAAE;IAC1E;;;;;;;;OAQG;IACH,MAAM,EACJ,UAAU,EACV,SAAS,EACT,OAAO,EACP,YAAY,EACZ,MAAM,EACN,aAAa,EACb,YAAY,EACZ,gBAAgB,GACjB,GAAG,IAAI,CAAC;IAET,MAAM,cAAc,GAAG,CACrB,MAA4C,EAC5C,QAAkB,EAClB,WAAoB,EACpB,EAAE;QACF,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC7B,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACnC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC,CAAC;IACF,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;IAE1F,MAAM,WAAW,GAAG,GAAS,EAAE;QAC7B,MAAM,EACJ,cAAc,EACd,WAAW,GACZ,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAErD,IAAI,oBAAoB,IAAI,gBAAgB,CAAC,cAAc,CAAC;YAAE,OAAO,YAAY,EAAE,CAAC;QACpF,4GAA4G;QAC5G,gGAAgG;QAChG,IAAI,sBAAsB,CAAC,cAAc,CAAC;YAAE,OAAO,cAAc,CAAC,cAAc,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;QACrG,yDAAyD;QACzD,IAAI,cAAc,KAAK,SAAS,CAAC,gBAAgB;YAC/C,MAAM,IAAI,KAAK,CACb,oFAAoF;gBACpF,WAAW,SAAS,CAAC,gBAAgB,GAAG,CACzC,CAAC;QAEJ,OAAO,YAAY,EAAE,CAAC;IACxB,CAAC,CAAA,CAAC;IAEF,yCAAyC;IACzC,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACpD,MAAM,eAAe,GAAG,YAAY;SACjC,QAAQ,EAAE;SACV,MAAM,CAAC,cAAc,CAAC;SACtB,IAAI,CAAC,CACJ,CAAC,EACD,CAAC,EACD,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IACxE,MAAM,CAAC,iBAAiB,CAAC,GAAG,eAAe,CAAC;IAC5C,+FAA+F;IAC/F,0CAA0C;IAE1C,kEAAkE;IAClE,0GAA0G;IAC1G,gEAAgE;IAChE,IAAI,CAAC,iBAAiB;QAAE,OAAO,YAAY,EAAE,CAAC;IAE9C,MAAM,uBAAuB,GAAG,iBAAiB,CAAC,SAAS,CAAC,MAAM,CAAC;IACnE,MAAM,oBAAoB,GAAG,CAAC,gBAAgB,GAAG,CAAC,CAAC;WAC9C,CAAC,gBAAgB,GAAG,CAAC,IAAI,gBAAgB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IAEzE,mGAAmG;IACnG,IAAI,cAAc,CAAC,uBAAuB,CAAC,EAAE,CAAC;QAC5C,oEAAoE;QACpE,OAAO,cAAc,CAAC,SAAS,CAAC,aAAa,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAC1E,CAAC;IACD,sHAAsH;IACtH,IAAI,gBAAgB,CAAC,uBAAuB,CAAC,EAAE,CAAC;QAC9C,OAAO,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YAC/B,OAAO,YAAY,CAAC;gBAClB,OAAO,EAAE,CAAC,CAAC,OAAO;gBAClB,OAAO,EAAE,CAAC;aACX,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IACD,IAAI,oBAAoB,IAAI,gBAAgB,CAAC,uBAAuB,CAAC,EAAE,CAAC;QACtE,OAAO,YAAY,EAAE,CAAC;IACxB,CAAC;IACD,IAAI,sBAAsB,CAAC,uBAAuB,CAAC,EAAE,CAAC;QACpD,4CAA4C;QAC5C,OAAO,cAAc,CAAC,uBAAuB,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QACxE,qDAAqD;IACvD,CAAC;IACD,OAAO,YAAY,EAAE,CAAC;AACxB,CAAC,CAAA,CAAC;AACF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAA+B,EAAE,EAAE;IAC7D,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEzD,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;IACtC,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;IAEjC,UAAU,CAAC,cAAc,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACzD,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;AACnD,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,MAAiB,EACjB,IAA+B,EAC/B,EAAE;IACF,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IACrD,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;IACtC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;IACpE,MAAM,IAAI,GAAG;QACX,YAAY,EAAE,MAAM;QACpB,IAAI,EAAE,cAAc,CAAC,QAAQ,EAAE;KACvB,CAAC;IACX,MAAM,OAAO,GAAG,2FAA2F,CAAC;IAC5G,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACxC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/E,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAA+B,EAAE,EAAE,CAAC,CAAC,IAAU,EAAE,EAAE;;IAC/E,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC3C,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC,CAAC;IAClG,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;IACjF,CAAC;IACD,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IAC9C,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC5C,MAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAChD,MAAM,aAAa,GAAG,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,CAAA,CAAC;IACvE,MAAM,MAAM,GAAG,UAAU;QACvB,CAAC,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,UAAU,CAAC;QAClD,CAAC,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAE3D,MAAM,EAAE;SACL,IAAI,CAAC,eAAe,CAAC;SACrB,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QACX,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAC5B,CAAC,IAA+B,EAAE,EAAE,CAAC,CACnC,OAAmB,EACnB,aAAuB,EACvB,EAAE;IACF,MAAM,EACJ,cAAc,EACd,SAAS,EACT,QAAQ,EACR,OAAO,EACP,MAAM,EACN,aAAa,EACb,YAAY,GACb,GAAG,IAAI,CAAC;IACT,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAEhD,qCAAqC;IACrC,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAK,EAAE,CAAC;IACrC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC7B,+EAA+E;IAC/E,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,cAAc,KAAK,SAAS,CAAC,eAAe,EAAE,CAAC;QACpF,MAAM,YAAY,GAAG,cAAc,CAAC,QAAQ,EAAE,CAAC;QAC/C,MAAM,gBAAgB,GAAG,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAC9D,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;QAE7E,IAAI,SAAS,EAAE,CAAC;YACd,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE;gBAC7B,QAAQ,EAAE,SAAS,CAAC,QAAQ;gBAC5B,QAAQ,EAAE,SAAS,CAAC,QAAQ;gBAC5B,MAAM,EAAE,SAAS,CAAC,MAAM;gBACxB,iBAAiB,EAAE,cAAc;gBACjC,kBAAkB,EAAE,OAAO,CAAC,QAAQ,EAAE;aACvC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE;gBACvB,OAAO,EACL,qGAAqG;oBACrG,oDAAoD,YAAY,KAAK,gBAAgB,IAAI;aAC5F,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,IAAI,cAAc,KAAK,SAAS,CAAC,gBAAgB,EAAE,CAAC;QAClD,YAAY,CAAC;YACX,OAAO,EACL,oFAAoF;gBACpF,UAAU,SAAS,CAAC,gBAAgB,EAAE;YACxC,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;IACL,CAAC;SAAM,IAAI,cAAc,KAAK,SAAS,CAAC,eAAe,EAAE,CAAC;QACxD,kGAAkG;QAClG,uCAAuC;QACvC,IAAI,aAAa;YACf,MAAM,IAAI,KAAK,CACb,8DAA8D,SAAS,CAAC,eAAe,KAAK;gBAC5F,2BAA2B,CAC5B,CAAC;QACJ,sEAAsE;QACtE,MAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM;aACH,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC;aAC7B,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;aACzC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CACX,YAAY,CAAC;YACX,OAAO,EAAE,oCAAoC,SAAS,CAAC,eAAe,uBAAuB;YAC7F,OAAO,EAAE,CAAC;SACX,CAAC,CACH,CAAC;IACN,CAAC;SAAM,IAAI,cAAc,CAAC,cAAc,CAAC,EAAE,CAAC;QAC1C,uDAAuD;QACvD,aAAa,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IACzC,CAAC;SAAM,CAAC;QACN,kDAAkD;QAClD,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IACnC,CAAC;AACH,CAAC,CAAC"}

package/dist/esm/modules/ocr/definition.d.ts

@@ -0,0 +1,53 @@
+import type { AccessFunction, AccessorsDictionary, EventHub } from '../common';
+import type { DocumentType } from '../common/shared/models/SupportingDocument';
+import type { ModuleDefinition } from '../common/types';
+import type { OCRStatus } from '../frankie-client/clients/OCRClient';
+import type { Events } from './events';
+import type { PartialDeep } from 'type-fest';
+export type OCRModule = ModuleDefinition<{
+    module: {
+        category: 'component';
+        name: 'ocr';
+        context: {
+            mount(domElementOrSelector: string | HTMLElement): void;
+            start(): void;
+            access: AccessFunction<PublicAccessors>;
+            isPreloaded: () => boolean;
+            statuses: Readonly<typeof OCRStatus>;
+        };
+        events: Events;
+        options: PartialDeep<Omit<OCRRecipeOptions, 'provider'>>;
+        recipe: {
+            ocr: OCRRecipeOptions;
+        };
+    };
+    wrapper: {
+        vendors: ['dummy-ocr', 'incode', 'onfido'];
+        loadType: 'sync';
+        options: {
+            eventHub: EventHub<Events>;
+            mountElement: HTMLElement;
+        };
+    };
+}>;
+export type PublicAccessors = AccessorsDictionary<{
+    readonly status: OCRStatus;
+    readonly isPreloaded: boolean;
+}>;
+export type OCRRecipeOptions = {
+    provideReviewScreen?: boolean;
+    maxDocumentCount?: number;
+    documents?: {
+        type: DocumentType;
+        countries?: string[];
+        digital?: boolean;
+    }[];
+    provider: {
+        name: 'ocrlabs';
+        tx_id: string;
+    } | {
+        name: 'onfido' | 'incode';
+        sdkVersion?: string;
+    };
+};
+//# sourceMappingURL=definition.d.ts.map

package/dist/esm/modules/ocr/definition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"definition.d.ts","sourceRoot":"","sources":["../../../../modules/ocr/definition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,mBAAmB,EACnB,QAAQ,EACT,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EACV,YAAY,EACb,MAAM,iDAAiD,CAAC;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AAE1E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7C,MAAM,MAAM,SAAS,GAAG,gBAAgB,CAAC;IACvC,MAAM,EAAE;QACN,QAAQ,EAAE,WAAW,CAAC;QACtB,IAAI,EAAE,KAAK,CAAC;QACZ,OAAO,EAAE;YACP,KAAK,CAAC,oBAAoB,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAAC;YACxD,KAAK,IAAI,IAAI,CAAC;YACd,MAAM,EAAE,cAAc,CAAC,eAAe,CAAC,CAAC;YACxC,WAAW,EAAE,MAAM,OAAO,CAAC;YAC3B,QAAQ,EAAE,QAAQ,CAAC,OAAO,SAAS,CAAC,CAAC;SACtC,CAAC;QACF,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,WAAW,CAAC,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC,CAAC;QACzD,MAAM,EAAE;YACN,GAAG,EAAE,gBAAgB,CAAC;SACvB,CAAC;KACH,CAAC;IACF,OAAO,EAAE;QACP,OAAO,EAAE,CAAC,WAAW,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC3C,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE;YACP,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC3B,YAAY,EAAE,WAAW,CAAC;SAC3B,CAAC;KACH,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,mBAAmB,CAAC;IAChD,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CAC/B,CAAC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE;QACV,IAAI,EAAE,YAAY,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;QACrB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,EAAE,CAAC;IACJ,QAAQ,EACJ;QACF,IAAI,EAAE,SAAS,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;KACf,GACG;QACF,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;QAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACH,CAAC"}

package/dist/esm/modules/ocr/definition.js

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

package/dist/esm/modules/ocr/definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definition.js","sourceRoot":"","sources":["../../../../modules/ocr/definition.ts"],"names":[],"mappings":""}

package/dist/esm/modules/ocr/events.d.ts

@@ -0,0 +1,38 @@
+import type { Document } from '../common/shared/models/Document';
+import type { OCRStatus } from '../frankie-client/clients/OCRClient';
+export type Events = {
+    session_data_generated: [{
+        session: unknown;
+    }];
+    session_data_failed_loading: [{
+        code?: unknown;
+        message: string;
+    }];
+    ready: [{
+        domElement: HTMLElement;
+    }];
+    detection_complete: [];
+    detection_failed: [{
+        message?: string;
+    }];
+    input_required: [Info, OCRStatus, ProvideFile];
+    results: [{
+        document: Document;
+        entityId: string;
+    }];
+    file_uploaded: [FileUploadedMeta];
+    session_closed: [];
+};
+export type FileUploadedMeta = {
+    fileName: string;
+    mimeType: string;
+    scanId: string;
+    statusAfterUpload: OCRStatus;
+    statusBeforeUpload: OCRStatus;
+};
+export type Info = {
+    documentType: Document['idType'];
+    side: 'front' | 'back';
+};
+export type ProvideFile = (blob: File) => void;
+//# sourceMappingURL=events.d.ts.map

package/dist/esm/modules/ocr/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../modules/ocr/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AAE1E,MAAM,MAAM,MAAM,GAAG;IACnB,sBAAsB,EAAE,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAC/C,2BAA2B,EAAE,CAAC;QAAE,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACnE,KAAK,EAAE,CAAC;QAAE,UAAU,EAAE,WAAW,CAAA;KAAE,CAAC,CAAC;IACrC,kBAAkB,EAAE,EAAE,CAAC;IACvB,gBAAgB,EAAE,CAAC;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACzC,cAAc,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;IAC/C,OAAO,EAAE,CAAC;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACpD,aAAa,EAAE,CAAC,gBAAgB,CAAC,CAAC;IAClC,cAAc,EAAE,EAAE,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,SAAS,CAAC;IAC7B,kBAAkB,EAAE,SAAS,CAAC;CAC/B,CAAC;AACF,MAAM,MAAM,IAAI,GAAG;IAAE,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAAA;CAAE,CAAC;AAChF,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC"}

package/dist/esm/modules/ocr/events.js

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

package/dist/esm/modules/ocr/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../../modules/ocr/events.ts"],"names":[],"mappings":""}

package/dist/esm/modules/ocr/index.d.ts

@@ -0,0 +1,28 @@
+import { ReactiveStore } from '../common';
+import type { Document } from '../common/shared/models/Document';
+import type { FailedStatus, InputRequiredStatus } from '../frankie-client/clients/OCRClient';
+import { OCRStatus } from '../frankie-client/clients/OCRClient';
+import type { Events } from './events';
+import type { OCRModule } from './definition';
+export * from './definition';
+export type { Events };
+export { OCRStatus as Status };
+declare const _default: import("../common/types").BrandedInitialiseFunction<OCRModule>;
+export default _default;
+type State = {
+    document: Document;
+    status: InputRequiredStatus | OCRStatus.COMPLETE;
+    failedStatus: FailedStatus;
+    files: File[];
+    isPreloaded: boolean;
+};
+export declare function createOCRInternalState(initialState: State): {
+    state$: ReactiveStore<State>;
+    status$: import("../common").Accessors<OCRStatus.COMPLETE | InputRequiredStatus, OCRStatus.COMPLETE | InputRequiredStatus>;
+    failedStatus$: import("../common").Accessors<FailedStatus, FailedStatus>;
+    document$: import("../common").Accessors<Document, Document>;
+    files$: import("../common").Accessors<File[], File[]>;
+    isPreloaded$: import("../common").Accessors<boolean, boolean>;
+    _expectedSide$: import("../common").ReadonlyAccessors<"front" | "back">;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/modules/ocr/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../modules/ocr/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,KAAK,EACV,YAAY,EACZ,mBAAmB,EACpB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAGL,SAAS,EACV,MAAM,0CAA0C,CAAC;AAElD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAMjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAE9C,cAAc,cAAc,CAAC;AAC7B,YAAY,EAAE,MAAM,EAAE,CAAC;AACvB,OAAO,EAAE,SAAS,IAAI,MAAM,EAAE,CAAC;;AAE/B,wBA0GG;AAEH,KAAK,KAAK,GAAG;IACX,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,mBAAmB,GAAG,SAAS,CAAC,QAAQ,CAAC;IACjD,YAAY,EAAE,YAAY,CAAC;IAC3B,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,KAAK;;;;;;;;EA4BzD"}