@smileid/usesmileid 12.0.2 → 12.1.0

package/src/camera/__tests__/use_smile_id_frame_stream.test.ts

@@ -1,227 +0,0 @@
-import { describe, expect, it, vi } from "vitest";
-import { ZodError } from "zod";
-import { FrameProcessingException } from "@smileid/usesmileid_bridge";
-
-import { dispatchFrameResult } from "../use_smile_id_frame_stream";
-
-/**
- * Smallest schema-valid face wire payload — the shape the native
- * frame processor plugin returns to the worklet. The dispatcher runs
- * the real Zod parse, so these fixtures must satisfy
- * `faceScanResultSchema` (unlike the pre-plugin suite, which stubbed
- * the already-parsed result).
- */
-const validFaceWirePayload = {
-  output: { faces: [], brightness: 0.5 },
-  state: { type: "initial" },
-  capturedEvents: [],
-};
-
-const validDocumentWirePayload = {
-  output: { documents: [], brightness: 0.5 },
-  state: { type: "found" },
-  capturedEvents: [],
-};
-
-const faceAnalyzer = { kind: "face" } as const;
-const documentAnalyzer = { kind: "document" } as const;
-
-function makeBusyHandle(initial = false) {
-  let value = initial;
-  return {
-    isBusy: () => value,
-    setBusy: (next: boolean) => {
-      value = next;
-    },
-    peek: () => value,
-  };
-}
-
-describe("dispatchFrameResult", () => {
-  it("is a no-op when analyzer is null", () => {
-    const onResult = vi.fn();
-    const onError = vi.fn();
-    const busy = makeBusyHandle();
-
-    dispatchFrameResult({
-      raw: validFaceWirePayload,
-      analyzer: null,
-      isBusy: busy.isBusy,
-      setBusy: busy.setBusy,
-      isMounted: () => true,
-      onResult,
-      onError,
-    });
-
-    expect(onResult).not.toHaveBeenCalled();
-    expect(onError).not.toHaveBeenCalled();
-    expect(busy.peek()).toBe(false);
-  });
-
-  it("drops the result when dispatch is already busy (re-entrancy guard)", () => {
-    const onResult = vi.fn();
-    const busy = makeBusyHandle(true);
-
-    dispatchFrameResult({
-      raw: validFaceWirePayload,
-      analyzer: faceAnalyzer,
-      isBusy: busy.isBusy,
-      setBusy: busy.setBusy,
-      isMounted: () => true,
-      onResult,
-    });
-
-    expect(onResult).not.toHaveBeenCalled();
-    expect(busy.peek()).toBe(true);
-  });
-
-  it("parses a valid face payload and routes the typed result to onResult", () => {
-    const onResult = vi.fn();
-    const onError = vi.fn();
-    const busy = makeBusyHandle();
-
-    dispatchFrameResult({
-      raw: validFaceWirePayload,
-      analyzer: faceAnalyzer,
-      isBusy: busy.isBusy,
-      setBusy: busy.setBusy,
-      isMounted: () => true,
-      onResult,
-      onError,
-    });
-
-    expect(onError).not.toHaveBeenCalled();
-    expect(onResult).toHaveBeenCalledTimes(1);
-    expect(onResult.mock.calls[0]![0]).toEqual(validFaceWirePayload);
-    expect(busy.peek()).toBe(false);
-  });
-
-  it("parses a valid document payload through the document schema", () => {
-    const onResult = vi.fn();
-    const onError = vi.fn();
-    const busy = makeBusyHandle();
-
-    dispatchFrameResult({
-      raw: validDocumentWirePayload,
-      analyzer: documentAnalyzer,
-      isBusy: busy.isBusy,
-      setBusy: busy.setBusy,
-      isMounted: () => true,
-      onResult,
-      onError,
-    });
-
-    expect(onError).not.toHaveBeenCalled();
-    expect(onResult).toHaveBeenCalledTimes(1);
-    expect(onResult.mock.calls[0]![0]).toEqual(validDocumentWirePayload);
-  });
-
-  it("rejects a malformed plugin result with a ZodError and releases the busy flag", () => {
-    const onResult = vi.fn();
-    const onError = vi.fn();
-    const busy = makeBusyHandle();
-
-    dispatchFrameResult({
-      // Face payload routed through the document schema is the classic
-      // provider-mismatch drift — must surface as a typed schema error.
-      raw: validFaceWirePayload,
-      analyzer: documentAnalyzer,
-      isBusy: busy.isBusy,
-      setBusy: busy.setBusy,
-      isMounted: () => true,
-      onResult,
-      onError,
-    });
-
-    expect(onResult).not.toHaveBeenCalled();
-    expect(onError).toHaveBeenCalledTimes(1);
-    expect(onError.mock.calls[0]![0]).toBeInstanceOf(ZodError);
-    expect(busy.peek()).toBe(false);
-  });
-
-  it("maps a native error marker to FrameProcessingException", () => {
-    const onResult = vi.fn();
-    const onError = vi.fn();
-    const busy = makeBusyHandle();
-
-    dispatchFrameResult({
-      raw: { error: "session_not_configured" },
-      analyzer: faceAnalyzer,
-      isBusy: busy.isBusy,
-      setBusy: busy.setBusy,
-      isMounted: () => true,
-      onResult,
-      onError,
-    });
-
-    expect(onResult).not.toHaveBeenCalled();
-    expect(onError).toHaveBeenCalledTimes(1);
-    const error = onError.mock.calls[0]![0];
-    expect(error).toBeInstanceOf(FrameProcessingException);
-    expect((error as FrameProcessingException).message).toContain(
-      "session_not_configured",
-    );
-    expect((error as FrameProcessingException).isRetryable()).toBe(true);
-    expect(busy.peek()).toBe(false);
-  });
-
-  it("treats a non-string error key as a schema problem, not a marker", () => {
-    const onResult = vi.fn();
-    const onError = vi.fn();
-    const busy = makeBusyHandle();
-
-    dispatchFrameResult({
-      // `error: 42` is not a native marker — the payload falls through
-      // to schema validation and fails there instead.
-      raw: { error: 42 },
-      analyzer: faceAnalyzer,
-      isBusy: busy.isBusy,
-      setBusy: busy.setBusy,
-      isMounted: () => true,
-      onResult,
-      onError,
-    });
-
-    expect(onResult).not.toHaveBeenCalled();
-    expect(onError).toHaveBeenCalledTimes(1);
-    expect(onError.mock.calls[0]![0]).toBeInstanceOf(ZodError);
-  });
-
-  it("swallows results after the component unmounts", () => {
-    const onResult = vi.fn();
-    const onError = vi.fn();
-    const busy = makeBusyHandle();
-
-    dispatchFrameResult({
-      raw: validFaceWirePayload,
-      analyzer: faceAnalyzer,
-      isBusy: busy.isBusy,
-      setBusy: busy.setBusy,
-      isMounted: () => false,
-      onResult,
-      onError,
-    });
-
-    expect(onResult).not.toHaveBeenCalled();
-    expect(onError).not.toHaveBeenCalled();
-    expect(busy.peek()).toBe(false);
-  });
-
-  it("swallows errors after the component unmounts", () => {
-    const onError = vi.fn();
-    const busy = makeBusyHandle();
-
-    dispatchFrameResult({
-      raw: { error: "scan_failed: native crashed" },
-      analyzer: faceAnalyzer,
-      isBusy: busy.isBusy,
-      setBusy: busy.setBusy,
-      isMounted: () => false,
-      onResult: vi.fn(),
-      onError,
-    });
-
-    expect(onError).not.toHaveBeenCalled();
-    expect(busy.peek()).toBe(false);
-  });
-});

