@transmitsecurity/platform-web-sdk 1.15.0

package/dist/docs/interfaces/WebauthnCrossDeviceFlows.md

@@ -0,0 +1,107 @@
+# 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

@@ -0,0 +1,23 @@
+# 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

@@ -0,0 +1,55 @@
+# 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

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

package/dist/docs/modules/drs.md

@@ -0,0 +1,92 @@
+# 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

@@ -0,0 +1,106 @@
+# 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`

package/dist/docs/modules/webauthn.md

@@ -0,0 +1,197 @@
+# Namespace: webauthn
+
+## Type Aliases
+
+### ApiCrossDeviceStatusResponse
+
+Ƭ **ApiCrossDeviceStatusResponse**: `ApiCrossDeviceStatusResponse`
+
+___
+
+### AttachDeviceResult
+
+Ƭ **AttachDeviceResult**: `AttachDeviceResult`
+
+___
+
+### AuthenticationAutofillActivateHandlers
+
+Ƭ **AuthenticationAutofillActivateHandlers**: [`AuthenticationAutofillActivateHandlers`](../interfaces/AuthenticationAutofillActivateHandlers.md)
+
+___
+
+### AutofillHandlers
+
+Ƭ **AutofillHandlers**: [`AutofillHandlers`](../interfaces/AutofillHandlers.md)
+
+___
+
+### CrossDeviceAuthenticationHandlers
+
+Ƭ **CrossDeviceAuthenticationHandlers**: `CrossDeviceAuthenticationHandlers`
+
+___
+
+### CrossDeviceController
+
+Ƭ **CrossDeviceController**: [`CrossDeviceController`](../interfaces/CrossDeviceController.md)
+
+___
+
+### CrossDeviceRegistrationHandlers
+
+Ƭ **CrossDeviceRegistrationHandlers**: `CrossDeviceRegistrationHandlers`
+
+___
+
+### SdkError
+
+Ƭ **SdkError**: [`SdkError`](../interfaces/SdkError.md)
+
+___
+
+### WebauthnApis
+
+Ƭ **WebauthnApis**: [`WebauthnApis`](../interfaces/WebauthnApis.md)
+
+___
+
+### WebauthnApprovalFlows
+
+Ƭ **WebauthnApprovalFlows**: `WebauthnApprovalFlows`
+
+___
+
+### WebauthnAuthenticationFlows
+
+Ƭ **WebauthnAuthenticationFlows**: [`WebauthnAuthenticationFlows`](../interfaces/WebauthnAuthenticationFlows.md)
+
+___
+
+### WebauthnAuthenticationOptions
+
+Ƭ **WebauthnAuthenticationOptions**: `WebauthnAuthenticationOptions`
+
+___
+
+### WebauthnCrossDeviceFlows
+
+Ƭ **WebauthnCrossDeviceFlows**: [`WebauthnCrossDeviceFlows`](../interfaces/WebauthnCrossDeviceFlows.md)
+
+___
+
+### WebauthnCrossDeviceRegistrationOptions
+
+Ƭ **WebauthnCrossDeviceRegistrationOptions**: [`WebauthnCrossDeviceRegistrationOptions`](../interfaces/WebauthnCrossDeviceRegistrationOptions.md)
+
+___
+
+### WebauthnCrossDeviceStatus
+
+Ƭ **WebauthnCrossDeviceStatus**: `WebauthnCrossDeviceStatus`
+
+___
+
+### WebauthnRegistrationOptions
+
+Ƭ **WebauthnRegistrationOptions**: [`WebauthnRegistrationOptions`](../interfaces/WebauthnRegistrationOptions.md)
+
+## Variables
+
+### WebauthnCrossDeviceStatus
+
+• **WebauthnCrossDeviceStatus**: typeof `WebauthnCrossDeviceStatus`
+
+___
+
+### approve
+
+• `Const` **approve**: typeof `approve`
+
+___
+
+### authenticate
+
+• `Const` **authenticate**: typeof [`authenticate`](../modules.md#authenticate)
+
+___
+
+### crossDevice
+
+• `Const` **crossDevice**: typeof [`crossDevice`](../modules.md#crossdevice)
+
+## Functions
+
+### getDefaultPaths
+
+▸ **getDefaultPaths**(): [`WebauthnApis`](../interfaces/WebauthnApis.md)
+
+Returns the default API paths for webauthn
+
+#### Returns
+
+[`WebauthnApis`](../interfaces/WebauthnApis.md)
+
+___
+
+### isAutofillSupported
+
+▸ **isAutofillSupported**(): `Promise`<`boolean`\>
+
+Indicates whether this browser supports Passkey Autofill
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+___
+
+### isPlatformAuthenticatorSupported
+
+▸ **isPlatformAuthenticatorSupported**(): `Promise`<`boolean`\>
+
+Indicates whether this browser supports WebAuthn, and has a platform authenticator
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+___
+
+### register
+
+▸ **register**(`username`, `options?`): `Promise`<`string`\>
+
+Invokes a WebAuthn credential registration for the specified user, 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.
+
+**`Throws`**
+
+[NotInitialized](../enums/ErrorCode.md#notinitialized)
+
+**`Throws`**
+
+[RegistrationFailed](../enums/ErrorCode.md#registrationfailed)
+
+**`Throws`**
+
+[RegistrationCanceled](../enums/ErrorCode.md#registrationcanceled)
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `username` | `string` | WebAuthn username to register |
+| `options?` | [`WebauthnRegistrationOptions`](../interfaces/WebauthnRegistrationOptions.md) | Additional configuration for registration flow |
+
+#### Returns
+
+`Promise`<`string`\>
+
+## References
+
+### ErrorCode
+
+Re-exports [ErrorCode](../enums/ErrorCode.md)