pgsql-deparser 13.19.0 → 13.20.0

package/README.md

@@ -1,20 +1,20 @@
 # pgsql-deparser 
 
 <p align="center" width="100%">
-  <img height="120" src="https://github.com/launchql/pgsql-parser/assets/545047/6440fa7d-918b-4a3b-8d1b-755d85de8bea" />
+  <img height="250" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
 </p>
 
 <p align="center" width="100%">
-  <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 href="https://github.com/constructive-io/pgsql-parser/actions/workflows/run-tests.yaml">
+    <img height="20" src="https://github.com/constructive-io/pgsql-parser/actions/workflows/run-tests.yaml/badge.svg" />
   </a>
    <a href="https://www.npmjs.com/package/pgsql-deparser"><img height="20" src="https://img.shields.io/npm/dt/pgsql-deparser"></a>
    <a href="https://www.npmjs.com/package/pgsql-deparser"><img height="20" src="https://img.shields.io/npm/dw/pgsql-deparser"/></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-deparser"><img height="20" src="https://img.shields.io/github/package-json/v/launchql/pgsql-parser?filename=packages%2Fdeparser%2Fpackage.json"/></a>
+   <a href="https://github.com/constructive-io/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-deparser"><img height="20" src="https://img.shields.io/github/package-json/v/constructive-io/pgsql-parser?filename=packages%2Fdeparser%2Fpackage.json"/></a>
 </p>
 
