@smileid/usesmileid 12.0.2 → 12.1.0

package/src/presentation/flow/screen/orchestrated_capture_screen.tsx

@@ -1,344 +0,0 @@
-import { useEffect, useState } from "react";
-import type {
-  DocumentAnalyzer,
-  FaceAnalyzer,
-} from "@smileid/usesmileid_platform_interface";
-import type {
-  CaptureReadyEvent,
-  ImageTypeId,
-} from "@smileid/usesmileid_bridge";
-import {
-  CaptureReadyEventKind,
-  DeviceIntegrityProvider,
-  DocumentSide,
-  ImageType,
-} from "@smileid/usesmileid_bridge";
-import { CaptureType } from "../../../core/models/ml_config";
-import { defaultFrameAspectRatio } from "../../../core/models/document_type";
-// Deep import: SmileExifTagger is SDK-internal, kept out of the public barrel.
-import { SmileExifTagger } from "@smileid/usesmileid_bridge/src/exif/smile_exif_tagger";
-import type { CaptureConfigBuilder } from "../dsl/builder/screens_builder";
-import { resolveFaceSessionConfig } from "./helpers/face_session_config";
-import { useCaptureOrientationLock } from "../../screen/helpers/use_capture_orientation_lock";
-import { resolveJpegQuality } from "../../../data/model/sdk_config_capture";
-import { UseSmileIDCaptureScreen } from "../../screen/use_smile_id_capture_screen";
-import { defaultLightTheme } from "../../theme/theme";
-import { UseSmileIDDocumentBackInstructions } from "../../screen/use_smile_id_document_back_instructions";
-import { useFlowNavigation } from "../flow_navigation_context";
-import { UseSmileIDOrchestratedScreenHost } from "./use_smile_id_orchestrated_screen_host";
-
-export type OrchestratedCaptureScreenProps = {
-  readonly configuration: CaptureConfigBuilder;
-};
-
-/**
- * Orchestrated capture screen — wraps `UseSmileIDCaptureScreen`, owns the
- * analyzer lifecycle (configure on mount, close on unmount), and persists
- * artifacts on the navigation manager before advancing. For two-sided
- * document captures it tracks the active side: front → persist + flip to
- * back, back → persist + advance.
- */
-export function OrchestratedCaptureScreen({
-  configuration,
-}: OrchestratedCaptureScreenProps) {
-  const navigationManager = useFlowNavigation();
-
-  // Validator guarantees captureType is set before render (else
-  // InvalidMissingCaptureTypeException short-circuits to onResult.failure).
-  const captureType = configuration.captureType!;
-  const documentConfig = configuration.documentConfig;
-  const documentType = documentConfig?.documentType;
-  // Back captured only when the type has one AND both sides were asked for.
-  const capturesBack =
-    documentType?.hasBackSide === true &&
-    (documentConfig?.captureBothSides ?? false);
-  const allowSkipBack = documentConfig?.allowSkipBack ?? false;
-  // With a `preview {}` after capture, the front exits to that preview and the
-  // back is captured on re-entry; otherwise the front→back flip is in-screen.
-  const previewFollows = navigationManager.documentPreviewFollowsCapture();
-
-  // Side derived from what's already captured on (re)mount: fresh entry starts
-  // front; re-entry for the back (front already persisted via the per-side
-  // preview loop) starts back and shows the flip interstitial.
-  const frontAlreadyCaptured =
-    navigationManager.captured.frontDocumentPath !== undefined;
-  const [currentDocumentSide, setCurrentDocumentSide] = useState<DocumentSide>(
-    capturesBack && frontAlreadyCaptured
-      ? DocumentSide.Back
-      : DocumentSide.Front,
-  );
-  const [showBackInstructions, setShowBackInstructions] = useState(
-    capturesBack && frontAlreadyCaptured,
-  );
-
-  // Pin orientation: documents to their type (landscape ID / portrait booklet),
-  // selfie to portrait. The flip interstitial is a portrait instruction screen,
-  // so it must NOT inherit the document's landscape lock — force portrait while
-  // it shows, then revert to the document orientation for the back capture.
-  const exitOrientations =
-    navigationManager.configuration.config?.exitOrientations;
-  useCaptureOrientationLock(
-    captureType === CaptureType.document && !showBackInstructions
-      ? (documentType?.orientation ?? "Landscape")
-      : "Portrait",
-    {
-      ...(exitOrientations !== undefined ? { exitLock: exitOrientations } : {}),
-    },
-  );
-
-  // Selfie also pushes the registry-built wire FaceConfig; documents have no
-  // per-flow config payload yet (native session applies platform defaults).
-  const analyzer: FaceAnalyzer | DocumentAnalyzer | undefined =
-    captureType === CaptureType.selfie
-      ? navigationManager.configuration.ml?.analyzers.selfie
-      : navigationManager.configuration.ml?.analyzers.document;
-
-  useEffect(() => {
-    if (!analyzer) return;
-    if (captureType === CaptureType.selfie && "key" in analyzer) {
-      const baseConfig = navigationManager.configuration.ml?.analyzers
-        .selfieConfig ?? { analyzerFactoryKey: analyzer.key };
-      // enableEnhancedLiveness lives on the SCREEN config, not the analyzer;
-      // the resolver merges it, applies sdk_config overrides, and pins
-      // numSamples to the ESS hold-still count when ESS is active.
-      void analyzer.configure(
-        resolveFaceSessionConfig(
-          baseConfig,
-          configuration.selfieConfig?.enableEnhancedLiveness ?? false,
-          navigationManager.resolvedSdkConfig,
-        ),
-      );
-    } else if (captureType === CaptureType.document && !("key" in analyzer)) {
-      // Active side drives the native `document_front/back.jpg` filename.
-      // Reconfiguring on currentDocumentSide change (see deps) sets `back`
-      // before the second capture so it doesn't overwrite the front.
-      const documentJpegQuality = resolveJpegQuality(
-        navigationManager.resolvedSdkConfig?.document,
-      );
-      void analyzer.configure({
-        documentSide: currentDocumentSide,
-        ...(documentJpegQuality !== undefined ? { documentJpegQuality } : {}),
-      });
-    }
-    return () => {
-      void analyzer.close();
-    };
-  }, [
-    analyzer,
-    captureType,
-    navigationManager,
-    configuration,
-    currentDocumentSide,
-  ]);
-
-  return (
-    <UseSmileIDOrchestratedScreenHost
-      content={({ navigationManager, onBack, onNavigateNext }) => {
-        if (!analyzer) {
-          // Validator should have caught this; hard-fail loudly rather
-          // than render an empty preview.
-          throw new Error(
-            `OrchestratedCaptureScreen: no ${captureType} analyzer registered in the ML DSL`,
-          );
-        }
-        if (
-          captureType === CaptureType.document &&
-          capturesBack &&
-          showBackInstructions
-        ) {
-          // Flip interstitial between front and back captures.
-          return (
-            <UseSmileIDDocumentBackInstructions
-              documentTypeDisplayName={documentType?.displayName ?? ""}
-              allowSkip={allowSkipBack}
-              onCaptureBack={() => setShowBackInstructions(false)}
-              onSkip={() => {
-                // Front already persisted; route past the back capture +
-                // its preview, submission proceeds with no back image.
-                navigationManager.skipDocumentBack();
-                onNavigateNext();
-              }}
-              onBack={() => {
-                if (previewFollows) {
-                  // Re-entered via the per-side preview loop: back to the front preview.
-                  onBack();
-                  return;
-                }
-                // In-screen flip: re-capture the front.
-                setShowBackInstructions(false);
-                setCurrentDocumentSide(DocumentSide.Front);
-              }}
-            />
-          );
-        }
-        return (
-          <UseSmileIDCaptureScreen
-            // Remount per document side so the camera resets between front and back captures.
-            key={
-              captureType === CaptureType.document
-                ? `document-capture-${currentDocumentSide}`
-                : "capture"
-            }
-            captureType={captureType}
-            analyzer={analyzer}
-            // Capture is always light; pass the partner's resolved light tokens
-            // so partner colours still apply (the screen forces light internally).
-            theme={
-              navigationManager.configuration.theme?.light ?? defaultLightTheme
-            }
-            enableEnhancedLiveness={
-              configuration.selfieConfig?.enableEnhancedLiveness ?? false
-            }
-            allowAgentMode={configuration.selfieConfig?.allowAgentMode ?? false}
-            {...(captureType === CaptureType.document && documentConfig
-              ? {
-                  // Type ratio → partner override → orientation default; matches
-                  // the preview/processing frames so all three share one shape.
-                  knownIdAspectRatio:
-                    documentConfig.resolvedAspectRatio ??
-                    defaultFrameAspectRatio(
-                      documentType?.orientation ?? "Landscape",
-                    ),
-                  captureMode: documentConfig.captureMode,
-                  allowGalleryUpload: documentConfig.allowGalleryUpload,
-                  documentSide: currentDocumentSide,
-                  ...(documentType?.kind
-                    ? { documentTypeKind: documentType.kind }
-                    : {}),
-                  onDocumentOrigin: (origin) =>
-                    navigationManager.recordDocumentImageOrigin(
-                      currentDocumentSide,
-                      origin,
-                    ),
-                  onClose: () => navigationManager.exit(),
-                }
-              : {})}
-            {...(configuration.startButton !== undefined
-              ? { startButton: configuration.startButton }
-              : {})}
-            onBack={() => {
-              // Back on the back-side capture returns to the flip interstitial.
-              if (
-                captureType === CaptureType.document &&
-                capturesBack &&
-                currentDocumentSide === DocumentSide.Back
-              ) {
-                setShowBackInstructions(true);
-                return;
-              }
-              onBack();
-            }}
-            onCaptureComplete={(events, telemetry) => {
-              const primary = pickPrimaryCaptureUrl(events, captureType);
-              if (!primary) {
-                // Pipeline finished without the expected artifact — stay so the user can retry.
-                return;
-              }
-
-              // Stamp the Smile EXIF UserComment tag before persisting
-              // (blank partnerId → native no-op). Context is rebound per
-              // capture because partnerConfig may change across re-renders
-              // (partner builder closures are not memoised).
-              //
-              // `navigationManager.partnerId` resolves the JWT's canonical partner_id (e.g.
-              // "002"), falling back to the config value — see FlowNavigationManager.partnerId.
-              const partnerId = navigationManager.partnerId;
-              const imageTypeForCapture: ImageTypeId =
-                captureType === CaptureType.selfie
-                  ? ImageType.Selfie
-                  : capturesBack && currentDocumentSide === DocumentSide.Back
-                    ? ImageType.DocumentBack
-                    : ImageType.DocumentFront;
-
-              const livenessUrls = events
-                .filter(
-                  (event) => event.kind === CaptureReadyEventKind.Liveness,
-                )
-                .map((event) => event.url);
-
-              // Source the device fingerprint from the same native signal the metadata
-              // payload uses so the EXIF tag's `fingerprint` matches it. `signals()` is
-              // fail-open (resolves with `""` if unavailable); omit it when blank so a
-              // capture never ships an empty fingerprint that shadows a real one.
-              void DeviceIntegrityProvider.signals()
-                .then(({ fingerprint }) =>
-                  SmileExifTagger.setContext({
-                    partnerId,
-                    ...(fingerprint ? { fingerprint } : {}),
-                  }),
-                )
-                .then(async () => {
-                  await SmileExifTagger.finalize(primary, imageTypeForCapture);
-                  // Liveness frames ship in the same submission, so they need the tag too.
-                  await Promise.all(
-                    livenessUrls.map((livenessUrl) =>
-                      SmileExifTagger.finalize(livenessUrl, ImageType.Liveness),
-                    ),
-                  );
-                })
-                // Tagging is fail-open: a rejection must not become an unhandled
-                // rejection, and navigation still runs in `finally`.
-                .catch(() => undefined)
-                .finally(async () => {
-                  if (captureType === CaptureType.selfie) {
-                    navigationManager.setCapturedSelfie(primary, livenessUrls);
-                    navigationManager.recordSelfieCaptureTelemetry(telemetry);
-                    onNavigateNext();
-                    return;
-                  }
-                  // Document: record this side's capture telemetry before advancing.
-                  // Image sizes are measured in the repository around the compression pass.
-                  navigationManager.recordDocumentCaptureTelemetry(
-                    currentDocumentSide,
-                    telemetry,
-                  );
-                  if (
-                    capturesBack &&
-                    currentDocumentSide === DocumentSide.Front
-                  ) {
-                    navigationManager.setCapturedFrontDocument(primary);
-                    if (previewFollows) {
-                      // Exit to the front preview; manager loops back here
-                      // for the back (flip interstitial shows on re-entry).
-                      onNavigateNext();
-                    } else {
-                      setCurrentDocumentSide(DocumentSide.Back);
-                      setShowBackInstructions(true);
-                    }
-                    return;
-                  }
-                  if (
-                    capturesBack &&
-                    currentDocumentSide === DocumentSide.Back
-                  ) {
-                    navigationManager.setCapturedBackDocument(primary);
-                    onNavigateNext();
-                    return;
-                  }
-                  // Single-side document
-                  navigationManager.setCapturedFrontDocument(primary);
-                  onNavigateNext();
-                });
-            }}
-          />
-        );
-      }}
-    />
-  );
-}
-
-/**
- * Pick the primary `file://` URL from `CaptureReadyEvent[]`: the
- * `"selfie"` event for selfie flows (vs the N `"liveness"` frames), the
- * `"document"` event for document flows. `undefined` when none found.
- */
-function pickPrimaryCaptureUrl(
-  events: readonly CaptureReadyEvent[],
-  captureType: CaptureType,
-): string | undefined {
-  const targetKind =
-    captureType === CaptureType.selfie
-      ? CaptureReadyEventKind.Selfie
-      : CaptureReadyEventKind.Document;
-  return events.find((event) => event.kind === targetKind)?.url;
-}

