@frankieone/one-sdk 0.0.1-npm

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.js";
+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/IDVClient.d.ts

@@ -0,0 +1,47 @@
+import type { Document } from '../../common/shared/models/Document';
+import type { Dictionary } from '../../../types/index.js';
+import { BaseClient } from './BaseClient';
+export declare class IDVClient extends BaseClient {
+    getToken<SDKParameters extends Dictionary<unknown> = Dictionary<unknown>>(options?: IDVTokenParameters): Promise<IDVTokenResponse<SDKParameters>>;
+    initProcess({ isSynchronous, vendorParameters, }: InitIDVProcessRequest): Promise<{
+        checkStatus: IDVStatus;
+        ocrDocument?: Document;
+    }>;
+}
+type IDVTokenResponse<Params extends Dictionary<unknown>> = {
+    token: string;
+    vendorParameters: Params;
+    entityId: string;
+};
+type IDVTokenParameters = {
+    relayState: string;
+};
+type InitIDVProcessRequest = {
+    isSynchronous: boolean;
+    vendorParameters?: Partial<{
+        checkId: string;
+    }>;
+};
+export declare enum IDVStatus {
+    CHECK_NOT_STARTED = "CHECK_NOT_STARTED",
+    CHECK_PROCESSING = "CHECK_PROCESSING",
+    COMPLETE = "COMPLETE",
+    FAILED = "FAILED",// Added for the idv flow
+    INCOMPLETE = "INCOMPLETE",// Added for the idv flow
+    DOCUMENTS_INVALID = "AWAITING_DOCUMENT_UPLOAD_INVALID_TYPE",// Based on OCR Results
+    PROVIDER_OFFLINE = "PROVIDER_OFFLINE",
+    AWAITING_CONSENT = "AWAITING_CONSENT",// Added for the idv flow
+    WAITING_SELFIE_UPLOAD = "WAITING_SELFIE_UPLOAD",
+    WAITING_DOC_UPLOAD = "WAITING_DOC_UPLOAD",
+    INTERRUPTED = "INTERRUPTED"
+}
+export type FailedStatus = IDVStatus.FAILED;
+export type CompleteStatus = IDVStatus.COMPLETE;
+export type InputRequiredStatus = IDVStatus.DOCUMENTS_INVALID | IDVStatus.WAITING_DOC_UPLOAD | IDVStatus.WAITING_SELFIE_UPLOAD;
+export type ErrorStatus = IDVStatus.PROVIDER_OFFLINE | IDVStatus.AWAITING_CONSENT;
+export declare const isCompleteStatus: (status: IDVStatus) => status is IDVStatus.COMPLETE;
+export declare const isInputRequiredStatus: (status: IDVStatus) => status is InputRequiredStatus;
+export declare const isFailedStatus: (status: IDVStatus) => status is IDVStatus.FAILED;
+export declare const isErrorStatus: (status: IDVStatus) => status is ErrorStatus;
+export {};
+//# sourceMappingURL=IDVClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDVClient.d.ts","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/IDVClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AAEtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEzC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,SAAU,SAAQ,UAAU;IACjC,QAAQ,CAAC,aAAa,SAAS,UAAU,CAAC,OAAO,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,EAC5E,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAgCrC,WAAW,CAAC,EAChB,aAAa,EACb,gBAAqB,GACtB,EAAE,qBAAqB,GAAG,OAAO,CAAC;QAAE,WAAW,EAAE,SAAS,CAAC;QAAC,WAAW,CAAC,EAAE,QAAQ,CAAA;KAAE,CAAC;CAYvF;AACD,KAAK,gBAAgB,CAAC,MAAM,SAAS,UAAU,CAAC,OAAO,CAAC,IAAI;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,KAAK,kBAAkB,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,KAAK,qBAAqB,GAAG;IAC3B,aAAa,EAAE,OAAO,CAAC;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;QACzB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;CACJ,CAAC;AAMF,oBAAY,SAAS;IAEnB,iBAAiB,sBAAsB;IACvC,gBAAgB,qBAAqB;IAErC,QAAQ,aAAa;IACrB,MAAM,WAAW,CAAE,yBAAyB;IAC5C,UAAU,eAAe,CAAE,yBAAyB;IACpD,iBAAiB,0CAA8B,CAAE,uBAAuB;IAExE,gBAAgB,qBAAqB;IACrC,gBAAgB,qBAAqB,CAAE,yBAAyB;IAEhE,qBAAqB,0BAA0B;IAC/C,kBAAkB,uBAAuB;IACzC,WAAW,gBAAgB;CAC5B;AACD,MAAM,MAAM,YAAY,GAAG,SAAS,CAAC,MAAM,CAAC;AAC5C,MAAM,MAAM,cAAc,GAAG,SAAS,CAAC,QAAQ,CAAC;AAChD,MAAM,MAAM,mBAAmB,GAC3B,SAAS,CAAC,iBAAiB,GAC3B,SAAS,CAAC,kBAAkB,GAC5B,SAAS,CAAC,qBAAqB,CAAC;AACpC,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,gBAAgB,GAAG,SAAS,CAAC,gBAAgB,CAAC;AAOlF,eAAO,MAAM,gBAAgB,WAAY,SAAS,iCAEjD,CAAC;AACF,eAAO,MAAM,qBAAqB,WAAY,SAAS,kCAEtD,CAAC;AACF,eAAO,MAAM,cAAc,WAAY,SAAS,+BAE/C,CAAC;AACF,eAAO,MAAM,aAAa,WAAY,SAAS,0BAE9C,CAAC"}

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

