@smileid/usesmileid 12.0.2 → 12.1.0

package/src/metadata/device_orientation_collector.ts

@@ -1,75 +0,0 @@
-import {
-  loadExpoSensors,
-  type AccelerometerSubscription,
-} from "./optional_native_modules";
-
-/**
- * Samples the accelerometer during capture for two metadata signals:
- * - `device_positions`: `"epochMs,x,y,z"` samples throttled to ~15 Hz, capped at
- *   {@link MAX_DURATION_MS} to bound payload size.
- * - `device_movement_detected`: the span (max − min) of movement magnitude
- *   (`|‖accel‖ − gravity|`, in g) across the session, or `null` when no samples ran.
- *
- * The `expo-sensors` subscription lives only between {@link start} and {@link stop}
- * (tied to the capture screen lifecycle). When `expo-sensors` isn't installed the
- * collector silently no-ops and the keys are omitted.
- */
-const SAMPLE_INTERVAL_MS = Math.floor(1000 / 15);
-const MAX_DURATION_MS = 90 * 1000;
-// expo-sensors reports acceleration in g; gravity is ~1 g (v11 parity value).
-const GRAVITY = 0.981;
-
-export class DeviceOrientationCollector {
-  private subscription: AccelerometerSubscription | null = null;
-  private positions: string[] = [];
-  private movements: number[] = [];
-  private startedAt = 0;
-  private lastSampleMs = 0;
-
-  /** Begins accelerometer sampling for a fresh capture session. No-op if running or unavailable. */
-  start(): void {
-    if (this.subscription) return;
-    const sensors = loadExpoSensors();
-    if (!sensors) return;
-    this.positions = [];
-    this.movements = [];
-    this.startedAt = Date.now();
-    this.lastSampleMs = 0;
-    sensors.Accelerometer.setUpdateInterval(SAMPLE_INTERVAL_MS);
-    this.subscription = sensors.Accelerometer.addListener((data) =>
-      this.onSample(data),
-    );
-  }
-
-  /** Stops sampling but preserves the collected data for the getters below. */
-  stop(): void {
-    this.subscription?.remove();
-    this.subscription = null;
-  }
-
-  private onSample(data: { x: number; y: number; z: number }): void {
-    const now = Date.now();
-    if (now - this.startedAt > MAX_DURATION_MS) {
-      this.stop();
-      return;
-    }
-    if (now - this.lastSampleMs < SAMPLE_INTERVAL_MS) return;
-    this.lastSampleMs = now;
-    this.positions.push(`${now},${data.x},${data.y},${data.z}`);
-    const magnitude = Math.sqrt(
-      data.x * data.x + data.y * data.y + data.z * data.z,
-    );
-    this.movements.push(Math.abs(magnitude - GRAVITY));
-  }
-
-  /** Collected `"epochMs,x,y,z"` samples (empty when no capture ran). */
-  get devicePositions(): readonly string[] {
-    return this.positions;
-  }
-
-  /** Span of movement magnitude across the session; `null` when no samples were collected. */
-  get deviceMovementDetected(): number | null {
-    if (this.movements.length === 0) return null;
-    return Math.max(...this.movements) - Math.min(...this.movements);
-  }
-}

package/src/metadata/document_image_origin.ts

@@ -1,22 +0,0 @@
-/**
- * How a captured document side was produced, emitted per side in submission
- * metadata. The string values are the wire contract — do not localize or abbreviate.
- */
-export const DocumentImageOrigin = {
-  /** Captured automatically by the native detection pipeline. */
-  CameraAutoCapture: "CameraAutoCapture",
-  /** Captured by an explicit shutter tap. */
-  CameraManualCapture: "CameraManualCapture",
-  /** Imported from the device photo library. */
-  Gallery: "Gallery",
-} as const;
-
-export type DocumentImageOrigin =
-  (typeof DocumentImageOrigin)[keyof typeof DocumentImageOrigin];
-
-/**
- * Per-side document-origin wire keys. PascalCase per the v11 metadata contract —
- * fixed by the wire format, distinct from the snake_case device-metadata keys.
- */
-export const DOCUMENT_FRONT_IMAGE_ORIGIN_KEY = "DocumentFrontImageOrigin";
-export const DOCUMENT_BACK_IMAGE_ORIGIN_KEY = "DocumentBackImageOrigin";

package/src/metadata/geolocation.ts

