okmodel 0.7.0 → 0.8.0

package/dist/tooling/shared/zvnhh1n0.js

@@ -0,0 +1,198 @@
+import {
+  decodeRows,
+  readHandle,
+  readCall,
+  attachHttp
+} from "./mtrqn2hn.js";
+import {
+  OkmError,
+  throwNamed,
+  selectedColumns,
+  parseOrder,
+  rejectKeys,
+  readLimit,
+  indexes,
+  quote,
+  list,
+  isRecord,
+  registerFailFix,
+  fail2
+} from "./f9mphxej.js";
+
+// src/runtime/page.ts
+registerFailFix("OKM1130", "Request the next page with the same orderBy and the exact next value the previous page returned. The cursor encodes that order.");
+var OPTIONS = [
+  "where",
+  "select",
+  "orderBy",
+  "limit",
+  "include",
+  "after",
+  "route",
+  "signal",
+  "timeout"
+];
+function build3(session, table, options, mods, view, pin) {
+  try {
+    return plan(session, table, options, mods, view, pin);
+  } catch (error) {
+    throw error instanceof OkmError ? attachHttp(session.http, error) : error;
+  }
+}
+function plan(session, table, options, mods, view, pin) {
+  const record = isRecord(options) ? options : {};
+  if (Object.hasOwn(record, "search")) {
+    fail2("OKM1120", "page() 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.");
+  }
+  rejectKeys(record, OPTIONS, "page");
+  const indexed = indexes(session.schema).get(table);
+  if (indexed === undefined)
+    fail2("OKM1120", `Table ${table} is not in the schema.`);
+  if (record.limit === undefined)
+    fail2("OKM1101", "page() needs a limit.");
+  const size = readLimit(record.limit);
+  if (size < 1) {
+    throw new OkmError("invalid", "page() limit must be at least 1.", { kind: "invalid" });
+  }
+  const keys = orderKeys(indexed, record.orderBy);
+  const signature = `${table}:${keys.map((key) => `${key.column.field}.${key.dir}.${key.nulls}`).join(",")}`;
+  const after = record.after === undefined || record.after === null ? undefined : keyset(keys, signature, record.after);
+  const wanted = selectedColumns(indexed, record.select);
+  const extra = keys.filter((key) => !wanted.includes(key.column)).map((key) => key.column.field);
+  const select = extra.length === 0 ? record.select : [...wanted.map((column) => column.field), ...extra];
+  const orderBy = {};
+  for (const key of keys)
+    orderBy[key.column.field] = { dir: key.dir, nulls: key.nulls };
+  const call = {
+    ...readCall("find", table, {
+      where: record.where,
+      select,
+      orderBy,
+      limit: size + 1,
+      include: record.include,
+      signal: record.signal,
+      timeout: record.timeout,
+      route: record.route
+    }, undefined, session.scope, session.schema.model[table], session.schema, view),
+    ...after !== undefined ? { after } : {},
+    ...pin !== undefined ? { pin } : {}
+  };
+  return readHandle(session, table, call, mods, async (compiled, rows) => {
+    const items = await decodeRows(compiled, rows, table);
+    const more = items.length > size;
+    const kept = more ? items.slice(0, size) : items;
+    const last = rows[size - 1];
+    const next = more && last !== undefined ? makeCursor(compiled, last, keys, signature) : null;
+    if (extra.length > 0) {
+      for (const item of kept) {
+        for (const field of extra)
+          delete item[field];
+      }
+    }
+    return { items: kept, next };
+  });
+}
+function orderKeys(table, orderBy) {
+  if (orderBy !== undefined && !isRecord(orderBy)) {
+    fail2("OKM1120", "orderBy must be an object of fields.");
+  }
+  const keys = [];
+  for (const field of Object.keys(orderBy ?? {})) {
+    const column = table.columns.get(field);
+    if (column === undefined) {
+      throwNamed("OKM1120", field, table.names, `Field ${field} is not on ${table.model.name}. Accepted names: ${list(table.names)}.`);
+    }
+    keys.push({ column, ...parseOrder(field, orderBy?.[field]) });
+  }
+  if (table.model.primary.length === 0) {
+    fail2("OKM1120", `page() needs a primary key on ${table.model.name} to break ties.`);
+  }
+  for (const field of table.model.primary) {
+    const column = table.columns.get(field);
+    if (column === undefined || keys.some((key) => key.column === column))
+      continue;
+    keys.push({ column, dir: "asc", nulls: "last" });
+  }
+  return keys;
+}
+function keyset(keys, signature, token) {
+  const values = readCursor(token, signature, keys.length);
+  return (sink, alias) => {
+    sink.mark(`k:${signature}:${values.map((value) => value === null ? "n" : "v").join("")}`);
+    let wrote = false;
+    for (let index = 0;index < keys.length; index += 1) {
+      const key = keys[index];
+      const value = values[index];
+      if (key === undefined || value === undefined)
+        continue;
+      if (value === null && key.nulls === "last")
+        continue;
+      sink.text(wrote ? " or (" : "(");
+      wrote = true;
+      for (let before = 0;before < index; before += 1) {
+        const prior = keys[before];
+        const held = values[before];
+        if (prior === undefined || held === undefined)
+          continue;
+        const ref = `${alias}.${quote(prior.column.sql)}`;
+        if (held === null) {
+          sink.text(`${ref} is null and `);
+        } else {
+          sink.text(`${ref} = `);
+          sink.param(held);
+          sink.text(" and ");
+        }
+      }
+      const ref = `${alias}.${quote(key.column.sql)}`;
+      if (value === null) {
+        sink.text(`${ref} is not null`);
+      } else {
+        sink.text(key.nulls === "last" ? `(${ref} ${compare(key)} ` : `${ref} ${compare(key)} `);
+        sink.param(value);
+        sink.text(key.nulls === "last" ? ` or ${ref} is null)` : "");
+      }
+      sink.text(")");
+    }
+    if (!wrote)
+      sink.text("false");
+  };
+}
+function compare(key) {
+  return key.dir === "asc" ? ">" : "<";
+}
+function makeCursor(plan, row, keys, signature) {
+  const values = keys.map((key) => {
+    const at = plan.outputs.fields.find((field) => field.key === key.column.field)?.at;
+    return at === undefined ? null : row[at] ?? null;
+  });
+  const bytes = new TextEncoder().encode(JSON.stringify([signature, ...values]));
+  let binary = "";
+  for (const byte of bytes)
+    binary += String.fromCharCode(byte);
+  return btoa(binary).replaceAll("+", "-").replaceAll("/", "_").replaceAll("=", "");
+}
+function readCursor(token, signature, count) {
+  let parsed;
+  if (typeof token === "string") {
+    try {
+      const binary = atob(token.replaceAll("-", "+").replaceAll("_", "/"));
+      const bytes = Uint8Array.from(binary, (char) => char.charCodeAt(0));
+      parsed = JSON.parse(new TextDecoder().decode(bytes));
+    } catch {
+      parsed = undefined;
+    }
+  }
+  if (!Array.isArray(parsed) || typeof parsed[0] !== "string") {
+    fail2("OKM1130", "after is not a cursor that page() returned.");
+  }
+  if (parsed[0] !== signature) {
+    fail2("OKM1130", `The cursor was made for another order: ${parsed[0]}. This page orders by ${signature}.`);
+  }
+  const values = parsed.slice(1);
+  if (values.length !== count || !values.every((value) => value === null || typeof value === "string")) {
+    fail2("OKM1130", "after is not a cursor that page() returned.");
+  }
+  return values;
+}
+
+export { build3 };