package/src/camera/__tests__/use_smile_id_frame_stream_hook.test.tsx

@@ -1,229 +0,0 @@
-import { describe, expect, it, vi } from "vitest";
-import * as React from "react";
-import { create as createRenderer, act } from "react-test-renderer";
-import type {
-  DocumentScanResult,
-  FaceScanResult,
-} from "@smileid/usesmileid_bridge";
-import { FrameProcessingException } from "@smileid/usesmileid_bridge";
-
-import {
-  useSmileIDFrameStream,
-  type UseSmileIDFrameStream,
-} from "../use_smile_id_frame_stream";
-
-/**
- * React-level companion to `use_smile_id_frame_stream.test.ts` (which
- * pins the pure dispatcher). These tests mount the hook so the ref
- * plumbing — analyzer / callback swaps between renders, the mounted
- * gate, and the memoised handle identity — is actually exercised.
- */
-
-const validFaceWirePayload = {
-  output: { faces: [], brightness: 0.5 },
-  state: { type: "initial" },
-  capturedEvents: [],
-};
-
-const validDocumentWirePayload = {
-  output: { documents: [], brightness: 0.5 },
-  state: { type: "found" },
-  capturedEvents: [],
-};
-
-type FaceAnalyzerStub = Parameters<typeof useSmileIDFrameStream>[0];
-
-const faceAnalyzer = { kind: "face" } as unknown as FaceAnalyzerStub;
-const documentAnalyzer = { kind: "document" } as unknown as FaceAnalyzerStub;
-
-type HarnessProps = {
-  readonly analyzer: FaceAnalyzerStub;
-  readonly onResult: (result: FaceScanResult) => void;
-  readonly onError?: (error: unknown) => void;
-  readonly onHandle: (handle: UseSmileIDFrameStream) => void;
-};
-
-function Harness({ analyzer, onResult, onError, onHandle }: HarnessProps) {
-  const handle = useSmileIDFrameStream(
-    analyzer,
-    onResult,
-    onError !== undefined ? { onError } : undefined,
-  );
-  onHandle(handle);
-  return null;
-}
-
-type Rendered = {
-  readonly tree: ReturnType<typeof createRenderer>;
-  readonly handles: UseSmileIDFrameStream[];
-  readonly latest: () => UseSmileIDFrameStream;
-};
-
-function mount(props: Omit<HarnessProps, "onHandle">): Rendered {
-  const handles: UseSmileIDFrameStream[] = [];
-  let tree!: ReturnType<typeof createRenderer>;
-  act(() => {
-    tree = createRenderer(
-      <Harness {...props} onHandle={(handle) => handles.push(handle)} />,
-    );
-  });
-  return {
-    tree,
-    handles,
-    latest: () => handles[handles.length - 1] as UseSmileIDFrameStream,
-  };
-}
-
-function update(
-  rendered: Rendered,
-  props: Omit<HarnessProps, "onHandle">,
-): void {
-  act(() => {
-    rendered.tree.update(
-      <Harness
-        {...props}
-        onHandle={(handle) => rendered.handles.push(handle)}
-      />,
-    );
-  });
-}
-
-describe("useSmileIDFrameStream", () => {
-  it("validates the raw wire payload and forwards the typed face result", () => {
-    const onResult = vi.fn();
-    const rendered = mount({ analyzer: faceAnalyzer, onResult });
-
-    act(() => {
-      rendered.latest().onFrameResult(validFaceWirePayload);
-    });
-
-    expect(onResult).toHaveBeenCalledTimes(1);
-    const result = onResult.mock.calls[0]?.[0] as FaceScanResult;
-    expect(result.state.type).toBe("initial");
-  });
-
-  it("parses against the document schema when the analyzer is a document one", () => {
-    const onResult = vi.fn();
-    const rendered = mount({
-      analyzer: documentAnalyzer,
-      onResult: onResult as unknown as (result: FaceScanResult) => void,
-    });
-
-    act(() => {
-      rendered.latest().onFrameResult(validDocumentWirePayload);
-    });
-
-    const result = onResult.mock.calls[0]?.[0] as DocumentScanResult;
-    expect(result.state.type).toBe("found");
-  });
-
-  it("keeps a stable handle across re-renders so the frame processor is not rebuilt", () => {
-    const onResult = vi.fn();
-    const rendered = mount({ analyzer: faceAnalyzer, onResult });
-    const first = rendered.latest();
-
-    update(rendered, { analyzer: faceAnalyzer, onResult: vi.fn() });
-
-    expect(rendered.latest()).toBe(first);
-    expect(rendered.latest().onFrameResult).toBe(first.onFrameResult);
-  });
-
-  it("routes results to the latest onResult after a swap", () => {
-    const first = vi.fn();
-    const second = vi.fn();
-    const rendered = mount({ analyzer: faceAnalyzer, onResult: first });
-
-    update(rendered, { analyzer: faceAnalyzer, onResult: second });
-    act(() => {
-      rendered.latest().onFrameResult(validFaceWirePayload);
-    });
-
-    expect(first).not.toHaveBeenCalled();
-    expect(second).toHaveBeenCalledTimes(1);
-  });
-
-  it("stops dispatching once the analyzer is detached", () => {
-    const onResult = vi.fn();
-    const rendered = mount({ analyzer: faceAnalyzer, onResult });
-
-    update(rendered, { analyzer: null, onResult });
-    act(() => {
-      rendered.latest().onFrameResult(validFaceWirePayload);
-    });
-
-    expect(onResult).not.toHaveBeenCalled();
-  });
-
-  it("reports a native error marker through the latest onError", () => {
-    const onResult = vi.fn();
-    const firstOnError = vi.fn();
-    const secondOnError = vi.fn();
-    const rendered = mount({
-      analyzer: faceAnalyzer,
-      onResult,
-      onError: firstOnError,
-    });
-
-    update(rendered, {
-      analyzer: faceAnalyzer,
-      onResult,
-      onError: secondOnError,
-    });
-    act(() => {
-      rendered.latest().onFrameResult({ error: "session crashed" });
-    });
-
-    expect(firstOnError).not.toHaveBeenCalled();
-    expect(secondOnError).toHaveBeenCalledTimes(1);
-    expect(secondOnError.mock.calls[0]?.[0]).toBeInstanceOf(
-      FrameProcessingException,
-    );
-    expect(onResult).not.toHaveBeenCalled();
-  });
-
-  it("swallows a schema rejection when no error handler is supplied", () => {
-    const onResult = vi.fn();
-    const rendered = mount({ analyzer: faceAnalyzer, onResult });
-
-    expect(() => {
-      act(() => {
-        rendered.latest().onFrameResult({ nonsense: true });
-      });
-    }).not.toThrow();
-    expect(onResult).not.toHaveBeenCalled();
-  });
-
-  it("drops results that arrive after unmount", () => {
-    const onResult = vi.fn();
-    const onError = vi.fn();
-    const rendered = mount({ analyzer: faceAnalyzer, onResult, onError });
-    const handle = rendered.latest();
-
-    act(() => {
-      rendered.tree.unmount();
-    });
-    handle.onFrameResult(validFaceWirePayload);
-    handle.onFrameResult({ error: "late failure" });
-
-    expect(onResult).not.toHaveBeenCalled();
-    expect(onError).not.toHaveBeenCalled();
-  });
-
-  it("gates re-entrant dispatch while a frame is in flight", () => {
-    const seen: string[] = [];
-    let handle: UseSmileIDFrameStream | null = null;
-    const onResult = vi.fn(() => {
-      seen.push("outer");
-      // A second frame arriving mid-dispatch must be dropped, not recursed into.
-      handle?.onFrameResult(validFaceWirePayload);
-    });
-    const rendered = mount({ analyzer: faceAnalyzer, onResult });
-    handle = rendered.latest();
-
-    act(() => {
-      handle?.onFrameResult(validFaceWirePayload);
-    });
-
-    expect(seen).toEqual(["outer"]);
-  });
-});