@@ -0,0 +1,83 @@
+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 { treeShake } from '../../common/modules/objectUtils.js';
+import { Status as OCRStatus } from '../../ocr/index.js';
+import { BaseClient } from './BaseClient.js';
+export class IDVClient extends BaseClient {
+    getToken(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = `data/v2/idvCheck/token`;
+            const appReference = this.frankie.session.appReference;
+            const extractData = (response) => response.data;
+            return this.frankie
+                .post(url, treeShake({
+                applicant: {
+                    customerReference: this.reference,
+                    entityId: this.entityId,
+                },
+                appReference,
+            }, [undefined, null]), {
+                params: treeShake({
+                    relayState: options === null || options === void 0 ? void 0 : options.relayState,
+                }, [undefined, null]),
+            })
+                .then(extractData)
+                .then((d) => {
+                this.entityId = d.entityId;
+                return d;
+            });
+        });
+    }
+    initProcess(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ isSynchronous, vendorParameters = {}, }) {
+            const entityId = this.entityId;
+            return this.frankie
+                .post(`data/v2/idvCheck/${entityId}/initProcess${isSynchronous ? '?is_synchronous' : ''}`, {
+                vendorParameters,
+            })
+                .then((response) => response.data);
+        });
+    }
+}
+export var IDVStatus;
+(function (IDVStatus) {
+    // Unknown use cases
+    IDVStatus["CHECK_NOT_STARTED"] = "CHECK_NOT_STARTED";
+    IDVStatus["CHECK_PROCESSING"] = "CHECK_PROCESSING";
+    // Results
+    IDVStatus["COMPLETE"] = "COMPLETE";
+    IDVStatus["FAILED"] = "FAILED";
+    IDVStatus["INCOMPLETE"] = "INCOMPLETE";
+    IDVStatus["DOCUMENTS_INVALID"] = "AWAITING_DOCUMENT_UPLOAD_INVALID_TYPE";
+    // Errors
+    IDVStatus["PROVIDER_OFFLINE"] = "PROVIDER_OFFLINE";
+    IDVStatus["AWAITING_CONSENT"] = "AWAITING_CONSENT";
+    // Missing data
+    IDVStatus["WAITING_SELFIE_UPLOAD"] = "WAITING_SELFIE_UPLOAD";
+    IDVStatus["WAITING_DOC_UPLOAD"] = "WAITING_DOC_UPLOAD";
+    IDVStatus["INTERRUPTED"] = "INTERRUPTED";
+})(IDVStatus || (IDVStatus = {}));
+// TODO: Should we expose all these functions and types to customers?
+// Types could potentially be a bit much, but maybe the utility functions could be useful
+// Types could be exposed as a single namespace to make it a bit less overwhelming to learn
+// ie: IDV["FailedStatus"], IDV["Status"] etc
+export const isCompleteStatus = (status) => {
+    return status === IDVStatus.COMPLETE;
+};
+export const isInputRequiredStatus = (status) => {
+    return [IDVStatus.DOCUMENTS_INVALID, IDVStatus.WAITING_DOC_UPLOAD, IDVStatus.WAITING_SELFIE_UPLOAD].includes(status);
+};
+export const isFailedStatus = (status) => {
+    return [IDVStatus.FAILED].includes(status);
+};
+export const isErrorStatus = (status) => {
+    return [IDVStatus.PROVIDER_OFFLINE, IDVStatus.AWAITING_CONSENT].includes(status);
+};
+//# sourceMappingURL=IDVClient.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDVClient.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/IDVClient.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAE/D,OAAO,EAAE,MAAM,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AAGlD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,SAAU,SAAQ,UAAU;IACjC,QAAQ,CACZ,OAA4B;;YAE5B,MAAM,GAAG,GAAG,wBAAwB,CAAC;YACrC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC;YACvD,MAAM,WAAW,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;YAChD,OAAO,IAAI,CAAC,OAAO;iBAChB,IAAI,CACH,GAAG,EACH,SAAS,CACP;gBACE,SAAS,EAAE;oBACT,iBAAiB,EAAE,IAAI,CAAC,SAAS;oBACjC,QAAQ,EAAE,IAAI,CAAC,QAAQ;iBACxB;gBACD,YAAY;aACb,EACD,CAAC,SAAS,EAAE,IAAI,CAAC,CAClB,EACD;gBACE,MAAM,EAAE,SAAS,CACf;oBACE,UAAU,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;iBAChC,EACD,CAAC,SAAS,EAAE,IAAI,CAAC,CAClB;aACF,CACF;iBACA,IAAI,CAAC,WAAW,CAAC;iBACjB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;gBACV,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;gBAC3B,OAAO,CAAC,CAAC;YACX,CAAC,CAAC,CAAC;QACP,CAAC;KAAA;IACK,WAAW;6DAAC,EAChB,aAAa,EACb,gBAAgB,GAAG,EAAE,GACC;YACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YAE/B,OAAO,IAAI,CAAC,OAAO;iBAChB,IAAI,CACH,oBAAoB,QAAQ,eAAe,aAAa,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,EAAE,EACnF;gBACE,gBAAgB;aACjB,CACF;iBACA,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;KAAA;CACF;AAqBD,MAAM,CAAN,IAAY,SAgBX;AAhBD,WAAY,SAAS;IACnB,oBAAoB;IACpB,oDAAuC,CAAA;IACvC,kDAAqC,CAAA;IACrC,UAAU;IACV,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;IACjB,sCAAyB,CAAA;IACzB,wEAA+C,CAAA;IAC/C,SAAS;IACT,kDAAqC,CAAA;IACrC,kDAAqC,CAAA;IACrC,eAAe;IACf,4DAA+C,CAAA;IAC/C,sDAAyC,CAAA;IACzC,wCAA2B,CAAA;AAC7B,CAAC,EAhBW,SAAS,KAAT,SAAS,QAgBpB;AASD,qEAAqE;AACrE,yFAAyF;AACzF,2FAA2F;AAC3F,6CAA6C;AAE7C,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAiB,EAA4B,EAAE;IAC9E,OAAO,MAAM,KAAK,SAAS,CAAC,QAAQ,CAAC;AACvC,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAiB,EAAiC,EAAE;IACxF,OAAO,CAAC,SAAS,CAAC,iBAAiB,EAAE,SAAS,CAAC,kBAAkB,EAAE,SAAS,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACvH,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAiB,EAA0B,EAAE;IAC1E,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC7C,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAiB,EAAyB,EAAE;IACxE,OAAO,CAAC,SAAS,CAAC,gBAAgB,EAAE,SAAS,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACnF,CAAC,CAAC"}

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

