@frankieone/one-sdk 0.0.1-npm

package/README.md

@@ -0,0 +1,6 @@
+# frontend-onesdk-library
+
+FrankieOne OneSDK Library
+
+<sub>This readme was generated using the Github repository provisioning
+pipeline.</sub>

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

@@ -0,0 +1,42 @@
+import type { EventHub } from '../common';
+import type { ModuleDefinition } from '../common/types';
+import type { Events } from './events';
+import type { PartialDeep } from 'type-fest';
+export type BiometricsModule = ModuleDefinition<{
+    module: {
+        category: 'component';
+        name: 'biometrics';
+        events: Events;
+        context: {
+            mount(domElementOrSelector: string | HTMLElement): void;
+        };
+        options: PartialDeep<BiometricsRecipeOptions>;
+        recipe: {
+            biometrics: BiometricsRecipeOptions;
+        };
+    };
+    wrapper: {
+        vendors: ['dummy-biometrics', 'ocrlabs', 'onfido', 'incode'];
+        loadType: 'sync';
+        options: {
+            eventHub: EventHub<Events>;
+            mountElement: HTMLElement;
+        };
+    };
+}>;
+type BiometricsRecipeOptions = {
+    provider: {
+        name: 'ocrlabs';
+        tx_id: string;
+    } | {
+        name: 'onfido';
+        fallback?: 'standard' | 'video';
+        sdkVersion?: string;
+    } | {
+        name: 'incode';
+        sdkVersion?: string;
+    };
+    is_synchronous?: boolean;
+};
+export {};
+//# sourceMappingURL=definition.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"definition.d.ts","sourceRoot":"","sources":["../../../../modules/biometrics/definition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7C,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;IAC9C,MAAM,EAAE;QACN,QAAQ,EAAE,WAAW,CAAC;QACtB,IAAI,EAAE,YAAY,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE;YACP,KAAK,CAAC,oBAAoB,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAAC;SACzD,CAAC;QACF,OAAO,EAAE,WAAW,CAAC,uBAAuB,CAAC,CAAC;QAC9C,MAAM,EAAE;YACN,UAAU,EAAE,uBAAuB,CAAC;SACrC,CAAC;KACH,CAAC;IACF,OAAO,EAAE;QACP,OAAO,EAAE,CAAC,kBAAkB,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC7D,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE;YAEP,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC3B,YAAY,EAAE,WAAW,CAAC;SAC3B,CAAC;KACH,CAAC;CACH,CAAC,CAAC;AAEH,KAAK,uBAAuB,GAAG;IAC7B,QAAQ,EACJ;QACF,IAAI,EAAE,SAAS,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;KACf,GACG;QACF,IAAI,EAAE,QAAQ,CAAC;QACf,QAAQ,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC;QAChC,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GACG;QACF,IAAI,EAAE,QAAQ,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAA"}

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

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

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

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

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

@@ -0,0 +1,42 @@
+import type { Document } from '../common/shared/models/Document';
+import type { IDVStatus } from '../frankie-client/clients/IDVClient';
+import type { BiometricsModule } from './definition';
+type Vendor = BiometricsModule['vendorName'];
+export type Events = {
+    vendor_sdk_loaded: [{
+        vendor: Vendor;
+    }];
+    vendor_sdk_failed_loading: [{
+        vendor: Vendor;
+        errorObject: unknown;
+    }];
+    session_data_generated: [{
+        session: unknown;
+    }];
+    session_data_failed_loading: [{
+        code?: unknown;
+        message: string;
+    }];
+    ready: [{
+        domElement: HTMLElement;
+    }];
+    input_required: [info: {
+        entityId: string;
+    }, status: IDVStatus];
+    detection_complete: [];
+    detection_failed: [{
+        message?: string;
+    }];
+    processing: [{
+        checkStatus: IDVStatus;
+        entityId: string;
+    }];
+    results: [{
+        checkStatus: IDVStatus;
+        document: Document;
+        entityId: string;
+    }];
+    session_closed: [];
+};
+export {};
+//# sourceMappingURL=events.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../modules/biometrics/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AAE1E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAErD,KAAK,MAAM,GAAG,gBAAgB,CAAC,YAAY,CAAC,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG;IACnB,iBAAiB,EAAE,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACxC,yBAAyB,EAAE,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IACtE,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,cAAc,EAAE,CAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IAChE,kBAAkB,EAAE,EAAE,CAAC;IACvB,gBAAgB,EAAE,CAAC;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACzC,UAAU,EAAE,CAAC;QAAE,WAAW,EAAE,SAAS,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC3D,OAAO,EAAE,CAAC;QAAE,WAAW,EAAE,SAAS,CAAC;QAAC,QAAQ,EAAE,QAAQ,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC5E,cAAc,EAAE,EAAE,CAAC;CACpB,CAAC"}

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

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

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

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

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

