okmodel 0.5.0 → 0.6.0

package/dist/tooling/testing/isolation.d.ts

@@ -1,18 +1,25 @@
 /**
  * Cross-tenant isolation check.
  *
- * For every tenant table, insert one row as tenant B and run the basic reads
- * and writes as tenant A. A returned row, a count above zero, or an update or
- * delete that touches a row is a leak. Global tables are skipped and listed.
- * Column tenancy is the strategy this version has. A table is tenant when its
- * predicate says so (D199).
+ * For every tenant table, insert one row as tenant B and run the reads and
+ * writes as tenant A against that row's key. A returned row, or an update or
+ * delete that touches it, is a leak. The row is deleted afterwards. Global
+ * tables are skipped and listed.
+ * A table is tenant when its predicate says so (D199). Composite tenancy changes
+ * one key at a time. A path table is checked through a parent that belongs to
+ * tenant B.
+ * Tenant views and materialized views are read the same way. The rows are
+ * inserted into the underlying tables, never into the view. A global view is
+ * skipped and listed with its `global("reason")`.
  */
 import { type FactoryHost } from "./factories.js";
-/** What {@link isolation} checked, and the global tables it skipped. */
+/** What {@link isolation} checked, and the global objects it skipped. */
 export type IsolationReport = {
     /** Tenant tables whose queries stayed inside tenant A. */
     readonly checked: readonly string[];
-    /** Global tables, with the reason from `global("reason")`. */
+    /** Tenant views and materialized views whose reads stayed inside tenant A. */
+    readonly views: readonly string[];
+    /** Global tables and views, with the reason from `global("reason")`. */
     readonly skipped: readonly {
         readonly table: string;
         readonly reason: string;
@@ -25,6 +32,6 @@ export type IsolationReport = {
  * already inserted is not reused as tenant B's row.
  *
  * @param host - The open harness
- * @returns The tables that were checked and the global tables that were not
+ * @returns The tables and views that were checked, and the global objects that were not
  */
 export declare function isolation(host: FactoryHost): Promise<IsolationReport>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "okmodel",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "okmodel is a catalog-first TypeScript ORM, PostgreSQL first.",
   "keywords": [
     "migrations",
@@ -23,9 +23,6 @@
     "okm": "./dist/okm.js",
     "okmodel": "./dist/okmodel.js"
   },
-  "workspaces": [
-    "packages/*"
-  ],
   "files": [
     "dist",
     "README.md",
@@ -112,7 +109,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 && 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/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",
     "driver-bench": "bun ./scripts/driver-bench.ts",
     "typecheck": "bunx tsc --noEmit -p tsconfig.json",
     "editor-check": "bun ./scripts/editor-check.ts",
@@ -129,6 +126,8 @@
     "compiler-api": "bun ./scripts/compiler-api.ts",
     "publint": "publint run . --strict --pack bun",
     "attw": "bun ./scripts/attw.ts",
+    "prepack": "bun ./scripts/strip-workspaces.ts strip",
+    "postpack": "bun ./scripts/strip-workspaces.ts restore",
     "size": "bun ./scripts/size.ts",
     "bundle-purity": "bun ./scripts/bundle-purity.ts",
     "test": "bun test",
@@ -143,6 +142,9 @@
     "bench": "bun ./packages/bench/src/run.ts",
     "catalog-bench": "bun ./scripts/catalog-bench.ts",
     "attest": "ATTEST_shouldFormat=0 ATTEST_updateSnapshots=0 bun ./packages/attest/src/measure.bench.ts",
+    "site:dev": "bun --cwd site dev",
+    "site:build": "bun --cwd site build",
+    "site:check": "bun --cwd site check",
     "publish:dry": "bun publish --dry-run",
     "prepublishOnly": "bun run build"
   },
@@ -157,6 +159,8 @@
     "oxlint": "^1.86.0",
     "oxlint-tsgolint": "^7.0.2003",
     "publint": "^0.3.24",
+    "temporal-polyfill": "^1.0.5",
+    "temporal-spec": "^1.0.1",
     "typescript": "7",
     "typescript-editor": "npm:typescript@6.0.3"
   },
@@ -177,6 +181,6 @@
     }
   },
   "engines": {
-    "node": ">=22"
+    "node": ">=22.18"
   }
 }

package/dist/shared/0v1g424p.js