package/src/camera/camera_configuration.ts

@@ -1,32 +0,0 @@
-import type { CameraLens } from "./camera_lens";
-import type { CaptureType } from "../core/models/ml_config";
-
-/**
- * Camera-system configuration applied when the orchestrator starts.
- * All fields optional — see `CameraDefaults` for the values applied
- * when omitted.
- */
-export type CameraConfiguration = {
-  /** Front (default for selfie) or back. */
-  readonly lens?: CameraLens;
-  /** Hint to enable low-light boost on supported devices. */
-  readonly enableLowLightBoost?: boolean;
-  /** What we're capturing — drives default lens + still-capture mode. */
-  readonly captureType?: CaptureType;
-  /**
-   * Override the pinned frame rate. Partners normally accept the
-   * `CameraDefaults.analysisTargetFps` default (30 fps).
-   */
-  readonly fps?: number;
-};
-
-/**
- * Public-facing snapshot of the camera system's runtime state.
- * `subscribe()` on `UseSmileIDCameraSystem` notifies on every change.
- */
-export type CameraSystemState = {
-  readonly isCameraRunning: boolean;
-  readonly isStreaming: boolean;
-  readonly currentLens: CameraLens;
-  readonly hasPermission: boolean;
-};

package/src/camera/camera_defaults.ts

