okmodel 0.7.0 → 0.8.0

package/dist/tooling/shared/bz2dqhab.js

@@ -0,0 +1,311 @@
+import {
+  queryHandle,
+  readHandle,
+  readCall,
+  attachHttp
+} from "./mtrqn2hn.js";
+import {
+  OkmError,
+  throwNamed,
+  emitWhere,
+  emitOrder,
+  refuseHidden,
+  rejectKeys,
+  readLimit,
+  projectExpr,
+  cell,
+  indexes,
+  quote,
+  list,
+  isRecord,
+  fail2
+} from "./f9mphxej.js";
+
+// src/runtime/aggregate.ts
+var BUCKET = Symbol.for("okmodel.bucket");
+var bucketChunk;
+function loadBucketGroup() {
+  return bucketChunk ??= import("./2revefqt.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 OkmError ? 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 OkmError ? 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);
+        throwNamed("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) {
+      throwNamed("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) {
+      throwNamed("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/tooling/shared/cmptmb4f.js

@@ -0,0 +1,12 @@
+import {
+  tag
+} from "./f9mphxej.js";
+
+// src/runtime/preset-stack.ts
+function stack2(where, presets) {
+  if (presets === undefined || presets.length === 0)
+    return where;
+  return tag("and", where === undefined ? presets : [where, ...presets]);
+}
+
+export { stack2 };

package/dist/tooling/shared/ddjtfgnx.js

@@ -0,0 +1,177 @@
+import {
+  build3
+} from "./zvnhh1n0.js";
+import {
+  attachHttp
+} from "./mtrqn2hn.js";
+import {
+  OkmError,
+  rejectKeys,
+  readLimit,
+  indexes,
+  isRecord,
+  fail2
+} from "./f9mphxej.js";
+
+// src/runtime/read-stream.ts
+var DEFAULT_BATCH = 1000;
+var MAX_BATCH = 2147483647;
+async function* streamRows(session, call, mods, view, batchOptions, log) {
+  const stop = (error) => {
+    throw log(attachHttp(session.http, error));
+  };
+  let batch;
+  let total;
+  let signal;
+  let deadline;
+  try {
+    if (call.op !== "find") {
+      fail2("OKM1120", `stream() reads rows from find(). ${call.op}() returns one value.`);
+    }
+    if (call.search !== undefined) {
+      fail2("OKM1120", "stream() does not take search in this version. Use find({ search, limit }) for a ranked list.", "Ranked pages are later. find({ search, limit }) returns one ranked list.");
+    }
+    if (Array.isArray(call.select) && call.select.some((item) => typeof item !== "string")) {
+      fail2("OKM1120", "stream() does not take a window. The keyset cursor has no window value to encode.");
+    }
+    const indexed = indexes(session.schema).get(call.table);
+    if (indexed === undefined)
+      fail2("OKM1120", `Table ${call.table} is not in the schema.`);
+    if (indexed.model.primary.length === 0) {
+      fail2("OKM1120", `stream() needs a primary key on ${indexed.model.name}. A keyset batch orders by that key.`, "Give the table a primary key. stream() orders by it.");
+    }
+    batch = readBatch(batchOptions);
+    if (mods.all !== undefined && mods.all.length === 0) {
+      fail2("OKM1101", "find() .all needs a reason.");
+    }
+    if (call.limit !== undefined)
+      total = readLimit(call.limit);
+    else if (mods.all === undefined) {
+      fail2("OKM1101", "find() needs a limit, or .all(reason) when the full set is intentional.");
+    }
+    const timeout = call.timeout;
+    if (timeout !== undefined && (typeof timeout !== "number" || !(timeout > 0))) {
+      fail2("OKM1121", "timeout must be a number of milliseconds above 0.");
+    }
+    signal = signalOf(call.signal);
+    deadline = timeout === undefined ? undefined : Date.now() + timeout;
+  } catch (error) {
+    if (error instanceof OkmError)
+      stop(error);
+    throw error;
+  }
+  if (total === 0)
+    return;
+  const cancel = session.pool.capabilities.cancel === true;
+  const statement = session.timeouts?.statement;
+  const pin = {};
+  let after;
+  let left = total;
+  let pending;
+  try {
+    while (left === undefined || left > 0) {
+      if (signal?.aborted === true) {
+        stop(new OkmError("cancelled", "The stream was cancelled.", { kind: "cancelled" }));
+      }
+      const remaining = timeLeft(deadline);
+      const size = left === undefined ? batch : Math.min(batch, left);
+      const handle = build3(session, call.table, pageFields(call, size, after, signal, batchTimeout(remaining, cancel, statement)), mods, view, pin);
+      pending = handle;
+      const value = asPage(await handle);
+      pending = undefined;
+      for (const row of value.items) {
+        yield row;
+        if (left !== undefined) {
+          left -= 1;
+          if (left === 0)
+            return;
+        }
+      }
+      if (value.next === null || value.items.length < size)
+        return;
+      after = value.next;
+    }
+  } catch (error) {
+    if (error instanceof OkmError && error.kind === "timeout" && error.message === "The stream timed out.") {
+      stop(error);
+    }
+    throw error;
+  } finally {
+    if (pending !== undefined) {
+      pending.then(() => {
+        return;
+      }, () => {
+        return;
+      });
+    }
+  }
+}
+function readBatch(options) {
+  if (options === undefined)
+    return DEFAULT_BATCH;
+  if (!isRecord(options))
+    fail2("OKM1120", "stream() takes an object. Pass { batch }.");
+  rejectKeys(options, ["batch"], "stream");
+  const batch = options.batch;
+  if (batch === undefined)
+    return DEFAULT_BATCH;
+  if (typeof batch !== "number" || !Number.isInteger(batch) || batch < 1 || batch > MAX_BATCH) {
+    fail2("OKM1121", "stream() batch must be an integer from 1 to 2147483647.");
+  }
+  return batch;
+}
+function pageFields(call, size, after, signal, timeout) {
+  const out = { limit: size };
+  if (call.where !== undefined)
+    out.where = call.where;
+  if (call.select !== undefined)
+    out.select = call.select;
+  if (call.orderBy !== undefined)
+    out.orderBy = call.orderBy;
+  if (call.include !== undefined)
+    out.include = call.include;
+  if (call.route !== undefined)
+    out.route = call.route;
+  if (after !== undefined)
+    out.after = after;
+  if (signal !== undefined)
+    out.signal = signal;
+  if (timeout !== undefined)
+    out.timeout = timeout;
+  return out;
+}
+function timeLeft(deadline) {
+  if (deadline === undefined)
+    return;
+  const left = deadline - Date.now();
+  if (left <= 0)
+    throw new OkmError("timeout", "The stream timed out.", { kind: "timeout" });
+  return left;
+}
+function batchTimeout(remaining, cancel, statement) {
+  if (!cancel || remaining === undefined)
+    return;
+  if (statement !== undefined && statement > 0 && statement < remaining)
+    return statement;
+  return remaining;
+}
+function signalOf(value) {
+  if (typeof value === "object" && value !== null && "aborted" in value) {
+    return value;
+  }
+  return;
+}
+function asPage(value) {
+  if (typeof value !== "object" || value === null || !("items" in value) || !("next" in value)) {
+    throw new OkmError("OKM1120", "stream() did not get a page of rows.");
+  }
+  const items = value.items;
+  const next = value.next;
+  if (!Array.isArray(items) || next !== null && typeof next !== "string") {
+    throw new OkmError("OKM1120", "stream() did not get a page of rows.");
+  }
+  return { items, next };
+}
+export {
+  streamRows
+};