@frankieone/one-sdk 0.0.1-npm

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

@@ -0,0 +1,108 @@
+import merge from 'lodash.merge';
+import { mkVendorLoader, ReactiveStore } from '../common/index.js';
+import { defineModule } from '../common/modules/defineModule.js';
+import { isInputRequiredStatus, OCRClient, OCRStatus, } from '../frankie-client/clients/OCRClient.js';
+import { mkMountMethod } from './actions/mount.js';
+import { SdkModes } from '../sdk/types/index.js';
+import { mkStartMethod } from './actions/start.js';
+export * from './definition.js';
+export { OCRStatus as Status };
+export default defineModule('ocr', (globalState, options = {}) => {
+    var _a, _b;
+    const { frankieClient, oneSdkInstance, globalEventHub, localEventHub, recipe: { ocr }, } = globalState;
+    // @TODO add validation check
+    Object.assign(ocr, merge(ocr, options));
+    const client = new OCRClient(frankieClient);
+    const { status$, failedStatus$, document$, files$, isPreloaded$, _expectedSide$, } = createOCRInternalState({
+        document: null,
+        status: null,
+        failedStatus: null,
+        files: [],
+        isPreloaded: null,
+    });
+    const publicAccessors = {
+        status: status$.toReadonly(),
+        failedStatus: failedStatus$.toReadonly(),
+        isPreloaded: isPreloaded$.toReadonly(),
+    };
+    const loadVendorWrapper = mkVendorLoader({
+        // If initialising in dummy mode, force the use of the dummy-ocr wrapper
+        // otherwise load the wrapper based on the provider's name
+        vendorName: globalState.mode.modeName === SdkModes.DUMMY
+            ? 'dummy-ocr'
+            : ocr.provider.name,
+        sharedConfiguration: globalState,
+        vendorLoader: {
+            'dummy-ocr': () => import(
+            /* webpackChunkName: 'ocr-dummy' */ './vendors/dummy-ocr/index.js'),
+            incode: () => import(
+            /* webpackChunkName: 'ocr-incode' */ './vendors/Incode/index.js'),
+            onfido: () => import(
+            /* webpackChunkName: 'ocr-onfido' */ './vendors/Onfido/index.js'),
+            ocrlabs: null,
+        },
+    });
+    const deps = {
+        _expectedSide$,
+        client,
+        document$,
+        eventHub: localEventHub,
+        files$,
+        individual: oneSdkInstance.individual(),
+        status$,
+        isPreloaded$,
+        failedStatus$,
+        globalEventHub,
+        maxDocumentCount: (_a = ocr === null || ocr === void 0 ? void 0 : ocr.maxDocumentCount) !== null && _a !== void 0 ? _a : 1,
+        documents: (_b = ocr === null || ocr === void 0 ? void 0 : ocr.documents) !== null && _b !== void 0 ? _b : [],
+    };
+    const start = mkStartMethod(deps);
+    const mount = mkMountMethod(Object.assign(Object.assign(Object.assign({}, globalState), deps), { vendorLoader: loadVendorWrapper }));
+    // Event mappings for telemetry
+    localEventHub.on('input_required', ({ documentType, side }, status) => globalEventHub.emit('telemetry', {
+        eventName: 'OCR:INPUT_REQUIRED',
+        data: {
+            documentType,
+            side,
+            status,
+        },
+    }));
+    localEventHub.on('results', () => globalEventHub.emit('telemetry', 'OCR:RESULTS'));
+    return {
+        mount,
+        start,
+        isPreloaded: () => isPreloaded$.getValue(),
+        access: (fieldName) => publicAccessors[fieldName],
+        statuses: Object.freeze(OCRStatus),
+    };
+});
+export function createOCRInternalState(initialState) {
+    // Set reactive internal state
+    const state$ = new ReactiveStore(initialState);
+    const status$ = state$.getRootAccessors('status');
+    const failedStatus$ = state$.getRootAccessors('failedStatus');
+    const document$ = state$.getRootAccessors('document');
+    const files$ = state$.getRootAccessors('files');
+    const isPreloaded$ = state$.getRootAccessors('isPreloaded');
+    const _expectedSide$ = ReactiveStore.mkComputedAccessors(status$, {
+        transformer: (status) => {
+            if (isInputRequiredStatus(status)) {
+                return status === OCRStatus.WAITING_FRONT ? 'front' : 'back';
+            }
+            else {
+                return null;
+            }
+        },
+        propertyName: 'expectedSide',
+    });
+    return {
+        state$,
+        status$,
+        failedStatus$,
+        document$,
+        files$,
+        isPreloaded$,
+        _expectedSide$,
+    };
+}
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/ocr/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,cAAc,CAAC;AAEjC,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AAMnE,OAAO,EACL,qBAAqB,EACrB,SAAS,EACT,SAAS,GACV,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAKhD,cAAc,cAAc,CAAC;AAE7B,OAAO,EAAE,SAAS,IAAI,MAAM,EAAE,CAAC;AAE/B,eAAe,YAAY,CAAY,KAAK,EAAE,CAAC,WAAW,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE;;IAC1E,MAAM,EACJ,aAAa,EACb,cAAc,EACd,cAAc,EACd,aAAa,EACb,MAAM,EAAE,EAAE,GAAG,EAAE,GAChB,GAAG,WAAW,CAAC;IAEhB,6BAA6B;IAC7B,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IAExC,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;IAE5C,MAAM,EACJ,OAAO,EACP,aAAa,EACb,SAAS,EACT,MAAM,EACN,YAAY,EACZ,cAAc,GACf,GAAG,sBAAsB,CAAC;QACzB,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,IAAI;QACZ,YAAY,EAAE,IAAI;QAClB,KAAK,EAAE,EAAE;QACT,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC;IAEH,MAAM,eAAe,GAAG;QACtB,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE;QAC5B,YAAY,EAAE,aAAa,CAAC,UAAU,EAAE;QACxC,WAAW,EAAE,YAAY,CAAC,UAAU,EAAE;KACvC,CAAC;IAEF,MAAM,iBAAiB,GAAG,cAAc,CAAC;QACvC,wEAAwE;QACxE,0DAA0D;QAC1D,UAAU,EACR,WAAW,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,KAAK;YAC1C,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI;QACvB,mBAAmB,EAAE,WAAW;QAChC,YAAY,EAAE;YACZ,WAAW,EAAE,GAAG,EAAE,CAChB,MAAM;YACJ,mCAAmC,CAAC,8BAA8B,CACnE;YACH,MAAM,EAAE,GAAG,EAAE,CACX,MAAM;YACJ,oCAAoC,CAAC,2BAA2B,CACjE;YACH,MAAM,EAAE,GAAG,EAAE,CACX,MAAM;YACJ,oCAAoC,CAAC,2BAA2B,CACjE;YACH,OAAO,EAAE,IAAI;SACd;KACF,CAAC,CAAC;IAEH,MAAM,IAAI,GAAiB;QACzB,cAAc;QACd,MAAM;QACN,SAAS;QACT,QAAQ,EAAE,aAAa;QACvB,MAAM;QACN,UAAU,EAAE,cAAc,CAAC,UAAU,EAAE;QACvC,OAAO;QACP,YAAY;QACZ,aAAa;QACb,cAAc;QACd,gBAAgB,EAAE,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,gBAAgB,mCAAI,CAAC;QAC5C,SAAS,EAAE,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,mCAAI,EAAE;KAChC,CAAC;IAEF,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAElC,MAAM,KAAK,GAAG,aAAa,+CACtB,WAAW,GACX,IAAI,KACP,YAAY,EAAE,iBAAiB,IAC/B,CAAC;IAEH,+BAA+B;IAE/B,aAAa,CAAC,EAAE,CAAC,gBAAgB,EAAE,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,CACpE,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;QAC/B,SAAS,EAAE,oBAAoB;QAC/B,IAAI,EAAE;YACJ,YAAY;YACZ,IAAI;YACJ,MAAM;SACP;KACF,CAAC,CACH,CAAC;IACF,aAAa,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAC/B,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,CAChD,CAAC;IAEF,OAAO;QACL,KAAK;QACL,KAAK;QACL,WAAW,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE;QAC1C,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC;QACjD,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;KACnC,CAAC;AACJ,CAAC,CAAC,CAAC;AAUH,MAAM,UAAU,sBAAsB,CAAC,YAAmB;IACxD,8BAA8B;IAC9B,MAAM,MAAM,GAAG,IAAI,aAAa,CAAQ,YAAY,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAClD,MAAM,aAAa,GAAG,MAAM,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;IAC9D,MAAM,SAAS,GAAG,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACtD,MAAM,MAAM,GAAG,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAE5D,MAAM,cAAc,GAAG,aAAa,CAAC,mBAAmB,CAAC,OAAO,EAAE;QAChE,WAAW,EAAE,CAAC,MAAM,EAAE,EAAE;YACtB,IAAI,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC;gBAClC,OAAO,MAAM,KAAK,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;YAC/D,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,YAAY,EAAE,cAAc;KAC7B,CAAC,CAAC;IACH,OAAO;QACL,MAAM;QACN,OAAO;QACP,aAAa;QACb,SAAS;QACT,MAAM;QACN,YAAY;QACZ,cAAc;KACf,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,12 @@
+export declare const initialise: import("../../../common/types").WrapperInitialiseFunction<{
+    eventHub: import("../../../common").EventHub<import("../..").Events>;
+    mountElement: HTMLElement;
+}, void, "sync", {
+    localEventHub: import("../../../common").EventHub<import("../..").Events>;
+    recipe: {
+        ocr: import("../..").OCRRecipeOptions;
+    };
+}> & {
+    vendorName: "incode" | "onfido" | "dummy-ocr";
+};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../modules/ocr/vendors/Incode/index.ts"],"names":[],"mappings":"AAoBA,eAAO,MAAM,UAAU;;;;;;;;;;CA4GrB,CAAC"}

