@smileid/usesmileid 12.0.2 → 12.1.1

package/src/metadata/optional_native_modules.ts

@@ -1,274 +0,0 @@
-/**
- * Lazy bridges to optional `expo-device` / `expo-network` / `expo-battery` /
- * `expo-cellular` peer deps. All are declared `optional: true` in
- * `peerDependenciesMeta` so partners who don't need richer metadata don't pay
- * the install cost.
- *
- * **Pattern:** dynamic `require()` wrapped in `try/catch`. Metro
- * tolerates the missing-module case without failing the build —
- * resolution attempts at runtime, the catch swallows the failure,
- * and the metadata factory falls back to empty / zero defaults.
- *
- * Concrete scenario this prevents: a hard `import` would fail the
- * bundle for every partner, even those who don't want richer
- * metadata. The optional peer + try/require pattern keeps the
- * default install footprint minimal.
- */
-
-type DeviceModule = {
-  readonly modelName?: string | null;
-  readonly brand?: string | null;
-  readonly supportedCpuArchitectures?: readonly string[] | null;
-  readonly totalMemory?: number | null;
-  // Android `Build.DEVICE`; iOS leaves this null (use `modelId` instead).
-  readonly designName?: string | null;
-  // Android `Build.PRODUCT`.
-  readonly productName?: string | null;
-  // Android `Build.FINGERPRINT`.
-  readonly osBuildFingerprint?: string | null;
-  // iOS hardware identifier (e.g. `iPhone16,2`).
-  readonly modelId?: string | null;
-};
-
-type NetworkModule = {
-  getNetworkStateAsync(): Promise<{
-    readonly type?: string | null;
-    readonly isConnected?: boolean | null;
-    readonly isInternetReachable?: boolean | null;
-  }>;
-  getIpAddressAsync?(): Promise<string>;
-};
-
-type BatteryModule = {
-  // expo-battery `BatteryState`: 0 unknown, 1 unplugged, 2 charging, 3 full.
-  getBatteryStateAsync(): Promise<number>;
-};
-
-type CellularModule = {
-  // Carrier name constant (may be null on Wi-Fi-only / dual-SIM devices).
-  readonly carrier?: string | null;
-};
-
-type AsyncStorageModule = {
-  getItem(key: string): Promise<string | null>;
-  setItem(key: string, value: string): Promise<void>;
-};
-
-/** Subscription returned by `Accelerometer.addListener`. */
-export type AccelerometerSubscription = { remove(): void };
-
-/** Minimal `expo-sensors` surface used for device_positions / device_movement_detected. */
-type SensorsModule = {
-  Accelerometer: {
-    setUpdateInterval(intervalMs: number): void;
-    addListener(
-      listener: (data: { x: number; y: number; z: number }) => void,
-    ): AccelerometerSubscription;
-  };
-};
-
-/** Minimal `expo-location` surface used for the geolocation metadata. */
-type LocationModule = {
-  getForegroundPermissionsAsync(): Promise<{ granted: boolean }>;
-  getLastKnownPositionAsync(): Promise<{
-    coords: {
-      latitude: number;
-      longitude: number;
-      accuracy: number | null;
-    };
-  } | null>;
-};
-
-let _device: DeviceModule | null | undefined;
-let _network: NetworkModule | null | undefined;
-let _battery: BatteryModule | null | undefined;
-let _cellular: CellularModule | null | undefined;
-let _asyncStorage: AsyncStorageModule | null | undefined;
-let _sensors: SensorsModule | null | undefined;
-let _location: LocationModule | null | undefined;
-
-/**
- * Load `expo-device`'s native module once, cached for the process
- * lifetime. Returns `null` if the native module isn't linked into
- * the host app (graceful degradation).
- *
- * **Why bypass `require("expo-device")`:** `expo-device`'s entry
- * (`Device.js`) does `import ExpoDevice from './ExpoDevice'`, which
- * evaluates `ExpoDevice.js` whose top-level statement is
- * `export default requireNativeModule('ExpoDevice')`. The
- * **throwing** variant — `requireNativeModule` throws "Cannot find
- * native module 'ExpoDevice'" synchronously when the native side
- * isn't linked. Concrete scenario this caused: pnpm-hoisted
- * `expo-device` JS at the workspace root was reachable from a host
- * app's Metro bundle even though the host app didn't link the native
- * module. The throw at module init bypassed every try/catch we
- * wrapped the require in.
- *
- * The fix: skip `expo-device`'s entry entirely. Pull the native
- * module via `expo-modules-core`'s `requireOptionalNativeModule`,
- * which returns `null` instead of throwing. The raw native module
- * exposes the same fields (`brand`, `modelName`,
- * `supportedCpuArchitectures`, `totalMemory`) that
- * `expo-device/Device.js` re-exports — see `expo-device`'s
- * native-module schema in `node_modules/expo-device/build/Device.js`.
- * `expo-modules-core` is a transitive dep of `expo` so it's always
- * present in any Expo app.
- */
-export function loadExpoDevice(): DeviceModule | null {
-  if (_device !== undefined) return _device;
-  try {
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    const core = require("expo-modules-core") as {
-      requireOptionalNativeModule?: <T>(name: string) => T | null;
-    };
-    _device =
-      core.requireOptionalNativeModule?.<DeviceModule>("ExpoDevice") ?? null;
-  } catch {
-    _device = null;
-  }
-  return _device;
-}
-
-/**
- * Load `expo-network`'s native module once, cached for the process
- * lifetime. Returns `null` if the native module isn't linked into the
- * host app (graceful degradation).
- *
- * **Why bypass `require("expo-network")`:** like `expo-device`, its
- * entry (`Network.js`) imports `./ExpoNetwork`, whose top-level
- * statement is `requireNativeModule('ExpoNetwork')` — the **throwing**
- * variant that raises "Cannot find native module 'ExpoNetwork'"
- * synchronously at module init when the native side isn't linked. That
- * throw fires during Metro's module evaluation and bypasses a
- * `try/catch` wrapped around the `require`, so a host app that reaches
- * the pnpm-hoisted `expo-network` JS without linking the native module
- * crashes on construction. The fix mirrors `loadExpoDevice`: pull the
- * raw native module via `expo-modules-core`'s
- * `requireOptionalNativeModule`, which returns `null` instead of
- * throwing. The raw module exposes `getNetworkStateAsync` /
- * `getIpAddressAsync` directly — the same methods `expo-network`'s
- * `Network.js` calls on it.
- *
- * Note: `getNetworkStateAsync()` is async — the factory warms it up
- * fire-and-forget and falls back to empty defaults until it settles.
- */
-export function loadExpoNetwork(): NetworkModule | null {
-  if (_network !== undefined) return _network;
-  try {
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    const core = require("expo-modules-core") as {
-      requireOptionalNativeModule?: <T>(name: string) => T | null;
-    };
-    _network =
-      core.requireOptionalNativeModule?.<NetworkModule>("ExpoNetwork") ?? null;
-  } catch {
-    _network = null;
-  }
-  return _network;
-}
-
-/**
- * Load `expo-battery`'s native module once, cached for the process lifetime.
- * Returns `null` when the native module isn't linked (graceful degradation).
- * Mirrors [loadExpoDevice] — pulls the raw `ExpoBattery` native module via
- * `expo-modules-core`'s non-throwing `requireOptionalNativeModule`.
- */
-export function loadExpoBattery(): BatteryModule | null {
-  if (_battery !== undefined) return _battery;
-  try {
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    const core = require("expo-modules-core") as {
-      requireOptionalNativeModule?: <T>(name: string) => T | null;
-    };
-    _battery =
-      core.requireOptionalNativeModule?.<BatteryModule>("ExpoBattery") ?? null;
-  } catch {
-    _battery = null;
-  }
-  return _battery;
-}
-
-/**
- * Load `expo-cellular`'s native module once, cached for the process lifetime.
- * Returns `null` when the native module isn't linked (graceful degradation).
- * The raw `ExpoCellular` module exposes the `carrier` name constant directly.
- */
-export function loadExpoCellular(): CellularModule | null {
-  if (_cellular !== undefined) return _cellular;
-  try {
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    const core = require("expo-modules-core") as {
-      requireOptionalNativeModule?: <T>(name: string) => T | null;
-    };
-    _cellular =
-      core.requireOptionalNativeModule?.<CellularModule>("ExpoCellular") ??
-      null;
-  } catch {
-    _cellular = null;
-  }
-  return _cellular;
-}
-
-/**
- * Load `@react-native-async-storage/async-storage` once, cached for the process
- * lifetime. Returns `null` when the package isn't installed (graceful
- * degradation). Unlike the expo modules, async-storage's JS entry does not throw
- * at import when the native side is missing, so a plain `require` (wrapped in
- * try/catch for the not-installed case) is sufficient; per-call native errors
- * are handled by the caller. Backed by Android `SharedPreferences` /
- * iOS `NSUserDefaults`.
- */
-export function loadAsyncStorage(): AsyncStorageModule | null {
-  if (_asyncStorage !== undefined) return _asyncStorage;
-  try {
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    const module = require("@react-native-async-storage/async-storage") as {
-      default?: AsyncStorageModule;
-    } & AsyncStorageModule;
-    _asyncStorage = module.default ?? module;
-  } catch {
-    _asyncStorage = null;
-  }
-  return _asyncStorage;
-}
-
-/**
- * Load `expo-sensors` for accelerometer sampling. Returns `null` when the peer
- * dep isn't installed/linked (graceful degradation — device_positions omitted).
- */
-export function loadExpoSensors(): SensorsModule | null {
-  if (_sensors !== undefined) return _sensors;
-  try {
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    _sensors = require("expo-sensors") as SensorsModule;
-  } catch {
-    _sensors = null;
-  }
-  return _sensors;
-}
-
-/**
- * Load `expo-location` for the geolocation metadata. Returns `null` when the
- * peer dep isn't installed/linked (graceful degradation — geolocation omitted).
- */
-export function loadExpoLocation(): LocationModule | null {
-  if (_location !== undefined) return _location;
-  try {
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    _location = require("expo-location") as LocationModule;
-  } catch {
-    _location = null;
-  }
-  return _location;
-}
-
-/** Test-only seam — clears the module cache so tests can re-evaluate. */
-export function _resetOptionalModulesForTesting(): void {
-  _device = undefined;
-  _network = undefined;
-  _battery = undefined;
-  _cellular = undefined;
-  _asyncStorage = undefined;
-  _sensors = undefined;
-  _location = undefined;
-}

