@toichubek/pg-ddl-extractor 1.0.0

package/dist/config.d.ts

@@ -0,0 +1,9 @@
+import { PoolConfig } from "pg";
+export interface DbConfig {
+    host: string;
+    port: number;
+    database: string;
+    user: string;
+    password: string;
+}
+export declare function getDbConfig(env: string): PoolConfig;

package/dist/config.js

@@ -0,0 +1,66 @@
+"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 });
+exports.getDbConfig = getDbConfig;
+const dotenv = __importStar(require("dotenv"));
+// ─── Load .env ────────────────────────────────────────────────────
+dotenv.config();
+function getDbConfig(env) {
+    const prefix = env.toUpperCase(); // DEV or PROD
+    const host = process.env[`${prefix}_DB_HOST`];
+    const port = process.env[`${prefix}_DB_PORT`];
+    const database = process.env[`${prefix}_DB_NAME`];
+    const user = process.env[`${prefix}_DB_USER`];
+    const password = process.env[`${prefix}_DB_PASSWORD`];
+    if (!host || !database || !user) {
+        throw new Error(`Missing DB config for env "${env}". ` +
+            `Expected ${prefix}_DB_HOST, ${prefix}_DB_NAME, ${prefix}_DB_USER in .env`);
+    }
+    // Validate port number if provided
+    const portNumber = port ? parseInt(port, 10) : 5432;
+    if (port && (isNaN(portNumber) || portNumber < 1 || portNumber > 65535)) {
+        throw new Error(`Invalid port number in ${prefix}_DB_PORT: "${port}". Port must be between 1 and 65535`);
+    }
+    return {
+        host,
+        port: portNumber,
+        database,
+        user,
+        password: password || "",
+        // safe defaults
+        connectionTimeoutMillis: 10000,
+        query_timeout: 30000,
+    };
+}

package/dist/diff.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/diff.js

@@ -0,0 +1,100 @@
+"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 fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const commander_1 = require("commander");
+const compare_1 = require("./compare");
+function parseArgs() {
+    commander_1.program
+        .name("pg-ddl-diff")
+        .description("Compare dev and prod PostgreSQL schemas")
+        .version("1.0.0")
+        .option("--report", "Generate markdown and HTML reports")
+        .option("--sql-dir <path>", "Path to SQL directory (default: ../../sql)")
+        .option("--dev <path>", "Path to dev schema directory")
+        .option("--prod <path>", "Path to prod schema directory")
+        .parse(process.argv);
+    return commander_1.program.opts();
+}
+// ─── Main ─────────────────────────────────────────────────────────
+function main() {
+    const options = parseArgs();
+    // Determine SQL root directory
+    const sqlRoot = options.sqlDir
+        ? path.resolve(options.sqlDir)
+        : process.env.SQL_OUTPUT_DIR
+            ? path.resolve(process.env.SQL_OUTPUT_DIR)
+            : path.resolve(__dirname, "..", "..", "sql");
+    if (!fs.existsSync(sqlRoot)) {
+        console.error(`❌ sql/ folder not found at: ${sqlRoot}`);
+        console.error("   Run extract:dev and extract:prod first.");
+        process.exit(1);
+    }
+    // Determine dev and prod directories
+    const devDir = options.dev ? path.resolve(options.dev) : path.join(sqlRoot, "dev");
+    const prodDir = options.prod ? path.resolve(options.prod) : path.join(sqlRoot, "prod");
+    if (!fs.existsSync(devDir)) {
+        console.error("❌ sql/dev/ not found. Run: npm run extract:dev");
+        process.exit(1);
+    }
+    if (!fs.existsSync(prodDir)) {
+        console.error("❌ sql/prod/ not found. Run: npm run extract:prod");
+        process.exit(1);
+    }
+    try {
+        const summary = (0, compare_1.compareDdl)(sqlRoot);
+        // Always print to console
+        console.log((0, compare_1.formatConsoleReport)(summary));
+        // Optionally save reports (markdown + HTML)
+        if (options.report) {
+            const reportDir = path.join(sqlRoot, "reports");
+            fs.mkdirSync(reportDir, { recursive: true });
+            const timestamp = new Date().toISOString().slice(0, 10);
+            const mdPath = path.join(reportDir, `diff_${timestamp}.md`);
+            fs.writeFileSync(mdPath, (0, compare_1.formatMarkdownReport)(summary), "utf-8");
+            const htmlPath = path.join(reportDir, `diff_${timestamp}.html`);
+            fs.writeFileSync(htmlPath, (0, compare_1.formatHtmlReport)(summary), "utf-8");
+            console.log(`\n📄 Markdown: ${mdPath}`);
+            console.log(`🌐 HTML:     ${htmlPath}`);
+            console.log(`\n   Open in browser: open ${htmlPath}`);
+        }
+    }
+    catch (err) {
+        console.error(`❌ ${err.message}`);
+        process.exit(1);
+    }
+}
+main();

