@incodetech/web 2.0.0 → 2.0.1

package/dist/types/face-match.d.ts

@@ -0,0 +1,59 @@
+import { FaceMatchConfig } from '@incodetech/core/face-match';
+import { FC } from 'preact/compat';
+
+/**
+ * Face match UI component.
+ *
+ * Provides a complete face comparison experience including:
+ * - Animated photo comparison sequence
+ * - Match/no-match result display
+ * - Continue button to proceed
+ *
+ * @example Basic usage
+ * ```tsx
+ * <FaceMatch
+ *   config={{
+ *     variant: 'selfieVsId',
+ *     disableFaceMatchAnimation: false,
+ *   }}
+ *   onFinish={() => router.push('/next-step')}
+ *   onError={(err) => toast.error(err)}
+ * />
+ * ```
+ *
+ * @see {@link createFaceMatchManager} for headless usage
+ */
+export declare const FaceMatch: FC<FaceMatchProps>;
+
+/**
+ * Props for the FaceMatch component
+ */
+declare type FaceMatchProps = IncodeModuleProps<FaceMatchConfig>;
+
+declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+    /**
+     * Module configuration required to render the flow.
+     * For Web Components, this is typically assigned via `element.config = ...`.
+     */
+    config?: TConfig;
+    /**
+     * Optional pre-built manager. When provided, the module does not create or manage the manager lifecycle.
+     */
+    manager?: TManager;
+    /**
+     * Callback invoked when the module completes successfully.
+     * @param result - Optional result data from the module completion
+     */
+    onFinish?: (result?: TResult) => void;
+    /**
+     * Callback invoked when a fatal module error occurs.
+     *
+     * @param error - Human-readable error message.
+     * @param errorCode - Optional numeric code (e.g. HTTP status). Populated by
+     *   the workflow and flow modules on QR validation failures —
+     *   `4026` (`expiredUUID`), `4081` (`invalidQRuuid`) or `4083` (`onboardingUrlAlreadyUsed`).
+     */
+    onError?: (error: string | undefined, errorCode?: number) => void;
+};
+
+export { }

package/dist/types/flow.d.ts

