@helpai/elements 1.8.0 → 1.10.0

package/llms.txt

@@ -0,0 +1,37 @@
+# Help AI Elements
+
+> Help AI's AI chat widget for any website: an AI agent that answers visitors from the customer's own help content, can hand the chat to a person, and shows Help articles and News. Install it with one script tag, the `<web-ai-chat>` element, the npm API or the React kit. These docs match @helpai/elements@1.10.0.
+
+What a coding agent needs to install it right the first time:
+
+- Two values come from the deployment's Install page in the Help AI dashboard: the public key (`agent_pk_…`) and the AI agent deployment id (a UUID). Both belong in browser code. The deployment's secret key never does.
+- Plain HTML, WordPress or any CMS: `<script src="https://cdn.help.ai/sdk/js/elements/1.10.0/elements.js" data-public-key="agent_pk_…" data-ai-agent-deployment-id="…" defer></script>`.
+- React, Next.js, Remix: install `@helpai/elements` and render `<HelpAI publicKey="…" aiAgentDeploymentId="…" />` from `@helpai/elements/react` once, in the root layout. `useHelpAI()` in any component returns `{ state, ask, open, close, reset }`. It is server-render safe; import everything from `@helpai/elements/react`.
+- Vue, Svelte, Angular and other bundlers: `import '@helpai/elements/web-component'`, then `<web-ai-chat public-key="…" ai-agent-deployment-id="…"></web-ai-chat>`. JSX typings: `@helpai/elements/jsx/react`, `/jsx/vue`, `/jsx/svelte`.
+- Site buttons need no JavaScript: `data-helpai-ask="Which plan fits a team of 10?"` puts the question in the chat, `data-helpai-open="help"` opens a tab (`home`, `chats`, `help`, `news`). In code, `ask(text)` fills the composer and sends only with `{ send: true }`.
+- Logged-in users: your server signs a JWT with the deployment's secret key (HS256; `sub` = your user id, `exp`; optional `name`, `email`), and the widget gets a function that fetches it: `userToken` at init, `login(fn)` after sign-in, `reset()` at sign-out. Their chats then follow them to any device. Never sign tokens in the browser.
+- `theme: 'host'` (`theme="host"`) follows the site's own light/dark switch.
+- Pin the exact version in production, as above; `latest` changes under you.
+- It works when the launcher shows in the bottom corner and `HelpAI.ready()` (or `chat.ready`) resolves.
+
+## Docs
+
+- [Quickstart](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/quickstart.md): credentials, the install paths and a first check, in five minutes
+- [Installation](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/installation.md): every install path in depth: script tag, async loader, npm, web component, CDN URLs and version pinning
+- [Frameworks](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/frameworks.md): the React kit (`<HelpAI />`, `useHelpAI()`), Next.js, Remix, Vue, Nuxt, Svelte, Astro, Angular, WordPress, Shopify, Webflow
+- [Configuration](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/configuration.md): every option by group, with examples
+- [Option reference](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/options.md): the table of every option, generated from the schemas; authoritative
+- [API reference](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/api-reference.md): exports, instance methods (`ask`, `open`, `state`, `ready`, `reset`, …), the global API, no-script triggers, deep links, JSX typings
+- [Events and hooks](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/events-and-hooks.md): every event and its payload, `on()` and `hook()`
+- [Theming](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/theming.md): colors, shapes, fonts, launcher styles, `theme: "host"` and `::part()` styling
+- [Recipes](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/recipes.md): copy-paste solutions for common integrations
+- [Analytics](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/analytics.md): sending widget activity to Google Analytics, Segment, PostHog and other trackers
+- [Security and privacy](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/security-privacy.md): isolation, CSP, what the widget stores and sends
+- [Browser support](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/browser-support.md): supported browsers and fallbacks
+- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/troubleshooting.md): an install that does not show, connect or answer
+- [FAQ](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/faq.md): short answers to common questions
+- [Overview](https://cdn.help.ai/sdk/js/elements/1.10.0/docs/README.md): the whole SDK on one page
+
+## Optional
+
+- [Every doc in one file](https://cdn.help.ai/sdk/js/elements/1.10.0/llms-full.txt): the docs above, concatenated

package/loader.js

@@ -1,10 +1,10 @@
-// GA-style async loader stub. Template: HelpAI and https://cdn.help.ai/elements/latest/elements.js are
+// GA-style async loader stub. Template: HelpAI and https://cdn.help.ai/sdk/js/elements/latest/elements.js are
 // Substituted at build time (see scripts/build-brand.mjs).
 //
 // Usage:
 //
 //   <script>
-//     !function(w,d){w.HelpAI=w.HelpAI||function(){(w.HelpAI.q=w.HelpAI.q||[]).push(arguments)};var s=d.createElement("script");s.async=1;s.src="https://cdn.help.ai/elements/latest/elements.js";d.head.appendChild(s)}(window,document);
+//     !function(w,d){w.HelpAI=w.HelpAI||function(){(w.HelpAI.q=w.HelpAI.q||[]).push(arguments)};var s=d.createElement("script");s.async=1;s.src="https://cdn.help.ai/sdk/js/elements/latest/elements.js";d.head.appendChild(s)}(window,document);
 //     HelpAI('init', { publicKey: 'agent_pk_xxxx', aiAgentDeploymentId: '01900000-0000-7000-8000-000000000000' });
 //   </script>
 
@@ -16,6 +16,6 @@
     };
   var s = d.createElement('script');
   s.async = 1;
-  s.src = 'https://cdn.help.ai/elements/latest/elements.js';
+  s.src = 'https://cdn.help.ai/sdk/js/elements/latest/elements.js';
   d.head.appendChild(s);
 })(window, document);

