@pgpmjs/core 4.9.0 → 4.10.0

package/core/boilerplate-scanner.js

@@ -70,10 +70,31 @@ function scanBoilerplates(baseDir) {
         const boilerplatePath = path_1.default.join(baseDir, entry.name);
         const config = readBoilerplateConfig(boilerplatePath);
         if (config) {
+            // Validate and normalize the type field
+            const validTypes = ['workspace', 'module', 'generic'];
+            const configType = config.type;
+            const type = validTypes.includes(configType)
+                ? configType
+                : 'module';
+            // Validate and normalize requiresWorkspace field
+            const validWorkspaceTypes = ['pgpm', 'pnpm', 'lerna', 'npm'];
+            let requiresWorkspace;
+            if (config.requiresWorkspace === false) {
+                requiresWorkspace = false;
+            }
+            else if (typeof config.requiresWorkspace === 'string' &&
+                validWorkspaceTypes.includes(config.requiresWorkspace)) {
+                requiresWorkspace = config.requiresWorkspace;
+            }
+            else {
+                // Default: 'pgpm' for module type (backward compatibility), undefined for others
+                requiresWorkspace = type === 'module' ? 'pgpm' : undefined;
+            }
             boilerplates.push({
                 name: entry.name,
                 path: boilerplatePath,
-                type: config.type ?? 'module',
+                type,
+                requiresWorkspace,
                 questions: config.questions
             });
         }

package/core/boilerplate-types.d.ts

@@ -2,6 +2,7 @@
  * Boilerplate metadata types for the new metadata-driven resolution system.
  * These types support the `.boilerplate.json` and `.boilerplates.json` configuration files.
  */
+export type { BoilerplateConfig, WorkspaceType } from './template-scaffold';
 /**
  * A question to prompt the user during template scaffolding.
  */
@@ -23,16 +24,6 @@ export interface BoilerplateQuestion {
     /** Auto-set value from resolver, skipping the prompt entirely */
     setFrom?: string;
 }
-/**
- * Configuration for a single boilerplate template.
- * Stored in `.boilerplate.json` within each template directory.
- */
-export interface BoilerplateConfig {
-    /** The type of boilerplate: workspace or module */
-    type: 'workspace' | 'module';
-    /** Questions to prompt the user during scaffolding */
-    questions?: BoilerplateQuestion[];
-}
 /**
  * Root configuration for a boilerplates repository.
  * Stored in `.boilerplates.json` at the repository root.
@@ -50,7 +41,12 @@ export interface ScannedBoilerplate {
     /** The full path to the boilerplate directory */
     path: string;
     /** The type of boilerplate */
-    type: 'workspace' | 'module';
+    type: 'workspace' | 'module' | 'generic';
+    /**
+     * What type of workspace this template requires.
+     * 'pgpm' also indicates pgpm files should be created.
+     */
+    requiresWorkspace?: 'pgpm' | 'pnpm' | 'lerna' | 'npm' | false;
     /** Questions from the boilerplate config */
     questions?: BoilerplateQuestion[];
 }

package/core/class/pgpm.d.ts

