@incodetech/web 0.0.0-dev-20260313-486e658 → 0.0.0-dev-20260313-bc2dab4

package/dist/types/extensibility.d.ts

@@ -0,0 +1,671 @@
+import { ComponentChildren } from 'preact';
+import { CountryCode } from 'libphonenumber-js';
+import { CSSProperties } from 'preact';
+import { FC } from 'preact/compat';
+import { FunctionalComponent } from 'preact';
+import { HTMLAttributes } from 'preact';
+import { HTMLAttributes as HTMLAttributes_2 } from 'preact/compat';
+import { i18n } from 'i18next';
+import { IdCaptureManager } from '@incodetech/core/id';
+import { IdCaptureState } from '@incodetech/core/id';
+import { InputHTMLAttributes } from 'preact';
+import { JSX } from 'preact';
+import { PermissionStatus as PermissionStatus_2 } from '@incodetech/core';
+import { PropsWithoutRef } from 'preact/compat';
+import { Ref } from 'preact';
+import { SelfieManager } from '@incodetech/core/selfie';
+import { SelfieState } from '@incodetech/core/selfie';
+import { TFunction } from 'i18next';
+import { VNode } from 'preact';
+
+export declare const BaseTutorial: ({ className, animationData, title, titleId, subtitle, onContinue, buttonText, disclaimerText, isLoading, }: BaseTutorialProps) => JSX.Element;
+
+declare type BaseTutorialProps = {
+    className?: string;
+    animationData: LottieAnimationData;
+    title: string;
+    titleId?: string;
+    subtitle: string;
+    onContinue: () => void;
+    buttonText: string;
+    disclaimerText: string;
+    isLoading?: boolean;
+};
+
+export declare const Button: FunctionalComponent<PropsWithoutRef<ButtonProps> & {
+ref?: Ref<HTMLButtonElement> | undefined;
+}>;
+
+declare type ButtonProps = Omit<HTMLAttributes<HTMLButtonElement>, 'class' | 'type' | 'icon'> & {
+    isLoading?: boolean;
+    children?: ComponentChildren;
+    class?: string;
+    type?: 'button' | 'submit' | 'reset';
+    variant?: 'primary' | 'secondary' | 'link';
+    size?: ButtonSize;
+    icon?: ComponentChildren;
+    disabled?: boolean;
+};
+
+declare type ButtonSize = 'L' | 'M' | 'S';
+
+export declare const CalendarIcon: FC<CalendarIconProps>;
+
+declare type CalendarIconProps = {
+    class?: string;
+};
+
+export declare const CameraFrame: FunctionalComponent<PropsWithoutRef<CameraFrameProps> & {
+ref?: Ref<HTMLDivElement> | undefined;
+}>;
+
+declare type CameraFrameProps = {
+    variant: CameraFrameVariant;
+    aspectRatio?: string;
+    orientation?: 'horizontal' | 'vertical';
+    frameState?: CameraFrameState;
+    className?: string;
+    children?: ComponentChildren;
+};
+
+declare type CameraFrameState = 'idle' | 'capturing' | 'error' | 'focus' | 'success' | 'analyzing';
+
+declare type CameraFrameVariant = 'fill' | 'locked';
+
+export declare const CameraIcon: FC<CameraIconProps>;
+
+declare type CameraIconProps = {
+    size?: number | string;
+};
+
+/**
+ * Absolute-positioned flex-column overlay that sits on top of the camera video.
+ *
+ * Expected child order:
+ *  1. (optional) Module-specific header extras (e.g. CaptureNotification)
+ *  2. CameraOverlayHeader
+ *  3. CameraFrame
+ *  4. CaptureFooter
+ */
+export declare const CameraOverlay: FC<CameraOverlayProps>;
+
+export declare const CameraOverlayHeader: FC<CameraOverlayHeaderProps>;
+
+declare type CameraOverlayHeaderProps = {
+    title: string;
+    subtitle?: string;
+    visible?: boolean;
+    className?: string;
+};
+
+declare type CameraOverlayProps = {
+    children: ComponentChildren;
+    className?: string;
+};
+
+export declare const CameraView: FC<CameraViewProps>;
+
+declare type CameraViewProps = {
+    stream: MediaStream | undefined;
+    children: ComponentChildren;
+    videoRef?: Ref<HTMLVideoElement>;
+    className?: string;
+    'data-testid'?: string;
+};
+
+export declare const CaptureButtonIcon: FC<CaptureButtonIconProps>;
+
+declare type CaptureButtonIconProps = {
+    className?: string;
+};
+
+export declare const CaptureFooter: FC<CaptureFooterProps>;
+
+declare type CaptureFooterProps = {
+    onOpenHelp: () => void;
+    onCapture?: () => void;
+    isManualCapture?: boolean;
+    captureAriaLabel?: string;
+    helpAriaLabel?: string;
+    encryptionLabel?: string;
+    children?: ComponentChildren;
+};
+
+declare type CaptureProps = {
+    manager: SelfieManager;
+    state: CaptureState;
+};
+
+declare type CaptureProps_2 = {
+    manager: IdCaptureManager;
+    state: Extract<IdCaptureState, {
+        status: 'capture';
+    }>;
+    onFinish?: () => void;
+};
+
+declare type CaptureState = Extract<SelfieState, {
+    status: 'capture';
+}>;
+
+export declare const Checkbox: FunctionalComponent<PropsWithoutRef<CheckboxProps> & {
+ref?: Ref<HTMLInputElement> | undefined;
+}>;
+
+declare type CheckboxProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'id' | 'class' | 'type' | 'size'> & {
+    id: string;
+    label?: string | ComponentChildren;
+    size?: 's' | 'm';
+    error?: string;
+    helper?: string;
+    showErrorIcon?: boolean;
+    class?: string;
+};
+
+export declare const CheckmarkIcon: FC<CheckmarkIconProps>;
+
+declare type CheckmarkIconProps = {
+    size?: number | string;
+};
+
+export declare const ChevronDown: FC<ChevronDownProps>;
+
+declare type ChevronDownProps = {
+    class?: string;
+};
+
+export declare const ChevronRightIcon: ({ size, class: className, }: ChevronRightIconProps) => JSX.Element;
+
+declare type ChevronRightIconProps = {
+    size?: number;
+    class?: string;
+};
+
+declare type ChooserProps = {
+    manager: IdCaptureManager;
+};
+
+declare type CloseButtonOptions = {
+    show?: boolean;
+    onClose?: () => void;
+    position?: 'left' | 'right';
+    offset?: string;
+    onCancel?: () => void;
+    color?: string;
+};
+
+declare type CloseButtonOptions_2 = {
+    show?: boolean;
+    onClose?: () => void;
+};
+
+export declare const CloseIcon: FC<CloseIconProps>;
+
+declare type CloseIconProps = {
+    width?: number | string;
+    height?: number | string;
+    class?: string;
+    fillColor?: string;
+};
+
+export declare const countries: CountryData[];
+
+declare type CountryData = {
+    code: CountryCode;
+    emoji: string;
+    name: string;
+    callingCode: string;
+};
+
+export declare const DateInputComposed: FunctionalComponent<PropsWithoutRef<DateInputComposedProps> & {
+ref?: Ref<HTMLInputElement> | undefined;
+}>;
+
+declare type DateInputComposedProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'type' | 'class'> & {
+    id: string;
+    label?: string;
+    value: string;
+    onInput: (e: Event) => void;
+    error?: string;
+    helper?: string;
+    showErrorIcon?: boolean;
+    showHelperIcon?: boolean;
+    suppressMessages?: boolean;
+    class?: string;
+    'data-testid'?: string;
+};
+
+export declare const DropdownComposed: FC<DropdownComposedProps>;
+
+declare type DropdownComposedProps = {
+    id: string;
+    label?: string;
+    placeholder?: string;
+    value: string;
+    options: DropdownOption[];
+    onChange: (value: string) => void;
+    error?: string;
+    helper?: string;
+    showErrorIcon?: boolean;
+    showHelperIcon?: boolean;
+    suppressMessages?: boolean;
+    disabled?: boolean;
+    required?: boolean;
+    searchable?: boolean;
+    searchPlaceholder?: string;
+    noResultsText?: string;
+    name?: string;
+    tabIndex?: number;
+    onKeyDown?: (e: KeyboardEvent) => void;
+    onBlur?: () => void;
+    renderSelectedLabel?: (option: DropdownOption) => string;
+    siblingElement?: ComponentChildren;
+    enterKeyHint?: 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send';
+    class?: string;
+    'data-testid'?: string;
+};
+
+declare type DropdownOption = {
+    value: string;
+    label: string;
+};
+
+export declare const ErrorContent: ({ title, description, attemptsRemaining, onButtonClick, "data-testid": testId, }: ErrorContentProps) => JSX.Element;
+
+declare type ErrorContentProps = {
+    title: string;
+    description: string;
+    attemptsRemaining: number;
+    onButtonClick: () => void;
+    'data-testid'?: string;
+};
+
+export declare const ErrorIcon: FC<ErrorIconProps>;
+
+declare type ErrorIconProps = {
+    size?: number | string;
+};
+
+export declare const FileIcon: FC<FileIconProps>;
+
+declare type FileIconProps = {
+    size?: number | string;
+};
+
+declare type FlipAnimationProps = {
+    manager: IdCaptureManager;
+    direction: 'toBack' | 'toFront';
+};
+
+export declare const FormField: FC<FormFieldProps>;
+
+declare type FormFieldProps = {
+    name: string;
+    label: string;
+    value?: string;
+    error?: string;
+    errorParams?: Record<string, string | number>;
+    type?: string;
+    placeholder?: string;
+    placeholderParams?: Record<string, string>;
+    required?: boolean;
+    readonly?: boolean;
+    maxLength?: number;
+    disabled?: boolean;
+    optional?: boolean;
+    onChange: (name: string, value: string) => void;
+};
+
+export declare function getCountryByCallingCode(callingCode: string): CountryData | undefined;
+
+export declare function getCountryByCode(code: string | undefined): CountryData | undefined;
+
+export declare const HelpIcon: FC<HelpIconProps>;
+
+declare type HelpIconProps = {
+    className?: string;
+};
+
+export declare const IdCapture: FC<CaptureProps_2>;
+
+export declare const IdChooser: FC<ChooserProps>;
+
+export declare const IdError: FC<IdErrorProps>;
+
+declare type IdErrorProps = {
+    manager: IdCaptureManager;
+    state: Extract<IdCaptureState, {
+        status: 'error';
+    }>;
+    onError?: (error: string | undefined) => void;
+} | {
+    manager: IdCaptureManager;
+    state: Extract<IdCaptureState, {
+        status: 'capture';
+    }>;
+};
+
+export declare const IdExpired: FC<IdExpiredProps>;
+
+declare type IdExpiredProps = {
+    manager: IdCaptureManager;
+};
+
+export declare const IdFlipAnimation: FC<FlipAnimationProps>;
+
+export declare const IdTutorial: FC<TutorialProps_2>;
+
+/**
+ * Wraps UI modules with the standard container.
+ * Shows a landscape blocker overlay on mobile (excluding iPad) when device is rotated to landscape.
+ */
+export declare function IncodeComponent({ children }: IncodeComponentProps): VNode;
+
+declare type IncodeComponentProps = {
+    children?: ComponentChildren;
+};
+
+export 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.
+     */
+    onError?: (error: string | undefined) => void;
+};
+
+declare type InferState<T> = T extends {
+    getState: () => infer S;
+} ? S : never;
+
+export declare const Input: FunctionalComponent<PropsWithoutRef<InputProps> & {
+ref?: Ref<HTMLInputElement> | undefined;
+}>;
+
+export declare const InputComposed: FunctionalComponent<PropsWithoutRef<InputComposedProps> & {
+ref?: Ref<HTMLInputElement> | undefined;
+}>;
+
+declare type InputComposedProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'id' | 'class'> & {
+    id: string;
+    label?: string;
+    error?: string;
+    helper?: string;
+    showErrorIcon?: boolean;
+    showHelperIcon?: boolean;
+    closeButton?: CloseButtonOptions_2;
+    suppressMessages?: boolean;
+    class?: string;
+};
+
+declare type InputProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'class' | 'type'> & {
+    class?: string;
+    type?: string;
+    'data-has-value'?: boolean;
+};
+
+export declare function LandscapeBlocker(): VNode | null;
+
+export declare const LockIcon: FC<LockIconProps>;
+
+declare type LockIconProps = {
+    className?: string;
+};
+
+export declare function Lottie({ animationData, loop, autoplay, style, className, onComplete, }: LottieProps): JSX.Element;
+
+declare type LottieAnimationData = {
+    fr: number;
+    v: string;
+    ip: number;
+    op: number;
+    w: number;
+    h: number;
+};
+
+declare type LottieProps = {
+    animationData: LottieAnimationData;
+    loop?: boolean;
+    autoplay?: boolean;
+    style?: CSSProperties;
+    className?: string;
+    onComplete?: () => void;
+};
+
+export declare const ManualCapture: FC<ManualCaptureProps>;
+
+declare type ManualCaptureProps = {
+    stream: MediaStream;
+    onCapture: (imageBase64: string) => void;
+    disabled?: boolean;
+};
+
+export declare const Modal: FC<ModalProps>;
+
+declare type ModalProps = {
+    children: ComponentChildren;
+    'aria-labelledby'?: string;
+    class?: string;
+};
+
+export declare const OtpInput: FC<OtpInputProps>;
+
+declare type OtpInputProps = {
+    resendTimer: number;
+    canResend: boolean;
+    error?: string;
+    onSubmit: (code: string) => void;
+    onResend: () => void;
+    onBack: () => void;
+    /**
+     * Custom text for the back link (e.g., "change email address").
+     * Defaults to "change phone number" if not provided.
+     */
+    backLinkText?: string;
+    /** Whether the inputs and buttons should be disabled */
+    disabled?: boolean;
+    /** Whether the submit button should show loading state */
+    isLoading?: boolean;
+};
+
+export declare const Page: ({ title, titleId, subtitle, className, logo, children, hideHeader, hideFooterBranding, "data-testid": dataTestId, "data-permission-status": dataPermissionStatus, }: PageProps) => JSX.Element;
+
+declare type PageProps = {
+    children?: ComponentChildren;
+    title?: string;
+    titleId?: string;
+    subtitle?: string;
+    className?: string;
+    logo?: {
+        src?: string;
+        height?: string;
+    };
+    hideFooterBranding?: boolean;
+    hideHeader?: boolean;
+    closeButton?: CloseButtonOptions;
+    'data-testid'?: string;
+    'data-permission-status'?: string;
+};
+
+declare const Permissions_2: FC<PermissionsProps>;
+export { Permissions_2 as Permissions }
+
+declare type PermissionsManager = {
+    requestPermission: () => void;
+    goToLearnMore: () => void;
+    close: () => void;
+};
+
+declare type PermissionsProps = {
+    manager: PermissionsManager;
+    permissionStatus: PermissionStatus_2;
+};
+
+export declare const PhoneInputComposed: FC<PhoneInputComposedProps>;
+
+declare type PhoneInputComposedProps = {
+    id: string;
+    label?: string;
+    countryCode?: string;
+    value?: string;
+    placeholder?: string;
+    error?: string;
+    disabled?: boolean;
+    disableCountrySelector?: boolean;
+    required?: boolean;
+    onChange?: (fullNumber: string, isValid: boolean) => void;
+    'data-testid'?: string;
+};
+
+export declare const Processing: FC;
+
+export declare const ProgressBar: FC<ProgressBarProps>;
+
+declare type ProgressBarProps = {
+    progress: number;
+    label?: string;
+    className?: string;
+};
+
+export declare const SearchIcon: FC<SearchIconProps>;
+
+declare type SearchIconProps = {
+    size?: number | string;
+};
+
+export declare const SelfieCapture: FC<CaptureProps>;
+
+export declare const SelfieTutorial: ({ manager }: TutorialProps) => JSX.Element | null;
+
+/**
+ * Sets global UI configuration defaults for `@incodetech/ui`.
+ */
+export declare function setUiConfig(next: UiConfig): void;
+
+export declare const Spacer: ({ size, className, direction, }: SpacerProps) => JSX.Element;
+
+declare type SpacerProps = {
+    size?: number | string;
+    direction?: 'horizontal' | 'vertical';
+    className?: string;
+};
+
+export declare const Spinner: FC<SpinnerProps>;
+
+declare type SpinnerProps = {
+    /** Title text to display below the spinner */
+    title?: string;
+    /** Subtitle text to display below the title */
+    subtitle?: string;
+    /** Size of the spinner icon */
+    size?: SpinnerSize;
+    /** Whether to display as full-screen overlay */
+    fullScreen?: boolean;
+    /** Additional CSS class name */
+    className?: string;
+};
+
+export declare type SpinnerSize = 'small' | 'medium' | 'large';
+
+export declare const SuccessIcon: FC<SuccessIconProps>;
+
+declare type SuccessIconProps = {
+    size?: number | string;
+};
+
+export declare const Title: FunctionalComponent<PropsWithoutRef<TitleProps> & {
+ref?: Ref<HTMLHeadingElement> | undefined;
+}>;
+
+declare type TitleProps = HTMLAttributes_2<HTMLHeadingElement> & {
+    children: ComponentChildren;
+    className?: string;
+};
+
+declare type TutorialProps = {
+    manager: SelfieManager;
+};
+
+declare type TutorialProps_2 = {
+    manager: IdCaptureManager;
+    state: Extract<IdCaptureState, {
+        status: 'tutorial';
+    }>;
+};
+
+export declare const TypographyH1: FC<TitleProps>;
+
+export declare const TypographyH3: FC<TitleProps>;
+
+export declare const TypographyH4: FC<TitleProps>;
+
+export declare const TypographyH5: FC<TitleProps>;
+
+export declare type UiConfig = {
+    logoSrc?: string;
+    logoHeight?: string;
+    hideHeader?: boolean;
+    hideFooterBranding?: boolean;
+};
+
+/**
+ * Hook for subscribing to manager state updates
+ * @param factory - Factory function that creates the manager instance
+ * @param options - Configuration options
+ * @returns Tuple of [state, manager]
+ */
+export declare function useManager<TManager extends {
+    getState: () => TState;
+    subscribe: (listener: (state: TState) => void) => () => void;
+    load?: () => void;
+    stop?: () => void;
+}, TState = InferState<TManager>>(factory: () => TManager, options?: UseManagerOptions): [TState, TManager];
+
+declare type UseManagerOptions = {
+    autoLoad?: boolean;
+    manageLifecycle?: boolean;
+};
+
+/**
+ * Hook that returns whether the device is in landscape mode on mobile (excluding iPad and desktop).
+ * Use this to show a landscape blocker overlay when true.
+ */
+export declare function useScreenOrientation(): {
+    isLandscapeMobile: boolean;
+};
+
+export declare function useTranslation(): UseTranslationReturn;
+
+declare type UseTranslationReturn = {
+    t: TFunction;
+    ready: boolean;
+    i18n: i18n;
+};
+
+export declare const VerificationResult: FC<VerificationResultProps>;
+
+declare type VerificationResultProps = {
+    status: 'submitting' | 'success' | 'failure';
+    submittingTitle?: string;
+    successTitle?: string;
+    failureTitle?: string;
+    errorMessage?: string;
+    onRetry?: () => void;
+    onSkip?: () => void;
+    retryLabel?: string;
+    skipLabel?: string;
+};
+
+export { }

package/dist/types/flow.d.ts

@@ -19,12 +19,16 @@ export declare const IncodeFlow: FC<IncodeFlowProps>;
 
 declare type IncodeFlowProps = IncodeModuleProps<FlowConfig, FinishStatus>;
 
-declare type IncodeModuleProps<TConfig, TResult = void> = {
+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

package/dist/types/geolocation.d.ts

@@ -6,12 +6,16 @@ export { Geolocation_2 as Geolocation }
 
 declare type GeolocationProps = IncodeModuleProps<GeolocationConfig>;
 
-declare type IncodeModuleProps<TConfig, TResult = void> = {
+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