@frankieone/one-sdk 0.5.5-rc → 0.6.5-alpha

package/dist/esm/modules/frankie-client/clients/ApplicantClient.js

@@ -10,7 +10,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { Applicant } from "../../common/shared/models/Applicant";
 import { CheckSummary } from "../../common/shared/models/CheckSummary";
 import { Document } from "../../common/shared/models/Document";
-import { hasEntityId } from "../../common/types/Session";
 import { BaseClient } from "./BaseClient";
 /**
  * Applicant client handles BFF Applicant and Document Operations
@@ -23,7 +22,7 @@ export class ApplicantClient extends BaseClient {
              * A search made using entityId HAS to be successful, since the entity id already exists. If not found, throw exception
              * A search made using reference doesn't need to return results, as it might be a
              */
-            const { reference, entityId } = this.entityIdentifier;
+            const { reference, entityId } = this;
             const data = yield this.frankie
                 .get("/data/v2/applicant/", {
                 params: {
@@ -59,11 +58,10 @@ export class ApplicantClient extends BaseClient {
     updateApplicant(payload) {
         return __awaiter(this, void 0, void 0, function* () {
             const { applicant, documents } = payload;
-            if (!hasEntityId(this.entityIdentifier))
+            if (!this.entityId)
                 throw new Error("Entity id not found in local state. Has entity been created yet?");
-            const { entityId } = this.entityIdentifier;
             return this.frankie
-                .put(`/data/v2/applicants/${entityId}`, {
+                .put(`/data/v2/applicants/${this.entityId}`, {
                 applicant,
                 documents,
                 kycMethod: "electronic",
@@ -73,10 +71,9 @@ export class ApplicantClient extends BaseClient {
     }
     getLatestCheckResults() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!hasEntityId(this.entityIdentifier))
+            if (!this.entityId)
                 throw new Error("Entity id not found in local state. Has entity been created yet?");
-            const { entityId } = this.entityIdentifier;
-            return yield this.frankie.get(`/data/v2/applicants/${entityId}`).then((r) => {
+            return yield this.frankie.get(`/data/v2/applicants/${this.entityId}`).then((r) => {
                 const { checkSummary } = r.data;
                 return CheckSummary.fromJSON(checkSummary);
             });
@@ -84,10 +81,9 @@ export class ApplicantClient extends BaseClient {
     }
     triggerChecks() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!hasEntityId(this.entityIdentifier))
+            if (!this.entityId)
                 throw new Error("Entity id not found in local state. Has entity been created yet?");
-            const { entityId } = this.entityIdentifier;
-            yield this.frankie.post(`/data/v1/applicants/${entityId}/checks`);
+            yield this.frankie.post(`/data/v1/applicants/${this.entityId}/checks`);
             return this.getLatestCheckResults();
         });
     }

package/dist/esm/modules/frankie-client/clients/ApplicantClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"ApplicantClient.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/ApplicantClient.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,SAAS,EAAqB,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,YAAY,EAAE,MAAM,2CAA2C,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAoB,MAAM,uCAAuC,CAAC;AACnF,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;GAGG;AACH,MAAM,OAAO,eAAgB,SAAQ,UAAU;IACvC,IAAI;;YACR;;;eAGG;YACH,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,gBAA2C,CAAC;YACjF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO;iBAC5B,GAAG,CAAgB,qBAAqB,EAAE;gBACzC,MAAM,EAAE;oBACN,SAAS;oBACT,QAAQ;iBACT;aACF,CAAC;iBACD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAC3B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;gBACxC,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;iBACD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IACK,eAAe,CAAC,OAAuB;;YAC3C,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;YACzC,OAAO,IAAI,CAAC,OAAO;iBAChB,IAAI,CAAkB,qBAAqB,EAAE;gBAC5C,SAAS;gBACT,SAAS;gBACT,SAAS,EAAE,YAAY;aACxB,CAAC;iBACD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;gBACV,sDAAsD;gBACtD,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAChC,OAAO,CAAC,CAAC,IAAI,CAAC;YAChB,CAAC,CAAC,CAAC;QACP,CAAC;KAAA;IACK,eAAe,CAAC,OAAuB;;YAC3C,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;YACzC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,gBAAgB,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;YACtF,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC;YAE3C,OAAO,IAAI,CAAC,OAAO;iBAChB,GAAG,CAAkB,uBAAuB,QAAQ,EAAE,EAAE;gBACvD,SAAS;gBACT,SAAS;gBACT,SAAS,EAAE,YAAY;aACxB,CAAC;iBACD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;KAAA;IACK,qBAAqB;;YACzB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,gBAAgB,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;YACtF,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC;YAC3C,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAoB,uBAAuB,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;gBAC7F,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC;gBAChC,OAAO,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;IACK,aAAa;;YACjB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,gBAAgB,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;YACtF,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC;YAC3C,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,QAAQ,SAAS,CAAC,CAAC;YAClE,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACtC,CAAC;KAAA;CACF;AACD,SAAS,4BAA4B,CAAC,IAAmB;;IACvD,OAAO;QACL,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;QAC7C,SAAS,EAAE,MAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,mCAAI,EAAE;KACxD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"ApplicantClient.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/ApplicantClient.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,SAAS,EAAqB,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,YAAY,EAAE,MAAM,2CAA2C,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAoB,MAAM,uCAAuC,CAAC;AACnF,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;GAGG;AACH,MAAM,OAAO,eAAgB,SAAQ,UAAU;IACvC,IAAI;;YACR;;;eAGG;YACH,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;YACrC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO;iBAC5B,GAAG,CAAgB,qBAAqB,EAAE;gBACzC,MAAM,EAAE;oBACN,SAAS;oBACT,QAAQ;iBACT;aACF,CAAC;iBACD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAC3B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;gBACxC,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;iBACD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IACK,eAAe,CAAC,OAAuB;;YAC3C,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;YACzC,OAAO,IAAI,CAAC,OAAO;iBAChB,IAAI,CAAkB,qBAAqB,EAAE;gBAC5C,SAAS;gBACT,SAAS;gBACT,SAAS,EAAE,YAAY;aACxB,CAAC;iBACD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;gBACV,sDAAsD;gBACtD,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAChC,OAAO,CAAC,CAAC,IAAI,CAAC;YAChB,CAAC,CAAC,CAAC;QACP,CAAC;KAAA;IACK,eAAe,CAAC,OAAuB;;YAC3C,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;YACzC,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;YAExG,OAAO,IAAI,CAAC,OAAO;iBAChB,GAAG,CAAkB,uBAAuB,IAAI,CAAC,QAAQ,EAAE,EAAE;gBAC5D,SAAS;gBACT,SAAS;gBACT,SAAS,EAAE,YAAY;aACxB,CAAC;iBACD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;KAAA;IACK,qBAAqB;;YACzB,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;YAExG,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAoB,uBAAuB,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;gBAClG,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC;gBAChC,OAAO,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;IACK,aAAa;;YACjB,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;YACxG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,IAAI,CAAC,QAAQ,SAAS,CAAC,CAAC;YACvE,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACtC,CAAC;KAAA;CACF;AACD,SAAS,4BAA4B,CAAC,IAAmB;;IACvD,OAAO;QACL,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;QAC7C,SAAS,EAAE,MAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,mCAAI,EAAE;KACxD,CAAC;AACJ,CAAC"}

package/dist/esm/modules/frankie-client/clients/BaseClient.d.ts

@@ -1,10 +1,8 @@
-import { ApplicantId } from "../../common/types/Session";
-import { ReadonlyDeep } from "type-fest";
 import { FrankieApiClient } from "../FrankieApiClient";
 export declare class BaseClient {
     protected frankie: FrankieApiClient;
     constructor(frankie: FrankieApiClient);
-    get entityIdentifier(): ReadonlyDeep<ApplicantId>;
+    get reference(): string | null;
     get entityId(): string | null;
     set entityId(v: string | null);
 }

package/dist/esm/modules/frankie-client/clients/BaseClient.js

@@ -2,12 +2,13 @@ export class BaseClient {
     constructor(frankie) {
         this.frankie = frankie;
     }
-    get entityIdentifier() {
-        return Object.freeze(Object.assign({}, this.frankie.session));
+    get reference() {
+        var _a;
+        return (_a = this.frankie.session.reference) !== null && _a !== void 0 ? _a : null;
     }
     get entityId() {
         var _a;
-        return (_a = this.entityIdentifier.entityId) !== null && _a !== void 0 ? _a : null;
+        return (_a = this.frankie.session.entityId) !== null && _a !== void 0 ? _a : null;
     }
     set entityId(v) {
         this.frankie.entityId = v;

package/dist/esm/modules/frankie-client/clients/BaseClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseClient.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/BaseClient.ts"],"names":[],"mappings":"AAIA,MAAM,OAAO,UAAU;IACrB,YAAsB,OAAyB;QAAzB,YAAO,GAAP,OAAO,CAAkB;IAAG,CAAC;IAEnD,IAAI,gBAAgB;QAClB,OAAO,MAAM,CAAC,MAAM,mBAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAG,CAAC;IACpD,CAAC;IACD,IAAI,QAAQ;;QACV,OAAO,MAAC,IAAI,CAAC,gBAAiC,CAAC,QAAQ,mCAAI,IAAI,CAAC;IAClE,CAAC;IACD,IAAI,QAAQ,CAAC,CAAgB;QAC3B,IAAI,CAAC,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC5B,CAAC;CACF"}
+{"version":3,"file":"BaseClient.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/BaseClient.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,UAAU;IACrB,YAAsB,OAAyB;QAAzB,YAAO,GAAP,OAAO,CAAkB;IAAG,CAAC;IAEnD,IAAI,SAAS;;QACX,OAAO,MAAA,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,mCAAI,IAAI,CAAC;IAChD,CAAC;IACD,IAAI,QAAQ;;QACV,OAAO,MAAA,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,mCAAI,IAAI,CAAC;IAC/C,CAAC;IACD,IAAI,QAAQ,CAAC,CAAgB;QAC3B,IAAI,CAAC,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC5B,CAAC;CACF"}

package/dist/esm/modules/frankie-client/clients/FederationClient.d.ts

@@ -0,0 +1,11 @@
+import { Vendor } from "../../federation/constants";
+import { BaseClient } from "./BaseClient";
+export declare class FederationClient extends BaseClient {
+    provideAuthorisation(provider: Vendor, authCode: string): Promise<AuthorisationPayload>;
+    submitCachedData(): Promise<unknown>;
+}
+declare type AuthorisationPayload = {
+    individual: object;
+    status: string;
+};
+export {};

package/dist/esm/modules/frankie-client/clients/FederationClient.js

@@ -0,0 +1,24 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { BaseClient } from "./BaseClient";
+export class FederationClient extends BaseClient {
+    provideAuthorisation(provider, authCode) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // TODO: This whole method
+            return yield this.frankie
+                .get(`/federation/v1/callback/${provider}?authCode=${authCode}`)
+                .then((d) => d.data);
+        });
+    }
+    submitCachedData() {
+        return this.frankie.post("/federation/v1/singpass/entity").then((d) => d.data);
+    }
+}
+//# sourceMappingURL=FederationClient.js.map

package/dist/esm/modules/frankie-client/clients/FederationClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FederationClient.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/FederationClient.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,gBAAiB,SAAQ,UAAU;IACxC,oBAAoB,CAAC,QAAgB,EAAE,QAAgB;;YAC3D,0BAA0B;YAC1B,OAAO,MAAM,IAAI,CAAC,OAAO;iBACtB,GAAG,CAAuB,2BAA2B,QAAQ,aAAa,QAAQ,EAAE,CAAC;iBACrF,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;KAAA;IACD,gBAAgB;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjF,CAAC;CACF"}

package/dist/esm/modules/frankie-client/clients/StorageClient.d.ts

@@ -0,0 +1,10 @@
+/**
+ * May be used to abstract quick storage. May be implemented as a wrapper for LocalStorage
+ * OR as a wrapper for a backend API which stores temporary data in redis
+ */
+import { BaseClient } from "./BaseClient";
+export declare class StorageClient extends BaseClient {
+    store(key: string, value: unknown): void;
+    retrieve<Type>(key: string): Type;
+    retrieveAndDelete<Type>(key: string): Type;
+}

package/dist/esm/modules/frankie-client/clients/StorageClient.js

@@ -0,0 +1,23 @@
+/**
+ * May be used to abstract quick storage. May be implemented as a wrapper for LocalStorage
+ * OR as a wrapper for a backend API which stores temporary data in redis
+ */
+import { BaseClient } from "./BaseClient";
+export class StorageClient extends BaseClient {
+    store(key, value) {
+        window.localStorage.setItem(key, JSON.stringify(value));
+    }
+    retrieve(key) {
+        // May fail parsing and throw exception
+        const value = window.localStorage.getItem(key);
+        if (!value)
+            return null;
+        return JSON.parse(value);
+    }
+    retrieveAndDelete(key) {
+        const value = this.retrieve(key);
+        window.localStorage.removeItem(key);
+        return value;
+    }
+}
+//# sourceMappingURL=StorageClient.js.map

package/dist/esm/modules/frankie-client/clients/StorageClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageClient.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/StorageClient.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,aAAc,SAAQ,UAAU;IAC3C,KAAK,CAAC,GAAW,EAAE,KAAc;QAC/B,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED,QAAQ,CAAO,GAAW;QACxB,uCAAuC;QACvC,MAAM,KAAK,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED,iBAAiB,CAAO,GAAW;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAO,GAAG,CAAC,CAAC;QACvC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/dist/esm/modules/frankie-client/index.d.ts

@@ -1,9 +1,15 @@
 import { EventHub } from "../common";
 import { GlobalEvents, OneSdkRootParameters } from "../sdk/types";
+import { SessionContext } from "../session/SessionContext";
 import { DummyFrankieApiClient } from "./DummyFrankieApiClient";
 import { FrankieApiClient } from "./FrankieApiClient";
-declare type Options = Pick<OneSdkRootParameters, "mode" | "session"> & {
+declare type Mode = OneSdkRootParameters["mode"];
+declare type Options<Validate extends boolean = true> = {
     globalEventHub: EventHub<GlobalEvents>;
+    mode: Mode;
+    session: SessionContext;
+    validateToken?: Validate;
 };
-export declare function mkFrankieClient(options: Options): Promise<FrankieApiClient>;
+export declare function mkFrankieClient(options: Options<false>): FrankieApiClient;
+export declare function mkFrankieClient(options: Options<true>): Promise<FrankieApiClient>;
 export { FrankieApiClient, DummyFrankieApiClient };

package/dist/esm/modules/frankie-client/index.js

@@ -1,13 +1,5 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { SdkModes } from "../sdk/types";
+import { resolveMode } from "../sdk/initialisation/configurationParser";
 import { Status } from "./clients/OCRClient";
 import { DummyFrankieApiClient } from "./DummyFrankieApiClient";
 import { FrankieApiClient } from "./FrankieApiClient";
@@ -22,30 +14,29 @@ const defaultMockOptions = {
         statusResults: [Status.WAITING_BACK, Status.DOCUMENTS_INVALID, Status.COMPLETE],
     },
 };
-const isDummy = (mode) => (typeof mode === "string" ? mode : mode.modeName);
 export function mkFrankieClient(options) {
-    var _a;
-    return __awaiter(this, void 0, void 0, function* () {
-        if (isDummy(options.mode) === SdkModes.DUMMY) {
-            // initialise dummy client with optional token
-            const dummyClient = new DummyFrankieApiClient(Object.assign(Object.assign({}, options), { defaultDelay: 200 }));
-            if ((_a = options.session) === null || _a === void 0 ? void 0 : _a.token)
-                dummyClient.setToken(options.session.token);
-            // resolve mock options either from mode: { options } or if mode: "dummy", then use default mock options
-            const simplifiedMockOptions = typeof options.mode === "string" ? defaultMockOptions : options.mode.mocks;
-            const mockOptions = resolveSimplifiedMockOptions(simplifiedMockOptions);
-            console.debug("Resolved mock options", {
-                mockOptions,
-                resultingMockedRequests: mockOptions,
-            });
-            // inject mocked flow to dummy client
-            return mockFlow(dummyClient, mockOptions);
-        }
-        // if not in dummy mode, simply initialise the regular api client with the provided token
-        const client = new FrankieApiClient();
-        yield client.setToken(options.session.token, { checkValidity: true });
-        return client;
-    });
+    if (resolveMode(options).modeName === SdkModes.DUMMY) {
+        // initialise dummy client with optional token
+        const dummyClient = new DummyFrankieApiClient(Object.assign(Object.assign({}, options), { defaultDelay: 200 }));
+        dummyClient.session = options.session;
+        // resolve mock options either from mode: { options } or if mode: "dummy", then use default mock options
+        const simplifiedMockOptions = typeof options.mode === "string" ? defaultMockOptions : options.mode.mocks;
+        const mockOptions = resolveSimplifiedMockOptions(simplifiedMockOptions);
+        console.debug("Resolved mock options", {
+            mockOptions,
+            resultingMockedRequests: mockOptions,
+        });
+        // inject mocked flow to dummy client
+        return mockFlow(dummyClient, mockOptions);
+    }
+    // if not in dummy mode, simply initialise the regular api client with the provided token
+    const client = new FrankieApiClient();
+    client.session = options.session;
+    // This function is only synchronous if options.validateToken is explicitly false
+    const { validateToken = true } = options;
+    if (validateToken)
+        return client.validateSession().then(() => client);
+    return client;
 }
 export { FrankieApiClient, DummyFrankieApiClient };
 //# sourceMappingURL=index.js.map

package/dist/esm/modules/frankie-client/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/frankie-client/index.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAsC,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAe,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,4BAA4B,EAAyB,MAAM,oBAAoB,CAAC;AAEzF,MAAM,kBAAkB,GAA0B;IAChD,mBAAmB,EAAE;QACnB,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;KAChD;IACD,OAAO,EAAE;QACP,YAAY,EAAE,iBAAiB;QAC/B,aAAa,EAAE,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC,QAAQ,CAAC;KAChF;CACF,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,IAAU,EAAE,EAAE,CAAC,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAGlF,MAAM,UAAgB,eAAe,CAAC,OAAgB;;;QACpD,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,KAAK,EAAE;YAC5C,8CAA8C;YAC9C,MAAM,WAAW,GAAG,IAAI,qBAAqB,iCAAM,OAAO,KAAE,YAAY,EAAE,GAAG,IAAG,CAAC;YACjF,IAAI,MAAA,OAAO,CAAC,OAAO,0CAAE,KAAK;gBAAE,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACxE,wGAAwG;YACxG,MAAM,qBAAqB,GACzB,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;YAC7E,MAAM,WAAW,GAAgB,4BAA4B,CAAC,qBAAqB,CAAC,CAAC;YACrF,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE;gBACrC,WAAW;gBACX,uBAAuB,EAAE,WAAW;aACrC,CAAC,CAAC;YACH,qCAAqC;YACrC,OAAO,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;SAC3C;QACD,yFAAyF;QACzF,MAAM,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACtC,MAAM,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,OAAO,MAAM,CAAC;;CACf;AACD,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/frankie-client/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAsC,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAC;AAExE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAe,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,4BAA4B,EAAyB,MAAM,oBAAoB,CAAC;AAEzF,MAAM,kBAAkB,GAA0B;IAChD,mBAAmB,EAAE;QACnB,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;KAChD;IACD,OAAO,EAAE;QACP,YAAY,EAAE,iBAAiB;QAC/B,aAAa,EAAE,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC,QAAQ,CAAC;KAChF;CACF,CAAC;AAWF,MAAM,UAAU,eAAe,CAAC,OAAyB;IACvD,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,KAAK,EAAE;QACpD,8CAA8C;QAC9C,MAAM,WAAW,GAAG,IAAI,qBAAqB,iCAAM,OAAO,KAAE,YAAY,EAAE,GAAG,IAAG,CAAC;QACjF,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QACtC,wGAAwG;QACxG,MAAM,qBAAqB,GACzB,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;QAC7E,MAAM,WAAW,GAAgB,4BAA4B,CAAC,qBAAqB,CAAC,CAAC;QACrF,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE;YACrC,WAAW;YACX,uBAAuB,EAAE,WAAW;SACrC,CAAC,CAAC;QACH,qCAAqC;QACrC,OAAO,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;KAC3C;IACD,yFAAyF;IACzF,MAAM,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;IACtC,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAEjC,iFAAiF;IACjF,MAAM,EAAE,aAAa,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IACzC,IAAI,aAAa;QAAE,OAAO,MAAM,CAAC,eAAe,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;IACtE,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/esm/modules/frankie-client/mocks/federation/index.d.ts

@@ -0,0 +1,4 @@
+import { DummyFrankieApiClient } from "../../../frankie-client";
+export declare function skipFederationLogin(client: DummyFrankieApiClient): void;
+export declare function successfulDataFetching(client: DummyFrankieApiClient): void;
+export declare function successfulConfirmation(client: DummyFrankieApiClient): void;

package/dist/esm/modules/frankie-client/mocks/federation/index.js

@@ -0,0 +1,32 @@
+import { singpassURLs } from "../../../federation/vendors/Singpass";
+import { v4 as uuid } from "uuid";
+import { QUERY_PARAM, URL_PARAM } from "../../DummyFrankieApiClient";
+export function skipFederationLogin(client) {
+    client.stubResponse({ url: /.+/, method: "redirect" }, (url) => {
+        const authCode = uuid();
+        if (Object.values(singpassURLs).some((u) => u.includes(url.hostname))) {
+            const newUrl = new URL(window.location.href);
+            newUrl.searchParams.append("code", authCode);
+            newUrl.searchParams.append("state", url.searchParams.get("state"));
+            return newUrl;
+        }
+        return null;
+    });
+}
+export function successfulDataFetching(client) {
+    client.stubResponse({ url: new RegExp(`/federation/v1/callback/${URL_PARAM}\\?authCode=${QUERY_PARAM}`), method: "get" }, (data) => ({
+        title: `Get data from '${data.urlMatch[1]}'`,
+        status: 200,
+        data: {
+            individual: { name: { givenName: "Dummy name", familyName: "Family" }, addresses: [], documents: {} },
+            status: "STATUS_OK",
+        },
+    }));
+}
+export function successfulConfirmation(client) {
+    client.stubResponse({ url: "/federation/v1/singpass/entity", method: "post" }, {
+        title: "Confirming federation data",
+        status: 201,
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/esm/modules/frankie-client/mocks/federation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../modules/frankie-client/mocks/federation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AAEnE,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAErE,MAAM,UAAU,mBAAmB,CAAC,MAA6B;IAC/D,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE;QAC7D,MAAM,QAAQ,GAAG,IAAI,EAAE,CAAC;QAExB,IAAI,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE;YACrE,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC7C,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAC7C,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;YACnE,OAAO,MAAM,CAAC;SACf;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,MAA6B;IAClE,MAAM,CAAC,YAAY,CACjB,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,2BAA2B,SAAS,eAAe,WAAW,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EACpG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACT,KAAK,EAAE,kBAAkB,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG;QAC5C,MAAM,EAAE,GAAG;QACX,IAAI,EAAE;YACJ,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;YACrG,MAAM,EAAE,WAAW;SACpB;KACF,CAAC,CACH,CAAC;AACJ,CAAC;AACD,MAAM,UAAU,sBAAsB,CAAC,MAA6B;IAClE,MAAM,CAAC,YAAY,CACjB,EAAE,GAAG,EAAE,gCAAgC,EAAE,MAAM,EAAE,MAAM,EAAE,EACzD;QACE,KAAK,EAAE,4BAA4B;QACnC,MAAM,EAAE,GAAG;KACZ,CACF,CAAC;AACJ,CAAC"}

package/dist/esm/modules/frankie-client/mocks/index.js

@@ -1,4 +1,5 @@
 import { generateIDVToken, initIDVProcess, initSynchronousIDVProcess } from "./biometrics/idvSubmission";
+import { skipFederationLogin, successfulConfirmation, successfulDataFetching } from "./federation";
 import { applicantNotFound, loadExistingApplicant, loadSuccessfulCheckResults, } from "./individual/loadIndividual";
 import { submitSuccessfulData, successfulVerification } from "./individual/submitData";
 import { loadConfiguration } from "./initialisation/loadConfiguration";
@@ -21,6 +22,9 @@ export function mockFlow(client, options) {
     generateIDVToken(client);
     initIDVProcess(client);
     initSynchronousIDVProcess(client);
+    skipFederationLogin(client);
+    successfulDataFetching(client);
+    successfulConfirmation(client);
     return client;
 }
 const hasPreloadedIndividual = (options) => {

package/dist/esm/modules/frankie-client/mocks/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/mocks/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACzG,OAAO,EACL,iBAAiB,EACjB,qBAAqB,EACrB,0BAA0B,GAE3B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAA6B,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,UAAU,QAAQ,CAAC,MAA6B,EAAE,OAAoB;IAC1E,aAAa,CAAC,MAAM,CAAC,CAAC;IACtB,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC1B,aAAa,CAAC,MAAM,CAAC,CAAC;IAEtB,IAAI,sBAAsB,CAAC,OAAO,CAAC;QAAE,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;;QACvE,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAE/B,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAC7B,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACnC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAE/B,IAAI,aAAa,CAAC,OAAO,CAAC;QAAE,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvD,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACzB,cAAc,CAAC,MAAM,CAAC,CAAC;IACvB,yBAAyB,CAAC,MAAM,CAAC,CAAC;IAElC,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,sBAAsB,GAAG,CAC7B,OAAoB,EAC4D,EAAE;IAClF,OAAO,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAC9C,CAAC,CAAC;AACF,MAAM,aAAa,GAAG,CACpB,OAAoB,EAC2D,EAAE;IACjF,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;AACtC,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/mocks/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACzG,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACnG,OAAO,EACL,iBAAiB,EACjB,qBAAqB,EACrB,0BAA0B,GAE3B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAA6B,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,UAAU,QAAQ,CAAC,MAA6B,EAAE,OAAoB;IAC1E,aAAa,CAAC,MAAM,CAAC,CAAC;IACtB,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC1B,aAAa,CAAC,MAAM,CAAC,CAAC;IAEtB,IAAI,sBAAsB,CAAC,OAAO,CAAC;QAAE,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;;QACvE,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAE/B,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAC7B,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACnC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAE/B,IAAI,aAAa,CAAC,OAAO,CAAC;QAAE,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvD,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACzB,cAAc,CAAC,MAAM,CAAC,CAAC;IACvB,yBAAyB,CAAC,MAAM,CAAC,CAAC;IAElC,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC5B,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAC/B,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAE/B,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,sBAAsB,GAAG,CAC7B,OAAoB,EAC4D,EAAE;IAClF,OAAO,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAC9C,CAAC,CAAC;AACF,MAAM,aAAa,GAAG,CACpB,OAAoB,EAC2D,EAAE;IACjF,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;AACtC,CAAC,CAAC"}

package/dist/esm/modules/frankie-client/mocks/individual/loadIndividual.d.ts

@@ -10,7 +10,7 @@ export declare type Options = {
 declare type MockOptions = MockOptionsPartial & {
     preloadedIndividual: Options;
 };
-export declare function resolveIndividualDdata(options: Options): {
+export declare function resolveIndividualData(options: Options): {
     individual: Applicant & {
         name: {
             givenName: string;

package/dist/esm/modules/frankie-client/mocks/individual/loadIndividual.js

@@ -4,7 +4,7 @@ import { Document } from "../../../common/shared/models/Document";
 import merge from "lodash.merge";
 import { v4 as uuid } from "uuid";
 import { URL_PARAM } from "../../DummyFrankieApiClient";
-export function resolveIndividualDdata(options) {
+export function resolveIndividualData(options) {
     var _a, _b;
     return {
         individual: merge(new Applicant(), {
@@ -22,7 +22,7 @@ export function resolveIndividualDdata(options) {
     };
 }
 export function loadExistingApplicant(client, options) {
-    const { individual, documents } = resolveIndividualDdata(options.preloadedIndividual);
+    const { individual, documents } = resolveIndividualData(options.preloadedIndividual);
     client.stubResponse({ url: "/data/v2/applicant", method: "get" }, (config) => {
         if (config.params.entityId)
             individual.entityId = config.params.entityId;

package/dist/esm/modules/frankie-client/mocks/individual/loadIndividual.js.map

@@ -1 +1 @@
-{"version":3,"file":"loadIndividual.js","sourceRoot":"","sources":["../../../../../../modules/frankie-client/mocks/individual/loadIndividual.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,2CAA2C,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AAEjE,OAAO,KAAK,MAAM,cAAc,CAAC;AACjC,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAGlC,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAOxD,MAAM,UAAU,sBAAsB,CAAC,OAAgB;;IACrD,OAAO;QACL,UAAU,EAAE,KAAK,CACf,IAAI,SAAS,EAAE,EACf;YACE,IAAI,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE;YAChE,WAAW,EAAE,YAAY;YACzB,QAAQ,EAAE,iBAAiB,IAAI,EAAE,EAAE;SACpC,EACD,MAAA,OAAO,CAAC,UAAU,mCAAI,EAAE,CACzB;QACD,SAAS,EAAE,MAAA,OAAO,CAAC,SAAS,0CAAE,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAC9C,KAAK,CACH,IAAI,QAAQ,EAAE,EACd;YACE,UAAU,EAAE,iBAAiB,IAAI,EAAE,EAAE;YACrC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;YACvD,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,OAAO;YACf,SAAS,EAAE,EAAE;SACO,EACtB,SAAS,CACV,CACF;KACF,CAAC;AACJ,CAAC;AACD,MAAM,UAAU,qBAAqB,CAAC,MAA6B,EAAE,OAAoB;IACvF,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,sBAAsB,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEtF,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,oBAAoB,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,MAAM,EAAE,EAAE;QAC3E,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ;YAAE,UAAU,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACzE,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS;YAAE,UAAU,CAAC,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;QAEpF,OAAO;YACL,KAAK,EAAE,mBAAmB;YAC1B,MAAM,EAAE,GAAG;YACX,IAAI,EAAE;gBACJ,SAAS,EAAE,UAAU,CAAC,MAAM,EAAE;gBAC9B,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;aAC5C;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,UAAU,iBAAiB,CAAC,MAA6B;IAC7D,MAAM,CAAC,YAAY,CACjB,EAAE,GAAG,EAAE,oBAAoB,EAAE,MAAM,EAAE,KAAK,EAAE,EAC5C;QACE,KAAK,EAAE,sBAAsB;QAC7B,MAAM,EAAE,GAAG;KACZ,CACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,UAAU,0BAA0B,CAAC,MAA6B;IACtE,MAAM,YAAY,GAAG,YAAY,CAAC,OAAO,EAAE,CAAC;IAC5C,YAAY,CAAC,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC;IACpC,YAAY,CAAC,MAAM,CAAC,KAAK,GAAG,QAAQ,CAAC;IACrC,YAAY,CAAC,MAAM,CAAC,GAAG,GAAG,QAAQ,CAAC;IACnC,YAAY,CAAC,SAAS,GAAG,EAAE,CAAC;IAE5B,MAAM,CAAC,YAAY,CACjB,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,uBAAuB,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EACtE;QACE,KAAK,EAAE,oBAAoB;QAC3B,IAAI,EAAE;YACJ,YAAY,EAAE,YAAY,CAAC,MAAM,EAAE;SACpC;KACF,CACF,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"loadIndividual.js","sourceRoot":"","sources":["../../../../../../modules/frankie-client/mocks/individual/loadIndividual.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,2CAA2C,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AAEjE,OAAO,KAAK,MAAM,cAAc,CAAC;AACjC,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAGlC,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAOxD,MAAM,UAAU,qBAAqB,CAAC,OAAgB;;IACpD,OAAO;QACL,UAAU,EAAE,KAAK,CACf,IAAI,SAAS,EAAE,EACf;YACE,IAAI,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE;YAChE,WAAW,EAAE,YAAY;YACzB,QAAQ,EAAE,iBAAiB,IAAI,EAAE,EAAE;SACpC,EACD,MAAA,OAAO,CAAC,UAAU,mCAAI,EAAE,CACzB;QACD,SAAS,EAAE,MAAA,OAAO,CAAC,SAAS,0CAAE,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAC9C,KAAK,CACH,IAAI,QAAQ,EAAE,EACd;YACE,UAAU,EAAE,iBAAiB,IAAI,EAAE,EAAE;YACrC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;YACvD,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,OAAO;YACf,SAAS,EAAE,EAAE;SACO,EACtB,SAAS,CACV,CACF;KACF,CAAC;AACJ,CAAC;AACD,MAAM,UAAU,qBAAqB,CAAC,MAA6B,EAAE,OAAoB;IACvF,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,qBAAqB,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAErF,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,oBAAoB,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,MAAM,EAAE,EAAE;QAC3E,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ;YAAE,UAAU,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACzE,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS;YAAE,UAAU,CAAC,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;QAEpF,OAAO;YACL,KAAK,EAAE,mBAAmB;YAC1B,MAAM,EAAE,GAAG;YACX,IAAI,EAAE;gBACJ,SAAS,EAAE,UAAU,CAAC,MAAM,EAAE;gBAC9B,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;aAC5C;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,UAAU,iBAAiB,CAAC,MAA6B;IAC7D,MAAM,CAAC,YAAY,CACjB,EAAE,GAAG,EAAE,oBAAoB,EAAE,MAAM,EAAE,KAAK,EAAE,EAC5C;QACE,KAAK,EAAE,sBAAsB;QAC7B,MAAM,EAAE,GAAG;KACZ,CACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,UAAU,0BAA0B,CAAC,MAA6B;IACtE,MAAM,YAAY,GAAG,YAAY,CAAC,OAAO,EAAE,CAAC;IAC5C,YAAY,CAAC,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC;IACpC,YAAY,CAAC,MAAM,CAAC,KAAK,GAAG,QAAQ,CAAC;IACrC,YAAY,CAAC,MAAM,CAAC,GAAG,GAAG,QAAQ,CAAC;IACnC,YAAY,CAAC,SAAS,GAAG,EAAE,CAAC;IAE5B,MAAM,CAAC,YAAY,CACjB,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,uBAAuB,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EACtE;QACE,KAAK,EAAE,oBAAoB;QAC3B,IAAI,EAAE;YACJ,YAAY,EAAE,YAAY,CAAC,MAAM,EAAE;SACpC;KACF,CACF,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -1,22 +1,34 @@
 import * as utils from "./common";
+import { ENVIRONMENTS } from "./common";
 import { FrankieApiClient } from "./frankie-client";
 import { SdkModes } from "./sdk/types";
 /**
  * Explicitly Export types (with type-only exports) and enums (without "type") at the root when importing into a typescript project via npm
  * https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export
  */
-export { ENVIRONMENTS } from "./common";
 export type { Accessors, mkEventHub, ReadonlyAccessors } from "./common";
 export type { CheckSummary } from "./common/shared/models/CheckSummary";
 export type { DeviceModule, DeviceModuleContext as DeviceModuleContext, Events as DeviceModuleEvents, } from "./device";
-export type { FrankieApiClient } from "./frankie-client";
+export { DummyFrankieApiClient, FrankieApiClient } from "./frankie-client";
 export { Status as OCRStatus } from "./ocr";
 export type { OneSdkContext, OneSdkRootParameters as OneSdkConfiguration } from "./sdk";
-export { SdkModes as SdkMode };
+export { SdkModes as SdkMode, ENVIRONMENTS as Environments };
+export { OneSDK };
+/**
+ * The default export of the OneSDK, also exposed as a named variable `OneSDK`.
+ * It is an asynchronous function that returns a Promise of the OneSdkContext,
+ * which is essentially an instance of the OneSDK.
+ * (options: OneSdkRootParameters) => Promise<OneSdkContext>
+ *
+ * This default export also contains utilities attached to it, such as the `modes` enum.
+ * @param {OneSdkRootParameters} options
+ * @returns {Promise<OneSdkContext>} Promise of an Instance of OneSDK
+ */
 declare const OneSDK: ((p: import("./sdk").OneSdkRootParameters) => Promise<import("./sdk").OneSdkContext>) & {
     FrankieApiClient: typeof FrankieApiClient;
     utils: typeof utils;
     modes: typeof SdkModes;
+    environments: typeof utils.ENVIRONMENTS;
     version: string;
 };
 export default OneSDK;

package/dist/esm/modules/index.js

@@ -1,23 +1,32 @@
 import * as utils from "./common";
+import { ENVIRONMENTS } from "./common";
 import { FrankieApiClient } from "./frankie-client";
 import packageMeta from "./meta.json";
 import { oneSdk } from "./sdk";
 import { SdkModes } from "./sdk/types";
-/**
- * Explicitly Export types (with type-only exports) and enums (without "type") at the root when importing into a typescript project via npm
- * https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export
- */
-export { ENVIRONMENTS } from "./common";
+export { DummyFrankieApiClient, FrankieApiClient } from "./frankie-client";
 export { Status as OCRStatus } from "./ocr";
-export { SdkModes as SdkMode };
+export { SdkModes as SdkMode, ENVIRONMENTS as Environments };
 // Exported OneSdk object
-// Via CDN, it will be available globally as [window.]OneSdk
-// OneSdk is a function, but also contains the objects
-// FrankieApiClient and utils
+// Either named as OneSDK or as a default export, which when loaded via CDN
+// The UMD build will attach the default export to the global window object as [window.]OneSdk
+// You'll find extra descriptions in the JSDoc below
+export { OneSDK };
+/**
+ * The default export of the OneSDK, also exposed as a named variable `OneSDK`.
+ * It is an asynchronous function that returns a Promise of the OneSdkContext,
+ * which is essentially an instance of the OneSDK.
+ * (options: OneSdkRootParameters) => Promise<OneSdkContext>
+ *
+ * This default export also contains utilities attached to it, such as the `modes` enum.
+ * @param {OneSdkRootParameters} options
+ * @returns {Promise<OneSdkContext>} Promise of an Instance of OneSDK
+ */
 const OneSDK = Object.assign(oneSdk.initialise, {
     FrankieApiClient,
     utils,
     modes: SdkModes,
+    environments: ENVIRONMENTS,
     version: packageMeta.version,
 });
 // eslint-disable-next-line import/no-default-export

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../modules/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC;;;GAGG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAS9C,OAAO,EAAE,MAAM,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AAElD,OAAO,EAAE,QAAQ,IAAI,OAAO,EAAE,CAAC;AAC/B,yBAAyB;AACzB,4DAA4D;AAC5D,sDAAsD;AACtD,6BAA6B;AAC7B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE;IAC9C,gBAAgB;IAChB,KAAK;IACL,KAAK,EAAE,QAAQ;IACf,OAAO,EAAE,WAAW,CAAC,OAAO;CAC7B,CAAC,CAAC;AACH,oDAAoD;AACpD,eAAe,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../modules/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAYvC,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AACjF,OAAO,EAAE,MAAM,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AAElD,OAAO,EAAE,QAAQ,IAAI,OAAO,EAAE,YAAY,IAAI,YAAY,EAAE,CAAC;AAC7D,yBAAyB;AACzB,2EAA2E;AAC3E,8FAA8F;AAC9F,oDAAoD;AACpD,OAAO,EAAE,MAAM,EAAE,CAAC;AAClB;;;;;;;;;GASG;AACH,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE;IAC9C,gBAAgB;IAChB,KAAK;IACL,KAAK,EAAE,QAAQ;IACf,YAAY,EAAE,YAAY;IAC1B,OAAO,EAAE,WAAW,CAAC,OAAO;CAC7B,CAAC,CAAC;AACH,oDAAoD;AACpD,eAAe,MAAM,CAAC"}

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

@@ -9,7 +9,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { OneSDKError } from "../../common";
 import { Applicant } from "../../common/shared/models/Applicant";
-import { hasEntityId } from "../../common/types/Session";
 import { Profile } from "../../common/shared/models/Profile";
 export const mkSearchMethod = (deps) => () => __awaiter(void 0, void 0, void 0, function* () {
     const { client, eventHub, state$, recipeName } = deps;
@@ -23,8 +22,8 @@ export const mkSearchMethod = (deps) => () => __awaiter(void 0, void 0, void 0,
         hasLoaded = true;
     }
     catch (e) {
-        if (hasEntityId(client.entityIdentifier)) {
-            const errorMessage = `Critical error! There was an issue loading the individual's details. Is the entityId (${client.entityIdentifier.entityId}) used to create this session valid?`;
+        if (client.entityId) {
+            const errorMessage = `Critical error! There was an issue loading the individual's details. Is the entityId (${client.entityId}) used to create this session valid?`;
             eventHub.emit("error", new OneSDKError(errorMessage, e));
             hasLoaded = false;
             throw new Error(errorMessage);
@@ -35,7 +34,7 @@ export const mkSearchMethod = (deps) => () => __awaiter(void 0, void 0, void 0,
             documents = [];
             const profile = new Profile(recipeName, "electronic");
             applicant.profile = profile;
-            applicant.customerReference = client.entityIdentifier.reference;
+            applicant.customerReference = client.reference;
         }
     }
     const isPreloaded = Boolean(applicant === null || applicant === void 0 ? void 0 : applicant.entityId);
@@ -46,6 +45,6 @@ export const mkSearchMethod = (deps) => () => __awaiter(void 0, void 0, void 0,
         isPreloaded,
     });
     if (hasLoaded)
-        eventHub.emit("data_loaded", Object.assign(Object.assign({}, client.entityIdentifier), { isPreloaded }));
+        eventHub.emit("data_loaded", { entityId: client.entityId, reference: client.reference, isPreloaded });
 });
 //# sourceMappingURL=search.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../../../modules/individual/actions/search.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAY,WAAW,EAAiB,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAC;AAEnE,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,OAAO,EAAE,OAAO,EAAE,MAAM,oCAAoC,CAAC;AAG7D,MAAM,CAAC,MAAM,cAAc,GACzB,CAAC,IAA+G,EAAE,EAAE,CACpH,GAAS,EAAE;IACT,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IACtD,IAAI,SAAS,GAAc,IAAI,CAAC;IAChC,IAAI,SAAS,GAAe,IAAI,CAAC;IACjC,IAAI,SAAS,GAAG,KAAK,CAAC;IAEtB,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QAClC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAC5B,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAC5B,SAAS,GAAG,IAAI,CAAC;KAClB;IAAC,OAAO,CAAC,EAAE;QACV,IAAI,WAAW,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE;YACxC,MAAM,YAAY,GAAG,yFAAyF,MAAM,CAAC,gBAAgB,CAAC,QAAQ,sCAAsC,CAAC;YACrL,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC;YACzD,SAAS,GAAG,KAAK,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;SAC/B;aAAM;YACL,SAAS,GAAG,IAAI,CAAC;YACjB,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,SAAS,GAAG,EAAE,CAAC;YAEf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;YACtD,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC;YAC5B,SAAS,CAAC,iBAAiB,GAAG,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC;SACjE;KACF;IACD,MAAM,WAAW,GAAG,OAAO,CAAC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,CAAC,CAAC;IACjD,MAAM,CAAC,IAAI,CAAC;QACV,SAAS;QACT,SAAS;QACT,SAAS;QACT,WAAW;KACZ,CAAC,CAAC;IACH,IAAI,SAAS;QAAE,QAAQ,CAAC,IAAI,CAAC,aAAa,kCAAO,MAAM,CAAC,gBAAgB,KAAE,WAAW,IAAG,CAAC;AAC3F,CAAC,CAAA,CAAC"}
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../../../modules/individual/actions/search.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAY,WAAW,EAAiB,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAC;AAGnE,OAAO,EAAE,OAAO,EAAE,MAAM,oCAAoC,CAAC;AAG7D,MAAM,CAAC,MAAM,cAAc,GACzB,CAAC,IAA+G,EAAE,EAAE,CACpH,GAAS,EAAE;IACT,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IACtD,IAAI,SAAS,GAAc,IAAI,CAAC;IAChC,IAAI,SAAS,GAAe,IAAI,CAAC;IACjC,IAAI,SAAS,GAAG,KAAK,CAAC;IAEtB,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QAClC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAC5B,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAC5B,SAAS,GAAG,IAAI,CAAC;KAClB;IAAC,OAAO,CAAC,EAAE;QACV,IAAI,MAAM,CAAC,QAAQ,EAAE;YACnB,MAAM,YAAY,GAAG,yFAAyF,MAAM,CAAC,QAAQ,sCAAsC,CAAC;YACpK,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC;YACzD,SAAS,GAAG,KAAK,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;SAC/B;aAAM;YACL,SAAS,GAAG,IAAI,CAAC;YACjB,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,SAAS,GAAG,EAAE,CAAC;YAEf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;YACtD,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC;YAC5B,SAAS,CAAC,iBAAiB,GAAG,MAAM,CAAC,SAAS,CAAC;SAChD;KACF;IACD,MAAM,WAAW,GAAG,OAAO,CAAC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,CAAC,CAAC;IACjD,MAAM,CAAC,IAAI,CAAC;QACV,SAAS;QACT,SAAS;QACT,SAAS;QACT,WAAW;KACZ,CAAC,CAAC;IACH,IAAI,SAAS;QACX,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;AAC1G,CAAC,CAAA,CAAC"}

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

@@ -1,4 +1,4 @@
-import { ApplicantId } from "../../common/types/Session";
+import { ApplicantId } from "../../session/SessionContext";
 export declare type Events = {
     data_loaded: [ApplicantId & {
         isPreloaded: boolean;

package/dist/esm/modules/meta.json

@@ -1 +1 @@
-{ "version": "0.5.5-rc" }
+{ "version": "0.6.5-alpha" }

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

@@ -8,9 +8,10 @@ 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 { Status, isCompleteStatus, isFailedStatus, isInputRequiredStatus, } from "../../frankie-client/clients/OCRClient";
+import { Subject, filter, takeUntil, takeWhile } from "rxjs";
 import { OneSDKError } from "../../common/errors/OneSDKError";
+import { runOnce } from "../../common/modules/HOF";
 /**
  * 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
@@ -53,6 +54,7 @@ export const mkStartMethod = (deps) => () => __awaiter(void 0, void 0, void 0, f
     const subscriber = {
         next: (newStatus) => {
             // For each new status/failureStatus, trigger inputRequired part of the flow
+            // This callback is what implements the loops in the OCR Flow
             inputRequired(newStatus, depsWithManualInterrupt);
         },
         complete: () => {
@@ -71,9 +73,9 @@ export const mkStartMethod = (deps) => () => __awaiter(void 0, void 0, void 0, f
     // either continue a flow, or start a new one
     yield resetCurrentStatus(depsWithManualInterrupt);
     // register callbacks to each data stream
-    // for status
+    // - for each new status, handle "error", "complete" and "next"/loop callbacks
     statusUntilComplete$.subscribe(subscriber);
-    // for failed statuses
+    // - for each new failed statuses, only handle the "next"/loop callback
     failedStatusExceptNull$.subscribe(subscriber.next);
     // expose interruptOCR() to allow interruption of an active flow, which unregister all listeners
     return {
@@ -180,16 +182,6 @@ export const inputRequired = (status, deps) => {
     const provideFile = mkProvideFile(deps);
     eventHub.emit("input_required", info, status, runOnce(provideFile, message));
 };
-const runOnce = (func, errorMessage) => {
-    let wasCalled = false;
-    return ((...args) => {
-        if (wasCalled)
-            throw new Error(errorMessage);
-        const result = func(...args);
-        wasCalled = true;
-        return result;
-    });
-};
 export const mkProvideFile = (deps) => (file) => {
     const { files$, document$, client } = deps;
     if (!file.type)