@transmitsecurity/platform-web-sdk 2.2.0 → 2.3.1

package/dist/ido.d.ts

@@ -51,6 +51,10 @@ interface StartJourneyOptions {
      * Should client-server communication be double encrypted? Defaults to false.
      */
     encrypted?: boolean;
+    /**
+     * An optional admin debug token to be passed to the Journey.
+     */
+    adminDebugToken?: string;
 }
 /**
  * @interface
@@ -61,6 +65,10 @@ interface StartSsoJourneyOptions {
    * Should client-server communication be double encrypted? Defaults to false.
    */
     encrypted?: boolean;
+    /**
+     * An optional admin debug token to be passed to the Journey.
+     */
+    adminDebugToken?: string;
 }
 /**
  * @enum
@@ -217,7 +225,7 @@ declare enum IdoServiceResponseType {
 /**
  * @enum
  * @description The enum for the Journey step ID, used when the journey step is a predefined typed action.
- * The actions that do not use this are "Get Information from Client" and "Login Form" which allow the journey author to define a custom ID.
+ * The actions that do not use this are "Collect information" and "Login Form" which allow the journey author to define a custom ID.
  * See also {@link IdoServiceResponse.journeyStepId}.
  */
 declare enum IdoJourneyActionType {
@@ -244,7 +252,7 @@ declare enum IdoJourneyActionType {
      *  }
      * }
      * ```
-     * The client response does not need to include any data: `tsPlatform.ido.submitClientResponse(ClientResponseOptionType.ClientInput);`
+     * The client response does not need to include any data: `ido.submitClientResponse(ClientResponseOptionType.ClientInput);`
      */
     Information = "action:information",
     /**
@@ -254,7 +262,7 @@ declare enum IdoJourneyActionType {
      *
      * The {@link IdoServiceResponse} object does not include any data.
      *
-     * The client response does not need to include any data: `tsPlatform.ido.submitClientResponse(ClientResponseOptionType.ClientInput);`
+     * The client response does not need to include any data: `ido.submitClientResponse(ClientResponseOptionType.ClientInput);`
      */
     DebugBreak = "action:debug_break",
     /**
@@ -263,7 +271,7 @@ declare enum IdoJourneyActionType {
      * The {@link IdoServiceResponse} object includes information that can be presented as a QR to scan by another device.
      * The response will remain the same while the cross session message was not consumed by the journey executed by the other device.
      *
-     * The client response does not need to include any data: `tsPlatform.ido.submitClientResponse(ClientResponseOptionType.ClientInput);`
+     * The client response does not need to include any data: `ido.submitClientResponse(ClientResponseOptionType.ClientInput);`
      */
     WaitForAnotherDevice = "action:wait_for_another_device",
     /**
@@ -291,7 +299,7 @@ declare enum IdoJourneyActionType {
     /**
      * @description `journeyStepId` for WebAuthn Registration action.
      *
-     * Data received in the {@link IdoServiceResponse} object: the input parameters that you need to send to `tsPlatform.webauthn.register()`
+     * Data received in the {@link IdoServiceResponse} object: the input parameters that you need to send to `webauthn.register()`
      * ```json
      * {
      *  "data": {
@@ -303,10 +311,10 @@ declare enum IdoJourneyActionType {
      * }
      * ```
      *
-     * Before responding, activate `tsPlatform.webauthn.register()` to obtain the `webauthn_encoded_result` value.
+     * Before responding, activate `webauthn.register()` to obtain the `webauthn_encoded_result` value.
      * This will present the user with the WebAuthn registration UI. Use the result to send the client response:
      * ```json
-     * tsPlatform.ido.submitClientResponse(
+     * ido.submitClientResponse(
      *     ClientResponseOptionType.ClientInput,
      *     {
      *         "webauthn_encoded_result": "<WEBAUTHN_ENCODED_RESULT_FROM_SDK>"
@@ -315,9 +323,9 @@ declare enum IdoJourneyActionType {
      */
     WebAuthnRegistration = "action:webauthn_registration",
     /**
-     * @description `journeyStepId` for instructing the use of DRS trigger action, as part of the Risk Recommendation journey step.
+     * @description `journeyStepId` for instructing the use of Fraud Prevention trigger action, as part of the Risk Recommendation journey step.
      *
-     * Data received in the {@link IdoServiceResponse} object: the input parameters that you need to send to `tsPlatform.drs.triggerActionEvent()`
+     * Data received in the {@link IdoServiceResponse} object: the input parameters that you need to send to `drs.triggerActionEvent()`
      * ```json
      * {
      *  "data": {
@@ -327,13 +335,13 @@ declare enum IdoJourneyActionType {
      *  },
      * }
      * ```
-     * Before responding, activate `tsPlatform.drs.triggerActionEvent()` to obtain the `action_token` value. This is a silent action, and does not require user interaction.
+     * Before responding, activate `drs.triggerActionEvent()` to obtain the `action_token` value. This is a silent action, and does not require user interaction.
      * Use the result to send the client response:
      * ```json
-     * tsPlatform.ido.submitClientResponse(
+     * ido.submitClientResponse(
      *     ClientResponseOptionType.ClientInput,
      *     {
-     *         "action_token": "<DRS action token>"
+     *         "action_token": "<Fraud Prevention action token>"
      *     })
      * ```
      */
@@ -356,12 +364,12 @@ declare enum IdoJourneyActionType {
      * }
      * ```
      * Use this data to redirect the user to the identity verification endpoint.
-     * Since this redirects to a different page, make sure you store the SDK state by calling `tsPlatform.ido.serializeState()`, and saving the response data in the session storage.
-     * After the user completes the identity verification, you can restore the SDK state and continue the journey, by calling `tsPlatform.ido.restoreFromSerializedState()` with the stored state.
+     * Since this redirects to a different page, make sure you store the SDK state by calling `ido.serializeState()`, and saving the response data in the session storage.
+     * After the user completes the identity verification, you can restore the SDK state and continue the journey, by calling `ido.restoreFromSerializedState()` with the stored state.
      *
      * Once done, send the following client response:
      * ```json
-     * tsPlatform.ido.submitClientResponse(
+     * ido.submitClientResponse(
      *     ClientResponseOptionType.ClientInput,
      *     {
      *         "payload": {
@@ -394,7 +402,7 @@ declare enum IdoJourneyActionType {
      *
      * - For simple submit of OTP passcode:
      * ```json
-     *      tsPlatform.ido.submitClientResponse(
+     *      ido.submitClientResponse(
      *          ClientResponseOptionType.ClientInput,
      *          {
      *              "passcode": "<passcode>"
@@ -402,7 +410,7 @@ declare enum IdoJourneyActionType {
      * ```
      *
      * - In Order to request resend of OTP (restart the action):
-     *     `tsPlatform.ido.submitClientResponse(ClientResponseOptionType.Resend)`
+     *   `ido.submitClientResponse(ClientResponseOptionType.Resend)`
      *
      */
     EmailOTPAuthentication = "transmit_platform_email_otp_authentication",
@@ -428,7 +436,7 @@ declare enum IdoJourneyActionType {
      *
      * - For simple submit of OTP passcode:
      * ```json
-     *      tsPlatform.ido.submitClientResponse(
+     *      ido.submitClientResponse(
      *          ClientResponseOptionType.ClientInput,
      *          {
      *              "passcode": "<passcode>"
@@ -436,7 +444,7 @@ declare enum IdoJourneyActionType {
      * ```
      *
      * - In Order to request resend of OTP (restart the action):
-     *     `tsPlatform.ido.submitClientResponse(ClientResponseOptionType.Resend)`
+     *   `ido.submitClientResponse(ClientResponseOptionType.Resend)`
      *
      */
     SmsOTPAuthentication = "transmit_platform_sms_otp_authentication",
@@ -462,7 +470,7 @@ declare enum IdoJourneyActionType {
      *
      * - For simple submit of OTP passcode:
      * ```json
-     *      tsPlatform.ido.submitClientResponse(
+     *      ido.submitClientResponse(
      *          ClientResponseOptionType.ClientInput,
      *          {
      *              "passcode": "<passcode>"
@@ -470,7 +478,7 @@ declare enum IdoJourneyActionType {
      * ```
      *
      * - In Order to request resend of OTP (restart the action):
-     *     `tsPlatform.ido.submitClientResponse(ClientResponseOptionType.Resend)`
+     *   `ido.submitClientResponse(ClientResponseOptionType.Resend)`
      *
      */
     GenericOTPAuthentication = "transmit_platform_generic_otp_authentication",
@@ -492,7 +500,7 @@ declare enum IdoJourneyActionType {
      * The user should use this to register the TOTP secret in their authenticator app.
      * Once the user has completed the registration, send the following empty client response:
      * ```json
-     * tsPlatform.ido.submitClientResponse(
+     * ido.submitClientResponse(
      *    ClientResponseOptionType.ClientInput
      * )
      * ```
@@ -521,7 +529,7 @@ declare enum IdoJourneyActionType {
      *
      * - For simple submit of validation passcode:
      * ```json
-     *      tsPlatform.ido.submitClientResponse(
+     *      ido.submitClientResponse(
      *          ClientResponseOptionType.ClientInput,
      *          {
      *              "passcode": "<passcode>"
@@ -529,7 +537,7 @@ declare enum IdoJourneyActionType {
      * ```
      *
      * - In Order to request resend of OTP (restart the action):
-     *     `tsPlatform.ido.submitClientResponse(ClientResponseOptionType.Resend)`
+     *   `ido.submitClientResponse(ClientResponseOptionType.Resend)`
      *
      */
     EmailValidation = "transmit_platform_email_validation",
@@ -554,7 +562,7 @@ declare enum IdoJourneyActionType {
      *
      * - For simple submit of validation passcode:
      * ```json
-     *      tsPlatform.ido.submitClientResponse(
+     *      ido.submitClientResponse(
      *          ClientResponseOptionType.ClientInput,
      *          {
      *              "passcode": "<passcode>"
@@ -562,7 +570,7 @@ declare enum IdoJourneyActionType {
      * ```
      *
      * - In Order to request resend of OTP (restart the action):
-     *     `tsPlatform.ido.submitClientResponse(ClientResponseOptionType.Resend)`
+     *   `ido.submitClientResponse(ClientResponseOptionType.Resend)`
      *
      */
     SmsValidation = "transmit_platform_sms_validation",
@@ -591,7 +599,7 @@ declare enum IdoJourneyActionType {
    *
    * - For submitting the TOTP code:
    * ```json
-   * tsPlatform.ido.submitClientResponse(
+   * ido.submitClientResponse(
    *    ClientResponseOptionType.ClientInput,
    *    {
    *      "totp_code": "<6_DIGIT_TOTP_CODE>"
@@ -624,7 +632,7 @@ declare enum IdoJourneyActionType {
      *
      * Once done, send the following client response:
      * ```json
-     * tsPlatform.ido.submitClientResponse(
+     * ido.submitClientResponse(
      *    ClientResponseOptionType.ClientInput,
      *    {
      *       "idp_response" : {
@@ -655,16 +663,16 @@ declare enum IdoJourneyActionType {
      *  }
      * }
      * ```
-     * Before responding, call `tsPlatform.webauthn.approve.modal()` to obtain the `webauthn_encoded_result` value.
+     * Before responding, call `webauthn.approve.modal()` to obtain the `webauthn_encoded_result` value.
      * ```javascript
-     * const result = await tsPlatform.webauthn.approve.modal(
+     * const result = await webauthn.approve.modal(
      *   response.data.approval_data // Transaction details to be approved
      * );
      * ```
      *
      * Then submit the result:
      * ```javascript
-     * tsPlatform.ido.submitClientResponse(
+     * ido.submitClientResponse(
      *    ClientResponseOptionType.ClientInput,
      *    {
      *      "webauthn_encoded_result": result
@@ -708,7 +716,7 @@ declare enum IdoJourneyActionType {
      *
      * For organization selection, send the following client response:
      * ```javascript
-     * tsPlatform.ido.submitClientResponse(
+     * ido.submitClientResponse(
      *    ClientResponseOptionType.ClientInput,
      *    {
      *      "organization_id": "<ORGANIZATION_ID>"
@@ -743,7 +751,7 @@ declare enum IdoJourneyActionType {
      *
      * For device selection, send the following client response:
      * ```javascript
-     * tsPlatform.ido.submitClientResponse(
+     * ido.submitClientResponse(
      *    ClientResponseOptionType.ClientInput,
      *    {
      *      "selected_device_code": "<DEVICE_CODE>"
@@ -775,17 +783,17 @@ declare enum IdoJourneyActionType {
      * ```javascript
      * // The application should implement its own polling mechanism
      * // and call this method periodically to check the status
-     * tsPlatform.ido.submitClientResponse(ClientResponseOptionType.ClientInput)
+     * ido.submitClientResponse(ClientResponseOptionType.ClientInput)
      * ```
      *
      * - To cancel the authentication:
      * ```javascript
-     * tsPlatform.ido.submitClientResponse(ClientResponseOptionType.Cancel)
+     * ido.submitClientResponse(ClientResponseOptionType.Cancel)
      * ```
      *
      * - To resend the push notification:
      * ```javascript
-     * tsPlatform.ido.submitClientResponse(ClientResponseOptionType.Resend)
+     * ido.submitClientResponse(ClientResponseOptionType.Resend)
      * ```
      *
      * Note: The application is responsible for implementing the polling mechanism
@@ -796,7 +804,98 @@ declare enum IdoJourneyActionType {
      * On failure, the `IdoServiceResponse` {@link IdoServiceResponse.errorData} field will contain
      * relevant error codes that can be used to handle various failure scenarios.
      */
-    MobileApproveAuthentication = "transmit_platform_mobile_approve_authentication"
+    MobileApproveAuthentication = "transmit_platform_mobile_approve_authentication",
+    /**
+     * @description `journeyStepId` for a selfie acquisition action.
+     * This action instructs the client to acquire a selfie image from the user, typically as part of an identity verification or face authentication process.
+     *
+     * Data received in the {@link IdoServiceResponse} object:
+     * ```json
+     * {
+     *   "data": {
+     *     "start_token": "<START_TOKEN>",         // Optional: used to start an identity verification session if required
+     *     "acquisition_id": "<ACQUISITION_ID>"   // Required: ID needed to start selfie capture
+     *   }
+     * }
+     * ```
+     *
+     * To perform the selfie acquisition:
+     * 1. If a `start_token` is present, initialize the IDV SDK session:
+     *    ```javascript
+     *    if (response.data.start_token !== undefined) {
+     *      await idv.start(response.data.start_token);
+     *    }
+     *    ```
+     * 2. Run the selfie acquisition by calling the IDV SDK's `captureSelfie()` method:
+     *    ```javascript
+     *    await idv.captureSelfie({ acquisitionId: response.data.acquisition_id });
+     *    ```
+     *
+     * After acquiring the selfie, the client response does not need to include any data:
+     * ```javascript
+     * ido.submitClientResponse(ClientResponseOptionType.ClientInput);
+     * ```
+     *
+     * If an error occurs while capturing the selfie, the client should handle error states and inform the user
+     * and/or retry as appropriate according to application requirements.
+     *
+     * For deeper understanding and more implementation details, refer to the IDV SDK documentation:
+     * {@link https://developer.transmitsecurity.com/sdk-ref/idvsdk/overview IDV SDK Reference}
+     */
+    SelfieAcquisition = "transmit_platform_selfie_acquisition",
+    /**
+     * @description `journeyStepId` for a document acquisition action.
+     * This action instructs the client to acquire a document image from the user, typically as part of an identity verification or face authentication process.
+     *
+     * Data received in the {@link IdoServiceResponse} object:
+     * ```json
+     * {
+     *   "data": {
+     *     "start_token": "<START_TOKEN>",         // Optional: used to start an identity verification session if required
+     *     "acquisition_id": "<ACQUISITION_ID>"   // Required: ID needed to start document capture
+     *   }
+     * }
+     * ```
+     *
+     * To perform the document acquisition:
+     * 1. If a `start_token` is present, initialize the IDV SDK session:
+     *    ```javascript
+     *    if (response.data.start_token !== undefined) {
+     *      await idv.start(response.data.start_token);
+     *    }
+     *    ```
+     * 2. Run the document acquisition by calling the IDV SDK's `captureDocument()` method:
+     *    ```javascript
+     *    await idv.captureDocument({ acquisitionId: response.data.acquisition_id });
+     *    ```
+     *
+     * After acquiring the document, the client response does not need to include any data:
+     * ```javascript
+     * ido.submitClientResponse(ClientResponseOptionType.ClientInput);
+     * ```
+     *
+     * If an error occurs while capturing the document, the client should handle error states and inform the user
+     * and/or retry as appropriate according to application requirements.
+     *
+     * For deeper understanding and more implementation details, refer to the IDV SDK documentation:
+     * {@link https://developer.transmitsecurity.com/sdk-ref/idvsdk/overview IDV SDK Reference}
+     */
+    DocumentAcquisition = "transmit_platform_document_acquisition",
+    /**
+     * @description `journeyStepId` for IDV recommendation action.
+     *
+     * When this action is received, it indicates that identity verification (IDV) processing is being performed asynchronously on the backend.
+     * The client is responsible for implementing a polling mechanism: keep calling
+     * `ido.submitClientResponse(ClientResponseOptionType.ClientInput)` in a loop until the server responds with a new action or returns an error.
+     *
+     * Note: No data is provided by the server in the {@link IdoServiceResponse} object for this action at any time.
+     *
+     * It is recommended to show a blocking UI element (such as a loader or progress indicator) while polling,
+     * to inform the user that processing is ongoing.
+     *
+     * This process can take a couple of seconds. The recommended polling interval is every 1 second.
+     */
+    WaitForIdvRecommendations = "transmit_platform_idv_recommendation"
 }
 /**
  * @interface
@@ -818,7 +917,7 @@ interface IdoServiceResponse {
     readonly errorData?: IdoSdkError;
     /**
      * @description Contains the Journey step ID, allowing the client side to choose the correct handler and UI.
-     * This will be either a form ID for the "Get Information from Client" and "Login Form" journey steps,
+     * This will be either a form ID for the "Collect information" and "Login Form" journey steps,
      * or one of {@link IdoJourneyActionType} for other actions.
      */
     readonly journeyStepId?: IdoJourneyActionType | string;
@@ -852,7 +951,8 @@ interface IdoSdk {
      * @throws {@link ErrorCode.InvalidInitOptions} in case of invalid init options.
      * @example
      * // Initialize an instance of the Identity Orchestration SDK using the unified SDK
-     * await window.tsPlatform.initialize({
+     * import { initialize } from '@transmitsecurity/platform-web-sdk';
+     * initialize({
      *   clientId: 'my-client-id',
      *   ido: { serverPath: 'https://api.transmitsecurity.io/ido'}
      * });
@@ -869,7 +969,7 @@ interface IdoSdk {
      * @example
      * // Start a Journey with the id 'my-journey-id'
      * try {
-     *   const idoResponse = await window.tsPlatform.ido.startJourney('my-journey-id', { additionalParams: 'additionalParams' });
+     *   const idoResponse = await ido.startJourney('my-journey-id', { additionalParams: 'additionalParams' });
      *   // Handle Journey response
      * } catch(error) {
      *   switch(sdkError.errorCode) ...
@@ -886,7 +986,7 @@ interface IdoSdk {
      * @example
      * // Start a Journey with the Interaction ID '2456E855-05A0-4992-85C1-A2519CBB4AA7'
      * try {
-     *   const idoResponse = await window.tsPlatform.ido.startSsoJourney('2456E855-05A0-4992-85C1-A2519CBB4AA7');
+     *   const idoResponse = await ido.startSsoJourney('2456E855-05A0-4992-85C1-A2519CBB4AA7');
      *   // Handle Journey response
      * } catch(error) {
      *   switch(sdkError.errorCode) ...
@@ -915,7 +1015,7 @@ interface IdoSdk {
      *
      * // Submit the client input. The data inside the JSON correspond to the expected fields from the Journey step.
      * try {
-     *   const idoResponse = await window.tsPlatform.ido.submitClientResponse(selectedInputOption, {
+     *   const idoResponse = await ido.submitClientResponse(selectedInputOption, {
      *     'userEmail': 'user@input.email',
      *     'userPhone': '111-222-3333',
      *   });
@@ -932,7 +1032,7 @@ interface IdoSdk {
     serializeState(): string;
     /**
      * @description Restores the SDK state from a serialized state, can be used to recover from page redirects or refresh.
-     * The application code also receives the latest communication from the orchestration server.
+     * The application code also receives the latest communication from the Mosaic server.
      * @param state - The state to restore from.
      * @returns The last {@link IdoServiceResponse} that was received before the state was saved.
      * @throws {@link ErrorCode.InvalidState} - Throws error if the provided state string is invalid.
@@ -940,15 +1040,18 @@ interface IdoSdk {
     restoreFromSerializedState(state: string): IdoServiceResponse;
     /**
      * @description This method will generate a debug PIN
-     *  const debugPin = await sdk.generateDebugPin();
-     *  console.log(`Debug PIN: ${debugPin}`); // Output: Debug PIN: 1234
+     * const debugPin = await ido.generateDebugPin();
+     * console.log(`Debug PIN: ${debugPin}`); // Output: Debug PIN: 1234
      */
     generateDebugPin(): Promise<string>;
 }
 
 declare module "@transmit-security/web-sdk-common/dist/module-metadata/module-metadata" {
     interface initConfigParams {
-        ido?: IdoInitOptions;
+        ido?: {
+            serverPath?: string;
+            [key: string]: any;
+        };
     }
 }