@@ -1,46 +0,0 @@
-import { loadExpoLocation } from "./optional_native_modules";
-
-/**
- * Coarse last-known location, emitted as the `geolocation` metadata (JSON-object string).
- *
- * `accuracy` is `precise` (<20 m), `approximate` (<100 m), or `unknown`; `source` is `gps`.
- */
-export interface Geolocation {
-  readonly latitude: number;
-  readonly longitude: number;
-  readonly accuracy: string;
-  readonly source: string;
-}
-
-function classifyAccuracy(meters: number | null): string {
-  if (meters === null || meters <= 0) return "unknown";
-  if (meters < 20) return "precise";
-  if (meters < 100) return "approximate";
-  return "unknown";
-}
-
-/**
- * Resolves the last-known location for the `geolocation` metadata — only when a location
- * permission is **already** granted. The SDK never requests it (uses
- * `getForegroundPermissionsAsync`, not `requestForegroundPermissionsAsync`), so this never
- * prompts. Returns `null` when permission is absent, no cached fix exists, or `expo-location`
- * isn't installed.
- */
-export async function resolveGeolocation(): Promise<Geolocation | null> {
-  const location = loadExpoLocation();
-  if (!location) return null;
-  try {
-    const permission = await location.getForegroundPermissionsAsync();
-    if (!permission.granted) return null;
-    const position = await location.getLastKnownPositionAsync();
-    if (!position) return null;
-    return {
-      latitude: position.coords.latitude,
-      longitude: position.coords.longitude,
-      accuracy: classifyAccuracy(position.coords.accuracy),
-      source: "gps",
-    };
-  } catch {
-    return null;
-  }
-}

package/src/metadata/metadata_configuration_mappers.ts

