@frankieone/one-sdk 0.2.4-alpha → 0.3.0-alpha

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

@@ -4,10 +4,10 @@ export class IDVClient extends BaseClient {
         const entityId = this.entityId;
         return this.frankie.get(`data/v2/idvCheck/${entityId}/token`).then((response) => response.data);
     }
-    initProcess() {
+    initProcess({ isSynchronous }) {
         const entityId = this.entityId;
         return this.frankie
-            .post(`data/v2/idvCheck/${entityId}/initProcess`)
+            .post(`data/v2/idvCheck/${entityId}/initProcess${isSynchronous ? "?is_synchronous" : ""}`)
             .then((response) => response.data);
     }
 }
@@ -17,5 +17,7 @@ export var Status;
     Status["WAITING_DOC_UPLOAD"] = "WAITING_DOC_UPLOAD";
     Status["CHECK_NOT_STARTED"] = "CHECK_NOT_STARTED";
     Status["CHECK_PROCESSING"] = "CHECK_PROCESSING";
+    Status["PROVIDER_OFFLINE"] = "PROVIDER_OFFLINE";
+    Status["COMPLETE"] = "COMPLETE";
 })(Status || (Status = {}));
 //# sourceMappingURL=IDVClient.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"IDVClient.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/IDVClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,SAAU,SAAQ,UAAU;IACvC,QAAQ;QACN,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAmB,oBAAoB,QAAQ,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACpH,CAAC;IACD,WAAW;QACT,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO;aAChB,IAAI,CAAyB,oBAAoB,QAAQ,cAAc,CAAC;aACxE,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;CACF;AASD,MAAM,CAAN,IAAY,MAKX;AALD,WAAY,MAAM;IAChB,yDAA+C,CAAA;IAC/C,mDAAyC,CAAA;IACzC,iDAAuC,CAAA;IACvC,+CAAqC,CAAA;AACvC,CAAC,EALW,MAAM,KAAN,MAAM,QAKjB"}
+{"version":3,"file":"IDVClient.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/IDVClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,SAAU,SAAQ,UAAU;IACvC,QAAQ;QACN,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAmB,oBAAoB,QAAQ,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACpH,CAAC;IACD,WAAW,CAAC,EAAE,aAAa,EAAyB;QAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO;aAChB,IAAI,CAAyB,oBAAoB,QAAQ,eAAe,aAAa,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;aACjH,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;CACF;AAaD,MAAM,CAAN,IAAY,MAOX;AAPD,WAAY,MAAM;IAChB,yDAA+C,CAAA;IAC/C,mDAAyC,CAAA;IACzC,iDAAuC,CAAA;IACvC,+CAAqC,CAAA;IACrC,+CAAqC,CAAA;IACrC,+BAAqB,CAAA;AACvB,CAAC,EAPW,MAAM,KAAN,MAAM,QAOjB"}

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

