@pgsql/transform 18.15.3 → 18.16.0

package/esm/index.js

@@ -10,4 +10,4 @@ export { createRoleResult, createRoleVisitor, transformRoles, } from './role-tra
 export { captureAstsFromSql, captureTransformAsts, firstDifference, normalizeParseTree, validateRoundTrip, } from './round-trip';
 export { CLEAN_TREE_VOLATILE_KEYS, cleanTree, normalizeTree, trimDefElemBody, } from './round-trip-core';
 export { SchemaRouter } from './router';
-export { createPlpgsqlVisitor, createSqlVisitor, escapeRegexp, extractPgpmHeader, shouldTransformSchema, transformComments, transformJsonStringValues, transformNameList, transformPlpgsqlTypeAst, transformPlpgsqlTypeString, transformRelation, transformSchemaName, transformSql, transformSqlStatement, transformVerifyCalls, validateNoUntransformedSchemas, walkPlpgsqlForSchemas, } from './transform';
+export { createPlpgsqlVisitor, createSqlVisitor, escapeRegexp, extractPgpmHeader, identityCastNamespace, shouldTransformSchema, transformComments, transformIdentityCastLiteral, transformJsonStringValues, transformNameList, transformPlpgsqlTypeAst, transformPlpgsqlTypeString, transformRelation, transformSchemaName, transformSql, transformSqlStatement, transformVerifyCalls, validateNoUntransformedSchemas, walkPlpgsqlForSchemas, } from './transform';

package/esm/transform.js

@@ -209,6 +209,98 @@ export function transformSchemaRefsInString(str, schemaMapping, result) {
     }
     return out;
 }
