@frankieone/one-sdk 0.1.0-poc.15 → 0.2.2-alpha

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

@@ -0,0 +1,19 @@
+import * as utils from "./common";
+import { FrankieApiClient } from "./frankie-client";
+import { SdkModes } from "./sdk/types";
+export type { Accessors } from "./common";
+export type { DeviceModule, DeviceModuleContext as DeviceModuleContext, Events as DeviceModuleEvents, } from "./device";
+export type { FrankieApiClient } from "./frankie-client";
+export type { OneSdkContext, OneSdkRootParameters as OneSdkConfiguration } from "./sdk";
+export { SdkModes };
+declare const _default: ((p: import("./sdk").OneSdkRootParameters) => Promise<import("./sdk").OneSdkContext>) & {
+    FrankieApiClient: typeof FrankieApiClient;
+    utils: typeof utils;
+    modes: typeof SdkModes;
+};
+export default _default;
+declare global {
+    interface Window {
+        OneSdk: typeof import(".").default;
+    }
+}

package/dist/esm/modules/index.js

@@ -0,0 +1,16 @@
+import * as utils from "./common";
+import { FrankieApiClient } from "./frankie-client";
+import { oneSdk } from "./sdk";
+import { SdkModes } from "./sdk/types";
+export { SdkModes };
+// 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
+// eslint-disable-next-line import/no-default-export
+export default Object.assign(oneSdk.initialise, {
+    FrankieApiClient,
+    utils,
+    modes: SdkModes,
+});
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +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,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAUvC,OAAO,EAAE,QAAQ,EAAE,CAAC;AACpB,yBAAyB;AACzB,4DAA4D;AAC5D,sDAAsD;AACtD,6BAA6B;AAC7B,oDAAoD;AACpD,eAAe,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE;IAC9C,gBAAgB;IAChB,KAAK;IACL,KAAK,EAAE,QAAQ;CAChB,CAAC,CAAC"}

package/dist/esm/modules/individual/actions/consents.d.ts

@@ -0,0 +1,4 @@
+import { Accessors } from "../../common";
+export declare const mkAddConsents: (deps: {
+    consentsGiven$: Accessors<string[]>;
+}) => (type: string) => void;

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

@@ -0,0 +1,7 @@
+export const mkAddConsents = (deps) => (type) => {
+    const { consentsGiven$ } = deps;
+    const consents = consentsGiven$.getValue();
+    consents.push(type);
+    consentsGiven$.setValue(consents);
+};
+//# sourceMappingURL=consents.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"consents.js","sourceRoot":"","sources":["../../../../../modules/individual/actions/consents.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAA6C,EAAE,EAAE,CAAC,CAAC,IAAY,EAAE,EAAE;IAC/F,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IAChC,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,CAAC;IAC3C,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACpC,CAAC,CAAC"}

package/dist/esm/modules/individual/actions/documents.d.ts

@@ -0,0 +1,9 @@
+import { Accessors } from "../../common";
+import { Document } from "../../common/shared/models/Document";
+import { IndividualModuleContext } from "../types";
+declare type MkAddDocumentOptions = {
+    documents$: Accessors<Document[]>;
+};
+export declare const mkAddDocument: (deps: MkAddDocumentOptions) => IndividualModuleContext["addDocument"];
+export declare const mkUpdateDocument: (deps: MkAddDocumentOptions) => IndividualModuleContext["updateDocument"];
+export {};

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

@@ -0,0 +1,21 @@
+export const mkAddDocument = (deps) => (document) => {
+    const { documents$ } = deps;
+    const allDocuments = documents$.getValue();
+    allDocuments.push(document);
+    documents$.setValue(allDocuments);
+};
+export const mkUpdateDocument = (deps) => (id, document) => {
+    const { documents$ } = deps;
+    const allDocuments = documents$.getValue();
+    const index = allDocuments.findIndex((d) => d.documentId === id);
+    document.documentId = id;
+    if (index === -1) {
+        const addDocument = mkAddDocument(deps);
+        addDocument(document);
+    }
+    else {
+        allDocuments[index] = document;
+        documents$.setValue(allDocuments);
+    }
+};
+//# sourceMappingURL=documents.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../../../../modules/individual/actions/documents.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,MAAM,aAAa,GACxB,CAAC,IAA0B,EAA0C,EAAE,CACvE,CAAC,QAAQ,EAAE,EAAE;IACX,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IAC5B,MAAM,YAAY,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC;IAC3C,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5B,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;AACpC,CAAC,CAAC;AAEJ,MAAM,CAAC,MAAM,gBAAgB,GAC3B,CAAC,IAA0B,EAA6C,EAAE,CAC1E,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE;IACf,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IAC5B,MAAM,YAAY,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC;IAC3C,MAAM,KAAK,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC;IAEjE,QAAQ,CAAC,UAAU,GAAG,EAAE,CAAC;IAEzB,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;QAChB,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QACxC,WAAW,CAAC,QAAQ,CAAC,CAAC;KACvB;SAAM;QACL,YAAY,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;QAC/B,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;KACnC;AACH,CAAC,CAAC"}