package/src/presentation/flow/screen/orchestrated_consent_screen.tsx

@@ -1,71 +0,0 @@
-import type { ConsentConfigBuilder } from "../dsl/builder/screens_builder";
-import type { ConsentInformation } from "../../../core/models/params";
-import { UseSmileIDCrashReporting } from "@smileid/usesmileid_bridge";
-import { ConsentDeniedException } from "../../../core/exception";
-import { GlobalPrivacyControl } from "../../../core/models/global_privacy_control";
-import { UseSmileIDConsentScreen } from "../../screen/use_smile_id_consent_screen";
-import { UseSmileIDOrchestratedScreenHost } from "./use_smile_id_orchestrated_screen_host";
-
-export type OrchestratedConsentScreenProps = {
-  readonly configuration: ConsentConfigBuilder;
-};
-
-/**
- * Orchestrated consent screen. On allow: stores the
- * `ConsentInformation` on the navigation manager, fires the partner-
- * supplied `onConsentGranted` callback, then advances the cursor.
- * On deny: exits the flow with a `failed` reason carrying a
- * "consent denied" error so the orchestrator's `onResult` reports
- * the failure cleanly.
- */
-export function OrchestratedConsentScreen({
-  configuration,
-}: OrchestratedConsentScreenProps) {
-  return (
-    <UseSmileIDOrchestratedScreenHost
-      content={({ navigationManager, onNavigateNext }) => (
-        <UseSmileIDConsentScreen
-          partnerName={configuration.partnerName}
-          globalPrivacyControl={
-            navigationManager.configuration.config?.globalPrivacyControl ??
-            GlobalPrivacyControl.OptOut
-          }
-          {...(configuration.partnerIcon !== undefined
-            ? { partnerIcon: configuration.partnerIcon }
-            : {})}
-          {...(configuration.partnerPrivacyPolicyUrl !== undefined
-            ? { partnerPrivacyPolicyUrl: configuration.partnerPrivacyPolicyUrl }
-            : {})}
-          showAttribution={configuration.showAttribution}
-          onAllow={(info: ConsentInformation) => {
-            // Store on the manager first so the consent payload is
-            // available to the next screen (or the eventual
-            // submission). Then fire the partner hook so partner-side
-            // analytics see the consent before navigation.
-            navigationManager.setConsent(info);
-            try {
-              configuration.onConsentGranted?.(info);
-            } catch (err) {
-              // Concrete scenario: partner's `onConsentGranted`
-              // throws (e.g., their analytics SDK is in a bad
-              // state). Don't let that crash the SDK — route through
-              // crash reporting so partner observability picks it up.
-              UseSmileIDCrashReporting.captureException(err);
-            }
-            onNavigateNext();
-          }}
-          onDeny={() => {
-            // Exit the flow with a failed reason; the orchestrator
-            // converts that to `onResult({ status: 'failure', error })`.
-            // Typed `ConsentDeniedException` (with timestamp) so partners
-            // can distinguish a deliberate denial from other failures.
-            navigationManager.exit({
-              kind: "failed",
-              error: new ConsentDeniedException({ timestamp: Date.now() }),
-            });
-          }}
-        />
-      )}
-    />
-  );
-}

