ngx-json-render 0.2.0 → 0.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-json-render",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Angular renderer for json-render — stream AI-generated JSON specs into real Angular components with signals.",
   "keywords": [
     "angular",

package/types/ngx-json-render.d.ts

@@ -593,6 +593,66 @@ declare function defineRegistry<C extends Catalog>(catalog: C, options: DefineRe
  */
 declare function createStoreSetState(store: Pick<StateStore, 'getSnapshot' | 'update'>): SetState;
 
+/**
+ * Apply an RFC 6902 JSON patch to a spec, returning a new spec object and
+ * sharing every subtree the patch did not touch.
+ *
+ * This is the only patch engine in the package: `injectUIStream`,
+ * `injectChatUI` and `buildSpecFromParts` all route through it, so the same
+ * stream produces the same spec whichever one an app reached for. The write
+ * primitives come from `@json-render/core`, so `add` splices into an array
+ * where `replace` overwrites, exactly as the other renderers do.
+ *
+ * One deliberate deviation from RFC 6902: a failing `test` op is a no-op
+ * rather than an abort. These patches come off a model's output, where the
+ * established behaviour — see the line parser — is to drop what does not make
+ * sense and keep rendering rather than kill a generation mid-flight.
+ */
+declare function applyPatch(spec: Spec, patch: JsonPatch): Spec;
+
+/**
+ * Convert a flat element list to a Spec.
+ * Input elements use key/parentKey to establish identity and relationships.
+ * Output spec uses the map-based format where key is the map entry key
+ * and parent-child relationships are expressed through children arrays.
+ */
+declare function flatToTree(elements: FlatElement[]): Spec;
+/**
+ * A single part from the AI SDK's `message.parts` array. This is a minimal
+ * structural type so that library helpers do not depend on the AI SDK.
+ */
+interface DataPart {
+    type: string;
+    text?: string;
+    data?: unknown;
+}
+/**
+ * Build a `Spec` by replaying all spec data parts from a message's
+ * parts array (AI SDK `UIMessage.parts`). Returns `null` if no spec data
+ * parts are present.
+ */
+declare function buildSpecFromParts(parts: DataPart[]): Spec | null;
+/**
+ * Extract and join all text content from a message's parts array.
+ */
+declare function getTextFromParts(parts: DataPart[]): string;
+/**
+ * Extract both the json-render spec and the text content from a message's
+ * parts array, as memoized signals. Angular counterpart of
+ * `useJsonRenderMessage` from the other renderers.
+ *
+ * @example
+ * ```ts
+ * readonly msg = jsonRenderMessage(() => this.message().parts);
+ * // template: @if (msg.hasSpec()) { <json-render [spec]="msg.spec()" ... /> }
+ * ```
+ */
+declare function jsonRenderMessage(parts: Signal<DataPart[]> | (() => DataPart[])): {
+    spec: Signal<Spec | null>;
+    text: Signal<string>;
+    hasSpec: Signal<boolean>;
+};
+
 /**
  * Token usage metadata from AI generation.
  */
@@ -602,11 +662,17 @@ interface TokenUsage {
     totalTokens: number;
 }
 /**
- * Apply an RFC 6902 JSON patch to the current spec, returning a new spec
- * object (structural sharing for untouched elements).
- * Supports add, remove, replace, move, copy, and test operations.
+ * Per-call options for {@link UIStreamReturn.send}.
  */
-declare function applyPatch(spec: Spec, patch: JsonPatch): Spec;
+interface UIStreamSendOptions {
+    /** Arbitrary context forwarded to the endpoint as `context`. */
+    context?: Record<string, unknown>;
+    /**
+     * Spec to refine instead of starting from an empty one. It is sent to the
+     * endpoint as `currentSpec` and the streamed patches apply on top of it.
+     */
+    previousSpec?: Spec;
+}
 /**
  * Options for {@link injectUIStream}.
  */
@@ -644,8 +710,13 @@ interface UIStreamReturn {
     /** Raw JSONL lines received from the stream (JSON patch lines) */
     readonly rawLines: Signal<string[]>;
     /** Send a prompt to generate UI */
-    send: (prompt: string, context?: Record<string, unknown>) => Promise<void>;
-    /** Clear the current spec */
+    send: (prompt: string, options?: UIStreamSendOptions) => Promise<void>;
+    /**
+     * Stop the in-flight generation, keeping whatever has rendered so far.
+     * A no-op when nothing is streaming.
+     */
+    stop: () => void;
+    /** Stop any generation and clear the spec, error, usage and raw lines. */
     clear: () => void;
 }
 /**
@@ -666,48 +737,7 @@ interface UIStreamReturn {
  * ```
  */
 declare function injectUIStream(options: UIStreamOptions): UIStreamReturn;
-/**
- * Convert a flat element list to a Spec.
- * Input elements use key/parentKey to establish identity and relationships.
- * Output spec uses the map-based format where key is the map entry key
- * and parent-child relationships are expressed through children arrays.
- */
-declare function flatToTree(elements: FlatElement[]): Spec;
-/**
- * A single part from the AI SDK's `message.parts` array. This is a minimal
- * structural type so that library helpers do not depend on the AI SDK.
- */
-interface DataPart {
-    type: string;
-    text?: string;
-    data?: unknown;
-}
-/**
- * Build a `Spec` by replaying all spec data parts from a message's
- * parts array (AI SDK `UIMessage.parts`). Returns `null` if no spec data
- * parts are present.
- */
-declare function buildSpecFromParts(parts: DataPart[]): Spec | null;
-/**
- * Extract and join all text content from a message's parts array.
- */
-declare function getTextFromParts(parts: DataPart[]): string;
-/**
- * Extract both the json-render spec and the text content from a message's
- * parts array, as memoized signals. Angular counterpart of
- * `useJsonRenderMessage` from the other renderers.
- *
- * @example
- * ```ts
- * readonly msg = jsonRenderMessage(() => this.message().parts);
- * // template: @if (msg.hasSpec()) { <json-render [spec]="msg.spec()" ... /> }
- * ```
- */
-declare function jsonRenderMessage(parts: Signal<DataPart[]> | (() => DataPart[])): {
-    spec: Signal<Spec | null>;
-    text: Signal<string>;
-    hasSpec: Signal<boolean>;
-};
+
 /**
  * A single message in the chat, which may contain text, a rendered UI spec,
  * or both.
@@ -734,7 +764,7 @@ interface ChatUIOptions {
     onError?: (error: Error) => void;
     /**
      * Transport, defaulting to the global `fetch`. Same contract as
-     * {@link UIStreamOptions.fetch}: it receives the endpoint and a request
+     * `UIStreamOptions.fetch`: it receives the endpoint and a request
      * carrying the JSON body and the abort signal, and must resolve to a
      * `Response` whose `body` streams the reply.
      */
@@ -752,7 +782,12 @@ interface ChatUIReturn {
     readonly error: Signal<Error | null>;
     /** Send a user message */
     send: (text: string) => Promise<void>;
-    /** Clear all messages and reset the conversation */
+    /**
+     * Stop the in-flight reply, keeping whatever the assistant has said so far.
+     * A no-op when nothing is streaming.
+     */
+    stop: () => void;
+    /** Stop any reply and clear all messages and the error. */
     clear: () => void;
 }
 /**
@@ -842,4 +877,4 @@ type AngularSpec<TCatalog> = typeof schema extends {
 declare function injectDevtoolsActive(): Signal<boolean>;
 
 export { JrChildren, JrConfirmDialog, JrElement, JrRepeatScope, JsonRenderActionsService, JsonRenderRootContext, JsonRenderStateService, JsonRenderValidationService, JsonRenderer, RENDER_CONTEXT, REPEAT_SCOPE, applyPatch, buildSpecFromParts, createStoreSetState, defineRegistry, flatToTree, getTextFromParts, injectAction, injectActions, injectBoundProp, injectChatUI, injectDevtoolsActive, injectFieldValidation, injectRenderContext, injectRepeatScope, injectStateBinding, injectStateStore, injectStateValue, injectUIStream, injectValidation, jsonRenderMessage, schema };
-export type { ActionFn, Actions, AngularSchema, AngularSpec, CatalogHasActions, ChatMessage, ChatUIOptions, ChatUIReturn, ComponentRegistry, Components, DataPart, DefineRegistryResult, EventHandle, FieldValidationState, PendingConfirmation, RegistryEntry, RenderContext, RepeatScope, SetState, StateChange, TokenUsage, UIStreamOptions, UIStreamReturn };
+export type { ActionFn, Actions, AngularSchema, AngularSpec, CatalogHasActions, ChatMessage, ChatUIOptions, ChatUIReturn, ComponentRegistry, Components, DataPart, DefineRegistryResult, EventHandle, FieldValidationState, PendingConfirmation, RegistryEntry, RenderContext, RepeatScope, SetState, StateChange, TokenUsage, UIStreamOptions, UIStreamReturn, UIStreamSendOptions };