package/dist/esm/modules/individual/actions/emitEvents.d.ts

@@ -0,0 +1,6 @@
+import { AccessorsDictionary, EventHub } from "../../common";
+import { Events } from "../types";
+export declare const subscribeAndEmitEvents: (deps: {
+    publicAccessors: AccessorsDictionary;
+    eventHub: EventHub<Events>;
+}) => void;

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

@@ -0,0 +1,7 @@
+export const subscribeAndEmitEvents = (deps) => {
+    const { eventHub, publicAccessors } = deps;
+    Object.entries(publicAccessors).forEach(([fieldName, accessors]) => {
+        accessors.observable.subscribe(() => eventHub.emit("data_updated", fieldName, accessors.getValue()));
+    });
+};
+//# sourceMappingURL=emitEvents.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"emitEvents.js","sourceRoot":"","sources":["../../../../../modules/individual/actions/emitEvents.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,IAA0E,EAAE,EAAE;IACnH,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;IAC3C,MAAM,CAAC,OAAO,CAAqB,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,EAAE;QACrF,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,SAAS,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACvG,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/esm/modules/individual/actions/search.d.ts

@@ -0,0 +1,17 @@
+import { EventHub, ReactiveStore } from "../../common";
+import { Applicant } from "../../common/shared/models/Applicant";
+import { Document } from "../../common/shared/models/Document";
+import { ApplicantClient } from "../../frankie-client/clients/ApplicantClient";
+import { Events } from "../types/events";
+export declare const mkSearchMethod: (deps: {
+    client: ApplicantClient;
+    eventHub: EventHub<Events>;
+    state$: ReactiveStore<State>;
+    recipeName: string;
+}) => () => Promise<void>;
+export declare type State = {
+    applicant: Applicant;
+    documents: Document[];
+    hasLoaded: boolean;
+    isPreloaded: boolean;
+};

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

@@ -0,0 +1,51 @@
+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 { 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;
+    let applicant = null;
+    let documents = null;
+    let hasLoaded = false;
+    try {
+        const found = yield client.load();
+        applicant = found.applicant;
+        documents = found.documents;
+        hasLoaded = true;
+    }
+    catch (e) {
+        if (hasEntityId(client.entityIdentifier)) {
+            eventHub.emit("error", {
+                message: `Critical error! There was an issue loading the individual's details. Is the entityId (${client.entityIdentifier.entityId}) used to create this session valid?`,
+                payload: e,
+            });
+            hasLoaded = false;
+        }
+        else {
+            hasLoaded = true;
+            applicant = new Applicant();
+            documents = [];
+            const profile = new Profile(recipeName, "electronic");
+            applicant.profile = profile;
+            applicant.customerReference = client.entityIdentifier.reference;
+        }
+    }
+    const isPreloaded = Boolean(applicant === null || applicant === void 0 ? void 0 : applicant.entityId);
+    state$.next({
+        applicant,
+        documents,
+        hasLoaded,
+        isPreloaded,
+    });
+    if (hasLoaded)
+        eventHub.emit("data_loaded", Object.assign(Object.assign({}, client.entityIdentifier), { isPreloaded }));
+});
+//# sourceMappingURL=search.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../../../modules/individual/actions/search.ts"],"names":[],"mappings":";;;;;;;;;AACA,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,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE;gBACrB,OAAO,EAAE,yFAAyF,MAAM,CAAC,gBAAgB,CAAC,QAAQ,sCAAsC;gBACxK,OAAO,EAAE,CAAC;aACX,CAAC,CAAC;YACH,SAAS,GAAG,KAAK,CAAC;SACnB;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"}

package/dist/esm/modules/individual/actions/submit.d.ts

@@ -0,0 +1,15 @@
+import { Accessors, EventHub } from "../../common";
+import { Applicant } from "../../common/shared/models/Applicant";
+import { Document } from "../../common/shared/models/Document";
+import { ApplicantClient } from "../../frankie-client/clients/ApplicantClient";
+import { PublicAccessors } from "../types";
+import { Events } from "../types/events";
+export declare const mkSubmitMethod: (deps: {
+    consentsGiven$: PublicAccessors["consentsGiven"];
+    applicant$: Accessors<Applicant>;
+    eventHub: EventHub<Events>;
+    client: ApplicantClient;
+    documents$: Accessors<Document[]>;
+}) => <T extends boolean>(o?: {
+    verify: T;
+}) => Promise<T extends true ? import("../../common/shared/models/CheckSummary").CheckSummary : true>;

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

