@incodetech/web 2.1.1 → 2.2.0-rc.1

package/dist/types/watchlist.d.ts

@@ -1,5 +1,59 @@
+import { DeepPartial } from '@incodetech/core/flow';
 import { FC } from 'preact/compat';
+import { FunctionComponent } from 'preact';
+import { SVGProps } from 'preact/compat';
 import { WatchlistConfig } from '@incodetech/core/watchlist';
+import { WatchlistManager } from '@incodetech/core/watchlist';
+
+/**
+ * Allowlisted keys for overridable Lottie animations
+ */
+declare type AnimationKey = 'id.tutorial.front' | 'id.tutorial.back' | 'id.tutorial.passport' | 'id.flip' | 'id.processing' | 'selfie.tutorial' | 'loader.spinner';
+
+/**
+ * A customer-supplied replacement for a built-in Lottie animation.
+ *
+ * - `LottieAnimationData` — a parsed Lottie JSON object.
+ * - `{ url }` — fetched and cached at runtime.
+ * - `{ animationData }` — explicit object form.
+ */
+declare type AnimationOverride = LottieAnimationData | {
+    url: string;
+} | {
+    animationData: LottieAnimationData;
+};
+
+declare type AnimationOverrides = Partial<Record<AnimationKey, AnimationOverride>>;
+
+/**
+ * Allowlisted keys for overridable branded SVG illustrations
+ */
+declare type AssetKey = 'faceMatch.success' | 'faceMatch.fail' | 'documentCapture.tutorial' | 'id.uploadScreen' | 'id.ageVerification.dob' | 'id.ageVerification.scan' | 'id.ageVerification.privacy' | 'videoSelfie.success' | 'videoSelfie.fail' | 'videoSelfie.tutorial.permission' | 'videoSelfie.tutorial.selfie' | 'videoSelfie.tutorial.frontId' | 'videoSelfie.tutorial.backId' | 'videoSelfie.tutorial.poa' | 'videoSelfie.tutorial.questions' | 'videoSelfie.tutorial.speech' | 'loader.spinner';
+
+/**
+ * A customer-supplied replacement for a built-in SVG illustration.
+ *
+ * - `string` — a URL, or raw `<svg …>` markup (detected by a leading `<`).
+ * - `{ url }` — fetched and rendered via `<img>`; no script execution.
+ * - `{ raw }` — inline markup; sanitized before injection.
+ * - `{ svg }` — a precompiled component, for build-time integrations.
+ */
+declare type AssetOverride = string | {
+    url: string;
+} | {
+    raw: string;
+} | {
+    svg: SvgComponent;
+};
+
+declare type AssetOverrides = Partial<Record<AssetKey, AssetOverride>>;
+
+/**
+ * A module `config` intersected with the per-instance override maps. Typed at
+ * the UI boundary so core config types (e.g. `IdCaptureConfig`) stay untouched;
+ * `FlowConfig` also declares the maps directly.
+ */
+declare type ConfigWithOverrides<TConfig> = TConfig & InstanceOverrides;
 
 /**
  * Extra context passed to `onFinish` alongside the result. Lets a host decide
@@ -21,12 +75,16 @@ declare type IncodeFinishMeta = {
     sdkOwnsTerminalScreen?: boolean;
 };
 
-declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown, TConfigInput = ConfigWithOverrides<TConfig>> = {
     /**
      * Module configuration required to render the flow.
      * For Web Components, this is typically assigned via `element.config = ...`.
+     *
+     * Also carries optional per-instance `assets`/`animations` override maps;
+     * they override the global `setup({ uiConfig })` values for this
+     * element only and are ignored by the core manager.
      */
-    config?: TConfig;
+    config?: TConfigInput;
     /**
      * Optional pre-built manager. When provided, the module does not create or manage the manager lifecycle.
      */
@@ -52,14 +110,42 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
     onError?: (error: string | undefined, errorCode?: number, moduleErrorCode?: string) => void;
 };
 