@@ -0,0 +1,33 @@
+import { Document } from '../../common/shared/models/Document';
+import { BaseClient } from './BaseClient';
+import type { FrankieApiClient } from '../FrankieApiClient';
+export declare class OCRClient extends BaseClient {
+    constructor(frankie: FrankieApiClient);
+    attachNewOCRDocument(file?: File, digital?: boolean): Promise<OCRResults>;
+    rerun(documentId: string): Promise<OCRResults>;
+    updateOCRDocument(file: File, documentId: string, scanId?: string): Promise<OCRResults>;
+}
+export type OCRResults = {
+    ocrDocument: Document;
+    documentStatus: OCRStatus;
+};
+export declare enum OCRStatus {
+    WAITING_OCR_RUN = "AWAITING_DOCUMENT_OCR",
+    WAITING_BACK = "AWAITING_DOCUMENT_UPLOAD_BACK",
+    WAITING_FRONT = "AWAITING_DOCUMENT_UPLOAD_FRONT",
+    COMPLETE = "COMPLETE_OCR",
+    DOCUMENTS_INVALID = "AWAITING_DOCUMENT_UPLOAD_INVALID_TYPE",
+    DOCUMENTS_UPLOAD_FAILED = "AWAITING_DOCUMENT_UPLOAD_FAILED_OCR",
+    PROVIDER_OFFLINE = "AWAITING_OCR_RESULTS_PROVIDER_OFFLINE",
+    FAILED_FILE_SIZE = "DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT",
+    FAILED_FILE_FORMAT = "DOCUMENT_INVALID_INCORRECT_FILE_FORMAT",
+    INTERRUPTED = "INTERRUPTED"
+}
+export type FailedStatus = OCRStatus.DOCUMENTS_UPLOAD_FAILED | OCRStatus.DOCUMENTS_INVALID | OCRStatus.FAILED_FILE_FORMAT | OCRStatus.FAILED_FILE_SIZE | OCRStatus.INTERRUPTED;
+export type CompleteStatus = OCRStatus.COMPLETE;
+export type InputRequiredStatus = OCRStatus.WAITING_BACK | OCRStatus.WAITING_FRONT;
+export declare const isCompleteStatus: (status: OCRStatus) => status is OCRStatus.COMPLETE;
+export declare const isInputRequiredStatus: (status: OCRStatus) => status is InputRequiredStatus;
+export declare const isFailedStatus: (status: OCRStatus) => status is FailedStatus;
+export type OCRDocumentType = 'DRIVERS_LICENCE' | 'PASSPORT';
+//# sourceMappingURL=OCRClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OCRClient.d.ts","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/OCRClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AAEjE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAE5D,qBAAa,SAAU,SAAQ,UAAU;gBAC3B,OAAO,EAAE,gBAAgB;IAI/B,oBAAoB,CACxB,IAAI,CAAC,EAAE,IAAI,EACX,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,UAAU,CAAC;IAsBhB,KAAK,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAuB9C,iBAAiB,CACrB,IAAI,EAAE,IAAI,EACV,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,UAAU,CAAC;CAoBvB;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,QAAQ,CAAC;IACtB,cAAc,EAAE,SAAS,CAAC;CAC3B,CAAC;AAiBF,oBAAY,SAAS;IACnB,eAAe,0BAA0B;IACzC,YAAY,kCAAkC;IAC9C,aAAa,mCAAmC;IAChD,QAAQ,iBAAiB;IACzB,iBAAiB,0CAA0C;IAC3D,uBAAuB,wCAAwC;IAC/D,gBAAgB,0CAA0C;IAC1D,gBAAgB,yCAAyC;IACzD,kBAAkB,2CAA2C;IAC7D,WAAW,gBAAgB;CAC5B;AAED,MAAM,MAAM,YAAY,GACpB,SAAS,CAAC,uBAAuB,GACjC,SAAS,CAAC,iBAAiB,GAC3B,SAAS,CAAC,kBAAkB,GAC5B,SAAS,CAAC,gBAAgB,GAC1B,SAAS,CAAC,WAAW,CAAC;AAC1B,MAAM,MAAM,cAAc,GAAG,SAAS,CAAC,QAAQ,CAAC;AAChD,MAAM,MAAM,mBAAmB,GAC7B,SAAS,CAAC,YAAY,GACpB,SAAS,CAAC,aAAa,CAAC;AAE5B,eAAO,MAAM,gBAAgB,WAAY,SAAS,iCAEjD,CAAC;AACF,eAAO,MAAM,qBAAqB,WAAY,SAAS,kCAEtD,CAAC;AACF,eAAO,MAAM,cAAc,WAAY,SAAS,2BAQ/C,CAAC;AACF,MAAM,MAAM,eAAe,GAAG,iBAAiB,GAAG,UAAU,CAAC"}

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