@@ -0,0 +1,7 @@
+import type { Events } from './events';
+import type { BiometricsModule } from './definition';
+export type { Events };
+declare const _default: import("../common/types").BrandedInitialiseFunction<BiometricsModule>;
+export default _default;
+export * from './definition';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../modules/biometrics/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAOxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAErD,YAAY,EAAE,MAAM,EAAE,CAAC;;AAEvB,wBAuGE;AAEF,cAAc,cAAc,CAAC"}

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

@@ -0,0 +1,84 @@
+import merge from 'lodash.merge';
+import { mkVendorLoader } from '../common/index.js';
+import { defineModule } from '../common/modules/defineModule.js';
+import { SdkModes } from '../sdk/types/index.js';
+import { validateConfiguration } from './parseConfiguration.js';
+export default defineModule('biometrics', (globalState, options) => {
+    validateConfiguration(globalState);
+    const { globalEventHub, recipe: { biometrics }, localEventHub, } = globalState;
+    // @TODO add validation check
+    Object.assign(biometrics, merge(biometrics, options));
+    const loadVendorWrapper = mkVendorLoader({
+        // If initialising in dummy mode, force the use of the dummy-biometrics wrapper
+        // otherwise load the wrapper based on the provider's name
+        vendorName: globalState.mode.modeName === SdkModes.DUMMY
+            ? 'dummy-biometrics'
+            : biometrics.provider.name,
+        sharedConfiguration: globalState,
+        vendorLoader: {
+            ocrlabs: () => import(
+            /* webpackChunkName: 'biometrics-ocrlabs' */ './vendors/OcrLabs/index.js'),
+            onfido: () => import(
+            /* webpackChunkName: 'biometrics-onfido' */ './vendors/Onfido/index.js'),
+            incode: () => import(
+            /* webpackChunkName: 'biometrics-incode' */ './vendors/Incode/index.js'),
+            'dummy-biometrics': () => import(
+            /* webpackChunkName: 'biometrics-dummy' */ './vendors/dummy-biometrics/index.js'),
+        },
+    });
+    // Publicly exposed "mount" function
+    const mount = (domElementOrSelector) => {
+        // Load and initialise vendor wrapper
+        // Which will automatically mount camera feed to HTML element provided as parameter above
+        loadVendorWrapper({
+            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 values required by the wrapper and the vendor loading function
+                return {
+                    eventHub: localEventHub,
+                    mountElement,
+                };
+            },
+            onSuccess: (_, { vendorName }) => {
+                globalEventHub.emit('telemetry', {
+                    eventName: 'BIOMETRICS:MOUNT',
+                    data: { vendor: vendorName },
+                });
+            },
+            onError: (error, { vendorName }) => {
+                globalEventHub.emit('telemetry', {
+                    eventName: 'BIOMETRICS:MOUNT:ERROR',
+                    data: { vendor: vendorName },
+                    error,
+                });
+            },
+        });
+    };
+    // Event mappings for telemetry
+    localEventHub.on('results', (results) => globalEventHub.emit('telemetry', {
+        eventName: 'BIOMETRICS:RESULTS',
+        data: {
+            checkStatus: results.checkStatus,
+            entityId: results.entityId,
+            allEmittedFields: Object.keys(results),
+        },
+    }));
+    localEventHub.on('processing', (status) => globalEventHub.emit('telemetry', {
+        eventName: 'BIOMETRICS:PROCESSING',
+        data: {
+            checkStatus: status.checkStatus,
+            entityId: status.entityId,
+            allEmittedFields: Object.keys(status),
+        },
+    }));
+    return {
+        mount,
+    };
+});
+export * from './definition.js';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/biometrics/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,cAAc,CAAC;AAGjC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAM7D,eAAe,YAAY,CACzB,YAAY,EACZ,CAAC,WAAW,EAAE,OAAO,EAAE,EAAE;IACvB,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAEnC,MAAM,EACJ,cAAc,EACd,MAAM,EAAE,EAAE,UAAU,EAAE,EACtB,aAAa,GACd,GAAG,WAAW,CAAC;IAEhB,6BAA6B;IAC7B,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAEtD,MAAM,iBAAiB,GAAG,cAAc,CAAC;QACvC,+EAA+E;QAC/E,0DAA0D;QAC1D,UAAU,EACR,WAAW,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,KAAK;YAC1C,CAAC,CAAC,kBAAkB;YACpB,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI;QAC9B,mBAAmB,EAAE,WAAW;QAChC,YAAY,EAAE;YACZ,OAAO,EAAE,GAAG,EAAE,CACZ,MAAM;YACJ,4CAA4C,CAAC,4BAA4B,CAC1E;YACH,MAAM,EAAE,GAAG,EAAE,CACX,MAAM;YACJ,2CAA2C,CAAC,2BAA2B,CACxE;YACH,MAAM,EAAE,GAAG,EAAE,CACX,MAAM;YACJ,2CAA2C,CAAC,2BAA2B,CACxE;YACH,kBAAkB,EAAE,GAAG,EAAE,CACvB,MAAM;YACJ,0CAA0C,CAAC,qCAAqC,CACjF;SACJ;KACF,CAAC,CAAC;IAEH,oCAAoC;IACpC,MAAM,KAAK,GAAG,CAAC,oBAA0C,EAAE,EAAE;QAC3D,qCAAqC;QACrC,yFAAyF;QACzF,iBAAiB,CAAC;YAChB,oBAAoB,EAAE,GAAG,EAAE;gBACzB,kCAAkC;gBAClC,MAAM,YAAY,GAChB,OAAO,oBAAoB,KAAK,QAAQ;oBACtC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAc,oBAAoB,CAAC;oBAClE,CAAC,CAAC,oBAAoB,CAAC;gBAC3B,IAAI,CAAC,YAAY;oBACf,MAAM,IAAI,KAAK,CAAC,eAAe,oBAAoB,aAAa,CAAC,CAAC;gBACpE,wEAAwE;gBACxE,OAAO;oBACL,QAAQ,EAAE,aAAa;oBACvB,YAAY;iBACb,CAAC;YACJ,CAAC;YACD,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;gBAC/B,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC/B,SAAS,EAAE,kBAAkB;oBAC7B,IAAI,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE;iBAC7B,CAAC,CAAC;YACL,CAAC;YACD,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;gBACjC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC/B,SAAS,EAAE,wBAAwB;oBACnC,IAAI,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE;oBAC5B,KAAK;iBACN,CAAC,CAAC;YACL,CAAC;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,+BAA+B;IAC/B,aAAa,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE,CACtC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;QAC/B,SAAS,EAAE,oBAAoB;QAC/B,IAAI,EAAE;YACJ,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,gBAAgB,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;SACvC;KACF,CAAC,CACH,CAAC;IACF,aAAa,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CACxC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;QAC/B,SAAS,EAAE,uBAAuB;QAClC,IAAI,EAAE;YACJ,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,gBAAgB,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACtC;KACF,CAAC,CACH,CAAC;IAEF,OAAO;QACL,KAAK;KACN,CAAC;AACJ,CAAC,CACF,CAAC;AAEF,cAAc,cAAc,CAAC"}

