@json-render/yaml 0.13.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 2025 Vercel Inc.
+
+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,113 @@
+# @json-render/yaml
+
+YAML wire format for `@json-render/core`. Progressive rendering and surgical edits via streaming YAML.
+
+## Installation
+
+```bash
+npm install @json-render/yaml @json-render/core yaml
+```
+
+## Key Concepts
+
+- **YAML wire format**: Uses `yaml-spec`, `yaml-edit`, `yaml-patch`, and `diff` code fences instead of JSONL
+- **Streaming parser**: Incrementally parses YAML as it arrives, emitting JSON Patch operations
+- **Edit modes**: Supports patch (RFC 6902), merge (RFC 7396), and unified diff for surgical edits
+- **AI SDK transform**: Drop-in `TransformStream` that converts YAML fences into json-render patch data parts
+
+## Quick Start
+
+### Generate a YAML System Prompt
+
+```typescript
+import { yamlPrompt } from "@json-render/yaml";
+import { catalog } from "./catalog";
+
+const systemPrompt = yamlPrompt(catalog, {
+  mode: "standalone",
+  editModes: ["merge"],
+});
+```
+
+### Stream YAML Specs (AI SDK)
+
+```typescript
+import { pipeYamlRender } from "@json-render/yaml";
+import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
+
+const stream = createUIMessageStream({
+  execute: async ({ writer }) => {
+    writer.merge(pipeYamlRender(result.toUIMessageStream()));
+  },
+});
+return createUIMessageStreamResponse({ stream });
+```
+
+### Streaming Parser (Low-Level)
+
+```typescript
+import { createYamlStreamCompiler } from "@json-render/yaml";
+
+const compiler = createYamlStreamCompiler<Spec>();
+
+// Feed chunks as they arrive
+const { result, newPatches } = compiler.push("root: main\n");
+compiler.push("elements:\n  main:\n    type: Card\n");
+
+// Flush remaining data
+const { result: final } = compiler.flush();
+```
+
+## API Reference
+
+### `yamlPrompt(catalog, options?)`
+
+Generate a YAML-format system prompt from any json-render catalog.
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `system` | `string` | `"You are a UI generator that outputs YAML."` | Custom system message intro |
+| `mode` | `"standalone" \| "inline"` | `"standalone"` | Output mode |
+| `customRules` | `string[]` | `[]` | Additional rules |
+| `editModes` | `EditMode[]` | `["merge"]` | Edit modes to document |
+
+### `createYamlTransform(options?)`
+
+Creates a `TransformStream` that converts YAML spec/edit fences in AI SDK stream chunks into json-render patch data parts.
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `previousSpec` | `Spec` | Seed with a previous spec for multi-turn edit support |
+
+### `pipeYamlRender(stream, options?)`
+
+Convenience wrapper that pipes an AI SDK stream through the YAML transform. Drop-in replacement for `pipeJsonRender` from `@json-render/core`.
+
+### `createYamlStreamCompiler(initial?)`
+
+Create a streaming YAML compiler that incrementally parses YAML text and emits JSON Patch operations.
+
+**Returns** `YamlStreamCompiler<T>` with methods:
+
+| Method | Description |
+|--------|-------------|
+| `push(chunk)` | Push a chunk of text. Returns `{ result, newPatches }` |
+| `flush()` | Flush remaining buffer and return final result |
+| `getResult()` | Get the current compiled result |
+| `getPatches()` | Get all patches applied so far |
+| `reset(initial?)` | Reset to initial state |
+
+### Fence Constants
+
+Exported constants for fence detection:
+
+- `YAML_SPEC_FENCE` — `` ```yaml-spec ``
+- `YAML_EDIT_FENCE` — `` ```yaml-edit ``
+- `YAML_PATCH_FENCE` — `` ```yaml-patch ``
+- `DIFF_FENCE` — `` ```diff ``
+- `FENCE_CLOSE` — `` ``` ``
+
+### Re-exports from `@json-render/core`
+
+- `diffToPatches(oldObj, newObj)` — Generate RFC 6902 JSON Patch from object diff
+- `deepMergeSpec(base, patch)` — RFC 7396 JSON Merge Patch

package/dist/index.d.mts

@@ -0,0 +1,118 @@
+import { JsonPatch, Spec, StreamChunk, EditMode, Catalog, SchemaDefinition } from '@json-render/core';
+export { deepMergeSpec, diffToPatches } from '@json-render/core';
+
+/**
+ * Streaming YAML compiler that incrementally parses YAML text and emits
+ * JSON Patch operations for each change detected.
+ *
+ * Same interface shape as `SpecStreamCompiler` from `@json-render/core`.
+ */
+interface YamlStreamCompiler<T> {
+    /** Push a chunk of text. Returns the current result and any new patches. */
+    push(chunk: string): {
+        result: T;
+        newPatches: JsonPatch[];
+    };
+    /** Flush remaining buffer and return the final result. */
+    flush(): {
+        result: T;
+        newPatches: JsonPatch[];
+    };
+    /** Get the current compiled result. */
+    getResult(): T;
+    /** Get all patches that have been applied. */
+    getPatches(): JsonPatch[];
+    /** Reset the compiler to initial state. */
+    reset(initial?: Partial<T>): void;
+}
+/**
+ * Create a streaming YAML compiler.
+ *
+ * Incrementally parses YAML text as it arrives and emits JSON Patch
+ * operations by diffing each successful parse against the previous snapshot.
+ *
+ * Uses `yaml.parse()` with YAML 1.2 defaults (the `yaml` v2 default).
+ * YAML 1.2 does not coerce `yes`/`no`/`on`/`off` to booleans.
+ *
+ * @example
+ * ```ts
+ * const compiler = createYamlStreamCompiler<Spec>();
+ * compiler.push("root: main\n");
+ * compiler.push("elements:\n  main:\n    type: Card\n");
+ * const { result } = compiler.flush();
+ * ```
+ */
+declare function createYamlStreamCompiler<T extends Record<string, unknown> = Record<string, unknown>>(initial?: Partial<T>): YamlStreamCompiler<T>;
+
+declare const YAML_SPEC_FENCE = "```yaml-spec";
+declare const YAML_EDIT_FENCE = "```yaml-edit";
+declare const YAML_PATCH_FENCE = "```yaml-patch";
+declare const DIFF_FENCE = "```diff";
+declare const FENCE_CLOSE = "```";
+interface YamlTransformOptions {
+    /** Seed with a previous spec for multi-turn edit support. */
+    previousSpec?: Spec;
+}
+/**
+ * Creates a `TransformStream` that intercepts AI SDK UI message stream chunks
+ * and converts YAML spec/edit blocks into json-render patch data parts.
+ *
+ * Two fence types are recognised:
+ *
+ * 1. **`\`\`\`yaml-spec`** — Full YAML spec. Parsed progressively, emitting
+ *    patches as each new property is detected.
+ * 2. **`\`\`\`yaml-edit`** — Partial YAML. Deep-merged with the current spec,
+ *    then diffed to produce patches. Only changed keys need to be included.
+ *
+ * Non-fenced text passes through unchanged as `text-delta` chunks, matching
+ * the behaviour of `createJsonRenderTransform` from `@json-render/core`.
+ */
+declare function createYamlTransform(options?: YamlTransformOptions): TransformStream<StreamChunk, StreamChunk>;
+/**
+ * Convenience wrapper that pipes an AI SDK UI message stream through the
+ * YAML transform, converting YAML spec/edit blocks into json-render patches.
+ *
+ * Drop-in replacement for `pipeJsonRender` from `@json-render/core`.
+ *
+ * @example
+ * ```ts
+ * import { pipeYamlRender } from "@json-render/yaml";
+ *
+ * const stream = createUIMessageStream({
+ *   execute: async ({ writer }) => {
+ *     writer.merge(pipeYamlRender(result.toUIMessageStream()));
+ *   },
+ * });
+ * return createUIMessageStreamResponse({ stream });
+ * ```
+ */
+declare function pipeYamlRender<T = StreamChunk>(stream: ReadableStream<T>, options?: YamlTransformOptions): ReadableStream<T>;
+
+interface YamlPromptOptions {
+    /** Custom system message intro. */
+    system?: string;
+    /**
+     * - `"standalone"` (default): LLM outputs only the YAML spec (no prose).
+     * - `"inline"`: LLM responds conversationally, then wraps YAML in a fence.
+     */
+    mode?: "standalone" | "inline";
+    /** Additional rules appended to the RULES section. */
+    customRules?: string[];
+    /** Edit modes to document. Default: `["merge"]` (yaml-edit). */
+    editModes?: EditMode[];
+}
+/**
+ * Generate a YAML-format system prompt from any json-render catalog.
+ *
+ * Works with catalogs from any renderer (`@json-render/react`,
+ * `@json-render/vue`, etc.) — it only reads the catalog metadata.
+ *
+ * @example
+ * ```ts
+ * import { yamlPrompt } from "@json-render/yaml";
+ * const systemPrompt = yamlPrompt(catalog, { mode: "inline" });
+ * ```
+ */
+declare function yamlPrompt(catalog: Catalog<SchemaDefinition, unknown>, options?: YamlPromptOptions): string;
+
+export { DIFF_FENCE, FENCE_CLOSE, YAML_EDIT_FENCE, YAML_PATCH_FENCE, YAML_SPEC_FENCE, type YamlPromptOptions, type YamlStreamCompiler, createYamlStreamCompiler, createYamlTransform, pipeYamlRender, yamlPrompt };

