okmodel 0.1.1 → 0.2.1

package/dist/shared/ytg3xf9p.js

@@ -0,0 +1,149 @@
+import {
+  noticeBuffer,
+  WireSession,
+  cursorStream
+} from "./cstgkzdx.js";
+import {
+  BUNSQL_CAPABILITIES,
+  driverErrors,
+  rejectClosed,
+  mapFailure,
+  runCall
+} from "./9k6vetvf.js";
+
+// src/adapters/pg/bunsql.ts
+import { SQL } from "bun";
+function open5(config) {
+  const max = config.max ?? 10;
+  const acquireMs = config.timeouts?.acquire;
+  const counters = { reserved: 0, busy: 0, reservedBusy: 0, waiting: 0 };
+  const notices = noticeBuffer();
+  let closed = false;
+  const isClosed = () => closed;
+  const named = config.prepared === "named";
+  const parked = [];
+  const sql = new SQL(config.url, {
+    max,
+    idleTimeout: 0,
+    maxLifetime: 0,
+    prepare: named,
+    bigint: false,
+    connectionTimeout: 5,
+    connection: {
+      application_name: "okmodel",
+      ...config.searchPath !== undefined ? { search_path: config.searchPath } : {}
+    },
+    ...config.ssl !== undefined ? { tls: config.ssl } : {}
+  });
+  const root = new WireSession((text, params) => send2(sql, text, params), notices, isClosed, false, () => {
+    counters.busy += 1;
+  }, () => {
+    counters.busy = Math.max(0, counters.busy - 1);
+  });
+  const held = { sql, parked, acquireMs, counters, notices, isClosed };
+  const checkout = () => closed ? rejectClosed() : import("./97g2jnrw.js").then((mod) => mod.checkout(held));
+  return {
+    capabilities: BUNSQL_CAPABILITIES,
+    execute(text, params, options) {
+      return runCall(closed, options, async (watch) => {
+        await releaseParked(parked);
+        return root.query(text, params, watch);
+      });
+    },
+    async batch(statements, options) {
+      const connection = await checkout();
+      try {
+        return await connection.batch(statements, options);
+      } finally {
+        await connection.release();
+      }
+    },
+    reserve: () => checkout(),
+    stream(text, params) {
+      return stream(text, params);
+    },
+    listen(channel, onNotify) {
+      return listen(channel, onNotify);
+    },
+    stats: () => statsOf(counters, max),
+    async close() {
+      closed = true;
+      await releaseParked(parked);
+      await sql.close();
+    }
+  };
+  function stream(text, params) {
+    return async function* () {
+      const connection = await checkout();
+      try {
+        yield* cursorStream((statement, values) => connection.execute(statement, values), text, params);
+      } finally {
+        await connection.release();
+      }
+    }();
+  }
+  async function listen(channel, onNotify) {
+    if (closed)
+      return rejectClosed();
+    await releaseParked(parked);
+    const subscription = await sql.listen(channel, onNotify);
+    return async () => {
+      await subscription.unlisten();
+    };
+  }
+}
+function send2(sql, text, params) {
+  if (params === undefined || params.length === 0)
+    return sql.unsafe(text).raw();
+  return sql.unsafe(text, [...params]).raw();
+}
+async function reserve(sql, acquireMs, counters) {
+  counters.waiting += 1;
+  try {
+    if (acquireMs === undefined)
+      return await sql.reserve();
+    return await sql.reserve({ signal: AbortSignal.timeout(acquireMs) });
+  } catch (error) {
+    if (isAbort(error)) {
+      const errors = await driverErrors();
+      throw errors.acquireTimeout();
+    }
+    throw await mapFailure(error);
+  } finally {
+    counters.waiting = Math.max(0, counters.waiting - 1);
+  }
+}
+async function park(parked, reserved) {
+  parked.push(reserved);
+  while (parked.length > 1) {
+    const extra = parked.shift();
+    if (extra !== undefined)
+      await releaseReserved(extra);
+  }
+}
+async function releaseParked(parked) {
+  const pending = parked.splice(0);
+  for (const reserved of pending)
+    await releaseReserved(reserved);
+}
+function releaseReserved(reserved) {
+  const done = reserved.release();
+  return done instanceof Promise ? done.then(() => {
+    return;
+  }) : Promise.resolve();
+}
+function isAbort(error) {
+  if (!(error instanceof Error))
+    return false;
+  return error.name === "AbortError" || error.name === "TimeoutError";
+}
+function statsOf(counters, size) {
+  return {
+    size,
+    idle: Math.max(0, size - counters.reserved - counters.busy),
+    inflight: counters.busy + counters.reservedBusy,
+    waiting: counters.waiting
+  };
+}
+
+export { open5, send2, reserve, park };