package/dist/tooling/testing/index.js

@@ -1,8 +1,8 @@
 import {
   testing2
-} from "../../shared/7k9grvf6.js";
-import"../../shared/9s0ypp87.js";
-import"../../shared/qq3899ht.js";
+} from "../../shared/b6d6p0zc.js";
+import"../../shared/sjk86yrx.js";
+import"../../shared/12z7aznj.js";
 export {
   testing2 as testing
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "okmodel",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "okmodel is a catalog-first TypeScript ORM, PostgreSQL first.",
   "keywords": [
     "migrations",
@@ -63,6 +63,10 @@
       "types": "./dist/runtime/pg/bun.d.ts",
       "import": "./dist/runtime/pg/bun.js"
     },
+    "./pg/neon": {
+      "types": "./dist/runtime/pg/neon.d.ts",
+      "import": "./dist/runtime/pg/neon.js"
+    },
     "./ids": {
       "types": "./dist/runtime/ids/index.d.ts",
       "import": "./dist/runtime/ids/index.js"
@@ -87,6 +91,10 @@
       "types": "./dist/runtime/validate/index.d.ts",
       "import": "./dist/runtime/validate/index.js"
     },
+    "./otel": {
+      "types": "./dist/runtime/otel.d.ts",
+      "import": "./dist/runtime/otel.js"
+    },
     "./ext": {
       "types": "./dist/dialects/pg/ext/index.d.ts",
       "import": "./dist/dialects/pg/ext/index.js"
@@ -109,7 +117,7 @@
     }
   },
   "scripts": {
-    "build": "rm -rf dist && bun build ./src/contracts/index.ts ./src/contracts/internal.ts ./src/dialects/pg/index.ts ./src/runtime/pg/postgresjs.ts ./src/runtime/pg/pglite.ts ./src/runtime/pg/pg.ts ./src/runtime/pg/bun.ts ./src/runtime/ids/index.ts ./src/runtime/safety/index.ts ./src/runtime/traits/index.ts ./src/runtime/tenancy/index.ts ./src/runtime/validate/index.ts ./src/dialects/pg/ext/index.ts ./src/dialects/pg/fn/index.ts ./src/dialects/pg/view/index.ts ./src/dialects/pg/ext/citext.ts ./src/dialects/pg/ext/pg-trgm.ts ./src/tooling/migrate/index.ts ./src/tooling/testing/index.ts ./src/tooling/cli.ts --outdir ./dist --root ./src --format esm --target node --splitting --chunk-naming=shared/[hash].js --external postgres --external @electric-sql/pglite --external pg --external bun && bunx tsc -p tsconfig.build.json && rm -f ./dist/dialects/pg/temporal.local.d.ts && bun ./scripts/write-bin-wrappers.ts",
+    "build": "rm -rf dist && bun build ./src/contracts/index.ts ./src/contracts/internal.ts ./src/dialects/pg/index.ts ./src/runtime/pg/postgresjs.ts ./src/runtime/pg/pglite.ts ./src/runtime/pg/pg.ts ./src/runtime/pg/bun.ts ./src/runtime/pg/neon.ts ./src/runtime/ids/index.ts ./src/runtime/safety/index.ts ./src/runtime/traits/index.ts ./src/runtime/tenancy/index.ts ./src/runtime/validate/index.ts ./src/runtime/otel.ts ./src/dialects/pg/ext/index.ts ./src/dialects/pg/fn/index.ts ./src/dialects/pg/view/index.ts ./src/dialects/pg/ext/citext.ts ./src/dialects/pg/ext/pg-trgm.ts ./src/tooling/migrate/index.ts ./src/tooling/testing/index.ts ./src/tooling/cli.ts --outdir ./dist --root ./src --format esm --target node --splitting --chunk-naming=shared/[hash].js --external postgres --external @electric-sql/pglite --external pg --external bun --external @neondatabase/serverless && bunx tsc -p tsconfig.build.json && rm -f ./dist/dialects/pg/temporal.local.d.ts && bun build ./packages/harness/src/driver-run.ts --outdir ./dist/tooling --format esm --target node --splitting --chunk-naming=shared/[hash].js --external postgres --external @electric-sql/pglite --external pg --external bun --external @neondatabase/serverless && bun ./scripts/write-bin-wrappers.ts",
     "driver-bench": "bun ./scripts/driver-bench.ts",
     "typecheck": "bunx tsc --noEmit -p tsconfig.json",
     "editor-check": "bun ./scripts/editor-check.ts",
@@ -168,6 +176,7 @@
   },
   "peerDependencies": {
     "@electric-sql/pglite": "^0.5.8",
+    "@neondatabase/serverless": "^1.2.0",
     "pg": "^8.16.0",
     "postgres": "^3.4.9"
   },