package/dist/esm/modules/ocr/vendors/Incode/index.js

@@ -0,0 +1,105 @@
+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 { OCRStatus } from '../../../index.js';
+import { OneSDKError } from '../../../common/index.js';
+import { defineWrapper } from '../../../common/modules/defineModule.js';
+import { createEventHandlers, install, startCamera, } from '../../../common/vendors/incode/index.js';
+import { IDVClient } from '../../../frankie-client/clients/IDVClient.js';
+import { createSession } from '../common/createSession.js';
+import { initProcessAndEvaluateResults, } from '../common/initProcess.js';
+export const initialise = defineWrapper('incode', (shared, options) => __awaiter(void 0, void 0, void 0, function* () {
+    const { frankieClient, recipe: { ocr: { documents, provider } }, localEventHub, } = shared;
+    const { mountElement, eventHub } = options;
+    const idvClient = new IDVClient(frankieClient);
+    // generate session token from backend
+    const idvSession = yield createSession(idvClient, eventHub);
+    // terminate initialising if session failed
+    if (!idvSession) {
+        localEventHub.emit('loading', false, { message: `Failed while loading session for vendor 'Incode'` });
+        return;
+    }
+    const { vendorParameters } = idvSession;
+    try {
+        // initialise Incode with credentials
+        const { apiURL, token, interviewId } = vendorParameters;
+        const { incode } = yield install({
+            apiURL,
+            sdkVersion: provider.name === 'incode' && provider.sdkVersion,
+        });
+        const { onLog, onError } = createEventHandlers('ocr', { eventHub });
+        const cameraProps = {
+            incode,
+            token: { token, interviewId },
+            eventHub,
+            mountElement,
+            onError,
+            onLog,
+        };
+        // turn on camera to capture the front of document
+        const startCameraPromise = startCamera('ocr', Object.assign(Object.assign({}, cameraProps), { validate: ({ typeOfId, countryCode }) => {
+                var _a;
+                eventHub.emit('info', {
+                    message: 'onSuccess',
+                    payload: { typeOfId, countryCode },
+                });
+                const emitInputRequired = (documentType) => {
+                    eventHub.emit('input_required', {
+                        documentType,
+                        side: 'front',
+                    }, OCRStatus.DOCUMENTS_INVALID, () => ({}));
+                };
+                // Check if documents config is given,
+                if (!documents) {
+                    return true; // No documents, validation passes
+                }
+                // Find the accepted document type
+                const acceptedDocType = documents.find(({ type }) => type === (incodeDocumentsDict[typeOfId] || typeOfId));
+                // If no accepted document is matched, validation fails
+                if (!acceptedDocType) {
+                    emitInputRequired(documents[0].type);
+                    return false;
+                }
+                // If the accepted document does not specify countries, validation passes
+                if (!(acceptedDocType === null || acceptedDocType === void 0 ? void 0 : acceptedDocType.countries)) {
+                    return true;
+                }
+                // If the accepted document specifies countries
+                // and the country code is matched, validation passes
+                if ((_a = acceptedDocType === null || acceptedDocType === void 0 ? void 0 : acceptedDocType.countries) === null || _a === void 0 ? void 0 : _a.includes(countryCode)) {
+                    return true;
+                }
+                // validation fails in other cases
+                emitInputRequired(acceptedDocType.type);
+                return false;
+            }, onSuccess: () => {
+                eventHub.emit('session_closed');
+                initProcessAndEvaluateResults(shared, Object.assign(Object.assign({}, options), { attachReviewScreen: !feat('modules.ocr.containsReviewScreen.incode') }));
+            } }));
+        eventHub.emit('ready', { domElement: mountElement });
+        eventHub.emit('loading', false, { message: `Vendor 'Incode' screen has loaded` });
+        yield startCameraPromise;
+    }
+    catch (error) {
+        const { type = null, message = '' } = error;
+        eventHub.emit('error', new OneSDKError(`Error from vendor SDK 'Incode'`, {
+            type,
+            message,
+        }));
+        eventHub.emit('loading', false, { message: `Failed while executing vendor 'Incode'` });
+    }
+    return {};
+}));
+const incodeDocumentsDict = {
+    Passport: 'PASSPORT',
+    DriversLicense: 'DRIVERS_LICENCE',
+    MedicalCard: 'NATIONAL_HEALTH_ID',
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/modules/ocr/vendors/Incode/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../modules/ocr/vendors/Incode/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAKpE,OAAO,EACL,mBAAmB,EACnB,OAAO,EACP,WAAW,GACZ,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AAErE,OAAO,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAC;AACzE,OAAO,EACL,6BAA6B,GAC9B,MAAM,wCAAwC,CAAC;AAEhD,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAY,QAAQ,EAAE,CAC3D,MAAM,EACN,OAAO,EACP,EAAE;IACF,MAAM,EACJ,aAAa,EACb,MAAM,EAAE,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EACxC,aAAa,GACd,GAAG,MAAM,CAAC;IACX,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC3C,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;IAE/C,sCAAsC;IACtC,MAAM,UAAU,GAAG,MAAM,aAAa,CAAgB,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC3E,2CAA2C;IAC3C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,kDAAkD,EAAE,CAAC,CAAC;QACtG,OAAO;IACT,CAAC;IAED,MAAM,EAAE,gBAAgB,EAAE,GAAG,UAAU,CAAC;IAExC,IAAI,CAAC;QACH,qCAAqC;QACrC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,gBAAgB,CAAC;QACxD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,OAAO,CAAC;YAC/B,MAAM;YACN,UAAU,EAAE,QAAQ,CAAC,IAAI,KAAK,QAAQ,IAAI,QAAQ,CAAC,UAAU;SAC9D,CAAC,CAAC;QAEH,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,mBAAmB,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QACpE,MAAM,WAAW,GAAG;YAClB,MAAM;YACN,KAAK,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE;YAC7B,QAAQ;YACR,YAAY;YACZ,OAAO;YACP,KAAK;SACN,CAAC;QACF,kDAAkD;QAClD,MAAM,kBAAkB,GAAG,WAAW,CAAC,KAAK,kCACvC,WAAW,KACd,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAW,EAAE;;gBAC/C,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE;oBACpB,OAAO,EAAE,WAAW;oBACpB,OAAO,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE;iBACnC,CAAC,CAAC;gBACH,MAAM,iBAAiB,GAAG,CAAC,YAA0B,EAAQ,EAAE;oBAC7D,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE;wBAC9B,YAAY;wBACZ,IAAI,EAAE,OAAO;qBACd,EAAE,SAAS,CAAC,iBAAiB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC9C,CAAC,CAAC;gBAEF,sCAAsC;gBACtC,IAAI,CAAC,SAAS,EAAE,CAAC;oBACf,OAAO,IAAI,CAAC,CAAC,kCAAkC;gBACjD,CAAC;gBAED,kCAAkC;gBAClC,MAAM,eAAe,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC;gBAE3G,uDAAuD;gBACvD,IAAI,CAAC,eAAe,EAAE,CAAC;oBACrB,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;oBACrC,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,yEAAyE;gBACzE,IAAI,CAAC,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,SAAS,CAAA,EAAE,CAAC;oBAChC,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,+CAA+C;gBAC/C,qDAAqD;gBACrD,IAAI,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,SAAS,0CAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;oBACtD,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,kCAAkC;gBAClC,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;gBACxC,OAAO,KAAK,CAAC;YACf,CAAC,EACD,SAAS,EAAE,GAAG,EAAE;gBACd,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBAEhC,6BAA6B,CAAC,MAAM,kCAC/B,OAAO,KACV,kBAAkB,EAAE,CAAC,IAAI,CAAC,yCAAyC,CAAC,IACpE,CAAC;YACL,CAAC,IACD,CAAC;QACH,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;QACrD,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,mCAAmC,EAAE,CAAC,CAAC;QAClF,MAAM,kBAAkB,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC;QAC5C,QAAQ,CAAC,IAAI,CACX,OAAO,EACP,IAAI,WAAW,CAAC,gCAAgC,EAAE;YAChD,IAAI;YACJ,OAAO;SACR,CAAC,CACH,CAAC;QACF,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,wCAAwC,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC,CAAA,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAG;IAC1B,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,iBAAiB;IACjC,WAAW,EAAE,oBAAoB;CAClC,CAAC"}

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

@@ -0,0 +1,14 @@
+import type { EventHub } from '../../../common';
+import type { Events } from '../..';
+export declare const initialise: import("../../../common/types").WrapperInitialiseFunction<{
+    eventHub: EventHub<Events>;
+    mountElement: HTMLElement;
+}, void, "sync", {
+    localEventHub: EventHub<Events>;
+    recipe: {
+        ocr: import("../..").OCRRecipeOptions;
+    };
+}> & {
+    vendorName: "incode" | "onfido" | "dummy-ocr";
+};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../modules/ocr/vendors/Onfido/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAU/C,OAAO,KAAK,EAAE,MAAM,EAAa,MAAM,aAAa,CAAC;AAMrD,eAAO,MAAM,UAAU;;;;;;;;;;CA4FrB,CAAC"}

package/dist/esm/modules/ocr/vendors/Onfido/index.js

@@ -0,0 +1,105 @@
+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 { OneSDKError } from '../../../common/index.js';
+import { defineWrapper } from '../../../common/modules/defineModule.js';
+import { install, observeReady } from '../../../common/vendors/onfido/index.js';
+import { IDVClient } from '../../../frankie-client/clients/IDVClient.js';
+import { OCRStatus } from '../../../frankie-client/clients/OCRClient.js';
+import { createSession } from '../common/createSession.js';
+import { initProcessAndEvaluateResults, } from '../common/initProcess.js';
+export const initialise = defineWrapper('onfido', (shared, options) => __awaiter(void 0, void 0, void 0, function* () {
+    const { frankieClient, recipe } = shared;
+    const { ocr: { provider }, } = recipe;
+    const { mountElement, eventHub } = options;
+    const idvClient = new IDVClient(frankieClient);
+    // generate onfido sdk token from backend
+    const idvSession = yield createSession(idvClient, eventHub);
+    // terminate initialise if session failed
+    if (!idvSession) {
+        eventHub.emit('loading', false, { message: `Failed while loading session for vendor 'Onfido'` });
+        return;
+    }
+    observeReady('onfido-sdk-ui-Theme-portal', eventHub);
+    eventHub.on('ready', () => eventHub.emit('loading', false, { message: `Vendor 'Onfido' screen has loaded` }));
+    yield install({ sdkVersion: provider.name === 'onfido' && provider.sdkVersion });
+    // initialise onfido instance
+    const { token } = idvSession;
+    const Onfido = window.Onfido;
+    const instance = Onfido.init({
+        token,
+        containerEl: mountElement,
+        steps: ['document'],
+        useModal: true,
+        isModalOpen: true,
+        disableAnalytics: true,
+        disableAnalyticsCookies: true,
+        onComplete: () => __awaiter(void 0, void 0, void 0, function* () {
+            yield removeVendorSdk(instance, { eventHub });
+            initProcessAndEvaluateResults(shared, Object.assign(Object.assign({}, options), { attachReviewScreen: !feat('modules.ocr.containsReviewScreen.onfido') }));
+        }),
+        onError: (error) => __awaiter(void 0, void 0, void 0, function* () {
+            const { type = null, message = '' } = error;
+            eventHub.emit('error', new OneSDKError(`Error from vendor SDK 'Onfido'`, {
+                type,
+                message,
+            }));
+            yield removeVendorSdk(instance, {
+                eventHub,
+                loadingEvent: `Failed while executing vendor 'Onfido'`,
+            });
+        }),
+        onUserExit: () => __awaiter(void 0, void 0, void 0, function* () {
+            // When user has not completed the process and exited it, we emit input_required event
+            // This will trigger Onfido init modal again (see event listener for input_required at mount method)
+            eventHub.emit('input_required', {
+                documentType: null,
+                side: 'front',
+            }, OCRStatus.INTERRUPTED, () => ({}));
+            yield removeVendorSdk(instance, {
+                eventHub,
+                loadingEvent: 'User exited',
+            });
+        }),
+        onModalRequestClose: () => __awaiter(void 0, void 0, void 0, function* () {
+            // When user has not completed the process and exited it, we emit input_required event
+            // This will trigger Onfido init modal again (see event listener for input_required at mount method)
+            eventHub.emit('input_required', {
+                documentType: null,
+                side: 'front',
+            }, OCRStatus.INTERRUPTED, () => ({}));
+            yield removeVendorSdk(instance, {
+                eventHub,
+                loadingEvent: 'User exited',
+            });
+        }),
+    });
+    return {};
+}));
+// destroy onfido instance
+const removeVendorSdk = (instance, opts) => __awaiter(void 0, void 0, void 0, function* () {
+    const { eventHub, loadingEvent } = opts;
+    try {
+        yield instance.safeTearDown();
+        eventHub.emit('session_closed');
+    }
+    catch (error) {
+        const { type = null, message = '' } = error;
+        eventHub.emit('error', new OneSDKError(`Error from vendor SDK 'Onfido'`, {
+            type,
+            message,
+        }));
+    }
+    finally {
+        if (loadingEvent)
+            eventHub.emit('loading', false, { message: loadingEvent });
+    }
+});
+//# sourceMappingURL=index.js.map

package/dist/esm/modules/ocr/vendors/Onfido/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../modules/ocr/vendors/Onfido/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAEtC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAKtE,OAAO,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AAErE,OAAO,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAC;AACzE,OAAO,EACL,6BAA6B,GAC9B,MAAM,wCAAwC,CAAC;AAEhD,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAY,QAAQ,EAAE,CAC3D,MAAM,EACN,OAAO,EACP,EAAE;IACF,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IACzC,MAAM,EACJ,GAAG,EAAE,EAAE,QAAQ,EAAE,GAClB,GAAG,MAAM,CAAC;IACX,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC3C,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;IAE/C,yCAAyC;IACzC,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5D,yCAAyC;IACzC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,kDAAkD,EAAE,CAAC,CAAC;QACjG,OAAO;IACT,CAAC;IAED,YAAY,CAAC,4BAA4B,EAAE,QAAQ,CAAC,CAAC;IACrD,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,mCAAmC,EAAE,CAAC,CAAC,CAAC;IAC9G,MAAM,OAAO,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,IAAI,KAAK,QAAQ,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;IAEjF,6BAA6B;IAC7B,MAAM,EAAE,KAAK,EAAE,GAAG,UAAU,CAAC;IAC7B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7B,MAAM,QAAQ,GAAc,MAAM,CAAC,IAAI,CAAC;QACtC,KAAK;QACL,WAAW,EAAE,YAAY;QACzB,KAAK,EAAE,CAAC,UAAU,CAAC;QACnB,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,IAAI;QACjB,gBAAgB,EAAE,IAAI;QACtB,uBAAuB,EAAE,IAAI;QAC7B,UAAU,EAAE,GAAwB,EAAE;YACpC,MAAM,eAAe,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;YAE9C,6BAA6B,CAAC,MAAM,kCAC/B,OAAO,KACV,kBAAkB,EAAE,CAAC,IAAI,CAAC,yCAAyC,CAAC,IACpE,CAAC;QACL,CAAC,CAAA;QACD,OAAO,EAAE,CAAO,KAAe,EAAiB,EAAE;YAChD,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC;YAC5C,QAAQ,CAAC,IAAI,CACX,OAAO,EACP,IAAI,WAAW,CAAC,gCAAgC,EAAE;gBAChD,IAAI;gBACJ,OAAO;aACR,CAAC,CACH,CAAC;YACF,MAAM,eAAe,CAAC,QAAQ,EAAE;gBAC9B,QAAQ;gBACR,YAAY,EAAE,wCAAwC;aACvD,CAAC,CAAC;QACL,CAAC,CAAA;QACD,UAAU,EAAE,GAAwB,EAAE;YACpC,sFAAsF;YACtF,oGAAoG;YACpG,QAAQ,CAAC,IAAI,CACX,gBAAgB,EAChB;gBACE,YAAY,EAAE,IAAI;gBAClB,IAAI,EAAE,OAAO;aACd,EACD,SAAS,CAAC,WAAW,EACrB,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CACX,CAAC;YACF,MAAM,eAAe,CAAC,QAAQ,EAAE;gBAC9B,QAAQ;gBACR,YAAY,EAAE,aAAa;aAC5B,CAAC,CAAC;QACL,CAAC,CAAA;QACD,mBAAmB,EAAE,GAAwB,EAAE;YAC7C,sFAAsF;YACtF,oGAAoG;YACpG,QAAQ,CAAC,IAAI,CACX,gBAAgB,EAChB;gBACE,YAAY,EAAE,IAAI;gBAClB,IAAI,EAAE,OAAO;aACd,EACD,SAAS,CAAC,WAAW,EACrB,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CACX,CAAC;YACF,MAAM,eAAe,CAAC,QAAQ,EAAE;gBAC9B,QAAQ;gBACR,YAAY,EAAE,aAAa;aAC5B,CAAC,CAAC;QACL,CAAC,CAAA;KACF,CAAC,CAAC;IACH,OAAO,EAAE,CAAC;AACZ,CAAC,CAAA,CAAC,CAAC;AAEH,0BAA0B;AAC1B,MAAM,eAAe,GAAG,CACtB,QAAmB,EACnB,IAA2D,EAC5C,EAAE;IACjB,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IACxC,IAAI,CAAC;QACH,MAAM,QAAQ,CAAC,YAAY,EAAE,CAAC;QAC9B,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAClC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC;QAC5C,QAAQ,CAAC,IAAI,CACX,OAAO,EACP,IAAI,WAAW,CAAC,gCAAgC,EAAE;YAChD,IAAI;YACJ,OAAO;SACR,CAAC,CACH,CAAC;IACJ,CAAC;YAAS,CAAC;QACT,IAAI,YAAY;YAAE,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;IAC/E,CAAC;AACH,CAAC,CAAA,CAAC"}

package/dist/esm/modules/ocr/vendors/common/createSession.d.ts

@@ -0,0 +1,19 @@
+import type { EventHub } from '../../../common';
+import type { IDVClient } from '../../../frankie-client/clients/IDVClient';
+import type { Events } from '../../events';
+import type { _DictionaryWrite } from '../../../../types/index.js';
+/**
+ * Creates a session by obtaining an entity ID, token, and vendor parameters from an IDVClient.
+ * It will also emit 'session_data_generated' event to the provided event hub.
+ * This function won't throw errors. Instead, it will emit 'session_data_failed_loading' and return null.
+ *
+ * @param idvClient - The IDVClient instance used to obtain the session data.
+ * @param eventHub - The EventHub instance for emitting session-related events.
+ * @returns A Promise that resolves with an object containing entityId, token, and vendorParameters upon success, or null if a session couldn't be created
+ */
+export declare const createSession: <T extends _DictionaryWrite<unknown>>(idvClient: IDVClient, eventHub: EventHub<Events>) => Promise<{
+    entityId: string;
+    token: string;
+    vendorParameters: T;
+} | null>;
+//# sourceMappingURL=createSession.d.ts.map

package/dist/esm/modules/ocr/vendors/common/createSession.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createSession.d.ts","sourceRoot":"","sources":["../../../../../../modules/ocr/vendors/common/createSession.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAE/C;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,mDACb,SAAS,YACV,SAAS,MAAM,CAAC,KACzB,QAAQ;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,gBAAgB,EAAE,CAAC,CAAA;CAAE,GAAG,IAAI,CAYzE,CAAC"}

package/dist/esm/modules/ocr/vendors/common/createSession.js

@@ -0,0 +1,33 @@
+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());
+    });
+};
+/**
+ * Creates a session by obtaining an entity ID, token, and vendor parameters from an IDVClient.
+ * It will also emit 'session_data_generated' event to the provided event hub.
+ * This function won't throw errors. Instead, it will emit 'session_data_failed_loading' and return null.
+ *
+ * @param idvClient - The IDVClient instance used to obtain the session data.
+ * @param eventHub - The EventHub instance for emitting session-related events.
+ * @returns A Promise that resolves with an object containing entityId, token, and vendorParameters upon success, or null if a session couldn't be created
+ */
+export const createSession = (idvClient, eventHub) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const { entityId, token, vendorParameters } = yield idvClient.getToken();
+        eventHub.emit('session_data_generated', {
+            session: { entityId, token, vendorParameters },
+        });
+        return { entityId, token, vendorParameters };
+    }
+    catch (error) {
+        const { code = null, message = '' } = error;
+        eventHub.emit('session_data_failed_loading', { code, message });
+        return null;
+    }
+});
+//# sourceMappingURL=createSession.js.map

