@smileid/usesmileid 12.0.0-beta01

package/dist/presentation/flow/flow_navigation_context.js

@@ -0,0 +1,34 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext, useContext } from "react";
+/**
+ * React Context bridge for the flow navigation manager. Partner
+ * screens or custom widgets call `useFlowNavigation()` to read the
+ * manager without prop-drilling.
+ *
+ * Concrete scenario: a partner ships a custom button slot
+ * (`screens.consent.allowButton`) that needs to advance the flow on
+ * press. They write `useFlowNavigation().navigateToNext()` instead of having
+ * to receive an `onPress` prop from N levels up.
+ */
+const FlowNavigationContext = createContext(null);
+export function FlowNavigationProvider({ manager, children, }) {
+    return (_jsx(FlowNavigationContext.Provider, { value: manager, children: children }));
+}
+/**
+ * Read the active `FlowNavigationManager` from context. Throws if
+ * called outside a `<FlowNavigationProvider>` — concrete scenario
+ * this catches: a partner mounts a SDK screen directly (e.g.
+ * `<UseSmileIDConsentScreen>`) without `<UseSmileIDBuilder>` wrapping
+ * it. The throw makes the misuse loud at first render rather than
+ * silently no-op-ing on `navigateToNext()` / `navigateBack()` calls.
+ */
+export function useFlowNavigation() {
+    const manager = useContext(FlowNavigationContext);
+    if (!manager) {
+        throw new Error("useFlowNavigation: called outside <UseSmileIDBuilder> — wrap the " +
+            "consuming screen with <FlowNavigationProvider> or render it " +
+            "inside <UseSmileIDBuilder>.");
+    }
+    return manager;
+}
+//# sourceMappingURL=flow_navigation_context.js.map

package/dist/presentation/flow/flow_navigation_context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow_navigation_context.js","sourceRoot":"","sources":["../../../src/presentation/flow/flow_navigation_context.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,aAAa,EAAE,UAAU,EAAkB,MAAM,OAAO,CAAC;AAGlE;;;;;;;;;GASG;AACH,MAAM,qBAAqB,GAAG,aAAa,CAA+B,IAAI,CAAC,CAAC;AAOhF,MAAM,UAAU,sBAAsB,CAAC,EACrC,OAAO,EACP,QAAQ,GACoB;IAC5B,OAAO,CACL,KAAC,qBAAqB,CAAC,QAAQ,IAAC,KAAK,EAAE,OAAO,YAC3C,QAAQ,GACsB,CAClC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB;IAC/B,MAAM,OAAO,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;IAClD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACb,mEAAmE;YACjE,8DAA8D;YAC9D,6BAA6B,CAChC,CAAC;IACJ,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/presentation/flow/flow_navigation_manager.d.ts