@@ -0,0 +1,119 @@
+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 { Document } from '../../common/shared/models/Document.js';
+import { BaseClient } from './BaseClient.js';
+export class OCRClient extends BaseClient {
+    constructor(frankie) {
+        super(frankie);
+    }
+    attachNewOCRDocument(file, digital) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const formData = new FormData();
+            if (file) {
+                formData.append('image-file', file);
+                formData.append('digital', digital ? 'true' : 'false');
+            }
+            return this.frankie
+                .post(`data/v2/idvCheck/${this.entityId}/ocr`, formData, {
+                headers: {
+                    'Content-Type': 'multipart/form-data',
+                },
+            })
+                .then((response) => {
+                const { ocrDocument, status: documentStatus } = response.data;
+                return {
+                    ocrDocument: Document.fromJSON(ocrDocument),
+                    documentStatus,
+                };
+            });
+        });
+    }
+    rerun(documentId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.frankie
+                .put(`data/v2/idvCheck/${this.entityId}/ocr`, {
+                documentId,
+            }, {
+                headers: {
+                    'Content-Type': 'multipart/form-data',
+                },
+            })
+                .then((response) => {
+                const { ocrDocument, status: documentStatus } = response.data;
+                return {
+                    ocrDocument: Document.fromJSON(ocrDocument),
+                    documentStatus,
+                };
+            });
+        });
+    }
+    updateOCRDocument(file, documentId, scanId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const formData = new FormData();
+            formData.append('image-file', file);
+            formData.append('documentId', documentId);
+            if (scanId)
+                formData.append('scanId', scanId);
+            return this.frankie
+                .put(`data/v2/idvCheck/${this.entityId}/ocr`, formData, {
+                headers: {
+                    'Content-Type': 'multipart/form-data',
+                },
+            })
+                .then((response) => {
+                const { ocrDocument, status: documentStatus } = response.data;
+                return {
+                    ocrDocument: Document.fromJSON(ocrDocument),
+                    documentStatus,
+                };
+            });
+        });
+    }
+}
+// {
+//   "AWAITING_DOCUMENT_OCR", # # onesdk has captured a document but ocr process is yet to run. Default status if we get errors and user abandons process
+//   "AWAITING_DOCUMENT_UPLOAD_FRONT", # onesdk needs to capture front image
+//   "AWAITING_DOCUMENT_UPLOAD_BACK", # onesdk needs to capture back image
+//   "COMPLETE_OCR", # onesdk has captured a front and/or back image, submitted successfully, and ocr results are available
+//   "AWAITING_DOCUMENT_UPLOAD_FAILED_OCR", # onesdk has captured a document but during upload an error was given by the provider
+//   "AWAITING_DOCUMENT_UPLOAD_DOCUMENT_INVALID_TYPE", # onesdk has captured a front image and submitted successfully but documenttype is invalid
+//   "AWAITING_OCR_RESULTS_PROVIDER_OFFLINE", # onesdk has captured a document but there was an issue uploading the document or retrieving the result
+//   "DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT", # onesdk has captured a front image but failed validation due to file size exceeding the limit
+//   "DOCUMENT_INVALID_INCORRECT_FILE_FORMAT", # onesdk has captured a front image but failed validation due to incorrect file format
+//  }
+export var OCRStatus;
+(function (OCRStatus) {
+    OCRStatus["WAITING_OCR_RUN"] = "AWAITING_DOCUMENT_OCR";
+    OCRStatus["WAITING_BACK"] = "AWAITING_DOCUMENT_UPLOAD_BACK";
+    OCRStatus["WAITING_FRONT"] = "AWAITING_DOCUMENT_UPLOAD_FRONT";
+    OCRStatus["COMPLETE"] = "COMPLETE_OCR";
+    OCRStatus["DOCUMENTS_INVALID"] = "AWAITING_DOCUMENT_UPLOAD_INVALID_TYPE";
+    OCRStatus["DOCUMENTS_UPLOAD_FAILED"] = "AWAITING_DOCUMENT_UPLOAD_FAILED_OCR";
+    OCRStatus["PROVIDER_OFFLINE"] = "AWAITING_OCR_RESULTS_PROVIDER_OFFLINE";
+    OCRStatus["FAILED_FILE_SIZE"] = "DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT";
+    OCRStatus["FAILED_FILE_FORMAT"] = "DOCUMENT_INVALID_INCORRECT_FILE_FORMAT";
+    OCRStatus["INTERRUPTED"] = "INTERRUPTED";
+})(OCRStatus || (OCRStatus = {}));
+export const isCompleteStatus = (status) => {
+    return status === OCRStatus.COMPLETE;
+};
+export const isInputRequiredStatus = (status) => {
+    return [OCRStatus.WAITING_BACK, OCRStatus.WAITING_FRONT].includes(status);
+};
+export const isFailedStatus = (status) => {
+    return [
+        OCRStatus.DOCUMENTS_UPLOAD_FAILED,
+        OCRStatus.DOCUMENTS_INVALID,
+        OCRStatus.FAILED_FILE_FORMAT,
+        OCRStatus.FAILED_FILE_SIZE,
+        OCRStatus.INTERRUPTED,
+    ].includes(status);
+};
+//# sourceMappingURL=OCRClient.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OCRClient.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/OCRClient.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AAEjE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAI1C,MAAM,OAAO,SAAU,SAAQ,UAAU;IACvC,YAAY,OAAyB;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEK,oBAAoB,CACxB,IAAW,EACX,OAAiB;;YAEjB,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;YAChC,IAAI,IAAI,EAAE,CAAC;gBACT,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;gBACpC,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YACzD,CAAC;YACD,OAAO,IAAI,CAAC,OAAO;iBAChB,IAAI,CAAqB,oBAAoB,IAAI,CAAC,QAAQ,MAAM,EAAE,QAAQ,EAAE;gBAC3E,OAAO,EAAE;oBACP,cAAc,EAAE,qBAAqB;iBACtC;aACF,CAAC;iBACD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjB,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAE9D,OAAO;oBACL,WAAW,EAAE,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC;oBAC3C,cAAc;iBACf,CAAC;YACJ,CAAC,CAAC,CAAC;QACP,CAAC;KAAA;IAEK,KAAK,CAAC,UAAkB;;YAC5B,OAAO,IAAI,CAAC,OAAO;iBAChB,GAAG,CACF,oBAAoB,IAAI,CAAC,QAAQ,MAAM,EACvC;gBACE,UAAU;aACX,EACD;gBACE,OAAO,EAAE;oBACP,cAAc,EAAE,qBAAqB;iBACtC;aACF,CACF;iBACA,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjB,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAE9D,OAAO;oBACL,WAAW,EAAE,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC;oBAC3C,cAAc;iBACf,CAAC;YACJ,CAAC,CAAC,CAAC;QACP,CAAC;KAAA;IAEK,iBAAiB,CACrB,IAAU,EACV,UAAkB,EAClB,MAAe;;YAEf,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;YAChC,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;YACpC,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;YAC1C,IAAI,MAAM;gBAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAE9C,OAAO,IAAI,CAAC,OAAO;iBAChB,GAAG,CAAqB,oBAAoB,IAAI,CAAC,QAAQ,MAAM,EAAE,QAAQ,EAAE;gBAC1E,OAAO,EAAE;oBACP,cAAc,EAAE,qBAAqB;iBACtC;aACF,CAAC;iBACD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjB,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAC9D,OAAO;oBACL,WAAW,EAAE,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC;oBAC3C,cAAc;iBACf,CAAC;YACJ,CAAC,CAAC,CAAC;QACP,CAAC;KAAA;CACF;AAWD,IAAI;AACJ,yJAAyJ;AACzJ,4EAA4E;AAC5E,0EAA0E;AAC1E,2HAA2H;AAC3H,iIAAiI;AACjI,iJAAiJ;AACjJ,qJAAqJ;AACrJ,2IAA2I;AAC3I,qIAAqI;AACrI,KAAK;AACL,MAAM,CAAN,IAAY,SAWX;AAXD,WAAY,SAAS;IACnB,sDAAyC,CAAA;IACzC,2DAA8C,CAAA;IAC9C,6DAAgD,CAAA;IAChD,sCAAyB,CAAA;IACzB,wEAA2D,CAAA;IAC3D,4EAA+D,CAAA;IAC/D,uEAA0D,CAAA;IAC1D,sEAAyD,CAAA;IACzD,0EAA6D,CAAA;IAC7D,wCAA2B,CAAA;AAC7B,CAAC,EAXW,SAAS,KAAT,SAAS,QAWpB;AAaD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAiB,EAA4B,EAAE;IAC9E,OAAO,MAAM,KAAK,SAAS,CAAC,QAAQ,CAAC;AACvC,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAiB,EAAiC,EAAE;IACxF,OAAO,CAAC,SAAS,CAAC,YAAY,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC5E,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAiB,EAA0B,EAAE;IAC1E,OAAO;QACL,SAAS,CAAC,uBAAuB;QACjC,SAAS,CAAC,iBAAiB;QAC3B,SAAS,CAAC,kBAAkB;QAC5B,SAAS,CAAC,gBAAgB;QAC1B,SAAS,CAAC,WAAW;KACtB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACrB,CAAC,CAAC"}

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

