@pgpmjs/core 3.0.0

package/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2025 Constructive <developers@constructive.io>
+Copyright (c) 2020-present, Interweb, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,99 @@
+# @launchql/core
+
+<p align="center" width="100%">
+  <img height="250" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml">
+    <img height="20" src="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml/badge.svg" />
+  </a>
+   <a href="https://github.com/constructive-io/constructive/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
+   <a href="https://www.npmjs.com/package/@launchql/core"><img height="20" src="https://img.shields.io/github/package-json/v/constructive-io/constructive?filename=packages%2Fcore%2Fpackage.json"/></a>
+</p>
+
+## Overview
+
+LaunchQL Core is the main package for LaunchQL, providing tools for database migrations, package management, and package scaffolding. It includes functionality for:
+
+- Managing PostgreSQL extensions and modules
+- Deploying, reverting, and verifying migrations
+- Parsing and generating migration plans
+- Reading and writing SQL scripts
+- Resolving dependencies between migrations
+
+---
+
+## Education and Tutorials
+
+ 1. 🚀 [Quickstart: Getting Up and Running](https://constructive.io/learn/quickstart)
+Get started with modular databases in minutes. Install prerequisites and deploy your first module.
+
+ 2. 📦 [Modular PostgreSQL Development with Database Packages](https://constructive.io/learn/modular-postgres)
+Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.
+
+ 3. ✏️ [Authoring Database Changes](https://constructive.io/learn/authoring-database-changes)
+Master the workflow for adding, organizing, and managing database changes with pgpm.
+
+ 4. 🧪 [End-to-End PostgreSQL Testing with TypeScript](https://constructive.io/learn/e2e-postgres-testing)
+Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.
+
+ 5. ⚡ [Supabase Testing](https://constructive.io/learn/supabase)
+Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.
+
+ 6. 💧 [Drizzle ORM Testing](https://constructive.io/learn/drizzle-testing)
+Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.
+
+ 7. 🔧 [Troubleshooting](https://constructive.io/learn/troubleshooting)
+Common issues and solutions for pgpm, PostgreSQL, and testing.
+
+## Related Constructive Tooling
+
+### 🧪 Testing
+
+* [pgsql-test](https://github.com/constructive-io/constructive/tree/main/packages/pgsql-test): **📊 Isolated testing environments** with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
+* [supabase-test](https://github.com/constructive-io/constructive/tree/main/packages/supabase-test): **🧪 Supabase-native test harness** preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
+* [graphile-test](https://github.com/constructive-io/constructive/tree/main/packages/graphile-test): **🔐 Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
+* [pg-query-context](https://github.com/constructive-io/constructive/tree/main/packages/pg-query-context): **🔒 Session context injection** to add session-local context (e.g., `SET LOCAL`) into queries—ideal for setting `role`, `jwt.claims`, and other session settings.
+
+### 🧠 Parsing & AST
+
+* [pgsql-parser](https://www.npmjs.com/package/pgsql-parser): **🔄 SQL conversion engine** that interprets and converts PostgreSQL syntax.
+* [libpg-query-node](https://www.npmjs.com/package/libpg-query): **🌉 Node.js bindings** for `libpg_query`, converting SQL into parse trees.
+* [pg-proto-parser](https://www.npmjs.com/package/pg-proto-parser): **📦 Protobuf parser** for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
+* [@pgsql/enums](https://www.npmjs.com/package/@pgsql/enums): **🏷️ TypeScript enums** for PostgreSQL AST for safe and ergonomic parsing logic.
+* [@pgsql/types](https://www.npmjs.com/package/@pgsql/types): **📝 Type definitions** for PostgreSQL AST nodes in TypeScript.
+* [@pgsql/utils](https://www.npmjs.com/package/@pgsql/utils): **🛠️ AST utilities** for constructing and transforming PostgreSQL syntax trees.
+* [pg-ast](https://www.npmjs.com/package/pg-ast): **🔍 Low-level AST tools** and transformations for Postgres query structures.
+
+### 🚀 API & Dev Tools
+
+* [launchql/server](https://github.com/constructive-io/constructive/tree/main/packages/server): **⚡ Express-based API server** powered by PostGraphile to expose a secure, scalable GraphQL API over your Postgres database.
+* [launchql/explorer](https://github.com/constructive-io/constructive/tree/main/packages/explorer): **🔎 Visual API explorer** with GraphiQL for browsing across all databases and schemas—useful for debugging, documentation, and API prototyping.
+
+### 🔁 Streaming & Uploads
+
+* [launchql/s3-streamer](https://github.com/constructive-io/constructive/tree/main/packages/s3-streamer): **📤 Direct S3 streaming** for large files with support for metadata injection and content validation.
+* [launchql/etag-hash](https://github.com/constructive-io/constructive/tree/main/packages/etag-hash): **🏷️ S3-compatible ETags** created by streaming and hashing file uploads in chunks.
+* [launchql/etag-stream](https://github.com/constructive-io/constructive/tree/main/packages/etag-stream): **🔄 ETag computation** via Node stream transformer during upload or transfer.
+* [launchql/uuid-hash](https://github.com/constructive-io/constructive/tree/main/packages/uuid-hash): **🆔 Deterministic UUIDs** generated from hashed content, great for deduplication and asset referencing.
+* [launchql/uuid-stream](https://github.com/constructive-io/constructive/tree/main/packages/uuid-stream): **🌊 Streaming UUID generation** based on piped file content—ideal for upload pipelines.
+* [launchql/upload-names](https://github.com/constructive-io/constructive/tree/main/packages/upload-names): **📂 Collision-resistant filenames** utility for structured and unique file names for uploads.
+
+### 🧰 CLI & Codegen
+
+* [pgpm](https://github.com/constructive-io/constructive/tree/main/packages/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
+* [@launchql/cli](https://github.com/constructive-io/constructive/tree/main/packages/cli): **🖥️ Command-line toolkit** for managing LaunchQL projects—supports database scaffolding, migrations, seeding, code generation, and automation.
+* [constructive-io/constructive-gen](https://github.com/constructive-io/constructive/tree/main/packages/launchql-gen): **✨ Auto-generated GraphQL** mutations and queries dynamically built from introspected schema data.
+* [@launchql/query-builder](https://github.com/constructive-io/constructive/tree/main/packages/query-builder): **🏗️ SQL constructor** providing a robust TypeScript-based query builder for dynamic generation of `SELECT`, `INSERT`, `UPDATE`, `DELETE`, and stored procedure calls—supports advanced SQL features like `JOIN`, `GROUP BY`, and schema-qualified queries.
+* [@launchql/query](https://github.com/constructive-io/constructive/tree/main/packages/query): **🧩 Fluent GraphQL builder** for PostGraphile schemas. ⚡ Schema-aware via introspection, 🧩 composable and ergonomic for building deeply nested queries.
+
+## Credits
+
+**🛠 Built by the [Constructive](https://constructive.io) team — creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on [GitHub](https://github.com/constructive-io).**
+
+## Disclaimer
+
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+
+No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

package/core/boilerplate-scanner.d.ts

@@ -0,0 +1,41 @@
+import { BoilerplateConfig, BoilerplatesRootConfig, ScannedBoilerplate } from './boilerplate-types';
+/**
+ * Read the root `.boilerplates.json` configuration from a template repository.
+ * This file specifies the default directory containing boilerplate templates.
+ *
+ * @param templateDir - The root directory of the template repository
+ * @returns The root config or null if not found
+ */
+export declare function readBoilerplatesConfig(templateDir: string): BoilerplatesRootConfig | null;
+/**
+ * Read the `.boilerplate.json` configuration from a boilerplate directory.
+ * This file specifies the boilerplate type and questions.
+ *
+ * @param boilerplatePath - The path to the boilerplate directory
+ * @returns The boilerplate config or null if not found
+ */
+export declare function readBoilerplateConfig(boilerplatePath: string): BoilerplateConfig | null;
+/**
+ * Scan a base directory for boilerplate templates.
+ * Each subdirectory with a `.boilerplate.json` file is considered a boilerplate.
+ *
+ * @param baseDir - The directory to scan (e.g., "default/")
+ * @returns Array of scanned boilerplates with their configurations
+ */
+export declare function scanBoilerplates(baseDir: string): ScannedBoilerplate[];
+/**
+ * Find a boilerplate by type within a scanned list.
+ *
+ * @param boilerplates - Array of scanned boilerplates
+ * @param type - The type to find ('workspace' or 'module')
+ * @returns The matching boilerplate or undefined
+ */
+export declare function findBoilerplateByType(boilerplates: ScannedBoilerplate[], type: 'workspace' | 'module'): ScannedBoilerplate | undefined;
+/**
+ * Resolve the base directory for boilerplates in a template repository.
+ * Uses `.boilerplates.json` if present, otherwise returns empty string.
+ *
+ * @param templateDir - The root directory of the template repository
+ * @returns The resolved base directory path
+ */
+export declare function resolveBoilerplateBaseDir(templateDir: string): string;

package/core/boilerplate-scanner.js

@@ -0,0 +1,106 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readBoilerplatesConfig = readBoilerplatesConfig;
+exports.readBoilerplateConfig = readBoilerplateConfig;
+exports.scanBoilerplates = scanBoilerplates;
+exports.findBoilerplateByType = findBoilerplateByType;
+exports.resolveBoilerplateBaseDir = resolveBoilerplateBaseDir;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+/**
+ * Read the root `.boilerplates.json` configuration from a template repository.
+ * This file specifies the default directory containing boilerplate templates.
+ *
+ * @param templateDir - The root directory of the template repository
+ * @returns The root config or null if not found
+ */
+function readBoilerplatesConfig(templateDir) {
+    const configPath = path_1.default.join(templateDir, '.boilerplates.json');
+    if (fs_1.default.existsSync(configPath)) {
+        try {
+            const content = fs_1.default.readFileSync(configPath, 'utf-8');
+            return JSON.parse(content);
+        }
+        catch {
+            return null;
+        }
+    }
+    return null;
+}
+/**
+ * Read the `.boilerplate.json` configuration from a boilerplate directory.
+ * This file specifies the boilerplate type and questions.
+ *
+ * @param boilerplatePath - The path to the boilerplate directory
+ * @returns The boilerplate config or null if not found
+ */
+function readBoilerplateConfig(boilerplatePath) {
+    const jsonPath = path_1.default.join(boilerplatePath, '.boilerplate.json');
+    if (fs_1.default.existsSync(jsonPath)) {
+        try {
+            const content = fs_1.default.readFileSync(jsonPath, 'utf-8');
+            return JSON.parse(content);
+        }
+        catch {
+            return null;
+        }
+    }
+    return null;
+}
+/**
+ * Scan a base directory for boilerplate templates.
+ * Each subdirectory with a `.boilerplate.json` file is considered a boilerplate.
+ *
+ * @param baseDir - The directory to scan (e.g., "default/")
+ * @returns Array of scanned boilerplates with their configurations
+ */
+function scanBoilerplates(baseDir) {
+    const boilerplates = [];
+    if (!fs_1.default.existsSync(baseDir)) {
+        return boilerplates;
+    }
+    const entries = fs_1.default.readdirSync(baseDir, { withFileTypes: true });
+    for (const entry of entries) {
+        if (!entry.isDirectory()) {
+            continue;
+        }
+        const boilerplatePath = path_1.default.join(baseDir, entry.name);
+        const config = readBoilerplateConfig(boilerplatePath);
+        if (config) {
+            boilerplates.push({
+                name: entry.name,
+                path: boilerplatePath,
+                type: config.type ?? 'module',
+                questions: config.questions
+            });
+        }
+    }
+    return boilerplates;
+}
+/**
+ * Find a boilerplate by type within a scanned list.
+ *
+ * @param boilerplates - Array of scanned boilerplates
+ * @param type - The type to find ('workspace' or 'module')
+ * @returns The matching boilerplate or undefined
+ */
+function findBoilerplateByType(boilerplates, type) {
+    return boilerplates.find((bp) => bp.type === type);
+}
+/**
+ * Resolve the base directory for boilerplates in a template repository.
+ * Uses `.boilerplates.json` if present, otherwise returns empty string.
+ *
+ * @param templateDir - The root directory of the template repository
+ * @returns The resolved base directory path
+ */
+function resolveBoilerplateBaseDir(templateDir) {
+    const rootConfig = readBoilerplatesConfig(templateDir);
+    if (rootConfig?.dir) {
+        return path_1.default.join(templateDir, rootConfig.dir);
+    }
+    return templateDir;
+}

package/core/boilerplate-types.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Boilerplate metadata types for the new metadata-driven resolution system.
+ * These types support the `.boilerplate.json` and `.boilerplates.json` configuration files.
+ */
+/**
+ * A question to prompt the user during template scaffolding.
+ */
+export interface BoilerplateQuestion {
+    /** The placeholder name in templates (e.g., "____fullName____") */
+    name: string;
+    /** The prompt message shown to the user */
+    message: string;
+    /** Whether the question is required */
+    required?: boolean;
+    /** The type of input: text, list (single select), or checkbox (multi select) */
+    type?: 'text' | 'list' | 'checkbox';
+    /** Options for list or checkbox types */
+    options?: string[];
+    /** Source to derive default value from (e.g., "git.user.name", "npm.whoami") */
+    defaultFrom?: 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.
+ */
+export interface BoilerplatesRootConfig {
+    /** The default directory containing boilerplate templates (e.g., "default") */
+    dir: string;
+}
+/**
+ * A scanned boilerplate with its resolved path and configuration.
+ */
+export interface ScannedBoilerplate {
+    /** The boilerplate folder name (e.g., "module", "workspace") */
+    name: string;
+    /** The full path to the boilerplate directory */
+    path: string;
+    /** The type of boilerplate */
+    type: 'workspace' | 'module';
+    /** Questions from the boilerplate config */
+    questions?: BoilerplateQuestion[];
+}

package/core/boilerplate-types.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Boilerplate metadata types for the new metadata-driven resolution system.
+ * These types support the `.boilerplate.json` and `.boilerplates.json` configuration files.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/core/class/pgpm.d.ts

@@ -0,0 +1,150 @@
+import { PgpmOptions, PgpmWorkspaceConfig } from '@pgpmjs/types';
+import { PgConfig } from 'pg-env';
+import { ExtensionInfo } from '../../files';
+import { ModuleMap } from '../../modules/modules';
+import { PackageAnalysisResult, RenameOptions } from '../../files/types';
+export declare enum PackageContext {
+    Outside = "outside",
+    Workspace = "workspace-root",
+    Module = "module",
+    ModuleInsideWorkspace = "module-in-workspace"
+}
+export interface InitModuleOptions {
+    name: string;
+    description: string;
+    author: string;
+    extensions: string[];
+    branch?: string;
+    templateRepo?: string;
+    templatePath?: string;
+    cacheTtlMs?: number;
+    noTty?: boolean;
+    toolName?: string;
+    answers?: Record<string, any>;
+}
+export declare class PgpmPackage {
+    cwd: string;
+    workspacePath?: string;
+    modulePath?: string;
+    config?: PgpmWorkspaceConfig;
+    allowedDirs: string[];
+    allowedParentDirs: string[];
+    private _moduleMap?;
+    private _moduleInfo?;
+    constructor(cwd?: string);
+    resetCwd(cwd: string): void;
+    private resolveSqitchPath;
+    private loadConfigSync;
+    private loadAllowedDirs;
+    private loadAllowedParentDirs;
+    isInsideAllowedDirs(cwd: string): boolean;
+    isParentOfAllowedDirs(cwd: string): boolean;
+    private createModuleDirectory;
+    ensureModule(): void;
+    ensureWorkspace(): void;
+    getContext(): PackageContext;
+    isInWorkspace(): boolean;
+    isInModule(): boolean;
+    getWorkspacePath(): string | undefined;
+    getModulePath(): string | undefined;
+    clearCache(): void;
+    getModules(): Promise<PgpmPackage[]>;
+    /**
+     * List all modules by parsing .control files in the workspace directory.
+     * Handles naming collisions by preferring the shortest path.
+     */
+    listModules(): ModuleMap;
+    getModuleMap(): ModuleMap;
+    getAvailableModules(): string[];
+    getModuleProject(name: string): PgpmPackage;
+    getModuleInfo(): ExtensionInfo;
+    getModuleName(): string;
+    getRequiredModules(): string[];
+    setModuleDependencies(modules: string[]): void;
+    private validateModuleDependencies;
+    private initModuleSqitch;
+    initModule(options: InitModuleOptions): Promise<void>;
+    getLatestChange(moduleName: string): string;
+    getLatestChangeAndVersion(moduleName: string): {
+        change: string;
+        version: string;
+    };
+    getModuleExtensions(): {
+        resolved: string[];
+        external: string[];
+    };
+    getModuleDependencies(moduleName: string): {
+        native: string[];
+        modules: string[];
+    };
+    getModuleDependencyChanges(moduleName: string): {
+        native: string[];
+        modules: {
+            name: string;
+            latest: string;
+            version: string;
+        }[];
+    };
+    getModulePlan(): string;
+    getModuleControlFile(): string;
+    getModuleMakefile(): string;
+    getModuleSQL(): string;
+    generateModulePlan(options: {
+        uri?: string;
+        includePackages?: boolean;
+        includeTags?: boolean;
+    }): string;
+    writeModulePlan(options: {
+        uri?: string;
+        includePackages?: boolean;
+        includeTags?: boolean;
+    }): void;
+    /**
+     * Add a tag to the current module's plan file
+     */
+    addTag(tagName: string, changeName?: string, comment?: string): void;
+    /**
+     * Add a change to the current module's plan file and create SQL files
+     */
+    addChange(changeName: string, dependencies?: string[], comment?: string): void;
+    /**
+     * Add change to the current module (internal helper)
+     */
+    private addChangeToModule;
+    /**
+     * Create deploy/revert/verify SQL files for a change
+     */
+    private createSqlFiles;
+    publishToDist(distFolder?: string): void;
+    /**
+      * Installs an extension npm package into the local skitch extensions directory,
+      * and automatically adds it to the current module’s package.json dependencies.
+      */
+    installModules(...pkgstrs: string[]): Promise<void>;
+    /**
+     * Get the set of modules that have been deployed to the database
+     */
+    private getDeployedModules;
+    resolveWorkspaceExtensionDependencies(opts?: {
+        filterDeployed?: boolean;
+        pgConfig?: PgConfig;
+    }): Promise<{
+        resolved: string[];
+        external: string[];
+    }>;
+    private parsePackageTarget;
+    deploy(opts: PgpmOptions, target?: string, recursive?: boolean): Promise<void>;
+    /**
+     * Reverts database changes for modules. Unlike verify operations, revert operations
+     * modify database state and must ensure dependent modules are reverted before their
+     * dependencies to prevent database constraint violations.
+     */
+    revert(opts: PgpmOptions, target?: string, recursive?: boolean): Promise<void>;
+    verify(opts: PgpmOptions, target?: string, recursive?: boolean): Promise<void>;
+    removeFromPlan(toChange: string): Promise<void>;
+    analyzeModule(): PackageAnalysisResult;
+    renameModule(newName: string, opts?: RenameOptions): {
+        changed: string[];
+        warnings: string[];
+    };
+}