@json-render/svelte 0.19.0 → 0.20.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 CHANGED
@@ -148,6 +148,8 @@ const chat = createChatUI({ endpoint: "/api/chat" });
148
148
 
149
149
  ## Documentation
150
150
 
151
+ Nested lists can set `repeat.statePath` to `{ "$item": "field" }` to iterate an array on the enclosing repeat item.
152
+
151
153
  Full API reference: [json-render.dev/docs/api/svelte](https://json-render.dev/docs/api/svelte).
152
154
 
153
155
  ## License
@@ -1,9 +1,15 @@
1
1
  <script lang="ts">
2
2
  import type { Spec, UIElement } from "@json-render/core";
3
- import { getByPath } from "@json-render/core";
3
+ import {
4
+ getByPath,
5
+ resolveRepeatItemStatePath,
6
+ resolveRepeatStatePath,
7
+ } from "@json-render/core";
4
8
  import type { ComponentRegistry, ComponentRenderer } from "./renderer.js";
5
9
  import { getStateContext } from "./contexts/StateProvider.svelte";
6
- import RepeatScopeProvider from "./contexts/RepeatScopeProvider.svelte";
10
+ import RepeatScopeProvider, {
11
+ getRepeatScope,
12
+ } from "./contexts/RepeatScopeProvider.svelte";
7
13
  import ElementRenderer from "./ElementRenderer.svelte";
8
14
 
9
15
  interface Props {
@@ -17,17 +23,30 @@
17
23
  let { element, spec, registry, loading = false, fallback }: Props = $props();
18
24
 
19
25
  const stateCtx = getStateContext();
26
+ const parentScope = getRepeatScope();
27
+
28
+ let statePath = $derived.by(() => {
29
+ const resolved = resolveRepeatStatePath(
30
+ element.repeat!.statePath,
31
+ parentScope?.basePath,
32
+ );
33
+ if (resolved === undefined) {
34
+ console.warn(
35
+ "[json-render/svelte] $item in repeat.statePath used outside of a repeat scope",
36
+ );
37
+ }
38
+ return resolved;
39
+ });
20
40
 
21
- // Get items from state
22
41
  let items = $derived(
23
- (getByPath(stateCtx.state, element.repeat!.statePath) as
24
- | unknown[]
25
- | undefined) ?? [],
42
+ statePath === undefined
43
+ ? []
44
+ : ((getByPath(stateCtx.state, statePath) as unknown[] | undefined) ?? []),
26
45
  );
27
46
  </script>
28
47
 
29
48
  {#each items as itemValue, index (element.repeat?.key && typeof itemValue === "object" && itemValue !== null ? String((itemValue as any)[element.repeat.key] ?? index) : String(index))}
30
- {@const basePath = `${element.repeat!.statePath}/${index}`}
49
+ {@const basePath = resolveRepeatItemStatePath(statePath!, index)}
31
50
 
32
51
  {#if element.children}
33
52
  <RepeatScopeProvider item={itemValue} {index} {basePath}>
@@ -1 +1 @@
1
- {"version":3,"file":"RepeatChildren.svelte.d.ts","sourceRoot":"","sources":["../src/RepeatChildren.svelte.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAMxE,UAAU,KAAK;IACb,OAAO,EAAE,SAAS,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;IACX,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,iBAAiB,CAAC;CAC9B;AA0CH,QAAA,MAAM,cAAc,2CAAwC,CAAC;AAC7D,KAAK,cAAc,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AACxD,eAAe,cAAc,CAAC"}
1
+ {"version":3,"file":"RepeatChildren.svelte.d.ts","sourceRoot":"","sources":["../src/RepeatChildren.svelte.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAMzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAQxE,UAAU,KAAK;IACb,OAAO,EAAE,SAAS,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;IACX,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,iBAAiB,CAAC;CAC9B;AAuDH,QAAA,MAAM,cAAc,2CAAwC,CAAC;AAC7D,KAAK,cAAc,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AACxD,eAAe,cAAc,CAAC"}
@@ -304,9 +304,8 @@
304
304
  handler,
305
305
  setState: stateCtx.set,
306
306
  navigate,
307
- executeAction: async (name) => {
308
- const subBinding: CoreActionBinding = { action: name };
309
- await execute(subBinding);
307
+ executeAction: async (binding) => {
308
+ await execute(binding);
310
309
  },
311
310
  });
312
311
  } finally {
@@ -322,9 +321,8 @@
322
321
  handler,
323
322
  setState: stateCtx.set,
324
323
  navigate,
325
- executeAction: async (name) => {
326
- const subBinding: CoreActionBinding = { action: name };
327
- await execute(subBinding);
324
+ executeAction: async (binding) => {
325
+ await execute(binding);
328
326
  },
329
327
  });
330
328
  } finally {
@@ -1 +1 @@
1
- {"version":3,"file":"ActionProvider.svelte.d.ts","sourceRoot":"","sources":["../../src/contexts/ActionProvider.svelte.ts"],"names":[],"mappings":"AAIE,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EACb,aAAa,EACb,cAAc,EACf,MAAM,mBAAmB,CAAC;AAI3B;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,cAAc,CAAC;IACvB,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACxC,qCAAqC;IACrC,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5B,kCAAkC;IAClC,mBAAmB,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAChD,gCAAgC;IAChC,OAAO,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,iCAAiC;IACjC,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,gCAAgC;IAChC,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,iCAAiC;IACjC,eAAe,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,KAAK,IAAI,CAAC;CACjE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,aAAa,CAQhD;AAED;;GAEG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,GACX,YAAY,CAAC,aAAa,GAAG,SAAS,CAAC,CAOzC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,8BAA8B;IAC9B,OAAO,EAAE,aAAa,CAAC;IACvB,4BAA4B;IAC5B,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,IAAI,CAAC;CACtB;AAuDH,OAAO,EAAc,KAAK,OAAO,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EAOH,KAAK,aAAa,IAAI,iBAAiB,EACxC,MAAM,mBAAmB,CAAC;AAM3B,UAAU,KAAK;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC7C,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAuOH,QAAA,MAAM,cAAc,2CAAwC,CAAC;AAC7D,KAAK,cAAc,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AACxD,eAAe,cAAc,CAAC"}
1
+ {"version":3,"file":"ActionProvider.svelte.d.ts","sourceRoot":"","sources":["../../src/contexts/ActionProvider.svelte.ts"],"names":[],"mappings":"AAIE,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EACb,aAAa,EACb,cAAc,EACf,MAAM,mBAAmB,CAAC;AAI3B;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,cAAc,CAAC;IACvB,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACxC,qCAAqC;IACrC,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5B,kCAAkC;IAClC,mBAAmB,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAChD,gCAAgC;IAChC,OAAO,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,iCAAiC;IACjC,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,gCAAgC;IAChC,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,iCAAiC;IACjC,eAAe,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,KAAK,IAAI,CAAC;CACjE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,aAAa,CAQhD;AAED;;GAEG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,GACX,YAAY,CAAC,aAAa,GAAG,SAAS,CAAC,CAOzC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,8BAA8B;IAC9B,OAAO,EAAE,aAAa,CAAC;IACvB,4BAA4B;IAC5B,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,IAAI,CAAC;CACtB;AAuDH,OAAO,EAAc,KAAK,OAAO,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EAOH,KAAK,aAAa,IAAI,iBAAiB,EACxC,MAAM,mBAAmB,CAAC;AAM3B,UAAU,KAAK;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC7C,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAqOH,QAAA,MAAM,cAAc,2CAAwC,CAAC;AAC7D,KAAK,cAAc,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AACxD,eAAe,cAAc,CAAC"}
@@ -101,6 +101,38 @@ describe("createActionContext", () => {
101
101
  expect(customHandler).toHaveBeenCalledWith({ foo: "bar" });
102
102
  }, { handlers: { myAction: customHandler } });
103
103
  })());
104
+ it("forwards params to a named onSuccess action (#301)", (() => {
105
+ const toast = vi.fn().mockResolvedValue(undefined);
106
+ return component(async () => {
107
+ const actionCtx = getActionContext();
108
+ await actionCtx.execute({
109
+ action: "save",
110
+ onSuccess: { action: "toast", params: { message: "Saved" } },
111
+ });
112
+ expect(toast).toHaveBeenCalledWith({ message: "Saved" });
113
+ }, {
114
+ handlers: {
115
+ save: vi.fn().mockResolvedValue(undefined),
116
+ toast,
117
+ },
118
+ });
119
+ })());
120
+ it("forwards params to a named onError action (#301)", (() => {
121
+ const toast = vi.fn().mockResolvedValue(undefined);
122
+ return component(async () => {
123
+ const actionCtx = getActionContext();
124
+ await actionCtx.execute({
125
+ action: "save",
126
+ onError: { action: "toast", params: { message: "Failed" } },
127
+ });
128
+ expect(toast).toHaveBeenCalledWith({ message: "Failed" });
129
+ }, {
130
+ handlers: {
131
+ save: vi.fn().mockRejectedValue(new Error("boom")),
132
+ toast,
133
+ },
134
+ });
135
+ })());
104
136
  it("warns when no handler registered", component(async () => {
105
137
  const actionCtx = getActionContext();
106
138
  const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => { });
@@ -165,4 +165,36 @@ describe("Renderer", () => {
165
165
  expect(texts).toHaveLength(1);
166
166
  expect(texts[0]?.textContent).toBe("I exist");
167
167
  });
168
+ it("renders nested repeats from the enclosing item", () => {
169
+ const spec = {
170
+ root: "groups",
171
+ state: {
172
+ groups: [
173
+ { subitems: [{ label: "a1" }, { label: "a2" }] },
174
+ { subitems: [{ label: "b1" }] },
175
+ ],
176
+ },
177
+ elements: {
178
+ groups: {
179
+ type: "Container",
180
+ props: {},
181
+ repeat: { statePath: "/groups" },
182
+ children: ["subitems"],
183
+ },
184
+ subitems: {
185
+ type: "Container",
186
+ props: {},
187
+ repeat: { statePath: { $item: "/subitems" } },
188
+ children: ["label"],
189
+ },
190
+ label: {
191
+ type: "Text",
192
+ props: { text: { $item: "label" } },
193
+ children: [],
194
+ },
195
+ },
196
+ };
197
+ const { container } = mountRenderer(spec);
198
+ expect(Array.from(container.querySelectorAll(".test-text")).map((element) => element.textContent)).toEqual(["a1", "a2", "b1"]);
199
+ });
168
200
  });
package/dist/schema.d.ts CHANGED
@@ -18,7 +18,17 @@ export declare const schema: import("@json-render/core").Schema<{
18
18
  /** Child element keys (flat reference) */
19
19
  children: import("@json-render/core").SchemaType<"array", import("@json-render/core").SchemaType<"string", unknown>>;
20
20
  /** Visibility condition */
21
- visible: import("@json-render/core").SchemaType<"any", unknown>;
21
+ visible: {
22
+ optional: true;
23
+ kind: "any";
24
+ inner?: unknown;
25
+ };
26
+ /** Repeat children from a state array */
27
+ repeat: {
28
+ optional: true;
29
+ kind: "any";
30
+ inner?: unknown;
31
+ };
22
32
  }>>;
23
33
  }>;
