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

package/dist/index.d.ts

@@ -1,23 +1,12 @@
-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 = {
@@ -26,7 +15,7 @@ declare type AuthTokenStoreData = {
     tokenExpiresAt: number;
 };
 
-declare class BaseConfigureError extends BaseError_2 {
+declare class BaseConfigureError extends BaseError {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -34,11 +23,11 @@ declare class BaseConfigureError extends BaseError_2 {
         errorCode: ConfigureError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError_2;
+        underlyingBaseError?: BaseError;
     });
 }
 
-declare class BaseConnectionError extends BaseError_2 {
+declare class BaseConnectionError extends BaseError {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -46,11 +35,11 @@ declare class BaseConnectionError extends BaseError_2 {
         errorCode: ConnectionError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError_2;
+        underlyingBaseError?: BaseError;
     });
 }
 
-declare class BaseDeinitializationError extends BaseError_2 {
+declare class BaseDeinitializationError extends BaseError {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -58,13 +47,39 @@ declare class BaseDeinitializationError extends BaseError_2 {
         errorCode: DeinitializationError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError_2;
+        underlyingBaseError?: BaseError;
     });
 }
 
-export { BaseError }
+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;
+}
 
-declare class BaseInitializationError extends BaseError_2 {
+declare class BaseInitializationError extends BaseError {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -72,11 +87,11 @@ declare class BaseInitializationError extends BaseError_2 {
         errorCode: InitializeError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError_2;
+        underlyingBaseError?: BaseError;
     });
 }
 
-export declare class BaseLoginError extends BaseError_2 {
+export declare class BaseLoginError extends BaseError {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -84,13 +99,16 @@ export declare class BaseLoginError extends BaseError_2 {
         errorCode: LoginError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError_2;
+        underlyingBaseError?: BaseError;
     });
 }
 
-export { BaseModule }
+export declare abstract class BaseModule<TModuleProps = unknown, TModulesConfig = unknown> extends HTMLElement {
+    abstract props: IdvModuleProps<TModuleProps, TModulesConfig> | null;
+    abstract setProps(config: IdvModuleProps<TModuleProps, TModulesConfig>): void;
+}
 
-declare class BasePrepareWorkflowError extends BaseError_2 {
+declare class BasePrepareWorkflowError extends BaseError {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -98,11 +116,11 @@ declare class BasePrepareWorkflowError extends BaseError_2 {
         errorCode: PrepareWorkflowError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError_2;
+        underlyingBaseError?: BaseError;
     });
 }
 
-declare class BaseTokenInitializationError extends BaseError_2 {
+declare class BaseTokenInitializationError extends BaseError {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -110,11 +128,11 @@ declare class BaseTokenInitializationError extends BaseError_2 {
         errorCode: TokenInitializeError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError_2;
+        underlyingBaseError?: BaseError;
     });
 }
 
-declare class BaseWorkflowError extends BaseError_2 {
+declare class BaseWorkflowError extends BaseError {
     private static readonly MODULE;
     private static readonly ERROR_ENUM_NAME;
     private static readonly SHORT_CODE;
@@ -122,7 +140,7 @@ declare class BaseWorkflowError extends BaseError_2 {
         errorCode: WorkflowError;
         message?: string;
         underlyingError?: string;
-        underlyingBaseError?: BaseError_2;
+        underlyingBaseError?: BaseError;
     });
 }
 
