@frankieone/one-sdk 0.0.1-npm

package/dist/esm/modules/ocr/vendors/dummy-ocr/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/dummy-ocr/index.d.ts.map

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

package/dist/esm/modules/ocr/vendors/dummy-ocr/index.js

@@ -0,0 +1,116 @@
+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 { OneSDKError } from '../../../common/index.js';
+import { defineWrapper } from '../../../common/modules/defineModule.js';
+import { observeReady } from '../../../common/vendors/onfido/index.js';
+import { IDVClient } from '../../../frankie-client/clients/IDVClient.js';
+import { OCRClient, OCRStatus, } from '../../../frankie-client/clients/OCRClient.js';
+import { statusEvaluators, } from '../common/statusEvaluators.js';
+export const initialise = defineWrapper('dummy-ocr', (shared, options) => __awaiter(void 0, void 0, void 0, function* () {
+    const { frankieClient } = shared;
+    const { mountElement, eventHub } = options;
+    const idvClient = new IDVClient(frankieClient);
+    const ocrClient = new OCRClient(frankieClient);
+    try {
+        // generate onfido sdk token from backend
+        const { entityId, token, vendorParameters } = yield idvClient.getToken();
+        eventHub.emit('session_data_generated', {
+            session: { entityId, token, vendorParameters },
+        });
+        observeReady('dummy-ocr-modal', eventHub);
+        // Create a modal container
+        const modalContainer = document.createElement('div');
+        Object.assign(modalContainer.style, {
+            position: 'fixed',
+            top: '0',
+            left: '0',
+            width: '100%',
+            height: '100%',
+            backgroundColor: 'rgba(0, 0, 0, 0.5)',
+            display: 'flex',
+            justifyContent: 'center',
+            alignItems: 'center',
+        });
+        modalContainer.className = 'dummy-ocr-modal';
+        mountElement.appendChild(modalContainer);
+        // Create modal content
+        const modalContent = document.createElement('div');
+        modalContent.style.backgroundColor = '#fff';
+        modalContent.style.padding = '200px';
+        modalContent.style.borderRadius = '5px';
+        modalContainer.appendChild(modalContent);
+        // Create Run OCR button
+        const runOcrButton = document.createElement('button');
+        runOcrButton.id = 'run-ocr-button';
+        runOcrButton.textContent = 'Run OCR';
+        runOcrButton.addEventListener('click', () => __awaiter(void 0, void 0, void 0, function* () {
+            const { oneSdkInstance } = shared;
+            yield handleComplete(ocrClient, eventHub, oneSdkInstance);
+            removeElement(modalContainer, eventHub);
+        }));
+        modalContent.appendChild(runOcrButton);
+        // Create close button
+        const closeButton = document.createElement('button');
+        closeButton.id = 'close-button';
+        closeButton.textContent = 'Close';
+        closeButton.addEventListener('click', () => {
+            eventHub.emit('input_required', {
+                documentType: null,
+                side: 'front',
+            }, OCRStatus.INTERRUPTED, () => ({}));
+            removeElement(modalContainer, eventHub);
+        });
+        modalContent.appendChild(closeButton);
+    }
+    catch (error) {
+        const { code = null, message = '' } = error;
+        eventHub.emit('session_data_failed_loading', { code, message });
+    }
+    return {};
+}));
+const handleComplete = (ocrClient, eventHub, oneSdkInstance) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    try {
+        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);
+        }
+        const { ocrDocument, documentStatus } = response;
+        const evaluateStatus = (_a = statusEvaluators[documentStatus]) !== null && _a !== void 0 ? _a : statusEvaluators.default;
+        evaluateStatus({
+            ocrDocument,
+            documentStatus,
+            ocrClient,
+            eventHub,
+        });
+        // Update global state with the latest ocr check outcome
+        yield oneSdkInstance.individual().search();
+    }
+    catch (error) {
+        const { message = '' } = error;
+        eventHub.emit('error', new OneSDKError('Error from OCR documents submission', { message }));
+    }
+});
+// remove modal element
+const removeElement = (element, eventHub) => {
+    try {
+        element.remove();
+        eventHub.emit('session_closed');
+    }
+    catch (error) {
+        const { type = null, message = '' } = error;
+        eventHub.emit('error', new OneSDKError(`Error from vendor SDK 'Onfido'`, {
+            type,
+            message,
+        }));
+    }
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/modules/ocr/vendors/dummy-ocr/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../modules/ocr/vendors/dummy-ocr/index.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AAIrE,OAAO,EACL,SAAS,EACT,SAAS,GACV,MAAM,0CAA0C,CAAC;AAKlD,OAAO,EACL,gBAAgB,GACjB,MAAM,6CAA6C,CAAC;AAGrD,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAY,WAAW,EAAE,CAC9D,MAAM,EACN,OAAO,EACP,EAAE;IACF,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;IACjC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC3C,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;IAC/C,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;IAC/C,IAAI,CAAC;QACH,yCAAyC;QACzC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,EAAE,GAAG,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;QACzE,QAAQ,CAAC,IAAI,CAAC,wBAAwB,EAAE;YACtC,OAAO,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,EAAE;SAC/C,CAAC,CAAC;QACH,YAAY,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAE1C,2BAA2B;QAC3B,MAAM,cAAc,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACrD,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE;YAClC,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,GAAG;YACR,IAAI,EAAE,GAAG;YACT,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,MAAM;YACd,eAAe,EAAE,oBAAoB;YACrC,OAAO,EAAE,MAAM;YACf,cAAc,EAAE,QAAQ;YACxB,UAAU,EAAE,QAAQ;SACrB,CAAC,CAAC;QACH,cAAc,CAAC,SAAS,GAAG,iBAAiB,CAAC;QAC7C,YAAY,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QAEzC,uBAAuB;QACvB,MAAM,YAAY,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACnD,YAAY,CAAC,KAAK,CAAC,eAAe,GAAG,MAAM,CAAC;QAC5C,YAAY,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QACrC,YAAY,CAAC,KAAK,CAAC,YAAY,GAAG,KAAK,CAAC;QACxC,cAAc,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAEzC,wBAAwB;QACxB,MAAM,YAAY,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACtD,YAAY,CAAC,EAAE,GAAG,gBAAgB,CAAC;QACnC,YAAY,CAAC,WAAW,GAAG,SAAS,CAAC;QACrC,YAAY,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAS,EAAE;YAChD,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;YAClC,MAAM,cAAc,CAAC,SAAS,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;YAC1D,aAAa,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QAC1C,CAAC,CAAA,CAAC,CAAC;QACH,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAEvC,sBAAsB;QACtB,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACrD,WAAW,CAAC,EAAE,GAAG,cAAc,CAAC;QAChC,WAAW,CAAC,WAAW,GAAG,OAAO,CAAC;QAClC,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;YACzC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBAC9B,YAAY,EAAE,IAAI;gBAClB,IAAI,EAAE,OAAO;aACd,EAAE,SAAS,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACtC,aAAa,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QACH,YAAY,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACxC,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;IAClE,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC,CAAA,CAAC,CAAC;AAEH,MAAM,cAAc,GAAG,CACrB,SAAoB,EACpB,QAA0B,EAC1B,cAA6B,EACd,EAAE;;IACjB,IAAI,CAAC;QACH,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,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,QAAQ,CAAC;QACjD,MAAM,cAAc,GAAG,MAAA,gBAAgB,CAAC,cAAc,CAAC,mCAAI,gBAAgB,CAAC,OAAO,CAAC;QACpF,cAAc,CAAE;YACd,WAAW;YACX,cAAc;YACd,SAAS;YACT,QAAQ;SACY,CAAC,CAAC;QAExB,wDAAwD;QACxD,MAAM,cAAc,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC;QAC/B,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,WAAW,CAAC,qCAAqC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IAC9F,CAAC;AACH,CAAC,CAAA,CAAC;AAEF,uBAAuB;AACvB,MAAM,aAAa,GAAG,CACpB,OAAoB,EACpB,QAA0B,EACpB,EAAE;IACR,IAAI,CAAC;QACH,OAAO,CAAC,MAAM,EAAE,CAAC;QACjB,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,CAAC,OAAO,EAAE,IAAI,WAAW,CAAC,gCAAgC,EAAE;YACvE,IAAI;YACJ,OAAO;SACR,CAAC,CAAC,CAAC;IACN,CAAC;AACH,CAAC,CAAC"}

package/dist/esm/modules/sdk/devTools/attachDevTools.d.ts

@@ -0,0 +1,22 @@
+import type { OneSdkContext } from '../types';
+declare const DEVTOOLS_GLOBAL_VARIABLE = "__ONE_SDK__DEVTOOLS";
+/**
+ * This function will setup and attach visibility tools to the window object, so they are available to developers
+ * @param sdk The OneSDK context
+ */
+export declare function attachDevTools(sdk: OneSdkContext): void;
+type Devtools = {
+    numberOfInstances: number;
+    oneSdkInstance: OneSdkContext;
+    moduleInstances: {
+        components: Record<string, unknown>;
+        flows: Record<string, unknown>;
+    };
+};
+declare global {
+    interface Window {
+        [DEVTOOLS_GLOBAL_VARIABLE]: Devtools;
+    }
+}
+export {};
+//# sourceMappingURL=attachDevTools.d.ts.map

package/dist/esm/modules/sdk/devTools/attachDevTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachDevTools.d.ts","sourceRoot":"","sources":["../../../../../modules/sdk/devTools/attachDevTools.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,QAAA,MAAM,wBAAwB,wBAAwB,CAAC;AACvD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,aAAa,GAAG,IAAI,CAqCvD;AAED,KAAK,QAAQ,GAAG;IACd,iBAAiB,EAAE,MAAM,CAAC;IAC1B,cAAc,EAAE,aAAa,CAAC;IAC9B,eAAe,EAAE;QACf,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACpC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAChC,CAAC;CACH,CAAC;AACF,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,CAAC,wBAAwB,CAAC,EAAE,QAAQ,CAAC;KACtC;CACF"}

package/dist/esm/modules/sdk/devTools/attachDevTools.js

@@ -0,0 +1,38 @@
+const DEVTOOLS_GLOBAL_VARIABLE = '__ONE_SDK__DEVTOOLS';
+/**
+ * This function will setup and attach visibility tools to the window object, so they are available to developers
+ * @param sdk The OneSDK context
+ */
+export function attachDevTools(sdk) {
+    const isDevtoolsInstalled = DEVTOOLS_GLOBAL_VARIABLE in window;
+    if (!isDevtoolsInstalled) {
+        // TODO: Add support for multiple instances
+        const initialDevtools = {
+            numberOfInstances: 0,
+            oneSdkInstance: null,
+            moduleInstances: {
+                components: {},
+                flows: {},
+            },
+        };
+        Object.defineProperty(window, DEVTOOLS_GLOBAL_VARIABLE, {
+            value: initialDevtools,
+            enumerable: false,
+            writable: false,
+            configurable: false,
+        });
+    }
+    const devtools = window[DEVTOOLS_GLOBAL_VARIABLE];
+    devtools.numberOfInstances += 1;
+    if (devtools.numberOfInstances > 1) {
+        // eslint-disable-next-line no-console
+        console.trace(`OneSDK devtools doesn't support multiple instances yet, but ${devtools.numberOfInstances} ` +
+            'initialisations were detected. Devtools will ignore all but the first one. ' +
+            'Follow stack trace to identify the source of the extra initialisations.');
+        return;
+    }
+    devtools.oneSdkInstance = sdk;
+    devtools.moduleInstances.components = sdk.component.instances;
+    devtools.moduleInstances.flows = sdk.flow.instances;
+}
+//# sourceMappingURL=attachDevTools.js.map

package/dist/esm/modules/sdk/devTools/attachDevTools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachDevTools.js","sourceRoot":"","sources":["../../../../../modules/sdk/devTools/attachDevTools.ts"],"names":[],"mappings":"AAEA,MAAM,wBAAwB,GAAG,qBAAqB,CAAC;AACvD;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,GAAkB;IAC/C,MAAM,mBAAmB,GAAG,wBAAwB,IAAI,MAAM,CAAC;IAE/D,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACzB,2CAA2C;QAC3C,MAAM,eAAe,GAAa;YAChC,iBAAiB,EAAE,CAAC;YACpB,cAAc,EAAE,IAAI;YACpB,eAAe,EAAE;gBACf,UAAU,EAAE,EAAE;gBACd,KAAK,EAAE,EAAE;aACV;SACF,CAAC;QACF,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,wBAAwB,EAAE;YACtD,KAAK,EAAE,eAAe;YACtB,UAAU,EAAE,KAAK;YACjB,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,KAAK;SACpB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,wBAAwB,CAAC,CAAC;IAClD,QAAQ,CAAC,iBAAiB,IAAI,CAAC,CAAC;IAEhC,IAAI,QAAQ,CAAC,iBAAiB,GAAG,CAAC,EAAE,CAAC;QACnC,sCAAsC;QACtC,OAAO,CAAC,KAAK,CACX,+DAA+D,QAAQ,CAAC,iBAAiB,GAAG;YAC1F,6EAA6E;YAC7E,yEAAyE,CAC5E,CAAC;QACF,OAAO;IACT,CAAC;IAED,QAAQ,CAAC,cAAc,GAAG,GAAG,CAAC;IAC9B,QAAQ,CAAC,eAAe,CAAC,UAAU,GAAG,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC;IAC9D,QAAQ,CAAC,eAAe,CAAC,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC;AACtD,CAAC"}

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

@@ -0,0 +1,3 @@
+import type { OneSdkModule } from './types';
+export declare const oneSdk: OneSdkModule;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../modules/sdk/index.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAEV,YAAY,EAEb,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,MAAM,EAAE,YA4DpB,CAAC"}

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

@@ -0,0 +1,70 @@
+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());
+    });
+};
+// TODO: Prevent one sdk from ever throwing an error. Emit error events instead.
+import { getInitialiser } from '../config/index.js';
+import { SessionFacade } from '../session/SessionFacade.js';
+import { mkEventListener } from '../common/index.js';
+import { attachDevTools } from './devTools/attachDevTools.js';
+import { mkModuleInstantiator } from './initialisation/componentLoader.js';
+import { parseConfiguration, resolveParameters, } from './initialisation/configurationParser.js';
+import { mkSharedDependencies } from './initialisation/sharedDependencies.js';
+export const oneSdk = {
+    initialise: function (oneSdkRootParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resolvedParameters = resolveParameters(oneSdkRootParameters);
+            const sharedDependencies = yield mkSharedDependencies(resolvedParameters);
+            const { globalEventHub } = sharedDependencies;
+            try {
+                const { globalState, warnings, } = yield parseConfiguration(resolvedParameters, sharedDependencies);
+                // TODO: Based on recipe configuration, add pre-fetch scripts tags so all files can be eager loaded in parallel as soon as possible
+                // Build the OneSDK instance which will be returned by this function
+                // The one sdk only exposes the listener methods of the event hubs
+                // Both the dynamic component loader and the individual component (which is returned by the "individual" method)
+                // are defined next
+                const globalEventListener = mkEventListener(globalEventHub);
+                const sdk = Object.assign(Object.assign({}, globalEventListener), { session: new SessionFacade(globalState.session), individual: () => individual, flow: null, component: null });
+                const injectedState = Object.assign(globalState, { oneSdkInstance: sdk });
+                // Initialise and label the individual component, which is special and will be
+                // available through the static factory method called "individual"
+                const individual = getInitialiser('individual')(injectedState);
+                // Make the dynamic component loader, which initialises components dynamically
+                sdk.component = mkModuleInstantiator(injectedState);
+                sdk.flow = mkModuleInstantiator(injectedState);
+                // wait for individual's data_loaded event before continuing
+                yield new Promise((resolve) => individual.on('data_loaded', () => resolve(sdk)));
+                // then schedule the emission of all events/warnings for after oneSDK instance is resolved
+                // Even telemetry, in case customers want to observe them
+                // TODO: THESE EVENTS NEED TO WAIT UNTIL ONESDK.ON IS CALLED
+                // Otherwise they are impossible to listen for
+                globalEventHub.emit('telemetry', {
+                    eventName: 'INIT',
+                    data: { mode: globalState.mode, recipe: globalState.recipe, warnings },
+                });
+                warnings.forEach(({ level, data }) => globalEventHub.emit(level, data));
+                if (oneSdkRootParameters.devtools)
+                    attachDevTools(sdk);
+                return sdk;
+            }
+            catch (error) {
+                // TODO: Emit telemetry event here
+                // Errors that reach this catch block are critical errors and will interrupt the flow of the OneSDK
+                globalEventHub.emit('telemetry', {
+                    eventName: 'INIT:ERROR',
+                    data: {
+                        oneSdkOptions: oneSdkRootParameters,
+                    },
+                    error,
+                });
+                throw error;
+            }
+        });
+    },
+};
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/sdk/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,gFAAgF;AAChF,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAKzC,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAE9D,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EACL,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAS3E,MAAM,CAAC,MAAM,MAAM,GAAiB;IAClC,UAAU,EAAE,UAAgB,oBAA0C;;YACpE,MAAM,kBAAkB,GAA2B,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;YAC3F,MAAM,kBAAkB,GAAuB,MAAM,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;YAE9F,MAAM,EAAE,cAAc,EAAE,GAAG,kBAAkB,CAAC;YAC9C,IAAI,CAAC;gBACH,MAAM,EACJ,WAAW,EACX,QAAQ,GACT,GAAG,MAAM,kBAAkB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;gBACrE,mIAAmI;gBACnI,oEAAoE;gBACpE,kEAAkE;gBAClE,gHAAgH;gBAChH,mBAAmB;gBACnB,MAAM,mBAAmB,GAAG,eAAe,CAAC,cAAc,CAAC,CAAC;gBAC5D,MAAM,GAAG,mCACJ,mBAAmB,KACtB,OAAO,EAAE,IAAI,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC,EAC/C,UAAU,EAAE,GAAG,EAAE,CAAC,UAAU,EAC5B,IAAI,EAAE,IAAI,EACV,SAAS,EAAE,IAAI,GAChB,CAAC;gBACF,MAAM,aAAa,GAAyB,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC;gBAChG,8EAA8E;gBAC9E,kEAAkE;gBAClE,MAAM,UAAU,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,CAAC;gBAC/D,8EAA8E;gBAC9E,GAAG,CAAC,SAAS,GAAG,oBAAoB,CAAc,aAAa,CAAC,CAAC;gBACjE,GAAG,CAAC,IAAI,GAAG,oBAAoB,CAAS,aAAa,CAAC,CAAC;gBAEvD,4DAA4D;gBAC5D,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBACjF,0FAA0F;gBAC1F,yDAAyD;gBACzD,4DAA4D;gBAC5D,8CAA8C;gBAC9C,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC/B,SAAS,EAAE,MAAM;oBACjB,IAAI,EAAE,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE;iBACvE,CAAC,CAAC;gBACH,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;gBAExE,IAAI,oBAAoB,CAAC,QAAQ;oBAAE,cAAc,CAAC,GAAG,CAAC,CAAC;gBAEvD,OAAO,GAAG,CAAC;YACb,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,kCAAkC;gBAClC,mGAAmG;gBACnG,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC/B,SAAS,EAAE,YAAY;oBACvB,IAAI,EAAE;wBACJ,aAAa,EAAE,oBAAoB;qBACpC;oBACD,KAAK;iBACN,CAAC,CAAC;gBACH,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;KAAA;CACF,CAAC"}

