@helpai/elements 6.4.10 → 6.5.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/configurator.mjs +1 -1
- package/docs/configuration.md +1 -1
- package/docs/installation.md +1 -1
- package/docs/page-tools.md +16 -13
- package/elements-web-component.esm.js +47 -45
- package/elements-web-component.esm.js.map +4 -4
- package/elements.cjs.js +47 -45
- package/elements.cjs.js.map +4 -4
- package/elements.esm.js +47 -45
- package/elements.esm.js.map +4 -4
- package/elements.js +47 -45
- package/elements.js.map +4 -4
- package/index.d.ts +71 -15
- package/index.mjs +19 -19
- package/llms-full.txt +158 -155
- package/llms.txt +19 -19
- package/package.json +7 -1
- package/react.d.ts +71 -15
- package/react.mjs +38 -38
- package/schema.d.ts +49 -7
- package/schema.json +52 -10
- package/schema.mjs +1 -1
- package/step-display.d.ts +215 -0
- package/step-display.mjs +2 -0
- package/style.css +1 -1
- package/web-component.d.ts +49 -9
- package/web-component.mjs +19 -19
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.
|
|
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.5.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
|
+
- Plain HTML, WordPress or any CMS: `<script src="https://cdn.help.ai/sdk/js/elements/6.5.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.
|
|
22
|
-
- [Installation](https://cdn.help.ai/sdk/js/elements/6.
|
|
23
|
-
- [Frameworks](https://cdn.help.ai/sdk/js/elements/6.
|
|
24
|
-
- [Configuration](https://cdn.help.ai/sdk/js/elements/6.
|
|
25
|
-
- [Option reference](https://cdn.help.ai/sdk/js/elements/6.
|
|
26
|
-
- [API reference](https://cdn.help.ai/sdk/js/elements/6.
|
|
27
|
-
- [Events and hooks](https://cdn.help.ai/sdk/js/elements/6.
|
|
28
|
-
- [Page tools](https://cdn.help.ai/sdk/js/elements/6.
|
|
29
|
-
- [Theming](https://cdn.help.ai/sdk/js/elements/6.
|
|
30
|
-
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.
|
|
31
|
-
- [Analytics](https://cdn.help.ai/sdk/js/elements/6.
|
|
32
|
-
- [Security and privacy](https://cdn.help.ai/sdk/js/elements/6.
|
|
33
|
-
- [Browser support](https://cdn.help.ai/sdk/js/elements/6.
|
|
34
|
-
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.
|
|
35
|
-
- [FAQ](https://cdn.help.ai/sdk/js/elements/6.
|
|
36
|
-
- [Overview](https://cdn.help.ai/sdk/js/elements/6.
|
|
21
|
+
- [Quickstart](https://cdn.help.ai/sdk/js/elements/6.5.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.5.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.5.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.5.0/docs/configuration.md): every option by group, with examples
|
|
25
|
+
- [Option reference](https://cdn.help.ai/sdk/js/elements/6.5.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.5.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.5.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.5.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.5.0/docs/theming.md): colors, shapes, fonts, launcher styles, `theme: "host"` and `::part()` styling
|
|
30
|
+
- [Recipes](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/recipes.md): copy-paste solutions for common integrations
|
|
31
|
+
- [Analytics](https://cdn.help.ai/sdk/js/elements/6.5.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.5.0/docs/security-privacy.md): isolation, CSP, what the widget stores and sends
|
|
33
|
+
- [Browser support](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/browser-support.md): supported browsers and fallbacks
|
|
34
|
+
- [Troubleshooting](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/troubleshooting.md): an install that does not show, connect or answer
|
|
35
|
+
- [FAQ](https://cdn.help.ai/sdk/js/elements/6.5.0/docs/faq.md): short answers to common questions
|
|
36
|
+
- [Overview](https://cdn.help.ai/sdk/js/elements/6.5.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.
|
|
40
|
+
- [Every doc in one file](https://cdn.help.ai/sdk/js/elements/6.5.0/llms-full.txt): the docs above, concatenated
|
package/package.json
CHANGED
|
@@ -34,6 +34,10 @@
|
|
|
34
34
|
"import": "./server.mjs",
|
|
35
35
|
"types": "./server.d.ts"
|
|
36
36
|
},
|
|
37
|
+
"./step-display": {
|
|
38
|
+
"import": "./step-display.mjs",
|
|
39
|
+
"types": "./step-display.d.ts"
|
|
40
|
+
},
|
|
37
41
|
"./jsx/react": {
|
|
38
42
|
"types": "./jsx-react.d.ts"
|
|
39
43
|
},
|
|
@@ -59,6 +63,8 @@
|
|
|
59
63
|
"react.d.ts",
|
|
60
64
|
"server.mjs",
|
|
61
65
|
"server.d.ts",
|
|
66
|
+
"step-display.mjs",
|
|
67
|
+
"step-display.d.ts",
|
|
62
68
|
"jsx-react.d.ts",
|
|
63
69
|
"jsx-vue.d.ts",
|
|
64
70
|
"jsx-svelte.d.ts",
|
|
@@ -123,5 +129,5 @@
|
|
|
123
129
|
],
|
|
124
130
|
"type": "module",
|
|
125
131
|
"types": "./index.d.ts",
|
|
126
|
-
"version": "6.
|
|
132
|
+
"version": "6.5.0"
|
|
127
133
|
}
|
package/react.d.ts
CHANGED
|
@@ -52,7 +52,7 @@ interface ClientStorage {
|
|
|
52
52
|
/** Removes `key`. No-op if absent. */
|
|
53
53
|
remove(key: string): void;
|
|
54
54
|
}
|
|
55
|
-
type StringKey = 'launcherOpen' | 'launcherAsk' | 'panelTitle' | 'composerPlaceholder' | 'send' | 'stop' | 'queueMessage' | 'removeQueuedMessage' | 'removeAttachment' | 'suggestedReplies' | 'compactingContext' | 'attach' | 'file' | 'micBlocked' | 'micStart' | 'micStop' | 'expand' | 'collapse' | 'fullscreen' | 'exitFullscreen' | 'popOut' | 'resizeHandle' | 'scrollToBottom' | 'close' | 'moreActions' | 'soundOn' | 'soundOff' | 'language' | 'theme' | 'themeAuto' | 'themeLight' | 'themeDark' | 'textSize' | 'textSizeSmall' | 'textSizeNormal' | 'textSizeLarge' | 'history' | 'historyTitle' | 'historyEmpty' | 'historyLoading' | 'historyBack' | 'historyContinue' | 'loadMoreConversations' | 'conversationLoading' | 'loadPreviousMessages' | 'talkToOperator' | 'connectingOperator' | 'noOperatorAvailable' | 'chattingWithOperator' | 'operatorBadgeTitle' | 'chatNotice' | 'cancelOperatorRequest' | 'loginPrompt' | 'loginAction' | 'loginRequired' | 'loginExpired' | 'loginExpiredGuest' | 'startAsGuest' | 'loggedInAs' | 'loggedIn' | 'dismissLoginPrompt' | 'emailTranscript' | 'emailTranscriptPrompt' | 'emailTranscriptEmailLabel' | 'emailTranscriptSend' | 'emailTranscriptSending' | 'emailTranscriptSent' | 'emailTranscriptAlreadySent' | 'emailTranscriptLimited' | 'emailTranscriptFailed' | 'emailTranscriptNotDelivered' | 'emailTranscriptCancel' | 'emailTranscriptDone' | 'dateToday' | 'dateYesterday' | 'dateLastWeek' | 'dateOlder' | 'newConversation' | 'dropZone' | 'dropZoneRejected' | 'attachmentTooLarge' | 'poweredBy' | 'attachmentTooMany' | 'attachmentMimeRejected' | 'attachmentUploadFailed' | 'errorRetry' | 'errorGeneric' | 'errorRateLimited' | 'errorRateLimitedIn' | 'errorOffline' | 'errorServer' | 'errorOriginNotAllowed' | 'errorMessageTooLong' | 'errorReconnecting' | 'loading' | 'visualPreparing' | 'visualError' | 'visualPartial' | 'visualSoldOut' | 'visualCartEmpty' | 'visualQuantity' | 'visualChoose' | 'thinking' | 'thought' | 'thoughtFor' | 'toolResult' | 'sources' | 'feedbackUp' | 'feedbackDown' | 'feedbackThanks' | 'copy' | 'copied' | 'copyTicketReference' | 'collapseSidebar' | 'expandSidebar' | 'formRequired' | 'formInvalidEmail' | 'formInvalidTel' | 'formInvalidNumber' | 'formOtherPlaceholder' | 'inputRequired' | 'askFallbackQuestion' | 'inputBadge' | 'inputAnswered' | 'inputSkipped' | 'inputSubmit' | 'inputSubmitHint' | 'inputSkip' | 'showOptions' | 'hideOptions' | 'qtypeText' | 'qtypeEmail' | 'qtypePhone' | 'qtypeNumber' | 'qtypeDate' | 'qtypeChooseOne' | 'qtypeChooseAny' | 'qtypeBoolean' | 'confirmYes' | 'confirmNo' | 'approve' | '
|
|
55
|
+
type StringKey = 'launcherOpen' | 'launcherAsk' | 'panelTitle' | 'composerPlaceholder' | 'send' | 'stop' | 'queueMessage' | 'removeQueuedMessage' | 'removeAttachment' | 'suggestedReplies' | 'compactingContext' | 'attach' | 'file' | 'micBlocked' | 'micStart' | 'micStop' | 'expand' | 'collapse' | 'fullscreen' | 'exitFullscreen' | 'popOut' | 'resizeHandle' | 'scrollToBottom' | 'close' | 'moreActions' | 'soundOn' | 'soundOff' | 'language' | 'theme' | 'themeAuto' | 'themeLight' | 'themeDark' | 'textSize' | 'textSizeSmall' | 'textSizeNormal' | 'textSizeLarge' | 'history' | 'historyTitle' | 'historyEmpty' | 'historyLoading' | 'historyBack' | 'historyContinue' | 'loadMoreConversations' | 'conversationLoading' | 'loadPreviousMessages' | 'talkToOperator' | 'connectingOperator' | 'noOperatorAvailable' | 'chattingWithOperator' | 'operatorBadgeTitle' | 'chatNotice' | 'cancelOperatorRequest' | 'loginPrompt' | 'loginAction' | 'loginRequired' | 'loginExpired' | 'loginExpiredGuest' | 'startAsGuest' | 'loggedInAs' | 'loggedIn' | 'dismissLoginPrompt' | 'emailTranscript' | 'emailTranscriptPrompt' | 'emailTranscriptEmailLabel' | 'emailTranscriptSend' | 'emailTranscriptSending' | 'emailTranscriptSent' | 'emailTranscriptAlreadySent' | 'emailTranscriptLimited' | 'emailTranscriptFailed' | 'emailTranscriptNotDelivered' | 'emailTranscriptCancel' | 'emailTranscriptDone' | 'dateToday' | 'dateYesterday' | 'dateLastWeek' | 'dateOlder' | 'newConversation' | 'dropZone' | 'dropZoneRejected' | 'attachmentTooLarge' | 'poweredBy' | 'attachmentTooMany' | 'attachmentMimeRejected' | 'attachmentUploadFailed' | 'errorRetry' | 'errorGeneric' | 'errorRateLimited' | 'errorRateLimitedIn' | 'errorOffline' | 'errorServer' | 'errorOriginNotAllowed' | 'errorMessageTooLong' | 'errorReconnecting' | 'loading' | 'visualPreparing' | 'visualError' | 'visualPartial' | 'visualSoldOut' | 'visualCartEmpty' | 'visualQuantity' | 'visualChoose' | 'thinking' | 'thought' | 'thoughtFor' | 'toolResult' | 'sources' | 'feedbackUp' | 'feedbackDown' | 'feedbackThanks' | 'copy' | 'copied' | 'copyTicketReference' | 'collapseSidebar' | 'expandSidebar' | 'formRequired' | 'formInvalidEmail' | 'formInvalidTel' | 'formInvalidNumber' | 'formOtherPlaceholder' | 'inputRequired' | 'askFallbackQuestion' | 'inputBadge' | 'inputAnswered' | 'inputSkipped' | 'inputSubmit' | 'inputSubmitHint' | 'inputSkip' | 'showOptions' | 'hideOptions' | 'qtypeText' | 'qtypeEmail' | 'qtypePhone' | 'qtypeNumber' | 'qtypeDate' | 'qtypeChooseOne' | 'qtypeChooseAny' | 'qtypeBoolean' | 'confirmYes' | 'confirmNo' | 'approve' | 'decline' | 'changeAnswer' | 'approvalPrompt' | 'approvalEditHint' | 'stepInput' | 'stepWorking' | 'stepWorkingOnIt' | 'stepNeedsYourApproval' | 'stepWaitingForVisitor' | 'stepApproved' | 'stepDeclined' | 'stepReplaced' | 'stepFailed' | 'stepDidNotWork' | 'decidedYouApproved' | 'decidedYouDeclined' | 'decidedVisitorApproved' | 'decidedVisitorDeclined' | 'decidedTeamApproved' | 'decidedTeamDeclined' | 'decidedRulesApproved' | 'decidedRulesDeclined' | 'edit' | 'statusError' | 'toolStepsFailed' | 'statusStopped' | 'toolStepsStopped' | 'toolStepsStoppedOne' | 'tabHome' | 'tabConversations' | 'tabHelp' | 'tabNews' | 'modulesEmpty' | 'chatUnavailable' | 'moduleBack' | 'contentLoading' | 'contentHelpful' | 'homeGreeting' | 'homeGreetingNamed' | 'homeGreetingLead' | 'homeSearchPlaceholder' | 'homeAskPlaceholder' | 'homeWhatsNew' | 'homeContentTitle' | 'homeStatus' | 'helpTitle' | 'helpSearchPlaceholder' | 'helpEmpty' | 'helpLoading' | 'helpSearchEmpty' | 'helpShowMore' | 'newsTitle' | 'newsEmpty' | 'newsLoading' | 'newsShowMore' | 'newsUnseen' | 'unread';
|
|
56
56
|
/** A partial map for one locale — what overrides look like on the wire. */
|
|
57
57
|
type LocaleStrings = Partial<Record<StringKey, string>>;
|
|
58
58
|
/**
|
|
@@ -518,6 +518,23 @@ interface PresentationOptions {
|
|
|
518
518
|
position?: Position;
|
|
519
519
|
size?: SizeOptions;
|
|
520
520
|
}
|
|
521
|
+
/** How a call this page ran (or found cut short) ended, for the `toolResult` event. */
|
|
522
|
+
type PageToolCallStatus = 'completed' | 'failed' | 'interrupted';
|
|
523
|
+
/** A 👍/👎 reaction on a rateable (assistant/operator) message; `null` clears a prior choice. */
|
|
524
|
+
type FeedbackValue = 'up' | 'down' | null;
|
|
525
|
+
/** The five switches, the same keys on a Deployment (`config.behavior.stepDisplay`) and in a member's Preferences. */
|
|
526
|
+
interface StepDisplay {
|
|
527
|
+
/** Every step appears as one folded line under the reply; off, only the steps that involve the reader do. */
|
|
528
|
+
showSteps: boolean;
|
|
529
|
+
/** Each step opens to its raw input and result. */
|
|
530
|
+
showStepDetails: boolean;
|
|
531
|
+
/** The system that ran a step follows its name: "Ship an order · BC Co. back office". */
|
|
532
|
+
showStepSystem: boolean;
|
|
533
|
+
/** Each approval says who decided it, and steps the rules decided show as steps. */
|
|
534
|
+
showDecidedBy: boolean;
|
|
535
|
+
/** A decided approval folds into the steps line; off, it stays in the reply as a card. */
|
|
536
|
+
foldApprovals: boolean;
|
|
537
|
+
}
|
|
521
538
|
/**
|
|
522
539
|
* Section: conversation runtime behaviour — auto-open, streaming mode, and the
|
|
523
540
|
* transcript surface (what renders, how it scrolls, reaction controls).
|
|
@@ -529,8 +546,8 @@ interface BehaviorOptions {
|
|
|
529
546
|
responseMode?: ResponseMode;
|
|
530
547
|
/** Show the model's reasoning ("thoughts") as a collapsible block. Default `false`. */
|
|
531
548
|
showReasoning?: boolean;
|
|
532
|
-
/**
|
|
533
|
-
|
|
549
|
+
/** How the AI's steps and approvals show; unset keys take the Simple preset. */
|
|
550
|
+
stepDisplay?: Partial<StepDisplay>;
|
|
534
551
|
/** Show citation sources (web links + document references) in the transcript. Default `false`. */
|
|
535
552
|
showSources?: boolean;
|
|
536
553
|
/** Turn OFF the 👍/👎 feedback controls on rateable (assistant/operator) replies. Unset/`false` = shown (default). */
|
|
@@ -774,6 +791,7 @@ interface ToolAnnotations {
|
|
|
774
791
|
interface ModelContextTool<TInput = unknown> {
|
|
775
792
|
/** Letters, digits, `_` and `-` (58 at most; others become `_`). A name registered again replaces the earlier tool. */
|
|
776
793
|
name: string;
|
|
794
|
+
/** Its name as people read it ("Place your order"): what the visitor's card calls the action. */
|
|
777
795
|
title?: string;
|
|
778
796
|
/** When the agent should use it and what it does (1024 characters at most). */
|
|
779
797
|
description: string;
|
|
@@ -784,6 +802,12 @@ interface ModelContextTool<TInput = unknown> {
|
|
|
784
802
|
execute(input: TInput, options: {
|
|
785
803
|
signal: AbortSignal;
|
|
786
804
|
}): unknown;
|
|
805
|
+
/**
|
|
806
|
+
* For a tool with `consequentialHint`: what the call will do, shown on the visitor's approval card before they decide.
|
|
807
|
+
* Return the cart (`{ lines, totals }`) or order (`{ number, status, items, totals }`) shape the chat's cards draw; it
|
|
808
|
+
* must not change anything. A failed or missing preview leaves the card with the call's own values.
|
|
809
|
+
*/
|
|
810
|
+
preview?(input: TInput): unknown;
|
|
787
811
|
}
|
|
788
812
|
interface ChatWidgetOptions {
|
|
789
813
|
/**
|
|
@@ -914,8 +938,8 @@ interface ResolvedOptions {
|
|
|
914
938
|
responseMode: ResponseMode;
|
|
915
939
|
/** Show reasoning ("thoughts") as a collapsible block. Default `false`. */
|
|
916
940
|
showReasoning: boolean;
|
|
917
|
-
/**
|
|
918
|
-
|
|
941
|
+
/** How the AI's steps and approvals show: the Deployment's settings over the Simple preset. */
|
|
942
|
+
stepDisplay: StepDisplay;
|
|
919
943
|
/** Show citation sources (web links + document references) in the transcript. Default `false`. */
|
|
920
944
|
showSources: boolean;
|
|
921
945
|
/** Show 👍/👎 feedback controls on rateable (assistant/operator) replies. Default `true`. */
|
|
@@ -1008,8 +1032,6 @@ interface ResolvedOptions {
|
|
|
1008
1032
|
onClose?: ChatWidgetOptions['onClose'];
|
|
1009
1033
|
onError?: ChatWidgetOptions['onError'];
|
|
1010
1034
|
}
|
|
1011
|
-
/** How a call this page ran (or found cut short) ended, for the `toolResult` event. */
|
|
1012
|
-
type PageToolCallStatus = 'completed' | 'failed' | 'interrupted';
|
|
1013
1035
|
/** A single image asset (logo, hero, icon). */
|
|
1014
1036
|
declare const assetSchema: z.ZodObject<{
|
|
1015
1037
|
url: z.ZodString;
|
|
@@ -1129,7 +1151,13 @@ declare const widgetSettingsSchema: z.ZodObject<{
|
|
|
1129
1151
|
streaming: "streaming";
|
|
1130
1152
|
}>>;
|
|
1131
1153
|
showReasoning: z.ZodDefault<z.ZodBoolean>;
|
|
1132
|
-
|
|
1154
|
+
stepDisplay: z.ZodOptional<z.ZodObject<{
|
|
1155
|
+
showSteps: z.ZodOptional<z.ZodBoolean>;
|
|
1156
|
+
showStepDetails: z.ZodOptional<z.ZodBoolean>;
|
|
1157
|
+
showStepSystem: z.ZodOptional<z.ZodBoolean>;
|
|
1158
|
+
showDecidedBy: z.ZodOptional<z.ZodBoolean>;
|
|
1159
|
+
foldApprovals: z.ZodOptional<z.ZodBoolean>;
|
|
1160
|
+
}, z.core.$strip>>;
|
|
1133
1161
|
showSources: z.ZodDefault<z.ZodBoolean>;
|
|
1134
1162
|
disableMessageFeedback: z.ZodDefault<z.ZodBoolean>;
|
|
1135
1163
|
autoSendSuggestions: z.ZodDefault<z.ZodBoolean>;
|
|
@@ -1408,7 +1436,13 @@ declare const widgetConfigSchema: z.ZodObject<{
|
|
|
1408
1436
|
streaming: "streaming";
|
|
1409
1437
|
}>>;
|
|
1410
1438
|
showReasoning: z.ZodDefault<z.ZodBoolean>;
|
|
1411
|
-
|
|
1439
|
+
stepDisplay: z.ZodOptional<z.ZodObject<{
|
|
1440
|
+
showSteps: z.ZodOptional<z.ZodBoolean>;
|
|
1441
|
+
showStepDetails: z.ZodOptional<z.ZodBoolean>;
|
|
1442
|
+
showStepSystem: z.ZodOptional<z.ZodBoolean>;
|
|
1443
|
+
showDecidedBy: z.ZodOptional<z.ZodBoolean>;
|
|
1444
|
+
foldApprovals: z.ZodOptional<z.ZodBoolean>;
|
|
1445
|
+
}, z.core.$strip>>;
|
|
1412
1446
|
showSources: z.ZodDefault<z.ZodBoolean>;
|
|
1413
1447
|
disableMessageFeedback: z.ZodDefault<z.ZodBoolean>;
|
|
1414
1448
|
autoSendSuggestions: z.ZodDefault<z.ZodBoolean>;
|
|
@@ -1688,7 +1722,13 @@ declare const widgetConfigPartialSchema: z.ZodObject<{
|
|
|
1688
1722
|
streaming: "streaming";
|
|
1689
1723
|
}>>;
|
|
1690
1724
|
showReasoning: z.ZodDefault<z.ZodBoolean>;
|
|
1691
|
-
|
|
1725
|
+
stepDisplay: z.ZodOptional<z.ZodObject<{
|
|
1726
|
+
showSteps: z.ZodOptional<z.ZodBoolean>;
|
|
1727
|
+
showStepDetails: z.ZodOptional<z.ZodBoolean>;
|
|
1728
|
+
showStepSystem: z.ZodOptional<z.ZodBoolean>;
|
|
1729
|
+
showDecidedBy: z.ZodOptional<z.ZodBoolean>;
|
|
1730
|
+
foldApprovals: z.ZodOptional<z.ZodBoolean>;
|
|
1731
|
+
}, z.core.$strip>>;
|
|
1692
1732
|
showSources: z.ZodDefault<z.ZodBoolean>;
|
|
1693
1733
|
disableMessageFeedback: z.ZodDefault<z.ZodBoolean>;
|
|
1694
1734
|
autoSendSuggestions: z.ZodDefault<z.ZodBoolean>;
|
|
@@ -1930,7 +1970,13 @@ declare const widgetSettingsPartialSchema: z.ZodObject<{
|
|
|
1930
1970
|
streaming: "streaming";
|
|
1931
1971
|
}>>;
|
|
1932
1972
|
showReasoning: z.ZodDefault<z.ZodBoolean>;
|
|
1933
|
-
|
|
1973
|
+
stepDisplay: z.ZodOptional<z.ZodObject<{
|
|
1974
|
+
showSteps: z.ZodOptional<z.ZodBoolean>;
|
|
1975
|
+
showStepDetails: z.ZodOptional<z.ZodBoolean>;
|
|
1976
|
+
showStepSystem: z.ZodOptional<z.ZodBoolean>;
|
|
1977
|
+
showDecidedBy: z.ZodOptional<z.ZodBoolean>;
|
|
1978
|
+
foldApprovals: z.ZodOptional<z.ZodBoolean>;
|
|
1979
|
+
}, z.core.$strip>>;
|
|
1934
1980
|
showSources: z.ZodDefault<z.ZodBoolean>;
|
|
1935
1981
|
disableMessageFeedback: z.ZodDefault<z.ZodBoolean>;
|
|
1936
1982
|
autoSendSuggestions: z.ZodDefault<z.ZodBoolean>;
|
|
@@ -2227,7 +2273,13 @@ declare const serverConfigSchema: z.ZodObject<{
|
|
|
2227
2273
|
streaming: "streaming";
|
|
2228
2274
|
}>>;
|
|
2229
2275
|
showReasoning: z.ZodDefault<z.ZodBoolean>;
|
|
2230
|
-
|
|
2276
|
+
stepDisplay: z.ZodOptional<z.ZodObject<{
|
|
2277
|
+
showSteps: z.ZodOptional<z.ZodBoolean>;
|
|
2278
|
+
showStepDetails: z.ZodOptional<z.ZodBoolean>;
|
|
2279
|
+
showStepSystem: z.ZodOptional<z.ZodBoolean>;
|
|
2280
|
+
showDecidedBy: z.ZodOptional<z.ZodBoolean>;
|
|
2281
|
+
foldApprovals: z.ZodOptional<z.ZodBoolean>;
|
|
2282
|
+
}, z.core.$strip>>;
|
|
2231
2283
|
showSources: z.ZodDefault<z.ZodBoolean>;
|
|
2232
2284
|
disableMessageFeedback: z.ZodDefault<z.ZodBoolean>;
|
|
2233
2285
|
autoSendSuggestions: z.ZodDefault<z.ZodBoolean>;
|
|
@@ -2546,7 +2598,13 @@ declare const handshakeResponseSchema: z.ZodObject<{
|
|
|
2546
2598
|
streaming: "streaming";
|
|
2547
2599
|
}>>;
|
|
2548
2600
|
showReasoning: z.ZodDefault<z.ZodBoolean>;
|
|
2549
|
-
|
|
2601
|
+
stepDisplay: z.ZodOptional<z.ZodObject<{
|
|
2602
|
+
showSteps: z.ZodOptional<z.ZodBoolean>;
|
|
2603
|
+
showStepDetails: z.ZodOptional<z.ZodBoolean>;
|
|
2604
|
+
showStepSystem: z.ZodOptional<z.ZodBoolean>;
|
|
2605
|
+
showDecidedBy: z.ZodOptional<z.ZodBoolean>;
|
|
2606
|
+
foldApprovals: z.ZodOptional<z.ZodBoolean>;
|
|
2607
|
+
}, z.core.$strip>>;
|
|
2550
2608
|
showSources: z.ZodDefault<z.ZodBoolean>;
|
|
2551
2609
|
disableMessageFeedback: z.ZodDefault<z.ZodBoolean>;
|
|
2552
2610
|
autoSendSuggestions: z.ZodDefault<z.ZodBoolean>;
|
|
@@ -2803,8 +2861,6 @@ declare const handshakeResponseSchema: z.ZodObject<{
|
|
|
2803
2861
|
}, z.core.$strict>>;
|
|
2804
2862
|
}, z.core.$loose>;
|
|
2805
2863
|
type HandshakeResponse = z.infer<typeof handshakeResponseSchema>;
|
|
2806
|
-
/** A 👍/👎 reaction on a rateable (assistant/operator) message; `null` clears a prior choice. */
|
|
2807
|
-
type FeedbackValue = 'up' | 'down' | null;
|
|
2808
2864
|
/**
|
|
2809
2865
|
* Payload shape per event. Keyed by event name; use `void` for events that
|
|
2810
2866
|
* carry no data.
|