@regulaforensics/idv-capture-web 3.6.419-nightly → 3.6.421-nightly

package/README.md

@@ -197,6 +197,24 @@ if (startWorkflowResult.error) {
 console.log('WORKFLOW FINISHED:', startWorkflowResult);
 ```
 
+### Start Login
+
+```javascript
+const startLoginResult = await service.startLogin({
+  applicationId: 'your_application_id',
+  baseUrl: 'https://your.host.com',
+  metadata: { anyMetadata: 'Any Metadata' },
+  locale: 'en-us',
+});
+
+// Error handling
+if (typeof startLoginResult !== 'string') {
+  console.error(startLoginResult);
+} else {
+  console.log('IAM AUTH CODE:', startLoginResult);
+}
+```
+
 ## Events
 
 You can subscribe to service events such as status updates, errors, and workflow progress by assigning a listener:
@@ -248,6 +266,7 @@ console.log(service.version);
 | `getWorkFlows(params?)`           | Returns a list of available workflows.                                                           | `async getWorkFlows(params?: WorkflowListRequest): Promise<WorkflowListCompletion>`                                                                                | Useful for dynamically displaying workflows to users.                               |
 | `prepareWorkflow({ workflowId })` | Prepares the service for the given workflow. Checks module and step compatibility.               | `async prepareWorkflow({ workflowId }: { workflowId: string }): Promise<PrepareWorkflowCompletion>`                                                                | Must be called after configure. Validates workflow and modules.                     |
 | `startWorkflow(config?)`          | Starts the workflow. Show the web component before running and remove it after completion.       | `async startWorkflow(config?: StartWorkflowConfig): Promise<WorkflowCompletion>`                                                                                   | Display the component before calling. Pass locale/metadata if needed.               |
+| `startLogin(config)`              | Runs the IAM login flow: IAM auth start, configure, prepare, and start workflow. Returns the IAM auth code on success. | `async startLogin(config: LoginConfig): Promise<StartLoginCompletion>`                                                                                             | Requires `initialize` first. Display the component before calling. |
 | `deinitialize()`                  | Deinitializes the service. Run `initialize` again to restart. Recommended after completing work. | `async deinitialize(): Promise<DeinitializeCompletion>`                                                                                                            | Clean up resources after finishing a workflow. Use `initialize` to start again.     |
 
 ## Examples

package/dist/index.d.ts

@@ -91,6 +91,18 @@ declare class BaseInitializationError extends BaseError {
     });
 }
 
+export declare class BaseLoginError extends BaseError {
+    private static readonly MODULE;
+    private static readonly ERROR_ENUM_NAME;
+    private static readonly SHORT_CODE;
+    constructor({ errorCode, message, underlyingError, underlyingBaseError, }: {
+        errorCode: LoginError;
+        message?: string;
+        underlyingError?: string;
+        underlyingBaseError?: BaseError;
+    });
+}
+
 export declare abstract class BaseModule<TModuleProps = unknown, TModulesConfig = unknown> extends HTMLElement {
     abstract props: IdvModuleProps<TModuleProps, TModulesConfig> | null;
     abstract setProps(config: IdvModuleProps<TModuleProps, TModulesConfig>): void;
@@ -318,7 +330,8 @@ declare type IdvBusinessLogicControllerProps = {
     setAndInitFetchService: () => Promise<void>;
     isFinalWaitingUi: boolean;
     setFinalWaitingUi: (isWaitingUi: boolean) => void;
-    setFinalStepAndStopProcess: (stepId?: string) => void;
+    _setFinalStepAndStopProcess: (stepId?: string) => void;
+    _setIamAuthCodeAndStopProcess: (step: WorkflowStep) => void;
     resetSession: () => void;
     resetFetchService: () => void;
     _decodeMessageFromWebSocket: (eventData: MessageEvent['data']) => WebSocketDecodedSessionMessage | null;
@@ -378,6 +391,7 @@ declare class IdvFetchService {
     private _fetchWorkflow;
     private _fetchStep;
     private _fetchSessionLogs;
+    private _fetchStartIamAuth;
     connectByUserPass(config: ConnectionConfigCore): Promise<{
         code: FetchResultCode.SUCCESS;
         data: {
@@ -442,6 +456,12 @@ declare class IdvFetchService {
         data: SessionData;
     } | FetchErrorResult>;
     pushLogs(sessionId: string, pushLogsParams: PushLogsParams): Promise<Record<string, unknown>>;
+    startIamAuth({ applicationId, baseUrl, metadata, locale, }: {
+        applicationId: string;
+        baseUrl: string;
+        metadata?: Record<string, unknown>;
+        locale?: string;
+    }): Promise<Record<string, unknown>>;
     private _postStartUpload;
     private _postFileChunk;
     private _uploadFileInChunks;
@@ -485,6 +505,12 @@ declare type IdvIntegrationControllerProps = {
         location?: GeoCoords | null;
     }) => Promise<WorkflowCompletion>;
     deinitialize: () => Promise<DeinitializeCompletion>;
+    startIamAuth: (params: {
+        applicationId: string;
+        baseUrl: string;
+        metadata?: Record<string, unknown>;
+        locale?: string;
+    }) => Promise<Record<string, unknown>>;
 };
 
 export declare class IdvIntegrationService {
@@ -499,6 +525,7 @@ export declare class IdvIntegrationService {
     }): Promise<PrepareWorkflowCompletion>;
     startWorkflow(config?: StartWorkflowConfig): Promise<WorkflowCompletion>;
     deinitialize(): Promise<DeinitializeCompletion>;
+    startLogin(config: LoginConfig): Promise<StartLoginCompletion>;
     /** service commands */
     get version(): string;
     get currentSessionId(): string | null;
@@ -612,7 +639,7 @@ export declare class IdvWebComponent extends LitElement {
     isProcessing: boolean;
     loadedModules: [] | LoadedModule[];
     modulesConfig: Record<string, any>;
-    nonce: string | undefined;
+    storeNonce: string | undefined;
     connectedCallback(): void;
     _listenerFromModule: (module: string, data: any) => void;
     _isProcessingCallback: (isProcessing: boolean) => void;
@@ -652,6 +679,24 @@ declare type LoadedModule = {
     component: any;
 };
 
+export declare type LoginConfig = {
+    applicationId: string;
+    baseUrl: string;
+    metadata?: Record<string, unknown>;
+    locale?: string;
+};
+
+export declare enum LoginError {
+    INITIALIZATION_REQUIRED = 0,
+    ALREADY_IN_PROCESS = 1,
+    START_COMMAND_FAILURE = 2,
+    MISSING_CONFIGURATION = 3,
+    PREPARE_WORKFLOW_FAILURE = 4,
+    EXECUTION_WORKFLOW_FAILURE = 5,
+    MISSING_AUTH_CODE = 6,
+    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;
@@ -762,6 +807,8 @@ declare type StartConfig = {
     port?: number;
 };
 
+export declare type StartLoginCompletion = string | BaseLoginError;
+
 export declare enum StartSessionError {
     HTTP_ISSUE = 0,
     PROVIDER_ERROR = 1,