package/dist/esm/modules/sdk/initialisation/componentLoader.d.ts

@@ -0,0 +1,22 @@
+import type { InjectedState } from '../../common/types';
+import type { Modules } from '../../config';
+type FactoryFunctions = Modules['factoryFunctions'];
+type InstantiableCategory = 'component' | 'flow';
+/**
+ * The module instantiator takes a partial InjectedState object, missing only the "moduleMeta" object (module name and instance name)
+ * Based on the options provided to the instantiator, along with the module name, it will inject moduleMeta to the existing InjectedState and use that
+ * to initialise the module.
+ */
+export type InjectedDependencies = Omit<InjectedState, 'moduleMeta'>;
+/**
+ * This factory will generate another function which will
+ * 1) load a module by module name, defined in the dictionary in Configuration.ts;
+ * 2) initialise it, which generates a context object, aka an "instance" of the module
+ * 3) tag that instance with an "instance name"
+ *
+ * @param globalState All options provided to OneSdk merged with resulting globalState object
+ * @returns A function to load OneSdk modules
+ */
+export declare const mkModuleInstantiator: <Category extends InstantiableCategory>(globalState: InjectedDependencies) => FactoryFunctions[Category];
+export {};
+//# sourceMappingURL=componentLoader.d.ts.map

package/dist/esm/modules/sdk/initialisation/componentLoader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"componentLoader.d.ts","sourceRoot":"","sources":["../../../../../modules/sdk/initialisation/componentLoader.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAGV,aAAa,EAEd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAI9C,KAAK,gBAAgB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAGpD,KAAK,oBAAoB,GAAG,WAAW,GAAG,MAAM,CAAC;AAEjD;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;AACrE;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB,uDAClB,oBAAoB,KAChC,gBAAgB,CAAC,QAAQ,CA2E3B,CAAC"}