package/loader.min.js

@@ -1 +1 @@
-(function(e,t){e.HelpAI=e.HelpAI||function(){(e.HelpAI.q=e.HelpAI.q||[]).push(arguments)};var n=t.createElement("script");n.async=1,n.src="https://cdn.help.ai/elements/latest/elements.js",t.head.appendChild(n)})(window,document);
+(function(e,s){e.HelpAI=e.HelpAI||function(){(e.HelpAI.q=e.HelpAI.q||[]).push(arguments)};var n=s.createElement("script");n.async=1,n.src="https://cdn.help.ai/sdk/js/elements/latest/elements.js",s.head.appendChild(n)})(window,document);

package/package.json

@@ -25,6 +25,19 @@
       "browser": "./elements-web-component.esm.js",
       "import": "./web-component.mjs",
       "types": "./web-component.d.ts"
+    },
+    "./react": {
+      "import": "./react.mjs",
+      "types": "./react.d.ts"
+    },
+    "./jsx/react": {
+      "types": "./jsx-react.d.ts"
+    },
+    "./jsx/vue": {
+      "types": "./jsx-vue.d.ts"
+    },
+    "./jsx/svelte": {
+      "types": "./jsx-svelte.d.ts"
     }
   },
   "files": [
@@ -38,6 +51,11 @@
     "configurator.css",
     "web-component.mjs",
     "web-component.d.ts",
+    "react.mjs",
+    "react.d.ts",
+    "jsx-react.d.ts",
+    "jsx-vue.d.ts",
+    "jsx-svelte.d.ts",
     "elements.js",
     "elements.js.map",
     "elements.esm.js",
@@ -50,6 +68,9 @@
     "loader.min.js",
     "style.css",
     "README.md",
+    "llms.txt",
+    "llms-full.txt",
+    "docs",
     "LICENSE",
     "LICENSE-OPENUI",
     "NOTICE"
@@ -73,6 +94,20 @@
   "main": "./elements.cjs.js",
   "module": "./index.mjs",
   "name": "@helpai/elements",
+  "dependencies": {
+    "@preact/signals": "^2.11.3",
+    "preact": "^11.0.2",
+    "streaming-markdown": "^0.2.15",
+    "zod": "^4.6.7"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -82,5 +117,5 @@
   ],
   "type": "module",
   "types": "./index.d.ts",
-  "version": "1.8.0"
+  "version": "1.10.0"
 }