@smileid/usesmileid 12.0.1 → 12.1.0

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;
-  }
-}

package/src/presentation/flow/screen/helpers/__tests__/face_session_config.test.ts

@@ -1,115 +0,0 @@
-import { describe, expect, it } from "vitest";
-import type { FaceConfig } from "@smileid/usesmileid_bridge";
-import { EnhancedSmartSelfieConfig } from "@smileid/usesmileid_bridge";
-import { resolveFaceSessionConfig } from "../face_session_config";
-import type { SdkConfig } from "../../../../../data/model/sdk_config";
-
-const baseConfig: FaceConfig = {
-  analyzerFactoryKey: "mlkit-face",
-  selfieCaptureTimeout: 100_000,
-  numSamples: 8,
-  sampleInterval: 350,
-};
-
-describe("resolveFaceSessionConfig", () => {
-  it("keeps the profile-driven numSamples on the standard path", () => {
-    const resolved = resolveFaceSessionConfig(baseConfig, false);
-    expect(resolved.numSamples).toBe(8);
-    expect(resolved.enableEnhancedLiveness).toBe(false);
-  });
-
-  it("forces numSamples to the hold-still count under Enhanced Smart Selfie", () => {
-    // The native session adds the head-turn stills on top of numSamples.
-    const resolved = resolveFaceSessionConfig(baseConfig, true);
-    expect(resolved.numSamples).toBe(
-      EnhancedSmartSelfieConfig.HOLD_STILL_SAMPLE_COUNT,
-    );
-    expect(resolved.enableEnhancedLiveness).toBe(true);
-  });
-
-  it("preserves every other field of the base config", () => {
-    const resolved = resolveFaceSessionConfig(baseConfig, true);
-    expect(resolved.analyzerFactoryKey).toBe("mlkit-face");
-    expect(resolved.selfieCaptureTimeout).toBe(100_000);
-    expect(resolved.sampleInterval).toBe(350);
-  });
-
-  it("does not mutate the base config", () => {
-    resolveFaceSessionConfig(baseConfig, true);
-    expect(baseConfig.numSamples).toBe(8);
-    expect(baseConfig.enableEnhancedLiveness).toBeUndefined();
-  });
-});
-
-describe("resolveFaceSessionConfig — sdk_config overrides", () => {
-  const sdkConfig: SdkConfig = {
-    selfie: { width: 640, height: 480, quality: 90 },
-    liveness: { width: 320, height: 240, quality: 70 },
-    livenessImageCount: 5,
-  };
-
-  it("applies selfie dimensions from sdk_config", () => {
-    const resolved = resolveFaceSessionConfig(baseConfig, false, sdkConfig);
-    expect(resolved.selfieImageWidth).toBe(640);
-    expect(resolved.selfieImageHeight).toBe(480);
-  });
-
-  it("applies selfie JPEG quality from sdk_config", () => {
-    const resolved = resolveFaceSessionConfig(baseConfig, false, sdkConfig);
-    expect(resolved.selfieJpegQuality).toBe(90);
-  });
-
-  it("applies liveness dimensions from sdk_config", () => {
-    const resolved = resolveFaceSessionConfig(baseConfig, false, sdkConfig);
-    expect(resolved.livenessImageWidth).toBe(320);
-    expect(resolved.livenessImageHeight).toBe(240);
-  });
-
-  it("applies liveness JPEG quality from sdk_config", () => {
-    const resolved = resolveFaceSessionConfig(baseConfig, false, sdkConfig);
-    expect(resolved.livenessJpegQuality).toBe(70);
-  });
-
-  it("applies livenessImageCount as numSamples (+1) when not ESS", () => {
-    // livenessImageCount: 5 → numSamples = 6
-    const resolved = resolveFaceSessionConfig(baseConfig, false, sdkConfig);
-    expect(resolved.numSamples).toBe(6);
-  });
-
-  it("suppresses livenessImageCount override under Enhanced Smart Selfie", () => {
-    // ESS manages its own capture count — the sdk_config override must
-    // not bleed through and change numSamples.
-    const resolved = resolveFaceSessionConfig(baseConfig, true, sdkConfig);
-    expect(resolved.numSamples).toBe(
-      EnhancedSmartSelfieConfig.HOLD_STILL_SAMPLE_COUNT,
-    );
-  });
-
-  it("omits selfie dimension fields when the pair rule fails (width-only)", () => {
-    const halfConfig: SdkConfig = { selfie: { width: 640 } };
-    const resolved = resolveFaceSessionConfig(baseConfig, false, halfConfig);
-    expect(resolved.selfieImageWidth).toBeUndefined();
-    expect(resolved.selfieImageHeight).toBeUndefined();
-  });
-
-  it("falls back to base numSamples when livenessImageCount is absent", () => {
-    const noCount: SdkConfig = { selfie: { quality: 85 } };
-    const resolved = resolveFaceSessionConfig(baseConfig, false, noCount);
-    // Base config has numSamples: 8 — should be preserved.
-    expect(resolved.numSamples).toBe(8);
-  });
-
-  it("does not set dimension fields when sdk_config is undefined", () => {
-    const resolved = resolveFaceSessionConfig(baseConfig, false, undefined);
-    expect(resolved.selfieImageWidth).toBeUndefined();
-    expect(resolved.selfieImageHeight).toBeUndefined();
-    expect(resolved.livenessImageWidth).toBeUndefined();
-    expect(resolved.livenessImageHeight).toBeUndefined();
-  });
-
-  it("does not mutate the base config when sdk_config is supplied", () => {
-    resolveFaceSessionConfig(baseConfig, false, sdkConfig);
-    expect(baseConfig.numSamples).toBe(8);
-    expect(baseConfig.selfieImageWidth).toBeUndefined();
-  });
-});