package/dist/shared/yw5c610b.js

@@ -0,0 +1,48 @@
+import {
+  required
+} from "./dd4f8mnx.js";
+import {
+  rejected
+} from "./xatfg0gn.js";
+
+// src/dialects/pg/json.ts
+function jsonReplacer2(_key, value) {
+  if (typeof value === "bigint") {
+    return value.toString();
+  }
+  return value;
+}
+function json2() {
+  return required({
+    baseType: "json",
+    encode: encodeJson,
+    decode: decodeJson,
+    accepts: ["Array", "Object"],
+    sqlForm: "json"
+  });
+}
+function jsonb2() {
+  return required({
+    baseType: "jsonb",
+    encode: encodeJson,
+    decode: decodeJson,
+    accepts: ["Array", "Object"],
+    sqlForm: "jsonb"
+  });
+}
+function encodeJson(value) {
+  const text = JSON.stringify(value, jsonReplacer2);
+  if (text === undefined) {
+    rejected("json value must be JSON data. undefined and functions are not accepted. bigint is written as a decimal string.");
+  }
+  return text;
+}
+function decodeJson(wire) {
+  try {
+    return JSON.parse(wire);
+  } catch {
+    rejected("json text must be JSON, for example null, a string, a number, true, {}, or [].");
+  }
+}
+
+export { jsonReplacer2, json2, jsonb2, encodeJson };

package/dist/shared/zd93g3rq.js

@@ -0,0 +1,31 @@
+import {
+  withHttp
+} from "./mxmcdsh5.js";
+import {
+  decodeResult
+} from "./xrfnq5k8.js";
+import {
+  OkmError2
+} from "./52szzakm.js";
+
+// src/runtime/read-stream.ts
+async function* streamRows(session, call, prepare, log) {
+  await session.connected;
+  if (session.pool.capabilities.stream !== true || session.pool.stream === undefined) {
+    throw log(new OkmError2("OKM1111", "stream needs a driver with stream: true. This driver does not have it.", withHttp(session.http, {
+      fix: { summary: "Use a driver that sets stream, or read with find." }
+    })));
+  }
+  const { plan, params } = await prepare();
+  const decode = plan.outputs.includes.length === 0 ? decodeResult : (await import("./edwqqryd.js")).decodeIncluded;
+  for await (const chunk of session.pool.stream(plan.text, params)) {
+    const decoded = decode(plan, chunk, call.table);
+    if (!Array.isArray(decoded))
+      continue;
+    for (const row of decoded)
+      yield row;
+  }
+}
+export {
+  streamRows
+};

package/dist/shared/zt8y0wzb.js