@@ -0,0 +1,137 @@
+import { CreateSessionOptions } from '@incodetech/core/session';
+import { FC } from 'preact/compat';
+import { FinishStatus } from '@incodetech/core/flow';
+import { FlowEvent } from '@incodetech/core/flow-events';
+import { WasmConfig } from '@incodetech/core/wasm';
+
+declare type ApiKeySessionBootstrap = {
+    apiKey: string;
+    clientId?: string;
+};
+
+declare type ClientIdSessionBootstrap = {
+    apiKey?: string;
+    clientId: string;
+};
+
+declare type FlowBaseConfig = {
+    authHint?: string;
+    wasmConfig?: WasmConfig;
+    lang?: string;
+    disableDashboardTheme?: boolean;
+    enableHome?: boolean;
+    useCPF?: boolean;
+};
+
+export declare type FlowConfig = FlowRuntimeConfig & FlowUiConfig;
+
+declare type FlowRuntimeConfig = TokenFlowRuntimeConfig | SelfLoadingFlowRuntimeConfig;
+
+declare type FlowUiConfig = {
+    onModuleLoading?: (moduleKey: string) => void;
+    onModuleLoaded?: (moduleKey: string) => void;
+    /**
+     * Receives curated flow milestones from this flow instance.
+     *
+     * Use this local-only stream for integration milestones such as
+     * `flow.started`, `flow.ready`, `flow.module.started`,
+     * `flow.module.completed`, `flow.completed`, and `flow.error`.
+     * For raw analytics events, use `subscribeEvent` from
+     * `@incodetech/core/events`.
+     */
+    onFlowEvent?: (event: FlowEvent) => void;
+    onWasmWarmup?: (pipelines: string[]) => void;
+    onUrlUuidRefreshed?: (urlUuid: string) => void;
+    spinnerConfig?: SpinnerConfig;
+};
+
+export declare const IncodeFlow: FC<IncodeFlowProps>;
+
+declare type IncodeFlowProps = IncodeModuleProps<FlowConfig, FinishStatus>;
+
+declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+    /**
+     * Module configuration required to render the flow.
+     * For Web Components, this is typically assigned via `element.config = ...`.
+     */
+    config?: TConfig;
+    /**
+     * Optional pre-built manager. When provided, the module does not create or manage the manager lifecycle.
+     */
+    manager?: TManager;
+    /**
+     * Callback invoked when the module completes successfully.
+     * @param result - Optional result data from the module completion
+     */
+    onFinish?: (result?: TResult) => void;
+    /**
+     * Callback invoked when a fatal module error occurs.
+     *
+     * @param error - Human-readable error message.
+     * @param errorCode - Optional numeric code (e.g. HTTP status). Populated by
+     *   the workflow and flow modules on QR validation failures —
+     *   `4026` (`expiredUUID`), `4081` (`invalidQRuuid`) or `4083` (`onboardingUrlAlreadyUsed`).
+     */
+    onError?: (error: string | undefined, errorCode?: number) => void;
+};
+
+/**
+ * Preload runs before the Flow component mounts and only prefetches the flow
+ * config + theme — it never burns a urlUuid. Allowing one would silently skip
+ * phishing-resistance rotation on mount (the consume path bypasses the init
+ * useEffect), so the field is forbidden at the type and runtime boundaries.
+ * Topology B (mobile leg of a desktop→mobile redirect) cannot use preload —
+ * pass `urlUuid` to `<IncodeFlow>` directly instead.
+ */
+declare type PreloadConfig = Omit<TokenFlowRuntimeConfig, 'urlUuid'> & {
+    urlUuid?: never;
+};
+
+export declare type PreloadHandle = {
+    get isReady(): boolean;
+    get error(): string | null;
+    waitUntilReady(): Promise<void>;
+    cancel(): void;
+};
+
+export declare function preloadIncodeFlow(config: PreloadConfig): PreloadHandle;
+
+declare type SelfLoadingFlowRuntimeConfig = FlowBaseConfig & SelfLoadingSessionOptions & (ApiKeySessionBootstrap | ClientIdSessionBootstrap) & {
+    token?: never;
+};
+
+declare type SelfLoadingSessionOptions = Pick<CreateSessionOptions, 'configurationId' | 'externalId' | 'externalCustomerId' | 'customFields' | 'uuid' | 'urlUuid' | 'interviewId'>;
+
+declare type SpinnerConfig = {
+    title?: string;
+    subtitle?: string;
+    size?: SpinnerSize;
+};
+
+declare type SpinnerSize = 'small' | 'medium' | 'large';
+
+declare type TokenFlowRuntimeConfig = FlowBaseConfig & {
+    token: string;
+    /** QR anti-phishing token from the incoming URL (mobile leg of a desktop→mobile redirect).
+     *  When provided, the SDK rotates it on mount via `validateQrUuid` and invokes
+     *  `onUrlUuidRefreshed` so the host can update the address bar. Validation
+     *  failures abort initialization via `onError` (with the HTTP status as
+     *  `errorCode`). */
+    urlUuid?: string;
+    apiKey?: never;
+    clientId?: never;
+    configurationId?: never;
+    externalId?: never;
+    externalCustomerId?: never;
+    customFields?: never;
+    uuid?: never;
+    interviewId?: never;
+};
+
+export { }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'incode-flow': HTMLElement & IncodeModuleProps<FlowConfig, FinishStatus>;
+    }
+}

package/dist/types/geolocation.d.ts

