@smileid/usesmileid 12.0.2 → 12.1.0

package/src/presentation/flow/graph/__tests__/screen_renderer.test.tsx

@@ -1,102 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from "vitest";
-import * as React from "react";
-import { create as createRenderer, act } from "react-test-renderer";
-
-// `vi.mock` is hoisted above the imports, so anything its factory closes over
-// must be created with `vi.hoisted` or it is still in the TDZ when the factory
-// runs.
-const { dispatched } = vi.hoisted(() => ({
-  dispatched: {
-    current: undefined as
-      | { screen: string; configuration: unknown }
-      | undefined,
-  },
-}));
-
-function stub(screen: string) {
-  return ({ configuration }: { configuration: unknown }) => {
-    dispatched.current = { screen, configuration };
-    return null;
-  };
-}
-
-// Stand in for every orchestrated screen: this suite asserts the switch routes
-// each step kind (and its config) to the right screen — each screen has its own
-// suite for what it then does with that config.
-vi.mock("../../screen/orchestrated_capture_screen", () => ({
-  OrchestratedCaptureScreen: stub("capture"),
-}));
-vi.mock("../../screen/orchestrated_consent_screen", () => ({
-  OrchestratedConsentScreen: stub("consent"),
-}));
-vi.mock("../../screen/orchestrated_instructions_screen", () => ({
-  OrchestratedInstructionsScreen: stub("instructions"),
-}));
-vi.mock("../../screen/orchestrated_preview_screen", () => ({
-  OrchestratedPreviewScreen: stub("preview"),
-}));
-vi.mock("../../screen/orchestrated_processing_screen", () => ({
-  OrchestratedProcessingScreen: stub("processing"),
-}));
-
-import { ScreenRenderer } from "../screen_renderer";
-import {
-  CaptureType,
-  ScreensBuilder,
-  type ScreenSpec,
-} from "../../dsl/builder/screens_builder";
-
-const steps: readonly ScreenSpec[] = (() => {
-  const screensBuilder = new ScreensBuilder();
-  screensBuilder.consent();
-  screensBuilder.instructions();
-  screensBuilder.capture((capture) => {
-    capture.captureType = CaptureType.selfie;
-  });
-  screensBuilder.preview();
-  screensBuilder.processing();
-  return screensBuilder.build().steps;
-})();
-
-function stepOfKind(kind: ScreenSpec["kind"]): ScreenSpec {
-  const step = steps.find((candidate) => candidate.kind === kind);
-  if (!step) throw new Error(`no ${kind} step built`);
-  return step;
-}
-
-function render(step: ScreenSpec) {
-  act(() => {
-    createRenderer(<ScreenRenderer step={step} />);
-  });
-  const current = dispatched.current;
-  if (!current) throw new Error("ScreenRenderer dispatched nothing");
-  return current;
-}
-
-beforeEach(() => {
-  dispatched.current = undefined;
-});
-
-describe("ScreenRenderer", () => {
-  it.each([
-    ["consent"],
-    ["instructions"],
-    ["capture"],
-    ["preview"],
-    ["processing"],
-  ] as const)("routes a %s step to its orchestrated screen", (kind) => {
-    const step = stepOfKind(kind);
-    const result = render(step);
-
-    expect(result.screen).toBe(kind);
-    expect(result.configuration).toBe(step.config);
-  });
-
-  it("hands each step its own config object, not a shared one", () => {
-    const capture = render(stepOfKind("capture")).configuration;
-    const preview = render(stepOfKind("preview")).configuration;
-
-    expect(capture).not.toBe(preview);
-    expect(capture).toBe(stepOfKind("capture").config);
-  });
-});

package/src/presentation/flow/graph/screen_renderer.tsx

@@ -1,35 +0,0 @@
-import type { ScreenSpec } from "../dsl/builder/screens_builder";
-import { OrchestratedCaptureScreen } from "../screen/orchestrated_capture_screen";
-import { OrchestratedConsentScreen } from "../screen/orchestrated_consent_screen";
-import { OrchestratedInstructionsScreen } from "../screen/orchestrated_instructions_screen";
-import { OrchestratedPreviewScreen } from "../screen/orchestrated_preview_screen";
-import { OrchestratedProcessingScreen } from "../screen/orchestrated_processing_screen";
-
-export type ScreenRendererProps = {
-  readonly step: ScreenSpec;
-};
-
-/**
- * Internal switch-on-kind dispatcher. Routes the active step's
- * configuration to the matching `OrchestratedXxxScreen` — which then
- * wraps the visual screen in a `UseSmileIDOrchestratedScreenHost`
- * and wires the navigation manager callbacks.
- *
- * Theme + localization providers are mounted higher up in
- * `<UseSmileIDBuilder>` so every orchestrated screen reads them via
- * context.
- */
-export function ScreenRenderer({ step }: ScreenRendererProps) {
-  switch (step.kind) {
-    case "instructions":
-      return <OrchestratedInstructionsScreen configuration={step.config} />;
-    case "consent":
-      return <OrchestratedConsentScreen configuration={step.config} />;
-    case "capture":
-      return <OrchestratedCaptureScreen configuration={step.config} />;
-    case "preview":
-      return <OrchestratedPreviewScreen configuration={step.config} />;
-    case "processing":
-      return <OrchestratedProcessingScreen configuration={step.config} />;
-  }
-}

