@pgpmjs/core 4.1.2 → 4.2.1

package/core/class/pgpm.d.ts

@@ -145,6 +145,16 @@ export declare class PgpmPackage {
         installed: string[];
         installedVersions: Record<string, string>;
     };
+    /**
+     * Returns all pgpm modules installed in the workspace extensions directory.
+     * Unlike getInstalledModules(), this does NOT require being inside a module.
+     * It scans the workspace/extensions/ directory directly to find installed packages.
+     *
+     * This is useful for checking what's available at workspace level before a module exists.
+     *
+     * @returns Array of installed npm package names (e.g., '@pgpm/base32', '@pgpm/totp')
+     */
+    getWorkspaceInstalledModules(): string[];
     /**
      * Updates installed pgpm modules to their latest versions from npm.
      * Re-installs each module to get the latest version.

package/core/class/pgpm.js

@@ -62,6 +62,11 @@ const package_1 = require("../../packaging/package");
 const deps_1 = require("../../resolution/deps");
 const target_utils_1 = require("../../utils/target-utils");
 const logger = new logger_1.Logger('pgpm');
+/**
+ * Directory name for workspace extensions.
+ * Extensions are installed globally in the workspace's extensions/ directory.
+ */
+const EXTENSIONS_DIR = 'extensions';
 function getUTCTimestamp(d = new Date()) {
     return (d.getUTCFullYear() +
         '-' + String(d.getUTCMonth() + 1).padStart(2, '0') +
@@ -786,7 +791,7 @@ ${dependencies.length > 0 ? dependencies.map(dep => `-- requires: ${dep}`).join(
         this.ensureWorkspace();
         this.ensureModule();
         const originalDir = process.cwd();
-        const skitchExtDir = path_1.default.join(this.workspacePath, 'extensions');
+        const skitchExtDir = path_1.default.join(this.workspacePath, EXTENSIONS_DIR);
         const pkgJsonPath = path_1.default.join(this.modulePath, 'package.json');
         if (!fs_1.default.existsSync(pkgJsonPath)) {
             throw new Error(`No package.json found at module path: ${this.modulePath}`);
@@ -889,7 +894,7 @@ ${dependencies.length > 0 ? dependencies.map(dep => `-- requires: ${dep}`).join(
         }
         const pkgData = JSON.parse(fs_1.default.readFileSync(pkgJsonPath, 'utf-8'));
         const dependencies = pkgData.dependencies || {};
-        const skitchExtDir = path_1.default.join(this.workspacePath, 'extensions');
+        const skitchExtDir = path_1.default.join(this.workspacePath, EXTENSIONS_DIR);
         const installed = [];
         const installedVersions = {};
         for (const [name, version] of Object.entries(dependencies)) {
@@ -901,6 +906,43 @@ ${dependencies.length > 0 ? dependencies.map(dep => `-- requires: ${dep}`).join(
         }
         return { installed, installedVersions };
     }
+    /**
+     * Returns all pgpm modules installed in the workspace extensions directory.
+     * Unlike getInstalledModules(), this does NOT require being inside a module.
+     * It scans the workspace/extensions/ directory directly to find installed packages.
+     *
+     * This is useful for checking what's available at workspace level before a module exists.
+     *
+     * @returns Array of installed npm package names (e.g., '@pgpm/base32', '@pgpm/totp')
+     */
+    getWorkspaceInstalledModules() {
+        this.ensureWorkspace();
+        const extensionsDir = path_1.default.join(this.workspacePath, EXTENSIONS_DIR);
+        if (!fs_1.default.existsSync(extensionsDir)) {
+            return [];
+        }
+        const installed = [];
+        const entries = fs_1.default.readdirSync(extensionsDir, { withFileTypes: true });
+        for (const entry of entries) {
+            if (!entry.isDirectory())
+                continue;
+            if (entry.name.startsWith('@')) {
+                // Handle scoped packages like @pgpm/base32
+                const scopeDir = path_1.default.join(extensionsDir, entry.name);
+                const scopedEntries = fs_1.default.readdirSync(scopeDir, { withFileTypes: true });
+                for (const scopedEntry of scopedEntries) {
+                    if (scopedEntry.isDirectory()) {
+                        installed.push(`${entry.name}/${scopedEntry.name}`);
+                    }
+                }
+            }
+            else {
+                // Handle non-scoped packages
+                installed.push(entry.name);
+            }
+        }
+        return installed;
+    }
     /**
      * Updates installed pgpm modules to their latest versions from npm.
      * Re-installs each module to get the latest version.

package/esm/core/class/pgpm.js

@@ -23,6 +23,11 @@ import { packageModule } from '../../packaging/package';
 import { resolveExtensionDependencies, resolveDependencies } from '../../resolution/deps';
 import { parseTarget } from '../../utils/target-utils';
 const logger = new Logger('pgpm');
+/**
+ * Directory name for workspace extensions.
+ * Extensions are installed globally in the workspace's extensions/ directory.
+ */
+const EXTENSIONS_DIR = 'extensions';
 function getUTCTimestamp(d = new Date()) {
     return (d.getUTCFullYear() +
         '-' + String(d.getUTCMonth() + 1).padStart(2, '0') +
@@ -747,7 +752,7 @@ ${dependencies.length > 0 ? dependencies.map(dep => `-- requires: ${dep}`).join(
         this.ensureWorkspace();
         this.ensureModule();
         const originalDir = process.cwd();
-        const skitchExtDir = path.join(this.workspacePath, 'extensions');
+        const skitchExtDir = path.join(this.workspacePath, EXTENSIONS_DIR);
         const pkgJsonPath = path.join(this.modulePath, 'package.json');
         if (!fs.existsSync(pkgJsonPath)) {
             throw new Error(`No package.json found at module path: ${this.modulePath}`);
@@ -850,7 +855,7 @@ ${dependencies.length > 0 ? dependencies.map(dep => `-- requires: ${dep}`).join(
         }
         const pkgData = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf-8'));
         const dependencies = pkgData.dependencies || {};
-        const skitchExtDir = path.join(this.workspacePath, 'extensions');
+        const skitchExtDir = path.join(this.workspacePath, EXTENSIONS_DIR);
         const installed = [];
         const installedVersions = {};
         for (const [name, version] of Object.entries(dependencies)) {
@@ -862,6 +867,43 @@ ${dependencies.length > 0 ? dependencies.map(dep => `-- requires: ${dep}`).join(
         }
         return { installed, installedVersions };
     }
+    /**
+     * Returns all pgpm modules installed in the workspace extensions directory.
+     * Unlike getInstalledModules(), this does NOT require being inside a module.
+     * It scans the workspace/extensions/ directory directly to find installed packages.
+     *
+     * This is useful for checking what's available at workspace level before a module exists.
+     *
+     * @returns Array of installed npm package names (e.g., '@pgpm/base32', '@pgpm/totp')
+     */
+    getWorkspaceInstalledModules() {
+        this.ensureWorkspace();
+        const extensionsDir = path.join(this.workspacePath, EXTENSIONS_DIR);
+        if (!fs.existsSync(extensionsDir)) {
+            return [];
+        }
+        const installed = [];
+        const entries = fs.readdirSync(extensionsDir, { withFileTypes: true });
+        for (const entry of entries) {
+            if (!entry.isDirectory())
+                continue;
+            if (entry.name.startsWith('@')) {
+                // Handle scoped packages like @pgpm/base32
+                const scopeDir = path.join(extensionsDir, entry.name);
+                const scopedEntries = fs.readdirSync(scopeDir, { withFileTypes: true });
+                for (const scopedEntry of scopedEntries) {
+                    if (scopedEntry.isDirectory()) {
+                        installed.push(`${entry.name}/${scopedEntry.name}`);
+                    }
+                }
+            }
+            else {
+                // Handle non-scoped packages
+                installed.push(entry.name);
+            }
+        }
+        return installed;
+    }
     /**
      * Updates installed pgpm modules to their latest versions from npm.
      * Re-installs each module to get the latest version.

package/esm/export/export-migrations.js

@@ -3,9 +3,95 @@ import { sync as glob } from 'glob';
 import { toSnakeCase } from 'komoji';
 import path from 'path';
 import { getPgPool } from 'pg-cache';
-import { writeSqitchFiles, writeSqitchPlan } from '../files';
+import { PgpmPackage } from '../core/class/pgpm';
+import { writePgpmFiles, writePgpmPlan } from '../files';
+import { getMissingInstallableModules } from '../modules/modules';
 import { exportMeta } from './export-meta';
-const exportMigrationsToDisk = async ({ project, options, database, databaseId, author, outdir, schema_names, extensionName, metaExtensionName }) => {
+/**
+ * Required extensions for database schema exports.
+ * Includes native PostgreSQL extensions and pgpm modules.
+ */
+const DB_REQUIRED_EXTENSIONS = [
+    'plpgsql',
+    'uuid-ossp',
+    'citext',
+    'pgcrypto',
+    'btree_gist',
+    'postgis',
+    'hstore',
+    'db-meta-schema',
+    'pgpm-inflection',
+    'pgpm-uuid',
+    'pgpm-utils',
+    'pgpm-database-jobs',
+    'pgpm-jwt-claims',
+    'pgpm-stamps',
+    'pgpm-base32',
+    'pgpm-totp',
+    'pgpm-types'
+];
+/**
+ * Required extensions for service/meta exports.
+ * Includes native PostgreSQL extensions and pgpm modules for metadata management.
+ */
+const SERVICE_REQUIRED_EXTENSIONS = [
+    'plpgsql',
+    'db-meta-schema',
+    'db-meta-modules'
+];
+/**
+ * Checks which pgpm modules from the extensions list are missing from the workspace
+ * and prompts the user if they want to install them.
+ *
+ * This function only does detection and prompting - it does NOT install.
+ * Use installMissingModules() after the module is created to do the actual installation.
+ *
+ * @param project - The PgpmPackage instance (only needs workspace context)
+ * @param extensions - List of extension names (control file names)
+ * @param prompter - Optional prompter for interactive confirmation
+ * @returns Object with missing modules and whether user wants to install them
+ */
+const detectMissingModules = async (project, extensions, prompter) => {
+    // Use workspace-level check - doesn't require being inside a module
+    const installed = project.getWorkspaceInstalledModules();
+    const missingModules = getMissingInstallableModules(extensions, installed);
+    if (missingModules.length === 0) {
+        return { missingModules: [], shouldInstall: false };
+    }
+    const missingNames = missingModules.map(m => m.npmName);
+    console.log(`\nMissing pgpm modules detected: ${missingNames.join(', ')}`);
+    if (prompter) {
+        const { install } = await prompter.prompt({}, [
+            {
+                type: 'confirm',
+                name: 'install',
+                message: `Install missing modules (${missingNames.join(', ')})?`,
+                default: true
+            }
+        ]);
+        return { missingModules, shouldInstall: install };
+    }
+    return { missingModules, shouldInstall: false };
+};
+/**
+ * Installs missing modules into a specific module directory.
+ * Must be called after the module has been created.
+ *
+ * @param moduleDir - The directory of the module to install into
+ * @param missingModules - Array of missing modules to install
+ */
+const installMissingModules = async (moduleDir, missingModules) => {
+    if (missingModules.length === 0) {
+        return;
+    }
+    const missingNames = missingModules.map(m => m.npmName);
+    console.log('Installing missing modules...');
+    // Create a new PgpmPackage instance pointing to the module directory
+    const moduleProject = new PgpmPackage(moduleDir);
+    await moduleProject.installModules(...missingNames);
+    console.log('Modules installed successfully.');
+};
+const exportMigrationsToDisk = async ({ project, options, database, databaseId, databaseName, author, outdir, schema_names, extensionName, extensionDesc, metaExtensionName, metaExtensionDesc, prompter }) => {
     outdir = outdir + '/';
     const pgPool = getPgPool({
         ...options.pg,
@@ -33,47 +119,51 @@ const exportMigrationsToDisk = async ({ project, options, database, databaseId,
         outdir,
         author
     };
+    // Build description for the database extension package
+    const dbExtensionDesc = extensionDesc || `${name} database schema for ${databaseName}`;
     if (results?.rows?.length > 0) {
-        await preparePackage({
+        // Detect missing modules at workspace level and prompt user
+        const dbMissingResult = await detectMissingModules(project, [...DB_REQUIRED_EXTENSIONS], prompter);
+        // Create/prepare the module directory
+        const dbModuleDir = await preparePackage({
             project,
             author,
             outdir,
             name,
-            extensions: [
-                'plpgsql',
-                'uuid-ossp',
-                'citext',
-                'pgcrypto',
-                'btree_gist',
-                'postgis',
-                'hstore',
-                'db-meta-schema',
-                'pgpm-inflection',
-                'pgpm-uuid',
-                'pgpm-utils',
-                'pgpm-database-jobs',
-                'pgpm-jwt-claims',
-                'pgpm-stamps',
-                'pgpm-base32',
-                'pgpm-totp',
-                'pgpm-types'
-            ]
+            description: dbExtensionDesc,
+            extensions: [...DB_REQUIRED_EXTENSIONS],
+            prompter
         });
-        writeSqitchPlan(results.rows, opts);
-        writeSqitchFiles(results.rows, opts);
+        // Install missing modules if user confirmed (now that module exists)
+        if (dbMissingResult.shouldInstall) {
+            await installMissingModules(dbModuleDir, dbMissingResult.missingModules);
+        }
+        writePgpmPlan(results.rows, opts);
+        writePgpmFiles(results.rows, opts);
         let meta = await exportMeta({
             opts: options,
             dbname: database,
             database_id: databaseId
         });
         meta = replacer(meta);
-        await preparePackage({
+        // Build description for the meta/service extension package
+        const metaDesc = metaExtensionDesc || `${metaExtensionName} service utilities for managing domains, APIs, and services`;
+        // Detect missing modules at workspace level and prompt user
+        const svcMissingResult = await detectMissingModules(project, [...SERVICE_REQUIRED_EXTENSIONS], prompter);
+        // Create/prepare the module directory
+        const svcModuleDir = await preparePackage({
             project,
             author,
             outdir,
-            extensions: ['plpgsql', 'db-meta-schema', 'db-meta-modules'],
-            name: metaExtensionName
+            name: metaExtensionName,
+            description: metaDesc,
+            extensions: [...SERVICE_REQUIRED_EXTENSIONS],
+            prompter
         });
+        // Install missing modules if user confirmed (now that module exists)
+        if (svcMissingResult.shouldInstall) {
+            await installMissingModules(svcModuleDir, svcMissingResult.missingModules);
+        }
         const metaReplacer = makeReplacer({
             schemas: schemas.rows.filter((schema) => schema_names.includes(schema.schema_name)),
             name: metaExtensionName
@@ -100,11 +190,15 @@ $LQLMIGRATION$;
 
 ${meta}
 
-UPDATE meta_public.apis
-      SET dbname = current_database() WHERE TRUE;
+-- TODO: Research needed - These UPDATE statements may be a security leak.
+-- They appear to rebind exported metadata to the target database after import,
+-- but exposing dbname in meta_public tables could leak internal database names.
+-- Consider removing entirely or gating behind an explicit flag.
+-- UPDATE meta_public.apis
+--       SET dbname = current_database() WHERE TRUE;
 
-UPDATE meta_public.sites
-      SET dbname = current_database() WHERE TRUE;
+-- UPDATE meta_public.sites
+--       SET dbname = current_database() WHERE TRUE;
 
 SET session_replication_role TO DEFAULT;
 `
@@ -112,50 +206,78 @@ SET session_replication_role TO DEFAULT;
         ];
         opts.replacer = metaReplacer.replacer;
         opts.name = metaExtensionName;
-        writeSqitchPlan(metaPackage, opts);
-        writeSqitchFiles(metaPackage, opts);
+        writePgpmPlan(metaPackage, opts);
+        writePgpmFiles(metaPackage, opts);
     }
     pgPool.end();
 };
-export const exportMigrations = async ({ project, options, dbInfo, author, outdir, schema_names, extensionName, metaExtensionName }) => {
+export const exportMigrations = async ({ project, options, dbInfo, author, outdir, schema_names, extensionName, extensionDesc, metaExtensionName, metaExtensionDesc, prompter }) => {
     for (let v = 0; v < dbInfo.database_ids.length; v++) {
         const databaseId = dbInfo.database_ids[v];
         await exportMigrationsToDisk({
             project,
             options,
             extensionName,
+            extensionDesc,
             metaExtensionName,
+            metaExtensionDesc,
             database: dbInfo.dbname,
+            databaseName: dbInfo.databaseName,
             databaseId,
             schema_names,
             author,
-            outdir
+            outdir,
+            prompter
         });
     }
 };
 /**
- * Creates a Sqitch package directory or resets the deploy/revert/verify directories if it exists.
+ * Creates a PGPM package directory or resets the deploy/revert/verify directories if it exists.
+ * If the module already exists and a prompter is provided, prompts the user for confirmation.
+ *
+ * @returns The absolute path to the created/prepared module directory
  */
-const preparePackage = async ({ project, author, outdir, name, extensions }) => {
+const preparePackage = async ({ project, author, outdir, name, description, extensions, prompter }) => {
     const curDir = process.cwd();
-    const sqitchDir = path.resolve(path.join(outdir, name));
-    mkdirSync(sqitchDir, { recursive: true });
-    process.chdir(sqitchDir);
-    const plan = glob(path.join(sqitchDir, 'pgpm.plan'));
+    const pgpmDir = path.resolve(path.join(outdir, name));
+    mkdirSync(pgpmDir, { recursive: true });
+    process.chdir(pgpmDir);
+    const plan = glob(path.join(pgpmDir, 'pgpm.plan'));
     if (!plan.length) {
         await project.initModule({
             name,
-            description: name,
+            description,
             author,
             extensions,
+            answers: {
+                moduleName: name,
+                moduleDesc: description,
+                access: 'restricted',
+                license: 'CLOSED'
+            }
         });
     }
     else {
-        rmSync(path.resolve(sqitchDir, 'deploy'), { recursive: true, force: true });
-        rmSync(path.resolve(sqitchDir, 'revert'), { recursive: true, force: true });
-        rmSync(path.resolve(sqitchDir, 'verify'), { recursive: true, force: true });
+        if (prompter) {
+            const { overwrite } = await prompter.prompt({}, [
+                {
+                    type: 'confirm',
+                    name: 'overwrite',
+                    message: `Module "${name}" already exists at ${pgpmDir}. Overwrite deploy/revert/verify directories?`,
+                    default: false
+                }
+            ]);
+            if (!overwrite) {
+                process.chdir(curDir);
+                throw new Error(`Export cancelled: Module "${name}" already exists.`);
+            }
+        }
+        rmSync(path.resolve(pgpmDir, 'deploy'), { recursive: true, force: true });
+        rmSync(path.resolve(pgpmDir, 'revert'), { recursive: true, force: true });
+        rmSync(path.resolve(pgpmDir, 'verify'), { recursive: true, force: true });
     }
     process.chdir(curDir);
+    return pgpmDir;
 };
 /**
  * Generates a function for replacing schema names and extension names in strings.

package/esm/files/plan/writer.js

@@ -1,9 +1,9 @@
 import fs from 'fs';
 import path from 'path';
 /**
- * Write a Sqitch plan file based on the provided rows
+ * Write a PGPM plan file based on the provided rows
  */
-export function writeSqitchPlan(rows, opts) {
+export function writePgpmPlan(rows, opts) {
     const dir = path.resolve(path.join(opts.outdir, opts.name));
     fs.mkdirSync(dir, { recursive: true });
     const date = () => '2017-08-11T08:11:51Z'; // stubbed timestamp
@@ -126,3 +126,7 @@ export function generateTagLineContent(tag) {
     }
     return line;
 }
+/**
+ * @deprecated Use writePgpmPlan instead. This alias is kept for backwards compatibility.
+ */
+export const writeSqitchPlan = writePgpmPlan;

package/esm/files/sql/writer.js

@@ -2,9 +2,9 @@ import { getEnvOptions } from '@pgpmjs/env';
 import fs from 'fs';
 import path from 'path';
 /**
- * Write SQL files for Sqitch migrations (deploy, revert, verify)
+ * Write SQL files for PGPM migrations (deploy, revert, verify)
  */
-export const writeSqitchFiles = (rows, opts) => {
+export const writePgpmFiles = (rows, opts) => {
     rows.forEach((row) => writeVerify(row, opts));
     rows.forEach((row) => writeRevert(row, opts));
     rows.forEach((row) => writeDeploy(row, opts));
@@ -18,7 +18,7 @@ const ordered = (arr) => {
     return arr.sort((a, b) => a.length - b.length || a.localeCompare(b));
 };
 /**
- * Write a deploy SQL file for a Sqitch change
+ * Write a deploy SQL file for a PGPM change
  */
 const writeDeploy = (row, opts) => {
     const globalOpts = getEnvOptions({
@@ -50,7 +50,7 @@ ${useTx ? 'COMMIT;' : ''}
     fs.writeFileSync(actualFile, content);
 };
 /**
- * Write a verify SQL file for a Sqitch change
+ * Write a verify SQL file for a PGPM change
  */
 const writeVerify = (row, opts) => {
     const globalOpts = getEnvOptions({
@@ -78,7 +78,7 @@ ${useTx ? 'COMMIT;' : ''}
     fs.writeFileSync(actualFile, content);
 };
 /**
- * Write a revert SQL file for a Sqitch change
+ * Write a revert SQL file for a PGPM change
  */
 const writeRevert = (row, opts) => {
     const globalOpts = getEnvOptions({
@@ -105,3 +105,7 @@ ${useTx ? 'COMMIT;' : ''}
 `;
     fs.writeFileSync(actualFile, content);
 };
+/**
+ * @deprecated Use writePgpmFiles instead. This alias is kept for backwards compatibility.
+ */
+export const writeSqitchFiles = writePgpmFiles;

package/esm/modules/modules.js

@@ -1,5 +1,44 @@
 import { getLatestChange } from '../files';
 import { errors } from '@pgpmjs/types';
+/**
+ * Mapping from control file names (used in extensions list) to npm package names.
+ * Only includes modules that can be installed via pgpm install from @pgpm/* packages.
+ * Native PostgreSQL extensions (plpgsql, uuid-ossp, etc.) are not included.
+ */
+export const PGPM_MODULE_MAP = {
+    'pgpm-base32': '@pgpm/base32',
+    'pgpm-database-jobs': '@pgpm/database-jobs',
+    'db-meta-modules': '@pgpm/db-meta-modules',
+    'db-meta-schema': '@pgpm/db-meta-schema',
+    'pgpm-inflection': '@pgpm/inflection',
+    'pgpm-jwt-claims': '@pgpm/jwt-claims',
+    'pgpm-stamps': '@pgpm/stamps',
+    'pgpm-totp': '@pgpm/totp',
+    'pgpm-types': '@pgpm/types',
+    'pgpm-utils': '@pgpm/utils',
+    'pgpm-uuid': '@pgpm/uuid'
+};
+/**
+ * Determines which pgpm modules from an extensions list are missing from the installed modules.
+ * Only checks modules that are in PGPM_MODULE_MAP (installable via pgpm install).
+ *
+ * @param extensions - List of extension/control file names to check
+ * @param installedModules - List of installed npm package names (e.g., '@pgpm/base32')
+ * @returns Array of missing modules with their control names and npm package names
+ */
+export const getMissingInstallableModules = (extensions, installedModules) => {
+    const missingModules = [];
+    for (const ext of extensions) {
+        const npmName = PGPM_MODULE_MAP[ext];
+        if (npmName && !installedModules.includes(npmName)) {
+            missingModules.push({
+                controlName: ext,
+                npmName
+            });
+        }
+    }
+    return missingModules;
+};
 /**
  * Get the latest change from the pgpm.plan file for a specific module.
  */

package/export/export-migrations.d.ts

@@ -1,17 +1,28 @@
 import { PgpmOptions } from '@pgpmjs/types';
 import { PgpmPackage } from '../core/class/pgpm';
+/**
+ * Prompter interface for interactive prompts.
+ * Compatible with Inquirerer from the CLI.
+ */
+interface Prompter {
+    prompt: (argv: any, questions: any[]) => Promise<Record<string, any>>;
+}
 interface ExportOptions {
     project: PgpmPackage;
     options: PgpmOptions;
     dbInfo: {
         dbname: string;
+        databaseName: string;
         database_ids: string[];
     };
     author: string;
     outdir: string;
     schema_names: string[];
     extensionName?: string;
+    extensionDesc?: string;
     metaExtensionName: string;
+    metaExtensionDesc?: string;
+    prompter?: Prompter;
 }
-export declare const exportMigrations: ({ project, options, dbInfo, author, outdir, schema_names, extensionName, metaExtensionName }: ExportOptions) => Promise<void>;
+export declare const exportMigrations: ({ project, options, dbInfo, author, outdir, schema_names, extensionName, extensionDesc, metaExtensionName, metaExtensionDesc, prompter }: ExportOptions) => Promise<void>;
 export {};

package/export/export-migrations.js

@@ -9,9 +9,95 @@ const glob_1 = require("glob");
 const komoji_1 = require("komoji");
 const path_1 = __importDefault(require("path"));
 const pg_cache_1 = require("pg-cache");
+const pgpm_1 = require("../core/class/pgpm");
 const files_1 = require("../files");
+const modules_1 = require("../modules/modules");
 const export_meta_1 = require("./export-meta");
-const exportMigrationsToDisk = async ({ project, options, database, databaseId, author, outdir, schema_names, extensionName, metaExtensionName }) => {
+/**
+ * Required extensions for database schema exports.
+ * Includes native PostgreSQL extensions and pgpm modules.
+ */
+const DB_REQUIRED_EXTENSIONS = [
+    'plpgsql',
+    'uuid-ossp',
+    'citext',
+    'pgcrypto',
+    'btree_gist',
+    'postgis',
+    'hstore',
+    'db-meta-schema',
+    'pgpm-inflection',
+    'pgpm-uuid',
+    'pgpm-utils',
+    'pgpm-database-jobs',
+    'pgpm-jwt-claims',
+    'pgpm-stamps',
+    'pgpm-base32',
+    'pgpm-totp',
+    'pgpm-types'
+];
+/**
+ * Required extensions for service/meta exports.
+ * Includes native PostgreSQL extensions and pgpm modules for metadata management.
+ */
+const SERVICE_REQUIRED_EXTENSIONS = [
+    'plpgsql',
+    'db-meta-schema',
+    'db-meta-modules'
+];
+/**
+ * Checks which pgpm modules from the extensions list are missing from the workspace
+ * and prompts the user if they want to install them.
+ *
+ * This function only does detection and prompting - it does NOT install.
+ * Use installMissingModules() after the module is created to do the actual installation.
+ *
+ * @param project - The PgpmPackage instance (only needs workspace context)
+ * @param extensions - List of extension names (control file names)
+ * @param prompter - Optional prompter for interactive confirmation
+ * @returns Object with missing modules and whether user wants to install them
+ */
+const detectMissingModules = async (project, extensions, prompter) => {
+    // Use workspace-level check - doesn't require being inside a module
+    const installed = project.getWorkspaceInstalledModules();
+    const missingModules = (0, modules_1.getMissingInstallableModules)(extensions, installed);
+    if (missingModules.length === 0) {
+        return { missingModules: [], shouldInstall: false };
+    }
+    const missingNames = missingModules.map(m => m.npmName);
+    console.log(`\nMissing pgpm modules detected: ${missingNames.join(', ')}`);
+    if (prompter) {
+        const { install } = await prompter.prompt({}, [
+            {
+                type: 'confirm',
+                name: 'install',
+                message: `Install missing modules (${missingNames.join(', ')})?`,
+                default: true
+            }
+        ]);
+        return { missingModules, shouldInstall: install };
+    }
+    return { missingModules, shouldInstall: false };
+};
+/**
+ * Installs missing modules into a specific module directory.
+ * Must be called after the module has been created.
+ *
+ * @param moduleDir - The directory of the module to install into
+ * @param missingModules - Array of missing modules to install
+ */
+const installMissingModules = async (moduleDir, missingModules) => {
+    if (missingModules.length === 0) {
+        return;
+    }
+    const missingNames = missingModules.map(m => m.npmName);
+    console.log('Installing missing modules...');
+    // Create a new PgpmPackage instance pointing to the module directory
+    const moduleProject = new pgpm_1.PgpmPackage(moduleDir);
+    await moduleProject.installModules(...missingNames);
+    console.log('Modules installed successfully.');
+};
+const exportMigrationsToDisk = async ({ project, options, database, databaseId, databaseName, author, outdir, schema_names, extensionName, extensionDesc, metaExtensionName, metaExtensionDesc, prompter }) => {
     outdir = outdir + '/';
     const pgPool = (0, pg_cache_1.getPgPool)({
         ...options.pg,
@@ -39,47 +125,51 @@ const exportMigrationsToDisk = async ({ project, options, database, databaseId,
         outdir,
         author
     };
+    // Build description for the database extension package
+    const dbExtensionDesc = extensionDesc || `${name} database schema for ${databaseName}`;
     if (results?.rows?.length > 0) {
-        await preparePackage({
+        // Detect missing modules at workspace level and prompt user
+        const dbMissingResult = await detectMissingModules(project, [...DB_REQUIRED_EXTENSIONS], prompter);
+        // Create/prepare the module directory
+        const dbModuleDir = await preparePackage({
             project,
             author,
             outdir,
             name,
-            extensions: [
-                'plpgsql',
-                'uuid-ossp',
-                'citext',
-                'pgcrypto',
-                'btree_gist',
-                'postgis',
-                'hstore',
-                'db-meta-schema',
-                'pgpm-inflection',
-                'pgpm-uuid',
-                'pgpm-utils',
-                'pgpm-database-jobs',
-                'pgpm-jwt-claims',
-                'pgpm-stamps',
-                'pgpm-base32',
-                'pgpm-totp',
-                'pgpm-types'
-            ]
+            description: dbExtensionDesc,
+            extensions: [...DB_REQUIRED_EXTENSIONS],
+            prompter
         });
-        (0, files_1.writeSqitchPlan)(results.rows, opts);
-        (0, files_1.writeSqitchFiles)(results.rows, opts);
+        // Install missing modules if user confirmed (now that module exists)
+        if (dbMissingResult.shouldInstall) {
+            await installMissingModules(dbModuleDir, dbMissingResult.missingModules);
+        }
+        (0, files_1.writePgpmPlan)(results.rows, opts);
+        (0, files_1.writePgpmFiles)(results.rows, opts);
         let meta = await (0, export_meta_1.exportMeta)({
             opts: options,
             dbname: database,
             database_id: databaseId
         });
         meta = replacer(meta);
-        await preparePackage({
+        // Build description for the meta/service extension package
+        const metaDesc = metaExtensionDesc || `${metaExtensionName} service utilities for managing domains, APIs, and services`;
+        // Detect missing modules at workspace level and prompt user
+        const svcMissingResult = await detectMissingModules(project, [...SERVICE_REQUIRED_EXTENSIONS], prompter);
+        // Create/prepare the module directory
+        const svcModuleDir = await preparePackage({
             project,
             author,
             outdir,
-            extensions: ['plpgsql', 'db-meta-schema', 'db-meta-modules'],
-            name: metaExtensionName
+            name: metaExtensionName,
+            description: metaDesc,
+            extensions: [...SERVICE_REQUIRED_EXTENSIONS],
+            prompter
         });
+        // Install missing modules if user confirmed (now that module exists)
+        if (svcMissingResult.shouldInstall) {
+            await installMissingModules(svcModuleDir, svcMissingResult.missingModules);
+        }
         const metaReplacer = makeReplacer({
             schemas: schemas.rows.filter((schema) => schema_names.includes(schema.schema_name)),
             name: metaExtensionName
@@ -106,11 +196,15 @@ $LQLMIGRATION$;
 
 ${meta}
 
-UPDATE meta_public.apis
-      SET dbname = current_database() WHERE TRUE;
+-- TODO: Research needed - These UPDATE statements may be a security leak.
+-- They appear to rebind exported metadata to the target database after import,
+-- but exposing dbname in meta_public tables could leak internal database names.
+-- Consider removing entirely or gating behind an explicit flag.
+-- UPDATE meta_public.apis
+--       SET dbname = current_database() WHERE TRUE;
 
-UPDATE meta_public.sites
-      SET dbname = current_database() WHERE TRUE;
+-- UPDATE meta_public.sites
+--       SET dbname = current_database() WHERE TRUE;
 
 SET session_replication_role TO DEFAULT;
 `
@@ -118,51 +212,79 @@ SET session_replication_role TO DEFAULT;
         ];
         opts.replacer = metaReplacer.replacer;
         opts.name = metaExtensionName;
-        (0, files_1.writeSqitchPlan)(metaPackage, opts);
-        (0, files_1.writeSqitchFiles)(metaPackage, opts);
+        (0, files_1.writePgpmPlan)(metaPackage, opts);
+        (0, files_1.writePgpmFiles)(metaPackage, opts);
     }
     pgPool.end();
 };
-const exportMigrations = async ({ project, options, dbInfo, author, outdir, schema_names, extensionName, metaExtensionName }) => {
+const exportMigrations = async ({ project, options, dbInfo, author, outdir, schema_names, extensionName, extensionDesc, metaExtensionName, metaExtensionDesc, prompter }) => {
     for (let v = 0; v < dbInfo.database_ids.length; v++) {
         const databaseId = dbInfo.database_ids[v];
         await exportMigrationsToDisk({
             project,
             options,
             extensionName,
+            extensionDesc,
             metaExtensionName,
+            metaExtensionDesc,
             database: dbInfo.dbname,
+            databaseName: dbInfo.databaseName,
             databaseId,
             schema_names,
             author,
-            outdir
+            outdir,
+            prompter
         });
     }
 };
 exports.exportMigrations = exportMigrations;
 /**
- * Creates a Sqitch package directory or resets the deploy/revert/verify directories if it exists.
+ * Creates a PGPM package directory or resets the deploy/revert/verify directories if it exists.
+ * If the module already exists and a prompter is provided, prompts the user for confirmation.
+ *
+ * @returns The absolute path to the created/prepared module directory
  */
-const preparePackage = async ({ project, author, outdir, name, extensions }) => {
+const preparePackage = async ({ project, author, outdir, name, description, extensions, prompter }) => {
     const curDir = process.cwd();
-    const sqitchDir = path_1.default.resolve(path_1.default.join(outdir, name));
-    (0, fs_1.mkdirSync)(sqitchDir, { recursive: true });
-    process.chdir(sqitchDir);
-    const plan = (0, glob_1.sync)(path_1.default.join(sqitchDir, 'pgpm.plan'));
+    const pgpmDir = path_1.default.resolve(path_1.default.join(outdir, name));
+    (0, fs_1.mkdirSync)(pgpmDir, { recursive: true });
+    process.chdir(pgpmDir);
+    const plan = (0, glob_1.sync)(path_1.default.join(pgpmDir, 'pgpm.plan'));
     if (!plan.length) {
         await project.initModule({
             name,
-            description: name,
+            description,
             author,
             extensions,
+            answers: {
+                moduleName: name,
+                moduleDesc: description,
+                access: 'restricted',
+                license: 'CLOSED'
+            }
         });
     }
     else {
-        (0, fs_1.rmSync)(path_1.default.resolve(sqitchDir, 'deploy'), { recursive: true, force: true });
-        (0, fs_1.rmSync)(path_1.default.resolve(sqitchDir, 'revert'), { recursive: true, force: true });
-        (0, fs_1.rmSync)(path_1.default.resolve(sqitchDir, 'verify'), { recursive: true, force: true });
+        if (prompter) {
+            const { overwrite } = await prompter.prompt({}, [
+                {
+                    type: 'confirm',
+                    name: 'overwrite',
+                    message: `Module "${name}" already exists at ${pgpmDir}. Overwrite deploy/revert/verify directories?`,
+                    default: false
+                }
+            ]);
+            if (!overwrite) {
+                process.chdir(curDir);
+                throw new Error(`Export cancelled: Module "${name}" already exists.`);
+            }
+        }
+        (0, fs_1.rmSync)(path_1.default.resolve(pgpmDir, 'deploy'), { recursive: true, force: true });
+        (0, fs_1.rmSync)(path_1.default.resolve(pgpmDir, 'revert'), { recursive: true, force: true });
+        (0, fs_1.rmSync)(path_1.default.resolve(pgpmDir, 'verify'), { recursive: true, force: true });
     }
     process.chdir(curDir);
+    return pgpmDir;
 };
 /**
  * Generates a function for replacing schema names and extension names in strings.

package/files/plan/writer.d.ts

@@ -1,4 +1,4 @@
-import { Change, SqitchRow, Tag, ExtendedPlanFile } from '../types';
+import { Change, PgpmRow, Tag, ExtendedPlanFile } from '../types';
 export interface PlanWriteOptions {
     outdir: string;
     name: string;
@@ -6,9 +6,9 @@ export interface PlanWriteOptions {
     author?: string;
 }
 /**
- * Write a Sqitch plan file based on the provided rows
+ * Write a PGPM plan file based on the provided rows
  */
-export declare function writeSqitchPlan(rows: SqitchRow[], opts: PlanWriteOptions): void;
+export declare function writePgpmPlan(rows: PgpmRow[], opts: PlanWriteOptions): void;
 /**
  * Write a plan file with the provided content
  */
@@ -25,3 +25,7 @@ export declare function generateChangeLineContent(change: Change): string;
  * Generate a line for a tag in a plan file
  */
 export declare function generateTagLineContent(tag: Tag): string;
+/**
+ * @deprecated Use writePgpmPlan instead. This alias is kept for backwards compatibility.
+ */
+export declare const writeSqitchPlan: typeof writePgpmPlan;

package/files/plan/writer.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeSqitchPlan = writeSqitchPlan;
+exports.writeSqitchPlan = void 0;
+exports.writePgpmPlan = writePgpmPlan;
 exports.writePlanFile = writePlanFile;
 exports.generatePlanFileContent = generatePlanFileContent;
 exports.generateChangeLineContent = generateChangeLineContent;
@@ -11,9 +12,9 @@ exports.generateTagLineContent = generateTagLineContent;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 /**
- * Write a Sqitch plan file based on the provided rows
+ * Write a PGPM plan file based on the provided rows
  */
-function writeSqitchPlan(rows, opts) {
+function writePgpmPlan(rows, opts) {
     const dir = path_1.default.resolve(path_1.default.join(opts.outdir, opts.name));
     fs_1.default.mkdirSync(dir, { recursive: true });
     const date = () => '2017-08-11T08:11:51Z'; // stubbed timestamp
@@ -136,3 +137,7 @@ function generateTagLineContent(tag) {
     }
     return line;
 }
+/**
+ * @deprecated Use writePgpmPlan instead. This alias is kept for backwards compatibility.
+ */
+exports.writeSqitchPlan = writePgpmPlan;

package/files/sql/writer.d.ts

@@ -1,4 +1,4 @@
-import { SqitchRow } from '../types';
+import { PgpmRow } from '../types';
 export interface SqlWriteOptions {
     outdir: string;
     name: string;
@@ -7,6 +7,10 @@ export interface SqlWriteOptions {
     useTx?: boolean;
 }
 /**
- * Write SQL files for Sqitch migrations (deploy, revert, verify)
+ * Write SQL files for PGPM migrations (deploy, revert, verify)
  */
-export declare const writeSqitchFiles: (rows: SqitchRow[], opts: SqlWriteOptions) => void;
+export declare const writePgpmFiles: (rows: PgpmRow[], opts: SqlWriteOptions) => void;
+/**
+ * @deprecated Use writePgpmFiles instead. This alias is kept for backwards compatibility.
+ */
+export declare const writeSqitchFiles: (rows: PgpmRow[], opts: SqlWriteOptions) => void;

package/files/sql/writer.js

@@ -3,19 +3,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeSqitchFiles = void 0;
+exports.writeSqitchFiles = exports.writePgpmFiles = void 0;
 const env_1 = require("@pgpmjs/env");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 /**
- * Write SQL files for Sqitch migrations (deploy, revert, verify)
+ * Write SQL files for PGPM migrations (deploy, revert, verify)
  */
-const writeSqitchFiles = (rows, opts) => {
+const writePgpmFiles = (rows, opts) => {
     rows.forEach((row) => writeVerify(row, opts));
     rows.forEach((row) => writeRevert(row, opts));
     rows.forEach((row) => writeDeploy(row, opts));
 };
-exports.writeSqitchFiles = writeSqitchFiles;
+exports.writePgpmFiles = writePgpmFiles;
 /**
  * Sort dependencies in a consistent order
  */
@@ -25,7 +25,7 @@ const ordered = (arr) => {
     return arr.sort((a, b) => a.length - b.length || a.localeCompare(b));
 };
 /**
- * Write a deploy SQL file for a Sqitch change
+ * Write a deploy SQL file for a PGPM change
  */
 const writeDeploy = (row, opts) => {
     const globalOpts = (0, env_1.getEnvOptions)({
@@ -57,7 +57,7 @@ ${useTx ? 'COMMIT;' : ''}
     fs_1.default.writeFileSync(actualFile, content);
 };
 /**
- * Write a verify SQL file for a Sqitch change
+ * Write a verify SQL file for a PGPM change
  */
 const writeVerify = (row, opts) => {
     const globalOpts = (0, env_1.getEnvOptions)({
@@ -85,7 +85,7 @@ ${useTx ? 'COMMIT;' : ''}
     fs_1.default.writeFileSync(actualFile, content);
 };
 /**
- * Write a revert SQL file for a Sqitch change
+ * Write a revert SQL file for a PGPM change
  */
 const writeRevert = (row, opts) => {
     const globalOpts = (0, env_1.getEnvOptions)({
@@ -112,3 +112,7 @@ ${useTx ? 'COMMIT;' : ''}
 `;
     fs_1.default.writeFileSync(actualFile, content);
 };
+/**
+ * @deprecated Use writePgpmFiles instead. This alias is kept for backwards compatibility.
+ */
+exports.writeSqitchFiles = exports.writePgpmFiles;

package/files/types/index.d.ts

@@ -36,7 +36,7 @@ export interface ResolvedReference {
     target: string;
     resolved?: string;
 }
-export interface SqitchRow {
+export interface PgpmRow {
     deploy: string;
     revert?: string;
     verify?: string;
@@ -44,3 +44,7 @@ export interface SqitchRow {
     deps?: string[];
     name?: string;
 }
+/**
+ * @deprecated Use PgpmRow instead. This alias is kept for backwards compatibility.
+ */
+export type SqitchRow = PgpmRow;

package/modules/modules.d.ts

@@ -1,5 +1,27 @@
 import { Module } from '../files';
 export type ModuleMap = Record<string, Module>;
+/**
+ * Mapping from control file names (used in extensions list) to npm package names.
+ * Only includes modules that can be installed via pgpm install from @pgpm/* packages.
+ * Native PostgreSQL extensions (plpgsql, uuid-ossp, etc.) are not included.
+ */
+export declare const PGPM_MODULE_MAP: Record<string, string>;
+/**
+ * Result of checking for missing installable modules.
+ */
+export interface MissingModule {
+    controlName: string;
+    npmName: string;
+}
+/**
+ * Determines which pgpm modules from an extensions list are missing from the installed modules.
+ * Only checks modules that are in PGPM_MODULE_MAP (installable via pgpm install).
+ *
+ * @param extensions - List of extension/control file names to check
+ * @param installedModules - List of installed npm package names (e.g., '@pgpm/base32')
+ * @returns Array of missing modules with their control names and npm package names
+ */
+export declare const getMissingInstallableModules: (extensions: string[], installedModules: string[]) => MissingModule[];
 /**
  * Get the latest change from the pgpm.plan file for a specific module.
  */

package/modules/modules.js

@@ -1,8 +1,48 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getExtensionsAndModulesChanges = exports.getExtensionsAndModules = exports.latestChangeAndVersion = exports.latestChange = void 0;
+exports.getExtensionsAndModulesChanges = exports.getExtensionsAndModules = exports.latestChangeAndVersion = exports.latestChange = exports.getMissingInstallableModules = exports.PGPM_MODULE_MAP = void 0;
 const files_1 = require("../files");
 const types_1 = require("@pgpmjs/types");
+/**
+ * Mapping from control file names (used in extensions list) to npm package names.
+ * Only includes modules that can be installed via pgpm install from @pgpm/* packages.
+ * Native PostgreSQL extensions (plpgsql, uuid-ossp, etc.) are not included.
+ */
+exports.PGPM_MODULE_MAP = {
+    'pgpm-base32': '@pgpm/base32',
+    'pgpm-database-jobs': '@pgpm/database-jobs',
+    'db-meta-modules': '@pgpm/db-meta-modules',
+    'db-meta-schema': '@pgpm/db-meta-schema',
+    'pgpm-inflection': '@pgpm/inflection',
+    'pgpm-jwt-claims': '@pgpm/jwt-claims',
+    'pgpm-stamps': '@pgpm/stamps',
+    'pgpm-totp': '@pgpm/totp',
+    'pgpm-types': '@pgpm/types',
+    'pgpm-utils': '@pgpm/utils',
+    'pgpm-uuid': '@pgpm/uuid'
+};
+/**
+ * Determines which pgpm modules from an extensions list are missing from the installed modules.
+ * Only checks modules that are in PGPM_MODULE_MAP (installable via pgpm install).
+ *
+ * @param extensions - List of extension/control file names to check
+ * @param installedModules - List of installed npm package names (e.g., '@pgpm/base32')
+ * @returns Array of missing modules with their control names and npm package names
+ */
+const getMissingInstallableModules = (extensions, installedModules) => {
+    const missingModules = [];
+    for (const ext of extensions) {
+        const npmName = exports.PGPM_MODULE_MAP[ext];
+        if (npmName && !installedModules.includes(npmName)) {
+            missingModules.push({
+                controlName: ext,
+                npmName
+            });
+        }
+    }
+    return missingModules;
+};
+exports.getMissingInstallableModules = getMissingInstallableModules;
 /**
  * Get the latest change from the pgpm.plan file for a specific module.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgpmjs/core",
-  "version": "4.1.2",
+  "version": "4.2.1",
   "author": "Constructive <developers@constructive.io>",
   "description": "PGPM Package and Migration Tools",
   "main": "index.js",
@@ -64,5 +64,5 @@
     "pgsql-parser": "^17.9.5",
     "yanse": "^0.1.8"
   },
-  "gitHead": "c2e68f9808a87e3231d9b9af5e706bef5dbd2af8"
+  "gitHead": "5b93211b63e72bedcfabc7c4aa41c69ed33d0f6c"
 }