@@ -0,0 +1,41 @@
+import { FC } from 'preact/compat';
+import { GeolocationConfig } from '@incodetech/core/geolocation';
+
+declare const Geolocation_2: FC<GeolocationProps>;
+export { Geolocation_2 as Geolocation }
+
+declare type GeolocationProps = IncodeModuleProps<GeolocationConfig>;
+
+declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+    /**
+     * Module configuration required to render the flow.
+     * For Web Components, this is typically assigned via `element.config = ...`.
+     */
+    config?: TConfig;
+    /**
+     * Optional pre-built manager. When provided, the module does not create or manage the manager lifecycle.
+     */
+    manager?: TManager;
+    /**
+     * Callback invoked when the module completes successfully.
+     * @param result - Optional result data from the module completion
+     */
+    onFinish?: (result?: TResult) => void;
+    /**
+     * Callback invoked when a fatal module error occurs.
+     *
+     * @param error - Human-readable error message.
+     * @param errorCode - Optional numeric code (e.g. HTTP status). Populated by
+     *   the workflow and flow modules on QR validation failures —
+     *   `4026` (`expiredUUID`), `4081` (`invalidQRuuid`) or `4083` (`onboardingUrlAlreadyUsed`).
+     */
+    onError?: (error: string | undefined, errorCode?: number) => void;
+};
+
+export { }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'incode-geolocation': HTMLElement & IncodeModuleProps<GeolocationConfig>;
+    }
+}

package/dist/types/governmentValidation.d.ts

@@ -0,0 +1,34 @@
+import { FC } from 'preact/compat';
+import { GovernmentValidationConfig } from '@incodetech/core/government-validation';
+
+export declare const GovernmentValidation: FC<GovernmentValidationProps>;
+
+declare type GovernmentValidationProps = IncodeModuleProps<GovernmentValidationConfig>;
+
+declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+    /**
+     * Module configuration required to render the flow.
+     * For Web Components, this is typically assigned via `element.config = ...`.
+     */
+    config?: TConfig;
+    /**
+     * Optional pre-built manager. When provided, the module does not create or manage the manager lifecycle.
+     */
+    manager?: TManager;
+    /**
+     * Callback invoked when the module completes successfully.
+     * @param result - Optional result data from the module completion
+     */
+    onFinish?: (result?: TResult) => void;
+    /**
+     * Callback invoked when a fatal module error occurs.
+     *
+     * @param error - Human-readable error message.
+     * @param errorCode - Optional numeric code (e.g. HTTP status). Populated by
+     *   the workflow and flow modules on QR validation failures —
+     *   `4026` (`expiredUUID`), `4081` (`invalidQRuuid`) or `4083` (`onboardingUrlAlreadyUsed`).
+     */
+    onError?: (error: string | undefined, errorCode?: number) => void;
+};
+
+export { }

package/dist/types/id-ocr/styles.d.ts

@@ -0,0 +1 @@
+export {}

package/dist/types/id-verification.d.ts

@@ -0,0 +1,40 @@
+import { FC } from 'preact/compat';
+import { IdVerificationConfig } from '@incodetech/core/id-verification';
+
+export declare const IdVerification: FC<IdVerificationProps>;
+
+declare type IdVerificationProps = IncodeModuleProps<IdVerificationConfig>;
+
+declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+    /**
+     * Module configuration required to render the flow.
+     * For Web Components, this is typically assigned via `element.config = ...`.
+     */
+    config?: TConfig;
+    /**
+     * Optional pre-built manager. When provided, the module does not create or manage the manager lifecycle.
+     */
+    manager?: TManager;
+    /**
+     * Callback invoked when the module completes successfully.
+     * @param result - Optional result data from the module completion
+     */
+    onFinish?: (result?: TResult) => void;
+    /**
+     * Callback invoked when a fatal module error occurs.
+     *
+     * @param error - Human-readable error message.
+     * @param errorCode - Optional numeric code (e.g. HTTP status). Populated by
+     *   the workflow and flow modules on QR validation failures —
+     *   `4026` (`expiredUUID`), `4081` (`invalidQRuuid`) or `4083` (`onboardingUrlAlreadyUsed`).
+     */
+    onError?: (error: string | undefined, errorCode?: number) => void;
+};
+
+export { }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'incode-id-verification': HTMLElement & IncodeModuleProps<IdVerificationConfig>;
+    }
+}

