onfido-sdk-ui 14.55.0 → 14.57.0

package/types/capture-api/theming/MediaResources.js

@@ -0,0 +1,26 @@
+export var ResourceType;
+(function (ResourceType) {
+    ResourceType["Icons"] = "icons";
+    ResourceType["Images"] = "images";
+    ResourceType["Animations"] = "animations";
+    ResourceType["Videos"] = "videos";
+})(ResourceType || (ResourceType = {}));
+export var IconTokens;
+(function (IconTokens) {
+    IconTokens["NavigationBack"] = "Navigation.Back";
+    IconTokens["NavigationExit"] = "Navigation.Close";
+})(IconTokens || (IconTokens = {}));
+export var ImageTokens;
+(function (ImageTokens) {
+})(ImageTokens || (ImageTokens = {}));
+export var VideoTokens;
+(function (VideoTokens) {
+})(VideoTokens || (VideoTokens = {}));
+export var AnimationTokens;
+(function (AnimationTokens) {
+})(AnimationTokens || (AnimationTokens = {}));
+export var MediaLocationType;
+(function (MediaLocationType) {
+    MediaLocationType["Local"] = "local";
+    MediaLocationType["Remote"] = "remote";
+})(MediaLocationType || (MediaLocationType = {}));

package/types/capture-api/theming/Theme.d.ts

@@ -0,0 +1,27 @@
+import type { Branding } from './Branding';
+import type { SdkColors } from './ColorTokens';
+import type { MediaResources } from './MediaResources';
+export declare enum ThemeMode {
+    Light = "Light",
+    Dark = "Dark"
+}
+export type Theme = {
+    id?: string;
+    mode?: ThemeMode;
+    branding?: Branding;
+    lightColors?: SdkColors;
+    darkColors?: SdkColors;
+    mediaResources?: MediaResources;
+    /**
+     * @deprecated Internal type: Temporary until fonts are officially supported through the theming API
+     */
+    googleFonts?: string[];
+    /**
+     * @deprecated Internal type: Temporary until fonts are officially supported through the theming API
+     */
+    customFonts?: string[];
+    /**
+     * @deprecated Internal type only
+     */
+    version?: 'v2' | 'v3';
+};

package/types/capture-api/theming/Theme.js

@@ -0,0 +1,5 @@
+export var ThemeMode;
+(function (ThemeMode) {
+    ThemeMode["Light"] = "Light";
+    ThemeMode["Dark"] = "Dark";
+})(ThemeMode || (ThemeMode = {}));

package/types/contract/module/Common.d.ts

@@ -0,0 +1 @@
+export type Empty = Record<string, never>;

package/types/contract/module/DocumentModule.d.ts