package/dist/index.d.ts

@@ -0,0 +1,118 @@
+import { JsonPatch, Spec, StreamChunk, EditMode, Catalog, SchemaDefinition } from '@json-render/core';
+export { deepMergeSpec, diffToPatches } from '@json-render/core';
+
+/**
+ * Streaming YAML compiler that incrementally parses YAML text and emits
+ * JSON Patch operations for each change detected.
+ *
+ * Same interface shape as `SpecStreamCompiler` from `@json-render/core`.
+ */
+interface YamlStreamCompiler<T> {
+    /** Push a chunk of text. Returns the current result and any new patches. */
+    push(chunk: string): {
+        result: T;
+        newPatches: JsonPatch[];
+    };
+    /** Flush remaining buffer and return the final result. */
+    flush(): {
+        result: T;
+        newPatches: JsonPatch[];
+    };
+    /** Get the current compiled result. */
+    getResult(): T;
+    /** Get all patches that have been applied. */
+    getPatches(): JsonPatch[];
+    /** Reset the compiler to initial state. */
+    reset(initial?: Partial<T>): void;
+}
+/**
+ * Create a streaming YAML compiler.
+ *
+ * Incrementally parses YAML text as it arrives and emits JSON Patch
+ * operations by diffing each successful parse against the previous snapshot.
+ *
+ * Uses `yaml.parse()` with YAML 1.2 defaults (the `yaml` v2 default).
+ * YAML 1.2 does not coerce `yes`/`no`/`on`/`off` to booleans.
+ *
+ * @example
+ * ```ts
+ * const compiler = createYamlStreamCompiler<Spec>();
+ * compiler.push("root: main\n");
+ * compiler.push("elements:\n  main:\n    type: Card\n");
+ * const { result } = compiler.flush();
+ * ```
+ */
+declare function createYamlStreamCompiler<T extends Record<string, unknown> = Record<string, unknown>>(initial?: Partial<T>): YamlStreamCompiler<T>;
+
+declare const YAML_SPEC_FENCE = "```yaml-spec";
+declare const YAML_EDIT_FENCE = "```yaml-edit";
+declare const YAML_PATCH_FENCE = "```yaml-patch";
+declare const DIFF_FENCE = "```diff";
+declare const FENCE_CLOSE = "```";
+interface YamlTransformOptions {
+    /** Seed with a previous spec for multi-turn edit support. */
+    previousSpec?: Spec;
+}
+/**
+ * Creates a `TransformStream` that intercepts AI SDK UI message stream chunks
+ * and converts YAML spec/edit blocks into json-render patch data parts.
+ *
+ * Two fence types are recognised:
+ *
+ * 1. **`\`\`\`yaml-spec`** — Full YAML spec. Parsed progressively, emitting
+ *    patches as each new property is detected.
+ * 2. **`\`\`\`yaml-edit`** — Partial YAML. Deep-merged with the current spec,
+ *    then diffed to produce patches. Only changed keys need to be included.
+ *
+ * Non-fenced text passes through unchanged as `text-delta` chunks, matching
+ * the behaviour of `createJsonRenderTransform` from `@json-render/core`.
+ */
+declare function createYamlTransform(options?: YamlTransformOptions): TransformStream<StreamChunk, StreamChunk>;
+/**
+ * Convenience wrapper that pipes an AI SDK UI message stream through the
+ * YAML transform, converting YAML spec/edit blocks into json-render patches.
+ *
+ * Drop-in replacement for `pipeJsonRender` from `@json-render/core`.
+ *
+ * @example
+ * ```ts
+ * import { pipeYamlRender } from "@json-render/yaml";
+ *
+ * const stream = createUIMessageStream({
+ *   execute: async ({ writer }) => {
+ *     writer.merge(pipeYamlRender(result.toUIMessageStream()));
+ *   },
+ * });
+ * return createUIMessageStreamResponse({ stream });
+ * ```
+ */
+declare function pipeYamlRender<T = StreamChunk>(stream: ReadableStream<T>, options?: YamlTransformOptions): ReadableStream<T>;
+
+interface YamlPromptOptions {
+    /** Custom system message intro. */
+    system?: string;
+    /**
+     * - `"standalone"` (default): LLM outputs only the YAML spec (no prose).
+     * - `"inline"`: LLM responds conversationally, then wraps YAML in a fence.
+     */
+    mode?: "standalone" | "inline";
+    /** Additional rules appended to the RULES section. */
+    customRules?: string[];
+    /** Edit modes to document. Default: `["merge"]` (yaml-edit). */
+    editModes?: EditMode[];
+}
+/**
+ * Generate a YAML-format system prompt from any json-render catalog.
+ *
+ * Works with catalogs from any renderer (`@json-render/react`,
+ * `@json-render/vue`, etc.) — it only reads the catalog metadata.
+ *
+ * @example
+ * ```ts
+ * import { yamlPrompt } from "@json-render/yaml";
+ * const systemPrompt = yamlPrompt(catalog, { mode: "inline" });
+ * ```
+ */
+declare function yamlPrompt(catalog: Catalog<SchemaDefinition, unknown>, options?: YamlPromptOptions): string;
+
+export { DIFF_FENCE, FENCE_CLOSE, YAML_EDIT_FENCE, YAML_PATCH_FENCE, YAML_SPEC_FENCE, type YamlPromptOptions, type YamlStreamCompiler, createYamlStreamCompiler, createYamlTransform, pipeYamlRender, yamlPrompt };