package/dist/esm/modules/sdk/initialisation/componentLoader.js

@@ -0,0 +1,118 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { v4 as uuid } from 'uuid';
+import { merge } from '../../common/index.js';
+import { getInitialiser } from '../../config/index.js';
+/**
+ * This factory will generate another function which will
+ * 1) load a module by module name, defined in the dictionary in Configuration.ts;
+ * 2) initialise it, which generates a context object, aka an "instance" of the module
+ * 3) tag that instance with an "instance name"
+ *
+ * @param globalState All options provided to OneSdk merged with resulting globalState object
+ * @returns A function to load OneSdk modules
+ */
+export const mkModuleInstantiator = (globalState) => {
+    const { retrieveInstance, storeInstance, instanceStore, } = mkInstanceDictionary();
+    /**
+     * TODO: description
+     * @param parameters Modulename: string and options: object
+     * @returns Module instance
+     */
+    const moduleInstantiator = (...parameters) => {
+        var _a;
+        const [which, providedOptions] = parameters;
+        const instanceName = (_a = providedOptions === null || providedOptions === void 0 ? void 0 : providedOptions.instanceName) !== null && _a !== void 0 ? _a : uuid();
+        // Use instance name to simply load an existing instance or to generate a new one and store it under that name
+        // instance name defaults to "default".
+        // Change: instanceName used to default to the module name itself.
+        const _b = providedOptions !== null && providedOptions !== void 0 ? providedOptions : {}, { instanceName: _ } = _b, moduleOptions = __rest(_b, ["instanceName"]);
+        const resolvedOptions = Object.assign({ instanceName }, providedOptions);
+        // if instance already exists, return it
+        const instance = retrieveInstance(which, instanceName);
+        if (instance)
+            return instance;
+        else {
+            // Otherwise,
+            // 1) resolve module parameters: baseModuleOptions and moduleOptions
+            const parameters = mkModuleParameters(which, instanceName, globalState, moduleOptions);
+            globalState.globalEventHub.emit('resolved_module_config', ...parameters);
+            const module = getInitialiser(which);
+            try {
+                // 2) Initialise module, resulting in the module context for that instance (aka a component)
+                const moduleContext = module(...parameters);
+                const instance = injectInstanceName(moduleContext, instanceName);
+                storeInstance(which, instanceName, instance);
+                // 3) Emit INIT event to telemetry immediately and map any future "error" events for this component, if applicable
+                // !ATTENTION! the component's resolved options will be stored in the database,
+                // !which means that any sensitive information (PII) either shouldn't be provided here, or should be removed from the options object before emitting the event
+                // !This also applies to event COMPONENT:INIT:ERROR
+                globalState.globalEventHub.emit('telemetry', {
+                    eventName: `COMPONENT:INIT`,
+                    data: { component: which, options: resolvedOptions },
+                });
+                // Since all event listeners support the "error" event, listen for any "error" events and submit them to "telemetry"
+                instance.on('error', (errorEvent) => globalState.globalEventHub.emit('telemetry', {
+                    eventName: `COMPONENT:ERROR`,
+                    data: { component: which },
+                    error: errorEvent,
+                }));
+                return instance;
+            }
+            catch (error) {
+                globalState.globalEventHub.emit('telemetry', {
+                    eventName: `COMPONENT:INIT:ERROR`,
+                    data: { component: which, options: resolvedOptions },
+                    error,
+                });
+                throw error;
+            }
+        }
+    };
+    // the "defineProperty" below exposes the instances object and allows for easier testing
+    return Object.defineProperty(moduleInstantiator, 'instances', {
+        value: instanceStore,
+        enumerable: false,
+        writable: false,
+    });
+};
+const injectInstanceName = (moduleContext, instanceName) => {
+    return Object.defineProperty(moduleContext, 'instanceName', {
+        value: instanceName,
+        enumerable: true,
+        writable: false,
+    });
+};
+function mkModuleParameters(moduleName, instanceName, globalState, moduleOptions) {
+    const injectedState = merge({}, globalState, {
+        moduleMeta: {
+            moduleName,
+            instanceName,
+        },
+    });
+    return [injectedState, moduleOptions];
+}
+function mkInstanceDictionary() {
+    // instanceStore is the format { moduleName: { instanceName: instance } }
+    const instanceStore = {};
+    const storeInstance = (moduleName, instanceName, instance) => {
+        var _a;
+        instanceStore[moduleName] = (_a = instanceStore[moduleName]) !== null && _a !== void 0 ? _a : {};
+        instanceStore[moduleName][instanceName] = instance;
+    };
+    const retrieveInstance = (moduleName, instanceName) => {
+        var _a, _b;
+        return (_b = (_a = instanceStore === null || instanceStore === void 0 ? void 0 : instanceStore[moduleName]) === null || _a === void 0 ? void 0 : _a[instanceName]) !== null && _b !== void 0 ? _b : null;
+    };
+    return { storeInstance, retrieveInstance, instanceStore };
+}
+//# sourceMappingURL=componentLoader.js.map

