@frankieone/one-sdk 0.6.6-rc.7 → 0.7.0-alpha

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

@@ -1,75 +1,74 @@
-import { mkEventHub, mkEventListener, ReactiveStore } from "../common";
+import { ReactiveStore, mkEventHub, mkEventListener } from "../common";
 import { ApplicantClient } from "../frankie-client/clients/ApplicantClient";
 import { mkAddConsents } from "./actions/consents";
 import { mkAddDocument, mkUpdateDocument } from "./actions/documents";
 import { subscribeAndEmitEvents } from "./actions/emitEvents";
 import { mkSearchMethod } from "./actions/search";
 import { mkSubmitMethod } from "./actions/submit";
-export const individualModule = {
-    initialise(o) {
-        const { frankieClient, globalEventHub } = o;
-        const client = new ApplicantClient(frankieClient);
-        const state$ = new ReactiveStore({
-            applicant: null,
-            documents: null,
-            hasLoaded: false,
-            isPreloaded: null,
-        });
-        const documents$ = state$.getRootAccessors("documents");
-        const applicant$ = state$.getRootAccessors("applicant");
-        const hasLoaded$ = state$.getRootAccessors("hasLoaded");
-        const isPreloaded$ = state$.getRootAccessors("isPreloaded");
-        const entityId$ = ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "entityId" });
-        const name$ = ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "name" });
-        const dob$ = ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "dateOfBirth" });
-        const addresses$ = ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "addresses" });
-        const consentsGiven$ = ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "consents" });
-        // when adding a new public field, make sure to update the PublicFields type in ./types/module
-        const publicAccessors = {
-            entityId: entityId$,
-            name: name$,
-            documents: documents$,
-            addresses: addresses$,
-            dateOfBirth: dob$,
-            hasLoaded: hasLoaded$,
-            consentsGiven: consentsGiven$,
-        };
-        // Events mapping
-        const eventHub = mkEventHub();
-        // For each public field, emit "data_updated" when they change
-        subscribeAndEmitEvents({
-            eventHub,
-            publicAccessors,
-        });
-        // methods
-        const search = mkSearchMethod({
-            client,
-            eventHub,
-            state$,
-            recipeName: o.recipe.name,
-        });
-        const submitData = mkSubmitMethod({
-            applicant$,
-            client,
-            consentsGiven$,
-            documents$,
-            eventHub,
-            globalEventHub,
-        });
-        const addConsent = mkAddConsents({
-            consentsGiven$,
-        });
-        const addDocument = mkAddDocument({
-            documents$,
-        });
-        const updateDocument = mkUpdateDocument({
-            documents$,
-        });
-        // Refresh state automatically on initialisation
-        search();
-        return Object.assign(Object.assign({}, mkEventListener(eventHub)), { access: (fieldName) => publicAccessors[fieldName], isPreloaded: () => isPreloaded$.getValue(), hasLoaded: () => hasLoaded$.getValue(), submit: submitData, addDocument,
-            updateDocument,
-            addConsent });
-    },
+export const initialise = (shared) => {
+    const { frankieClient, globalEventHub } = shared;
+    const client = new ApplicantClient(frankieClient);
+    const state$ = new ReactiveStore({
+        applicant: null,
+        documents: null,
+        hasLoaded: false,
+        isPreloaded: null,
+    });
+    const documents$ = state$.getRootAccessors("documents");
+    const applicant$ = state$.getRootAccessors("applicant");
+    const hasLoaded$ = state$.getRootAccessors("hasLoaded");
+    const isPreloaded$ = state$.getRootAccessors("isPreloaded");
+    const entityId$ = ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "entityId" });
+    const name$ = ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "name" });
+    const dob$ = ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "dateOfBirth" });
+    const addresses$ = ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "addresses" });
+    const consentsGiven$ = ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "consents" });
+    // when adding a new public field, make sure to update the PublicFields type in ./types/module
+    const publicAccessors = {
+        entityId: entityId$,
+        name: name$,
+        documents: documents$,
+        addresses: addresses$,
+        dateOfBirth: dob$,
+        hasLoaded: hasLoaded$,
+        consentsGiven: consentsGiven$,
+    };
+    // Events mapping
+    const eventHub = mkEventHub();
+    // For each public field, emit "data_updated" when they change
+    subscribeAndEmitEvents({
+        eventHub,
+        publicAccessors,
+    });
+    // methods
+    const search = mkSearchMethod({
+        client,
+        eventHub,
+        state$,
+        recipeName: shared.recipe.name,
+    });
+    const submitData = mkSubmitMethod({
+        applicant$,
+        client,
+        consentsGiven$,
+        documents$,
+        eventHub,
+        globalEventHub,
+    });
+    const addConsent = mkAddConsents({
+        consentsGiven$,
+    });
+    const addDocument = mkAddDocument({
+        documents$,
+    });
+    const updateDocument = mkUpdateDocument({
+        documents$,
+    });
+    // Refresh state automatically on initialisation
+    search();
+    return Object.assign(Object.assign({}, mkEventListener(eventHub)), { access: (fieldName) => publicAccessors[fieldName], isPreloaded: () => isPreloaded$.getValue(), hasLoaded: () => hasLoaded$.getValue(), submit: submitData, addDocument,
+        updateDocument,
+        addConsent });
 };
