@pgpmjs/core 7.0.0 → 7.2.0

package/esm/files/plan/validators.js

@@ -1,181 +0,0 @@
-/**
- * Validators for Sqitch change and tag names according to the spec:
- * https://sqitch.org/docs/manual/sqitchchanges/
- */
-/**
- * Check if a character is punctuation (excluding underscore)
- */
-function isPunctuation(char) {
-    // Common punctuation marks, excluding underscore
-    const punctuation = /[!"#$%&'()*+,\-./:;<=>?@[\\\]^`{|}~]/;
-    return punctuation.test(char);
-}
-/**
- * Validate a change name according to Sqitch rules:
- * - ≥1 character
- * - Cannot contain whitespace
- * - First and last characters must not be punctuation (except _)
- * - Must not end in ~, ^, /, = or % followed by digits
- * - Disallowed characters anywhere: :, @, #, \
- */
-export function isValidChangeName(name) {
-    if (!name || name.length === 0) {
-        return false;
-    }
-    // Check for whitespace
-    if (/\s/.test(name)) {
-        return false;
-    }
-    // Check for disallowed characters anywhere
-    if (/[:@#\\]/.test(name)) {
-        return false;
-    }
-    // Check first character - must not be punctuation except underscore
-    const firstChar = name[0];
-    if (firstChar !== '_' && isPunctuation(firstChar)) {
-        return false;
-    }
-    // Check last character - must not be punctuation except underscore
-    const lastChar = name[name.length - 1];
-    if (lastChar !== '_' && isPunctuation(lastChar)) {
-        return false;
-    }
-    // Check for endings like ~N, ^N, /N, =N, %N where N is digits
-    if (/[~^/=%]\d+$/.test(name)) {
-        return false;
-    }
-    return true;
-}
-/**
- * Validate a tag name according to Sqitch rules:
- * - Same as change name rules
- * - Additionally, must not contain /
- */
-export function isValidTagName(name) {
-    if (!isValidChangeName(name)) {
-        return false;
-    }
-    // Tags must not contain /
-    if (name.includes('/')) {
-        return false;
-    }
-    return true;
-}
-/**
- * Check if a string is a valid SHA1 hash (40 hex characters)
- */
-function isSHA1(str) {
-    return /^[0-9a-f]{40}$/i.test(str);
-}
-/**
- * Parse a reference string into its components
- */
-export function parseReference(ref) {
-    if (!ref) {
-        return null;
-    }
-    const result = {};
-    // Check for package qualifier
-    let workingRef = ref;
-    const colonIndex = ref.indexOf(':');
-    if (colonIndex > 0) {
-        const projectPart = ref.substring(0, colonIndex);
-        const remainingPart = ref.substring(colonIndex + 1);
-        // Check if this is actually a package qualifier or just a colon in the name
-        // Package names should be valid identifiers (alphanumeric, dash, underscore)
-        // Also check that the remaining part doesn't have more colons
-        if (/^[a-zA-Z0-9_-]+$/.test(projectPart) &&
-            remainingPart.length > 0 &&
-            remainingPart.indexOf(':') === -1) {
-            result.package = projectPart;
-            workingRef = remainingPart;
-        }
-        else {
-            // Not a valid package qualifier, treat the whole thing as a reference
-            workingRef = ref;
-        }
-    }
-    // Check for symbolic references
-    if (workingRef === 'HEAD' || workingRef === '@HEAD') {
-        result.symbolic = 'HEAD';
-        return result;
-    }
-    if (workingRef === 'ROOT' || workingRef === '@ROOT') {
-        result.symbolic = 'ROOT';
-        return result;
-    }
-    // Check for relative references (e.g., HEAD^, @beta~2, HEAD^^)
-    // Handle multiple ^ characters
-    const multiCaretMatch = workingRef.match(/^(.+?)(\^+)$/);
-    if (multiCaretMatch) {
-        const [, base, carets] = multiCaretMatch;
-        result.relative = {
-            base: base, // Keep the original base including @ prefix
-            direction: '^',
-            count: carets.length
-        };
-        return result;
-    }
-    // Handle ^N or ~N format
-    const relativeMatch = workingRef.match(/^(.+?)([~^])(\d+)$/);
-    if (relativeMatch) {
-        const [, base, direction, countStr] = relativeMatch;
-        const count = parseInt(countStr, 10);
-        result.relative = {
-            base: base, // Keep the original base including @ prefix
-            direction: direction,
-            count
-        };
-        return result;
-    }
-    // Handle single ^ or ~ without number
-    const singleRelativeMatch = workingRef.match(/^(.+?)([~^])$/);
-    if (singleRelativeMatch) {
-        const [, base, direction] = singleRelativeMatch;
-        result.relative = {
-            base: base, // Keep the original base including @ prefix
-            direction: direction,
-            count: 1
-        };
-        return result;
-    }
-    // Check if it's a SHA1
-    if (isSHA1(workingRef)) {
-        result.sha1 = workingRef;
-        return result;
-    }
-    // Check for tag reference (starts with @)
-    if (workingRef.startsWith('@')) {
-        const tagName = workingRef.substring(1);
-        if (isValidTagName(tagName)) {
-            result.tag = tagName;
-            return result;
-        }
-        return null; // Invalid tag name
-    }
-    // Check for change@tag format
-    const atIndex = workingRef.indexOf('@');
-    if (atIndex > 0) {
-        const changeName = workingRef.substring(0, atIndex);
-        const tagName = workingRef.substring(atIndex + 1);
-        if (isValidChangeName(changeName) && isValidTagName(tagName)) {
-            result.change = changeName;
-            result.tag = tagName;
-            return result;
-        }
-        return null; // Invalid change or tag name
-    }
-    // Must be a plain change name
-    if (isValidChangeName(workingRef)) {
-        result.change = workingRef;
-        return result;
-    }
-    return null; // Invalid reference
-}
-/**
- * Validate a dependency reference
- * Dependencies can be any valid reference format
- */
-export function isValidDependency(dep) {
-    return parseReference(dep) !== null;
-}

package/esm/files/plan/writer.js

@@ -1,142 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { parseAuthor } from '../../utils/author';
-/**
- * Sort dependencies by their order in the supplied plan, so prerequisites
- * (parent migrations) appear before their dependents in the bracket.
- * Internal dependencies are sorted by their plan index, and external
- * dependencies (not in the plan) preserve their original order.
- */
-const sortDependencies = (deps, order) => {
-    const originalOrder = new Map(deps.map((dep, index) => [dep, index]));
-    return [...deps].sort((a, b) => {
-        const aIndex = order.get(a);
-        const bIndex = order.get(b);
-        const aOriginal = originalOrder.get(a);
-        const bOriginal = originalOrder.get(b);
-        if (aIndex !== undefined && bIndex !== undefined)
-            return aIndex - bIndex || aOriginal - bOriginal;
-        if (aIndex !== undefined)
-            return -1;
-        if (bIndex !== undefined)
-            return 1;
-        return aOriginal - bOriginal;
-    });
-};
-/**
- * Write a PGPM plan file based on the provided rows
- */
-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
-    const { fullName, email } = parseAuthor(opts.author || 'constructive');
-    const authorName = fullName;
-    const authorEmail = email || `${fullName}@5b0c196eeb62`;
-    const duplicates = {};
-    // Build an order map from the row list so brackets can be sorted by plan order
-    const rowOrder = new Map(rows.map((row, index) => [row.deploy, index]));
-    const plan = opts.replacer(`%syntax-version=1.0.0
-%project=constructive-extension-name
-%uri=constructive-extension-name
-
-${rows
-        .map((row) => {
-        if (duplicates[row.deploy]) {
-            console.log('DUPLICATE ' + row.deploy);
-            return '';
-        }
-        duplicates[row.deploy] = true;
-        if (row.deps?.length) {
-            return `${row.deploy} [${sortDependencies(row.deps, rowOrder).join(' ')}] ${date()} ${authorName} <${authorEmail}> # add ${row.name}`;
-        }
-        return `${row.deploy} ${date()} ${authorName} <${authorEmail}> # add ${row.name}`;
-    })
-        .join('\n')}
-`);
-    fs.writeFileSync(path.join(dir, 'pgpm.plan'), plan);
-}
-/**
- * Write a plan file with the provided content
- */
-export function writePlanFile(planPath, plan) {
-    const content = generatePlanFileContent(plan);
-    fs.writeFileSync(planPath, content);
-}
-/**
- * Generate content for a plan file
- */
-export function generatePlanFileContent(plan) {
-    const { package: packageName, uri, changes, tags } = plan;
-    let content = `%syntax-version=1.0.0\n`;
-    content += `%project=${packageName}\n`;
-    if (uri) {
-        content += `%uri=${uri}\n`;
-    }
-    content += `\n`;
-    // Build an order map from the change list so brackets can be sorted by plan order
-    const changeOrder = new Map(changes.map((change, index) => [change.name, index]));
-    // Add changes and their associated tags
-    for (const change of changes) {
-        content += generateChangeLineContent(change, changeOrder);
-        content += `\n`;
-        const associatedTags = tags.filter(tag => tag.change === change.name);
-        for (const tag of associatedTags) {
-            content += generateTagLineContent(tag);
-            content += `\n`;
-        }
-    }
-    return content;
-}
-/**
- * Generate a line for a change in a plan file
- */
-export function generateChangeLineContent(change, changeOrder) {
-    const { name, dependencies, timestamp, planner, email, comment } = change;
-    let line = name;
-    // Add dependencies if present, sorted by plan order
-    if (dependencies && dependencies.length > 0) {
-        line += ` [${sortDependencies(dependencies, changeOrder || new Map()).join(' ')}]`;
-    }
-    // Add timestamp if present
-    if (timestamp) {
-        line += ` ${timestamp}`;
-        // Add planner if present
-        if (planner) {
-            line += ` ${planner}`;
-            // Add email if present
-            if (email) {
-                line += ` <${email}>`;
-            }
-        }
-    }
-    // Add comment if present
-    if (comment) {
-        line += ` # ${comment}`;
-    }
-    return line;
-}
-/**
- * Generate a line for a tag in a plan file
- */
-export function generateTagLineContent(tag) {
-    const { name, timestamp, planner, email, comment } = tag;
-    let line = `@${name}`;
-    // Add timestamp if present
-    if (timestamp) {
-        line += ` ${timestamp}`;
-        // Add planner if present
-        if (planner) {
-            line += ` ${planner}`;
-            // Add email if present
-            if (email) {
-                line += ` <${email}>`;
-            }
-        }
-    }
-    // Add comment if present
-    if (comment) {
-        line += ` # ${comment}`;
-    }
-    return line;
-}

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';