@smileid/usesmileid 12.0.0 → 12.0.1

package/src/testing/scenario_loader.ts

@@ -0,0 +1,83 @@
+import type {
+  ScriptedScenario,
+  ScriptedScenarioStep,
+} from "./fake_face_analyzer";
+
+/**
+ * Emission vocabulary of the shared `e2e-scenarios` schema (`schema.json` in
+ * every repo's scenario folder). A step whose `emit` is outside this set is a
+ * drift bug — the loader rejects it rather than letting the fake silently treat
+ * it as "no detection".
+ */
+const KNOWN_EMITS: ReadonlySet<string> = new Set([
+  "noFace",
+  "faceTooFar",
+  "faceCentered",
+  "headTurnLeft",
+  "headTurnRight",
+  "headTurnUp",
+  "satisfied",
+  "noDocument",
+  "documentFound",
+  "documentUnstable",
+]);
+
+const CAPTURE_TYPES: ReadonlySet<string> = new Set(["selfie", "document"]);
+
+/**
+ * Validates a parsed shared-scenario JSON object and returns the typed
+ * [ScriptedScenario]. Kept I/O-free (takes an already-parsed object) so the
+ * `@smileid/usesmileid/testing` subpath stays environment-agnostic — the caller
+ * owns how the JSON is read. Throws with a specific message on any shape drift
+ * so a malformed or vocabulary-drifted script fails loudly at load time instead
+ * of producing a misleading capture sequence.
+ */
+export function parseScriptedScenario(raw: unknown): ScriptedScenario {
+  if (typeof raw !== "object" || raw === null) {
+    throw new Error("scenario must be a JSON object");
+  }
+  const record = raw as Record<string, unknown>;
+
+  const name = record.name;
+  if (typeof name !== "string" || name.length === 0) {
+    throw new Error("scenario.name must be a non-empty string");
+  }
+
+  const captureType = record.captureType;
+  if (typeof captureType !== "string" || !CAPTURE_TYPES.has(captureType)) {
+    throw new Error(
+      `scenario.captureType must be one of ${[...CAPTURE_TYPES].join(", ")}, got ${String(captureType)}`,
+    );
+  }
+
+  if (!Array.isArray(record.steps) || record.steps.length === 0) {
+    throw new Error(`scenario.steps must be a non-empty array in ${name}`);
+  }
+
+  const steps: ScriptedScenarioStep[] = record.steps.map((step, index) => {
+    if (typeof step !== "object" || step === null) {
+      throw new Error(`scenario.steps[${index}] must be an object in ${name}`);
+    }
+    const stepRecord = step as Record<string, unknown>;
+    const emit = stepRecord.emit;
+    if (typeof emit !== "string" || !KNOWN_EMITS.has(emit)) {
+      throw new Error(
+        `scenario.steps[${index}].emit "${String(emit)}" is not a known emission in ${name}`,
+      );
+    }
+    const holdFrames = stepRecord.holdFrames;
+    if (
+      holdFrames !== undefined &&
+      (typeof holdFrames !== "number" ||
+        !Number.isInteger(holdFrames) ||
+        holdFrames < 1)
+    ) {
+      throw new Error(
+        `scenario.steps[${index}].holdFrames must be a positive integer in ${name}`,
+      );
+    }
+    return holdFrames === undefined ? { emit } : { emit, holdFrames };
+  });
+
+  return { name, captureType, steps };
+}

package/src/testing/scripted_scan_results.ts

@@ -0,0 +1,66 @@
+import {
+  CaptureReadyEventKind,
+  UseSmileIDScanStateType,
+} from "@smileid/usesmileid_bridge";
+import type {
+  CaptureReadyEvent,
+  FaceScanResult,
+} from "@smileid/usesmileid_bridge";
+import type { ScriptedScenario } from "./fake_face_analyzer";
+
+/**
+ * Turns a shared E2E scenario into the `FaceScanResult` sequence a capture
+ * screen receives frame-by-frame, so a headless test can replay the shared
+ * script through the frame stream's `onResult` seam (per-frame detection is a
+ * native frame-processor concern; pixels never reach JS).
+ *
+ * `noFace` → `initial`; `faceTooFar` / `faceCentered` → `found`; the terminal
+ * `satisfied` → one `finished` result carrying a `selfie` event plus
+ * [livenessCount] `liveness` events at opaque `file://` URLs the screen never
+ * reads. Exported only behind the `@smileid/usesmileid/testing` subpath.
+ */
+export function scriptedFaceScanResults(
+  scenario: ScriptedScenario,
+  options: { readonly livenessCount?: number } = {},
+): FaceScanResult[] {
+  const livenessCount = options.livenessCount ?? 2;
+  const output: FaceScanResult["output"] = { faces: [], brightness: 128 };
+  const results: FaceScanResult[] = [];
+
+  for (const step of scenario.steps) {
+    if (step.emit === "satisfied") {
+      results.push({
+        output,
+        state: { type: UseSmileIDScanStateType.Finished },
+        capturedEvents: captureEvents(livenessCount),
+      });
+      return results;
+    }
+    const type =
+      step.emit === "noFace"
+        ? UseSmileIDScanStateType.Initial
+        : UseSmileIDScanStateType.Found;
+    for (let frame = 0; frame < (step.holdFrames ?? 1); frame++) {
+      results.push({ output, state: { type }, capturedEvents: [] });
+    }
+  }
+  return results;
+}
+
+function captureEvents(livenessCount: number): CaptureReadyEvent[] {
+  const events: CaptureReadyEvent[] = [
+    {
+      kind: CaptureReadyEventKind.Selfie,
+      captureIndex: 0,
+      url: "file://selfie-0.jpg",
+    },
+  ];
+  for (let index = 1; index <= livenessCount; index++) {
+    events.push({
+      kind: CaptureReadyEventKind.Liveness,
+      captureIndex: index,
+      url: `file://liveness-${index}.jpg`,
+    });
+  }
+  return events;
+}

