Migration to v2.x

This guide helps you migrate your Platform SDK integration from version 1.x to version 2.x.

Version 2 introduces several improvements to the SDK architecture and configuration.

Breaking changes:

• The serverPath parameter becomes mandatory for all SDK modules.
• Fraud Prevention is disabled by default and must be explicitly initialized.
• Deprecating Fraud Prevention functions: unidentifiedUser(), identifyUser() and setUser().
• Webauthn methods were refactored to use a single parameter object pattern instead of multiple positional parameters.

Changes:

• The Orchestration (IDO) module now uses separate typing files.

The serverPath parameter is now mandatory for all SDK modules. Review all initialize() calls and add serverPath for each module you use.

Before (v1):

await initialize({
  clientId: 'your-client-id',
  ido: {
    // serverPath was optional, defaulted to US region
  }
});

After (v2.x):

await initialize({
  clientId: 'your-client-id',
  ido: {
    serverPath: 'https://api.transmitsecurity.io/ido' // Required
  }
});

Use the appropriate serverPath for your environment:

In v2.x, Fraud Prevention is disabled by default and must be explicitly initialized if your application relies on it. Add the drs module configuration to your initialize() call:

Before (v1):

await initialize({
  clientId: 'your-client-id',
  // Fraud Prevention was initialized automatically
});

After (v2.x):

await initialize({
  clientId: 'your-client-id',
  drs: {
    serverPath: 'https://api.transmitsecurity.io/risk-collect/' // Explicit initialization required
  }
});

If your application uses any of the following Fraud Prevention functions, update them to the new names:

See Fraud Prevention SDK reference for details.

WebAuthn methods have been refactored to use a single parameter object instead of multiple positional parameters:

Before (v1):

webauthn.register('user@email.com', { displayName: 'Display Name' });

After (v2.x):

webauthn.register({ username: 'user@email.com', options: { displayName: 'Display Name' } });

See WebAuthn SDK reference for the updated method signatures.

The Orchestration (IDO) module now uses separate typing files. If your TypeScript application imports IDO types, update the import paths:

Before (v1):

import { IdoServiceResponse, ClientResponseOptionType } from '@transmitsecurity/platform-web-sdk';

After (v2.x):

import type { IdoServiceResponse, ClientResponseOptionType } from '@transmitsecurity/platform-web-sdk/ido';

Update the SDK package or CDN script to version 2:

• NPM: Update to @transmitsecurity/platform-web-sdk@^2
• CDN: Change script URL from 1.x to 2.x

• Verify all SDK functionality works as expected
• Check browser console for any initialization errors