@@ -1,248 +0,0 @@
-import { GlobalPrivacyControl } from "../core/models/global_privacy_control";
-import { AnalyzerFactoryKey } from "@smileid/usesmileid_bridge";
-
-import { CaptureType } from "../core/models/ml_config";
-import { autoCaptureWireValue } from "../core/models/document_capture_mode";
-import type { FlowConfiguration } from "../presentation/flow/config/flow_configuration";
-import type {
-  CaptureConfigBuilder,
-  ConsentConfigBuilder,
-} from "../presentation/flow/dsl/builder/screens_builder";
-import {
-  type BuilderConfiguration,
-  builderConfigurationToJson,
-} from "./builder_configuration";
-import {
-  MODEL_DESCRIPTOR_UNKNOWN,
-  type ModelConfiguration,
-  type ModelDescriptor,
-  ModelProvider,
-  modelConfigurationToJson,
-} from "./model_configuration";
-import type { MetadataEntry } from "./use_smile_id_metadata";
-
-/**
- * Projects the resolved [FlowConfiguration] into the request-metadata
- * configuration objects, so the telemetry layer never needs a parallel copy of
- * the partner's choices.
- *
- * Fields that do not apply to the assembled flow report their accurate "absent"
- * value (`false`, or `autocapture_default` for the capture mode) rather than
- * being omitted, so the object always carries the full schema.
- * `consent_icon_dimensions` is always `null`: the consent icon is a `ReactNode`
- * with no measurable pixel size at configuration time.
- */
-export function flowConfigurationToBuilderConfiguration(
-  configuration: FlowConfiguration,
-): BuilderConfiguration {
-  const steps = configuration.screens.steps;
-
-  let consent: ConsentConfigBuilder | undefined;
-  const captures: CaptureConfigBuilder[] = [];
-  let instructionsUsed = false;
-  let previewUsed = false;
-  let processingUsed = false;
-  for (const step of steps) {
-    switch (step.kind) {
-      case "consent":
-        consent = step.config;
-        break;
-      case "instructions":
-        instructionsUsed = true;
-        break;
-      case "capture":
-        captures.push(step.config);
-        break;
-      case "preview":
-        previewUsed = true;
-        break;
-      case "processing":
-        processingUsed = true;
-        break;
-    }
-  }
-
-  const selfie = captures.find((capture) => capture.selfieConfig)?.selfieConfig;
-  const document = captures.find(
-    (capture) => capture.documentConfig,
-  )?.documentConfig;
-  const hasSelfieCapture =
-    selfie !== undefined ||
-    captures.some((capture) => capture.captureType === CaptureType.selfie);
-  const hasDocumentCapture =
-    document !== undefined ||
-    captures.some((capture) => capture.captureType === CaptureType.document);
-
-  return {
-    consentScreenUsed: consent !== undefined,
-    consentIconProvided: consent?.partnerIcon != null,
-    // A React Native consent icon is a ReactNode with no measurable pixel size.
-    consentIconDimensions: null,
-    consentAttributionShown: consent?.showAttribution ?? false,
-    instructionsScreenUsed: instructionsUsed,
-    selfiePreviewEnabled: previewUsed && hasSelfieCapture,
-    documentPreviewEnabled: previewUsed && hasDocumentCapture,
-    // No processing screen means the flow captures without submitting to the API.
-    submissionSkipped: !processingUsed,
-    allowAgentMode: selfie?.allowAgentMode ?? false,
-    enhancedLivenessEnabled: selfie?.enableEnhancedLiveness ?? false,
-    autoCaptureEnabled: autoCaptureWireValue(document?.captureMode),
-    allowGalleryUpload: document?.allowGalleryUpload ?? false,
-    captureBothSides: document?.captureBothSides ?? false,
-    allowSkipBack: document?.allowSkipBack ?? false,
-    globalPrivacyControl:
-      configuration.config?.globalPrivacyControl ?? GlobalPrivacyControl.OptOut,
-  };
-}
-
-/**
- * Describes the face and document models backing this flow.
- *
- * The face model is resolved from the registered selfie analyzer factory key;
- * the document model reports the native no-op fallback, since the React Native
- * document detector is not selectable from JS.
- */
-export function flowConfigurationToModelConfiguration(
-  configuration: FlowConfiguration,
-): ModelConfiguration {
-  const faceKey = configuration.ml?.analyzers.selfieConfig?.analyzerFactoryKey;
-  return {
-    faceModel: faceDescriptorOf(faceKey),
-    documentModel: NOOP_DOCUMENT_DESCRIPTOR,
-  };
-}
-
-/**
- * The `builder_configuration_object` + `model_configuration_object` wire
- * entries, encoded as JSON-string values so the metadata payload stays a flat
- * `{name, value}` array.
- */
-export function configurationMetadataEntries(
-  configuration: FlowConfiguration,
-): MetadataEntry[] {
-  const entries: MetadataEntry[] = [
-    {
-      name: "builder_configuration_object",
-      value: JSON.stringify(
-        builderConfigurationToJson(
-          flowConfigurationToBuilderConfiguration(configuration),
-        ),
-      ),
-    },
-    {
-      name: "model_configuration_object",
-      value: JSON.stringify(
-        modelConfigurationToJson(
-          flowConfigurationToModelConfiguration(configuration),
-        ),
-      ),
-    },
-  ];
-
-  // Flow-derived selfie liveness telemetry — appended only for selfie flows.
-  const liveness = flowConfigurationToSelfieLivenessTelemetry(configuration);
-  if (liveness.activeLivenessType !== null) {
-    entries.push(
-      { name: "active_liveness_type", value: liveness.activeLivenessType },
-      {
-        name: "active_liveness_version",
-        value: liveness.activeLivenessVersion,
-      },
-      { name: "selfie_image_origin", value: liveness.selfieImageOrigin },
-    );
-  }
-  return entries;
-}
-
-type SelfieLivenessTelemetry =
-  | {
-      readonly activeLivenessType: string;
-      readonly activeLivenessVersion: string;
-      readonly selfieImageOrigin: string;
-    }
-  | {
-      readonly activeLivenessType: null;
-      readonly activeLivenessVersion: null;
-      readonly selfieImageOrigin: null;
-    };
-
-/**
- * Flow-derived selfie liveness telemetry. All-`null` for flows without a selfie
- * capture; otherwise the active-liveness check, the version, and the lens the
- * selfie came from (the selfie SDK has no gallery path).
- */
-export function flowConfigurationToSelfieLivenessTelemetry(
-  configuration: FlowConfiguration,
-): SelfieLivenessTelemetry {
-  let selfie: SelfieLivenessSource;
-  let hasSelfieCapture = false;
-  for (const step of configuration.screens.steps) {
-    if (step.kind === "capture") {
-      selfie ??= step.config.selfieConfig;
-      if (step.config.captureType === CaptureType.selfie) {
-        hasSelfieCapture = true;
-      }
-    }
-  }
-  if (!hasSelfieCapture && selfie === undefined) {
-    return {
-      activeLivenessType: null,
-      activeLivenessVersion: null,
-      selfieImageOrigin: null,
-    };
-  }
-  return {
-    activeLivenessType: activeLivenessTypeOf(selfie),
-    activeLivenessVersion: "2.0.0",
-    selfieImageOrigin: selfieImageOriginOf(selfie),
-  };
-}
-
-type SelfieLivenessSource =
-  | { enableEnhancedLiveness: boolean; allowAgentMode?: boolean }
-  | undefined;
-
-function activeLivenessTypeOf(selfie: SelfieLivenessSource): string {
-  return selfie?.enableEnhancedLiveness ? "head_pose" : "smile";
-}
-
-function selfieImageOriginOf(selfie: SelfieLivenessSource): string {
-  return selfie?.allowAgentMode ? "back_camera" : "front_camera";
-}
-
-function faceDescriptorOf(
-  key: AnalyzerFactoryKey | undefined,
-): ModelDescriptor {
-  switch (key) {
-    case AnalyzerFactoryKey.MLKitFace:
-      return {
-        provider: ModelProvider.Google,
-        name: "play-services-mlkit-face-detection",
-        version: "17.1.0",
-        bundled: false,
-      };
-    case AnalyzerFactoryKey.HuaweiFace:
-      return {
-        provider: ModelProvider.Huawei,
-        name: "ml-computer-vision-face",
-        version: "3.18.1.300",
-        bundled: false,
-      };
-    case AnalyzerFactoryKey.VisionFace:
-      return {
-        provider: ModelProvider.Apple,
-        name: "vision_face_detector",
-        version: "system",
-        bundled: true,
-      };
-    default:
-      return MODEL_DESCRIPTOR_UNKNOWN;
-  }
-}
-
-const NOOP_DOCUMENT_DESCRIPTOR: ModelDescriptor = {
-  provider: ModelProvider.Smile,
-  name: "noop_document_detector",
-  version: "12.0.2", // x-release-please-version
-  bundled: true,
-};