+/**
+ * Cast types whose string operand is an object reference rather than opaque
+ * text. `'sch.tbl'::regclass` is a relation the parser resolves, and the cast
+ * names the namespace it resolves in — so the reference can be routed from the
+ * cast, semantically, instead of pattern-matched. This reaches what the string
+ * passes cannot: a bare `'sch'::regnamespace` has no dot to match on.
+ */
+const IDENTITY_CAST_NAMESPACES = {
+    regclass: 'relation',
+    regcollation: 'unknown',
+    regconfig: 'unknown',
+    regdictionary: 'unknown',
+    regnamespace: 'schema',
+    regoper: 'unknown',
+    regoperator: 'unknown',
+    regproc: 'function',
+    regprocedure: 'function',
+    regtype: 'type'
+};
+/**
+ * The namespace a cast resolves its operand in, or `undefined` when the target
+ * type is not an object-identity type.
+ */
+export function identityCastNamespace(typeName) {
+    const names = typeName?.names;
+    if (!Array.isArray(names) || names.length === 0)
+        return undefined;
+    // Only `pg_catalog`-qualified (or unqualified) reg* types are the built-ins.
+    if (names.length > 1 && names[0]?.String?.sval !== 'pg_catalog')
+        return undefined;
+    const typeIdent = names[names.length - 1]?.String?.sval;
+    if (typeof typeIdent !== 'string')
+        return undefined;
+    return IDENTITY_CAST_NAMESPACES[typeIdent.toLowerCase()];
+}
+const IDENTITY_TOKEN = String.raw `(?:"(?:[^"]|"")*"|[^\s".,()[\]]+)`;
+const BARE_IDENTITY_RE = new RegExp(`^\\s*(${IDENTITY_TOKEN})\\s*$`);
+const QUALIFIED_IDENTITY_RE = new RegExp(`^\\s*(${IDENTITY_TOKEN})\\.([\\s\\S]+)$`);
+function unquoteIdentifier(token) {
+    if (token.length > 1 && token.startsWith('"') && token.endsWith('"')) {
+        return token.slice(1, -1).replace(/""/g, '"');
+    }
+    return token;
+}
+/**
+ * Route the object reference carried in the string operand of an identity
+ * cast. `ns` comes from the cast's target type.
+ *
+ * Unqualified operands (`'tbl'::regclass`) name no schema — they resolve
+ * through `search_path` — so they are returned unchanged.
+ */
+export function transformIdentityCastLiteral(sval, ns, schemaMapping, result) {
+    const router = asRouter(schemaMapping);
+    if (ns === 'schema') {
+        const bare = BARE_IDENTITY_RE.exec(sval);
+        if (!bare)
+            return sval;
+        const schemaName = unquoteIdentifier(bare[1]);
+        const newName = router.resolve(schemaName, undefined, 'schema');
+        if (!newName || newName === schemaName)
+            return sval;
+        result.schemasFound.add(schemaName);
+        result.schemasTransformed.set(schemaName, newName);
+        return QuoteUtils.quoteIdentifier(newName);
+    }
+    // `regprocedure` and `regoperator` carry an argument list after the name, and
+    // an argument type can itself be schema-qualified
+    // (`fn("my-schema".row_type)`), so the list is routed as ordinary schema refs.
+    const argsAt = sval.indexOf('(');
+    const head = argsAt === -1 ? sval : sval.slice(0, argsAt);
+    const args = argsAt === -1 ? '' : transformSchemaRefsInString(sval.slice(argsAt), router, result);
+    const qualified = QUALIFIED_IDENTITY_RE.exec(head);
+    if (!qualified)
+        return `${head}${args}`;
+    const schemaName = unquoteIdentifier(qualified[1]);
+    const objName = unquoteIdentifier(qualified[2].trim());
+    const target = router.resolveObject(schemaName, objName, ns);
+    if (!target)
+        return `${head}${args}`;
+    const rebound = target.name !== undefined && target.name !== objName;
+    const requalified = target.schema === null || (!!target.schema && target.schema !== schemaName);
+    if (!rebound && !requalified)
+        return `${head}${args}`;
+    result.schemasFound.add(schemaName);
+    const nameToken = QuoteUtils.quoteIdentifier(rebound ? target.name : objName);
+    if (target.schema === null)
+        return `${nameToken}${args}`;
+    if (target.schema && target.schema !== schemaName) {
+        result.schemasTransformed.set(schemaName, target.schema);
+    }
+    return `${QuoteUtils.quoteIdentifier(target.schema ?? schemaName)}.${nameToken}${args}`;
+}
 /**
  * Create a SQL AST visitor that transforms schema names.
  *
@@ -461,9 +553,28 @@ export function createSqlVisitor(schemaMapping, result, visitorOptions) {
         A_Const: (path) => {
             const node = path.node;
             if (typeof node.sval?.sval === 'string' && node.sval.sval.includes('.')) {
+                if (!claimSite(result, node.sval, 'sval'))
+                    return;
                 node.sval.sval = transformSchemaRefsInString(node.sval.sval, schemaMapping, result);
             }
         },
+        // Object identities carried as the operand of an identity cast
+        // ('sch.tbl'::regclass, 'sch.fn(uuid)'::regprocedure, 'sch'::regnamespace).
+        // The cast names the namespace, so these route through the same object
+        // routes as a RangeVar rather than through a string pattern — and the bare
+        // schema form, invisible to every string pass, routes here.
+        TypeCast: (path) => {
+            const node = path.node;
+            const sval = node?.arg?.A_Const?.sval;
+            if (typeof sval?.sval !== 'string')
+                return;
+            const ns = identityCastNamespace(node.typeName);
+            if (!ns)
+                return;
+            if (!claimSite(result, sval, 'sval'))
+                return;
+            sval.sval = transformIdentityCastLiteral(sval.sval, ns, router, result);
+        },
         // Transform DefineStmt (CREATE TYPE schema.name, CREATE AGGREGATE schema.agg)
         DefineStmt: (path) => {
             const node = path.node;

package/index.d.ts

@@ -23,4 +23,4 @@ export { CLEAN_TREE_VOLATILE_KEYS, cleanTree, normalizeTree, trimDefElemBody, }
 export type { ObjectNamespace, ObjectRoute, ObjectRouteTarget, RouteNamespace, RouteSpec, SchemaRoute, } from './router';
 export { SchemaRouter } from './router';
 export type { SchemaMappingInput, SchemaTransformPass, SchemaTransformResult, TransformSqlOptions, } from './transform';
-export { createPlpgsqlVisitor, createSqlVisitor, escapeRegexp, extractPgpmHeader, shouldTransformSchema, transformComments, transformJsonStringValues, transformNameList, transformPlpgsqlTypeAst, transformPlpgsqlTypeString, transformRelation, transformSchemaName, transformSql, transformSqlStatement, transformVerifyCalls, validateNoUntransformedSchemas, walkPlpgsqlForSchemas, } from './transform';
+export { createPlpgsqlVisitor, createSqlVisitor, escapeRegexp, extractPgpmHeader, identityCastNamespace, shouldTransformSchema, transformComments, transformIdentityCastLiteral, transformJsonStringValues, transformNameList, transformPlpgsqlTypeAst, transformPlpgsqlTypeString, transformRelation, transformSchemaName, transformSql, transformSqlStatement, transformVerifyCalls, validateNoUntransformedSchemas, walkPlpgsqlForSchemas, } from './transform';

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.walkPlpgsqlForSchemas = exports.validateNoUntransformedSchemas = exports.transformVerifyCalls = exports.transformSqlStatement = exports.transformSql = exports.transformSchemaName = exports.transformRelation = exports.transformPlpgsqlTypeString = exports.transformPlpgsqlTypeAst = exports.transformNameList = exports.transformJsonStringValues = exports.transformComments = exports.shouldTransformSchema = exports.extractPgpmHeader = exports.escapeRegexp = exports.createSqlVisitor = exports.createPlpgsqlVisitor = exports.SchemaRouter = exports.trimDefElemBody = exports.normalizeTree = exports.cleanTree = exports.CLEAN_TREE_VOLATILE_KEYS = exports.validateRoundTrip = exports.normalizeParseTree = exports.firstDifference = exports.captureTransformAsts = exports.captureAstsFromSql = exports.transformRoles = exports.createRoleVisitor = exports.createRoleResult = exports.RoleRouter = exports.restructureSql = exports.orderStatements = exports.qualifyUnqualified = exports.mergeInventories = exports.createQualifyVisitor = exports.collectCreatedObjects = exports.identityOf = exports.buildStatementGraph = exports.classifyStatements = exports.transformExtensions = exports.createExtensionVisitor = exports.createExtensionResult = exports.ExtensionRouter = exports.COMMON_EXTENSIONS = void 0;
+exports.walkPlpgsqlForSchemas = exports.validateNoUntransformedSchemas = exports.transformVerifyCalls = exports.transformSqlStatement = exports.transformSql = exports.transformSchemaName = exports.transformRelation = exports.transformPlpgsqlTypeString = exports.transformPlpgsqlTypeAst = exports.transformNameList = exports.transformJsonStringValues = exports.transformIdentityCastLiteral = exports.transformComments = exports.shouldTransformSchema = exports.identityCastNamespace = exports.extractPgpmHeader = exports.escapeRegexp = exports.createSqlVisitor = exports.createPlpgsqlVisitor = exports.SchemaRouter = exports.trimDefElemBody = exports.normalizeTree = exports.cleanTree = exports.CLEAN_TREE_VOLATILE_KEYS = exports.validateRoundTrip = exports.normalizeParseTree = exports.firstDifference = exports.captureTransformAsts = exports.captureAstsFromSql = exports.transformRoles = exports.createRoleVisitor = exports.createRoleResult = exports.RoleRouter = exports.restructureSql = exports.orderStatements = exports.qualifyUnqualified = exports.mergeInventories = exports.createQualifyVisitor = exports.collectCreatedObjects = exports.identityOf = exports.buildStatementGraph = exports.classifyStatements = exports.transformExtensions = exports.createExtensionVisitor = exports.createExtensionResult = exports.ExtensionRouter = exports.COMMON_EXTENSIONS = void 0;
 var extension_router_1 = require("./extension-router");
 Object.defineProperty(exports, "COMMON_EXTENSIONS", { enumerable: true, get: function () { return extension_router_1.COMMON_EXTENSIONS; } });
 Object.defineProperty(exports, "ExtensionRouter", { enumerable: true, get: function () { return extension_router_1.ExtensionRouter; } });
@@ -46,8 +46,10 @@ Object.defineProperty(exports, "createPlpgsqlVisitor", { enumerable: true, get:
 Object.defineProperty(exports, "createSqlVisitor", { enumerable: true, get: function () { return transform_1.createSqlVisitor; } });
 Object.defineProperty(exports, "escapeRegexp", { enumerable: true, get: function () { return transform_1.escapeRegexp; } });
 Object.defineProperty(exports, "extractPgpmHeader", { enumerable: true, get: function () { return transform_1.extractPgpmHeader; } });
+Object.defineProperty(exports, "identityCastNamespace", { enumerable: true, get: function () { return transform_1.identityCastNamespace; } });
 Object.defineProperty(exports, "shouldTransformSchema", { enumerable: true, get: function () { return transform_1.shouldTransformSchema; } });
 Object.defineProperty(exports, "transformComments", { enumerable: true, get: function () { return transform_1.transformComments; } });
+Object.defineProperty(exports, "transformIdentityCastLiteral", { enumerable: true, get: function () { return transform_1.transformIdentityCastLiteral; } });
 Object.defineProperty(exports, "transformJsonStringValues", { enumerable: true, get: function () { return transform_1.transformJsonStringValues; } });
 Object.defineProperty(exports, "transformNameList", { enumerable: true, get: function () { return transform_1.transformNameList; } });
 Object.defineProperty(exports, "transformPlpgsqlTypeAst", { enumerable: true, get: function () { return transform_1.transformPlpgsqlTypeAst; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgsql/transform",
-  "version": "18.15.3",
+  "version": "18.16.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "AST-based SQL transformation, qualification, classification and closure analysis for PostgreSQL",
   "main": "index.js",
@@ -50,5 +50,5 @@
     "classify",
     "plpgsql"
   ],
-  "gitHead": "69cdce673db035fb1ee3b529480d39fac01512ab"
+  "gitHead": "9ecd247f9f0ef696a95e1f582d7353eb6bb693d4"
 }

package/transform.d.ts

@@ -123,6 +123,19 @@ export declare function transformRelation(relation: any, schemaMapping: SchemaMa
  * followed by a dot are rewritten.
  */
 export declare function transformSchemaRefsInString(str: string, schemaMapping: SchemaMappingInput, result: SchemaTransformResult): string;