package/dist/esm/modules/sdk/initialisation/componentLoader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"componentLoader.js","sourceRoot":"","sources":["../../../../../modules/sdk/initialisation/componentLoader.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAQvC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAchD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,WAAiC,EACL,EAAE;IAC9B,MAAM,EACJ,gBAAgB,EAChB,aAAa,EACb,aAAa,GACd,GAAG,oBAAoB,EAAE,CAAC;IAC3B;;;;OAIG;IACH,MAAM,kBAAkB,GAAG,CACzB,GAAG,UAAwD,EAC1C,EAAE;;QAGnB,MAAM,CAAC,KAAK,EAAE,eAAe,CAAC,GAAG,UAA+C,CAAC;QACjF,MAAM,YAAY,GAAG,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,YAAY,mCAAI,IAAI,EAAE,CAAC;QAC7D,8GAA8G;QAC9G,uCAAuC;QACvC,kEAAkE;QAClE,MAAM,KAAwC,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,EAAE,EAA7D,EAAE,YAAY,EAAE,CAAC,OAA4C,EAAvC,aAAa,cAAnC,gBAAqC,CAAwB,CAAC;QACpE,MAAM,eAAe,mBAAqB,YAAY,IAAK,eAAe,CAAE,CAAC;QAE7E,wCAAwC;QACxC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QACvD,IAAI,QAAQ;YAAE,OAAO,QAA2B,CAAC;aAC5C,CAAC;YACJ,aAAa;YACb,oEAAoE;YACpE,MAAM,UAAU,GAAG,kBAAkB,CAAC,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;YACvF,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,wBAAwB,EAAE,GAAG,UAAU,CAAC,CAAC;YAEzE,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,CAAgC,CAAC;YAEpE,IAAI,CAAC;gBACH,4FAA4F;gBAC5F,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC;gBAC5C,MAAM,QAAQ,GAAG,kBAAkB,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;gBACjE,aAAa,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;gBAE7C,kHAAkH;gBAClH,+EAA+E;gBAC/E,8JAA8J;gBAC9J,mDAAmD;gBACnD,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC3C,SAAS,EAAE,gBAAgB;oBAC3B,IAAI,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE;iBACrD,CAAC,CAAC;gBACH,oHAAoH;gBACpH,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,UAAU,EAAE,EAAE,CAClC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC3C,SAAS,EAAE,iBAAiB;oBAC5B,IAAI,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE;oBAC1B,KAAK,EAAE,UAAU;iBAClB,CAAC,CACH,CAAC;gBAEF,OAAO,QAA2B,CAAC;YACrC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC3C,SAAS,EAAE,sBAAsB;oBACjC,IAAI,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE;oBACpD,KAAK;iBACN,CAAC,CAAC;gBACH,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IACF,wFAAwF;IACxF,OAAO,MAAM,CAAC,cAAc,CAAC,kBAAkB,EAAE,WAAW,EAAE;QAC5D,KAAK,EAAE,aAAa;QACpB,UAAU,EAAE,KAAK;QACjB,QAAQ,EAAE,KAAK;KAChB,CAA0C,CAAC;AAC9C,CAAC,CAAC;AACF,MAAM,kBAAkB,GAAG,CACzB,aAA4B,EAC5B,YAAoB,EACpB,EAAE;IACF,OAAO,MAAM,CAAC,cAAc,CAAC,aAAa,EAAE,cAAc,EAAE;QAC1D,KAAK,EAAE,YAAY;QACnB,UAAU,EAAE,IAAI;QAChB,QAAQ,EAAE,KAAK;KAChB,CAAkC,CAAC;AACtC,CAAC,CAAC;AAEF,SAAS,kBAAkB,CACzB,UAAsB,EACtB,YAAoB,EACpB,WAAiC,EACjC,aAAsD;IAEtD,MAAM,aAAa,GAAG,KAAK,CAAC,EAAE,EAAE,WAAW,EAAE;QAC3C,UAAU,EAAE;YACV,UAAU;YACV,YAAY;SACb;KACF,CAAC,CAAC;IAEH,OAAO,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,oBAAoB;IAC3B,yEAAyE;IACzE,MAAM,aAAa,GAA2C,EAAE,CAAC;IAEjE,MAAM,aAAa,GAAG,CACpB,UAAgB,EAChB,YAAoB,EACpB,QAAgC,EAC1B,EAAE;;QACR,aAAa,CAAC,UAAU,CAAC,GAAG,MAAA,aAAa,CAAC,UAAU,CAAC,mCAAI,EAAE,CAAC;QAC5D,aAAa,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC;IACrD,CAAC,CAAC;IACF,MAAM,gBAAgB,GAAG,CACvB,UAAgB,EAChB,YAAoB,EACW,EAAE;;QACjC,OAAO,MAAC,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAG,UAAU,CAAC,0CAAG,YAAY,CAA4B,mCAAI,IAAI,CAAC;IACzF,CAAC,CAAC;IAEF,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,CAAC;AAC5D,CAAC"}

