@smileid/usesmileid 12.0.2 → 12.1.0

package/src/core/models/document_type.ts

@@ -1,79 +0,0 @@
-/**
- * Identifies the kind of identity document being captured. Behaviour falls out
- * of the typed fields, never `displayName`. Use a preset, or
- * {@link DocumentType.GenericDocument} otherwise.
- */
-
-/** Capture orientation for a {@link DocumentType}. */
-export type DocumentOrientation = "Landscape" | "Portrait";
-
-type DocumentTypeFields = {
-  /** Name shown in the instructions title emphasis. */
-  readonly displayName: string;
-  /** Whether there is a back side to capture (drives the flip interstitial). */
-  readonly hasBackSide: boolean;
-  readonly orientation: DocumentOrientation;
-  /** Fixed capture-frame aspect ratio; takes precedence over the DSL `knownIdAspectRatio`. */
-  readonly knownAspectRatio?: number;
-};
-
-/** Closed set of document types; the `kind` tag keeps a `switch` exhaustive. */
-export type DocumentType =
-  | ({ readonly kind: "southAfricaGreenBook" } & DocumentTypeFields)
-  | ({ readonly kind: "passport" } & DocumentTypeFields)
-  | ({ readonly kind: "genericDocument" } & DocumentTypeFields);
-
-const SOUTH_AFRICA_GREEN_BOOK: DocumentType = Object.freeze({
-  kind: "southAfricaGreenBook",
-  displayName: "Green Book",
-  hasBackSide: false,
-  orientation: "Portrait",
-  knownAspectRatio: 320 / 428,
-});
-
-const PASSPORT: DocumentType = Object.freeze({
-  kind: "passport",
-  displayName: "Passport",
-  hasBackSide: true,
-  orientation: "Landscape",
-  knownAspectRatio: 356 / 272,
-});
-
-/** Configurable fields for {@link DocumentType.GenericDocument}. */
-export type GenericDocumentArgs = {
-  readonly displayName?: string;
-  readonly hasBackSide?: boolean;
-  readonly orientation?: DocumentOrientation;
-  readonly knownAspectRatio?: number;
-};
-
-/** Preset values and the `GenericDocument` factory for {@link DocumentType}. */
-export const DocumentType = {
-  /** South Africa Green Book — booklet-style, single-side, portrait. */
-  SouthAfricaGreenBook: SOUTH_AFRICA_GREEN_BOOK,
-  /** Passport — landscape data page followed by a back-side capture. */
-  Passport: PASSPORT,
-  /** Catch-all without a preset; defaults to a landscape, two-sided "Document". */
-  GenericDocument(args: GenericDocumentArgs = {}): DocumentType {
-    return Object.freeze({
-      kind: "genericDocument",
-      displayName: args.displayName ?? "Document",
-      hasBackSide: args.hasBackSide ?? true,
-      orientation: args.orientation ?? "Landscape",
-      ...(args.knownAspectRatio !== undefined
-        ? { knownAspectRatio: args.knownAspectRatio }
-        : {}),
-    });
-  },
-} as const;
-
-/**
- * Capture-frame width:height ratio when neither {@link DocumentType.knownAspectRatio}
- * nor a partner `knownIdAspectRatio` is set. Landscape ≈ ID-1 card (1.586);
- * portrait a tall booklet / passport (0.65).
- */
-export function defaultFrameAspectRatio(
-  orientation: DocumentOrientation,
-): number {
-  return orientation === "Portrait" ? 0.65 : 1.586;
-}

package/src/core/models/flow_step.ts

@@ -1,17 +0,0 @@
-/**
- * Discrete steps a UseSmileID flow can stop on.
- *
- * Order is significant — the orchestrator advances forward through this
- * list; back-navigation goes backward. Add new steps in their natural
- * flow position, never at the end "for compatibility".
- */
-export const FlowStep = [
-  "instructions",
-  "consent",
-  "permission",
-  "capture",
-  "preview",
-  "processing",
-] as const;
-
-export type FlowStep = (typeof FlowStep)[number];

package/src/core/models/global_privacy_control.ts