@@ -29,6 +29,11 @@ export interface InitModuleOptions {
      * Must be an absolute path or relative to workspace root.
      */
     outputDir?: string;
+    /**
+     * Whether this is a pgpm-managed module that should create pgpm.plan and .control files.
+     * Defaults to true for backward compatibility.
+     */
+    pgpm?: boolean;
 }
 export declare class PgpmPackage {
     cwd: string;

package/core/class/pgpm.js

@@ -364,6 +364,8 @@ class PgpmPackage {
     }
     async initModule(options) {
         this.ensureWorkspace();
+        // Determine if this is a pgpm-managed module (defaults to true for backward compatibility)
+        const isPgpmModule = options.pgpm ?? true;
         // If outputDir is provided, use it directly instead of createModuleDirectory
         let targetPath;
         if (options.outputDir) {
@@ -397,8 +399,11 @@ class PgpmPackage {
             toolName: options.toolName ?? template_scaffold_1.DEFAULT_TEMPLATE_TOOL_NAME,
             cwd: this.cwd
         });
-        this.initModuleSqitch(options.name, targetPath);
-        (0, files_2.writeExtensions)(targetPath, options.extensions);
+        // Only create pgpm files (pgpm.plan, .control, deploy/revert/verify dirs) for pgpm-managed modules
+        if (isPgpmModule) {
+            this.initModuleSqitch(options.name, targetPath);
+            (0, files_2.writeExtensions)(targetPath, options.extensions);
+        }
     }
     // ──────────────── Dependency Analysis ────────────────
     getLatestChange(moduleName) {

package/core/template-scaffold.d.ts

@@ -1,5 +1,31 @@
-import { BoilerplateConfig } from 'genomic';
+import { BoilerplateConfig as GenomicBoilerplateConfig } from 'genomic';
 import type { Inquirerer, Question } from 'inquirerer';
+/**
+ * Supported workspace types for template requirements.
+ * - 'pgpm': Requires pgpm workspace (pgpm.json/pgpm.config.js) and creates pgpm.plan/.control files
+ * - 'pnpm': Requires pnpm workspace (pnpm-workspace.yaml)
+ * - 'lerna': Requires lerna workspace (lerna.json)
+ * - 'npm': Requires npm workspace (package.json with workspaces field)
+ * - false: No workspace required, can be scaffolded anywhere
+ */
+export type WorkspaceType = 'pgpm' | 'pnpm' | 'lerna' | 'npm' | false;
+/**
+ * Extended BoilerplateConfig that adds workspace requirement field.
+ * This field controls both workspace detection and whether pgpm-specific files are created.
+ */
+export interface BoilerplateConfig extends GenomicBoilerplateConfig {
+    /**
+     * Specifies what type of workspace this template requires.
+     * - 'pgpm': Requires pgpm workspace AND creates pgpm.plan/.control files
+     * - 'pnpm': Requires pnpm workspace (pnpm-workspace.yaml), no pgpm files
+     * - 'lerna': Requires lerna workspace (lerna.json), no pgpm files
+     * - 'npm': Requires npm workspace (package.json with workspaces), no pgpm files
+     * - false: No workspace required, no pgpm files
+     *
+     * Defaults to 'pgpm' for 'module' type (backward compatibility), false for others.
+     */
+    requiresWorkspace?: WorkspaceType;
+}
 export interface InspectTemplateOptions {
     /**
      * The boilerplate path to inspect. When omitted, inspects the template

package/esm/core/boilerplate-scanner.js

@@ -60,10 +60,31 @@ export function scanBoilerplates(baseDir) {
         const boilerplatePath = path.join(baseDir, entry.name);
         const config = readBoilerplateConfig(boilerplatePath);
         if (config) {
+            // Validate and normalize the type field
+            const validTypes = ['workspace', 'module', 'generic'];
+            const configType = config.type;
+            const type = validTypes.includes(configType)
+                ? configType
+                : 'module';
+            // Validate and normalize requiresWorkspace field
+            const validWorkspaceTypes = ['pgpm', 'pnpm', 'lerna', 'npm'];
+            let requiresWorkspace;
+            if (config.requiresWorkspace === false) {
+                requiresWorkspace = false;
+            }
+            else if (typeof config.requiresWorkspace === 'string' &&
+                validWorkspaceTypes.includes(config.requiresWorkspace)) {
+                requiresWorkspace = config.requiresWorkspace;
+            }
+            else {
+                // Default: 'pgpm' for module type (backward compatibility), undefined for others
+                requiresWorkspace = type === 'module' ? 'pgpm' : undefined;
+            }
             boilerplates.push({
                 name: entry.name,
                 path: boilerplatePath,
-                type: config.type ?? 'module',
+                type,
+                requiresWorkspace,
                 questions: config.questions
             });
         }

package/esm/core/class/pgpm.js

@@ -325,6 +325,8 @@ export class PgpmPackage {
     }
     async initModule(options) {
         this.ensureWorkspace();
+        // Determine if this is a pgpm-managed module (defaults to true for backward compatibility)
+        const isPgpmModule = options.pgpm ?? true;
         // If outputDir is provided, use it directly instead of createModuleDirectory
         let targetPath;
         if (options.outputDir) {
@@ -358,8 +360,11 @@ export class PgpmPackage {
             toolName: options.toolName ?? DEFAULT_TEMPLATE_TOOL_NAME,
             cwd: this.cwd
         });
-        this.initModuleSqitch(options.name, targetPath);
-        writeExtensions(targetPath, options.extensions);
+        // Only create pgpm files (pgpm.plan, .control, deploy/revert/verify dirs) for pgpm-managed modules
+        if (isPgpmModule) {
+            this.initModuleSqitch(options.name, targetPath);
+            writeExtensions(targetPath, options.extensions);
+        }
     }
     // ──────────────── Dependency Analysis ────────────────
     getLatestChange(moduleName) {

package/esm/export/export-migrations.js

@@ -38,7 +38,8 @@ const DB_REQUIRED_EXTENSIONS = [
 const SERVICE_REQUIRED_EXTENSIONS = [
     'plpgsql',
     'metaschema-schema',
-    'metaschema-modules'
+    'metaschema-modules',
+    'services'
 ];
 /**
  * Checks which pgpm modules from the extensions list are missing from the workspace
@@ -201,7 +202,7 @@ GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA public to public;
 DO $LQLMIGRATION$
   DECLARE
   BEGIN
-  
+
     EXECUTE format('GRANT CONNECT ON DATABASE %I TO %I', current_database(), 'app_user');
     EXECUTE format('GRANT CONNECT ON DATABASE %I TO %I', current_database(), 'app_admin');
 

package/esm/modules/modules.js

@@ -10,6 +10,7 @@ export const PGPM_MODULE_MAP = {
     'pgpm-database-jobs': '@pgpm/database-jobs',
     'metaschema-modules': '@pgpm/metaschema-modules',
     'metaschema-schema': '@pgpm/metaschema-schema',
+    'services': '@pgpm/services',
     'pgpm-inflection': '@pgpm/inflection',
     'pgpm-jwt-claims': '@pgpm/jwt-claims',
     'pgpm-stamps': '@pgpm/stamps',

package/export/export-migrations.js

@@ -44,7 +44,8 @@ const DB_REQUIRED_EXTENSIONS = [
 const SERVICE_REQUIRED_EXTENSIONS = [
     'plpgsql',
     'metaschema-schema',
-    'metaschema-modules'
+    'metaschema-modules',
+    'services'
 ];
 /**
  * Checks which pgpm modules from the extensions list are missing from the workspace
@@ -207,7 +208,7 @@ GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA public to public;
 DO $LQLMIGRATION$
   DECLARE
   BEGIN
-  
+
     EXECUTE format('GRANT CONNECT ON DATABASE %I TO %I', current_database(), 'app_user');
     EXECUTE format('GRANT CONNECT ON DATABASE %I TO %I', current_database(), 'app_admin');
 

package/modules/modules.js

@@ -13,6 +13,7 @@ exports.PGPM_MODULE_MAP = {
     'pgpm-database-jobs': '@pgpm/database-jobs',
     'metaschema-modules': '@pgpm/metaschema-modules',
     'metaschema-schema': '@pgpm/metaschema-schema',
+    'services': '@pgpm/services',
     'pgpm-inflection': '@pgpm/inflection',
     'pgpm-jwt-claims': '@pgpm/jwt-claims',
     'pgpm-stamps': '@pgpm/stamps',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgpmjs/core",
-  "version": "4.9.0",
+  "version": "4.10.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "PGPM Package and Migration Tools",
   "main": "index.js",
@@ -48,11 +48,11 @@
     "makage": "^0.1.10"
   },
   "dependencies": {
-    "@pgpmjs/env": "^2.9.2",
+    "@pgpmjs/env": "^2.9.3",
     "@pgpmjs/logger": "^1.3.7",
     "@pgpmjs/server-utils": "^2.8.14",
     "@pgpmjs/types": "^2.14.0",
-    "csv-to-pg": "^3.3.2",
+    "csv-to-pg": "^3.3.3",
     "genomic": "^5.2.0",
     "glob": "^13.0.0",
     "komoji": "^0.7.14",
@@ -64,5 +64,5 @@
     "pgsql-parser": "^17.9.9",
     "yanse": "^0.1.11"
   },
-  "gitHead": "e6171117d5498f38f456dfaf7e8a497dd7d2a30b"
+  "gitHead": "ba5bbacf7ccc1980cba10bf3f45ebb0ca639fb79"
 }