package/dist/extract.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/extract.js

@@ -0,0 +1,190 @@
+"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 path = __importStar(require("path"));
+const dotenv = __importStar(require("dotenv"));
+const pg_1 = require("pg");
+const commander_1 = require("commander");
+const config_1 = require("./config");
+const writer_1 = require("./writer");
+const extractor_1 = require("./extractor");
+const tunnel_1 = require("./tunnel");
+// ─── Load .env ────────────────────────────────────────────────────
+dotenv.config();
+function parseArgs() {
+    commander_1.program
+        .name("pg-ddl-extract")
+        .description("Extract PostgreSQL DDL into organized folder structure")
+        .version("1.0.0")
+        .option("--env <environment>", "Environment (dev or prod)", "dev")
+        .option("--host <host>", "Database host")
+        .option("--port <port>", "Database port")
+        .option("--database <database>", "Database name")
+        .option("--user <user>", "Database user")
+        .option("--password <password>", "Database password")
+        .option("--output <path>", "Output directory path")
+        .parse(process.argv);
+    const options = commander_1.program.opts();
+    // Validate env if provided
+    if (options.env && !["dev", "prod"].includes(options.env)) {
+        console.error(`❌ Invalid env: "${options.env}". Use --env dev or --env prod`);
+        process.exit(1);
+    }
+    return options;
+}
+// ─── Main ─────────────────────────────────────────────────────────
+async function main() {
+    const options = parseArgs();
+    const env = options.env || "dev";
+    // Determine output directory
+    const outputDir = options.output
+        ? path.resolve(options.output)
+        : process.env.SQL_OUTPUT_DIR
+            ? path.resolve(process.env.SQL_OUTPUT_DIR, env)
+            : path.resolve(__dirname, "..", "..", "sql", env);
+    console.log("═══════════════════════════════════════════════════");
+    console.log(`  PostgreSQL DDL Extractor`);
+    console.log(`  Environment: ${env.toUpperCase()}`);
+    console.log(`  Output:      ${outputDir}`);
+    console.log("═══════════════════════════════════════════════════");
+    // Check if SSH tunnel is needed
+    const sshConfig = (0, tunnel_1.getSshConfig)(env);
+    let tunnel = null;
+    // Get DB config - use CLI options if provided, otherwise use env-based config
+    let pgConfig = options.host || options.database || options.user
+        ? {
+            host: options.host || "localhost",
+            port: options.port ? parseInt(options.port, 10) : 5432,
+            database: options.database,
+            user: options.user,
+            password: options.password || "",
+            connectionTimeoutMillis: 10000,
+            query_timeout: 30000,
+        }
+        : (0, config_1.getDbConfig)(env);
+    // Validate required fields if using CLI options
+    if (options.host || options.database || options.user) {
+        if (!options.database || !options.user) {
+            console.error("❌ When using CLI flags, --database and --user are required");
+            process.exit(1);
+        }
+        // Validate port number
+        if (options.port) {
+            const port = parseInt(options.port, 10);
+            if (isNaN(port) || port < 1 || port > 65535) {
+                console.error(`❌ Invalid port number: "${options.port}". Port must be between 1 and 65535`);
+                process.exit(1);
+            }
+        }
+    }
+    if (sshConfig) {
+        console.log(`\n🔒 SSH tunnel: ${sshConfig.sshUser}@${sshConfig.sshHost}:${sshConfig.sshPort}`);
+        console.log(`   Remote DB:  ${sshConfig.remoteHost}:${sshConfig.remotePort}`);
+        try {
+            tunnel = await (0, tunnel_1.createSshTunnel)(sshConfig);
+            console.log(`   Local port: 127.0.0.1:${tunnel.localPort}`);
+            // Override pg config to connect through tunnel
+            pgConfig = {
+                ...pgConfig,
+                host: "127.0.0.1",
+                port: tunnel.localPort,
+            };
+        }
+        catch (err) {
+            console.error(`\n❌ SSH tunnel failed: ${err.message}`);
+            if (err.message.includes("Authentication")) {
+                console.error("   → Check SSH_USER, SSH_PASSWORD or SSH_KEY_PATH in .env");
+            }
+            if (err.message.includes("ECONNREFUSED")) {
+                console.error("   → SSH server not reachable");
+            }
+            process.exit(1);
+        }
+    }
+    console.log(`\n🔌 Connecting to ${pgConfig.host}:${pgConfig.port}/${pgConfig.database}...`);
+    const client = new pg_1.Client(pgConfig);
+    try {
+        await client.connect();
+        console.log("✅ Connected\n");
+        // Get db version for info
+        const { rows } = await client.query("SELECT version();");
+        console.log(`  DB: ${rows[0].version.split(",")[0]}\n`);
+        // Extract
+        const writer = new writer_1.SqlFileWriter(outputDir);
+        const extractor = new extractor_1.DdlExtractor(client, writer);
+        await extractor.extractAll();
+        // Summary
+        const summary = writer.getSummary();
+        const total = Object.values(summary).reduce((a, b) => a + b, 0);
+        const stats = writer.getChangeStats();
+        console.log("\n═══════════════════════════════════════════════════");
+        console.log(`  ✅ Done! Extracted ${total} objects into sql/${env}/`);
+        console.log("═══════════════════════════════════════════════════");
+        console.log(`\n  📁 ${outputDir}`);
+        console.log(`  📄 Full dump: sql/${env}/_full_dump.sql`);
+        console.log("\n  Change Summary:");
+        console.log(`    🆕 Created:   ${stats.created}`);
+        console.log(`    🔄 Updated:   ${stats.updated}`);
+        console.log(`    ✅ Unchanged: ${stats.unchanged}`);
+        if (stats.created === 0 && stats.updated === 0) {
+            console.log(`\n  🎉 No changes - database structure is unchanged!\n`);
+        }
+        else {
+            console.log(`\n  Ready to commit to Git! 🎉\n`);
+        }
+    }
+    catch (err) {
+        console.error(`\n❌ Error: ${err.message}`);
+        if (err.code === "ECONNREFUSED") {
+            console.error("   → Check that the database server is running");
+        }
+        if (err.code === "28P01") {
+            console.error("   → Invalid username or password");
+        }
+        if (err.code === "3D000") {
+            console.error("   → Database does not exist");
+        }
+        process.exit(1);
+    }
+    finally {
+        await client.end();
+        // Close SSH tunnel if it was opened
+        if (tunnel) {
+            await tunnel.close();
+            console.log("🔒 SSH tunnel closed");
+        }
+    }
+}
+main();

package/dist/extractor.d.ts

@@ -0,0 +1,23 @@
+import { Client } from "pg";
+import { SqlFileWriter } from "./writer";
+export declare class DdlExtractor {
+    private client;
+    private writer;
+    private allDdl;
+    constructor(client: Client, writer: SqlFileWriter);
+    /** Run full extraction */
+    extractAll(): Promise<void>;
+    private extractSchemas;
+    private extractTypes;
+    private extractSequences;
+    private extractTables;
+    private buildTableDdl;
+    private buildColumnType;
+    private extractViews;
+    private extractMaterializedViews;
+    private extractFunctions;
+    private extractTriggers;
+    private extractIndexes;
+    private save;
+    private log;
+}