swagger-typescript-api 13.2.3 → 13.2.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # swagger-typescript-api
 
+## 13.2.4
+
+### Patch Changes
+
+- [#1299](https://github.com/acacode/swagger-typescript-api/pull/1299) [`9552c0a`](https://github.com/acacode/swagger-typescript-api/commit/9552c0a3341583be69aaa2cdf2b4e830a1919b01) Thanks [@js2me](https://github.com/js2me)! - added support of x-enum-descriptions property
+
 ## 13.2.3
 
 ### Patch Changes

package/dist/cli.cjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-const require_src = require('./src-CD5LAKtC.cjs');
+const require_src = require('./src-Dti-j_nt.cjs');
 const node_path = require_src.__toESM(require("node:path"));
 const c12 = require_src.__toESM(require("c12"));
 const citty = require_src.__toESM(require("citty"));

package/dist/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { CodeGenConfig, HTTP_CLIENT, TemplatesGenConfig, generateApi, generateTemplates, package_default } from "./src-BYbyXNbU.js";
+import { CodeGenConfig, HTTP_CLIENT, TemplatesGenConfig, generateApi, generateTemplates, package_default } from "./src-Dg3yZCMd.js";
 import * as path$1 from "node:path";
 import { loadConfig } from "c12";
 import { defineCommand, runMain } from "citty";

package/dist/lib.cjs

@@ -1,4 +1,4 @@
-const require_src = require('./src-CD5LAKtC.cjs');
+const require_src = require('./src-Dti-j_nt.cjs');
 
 Object.defineProperty(exports, 'constants', {
   enumerable: true,

package/dist/lib.d.cts

@@ -136,6 +136,7 @@ declare class SchemaUtils {
   getRequiredProperties: (schema: any) => unknown[];
   isRefSchema: (schema: any) => boolean;
   getEnumNames: (schema: any) => any;
+  getEnumDescriptions: (schema: any) => any;
   getSchemaRefType: (schema: any) => SchemaComponent | null;
   isPropertyRequired: (name: any, propertySchema: any, rootSchema: any) => any;
   isNullMissingInType: (schema: any, type: any) => any;
@@ -496,6 +497,7 @@ declare class CodeGenProcess {
           InterfaceDynamicField: (key: unknown, value: unknown) => string;
           EnumUsageKey: (enumStruct: unknown, key: unknown) => string;
           EnumField: (key: unknown, value: unknown) => string;
+          EnumFieldDescription: (description: any) => string;
           EnumFieldsWrapper: (contents: Record<string, unknown>[]) => string;
           ObjectWrapper: (content: unknown) => string;
           MultilineComment: (contents: unknown[], formatFn: (arg: unknown) => unknown) => string[];
@@ -600,6 +602,7 @@ declare class CodeGenProcess {
         InterfaceDynamicField: (key: unknown, value: unknown) => string;
         EnumUsageKey: (enumStruct: unknown, key: unknown) => string;
         EnumField: (key: unknown, value: unknown) => string;
+        EnumFieldDescription: (description: any) => string;
         EnumFieldsWrapper: (contents: Record<string, unknown>[]) => string;
         ObjectWrapper: (content: unknown) => string;
         MultilineComment: (contents: unknown[], formatFn: (arg: unknown) => unknown) => string[];
@@ -1394,8 +1397,15 @@ declare class CodeGenConfig {
      */
     EnumField: (key: unknown, value: unknown) => string;
     /**
+     * /\** description \*\/
+     */
+    EnumFieldDescription: (description: any) => string;
+    /**
+     * /\** $A0.description \*\/
      * $A0.key = $A0.value,
+     * /\** $A1.description \*\/
      * $A1.key = $A1.value,
+     * /\** $AN.description \*\/
      * $AN.key = $AN.value,
      */
     EnumFieldsWrapper: (contents: Record<string, unknown>[]) => string;
@@ -1545,6 +1555,7 @@ declare function generateApi(config: Partial<GenerateApiConfiguration["config"]>
         InterfaceDynamicField: (key: unknown, value: unknown) => string;
         EnumUsageKey: (enumStruct: unknown, key: unknown) => string;
         EnumField: (key: unknown, value: unknown) => string;
+        EnumFieldDescription: (description: any) => string;
         EnumFieldsWrapper: (contents: Record<string, unknown>[]) => string;
         ObjectWrapper: (content: unknown) => string;
         MultilineComment: (contents: unknown[], formatFn: (arg: unknown) => unknown) => string[];

package/dist/lib.d.ts

@@ -1,10 +1,10 @@
 import { __export } from "./chunk-Cl8Af3a2.js";
-import * as lodash20 from "lodash";
+import * as lodash19 from "lodash";
 import lodash from "lodash";
 import * as typescript from "typescript";
-import * as eta21 from "eta";
+import * as eta20 from "eta";
 import { OpenAPI } from "openapi-types";
-import * as swagger_schema_official17 from "swagger-schema-official";
+import * as swagger_schema_official16 from "swagger-schema-official";
 
 //#region src/schema-components-map.d.ts
 declare class SchemaComponentsMap {
@@ -135,6 +135,7 @@ declare class SchemaUtils {
   getRequiredProperties: (schema: any) => unknown[];
   isRefSchema: (schema: any) => boolean;
   getEnumNames: (schema: any) => any;
+  getEnumDescriptions: (schema: any) => any;
   getSchemaRefType: (schema: any) => SchemaComponent | null;
   isPropertyRequired: (name: any, propertySchema: any, rootSchema: any) => any;
   isNullMissingInType: (schema: any, type: any) => any;
@@ -495,6 +496,7 @@ declare class CodeGenProcess {
           InterfaceDynamicField: (key: unknown, value: unknown) => string;
           EnumUsageKey: (enumStruct: unknown, key: unknown) => string;
           EnumField: (key: unknown, value: unknown) => string;
+          EnumFieldDescription: (description: any) => string;
           EnumFieldsWrapper: (contents: Record<string, unknown>[]) => string;
           ObjectWrapper: (content: unknown) => string;
           MultilineComment: (contents: unknown[], formatFn: (arg: unknown) => unknown) => string[];
@@ -599,6 +601,7 @@ declare class CodeGenProcess {
         InterfaceDynamicField: (key: unknown, value: unknown) => string;
         EnumUsageKey: (enumStruct: unknown, key: unknown) => string;
         EnumField: (key: unknown, value: unknown) => string;
+        EnumFieldDescription: (description: any) => string;
         EnumFieldsWrapper: (contents: Record<string, unknown>[]) => string;
         ObjectWrapper: (content: unknown) => string;
         MultilineComment: (contents: unknown[], formatFn: (arg: unknown) => unknown) => string[];
@@ -911,7 +914,7 @@ type RawRouteInfo = {
   description?: string;
   tags?: string[];
   summary?: string;
-  responses?: swagger_schema_official17.Spec["responses"];
+  responses?: swagger_schema_official16.Spec["responses"];
   produces?: string[];
   requestBody?: object;
   consumes?: string[];
@@ -1144,7 +1147,7 @@ interface GenerateApiConfiguration {
     fmtToJSDocLine: (line: string, params?: {
       eol?: boolean;
     }) => string;
-    _: lodash20.LoDashStatic;
+    _: lodash19.LoDashStatic;
     require: (path: string) => unknown;
   };
 }
@@ -1165,7 +1168,7 @@ interface GenerateApiOutput {
     content: string;
     withPrefix: boolean;
   }) => void;
-  renderTemplate: (templateContent: string, data: Record<string, unknown>, etaOptions?: Partial<eta21.EtaConfig>) => Promise<string> | string;
+  renderTemplate: (templateContent: string, data: Record<string, unknown>, etaOptions?: Partial<eta20.EtaConfig>) => Promise<string> | string;
   getTemplate: (params: {
     fileName?: string;
     name?: string;
@@ -1393,8 +1396,15 @@ declare class CodeGenConfig {
      */
     EnumField: (key: unknown, value: unknown) => string;
     /**
+     * /\** description \*\/
+     */
+    EnumFieldDescription: (description: any) => string;
+    /**
+     * /\** $A0.description \*\/
      * $A0.key = $A0.value,
+     * /\** $A1.description \*\/
      * $A1.key = $A1.value,
+     * /\** $AN.description \*\/
      * $AN.key = $AN.value,
      */
     EnumFieldsWrapper: (contents: Record<string, unknown>[]) => string;
@@ -1544,6 +1554,7 @@ declare function generateApi(config: Partial<GenerateApiConfiguration["config"]>
         InterfaceDynamicField: (key: unknown, value: unknown) => string;
         EnumUsageKey: (enumStruct: unknown, key: unknown) => string;
         EnumField: (key: unknown, value: unknown) => string;
+        EnumFieldDescription: (description: any) => string;
         EnumFieldsWrapper: (contents: Record<string, unknown>[]) => string;
         ObjectWrapper: (content: unknown) => string;
         MultilineComment: (contents: unknown[], formatFn: (arg: unknown) => unknown) => string[];
@@ -1579,7 +1590,7 @@ declare function generateApi(config: Partial<GenerateApiConfiguration["config"]>
         eol?: boolean | undefined;
       }) => string;
       NameResolver: typeof NameResolver;
-      _: lodash20.LoDashStatic;
+      _: lodash19.LoDashStatic;
       require: (packageOrPath: string) => Promise<any>;
     };
   };

package/dist/lib.js

@@ -1,3 +1,3 @@
-import { constants_exports, generateApi, generateTemplates } from "./src-BYbyXNbU.js";
+import { constants_exports, generateApi, generateTemplates } from "./src-Dg3yZCMd.js";
 
 export { constants_exports as constants, generateApi, generateTemplates };

package/dist/{src-BYbyXNbU.js → src-Dg3yZCMd.js}

@@ -177,7 +177,7 @@ var ComponentTypeNameResolver = class extends NameResolver {
 //#endregion
 //#region package.json
 var name = "swagger-typescript-api";
-var version = "13.2.3";
+var version = "13.2.4";
 var description = "Generate the API client for Fetch or Axios from an OpenAPI Specification";
 var homepage = "https://github.com/acacode/swagger-typescript-api";
 var bugs = "https://github.com/acacode/swagger-typescript-api/issues";
@@ -218,7 +218,7 @@ var scripts = {
 };
 var dependencies = {
 	"@biomejs/js-api": "1.0.0",
-	"@biomejs/wasm-nodejs": "2.0.0",
+	"@biomejs/wasm-nodejs": "2.0.4",
 	"@types/swagger-schema-official": "^2.0.25",
 	"c12": "^3.0.4",
 	"citty": "^0.1.6",
@@ -232,20 +232,20 @@ var dependencies = {
 	"typescript": "~5.8.3"
 };
 var devDependencies = {
-	"@biomejs/biome": "2.0.0",
+	"@biomejs/biome": "2.0.4",
 	"@changesets/changelog-github": "0.5.1",
-	"@changesets/cli": "2.29.4",
+	"@changesets/cli": "2.29.5",
 	"@tsconfig/node18": "18.2.4",
 	"@tsconfig/strictest": "2.0.5",
 	"@types/js-yaml": "4.0.9",
-	"@types/lodash": "4.17.17",
+	"@types/lodash": "4.17.18",
 	"@types/node": "24.0.3",
 	"@types/swagger2openapi": "7.0.4",
 	"axios": "1.10.0",
 	"openapi-types": "12.1.3",
 	"tsdown": "0.12.8",
 	"typedoc": "0.28.5",
-	"vitest": "3.2.3"
+	"vitest": "3.2.4"
 };
 var packageManager = "yarn@4.9.2";
 var engines = { "node": ">=20" };
@@ -575,7 +575,13 @@ var CodeGenConfig = class {
 		InterfaceDynamicField: (key, value) => `[key: ${key}]: ${value}`,
 		EnumUsageKey: (enumStruct, key) => `${enumStruct}.${key}`,
 		EnumField: (key, value) => `${key} = ${value}`,
-		EnumFieldsWrapper: (contents) => lodash.map(contents, ({ key, value }) => `  ${this.Ts.EnumField(key, value)}`).join(",\n"),
+		EnumFieldDescription: (description$1) => {
+			if (description$1) return `  /** ${description$1} */`;
+			else return "";
+		},
+		EnumFieldsWrapper: (contents) => lodash.map(contents, ({ key, value, description: description$1 }) => {
+			return [this.Ts.EnumFieldDescription(description$1), `  ${this.Ts.EnumField(key, value)}`].filter(Boolean).join("\n");
+		}).join(",\n"),
 		ObjectWrapper: (content) => `{\n${content}\n}`,
 		MultilineComment: (contents, formatFn) => [...contents.length === 1 ? [`/** ${contents[0]} */`] : [
 			"/**",
@@ -1139,6 +1145,7 @@ var EnumSchemaParser = class extends MonoSchemaParser {
 		})) }, this.typeName, this.schemaPath);
 		const keyType = this.schemaUtils.getSchemaType(this.schema);
 		const enumNames = this.schemaUtils.getEnumNames(this.schema);
+		const enumDescriptions = this.schemaUtils.getEnumDescriptions(this.schema);
 		let content = null;
 		const formatValue = (value) => {
 			if (value === null) return this.config.Ts.NullValue(value);
@@ -1155,19 +1162,22 @@ var EnumSchemaParser = class extends MonoSchemaParser {
 			if (this.config.enumNamesAsValues || enumValue === void 0) return {
 				key: formattedKey,
 				type: this.config.Ts.Keyword.String,
-				value: this.config.Ts.StringValue(enumName)
+				value: this.config.Ts.StringValue(enumName),
+				description: enumDescriptions?.[index]
 			};
 			return {
 				key: formattedKey,
 				type: keyType,
-				value: formatValue(enumValue)
+				value: formatValue(enumValue),
+				description: enumDescriptions?.[index]
 			};
 		});
-		else content = this.schema.enum.map((value) => {
+		else content = this.schema.enum.map((value, index) => {
 			return {
 				key: this.formatEnumKey({ value }),
 				type: keyType,
-				value: formatValue(value)
+				value: formatValue(value),
+				description: enumDescriptions?.[index]
 			};
 		});
 		return {
@@ -1498,6 +1508,9 @@ var SchemaUtils = class {
 	getEnumNames = (schema) => {
 		return schema["x-enumNames"] || schema.xEnumNames || schema["x-enumnames"] || schema["x-enum-varnames"];
 	};
+	getEnumDescriptions = (schema) => {
+		return schema["x-enumDescriptions"] || schema.xEnumDescriptions || schema["x-enumdescriptions"] || schema["x-enum-descriptions"];
+	};
 	getSchemaRefType = (schema) => {
 		if (!this.isRefSchema(schema)) return null;
 		return this.schemaComponentsMap.get(schema.$ref);
@@ -3124,4 +3137,4 @@ async function generateApi(config) {
 
 //#endregion
 export { CodeGenConfig, HTTP_CLIENT, TemplatesGenConfig, constants_exports, generateApi, generateTemplates, package_default };
-//# sourceMappingURL=src-BYbyXNbU.js.map
+//# sourceMappingURL=src-Dg3yZCMd.js.map