package/src/metadata/model_configuration.ts

@@ -1,68 +0,0 @@
-/**
- * Client-side detection-model metadata appended to a job request as the
- * `model_configuration_object` entry, so the server can attribute face /
- * document detection behaviour to a concrete component and version during
- * fraud analysis.
- *
- * `ModelProvider` is a stable lowercase wire token; `apple` covers detectors
- * backed by Apple's Vision framework on iOS. New providers are additive.
- */
-
-export const ModelProvider = {
-  Google: "google",
-  Huawei: "huawei",
-  Smile: "smile",
-  Apple: "apple",
-  Custom: "custom",
-} as const;
-
-export type ModelProvider = (typeof ModelProvider)[keyof typeof ModelProvider];
-
-export type ModelDescriptor = {
-  readonly provider: ModelProvider;
-  /** Human-readable model identifier (e.g. the native artefact id). */
-  readonly name: string;
-  /** The model / framework version in use on the device. */
-  readonly version: string;
-  /** `true` when the model ships with the app / OS, `false` when downloaded on demand. */
-  readonly bundled: boolean;
-};
-
-/**
- * Placeholder used when the active model for a capture type cannot be
- * resolved, so the `model_configuration_object` always carries both
- * `face_model` and `document_model` rather than omitting a side.
- */
-export const MODEL_DESCRIPTOR_UNKNOWN: ModelDescriptor = Object.freeze({
-  provider: ModelProvider.Custom,
-  name: "unknown",
-  version: "unknown",
-  bundled: false,
-});
-
-export type ModelConfiguration = {
-  readonly faceModel: ModelDescriptor;
-  readonly documentModel: ModelDescriptor;
-};
-
-/** Serialises a [ModelDescriptor] to its snake_case wire object. */
-export function modelDescriptorToJson(
-  descriptor: ModelDescriptor,
-): Record<string, unknown> {
-  return {
-    provider: descriptor.provider,
-    name: descriptor.name,
-    version: descriptor.version,
-    bundled: descriptor.bundled,
-  };
-}
-
-/** Serialises a [ModelConfiguration] to its snake_case wire object. */
-export function modelConfigurationToJson(
-  configuration: ModelConfiguration,
-): Record<string, unknown> {
-  return {
-    face_model: modelDescriptorToJson(configuration.faceModel),
-    document_model: modelDescriptorToJson(configuration.documentModel),
-  };
-}