package/dist/types/id.d.ts

@@ -0,0 +1,41 @@
+import { FC } from 'preact/compat';
+import { IdCaptureConfig } from '@incodetech/core/id';
+import { IdCaptureManager } from '@incodetech/core/id';
+
+export declare const Id: FC<IdProps>;
+
+declare type IdProps = IncodeModuleProps<IdCaptureConfig, void, IdCaptureManager>;
+
+declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+    /**
+     * Module configuration required to render the flow.
+     * For Web Components, this is typically assigned via `element.config = ...`.
+     */
+    config?: TConfig;
+    /**
+     * Optional pre-built manager. When provided, the module does not create or manage the manager lifecycle.
+     */
+    manager?: TManager;
+    /**
+     * Callback invoked when the module completes successfully.
+     * @param result - Optional result data from the module completion
+     */
+    onFinish?: (result?: TResult) => void;
+    /**
+     * Callback invoked when a fatal module error occurs.
+     *
+     * @param error - Human-readable error message.
+     * @param errorCode - Optional numeric code (e.g. HTTP status). Populated by
+     *   the workflow and flow modules on QR validation failures —
+     *   `4026` (`expiredUUID`), `4081` (`invalidQRuuid`) or `4083` (`onboardingUrlAlreadyUsed`).
+     */
+    onError?: (error: string | undefined, errorCode?: number) => void;
+};
+
+export { }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'incode-id': HTMLElement & IncodeModuleProps<IdCaptureConfig, void, IdCaptureManager>;
+    }
+}

package/dist/types/identity-reuse.d.ts

@@ -0,0 +1,43 @@
+import { FC } from 'preact/compat';
+import { IdentityReuseConfig } from '@incodetech/core/identity-reuse';
+import { IdentityReuseManager } from '@incodetech/core/identity-reuse';
+
+export declare const IdentityReuse: FC<IdentityReuseProps>;
+
+declare type IdentityReuseProps = IncodeModuleProps<IdentityReuseConfig, void, IdentityReuseManager>;
+
+declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+    /**
+     * Module configuration required to render the flow.
+     * For Web Components, this is typically assigned via `element.config = ...`.
+     */
+    config?: TConfig;
+    /**
+     * Optional pre-built manager. When provided, the module does not create or manage the manager lifecycle.
+     */
+    manager?: TManager;
+    /**
+     * Callback invoked when the module completes successfully.
+     * @param result - Optional result data from the module completion
+     */
+    onFinish?: (result?: TResult) => void;
+    /**
+     * Callback invoked when a fatal module error occurs.
+     *
+     * @param error - Human-readable error message.
+     * @param errorCode - Optional numeric code (e.g. HTTP status). Populated by
+     *   the workflow and flow modules on QR validation failures —
+     *   `4026` (`expiredUUID`), `4081` (`invalidQRuuid`) or `4083` (`onboardingUrlAlreadyUsed`).
+     */
+    onError?: (error: string | undefined, errorCode?: number) => void;
+};
+
+export { }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'incode-identity-reuse': HTMLElement & IncodeModuleProps<IdentityReuseConfig,
+  void,
+  IdentityReuseManagerType>;
+    }
+}

package/dist/types/index.d.ts

@@ -0,0 +1,32 @@
+import { DEFAULT_WASM_VERSION } from '@incodetech/core/wasm';
+import { I18nOptions } from './setup';
+import { WasmConfig } from '@incodetech/core/wasm';
+
+export { DEFAULT_WASM_VERSION }
+
+/**
+ * Sets global UI configuration defaults for `@incodetech/ui`.
+ */
+export declare function setUiConfig(next: UiConfig): void;
+
+export declare function setup({ apiURL, token, customHeaders, timeout, wasm, i18n, uiConfig, }: SetupOptions): Promise<void>;
+
+declare type SetupOptions = {
+    apiURL: string;
+    token: string;
+    customHeaders?: Record<string, string>;
+    timeout?: number;
+    wasm?: WasmConfig | false;
+    i18n?: I18nOptions;
+    uiConfig?: UiConfig;
+};
+
+export declare type UiConfig = {
+    logoSrc?: string;
+    logoHeight?: string;
+    subtitle?: string;
+    hideHeader?: boolean;
+    hideFooterBranding?: boolean;
+};
+
+export { }