-export declare const Watchlist: FC<WatchlistProps>;
+/**
+ * Per-instance asset/animation overrides for a single mounted SDK module.
+ *
+ * These ride on the module's `config` prop and are published once at the
+ * module root by `registerIncodeModuleElement`, so a deep `<Asset>`/`<AnimatedAsset>`
+ * reads them via {@link useInstanceOverrides} without any prop drilling.
+ */
+declare type InstanceOverrides = {
+    assets?: AssetOverrides;
+    animations?: AnimationOverrides;
+};
+
+declare type LottieAnimationData = {
+    fr: number;
+    v: string;
+    ip: number;
+    op: number;
+    w: number;
+    h: number;
+};
+
+/** An SVG imported as a Preact component (the `?react` import shape). */
+declare type SvgComponent = FunctionComponent<SVGProps<SVGSVGElement>>;
+
+export declare const Watchlist: FC<Omit<WatchlistProps, "config"> & {
+    config?: (Omit<unknown, never> & DeepPartial<Pick<unknown, never>>) | undefined;
+}>;
 
-declare type WatchlistProps = IncodeModuleProps<WatchlistConfig>;
+declare type WatchlistProps = IncodeModuleProps<WatchlistConfig, void, WatchlistManager>;
 
 export { }
 
 declare global {
     interface HTMLElementTagNameMap {
-        'incode-watchlist': HTMLElement & IncodeModuleProps<WatchlistConfig>;
+        'incode-watchlist': HTMLElement & IncodeModuleProps<WatchlistConfig,
+  void,
+  WatchlistManager>;
     }
 }

package/dist/types/workflow.d.ts

@@ -2,18 +2,70 @@ import { CreateSessionOptions } from '@incodetech/core/session';
 import { CustomModuleCallback } from '@incodetech/core/workflow';
 import { FC } from 'preact/compat';
 import { FinishStatus } from '@incodetech/core/flow';
+import { FunctionComponent } from 'preact';
+import { SVGProps } from 'preact/compat';
 import { WasmConfig } from '@incodetech/core/wasm';
 
+/**
+ * Allowlisted keys for overridable Lottie animations
+ */
+declare type AnimationKey = 'id.tutorial.front' | 'id.tutorial.back' | 'id.tutorial.passport' | 'id.flip' | 'id.processing' | 'selfie.tutorial' | 'loader.spinner';
+
+/**
+ * A customer-supplied replacement for a built-in Lottie animation.
+ *
+ * - `LottieAnimationData` — a parsed Lottie JSON object.
+ * - `{ url }` — fetched and cached at runtime.
+ * - `{ animationData }` — explicit object form.
+ */
+declare type AnimationOverride = LottieAnimationData | {
+    url: string;
+} | {
+    animationData: LottieAnimationData;
+};
+
+declare type AnimationOverrides = Partial<Record<AnimationKey, AnimationOverride>>;
+
 declare type ApiKeySessionBootstrap = {
     apiKey: string;
     clientId?: string;
 };
 
+/**
+ * Allowlisted keys for overridable branded SVG illustrations
+ */
+declare type AssetKey = 'faceMatch.success' | 'faceMatch.fail' | 'documentCapture.tutorial' | 'id.uploadScreen' | 'id.ageVerification.dob' | 'id.ageVerification.scan' | 'id.ageVerification.privacy' | 'videoSelfie.success' | 'videoSelfie.fail' | 'videoSelfie.tutorial.permission' | 'videoSelfie.tutorial.selfie' | 'videoSelfie.tutorial.frontId' | 'videoSelfie.tutorial.backId' | 'videoSelfie.tutorial.poa' | 'videoSelfie.tutorial.questions' | 'videoSelfie.tutorial.speech' | 'loader.spinner';
+
+/**
+ * A customer-supplied replacement for a built-in SVG illustration.
+ *
+ * - `string` — a URL, or raw `<svg …>` markup (detected by a leading `<`).
+ * - `{ url }` — fetched and rendered via `<img>`; no script execution.
+ * - `{ raw }` — inline markup; sanitized before injection.
+ * - `{ svg }` — a precompiled component, for build-time integrations.
+ */
+declare type AssetOverride = string | {
+    url: string;
+} | {
+    raw: string;
+} | {
+    svg: SvgComponent;
+};
+
+declare type AssetOverrides = Partial<Record<AssetKey, AssetOverride>>;
+
 declare type ClientIdSessionBootstrap = {
     apiKey?: string;
     clientId: string;
 };
 