@@ -0,0 +1,37 @@
+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());
+    });
+};
+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;
+}));
+//# sourceMappingURL=submit.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,2 @@
+import { IndividualModule } from "./types";
+export declare const individualModule: IndividualModule;

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

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

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

@@ -0,0 +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"}

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

@@ -0,0 +1,7 @@
+import { ApplicantId } from "../../common/types/Session";
+export declare type Events = {
+    data_loaded: [ApplicantId & {
+        isPreloaded: boolean;
+    }];
+    data_updated: [string, unknown];
+};

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,31 @@
+import type { Address } from "../../common/shared/models/Address";
+import { Applicant } from "../../common/shared/models/Applicant";
+import type { CheckSummary } from "../../common/shared/models/CheckSummary";
+import type { Document } from "../../common/shared/models/Document";
+import type { BaseModuleOptions, ModuleContext } from "../../sdk/types";
+import { AccessFunction, AccessorsDictionary } from "../../common/types/Accessors";
+import { Events } from "./events";
+export interface IndividualModule {
+    initialise: (o: BaseModuleOptions) => IndividualModuleContext;
+}
+export declare type IndividualModuleContext = ModuleContext<{
+    hasLoaded: () => boolean;
+    isPreloaded: () => boolean;
+    addConsent: (type: string) => void;
+    addDocument: (details: Document) => void;
+    updateDocument: (id: string, details: Document) => void;
+    submit: <T extends boolean>(o?: {
+        verify: T;
+    }) => Promise<T extends true ? CheckSummary : true>;
+    access: AccessFunction<PublicAccessors>;
+}, Events>;
+export declare type PublicFields = {
+    entityId: Applicant["entityId"];
+    name: Applicant["name"];
+    dateOfBirth: Applicant["dateOfBirth"];
+    consentsGiven: Applicant["consents"];
+    documents: Document[];
+    addresses: Address[];
+    hasLoaded: boolean;
+};
+export declare type PublicAccessors = AccessorsDictionary<PublicFields>;

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

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

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

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

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

@@ -0,0 +1,51 @@
+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 { Events } from "../types";
+declare type Dependencies = {
+    _expectedSide$: ReadonlyAccessors<"front" | "back">;
+    status$: Accessors<InputRequiredStatus | CompleteStatus>;
+    document$: Accessors<Document>;
+    files$: Accessors<File[]>;
+    individual: IndividualModuleContext;
+    eventHub: EventHub<Events>;
+    client: OCRClient;
+    isPreloaded$: Accessors<boolean>;
+    failedStatus$: Accessors<FailedStatus>;
+};
+export declare type DependenciesWithInterrupt = Dependencies & {
+    interruptOCR: InterruptOCR;
+};
+declare type InterruptOCR = (e: {
+    message: string;
+    payload?: unknown;
+}) => void;
+/**
+ * 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
+ * a) status$
+ *    Which will cycle on every new status and
+ *    will interrupt the cycle once the value of status is COMPLETE OR there is a forced interruption
+ * b) failedStatus$
+ *    Which will cycle on every new fail status, ignoring null values, issued when failures are resolved
+ *    Will be interrupted by any forced interruptions
+ *
+ * Forced interruptions occur when the function interruptOCR is called by either the customer or internally,
+ * when we reach an unrecoverable state. So far the unrecoverable states are
+ * - Receiving a status PROVIDER_OFFLINE form backend
+ * - File submission fails due to server/network issues
+ * - Receiving a status WAITING_OCR_RUN, reattempting automatically and failing with another WAITING_OCR_RUN
+ *
+ * @param deps dependencies passed from the OCR module
+ * @returns { interruptOCR }, where interruptOCR forces the end of the OCR cycles
+ */
+export declare const mkStartMethod: (deps: Dependencies) => () => Promise<{
+    interruptOCR: () => void;
+}>;
+export declare const resetCurrentStatus: (deps: DependenciesWithInterrupt) => Promise<void>;
+export declare const completeOCR: (deps: DependenciesWithInterrupt) => void;
+export declare const inputRequired: (status: Status, deps: DependenciesWithInterrupt) => void;
+export declare const mkProvideFile: (deps: DependenciesWithInterrupt) => (file: File) => void;
+export declare const mkEvaluateResults: (deps: DependenciesWithInterrupt) => (results: OCRResults, recursionFlag?: boolean) => void;
+export {};