@@ -1,45 +0,0 @@
-/**
- * Partner-declared Global Privacy Control posture for the consent screen
- * (`global_privacy_control` on the wire).
- *
- * Native mobile platforms expose no OS-level equivalent of the web's GPC
- * signal, so the SDK performs no runtime user-signal tracking: the partner
- * declares the posture once at initialization
- * (`b.config((c) => { c.globalPrivacyControl = ...; })`) and it governs
- * every session.
- *
- * Const-object pattern (see `KameraEventType`-style types): enum ergonomics,
- * string wire format.
- */
-export const GlobalPrivacyControl = {
-  /**
-   * Default. Forces the opt-out consent layout universally: consent starts
-   * granted (pre-selected) for every session regardless of region — the
-   * user unticks to opt out. Regional detection is never consulted.
-   */
-  OptOut: "opt-out",
-
-  /**
-   * Legacy regional mechanics: consent starts granted outside the EU and
-   * starts ungranted (explicit opt-in required) when the device locale is
-   * an EU member state.
-   */
-  OptIn: "opt-in",
-} as const;
-export type GlobalPrivacyControl =
-  (typeof GlobalPrivacyControl)[keyof typeof GlobalPrivacyControl];
-
-/** Configuration key this setting is transported under. */
-export const GLOBAL_PRIVACY_CONTROL_WIRE_KEY = "global_privacy_control";
-
-/**
- * Parses a wire value ("opt-out" / "opt-in"); anything else falls back to
- * the `OptOut` baseline default.
- */
-export function globalPrivacyControlFromWire(
-  value: string | null | undefined,
-): GlobalPrivacyControl {
-  return value === GlobalPrivacyControl.OptIn
-    ? GlobalPrivacyControl.OptIn
-    : GlobalPrivacyControl.OptOut;
-}

package/src/core/models/head_turn_direction.ts

@@ -1,15 +0,0 @@
-/**
- * Head-turn direction enum. Drives the direction-specific Enhanced
- * Smart Selfie liveness animation and the scan-state transitioner's
- * expected-direction tracking.
- *
- * Order is significant — used by the head-turn validator and surfaced
- * to analytics dashboards.
- */
-export const HEAD_TURN_DIRECTIONS = [
-  "look_left",
-  "look_right",
-  "look_up",
-] as const;
-
-export type HeadTurnDirection = (typeof HEAD_TURN_DIRECTIONS)[number];

package/src/core/models/job_type.ts

@@ -1,53 +0,0 @@
-/**
- * Identifies the type of identity verification job to perform.
- *
- * The raw numeric value is the `job_type_id` carried in API requests
- * and is part of the server wire-format contract — changing it is a
- * breaking change.
- */
-export const JobType = {
-  biometricKyc: 1,
-  smartSelfieAuthentication: 2,
-  smartSelfieEnrollment: 4,
-  enhancedKyc: 5,
-  documentVerification: 6,
-  bvn: 7,
-  enhancedDocumentVerification: 11,
-  /**
-   * Sentinel used when no job type has been configured, or when the
-   * server returns a value not recognised by this SDK version. Update
-   * the SDK to pick up new values.
-   */
-  unknown: -1,
-} as const;
-
-export type JobType = (typeof JobType)[keyof typeof JobType];
-
-export type JobTypeName = keyof typeof JobType;
-
-/**
- * Look up a `JobType` by its raw integer value. Returns `unknown` when
- * no case matches.
- */
-export function jobTypeFromValue(value: number): JobType {
-  const match = (Object.values(JobType) as number[]).find((v) => v === value);
-  return (match ?? JobType.unknown) as JobType;
-}
-
-/** True when completing this job involves capturing a selfie. */
-export function requiresSelfie(jobType: JobType): boolean {
-  return (
-    jobType === JobType.biometricKyc ||
-    jobType === JobType.smartSelfieAuthentication ||
-    jobType === JobType.smartSelfieEnrollment
-  );
-}
-
-/** True when completing this job involves capturing an identity document. */
-export function requiresDocument(jobType: JobType): boolean {
-  return (
-    jobType === JobType.biometricKyc ||
-    jobType === JobType.documentVerification ||
-    jobType === JobType.enhancedDocumentVerification
-  );
-}

package/src/core/models/ml_config.ts