+/**
+ * A module `config` intersected with the per-instance override maps. Typed at
+ * the UI boundary so core config types (e.g. `IdCaptureConfig`) stay untouched;
+ * `FlowConfig` also declares the maps directly.
+ */
+declare type ConfigWithOverrides<TConfig> = TConfig & InstanceOverrides;
+
 /**
  * Extra context passed to `onFinish` alongside the result. Lets a host decide
  * how to react to the terminal state without inspecting the DOM. Only the
@@ -34,12 +86,16 @@ export declare type IncodeFinishMeta = {
     sdkOwnsTerminalScreen?: boolean;
 };
 
-declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown, TConfigInput = ConfigWithOverrides<TConfig>> = {
     /**
      * Module configuration required to render the flow.
      * For Web Components, this is typically assigned via `element.config = ...`.
+     *
+     * Also carries optional per-instance `assets`/`animations` override maps;
+     * they override the global `setup({ uiConfig })` values for this
+     * element only and are ignored by the core manager.
      */
-    config?: TConfig;
+    config?: TConfigInput;
     /**
      * Optional pre-built manager. When provided, the module does not create or manage the manager lifecycle.
      */
@@ -69,6 +125,27 @@ export declare const IncodeWorkflow: FC<IncodeWorkflowProps>;
 
 declare type IncodeWorkflowProps = IncodeModuleProps<WorkflowComponentConfig, FinishStatus>;
 
