npm - obi-sdk - Versions diffs - 0.1.7 → 0.1.8 - Mend

obi-sdk 0.1.7 → 0.1.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2) hide show

package/README.md +33 -232
package/package.json +2 -2

package/README.md CHANGED Viewed

@@ -4,16 +4,12 @@ A JavaScript SDK with dynamic content capabilities for integrating Obi into your
 ## Features
-- ASssistant interacts through voice and screen share
+- Assistant interacts through voice and screen share
 - DOM analysis allows the assistant to improve context
 - Framework-agnostic UI components using Web Components
 - Event-based API
 - TypeScript support
-## Installation
-Currently, the recommended way to use Obi SDK is through the inline loader script approach.
 ## Configuration Options
 The loader accepts the following configuration options:
@@ -25,170 +21,47 @@ The loader accepts the following configuration options:
 | `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
+## Installation Options
+### Quick Start: Inline Loader
 The simplest way to add Obi to your website is by using the inline loader script:
-1. Copy the full inline loader script from below
+1. Copy the formatted inline loader script from below
 2. Add it to your HTML page
 3. Configure the widget using `window.obiWidgetConfig`
-```html
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>My Website with Obi</title>
-    <script>
-      // Configure Obi
-      window.obiWidgetConfig = {
-        position: "bottom-right",
-        apiKey: "YOUR_API_KEY",
-        user: {
-          id: "user-123",
-          email: "user@example.com",
-        },
-      }
-    </script>
-  </head>
-  <body>
-    <!-- Your website content -->
-    <!-- Add Obi widget loader script at the end of body -->
-    <script>
-      ;(function (w, d) {
-        "use strict"
-        var c = {
+**Example HTML structure:**
+  <!DOCTYPE html>
+  <html>
+    <head>
+      <title>My Website with Obi</title>
+      <script>
+        // Configure Obi
+        window.obiWidgetConfig = {
           position: "bottom-right",
-          autoInit: true,
-        }
-        w.__obiSDKLoading = w.__obiSDKLoading || !1
-        function i() {
-          var f = w.obiWidgetConfig || {}
-          for (var k in c) !(k in f) && (f[k] = c[k])
-          if (typeof w.ObiSDK === "function" || typeof w.ObiSDK === "object") g(f)
-          else {
-            if (w.__obiSDKLoading) {
-              e(function () {
-                g(f)
-              })
-              return
-            }
-            m(function (v) {
-              j(v, function () {
-                w.__obiSDKLoading = !1
-                g(f)
-              })
-            })
-          }
-        }
-        function e(f) {
-          var t = w.setInterval(function () {
-            if (typeof w.ObiSDK === "function" || typeof w.ObiSDK === "object") {
-              w.clearInterval(t)
-              f()
-            }
-          }, 100)
+          apiKey: "YOUR_API_KEY",
+          user: {
+            id: "user-123",
+            email: "user@example.com",
+          },
         }
-        function m(cb) {
-          try {
-            var x = new XMLHttpRequest()
-            x.open("GET", "https://registry.npmjs.org/obi-sdk/latest")
-            x.onload = function () {
-              if (x.status === 200) {
-                try {
-                  var r = JSON.parse(x.responseText)
-                  cb(r.version)
-                } catch (e) {
-                  cb(null)
-                }
-              } else {
-                cb(null)
-              }
-            }
-            x.onerror = function () {
-              cb(null)
-            }
-            x.send()
-          } catch (e) {
-            cb(null)
-          }
-        }
-        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"
-          var u = v || "latest"
-          s.src = b + "@" + u + "/dist/obi-sdk.standalone.iife.js"
-          s.onload = cb
-          s.onerror = function () {
-            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]
-          fs.parentNode.insertBefore(s, fs)
-        }
-        function g(f) {
-          if (d.querySelector("obi-widget")) {
-            w.console && w.console.log && w.console.log("Obi Widget already exists on the page")
-            return
-          }
-          if (!w.customElements || !w.customElements.get("obi-widget")) {
-            w.console &&
-              w.console.warn &&
-              w.console.warn(
-                "Obi Widget component not registered - SDK may not have loaded properly"
-              )
-            return
-          }
-          var t = d.createElement("obi-widget")
-          f.theme && t.setAttribute("theme", f.theme)
-          f.apiKey && t.setAttribute("api-key", f.apiKey)
-          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")
-        }
-        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>
-</html>
-```
+      </script>
+    </head>
+    <body>
+      <!-- Your website content -->
+      <script>
+        (()=>{var s=window,d=document,r={position:"bottom-right",autoInit:!0};function t(){var t,e,o,a=s.obiWidgetConfig||{};for(t in r)t in a||(a[t]=r[t]);if("function"==typeof s.ObiSDK||"object"==typeof s.ObiSDK)l(a);else if(s.__obiSDKLoading)e=function(){l(a)},o=s.setInterval(function(){"function"!=typeof s.ObiSDK&&"object"!=typeof s.ObiSDK||(s.clearInterval(o),e())},100);else{var i=function(t){var e,o,i,n;t=t,e=function(){s.__obiSDKLoading=!1,l(a)},s.__obiSDKLoading=!0,(o=d.createElement("script")).type="text/javascript",o.async=!0,o.src=(i="https://unpkg.com/obi-sdk")+"@"+(n=t||"latest")+"/dist/obi-sdk.standalone.iife.js",o.onload=e,o.onerror=function(){"latest"!==n?(console.warn("Failed to load specific version, falling back to latest"),o.src=i+"@latest/dist/obi-sdk.standalone.iife.js",o.onload=e):(s.__obiSDKLoading=!1,console.error("Failed to load Obi SDK"))},d.head.appendChild(o)};try{var n=new XMLHttpRequest;n.open("GET","https://registry.npmjs.org/obi-sdk/latest"),n.onload=function(){if(200===n.status)try{var t=JSON.parse(n.responseText);i(t.version)}catch(t){i(null)}else i(null)},n.onerror=function(){i(null)},n.send()}catch(t){i(null)}}}function l(t){var e;d.querySelector("obi-widget")?console.log("Obi Widget already exists on the page"):customElements.get("obi-widget")?(e=d.createElement("obi-widget"),t.apiKey&&e.setAttribute("api-key",t.apiKey),t.position&&e.setAttribute("position",t.position),t.user&&e.setAttribute("user",JSON.stringify(t.user)),d.body.appendChild(e),console.log("Obi Widget added to page")):console.warn("Obi Widget component not registered - SDK may not have loaded properly")}s.__obiSDKLoading=s.__obiSDKLoading||!1,s.obiWidgetConfig&&!1===s.obiWidgetConfig.autoInit?console.log("Obi Widget auto-initialization disabled"):"complete"===d.readyState?t():s.attachEvent?s.attachEvent("onload",t):s.addEventListener("load",t,!1)})();
+      </script>
+    </body>
+  </html>
 The widget will automatically appear in the specified position on your page.
-## How It Works
-The loader script:
-1. Dynamically checks for the latest version using the npm registry API
-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
+### Using a CDN Link
-## 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:
+You can also include the loader directly from our CDN:
 ```html
 <!-- Configure the widget (optional) -->
@@ -203,7 +76,7 @@ The loader script is also available as a separate file that can be loaded direct
 <script src="https://unpkg.com/obi-sdk@latest/dist/obi-loader.iife.js"></script>
 ```
-## Installation for npm Projects
+### Installation for npm Projects
 You can also install the SDK via npm:
@@ -211,20 +84,9 @@ You can also install the SDK via npm:
 npm install obi-sdk
 ```
-And import it in your application:
-```javascript
-import ObiSDK from "obi-sdk"
-// Initialize the SDK
-const sdk = new ObiSDK({
-  apiKey: "YOUR_API_KEY",
-})
-```
 ## 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.
+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:
 ```tsx
 import { initObi } from "obi-sdk"
@@ -256,64 +118,7 @@ useEffect(() => {
 }, [])
 ```
-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:
-```bash
-# Install dependencies
-npm install
-# Build all formats (UMD, ES, standalone IIFE, and loader)
-npm run build:all
-```
-This generates the following in the `dist` directory:
-- `obi-sdk.umd.js` - UMD format for CommonJS/AMD environments
-- `obi-sdk.es.js` - ES Module format for modern bundlers
-- `obi-sdk.standalone.iife.js` - IIFE format with all dependencies bundled
-- `obi-loader.iife.js` - Standalone loader script
-## Coming Soon
-The following features are under development and will be available in future releases:
-- React integration components
-- Import-based usage
-- Advanced SDK methods for voice and screen capture
-## Documentation
-### Inline Loader Script
-The inline loader script provides a self-contained way to add the Obi Widget to any webpage:
-1. It checks if there's a global configuration object (`window.obiWidgetConfig`)
-2. It merges this with default configuration values
-3. It queries the npm registry to get the latest version of the SDK
-4. It loads the SDK from your CDN with the appropriate version
-5. It creates the `<obi-widget>` element and positions it on the page
-6. It configures the widget with the provided options
-Before using in production, you can use unpkg.com as a CDN which automatically serves files from npm packages:
-```js
-// The loader automatically uses unpkg.com to load the package:
-var b = "https://unpkg.com/obi-sdk"
-// Which resolves to URLs like:
-// https://unpkg.com/obi-sdk@0.1.1/dist/obi-sdk.standalone.iife.js
-```
-### Widget Positioning
+## Widget Positioning
 The widget can be positioned in one of four corners of the page:
@@ -347,10 +152,6 @@ window.obiWidgetConfig = {
 }
 ```
-## Contributing
-Contributions are welcome! Please feel free to submit a Pull Request.
 ## License
 SEE LICENSE IN LICENSE.txt

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "obi-sdk",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "JavaScript SDK for Obi",
   "type": "module",
   "main": "dist/obi-sdk.umd.js",
@@ -65,4 +65,4 @@
     "typescript": "^5.0.2",
     "vite": "^4.5.0"
   }
-}
+}