@@ -0,0 +1,11 @@
+/**
+ * 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 {
+    retrieveAndDelete<Type>(key: string): Promise<{
+        value: Type;
+    }>;
+}
+//# sourceMappingURL=StorageClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StorageClient.d.ts","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/StorageClient.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,aAAc,SAAQ,UAAU;IACrC,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,IAAI,CAAA;KAAE,CAAC;CAUrE"}

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

@@ -0,0 +1,29 @@
+/**
+ * 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
+ */
+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.js";
+export class StorageClient extends BaseClient {
+    retrieveAndDelete(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const keyPairRetrieveEndpoint = `/data/v1/key-value/${key}`;
+            return this.frankie
+                .get(keyPairRetrieveEndpoint, {
+                params: {
+                    delete: true,
+                },
+            })
+                .then((d) => d.data);
+        });
+    }
+}
+//# 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;IACrC,iBAAiB,CAAO,GAAW;;YACvC,MAAM,uBAAuB,GAAG,sBAAsB,GAAG,EAAE,CAAC;YAC5D,OAAO,IAAI,CAAC,OAAO;iBAChB,GAAG,CAAkB,uBAAuB,EAAE;gBAC7C,MAAM,EAAE;oBACN,MAAM,EAAE,IAAI;iBACb;aACF,CAAC;iBACD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;KAAA;CACF"}

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

