@smileid/usesmileid 12.0.2 → 12.1.0

package/src/presentation/flow/dsl/builder/ml_builder.ts

@@ -1,210 +0,0 @@
-import type {
-  FaceAnalyzer,
-  DocumentAnalyzer,
-} from "@smileid/usesmileid_platform_interface";
-import {
-  ScanPerformanceProfile,
-  type FaceConfig,
-  type FaceDetectorConfig,
-  type FaceDetectorMode,
-} from "@smileid/usesmileid_bridge";
-import {
-  CaptureType,
-  type AnalyzerRegistry,
-  type MLConfig,
-} from "../../../../core/models/ml_config";
-
-/**
- * `b.ml((m) => { m.analyzers((a) => { a.forCaptureType(CaptureType.selfie, (face) => face.add(useSmileIDVisionFace)); }); })`
- *
- * Shape: `ml → analyzers → forCaptureType(type, callback) → add(analyzer)`
- *
- * Each provider package (`usesmileid_vision_face`,
- * `usesmileid_mlkit_face`, …) exports a ready-to-use `FaceAnalyzer`
- * / `DocumentAnalyzer` value. Partners register them per capture
- * type via `forCaptureType`.
- *
- * Type-safety note: distinct `Face*` and `Document*` scope classes
- * prevent the partner from setting the wrong slot inside a
- * `forCaptureType` closure. Without this, a typo like
- * `forCaptureType(CaptureType.selfie, (a) => a.documentAnalyzer = ...)` would
- * silently drop the document analyzer and leave the face slot empty —
- * the orchestrator would then refuse to run face capture with no
- * clear cause. Distinct scopes block that at compile time.
- */
-
-export class FaceAnalyzerScope {
-  /** Registers a detection backend for this capture type. */
-  add(analyzer: FaceAnalyzer): void {
-    this._analyzer = analyzer;
-  }
-  /** @internal */
-  _analyzer?: FaceAnalyzer;
-
-  /**
-   * Scan-loop tuning preset (Fast / Balanced / HighQuality). Default is
-   * `Balanced`; the orchestrator lifts the field into `FaceConfig` at
-   * configure time.
-   */
-  scanPerformanceProfile: ScanPerformanceProfile =
-    ScanPerformanceProfile.Balanced;
-
-  /**
-   * Face-detection preset. A token (`"performance"` / `"default"` / `"low"`)
-   * the native backend resolves to its own engine-calibrated thresholds;
-   * defaults to `"default"`. Set individual {@link faceDetectorConfig} fields
-   * to override specific thresholds on top of the resolved preset.
-   */
-  detectorMode: FaceDetectorMode = "default";
-
-  /**
-   * Fine-grained face-detector thresholds. Omit to use the native
-   * session's platform-tuned defaults — partners typically leave this
-   * `undefined` and only set it for specific device/lighting
-   * constraints.
-   */
-  faceDetectorConfig?: FaceDetectorConfig;
-
-  /**
-   * Lift the DSL state into the wire-shape `FaceConfig` that
-   * `FaceAnalyzer.configure()` consumes.
-   *
-   * Returns `undefined` when no analyzer has been registered — callers
-   * skip the `configure()` call in that case rather than pushing a partial
-   * config at the native side.
-   *
-   * @internal
-   */
-  toFaceConfig(): FaceConfig | undefined {
-    const analyzer = this._analyzer;
-    if (!analyzer) return undefined;
-    const profile = this.scanPerformanceProfile;
-    const detector = this.faceDetectorConfig;
-    return {
-      selfieCaptureTimeout: profile.timeoutMs,
-      numSamples: profile.numSamples,
-      sampleInterval: profile.sampleIntervalMs,
-      stayInFoundDuration: profile.stayInFoundMs,
-      // Detection preset token. The native backend resolves this to its own
-      // engine-calibrated thresholds; the explicit fields below (when set)
-      // are overlaid on top of that resolved preset.
-      faceDetectorMode: this.detectorMode,
-      // Detector thresholds — spread only when the partner set them; the
-      // wire schema treats `undefined` as "use the native default".
-      ...(detector?.minFillThreshold !== undefined
-        ? { minFillThreshold: detector.minFillThreshold }
-        : {}),
-      ...(detector?.maxFillThreshold !== undefined
-        ? { maxFillThreshold: detector.maxFillThreshold }
-        : {}),
-      ...(detector?.faceDetectorMinScore !== undefined
-        ? { faceDetectorMinScore: detector.faceDetectorMinScore }
-        : {}),
-      ...(detector?.centerToleranceX !== undefined
-        ? { centerToleranceX: detector.centerToleranceX }
-        : {}),
-      ...(detector?.centerToleranceY !== undefined
-        ? { centerToleranceY: detector.centerToleranceY }
-        : {}),
-      ...(detector?.motionBlurMinIou !== undefined
-        ? { motionBlurMinIou: detector.motionBlurMinIou }
-        : {}),
-      ...(detector?.motionBlurMinDuration !== undefined
-        ? { motionBlurMinDuration: detector.motionBlurMinDuration }
-        : {}),
-      ...(detector?.minTopPadding !== undefined
-        ? { minTopPadding: detector.minTopPadding }
-        : {}),
-      ...(detector?.minFaceBoundsThreshold !== undefined
-        ? { minFaceBoundsThreshold: detector.minFaceBoundsThreshold }
-        : {}),
-      ...(detector?.maxFaceBoundsThreshold !== undefined
-        ? { maxFaceBoundsThreshold: detector.maxFaceBoundsThreshold }
-        : {}),
-      ...(detector?.minSmileProbability !== undefined
-        ? { minSmileProbability: detector.minSmileProbability }
-        : {}),
-      analyzerFactoryKey: analyzer.key,
-    };
-  }
-}
-
-export class DocumentAnalyzerScope {
-  /** Registers a detection backend for this capture type. */
-  add(analyzer: DocumentAnalyzer): void {
-    this._analyzer = analyzer;
-  }
-  /** @internal */
-  _analyzer?: DocumentAnalyzer;
-}
-
-export class AnalyzerRegistryBuilder {
-  private _selfie?: FaceAnalyzer | undefined;
-  private _selfieConfig?: FaceConfig | undefined;
-  private _document?: DocumentAnalyzer | undefined;
-
-  /**
-   * Registers and tunes the analyzer(s) for the selfie capture type.
-   * Calling it again for the same capture type replaces the previous
-   * registration.
-   */
-  forCaptureType(
-    captureType: CaptureType.selfie,
-    block: (a: FaceAnalyzerScope) => void,
-  ): void;
-  /**
-   * Registers and tunes the analyzer(s) for the document capture type.
-   * Calling it again for the same capture type replaces the previous
-   * registration.
-   */
-  forCaptureType(
-    captureType: CaptureType.document,
-    block: (a: DocumentAnalyzerScope) => void,
-  ): void;
-  forCaptureType(
-    captureType: CaptureType,
-    block:
-      | ((a: FaceAnalyzerScope) => void)
-      | ((a: DocumentAnalyzerScope) => void),
-  ): void {
-    if (captureType === CaptureType.selfie) {
-      const scope = new FaceAnalyzerScope();
-      (block as (a: FaceAnalyzerScope) => void)(scope);
-      if (scope._analyzer) {
-        this._selfie = scope._analyzer;
-        // Snapshot the scope's DSL state into a wire `FaceConfig` now —
-        // build() time — so the orchestrator never has to reach into the
-        // builder.
-        this._selfieConfig = scope.toFaceConfig();
-      }
-      return;
-    }
-    const scope = new DocumentAnalyzerScope();
-    (block as (a: DocumentAnalyzerScope) => void)(scope);
-    if (scope._analyzer) this._document = scope._analyzer;
-  }
-
-  build(): AnalyzerRegistry {
-    return Object.freeze({
-      ...(this._selfie ? { selfie: this._selfie } : {}),
-      ...(this._selfieConfig ? { selfieConfig: this._selfieConfig } : {}),
-      ...(this._document ? { document: this._document } : {}),
-    });
-  }
-}
-
-export class UseSmileIDMLBuilder {
-  private _analyzers?: AnalyzerRegistryBuilder;
-
-  /** Registers the ML analyzers for the flow, keyed by capture type. */
-  analyzers(block: (a: AnalyzerRegistryBuilder) => void): void {
-    if (!this._analyzers) this._analyzers = new AnalyzerRegistryBuilder();
-    block(this._analyzers);
-  }
-
-  build(): MLConfig {
-    return Object.freeze({
-      analyzers: this._analyzers ? this._analyzers.build() : Object.freeze({}),
-    });
-  }
-}