package/dist/esm/modules/biometrics/parseConfiguration.d.ts

@@ -0,0 +1,3 @@
+import { InjectedState } from "../common/types";
+export declare function validateConfiguration(options: InjectedState): void;
+//# sourceMappingURL=parseConfiguration.d.ts.map

package/dist/esm/modules/biometrics/parseConfiguration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseConfiguration.d.ts","sourceRoot":"","sources":["../../../../modules/biometrics/parseConfiguration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,aAAa,QAI3D"}

package/dist/esm/modules/biometrics/parseConfiguration.js

@@ -0,0 +1,6 @@
+export function validateConfiguration(options) {
+    const { recipe } = options;
+    if (!recipe.biometrics)
+        throw new Error("Missing biometrics configuration");
+}
+//# sourceMappingURL=parseConfiguration.js.map

package/dist/esm/modules/biometrics/parseConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseConfiguration.js","sourceRoot":"","sources":["../../../../modules/biometrics/parseConfiguration.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,qBAAqB,CAAC,OAAsB;IAC1D,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC,MAAM,CAAC,UAAU;QAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;AAC9E,CAAC"}

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

@@ -0,0 +1,25 @@
+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: {
+        biometrics: {
+            provider: {
+                name: "ocrlabs";
+                tx_id: string;
+            } | {
+                name: "onfido";
+                fallback?: "standard" | "video";
+                sdkVersion?: string;
+            } | {
+                name: "incode";
+                sdkVersion?: string;
+            };
+            is_synchronous?: boolean;
+        };
+    };
+}> & {
+    vendorName: "incode" | "onfido" | "ocrlabs" | "dummy-biometrics";
+};
+//# sourceMappingURL=index.d.ts.map

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

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

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

