swagger2api-v3 1.1.10 → 1.1.11

package/dist/utils/type.js

@@ -1,259 +1,28 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 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.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 类型字符串
- * @returns 移除 null 后的类型字符串
- */
-function stripNullFromUnion(typeStr) {
-    if (!typeStr)
-        return 'any';
-    const parts = [];
-    let current = '';
-    let parenDepth = 0;
-    let angleDepth = 0;
-    let braceDepth = 0;
-    let bracketDepth = 0;
-    for (let i = 0; i < typeStr.length; i++) {
-        const ch = typeStr[i];
-        if (ch === '(')
-            parenDepth++;
-        else if (ch === ')')
-            parenDepth = Math.max(0, parenDepth - 1);
-        else if (ch === '<')
-            angleDepth++;
-        else if (ch === '>')
-            angleDepth = Math.max(0, angleDepth - 1);
-        else if (ch === '{')
-            braceDepth++;
-        else if (ch === '}')
-            braceDepth = Math.max(0, braceDepth - 1);
-        else if (ch === '[')
-            bracketDepth++;
-        else if (ch === ']')
-            bracketDepth = Math.max(0, bracketDepth - 1);
-        const isTopLevel = parenDepth === 0 &&
-            angleDepth === 0 &&
-            braceDepth === 0 &&
-            bracketDepth === 0;
-        if (ch === '|' && isTopLevel) {
-            parts.push(current.trim());
-            current = '';
-            continue;
-        }
-        current += ch;
-    }
-    if (current.trim())
-        parts.push(current.trim());
-    const normalized = Array.from(new Set(parts.filter((part) => part && part !== 'null')));
-    return normalized.length > 0 ? normalized.join(' | ') : 'any';
-}
-/**
- * 将 OpenAPI schema 转换为 TypeScript 类型
- * @param schema OpenAPI schema
- * @param schemas 可选的 schemas 上下文，用于查找被引用的类型定义
- * @returns TypeScript类型字符串
- */
-function swaggerTypeToTsType(schema, schemas) {
-    if (!schema)
-        return 'any';
-    let baseType = 'any';
-    if (Array.isArray(schema.type)) {
-        const types = schema.type.map((type) => swaggerTypeToTsType({ ...schema, type, nullable: false }, schemas));
-        const uniqueTypes = Array.from(new Set(types));
-        baseType = uniqueTypes.includes('any') ? 'any' : uniqueTypes.join(' | ');
-    }
-    else if (schema.enum) {
-        baseType = schema.enum
-            .map((value) => toLiteralType(value))
-            .join(' | ');
-    }
-    else if (schema.allOf) {
-        const refSchema = schema.allOf.find((item) => item.$ref);
-        const secondSchema = schema.allOf.find((item) => !item.$ref);
-        if (refSchema && secondSchema && schema.allOf.length === 2) {
-            const refName = getRefName(refSchema.$ref || '');
-            const sanitizedRefName = (0, naming_1.sanitizeTypeName)(refName || '');
-            if (secondSchema.properties) {
-                const propertyTypes = [];
-                for (const propSchema of Object.values(secondSchema.properties)) {
-                    const propType = swaggerTypeToTsType(propSchema, schemas);
-                    propertyTypes.push(propType);
-                }
-                if (propertyTypes.length === 1) {
-                    baseType = `${sanitizedRefName}<${propertyTypes[0]}>`;
-                }
-                else if (propertyTypes.length > 1) {
-                    const combinedType = `{ ${Object.entries(secondSchema.properties)
-                        .map(([key, value]) => {
-                        const optional = secondSchema.required?.includes(key) ? '' : '?';
-                        let type = swaggerTypeToTsType(value, schemas);
-                        if (optional === '?')
-                            type = stripNullFromUnion(type);
-                        return `${formatTsPropertyName(key)}${optional}: ${type}`;
-                    })
-                        .join('; ')} }`;
-                    baseType = `${sanitizedRefName}<${combinedType}>`;
-                }
-                else {
-                    baseType = sanitizedRefName || 'any';
-                }
-            }
-            else {
-                baseType = sanitizedRefName || 'any';
-            }
-        }
-        else {
-            const types = schema.allOf
-                .map((item) => swaggerTypeToTsType(item, schemas))
-                .filter((type) => type !== 'any');
-            const uniqueTypes = Array.from(new Set(types));
-            baseType = uniqueTypes.length > 0 ? uniqueTypes.join(' & ') : 'any';
-        }
-    }
-    else if (schema.anyOf || schema.oneOf) {
-        const types = (schema.anyOf || schema.oneOf).map((item) => {
-            if (item.type === 'null')
-                return 'null';
-            return swaggerTypeToTsType(item, schemas);
-        });
-        if (types.includes('any')) {
-            baseType = 'any';
-        }
-        else {
-            const uniqueTypes = Array.from(new Set(types));
-            baseType = uniqueTypes.length > 0 ? uniqueTypes.join(' | ') : 'any';
-        }
-    }
-    else if (schema.$ref) {
-        const refName = getRefName(schema.$ref);
-        baseType = (0, naming_1.sanitizeTypeName)(refName || 'any');
-        if (schemas && refName) {
-            const referencedSchema = schemas[refName];
-            if (referencedSchema && referencedSchema.type === 'array') {
-                baseType = `${baseType}[]`;
-            }
-        }
-    }
-    else if (schema.type === 'array') {
-        const itemSchema = schema.items;
-        const itemType = swaggerTypeToTsType(itemSchema, schemas);
-        if (itemSchema?.$ref && schemas) {
-            const refName = getRefName(itemSchema.$ref);
-            const referencedSchema = refName ? schemas[refName] : undefined;
-            baseType =
-                referencedSchema?.type === 'array' ? itemType : `${itemType}[]`;
-        }
-        else {
-            baseType = `${itemType}[]`;
-        }
-    }
-    else if (schema.type === 'object') {
-        if (schema.properties) {
-            const properties = Object.entries(schema.properties)
-                .map(([key, value]) => {
-                const optional = schema.required?.includes(key) ? '' : '?';
-                let type = swaggerTypeToTsType(value, schemas);
-                if (optional === '?')
-                    type = stripNullFromUnion(type);
-                return `  ${formatTsPropertyName(key)}${optional}: ${type};`;
-            })
-                .join('\n');
-            baseType = `{\n${properties}\n}`;
-        }
-        else if (schema.additionalProperties &&
-            typeof schema.additionalProperties === 'object') {
-            const valueType = swaggerTypeToTsType(schema.additionalProperties, schemas);
-            baseType = `Record<string, ${valueType}>`;
-        }
-        else if (schema.additionalProperties === false) {
-            baseType = 'Record<string, never>';
-        }
-        else {
-            baseType = 'Record<string, any>';
-        }
-    }
-    else {
-        switch (schema.type) {
-            case 'integer':
-            case 'number':
-                baseType = 'number';
-                break;
-            case 'string':
-                baseType = 'string';
-                break;
-            case 'boolean':
-                baseType = 'boolean';
-                break;
-            case 'file':
-                baseType = 'File';
-                break;
-            case 'null':
-                baseType = 'null';
-                break;
-            default:
-                baseType = 'any';
-                break;
-        }
-    }
-    if (schema.nullable === true) {
-        if (baseType === 'any')
-            return 'any';
-        if (baseType.includes('null'))
-            return baseType;
-        return `${baseType} | null`;
-    }
-    return baseType;
-}
+const schema_1 = require("./schema");
+__exportStar(require("./schema"), exports);
 /**
- * 从 $ref 字符串中提取引用名称
- * @param ref OpenAPI $ref 字符串
- * @returns 引用名称
- */
-function getRefName(ref) {
-    return ref.split('/').pop() || '';
-}
-/**
- * 将枚举值转换为 TypeScript 字面量类型
- * @param value 枚举值
- * @returns 字面量类型字符串
- */
-function toLiteralType(value) {
-    if (value === null)
-        return 'null';
-    if (typeof value === 'string')
-        return JSON.stringify(value);
-    return String(value);
-}
-/**
- * 将 OpenAPI 参数转换为 schema 对象
+ * 将 OpenAPI 参数转换为 Schema 对象
  * @param parameter OpenAPI 参数
- * @returns 参数对应的 schema
+ * @returns 参数对应的 Schema
  */
 function swaggerParameterToSchema(parameter) {
     if (parameter.schema) {
@@ -270,25 +39,23 @@ function swaggerParameterToSchema(parameter) {
  * 获取响应类型
  * @param responses OpenAPI 响应对象
  * @param schemas OpenAPI components.schemas
- * @returns TypeScript类型字符串
+ * @returns TypeScript 类型字符串
  */
-function getResponseType(responses, schemas) {
-    if (!responses) {
+function getResponseType(responses, schemas = {}) {
+    if (!responses)
         return 'any';
-    }
     const successResponse = getSuccessResponse(responses);
-    if (!successResponse) {
+    if (!successResponse)
         return 'any';
-    }
     const contentSchema = getSchemaFromContent(successResponse.content);
     if (contentSchema) {
-        return swaggerTypeToTsType(contentSchema, schemas);
+        return (0, schema_1.swaggerTypeToTsType)(contentSchema, schemas, 'response');
     }
     return successResponse.description === 'No Content' ? 'void' : 'any';
 }
 /**
  * 从响应集合中获取优先成功响应
- * @param responses OpenAPI响应对象
+ * @param responses OpenAPI 响应对象
  * @returns 成功响应对象
  */
 function getSuccessResponse(responses) {
@@ -299,12 +66,14 @@ function getSuccessResponse(responses) {
     const successStatus = Object.keys(responses)
         .filter((status) => /^2\d\d$/.test(status))
         .sort()[0];
-    return successStatus ? responses[successStatus] : responses.default;
+    return successStatus
+        ? responses[successStatus]
+        : responses.default;
 }
 /**
- * 从 OpenAPI content 对象中获取最合适的 schema
+ * 从 OpenAPI content 对象中获取最合适的 Schema
  * @param content OpenAPI content 对象
- * @returns 匹配到的 schema
+ * @returns 匹配到的 Schema
  */
 function getSchemaFromContent(content) {
     if (!content)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "swagger2api-v3",
-  "version": "1.1.10",
-  "description": "A command-line tool for generating TypeScript API interfaces from OpenAPI 3.x / Swagger 3.0 documentation",
+  "version": "1.1.11",
+  "description": "A command-line tool for generating TypeScript API interfaces from OpenAPI 3.0 documentation",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "commonjs",
@@ -48,7 +48,7 @@
   "homepage": "https://github.com/xiaoyang33/swagger2api-v3#readme",
   "repository": {
     "type": "git",
-    "url": "https://github.com/xiaoyang33/swagger2api-v3.git"
+    "url": "git+https://github.com/xiaoyang33/swagger2api-v3.git"
   },
   "bugs": {
     "url": "https://github.com/xiaoyang33/swagger2api-v3/issues"
@@ -65,7 +65,7 @@
     "typescript": "^6.0.3"
   },
   "dependencies": {
-    "axios": "^1.18.1",
+    "@apidevtools/swagger-parser": "^12.1.0",
     "commander": "^12.1.0"
   }
 }