package/dist/esm/modules/ocr/vendors/common/createSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createSession.js","sourceRoot":"","sources":["../../../../../../modules/ocr/vendors/common/createSession.ts"],"names":[],"mappings":";;;;;;;;;AAKA;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,SAAoB,EACpB,QAA0B,EACgD,EAAE;IAC5E,IAAI,CAAC;QACH,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,EAAE,GAAG,MAAM,SAAS,CAAC,QAAQ,EAAK,CAAC;QAC5E,QAAQ,CAAC,IAAI,CAAC,wBAAwB,EAAE;YACtC,OAAO,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,EAAE;SAC/C,CAAC,CAAC;QACH,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC/C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC;QAC5C,QAAQ,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QAChE,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAA,CAAC"}

package/dist/esm/modules/ocr/vendors/common/initProcess.d.ts

@@ -0,0 +1,24 @@
+import type { WrapperParameters } from '../../../common/modules/defineModule';
+import type { OCRModule } from '../..';
+type Shared = WrapperParameters<OCRModule>[0];
+type Options = WrapperParameters<OCRModule>[1] & {
+    /** Each vendor wrapper needs to flag if their underlying vendor UI already contains a review screen.
+     * If it doesn't provide one, we ALWAYS flag that in 'attachReviewScreen' as true.
+     * This value can be manually overriden by recipe configuration (ocr.provideReviewScreen) */
+    attachReviewScreen: boolean;
+};
+/**
+ * This function will
+ * 1) Trigger the OCR processing
+ * 2) Fetch the updated individual details
+ * 3) Evaluate the OCR status to trigger the appropriate event
+ * 4) Initialise the Form for manual review, if required
+ *
+ * It will also emit loading events at the start and end of the process, as well as between long lasting steps
+ * @throws This function doesn't throw exceptions, only error events
+ * @param shared
+ * @param options
+ */
+export declare const initProcessAndEvaluateResults: (shared: Shared, options: Options) => Promise<void>;
+export {};
+//# sourceMappingURL=initProcess.d.ts.map