@@ -1,28 +0,0 @@
-/** Static camera tuning defaults. */
-export const CameraDefaults = {
-  /** Focus running indicator visibility duration (ms). */
-  focusRunningDurationMs: 600,
-  /** Focus settled indicator visibility duration (ms). */
-  focusSettledDurationMs: 500,
-
-  /** Pinned analysis-stream frame rate; 30 fps keeps motion smooth at low ISO. */
-  analysisTargetFps: 30,
-  /** Selfie analysis resolution (4:3 — the face/smile heuristics are calibrated on it). */
-  analysisTargetResolution: { width: 640, height: 480 } as const,
-  /** Document analysis resolution (16:9, matched to the visible preview so the guide-rect crop stays aligned). */
-  documentAnalysisResolution: { width: 1280, height: 720 } as const,
-
-  /** How long a streaming capture waits for its first analyzed frame before reporting the camera unavailable. */
-  firstFrameTimeoutMs: 10_000,
-
-  /** Longest-edge ceiling (px) for an imported document image; downscale-only. */
-  documentMaxDimension: 1600,
-  /** JPEG quality (0–1) for imported document images. */
-  documentJpegQuality: 0.85,
-  /** Minimum shortest-edge (px) for a gallery document image; smaller is rejected. */
-  minGalleryDocumentDimensionPx: 600,
-  /** Default selfie JPEG width (px); also the `image_width` metadata fallback. */
-  selfieJpegTargetWidth: 480,
-  /** Default selfie JPEG height (px); also the `image_height` metadata fallback. */
-  selfieJpegTargetHeight: 640,
-} as const;