@@ -0,0 +1,75 @@
+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 { createSession } from '../common/createSession.js';
+import { mkErrors } from '../common/errors.js';
+import { initProcess } from '../common/initProcess.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';
+export const initialise = defineWrapper('incode', (shared, options) => __awaiter(void 0, void 0, void 0, function* () {
+    const { frankieClient, recipe } = shared;
+    const { biometrics: { provider } } = recipe;
+    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)
+        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,
+        });
+        /**
+         * There is CSS misalignment from Incode loading animation
+         * Adding style override to enforce center alignment
+         */
+        const styleSheet = document.createElement('style');
+        styleSheet.innerHTML = `
+      .IncodeCaptureSelfieBordersContainer {
+        display: flex;
+        align-items: center;
+        justify-content: center;
+      }`;
+        document.head.appendChild(styleSheet);
+        const { onLog, onError, } = createEventHandlers('biometrics', {
+            eventHub,
+            entityId: idvClient.entityId,
+        });
+        const cameraProps = {
+            incode,
+            token: { token, interviewId },
+            eventHub,
+            mountElement,
+            onError,
+            onLog,
+        };
+        // turn on camera to capture selfie
+        // "void" operator indicates the intention of non-blocking async process
+        // it allows other events to emit while using camera to capture
+        void startCamera('biometrics', Object.assign(Object.assign({}, cameraProps), { onSuccess: () => __awaiter(void 0, void 0, void 0, function* () {
+                eventHub.emit('detection_complete');
+                yield initProcess({ idvClient, recipe, eventHub });
+                eventHub.emit('session_closed');
+            }) }));
+        eventHub.emit('ready', { domElement: mountElement });
+    }
+    catch (error) {
+        const errorMessages = mkErrors(recipe);
+        const { type = null, message = '' } = error;
+        eventHub.emit('error', errorMessages('DEFAULT', { type, message }));
+    }
+    return {};
+}));
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../modules/biometrics/vendors/Incode/index.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,aAAa,EAAE,MAAM,iDAAiD,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,MAAM,0CAA0C,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,+CAA+C,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAEpE,OAAO,EACL,mBAAmB,EACnB,OAAO,EACP,WAAW,GACZ,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AAErE,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAmB,QAAQ,EAAE,CAClE,MAAM,EACN,OAAO,EACP,EAAE;IACF,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IACzC,MAAM,EAAE,UAAU,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,MAAM,CAAC;IAC5C,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;QAAE,OAAO;IACxB,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;;;WAGG;QACH,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACnD,UAAU,CAAC,SAAS,GAAG;;;;;QAKnB,CAAC;QACL,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QAEtC,MAAM,EACJ,KAAK,EACL,OAAO,GACR,GAAG,mBAAmB,CAAC,YAAY,EAAE;YACpC,QAAQ;YACR,QAAQ,EAAE,SAAS,CAAC,QAAQ;SAC7B,CAAC,CAAC;QACH,MAAM,WAAW,GAAG;YAClB,MAAM;YACN,KAAK,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE;YAC7B,QAAQ;YACR,YAAY;YACZ,OAAO;YACP,KAAK;SACN,CAAC;QACF,mCAAmC;QACnC,wEAAwE;QACxE,+DAA+D;QAC/D,KAAK,WAAW,CAAC,YAAY,kCACxB,WAAW,KACd,SAAS,EAAE,GAAwB,EAAE;gBACnC,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;gBACpC,MAAM,WAAW,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;gBACnD,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAClC,CAAC,CAAA,IACD,CAAC;QACH,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;IACvD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC;QAC5C,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACtE,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC,CAAA,CAAC,CAAC"}

