@frankieone/one-sdk 0.3.2-rc.0 → 0.3.2-rc.2

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

@@ -0,0 +1,57 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mkSearchMethod = void 0;
+const Applicant_1 = require("@module/common/shared/models/Applicant");
+const Session_1 = require("@module/common/types/Session");
+const Profile_1 = require("../../common/shared/models/Profile");
+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 ((0, Session_1.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?`;
+            eventHub.emit("error", {
+                message: errorMessage,
+                payload: e,
+            });
+            hasLoaded = false;
+            throw new Error(errorMessage);
+        }
+        else {
+            hasLoaded = true;
+            applicant = new Applicant_1.Applicant();
+            documents = [];
+            const profile = new Profile_1.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 }));
+});
+exports.mkSearchMethod = mkSearchMethod;
+//# sourceMappingURL=search.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../../../modules/individual/actions/search.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,sEAAmE;AAEnE,0DAA2D;AAE3D,gEAA6D;AAGtD,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,IAAA,qBAAW,EAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE;YACxC,MAAM,YAAY,GAAG,yFAAyF,MAAM,CAAC,gBAAgB,CAAC,QAAQ,sCAAsC,CAAC;YACrL,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE;gBACrB,OAAO,EAAE,YAAY;gBACrB,OAAO,EAAE,CAAC;aACX,CAAC,CAAC;YACH,SAAS,GAAG,KAAK,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;SAC/B;aAAM;YACL,SAAS,GAAG,IAAI,CAAC;YACjB,SAAS,GAAG,IAAI,qBAAS,EAAE,CAAC;YAC5B,SAAS,GAAG,EAAE,CAAC;YAEf,MAAM,OAAO,GAAG,IAAI,iBAAO,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;AAxCS,QAAA,cAAc,kBAwCvB"}

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

@@ -0,0 +1,15 @@
+import { Accessors, EventHub } from "@module/common";
+import { Applicant } from "@module/common/shared/models/Applicant";
+import { Document } from "@module/common/shared/models/Document";
+import { ApplicantClient } from "@module/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/cjs/modules/individual/actions/submit.js

@@ -0,0 +1,41 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mkSubmitMethod = void 0;
+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;
+}));
+exports.mkSubmitMethod = mkSubmitMethod;
+//# sourceMappingURL=submit.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"submit.js","sourceRoot":"","sources":["../../../../../modules/individual/actions/submit.ts"],"names":[],"mappings":";;;;;;;;;;;;AAOO,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;AAnC7B,QAAA,cAAc,kBAmCe"}

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

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

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

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.individualModule = void 0;
+const common_1 = require("@module/common");
+const ApplicantClient_1 = require("@module/frankie-client/clients/ApplicantClient");
+const consents_1 = require("./actions/consents");
+const documents_1 = require("./actions/documents");
+const emitEvents_1 = require("./actions/emitEvents");
+const search_1 = require("./actions/search");
+const submit_1 = require("./actions/submit");
+exports.individualModule = {
+    initialise(o) {
+        const { frankieClient } = o;
+        const client = new ApplicantClient_1.ApplicantClient(frankieClient);
+        const state$ = new common_1.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$ = common_1.ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "entityId" });
+        const name$ = common_1.ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "name" });
+        const dob$ = common_1.ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "dateOfBirth" });
+        const addresses$ = common_1.ReactiveStore.mkPropertyAccessors(applicant$, { propertyName: "addresses" });
+        const consentsGiven$ = common_1.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 = (0, common_1.mkEventHub)();
+        // For each public field, emit "data_updated" when they change
+        (0, emitEvents_1.subscribeAndEmitEvents)({
+            eventHub,
+            publicAccessors,
+        });
+        // methods
+        const search = (0, search_1.mkSearchMethod)({
+            client,
+            eventHub,
+            state$,
+            recipeName: o.recipe.name,
+        });
+        const submitData = (0, submit_1.mkSubmitMethod)({
+            applicant$,
+            client,
+            consentsGiven$,
+            documents$,
+            eventHub,
+        });
+        const addConsent = (0, consents_1.mkAddConsents)({
+            consentsGiven$,
+        });
+        const addDocument = (0, documents_1.mkAddDocument)({
+            documents$,
+        });
+        const updateDocument = (0, documents_1.mkUpdateDocument)({
+            documents$,
+        });
+        // Refresh state automatically on initialisation
+        search();
+        return Object.assign(Object.assign({}, (0, common_1.mkEventListener)(eventHub)), { access: (fieldName) => publicAccessors[fieldName], isPreloaded: () => isPreloaded$.getValue(), hasLoaded: () => hasLoaded$.getValue(), submit: submitData, addDocument,
+            updateDocument,
+            addConsent });
+    },
+};
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/individual/index.ts"],"names":[],"mappings":";;;AAAA,2CAA4E;AAG5E,oFAAiF;AACjF,iDAAmD;AACnD,mDAAsE;AACtE,qDAA8D;AAC9D,6CAAkD;AAClD,6CAAkD;AAIrC,QAAA,gBAAgB,GAAqB;IAChD,UAAU,CAAC,CAAC;QACV,MAAM,EAAE,aAAa,EAAE,GAAG,CAAC,CAAC;QAC5B,MAAM,MAAM,GAAG,IAAI,iCAAe,CAAC,aAAa,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,IAAI,sBAAa,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,sBAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC;QAC9F,MAAM,KAAK,GAAG,sBAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;QACtF,MAAM,IAAI,GAAG,sBAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,sBAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;QAChG,MAAM,cAAc,GAAG,sBAAa,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,IAAA,mBAAU,GAAU,CAAC;QAEtC,8DAA8D;QAC9D,IAAA,mCAAsB,EAAC;YACrB,QAAQ;YACR,eAAe;SAChB,CAAC,CAAC;QAEH,UAAU;QACV,MAAM,MAAM,GAAG,IAAA,uBAAc,EAAC;YAC5B,MAAM;YACN,QAAQ;YACR,MAAM;YACN,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI;SAC1B,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,IAAA,uBAAc,EAAC;YAChC,UAAU;YACV,MAAM;YACN,cAAc;YACd,UAAU;YACV,QAAQ;SACT,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,IAAA,wBAAa,EAAC;YAC/B,cAAc;SACf,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,IAAA,yBAAa,EAAC;YAChC,UAAU;SACX,CAAC,CAAC;QACH,MAAM,cAAc,GAAG,IAAA,4BAAgB,EAAC;YACtC,UAAU;SACX,CAAC,CAAC;QACH,gDAAgD;QAChD,MAAM,EAAE,CAAC;QAET,uCACK,IAAA,wBAAe,EAAC,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/cjs/modules/individual/types/events.d.ts

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

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=events.js.map

package/dist/cjs/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/cjs/modules/individual/types/index.d.ts

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

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

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./events"), exports);
+__exportStar(require("./module"), exports);
+//# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,31 @@
+import type { Address } from "@module/common/shared/models/Address";
+import { Applicant } from "@module/common/shared/models/Applicant";
+import type { CheckSummary } from "@module/common/shared/models/CheckSummary";
+import type { Document } from "@module/common/shared/models/Document";
+import type { BaseModuleOptions, ModuleContext } from "@module/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<PublicFields>;
+}, 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/cjs/modules/individual/types/module.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=module.js.map

package/dist/cjs/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/cjs/modules/ocr/actions/start.d.ts

@@ -0,0 +1,52 @@
+import { Accessors, EventHub, ReadonlyAccessors } from "@module/common";
+import { Document } from "@module/common/shared/models/Document";
+import { CompleteStatus, FailedStatus, InputRequiredStatus, OCRClient, OCRResults, Status } from "@module/frankie-client/clients/OCRClient";
+import { IndividualModuleContext } from "@module/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 isOcrPreloaded: (d: Document) => boolean;
+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 {};

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

@@ -0,0 +1,278 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mkEvaluateResults = exports.mkProvideFile = exports.inputRequired = exports.completeOCR = exports.resetCurrentStatus = exports.isOcrPreloaded = exports.mkStartMethod = void 0;
+const Document_1 = require("@module/common/shared/models/Document");
+const OCRClient_1 = require("@module/frankie-client/clients/OCRClient");
+const rxjs_1 = require("rxjs");
+/**
+ * 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
+ */
+const mkStartMethod = (deps) => () => __awaiter(void 0, void 0, void 0, function* () {
+    const { status$, failedStatus$, eventHub, document$, files$, isPreloaded$ } = deps;
+    // If flow was interrupted with an error, interrupt observable as well
+    const interruptor = new rxjs_1.Subject();
+    const interruptOCR = ({ message, payload = null }) => interruptor.error({ message, payload });
+    // Loop until Status is COMPLETE, then unsubscribe automatically
+    // Repeated statuses do not trigger another cycle, so this assumes IDV always returns either a new status or a status flagging an issue
+    const statusUntilComplete$ = status$.observable.pipe((0, rxjs_1.filter)(Boolean), (0, rxjs_1.takeUntil)(interruptor), (0, rxjs_1.takeWhile)(statusIsNotComplete));
+    // Ignore null failures (when error is resolved). Run until interrupted
+    const failedStatusExceptNull$ = failedStatus$.observable.pipe((0, rxjs_1.filter)(Boolean), (0, rxjs_1.takeUntil)(interruptor));
+    const depsWithManualInterrupt = Object.assign(Object.assign({}, deps), { interruptOCR });
+    // callback definitions
+    const resetState = () => {
+        status$.setValue(null);
+        failedStatus$.setValue(null);
+        document$.setValue(null);
+        files$.setValue([]);
+        isPreloaded$.setValue(null);
+    };
+    const subscriber = {
+        next: (newStatus) => {
+            // For each new status/failureStatus, trigger inputRequired part of the flow
+            (0, exports.inputRequired)(newStatus, depsWithManualInterrupt);
+        },
+        complete: () => {
+            // when flow is flagged as completed by the operator takeWhile above
+            (0, exports.completeOCR)(depsWithManualInterrupt);
+            resetState();
+        },
+        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 });
+            resetState();
+        },
+    };
+    // Before starting the OCR flow, analyse the existing documents to
+    // either continue a flow, or start a new one
+    yield (0, exports.resetCurrentStatus)(depsWithManualInterrupt);
+    // register callbacks to each data stream
+    // for status
+    statusUntilComplete$.subscribe(subscriber);
+    // for failed statuses
+    failedStatusExceptNull$.subscribe(subscriber.next);
+    // expose interruptOCR() to allow interruption of an active flow, which unregister all listeners
+    return {
+        interruptOCR: () => interruptOCR({
+            message: "OCR Flow interrupted externally",
+            payload: {
+                document: deps.document$.getValue(),
+                status: deps.status$.getValue(),
+                failedStatus: deps.failedStatus$.getValue(),
+            },
+        }),
+    };
+});
+exports.mkStartMethod = mkStartMethod;
+const statusIsNotComplete = (status) => !(0, OCRClient_1.isCompleteStatus)(status);
+const isOcrPreloaded = (d) => {
+    var _a, _b;
+    // d.verified.{manual|electronic} can have boolean or null values
+    const { manual = null, electronic = null } = (_a = d.verified) !== null && _a !== void 0 ? _a : {};
+    if (!((_b = d.ocrResult) === null || _b === void 0 ? void 0 : _b.status))
+        return false;
+    if (manual === false)
+        return false;
+    if (electronic === false && manual !== true)
+        return false;
+    // COMPLETE, WAITING_FRONT, WAITING_BACK, WAITING_OCR_RUN, FAILED
+    return true;
+};
+exports.isOcrPreloaded = isOcrPreloaded;
+const resetCurrentStatus = (deps) => __awaiter(void 0, void 0, void 0, function* () {
+    /**
+     * Resolve the status, the document object and the "isPreloaded" flag before initiating the ocr flow
+     * The only statuses that should come out of this function are COMPLETE, WAITING_FRONT and WAITING_BACK
+     *
+     * 1) Determine if any document already has any valid OCR results
+     * 1.a) has ocrResult.status
+     * 1.b) has no failed KYC (neither manually or electronically rejected). Here manual verification takes precedence for this decision.
+  
+     */
+    const { individual, document$, status$, isPreloaded$, client, failedStatus$, interruptOCR } = deps;
+    const allDocuments = individual.access("documents");
+    // helpers
+    const isOcrInterrupted = (status) => status === OCRClient_1.Status.WAITING_OCR_RUN;
+    const isOcrWaitingOrComplete = (status) => (0, OCRClient_1.isInputRequiredStatus)(status) || (0, OCRClient_1.isCompleteStatus)(status);
+    const initialiseWith = (status, document, isPreloaded) => {
+        status$.setValue(status);
+        failedStatus$.setValue(null);
+        document$.setValue(document);
+        isPreloaded$.setValue(isPreloaded);
+    };
+    const startNewFlow = () => initialiseWith(OCRClient_1.Status.WAITING_FRONT, new Document_1.Document(), false);
+    // Search for existing document with ocr
+    const [latestFoundOcrDocument] = allDocuments
+        .getValue()
+        .filter(exports.isOcrPreloaded)
+        .sort((a, b) => +new Date(a.ocrResult.runDate) - +new Date(b.ocrResult.runDate))
+        .reverse();
+    // if none found, start a new flow
+    if (!latestFoundOcrDocument)
+        startNewFlow();
+    else if ((0, OCRClient_1.isFailedStatus)(latestFoundOcrDocument.ocrResult.status)) {
+        // if failed status, use existing docuemnt with status WAITING_FRONT
+        initialiseWith(OCRClient_1.Status.WAITING_FRONT, latestFoundOcrDocument, true);
+    }
+    else if (isOcrInterrupted(latestFoundOcrDocument.ocrResult.status)) {
+        // If latest OCR document was interrupted and has no 'continuable status', attempt to continue it
+        const { documentStatus, ocrDocument } = yield client.rerun(latestFoundOcrDocument.documentId);
+        // IF results are: WAITING_FRONT, WAITING_BACK, COMPLETE_OCR, use that
+        if ((0, OCRClient_1.isInputRequiredStatus)(documentStatus) || (0, OCRClient_1.isCompleteStatus)(documentStatus))
+            initialiseWith(documentStatus, ocrDocument, true);
+        // IF attempt fails with PROVIDER_OFFLINE, interrupt flow
+        else if (documentStatus === OCRClient_1.Status.PROVIDER_OFFLINE)
+            interruptOCR({
+                message: `Provider is offline. Either switch providers and restart or skip OCR temporarily. Status ${OCRClient_1.Status.PROVIDER_OFFLINE}`,
+                payload: null,
+            });
+        // If attempt fails, start new flow with WAITING_FRONT
+        else
+            startNewFlow();
+    }
+    else if (isOcrWaitingOrComplete(latestFoundOcrDocument.ocrResult.status)) {
+        // WAITING_FRONT, WAITING_BACK, COMPLETE_OCR
+        const storedStatus = latestFoundOcrDocument.ocrResult.status;
+        // OUTCOME: WAITING_FRONT, WAITING_BACK, COMPLETE_OCR
+        initialiseWith(storedStatus, latestFoundOcrDocument, true);
+        // anything else starts a new flow with WAITING_FRONT
+    }
+    else
+        startNewFlow();
+});
+exports.resetCurrentStatus = resetCurrentStatus;
+const completeOCR = (deps) => {
+    const { document$, eventHub, individual } = deps;
+    const document = document$.getValue();
+    individual.updateDocument(document.documentId, document);
+    eventHub.emit("results", { document });
+};
+exports.completeOCR = completeOCR;
+const inputRequired = (status, deps) => {
+    const { document$, _expectedSide$, eventHub } = deps;
+    const document = document$.getValue();
+    const idType = document.idType === "OTHER" ? null : document.idType;
+    const info = {
+        documentType: idType,
+        side: _expectedSide$.getValue(),
+    };
+    const message = "Callback 'submitFile' on event 'input_required' called twice. Second call was ignored";
+    const provideFile = (0, exports.mkProvideFile)(deps);
+    eventHub.emit("input_required", info, status, runOnce(provideFile, message));
+};
+exports.inputRequired = inputRequired;
+const runOnce = (func, errorMessage) => {
+    let wasCalled = false;
+    return ((...args) => {
+        if (wasCalled)
+            throw new Error(errorMessage);
+        const result = func(...args);
+        wasCalled = true;
+        return result;
+    });
+};
+const mkProvideFile = (deps) => (file) => {
+    const { files$, document$, client } = deps;
+    if (!file.type)
+        throw new Error("File is missing mime type. Provide a 'type' option in the File constructor");
+    if (!file.type.match(/^image/))
+        throw new Error("Invalid mime type. Provided files must be of type 'image'");
+    const files = files$.getValue();
+    files.push(file);
+    files$.setValue(files);
+    const { documentId } = document$.getValue();
+    const evaluateResults = (0, exports.mkEvaluateResults)(deps);
+    const submit = documentId
+        ? () => client.updateOCRDocument(file, documentId)
+        : () => client.attachNewOCRDocument(file);
+    submit()
+        .then(evaluateResults)
+        .catch((e) => {
+        deps.interruptOCR({ message: "Error submitting file", payload: e });
+    });
+};
+exports.mkProvideFile = mkProvideFile;
+const mkEvaluateResults = (deps) => (results, recursionFlag) => {
+    const { _expectedSide$, document$, eventHub, status$, client, failedStatus$, interruptOCR } = deps;
+    const { documentStatus, ocrDocument } = results;
+    // Update local document object first
+    const document = ocrDocument.clone();
+    document$.setValue(document);
+    // if not a failure and not a WAITING_OCR_RUN, emit logs to confirm file upload
+    if (!(0, OCRClient_1.isFailedStatus)(documentStatus) && documentStatus !== OCRClient_1.Status.WAITING_OCR_RUN) {
+        const expectedSide = _expectedSide$.getValue();
+        const expectedScanSide = expectedSide === "front" ? "F" : "B";
+        const foundScan = ocrDocument.scans.find((s) => expectedScanSide === s.side);
+        if (foundScan) {
+            eventHub.emit("file_uploaded", {
+                fileName: foundScan.scanName,
+                mimeType: foundScan.mimeType,
+                scanId: foundScan.scanId,
+                statusAfterUpload: documentStatus,
+                statusBeforeUpload: status$.getValue(),
+            });
+        }
+        else {
+            eventHub.emit("warning", {
+                message: `File was uploaded successfully, but there was an issue identifying it within the document payload: document.scans[].side didn't match expected side ${expectedSide} (${expectedScanSide}) `,
+            });
+        }
+    }
+    if (documentStatus === OCRClient_1.Status.PROVIDER_OFFLINE) {
+        interruptOCR({
+            message: `Provider is offline. Either switch providers and restart or skip OCR temporarily. Status ${OCRClient_1.Status.PROVIDER_OFFLINE}`,
+            payload: null,
+        });
+    }
+    else if (documentStatus === OCRClient_1.Status.WAITING_OCR_RUN) {
+        // If request previously returned WAITING_OCR_RUN, we tried again and got another WAITING_OCR_RUN,
+        // throw error, which will interruptOCR
+        if (recursionFlag)
+            throw new Error(`Two attempts to get OCR results failed with an unresolved "${OCRClient_1.Status.WAITING_OCR_RUN}". This is a system failure.`);
+        // If waiting_ocr_run is returned, try to rerun and reevaluate results
+        const evaluateResults = (0, exports.mkEvaluateResults)(deps);
+        client
+            .rerun(ocrDocument.documentId)
+            .then((res) => evaluateResults(res, true))
+            .catch((e) => interruptOCR({
+            message: `Attempting to resolve the status ${OCRClient_1.Status.WAITING_OCR_RUN} resulted in an error`,
+            payload: e,
+        }));
+    }
+    else if ((0, OCRClient_1.isFailedStatus)(documentStatus)) {
+        // if failed, set failedStatus and keep status the same
+        failedStatus$.setValue(documentStatus);
+    }
+    else {
+        // otherwise, update status to new received status
+        failedStatus$.setValue(null);
+        status$.setValue(documentStatus);
+    }
+};
+exports.mkEvaluateResults = mkEvaluateResults;
+//# sourceMappingURL=start.js.map