@pgpmjs/core 4.2.0 → 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,6 +3,7 @@ import { sync as glob } from 'glob';
 import { toSnakeCase } from 'komoji';
 import path from 'path';
 import { getPgPool } from 'pg-cache';
+import { PgpmPackage } from '../core/class/pgpm';
 import { writePgpmFiles, writePgpmPlan } from '../files';
 import { getMissingInstallableModules } from '../modules/modules';
 import { exportMeta } from './export-meta';
@@ -40,18 +41,22 @@ const SERVICE_REQUIRED_EXTENSIONS = [
 ];
 /**
  * Checks which pgpm modules from the extensions list are missing from the workspace
- * and prompts the user to install them if a prompter is provided.
+ * and prompts the user if they want to install them.
  *
- * @param project - The PgpmPackage instance
+ * 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 List of extensions that were successfully installed
+ * @returns Object with missing modules and whether user wants to install them
  */
-const promptAndInstallMissingModules = async (project, extensions, prompter) => {
-    const { installed } = project.getInstalledModules();
+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 [];
+        return { missingModules: [], shouldInstall: false };
     }
     const missingNames = missingModules.map(m => m.npmName);
     console.log(`\nMissing pgpm modules detected: ${missingNames.join(', ')}`);
@@ -64,14 +69,27 @@ const promptAndInstallMissingModules = async (project, extensions, prompter) =>
                 default: true
             }
         ]);
-        if (install) {
-            console.log('Installing missing modules...');
-            await project.installModules(...missingNames);
-            console.log('Modules installed successfully.');
-            return missingModules.map(m => m.controlName);
-        }
+        return { missingModules, shouldInstall: install };
     }
-    return [];
+    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 + '/';
@@ -104,8 +122,10 @@ const exportMigrationsToDisk = async ({ project, options, database, databaseId,
     // Build description for the database extension package
     const dbExtensionDesc = extensionDesc || `${name} database schema for ${databaseName}`;
     if (results?.rows?.length > 0) {
-        await promptAndInstallMissingModules(project, [...DB_REQUIRED_EXTENSIONS], prompter);
-        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,
@@ -114,6 +134,10 @@ const exportMigrationsToDisk = async ({ project, options, database, databaseId,
             extensions: [...DB_REQUIRED_EXTENSIONS],
             prompter
         });
+        // 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({
@@ -124,8 +148,10 @@ const exportMigrationsToDisk = async ({ project, options, database, databaseId,
         meta = replacer(meta);
         // Build description for the meta/service extension package
         const metaDesc = metaExtensionDesc || `${metaExtensionName} service utilities for managing domains, APIs, and services`;
-        await promptAndInstallMissingModules(project, [...SERVICE_REQUIRED_EXTENSIONS], prompter);
-        await preparePackage({
+        // 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,
@@ -134,6 +160,10 @@ const exportMigrationsToDisk = async ({ project, options, database, databaseId,
             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
@@ -204,6 +234,8 @@ export const exportMigrations = async ({ project, options, dbInfo, author, outdi
 /**
  * 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, description, extensions, prompter }) => {
     const curDir = process.cwd();
@@ -245,6 +277,7 @@ const preparePackage = async ({ project, author, outdir, name, description, exte
         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/export/export-migrations.js

@@ -9,6 +9,7 @@ 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");
@@ -46,18 +47,22 @@ const SERVICE_REQUIRED_EXTENSIONS = [
 ];
 /**
  * Checks which pgpm modules from the extensions list are missing from the workspace
- * and prompts the user to install them if a prompter is provided.
+ * and prompts the user if they want to install them.
  *
- * @param project - The PgpmPackage instance
+ * 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 List of extensions that were successfully installed
+ * @returns Object with missing modules and whether user wants to install them
  */
-const promptAndInstallMissingModules = async (project, extensions, prompter) => {
-    const { installed } = project.getInstalledModules();
+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 [];
+        return { missingModules: [], shouldInstall: false };
     }
     const missingNames = missingModules.map(m => m.npmName);
     console.log(`\nMissing pgpm modules detected: ${missingNames.join(', ')}`);
@@ -70,14 +75,27 @@ const promptAndInstallMissingModules = async (project, extensions, prompter) =>
                 default: true
             }
         ]);
-        if (install) {
-            console.log('Installing missing modules...');
-            await project.installModules(...missingNames);
-            console.log('Modules installed successfully.');
-            return missingModules.map(m => m.controlName);
-        }
+        return { missingModules, shouldInstall: install };
     }
-    return [];
+    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 + '/';
@@ -110,8 +128,10 @@ const exportMigrationsToDisk = async ({ project, options, database, databaseId,
     // Build description for the database extension package
     const dbExtensionDesc = extensionDesc || `${name} database schema for ${databaseName}`;
     if (results?.rows?.length > 0) {
-        await promptAndInstallMissingModules(project, [...DB_REQUIRED_EXTENSIONS], prompter);
-        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,
@@ -120,6 +140,10 @@ const exportMigrationsToDisk = async ({ project, options, database, databaseId,
             extensions: [...DB_REQUIRED_EXTENSIONS],
             prompter
         });
+        // 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)({
@@ -130,8 +154,10 @@ const exportMigrationsToDisk = async ({ project, options, database, databaseId,
         meta = replacer(meta);
         // Build description for the meta/service extension package
         const metaDesc = metaExtensionDesc || `${metaExtensionName} service utilities for managing domains, APIs, and services`;
-        await promptAndInstallMissingModules(project, [...SERVICE_REQUIRED_EXTENSIONS], prompter);
-        await preparePackage({
+        // 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,
@@ -140,6 +166,10 @@ const exportMigrationsToDisk = async ({ project, options, database, databaseId,
             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
@@ -211,6 +241,8 @@ exports.exportMigrations = exportMigrations;
 /**
  * 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, description, extensions, prompter }) => {
     const curDir = process.cwd();
@@ -252,6 +284,7 @@ const preparePackage = async ({ project, author, outdir, name, description, exte
         (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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgpmjs/core",
-  "version": "4.2.0",
+  "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": "9b68e2d19937ad4e2a81a5de110a197a8572e3d9"
+  "gitHead": "5b93211b63e72bedcfabc7c4aa41c69ed33d0f6c"
 }