@@ -0,0 +1,6 @@
+import { TelemetryEvent } from "../../common/shared/models/TelemetryEvent";
+import { BaseClient } from "./BaseClient";
+export declare class TelemetryEventsClient extends BaseClient {
+    dispatch(payload: TelemetryEvent): Promise<import("axios").AxiosResponse<void, any>>;
+}
+//# sourceMappingURL=TelemetryEventsClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TelemetryEventsClient.d.ts","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/TelemetryEventsClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,6CAA6C,CAAC;AAC7E,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,qBAAsB,SAAQ,UAAU;IACnD,QAAQ,CAAC,OAAO,EAAE,cAAc;CAGjC"}

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

@@ -0,0 +1,7 @@
+import { BaseClient } from "./BaseClient.js";
+export class TelemetryEventsClient extends BaseClient {
+    dispatch(payload) {
+        return this.frankie.post(`/data/v2/events`, Object.assign({}, payload));
+    }
+}
+//# sourceMappingURL=TelemetryEventsClient.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TelemetryEventsClient.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/TelemetryEventsClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,qBAAsB,SAAQ,UAAU;IACnD,QAAQ,CAAC,OAAuB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAO,iBAAiB,oBAAO,OAAO,EAAG,CAAC;IACpE,CAAC;CACF"}

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