package/src/presentation/flow/screen/orchestrated_instructions_screen.tsx

@@ -1,103 +0,0 @@
-import { useCallback } from "react";
-import type { InstructionsConfigBuilder } from "../dsl/builder/screens_builder";
-import { UseSmileIDInstructionsScreen } from "../../screen/use_smile_id_instructions_screen";
-import {
-  UseSmileIDOrchestratedScreenHost,
-  type OrchestratedScreenHostContent,
-} from "./use_smile_id_orchestrated_screen_host";
-import { resolveInstructionsConfig } from "../../screen/helpers/instructions_screen_helpers";
-import { useUseSmileIDLocalizations } from "../../../l10n/use_smile_id_localizations_provider";
-import type { UseSmileIDLocalizations } from "../../../l10n/use_smile_id_localizations";
-import {
-  getCameraPermissionStatus,
-  requestCameraPermission,
-} from "../../../camera/camera_permissions";
-
-export type OrchestratedInstructionsScreenProps = {
-  readonly configuration: InstructionsConfigBuilder;
-};
-
-type HostRenderProps = Parameters<OrchestratedScreenHostContent>[0];
-
-/**
- * Orchestrated instructions screen. Resolves the partner config into concrete
- * screen props — `enhancedLivenessEnabled` drives the hero swap and the
- * `showHeroOvalProgress = !enhancedLivenessEnabled` suppression — and gates
- * Continue on the camera permission before advancing.
- */
-export function OrchestratedInstructionsScreen({
-  configuration,
-}: OrchestratedInstructionsScreenProps) {
-  const localizations = useUseSmileIDLocalizations();
-  return (
-    <UseSmileIDOrchestratedScreenHost
-      content={(renderProps) => (
-        <OrchestratedInstructionsContent
-          renderProps={renderProps}
-          configuration={configuration}
-          localizations={localizations}
-        />
-      )}
-    />
-  );
-}
-
-// A real component so its hooks run at the top level, not inside the host's
-// render callback (Rules of Hooks).
-function OrchestratedInstructionsContent({
-  renderProps: { navigationManager, onBack, onNavigateNext },
-  configuration,
-  localizations,
-}: {
-  readonly renderProps: HostRenderProps;
-  readonly configuration: InstructionsConfigBuilder;
-  readonly localizations: UseSmileIDLocalizations;
-}) {
-  const onContinueWithPermission = useCallback(async () => {
-    const current = await getCameraPermissionStatus();
-    if (current === "granted") {
-      onNavigateNext();
-      return;
-    }
-    const next = await requestCameraPermission();
-    if (next === "granted") {
-      onNavigateNext();
-    }
-    // On denial, stay on the Instructions screen rather than advancing
-    // into a camera screen against a denied permission.
-  }, [onNavigateNext]);
-
-  const documentType = navigationManager.documentType;
-  const resolved = resolveInstructionsConfig(
-    configuration,
-    {
-      enhancedLivenessEnabled: navigationManager.enhancedLivenessEnabled,
-      ...(documentType ? { documentType } : {}),
-    },
-    localizations,
-  );
-
-  return (
-    <UseSmileIDInstructionsScreen
-      titlePrefix={resolved.titlePrefix}
-      titleEmphasis={resolved.titleEmphasis}
-      heroSource={resolved.heroSource}
-      guidelinesSectionTitle={resolved.guidelinesSectionTitle}
-      guidelines={resolved.guidelines}
-      showAttribution={resolved.showAttribution}
-      showHeroOval={resolved.showHeroOval}
-      showHeroOvalProgress={resolved.showHeroOvalProgress}
-      showCardBackground={resolved.showCardBackground}
-      {...(configuration.continueButton
-        ? {
-            // Adapt the config slot `{ onClick, enabled }` to the screen's
-            // `{ onClick }` (Continue is always actionable).
-            continueButton: ({ onClick }: { onClick: () => void }) =>
-              configuration.continueButton?.({ onClick, enabled: true }),
-          }
-        : {})}
-      onContinue={onContinueWithPermission}
-      onBack={onBack}
-    />
-  );
-}

