pgpm 5.18.0 → 5.19.0

package/commands/regen.d.ts

@@ -0,0 +1,3 @@
+import { CLIOptions, Inquirerer, ParsedArgs } from 'inquirerer';
+declare const _default: (argv: Partial<ParsedArgs>, prompter: Inquirerer, _options: CLIOptions) => Promise<Partial<ParsedArgs>>;
+export default _default;

package/commands/regen.js

@@ -0,0 +1,171 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@pgpmjs/core");
+const logger_1 = require("@pgpmjs/logger");
+const transform_1 = require("@pgpmjs/transform");
+const fs = __importStar(require("fs"));
+const inquirerer_1 = require("inquirerer");
+const path = __importStar(require("path"));
+const log = new logger_1.Logger('regen');
+const regenUsageText = `
+Regen Command:
+
+  pgpm regen [change...] [OPTIONS]
+
+  Generate revert/verify scripts from deploy scripts. By default sweeps every
+  change in pgpm.plan and fills in scripts that are missing or empty stubs
+  (only comments and a BEGIN/COMMIT wrapper). Reverts are mechanical inverses
+  in reverse dependency order; verifies are existence checks per created
+  object. Statements with no derivable inverse become
+  '-- revert not derivable: <reason>' comments.
+
+Arguments:
+  change                 Regenerate only the named change(s) (targeted mode)
+
+Options:
+  --help, -h             Show this help message
+  --revert-only          Only generate revert scripts
+  --verify-only          Only generate verify scripts
+  --dry-run              Report what would be written without writing
+  --force                Overwrite non-empty existing scripts
+  --cwd <directory>      Working directory (default: current directory)
+
+Examples:
+  pgpm regen                                  Fill in all missing/stub revert+verify scripts
+  pgpm regen schemas/app/tables/users/table   Regenerate one change
+  pgpm regen --verify-only --dry-run          Preview verify generation
+  pgpm regen foo --force                      Overwrite foo's scripts even if non-empty
+`;
+const wrapScript = (type, change, body) => {
+    const header = type === 'revert' ? `-- Revert ${change} from pg` : `-- Verify ${change} on pg`;
+    const close = type === 'revert' ? 'COMMIT;' : 'ROLLBACK;';
+    const sql = body.trim();
+    return `${header}\n\nBEGIN;\n\n${sql ? `${sql}\n\n` : ''}${close}\n`;
+};
+exports.default = async (argv, prompter, _options) => {
+    if (argv.help || argv.h) {
+        console.log(regenUsageText);
+        process.exit(0);
+    }
+    const cwd = argv.cwd || process.cwd();
+    const revertOnly = Boolean(argv['revert-only'] ?? argv.revertOnly);
+    const verifyOnly = Boolean(argv['verify-only'] ?? argv.verifyOnly);
+    const dryRun = Boolean(argv['dry-run'] ?? argv.dryRun);
+    const force = Boolean(argv.force);
+    if (revertOnly && verifyOnly) {
+        await (0, inquirerer_1.cliExitWithError)('--revert-only and --verify-only are mutually exclusive');
+    }
+    const types = revertOnly
+        ? ['revert']
+        : verifyOnly
+            ? ['verify']
+            : ['revert', 'verify'];
+    const pkg = new core_1.PgpmPackage(path.resolve(cwd));
+    if (!pkg.isInModule()) {
+        await (0, inquirerer_1.cliExitWithError)('This command must be run inside a pgpm module (or pass --cwd <module>).');
+    }
+    const modulePath = pkg.modulePath;
+    const planResult = (0, core_1.parsePlanFile)(path.join(modulePath, 'pgpm.plan'));
+    if (!planResult.data) {
+        await (0, inquirerer_1.cliExitWithError)(`Failed to parse pgpm.plan: ${planResult.errors.map(e => e.message).join(', ')}`);
+    }
+    const planChanges = planResult.data.changes.map(c => c.name);
+    const requested = argv._?.filter(Boolean) ?? [];
+    let targets;
+    if (requested.length > 0) {
+        const missing = requested.filter(name => !planChanges.includes(name));
+        if (missing.length > 0) {
+            await (0, inquirerer_1.cliExitWithError)(`Change(s) not found in pgpm.plan: ${missing.join(', ')}`);
+        }
+        targets = requested;
+    }
+    else {
+        targets = planChanges;
+    }
+    const result = { generated: [], skipped: [], warnings: [] };
+    await (0, transform_1.loadModule)();
+    for (const change of targets) {
+        const deploySql = (0, core_1.readScript)(modulePath, 'deploy', change);
+        if (!deploySql) {
+            result.warnings.push(`${change}: no deploy script found, skipping`);
+            continue;
+        }
+        const needed = types.filter(type => {
+            const existing = (0, core_1.readScript)(modulePath, type, change);
+            return force || (0, transform_1.isStubScript)(existing);
+        });
+        const untouched = types.filter(type => !needed.includes(type));
+        for (const type of untouched) {
+            result.skipped.push(`${type}/${change}`);
+        }
+        if (needed.length === 0)
+            continue;
+        let scripts;
+        try {
+            scripts = (0, transform_1.regenerateScripts)(deploySql);
+        }
+        catch (err) {
+            result.warnings.push(`${change}: failed to parse deploy script (${err?.message ?? err})`);
+            continue;
+        }
+        for (const warning of scripts.revert.warnings) {
+            result.warnings.push(`${change}: ${warning}`);
+        }
+        for (const warning of scripts.verify.warnings) {
+            result.warnings.push(`${change}: ${warning}`);
+        }
+        for (const type of needed) {
+            const body = type === 'revert' ? scripts.revert.sql : scripts.verify.sql;
+            const content = wrapScript(type, change, body);
+            const target = `${type}/${change}`;
+            if (dryRun) {
+                log.info(`would write ${target}.sql`);
+            }
+            else {
+                const filePath = path.join(modulePath, type, `${change}.sql`);
+                fs.mkdirSync(path.dirname(filePath), { recursive: true });
+                fs.writeFileSync(filePath, content);
+            }
+            result.generated.push(target);
+        }
+    }
+    for (const warning of result.warnings) {
+        log.warn(warning);
+    }
+    const verb = dryRun ? 'would generate' : 'generated';
+    log.success(`regen: ${verb} ${result.generated.length} script(s), skipped ${result.skipped.length} existing, ${result.warnings.length} warning(s)`);
+    return argv;
+};