@@ -0,0 +1,217 @@
+import type { ScreenSpec } from "./dsl/builder/screens_builder";
+import type { FlowConfigurationSnapshot } from "./dsl/use_smile_id_flow_builder";
+import type { JobSubmissionState } from "./job_submission_state";
+import type { UseSmileIDRepository } from "../../data/repository/use_smile_id_repository";
+import type { ConsentInformation } from "../../core/models/params";
+import type { DocumentType } from "../../core/models/document_type";
+import type { JobSubmissionResponse } from "../../data/model/job_submission_response";
+import { type MetadataProvider } from "../../metadata/use_smile_id_metadata_factory";
+import { type DocumentImageOrigin } from "../../metadata/document_image_origin";
+import type { SdkConfig } from "../../data/model/sdk_config";
+import { DocumentSide } from "@smileid/usesmileid_bridge";
+/**
+ * Internal flow navigation manager — owns the screen cursor, captured
+ * artifacts, navigation primitives, job submission lifecycle, and a
+ * subscribe pattern for React re-renders.
+ *
+ * Custom (not Expo Router / React Navigation) because screens are
+ * partner-configurable via the DSL, not file-based routes; forcing a
+ * routing library would conflict with the partner's own app routing.
+ */
+type Listener = () => void;
+export type CapturedArtifacts = {
+    readonly selfiePath?: string;
+    readonly livenessPaths: readonly string[];
+    readonly frontDocumentPath?: string;
+    readonly backDocumentPath?: string;
+    readonly consentInformation?: ConsentInformation;
+};
+export type FlowExitReason = {
+    readonly kind: "completed";
+    readonly job: JobSubmissionResponse;
+} | {
+    readonly kind: "cancelled";
+} | {
+    readonly kind: "failed";
+    readonly error: unknown;
+};
+export type FlowExitHandler = (reason: FlowExitReason) => void;
+export type FlowNavigationManagerOptions = {
+    readonly configuration: FlowConfigurationSnapshot;
+    readonly onExit: FlowExitHandler;
+    /**
+     * Dispatches the assembled `JobRequest`. Optional so capture-only /
+     * UI-only harnesses (no `b.network(...)`) can still mount. When
+     * absent, `beginSubmissionIfNeeded()` goes straight to a descriptive
+     * `failure` rather than spinning forever.
+     */
+    readonly repository?: UseSmileIDRepository;
+    /**
+     * Per-flow metadata provider; each `JobRequest` carries a fresh
+     * `metadata` snapshot via `make()`. Optional — capture-only harnesses
+     * fall back to a default factory. Production passes the same provider
+     * the networking factory created so `session_id` stays stable across
+     * every submission in the flow.
+     */
+    readonly metadataProvider?: MetadataProvider;
+};
+export declare class FlowNavigationManager {
+    /**
+     * Navigation stack and source of truth — top is the active screen.
+     * Active screen + first/last predicates derive from this path (no
+     * parallel index). Mutated only via the navigate* methods.
+     */
+    private _navigationPath;
+    private _captured;
+    /**
+     * Set once the partner skips the document back side via the flip
+     * interstitial. Routes `getNextScreen()` past the back capture's preview so
+     * submission proceeds with `backDocument` unset. Cleared when the front is
+     * retaken.
+     */
+    private _documentBackSkipped;
+    /**
+     * How each captured document side was produced (auto / manual / gallery).
+     * Emitted as `DocumentFront/BackImageOrigin` submission metadata; an entry is
+     * removed when its side is retaken.
+     */
+    private readonly _documentImageOrigins;
+    private _jobSubmissionState;
+    private readonly _listeners;
+    private readonly _steps;
+    private readonly _configuration;
+    private readonly _repository;
+    private readonly _metadataProvider;
+    private readonly _onExit;
+    private _disposed;
+    private _submissionResponse;
+    /**
+     * Decoded `sdk_config` JWT claim, resolved once at construction.
+     * `undefined` for offline mode / no token / no valid claim — SDK
+     * defaults apply throughout the flow in those cases.
+     */
+    readonly resolvedSdkConfig: SdkConfig | undefined;
+    /** Stable per-flow session id, stamped into every analytics event's `session_id`. */
+    private readonly _sessionId;
+    /** Submission attempts so far — stamped into `job_submitted` as `attempt`. */
+    private _submissionAttemptCount;
+    constructor(options: FlowNavigationManagerOptions);
+    get configuration(): FlowConfigurationSnapshot;
+    /** Whether any selfie step enabled Enhanced Smart Selfie (drives the instructions hero swap and oval-progress suppression). */
+    get enhancedLivenessEnabled(): boolean;
+    /** Document type from the flow's document capture step, if any (drives the instructions document variant). */
+    get documentType(): DocumentType | undefined;
+    /** Read-only navigation stack; top is the active screen. */
+    get navigationPath(): readonly ScreenSpec[];
+    /** Active screen (top of the path); `undefined` only when no screens are configured. */
+    get currentScreen(): ScreenSpec | undefined;
+    /**
+     * Depth of the active screen — stable id for React view identity so
+     * stack frames at the same configured-screen position stay distinct.
+     */
+    get currentDepth(): number;
+    get isFirstScreen(): boolean;
+    get isLastScreen(): boolean;
+    /** Next screen `navigateToNext()` would land on; `undefined` at the terminal screen. */
+    getNextScreen(): ScreenSpec | undefined;
+    /**
+     * Advance to the next screen. Past the last screen, exits via `onExit`
+     * `{ kind: 'completed', job }` (job is the successful response, or an
+     * empty-fields stand-in for flows with no processing screen).
+     *
+     * Advancing into a `processing` screen sets `loading` synchronously
+     * before the async submit, closing the race with the screen's
+     * mount-time `beginSubmissionIfNeeded()` so it never flashes
+     * `notAttempted`.
+     */
+    navigateToNext(): void;
+    /** Pop the active screen; from the first screen, exits via `onExit` `{ kind: 'cancelled' }`. */
+    navigateBack(): void;
+    /** Reset the path to the first screen (flow restart after terminal failure, manager kept alive). */
+    navigateToStart(): void;
+    /** Exit the flow with a partner-supplied reason (processing onExit, consent denied, etc.). */
+    exit(reason?: FlowExitReason): void;
+    get captured(): CapturedArtifacts;
+    setCapturedSelfie(selfiePath: string, livenessPaths: readonly string[]): void;
+    setCapturedFrontDocument(path: string): void;
+    setCapturedBackDocument(path: string): void;
+    /** Whether the configured document capture asks for a back side. */
+    documentCapturesBack(): boolean;
+    /** Whether a `preview {}` immediately follows the document capture step. */
+    documentPreviewFollowsCapture(): boolean;
+    /** Whether the active preview previews a document side (vs the selfie). */
+    currentPreviewIsDocument(): boolean;
+    /** Path of the document side under review: the back if captured, else the front. */
+    currentDocumentPreviewPath(): string | undefined;
+    /**
+     * Discard the side under review for re-capture: the back if captured,
+     * else the front (which also un-skips the back). Does not navigate.
+     */
+    retakeCurrentDocumentSide(): void;
+    /** Skip the document back side from the flip interstitial ("Skip"). */
+    skipDocumentBack(): void;
+    /**
+     * Record how a side was produced (→ `DocumentFront/BackImageOrigin`
+     * metadata). Metadata-only, so it intentionally does not `_notify()`.
+     */
+    recordDocumentImageOrigin(side: DocumentSide, origin: DocumentImageOrigin): void;
+    /** Per-side document origin wire entries (front then back; omitted when unset). */
+    private _documentImageOriginEntries;
+    private _precedingStepIsDocumentCapture;
+    setConsent(info: ConsentInformation): void;
+    get jobSubmissionState(): JobSubmissionState;
+    /**
+     * Idempotent submission entry point (called on processing-screen
+     * mount). The `notAttempted` guard prevents re-mounts re-firing.
+     */
+    beginSubmissionIfNeeded(): void;
+    /** Reset to `notAttempted` and re-fire submission (processing screen's onRetry). */
+    retrySubmission(): void;
+    private _setSubmissionState;
+    /**
+     * Build the request, dispatch via repository, update state. Errors
+     * from `_assembleJob` (missing captures / bad job type) map to the
+     * `failure` state rather than propagating as unhandled rejections.
+     */
+    private _submit;
+    /**
+     * Build a typed `JobRequest` from `jobType` + captured artifacts.
+     * Throws a descriptive message when a required capture is missing.
+     */
+    private _assembleJob;
+    private _requireSelfie;
+    private _requireUserDetails;
+    /**
+     * Resolve `b.userId` for smartSelfieAuthentication —
+     * `/v3/authentication` requires the prior-enrollment `user_id` to
+     * match the attempt. Throws `MissingRequiredFieldException` if blank.
+     */
+    private _requireUserId;
+    private _requireFrontDocument;
+    private _buildDocumentRequest;
+    private _buildEnhancedDocumentRequest;
+    /** Emit terminal `flow_completed` (completed/failed only; not cancelled), then exit via `onExit`. */
+    private _finishFlow;
+    /** Forward a lifecycle event to `onAnalyticsEvent`, adding `session_id` + `timestamp`. No-op without a callback. */
+    private _logEvent;
+    private _jobTypeName;
+    private _screenAnalyticsName;
+    /** Subscribe to state changes; returns an unsubscribe (safe after `dispose()`). */
+    subscribe(listener: Listener): () => void;
+    /** Tear down — drop listeners, make methods no-ops (orchestrator's useEffect cleanup). */
+    dispose(): void;
+    /**
+     * Expected liveness image count: ESS uses its fixed count (head-turn
+     * flow self-manages); else the token's livenessImageCount override;
+     * else the ScanPerformanceProfile default (`numSamples - 1`).
+     */
+    private _expectedLivenessImageCount;
+    /**
+     * Decode the `sdk_config` JWT claim. `undefined` for offline mode,
+     * no token, or no valid claim — SDK defaults apply in those cases.
+     */
+    private static _decodeSdkConfig;
+    private _notify;
+}
+export {};
+//# sourceMappingURL=flow_navigation_manager.d.ts.map