package/dist/types/light.d.ts

@@ -0,0 +1 @@
+export { }

package/dist/types/mandatory-consent/styles.d.ts

@@ -0,0 +1 @@
+export {}

package/dist/types/phone.d.ts

@@ -0,0 +1,68 @@
+import { FC } from 'preact/compat';
+import { PhoneConfig } from '@incodetech/core/phone';
+import { PhoneManager } from '@incodetech/core/phone';
+
+declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+    /**
+     * Module configuration required to render the flow.
+     * For Web Components, this is typically assigned via `element.config = ...`.
+     */
+    config?: TConfig;
+    /**
+     * Optional pre-built manager. When provided, the module does not create or manage the manager lifecycle.
+     */
+    manager?: TManager;
+    /**
+     * Callback invoked when the module completes successfully.
+     * @param result - Optional result data from the module completion
+     */
+    onFinish?: (result?: TResult) => void;
+    /**
+     * Callback invoked when a fatal module error occurs.
+     *
+     * @param error - Human-readable error message.
+     * @param errorCode - Optional numeric code (e.g. HTTP status). Populated by
+     *   the workflow and flow modules on QR validation failures —
+     *   `4026` (`expiredUUID`), `4081` (`invalidQRuuid`) or `4083` (`onboardingUrlAlreadyUsed`).
+     */
+    onError?: (error: string | undefined, errorCode?: number) => void;
+};
+
+/**
+ * Phone verification UI component.
+ *
+ * Provides a complete phone verification experience including:
+ * - Country code selector with flag emojis
+ * - Phone number input with validation
+ * - OTP code entry with resend functionality
+ * - Loading states and error handling
+ *
+ * @example Basic usage
+ * ```tsx
+ * <Phone
+ *   config={{
+ *     otpVerification: true,
+ *     otpExpirationInMinutes: 5,
+ *     prefill: false,
+ *   }}
+ *   onFinish={() => router.push('/next-step')}
+ *   onError={(err) => toast.error(err)}
+ * />
+ * ```
+ *
+ * @see {@link createPhoneManager} for headless usage
+ */
+export declare const Phone: FC<PhoneProps>;
+
+/**
+ * Props for the Phone component
+ */
+declare type PhoneProps = IncodeModuleProps<PhoneConfig, void, PhoneManager>;
+
+export { }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'incode-phone': HTMLElement & IncodeModuleProps<PhoneConfig, void, PhoneManager>;
+    }
+}

package/dist/types/qe-signature.d.ts

@@ -0,0 +1,40 @@
+import { FC } from 'preact/compat';
+import { QeSignatureConfig } from '@incodetech/core/qe-signature';
+
+declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+    /**
+     * Module configuration required to render the flow.
+     * For Web Components, this is typically assigned via `element.config = ...`.
+     */
+    config?: TConfig;
+    /**
+     * Optional pre-built manager. When provided, the module does not create or manage the manager lifecycle.
+     */
+    manager?: TManager;
+    /**
+     * Callback invoked when the module completes successfully.
+     * @param result - Optional result data from the module completion
+     */
+    onFinish?: (result?: TResult) => void;
+    /**
+     * Callback invoked when a fatal module error occurs.
+     *
+     * @param error - Human-readable error message.
+     * @param errorCode - Optional numeric code (e.g. HTTP status). Populated by
+     *   the workflow and flow modules on QR validation failures —
+     *   `4026` (`expiredUUID`), `4081` (`invalidQRuuid`) or `4083` (`onboardingUrlAlreadyUsed`).
+     */
+    onError?: (error: string | undefined, errorCode?: number) => void;
+};
+
+export declare const QeSignature: FC<QeSignatureModuleProps>;
+
+declare type QeSignatureModuleProps = IncodeModuleProps<QeSignatureConfig>;
+
+export { }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'incode-qe-signature': HTMLElement & IncodeModuleProps<QeSignatureConfig>;
+    }
+}

