@loomwork/ui-hydration 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 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/NOTICE

@@ -0,0 +1,8 @@
+loom-ui
+Copyright 2026 Sushil Chhetri
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this project except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0

package/README.md

@@ -1,3 +1,399 @@
-# Temporary Holding Version
+# @loomwork/ui-hydration
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Resolves an Experience's provider handles through loom's transient effects and publishes them as
+one loom projection, so a renderer can bind to `values.<handle>` / `status.<handle>` and redraw as
+they arrive. It is the provider plane of the pipeline: `@loomwork/ui-core` compiles an Experience to a
+`Blueprint`; this package answers what the Blueprint's bindings need, in-process or split across a
+trust boundary; `@loomwork/ui-renderer-lit` and `@loomwork/ui-renderer-terminal` read the resulting
+projection state. Hydration is **read-only and log-free** — it never emits a durable event; drift
+repair is the app's own loom execution.
+
+## Install / import
+
+```jsonc
+// package.json of a consumer checked out beside this repo (the packages are not published)
+"@loomwork/ui-hydration": "link:../loom-ui/packages/hydration"
+```
+
+```ts
+// Node / server: executes providers — imports loom's sandbox (QuickJS WASM) and MCP plugin.
+import { HydrationController, handleInventory, serveHandles } from "@loomwork/ui-hydration";
+
+// Browser: split hydration only. Never import the root entry from a browser bundle.
+import { SplitHydrationController, HydrationStore } from "@loomwork/ui-hydration/client";
+```
+
+## Key concepts
+
+- **Two entries, one trust boundary.** The root entry (`@loomwork/ui-hydration`) is server-side: it
+  executes providers, so its module graph reaches loom's sandbox and MCP plugin. The client entry
+  (`@loomwork/ui-hydration/client`, `src/client.ts`) carries only what split hydration needs in a
+  browser: the split controller, the loader contract, the store, and param checks — nothing that
+  imports the sandbox, MCP, `@loomwork/effect-runtime` or a Node builtin. `clientEntry.test.ts` walks
+  the *built* client bundle to enforce this, and keeps it under a 56 KiB size budget (the
+  minified ESM bundle). The client entry also carries the pure helpers other client-side packages need
+  (`terminalSteps`, `stepReferences`, `topoWaves`, `jsonPathSelect`, `outputShapeHashOf`, a
+  client-safe mirror of the sandbox's shape hash, parity-tested). `@loomwork/ui-planner`,
+  `renderer-terminal`, `renderer-lit` and `core` import ONLY `@loomwork/ui-hydration/client`;
+  `clientConsumers.test.ts` fails if any of them reaches the root entry, QuickJS or the MCP plugin,
+  by source import or built module graph.
+- **The hydration projection.** Every handle publishes to one loom projection
+  (`HYDRATION_PROJECTION_ID = "loom-ui.hydration"`, version `HYDRATION_PROJECTION_VERSION`) that a
+  `HydrationStore` wraps; a compiled Blueprint's bindings read `values.<handle>` / `status.<handle>`
+  from it. A handle's `HandleState` is `"pending" | "ready" | "stale" | "error" | "empty"`.
+- **In-process vs. split.** `HydrationController` executes providers directly through an injected
+  `TransientInvoker` (any loom `EffectRuntime` satisfies it structurally).
+  `SplitHydrationController` (client) talks to a `HandleLoader` — the app's transport — which calls
+  `serveHandle`/`serveHandles` (server) over that boundary; the server answers with the exact same
+  `HandleLoadResult` shape the in-process controller publishes, so the two paths cannot disagree.
+- **`scopeInvoker` and `principal`.** When the invoker is a planner `scopeInvoker` (a `ctx.decide`
+  scope), do not configure `principal`: the scope already carries the execution's principal and the
+  call is refused otherwise.
+- **Bounded cache (U17).** `new HydrationCache(clock, { maxEntries })` evicts the least recently
+  used result past `maxEntries` (default `DEFAULT_CACHE_MAX_ENTRIES` = 10,000; a hit or a set
+  refreshes an entry; a non-positive-integer cap throws `RangeError`). An evicted result is a miss,
+  exactly like an expired one: the next load calls the provider again. Before this the cache only
+  dropped an entry on a re-read after its TTL, so a long-lived ambient host grew without bound.
+- **Scheduling.** Both controllers schedule by priority: P0 loads immediately, P1 batches within a
+  short window, P2 waits for `markVisible`. An identical step (same tool, same arguments) runs once
+  per pass no matter how many handles share it.
+- **Params, time tokens, drift.** A step declares which argument names a load may override
+  (`MCPToolNode.overridable`); `$now`/`$now±<n><s|m|h|d|w>` tokens resolve once per pass against an
+  injected clock; drift (an input schema pin that moved, or an output that no longer reshapes or
+  fits its contract) is reported through `onDrift`, never repaired here.
+
+## API
+
+### The projection and its store
+
+- `HYDRATION_PROJECTION_ID`, `HYDRATION_PROJECTION_VERSION`, `HYDRATION_SET_EVENT` — the fixed
+  projection id/version and the internal set event it folds.
+- `hydrationProjection()`, `HydrationState`, `HandleSlice`, `HandleState`, `HandleStatus`,
+  `HydrationScope` — the loom `Projection` itself and its state shape. Isolation is by (experience,
+  principal, audience): `HydrationScope.audience` (`"broadcast"`) is its own state, and
+  `HydrationAudienceMismatchError` is thrown when a controller's `audience` differs from its
+  store's.
+- `HydrationStore` — wraps a `projectionRuntime` and exposes `.state()` and `.runtimeSubscribe(fn)`
+  for a renderer or `watch` to read/observe.
+- `isReservedHandle(handle)` — true for a handle name the projection itself reserves.
+
+### Running providers (server / Node only)
+
+- `HydrationController` — in-process controller. Constructor takes `ControllerOptions` (`invoker`,
+  `store`, `clock?`, `setTimer?`, `batchWindowMs?`, `concurrency?`, `maxConcurrentCalls?`,
+  `principal?`, `cache?`, `viewer?`, `audience?`, `readPolicy?`, `declaredToolClasses?`, `undeclared?`,
+  `onDrift?`, `outputKinds?`, `defaultParams?`, `inputDrift?`,
+  `argumentHook?`, `contentRefArgs` (required), `acceptContentRefParam?`, `reshapers?`,
+  `providers?`, `captureSample?`). Methods: `load(exp)`, `recompose(next)`, `markVisible(handle)`,
+  `setParams(params, scope?)`, `invalidate(handle?)`, `inFlight()`, `dispose()`, plus `setViewer(viewer)`,
+  `append(handle, chunk)` and `publishValue(handle, value, { state?, kind? })` — the ones that can
+  fail return `{ findings: Finding[] }` or a `{ ok: false, finding }` refusal.
+- **Content-reference arguments (U9b).** `contentRefArgs` is REQUIRED on `ControllerOptions` and
+  `ServeOptions`: the table `contentRefArgsFrom(capabilities)` builds (persist it with the
+  capability set; `parseContentRefTable` re-reads it), or the explicit opt-out `"none"` (an
+  experience with media nodes then reports `media-content-refs-unguarded`). Before ANY call a step's
+  marked argument must be absent / null, a `{{steps.…}}` reference to an output its tool declares to
+  be a content reference, or a param the host accepted; otherwise the step is refused
+  (`media-arg-literal` / `media-arg-unproven-ref`, or `media-arg-param-refused` for a param the gate
+  refused: three distinct codes on `onFinding`) and the call is NOT made. Behaviour change: when
+  every failed step was such a refusal, the outcome's finding (and what a split client receives) is
+  the public code `content-ref-refused` with one fixed message, no longer the opaque
+  `provider-failed`; it says nothing of which argument, step or whether a reference exists. A
+  refusal mixed with another failure stays `provider-failed`. A param the gate refuses used to be
+  reported as `media-arg-literal` and is now `media-arg-param-refused`. The same check runs BEFORE
+  every cache lookup (in-process and split), asking the gate again: a cached value is never served
+  to a principal whose gate refuses, nor after a revocation, and a result a param filled is cached
+  per principal only, never globally. A param that fills a marked argument (in-process `setParams`,
+  or a split client's params, which are client input) is refused unless `acceptContentRefParam({
+  handle, stepId, toolName, kind?, param, value, principalId?, principal? }) => boolean` returns
+  `true`. The gate MUST check that the value was ISSUED TO `principalId` (e.g. keep the `MediaRef`s
+  `acceptMediaAttach` accepted for each principal and return
+  `issued.get(principalId)?.has(value.address)`) and is still current (a revoked share answers
+  `false`). `null` at a marked path is stripped before the call. The `argumentHook` runs after the
+  check and is the host's own word. A tool whose schema mentions the marker but was unreadable
+  (`"unknown"`) has every replaced param gated and every literal string refused.
+- `executeProvider` — runs one `ProviderSpec`'s execution graph and reshaping; what both controllers
+  and `serveHandle`/`serveHandles` call underneath.
+- `ExecuteOptions`, `ProviderOutcome`, `DriftRecord`, `InputDriftMode` — the execution options and
+  outcome/drift shapes `executeProvider` and `onDrift` use.
+- `DriftReport` — what `ControllerOptions.onDrift` actually receives: `{ experienceId, versionHash,
+  handle, spec, drift: readonly DriftRecord[], findings, proceeded }` — one or more drift records
+  for the handle, plus the provider spec that drifted and whether the load retried and published
+  (`inputDrift: "report-and-proceed"`).
+- `HandleLoadResult` — what every load resolves to and what both controllers publish: `{ state:
+  "ready", value, finding? } | { state: "stale" | "error", finding } | { state: "empty", finding }`.
+- `HydrationCache`, `CacheVariant` (`params`, `kinds`, `contracts` — the bound kinds'
+  `ValueContract.version`s are folded into the key; unversioned contracts leave keys unchanged, so
+  call `invalidate()` after changing one) — the per-principal, per-params cache
+  `HydrationController` uses by default (inject your own, or a fresh one per controller).
+- `limitInvoker`, `memoInvoker`, `signalInvoker` — `TransientInvoker` wrappers: cap concurrency,
+  de-duplicate identical calls within one pass, and bind an `AbortSignal`. `memoInvoker` keys on the
+  principal AND every other call option except `signal` (e.g. a stamped execution identity `as`, or
+  the `label` that names the transient execution when `as` is absent — an authorizer may grant by
+  either), so calls made as different executions never share a result.
+- `defineReshapers(entries)`, `jsonPathSelect(value, path)`, `outputShapeHashOf(value)` — build a
+  `ReshaperRegistry` for `reshaping.engine: "Named"`, run a JSONPath reshape, and hash a value's
+  structural shape for pinning `ProviderSpec.outputShapeHash`.
+- `stepReferences`, `terminalSteps`, `topoWaves` — inspect an execution graph's `{{steps.…}}`
+  references, find its terminal step(s), and compute its topological waves.
+- `DEFAULT_TIME_RANGE`, `checkParams` — the default `{ from: "$now-24h", to: "$now" }` params, and a
+  params validity check.
+
+### The data plane: data-provider kinds (server / Node only)
+
+A provider step used to be an MCP tool call and nothing else. A step now names a **kind**
+(`step.kind`; absent = `mcp`, the original) and hydration runs it through the `DataProvider`
+registered for that kind. A loom app whose data lives in a loom effect (a `tool$`, a read-model
+query, an A2A call) binds it directly, without wrapping it as an MCP server.
+
+- `DataProvider` — `{ kind, invoke(call, invoker, opts) }`. `call` is `{ stepId, target, args,
+  expectedPin }`: `target` is the step's `toolName` (its id WITHIN the kind), `args` the prepared
+  arguments (params, time tokens, templates, hook already applied), `expectedPin` the step's
+  `toolSchemaHash`. `invoke` runs the target THROUGH the transient `invoker` it is handed with
+  `opts` (signal, principal, label) — so the invoker's authoriser, budget and per-principal identity
+  stay in force, the read path stays log-free, and a kind never sees the runtime.
+- **The pin is the contract.** `invoke` MUST compare `expectedPin` with the target's current pin and
+  throw `TypedFailure("schemaDrift", { observedHash })` BEFORE running the target. That is what
+  makes drift a `DriftRecord` (`kind: "input"`, `providerKind` set for a non-MCP kind), what
+  `remapOperation` repairs, and what `inputDrift: "report-and-proceed"` retries on. A kind that
+  cannot say what its target's contract is must not be registered: there is no unpinned kind.
+  `checkDataProviderConformance(provider, { target, pin, invoker })` returns the violations (empty =
+  conformant), including a violation if a stale pin reached a direct call to `target`; it is a TEST
+  HELPER — `defineDataProviders` cannot enforce the rule, so run it in a kind's own tests.
+- `defineDataProviders(providers)` → `DataProviderRegistry` (`has`/`get`/`kinds`) — composition-time
+  only, no discovery, no later registration; a malformed or duplicate kind id throws. Pass it as
+  `providers` to `HydrationController`, `serveHandle(s)` or `executeProvider`. Default
+  (`DEFAULT_DATA_PROVIDERS`): MCP only, byte-identical to before kinds.
+- `mcpProvider` — the first registered kind: `mcp.invoke` with `expectedPin` as `expectedSchemaHash`
+  (the plugin verifies it per call).
+- `loomEffectProvider({ runtime, effects })` — the second kind, `loom-effect` (`LOOM_EFFECT_KIND`):
+  a step whose `toolName` is a registered loom effect id, invoked via `invokeTransient`. Hydration
+  is a read path (per viewer load, unmemoised, retried), so at CONSTRUCTION every listed effect is
+  checked against `runtime` (`has` / `modeOf` / `kindOf`): it must be registered, explicitly `mode:
+  "ambient"` (ADR 0073 — an UNDECLARED mode is refused, since loom itself only refuses an explicit
+  `journaled` one), and not a `human` / `llm` kind. `effects` is an ALLOWLIST: a stored or
+  planner-authored step can name any string. Each entry is `{ inputSchema }` (the pin is computed
+  with `effectPin(schema)` = `jsonSchemaHash` of its JSON-Schema form, so editing the effect's zod
+  schema drifts every stored step with no edit to the map) or `{ pin }` (HOST-ASSERTED: nothing
+  checks it against the effect). Use `effectPin` also when building a planner
+  `CapabilityRef.toolSchemaHash`, so both come from one source. An unlisted target fails
+  `tool-targetUnregistered` and nothing runs; `mcp.invoke` and the sandbox effect cannot be listed.
+  A target that itself throws `schemaDrift` surfaces as `tool-targetFailed` (`TARGET_FAILED`), never
+  as pin drift — only the provider's own pin check emits `schemaDrift`, or a repair would flip the
+  pin forever. An effect call is not memoised within a pass (`memoInvoker` coalesces `mcp.invoke`
+  only); memoising `ambient` effects is a possible follow-up. A persisted experience must cross
+  version boundaries only through the log: an older in-memory `executeProvider` / `seal` that
+  predates kinds would run a kinded step as an MCP call.
+- `ArgumentHookContext.kind` — the step's provider kind (absent for MCP): a hook keyed on `toolName`
+  must also read it, since MCP tool `x` and loom effect `x` are different targets.
+- An unregistered kind fails the WHOLE provider as `provider-kind-unregistered` before any step runs
+  (never a throw, no partial calls); served publicly as a fixed text naming neither kind nor target.
+
+A step's class identity is `toolKey(step)` (core): the bare `toolName` for MCP — every class
+recorded before kinds still applies — and `<kind>:<toolName>` otherwise, so `toolClasses` stickiness
+and `effectiveClasses` cover every kind and a loom effect never shares a class with a same-named MCP
+tool.
+
+### Split hydration — server half
+
+- `handleInventory(exp, opts: InventoryOptions): { inventory, findings }` — the client-safe
+  inventory: per bound handle, its priority, the overridable param names, and an opaque, keyed
+  revision.
+- `InventoryOptions` — `{ revisionOf: RevisionFn, viewer?, audience?, declaredToolClasses?, undeclared? }`.
+- `createServeSurface(policy?: ReadPolicy): ServeSurface` — `handleInventory` / `serveHandle` /
+  `serveHandles` with the read policy bound once (prefer it to the free functions); it also
+  exposes the merged `policy`.
+- `RevisionFn` — `(handle: string, fingerprint: string) => string`. MUST be a keyed hash (e.g. an
+  HMAC over a server secret) — never the provider's own content fingerprint, which a client could
+  confirm a guessed provider against offline; `handleInventory` throws if it returns a non-string,
+  an empty string, or a string containing the fingerprint.
+- `serveHandle(exp, request, opts: ServeOptions)`, `serveHandles(exp, requests, opts: ServeOptions)`
+  — answer one or many `HandleLoadRequest`s; every request is treated as untrusted and re-checked
+  server-side. `ServeOptions` extends `ExecuteOptions` (minus `params`/`kinds`) with `maxBatch?`
+  (default `DEFAULT_MAX_BATCH`, 256) and `maxConcurrentCalls?` (default
+  `DEFAULT_MAX_CONCURRENT_CALLS`, 32).
+- `publicFinding(handle, finding)` — the public form of a finding a client may see (fixed code,
+  handle name only — never a tool, argument, script or exception text).
+
+### Split hydration — client half (also on `@loomwork/ui-hydration/client`)
+
+- `SplitHydrationController` — same scheduling as `HydrationController`, over a `HandleInventory`,
+  loading through an injected `HandleLoader`. Methods: `load(inventory)`, `recompose(next)`,
+  `markVisible(handle)`, `setParams(params, scope?)`, `invalidate(handle?)`, `inFlight()`,
+  `dispose()`, plus `publishValue(handle, value, { state?, kind })` (`kind` is required here).
+- `HandleLoader` — the app's transport: `load(request, signal)` and `loadMany(requests, signal)`
+  (both required — loads the scheduler starts together go out as one `loadMany` round trip).
+- `HandleInventory`, `HandleRef`, `HandleLoadRequest`, `SplitControllerOptions` — the wire shapes.
+- `handleOfPath(path): string | undefined`, `HYDRATION_VALUES_PREFIX` — client entry only. Maps a
+  widget's binding path (`values.<handle>`) back to its hydration handle: the exact inverse of
+  `@loomwork/ui-core`'s `hydrationPath`. `undefined` unless the path is `values.` plus a non-empty
+  handle (the bare prefix, `status.<handle>` and near-misses like `valuesh` all give `undefined`);
+  everything after the first `values.` is the handle, spelled exactly as `hydrationPath` spelled
+  it (a handle containing `.` round-trips here but will not resolve at render time, because
+  binding paths are resolved by splitting on `.` — keep handles dot-free). The browser takes these
+  from here so the client entry never pulls core's runtime graph into a bundle. The prefix is
+  defined in both packages (core cannot import hydration); a type-level `satisfies` and a test pin
+  them equal.
+
+### Repair (app-side, durable)
+
+- `SCHEMA_REPAIRED`, `SchemaRepairedPayload` — the userspace event name and payload an app emits
+  after applying a repair, from inside a loom execution.
+- `remapOperation(spec, drift)` — turns an INPUT drift record into the `Operation` that repairs it
+  (refuses output/reshape drift with `repair-needs-planner` — that needs `@loomwork/ui-planner`'s
+  `reviseForDrift`).
+
+## Examples
+
+In-process hydration (illustrative — not a compiling snippet):
+
+```ts
+import { HydrationController, HydrationStore, SCHEMA_REPAIRED, remapOperation } from "@loomwork/ui-hydration";
+
+const store = new HydrationStore(projectionRuntime, {
+  experienceId: experience.experienceId,
+  principalId: viewer.id,
+});
+const controller = new HydrationController({
+  invoker: effectRuntime, // any EffectRuntime satisfies TransientInvoker
+  store,
+  principal: { id: viewer.id, chain: viewer.principalChain },
+  onDrift: (report) => durableRepair(report), // the app's own loom execution
+});
+controller.load(experience); // P0 now, P1 in ~50ms, P2 on markVisible
+```
+
+Split hydration, client side (illustrative):
+
+```ts
+import { HydrationStore, SplitHydrationController } from "@loomwork/ui-hydration/client";
+
+const split = new SplitHydrationController({
+  store,
+  loader: {
+    load: (request, signal) => postJson("/hydrate", request, signal),
+    loadMany: (requests, signal) => postJson("/hydrate/batch", requests, signal),
+  },
+});
+split.load(inventory); // fetched from the server's handleInventory(exp, { revisionOf })
+```
+
+## Notable behaviours and guarantees
+
+- **A handle that feeds a media widget is always contract-checked (U9).** When the controller is
+  given `outputKinds` and a handle's bound nodes resolve to `Image`/`Audio`/`Video`/`File`, the load
+  runs as `outputCheck: "contract"` whatever the provider declared: a shape pin passes any value of
+  the pinned shape (inline bytes or a locator included), and what is published reaches the store, a
+  seen log and a split-hydration payload. A value that is not a `MediaRef` is drift
+  (`output-contract-drift`), never published. A restricted media handle is never invoked, as for any
+  restricted handle. Kinds are resolved through the catalogue when `outputKinds` is given AND by
+  node type alone: a node whose `type` is a framework media kind marks its handle as media even with
+  NO `outputKinds`, so forgetting it fails closed (a `media-output-kinds-missing` warning says to
+  pass it). The split server (`serveHandle`/`serveHandles`) applies the same rule, including its
+  cache variant. Resolving a ref to a URL is NOT hydration's job: it is the host's `MediaResolver`,
+  called by the renderer (see `@loomwork/ui-core` "Media").
+
+- **A handle that feeds a chat transcript is always contract-checked, and never a stream (U8).**
+  Like media: a node of type `Chat` (or a kind that resolves to it) marks its handle, the provider
+  is checked against the `ChatValue` contract whatever `outputCheck` it declared (controller AND
+  split server), and a text chunk (`append`) cannot overwrite a transcript. A live reply therefore
+  rides the transcript VALUE (a `ChatFeed` republishes it), with `pending` status while it streams,
+  rather than `appendChunk` on a string handle; the bounds of `appendChunk` still apply inside the
+  feed.
+- **`connectConversation` (U8, `@loomwork/ui-hydration/client`)** is the browser's read half over loom's
+  conversation routes (`GET {base}/history`, `GET {base}/events`, ADR 0122 D6). The transport is
+  injected (`fetch`; `openStream(url)` so the host builds the `EventSource` with its credentials),
+  it imports no loom package, and it folds history pages and SSE frames into a `ChatFeed`,
+  publishing the result through `publish` (`SplitHydrationController.publishValue` can check only
+  that the handle is one the server LISTED; it cannot know the listed handle is a `Chat`, so the
+  `kind` it checks against is the page author's own claim). (`publishChat(controller, handle)`
+  writes the handle THROUGH the controller's gate: `publishValue` refuses a handle the experience
+  does not bind or the server did not list, a restricted one, one that is not a `Chat`, and a value
+  that fails the `ChatValue` contract; `pending` while a reply streams, `ready` once durable).
+  `start()` loads the newest page then opens the stream after its cursor; `loadOlder()` follows the
+  feed's cursor, one load at a time; **reasoning** (ADR 0133) rides the same connection: the
+  `reasoning` / `reasoning-partial` events go to the feed (which ignores them unless
+  `ChatFeed({ reasoning })`), and with `reasoning: true` here and a durable feed,
+  `loadReasoning(cursor)` fetches `GET {base}/reasoning?cursor=` for ONE reply, once, only when the host
+  calls it (route a Chat's `LOAD_REASONING` action to it, like `LOAD_OLDER`); a 404/403 is a settled
+  "none for you", a transport failure is a fixed finding and retryable, never the error text; a `reconnect` event reopens from the feed's resume cursor after
+  at least 250 ms (never 0), consecutive failures back off (the first wait is `reconnectMs`, 2 s,
+  then doubling to 30 s; a stream that stayed up 5 s or more starts the streak afresh), and a failed
+  first page is retried the same way instead of giving up. Failures are FIXED findings
+  (`history-unavailable`, `frame-invalid`, `frame-too-large`, `stream-error`, and
+  `reasoning-unavailable` for the reasoning fetch): no status code,
+  response body or exception text is carried, and an `error` event's body is not read. Sending is
+  NOT here: it is the host's authenticated write-back (`createWriteBack`, `@loomwork/ui-core` "Chat and
+  inputs").
+- **A host-declared tool class floors it too.** `declaredToolClasses` (on `HydrationController`,
+  `handleInventory` and `serveHandle(s)`; `@loomwork/ui-core`'s `DeclaredToolClasses`) makes a handle
+  whose provider calls a declared tool at least that class, even when no stored node carries one.
+  **Bind it once with `createServeSurface(policy)`**: it returns `handleInventory`, `serveHandle`
+  and `serveHandles` with a core `ReadPolicy` (`{ declaredToolClasses, undeclared }`) applied to
+  every call, so the inventory and the loader cannot disagree because one call forgot the table. A
+  per-call `declaredToolClasses` / `undeclared` only ADDS (`{}` or `undefined` cannot lower it). The
+  free `handleInventory` / `serveHandle(s)` take the table per call and are the low-level API.
+  `undeclared: "deny"` refuses every handle whose provider calls a tool the table does not list (no
+  table = an empty one: all tool-bound handles), for every viewer, until the tool is declared; a
+  per-call table cannot list a new tool once deny is bound. `HydrationController` takes the SAME
+  `readPolicy` (`new HydrationController({ readPolicy })`; the separate `declaredToolClasses` /
+  `undeclared` options join it raise-only), so a host passes ONE policy to the controller and to
+  `createServeSurface`.
+- **A classified handle is never fetched for a viewer who may not see it (fail-closed).** Pass
+  `viewer: { clearance }` (`@loomwork/ui-core`'s `Viewer`) to `HydrationController`, `handleInventory`
+  and `serveHandle`/`serveHandles`. A handle bound by any node whose `sensitivity` is above the
+  clearance is not planned, not cached and its provider is never invoked, and the controller writes
+  NOTHING to the store for it: no value and no status, so a store projected to a client does not
+  even name the handle (a stale entry is removed). The viewer is snapshotted at construction;
+  `setViewer` re-plans (drops now-restricted values, aborts their in-flight loads, loads newly
+  allowed ones). Token streams obey the same gate: `ctl.append(handle, chunk)` (and `store.append`
+  once a controller fronts the store) refuses a handle that is restricted for the viewer
+  (`restricted`), not bound (`stream-unbound`), or — with `outputKinds` — not a `StreamingText`
+  widget (`stream-kind-mismatch`); nothing is written. `handleInventory` omits it (the client learns
+  neither name nor revision); the server answers a client that names it anyway exactly as for a
+  handle the experience does not bind (`unknown-handle`, no existence oracle) and logs the full
+  `restricted` finding to `onFinding`. No viewer = no clearance, with one `viewer-not-supplied` warn
+  when anything is classified; unclassified handles are unaffected. Use the same viewer you pass to
+  `compile`, and one store per viewer.
+
+- **`empty` is an answer, not an error.** A step whose `{{steps.<id>.output.<path>}}` indexes past
+  the end of a real (but short) upstream array publishes `empty` — a warn (`upstream-empty`), no
+  value, never cached, never drift, never repaired. Every other miss (a bad key, `null` mid-path, a
+  step with no output) stays `unresolved-step-reference` → `error`.
+- **Relative time is read once per pass.** `$now`/`$now±<n><unit>` resolve against one clock read,
+  so two steps in the same load asking for "the last day" agree; anything else starting `$now` is
+  refused (`invalid-time-token`) before it reaches a tool.
+- **Calls are capped and de-duplicated.** `maxConcurrentCalls` bounds the whole controller (or one
+  server batch); beneath it, one step memo per pass runs an identical step once no matter how many
+  handles share it, ref-counted so one caller's abort never cancels another caller's still-pending
+  wait on the same call.
+- **A provider never reaches a browser.** Split hydration ships only the inventory
+  (`handleInventory`) and answers requests (`serveHandle`); a client only ever sees a finding's
+  PUBLIC form (fixed code + handle name) — the full finding (tool, step, script, exception text)
+  reaches only the server's own `onFinding` hook.
+- **Drift is reported, never repaired here.** `onDrift` fires with a `DriftReport`
+  (`{ experienceId, versionHash, handle, spec, drift: readonly DriftRecord[], findings, proceeded
+  }`) — one or more typed `DriftRecord`s for the handle, not a single record. Applying a fix
+  (`remapOperation` for input drift, `@loomwork/ui-planner`'s `reviseForDrift` for output drift) and
+  emitting `SCHEMA_REPAIRED` is the app's job, inside its own durable execution. Nothing in this
+  package dedupes or bounds repairs — an app must dedupe on `(versionHash, handle)` and cap
+  attempts itself.
+- **A `scriptError` payload is untrusted, unlogged text.** A reshaping script's own exception can
+  echo the raw output; loom-ui classifies drift by the failure's typed channel alone and never
+  copies that text into a finding message, handle status or drift record.
+- **Recompose keeps shared handles.** `controller.load(nextExperience)` (or
+  `SplitHydrationController.recompose`) aborts and drops handles the new artifact no longer binds
+  and keeps the ones still bound — no full re-hydrate on every revision.
+
+## See also
+
+- [../core/README.md](../core/README.md) — the Experience Model and `compile` this package
+  hydrates.
+- [../planner/README.md](../planner/README.md) — `reviseForDrift` repairs the output drift this
+  package reports.
+- [../renderer-lit/README.md](../renderer-lit/README.md) and
+  [../renderer-terminal/README.md](../renderer-terminal/README.md) — read the projection this
+  package publishes.
+- [../../docs/reference/hydration.md](../../docs/reference/hydration.md) — the full hydration
+  options reference and split-hydration wiring.
+- [../../README.md](../../README.md) — root overview.