package/src/metadata/use_smile_id_metadata.ts

@@ -1,305 +0,0 @@
-/**
- * Metadata payload submitted alongside every job request.
- *
- * Wire format: a JSON array of `{name, value}` entries (NOT a flat object) — the
- * server and partner dashboards parse it positionally; `toEntries()` produces it.
- *
- * Omission rules: always-present (`sdk_version`, `sdk`, `device_os`,
- * `device_model`, `app_name`, `session_id`, `security_policy_version`);
- * conditional strings dropped when empty; conditional integers dropped when
- * zero; `proxy` / `proximity_sensor` emitted only when actually measured
- * (undefined = unknown, dropped) — a measured `false` is kept.
- */
-
-import type { Geolocation } from "./geolocation";
-
-export type MetadataEntry = {
-  readonly name: string;
-  readonly value: string;
-};
-
-export type UseSmileIDMetadataFields = {
-  readonly sdkVersion: string;
-  readonly sdk: string;
-  readonly deviceOs: string;
-  readonly deviceModel: string;
-  readonly appName: string;
-  readonly sessionId: string;
-  readonly clientIp: string;
-  readonly networkConnection: string;
-  readonly carrierInfo: string;
-  /** Proxy detection result → `proxy`. Undefined when never measured (omitted); a measured `false` is emitted. */
-  readonly proxy?: boolean;
-  readonly timezone: string;
-  readonly locale: string;
-  readonly screenResolution: string;
-  readonly memoryInfoMb: number;
-  readonly deviceOrientation: string;
-  readonly systemArchitecture: string;
-  readonly numberOfCameras: number;
-  readonly hostApplication: string;
-  /** Proximity-sensor availability → `proximity_sensor`. Undefined when never measured (omitted); a measured `false` is emitted. */
-  readonly proximitySensor?: boolean;
-  readonly securityPolicyVersion: string;
-  /** Android Keystore security level (`KeyInfo.getSecurityLevel()`, `-2`…`2`) → `supports_hardware_attestation`. Undefined on iOS and before warm-up resolves. */
-  readonly hardwareAttestationSecurityLevel?: number;
-  /** base64-DER leaf-first X.509 chain → `attestation_certificate_chain` (JSON-array string). Undefined/empty when no chain was minted. */
-  readonly attestationCertificateChain?: readonly string[];
-  /** Apple App Attest support → `supports_app_attest`. Undefined on Android and before warm-up resolves. */
-  readonly supportsAppAttest?: boolean;
-  /** Capture-param provenance → `sdk_config_source`: `"sdk_config"` when a valid JWT claim was decoded, else `"default"`. */
-  readonly sdkConfigSource: string;
-  /** Resolved selfie capture target dimensions → `selfie_image_dimensions` `"WxH"`: `sdk_config.selfie` override or SDK default (480x640). Dropped when a side is 0. */
-  readonly imageWidth: number;
-  readonly imageHeight: number;
-  /** Resolved liveness capture target dimensions → `liveness_image_dimensions` `"WxH"`. Dropped when a side is 0. */
-  readonly livenessImageWidth: number;
-  readonly livenessImageHeight: number;
-  /** Device UTC offset in minutes (may be negative or 0) → `timezone_offset`. Undefined omits. */
-  readonly timezoneOffsetMinutes?: number;
-  /** `android.os.Build.*` device-context strings; empty on iOS except `buildDevice` (iOS hardware id). Omitted when empty. */
-  readonly buildBrand?: string;
-  readonly buildDevice?: string;
-  readonly buildFingerprint?: string;
-  readonly buildProduct?: string;
-  /** `Build.HARDWARE` (Android) → `build_hardware`; empty on iOS. Omitted when empty. */
-  readonly buildHardware?: string;
-  /** Install source / store (Android `PackageManager` install source) → `build_source`. Omitted when empty. */
-  readonly buildSource?: string;
-  /** Host app package id (Android) / bundle id (iOS), computed natively → `package_name`. Omitted when empty. */
-  readonly packageName?: string;
-  /** Stable per-device fingerprint (Android `ANDROID_ID` / iOS `identifierForVendor`) → `fingerprint`. Omitted when empty. */
-  readonly fingerprint?: string;
-  /** Whether an active VPN is present → `vpn`. Omitted when undefined. */
-  readonly vpn?: boolean;
-  /** App-signing certificate SHA-256 digests (Android only) → `certificate_digest` (JSON-array string). Omitted when empty. */
-  readonly certificateDigest?: readonly string[];
-  /** ISO-8601 local timestamp captured at request build time → `local_time_of_enrolment`. */
-  readonly localTimeOfEnrolment?: string;
-  /** Charging plug status → `battery_status` (`-1` unknown, `0` on-battery, `1` plugged in). Omitted when undefined. */
-  readonly batteryStatus?: number;
-  /** Wrapper SDK identity → `wrapper_name` / `wrapper_version` (`react_native_expo` + SDK version). Omitted when empty. */
-  readonly wrapperName?: string;
-  readonly wrapperVersion?: string;
-  /** Persisted SDK launch count → `sdk_launch_count`. Omitted when undefined or zero. */
-  readonly sdkLaunchCount?: number;
-  /** Last-known location → `geolocation` (JSON-object string). Omitted when undefined. */
-  readonly geolocation?: Geolocation;
-  /** Obfuscated device security-state signal (computed natively) → `privileges`. Omitted when undefined/blank. */
-  readonly privileges?: string;
-};
-
-export class UseSmileIDMetadata {
-  private readonly _fields: UseSmileIDMetadataFields;
-  private readonly _extraEntries: readonly MetadataEntry[];
-
-  constructor(
-    fields: UseSmileIDMetadataFields,
-    extraEntries: readonly MetadataEntry[] = [],
-  ) {
-    this._fields = fields;
-    this._extraEntries = extraEntries;
-  }
-
-  /** Snapshot of the typed fields. Useful for tests and analytics hooks. */
-  toFields(): UseSmileIDMetadataFields {
-    return this._fields;
-  }
-
-  /**
-   * Returns a copy carrying additional wire entries appended after the
-   * device-metadata fields — for flow state that is not device metadata, e.g.
-   * the per-side document image origins (`DocumentFront/BackImageOrigin`).
-   */
-  withAdditionalEntries(extra: readonly MetadataEntry[]): UseSmileIDMetadata {
-    return new UseSmileIDMetadata(this._fields, [
-      ...this._extraEntries,
-      ...extra,
-    ]);
-  }
-
-  /**
-   * Canonical wire-format serialization to an array of `{name, value}` entries.
-   * Empty strings and zero integers are dropped so the payload stays compact
-   * (e.g. an emulator with no carrier info omits `carrier_info` entirely).
-   */
-  toEntries(): readonly MetadataEntry[] {
-    const fields = this._fields;
-    const entries: MetadataEntry[] = [];
-
-    // Always-present: SDK constants, sessionId (UUID), and
-    // device_os/device_model/app_name (emitted even when empty). The rest
-    // below use the drop-when-empty rule.
-    entries.push({ name: "sdk_version", value: fields.sdkVersion });
-    entries.push({ name: "sdk", value: fields.sdk });
-    entries.push({ name: "device_os", value: fields.deviceOs });
-    entries.push({ name: "device_model", value: fields.deviceModel });
-    entries.push({ name: "app_name", value: fields.appName });
-    entries.push({ name: "session_id", value: fields.sessionId });
-
-    // Measured booleans — omitted when never measured; a measured false is kept.
-    if (fields.proxy !== undefined) {
-      entries.push({ name: "proxy", value: String(fields.proxy) });
-    }
-    if (fields.proximitySensor !== undefined) {
-      entries.push({
-        name: "proximity_sensor",
-        value: String(fields.proximitySensor),
-      });
-    }
-
-    // Conditional strings — omitted when empty
-    pushIfNonEmpty(entries, "client_ip", fields.clientIp);
-    pushIfNonEmpty(entries, "network_connection", fields.networkConnection);
-    pushIfNonEmpty(entries, "carrier_info", fields.carrierInfo);
-    pushIfNonEmpty(entries, "timezone", fields.timezone);
-    pushIfNonEmpty(entries, "locale", fields.locale);
-    pushIfNonEmpty(entries, "screen_resolution", fields.screenResolution);
-    pushIfNonEmpty(entries, "device_orientation", fields.deviceOrientation);
-    pushIfNonEmpty(entries, "system_architecture", fields.systemArchitecture);
-    pushIfNonEmpty(entries, "host_application", fields.hostApplication);
-
-    // Conditional integers — omitted when zero
-    pushIfNonZero(entries, "memory_info", fields.memoryInfoMb);
-    pushIfNonZero(entries, "number_of_cameras", fields.numberOfCameras);
-
-    // Always-present trailer
-    entries.push({
-      name: "security_policy_version",
-      value: fields.securityPolicyVersion,
-    });
-
-    // Device-integrity capability — omitted until per-session warm-up resolves.
-    // Android: Keystore security-level integer + cert chain; iOS: App Attest flag.
-    if (fields.hardwareAttestationSecurityLevel !== undefined) {
-      entries.push({
-        name: "supports_hardware_attestation",
-        value: String(fields.hardwareAttestationSecurityLevel),
-      });
-      const chain = fields.attestationCertificateChain;
-      if (chain && chain.length > 0) {
-        entries.push({
-          name: "attestation_certificate_chain",
-          value: JSON.stringify(chain),
-        });
-      }
-    }
-    if (fields.supportsAppAttest !== undefined) {
-      entries.push({
-        name: "supports_app_attest",
-        value: String(fields.supportsAppAttest),
-      });
-    }
-
-    // sdk_config provenance — always-present string, never empty.
-    entries.push({ name: "sdk_config_source", value: fields.sdkConfigSource });
-    // Resolved selfie / liveness capture target dimensions as "WxH"; each dropped when a side is 0.
-    if (fields.imageWidth > 0 && fields.imageHeight > 0) {
-      entries.push({
-        name: "selfie_image_dimensions",
-        value: `${fields.imageWidth}x${fields.imageHeight}`,
-      });
-    }
-    if (fields.livenessImageWidth > 0 && fields.livenessImageHeight > 0) {
-      entries.push({
-        name: "liveness_image_dimensions",
-        value: `${fields.livenessImageWidth}x${fields.livenessImageHeight}`,
-      });
-    }
-    // UTC offset in minutes (may be negative or 0); emitted whenever resolved.
-    if (fields.timezoneOffsetMinutes !== undefined) {
-      entries.push({
-        name: "timezone_offset",
-        value: String(fields.timezoneOffsetMinutes),
-      });
-    }
-
-    // Build / device-context strings — omitted when empty.
-    pushIfNonEmpty(entries, "build_brand", fields.buildBrand ?? "");
-    pushIfNonEmpty(entries, "build_device", fields.buildDevice ?? "");
-    pushIfNonEmpty(entries, "build_fingerprint", fields.buildFingerprint ?? "");
-    pushIfNonEmpty(entries, "build_product", fields.buildProduct ?? "");
-    pushIfNonEmpty(entries, "build_hardware", fields.buildHardware ?? "");
-    pushIfNonEmpty(entries, "build_source", fields.buildSource ?? "");
-    pushIfNonEmpty(entries, "package_name", fields.packageName ?? "");
-    pushIfNonEmpty(entries, "fingerprint", fields.fingerprint ?? "");
-    pushIfNonEmpty(
-      entries,
-      "local_time_of_enrolment",
-      fields.localTimeOfEnrolment ?? "",
-    );
-    // Charging status — omitted until resolved. `0` (on battery) is meaningful.
-    if (fields.batteryStatus !== undefined) {
-      entries.push({
-        name: "battery_status",
-        value: String(fields.batteryStatus),
-      });
-    }
-
-    // VPN presence — omitted until resolved; `false` is meaningful.
-    if (fields.vpn !== undefined) {
-      entries.push({ name: "vpn", value: String(fields.vpn) });
-    }
-
-    // App-signing certificate digests (Android) — JSON-array string, omitted when empty.
-    if (
-      fields.certificateDigest !== undefined &&
-      fields.certificateDigest.length > 0
-    ) {
-      entries.push({
-        name: "certificate_digest",
-        value: JSON.stringify(fields.certificateDigest),
-      });
-    }
-
-    // Wrapper SDK identity — omitted when empty.
-    pushIfNonEmpty(entries, "wrapper_name", fields.wrapperName ?? "");
-    pushIfNonEmpty(entries, "wrapper_version", fields.wrapperVersion ?? "");
-
-    // Persisted launch count — omitted until resolved or when zero.
-    if (fields.sdkLaunchCount !== undefined && fields.sdkLaunchCount > 0) {
-      entries.push({
-        name: "sdk_launch_count",
-        value: String(fields.sdkLaunchCount),
-      });
-    }
-
-    // Last-known location — JSON-object string, omitted when unresolved.
-    if (fields.geolocation !== undefined) {
-      entries.push({
-        name: "geolocation",
-        value: JSON.stringify(fields.geolocation),
-      });
-    }
-
-    // Obfuscated device privileges signal — emitted verbatim, omitted when blank.
-    if (fields.privileges !== undefined && fields.privileges.length > 0) {
-      entries.push({ name: "privileges", value: fields.privileges });
-    }
-
-    // Flow-state entries appended after the device-metadata fields.
-    entries.push(...this._extraEntries);
-
-    return Object.freeze(entries);
-  }
-}
-
-function pushIfNonEmpty(
-  entries: MetadataEntry[],
-  name: string,
-  value: string,
-): void {
-  if (value && value.length > 0) {
-    entries.push({ name, value });
-  }
-}
-
-function pushIfNonZero(
-  entries: MetadataEntry[],
-  name: string,
-  value: number,
-): void {
-  if (value !== 0) {
-    entries.push({ name, value: String(value) });
-  }
-}