readmes and consistent interfaces

Author: pyramation

README.md

@@ -97,20 +97,21 @@ The `pgsql-deparser` module serializes ASTs to SQL in pure TypeScript, avoiding
 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 from '@pgsql/utils';
-import { deparse } from 'pgsql-deparser';
+import * as t from '@pgsql/utils';
+import { RangeVar, SelectStmt } from '@pgsql/types';
+import { deparseSync as deparse } from 'pgsql-deparser';
 
 // This could have been obtained from any JSON or AST, not necessarily @pgsql/utils
-const stmt = ast.selectStmt({
+const stmt: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
   targetList: [
-    ast.resTarget({
-      val: ast.columnRef({
-        fields: [ast.aStar()]
+    t.nodes.resTarget({
+      val: t.nodes.columnRef({
+        fields: [t.nodes.aStar()]
       })
     })
   ],
   fromClause: [
-    ast.rangeVar({
+    t.nodes.rangeVar({
       relname: 'some_table',
       inh: true,
       relpersistence: 'p'
@@ -120,11 +121,11 @@ const stmt = ast.selectStmt({
   op: 'SETOP_NONE'
 });
 
-// Modify the AST if needed
-stmt.SelectStmt.fromClause[0].RangeVar.relname = 'another_table';
+// Modify the AST if needed  
+(stmt.SelectStmt.fromClause[0] as {RangeVar: RangeVar}).RangeVar.relname = 'another_table';
 
 // Deparse the modified AST back to a SQL string
-console.log(deparse(stmts));
+console.log(deparse(stmt));
 
 // Output: SELECT * FROM another_table
 ```

packages/deparser/README.md

@@ -35,20 +35,21 @@ The `pgsql-deparser` module serializes ASTs to SQL in pure TypeScript, avoiding
 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';
+import * as t from '@pgsql/utils';
+import { RangeVar, SelectStmt } from '@pgsql/types';
+import { deparseSync as deparse } from 'pgsql-deparser';
 
 // This could have been obtained from any JSON or AST, not necessarily @pgsql/utils
-const stmt: SelectStmt = ast.selectStmt({
+const stmt: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
   targetList: [
-    ast.resTarget({
-      val: ast.columnRef({
-        fields: [ast.aStar()]
+    t.nodes.resTarget({
+      val: t.nodes.columnRef({
+        fields: [t.nodes.aStar()]
       })
     })
   ],
   fromClause: [
-    ast.rangeVar({
+    t.nodes.rangeVar({
       relname: 'some_table',
       inh: true,
       relpersistence: 'p'
@@ -58,11 +59,11 @@ const stmt: SelectStmt = ast.selectStmt({
   op: 'SETOP_NONE'
 });
 
-// Modify the AST if needed
-stmt.SelectStmt.fromClause[0].RangeVar.relname = 'another_table';
+// Modify the AST if needed  
+(stmt.SelectStmt.fromClause[0] as {RangeVar: RangeVar}).RangeVar.relname = 'another_table';
 
 // Deparse the modified AST back to a SQL string
-console.log(deparse(stmts));
+console.log(deparse(stmt));
 
 // Output: SELECT * FROM another_table
 ```

packages/deparser/package.json

@@ -49,6 +49,6 @@
     "libpg-query": "17.3.3"
   },
   "dependencies": {
-    "@pgsql/types": "^17.5.3"
+    "@pgsql/types": "^17.6.0"
   }
 }

packages/deparser/src/index.ts

@@ -1,4 +1,13 @@
 import { Deparser, DeparserOptions } from "./deparser";
 
-const deparse = Deparser.deparse;
-export { deparse, Deparser, DeparserOptions };
+const deparseMethod = Deparser.deparse;
+
+// Export the original sync version as deparseSync
+export const deparseSync = deparseMethod;
+
+// Create an async wrapper for deparse
+export const deparse = async (...args: Parameters<typeof deparseMethod>): Promise<ReturnType<typeof deparseMethod>> => {
+    return deparseMethod(...args);
+};
+
+export { Deparser, DeparserOptions };

packages/parser/README.md

@@ -33,27 +33,18 @@ npm install pgsql-parser
 
 The package exports both async and sync methods. Async methods handle initialization automatically, while sync methods require explicit initialization.
 
-⚠️ We recommend using `@pgsql/deparser` instead of `deparse` from `pgsql-parser`. The deparser package is more complete, supports sub-expressions, and doesn't require the WebAssembly module, making it lighter and more flexible for most use cases. It will soon be deprecated, in a minor version bump.
+⚠️ If you don't need the parser functionality, consider using the TS-only (no WASM, zero dependencies) [`pgsql-deparser`](https://github.com/launchql/pgsql-parser/tree/main/packages/deparser) for a super fast, lightweight deparser. Battle-tested with 23,000+ SQL statements 🚀
 
 ### Async Methods (Recommended)
 
 ```typescript
-import { parse, deparse, parseFunction } from 'pgsql-parser';
+import { parse, deparse } from 'pgsql-parser';
 
 // Parse SQL to AST
 const stmts = await parse('SELECT * FROM test_table');
 
 // Deparse AST back to SQL
 const sql = await deparse(stmts);
-
-// Parse PL/pgSQL functions
-const funcAst = await parseFunction(`
-  CREATE FUNCTION get_count() RETURNS integer AS $$
-  BEGIN
-    RETURN (SELECT COUNT(*) FROM users);
-  END;
-  $$ LANGUAGE plpgsql;
-`);
 ```
 
 ### Sync Methods
@@ -97,20 +88,21 @@ The `pgsql-deparser` module serializes ASTs to SQL in pure TypeScript, avoiding
 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 from '@pgsql/utils';
-import { deparse } from 'pgsql-deparser';
+import * as t from '@pgsql/utils';
+import { RangeVar, SelectStmt } from '@pgsql/types';
+import { deparseSync as deparse } from 'pgsql-deparser';
 
 // This could have been obtained from any JSON or AST, not necessarily @pgsql/utils
-const stmt = ast.selectStmt({
+const stmt: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
   targetList: [
-    ast.resTarget({
-      val: ast.columnRef({
-        fields: [ast.aStar()]
+    t.nodes.resTarget({
+      val: t.nodes.columnRef({
+        fields: [t.nodes.aStar()]
       })
     })
   ],
   fromClause: [
-    ast.rangeVar({
+    t.nodes.rangeVar({
       relname: 'some_table',
       inh: true,
       relpersistence: 'p'
@@ -120,11 +112,11 @@ const stmt = ast.selectStmt({
   op: 'SETOP_NONE'
 });
 
-// Modify the AST if needed
-stmt.SelectStmt.fromClause[0].RangeVar.relname = 'another_table';
+// Modify the AST if needed  
+(stmt.SelectStmt.fromClause[0] as {RangeVar: RangeVar}).RangeVar.relname = 'another_table';
 
 // Deparse the modified AST back to a SQL string
-console.log(deparse(stmts));
+console.log(deparse(stmt));
 
 // Output: SELECT * FROM another_table
 ```

packages/parser/package.json

@@ -42,8 +42,9 @@
     "database"
   ],
   "dependencies": {
-    "@pgsql/types": "^17.5.3",
-    "libpg-query": "17.3.3",
+    "@pgsql/types": "^17.6.0",
+    "libpg-query": "17.5.0",
+    "pgsql-deparser": "^17.6.2",
     "minimist": "^1.2.6"
   }
 }

packages/parser/src/index.ts

@@ -1,8 +1,7 @@
 export {
   parse as parse,
   parseSync as parseSync,
-  parsePlPgSQL as parseFunction,
-  deparseSync as deparseSync,
-  deparse as deparse,
   loadModule as loadModule
 } from 'libpg-query';
+
+export { deparse, deparseSync } from 'pgsql-deparser';

packages/utils/__test__/utils.test.ts

@@ -1,6 +1,6 @@
 import * as t from '../src';
 import { RangeVar, SelectStmt } from '@pgsql/types';
-import { deparse } from 'pgsql-deparser';
+import { deparseSync as deparse } from 'pgsql-deparser';
 
 it('simple SelectStmt', () => {
   const stmt: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
@@ -25,7 +25,7 @@ it('simple SelectStmt', () => {
   (stmt.SelectStmt.fromClause[0] as {RangeVar: RangeVar}).RangeVar.relname = 'another_table';
 
   expect(stmt).toMatchSnapshot();
-  expect(deparse(stmt, {})).toMatchSnapshot();
+  expect(deparse(stmt)).toMatchSnapshot();
 });
 
 it('SelectStmt with WHERE clause', () => {

packages/utils/package.json

@@ -35,7 +35,7 @@
     "pgsql-deparser": "^17.6.2"
   },
   "dependencies": {
-    "@pgsql/types": "^17.5.3",
+    "@pgsql/types": "^17.6.0",
     "nested-obj": "0.0.1"
   },
   "keywords": []

yarn.lock

@@ -1227,11 +1227,16 @@
     node-addon-api "^3.2.1"
     node-gyp-build "^4.3.0"
 
-"@pgsql/types@^17.0.0", "@pgsql/types@^17.5.3":
+"@pgsql/types@^17.0.0":
   version "17.5.3"
   resolved "https://registry.yarnpkg.com/@pgsql/types/-/types-17.5.3.tgz#b4a53ba71a1bf111de744d01fc49a4e1576f3e31"
   integrity sha512-lRPdKcipoKLoovXw6tVwg9gdqV1fIvfjzqFDY1UFsJa8I+/yaVrGWCtmE+CeWU5e+imXd7X3fTWs8N8bK3R+AQ==
 
+"@pgsql/types@^17.6.0":
+  version "17.6.0"
+  resolved "https://registry.yarnpkg.com/@pgsql/types/-/types-17.6.0.tgz#ea2511d8ebf24ee821968532184058d4ebf4ecaa"
+  integrity sha512-WGVIne1kFm3pIHiCkUWGbv7vlhxCRT+61UigsYejhmEsl4Iyf8d2CBnt9muhi571mfuwvtkeD0sxo5y8oj0ijQ==
+
 "@pkgjs/parseargs@^0.11.0":
   version "0.11.0"
   resolved "https://registry.yarnpkg.com/@pkgjs/parseargs/-/parseargs-0.11.0.tgz#a77ea742fab25775145434eb1d2328cf5013ac33"
@@ -4579,6 +4584,13 @@ [email protected]:
     "@launchql/protobufjs" "7.2.6"
     "@pgsql/types" "^17.0.0"
 
+[email protected]:
+  version "17.5.0"
+  resolved "https://registry.yarnpkg.com/libpg-query/-/libpg-query-17.5.0.tgz#1b60b950b5c8eae8dfed664a470c05f79f89634a"
+  integrity sha512-vFe0Lnneg/wIa5hsIIyJ2h1aExqLrn2qHVIC57bmyZE77Jk8G5S8qs7S94KYLJCk3i9TQZfkKTjViqJ+o6an4A==
+  dependencies:
+    "@pgsql/types" "^17.6.0"
+
 lines-and-columns@^1.1.6:
   version "1.2.4"
   resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632"