package/dist/esm/modules/sdk/initialisation/configurationParser.d.ts

@@ -0,0 +1,29 @@
+import { GlobalState, ModeObject, ResolvedRootParameters, SharedDependencies } from "../../common/types";
+import { OneSdkRootParameters, RecipeParsed } from "../types";
+/**
+ *
+ * Parses parameters passed to OneSDK constructor and returns a dictionary of GlobalState variables and a list of warnings to be emitted as global events by the top level constructor
+ * @param rootParameters All the parameters passed to the OneSDK constructor
+ * @returns { globalState: Dictionary, warnings: { level: "info"|"warnings"|"error", message: string, payload: unknown }[] }
+ */
+export declare function parseConfiguration(rootParameters: ResolvedRootParameters, sharedDependencies: SharedDependencies): Promise<{
+    globalState: GlobalState;
+    warnings: Warning[];
+}>;
+export declare function resolveParameters(oneSdkRootParameters: OneSdkRootParameters): ResolvedRootParameters;
+export declare function resolveSession(sessionParameter: OneSdkRootParameters["session"]): ResolvedRootParameters["session"];
+export declare function resolveModeObject(modeParameter: OneSdkRootParameters["mode"]): ModeObject;
+export declare function resolveRecipeValue(recipeParameter: OneSdkRootParameters["recipe"]): RecipeParsed;
+export declare function includeTelemetry(oneSdkOptions: ResolvedRootParameters): boolean;
+type Warning = {
+    level: "info" | "warning";
+    data: {
+        message: string;
+        payload?: unknown;
+    };
+} | {
+    level: "error";
+    data: Error;
+};
+export {};
+//# sourceMappingURL=configurationParser.d.ts.map

