okmodel 0.6.0 → 0.7.0

package/dist/runtime/validate/index.js

@@ -3,10 +3,10 @@ import {
 } from "../../shared/ze4hxsmy.js";
 import {
   addSchemaHook
-} from "../../shared/hazqqecq.js";
+} from "../../shared/xnxsed62.js";
 import {
   queryHandle
-} from "../../shared/j60w0dvr.js";
+} from "../../shared/tbrvgw6z.js";
 import {
   OkmError2
 } from "../../shared/52szzakm.js";

package/dist/runtime/version.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Optimistic version checks.
+ *
+ * Loaded on the first update of a `versioned()` table. A plain update does
+ * not import it. The check and the bump are one statement: a stale row is
+ * not written, and the caller hears category `conflict`.
+ */
+import type { Statement } from "../contracts/driver.js";
+import type { QuerySchema } from "../dialects/pg/model.js";
+import { type Outputs } from "./plan.js";
+import { type Indexed } from "./plan.js";
+import { type WriteMods } from "./write.js";
+/** What {@link planVersioned} hands back to the write path. */
+export type VersionPlan = {
+    readonly statements: readonly Statement[];
+    readonly outputs: Outputs;
+    readonly shape: "count" | "rows";
+    readonly expect: number | undefined;
+    /** Fields the caller tried to write, and the versions they sent. */
+    readonly versioned: {
+        readonly fields: readonly string[];
+        readonly sent: readonly number[];
+    };
+};
+/**
+ * Plans an update that checks `version` and bumps it.
+ *
+ * A list carries one version per row. `lock: "skip"` claims rows at that
+ * version and leaves locked rows. `.all()` is refused. An upsert is refused
+ * by the insert planner, not here.
+ *
+ * @param schema - Connected schema
+ * @param table - Target table
+ * @param input - `{ where, set, version }` or a per-row list
+ * @param options - Returning, expect, signal, timeout
+ * @param mods - `.expect`. `.all` is refused
+ * @returns One statement, and the versions the caller sent
+ */
+export declare function planVersioned(schema: QuerySchema, table: Indexed, input: unknown, options: Record<string, unknown>, mods: WriteMods): VersionPlan;

package/dist/runtime/window.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Window helpers in `select` (spec §10, §13 tool 12).
+ *
+ * Loaded on the first `find` or `one` whose `select` contains a helper.
+ * A plain list of field names never loads this module. `page` does not take
+ * a window: its select is field names, and the keyset cursor has no window
+ * value to encode.
+ */
+import type { QuerySchema } from "../dialects/pg/model.js";
+import { type ReadCall } from "./plan.js";
+/**
+ * Plans a read whose `select` contains a window helper.
+ *
+ * The returned call writes the statement. Includes, tenancy, and presets stay
+ * on the planner the plain read uses.
+ *
+ * @param schema - Connected schema
+ * @param call - The read, with a window in `select`
+ * @returns The same read, with its statement builder set
+ */
+export declare function attach(schema: QuerySchema, call: ReadCall): ReadCall;

package/dist/runtime/write.d.ts

@@ -6,9 +6,9 @@
  */
 import type { ExecuteOptions, ExecuteResult, Statement } from "../contracts/driver.js";
 import type { IdGenerators } from "../contracts/generator.js";
-import type { PresetUse } from "../dialects/pg/model.js";
+import type { ColumnModel, PresetUse } from "../dialects/pg/model.js";
 import type { QuerySchema } from "../dialects/pg/model.js";
-import { type ArchiveView, type CallScope } from "./plan.js";
+import { type ArchiveView, type CallScope, type Indexed, type Sink } from "./plan.js";
 import { type RunHost } from "./tx.js";
 /** Statements in one insert stay under this many parameters. The protocol limit is 65535. */
 export declare const WRITE_PARAM_BUDGET = 2048;
