@wotnak/json-render-react 0.0.0-pr.slots.9c5563f

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/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2025 Vercel Inc.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,376 @@
1
+ # @json-render/react
2
+
3
+ React renderer for json-render. Turn JSON specs into React components with data binding, visibility, and actions.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @json-render/react @json-render/core zod
9
+ ```
10
+
11
+ ## Quick Start
12
+
13
+ ### 1. Create a Catalog
14
+
15
+ ```typescript
16
+ import { defineCatalog } from "@json-render/core";
17
+ import { schema } from "@json-render/react";
18
+ import { z } from "zod";
19
+
20
+ export const catalog = defineCatalog(schema, {
21
+ components: {
22
+ Card: {
23
+ props: z.object({
24
+ title: z.string(),
25
+ description: z.string().nullable(),
26
+ }),
27
+ description: "A card container",
28
+ },
29
+ Button: {
30
+ props: z.object({
31
+ label: z.string(),
32
+ action: z.string(),
33
+ }),
34
+ description: "A clickable button",
35
+ },
36
+ Input: {
37
+ props: z.object({
38
+ value: z.union([z.string(), z.record(z.unknown())]).nullable(),
39
+ label: z.string(),
40
+ placeholder: z.string().nullable(),
41
+ }),
42
+ description: "Text input field with optional value binding",
43
+ },
44
+ },
45
+ actions: {
46
+ submit: { description: "Submit the form" },
47
+ cancel: { description: "Cancel and close" },
48
+ },
49
+ });
50
+ ```
51
+
52
+ ### 2. Define Component Implementations
53
+
54
+ ```tsx
55
+ import { defineRegistry, useBoundProp } from "@json-render/react";
56
+ import { catalog } from "./catalog";
57
+
58
+ export const { registry } = defineRegistry(catalog, {
59
+ components: {
60
+ Card: ({ props, children }) => (
61
+ <div className="card">
62
+ <h3>{props.title}</h3>
63
+ {props.description && <p>{props.description}</p>}
64
+ {children}
65
+ </div>
66
+ ),
67
+ Button: ({ props, emit }) => (
68
+ <button onClick={() => emit("press")}>
69
+ {props.label}
70
+ </button>
71
+ ),
72
+ Input: ({ props, bindings }) => {
73
+ const [value, setValue] = useBoundProp(props.value, bindings?.value);
74
+ return (
75
+ <label>
76
+ {props.label}
77
+ <input
78
+ placeholder={props.placeholder ?? ""}
79
+ value={value ?? ""}
80
+ onChange={(e) => setValue(e.target.value)}
81
+ />
82
+ </label>
83
+ );
84
+ },
85
+ },
86
+ });
87
+ ```
88
+
89
+ ### 3. Render Specs
90
+
91
+ ```tsx
92
+ import { Renderer, StateProvider, ActionProvider } from "@json-render/react";
93
+ import { registry } from "./registry";
94
+
95
+ function App({ spec }) {
96
+ return (
97
+ <StateProvider initialState={{ form: { name: "" } }}>
98
+ <ActionProvider handlers={{
99
+ submit: () => console.log("Submit"),
100
+ }}>
101
+ <Renderer spec={spec} registry={registry} />
102
+ </ActionProvider>
103
+ </StateProvider>
104
+ );
105
+ }
106
+ ```
107
+
108
+ ## Spec Format
109
+
110
+ The React renderer uses a flat element map format:
111
+
112
+ ```typescript
113
+ interface Spec {
114
+ root: string; // Key of the root element
115
+ elements: Record<string, UIElement>; // Flat map of elements by key
116
+ state?: Record<string, unknown>; // Optional initial state
117
+ }
118
+
119
+ interface UIElement {
120
+ type: string; // Component name from catalog
121
+ props: Record<string, unknown>; // Component props
122
+ children?: string[]; // Keys of child elements
123
+ visible?: VisibilityCondition; // Visibility condition
124
+ }
125
+ ```
126
+
127
+ Example spec:
128
+
129
+ ```json
130
+ {
131
+ "root": "card-1",
132
+ "elements": {
133
+ "card-1": {
134
+ "type": "Card",
135
+ "props": { "title": "Welcome" },
136
+ "children": ["input-1", "btn-1"]
137
+ },
138
+ "input-1": {
139
+ "type": "Input",
140
+ "props": {
141
+ "value": { "$bindState": "/form/name" },
142
+ "label": "Name",
143
+ "placeholder": "Enter name"
144
+ }
145
+ },
146
+ "btn-1": {
147
+ "type": "Button",
148
+ "props": { "label": "Submit" },
149
+ "children": []
150
+ }
151
+ }
152
+ }
153
+ ```
154
+
155
+ ## Contexts
156
+
157
+ ### StateProvider
158
+
159
+ Share data across components with JSON Pointer paths:
160
+
161
+ ```tsx
162
+ <StateProvider initialState={{ user: { name: "John" } }}>
163
+ {children}
164
+ </StateProvider>
165
+
166
+ // In components:
167
+ const { state, get, set } = useStateStore();
168
+ const name = get("/user/name"); // "John"
169
+ set("/user/age", 25);
170
+ ```
171
+
172
+ ### ActionProvider
173
+
174
+ Handle actions from components:
175
+
176
+ ```tsx
177
+ <ActionProvider
178
+ handlers={{
179
+ submit: (params) => handleSubmit(params),
180
+ cancel: () => handleCancel(),
181
+ }}
182
+ >
183
+ {children}
184
+ </ActionProvider>
185
+ ```
186
+
187
+ ### VisibilityProvider
188
+
189
+ Control element visibility based on data:
190
+
191
+ ```tsx
192
+ <VisibilityProvider>
193
+ {children}
194
+ </VisibilityProvider>
195
+
196
+ // Elements can use visibility conditions:
197
+ {
198
+ "type": "Alert",
199
+ "props": { "message": "Error!" },
200
+ "visible": { "$state": "/form/hasError" }
201
+ }
202
+ ```
203
+
204
+ ### ValidationProvider
205
+
206
+ Add field validation:
207
+
208
+ ```tsx
209
+ <ValidationProvider>
210
+ {children}
211
+ </ValidationProvider>
212
+
213
+ // Use validation hooks:
214
+ const { errors, validate } = useFieldValidation("/form/email", {
215
+ checks: [
216
+ { type: "required", message: "Email required" },
217
+ { type: "email", message: "Invalid email" },
218
+ ],
219
+ });
220
+ ```
221
+
222
+ ## Hooks
223
+
224
+ | Hook | Purpose |
225
+ |------|---------|
226
+ | `useStateStore()` | Access state context (`state`, `get`, `set`, `update`) |
227
+ | `useStateValue(path)` | Get single value from state |
228
+ | `useStateBinding(path)` | Two-way data binding (returns `[value, setValue]`) |
229
+ | `useIsVisible(condition)` | Check if a visibility condition is met |
230
+ | `useActions()` | Access action context |
231
+ | `useAction(name)` | Get a single action dispatch function |
232
+ | `useFieldValidation(path, config)` | Field validation state |
233
+ | `useUIStream(options)` | Stream specs from an API endpoint |
234
+
235
+ ## Visibility Conditions
236
+
237
+ ```typescript
238
+ // Truthiness check
239
+ { "$state": "/user/isAdmin" }
240
+
241
+ // Auth state (use state path)
242
+ { "$state": "/auth/isSignedIn" }
243
+
244
+ // Comparisons (flat style)
245
+ { "$state": "/status", "eq": "active" }
246
+ { "$state": "/count", "gt": 10 }
247
+
248
+ // Negation
249
+ { "$state": "/maintenance", "not": true }
250
+
251
+ // Multiple conditions (implicit AND)
252
+ [
253
+ { "$state": "/feature/enabled" },
254
+ { "$state": "/maintenance", "not": true }
255
+ ]
256
+
257
+ // Always / never
258
+ true // always visible
259
+ false // never visible
260
+ ```
261
+
262
+ TypeScript helpers from `@json-render/core`:
263
+
264
+ ```typescript
265
+ import { visibility } from "@json-render/core";
266
+
267
+ visibility.when("/path") // { $state: "/path" }
268
+ visibility.unless("/path") // { $state: "/path", not: true }
269
+ visibility.eq("/path", val) // { $state: "/path", eq: val }
270
+ visibility.neq("/path", val) // { $state: "/path", neq: val }
271
+ visibility.and(cond1, cond2) // { $and: [cond1, cond2] }
272
+ visibility.always // true
273
+ visibility.never // false
274
+ ```
275
+
276
+ ## Dynamic Prop Expressions
277
+
278
+ Any prop value can use data-driven expressions that resolve at render time. The renderer resolves these transparently before passing props to components.
279
+
280
+ ```json
281
+ {
282
+ "type": "Badge",
283
+ "props": {
284
+ "label": { "$state": "/user/role" },
285
+ "color": {
286
+ "$cond": { "$state": "/user/role", "eq": "admin" },
287
+ "$then": "red",
288
+ "$else": "gray"
289
+ }
290
+ }
291
+ }
292
+ ```
293
+
294
+ For two-way binding, use `{ "$bindState": "/path" }` on the natural value prop (e.g. `value`, `checked`, `pressed`). Inside repeat scopes, use `{ "$bindItem": "field" }` instead. Components receive resolved `bindings` with the state path for each bound prop; use `useBoundProp(props.value, bindings?.value)` to get `[value, setValue]`.
295
+
296
+ See [@json-render/core](../core/README.md) for full expression syntax.
297
+
298
+ ## Built-in Actions
299
+
300
+ The `setState`, `pushState`, and `removeState` actions are handled automatically by `ActionProvider`. They update the state model, which triggers re-evaluation of visibility conditions and dynamic prop expressions:
301
+
302
+ ```json
303
+ {
304
+ "type": "Button",
305
+ "props": { "label": "Switch Tab" },
306
+ "on": {
307
+ "press": {
308
+ "action": "setState",
309
+ "params": { "statePath": "/activeTab", "value": "settings" }
310
+ }
311
+ },
312
+ "children": []
313
+ }
314
+ ```
315
+
316
+ ## Component Props
317
+
318
+ When using `defineRegistry`, components receive these props:
319
+
320
+ ```typescript
321
+ interface ComponentContext<P> {
322
+ props: P; // Typed props from the catalog (expressions resolved)
323
+ children?: React.ReactNode; // Rendered children
324
+ emit?: (event: string) => void; // Emit a named event
325
+ loading?: boolean; // Whether the parent is loading
326
+ bindings?: Record<string, string>; // State paths for $bindState/$bindItem expressions (e.g. bindings.value)
327
+ }
328
+ ```
329
+
330
+ Use `bindings?.value`, `bindings?.checked`, etc. with `useBoundProp()` for two-way bound form components.
331
+
332
+ ## Generate AI Prompts
333
+
334
+ ```typescript
335
+ const systemPrompt = catalog.prompt();
336
+ // Returns detailed prompt with component/action descriptions
337
+ ```
338
+
339
+ ## Full Example
340
+
341
+ ```tsx
342
+ import { defineCatalog } from "@json-render/core";
343
+ import { schema, defineRegistry, Renderer } from "@json-render/react";
344
+ import { z } from "zod";
345
+
346
+ const catalog = defineCatalog(schema, {
347
+ components: {
348
+ Greeting: {
349
+ props: z.object({ name: z.string() }),
350
+ description: "Displays a greeting",
351
+ },
352
+ },
353
+ actions: {},
354
+ });
355
+
356
+ const { registry } = defineRegistry(catalog, {
357
+ components: {
358
+ Greeting: ({ props }) => <h1>Hello, {props.name}!</h1>,
359
+ },
360
+ });
361
+
362
+ const spec = {
363
+ root: "greeting-1",
364
+ elements: {
365
+ "greeting-1": {
366
+ type: "Greeting",
367
+ props: { name: "World" },
368
+ children: [],
369
+ },
370
+ },
371
+ };
372
+
373
+ function App() {
374
+ return <Renderer spec={spec} registry={registry} />;
375
+ }
376
+ ```
@@ -0,0 +1,73 @@
1
+ // src/schema.ts
2
+ import { defineSchema } from "@json-render/core";
3
+ var schema = defineSchema(
4
+ (s) => ({
5
+ // What the AI-generated SPEC looks like
6
+ spec: s.object({
7
+ /** Root element key */
8
+ root: s.string(),
9
+ /** Flat map of elements by key */
10
+ elements: s.record(
11
+ s.object({
12
+ /** Component type from catalog */
13
+ type: s.ref("catalog.components"),
14
+ /** Component props */
15
+ props: s.propsOf("catalog.components"),
16
+ /** Child element keys (flat reference) - maps to the 'default' slot */
17
+ children: s.array(s.string()),
18
+ /** Named slots - maps slot names to arrays of child element keys */
19
+ slots: s.record(s.array(s.string())),
20
+ /** Visibility condition */
21
+ visible: s.any()
22
+ })
23
+ )
24
+ }),
25
+ // What the CATALOG must provide
26
+ catalog: s.object({
27
+ /** Component definitions */
28
+ components: s.map({
29
+ /** Zod schema for component props */
30
+ props: s.zod(),
31
+ /** Slots for this component. Use ['default'] for children, or named slots like ['header', 'footer'] */
32
+ slots: s.array(s.string()),
33
+ /** Description for AI generation hints */
34
+ description: s.string(),
35
+ /** Example prop values used in prompt examples (auto-generated from Zod schema if omitted) */
36
+ example: s.any()
37
+ }),
38
+ /** Action definitions (optional) */
39
+ actions: s.map({
40
+ /** Zod schema for action params */
41
+ params: s.zod(),
42
+ /** Description for AI generation hints */
43
+ description: s.string()
44
+ })
45
+ })
46
+ }),
47
+ {
48
+ defaultRules: [
49
+ // Element integrity
50
+ "CRITICAL INTEGRITY CHECK: Before outputting ANY element that references children, you MUST have already output (or will output) each child as its own element. If an element has children: ['a', 'b'], then elements 'a' and 'b' MUST exist. A missing child element causes that entire branch of the UI to be invisible.",
51
+ "SELF-CHECK: After generating all elements, mentally walk the tree from root. Every key in every children array must resolve to a defined element. If you find a gap, output the missing element immediately.",
52
+ // Named slots
53
+ `Components may declare named slots in their catalog definition (e.g., slots: ["header", "footer"]). Example: {"type":"Layout","props":{},"slots":{"header":["h1"],"footer":["f1"]},"children":["main1"]}. Verify slot names exist in the component's catalog definition and all referenced child element keys exist.`,
54
+ // Field placement
55
+ 'CRITICAL: The "visible" field goes on the ELEMENT object, NOT inside "props". Correct: {"type":"<ComponentName>","props":{},"visible":{"$state":"/tab","eq":"home"},"children":[...]}.',
56
+ 'CRITICAL: The "on" field goes on the ELEMENT object, NOT inside "props". Use on.press, on.change, on.submit etc. NEVER put action/actionParams inside props.',
57
+ // State and data
58
+ "When the user asks for a UI that displays data (e.g. blog posts, products, users), ALWAYS include a state field with realistic sample data. The state field is a top-level field on the spec (sibling of root/elements).",
59
+ 'When building repeating content backed by a state array (e.g. posts, products, items), use the "repeat" field on a container element. Example: { "type": "<ContainerComponent>", "props": {}, "repeat": { "statePath": "/posts", "key": "id" }, "children": ["post-card"] }. Replace <ContainerComponent> with an appropriate component from the AVAILABLE COMPONENTS list. Inside repeated children, use { "$item": "field" } to read a field from the current item, and { "$index": true } for the current array index. For two-way binding to an item field use { "$bindItem": "completed" }. Do NOT hardcode individual elements for each array item.',
60
+ // Design quality
61
+ "Design with visual hierarchy: use container components to group content, heading components for section titles, proper spacing, and status indicators. ONLY use components from the AVAILABLE COMPONENTS list.",
62
+ "For data-rich UIs, use multi-column layout components if available. For forms and single-column content, use vertical layout components. ONLY use components from the AVAILABLE COMPONENTS list.",
63
+ "Always include realistic, professional-looking sample data. For blogs include 3-4 posts with varied titles, authors, dates, categories. For products include names, prices, images. Never leave data empty."
64
+ ]
65
+ }
66
+ );
67
+ var elementTreeSchema = schema;
68
+
69
+ export {
70
+ schema,
71
+ elementTreeSchema
72
+ };
73
+ //# sourceMappingURL=chunk-55LSUHMB.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/schema.ts"],"sourcesContent":["import { defineSchema } from \"@json-render/core\";\n\n/**\n * The schema for @json-render/react\n *\n * Defines:\n * - Spec: A flat tree of elements with keys, types, props, and children references\n * - Catalog: Components with props schemas, and optional actions\n */\nexport const schema = defineSchema(\n (s) => ({\n // What the AI-generated SPEC looks like\n spec: s.object({\n /** Root element key */\n root: s.string(),\n /** Flat map of elements by key */\n elements: s.record(\n s.object({\n /** Component type from catalog */\n type: s.ref(\"catalog.components\"),\n /** Component props */\n props: s.propsOf(\"catalog.components\"),\n /** Child element keys (flat reference) - maps to the 'default' slot */\n children: s.array(s.string()),\n /** Named slots - maps slot names to arrays of child element keys */\n slots: s.record(s.array(s.string())),\n /** Visibility condition */\n visible: s.any(),\n }),\n ),\n }),\n\n // What the CATALOG must provide\n catalog: s.object({\n /** Component definitions */\n components: s.map({\n /** Zod schema for component props */\n props: s.zod(),\n /** Slots for this component. Use ['default'] for children, or named slots like ['header', 'footer'] */\n slots: s.array(s.string()),\n /** Description for AI generation hints */\n description: s.string(),\n /** Example prop values used in prompt examples (auto-generated from Zod schema if omitted) */\n example: s.any(),\n }),\n /** Action definitions (optional) */\n actions: s.map({\n /** Zod schema for action params */\n params: s.zod(),\n /** Description for AI generation hints */\n description: s.string(),\n }),\n }),\n }),\n {\n defaultRules: [\n // Element integrity\n \"CRITICAL INTEGRITY CHECK: Before outputting ANY element that references children, you MUST have already output (or will output) each child as its own element. If an element has children: ['a', 'b'], then elements 'a' and 'b' MUST exist. A missing child element causes that entire branch of the UI to be invisible.\",\n \"SELF-CHECK: After generating all elements, mentally walk the tree from root. Every key in every children array must resolve to a defined element. If you find a gap, output the missing element immediately.\",\n\n // Named slots\n 'Components may declare named slots in their catalog definition (e.g., slots: [\"header\", \"footer\"]). Example: {\"type\":\"Layout\",\"props\":{},\"slots\":{\"header\":[\"h1\"],\"footer\":[\"f1\"]},\"children\":[\"main1\"]}. Verify slot names exist in the component\\'s catalog definition and all referenced child element keys exist.',\n\n // Field placement\n 'CRITICAL: The \"visible\" field goes on the ELEMENT object, NOT inside \"props\". Correct: {\"type\":\"<ComponentName>\",\"props\":{},\"visible\":{\"$state\":\"/tab\",\"eq\":\"home\"},\"children\":[...]}.',\n 'CRITICAL: The \"on\" field goes on the ELEMENT object, NOT inside \"props\". Use on.press, on.change, on.submit etc. NEVER put action/actionParams inside props.',\n\n // State and data\n \"When the user asks for a UI that displays data (e.g. blog posts, products, users), ALWAYS include a state field with realistic sample data. The state field is a top-level field on the spec (sibling of root/elements).\",\n 'When building repeating content backed by a state array (e.g. posts, products, items), use the \"repeat\" field on a container element. Example: { \"type\": \"<ContainerComponent>\", \"props\": {}, \"repeat\": { \"statePath\": \"/posts\", \"key\": \"id\" }, \"children\": [\"post-card\"] }. Replace <ContainerComponent> with an appropriate component from the AVAILABLE COMPONENTS list. Inside repeated children, use { \"$item\": \"field\" } to read a field from the current item, and { \"$index\": true } for the current array index. For two-way binding to an item field use { \"$bindItem\": \"completed\" }. Do NOT hardcode individual elements for each array item.',\n\n // Design quality\n \"Design with visual hierarchy: use container components to group content, heading components for section titles, proper spacing, and status indicators. ONLY use components from the AVAILABLE COMPONENTS list.\",\n \"For data-rich UIs, use multi-column layout components if available. For forms and single-column content, use vertical layout components. ONLY use components from the AVAILABLE COMPONENTS list.\",\n \"Always include realistic, professional-looking sample data. For blogs include 3-4 posts with varied titles, authors, dates, categories. For products include names, prices, images. Never leave data empty.\",\n ],\n },\n);\n\n/**\n * Type for the React schema\n */\nexport type ReactSchema = typeof schema;\n\n/**\n * Infer the spec type from a catalog\n */\nexport type ReactSpec<TCatalog> = typeof schema extends {\n createCatalog: (catalog: TCatalog) => { _specType: infer S };\n}\n ? S\n : never;\n\n// Backward compatibility aliases\n/** @deprecated Use `schema` instead */\nexport const elementTreeSchema = schema;\n/** @deprecated Use `ReactSchema` instead */\nexport type ElementTreeSchema = ReactSchema;\n/** @deprecated Use `ReactSpec` instead */\nexport type ElementTreeSpec<T> = ReactSpec<T>;\n"],"mappings":";AAAA,SAAS,oBAAoB;AAStB,IAAM,SAAS;AAAA,EACpB,CAAC,OAAO;AAAA;AAAA,IAEN,MAAM,EAAE,OAAO;AAAA;AAAA,MAEb,MAAM,EAAE,OAAO;AAAA;AAAA,MAEf,UAAU,EAAE;AAAA,QACV,EAAE,OAAO;AAAA;AAAA,UAEP,MAAM,EAAE,IAAI,oBAAoB;AAAA;AAAA,UAEhC,OAAO,EAAE,QAAQ,oBAAoB;AAAA;AAAA,UAErC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC;AAAA;AAAA,UAE5B,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAAA;AAAA,UAEnC,SAAS,EAAE,IAAI;AAAA,QACjB,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA;AAAA,IAGD,SAAS,EAAE,OAAO;AAAA;AAAA,MAEhB,YAAY,EAAE,IAAI;AAAA;AAAA,QAEhB,OAAO,EAAE,IAAI;AAAA;AAAA,QAEb,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC;AAAA;AAAA,QAEzB,aAAa,EAAE,OAAO;AAAA;AAAA,QAEtB,SAAS,EAAE,IAAI;AAAA,MACjB,CAAC;AAAA;AAAA,MAED,SAAS,EAAE,IAAI;AAAA;AAAA,QAEb,QAAQ,EAAE,IAAI;AAAA;AAAA,QAEd,aAAa,EAAE,OAAO;AAAA,MACxB,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA,EACA;AAAA,IACE,cAAc;AAAA;AAAA,MAEZ;AAAA,MACA;AAAA;AAAA,MAGA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA;AAAA,MAGA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AACF;AAkBO,IAAM,oBAAoB;","names":[]}