pgsql-deparser 16.0.0 → 16.1.1

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="120" src="https://github.com/constructive-io/pgsql-parser/assets/545047/6440fa7d-918b-4a3b-8d1b-755d85de8bea" />
 </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';
@@ -80,12 +80,17 @@ npm install pgsql-deparser
 While we highly recommend using PG17, for PostgreSQL versions 13-16, use the version-specific packages:
 
 ```sh
-npm install pgsql-deparser@v13  # PostgreSQL 13
-npm install pgsql-deparser@v14  # PostgreSQL 14
-npm install pgsql-deparser@v15  # PostgreSQL 15
-npm install pgsql-deparser@v16  # PostgreSQL 16
+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
 ```
 
+**Version Status:**
+- **PG17**: 🚀 Recommended (stable + modern AST)
+- **PG14-16**: ⚠️ Experimental (modern AST, hardening in progress)
+- **PG13**: Stable (legacy AST format)
+
 ## Options
 
 The deparser accepts optional configuration for formatting and output control:
@@ -94,7 +99,7 @@ The deparser accepts optional configuration for formatting and output control:
 import { deparseSync as deparse } from 'pgsql-deparser';
 
 const options = {
-  pretty: true,           // Enable pretty formatting (default: false)
+  pretty: true,           // Enable pretty formatting (default: true)
   newline: '\n',         // Newline character (default: '\n')
   tab: '  ',             // Tab/indentation character (default: '  ')
   semicolons: true       // Add semicolons to statements (default: true)
@@ -105,7 +110,7 @@ const sql = deparse(ast, options);
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
-| `pretty` | `boolean` | `false` | Enable pretty formatting with indentation and line breaks |
+| `pretty` | `boolean` | `true` | Enable pretty formatting with indentation and line breaks |
 | `newline` | `string` | `'\n'` | Character(s) used for line breaks |
 | `tab` | `string` | `'  '` | Character(s) used for indentation |
 | `semicolons` | `boolean` | `true` | Add semicolons to SQL statements |
@@ -126,7 +131,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`?
 
@@ -142,6 +147,8 @@ 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
 
 * [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.
@@ -150,11 +157,12 @@ Built on the excellent work of several contributors:
 * [@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.
+* [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

@@ -36,7 +36,6 @@ export interface DeparserOptions {
  * compatibility and wraps them internally for consistent processing.
  */
 export declare class Deparser implements DeparserVisitor {
-    private formatter;
     private tree;
     private options;
     constructor(tree: any | any[] | any, opts?: DeparserOptions);
@@ -59,6 +58,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;
@@ -67,10 +71,11 @@ export declare class Deparser implements DeparserVisitor {
     RawStmt(node: any, context: DeparserContext): string;
     SelectStmt(node: any, context: DeparserContext): string;
     A_Expr(node: any, context: DeparserContext): string;
-    deparseOperatorName(name: any): string;
+    deparseOperatorName(name: any, context: DeparserContext): string;
     private getOperatorPrecedence;
     private needsParentheses;
     private isComplexExpression;
+    private isComplexSelectTarget;
     visitBetweenRange(rexpr: any, context: DeparserContext): string;
     InsertStmt(node: any, context: DeparserContext): string;
     UpdateStmt(node: any, context: DeparserContext): string;
@@ -90,6 +95,7 @@ export declare class Deparser implements DeparserVisitor {
     formatTypeMods(typmods: any, context: DeparserContext): string | null;
     formatSingleTypeMod(typemod: number, typeName: string): string | null;
     getPgCatalogTypeName(typeName: string, size: string | null): string;
+    isPgCatalogType(typeName: string): boolean;
     A_ArrayExpr(node: any, context: DeparserContext): string;
     A_Indices(node: any, context: DeparserContext): string;
     A_Indirection(node: any, context: DeparserContext): string;
@@ -117,7 +123,7 @@ export declare class Deparser implements DeparserVisitor {
     SubLink(node: any, context: DeparserContext): string;
     CaseWhen(node: any, context: DeparserContext): string;
     WindowDef(node: any, context: DeparserContext): string;
-    formatWindowFrame(node: any): string | null;
+    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;
@@ -171,6 +177,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;