@@ -1,47 +0,0 @@
-import type { FaceConfig } from "@smileid/usesmileid_bridge";
-import type {
-  FaceAnalyzer,
-  DocumentAnalyzer,
-} from "@smileid/usesmileid_platform_interface";
-
-/**
- * ML configuration — the registry maps a `CaptureType` to its analyzer
- * plus the configured wire payload the orchestrator pushes through
- * `FaceAnalyzer.configure()` at capture start.
- *
- * Per-capture-type registration is exposed via
- * `ml.analyzers((a) => a.forCaptureType(CaptureType.selfie, ...))`. The
- * concrete type is the `FaceAnalyzer` / `DocumentAnalyzer` exported by
- * each federated provider package; the `*Config` companion is the
- * pre-built wire payload computed from the DSL scope at builder
- * `build()` time and stable for the lifetime of the flow.
- *
- * `CaptureType` is a TypeScript enum (not a string union) so bare
- * string literals do not typecheck — partners must reference the
- * namespaced enum value.
- */
-
-export enum CaptureType {
-  /**
-   * Selfie capture — front-facing camera, face oval overlay, head-pose
-   * validation.
-   */
-  selfie = "selfie",
-  /** Document capture — rectangular frame, optional two-sided. */
-  document = "document",
-}
-
-export type AnalyzerRegistry = {
-  readonly selfie?: FaceAnalyzer;
-  /**
-   * Wire-shape `FaceConfig` built from the DSL scope (analyzer key,
-   * ScanPerformanceProfile, FaceDetectorConfig). Falls back to native
-   * platform defaults when omitted.
-   */
-  readonly selfieConfig?: FaceConfig;
-  readonly document?: DocumentAnalyzer;
-};
-
-export type MLConfig = {
-  readonly analyzers: AnalyzerRegistry;
-};

package/src/core/models/network_config.ts