package/dist/esm/modules/ocr/vendors/common/initProcess.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"initProcess.d.ts","sourceRoot":"","sources":["../../../../../../modules/ocr/vendors/common/initProcess.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAM7E,OAAO,KAAK,EAAU,SAAS,EAAE,MAAM,aAAa,CAAC;AAOrD,KAAK,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9C,KAAK,OAAO,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG;IAC/C;;gGAE4F;IAC5F,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CAAC;AACF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,6BAA6B,WAChC,MAAM,WACL,OAAO,KACf,QAAQ,IAAI,CA6Cd,CAAC"}

package/dist/esm/modules/ocr/vendors/common/initProcess.js

@@ -0,0 +1,68 @@
+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 { OneSDKError, mkEventHub } from '../../../common/index.js';
+import { useFormToReviewResults, } from '../../../common/vendors/form/useForm.js';
+import { OCRClient } from '../../../frankie-client/clients/OCRClient.js';
+import { statusEvaluators } from './statusEvaluators.js';
+import { OCRStatus } from '../../../types.js';
+/**
+ * This function will
+ * 1) Trigger the OCR processing
+ * 2) Fetch the updated individual details
+ * 3) Evaluate the OCR status to trigger the appropriate event
+ * 4) Initialise the Form for manual review, if required
+ *
+ * It will also emit loading events at the start and end of the process, as well as between long lasting steps
+ * @throws This function doesn't throw exceptions, only error events
+ * @param shared
+ * @param options
+ */
+export const initProcessAndEvaluateResults = (shared, options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    const { frankieClient, oneSdkInstance, localEventHub } = shared;
+    try {
+        const ocrClient = new OCRClient(frankieClient);
+        localEventHub.emit('loading', true, { message: 'Retrieving IDV results' });
+        let response = yield ocrClient.attachNewOCRDocument();
+        // If waiting_ocr_run is returned, try to rerun
+        if (response.documentStatus === OCRStatus.WAITING_OCR_RUN) {
+            response = yield ocrClient.rerun(response.ocrDocument.documentId);
+        }
+        // Update global state with the latest ocr check outcome
+        yield oneSdkInstance.individual().search();
+        const { ocrDocument, documentStatus } = response;
+        const evaluateStatus = (_a = statusEvaluators[documentStatus]) !== null && _a !== void 0 ? _a : statusEvaluators.default;
+        // When receiving results event, initialise Form for user manual review
+        const privateEventHub = mkEventHub();
+        const mountElement = options.mountElement;
+        const recipeProvideReviewScreen = (_b = shared.recipe.ocr.provideReviewScreen) !== null && _b !== void 0 ? _b : feat('recipeDefaults.ocr.provideReviewScreen');
+        privateEventHub.on('results', useFormToReviewResults({
+            localEventHub,
+            mountElement,
+            oneSdkInstance,
+            // Based on recipe configuration and if the vendor options determine
+            // if Form should be attached
+            attachForm: recipeProvideReviewScreen && options.attachReviewScreen,
+        }));
+        privateEventHub.map(['input_required', 'error'], localEventHub);
+        evaluateStatus({
+            ocrDocument,
+            documentStatus,
+            ocrClient,
+            eventHub: privateEventHub,
+        });
+    }
+    catch (e) {
+        localEventHub.emit('error', new OneSDKError('Failed submitting and retrieving OCR results', e));
+        localEventHub.emit('loading', false, { message: 'Failed retrieving OCR results' });
+    }
+});
+//# sourceMappingURL=initProcess.js.map

