@smileid/usesmileid 12.0.1 → 12.1.0

package/dist/presentation/flow/validation/job_type_validator.d.ts

@@ -3,6 +3,7 @@ import type { NetworkConfig } from "../../../core/models/network_config";
 import type { BiometricKYCParams, ConsentInformation, DocumentVerificationParams, EnhancedDocumentVerificationParams, EnhancedKYCParams, UserDetails } from "../../../core/models/params";
 import { JobType } from "../../../core/models/job_type";
 import type { ScreenSpec } from "../dsl/builder/screens_builder";
+import { type TokenPayload } from "../../../data/model/token_payload";
 import type { ValidationIssue } from "./validation_state";
 /**
  * Job-type-specific flow validation rules.
@@ -38,6 +39,7 @@ export interface JobTypeValidator {
  */
 export type JobTypeValidatorInput = {
     readonly steps: readonly ScreenSpec[];
+    readonly userId?: string | undefined;
     readonly network?: NetworkConfig | undefined;
     readonly ml?: MLConfig | undefined;
     readonly consentInformation?: ConsentInformation | undefined;
@@ -46,7 +48,15 @@ export type JobTypeValidatorInput = {
     readonly documentVerificationParams?: DocumentVerificationParams | undefined;
     readonly enhancedDocumentVerificationParams?: EnhancedDocumentVerificationParams | undefined;
     readonly userDetails?: UserDetails | undefined;
+    /**
+     * User-detail/consent bindings decoded from the JWT `payload` claim.
+     * `undefined` (no token, offline mode, legacy token) keeps every rule
+     * exactly as strict as before token support existed.
+     */
+    readonly tokenPayload?: TokenPayload | undefined;
 };
+/** Key set must equal `JOB_PARAMS_OWNERS`'s field names — a key in one and not the other silently disarms the rule. */
+export declare const JOB_PARAMS_SUPPLIERS: Readonly<Record<string, (input: JobTypeValidatorInput) => unknown>>;
 /**
  * Validates selfie-only flows: BiometricKyc, SmartSelfieAuthentication,
  * SmartSelfieEnrollment.
@@ -121,4 +131,3 @@ export declare function resolveJobTypeValidator(jobType: JobType | undefined): J
  * generic structural validator as the fallback for unknown job types.
  */
 export declare function collectJobTypeIssues(input: JobTypeValidatorInput, issues: ValidationIssue[]): void;
-//# sourceMappingURL=job_type_validator.d.ts.map

package/dist/presentation/flow/validation/job_type_validator.js

@@ -1,434 +1 @@
-import { JobType } from "../../../core/models/job_type";
-import { CaptureType } from "../dsl/builder/screens_builder";
-import { InvalidJobTypeScreenConfigException } from "../../../core/exception/job_validation_exceptions";
-import { DuplicateScreenTypeException, InvalidScreenOrderException, MissingCaptureForPreviewException, } from "../../../core/exception/screen_config_validation_exceptions";
-import { IssueSeverity } from "../../../core/exception/issue_severity";
-/**
- * Stable display label for a `JobType` enum value, matching the
- * canonical name carried in the `Invalid configuration for {name}:`
- * message string. The DSL-facing `JobType` keys are camelCase; this map
- * supplies the PascalCase label used in partner-visible copy.
- */
-const JOB_TYPE_NAMES = new Map([
-    [JobType.biometricKyc, "BiometricKyc"],
-    [JobType.smartSelfieAuthentication, "SmartSelfieAuthentication"],
-    [JobType.smartSelfieEnrollment, "SmartSelfieEnrollment"],
-    [JobType.enhancedKyc, "EnhancedKyc"],
-    [JobType.documentVerification, "DocumentVerification"],
-    [JobType.bvn, "BVN"],
-    [JobType.enhancedDocumentVerification, "EnhancedDocumentVerification"],
-    [JobType.unknown, "Unknown"],
-]);
-/**
- * Resolve the partner-visible label for a `JobType` value.
- */
-function jobTypeName(jobType) {
-    return JOB_TYPE_NAMES.get(jobType) ?? "Unknown";
-}
-/**
- * Consent rule: exactly one form of consent is required — either a
- * Consent screen or pre-supplied `consentInformation`, never both and
- * never neither.
- */
-function appendConsentRule(jobType, input, issues) {
-    const hasConsentScreen = input.steps.some((s) => s.kind === "consent");
-    const hasConsentInformation = input.consentInformation !== undefined;
-    if (!hasConsentScreen && !hasConsentInformation) {
-        issues.push(InvalidJobTypeScreenConfigException.forJob({
-            jobType,
-            reason: "must include either a Consent screen or a pre-supplied consentInformation",
-            suggestedFix: "Add a consent { } screen to your flow, or supply consentInformation via the builder",
-        }));
-    }
-    else if (hasConsentScreen && hasConsentInformation) {
-        issues.push(InvalidJobTypeScreenConfigException.forJob({
-            jobType,
-            reason: "must not include both a Consent screen and a pre-supplied consentInformation — use one or the other",
-            suggestedFix: "Remove the consent { } screen if supplying consentInformation, or clear consentInformation if using the consent screen",
-        }));
-    }
-}
-/**
- * Reject more than one screen of any non-Capture, non-Preview type.
- * Capture screens may repeat (selfie + document) and Preview screens are
- * governed by the per-job preview rule instead, so both are excluded.
- */
-function appendDuplicateScreenRule(steps, issues) {
-    const indicesByKind = new Map();
-    steps.forEach((step, index) => {
-        if (step.kind === "capture" || step.kind === "preview")
-            return;
-        const list = indicesByKind.get(step.kind) ?? [];
-        list.push(index);
-        indicesByKind.set(step.kind, list);
-    });
-    for (const [kind, indices] of indicesByKind) {
-        if (indices.length > 1) {
-            issues.push(new DuplicateScreenTypeException({ screenType: kind, indices }));
-        }
-    }
-}
-/**
- * Enforce consent-first, processing-last, and instructions-before-capture
- * ordering. Preview ordering is handled by `appendPreviewRule`.
- */
-function appendScreenOrderRule(steps, issues) {
-    const consentIndex = steps.findIndex((s) => s.kind === "consent");
-    if (consentIndex > 0) {
-        issues.push(new InvalidScreenOrderException({
-            description: "Consent screen must be the first screen in the flow",
-            severity: IssueSeverity.error,
-        }));
-    }
-    const processingIndex = steps.findIndex((s) => s.kind === "processing");
-    if (processingIndex !== -1 && processingIndex !== steps.length - 1) {
-        issues.push(new InvalidScreenOrderException({
-            description: "Processing screen must be the last screen in the flow",
-            severity: IssueSeverity.error,
-        }));
-    }
-    let hasCaptureBeforeThisPoint = false;
-    steps.forEach((step, index) => {
-        if (step.kind === "capture") {
-            hasCaptureBeforeThisPoint = true;
-        }
-        else if (step.kind === "instructions" && hasCaptureBeforeThisPoint) {
-            issues.push(new InvalidScreenOrderException({
-                description: `Instructions screen at index ${index} must appear before the Capture screen`,
-                severity: IssueSeverity.error,
-            }));
-        }
-    });
-}
-/**
- * Preview rule for flows that allow at most `maxPreviews` preview
- * screens, each of which must follow a Capture screen. A preview with
- * no preceding capture emits `MissingCaptureForPreviewException`; an
- * extra preview beyond `maxPreviews` emits `InvalidScreenOrderException`.
- */
-function appendPreviewRule(steps, maxPreviews, issues) {
-    let hasCaptureBeforeThisPoint = false;
-    let previewCount = 0;
-    steps.forEach((step, index) => {
-        if (step.kind === "capture") {
-            hasCaptureBeforeThisPoint = true;
-        }
-        else if (step.kind === "preview") {
-            previewCount += 1;
-            if (!hasCaptureBeforeThisPoint) {
-                issues.push(new MissingCaptureForPreviewException({ previewIndex: index }));
-            }
-            else if (previewCount > maxPreviews) {
-                issues.push(new InvalidScreenOrderException({
-                    description: `Preview screen at index ${index} exceeds the maximum of ${maxPreviews} preview screen(s) allowed for this flow`,
-                    severity: IssueSeverity.error,
-                }));
-            }
-        }
-    });
-}
-/**
- * Processing screen is required for every job type. The companion
- * `network { }` block requirement is surfaced by `FlowValidator`
- * (job-agnostic) to keep a single emission point.
- */
-function appendProcessingRule(jobType, input, issues) {
-    const hasProcessingScreen = input.steps.some((s) => s.kind === "processing");
-    if (!hasProcessingScreen) {
-        issues.push(InvalidJobTypeScreenConfigException.forJob({
-            jobType,
-            reason: "must include a Processing screen",
-            suggestedFix: "Add a processing { } screen as the last screen in the flow",
-        }));
-    }
-}
-/**
- * Enforce exactly one selfie Capture screen.
- */
-function appendSelfieCaptureRule(jobType, input, issues) {
-    const selfieCaptures = input.steps.filter((s) => s.kind === "capture" && s.config.captureType === CaptureType.selfie);
-    if (selfieCaptures.length === 0) {
-        issues.push(InvalidJobTypeScreenConfigException.forJob({
-            jobType,
-            reason: "must include exactly one Capture screen with captureType = SELFIE",
-            suggestedFix: "Add a capture { captureType = CaptureType.SELFIE } screen to your flow",
-        }));
-    }
-    else if (selfieCaptures.length > 1) {
-        issues.push(InvalidJobTypeScreenConfigException.forJob({
-            jobType,
-            reason: `must include exactly one Capture screen with captureType = SELFIE, but found ${selfieCaptures.length}`,
-            suggestedFix: "Remove the extra selfie capture screens — only one is allowed",
-        }));
-    }
-}
-/**
- * Validate the selfie ML analyzer dependency. A Capture screen requires
- * an `ml { }` block, and that block must register analyzers for
- * `CaptureType.SELFIE`. The missing-block warning is owned by
- * `FlowValidator`; this rule emits only the error-severity
- * `InvalidJobTypeScreenConfigException`.
- */
-function appendSelfieMlRule(jobType, input, missingMlSuggestedFix, issues) {
-    if (!input.ml) {
-        issues.push(InvalidJobTypeScreenConfigException.forJob({
-            jobType,
-            reason: "ml { } block is required and must register analyzers for CaptureType.SELFIE",
-            suggestedFix: missingMlSuggestedFix,
-        }));
-    }
-    else if (!input.ml.analyzers.selfie) {
-        issues.push(InvalidJobTypeScreenConfigException.forJob({
-            jobType,
-            reason: "ml { } block must register analyzers for CaptureType.SELFIE",
-            suggestedFix: "Add forCaptureType(CaptureType.SELFIE) { } inside the ml { } block",
-        }));
-    }
-}
-/**
- * Validates selfie-only flows: BiometricKyc, SmartSelfieAuthentication,
- * SmartSelfieEnrollment.
- *
- * Allows at most one Preview screen, which must follow a Capture screen.
- */
-export class SelfieJobTypeValidator {
-    jobType;
-    constructor(jobType) {
-        this.jobType = jobType;
-    }
-    validate(input, issues) {
-        appendDuplicateScreenRule(input.steps, issues);
-        appendScreenOrderRule(input.steps, issues);
-        appendPreviewRule(input.steps, 1, issues);
-        appendConsentRule(this.jobType, input, issues);
-        appendSelfieCaptureRule(this.jobType, input, issues);
-        const hasDocumentCapture = input.steps.some((s) => s.kind === "capture" && s.config.captureType === CaptureType.document);
-        if (hasDocumentCapture) {
-            issues.push(InvalidJobTypeScreenConfigException.forJob({
-                jobType: this.jobType,
-                reason: "must not include a Document capture screen",
-                suggestedFix: `Remove the Document capture screen — ${jobTypeName(this.jobType)} requires selfie capture only`,
-            }));
-        }
-        appendProcessingRule(this.jobType, input, issues);
-        appendSelfieMlRule(this.jobType, input, "Add the ml { } block with forCaptureType(CaptureType.SELFIE) { } inside", issues);
-        if (input.ml?.analyzers.document) {
-            issues.push(InvalidJobTypeScreenConfigException.forJob({
-                jobType: this.jobType,
-                reason: "ml { } block must not register analyzers for CaptureType.DOCUMENT",
-                suggestedFix: `Remove forCaptureType(CaptureType.DOCUMENT) { } from the ml { } block — ${jobTypeName(this.jobType)} does not use document capture`,
-            }));
-        }
-        if (this.jobType === JobType.biometricKyc &&
-            input.biometricKYCParams === undefined) {
-            issues.push(InvalidJobTypeScreenConfigException.forJob({
-                jobType: this.jobType,
-                reason: "biometricKYCParams is required for BiometricKyc jobs",
-                suggestedFix: "Set builder.biometricKYCParams with the identity fields before building",
-            }));
-        }
-        if (input.userDetails === undefined) {
-            issues.push(InvalidJobTypeScreenConfigException.forJob({
-                jobType: this.jobType,
-                reason: `userDetails is required for ${jobTypeName(this.jobType)} jobs`,
-                suggestedFix: "Set builder.userDetails with the end user PII before building",
-            }));
-        }
-    }
-}
-/**
- * Validates document flows: DocumentVerification,
- * EnhancedDocumentVerification.
- *
- * Allows up to two Preview screens (a selfie-step preview and a
- * document-step preview); each must follow a Capture screen. The
- * document analyzer is optional — the native pipeline falls back to a
- * noop document detector — but a selfie analyzer is required for the
- * biometric match against the document portrait.
- */
-export class DocumentJobTypeValidator {
-    jobType;
-    constructor(jobType) {
-        this.jobType = jobType;
-    }
-    validate(input, issues) {
-        appendDuplicateScreenRule(input.steps, issues);
-        appendScreenOrderRule(input.steps, issues);
-        appendPreviewRule(input.steps, 2, issues);
-        appendConsentRule(this.jobType, input, issues);
-        appendSelfieCaptureRule(this.jobType, input, issues);
-        const documentCaptures = input.steps.filter((s) => s.kind === "capture" && s.config.captureType === CaptureType.document);
-        if (documentCaptures.length === 0) {
-            issues.push(InvalidJobTypeScreenConfigException.forJob({
-                jobType: this.jobType,
-                reason: "must include exactly one Capture screen with captureType = DOCUMENT",
-                suggestedFix: "Add a capture { captureType = CaptureType.DOCUMENT } screen to your flow",
-            }));
-        }
-        else if (documentCaptures.length > 1) {
-            issues.push(InvalidJobTypeScreenConfigException.forJob({
-                jobType: this.jobType,
-                reason: `must include exactly one Capture screen with captureType = DOCUMENT, but found ${documentCaptures.length}`,
-                suggestedFix: "Remove the extra document capture screens — only one is allowed",
-            }));
-        }
-        appendProcessingRule(this.jobType, input, issues);
-        // CaptureType.DOCUMENT uses a noop document detector by default — no
-        // explicit registration required.
-        appendSelfieMlRule(this.jobType, input, "Add the ml { } block with forCaptureType(CaptureType.SELFIE) { } inside — document capture uses NoopDocumentDetectorAnalyzer by default", issues);
-        this.appendParamsRule(input, issues);
-        // The South Africa Green Book carries no usable data on its back and is not
-        // supported by the Enhanced Document Verification ID-authority cross check.
-        // Reject it for that job type so the partner sees a build-time error instead
-        // of a server-side job failure.
-        if (this.jobType === JobType.enhancedDocumentVerification &&
-            documentCaptures.some((s) => s.kind === "capture" &&
-                s.config.documentConfig?.documentType?.kind ===
-                    "southAfricaGreenBook")) {
-            issues.push(InvalidJobTypeScreenConfigException.forJob({
-                jobType: this.jobType,
-                reason: "South Africa Green Book is not supported for Enhanced Document Verification",
-                suggestedFix: "Use JobType.documentVerification for the Green Book, or choose a supported document type for Enhanced Document Verification",
-            }));
-        }
-        if (input.userDetails === undefined) {
-            issues.push(InvalidJobTypeScreenConfigException.forJob({
-                jobType: this.jobType,
-                reason: `userDetails is required for ${jobTypeName(this.jobType)} jobs`,
-                suggestedFix: "Set builder.userDetails with the end user PII before building",
-            }));
-        }
-    }
-    /**
-     * Require the params object for each document job. Per-field blank
-     * checks live in the standalone validators in `flow_validator.ts`.
-     */
-    appendParamsRule(input, issues) {
-        if (this.jobType === JobType.documentVerification &&
-            input.documentVerificationParams === undefined) {
-            issues.push(InvalidJobTypeScreenConfigException.forJob({
-                jobType: this.jobType,
-                reason: "documentVerificationParams is required for DocumentVerification jobs",
-                suggestedFix: "Set builder.documentVerificationParams with the country (and optional idType) before building",
-            }));
-        }
-        if (this.jobType === JobType.enhancedDocumentVerification &&
-            input.enhancedDocumentVerificationParams === undefined) {
-            issues.push(InvalidJobTypeScreenConfigException.forJob({
-                jobType: this.jobType,
-                reason: "enhancedDocumentVerificationParams is required for EnhancedDocumentVerification jobs",
-                suggestedFix: "Set builder.enhancedDocumentVerificationParams with the country and idType before building",
-            }));
-        }
-    }
-}
-/**
- * Validates non-capture flows: EnhancedKyc, BVN.
- *
- * No capture happens, so no Preview screen is permitted. The flow must
- * consist of consent (in-flow or pre-supplied) followed by processing.
- * Enhanced KYC additionally requires `enhancedKYCParams` and
- * `userDetails`.
- */
-export class NonCaptureJobTypeValidator {
-    jobType;
-    constructor(jobType) {
-        this.jobType = jobType;
-    }
-    validate(input, issues) {
-        appendDuplicateScreenRule(input.steps, issues);
-        appendScreenOrderRule(input.steps, issues);
-        appendPreviewRule(input.steps, 0, issues);
-        appendConsentRule(this.jobType, input, issues);
-        appendProcessingRule(this.jobType, input, issues);
-        const disallowedScreens = input.steps.filter((s) => s.kind !== "consent" && s.kind !== "processing");
-        if (disallowedScreens.length > 0) {
-            const types = [...new Set(disallowedScreens.map((s) => s.kind))].join(", ");
-            issues.push(InvalidJobTypeScreenConfigException.forJob({
-                jobType: this.jobType,
-                reason: `must only contain consent and processing screens, but found: ${types}`,
-                suggestedFix: "Remove all screens except consent { } and processing { } from your flow",
-            }));
-        }
-        if (this.jobType === JobType.enhancedKyc &&
-            input.enhancedKYCParams === undefined) {
-            issues.push(InvalidJobTypeScreenConfigException.forJob({
-                jobType: this.jobType,
-                reason: "enhancedKYCParams is required for EnhancedKyc jobs",
-                suggestedFix: "Set builder.enhancedKYCParams with the identity fields before building",
-            }));
-        }
-        if (this.jobType === JobType.enhancedKyc &&
-            input.userDetails === undefined) {
-            issues.push(InvalidJobTypeScreenConfigException.forJob({
-                jobType: this.jobType,
-                reason: "userDetails is required for EnhancedKyc jobs",
-                suggestedFix: "Set builder.userDetails with the end user PII before building",
-            }));
-        }
-    }
-}
-/**
- * Generic structural validator used when no concrete `JobType` is
- * resolved yet (e.g. a UI-only flow without a `network { }` block). It
- * applies only the job-agnostic structural rules so partners still get
- * screen-order / duplicate / preview feedback while prototyping. A
- * single Preview following a Capture is permitted by default.
- */
-export class DefaultStructuralValidator {
-    validate(input, issues) {
-        appendDuplicateScreenRule(input.steps, issues);
-        appendScreenOrderRule(input.steps, issues);
-        appendPreviewRule(input.steps, 1, issues);
-    }
-}
-/**
- * Registry mapping each `JobType` to its validator instance. Adding a new job
- * type is a one-line registry change here; the validator runs the union of
- * the per-type rules (consent + selfie / document / etc.) declared above.
- */
-export const jobTypeValidators = new Map([
-    [JobType.biometricKyc, new SelfieJobTypeValidator(JobType.biometricKyc)],
-    [
-        JobType.smartSelfieAuthentication,
-        new SelfieJobTypeValidator(JobType.smartSelfieAuthentication),
-    ],
-    [
-        JobType.smartSelfieEnrollment,
-        new SelfieJobTypeValidator(JobType.smartSelfieEnrollment),
-    ],
-    [
-        JobType.documentVerification,
-        new DocumentJobTypeValidator(JobType.documentVerification),
-    ],
-    [
-        JobType.enhancedDocumentVerification,
-        new DocumentJobTypeValidator(JobType.enhancedDocumentVerification),
-    ],
-    [JobType.enhancedKyc, new NonCaptureJobTypeValidator(JobType.enhancedKyc)],
-    [JobType.bvn, new NonCaptureJobTypeValidator(JobType.bvn)],
-]);
-const defaultStructuralValidator = new DefaultStructuralValidator();
-/**
- * Resolve the validator for the configured job type, falling back to the
- * generic structural validator when the job type is unknown or
- * unregistered. Always returns a validator so the generic structural
- * rules run regardless of dispatch.
- */
-export function resolveJobTypeValidator(jobType) {
-    if (jobType === undefined || jobType === JobType.unknown) {
-        return defaultStructuralValidator;
-    }
-    return jobTypeValidators.get(jobType) ?? defaultStructuralValidator;
-}
-/**
- * Run the job-type-specific rules against the flow and append any issues
- * found. Called by `FlowValidator` after its generic builder pass. The
- * matching validator is resolved from the configured `jobType`, with the
- * generic structural validator as the fallback for unknown job types.
- */
-export function collectJobTypeIssues(input, issues) {
-    const jobType = input.network?.config?.jobType;
-    resolveJobTypeValidator(jobType).validate(input, issues);
-}
-//# sourceMappingURL=job_type_validator.js.map
+"use strict";import{JobType as i}from"../../../core/models/job_type";import{CaptureType as h}from"../dsl/builder/screens_builder";import{InvalidJobTypeScreenConfigException as a}from"../../../core/exception/job_validation_exceptions";import{JOB_PARAMS_OWNERS as S,UnusedJobParamsException as x}from"../../../core/exception/unused_job_params_exception";import{DuplicateScreenTypeException as k,InvalidScreenOrderException as d,MissingCaptureForPreviewException as E}from"../../../core/exception/screen_config_validation_exceptions";import{IssueSeverity as p}from"../../../core/exception/issue_severity";import{tokenConsentMissingSubfields as P,bindsRequiredUserDetails as D}from"../../../data/model/token_payload";import{missingUserDetailsFieldIssues as V}from"./user_details_validator";const I=new Map([[i.biometricKyc,"BiometricKyc"],[i.smartSelfieAuthentication,"SmartSelfieAuthentication"],[i.smartSelfieEnrollment,"SmartSelfieEnrollment"],[i.enhancedKyc,"EnhancedKyc"],[i.documentVerification,"DocumentVerification"],[i.bvn,"BVN"],[i.enhancedDocumentVerification,"EnhancedDocumentVerification"],[i.unknown,"Unknown"]]);function m(o){return I.get(o)??"Unknown"}function y(o,e,n){const t=e.steps.some(s=>s.kind==="consent"),r=e.consentInformation!==void 0,c=e.tokenPayload?.consent;if(c!==void 0){const s=P(c);s.length>0&&n.push(a.forJob({jobType:o,reason:`the token's consent binding is incomplete \u2014 missing: ${s.join(", ")}`,suggestedFix:"Bind all four consent fields when minting the token at /v3/token, or bind none and collect consent in the app"}));return}!t&&!r&&n.push(a.forJob({jobType:o,reason:"must include either a Consent screen or a pre-supplied consentInformation",suggestedFix:"Add a consent { } screen to your flow, or supply consentInformation via the builder"}))}export const JOB_PARAMS_SUPPLIERS={enhancedKYCParams:o=>o.enhancedKYCParams,biometricKYCParams:o=>o.biometricKYCParams,documentVerificationParams:o=>o.documentVerificationParams,enhancedDocumentVerificationParams:o=>o.enhancedDocumentVerificationParams};function b(o,e,n){for(const{fieldName:t,owner:r}of S)r!==o&&JOB_PARAMS_SUPPLIERS[t]?.(e)!==void 0&&n.push(new x({jobType:o,fieldName:t}))}function T(o,e,n){if(e.userDetails===void 0&&!D(e.tokenPayload)){if(e.tokenPayload===void 0){n.push(a.forJob({jobType:o,reason:`userDetails is required for ${m(o)} jobs`,suggestedFix:"Set builder.userDetails with the end user PII before building"}));return}n.push(...V(void 0,e.tokenPayload))}}function f(o,e){const n=new Map;o.forEach((t,r)=>{if(t.kind==="capture"||t.kind==="preview")return;const c=n.get(t.kind)??[];c.push(r),n.set(t.kind,c)});for(const[t,r]of n)r.length>1&&e.push(new k({screenType:t,indices:r}))}function u(o,e){o.findIndex(c=>c.kind==="consent")>0&&e.push(new d({description:"Consent screen must be the first screen in the flow",severity:p.error}));const t=o.findIndex(c=>c.kind==="processing");t!==-1&&t!==o.length-1&&e.push(new d({description:"Processing screen must be the last screen in the flow",severity:p.error}));let r=!1;o.forEach((c,s)=>{c.kind==="capture"?r=!0:c.kind==="instructions"&&r&&e.push(new d({description:`Instructions screen at index ${s} must appear before the Capture screen`,severity:p.error}))})}function l(o,e,n){let t=!1,r=0;o.forEach((c,s)=>{c.kind==="capture"?t=!0:c.kind==="preview"&&(r+=1,t?r>e&&n.push(new d({description:`Preview screen at index ${s} exceeds the maximum of ${e} preview screen(s) allowed for this flow`,severity:p.error})):n.push(new E({previewIndex:s})))})}function g(o,e,n){e.steps.some(r=>r.kind==="processing")||n.push(a.forJob({jobType:o,reason:"must include a Processing screen",suggestedFix:"Add a processing { } screen as the last screen in the flow"}))}function j(o,e,n){const t=e.steps.filter(r=>r.kind==="capture"&&r.config.captureType===h.selfie);t.length===0?n.push(a.forJob({jobType:o,reason:"must include exactly one Capture screen with captureType = SELFIE",suggestedFix:"Add a capture { captureType = CaptureType.SELFIE } screen to your flow"})):t.length>1&&n.push(a.forJob({jobType:o,reason:`must include exactly one Capture screen with captureType = SELFIE, but found ${t.length}`,suggestedFix:"Remove the extra selfie capture screens \u2014 only one is allowed"}))}function w(o,e,n,t){e.ml?e.ml.analyzers.selfie||t.push(a.forJob({jobType:o,reason:"ml { } block must register analyzers for CaptureType.SELFIE",suggestedFix:"Add forCaptureType(CaptureType.SELFIE) { } inside the ml { } block"})):t.push(a.forJob({jobType:o,reason:"ml { } block is required and must register analyzers for CaptureType.SELFIE",suggestedFix:n}))}export class SelfieJobTypeValidator{jobType;constructor(e){this.jobType=e}validate(e,n){f(e.steps,n),u(e.steps,n),l(e.steps,1,n),y(this.jobType,e,n),b(this.jobType,e,n),j(this.jobType,e,n),e.steps.some(r=>r.kind==="capture"&&r.config.captureType===h.document)&&n.push(a.forJob({jobType:this.jobType,reason:"must not include a Document capture screen",suggestedFix:`Remove the Document capture screen \u2014 ${m(this.jobType)} requires selfie capture only`})),g(this.jobType,e,n),w(this.jobType,e,"Add the ml { } block with forCaptureType(CaptureType.SELFIE) { } inside",n),e.ml?.analyzers.document&&n.push(a.forJob({jobType:this.jobType,reason:"ml { } block must not register analyzers for CaptureType.DOCUMENT",suggestedFix:`Remove forCaptureType(CaptureType.DOCUMENT) { } from the ml { } block \u2014 ${m(this.jobType)} does not use document capture`})),this.jobType===i.biometricKyc&&e.biometricKYCParams===void 0&&n.push(a.forJob({jobType:this.jobType,reason:"biometricKYCParams is required for BiometricKyc jobs",suggestedFix:"Set builder.biometricKYCParams with the identity fields before building"})),this.jobType===i.smartSelfieAuthentication&&(e.userId===void 0||e.userId.trim()==="")&&n.push(a.forJob({jobType:this.jobType,reason:"userId is required for SmartSelfieAuthentication jobs",suggestedFix:"Set builder.userId with the identifier returned by a prior Smart Selfie Enrollment before building"})),T(this.jobType,e,n)}}export class DocumentJobTypeValidator{jobType;constructor(e){this.jobType=e}validate(e,n){f(e.steps,n),u(e.steps,n),l(e.steps,2,n),y(this.jobType,e,n),b(this.jobType,e,n),j(this.jobType,e,n);const t=e.steps.filter(r=>r.kind==="capture"&&r.config.captureType===h.document);t.length===0?n.push(a.forJob({jobType:this.jobType,reason:"must include exactly one Capture screen with captureType = DOCUMENT",suggestedFix:"Add a capture { captureType = CaptureType.DOCUMENT } screen to your flow"})):t.length>1&&n.push(a.forJob({jobType:this.jobType,reason:`must include exactly one Capture screen with captureType = DOCUMENT, but found ${t.length}`,suggestedFix:"Remove the extra document capture screens \u2014 only one is allowed"})),g(this.jobType,e,n),w(this.jobType,e,"Add the ml { } block with forCaptureType(CaptureType.SELFIE) { } inside \u2014 document capture uses NoopDocumentDetectorAnalyzer by default",n),this.appendParamsRule(e,n),this.jobType===i.enhancedDocumentVerification&&t.some(r=>r.kind==="capture"&&r.config.documentConfig?.documentType?.kind==="southAfricaGreenBook")&&n.push(a.forJob({jobType:this.jobType,reason:"South Africa Green Book is not supported for Enhanced Document Verification",suggestedFix:"Use JobType.documentVerification for the Green Book, or choose a supported document type for Enhanced Document Verification"})),T(this.jobType,e,n)}appendParamsRule(e,n){this.jobType===i.documentVerification&&e.documentVerificationParams===void 0&&n.push(a.forJob({jobType:this.jobType,reason:"documentVerificationParams is required for DocumentVerification jobs",suggestedFix:"Set builder.documentVerificationParams with the country (and optional idType) before building"})),this.jobType===i.enhancedDocumentVerification&&e.enhancedDocumentVerificationParams===void 0&&n.push(a.forJob({jobType:this.jobType,reason:"enhancedDocumentVerificationParams is required for EnhancedDocumentVerification jobs",suggestedFix:"Set builder.enhancedDocumentVerificationParams with the country and idType before building"}))}}export class NonCaptureJobTypeValidator{jobType;constructor(e){this.jobType=e}validate(e,n){f(e.steps,n),u(e.steps,n),l(e.steps,0,n),y(this.jobType,e,n),b(this.jobType,e,n),g(this.jobType,e,n);const t=e.steps.filter(r=>r.kind!=="consent"&&r.kind!=="processing");if(t.length>0){const r=[...new Set(t.map(c=>c.kind))].join(", ");n.push(a.forJob({jobType:this.jobType,reason:`must only contain consent and processing screens, but found: ${r}`,suggestedFix:"Remove all screens except consent { } and processing { } from your flow"}))}this.jobType===i.enhancedKyc&&e.enhancedKYCParams===void 0&&n.push(a.forJob({jobType:this.jobType,reason:"enhancedKYCParams is required for EnhancedKyc jobs",suggestedFix:"Set builder.enhancedKYCParams with the identity fields before building"})),this.jobType===i.enhancedKyc&&T(this.jobType,e,n)}}export class DefaultStructuralValidator{validate(e,n){f(e.steps,n),u(e.steps,n),l(e.steps,1,n)}}export const jobTypeValidators=new Map([[i.biometricKyc,new SelfieJobTypeValidator(i.biometricKyc)],[i.smartSelfieAuthentication,new SelfieJobTypeValidator(i.smartSelfieAuthentication)],[i.smartSelfieEnrollment,new SelfieJobTypeValidator(i.smartSelfieEnrollment)],[i.documentVerification,new DocumentJobTypeValidator(i.documentVerification)],[i.enhancedDocumentVerification,new DocumentJobTypeValidator(i.enhancedDocumentVerification)],[i.enhancedKyc,new NonCaptureJobTypeValidator(i.enhancedKyc)],[i.bvn,new NonCaptureJobTypeValidator(i.bvn)]]);const C=new DefaultStructuralValidator;export function resolveJobTypeValidator(o){return o===void 0||o===i.unknown?C:jobTypeValidators.get(o)??C}export function collectJobTypeIssues(o,e){const n=o.network?.config?.jobType;resolveJobTypeValidator(n).validate(o,e)}

package/dist/presentation/flow/validation/user_details_validator.d.ts

@@ -0,0 +1,8 @@
+import type { UserDetails } from "../../../core/models/params";
+import type { TokenPayload } from "../../../data/model/token_payload";
+import type { ValidationIssue } from "./validation_state";
+/**
+ * Field-union rule shared by the content validator and the job-type required
+ * rule: a field is covered when the token binds it or the builder supplies it.
+ */
+export declare function missingUserDetailsFieldIssues(userDetails: UserDetails | undefined, tokenPayload: TokenPayload | undefined): ValidationIssue[];

package/dist/presentation/flow/validation/user_details_validator.js

@@ -0,0 +1 @@
+"use strict";import{InvalidFieldValueException as o}from"../../../core/exception/job_validation_exceptions";export function missingUserDetailsFieldIssues(n,e){const t=[],a=e===void 0?"must not be blank":"not bound by the token and not supplied on the builder",m={givenNames:e?.hasGivenNames===!0,lastName:e?.hasLastName===!0};for(const s of["givenNames","lastName"]){if(m[s])continue;const i=n?.[s];(!i||!i.trim())&&t.push(new o({fieldName:`userDetails.${s}`,reason:a}))}const u=!!n?.email&&n.email.trim().length>0,l=!!n?.phoneNumber&&n.phoneNumber.trim().length>0,r=e?.hasEmail===!0||e?.hasPhoneNumber===!0;return!u&&!l&&!r&&t.push(new o({fieldName:"userDetails",reason:e===void 0?"at least one of email or phoneNumber must be non blank":"at least one contact field must be bound by the token or supplied on the builder"})),t}

package/dist/presentation/flow/validation/validation_state.d.ts

@@ -22,7 +22,7 @@ export type ValidationIssue = UseSmileIDValidationException;
 /**
  * Result of running the flow validator.
  *
- * - `valid: true` — every rule passed (no errors and no warnings).
+ * - `valid: true` — no error issue; warnings never make a flow invalid.
  * - `valid: false` — at least one error issue. `issues` is non-empty
  *   and may contain a mix of `error` and `warning` entries.
  */
@@ -47,8 +47,8 @@ export type ValidationStateInvalid = {
  * worrying about reference identity.
  *
  * `ValidationState.invalid(issues)` returns a frozen invalid state.
- * If `issues` is empty, returns the valid sentinel — `validate()`
- * implementations don't need to special-case the empty path.
+ * With no error-severity entry it returns the valid sentinel, so callers need no
+ * special case.
  */
 export declare const ValidationState: {
     readonly valid: {
@@ -56,4 +56,3 @@ export declare const ValidationState: {
     };
     readonly invalid: (issues: readonly ValidationIssue[]) => ValidationState;
 };
-//# sourceMappingURL=validation_state.d.ts.map

package/dist/presentation/flow/validation/validation_state.js

@@ -1,23 +1 @@
-import { IssueSeverity } from "../../../core/exception/issue_severity";
-export { IssueSeverity };
-const VALID_STATE = Object.freeze({ valid: true });
-/**
- * Construct a `ValidationState`.
- *
- * `ValidationState.valid` returns the canonical "no issues" sentinel
- * (frozen) — partners can compare via `state.valid === true` without
- * worrying about reference identity.
- *
- * `ValidationState.invalid(issues)` returns a frozen invalid state.
- * If `issues` is empty, returns the valid sentinel — `validate()`
- * implementations don't need to special-case the empty path.
- */
-export const ValidationState = {
-    valid: VALID_STATE,
-    invalid(issues) {
-        if (issues.length === 0)
-            return VALID_STATE;
-        return Object.freeze({ valid: false, issues: Object.freeze([...issues]) });
-    },
-};
-//# sourceMappingURL=validation_state.js.map
+"use strict";import{IssueSeverity as r}from"../../../core/exception/issue_severity";export{r as IssueSeverity};const t=Object.freeze({valid:!0});export const ValidationState={valid:t,invalid(e){return e.some(i=>i.severity===r.error)?Object.freeze({valid:!1,issues:Object.freeze([...e])}):t}};

package/dist/presentation/screen/helpers/capture_screen_helpers.d.ts

@@ -26,4 +26,3 @@ export declare function resolveCaptureFeedback(state: OverlayState, loc: UseSmil
  * the pre-flight `INSTRUCTION` state — before the pipeline has started.
  */
 export declare function isStartCaptureEnabled(state: OverlayState): boolean;
-//# sourceMappingURL=capture_screen_helpers.d.ts.map