package/src/presentation/flow/dsl/builder/screens_builder.ts

@@ -1,276 +0,0 @@
-import type { ReactNode } from "react";
-import { CaptureType } from "../../../../core/models/ml_config";
-import type { DocumentType } from "../../../../core/models/document_type";
-import { DocumentCaptureMode } from "../../../../core/models/document_capture_mode";
-import type { ConsentInformation } from "../../../../core/models/params";
-import type { InstructionGuideline } from "../../model/instruction_guideline";
-import type { HeroAnimationSource } from "../../model/instructions_defaults";
-
-export { CaptureType };
-
-/**
- * Screens DSL:
- *
- *   screens → consent((c) => …)
- *           → instructions((i) => …)
- *           → capture({ captureType }, (cap) => cap.selfie(…) | cap.document(…))
- *           → preview((p) => …)
- *           → processing((p) => …)
- *
- * Each screen-builder call appends a step to the orchestrator's
- * `flowSteps` list in the order declared. The partner can omit
- * screens entirely (no `screens.consent(…)` call → no consent screen).
- */
-
-export type ButtonSlot = (props: {
-  onClick: () => void;
-  enabled: boolean;
-}) => ReactNode;
-
-// --- Per-screen builders ---------------------------------------------------
-
-// Required fields stay optional on the type because partners assign them by mutating this builder; the flow validator rejects a missing one.
-export class ConsentConfigBuilder {
-  /** Required. Your company name, shown in the consent copy. */
-  partnerName = "";
-  /** Required. Your logo, shown on the consent screen next to the Smile ID icon. */
-  partnerIcon?: ReactNode;
-  /** Required. URL of your privacy policy, linked from the consent screen. */
-  partnerPrivacyPolicyUrl?: string;
-  /**
-   * Whether to show the "Powered by Smile ID" attribution. Defaults to
-   * true.
-   */
-  showAttribution = true;
-  /**
-   * Callback invoked with the `ConsentInformation` when the user grants
-   * consent.
-   */
-  onConsentGranted?: (info: ConsentInformation) => void;
-  /** Provides a custom allow/agree button in place of the default. */
-  allowButton?: ButtonSlot;
-  /** Provides a custom deny/cancel button in place of the default. */
-  denyButton?: ButtonSlot;
-}
-
-export class InstructionsConfigBuilder {
-  /**
-   * The leading, non-emphasized part of the instructions screen title.
-   * Defaults to the localized prefix.
-   */
-  titlePrefix?: string;
-  /**
-   * The emphasized (highlighted) part of the instructions screen title.
-   * Defaults to the localized "selfie".
-   */
-  titleEmphasis?: string;
-  /**
-   * Name of the hero animation asset shown at the top of the
-   * instructions screen. Unset uses the selfie hero (or the ESS hero
-   * when enhanced liveness is on).
-   */
-  heroAnimation?: HeroAnimationSource;
-  /** Heading for the list of capture guidelines (rendered uppercase). */
-  guidelinesSectionTitle?: string;
-  /** The list of guideline items shown to the user. Empty uses the defaults. */
-  guidelines: InstructionGuideline[] = [];
-  /**
-   * Whether to show the "Powered by Smile ID" attribution. Defaults to
-   * true.
-   */
-  showAttribution = true;
-  /** When true, draws the face-oval ring around the hero animation. */
-  showHeroOval = true;
-  /** Provides a custom continue button in place of the default. */
-  continueButton?: ButtonSlot;
-}
-
-export class SelfieCaptureConfigBuilder {
-  /**
-   * When true, the whole selfie session captures on the rear camera so an
-   * assisting agent can point it at the subject. Cannot be combined with
-   * {@link enableEnhancedLiveness}.
-   */
-  allowAgentMode = false;
-  /**
-   * When true, uses the enhanced active-liveness capture path. Defaults
-   * to false.
-   */
-  enableEnhancedLiveness = false;
-}
-
-export class DocumentCaptureConfigBuilder {
-  /**
-   * The kind of document being captured, which drives the capture
-   * framing and aspect ratio. **Required** — missing it fails validation.
-   */
-  documentType?: DocumentType;
-  /**
-   * Whether the document is captured automatically when held steady, or
-   * manually by shutter. Defaults to auto-capture with a 10s manual
-   * fallback.
-   */
-  captureMode: DocumentCaptureMode =
-    DocumentCaptureMode.AutoCaptureWithManualFallback();
-  /**
-   * When true, lets the user pick an existing document image from the
-   * gallery. Defaults to false.
-   */
-  allowGalleryUpload = false;
-  /** When true, captures both the front and back of the document. Defaults to true. */
-  captureBothSides = true;
-  /** When true, lets the user skip capturing the back side. Defaults to false. */
-  allowSkipBack = false;
-  /**
-   * Optional fixed aspect ratio for the document frame when the ID's
-   * dimensions are known in advance — e.g. CR-80 ID card = 1.586.
-   */
-  knownIdAspectRatio?: number;
-
-  /** The `documentType`'s aspect ratio when present, otherwise `knownIdAspectRatio`. */
-  get resolvedAspectRatio(): number | undefined {
-    return this.documentType?.knownAspectRatio ?? this.knownIdAspectRatio;
-  }
-}
-
-export class CaptureConfigBuilder {
-  /** What this screen captures — a selfie or a document. Required. */
-  captureType?: CaptureType;
-  /** Provides a custom start/capture button in place of the default. */
-  startButton?: ButtonSlot;
-
-  private _selfie?: SelfieCaptureConfigBuilder;
-  private _document?: DocumentCaptureConfigBuilder;
-
-  /**
-   * Configures selfie-specific capture options (agent mode, enhanced
-   * liveness).
-   */
-  selfie(block: (s: SelfieCaptureConfigBuilder) => void): void {
-    if (!this._selfie) this._selfie = new SelfieCaptureConfigBuilder();
-    block(this._selfie);
-  }
-
-  /**
-   * Configures document-specific capture options (document type, capture
-   * mode, gallery upload, two-sided capture).
-   */
-  document(block: (d: DocumentCaptureConfigBuilder) => void): void {
-    if (!this._document) this._document = new DocumentCaptureConfigBuilder();
-    block(this._document);
-  }
-
-  /** @internal Snapshot used by the orchestrator. */
-  get selfieConfig(): SelfieCaptureConfigBuilder | undefined {
-    return this._selfie;
-  }
-
-  /** @internal Snapshot used by the orchestrator. */
-  get documentConfig(): DocumentCaptureConfigBuilder | undefined {
-    return this._document;
-  }
-}
-
-export class PreviewConfigBuilder {
-  /** Whether the preview screen offers a retake action. */
-  allowRetake = true;
-  /**
-   * Whether to show the "Powered by Smile ID" attribution. Defaults to
-   * true.
-   */
-  showAttribution = true;
-}
-
-export class ProcessingConfigBuilder {
-  /**
-   * When true, shows a numeric progress percentage while the job is
-   * processing.
-   */
-  showProgressPercentage = true;
-  /**
-   * Whether to show the "Powered by Smile ID" attribution. Defaults to
-   * true.
-   */
-  showAttribution = true;
-  /** Provides a custom continue button in place of the default. */
-  continueButton?: ButtonSlot;
-  /** Provides a custom retry button in place of the default. */
-  retryButton?: ButtonSlot;
-  /** Provides a custom exit button in place of the default. */
-  exitButton?: ButtonSlot;
-}
-
-// --- Discriminated union the orchestrator consumes -------------------------
-
-export type ScreenSpec =
-  | { readonly kind: "consent"; readonly config: ConsentConfigBuilder }
-  | {
-      readonly kind: "instructions";
-      readonly config: InstructionsConfigBuilder;
-    }
-  | { readonly kind: "capture"; readonly config: CaptureConfigBuilder }
-  | { readonly kind: "preview"; readonly config: PreviewConfigBuilder }
-  | { readonly kind: "processing"; readonly config: ProcessingConfigBuilder };
-
-export type ScreensConfig = {
-  readonly steps: readonly ScreenSpec[];
-};
-
-// --- Top-level screens builder ---------------------------------------------
-
-export class ScreensBuilder {
-  private _steps: ScreenSpec[] = [];
-
-  /**
-   * Adds a consent screen that collects the user's agreement to
-   * biometric data processing before capture.
-   */
-  consent(block?: (c: ConsentConfigBuilder) => void): void {
-    const config = new ConsentConfigBuilder();
-    block?.(config);
-    this._steps.push({ kind: "consent", config });
-  }
-
-  /**
-   * Adds an instructions screen explaining what the user is about to do.
-   */
-  instructions(block?: (i: InstructionsConfigBuilder) => void): void {
-    const config = new InstructionsConfigBuilder();
-    block?.(config);
-    this._steps.push({ kind: "instructions", config });
-  }
-
-  /**
-   * Adds a capture screen that runs the camera and on-device detection
-   * for a selfie or document.
-   */
-  capture(block: (c: CaptureConfigBuilder) => void): void {
-    const config = new CaptureConfigBuilder();
-    block(config);
-    this._steps.push({ kind: "capture", config });
-  }
-
-  /**
-   * Adds a preview screen that lets the user review the captured image
-   * and optionally retake it.
-   */
-  preview(block?: (p: PreviewConfigBuilder) => void): void {
-    const config = new PreviewConfigBuilder();
-    block?.(config);
-    this._steps.push({ kind: "preview", config });
-  }
-
-  /**
-   * Adds a processing screen shown while the job is submitted, displaying
-   * success, failure, or retry states.
-   */
-  processing(block?: (p: ProcessingConfigBuilder) => void): void {
-    const config = new ProcessingConfigBuilder();
-    block?.(config);
-    this._steps.push({ kind: "processing", config });
-  }
-
-  build(): ScreensConfig {
-    return Object.freeze({ steps: Object.freeze([...this._steps]) });
-  }
-}

