@rindle/narrator-react 0.6.3

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,30 @@
+# @rindle/narrator-react
+
+React integration for [`@rindle/narrator`](../narrator): subscribe to a query's live, netted change
+stream and buffer semantic events without re-rendering the component on each change.
+
+```sh
+pnpm add @rindle/narrator @rindle/narrator-react
+```
+
+```tsx
+import { useNarration } from "@rindle/narrator-react";
+import type { NarratorRegistry } from "@rindle/narrator";
+
+const NARRATORS: NarratorRegistry = {
+  unseatedGuests: {
+    salience: "alert",
+    root: { add: ({ row }) => `${row.name as string} needs a seat.` },
+  },
+};
+
+const advisor = useNarration(unseatedGuestsQuery({ eventId }), NARRATORS, { ctx });
+
+// When preparing the next agent prompt:
+for (const event of advisor.take()) agentContext.append(event.text);
+```
+
+Wrap the component tree in `Rindle` from `@rindle/react`. The returned handle is stable; `take()`
+drains events accumulated since its previous call, and `clear()` discards them. By default the hook
+ignores the initial snapshot and buffers only later batches. Pass `phases: ["snapshot", "batch"]` to
+include initial rows.

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+import type { AnyQuery, ChangePhase } from "@rindle/client";
+import type { NarrateContext, NarratorRegistry, SemanticEvent } from "@rindle/narrator";
+/** Options for {@link useNarration}. */
+export interface UseNarrationOptions {
+    /** The registry key for this query's templates. Defaults to a named query's `name`; pass it for an
+     *  ad-hoc (unnamed) query, e.g. `{ as: "deckSlides" }`. */
+    as?: string;
+    /** Context handed to every template (e.g. a human subject label). */
+    ctx?: NarrateContext;
+    /** Which delivery phases to narrate. Default `["batch"]` — the initial `snapshot` is the current
+     *  state (not a change), so "tell me what CHANGED" ignores it. Pass `["snapshot", "batch"]` to also
+     *  narrate the initial rows. */
+    phases?: ChangePhase[];
+    /** Cap the retained event buffer; oldest drop first. Default 200. */
+    max?: number;
+}
+/** A stable handle over a query's live narration buffer. */
+export interface Narration {
+    /** Drain the events accumulated since the last call, then clear — call this when you hand context
+     *  to an agent (e.g. on chat send). */
+    take(): SemanticEvent[];
+    /** Discard the buffer without returning it. */
+    clear(): void;
+}
+/** Narrate a live query's change stream into buffered {@link SemanticEvent}s — the agent-facing twin
+ *  of `useQuery`. It drives off the view's OWN `onChanges` channel (net of no-op rebase cycles, so a
+ *  correctly predicted optimistic write narrates nothing) and needs no store-global qid filter.
+ *
+ *  The returned handle is STABLE and does NOT re-render on each change — narration feeds an agent,
+ *  not the DOM. Drain it with `take()` at the moment you send context. Pass a STABLE `registry` (a
+ *  module const): a fresh object each render re-subscribes the view. */
+export declare function useNarration<Q extends AnyQuery>(query: Q, registry: NarratorRegistry, opts?: UseNarrationOptions): Narration;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE5D,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGxF,wCAAwC;AACxC,MAAM,WAAW,mBAAmB;IAClC;+DAC2D;IAC3D,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,qEAAqE;IACrE,GAAG,CAAC,EAAE,cAAc,CAAC;IACrB;;oCAEgC;IAChC,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB,qEAAqE;IACrE,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,4DAA4D;AAC5D,MAAM,WAAW,SAAS;IACxB;2CACuC;IACvC,IAAI,IAAI,aAAa,EAAE,CAAC;IACxB,+CAA+C;IAC/C,KAAK,IAAI,IAAI,CAAC;CACf;AAED;;;;;;wEAMwE;AACxE,wBAAgB,YAAY,CAAC,CAAC,SAAS,QAAQ,EAC7C,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,gBAAgB,EAC1B,IAAI,GAAE,mBAAwB,GAC7B,SAAS,CAiEX"}

