@json-render/solid 0.12.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/LICENSE +201 -0
- package/README.md +243 -0
- package/dist/chunk-XTSB6FIM.mjs +87 -0
- package/dist/chunk-XTSB6FIM.mjs.map +1 -0
- package/dist/index.d.mts +602 -0
- package/dist/index.d.ts +602 -0
- package/dist/index.js +1853 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +1727 -0
- package/dist/index.mjs.map +1 -0
- package/dist/schema.d.mts +102 -0
- package/dist/schema.d.ts +102 -0
- package/dist/schema.js +112 -0
- package/dist/schema.js.map +1 -0
- package/dist/schema.mjs +9 -0
- package/dist/schema.mjs.map +1 -0
- package/package.json +69 -0
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,243 @@
|
|
|
1
|
+
# @json-render/solid
|
|
2
|
+
|
|
3
|
+
SolidJS renderer for json-render. Turn JSON specs into Solid components with data binding, visibility, actions, validation, and streaming.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @json-render/core @json-render/solid zod
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Peer dependencies: `solid-js ^1.9.0` and `zod ^4.0.0`.
|
|
12
|
+
|
|
13
|
+
## Quick Start
|
|
14
|
+
|
|
15
|
+
### 1. Create a Catalog
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { defineCatalog } from "@json-render/core";
|
|
19
|
+
import { schema } from "@json-render/solid/schema";
|
|
20
|
+
import { z } from "zod";
|
|
21
|
+
|
|
22
|
+
export const catalog = defineCatalog(schema, {
|
|
23
|
+
components: {
|
|
24
|
+
Card: {
|
|
25
|
+
props: z.object({
|
|
26
|
+
title: z.string(),
|
|
27
|
+
description: z.string().nullable(),
|
|
28
|
+
}),
|
|
29
|
+
description: "A card container",
|
|
30
|
+
},
|
|
31
|
+
Button: {
|
|
32
|
+
props: z.object({
|
|
33
|
+
label: z.string(),
|
|
34
|
+
action: z.string(),
|
|
35
|
+
}),
|
|
36
|
+
description: "A clickable button",
|
|
37
|
+
},
|
|
38
|
+
Input: {
|
|
39
|
+
props: z.object({
|
|
40
|
+
value: z.union([z.string(), z.record(z.unknown())]).nullable(),
|
|
41
|
+
label: z.string(),
|
|
42
|
+
placeholder: z.string().nullable(),
|
|
43
|
+
}),
|
|
44
|
+
description: "Text input with optional state binding",
|
|
45
|
+
},
|
|
46
|
+
},
|
|
47
|
+
actions: {
|
|
48
|
+
submit: { description: "Submit the form" },
|
|
49
|
+
cancel: { description: "Cancel and close" },
|
|
50
|
+
},
|
|
51
|
+
});
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### 2. Define Component Implementations
|
|
55
|
+
|
|
56
|
+
`defineRegistry` conditionally requires the `actions` field only when the catalog declares actions.
|
|
57
|
+
|
|
58
|
+
```tsx
|
|
59
|
+
import { defineRegistry, useBoundProp } from "@json-render/solid";
|
|
60
|
+
import { catalog } from "./catalog";
|
|
61
|
+
|
|
62
|
+
export const { registry } = defineRegistry(catalog, {
|
|
63
|
+
components: {
|
|
64
|
+
Card: (renderProps) => (
|
|
65
|
+
<div class="card">
|
|
66
|
+
<h3>{renderProps.element.props.title as string}</h3>
|
|
67
|
+
{renderProps.children}
|
|
68
|
+
</div>
|
|
69
|
+
),
|
|
70
|
+
Button: (renderProps) => (
|
|
71
|
+
<button onClick={() => renderProps.emit("press")}>
|
|
72
|
+
{renderProps.element.props.label as string}
|
|
73
|
+
</button>
|
|
74
|
+
),
|
|
75
|
+
Input: (renderProps) => {
|
|
76
|
+
const [value, setValue] = useBoundProp(
|
|
77
|
+
renderProps.element.props.value,
|
|
78
|
+
renderProps.bindings?.value,
|
|
79
|
+
);
|
|
80
|
+
return (
|
|
81
|
+
<label>
|
|
82
|
+
{renderProps.element.props.label as string}
|
|
83
|
+
<input
|
|
84
|
+
value={String(value() ?? "")}
|
|
85
|
+
placeholder={String(renderProps.element.props.placeholder ?? "")}
|
|
86
|
+
onInput={(e) => setValue(e.currentTarget.value)}
|
|
87
|
+
/>
|
|
88
|
+
</label>
|
|
89
|
+
);
|
|
90
|
+
},
|
|
91
|
+
},
|
|
92
|
+
actions: {
|
|
93
|
+
submit: async () => {},
|
|
94
|
+
cancel: async () => {},
|
|
95
|
+
},
|
|
96
|
+
});
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### 3. Render Specs
|
|
100
|
+
|
|
101
|
+
```tsx
|
|
102
|
+
import { Renderer, StateProvider, ActionProvider } from "@json-render/solid";
|
|
103
|
+
import { registry } from "./registry";
|
|
104
|
+
|
|
105
|
+
export function App(props: { spec: any }) {
|
|
106
|
+
return (
|
|
107
|
+
<StateProvider initialState={{ form: { name: "" } }}>
|
|
108
|
+
<ActionProvider handlers={{ submit: () => console.log("submit") }}>
|
|
109
|
+
<Renderer spec={props.spec} registry={registry} />
|
|
110
|
+
</ActionProvider>
|
|
111
|
+
</StateProvider>
|
|
112
|
+
);
|
|
113
|
+
}
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Spec Format
|
|
117
|
+
|
|
118
|
+
`@json-render/solid` uses the same flat element map format as React/Vue:
|
|
119
|
+
|
|
120
|
+
```typescript
|
|
121
|
+
interface Spec {
|
|
122
|
+
root: string;
|
|
123
|
+
elements: Record<string, UIElement>;
|
|
124
|
+
state?: Record<string, unknown>;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
interface UIElement {
|
|
128
|
+
type: string;
|
|
129
|
+
props: Record<string, unknown>;
|
|
130
|
+
children?: string[];
|
|
131
|
+
visible?: VisibilityCondition;
|
|
132
|
+
watch?: Record<string, ActionBinding | ActionBinding[]>;
|
|
133
|
+
}
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Providers
|
|
137
|
+
|
|
138
|
+
| Provider | Purpose |
|
|
139
|
+
| --------------------- | ---------------------------------------------------- |
|
|
140
|
+
| `StateProvider` | State model and JSON Pointer read/write APIs |
|
|
141
|
+
| `ActionProvider` | Action dispatch, loading tracking, confirmation flow |
|
|
142
|
+
| `VisibilityProvider` | Visibility condition evaluation from current state |
|
|
143
|
+
| `ValidationProvider` | Field-level and full-form validation |
|
|
144
|
+
| `RepeatScopeProvider` | Repeat context (`$item`, `$index`, `$bindItem`) |
|
|
145
|
+
| `JSONUIProvider` | Combined provider wiring for renderer trees |
|
|
146
|
+
|
|
147
|
+
### External Store (Controlled Mode)
|
|
148
|
+
|
|
149
|
+
Pass a `StateStore` to `StateProvider`, `JSONUIProvider`, or the component returned by `createRenderer`.
|
|
150
|
+
When `store` is provided, `initialState` and `onStateChange` are ignored.
|
|
151
|
+
|
|
152
|
+
```tsx
|
|
153
|
+
import { createStateStore, StateProvider } from "@json-render/solid";
|
|
154
|
+
|
|
155
|
+
const store = createStateStore({ count: 0 });
|
|
156
|
+
|
|
157
|
+
<StateProvider store={store}>{/* ... */}</StateProvider>;
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## Hooks
|
|
161
|
+
|
|
162
|
+
| Hook | Purpose |
|
|
163
|
+
| --------------------------------------------- | ----------------------------------------------------- |
|
|
164
|
+
| `useStateStore()` | Access `state`, `get`, `set`, `update`, `getSnapshot` |
|
|
165
|
+
| `useStateValue(path)` | Read a value by JSON Pointer path via accessor |
|
|
166
|
+
| `useStateBinding(path)` | Legacy two-way binding helper returning an accessor |
|
|
167
|
+
| `useVisibility()` / `useIsVisible()` | Visibility context and checks |
|
|
168
|
+
| `useActions()` / `useAction()` | Action context and single-action helper |
|
|
169
|
+
| `useValidation()` / `useOptionalValidation()` | Validation context (throwing/non-throwing) |
|
|
170
|
+
| `useFieldValidation(path, config)` | Field state accessors plus validate/touch/clear |
|
|
171
|
+
| `useBoundProp(value, binding)` | Fine-grained two-way binding helper |
|
|
172
|
+
| `useUIStream(options)` | Stream UI specs from an endpoint |
|
|
173
|
+
| `useChatUI(options)` | Chat-style spec generation hook |
|
|
174
|
+
|
|
175
|
+
## Built-in Actions
|
|
176
|
+
|
|
177
|
+
These actions are available in the Solid schema and handled by `ActionProvider`:
|
|
178
|
+
|
|
179
|
+
- `setState`
|
|
180
|
+
- `pushState`
|
|
181
|
+
- `removeState`
|
|
182
|
+
- `validateForm`
|
|
183
|
+
|
|
184
|
+
`setState`/`pushState`/`removeState` mutate the state model. `validateForm` validates registered fields and writes `{ valid, errors }` to state (`/formValidation` by default).
|
|
185
|
+
|
|
186
|
+
## Events and Action Binding
|
|
187
|
+
|
|
188
|
+
Components can use either `emit("event")` or `on("event")`.
|
|
189
|
+
|
|
190
|
+
- `emit` fires named event bindings directly.
|
|
191
|
+
- `on` returns an `EventHandle` with `emit`, `bound`, and `shouldPreventDefault`.
|
|
192
|
+
|
|
193
|
+
This mirrors the React package API while preserving Solid's fine-grained reactivity.
|
|
194
|
+
|
|
195
|
+
## Streaming
|
|
196
|
+
|
|
197
|
+
`useUIStream` and `useChatUI` support JSON patch streaming and mixed text/spec data parts.
|
|
198
|
+
|
|
199
|
+
```tsx
|
|
200
|
+
import { useUIStream } from "@json-render/solid";
|
|
201
|
+
|
|
202
|
+
const stream = useUIStream({ api: "/api/generate" });
|
|
203
|
+
await stream.send("Build me a dashboard");
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
## Key Exports
|
|
207
|
+
|
|
208
|
+
| Export | Purpose |
|
|
209
|
+
| ------------------ | -------------------------------------------------------------------------- |
|
|
210
|
+
| `defineRegistry` | Create catalog-aware component and action registry helpers |
|
|
211
|
+
| `Renderer` | Render a `Spec` with a component registry |
|
|
212
|
+
| `createRenderer` | Build an app-level renderer with provider wiring |
|
|
213
|
+
| `JSONUIProvider` | Combined provider tree (`state` + `visibility` + `validation` + `actions`) |
|
|
214
|
+
| `schema` | Solid element schema with built-in actions |
|
|
215
|
+
| `createStateStore` | Framework-agnostic in-memory `StateStore` |
|
|
216
|
+
|
|
217
|
+
### Types
|
|
218
|
+
|
|
219
|
+
| Export | Purpose |
|
|
220
|
+
| --------------------------- | -------------------------------------------------------- |
|
|
221
|
+
| `ComponentContext` | Catalog-aware component context type |
|
|
222
|
+
| `BaseComponentProps` | Catalog-agnostic component props type |
|
|
223
|
+
| `EventHandle` | Event metadata (`emit`, `bound`, `shouldPreventDefault`) |
|
|
224
|
+
| `StateStore` | Controlled state backend interface |
|
|
225
|
+
| `StateModel` | Renderer state model type |
|
|
226
|
+
| `SolidSchema` / `SolidSpec` | Solid schema/spec types |
|
|
227
|
+
|
|
228
|
+
## Differences from `@json-render/react`
|
|
229
|
+
|
|
230
|
+
Most APIs are intentionally aligned, but there are runtime behavior differences due to Solid:
|
|
231
|
+
|
|
232
|
+
- Solid components run once, then update via signals.
|
|
233
|
+
- Keep changing reads inside JSX expressions, `createMemo`, or `createEffect`.
|
|
234
|
+
- Avoid props destructuring in component signatures when values should remain reactive.
|
|
235
|
+
- Hooks that read changing state return accessors; call them inside JSX or effects.
|
|
236
|
+
|
|
237
|
+
## Documentation
|
|
238
|
+
|
|
239
|
+
Full docs: [json-render.dev/docs/api/solid](https://json-render.dev/docs/api/solid)
|
|
240
|
+
|
|
241
|
+
## License
|
|
242
|
+
|
|
243
|
+
Apache-2.0
|
|
@@ -0,0 +1,87 @@
|
|
|
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) */
|
|
17
|
+
children: s.array(s.string()),
|
|
18
|
+
/** Visibility condition */
|
|
19
|
+
visible: s.any()
|
|
20
|
+
})
|
|
21
|
+
)
|
|
22
|
+
}),
|
|
23
|
+
// What the CATALOG must provide
|
|
24
|
+
catalog: s.object({
|
|
25
|
+
/** Component definitions */
|
|
26
|
+
components: s.map({
|
|
27
|
+
/** Zod schema for component props */
|
|
28
|
+
props: s.zod(),
|
|
29
|
+
/** Slots for this component. Use ['default'] for children, or named slots like ['header', 'footer'] */
|
|
30
|
+
slots: s.array(s.string()),
|
|
31
|
+
/** Description for AI generation hints */
|
|
32
|
+
description: s.string(),
|
|
33
|
+
/** Example prop values used in prompt examples (auto-generated from Zod schema if omitted) */
|
|
34
|
+
example: s.any()
|
|
35
|
+
}),
|
|
36
|
+
/** Action definitions (optional) */
|
|
37
|
+
actions: s.map({
|
|
38
|
+
/** Zod schema for action params */
|
|
39
|
+
params: s.zod(),
|
|
40
|
+
/** Description for AI generation hints */
|
|
41
|
+
description: s.string()
|
|
42
|
+
})
|
|
43
|
+
})
|
|
44
|
+
}),
|
|
45
|
+
{
|
|
46
|
+
builtInActions: [
|
|
47
|
+
{
|
|
48
|
+
name: "setState",
|
|
49
|
+
description: "Update a value in the state model at the given statePath. Params: { statePath: string, value: any }"
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
name: "pushState",
|
|
53
|
+
description: 'Append an item to an array in state. Params: { statePath: string, value: any, clearStatePath?: string }. Value can contain {"$state":"/path"} refs and "$id" for auto IDs.'
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
name: "removeState",
|
|
57
|
+
description: "Remove an item from an array in state by index. Params: { statePath: string, index: number }"
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
name: "validateForm",
|
|
61
|
+
description: "Validate all registered form fields and write the result to state. Params: { statePath?: string }. Defaults to /formValidation. Result: { valid: boolean, errors: Record<string, string[]> }."
|
|
62
|
+
}
|
|
63
|
+
],
|
|
64
|
+
defaultRules: [
|
|
65
|
+
// Element integrity
|
|
66
|
+
"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.",
|
|
67
|
+
"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.",
|
|
68
|
+
// Field placement
|
|
69
|
+
'CRITICAL: The "visible" field goes on the ELEMENT object, NOT inside "props". Correct: {"type":"<ComponentName>","props":{},"visible":{"$state":"/tab","eq":"home"},"children":[...]}.',
|
|
70
|
+
'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.',
|
|
71
|
+
// State and data
|
|
72
|
+
"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).",
|
|
73
|
+
'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.',
|
|
74
|
+
// Design quality
|
|
75
|
+
"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.",
|
|
76
|
+
"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.",
|
|
77
|
+
"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."
|
|
78
|
+
]
|
|
79
|
+
}
|
|
80
|
+
);
|
|
81
|
+
var elementTreeSchema = schema;
|
|
82
|
+
|
|
83
|
+
export {
|
|
84
|
+
schema,
|
|
85
|
+
elementTreeSchema
|
|
86
|
+
};
|
|
87
|
+
//# sourceMappingURL=chunk-XTSB6FIM.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/solid\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) */\n children: 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 builtInActions: [\n {\n name: \"setState\",\n description:\n \"Update a value in the state model at the given statePath. Params: { statePath: string, value: any }\",\n },\n {\n name: \"pushState\",\n description:\n 'Append an item to an array in state. Params: { statePath: string, value: any, clearStatePath?: string }. Value can contain {\"$state\":\"/path\"} refs and \"$id\" for auto IDs.',\n },\n {\n name: \"removeState\",\n description:\n \"Remove an item from an array in state by index. Params: { statePath: string, index: number }\",\n },\n {\n name: \"validateForm\",\n description:\n \"Validate all registered form fields and write the result to state. Params: { statePath?: string }. Defaults to /formValidation. Result: { valid: boolean, errors: Record<string, string[]> }.\",\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 // 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 Solid schema\n */\nexport type SolidSchema = typeof schema;\n\n/**\n * Infer the spec type from a catalog\n */\nexport type SolidSpec<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 `SolidSchema` instead */\nexport type ElementTreeSchema = SolidSchema;\n/** @deprecated Use `SolidSpec` instead */\nexport type ElementTreeSpec<T> = SolidSpec<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,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,gBAAgB;AAAA,MACd;AAAA,QACE,MAAM;AAAA,QACN,aACE;AAAA,MACJ;AAAA,MACA;AAAA,QACE,MAAM;AAAA,QACN,aACE;AAAA,MACJ;AAAA,MACA;AAAA,QACE,MAAM;AAAA,QACN,aACE;AAAA,MACJ;AAAA,MACA;AAAA,QACE,MAAM;AAAA,QACN,aACE;AAAA,MACJ;AAAA,IACF;AAAA,IACA,cAAc;AAAA;AAAA,MAEZ;AAAA,MACA;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":[]}
|