package/src/presentation/flow/screen/helpers/face_session_config.ts

@@ -1,77 +0,0 @@
-import type { FaceConfig } from "@smileid/usesmileid_bridge";
-import { enhancedSmartSelfieNumSamples } from "@smileid/usesmileid_bridge";
-import type { SdkConfig } from "../../../../data/model/sdk_config";
-import { numSamplesOverride } from "../../../../data/model/sdk_config";
-import {
-  resolveDimensions,
-  resolveJpegQuality,
-} from "../../../../data/model/sdk_config_capture";
-
-/**
- * Merge the screen-level Enhanced Smart Selfie flag and any decoded
- * `sdk_config` settings into the registry-built base config.
- *
- * Applied overrides (when `sdkConfig` is present):
- *   - Selfie capture dimensions (`selfieImageWidth` / `selfieImageHeight`):
- *     pair-fallback rule — both must be present and `> 0`.
- *   - Selfie JPEG quality (`selfieJpegQuality`): integer `1..100`.
- *   - Liveness capture dimensions (`livenessImageWidth` / `livenessImageHeight`):
- *     same pair rule.
- *   - Liveness JPEG quality (`livenessJpegQuality`): integer `1..100`.
- *   - `numSamples` from `livenessImageCount + 1`: suppressed when ESS is
- *     active (head-turn manages its own count). Falls back to the base
- *     config's `numSamples` (set from `ScanPerformanceProfile`) when the
- *     claim is absent or invalid.
- *
- * `faceConfigSchema` re-applies the ESS frame-count pin at every
- * `configure()` boundary, so direct `analyzer.configure()` callers are
- * equally safe; applying the pin here keeps the orchestrator's resolved
- * config honest for logging and tests.
- */
-export function resolveFaceSessionConfig(
-  baseConfig: FaceConfig,
-  enableEnhancedLiveness: boolean,
-  sdkConfig?: SdkConfig,
-): FaceConfig {
-  const selfieDims = resolveDimensions(sdkConfig?.selfie);
-  const livenessDims = resolveDimensions(sdkConfig?.liveness);
-  const selfieQuality = resolveJpegQuality(sdkConfig?.selfie);
-  const livenessQuality = resolveJpegQuality(sdkConfig?.liveness);
-
-  // Suppress the liveness-count override when ESS is active — the
-  // head-turn flow manages its own capture count internally.
-  const resolvedNumSamples =
-    (!enableEnhancedLiveness ? numSamplesOverride(sdkConfig) : undefined) ??
-    baseConfig.numSamples;
-
-  return enhancedSmartSelfieNumSamples({
-    ...baseConfig,
-    enableEnhancedLiveness,
-    // Selfie dimensions — spread only when the pair resolves.
-    ...(selfieDims !== undefined
-      ? {
-          selfieImageWidth: selfieDims.width,
-          selfieImageHeight: selfieDims.height,
-        }
-      : {}),
-    // Selfie JPEG quality — spread only when the value is in range.
-    ...(selfieQuality !== undefined
-      ? { selfieJpegQuality: selfieQuality }
-      : {}),
-    // Liveness dimensions — spread only when the pair resolves.
-    ...(livenessDims !== undefined
-      ? {
-          livenessImageWidth: livenessDims.width,
-          livenessImageHeight: livenessDims.height,
-        }
-      : {}),
-    // Liveness JPEG quality — spread only when the value is in range.
-    ...(livenessQuality !== undefined
-      ? { livenessJpegQuality: livenessQuality }
-      : {}),
-    // numSamples from sdk_config (suppressed for ESS; falls back to profile).
-    ...(resolvedNumSamples !== undefined
-      ? { numSamples: resolvedNumSamples }
-      : {}),
-  });
-}