@hey-api/openapi-ts 0.37.3 → 0.38.1

package/README.md

@@ -6,12 +6,12 @@
 
 ## Features
 
-- Generate TypeScript clients from OpenAPI v2.0, v3.0, and v3.1 specifications
-- Support JSON or YAML input files
-- Handle external references using [JSON Schema $Ref Parser](https://github.com/APIDevTools/json-schema-ref-parser/)
-- Generate Fetch, Node-Fetch, Axios, Angular, or XHR HTTP clients
-- Can be used with CLI, Node.js, or npx
-- Abortable requests through cancellable promise pattern
+-   Generate TypeScript clients from OpenAPI v2.0, v3.0, and v3.1 specifications
+-   Support JSON or YAML input files
+-   Handle external references using [JSON Schema $Ref Parser](https://github.com/APIDevTools/json-schema-ref-parser/)
+-   Generate Fetch, Node-Fetch, Axios, Angular, or XHR HTTP clients
+-   Can be used with CLI, Node.js, or npx
+-   Abortable requests through cancellable promise pattern
 
 ## Migrating from OpenAPI Typescript Codegen?
 

package/bin/index.js

@@ -2,8 +2,10 @@
 
 'use strict';
 
-import { readFileSync } from 'node:fs';
+import { readFileSync, writeFileSync } from 'node:fs';
+import path from 'node:path';
 
+import camelCase from 'camelcase';
 import { program } from 'commander';
 
 const pkg = JSON.parse(readFileSync(new URL('../package.json', import.meta.url)).toString());
@@ -17,6 +19,7 @@ const params = program
     .option('-c, --client <value>', 'HTTP client to generate [angular, axios, fetch, node, xhr]')
     .option('-d, --debug', 'Run in debug mode?')
     .option('--base [value]', 'Manually set base in OpenAPI config instead of inferring from server value')
+    .option('--dry-run [value]', 'Skip writing files to disk?')
     .option('--enums <value>', 'Export enum definitions (javascript, typescript)')
     .option('--exportCore [value]', 'Write core files to disk')
     .option('--exportModels [value]', 'Write models to disk')
@@ -31,7 +34,6 @@ const params = program
     .option('--serviceResponse [value]', 'Define shape of returned value from service calls')
     .option('--useDateType [value]', 'Output Date instead of string for the format "date-time" in the models')
     .option('--useOptions [value]', 'Use options instead of arguments')
-    .option('--write [value]', 'Write files to disk? (used for testing)')
     .parse(process.argv)
     .opts();
 
@@ -45,38 +47,44 @@ const stringToBoolean = value => {
     return value;
 };
 
-const processParams = (obj, keys) => {
-    const result = {};
-    for (const key of keys) {
+const processParams = (obj, booleanKeys) => {
+    for (const key of booleanKeys) {
         const value = obj[key];
         if (typeof value === 'string') {
-            result[key] = stringToBoolean(value);
+            const parsedValue = stringToBoolean(value);
+            delete obj[key];
+            obj[camelCase(key)] = parsedValue;
         }
     }
-    return result;
+    return obj;
 };
 
 async function start() {
+    let userConfig;
     try {
         const { createClient } = await import(new URL('../dist/node/index.js', import.meta.url));
-        await createClient({
-            ...params,
-            ...processParams(params, [
-                'exportCore',
-                'exportModels',
-                'exportServices',
-                'format',
-                'lint',
-                'operationId',
-                'schemas',
-                'useDateType',
-                'useOptions',
-                'write',
-            ]),
-        });
+        userConfig = processParams(params, [
+            'dryRun',
+            'exportCore',
+            'exportModels',
+            'exportServices',
+            'format',
+            'lint',
+            'operationId',
+            'schemas',
+            'useDateType',
+            'useOptions',
+        ]);
+        await createClient(userConfig);
         process.exit(0);
     } catch (error) {
-        console.error(error);
+        if (!userConfig.dryRun) {
+            const logName = `openapi-ts-error-${Date.now()}.log`;
+            const logPath = path.resolve(process.cwd(), logName);
+            writeFileSync(logPath, `${error.message}\n${error.stack}`);
+            console.error(`🔥 Unexpected error occurred. Log saved to ${logPath}`);
+        }
+        console.error(`🔥 Unexpected error occurred. ${error.message}`);
         process.exit(1);
     }
 }

package/dist/node/index.d.ts

@@ -1,109 +1,6 @@
-interface UserConfig {
-    /**
-     * Manually set base in OpenAPI config instead of inferring from server value
-     */
-    base?: string;
-    /**
-     * The selected HTTP client (fetch, xhr, node or axios)
-     * @default 'fetch'
-     */
-    client?: 'angular' | 'axios' | 'fetch' | 'node' | 'xhr';
-    /**
-     * Run in debug mode?
-     * @default false
-     */
-    debug?: boolean;
-    /**
-     * Export enum definitions?
-     * @default false
-     */
-    enums?: 'javascript' | 'typescript' | false;
-    /**
-     * Generate an experimental build?
-     * @default false
-     */
-    experimental?: boolean;
-    /**
-     * Generate core client classes?
-     * @default true
-     */
-    exportCore?: boolean;
-    /**
-     * Generate models?
-     * @default true
-     */
-    exportModels?: boolean | string;
-    /**
-     * Generate services?
-     * @default true
-     */
-    exportServices?: boolean | string;
-    /**
-     * Process output folder with formatter?
-     * @default true
-     */
-    format?: boolean;
-    /**
-     * The relative location of the OpenAPI spec
-     */
-    input: string | Record<string, unknown>;
-    /**
-     * Process output folder with linter?
-     * @default false
-     */
-    lint?: boolean;
-    /**
-     * Custom client class name
-     */
-    name?: string;
-    /**
-     * Use operation ID to generate operation names?
-     * @default true
-     */
-    operationId?: boolean;
-    /**
-     * The relative location of the output directory
-     */
-    output: string;
-    /**
-     * Service name postfix
-     * @default 'Service'
-     */
-    postfixServices?: string;
-    /**
-     * Path to custom request file
-     */
-    request?: string;
-    /**
-     * Export JSON schemas?
-     * @default true
-     */
-    schemas?: boolean;
-    /**
-     * Define shape of returned value from service calls
-     * @default 'body'
-     */
-    serviceResponse?: 'body' | 'response';
-    /**
-     * Output Date instead of string for the format "date-time" in the models
-     * @default false
-     */
-    useDateType?: boolean;
-    /**
-     * Use options or arguments functions
-     * @default true
-     */
-    useOptions?: boolean;
-    /**
-     * Write the files to disk (true or false)
-     * @default true
-     */
-    write?: boolean;
-}
-
 interface Enum {
-    'x-enum-description'?: string;
-    'x-enum-varname'?: string;
+    customDescription?: string;
+    customName?: string;
     description?: string;
     value: string | number;
 }
@@ -201,6 +98,104 @@ interface Client {
     version: string;
 }
 
+interface UserConfig {
+    /**
+     * Manually set base in OpenAPI config instead of inferring from server value
+     */
+    base?: string;
+    /**
+     * The selected HTTP client (fetch, xhr, node or axios)
+     * @default 'fetch'
+     */
+    client?: 'angular' | 'axios' | 'fetch' | 'node' | 'xhr';
+    /**
+     * Run in debug mode?
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Skip writing files to disk?
+     * @default false
+     */
+    dryRun?: boolean;
+    /**
+     * Export enum definitions?
+     * @default false
+     */
+    enums?: 'javascript' | 'typescript' | false;
+    /**
+     * Generate core client classes?
+     * @default true
+     */
+    exportCore?: boolean;
+    /**
+     * Generate models?
+     * @default true
+     */
+    exportModels?: boolean | string;
+    /**
+     * Generate services?
+     * @default true
+     */
+    exportServices?: boolean | string;
+    /**
+     * Process output folder with formatter?
+     * @default true
+     */
+    format?: boolean;
+    /**
+     * The relative location of the OpenAPI spec
+     */
+    input: string | Record<string, unknown>;
+    /**
+     * Process output folder with linter?
+     * @default false
+     */
+    lint?: boolean;
+    /**
+     * Custom client class name
+     */
+    name?: string;
+    /**
+     * Use operation ID to generate operation names?
+     * @default true
+     */
+    operationId?: boolean;
+    /**
+     * The relative location of the output directory
+     */
+    output: string;
+    /**
+     * Service name postfix
+     * @default 'Service'
+     */
+    postfixServices?: string;
+    /**
+     * Path to custom request file
+     */
+    request?: string;
+    /**
+     * Export JSON schemas?
+     * @default true
+     */
+    schemas?: boolean;
+    /**
+     * Define shape of returned value from service calls
+     * @default 'body'
+     */
+    serviceResponse?: 'body' | 'response';
+    /**
+     * Output Date instead of string for the format "date-time" in the models
+     * @default false
+     */
+    useDateType?: boolean;
+    /**
+     * Use options or arguments functions
+     * @default true
+     */
+    useOptions?: boolean;
+}
+
 /**
  * Generate the OpenAPI client. This method will read the OpenAPI specification and based on the
  * given language it will generate the client, including the typed models, validation schemas,