package/dist/index.js

@@ -0,0 +1,71 @@
+// @rindle/narrator-react — React lifecycle integration for @rindle/narrator.
+import { useEffect, useMemo, useRef } from "react";
+import { createNarrator } from "@rindle/narrator";
+import { queryCacheKey, useRindleStore } from "@rindle/react";
+/** Narrate a live query's change stream into buffered {@link SemanticEvent}s — the agent-facing twin
+ *  of `useQuery`. It drives off the view's OWN `onChanges` channel (net of no-op rebase cycles, so a
+ *  correctly predicted optimistic write narrates nothing) and needs no store-global qid filter.
+ *
+ *  The returned handle is STABLE and does NOT re-render on each change — narration feeds an agent,
+ *  not the DOM. Drain it with `take()` at the moment you send context. Pass a STABLE `registry` (a
+ *  module const): a fresh object each render re-subscribes the view. */
+export function useNarration(query, registry, opts = {}) {
+    // Derive + validate the registry key BEFORE any hook runs (so a throw never executes a partial
+    // hook list). An ad-hoc (unnamed) query carries no `name`, so without `opts.as` the key would fall
+    // back to "" — matching no registry entry and silently narrating NOTHING, indistinguishable from
+    // "no changes". Fail loud instead: the fix is one option, and a silent agent is worse than a crash.
+    const key = opts.as ?? (typeof query.name === "string" ? query.name : "");
+    if (key === "") {
+        throw new Error("useNarration: could not derive a narrator registry key from this query. Ad-hoc (unnamed) " +
+            'queries have no name — pass `{ as: "<registryKey>" }` naming this query\'s narrator entry.');
+    }
+    const store = useRindleStore();
+    const viewKey = queryCacheKey(query);
+    const queryRef = useRef(query);
+    queryRef.current = query;
+    const narrator = useMemo(() => createNarrator(registry), [registry]);
+    // Latest ctx/phases/max read inside the subscription, so a changing `opts` object does not
+    // re-subscribe the view (only the query/registry/key identity does).
+    const optsRef = useRef(opts);
+    optsRef.current = opts;
+    const bufferRef = useRef([]);
+    useEffect(() => {
+        // A dedicated view for narration: `onChanges` is wired inside `materialize` (before the backend
+        // registers the query), so a synchronous backend's first `snapshot` is caught too.
+        const view = store.materialize(queryRef.current, {
+            onChanges: (changes, phase, schema) => {
+                const { phases, ctx, max = 200 } = optsRef.current;
+                const want = phases ? phases.includes(phase) : phase === "batch";
+                if (!want)
+                    return;
+                const buf = bufferRef.current;
+                // `text === null` is the narrator's suppression signal; an empty string is a real (if terse)
+                // rendered line, so filter on null explicitly, not truthiness.
+                for (const event of narrator.narrate(key, schema, changes, phase, ctx)) {
+                    if (event.text !== null)
+                        buf.push(event);
+                }
+                if (buf.length > max)
+                    buf.splice(0, buf.length - max);
+            },
+        });
+        // Clear the buffer on re-subscribe (a query/registry/key identity change, or a StrictMode
+        // double-mount): the buffer outlives the effect, so without this a re-materialize replays the
+        // fresh snapshot/changes on top of stale events from the previous subscription.
+        return () => {
+            view.destroy();
+            bufferRef.current = [];
+        };
+    }, [store, viewKey, narrator, key]);
+    return useMemo(() => ({
+        take: () => {
+            const out = bufferRef.current;
+            bufferRef.current = [];
+            return out;
+        },
+        clear: () => {
+            bufferRef.current = [];
+        },
+    }), []);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAE7E,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAEnD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AA0B9D;;;;;;wEAMwE;AACxE,MAAM,UAAU,YAAY,CAC1B,KAAQ,EACR,QAA0B,EAC1B,OAA4B,EAAE;IAE9B,+FAA+F;IAC/F,mGAAmG;IACnG,iGAAiG;IACjG,oGAAoG;IACpG,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC1E,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,2FAA2F;YACzF,4FAA4F,CAC/F,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAG,cAAc,EAAE,CAAC;IAC/B,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/B,QAAQ,CAAC,OAAO,GAAG,KAAK,CAAC;IAEzB,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAErE,2FAA2F;IAC3F,qEAAqE;IACrE,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7B,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IACvB,MAAM,SAAS,GAAG,MAAM,CAAkB,EAAE,CAAC,CAAC;IAE9C,SAAS,CAAC,GAAG,EAAE;QACb,gGAAgG;QAChG,mFAAmF;QACnF,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,EAAE;YAC/C,SAAS,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;gBACpC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;gBACnD,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,OAAO,CAAC;gBACjE,IAAI,CAAC,IAAI;oBAAE,OAAO;gBAClB,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC;gBAC9B,6FAA6F;gBAC7F,+DAA+D;gBAC/D,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;oBACvE,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI;wBAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC3C,CAAC;gBACD,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG;oBAAE,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC;YACxD,CAAC;SACF,CAAC,CAAC;QACH,0FAA0F;QAC1F,8FAA8F;QAC9F,gFAAgF;QAChF,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,SAAS,CAAC,OAAO,GAAG,EAAE,CAAC;QACzB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;IAEpC,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,CAAC;QACL,IAAI,EAAE,GAAG,EAAE;YACT,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC;YAC9B,SAAS,CAAC,OAAO,GAAG,EAAE,CAAC;YACvB,OAAO,GAAG,CAAC;QACb,CAAC;QACD,KAAK,EAAE,GAAG,EAAE;YACV,SAAS,CAAC,OAAO,GAAG,EAAE,CAAC;QACzB,CAAC;KACF,CAAC,EACF,EAAE,CACH,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@rindle/narrator-react",
+  "version": "0.6.3",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rindle-sh/rindle.git",
+    "directory": "packages/narrator-react"
+  },
+  "type": "module",
+  "description": "React integration for @rindle/narrator: subscribe to a Rindle query's netted change stream and buffer agent-ready semantic events.",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "@rindle/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "dependencies": {
+    "@rindle/narrator": "0.6.3",
+    "@rindle/client": "0.6.3",
+    "@rindle/react": "0.6.3"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@types/jsdom": "^21.1.0",
+    "@types/node": "^22.10.0",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "jsdom": "^25.0.0",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0",
+    "typescript": "^5.7.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "tsc --noEmit && node --conditions=@rindle/source --test test/*.test.ts"
+  }
+}

package/src/index.ts

@@ -0,0 +1,109 @@
+// @rindle/narrator-react — React lifecycle integration for @rindle/narrator.
+
+import { useEffect, useMemo, useRef } from "react";
+import type { AnyQuery, ChangePhase } from "@rindle/client";
+import { createNarrator } from "@rindle/narrator";
+import type { NarrateContext, NarratorRegistry, SemanticEvent } from "@rindle/narrator";
+import { queryCacheKey, useRindleStore } from "@rindle/react";
+
+/** Options for {@link useNarration}. */
+export interface UseNarrationOptions {
+  /** The registry key for this query's templates. Defaults to a named query's `name`; pass it for an
+   *  ad-hoc (unnamed) query, e.g. `{ as: "deckSlides" }`. */
+  as?: string;
+  /** Context handed to every template (e.g. a human subject label). */
+  ctx?: NarrateContext;
+  /** Which delivery phases to narrate. Default `["batch"]` — the initial `snapshot` is the current
+   *  state (not a change), so "tell me what CHANGED" ignores it. Pass `["snapshot", "batch"]` to also
+   *  narrate the initial rows. */
+  phases?: ChangePhase[];
+  /** Cap the retained event buffer; oldest drop first. Default 200. */
+  max?: number;
+}
+
+/** A stable handle over a query's live narration buffer. */
+export interface Narration {
+  /** Drain the events accumulated since the last call, then clear — call this when you hand context
+   *  to an agent (e.g. on chat send). */
+  take(): SemanticEvent[];
+  /** Discard the buffer without returning it. */
+  clear(): void;
+}
+
+/** Narrate a live query's change stream into buffered {@link SemanticEvent}s — the agent-facing twin
+ *  of `useQuery`. It drives off the view's OWN `onChanges` channel (net of no-op rebase cycles, so a
+ *  correctly predicted optimistic write narrates nothing) and needs no store-global qid filter.
+ *
+ *  The returned handle is STABLE and does NOT re-render on each change — narration feeds an agent,
+ *  not the DOM. Drain it with `take()` at the moment you send context. Pass a STABLE `registry` (a
+ *  module const): a fresh object each render re-subscribes the view. */
+export function useNarration<Q extends AnyQuery>(
+  query: Q,
+  registry: NarratorRegistry,
+  opts: UseNarrationOptions = {},
+): Narration {
+  // Derive + validate the registry key BEFORE any hook runs (so a throw never executes a partial
+  // hook list). An ad-hoc (unnamed) query carries no `name`, so without `opts.as` the key would fall
+  // back to "" — matching no registry entry and silently narrating NOTHING, indistinguishable from
+  // "no changes". Fail loud instead: the fix is one option, and a silent agent is worse than a crash.
+  const key = opts.as ?? (typeof query.name === "string" ? query.name : "");
+  if (key === "") {
+    throw new Error(
+      "useNarration: could not derive a narrator registry key from this query. Ad-hoc (unnamed) " +
+        'queries have no name — pass `{ as: "<registryKey>" }` naming this query\'s narrator entry.',
+    );
+  }
+
+  const store = useRindleStore();
+  const viewKey = queryCacheKey(query);
+  const queryRef = useRef(query);
+  queryRef.current = query;
+
+  const narrator = useMemo(() => createNarrator(registry), [registry]);
+
+  // Latest ctx/phases/max read inside the subscription, so a changing `opts` object does not
+  // re-subscribe the view (only the query/registry/key identity does).
+  const optsRef = useRef(opts);
+  optsRef.current = opts;
+  const bufferRef = useRef<SemanticEvent[]>([]);
+
+  useEffect(() => {
+    // A dedicated view for narration: `onChanges` is wired inside `materialize` (before the backend
+    // registers the query), so a synchronous backend's first `snapshot` is caught too.
+    const view = store.materialize(queryRef.current, {
+      onChanges: (changes, phase, schema) => {
+        const { phases, ctx, max = 200 } = optsRef.current;
+        const want = phases ? phases.includes(phase) : phase === "batch";
+        if (!want) return;
+        const buf = bufferRef.current;
+        // `text === null` is the narrator's suppression signal; an empty string is a real (if terse)
+        // rendered line, so filter on null explicitly, not truthiness.
+        for (const event of narrator.narrate(key, schema, changes, phase, ctx)) {
+          if (event.text !== null) buf.push(event);
+        }
+        if (buf.length > max) buf.splice(0, buf.length - max);
+      },
+    });
+    // Clear the buffer on re-subscribe (a query/registry/key identity change, or a StrictMode
+    // double-mount): the buffer outlives the effect, so without this a re-materialize replays the
+    // fresh snapshot/changes on top of stale events from the previous subscription.
+    return () => {
+      view.destroy();
+      bufferRef.current = [];
+    };
+  }, [store, viewKey, narrator, key]);
+
+  return useMemo<Narration>(
+    () => ({
+      take: () => {
+        const out = bufferRef.current;
+        bufferRef.current = [];
+        return out;
+      },
+      clear: () => {
+        bufferRef.current = [];
+      },
+    }),
+    [],
+  );
+}