@@ -0,0 +1,14 @@
+import { ModeObject } from "../common/types";
+import { SessionContext } from "../session/SessionContext";
+import { DummyFrankieApiClient } from "./DummyFrankieApiClient";
+import { FrankieApiClient } from "./FrankieApiClient";
+type Options<Validate extends boolean = true> = {
+    mode: ModeObject;
+    session: SessionContext;
+    /** Should this factory function validate the session? */
+    validateToken?: Validate;
+};
+export declare function mkFrankieClient(options: Options<false>): FrankieApiClient;
+export declare function mkFrankieClient(options: Options<true>): Promise<FrankieApiClient>;
+export { FrankieApiClient, DummyFrankieApiClient };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../modules/frankie-client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAQtD,KAAK,OAAO,CAAC,QAAQ,SAAS,OAAO,GAAG,IAAI,IAAI;IAC9C,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,cAAc,CAAC;IACxB,yDAAyD;IACzD,aAAa,CAAC,EAAE,QAAQ,CAAC;CAC1B,CAAC;AACF,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,gBAAgB,CAAC;AAC3E,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAyBnF,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,CAAC"}

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

@@ -0,0 +1,33 @@
+import { SdkModes } from "../sdk/types/index.js";
+import { DummyFrankieApiClient } from "./DummyFrankieApiClient.js";
+import { FrankieApiClient } from "./FrankieApiClient.js";
+import { applyMocks } from "./mocks/applyMocks.js";
+import { defaultMockOptions } from "./mocks/options/simplified/defaults.js";
+import { resolveSimplifiedMockOptions } from "./mocks/options/simplified/resolveSimplifiedMockOptions.js";
+export function mkFrankieClient(options) {
+    var _a;
+    if (options.mode.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 = (_a = options.mode.mocks) !== null && _a !== void 0 ? _a : defaultMockOptions;
+        const mockOptions = resolveSimplifiedMockOptions(simplifiedMockOptions);
+        console.debug("Resolved mock options", {
+            mockOptions,
+            resultingMockedRequests: mockOptions,
+        });
+        // inject mocked flow to dummy client
+        return applyMocks(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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/frankie-client/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE,OAAO,EAAE,4BAA4B,EAAE,MAAM,yDAAyD,CAAC;AAWvG,MAAM,UAAU,eAAe,CAAC,OAAyB;;IACvD,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,KAAK,EAAE,CAAC;QAC7C,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,GAA0B,MAAA,OAAO,CAAC,IAAI,CAAC,KAAK,mCAAI,kBAAkB,CAAC;QAC9F,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,UAAU,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAC9C,CAAC;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/applyMocks.d.ts

@@ -0,0 +1,10 @@
+import type { MockOptions } from './options/MockOptions.type';
+import type { DummyFrankieApiClient } from '../DummyFrankieApiClient';
+/**
+ * applyMocks implements the logic to interpret the MockOptions and apply the appropriate mocks to the DummyFrankieApiClient
+ * @param client DummyFrankieApiClient to apply mocks to
+ * @param options MockOptions to guide the mocks to be applied
+ * @returns DummyFrankieApiClient with mocks applied
+ */
+export declare function applyMocks(client: DummyFrankieApiClient, options: MockOptions): DummyFrankieApiClient;
+//# sourceMappingURL=applyMocks.d.ts.map

package/dist/esm/modules/frankie-client/mocks/applyMocks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"applyMocks.d.ts","sourceRoot":"","sources":["../../../../../modules/frankie-client/mocks/applyMocks.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEtE;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,qBAAqB,EAAE,OAAO,EAAE,WAAW,GAAG,qBAAqB,CA6BrG"}

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

@@ -0,0 +1,53 @@
+import { skipFederationLogin, successfulConfirmation, successfulDataFetching } from './federation/index.js';
+import { mockIDVFlow } from './idvAndBiometrics/idvSubmission.js';
+import { applicantNotFound, loadExistingApplicant, loadSuccessfulCheckResults } from './individual/loadIndividual.js';
+import { submitSuccessfulData, successfulVerification } from './individual/submitData.js';
+import { loadConfiguration } from './initialisation/loadConfiguration.js';
+import { validateToken } from './initialisation/validateToken.js';
+import { submitOCR } from './ocr/ocrSubmission.js';
+import { mockStorage } from './storage/mockStorage.js';
+import { mockTelemetry } from './telemetry/index.js';
+/**
+ * applyMocks implements the logic to interpret the MockOptions and apply the appropriate mocks to the DummyFrankieApiClient
+ * @param client DummyFrankieApiClient to apply mocks to
+ * @param options MockOptions to guide the mocks to be applied
+ * @returns DummyFrankieApiClient with mocks applied
+ */
+export function applyMocks(client, options) {
+    // TODO: Streamline mocking with a reducer. Read below.
+    // 1) Don't test conditions in this function. Let each of the mockScenario functions test their own conditions
+    // 2) This function should simply list all the mockScenario functions and apply each of them to the client
+    // IE: [...mockScenarioFunctions].reduce((client, mockScenario) => mockScenario(client, options), client);
+    // 3) Make sure mockScenario functions use consistent naming that explains what the mockScenario actually is
+    // IE: The existing "loadExistingApplicant" is a good name and explains what the mockScenario is doing
+    // IE: "successfulDataFetching" is NOT a good name as we have no idea what it refers to
+    mockTelemetry(client);
+    loadConfiguration(client);
+    validateToken(client);
+    if (hasPreloadedIndividual(options))
+        loadExistingApplicant(client, options);
+    else
+        applicantNotFound(client);
+    submitSuccessfulData(client);
+    loadSuccessfulCheckResults(client);
+    successfulVerification(client);
+    if (hasOcrOptions(options))
+        submitOCR(client, options);
+    if (hasIdvOptions(options))
+        mockIDVFlow(client, options);
+    skipFederationLogin(client);
+    successfulDataFetching(client);
+    successfulConfirmation(client);
+    mockStorage(client);
+    return client;
+}
+const hasPreloadedIndividual = (options) => {
+    return Boolean(options.preloadedIndividual);
+};
+const hasOcrOptions = (options) => {
+    return Boolean(options.ocrRequests);
+};
+const hasIdvOptions = (options) => {
+    return Boolean(options.idvRequests);
+};
+//# sourceMappingURL=applyMocks.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"applyMocks.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/mocks/applyMocks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACnG,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AACnH,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,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAK5C;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,MAA6B,EAAE,OAAoB;IAC5E,uDAAuD;IACvD,8GAA8G;IAC9G,0GAA0G;IAC1G,0GAA0G;IAC1G,4GAA4G;IAC5G,sGAAsG;IACtG,uFAAuF;IAEvF,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;IACvD,IAAI,aAAa,CAAC,OAAO,CAAC;QAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzD,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC5B,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAC/B,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAC/B,WAAW,CAAC,MAAM,CAAC,CAAC;IAEpB,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,sBAAsB,GAAG,CAC7B,OAAoB,EACoE,EAAE;IAC1F,OAAO,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAC9C,CAAC,CAAC;AACF,MAAM,aAAa,GAAG,CACpB,OAAoB,EACuE,EAAE;IAC7F,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;AACtC,CAAC,CAAC;AACF,MAAM,aAAa,GAAG,CAAC,OAAoB,EAAwE,EAAE;IACnH,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;AACtC,CAAC,CAAC"}

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

@@ -0,0 +1,5 @@
+import { DummyFrankieApiClient } from "../..";
+export declare function skipFederationLogin(client: DummyFrankieApiClient): void;
+export declare function successfulDataFetching(client: DummyFrankieApiClient): void;
+export declare function successfulConfirmation(client: DummyFrankieApiClient): void;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../modules/frankie-client/mocks/federation/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAI/D,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,qBAAqB,QAYhE;AAED,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,qBAAqB,QAYnE;AACD,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,qBAAqB,QAQnE"}

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

@@ -0,0 +1,32 @@
+import { singpassURLs } from "../../../federation/vendors/Singpass.js";
+import { v4 as uuid } from "uuid";
+import { QUERY_PARAM, URL_PARAM } from "../../DummyFrankieApiClient.js";
+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,CAAC;YACtE,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;QAChB,CAAC;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/idvAndBiometrics/idvSubmission.d.ts

@@ -0,0 +1,18 @@
+import type { Applicant } from '../../../common/shared/models/Applicant';
+import type { Document } from '../../../common/shared/models/Document';
+import type { DeepPartial } from '../../../common/shared/models/general';
+import { IDVStatus } from '../../clients/IDVClient';
+import type { DummyFrankieApiClient } from '../../DummyFrankieApiClient';
+import type { MockOptions as _MockOptions } from '../options/MockOptions.type';
+export type IDVFlowOptions = {
+    result: IDVStatus;
+    failGeneratingSession?: boolean;
+    capturedIndividualDetails?: DeepPartial<Applicant>;
+    capturedDocumentDetails?: DeepPartial<Document>;
+};
+type MockOptions = _MockOptions & {
+    idvRequests: IDVFlowOptions;
+};
+export declare function mockIDVFlow(client: DummyFrankieApiClient, options: MockOptions): DummyFrankieApiClient;
+export {};
+//# sourceMappingURL=idvSubmission.d.ts.map

package/dist/esm/modules/frankie-client/mocks/idvAndBiometrics/idvSubmission.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"idvSubmission.d.ts","sourceRoot":"","sources":["../../../../../../modules/frankie-client/mocks/idvAndBiometrics/idvSubmission.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AAOrE,OAAO,KAAK,EAAE,qBAAqB,EAAgB,MAAM,6BAA6B,CAAC;AACvF,OAAO,KAAK,EAAE,WAAW,IAAI,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAE/E,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,SAAS,CAAC;IAClB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,yBAAyB,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACnD,uBAAuB,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;CACjD,CAAC;AAEF,KAAK,WAAW,GAAG,YAAY,GAAG;IAAE,WAAW,EAAE,cAAc,CAAA;CAAE,CAAC;AAiBlE,wBAAgB,WAAW,CAAC,MAAM,EAAE,qBAAqB,EAAE,OAAO,EAAE,WAAW,GAAG,qBAAqB,CAyDtG"}