package/src/presentation/flow/dsl/builder/theme_builder.ts

@@ -1,119 +0,0 @@
-import {
-  DEFAULT_FONT_FAMILY,
-  defaultDarkTheme,
-  defaultLightTheme,
-  typographyWithFontFamily,
-  type UseSmileIDColors,
-  type UseSmileIDTheme,
-} from "../../../theme/theme";
-
-/** A color that adapts to the active light/dark color scheme. */
-export type AdaptiveColor = {
-  readonly light: string;
-  readonly dark: string;
-};
-
-/** Pair of resolved themes — renderer picks one based on system scheme. */
-export type ThemeConfiguration = {
-  readonly light: UseSmileIDTheme;
-  readonly dark: UseSmileIDTheme;
-};
-
-/**
- * `b.theme((t) => { t.primaryColor = color('#1A73E8', '#4DA3FF'); })`
- *
- * Each color slot accepts an [AdaptiveColor] pair. Build produces a
- * [ThemeConfiguration] carrying both resolved themes; the renderer
- * picks light or dark at mount time based on the active color scheme.
- */
-export class ThemeConfigBuilder {
-  /** Primary brand color used for key actions and accents. */
-  primaryColor?: AdaptiveColor;
-
-  /**
-   * Foreground color used on top of the primary color (for example
-   * button text).
-   */
-  primaryForeground?: AdaptiveColor;
-
-  /** Secondary color used for less prominent surfaces and actions. */
-  secondaryColor?: AdaptiveColor;
-
-  /** Accent color used for highlights and selected states. */
-  accentColor?: AdaptiveColor;
-
-  /** Optional font family applied to all SDK text. */
-  fontFamily?: string;
-
-  /** Corner radius applied to buttons. */
-  buttonShape?: number;
-
-  /** Corner radius applied to cards and surfaces. */
-  cardShape?: number;
-
-  /**
-   * Builds an adaptive color that resolves to the light or dark value
-   * based on the active appearance.
-   */
-  color(light: string, dark: string): AdaptiveColor {
-    return Object.freeze({ light, dark });
-  }
-
-  /**
-   * Builds a corner-shape value from the given radius. Returns the input
-   * radius unchanged — React Native resolves shape at render time via
-   * `borderRadius`, so the `buttonShape` / `cardShape` properties are
-   * plain numbers.
-   */
-  shape(radius: number): number {
-    return radius;
-  }
-
-  /**
-   * Build a [ThemeConfiguration] that pairs a fully-resolved light
-   * theme with its dark counterpart. Each `AdaptiveColor` override maps
-   * to its canonical key on the matching variant.
-   */
-  build(): ThemeConfiguration {
-    return Object.freeze({
-      light: this._resolve("light", defaultLightTheme),
-      dark: this._resolve("dark", defaultDarkTheme),
-    });
-  }
-
-  private _resolve(
-    variant: "light" | "dark",
-    base: UseSmileIDTheme,
-  ): UseSmileIDTheme {
-    const pick = (c: AdaptiveColor | undefined): string | undefined =>
-      c === undefined ? undefined : c[variant];
-    // Capture each picked colour once so the `!== undefined` guard narrows
-    // it to `string` — re-invoking `pick` inside the spread value would
-    // leave it `string | undefined` and trip `exactOptionalPropertyTypes`.
-    const primary = pick(this.primaryColor);
-    const primaryForeground = pick(this.primaryForeground);
-    const secondary = pick(this.secondaryColor);
-    const accent = pick(this.accentColor);
-    const colorOverrides: Partial<UseSmileIDColors> = {
-      ...(primary !== undefined ? { primary } : {}),
-      ...(primaryForeground !== undefined ? { primaryForeground } : {}),
-      ...(secondary !== undefined ? { secondary } : {}),
-      ...(accent !== undefined ? { accent } : {}),
-    };
-    return Object.freeze({
-      ...base,
-      colors: { ...base.colors, ...colorOverrides },
-      typography: typographyWithFontFamily(
-        base.typography,
-        this.fontFamily ?? DEFAULT_FONT_FAMILY,
-      ),
-      shapes: {
-        ...base.shapes,
-        ...(this.buttonShape !== undefined
-          ? { buttonRadius: this.buttonShape }
-          : {}),
-        ...(this.cardShape !== undefined ? { cardRadius: this.cardShape } : {}),
-      },
-    });
-  }
-}