package/dist/esm/modules/ocr/vendors/common/initProcess.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initProcess.js","sourceRoot":"","sources":["../../../../../../modules/ocr/vendors/common/initProcess.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEzD,OAAO,EACL,sBAAsB,GACvB,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AAKrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAC;AAC/E,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAS1C;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,MAAc,EACd,OAAgB,EACD,EAAE;;IACjB,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;IAChE,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;QAE/C,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC,CAAC;QAC3E,IAAI,QAAQ,GAAe,MAAM,SAAS,CAAC,oBAAoB,EAAE,CAAC;QAClE,+CAA+C;QAC/C,IAAI,QAAQ,CAAC,cAAc,KAAK,SAAS,CAAC,eAAe,EAAE,CAAC;YAC1D,QAAQ,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACpE,CAAC;QACD,wDAAwD;QACxD,MAAM,cAAc,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,CAAC;QAC3C,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,QAAQ,CAAC;QACjD,MAAM,cAAc,GAAG,MAAA,gBAAgB,CAAC,cAAc,CAAC,mCAAI,gBAAgB,CAAC,OAAO,CAAC;QAEpF,uEAAuE;QACvE,MAAM,eAAe,GAAG,UAAU,EAAU,CAAC;QAC7C,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC1C,MAAM,yBAAyB,GAC7B,MAAA,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,mCAAI,IAAI,CAAC,wCAAwC,CAAC,CAAC;QAE1F,eAAe,CAAC,EAAE,CAChB,SAAS,EACT,sBAAsB,CAAC;YACrB,aAAa;YACb,YAAY;YACZ,cAAc;YACd,oEAAoE;YACpE,6BAA6B;YAC7B,UAAU,EAAE,yBAAyB,IAAI,OAAO,CAAC,kBAAkB;SACpE,CAAC,CACH,CAAC;QACF,eAAe,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,CAAC;QAEhE,cAAc,CAAC;YACb,WAAW;YACX,cAAc;YACd,SAAS;YACT,QAAQ,EAAE,eAAe;SACN,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,WAAW,CAAC,8CAA8C,EAAE,CAAC,CAAC,CAAC,CAAC;QAChG,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,+BAA+B,EAAE,CAAC,CAAC;IACrF,CAAC;AACH,CAAC,CAAA,CAAC"}