+/**
+ * The namespace a cast resolves its operand in, or `undefined` when the target
+ * type is not an object-identity type.
+ */
+export declare function identityCastNamespace(typeName: any): RouteNamespace | undefined;
+/**
+ * Route the object reference carried in the string operand of an identity
+ * cast. `ns` comes from the cast's target type.
+ *
+ * Unqualified operands (`'tbl'::regclass`) name no schema — they resolve
+ * through `search_path` — so they are returned unchanged.
+ */
+export declare function transformIdentityCastLiteral(sval: string, ns: RouteNamespace, schemaMapping: SchemaMappingInput, result: SchemaTransformResult): string;
 /**
  * Create a SQL AST visitor that transforms schema names.
  *
@@ -148,6 +161,7 @@ export declare function createSqlVisitor(schemaMapping: SchemaMappingInput, resu
     CreateTrigStmt: (path: any) => void;
     CommentStmt: (path: any) => void;
     A_Const: (path: any) => void;
+    TypeCast: (path: any) => void;
     DefineStmt: (path: any) => void;
     CreateDomainStmt: (path: any) => void;
     CreateEnumStmt: (path: any) => void;

package/transform.js

@@ -31,6 +31,8 @@ exports.transformNameList = transformNameList;
 exports.transformSchemaNameField = transformSchemaNameField;
 exports.transformRelation = transformRelation;
 exports.transformSchemaRefsInString = transformSchemaRefsInString;
+exports.identityCastNamespace = identityCastNamespace;
+exports.transformIdentityCastLiteral = transformIdentityCastLiteral;
 exports.createSqlVisitor = createSqlVisitor;
 exports.validateNoUntransformedSchemas = validateNoUntransformedSchemas;
 exports.createPlpgsqlVisitor = createPlpgsqlVisitor;
@@ -230,6 +232,98 @@ function transformSchemaRefsInString(str, schemaMapping, result) {
     }
     return out;
 }
+/**
+ * Cast types whose string operand is an object reference rather than opaque
+ * text. `'sch.tbl'::regclass` is a relation the parser resolves, and the cast
+ * names the namespace it resolves in — so the reference can be routed from the
+ * cast, semantically, instead of pattern-matched. This reaches what the string
+ * passes cannot: a bare `'sch'::regnamespace` has no dot to match on.
+ */
+const IDENTITY_CAST_NAMESPACES = {
+    regclass: 'relation',
+    regcollation: 'unknown',
+    regconfig: 'unknown',
+    regdictionary: 'unknown',
+    regnamespace: 'schema',
+    regoper: 'unknown',
+    regoperator: 'unknown',
+    regproc: 'function',
+    regprocedure: 'function',
+    regtype: 'type'
+};
+/**
+ * The namespace a cast resolves its operand in, or `undefined` when the target
+ * type is not an object-identity type.
+ */
+function identityCastNamespace(typeName) {
+    const names = typeName?.names;
+    if (!Array.isArray(names) || names.length === 0)
+        return undefined;
+    // Only `pg_catalog`-qualified (or unqualified) reg* types are the built-ins.
+    if (names.length > 1 && names[0]?.String?.sval !== 'pg_catalog')
+        return undefined;
+    const typeIdent = names[names.length - 1]?.String?.sval;
+    if (typeof typeIdent !== 'string')
+        return undefined;
+    return IDENTITY_CAST_NAMESPACES[typeIdent.toLowerCase()];
+}
+const IDENTITY_TOKEN = String.raw `(?:"(?:[^"]|"")*"|[^\s".,()[\]]+)`;
+const BARE_IDENTITY_RE = new RegExp(`^\\s*(${IDENTITY_TOKEN})\\s*$`);
+const QUALIFIED_IDENTITY_RE = new RegExp(`^\\s*(${IDENTITY_TOKEN})\\.([\\s\\S]+)$`);
+function unquoteIdentifier(token) {
+    if (token.length > 1 && token.startsWith('"') && token.endsWith('"')) {
+        return token.slice(1, -1).replace(/""/g, '"');
+    }
+    return token;
+}
+/**
+ * Route the object reference carried in the string operand of an identity
+ * cast. `ns` comes from the cast's target type.
+ *
+ * Unqualified operands (`'tbl'::regclass`) name no schema — they resolve
+ * through `search_path` — so they are returned unchanged.
+ */
+function transformIdentityCastLiteral(sval, ns, schemaMapping, result) {
+    const router = asRouter(schemaMapping);
+    if (ns === 'schema') {
+        const bare = BARE_IDENTITY_RE.exec(sval);
+        if (!bare)
+            return sval;
+        const schemaName = unquoteIdentifier(bare[1]);
+        const newName = router.resolve(schemaName, undefined, 'schema');
+        if (!newName || newName === schemaName)
+            return sval;
+        result.schemasFound.add(schemaName);
+        result.schemasTransformed.set(schemaName, newName);
+        return quotes_1.QuoteUtils.quoteIdentifier(newName);
+    }
+    // `regprocedure` and `regoperator` carry an argument list after the name, and
+    // an argument type can itself be schema-qualified
+    // (`fn("my-schema".row_type)`), so the list is routed as ordinary schema refs.
+    const argsAt = sval.indexOf('(');
+    const head = argsAt === -1 ? sval : sval.slice(0, argsAt);
+    const args = argsAt === -1 ? '' : transformSchemaRefsInString(sval.slice(argsAt), router, result);
+    const qualified = QUALIFIED_IDENTITY_RE.exec(head);
+    if (!qualified)
+        return `${head}${args}`;
+    const schemaName = unquoteIdentifier(qualified[1]);
+    const objName = unquoteIdentifier(qualified[2].trim());
+    const target = router.resolveObject(schemaName, objName, ns);
+    if (!target)
+        return `${head}${args}`;
+    const rebound = target.name !== undefined && target.name !== objName;
+    const requalified = target.schema === null || (!!target.schema && target.schema !== schemaName);
+    if (!rebound && !requalified)
+        return `${head}${args}`;
+    result.schemasFound.add(schemaName);
+    const nameToken = quotes_1.QuoteUtils.quoteIdentifier(rebound ? target.name : objName);
+    if (target.schema === null)
+        return `${nameToken}${args}`;
+    if (target.schema && target.schema !== schemaName) {
+        result.schemasTransformed.set(schemaName, target.schema);
+    }
+    return `${quotes_1.QuoteUtils.quoteIdentifier(target.schema ?? schemaName)}.${nameToken}${args}`;
+}
 /**
  * Create a SQL AST visitor that transforms schema names.
  *
@@ -482,9 +576,28 @@ function createSqlVisitor(schemaMapping, result, visitorOptions) {
         A_Const: (path) => {
             const node = path.node;
             if (typeof node.sval?.sval === 'string' && node.sval.sval.includes('.')) {
+                if (!claimSite(result, node.sval, 'sval'))
+                    return;
                 node.sval.sval = transformSchemaRefsInString(node.sval.sval, schemaMapping, result);
             }
         },
+        // Object identities carried as the operand of an identity cast
+        // ('sch.tbl'::regclass, 'sch.fn(uuid)'::regprocedure, 'sch'::regnamespace).
+        // The cast names the namespace, so these route through the same object
+        // routes as a RangeVar rather than through a string pattern — and the bare
+        // schema form, invisible to every string pass, routes here.
+        TypeCast: (path) => {
+            const node = path.node;
+            const sval = node?.arg?.A_Const?.sval;
+            if (typeof sval?.sval !== 'string')
+                return;
+            const ns = identityCastNamespace(node.typeName);
+            if (!ns)
+                return;
+            if (!claimSite(result, sval, 'sval'))
+                return;
+            sval.sval = transformIdentityCastLiteral(sval.sval, ns, router, result);
+        },
         // Transform DefineStmt (CREATE TYPE schema.name, CREATE AGGREGATE schema.agg)
         DefineStmt: (path) => {
             const node = path.node;