package/dist/presentation/flow/flow_navigation_manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow_navigation_manager.d.ts","sourceRoot":"","sources":["../../../src/presentation/flow/flow_navigation_manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAMjE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+CAA+C,CAAC;AAC1F,OAAO,KAAK,EACV,kBAAkB,EAInB,MAAM,0BAA0B,CAAC;AAGlC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AAYtF,OAAO,EAEL,KAAK,gBAAgB,EACtB,MAAM,8CAA8C,CAAC;AACtD,OAAO,EAGL,KAAK,mBAAmB,EACzB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAG7D,OAAO,EACL,YAAY,EAEb,MAAM,4BAA4B,CAAC;AAGpC;;;;;;;;GAQG;AACH,KAAK,QAAQ,GAAG,MAAM,IAAI,CAAC;AAE3B,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,aAAa,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,cAAc,GACtB;IAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,GAAG,EAAE,qBAAqB,CAAA;CAAE,GACnE;IAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;CAAE,GAC9B;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;AAEzD,MAAM,MAAM,eAAe,GAAG,CAAC,MAAM,EAAE,cAAc,KAAK,IAAI,CAAC;AAE/D,MAAM,MAAM,4BAA4B,GAAG;IACzC,QAAQ,CAAC,aAAa,EAAE,yBAAyB,CAAC;IAClD,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IACjC;;;;;OAKG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAC3C;;;;;;OAMG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CAC9C,CAAC;AASF,qBAAa,qBAAqB;IAChC;;;;OAIG;IACH,OAAO,CAAC,eAAe,CAAoB;IAC3C,OAAO,CAAC,SAAS,CAA4C;IAC7D;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB,CAAS;IACrC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAGlC;IACJ,OAAO,CAAC,mBAAmB,CAAgD;IAC3E,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAuB;IAClD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;IAC/C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA4B;IAC3D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmC;IAC/D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmB;IACrD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAkB;IAC1C,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,mBAAmB,CAAoC;IAE/D;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,EAAE,SAAS,GAAG,SAAS,CAAC;IAElD,qFAAqF;IACrF,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IAEpC,8EAA8E;IAC9E,OAAO,CAAC,uBAAuB,CAAK;gBAExB,OAAO,EAAE,4BAA4B;IAgCjD,IAAI,aAAa,IAAI,yBAAyB,CAE7C;IAED,+HAA+H;IAC/H,IAAI,uBAAuB,IAAI,OAAO,CAMrC;IAED,8GAA8G;IAC9G,IAAI,YAAY,IAAI,YAAY,GAAG,SAAS,CAU3C;IAID,4DAA4D;IAC5D,IAAI,cAAc,IAAI,SAAS,UAAU,EAAE,CAE1C;IAED,wFAAwF;IACxF,IAAI,aAAa,IAAI,UAAU,GAAG,SAAS,CAE1C;IAED;;;OAGG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED,IAAI,aAAa,IAAI,OAAO,CAE3B;IAED,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED,wFAAwF;IACxF,aAAa,IAAI,UAAU,GAAG,SAAS;IAmCvC;;;;;;;;;OASG;IACH,cAAc,IAAI,IAAI;IAuDtB,gGAAgG;IAChG,YAAY,IAAI,IAAI;IAYpB,oGAAoG;IACpG,eAAe,IAAI,IAAI;IAOvB,8FAA8F;IAC9F,IAAI,CAAC,MAAM,GAAE,cAAsC,GAAG,IAAI;IAO1D,IAAI,QAAQ,IAAI,iBAAiB,CAEhC;IAED,iBAAiB,CACf,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,SAAS,MAAM,EAAE,GAC/B,IAAI;IAeP,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAS5C,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAY3C,oEAAoE;IACpE,oBAAoB,IAAI,OAAO;IAgB/B,4EAA4E;IAC5E,6BAA6B,IAAI,OAAO;IAUxC,2EAA2E;IAC3E,wBAAwB,IAAI,OAAO;IAMnC,oFAAoF;IACpF,0BAA0B,IAAI,MAAM,GAAG,SAAS;IAIhD;;;OAGG;IACH,yBAAyB,IAAI,IAAI;IAiBjC,uEAAuE;IACvE,gBAAgB,IAAI,IAAI;IAMxB;;;OAGG;IACH,yBAAyB,CACvB,IAAI,EAAE,YAAY,EAClB,MAAM,EAAE,mBAAmB,GAC1B,IAAI;IAKP,mFAAmF;IACnF,OAAO,CAAC,2BAA2B;IAanC,OAAO,CAAC,+BAA+B;IAQvC,UAAU,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI;IAW1C,IAAI,kBAAkB,IAAI,kBAAkB,CAE3C;IAED;;;OAGG;IACH,uBAAuB,IAAI,IAAI;IAM/B,oFAAoF;IACpF,eAAe,IAAI,IAAI;IAMvB,OAAO,CAAC,mBAAmB;IAM3B;;;;OAIG;YACW,OAAO;IAoDrB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAkKpB,OAAO,CAAC,cAAc;IAWtB,OAAO,CAAC,mBAAmB;IAQ3B;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,qBAAqB;IAQ7B,OAAO,CAAC,qBAAqB;IA4B7B,OAAO,CAAC,6BAA6B;IA6BrC,qGAAqG;IACrG,OAAO,CAAC,WAAW;IAqBnB,oHAAoH;IACpH,OAAO,CAAC,SAAS;IAgBjB,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,oBAAoB;IAa5B,mFAAmF;IACnF,SAAS,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,IAAI;IAOzC,0FAA0F;IAC1F,OAAO,IAAI,IAAI;IAKf;;;;OAIG;IACH,OAAO,CAAC,2BAA2B;IAiBnC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAS/B,OAAO,CAAC,OAAO;CAUhB"}