@smileid/usesmileid 12.0.2 → 12.1.0

package/src/presentation/flow/__tests__/document_flow_navigation.test.ts

@@ -1,484 +0,0 @@
-import { describe, expect, it, vi } from "vitest";
-import { DocumentSide } from "@smileid/usesmileid_bridge";
-import { FlowNavigationManager } from "../flow_navigation_manager";
-import {
-  CaptureType,
-  type DocumentCaptureConfigBuilder,
-  ScreensBuilder,
-  type ScreensConfig,
-} from "../dsl/builder/screens_builder";
-import type { FlowConfigurationSnapshot } from "../dsl/use_smile_id_flow_builder";
-import type { JobRequest } from "../../../data/model/job_request";
-import type { UseSmileIDRepository } from "../../../data/repository/use_smile_id_repository";
-import type { JobSubmissionResponse } from "../../../data/model/job_submission_response";
-import { success, type UseSmileIDResult } from "../../../core/models/result";
-import { JobType } from "../../../core/models/job_type";
-import { DocumentType } from "../../../core/models/document_type";
-import { DocumentImageOrigin } from "../../../metadata/document_image_origin";
-
-function buildScreens(block: (s: ScreensBuilder) => void): ScreensConfig {
-  const screensBuilder = new ScreensBuilder();
-  block(screensBuilder);
-  return screensBuilder.build();
-}
-
-function makeManager(
-  screens: ScreensConfig,
-  extra: Partial<FlowConfigurationSnapshot> = {},
-  repository?: UseSmileIDRepository,
-): FlowNavigationManager {
-  return new FlowNavigationManager({
-    configuration: { screens, onResult: () => {}, ...extra },
-    onExit: vi.fn(),
-    ...(repository ? { repository } : {}),
-  });
-}
-
-/** Two-sided document flow with a single per-side `preview {}`, then selfie. */
-function twoSidedDocumentFlow(): ScreensConfig {
-  return buildScreens((screens) => {
-    screens.instructions();
-    screens.capture((capture) => {
-      capture.captureType = CaptureType.document;
-      capture.document((document) => {
-        document.documentType = DocumentType.GenericDocument(); // hasBackSide
-        document.captureBothSides = true;
-        document.allowSkipBack = true;
-      });
-    });
-    screens.preview();
-    screens.capture((capture) => {
-      capture.captureType = CaptureType.selfie;
-    });
-    screens.processing();
-  });
-}
-
-const consentInfo = Object.freeze({
-  granted: true,
-  grantedAt: "2026-04-30T00:00:00.000Z",
-  noticeLanguage: "EN",
-  noticePrivacyPolicyUrl: "https://example.test/privacy",
-});
-
-const SAMPLE_USER_DETAILS = Object.freeze({
-  givenNames: "Jane",
-  lastName: "Doe",
-  email: "jane@example.test",
-  phoneNumber: "+2348000000000",
-});
-
-describe("FlowNavigationManager — document per-side preview loop", () => {
-  it("documentCapturesBack reflects the document type + captureBothSides", () => {
-    expect(makeManager(twoSidedDocumentFlow()).documentCapturesBack()).toBe(
-      true,
-    );
-
-    const greenBookFlow = buildScreens((screens) => {
-      screens.capture((capture) => {
-        capture.captureType = CaptureType.document;
-        capture.document((document) => {
-          document.documentType = DocumentType.SouthAfricaGreenBook; // no back side
-        });
-      });
-    });
-    expect(makeManager(greenBookFlow).documentCapturesBack()).toBe(false);
-  });
-
-  it("after the FRONT preview, routes back to the document capture for the BACK", () => {
-    const manager = makeManager(twoSidedDocumentFlow());
-    manager.navigateToNext(); // instructions → document capture
-    manager.setCapturedFrontDocument("file:///front.jpg");
-
-    // From the capture step the front simply advances to the preview.
-    expect(manager.getNextScreen()?.kind).toBe("preview");
-    manager.navigateToNext(); // → preview (front)
-
-    expect(manager.currentPreviewIsDocument()).toBe(true);
-    expect(manager.currentDocumentPreviewPath()).toBe("file:///front.jpg");
-
-    // The front preview loops back to the document capture for the back.
-    const next = manager.getNextScreen();
-    expect(next?.kind).toBe("capture");
-    expect(next?.kind === "capture" ? next.config.captureType : undefined).toBe(
-      CaptureType.document,
-    );
-  });
-
-  it("after the BACK preview, advances linearly to the selfie capture", () => {
-    const manager = makeManager(twoSidedDocumentFlow());
-    manager.navigateToNext(); // → document capture
-    manager.setCapturedFrontDocument("file:///front.jpg");
-    manager.navigateToNext(); // → preview (front)
-    manager.navigateToNext(); // → document capture (back)
-    manager.setCapturedBackDocument("file:///back.jpg");
-    expect(manager.getNextScreen()?.kind).toBe("preview");
-    manager.navigateToNext(); // → preview (back)
-
-    expect(manager.currentDocumentPreviewPath()).toBe("file:///back.jpg");
-    const next = manager.getNextScreen();
-    expect(next?.kind).toBe("capture");
-    expect(next?.kind === "capture" ? next.config.captureType : undefined).toBe(
-      CaptureType.selfie,
-    );
-  });
-
-  it("skipping the back side routes past the back capture's preview", () => {
-    const manager = makeManager(twoSidedDocumentFlow());
-    manager.navigateToNext(); // → document capture
-    manager.setCapturedFrontDocument("file:///front.jpg");
-    manager.skipDocumentBack();
-
-    // From the capture step (interstitial shown) Skip jumps past the preview.
-    const next = manager.getNextScreen();
-    expect(next?.kind).toBe("capture");
-    expect(next?.kind === "capture" ? next.config.captureType : undefined).toBe(
-      CaptureType.selfie,
-    );
-  });
-
-  it("with no document preview, still routes to the BACK capture after the front", () => {
-    // Regression: captureBothSides must capture the back even with no document
-    // preview { }, not jump straight to the selfie.
-    const noPreviewFlow = buildScreens((screens) => {
-      screens.instructions();
-      screens.capture((capture) => {
-        capture.captureType = CaptureType.document;
-        capture.document((document) => {
-          document.documentType = DocumentType.GenericDocument(); // hasBackSide
-          document.captureBothSides = true;
-          document.allowSkipBack = false;
-        });
-      });
-      screens.capture((capture) => {
-        capture.captureType = CaptureType.selfie;
-      });
-      screens.processing();
-    });
-    const manager = makeManager(noPreviewFlow);
-    manager.navigateToNext(); // instructions → document capture (front)
-    manager.setCapturedFrontDocument("file:///front.jpg");
-
-    // No preview follows → re-enter the document capture for the back side.
-    const next = manager.getNextScreen();
-    expect(next?.kind).toBe("capture");
-    expect(next?.kind === "capture" ? next.config.captureType : undefined).toBe(
-      CaptureType.document,
-    );
-
-    // After the back is captured, advance to the selfie.
-    manager.navigateToNext(); // → document capture (back)
-    manager.setCapturedBackDocument("file:///back.jpg");
-    const afterBack = manager.getNextScreen();
-    expect(
-      afterBack?.kind === "capture" ? afterBack.config.captureType : undefined,
-    ).toBe(CaptureType.selfie);
-  });
-
-  it("retakeCurrentDocumentSide clears the back first, then the front", () => {
-    const manager = makeManager(twoSidedDocumentFlow());
-    manager.setCapturedFrontDocument("file:///front.jpg");
-    manager.setCapturedBackDocument("file:///back.jpg");
-
-    manager.retakeCurrentDocumentSide();
-    expect(manager.captured.backDocumentPath).toBeUndefined();
-    expect(manager.captured.frontDocumentPath).toBe("file:///front.jpg");
-
-    manager.retakeCurrentDocumentSide();
-    expect(manager.captured.frontDocumentPath).toBeUndefined();
-  });
-
-  it("retaking the front un-skips the back so the loop runs again", () => {
-    const manager = makeManager(twoSidedDocumentFlow());
-    manager.navigateToNext(); // → document capture
-    manager.setCapturedFrontDocument("file:///front.jpg");
-    manager.skipDocumentBack();
-    manager.retakeCurrentDocumentSide(); // clears front + un-skips
-
-    manager.setCapturedFrontDocument("file:///front2.jpg");
-    manager.navigateToNext(); // → preview (front)
-    // Back pending again and no longer skipped → loops to the document capture.
-    expect(manager.getNextScreen()?.kind).toBe("capture");
-  });
-
-  it("a selfie preview is not treated as a document preview", () => {
-    const manager = makeManager(
-      buildScreens((screens) => {
-        screens.capture((capture) => {
-          capture.captureType = CaptureType.selfie;
-        });
-        screens.preview();
-      }),
-    );
-    manager.navigateToNext(); // selfie capture → preview
-    expect(manager.currentPreviewIsDocument()).toBe(false);
-  });
-});
-
-describe("FlowNavigationManager — document image origin metadata", () => {
-  const RESPONSE: JobSubmissionResponse = Object.freeze({
-    jobId: "job-1",
-    userId: "user-1",
-    status: "completed",
-    message: "ok",
-  });
-
-  class StubRepository implements UseSmileIDRepository {
-    readonly received: JobRequest[] = [];
-    result: UseSmileIDResult<JobSubmissionResponse> = success(RESPONSE);
-    submit(
-      request: JobRequest,
-    ): Promise<UseSmileIDResult<JobSubmissionResponse>> {
-      this.received.push(request);
-      return Promise.resolve(this.result);
-    }
-  }
-
-  it("stamps DocumentFront/BackImageOrigin onto the submitted metadata", () => {
-    const repository = new StubRepository();
-    const manager = makeManager(
-      buildScreens((screens) => screens.processing()),
-      {
-        documentVerificationParams: { country: "NG" },
-        userDetails: SAMPLE_USER_DETAILS,
-        network: {
-          config: {
-            jobType: JobType.documentVerification,
-            token: "k",
-            partnerConfig: {
-              partnerId: "p",
-              callbackUrl: "",
-              useSandbox: true,
-            },
-          },
-        },
-      },
-      repository,
-    );
-    manager.setCapturedSelfie("file:///selfie.jpg", ["file:///l1.jpg"]);
-    manager.setCapturedFrontDocument("file:///front.jpg");
-    manager.setCapturedBackDocument("file:///back.jpg");
-    manager.recordDocumentImageOrigin(
-      DocumentSide.Front,
-      DocumentImageOrigin.CameraManualCapture,
-    );
-    manager.recordDocumentImageOrigin(
-      DocumentSide.Back,
-      DocumentImageOrigin.Gallery,
-    );
-    manager.setConsent(consentInfo);
-
-    manager.beginSubmissionIfNeeded();
-
-    const request = repository.received[0]!;
-    const entries = request.metadata.toEntries();
-    expect(entries).toContainEqual({
-      name: "DocumentFrontImageOrigin",
-      value: "CameraManualCapture",
-    });
-    expect(entries).toContainEqual({
-      name: "DocumentBackImageOrigin",
-      value: "Gallery",
-    });
-  });
-
-  it("omits the back origin when only the front was captured", () => {
-    const repository = new StubRepository();
-    const manager = makeManager(
-      buildScreens((screens) => screens.processing()),
-      {
-        documentVerificationParams: { country: "NG" },
-        userDetails: SAMPLE_USER_DETAILS,
-        network: {
-          config: {
-            jobType: JobType.documentVerification,
-            token: "k",
-            partnerConfig: {
-              partnerId: "p",
-              callbackUrl: "",
-              useSandbox: true,
-            },
-          },
-        },
-      },
-      repository,
-    );
-    manager.setCapturedSelfie("file:///selfie.jpg", []);
-    manager.setCapturedFrontDocument("file:///front.jpg");
-    manager.recordDocumentImageOrigin(
-      DocumentSide.Front,
-      DocumentImageOrigin.CameraAutoCapture,
-    );
-    manager.setConsent(consentInfo);
-
-    manager.beginSubmissionIfNeeded();
-
-    const entries = repository.received[0]!.metadata.toEntries();
-    expect(
-      entries.some((entry) => entry.name === "DocumentFrontImageOrigin"),
-    ).toBe(true);
-    expect(
-      entries.some((entry) => entry.name === "DocumentBackImageOrigin"),
-    ).toBe(false);
-  });
-
-  it("stamps capture telemetry and image properties onto the submitted metadata", () => {
-    const repository = new StubRepository();
-    const manager = makeManager(
-      buildScreens((screens) => screens.processing()),
-      {
-        documentVerificationParams: { country: "NG" },
-        userDetails: SAMPLE_USER_DETAILS,
-        network: {
-          config: {
-            jobType: JobType.documentVerification,
-            token: "k",
-            partnerConfig: {
-              partnerId: "p",
-              callbackUrl: "",
-              useSandbox: true,
-            },
-          },
-        },
-      },
-      repository,
-    );
-    manager.setCapturedSelfie("file:///selfie.jpg", ["file:///l1.jpg"]);
-    manager.setCapturedFrontDocument("file:///front.jpg");
-    manager.recordSelfieCaptureTelemetry({
-      durationMs: 4200,
-      retries: 0,
-      cameraName: "com.apple.avfoundation:front",
-      devicePositions: ["1000,0.1,0.2,0.98", "1066,0.1,0.3,0.97"],
-      deviceMovementDetected: 0.35,
-    });
-    manager.recordDocumentCaptureTelemetry(DocumentSide.Front, {
-      durationMs: 5000,
-      retries: 1,
-      devicePositions: [],
-      deviceMovementDetected: null,
-    });
-    manager.setConsent(consentInfo);
-
-    manager.beginSubmissionIfNeeded();
-
-    const entries = repository.received[0]!.metadata.toEntries();
-    // Selfie: duration + retries (0 kept) + image color depth / pixel config.
-    expect(entries).toContainEqual({
-      name: "selfie_capture_duration_ms",
-      value: "4200",
-    });
-    expect(entries).toContainEqual({
-      name: "selfie_capture_retries",
-      value: "0",
-    });
-    expect(entries).toContainEqual({
-      name: "selfie_image_color_depth",
-      value: "24",
-    });
-    expect(entries).toContainEqual({
-      name: "selfie_image_pixel_config",
-      value: "RGB_888",
-    });
-    // Document front: telemetry + image color depth / pixel config. (Original/final compressed
-    // sizes are stamped in the repository around the compression pass, not by the flow manager.)
-    expect(entries).toContainEqual({
-      name: "document_front_capture_duration_ms",
-      value: "5000",
-    });
-    expect(entries).toContainEqual({
-      name: "document_front_capture_retries",
-      value: "1",
-    });
-    // Back side never captured → no back entries.
-    expect(
-      entries.some((entry) => entry.name === "document_back_capture_retries"),
-    ).toBe(false);
-    // Camera id from the telemetry.
-    expect(entries).toContainEqual({
-      name: "camera_name",
-      value: "com.apple.avfoundation:front",
-    });
-    // Accelerometer telemetry from the selfie capture.
-    expect(entries).toContainEqual({
-      name: "device_positions",
-      value: JSON.stringify(["1000,0.1,0.2,0.98", "1066,0.1,0.3,0.97"]),
-    });
-    expect(entries).toContainEqual({
-      name: "device_movement_detected",
-      value: "0.35",
-    });
-  });
-});
-
-describe("FlowNavigationManager — documentFrameAspectRatio", () => {
-  function documentFlow(
-    configure: (document: DocumentCaptureConfigBuilder) => void,
-  ): ScreensConfig {
-    return buildScreens((screens) => {
-      screens.capture((capture) => {
-        capture.captureType = CaptureType.document;
-        capture.document(configure);
-      });
-    });
-  }
-
-  it("uses the document type's own knownAspectRatio for presets", () => {
-    expect(
-      makeManager(
-        documentFlow((document) => {
-          document.documentType = DocumentType.Passport;
-        }),
-      ).documentFrameAspectRatio,
-    ).toBeCloseTo(356 / 272);
-
-    expect(
-      makeManager(
-        documentFlow((document) => {
-          document.documentType = DocumentType.SouthAfricaGreenBook;
-        }),
-      ).documentFrameAspectRatio,
-    ).toBeCloseTo(320 / 428);
-  });
-
-  it("falls back to the partner ratio, then the orientation default", () => {
-    // Generic landscape with no fixed ratio → landscape default.
-    expect(
-      makeManager(
-        documentFlow((document) => {
-          document.documentType = DocumentType.GenericDocument();
-        }),
-      ).documentFrameAspectRatio,
-    ).toBeCloseTo(1.586);
-
-    // A partner override wins when the type has no fixed ratio.
-    expect(
-      makeManager(
-        documentFlow((document) => {
-          document.documentType = DocumentType.GenericDocument();
-          document.knownIdAspectRatio = 1.4;
-        }),
-      ).documentFrameAspectRatio,
-    ).toBeCloseTo(1.4);
-
-    // Generic portrait with no fixed ratio → portrait default.
-    expect(
-      makeManager(
-        documentFlow((document) => {
-          document.documentType = DocumentType.GenericDocument({
-            orientation: "Portrait",
-          });
-        }),
-      ).documentFrameAspectRatio,
-    ).toBeCloseTo(0.65);
-  });
-
-  it("is undefined when the flow has no document capture step", () => {
-    const selfieFlow = buildScreens((screens) => {
-      screens.capture((capture) => {
-        capture.captureType = CaptureType.selfie;
-      });
-    });
-    expect(makeManager(selfieFlow).documentFrameAspectRatio).toBeUndefined();
-  });
-});