@transmitsecurity/platform-web-sdk 1.16.0 → 1.16.2

package/README.md

@@ -10,50 +10,69 @@ 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.
+For optimal tree-shaking and performance, import only the modules you need using the recommended namespace import pattern:
 
 ```js
-import { drs, webauthn, idv, ido, initialize } from '@transmitsecurity/platform-web-sdk';
+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 initialize call for all modules
-await initialize({
+// 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' }
+  webauthn: { serverPath: 'https://api.transmitsecurity.io' },
+  idv: { serverPath: 'https://api.transmitsecurity.io' },
+  ido: { serverPath: 'https://api.transmitsecurity.io' }
 });
 
-// Use the modules
+// Now all modules are initialized and ready to use
 await drs.triggerActionEvent('login', { correlationId: 'example' });
 const isSupported = await webauthn.isPlatformAuthenticatorSupported();
 ```
 
-### Individual Module Imports (Limited Support)
+### 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 using namespace import pattern (larger bundle size but simpler initialization):
 
 ```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 { * as sdk } from '@transmitsecurity/platform-web-sdk';
 
-// Single initialize call
-await initialize({
+// 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' }
 });
+
+// Use the modules
+await sdk.drs.triggerActionEvent('login', { correlationId: 'example' });
+const isSupported = await sdk.webauthn.isPlatformAuthenticatorSupported();
 ```
 
+### Alternative: Named Imports
+
+If your bundler supports it, you can use destructuring imports (though namespace imports are recommended for better TypeScript compatibility):
 
-### Other Bundlers
+```js
+import { drs, webauthn, idv, ido, initialize } from '@transmitsecurity/platform-web-sdk';
 
-For webpack, Rollup, or other bundlers, the full SDK import should work without additional configuration.
+// 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' }
+});
 
-## Documentation
+// Use the modules
+await drs.triggerActionEvent('login', { correlationId: 'example' });
+const isSupported = await webauthn.isPlatformAuthenticatorSupported();
+```
 
-For complete documentation, visit: https://developer.transmitsecurity.com/sdk-ref/sdk_ref_intro/
+⚠️ **Note**: The namespace import syntax `import { * as moduleName }` provides the best compatibility across different bundlers and avoids TypeScript typing issues.
 
 ## License
 

package/build/drs.d.ts

@@ -11,3 +11,18 @@ export declare const setUser: (...args: any[]) => any;
 export declare const setAuthenticatedUser: (...args: any[]) => any;
 export declare const clearUser: (...args: any[]) => any;
 export type { ActionEventOptions, ActionResponse } from "@transmit-security/riskid_sdk";
+
+// Default export for better TypeScript support
+declare const drs: {
+    initialize: typeof initialize;
+    triggerActionEvent: (...args: any[]) => any;
+    setUser: (...args: any[]) => any;
+    setAuthenticatedUser: (...args: any[]) => any;
+    clearUser: (...args: any[]) => any;
+    getSessionToken: (...args: any[]) => any;
+    getActions: (...args: any[]) => any;
+    identifyUser: (...args: any[]) => any;
+    unidentifiedUser: (...args: any[]) => any;
+};
+
+export default drs;

package/build/ido.d.ts

@@ -6,3 +6,13 @@ declare global {
 }
 export { initialize } from './initialize-only';
 export * from '@transmit-security/ido-web-sdk';
+
+// Default export for better TypeScript support
+declare const ido: {
+    initialize: typeof initialize;
+    startJourney: (...args: any[]) => any;
+    completeStep: (...args: any[]) => any;
+    getJourneyState: (...args: any[]) => any;
+};
+
+export default ido;

package/build/idv.d.ts

@@ -6,3 +6,13 @@ declare global {
 }
 export { initialize } from './initialize-only';
 export * from '@transmit-security/ts-identity-verification';
+
+// Default export for better TypeScript support
+declare const idv: {
+    initialize: typeof initialize;
+    startDocumentCapture: (...args: any[]) => any;
+    startFaceCapture: (...args: any[]) => any;
+    startSelfieCapture: (...args: any[]) => any;
+};
+
+export default idv;

