@smileid/usesmileid 12.0.1 → 12.1.0

package/dist/presentation/flow/dsl/use_smile_id_flow_builder.js

@@ -1,334 +1 @@
-import { UseSmileIDConfigBuilder } from "./builder/config_builder";
-import { ThemeConfigBuilder } from "./builder/theme_builder";
-import { UseSmileIDNetworkBuilder } from "../../../data/dsl/use_smile_id_network_builder";
-import { UseSmileIDMLBuilder } from "./builder/ml_builder";
-import { ScreensBuilder } from "./builder/screens_builder";
-import { firstErrorIssue, runBiometricKYCParamsValidation, runBuilderValidation, runConsentValidation, runDocumentVerificationParamsValidation, runEnhancedDocumentVerificationParamsValidation, runEnhancedKYCParamsValidation, runFlowValidation, runUserDetailsValidation, } from "../validation/flow_validator";
-import { ValidationState } from "../validation/validation_state";
-/**
- * Top-level DSL builder.
- *
- * Closure-based block methods (`config`, `theme`, `network`, `ml`,
- * `screens`) configure each section; mutable top-level properties
- * (`consentInformation`, `enhancedKYCParams`, `biometricKYCParams`,
- * `onResult`, `onAnalyticsEvent`) are assigned directly. The server
- * issues `userId` / `jobId` and returns them in the submission
- * response — partners receive them via `onResult`.
- */
-export class UseSmileIDFlowBuilder {
-    /**
-     * Optional. Pre-supplied consent — if set, the consent screen is
-     * skipped.
-     */
-    consentInformation;
-    /** Optional. Required only for `JobType.enhancedKyc`. */
-    enhancedKYCParams;
-    /** Optional. Required only for `JobType.biometricKyc`. */
-    biometricKYCParams;
-    /** Optional. Required only for `JobType.documentVerification`. */
-    documentVerificationParams;
-    /** Optional. Required only for `JobType.enhancedDocumentVerification`. */
-    enhancedDocumentVerificationParams;
-    /**
-     * Required for any job that submits the `user_details` multipart
-     * part — `JobType.enhancedKyc`, `JobType.biometricKyc`,
-     * `JobType.smartSelfieEnrollment`, `JobType.smartSelfieAuthentication`
-     * (plus the two Enhanced selfie aliases). The same shape is sent on
-     * the wire as a JSON multipart part with snake_case keys.
-     *
-     * Previously carried inside `enhancedKYCParams` / `biometricKYCParams`
-     * — consolidated here so the smartSelfie* endpoints can carry it too
-     * (their v3 wire format also requires `user_details`).
-     */
-    userDetails;
-    /**
-     * Required for `JobType.smartSelfieAuthentication` (and its enhanced
-     * alias). The v3 `/v3/authentication` endpoint requires the partner to
-     * pass the `user_id` returned from a prior enrollment so the server
-     * can match the authentication attempt to the existing enrollment.
-     * Sent on the wire as a `user_id` multipart text form field.
-     */
-    userId;
-    /**
-     * Optional. Locale-resolved string overrides. The flow component
-     * wraps its tree with `<UseSmileIDLocalizationsProvider>` when this
-     * is set so all SDK screens read from it. Partners use any i18n
-     * stack to pick the right map and pass it here.
-     *
-     * If unset, screens render the canonical English defaults bundled
-     * with `strings_en.ts`.
-     */
-    localizations;
-    /**
-     * Invoked once when the flow terminates — with the submitted job on
-     * success, a typed error on failure, or a cancellation when the user
-     * exits before completing. Wire the returned user id / job id into
-     * your job-status pipeline. Defaults to a no-op so partners who don't
-     * need result handling still get a valid configuration; the
-     * server-issued `JobSubmissionResponse` carries `userId` / `jobId` /
-     * `status` / `message` / `createdAt`.
-     */
-    onResult = () => { };
-    /**
-     * Invoked for every analytics event the SDK emits during the flow.
-     * Optional — leave unset to ignore analytics.
-     */
-    onAnalyticsEvent;
-    // --- Internal block builders ---------------------------------------------
-    _config;
-    _theme;
-    _network;
-    _ml;
-    _screens;
-    /**
-     * Configures global SDK feature flags (debug mode, offline mode, crash
-     * reporting). Repeated calls compose against the same configuration —
-     * `enableCrashReporting` set in one call and `enableDebugMode` set in
-     * another both end up on the final config.
-     *
-     * `b.config((c) => { c.enableCrashReporting = false; })`
-     */
-    config(block) {
-        if (!this._config)
-            this._config = new UseSmileIDConfigBuilder();
-        block(this._config);
-    }
-    /**
-     * Configures the visual theme — colors, fonts, and corner shapes —
-     * applied to every SDK screen in the flow.
-     *
-     * `b.theme((t) => { t.primaryColor = t.color('#1A73E8', '#4DA3FF'); t.buttonShape = 12; })`
-     *
-     * Each call replaces the prior theme builder — partners typically
-     * configure the theme in one place, and accumulating across helpers
-     * tends to surface as a fight over which call wrote `primaryColor`
-     * last. Replace semantics make the precedence local and obvious.
-     */
-    theme(block) {
-        this._theme = new ThemeConfigBuilder();
-        block(this._theme);
-    }
-    /**
-     * Configures the network stack: partner credentials, job type,
-     * timeouts, retry policy, response cache, and custom interceptors.
-     * Required for any flow that submits a job.
-     *
-     * `b.network((n) => { n.config((c) => { c.partnerConfig((p) => { p.partnerId = ...; }); }); })`
-     *
-     * Each call replaces the prior network builder. Network config
-     * carries credentials and a job type, so partial composition across
-     * helpers is more likely to mask configuration errors than to help.
-     */
-    network(block) {
-        this._network = new UseSmileIDNetworkBuilder();
-        block(this._network);
-    }
-    /**
-     * Registers the on-device ML analyzers used for face and document
-     * detection, keyed by capture type.
-     *
-     * `b.ml((m) => { m.analyzers((a) => { a.forCaptureType(CaptureType.selfie, (face) => face.add(useSmileIDVisionFace)); }); })`
-     */
-    ml(block) {
-        if (!this._ml)
-            this._ml = new UseSmileIDMLBuilder();
-        block(this._ml);
-    }
-    /**
-     * Declares the ordered sequence of screens the flow presents. Screens
-     * render in the order they are added; the same screen type may be
-     * added more than once.
-     *
-     * `b.screens((screens) => { screens.instructions(); screens.capture((c) => { c.captureType = CaptureType.selfie; }); })`
-     *
-     * Each screen-builder call appends a step to the orchestrator's
-     * flow list in declaration order.
-     */
-    screens(block) {
-        if (!this._screens)
-            this._screens = new ScreensBuilder();
-        block(this._screens);
-    }
-    /**
-     * Runs a pre-flight check of the current builder configuration and
-     * returns a `ValidationState` describing any blocking issues, without
-     * throwing. Today the only rule it surfaces is the empty-screens-block
-     * error — `b.screens` must register at least one screen before the
-     * builder can produce a flow.
-     *
-     * The full rule set (screen ordering, dependency rules, KYC and
-     * consent payload validation, etc.) runs inside `build()` and is
-     * reflected in the [FlowBuildResult] surface; partners that want
-     * the full picture during configuration should call
-     * `useSmileIDBuilder(...)` and pattern-match on the returned
-     * `result.kind`.
-     *
-     * @returns a `ValidationState` describing any blocking issues.
-     */
-    validate() {
-        return ValidationState.invalid(runBuilderValidation(this._screens?.build().steps ?? []));
-    }
-    /**
-     * Validates a `ConsentInformation` payload in isolation and returns a
-     * `ValidationState`, without throwing. Useful when the payload comes
-     * from dynamic partner storage or remote config — pre-flight it before
-     * assigning to `b.consentInformation`.
-     */
-    validateConsent(consent) {
-        return ValidationState.invalid(runConsentValidation(consent));
-    }
-    /**
-     * Validates an `EnhancedKYCParams` payload in isolation and returns a
-     * `ValidationState`, without throwing. Useful when the partner pulls
-     * KYC fields from a form or remote config and wants to pre-flight them
-     * before assigning to `b.enhancedKYCParams`.
-     */
-    validateEnhancedKYCParams(params) {
-        return ValidationState.invalid(runEnhancedKYCParamsValidation(params));
-    }
-    /**
-     * Validates a `BiometricKYCParams` payload in isolation and returns a
-     * `ValidationState`, without throwing.
-     */
-    validateBiometricKYCParams(params) {
-        return ValidationState.invalid(runBiometricKYCParamsValidation(params));
-    }
-    /**
-     * Validates a `DocumentVerificationParams` payload in isolation and
-     * returns a `ValidationState`, without throwing. Only `country` is
-     * required; `idType` is optional.
-     */
-    validateDocumentVerificationParams(params) {
-        return ValidationState.invalid(runDocumentVerificationParamsValidation(params));
-    }
-    /**
-     * Validates an `EnhancedDocumentVerificationParams` payload in
-     * isolation and returns a `ValidationState`, without throwing. Both
-     * `country` and `idType` are required.
-     */
-    validateEnhancedDocumentVerificationParams(params) {
-        return ValidationState.invalid(runEnhancedDocumentVerificationParamsValidation(params));
-    }
-    /**
-     * Validates a `UserDetails` payload in isolation and returns a
-     * `ValidationState`, without throwing. Useful when the partner pulls
-     * user PII from a form or remote config and wants to pre-flight it
-     * before assigning to `b.userDetails`. Surfaces the same dotted-path
-     * field names (`userDetails.givenNames` etc.) that the in-build
-     * validator emits.
-     */
-    validateUserDetails(userDetails) {
-        return ValidationState.invalid(runUserDetailsValidation(userDetails));
-    }
-    /**
-     * Snapshot the current builder state and report the validation
-     * outcome as a [FlowBuildResult]. Returns `{kind: 'success', ...}`
-     * when every rule passed, or `{kind: 'invalid', ...}` carrying the
-     * issues, the partner's `onResult` callback, and the resolved
-     * `enableDebugMode` flag so the wrapper can route the failure
-     * through `onResult.failure` and decide whether to render the
-     * debug screen.
-     *
-     * Internal — partners use `<UseSmileIDBuilder>`, which calls this
-     * method and dispatches on `kind` (success → render flow, invalid →
-     * fire `onResult.failure(BuilderValidationException)` and optionally
-     * render the debug screen).
-     *
-     * Validation rules (see `validate()` for non-throwing access from
-     * inside a builder closure):
-     *   1. The screens list must not be empty.
-     *   2. Screen ordering: consent must be first if present; processing
-     *      must be last if present; instructions must come before any
-     *      capture; every preview must be preceded by a capture.
-     *   3. Duplicate screen types are rejected (capture is exempt — a
-     *      flow may have both selfie and document capture).
-     *   4. ML configuration is required when any capture screen is
-     *      present.
-     *   5. Network configuration is required when a processing screen
-     *      is present.
-     *   6. The configured `jobType` may not be `unknown` once a
-     *      processing screen is wired.
-     *   7. Pre-supplied `consentInformation` and an in-flow consent
-     *      screen are mutually exclusive — exactly one source.
-     *   8. When set, `consentInformation` must have `granted: true`,
-     *      non-blank `grantedAt`, `noticeLanguage`, and
-     *      `noticePrivacyPolicyUrl`, and `grantedAt` must not parse to
-     *      a future timestamp.
-     *   9. When set, `EnhancedKYCParams` and `BiometricKYCParams` must
-     *      have non-blank `idType`, `idNumber`, `country`, and a
-     *      `userDetails` whose `givenNames` and `lastName` are non-blank
-     *      and whose `email` or `phoneNumber` (at least one) is set.
-     *
-     * @internal
-     */
-    build() {
-        const screens = this._screens?.build();
-        const network = this._network?.build();
-        const mlConfig = this._ml?.build();
-        const issues = runFlowValidation({
-            steps: screens?.steps ?? [],
-            network,
-            ml: mlConfig,
-            consentInformation: this.consentInformation,
-            enhancedKYCParams: this.enhancedKYCParams,
-            biometricKYCParams: this.biometricKYCParams,
-            documentVerificationParams: this.documentVerificationParams,
-            enhancedDocumentVerificationParams: this.enhancedDocumentVerificationParams,
-            userDetails: this.userDetails,
-        });
-        const state = ValidationState.invalid(issues);
-        const blocking = firstErrorIssue(state);
-        if (blocking) {
-            // `state.valid` is `false` here: `blocking` is non-null only when
-            // the validator surfaced an error-severity issue, which forces
-            // `state` into the invalid branch.
-            const invalid = state;
-            return {
-                kind: "invalid",
-                validation: invalid,
-            };
-        }
-        // The validator's "screens not empty" rule is the only source of
-        // truth that guarantees `screens` is non-undefined here. Keep the
-        // invariant local rather than hiding it behind a `!` assertion so
-        // a future refactor that loosens the rule fails loudly with a
-        // descriptive error instead of silently returning a malformed
-        // snapshot.
-        if (!screens) {
-            throw new Error("UseSmileIDFlowBuilder: internal invariant violated — screens missing after validation passed.");
-        }
-        const configuration = Object.freeze({
-            ...(this.consentInformation
-                ? { consentInformation: this.consentInformation }
-                : {}),
-            ...(this.enhancedKYCParams
-                ? { enhancedKYCParams: this.enhancedKYCParams }
-                : {}),
-            ...(this.biometricKYCParams
-                ? { biometricKYCParams: this.biometricKYCParams }
-                : {}),
-            ...(this.documentVerificationParams
-                ? { documentVerificationParams: this.documentVerificationParams }
-                : {}),
-            ...(this.enhancedDocumentVerificationParams
-                ? {
-                    enhancedDocumentVerificationParams: this.enhancedDocumentVerificationParams,
-                }
-                : {}),
-            ...(this.userDetails ? { userDetails: this.userDetails } : {}),
-            ...(this.userId ? { userId: this.userId } : {}),
-            ...(this._config ? { config: this._config.build() } : {}),
-            ...(this._theme ? { theme: this._theme.build() } : {}),
-            ...(network ? { network } : {}),
-            ...(mlConfig ? { ml: mlConfig } : {}),
-            screens,
-            ...(this.localizations ? { localizations: this.localizations } : {}),
-            onResult: this.onResult,
-            ...(this.onAnalyticsEvent
-                ? { onAnalyticsEvent: this.onAnalyticsEvent }
-                : {}),
-        });
-        return { kind: "success", configuration };
-    }
-}
-//# sourceMappingURL=use_smile_id_flow_builder.js.map
+"use strict";import{UseSmileIDConfigBuilder as l}from"./builder/config_builder";import{ThemeConfigBuilder as d}from"./builder/theme_builder";import{UseSmileIDNetworkBuilder as u}from"../../../data/dsl/use_smile_id_network_builder";import{UseSmileIDMLBuilder as h}from"./builder/ml_builder";import{ScreensBuilder as f}from"./builder/screens_builder";import{IssueSeverity as P}from"../../../core/exception/issue_severity";import{runBiometricKYCParamsValidation as v,runBuilderValidation as D,runConsentValidation as V,runDocumentVerificationParamsValidation as _,runEnhancedDocumentVerificationParamsValidation as g,runEnhancedKYCParamsValidation as w,runFlowValidation as C,runUserDetailsValidation as I}from"../validation/flow_validator";import{ValidationState as n}from"../validation/validation_state";import{decodeSmileIDToken as K}from"../../../data/util/use_smile_id_token_decoder";export class UseSmileIDFlowBuilder{consentInformation;enhancedKYCParams;biometricKYCParams;documentVerificationParams;enhancedDocumentVerificationParams;userDetails;userId;localizations;onResult=()=>{};onAnalyticsEvent;_config;_theme;_network;_ml;_screens;config(i){this._config||(this._config=new l),i(this._config)}theme(i){this._theme=new d,i(this._theme)}network(i){this._network=new u,i(this._network)}ml(i){this._ml||(this._ml=new h),i(this._ml)}screens(i){this._screens||(this._screens=new f),i(this._screens)}validate(){return n.invalid(D(this._screens?.build().steps??[]))}validateConsent(i){return n.invalid(V(i))}validateEnhancedKYCParams(i){return n.invalid(w(i))}validateBiometricKYCParams(i){return n.invalid(v(i))}validateDocumentVerificationParams(i){return n.invalid(_(i))}validateEnhancedDocumentVerificationParams(i){return n.invalid(g(i))}validateUserDetails(i){return n.invalid(I(i))}build(){const i=this._screens?.build(),e=this._network?.build(),a=this._ml?.build(),s=this._config?.build(),m=Y(s?.allowOfflineMode,e),o=C({steps:i?.steps??[],network:e,ml:a,consentInformation:this.consentInformation,enhancedKYCParams:this.enhancedKYCParams,biometricKYCParams:this.biometricKYCParams,documentVerificationParams:this.documentVerificationParams,enhancedDocumentVerificationParams:this.enhancedDocumentVerificationParams,userDetails:this.userDetails,userId:this.userId,tokenPayload:m}),c=n.invalid(o);if(!c.valid)return{kind:"invalid",validation:c};for(const t of o)t.severity===P.warning&&(console.warn(`[UseSmileIDFlowBuilder] ${t.message}`),t.suggestedFix&&console.warn(`[UseSmileIDFlowBuilder] Suggested fix: ${t.suggestedFix}`));if(!i)throw new Error("UseSmileIDFlowBuilder: internal invariant violated \u2014 screens missing after validation passed.");return{kind:"success",configuration:Object.freeze({...this.consentInformation?{consentInformation:this.consentInformation}:{},...this.enhancedKYCParams?{enhancedKYCParams:this.enhancedKYCParams}:{},...this.biometricKYCParams?{biometricKYCParams:this.biometricKYCParams}:{},...this.documentVerificationParams?{documentVerificationParams:this.documentVerificationParams}:{},...this.enhancedDocumentVerificationParams?{enhancedDocumentVerificationParams:this.enhancedDocumentVerificationParams}:{},...this.userDetails?{userDetails:this.userDetails}:{},...this.userId?{userId:this.userId}:{},...s?{config:s}:{},...this._theme?{theme:this._theme.build()}:{},...e?{network:e}:{},...a?{ml:a}:{},screens:i,...this.localizations?{localizations:this.localizations}:{},onResult:this.onResult,...this.onAnalyticsEvent?{onAnalyticsEvent:this.onAnalyticsEvent}:{}})}}}function Y(r,i){if(r)return;const e=i?.config?.token;if(!(!e||e.length===0))return K(e)?.tokenPayload}

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

