@helpai/elements 6.8.0 → 6.9.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.8.0.
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.9.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.8.0/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.9.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.8.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.8.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.8.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.8.0/docs/configuration.md): every option by group, with examples
25
- - [Option reference](https://cdn.help.ai/sdk/js/elements/6.8.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.8.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.8.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.8.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.8.0/docs/theming.md): colors, shapes, fonts, launcher styles, `theme: "host"` and `::part()` styling
30
- - [Recipes](https://cdn.help.ai/sdk/js/elements/6.8.0/docs/recipes.md): copy-paste solutions for common integrations
31
- - [Analytics](https://cdn.help.ai/sdk/js/elements/6.8.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.8.0/docs/security-privacy.md): isolation, CSP, what the widget stores and sends
33
- - [Browser support](https://cdn.help.ai/sdk/js/elements/6.8.0/docs/browser-support.md): supported browsers and fallbacks
34
- - [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.8.0/docs/troubleshooting.md): an install that does not show, connect or answer
35
- - [FAQ](https://cdn.help.ai/sdk/js/elements/6.8.0/docs/faq.md): short answers to common questions
36
- - [Overview](https://cdn.help.ai/sdk/js/elements/6.8.0/docs/README.md): the whole SDK on one page
21
+ - [Quickstart](https://cdn.help.ai/sdk/js/elements/6.9.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.9.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.9.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.9.0/docs/configuration.md): every option by group, with examples
25
+ - [Option reference](https://cdn.help.ai/sdk/js/elements/6.9.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.9.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.9.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.9.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.9.0/docs/theming.md): colors, shapes, fonts, launcher styles, `theme: "host"` and `::part()` styling
30
+ - [Recipes](https://cdn.help.ai/sdk/js/elements/6.9.0/docs/recipes.md): copy-paste solutions for common integrations
31
+ - [Analytics](https://cdn.help.ai/sdk/js/elements/6.9.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.9.0/docs/security-privacy.md): isolation, CSP, what the widget stores and sends
33
+ - [Browser support](https://cdn.help.ai/sdk/js/elements/6.9.0/docs/browser-support.md): supported browsers and fallbacks
34
+ - [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.9.0/docs/troubleshooting.md): an install that does not show, connect or answer
35
+ - [FAQ](https://cdn.help.ai/sdk/js/elements/6.9.0/docs/faq.md): short answers to common questions
36
+ - [Overview](https://cdn.help.ai/sdk/js/elements/6.9.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.8.0/llms-full.txt): the docs above, concatenated
40
+ - [Every doc in one file](https://cdn.help.ai/sdk/js/elements/6.9.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.8.0"
132
+ "version": "6.9.0"
133
133
  }
package/react.d.ts CHANGED
@@ -523,11 +523,12 @@ type PageToolCallStatus = 'completed' | 'failed' | 'interrupted';
523
523
  /** A 👍/👎 reaction on a rateable (assistant/operator) message; `null` clears a prior choice. */
524
524
  type FeedbackValue = 'up' | 'down' | null;
525
525
  /**
526
- * What an opened step shows: `values`, its values as quiet label and value lines without ids; `table`, tables of what
527
- * it ran on (ids included) and what came back; `json`, its raw input and result; `table-and-json`, the tables with
528
- * the JSON folded under Raw data.
526
+ * What an opened step shows: `none`, nothing (the step line alone, for a business that never shows a visitor's data
527
+ * back); `values`, its values as quiet label and value lines without ids; `table`, tables of what it ran on (ids
528
+ * included) and what came back; `json`, its raw input and result; `table-and-json`, the tables with the JSON folded
529
+ * under Raw data. A step waiting on a decision shows its values whatever this says.
529
530
  */
530
- declare const STEP_DETAILS: readonly ['values', 'table', 'json', 'table-and-json'];
531
+ declare const STEP_DETAILS: readonly ['none', 'values', 'table', 'json', 'table-and-json'];
531
532
  type StepDetails = (typeof STEP_DETAILS)[number];
532
533
  /** The settings, the same keys on a Deployment (`config.behavior.stepDisplay`) and in a member's Preferences. */
533
534
  interface StepDisplay {
@@ -1162,6 +1163,7 @@ declare const widgetSettingsSchema: z.ZodObject<{
1162
1163
  showSteps: z.ZodOptional<z.ZodBoolean>;
1163
1164
  stepDetails: z.ZodOptional<z.ZodEnum<{
1164
1165
  json: "json";
1166
+ none: "none";
1165
1167
  table: "table";
1166
1168
  "table-and-json": "table-and-json";
1167
1169
  values: "values";
@@ -1452,6 +1454,7 @@ declare const widgetConfigSchema: z.ZodObject<{
1452
1454
  showSteps: z.ZodOptional<z.ZodBoolean>;
1453
1455
  stepDetails: z.ZodOptional<z.ZodEnum<{
1454
1456
  json: "json";
1457
+ none: "none";
1455
1458
  table: "table";
1456
1459
  "table-and-json": "table-and-json";
1457
1460
  values: "values";
@@ -1743,6 +1746,7 @@ declare const widgetConfigPartialSchema: z.ZodObject<{
1743
1746
  showSteps: z.ZodOptional<z.ZodBoolean>;
1744
1747
  stepDetails: z.ZodOptional<z.ZodEnum<{
1745
1748
  json: "json";
1749
+ none: "none";
1746
1750
  table: "table";
1747
1751
  "table-and-json": "table-and-json";
1748
1752
  values: "values";
@@ -1996,6 +2000,7 @@ declare const widgetSettingsPartialSchema: z.ZodObject<{
1996
2000
  showSteps: z.ZodOptional<z.ZodBoolean>;
1997
2001
  stepDetails: z.ZodOptional<z.ZodEnum<{
1998
2002
  json: "json";
2003
+ none: "none";
1999
2004
  table: "table";
2000
2005
  "table-and-json": "table-and-json";
2001
2006
  values: "values";
@@ -2304,6 +2309,7 @@ declare const serverConfigSchema: z.ZodObject<{
2304
2309
  showSteps: z.ZodOptional<z.ZodBoolean>;
2305
2310
  stepDetails: z.ZodOptional<z.ZodEnum<{
2306
2311
  json: "json";
2312
+ none: "none";
2307
2313
  table: "table";
2308
2314
  "table-and-json": "table-and-json";
2309
2315
  values: "values";
@@ -2634,6 +2640,7 @@ declare const handshakeResponseSchema: z.ZodObject<{
2634
2640
  showSteps: z.ZodOptional<z.ZodBoolean>;
2635
2641
  stepDetails: z.ZodOptional<z.ZodEnum<{
2636
2642
  json: "json";
2643
+ none: "none";
2637
2644
  table: "table";
2638
2645
  "table-and-json": "table-and-json";
2639
2646
  values: "values";