package/dist/esm/modules/sdk/initialisation/configurationParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configurationParser.d.ts","sourceRoot":"","sources":["../../../../../modules/sdk/initialisation/configurationParser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE3G,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAY,MAAM,UAAU,CAAC;AAExE;;;;;GAKG;AACH,wBAAsB,kBAAkB,CACtC,cAAc,EAAE,sBAAsB,EACtC,kBAAkB,EAAE,kBAAkB,GACrC,OAAO,CAAC;IAAE,WAAW,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,OAAO,EAAE,CAAA;CAAE,CAAC,CAyB5D;AACD,wBAAgB,iBAAiB,CAAC,oBAAoB,EAAE,oBAAoB,GAAG,sBAAsB,CAgBpG;AAED,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,oBAAoB,CAAC,SAAS,CAAC,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAMnH;AACD,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,oBAAoB,CAAC,MAAM,CAAC,GAAG,UAAU,CASzF;AACD,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,oBAAoB,CAAC,QAAQ,CAAC,GAAG,YAAY,CAOhG;AACD,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,sBAAsB,WAGrE;AAgDD,KAAK,OAAO,GACR;IAAE,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,GAC3E;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,KAAK,CAAA;CAAE,CAAC"}

package/dist/esm/modules/sdk/initialisation/configurationParser.js

