npm - obi-sdk - Versions diffs - 0.1.1 - Mend

obi-sdk 0.1.1

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 (5) hide show

package/LICENSE.txt ADDED Viewed

@@ -0,0 +1,35 @@
+**Obi SDK License Agreement**
+**Effective Date:** 28th April 2025
+**Last Updated:** 28th April 2025
+### 1. Grant of License
+Subject to the terms of this Agreement and payment of applicable fees, **Cor** grants you a non-exclusive, non-transferable, non-sublicensable license to use the **Obi SDK** (the "SDK") solely to integrate voice assistant functionality into your applications.
+### 2. Restrictions
+You may **not**:
+- Use the SDK without a valid paid license or subscription.
+- Copy, modify, reverse-engineer, or create derivative works of the SDK.
+- Distribute, sublicense, or make the SDK available to third parties.
+- Remove or alter any proprietary notices.
+### 3. Ownership
+The SDK is licensed, not sold. **Cor** retains all rights, title, and interest in and to the SDK, including all intellectual property rights.
+### 4. Fees and Activation
+Use of the SDK requires a valid license key issued by **Cor**. Access to features or voice processing may be metered, and continued usage is subject to payment of applicable fees as described on our pricing page: [www.iamobi.ai](https://www.iamobi.ai).
+### 5. Updates & Support
+**Cor** may provide updates or patches at its discretion. Support is only provided to licensed users with active subscriptions.
+### 6. Termination
+This Agreement is effective until terminated. It will terminate automatically without notice if you fail to comply with any terms. Upon termination, you must destroy all copies of the SDK.
+### 7. Disclaimer of Warranties
+The SDK is provided "as is" without warranties of any kind. You assume all risks related to use.
+### 8. Limitation of Liability
+In no event will **Cor** be liable for indirect, incidental, or consequential damages arising from use of the SDK.
+### 9. Governing Law
+This Agreement shall be governed by the laws of Australia.

package/README.md ADDED Viewed

@@ -0,0 +1,274 @@
+# Obi SDK
+A JavaScript SDK with dynamic content capabilities for integrating Obi into your web applications.
+## Features
+- ASssistant 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:
+| 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                                                                                      |
+## Quick Start
+The simplest way to add Obi to your website is by using the inline loader script:
+1. Copy the full inline loader script from above
+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",
+        apiBaseUrl: "https://www.iamobi.ai/api/",
+      }
+    </script>
+  </head>
+  <body>
+    <!-- Your website content -->
+    <!-- Add Obi widget loader script at the end of body -->
+    <script>
+      ;(function (w, d) {
+        "use strict"
+        var c = {
+          position: "bottom-right",
+          apiBaseUrl: "https://www.iamobi.ai/api/",
+          sdkVersion: "latest",
+          noCacheSDK: !1,
+        }
+        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
+            }
+            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 () {
+                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)
+        }
+        function m(cb) {
+          try {
+            var x = new (w.XMLHttpRequest || w.ActiveXObject)("Microsoft.XMLHTTP")
+            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(f, cb) {
+          w.__obiSDKLoading = !0
+          var s = d.createElement("script")
+          s.type = "text/javascript"
+          s.async = !0
+          var b = "https://cdn.iamobi.ai/obi-sdk"
+          s.src = f.noCacheSDK
+            ? b + "-" + f.sdkVersion + ".js?t=" + Date.now()
+            : b + "-" + f.sdkVersion + ".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)
+            }
+          }
+          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)
+          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
+          }
+          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)
+      })(window, document)
+    </script>
+  </body>
+</html>
+```
+The widget will automatically appear in the specified position on your page.
+## 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 should update the CDN URL to point to where you host the SDK files:
+```js
+// In the loader script, change this line:
+var b = "https://cdn.iamobi.ai/obi-sdk"
+// To point to your CDN:
+var b = "https://your-cdn.iamobi.ai/path/to/obi-sdk"
+```
+### Widget Positioning
+The widget can be positioned in one of four corners of the page:
+```js
+window.obiWidgetConfig = {
+  position: "bottom-right", // Options: "bottom-right", "bottom-left", "top-right", "top-left"
+  apiKey: "YOUR_API_KEY",
+  apiBaseUrl: "https://www.iamobi.ai/api/",
+}
+```
+### Theming
+The widget supports light and dark themes:
+```js
+window.obiWidgetConfig = {
+  theme: "light", // Options: "light", "dark"
+  apiKey: "YOUR_API_KEY",
+  apiBaseUrl: "https://www.iamobi.ai/api/",
+}
+```
+### SDK Version Control
+You can specify which version of the SDK to load:
+```js
+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/",
+}
+```
+## Contributing
+Contributions are welcome! Please feel free to submit a Pull Request.
+## License
+SEE LICENSE IN LICENSE.txt