@pgsql/transform 17.7.1 → 17.8.0

package/13/enums.d.ts

@@ -1,5 +1,5 @@
 /**
-* This file was automatically generated by pg-proto-parser@1.29.1.
+* This file was automatically generated by pg-proto-parser@1.29.2.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file,
 * and run the pg-proto-parser generate command to regenerate this file.
 */

package/13/types.d.ts

@@ -1,5 +1,5 @@
 /**
-* This file was automatically generated by pg-proto-parser@1.29.1.
+* This file was automatically generated by pg-proto-parser@1.29.2.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file,
 * and run the pg-proto-parser generate command to regenerate this file.
 */

package/14/enums.d.ts

@@ -1,5 +1,5 @@
 /**
-* This file was automatically generated by pg-proto-parser@1.29.1.
+* This file was automatically generated by pg-proto-parser@1.29.2.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file,
 * and run the pg-proto-parser generate command to regenerate this file.
 */

package/14/types.d.ts

@@ -1,5 +1,5 @@
 /**
-* This file was automatically generated by pg-proto-parser@1.29.1.
+* This file was automatically generated by pg-proto-parser@1.29.2.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file,
 * and run the pg-proto-parser generate command to regenerate this file.
 */

package/15/enums.d.ts

@@ -1,5 +1,5 @@
 /**
-* This file was automatically generated by pg-proto-parser@1.29.1.
+* This file was automatically generated by pg-proto-parser@1.29.2.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file,
 * and run the pg-proto-parser generate command to regenerate this file.
 */

package/15/types.d.ts

@@ -1,5 +1,5 @@
 /**
-* This file was automatically generated by pg-proto-parser@1.29.1.
+* This file was automatically generated by pg-proto-parser@1.29.2.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file,
 * and run the pg-proto-parser generate command to regenerate this file.
 */

package/16/enums.d.ts

@@ -1,5 +1,5 @@
 /**
-* This file was automatically generated by pg-proto-parser@1.29.1.
+* This file was automatically generated by pg-proto-parser@1.29.2.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file,
 * and run the pg-proto-parser generate command to regenerate this file.
 */

package/16/types.d.ts

@@ -1,5 +1,5 @@
 /**
-* This file was automatically generated by pg-proto-parser@1.29.1.
+* This file was automatically generated by pg-proto-parser@1.29.2.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file,
 * and run the pg-proto-parser generate command to regenerate this file.
 */

package/17/enums.d.ts

@@ -1,5 +1,5 @@
 /**
-* This file was automatically generated by pg-proto-parser@1.29.1.
+* This file was automatically generated by pg-proto-parser@1.29.2.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file,
 * and run the pg-proto-parser generate command to regenerate this file.
 */

package/17/types.d.ts

@@ -1,5 +1,5 @@
 /**
-* This file was automatically generated by pg-proto-parser@1.29.1.
+* This file was automatically generated by pg-proto-parser@1.29.2.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file,
 * and run the pg-proto-parser generate command to regenerate this file.
 */

package/README.md

@@ -8,13 +8,112 @@
   <a href="https://github.com/launchql/pgsql-parser/actions/workflows/run-tests.yaml">
     <img height="20" src="https://github.com/launchql/pgsql-parser/actions/workflows/run-tests.yaml/badge.svg" />
   </a>
-   <!-- <a href="https://www.npmjs.com/package/@pgsql/types"><img height="20" src="https://img.shields.io/npm/dt/@pgsql/types"></a> -->
-   <!-- <a href="https://www.npmjs.com/package/@pgsql/types"><img height="20" src="https://img.shields.io/npm/dw/@pgsql/types"/></a> -->
    <a href="https://github.com/launchql/pgsql-parser/blob/main/LICENSE-MIT"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
-   <a href="https://www.npmjs.com/package/@pgsql/types"><img height="20" src="https://img.shields.io/github/package-json/v/launchql/pgsql-parser?filename=packages%2Ftypes%2Fpackage.json"/></a>
+   <a href="https://www.npmjs.com/package/@pgsql/transform"><img height="20" src="https://img.shields.io/github/package-json/v/launchql/pgsql-parser?filename=packages%2Ftransform%2Fpackage.json"/></a>
 </p>
 