@@ -0,0 +1,140 @@
+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());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { OneSDKError, merge } from "../../common/index.js";
+import { ConfigurationClient } from "../../frankie-client/clients/ConfigurationClient.js";
+import { SdkModes } from "../types/index.js";
+/**
+ *
+ * Parses parameters passed to OneSDK constructor and returns a dictionary of GlobalState variables and a list of warnings to be emitted as global events by the top level constructor
+ * @param rootParameters All the parameters passed to the OneSDK constructor
+ * @returns { globalState: Dictionary, warnings: { level: "info"|"warnings"|"error", message: string, payload: unknown }[] }
+ */
+export function parseConfiguration(rootParameters, sharedDependencies) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { frankieClient, globalEventHub } = sharedDependencies;
+        // Resolve final recipe name based on optionally provided recipe object
+        const warnings = [];
+        const recipe = resolveRecipeValue(rootParameters.recipe);
+        // use frankie client to fetch existing recipe configuration from API
+        const fetchedRecipeConfiguration = yield fetchRecipeConfig({ frankieClient, globalEventHub, recipe }, warnings);
+        // And merge it with provided config
+        const mergedRecipeConfiguration = mergeRecipeConfigurations(recipe, fetchedRecipeConfiguration, warnings);
+        // Assemble a "shared state" object, with all the internal resolved configuration and dependencies to be passed to all modules
+        // which is the output of this parseConfiguration function
+        // The oneSdkInstance object will *later* be injected by the OneSDK initialisation function and also shared with all modules.
+        // This gives the modules all capabilities that users also have when accessing the one sdk instance directly
+        // We can then from inside the modules provide an extra layer of abstraction and some level of "reflexion" to simplify different use cases.
+        const globalState = {
+            mode: rootParameters.mode,
+            telemetry: includeTelemetry(rootParameters),
+            recipe: mergedRecipeConfiguration,
+            frankieClient: sharedDependencies.frankieClient,
+            globalEventHub: sharedDependencies.globalEventHub,
+            session: sharedDependencies.session,
+        };
+        return { globalState, warnings };
+    });
+}
+export function resolveParameters(oneSdkRootParameters) {
+    var _a;
+    const { mode: modeParameter, recipe: recipeParameter } = oneSdkRootParameters;
+    const mode = resolveModeObject(modeParameter);
+    const recipe = resolveRecipeValue(recipeParameter);
+    const session = resolveSession(oneSdkRootParameters.session);
+    // Telemetry is on by default. If no value is provided, it will fallback to true.
+    const telemetry = (_a = oneSdkRootParameters.telemetry) !== null && _a !== void 0 ? _a : true;
+    return Object.assign({}, oneSdkRootParameters, {
+        mode,
+        recipe,
+        telemetry,
+        session,
+    });
+}
+export function resolveSession(sessionParameter) {
+    var _a, _b, _c;
+    return {
+        token: (_a = sessionParameter === null || sessionParameter === void 0 ? void 0 : sessionParameter.token) !== null && _a !== void 0 ? _a : null,
+        persist: (_b = sessionParameter === null || sessionParameter === void 0 ? void 0 : sessionParameter.persist) !== null && _b !== void 0 ? _b : false,
+        appReference: (_c = sessionParameter === null || sessionParameter === void 0 ? void 0 : sessionParameter.appReference) !== null && _c !== void 0 ? _c : null,
+    };
+}
+export function resolveModeObject(modeParameter) {
+    const modeObject = {
+        modeName: SdkModes.PROD,
+        is: (mode) => mode === modeObject.modeName,
+    };
+    if (!modeParameter)
+        return modeObject;
+    const providedAsString = typeof modeParameter === "string";
+    const ensureObjectValue = providedAsString ? { modeName: modeParameter } : modeParameter;
+    return Object.assign(modeObject, ensureObjectValue);
+}
+export function resolveRecipeValue(recipeParameter) {
+    var _a;
+    if (!recipeParameter)
+        return { name: "auto" };
+    if (typeof recipeParameter === "string")
+        return { name: recipeParameter };
+    return Object.assign(Object.assign({}, recipeParameter), { name: (_a = recipeParameter === null || recipeParameter === void 0 ? void 0 : recipeParameter.name) !== null && _a !== void 0 ? _a : "auto" });
+}
+export function includeTelemetry(oneSdkOptions) {
+    // Telemetry is on by default. If anything other than a explicit false is passed, enable it.
+    return oneSdkOptions.telemetry !== false;
+}
+function mergeRecipeConfigurations(provided, fetched, warnings) {
+    // Merge configs by:
+    // first) ensuring fetched configuration has recipe name (defaulting it to 'auto')
+    // second) keeping fetched name if provided recipe name is 'auto'
+    const { name: providedRecipeName } = provided, providedRecipeObject = __rest(provided, ["name"]);
+    const _a = resolveRecipeValue(fetched), { name: fetchedRecipeName } = _a, fetchedRecipeObject = __rest(_a, ["name"]);
+    /* eslint-disable */
+    const mergedRecipeConfiguration = merge({}, fetchedRecipeObject, providedRecipeObject, {
+        name: providedRecipeName === "auto" ? fetchedRecipeName : providedRecipeName,
+    });
+    if (providedRecipeName !== "auto" && fetchedRecipeName && providedRecipeName !== fetchedRecipeName) {
+        warnings.push({
+            level: "error",
+            data: new OneSDKError(`Recipe name mismatch. Requested '${providedRecipeName}', found '${fetchedRecipeName}'.` +
+                "Configuration might be incorrect. Check this event's 'payload' for the resulting configuration object.", mergedRecipeConfiguration),
+        });
+    }
+    return mergedRecipeConfiguration;
+}
+function fetchRecipeConfig(options, warnings) {
+    return __awaiter(this, void 0, void 0, function* () {
+        warnings.push({
+            level: "info",
+            data: {
+                message: "Fetching recipe configuration",
+                payload: { recipeName: options.recipe.name },
+            },
+        });
+        const config = new ConfigurationClient(options.frankieClient, { recipe: options.recipe.name });
+        return config.load().catch((error) => {
+            warnings.push({
+                level: "error",
+                data: new OneSDKError("Failed fetching recipe configuration. Using provided configuration only.", error),
+            });
+            return {};
+        });
+    });
+}
+//# sourceMappingURL=configurationParser.js.map