package/commands.js

@@ -26,6 +26,7 @@ const materialize_1 = __importDefault(require("./commands/materialize"));
 const migrate_1 = __importDefault(require("./commands/migrate"));
 const package_1 = __importDefault(require("./commands/package"));
 const plan_1 = __importDefault(require("./commands/plan"));
+const regen_1 = __importDefault(require("./commands/regen"));
 const remove_1 = __importDefault(require("./commands/remove"));
 const rename_1 = __importDefault(require("./commands/rename"));
 const revert_1 = __importDefault(require("./commands/revert"));
@@ -57,6 +58,7 @@ const ENGINE_EXEMPT_COMMANDS = new Set([
     'package',
     'materialize',
     'plan',
+    'regen',
     'remove',
     'rename',
     'slice',
@@ -93,6 +95,7 @@ const createPgpmCommandMap = (skipPgTeardown = false) => {
         init: pgt(init_1.default),
         extension: pgt(extension_1.default),
         plan: pgt(plan_1.default),
+        regen: regen_1.default,
         export: pgt(export_1.default),
         package: pgt(package_1.default),
         tag: pgt(tag_1.default),

package/esm/commands/regen.js

@@ -0,0 +1,136 @@
+import { parsePlanFile, PgpmPackage, readScript } from '@pgpmjs/core';
+import { Logger } from '@pgpmjs/logger';
+import { isStubScript, loadModule, regenerateScripts } from '@pgpmjs/transform';
+import * as fs from 'fs';
+import { cliExitWithError } from 'inquirerer';
+import * as path from 'path';
+const log = new Logger('regen');
+const regenUsageText = `
+Regen Command:
+
+  pgpm regen [change...] [OPTIONS]
+
+  Generate revert/verify scripts from deploy scripts. By default sweeps every
+  change in pgpm.plan and fills in scripts that are missing or empty stubs
+  (only comments and a BEGIN/COMMIT wrapper). Reverts are mechanical inverses
+  in reverse dependency order; verifies are existence checks per created
+  object. Statements with no derivable inverse become
+  '-- revert not derivable: <reason>' comments.
+
+Arguments:
+  change                 Regenerate only the named change(s) (targeted mode)
+
+Options:
+  --help, -h             Show this help message
+  --revert-only          Only generate revert scripts
+  --verify-only          Only generate verify scripts
+  --dry-run              Report what would be written without writing
+  --force                Overwrite non-empty existing scripts
+  --cwd <directory>      Working directory (default: current directory)
+
+Examples:
+  pgpm regen                                  Fill in all missing/stub revert+verify scripts
+  pgpm regen schemas/app/tables/users/table   Regenerate one change
+  pgpm regen --verify-only --dry-run          Preview verify generation
+  pgpm regen foo --force                      Overwrite foo's scripts even if non-empty
+`;
+const wrapScript = (type, change, body) => {
+    const header = type === 'revert' ? `-- Revert ${change} from pg` : `-- Verify ${change} on pg`;
+    const close = type === 'revert' ? 'COMMIT;' : 'ROLLBACK;';
+    const sql = body.trim();
+    return `${header}\n\nBEGIN;\n\n${sql ? `${sql}\n\n` : ''}${close}\n`;
+};
+export default async (argv, prompter, _options) => {
+    if (argv.help || argv.h) {
+        console.log(regenUsageText);
+        process.exit(0);
+    }
+    const cwd = argv.cwd || process.cwd();
+    const revertOnly = Boolean(argv['revert-only'] ?? argv.revertOnly);
+    const verifyOnly = Boolean(argv['verify-only'] ?? argv.verifyOnly);
+    const dryRun = Boolean(argv['dry-run'] ?? argv.dryRun);
+    const force = Boolean(argv.force);
+    if (revertOnly && verifyOnly) {
+        await cliExitWithError('--revert-only and --verify-only are mutually exclusive');
+    }
+    const types = revertOnly
+        ? ['revert']
+        : verifyOnly
+            ? ['verify']
+            : ['revert', 'verify'];
+    const pkg = new PgpmPackage(path.resolve(cwd));
+    if (!pkg.isInModule()) {
+        await cliExitWithError('This command must be run inside a pgpm module (or pass --cwd <module>).');
+    }
+    const modulePath = pkg.modulePath;
+    const planResult = parsePlanFile(path.join(modulePath, 'pgpm.plan'));
+    if (!planResult.data) {
+        await cliExitWithError(`Failed to parse pgpm.plan: ${planResult.errors.map(e => e.message).join(', ')}`);
+    }
+    const planChanges = planResult.data.changes.map(c => c.name);
+    const requested = argv._?.filter(Boolean) ?? [];
+    let targets;
+    if (requested.length > 0) {
+        const missing = requested.filter(name => !planChanges.includes(name));
+        if (missing.length > 0) {
+            await cliExitWithError(`Change(s) not found in pgpm.plan: ${missing.join(', ')}`);
+        }
+        targets = requested;
+    }
+    else {
+        targets = planChanges;
+    }
+    const result = { generated: [], skipped: [], warnings: [] };
+    await loadModule();
+    for (const change of targets) {
+        const deploySql = readScript(modulePath, 'deploy', change);
+        if (!deploySql) {
+            result.warnings.push(`${change}: no deploy script found, skipping`);
+            continue;
+        }
+        const needed = types.filter(type => {
+            const existing = readScript(modulePath, type, change);
+            return force || isStubScript(existing);
+        });
+        const untouched = types.filter(type => !needed.includes(type));
+        for (const type of untouched) {
+            result.skipped.push(`${type}/${change}`);
+        }
+        if (needed.length === 0)
+            continue;
+        let scripts;
+        try {
+            scripts = regenerateScripts(deploySql);
+        }
+        catch (err) {
+            result.warnings.push(`${change}: failed to parse deploy script (${err?.message ?? err})`);
+            continue;
+        }
+        for (const warning of scripts.revert.warnings) {
+            result.warnings.push(`${change}: ${warning}`);
+        }
+        for (const warning of scripts.verify.warnings) {
+            result.warnings.push(`${change}: ${warning}`);
+        }
+        for (const type of needed) {
+            const body = type === 'revert' ? scripts.revert.sql : scripts.verify.sql;
+            const content = wrapScript(type, change, body);
+            const target = `${type}/${change}`;
+            if (dryRun) {
+                log.info(`would write ${target}.sql`);
+            }
+            else {
+                const filePath = path.join(modulePath, type, `${change}.sql`);
+                fs.mkdirSync(path.dirname(filePath), { recursive: true });
+                fs.writeFileSync(filePath, content);
+            }
+            result.generated.push(target);
+        }
+    }
+    for (const warning of result.warnings) {
+        log.warn(warning);
+    }
+    const verb = dryRun ? 'would generate' : 'generated';
+    log.success(`regen: ${verb} ${result.generated.length} script(s), skipped ${result.skipped.length} existing, ${result.warnings.length} warning(s)`);
+    return argv;
+};

package/esm/commands.js

@@ -20,6 +20,7 @@ import materialize from './commands/materialize';
 import migrate from './commands/migrate';
 import _package from './commands/package';
 import plan from './commands/plan';
+import regen from './commands/regen';
 import remove from './commands/remove';
 import renameCmd from './commands/rename';
 import revert from './commands/revert';
@@ -51,6 +52,7 @@ const ENGINE_EXEMPT_COMMANDS = new Set([
     'package',
     'materialize',
     'plan',
+    'regen',
     'remove',
     'rename',
     'slice',
@@ -87,6 +89,7 @@ export const createPgpmCommandMap = (skipPgTeardown = false) => {
         init: pgt(init),
         extension: pgt(extension),
         plan: pgt(plan),
+        regen,
         export: pgt(_export),
         package: pgt(_package),
         tag: pgt(tag),

package/esm/utils/display.js

@@ -11,6 +11,7 @@ export const usageText = `
     init               Initialize workspace or module
     extension          Manage module dependencies
     plan               Generate module deployment plans
+    regen              Generate revert/verify scripts from deploy scripts
     package            Package module for distribution
     materialize        Transpile an apply proxy into a plain, committed module
     sync-versions      Sync .control/Makefile/sql metadata to package.json versions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pgpm",
-  "version": "5.18.0",
+  "version": "5.19.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "PostgreSQL Package Manager - Database migration and package management CLI",
   "main": "index.js",
@@ -46,11 +46,12 @@
   },
   "dependencies": {
     "@inquirerer/utils": "^3.3.9",
-    "@pgpmjs/core": "^7.21.0",
+    "@pgpmjs/core": "^7.21.1",
     "@pgpmjs/env": "^2.40.2",
-    "@pgpmjs/export": "^1.14.0",
+    "@pgpmjs/export": "^1.14.1",
     "@pgpmjs/logger": "^2.23.2",
-    "@pgpmjs/slice": "^0.13.5",
+    "@pgpmjs/slice": "^0.13.6",
+    "@pgpmjs/transform": "^0.17.0",
     "@pgpmjs/types": "^2.49.2",
     "@pgsql/quotes": "^18.1.0",
     "appstash": "^0.7.0",
@@ -60,7 +61,7 @@
     "js-yaml": "^4.1.0",
     "pg-cache": "^3.24.2",
     "pg-env": "^1.27.2",
-    "pgsql-deparser": "^18.1.1",
+    "pgsql-deparser": "^18.2.0",
     "semver": "^7.8.1",
     "shelljs": "^0.10.0",
     "yanse": "^0.2.1"
@@ -77,5 +78,5 @@
     "pg",
     "pgsql"
   ],
-  "gitHead": "7a37da1f5655c36813343f09c6efa62ca0d7a855"
+  "gitHead": "45cd961cf956d2d28e4d09b20db4204982c33593"
 }

package/utils/display.d.ts

@@ -1 +1 @@
-export declare const usageText = "\n  Usage: pgpm <command> [options]\n\n  Core Database Operations:\n    add                Add database changes to plans and create SQL files\n    deploy             Deploy database changes and migrations\n    verify             Verify database state and migrations\n    revert             Revert database changes and migrations\n\n  Project Management:\n    init               Initialize workspace or module\n    extension          Manage module dependencies\n    plan               Generate module deployment plans\n    package            Package module for distribution\n    materialize        Transpile an apply proxy into a plain, committed module\n    sync-versions      Sync .control/Makefile/sql metadata to package.json versions\n    export             Export database migrations from existing databases\n    update             Update pgpm to the latest version\n    cache              Manage cached templates (clean)\n    upgrade            Upgrade installed pgpm modules to latest versions (alias: up)\n\n  Database Administration:\n    dump               Dump a database to a sql file\n    kill               Terminate database connections and optionally drop databases\n    install            Install database modules\n    tag                Add tags to changes for versioning\n    clear              Clear database state\n    remove             Remove database changes\n    analyze            Analyze database structure\n    rename             Rename database changes\n    admin-users        Manage admin users\n    tune               Tune PostgreSQL for throwaway environments (CI/test)\n\n  Testing:\n    test-packages      Run integration tests on all workspace packages\n\n  Migration Tools:\n    migrate            Migration management subcommands\n      init             Initialize migration tracking\n      status           Show migration status\n      list             List all changes\n      deps             Show change dependencies\n  \n  Development Tools:\n    docker             Manage Docker containers (start/stop/ls, --minio)\n    doctor             Check local dependencies (node, docker, psql) with install guidance\n    env                Manage environment variables (--supabase, --minio)\n    test-packages      Run integration tests on workspace packages\n  \n  Global Options:\n    -h, --help         Display this help information\n    -v, --version      Display version information\n    --cwd <directory>  Working directory (default: current directory)\n    --engine <name>    Migration backend: pg (default, Postgres server) or\n                       pglite (in-process WASM Postgres, no server). Also set by\n                       the \"engine\" key of pgpm.json or PGPM_ENGINE.\n    --driver <pkg>     Driver plugin package backing the engine (escape hatch)\n    --pglite[=dataDir] Sugar for --engine pglite, persisted to <dataDir> if given\n\n  Individual Command Help:\n    pgpm <command> --help    Display detailed help for specific command\n    pgpm <command> -h        Display detailed help for specific command\n\n  Examples:\n    pgpm deploy --help       Show deploy command options\n    pgpm init workspace      Initialize new workspace\n    pgpm install @pgpm/base32  Install a database module\n  ";
+export declare const usageText = "\n  Usage: pgpm <command> [options]\n\n  Core Database Operations:\n    add                Add database changes to plans and create SQL files\n    deploy             Deploy database changes and migrations\n    verify             Verify database state and migrations\n    revert             Revert database changes and migrations\n\n  Project Management:\n    init               Initialize workspace or module\n    extension          Manage module dependencies\n    plan               Generate module deployment plans\n    regen              Generate revert/verify scripts from deploy scripts\n    package            Package module for distribution\n    materialize        Transpile an apply proxy into a plain, committed module\n    sync-versions      Sync .control/Makefile/sql metadata to package.json versions\n    export             Export database migrations from existing databases\n    update             Update pgpm to the latest version\n    cache              Manage cached templates (clean)\n    upgrade            Upgrade installed pgpm modules to latest versions (alias: up)\n\n  Database Administration:\n    dump               Dump a database to a sql file\n    kill               Terminate database connections and optionally drop databases\n    install            Install database modules\n    tag                Add tags to changes for versioning\n    clear              Clear database state\n    remove             Remove database changes\n    analyze            Analyze database structure\n    rename             Rename database changes\n    admin-users        Manage admin users\n    tune               Tune PostgreSQL for throwaway environments (CI/test)\n\n  Testing:\n    test-packages      Run integration tests on all workspace packages\n\n  Migration Tools:\n    migrate            Migration management subcommands\n      init             Initialize migration tracking\n      status           Show migration status\n      list             List all changes\n      deps             Show change dependencies\n  \n  Development Tools:\n    docker             Manage Docker containers (start/stop/ls, --minio)\n    doctor             Check local dependencies (node, docker, psql) with install guidance\n    env                Manage environment variables (--supabase, --minio)\n    test-packages      Run integration tests on workspace packages\n  \n  Global Options:\n    -h, --help         Display this help information\n    -v, --version      Display version information\n    --cwd <directory>  Working directory (default: current directory)\n    --engine <name>    Migration backend: pg (default, Postgres server) or\n                       pglite (in-process WASM Postgres, no server). Also set by\n                       the \"engine\" key of pgpm.json or PGPM_ENGINE.\n    --driver <pkg>     Driver plugin package backing the engine (escape hatch)\n    --pglite[=dataDir] Sugar for --engine pglite, persisted to <dataDir> if given\n\n  Individual Command Help:\n    pgpm <command> --help    Display detailed help for specific command\n    pgpm <command> -h        Display detailed help for specific command\n\n  Examples:\n    pgpm deploy --help       Show deploy command options\n    pgpm init workspace      Initialize new workspace\n    pgpm install @pgpm/base32  Install a database module\n  ";

package/utils/display.js

@@ -14,6 +14,7 @@ exports.usageText = `
     init               Initialize workspace or module
     extension          Manage module dependencies
     plan               Generate module deployment plans
+    regen              Generate revert/verify scripts from deploy scripts
     package            Package module for distribution
     materialize        Transpile an apply proxy into a plain, committed module
     sync-versions      Sync .control/Makefile/sql metadata to package.json versions