@pgpmjs/core 7.1.0 → 7.2.0

package/esm/files/sql/header.js

@@ -1,259 +0,0 @@
-import { readFileSync } from 'fs';
-import { join } from 'path';
-import { parsePlanFile } from '../plan/parser';
-import { parseReference } from '../plan/validators';
-const HEADER_LINE = /^--\s*(Deploy|Revert|Verify)\b(:)?\s*(.*?)\s*$/;
-const REQUIRES_LINE = /^--\s*requires:\s*(.*?)\s*$/;
-const COMMENT_LINE = /^\s*--/;
-const TO_PG_SUFFIX = /\s+to\s+pg\s*$/;
-/**
- * Parse the header block of a pgpm SQL script into a structured model.
- *
- * Recognizes both header formats:
- *   `-- Deploy <project>:<change> to pg` (legacy sqitch-compatible)
- *   `-- Deploy <change>` / `-- Deploy: <change>` (new)
- * along with `-- requires: <ref>` lines where `<ref>` may be a plain change
- * name, `{package}:{change}`, `@tag`, or `{package}:@tag`.
- *
- * The parse is lossless: `header.lines` plus `body` reassemble the original
- * content byte-exactly (see {@link writePgpmScript}).
- */
-export function parsePgpmHeader(content) {
-    const header = {
-        verb: null,
-        project: null,
-        change: null,
-        toPg: false,
-        requires: [],
-        lines: []
-    };
-    const lines = content.split('\n');
-    let lastHeaderIdx = -1;
-    for (let i = 0; i < lines.length; i++) {
-        const line = lines[i];
-        if (line.trim() === '') {
-            continue;
-        }
-        if (!COMMENT_LINE.test(line)) {
-            break;
-        }
-        const headerMatch = line.match(HEADER_LINE);
-        if (headerMatch && header.verb === null) {
-            header.verb = headerMatch[1];
-            let target = headerMatch[3];
-            if (TO_PG_SUFFIX.test(target)) {
-                header.toPg = true;
-                target = target.replace(TO_PG_SUFFIX, '');
-            }
-            const colonIndex = target.indexOf(':');
-            if (colonIndex > 0 && /^[a-zA-Z0-9_-]+$/.test(target.substring(0, colonIndex))) {
-                header.project = target.substring(0, colonIndex);
-                header.change = target.substring(colonIndex + 1).trim();
-            }
-            else {
-                header.change = target.trim() || null;
-            }
-            lastHeaderIdx = i;
-            continue;
-        }
-        const requiresMatch = line.match(REQUIRES_LINE);
-        if (requiresMatch) {
-            const raw = requiresMatch[1];
-            header.requires.push({ raw, ref: parseReference(raw) });
-            lastHeaderIdx = i;
-            continue;
-        }
-        // Other comment lines (e.g. attribution) before/between header lines are
-        // tolerated but only absorbed into the header when a later header line
-        // follows; trailing comments belong to the body.
-    }
-    header.lines = lines.slice(0, lastHeaderIdx + 1);
-    return {
-        header,
-        body: lines.slice(lastHeaderIdx + 1).join('\n')
-    };
-}
-/**
- * Serialize a header back to its raw lines. When the structured fields have
- * been modified via {@link renameInHeader}, the raw lines already reflect the
- * change; this simply joins header and body losslessly.
- */
-export function writePgpmScript(script) {
-    if (script.header.lines.length === 0)
-        return script.body;
-    return script.header.lines.join('\n') + '\n' + script.body;
-}
-/**
- * Rewrite change names in a script header according to a rename map
- * (old change name -> new change name). Rewrites both the `-- Deploy` line's
- * change identity and any `-- requires:` lines referencing renamed changes,
- * preserving format (project qualifier, ` to pg` suffix, tag refs untouched).
- *
- * Returns the number of substitutions applied; mutates `script` in place.
- */
-export function renameInHeader(script, renames) {
-    const { header } = script;
-    let count = 0;
-    const renameRef = (raw) => {
-        const ref = parseReference(raw);
-        if (!ref) {
-            const to = renames.get(raw);
-            return to ?? null;
-        }
-        if (ref.tag || ref.symbolic || ref.relative)
-            return null;
-        const change = ref.change;
-        if (!change)
-            return null;
-        const to = renames.get(change);
-        if (!to)
-            return null;
-        return ref.package ? `${ref.package}:${to}` : to;
-    };
-    header.lines = header.lines.map(line => {
-        const headerMatch = line.match(HEADER_LINE);
-        if (headerMatch && header.change && renames.has(header.change)) {
-            const to = renames.get(header.change);
-            const oldTarget = header.project ? `${header.project}:${header.change}` : header.change;
-            const newTarget = header.project ? `${header.project}:${to}` : to;
-            const rewritten = line.replace(oldTarget, newTarget);
-            if (rewritten !== line) {
-                header.change = to;
-                count++;
-                return rewritten;
-            }
-            return line;
-        }
-        const requiresMatch = line.match(REQUIRES_LINE);
-        if (requiresMatch) {
-            const raw = requiresMatch[1];
-            const renamed = renameRef(raw);
-            if (renamed !== null) {
-                count++;
-                return line.replace(raw, renamed);
-            }
-        }
-        return line;
-    });
-    header.requires = header.requires.map(req => {
-        const renamed = renameRef(req.raw);
-        if (renamed === null)
-            return req;
-        return { raw: renamed, ref: parseReference(renamed) };
-    });
-    return count;
-}
-/**
- * Scan a deploy script the way dependency resolution historically has:
- * line-by-line over the whole file, collecting `-- requires: <ref>` lines
- * verbatim and validating any `-- Deploy <project>:<change>[ to pg]` line
- * against the script's path identity and project name.
- *
- * Kept strictly line-regex-compatible with the original resolver behavior
- * (requires lines are honored anywhere in the file, and the legacy
- * `-- Deploy: <change>` colon form is not identity-validated).
- *
- * @throws when the Deploy line's project or change identity mismatches.
- */
-export function scanDeployScript(content, options) {
-    const { key, extname, makeKey } = options;
-    const requires = [];
-    for (const line of content.split('\n')) {
-        const requiresMatch = line.match(/^-- requires: (.*)/);
-        if (requiresMatch) {
-            requires.push(requiresMatch[1].trim());
-            continue;
-        }
-        if (/:/.test(line)) {
-            const m2 = line.match(/^-- Deploy ([^:]*):([\w\/]+)(?:\s+to\s+pg)?/);
-            if (m2) {
-                const actualProject = m2[1];
-                const keyToTest = m2[2];
-                if (extname !== actualProject) {
-                    throw new Error(`Mismatched project name in deploy file:
-          Expected project: ${extname}
-          Found in line   : ${actualProject}
-          Line            : ${line}`);
-                }
-                const expectedKey = makeKey(keyToTest);
-                if (key !== expectedKey) {
-                    throw new Error(`Deployment script path or internal name mismatch:
-          Expected key    : ${key}
-          Found in line   : ${expectedKey}
-          Line            : ${line}`);
-                }
-            }
-        }
-        else {
-            const m2 = line.match(/^-- Deploy (.*?)(?:\s+to\s+pg)?\s*$/);
-            if (m2) {
-                const keyToTest = m2[1].trim();
-                if (key !== makeKey(keyToTest)) {
-                    throw new Error('deployment script in wrong place or is named wrong internally\n' + line);
-                }
-            }
-        }
-    }
-    return { requires };
-}
-/**
- * Verify that every change in a module's pgpm.plan has a deploy script whose
- * header identity matches its path, and report dependency drift between the
- * plan's dep lists and the scripts' `-- requires:` lines.
- *
- * Read-only diagnostic; returns issues rather than throwing.
- */
-export function verifyPlanMatchesHeaders(moduleDir) {
-    const issues = [];
-    const planPath = join(moduleDir, 'pgpm.plan');
-    const parsed = parsePlanFile(planPath);
-    if (!parsed.data) {
-        throw new Error(`Failed to parse plan file: ${planPath}`);
-    }
-    for (const planChange of parsed.data.changes) {
-        const change = planChange.name;
-        const file = join(moduleDir, 'deploy', `${change}.sql`);
-        let content;
-        try {
-            content = readFileSync(file, 'utf-8');
-        }
-        catch {
-            issues.push({
-                change,
-                file,
-                kind: 'missing-file',
-                message: `deploy script not found for plan change "${change}"`
-            });
-            continue;
-        }
-        const { header } = parsePgpmHeader(content);
-        if (header.change && header.change !== change) {
-            issues.push({
-                change,
-                file,
-                kind: 'identity-mismatch',
-                message: `header declares "${header.change}" but path identity is "${change}"`
-            });
-        }
-        const planDeps = new Set(planChange.dependencies || []);
-        const headerDeps = new Set(header.requires.map(r => r.raw));
-        const missingInHeader = [...planDeps].filter(d => !headerDeps.has(d));
-        const missingInPlan = [...headerDeps].filter(d => !planDeps.has(d));
-        if (missingInHeader.length > 0 || missingInPlan.length > 0) {
-            const parts = [];
-            if (missingInHeader.length > 0) {
-                parts.push(`in plan but not in header requires: ${missingInHeader.join(', ')}`);
-            }
-            if (missingInPlan.length > 0) {
-                parts.push(`in header requires but not in plan: ${missingInPlan.join(', ')}`);
-            }
-            issues.push({
-                change,
-                file,
-                kind: 'requires-drift',
-                message: parts.join('; ')
-            });
-        }
-    }
-    return issues;
-}

