traverse

Author: pyramation

.github/workflows/run-tests.yaml

@@ -26,4 +26,7 @@ jobs:
         run: cd ./packages/utils && yarn test
 
       - name: transform
-        run: cd ./packages/transform && yarn test
+        run: cd ./packages/transform && yarn test
+
+      - name: traverse
+        run: cd ./packages/traverse && yarn test

packages/traverse/README.md

@@ -1,5 +1,18 @@
 # @pgsql/traverse
 
+<p align="center" width="100%">
+  <img height="120" src="https://github.com/launchql/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>
+   <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>
+</p>
+
+
 PostgreSQL AST traversal utilities for pgsql-parser. This package provides a visitor pattern for traversing PostgreSQL Abstract Syntax Tree (AST) nodes, similar to Babel's traverse functionality but specifically designed for PostgreSQL AST structures.
 
 ## Installation
@@ -284,11 +297,17 @@ visit(ast, visitor);
 
 ## Related
 
-* [pgsql-parser](https://www.npmjs.com/package/pgsql-parser): The real PostgreSQL parser for Node.js
-* [pgsql-deparser](https://www.npmjs.com/package/pgsql-deparser): Convert PostgreSQL ASTs back into SQL queries
-* [@pgsql/types](https://www.npmjs.com/package/@pgsql/types): TypeScript type definitions for PostgreSQL AST nodes
-* [@pgsql/utils](https://www.npmjs.com/package/@pgsql/utils): Utility library for PostgreSQL AST node creation
+* [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.
+* [@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.
+* [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.
+
+## Disclaimer
 
-## License
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
 
-SEE LICENSE IN LICENSE
+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.

packages/traverse/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgsql/traverse",
-  "version": "17.7.6",
+  "version": "1.0.0",
   "author": "Dan Lynch <[email protected]>",
   "description": "PostgreSQL AST traversal utilities for pgsql-parser",
   "main": "index.js",
@@ -25,13 +25,14 @@
     "prepare": "npm run build",
     "build": "npm run clean && tsc && tsc -p tsconfig.esm.json && npm run copy",
     "build:dev": "npm run clean && tsc --declarationMap && tsc -p tsconfig.esm.json && npm run copy",
+    "build:proto": "ts-node scripts/pg-proto-parser",
     "lint": "eslint . --fix",
     "test": "jest",
     "test:watch": "jest --watch"
   },
   "dependencies": {
     "@pgsql/types": "^17.6.1",
-    "@pgsql/transform": "^17.7.1"
+    "pg-proto-parser": "^1.29.1"
   },
   "keywords": [
     "sql",

packages/traverse/scripts/pg-proto-parser.ts

@@ -0,0 +1,22 @@
+import { PgProtoParser, PgProtoParserOptions } from 'pg-proto-parser';
+import { resolve, join } from 'path';
+
+const versions = ['17'];
+const baseDir = resolve(join(__dirname, '../../../__fixtures__/proto'));
+
+for (const version of versions) {
+  const inFile = join(baseDir, `${version}-latest.proto`);
+  const outDir = resolve(join(__dirname, `../src/${version}`));
+
+  const options: PgProtoParserOptions = {
+    outDir,
+    runtimeSchema: {
+      enabled: true,
+      filename: 'runtime-schema.ts',
+      format: 'typescript'
+    }
+  };
+
+  const parser = new PgProtoParser(inFile, options);
+  parser.write();
+}