package/dist/esm/modules/ocr/vendors/common/mutationObserver.d.ts

@@ -0,0 +1,4 @@
+import type { EventHub } from '../../../common';
+import type { Events } from '../..';
+export declare const observeModalReady: (mutationClass: string, eventHub: EventHub<Events>) => void;
+//# sourceMappingURL=mutationObserver.d.ts.map

package/dist/esm/modules/ocr/vendors/common/mutationObserver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mutationObserver.d.ts","sourceRoot":"","sources":["../../../../../../modules/ocr/vendors/common/mutationObserver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,eAAO,MAAM,iBAAiB,kBAAmB,MAAM,YAAY,SAAS,MAAM,CAAC,KAAG,IAkBrF,CAAC"}

package/dist/esm/modules/ocr/vendors/common/mutationObserver.js

@@ -0,0 +1,21 @@
+export const observeModalReady = (mutationClass, eventHub) => {
+    // Select the target node
+    const targetNode = document.querySelector('body');
+    // Create an observer instance
+    const observer = new MutationObserver((mutations, observer) => {
+        var _a;
+        for (const mutation of mutations) {
+            const mutationElement = (_a = mutation.addedNodes) === null || _a === void 0 ? void 0 : _a[0];
+            if (mutationElement === null || mutationElement === void 0 ? void 0 : mutationElement.classList.contains(mutationClass)) {
+                eventHub.emit('ready', { domElement: mutationElement });
+                // stop observing
+                observer.disconnect();
+            }
+        }
+    });
+    // Options for the observer (which mutations to observe)
+    const config = { childList: true, subtree: true };
+    // Start observing the target node for specified mutations
+    observer.observe(targetNode, config);
+};
+//# sourceMappingURL=mutationObserver.js.map

