obi-sdk 0.1.2 → 0.1.4

package/README.md

@@ -18,13 +18,12 @@ Currently, the recommended way to use Obi SDK is through the inline loader scrip
 
 The loader accepts the following configuration options:
 
-| Option       | Type    | Default                        | Description                                                                                                 |
-| ------------ | ------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------- |
-| `position`   | string  | `'bottom-right'`               | Position of the widget on the page. Options: `'bottom-right'`, `'bottom-left'`, `'top-right'`, `'top-left'` |
-| `apiKey`     | string  | -                              | Your Obi API key (required for production)                                                                  |
-| `sdkVersion` | string  | `'latest'`                     | Version of the SDK to load                                                                                  |
-| `noCacheSDK` | boolean | `false`                        | Force fresh load of SDK without caching                                                                     |
-| `apiBaseUrl` | string  | `'https://www.iamobi.ai/api/'` | Base URL for API calls                                                                                      |
+| Option     | Type    | Default          | Description                                                                                                 |
+| ---------- | ------- | ---------------- | ----------------------------------------------------------------------------------------------------------- |
+| `position` | string  | `'bottom-right'` | Position of the widget on the page. Options: `'bottom-right'`, `'bottom-left'`, `'top-right'`, `'top-left'` |
+| `apiKey`   | string  | -                | Your Obi API key (required for production)                                                                  |
+| `autoInit` | boolean | `true`           | Whether to initialize the widget automatically when loaded                                                  |
+| `user`     | object  | -                | User information with `id` (required), `email` (optional) and `metadata` (optional)                         |
 
 ## Quick Start
 
@@ -44,7 +43,10 @@ The simplest way to add Obi to your website is by using the inline loader script
       window.obiWidgetConfig = {
         position: "bottom-right",
         apiKey: "YOUR_API_KEY",
-        apiBaseUrl: "https://www.iamobi.ai/api/",
+        user: {
+          id: "user-123",
+          email: "user@example.com",
+        },
       }
     </script>
   </head>
@@ -57,9 +59,7 @@ The simplest way to add Obi to your website is by using the inline loader script
         "use strict"
         var c = {
           position: "bottom-right",
-          apiBaseUrl: "https://www.iamobi.ai/api/",
-          sdkVersion: "latest",
-          noCacheSDK: !1,
+          autoInit: true,
         }
         w.__obiSDKLoading = w.__obiSDKLoading || !1
         function i() {
@@ -73,20 +73,12 @@ The simplest way to add Obi to your website is by using the inline loader script
               })
               return
             }