+/**
+ * Per-instance asset/animation overrides for a single mounted SDK module.
+ *
+ * These ride on the module's `config` prop and are published once at the
+ * module root by `registerIncodeModuleElement`, so a deep `<Asset>`/`<AnimatedAsset>`
+ * reads them via {@link useInstanceOverrides} without any prop drilling.
+ */
+declare type InstanceOverrides = {
+    assets?: AssetOverrides;
+    animations?: AnimationOverrides;
+};
+
+declare type LottieAnimationData = {
+    fr: number;
+    v: string;
+    ip: number;
+    op: number;
+    w: number;
+    h: number;
+};
+
 export declare function mapModuleConfig(options: MapModuleConfigOptions): Record<string, unknown>;
 
 /**
@@ -80,6 +157,7 @@ declare type MapModuleConfigOptions = {
     config: Record<string, unknown>;
     workflowId: string;
     authHint?: string;
+    loginHintPrefill?: string;
     lang?: string;
     mergeSessionRecordings?: boolean;
     ageAssurance?: boolean;
@@ -105,6 +183,9 @@ declare type SpinnerConfig = {
 
 declare type SpinnerSize = 'small' | 'medium' | 'large';
 
+/** An SVG imported as a Preact component (the `?react` import shape). */
+declare type SvgComponent = FunctionComponent<SVGProps<SVGSVGElement>>;
+
 declare type TokenWorkflowRuntimeConfig = WorkflowBaseConfig & {
     token: string;
     /**
@@ -140,6 +221,8 @@ declare type WorkflowBaseConfig = {
     isDesktop?: boolean;
     /** Authentication hint for AUTHENTICATION module. Required when workflow includes face authentication. */
     authHint?: string;
+    /** Login-hint prefill forwarded to the DYNAMIC_FORMS module's `prefillValue`. Distinct from `authHint`. */
+    loginHintPrefill?: string;
     onModuleLoading?: (moduleKey: string) => void;
     onModuleLoaded?: (moduleKey: string) => void;
     onUrlUuidRefreshed?: (urlUuid: string) => void;

package/dist/{i18n-CU4xq8qC.js → uiConfig-D7ezQeZ7.js}

@@ -1,5 +1,5 @@
 import { r as __toESM } from "./rolldown-runtime--E5BIlTp.js";
-import { _ as y, d as T, p as d, v as u, x as k, y as K } from "./vendor-preact-DThS2ZQ_.js";
+import { S as k, _ as y, d as T, i as C, p as d, v as u, y as K } from "./vendor-preact-mvwZ8mJj.js";
 //#region ../../node_modules/.pnpm/i18next@25.7.1_typescript@5.9.3/node_modules/i18next/dist/esm/i18next.js
 var isString = (obj) => typeof obj === "string";
 var defer = () => {
@@ -2360,7 +2360,7 @@ if (typeof ActiveXObject === "function") {
 }
 if (typeof fetchApi !== "function") fetchApi = void 0;
 if (!fetchApi && !XmlHttpRequestApi && !ActiveXObjectApi) try {
-	import("./browser-ponyfill-Df13Th-G.js").then((m) => /* @__PURE__ */ __toESM(m.default, 1)).then(function(mod) {
+	import("./browser-ponyfill-CBjGwwPW.js").then((m) => /* @__PURE__ */ __toESM(m.default, 1)).then(function(mod) {
 		fetchApi = mod.default;
 	}).catch(function() {});
 } catch (e) {}
@@ -2968,4 +2968,64 @@ var Trans = ({ i18nKey, boldClass = "IncodeTransBold", arrowClass = "IncodeTrans
 	}) });
 };
 //#endregion
-export { createI18n as a, supportedLanguages as c, setI18nInstance as i, useTranslation as n, readStoredLanguage as o, hasI18nInstance as r, getLanguageEmoji as s, Trans as t };
+//#region src/shared/uiConfig/uiConfig.ts
+/** Tier 1: set by the host via `setup({ uiConfig })` / `setUiConfig`. Wins. */
+var hostUiConfig = {};
+/** Tier 2: derived from the tenant's dashboard theme. Fills the gaps. */
+var themeUiConfig = {};
+/**
+* Cached composition of the two tiers. `useSyncExternalStore` requires
+* `getSnapshot` to return a referentially stable value — composing on every
+* call would hand Preact a new object each time and loop forever — so the
+* merge happens once per write instead.
+*/
+var snapshot = {};
+var listeners = /* @__PURE__ */ new Set();
+function withoutUndefined(value) {
+	const defined = {};
+	for (const key of Object.keys(value)) if (value[key] !== void 0) defined[key] = value[key];
+	return defined;
+}
+/**
+* Host fields win over theme fields; a host field left `undefined` counts as
+* "not specified" and lets the theme through, rather than blanking it.
+*/
+function publish() {
+	snapshot = {
+		...themeUiConfig,
+		...withoutUndefined(hostUiConfig)
+	};
+	for (const listener of listeners) listener();
+}
+function subscribe(listener) {
+	listeners.add(listener);
+	return () => {
+		listeners.delete(listener);
+	};
+}
+function getSnapshot() {
+	return snapshot;
+}
+/**
+* Sets global UI configuration defaults for `@incodetech/ui`.
+*
+* Replaces (does not merge with) the previous host-supplied config, so omitting
+* a field clears it. The dashboard theme is held separately and is unaffected.
+*/
+function setUiConfig(next) {
+	hostUiConfig = next;
+	publish();
+}
+/**
+* Internal: publishes the branding fields derived from the tenant's dashboard
+* theme. Not exported from the package — hosts use {@link setUiConfig}.
+*/
+function setThemeUiConfig(next) {
+	themeUiConfig = next;
+	publish();
+}
+function useUiConfig() {
+	return C(subscribe, getSnapshot);
+}
+//#endregion
+export { useTranslation as a, createI18n as c, supportedLanguages as d, Trans as i, readStoredLanguage as l, setUiConfig as n, hasI18nInstance as o, useUiConfig as r, setI18nInstance as s, setThemeUiConfig as t, getLanguageEmoji as u };