package/dist/esm/modules/ocr/vendors/common/mutationObserver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mutationObserver.js","sourceRoot":"","sources":["../../../../../../modules/ocr/vendors/common/mutationObserver.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,aAAqB,EAAE,QAA0B,EAAQ,EAAE;IAC3F,yBAAyB;IACzB,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAClD,8BAA8B;IAC9B,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,CAAC,SAA2B,EAAE,QAA0B,EAAE,EAAE;;QAChG,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,eAAe,GAAG,MAAA,QAAQ,CAAC,UAAU,0CAAG,CAAC,CAAgB,CAAC;YAChE,IAAI,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;gBACvD,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC,CAAC;gBACxD,iBAAiB;gBACjB,QAAQ,CAAC,UAAU,EAAE,CAAC;YACxB,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IACH,wDAAwD;IACxD,MAAM,MAAM,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAClD,0DAA0D;IAC1D,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AACvC,CAAC,CAAC"}

package/dist/esm/modules/ocr/vendors/common/statusEvaluators.d.ts

@@ -0,0 +1,18 @@
+import { OCRStatus } from '../../../index.js';
+import type { EventHub } from '../../../common';
+import type { Document } from '../../../common/shared/models/Document';
+import type { OCRClient } from '../../../frankie-client/clients/OCRClient';
+import type { Events } from '../..';
+export interface StatusEvaluators {
+    ocrDocument?: Document;
+    documentStatus?: OCRStatus;
+    ocrClient?: OCRClient;
+    eventHub: EventHub<Events>;
+}
+export declare const statusEvaluators: {
+    readonly COMPLETE_OCR: ({ ocrDocument, ocrClient, eventHub }: StatusEvaluators) => void;
+    readonly AWAITING_DOCUMENT_OCR: ({ eventHub }: StatusEvaluators) => void;
+    readonly AWAITING_OCR_RESULTS_PROVIDER_OFFLINE: ({ eventHub }: StatusEvaluators) => void;
+    readonly default: ({ documentStatus, eventHub }: StatusEvaluators) => void;
+};
+//# sourceMappingURL=statusEvaluators.d.ts.map