package/dist/esm/modules/biometrics/vendors/OcrLabs/index.d.ts

@@ -0,0 +1,27 @@
+import './window';
+import './nolint_liveness-v3.2.0.vendor';
+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: {
+        biometrics: {
+            provider: {
+                name: "ocrlabs";
+                tx_id: string;
+            } | {
+                name: "onfido";
+                fallback?: "standard" | "video";
+                sdkVersion?: string;
+            } | {
+                name: "incode";
+                sdkVersion?: string;
+            };
+            is_synchronous?: boolean;
+        };
+    };
+}> & {
+    vendorName: "incode" | "onfido" | "ocrlabs" | "dummy-biometrics";
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/modules/biometrics/vendors/OcrLabs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../modules/biometrics/vendors/OcrLabs/index.ts"],"names":[],"mappings":"AASA,OAAO,UAAU,CAAC;AAClB,OAAO,iCAAiC,CAAC;AA8BzC,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;CAIrB,CAAC"}

package/dist/esm/modules/biometrics/vendors/OcrLabs/index.js

@@ -0,0 +1,254 @@
+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 { createSession } from '../common/createSession.js';
+import { mkErrors } from '../common/errors.js';
+import { initProcess } from '../common/initProcess.js';
+import { defineWrapper } from '../../../common/modules/defineModule.js';
+import { IDVClient } from '../../../frankie-client/clients/IDVClient.js';
+// this './window' import serves only to force the type into the build. Don't remove it.
+import './window.js';
+import './nolint_liveness-v3.2.0.vendor.js';
+const Liveness = window.Liveness;
+const OverlayColours = {
+    base: '#fff',
+    success: '#14ffc0',
+    error: '#ff4747',
+};
+const MaskDimension = {
+    width: 90,
+    height: 125,
+    scale: 0.75,
+};
+// calculates the scale ratio for the mount element size relative to the original mask dimensions
+const calculateScaleRatio = ({ width, height }) => {
+    const { width: maskWidth, height: maskHeight, scale: maskScale } = MaskDimension;
+    const relativeRatio = Math.min(width / maskWidth, height / maskHeight);
+    return relativeRatio * maskScale;
+};
+export const initialise = defineWrapper('ocrlabs', (shared, options) => __awaiter(void 0, void 0, void 0, function* () {
+    // prematurely mount our ui to the dom before sdk session initialisation.
+    mountUserInterface(shared, options);
+    return {};
+}));
+// TODO: extract this into common and share with DUMMY mode
+const mountUserInterface = (shared, options) => {
+    const { mountElement: originalElement } = options;
+    const mountElement = originalElement.cloneNode(true);
+    originalElement.parentNode.replaceChild(mountElement, originalElement);
+    mountElement.id = 'onesdk_idv_container';
+    Object.assign(mountElement.style, {
+        position: 'absolute',
+        top: '0',
+        left: '0',
+        height: '100%',
+        minHeight: '50px',
+        width: '100%',
+        overflow: 'hidden',
+    });
+    // convert content to be responsive based on viewport
+    const metaTag = document.createElement('meta');
+    metaTag.name = 'viewport';
+    metaTag.content = 'width=device-width, initial-scale=1.0';
+    document.head.appendChild(metaTag);
+    document.querySelector('body').style.margin = '0';
+    const loader = document.createElement('div');
+    loader.id = 'onesdk_idv_loader';
+    Object.assign(loader.style, {
+        position: 'absolute',
+        height: '100%',
+        width: '100%',
+        display: 'flex',
+        justifyContent: 'center',
+        paddingTop: '20px',
+        fontFamily: '"Helvetica Neue", Helvetica, Arial, sans-serif',
+        fontSize: '24px',
+        color: '#fff',
+        backgroundColor: '#000',
+        zIndex: 9,
+    });
+    loader.innerText = 'Loading...';
+    mountElement.appendChild(loader);
+    const videoElement = document.createElement('video');
+    videoElement.id = 'onesdk_idv_video';
+    videoElement.autoplay = true;
+    videoElement.muted = true;
+    videoElement.playsInline = true;
+    Object.assign(videoElement.style, {
+        position: 'absolute',
+        top: '0',
+        left: '0',
+        height: '100%',
+        width: '100%',
+        objectFit: 'cover',
+        transform: 'scale(-1, 1)', // mirror the video element
+    });
+    mountElement.appendChild(videoElement);
+    const overlayContainer = document.createElement('div');
+    overlayContainer.id = 'onesdk_idv_overlay';
+    Object.assign(overlayContainer.style, {
+        position: 'absolute',
+        top: '0',
+        left: '0',
+        height: '100%',
+        width: '100%',
+        display: 'flex',
+        justifyContent: 'center',
+        alignItems: 'center',
+    });
+    const mask = document.createElement('div');
+    mask.id = 'onesdk_idv_mask';
+    const { width, height } = MaskDimension;
+    const scaleRatio = calculateScaleRatio({
+        width: mountElement.offsetWidth,
+        height: mountElement.offsetHeight,
+    });
+    Object.assign(mask.style, {
+        width: `${width * scaleRatio}px`,
+        height: `${height * scaleRatio}px`,
+        backgroundColor: 'transparent',
+        border: `${scaleRatio}px solid ${OverlayColours.base}`,
+        // create oval-shaped mask
+        borderRadius: '50% / 40% 40% 60% 60%',
+        // fill up area outside of oval
+        boxShadow: '0 0 0 9999px rgba(0, 0, 0, 0.75)',
+    });
+    overlayContainer.appendChild(mask);
+    mountElement.appendChild(overlayContainer);
+    const instructions = document.createElement('div');
+    instructions.id = 'onesdk_idv_instructions';
+    Object.assign(instructions.style, {
+        position: 'absolute',
+        bottom: '20px',
+        left: '50%',
+        transform: 'translate(-50%, 0)',
+        color: '#fff',
+        fontFamily: '"Helvetica Neue", Helvetica, Arial, sans-serif',
+        fontSize: '24px',
+        zIndex: '1',
+    });
+    mountElement.appendChild(instructions);
+    loadOcrLabs(shared, options);
+    return videoElement;
+};
+// reset to the original container dom element and close the ocrlabs session.
+const cleanup = (shared, options) => __awaiter(void 0, void 0, void 0, function* () {
+    const { recipe } = shared;
+    const { eventHub, mountElement } = options;
+    const errorMessages = mkErrors(recipe);
+    const cloneElement = document.getElementById('onesdk_idv_container');
+    cloneElement && cloneElement.parentNode.replaceChild(mountElement, cloneElement);
+    try {
+        yield Liveness.close();
+        eventHub.emit('session_closed');
+    }
+    catch (error) {
+        const { message } = error;
+        eventHub.emit('error', errorMessages('DEFAULT', { message }));
+        return false;
+    }
+    return true;
+});
+const loadOcrLabs = (shared, options) => __awaiter(void 0, void 0, void 0, function* () {
+    const { frankieClient, recipe } = shared;
+    const { biometrics: { provider }, } = recipe;
+    const { eventHub } = options;
+    const idvClient = new IDVClient(frankieClient);
+    const errorMessages = mkErrors(recipe);
+    // fetch session data for ocrlabs initialisation.
+    const idvSession = yield createSession(idvClient, eventHub);
+    // terminate initialise if session failed
+    if (!idvSession)
+        return;
+    const { token } = idvSession;
+    const sessionData = {
+        session_id: token,
+        tx_id: provider.name === 'ocrlabs' && provider.tx_id,
+    };
+    // initialise ocrlabs session, then run liveness checks.
+    const videoElement = document.getElementById('onesdk_idv_video');
+    const loader = document.getElementById('onesdk_idv_loader');
+    // handle process errors such as network issues.
+    /* istanbul ignore next */
+    Liveness.observer.on('error', (error) => {
+        const { message } = error;
+        eventHub.emit('error', errorMessages('DEFAULT', { message }));
+        cleanup(shared, options);
+    });
+    // initialise ocrlabs session.
+    try {
+        yield Liveness.createSession('wss://engine.au.v3.liveness.idkit.io', {
+            videoElement,
+            auth: sessionData,
+        });
+        // update ui and broadcast event in case the consumer is providing their own initialisation ui.
+        loader.remove();
+        eventHub.emit('ready', { domElement: videoElement });
+        yield runLivenessChecks(shared, options, idvClient);
+    }
+    catch (error) {
+        eventHub.emit('session_data_failed_loading', {
+            code: error.code || null,
+            message: error.message,
+        });
+        yield cleanup(shared, options);
+    }
+});
+const runLivenessChecks = (shared, options, idvClient) => __awaiter(void 0, void 0, void 0, function* () {
+    const { recipe } = shared;
+    const { eventHub } = options;
+    const errorMessages = mkErrors(recipe);
+    const instructions = document.getElementById('onesdk_idv_instructions');
+    const mask = document.getElementById('onesdk_idv_mask');
+    instructions.style.display = 'block';
+    // manage the timing of ui changes during each detection step.
+    const handleDetection = (type, instructionCopy) => __awaiter(void 0, void 0, void 0, function* () {
+        const MIN_INSTRUCTION_DISPLAY_TIME = Liveness.delay || 2000;
+        const detection = (resolve, reject) => __awaiter(void 0, void 0, void 0, function* () {
+            try {
+                instructions.innerText = instructionCopy;
+                mask.style.borderColor = OverlayColours.base;
+                yield Liveness.detect(type, {
+                    retry: true,
+                    timeout: 7500,
+                });
+                instructions.innerText = 'Thanks!';
+                mask.style.borderColor = OverlayColours.success;
+                setTimeout(() => {
+                    resolve(true);
+                }, MIN_INSTRUCTION_DISPLAY_TIME);
+            }
+            catch (error) {
+                instructions.innerText = 'Something went wrong';
+                mask.style.borderColor = OverlayColours.error;
+                eventHub.emit('detection_failed', {
+                    message: error && error.message ? error.message : null,
+                });
+                setTimeout(() => {
+                    cleanup(shared, options);
+                    reject(false);
+                }, MIN_INSTRUCTION_DISPLAY_TIME);
+            }
+        });
+        return new Promise(detection);
+    });
+    yield handleDetection('face', 'Position your face within the frame');
+    yield handleDetection('smile', 'Please give us a BIG Smile!');
+    eventHub.emit('detection_complete');
+    try {
+        if (!(yield cleanup(shared, options)))
+            return; // escape initProcess if cleanup failed
+        yield initProcess({ idvClient, recipe, eventHub });
+    }
+    catch (error) {
+        const { message } = error;
+        eventHub.emit('error', errorMessages('INIT_PROCESS', { message }));
+    }
+});
+//# sourceMappingURL=index.js.map