@frankieone/one-sdk 0.1.0-poc.17 → 0.1.0-poc.18

package/README.md

@@ -1,25 +1 @@
-## Release
-
-### npm
-
-`one-sdk` will be published as npm package within @frankieone scope. The complete package name will match to [package.json](./package.json)'s name field.
-
-### CDN
-
-The `umd` version of bundle will be deployed to aws [s3](https://aws.amazon.com/s3/) and served by the [cloudfront](https://aws.amazon.com/cloudfront/) as CDN.
-
-The CDN URL is composed with following https://{base-url}/{version}/{file-name}
-
-#### base-url
-
-The base-url to be confirmed as we do not have a production environment set up yet. We are using portal dev environment for the time being during the poc stage.
-
-base-url: `latest.frankiefinancial.io/one-sdk/`
-
-#### version
-
-This version matches to [package.json](./package.json)'s version field.
-
-#### file-name
-
-Finale bundle and minified file and map: `one-sdk.umd.js`, `one-sdk.umd.js.map`
+# FrankieOne's OneSdk

package/dist/commit.txt

@@ -0,0 +1 @@
+2b14edeb3eec1e6f184652b6cc8a8d90fe91118d

package/dist/esm/modules/common/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const Components: {
+    readonly device: import("../device").DeviceModule;
+};
+export declare type Components = typeof Components;

package/dist/esm/modules/common/constants.js

@@ -0,0 +1,5 @@
+import { deviceModule } from "../device";
+export const Components = {
+    device: deviceModule,
+};
+//# sourceMappingURL=constants.js.map

package/dist/esm/modules/common/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../modules/common/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,MAAM,EAAE,YAAY;CACZ,CAAC"}

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

@@ -0,0 +1,7 @@
+export * from "./modules/loadAsyncAsset";
+export * from "./modules/eventHub";
+export * from "./modules/base64";
+export * from "./modules/env2url";
+export * from "./modules/merge";
+export * from "./types/Configuration";
+export * from "./constants";

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

@@ -0,0 +1,8 @@
+export * from "./modules/loadAsyncAsset";
+export * from "./modules/eventHub";
+export * from "./modules/base64";
+export * from "./modules/env2url";
+export * from "./modules/merge";
+export * from "./types/Configuration";
+export * from "./constants";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC"}

package/dist/{types/models/utils → esm/modules/common/modules}/base64.d.ts

@@ -1,11 +1,11 @@
-/// <reference types="node" />
-import { Buffer } from "buffer";
-export declare function stringToBase64(s: string): string;
-export declare function bufferToBase64(b: Buffer): string;
-export declare function base64ToString(bs: string): string;
-export declare function bufferToString(b: Buffer): string;
-export declare function hexToByteString(hex: string): string;
-export declare function hexToBytes(hex: string): number[];
-export declare function bytesToBase64(byt: number[]): string;
-export declare function bufferToByteString(buff: Buffer): number[];
-export declare function stringToByteString(str: string): number[];
+/// <reference types="node" />
+import { Buffer } from "buffer";
+export declare function stringToBase64(s: string): string;
+export declare function bufferToBase64(b: Buffer): string;
+export declare function base64ToString(bs: string): string;
+export declare function bufferToString(b: Buffer): string;
+export declare function hexToByteString(hex: string): string;
+export declare function hexToBytes(hex: string): number[];
+export declare function bytesToBase64(byt: number[]): string;
+export declare function bufferToByteString(buff: Buffer): number[];
+export declare function stringToByteString(str: string): number[];

package/dist/esm/modules/common/modules/base64.js

@@ -0,0 +1,37 @@
+import convertHex from "convert-hex";
+import { Buffer } from "buffer";
+export function stringToBase64(s) {
+    return bufferToBase64(Buffer.from(s, "utf8"));
+}
+export function bufferToBase64(b) {
+    return b.toString("base64");
+}
+export function base64ToString(bs) {
+    return Buffer.from(bs, "base64").toString("utf8");
+}
+export function bufferToString(b) {
+    return b.toString("utf8");
+}
+export function hexToByteString(hex) {
+    const bytes = hexToBytes(hex);
+    const buffer = Buffer.from(bytes);
+    return bufferToString(buffer);
+}
+export function hexToBytes(hex) {
+    const bytes = convertHex.hexToBytes(hex);
+    return bytes;
+}
+export function bytesToBase64(byt) {
+    const buffer = Buffer.from(byt);
+    return bufferToBase64(buffer);
+}
+export function bufferToByteString(buff) {
+    const bytes = Array.from(buff);
+    return bytes;
+}
+export function stringToByteString(str) {
+    const buffer = Buffer.from(str);
+    const bytes = bufferToByteString(buffer);
+    return bytes;
+}
+//# sourceMappingURL=base64.js.map

package/dist/esm/modules/common/modules/base64.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base64.js","sourceRoot":"","sources":["../../../../../modules/common/modules/base64.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,MAAM,UAAU,cAAc,CAAC,CAAS;IACtC,OAAO,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AAChD,CAAC;AACD,MAAM,UAAU,cAAc,CAAC,CAAS;IACtC,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC9B,CAAC;AACD,MAAM,UAAU,cAAc,CAAC,EAAU;IACvC,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACpD,CAAC;AACD,MAAM,UAAU,cAAc,CAAC,CAAS;IACtC,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC;AACD,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,MAAM,KAAK,GAAa,UAAU,CAAC,GAAG,CAAC,CAAC;IACxC,MAAM,MAAM,GAAW,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1C,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AACD,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,MAAM,KAAK,GAAa,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACnD,OAAO,KAAK,CAAC;AACf,CAAC;AACD,MAAM,UAAU,aAAa,CAAC,GAAa;IACzC,MAAM,MAAM,GAAW,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxC,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AACD,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,OAAO,KAAK,CAAC;AACf,CAAC;AACD,MAAM,UAAU,kBAAkB,CAAC,GAAW;IAC5C,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChC,MAAM,KAAK,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACzC,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/esm/modules/common/modules/env2url.d.ts

@@ -0,0 +1,9 @@
+export declare enum ENVIRONMENTS {
+    development = "development",
+    local = "local",
+    production = "production",
+    uat = "uat",
+    demo = "demo",
+    qa = "qa"
+}
+export declare const env2url: (env: ENVIRONMENTS) => string;

package/dist/esm/modules/common/modules/env2url.js

@@ -0,0 +1,30 @@
+export var ENVIRONMENTS;
+(function (ENVIRONMENTS) {
+    ENVIRONMENTS["development"] = "development";
+    ENVIRONMENTS["local"] = "local";
+    ENVIRONMENTS["production"] = "production";
+    ENVIRONMENTS["uat"] = "uat";
+    ENVIRONMENTS["demo"] = "demo";
+    ENVIRONMENTS["qa"] = "qa";
+})(ENVIRONMENTS || (ENVIRONMENTS = {}));
+export const env2url = (env) => {
+    switch (env.toLowerCase()) {
+        case "latest":
+        case "development":
+        case "dev":
+            return "https://backend.latest.frankiefinancial.io";
+        case "qa":
+        case "staging3":
+            return "https://backend.staging3.latest.frankiefinancial.io";
+        case "demo":
+            return "https://backend.demo.frankiefinancial.io";
+        case "uat":
+            return "https://backend.kycaml.uat.frankiefinancial.io";
+        case "prod":
+        case "production":
+            return `https://backend.kycaml.frankiefinancial.io`;
+        default:
+            return `https://backend.${env}.latest.frankiefinancial.io`;
+    }
+};
+//# sourceMappingURL=env2url.js.map

package/dist/esm/modules/common/modules/env2url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"env2url.js","sourceRoot":"","sources":["../../../../../modules/common/modules/env2url.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,2CAA2B,CAAA;IAC3B,+BAAe,CAAA;IACf,yCAAyB,CAAA;IACzB,2BAAW,CAAA;IACX,6BAAa,CAAA;IACb,yBAAS,CAAA;AACX,CAAC,EAPW,YAAY,KAAZ,YAAY,QAOvB;AACD,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,GAAiB,EAAE,EAAE;IAC3C,QAAQ,GAAG,CAAC,WAAW,EAAE,EAAE;QACzB,KAAK,QAAQ,CAAC;QACd,KAAK,aAAa,CAAC;QACnB,KAAK,KAAK;YACR,OAAO,4CAA4C,CAAC;QACtD,KAAK,IAAI,CAAC;QACV,KAAK,UAAU;YACb,OAAO,qDAAqD,CAAC;QAC/D,KAAK,MAAM;YACT,OAAO,0CAA0C,CAAC;QACpD,KAAK,KAAK;YACR,OAAO,gDAAgD,CAAC;QAC1D,KAAK,MAAM,CAAC;QACZ,KAAK,YAAY;YACf,OAAO,4CAA4C,CAAC;QACtD;YACE,OAAO,mBAAmB,GAAG,6BAA6B,CAAC;KAC9D;AACH,CAAC,CAAC"}

package/dist/esm/modules/common/modules/eventHub.d.ts

@@ -0,0 +1,8 @@
+export declare function mkEventHub<Events extends EventsDictionary>(): EventHub<Events>;
+export declare type EventsDictionary = Record<string, unknown[]>;
+export declare type EventListener<Arguments extends unknown[]> = (...args: Arguments) => void;
+export declare type EventHub<ModuleEvents extends EventsDictionary = Record<string, unknown[]>> = {
+    on: <EventName extends keyof ModuleEvents>(eventName: EventName, listener: EventListener<ModuleEvents[EventName]>) => void;
+    off: <EventName extends keyof ModuleEvents>(eventName: EventName, listener: EventListener<ModuleEvents[EventName]>) => void;
+    emit: <EventName extends keyof ModuleEvents>(eventName: EventName, ...args: ModuleEvents[EventName]) => void;
+};

package/dist/esm/modules/common/modules/eventHub.js

@@ -0,0 +1,16 @@
+import EE from "event-emitter";
+export function mkEventHub() {
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    const Emitter = function () { };
+    EE(Emitter.prototype);
+    const emitter = new Emitter();
+    const originalEmit = emitter.emit;
+    const emit = (eventName, args) => originalEmit.apply(emitter, [eventName, ...args]);
+    return Object.assign(emitter, {
+        emit: (eventName, ...args) => {
+            emit(eventName, args);
+            emit("*", [{ eventName, arguments: args }]);
+        },
+    });
+}
+//# sourceMappingURL=eventHub.js.map

package/dist/esm/modules/common/modules/eventHub.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventHub.js","sourceRoot":"","sources":["../../../../../modules/common/modules/eventHub.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,eAAe,CAAC;AAE/B,MAAM,UAAU,UAAU;IACxB,gEAAgE;IAChE,MAAM,OAAO,GAAG,cAAa,CAAC,CAAC;IAC/B,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACtB,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAC9B,MAAM,YAAY,GAAG,OAAO,CAAC,IAAwB,CAAC;IACtD,MAAM,IAAI,GAAG,CAAC,SAAiB,EAAE,IAAe,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;IACvG,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;QAC5B,IAAI,EAAE,CAAC,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE;YAC3B,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACtB,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC9C,CAAC;KACF,CAAC,CAAC;AACL,CAAC"}

package/dist/esm/modules/common/modules/loadAsyncAsset.d.ts

@@ -0,0 +1 @@
+export declare function loadAsyncAsset(url: string, type?: "script" | "style"): Promise<void>;

package/dist/esm/modules/common/modules/loadAsyncAsset.js

@@ -0,0 +1,9 @@
+import loader from "load-script-promise";
+export function loadAsyncAsset(url, type = "script") {
+    if (type === "script")
+        return loader.loadScript(url);
+    if (type === "style")
+        return loader.loadCSS(url);
+    return Promise.reject("No valid loader type");
+}
+//# sourceMappingURL=loadAsyncAsset.js.map

package/dist/esm/modules/common/modules/loadAsyncAsset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadAsyncAsset.js","sourceRoot":"","sources":["../../../../../modules/common/modules/loadAsyncAsset.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,qBAAqB,CAAC;AAEzC,MAAM,UAAU,cAAc,CAAC,GAAW,EAAE,OAA2B,QAAQ;IAC7E,IAAI,IAAI,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACrD,IAAI,IAAI,KAAK,OAAO;QAAE,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACjD,OAAO,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAChD,CAAC"}

package/dist/esm/modules/common/modules/merge.d.ts

@@ -0,0 +1 @@
+export { default as merge } from "lodash.merge";

package/dist/esm/modules/common/modules/merge.js

@@ -0,0 +1,2 @@
+export { default as merge } from "lodash.merge";
+//# sourceMappingURL=merge.js.map

package/dist/esm/modules/common/modules/merge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge.js","sourceRoot":"","sources":["../../../../../modules/common/modules/merge.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,cAAc,CAAC"}

package/dist/esm/modules/common/types/Configuration.d.ts

@@ -0,0 +1,22 @@
+import { Vendor } from "../../device";
+export declare type RecipeConfiguration = {
+    name?: string;
+    device?: {
+        provider: {
+            name: Vendor;
+            clientID: string;
+        };
+    };
+    ocr?: {
+        provider: {
+            name: "ocrlabs";
+            tx_id: string;
+        };
+    };
+    biometrics?: {
+        provider: {
+            name: "ocrlabs";
+            tx_id: string;
+        };
+    };
+};

package/dist/esm/modules/common/types/Configuration.js

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

package/dist/esm/modules/common/types/Configuration.js.map

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

package/dist/esm/modules/device/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const VendorList: readonly ["sardine", "threatmetrix"];
+export declare const ActivityTypeList: readonly ["REGISTRATION", "LOGIN", "LOGOUT"];
+export declare type Vendor = typeof VendorList[number];
+export declare type ActivityType = typeof ActivityTypeList[number];

package/dist/esm/modules/device/constants.js

@@ -0,0 +1,4 @@
+// hard coded list of supported vendors which maps directly to a vendor wrapper
+export const VendorList = ["sardine", "threatmetrix"];
+export const ActivityTypeList = ["REGISTRATION", "LOGIN", "LOGOUT"];
+//# sourceMappingURL=constants.js.map

package/dist/esm/modules/device/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../modules/device/constants.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,SAAS,EAAE,cAAc,CAAU,CAAC;AAC/D,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,cAAc,EAAE,OAAO,EAAE,QAAQ,CAAU,CAAC"}

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

@@ -0,0 +1,4 @@
+import { DeviceModule } from "./types";
+export * from "./types";
+export * from "./constants";
+export declare const deviceModule: DeviceModule;

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

@@ -0,0 +1,95 @@
+import { mkEventHub } from "../common";
+import { validateConfiguration } from "./parseConfiguration";
+export * from "./types";
+export * from "./constants";
+const loadVendorSdk = async (vendor) => {
+    let moduleLoader; /** Expects file with interface { wrapper: VendorWrapper } */
+    if (vendor === "sardine")
+        moduleLoader = import(/* webpackChunkName: 'device-sardine' */ "./vendors/Sardine");
+    if (vendor === "threatmetrix")
+        moduleLoader = import(/* webpackChunkName: 'device-threatmetrix' */ "./vendors/Threatmetrix");
+    if (!moduleLoader)
+        throw new Error(`Vendor not recognised: '${vendor}'`);
+    return moduleLoader.then((module) => module.wrapper);
+};
+export const deviceModule = {
+    initialise(options) {
+        /**
+         * All the oneSdk components expose a synchronous "ModuleContext" object whose properties
+         * need to be declared outside the asynchronous "main" function. They are then "passed down" to be used by the main function.
+         *
+         * This keeps all modules initialisation signatures uniform.
+         * The "main" function is assynchronous and will return data in form of events.
+         *
+         * The set function allows customer to make "late" changes to internal module data (after initialisation options).
+         *  Things such as set "username/email/applicant reference" as soon as they are discovered
+         * The on and off functions allow customers to listen for internal lifecycle events
+         */
+        // Validate configuration or interrupt flow by throwing error.
+        options = validateConfiguration(options);
+        // Create a new event hub separated from the global event hub to be distributed across the modules's lifecycle
+        // Maybe we should just use the one event hub passed in the options object for all the modules of the one sdk?
+        // For that the events dictionary for all modules would need to be centralised
+        // const eventHub = options.globalEventHub; <-- this
+        const eventHub = mkEventHub(); // <--instead of this
+        const { recipe, globalEventHub } = options;
+        let vendorContext = null;
+        // main will trigger the following procedure
+        // - determine vendor from recipe configuration
+        // - load vendor sdk (async)
+        //    - initialise vendor session (async)
+        // - initialise vendor sdk (async)
+        //    - provide vendor context object as soon as sdk is initialised.
+        // - Vendor context API is the same for all vendors. All the particularities are implemented within the vendor wrapper
+        const main = async () => {
+            const provider = recipe.device.provider.name;
+            vendorContext = await loadVendorSdk(provider)
+                .then((sdk) => sdk.initialise({ ...options, eventHub }))
+                .then((context) => {
+                eventHub.emit("vendor_sdk_loaded", { vendor: provider });
+                return context;
+            })
+                .catch((errorObject) => {
+                eventHub.emit("vendor_sdk_failed_loading", { vendor: provider, errorObject });
+                return null;
+            });
+        };
+        // reemit/transform events
+        eventHub.on("value_set", ({ key, value }) => {
+            // when event "value_set" happens for activity type,
+            // reemit event as the more meaninful "activity_started"
+            if (key === "activityType")
+                eventHub.emit("activity_started", { activityType: value });
+        });
+        const startActivity = async (activityType) => {
+            vendorContext.set("activityType", activityType);
+        };
+        if (!vendorContext)
+            main();
+        else
+            globalEventHub.emit("warning", { message: "Double initialisation of Device module detected." });
+        return {
+            on: (...args) => void eventHub.on(...args),
+            off: (...args) => void eventHub.off(...args),
+            // Experiment: If calling startActivity on a uninitialised vendor, it will first automatically
+            // wait for the event vendor_sdk_loaded and then try again
+            // Not sure we're still going to use method "startActivity", TBD
+            startActivity: runIfWhen({
+                run: startActivity,
+                condition: () => Boolean(vendorContext),
+                elseWaitFor: "vendor_sdk_loaded",
+                eventHub,
+            }),
+        };
+    },
+};
+const runIfWhen = (opt) => ((...args) => new Promise((resolve) => {
+    if (opt.condition())
+        resolve(opt.run(...args));
+    else {
+        opt.eventHub.on(opt.elseWaitFor, async () => {
+            resolve(opt.run(...args));
+        });
+    }
+}));
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/device/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAY,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAY7D,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAE5B,MAAM,aAAa,GAAG,KAAK,EAAE,MAAc,EAA0B,EAAE;IACrE,IAAI,YAAY,CAAC,CAAC,6DAA6D;IAC/E,IAAI,MAAM,KAAK,SAAS;QAAE,YAAY,GAAG,MAAM,CAAC,wCAAwC,CAAC,mBAAmB,CAAC,CAAC;IAC9G,IAAI,MAAM,KAAK,cAAc;QAC3B,YAAY,GAAG,MAAM,CAAC,6CAA6C,CAAC,wBAAwB,CAAC,CAAC;IAEhG,IAAI,CAAC,YAAY;QAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,MAAM,GAAG,CAAC,CAAC;IACzE,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAiB;IACxC,UAAU,CAAC,OAA8C;QACvD;;;;;;;;;;WAUG;QACH,8DAA8D;QAC9D,OAAO,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;QACzC,8GAA8G;QAC9G,8GAA8G;QAC9G,8EAA8E;QAC9E,oDAAoD;QACpD,MAAM,QAAQ,GAAG,UAAU,EAAU,CAAC,CAAC,qBAAqB;QAC5D,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAC3C,IAAI,aAAa,GAAyB,IAAI,CAAC;QAE/C,4CAA4C;QAC5C,+CAA+C;QAC/C,4BAA4B;QAC5B,yCAAyC;QACzC,kCAAkC;QAClC,oEAAoE;QACpE,sHAAsH;QACtH,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;YACtB,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC7C,aAAa,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC;iBAC1C,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,GAAG,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;iBACvD,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBAChB,QAAQ,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;gBACzD,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE;gBACrB,QAAQ,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC;gBAC9E,OAAO,IAAI,CAAC;YACd,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,0BAA0B;QAC1B,QAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE;YAC1C,oDAAoD;YACpD,wDAAwD;YACxD,IAAI,GAAG,KAAK,cAAc;gBAAE,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,YAAY,EAAE,KAAqB,EAAE,CAAC,CAAC;QACzG,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,KAAK,EAAE,YAA0B,EAAE,EAAE;YACzD,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;QAClD,CAAC,CAAC;QAEF,IAAI,CAAC,aAAa;YAAE,IAAI,EAAE,CAAC;;YACtB,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,kDAAkD,EAAE,CAAC,CAAC;QAErG,OAAO;YACL,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;YAC1C,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,KAAK,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;YAC5C,8FAA8F;YAC9F,0DAA0D;YAC1D,gEAAgE;YAChE,aAAa,EAAE,SAAS,CAAC;gBACvB,GAAG,EAAE,aAAyB;gBAC9B,SAAS,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC;gBACvC,WAAW,EAAE,mBAAmB;gBAChC,QAAQ;aACT,CAAC;SACH,CAAC;IACJ,CAAC;CACF,CAAC;AAsBF,MAAM,SAAS,GAAG,CAA4B,GAAsB,EAAY,EAAE,CAChF,CAAC,CAAC,GAAG,IAAe,EAAE,EAAE,CACtB,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;IACtB,IAAI,GAAG,CAAC,SAAS,EAAE;QAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;SAC1C;QACH,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;YAC1C,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;KACJ;AACH,CAAC,CAAC,CAAa,CAAC"}

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

@@ -0,0 +1,5 @@
+import { BaseModuleOptions } from "../sdk/types";
+import { UserModuleOptions } from "./types";
+declare type AllConfiguration = BaseModuleOptions & UserModuleOptions;
+export declare function validateConfiguration(options: AllConfiguration): AllConfiguration;
+export {};

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

@@ -0,0 +1,15 @@
+export function validateConfiguration(options) {
+    const { globalEventHub, recipe } = options;
+    const interruptWithError = mkErrorEmitter(globalEventHub, options);
+    if (!recipe.device)
+        interruptWithError("Missing device configuration.");
+    return options;
+}
+const mkErrorEmitter = (globalEventHub, options) => (message) => {
+    globalEventHub.emit("error", {
+        message: `${message} look for 'payload' in the 'error' event.`,
+        payload: options,
+    });
+    throw new Error(message);
+};
+//# sourceMappingURL=parseConfiguration.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"parseConfiguration.js","sourceRoot":"","sources":["../../../../modules/device/parseConfiguration.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,qBAAqB,CAAC,OAAyB;IAC7D,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC3C,MAAM,kBAAkB,GAAG,cAAc,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAEnE,IAAI,CAAC,MAAM,CAAC,MAAM;QAAE,kBAAkB,CAAC,+BAA+B,CAAC,CAAC;IACxE,OAAO,OAAO,CAAC;AACjB,CAAC;AACD,MAAM,cAAc,GAAG,CAAC,cAAsC,EAAE,OAAyB,EAAE,EAAE,CAAC,CAAC,OAAe,EAAE,EAAE;IAChH,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE;QAC3B,OAAO,EAAE,GAAG,OAAO,2CAA2C;QAC9D,OAAO,EAAE,OAAO;KACjB,CAAC,CAAC;IACH,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;AAC3B,CAAC,CAAC"}

package/dist/esm/modules/device/types/events.d.ts

@@ -0,0 +1,30 @@
+import { RecipeConfiguration } from "../../common";
+import { ActivityType, Vendor } from "../constants";
+export declare type Events = {
+    configuration_loaded: [RecipeConfiguration];
+    activity_started: [{
+        activityType: ActivityType;
+    }];
+    device_details_extracted: [{
+        device: Record<string, string | number | object>;
+    }];
+    completed: [Core["DeviceDetailsObject"]];
+    vendor_sdk_loaded: [{
+        vendor: Vendor;
+    }];
+    vendor_sdk_failed_loading: [{
+        vendor: Vendor;
+        errorObject: any;
+    }];
+    session_data_generated: [{
+        session: Record<string, any>;
+    }];
+    value_set: [{
+        key: string;
+        value: unknown;
+    }];
+};
+interface Core {
+    DeviceDetailsObject: Record<string, never>;
+}
+export {};

package/dist/esm/modules/device/types/events.js

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

package/dist/esm/modules/device/types/events.js.map

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

package/dist/esm/modules/device/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./events";
+export * from "./module";
+export * from "./vendor";

package/dist/esm/modules/device/types/index.js

@@ -0,0 +1,4 @@
+export * from "./events";
+export * from "./module";
+export * from "./vendor";
+//# sourceMappingURL=index.js.map

package/dist/esm/modules/device/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../modules/device/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC"}

package/dist/esm/modules/device/types/module.d.ts

@@ -0,0 +1,15 @@
+import { BaseModuleOptions } from "../../sdk/types";
+import { EventHub } from "../../common";
+import { ActivityType } from "../constants";
+import { Events } from "./events";
+export interface DeviceModule {
+    initialise: (o: BaseModuleOptions & UserModuleOptions) => DeviceModuleContext;
+}
+export interface UserModuleOptions {
+    page: string;
+}
+export interface DeviceModuleContext extends Omit<EventHub<Events>, "emit"> {
+    startActivity: StartActivityFunction;
+}
+export declare type StartActivityFunction = (activityType: ActivityType) => Promise<void>;
+export declare type EndActivityFunction = () => Promise<void>;

package/dist/esm/modules/device/types/module.js

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

package/dist/esm/modules/device/types/module.js.map

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

package/dist/esm/modules/device/types/vendor.d.ts

@@ -0,0 +1,33 @@
+import { EventHub } from "../../common";
+import { ActivityType, Vendor } from "../constants";
+import { Events } from "./events";
+import { BaseModuleOptions } from "../../sdk/types";
+import { UserModuleOptions } from "./module";
+export interface WrapperModule {
+    wrapper: VendorWrapper;
+}
+export interface VendorWrapper {
+    readonly vendor: Vendor;
+    initialise(o: VendorOptions): Promise<VendorContext>;
+}
+export interface SetOptions {
+    activityType: ActivityType;
+    entityId: string;
+}
+export interface VendorContext {
+    readonly vendor: Vendor;
+    set<Key extends keyof SetOptions>(key: Key, value: SetOptions[Key]): void;
+}
+export interface AdditionalDeviceInternalDependencies {
+    eventHub: EventHub<Events>;
+}
+export interface SessionData {
+    frankieClientID: string;
+    customerID: string;
+    vendorSessionID: string;
+}
+export declare type VendorOptions = BaseModuleOptions & UserModuleOptions & AdditionalDeviceInternalDependencies;
+export declare type VendorLoaderOptions = {
+    module: VendorOptions;
+    session: SessionData;
+};

package/dist/esm/modules/device/types/vendor.js

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

package/dist/esm/modules/device/types/vendor.js.map

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

package/dist/esm/modules/device/vendors/Sardine.d.ts

@@ -0,0 +1,19 @@
+import { VendorWrapper } from "../types/vendor";
+declare const wrapper: VendorWrapper;
+export { wrapper };
+interface SardineSdkOptions {
+    clientId: string;
+    userIdHash: string;
+    flow: string;
+    partnerID: string;
+    sessionKey: string;
+}
+declare global {
+    interface Window {
+        _Sardine: {
+            createContext(...args: unknown[]): {
+                updateConfig(config: Partial<SardineSdkOptions>): void;
+            };
+        };
+    }
+}

package/dist/esm/modules/device/vendors/Sardine.js

@@ -0,0 +1,63 @@
+import { loadAsyncAsset } from "../../common";
+import { v4 as uuid } from "uuid";
+const wrapper = {
+    vendor: "sardine",
+    async initialise(options) {
+        // create session with backend
+        const sessionData = await initialiseSardineSession(options);
+        options.eventHub.emit("session_data_generated", {
+            session: sessionData,
+        });
+        // initialise sardine sdk
+        const sardineContext = await asyncLoadSardine({
+            module: options,
+            session: sessionData,
+        });
+        // listen for events, if there are any in the frontend
+        // maybe we should implement our own events by websockets, if no frontend events are emitted
+        return sardineContext;
+    },
+};
+export { wrapper };
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+async function initialiseSardineSession(options) {
+    return {
+        customerID: options.session.customerChildID ?? options.session.customerID,
+        frankieClientID: options.recipe.device.provider.clientID,
+        vendorSessionID: uuid(), // will come from a backend call
+    };
+}
+async function asyncLoadSardine(options) {
+    const { mode } = options.module;
+    const isProd = mode === "production";
+    const sardineHost = isProd ? "api.sardine.ai" : "api.dev.sardine.ai";
+    const url = `https://${sardineHost}/assets/loader.min.js`;
+    await loadAsyncAsset(url);
+    const sardineContext = window._Sardine.createContext({
+        clientId: options.session.frankieClientID,
+        partnerID: options.session.customerID,
+        sessionKey: options.session.vendorSessionID,
+        parentElement: document.body,
+        environment: isProd ? "production" : "development",
+        onDeviceResponse: function (data) {
+            options.module.eventHub.emit("device_details_extracted", {
+                device: data,
+            });
+        },
+    });
+    return {
+        vendor: "sardine",
+        set(key, value) {
+            const mappedKey = mapF2S[key];
+            if (mappedKey) {
+                sardineContext.updateConfig({ [mappedKey]: value });
+                options.module.eventHub.emit("value_set", { key, value });
+            }
+        },
+    };
+}
+const mapF2S = {
+    entityId: "userIdHash",
+    activityType: "flow",
+};
+//# sourceMappingURL=Sardine.js.map