unshared-frontend-sdk 2.0.0-rc.3 → 2.0.0-rc.5

package/README.md

@@ -10,12 +10,7 @@ Browser SDK for [Unshared Labs](https://unsharedlabs.com) — collects a device
 npm install unshared-frontend-sdk
 ```
 
-Or via CDN (no build step):
-
-```html
-<script src="https://unpkg.com/unshared-frontend-sdk/dist/index.umd.js"></script>
-<!-- Available as window.UnsharedLabsBrowser -->
-```
+Or via CDN (no build step) — see [CDN / UMD usage](#cdn--umd-usage) below for the complete example.
 
 ---
 
@@ -24,14 +19,12 @@ Or via CDN (no build step):
 ```typescript
 import { UnsharedLabsBrowser } from 'unshared-frontend-sdk';
 
-// Cross-origin: point at your backend
-const client = new UnsharedLabsBrowser({
-  baseUrl: 'https://yourapp.com', // your backend, not Unshared Labs
-});
-
-// Same-origin: omit baseUrl
+// Same-origin (frontend served by the same backend): omit baseUrl
 const client = new UnsharedLabsBrowser({});
 
+// Cross-origin (separate domains): set baseUrl via env var
+// const client = new UnsharedLabsBrowser({ baseUrl: process.env.BACKEND_URL });
+
 // On page load — fire and forget
 const fingerprint = await client.collect();
 client.submitFingerprintEvent(fingerprint, { userId: currentUser?.id });
@@ -45,9 +38,9 @@ That's it. The SDK handles retries, timeouts, and errors silently.
 
 ```typescript
 new UnsharedLabsBrowser({
-  baseUrl:    'https://yourapp.com', // optional — omit for same-origin
-  maxRetries: 3,                     // optional, default: 3
-  timeout:    30_000,                // optional, default: 30s per attempt
+  baseUrl:    process.env.BACKEND_URL, // optional — omit for same-origin
+  maxRetries: 3,                       // optional, default: 3
+  timeout:    30_000,                  // optional, default: 30s per attempt
 });
 ```
 
@@ -104,10 +97,15 @@ The SDK sends fingerprints to `{baseUrl}/unshared/submit-fingerprint-event`. You
 
 ```typescript
 // On your Express backend
+import express from 'express';
+import { UnsharedLabsClient } from 'unshared-clientjs-sdk';
 import { createUnsharedMiddleware } from 'unshared-clientjs-sdk/middleware';
 
+const app = express();
+const unshared = new UnsharedLabsClient({ apiKey: process.env.UNSHARED_API_KEY });
+
 app.use(express.json());
-app.use(createUnsharedMiddleware(client));
+app.use(createUnsharedMiddleware(unshared));
 ```
 
 ---
@@ -129,12 +127,15 @@ Retries happen automatically on network errors, timeouts, and server errors (5xx
 
 ## CDN / UMD usage
 
+The UMD bundle exposes a `window.UnsharedLabsBrowser` namespace object. Destructure the class from it first:
+
 ```html
-<script src="https://unpkg.com/unshared-frontend-sdk/dist/index.umd.js"></script>
+<script src="https://unpkg.com/unshared-frontend-sdk@2.0.0-rc.4/dist/index.umd.js"></script>
 <script>
-  const client = new UnsharedLabsBrowser.UnsharedLabsBrowser({
-    baseUrl: 'https://yourapp.com',
-  });
+  const { UnsharedLabsBrowser } = window.UnsharedLabsBrowser;
+
+  // Omit baseUrl for same-origin. Set it for cross-origin: { baseUrl: 'https://api.example.com' }
+  const client = new UnsharedLabsBrowser({});
 
   client.collect().then(fp => {
     client.submitFingerprintEvent(fp);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unshared-frontend-sdk",
-  "version": "2.0.0-rc.3",
+  "version": "2.0.0-rc.5",
   "description": "Browser SDK for Unshared Labs — routes fingerprint events through the customer's own backend",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",