+export * from "./events";
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/individual/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAG5E,OAAO,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAIlD,MAAM,CAAC,MAAM,gBAAgB,GAAqB;IAChD,UAAU,CAAC,CAAC;QACV,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,GAAG,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,aAAa,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC;YAC/B,SAAS,EAAE,IAAiB;YAC5B,SAAS,EAAE,IAAkB;YAC7B,SAAS,EAAE,KAAgB;YAC3B,WAAW,EAAE,IAAe;SAC7B,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,MAAM,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACxD,MAAM,UAAU,GAAG,MAAM,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACxD,MAAM,UAAU,GAAG,MAAM,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACxD,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAE5D,MAAM,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC;QAC9F,MAAM,KAAK,GAAG,aAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;QACtF,MAAM,IAAI,GAAG,aAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,aAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;QAChG,MAAM,cAAc,GAAG,aAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC;QAEnG,8FAA8F;QAC9F,MAAM,eAAe,GAAoB;YACvC,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,KAAK;YACX,SAAS,EAAE,UAAU;YACrB,SAAS,EAAE,UAAU;YACrB,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,UAAU;YACrB,aAAa,EAAE,cAAc;SAC9B,CAAC;QAEF,iBAAiB;QACjB,MAAM,QAAQ,GAAG,UAAU,EAAU,CAAC;QAEtC,8DAA8D;QAC9D,sBAAsB,CAAC;YACrB,QAAQ;YACR,eAAe;SAChB,CAAC,CAAC;QAEH,UAAU;QACV,MAAM,MAAM,GAAG,cAAc,CAAC;YAC5B,MAAM;YACN,QAAQ;YACR,MAAM;YACN,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI;SAC1B,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,cAAc,CAAC;YAChC,UAAU;YACV,MAAM;YACN,cAAc;YACd,UAAU;YACV,QAAQ;YACR,cAAc;SACf,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,aAAa,CAAC;YAC/B,cAAc;SACf,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,aAAa,CAAC;YAChC,UAAU;SACX,CAAC,CAAC;QACH,MAAM,cAAc,GAAG,gBAAgB,CAAC;YACtC,UAAU;SACX,CAAC,CAAC;QACH,gDAAgD;QAChD,MAAM,EAAE,CAAC;QAET,uCACK,eAAe,CAAC,QAAQ,CAAC,KAC5B,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC,EACjD,WAAW,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,EAC1C,SAAS,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EACtC,MAAM,EAAE,UAAU,EAClB,WAAW;YACX,cAAc;YACd,UAAU,IACV;IACJ,CAAC;CACF,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/individual/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuC,aAAa,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGjH,OAAO,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAC;AAIjF,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAGlD,MAAM,CAAC,MAAM,UAAU,GAAoE,CAAC,MAAM,EAAE,EAAE;IACpG,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;IACjD,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,aAAa,CAAC,CAAC;IAElD,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC;QAC/B,SAAS,EAAE,IAAiB;QAC5B,SAAS,EAAE,IAAkB;QAC7B,SAAS,EAAE,KAAgB;QAC3B,WAAW,EAAE,IAAe;KAC7B,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,MAAM,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IACxD,MAAM,UAAU,GAAG,MAAM,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IACxD,MAAM,UAAU,GAAG,MAAM,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IACxD,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAE5D,MAAM,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC;IAC9F,MAAM,KAAK,GAAG,aAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;IACtF,MAAM,IAAI,GAAG,aAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC;IAC5F,MAAM,UAAU,GAAG,aAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;IAChG,MAAM,cAAc,GAAG,aAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC;IAEnG,8FAA8F;IAC9F,MAAM,eAAe,GAAoB;QACvC,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,UAAU;QACrB,SAAS,EAAE,UAAU;QACrB,WAAW,EAAE,IAAI;QACjB,SAAS,EAAE,UAAU;QACrB,aAAa,EAAE,cAAc;KAC9B,CAAC;IAEF,iBAAiB;IACjB,MAAM,QAAQ,GAAG,UAAU,EAAU,CAAC;IAEtC,8DAA8D;IAC9D,sBAAsB,CAAC;QACrB,QAAQ;QACR,eAAe;KAChB,CAAC,CAAC;IAEH,UAAU;IACV,MAAM,MAAM,GAAG,cAAc,CAAC;QAC5B,MAAM;QACN,QAAQ;QACR,MAAM;QACN,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI;KAC/B,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,cAAc,CAAC;QAChC,UAAU;QACV,MAAM;QACN,cAAc;QACd,UAAU;QACV,QAAQ;QACR,cAAc;KACf,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,aAAa,CAAC;QAC/B,cAAc;KACf,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,aAAa,CAAC;QAChC,UAAU;KACX,CAAC,CAAC;IACH,MAAM,cAAc,GAAG,gBAAgB,CAAC;QACtC,UAAU;KACX,CAAC,CAAC;IACH,gDAAgD;IAChD,MAAM,EAAE,CAAC;IAET,uCACK,eAAe,CAAC,QAAQ,CAAC,KAC5B,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC,EACjD,WAAW,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,EAC1C,SAAS,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EACtC,MAAM,EAAE,UAAU,EAClB,WAAW;QACX,cAAc;QACd,UAAU,IACV;AACJ,CAAC,CAAC;AAwBF,cAAc,UAAU,CAAC"}

package/dist/esm/modules/meta.json