package/esm/files/sql/index.js

@@ -1,2 +0,0 @@
-export * from './header';
-export * from './writer';

package/esm/files/sql/writer.js

@@ -1,107 +0,0 @@
-import { getEnvOptions } from '@pgpmjs/env';
-import fs from 'fs';
-import path from 'path';
-/**
- * Write SQL files for PGPM migrations (deploy, revert, verify)
- */
-export const writePgpmFiles = (rows, opts) => {
-    rows.forEach((row) => writeVerify(row, opts));
-    rows.forEach((row) => writeRevert(row, opts));
-    rows.forEach((row) => writeDeploy(row, opts));
-};
-/**
- * Sort dependencies in a consistent order
- */
-const ordered = (arr) => {
-    if (!arr)
-        return [];
-    return arr.sort((a, b) => a.length - b.length || a.localeCompare(b));
-};
-/**
- * Write a deploy SQL file for a PGPM change
- */
-const writeDeploy = (row, opts) => {
-    const globalOpts = getEnvOptions({
-        migrations: {
-            codegen: {
-                useTx: opts.useTx
-            }
-        }
-    });
-    const useTx = globalOpts.migrations.codegen.useTx;
-    const deploy = opts.replacer(row.deploy);
-    const dir = path.dirname(deploy);
-    const prefix = path.join(opts.outdir, opts.name, 'deploy');
-    const actualDir = path.resolve(prefix, dir);
-    const actualFile = path.resolve(prefix, `${deploy}.sql`);
-    fs.mkdirSync(actualDir, { recursive: true });
-    const sqlContent = opts.replacer(row.content);
-    const content = `-- Deploy: ${deploy}
--- made with <3 @ constructive.io
-
-${opts.replacer(ordered(row?.deps)
-        .map((dep) => `-- requires: ${dep}`)
-        .join('\n') || '')}
-
-${useTx ? 'BEGIN;' : ''}
-${sqlContent}
-${useTx ? 'COMMIT;' : ''}
-`;
-    fs.writeFileSync(actualFile, content);
-};
-/**
- * Write a verify SQL file for a PGPM change
- */
-const writeVerify = (row, opts) => {
-    const globalOpts = getEnvOptions({
-        migrations: {
-            codegen: {
-                useTx: opts.useTx
-            }
-        }
-    });
-    const useTx = globalOpts.migrations.codegen.useTx;
-    const deploy = opts.replacer(row.deploy);
-    const dir = path.dirname(deploy);
-    const prefix = path.join(opts.outdir, opts.name, 'verify');
-    const actualDir = path.resolve(prefix, dir);
-    const actualFile = path.resolve(prefix, `${deploy}.sql`);
-    fs.mkdirSync(actualDir, { recursive: true });
-    const sqlContent = opts.replacer(row.verify);
-    const content = opts.replacer(`-- Verify: ${deploy}
-
-${useTx ? 'BEGIN;' : ''}
-${sqlContent}
-${useTx ? 'COMMIT;' : ''}
-
-`);
-    fs.writeFileSync(actualFile, content);
-};
-/**
- * Write a revert SQL file for a PGPM change
- */
-const writeRevert = (row, opts) => {
-    const globalOpts = getEnvOptions({
-        migrations: {
-            codegen: {
-                useTx: opts.useTx
-            }
-        }
-    });
-    const useTx = globalOpts.migrations.codegen.useTx;
-    const deploy = opts.replacer(row.deploy);
-    const dir = path.dirname(deploy);
-    const prefix = path.join(opts.outdir, opts.name, 'revert');
-    const actualDir = path.resolve(prefix, dir);
-    const actualFile = path.resolve(prefix, `${deploy}.sql`);
-    fs.mkdirSync(actualDir, { recursive: true });
-    const sqlContent = opts.replacer(row.revert);
-    const content = `-- Revert: ${deploy}
-
-${useTx ? 'BEGIN;' : ''}
-${sqlContent}
-${useTx ? 'COMMIT;' : ''}
-
-`;
-    fs.writeFileSync(actualFile, content);
-};

