@frankieone/one-sdk 0.4.2-rc.0 → 0.4.2-rc.5

package/dist/esm/modules/individual/actions/submit.js

@@ -7,31 +7,47 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-export const mkSubmitMethod = (deps) => ((o) => __awaiter(void 0, void 0, void 0, function* () {
-    const { applicant$, eventHub, client, documents$ } = deps;
-    // skipping requirements for consents initially
-    const hasConsentGiven = true; // consentsGiven$.getValue().length > 0;
-    const hasEntityId = Boolean(applicant$.getValue().entityId);
-    if (!hasConsentGiven) {
-        const message = "Consent needs to be provided before submitting any data.";
-        eventHub.emit("error", {
-            message,
-            payload: {
-                hint: "Capture user's consent and provide it using the method addConsent({ type }), where 'type' is one of the values defined in our api documentation",
-            },
-        });
-        throw new Error(message);
-    }
-    const method = hasEntityId ? client.updateApplicant : client.createApplicant;
-    const applicant = applicant$.getValue();
-    const documents = documents$.getValue();
-    const { entityId } = yield method.bind(client)({ applicant, documents });
-    if (!hasEntityId) {
-        applicant.entityId = entityId;
-        applicant$.setValue(applicant);
-    }
-    if (o === null || o === void 0 ? void 0 : o.verify)
-        return yield client.triggerChecks();
-    return true;
-}));
+import { OneSDKError } from "../../common/errors/OneSDKError";
+export const mkSubmitMethod = (deps) => {
+    const submitMethod = (o) => __awaiter(void 0, void 0, void 0, function* () {
+        const { applicant$, eventHub, client, documents$, globalEventHub } = deps;
+        const eventName = (o === null || o === void 0 ? void 0 : o.verify) ? "SUBMIT_AND_VERIFY" : "SUBMIT";
+        try {
+            // skipping requirements for consents initially
+            const hasConsentGiven = true; // consentsGiven$.getValue().length > 0;
+            const hasEntityId = Boolean(applicant$.getValue().entityId);
+            if (!hasConsentGiven) {
+                throw new OneSDKError("Consent needs to be provided before submitting any data.", {
+                    hint: "Capture user's consent and provide it using the method addConsent({ type }), where 'type' is one of the values defined in our api documentation",
+                });
+            }
+            // Decide if creating or updating applicant and then extract method into a single variable
+            const method = hasEntityId ? client.updateApplicant : client.createApplicant;
+            const applicant = applicant$.getValue();
+            const documents = documents$.getValue();
+            // Bind extracted method above to the client object and then call it
+            // Either action will result in an entityId
+            // If creating new applicant, store recently found entity Id
+            const { entityId } = yield method.call(client, { applicant, documents });
+            if (!hasEntityId) {
+                applicant.entityId = entityId;
+                applicant$.setValue(applicant);
+            }
+            let checkSummary;
+            if (o === null || o === void 0 ? void 0 : o.verify)
+                checkSummary = yield client.triggerChecks();
+            globalEventHub.emit("telemetry", {
+                eventName,
+                data: hasEntityId ? {} : { createdEntityId: entityId },
+            });
+            if (o === null || o === void 0 ? void 0 : o.verify)
+                return checkSummary;
+        }
+        catch (error) {
+            eventHub.emit("error", error);
+            throw error;
+        }
+    });
+    return submitMethod;
+};
 //# sourceMappingURL=submit.js.map

package/dist/esm/modules/individual/actions/submit.js.map

@@ -1 +1 @@
-{"version":3,"file":"submit.js","sourceRoot":"","sources":["../../../../../modules/individual/actions/submit.ts"],"names":[],"mappings":";;;;;;;;;AAOA,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAM9B,EAAE,EAAE,CACH,CAAC,CAAO,CAAC,EAAE,EAAE;IACX,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IAC1D,+CAA+C;IAC/C,MAAM,eAAe,GAAG,IAAI,CAAC,CAAC,wCAAwC;IACtE,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC;IAE5D,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,OAAO,GAAG,0DAA0D,CAAC;QAC3E,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE;YACrB,OAAO;YACP,OAAO,EAAE;gBACP,IAAI,EAAE,iJAAiJ;aACxJ;SACF,CAAC,CAAC;QACH,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;KAC1B;IACD,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC;IAC7E,MAAM,SAAS,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC;IACxC,MAAM,SAAS,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC;IAExC,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IACzE,IAAI,CAAC,WAAW,EAAE;QAChB,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC9B,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;KAChC;IAED,IAAI,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,MAAM;QAAE,OAAO,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;IACnD,OAAO,IAAI,CAAC;AACd,CAAC,CAAA,CAAsC,CAAC"}
+{"version":3,"file":"submit.js","sourceRoot":"","sources":["../../../../../modules/individual/actions/submit.ts"],"names":[],"mappings":";;;;;;;;;AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAI9D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAO9B,EAAE,EAAE;IACH,MAAM,YAAY,GAAG,CAAO,CAAsB,EAAgC,EAAE;QAClF,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;QAC1E,MAAM,SAAS,GAAG,CAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,MAAM,EAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC7D,IAAI;YACF,+CAA+C;YAC/C,MAAM,eAAe,GAAG,IAAI,CAAC,CAAC,wCAAwC;YACtE,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC;YAE5D,IAAI,CAAC,eAAe,EAAE;gBACpB,MAAM,IAAI,WAAW,CAAC,0DAA0D,EAAE;oBAChF,IAAI,EAAE,iJAAiJ;iBACxJ,CAAC,CAAC;aACJ;YACD,0FAA0F;YAC1F,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC;YAC7E,MAAM,SAAS,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC;YACxC,MAAM,SAAS,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC;YAExC,oEAAoE;YACpE,2CAA2C;YAC3C,4DAA4D;YAC5D,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;YACzE,IAAI,CAAC,WAAW,EAAE;gBAChB,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBAC9B,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;aAChC;YACD,IAAI,YAA0B,CAAC;YAC/B,IAAI,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,MAAM;gBAAE,YAAY,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAE3D,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC/B,SAAS;gBACT,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,QAAQ,EAAE;aACvD,CAAC,CAAC;YAEH,IAAI,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,MAAM;gBAAE,OAAO,YAAY,CAAC;SACpC;QAAC,OAAO,KAAK,EAAE;YACd,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC9B,MAAM,KAAK,CAAC;SACb;IACH,CAAC,CAAA,CAAC;IACF,OAAO,YAAiD,CAAC;AAC3D,CAAC,CAAC"}

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

