okmodel 0.0.0 → 0.1.0

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

@@ -0,0 +1,74 @@
+/**
+ * `okm migrate status`.
+ *
+ * One row per target: version, catalog hash, state, and a separate protected
+ * column. The state is current, behind by expand, behind by contract, ahead,
+ * or failed at a step.
+ */
+import type { MigrationClass } from "./plan.js";
+import type { StoredMigration } from "./files.js";
+import { type InvokeFlags } from "./policy.js";
+/** One status row. `protected` is its own column, not a state. */
+export type TargetStatus = {
+    readonly target: string;
+    readonly version: string;
+    readonly catalogHash: string;
+    readonly state: string;
+    readonly protected: boolean;
+};
+/** A checkpoint row the state function reads. */
+export type StatusHistory = {
+    readonly migrationId: string;
+    readonly stepIndex: number;
+    readonly class: MigrationClass;
+};
+/**
+ * Decides the status state from files and history.
+ *
+ * A partial migration is `failed at step`. History the files do not contain
+ * is `ahead`. Pending files are behind by expand, or by contract when any
+ * pending step is not expand.
+ *
+ * @param migrations - Files in apply order
+ * @param history - Checkpoint rows
+ * @param recorded - Head row in `okm_meta`, when the target has one
+ * @returns Version, catalog hash, and state
+ */
+export declare function describeStatus(migrations: readonly StoredMigration[], history: readonly StatusHistory[], recorded: {
+    readonly hash: string;
+    readonly version: string;
+} | undefined): {
+    readonly version: string;
+    readonly catalogHash: string;
+    readonly state: string;
+};
+/**
+ * Reads one target and returns its status row.
+ *
+ * @param input - URL, name, protection, and the local migrations
+ * @returns The row
+ */
+export declare function readTargetStatus(input: {
+    readonly url: string;
+    readonly target: string;
+    readonly protected: boolean;
+    readonly searchPath?: string;
+    readonly migrations: readonly StoredMigration[];
+}): Promise<TargetStatus>;
+/**
+ * Prints status for every target, or for `--target` when it is passed.
+ *
+ * Several targets do not require `--target` here: the command lists them.
+ *
+ * @param cwd - Project directory
+ * @param flags - Optional target name
+ * @returns Tab-separated text, with a header
+ */
+export declare function statusProject(cwd: string, flags: InvokeFlags): Promise<string>;
+/**
+ * Prints status rows.
+ *
+ * @param rows - One per target
+ * @returns Header plus one line per target
+ */
+export declare function formatStatus(rows: readonly TargetStatus[]): string;

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

@@ -0,0 +1,29 @@
+/**
+ * `--replace` flags for a removed picklist or enum value (D131).
+ *
+ * The schema never stores the replacement. The flag is the only place it
+ * exists, and a chain (a value replaced by another removed value) is rejected.
+ */
+/** One replacement. `to` is `null` when the flag says `=null`. */
+export type Replacement = {
+    readonly table: string;
+    readonly column: string;
+    readonly from: string;
+    readonly to: string | null;
+};
+/**
+ * Parses `table.column.old=new`.
+ *
+ * The split is the first `=` and the first two dots, so the old value may
+ * contain dots. `=null` is the null replacement.
+ *
+ * @param flag - One `--replace` value
+ * @returns The replacement
+ */
+export declare function parseReplace(flag: string): Replacement;
+/**
+ * Rejects a chain: a replacement whose new value is itself removed.
+ *
+ * @param replacements - Flags for one generate
+ */
+export declare function assertNoChains(replacements: readonly Replacement[]): void;

package/package.json

@@ -1,19 +1,106 @@
 {
   "name": "okmodel",
-  "version": "0.0.0",
-  "description": "A catalog-first TypeScript ORM, work in progress",
-  "type": "module",
+  "version": "0.1.0",
+  "description": "Catalog-first TypeScript ORM: typed queries, safe migrations and replica-aware routing. PostgreSQL first, zero runtime dependencies.",
   "license": "Apache-2.0",
   "author": "Omq Khafi",
-  "repository": "https://github.com/omqkhafi/okmodel",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/omqkhafi/okmodel.git"
+  },
+  "bin": {
+    "okm": "./dist/okm.js",
+    "okmodel": "./dist/okmodel.js"
+  },
+  "workspaces": [
+    "packages/*"
+  ],
   "files": [
     "dist",
     "README.md",
     "LICENSE"
   ],
-  "exports": "./dist/index.js",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/contracts/index.d.ts",
+      "import": "./dist/contracts/index.js"
+    },
+    "./pg": {
+      "types": "./dist/dialects/pg/index.d.ts",
+      "import": "./dist/dialects/pg/index.js"
+    },
+    "./internal": {
+      "types": "./dist/contracts/internal.d.ts",
+      "import": "./dist/contracts/internal.js"
+    },
+    "./migrate": {
+      "types": "./dist/tooling/migrate/index.d.ts",
+      "import": "./dist/tooling/migrate/index.js"
+    },
+    "./pg/postgresjs": {
+      "types": "./dist/runtime/pg/postgresjs.d.ts",
+      "import": "./dist/runtime/pg/postgresjs.js"
+    },
+    "./pg/pglite": {
+      "types": "./dist/runtime/pg/pglite.d.ts",
+      "import": "./dist/runtime/pg/pglite.js"
+    }
+  },
   "scripts": {
-    "build": "bun build ./src/index.ts --outdir ./dist --format esm --target node",
-    "publish:dry": "bun publish --dry-run"
+    "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",
+    "driver-bench": "bun ./scripts/driver-bench.ts",
+    "typecheck": "bunx tsc --noEmit -p tsconfig.json",
+    "editor-check": "bun ./scripts/editor-check.ts",
+    "type-cost": "bun ./scripts/type-cost.ts",
+    "lint": "oxlint",
+    "format": "oxfmt",
+    "format:check": "oxfmt --check",
+    "layers-check": "bun ./scripts/layers-check.ts",
+    "core-purity": "bun ./scripts/core-purity.ts",
+    "docs:check": "bun ./scripts/docs-check.ts",
+    "compiler-api": "bun ./scripts/compiler-api.ts",
+    "publint": "publint run . --strict --pack bun",
+    "attw": "bun ./scripts/attw.ts",
+    "size": "bun ./scripts/size.ts",
+    "bundle-purity": "bun ./scripts/bundle-purity.ts",
+    "test": "bun test",
+    "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 compiler-api && bun run bundle-purity && bun run build && bun test && 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",
+    "db:down": "bun ./packages/harness/src/docker-cli.ts down",
+    "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",
+    "publish:dry": "bun publish --dry-run",
+    "prepublishOnly": "bun run build"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@electric-sql/pglite-socket": "^0.2.11",
+    "@types/bun": "^1.4.2",
+    "expect-type": "^1.4.0",
+    "fast-check": "^4.10.2",
+    "oxc-parser": "^0.152.0",
+    "oxfmt": "0.71.0",
+    "oxlint": "^1.86.0",
+    "oxlint-tsgolint": "^7.0.2003",
+    "publint": "^0.3.24",
+    "typescript": "7",
+    "typescript-editor": "npm:typescript@6.0.3"
+  },
+  "peerDependencies": {
+    "@electric-sql/pglite": "^0.5.8",
+    "postgres": "^3.4.9"
+  },
+  "peerDependenciesMeta": {
+    "@electric-sql/pglite": {
+      "optional": true
+    },
+    "postgres": {
+      "optional": true
+    }
   }
 }