swagger2api-v3 1.1.8 → 1.1.10

package/dist/utils/type.js

@@ -1,12 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidIdentifier = isValidIdentifier;
+exports.formatTsPropertyName = formatTsPropertyName;
 exports.stripNullFromUnion = stripNullFromUnion;
 exports.swaggerTypeToTsType = swaggerTypeToTsType;
+exports.getRefName = getRefName;
 exports.swaggerParameterToSchema = swaggerParameterToSchema;
-exports.generateParameterTypes = generateParameterTypes;
 exports.getResponseType = getResponseType;
 exports.getSchemaFromContent = getSchemaFromContent;
 const naming_1 = require("./naming");
+/**
+ * 判断字符串是否为合法 TypeScript 标识符
+ * @param name 属性名
+ * @returns 是否为合法标识符
+ */
+function isValidIdentifier(name) {
+    return /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(name);
+}
+/**
+ * 格式化 TypeScript 属性名
+ * @param name 属性名
+ * @returns 可用于类型声明的属性名
+ */
+function formatTsPropertyName(name) {
+    return isValidIdentifier(name) ? name : JSON.stringify(name);
+}
 /**
  * 移除联合类型中的顶层 null 类型
  * @param typeStr 类型字符串
@@ -78,8 +96,8 @@ function swaggerTypeToTsType(schema, schemas) {
     else if (schema.allOf) {
         const refSchema = schema.allOf.find((item) => item.$ref);
         const secondSchema = schema.allOf.find((item) => !item.$ref);
-        if (refSchema && secondSchema) {
-            const refName = refSchema.$ref.split('/').pop();
+        if (refSchema && secondSchema && schema.allOf.length === 2) {
+            const refName = getRefName(refSchema.$ref || '');
             const sanitizedRefName = (0, naming_1.sanitizeTypeName)(refName || '');
             if (secondSchema.properties) {
                 const propertyTypes = [];
@@ -97,7 +115,7 @@ function swaggerTypeToTsType(schema, schemas) {
                         let type = swaggerTypeToTsType(value, schemas);
                         if (optional === '?')
                             type = stripNullFromUnion(type);
-                        return `${key}${optional}: ${type}`;
+                        return `${formatTsPropertyName(key)}${optional}: ${type}`;
                     })
                         .join('; ')} }`;
                     baseType = `${sanitizedRefName}<${combinedType}>`;
@@ -112,9 +130,10 @@ function swaggerTypeToTsType(schema, schemas) {
         }
         else {
             const types = schema.allOf
-                .map((item) => swaggerTypeToTsType(item))
+                .map((item) => swaggerTypeToTsType(item, schemas))
                 .filter((type) => type !== 'any');
-            baseType = types.length > 0 ? types[0] : 'any';
+            const uniqueTypes = Array.from(new Set(types));
+            baseType = uniqueTypes.length > 0 ? uniqueTypes.join(' & ') : 'any';
         }
     }
     else if (schema.anyOf || schema.oneOf) {
@@ -132,7 +151,7 @@ function swaggerTypeToTsType(schema, schemas) {
         }
     }
     else if (schema.$ref) {
-        const refName = schema.$ref.split('/').pop();
+        const refName = getRefName(schema.$ref);
         baseType = (0, naming_1.sanitizeTypeName)(refName || 'any');
         if (schemas && refName) {
             const referencedSchema = schemas[refName];
@@ -145,7 +164,7 @@ function swaggerTypeToTsType(schema, schemas) {
         const itemSchema = schema.items;
         const itemType = swaggerTypeToTsType(itemSchema, schemas);
         if (itemSchema?.$ref && schemas) {
-            const refName = itemSchema.$ref.split('/').pop();
+            const refName = getRefName(itemSchema.$ref);
             const referencedSchema = refName ? schemas[refName] : undefined;
             baseType =
                 referencedSchema?.type === 'array' ? itemType : `${itemType}[]`;
@@ -162,7 +181,7 @@ function swaggerTypeToTsType(schema, schemas) {
                 let type = swaggerTypeToTsType(value, schemas);
                 if (optional === '?')
                     type = stripNullFromUnion(type);
-                return `  ${key}${optional}: ${type};`;
+                return `  ${formatTsPropertyName(key)}${optional}: ${type};`;
             })
                 .join('\n');
             baseType = `{\n${properties}\n}`;
@@ -211,6 +230,14 @@ function swaggerTypeToTsType(schema, schemas) {
     }
     return baseType;
 }
+/**
+ * 从 $ref 字符串中提取引用名称
+ * @param ref OpenAPI $ref 字符串
+ * @returns 引用名称
+ */
+function getRefName(ref) {
+    return ref.split('/').pop() || '';
+}
 /**
  * 将枚举值转换为 TypeScript 字面量类型
  * @param value 枚举值
@@ -220,7 +247,7 @@ function toLiteralType(value) {
     if (value === null)
         return 'null';
     if (typeof value === 'string')
-        return `'${value}'`;
+        return JSON.stringify(value);
     return String(value);
 }
 /**
@@ -239,41 +266,6 @@ function swaggerParameterToSchema(parameter) {
         enum: parameter.enum
     };
 }
-/**
- * 从 OpenAPI 参数生成 TypeScript 参数类型
- * @param parameters OpenAPI 参数数组
- * @returns TypeScript参数类型定义
- */
-function generateParameterTypes(parameters) {
-    if (!parameters || parameters.length === 0) {
-        return '';
-    }
-    const queryParams = parameters.filter((param) => param.in === 'query');
-    const pathParams = parameters.filter((param) => param.in === 'path');
-    const bodyParams = parameters.filter((param) => param.in === 'body');
-    const types = [];
-    if (pathParams.length > 0) {
-        const pathType = pathParams
-            .map((param) => `${param.name}: ${swaggerTypeToTsType(swaggerParameterToSchema(param))}`)
-            .join(', ');
-        types.push(`pathParams: { ${pathType} }`);
-    }
-    if (queryParams.length > 0) {
-        const queryType = queryParams
-            .map((param) => {
-            const optional = param.required ? '' : '?';
-            return `${param.name}${optional}: ${swaggerTypeToTsType(swaggerParameterToSchema(param))}`;
-        })
-            .join(', ');
-        types.push(`queryParams${queryParams.every((param) => !param.required) ? '?' : ''}: { ${queryType} }`);
-    }
-    if (bodyParams.length > 0) {
-        const bodyParam = bodyParams[0];
-        const bodyType = swaggerTypeToTsType(bodyParam.schema);
-        types.push(`data: ${bodyType}`);
-    }
-    return types.join(', ');
-}
 /**
  * 获取响应类型
  * @param responses OpenAPI 响应对象

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "swagger2api-v3",
-  "version": "1.1.8",
-  "description": "A command-line tool for generating TypeScript API interfaces from Swagger (OAS 3.0) documentation",
+  "version": "1.1.10",
+  "description": "A command-line tool for generating TypeScript API interfaces from OpenAPI 3.x / Swagger 3.0 documentation",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "commonjs",
@@ -18,20 +18,21 @@
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
     "test:ci": "jest --ci --coverage --watchAll=false",
-    "build": "tsc && npm run copy:schema",
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
+    "build": "tsc && pnpm run copy:schema",
     "copy:schema": "node build/copy-schema.js",
     "clean": "rimraf dist",
-    "prebuild": "npm run clean",
+    "prebuild": "pnpm run clean",
     "start": "node dist/cli/index.js",
-    "dev": "npm run build && npm start",
+    "dev": "pnpm run build && pnpm start",
     "lint": "prettier --write .",
-    "generate": "npm run build && node dist/cli/index.js generate",
-    "init": "npm run build && node dist/cli/index.js init",
-    "validate": "npm run build && node dist/cli/index.js validate",
-    "swagger:generate": "npm run generate",
-    "swagger:run": "npm run generate",
-    "swagger:init": "npm run init",
-    "swagger:validate": "npm run validate"
+    "generate": "pnpm run build && node dist/cli/index.js generate",
+    "init": "pnpm run build && node dist/cli/index.js init",
+    "validate": "pnpm run build && node dist/cli/index.js validate",
+    "swagger:generate": "pnpm run generate",
+    "swagger:run": "pnpm run generate",
+    "swagger:init": "pnpm run init",
+    "swagger:validate": "pnpm run validate"
   },
   "keywords": [
     "swagger",
@@ -54,16 +55,17 @@
   },
   "packageManager": "pnpm@10.11.0",
   "devDependencies": {
-    "@types/jest": "^29.5.0",
-    "@types/node": "^24.3.1",
-    "jest": "^29.5.0",
-    "prettier": "^3.6.2",
-    "rimraf": "^6.0.1",
-    "ts-jest": "^29.1.0",
-    "typescript": "^5.9.2"
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.13.2",
+    "conventional-changelog-cli": "^5.0.0",
+    "jest": "^30.4.2",
+    "prettier": "^3.8.4",
+    "rimraf": "^6.1.3",
+    "ts-jest": "^29.4.11",
+    "typescript": "^6.0.3"
   },
   "dependencies": {
-    "axios": "^1.11.0",
-    "commander": "^12.0.0"
+    "axios": "^1.18.1",
+    "commander": "^12.1.0"
   }
 }