package/src/camera/camera_lens.ts

@@ -1,13 +0,0 @@
-/**
- * Camera lens selector — `front` or `back`.
- *
- * The lowercase string values are what `useCameraDevice` from
- * `react-native-vision-camera` accepts as its position argument, so
- * the value passes through without translation.
- */
-export const CameraLens = {
-  front: "front",
-  back: "back",
-} as const;
-
-export type CameraLens = (typeof CameraLens)[keyof typeof CameraLens];

package/src/camera/camera_permissions.ts

@@ -1,36 +0,0 @@
-import { Camera } from "react-native-vision-camera";
-
-/**
- * Camera permission helpers.
- *
- * Wraps `react-native-vision-camera`'s permission API in a stable
- * shape the system class consumes. Does NOT auto-request — the caller
- * decides whether to prompt or fall through to a permission-denied
- * screen.
- */
-
-export type CameraPermissionStatus = "granted" | "denied" | "undetermined";
-
-/** Snapshot the current camera permission status without prompting. */
-export async function getCameraPermissionStatus(): Promise<CameraPermissionStatus> {
-  const status = Camera.getCameraPermissionStatus();
-  return mapPermissionStatus(status);
-}
-
-/**
- * Request camera permission, prompting if necessary. Returns the
- * resulting status; the caller should branch on `'granted'` before
- * starting the camera.
- */
-export async function requestCameraPermission(): Promise<CameraPermissionStatus> {
-  const status = await Camera.requestCameraPermission();
-  return mapPermissionStatus(status);
-}
-
-function mapPermissionStatus(
-  status: "granted" | "not-determined" | "denied" | "restricted",
-): CameraPermissionStatus {
-  if (status === "granted") return "granted";
-  if (status === "not-determined") return "undetermined";
-  return "denied";
-}

package/src/camera/camera_preview_image.ts

@@ -1,19 +0,0 @@
-/**
- * Frame envelope. The frame-processor pipeline streams raw RGBA
- * pixel buffers (`ArrayBuffer`) per frame; partners who want to
- * thread additional metadata alongside the bytes can use this type
- * to keep their call sites symmetric.
- */
-
-export type ViewBounds = {
-  readonly width: number;
-  readonly height: number;
-};
-
-export type CameraPreviewImage<T> = {
-  readonly image: T;
-  /** Preview surface size at the moment the frame was sampled. */
-  readonly viewBounds?: ViewBounds;
-  /** Device orientation in degrees (0/90/180/270) at sample time. */
-  readonly rotationDegrees: number;
-};

