ngx-json-render 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,216 @@
+# ngx-json-render
+
+Angular renderer for [json-render](https://github.com/vercel-labs/json-render) — give an LLM a catalog of your components, stream back a JSON spec, and render it as real Angular components. No `innerHTML`, no `eval`, no framework lock-in on the wire format.
+
+Built on `@json-render/core` (the same spec format, expressions, state store, actions, and streaming compiler used by the React, Vue, Solid, and Svelte renderers) and idiomatic modern Angular: standalone components, signals, zoneless-friendly, `OnPush` everywhere.
+
+## Install
+
+```bash
+npm install ngx-json-render @json-render/core zod
+```
+
+Requires Angular ≥ 21.
+
+## Quick start
+
+**1. Define a catalog** — the vocabulary the model (or your server) is allowed to use:
+
+```ts
+// catalog.ts
+import { schema } from 'ngx-json-render';
+import { z } from 'zod';
+
+export const catalog = schema.createCatalog({
+  components: {
+    Card: {
+      props: z.object({ title: z.string().optional() }),
+      slots: ['default'],
+      description: 'A card container',
+    },
+    Button: {
+      props: z.object({ label: z.string() }),
+      slots: [],
+      description: "A button that emits a 'press' event",
+    },
+  },
+  actions: {
+    refresh: { params: z.object({}), description: 'Reload the data' },
+  },
+});
+```
+
+**2. Implement catalog components** — plain Angular components that read the render context:
+
+```ts
+import { Component } from '@angular/core';
+import { JrChildren, injectRenderContext } from 'ngx-json-render';
+
+@Component({
+  selector: 'app-card',
+  imports: [JrChildren],
+  template: `
+    <section class="card">
+      @if (ctx.props().title) { <h3>{{ ctx.props().title }}</h3> }
+      <jr-children />
+    </section>
+  `,
+})
+export class CardComponent {
+  readonly ctx = injectRenderContext<{ title?: string }>();
+}
+
+@Component({
+  selector: 'app-button',
+  template: `<button (click)="ctx.emit('press')">{{ ctx.props().label }}</button>`,
+})
+export class ButtonComponent {
+  readonly ctx = injectRenderContext<{ label: string }>();
+}
+```
+
+`<jr-children />` renders the element's children where you place it — like a `router-outlet` for the spec tree. Use `<jr-children slot="header" />` for named slots.
+
+**3. Build the registry and render:**
+
+```ts
+import { Component, signal } from '@angular/core';
+import { JsonRenderer, type Spec, defineRegistry } from 'ngx-json-render';
+import { catalog } from './catalog';
+
+const { registry } = defineRegistry(catalog, {
+  components: { Card: CardComponent, Button: ButtonComponent },
+  actions: { refresh: async () => {} },
+});
+
+@Component({
+  selector: 'app-page',
+  imports: [JsonRenderer],
+  template: `
+    <json-render
+      [spec]="spec()"
+      [registry]="registry"
+      [handlers]="handlers"
+      (stateChange)="onStateChange($event)"
+    />
+  `,
+})
+export class Page {
+  readonly registry = registry;
+  readonly spec = signal<Spec>({
+    root: 'root',
+    state: { count: 0 },
+    elements: {
+      root: { type: 'Card', props: { title: 'Hello' }, children: ['btn'] },
+      btn: {
+        type: 'Button',
+        props: { label: 'Tap me' },
+        on: {
+          press: { action: 'setState', params: { statePath: '/count', value: 1 } },
+        },
+      },
+    },
+  });
+  handlers = { refresh: async () => { /* ... */ } };
+  onStateChange(changes: unknown) { console.log(changes); }
+}
+```
+
+## Streaming a UI from an LLM
+
+Specs stream as JSONL patch lines (RFC 6902). Render partial specs as they arrive — the renderer tolerates missing elements while `loading` is true:
+
+```ts
+import { injectUIStream } from 'ngx-json-render';
+
+@Component({
+  template: `
+    <json-render [spec]="ui.spec()" [registry]="registry" [loading]="ui.isStreaming()" />
+    <button (click)="ui.send('A dashboard for weekly sales')">Generate</button>
+  `,
+  imports: [JsonRenderer],
+})
+export class GeneratePage {
+  readonly ui = injectUIStream({ api: '/api/generate' });
+  readonly registry = registry;
+}
+```
+
+Also available:
+
+- `injectChatUI({ api })` — chat + GenUI: assistant messages carrying both prose and specs (` ```spec ` fenced JSONL).
+- `applyPatch(spec, patch)` — immutably apply one RFC 6902 patch to a spec.
+- `buildSpecFromParts` / `getTextFromParts` / `jsonRenderMessage` — derive specs from AI SDK `message.parts`.
+- `catalog.prompt()` / `buildUserPrompt` (from `@json-render/core`) — generate the system/user prompts for your catalog.
+
+## Spec features supported
+
+Full parity with the baseline json-render contract:
+
+| Feature | Example |
+| --- | --- |
+| Dynamic props | `{ "$state": "/user/name" }` |
+| Two-way binding | `{ "$bindState": "/form/email" }`, `{ "$bindItem": "done" }` |
+| Conditionals | `{ "$cond": {...}, "$then": ..., "$else": ... }` |
+| Templates | `{ "$template": "Hello, ${/user/name}" }` |
+| Computed / directives | `{ "$computed": "fmtDate", "args": {...} }`, custom `$`-directives |
+| Visibility | `"visible": { "$state": "/count", "gte": 5 }` (incl. `$and`/`$or`, `$item`, `$index`) |
+| Events → actions | `"on": { "press": { "action": "...", "params": {...}, "confirm": {...}, "onSuccess": ..., "onError": ... } }` |
+| Built-in actions | `setState`, `pushState` (with `$id`), `removeState`, `push`/`pop`, `validateForm` |
+| Repeat | `"repeat": { "statePath": "/todos", "key": "id" }`, nested via `{ "$item": "..." }` |
+| Watch | `"watch": { "/country": { "action": "loadCities" } }` |
+| Slots | `"slots": { "header": ["title-el"] }` + `<jr-children slot="header" />` |
+| Validation | field checks via `ValidationConfig`, `validateForm`, `injectFieldValidation` |
+| Confirm dialogs | built-in `<jr-confirm-dialog>` (auto-rendered) |
+| Devtools hooks | action observer + `data-jr-key` picker attributes |
+
+## State
+
+Each `<json-render>` owns a state store (JSON Pointer addressed). Seeding order: `store` input (controlled) → `state` input → `spec.state`.
+
+Inside catalog components:
+
+```ts
+const store = injectStateStore();     // get/set/update/state()
+const name = injectStateValue<string>('/user/name');
+const bound = injectBoundProp<string>(() => ctx.props().value, () => ctx.bindings()?.['value']);
+```
+
+Share one store across renderers (or drive it from your own state management) by passing a core `StateStore` — `createStateStore()`, or `createStoreAdapter()` over Redux/NgRx/etc. — via the `store` input. `createStoreSetState(store)` adapts a whole-state updater to fine-grained path writes.
+
+### A note on inputs
+
+If a catalog component renders `<input [value]="ctx.props().value">`, remember that one-way bindings do not re-assert the DOM when the bound value returns to its previously applied value while the user typed in between (e.g. `pushState` + `clearStatePath`). Sync imperatively instead — see `InputComponent` in the demo app for the pattern.
+
+## API surface
+
+Components: `JsonRenderer` (`<json-render>`), `JrChildren`, `JrConfirmDialog`, `JrElement`, `JrRepeatScope`.
+
+Injectables/helpers: `injectRenderContext`, `injectRepeatScope`, `injectStateStore`, `injectStateValue`, `injectStateBinding`, `injectBoundProp`, `injectActions`, `injectAction`, `injectValidation`, `injectFieldValidation`, `injectUIStream`, `injectChatUI`, `injectDevtoolsActive`, `jsonRenderMessage`.
+
+Registry & schema: `defineRegistry`, `createStoreSetState`, `schema`.
+
+Everything from `@json-render/core` (types, `createStateStore`, `nestedToFlat`, prompt builders, spec validators, SpecStream compiler) composes with this package; the most common symbols are re-exported.
+
+## Renderer inputs
+
+| Input | Type | Purpose |
+| --- | --- | --- |
+| `spec` | `Spec \| null` | The UI spec (may be partial while streaming) |
+| `registry` | `ComponentRegistry` | Catalog type → Angular component |
+| `loading` | `boolean` | Suppress missing-element warnings while streaming |
+| `fallback` | `Type<unknown>` | Component for unknown types |
+| `state` | `StateModel` | Initial state (uncontrolled; defaults to `spec.state`) |
+| `store` | `StateStore` | External store (controlled mode) |
+| `handlers` | `Record<string, ActionHandler>` | Action handlers |
+| `onAction` | `(name, params) => unknown` | Catch-all action handler |
+| `navigate` | `(path) => void` | Used by `onSuccess: { navigate }` |
+| `validationFunctions` | `Record<string, ValidationFunction>` | Custom validation |
+| `functions` | `Record<string, ComputedFunction>` | `$computed` functions |
+| `directives` | `DirectiveDefinition[]` | Custom `$`-prefixed expressions |
+
+Output: `(stateChange)` — batched `{ path, value }[]` in uncontrolled mode.
+
+## License
+
+Apache-2.0