@onreza/sqlx-js 0.5.0 → 0.7.0

package/dist/src/commands/init.js

@@ -1,4 +1,4 @@
-import { existsSync, mkdirSync, writeFileSync } from "node:fs";
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { dirname, join } from "node:path";
 const CONFIG_TEMPLATE = `import { defineConfig } from "@onreza/sqlx-js";
 
@@ -33,10 +33,32 @@ const PGSCHEMA_TEMPLATE = `-- Desired PostgreSQL schema managed by pgschema.
 --   sqlx-js db plan -- --output-json plan.json
 --   sqlx-js db apply -- --auto-approve
 `;
+const DTS_TEMPLATE = `// AUTO-GENERATED by sqlx-js. Do not edit.
+// Run \`sqlx-js prepare\` to regenerate.
+
+export interface SqlxJsGeneratedQueries {}
+export interface SqlxJsGeneratedFileQueries {}
+export interface SqlxJsGeneratedFunctions {}
+export interface SqlxJsGeneratedRegistry {
+  queries: SqlxJsGeneratedQueries;
+  fileQueries: SqlxJsGeneratedFileQueries;
+  functions: SqlxJsGeneratedFunctions;
+}
+
+declare module "@onreza/sqlx-js" {
+  interface KnownQueries extends SqlxJsGeneratedQueries {}
+  interface KnownFileQueries extends SqlxJsGeneratedFileQueries {}
+  interface KnownFunctions extends SqlxJsGeneratedFunctions {}
+}
+
+export {};
+`;
 export function runInit(opts) {
     const log = opts.log ?? console.log;
     const created = [];
+    const updated = [];
     const skipped = [];
+    const notes = [];
     const ensureFile = (rel, content) => {
         const full = join(opts.root, rel);
         if (existsSync(full)) {
@@ -63,10 +85,82 @@ export function runInit(opts) {
     else
         ensureDir("migrations");
     ensureFile(".env.example", ENV_TEMPLATE);
+    ensureFile("sqlx-js-env.d.ts", DTS_TEMPLATE);
+    const updateJson = (rel, mutate) => {
+        const full = join(opts.root, rel);
+        if (!existsSync(full))
+            return;
+        const source = readFileSync(full, "utf8");
+        let value;
+        try {
+            value = JSON.parse(source);
+        }
+        catch {
+            notes.push(`${rel}: manual update required because the file is not strict JSON`);
+            return;
+        }
+        if (!value || typeof value !== "object" || Array.isArray(value))
+            return;
+        if (!mutate(value))
+            return;
+        const indent = source.match(/\n([ \t]+)"/)?.[1] ?? "  ";
+        writeFileSync(full, JSON.stringify(value, null, indent) + "\n");
+        updated.push(rel);
+    };
+    updateJson("tsconfig.json", (value) => {
+        const files = value.files;
+        if (files !== undefined && (!Array.isArray(files) || !files.every((item) => typeof item === "string"))) {
+            notes.push("tsconfig.json: manual update required because files is not an array of strings");
+            return false;
+        }
+        if (Array.isArray(files)) {
+            if (files.includes("sqlx-js-env.d.ts"))
+                return false;
+            files.push("sqlx-js-env.d.ts");
+            return true;
+        }
+        const include = value.include;
+        if (include !== undefined && (!Array.isArray(include) || !include.every((item) => typeof item === "string"))) {
+            notes.push("tsconfig.json: manual update required because include is not an array of strings");
+            return false;
+        }
+        if (Array.isArray(include)) {
+            if (include.includes("sqlx-js-env.d.ts"))
+                return false;
+            include.push("sqlx-js-env.d.ts");
+            return true;
+        }
+        return false;
+    });
+    updateJson("package.json", (value) => {
+        if (value.scripts !== undefined && (!value.scripts || typeof value.scripts !== "object" || Array.isArray(value.scripts))) {
+            notes.push("package.json: manual script update required because scripts is not an object");
+            return false;
+        }
+        const scripts = (value.scripts ??= {});
+        const defaults = {
+            "sqlx:prepare": "sqlx-js prepare",
+            "sqlx:check": "sqlx-js prepare --check",
+            "sqlx:offline": "sqlx-js prepare --offline",
+            "sqlx:verify": "sqlx-js prepare --verify --strict-inference",
+        };
+        let changed = false;
+        for (const [name, command] of Object.entries(defaults)) {
+            if (scripts[name] !== undefined)
+                continue;
+            scripts[name] = command;
+            changed = true;
+        }
+        return changed;
+    });
     for (const f of created)
         log(`created ${f}`);
+    for (const f of updated)
+        log(`updated ${f}`);
     for (const f of skipped)
         log(`exists  ${f} (left unchanged)`);
+    for (const note of notes)
+        log(`manual  ${note}`);
     log("");
     log("Next steps:");
     log("  1. Set DATABASE_URL (see .env.example).");
@@ -78,7 +172,7 @@ export function runInit(opts) {
     }
     else {
         log("  2. Add a migration:  sqlx-js migrate add init");
-        log("  3. Make sure tsconfig.json \"include\" covers sqlx-js-env.d.ts.");
-        log("  4. Develop locally:  sqlx-js migrate dev");
+        log("  3. Check the project setup:  sqlx-js doctor");
+        log("  4. Develop locally:  sqlx-js migrate dev --strict-inference");
     }
 }

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

@@ -1,4 +1,5 @@
 import { PgClient } from "../pg/wire.js";
+export * from "../migration-core.js";
 export type MigrateOptions = {
     databaseUrl: string;
     migrationsDir: string;
@@ -12,91 +13,7 @@ export type MigrationWorkflowOptions = MigrateOptions & {
     shadowAdminUrl?: string;
     lockKey?: number | bigint;
     lockTimeoutMs?: number;
-};
-export type MigrationStore = {
-    table: string;
-};
-export declare const DEFAULT_MIGRATE_LOCK_KEY = 18750938867203960n;
-export declare function ensureTable(c: PgClient): Promise<MigrationStore>;
-export declare function listApplied(c: PgClient, store?: MigrationStore): Promise<Map<number, {
-    name: string;
-    hash: string;
-}>>;
-export type ApplyOutcome = {
-    kind: "applied";
-    version: number;
-    name: string;
-} | {
-    kind: "adopted";
-    version: number;
-    name: string;
-    replaced: number;
-} | {
-    kind: "tampered";
-    version: number;
-    name: string;
-    applied: string;
-    current: string;
-} | {
-    kind: "failed";
-    version: number;
-    name: string;
-    error: string;
-};
-export type PlanOutcome = {
-    kind: "pending";
-    version: number;
-    name: string;
-} | {
-    kind: "adoptable";
-    version: number;
-    name: string;
-    replaced: number;
-} | {
-    kind: "tampered";
-    version: number;
-    name: string;
-    applied: string;
-    current: string;
-} | {
-    kind: "failed";
-    version: number;
-    name: string;
-    error: string;
-};
-export type MigrationPlanItem = {
-    kind: "apply";
-    version: number;
-    name: string;
-} | {
-    kind: "adopt";
-    version: number;
-    name: string;
-    replaced: number;
-};
-export type MigrationPlanDiagnostic = Extract<PlanOutcome, {
-    kind: "tampered" | "failed";
-}>;
-export type MigrationPlanSnapshot = {
-    ok: boolean;
-    pending: number;
-    adoptable: number;
-    tampered: number;
-    failed: number;
-    steps: MigrationPlanItem[];
-    diagnostics: MigrationPlanDiagnostic[];
-};
-export type MigrationInfoStatus = "applied" | "pending" | "adoptable" | "superseded" | "tampered" | "failed";
-export type MigrationInfoItem = {
-    version: number;
-    name: string;
-    status: MigrationInfoStatus;
-    detail?: string;
-};
-export type MigrationInfoSnapshot = {
-    historyTable: string | null;
-    summary: Record<MigrationInfoStatus, number>;
-    items: MigrationInfoItem[];
+    strictInference?: boolean;
 };
 export type MigrationArchive = {
     name: string;
@@ -151,22 +68,6 @@ export type RevertDryRunOutcome = {
     error: string;
 };
 export declare function checkMigrationFiles(migrationsDir: string): MigrationCheckReport;
-export declare function planPending(c: PgClient, migrationsDir: string, onEvent?: (e: PlanOutcome) => void): Promise<{
-    pending: number;
-    adoptable: number;
-    tampered: number;
-    failed: number;
-    steps: MigrationPlanItem[];
-}>;
-export declare function inspectMigrationPlan(c: PgClient, migrationsDir: string): Promise<MigrationPlanSnapshot>;
-export declare function inspectMigrations(c: PgClient, migrationsDir: string): Promise<MigrationInfoSnapshot>;
-export declare function applyPending(c: PgClient, migrationsDir: string, onEvent?: (e: ApplyOutcome) => void): Promise<{
-    applied: number;
-    tampered: number;
-    failed: number;
-}>;
-export declare function acquireMigrateLock(c: PgClient, lockKey?: number | bigint, timeoutMs?: number): Promise<void>;
-export declare function releaseMigrateLock(c: PgClient, lockKey?: number | bigint): Promise<void>;
 export declare function sanitizePgDumpSchema(sql: string): string;
 export declare function listMigrationArchives(migrationsDir: string): MigrationArchive[];
 export declare function restoreMigrationArchive(migrationsDir: string, archiveName: string, opts?: {