@@ -34,6 +34,8 @@ export type DocumentModuleConfiguration = {
     hideCountrySelection?: boolean;
     uploadFallback?: boolean;
     nfcPolicy?: NfcPolicy;
+    allowModuleFinishViaBackend?: boolean;
+    classifyDocument?: boolean;
 };
 export type DocumentModuleInput = {
     preferredUserCountry?: string;
@@ -54,8 +56,11 @@ export type DocumentModuleOutput = {
     issuingCountry: string;
     documentType: string;
     sides: DocumentIds;
-    nfcKey?: string;
-    aaChallenge?: number[];
+    nfc?: {
+        aaChallenge?: number[];
+        can?: string;
+        key: string;
+    };
     documentVersion?: string;
 };
 export type EnabledDocumentType = {

package/types/index.d.ts

@@ -1,3 +1,3 @@
 export * from './Onfido';
 export * from './loader';
-export { Onfido } from './loader';
+export { Onfido, OnfidoApi } from './loader';

package/types/loader.d.ts

@@ -1,15 +1,18 @@
-import type { SdkParameters } from '../../../shared/src/SdkParameters';
-import type { Handle, OnfidoApi } from './Onfido';
+import type { Handle, OnfidoApi as OnfidoBaseApi } from './Onfido'
+import type { SdkParameters } from './shared/SdkParameters'
+
 export type LoaderParameter = {
-    /**
-     * The version of the sdk to be loaded, by default v14 is used, which
-     * is always fresh. Valid examples are 14 (default), 14.x (which pins the version to a minor version
-     * and still accepts hotfixes or 14.x.y which pins it to exactly this version
-     */
-    version?: string;
-};
-export declare const prefixVersion: (version?: string) => string;
-export declare const Onfido: Omit<OnfidoApi, 'init'> & {
-    init: (parameter: SdkParameters & LoaderParameter) => Handle;
-    environment?: 'INSECURE';
-};
+  /**
+   * The version of the sdk to be loaded, by default v14 is used, which
+   * is always fresh. Valid examples are 14 (default), 14.x (which pins the version to a minor version
+   * and still accepts hotfixes or 14.x.y which pins it to exactly this version
+   */
+  version?: string
+}
+
+export type OnfidoApi = Omit<OnfidoBaseApi, 'init'> & {
+  init: (parameter: SdkParameters & LoaderParameter) => Handle
+  environment?: 'INSECURE'
+}
+
+export declare const Onfido: OnfidoApi

package/types/shared/Error.d.ts

@@ -1,4 +1,4 @@
-import { FlowStatesFlowErrorStatesEnum } from '@onfido/sdk-analytics/models/FlowStates';
+import { FlowStatesFlowErrorStatesEnum } from '../analytics/FlowStates';
 import type { Configuration } from './Types';
 export declare enum SdkErrorLevel {
     EXTERNAL = "external",

package/types/shared/Public.types.d.ts

@@ -0,0 +1,47 @@
+import type { CrossDeviceMethod } from './CrossDeviceConnect.types';
+import type { CompleteData, EnterpriseFeatureParameter, ExternalLinkCallback, LegacyLanguageParameter, UserExitCallback } from './SdkParameters';
+import type { CrossDevicePolicy, LegacyStepDefinition, Translations, UserDetails } from './Types';
+import type { ErrorCallback } from './Error';
+export type ThemeConfig = Record<string, any>;
+export type Theme = {
+    name: 'light' | 'dark';
+    config?: ThemeConfig;
+};
+type CommonSdkParameters = {
+    containerEl?: HTMLElement;
+    containerId?: string;
+    onError?: ErrorCallback;
+    onComplete?: (data: CompleteData) => void;
+    showExitButton?: boolean;
+    onUserExit?: UserExitCallback;
+    onExternalLink?: ExternalLinkCallback;
+    enterpriseFeatures?: EnterpriseFeatureParameter;
+    theme?: Theme;
+    customUI?: ThemeConfig;
+    translations?: Translations;
+    language?: string | LegacyLanguageParameter;
+    smsNumberCountryCode?: string;
+    userDetails?: UserDetails;
+    _crossDeviceLinkMethods?: CrossDeviceMethod[];
+    crossDeviceClientIntroProductLogoSrc?: string;
+    crossDevicePolicy?: CrossDevicePolicy;
+    disableAnalytics?: boolean;
+    disableAnalyticsCookies?: boolean;
+};
+export type StudioSdkParameters = {
+    token: string;
+    workflowRunId: string;
+    disableWelcomeScreen?: boolean;
+    disableCompleteScreen?: boolean;
+    onBiometricTokenGenerated?: (customerUserHash: string, biometricToken: string) => void;
+    onBiometricTokenRequested?: (customerUserHash: string) => Promise<string>;
+} & CommonSdkParameters;
+export type ClassicSdkParameters = {
+    token: string;
+    steps: LegacyStepDefinition[];
+} & CommonSdkParameters;
+export type CrossDeviceSdkParameters = CommonSdkParameters & {
+    roomId?: string;
+};
+export type SdkParameters = StudioSdkParameters | ClassicSdkParameters | CrossDeviceSdkParameters;
+export {};

package/types/shared/SdkParameters.d.ts

@@ -1,4 +1,6 @@
-import type { LegacyStepDefinition, LegacyStepType, CrossDevicePolicy, EnterpriseFeatures, LocaleDirection, Theme, ThemeConfig, Translations, UserDetails } from './Types';
+import type { Theme as CaptureTheme } from '../capture-api/theming/Theme';
+import type { Navigation as CaptureNavigation } from '../capture-api';
+import type { LegacyStepDefinition, LegacyStepType, CrossDevicePolicy, EnterpriseFeatures, LocaleDirection, Translations, UserDetails } from './Types';
 import type { ErrorCallback } from './Error';
 import type { CrossDeviceMethod } from './CrossDeviceConnect.types';
 import type { EnterpriseFeatureCallback } from './Enterprise';
@@ -21,10 +23,10 @@ export type CommonSdkParameters = {
     onUserExit?: UserExitCallback;
     onExternalLink?: ExternalLinkCallback;
     enterpriseFeatures?: EnterpriseFeatureParameter;
-    theme?: Theme;
-    customUI?: ThemeConfig;
     language?: string | LegacyLanguageParameter;
     translations?: Translations;
+    theme?: CaptureTheme;
+    navigation?: CaptureNavigation;
 };
 export type LegacyLanguageParameter = {
     locale?: string;
@@ -35,8 +37,6 @@ export type LegacyLanguageParameter = {
 export type TokenParameters = {
     token: string;
     language?: string | LegacyLanguageParameter;
-    translations?: Translations;
-    theme?: Theme;
     /***
      * You can change the default country for the SMS number input by passing the
      * smsNumberCountryCode option when the SDK is initialized. The value should

package/types/shared/Types.d.ts

@@ -1,3 +1,4 @@
+import type { Theme, Navigation } from '../capture-api';
 import type { CrossDeviceMethod } from './CrossDeviceConnect.types';
 import type { FeatureFlags } from './FeatureFlags';
 export type ModuleError = {
@@ -41,11 +42,6 @@ export type TranslationData<T> = T & {
 };
 export type TranslationItem<T> = T | (() => Promise<T>);
 export type Translations<T = unknown> = Record<string, TranslationItem<T>>;
-export type ThemeConfig = Record<string, any>;
-export type Theme = {
-    name: 'light' | 'dark';
-    config?: ThemeConfig;
-};
 export type Optional<T> = undefined | T;
 export type RecursivePartial<T> = {
     [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object | undefined ? RecursivePartial<T[P]> : T[P];
@@ -97,6 +93,7 @@ export type ClientConfiguration = {
     theme?: Theme;
     language?: string;
     translations?: Translations;
+    navigation?: Navigation;
     analytics?: {
         enabled: boolean;
         anonymousUuid: string;
@@ -168,7 +165,7 @@ export type EnterpriseFeatures = {
         darkLogoSrc?: string;
     };
 };
-type TokenEnterpriseFeatures = {
+export type TokenEnterpriseFeatures = {
     cobrand: boolean;
     logoCobrand: boolean;
     hideOnfidoLogo: boolean;