@incodetech/web 2.1.1 → 2.2.0-rc.0

package/dist/types/email.d.ts

@@ -1,31 +1,63 @@
+import { DeepPartial } from '@incodetech/core/flow';
 import { EmailConfig } from '@incodetech/core/email';
 import { EmailManager } from '@incodetech/core/email';
 import { FC } from 'preact/compat';
+import { FunctionComponent } from 'preact';
+import { SVGProps } from 'preact/compat';
 
 /**
- * Email verification UI component.
- *
- * Provides a complete email verification experience including:
- * - Email address input with validation
- * - OTP code entry with resend functionality
- * - Loading states and error handling
+ * 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.
  *
- * @example Basic usage
- * ```tsx
- * <Email
- *   config={{
- *     otpVerification: true,
- *     otpExpirationInMinutes: 5,
- *     prefill: false,
- *   }}
- *   onFinish={() => router.push('/next-step')}
- *   onError={(err) => toast.error(err)}
- * />
- * ```
+ * - `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.
  *
- * @see {@link createEmailManager} for headless usage
+ * - `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.
  */
-export declare const Email: FC<EmailProps>;
+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;
+
+export declare const Email: FC<Omit<EmailProps, "config"> & {
+    config?: (Omit<unknown, never> & DeepPartial<Pick<unknown, never>>) | undefined;
+}>;
 
 /**
  * Props for the Email component
@@ -52,12 +84,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.
      */
@@ -83,6 +119,30 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
     onError?: (error: string | undefined, errorCode?: number, moduleErrorCode?: string) => void;
 };
 
