@transmitsecurity/platform-web-sdk 1.16.2 → 1.17.1

package/dist/docs/interfaces/AutofillHandlers.md

@@ -1,50 +0,0 @@
-# Interface: AutofillHandlers
-
-## Methods
-
-### activate
-
-▸ **activate**(`handlers`, `username?`): `void`
-
-Invokes a WebAuthn authentication, including prompting the user to select from a list of registered credentials using autofill, and then prompting the user for biometrics. In order to prompt this credentials list, the autocomplete="username webauthn" attribute **must** be defined on the username input box of the authentication page.<br/>
-If authentication is completed successfully, the `onSuccess` callback will be triggered with the credential result, which is an object encoded as a base64 string. This encoded result should then be passed to the [backend authentication endpoint](/openapi/user/backend-webauthn/#operation/authenticateWebauthnCredential) to retrieve user tokens.<br/>
-If it fails, the `onError` callback will be triggered with an SdkError.
-
-**`Throws`**
-
-[NotInitialized](../enums/ErrorCode.md#notinitialized)
-
-**`Throws`**
-
-[AuthenticationFailed](../enums/ErrorCode.md#authenticationfailed)
-
-**`Throws`**
-
-[AuthenticationCanceled](../enums/ErrorCode.md#authenticationcanceled)
-
-**`Throws`**
-
-[AutofillAuthenticationAborted](../enums/ErrorCode.md#autofillauthenticationaborted)
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `handlers` | [`AuthenticationAutofillActivateHandlers`](AuthenticationAutofillActivateHandlers.md) | Handlers that will be invoked once the authentication is completed (success or failure) |
-| `username?` | `string` | Name of user account, as used in the WebAuthn registration. If not provided, the authentication will start without the context of a user and it will be inferred by the chosen passkey |
-
-#### Returns
-
-`void`
-
-___
-
-### abort
-
-▸ **abort**(): `void`
-
-Aborts a WebAuthn authentication. This method should be called after the passkey autofill is dismissed in order to be able to query existing passkeys once again. This will end the browser's  `navigator.credentials.get()` operation.
-
-#### Returns
-
-`void`

package/dist/docs/interfaces/CrossDeviceController.md

@@ -1,27 +0,0 @@
-# Interface: CrossDeviceController
-
-WebAuthn cross device handlers interfaces
-
-## Properties
-
-### crossDeviceTicketId
-
-• **crossDeviceTicketId**: `string`
-
-Ticket ID for this cross-device flow.
-
-___
-
-### stop
-
-• **stop**: () => `void`
-
-#### Type declaration
-
-▸ (): `void`
-
-Stops listening for events from devices in cross-device flows
-
-##### Returns
-
-`void`

package/dist/docs/interfaces/SdkError.md

@@ -1,28 +0,0 @@
-# Interface: SdkError
-
-Common interface for `Promise` rejections.
-Developers should handle according to the `errorCode`
-
-## Properties
-
-### errorCode
-
-• `Readonly` **errorCode**: [`ErrorCode`](../enums/ErrorCode.md)
-
-Error code from [ErrorCode](../enums/ErrorCode.md)
-
-___
-
-### message
-
-• `Readonly` **message**: `string`
-
-Error message
-
-___
-
-### data
-
-• `Optional` `Readonly` **data**: `any`
-
-Additional data

package/dist/docs/interfaces/WebauthnApis.md

@@ -1,73 +0,0 @@
-# Interface: WebauthnApis
-
-Alternate paths used by the SDK to route API calls to your proxy server.
-
-## Properties
-
-### startAuthentication
-
-• **startAuthentication**: `string`
-
-**`Default Value`**
-
-`/v1/auth/webauthn/authenticate/start`
-
-___
-
-### startRegistration
-
-• **startRegistration**: `string`
-
-**`Default Value`**
-
-`/v1/auth/webauthn/register/start`
-
-___
-
-### startCrossDeviceRegistration
-
-• **startCrossDeviceRegistration**: `string`
-
-**`Default Value`**
-
-`/v1/auth/webauthn/cross-device/register/start`
-
-___
-
-### initCrossDeviceAuthentication
-
-• **initCrossDeviceAuthentication**: `string`
-
-**`Default Value`**
-
-`/v1/auth/webauthn/cross-device/authenticate/init`
-
-___
-
-### startCrossDeviceAuthentication
-
-• **startCrossDeviceAuthentication**: `string`
-
-**`Default Value`**
-
-`/v1/auth/webauthn/cross-device/authenticate/start`
-
-___
-
-### getCrossDeviceTicketStatus
-
-• **getCrossDeviceTicketStatus**: `string`
-
-**`Default Value`**
-
-`/v1/auth/webauthn/cross-device/status`
-
-___
-
-### attachDeviceToCrossDeviceSession
-
-• **attachDeviceToCrossDeviceSession**: `string`
-
-**`Default Value`**
-
-`/v1/auth/webauthn/cross-device/attach-device`

package/dist/docs/interfaces/WebauthnAuthenticationFlows.md

@@ -1,52 +0,0 @@
-# Interface: WebauthnAuthenticationFlows
-
-## Methods
-
-### modal
-
-▸ **modal**(`username?`, `options?`): `Promise`<`string`\>
-
-Invokes a WebAuthn authentication, including prompting the user to select from a list of registered credentials, and then prompting the user for biometrics. The credentials list is displayed using the native browser modal.<br/>
-If username isn't provided, it will promote a modal with a list of all discoverable credentials on the device. If username is provided, this call must be invoked for a registered username. If the target username is not registered or in case of any other failure, an SdkError will be thrown.<br/>
-If authentication is completed successfully, this call will return a promise that resolves to the credential result, which is an object encoded as a base64 string. This encoded result should then be passed to the [backend authentication endpoint](/openapi/user/backend-webauthn/#operation/authenticateWebauthnCredential) to retrieve user tokens.<br/>
-
-**`Throws`**
-
-[NotInitialized](../enums/ErrorCode.md#notinitialized)
-
-**`Throws`**
-
-[AuthenticationFailed](../enums/ErrorCode.md#authenticationfailed)
-
-**`Throws`**
-
-[AuthenticationCanceled](../enums/ErrorCode.md#authenticationcanceled)
-
-**`Throws`**
-
-[InvalidApprovalData](../enums/ErrorCode.md#invalidapprovaldata)
-
-**`Throws`**
-
-[AuthenticationProcessAlreadyActive](../enums/ErrorCode.md#authenticationprocessalreadyactive)
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `username?` | `string` | Name of user account, as used in the WebAuthn registration. If not provided, the authentication will start without the context of a user and it will be inferred by the chosen passkey |
-| `options?` | `WebauthnAuthenticationOptions` | WebauthnAuthenticationOptions Options for the authentication process |
-
-#### Returns
-
-`Promise`<`string`\>
-
-Base64-encoded object, which contains the credential result. This encoded result will be used to fetch user tokens via the [backend authentication endpoint](/openapi/user/backend-webauthn/#operation/authenticateWebauthnCredential).
-
-## Properties
-
-### autofill
-
-• **autofill**: [`AutofillHandlers`](AutofillHandlers.md)
-
-Property used to implement credential selection via autofill UI.

package/dist/docs/interfaces/WebauthnCrossDeviceFlows.md

@@ -1,107 +0,0 @@
-# Interface: WebauthnCrossDeviceFlows
-
-## Properties
-
-### init
-
-• **init**: `Object`
-
-Initializes a cross device flow, such as when users request to login to a desktop using their mobile device. Once invoked, the SDK will start listening for events occurring on the other device,
-and calls your handlers when a state change is detected.
-These methods return a promise that resolves to a [CrossDeviceController](CrossDeviceController.md) object, which allows you to stop listening to events and includes the cross-device ticket ID which is used when attaching another device to the flow.
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `registration` | (`params`: { `crossDeviceTicketId`: `string` ; `handlers`: `CrossDeviceRegistrationHandlers`  }) => `Promise`<[`CrossDeviceController`](CrossDeviceController.md)\> |
-| `authentication` | (`params`: { `username?`: `string` ; `handlers`: `CrossDeviceAuthenticationHandlers`  }) => `Promise`<[`CrossDeviceController`](CrossDeviceController.md)\> |
-| `approval` | (`params`: { `username`: `string` ; `approvalData`: `Record`<`string`, `string`\> ; `handlers`: `CrossDeviceAuthenticationHandlers`  }) => `Promise`<[`CrossDeviceController`](CrossDeviceController.md)\> |
-
-___
-
-### authenticate
-
-• **authenticate**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `modal` | (`crossDeviceTicketId`: `string`) => `Promise`<`string`\> |
-
-___
-
-### approve
-
-• **approve**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `modal` | (`crossDeviceTicketId`: `string`) => `Promise`<`string`\> |
-
-___
-
-### register
-
-• **register**: (`crossDeviceTicketId`: `string`, `options?`: [`WebauthnCrossDeviceRegistrationOptions`](WebauthnCrossDeviceRegistrationOptions.md)) => `Promise`<`string`\>
-
-#### Type declaration
-
-▸ (`crossDeviceTicketId`, `options?`): `Promise`<`string`\>
-
-Invokes a WebAuthn credential registration for the user used in the cross device session init, including prompting the user for biometrics.
-If registration is completed successfully, this call will return a promise that resolves to the credential result, which is an object encoded as a base64 string. This encoded result should then be passed to the relevant backend registration endpoint to complete the registration for either a [logged-in user](/openapi/user/backend-webauthn/#operation/webauthn-registration) or [logged-out user](/openapi/user/backend-webauthn/#operation/webauthn-registration-external).
-If registration fails, an SdkError will be thrown.
-If the backend registration call was successful, CrossDeviceRegistrationHandlers.onCredentialRegister will be called.
-
-**`Throws`**
-
-[NotInitialized](../enums/ErrorCode.md#notinitialized)
-
-**`Throws`**
-
-[RegistrationFailed](../enums/ErrorCode.md#registrationfailed)
-
-**`Throws`**
-
-[RegistrationCanceled](../enums/ErrorCode.md#registrationcanceled)
-
-##### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `crossDeviceTicketId` | `string` | Ticket ID of the cross-device flow. retrieved from the [CrossDeviceController](CrossDeviceController.md) object. |
-| `options?` | [`WebauthnCrossDeviceRegistrationOptions`](WebauthnCrossDeviceRegistrationOptions.md) | Additional configuration for registration flow |
-
-##### Returns
-
-`Promise`<`string`\>
-
-___
-
-### attachDevice
-
-• **attachDevice**: (`crossDeviceTicketId`: `string`) => `Promise`<`AttachDeviceResult`\>
-
-#### Type declaration
-
-▸ (`crossDeviceTicketId`): `Promise`<`AttachDeviceResult`\>
-
-Indicates when a session is accepted on another device in cross-device flows.
-
-If successful,CrossDeviceRegistrationHandlers.onDeviceAttach will be called in registration flow and CrossDeviceAuthenticationHandlers.onDeviceAttach for authentication.
-
-##### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `crossDeviceTicketId` | `string` | Ticket ID of the cross-device flow. retrieved from the [CrossDeviceController](CrossDeviceController.md) object. |
-
-##### Returns
-
-`Promise`<`AttachDeviceResult`\>
-
-AttachDeviceResult AttachDeviceResult. Object containing the ticket status, creation timestamp, and approval data (if passed in the init.authentication() call)

package/dist/docs/interfaces/WebauthnCrossDeviceRegistrationOptions.md

@@ -1,23 +0,0 @@
-# Interface: WebauthnCrossDeviceRegistrationOptions
-
-## Hierarchy
-
-- **`WebauthnCrossDeviceRegistrationOptions`**
-
-  ↳ [`WebauthnRegistrationOptions`](WebauthnRegistrationOptions.md)
-
-## Properties
-
-### allowCrossPlatformAuthenticators
-
-• `Optional` **allowCrossPlatformAuthenticators**: `boolean`
-
-Allow registration using cross-platform authenticators, such as a USB security key or a different device. If enabled, cross-device authentication flows can be performed using the native browser experience (via QR code). default: True
-
-___
-
-### registerAsDiscoverable
-
-• `Optional` **registerAsDiscoverable**: `boolean`
-
-Must be set to true to register credentials as passkeys when supported (except for Apple devices, which always register credentials as passkeys). default: True

package/dist/docs/interfaces/WebauthnRegistrationOptions.md

@@ -1,55 +0,0 @@
-# Interface: WebauthnRegistrationOptions
-
-## Hierarchy
-
-- [`WebauthnCrossDeviceRegistrationOptions`](WebauthnCrossDeviceRegistrationOptions.md)
-
-  ↳ **`WebauthnRegistrationOptions`**
-
-## Properties
-
-### allowCrossPlatformAuthenticators
-
-• `Optional` **allowCrossPlatformAuthenticators**: `boolean`
-
-Allow registration using cross-platform authenticators, such as a USB security key or a different device. If enabled, cross-device authentication flows can be performed using the native browser experience (via QR code). default: True
-
-#### Inherited from
-
-[WebauthnCrossDeviceRegistrationOptions](WebauthnCrossDeviceRegistrationOptions.md).[allowCrossPlatformAuthenticators](WebauthnCrossDeviceRegistrationOptions.md#allowcrossplatformauthenticators)
-
-___
-
-### registerAsDiscoverable
-
-• `Optional` **registerAsDiscoverable**: `boolean`
-
-Must be set to true to register credentials as passkeys when supported (except for Apple devices, which always register credentials as passkeys). default: True
-
-#### Inherited from
-
-[WebauthnCrossDeviceRegistrationOptions](WebauthnCrossDeviceRegistrationOptions.md).[registerAsDiscoverable](WebauthnCrossDeviceRegistrationOptions.md#registerasdiscoverable)
-
-___
-
-### displayName
-
-• `Optional` **displayName**: `string`
-
-Human-palatable name for the user account, only for display (max 64 characters). If not set, the username parameter will also act as the display name
-
-___
-
-### timeout
-
-• `Optional` **timeout**: `number`
-
-The timeout in seconds for the registration process. If the timeout is reached, the registration process will be aborted with error [RegistrationAbortedTimeout](../enums/ErrorCode.md#registrationabortedtimeout).
-
-___
-
-### limitSingleCredentialToDevice
-
-• `Optional` **limitSingleCredentialToDevice**: `boolean`
-
-Set to True in order to limit the creation of multiple credentials for the same account on a single authenticator. default: False

package/dist/docs/interfaces/initConfigParams.md

@@ -1,7 +0,0 @@
-# Interface: initConfigParams
-
-## Properties
-
-### clientId
-
-• **clientId**: `string`

package/dist/docs/modules/drs.md

@@ -1,92 +0,0 @@
-# Namespace: drs
-
-## Type Aliases
-
-### ActionEventOptions
-
-Ƭ **ActionEventOptions**: [`ActionEventOptions`](../interfaces/ActionEventOptions.md)
-
-___
-
-### ActionResponse
-
-Ƭ **ActionResponse**: [`ActionResponse`](../interfaces/ActionResponse.md)
-
-## Variables
-
-### \_\_internal
-
-• `Const` **\_\_internal**: typeof `__internal`
-
-## Functions
-
-### clearUser
-
-▸ **clearUser**(`options?`): `Promise`<`boolean`\>
-
-Clears the user context for all subsequent events in the browser session
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `options?` | `Object` | Reserved for future use |
-
-#### Returns
-
-`Promise`<`boolean`\>
-
-Indicates if the call succeeded
-
-___
-
-### getSessionToken
-
-▸ **getSessionToken**(): `Promise`<`any`\>
-
-#### Returns
-
-`Promise`<`any`\>
-
-___
-
-### setAuthenticatedUser
-
-▸ **setAuthenticatedUser**(`userId`, `options?`): `Promise`<`boolean`\>
-
-Sets the user context for all subsequent events in the browser session (or until the user is explicitly cleared)
-It should be set only after you've fully authenticated the user (including, for example, any 2FA that was required)
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `userId` | `string` | Opaque identifier of the user in your system |
-| `options?` | `Object` | Reserved for future use |
-
-#### Returns
-
-`Promise`<`boolean`\>
-
-Indicates if the call succeeded
-
-___
-
-### triggerActionEvent
-
-▸ **triggerActionEvent**(`actionType`, `options?`): `Promise`<[`ActionResponse`](../interfaces/ActionResponse.md)\>
-
-Reports a user action event to the SDK
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `actionType` | `string` | Type of user action event that was predefined in the Transmit Security server |
-| `options?` | [`ActionEventOptions`](../interfaces/ActionEventOptions.md) | - |
-
-#### Returns
-
-`Promise`<[`ActionResponse`](../interfaces/ActionResponse.md)\>
-
-Indicates if the call succeeded

package/dist/docs/modules/idv.md

@@ -1,106 +0,0 @@
-# Namespace: idv
-
-## Functions
-
-### recapture
-
-▸ **recapture**(): `Promise`<`boolean`\>
-
-Recaptures the required images in case the `recapture` status is returned. For example, this may occur in case some data
-couldn't be extracted due to poor image quality.
-
-**`Function`**
-
-recapture
-
-**`Memberof`**
-
-module:core
-
-**`Example`**
-
-```ts
-const showLoader = true;
-tsPlatform.idv.recapture().then((success) => {
- showLoader = false;
- if (success) {
-   console.log('Recapture started');
- } else {
-   console.log('Recapture not started');
- }
-});
-```
-
-#### Returns
-
-`Promise`<`boolean`\>
-
-Indicates if the session was started successfully
-
-___
-
-### restart
-
-▸ **restart**(): `Promise`<`boolean`\>
-
-deprecated use module:tsPlatform.idv.recapture|recapture instead
-TODO: [VER-3126](https://transmitsecurity.atlassian.net/browse/VER-3126)
-
-#### Returns
-
-`Promise`<`boolean`\>
-
-___
-
-### start
-
-▸ **start**(`startToken?`): `Promise`<`boolean`\>
-
-Starts a verification session that was created in the backend (via the [Verification API](/openapi/verify/verifications/#operation/createSession)).
-This will start the verification process for the user and guides them through the entire identity verification flow
-using the Transmit identity verification experience, which includes capturing the required images and submitting them for processing.
-
-**`Function`**
-
-start
-
-**`Memberof`**
-
-module:core
-
-**`Example`**
-
-```ts
-const showLoader = true;
-const startToken = '123456'; // start_token returned by the backend upon session creation
-tsPlatform.idv.start(startToken).then((started) => {
- showLoader = false;
- if (started) {
-   console.log('Session started');
- } else {
-   console.log('Session not started');
- }
-});
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `startToken?` | `string` | The start_token returned by the backend when the session was created, used to bind the session to the device |
-
-#### Returns
-
-`Promise`<`boolean`\>
-
-Indicates if the session was started successfully
-
-___
-
-### version
-
-▸ **version**(): `string`
-
-#### Returns
-
-`string`