@helpai/elements 6.8.0 โ 6.10.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/page-tools.md +4 -3
- package/elements-web-component.esm.js +31 -31
- package/elements-web-component.esm.js.map +3 -3
- package/elements.cjs.js +31 -31
- package/elements.cjs.js.map +3 -3
- package/elements.esm.js +32 -32
- package/elements.esm.js.map +3 -3
- package/elements.js +34 -34
- package/elements.js.map +3 -3
- package/index.d.ts +107 -15
- package/index.mjs +19 -19
- package/llms-full.txt +144 -143
- package/llms.txt +19 -19
- package/package.json +1 -1
- package/react.d.ts +107 -15
- package/react.mjs +36 -36
- package/schema.d.ts +91 -7
- package/schema.json +58 -12
- package/schema.mjs +1 -1
- package/step-display.d.ts +53 -26
- package/step-display.mjs +2 -2
- package/web-component.d.ts +42 -11
- package/web-component.mjs +19 -19
package/index.d.ts
CHANGED
|
@@ -521,21 +521,41 @@ type PageToolCallStatus = 'completed' | 'failed' | 'interrupted';
|
|
|
521
521
|
/** A ๐/๐ reaction on a rateable (assistant/operator) message; `null` clears a prior choice. */
|
|
522
522
|
type FeedbackValue = 'up' | 'down' | null;
|
|
523
523
|
/**
|
|
524
|
-
*
|
|
525
|
-
*
|
|
526
|
-
*
|
|
524
|
+
* The kinds of steps a reader may choose to see, folded into one line under the reply: `decided`, it asked a person
|
|
525
|
+
* (a visitor or another member); `auto-decided`, the rules decided it; `unasked`, it ran without asking; `failed`, it
|
|
526
|
+
* failed, whoever decided it. A step has every kind that applies ("auto-decided" and "failed" both, for an approved
|
|
527
|
+
* call that then failed) and shows when any of them is chosen. The reader's own decisions and anything waiting on
|
|
528
|
+
* someone always show.
|
|
527
529
|
*/
|
|
528
|
-
declare const
|
|
530
|
+
declare const STEP_KINDS: readonly ['decided', 'auto-decided', 'unasked', 'failed'];
|
|
531
|
+
type StepKind = (typeof STEP_KINDS)[number];
|
|
532
|
+
/**
|
|
533
|
+
* Where a step came from, as the server marks every call (`toolMetadata.origin`), set once where each family of tools
|
|
534
|
+
* is built: `platform`, help.ai's own tools; `mcp`, an MCP server's (an integration, help.ai's own MCP included);
|
|
535
|
+
* `api`, a call to an API integration; `webmcp`, the page's own tools, run in the visitor's browser (those the site
|
|
536
|
+
* hands the widget and those the browser offers through WebMCP).
|
|
537
|
+
*/
|
|
538
|
+
declare const STEP_ORIGINS: readonly ['platform', 'mcp', 'api', 'webmcp'];
|
|
539
|
+
type StepOrigin = (typeof STEP_ORIGINS)[number];
|
|
540
|
+
/**
|
|
541
|
+
* What an opened step shows: `none`, nothing (the step line alone, for a business that never shows a visitor's data
|
|
542
|
+
* back); `values`, its values as quiet label and value lines without ids; `table`, tables of what it ran on (ids
|
|
543
|
+
* included) and what came back; `json`, its raw input and result; `table-and-json`, the tables with the JSON folded
|
|
544
|
+
* under Raw data. A step waiting on a decision shows its values whatever this says.
|
|
545
|
+
*/
|
|
546
|
+
declare const STEP_DETAILS: readonly ['none', 'values', 'table', 'json', 'table-and-json'];
|
|
529
547
|
type StepDetails = (typeof STEP_DETAILS)[number];
|
|
530
548
|
/** The settings, the same keys on a Deployment (`config.behavior.stepDisplay`) and in a member's Preferences. */
|
|
531
549
|
interface StepDisplay {
|
|
532
|
-
/**
|
|
533
|
-
|
|
550
|
+
/** The origins whose steps may appear (`STEP_ORIGINS`), in any combination. */
|
|
551
|
+
stepsFrom: readonly StepOrigin[];
|
|
552
|
+
/** The kinds of steps that appear (`STEP_KINDS`), in any combination: a step from a chosen origin shows when any of its kinds is chosen. */
|
|
553
|
+
stepsShown: readonly StepKind[];
|
|
534
554
|
/** What an opened step shows (`STEP_DETAILS`). */
|
|
535
555
|
stepDetails: StepDetails;
|
|
536
556
|
/** The system that ran a step follows its name: "Ship an order ยท BC Co. back office". */
|
|
537
557
|
showStepSystem: boolean;
|
|
538
|
-
/** Each
|
|
558
|
+
/** Each decision someone else or the rules made says who made it. */
|
|
539
559
|
showDecidedBy: boolean;
|
|
540
560
|
/** A decided approval folds into the steps line; off, it stays in the reply as a card. */
|
|
541
561
|
foldApprovals: boolean;
|
|
@@ -551,7 +571,7 @@ interface BehaviorOptions {
|
|
|
551
571
|
responseMode?: ResponseMode;
|
|
552
572
|
/** Show the model's reasoning ("thoughts") as a collapsible block. Default `false`. */
|
|
553
573
|
showReasoning?: boolean;
|
|
554
|
-
/** How the AI's steps and approvals show; unset keys take the
|
|
574
|
+
/** How the AI's steps and approvals show; unset keys take the visitor defaults. */
|
|
555
575
|
stepDisplay?: Partial<StepDisplay>;
|
|
556
576
|
/** Show citation sources (web links + document references) in the transcript. Default `false`. */
|
|
557
577
|
showSources?: boolean;
|
|
@@ -943,7 +963,7 @@ interface ResolvedOptions {
|
|
|
943
963
|
responseMode: ResponseMode;
|
|
944
964
|
/** Show reasoning ("thoughts") as a collapsible block. Default `false`. */
|
|
945
965
|
showReasoning: boolean;
|
|
946
|
-
/** How the AI's steps and approvals show: the Deployment's settings over the
|
|
966
|
+
/** How the AI's steps and approvals show: the Deployment's settings over the visitor defaults. */
|
|
947
967
|
stepDisplay: StepDisplay;
|
|
948
968
|
/** Show citation sources (web links + document references) in the transcript. Default `false`. */
|
|
949
969
|
showSources: boolean;
|
|
@@ -1158,9 +1178,21 @@ declare const widgetSettingsSchema: z.ZodObject<{
|
|
|
1158
1178
|
}>>;
|
|
1159
1179
|
showReasoning: z.ZodDefault<z.ZodBoolean>;
|
|
1160
1180
|
stepDisplay: z.ZodOptional<z.ZodObject<{
|
|
1161
|
-
|
|
1181
|
+
stepsFrom: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
1182
|
+
api: "api";
|
|
1183
|
+
mcp: "mcp";
|
|
1184
|
+
platform: "platform";
|
|
1185
|
+
webmcp: "webmcp";
|
|
1186
|
+
}>>>;
|
|
1187
|
+
stepsShown: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
1188
|
+
"auto-decided": "auto-decided";
|
|
1189
|
+
decided: "decided";
|
|
1190
|
+
failed: "failed";
|
|
1191
|
+
unasked: "unasked";
|
|
1192
|
+
}>>>;
|
|
1162
1193
|
stepDetails: z.ZodOptional<z.ZodEnum<{
|
|
1163
1194
|
json: "json";
|
|
1195
|
+
none: "none";
|
|
1164
1196
|
table: "table";
|
|
1165
1197
|
"table-and-json": "table-and-json";
|
|
1166
1198
|
values: "values";
|
|
@@ -1448,9 +1480,21 @@ declare const widgetConfigSchema: z.ZodObject<{
|
|
|
1448
1480
|
}>>;
|
|
1449
1481
|
showReasoning: z.ZodDefault<z.ZodBoolean>;
|
|
1450
1482
|
stepDisplay: z.ZodOptional<z.ZodObject<{
|
|
1451
|
-
|
|
1483
|
+
stepsFrom: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
1484
|
+
api: "api";
|
|
1485
|
+
mcp: "mcp";
|
|
1486
|
+
platform: "platform";
|
|
1487
|
+
webmcp: "webmcp";
|
|
1488
|
+
}>>>;
|
|
1489
|
+
stepsShown: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
1490
|
+
"auto-decided": "auto-decided";
|
|
1491
|
+
decided: "decided";
|
|
1492
|
+
failed: "failed";
|
|
1493
|
+
unasked: "unasked";
|
|
1494
|
+
}>>>;
|
|
1452
1495
|
stepDetails: z.ZodOptional<z.ZodEnum<{
|
|
1453
1496
|
json: "json";
|
|
1497
|
+
none: "none";
|
|
1454
1498
|
table: "table";
|
|
1455
1499
|
"table-and-json": "table-and-json";
|
|
1456
1500
|
values: "values";
|
|
@@ -1739,9 +1783,21 @@ declare const widgetConfigPartialSchema: z.ZodObject<{
|
|
|
1739
1783
|
}>>;
|
|
1740
1784
|
showReasoning: z.ZodDefault<z.ZodBoolean>;
|
|
1741
1785
|
stepDisplay: z.ZodOptional<z.ZodObject<{
|
|
1742
|
-
|
|
1786
|
+
stepsFrom: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
1787
|
+
api: "api";
|
|
1788
|
+
mcp: "mcp";
|
|
1789
|
+
platform: "platform";
|
|
1790
|
+
webmcp: "webmcp";
|
|
1791
|
+
}>>>;
|
|
1792
|
+
stepsShown: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
1793
|
+
"auto-decided": "auto-decided";
|
|
1794
|
+
decided: "decided";
|
|
1795
|
+
failed: "failed";
|
|
1796
|
+
unasked: "unasked";
|
|
1797
|
+
}>>>;
|
|
1743
1798
|
stepDetails: z.ZodOptional<z.ZodEnum<{
|
|
1744
1799
|
json: "json";
|
|
1800
|
+
none: "none";
|
|
1745
1801
|
table: "table";
|
|
1746
1802
|
"table-and-json": "table-and-json";
|
|
1747
1803
|
values: "values";
|
|
@@ -1992,9 +2048,21 @@ declare const widgetSettingsPartialSchema: z.ZodObject<{
|
|
|
1992
2048
|
}>>;
|
|
1993
2049
|
showReasoning: z.ZodDefault<z.ZodBoolean>;
|
|
1994
2050
|
stepDisplay: z.ZodOptional<z.ZodObject<{
|
|
1995
|
-
|
|
2051
|
+
stepsFrom: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
2052
|
+
api: "api";
|
|
2053
|
+
mcp: "mcp";
|
|
2054
|
+
platform: "platform";
|
|
2055
|
+
webmcp: "webmcp";
|
|
2056
|
+
}>>>;
|
|
2057
|
+
stepsShown: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
2058
|
+
"auto-decided": "auto-decided";
|
|
2059
|
+
decided: "decided";
|
|
2060
|
+
failed: "failed";
|
|
2061
|
+
unasked: "unasked";
|
|
2062
|
+
}>>>;
|
|
1996
2063
|
stepDetails: z.ZodOptional<z.ZodEnum<{
|
|
1997
2064
|
json: "json";
|
|
2065
|
+
none: "none";
|
|
1998
2066
|
table: "table";
|
|
1999
2067
|
"table-and-json": "table-and-json";
|
|
2000
2068
|
values: "values";
|
|
@@ -2300,9 +2368,21 @@ declare const serverConfigSchema: z.ZodObject<{
|
|
|
2300
2368
|
}>>;
|
|
2301
2369
|
showReasoning: z.ZodDefault<z.ZodBoolean>;
|
|
2302
2370
|
stepDisplay: z.ZodOptional<z.ZodObject<{
|
|
2303
|
-
|
|
2371
|
+
stepsFrom: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
2372
|
+
api: "api";
|
|
2373
|
+
mcp: "mcp";
|
|
2374
|
+
platform: "platform";
|
|
2375
|
+
webmcp: "webmcp";
|
|
2376
|
+
}>>>;
|
|
2377
|
+
stepsShown: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
2378
|
+
"auto-decided": "auto-decided";
|
|
2379
|
+
decided: "decided";
|
|
2380
|
+
failed: "failed";
|
|
2381
|
+
unasked: "unasked";
|
|
2382
|
+
}>>>;
|
|
2304
2383
|
stepDetails: z.ZodOptional<z.ZodEnum<{
|
|
2305
2384
|
json: "json";
|
|
2385
|
+
none: "none";
|
|
2306
2386
|
table: "table";
|
|
2307
2387
|
"table-and-json": "table-and-json";
|
|
2308
2388
|
values: "values";
|
|
@@ -2630,9 +2710,21 @@ declare const handshakeResponseSchema: z.ZodObject<{
|
|
|
2630
2710
|
}>>;
|
|
2631
2711
|
showReasoning: z.ZodDefault<z.ZodBoolean>;
|
|
2632
2712
|
stepDisplay: z.ZodOptional<z.ZodObject<{
|
|
2633
|
-
|
|
2713
|
+
stepsFrom: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
2714
|
+
api: "api";
|
|
2715
|
+
mcp: "mcp";
|
|
2716
|
+
platform: "platform";
|
|
2717
|
+
webmcp: "webmcp";
|
|
2718
|
+
}>>>;
|
|
2719
|
+
stepsShown: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
2720
|
+
"auto-decided": "auto-decided";
|
|
2721
|
+
decided: "decided";
|
|
2722
|
+
failed: "failed";
|
|
2723
|
+
unasked: "unasked";
|
|
2724
|
+
}>>>;
|
|
2634
2725
|
stepDetails: z.ZodOptional<z.ZodEnum<{
|
|
2635
2726
|
json: "json";
|
|
2727
|
+
none: "none";
|
|
2636
2728
|
table: "table";
|
|
2637
2729
|
"table-and-json": "table-and-json";
|
|
2638
2730
|
values: "values";
|