@rindle/optimistic 0.1.0-rc.5

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,66 @@
+# @rindle/optimistic
+
+Optimistic writes over the local-first wasm engine (`OPTIMISTIC-WRITES-DESIGN.md`).
+
+The local IVM engine **is** the rebase function: the wasm `Db` keeps an authoritative
+`sync` fork per base table and reconciles every server batch by **rewinding** the live
+pipeline to the authoritative state and **re-invoking** the still-pending client
+mutators against it — no inverse mutations, no second materialization. This package is
+the client glue around that engine cycle:
+
+- **Named client mutators** (`ClientRegistry`): `(tx, args) => void` against a
+  `MutationTx` (`get`/`add`/`remove`/`edit`; reads see the current base + the
+  transaction's own writes). Deterministic and replayable — a mutator is re-invoked on
+  every rebase, so a read-dependent `incrementScore(+5)` computed on a stale `10`
+  correctly becomes `105` after the server lands `100`.
+- **cv-buffering** (§8.5): per-query data frames are `cv`-tagged and buffer; a
+  connection-level progress frame `{ cvMin, lmid, rejected }` releases everything
+  `cv ≤ cvMin` as one coherent step — no torn multi-query reads, ever. Buffer
+  overflow drops + re-hydrates (the one new client obligation).
+- **Pending stack** of `(mid, name, args)` — never effects; `lmid` confirms (drop),
+  `rejected` snaps back (the engine cycle removes the phantom effects).
+- **`ResultType`** per query (§6/§7): the **server channel's** state only — `unknown`
+  while not hydrated (the server hasn't answered yet), `complete` once it has. A pending
+  mutation no longer moves it; `error` is reserved and currently unproduced.
+- **Pending axis** (§7.2): "is an unconfirmed prediction touching this query?" is its own
+  reactive signal — `pending(qid)` / `onPending` / `pendingTables()` — so a "saving…"
+  indicator is separate from loading.
+- **Folded mutations** (FOLDED-MUTATIONS-DESIGN): `mutate.foo.folded({ key, debounceMs,
+  maxWaitMs }, args)` collapses a run of high-frequency same-key writes (a slider drag) into
+  **one** debounced, last-value-wins server write while the local view still updates on every
+  call. Folded mutators must be **absorbing** (last-writer-wins); a read-dependent one is
+  refused. `flushFolds()` (also auto-fired on `pagehide`/`beforeunload`) drains in-flight folds.
+
+```ts
+import { createOptimisticStore, type ClientRegistry } from "@rindle/optimistic";
+import { defineQuery, newQueryBuilder } from "@rindle/client";
+// `schema` is your @rindle/client schema; `source` is an `OptimisticSource`
+// (e.g. `createRemoteOptimisticSource` from @rindle/remote).
+
+const registry = {
+  createIssue: (tx, args: { id: number; title: string }) =>
+    tx.add("issue", [args.id, args.title]),
+} satisfies ClientRegistry;
+
+const q = newQueryBuilder(schema);
+const queries = {
+  allIssues: defineQuery("allIssues", () => q.issue.orderBy("id", "asc")),
+};
+
+const { store, backend, mutate } = createOptimisticStore(schema, source, registry, {
+  clientID: "client-1",
+});
+
+const view = store.materialize(queries.allIssues()); // named remote footprint + local view
+mutate.createIssue({ id: 7, title: "instant" }); // applies NOW; reconciles when confirmed
+backend.resultType(/* queryId */ 1); // "unknown" (loading) → "complete"
+backend.pending(/* queryId */ 1);    // is an optimistic write pending on this query?
+```
+
+A `Store` over an `OptimisticBackend` is an ordinary `@rindle/client` store — the
+`Backend` seam holds. Unstamped `store.query...materialize()` calls are local-only; use
+`defineQuery` + `store.materialize(query)` for remote sync. The `OptimisticSource` (the server side: cv-tagged normalized
+frames + progress frames + the mutation upstream) is pluggable; the ws transport wiring
+is the follow-up slice. The engine-side cycle and the server protocol are proven in
+Rust (`src/optimistic.rs`, `rindle-replica`'s mutation/envelope suites); this package's
+tests pin the TS wiring against a scripted source.

package/dist/agg-overlay.d.ts

@@ -0,0 +1,86 @@
+import type { Ast, Condition, WireValue } from "@rindle/client";
+/** One aggregate's definition, derived from the original AST — everything needed to compute a
+ *  per-group delta from the child table's pending mutations. */
+export interface AggDef {
+    /** The synthetic table name (`__agg_*`) the delta is applied to. */
+    aggTable: string;
+    /** The child table whose mutations drive the count (e.g. `"comment"`). */
+    childTable: string;
+    /** The child column names (schema order) — resolves the group key + filter columns. */
+    childColumns: string[];
+    /** Indices into a positional child row of the correlation child fields = the group key. */
+    groupKeyCols: number[];
+    /** The child `where`, if any (already baked into the server count; re-evaluated locally
+     *  to decide a pending child's membership). */
+    where?: Condition;
+    /** §6.2: whether the optimistic delta is computable — the `where` references only the
+     *  child's own columns + literals over scalar ops. Unevaluable ⇒ no delta (server value). */
+    evaluable: boolean;
+}
+/** Collect every aggregate's `AggDef` from `ast` (recursively — a nested aggregate under a
+ *  materialized relationship included), resolving child columns via `getColumns(table)`. The
+ *  twin of `aggTableSchemas` (`@rindle/normalized`) but carrying the delta-computation fields. */
+export declare function collectAggDefs(ast: Ast, getColumns: (table: string) => string[] | undefined): AggDef[];
+/** §6.2 static gate: a condition is locally evaluable iff every leaf compares the child's own
+ *  columns / literals with a scalar op. A `correlatedSubquery` (a join the client may not hold)
+ *  or a column outside the child schema makes the whole aggregate unevaluable. */
+export declare function isEvaluable(cond: Condition, childColumns: string[]): boolean;
+/** Evaluate an EVALUABLE condition against a positional child row (SQL-ish three-valued logic
+ *  collapsed to a boolean — an unknown comparison is `false`, i.e. the row is not a member).
+ *  Only the grammar `isEvaluable` admits reaches here. */
+export declare function evalCondition(cond: Condition, row: WireValue[], childColumns: string[]): boolean;
+/** One observed child-table op (the wire shape the collector feeds the overlay). */
+export interface ChildOp {
+    table: string;
+    kind: "add" | "remove" | "edit";
+    row: WireValue[];
+    /** The pre-image (edit only). */
+    old?: WireValue[];
+}
+/** One group's accumulated optimistic delta. */
+export interface DeltaEntry {
+    aggTable: string;
+    def: AggDef;
+    /** The group-key cells (PK of the synthetic row). */
+    cells: WireValue[];
+    /** The net optimistic count delta for this group over the pending child mutations. */
+    n: number;
+}
+/** The stateful accumulator: holds the aggregate definitions and the per-group pending delta.
+ *  Engine-agnostic — the backend feeds it observed child ops and reads back the entries to
+ *  reconcile against the `__agg` head rows. */
+export declare class AggOverlay {
+    /** By synthetic table name. Sharing a definition across queries is automatic (idempotent
+     *  {@link register}); the backend refcounts readers and calls {@link unregister} when the
+     *  last query over an aggregate is gone, so a definition is reclaimed with its table — not
+     *  kept for the backend's life. */
+    private readonly defs;
+    /** Child table → the defs it feeds, for O(1) dispatch in `observe`. */
+    private readonly byChild;
+    /** `aggTable\0JSON(groupCells)` → the group's accumulated delta. */
+    private readonly delta;
+    /** Register aggregate definitions (idempotent per synthetic table name). */
+    register(defs: AggDef[]): void;
+    /** Forget an aggregate definition (its synthetic table is being removed because the last
+     *  query reading it was unregistered — `AGGREGATE-SYNC-DESIGN.md` §4). Drops the def, its
+     *  child-dispatch entry, and any accumulated delta for it. The inverse of the per-table half
+     *  of {@link register}; a no-op for an unknown table. */
+    unregister(aggTable: string): void;
+    /** Does any aggregate count rows of `table`? (cheap collector guard) */
+    hasChild(table: string): boolean;
+    /** Any aggregate definitions at all? */
+    get hasDefs(): boolean;
+    /** Drop all accumulated deltas — called at the start of a reconcile cycle rebuild, where the
+     *  delta is recomputed from scratch off the (confirm-filtered) pending set. */
+    reset(): void;
+    /** Fold one observed child op into the per-group delta, for every EVALUABLE aggregate over
+     *  that child table. (Unevaluable defs contribute nothing — §6.2 server-value fallback.) */
+    observe(op: ChildOp): void;
+    private bump;
+    /** The current non-trivial deltas to reconcile against the `__agg` head rows. */
+    entries(): DeltaEntry[];
+    /** Forget groups whose delta has returned to 0 (their head row was reverted to the server
+     *  value by the reconcile that observed the 0) — keeps the map bounded between releases. */
+    pruneZeros(): void;
+}
+//# sourceMappingURL=agg-overlay.d.ts.map

package/dist/agg-overlay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agg-overlay.d.ts","sourceRoot":"","sources":["../src/agg-overlay.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAiB,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAS/E;gEACgE;AAChE,MAAM,WAAW,MAAM;IACrB,oEAAoE;IACpE,QAAQ,EAAE,MAAM,CAAC;IACjB,0EAA0E;IAC1E,UAAU,EAAE,MAAM,CAAC;IACnB,uFAAuF;IACvF,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,2FAA2F;IAC3F,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;mDAC+C;IAC/C,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB;iGAC6F;IAC7F,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;kGAEkG;AAClG,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,EAAE,GAAG,SAAS,GAAG,MAAM,EAAE,CAuBtG;AAED;;kFAEkF;AAClF,wBAAgB,WAAW,CAAC,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,OAAO,CAU5E;AAMD;;0DAE0D;AAC1D,wBAAgB,aAAa,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,OAAO,CAWhG;AAyCD,oFAAoF;AACpF,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IAChC,GAAG,EAAE,SAAS,EAAE,CAAC;IACjB,iCAAiC;IACjC,GAAG,CAAC,EAAE,SAAS,EAAE,CAAC;CACnB;AAED,gDAAgD;AAChD,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,qDAAqD;IACrD,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,sFAAsF;IACtF,CAAC,EAAE,MAAM,CAAC;CACX;AAED;;+CAE+C;AAC/C,qBAAa,UAAU;IACrB;;;uCAGmC;IACnC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA6B;IAClD,uEAAuE;IACvE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA+B;IACvD,oEAAoE;IACpE,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAiC;IAEvD,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;IAU9B;;;6DAGyD;IACzD,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAWlC,wEAAwE;IACxE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAIhC,wCAAwC;IACxC,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;mFAC+E;IAC/E,KAAK,IAAI,IAAI;IAIb;gGAC4F;IAC5F,OAAO,CAAC,EAAE,EAAE,OAAO,GAAG,IAAI;IAc1B,OAAO,CAAC,IAAI;IASZ,iFAAiF;IACjF,OAAO,IAAI,UAAU,EAAE;IAIvB;gGAC4F;IAC5F,UAAU,IAAI,IAAI;CAGnB"}

package/dist/agg-overlay.js

@@ -0,0 +1,224 @@
+// The optimistic aggregate overlay (AGGREGATE-SYNC-DESIGN.md §4–§6) — the pure half of
+// "displayed = server_base ⊕ watermark-gated local_pending_delta".
+//
+// The DISPLAY path (§3) makes a relationship `count(comments)` read a server-authoritative
+// synthetic base table `__agg_*` (the reduce's `(group_key, count)` output) via a plain
+// projected join. This module computes the CLIENT's own pending delta on top: a mini
+// invertible counter over only the pending child mutations, correlated by the same group key
+// (`+1` per pending child add, `−1` per remove, net per edit). The backend applies the delta
+// as an optimistic add/edit/remove to the `__agg` head row, so the displayed scalar updates
+// through the same join + projection with no special path.
+//
+// Two things are pure and live here: the per-aggregate DEFINITIONS derived from the AST
+// (`AggDef`, incl. the §6.2 static `evaluable` gate), and the accumulator (`AggOverlay`) that
+// folds observed child ops into a per-group delta. The engine-touching reconcile (reading
+// `server_base`, writing the `__agg` head row) stays in `backend.ts`.
+import { aggTableName } from "@rindle/normalized";
+/** The scalar comparison ops the v1 predicate evaluator (and the `evaluable` gate) cover.
+ *  `LIKE`/`ILIKE`/`IN` are deliberately EXCLUDED — a filter using them is `evaluable: false`
+ *  and falls back to the bare server value (avoids the LIKE-escape parity rabbit hole; always
+ *  correct, just not optimistic for that aggregate). */
+const SCALAR_OPS = new Set(["=", "!=", "<", "<=", ">", ">=", "IS", "IS NOT"]);
+/** Collect every aggregate's `AggDef` from `ast` (recursively — a nested aggregate under a
+ *  materialized relationship included), resolving child columns via `getColumns(table)`. The
+ *  twin of `aggTableSchemas` (`@rindle/normalized`) but carrying the delta-computation fields. */
+export function collectAggDefs(ast, getColumns) {
+    const out = [];
+    for (const r of ast.related ?? []) {
+        if (r.subquery.aggregate) {
+            const childTable = r.subquery.table;
+            const childColumns = getColumns(childTable);
+            if (!childColumns)
+                continue; // child table not in the client schema — cannot key locally
+            const groupKeyCols = r.correlation.childField.map((n) => childColumns.indexOf(n));
+            if (groupKeyCols.some((i) => i < 0))
+                continue; // a correlation field not in the schema
+            const where = r.subquery.where;
+            out.push({
+                aggTable: aggTableName(r),
+                childTable,
+                childColumns,
+                groupKeyCols,
+                where,
+                evaluable: where === undefined || isEvaluable(where, childColumns),
+            });
+        }
+        else {
+            out.push(...collectAggDefs(r.subquery, getColumns));
+        }
+    }
+    return out;
+}
+/** §6.2 static gate: a condition is locally evaluable iff every leaf compares the child's own
+ *  columns / literals with a scalar op. A `correlatedSubquery` (a join the client may not hold)
+ *  or a column outside the child schema makes the whole aggregate unevaluable. */
+export function isEvaluable(cond, childColumns) {
+    switch (cond.type) {
+        case "simple":
+            return SCALAR_OPS.has(cond.op) && pos(cond.left, childColumns) && pos(cond.right, childColumns);
+        case "and":
+        case "or":
+            return cond.conditions.every((c) => isEvaluable(c, childColumns));
+        case "correlatedSubquery":
+            return false; // reaches into a join the client may not have
+    }
+}
+function pos(vp, childColumns) {
+    return vp.type === "literal" || childColumns.includes(vp.name);
+}
+/** Evaluate an EVALUABLE condition against a positional child row (SQL-ish three-valued logic
+ *  collapsed to a boolean — an unknown comparison is `false`, i.e. the row is not a member).
+ *  Only the grammar `isEvaluable` admits reaches here. */
+export function evalCondition(cond, row, childColumns) {
+    switch (cond.type) {
+        case "simple":
+            return evalSimple(cond.op, value(cond.left, row, childColumns), value(cond.right, row, childColumns));
+        case "and":
+            return cond.conditions.every((c) => evalCondition(c, row, childColumns));
+        case "or":
+            return cond.conditions.some((c) => evalCondition(c, row, childColumns));
+        case "correlatedSubquery":
+            return false; // never evaluable — defensive
+    }
+}
+function value(vp, row, childColumns) {
+    return vp.type === "literal" ? vp.value : row[childColumns.indexOf(vp.name)];
+}
+function evalSimple(op, l, r) {
+    switch (op) {
+        case "IS":
+            return nullSafeEq(l, r); // null-safe: NULL IS NULL → true
+        case "IS NOT":
+            return !nullSafeEq(l, r);
+        case "=":
+            return l == null || r == null ? false : nullSafeEq(l, r);
+        case "!=":
+            return l == null || r == null ? false : !nullSafeEq(l, r);
+        case "<":
+            return less(l, r);
+        case "<=":
+            return less(l, r) || nullSafeEq(l, r);
+        case ">":
+            return less(r, l);
+        case ">=":
+            return less(r, l) || nullSafeEq(l, r);
+        default:
+            return false;
+    }
+}
+function nullSafeEq(l, r) {
+    return l === r; // scalar cells: number/string/boolean/null compare by identity
+}
+function less(l, r) {
+    if (l == null || r == null)
+        return false; // ordered comparison with NULL → unknown → false
+    if (typeof l === "number" && typeof r === "number")
+        return l < r;
+    if (typeof l === "string" && typeof r === "string")
+        return l < r;
+    if (typeof l === "boolean" && typeof r === "boolean")
+        return Number(l) < Number(r);
+    return false; // mixed types: not a member (matches no row optimistically; self-corrects)
+}
+/** The stateful accumulator: holds the aggregate definitions and the per-group pending delta.
+ *  Engine-agnostic — the backend feeds it observed child ops and reads back the entries to
+ *  reconcile against the `__agg` head rows. */
+export class AggOverlay {
+    /** By synthetic table name. Sharing a definition across queries is automatic (idempotent
+     *  {@link register}); the backend refcounts readers and calls {@link unregister} when the
+     *  last query over an aggregate is gone, so a definition is reclaimed with its table — not
+     *  kept for the backend's life. */
+    defs = new Map();
+    /** Child table → the defs it feeds, for O(1) dispatch in `observe`. */
+    byChild = new Map();
+    /** `aggTable\0JSON(groupCells)` → the group's accumulated delta. */
+    delta = new Map();
+    /** Register aggregate definitions (idempotent per synthetic table name). */
+    register(defs) {
+        for (const d of defs) {
+            if (this.defs.has(d.aggTable))
+                continue;
+            this.defs.set(d.aggTable, d);
+            const list = this.byChild.get(d.childTable);
+            if (list)
+                list.push(d);
+            else
+                this.byChild.set(d.childTable, [d]);
+        }
+    }
+    /** Forget an aggregate definition (its synthetic table is being removed because the last
+     *  query reading it was unregistered — `AGGREGATE-SYNC-DESIGN.md` §4). Drops the def, its
+     *  child-dispatch entry, and any accumulated delta for it. The inverse of the per-table half
+     *  of {@link register}; a no-op for an unknown table. */
+    unregister(aggTable) {
+        const d = this.defs.get(aggTable);
+        if (!d)
+            return;
+        this.defs.delete(aggTable);
+        const rest = (this.byChild.get(d.childTable) ?? []).filter((x) => x.aggTable !== aggTable);
+        if (rest.length)
+            this.byChild.set(d.childTable, rest);
+        else
+            this.byChild.delete(d.childTable);
+        // Drop this table's accumulated groups (match on the stored aggTable — separator-agnostic).
+        for (const [k, e] of this.delta)
+            if (e.aggTable === aggTable)
+                this.delta.delete(k);
+    }
+    /** Does any aggregate count rows of `table`? (cheap collector guard) */
+    hasChild(table) {
+        return this.byChild.has(table);
+    }
+    /** Any aggregate definitions at all? */
+    get hasDefs() {
+        return this.defs.size > 0;
+    }
+    /** Drop all accumulated deltas — called at the start of a reconcile cycle rebuild, where the
+     *  delta is recomputed from scratch off the (confirm-filtered) pending set. */
+    reset() {
+        this.delta.clear();
+    }
+    /** Fold one observed child op into the per-group delta, for every EVALUABLE aggregate over
+     *  that child table. (Unevaluable defs contribute nothing — §6.2 server-value fallback.) */
+    observe(op) {
+        const defs = this.byChild.get(op.table);
+        if (!defs)
+            return;
+        for (const d of defs) {
+            if (!d.evaluable)
+                continue;
+            if (op.kind === "add")
+                this.bump(d, op.row, 1);
+            else if (op.kind === "remove")
+                this.bump(d, op.row, -1);
+            else {
+                if (op.old)
+                    this.bump(d, op.old, -1);
+                this.bump(d, op.row, 1);
+            }
+        }
+    }
+    bump(d, childRow, sign) {
+        if (d.where && !evalCondition(d.where, childRow, d.childColumns))
+            return; // not a member
+        const cells = d.groupKeyCols.map((i) => childRow[i]);
+        const key = `${d.aggTable}|${JSON.stringify(cells)}`;
+        const e = this.delta.get(key);
+        if (e)
+            e.n += sign;
+        else
+            this.delta.set(key, { aggTable: d.aggTable, def: d, cells, n: sign });
+    }
+    /** The current non-trivial deltas to reconcile against the `__agg` head rows. */
+    entries() {
+        return [...this.delta.values()];
+    }
+    /** Forget groups whose delta has returned to 0 (their head row was reverted to the server
+     *  value by the reconcile that observed the 0) — keeps the map bounded between releases. */
+    pruneZeros() {
+        for (const [k, e] of this.delta)
+            if (e.n === 0)
+                this.delta.delete(k);
+    }
+}
+//# sourceMappingURL=agg-overlay.js.map

package/dist/agg-overlay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agg-overlay.js","sourceRoot":"","sources":["../src/agg-overlay.ts"],"names":[],"mappings":"AAAA,uFAAuF;AACvF,mEAAmE;AACnE,EAAE;AACF,2FAA2F;AAC3F,wFAAwF;AACxF,qFAAqF;AACrF,6FAA6F;AAC7F,6FAA6F;AAC7F,4FAA4F;AAC5F,2DAA2D;AAC3D,EAAE;AACF,wFAAwF;AACxF,8FAA8F;AAC9F,0FAA0F;AAC1F,sEAAsE;AAGtE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;;wDAGwD;AACxD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;AAqB9E;;kGAEkG;AAClG,MAAM,UAAU,cAAc,CAAC,GAAQ,EAAE,UAAmD;IAC1F,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;QAClC,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;YACzB,MAAM,UAAU,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;YACpC,MAAM,YAAY,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;YAC5C,IAAI,CAAC,YAAY;gBAAE,SAAS,CAAC,4DAA4D;YACzF,MAAM,YAAY,GAAG,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAClF,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;gBAAE,SAAS,CAAC,wCAAwC;YACvF,MAAM,KAAK,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;YAC/B,GAAG,CAAC,IAAI,CAAC;gBACP,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC;gBACzB,UAAU;gBACV,YAAY;gBACZ,YAAY;gBACZ,KAAK;gBACL,SAAS,EAAE,KAAK,KAAK,SAAS,IAAI,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC;aACnE,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;kFAEkF;AAClF,MAAM,UAAU,WAAW,CAAC,IAAe,EAAE,YAAsB;IACjE,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ;YACX,OAAO,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAClG,KAAK,KAAK,CAAC;QACX,KAAK,IAAI;YACP,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;QACpE,KAAK,oBAAoB;YACvB,OAAO,KAAK,CAAC,CAAC,8CAA8C;IAChE,CAAC;AACH,CAAC;AAED,SAAS,GAAG,CAAC,EAAiB,EAAE,YAAsB;IACpD,OAAO,EAAE,CAAC,IAAI,KAAK,SAAS,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;AACjE,CAAC;AAED;;0DAE0D;AAC1D,MAAM,UAAU,aAAa,CAAC,IAAe,EAAE,GAAgB,EAAE,YAAsB;IACrF,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ;YACX,OAAO,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,YAAY,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC;QACxG,KAAK,KAAK;YACR,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC;QAC3E,KAAK,IAAI;YACP,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC;QAC1E,KAAK,oBAAoB;YACvB,OAAO,KAAK,CAAC,CAAC,8BAA8B;IAChD,CAAC;AACH,CAAC;AAED,SAAS,KAAK,CAAC,EAAiB,EAAE,GAAgB,EAAE,YAAsB;IACxE,OAAO,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAE,EAAE,CAAC,KAAmB,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9F,CAAC;AAED,SAAS,UAAU,CAAC,EAAU,EAAE,CAAY,EAAE,CAAY;IACxD,QAAQ,EAAE,EAAE,CAAC;QACX,KAAK,IAAI;YACP,OAAO,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,iCAAiC;QAC5D,KAAK,QAAQ;YACX,OAAO,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3B,KAAK,GAAG;YACN,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3D,KAAK,IAAI;YACP,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5D,KAAK,GAAG;YACN,OAAO,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACpB,KAAK,IAAI;YACP,OAAO,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACxC,KAAK,GAAG;YACN,OAAO,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACpB,KAAK,IAAI;YACP,OAAO,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACxC;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,CAAY,EAAE,CAAY;IAC5C,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,+DAA+D;AACjF,CAAC;AAED,SAAS,IAAI,CAAC,CAAY,EAAE,CAAY;IACtC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC,CAAC,iDAAiD;IAC3F,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ;QAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACjE,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ;QAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACjE,IAAI,OAAO,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACnF,OAAO,KAAK,CAAC,CAAC,2EAA2E;AAC3F,CAAC;AAqBD;;+CAE+C;AAC/C,MAAM,OAAO,UAAU;IACrB;;;uCAGmC;IAClB,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IAClD,uEAAuE;IACtD,OAAO,GAAG,IAAI,GAAG,EAAoB,CAAC;IACvD,oEAAoE;IACnD,KAAK,GAAG,IAAI,GAAG,EAAsB,CAAC;IAEvD,4EAA4E;IAC5E,QAAQ,CAAC,IAAc;QACrB,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACrB,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAAE,SAAS;YACxC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;YAC5C,IAAI,IAAI;gBAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;;gBAClB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;IAED;;;6DAGyD;IACzD,UAAU,CAAC,QAAgB;QACzB,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,CAAC,CAAC;YAAE,OAAO;QACf,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC3B,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;QAC3F,IAAI,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;;YACjD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QACvC,4FAA4F;QAC5F,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ;gBAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACrF,CAAC;IAED,wEAAwE;IACxE,QAAQ,CAAC,KAAa;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,wCAAwC;IACxC,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED;mFAC+E;IAC/E,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED;gGAC4F;IAC5F,OAAO,CAAC,EAAW;QACjB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI;YAAE,OAAO;QAClB,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACrB,IAAI,CAAC,CAAC,CAAC,SAAS;gBAAE,SAAS;YAC3B,IAAI,EAAE,CAAC,IAAI,KAAK,KAAK;gBAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;iBAC1C,IAAI,EAAE,CAAC,IAAI,KAAK,QAAQ;gBAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;iBACnD,CAAC;gBACJ,IAAI,EAAE,CAAC,GAAG;oBAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;gBACrC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;IACH,CAAC;IAEO,IAAI,CAAC,CAAS,EAAE,QAAqB,EAAE,IAAY;QACzD,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC,YAAY,CAAC;YAAE,OAAO,CAAC,eAAe;QACzF,MAAM,KAAK,GAAG,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QACrD,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACrD,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,CAAC;YAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;;YACd,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED,iFAAiF;IACjF,OAAO;QACL,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IAClC,CAAC;IAED;gGAC4F;IAC5F,UAAU;QACR,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;gBAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACvE,CAAC;CACF"}