-            if (f.sdkVersion === "latest" && !f.noCacheSDK) {
-              m(function (v) {
-                v && (f.sdkVersion = v)
-                j(f, function () {
-                  w.__obiSDKLoading = !1
-                  g(f)
-                })
-              })
-            } else {
-              j(f, function () {
+            m(function (v) {
+              j(v, function () {
                 w.__obiSDKLoading = !1
                 g(f)
               })
-            }
+            })
           }
         }
         function e(f) {
@@ -99,7 +91,7 @@ The simplest way to add Obi to your website is by using the inline loader script
         }
         function m(cb) {
           try {
-            var x = new (w.XMLHttpRequest || w.ActiveXObject)("Microsoft.XMLHTTP")
+            var x = new XMLHttpRequest()
             x.open("GET", "https://registry.npmjs.org/obi-sdk/latest")
             x.onload = function () {
               if (x.status === 200) {
@@ -121,23 +113,23 @@ The simplest way to add Obi to your website is by using the inline loader script
             cb(null)
           }
         }
-        function j(f, cb) {
+        function j(v, cb) {
           w.__obiSDKLoading = !0
           var s = d.createElement("script")
           s.type = "text/javascript"
           s.async = !0
           var b = "https://unpkg.com/obi-sdk"
-          s.src = f.noCacheSDK
-            ? b + "@" + f.sdkVersion + "/dist/obi-sdk.standalone.iife.js?t=" + Date.now()
-            : b + "@" + f.sdkVersion + "/dist/obi-sdk.standalone.iife.js"
+          var u = v || "latest"
+          s.src = b + "@" + u + "/dist/obi-sdk.standalone.iife.js"
           s.onload = cb
           s.onerror = function () {
-            w.__obiSDKLoading = !1
-            w.console && w.console.error && w.console.error("Failed to load Obi SDK")
-            if (f.sdkVersion !== "latest" && !f.noCacheSDK) {
-              w.console && w.console.warn && w.console.warn("Falling back to latest version")
-              f.sdkVersion = "latest"
-              j(f, cb)
+            if (u !== "latest") {
+              console.warn("Failed to load specific version, falling back to latest")
+              s.src = b + "@latest/dist/obi-sdk.standalone.iife.js"
+              s.onload = cb
+            } else {
+              w.__obiSDKLoading = !1
+              console.error("Failed to load Obi SDK")
             }
           }
           var fs = d.getElementsByTagName("script")[0]
@@ -159,36 +151,22 @@ The simplest way to add Obi to your website is by using the inline loader script
           var t = d.createElement("obi-widget")
           f.theme && t.setAttribute("theme", f.theme)
           f.apiKey && t.setAttribute("api-key", f.apiKey)
-          f.endpoint && t.setAttribute("endpoint", f.endpoint)
-          f.apiBaseUrl && t.setAttribute("api-base-url", f.apiBaseUrl)
-          t.style.position = "fixed"
-          t.style.zIndex = "9999"
-          switch (f.position) {
-            case "bottom-right":
-              t.style.bottom = "20px"
-              t.style.right = "20px"
-              break
-            case "bottom-left":
-              t.style.bottom = "20px"
-              t.style.left = "20px"
-              break
-            case "top-right":
-              t.style.top = "20px"
-              t.style.right = "20px"
-              break
-            case "top-left":
-              t.style.top = "20px"
-              t.style.left = "20px"
-              break
-          }
+          t.setAttribute("api-base-url", "https://www.iamobi.ai/api/")
+          f.position && t.setAttribute("position", f.position)
+          f.user && t.setAttribute("user", JSON.stringify(f.user))
           d.body.appendChild(t)
           w.console && w.console.log && w.console.log("Obi Widget added to page")
         }
-        d.readyState === "complete"
-          ? i()
-          : w.attachEvent
-            ? w.attachEvent("onload", i)
-            : w.addEventListener("load", i, !1)
+        if (w.obiWidgetConfig && w.obiWidgetConfig.autoInit === false) {
+          // Skip auto-initialization
+          console.log("Obi Widget auto-initialization disabled")
+        } else {
+          d.readyState === "complete"
+            ? i()
+            : w.attachEvent
+              ? w.attachEvent("onload", i)
+              : w.addEventListener("load", i, !1)
+        }
       })(window, document)
     </script>
   </body>
@@ -202,10 +180,29 @@ The widget will automatically appear in the specified position on your page.
 The loader script:
 
 1. Dynamically checks for the latest version using the npm registry API
-2. Loads the Obi SDK from unpkg.com with the appropriate version
+2. Loads the specific versioned SDK from unpkg.com for better browser caching
 3. Creates and positions the `<obi-widget>` custom element on your page
 4. Initializes the widget with your API key and configuration
 
+## Advanced Loader Usage
+
+The inline loader script shown above is already minified for production use. If you need to customize it or understand how it works, you can find the full, commented version in the source code (`src/loader-inline.js`).
+
+The loader script is also available as a separate file that can be loaded directly:
+
+```html
+<!-- Configure the widget (optional) -->
+<script>
+  window.obiWidgetConfig = {
+    position: "bottom-right",
+    apiKey: "YOUR_API_KEY",
+  }
+</script>
+
+<!-- Load the widget using the separate loader script -->
+<script src="https://unpkg.com/obi-sdk@latest/dist/obi-loader.iife.js"></script>
+```
+
 ## Installation for npm Projects
 
 You can also install the SDK via npm:
@@ -222,10 +219,50 @@ import ObiSDK from "obi-sdk"
 // Initialize the SDK
 const sdk = new ObiSDK({
   apiKey: "YOUR_API_KEY",
-  apiBaseUrl: "https://www.iamobi.ai/api/",
 })
 ```
 
+## Always Load the Latest SDK Version
+
+The SDK includes a simple function to always load the latest version from the CDN, which can be useful for applications that need to ensure users always have the newest features. The dynamic loader follows the same version detection mechanism as the inline script, querying the npm registry to get the latest version.
+
+```tsx
+import { initObi } from "obi-sdk"
+
+// In a React component:
+useEffect(() => {
+  const setupObi = async () => {
+    try {
+      // This will:
+      // 1. Check npm registry for the latest version
+      // 2. Load that specific version from unpkg.com
+      // 3. Initialize the widget with your config
+      await initObi({
+        apiKey: "YOUR_API_KEY",
+        position: "bottom-right",
+        user: {
+          id: "user-123",
+          email: "user@example.com",
+        },
+      })
+      console.log("Obi Assistant initialized with latest SDK")
+    } catch (error) {
+      console.error("Failed to initialize Obi Assistant:", error)
+    }
+  }
+
+  // Initialize Obi
+  setupObi()
+}, [])
+```
+
+This approach ensures your application always uses the newest SDK version without requiring updates to your codebase. The loader will:
+
+1. Query the npm registry to find the latest published version
+2. Load that specific version from unpkg.com
+3. Fall back to the "latest" tag if the specific version fails to load
+4. Initialize the Obi widget with your configuration
+
 ## Building the SDK
 
 To build the SDK locally:
@@ -284,7 +321,6 @@ The widget can be positioned in one of four corners of the page:
 window.obiWidgetConfig = {
   position: "bottom-right", // Options: "bottom-right", "bottom-left", "top-right", "top-left"
   apiKey: "YOUR_API_KEY",
-  apiBaseUrl: "https://www.iamobi.ai/api/",
 }
 ```
 
@@ -296,7 +332,6 @@ The widget supports light and dark themes:
 window.obiWidgetConfig = {
   theme: "light", // Options: "light", "dark"
   apiKey: "YOUR_API_KEY",
-  apiBaseUrl: "https://www.iamobi.ai/api/",
 }
 ```
 
@@ -309,7 +344,6 @@ window.obiWidgetConfig = {
   sdkVersion: "latest", // Use "latest" or a specific version number
   noCacheSDK: false, // Set to true to bypass cache
   apiKey: "YOUR_API_KEY",
-  apiBaseUrl: "https://www.iamobi.ai/api/",
 }
 ```