@@ -0,0 +1,132 @@
+import {
+  writeArray
+} from "./xatfg0gn.js";
+import {
+  OkmError2
+} from "./52szzakm.js";
+
+// src/dialects/pg/operator-fit.ts
+var FAMILIES = {
+  startsWith: ["text"],
+  endsWith: ["text"],
+  like: ["text"],
+  ilike: ["text"],
+  contains: ["text", "array", "jsonb", "range"],
+  containedBy: ["array", "jsonb", "range"],
+  overlaps: ["array", "range"],
+  hasKey: ["jsonb"],
+  hasAnyKey: ["jsonb"],
+  path: ["json", "jsonb"],
+  matches: ["tsvector"],
+  "json.set": ["json", "jsonb"],
+  "arr.append": ["array"],
+  "arr.remove": ["array"]
+};
+var ACCEPTED = {
+  text: [
+    "eq",
+    "not",
+    "lt",
+    "lte",
+    "gt",
+    "gte",
+    "between",
+    "startsWith",
+    "contains",
+    "endsWith",
+    "like",
+    "ilike",
+    "inList",
+    "notIn"
+  ],
+  array: [
+    "eq",
+    "not",
+    "contains",
+    "containedBy",
+    "overlaps",
+    "inList",
+    "notIn",
+    "arr.append",
+    "arr.remove"
+  ],
+  jsonb: ["eq", "not", "contains", "containedBy", "hasKey", "hasAnyKey", "path", "json.set"],
+  json: ["eq", "not", "path", "json.set"],
+  range: ["eq", "not", "lt", "lte", "gt", "gte", "contains", "containedBy", "overlaps"],
+  tsvector: ["eq", "not", "matches"],
+  scalar: ["eq", "not", "lt", "lte", "gt", "gte", "between", "inList", "notIn", "inc"]
+};
+var SAFE_TYPE = /^[A-Za-z_][A-Za-z0-9_]*(\(\d+\))?(\[\])*$/;
+var REGCONFIG = /^[A-Za-z_][A-Za-z0-9_]*(\.[A-Za-z_][A-Za-z0-9_]*)?$/;
+function columnFamily(dataType) {
+  if (dataType.endsWith("[]"))
+    return "array";
+  if (dataType === "jsonb")
+    return "jsonb";
+  if (dataType === "json")
+    return "json";
+  if (dataType === "tsvector")
+    return "tsvector";
+  if (dataType.endsWith("range"))
+    return "range";
+  if (dataType === "text" || dataType === "citext" || dataType.startsWith("varchar(") || dataType.startsWith("char(") || dataType.startsWith("character")) {
+    return "text";
+  }
+  return "scalar";
+}
+function assertOperatorFits(column, name) {
+  const families = FAMILIES[name];
+  if (families === undefined)
+    return;
+  if (families.includes(columnFamily(column.dataType)))
+    return;
+  const accepted = ACCEPTED[columnFamily(column.dataType)];
+  const search = name === "matches" && columnFamily(column.dataType) === "text" ? " Text search needs a tsvector column." : "";
+  throw new OkmError2("OKM1124", `Operator ${name} does not apply to ${column.dataType} column ${column.field}. Accepted operators: ${accepted.join(", ")}.${search}`, { fix: { summary: `Use one of: ${accepted.join(", ")}.` } });
+}
+function sqlType(dataType, column) {
+  if (SAFE_TYPE.test(dataType))
+    return dataType;
+  assertOperatorFits(column, "contains");
+  throw new OkmError2("OKM1124", `Operator contains does not apply to ${column.dataType} column ${column.field}. Accepted operators: ${ACCEPTED[columnFamily(column.dataType)].join(", ")}.`, { fix: { summary: "Use a column type this operator accepts." } });
+}
+function assertNoControl(value, role) {
+  for (let index = 0;index < value.length; index += 1) {
+    const code = value.charCodeAt(index);
+    if (code <= 31 || code === 127) {
+      throw new OkmError2("OKM1122", `${role} contains a control character.`, {
+        fix: { summary: "Remove NUL and other control characters. The value is not sent." }
+      });
+    }
+  }
+}
+function assertBoundText(value, role) {
+  if (value.length === 0) {
+    throw new OkmError2("OKM1122", `${role} is empty.`, {
+      fix: { summary: "Pass a non-empty key or path segment." }
+    });
+  }
+  assertNoControl(value, role);
+}
+function assertRegconfig(config) {
+  if (!REGCONFIG.test(config)) {
+    throw new OkmError2("OKM1122", `Text search config ${config} must be a regconfig name such as english or pg_catalog.simple.`, { fix: { summary: "Pass a regconfig name. Quotes and extra clauses are not accepted." } });
+  }
+}
+function textArray(values, role) {
+  for (const value of values)
+    assertBoundText(value, role);
+  return writeArray(values, 1, (value) => String(value), false);
+}
+function arrayElementType(dataType, column) {
+  if (!dataType.endsWith("[]")) {
+    assertOperatorFits(column, "arr.append");
+  }
+  const element = dataType.slice(0, -2);
+  if (!SAFE_TYPE.test(element)) {
+    throw new OkmError2("OKM1124", `Operator arr.append does not apply to ${column.dataType} column ${column.field}. Accepted operators: ${ACCEPTED.array.join(", ")}.`, { fix: { summary: "Use arr.append on an array column." } });
+  }
+  return element;
+}
+
+export { assertOperatorFits, sqlType, assertNoControl, assertBoundText, assertRegconfig, textArray, arrayElementType };

package/dist/shared/{p0cbr3g2.js → zwmqxb0g.js}

