@transmitsecurity/platform-web-sdk 1.16.1 → 1.17.0

package/bundler-config.json

@@ -1,14 +0,0 @@
-{
-  "exports": {
-    "drs": "@transmit-security/riskid_sdk",
-    "idv": "@transmit-security/ts-identity-verification",
-    "webauthn": "@transmit-security/authentication-sdk",
-    "ido": "@transmit-security/ido-web-sdk"
-  },
-  "exportsFromDefault": {},
-  "mainExport": "./build/mainExport",
-  "declarations": true,
-  "docs": true,
-  "minify": true,
-  "legacyBrowsers": true
-}

package/dist/docs/.nojekyll

@@ -1 +0,0 @@
-TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/dist/docs/README.md

@@ -1,72 +0,0 @@
-# Transmit Security Platform Web SDK
-
-A comprehensive browser-based identity and security solution with fraud prevention, WebAuthn authentication, identity verification, and orchestration capabilities.
-
-## Installation
-
-```bash
-npm install @transmitsecurity/platform-web-sdk
-```
-
-## Quick Start
-
-### Recommended Usage (Full SDK Import)
-
-```js
-import { drs, webauthn, idv, ido, initialize } from '@transmitsecurity/platform-web-sdk';
-
-// Single initialize call for all modules
-await initialize({
-  clientId: 'your-client-id',
-  drs: { serverPath: 'https://api.transmitsecurity.io/risk-collect/' },
-  webauthn: { serverPath: 'https://api.transmitsecurity.io' }
-});
-
-// Use the modules
-await drs.triggerActionEvent('login', { correlationId: 'example' });
-const isSupported = await webauthn.isPlatformAuthenticatorSupported();
-```
-
-### Individual Module Imports (Limited Support)
-
-⚠️ **Note**: Individual module imports have dependency resolution issues in some bundlers (like Vite). Use full SDK import for better compatibility.
-
-```js
-// May cause dependency resolution errors in some environments
-import { drs, initialize } from '@transmitsecurity/platform-web-sdk/drs';
-import { webauthn } from '@transmitsecurity/platform-web-sdk/webauthn';
-
-// Single initialize call
-await initialize({
-  clientId: 'your-client-id',
-  drs: { serverPath: 'https://api.transmitsecurity.io/risk-collect/' },
-  webauthn: { serverPath: 'https://api.transmitsecurity.io' }
-});
-```
-
-## Bundle Size
-
-The SDK is optimized for production use:
-- **Gzipped**: ~180KB
-- **Uncompressed**: ~565KB
-- **Tree-shaking**: Modern bundlers eliminate unused code automatically
-
-## Troubleshooting
-
-### Vite Dependency Resolution Errors
-
-If you encounter errors like "Could not resolve @transmit-security/web-sdk-common", see [VITE_CONFIG.md](./VITE_CONFIG.md) for detailed solutions.
-
-**Quick fix**: Use the full SDK import instead of individual module imports.
-
-### Other Bundlers
-
-For webpack, Rollup, or other bundlers, the full SDK import should work without additional configuration.
-
-## Documentation
-
-For complete documentation, visit: https://github.com/transmitsecurity-dev/ciam-web-sdk
-
-## License
-
-SEE LICENSE IN LICENSE

package/dist/docs/enums/ErrorCode.md