@@ -1 +1 @@
-{ "version": "0.6.6-rc.7" }
+{ "version": "0.7.0-alpha" }

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

@@ -1,9 +1,9 @@
 import { Accessors, EventHub, ReadonlyAccessors } from "../../common";
 import { Document } from "../../common/shared/models/Document";
 import { CompleteStatus, FailedStatus, InputRequiredStatus, OCRClient, OCRResults, Status } from "../../frankie-client/clients/OCRClient";
-import { IndividualModuleContext } from "../../individual/types";
+import { IndividualModuleContext } from "../../individual";
 import { GlobalEvents } from "../../sdk/types";
-import { Events } from "../types";
+import { Events } from "../events";
 declare type Dependencies = {
     _expectedSide$: ReadonlyAccessors<"front" | "back">;
     status$: Accessors<InputRequiredStatus | CompleteStatus>;

package/dist/esm/modules/ocr/{types/events.d.ts → events.d.ts}

@@ -1,5 +1,5 @@
-import { Document } from "../../common/shared/models/Document";
-import { Status } from "../../frankie-client/clients/OCRClient";
+import { Document } from "../common/shared/models/Document";
+import { Status } from "../frankie-client/clients/OCRClient";
 export declare type Events = {
     input_required: [Info, Status, ProvideFile];
     results: [{

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

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

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

@@ -1,13 +1,34 @@
-import { ReactiveStore } from "../common";
-import { Status } from "../frankie-client/clients/OCRClient";
-import { OcrModule, State } from "./types";
+import { AccessFunction, AccessorsDictionary, ReactiveStore } from "../common";
+import { FailedStatus, InputRequiredStatus, Status } from "../frankie-client/clients/OCRClient";
+import { ModuleContext, ModuleInitialiseFunction } from "../sdk/types";
+import { Document } from "../common/shared/models/Document";
+import { Events } from "../ocr/events";
+export type { Events };
 export { Status };
-export declare const ocrModule: OcrModule;
-export declare function initialiseLocalState(state$: ReactiveStore<State>): {
-    status$: import("../common").Accessors<Status.COMPLETE | import("../frankie-client/clients/OCRClient").InputRequiredStatus, Status.COMPLETE | import("../frankie-client/clients/OCRClient").InputRequiredStatus>;
-    failedStatus$: import("../common").Accessors<import("../frankie-client/clients/OCRClient").FailedStatus, import("../frankie-client/clients/OCRClient").FailedStatus>;
-    document$: import("../common").Accessors<import("../common/shared/models/Document").Document, import("../common/shared/models/Document").Document>;
+export declare const initialise: ModuleInitialiseFunction<"ocr", OcrModuleContext>;
+declare type State = {
+    document: Document;
+    status: InputRequiredStatus | Status.COMPLETE;
+    failedStatus: FailedStatus;
+    files: File[];
+    isPreloaded: boolean;
+};
+export declare function createOCRInternalState(initialState: State): {
+    state$: ReactiveStore<State>;
+    status$: import("../common").Accessors<Status.COMPLETE | InputRequiredStatus, Status.COMPLETE | InputRequiredStatus>;
+    failedStatus$: import("../common").Accessors<FailedStatus, FailedStatus>;
+    document$: import("../common").Accessors<Document, Document>;
     files$: import("../common").Accessors<File[], File[]>;
     isPreloaded$: import("../common").Accessors<boolean, boolean>;
     _expectedSide$: import("../common").ReadonlyAccessors<"front" | "back">;
 };
+export declare type OcrModuleContext = ModuleContext<{
+    start(): void;
+    access: AccessFunction<PublicAccessors>;
+    isPreloaded: () => boolean;
+    statuses: Readonly<typeof Status>;
+}, Events>;
+export declare type PublicAccessors = AccessorsDictionary<{
+    readonly status: Status;
+    readonly isPreloaded: boolean;
+}>;

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

@@ -1,50 +1,50 @@
-import { mkEventHub, mkEventListener, ReactiveStore } from "../common";
-import { isInputRequiredStatus, OCRClient, Status } from "../frankie-client/clients/OCRClient";
+import { ReactiveStore, mkEventHub, mkEventListener } from "../common";
+import { OCRClient, Status, isInputRequiredStatus, } from "../frankie-client/clients/OCRClient";
 import { mkStartMethod } from "./actions/start";
 export { Status };
-export const ocrModule = {
-    initialise(options) {
-        const { frankieClient, oneSdkInstance, globalEventHub } = options;
-        const client = new OCRClient(frankieClient);
-        const eventHub = mkEventHub();
-        const { _expectedSide$, document$, failedStatus$, files$, isPreloaded$, status$ } = initialiseLocalState(new ReactiveStore({
-            document: null,
-            status: null,
-            failedStatus: null,
-            files: [],
-            isPreloaded: null,
-        }));
-        const publicAccessors = {
-            status: status$.toReadonly(),
-            failedStatus: failedStatus$.toReadonly(),
-            isPreloaded: isPreloaded$.toReadonly(),
-        };
-        const start = mkStartMethod({
-            _expectedSide$,
-            client,
-            document$,
-            eventHub,
-            files$,
-            individual: oneSdkInstance.individual(),
-            status$,
-            isPreloaded$,
-            failedStatus$,
-            globalEventHub,
-        });
-        // Event mappings for telemetry
-        eventHub.on("input_required", ({ documentType, side }, status) => globalEventHub.emit("telemetry", {
-            eventName: "OCR:INPUT_REQUIRED",
-            data: {
-                documentType,
-                side,
-                status,
-            },
-        }));
-        eventHub.on("results", () => globalEventHub.emit("telemetry", "OCR:RESULTS"));
-        return Object.assign(Object.assign({}, mkEventListener(eventHub)), { start, isPreloaded: () => isPreloaded$.getValue(), access: (fieldName) => publicAccessors[fieldName], statuses: Object.freeze(Status) });
-    },
+export const initialise = (options) => {
+    const { frankieClient, oneSdkInstance, globalEventHub } = options;
+    const client = new OCRClient(frankieClient);
+    const eventHub = mkEventHub();
+    const { status$, failedStatus$, document$, files$, isPreloaded$, _expectedSide$ } = createOCRInternalState({
+        document: null,
+        status: null,
+        failedStatus: null,
+        files: [],
+        isPreloaded: null,
+    });
+    const publicAccessors = {
+        status: status$.toReadonly(),
+        failedStatus: failedStatus$.toReadonly(),
+        isPreloaded: isPreloaded$.toReadonly(),
+    };
+    const start = mkStartMethod({
+        _expectedSide$,
+        client,
+        document$,
+        eventHub,
+        files$,
+        individual: oneSdkInstance.individual(),
+        status$,
+        isPreloaded$,
+        failedStatus$,
+        globalEventHub,
+    });
+    // Event mappings for telemetry
+    eventHub.on("input_required", ({ documentType, side }, status) => globalEventHub.emit("telemetry", {
+        eventName: "OCR:INPUT_REQUIRED",
+        data: {
+            documentType,
+            side,
+            status,
+        },
+    }));
+    eventHub.on("results", () => globalEventHub.emit("telemetry", "OCR:RESULTS"));
+    return Object.assign(Object.assign({}, mkEventListener(eventHub)), { start, isPreloaded: () => isPreloaded$.getValue(), access: (fieldName) => publicAccessors[fieldName], statuses: Object.freeze(Status) });
 };
-export function initialiseLocalState(state$) {
+export function createOCRInternalState(initialState) {
+    // Set reactive internal state
+    const state$ = new ReactiveStore(initialState);
     const status$ = state$.getRootAccessors("status");
     const failedStatus$ = state$.getRootAccessors("failedStatus");
     const document$ = state$.getRootAccessors("document");
@@ -61,13 +61,6 @@ export function initialiseLocalState(state$) {
         },
         propertyName: "expectedSide",
     });
-    return {
-        status$,
-        failedStatus$,
-        document$,
-        files$,
-        isPreloaded$,
-        _expectedSide$,
-    };
+    return { state$, status$, failedStatus$, document$, files$, isPreloaded$, _expectedSide$ };
 }
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/ocr/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC5E,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,0CAA0C,CAAC;AACpG,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIhD,OAAO,EAAE,MAAM,EAAE,CAAC;AAElB,MAAM,CAAC,MAAM,SAAS,GAAc;IAClC,UAAU,CAAC,OAAO;QAChB,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAClE,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,UAAU,EAAU,CAAC;QAEtC,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,oBAAoB,CACtG,IAAI,aAAa,CAAQ;YACvB,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;YACZ,YAAY,EAAE,IAAI;YAClB,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,IAAI;SAClB,CAAC,CACH,CAAC;QAEF,MAAM,eAAe,GAAG;YACtB,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE;YAC5B,YAAY,EAAE,aAAa,CAAC,UAAU,EAAE;YACxC,WAAW,EAAE,YAAY,CAAC,UAAU,EAAE;SACvC,CAAC;QAEF,MAAM,KAAK,GAAG,aAAa,CAAC;YAC1B,cAAc;YACd,MAAM;YACN,SAAS;YACT,QAAQ;YACR,MAAM;YACN,UAAU,EAAE,cAAc,CAAC,UAAU,EAAE;YACvC,OAAO;YACP,YAAY;YACZ,aAAa;YACb,cAAc;SACf,CAAC,CAAC;QAEH,+BAA+B;QAE/B,QAAQ,CAAC,EAAE,CAAC,gBAAgB,EAAE,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,CAC/D,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;YAC/B,SAAS,EAAE,oBAAoB;YAC/B,IAAI,EAAE;gBACJ,YAAY;gBACZ,IAAI;gBACJ,MAAM;aACP;SACF,CAAC,CACH,CAAC;QACF,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC,CAAC;QAE9E,uCACK,eAAe,CAAC,QAAQ,CAAC,KAC5B,KAAK,EACL,WAAW,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,EAC1C,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC,EACjD,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAC/B;IACJ,CAAC;CACF,CAAC;AAEF,MAAM,UAAU,oBAAoB,CAAC,MAA4B;IAC/D,MAAM,OAAO,GAAG,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAClD,MAAM,aAAa,GAAG,MAAM,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;IAC9D,MAAM,SAAS,GAAG,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACtD,MAAM,MAAM,GAAG,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAE5D,MAAM,cAAc,GAAG,aAAa,CAAC,mBAAmB,CAAC,OAAO,EAAE;QAChE,WAAW,EAAE,CAAC,MAAM,EAAE,EAAE;YACtB,IAAI,qBAAqB,CAAC,MAAM,CAAC,EAAE;gBACjC,OAAO,MAAM,KAAK,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;aAC3D;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;QACH,CAAC;QACD,YAAY,EAAE,cAAc;KAC7B,CAAC,CAAC;IACH,OAAO;QACL,OAAO;QACP,aAAa;QACb,SAAS;QACT,MAAM;QACN,YAAY;QACZ,cAAc;KACf,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/ocr/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuC,aAAa,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjH,OAAO,EAGL,SAAS,EACT,MAAM,EACN,qBAAqB,GACtB,MAAM,0CAA0C,CAAC;AAElD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAMhD,OAAO,EAAE,MAAM,EAAE,CAAC;AAElB,MAAM,CAAC,MAAM,UAAU,GAAsD,CAAC,OAAO,EAAE,EAAE;IACvF,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;IAClE,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,UAAU,EAAU,CAAC;IAEtC,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,sBAAsB,CAAC;QACzG,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,IAAI;QACZ,YAAY,EAAE,IAAI;QAClB,KAAK,EAAE,EAAE;QACT,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC;IAEH,MAAM,eAAe,GAAG;QACtB,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE;QAC5B,YAAY,EAAE,aAAa,CAAC,UAAU,EAAE;QACxC,WAAW,EAAE,YAAY,CAAC,UAAU,EAAE;KACvC,CAAC;IAEF,MAAM,KAAK,GAAG,aAAa,CAAC;QAC1B,cAAc;QACd,MAAM;QACN,SAAS;QACT,QAAQ;QACR,MAAM;QACN,UAAU,EAAE,cAAc,CAAC,UAAU,EAAE;QACvC,OAAO;QACP,YAAY;QACZ,aAAa;QACb,cAAc;KACf,CAAC,CAAC;IAEH,+BAA+B;IAE/B,QAAQ,CAAC,EAAE,CAAC,gBAAgB,EAAE,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,CAC/D,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;QAC/B,SAAS,EAAE,oBAAoB;QAC/B,IAAI,EAAE;YACJ,YAAY;YACZ,IAAI;YACJ,MAAM;SACP;KACF,CAAC,CACH,CAAC;IACF,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC,CAAC;IAE9E,uCACK,eAAe,CAAC,QAAQ,CAAC,KAC5B,KAAK,EACL,WAAW,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,EAC1C,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC,EACjD,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAC/B;AACJ,CAAC,CAAC;AASF,MAAM,UAAU,sBAAsB,CAAC,YAAmB;IACxD,8BAA8B;IAC9B,MAAM,MAAM,GAAG,IAAI,aAAa,CAAQ,YAAY,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAClD,MAAM,aAAa,GAAG,MAAM,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;IAC9D,MAAM,SAAS,GAAG,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACtD,MAAM,MAAM,GAAG,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAE5D,MAAM,cAAc,GAAG,aAAa,CAAC,mBAAmB,CAAC,OAAO,EAAE;QAChE,WAAW,EAAE,CAAC,MAAM,EAAE,EAAE;YACtB,IAAI,qBAAqB,CAAC,MAAM,CAAC,EAAE;gBACjC,OAAO,MAAM,KAAK,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;aAC3D;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;QACH,CAAC;QACD,YAAY,EAAE,cAAc;KAC7B,CAAC,CAAC;IACH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAC7F,CAAC"}

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

@@ -1,3 +1,3 @@
 import type { OneSdkModule } from "./types";
-export type { OneSdkContext, OneSdkRootParameters } from "./types";
+export * from "./types";
 export declare const oneSdk: OneSdkModule;

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

@@ -7,32 +7,32 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { individualModule } from "../individual";
+import { initialise as individualModule } from "../individual";
 import { mkEventListener } from "../common";
-import { sessionModule } from "../session";
 import { mkComponentLoader } from "./initialisation/componentLoader";
-import { parseConfiguration } from "./initialisation/configurationParser";
+import { parseConfiguration, resolveParameters } from "./initialisation/configurationParser";
 import { mkSharedDependencies } from "./initialisation/sharedDependencies";
+export * from "./types";
 export const oneSdk = {
-    initialise: function (oneSdkOptions) {
+    initialise: function (oneSdkRootParameters) {
         return __awaiter(this, void 0, void 0, function* () {
-            const sessionContext = sessionModule.initialise(oneSdkOptions);
-            const sharedDependencies = yield mkSharedDependencies(oneSdkOptions, sessionContext);
+            const resolvedParameters = resolveParameters(oneSdkRootParameters);
+            const sharedDependencies = yield mkSharedDependencies(resolvedParameters);
             const { globalEventHub } = sharedDependencies;
             try {
-                const { sharedState, warnings } = yield parseConfiguration(oneSdkOptions, sharedDependencies);
+                const { sharedState, warnings } = yield parseConfiguration(resolvedParameters, sharedDependencies);
                 // 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), { individual: () => individual, component: null });
-                const baseModuleOptions = Object.assign(Object.assign({}, sharedState), { oneSdkInstance: sdk });
+                const sharedConfiguration = Object.assign(sharedState, { oneSdkInstance: sdk });
                 // Initialise and label the individual component, which is special and will be
                 // available through the static factory method called "individual"
-                const individual = individualModule.initialise(Object.assign(Object.assign({}, baseModuleOptions), { instanceName: "individual" }));
+                const individual = individualModule(sharedConfiguration);
                 // Make the dynamic component loader, which initialises components dynamically
-                sdk.component = mkComponentLoader(baseModuleOptions);
+                sdk.component = mkComponentLoader(sharedConfiguration);
                 // 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
@@ -51,7 +51,7 @@ export const oneSdk = {
                 globalEventHub.emit("telemetry", {
                     eventName: "INIT:ERROR",
                     data: {
-                        oneSdkOptions,
+                        oneSdkOptions: oneSdkRootParameters,
                     },
                     error,
                 });

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/sdk/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAI3E,MAAM,CAAC,MAAM,MAAM,GAAiB;IAClC,UAAU,EAAE,UAAgB,aAAa;;YACvC,MAAM,cAAc,GAAG,aAAa,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YAC/D,MAAM,kBAAkB,GAAG,MAAM,oBAAoB,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;YACrF,MAAM,EAAE,cAAc,EAAE,GAAG,kBAAkB,CAAC;YAC9C,IAAI;gBACF,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,MAAM,kBAAkB,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;gBAE9F,oEAAoE;gBACpE,kEAAkE;gBAClE,gHAAgH;gBAChH,mBAAmB;gBACnB,MAAM,mBAAmB,GAAG,eAAe,CAAC,cAAc,CAAC,CAAC;gBAC5D,MAAM,GAAG,mCACJ,mBAAmB,KACtB,UAAU,EAAE,GAAG,EAAE,CAAC,UAAU,EAC5B,SAAS,EAAE,IAAI,GAChB,CAAC;gBACF,MAAM,iBAAiB,mCAAqB,WAAW,KAAE,cAAc,EAAE,GAAG,GAAE,CAAC;gBAC/E,8EAA8E;gBAC9E,kEAAkE;gBAClE,MAAM,UAAU,GAAG,gBAAgB,CAAC,UAAU,iCACzC,iBAAiB,KACpB,YAAY,EAAE,YAAY,IAC1B,CAAC;gBACH,8EAA8E;gBAC9E,GAAG,CAAC,SAAS,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;gBAErD,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,OAAO,GAAG,CAAC;aACZ;YAAC,OAAO,KAAK,EAAE;gBACd,mGAAmG;gBACnG,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC/B,SAAS,EAAE,YAAY;oBACvB,IAAI,EAAE;wBACJ,aAAa;qBACd;oBACD,KAAK;iBACN,CAAC,CAAC;gBACH,MAAM,KAAK,CAAC;aACb;QACH,CAAC;KAAA;CACF,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/sdk/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AAC7F,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAS3E,cAAc,SAAS,CAAC;AAExB,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;gBACF,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,MAAM,kBAAkB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;gBAEnG,oEAAoE;gBACpE,kEAAkE;gBAClE,gHAAgH;gBAChH,mBAAmB;gBACnB,MAAM,mBAAmB,GAAG,eAAe,CAAC,cAAc,CAAC,CAAC;gBAC5D,MAAM,GAAG,mCACJ,mBAAmB,KACtB,UAAU,EAAE,GAAG,EAAE,CAAC,UAAU,EAC5B,SAAS,EAAE,IAAI,GAChB,CAAC;gBACF,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC;gBAChF,8EAA8E;gBAC9E,kEAAkE;gBAClE,MAAM,UAAU,GAAG,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;gBACzD,8EAA8E;gBAC9E,GAAG,CAAC,SAAS,GAAG,iBAAiB,CAAC,mBAAmB,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,OAAO,GAAG,CAAC;aACZ;YAAC,OAAO,KAAK,EAAE;gBACd,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;aACb;QACH,CAAC;KAAA;CACF,CAAC"}

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

@@ -1,7 +1,7 @@
 import { OneSdkContext, SharedState } from "../types";
 /**
  * This factory will generate another function which will
- * 1) load a public module by module name, defined in the dictionary PublicModules;
+ * 1) load a public 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", which essentially is what we call a "component".
  *

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

@@ -1,7 +1,18 @@
-import { merge, PublicModules } from "../../common";
+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 { ModulesDictionary, merge } from "../../common";
 /**
  * This factory will generate another function which will
- * 1) load a public module by module name, defined in the dictionary PublicModules;
+ * 1) load a public 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", which essentially is what we call a "component".
  *
@@ -21,22 +32,25 @@ export const mkComponentLoader = (sharedState) => {
         const [which, options] = parameters;
         // 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 the module name itself
-        const { instanceName = which } = options !== null && options !== void 0 ? options : {};
-        // Store "telemetry-event-friendly" formatted component name for later use
-        const WHICH = which.toUpperCase();
+        const _a = options !== null && options !== void 0 ? options : {}, { instanceName = which } = _a, moduleOptions = __rest(_a, ["instanceName"]);
         // if instance already exists, return it
         const instance = retrieveInstance(which, instanceName);
         if (instance)
             return instance;
         else {
             // Otherwise,
-            // 1) resolve new configuration
-            const mergedOptions = merge({}, sharedState, options, { instanceName, componentName: which });
-            sharedState.globalEventHub.emit("resolved_module_config", mergedOptions);
-            const module = PublicModules[which];
+            // 1) resolve module parameters: baseModuleOptions and moduleOptions
+            const sharedConfiguration = merge({}, sharedState, {
+                moduleMeta: {
+                    moduleName: which,
+                    instanceName,
+                },
+            });
+            sharedState.globalEventHub.emit("resolved_module_config", sharedConfiguration, moduleOptions);
+            const module = ModulesDictionary[which];
             try {
                 // 2) Initialise module, resulting in the module context for that instance (aka a component)
-                const moduleContext = module.initialise(mergedOptions);
+                const moduleContext = module(sharedConfiguration, moduleOptions);
                 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

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

@@ -1 +1 @@
-{"version":3,"file":"componentLoader.js","sourceRoot":"","sources":["../../../../../modules/sdk/initialisation/componentLoader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAe,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAanE;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,WAAwB,EAA8B,EAAE;IACxF,MAAM,EAAE,gBAAgB,EAAE,aAAa,EAAE,mBAAmB,EAAE,GAAG,oBAAoB,EAAE,CAAC;IAExF,MAAM,eAAe,GAAsB,CACzC,GAAG,UAAmD,EACnC,EAAE;QACrB,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,UAAU,CAAC;QACpC,8GAA8G;QAC9G,mDAAmD;QACnD,MAAM,EAAE,YAAY,GAAG,KAAK,EAAE,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QAC/C,0EAA0E;QAC1E,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAClC,wCAAwC;QACxC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QACvD,IAAI,QAAQ;YAAE,OAAO,QAAQ,CAAC;aACzB;YACH,aAAa;YACb,+BAA+B;YAC/B,MAAM,aAAa,GAAG,KAAK,CAAC,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,YAAY,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;YAC9F,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,wBAAwB,EAAE,aAAa,CAAC,CAAC;YACzE,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAW,CAAC;YAE9C,IAAI;gBACF,4FAA4F;gBAC5F,MAAM,aAAa,GAAG,MAAM,CAAC,UAAU,CAAC,aAAa,CAAoB,CAAC;gBAC1E,MAAM,QAAQ,GAAsB,kBAAkB,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;gBACpF,aAAa,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;gBAE7C,kHAAkH;gBAClH,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC3C,SAAS,EAAE,gBAAgB;oBAC3B,IAAI,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE;iBACpC,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,QAA6B,CAAC;aACtC;YAAC,OAAO,KAAK,EAAE;gBACd,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC3C,SAAS,EAAE,sBAAsB;oBACjC,IAAI,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE;oBACnC,KAAK;iBACN,CAAC,CAAC;gBACH,MAAM,KAAK,CAAC;aACb;SACF;IACH,CAAC,CAAC;IACF,wFAAwF;IACxF,OAAO,MAAM,CAAC,cAAc,CAAC,eAAe,EAAE,WAAW,EAAE;QACzD,KAAK,EAAE,mBAAqD;QAC5D,UAAU,EAAE,KAAK;QACjB,QAAQ,EAAE,KAAK;KAChB,CAA+B,CAAC;AACnC,CAAC,CAAC;AACF,MAAM,kBAAkB,GAAG,CACzB,CAAU,EACV,YAA0B,EAC1B,EAAE;IACF,OAAO,MAAM,CAAC,cAAc,CAAC,CAAC,EAAE,cAAc,EAAE;QAC9C,KAAK,EAAE,YAAY;QACnB,UAAU,EAAE,IAAI;QAChB,QAAQ,EAAE,KAAK;KAChB,CAA6C,CAAC;AACjD,CAAC,CAAC;AAEF,SAAS,oBAAoB;IAC3B,MAAM,mBAAmB,GAAyB,EAAE,CAAC;IACrD,MAAM,aAAa,GAAG,CACpB,UAAgB,EAChB,YAA0B,EAC1B,QAA2B,EAC3B,EAAE;;QACF,mBAAmB,CAAC,UAAU,CAAC,GAAG,MAAA,mBAAmB,CAAC,UAAU,CAAC,mCAAI,EAAE,CAAC;QACxE,mBAAmB,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,GAAG,QAAoD,CAAC;IACvG,CAAC,CAAC;IACF,MAAM,gBAAgB,GAAG,CACvB,UAAgB,EAChB,YAA0B,EACA,EAAE;;QAC5B,OAAO,MAAA,MAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAG,UAAU,CAAC,0CAAG,YAAY,CAAC,mCAAI,IAAI,CAAC;IACnE,CAAC,CAAC;IAEF,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,CAAC;AAClE,CAAC"}
+{"version":3,"file":"componentLoader.js","sourceRoot":"","sources":["../../../../../modules/sdk/initialisation/componentLoader.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,EAAoB,iBAAiB,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAgB5E;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,WAAwB,EAA8B,EAAE;IACxF,MAAM,EAAE,gBAAgB,EAAE,aAAa,EAAE,mBAAmB,EAAE,GAAG,oBAAoB,EAAE,CAAC;IAExF,MAAM,eAAe,GAA6B,CAChD,GAAG,UAA4C,EAC5B,EAAE;QAIrB,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,GAA2B,UAAU,CAAC;QAC5D,8GAA8G;QAC9G,mDAAmD;QACnD,MAAM,KAA6C,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,EAA1D,EAAE,YAAY,GAAG,KAAK,OAAoC,EAA/B,aAAa,cAAxC,gBAA0C,CAAgB,CAAC;QACjE,wCAAwC;QACxC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QACvD,IAAI,QAAQ;YAAE,OAAO,QAAQ,CAAC;aACzB;YACH,aAAa;YACb,oEAAoE;YAEpE,MAAM,mBAAmB,GAA8B,KAAK,CAAC,EAAE,EAAE,WAAW,EAAE;gBAC5E,UAAU,EAAE;oBACV,UAAU,EAAE,KAAK;oBACjB,YAAY;iBACb;aACF,CAAC,CAAC;YAEH,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,wBAAwB,EAAE,mBAAmB,EAAE,aAAa,CAAC,CAAC;YAE9F,MAAM,MAAM,GAA8B,iBAAiB,CAAC,KAAK,CAAC,CAAC;YAEnE,IAAI;gBACF,4FAA4F;gBAC5F,MAAM,aAAa,GAAkB,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;gBAChF,MAAM,QAAQ,GAAsB,kBAAkB,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;gBACpF,aAAa,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;gBAE7C,kHAAkH;gBAClH,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC3C,SAAS,EAAE,gBAAgB;oBAC3B,IAAI,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE;iBACpC,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,OAA0B,QAAQ,CAAC;aACpC;YAAC,OAAO,KAAK,EAAE;gBACd,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC3C,SAAS,EAAE,sBAAsB;oBACjC,IAAI,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE;oBACnC,KAAK;iBACN,CAAC,CAAC;gBACH,MAAM,KAAK,CAAC;aACb;SACF;IACH,CAAC,CAAC;IACF,wFAAwF;IACxF,OAAmC,MAAM,CAAC,cAAc,CAAC,eAAe,EAAE,WAAW,EAAE;QACrF,KAAK,EAAE,mBAAmB;QAC1B,UAAU,EAAE,KAAK;QACjB,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC;AACL,CAAC,CAAC;AACF,MAAM,kBAAkB,GAAG,CAAC,CAAgB,EAAE,YAAoB,EAAmB,EAAE;IACrF,OAAwB,MAAM,CAAC,cAAc,CAAC,CAAC,EAAE,cAAc,EAAE;QAC/D,KAAK,EAAE,YAAY;QACnB,UAAU,EAAE,IAAI;QAChB,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,SAAS,oBAAoB;IAC3B,MAAM,mBAAmB,GAAyB,EAAE,CAAC;IACrD,MAAM,aAAa,GAAG,CACpB,UAAgB,EAChB,YAA0B,EAC1B,QAAyC,EACzC,EAAE;;QACF,mBAAmB,CAAC,UAAU,CAAC,GAAG,MAAA,mBAAmB,CAAC,UAAU,CAAC,mCAAI,EAAE,CAAC;QACxE,mBAAmB,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,GAA6C,QAAQ,CAAC;IACrG,CAAC,CAAC;IACF,MAAM,gBAAgB,GAAG,CACvB,UAAgB,EAChB,YAA0B,EACA,EAAE;;QAC5B,OAAO,MAAA,MAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAG,UAAU,CAAC,0CAAG,YAAY,CAAC,mCAAI,IAAI,CAAC;IACnE,CAAC,CAAC;IAEF,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,CAAC;AAClE,CAAC"}

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

@@ -1,20 +1,19 @@
-import { OneSdkRootParameters, RecipeParsed, SdkModes, SharedDependencies, SharedState } from "../types";
+import { OneSdkRootParameters, RecipeParsed, ResolvedRootParameters, SharedDependencies, SharedState } from "../types";
 /**
  *
  * Parses parameters passed to OneSDK constructor and returns a dictionary of sharedState variables and a list of warnings to be emitted as global events by the top level constructor
- * @param oneSdkOptions All the parameters passed to the OneSDK constructor
+ * @param rootParameters All the parameters passed to the OneSDK constructor
  * @returns { sharedState: Dictionary, warnings: { level: "info"|"warnings"|"error", message: string, payload: unknown }[] }
  */
-export declare function parseConfiguration(oneSdkOptions: OneSdkRootParameters, sharedDependencies: SharedDependencies): Promise<{
-    sharedState: Omit<SharedState, "oneSdkInstance">;
+export declare function parseConfiguration(rootParameters: ResolvedRootParameters, sharedDependencies: SharedDependencies): Promise<{
+    sharedState: SharedState;
     warnings: Warning[];
 }>;
-export declare function includeTelemetry(oneSdkOptions: OneSdkRootParameters): boolean;
-export declare function resolveMode(oneSdkOptions: OneSdkRootParameters): {
-    modeName: SdkModes;
-    mode: OneSdkRootParameters["mode"];
-};
-export declare function resolveRecipeValue(recipe: OneSdkRootParameters["recipe"]): RecipeParsed;
+export declare function resolveParameters(oneSdkRootParameters: OneSdkRootParameters): ResolvedRootParameters;
+export declare function resolveSession(sessionParameter: OneSdkRootParameters["session"]): ResolvedRootParameters["session"];
+export declare function resolveModeObject(modeParameter: OneSdkRootParameters["mode"]): ResolvedRootParameters["mode"];
+export declare function resolveRecipeValue(recipeParameter: OneSdkRootParameters["recipe"]): RecipeParsed;
+export declare function includeTelemetry(oneSdkOptions: ResolvedRootParameters): boolean;
 declare type Warning = {
     level: "info" | "warning";
     data: {