@transmitsecurity/platform-web-sdk 1.16.0 → 1.16.1

package/README.md

@@ -10,14 +10,14 @@ npm install @transmitsecurity/platform-web-sdk@^1
 
 ## Quick Start
 
-### Full SDK Import
+### Individual Module Imports (Recommended)
 
-Import the entire SDK or leverage tree-shaking capabilities to import individual modules.
+✅ **Recommended**: Import only the modules you need for optimal bundle size and faster loading.
 
 ```js
-import { drs, webauthn, idv, ido, initialize } from '@transmitsecurity/platform-web-sdk';
+import { drs, initialize } from '@transmitsecurity/platform-web-sdk/drs';
+import { webauthn } from '@transmitsecurity/platform-web-sdk/webauthn';
 
-// Single initialize call for all modules
 await initialize({
   clientId: 'your-client-id',
   drs: { serverPath: 'https://api.transmitsecurity.io/risk-collect/' },
@@ -29,27 +29,39 @@ await drs.triggerActionEvent('login', { correlationId: 'example' });
 const isSupported = await webauthn.isPlatformAuthenticatorSupported();
 ```
 
-### Individual Module Imports (Limited Support)
+**Available individual imports**:
+```js
+// Fraud Prevention (DRS)
+import { drs, initialize } from '@transmitsecurity/platform-web-sdk/drs';
+
+// WebAuthn Authentication
+import { webauthn, initialize } from '@transmitsecurity/platform-web-sdk/webauthn';
+
+// Identity Verification (IDV)
+import { idv, initialize } from '@transmitsecurity/platform-web-sdk/idv';
+
+// Identity Orchestration (IDO)
+import { ido, initialize } from '@transmitsecurity/platform-web-sdk/ido';
+```
+
+### Full SDK Import
 
-⚠️ **Note**: Individual module imports have dependency resolution issues in some bundlers (like Vite). Use full SDK import for better compatibility.
+Import the entire SDK if you need multiple modules or prefer a single import.
 
 ```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';
+import { drs, webauthn, idv, ido, initialize } from '@transmitsecurity/platform-web-sdk';
 
-// Single initialize call
+// 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' }
 });
-```
 
-
-### Other Bundlers
-
-For webpack, Rollup, or other bundlers, the full SDK import should work without additional configuration.
+// Use the modules
+await drs.triggerActionEvent('login', { correlationId: 'example' });
+const isSupported = await webauthn.isPlatformAuthenticatorSupported();
+```
 
 ## Documentation