@pgsql/utils 13.10.0 → 13.12.0

package/README.md

@@ -19,10 +19,11 @@
 # Table of Contents
 
 1. [@pgsql/utils](#pgsql-utils)
-   - [Key Features](#key-features)
+   - [Features](#features)
 2. [Installation](#installation)
 3. [Usage](#usage)
    - [AST Node Creation](#ast-node-creation)
+     - [JSON AST](#json-ast)
      - [Select Statement](#select-statement)
      - [Creating Table Schemas Dynamically](#creating-table-schemas-dynamically)
    - [Enum Value Conversion](#enum-value-conversion)
@@ -53,6 +54,34 @@ npm install @pgsql/utils
 
 With the AST helper methods, creating complex SQL ASTs becomes straightforward and intuitive.
 
+#### JSON AST
+
+Explore the PostgreSQL Abstract Syntax Tree (AST) as JSON objects with ease using `@pgsql/utils`. Below is an example of how you can generate a JSON AST using TypeScript:
+
+```ts
+import ast from '@pgsql/utils';
+const selectStmt = ast.selectStmt({
+  targetList: [
+    ast.resTarget({
+      val: ast.columnRef({
+        fields: [ast.aStar()]
+      })
+    })
+  ],
+  fromClause: [
+    ast.rangeVar({
+      relname: 'some_amazing_table',
+      inh: true,
+      relpersistence: 'p'
+    })
+  ],
+  limitOption: 'LIMIT_OPTION_DEFAULT',
+  op: 'SETOP_NONE'
+});
+console.log(selectStmt);
+// Output: { "SelectStmt": { "targetList": [ { "ResTarget": { "val": { "ColumnRef": { "fields": [ { "A_Star": {} } ] } } } } ], "fromClause": [ { "RangeVar": { "relname": "some_amazing_table", "inh": true, "relpersistence": "p" } } ], "limitOption": "LIMIT_OPTION_DEFAULT", "op": "SETOP_NONE" } }
+```
+
 #### Select Statement
 
 ```ts
@@ -105,7 +134,7 @@ deparse(createStmt, {});
 #### Creating Table Schemas Dynamically
 
 ```ts
-// Example JSON with schema
+// Example JSON schema
 const schema = {
   "tableName": "users",
   "columns": [
@@ -118,7 +147,11 @@ const schema = {
 
 // Construct the CREATE TABLE statement
 const createStmt = ast.createStmt({
-  relation: ast.rangeVar({ relname: schema.tableName }),
+  relation: ast.rangeVar({ 
+    relname: schema.tableName,
+    inh: true,
+    relpersistence: 'p'
+  }).RangeVar as RangeVar, // special case due to PG AST
   tableElts: schema.columns.map(column => ast.columnDef({
     colname: column.name,
     typeName: ast.typeName({
@@ -126,23 +159,24 @@ const createStmt = ast.createStmt({
     }),
     constraints: column.constraints?.map(constraint =>
       ast.constraint({
-        contype: constraint === "PRIMARY KEY" ? "CONSTR_PRIMARY" : constraint === "UNIQUE" ? "CONSTR_UNIQUE" : "CONSTR_NOTNULL",
-        keys: [ast.string({ str: column.name })]
+        contype: constraint === "PRIMARY KEY" ? "CONSTR_PRIMARY" : constraint === "UNIQUE" ? "CONSTR_UNIQUE" : "CONSTR_NOTNULL"
       })
     )
   }))
 });
 
-// Assuming `deparse` function converts AST to SQL string
+// `deparse` function converts AST to SQL string
 const sql = deparse(createStmt, {});
+
 console.log(sql);
-//  CREATE TABLE  (
-//  	id int PRIMARY KEY ( id ),
-// 	  username string,
-// 	  email string UNIQUE ( email ),
-// 	  created_at timestamp NOT NULL ( created_at ) 
-// )
+// OUTPUT: 
 
+// CREATE TABLE users (
+//  id int PRIMARY KEY,
+// 	username text,
+// 	email text UNIQUE,
+// 	created_at timestamp NOT NULL 
+// )
 ```
 
 ### Enum Value Conversion
@@ -179,7 +213,7 @@ console.log(enumName); // Outputs 'SORTBY_ASC' if 1 corresponds to 'SORTBY_ASC'
 
 * [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/main/asts.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
-* This file was automatically generated by pg-proto-parser@1.20.0.
+* This file was automatically generated by pg-proto-parser@1.23.0.
 * 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/module/asts.js

@@ -1,5 +1,5 @@
 /**
-* This file was automatically generated by pg-proto-parser@1.20.0.
+* This file was automatically generated by pg-proto-parser@1.23.0.
 * 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgsql/utils",
-  "version": "13.10.0",
+  "version": "13.12.0",
   "description": "PostgreSQL AST utils for pgsql-parser",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "homepage": "https://github.com/launchql/pgsql-parser",
@@ -66,7 +66,7 @@
     "esprima": "4.0.1",
     "jest": "^29.5.0",
     "pg-proto-parser": "^1.20.0",
-    "pgsql-deparser": "^13.14.0",
+    "pgsql-deparser": "^13.16.0",
     "prettier": "^2.8.7",
     "rimraf": "5.0.5",
     "ts-jest": "^29.1.0",
@@ -74,8 +74,8 @@
     "typescript": "^5.0.4"
   },
   "dependencies": {
-    "@pgsql/types": "^13.8.0",
+    "@pgsql/types": "^13.10.0",
     "nested-obj": "0.0.1"
   },
-  "gitHead": "1358b34422c45c2111dc0b1764155a720ab7fd73"
+  "gitHead": "85346892e652a57e570562fdac7a768545113619"
 }

package/src/asts.ts

@@ -1,5 +1,5 @@
 /**
-* This file was automatically generated by pg-proto-parser@1.20.0.
+* This file was automatically generated by pg-proto-parser@1.23.0.
 * 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/src/wrapped.ts

@@ -1,5 +1,5 @@
 /**
-* This file was automatically generated by pg-proto-parser@1.20.0.
+* This file was automatically generated by pg-proto-parser@1.23.0.
 * 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/types/wrapped.d.ts

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