@transmitsecurity/platform-web-sdk 1.16.2 → 1.17.0

package/CHANGELOG.md

@@ -1,4 +1,14 @@
 # Changelog
+## 1.16.4 -  Aug. 3, 2025
+* fix: Crypto binding - resolved initialization issue in Safari
+* feat: Improved error handling - provide detailed reasons when the RiskID-SDK is disabled.
+
+## 1.16.3 -  Jul. 13, 2025
+* feat: Deploy a fix for Orchestration (ido) sdk
+
+## 1.16.2 -  Jul. 13, 2025
+* feat: Add NPM support for Platform SDK
+
 ## 1.15.0 -  Jun. 29, 2025
 **Fraud Prevention**
 * feat: Add support for rotating crypto-binding keys
@@ -11,11 +21,9 @@
 **Fraud Prevention**
 * feat: Add support for passing custom attributes to the `triggerActionEvent`
 
-
 ## 1.13.7 -  Jun. 8, 2025
 **Identity Verification**
 * Correct and update UI texts
-* 
 
 ## 1.13.6 -  May 25, 2025
 * fix: prevent race condition during crypto binding keys generation

package/README.md

@@ -1,79 +1,100 @@
 # Transmit Security Platform Web SDK
 
-A comprehensive browser-based identity and security solution for integrating with Mosaic's Fraud Prevention, WebAuthn authentication, Identity Verification, and Orchestration capabilities.
+A comprehensive browser-based identity and security solution with fraud prevention, WebAuthn authentication, identity verification, and orchestration capabilities.
 
 ## Installation
 
+### NPM Package (Recommended)
 ```bash
-npm install @transmitsecurity/platform-web-sdk@^1
+npm install @transmitsecurity/platform-web-sdk
 ```
+## Usage Patterns
 
-## Quick Start
+#### Individual Module Imports (Recommended)
+For optimal bundle sizes and performance, import only the modules you need:
 
-### Individual Module Imports (Recommended)
+```javascript
+// Option 1: Individual function imports (best for tree-shaking)
+import { triggerActionEvent, setUser, clearUser, initialize } from '@transmitsecurity/platform-web-sdk/drs';
+import { isPlatformAuthenticatorSupported, register } from '@transmitsecurity/platform-web-sdk/webauthn';
+import { start } from '@transmitsecurity/platform-web-sdk/idv';
 
-For optimal tree-shaking and performance, import only the modules you need using the recommended namespace import pattern:
+// Use modules (syntax depends on import method)
+// Option 1: Direct function calls
+await triggerActionEvent('login', { correlationId: 'example' });
+await setUser({ userId: 'user123' });
+const isSupported = await isPlatformAuthenticatorSupported();
 
-```js
-import { * as drs } from '@transmitsecurity/platform-web-sdk/drs';
-import { * as webauthn } from '@transmitsecurity/platform-web-sdk/webauthn';
-import { * as idv } from '@transmitsecurity/platform-web-sdk/idv';
-import { * as ido } from '@transmitsecurity/platform-web-sdk/ido';
-
-// Single global initialize call with all module configurations
-await drs.initialize({
-  clientId: 'your-client-id',
-  drs: { serverPath: 'https://api.transmitsecurity.io/risk-collect/' },
-  webauthn: { serverPath: 'https://api.transmitsecurity.io' },
-  idv: { serverPath: 'https://api.transmitsecurity.io' },
-  ido: { serverPath: 'https://api.transmitsecurity.io' }
-});
-
-// Now all modules are initialized and ready to use
+// Option 2: Namespace calls
 await drs.triggerActionEvent('login', { correlationId: 'example' });
+await drs.setUser({ userId: 'user123' });
 const isSupported = await webauthn.isPlatformAuthenticatorSupported();
 ```
 
-### Full SDK Import
-
-Import the entire SDK using namespace import pattern (larger bundle size but simpler initialization):
 
-```js
-import { * as sdk } from '@transmitsecurity/platform-web-sdk';
+```javascript
+import { ido, ClientResponseOptionType } from '@transmitsecurity/platform-web-sdk/ido';
+import { initialize } from '@transmitsecurity/platform-web-sdk';
 
-// Single initialize call for all modules
-await sdk.initialize({
-  clientId: 'your-client-id',
-  drs: { serverPath: 'https://api.transmitsecurity.io/risk-collect/' },
-  webauthn: { serverPath: 'https://api.transmitsecurity.io' }
+// Initialize
+await initialize({
+    clientId: 'your-client-id',
+    ido: { serverPath: 'https://api.transmitsecurity.io' }
 });
 
-// Use the modules
-await sdk.drs.triggerActionEvent('login', { correlationId: 'example' });
-const isSupported = await sdk.webauthn.isPlatformAuthenticatorSupported();
+// IDO usage
+await ido.startJourney('journey-id');
+await ido.submitClientResponse(
+    ClientResponseOptionType.ClientInput,
+    { userEmail: 'user@example.com' }
+);
 ```
 
-### Alternative: Named Imports
+#### TypeScript Support
+Full TypeScript support with individual module imports:
+
+```typescript
+import { triggerActionEvent, setUser } from '@transmitsecurity/platform-web-sdk/drs';
+import { isPlatformAuthenticatorSupported } from '@transmitsecurity/platform-web-sdk/webauthn';
+import { start } from '@transmitsecurity/platform-web-sdk/idv';
+import { ido } from '@transmitsecurity/platform-web-sdk/ido';
+import { initialize } from '@transmitsecurity/platform-web-sdk';
+
+// Initialize with TypeScript types
+await initialize({
+    clientId: 'your-client-id',
+    drs: { serverPath: 'https://api.transmitsecurity.io/risk-collect/' },
+    webauthn: { serverPath: 'https://api.transmitsecurity.io' },
+    idv: { serverPath: 'https://api.transmitsecurity.io' },
+    ido: { 
+        serverPath: 'https://api.transmitsecurity.io',
+    }
+});
+
+// Use with proper TypeScript types
+await triggerActionEvent('login', { correlationId: 'example' });
+const isSupported: boolean = await isPlatformAuthenticatorSupported();
+await ido.default.submitClientResponse(
+    ClientResponseOptionType.ClientInput,
+    { userEmail: 'user@example.com' }
+);
+```
 
-If your bundler supports it, you can use destructuring imports (though namespace imports are recommended for better TypeScript compatibility):
+#### Full SDK Import (Alternative)
+If you need multiple modules, you can also import the full SDK:
 
-```js
+```javascript
 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' }
+    clientId: 'your-client-id',
+    drs: { serverPath: 'https://api.transmitsecurity.io/risk-collect/' },
+    webauthn: { serverPath: 'https://api.transmitsecurity.io' },
+    idv: { serverPath: 'https://api.transmitsecurity.io' },
+    ido: { serverPath: 'https://api.transmitsecurity.io' }
 });
 
-// Use the modules
+// Use modules through the main object
 await drs.triggerActionEvent('login', { correlationId: 'example' });
-const isSupported = await webauthn.isPlatformAuthenticatorSupported();
 ```
-
-⚠️ **Note**: The namespace import syntax `import { * as moduleName }` provides the best compatibility across different bundlers and avoids TypeScript typing issues.
-
-## License
-
-SEE LICENSE IN LICENSE