onfido-sdk-ui 14.56.0 → 14.58.0

package/LICENSE

@@ -9,6 +9,14 @@ at https://documentation.onfido.com/sdk/sdk-licenses/.
 
 ------------------
 
+Name: @onfido/capture-api
+Version: 0.0.0-master.2187611
+License: null
+Private: false
+Repository: git@gitlab.eu-west-1.mgmt.onfido.xyz:onfido/sdks/capture-api.git
+
+---
+
 Name: @onfido/capture-shared
 Version: 2.24.9
 License: null
@@ -243,6 +251,13 @@ SOFTWARE.
 
 ---
 
+Name: capture-module
+Version: 3.13.0
+License: null
+Private: false
+
+---
+
 Name: js-cookie
 Version: 3.0.5
 License: MIT
@@ -278,7 +293,7 @@ SOFTWARE.
 ---
 
 Name: @onfido/capture-contract
-Version: 0.0.0-master.2089493
+Version: 0.0.0-master.2163212
 License: null
 Private: false
 Description: Contracts for the SDKs and modules

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onfido-sdk-ui",
-  "version": "14.56.0",
+  "version": "14.58.0",
   "description": "JavaScript SDK view layer for Onfido identity verification",
   "author": "Onfido Customer Support <support@onfido.com> (https://documentation.onfido.com/sdk/web/)",
   "repository": {
@@ -9,7 +9,7 @@
   },
   "license": "SEE LICENSE in LICENSE",
   "main": "Onfido.js",