24
34
  catalog: import("@json-render/core").SchemaType<"object", {
@@ -1 +1 @@
1
- {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,eAAO,MAAM,MAAM;;QAIb,uBAAuB;;QAEvB,kCAAkC;;YAG9B,kCAAkC;;YAElC,sBAAsB;;YAEtB,0CAA0C;;YAE1C,2BAA2B;;;;;QAQ/B,4BAA4B;;YAE1B,qCAAqC;;YAErC,uGAAuG;;YAEvG,0CAA0C;;YAE1C,8FAA8F;;;QAGhG,oCAAoC;;YAElC,mCAAmC;;YAEnC,0CAA0C;;;;EA+CjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,MAAM,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,QAAQ,IAAI,OAAO,MAAM,SAAS;IACvD,aAAa,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK;QAAE,SAAS,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;CAC9D,GACG,CAAC,GACD,KAAK,CAAC"}
1
+ {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,eAAO,MAAM,MAAM;;QAIb,uBAAuB;;QAEvB,kCAAkC;;YAG9B,kCAAkC;;YAElC,sBAAsB;;YAEtB,0CAA0C;;YAE1C,2BAA2B;;;;;;YAE3B,yCAAyC;;;;;;;;;QAQ7C,4BAA4B;;YAE1B,qCAAqC;;YAErC,uGAAuG;;YAEvG,0CAA0C;;YAE1C,8FAA8F;;;QAGhG,oCAAoC;;YAElC,mCAAmC;;YAEnC,0CAA0C;;;;EAgDjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,MAAM,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,QAAQ,IAAI,OAAO,MAAM,SAAS;IACvD,aAAa,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK;QAAE,SAAS,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;CAC9D,GACG,CAAC,GACD,KAAK,CAAC"}
package/dist/schema.js CHANGED
@@ -20,7 +20,9 @@ export const schema = defineSchema((s) => ({
20
20
  /** Child element keys (flat reference) */
21
21
  children: s.array(s.string()),
22
22
  /** Visibility condition */
23
- visible: s.any(),
23
+ visible: { ...s.any(), ...s.optional() },
24
+ /** Repeat children from a state array */
25
+ repeat: { ...s.any(), ...s.optional() },
24
26
  })),
25
27
  }),
26
28
  // What the CATALOG must provide
@@ -67,12 +69,13 @@ export const schema = defineSchema((s) => ({
67
69
  // Element integrity
68
70
  "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.",
69
71
  "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.",
72
+ 'REQUIRED FIELDS: Every element MUST include a "children" array. Leaf elements (text, badges, inputs, images) use an empty array: "children": []. Omitting "children" fails validation.',
70
73
  // Field placement
71
74
  'CRITICAL: The "visible" field goes on the ELEMENT object, NOT inside "props". Correct: {"type":"<ComponentName>","props":{},"visible":{"$state":"/tab","eq":"home"},"children":[...]}.',
72
75
  '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.',
73
76
  // State and data
74
77
  "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).",
75
- '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.',
78
+ '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"] }. For a nested list stored on the enclosing item, use "repeat": { "statePath": { "$item": "comments" }, "key": "id" }. The $item statePath form is valid only inside another repeat. 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.',
76
79
  // Design quality
77
80
  "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.",
78
81
  "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.",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@json-render/svelte",
3
- "version": "0.19.0",
3
+ "version": "0.20.0",
4
4
  "license": "Apache-2.0",
5
5
  "description": "Svelte 5 renderer for @json-render/core. JSON becomes Svelte components.",
6
6
  "keywords": [
@@ -49,7 +49,7 @@
49
49
  "dist"
50
50
  ],
51
51
  "dependencies": {
52
- "@json-render/core": "0.19.0"
52
+ "@json-render/core": "0.20.0"
53
53
  },
54
54
  "devDependencies": {
55
55
  "@sveltejs/package": "^2.3.0",