@@ -41,6 +41,13 @@ export type PreparedWrite = {
     /** Set when `finish` can refuse a statement that already ran. `batch` refuses such a write (D183). */
     readonly checked?: "restore" | "expect" | "parent";
     finish(results: readonly ExecuteResult[]): unknown;
+    /**
+     * More statements once the planned ones have run.
+     *
+     * First-or-create uses this when the insert returned fewer rows than it was
+     * given. Empty means the insert already returned every row.
+     */
+    follow?(results: readonly ExecuteResult[]): readonly Statement[];
 };
 /**
  * Runs a write and decodes it.
@@ -71,3 +78,48 @@ export declare function executeWrite(host: WriteHost, op: WriteOp, table: string
 export declare function explainWrite(schema: QuerySchema, op: WriteOp, table: string, input: unknown, options: object, mods: WriteMods, generators?: IdGenerators, scope?: CallScope): Promise<{
     readonly statements: readonly Statement[];
 }>;
+export declare function updateSliceBody(schema: QuerySchema, table: Indexed, rows: readonly {
+    readonly where: unknown;
+    readonly set: Record<string, unknown>;
+}[], sql: Sql, wrapWhere?: boolean, hooks?: {
+    afterWhere?(sql: Sql, index: number): void;
+    afterSet?(sql: Sql): void;
+}): void;
+export declare function rejectDuplicateTargets(table: Indexed, rows: readonly {
+    readonly where: unknown;
+}[]): void;
+export declare function emitSet(sql: Sql, table: Indexed, set: Record<string, unknown>, alias: string): void;
+export declare class Sql {
+    private readonly parts;
+    private readonly params;
+    text(value: string): void;
+    /**
+     * Binds one parameter.
+     *
+     * An empty data type leaves the parameter uncast so `where` can infer it.
+     */
+    param(wire: string | null, dataType: string): void;
+    sink(): Sink;
+    statement(): Statement;
+}
+export declare function writeSet(table: Indexed, value: unknown, allow: ReadonlySet<string>, tenancy: QuerySchema["tenancy"]): Record<string, unknown>;
+/**
+ * A list that sets one field with an operator in one row and a plain value,
+ * or a different operator, in another.
+ */
+export declare function rejectMixedSets(rows: readonly {
+    readonly set: Record<string, unknown>;
+}[]): void;
+/**
+ * `lock: "skip"` with `limit` on one update. Absent when the caller named neither.
+ *
+ * @param input - The update target
+ * @returns The row cap, or `undefined` when this update does not claim
+ */
+export declare function readClaim(input: Record<string, unknown>): number | undefined;
+export declare function rejectUpdateKeys(input: Record<string, unknown>, row: boolean): void;
+export declare function requireFilter(table: Indexed, where: unknown, mods: WriteMods, op: WriteOp): void;
+export declare function returningOption(table: Indexed, value: unknown): readonly ColumnModel[] | undefined;
+export declare function expectOf(options: Record<string, unknown>, mods: WriteMods): number | undefined;
+export declare function allowSet(table: Indexed, value: unknown): ReadonlySet<string>;
+export declare function noteGuarded(table: Indexed, allow: ReadonlySet<string>, op: "insert" | "update"): void;

package/dist/shared/{wkme6tep.js → 14vx95q4.js}

@@ -6,7 +6,7 @@ import {
   runCall,
   EMPTY_NOTICES,
   resultFrom
-} from "./cgbamx3e.js";
+} from "./kb2sdhfb.js";
 
 // src/adapters/pg/postgresjs.ts
 import net from "node:net";