package/dist/presentation/components/use_smile_id_face_silhouette_overlay.d.ts

@@ -1,15 +0,0 @@
-import type { UseSmileIDTheme } from "../theme/theme";
-export type UseSmileIDFaceSilhouetteOverlayProps = {
-    readonly visible: boolean;
-    readonly theme?: UseSmileIDTheme;
-};
-/**
- * Silhouette guide rendered inside the face oval during the
- * `INSTRUCTION` state — gives the user a visual hint of where to
- * place their face before the analyzer kicks in.
- *
- * **STUB.** Silhouette SVG / vector pending; current implementation
- * is an empty view.
- */
-export declare function UseSmileIDFaceSilhouetteOverlay(props: UseSmileIDFaceSilhouetteOverlayProps): import("react").JSX.Element | null;
-//# sourceMappingURL=use_smile_id_face_silhouette_overlay.d.ts.map

package/dist/presentation/components/use_smile_id_face_silhouette_overlay.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"use_smile_id_face_silhouette_overlay.d.ts","sourceRoot":"","sources":["../../../src/presentation/components/use_smile_id_face_silhouette_overlay.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGtD,MAAM,MAAM,oCAAoC,GAAG;IACjD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,eAAe,CAAC;CAClC,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,+BAA+B,CAC7C,KAAK,EAAE,oCAAoC,sCAQ5C"}

package/dist/presentation/components/use_smile_id_face_silhouette_overlay.js

@@ -1,19 +0,0 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-import { View } from "react-native";
-import { useUseSmileIDTheme } from "../theme/theme_context";
-/**
- * Silhouette guide rendered inside the face oval during the
- * `INSTRUCTION` state — gives the user a visual hint of where to
- * place their face before the analyzer kicks in.
- *
- * **STUB.** Silhouette SVG / vector pending; current implementation
- * is an empty view.
- */
-export function UseSmileIDFaceSilhouetteOverlay(props) {
-    const themeFromContext = useUseSmileIDTheme();
-    const theme = props.theme ?? themeFromContext;
-    if (!props.visible)
-        return null;
-    return (_jsx(View, { style: { opacity: 0.3, backgroundColor: theme.colors.stroke } }));
-}
-//# sourceMappingURL=use_smile_id_face_silhouette_overlay.js.map

package/dist/presentation/components/use_smile_id_face_silhouette_overlay.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"use_smile_id_face_silhouette_overlay.js","sourceRoot":"","sources":["../../../src/presentation/components/use_smile_id_face_silhouette_overlay.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAO5D;;;;;;;GAOG;AACH,MAAM,UAAU,+BAA+B,CAC7C,KAA2C;IAE3C,MAAM,gBAAgB,GAAG,kBAAkB,EAAE,CAAC;IAC9C,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,gBAAgB,CAAC;IAC9C,IAAI,CAAC,KAAK,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAChC,OAAO,CACL,KAAC,IAAI,IAAC,KAAK,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAI,CACxE,CAAC;AACJ,CAAC"}

package/src/presentation/components/use_smile_id_face_silhouette_overlay.tsx

@@ -1,27 +0,0 @@
-import { View } from "react-native";
-import type { UseSmileIDTheme } from "../theme/theme";
-import { useUseSmileIDTheme } from "../theme/theme_context";
-
-export type UseSmileIDFaceSilhouetteOverlayProps = {
-  readonly visible: boolean;
-  readonly theme?: UseSmileIDTheme;
-};
-
-/**
- * Silhouette guide rendered inside the face oval during the
- * `INSTRUCTION` state — gives the user a visual hint of where to
- * place their face before the analyzer kicks in.
- *
- * **STUB.** Silhouette SVG / vector pending; current implementation
- * is an empty view.
- */
-export function UseSmileIDFaceSilhouetteOverlay(
-  props: UseSmileIDFaceSilhouetteOverlayProps,
-) {
-  const themeFromContext = useUseSmileIDTheme();
-  const theme = props.theme ?? themeFromContext;
-  if (!props.visible) return null;
-  return (
-    <View style={{ opacity: 0.3, backgroundColor: theme.colors.stroke }} />
-  );
-}