@@ -175,6 +184,9 @@
     "@electric-sql/pglite": {
       "optional": true
     },
+    "@neondatabase/serverless": {
+      "optional": true
+    },
     "pg": {
       "optional": true
     },

package/dist/shared/y34a8714.js

@@ -1,150 +0,0 @@
-import {
-  staticNamespace2,
-  assertNamespace2,
-  normaliseEdges,
-  assertProvenance
-} from "./358zsv4r.js";
-import {
-  assertIdentifier2
-} from "./nfzc5z0w.js";
-import {
-  catalogError2
-} from "./52szzakm.js";
-
-// src/contracts/catalog/routine.ts
-var VOLATILITY = new Set(["volatile", "stable", "immutable"]);
-var SECURITY = new Set(["invoker", "definer"]);
-var TIMING = new Set(["before", "after", "instead"]);
-var LEVEL = new Set(["row", "statement"]);
-var EVENT_ORDER = ["insert", "update", "delete", "truncate"];
-var TYPE_TEXT = /^[A-Za-z][A-Za-z0-9_ ]*(\(\d+(,\s*\d+)?\))?(\[\])*$/;
-function functionObject(input) {
-  assertIdentifier2(input.name, "function");
-  const namespace = input.namespace ?? staticNamespace2("public");
-  assertNamespace2(namespace);
-  assertProvenance(input.provenance);
-  if (input.language !== "sql" && input.language !== "plpgsql") {
-    catalogError2("OKM1020", `Function ${input.name} language must be sql or plpgsql.`);
-  }
-  const volatility = input.volatility ?? "volatile";
-  if (!VOLATILITY.has(volatility)) {
-    catalogError2("OKM1020", `Function ${input.name} volatility ${volatility} is not supported.`);
-  }
-  const security = input.security ?? "invoker";
-  if (!SECURITY.has(security)) {
-    catalogError2("OKM1020", `Function ${input.name} security ${security} is not supported.`);
-  }
-  assertTypeName(input.returns, `function ${input.name} return type`);
-  const args = (input.arguments ?? []).map((argument) => readArgument(input.name, argument));
-  if (input.body.length === 0) {
-    catalogError2("OKM1020", `Function ${input.name} needs a body.`);
-  }
-  const atomic = input.atomic === true;
-  if (atomic && input.language !== "sql") {
-    catalogError2("OKM1020", `Function ${input.name} BEGIN ATOMIC needs language sql.`);
-  }
-  if (input.searchPath !== undefined && input.searchPath.trim().length === 0) {
-    catalogError2("OKM1020", `Function ${input.name} search_path is empty.`);
-  }
-  const definition = {
-    arguments: args,
-    returns: input.returns,
-    language: input.language,
-    volatility,
-    security,
-    body: input.body,
-    ...input.searchPath !== undefined ? { searchPath: input.searchPath } : {},
-    ...atomic ? { atomic: true } : {}
-  };
-  return {
-    kind: "function",
-    identity: {
-      kind: "function",
-      namespace,
-      name: input.name,
-      argTypes: args.map((arg) => arg.type)
-    },
-    owner: input.owner ?? "managed",
-    definition,
-    dependencies: normaliseEdges(input.dependencies ?? []),
-    provenance: input.provenance
-  };
-}
-function triggerObject(input) {
-  assertIdentifier2(input.name, "trigger");
-  assertNamespace2(input.parent.namespace);
-  assertIdentifier2(input.parent.name, "trigger table");
-  assertProvenance(input.provenance);
-  if (!TIMING.has(input.timing)) {
-    catalogError2("OKM1020", `Trigger ${input.name} timing ${input.timing} is not supported.`);
-  }
-  if (!LEVEL.has(input.level)) {
-    catalogError2("OKM1020", `Trigger ${input.name} level ${input.level} is not supported.`);
-  }
-  const events = EVENT_ORDER.filter((event) => input.events.includes(event));
-  if (events.length === 0) {
-    catalogError2("OKM1020", `Trigger ${input.name} needs an event.`);
-  }
-  const updateOf = input.updateOf === undefined ? undefined : [...input.updateOf];
-  if (updateOf !== undefined) {
-    if (!events.includes("update")) {
-      catalogError2("OKM1020", `Trigger ${input.name} lists UPDATE OF columns without an update event.`);
-    }
-    if (input.level !== "row") {
-      catalogError2("OKM1020", `Trigger ${input.name} UPDATE OF columns need level row.`);
-    }
-    for (const column of updateOf)
-      assertIdentifier2(column, "trigger column");
-  }
-  assertIdentifier2(input.calls.name, "trigger function");
-  assertNamespace2(input.calls.namespace);
-  for (const typeName of input.calls.argTypes)
-    assertTypeName(typeName, `trigger ${input.name}`);
-  const edges = [
-    { kind: "table", namespace: input.parent.namespace, name: input.parent.name },
-    {
-      kind: "function",
-      namespace: input.calls.namespace,
-      name: input.calls.name,
-      argTypes: input.calls.argTypes
-    },
-    ...(updateOf ?? []).map((column) => ({
-      kind: "column",
-      parent: input.parent,
-      name: column
-    })),
-    ...input.dependencies ?? []
-  ];
-  const definition = {
-    timing: input.timing,
-    events,
-    level: input.level,
-    calls: {
-      namespace: input.calls.namespace,
-      name: input.calls.name,
-      argTypes: [...input.calls.argTypes]
-    },
-    ...updateOf !== undefined && updateOf.length > 0 ? { updateOf } : {},
-    ...input.when !== undefined && input.when.length > 0 ? { when: input.when } : {}
-  };
-  return {
-    kind: "trigger",
-    identity: { kind: "trigger", parent: input.parent, name: input.name },
-    owner: input.owner ?? "managed",
-    definition,
-    dependencies: normaliseEdges(edges),
-    provenance: input.provenance
-  };
-}
-function readArgument(fn, argument) {
-  assertIdentifier2(argument.name, `function ${fn} argument`);
-  assertTypeName(argument.type, `function ${fn} argument ${argument.name}`);
-  return { name: argument.name, type: argument.type };
-}
-function assertTypeName(typeName, role) {
-  if (!TYPE_TEXT.test(typeName)) {
-    catalogError2("OKM1020", `${role} ${typeName} is not a type name.`);
-  }
-}
-
-export { functionObject, triggerObject };