-`@pgsql/types` is a TypeScript library providing type definitions for PostgreSQL AST nodes, primarily used in conjunction with [`pgsql-parser`](https://github.com/launchql/pgsql-parser). It offers a comprehensive and type-safe way to interact with the AST nodes generated by PostgreSQL query parsing.
+`@pgsql/transform` is a TypeScript library for transforming PostgreSQL ASTs between different PostgreSQL versions. It serves as a crucial component for building a single source of truth deparser that can handle SQL from multiple PostgreSQL versions while maintaining backward compatibility.
+
+## Transforming ASTs Between PG Versions
+
+The transform package enables you to:
+
+- **Transform legacy ASTs**: Convert ASTs from PostgreSQL versions 13-16 to version 17
+- **Build unified deparsers**: Create a single deparser pipeline that works with multiple PostgreSQL versions
+- **Maintain backward compatibility**: Support legacy codebases while leveraging the latest PostgreSQL features
+
+## Key Limitation
+
+This package only supports ASTs derived from SQL that is parseable by PostgreSQL 17. This means:
+
+- ✅ **Supported**: SQL from PG13-16 that remains valid in PG17
+- ❌ **Not supported**: Deprecated syntax from older versions that was removed
+- ❌ **Not supported**: SQL that cannot be parsed by the PG17 parser
+
+This design ensures all transformed ASTs can be reliably deparsed using the latest PostgreSQL grammar.
+
+## Installation
+
+```bash
+npm install @pgsql/transform
+```
+
+## 🚀 Quick Start
+
+### Multi-Version Transformer
+
+```typescript
+import { ASTTransformer } from '@pgsql/transform';
+
+const transformer = new ASTTransformer();
+
+// Transform any version to PG17
+const pg17Ast = transformer.transformToLatest(pg13Ast, 13);
+
+// Transform between specific versions
+const pg15Ast = transformer.transform(pg13Ast, 13, 15);
+
+// Convenience methods
+const result = transformer.transform13To17(pg13Ast);
+```
+
+### Direct Transformers
+
+For better performance when you know source and target versions:
+
+```typescript
+import { PG13ToPG17Transformer } from '@pgsql/transform';
+
+const transformer = new PG13ToPG17Transformer();
+const pg17Ast = transformer.transform(pg13Ast);
+```
+
+### Integration Example
+
+```typescript
+import { parse } from '@pgsql/parser';
+import { deparse } from 'pgsql-deparser';
+import { PG13ToPG17Transformer } from '@pgsql/transform';
+
+// Parse with older version
+const pg13Ast = await parse('SELECT * FROM users', { version: 13 });
+
+// Transform to latest
+const transformer = new PG13ToPG17Transformer();
+const pg17Ast = transformer.transform(pg13Ast);
+
+// Deparse with latest grammar
+const sql = await deparse(pg17Ast);
+```
+
+## 🔄 Transformation Chain
+
+**Incremental**: PG13 → PG14 → PG15 → PG16 → PG17
+- Step-by-step version upgrades
+- Useful for debugging transformation issues
+
+**Direct**: PG13 → PG17, PG14 → PG17, etc.
+- Single-step transformations
+- Optimized for performance
+
+## 📋 Supported Transformations
+
+| From | To | Transformer |
+|------|----|-----------| 
+| PG13 | PG14, PG15, PG16, PG17 | `V13ToV14Transformer`, `PG13ToPG17Transformer` |
+| PG14 | PG15, PG16, PG17 | `V14ToV15Transformer`, `PG14ToPG17Transformer` |
+| PG15 | PG16, PG17 | `V15ToV16Transformer`, `PG15ToPG17Transformer` |
+| PG16 | PG17 | `V16ToV17Transformer`, `PG16ToPG17Transformer` |
+
+## 🏗️ Architecture
+
+The transform package fits into the broader pgsql-parser ecosystem:
+
+1. **Parse** legacy SQL with version-specific parsers
+2. **Transform** ASTs to the latest version
+3. **Deparse** using the unified, latest-version deparser
+
+This enables a single source of truth for SQL generation while supporting legacy codebases.
 
 ## Related
 
@@ -24,6 +123,7 @@
 * [@pgsql/types](https://www.npmjs.com/package/@pgsql/types): Offers TypeScript type definitions for PostgreSQL AST nodes, facilitating type-safe construction, analysis, and manipulation of ASTs.
 * [@pgsql/enums](https://www.npmjs.com/package/@pgsql/enums): Provides TypeScript enum definitions for PostgreSQL constants, enabling type-safe usage of PostgreSQL enums and constants in your applications.
 * [@pgsql/utils](https://www.npmjs.com/package/@pgsql/utils): A comprehensive utility library for PostgreSQL, offering type-safe AST node creation and enum value conversions, simplifying the construction and manipulation of PostgreSQL ASTs.
+* [@pgsql/traverse](https://www.npmjs.com/package/@pgsql/traverse): PostgreSQL AST traversal utilities for pgsql-parser, providing a visitor pattern for traversing PostgreSQL Abstract Syntax Tree nodes, similar to Babel's traverse functionality but specifically designed for PostgreSQL AST structures.
 * [pg-proto-parser](https://www.npmjs.com/package/pg-proto-parser): A TypeScript tool that parses PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
 * [libpg-query](https://github.com/launchql/libpg-query-node): The real PostgreSQL parser exposed for Node.js, used primarily in `pgsql-parser` for parsing and deparsing SQL queries.
 
@@ -31,4 +131,4 @@
 
 AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
 
-No developer or entity involved in creating Software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the Software code or Software CLI, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.
+No developer or entity involved in creating Software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the Software code or Software CLI, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

package/esm/transformers/v14-to-v15.js

@@ -654,6 +654,9 @@ export class V14ToV15Transformer {
         if (node.name !== undefined) {
             result.name = node.name;
         }
+        if (node.num !== undefined) {
+            result.num = node.num;
+        }
         if (node.newowner !== undefined) {
             result.newowner = this.transform(node.newowner, context);
         }

package/esm/transformers/v15-to-v16.js

@@ -327,6 +327,18 @@ export class V15ToV16Transformer {
                     { String: { sval: 'json_object' } }
                 ];
             }
+            else if (node.funcname.length === 2 &&
+                node.funcname[0]?.String?.sval === 'pg_catalog' &&
+                node.funcname[1]?.String?.sval === 'system_user' &&
+                node.funcformat === 'COERCE_SQL_SYNTAX') {
+                return {
+                    ColumnRef: {
+                        fields: [
+                            { String: { sval: 'system_user' } }
+                        ]
+                    }
+                };
+            }
             else {
                 result.funcname = Array.isArray(node.funcname)
                     ? node.funcname.map((item) => this.transform(item, context))
@@ -432,6 +444,20 @@ export class V15ToV16Transformer {
         return { A_Const: result };
     }
     ColumnRef(node, context) {
+        if (node.fields && Array.isArray(node.fields) && node.fields.length === 1) {
+            const field = node.fields[0];
+            if (field?.String?.sval === 'system_user') {
+                return {
+                    FuncCall: {
+                        funcname: [
+                            { String: { sval: 'pg_catalog' } },
+                            { String: { sval: 'system_user' } }
+                        ],
+                        funcformat: 'COERCE_SQL_SYNTAX'
+                    }
+                };
+            }
+        }
         const result = {};
         if (node.fields !== undefined) {
             result.fields = Array.isArray(node.fields)
@@ -494,6 +520,30 @@ export class V15ToV16Transformer {
         return { Alias: result };
     }
     RangeVar(node, context) {
+        if (node.relname === 'system_user' && node.inh === true && node.relpersistence === 'p') {
+            return {
+                RangeFunction: {
+                    functions: [
+                        {
+                            List: {
+                                items: [
+                                    {
+                                        FuncCall: {
+                                            funcname: [
+                                                { String: { sval: 'pg_catalog' } },
+                                                { String: { sval: 'system_user' } }
+                                            ],
+                                            funcformat: 'COERCE_SQL_SYNTAX'
+                                        }
+                                    },
+                                    {}
+                                ]
+                            }
+                        }
+                    ]
+                }
+            };
+        }
         const result = {};
         if (node.catalogname !== undefined) {
             result.catalogname = node.catalogname;
@@ -701,7 +751,13 @@ export class V15ToV16Transformer {
         const result = {};
         if (node.items !== undefined) {
             result.items = Array.isArray(node.items)
-                ? node.items.map((item) => this.transform(item, context))
+                ? node.items.map((item) => {
+                    const transformed = this.transform(item, context);
+                    if (transformed === null) {
+                        return {};
+                    }
+                    return transformed;
+                })
                 : this.transform(node.items, context);
         }
         return { List: result };
@@ -1628,6 +1684,9 @@ export class V15ToV16Transformer {
         if (node.unique !== undefined) {
             result.unique = node.unique;
         }
+        if (node.nulls_not_distinct !== undefined) {
+            result.nulls_not_distinct = node.nulls_not_distinct;
+        }
         if (node.primary !== undefined) {
             result.primary = node.primary;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgsql/transform",
-  "version": "17.7.1",
+  "version": "17.8.0",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "description": "Transform PostgreSQL AST types for pgsql-parser",
   "main": "index.js",
@@ -34,9 +34,9 @@
   },
   "devDependencies": {
     "@pgsql/parser": "^1.1.4",
-    "pg-proto-parser": "^1.29.1",
-    "pgsql-deparser": "^17.8.5"
+    "pg-proto-parser": "^1.29.2",
+    "pgsql-deparser": "^17.9.0"
   },
   "keywords": [],
-  "gitHead": "4024140162b786638a20ac4d1d0ec0bcbbed7ccc"
+  "gitHead": "c2982c6793a8e92395a32e5d9d656b04e060466b"
 }

package/transformers/v14-to-v15.js

@@ -657,6 +657,9 @@ class V14ToV15Transformer {
         if (node.name !== undefined) {
             result.name = node.name;
         }
+        if (node.num !== undefined) {
+            result.num = node.num;
+        }
         if (node.newowner !== undefined) {
             result.newowner = this.transform(node.newowner, context);
         }

package/transformers/v15-to-v16.d.ts

@@ -40,6 +40,8 @@ export declare class V15ToV16Transformer {
     };
     FuncCall(node: PG15.FuncCall, context: TransformerContext): {
         FuncCall: PG16.FuncCall;
+    } | {
+        ColumnRef: PG16.ColumnRef;
     };
     FuncExpr(node: PG15.FuncExpr, context: TransformerContext): {
         FuncExpr: PG16.FuncExpr;
@@ -49,6 +51,8 @@ export declare class V15ToV16Transformer {
     };
     ColumnRef(node: PG15.ColumnRef, context: TransformerContext): {
         ColumnRef: PG16.ColumnRef;
+    } | {
+        FuncCall: PG16.FuncCall;
     };
     TypeName(node: PG15.TypeName, context: TransformerContext): {
         TypeName: PG16.TypeName;
@@ -58,6 +62,8 @@ export declare class V15ToV16Transformer {
     };
     RangeVar(node: PG15.RangeVar, context: TransformerContext): {
         RangeVar: PG16.RangeVar;
+    } | {
+        RangeFunction: PG16.RangeFunction;
     };
     A_ArrayExpr(node: PG15.A_ArrayExpr, context: TransformerContext): {
         A_ArrayExpr: PG16.A_ArrayExpr;

package/transformers/v15-to-v16.js

@@ -330,6 +330,18 @@ class V15ToV16Transformer {
                     { String: { sval: 'json_object' } }
                 ];
             }
+            else if (node.funcname.length === 2 &&
+                node.funcname[0]?.String?.sval === 'pg_catalog' &&
+                node.funcname[1]?.String?.sval === 'system_user' &&
+                node.funcformat === 'COERCE_SQL_SYNTAX') {
+                return {
+                    ColumnRef: {
+                        fields: [
+                            { String: { sval: 'system_user' } }
+                        ]
+                    }
+                };
+            }
             else {
                 result.funcname = Array.isArray(node.funcname)
                     ? node.funcname.map((item) => this.transform(item, context))
@@ -435,6 +447,20 @@ class V15ToV16Transformer {
         return { A_Const: result };
     }
     ColumnRef(node, context) {
+        if (node.fields && Array.isArray(node.fields) && node.fields.length === 1) {
+            const field = node.fields[0];
+            if (field?.String?.sval === 'system_user') {
+                return {
+                    FuncCall: {
+                        funcname: [
+                            { String: { sval: 'pg_catalog' } },
+                            { String: { sval: 'system_user' } }
+                        ],
+                        funcformat: 'COERCE_SQL_SYNTAX'
+                    }
+                };
+            }
+        }
         const result = {};
         if (node.fields !== undefined) {
             result.fields = Array.isArray(node.fields)
@@ -497,6 +523,30 @@ class V15ToV16Transformer {
         return { Alias: result };
     }
     RangeVar(node, context) {
+        if (node.relname === 'system_user' && node.inh === true && node.relpersistence === 'p') {
+            return {
+                RangeFunction: {
+                    functions: [
+                        {
+                            List: {
+                                items: [
+                                    {
+                                        FuncCall: {
+                                            funcname: [
+                                                { String: { sval: 'pg_catalog' } },
+                                                { String: { sval: 'system_user' } }
+                                            ],
+                                            funcformat: 'COERCE_SQL_SYNTAX'
+                                        }
+                                    },
+                                    {}
+                                ]
+                            }
+                        }
+                    ]
+                }
+            };
+        }
         const result = {};
         if (node.catalogname !== undefined) {
             result.catalogname = node.catalogname;
@@ -704,7 +754,13 @@ class V15ToV16Transformer {
         const result = {};
         if (node.items !== undefined) {
             result.items = Array.isArray(node.items)
-                ? node.items.map((item) => this.transform(item, context))
+                ? node.items.map((item) => {
+                    const transformed = this.transform(item, context);
+                    if (transformed === null) {
+                        return {};
+                    }
+                    return transformed;
+                })
                 : this.transform(node.items, context);
         }
         return { List: result };
@@ -1631,6 +1687,9 @@ class V15ToV16Transformer {
         if (node.unique !== undefined) {
             result.unique = node.unique;
         }
+        if (node.nulls_not_distinct !== undefined) {
+            result.nulls_not_distinct = node.nulls_not_distinct;
+        }
         if (node.primary !== undefined) {
             result.primary = node.primary;
         }

package/13/enum-to-int.d.ts

@@ -1,7 +0,0 @@
-/**
-* This file was automatically generated by pg-proto-parser@1.29.1.
-* DO NOT MODIFY IT BY HAND. Instead, modify the source proto file,
-* and run the pg-proto-parser generate command to regenerate this file.
-*/
-export type EnumType = "OverridingKind" | "QuerySource" | "SortByDir" | "SortByNulls" | "A_Expr_Kind" | "RoleSpecType" | "TableLikeOption" | "DefElemAction" | "PartitionRangeDatumKind" | "RTEKind" | "WCOKind" | "GroupingSetKind" | "CTEMaterialize" | "SetOperation" | "ObjectType" | "DropBehavior" | "AlterTableType" | "GrantTargetType" | "VariableSetKind" | "ConstrType" | "ImportForeignSchemaType" | "RoleStmtType" | "FetchDirection" | "FunctionParameterMode" | "TransactionStmtKind" | "ViewCheckOption" | "ClusterOption" | "DiscardMode" | "ReindexObjectType" | "AlterTSConfigType" | "AlterSubscriptionType" | "OnCommitAction" | "ParamKind" | "CoercionContext" | "CoercionForm" | "BoolExprType" | "SubLinkType" | "RowCompareType" | "MinMaxOp" | "SQLValueFunctionOp" | "XmlExprOp" | "XmlOptionType" | "NullTestType" | "BoolTestType" | "CmdType" | "JoinType" | "AggStrategy" | "AggSplit" | "SetOpCmd" | "SetOpStrategy" | "OnConflictAction" | "LimitOption" | "LockClauseStrength" | "LockWaitPolicy" | "LockTupleMode" | "KeywordKind" | "Token";
-export declare const getEnumInt: (enumType: EnumType, key: string) => number;