@@ -1,6 +1,6 @@
 import {
   OkmError2
-} from "./ycwz42az.js";
+} from "./52szzakm.js";
 
 // src/runtime/drift-detail.ts
 function driftVerdict(codeHash, recordedHash, migrations) {

package/dist/tooling/cli.js

@@ -1,14 +1,15 @@
-import"../shared/y9m15dfv.js";
+import"../shared/d2whjz4k.js";
+import"../shared/n442h54c.js";
 import {
   formatPlan,
   buildProject,
   generateProject,
   planProject,
   checkProject
-} from "../shared/05w44d8g.js";
+} from "../shared/5z4q2zda.js";
 import {
   OkmError2
-} from "../shared/ycwz42az.js";
+} from "../shared/52szzakm.js";
 
 // src/tooling/cli.ts
 import { readFileSync } from "node:fs";
@@ -16,6 +17,11 @@ import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 
 // src/tooling/migrate/commands.ts
+function formatFailure(error) {
+  return `${error.code}: ${error.message}
+${error.fix.summary}
+`;
+}
 async function run(argv, io) {
   const cwd = io?.cwd ?? process.cwd();
   const stdout = io?.stdout ?? ((text) => process.stdout.write(text));
@@ -41,12 +47,12 @@ async function run(argv, io) {
     return;
   }
   if (command === "dev") {
-    const { devProject } = await import("../shared/kprcwaha.js");
+    const { devProject } = await import("../shared/eaxwrgby.js");
     stdout(await devProject(cwd));
     return;
   }
   if (command === "push") {
-    const { pushProject } = await import("../shared/m3ypagh5.js");
+    const { pushProject } = await import("../shared/eqmtn1bj.js");
     stdout(await pushProject(cwd, invoke(splitFlags(rest))));
     return;
   }
@@ -61,12 +67,12 @@ async function run(argv, io) {
       return;
     }
     if (sub === "apply") {
-      const { applyProject } = await import("../shared/m3ypagh5.js");
+      const { applyProject } = await import("../shared/eqmtn1bj.js");
       stdout(await applyProject(cwd, invoke(parsed)));
       return;
     }
     if (sub === "status") {
-      const { statusProject } = await import("../shared/523ft3e8.js");
+      const { statusProject } = await import("../shared/d04j53v8.js");
       stdout(await statusProject(cwd, invoke(parsed)));
       return;
     }
@@ -172,9 +178,7 @@ if (process.argv.includes("--version")) {
     await run(process.argv.slice(2));
   } catch (error) {
     if (error instanceof OkmError2) {
-      process.stderr.write(`${error.code}: ${error.message}
-${error.fix.summary}
-`);
+      process.stderr.write(formatFailure(error));
       process.exitCode = 1;
     } else {
       throw error;

package/dist/tooling/migrate/commands.d.ts

@@ -4,11 +4,21 @@
  * The bin wrapper imports {@link run}. Importing this module does not parse
  * `process.argv`.
  */
+import { OkmError } from "../../contracts/error.js";
 /** Where a command reads the project and writes its text. */
 export type CommandIo = {
     readonly cwd?: string;
     readonly stdout?: (text: string) => void;
 };
+/**
+ * Text `okm` writes for a failure.
+ *
+ * The message includes a source location when the schema recorded one.
+ *
+ * @param error - Failure from a command
+ * @returns The stderr text, including the trailing newline
+ */
+export declare function formatFailure(error: OkmError): string;
 /**
  * Runs one `okm` invocation.
  *

package/dist/tooling/migrate/engine.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Engine-version checks `okm migrate apply` runs before the first statement.
+ *
+ * The only engine-dependent feature in 0.2 is a `uuidv7()` database default,
+ * which Postgres has from 18. Nothing here is reachable from `connect()`.
+ */
+import type { DriverConnection } from "../../contracts/driver.js";
+import type { StoredMigration } from "./files.js";
+/** Where a migration sets a `uuidv7()` default. */
+export type UuidV7Default = {
+    readonly migrationId: string;
+    readonly stepIndex: number;
+    /** `table.column`, or `undefined` when the statement does not name both. */
+    readonly column: string | undefined;
+};
+/**
+ * Finds the first pending step that sets a `uuidv7()` database default.
+ *
+ * Only `default uuidv7()` counts, so a string in a data step is not a hit.
+ *
+ * @param migrations - Migrations in apply order
+ * @returns The first hit, or `undefined`
+ */
+export declare function findUuidV7Default(migrations: readonly StoredMigration[]): UuidV7Default | undefined;
+/**
+ * Refuses a run that would set a `uuidv7()` default on a server that has none.
+ *
+ * The server is asked only when a step needs it, so a schema without the
+ * default costs no round trip. A server below 18 that already has a
+ * `uuidv7()` function, such as one the application defined, is accepted.
+ *
+ * @param connection - The reserved apply connection
+ * @param migrations - Migrations in apply order
+ * @throws OkmError OKM1812, before any statement of the plan runs
+ */
+export declare function assertUuidV7Available(connection: DriverConnection, migrations: readonly StoredMigration[]): Promise<void>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "okmodel",
-  "version": "0.1.1",
-  "description": "okmodel is a catalog-first TypeScript ORM, PostgreSQL first. Other SQL databases are the direction. Version 0.1 supports PostgreSQL only. The schema is the single source. Migrations and queries come from it.",
+  "version": "0.2.1",
+  "description": "okmodel is a catalog-first TypeScript ORM, PostgreSQL first.",
   "keywords": [
     "migrations",
     "orm",
@@ -57,10 +57,38 @@
     "./pg/pglite": {
       "types": "./dist/runtime/pg/pglite.d.ts",
       "import": "./dist/runtime/pg/pglite.js"
+    },
+    "./pg/pg": {
+      "types": "./dist/runtime/pg/pg.d.ts",
+      "import": "./dist/runtime/pg/pg.js"
+    },
+    "./pg/bun": {
+      "types": "./dist/runtime/pg/bun.d.ts",
+      "import": "./dist/runtime/pg/bun.js"
+    },
+    "./ids": {
+      "types": "./dist/runtime/ids/index.d.ts",
+      "import": "./dist/runtime/ids/index.js"
+    },
+    "./safety": {
+      "types": "./dist/runtime/safety/index.d.ts",
+      "import": "./dist/runtime/safety/index.js"
+    },
+    "./traits": {
+      "types": "./dist/runtime/traits/index.d.ts",
+      "import": "./dist/runtime/traits/index.js"
+    },
+    "./tenancy": {
+      "types": "./dist/runtime/tenancy/index.d.ts",
+      "import": "./dist/runtime/tenancy/index.js"
+    },
+    "./validate": {
+      "types": "./dist/runtime/validate/index.d.ts",
+      "import": "./dist/runtime/validate/index.js"
     }
   },
   "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/tooling/migrate/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 && bunx tsc -p tsconfig.build.json && 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/ids/index.ts ./src/runtime/safety/index.ts ./src/runtime/traits/index.ts ./src/runtime/tenancy/index.ts ./src/runtime/validate/index.ts ./src/tooling/migrate/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 && 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",
@@ -70,6 +98,8 @@
     "format:check": "oxfmt --check",
     "layers-check": "bun ./scripts/layers-check.ts",
     "core-purity": "bun ./scripts/core-purity.ts",
+    "okid-drift": "bun ./scripts/okid-drift.ts",
+    "test:runtimes": "bun ./scripts/runtimes.ts",
     "docs:check": "bun ./scripts/docs-check.ts",
     "readme:check": "bun ./scripts/readme-check.ts",
     "compiler-api": "bun ./scripts/compiler-api.ts",
@@ -81,7 +111,7 @@
     "test:postgres": "bun ./scripts/postgres-suite.ts",
     "test:tarball": "bun ./scripts/tarball-smoke.ts",
     "verify": "bun ./scripts/verify.ts",
-    "check": "bun run format:check && bun run lint && bun run typecheck && bun run editor-check && bun run type-cost && bun run layers-check && bun run core-purity && bun run docs:check && bun run readme:check && bun run compiler-api && bun run bundle-purity && bun run build && bun test && bun run publint && bun run attw && bun run size",
+    "check": "bun run format:check && bun run lint && bun run typecheck && bun run editor-check && bun run type-cost && bun run layers-check && bun run core-purity && bun run okid-drift && bun run docs:check && bun run readme:check && bun run compiler-api && bun run bundle-purity && bun run build && bun test && bun run test:runtimes && bun run publint && bun run attw && bun run size",
     "bump": "bun ./scripts/bump-version.ts",
     "release-check": "bun ./scripts/release-check.ts",
     "db:up": "bun ./packages/harness/src/docker-cli.ts up",
@@ -108,14 +138,21 @@
   },
   "peerDependencies": {
     "@electric-sql/pglite": "^0.5.8",
+    "pg": "^8.16.0",
     "postgres": "^3.4.9"
   },
   "peerDependenciesMeta": {
     "@electric-sql/pglite": {
       "optional": true
     },
+    "pg": {
+      "optional": true
+    },
     "postgres": {
       "optional": true
     }
+  },
+  "engines": {
+    "node": ">=22"
   }
 }