@helpai/elements 6.6.2 → 6.7.0

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.
package/llms.txt CHANGED
@@ -1,11 +1,11 @@
1
1
  # Help AI Elements
2
2
 
3
- > 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@6.6.2.
3
+ > 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@6.7.0.
4
4
 
5
5
  What a coding agent needs to install it right the first time:
6
6
 
7
7
  - 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.
8
- - Plain HTML, WordPress or any CMS: `<script src="https://cdn.help.ai/sdk/js/elements/6.6.2/elements.js" data-public-key="agent_pk_…" data-ai-agent-deployment-id="…" defer></script>`.
8
+ - Plain HTML, WordPress or any CMS: `<script src="https://cdn.help.ai/sdk/js/elements/6.7.0/elements.js" data-public-key="agent_pk_…" data-ai-agent-deployment-id="…" defer></script>`.
9
9
  - 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`.
10
10
  - 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`.
11
11
  - 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 }`.
@@ -18,23 +18,23 @@ What a coding agent needs to install it right the first time:
18
18
 
19
19
  ## Docs
20
20
 
21
- - [Quickstart](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/quickstart.md): credentials, the install paths and a first check, in five minutes
22
- - [Installation](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/installation.md): every install path in depth: script tag, async loader, npm, web component, CDN URLs and version pinning
23
- - [Frameworks](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/frameworks.md): the React kit (`<HelpAI />`, `useHelpAI()`), Next.js, Remix, Vue, Nuxt, Svelte, Astro, Angular, WordPress, Shopify, Webflow
24
- - [Configuration](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/configuration.md): every option by group, with examples
25
- - [Option reference](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/options.md): the table of every option, generated from the schemas; authoritative
26
- - [API reference](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/api-reference.md): exports, instance methods (`ask`, `open`, `state`, `ready`, `reset`, …), the global API, no-script triggers, deep links, JSX typings
27
- - [Events and hooks](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/events-and-hooks.md): every event and its payload, `on()` and `hook()`
28
- - [Page tools](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/page-tools.md): WebMCP-shaped tools the AI agent calls on your page (`registerTool`, `tools`, `useHelpAITool`, `<form toolname>`), run once in the browser
29
- - [Theming](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/theming.md): colors, shapes, fonts, launcher styles, `theme: "host"` and `::part()` styling
30
- - [Recipes](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/recipes.md): copy-paste solutions for common integrations
31
- - [Analytics](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/analytics.md): sending widget activity to Google Analytics, Segment, PostHog and other trackers
32
- - [Security and privacy](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/security-privacy.md): isolation, CSP, what the widget stores and sends
33
- - [Browser support](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/browser-support.md): supported browsers and fallbacks
34
- - [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/troubleshooting.md): an install that does not show, connect or answer
35
- - [FAQ](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/faq.md): short answers to common questions
36
- - [Overview](https://cdn.help.ai/sdk/js/elements/6.6.2/docs/README.md): the whole SDK on one page
21
+ - [Quickstart](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/quickstart.md): credentials, the install paths and a first check, in five minutes
22
+ - [Installation](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/installation.md): every install path in depth: script tag, async loader, npm, web component, CDN URLs and version pinning
23
+ - [Frameworks](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/frameworks.md): the React kit (`<HelpAI />`, `useHelpAI()`), Next.js, Remix, Vue, Nuxt, Svelte, Astro, Angular, WordPress, Shopify, Webflow
24
+ - [Configuration](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/configuration.md): every option by group, with examples
25
+ - [Option reference](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/options.md): the table of every option, generated from the schemas; authoritative
26
+ - [API reference](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/api-reference.md): exports, instance methods (`ask`, `open`, `state`, `ready`, `reset`, …), the global API, no-script triggers, deep links, JSX typings
27
+ - [Events and hooks](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/events-and-hooks.md): every event and its payload, `on()` and `hook()`
28
+ - [Page tools](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/page-tools.md): WebMCP-shaped tools the AI agent calls on your page (`registerTool`, `tools`, `useHelpAITool`, `<form toolname>`), run once in the browser
29
+ - [Theming](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/theming.md): colors, shapes, fonts, launcher styles, `theme: "host"` and `::part()` styling
30
+ - [Recipes](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/recipes.md): copy-paste solutions for common integrations
31
+ - [Analytics](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/analytics.md): sending widget activity to Google Analytics, Segment, PostHog and other trackers
32
+ - [Security and privacy](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/security-privacy.md): isolation, CSP, what the widget stores and sends
33
+ - [Browser support](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/browser-support.md): supported browsers and fallbacks
34
+ - [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/troubleshooting.md): an install that does not show, connect or answer
35
+ - [FAQ](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/faq.md): short answers to common questions
36
+ - [Overview](https://cdn.help.ai/sdk/js/elements/6.7.0/docs/README.md): the whole SDK on one page
37
37
 
38
38
  ## Optional
39
39
 
40
- - [Every doc in one file](https://cdn.help.ai/sdk/js/elements/6.6.2/llms-full.txt): the docs above, concatenated
40
+ - [Every doc in one file](https://cdn.help.ai/sdk/js/elements/6.7.0/llms-full.txt): the docs above, concatenated
package/package.json CHANGED
@@ -129,5 +129,5 @@
129
129
  ],
130
130
  "type": "module",
131
131
  "types": "./index.d.ts",
132
- "version": "6.6.2"
132
+ "version": "6.7.0"
133
133
  }
package/react.d.ts CHANGED
@@ -526,8 +526,10 @@ type FeedbackValue = 'up' | 'down' | null;
526
526
  interface StepDisplay {
527
527
  /** Every step appears as one folded line under the reply; off, only the steps that involve the reader do. */
528
528
  showSteps: boolean;
529
- /** Each step opens to its raw input and result. */
529
+ /** Each step opens to what it ran on and what came back, as labelled tables with ids. */
530
530
  showStepDetails: boolean;
531
+ /** Each step also opens to its raw input and result as JSON, under Raw data. */
532
+ showRawData: boolean;
531
533
  /** The system that ran a step follows its name: "Ship an order · BC Co. back office". */
532
534
  showStepSystem: boolean;
533
535
  /** Each approval says who decided it, and steps the rules decided show as steps. */
@@ -1154,6 +1156,7 @@ declare const widgetSettingsSchema: z.ZodObject<{
1154
1156
  stepDisplay: z.ZodOptional<z.ZodObject<{
1155
1157
  showSteps: z.ZodOptional<z.ZodBoolean>;
1156
1158
  showStepDetails: z.ZodOptional<z.ZodBoolean>;
1159
+ showRawData: z.ZodOptional<z.ZodBoolean>;
1157
1160
  showStepSystem: z.ZodOptional<z.ZodBoolean>;
1158
1161
  showDecidedBy: z.ZodOptional<z.ZodBoolean>;
1159
1162
  foldApprovals: z.ZodOptional<z.ZodBoolean>;
@@ -1439,6 +1442,7 @@ declare const widgetConfigSchema: z.ZodObject<{
1439
1442
  stepDisplay: z.ZodOptional<z.ZodObject<{
1440
1443
  showSteps: z.ZodOptional<z.ZodBoolean>;
1441
1444
  showStepDetails: z.ZodOptional<z.ZodBoolean>;
1445
+ showRawData: z.ZodOptional<z.ZodBoolean>;
1442
1446
  showStepSystem: z.ZodOptional<z.ZodBoolean>;
1443
1447
  showDecidedBy: z.ZodOptional<z.ZodBoolean>;
1444
1448
  foldApprovals: z.ZodOptional<z.ZodBoolean>;
@@ -1725,6 +1729,7 @@ declare const widgetConfigPartialSchema: z.ZodObject<{
1725
1729
  stepDisplay: z.ZodOptional<z.ZodObject<{
1726
1730
  showSteps: z.ZodOptional<z.ZodBoolean>;
1727
1731
  showStepDetails: z.ZodOptional<z.ZodBoolean>;
1732
+ showRawData: z.ZodOptional<z.ZodBoolean>;
1728
1733
  showStepSystem: z.ZodOptional<z.ZodBoolean>;
1729
1734
  showDecidedBy: z.ZodOptional<z.ZodBoolean>;
1730
1735
  foldApprovals: z.ZodOptional<z.ZodBoolean>;
@@ -1973,6 +1978,7 @@ declare const widgetSettingsPartialSchema: z.ZodObject<{
1973
1978
  stepDisplay: z.ZodOptional<z.ZodObject<{
1974
1979
  showSteps: z.ZodOptional<z.ZodBoolean>;
1975
1980
  showStepDetails: z.ZodOptional<z.ZodBoolean>;
1981
+ showRawData: z.ZodOptional<z.ZodBoolean>;
1976
1982
  showStepSystem: z.ZodOptional<z.ZodBoolean>;
1977
1983
  showDecidedBy: z.ZodOptional<z.ZodBoolean>;
1978
1984
  foldApprovals: z.ZodOptional<z.ZodBoolean>;
@@ -2276,6 +2282,7 @@ declare const serverConfigSchema: z.ZodObject<{
2276
2282
  stepDisplay: z.ZodOptional<z.ZodObject<{
2277
2283
  showSteps: z.ZodOptional<z.ZodBoolean>;
2278
2284
  showStepDetails: z.ZodOptional<z.ZodBoolean>;
2285
+ showRawData: z.ZodOptional<z.ZodBoolean>;
2279
2286
  showStepSystem: z.ZodOptional<z.ZodBoolean>;
2280
2287
  showDecidedBy: z.ZodOptional<z.ZodBoolean>;
2281
2288
  foldApprovals: z.ZodOptional<z.ZodBoolean>;
@@ -2601,6 +2608,7 @@ declare const handshakeResponseSchema: z.ZodObject<{
2601
2608
  stepDisplay: z.ZodOptional<z.ZodObject<{
2602
2609
  showSteps: z.ZodOptional<z.ZodBoolean>;
2603
2610
  showStepDetails: z.ZodOptional<z.ZodBoolean>;
2611
+ showRawData: z.ZodOptional<z.ZodBoolean>;
2604
2612
  showStepSystem: z.ZodOptional<z.ZodBoolean>;
2605
2613
  showDecidedBy: z.ZodOptional<z.ZodBoolean>;
2606
2614
  foldApprovals: z.ZodOptional<z.ZodBoolean>;