@copilotkit/shared 1.84.2-canary.1793809041 → 1.85.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/README.md +1 -1
- package/dist/a2ui-catalog-schema.cjs +14 -5
- package/dist/a2ui-catalog-schema.cjs.map +1 -1
- package/dist/a2ui-catalog-schema.d.cts +4 -2
- package/dist/a2ui-catalog-schema.d.cts.map +1 -1
- package/dist/a2ui-catalog-schema.d.mts +4 -2
- package/dist/a2ui-catalog-schema.d.mts.map +1 -1
- package/dist/a2ui-catalog-schema.mjs +14 -5
- package/dist/a2ui-catalog-schema.mjs.map +1 -1
- package/dist/event-transforms/open-generative-ui-middleware.cjs +7 -6
- package/dist/event-transforms/open-generative-ui-middleware.cjs.map +1 -1
- package/dist/event-transforms/open-generative-ui-middleware.d.cts.map +1 -1
- package/dist/event-transforms/open-generative-ui-middleware.d.mts.map +1 -1
- package/dist/event-transforms/open-generative-ui-middleware.mjs +7 -6
- package/dist/event-transforms/open-generative-ui-middleware.mjs.map +1 -1
- package/dist/generative-ui/catalog/catalog-export.cjs +329 -0
- package/dist/generative-ui/catalog/catalog-export.cjs.map +1 -0
- package/dist/generative-ui/catalog/catalog-export.d.cts +92 -0
- package/dist/generative-ui/catalog/catalog-export.d.cts.map +1 -0
- package/dist/generative-ui/catalog/catalog-export.d.mts +92 -0
- package/dist/generative-ui/catalog/catalog-export.d.mts.map +1 -0
- package/dist/generative-ui/catalog/catalog-export.mjs +328 -0
- package/dist/generative-ui/catalog/catalog-export.mjs.map +1 -0
- package/dist/generative-ui/catalog/catalog.cjs +314 -0
- package/dist/generative-ui/catalog/catalog.cjs.map +1 -0
- package/dist/generative-ui/catalog/catalog.d.cts +407 -0
- package/dist/generative-ui/catalog/catalog.d.cts.map +1 -0
- package/dist/generative-ui/catalog/catalog.d.mts +407 -0
- package/dist/generative-ui/catalog/catalog.d.mts.map +1 -0
- package/dist/generative-ui/catalog/catalog.mjs +311 -0
- package/dist/generative-ui/catalog/catalog.mjs.map +1 -0
- package/dist/generative-ui/catalog/errors.cjs +13 -0
- package/dist/generative-ui/catalog/errors.cjs.map +1 -0
- package/dist/generative-ui/catalog/errors.d.cts +46 -0
- package/dist/generative-ui/catalog/errors.d.cts.map +1 -0
- package/dist/generative-ui/catalog/errors.d.mts +46 -0
- package/dist/generative-ui/catalog/errors.d.mts.map +1 -0
- package/dist/generative-ui/catalog/errors.mjs +12 -0
- package/dist/generative-ui/catalog/errors.mjs.map +1 -0
- package/dist/generative-ui/catalog/index.d.mts +6 -0
- package/dist/generative-ui/catalog/json-schema.cjs +19 -0
- package/dist/generative-ui/catalog/json-schema.cjs.map +1 -0
- package/dist/generative-ui/catalog/json-schema.d.cts +13 -0
- package/dist/generative-ui/catalog/json-schema.d.cts.map +1 -0
- package/dist/generative-ui/catalog/json-schema.d.mts +13 -0
- package/dist/generative-ui/catalog/json-schema.d.mts.map +1 -0
- package/dist/generative-ui/catalog/json-schema.mjs +18 -0
- package/dist/generative-ui/catalog/json-schema.mjs.map +1 -0
- package/dist/generative-ui/catalog/refs.cjs +20 -0
- package/dist/generative-ui/catalog/refs.cjs.map +1 -0
- package/dist/generative-ui/catalog/refs.d.cts +54 -0
- package/dist/generative-ui/catalog/refs.d.cts.map +1 -0
- package/dist/generative-ui/catalog/refs.d.mts +54 -0
- package/dist/generative-ui/catalog/refs.d.mts.map +1 -0
- package/dist/generative-ui/catalog/refs.mjs +18 -0
- package/dist/generative-ui/catalog/refs.mjs.map +1 -0
- package/dist/generative-ui/catalog/schema.cjs +74 -0
- package/dist/generative-ui/catalog/schema.cjs.map +1 -0
- package/dist/generative-ui/catalog/schema.d.cts +43 -0
- package/dist/generative-ui/catalog/schema.d.cts.map +1 -0
- package/dist/generative-ui/catalog/schema.d.mts +43 -0
- package/dist/generative-ui/catalog/schema.d.mts.map +1 -0
- package/dist/generative-ui/catalog/schema.mjs +68 -0
- package/dist/generative-ui/catalog/schema.mjs.map +1 -0
- package/dist/generative-ui/index.cjs +247 -0
- package/dist/generative-ui/index.d.cts +33 -0
- package/dist/generative-ui/index.d.mts +35 -0
- package/dist/generative-ui/index.mjs +34 -0
- package/dist/generative-ui/is-record.cjs +6 -1
- package/dist/generative-ui/is-record.cjs.map +1 -1
- package/dist/generative-ui/is-record.d.cts +6 -0
- package/dist/generative-ui/is-record.d.cts.map +1 -0
- package/dist/generative-ui/is-record.d.mts +6 -0
- package/dist/generative-ui/is-record.d.mts.map +1 -0
- package/dist/generative-ui/is-record.mjs +6 -2
- package/dist/generative-ui/is-record.mjs.map +1 -1
- package/dist/generative-ui/standard/chart.cjs +56 -0
- package/dist/generative-ui/standard/chart.cjs.map +1 -0
- package/dist/generative-ui/standard/chart.d.cts +142 -0
- package/dist/generative-ui/standard/chart.d.cts.map +1 -0
- package/dist/generative-ui/standard/chart.d.mts +142 -0
- package/dist/generative-ui/standard/chart.d.mts.map +1 -0
- package/dist/generative-ui/standard/chart.mjs +54 -0
- package/dist/generative-ui/standard/chart.mjs.map +1 -0
- package/dist/generative-ui/standard/checks.cjs +74 -0
- package/dist/generative-ui/standard/checks.cjs.map +1 -0
- package/dist/generative-ui/standard/checks.d.cts +74 -0
- package/dist/generative-ui/standard/checks.d.cts.map +1 -0
- package/dist/generative-ui/standard/checks.d.mts +74 -0
- package/dist/generative-ui/standard/checks.d.mts.map +1 -0
- package/dist/generative-ui/standard/checks.mjs +71 -0
- package/dist/generative-ui/standard/checks.mjs.map +1 -0
- package/dist/generative-ui/standard/components.cjs +23 -0
- package/dist/generative-ui/standard/components.cjs.map +1 -0
- package/dist/generative-ui/standard/components.d.cts +24 -0
- package/dist/generative-ui/standard/components.d.cts.map +1 -0
- package/dist/generative-ui/standard/components.d.mts +24 -0
- package/dist/generative-ui/standard/components.d.mts.map +1 -0
- package/dist/generative-ui/standard/components.mjs +22 -0
- package/dist/generative-ui/standard/components.mjs.map +1 -0
- package/dist/generative-ui/standard/composites.cjs +143 -0
- package/dist/generative-ui/standard/composites.cjs.map +1 -0
- package/dist/generative-ui/standard/composites.d.cts +500 -0
- package/dist/generative-ui/standard/composites.d.cts.map +1 -0
- package/dist/generative-ui/standard/composites.d.mts +500 -0
- package/dist/generative-ui/standard/composites.d.mts.map +1 -0
- package/dist/generative-ui/standard/composites.mjs +132 -0
- package/dist/generative-ui/standard/composites.mjs.map +1 -0
- package/dist/generative-ui/standard/data.cjs +176 -0
- package/dist/generative-ui/standard/data.cjs.map +1 -0
- package/dist/generative-ui/standard/data.d.cts +745 -0
- package/dist/generative-ui/standard/data.d.cts.map +1 -0
- package/dist/generative-ui/standard/data.d.mts +745 -0
- package/dist/generative-ui/standard/data.d.mts.map +1 -0
- package/dist/generative-ui/standard/data.mjs +167 -0
- package/dist/generative-ui/standard/data.mjs.map +1 -0
- package/dist/generative-ui/standard/declarations.cjs +40 -0
- package/dist/generative-ui/standard/declarations.cjs.map +1 -0
- package/dist/generative-ui/standard/declarations.d.cts +4604 -0
- package/dist/generative-ui/standard/declarations.d.cts.map +1 -0
- package/dist/generative-ui/standard/declarations.d.mts +4605 -0
- package/dist/generative-ui/standard/declarations.d.mts.map +1 -0
- package/dist/generative-ui/standard/declarations.mjs +39 -0
- package/dist/generative-ui/standard/declarations.mjs.map +1 -0
- package/dist/generative-ui/standard/feedback.cjs +97 -0
- package/dist/generative-ui/standard/feedback.cjs.map +1 -0
- package/dist/generative-ui/standard/feedback.d.cts +227 -0
- package/dist/generative-ui/standard/feedback.d.cts.map +1 -0
- package/dist/generative-ui/standard/feedback.d.mts +227 -0
- package/dist/generative-ui/standard/feedback.d.mts.map +1 -0
- package/dist/generative-ui/standard/feedback.mjs +90 -0
- package/dist/generative-ui/standard/feedback.mjs.map +1 -0
- package/dist/generative-ui/standard/index.d.mts +16 -0
- package/dist/generative-ui/standard/inputs.cjs +333 -0
- package/dist/generative-ui/standard/inputs.cjs.map +1 -0
- package/dist/generative-ui/standard/inputs.d.cts +2658 -0
- package/dist/generative-ui/standard/inputs.d.cts.map +1 -0
- package/dist/generative-ui/standard/inputs.d.mts +2658 -0
- package/dist/generative-ui/standard/inputs.d.mts.map +1 -0
- package/dist/generative-ui/standard/inputs.mjs +318 -0
- package/dist/generative-ui/standard/inputs.mjs.map +1 -0
- package/dist/generative-ui/standard/layout.cjs +289 -0
- package/dist/generative-ui/standard/layout.cjs.map +1 -0
- package/dist/generative-ui/standard/layout.d.cts +2854 -0
- package/dist/generative-ui/standard/layout.d.cts.map +1 -0
- package/dist/generative-ui/standard/layout.d.mts +2854 -0
- package/dist/generative-ui/standard/layout.d.mts.map +1 -0
- package/dist/generative-ui/standard/layout.mjs +269 -0
- package/dist/generative-ui/standard/layout.mjs.map +1 -0
- package/dist/generative-ui/standard/map.cjs +27 -0
- package/dist/generative-ui/standard/map.cjs.map +1 -0
- package/dist/generative-ui/standard/map.d.cts +93 -0
- package/dist/generative-ui/standard/map.d.cts.map +1 -0
- package/dist/generative-ui/standard/map.d.mts +93 -0
- package/dist/generative-ui/standard/map.d.mts.map +1 -0
- package/dist/generative-ui/standard/map.mjs +25 -0
- package/dist/generative-ui/standard/map.mjs.map +1 -0
- package/dist/generative-ui/standard/media.cjs +215 -0
- package/dist/generative-ui/standard/media.cjs.map +1 -0
- package/dist/generative-ui/standard/media.d.cts +968 -0
- package/dist/generative-ui/standard/media.d.cts.map +1 -0
- package/dist/generative-ui/standard/media.d.mts +968 -0
- package/dist/generative-ui/standard/media.d.mts.map +1 -0
- package/dist/generative-ui/standard/media.mjs +205 -0
- package/dist/generative-ui/standard/media.mjs.map +1 -0
- package/dist/generative-ui/standard/parameter-order.cjs +231 -0
- package/dist/generative-ui/standard/parameter-order.cjs.map +1 -0
- package/dist/generative-ui/standard/parameter-order.d.cts +84 -0
- package/dist/generative-ui/standard/parameter-order.d.cts.map +1 -0
- package/dist/generative-ui/standard/parameter-order.d.mts +84 -0
- package/dist/generative-ui/standard/parameter-order.d.mts.map +1 -0
- package/dist/generative-ui/standard/parameter-order.mjs +230 -0
- package/dist/generative-ui/standard/parameter-order.mjs.map +1 -0
- package/dist/generative-ui/standard/styles.cjs +62 -0
- package/dist/generative-ui/standard/styles.cjs.map +1 -0
- package/dist/generative-ui/standard/styles.d.cts +17 -0
- package/dist/generative-ui/standard/styles.d.cts.map +1 -0
- package/dist/generative-ui/standard/styles.d.mts +17 -0
- package/dist/generative-ui/standard/styles.d.mts.map +1 -0
- package/dist/generative-ui/standard/styles.mjs +60 -0
- package/dist/generative-ui/standard/styles.mjs.map +1 -0
- package/dist/generative-ui/standard/text.cjs +226 -0
- package/dist/generative-ui/standard/text.cjs.map +1 -0
- package/dist/generative-ui/standard/text.d.cts +687 -0
- package/dist/generative-ui/standard/text.d.cts.map +1 -0
- package/dist/generative-ui/standard/text.d.mts +687 -0
- package/dist/generative-ui/standard/text.d.mts.map +1 -0
- package/dist/generative-ui/standard/text.mjs +209 -0
- package/dist/generative-ui/standard/text.mjs.map +1 -0
- package/dist/generative-ui/standard/theme.cjs +115 -0
- package/dist/generative-ui/standard/theme.cjs.map +1 -0
- package/dist/generative-ui/standard/theme.d.cts +60 -0
- package/dist/generative-ui/standard/theme.d.cts.map +1 -0
- package/dist/generative-ui/standard/theme.d.mts +60 -0
- package/dist/generative-ui/standard/theme.d.mts.map +1 -0
- package/dist/generative-ui/standard/theme.mjs +112 -0
- package/dist/generative-ui/standard/theme.mjs.map +1 -0
- package/dist/generative-ui/standard/tokens.cjs +336 -0
- package/dist/generative-ui/standard/tokens.cjs.map +1 -0
- package/dist/generative-ui/standard/tokens.d.cts +76 -0
- package/dist/generative-ui/standard/tokens.d.cts.map +1 -0
- package/dist/generative-ui/standard/tokens.d.mts +76 -0
- package/dist/generative-ui/standard/tokens.d.mts.map +1 -0
- package/dist/generative-ui/standard/tokens.mjs +305 -0
- package/dist/generative-ui/standard/tokens.mjs.map +1 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +10 -10
- package/dist/index.d.mts +10 -10
- package/dist/index.mjs.map +1 -1
- package/dist/index.umd.js +16 -7
- package/dist/index.umd.js.map +1 -1
- package/dist/package.cjs +1 -1
- package/dist/package.mjs +1 -1
- package/package.json +7 -3
- package/src/__tests__/a2ui-catalog-schema.test.ts +26 -0
- package/src/a2ui-catalog-schema.ts +14 -5
- package/src/event-transforms/open-generative-ui-middleware.ts +19 -10
- package/src/generative-ui/base.ts +9 -0
- package/src/generative-ui/catalog/catalog-export.ts +478 -0
- package/src/generative-ui/catalog/catalog.ts +1166 -0
- package/src/generative-ui/catalog/errors.ts +102 -0
- package/src/generative-ui/catalog/index.ts +6 -0
- package/src/generative-ui/catalog/json-schema.ts +23 -0
- package/src/generative-ui/catalog/refs.ts +86 -0
- package/src/generative-ui/catalog/schema.ts +107 -0
- package/src/generative-ui/index.ts +7 -0
- package/src/generative-ui/is-record.ts +6 -1
- package/src/generative-ui/standard/__tests__/theme.test.ts +61 -0
- package/src/generative-ui/standard/__tests__/tokens.test.ts +139 -0
- package/src/generative-ui/standard/chart.ts +79 -0
- package/src/generative-ui/standard/checks.ts +98 -0
- package/src/generative-ui/standard/components.ts +35 -0
- package/src/generative-ui/standard/composites.ts +158 -0
- package/src/generative-ui/standard/data.ts +213 -0
- package/src/generative-ui/standard/declarations.ts +57 -0
- package/src/generative-ui/standard/feedback.ts +105 -0
- package/src/generative-ui/standard/index.ts +19 -0
- package/src/generative-ui/standard/inputs.ts +423 -0
- package/src/generative-ui/standard/layout.ts +312 -0
- package/src/generative-ui/standard/map.ts +32 -0
- package/src/generative-ui/standard/media.ts +265 -0
- package/src/generative-ui/standard/parameter-order.ts +155 -0
- package/src/generative-ui/standard/styles.ts +79 -0
- package/src/generative-ui/standard/text.ts +210 -0
- package/src/generative-ui/standard/theme.ts +198 -0
- package/src/generative-ui/standard/tokens.ts +317 -0
- package/src/index.ts +1 -1
- package/tsdown.config.ts +1 -0
|
@@ -0,0 +1,423 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { checksProp } from "./checks";
|
|
3
|
+
import {
|
|
4
|
+
CHILDREN_SLOT,
|
|
5
|
+
NO_ARGS,
|
|
6
|
+
VISIBLE_EVENT,
|
|
7
|
+
layoutProps,
|
|
8
|
+
weightProp,
|
|
9
|
+
} from "./layout";
|
|
10
|
+
|
|
11
|
+
// ---- Shared schemas ----
|
|
12
|
+
|
|
13
|
+
/** A list of choices: plain strings or `{ value, label, description? }`. */
|
|
14
|
+
const optionList = z
|
|
15
|
+
.array(
|
|
16
|
+
z.union([
|
|
17
|
+
z.string(),
|
|
18
|
+
z.object({
|
|
19
|
+
value: z.string(),
|
|
20
|
+
label: z.string().optional(),
|
|
21
|
+
description: z.string().optional(),
|
|
22
|
+
}),
|
|
23
|
+
]),
|
|
24
|
+
)
|
|
25
|
+
.optional();
|
|
26
|
+
|
|
27
|
+
export type InputOptionList = z.output<typeof optionList>;
|
|
28
|
+
|
|
29
|
+
export const INPUT_SIZES = ["sm", "md", "lg", "xl"] as const;
|
|
30
|
+
export type InputSize = (typeof INPUT_SIZES)[number];
|
|
31
|
+
|
|
32
|
+
const size = (fallback: InputSize) =>
|
|
33
|
+
z.enum(INPUT_SIZES).optional().describe(`Default "${fallback}"`);
|
|
34
|
+
const pill = z.boolean().optional().describe("Default true");
|
|
35
|
+
const fieldLabel = z
|
|
36
|
+
.string()
|
|
37
|
+
.optional()
|
|
38
|
+
.describe("The visible label of the field. Always set it");
|
|
39
|
+
const boundValue = z
|
|
40
|
+
.string()
|
|
41
|
+
.optional()
|
|
42
|
+
.describe('Bind it with { "@path": "/x" } to read what the user entered');
|
|
43
|
+
|
|
44
|
+
export const buttonSchema = z.object({
|
|
45
|
+
label: z.string().optional().describe("The button text"),
|
|
46
|
+
checks: checksProp,
|
|
47
|
+
text: z
|
|
48
|
+
.string()
|
|
49
|
+
.optional()
|
|
50
|
+
.describe("Same as label. Used when label is not set"),
|
|
51
|
+
variant: z
|
|
52
|
+
.enum(["default", "primary", "soft", "borderless"])
|
|
53
|
+
.optional()
|
|
54
|
+
.describe(
|
|
55
|
+
'Default "default": outlined. "primary" is filled, for the one main action. "borderless" has no box, like a link',
|
|
56
|
+
),
|
|
57
|
+
color: z
|
|
58
|
+
.enum(["primary", "secondary", "danger"])
|
|
59
|
+
.optional()
|
|
60
|
+
.describe('Default "primary"'),
|
|
61
|
+
size: z.enum(["sm", "md", "lg"]).optional().describe('Default "lg"'),
|
|
62
|
+
block: z.boolean().optional().describe("Full width"),
|
|
63
|
+
weight: weightProp,
|
|
64
|
+
pill,
|
|
65
|
+
disabled: z.boolean().optional(),
|
|
66
|
+
loading: z.boolean().optional(),
|
|
67
|
+
submit: z
|
|
68
|
+
.boolean()
|
|
69
|
+
.optional()
|
|
70
|
+
.describe("Submits the Form around it. The Form sends its onSubmit event"),
|
|
71
|
+
icon: z.string().optional().describe("Lucide icon name"),
|
|
72
|
+
uniform: z.boolean().optional().describe("A square button, for an icon"),
|
|
73
|
+
href: z
|
|
74
|
+
.string()
|
|
75
|
+
.optional()
|
|
76
|
+
.describe("Opens this URL in a new tab on click, instead of onClick"),
|
|
77
|
+
copy: z
|
|
78
|
+
.string()
|
|
79
|
+
.optional()
|
|
80
|
+
.describe(
|
|
81
|
+
"Copies this text to the clipboard on click and shows a check mark, instead of onClick",
|
|
82
|
+
),
|
|
83
|
+
});
|
|
84
|
+
export const pressableSchema = z.object({
|
|
85
|
+
...layoutProps,
|
|
86
|
+
disabled: z.boolean().optional(),
|
|
87
|
+
hoverBackground: z.string().optional(),
|
|
88
|
+
href: z
|
|
89
|
+
.string()
|
|
90
|
+
.optional()
|
|
91
|
+
.describe("Opens this URL in a new tab on click, instead of onClick"),
|
|
92
|
+
tooltip: z.string().optional().describe("Shown on hover"),
|
|
93
|
+
ariaPressed: z.boolean().optional().describe("For a toggle"),
|
|
94
|
+
insetBorder: z.boolean().optional().describe("A 1px border inside the box"),
|
|
95
|
+
});
|
|
96
|
+
export const formSchema = z.object({
|
|
97
|
+
...layoutProps,
|
|
98
|
+
label: z
|
|
99
|
+
.string()
|
|
100
|
+
.optional()
|
|
101
|
+
.describe("A short name of the form for screen readers"),
|
|
102
|
+
});
|
|
103
|
+
export const textFieldSchema = z.object({
|
|
104
|
+
checks: checksProp,
|
|
105
|
+
value: z
|
|
106
|
+
.union([z.string(), z.number()])
|
|
107
|
+
.optional()
|
|
108
|
+
.describe('Bind it with { "@path": "/x" } to read what the user typed'),
|
|
109
|
+
placeholder: z.string().optional(),
|
|
110
|
+
label: fieldLabel,
|
|
111
|
+
variant: z
|
|
112
|
+
.enum([
|
|
113
|
+
"shortText",
|
|
114
|
+
"longText",
|
|
115
|
+
"number",
|
|
116
|
+
"obscured",
|
|
117
|
+
"email",
|
|
118
|
+
"url",
|
|
119
|
+
"tel",
|
|
120
|
+
])
|
|
121
|
+
.optional()
|
|
122
|
+
.describe(
|
|
123
|
+
'Default "shortText". "longText" is a multi-line field, "obscured" a password',
|
|
124
|
+
),
|
|
125
|
+
weight: weightProp,
|
|
126
|
+
name: z.string().optional(),
|
|
127
|
+
required: z.boolean().optional(),
|
|
128
|
+
disabled: z.boolean().optional(),
|
|
129
|
+
invalid: z.boolean().optional(),
|
|
130
|
+
size: size("xl"),
|
|
131
|
+
pill,
|
|
132
|
+
autoSelect: z.boolean().optional(),
|
|
133
|
+
mask: z.string().optional(),
|
|
134
|
+
});
|
|
135
|
+
export const textAreaSchema = z.object({
|
|
136
|
+
checks: checksProp,
|
|
137
|
+
value: boundValue,
|
|
138
|
+
placeholder: z.string().optional(),
|
|
139
|
+
label: fieldLabel,
|
|
140
|
+
weight: weightProp,
|
|
141
|
+
rows: z.number().optional().describe("Default 3"),
|
|
142
|
+
maxRows: z.number().optional(),
|
|
143
|
+
autoResize: z.boolean().optional(),
|
|
144
|
+
name: z.string().optional(),
|
|
145
|
+
required: z.boolean().optional(),
|
|
146
|
+
disabled: z.boolean().optional(),
|
|
147
|
+
invalid: z.boolean().optional(),
|
|
148
|
+
size: size("xl"),
|
|
149
|
+
});
|
|
150
|
+
export const selectSchema = z.object({
|
|
151
|
+
checks: checksProp,
|
|
152
|
+
value: boundValue,
|
|
153
|
+
options: optionList,
|
|
154
|
+
placeholder: z.string().optional(),
|
|
155
|
+
label: fieldLabel,
|
|
156
|
+
name: z.string().optional(),
|
|
157
|
+
required: z.boolean().optional(),
|
|
158
|
+
disabled: z.boolean().optional(),
|
|
159
|
+
clearable: z.boolean().optional(),
|
|
160
|
+
clearLabel: z.string().optional().describe("The label of the empty option"),
|
|
161
|
+
searchable: z.boolean().optional(),
|
|
162
|
+
icon: z.string().optional().describe("Lucide icon shown before the value"),
|
|
163
|
+
block: z.boolean().optional().describe("Full width"),
|
|
164
|
+
size: size("xl"),
|
|
165
|
+
pill,
|
|
166
|
+
});
|
|
167
|
+
export const checkBoxSchema = z.object({
|
|
168
|
+
checks: checksProp,
|
|
169
|
+
value: z
|
|
170
|
+
.boolean()
|
|
171
|
+
.optional()
|
|
172
|
+
.describe(
|
|
173
|
+
'True when checked. Bind it with { "@path": "/x" } to read the state of the box',
|
|
174
|
+
),
|
|
175
|
+
label: z.string().optional().describe("The label text. Always set it"),
|
|
176
|
+
name: z.string().optional(),
|
|
177
|
+
weight: weightProp,
|
|
178
|
+
disabled: z.boolean().optional(),
|
|
179
|
+
required: z.boolean().optional(),
|
|
180
|
+
lineThrough: z
|
|
181
|
+
.boolean()
|
|
182
|
+
.optional()
|
|
183
|
+
.describe("Default false. Strikes the label when the box is checked"),
|
|
184
|
+
shape: z.enum(["round", "square"]).optional().describe('Default "round"'),
|
|
185
|
+
});
|
|
186
|
+
export const radioSchema = z.object({
|
|
187
|
+
value: z.string().optional(),
|
|
188
|
+
label: z.string().optional(),
|
|
189
|
+
disabled: z.boolean().optional(),
|
|
190
|
+
required: z.boolean().optional(),
|
|
191
|
+
});
|
|
192
|
+
export const radioGroupSchema = z.object({
|
|
193
|
+
checks: checksProp,
|
|
194
|
+
value: boundValue,
|
|
195
|
+
options: optionList,
|
|
196
|
+
label: fieldLabel,
|
|
197
|
+
name: z.string().optional(),
|
|
198
|
+
direction: z.enum(["row", "col"]).optional().describe('Default "row"'),
|
|
199
|
+
variant: z.enum(["list", "pills", "cards"]).optional(),
|
|
200
|
+
disabled: z.boolean().optional(),
|
|
201
|
+
required: z.boolean().optional(),
|
|
202
|
+
});
|
|
203
|
+
export const sliderSchema = z.object({
|
|
204
|
+
checks: checksProp,
|
|
205
|
+
value: z
|
|
206
|
+
.number()
|
|
207
|
+
.optional()
|
|
208
|
+
.describe('Bind it with { "@path": "/x" } to read the number'),
|
|
209
|
+
min: z.number().optional().describe("Default 0"),
|
|
210
|
+
max: z.number().optional().describe("Default 100"),
|
|
211
|
+
step: z.number().optional().describe("Default 1"),
|
|
212
|
+
steps: z
|
|
213
|
+
.number()
|
|
214
|
+
.int()
|
|
215
|
+
.min(1)
|
|
216
|
+
.optional()
|
|
217
|
+
.describe(
|
|
218
|
+
"The number of equal divisions between min and max, instead of step",
|
|
219
|
+
),
|
|
220
|
+
label: fieldLabel,
|
|
221
|
+
weight: weightProp,
|
|
222
|
+
unit: z.string().optional().describe('Unit after the value, for example "%"'),
|
|
223
|
+
marks: z
|
|
224
|
+
.array(z.object({ value: z.number(), label: z.string().optional() }))
|
|
225
|
+
.optional(),
|
|
226
|
+
sliderStyle: z
|
|
227
|
+
.enum(["continuous", "discrete"])
|
|
228
|
+
.optional()
|
|
229
|
+
.describe('Default "continuous"'),
|
|
230
|
+
disabled: z.boolean().optional(),
|
|
231
|
+
name: z.string().optional(),
|
|
232
|
+
});
|
|
233
|
+
export const segmentedControlSchema = z.object({
|
|
234
|
+
checks: checksProp,
|
|
235
|
+
value: boundValue,
|
|
236
|
+
options: optionList,
|
|
237
|
+
label: fieldLabel,
|
|
238
|
+
block: z.boolean().optional().describe("Full width"),
|
|
239
|
+
size: size("lg"),
|
|
240
|
+
pill,
|
|
241
|
+
variant: z
|
|
242
|
+
.enum(["solid", "soft", "outline", "ghost"])
|
|
243
|
+
.optional()
|
|
244
|
+
.describe('Default "ghost"'),
|
|
245
|
+
disabled: z.boolean().optional(),
|
|
246
|
+
});
|
|
247
|
+
export const choicePickerSchema = z.object({
|
|
248
|
+
checks: checksProp,
|
|
249
|
+
value: z
|
|
250
|
+
.array(z.string())
|
|
251
|
+
.optional()
|
|
252
|
+
.describe(
|
|
253
|
+
'The chosen option values. Bind it with { "@path": "/x" } to a string list',
|
|
254
|
+
),
|
|
255
|
+
options: optionList,
|
|
256
|
+
label: fieldLabel,
|
|
257
|
+
variant: z
|
|
258
|
+
.enum(["multipleSelection", "mutuallyExclusive"])
|
|
259
|
+
.optional()
|
|
260
|
+
.describe('Default "mutuallyExclusive": the user picks one option'),
|
|
261
|
+
displayStyle: z
|
|
262
|
+
.enum(["checkbox", "chips"])
|
|
263
|
+
.optional()
|
|
264
|
+
.describe('Default "checkbox". "chips" shows the options as pills'),
|
|
265
|
+
filterable: z
|
|
266
|
+
.boolean()
|
|
267
|
+
.optional()
|
|
268
|
+
.describe("Default false. Shows a field that filters the options"),
|
|
269
|
+
weight: weightProp,
|
|
270
|
+
disabled: z.boolean().optional(),
|
|
271
|
+
required: z.boolean().optional(),
|
|
272
|
+
});
|
|
273
|
+
export const dateTimeInputSchema = z.object({
|
|
274
|
+
checks: checksProp,
|
|
275
|
+
value: z
|
|
276
|
+
.string()
|
|
277
|
+
.optional()
|
|
278
|
+
.describe(
|
|
279
|
+
'ISO 8601: "YYYY-MM-DD", "HH:MM" or "YYYY-MM-DDTHH:MM". Bind it with { "@path": "/x" }',
|
|
280
|
+
),
|
|
281
|
+
label: fieldLabel,
|
|
282
|
+
enableDate: z
|
|
283
|
+
.boolean()
|
|
284
|
+
.optional()
|
|
285
|
+
.describe(
|
|
286
|
+
"The user picks a date. Default true unless only enableTime is set",
|
|
287
|
+
),
|
|
288
|
+
enableTime: z.boolean().optional().describe("The user picks a time"),
|
|
289
|
+
timeStep: z
|
|
290
|
+
.number()
|
|
291
|
+
.int()
|
|
292
|
+
.min(1)
|
|
293
|
+
.max(720)
|
|
294
|
+
.optional()
|
|
295
|
+
.describe(
|
|
296
|
+
"Minutes between the times the user can pick, e.g. 15 or 30. Shows the time as a list",
|
|
297
|
+
),
|
|
298
|
+
weight: weightProp,
|
|
299
|
+
min: z.string().optional().describe("The earliest value, ISO 8601"),
|
|
300
|
+
max: z.string().optional().describe("The latest value, ISO 8601"),
|
|
301
|
+
placeholder: z.string().optional(),
|
|
302
|
+
disabled: z.boolean().optional(),
|
|
303
|
+
required: z.boolean().optional(),
|
|
304
|
+
clearable: z.boolean().optional(),
|
|
305
|
+
block: z.boolean().optional().describe("Full width"),
|
|
306
|
+
});
|
|
307
|
+
|
|
308
|
+
/** The writable list of a control that keeps its state in `value`. */
|
|
309
|
+
const VALUE_WRITABLE = ["value"] as const;
|
|
310
|
+
|
|
311
|
+
// ---- Catalog ----
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* The declarations of the standard input components: Button, Pressable,
|
|
315
|
+
* Form, and the controls. A framework adds its components with
|
|
316
|
+
* `withComponents`.
|
|
317
|
+
*
|
|
318
|
+
* - Button and Pressable send `onClick`. Form sends `onSubmit`. The model
|
|
319
|
+
* binds an event to `{ "event": { "name", "userMessage"?, "context"? } }`
|
|
320
|
+
* or `{ "functionCall": { "@call", "args"? } }`, or an app function with
|
|
321
|
+
* the same name binds it automatically.
|
|
322
|
+
* - The value of a control is writable: `value`.
|
|
323
|
+
* When the model binds it to `{ "@path": "/x" }`, what the user enters goes
|
|
324
|
+
* into the data model at that path, and the agent can no longer change it.
|
|
325
|
+
*/
|
|
326
|
+
export const inputDeclarations = {
|
|
327
|
+
Button: {
|
|
328
|
+
description:
|
|
329
|
+
'Sends its onClick event; with href it opens the URL, with copy it copies the text. Variant "primary" for the one main Button in a Row. submit true submits the Form around it. Its children render instead of the label. With checks it is disabled while a check fails.',
|
|
330
|
+
props: buttonSchema,
|
|
331
|
+
events: {
|
|
332
|
+
onClick: {
|
|
333
|
+
description: "Sent when the user clicks the button.",
|
|
334
|
+
parameters: NO_ARGS,
|
|
335
|
+
},
|
|
336
|
+
},
|
|
337
|
+
slots: { child: "single", children: "multiple" } as const,
|
|
338
|
+
},
|
|
339
|
+
Pressable: {
|
|
340
|
+
description:
|
|
341
|
+
"A layout container that the user can click or press with Enter or Space. It sends its onClick event, or opens href. A control inside it sends only its own event.",
|
|
342
|
+
props: pressableSchema,
|
|
343
|
+
events: {
|
|
344
|
+
...VISIBLE_EVENT,
|
|
345
|
+
onClick: {
|
|
346
|
+
description: "Sent when the user clicks or presses the container.",
|
|
347
|
+
parameters: NO_ARGS,
|
|
348
|
+
},
|
|
349
|
+
},
|
|
350
|
+
slots: CHILDREN_SLOT,
|
|
351
|
+
},
|
|
352
|
+
Form: {
|
|
353
|
+
description:
|
|
354
|
+
'A layout container that is a form. It sends onSubmit when the user submits (a Button with submit true, or Enter in a field). Put its field values in the event context with { "@path": "/x" }.',
|
|
355
|
+
props: formSchema,
|
|
356
|
+
events: {
|
|
357
|
+
onSubmit: {
|
|
358
|
+
description: "Sent when the user submits the form.",
|
|
359
|
+
parameters: NO_ARGS,
|
|
360
|
+
},
|
|
361
|
+
},
|
|
362
|
+
slots: CHILDREN_SLOT,
|
|
363
|
+
},
|
|
364
|
+
TextField: {
|
|
365
|
+
description:
|
|
366
|
+
'A text input, single-line unless variant is "longText". Bind value with { "@path": "/x" } to read what the user typed. Give it a label.',
|
|
367
|
+
props: textFieldSchema,
|
|
368
|
+
writable: VALUE_WRITABLE,
|
|
369
|
+
},
|
|
370
|
+
TextArea: {
|
|
371
|
+
description:
|
|
372
|
+
'A multi-line text input. Bind value with { "@path": "/x" } to read what the user typed. Give it a label.',
|
|
373
|
+
props: textAreaSchema,
|
|
374
|
+
writable: VALUE_WRITABLE,
|
|
375
|
+
},
|
|
376
|
+
Select: {
|
|
377
|
+
description:
|
|
378
|
+
'A dropdown list of options. Bind value with { "@path": "/x" } to read the chosen option. Give it a label.',
|
|
379
|
+
props: selectSchema,
|
|
380
|
+
writable: VALUE_WRITABLE,
|
|
381
|
+
},
|
|
382
|
+
CheckBox: {
|
|
383
|
+
description:
|
|
384
|
+
'A checkbox with a label. Bind value with { "@path": "/x" } to read its state, true or false.',
|
|
385
|
+
props: checkBoxSchema,
|
|
386
|
+
writable: VALUE_WRITABLE,
|
|
387
|
+
},
|
|
388
|
+
Radio: {
|
|
389
|
+
description:
|
|
390
|
+
"One radio button. Use RadioGroup instead, because it keeps the chosen value.",
|
|
391
|
+
props: radioSchema,
|
|
392
|
+
},
|
|
393
|
+
RadioGroup: {
|
|
394
|
+
description:
|
|
395
|
+
'A group of radio buttons. The user chooses one option. Bind value with { "@path": "/x" } to read it. Give it a label.',
|
|
396
|
+
props: radioGroupSchema,
|
|
397
|
+
writable: VALUE_WRITABLE,
|
|
398
|
+
},
|
|
399
|
+
Slider: {
|
|
400
|
+
description:
|
|
401
|
+
'A range slider for a number between min and max. Bind value with { "@path": "/x" } to read the number. Give it a label.',
|
|
402
|
+
props: sliderSchema,
|
|
403
|
+
writable: VALUE_WRITABLE,
|
|
404
|
+
},
|
|
405
|
+
SegmentedControl: {
|
|
406
|
+
description:
|
|
407
|
+
'A row of segments. The user chooses one option. Use it for 2 to 5 short options. Bind value with { "@path": "/x" } to read it.',
|
|
408
|
+
props: segmentedControlSchema,
|
|
409
|
+
writable: VALUE_WRITABLE,
|
|
410
|
+
},
|
|
411
|
+
ChoicePicker: {
|
|
412
|
+
description:
|
|
413
|
+
'Options as checkboxes or chips: pick one, or several with variant "multipleSelection". Its value is the list of chosen values. Give it a label.',
|
|
414
|
+
props: choicePickerSchema,
|
|
415
|
+
writable: VALUE_WRITABLE,
|
|
416
|
+
},
|
|
417
|
+
DateTimeInput: {
|
|
418
|
+
description:
|
|
419
|
+
"A date picker, a time picker with enableTime, or both. timeStep (minutes) offers fixed times, e.g. 30 for a booking. The value is ISO 8601. Give it a label.",
|
|
420
|
+
props: dateTimeInputSchema,
|
|
421
|
+
writable: VALUE_WRITABLE,
|
|
422
|
+
},
|
|
423
|
+
};
|