@pgpmjs/transform 0.10.0 → 0.11.1

package/bundle-driver.d.ts

@@ -7,7 +7,7 @@
  * purpose — no dependency on `@pgpmjs/bundle`/`@pgpmjs/core` — so the driver
  * stays a pure function factory over `transformSql` and `classifyStatements`.
  */
-import { SchemaRouter, SchemaTransformResult, TransformSqlOptions } from '@pgsql/transform';
+import { ExtensionDefinition, ExtensionRouteSpec, ExtensionRouter, ExtensionTransformResult, RoleRouteSpec, RoleTransformResult, SchemaRouter, SchemaTransformResult, TransformSqlOptions } from '@pgsql/transform';
 /** Identity of the script being transformed/validated (matches the bundle seams). */
 export interface BundleScriptContext {
     change: string;
@@ -29,6 +29,42 @@ export interface SchemaObjectRoute {
     /** Target schema this object is routed to (e.g. `reporting`). */
     toSchema: string;
 }
+/**
+ * Extension routing for a transpile: where to install extensions and where the
+ * symbols they provide (functions/types/operators) should resolve. Distinct
+ * from schema routing — the objects are owned by an extension, not declared in
+ * the SQL — so it is driven by a version-aware symbol inventory. See the
+ * upstream `ExtensionRouter` for the full model. `toSchema: null` (or a `routes`
+ * entry with `to: null`) strips qualification — the "rely on search_path"
+ * direction — so the same mechanism moves symbols into a dedicated schema and
+ * back out again.
+ */
+export interface ExtensionRoutingInput {
+    /**
+     * Move the matched extensions and their provided symbols to this single
+     * schema (`null` strips qualification). Ignored when `routes` is given.
+     */
+    toSchema?: string | null;
+    /** With `toSchema`: limit to these extensions (default: every inventoried one). */
+    only?: string[];
+    /**
+     * With `toSchema`: which source qualifications to rewrite (a `null` entry
+     * also rewrites bare references). Defaults to `public` + bare.
+     */
+    from?: (string | null)[];
+    /** Advanced: explicit per-extension route spec. Overrides `toSchema`/`only`/`from`. */
+    routes?: ExtensionRouteSpec;
+    /** Target PostgreSQL major version, for core-graduation awareness (e.g. `gen_random_uuid`). */
+    serverVersion?: number;
+    /** Augmented or replacement symbol inventory (defaults to the curated common set). */
+    inventory?: ExtensionDefinition[];
+}
+/**
+ * Build an {@link ExtensionRouter} from the declarative {@link ExtensionRoutingInput}:
+ * an explicit `routes` spec when given, otherwise the "move everything matched
+ * to one schema" shortcut via `ExtensionRouter.toSchema`.
+ */
+export declare function buildExtensionRouter(input: ExtensionRoutingInput): ExtensionRouter;
 export interface SchemaTranspilerOptions {
     /**
      * Whole-schema default: source schema → target schema. Optional when
@@ -40,6 +76,17 @@ export interface SchemaTranspilerOptions {
      * its specific object, letting a single source schema fan out per object.
      */
     routes?: SchemaObjectRoute[];
+    /**
+     * Route extension installs and provided-symbol references (a dimension
+     * orthogonal to schema routing). See {@link ExtensionRoutingInput}.
+     */
+    extensions?: ExtensionRoutingInput;
+    /**
+     * Rename role identifiers (source role name → target role name), for
+     * translating between databases that name equivalent roles differently.
+     * Renames identifiers only — never role attributes.
+     */
+    roles?: RoleRouteSpec | Map<string, string>;
     /** Forwarded to {@link transformSql} (round-trip validation, extra passes). */
     transform?: TransformSqlOptions;
 }
@@ -71,6 +118,16 @@ export interface SchemaTranspiler {
      * schemas found/transformed and any per-script errors.
      */
     result: SchemaTransformResult;
+    /**
+     * Accumulated extension-routing report (installs moved, symbols rewritten).
+     * Present only when `extensions` was configured.
+     */
+    extensionResult?: ExtensionTransformResult;
+    /**
+     * Accumulated role-routing report (role → rewrite count). Present only when
+     * `roles` was configured.
+     */
+    roleResult?: RoleTransformResult;
 }
 /**
  * Build the caller-supplied callbacks for `transpileBundle` from a schema map

package/bundle-driver.js

@@ -9,11 +9,31 @@
  * stays a pure function factory over `transformSql` and `classifyStatements`.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildExtensionRouter = buildExtensionRouter;
 exports.buildSchemaRouter = buildSchemaRouter;
 exports.makeSchemaTranspiler = makeSchemaTranspiler;
 exports.makeNamespaceValidator = makeNamespaceValidator;
 const transform_1 = require("@pgsql/transform");
 const transform_2 = require("@pgsql/transform");
+/**
+ * Build an {@link ExtensionRouter} from the declarative {@link ExtensionRoutingInput}:
+ * an explicit `routes` spec when given, otherwise the "move everything matched
+ * to one schema" shortcut via `ExtensionRouter.toSchema`.
+ */
+function buildExtensionRouter(input) {
+    const opts = {};
+    if (input.serverVersion !== undefined)
+        opts.serverVersion = input.serverVersion;
+    if (input.inventory)
+        opts.inventory = input.inventory;
+    if (input.routes)
+        return new transform_2.ExtensionRouter(input.routes, opts);
+    return transform_2.ExtensionRouter.toSchema(input.toSchema ?? null, {
+        ...opts,
+        extensions: input.only,
+        from: input.from
+    });
+}
 /** pgpm change-path folder segment → transform routing namespace. */
 const PATH_KIND_NS = {
     tables: 'relation',
@@ -92,11 +112,36 @@ function makeSchemaTranspiler(options) {
         schemasTransformed: new Map(),
         errors: []
     };
+    // Extension/role routing are additional, orthogonal AST dimensions applied
+    // after schema routing on each script. Each is a self-contained parse →
+    // rewrite → deparse pass, so they compose by threading the SQL through.
+    const extRouter = options.extensions ? buildExtensionRouter(options.extensions) : undefined;
+    const roleRouter = options.roles ? transform_2.RoleRouter.from(options.roles) : undefined;
+    const extensionResult = extRouter ? (0, transform_2.createExtensionResult)() : undefined;
+    const roleResult = roleRouter ? (0, transform_2.createRoleResult)() : undefined;
     const renameChange = (name) => renameChangePath(name, router);
     const transformScript = (sql, _ctx) => {
-        return (0, transform_2.transformSql)(sql, router, options.transform, result).content;
+        let out = (0, transform_2.transformSql)(sql, router, options.transform, result).content;
+        if (extRouter) {
+            const r = (0, transform_2.transformExtensions)(out, extRouter);
+            out = r.sql;
+            for (const [name, schema] of r.result.installsMoved) {
+                extensionResult.installsMoved.set(name, schema);
+            }
+            for (const [name, count] of r.result.symbolsRewritten) {
+                extensionResult.symbolsRewritten.set(name, (extensionResult.symbolsRewritten.get(name) ?? 0) + count);
+            }
+        }
+        if (roleRouter) {
+            const r = (0, transform_2.transformRoles)(out, roleRouter);
+            out = r.sql;
+            for (const [name, count] of r.result.rolesRenamed) {
+                roleResult.rolesRenamed.set(name, (roleResult.rolesRenamed.get(name) ?? 0) + count);
+            }
+        }
+        return out;
     };
-    return { renameChange, transformScript, result };
+    return { renameChange, transformScript, result, extensionResult, roleResult };
 }
 /**
  * Build an `applyBundle`-compatible `validateReferences` callback: returns a

package/esm/bundle-driver.js

@@ -8,7 +8,26 @@
  * stays a pure function factory over `transformSql` and `classifyStatements`.
  */
 import { classifyStatements } from '@pgsql/transform';
-import { SchemaRouter, transformSql } from '@pgsql/transform';
+import { createExtensionResult, createRoleResult, ExtensionRouter, RoleRouter, SchemaRouter, transformExtensions, transformRoles, transformSql } from '@pgsql/transform';
+/**
+ * Build an {@link ExtensionRouter} from the declarative {@link ExtensionRoutingInput}:
+ * an explicit `routes` spec when given, otherwise the "move everything matched
+ * to one schema" shortcut via `ExtensionRouter.toSchema`.
+ */
+export function buildExtensionRouter(input) {
+    const opts = {};
+    if (input.serverVersion !== undefined)
+        opts.serverVersion = input.serverVersion;
+    if (input.inventory)
+        opts.inventory = input.inventory;
+    if (input.routes)
+        return new ExtensionRouter(input.routes, opts);
+    return ExtensionRouter.toSchema(input.toSchema ?? null, {
+        ...opts,
+        extensions: input.only,
+        from: input.from
+    });
+}
 /** pgpm change-path folder segment → transform routing namespace. */
 const PATH_KIND_NS = {
     tables: 'relation',
@@ -87,11 +106,36 @@ export function makeSchemaTranspiler(options) {
         schemasTransformed: new Map(),
         errors: []
     };
+    // Extension/role routing are additional, orthogonal AST dimensions applied
+    // after schema routing on each script. Each is a self-contained parse →
+    // rewrite → deparse pass, so they compose by threading the SQL through.
+    const extRouter = options.extensions ? buildExtensionRouter(options.extensions) : undefined;
+    const roleRouter = options.roles ? RoleRouter.from(options.roles) : undefined;
+    const extensionResult = extRouter ? createExtensionResult() : undefined;
+    const roleResult = roleRouter ? createRoleResult() : undefined;
     const renameChange = (name) => renameChangePath(name, router);
     const transformScript = (sql, _ctx) => {
-        return transformSql(sql, router, options.transform, result).content;
+        let out = transformSql(sql, router, options.transform, result).content;
+        if (extRouter) {
+            const r = transformExtensions(out, extRouter);
+            out = r.sql;
+            for (const [name, schema] of r.result.installsMoved) {
+                extensionResult.installsMoved.set(name, schema);
+            }
+            for (const [name, count] of r.result.symbolsRewritten) {
+                extensionResult.symbolsRewritten.set(name, (extensionResult.symbolsRewritten.get(name) ?? 0) + count);
+            }
+        }
+        if (roleRouter) {
+            const r = transformRoles(out, roleRouter);
+            out = r.sql;
+            for (const [name, count] of r.result.rolesRenamed) {
+                roleResult.rolesRenamed.set(name, (roleResult.rolesRenamed.get(name) ?? 0) + count);
+            }
+        }
+        return out;
     };
-    return { renameChange, transformScript, result };
+    return { renameChange, transformScript, result, extensionResult, roleResult };
 }
 /**
  * Build an `applyBundle`-compatible `validateReferences` callback: returns a

package/esm/index.js

@@ -1,5 +1,5 @@
 export * from '@pgsql/transform';
 export { loadModule } from 'plpgsql-parser';
-export { buildSchemaRouter, makeNamespaceValidator, makeSchemaTranspiler, } from './bundle-driver';
+export { buildExtensionRouter, buildSchemaRouter, makeNamespaceValidator, makeSchemaTranspiler, } from './bundle-driver';
 export { buildCategoryOf, categorizeChange, TIER_PROFILE, } from './categorize';
 export { resolveFixtureClosure } from './fixture-closure';

package/index.d.ts

@@ -1,7 +1,7 @@
 export * from '@pgsql/transform';
 export { loadModule } from 'plpgsql-parser';
-export type { BundleScriptContext, NamespaceValidatorOptions, SchemaObjectRoute, SchemaTranspiler, SchemaTranspilerOptions, } from './bundle-driver';
-export { buildSchemaRouter, makeNamespaceValidator, makeSchemaTranspiler, } from './bundle-driver';
+export type { BundleScriptContext, ExtensionRoutingInput, NamespaceValidatorOptions, SchemaObjectRoute, SchemaTranspiler, SchemaTranspilerOptions, } from './bundle-driver';
+export { buildExtensionRouter, buildSchemaRouter, makeNamespaceValidator, makeSchemaTranspiler, } from './bundle-driver';
 export type { CategoryProfile, ChangeCategory, } from './categorize';
 export { buildCategoryOf, categorizeChange, TIER_PROFILE, } from './categorize';
 export type { ClosureChange, ClosureInputChange, ClosureReason, FixtureClosure, ResolveFixtureClosureOptions, } from './fixture-closure';

package/index.js

@@ -14,11 +14,12 @@ 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 });
-exports.resolveFixtureClosure = exports.TIER_PROFILE = exports.categorizeChange = exports.buildCategoryOf = exports.makeSchemaTranspiler = exports.makeNamespaceValidator = exports.buildSchemaRouter = exports.loadModule = void 0;
+exports.resolveFixtureClosure = exports.TIER_PROFILE = exports.categorizeChange = exports.buildCategoryOf = exports.makeSchemaTranspiler = exports.makeNamespaceValidator = exports.buildSchemaRouter = exports.buildExtensionRouter = exports.loadModule = void 0;
 __exportStar(require("@pgsql/transform"), exports);
 var plpgsql_parser_1 = require("plpgsql-parser");
 Object.defineProperty(exports, "loadModule", { enumerable: true, get: function () { return plpgsql_parser_1.loadModule; } });
 var bundle_driver_1 = require("./bundle-driver");
+Object.defineProperty(exports, "buildExtensionRouter", { enumerable: true, get: function () { return bundle_driver_1.buildExtensionRouter; } });
 Object.defineProperty(exports, "buildSchemaRouter", { enumerable: true, get: function () { return bundle_driver_1.buildSchemaRouter; } });
 Object.defineProperty(exports, "makeNamespaceValidator", { enumerable: true, get: function () { return bundle_driver_1.makeNamespaceValidator; } });
 Object.defineProperty(exports, "makeSchemaTranspiler", { enumerable: true, get: function () { return bundle_driver_1.makeSchemaTranspiler; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgpmjs/transform",
-  "version": "0.10.0",
+  "version": "0.11.1",
   "author": "Constructive <developers@constructive.io>",
   "description": "Change-aware SQL transformation for PGPM — superset of @pgsql/transform plus change categorization, fixture closure, and bundle transpile/apply drivers",
   "main": "index.js",
@@ -39,12 +39,12 @@
     "plpgsql"
   ],
   "devDependencies": {
-    "@pgpmjs/bundle": "^0.11.0",
+    "@pgpmjs/bundle": "^0.12.1",
     "makage": "^0.3.0"
   },
   "dependencies": {
-    "@pgsql/transform": "^18.5.0",
+    "@pgsql/transform": "^18.6.0",
     "plpgsql-parser": "^18.2.1"
   },
-  "gitHead": "d85911699e8a50a9fdfeb7506195442525c1f238"
+  "gitHead": "0286d994d98717cb9b28842233d2db6d1e37c48e"
 }