package/dist/esm/modules/ocr/vendors/common/statusEvaluators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"statusEvaluators.d.ts","sourceRoot":"","sources":["../../../../../../modules/ocr/vendors/common/statusEvaluators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAC,MAAM,gBAAgB,CAAC;AAE9C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,WAAW,gBAAgB;IAC/B,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB,cAAc,CAAC,EAAE,SAAS,CAAC;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,eAAO,MAAM,gBAAgB;kEACkC,gBAAgB;mDAEjC,gBAAgB;mEASf,gBAAgB;qDAQrB,gBAAgB;CAEhD,CAAC"}

package/dist/esm/modules/ocr/vendors/common/statusEvaluators.js

@@ -0,0 +1,11 @@
+import { OCRStatus } from '../../../index.js';
+import { OneSDKError } from '../../../common/index.js';
+export const statusEvaluators = {
+    [OCRStatus.COMPLETE]: ({ ocrDocument, ocrClient, eventHub }) => eventHub.emit('results', { document: ocrDocument, entityId: ocrClient.entityId }),
+    [OCRStatus.WAITING_OCR_RUN]: ({ eventHub }) => {
+        eventHub.emit('error', new OneSDKError(`Two attempts to get OCR results failed with an unresolved "${OCRStatus.WAITING_OCR_RUN}". This is a system failure.`, { payload: null }));
+    },
+    [OCRStatus.PROVIDER_OFFLINE]: ({ eventHub }) => eventHub.emit('error', new OneSDKError(`Provider is offline. Either switch providers and restart or skip OCR temporarily. Status ${OCRStatus.PROVIDER_OFFLINE}`, { payload: null })),
+    default: ({ documentStatus, eventHub }) => eventHub.emit('input_required', { documentType: null, side: 'front' }, documentStatus, () => ({})),
+};
+//# sourceMappingURL=statusEvaluators.js.map

package/dist/esm/modules/ocr/vendors/common/statusEvaluators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"statusEvaluators.js","sourceRoot":"","sources":["../../../../../../modules/ocr/vendors/common/statusEvaluators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAY7C,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAoB,EAAE,EAAE,CAC/E,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC;IACnF,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAoB,EAAE,EAAE;QAC9D,QAAQ,CAAC,IAAI,CACX,OAAO,EACP,IAAI,WAAW,CACb,8DAA8D,SAAS,CAAC,eAAe,8BAA8B,EACrH,EAAE,OAAO,EAAE,IAAI,EAAE,CAClB,CACF,CAAC;IACJ,CAAC;IACD,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAoB,EAAE,EAAE,CAC/D,QAAQ,CAAC,IAAI,CACX,OAAO,EACP,IAAI,WAAW,CACb,4FAA4F,SAAS,CAAC,gBAAgB,EAAE,EACxH,EAAE,OAAO,EAAE,IAAI,EAAE,CAClB,CACF;IACH,OAAO,EAAE,CAAC,EAAE,cAAc,EAAE,QAAQ,EAAoB,EAAE,EAAE,CAC1D,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;CAC5F,CAAC"}