package/src/presentation/flow/screen/orchestrated_preview_screen.tsx

@@ -1,62 +0,0 @@
-import type { PreviewConfigBuilder } from "../dsl/builder/screens_builder";
-import { UseSmileIDPreviewScreen } from "../../screen/use_smile_id_preview_screen";
-import { UseSmileIDDocumentPreviewScreen } from "../../screen/use_smile_id_document_preview_screen";
-import { UseSmileIDOrchestratedScreenHost } from "./use_smile_id_orchestrated_screen_host";
-import { defaultFrameAspectRatio } from "../../../core/models/document_type";
-
-export type OrchestratedPreviewScreenProps = {
-  readonly configuration: PreviewConfigBuilder;
-};
-
-/**
- * Orchestrated preview screen — renders the document preview (the side just
- * captured, once per side via the manager's per-side loop) or the selfie
- * preview. Accept advances; Reject rewinds and discards that side, but only
- * when the partner opted in via `allowRetake`.
- */
-export function OrchestratedPreviewScreen({
-  configuration,
-}: OrchestratedPreviewScreenProps) {
-  return (
-    <UseSmileIDOrchestratedScreenHost
-      content={({ navigationManager, onBack, onNavigateNext }) => {
-        if (navigationManager.currentPreviewIsDocument()) {
-          const documentPath = navigationManager.currentDocumentPreviewPath();
-          return (
-            <UseSmileIDDocumentPreviewScreen
-              documentAspectRatio={
-                navigationManager.documentFrameAspectRatio ??
-                defaultFrameAspectRatio("Landscape")
-              }
-              showAttribution={configuration.showAttribution}
-              {...(documentPath !== undefined
-                ? { capturedDocumentPath: documentPath }
-                : {})}
-              onAccept={onNavigateNext}
-              onReject={() => {
-                if (configuration.allowRetake) {
-                  navigationManager.retakeCurrentDocumentSide();
-                  onBack();
-                }
-              }}
-              onClose={() => navigationManager.exit()}
-            />
-          );
-        }
-        return (
-          <UseSmileIDPreviewScreen
-            allowRetake={configuration.allowRetake}
-            showAttribution={configuration.showAttribution}
-            {...(navigationManager.captured.selfiePath !== undefined
-              ? { capturedSelfiePath: navigationManager.captured.selfiePath }
-              : {})}
-            onAccept={onNavigateNext}
-            onReject={() => {
-              if (configuration.allowRetake) onBack();
-            }}
-          />
-        );
-      }}
-    />
-  );
-}