@@ -1,113 +0,0 @@
-# Enumeration: ErrorCode
-
-## Enumeration Members
-
-### NotInitialized
-
-• **NotInitialized** = ``"not_initialized"``
-
-Either the SDK init call failed or another function was called before initializing the SDK
-
-___
-
-### AuthenticationFailed
-
-• **AuthenticationFailed** = ``"authentication_failed"``
-
-When the call to [startAuthentication](../interfaces/WebauthnApis.md#startauthentication) failed
-
-___
-
-### AuthenticationAbortedTimeout
-
-• **AuthenticationAbortedTimeout** = ``"authentication_aborted_timeout"``
-
-When [authenticate.modal](../interfaces/WebauthnAuthenticationFlows.md#modal) or [authenticate.autofill.activate](../interfaces/AutofillHandlers.md#activate) is called and the modal is closed by the user
-
-___
-
-### AuthenticationCanceled
-
-• **AuthenticationCanceled** = ``"webauthn_authentication_canceled"``
-
-When [register](../modules.md#register) is called and the modal is closed when reaching the timeout
-
-___
-
-### RegistrationFailed
-
-• **RegistrationFailed** = ``"registration_failed"``
-
-When the call to [startRegistration](../interfaces/WebauthnApis.md#startregistration) failed
-
-___
-
-### AlreadyRegistered
-
-• **AlreadyRegistered** = ``"username_already_registered"``
-
-/ When The user attempted to register an authenticator that contains one of the credentials already registered with the relying party.
-
-___
-
-### RegistrationAbortedTimeout
-
-• **RegistrationAbortedTimeout** = ``"registration_aborted_timeout"``
-
-When [register](../modules.md#register) is called and the modal is closed by the user
-
-___
-
-### RegistrationCanceled
-
-• **RegistrationCanceled** = ``"webauthn_registration_canceled"``
-
-When [register](../modules.md#register) is called and the modal is closed when reaching the timeout
-
-___
-
-### AutofillAuthenticationAborted
-
-• **AutofillAuthenticationAborted** = ``"autofill_authentication_aborted"``
-
-Passkey autofill authentication was aborted by [abort](../interfaces/AutofillHandlers.md#abort)
-
-___
-
-### AuthenticationProcessAlreadyActive
-
-• **AuthenticationProcessAlreadyActive** = ``"authentication_process_already_active"``
-
-Passkey authentication is already active. To start a new authentication, abort the current one first by calling [abort](../interfaces/AutofillHandlers.md#abort)
-
-___
-
-### InvalidApprovalData
-
-• **InvalidApprovalData** = ``"invalid_approval_data"``
-
-The ApprovalData parameter was sent in the wrong format
-
-___
-
-### FailedToInitCrossDeviceSession
-
-• **FailedToInitCrossDeviceSession** = ``"cross_device_init_failed"``
-
-When the call to [initCrossDeviceAuthentication](../interfaces/WebauthnApis.md#initcrossdeviceauthentication)  failed
-
-___
-
-### FailedToGetCrossDeviceStatus
-
-• **FailedToGetCrossDeviceStatus** = ``"cross_device_status_failed"``
-
-When the call to [getCrossDeviceTicketStatus](../interfaces/WebauthnApis.md#getcrossdeviceticketstatus)  failed
-
-___
-
-### Unknown
-
-• **Unknown** = ``"unknown"``
-
-When the SDK operation fails on an unhandled error

package/dist/docs/interfaces/ActionEventOptions.md

@@ -1,44 +0,0 @@
-# Interface: ActionEventOptions
-
-## Properties
-
-### correlationId
-
-• `Optional` **correlationId**: `string`
-
-Any ID that could help relate the action with external context or session
-
-___
-
-### claimedUserId
-
-• `Optional` **claimedUserId**: `string`
-
-User ID of the not yet authenticated user, used to enhance risk and
-trust assessments. Once the user is authenticated,
-TSAccountProtection.setAuthenticatedUser should be called.
-
-___
-
-### claimedUserIdType
-
-• `Optional` **claimedUserIdType**: `string`
-
-The reported claimedUserId type (if provided), should not contain PII unless it is hashed.
-Supported values: email, phone_number, account_id, ssn, national_id, passport_number, drivers_license_number, other.
-
-___
-
-### transactionData
-
-• `Optional` **transactionData**: `TransactionData`
-
-A transaction data-points object for transaction-monitoring
-
-___
-
-### customAttributes
-
-• `Optional` **customAttributes**: `Record`<`string`, `string` \| `number` \| `boolean`\>
-
-Custom attributes matching the schema previously defined in the Admin Portal

package/dist/docs/interfaces/ActionResponse.md

@@ -1,9 +0,0 @@
-# Interface: ActionResponse
-
-## Properties
-
-### actionToken
-
-• `Optional` **actionToken**: `string`
-
-The token return by the SDK when the action was reported

package/dist/docs/interfaces/AuthenticationAutofillActivateHandlers.md

@@ -1,61 +0,0 @@
-# Interface: AuthenticationAutofillActivateHandlers
-
-## Properties
-
-### onSuccess
-
-• **onSuccess**: (`webauthn_encoded_result`: `string`) => `Promise`<`void`\>
-
-#### Type declaration
-
-▸ (`webauthn_encoded_result`): `Promise`<`void`\>
-
-A Callback function that will be triggered once biometrics signing is completed successfully.
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `webauthn_encoded_result` | `string` |
-
-##### Returns
-
-`Promise`<`void`\>
-
-___
-
-### onError
-
-• `Optional` **onError**: (`err`: [`SdkError`](SdkError.md)) => `Promise`<`void`\>
-
-#### Type declaration
-
-▸ (`err`): `Promise`<`void`\>
-
-A Callback function that will be triggered if authentication fails with an SdkError.
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `err` | [`SdkError`](SdkError.md) |
-
-##### Returns
-
-`Promise`<`void`\>
-
-___
-
-### onReady
-
-• `Optional` **onReady**: () => `void`
-
-#### Type declaration
-
-▸ (): `void`
-
-A Callback function that will be triggered when challenge excepted from the service and autofill is ready to use.
-
-##### Returns
-
-`void`

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