@@ -1,26 +0,0 @@
-import {
-  OkmError2
-} from "./52szzakm.js";
-
-// src/dialects/pg/filter-parse.ts
-function parseQuery(allow, sort, query) {
-  if (typeof query !== "object" || query === null || Array.isArray(query)) {
-    throw new OkmError2("OKM1121", "filters parse expects an object of fields.");
-  }
-  const where = {};
-  let orderBy;
-  for (const key of Object.keys(query)) {
-    const value = query[key];
-    if (key === "sort" && typeof value === "string" && sort.includes(value)) {
-      orderBy = { [value]: "asc" };
-      continue;
-    }
-    if (allow[key]?.includes("eq") === true && (value === null || typeof value !== "object")) {
-      where[key] = value;
-    }
-  }
-  return orderBy === undefined ? { where } : { where, orderBy };
-}
-export {
-  parseQuery
-};

package/dist/shared/r73pt594.js

@@ -1,426 +0,0 @@
-import {
-  parseCatalog2
-} from "./8bwbwy8h.js";
-import"./wqem4jed.js";
-import"./n442h54c.js";
-import {
-  applyTarget2,
-  backfillTiming2
-} from "./xhh1srw3.js";
-import {
-  sealViews,
-  catalogQuery2,
-  managedRoleOptions2
-} from "./wxn4b7pp.js";
-import {
-  loadMigrations,
-  catalogsEqual,
-  snapshotDifference
-} from "./kdkxh3kb.js";
-import"./szm0cksa.js";
-import {
-  introspectSchema
-} from "./fancm5pt.js";
-import {
-  lintMigrationDirectory,
-  hasError,
-  lintRefusal,
-  selectTarget,
-  openProject
-} from "./xdpj5kkm.js";
-import {
-  canonicalTypeName,
-  classOf,
-  strictestClass,
-  planMigration,
-  parsePlan
-} from "./ayz64vzj.js";
-import {
-  quoteIdent
-} from "./8xsbagad.js";
-import {
-  catalog,
-  isDomain
-} from "./g7ez901n.js";
-import {
-  identityKey2
-} from "./t4tbsy9h.js";
-import {
-  OkmError2
-} from "./52szzakm.js";
-
-// src/tooling/migrate/check.ts
-import { readFileSync } from "node:fs";
-import { join } from "node:path";
-import postgres from "postgres";
-var CHECK_SCHEMA_PREFIX = "okm_check_";
-var HISTORY_CODE = "OKM1547";
-var PREVIOUS_CODE = "OKM1548";
-var STALE_CODE = "OKM1549";
-var HISTORY_FIX = "Regenerate the migration so the stored catalog matches the schema the SQL applies.";
-var FORK_FIX = "Generate the later migration from the previous migration's catalog, not from an older parent.";
-var PREVIOUS_FIX = "Keep every table, column, constraint, and type the previous catalog relies on, or classify the migration as contract.";
-var STALE_FIX = "Run okm generate.";
-async function checkMigrations(cwd, flags, options) {
-  const opened = await openProject(cwd);
-  const target = selectTarget(opened.config, flags.target);
-  if (target.protected) {
-    throw new OkmError2("OKM1850", `okm migrate check writes a scratch schema and refuses protected target ${target.name}. Point it at a throwaway Postgres.`, {
-      kind: "forbidden",
-      fix: {
-        summary: "Point okm migrate check at a throwaway Postgres. --allow-protected does not apply."
-      }
-    });
-  }
-  const directory = join(cwd, opened.config.migrations ?? "migrations");
-  const history = readHistory(directory);
-  if (options?.provision === true) {
-    const equivalence = await proveSnapshot(opened.config, target.url, target.name, flags, history);
-    if (equivalence !== undefined)
-      throwFailure([equivalence]);
-  }
-  const previous = previousFailures(history);
-  const stale = staleFailure(history, opened.built.catalog);
-  const lint = lintFailure(directory, history, opened.config.lintFrom);
-  const replayed = await replayHistory(opened.config, target.url, target.name, flags, history);
-  const failures = [...replayed, ...previous, ...stale, ...lint];
-  if (failures.length > 0)
-    throwFailure(failures);
-  return `ok ${String(history.length)} migrations
-`;
-}
-function previousCatalogGaps(before, after) {
-  const afterBy = new Map(after.objects.map((object) => [identityKey2(object.identity), object]));
-  const gaps = [];
-  for (const object of before.objects) {
-    if (!checkedKind(object.kind))
-      continue;
-    const next = afterBy.get(identityKey2(object.identity));
-    if (next === undefined || next.kind !== object.kind) {
-      gaps.push(`${objectLabel(object)} is missing`);
-      continue;
-    }
-    if (object.kind === "column" && next.kind === "column") {
-      gaps.push(...columnGaps(object, next));
-    }
-    if (object.kind === "type" && next.kind === "type" && !sameType(object.definition, next.definition)) {
-      gaps.push(`${objectLabel(object)} changed`);
-    }
-  }
-  return gaps;
-}
-function recomputedMigrationClass(plan, before, after) {
-  if (plan.steps.length === 0)
-    return "expand";
-  if (plan.steps.some((step) => step.kind === undefined)) {
-    return planMigration({ before, after, name: plan.name }).class;
-  }
-  return strictestClass(plan.steps.map((step) => classOf(step.kind ?? "raw-sql")));
-}
-function migrationAllowsPreviousGaps(plan, before, after) {
-  return recomputedMigrationClass(plan, before, after) === "contract" && plan.class !== "expand";
-}
-function previousFailures(history) {
-  const failures = [];
-  let before = catalog([]);
-  for (const migration of history) {
-    const gaps = previousCatalogGaps(before, migration.catalog);
-    if (gaps.length > 0 && !migrationAllowsPreviousGaps(migration.plan, before, migration.catalog)) {
-      const stated = migration.plan.class === "expand" ? "expand" : recomputedMigrationClass(migration.plan, before, migration.catalog);
-      failures.push({
-        code: PREVIOUS_CODE,
-        message: `${migration.id}: previous catalog is not satisfied (${gaps.join("; ")}). The migration is classified ${stated}.`,
-        fix: PREVIOUS_FIX
-      });
-    }
-    before = migration.catalog;
-  }
-  return failures;
-}
-function staleFailure(history, head) {
-  const last = history.at(-1)?.catalog ?? catalog([]);
-  if (catalogsEqual(last, head))
-    return [];
-  return [
-    {
-      code: STALE_CODE,
-      message: "The last migration's catalog does not match the schema.",
-      fix: STALE_FIX
-    }
-  ];
-}
-function lintFailure(directory, history, lintFrom) {
-  const findings = lintMigrationDirectory(directory, lintIds(history, lintFrom));
-  if (!hasError(findings))
-    return [];
-  const refusal = lintRefusal(findings);
-  return [{ code: refusal.code, message: refusal.message, fix: refusal.fix.summary }];
-}
-function lintIds(history, lintFrom) {
-  if (lintFrom === undefined)
-    return;
-  const ids = history.map((migration) => migration.id);
-  const start = ids.indexOf(lintFrom);
-  if (start < 0) {
-    throw new OkmError2("invalid", `lintFrom ${lintFrom} is not a migration id.`, {
-      fix: {
-        summary: "Set lintFrom to a migration id. Files before that id are the adoption baseline and are not linted."
-      }
-    });
-  }
-  return new Set(ids.slice(start));
-}
-async function proveSnapshot(config, url, target, flags, history) {
-  const head = history.at(-1);
-  if (head === undefined)
-    return;
-  const sql = postgres(url, {
-    max: 1,
-    connect_timeout: 5,
-    idle_timeout: 1,
-    onnotice: () => {}
-  });
-  const provided = `${CHECK_SCHEMA_PREFIX}p${crypto.randomUUID().replaceAll("-", "")}`;
-  const replayed = `${CHECK_SCHEMA_PREFIX}r${crypto.randomUUID().replaceAll("-", "")}`;
-  const timing = {
-    ...flags.lockTimeoutMs !== undefined ? { lockTimeoutMs: flags.lockTimeoutMs } : config.timeouts?.lock !== undefined ? { lockTimeoutMs: config.timeouts.lock } : {},
-    ...flags.statementTimeoutMs !== undefined ? { statementTimeoutMs: flags.statementTimeoutMs } : config.timeouts?.statement !== undefined ? { statementTimeoutMs: config.timeouts.statement } : {},
-    ...backfillTiming2(config.backfill)
-  };
-  try {
-    await sql.unsafe(`create schema ${quoteIdent(provided)}`);
-    await sql.unsafe(`create schema ${quoteIdent(replayed)}`);
-    const role = config.roles === undefined ? {} : { migrationRole: config.roles.migration, schema: provided };
-    await applyTarget2({
-      url,
-      target,
-      protected: false,
-      allowProtected: false,
-      allowPooler: flags.allowPooler || config.allowPooler === true,
-      searchPath: provided,
-      ...timing,
-      migrations: history.map((migration) => ({
-        id: migration.id,
-        catalogHash: migration.catalogHash,
-        steps: migration.steps
-      })),
-      snapshot: {
-        catalog: head.catalog,
-        migrationId: head.id,
-        catalogHash: head.catalogHash,
-        reference: [],
-        only: true
-      },
-      ...role
-    });
-    await applyTarget2({
-      url,
-      target,
-      protected: false,
-      allowProtected: false,
-      allowPooler: flags.allowPooler || config.allowPooler === true,
-      searchPath: replayed,
-      ...timing,
-      migrations: history.map((migration) => ({
-        id: migration.id,
-        catalogHash: migration.catalogHash,
-        steps: retargetSteps(migration.steps, replayed)
-      })),
-      ...config.roles !== undefined ? { migrationRole: config.roles.migration, schema: replayed } : {}
-    });
-    const liveProvided = await introspectScratch(sql, provided, config);
-    const liveReplayed = await introspectScratch(sql, replayed, config);
-    const difference = snapshotDifference(liveProvided, liveReplayed);
-    if (difference === undefined)
-      return;
-    return {
-      code: "OKM1521",
-      message: `Provisioning from the snapshot does not match the replayed history.
-${difference}`,
-      fix: "Regenerate the snapshot from the history. okm migrate check --provision is the command that reports this."
-    };
-  } finally {
-    await sql.unsafe(`drop schema if exists ${quoteIdent(provided)} cascade`).catch(() => {
-      return;
-    });
-    await sql.unsafe(`drop schema if exists ${quoteIdent(replayed)} cascade`).catch(() => {
-      return;
-    });
-    await sql.end({ timeout: 5 });
-  }
-}
-async function replayHistory(config, url, target, flags, history) {
-  if (history.length === 0)
-    return [];
-  const sql = postgres(url, {
-    max: 1,
-    connect_timeout: 5,
-    idle_timeout: 1,
-    onnotice: () => {}
-  });
-  const scratch = `${CHECK_SCHEMA_PREFIX}${crypto.randomUUID().replaceAll("-", "")}`;
-  const failures = [];
-  try {
-    await sql.unsafe(`create schema ${quoteIdent(scratch)}`);
-    const runner = catalogQuery2(sql);
-    for (let index = 0;index < history.length; index += 1) {
-      const migration = history[index];
-      if (migration === undefined)
-        continue;
-      await applyTarget2({
-        url,
-        target,
-        protected: false,
-        allowProtected: false,
-        allowPooler: flags.allowPooler || config.allowPooler === true,
-        searchPath: scratch,
-        ...flags.lockTimeoutMs !== undefined ? { lockTimeoutMs: flags.lockTimeoutMs } : config.timeouts?.lock !== undefined ? { lockTimeoutMs: config.timeouts.lock } : {},
-        ...flags.statementTimeoutMs !== undefined ? { statementTimeoutMs: flags.statementTimeoutMs } : config.timeouts?.statement !== undefined ? { statementTimeoutMs: config.timeouts.statement } : {},
-        ...backfillTiming2(config.backfill),
-        migrations: [
-          {
-            id: migration.id,
-            catalogHash: migration.catalogHash,
-            steps: retargetSteps(migration.steps, scratch)
-          }
-        ],
-        ...config.roles !== undefined ? { migrationRole: config.roles.migration, schema: scratch } : {}
-      });
-      const live = await introspectScratch(sql, scratch, config);
-      const sealed = await sealViews(runner, migration.catalog);
-      const back = planMigration({ before: live, after: sealed, name: migration.id });
-      if (back.steps.length === 0)
-        continue;
-      failures.push(historyFailure(history, index, back));
-      break;
-    }
-  } finally {
-    await sql.unsafe(`drop schema if exists ${quoteIdent(scratch)} cascade`).catch(() => {
-      return;
-    });
-    await sql.end({ timeout: 5 });
-  }
-  return failures;
-}
-async function introspectScratch(sql, schema, config) {
-  await sql.unsafe(`set search_path to ${quoteIdent(schema)}`);
-  return introspectSchema(catalogQuery2(sql), schema, "public", managedRoleOptions2(config.roles));
-}
-function historyFailure(history, index, back) {
-  const migration = history[index];
-  const id = migration?.id ?? "migration";
-  const fork = migration === undefined ? undefined : forkMessage(history, index);
-  if (fork !== undefined)
-    return { code: HISTORY_CODE, message: fork, fix: FORK_FIX };
-  const steps = back.steps.map((step) => step.sql).join(`
-`);
-  return {
-    code: HISTORY_CODE,
-    message: `${id}: history differs from the stored catalog
-${steps}`,
-    fix: HISTORY_FIX
-  };
-}
-function forkMessage(history, index) {
-  const current = history[index];
-  const previous = history[index - 1];
-  if (current === undefined || previous === undefined)
-    return;
-  if (samePlan(previous.catalog, current.catalog, current.plan))
-    return;
-  for (let parentIndex = 0;parentIndex < index; parentIndex += 1) {
-    const parent = parentIndex === 0 ? catalog([]) : history[parentIndex - 1]?.catalog;
-    if (parent === undefined)
-      continue;
-    if (!samePlan(parent, current.catalog, current.plan))
-      continue;
-    return `migration ${current.id} was generated from a different parent than ${previous.id}`;
-  }
-  return;
-}
-function samePlan(before, after, file) {
-  try {
-    return sameSql(planMigration({ before, after, name: "parent" }), file);
-  } catch (error) {
-    if (error instanceof OkmError2 && error.code === "OKM1530")
-      return false;
-    throw error;
-  }
-}
-function sameSql(planned, file) {
-  if (planned.steps.length !== file.steps.length)
-    return false;
-  return planned.steps.every((step, index) => step.sql === file.steps[index]?.sql);
-}
-function retargetSteps(steps, schema) {
-  const from = `${quoteIdent("public")}.`;
-  const to = `${quoteIdent(schema)}.`;
-  const fromDefaults = `in schema ${quoteIdent("public")} `;
-  const toDefaults = `in schema ${quoteIdent(schema)} `;
-  return steps.map((step) => ({
-    ...step,
-    sql: step.sql.replaceAll(from, to).replaceAll(fromDefaults, toDefaults),
-    ...step.backfill === undefined ? {} : { backfill: { ...step.backfill, table: step.backfill.table.replaceAll(from, to) } }
-  }));
-}
-function readHistory(directory) {
-  return loadMigrations(directory).map((migration) => ({
-    id: migration.id,
-    catalogHash: migration.catalogHash,
-    steps: migration.steps,
-    plan: parsePlan(readFileSync(join(directory, `${migration.id}.sql`), "utf8")),
-    catalog: parseCatalog2(readFileSync(join(directory, `${migration.id}.catalog.json`), "utf8"))
-  }));
-}
-function throwFailure(failures) {
-  const first = failures[0];
-  if (first === undefined)
-    throw new Error("okm migrate check has no failure to report.");
-  const message = failures.length === 1 ? first.message : failures.map((failure) => `${failure.code} ${failure.message}`).join(`
-`);
-  throw new OkmError2(first.code, message, { fix: { summary: first.fix } });
-}
-function checkedKind(kind) {
-  return kind === "table" || kind === "column" || kind === "constraint" || kind === "type";
-}
-function columnGaps(before, after) {
-  const gaps = [];
-  const place = objectLabel(before);
-  if (canonicalTypeName(before.definition.dataType) !== canonicalTypeName(after.definition.dataType)) {
-    gaps.push(`${place} changed type from ${before.definition.dataType} to ${after.definition.dataType}`);
-  }
-  if (before.definition.nullable && !after.definition.nullable && !columnHasDefault(after)) {
-    gaps.push(`${place} nullability tightened without a default`);
-  }
-  return gaps;
-}
-function columnHasDefault(column) {
-  return column.definition.defaultExpression !== undefined || column.definition.identity !== undefined || column.definition.generated !== undefined;
-}
-function sameType(before, after) {
-  const beforeDomain = isDomain(before);
-  const afterDomain = isDomain(after);
-  if (beforeDomain !== afterDomain)
-    return false;
-  if (beforeDomain && afterDomain) {
-    return canonicalTypeName(before.base) === canonicalTypeName(after.base) && before.check === after.check;
-  }
-  if (!beforeDomain && !afterDomain) {
-    if (before.labels.length !== after.labels.length)
-      return false;
-    return before.labels.every((label, index) => label === after.labels[index]);
-  }
-  return false;
-}
-function objectLabel(object) {
-  if (object.kind === "column" || object.kind === "constraint") {
-    return `${object.kind} ${object.identity.parent.name}.${object.identity.name}`;
-  }
-  if (object.kind === "table" || object.kind === "type") {
-    return `${object.kind} ${object.identity.name}`;
-  }
-  return object.kind;
-}
-export {
-  checkMigrations
-};

package/dist/shared/rasvvzgz.js

@@ -1,21 +0,0 @@
-import {
-  applyTarget2,
-  applyProject2,
-  pushProject2,
-  backfillTiming2
-} from "./xhh1srw3.js";
-import"./kdkxh3kb.js";
-import"./szm0cksa.js";
-import"./fancm5pt.js";
-import"./xdpj5kkm.js";
-import"./ayz64vzj.js";
-import"./n442h54c.js";
-import"./8xsbagad.js";
-import"./8bwbwy8h.js";
-import"./wqem4jed.js";
-export {
-  applyProject2 as applyProject,
-  applyTarget2 as applyTarget,
-  backfillTiming2 as backfillTiming,
-  pushProject2 as pushProject
-};