@regulaforensics/idv-capture-web 3.10.597-rc → 3.10.598-nightly

package/dist/index.d.ts

@@ -1,12 +1,23 @@
+import { BaseError } from '../../interfaces-idv/src';
+import { BaseError as BaseError_2 } from '../../../interfaces-idv/src';
+import { BaseModule } from '../../interfaces-idv/src';
 import { CSSResult } from 'lit';
+import { FailedAssets } from '../../interfaces-idv/src';
+import { IdvModuleProps } from '../../interfaces-idv/src';
+import { IdvModuleStaticMethods } from '../../interfaces-idv/src';
 import { LitElement } from 'lit';
+import { ModuleClass } from '../../interfaces-idv/src';
 import { nothing } from 'lit';
+import { PerformType } from '../../../interfaces-idv/src';
+import { PerformType as PerformType_2 } from '../../../../interfaces-idv/src';
+import { registerModule } from '../../interfaces-idv/src';
 import { TemplateResult } from 'lit-html';
 
 export declare type ApiKeyConnectionConfig = {
     baseUrl: string;
     apiKey: string;
     ttl?: number;
+    httpTimeoutMs?: number;
 };
 
 declare type AuthTokenStoreData = {
@@ -15,7 +26,7 @@ declare type AuthTokenStoreData = {
     tokenExpiresAt: number;
 };
 
-declare class BaseConfigureError extends BaseError {
+declare class BaseConfigureError extends BaseError_2 {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -23,11 +34,11 @@ declare class BaseConfigureError extends BaseError {
         errorCode: ConfigureError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError;
+        underlyingBaseError?: BaseError_2;
     });
 }
 
-declare class BaseConnectionError extends BaseError {
+declare class BaseConnectionError extends BaseError_2 {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -35,11 +46,11 @@ declare class BaseConnectionError extends BaseError {
         errorCode: ConnectionError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError;
+        underlyingBaseError?: BaseError_2;
     });
 }
 
-declare class BaseDeinitializationError extends BaseError {
+declare class BaseDeinitializationError extends BaseError_2 {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -47,39 +58,13 @@ declare class BaseDeinitializationError extends BaseError {
         errorCode: DeinitializationError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError;
+        underlyingBaseError?: BaseError_2;
     });
 }
 
-export declare class BaseError {
-    errorCode: number | string;
-    errorCodeKey: string;
-    message?: string;
-    underlyingError?: string;
-    underlyingBaseError?: BaseError;
-    domain?: string;
-    module: string;
-    errorEnumName: string;
-    shortDomainCode: string;
-    constructor({ errorCode, errorCodeKey, message, underlyingError, underlyingBaseError, domain, module, errorEnumName, shortDomainCode, }: {
-        errorCode: number | string;
-        errorCodeKey: string;
-        module: string;
-        message?: string;
-        underlyingError?: string;
-        underlyingBaseError?: BaseError;
-        domain?: string;
-        errorEnumName: string;
-        shortDomainCode: string;
-    });
-    static getErrorKey<T extends Record<string, any>>(errorCode: number | string, errorEnum: T): string;
-    get lastUnderlyingError(): string | undefined;
-    toObject(): Record<string, any>;
-    get shortChain(): string;
-    get fullChain(): string;
-}
+export { BaseError }
 
-declare class BaseInitializationError extends BaseError {
+declare class BaseInitializationError extends BaseError_2 {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -87,11 +72,11 @@ declare class BaseInitializationError extends BaseError {
         errorCode: InitializeError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError;
+        underlyingBaseError?: BaseError_2;
     });
 }
 
-export declare class BaseLoginError extends BaseError {
+export declare class BaseLoginError extends BaseError_2 {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -99,16 +84,13 @@ export declare class BaseLoginError extends BaseError {
         errorCode: LoginError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError;
+        underlyingBaseError?: BaseError_2;
     });
 }
 
-export declare abstract class BaseModule<TModuleProps = unknown, TModulesConfig = unknown> extends HTMLElement {
-    abstract props: IdvModuleProps<TModuleProps, TModulesConfig> | null;
-    abstract setProps(config: IdvModuleProps<TModuleProps, TModulesConfig>): void;
-}
+export { BaseModule }
 
-declare class BasePrepareWorkflowError extends BaseError {
+declare class BasePrepareWorkflowError extends BaseError_2 {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -116,11 +98,11 @@ declare class BasePrepareWorkflowError extends BaseError {
         errorCode: PrepareWorkflowError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError;
+        underlyingBaseError?: BaseError_2;
     });
 }
 
-declare class BaseTokenInitializationError extends BaseError {
+declare class BaseTokenInitializationError extends BaseError_2 {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -128,11 +110,11 @@ declare class BaseTokenInitializationError extends BaseError {
         errorCode: TokenInitializeError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError;
+        underlyingBaseError?: BaseError_2;
     });
 }
 
-declare class BaseWorkflowError extends BaseError {
+declare class BaseWorkflowError extends BaseError_2 {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -140,7 +122,7 @@ declare class BaseWorkflowError extends BaseError {
         errorCode: WorkflowError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError;
+        underlyingBaseError?: BaseError_2;
     });
 }
 
@@ -165,6 +147,7 @@ declare type ConnectionByApiKeyConfigCore = {
     deviceDescriptor: {
         ttl: number;
     };
+    httpTimeoutMs?: number;
 };
 
 declare type ConnectionConfigCore = {
@@ -173,6 +156,7 @@ declare type ConnectionConfigCore = {
     password: string;
     port?: number;
     userName: string;
+    httpTimeoutMs?: number;
 };
 
 export declare enum ConnectionError {
@@ -181,14 +165,17 @@ export declare enum ConnectionError {
     DECODING_FAILED = 2
 }
 
-declare type ContinueSessionResults = SessionData | WorkflowResult | {
-    error?: BaseWorkflowError;
+declare type ContinueSessionResults = {
+    error: BaseWorkflowError;
+} | {
+    shouldStartNewSession: boolean;
 };
 
 export declare type CredentialConnectionConfig = {
     baseUrl: string;
     password: string;
     userName: string;
+    httpTimeoutMs?: number;
 };
 
 declare type CurrentScreenConfig = {
@@ -233,12 +220,6 @@ export declare type DeinitializeCompletion = {
     error?: BaseDeinitializationError;
 };
 
-declare type FailedAssets = {
-    imageURL: Set<string>;
-    base64: Set<string>;
-    blockingAssets: Set<string>;
-};
-
 declare type FetchErrorResult = {
     code: FetchResultCode.HTTP_ISSUE | FetchResultCode.PROVIDER_ERROR | FetchResultCode.DECODING_FAILED;
     data: FetchState;
@@ -311,7 +292,10 @@ declare type IdvBusinessLogicControllerProps = {
         sessionData?: undefined;
         error: BaseWorkflowError;
     }>;
-    _waitForNextStep: () => Promise<void>;
+    _waitForNextStep: () => {
+        startHttpTimer: () => void;
+        cancel: () => void;
+    };
     _stepSocketListenerWhenStepIsRunning: (isStepRunning: boolean) => void;
     _getSessionStateNextStepConditionResult: () => Promise<DataOrError<SessionModel>>;
     _findStepById: (stepId: string) => WorkflowStep | null;
@@ -349,6 +333,7 @@ export declare const IdvEventTypesEnum: {
 
 declare class IdvFetchService {
     private _connectionTokenExpirationBufferMs;
+    private _httpTimeoutMs;
     private _origin;
     private _apiKeyAuthToken;
     private _connectionToken;
@@ -380,6 +365,8 @@ declare class IdvFetchService {
     } | FetchErrorResult>;
     private _getAuthorizationSearchParam;
     private _getResponseTextFromBadResponse;
+    private _applyHttpTimeout;
+    private _getRequestSignal;
     private _httpFetch;
     private _fetchPing;
     private _fetchMe;
@@ -456,11 +443,12 @@ declare class IdvFetchService {
         data: SessionData;
     } | FetchErrorResult>;
     pushLogs(sessionId: string, pushLogsParams: PushLogsParams): Promise<Record<string, unknown>>;
-    startIamAuth({ applicationId, baseUrl, metadata, locale, }: {
+    startIamAuth({ applicationId, baseUrl, metadata, locale, httpTimeoutMs, }: {
         applicationId: string;
         baseUrl: string;
         metadata?: Record<string, unknown>;
         locale?: string;
+        httpTimeoutMs?: number;
     }): Promise<Record<string, unknown>>;
     private _postStartUpload;
     private _postFileChunk;
@@ -498,7 +486,7 @@ declare type IdvIntegrationControllerProps = {
     }>;
     getWorkflows: (params?: WorkflowListRequest) => Promise<WorkflowListCompletion>;
     prepareWorkflowAndPrepareUi: (workflowId: string) => Promise<PrepareWorkflowCompletion>;
-    startNewSession: (params: {
+    startSession: (params: {
         completion: (data: WorkflowCompletion) => void;
         locale: string;
         metadata?: Record<string, unknown>;
@@ -510,6 +498,7 @@ declare type IdvIntegrationControllerProps = {
         baseUrl: string;
         metadata?: Record<string, unknown>;
         locale?: string;
+        httpTimeoutMs?: number;
     }) => Promise<Record<string, unknown>>;
 };
 
@@ -554,23 +543,9 @@ export declare type IdvMessageEvent = {
     message?: IdvServiceMessages | string;
 };
 
-export declare type IdvModuleProps<TModuleProps, TModulesConfig> = {
-    isProcessing?: (isProcessing: boolean) => void;
-    moduleProps: TModuleProps;
-    modulesConfig?: TModulesConfig;
-    perform: (data: any, type?: PerformType) => void;
-    idvEventListener: (module: string, data: any) => void;
-    nonce?: string;
-};
+export { IdvModuleProps }
 
-export declare interface IdvModuleStaticMethods {
-    displayName: string;
-    isReady(): boolean;
-    getSupportedTemplates(): string[];
-    initialize(modulesConfig: Record<string, unknown>): void;
-    deinitialize(): void;
-    getIdentifier(): string;
-}
+export { IdvModuleStaticMethods }
 
 export declare enum IdvServiceMessages {
     DID_START_SESSION = "DID_START_SESSION",
@@ -643,7 +618,7 @@ export declare class IdvWebComponent extends LitElement {
     connectedCallback(): void;
     _listenerFromModule: (module: string, data: any) => void;
     _isProcessingCallback: (isProcessing: boolean) => void;
-    _performFromModule: (data: any, type?: PerformType) => void;
+    _performFromModule: (data: any, type?: PerformType_2) => void;
     _processingScreen(): HTMLElement | TemplateResult<1>;
     private _isTheSameModuleAndScreen;
     _currentScreen(): HTMLElement | typeof nothing;
@@ -684,6 +659,7 @@ export declare type LoginConfig = {
     baseUrl: string;
     metadata?: Record<string, unknown>;
     locale?: string;
+    httpTimeoutMs?: number;
 };
 
 export declare enum LoginError {
@@ -697,14 +673,7 @@ export declare enum LoginError {
     AUTH_FAILURE = 7
 }
 
-export declare type ModuleClass<TModuleProps = unknown, TModulesConfig = unknown> = IdvModuleStaticMethods & (new (...args: any[]) => BaseModule<TModuleProps, TModulesConfig>);
-
-declare type PerformType = (typeof PerformTypes)[keyof typeof PerformTypes] | undefined;
-
-declare const PerformTypes: {
-    readonly FORM: "form";
-    readonly DATA: "data";
-};
+export { ModuleClass }
 
 export declare type PrepareWorkflowCompletion = {
     workflow?: Workflow;
@@ -744,7 +713,7 @@ declare type PushLogsParams = {
     };
 };
 
-export declare function registerModule<TModuleProps = unknown, TModulesConfig = unknown>(name: string, ModuleClass: ModuleClass<TModuleProps, TModulesConfig>): void;
+export { registerModule }
 
 declare type SessionData = {
     id: string;
@@ -800,11 +769,19 @@ declare type SessionPropertiesItem = {
     object?: unknown;
 };
 
+export declare enum SocketError {
+    UNKNOWN = 0,
+    SESSION_NOT_FOUND_OR_ACCESS_DENIED = 1,
+    INVALID_MESSAGE_FORMAT = 2,
+    UNSUPPORTED_COMMAND = 3
+}
+
 declare type StartConfig = {
     host?: string;
     isSecure?: boolean;
     apiKey?: string;
     port?: number;
+    httpTimeoutMs?: number;
 };
 
 export declare type StartLoginCompletion = string | BaseLoginError;
@@ -851,6 +828,7 @@ declare type Workflow = {
     id: string;
     logging?: WorkflowLogging | null;
     steps: Array<WorkflowStep>;
+    stepTemplateIds?: string[];
     client: WorkflowClient;
     trackLocation?: boolean;
     error?: string | null;
@@ -905,6 +883,7 @@ declare class WorkflowModel implements Workflow {
     id: string;
     steps: WorkflowStepModel[];
     client: WorkflowClientModel;
+    stepTemplateIds?: string[];
     name?: string;
     logging?: WorkflowLoggingModel | null;
     error?: string | null;
@@ -965,3 +944,25 @@ declare class WorkflowStepModel implements WorkflowStep {
 }
 
 export { }
+
+
+
+declare global {
+    const VERSION: string;
+    const ENV: string;
+
+    interface Window {
+        RegulaIdvService: IdvFetchService;
+        allowedCameras: InputDeviceInfo[];
+    }
+
+    declare namespace preact.JSX {
+        interface IntrinsicElements {
+            'face-liveness': IFaceLiveness;
+            'document-reader': IDocumentReader;
+            'idv-flow': any;
+            'idv-document': any;
+            'idv-face': any;
+        }
+    }
+}