@@ -14,4 +14,3 @@ export declare function FlowNavigationProvider({ manager, children, }: FlowNavig
  * silently no-op-ing on `navigateToNext()` / `navigateBack()` calls.
  */
 export declare function useFlowNavigation(): FlowNavigationManager;
-//# sourceMappingURL=flow_navigation_context.d.ts.map

package/dist/presentation/flow/flow_navigation_context.js

@@ -1,34 +1 @@
-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
+"use strict";import{jsx as i}from"react/jsx-runtime";import{createContext as t,useContext as n}from"react";const o=t(null);export function FlowNavigationProvider({manager:e,children:r}){return i(o.Provider,{value:e,children:r})}export function useFlowNavigation(){const e=n(o);if(!e)throw new Error("useFlowNavigation: called outside <UseSmileIDBuilder> \u2014 wrap the consuming screen with <FlowNavigationProvider> or render it inside <UseSmileIDBuilder>.");return e}

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

@@ -99,6 +99,14 @@ export declare class FlowNavigationManager {
     readonly resolvedSdkConfig: SdkConfig | undefined;
     /** Canonical `partner_id` decoded from the JWT (raw); resolved via the [partnerId] getter. */
     private readonly _resolvedPartnerId;
+    /**
+     * Token-bound user-detail/consent bindings decoded from the JWT
+     * `payload` claim, resolved once at construction alongside
+     * `resolvedSdkConfig`. `undefined` for offline mode / no token /
+     * legacy token — assembly then requires and sends everything exactly
+     * as before token support existed.
+     */
+    private readonly _resolvedTokenPayload;
     /**
      * Partner identifier the capture screen stamps into the Smile EXIF tag — the tag's HMAC/AES
      * keys derive from it and the backend validates the tag against the request's partner_id.
@@ -219,6 +227,13 @@ export declare class FlowNavigationManager {
      */
     private _assembleJob;
     private _requireSelfie;
+    /**
+     * Resolve `b.userDetails` for the wire. May legitimately return
+     * `undefined` when the token binds every required field
+     * (`given_names`, `last_name`, and a contact field) — the
+     * `user_details` part is then omitted and the server injects the
+     * token's values. Otherwise throws exactly as before token support.
+     */
     private _requireUserDetails;
     /**
      * Resolve `b.userId` for smartSelfieAuthentication —
@@ -227,9 +242,11 @@ export declare class FlowNavigationManager {
      */
     private _requireUserId;
     private _requireFrontDocument;
-    private _buildDocumentRequest;
-    private _buildEnhancedDocumentRequest;
+    /** Capture-artifact fields shared by both document request variants. */
+    private _documentRequestFields;
     /** Emit terminal `flow_completed` (completed/failed only; not cancelled), then exit via `onExit`. */
+    /** Captured images are removed at every terminal unless offline mode keeps them for a later submission. */
+    private _deleteCapturedFiles;
     private _finishFlow;
     /** Forward a lifecycle event to `onAnalyticsEvent`, adding `session_id` + `timestamp`. No-op without a callback. */
     private _logEvent;
@@ -253,4 +270,3 @@ export declare class FlowNavigationManager {
     private _notify;
 }
 export {};
-//# sourceMappingURL=flow_navigation_manager.d.ts.map