package/dist/types/redirect-to-mobile/styles.d.ts

@@ -0,0 +1 @@
+export {}

package/dist/types/selfie.d.ts

@@ -0,0 +1,41 @@
+import { FC } from 'preact/compat';
+import { SelfieConfig } from '@incodetech/core/selfie';
+import { SelfieManager } from '@incodetech/core/selfie';
+
+declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+    /**
+     * Module configuration required to render the flow.
+     * For Web Components, this is typically assigned via `element.config = ...`.
+     */
+    config?: TConfig;
+    /**
+     * Optional pre-built manager. When provided, the module does not create or manage the manager lifecycle.
+     */
+    manager?: TManager;
+    /**
+     * Callback invoked when the module completes successfully.
+     * @param result - Optional result data from the module completion
+     */
+    onFinish?: (result?: TResult) => void;
+    /**
+     * Callback invoked when a fatal module error occurs.
+     *
+     * @param error - Human-readable error message.
+     * @param errorCode - Optional numeric code (e.g. HTTP status). Populated by
+     *   the workflow and flow modules on QR validation failures —
+     *   `4026` (`expiredUUID`), `4081` (`invalidQRuuid`) or `4083` (`onboardingUrlAlreadyUsed`).
+     */
+    onError?: (error: string | undefined, errorCode?: number) => void;
+};
+
+export declare const Selfie: FC<SelfieProps>;
+
+declare type SelfieProps = IncodeModuleProps<SelfieConfig, void, SelfieManager>;
+
+export { }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'incode-selfie': HTMLElement & IncodeModuleProps<SelfieConfig, void, SelfieManager>;
+    }
+}

package/dist/types/signature.d.ts

@@ -0,0 +1,40 @@
+import { FC } from 'preact/compat';
+import { SignatureConfig } from '@incodetech/core/signature';
+
+declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+    /**
+     * Module configuration required to render the flow.
+     * For Web Components, this is typically assigned via `element.config = ...`.
+     */
+    config?: TConfig;
+    /**
+     * Optional pre-built manager. When provided, the module does not create or manage the manager lifecycle.
+     */
+    manager?: TManager;
+    /**
+     * Callback invoked when the module completes successfully.
+     * @param result - Optional result data from the module completion
+     */
+    onFinish?: (result?: TResult) => void;
+    /**
+     * Callback invoked when a fatal module error occurs.
+     *
+     * @param error - Human-readable error message.
+     * @param errorCode - Optional numeric code (e.g. HTTP status). Populated by
+     *   the workflow and flow modules on QR validation failures —
+     *   `4026` (`expiredUUID`), `4081` (`invalidQRuuid`) or `4083` (`onboardingUrlAlreadyUsed`).
+     */
+    onError?: (error: string | undefined, errorCode?: number) => void;
+};
+
+export declare const Signature: FC<SignatureProps>;
+
+declare type SignatureProps = IncodeModuleProps<SignatureConfig>;
+
+export { }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'incode-signature': HTMLElement & IncodeModuleProps<SignatureConfig>;
+    }
+}

package/dist/types/styles.d.ts

@@ -0,0 +1 @@
+export { }

package/dist/types/themes/dark.d.ts

@@ -0,0 +1 @@
+export {}

package/dist/types/themes/light.d.ts

@@ -0,0 +1 @@
+export {}

package/dist/types/watchlist-for-business/styles.d.ts

@@ -0,0 +1 @@
+export {}