pgsql-deparser 15.1.1 → 15.2.0

package/esm/deparser/index.js

@@ -2,7 +2,7 @@
  * Auto-generated file with types stripped for better tree-shaking
  * DO NOT EDIT - Generated by strip-deparser-types.ts
  */
-import { Deparser } from "./deparser";
+import { Deparser } from './deparser';
 const deparseMethod = Deparser.deparse;
 // Export the original sync version as deparseSync
 export const deparseSync = deparseMethod;
@@ -11,3 +11,5 @@ export const deparse = async (...args) => {
     return deparseMethod(...args);
 };
 export { Deparser };
+export { splitSqlLines } from './utils/sql-formatter';
+export { QuoteUtils } from '@pgsql/quotes';

package/esm/deparser/utils/sql-formatter.js

@@ -2,6 +2,108 @@
  * Auto-generated file with types stripped for better tree-shaking
  * DO NOT EDIT - Generated by strip-deparser-types.ts
  */
+const isIdentChar = (ch) => ch !== undefined && (/[A-Za-z0-9_$]/.test(ch) || ch.charCodeAt(0) >= 0x80);
+const DOLLAR_TAG = /\$(?:[A-Za-z_\u0080-\uffff][A-Za-z0-9_\u0080-\uffff]*)?\$/y;
+/**
+ * Splits SQL text into lines, breaking only at newlines that sit between
+ * tokens. A newline inside a string literal ('...', E'...', $tag$...$tag$),
+ * a quoted identifier or a block comment is part of that token's value and
+ * stays inside its line, so callers can re-indent the lines without changing
+ * what the SQL means.
+ */
+export function splitSqlLines(text, newlineChar = '\n') {
+    if (!newlineChar || !text.includes(newlineChar)) {
+        return [text];
+    }
+    const lines = [];
+    const length = text.length;
+    let lineStart = 0;
+    let i = 0;
+    while (i < length) {
+        const ch = text[i];
+        if (ch === "'") {
+            const prev = text[i - 1];
+            const backslashEscapes = (prev === 'E' || prev === 'e') && !isIdentChar(text[i - 2]);
+            i++;
+            while (i < length) {
+                if (backslashEscapes && text[i] === '\\') {
+                    i += 2;
+                }
+                else if (text[i] === "'") {
+                    if (text[i + 1] === "'") {
+                        i += 2;
+                    }
+                    else {
+                        break;
+                    }
+                }
+                else {
+                    i++;
+                }
+            }
+            i++;
+        }
+        else if (ch === '"') {
+            i++;
+            while (i < length) {
+                if (text[i] === '"') {
+                    if (text[i + 1] === '"') {
+                        i += 2;
+                    }
+                    else {
+                        break;
+                    }
+                }
+                else {
+                    i++;
+                }
+            }
+            i++;
+        }
+        else if (ch === '$' && !isIdentChar(text[i - 1])) {
+            DOLLAR_TAG.lastIndex = i;
+            const tag = DOLLAR_TAG.exec(text);
+            if (tag) {
+                const close = text.indexOf(tag[0], i + tag[0].length);
+                i = close === -1 ? length : close + tag[0].length;
+            }
+            else {
+                i++;
+            }
+        }
+        else if (ch === '-' && text[i + 1] === '-') {
+            const end = text.indexOf('\n', i);
+            i = end === -1 ? length : end;
+        }
+        else if (ch === '/' && text[i + 1] === '*') {
+            let depth = 1;
+            i += 2;
+            while (i < length && depth > 0) {
+                if (text[i] === '/' && text[i + 1] === '*') {
+                    depth++;
+                    i += 2;
+                }
+                else if (text[i] === '*' && text[i + 1] === '/') {
+                    depth--;
+                    i += 2;
+                }
+                else {
+                    i++;
+                }
+            }
+        }
+        else if (text.startsWith(newlineChar, i)) {
+            lines.push(text.slice(lineStart, i));
+            i += newlineChar.length;
+            lineStart = i;
+        }
+        else {
+            i++;
+        }
+    }
+    lines.push(text.slice(lineStart));
+    return lines;
+}
 export class SqlFormatter {
     newlineChar;
     tabChar;
@@ -19,7 +121,7 @@ export class SqlFormatter {
             return text;
         }
         const indentation = this.tabChar.repeat(count);
-        return text.split(this.newlineChar).map(line => line.trim() ? indentation + line : line).join(this.newlineChar);
+        return splitSqlLines(text, this.newlineChar).map(line => line.trim() ? indentation + line : line).join(this.newlineChar);
     }
     parens(content) {
         return `(${content})`;

package/esm/index.js

@@ -2,14 +2,70 @@
  * Deparser for PostgreSQL version 15
  * Auto-generated by generate-version-deparsers.ts
  */
-import { deparse as deparse17, deparseSync as deparseSync17 } from './deparser';
-import { PG15ToPG17Transformer } from './v15-to-v17-direct';
-const tx = new PG15ToPG17Transformer();
+import { Deparser as Deparser18 } from './deparser';
+import { PG15ToPG18Transformer } from './v15-to-v18-direct';
+const tx = new PG15ToPG18Transformer();
+const bare = (names, name) => Array.isArray(names) && names.length === 1 && (names[0]?.String?.sval ?? names[0]?.String?.str) === name;
+const v16to17 = tx.v16to17;
+const upgradeTypeName = v16to17.TypeName.bind(v16to17);
+v16to17.TypeName = (node, context) => {
+    const out = upgradeTypeName(node, context);
+    if (bare(node.names, 'json'))
+        out.TypeName.names = [{ String: { sval: 'json' } }];
+    return out;
+};
+const upgradeTypeCast = v16to17.TypeCast.bind(v16to17);
+v16to17.TypeCast = (node, context) => {
+    const out = upgradeTypeCast(node, context);
+    const typeName = out.TypeCast.typeName?.TypeName ?? out.TypeCast.typeName;
+    if (typeName && bare((node.typeName?.TypeName ?? node.typeName)?.names, 'json')) {
+        typeName.names = [{ String: { sval: 'json' } }];
+    }
+    return out;
+};
+const v15to16 = tx.v15to16;
+const upgradeFuncCall = v15to16.FuncCall.bind(v15to16);
+v15to16.FuncCall = (node, context) => {
+    const out = upgradeFuncCall(node, context);
+    if (out.FuncCall && bare(node.funcname, 'json_object')) {
+        out.FuncCall.funcname = [{ String: { sval: 'json_object' } }];
+    }
+    return out;
+};
+const toAst18 = (query) => Array.isArray(query) ? query.map(node => tx.transform(node)) : tx.transform(query);
+export class Deparser extends Deparser18 {
+    constructor(tree, opts = {}) {
+        super(toAst18(tree), opts);
+    }
+    static deparse(query, opts = {}) {
+        return new Deparser(query, opts).deparseQuery();
+    }
+    DefElem(node, context) {
+        if (!node.arg && node.defaction !== 'DEFELEM_DROP' && context.parentNodeTypes.includes('AlterOperatorStmt')) {
+            return `${node.defname} = NONE`;
+        }
+        return super.DefElem(node, context);
+    }
+    GrantRoleStmt(node, context) {
+        const sql = super.GrantRoleStmt(node, context);
+        const opts = (Array.isArray(node.opt) ? node.opt : []).map((opt) => opt.DefElem);
+        const arg = opts[0]?.arg;
+        const off = arg?.Boolean ? arg.Boolean.boolval !== true : arg?.String?.sval === 'false';
+        if (!node.is_grant || opts.length !== 1 || opts[0]?.defname !== 'admin' || off)
+            return sql;
+        // locate the option by what the statement prints without GRANTED BY, so a role name can never match
+        const head = node.grantor ? super.GrantRoleStmt({ ...node, grantor: undefined }, context) : sql;
+        const option = ' WITH ADMIN TRUE';
+        if (!head.endsWith(option) || !sql.startsWith(head))
+            return sql;
+        return head.slice(0, -option.length) + ' WITH ADMIN OPTION' + sql.slice(head.length);
+    }
+}
 export async function deparse(query, opts) {
-    const ast17 = tx.transform(query);
-    return await deparse17(ast17, opts);
+    return Deparser.deparse(query, opts);
 }
 export function deparseSync(query, opts) {
-    const ast17 = tx.transform(query);
-    return deparseSync17(ast17, opts);
+    return Deparser.deparse(query, opts);
 }
+export { splitSqlLines } from './deparser/utils/sql-formatter';
+export { QuoteUtils } from '@pgsql/quotes';

package/esm/v15-to-v16.js

@@ -790,9 +790,9 @@ export class V15ToV16Transformer {
             const partspec = { ...node.partspec };
             if (partspec.strategy !== undefined) {
                 const strategyMap = {
-                    'range': 'PARTITION_STRATEGY_RANGE',
-                    'list': 'PARTITION_STRATEGY_LIST',
-                    'hash': 'PARTITION_STRATEGY_HASH'
+                    range: 'PARTITION_STRATEGY_RANGE',
+                    list: 'PARTITION_STRATEGY_LIST',
+                    hash: 'PARTITION_STRATEGY_HASH'
                 };
                 partspec.strategy = strategyMap[partspec.strategy] || partspec.strategy;
             }
@@ -854,6 +854,9 @@ export class V15ToV16Transformer {
         if (node.storage !== undefined) {
             result.storage = node.storage;
         }
+        if (node.compression !== undefined) {
+            result.compression = node.compression;
+        }
         if (node.raw_default !== undefined) {
             result.raw_default = this.transform(node.raw_default, context);
         }
@@ -976,6 +979,11 @@ export class V15ToV16Transformer {
         if (node.fk_del_action !== undefined) {
             result.fk_del_action = node.fk_del_action;
         }
+        if (node.fk_del_set_cols !== undefined) {
+            result.fk_del_set_cols = Array.isArray(node.fk_del_set_cols)
+                ? node.fk_del_set_cols.map((item) => this.transform(item, context))
+                : this.transform(node.fk_del_set_cols, context);
+        }
         if (node.old_conpfeqop !== undefined) {
             result.old_conpfeqop = Array.isArray(node.old_conpfeqop)
                 ? node.old_conpfeqop.map((item) => this.transform(item, context))
@@ -2551,13 +2559,13 @@ export class V15ToV16Transformer {
             result.opt = [
                 {
                     DefElem: {
-                        defname: "admin",
+                        defname: 'admin',
                         arg: {
                             Boolean: {
                                 boolval: true
                             }
                         },
-                        defaction: "DEFELEM_UNSPEC"
+                        defaction: 'DEFELEM_UNSPEC'
                     }
                 }
             ];
@@ -2568,6 +2576,9 @@ export class V15ToV16Transformer {
                 ? nodeAny.opt.map((item) => this.transform(item, context))
                 : this.transform(nodeAny.opt, context);
         }
+        if (node.grantor !== undefined) {
+            result.grantor = node.grantor;
+        }
         return { GrantRoleStmt: result };
     }
     SecLabelStmt(node, context) {

package/esm/v15-to-v18-direct.js

@@ -0,0 +1,66 @@
+/**
+ * Auto-generated file with types stripped for better tree-shaking
+ * DO NOT EDIT - Generated by strip-direct-transformer-types.ts
+ */
+import { V15ToV16Transformer } from "./v15-to-v16";
+import { V16ToV17Transformer } from "./v16-to-v17";
+import { V17ToV18Transformer } from "./v17-to-v18";
+/**
+ * Direct transformer from PG15 to PG18
+ * This transformer chains v15->...->v18 transformations
+ */
+export class PG15ToPG18Transformer {
+    v15to16 = new V15ToV16Transformer();
+    v16to17 = new V16ToV17Transformer();
+    v17to18 = new V17ToV18Transformer();
+    transform(node) {
+        if (this.isParseResult(node)) {
+            // Transform through the chain: v15->v16->v17->v18
+            const v16Stmts = node.stmts.map((stmtWrapper) => {
+                if (stmtWrapper.stmt) {
+                    const stmt = this.v15to16.transform(stmtWrapper.stmt, { parentNodeTypes: [] });
+                    return { ...stmtWrapper, stmt };
+                }
+                return stmtWrapper;
+            });
+            const v17Stmts = v16Stmts.map((stmtWrapper) => {
+                if (stmtWrapper.stmt) {
+                    const stmt = this.v16to17.transform(stmtWrapper.stmt, { parentNodeTypes: [] });
+                    return { ...stmtWrapper, stmt };
+                }
+                return stmtWrapper;
+            });
+            const v18Stmts = v17Stmts.map((stmtWrapper) => {
+                if (stmtWrapper.stmt) {
+                    const stmt = this.v17to18.transform(stmtWrapper.stmt, { parentNodeTypes: [] });
+                    return { ...stmtWrapper, stmt };
+                }
+                return stmtWrapper;
+            });
+            return {
+                ...node,
+                version: 180004, // PG18 version
+                stmts: v18Stmts
+            };
+        }
+        // Otherwise, transform as a regular node through the chain
+        const v16Node = this.v15to16.transform(node, { parentNodeTypes: [] });
+        const v17Node = this.v16to17.transform(v16Node, { parentNodeTypes: [] });
+        return this.v17to18.transform(v17Node, { parentNodeTypes: [] });
+    }
+    /**
+     * Transform a single statement from PG15 to PG18
+     * @deprecated Use transform() instead, which handles all node types
+     */
+    transformStatement(stmt) {
+        const v16Stmt = this.v15to16.transform(stmt, { parentNodeTypes: [] });
+        const v17Stmt = this.v16to17.transform(v16Stmt, { parentNodeTypes: [] });
+        return this.v17to18.transform(v17Stmt, { parentNodeTypes: [] });
+    }
+    /**
+     * Type guard to check if a node is a ParseResult
+     */
+    isParseResult(node) {
+        return node && typeof node === 'object' && 'version' in node && 'stmts' in node;
+    }
+}

package/esm/v16-to-v17.js

@@ -652,6 +652,12 @@ export class V16ToV17Transformer {
         if (node.storage !== undefined) {
             result.storage = node.storage;
         }
+        if (node.storage_name !== undefined) {
+            result.storage_name = node.storage_name;
+        }
+        if (node.compression !== undefined) {
+            result.compression = node.compression;
+        }
         if (node.raw_default !== undefined) {
             result.raw_default = this.transform(node.raw_default, context);
         }
@@ -1110,7 +1116,50 @@ export class V16ToV17Transformer {
         return { AlterOpFamilyStmt: node };
     }
     MergeStmt(node, context) {
-        return { MergeStmt: node };
+        const result = {};
+        if (node.relation !== undefined) {
+            result.relation = node.relation;
+        }
+        if (node.sourceRelation !== undefined) {
+            result.sourceRelation = this.transform(node.sourceRelation, context);
+        }
+        if (node.joinCondition !== undefined) {
+            result.joinCondition = this.transform(node.joinCondition, context);
+        }
+        if (node.mergeWhenClauses !== undefined) {
+            result.mergeWhenClauses = Array.isArray(node.mergeWhenClauses)
+                ? node.mergeWhenClauses.map(item => this.transform(item, context))
+                : this.transform(node.mergeWhenClauses, context);
+        }
+        if (node.withClause !== undefined) {
+            result.withClause = this.WithClause(node.withClause, context);
+        }
+        return { MergeStmt: result };
+    }
+    MergeWhenClause(node, context) {
+        const result = {};
+        // v17 replaces the boolean matched with matchKind
+        result.matchKind = node.matched ? 'MERGE_WHEN_MATCHED' : 'MERGE_WHEN_NOT_MATCHED_BY_TARGET';
+        if (node.commandType !== undefined) {
+            result.commandType = node.commandType;
+        }
+        if (node.override !== undefined) {
+            result.override = node.override;
+        }
+        if (node.condition !== undefined) {
+            result.condition = this.transform(node.condition, context);
+        }
+        if (node.targetList !== undefined) {
+            result.targetList = Array.isArray(node.targetList)
+                ? node.targetList.map(item => this.transform(item, context))
+                : this.transform(node.targetList, context);
+        }
+        if (node.values !== undefined) {
+            result.values = Array.isArray(node.values)
+                ? node.values.map(item => this.transform(item, context))
+                : this.transform(node.values, context);
+        }
+        return { MergeWhenClause: result };
     }
     AlterTableMoveAllStmt(node, context) {
         return { AlterTableMoveAllStmt: node };

package/esm/v17-to-v18.js

@@ -0,0 +1,209 @@
+/**
+ * Auto-generated file with types stripped for better tree-shaking
+ * DO NOT EDIT - Generated by strip-transformer-types.ts
+ */
+// @ts-nocheck
+/**
+ * V17 to V18 AST Transformer
+ * Transforms PostgreSQL v17 AST nodes to v18 format
+ *
+ * Structural changes in v18:
+ * - InsertStmt/UpdateStmt/DeleteStmt/MergeStmt: returningList -> returningClause { exprs }
+ * - Constraint: new is_enforced flag (true by default for CHECK/FOREIGN/NOTNULL)
+ * - Constraint: CONSTR_GENERATED gains generated_kind ('s' = STORED, 'v' = VIRTUAL)
+ * - Column-level NOT NULL constraints gain initially_valid: true
+ */
+export class V17ToV18Transformer {
+    transform(node, context = { parentNodeTypes: [] }) {
+        if (node == null) {
+            return null;
+        }
+        if (typeof node === 'number' || node instanceof Number) {
+            return node;
+        }
+        if (typeof node === 'string') {
+            return node;
+        }
+        try {
+            return this.visit(node, context);
+        }
+        catch (error) {
+            const nodeType = Object.keys(node)[0];
+            throw new Error(`Error transforming ${nodeType}: ${error.message}`);
+        }
+    }
+    visit(node, context = { parentNodeTypes: [] }) {
+        if (node && typeof node === 'object' && 'version' in node && 'stmts' in node) {
+            return this.ParseResult(node, context);
+        }
+        const nodeType = this.getNodeType(node);
+        // Handle empty objects
+        if (!nodeType) {
+            return {};
+        }
+        const nodeData = this.getNodeData(node);
+        const methodName = nodeType;
+        if (typeof this[methodName] === 'function') {
+            const childContext = {
+                ...context,
+                parentNodeTypes: [...context.parentNodeTypes, nodeType]
+            };
+            const result = this[methodName](nodeData, childContext);
+            return result;
+        }
+        // No specific method: recurse into children so nested statements
+        // (e.g. DML inside CTEs) still get transformed
+        return this.walkValue(node, context);
+    }
+    /**
+     * Generic recursive walk that re-dispatches wrapped nodes with a
+     * dedicated transformer method and deep-copies everything else.
+     */
+    walkValue(value, context) {
+        if (value == null || typeof value !== 'object') {
+            return value;
+        }
+        if (Array.isArray(value)) {
+            return value.map(item => this.walkValue(item, context));
+        }
+        const keys = Object.keys(value);
+        if (keys.length === 1 && typeof this[keys[0]] === 'function') {
+            // Wrapped node with a dedicated transformer method
+            return this.visit(value, context);
+        }
+        const result = {};
+        for (const key of keys) {
+            result[key] = this.walkValue(value[key], context);
+        }
+        return result;
+    }
+    getNodeType(node) {
+        return Object.keys(node)[0];
+    }
+    getNodeData(node) {
+        const keys = Object.keys(node);
+        if (keys.length === 1 && typeof node[keys[0]] === 'object') {
+            return node[keys[0]];
+        }
+        return node;
+    }
+    ParseResult(node, context) {
+        if (node && typeof node === 'object' && 'version' in node && 'stmts' in node) {
+            return {
+                version: 180004, // PG18 version
+                stmts: node.stmts.map((stmt) => {
+                    if (stmt && typeof stmt === 'object' && 'stmt' in stmt) {
+                        return {
+                            ...stmt,
+                            stmt: this.transform(stmt.stmt, context)
+                        };
+                    }
+                    return this.transform(stmt, context);
+                })
+            };
+        }
+        return node;
+    }
+    RawStmt(node, context) {
+        const result = {};
+        if (node.stmt !== undefined) {
+            result.stmt = this.transform(node.stmt, context);
+        }
+        if (node.stmt_location !== undefined) {
+            result.stmt_location = node.stmt_location;
+        }
+        if (node.stmt_len !== undefined) {
+            result.stmt_len = node.stmt_len;
+        }
+        return { RawStmt: result };
+    }
+    /**
+     * Convert a v17 returningList into a v18 ReturningClause
+     */
+    transformReturningList(returningList, context) {
+        return {
+            exprs: returningList.map(item => this.transform(item, context))
+        };
+    }
+    transformDmlStatement(nodeType, node, context) {
+        const result = {};
+        for (const key of Object.keys(node)) {
+            if (key === 'returningList') {
+                result.returningClause = this.transformReturningList(node.returningList, context);
+            }
+            else {
+                result[key] = this.walkValue(node[key], context);
+            }
+        }
+        return { [nodeType]: result };
+    }
+    InsertStmt(node, context) {
+        return this.transformDmlStatement('InsertStmt', node, context);
+    }
+    UpdateStmt(node, context) {
+        return this.transformDmlStatement('UpdateStmt', node, context);
+    }
+    DeleteStmt(node, context) {
+        return this.transformDmlStatement('DeleteStmt', node, context);
+    }
+    MergeStmt(node, context) {
+        return this.transformDmlStatement('MergeStmt', node, context);
+    }
+    AlterTableCmd(node, context) {
+        const result = {};
+        for (const key of Object.keys(node)) {
+            result[key] = this.walkValue(node[key], context);
+        }
+        // v18 wraps ALTER CONSTRAINT definitions in the new ATAlterConstraint node
+        if (node.subtype === 'AT_AlterConstraint' && node.def?.Constraint) {
+            const constraint = node.def.Constraint;
+            const alterConstraint = {};
+            if (constraint.conname !== undefined) {
+                alterConstraint.conname = constraint.conname;
+            }
+            alterConstraint.is_enforced = true;
+            // v17 ALTER CONSTRAINT could only change deferrability
+            alterConstraint.alterDeferrability = true;
+            if (constraint.deferrable !== undefined) {
+                alterConstraint.deferrable = constraint.deferrable;
+            }
+            if (constraint.initdeferred !== undefined) {
+                alterConstraint.initdeferred = constraint.initdeferred;
+            }
+            result.def = { ATAlterConstraint: alterConstraint };
+        }
+        return { AlterTableCmd: result };
+    }
+    VariableSetStmt(node, context) {
+        const result = {};
+        for (const key of Object.keys(node)) {
+            result[key] = this.walkValue(node[key], context);
+        }
+        // v18 marks SET TRANSACTION / SESSION CHARACTERISTICS args as jumbled
+        if (node.kind === 'VAR_SET_MULTI' && (node.name === 'TRANSACTION' || node.name === 'SESSION CHARACTERISTICS')) {
+            result.jumble_args = true;
+        }
+        return { VariableSetStmt: result };
+    }
+    Constraint(node, context) {
+        const result = {};
+        for (const key of Object.keys(node)) {
+            result[key] = this.walkValue(node[key], context);
+        }
+        // v18 constraints are enforced by default; v17 grammar had no ENFORCED syntax
+        if (node.contype === 'CONSTR_CHECK' || node.contype === 'CONSTR_FOREIGN') {
+            result.is_enforced = true;
+        }
+        if (node.contype === 'CONSTR_NOTNULL') {
+            // v17 only produces column-level NOT NULL constraints, which in v18
+            // carry is_enforced and initially_valid
+            result.is_enforced = true;
+            result.initially_valid = true;
+        }
+        if (node.contype === 'CONSTR_GENERATED' && result.generated_kind === undefined) {
+            // v17 only supports STORED generated columns
+            result.generated_kind = 's';
+        }
+        return { Constraint: result };
+    }
+}

package/index.d.ts

@@ -3,7 +3,16 @@
  * Auto-generated by generate-version-deparsers.ts
  */
 import { Node, ParseResult } from '@pgsql/types';
-import { DeparserOptions } from './deparser';
-export declare function deparse(query: Node | Node[] | ParseResult, opts?: DeparserOptions): Promise<string>;
-export declare function deparseSync(query: Node | Node[] | ParseResult, opts?: DeparserOptions): string;
-export { DeparserOptions } from './deparser';
+import { Deparser as Deparser18, DeparserOptions } from './deparser';
+type Query = Node | Node[] | ParseResult;
+export declare class Deparser extends Deparser18 {
+    constructor(tree: Query, opts?: DeparserOptions);
+    static deparse(query: Query, opts?: DeparserOptions): string;
+    DefElem(node: any, context: any): string;
+    GrantRoleStmt(node: any, context: any): string;
+}
+export declare function deparse(query: Query, opts?: DeparserOptions): Promise<string>;
+export declare function deparseSync(query: Query, opts?: DeparserOptions): string;
+export { DeparserOptions };
+export { splitSqlLines } from './deparser/utils/sql-formatter';
+export { QuoteUtils } from '@pgsql/quotes';