@@ -7,7 +7,7 @@ import { mkSearchMethod } from "./actions/search";
 import { mkSubmitMethod } from "./actions/submit";
 export const individualModule = {
     initialise(o) {
-        const { frankieClient } = o;
+        const { frankieClient, globalEventHub } = o;
         const client = new ApplicantClient(frankieClient);
         const state$ = new ReactiveStore({
             applicant: null,
@@ -54,6 +54,7 @@ export const individualModule = {
             consentsGiven$,
             documents$,
             eventHub,
+            globalEventHub,
         });
         const addConsent = mkAddConsents({
             consentsGiven$,

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,GAAG,CAAC,CAAC;QAC5B,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;SACT,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,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"}

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

@@ -16,7 +16,7 @@ export declare type IndividualModuleContext = ModuleContext<{
     updateDocument: (id: string, details: Document) => void;
     submit: <T extends boolean>(o?: {
         verify: T;
-    }) => Promise<T extends true ? CheckSummary : true>;
+    }) => Promise<T extends true ? CheckSummary : void>;
     access: AccessFunction<PublicFields>;
 }, Events>;
 export declare type PublicFields = {

package/dist/esm/modules/meta.json

@@ -0,0 +1 @@
+{ "version": "0.4.2-rc.5" }

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

@@ -2,6 +2,7 @@ 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 { GlobalEvents } from "../../sdk/types";
 import { Events } from "../types";
 declare type Dependencies = {
     _expectedSide$: ReadonlyAccessors<"front" | "back">;
@@ -13,6 +14,7 @@ declare type Dependencies = {
     client: OCRClient;
     isPreloaded$: Accessors<boolean>;
     failedStatus$: Accessors<FailedStatus>;
+    globalEventHub: EventHub<GlobalEvents>;
 };
 export declare type DependenciesWithInterrupt = Dependencies & {
     interruptOCR: InterruptOCR;

package/dist/esm/modules/ocr/actions/start.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { Document } from "../../common/shared/models/Document";
 import { isCompleteStatus, isFailedStatus, isInputRequiredStatus, Status, } from "../../frankie-client/clients/OCRClient";
 import { filter, Subject, takeUntil, takeWhile } from "rxjs";
+import { OneSDKError } from "../../common/errors/OneSDKError";
 /**
  * Returns the start method called by customers to trigger the OCR flow
  * It first generates two observables by branching off the OCR's internal state variables
@@ -30,7 +31,8 @@ import { filter, Subject, takeUntil, takeWhile } from "rxjs";
  * @returns { interruptOCR }, where interruptOCR forces the end of the OCR cycles
  */
 export const mkStartMethod = (deps) => () => __awaiter(void 0, void 0, void 0, function* () {
-    const { status$, failedStatus$, eventHub, document$, files$, isPreloaded$ } = deps;
+    const { status$, failedStatus$, eventHub, document$, files$, isPreloaded$, globalEventHub } = deps;
+    globalEventHub.emit("telemetry", "OCR:START");
     // If flow was interrupted with an error, interrupt observable as well
     const interruptor = new Subject();
     const interruptOCR = ({ message, payload = null }) => interruptor.error({ message, payload });
@@ -61,7 +63,7 @@ export const mkStartMethod = (deps) => () => __awaiter(void 0, void 0, void 0, f
         error: (e) => {
             // when flow is interrupted by calling interruptOCR, which will in turn
             // emit an error internally, trigerring this error callback
-            eventHub.emit("error", { message: "While executing OCR callbacks: " + e.message, payload: e.payload });
+            eventHub.emit("error", new OneSDKError("While executing OCR callbacks: " + e.message, e.payload));
             resetState();
         },
     };

package/dist/esm/modules/ocr/actions/start.js.map

@@ -1 +1 @@
-{"version":3,"file":"start.js","sourceRoot":"","sources":["../../../../../modules/ocr/actions/start.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAIL,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EAGrB,MAAM,GACP,MAAM,0CAA0C,CAAC;AAElD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAgB7D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAkB,EAAE,EAAE,CAAC,GAAS,EAAE;IAC9D,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IAEnF,sEAAsE;IACtE,MAAM,WAAW,GAAG,IAAI,OAAO,EAAE,CAAC;IAClC,MAAM,YAAY,GAAiB,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5G,gEAAgE;IAChE,uIAAuI;IACvI,MAAM,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAClD,MAAM,CAAC,OAAO,CAAC,EACf,SAAS,CAAC,WAAW,CAAC,EACtB,SAAS,CAAC,mBAAmB,CAAC,CAC/B,CAAC;IACF,uEAAuE;IACvE,MAAM,uBAAuB,GAAG,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;IACvG,MAAM,uBAAuB,mCAAmC,IAAI,KAAE,YAAY,GAAE,CAAC;IACrF,uBAAuB;IACvB,MAAM,UAAU,GAAG,GAAG,EAAE;QACtB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvB,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACpB,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC,CAAC;IACF,MAAM,UAAU,GAAG;QACjB,IAAI,EAAE,CAAC,SAAiB,EAAE,EAAE;YAC1B,4EAA4E;YAC5E,aAAa,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC;QACpD,CAAC;QACD,QAAQ,EAAE,GAAG,EAAE;YACb,oEAAoE;YACpE,WAAW,CAAC,uBAAuB,CAAC,CAAC;YACrC,UAAU,EAAE,CAAC;QACf,CAAC;QACD,KAAK,EAAE,CAAC,CAAwC,EAAE,EAAE;YAClD,uEAAuE;YACvE,2DAA2D;YAC3D,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,iCAAiC,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YACvG,UAAU,EAAE,CAAC;QACf,CAAC;KACF,CAAC;IAEF,kEAAkE;IAClE,6CAA6C;IAC7C,MAAM,kBAAkB,CAAC,uBAAuB,CAAC,CAAC;IAElD,yCAAyC;IACzC,aAAa;IACb,oBAAoB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAC3C,sBAAsB;IACtB,uBAAuB,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACnD,gGAAgG;IAChG,OAAO;QACL,YAAY,EAAE,GAAG,EAAE,CACjB,YAAY,CAAC;YACX,OAAO,EAAE,iCAAiC;YAC1C,OAAO,EAAE;gBACP,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;gBACnC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;gBAC/B,YAAY,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;aAC5C;SACF,CAAC;KACL,CAAC;AACJ,CAAC,CAAA,CAAC;AACF,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAC1E,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAW,EAAE,EAAE;;IAC5C,iEAAiE;IACjE,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,UAAU,GAAG,IAAI,EAAE,GAAG,MAAA,CAAC,CAAC,QAAQ,mCAAI,EAAE,CAAC;IAC9D,IAAI,CAAC,CAAA,MAAA,CAAC,CAAC,SAAS,0CAAE,MAAM,CAAA;QAAE,OAAO,KAAK,CAAC;IACvC,IAAI,MAAM,KAAK,KAAK;QAAE,OAAO,KAAK,CAAC;IACnC,IAAI,UAAU,KAAK,KAAK,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC1D,iEAAiE;IACjE,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAO,IAA+B,EAAE,EAAE;IAC1E;;;;;;;;OAQG;IACH,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IACnG,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAEpD,UAAU;IACV,MAAM,gBAAgB,GAAG,CAAC,MAAe,EAAoC,EAAE,CAAC,MAAM,KAAK,MAAM,CAAC,eAAe,CAAC;IAClH,MAAM,sBAAsB,GAAG,CAAC,MAAe,EAAkD,EAAE,CACjG,qBAAqB,CAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAE5D,MAAM,cAAc,GAAG,CAAC,MAA4C,EAAE,QAAkB,EAAE,WAAoB,EAAE,EAAE;QAChH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACzB,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC7B,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC,CAAC;IACF,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;IAEvF,wCAAwC;IACxC,MAAM,CAAC,sBAAsB,CAAC,GAAG,YAAY;SAC1C,QAAQ,EAAE;SACV,MAAM,CAAC,cAAc,CAAC;SACtB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;SAC/E,OAAO,EAAE,CAAC;IAEb,kCAAkC;IAClC,IAAI,CAAC,sBAAsB;QAAE,YAAY,EAAE,CAAC;SACvC,IAAI,cAAc,CAAC,sBAAsB,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;QAChE,oEAAoE;QACpE,cAAc,CAAC,MAAM,CAAC,aAAa,EAAE,sBAAsB,EAAE,IAAI,CAAC,CAAC;KACpE;SAAM,IAAI,gBAAgB,CAAC,sBAAsB,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;QACpE,iGAAiG;QACjG,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;QAC9F,sEAAsE;QACtE,IAAI,qBAAqB,CAAC,cAAc,CAAC,IAAI,gBAAgB,CAAC,cAAc,CAAC;YAC3E,cAAc,CAAC,cAAc,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;QACpD,yDAAyD;aACpD,IAAI,cAAc,KAAK,MAAM,CAAC,gBAAgB;YACjD,YAAY,CAAC;gBACX,OAAO,EAAE,4FAA4F,MAAM,CAAC,gBAAgB,EAAE;gBAC9H,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,sDAAsD;;YACjD,YAAY,EAAE,CAAC;KACrB;SAAM,IAAI,sBAAsB,CAAC,sBAAsB,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;QAC1E,4CAA4C;QAC5C,MAAM,YAAY,GAAG,sBAAsB,CAAC,SAAS,CAAC,MAAM,CAAC;QAC7D,qDAAqD;QACrD,cAAc,CAAC,YAAY,EAAE,sBAAsB,EAAE,IAAI,CAAC,CAAC;QAC3D,qDAAqD;KACtD;;QAAM,YAAY,EAAE,CAAC;AACxB,CAAC,CAAA,CAAC;AACF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAA+B,EAAE,EAAE;IAC7D,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IAEjD,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;IACtC,UAAU,CAAC,cAAc,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAEzD,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AACzC,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAE,IAA+B,EAAE,EAAE;IAC/E,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IACrD,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;IACtC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;IACpE,MAAM,IAAI,GAAG;QACX,YAAY,EAAE,MAAM;QACpB,IAAI,EAAE,cAAc,CAAC,QAAQ,EAAE;KACvB,CAAC;IACX,MAAM,OAAO,GAAG,uFAAuF,CAAC;IACxG,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACxC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/E,CAAC,CAAC;AACF,MAAM,OAAO,GAAG,CAA+C,IAAU,EAAE,YAAoB,EAAQ,EAAE;IACvG,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,OAAO,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE;QAClB,IAAI,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QAC7B,SAAS,GAAG,IAAI,CAAC;QACjB,OAAO,MAAM,CAAC;IAChB,CAAC,CAAS,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAA+B,EAAE,EAAE,CAAC,CAAC,IAAU,EAAE,EAAE;IAC/E,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC3C,IAAI,CAAC,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;IAC9G,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC7G,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;IAChC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC5C,MAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,UAAU;QACvB,CAAC,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,UAAU,CAAC;QAClD,CAAC,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAE5C,MAAM,EAAE;SACL,IAAI,CAAC,eAAe,CAAC;SACrB,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QACX,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAC5B,CAAC,IAA+B,EAAE,EAAE,CAAC,CAAC,OAAmB,EAAE,aAAuB,EAAE,EAAE;IACpF,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IACnG,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAEhD,qCAAqC;IACrC,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAK,EAAE,CAAC;IACrC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC7B,+EAA+E;IAC/E,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,cAAc,KAAK,MAAM,CAAC,eAAe,EAAE;QAChF,MAAM,YAAY,GAAG,cAAc,CAAC,QAAQ,EAAE,CAAC;QAC/C,MAAM,gBAAgB,GAAG,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAC9D,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;QAE7E,IAAI,SAAS,EAAE;YACb,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE;gBAC7B,QAAQ,EAAE,SAAS,CAAC,QAAQ;gBAC5B,QAAQ,EAAE,SAAS,CAAC,QAAQ;gBAC5B,MAAM,EAAE,SAAS,CAAC,MAAM;gBACxB,iBAAiB,EAAE,cAAc;gBACjC,kBAAkB,EAAE,OAAO,CAAC,QAAQ,EAAE;aACvC,CAAC,CAAC;SACJ;aAAM;YACL,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE;gBACvB,OAAO,EAAE,uJAAuJ,YAAY,KAAK,gBAAgB,IAAI;aACtM,CAAC,CAAC;SACJ;KACF;IAED,IAAI,cAAc,KAAK,MAAM,CAAC,gBAAgB,EAAE;QAC9C,YAAY,CAAC;YACX,OAAO,EAAE,4FAA4F,MAAM,CAAC,gBAAgB,EAAE;YAC9H,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;KACJ;SAAM,IAAI,cAAc,KAAK,MAAM,CAAC,eAAe,EAAE;QACpD,kGAAkG;QAClG,uCAAuC;QACvC,IAAI,aAAa;YACf,MAAM,IAAI,KAAK,CACb,8DAA8D,MAAM,CAAC,eAAe,8BAA8B,CACnH,CAAC;QACJ,sEAAsE;QACtE,MAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM;aACH,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC;aAC7B,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;aACzC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CACX,YAAY,CAAC;YACX,OAAO,EAAE,oCAAoC,MAAM,CAAC,eAAe,uBAAuB;YAC1F,OAAO,EAAE,CAAC;SACX,CAAC,CACH,CAAC;KACL;SAAM,IAAI,cAAc,CAAC,cAAc,CAAC,EAAE;QACzC,uDAAuD;QACvD,aAAa,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;KACxC;SAAM;QACL,kDAAkD;QAClD,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;KAClC;AACH,CAAC,CAAC"}
+{"version":3,"file":"start.js","sourceRoot":"","sources":["../../../../../modules/ocr/actions/start.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAIL,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EAGrB,MAAM,GACP,MAAM,0CAA0C,CAAC;AAGlD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAiB9D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAkB,EAAE,EAAE,CAAC,GAAS,EAAE;IAC9D,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IACnG,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAC9C,sEAAsE;IACtE,MAAM,WAAW,GAAG,IAAI,OAAO,EAAE,CAAC;IAClC,MAAM,YAAY,GAAiB,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5G,gEAAgE;IAChE,uIAAuI;IACvI,MAAM,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAClD,MAAM,CAAC,OAAO,CAAC,EACf,SAAS,CAAC,WAAW,CAAC,EACtB,SAAS,CAAC,mBAAmB,CAAC,CAC/B,CAAC;IACF,uEAAuE;IACvE,MAAM,uBAAuB,GAAG,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;IACvG,MAAM,uBAAuB,mCAAmC,IAAI,KAAE,YAAY,GAAE,CAAC;IACrF,uBAAuB;IACvB,MAAM,UAAU,GAAG,GAAG,EAAE;QACtB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvB,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACpB,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC,CAAC;IACF,MAAM,UAAU,GAAG;QACjB,IAAI,EAAE,CAAC,SAAiB,EAAE,EAAE;YAC1B,4EAA4E;YAC5E,aAAa,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC;QACpD,CAAC;QACD,QAAQ,EAAE,GAAG,EAAE;YACb,oEAAoE;YACpE,WAAW,CAAC,uBAAuB,CAAC,CAAC;YACrC,UAAU,EAAE,CAAC;QACf,CAAC;QACD,KAAK,EAAE,CAAC,CAAwC,EAAE,EAAE;YAClD,uEAAuE;YACvE,2DAA2D;YAC3D,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,WAAW,CAAC,iCAAiC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YAClG,UAAU,EAAE,CAAC;QACf,CAAC;KACF,CAAC;IAEF,kEAAkE;IAClE,6CAA6C;IAC7C,MAAM,kBAAkB,CAAC,uBAAuB,CAAC,CAAC;IAElD,yCAAyC;IACzC,aAAa;IACb,oBAAoB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAC3C,sBAAsB;IACtB,uBAAuB,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACnD,gGAAgG;IAChG,OAAO;QACL,YAAY,EAAE,GAAG,EAAE,CACjB,YAAY,CAAC;YACX,OAAO,EAAE,iCAAiC;YAC1C,OAAO,EAAE;gBACP,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;gBACnC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;gBAC/B,YAAY,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;aAC5C;SACF,CAAC;KACL,CAAC;AACJ,CAAC,CAAA,CAAC;AACF,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAC1E,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAW,EAAE,EAAE;;IAC5C,iEAAiE;IACjE,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,UAAU,GAAG,IAAI,EAAE,GAAG,MAAA,CAAC,CAAC,QAAQ,mCAAI,EAAE,CAAC;IAC9D,IAAI,CAAC,CAAA,MAAA,CAAC,CAAC,SAAS,0CAAE,MAAM,CAAA;QAAE,OAAO,KAAK,CAAC;IACvC,IAAI,MAAM,KAAK,KAAK;QAAE,OAAO,KAAK,CAAC;IACnC,IAAI,UAAU,KAAK,KAAK,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC1D,iEAAiE;IACjE,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAO,IAA+B,EAAE,EAAE;IAC1E;;;;;;;;OAQG;IACH,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IACnG,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAEpD,UAAU;IACV,MAAM,gBAAgB,GAAG,CAAC,MAAe,EAAoC,EAAE,CAAC,MAAM,KAAK,MAAM,CAAC,eAAe,CAAC;IAClH,MAAM,sBAAsB,GAAG,CAAC,MAAe,EAAkD,EAAE,CACjG,qBAAqB,CAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAE5D,MAAM,cAAc,GAAG,CAAC,MAA4C,EAAE,QAAkB,EAAE,WAAoB,EAAE,EAAE;QAChH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACzB,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC7B,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC,CAAC;IACF,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;IAEvF,wCAAwC;IACxC,MAAM,CAAC,sBAAsB,CAAC,GAAG,YAAY;SAC1C,QAAQ,EAAE;SACV,MAAM,CAAC,cAAc,CAAC;SACtB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;SAC/E,OAAO,EAAE,CAAC;IAEb,kCAAkC;IAClC,IAAI,CAAC,sBAAsB;QAAE,YAAY,EAAE,CAAC;SACvC,IAAI,cAAc,CAAC,sBAAsB,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;QAChE,oEAAoE;QACpE,cAAc,CAAC,MAAM,CAAC,aAAa,EAAE,sBAAsB,EAAE,IAAI,CAAC,CAAC;KACpE;SAAM,IAAI,gBAAgB,CAAC,sBAAsB,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;QACpE,iGAAiG;QACjG,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;QAC9F,sEAAsE;QACtE,IAAI,qBAAqB,CAAC,cAAc,CAAC,IAAI,gBAAgB,CAAC,cAAc,CAAC;YAC3E,cAAc,CAAC,cAAc,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;QACpD,yDAAyD;aACpD,IAAI,cAAc,KAAK,MAAM,CAAC,gBAAgB;YACjD,YAAY,CAAC;gBACX,OAAO,EAAE,4FAA4F,MAAM,CAAC,gBAAgB,EAAE;gBAC9H,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,sDAAsD;;YACjD,YAAY,EAAE,CAAC;KACrB;SAAM,IAAI,sBAAsB,CAAC,sBAAsB,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;QAC1E,4CAA4C;QAC5C,MAAM,YAAY,GAAG,sBAAsB,CAAC,SAAS,CAAC,MAAM,CAAC;QAC7D,qDAAqD;QACrD,cAAc,CAAC,YAAY,EAAE,sBAAsB,EAAE,IAAI,CAAC,CAAC;QAC3D,qDAAqD;KACtD;;QAAM,YAAY,EAAE,CAAC;AACxB,CAAC,CAAA,CAAC;AACF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAA+B,EAAE,EAAE;IAC7D,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IAEjD,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;IACtC,UAAU,CAAC,cAAc,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAEzD,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AACzC,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAE,IAA+B,EAAE,EAAE;IAC/E,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IACrD,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;IACtC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;IACpE,MAAM,IAAI,GAAG;QACX,YAAY,EAAE,MAAM;QACpB,IAAI,EAAE,cAAc,CAAC,QAAQ,EAAE;KACvB,CAAC;IACX,MAAM,OAAO,GAAG,uFAAuF,CAAC;IACxG,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACxC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/E,CAAC,CAAC;AACF,MAAM,OAAO,GAAG,CAA+C,IAAU,EAAE,YAAoB,EAAQ,EAAE;IACvG,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,OAAO,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE;QAClB,IAAI,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QAC7B,SAAS,GAAG,IAAI,CAAC;QACjB,OAAO,MAAM,CAAC;IAChB,CAAC,CAAS,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAA+B,EAAE,EAAE,CAAC,CAAC,IAAU,EAAE,EAAE;IAC/E,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC3C,IAAI,CAAC,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;IAC9G,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC7G,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;IAChC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC5C,MAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,UAAU;QACvB,CAAC,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,UAAU,CAAC;QAClD,CAAC,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAE5C,MAAM,EAAE;SACL,IAAI,CAAC,eAAe,CAAC;SACrB,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QACX,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAC5B,CAAC,IAA+B,EAAE,EAAE,CAAC,CAAC,OAAmB,EAAE,aAAuB,EAAE,EAAE;IACpF,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IACnG,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAEhD,qCAAqC;IACrC,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAK,EAAE,CAAC;IACrC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC7B,+EAA+E;IAC/E,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,cAAc,KAAK,MAAM,CAAC,eAAe,EAAE;QAChF,MAAM,YAAY,GAAG,cAAc,CAAC,QAAQ,EAAE,CAAC;QAC/C,MAAM,gBAAgB,GAAG,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAC9D,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;QAE7E,IAAI,SAAS,EAAE;YACb,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE;gBAC7B,QAAQ,EAAE,SAAS,CAAC,QAAQ;gBAC5B,QAAQ,EAAE,SAAS,CAAC,QAAQ;gBAC5B,MAAM,EAAE,SAAS,CAAC,MAAM;gBACxB,iBAAiB,EAAE,cAAc;gBACjC,kBAAkB,EAAE,OAAO,CAAC,QAAQ,EAAE;aACvC,CAAC,CAAC;SACJ;aAAM;YACL,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE;gBACvB,OAAO,EAAE,uJAAuJ,YAAY,KAAK,gBAAgB,IAAI;aACtM,CAAC,CAAC;SACJ;KACF;IAED,IAAI,cAAc,KAAK,MAAM,CAAC,gBAAgB,EAAE;QAC9C,YAAY,CAAC;YACX,OAAO,EAAE,4FAA4F,MAAM,CAAC,gBAAgB,EAAE;YAC9H,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;KACJ;SAAM,IAAI,cAAc,KAAK,MAAM,CAAC,eAAe,EAAE;QACpD,kGAAkG;QAClG,uCAAuC;QACvC,IAAI,aAAa;YACf,MAAM,IAAI,KAAK,CACb,8DAA8D,MAAM,CAAC,eAAe,8BAA8B,CACnH,CAAC;QACJ,sEAAsE;QACtE,MAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM;aACH,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC;aAC7B,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;aACzC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CACX,YAAY,CAAC;YACX,OAAO,EAAE,oCAAoC,MAAM,CAAC,eAAe,uBAAuB;YAC1F,OAAO,EAAE,CAAC;SACX,CAAC,CACH,CAAC;KACL;SAAM,IAAI,cAAc,CAAC,cAAc,CAAC,EAAE;QACzC,uDAAuD;QACvD,aAAa,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;KACxC;SAAM;QACL,kDAAkD;QAClD,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;KAClC;AACH,CAAC,CAAC"}

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

@@ -4,7 +4,7 @@ import { mkStartMethod } from "./actions/start";
 export { Status };
 export const ocrModule = {
     initialise(options) {
-        const { frankieClient, oneSdkInstance } = options;
+        const { frankieClient, oneSdkInstance, globalEventHub } = options;
         const client = new OCRClient(frankieClient);
         const eventHub = mkEventHub();
         const { _expectedSide$, document$, failedStatus$, files$, isPreloaded$, status$ } = initialiseLocalState(new ReactiveStore({
@@ -29,7 +29,18 @@ export const ocrModule = {
             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) });
     },
 };

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,GAAG,OAAO,CAAC;QAClD,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;SACd,CAAC,CAAC;QACH,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,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"}

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

@@ -9,21 +9,52 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { individualModule } from "../individual";
 import { mkEventListener } from "../common";
-import { mkComponentLoader } from "./ComponentLoader";
-import { parseConfiguration } from "./parseConfiguration";
+import { mkComponentLoader } from "./initialisation/componentLoader";
+import { parseConfiguration } from "./initialisation/configurationParser";
+import { mkSharedDependencies } from "./initialisation/sharedDependencies";
 export const oneSdk = {
     initialise: function (oneSdkOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            const sharedState = yield parseConfiguration(oneSdkOptions);
-            const { globalEventHub } = sharedState;
-            const sdk = Object.assign(Object.assign({}, mkEventListener(globalEventHub)), { individual: () => individual, component: null });
-            const baseModuleOptions = Object.assign(Object.assign({}, sharedState), { oneSdkInstance: sdk });
-            // Make individual module
-            const individual = individualModule.initialise(Object.assign(Object.assign({}, baseModuleOptions), { instanceName: "individual" }));
-            // Make component factory
-            sdk.component = mkComponentLoader(baseModuleOptions);
-            // resolve onesdk once
-            return new Promise((resolve) => individual.on("data_loaded", () => resolve(sdk)));
+            const sharedDependencies = yield mkSharedDependencies(oneSdkOptions);
+            const { globalEventHub } = sharedDependencies;
+            try {
+                const { sharedState, warnings } = yield parseConfiguration(oneSdkOptions, 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 });
+                // 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" }));
+                // Make the dynamic component loader, which initialises components dynamically
+                sdk.component = mkComponentLoader(baseModuleOptions);
+                // 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: sharedState.mode, recipe: sharedState.recipe, warnings },
+                });
+                warnings.forEach(({ level, data }) => globalEventHub.emit(level, data));
+                return sdk;
+            }
+            catch (error) {
+                // 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,
+                    },
+                    error,
+                });
+                throw 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,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAI1D,MAAM,CAAC,MAAM,MAAM,GAAiB;IAClC,UAAU,EAAE,UAAgB,aAAa;;YACvC,MAAM,WAAW,GAAG,MAAM,kBAAkB,CAAC,aAAa,CAAC,CAAC;YAC5D,MAAM,EAAE,cAAc,EAAE,GAAG,WAAW,CAAC;YAEvC,MAAM,GAAG,mCAEJ,eAAe,CAAC,cAAc,CAAC,KAClC,UAAU,EAAE,GAAG,EAAE,CAAC,UAAU,EAC5B,SAAS,EAAE,IAAI,GAChB,CAAC;YACF,MAAM,iBAAiB,mCAAqB,WAAW,KAAE,cAAc,EAAE,GAAG,GAAE,CAAC;YAC/E,yBAAyB;YACzB,MAAM,UAAU,GAAG,gBAAgB,CAAC,UAAU,iCACzC,iBAAiB,KACpB,YAAY,EAAE,YAAY,IAC1B,CAAC;YACH,yBAAyB;YACzB,GAAG,CAAC,SAAS,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;YAErD,sBAAsB;YACtB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACpF,CAAC;KAAA;CACF,CAAC"}
+{"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,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,kBAAkB,GAAG,MAAM,oBAAoB,CAAC,aAAa,CAAC,CAAC;YACrE,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"}

package/dist/{cjs/modules/sdk/ComponentLoader.d.ts → esm/modules/sdk/initialisation/componentLoader.d.ts}

@@ -1,4 +1,4 @@
-import { OneSdkContext, SharedState } from "./types";
+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;

package/dist/esm/modules/sdk/{ComponentLoader.js → initialisation/componentLoader.js}

@@ -1,4 +1,4 @@
-import { merge, PublicModules } from "../common";
+import { merge, PublicModules } from "../../common";
 /**
  * This factory will generate another function which will
  * 1) load a public module by module name, defined in the dictionary PublicModules;
@@ -22,19 +22,44 @@ export const mkComponentLoader = (sharedState) => {
         // 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();
         // if instance already exists, return it
         const instance = retrieveInstance(which, instanceName);
         if (instance)
             return instance;
         else {
-            // otherwise, resolve new configuration and initialise and return new instance
-            const mergedOptions = merge({}, sharedState, options, { instanceName });
+            // Otherwise,
+            // 1) resolve new configuration
+            const mergedOptions = merge({}, sharedState, options, { instanceName, componentName: which });
             sharedState.globalEventHub.emit("resolved_module_config", mergedOptions);
             const module = PublicModules[which];
-            const moduleContext = module.initialise(mergedOptions);
-            const instance = injectInstanceName(moduleContext, instanceName);
-            storeInstance(which, instanceName, instance);
-            return instance;
+            try {
+                // 2) Initialise module, resulting in the module context for that instance (aka a component)
+                const moduleContext = module.initialise(mergedOptions);
+                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
+                sharedState.globalEventHub.emit("telemetry", {
+                    eventName: `COMPONENT:INIT`,
+                    data: { component: which, options },
+                });
+                // Since all event listeners support the "error" event, listen for any "error" events and submit them to "telemetry"
+                instance.on("error", (errorEvent) => sharedState.globalEventHub.emit("telemetry", {
+                    eventName: `COMPONENT:ERROR`,
+                    data: { component: which },
+                    error: errorEvent,
+                }));
+                return instance;
+            }
+            catch (error) {
+                sharedState.globalEventHub.emit("telemetry", {
+                    eventName: `COMPONENT:INIT:ERROR`,
+                    data: { component: which, options },
+                    error,
+                });
+                throw error;
+            }
         }
     };
     // the "defineProperty" below exposes the instances object and allows for easier testing
@@ -64,4 +89,4 @@ function mkInstanceDictionary() {
     };
     return { storeInstance, retrieveInstance, instancesDictionary };
 }
-//# sourceMappingURL=ComponentLoader.js.map
+//# 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,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,EACrB,EAAE;QACnC,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,CAA2C,CAAC;QACjG,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,GAAG,kBAAkB,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;gBACjE,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,QAA2C,CAAC;aACpD;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,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,GAAG,QAAoD,CAAC,CAAC,2BAA2B;IACnI,CAAC,CAAC;IACF,MAAM,gBAAgB,GAAG,CACvB,UAAgB,EAChB,YAA0B,EAC1B,EAAE;;QACF,OAAO,MAAC,MAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAG,UAAU,CAAC,0CAAG,YAAY,CAAqC,mCAAI,IAAI,CAAC;IACxG,CAAC,CAAC;IAEF,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,CAAC;AAClE,CAAC"}

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

@@ -0,0 +1,27 @@
+import { OneSdkRootParameters, RecipeParsed, SdkModes, 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
+ * @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">;
+    warnings: Warning[];
+}>;
+export declare function resolveMode(oneSdkOptions: OneSdkRootParameters): {
+    modeName: SdkModes;
+    mode: OneSdkRootParameters["mode"];
+};
+export declare function resolveRecipeValue(recipe: OneSdkRootParameters["recipe"]): RecipeParsed;
+declare type Warning = {
+    level: "info" | "warning";
+    data: {
+        message: string;
+        payload?: unknown;
+    };
+} | {
+    level: "error";
+    data: Error;
+};
+export {};

package/dist/esm/modules/sdk/{parseConfiguration.js → initialisation/configurationParser.js}

@@ -18,22 +18,31 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-import { merge, mkEventHub } from "../common";
-import { mkFrankieClient } from "../frankie-client";
-import { ConfigurationClient } from "../frankie-client/clients/ConfigurationClient";
-import { SdkModes } from "./types";
-export function parseConfiguration(oneSdkOptions) {
-    var _a;
+import { merge, OneSDKError } from "../../common";
+import { ConfigurationClient } from "../../frankie-client/clients/ConfigurationClient";
+import { SdkModes } 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
+ * @returns { sharedState: Dictionary, warnings: { level: "info"|"warnings"|"error", message: string, payload: unknown }[] }
+ */
+export function parseConfiguration(oneSdkOptions, 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(oneSdkOptions.recipe);
-        const mode = (_a = oneSdkOptions.mode) !== null && _a !== void 0 ? _a : SdkModes.PROD;
-        const globalEventHub = mkEventHub();
-        const frankieClient = yield mkFrankieClient({ mode, session: oneSdkOptions.session, globalEventHub });
+        const { mode, modeName } = resolveMode(oneSdkOptions);
         // use frankie client to fetch existing recipe configuration from API
-        const fetchedRecipeConfiguration = yield fetchRecipeConfig({ frankieClient, globalEventHub, recipe });
+        const fetchedRecipeConfiguration = yield fetchRecipeConfig({ frankieClient, globalEventHub, recipe }, warnings);
         // And merge it with provided config
-        const mergedRecipeConfiguration = mergeRecipeConfigurations(recipe, fetchedRecipeConfiguration, globalEventHub);
-        const modeName = typeof mode === "string" ? mode : mode.modeName;
+        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 sharedState = {
             mode,
             session: resolveSessionObject({ mode: modeName, frankieClient }),
@@ -41,13 +50,27 @@ export function parseConfiguration(oneSdkOptions) {
             frankieClient,
             recipe: mergedRecipeConfiguration,
         };
-        return sharedState;
+        return { sharedState, warnings };
     });
 }
+export function resolveMode(oneSdkOptions) {
+    var _a;
+    const mode = (_a = oneSdkOptions.mode) !== null && _a !== void 0 ? _a : SdkModes.PROD;
+    const modeName = typeof mode === "string" ? mode : mode.modeName;
+    return { modeName, mode };
+}
+export function resolveRecipeValue(recipe) {
+    var _a;
+    if (!recipe)
+        return { name: "auto" };
+    if (typeof recipe === "string")
+        return { name: recipe };
+    return Object.assign(Object.assign({}, recipe), { name: (_a = recipe.name) !== null && _a !== void 0 ? _a : "auto" });
+}
 function resolveSessionObject(options) {
     return options.frankieClient.session;
 }
-function mergeRecipeConfigurations(provided, fetched, eventHub) {
+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'
@@ -58,35 +81,31 @@ function mergeRecipeConfigurations(provided, fetched, eventHub) {
         name: providedRecipeName === "auto" ? fetchedRecipeName : providedRecipeName,
     });
     if (providedRecipeName !== "auto" && fetchedRecipeName && providedRecipeName !== fetchedRecipeName) {
-        setTimeout(() => eventHub.emit("error", {
-            message: `Recipe name mismatch. Requested '${providedRecipeName}', found '${fetchedRecipeName}'. Configuration might be incorrect, so check this event's 'payload' for the resulting configuration object.`,
-            payload: mergedRecipeConfiguration,
-        }));
+        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;
 }
-export function resolveRecipeValue(recipe) {
-    var _a;
-    if (!recipe)
-        return { name: "auto" };
-    if (typeof recipe === "string")
-        return { name: recipe };
-    return Object.assign(Object.assign({}, recipe), { name: (_a = recipe.name) !== null && _a !== void 0 ? _a : "auto" });
-}
-function fetchRecipeConfig(options) {
+function fetchRecipeConfig(options, warnings) {
     return __awaiter(this, void 0, void 0, function* () {
-        options.globalEventHub.emit("info", {
-            message: "Fetching recipe configuration",
-            payload: { recipeName: options.recipe },
+        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((e) => {
-            options.globalEventHub.emit("error", {
-                message: "Failed fetching recipe configuration. Using provided configuration only.",
-                payload: e,
+        return config.load().catch((error) => {
+            warnings.push({
+                level: "error",
+                data: new OneSDKError("Failed fetching recipe configuration. Using provided configuration only.", error),
             });
             return {};
         });
     });
 }
-//# sourceMappingURL=parseConfiguration.js.map
+//# sourceMappingURL=configurationParser.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"configurationParser.js","sourceRoot":"","sources":["../../../../../modules/sdk/initialisation/configurationParser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,KAAK,EAAE,WAAW,EAAuB,MAAM,gBAAgB,CAAC;AAEzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oDAAoD,CAAC;AACzF,OAAO,EAAsC,QAAQ,EAAgD,MAAM,UAAU,CAAC;AAEtH;;;;;GAKG;AACH,MAAM,UAAgB,kBAAkB,CACtC,aAAmC,EACnC,kBAAsC;;QAEtC,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,GAAG,kBAAkB,CAAC;QAC7D,uEAAuE;QACvE,MAAM,QAAQ,GAAc,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAG,kBAAkB,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QACxD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;QACtD,qEAAqE;QACrE,MAAM,0BAA0B,GAAG,MAAM,iBAAiB,CAAC,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,EAAE,QAAQ,CAAC,CAAC;QAChH,oCAAoC;QACpC,MAAM,yBAAyB,GAAG,yBAAyB,CAAC,MAAM,EAAE,0BAA0B,EAAE,QAAQ,CAAC,CAAC;QAC1G,8HAA8H;QAC9H,0DAA0D;QAC1D,6HAA6H;QAC7H,4GAA4G;QAC5G,2IAA2I;QAC3I,MAAM,WAAW,GAAwC;YACvD,IAAI;YACJ,OAAO,EAAE,oBAAoB,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;YAChE,cAAc;YACd,aAAa;YACb,MAAM,EAAE,yBAAyB;SAClC,CAAC;QAEF,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;IACnC,CAAC;CAAA;AAED,MAAM,UAAU,WAAW,CAAC,aAAmC;;IAI7D,MAAM,IAAI,GAAG,MAAA,aAAa,CAAC,IAAI,mCAAI,QAAQ,CAAC,IAAI,CAAC;IACjD,MAAM,QAAQ,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;AAC5B,CAAC;AACD,MAAM,UAAU,kBAAkB,CAAC,MAAsC;;IACvE,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACrC,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACxD,uCACK,MAAM,KACT,IAAI,EAAE,MAAA,MAAM,CAAC,IAAI,mCAAI,MAAM,IAC3B;AACJ,CAAC;AACD,SAAS,oBAAoB,CAAC,OAA4D;IACxF,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC;AACvC,CAAC;AAED,SAAS,yBAAyB,CAChC,QAAsB,EACtB,OAA4B,EAC5B,QAAmB;IAEnB,oBAAoB;IACpB,kFAAkF;IAClF,iEAAiE;IACjE,MAAM,EAAE,IAAI,EAAE,kBAAkB,KAA8B,QAAQ,EAAjC,oBAAoB,UAAK,QAAQ,EAAhE,QAAqD,CAAW,CAAC;IACvE,MAAM,KAAsD,kBAAkB,CAAC,OAAO,CAAC,EAAjF,EAAE,IAAI,EAAE,iBAAiB,OAAwD,EAAnD,mBAAmB,cAAjD,QAAmD,CAA8B,CAAC;IACxF,mBAAmB;IACnB,MAAM,yBAAyB,GAAG,KAAK,CAAC,EAAE,EAAE,mBAAmB,EAAE,oBAAoB,EAAE;QACrF,IAAI,EAAE,kBAAkB,KAAK,MAAM,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,kBAAkB;KAC7E,CAAC,CAAC;IACH,IAAI,kBAAkB,KAAK,MAAM,IAAI,iBAAiB,IAAI,kBAAkB,KAAK,iBAAiB,EAAE;QAClG,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,IAAI,WAAW,CACnB,oCAAoC,kBAAkB,aAAa,iBAAiB,IAAI;gBACtF,wGAAwG,EAC1G,yBAAyB,CAC1B;SACF,CAAC,CAAC;KACJ;IACD,OAAO,yBAAyB,CAAC;AACnC,CAAC;AACD,SAAe,iBAAiB,CAC9B,OAAyE,EACzE,QAAmB;;QAEnB,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,MAAM;YACb,IAAI,EAAE;gBACJ,OAAO,EAAE,+BAA+B;gBACxC,OAAO,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE;aAC7C;SACF,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,mBAAmB,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/F,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACnC,QAAQ,CAAC,IAAI,CAAC;gBACZ,KAAK,EAAE,OAAO;gBACd,IAAI,EAAE,IAAI,WAAW,CAAC,0EAA0E,EAAE,KAAK,CAAC;aACzG,CAAC,CAAC;YACH,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC;CAAA"}

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

@@ -0,0 +1,5 @@
+import { EventHub } from "../../common";
+import { FrankieApiClient } from "../../frankie-client";
+import { GlobalEvents, OneSdkRootParameters, SharedDependencies } from "../types";
+export declare function mkSharedDependencies(oneSdkOptions: OneSdkRootParameters): Promise<SharedDependencies>;
+export declare function registerTelemetryEvents(globalEventHub: EventHub<GlobalEvents>, frankieClient: FrankieApiClient): void;