package/src/camera/document_image_pipeline.ts

@@ -1,101 +0,0 @@
-import { Directory, File, Paths } from "expo-file-system";
-import { ImageManipulator, SaveFormat } from "expo-image-manipulator";
-import {
-  DocumentSide,
-  UseSmileIDCrashReporting,
-} from "@smileid/usesmileid_bridge";
-import { CameraDefaults } from "./camera_defaults";
-import { computeDocumentResizeTarget } from "./document_resize_target";
-
-export { computeDocumentResizeTarget } from "./document_resize_target";
-
-/**
- * Imported document image pipeline — brings a manual-shutter still or gallery
- * image onto the SAME byte policy as the native auto-capture artifact: longest
- * edge downscaled to {@link CameraDefaults.documentMaxDimension} at
- * {@link CameraDefaults.documentJpegQuality}, written under the canonical
- * per-side filename. The Smile EXIF `UserComment` tag is stamped downstream by
- * `SmileExifTagger.finalize`, so every upload is byte-policy-identical
- * regardless of capture path.
- */
-
-/** Subdirectory under the cache directory holding imported document artifacts. */
-const IMPORT_SUBDIRECTORY = "usesmileid_documents";
-
-/** Canonical per-side artifact basename, matching the auto-capture naming. */
-export function documentArtifactFileName(side: DocumentSide): string {
-  return side === DocumentSide.Back
-    ? "document_back.jpg"
-    : "document_front.jpg";
-}
-
-/** Source image for an imported document capture (manual shutter or gallery). */
-export type ImportedDocumentSource = {
-  /** `file://` URI (or bare path) of the still / picked image. */
-  readonly uri: string;
-  /** Pixel dimensions when known. Omitted ⇒ re-encode at document quality without a resize (never upscaled). */
-  readonly width?: number;
-  readonly height?: number;
-};
-
-/**
- * Resample an imported document image and write it under the canonical per-side
- * filename. Returns the `file://` URI of the processed artifact.
- *
- * Canonical naming is best-effort: the native auto-capture session directory is
- * not exposed to JS, so the artifact lands in the app cache under the same
- * basename. On rename failure the resampled file's own URI is returned so the
- * byte-correct artifact is never lost — the backend validates the EXIF
- * image-type tag and JPEG bytes, not the containing directory.
- */
-export async function resampleImportedDocument(
-  source: ImportedDocumentSource,
-  side: DocumentSide,
-): Promise<string> {
-  const target =
-    source.width !== undefined && source.height !== undefined
-      ? computeDocumentResizeTarget(
-          source.width,
-          source.height,
-          CameraDefaults.documentMaxDimension,
-        )
-      : null;
-
-  const context = ImageManipulator.manipulate(source.uri);
-  if (target) {
-    context.resize(target);
-  }
-  const rendered = await context.renderAsync();
-  const result = await rendered.saveAsync({
-    compress: CameraDefaults.documentJpegQuality,
-    format: SaveFormat.JPEG,
-  });
-
-  return persistAsCanonicalArtifact(result.uri, side);
-}
-
-/** Move the resampled file to `<cache>/usesmileid_documents/document_<side>.jpg` (synchronous `expo-file-system` API). */
-function persistAsCanonicalArtifact(
-  resampledUri: string,
-  side: DocumentSide,
-): string {
-  try {
-    const directory = new Directory(Paths.cache, IMPORT_SUBDIRECTORY);
-    if (!directory.exists) {
-      directory.create({ intermediates: true });
-    }
-    const destination = new File(directory, documentArtifactFileName(side));
-    if (destination.exists) {
-      destination.delete();
-    }
-    new File(resampledUri).move(destination);
-    return destination.uri;
-  } catch (error) {
-    // Best-effort rename: a file-system error must not drop the byte-correct
-    // artifact. Surface non-fatal and fall back to the resampled file's URI.
-    UseSmileIDCrashReporting.captureException(
-      error instanceof Error ? error : new Error(String(error)),
-    );
-    return resampledUri;
-  }
-}