@@ -1,138 +0,0 @@
-/**
- * Network stack types — partner credentials, transport tuning, logging
- * controls.
- *
- * Stub note: the network stack itself is not yet wired (see
- * `docs/Architecture.md § Rollout`). The DSL builder accepts these
- * values for forward-compatibility — the orchestrator will start
- * honouring them when the network/job-submission milestone lands.
- */
-
-import type { AxiosInstance } from "axios";
-
-import type { JobType } from "./job_type";
-
-/**
- * HTTP log verbosity — progressively reveals more of each request as
- * the level rises (less redaction).
- *
- * `LogLevel` is a TypeScript enum — partners must reference the
- * namespaced value (`LogLevel.body`); bare string literals do not
- * typecheck.
- */
-export enum LogLevel {
-  /** Suppress all network logging. */
-  none = "none",
-  /** Method, URL, and status only. */
-  basic = "basic",
-  /** `basic` + request/response headers (pre-redaction applied). */
-  headers = "headers",
-  /** `headers` + request/response bodies. Verbose — partner-debug only. */
-  body = "body",
-}
-
-export type NetworkLoggingConfig = {
-  readonly enabled: boolean;
-  readonly level: LogLevel;
-  readonly redactHeaders: readonly string[];
-};
-
-/**
- * Partner identity and per-job environment settings.
- *
- * The HTTP auth credential (`token`) and refresh callback (`onTokenExpired`)
- * live on the parent {@link NetworkInnerConfig} instead — they are
- * network-level concerns rather than partner identity.
- */
-export type PartnerConfig = {
-  readonly partnerId: string;
-  /**
-   * Partner webhook endpoint. Sent as the `callback-url` HTTP header
-   * on every request and, when non-empty, as the `callback_url`
-   * multipart form part on Enhanced/Biometric KYC submissions.
-   */
-  readonly callbackUrl: string;
-  readonly useSandbox: boolean;
-  /**
-   * Optional partner-supplied key/value metadata. When set, attached
-   * as the `partner_params` JSON multipart form part on Enhanced /
-   * Biometric KYC submissions.
-   */
-  readonly partnerParams?: Record<string, string>;
-};
-
-/**
- * Frozen snapshot of the network job + auth + partner + logging block.
- *
- * `token` is the HTTP credential stamped as the `smileid-token` header on
- * every outbound request — separate from `partnerConfig` because
- * authentication is a network-level credential, not partner identity.
- *
- * `onTokenExpired` is an optional async refresh callback invoked when the
- * server returns a `401 Unauthorized` on an authed endpoint. The SDK
- * collapses concurrent 401s into a single callback invocation via
- * `TokenHolder`, updates the stored token on success, and retries the
- * failed request once. If the callback throws (or the retry also returns
- * 401) the original 401 is surfaced unchanged.
- */
-export type NetworkInnerConfig = {
-  readonly jobType?: JobType;
-  readonly token?: string;
-  readonly onTokenExpired?: (previousToken: string) => Promise<string>;
-  readonly partnerConfig?: PartnerConfig;
-  readonly logging?: NetworkLoggingConfig;
-};
-
-/** Timeouts in seconds. */
-export type TimeoutConfig = {
-  readonly connect: number;
-  readonly read: number;
-  readonly write: number;
-  readonly call: number;
-};
-
-export type CacheConfig = {
-  readonly enabled: boolean;
-  readonly maxSize: number;
-};
-
-/**
- * Retry strategy. `none` is the default.
- *   - `none`: one attempt, no retry — `maxAttempts` is forced to 1
- *   - `exponential`: `delay = min(initialDelay × multiplier^attempt, maxDelay)` plus `±jitter`
- *   - `fixed`: constant `fixedDelay` between attempts
- */
-export enum RetryStrategy {
-  exponential = "exponential",
-  fixed = "fixed",
-  none = "none",
-}
-
-/** Delays are in seconds. */
-export type RetryConfig = {
-  readonly maxAttempts: number;
-  readonly strategy: RetryStrategy;
-  readonly initialDelay: number;
-  readonly multiplier: number;
-  readonly maxDelay: number;
-  readonly jitter: number;
-  readonly fixedDelay: number;
-};
-
-/**
- * A request interceptor that hooks into the SDK's axios client. The
- * SDK's built-in interceptors (gzip, auth, request-MAC, integrity)
- * implement this shape, and partners can supply their own.
- */
-export interface Interceptor {
-  /** Wire the interceptor's request/response hooks onto the client. */
-  attach(client: AxiosInstance): void;
-}
-
-export type NetworkConfig = {
-  readonly config?: NetworkInnerConfig;
-  readonly timeouts?: TimeoutConfig;
-  readonly cache?: CacheConfig;
-  readonly retry?: RetryConfig;
-  readonly interceptors?: readonly Interceptor[];
-};

package/src/core/models/params.ts

