@tronsfey/openapi2cli 1.0.10

package/dist/templates/flat-commands.ts.hbs

@@ -0,0 +1,126 @@
+import { Command, Option } from 'commander';
+import chalk from 'chalk';
+import { createApiClient } from './lib/api-client';
+
+export function registerFlatCommands(program: Command): void {
+{{#each flatCommands}}
+  program
+    .command({{jsString name}})
+    .description({{jsString description}})
+{{#each aliases}}
+    .alias({{jsString this}})
+{{/each}}
+{{#each options}}
+{{#if enum}}
+    .addOption(new Option('{{optionFlag name required type}}', {{jsString description}}){{#if defaultValue}}.default({{jsString defaultValue}}){{/if}}.choices([{{#each enum}}{{jsString this}}{{#unless @last}}, {{/unless}}{{/each}}]))
+{{else}}
+{{#eq type "boolean"}}
+    .option('{{optionFlag name required type}}', {{jsString description}})
+{{else}}
+    .option('{{optionFlag name required type}}', {{jsString description}}{{#if defaultValue}}, {{jsString defaultValue}}{{/if}})
+{{/eq}}
+{{/if}}
+{{/each}}
+{{#if (subcommandHelpText this)}}
+    .addHelpText('after', {{subcommandHelpText this}})
+{{/if}}
+    .action(async (opts: Record<string, unknown>, cmd: Command) => {
+      const allOpts = cmd.optsWithGlobals<Record<string, unknown>>();
+      const endpoint = (allOpts['endpoint'] as string | undefined) ?? {{jsString ../structure.baseUrl}};
+      const format = (allOpts['format'] as string | undefined) ?? 'json';
+      const verbose = Boolean(allOpts['verbose']);
+      const allPages = Boolean(allOpts['allPages']);
+      const query = allOpts['query'] as string | undefined;
+      const client = createApiClient(endpoint);
+
+      // Separate body keys from path/query params
+      const bodyKeys = new Set<string>([{{#if requestBody}}{{#each requestBody.fields}}'{{optKey}}', {{/each}}'data'{{/if}}]);
+      const params: Record<string, string | undefined> = {};
+      for (const [k, v] of Object.entries(opts)) {
+        if (!bodyKeys.has(k)) params[k] = v as string | undefined;
+      }
+
+{{#if requestBody}}
+      // Assemble request body
+      let body: unknown;
+      const rawData = opts['data'] as string | undefined;
+      if (rawData) {
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
+        const { readFileSync } = require('fs') as typeof import('fs');
+        body = rawData.startsWith('@')
+          ? JSON.parse(readFileSync(rawData.slice(1), 'utf-8'))
+          : JSON.parse(rawData);
+{{#if (hasItems requestBody.fields)}}
+      } else {
+        const bodyObj: Record<string, unknown> = {};
+        {{#each requestBody.fields}}if (opts['{{optKey}}'] !== undefined) bodyObj[{{jsString name}}] = opts['{{optKey}}'];
+        {{/each}}if (Object.keys(bodyObj).length) body = bodyObj;
+{{/if}}
+      }
+{{/if}}
+
+      try {
+{{#eq streaming "sse"}}
+        // Server-Sent Events — stream events to stdout, one compact JSON line each
+        for await (const eventData of client.requestStream({
+          method: '{{method}}',
+          path: '{{path}}',
+          params,
+          verbose,
+        })) {
+          try {
+            let output: unknown = JSON.parse(eventData);
+            if (query) {
+              // eslint-disable-next-line @typescript-eslint/no-require-imports
+              const jmespath = require('jmespath') as { search: (d: unknown, e: string) => unknown };
+              output = jmespath.search(output, query);
+            }
+            process.stdout.write(JSON.stringify(output) + '\n');
+          } catch {
+            process.stdout.write(eventData + '\n');
+          }
+        }
+{{else}}
+        const result = await client.request({
+          method: '{{method}}',
+          path: '{{path}}',
+          params,
+          {{#if requestBody}}body,{{/if}}
+          verbose,
+          allPages,
+        });
+        formatOutput(result, format, query);
+{{/eq}}
+      } catch (err: unknown) {
+        const message = err instanceof Error ? err.message : String(err);
+        console.error(chalk.red('Error:'), message);
+        process.exit(1);
+      }
+    });
+
+{{/each}}
+}
+
+function formatOutput(data: unknown, format: string, query?: string): void {
+  let output = data;
+  if (query) {
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    const jmespath = require('jmespath') as { search: (d: unknown, e: string) => unknown };
+    output = jmespath.search(data, query);
+  }
+  if (format === 'json') {
+    console.log(JSON.stringify(output, null, 2));
+  } else if (format === 'yaml') {
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    const yaml = require('yaml') as { stringify: (d: unknown) => string };
+    process.stdout.write(yaml.stringify(output));
+  } else if (format === 'table') {
+    if (Array.isArray(output)) {
+      console.table(output);
+    } else {
+      console.log(JSON.stringify(output, null, 2));
+    }
+  } else {
+    console.log(JSON.stringify(output, null, 2));
+  }
+}

package/dist/templates/index.ts.hbs

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import chalk from 'chalk';
+{{#each structure.groups}}
+import { register{{pascalCase name}}Commands } from './commands/{{name}}';
+{{/each}}
+{{#if (hasItems structure.flatCommands)}}
+import { registerFlatCommands } from './flat-commands';
+{{/if}}
+
+const program = new Command();
+
+program
+  .name({{jsString structure.name}})
+  .description({{jsString structure.description}})
+  .version({{jsString structure.version}});
+
+// Global options
+program
+  .option('--endpoint <url>', 'Override the base API URL', {{jsString structure.baseUrl}})
+  .addOption(new (require('commander').Option)('--format <format>', 'Output format').choices(['json', 'yaml', 'table']).default('json'))
+  .option('--verbose', 'Enable verbose request logging')
+  .option('--query [expr]', 'JMESPath expression to filter the response')
+  .option('--all-pages', 'Auto-follow Link rel="next" headers to collect all pages');
+
+// Register tag-level command groups
+{{#each structure.groups}}
+register{{pascalCase name}}Commands(program);
+{{/each}}
+{{#if (hasItems structure.flatCommands)}}
+// Register untagged operations directly on the program
+registerFlatCommands(program);
+{{/if}}
+
+program.parseAsync(process.argv).catch((err: Error) => {
+  console.error(chalk.red('Error:'), err.message);
+  process.exit(1);
+});

package/dist/templates/package.json.hbs

@@ -0,0 +1,31 @@
+{
+  "name": "{{structure.name}}",
+  "version": "1.0.0",
+  "description": {{jsString structure.description}},
+  "main": "dist/index.js",
+  "bin": {
+    "{{structure.name}}": "./bin/{{structure.name}}"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "dev": "ts-node src/index.ts"
+  },
+  "dependencies": {
+    "eventsource-parser": "^3.0.6",
+    "axios": "^1.7.9",
+    "chalk": "^4.1.2",
+    "commander": "^12.1.0",
+    "jmespath": "^0.16.0",
+    "ora": "^5.4.1",
+    "yaml": "^2.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.3"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/dist/templates/tsconfig.json.hbs

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"],
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "sourceMap": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

package/dist/types/index.d.ts

@@ -0,0 +1,104 @@
+export type HTTPMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head' | 'options';
+export interface CLIConfig {
+    oas: string;
+    name: string;
+    output: string;
+}
+export interface Option {
+    name: string;
+    alias?: string;
+    description: string;
+    required: boolean;
+    type: 'string' | 'number' | 'boolean';
+    defaultValue?: string | number | boolean;
+    enum?: string[];
+}
+export interface Parameter {
+    name: string;
+    in: 'query' | 'path' | 'header' | 'cookie';
+    description: string;
+    required: boolean;
+    schema: {
+        type: string;
+        enum?: string[];
+        default?: unknown;
+    };
+}
+export interface RequestBodyField {
+    name: string;
+    optKey: string;
+    type: string;
+    required: boolean;
+    description: string;
+    enum?: string[];
+}
+export interface ResponseField {
+    name: string;
+    type: string;
+    description: string;
+}
+export interface RequestBody {
+    description: string;
+    required: boolean;
+    contentType: string;
+    schema: Record<string, unknown>;
+    fields: RequestBodyField[];
+}
+export interface APIResponse {
+    statusCode: string;
+    description: string;
+    contentType?: string;
+    fields: ResponseField[];
+    isArray: boolean;
+}
+export interface SubCommand {
+    name: string;
+    description: string;
+    method: HTTPMethod;
+    path: string;
+    parameters: Parameter[];
+    requestBody?: RequestBody;
+    responses: Record<string, APIResponse>;
+    options: Option[];
+    securitySchemes: string[];
+    aliases: string[];
+    streaming?: 'sse';
+}
+export interface CommandGroup {
+    name: string;
+    description: string;
+    subcommands: SubCommand[];
+}
+/** Body field name → environment variable mapping for dynamic token providers. */
+export interface TokenEnvVar {
+    name: string;
+    env: string;
+}
+export type AuthType = 'bearer' | 'apiKey' | 'basic' | 'oauth2-cc' | 'dynamic' | 'none';
+export interface AuthConfig {
+    type: AuthType;
+    envVar: string;
+    headerName?: string;
+    tokenUrl?: string;
+    clientIdEnvVar?: string;
+    clientSecretEnvVar?: string;
+    scopesEnvVar?: string;
+    tokenEnvVars?: TokenEnvVar[];
+}
+export interface CommandStructure {
+    name: string;
+    description: string;
+    version: string;
+    baseUrl: string;
+    groups: CommandGroup[];
+    flatCommands: SubCommand[];
+    globalOptions: Option[];
+    authConfig: AuthConfig;
+    allAuthSchemes: string[];
+    warnings: string[];
+}
+export interface GeneratedFile {
+    relativePath: string;
+    content: string;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;AAE1F,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IACtC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IACzC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC3C,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;CACH;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACvC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,CAAC,EAAE,KAAK,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,kFAAkF;AAClF,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,QAAQ,GAChB,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,WAAW,GACX,SAAS,GACT,MAAM,CAAC;AAEX,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,YAAY,EAAE,UAAU,EAAE,CAAC;IAC3B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,UAAU,EAAE,UAAU,CAAC;IACvB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@tronsfey/openapi2cli",
+  "version": "1.0.10",
+  "description": "Generate a fully typed Commander.js CLI project from an OpenAPI 3.x specification",
+  "main": "dist/index.js",
+  "bin": {
+    "openapi2cli": "./bin/openapi2cli"
+  },
+  "files": [
+    "dist/",
+    "bin/",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "openapi",
+    "cli",
+    "generator",
+    "commander",
+    "typescript",
+    "swagger",
+    "codegen",
+    "oas3",
+    "rest"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tronsfey928/openapi2cli.git"
+  },
+  "homepage": "https://github.com/tronsfey928/openapi2cli#readme",
+  "bugs": {
+    "url": "https://github.com/tronsfey928/openapi2cli/issues"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsc && copyfiles -u 1 \"src/templates/**/*.hbs\" dist/",
+    "dev": "ts-node src/index.ts",
+    "start": "node dist/index.js",
+    "test": "jest --testPathIgnorePatterns=tests/integration",
+    "test:e2e": "jest tests/integration/express-server.test.ts --testTimeout=180000",
+    "test:integration": "jest tests/integration/github.test.ts --testTimeout=180000",
+    "test:all": "jest --testTimeout=180000",
+    "generate:examples": "ts-node scripts/generate-example.ts",
+    "test:coverage": "jest --coverage --testPathIgnorePatterns=tests/integration",
+    "lint": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run lint && npm test && npm run build && npm run generate:examples && npm run test:e2e"
+  },
+  "dependencies": {
+    "@apidevtools/swagger-parser": "^10.1.0",
+    "axios": "^1.7.9",
+    "chalk": "^4.1.2",
+    "commander": "^12.1.0",
+    "fs-extra": "^11.2.0",
+    "handlebars": "^4.7.8",
+    "lodash": "^4.17.23",
+    "openapi-types": "^12.1.3",
+    "ora": "^5.4.1",
+    "pinyin-pro": "^3.28.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/fs-extra": "^11.0.4",
+    "express": "^4.21.2",
+    "@types/jest": "^29.5.14",
+    "@types/lodash": "^4.17.16",
+    "@types/node": "^22.0.0",
+    "copyfiles": "^2.4.1",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.4.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.3"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "testMatch": [
+      "**/tests/**/*.test.ts"
+    ],
+    "collectCoverageFrom": [
+      "src/**/*.ts"
+    ]
+  }
+}