pgsql-deparser 13.13.0 → 13.15.0

package/README.md

@@ -30,25 +30,41 @@ npm install pgsql-deparser
 
 ## Deparser Example
 
-The deparser functionality is provided as a standalone module, enabling you to serialize AST (Abstract Syntax Tree) objects back to SQL statements without the need for the full parsing engine. This separation is particularly beneficial for environments where the native dependencies of the full parser are problematic or unnecessary. For instance, if you already have an AST representation of your SQL query and merely need to convert it back to a SQL string, you can use the pgsql-deparser module directly. This module is implemented in pure TypeScript, avoiding the need for native bindings and thereby simplifying deployment and compatibility across different environments.
+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:
+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`:
 
 ```ts
+import ast, { SelectStmt } from '@pgsql/utils';
 import { deparse } from 'pgsql-deparser';
 
-// Assuming `stmts` is an AST object for the query 'SELECT * FROM test_table'
-// This could have been obtained from any source, not necessarily the pgsql-parser
-const stmts = getAstFromSomewhere();
-
-// Modify the AST as needed
-stmts[0].RawStmt.stmt.SelectStmt.fromClause[0].RangeVar.relname = 'another_table';
+// This could have been obtained from any JSON or AST, not necessarily @pgsql/utils
+const stmt: SelectStmt = ast.selectStmt({
+  targetList: [
+    ast.resTarget({
+      val: ast.columnRef({
+        fields: [ast.aStar()]
+      })
+    })
+  ],
+  fromClause: [
+    ast.rangeVar({
+      relname: 'some_table',
+      inh: true,
+      relpersistence: 'p'
+    })
+  ],
+  limitOption: 'LIMIT_OPTION_DEFAULT',
+  op: 'SETOP_NONE'
+});
+
+// Modify the AST if needed
+stmt.SelectStmt.fromClause[0].RangeVar.relname = 'another_table';
 
 // Deparse the modified AST back to a SQL string
 console.log(deparse(stmts));
 
-// Output: SELECT * FROM "another_table"
-
+// Output: SELECT * FROM another_table
 ```
 
 ## Why Use `pgsql-deparser`?
@@ -73,7 +89,7 @@ Our latest is built with `13-latest` branch from libpg_query
 
 * [pgsql-parser](https://github.com/launchql/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://github.com/launchql/pgsql-parser/tree/main/packages/deparser): A streamlined tool designed for converting PostgreSQL ASTs back into SQL queries, focusing solely on deparser functionality to complement `pgsql-parser`.
-* [pgsql-enums](https://github.com/launchql/pgsql-parser/tree/main/packages/enums-json): A utility package offering easy access to PostgreSQL enumeration types in JSON format, aiding in string and integer conversions of enums used within ASTs to compliment `pgsql-parser`
+* [pgsql-enums](https://github.com/launchql/pgsql-parser/tree/main/packages/pgsql-enums): A utility package offering easy access to PostgreSQL enumeration types in JSON format, aiding in string and integer conversions of enums used within ASTs to compliment `pgsql-parser`
 * [@pgsql/enums](https://github.com/launchql/pgsql-parser/tree/main/packages/enums): Provides PostgreSQL AST enums in TypeScript, enhancing type safety and usability in projects interacting with PostgreSQL AST nodes.
 * [@pgsql/types](https://github.com/launchql/pgsql-parser/tree/main/packages/types): Offers TypeScript type definitions for PostgreSQL AST nodes, facilitating type-safe construction, analysis, and manipulation of ASTs.
 * [@pgsql/utils](https://github.com/launchql/pgsql-parser/tree/main/packages/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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pgsql-deparser",
-  "version": "13.13.0",
+  "version": "13.15.0",
   "description": "PostgreSQL AST Deparser",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "homepage": "https://github.com/launchql/pgsql-parser",
@@ -74,7 +74,7 @@
     "esprima": "4.0.1",
     "glob": "8.0.3",
     "jest": "^29.7.0",
-    "pgsql-parser": "^13.14.0",
+    "pgsql-parser": "^13.16.0",
     "prettier": "^2.8.7",
     "rimraf": "5.0.5",
     "ts-jest": "^29.1.0",
@@ -82,9 +82,8 @@
     "typescript": "^5.0.4"
   },
   "dependencies": {
-    "@pgsql/types": "^13.8.0",
+    "@pgsql/types": "^13.9.0",
     "dotty": "^0.1.0",
-    "pgsql-enums": "^13.9.0"
-  },
-  "gitHead": "453a53729df906c6eb5a095dc0fa985babab4d51"
+    "pgsql-enums": "^13.10.0"
+  }
 }