onfido-sdk-ui/types/capture-api/SdkParameters.d.ts

JavaScript SDK view layer for Onfido identity verification

import type { Localisation } from './Localisation.js';
import type { Theme } from './theming/Theme.js';
import type { KnownStep } from './steps/index.js';
import type { CrossDevice } from './CrossDevice.js';
type CommonSdkParameters = {
    sdkToken: string;
    configuration?: Configuration;
};
export type Configuration = {
    disableAnalytics?: boolean;
    theme?: Theme;
    localisation?: Localisation;
    navigation?: Navigation;
};
export type Navigation = {
    navigationBar: NavigationBar;
};
export declare enum NavigationBar {
    BackAndExit = "BackAndExit",
    BackOnly = "BackOnly",
    Hidden = "Hidden"
}
export type SdkParameters = StudioParameters | ClassicParameters;
export type StudioParameters = CommonSdkParameters;
export type ClassicParameters = {
    steps: KnownStep[];
} & CommonSdkParameters;
export type CrossDeviceParameters = CommonSdkParameters & {
    roomId?: string;
};
export type WebSdk = {
    containerEl?: HTMLElement;
    containerId?: string;
    configuration?: Configuration & {
        crossDevice?: CrossDevice;
    };
};
export type Wrapper = never;
export type WebSdkParameters = SdkParameters & WebSdk;
export type WrapperSdkParameters = SdkParameters & Wrapper;
export {};