@@ -1,98 +0,0 @@
-/**
- * Job-specific parameters and consent records.
- */
-
-/** ISO-8601 timestamp string. */
-export type Timestamp = string;
-
-/** Records that a user has granted consent to biometric data collection. */
-export type ConsentInformation = {
-  /** `true` when the user tapped Allow on the consent screen. */
-  readonly granted: boolean;
-  /** ISO-8601 timestamp at which consent was granted. */
-  readonly grantedAt: Timestamp;
-  /** BCP-47 language code for the displayed consent notice (e.g. `"en"`). */
-  readonly noticeLanguage: string;
-  /** URL of the partner's privacy policy shown at consent time. */
-  readonly noticePrivacyPolicyUrl: string;
-};
-
-/**
- * Subject's personal details, sent as the `user_details` JSON part.
- * Requires non-blank `givenNames` and `lastName`, plus at least one of
- * `email` or `phoneNumber`.
- */
-export type UserDetails = {
-  /** Subject's given / first names. Required, non-blank. */
-  readonly givenNames: string;
-  /** Subject's family / last name. Required, non-blank. */
-  readonly lastName: string;
-  /** Optional email address. */
-  readonly email?: string;
-  /** Optional phone number in international format (leading `+`). */
-  readonly phoneNumber?: string;
-};
-
-/**
- * Identity fields for an Enhanced KYC job. `userDetails` is no longer
- * carried on this type — set it on the top-level builder via
- * `b.userDetails = ...` (shared across every job that needs the
- * `user_details` multipart part: enhanced_kyc, biometric_kyc, and the
- * v3 smartSelfie* endpoints).
- */
-export type EnhancedKYCParams = {
-  /** Document type (e.g. `"NATIONAL_ID"`, `"PASSPORT"`). */
-  readonly idType: string;
-  /** Document number. */
-  readonly idNumber: string;
-  /** ISO 3166-1 alpha-2 country code (e.g. `"KE"`). */
-  readonly country: string;
-  /** Optional bank code, sent as `bank_code`. */
-  readonly bankCode?: string;
-  /** Optional mobile operator code, sent as `operator`. */
-  readonly mobileOperator?: string;
-};
-
-/**
- * Identity fields for a Biometric KYC job. `userDetails` is no longer
- * carried on this type — set it on the top-level builder via
- * `b.userDetails = ...` (shared across every job that needs the
- * `user_details` multipart part: enhanced_kyc, biometric_kyc, and the
- * v3 smartSelfie* endpoints).
- */
-export type BiometricKYCParams = {
-  /** Document type (e.g. `"NATIONAL_ID"`, `"PASSPORT"`). */
-  readonly idType: string;
-  /** Document number. */
-  readonly idNumber: string;
-  /** ISO 3166-1 alpha-2 country code (e.g. `"KE"`). */
-  readonly country: string;
-  /**
-   * When `true`, sends `use_enrolled_image` so the server uses the
-   * partner's previously enrolled image. Capture still runs.
-   */
-  readonly useEnrolledImage: boolean;
-};
-
-/**
- * Identity fields for a Document Verification job. `userDetails` rides
- * on the top-level builder via `b.userDetails = ...`, not on this type.
- */
-export type DocumentVerificationParams = {
-  /** ISO 3166-1 alpha-2 country code (e.g. `"KE"`). */
-  readonly country: string;
-  /** Document type. Optional — the server classifies it when omitted. */
-  readonly idType?: string;
-};
-
-/**
- * Identity fields for an Enhanced Document Verification job.
- * `userDetails` rides on the top-level builder via `b.userDetails =
- * ...`, not on this type.
- */
-export type EnhancedDocumentVerificationParams = {
-  /** ISO 3166-1 alpha-2 country code (e.g. `"KE"`). */
-  readonly country: string;
-  /** Document type. Required — drives the ID-authority cross-check. */
-  readonly idType: string;
-};

package/src/core/models/result.test.ts

@@ -1,20 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { cancelled, failure, success } from "./result";
-
-describe("UseSmileIDResult factories", () => {
-  it("success carries the value under a 'success' status", () => {
-    expect(success(42)).toEqual({ status: "success", value: 42 });
-  });
-
-  it("failure carries the error under a 'failure' status", () => {
-    const error = new Error("boom");
-    expect(failure(error)).toEqual({ status: "failure", error });
-  });
-
-  it("cancelled is a distinct status with no value/error payload", () => {
-    const result = cancelled();
-    expect(result).toEqual({ status: "cancelled" });
-    // Partners switch on `status`; cancelled must NOT masquerade as failure.
-    expect(result.status).not.toBe("failure");
-  });
-});

package/src/core/models/result.ts

@@ -1,33 +0,0 @@
-/**
- * The outcome of an SDK operation: success with a value, failure with an
- * error, or cancellation when the user exits the flow. Surfaced to
- * partners through `onResult`.
- *
- * Partners never need to unwrap a `UseSmileIDResult` directly — all
- * errors are automatically surfaced through the `onResult` callback.
- * The discriminated union lets partner code `switch (result.status)`
- * and exhaust the branches without try/catch ceremony.
- */
-export type UseSmileIDResult<T> =
-  | { readonly status: "success"; readonly value: T }
-  | { readonly status: "failure"; readonly error: unknown }
-  | { readonly status: "cancelled" };
-
-/** A successful outcome carrying the resulting value. */
-export function success<T>(value: T): UseSmileIDResult<T> {
-  return { status: "success", value };
-}
-
-/** A failed outcome carrying the causing error. */
-export function failure<T>(error: unknown): UseSmileIDResult<T> {
-  return { status: "failure", error };
-}
-
-/**
- * The user deliberately exited the flow without completing or failing it
- * (e.g. back-pressed out of the first screen) — distinct from a failure
- * so cancellation can be handled separately.
- */
-export function cancelled<T>(): UseSmileIDResult<T> {
-  return { status: "cancelled" };
-}