@@ -16,7 +16,7 @@ export declare enum Status {
     WAITING_BACK = "AWAITING_DOCUMENT_UPLOAD_BACK",
     WAITING_FRONT = "AWAITING_DOCUMENT_UPLOAD_FRONT",
     COMPLETE = "COMPLETE_OCR",
-    DOCUMENTS_INVALID = "AWAITING_DOCUMENT_UPLOAD_DOCUMENT_INVALID_TYPE",
+    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",
@@ -28,3 +28,4 @@ export declare type InputRequiredStatus = Status.WAITING_BACK | Status.WAITING_F
 export declare const isCompleteStatus: (status: Status) => status is Status.COMPLETE;
 export declare const isInputRequiredStatus: (status: Status) => status is InputRequiredStatus;
 export declare const isFailedStatus: (status: Status) => status is FailedStatus;
+export declare type OCRDocumentType = "DRIVERS_LICENCE" | "PASSPORT";

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

@@ -44,8 +44,6 @@ export class OCRClient extends BaseClient {
             })
                 .then((response) => {
                 const { ocrDocument, status: documentStatus } = response.data;
-                if (isFailedStatus(documentStatus))
-                    return { documentStatus, ocrDocument: null };
                 return {
                     ocrDocument: Document.fromJSON(ocrDocument),
                     documentStatus,
@@ -93,7 +91,7 @@ export var Status;
     Status["WAITING_BACK"] = "AWAITING_DOCUMENT_UPLOAD_BACK";
     Status["WAITING_FRONT"] = "AWAITING_DOCUMENT_UPLOAD_FRONT";
     Status["COMPLETE"] = "COMPLETE_OCR";
-    Status["DOCUMENTS_INVALID"] = "AWAITING_DOCUMENT_UPLOAD_DOCUMENT_INVALID_TYPE";
+    Status["DOCUMENTS_INVALID"] = "AWAITING_DOCUMENT_UPLOAD_INVALID_TYPE";
     Status["DOCUMENTS_UPLOAD_FAILED"] = "AWAITING_DOCUMENT_UPLOAD_FAILED_OCR";
     Status["PROVIDER_OFFLINE"] = "AWAITING_OCR_RESULTS_PROVIDER_OFFLINE";
     Status["FAILED_FILE_SIZE"] = "DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT";

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

@@ -1 +1 @@
-{"version":3,"file":"OCRClient.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/OCRClient.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAoB,MAAM,uCAAuC,CAAC;AAEnF,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,SAAU,SAAQ,UAAU;IACvC,YAAY,OAAyB;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IACK,oBAAoB,CAAC,IAAU;;YACnC,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;YAChC,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;YACpC,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;IACK,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;gBAC9D,IAAI,cAAc,CAAC,cAAc,CAAC;oBAAE,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;gBACjF,OAAO;oBACL,WAAW,EAAE,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC;oBAC3C,cAAc;iBACf,CAAC;YACJ,CAAC,CAAC,CAAC;QACP,CAAC;KAAA;IACK,iBAAiB,CAAC,IAAU,EAAE,UAAkB,EAAE,MAAe;;YACrE,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,MAUX;AAVD,WAAY,MAAM;IAChB,mDAAyC,CAAA;IACzC,wDAA8C,CAAA;IAC9C,0DAAgD,CAAA;IAChD,mCAAyB,CAAA;IACzB,8EAAoE,CAAA;IACpE,yEAA+D,CAAA;IAC/D,oEAA0D,CAAA;IAC1D,mEAAyD,CAAA;IACzD,uEAA6D,CAAA;AAC/D,CAAC,EAVW,MAAM,KAAN,MAAM,QAUjB;AAUD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAA4B,EAAE;IAC3E,OAAO,MAAM,KAAK,MAAM,CAAC,QAAQ,CAAC;AACpC,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAc,EAAiC,EAAE;IACrF,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACtE,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAc,EAA0B,EAAE;IACvE,OAAO;QACL,MAAM,CAAC,uBAAuB;QAC9B,MAAM,CAAC,iBAAiB;QACxB,MAAM,CAAC,kBAAkB;QACzB,MAAM,CAAC,gBAAgB;KACxB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACrB,CAAC,CAAC"}
+{"version":3,"file":"OCRClient.js","sourceRoot":"","sources":["../../../../../modules/frankie-client/clients/OCRClient.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAoB,MAAM,uCAAuC,CAAC;AAEnF,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,SAAU,SAAQ,UAAU;IACvC,YAAY,OAAyB;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IACK,oBAAoB,CAAC,IAAU;;YACnC,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;YAChC,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;YACpC,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;IACK,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;IACK,iBAAiB,CAAC,IAAU,EAAE,UAAkB,EAAE,MAAe;;YACrE,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,MAUX;AAVD,WAAY,MAAM;IAChB,mDAAyC,CAAA;IACzC,wDAA8C,CAAA;IAC9C,0DAAgD,CAAA;IAChD,mCAAyB,CAAA;IACzB,qEAA2D,CAAA;IAC3D,yEAA+D,CAAA;IAC/D,oEAA0D,CAAA;IAC1D,mEAAyD,CAAA;IACzD,uEAA6D,CAAA;AAC/D,CAAC,EAVW,MAAM,KAAN,MAAM,QAUjB;AAUD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAA4B,EAAE;IAC3E,OAAO,MAAM,KAAK,MAAM,CAAC,QAAQ,CAAC;AACpC,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAc,EAAiC,EAAE;IACrF,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACtE,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAc,EAA0B,EAAE;IACvE,OAAO;QACL,MAAM,CAAC,uBAAuB;QAC9B,MAAM,CAAC,iBAAiB;QACxB,MAAM,CAAC,kBAAkB;QACzB,MAAM,CAAC,gBAAgB;KACxB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACrB,CAAC,CAAC"}

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

@@ -12,31 +12,36 @@ import { Status } from "./clients/OCRClient";
 import { DummyFrankieApiClient } from "./DummyFrankieApiClient";
 import { FrankieApiClient } from "./FrankieApiClient";
 import { mockFlow } from "./mocks";
-const mockOptions = {
-    preloadIndividual: {
-        documents: [{ idType: "PASSPORT" }],
+import { resolveSimplifiedMockOptions } from "./mocks/simplifier";
+const defaultMockOptions = {
+    preloadedIndividual: {
+        documents: [{ idType: "PASSPORT", scans: "F" }],
     },
-    ocrDocument: {
-        type: "DRIVERS_LICENCE",
-        postResponsePayload: {
-            status: Status.WAITING_BACK,
-            scans: "front",
-        },
-        updateResponsePayloads: [
-            { status: Status.DOCUMENTS_INVALID, scans: "front" },
-            { status: Status.COMPLETE, scans: "all" },
-        ],
+    ocrFlow: {
+        detectedType: "DRIVERS_LICENCE",
+        statusResults: [Status.WAITING_BACK, Status.DOCUMENTS_INVALID, Status.COMPLETE],
     },
 };
+const isDummy = (mode) => (typeof mode === "string" ? mode : mode.modeName);
 export function mkFrankieClient(options) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
-        if (options.mode === SdkModes.DUMMY) {
+        if (isDummy(options.mode) === SdkModes.DUMMY) {
+            // initialise dummy client with optional token
             const dummyClient = new DummyFrankieApiClient(Object.assign(Object.assign({}, options), { defaultDelay: 200 }));
             if ((_a = options.session) === null || _a === void 0 ? void 0 : _a.token)
                 dummyClient.setToken(options.session.token);
+            // resolve mock options either from mode: { options } or if mode: "dummy", then use default mock options
+            const simplifiedMockOptions = typeof options.mode === "string" ? defaultMockOptions : options.mode.mocks;
+            const mockOptions = resolveSimplifiedMockOptions(simplifiedMockOptions);
+            console.debug("Resolved mock options", {
+                mockOptions,
+                resultingMockedRequests: mockOptions,
+            });
+            // inject mocked flow to dummy client
             return mockFlow(dummyClient, mockOptions);
         }
+        // if not in dummy mode, simply initialise the regular api client with the provided token
         const client = new FrankieApiClient();
         yield client.setToken(options.session.token, { checkValidity: true });
         return client;

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/frankie-client/index.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAsC,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAe,MAAM,SAAS,CAAC;AAEhD,MAAM,WAAW,GAAgB;IAC/B,iBAAiB,EAAE;QACjB,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;KACpC;IACD,WAAW,EAAE;QACX,IAAI,EAAE,iBAAiB;QACvB,mBAAmB,EAAE;YACnB,MAAM,EAAE,MAAM,CAAC,YAAY;YAC3B,KAAK,EAAE,OAAO;SACf;QACD,sBAAsB,EAAE;YACtB,EAAE,MAAM,EAAE,MAAM,CAAC,iBAAiB,EAAE,KAAK,EAAE,OAAO,EAAE;YACpD,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE;SAC1C;KACF;CACF,CAAC;AAEF,MAAM,UAAgB,eAAe,CAAC,OAAgB;;;QACpD,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,EAAE;YACnC,MAAM,WAAW,GAAG,IAAI,qBAAqB,iCAAM,OAAO,KAAE,YAAY,EAAE,GAAG,IAAG,CAAC;YACjF,IAAI,MAAA,OAAO,CAAC,OAAO,0CAAE,KAAK;gBAAE,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACxE,OAAO,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;SAC3C;QAED,MAAM,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACtC,MAAM,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,OAAO,MAAM,CAAC;;CACf;AACD,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/frankie-client/index.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAsC,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAe,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,4BAA4B,EAAyB,MAAM,oBAAoB,CAAC;AAEzF,MAAM,kBAAkB,GAA0B;IAChD,mBAAmB,EAAE;QACnB,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;KAChD;IACD,OAAO,EAAE;QACP,YAAY,EAAE,iBAAiB;QAC/B,aAAa,EAAE,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC,QAAQ,CAAC;KAChF;CACF,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,IAAU,EAAE,EAAE,CAAC,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAGlF,MAAM,UAAgB,eAAe,CAAC,OAAgB;;;QACpD,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,KAAK,EAAE;YAC5C,8CAA8C;YAC9C,MAAM,WAAW,GAAG,IAAI,qBAAqB,iCAAM,OAAO,KAAE,YAAY,EAAE,GAAG,IAAG,CAAC;YACjF,IAAI,MAAA,OAAO,CAAC,OAAO,0CAAE,KAAK;gBAAE,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACxE,wGAAwG;YACxG,MAAM,qBAAqB,GACzB,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;YAC7E,MAAM,WAAW,GAAgB,4BAA4B,CAAC,qBAAqB,CAAC,CAAC;YACrF,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE;gBACrC,WAAW;gBACX,uBAAuB,EAAE,WAAW;aACrC,CAAC,CAAC;YACH,qCAAqC;YACrC,OAAO,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;SAC3C;QACD,yFAAyF;QACzF,MAAM,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACtC,MAAM,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,OAAO,MAAM,CAAC;;CACf;AACD,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/esm/modules/frankie-client/mocks/biometrics/{idvSubmissoin.d.ts → idvSubmission.d.ts}

@@ -1,3 +1,4 @@
 import { DummyFrankieApiClient } from "../../DummyFrankieApiClient";
 export declare function generateIDVToken(client: DummyFrankieApiClient): DummyFrankieApiClient;
 export declare function initIDVProcess(client: DummyFrankieApiClient): DummyFrankieApiClient;
+export declare function initSynchronousIDVProcess(client: DummyFrankieApiClient): DummyFrankieApiClient;

package/dist/esm/modules/frankie-client/mocks/biometrics/{idvSubmissoin.js → idvSubmission.js}

@@ -22,4 +22,16 @@ export function initIDVProcess(client) {
     });
     return client;
 }
-//# sourceMappingURL=idvSubmissoin.js.map
+export function initSynchronousIDVProcess(client) {
+    client.stubResponse({ url: new RegExp(`data/v2/idvCheck/${URL_PARAM}/initProcess?is_synchronous`), method: "post" }, () => {
+        return {
+            title: "Call to init process",
+            delay: 3000,
+            data: {
+                checkStatus: Status.COMPLETE,
+            },
+        };
+    });
+    return client;
+}
+//# sourceMappingURL=idvSubmission.js.map

package/dist/esm/modules/frankie-client/mocks/biometrics/{idvSubmissoin.js.map → idvSubmission.js.map}

@@ -1 +1 @@
-{"version":3,"file":"idvSubmissoin.js","sourceRoot":"","sources":["../../../../../../modules/frankie-client/mocks/biometrics/idvSubmissoin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,EAAyB,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAE/E,MAAM,UAAU,gBAAgB,CAAC,MAA6B;IAC5D,MAAM,CAAC,YAAY,CACjB,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,oBAAoB,SAAS,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EACzE;QACE,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,IAAI;QACX,IAAI,EAAE;YACJ,KAAK,EAAE,6BAA6B;SACrC;KACF,CACF,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,MAA6B;IAC1D,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,oBAAoB,SAAS,cAAc,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE;QACzG,OAAO;YACL,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE,IAAI;YACX,IAAI,EAAE;gBACJ,WAAW,EAAE,MAAM,CAAC,gBAAgB;aACrC;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"idvSubmission.js","sourceRoot":"","sources":["../../../../../../modules/frankie-client/mocks/biometrics/idvSubmission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,EAAyB,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAE/E,MAAM,UAAU,gBAAgB,CAAC,MAA6B;IAC5D,MAAM,CAAC,YAAY,CACjB,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,oBAAoB,SAAS,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EACzE;QACE,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,IAAI;QACX,IAAI,EAAE;YACJ,KAAK,EAAE,6BAA6B;SACrC;KACF,CACF,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,MAA6B;IAC1D,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,oBAAoB,SAAS,cAAc,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE;QACzG,OAAO;YACL,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE,IAAI;YACX,IAAI,EAAE;gBACJ,WAAW,EAAE,MAAM,CAAC,gBAAgB;aACrC;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,MAA6B;IACrE,MAAM,CAAC,YAAY,CACjB,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,oBAAoB,SAAS,6BAA6B,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAC/F,GAAG,EAAE;QACH,OAAO;YACL,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE,IAAI;YACX,IAAI,EAAE;gBACJ,WAAW,EAAE,MAAM,CAAC,QAAQ;aAC7B;SACF,CAAC;IACJ,CAAC,CACF,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -1,12 +1,8 @@
 import { DummyFrankieApiClient } from "../DummyFrankieApiClient";
-import { OptionsLoadExistingApplicant } from "./individual/loadIndividual";
-import { Options as OCROptions } from "./ocr/driversLicence";
+import { Options as PreloadedIndividualOptions } from "./individual/loadIndividual";
+import { Options as OCRFlowOptions } from "./ocr/ocrSubmission";
 export declare function mockFlow(client: DummyFrankieApiClient, options: MockOptions): DummyFrankieApiClient;
-declare type OCRDocumentType = "DRIVERS_LICENCE" | "PASSPORT";
 export declare type MockOptions = {
-    preloadIndividual?: false | OptionsLoadExistingApplicant;
-    ocrDocument?: false | ({
-        type: OCRDocumentType;
-    } & OCROptions);
+    preloadedIndividual?: false | PreloadedIndividualOptions;
+    ocrRequests?: OCRFlowOptions;
 };
-export {};

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

@@ -1,24 +1,30 @@
-import { generateIDVToken, initIDVProcess } from "./biometrics/idvSubmissoin";
+import { generateIDVToken, initIDVProcess, initSynchronousIDVProcess } from "./biometrics/idvSubmission";
 import { applicantNotFound, loadExistingApplicant, loadSuccessfulCheckResults, } from "./individual/loadIndividual";
 import { submitSuccessfulData, successfulVerification } from "./individual/submitData";
 import { loadConfiguration } from "./initialisation/loadConfiguration";
 import { validateToken } from "./initialisation/validateToken";
-import { submitDLScans } from "./ocr/driversLicence";
+import { submitOCR } from "./ocr/ocrSubmission";
 export function mockFlow(client, options) {
-    const { preloadIndividual = false, ocrDocument = false } = options;
     loadConfiguration(client);
     validateToken(client);
-    if (preloadIndividual)
-        loadExistingApplicant(client, preloadIndividual);
+    if (hasPreloadedIndividual(options))
+        loadExistingApplicant(client, options);
     else
         applicantNotFound(client);
     submitSuccessfulData(client);
     loadSuccessfulCheckResults(client);
     successfulVerification(client);
-    if (ocrDocument)
-        submitDLScans(client, ocrDocument);
+    if (hasOcrOptions(options))
+        submitOCR(client, options);
     generateIDVToken(client);
     initIDVProcess(client);
+    initSynchronousIDVProcess(client);
     return client;
 }
+const hasPreloadedIndividual = (options) => {
+    return Boolean(options.preloadedIndividual);
+};
+const hasOcrOptions = (options) => {
+    return Boolean(options.ocrRequests);
+};
 //# sourceMappingURL=index.js.map

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

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

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

@@ -1,8 +1,28 @@
+import { Applicant } from "../../../common/shared/models/Applicant";
 import { Document } from "../../../common/shared/models/Document";
 import { DummyFrankieApiClient } from "../../../frankie-client";
-export declare type OptionsLoadExistingApplicant = {
-    documents: Partial<Document>[];
+import { MockOptions as MockOptionsPartial } from "..";
+import { DeepPartial } from "../../../common/shared/models/general";
+export declare type Options = {
+    individual?: DeepPartial<Applicant>;
+    documents?: DeepPartial<Document>[];
 };
-export declare function loadExistingApplicant(client: DummyFrankieApiClient, options: OptionsLoadExistingApplicant): DummyFrankieApiClient;
+declare type MockOptions = MockOptionsPartial & {
+    preloadedIndividual: Options;
+};
+export declare function resolveIndividualDdata(options: Options): {
+    individual: Applicant & {
+        name: {
+            givenName: string;
+            familyName: string;
+            middleName: any;
+        };
+        dateOfBirth: string;
+        entityId: string;
+    } & import("type-fest/source/partial-deep").PartialObjectDeep<Applicant>;
+    documents: (Document & Partial<Document> & import("type-fest/source/partial-deep").PartialObjectDeep<Document>)[];
+};
+export declare function loadExistingApplicant(client: DummyFrankieApiClient, options: MockOptions): DummyFrankieApiClient;
 export declare function applicantNotFound(client: DummyFrankieApiClient): DummyFrankieApiClient;
 export declare function loadSuccessfulCheckResults(client: DummyFrankieApiClient): DummyFrankieApiClient;
+export {};

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

@@ -1,34 +1,39 @@
 import { Applicant } from "../../../common/shared/models/Applicant";
 import { CheckSummary } from "../../../common/shared/models/CheckSummary";
 import { Document } from "../../../common/shared/models/Document";
+import merge from "lodash.merge";
 import { v4 as uuid } from "uuid";
 import { URL_PARAM } from "../../DummyFrankieApiClient";
+export function resolveIndividualDdata(options) {
+    var _a, _b;
+    return {
+        individual: merge(new Applicant(), {
+            name: { givenName: "John", familyName: "Doe", middleName: null },
+            dateOfBirth: "1991-10-16",
+            entityId: `mockpreloaded-${uuid()}`,
+        }, (_a = options.individual) !== null && _a !== void 0 ? _a : {}),
+        documents: (_b = options.documents) === null || _b === void 0 ? void 0 : _b.map((docConfig) => merge(new Document(), {
+            documentId: `mockpreloaded-${uuid()}`,
+            idNumber: String(Math.floor(Math.random() * 999999999)),
+            country: "AUS",
+            idType: "OTHER",
+            ocrResult: {},
+        }, docConfig)),
+    };
+}
 export function loadExistingApplicant(client, options) {
-    var _a;
-    const documentsConfig = (_a = options.documents) !== null && _a !== void 0 ? _a : [];
+    const { individual, documents } = resolveIndividualDdata(options.preloadedIndividual);
     client.stubResponse({ url: "/data/v2/applicant", method: "get" }, (config) => {
-        var _a, _b;
-        const applicant = new Applicant();
-        applicant.name.givenName = "John";
-        applicant.name.familyName = "Doe";
-        applicant.dateOfBirth = "1998-10-10";
-        applicant.entityId = (_a = config.params.entityId) !== null && _a !== void 0 ? _a : uuid();
-        applicant.customerReference = (_b = config.params.reference) !== null && _b !== void 0 ? _b : null;
-        const documents = documentsConfig.map((config) => {
-            const document = Object.assign(new Document(), {
-                documentId: "preexisting-" + uuid(),
-                idNumber: String(Math.floor(Math.random() * 999999999)),
-                country: "AUS",
-                ocrResult: {},
-            }, config);
-            return document;
-        });
+        if (config.params.entityId)
+            individual.entityId = config.params.entityId;
+        if (config.params.reference)
+            individual.customerReference = config.params.reference;
         return {
             title: "Search individual",
             status: 200,
             data: {
-                applicant: applicant.toJSON(),
-                documents,
+                applicant: individual.toJSON(),
+                documents: documents.map((d) => d.toJSON()),
             },
         };
     });

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

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

package/dist/esm/modules/frankie-client/mocks/ocr/ocrSubmission.d.ts

@@ -0,0 +1,23 @@
+import { Document, Scan } from "../../../common/shared/models/Document";
+import { PartialDeep } from "type-fest";
+import { MockOptions as MockOptionsPartial } from "..";
+import { DeepPartial } from "../../../common/shared/models/general";
+import { OCRDocumentType, Status } from "../../clients/OCRClient";
+import { DummyFrankieApiClient } from "../../DummyFrankieApiClient";
+export declare type OCRDocumentOptions = {
+    status: Status;
+    ocrDocument: PartialDeep<Document>;
+};
+export declare type Options = {
+    detectedType: OCRDocumentType;
+    updateResponsePayloads: OCRDocumentOptions[];
+    postResponsePayload: OCRDocumentOptions;
+};
+declare type MockOptions = Omit<MockOptionsPartial, "ocrRequests"> & {
+    ocrRequests: Options;
+};
+export declare function submitOCR(client: DummyFrankieApiClient, options: MockOptions): DummyFrankieApiClient;
+export declare function createOCRDocument(client: DummyFrankieApiClient, options: MockOptions): DummyFrankieApiClient;
+export declare function updateOCRDocument(client: DummyFrankieApiClient, options: MockOptions): DummyFrankieApiClient;
+export declare const mkFullScanPayload: (scanOptions: DeepPartial<Document>["scans"][0]) => Scan;
+export {};

package/dist/esm/modules/frankie-client/mocks/ocr/{driversLicence.js → ocrSubmission.js}

@@ -1,19 +1,17 @@
+import { Scan } from "../../../common/shared/models/Document";
+import merge from "lodash.merge";
 import { v4 as uuid } from "uuid";
-import { Status } from "../../clients/OCRClient";
 import { URL_PARAM } from "../../DummyFrankieApiClient";
 const scanUuidFront = uuid();
 const scanUuidBack = uuid();
-export function submitDLScans(client, options) {
-    createDLOcrDocument(client, options);
-    submitDLBackScan(client, options);
+export function submitOCR(client, options) {
+    createOCRDocument(client, options);
+    updateOCRDocument(client, options);
     return client;
 }
-export function createDLOcrDocument(client, options) {
+export function createOCRDocument(client, options) {
     client.stubResponse({ url: new RegExp(`data/v2/idvCheck/${URL_PARAM}/ocr`), method: "post" }, () => {
-        var _a;
-        const { status = Status.WAITING_BACK, scans = "front" } = (_a = options.postResponsePayload) !== null && _a !== void 0 ? _a : {};
-        const sides = status === Status.WAITING_OCR_RUN ? scans : "front";
-        const data = mkFullPayload({ status, sides, documentId: uuid() });
+        const data = mkFullPayload(options.ocrRequests.postResponsePayload, options);
         return {
             delay: 800,
             title: `OCR New document`,
@@ -23,12 +21,14 @@ export function createDLOcrDocument(client, options) {
     });
     return client;
 }
-export function submitDLBackScan(client, options) {
+export function updateOCRDocument(client, options) {
     client.stubResponse({ url: new RegExp(`data/v2/idvCheck/${URL_PARAM}/ocr`), method: "put" }, (config) => {
+        const currentRequestPayload = options.ocrRequests.updateResponsePayloads.shift();
         const documentId = config.data instanceof FormData ? config.data.get("documentId") : config.data.documentId;
+        if (documentId)
+            currentRequestPayload.ocrDocument.documentId = documentId;
         // If not submitting image file, this is a OCR rerun
-        const { status, scans } = options.updateResponsePayloads.shift();
-        const data = mkFullPayload({ status, sides: scans, documentId });
+        const data = mkFullPayload(currentRequestPayload, options);
         return {
             title: `Update document for OCR`,
             delay: 800,
@@ -38,26 +38,49 @@ export function submitDLBackScan(client, options) {
     });
     return client;
 }
-const mkFullPayload = ({ status, sides, documentId }) => {
+export const mkFullScanPayload = (scanOptions) => {
+    const defaultScanObject = {
+        file: null,
+        fileUploadUuid: null,
+        mimeType: "image/jpeg",
+        scanCreated: "2022-05-31T03:48:25.000+0000",
+        scanId: uuid(),
+        scanName: "dl-front.jpg",
+        side: "F",
+    };
+    return Scan.fromJSON(merge(defaultScanObject, scanOptions));
+};
+const mkFullPayload = (requestOptions, allMockOptions) => {
+    var _a;
+    const idType = allMockOptions.ocrRequests.detectedType;
+    const { status, ocrDocument } = requestOptions;
+    const scansOptions = (_a = ocrDocument === null || ocrDocument === void 0 ? void 0 : ocrDocument.scans) !== null && _a !== void 0 ? _a : [];
+    const scans = scansOptions.map(mkFullScanPayload).map((scan) => {
+        if (scan.side === "F")
+            scan.scanId = scanUuidFront;
+        if (scan.side === "B")
+            scan.scanId = scanUuidBack;
+        return scan;
+    });
     return {
         status,
-        ocrDocument: {
+        ocrDocument: merge({
             country: "AUS",
             dateOfBirth: null,
-            documentId,
+            documentId: uuid(),
             extraData: {},
             gender: null,
             idExpiry: "0001-01-01",
             idNumber: "P77864526",
             idSubType: null,
-            idType: "DRIVERS_LICENCE",
+            idType,
             ocrResult: {
                 status,
-                runDate: "2022-05-31T03:53:00.000+0000",
-                documentTypeInternal: "DRIVERS_LICENCE",
+                runDate: new Date().toISOString(),
+                documentTypeInternal: idType,
                 dateOfExpiry: "2031-05-28",
                 dateOfIssue: "2021-05-28",
-                documentType: "DRIVERS_LICENCE",
+                documentType: idType,
                 documentNumber: "999999999",
                 dateOfBirth: "1990-01-01",
                 nationality: null,
@@ -72,30 +95,7 @@ const mkFullPayload = ({ status, sides, documentId }) => {
                 mismatch: ["firstName", "lastName", "documentNumber", "dateOfBirth"],
             },
             region: "VIC",
-            scans: (() => {
-                const scans = [];
-                if (["all", "front"].includes(sides))
-                    scans.push({
-                        file: null,
-                        fileUploadUuid: null,
-                        mimeType: "image/jpeg",
-                        scanCreated: "2022-05-31T03:48:25.000+0000",
-                        scanId: scanUuidFront,
-                        scanName: "dl-front.jpg",
-                        side: "F",
-                    });
-                if (["all", "back"].includes(sides))
-                    scans.push({
-                        file: null,
-                        fileUploadUuid: null,
-                        mimeType: "image/jpeg",
-                        scanCreated: "2022-05-31T03:52:25.000+0000",
-                        scanId: scanUuidBack,
-                        scanName: "dl-back.jpg",
-                        side: "B",
-                    });
-                return scans;
-            })(),
+            scans: [],
             validation: {
                 electronic: {
                     isValid: true,
@@ -109,7 +109,11 @@ const mkFullPayload = ({ status, sides, documentId }) => {
                 electronic: null,
                 manual: null,
             },
-        },
+        }, ocrDocument, {
+            idType,
+            scans,
+            docScan: scans,
+        }),
     };
 };
-//# sourceMappingURL=driversLicence.js.map
+//# sourceMappingURL=ocrSubmission.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ocrSubmission.js","sourceRoot":"","sources":["../../../../../../modules/frankie-client/mocks/ocr/ocrSubmission.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,IAAI,EAAS,MAAM,uCAAuC,CAAC;AAChG,OAAO,KAAK,MAAM,cAAc,CAAC;AAEjC,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAIlC,OAAO,EAAyB,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAG/E,MAAM,aAAa,GAAG,IAAI,EAAE,CAAC;AAC7B,MAAM,YAAY,GAAG,IAAI,EAAE,CAAC;AAY5B,MAAM,UAAU,SAAS,CAAC,MAA6B,EAAE,OAAoB;IAC3E,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,UAAU,iBAAiB,CAAC,MAA6B,EAAE,OAAoB;IACnF,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,oBAAoB,SAAS,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE;QACjG,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;QAC7E,OAAO;YACL,KAAK,EAAE,GAAG;YACV,KAAK,EAAE,kBAAkB;YACzB,IAAI;YACJ,MAAM,EAAE,GAAG;SACZ,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAA6B,EAAE,OAAoB;IACnF,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,oBAAoB,SAAS,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,MAAM,EAAE,EAAE;QACtG,MAAM,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,sBAAsB,CAAC,KAAK,EAAE,CAAC;QACjF,MAAM,UAAU,GACd,MAAM,CAAC,IAAI,YAAY,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;QAC3F,IAAI,UAAU;YAAE,qBAAqB,CAAC,WAAW,CAAC,UAAU,GAAG,UAAU,CAAC;QAC1E,oDAAoD;QACpD,MAAM,IAAI,GAAG,aAAa,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;QAC3D,OAAO;YACL,KAAK,EAAE,yBAAyB;YAChC,KAAK,EAAE,GAAG;YACV,IAAI;YACJ,MAAM,EAAE,GAAG;SACZ,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,WAA8C,EAAQ,EAAE;IACxF,MAAM,iBAAiB,GAAe;QACpC,IAAI,EAAE,IAAI;QACV,cAAc,EAAE,IAAI;QACpB,QAAQ,EAAE,YAAY;QACtB,WAAW,EAAE,8BAA8B;QAC3C,MAAM,EAAE,IAAI,EAAE;QACd,QAAQ,EAAE,cAAc;QACxB,IAAI,EAAE,GAAG;KACV,CAAC;IAEF,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,iBAAiB,EAAE,WAAW,CAAU,CAAC,CAAC;AACvE,CAAC,CAAC;AACF,MAAM,aAAa,GAAG,CACpB,cAAkC,EAClC,cAA2B,EACwB,EAAE;;IACrD,MAAM,MAAM,GAAG,cAAc,CAAC,WAAW,CAAC,YAAY,CAAC;IACvD,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,cAAc,CAAC;IAC/C,MAAM,YAAY,GAAG,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,KAAK,mCAAI,EAAE,CAAC;IAC9C,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAC7D,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG;YAAE,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;QACnD,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG;YAAE,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC;QAClD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IACH,OAAO;QACL,MAAM;QACN,WAAW,EAAE,KAAK,CAChB;YACE,OAAO,EAAE,KAAK;YACd,WAAW,EAAE,IAAI;YACjB,UAAU,EAAE,IAAI,EAAE;YAClB,SAAS,EAAE,EAAE;YACb,MAAM,EAAE,IAAI;YACZ,QAAQ,EAAE,YAAY;YACtB,QAAQ,EAAE,WAAW;YACrB,SAAS,EAAE,IAAI;YACf,MAAM;YACN,SAAS,EAAE;gBACT,MAAM;gBACN,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACjC,oBAAoB,EAAE,MAAM;gBAC5B,YAAY,EAAE,YAAY;gBAC1B,WAAW,EAAE,YAAY;gBACzB,YAAY,EAAE,MAAM;gBACpB,cAAc,EAAE,WAAW;gBAC3B,WAAW,EAAE,YAAY;gBACzB,WAAW,EAAE,IAAI;gBACjB,YAAY,EAAE,IAAI;gBAClB,cAAc,EAAE,KAAK;gBACrB,KAAK,EAAE,KAAK;gBACZ,QAAQ,EAAE,MAAM;gBAChB,IAAI,EAAE,WAAW;gBACjB,MAAM,EAAE,mBAAmB;gBAC3B,SAAS,EAAE,OAAO;gBAClB,QAAQ,EAAE,cAAc;gBACxB,QAAQ,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,gBAAgB,EAAE,aAAa,CAAC;aACrE;YACD,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,EAAE;YACT,UAAU,EAAE;gBACV,UAAU,EAAE;oBACV,OAAO,EAAE,IAAI;oBACb,gBAAgB,EAAE,IAAI;iBACvB;gBACD,MAAM,EAAE;oBACN,OAAO,EAAE,IAAI;iBACd;aACF;YACD,QAAQ,EAAE;gBACR,UAAU,EAAE,IAAI;gBAChB,MAAM,EAAE,IAAI;aACb;SACF,EACD,WAAW,EACX;YACE,MAAM;YACN,KAAK;YACL,OAAO,EAAE,KAAK;SACf,CACkB;KACtB,CAAC;AACJ,CAAC,CAAC"}

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

@@ -0,0 +1,28 @@
+/**
+ * Exposes functions that offer a simplified conversion of MockOptions for external usage
+ */
+import { Applicant } from "../../common/shared/models/Applicant";
+import { Document, Scan, TScan } from "../../common/shared/models/Document";
+import { DeepPartial } from "../../common/shared/models/general";
+import { MockOptions } from ".";
+import { OCRDocumentType, Status } from "../clients/OCRClient";
+export declare function resolveSimplifiedMockOptions(simplifiedOptions: SimplifiedMockOptions): MockOptions;
+export declare const resolveSimplifiedPreloadedDocument: (partialDoc: PartialDocument, allOptions: SimplifiedMockOptions) => DeepPartial<Document>;
+export declare const resolveScans: (scansOptions: PartialDocument["scans"]) => Scan[];
+export declare type SimplifiedMockOptions = {
+    preloadedIndividual?: false | {
+        individual?: DeepPartial<Applicant>;
+        documents?: PartialDocument[];
+    };
+    ocrFlow?: {
+        detectedType: OCRDocumentType;
+        statusResults: Status[];
+    };
+};
+export declare type ScanSide = "F" | "B" | "both" | "none";
+export declare type ScanObject = DeepPartial<TScan> & {
+    side: "F" | "B";
+};
+export declare type PartialDocument = DeepPartial<Omit<Document, "scans">> & {
+    scans?: ScanSide | ScanObject[] | Scan[];
+};