package/src/presentation/flow/job_submission_state.ts

@@ -1,17 +0,0 @@
-import type { JobSubmissionResponse } from "../../data/model/job_submission_response";
-
-/**
- * In-flight job-submission state owned by `FlowNavigationManager`.
- *
- * `notAttempted` is the freshly-mounted state that
- * `beginSubmissionIfNeeded()` guards on for idempotency. `loading`
- * is set the moment submission kicks off so re-renders don't re-fire
- * the request. `success` carries the server response so the
- * processing screen can display the message; `failure` carries the
- * already-mapped `Error` from `UseSmileIDRepositoryImpl._mapError`.
- */
-export type JobSubmissionState =
-  | { readonly kind: "notAttempted" }
-  | { readonly kind: "loading" }
-  | { readonly kind: "success"; readonly response: JobSubmissionResponse }
-  | { readonly kind: "failure"; readonly error: Error };

package/src/presentation/flow/model/instruction_guideline.ts

@@ -1,21 +0,0 @@
-import type { FC } from "react";
-import type { UseSmileIDLocalizations } from "../../../l10n/use_smile_id_localizations";
-
-/** Whether a guideline depicts an allowed condition or a blocked one. */
-export type GuidelineStatus = "allowed" | "blocked";
-
-/**
- * A capture-guideline tile's data. `label` is a resolver (not a string) so the
- * shared default list can be allocated once without a render context.
- */
-export type InstructionGuideline = {
-  readonly image: FC<{ readonly width?: number; readonly height?: number }>;
-  readonly label: (localizations: UseSmileIDLocalizations) => string;
-  readonly status: GuidelineStatus;
-  /**
-   * Visible-card size (device-independent px) for a self-contained document
-   * illustration (the SVG paints its own card). Set ⇒ document-card tile;
-   * omitted ⇒ selfie tile (framed card + pill).
-   */
-  readonly card?: { readonly width: number; readonly height: number };
-};

package/src/presentation/flow/model/instructions_defaults.ts