package/src/presentation/flow/dsl/flow_build_result.ts

@@ -1,37 +0,0 @@
-import type { ValidationStateInvalid } from "../validation/validation_state";
-import type { FlowConfigurationSnapshot } from "./use_smile_id_flow_builder";
-
-/**
- * Result of `useSmileIDBuilder(configure)` and the internal
- * `UseSmileIDFlowBuilder.build()`.
- *
- * Discriminated on `kind`. This type is `@internal` — partners interact
- * with `<UseSmileIDBuilder>` exclusively, which calls `build()` and
- * dispatches on the result. The `kind: 'invalid'` case is delivered
- * to partners as a typed `BuilderValidationException` through
- * `onResult.failure`.
- */
-export type FlowBuildResult = FlowBuildResultSuccess | FlowBuildResultInvalid;
-
-/**
- * Builder produced a configuration that passed every validation rule.
- * `<UseSmileIDBuilder>` renders this case end-to-end.
- */
-export type FlowBuildResultSuccess = {
-  readonly kind: "success";
-  readonly configuration: FlowConfigurationSnapshot;
-};
-
-/**
- * Builder produced at least one `error`-severity validation issue.
- * `validation` carries the invalid branch of [ValidationState] — its
- * `issues` array is non-empty by construction.
- *
- * The wrapper component that renders the failure sources `onResult` /
- * `enableDebugMode` from the builder reference it already holds rather
- * than from this result.
- */
-export type FlowBuildResultInvalid = {
-  readonly kind: "invalid";
-  readonly validation: ValidationStateInvalid;
-};