package/esm/files/sql-scripts/index.js

@@ -1,2 +0,0 @@
-// Re-export all sql-scripts functionality
-export * from './reader';

package/esm/files/sql-scripts/reader.js

@@ -1,19 +0,0 @@
-import { existsSync, readFileSync } from 'fs';
-import { join } from 'path';
-/**
- * Read a SQL script file, return empty string if not found
- */
-export function readScript(basePath, scriptType, changeName) {
-    const scriptPath = join(basePath, scriptType, `${changeName}.sql`);
-    if (!existsSync(scriptPath)) {
-        return '';
-    }
-    return readFileSync(scriptPath, 'utf-8');
-}
-/**
- * Check if a script file exists
- */
-export function scriptExists(basePath, scriptType, changeName) {
-    const scriptPath = join(basePath, scriptType, `${changeName}.sql`);
-    return existsSync(scriptPath);
-}

package/esm/files/types/index.js

@@ -1 +0,0 @@
-export * from './package';

package/esm/files/types/package.js

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

package/esm/utils/author.js

@@ -1,11 +0,0 @@
-export function parseAuthor(author) {
-    const trimmed = (author || '').trim();
-    const match = trimmed.match(/^(.+?)\s*<([^>]+)>$/);
-    if (match) {
-        return {
-            fullName: match[1].trim(),
-            email: match[2].trim()
-        };
-    }
-    return { fullName: trimmed };
-}

