Feat/runtime schema

packages/cli/README.md

@@ -100,6 +100,26 @@ pg-proto-parser protogen --protoUrl <URL to proto file> \
 | `--help`, `-h`          | Show this help message.                                                             |               |
 | `--version`, `-v`       | Show the version number.                                                            |               |
 
+### runtime-schema
+
+Generate runtime schema for PostgreSQL AST nodes:
+
+```bash
+pg-proto-parser runtime-schema --inFile <path-to-proto> --outDir <output-directory> \
+                               [--format <json|typescript>] [--filename <filename>]
+```
+
+#### Options for runtime-schema
+
+| Option              | Description                                                                         | Default Value |
+|---------------------|-------------------------------------------------------------------------------------|---------------|
+| `--inFile`          | Path to the `.proto` file to be parsed.                                             | *Required*    |
+| `--outDir`          | Directory to save the generated runtime schema files.                               | *Required*    |
+| `--format`          | Output format for runtime schema ('json' or 'typescript').                          | `json`        |
+| `--filename`        | Filename for the runtime schema file (without extension).                           | `runtime-schema` |
+| `--help`, `-h`      | Show this help message and exit.                                                   |               |
+| `--version`, `-v`   | Show the version number and exit.                                                  |               |
+
 
 ## Related
 

packages/cli/src/commands/index.ts

@@ -3,9 +3,11 @@ import { ParsedArgs } from 'minimist';
 
 import { commands as codegen } from './codegen';
 import { commands as protogen } from './protogen';
+import { commands as runtimeSchema } from './runtime-schema';
 
 import { help as codegenHelp } from './codegen/cli';
 import { help as protogenHelp } from './protogen/cli';
+import { help as runtimeSchemaHelp } from './runtime-schema/cli';
 
 export const commands = async (argv: Partial<ParsedArgs>, prompter: Inquirerer, _options: CLIOptions) => {
   let command;
@@ -21,6 +23,7 @@ export const commands = async (argv: Partial<ParsedArgs>, prompter: Inquirerer,
   if (argv.help || argv.h) {
     codegenHelp();
     protogenHelp();
+    runtimeSchemaHelp();
     process.exit(0);
   }
 
@@ -32,7 +35,8 @@ export const commands = async (argv: Partial<ParsedArgs>, prompter: Inquirerer,
       message: 'choose a command',
       options: [
         'protogen',
-        'codegen'
+        'codegen',
+        'runtime-schema'
       ]
     }
   ];
@@ -54,11 +58,15 @@ export const commands = async (argv: Partial<ParsedArgs>, prompter: Inquirerer,
         argv = await codegen(argv, prompter, _options);
         break;
 
+    case 'runtime-schema':
+        argv = await runtimeSchema(argv, prompter, _options);
+        break;
+
     default:
       console.log(`No recognized command provided or no command given: ${command}`);
       break;
   }
 
   return argv;
 
-};
+};

packages/cli/src/commands/runtime-schema/cli.ts

@@ -0,0 +1,62 @@
+import { readAndParsePackageJson } from '../../package';
+import { PgProtoParser, PgProtoParserOptions, getOptionsWithDefaults } from 'pg-proto-parser';
+import o from 'nested-obj';
+
+export const help = (): void => {
+  console.log(`
+  Usage:
+
+  pg-proto-parser runtime-schema --inFile <path-to-proto> --outDir <output-directory>
+                                 [--format <json|typescript>] [--filename <filename>]
+
+  Options:
+
+  --help, -h                 Show this help message and exit.
+  --inFile                   Path to the .proto file to be parsed.
+  --outDir                   Directory to save the generated runtime schema files.
+  --format                   Output format for runtime schema ('json' or 'typescript').
+  --filename                 Filename for the runtime schema file (without extension).
+  --version, -v              Show the version number and exit.
+  `);
+}
+
+export default async (argv) => {
+
+  if (argv.help || argv.h) {
+    help();
+    process.exit(0);
+  }
+
+  if (argv.version || argv.v) {
+    console.log(`Version: ${readAndParsePackageJson().version}`);
+    process.exit(0);
+  }
+
+  if (!argv.inFile || !argv.outDir) {
+    console.log('Input Error: inFile and outDir are required!');
+    help();
+    process.exit(1);
+  }
+
+  const options: PgProtoParserOptions = getOptionsWithDefaults({
+    outDir: argv.outDir
+  });
+
+  o.set(options, 'runtimeSchema.enabled', true);
+  o.set(options, 'runtimeSchema.format', argv.format || 'json');
+  o.set(options, 'runtimeSchema.filename', argv.filename || 'runtime-schema');
+
+  o.set(options, 'types.enabled', false);
+  o.set(options, 'enums.enabled', false);
+  o.set(options, 'utils.astHelpers.enabled', false);
+  o.set(options, 'utils.enums.enabled', false);
+
+  console.log(`Generating runtime schema from ${argv.inFile}...`);
+  const parser = new PgProtoParser(argv.inFile, options);
+  await parser.write();
+
+  const extension = argv.format === 'typescript' ? 'ts' : 'json';
+  console.log(`Runtime schema generated successfully in ${argv.outDir}/${argv.filename || 'runtime-schema'}.${extension}`);
+
+  return argv;
+};

packages/cli/src/commands/runtime-schema/index.ts

@@ -0,0 +1,43 @@
+import { CLIOptions, Inquirerer } from 'inquirerer'
+import { ParsedArgs } from 'minimist';
+import cli, { help } from './cli';
+
+export const commands = async (argv: Partial<ParsedArgs>, prompter: Inquirerer, _options: CLIOptions) => {
+
+  if (argv.help || argv.h) {
+    help();
+    process.exit(0);
+  }
+
+  argv = await prompter.prompt(argv, [
+    {
+      type: 'text',
+      name: 'inFile',
+      message: 'provide inFile (./path/to/proto.proto):'
+    },
+    {
+      type: 'text',
+      name: 'outDir',
+      message: 'provide outDir (./outputDir):'
+    },
+    {
+      type: 'autocomplete',
+      name: 'format',
+      message: 'Choose output format:',
+      options: ['json', 'typescript'],
+      default: 'json',
+      useDefault: true
+    },
+    {
+      type: 'text',
+      name: 'filename',
+      message: 'Filename for runtime schema (without extension):',
+      default: 'runtime-schema',
+      useDefault: true
+    }
+  ]);
+
+  argv = await cli(argv);
+
+  return argv;
+};

packages/parser/README.md

@@ -82,6 +82,9 @@ This table describes the options available for `PgProtoParserOptions`, their fun
 | `enums.json.toIntOutFile`                | Output file name for the JSON mapping of enum names to integer values.                                                          | `'enums2int.json'`       |
 | `enums.json.toStrOutFile`                | Output file name for the JSON mapping of integer values to enum names.                                                          | `'enums2str.json'`       |
 | `enums.removeUndefinedAt0`               | Removes the initial `UNDEFINED` enum entry and adjusts the subsequent values by decrementing them.                             | `true`                   |
+| `runtimeSchema.enabled`                  | Whether to generate runtime schema for AST nodes with metadata about node types and field specifications.                      | `false`                  |
+| `runtimeSchema.filename`                 | Filename for the generated runtime schema file.                                                                                | `'runtime-schema'`       |
+| `runtimeSchema.format`                   | Output format for runtime schema generation ('json' or 'typescript').                                                         | `'json'`                 |
 | `includeHeader`                          | Includes a header at the top of generated TypeScript files to avoid manual manipulation which could cause issues in CI/CD pipelines. | `true`                |
 
 
@@ -165,4 +168,4 @@ ast.selectStmt({
 
 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.