@@ -147,7 +165,6 @@ declare type ConnectionByApiKeyConfigCore = {
     deviceDescriptor: {
         ttl: number;
     };
-    httpTimeoutMs?: number;
 };
 
 declare type ConnectionConfigCore = {
@@ -156,7 +173,6 @@ declare type ConnectionConfigCore = {
     password: string;
     port?: number;
     userName: string;
-    httpTimeoutMs?: number;
 };
 
 export declare enum ConnectionError {
@@ -165,17 +181,14 @@ export declare enum ConnectionError {
     DECODING_FAILED = 2
 }
 
-declare type ContinueSessionResults = {
-    error: BaseWorkflowError;
-} | {
-    shouldStartNewSession: boolean;
+declare type ContinueSessionResults = SessionData | WorkflowResult | {
+    error?: BaseWorkflowError;
 };
 
 export declare type CredentialConnectionConfig = {
     baseUrl: string;
     password: string;
     userName: string;
-    httpTimeoutMs?: number;
 };
 
 declare type CurrentScreenConfig = {
@@ -220,6 +233,12 @@ 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;
@@ -292,10 +311,7 @@ declare type IdvBusinessLogicControllerProps = {
         sessionData?: undefined;
         error: BaseWorkflowError;
     }>;
-    _waitForNextStep: () => {
-        startHttpTimer: () => void;
-        cancel: () => void;
-    };
+    _waitForNextStep: () => Promise<void>;
     _stepSocketListenerWhenStepIsRunning: (isStepRunning: boolean) => void;
     _getSessionStateNextStepConditionResult: () => Promise<DataOrError<SessionModel>>;
     _findStepById: (stepId: string) => WorkflowStep | null;
@@ -333,7 +349,6 @@ export declare const IdvEventTypesEnum: {
 
 declare class IdvFetchService {
     private _connectionTokenExpirationBufferMs;
-    private _httpTimeoutMs;
     private _origin;
     private _apiKeyAuthToken;
     private _connectionToken;
@@ -365,8 +380,6 @@ declare class IdvFetchService {
     } | FetchErrorResult>;
     private _getAuthorizationSearchParam;
     private _getResponseTextFromBadResponse;
-    private _applyHttpTimeout;
-    private _getRequestSignal;
     private _httpFetch;
     private _fetchPing;
     private _fetchMe;
@@ -443,12 +456,11 @@ declare class IdvFetchService {
         data: SessionData;
     } | FetchErrorResult>;
     pushLogs(sessionId: string, pushLogsParams: PushLogsParams): Promise<Record<string, unknown>>;
-    startIamAuth({ applicationId, baseUrl, metadata, locale, httpTimeoutMs, }: {
+    startIamAuth({ applicationId, baseUrl, metadata, locale, }: {
         applicationId: string;
         baseUrl: string;
         metadata?: Record<string, unknown>;
         locale?: string;
-        httpTimeoutMs?: number;
     }): Promise<Record<string, unknown>>;
     private _postStartUpload;
     private _postFileChunk;
@@ -486,7 +498,7 @@ declare type IdvIntegrationControllerProps = {
     }>;
     getWorkflows: (params?: WorkflowListRequest) => Promise<WorkflowListCompletion>;
     prepareWorkflowAndPrepareUi: (workflowId: string) => Promise<PrepareWorkflowCompletion>;
-    startSession: (params: {
+    startNewSession: (params: {
         completion: (data: WorkflowCompletion) => void;
         locale: string;
         metadata?: Record<string, unknown>;
@@ -498,7 +510,6 @@ declare type IdvIntegrationControllerProps = {
         baseUrl: string;
         metadata?: Record<string, unknown>;
         locale?: string;
-        httpTimeoutMs?: number;
     }) => Promise<Record<string, unknown>>;
 };
 
@@ -543,9 +554,23 @@ export declare type IdvMessageEvent = {
     message?: IdvServiceMessages | string;
 };
 
-export { IdvModuleProps }
+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 { IdvModuleStaticMethods }
+export declare interface IdvModuleStaticMethods {
+    displayName: string;
+    isReady(): boolean;
+    getSupportedTemplates(): string[];
+    initialize(modulesConfig: Record<string, unknown>): void;
+    deinitialize(): void;
+    getIdentifier(): string;
+}
 
 export declare enum IdvServiceMessages {
     DID_START_SESSION = "DID_START_SESSION",
@@ -618,7 +643,7 @@ export declare class IdvWebComponent extends LitElement {
     connectedCallback(): void;
     _listenerFromModule: (module: string, data: any) => void;
     _isProcessingCallback: (isProcessing: boolean) => void;
-    _performFromModule: (data: any, type?: PerformType_2) => void;
+    _performFromModule: (data: any, type?: PerformType) => void;
     _processingScreen(): HTMLElement | TemplateResult<1>;
     private _isTheSameModuleAndScreen;
     _currentScreen(): HTMLElement | typeof nothing;
@@ -659,7 +684,6 @@ export declare type LoginConfig = {
     baseUrl: string;
     metadata?: Record<string, unknown>;
     locale?: string;
-    httpTimeoutMs?: number;
 };
 
 export declare enum LoginError {
@@ -673,7 +697,14 @@ export declare enum LoginError {
     AUTH_FAILURE = 7
 }
 
-export { ModuleClass }
+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 declare type PrepareWorkflowCompletion = {
     workflow?: Workflow;
@@ -713,7 +744,7 @@ declare type PushLogsParams = {
     };
 };
 
-export { registerModule }
+export declare function registerModule<TModuleProps = unknown, TModulesConfig = unknown>(name: string, ModuleClass: ModuleClass<TModuleProps, TModulesConfig>): void;
 
 declare type SessionData = {
     id: string;
@@ -769,19 +800,11 @@ 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;
@@ -828,7 +851,6 @@ declare type Workflow = {
     id: string;
     logging?: WorkflowLogging | null;
     steps: Array<WorkflowStep>;
-    stepTemplateIds?: string[];
     client: WorkflowClient;
     trackLocation?: boolean;
     error?: string | null;
@@ -883,7 +905,6 @@ declare class WorkflowModel implements Workflow {
     id: string;
     steps: WorkflowStepModel[];
     client: WorkflowClientModel;
-    stepTemplateIds?: string[];
     name?: string;
     logging?: WorkflowLoggingModel | null;
     error?: string | null;
@@ -944,25 +965,3 @@ 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;
-        }
-    }
-}