package/build/webauthn.d.ts

@@ -10,3 +10,15 @@ export declare const authenticate: (...args: any[]) => any;
 export declare const register: (...args: any[]) => any;
 export declare const crossDevice: (...args: any[]) => any;
 export type { authenticate as authenticateType, WebauthnApis, WebauthnAuthenticationFlows, AutofillHandlers, AuthenticationAutofillActivateHandlers, WebauthnRegistrationOptions, isAutofillSupported, SdkError, ErrorCode, isPlatformAuthenticatorSupported, register as registerType, crossDevice as crossDeviceType, CrossDeviceController, WebauthnCrossDeviceRegistrationOptions, WebauthnCrossDeviceFlows, getDefaultPaths } from '@transmit-security/authentication-sdk';
+
+// Default export for better TypeScript support
+declare const webauthn: {
+    initialize: typeof initialize;
+    authenticate: (...args: any[]) => any;
+    register: (...args: any[]) => any;
+    crossDevice: (...args: any[]) => any;
+    isPlatformAuthenticatorSupported: (...args: any[]) => any;
+    isAutofillSupported: (...args: any[]) => any;
+};
+
+export default webauthn;

package/dist/docs/README.md

@@ -1,21 +1,23 @@
 # Transmit Security Platform Web SDK
 
-A comprehensive browser-based identity and security solution with fraud prevention, WebAuthn authentication, identity verification, and orchestration capabilities.
+A comprehensive browser-based identity and security solution for integrating with Mosaic's Fraud Prevention, WebAuthn authentication, Identity Verification, and Orchestration capabilities.
 
 ## Installation
 
 ```bash
-npm install @transmitsecurity/platform-web-sdk
+npm install @transmitsecurity/platform-web-sdk@^1
 ```
 
 ## Quick Start
 
-### Recommended Usage (Full SDK Import)
+### Individual Module Imports (Recommended)
+
+✅ **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/' },
@@ -27,46 +29,44 @@ 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.
-
+**Available individual imports**:
 ```js
-// May cause dependency resolution errors in some environments
+// Fraud Prevention (DRS)
 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
+// WebAuthn Authentication
+import { webauthn, initialize } from '@transmitsecurity/platform-web-sdk/webauthn';
 
-The SDK is optimized for production use:
-- **Gzipped**: ~180KB
-- **Uncompressed**: ~565KB
-- **Tree-shaking**: Modern bundlers eliminate unused code automatically
+// Identity Verification (IDV)
+import { idv, initialize } from '@transmitsecurity/platform-web-sdk/idv';
 
-## Troubleshooting
+// Identity Orchestration (IDO)
+import { ido, initialize } from '@transmitsecurity/platform-web-sdk/ido';
+```
 
-### Vite Dependency Resolution Errors
+### Full SDK Import
 
-If you encounter errors like "Could not resolve @transmit-security/web-sdk-common", see [VITE_CONFIG.md](./VITE_CONFIG.md) for detailed solutions.
+Import the entire SDK if you need multiple modules or prefer a single import.
 
-**Quick fix**: Use the full SDK import instead of individual module imports.
+```js
+import { drs, webauthn, idv, ido, initialize } from '@transmitsecurity/platform-web-sdk';
 
-### Other Bundlers
+// 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' }
+});
 
-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
 
-For complete documentation, visit: https://github.com/transmitsecurity-dev/ciam-web-sdk
+For complete documentation, visit: https://developer.transmitsecurity.com/sdk-ref/sdk_ref_intro/
 
-## License
+I## License
 
 SEE LICENSE IN LICENSE

package/dist/docs/modules.md

@@ -57,7 +57,7 @@ ___
 
 ### PACKAGE\_VERSION
 
-• `Const` **PACKAGE\_VERSION**: ``"1.16.0"``
+• `Const` **PACKAGE\_VERSION**: ``"1.16.1"``
 
 ## Functions