@pgpmjs/bundle 0.12.2 → 0.13.0

package/esm/transpile.js

@@ -1,8 +1,26 @@
 import { parsePgpmHeader, renameInHeader, writePgpmScript } from '@pgpmjs/ast/files/sql/header';
 import { hashString } from '@pgpmjs/ast';
-import { renameInPlanContent } from '@pgpmjs/ast';
+import { generatePlanFileContent, parsePlanContent, renameInPlanContent } from '@pgpmjs/ast';
 import { mapScripts } from '@pgpmjs/traverse';
 import { computeBundleDigest, computeChangeDigest } from './create';
+/**
+ * Drop excluded changes from a plan's text and prune references to them from
+ * the surviving changes' dependency brackets, re-serializing the plan. Tags on
+ * excluded changes are dropped with them.
+ */
+function removeChangesFromPlan(plan, excluded) {
+    const parsed = parsePlanContent(plan);
+    if (!parsed.data)
+        return plan;
+    const changes = parsed.data.changes
+        .filter(change => !excluded.has(change.name))
+        .map(change => ({
+        ...change,
+        dependencies: change.dependencies.filter(dep => !excluded.has(dep))
+    }));
+    const tags = (parsed.data.tags ?? []).filter(tag => !excluded.has(tag.change));
+    return generatePlanFileContent({ ...parsed.data, changes, tags });
+}
 function renameProjectInPlan(plan, from, to) {
     return plan
         .split('\n')
@@ -67,10 +85,15 @@ function transpileScriptSql(script, changeName, renames, options) {
  */
 export function transpileBundle(bundle, options = {}) {
     const renameChange = options.renameChange ?? ((name) => name);
+    const excludeChange = options.excludeChange ?? (() => false);
     const renames = buildRenames(bundle.manifest.deployOrder, renameChange);
-    const changes = bundle.changes.map(change => {
+    const changes = bundle.changes
+        .filter(change => !excludeChange(change.name))
+        .map(change => {
         const name = renames.get(change.name) ?? change.name;
-        const dependencies = change.dependencies.map(dep => renames.get(dep) ?? dep);
+        const dependencies = change.dependencies
+            .filter(dep => !excludeChange(dep))
+            .map(dep => renames.get(dep) ?? dep);
         const { deploy, revert, verify } = mapScripts(change, script => transpileScriptSql(script, change.name, renames, options));
         const digest = computeChangeDigest(name, {
             deploy: deploy?.digest,
@@ -80,6 +103,13 @@ export function transpileBundle(bundle, options = {}) {
         return { name, dependencies, deploy, revert, verify, digest };
     });
     let plan = renames.size > 0 ? renameInPlanContent(bundle.plan, renames) : bundle.plan;
+    // Excluded changes are matched by source name; they are never renamed (the
+    // caller leaves excluded changes' identity intact), so prune the plan by the
+    // source names, after any survivor renames have been applied above.
+    const excluded = new Set(bundle.manifest.deployOrder.filter(excludeChange));
+    if (excluded.size > 0) {
+        plan = removeChangesFromPlan(plan, excluded);
+    }
     const moduleName = options.renameModule ?? bundle.manifest.name;
     if (options.renameModule && options.renameModule !== bundle.manifest.name) {
         plan = renameProjectInPlan(plan, bundle.manifest.name, options.renameModule);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgpmjs/bundle",
-  "version": "0.12.2",
+  "version": "0.13.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "PGPM migration bundle — the portable, content-addressed artifact layer (create/io/verify/transpile/diff/reconcile)",
   "main": "index.js",
@@ -40,8 +40,8 @@
     "makage": "^0.3.0"
   },
   "dependencies": {
-    "@pgpmjs/ast": "^0.9.4",
-    "@pgpmjs/traverse": "^0.9.4"
+    "@pgpmjs/ast": "^0.10.0",
+    "@pgpmjs/traverse": "^0.10.0"
   },
-  "gitHead": "2832d5632d11eb22e1437df773706ac6a99175fe"
+  "gitHead": "622be766e8b1d5762b6f0536699d59f745a34c0c"
 }

package/transpile.d.ts

@@ -40,6 +40,20 @@ export interface TranspileBundleOptions extends CreateBundleOptions {
      * dependency references land on the instance instead of the source.
      */
     renameModule?: string;
+    /**
+     * Select changes to drop from the transpiled bundle entirely (return `true`
+     * to exclude). Excluded changes are removed from the change list, deploy
+     * order, and plan, and their name is pruned from every surviving change's
+     * dependencies (plan brackets included).
+     *
+     * This is the mechanism behind subsystem exclusion in apply: an excluded
+     * subsystem is genuinely absent from the artifact rather than emitted as an
+     * empty script. Empty tombstones are indistinguishable by content, so they
+     * collide on the deploy ledger's `(package, script_hash)` uniqueness — a
+     * dropped change has no script to hash. Cascade safety (no survivor still
+     * references a dropped object) is the caller's responsibility.
+     */
+    excludeChange?: (name: string) => boolean;
 }
 /**
  * Transpile a {@link MigrationBundle} into a new namespace, producing a fresh

package/transpile.js

@@ -6,6 +6,24 @@ const ast_1 = require("@pgpmjs/ast");
 const ast_2 = require("@pgpmjs/ast");
 const traverse_1 = require("@pgpmjs/traverse");
 const create_1 = require("./create");
+/**
+ * Drop excluded changes from a plan's text and prune references to them from
+ * the surviving changes' dependency brackets, re-serializing the plan. Tags on
+ * excluded changes are dropped with them.
+ */
+function removeChangesFromPlan(plan, excluded) {
+    const parsed = (0, ast_2.parsePlanContent)(plan);
+    if (!parsed.data)
+        return plan;
+    const changes = parsed.data.changes
+        .filter(change => !excluded.has(change.name))
+        .map(change => ({
+        ...change,
+        dependencies: change.dependencies.filter(dep => !excluded.has(dep))
+    }));
+    const tags = (parsed.data.tags ?? []).filter(tag => !excluded.has(tag.change));
+    return (0, ast_2.generatePlanFileContent)({ ...parsed.data, changes, tags });
+}
 function renameProjectInPlan(plan, from, to) {
     return plan
         .split('\n')
@@ -70,10 +88,15 @@ function transpileScriptSql(script, changeName, renames, options) {
  */
 function transpileBundle(bundle, options = {}) {
     const renameChange = options.renameChange ?? ((name) => name);
+    const excludeChange = options.excludeChange ?? (() => false);
     const renames = buildRenames(bundle.manifest.deployOrder, renameChange);
-    const changes = bundle.changes.map(change => {
+    const changes = bundle.changes
+        .filter(change => !excludeChange(change.name))
+        .map(change => {
         const name = renames.get(change.name) ?? change.name;
-        const dependencies = change.dependencies.map(dep => renames.get(dep) ?? dep);
+        const dependencies = change.dependencies
+            .filter(dep => !excludeChange(dep))
+            .map(dep => renames.get(dep) ?? dep);
         const { deploy, revert, verify } = (0, traverse_1.mapScripts)(change, script => transpileScriptSql(script, change.name, renames, options));
         const digest = (0, create_1.computeChangeDigest)(name, {
             deploy: deploy?.digest,
@@ -83,6 +106,13 @@ function transpileBundle(bundle, options = {}) {
         return { name, dependencies, deploy, revert, verify, digest };
     });
     let plan = renames.size > 0 ? (0, ast_2.renameInPlanContent)(bundle.plan, renames) : bundle.plan;
+    // Excluded changes are matched by source name; they are never renamed (the
+    // caller leaves excluded changes' identity intact), so prune the plan by the
+    // source names, after any survivor renames have been applied above.
+    const excluded = new Set(bundle.manifest.deployOrder.filter(excludeChange));
+    if (excluded.size > 0) {
+        plan = removeChangesFromPlan(plan, excluded);
+    }
     const moduleName = options.renameModule ?? bundle.manifest.name;
     if (options.renameModule && options.renameModule !== bundle.manifest.name) {
         plan = renameProjectInPlan(plan, bundle.manifest.name, options.renameModule);