-`pgsql-deparser` is the lightning-fast, pure TypeScript solution for converting PostgreSQL ASTs back into SQL queries. Perfect companion to [`pgsql-parser`](https://github.com/launchql/pgsql-parser), this focused tool delivers SQL generation without any native dependencies or WebAssembly overhead.
+`pgsql-deparser` is the lightning-fast, pure TypeScript solution for converting PostgreSQL ASTs back into SQL queries. Perfect companion to [`pgsql-parser`](https://github.com/constructive-io/pgsql-parser), this focused tool delivers SQL generation without any native dependencies or WebAssembly overhead.
 
 ## Installation
 
@@ -33,7 +33,7 @@ npm install pgsql-deparser
 
 The `pgsql-deparser` module serializes ASTs to SQL in pure TypeScript, avoiding the full parser's native dependencies. It's useful when only SQL string conversion from ASTs is needed, and is written in pure TypeScript for easy cross-environment deployment.
 
-Here's how you can use the deparser in your TypeScript code, using [`@pgsql/utils`](https://github.com/launchql/pgsql-parser/tree/main/packages/utils) to create an AST for `deparse`:
+Here's how you can use the deparser in your TypeScript code, using [`@pgsql/utils`](https://github.com/constructive-io/pgsql-parser/tree/main/packages/utils) to create an AST for `deparse`:
 
 ```ts
 import * as t from '@pgsql/utils';
@@ -69,27 +69,29 @@ console.log(deparse(stmt));
 // Output: SELECT * FROM another_table
 ```
 
-### Latest Version (PostgreSQL 17)
+### Latest Version (PostgreSQL 18)
 
 ```sh
 npm install pgsql-deparser
 ```
 
-### Version-Specific Packages (PostgreSQL 13-16)
+### Version-Specific Packages (PostgreSQL 13-17)
 
-While we highly recommend using PG17, for PostgreSQL versions 13-16, use the version-specific packages:
+We recommend PG18. PG17 remains fully supported; for PostgreSQL versions 13-17, use the version-specific packages:
 
 ```sh
 npm install pgsql-deparser@pg13  # PostgreSQL 13
 npm install pgsql-deparser@pg14  # PostgreSQL 14
 npm install pgsql-deparser@pg15  # PostgreSQL 15
 npm install pgsql-deparser@pg16  # PostgreSQL 16
+npm install pgsql-deparser@pg17  # PostgreSQL 17
 ```
 
 **Version Status:**
-- **PG17**: 🚀 Recommended (stable + modern AST)
-- **PG14-16**: ⚠️ Experimental (modern AST, hardening in progress)
-- **PG13**: Stable (legacy AST format)
+- **PG18**: 🚀 Recommended (stable + modern AST)
+- **PG17**: Stable (modern AST)
+- **PG14-16**: Legacy (modern AST, not actively developed)
+- **PG13**: Legacy (legacy AST format)
 
 ## Options
 
@@ -131,7 +133,7 @@ const sql2 = deparse(selectAst, { pretty: true });
 //   active = true;
 ```
 
-For complete documentation and advanced options, see [DEPARSER_USAGE.md](../../DEPARSER_USAGE.md).
+For complete documentation and advanced options, see [DEPARSER_USAGE.md](https://github.com/constructive-io/pgsql-parser/tree/main/packages/deparser/DEPARSER_USAGE.md).
 
 ## Why Use `pgsql-deparser`?
 
@@ -147,8 +149,13 @@ Built on the excellent work of several contributors:
 * **[Ethan Resnick](https://github.com/ethanresnick)** for the original Node.js N-API bindings
 * **[Zac McCormick](https://github.com/zhm)** for the foundational [node-pg-query-native](https://github.com/zhm/node-pg-query-native) parser
 
+**🛠 Built by the [Constructive](https://constructive.io) team — creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on [GitHub](https://github.com/constructive-io).**
+
 ## Related
 
+* [pgpm](https://pgpm.dev): A Postgres Package Manager that brings modular development to PostgreSQL with reusable packages, deterministic migrations, recursive dependency resolution, and tag-aware versioning.
+* [pgsql-test](https://www.npmjs.com/package/pgsql-test): Instant, isolated PostgreSQL databases for each test with automatic transaction rollbacks, context switching, and clean seeding for fast, reliable database testing.
+* [pgsql-seed](https://www.npmjs.com/package/pgsql-seed): PostgreSQL seeding utilities for CSV, JSON, SQL data loading, and pgpm deployment.
 * [pgsql-parser](https://www.npmjs.com/package/pgsql-parser): The real PostgreSQL parser for Node.js, providing symmetric parsing and deparsing of SQL statements with actual PostgreSQL parser integration.
 * [pgsql-deparser](https://www.npmjs.com/package/pgsql-deparser): A streamlined tool designed for converting PostgreSQL ASTs back into SQL queries, focusing solely on deparser functionality to complement `pgsql-parser`.
 * [@pgsql/parser](https://www.npmjs.com/package/@pgsql/parser): Multi-version PostgreSQL parser with dynamic version selection at runtime, supporting PostgreSQL 15, 16, and 17 in a single package.
@@ -157,10 +164,10 @@ Built on the excellent work of several contributors:
 * [@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.
+* [libpg-query](https://github.com/constructive-io/libpg-query-node): The real PostgreSQL parser exposed for Node.js, used primarily in `pgsql-parser` for parsing and deparsing SQL queries.
 
 ## Disclaimer
 
 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/deparser/deparser.d.ts

@@ -10,31 +10,6 @@ export interface DeparserOptions {
     functionDelimiterFallback?: string;
     pretty?: boolean;
 }
-/**
- * Deparser - Converts PostgreSQL AST nodes back to SQL strings
- *
- * Entry Points:
- * 1. ParseResult (from libpg-query) - The complete parse result
- *    Structure: { version: number, stmts: RawStmt[] }
- *    Note: stmts is "repeated RawStmt" in protobuf, so array contains RawStmt
- *    objects inline (not wrapped as { RawStmt: ... } nodes)
- *    Example: { version: 170004, stmts: [{ stmt: {...}, stmt_len: 32 }] }
- *
- * 2. Wrapped ParseResult - When explicitly wrapped as a Node
- *    Structure: { ParseResult: { version: number, stmts: RawStmt[] } }
- *
- * 3. Wrapped RawStmt - When explicitly wrapped as a Node
- *    Structure: { RawStmt: { stmt: Node, stmt_len?: number } }
- *
- * 4. Array of Nodes - Multiple statements to deparse
- *    Can be: Node[] (e.g., SelectStmt, InsertStmt, etc.)
- *
- * 5. Single Node - Individual statement node
- *    Example: { SelectStmt: {...} }, { InsertStmt: {...} }, etc.
- *
- * The deparser automatically detects bare ParseResult objects for backward
- * compatibility and wraps them internally for consistent processing.
- */
 export declare class Deparser implements DeparserVisitor {
     private tree;
     private options;
@@ -58,6 +33,11 @@ export declare class Deparser implements DeparserVisitor {
      * @returns The delimiter to use
      */
     private getFunctionDelimiter;
+    /**
+     * Maps ObjectType enum values to their corresponding SQL keywords
+     * Used by AlterOwnerStmt, AlterObjectSchemaStmt, and other statements that need object type keywords
+     */
+    private getObjectTypeKeyword;
     deparse(node: any, context?: DeparserContext): string | null;
     visit(node: any, context?: DeparserContext): string;
     getNodeType(node: any): string;
@@ -74,12 +54,18 @@ export declare class Deparser implements DeparserVisitor {
     visitBetweenRange(rexpr: any, context: DeparserContext): string;
     InsertStmt(node: any, context: DeparserContext): string;
     UpdateStmt(node: any, context: DeparserContext): string;
+    formatUpdateAssignments(targets: any[], context: DeparserContext): string;
     DeleteStmt(node: any, context: DeparserContext): string;
     WithClause(node: any, context: DeparserContext): string;
     ResTarget(node: any, context: DeparserContext): string;
+    ATAlterConstraint(node: any, context: DeparserContext): string;
+    deparseKeyAttrs(attrs: any, withPeriod: boolean | undefined, context: DeparserContext): string;
+    ReturningClause(node: any, context: DeparserContext): string;
+    ReturningOption(node: any, context: DeparserContext): string;
     deparseReturningList(list: any, context: DeparserContext): string;
     BoolExpr(node: any, context: DeparserContext): string;
     FuncCall(node: any, context: DeparserContext): string;
+    formatOverClause(over: any, context: DeparserContext): string;
     FuncExpr(node: any, context: DeparserContext): string;
     A_Const(node: any, context: DeparserContext): string;
     ColumnRef(node: any, context: DeparserContext): string;
@@ -101,8 +87,6 @@ export declare class Deparser implements DeparserVisitor {
     CollateClause(node: any, context: DeparserContext): string;
     BooleanTest(node: any, context: DeparserContext): string;
     NullTest(node: any, context: DeparserContext): string;
-    private static readonly RESERVED_WORDS;
-    private static needsQuotes;
     quoteIfNeeded(value: string): string;
     preserveOperatorDefElemCase(defName: string): string;
     String(node: any, context: DeparserContext): string;
@@ -118,10 +102,13 @@ export declare class Deparser implements DeparserVisitor {
     SubLink(node: any, context: DeparserContext): string;
     CaseWhen(node: any, context: DeparserContext): string;
     WindowDef(node: any, context: DeparserContext): string;
+    formatIdentityColumnOptions(def: any, context: DeparserContext): string;
+    needsBExprParens(node: any): boolean;
     formatWindowFrame(node: any, context: DeparserContext): string | null;
     SortBy(node: any, context: DeparserContext): string;
     GroupingSet(node: any, context: DeparserContext): string;
     CommonTableExpr(node: any, context: DeparserContext): string;
+    formatAexprConst(node: any, context: DeparserContext): string;
     ParamRef(node: any, context: DeparserContext): string;
     LockingClause(node: any, context: DeparserContext): string;
     MinMaxExpr(node: any, context: DeparserContext): string;
@@ -172,6 +159,7 @@ export declare class Deparser implements DeparserVisitor {
     AlterTableSpaceOptionsStmt(node: any, context: DeparserContext): string;
     CreateExtensionStmt(node: any, context: DeparserContext): string;
     AlterExtensionStmt(node: any, context: DeparserContext): string;
+    AlterExtensionContentsStmt(node: any, context: DeparserContext): string;
     CreateFdwStmt(node: any, context: DeparserContext): string;
     SetOperationStmt(node: any, context: DeparserContext): string;
     ReplicaIdentityStmt(node: any, context: DeparserContext): string;
@@ -186,6 +174,8 @@ export declare class Deparser implements DeparserVisitor {
     CheckPointStmt(node: any, context: DeparserContext): string;
     LoadStmt(node: any, context: DeparserContext): string;
     DiscardStmt(node: any, context: DeparserContext): string;
+    /** `schema.op` for an operator name list: schema parts quoted, the operator symbol as is. */
+    private qualifiedOperatorName;
     CommentStmt(node: any, context: DeparserContext): string;
     LockStmt(node: any, context: DeparserContext): string;
     CreatePolicyStmt(node: any, context: DeparserContext): string;
@@ -245,6 +235,8 @@ export declare class Deparser implements DeparserVisitor {
     CreateOpFamilyStmt(node: any, context: DeparserContext): string;
     AlterOpFamilyStmt(node: any, context: DeparserContext): string;
     MergeStmt(node: any, context: DeparserContext): string;
+    MergeSupportFunc(node: any, context: DeparserContext): string;
+    MergeWhenClause(node: any, context: DeparserContext): string;
     AlterTableMoveAllStmt(node: any, context: DeparserContext): string;
     CreateSeqStmt(node: any, context: DeparserContext): string;
     AlterSeqStmt(node: any, context: DeparserContext): string;
@@ -272,11 +264,29 @@ export declare class Deparser implements DeparserVisitor {
     OnConflictExpr(node: any, context: DeparserContext): string;
     ScanToken(node: any, context: DeparserContext): string;
     CreateOpClassItem(node: any, context: DeparserContext): string;
+    private quoteDefElemArg;
+    private formatOptionValue;
     Var(node: any, context: DeparserContext): string;
     TableFunc(node: any, context: DeparserContext): string;
     RangeTableFunc(node: any, context: DeparserContext): string;
+    private formatXmlTableExpr;
     RangeTableFuncCol(node: any, context: DeparserContext): string;
+    formatJsonFormat(format: any): string | null;
+    formatJsonOutput(output: any, context: DeparserContext): string | null;
+    formatJsonNullClause(absentOnNull: boolean | undefined): string;
+    formatJsonUniqueClause(unique: boolean | undefined): string | null;
+    JsonValueExpr(node: any, context: DeparserContext): string;
+    JsonKeyValue(node: any, context: DeparserContext): string;
+    JsonObjectConstructor(node: any, context: DeparserContext): string;
+    JsonArrayConstructor(node: any, context: DeparserContext): string;
     JsonArrayQueryConstructor(node: any, context: DeparserContext): string;
+    formatJsonAggSuffix(ctor: any, context: DeparserContext): string;
+    JsonObjectAgg(node: any, context: DeparserContext): string;
+    JsonArrayAgg(node: any, context: DeparserContext): string;
+    JsonParseExpr(node: any, context: DeparserContext): string;
+    JsonScalarExpr(node: any, context: DeparserContext): string;
+    JsonSerializeExpr(node: any, context: DeparserContext): string;
+    JsonIsPredicate(node: any, context: DeparserContext): string;
     RangeFunction(node: any, context: DeparserContext): string;
     XmlExpr(node: any, context: DeparserContext): string;
     schemaname(node: any, context: DeparserContext): string;
@@ -298,5 +308,4 @@ export declare class Deparser implements DeparserVisitor {
     AlterObjectSchemaStmt(node: any, context: DeparserContext): string;
     AlterRoleSetStmt(node: any, context: DeparserContext): string;
     CreateForeignTableStmt(node: any, context: DeparserContext): string;
-    private containsMultilineStringLiteral;
 }