@@ -1,198 +0,0 @@
-import type { AnimationObject } from "lottie-react-native";
-import {
-  SiGuidelineAccessories,
-  SiGuidelineDocumentGenericGood,
-  SiGuidelineDocumentGenericNotBlurry,
-  SiGuidelineDocumentGenericNotCropped,
-  SiGuidelineDocumentGenericNotReflective,
-  SiGuidelineDocumentGreenBookGood,
-  SiGuidelineDocumentGreenBookNotBlurry,
-  SiGuidelineDocumentGreenBookNotCropped,
-  SiGuidelineDocumentGreenBookNotReflective,
-  SiGuidelineDocumentPassportGood,
-  SiGuidelineDocumentPassportNotBlurry,
-  SiGuidelineDocumentPassportNotCropped,
-  SiGuidelineDocumentPassportNotReflective,
-  SiGuidelineGood,
-  SiGuidelineMultipleFaces,
-  SiGuidelinePoorLighting,
-} from "../../components/icons";
-import type { DocumentType } from "../../../core/models/document_type";
-import type { InstructionGuideline } from "./instruction_guideline";
-
-/** Lottie source accepted for the instructions hero animation. */
-export type HeroAnimationSource =
-  | AnimationObject
-  | string
-  | { readonly uri: string };
-
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-export const SELFIE_HERO_ANIMATION =
-  require("../../assets/si_selfie_hero_animation.json") as AnimationObject;
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-export const ESS_HERO_ANIMATION =
-  require("../../assets/si_ess_all_directions_hero_animation.json") as AnimationObject;
-
-// Document hero animations — per-document-type front instruction heroes, plus
-// the back-of-ID (flip) hero shown on the back-capture interstitial.
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-export const DOCUMENT_HERO_ANIMATION =
-  require("../../assets/si_document_hero_animation.json") as AnimationObject;
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-export const DOCUMENT_PASSPORT_HERO_ANIMATION =
-  require("../../assets/si_document_passport_hero_animation.json") as AnimationObject;
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-export const DOCUMENT_GREEN_BOOK_HERO_ANIMATION =
-  require("../../assets/si_document_green_book_hero_animation.json") as AnimationObject;
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-export const DOCUMENT_HERO_BACK_ANIMATION =
-  require("../../assets/si_document_hero_back_animation.json") as AnimationObject;
-
-const SELFIE_GUIDELINE_ENTRIES: InstructionGuideline[] = [
-  {
-    image: SiGuidelineGood,
-    label: (localizations) => localizations.siInstructionsGuidelineGood,
-    status: "allowed",
-  },
-  {
-    image: SiGuidelineAccessories,
-    label: (localizations) => localizations.siInstructionsGuidelineAccessories,
-    status: "blocked",
-  },
-  {
-    image: SiGuidelineMultipleFaces,
-    label: (localizations) =>
-      localizations.siInstructionsGuidelineMultipleFaces,
-    status: "blocked",
-  },
-  {
-    image: SiGuidelinePoorLighting,
-    label: (localizations) => localizations.siInstructionsGuidelinePoorLighting,
-    status: "blocked",
-  },
-];
-
-/**
- * Default Smart Selfie capture guidelines — allocated once and deeply frozen
- * (array + each entry) so the shared default never churns and can't be
- * mutated by a caller.
- */
-export const SELFIE_GUIDELINES: readonly InstructionGuideline[] = Object.freeze(
-  SELFIE_GUIDELINE_ENTRIES.map((guideline) => Object.freeze(guideline)),
-);
-
-// Visible card size (device-independent px) per document guideline tile.
-const DOCUMENT_CARD_LANDSCAPE = Object.freeze({ width: 80, height: 56 });
-const DOCUMENT_CARD_PORTRAIT = Object.freeze({ width: 60, height: 84 });
-
-type DocumentGuidelineImages = {
-  readonly good: InstructionGuideline["image"];
-  readonly notCropped: InstructionGuideline["image"];
-  readonly notBlurry: InstructionGuideline["image"];
-  readonly notReflective: InstructionGuideline["image"];
-};
-
-/**
- * Build the four document-capture guidelines (good + not cropped / blurry /
- * reflective) for one document type. The order and labels are shared; only the
- * per-type artwork and card size differ. Allocated once and deeply frozen.
- */
-function buildDocumentGuidelines(
-  images: DocumentGuidelineImages,
-  card: { readonly width: number; readonly height: number },
-): readonly InstructionGuideline[] {
-  const entries: InstructionGuideline[] = [
-    {
-      image: images.good,
-      label: (localizations) => localizations.siDocumentGuidelineGood,
-      status: "allowed",
-      card,
-    },
-    {
-      image: images.notCropped,
-      label: (localizations) => localizations.siDocumentGuidelineNotCropped,
-      status: "blocked",
-      card,
-    },
-    {
-      image: images.notBlurry,
-      label: (localizations) => localizations.siDocumentGuidelineNotBlurry,
-      status: "blocked",
-      card,
-    },
-    {
-      image: images.notReflective,
-      label: (localizations) => localizations.siDocumentGuidelineNotReflective,
-      status: "blocked",
-      card,
-    },
-  ];
-  return Object.freeze(entries.map((guideline) => Object.freeze(guideline)));
-}
-
-/** Generic-document capture guidelines (landscape card). */
-export const DOCUMENT_GUIDELINES_GENERIC = buildDocumentGuidelines(
-  {
-    good: SiGuidelineDocumentGenericGood,
-    notCropped: SiGuidelineDocumentGenericNotCropped,
-    notBlurry: SiGuidelineDocumentGenericNotBlurry,
-    notReflective: SiGuidelineDocumentGenericNotReflective,
-  },
-  DOCUMENT_CARD_LANDSCAPE,
-);
-
-/** Passport capture guidelines (landscape card). */
-export const DOCUMENT_GUIDELINES_PASSPORT = buildDocumentGuidelines(
-  {
-    good: SiGuidelineDocumentPassportGood,
-    notCropped: SiGuidelineDocumentPassportNotCropped,
-    notBlurry: SiGuidelineDocumentPassportNotBlurry,
-    notReflective: SiGuidelineDocumentPassportNotReflective,
-  },
-  DOCUMENT_CARD_LANDSCAPE,
-);
-
-/** South Africa green book capture guidelines (portrait card). */
-export const DOCUMENT_GUIDELINES_GREEN_BOOK = buildDocumentGuidelines(
-  {
-    good: SiGuidelineDocumentGreenBookGood,
-    notCropped: SiGuidelineDocumentGreenBookNotCropped,
-    notBlurry: SiGuidelineDocumentGreenBookNotBlurry,
-    notReflective: SiGuidelineDocumentGreenBookNotReflective,
-  },
-  DOCUMENT_CARD_PORTRAIT,
-);
-
-/**
- * Resolve the document-capture guidelines for a document type. Falls back to
- * the generic set when the type is unset or has no dedicated artwork.
- */
-export function documentGuidelines(
-  documentType: DocumentType | undefined,
-): readonly InstructionGuideline[] {
-  switch (documentType?.kind) {
-    case "southAfricaGreenBook":
-      return DOCUMENT_GUIDELINES_GREEN_BOOK;
-    case "passport":
-      return DOCUMENT_GUIDELINES_PASSPORT;
-    default:
-      return DOCUMENT_GUIDELINES_GENERIC;
-  }
-}
-
-/**
- * Resolve the document hero animation for a document type. Falls back to the
- * generic document hero when the type is unset or has no dedicated animation.
- */
-export function documentHeroAnimation(
-  documentType: DocumentType | undefined,
-): AnimationObject {
-  switch (documentType?.kind) {
-    case "southAfricaGreenBook":
-      return DOCUMENT_GREEN_BOOK_HERO_ANIMATION;
-    case "passport":
-      return DOCUMENT_PASSPORT_HERO_ANIMATION;
-    default:
-      return DOCUMENT_HERO_ANIMATION;
-  }
-}