-  "types": "types/loader.d.ts",
+  "types": "types/index.d.ts",
   "files": [
     "Onfido.js",
     "types"

package/types/Events.d.ts

@@ -1,7 +1,7 @@
-import type { CaptureModule } from '../../../shared/src/Types';
-import type { SdkError } from '../../../shared/src/Error';
-import type { Event } from '../../../shared/src/EventEmitter';
-import type { CompleteData } from '../../../shared/src/SdkParameters';
+import type { CaptureModule } from './shared/Types';
+import type { SdkError } from './shared/Error';
+import type { Event } from './shared/EventEmitter';
+import type { CompleteData } from './shared/SdkParameters';
 export type ModuleEvent<T extends string> = {
     module: CaptureModule;
     id: string;

package/types/Onfido.d.ts

@@ -1,13 +1,16 @@
 import type { CaptureRunEvents } from './Events';
-import { ClassicSdkParameters } from '../../../shared/src/SdkParameters';
-import type { Listener } from '../../../shared/src/EventEmitter';
-import { SdkParameters } from '../../../shared/src/SdkParameters';
-import { StudioSdkParameters } from '../../../shared/src/SdkParameters';
+import { ClassicSdkParameters } from './shared/Public.types';
+import { CrossDeviceSdkParameters } from './shared/Public.types';
+import type { Listener } from './shared/EventEmitter';
+import { SdkParameters } from './shared/Public.types';
+import { StudioSdkParameters } from './shared/Public.types';
 
 export declare const backwardCompatibility: (parameter: SdkParameters) => SdkParameters;
 
 export { ClassicSdkParameters }
 
+export { CrossDeviceSdkParameters }
+
 export declare type Handle = {
     addEventListener: <EventName extends keyof CaptureRunEvents>(eventName: EventName, listener: Listener<CaptureRunEvents[EventName]>) => void;
     removeEventListener: <EventName extends keyof CaptureRunEvents>(eventName: EventName, listener: Listener<CaptureRunEvents[EventName]>) => void;

package/types/analytics/FlowStates.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Onfido SDK Analytics
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version:
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class FlowStates {
+  'flowErrorStates'?: FlowStatesFlowErrorStatesEnum
+  'flowExitStates'?: FlowStatesFlowExitStatesEnum
+  'flowInactiveReasons'?: FlowStatesFlowInactiveReasonsEnum
+  'flowResumedReasons'?: FlowStatesFlowResumedReasonsEnum
+  constructor(props: {
+    flowErrorStates?: FlowStatesFlowErrorStatesEnum
+    flowExitStates?: FlowStatesFlowExitStatesEnum
+    flowInactiveReasons?: FlowStatesFlowInactiveReasonsEnum
+    flowResumedReasons?: FlowStatesFlowResumedReasonsEnum
+  })
+}
+export declare enum FlowStatesFlowErrorStatesEnum {
+  MicrophonePermissionDenied = 'MicrophonePermissionDenied',
+  CameraPermissionDenied = 'CameraPermissionDenied',
+  PermissionsUnavailable = 'PermissionsUnavailable',
+  CameraNotDetected = 'CameraNotDetected',
+  CameraException = 'CameraException',
+  FailedToWriteToDisk = 'FailedToWriteToDisk',
+  InvalidImageData = 'InvalidImageData',
+  WorkflowTaskAbandoned = 'WorkflowTaskAbandoned',
+  WorkflowTaskError = 'WorkflowTaskError',
+  BiometricTokenRetrievalException = 'BiometricTokenRetrievalException',
+  WorkflowBiometricTokenStorageException = 'WorkflowBiometricTokenStorageException',
+  CrossDeviceRestartError = 'CrossDeviceRestartError',
+  CrossDeviceDesktopError = 'CrossDeviceDesktopError',
+  CrossDeviceVerificationInvalidError = 'CrossDeviceVerificationInvalidError',
+  CrossDeviceVerificationAbortError = 'CrossDeviceVerificationAbortError',
+  InvalidToken = 'InvalidToken',
+  ExpiredToken = 'ExpiredToken',
+  ExpiredTrial = 'ExpiredTrial',
+  NetworkException = 'NetworkException',
+  UploadError = 'UploadError',
+  InitialisationInvalid = 'InitialisationInvalid',
+  SdkVersionInsufficient = 'SdkVersionInsufficient',
+  UnsupportedError = 'UnsupportedError',
+  UnsupportedFeatureError = 'UnsupportedFeatureError',
+  InvalidSdkParameter = 'InvalidSdkParameter',
+  FeaturesNotAuthorized = 'FeaturesNotAuthorized',
+  MissingSteps = 'MissingSteps',
+  DuplicateStep = 'DuplicateStep',
+  WelcomeMustBeFirstStep = 'WelcomeMustBeFirstStep',
+  WorkflowVersionMismatch = 'WorkflowVersionMismatch',
+  WorkflowInputError = 'WorkflowInputError',
+  MissingLogoCobrandingParameter = 'MissingLogoCobrandingParameter',
+  InvalidCustomTranslations = 'InvalidCustomTranslations',
+  InvalidCountryCode = 'InvalidCountryCode',
+  InvalidDocumentFormatAndCountryCombination = 'InvalidDocumentFormatAndCountryCombination',
+  InvalidDocumentTypeException = 'InvalidDocumentTypeException',
+  InvalidDocumentTitle = 'InvalidDocumentTitle',
+  DuplicateGenericDocument = 'DuplicateGenericDocument',
+  NfcInputNotAvailable = 'NfcInputNotAvailable',
+  AppTerminated = 'AppTerminated',
+  GenericException = 'GenericException',
+  GeoBlocked = 'GeoBlocked',
+  ModuleLoadError = 'ModuleLoadError',
+}
+export declare enum FlowStatesFlowExitStatesEnum {
+  UserExit = 'UserExit',
+  ConsentDenied = 'ConsentDenied',
+  RequiredNfcNotCompleted = 'RequiredNfcNotCompleted',
+}
+export declare enum FlowStatesFlowInactiveReasonsEnum {
+  AppInBackground = 'AppInBackground',
+  AppInactive = 'AppInactive',
+}
+export declare enum FlowStatesFlowResumedReasonsEnum {
+  AppBackInForeground = 'AppBackInForeground',
+  AppBackToActive = 'AppBackToActive',
+}

package/types/capture-api/CrossDevice.d.ts

@@ -0,0 +1,21 @@
+export declare enum CrossDeviceMethod {
+    CopyLink = "copy_link",
+    QrCode = "qr_code",
+    Sms = "sms"
+}
+export declare enum CrossDevicePolicy {
+    Enable = "enable",
+    Disable = "disable",
+    Force = "force"
+}
+export type CrossDevice = {
+    methods?: CrossDeviceMethod[];
+    policy?: CrossDevicePolicy;
+    sms?: {
+        countryCode?: string;
+        phoneNumber?: string;
+    };
+    verification?: boolean;
+    confirmation?: boolean;
+    qrCodeRefresh?: boolean;
+};

package/types/capture-api/CrossDevice.js

@@ -0,0 +1,12 @@
+export var CrossDeviceMethod;
+(function (CrossDeviceMethod) {
+    CrossDeviceMethod["CopyLink"] = "copy_link";
+    CrossDeviceMethod["QrCode"] = "qr_code";
+    CrossDeviceMethod["Sms"] = "sms";
+})(CrossDeviceMethod || (CrossDeviceMethod = {}));
+export var CrossDevicePolicy;
+(function (CrossDevicePolicy) {
+    CrossDevicePolicy["Enable"] = "enable";
+    CrossDevicePolicy["Disable"] = "disable";
+    CrossDevicePolicy["Force"] = "force";
+})(CrossDevicePolicy || (CrossDevicePolicy = {}));

package/types/capture-api/Localisation.d.ts

@@ -0,0 +1,5 @@
+export type Localisation = {
+    language?: string;
+    allowedLanguages?: string[];
+    overrides?: Record<string, Record<string, string>>;
+};

package/types/capture-api/Localisation.js

@@ -0,0 +1 @@
+export {};

package/types/capture-api/Module.d.ts

@@ -0,0 +1,8 @@
+export type HostedModule = {
+    module: string;
+    version?: string;
+};
+export type ExternalModule = {
+    name: string;
+    url: string;
+};

package/types/capture-api/Module.js

@@ -0,0 +1 @@
+export {};

package/types/capture-api/SdkParameters.d.ts

@@ -0,0 +1,41 @@
+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 {};

package/types/capture-api/SdkParameters.js

@@ -0,0 +1,6 @@
+export var NavigationBar;
+(function (NavigationBar) {
+    NavigationBar["BackAndExit"] = "BackAndExit";
+    NavigationBar["BackOnly"] = "BackOnly";
+    NavigationBar["Hidden"] = "Hidden";
+})(NavigationBar || (NavigationBar = {}));

package/types/capture-api/callbacks/analytics.d.ts

@@ -0,0 +1,9 @@
+export type AnalyticsCallback = (event: IdvEvent) => void;
+export type IdvEvent = {
+    identifier: string;
+    eventMetadata: EventMetadata;
+};
+export type EventMetadata = {
+    runtimeId: string;
+    generatedAt: string;
+};

package/types/capture-api/callbacks/analytics.js

@@ -0,0 +1 @@
+export {};

package/types/capture-api/callbacks/biometricsToken.d.ts

@@ -0,0 +1,6 @@
+export type BiometricsTokenRequestedCallback = (customerHash: string) => string;
+export type BiometricsTokenGeneratedCallback = (customerUserHash: string, encryptedBiometricToken: string) => void;
+export type BiometricsTokenHandler = {
+    onTokenRequested: BiometricsTokenRequestedCallback;
+    onTokenGenerated: BiometricsTokenGeneratedCallback;
+};

package/types/capture-api/callbacks/biometricsToken.js

@@ -0,0 +1 @@
+export {};

package/types/capture-api/callbacks/callbacks.d.ts

@@ -0,0 +1,13 @@
+import type { AnalyticsCallback } from './analytics.js';
+import type { BiometricsTokenHandler } from './biometricsToken.js';
+import type { CompleteCallback } from './complete.js';
+import type { UserExitCallback } from './exit.js';
+import type { MediaCallback } from './media.js';
+export type Callbacks = {
+    onComplete: CompleteCallback;
+    onError: ErrorCallback;
+    onUserExit: UserExitCallback;
+    onMedia?: MediaCallback;
+    onAnalytics?: AnalyticsCallback;
+    biometricsTokenHandler?: BiometricsTokenHandler;
+};

package/types/capture-api/callbacks/callbacks.js

@@ -0,0 +1 @@
+export {};

package/types/capture-api/callbacks/complete.d.ts

@@ -0,0 +1,34 @@
+import type { ProofOfAddressType } from '../steps/ProofOfAddress.js';
+import type { StepNames } from '../steps/Step.js';
+export type CompleteCallback = (result: Record<string, CaptureResult>) => void;
+export type CaptureResult = FacePhotoCaptureResult;
+export type FacePhotoCaptureResult = {
+    type: StepNames.FacePhoto;
+    id: string;
+};
+export type FaceVideoCaptureResult = {
+    type: StepNames.FaceVideo;
+    id: string;
+};
+export type FaceMotionCaptureResult = {
+    type: StepNames.FaceMotion;
+    id: string;
+};
+export type DocumentSide = {
+    id: string;
+    videoId: string;
+};
+export type DocumentSides = {
+    front?: DocumentSide;
+    back?: DocumentSide;
+};
+export type DocumentCaptureResult = {
+    type: StepNames.Document;
+    sides: DocumentSides;
+    countryCode: string;
+};
+export type ProofOfAddressCaptureResult = {
+    type: StepNames.ProofOfAddress;
+    documentType: ProofOfAddressType;
+    sides: DocumentSides;
+};

package/types/capture-api/callbacks/complete.js

@@ -0,0 +1 @@
+export {};

package/types/capture-api/callbacks/error.d.ts

@@ -0,0 +1,247 @@
+declare enum ErrorCategory {
+    Authentication = "Authentication",
+    DeviceCapabilities = "DeviceCapabilities",
+    General = "General",
+    Initialisation = "Initialisation",
+    Network = "Network",
+    Permissions = "Permissions",
+    Processing = "Processing"
+}
+export type Error = {
+    uuid: string;
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export type ErrorCallback = (error: Error) => void;
+export declare enum ErrorType {
+    BiometricTokenRetrievalException = "BiometricTokenRetrievalException",
+    CameraException = "CameraException",
+    CameraNotDetected = "CameraNotDetected",
+    CrossDeviceDesktopError = "CrossDeviceDesktopError",
+    CrossDeviceRestartError = "CrossDeviceRestartError",
+    CrossDeviceVerificationAbortError = "CrossDeviceVerificationAbortError",
+    CrossDeviceVerificationInvalidError = "CrossDeviceVerificationInvalidError",
+    DuplicateGenericDocument = "DuplicateGenericDocument",
+    DuplicateStep = "DuplicateStep",
+    ExpiredToken = "ExpiredToken",
+    ExpiredTrial = "ExpiredTrial",
+    FeaturesNotAuthorized = "FeaturesNotAuthorized",
+    GenericException = "GenericException",
+    GeoBlocked = "GeoBlocked",
+    InitialisationInvalid = "InitialisationInvalid",
+    InvalidCountryCode = "InvalidCountryCode",
+    InvalidCustomTranslations = "InvalidCustomTranslations",
+    InvalidDocumentFormatAndCountryCombination = "InvalidDocumentFormatAndCountryCombination",
+    InvalidDocumentTitle = "InvalidDocumentTitle",
+    InvalidDocumentTypeException = "InvalidDocumentTypeException",
+    InvalidImageData = "InvalidImageData",
+    InvalidSdkParameter = "InvalidSdkParameter",
+    InvalidToken = "InvalidToken",
+    MissingLogoCobrandingParameter = "MissingLogoCobrandingParameter",
+    MissingSteps = "MissingSteps",
+    ModuleLoadError = "ModuleLoadError",
+    NetworkException = "NetworkException",
+    PermissionsUnavailable = "PermissionsUnavailable",
+    SdkVersionInsufficient = "SdkVersionInsufficient",
+    UnsupportedError = "UnsupportedError",
+    UnsupportedFeatureError = "UnsupportedFeatureError",
+    UploadError = "UploadError",
+    WelcomeMustBeFirstStep = "WelcomeMustBeFirstStep",
+    WorkflowBiometricTokenStorageException = "WorkflowBiometricTokenStorageException",
+    WorkflowInputError = "WorkflowInputError",
+    WorkflowTaskAbandoned = "WorkflowTaskAbandoned",
+    WorkflowTaskError = "WorkflowTaskError",
+    WorkflowVersionMismatch = "WorkflowVersionMismatch"
+}
+export declare const BiometricTokenRetrievalException: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const CameraException: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const CameraNotDetected: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const CrossDeviceDesktopError: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const CrossDeviceRestartError: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const CrossDeviceVerificationAbortError: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const CrossDeviceVerificationInvalidError: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const DuplicateGenericDocument: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const DuplicateStep: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const ExpiredToken: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const ExpiredTrial: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const FeaturesNotAuthorized: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const GenericException: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const GeoBlocked: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const InitialisationInvalid: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const InvalidCountryCode: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const InvalidCustomTranslations: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const InvalidDocumentFormatAndCountryCombination: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const InvalidDocumentTitle: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const InvalidDocumentTypeException: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const InvalidImageData: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const InvalidSdkParameter: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const InvalidToken: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const MissingLogoCobrandingParameter: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const MissingSteps: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const ModuleLoadError: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const NetworkException: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const PermissionsUnavailable: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const SdkVersionInsufficient: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const UnsupportedError: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const UnsupportedFeatureError: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const UploadError: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const WelcomeMustBeFirstStep: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const WorkflowBiometricTokenStorageException: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const WorkflowInputError: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const WorkflowTaskAbandoned: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const WorkflowTaskError: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export declare const WorkflowVersionMismatch: {
+    type: ErrorType;
+    category: ErrorCategory;
+    message: string;
+};
+export {};