obi-sdk 0.3.12 → 0.4.0

package/README.md

@@ -21,6 +21,7 @@ The loader accepts the following configuration options:
 | `apiKey`         | string  | -                | Your Obi API key (required for production)                                                                                                                                        |
 | `user`           | object  | -                | User information with `id` (required), `email` (optional) and `metadata` (optional)                                                                                               |
 | `isActive`       | boolean | `true`           | Whether to show the widget. Set to `false` to disable the widget for specific users                                                                                               |
+| `linkOnlyAccess` | boolean | `false`          | Hide the widget unless accessed via a session link. Perfect for trial periods where only customers with direct links should see the widget                                        |
 | `primaryColor`   | string  | -                | Custom primary color for the widget UI (CSS color value)                                                                                                                          |
 | `secondaryColor` | string  | -                | Custom secondary color for the widget UI (CSS color value)                                                                                                                        |
 
@@ -41,6 +42,30 @@ window.obiWidgetConfig = {
 }
 ```
 
+## Trial Mode / Link-Only Access
+
+The `linkOnlyAccess` option is perfect for trial periods where you want to control who can see and interact with the widget. When enabled, the widget remains hidden until a session is started via a direct link.
+
+```js
+window.obiWidgetConfig = {
+  apiKey: "YOUR_API_KEY",
+  linkOnlyAccess: true, // Widget only visible when accessed via session link
+}
+```
+
+This is ideal for:
+
+- Trial periods where only specific customers should see the widget
+- Beta testing with selected users
+- Controlled rollouts using session-specific links
+- Demo environments where widget access is link-based
+
+When `linkOnlyAccess` is `true`:
+
+- Widget is invisible to regular website visitors
+- Widget becomes visible only when a session is started (e.g., via URL parameters)
+- Once a session ends, the widget returns to hidden state
+
 ## Session Persistence
 
 The SDK now supports session persistence across page reloads and navigation. If a user refreshes the page or navigates to another page on your site, the session with Obi will be automatically restored when they return, providing a seamless experience.

package/dist/loader.d.ts

@@ -10,9 +10,12 @@ interface ObiWidgetConfig {
     user?: {
         id: string;
         email?: string;
-        metadata?: any;
-    };
+        metadata?: Record<string, any>;
+    } | null;
     isActive?: boolean;
+    linkOnlyAccess?: boolean;
+    primaryColor?: string;
+    secondaryColor?: string;
 }
 declare class ObiWidgetLoader {
     private config;