package/files/extension/index.d.ts

@@ -1,2 +0,0 @@
-export * from './reader';
-export * from './writer';

package/files/extension/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-// Re-export all extension functionality
-__exportStar(require("./reader"), exports);
-__exportStar(require("./writer"), exports);

package/files/extension/reader.d.ts

@@ -1,24 +0,0 @@
-import { ExtensionInfo } from './writer';
-export interface Module {
-    path: string;
-    requires: string[];
-    version: string;
-}
-/**
- * Parse a .control file and extract its metadata.
- * https://www.postgresql.org/docs/current/extend-extensions.html
- */
-export declare function parseControlFile(filePath: string, basePath: string): Module;
-/**
- * Parse the pgpm.plan file to get the extension name.
- */
-export declare const getExtensionName: (packageDir: string) => string;
-/**
- * Get detailed information about an extension in the specified directory.
- */
-export declare const getExtensionInfo: (packageDir: string) => ExtensionInfo;
-/**
- * Get a list of extensions required by an extension from its control file.
- * Returns an empty array if the file doesn't exist or has no requires line.
- */
-export declare const getInstalledExtensions: (controlFilePath: string) => string[];

package/files/extension/reader.js

@@ -1,86 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInstalledExtensions = exports.getExtensionInfo = exports.getExtensionName = void 0;
-exports.parseControlFile = parseControlFile;
-const fs_1 = require("fs");
-const path_1 = require("path");
-const plan_1 = require("../plan");
-/**
- * Parse a .control file and extract its metadata.
- * https://www.postgresql.org/docs/current/extend-extensions.html
- */
-function parseControlFile(filePath, basePath) {
-    const contents = (0, fs_1.readFileSync)(filePath, 'utf-8');
-    const key = (0, path_1.basename)(filePath).split('.control')[0];
-    const requires = contents
-        .split('\n')
-        .find((line) => /^requires/.test(line))
-        ?.split('=')[1]
-        .split(',')
-        .map((req) => req.replace(/[\'\s]*/g, '').trim()) || [];
-    const version = contents
-        .split('\n')
-        .find((line) => /^default_version/.test(line))
-        ?.split('=')[1]
-        .replace(/[\']*/g, '')
-        .trim() || '';
-    return {
-        path: (0, path_1.dirname)((0, path_1.relative)(basePath, filePath)),
-        requires,
-        version,
-    };
-}
-/**
- * Parse the pgpm.plan file to get the extension name.
- */
-const getExtensionName = (packageDir) => {
-    const planPath = `${packageDir}/pgpm.plan`;
-    const plan = (0, plan_1.parsePlanFileSimple)(planPath);
-    if (!plan.package) {
-        throw new Error('No package name found in pgpm.plan!');
-    }
-    return plan.package;
-};
-exports.getExtensionName = getExtensionName;
-/**
- * Get detailed information about an extension in the specified directory.
- */
-const getExtensionInfo = (packageDir) => {
-    const pkgPath = `${packageDir}/package.json`;
-    const pkg = require(pkgPath);
-    const extname = (0, exports.getExtensionName)(packageDir);
-    const version = pkg.version;
-    const Makefile = `${packageDir}/Makefile`;
-    const controlFile = `${packageDir}/${extname}.control`;
-    const sqlFile = `sql/${extname}--${version}.sql`;
-    return { extname, packageDir, version, Makefile, controlFile, sqlFile };
-};
-exports.getExtensionInfo = getExtensionInfo;
-/**
- * Get a list of extensions required by an extension from its control file.
- * Returns an empty array if the file doesn't exist or has no requires line.
- */
-const getInstalledExtensions = (controlFilePath) => {
-    try {
-        const contents = (0, fs_1.readFileSync)(controlFilePath, 'utf-8');
-        const match = contents.match(/^\s*requires\s*=\s*'([^']*)'/m);
-        if (!match) {
-            return [];
-        }
-        const requiresValue = match[1];
-        if (!requiresValue || requiresValue.trim() === '') {
-            return [];
-        }
-        return requiresValue
-            .split(',')
-            .map((ext) => ext.trim())
-            .filter((ext) => ext.length > 0);
-    }
-    catch (e) {
-        if (e.code === 'ENOENT') {
-            return [];
-        }
-        throw new Error(`Error reading control file at ${controlFilePath}: ${e.message}`);
-    }
-};
-exports.getInstalledExtensions = getInstalledExtensions;

package/files/extension/writer.d.ts

@@ -1,48 +0,0 @@
-/**
- * Write the Makefile for the extension.
- */
-export declare const writeExtensionMakefile: (outputPath: string, extname: string, version: string) => void;
-/**
- * Generate content for a .control file
- * https://www.postgresql.org/docs/current/extend-extensions.html
- */
-export declare function generateControlFileContent(options: {
-    name: string;
-    version: string;
-    comment?: string;
-    requires?: string[];
-    default_version?: string;
-    relocatable?: boolean;
-    superuser?: boolean;
-    schema?: string;
-    module_pathname?: string;
-}): string;
-/**
- * Update (or insert/remove) the `requires =` line of an existing .control file
- * in place, preserving every other field and the file's formatting. Used when
- * changing a module's dependencies after init (e.g. via `pgpm extension`) so
- * hand-tuned fields (comment, schema, relocatable, module_pathname) survive.
- */
-export declare function upsertRequiresLine(content: string, requires: string[]): string;
-/**
- * Write the control file for the extension.
- * If the file already exists, only its `requires` line is updated so that any
- * custom fields are preserved; otherwise a fresh file is generated.
- */
-export declare const writeExtensionControlFile: (outputPath: string, extname: string, extensions: string[], version: string) => void;
-/**
- * Interface for extension information
- */
-export interface ExtensionInfo {
-    extname: string;
-    packageDir: string;
-    version: string;
-    Makefile: string;
-    controlFile: string;
-    sqlFile: string;
-}
-/**
- * Write control and Makefile for the extension with given data.
- * If extInfo is not provided, it will be generated from packageDir.
- */
-export declare const writeExtensions: (packageDir: string, extensions: string[], extInfo?: ExtensionInfo) => void;