@@ -117,26 +117,18 @@ function open2(config) {
     execute(text, params, options) {
       return sockets.occupy(() => runCall(closed, options, (watch) => root.query(text, params, watch)));
     },
-    async batch(statements, options) {
-      return sockets.occupy(async () => {
-        const { checkout } = await import("./r1fdd0f6.js");
-        const connection = await checkout(held);
-        try {
-          return await connection.batch(statements, options);
-        } finally {
-          await connection.release();
-        }
-      });
+    batch(statements, options) {
+      return sockets.occupy(() => import("./je4axnm8.js").then((mod) => mod.runBatch(held, statements, options)));
     },
     reserve() {
       const gate = sockets.busyGate();
       gate.enter();
-      return import("./r1fdd0f6.js").then((mod) => mod.holdCheckout(gate, () => mod.checkout(held)), (error) => {
+      return import("./je4axnm8.js").then((mod) => mod.holdCheckout(gate, () => mod.checkout(held)), (error) => {
         gate.leave();
         throw error;
       });
     },
-    describe: (text, params) => sockets.occupy(() => import("./r1fdd0f6.js").then((mod) => mod.describe(sql, text, params))),
+    describe: (text, params) => sockets.occupy(() => import("./je4axnm8.js").then((mod) => mod.describe(sql, text, params))),
     stream(text, params) {
       const gate = sockets.busyGate();
       return async function* () {
@@ -151,7 +143,7 @@ function open2(config) {
     listen(channel, onNotify) {
       const gate = sockets.listenerGate();
       gate.enter();
-      return import("./r1fdd0f6.js").then((mod) => mod.holdListener(gate, async () => {
+      return import("./je4axnm8.js").then((mod) => mod.holdListener(gate, async () => {
         const listening = await sql.listen(channel, onNotify);
         return async () => {
           await listening.unlisten();
@@ -221,7 +213,7 @@ class PgSession {
       onAbort();
     else
       watch.signal.addEventListener("abort", onAbort, { once: true });
-    return import("./r1fdd0f6.js").then((mod) => mod.watchQuery(pending, watch, onAbort, {
+    return import("./je4axnm8.js").then((mod) => mod.watchQuery(pending, watch, onAbort, {
       start,
       text,
       notices: this.notices,
@@ -273,7 +265,7 @@ class PgSession {
   }
 }
 async function* loadStream(sql, text, params) {
-  const { stream } = await import("./r1fdd0f6.js");
+  const { stream } = await import("./je4axnm8.js");
   yield* stream(sql, text, params);
 }
 function send(sql, text, params, named) {

package/dist/shared/1est4ezg.js

@@ -0,0 +1,313 @@
+import {
+  queryHandle,
+  readHandle,
+  readCall,
+  attachHttp
+} from "./tbrvgw6z.js";
+import {
+  emitWhere,
+  emitOrder,
+  refuseHidden,
+  rejectKeys,
+  readLimit,
+  projectExpr,
+  cell,
+  indexes,
+  quote,
+  list,
+  isRecord,
+  fail2
+} from "./67txcrcw.js";
+import {
+  OkmError2,
+  throwNamed2
+} from "./52szzakm.js";
+
+// src/runtime/aggregate.ts
+var BUCKET = Symbol.for("okmodel.bucket");
+var bucketChunk;
+function loadBucketGroup() {
+  return bucketChunk ??= import("./3v7t1yrv.js");
+}
+var OPTIONS = [
+  "where",
+  "groupBy",
+  "count",
+  "sum",
+  "avg",
+  "min",
+  "max",
+  "orderBy",
+  "limit",
+  "route",
+  "signal",
+  "timeout"
+];
+var NUMERIC = /^(smallint|integer|bigint|real|double precision|numeric|decimal)\b/;
+var AS_NUMBER = (wire) => Number(wire);
+var AS_TEXT = (wire) => wire;
+var UNORDERED = /^(json|jsonb|bytea|point|line|tsvector)\b|\[\]$/;
+var FUNCTIONS = [
+  { option: "sum", tag: "s", numeric: true },
+  { option: "avg", tag: "a", numeric: true },
+  { option: "min", tag: "n", numeric: false },
+  { option: "max", tag: "x", numeric: false }
+];
+function build(session, table, options, mods, view) {
+  try {
+    if (seesBucket(options))
+      return bucketHandle(session, table, options, mods, view);
+    return plan(session, table, options, mods, view);
+  } catch (error) {
+    throw error instanceof OkmError2 ? attachHttp(session.http, error) : error;
+  }
+}
+function bucketHandle(session, table, options, mods, view) {
+  const open = () => loadBucketGroup().then((mod) => {
+    try {
+      return { it: plan(session, table, options, mods, view, mod) };
+    } catch (error) {
+      throw error instanceof OkmError2 ? attachHttp(session.http, error) : error;
+    }
+  });
+  return queryHandle(() => open().then((box) => box.it), {
+    inspect: () => open().then((box) => box.it.inspect()),
+    sql: () => open().then((box) => box.it.sql()),
+    all: (reason) => build(session, table, options, { ...mods, all: reason }, view)
+  });
+}
+function seesBucket(options) {
+  if (!isRecord(options))
+    return false;
+  const groupBy = options.groupBy;
+  if (!Array.isArray(groupBy))
+    return false;
+  for (const item of groupBy) {
+    if (typeof item === "object" && item !== null && BUCKET in item)
+      return true;
+  }
+  return false;
+}
+function plan(session, table, options, mods, view, buckets) {
+  const record = isRecord(options) ? options : {};
+  rejectKeys(record, OPTIONS, "aggregate");
+  const indexed = indexes(session.schema).get(table);
+  if (indexed === undefined)
+    fail2("OKM1120", `Table ${table} is not in the schema.`);
+  const spec = parse(indexed, record, buckets);
+  if (spec.groups.length > 0 && record.limit === undefined && mods.all === undefined) {
+    fail2("OKM1101", "aggregate() with groupBy needs a limit, or .all(reason) for every group.");
+  }
+  const names = groupNames(spec.groups);
+  const orderBy = record.orderBy;
+  if (orderBy !== undefined) {
+    if (!isRecord(orderBy))
+      fail2("OKM1120", "orderBy must be an object of fields.");
+    for (const field of Object.keys(orderBy)) {
+      if (!names.includes(field)) {
+        const column = indexed.columns.get(field);
+        if (column !== undefined)
+          refuseHidden(column);
+        throwNamed2("OKM1120", field, names, `aggregate() orders by a groupBy field. Accepted names: ${list(names)}.`);
+      }
+    }
+  }
+  if (record.limit !== undefined)
+    readLimit(record.limit);
+  const base = readCall("find", table, {
+    where: record.where,
+    orderBy,
+    limit: record.limit,
+    signal: record.signal,
+    timeout: record.timeout,
+    route: record.route
+  }, mods.all, session.scope, session.schema.model[table], session.schema, view);
+  const call = { ...base, op: "aggregate", build: statement(spec, buckets) };
+  return readHandle(session, table, call, mods, (compiled, rows) => decode(compiled, rows));
+}
+function parse(table, record, buckets) {
+  const grouped = readGroups(table, record.groupBy, buckets);
+  const count = record.count === true;
+  if (record.count !== undefined && typeof record.count !== "boolean") {
+    fail2("OKM1120", "count is true when you want a row count.");
+  }
+  const calls = [];
+  for (const { option, tag, numeric } of FUNCTIONS) {
+    for (const column of columns(table, record[option], option)) {
+      const fits = numeric ? NUMERIC.test(column.dataType) : !UNORDERED.test(column.dataType);
+      if (!fits) {
+        fail2("OKM1124", `${option} does not apply to ${column.dataType} column ${column.field}. ${numeric ? "sum and avg take integer, real, and numeric columns." : "min and max need an ordered type."}`);
+      }
+      calls.push({ option, tag, column, decode: numeric ? sumDecode(column) : column.decode });
+    }
+  }
+  if (!count && calls.length === 0 && grouped.groups.length === 0) {
+    fail2("OKM1120", "aggregate() needs count, sum, avg, min, max, or groupBy.");
+  }
+  return { groups: grouped.groups, bucketed: grouped.bucketed, count, calls };
+}
+function sumDecode(column) {
+  const kind = typeof (column.decode?.("0") ?? "");
+  if (kind === "string")
+    return AS_TEXT;
+  if (kind === "number")
+    return AS_NUMBER;
+  return fail2("OKM1124", `sum and avg need a column whose value is a number or a string. ${column.field} reads as ${kind}.`);
+}
+function columns(table, value, option) {
+  if (value === undefined)
+    return [];
+  if (!Array.isArray(value))
+    fail2("OKM1120", `${option} must be a list of field names.`);
+  const out = [];
+  for (const name of value) {
+    const column = typeof name === "string" ? table.columns.get(name) : undefined;
+    if (typeof name !== "string" || column === undefined) {
+      throwNamed2("OKM1120", String(name), table.names, `Field ${String(name)} is not on ${table.model.name}. Accepted names: ${list(table.names)}.`);
+    }
+    if (column.hidden) {
+      fail2("OKM1120", `Field ${column.field} is hidden, so ${option} cannot read it.`);
+    }
+    out.push(column);
+  }
+  return out;
+}
+function groupNames(groups) {
+  const names = [];
+  for (const group of groups)
+    names.push(group.kind === "field" ? group.column.field : group.as);
+  return names;
+}
+function readGroups(table, value, buckets) {
+  if (value === undefined)
+    return { groups: [], bucketed: false };
+  if (!Array.isArray(value))
+    fail2("OKM1120", "groupBy must be a list of field names.");
+  const fields = new Set;
+  const aliases = new Set;
+  const groups = [];
+  let bucketed = false;
+  for (const item of value) {
+    if (typeof item === "object" && item !== null && BUCKET in item) {
+      if (buckets === undefined)
+        fail2("OKM1120", "bucket group");
+      groups.push(buckets.readBucket(table, item, fields, aliases));
+      bucketed = true;
+      continue;
+    }
+    const column = typeof item === "string" ? table.columns.get(item) : undefined;
+    if (typeof item !== "string" || column === undefined) {
+      throwNamed2("OKM1120", String(item), table.names, `Field ${String(item)} is not on ${table.model.name}. Accepted names: ${list(table.names)}.`);
+    }
+    if (column.hidden) {
+      fail2("OKM1120", `Field ${column.field} is hidden, so groupBy cannot read it.`);
+    }
+    if (aliases.has(column.field)) {
+      fail2("OKM1120", `group field ${column.field} clashes with a bucket as.`);
+    }
+    fields.add(column.field);
+    groups.push({ kind: "field", column });
+  }
+  return { groups, bucketed };
+}
+function statement(spec, buckets) {
+  return (schema, table, sink, outputs, call) => {
+    sink.mark(`aggregate|${table.model.name}|g:${groupMark(spec.groups)}|c:${String(spec.count)}|${spec.calls.map((item) => `${item.tag}:${item.column.field}`).join(",")}|`);
+    sink.text("select ");
+    const wrote = { at: 0 };
+    for (const group of spec.groups) {
+      if (group.kind === "field") {
+        put(sink, outputs, wrote, projectExpr(`t.${quote(group.column.sql)}`, group.column.dataType), {
+          key: `g:${group.column.field}`,
+          decode: group.column.decode
+        });
+      } else {
+        if (buckets === undefined)
+          fail2("OKM1120", "bucket group");
+        buckets.writeBucket(sink, outputs, wrote, group);
+      }
+    }
+    if (spec.count)
+      put(sink, outputs, wrote, "count(*)::text", { key: "c:", decode: undefined });
+    for (const item of spec.calls) {
+      const ref = `t.${quote(item.column.sql)}`;
+      const expr = item.option === "sum" || item.option === "avg" ? `${item.option}(${ref})::text` : projectExpr(`${item.option}(${ref})`, item.column.dataType);
+      put(sink, outputs, wrote, expr, {
+        key: `${item.tag}:${item.column.field}`,
+        decode: item.decode
+      });
+    }
+    sink.text(" from ");
+    sink.text(quote(table.model.sql));
+    sink.text(" t");
+    emitWhere(schema, table, call.where, sink, "t", 0);
+    if (spec.groups.length > 0) {
+      sink.text(" group by ");
+      if (spec.bucketed) {
+        if (buckets === undefined)
+          fail2("OKM1120", "bucket group");
+        buckets.writeGrouped(sink, groupNames(spec.groups), call.orderBy);
+      } else {
+        sink.text(spec.groups.map((group) => fieldRef(group)).join(", "));
+        if (isRecord(call.orderBy) && Object.keys(call.orderBy).length > 0) {
+          emitOrder(table, call.orderBy, sink, "t");
+        } else {
+          sink.text(" order by ");
+          sink.text(spec.groups.map((group) => `${fieldRef(group)} asc nulls last`).join(", "));
+        }
+      }
+    }
+    if (call.limit !== undefined) {
+      const limit = String(call.limit);
+      sink.text(" limit ");
+      sink.param(limit);
+      sink.mark(`l:${limit}`);
+    }
+    if (typeof call.all === "string")
+      sink.mark(`all:${call.all}`);
+  };
+}
+function groupMark(groups) {
+  const parts = [];
+  for (const group of groups) {
+    parts.push(group.kind === "field" ? group.column.field : `b:${group.column.field}:${group.as}:${group.unit}:${String(group.shift)}`);
+  }
+  return parts.join(",");
+}
+function fieldRef(group) {
+  if (group.kind !== "field")
+    return fail2("OKM1120", "bucket group");
+  return `t.${quote(group.column.sql)}`;
+}
+function put(sink, outputs, wrote, expr, out) {
+  if (wrote.at > 0)
+    sink.text(", ");
+  sink.text(expr);
+  outputs?.fields.push({ key: out.key, at: wrote.at, decode: out.decode });
+  wrote.at += 1;
+}
+function decode(compiled, rows) {
+  const items = [];
+  for (const row of rows) {
+    const item = {};
+    for (const field of compiled.outputs.fields) {
+      const value = row[field.at];
+      const tag = field.key.slice(0, 2);
+      const name = field.key.slice(2);
+      if (tag === "g:") {
+        item[name] = cell(value, field.decode);
+      } else if (tag === "c:") {
+        item.count = Number(value ?? 0);
+      } else {
+        const group = tag === "s:" ? "sum" : tag === "a:" ? "avg" : tag === "n:" ? "min" : "max";
+        const into = item[group] ??= {};
+        into[name] = cell(value, field.decode);
+      }
+    }
+    items.push(item);
+  }
+  return items;
+}
+export {
+  build
+};

package/dist/shared/{4az561fn.js → 1qa0qajz.js}

@@ -4,12 +4,9 @@ import {
   nextTransactionDepth,
   EMPTY_NOTICES,
   resultFrom
-} from "./cgbamx3e.js";
+} from "./kb2sdhfb.js";
 
 // src/adapters/pg/session.ts
-function quoteIdent2(name) {
-  return `"${name.replaceAll('"', '""')}"`;
-}
 function noticeBuffer() {
   let notices;
   return {
@@ -63,7 +60,7 @@ class WireSession {
         return resultFrom(result, this.notices.since(start));
       }, (error) => {
         this.onLeave();
-        return driverErrors().then((errors) => Promise.reject(errors.mapDriverError(error)));
+        return driverErrors().then((errors) => Promise.reject(errors.mapDriverError(stampQuery(error, text))));
       });
     }
     return this.watched(pending, watch, start, text);
@@ -110,7 +107,7 @@ class WireSession {
       return resultFrom(result, this.notices.since(start));
     }, (error) => {
       this.finishWatched(pending, watch, onAbort);
-      return classify(error, watch);
+      return classify(stampQuery(error, text), watch);
     });
   }
   finishWatched(pending, watch, onAbort) {
@@ -119,22 +116,10 @@ class WireSession {
     watch.signal.removeEventListener("abort", onAbort);
   }
 }
-async function* cursorStream(run, text, params) {
-  const name = "okm_stream";
-  await run("BEGIN");
-  try {
-    await run(`DECLARE ${name} NO SCROLL CURSOR FOR ${text}`, params);
-    for (;; ) {
-      const chunk = await run(`FETCH 64 FROM ${name}`);
-      if (chunk.rows.length === 0)
-        break;
-      yield chunk.rows;
-    }
-  } finally {
-    await run("ROLLBACK").catch(() => {
-      return;
-    });
-  }
+function stampQuery(error, text) {
+  if (typeof error === "object" && error !== null && !("query" in error))
+    Reflect.set(error, "query", text);
+  return error;
 }
 async function classify(error, watch) {
   const errors = await driverErrors();
@@ -151,4 +136,4 @@ async function classify(error, watch) {
   return Promise.reject(errors.mapDriverError(error));
 }
 
-export { quoteIdent2, noticeBuffer, WireSession, cursorStream };
+export { noticeBuffer, WireSession };