+/**
+ * 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 global {

package/dist/types/extensibility.d.ts

@@ -3,6 +3,7 @@ import { CountryCode } from 'libphonenumber-js';
 import { CSSProperties } from 'preact';
 import { FC } from 'preact/compat';
 import { FunctionalComponent } from 'preact';
+import { FunctionComponent } from 'preact';
 import { HTMLAttributes } from 'preact';
 import { HTMLAttributes as HTMLAttributes_2 } from 'preact/compat';
 import { i18n } from 'i18next';
@@ -15,13 +16,58 @@ import { PermissionStatus as PermissionStatus_2 } from '@incodetech/core/camera'
 import { PropsWithoutRef } from 'preact/compat';
 import { Ref } from 'preact';
 import { RefObject } from 'preact';
+import { RefObject as RefObject_2 } from 'preact/compat';
 import { SelfieManager } from '@incodetech/core/selfie';
 import { SelfieState } from '@incodetech/core/selfie';
+import { SVGProps } from 'preact/compat';
 import { TargetedEvent } from 'preact';
 import { TFunction } from 'i18next';
 import { VNode } from 'preact';
 
-export declare const BaseTutorial: ({ className, animationData, title, titleId, subtitle, onContinue, buttonText, disclaimerText, isLoading, stopFramePosition, }: BaseTutorialProps) => JSX.Element;
+/**
+ * Allowlisted keys for overridable Lottie animations
+ */
+export 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.
+ */
+export declare type AnimationOverride = LottieAnimationData | {
+    url: string;
+} | {
+    animationData: LottieAnimationData;
+};
+
+export declare type AnimationOverrides = Partial<Record<AnimationKey, AnimationOverride>>;
+
+/**
+ * Allowlisted keys for overridable branded SVG illustrations
+ */
+export 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.
+ */
+export declare type AssetOverride = string | {
+    url: string;
+} | {
+    raw: string;
+} | {
+    svg: SvgComponent;
+};
+
+export declare type AssetOverrides = Partial<Record<AssetKey, AssetOverride>>;
+
+export declare const BaseTutorial: ({ className, animationData, title, titleId, subtitle, onContinue, buttonText, disclaimerText, isLoading, stopFramePosition, recolor, }: BaseTutorialProps) => JSX.Element;
 
 declare type BaseTutorialProps = {
     className?: string;
@@ -34,6 +80,12 @@ declare type BaseTutorialProps = {
     disclaimerText: string;
     isLoading?: boolean;
     stopFramePosition?: 'first' | 'middle' | 'last';
+    /**
+     * Re-tint the animation's brand-colored elements to the active branding
+     * color. On for built-in animations; pass `false` for customer overrides so
+     * their artwork is rendered as-authored (no recoloring).
+     */
+    recolor?: boolean;
 };
 
 export declare const BottomSheet: FC<BottomSheetProps>;
@@ -43,6 +95,7 @@ declare type BottomSheetProps = {
     onClose?: () => void;
     labelledById: string;
     children: ComponentChildren;
+    returnFocusRef?: RefObject<HTMLElement | null>;
 };
 
 export declare const Button: FunctionalComponent<PropsWithoutRef<ButtonProps> & {
@@ -110,6 +163,7 @@ declare type CameraOverlayHeaderProps = {
     visible?: boolean;
     className?: string;
     titleId?: string;
+    titleRef?: RefObject_2<HTMLHeadingElement>;
 };
 
 declare type CameraOverlayProps = {
@@ -148,6 +202,13 @@ declare type CaptureFooterProps = {
     captureButtonRef?: Ref<HTMLButtonElement>;
     encryptionLabel?: string;
     children?: ComponentChildren;
+    /**
+     * Hides the help button and the manual-capture button/section, keeping
+     * only the encryption label — for surfaces where there's nothing left
+     * for the user to act on (e.g. the `uxp_idc_exp05_show_result` live
+     * post-capture overlay while the upload is in flight).
+     */
+    hideActions?: boolean;
 };
 
 declare type CaptureProps = {
@@ -158,7 +219,6 @@ declare type CaptureProps = {
 declare type CaptureProps_2 = {
     manager: IdCaptureManager;
     state: CaptureState_2;
-    onFinish?: () => void;
 };
 
 declare type CaptureState = Extract<SelfieState, {
@@ -258,6 +318,35 @@ declare type CloseIconProps = {
     fillColor?: 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;
+
+/**
+ * Full-screen "no internet connection" state, shown whenever a backend request
+ * fails due to lost connectivity. Flow-agnostic and cross-cutting — any module
+ * can render it on a connectivity failure — so it lives in `shared/` rather
+ * than inside a single module. Composes the shared `StatusPage` primitive
+ * (icon + title + subtitle + actions) so it stays visually consistent with the
+ * rest of the status/result screens. Copy defaults to the shared
+ * `connectionError.*` namespace and can be overridden per caller.
+ */
+export declare const ConnectionError: FC<ConnectionErrorProps>;
+
+declare type ConnectionErrorProps = {
+    /** Invoked by the primary action. Typically `() => window.location.reload()`. */
+    onRefresh: () => void;
+    /** Overrides the default connectivity title copy. */
+    title?: string;
+    /** Overrides the default connectivity subtitle copy. */
+    subtitle?: string;
+    /** Overrides the default refresh button label. */
+    refreshLabel?: string;
+};
+
 export declare const countries: CountryData[];
 
 declare type CountryData = {
@@ -314,6 +403,12 @@ declare type DropdownOption = {
     ariaLabel?: string;
 };
 
+export declare const EllipseIcon: FC<EllipseIconProps>;
+
+declare type EllipseIconProps = {
+    size?: number | string;
+};
+
 export declare const ErrorContent: ({ title, description, attemptsRemaining, onButtonClick, "data-testid": testId, }: ErrorContentProps) => JSX.Element;
 
 declare type ErrorContentProps = {
@@ -330,6 +425,18 @@ declare type ErrorIconProps = {
     size?: number | string;
 };
 
+export declare const EyeIcon: FC<EyeIconProps>;
+
+declare type EyeIconProps = {
+    size?: number | string;
+};
+
+export declare const EyeOffIcon: FC<EyeOffIconProps>;
+
+declare type EyeOffIconProps = {
+    size?: number | string;
+};
+
 export declare const FileIcon: FC<FileIconProps>;
 
 declare type FileIconProps = {
@@ -357,6 +464,7 @@ declare type FormFieldProps = {
     readonly?: boolean;
     maxLength?: number;
     disabled?: boolean;
+    autoComplete?: string;
     /**
      * Pre-translated text rendered next to the label (e.g. "(optional)").
      * Forms derive this via the majority rule (`getRequiredHintMode` +
@@ -453,12 +561,16 @@ declare type IncodeFinishMeta = {
     sdkOwnsTerminalScreen?: boolean;
 };
 
-export declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
+export 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.
      */
@@ -501,6 +613,7 @@ declare type InputComposedProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'i
     label?: string;
     labelHint?: string;
     error?: string;
+    invalid?: boolean;
     helper?: string;
     showErrorIcon?: boolean;
     showHelperIcon?: boolean;
@@ -516,6 +629,18 @@ declare type InputProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'class' |
     'data-has-value'?: boolean;
 };
 
+/**
+ * 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;
+};
+
 export declare function LandscapeBlocker(): VNode | null;
 
 export { LightningIcon }
@@ -704,6 +829,26 @@ declare type PageProps = {
     'data-permission-status'?: string;
 };
 
+export declare const PasswordInputComposed: FunctionalComponent<PropsWithoutRef<PasswordInputComposedProps> & {
+ref?: Ref<HTMLInputElement> | undefined;
+}>;
+
+export declare type PasswordInputComposedProps = Omit<InputComposedProps, 'type' | 'closeButton' | 'rightIcon'> & {
+    showPasswordAriaLabel: string;
+    hidePasswordAriaLabel: string;
+    defaultVisible?: boolean;
+    requirementsHeading?: string;
+    requirements?: PasswordRequirement[];
+    requirementMetLabel?: string;
+    requirementUnmetLabel?: string;
+};
+
+export declare type PasswordRequirement = {
+    key: string;
+    label: string;
+    met: boolean;
+};
+
 declare const Permissions_2: FC<PermissionsProps>;
 export { Permissions_2 as Permissions }
 
@@ -785,10 +930,10 @@ declare type RadioButtonComposedProps = Omit<InputHTMLAttributes<HTMLInputElemen
     helper?: string;
     showErrorIcon?: boolean;
     class?: string;
+    textSize?: TextSize;
     'aria-label'?: string;
     'aria-labelledby'?: string;
     'aria-describedby'?: string;
-    'aria-invalid'?: boolean;
 };
 
 export declare const RadioGroupComposed: FunctionalComponent<PropsWithoutRef<RadioGroupComposedProps> & {
@@ -894,6 +1039,9 @@ declare type SuccessIconProps = {
     size?: number | string;
 };
 
+/** An SVG imported as a Preact component (the `?react` import shape). */
+export declare type SvgComponent = FunctionComponent<SVGProps<SVGSVGElement>>;
+
 export declare const TextArea: FunctionalComponent<PropsWithoutRef<TextAreaProps> & {
 ref?: Ref<HTMLTextAreaElement> | undefined;
 }>;
@@ -918,6 +1066,8 @@ declare type TextAreaProps = Omit<JSX.IntrinsicElements['textarea'], 'class'> &
     class?: string;
 };
 
+declare type TextSize = 'M' | 'S';
+
 export declare const Title: FunctionalComponent<PropsWithoutRef<TitleProps> & {
 ref?: Ref<HTMLHeadingElement> | undefined;
 }>;
@@ -962,6 +1112,8 @@ export declare type UiConfig = {
     subtitle?: string;
     hideHeader?: boolean;
     hideFooterBranding?: boolean;
+    assets?: AssetOverrides;
+    animations?: AnimationOverrides;
 };
 
 /**

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

@@ -1,34 +1,68 @@
+import { DeepPartial } from '@incodetech/core/flow';
 import { FaceMatchConfig } from '@incodetech/core/face-match';
+import { FaceMatchManager } from '@incodetech/core/face-match';
 import { FC } from 'preact/compat';
+import { FunctionComponent } from 'preact';
+import { SVGProps } 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
+ * 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.
  *
- * @example Basic usage
- * ```tsx
- * <FaceMatch
- *   config={{
- *     variant: 'selfieVsId',
- *     disableFaceMatchAnimation: false,
- *   }}
- *   onFinish={() => router.push('/next-step')}
- *   onError={(err) => toast.error(err)}
- * />
- * ```
+ * - `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.
  *
- * @see {@link createFaceMatchManager} for headless usage
+ * - `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.
  */
-export declare const FaceMatch: FC<FaceMatchProps>;
+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;
+
+export declare const FaceMatch: FC<Omit<FaceMatchProps, "config"> & {
+    config?: (Omit<unknown, never> & DeepPartial<Pick<unknown, never>>) | undefined;
+}>;
 
 /**
  * Props for the FaceMatch component
  */
-declare type FaceMatchProps = IncodeModuleProps<FaceMatchConfig>;
+declare type FaceMatchProps = IncodeModuleProps<FaceMatchConfig, void, FaceMatchManager>;
 
 /**
  * Extra context passed to `onFinish` alongside the result. Lets a host decide
@@ -50,12 +84,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.
      */
@@ -81,4 +119,28 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
     onError?: (error: string | undefined, errorCode?: number, moduleErrorCode?: string) => void;
 };
 
+/**
+ * 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 { }

package/dist/types/field-comparison.d.ts

@@ -1,8 +1,63 @@
+import { DeepPartial } from '@incodetech/core/flow';
 import { FC } from 'preact/compat';
 import { FieldComparisonConfig } from '@incodetech/core/field-comparison';
 import { FieldComparisonManager } from '@incodetech/core/field-comparison';
+import { FunctionComponent } from 'preact';
+import { SVGProps } from 'preact/compat';
 
-export declare const FieldComparison: FC<FieldComparisonProps>;
+/**
+ * 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;
+
+export declare const FieldComparison: FC<Omit<FieldComparisonProps, "config"> & {
+    config?: (Omit<unknown, never> & DeepPartial<Pick<unknown, never>>) | undefined;
+}>;
 
 declare type FieldComparisonProps = IncodeModuleProps<FieldComparisonConfig, void, FieldComparisonManager>;
 
@@ -26,12 +81,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.
      */
@@ -57,4 +116,28 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
     onError?: (error: string | undefined, errorCode?: number, moduleErrorCode?: string) => void;
 };
 
+/**
+ * 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 { }