package/dist/shared/zy8r7qvz.js

@@ -1,116 +0,0 @@
-import {
-  staticNamespace2,
-  assertNamespace2,
-  normaliseEdges,
-  assertProvenance
-} from "./358zsv4r.js";
-import {
-  assertIdentifier2,
-  fitIdentifier2,
-  deterministicName2
-} from "./nfzc5z0w.js";
-import {
-  catalogError2
-} from "./52szzakm.js";
-
-// src/contracts/catalog/view.ts
-function normaliseViewQuery(query) {
-  return query.trim().replace(/;\s*$/, "");
-}
-function viewObject(input) {
-  const namespace = input.namespace ?? staticNamespace2("public");
-  const columns = readColumns(input.name, input.columns);
-  const query = readQuery(input.name, input.query);
-  assertNamespace2(namespace);
-  assertProvenance(input.provenance);
-  const definition = {
-    columns,
-    query,
-    ...input.securityInvoker === true ? { securityInvoker: true } : {}
-  };
-  return {
-    kind: "view",
-    identity: { kind: "view", namespace, name: input.name },
-    owner: input.owner ?? "managed",
-    definition,
-    dependencies: normaliseEdges(input.dependencies ?? []),
-    provenance: input.provenance
-  };
-}
-function materializedViewObject(input) {
-  const namespace = input.namespace ?? staticNamespace2("public");
-  const columns = readColumns(input.name, input.columns);
-  const query = readQuery(input.name, input.query);
-  assertNamespace2(namespace);
-  assertProvenance(input.provenance);
-  const definition = {
-    columns,
-    query,
-    ...input.refresh === "concurrently" ? { refresh: "concurrently" } : {}
-  };
-  return {
-    kind: "materializedView",
-    identity: { kind: "materializedView", namespace, name: input.name },
-    owner: input.owner ?? "managed",
-    definition,
-    dependencies: normaliseEdges(input.dependencies ?? []),
-    provenance: input.provenance
-  };
-}
-function materializedViewIndex(input) {
-  assertNamespace2(input.parent.namespace);
-  assertIdentifier2(input.parent.name, "index parent");
-  assertProvenance(input.provenance);
-  const columns = [...input.columns];
-  for (const name of columns)
-    assertIdentifier2(name, "index column");
-  if (columns.length === 0 && input.expression === undefined) {
-    catalogError2("OKM1020", `Index on ${input.parent.name} needs a column or an expression.`);
-  }
-  const nameKey = input.nameKey ?? (columns.length > 0 ? columns.join("_") : "expr");
-  const name = input.name === undefined ? deterministicName2({ parent: input.parent.name, purpose: "index", nameKey }) : fitIdentifier2(input.name);
-  const parentView = {
-    kind: "materializedView",
-    namespace: input.parent.namespace,
-    name: input.parent.name
-  };
-  return {
-    kind: "index",
-    identity: { kind: "index", parent: input.parent, name },
-    owner: input.owner ?? "managed",
-    definition: {
-      columns,
-      unique: input.unique === true,
-      nameKey,
-      ...input.expression !== undefined ? { expression: input.expression } : {},
-      ...input.predicate !== undefined ? { predicate: input.predicate } : {}
-    },
-    dependencies: normaliseEdges(input.dependencies ?? [parentView]),
-    provenance: input.provenance
-  };
-}
-function readColumns(view, columns) {
-  assertIdentifier2(view, "view");
-  if (columns.length === 0)
-    catalogError2("OKM1020", `View ${view} needs a column.`);
-  const seen = new Set;
-  return columns.map((column) => {
-    assertIdentifier2(column.name, `view ${view} column`);
-    if (seen.has(column.name)) {
-      catalogError2("OKM1020", `View ${view} lists column ${column.name} twice.`);
-    }
-    seen.add(column.name);
-    if (column.dataType.length === 0 || /[;'"\\]/.test(column.dataType)) {
-      catalogError2("OKM1020", `View ${view} column ${column.name} type is not a type name.`);
-    }
-    return { name: column.name, dataType: column.dataType };
-  });
-}
-function readQuery(view, query) {
-  const text = normaliseViewQuery(query);
-  if (text.length === 0)
-    catalogError2("OKM1020", `View ${view} needs a query.`);
-  return text;
-}
-
-export { normaliseViewQuery, viewObject, materializedViewObject, materializedViewIndex };

package/dist/shared/{ywr8hmey.js → 606g0nbf.js}

@@ -1,3 +1,6 @@
+import {
+  readClientGenerator
+} from "./rwmrejjz.js";
 import {
   definition,
   rejected,
@@ -11,9 +14,6 @@ import {
   REFERENTIAL_ACTIONS,
   referentialAction
 } from "./4e4c6vq2.js";
-import {
-  readClientGenerator
-} from "./rwmrejjz.js";
 
 // src/dialects/pg/column.ts
 class ColumnBuilder2 {

package/dist/shared/{rpycarcr.js → gcefca6p.js}

@@ -1,11 +1,11 @@
-import {
-  definition,
-  unavailable
-} from "./tmbdywx0.js";
 import {
   callerLocation,
   withLocation
 } from "./y6jdds7g.js";
+import {
+  definition,
+  unavailable
+} from "./tmbdywx0.js";
 import {
   OkmError2,
   throwNamed2