czh-api 1.0.4 → 1.0.6

package/dist/commands/build.js

@@ -48,7 +48,7 @@ function convertOpenApiTypeToTypeScript(openApiType) {
         case 'number':
             return 'number';
         default:
-            return 'any';
+            return openApiType;
     }
 }
 // 改进类型定义的辅助函数
@@ -93,6 +93,138 @@ function findInterfaceBlockRange(content, typeName) {
     }
     return null;
 }
+const TS_BUILTIN_TYPE_NAMES = new Set([
+    'string',
+    'number',
+    'boolean',
+    'null',
+    'undefined',
+    'void',
+    'any',
+    'unknown',
+    'never',
+    'object',
+    'Record',
+    'Array',
+    'Date',
+    'Promise',
+    'true',
+    'false',
+]);
+function extractTypeIdentifiers(typeExpr) {
+    if (!typeExpr)
+        return [];
+    const matches = typeExpr.match(/[A-Za-z_$][A-Za-z0-9_$]*/g) || [];
+    return [...new Set(matches.filter(name => !TS_BUILTIN_TYPE_NAMES.has(name)))];
+}
+function getSchemaNameFromRef(ref) {
+    if (!ref)
+        return '';
+    return ref.split('/').pop() || '';
+}
+function resolveSchemaTypeFromModuleSchemas(schema, moduleSchemas, visitedRefs = new Set()) {
+    if (!schema)
+        return 'any';
+    if (schema.$ref) {
+        const refName = getSchemaNameFromRef(schema.$ref);
+        return refName || 'any';
+    }
+    const schemaObj = schema;
+    if (schemaObj.anyOf && Array.isArray(schemaObj.anyOf) && schemaObj.anyOf.length > 0) {
+        const types = schemaObj.anyOf
+            .map(item => resolveSchemaTypeFromModuleSchemas(item, moduleSchemas, visitedRefs))
+            .filter(Boolean);
+        if (types.length > 0) {
+            return [...new Set(types)].join(' | ');
+        }
+    }
+    if (schemaObj.oneOf && Array.isArray(schemaObj.oneOf) && schemaObj.oneOf.length > 0) {
+        const types = schemaObj.oneOf
+            .map(item => resolveSchemaTypeFromModuleSchemas(item, moduleSchemas, visitedRefs))
+            .filter(Boolean);
+        if (types.length > 0) {
+            return [...new Set(types)].join(' | ');
+        }
+    }
+    if (schemaObj.type === 'array') {
+        const itemType = resolveSchemaTypeFromModuleSchemas(schemaObj.items, moduleSchemas, visitedRefs);
+        return `${itemType || 'any'}[]`;
+    }
+    if (schemaObj.type === 'object' && schemaObj.additionalProperties) {
+        if (schemaObj.additionalProperties === true) {
+            return 'Record<string, any>';
+        }
+        const valueType = resolveSchemaTypeFromModuleSchemas(schemaObj.additionalProperties, moduleSchemas, visitedRefs);
+        return `Record<string, ${valueType || 'any'}>`;
+    }
+    if (schemaObj.type === 'object' && schemaObj.properties && Object.keys(schemaObj.properties).length > 0) {
+        const requiredSet = new Set(schemaObj.required || []);
+        const inlineFields = Object.entries(schemaObj.properties).map(([key, value]) => {
+            const fieldType = resolveSchemaTypeFromModuleSchemas(value, moduleSchemas, visitedRefs);
+            const optional = requiredSet.has(key) ? '' : '?';
+            return `${key}${optional}: ${fieldType || 'any'}`;
+        });
+        return `{ ${inlineFields.join('; ')} }`;
+    }
+    const baseType = convertOpenApiTypeToTypeScript(schemaObj.type);
+    if (!baseType)
+        return 'any';
+    return schemaObj.nullable ? `${baseType} | null` : baseType;
+}
+function collectSchemaProperties(schema, moduleSchemas, visitedRefs = new Set()) {
+    const collected = {
+        properties: {},
+        required: new Set(),
+    };
+    if (!schema)
+        return collected;
+    if (schema.$ref) {
+        const ref = schema.$ref;
+        if (!visitedRefs.has(ref)) {
+            visitedRefs.add(ref);
+            const refName = getSchemaNameFromRef(ref);
+            const refSchema = moduleSchemas[refName];
+            if (refSchema) {
+                const nested = collectSchemaProperties(refSchema, moduleSchemas, visitedRefs);
+                Object.assign(collected.properties, nested.properties);
+                nested.required.forEach(field => collected.required.add(field));
+            }
+        }
+        return collected;
+    }
+    const schemaObj = schema;
+    if (schemaObj.allOf && Array.isArray(schemaObj.allOf)) {
+        schemaObj.allOf.forEach(item => {
+            const nested = collectSchemaProperties(item, moduleSchemas, visitedRefs);
+            Object.assign(collected.properties, nested.properties);
+            nested.required.forEach(field => collected.required.add(field));
+        });
+    }
+    if (schemaObj.properties) {
+        Object.entries(schemaObj.properties).forEach(([name, value]) => {
+            collected.properties[name] = value;
+        });
+    }
+    (schemaObj.required || []).forEach(field => collected.required.add(field));
+    return collected;
+}
+function buildInterfaceDefinitionFromModuleSchemas(typeName, moduleSchemas) {
+    const schema = moduleSchemas[typeName];
+    if (!schema)
+        return null;
+    const { properties, required } = collectSchemaProperties(schema, moduleSchemas);
+    const entries = Object.entries(properties);
+    if (entries.length === 0)
+        return null;
+    const lines = entries.map(([propName, propSchema]) => {
+        const optional = required.has(propName) ? '' : '?';
+        const propType = resolveSchemaTypeFromModuleSchemas(propSchema, moduleSchemas) || 'any';
+        const propDescription = propSchema.description || '';
+        const comment = propDescription ? ` // ${propDescription}` : '';
+        return `  ${propName}${optional}: ${propType};${comment}`;
+    });
+    return `export interface ${typeName} {\n${lines.join('\n')}\n}`;
+}
 function improveTypeDefinitions(typesContent, endpoints) {
     let improvedContent = typesContent;
     // 收集所有需要改进的类型定义
@@ -124,8 +256,8 @@ function improveTypeDefinitions(typesContent, endpoints) {
         if (requestParamsTypeName && isValidTypeIdentifier(requestParamsTypeName) && endpoint.paramsJsdocParams && endpoint.paramsJsdocParams.length > 0) {
             const paramsFields = buildFieldsFromJsdocParams(endpoint.paramsJsdocParams);
             if (paramsFields) {
-                typeImprovements[requestParamsTypeName] = `export interface ${requestParamsTypeName} {
-${paramsFields}
+                typeImprovements[requestParamsTypeName] = `export interface ${requestParamsTypeName} {
+${paramsFields}
 }`;
             }
         }
@@ -134,8 +266,8 @@ ${paramsFields}
         if (requestBodyTypeName && isValidTypeIdentifier(requestBodyTypeName) && endpoint.dataJsdocParams && endpoint.dataJsdocParams.length > 0) {
             const dataFields = buildFieldsFromJsdocParams(endpoint.dataJsdocParams);
             if (dataFields) {
-                typeImprovements[requestBodyTypeName] = `export interface ${requestBodyTypeName} {
-${dataFields}
+                typeImprovements[requestBodyTypeName] = `export interface ${requestBodyTypeName} {
+${dataFields}
 }`;
             }
         }
@@ -144,8 +276,8 @@ ${dataFields}
         if (responseTargetType && endpoint.responseTypeName !== 'void' && endpoint.responseJsdocParams && endpoint.responseJsdocParams.length > 0) {
             const responseFields = buildFieldsFromJsdocParams(endpoint.responseJsdocParams);
             if (responseFields) {
-                typeImprovements[responseTargetType] = `export interface ${responseTargetType} {
-${responseFields}
+                typeImprovements[responseTargetType] = `export interface ${responseTargetType} {
+${responseFields}
 }`;
             }
         }
@@ -252,6 +384,25 @@ function normalizeSchemaRefs(value) {
     }
     return value;
 }
+function stripNestedSchemaTitles(value, depth = 0) {
+    if (Array.isArray(value)) {
+        return value.map(item => stripNestedSchemaTitles(item, depth + 1));
+    }
+    if (value && typeof value === 'object') {
+        const obj = value;
+        const normalized = {};
+        for (const [key, currentValue] of Object.entries(obj)) {
+            // json-schema-to-typescript may generate invalid type aliases from nested title values
+            // (e.g. Chinese punctuation or numeric-leading titles), so keep only root-level titles.
+            if (key === 'title' && depth > 0) {
+                continue;
+            }
+            normalized[key] = stripNestedSchemaTitles(currentValue, depth + 1);
+        }
+        return normalized;
+    }
+    return value;
+}
 const handleBuild = () => __awaiter(void 0, void 0, void 0, function* () {
     try {
         console.log(chalk_1.default.blue('Building API from source...'));
@@ -351,7 +502,7 @@ const handleBuild = () => __awaiter(void 0, void 0, void 0, function* () {
             if (Object.keys(module.schemas).length > 0) {
                 console.log(chalk_1.default.blue(`正在为模块 "${moduleName}" 生成类型文件，包含 ${Object.keys(module.schemas).length} 个 schema`));
                 try {
-                    const normalizedModuleSchemas = normalizeSchemaRefs(module.schemas);
+                    const normalizedModuleSchemas = stripNestedSchemaTitles(normalizeSchemaRefs(module.schemas));
                     const schemasWithTitles = {};
                     for (const schemaName in normalizedModuleSchemas) {
                         schemasWithTitles[schemaName] = Object.assign(Object.assign({}, normalizedModuleSchemas[schemaName]), { title: schemaName });
@@ -401,7 +552,7 @@ const handleBuild = () => __awaiter(void 0, void 0, void 0, function* () {
                         // 尝试逐个验证 schema，过滤掉有问题的
                         const validSchemas = {};
                         const invalidSchemas = [];
-                        const normalizedModuleSchemas = normalizeSchemaRefs(module.schemas);
+                        const normalizedModuleSchemas = stripNestedSchemaTitles(normalizeSchemaRefs(module.schemas));
                         for (const schemaName in normalizedModuleSchemas) {
                             try {
                                 // 尝试单独编译每个 schema
@@ -481,6 +632,7 @@ const handleBuild = () => __awaiter(void 0, void 0, void 0, function* () {
                         console.log(chalk_1.default.blue(`为模块 "${moduleName}" 生成基于 JSDoc 的类型定义...`));
                         // 创建类型定义映射
                         const typeDefinitions = {};
+                        const nestedReferencedTypes = new Set();
                         // 从 endpoints 中提取类型定义
                         module.endpoints.forEach(endpoint => {
                             // 辅助函数：将 jsdoc params 转换为字段
@@ -497,6 +649,11 @@ const handleBuild = () => __awaiter(void 0, void 0, void 0, function* () {
                                 else {
                                     type = convertOpenApiTypeToTypeScript(type);
                                 }
+                                extractTypeIdentifiers(type).forEach(typeName => {
+                                    if (isValidTypeIdentifier(typeName)) {
+                                        nestedReferencedTypes.add(typeName);
+                                    }
+                                });
                                 const comment = param.description ? ` // ${param.description}` : '';
                                 return `  ${param.name}${optional}: ${type};${comment}`;
                             })
@@ -506,8 +663,8 @@ const handleBuild = () => __awaiter(void 0, void 0, void 0, function* () {
                             if (requestParamsTypeName && isValidTypeIdentifier(requestParamsTypeName) && endpoint.paramsJsdocParams && endpoint.paramsJsdocParams.length > 0) {
                                 const paramsFields = buildFields(endpoint.paramsJsdocParams);
                                 if (paramsFields) {
-                                    typeDefinitions[requestParamsTypeName] = `export interface ${requestParamsTypeName} {
-${paramsFields}
+                                    typeDefinitions[requestParamsTypeName] = `export interface ${requestParamsTypeName} {
+${paramsFields}
 }`;
                                 }
                             }
@@ -516,8 +673,8 @@ ${paramsFields}
                             if (requestBodyTypeName && isValidTypeIdentifier(requestBodyTypeName) && endpoint.dataJsdocParams && endpoint.dataJsdocParams.length > 0) {
                                 const dataFields = buildFields(endpoint.dataJsdocParams);
                                 if (dataFields) {
-                                    typeDefinitions[requestBodyTypeName] = `export interface ${requestBodyTypeName} {
-${dataFields}
+                                    typeDefinitions[requestBodyTypeName] = `export interface ${requestBodyTypeName} {
+${dataFields}
 }`;
                                 }
                             }
@@ -526,20 +683,32 @@ ${dataFields}
                             if (responseTargetType && endpoint.responseTypeName !== 'void' && endpoint.responseJsdocParams && endpoint.responseJsdocParams.length > 0) {
                                 const responseFields = buildFields(endpoint.responseJsdocParams);
                                 if (responseFields) {
-                                    typeDefinitions[responseTargetType] = `export interface ${responseTargetType} {
-${responseFields}
+                                    typeDefinitions[responseTargetType] = `export interface ${responseTargetType} {
+${responseFields}
 }`;
                                 }
                             }
                         });
                         // 为没有定义的类型添加基本定义
-                        allReferencedTypes.forEach(typeName => {
+                        const fallbackReferencedTypes = [
+                            ...new Set([
+                                ...allReferencedTypes,
+                                ...Object.keys(module.schemas || {}),
+                                ...nestedReferencedTypes,
+                            ])
+                        ];
+                        fallbackReferencedTypes.forEach(typeName => {
                             if (!isValidTypeIdentifier(typeName)) {
                                 return;
                             }
                             if (!typeDefinitions[typeName]) {
-                                typeDefinitions[typeName] = `export interface ${typeName} {
-  [key: string]: any;
+                                const schemaBasedDefinition = buildInterfaceDefinitionFromModuleSchemas(typeName, module.schemas);
+                                if (schemaBasedDefinition) {
+                                    typeDefinitions[typeName] = schemaBasedDefinition;
+                                    return;
+                                }
+                                typeDefinitions[typeName] = `export interface ${typeName} {
+  [key: string]: any;
 }`;
                             }
                         });

package/dist/core/parser.js

@@ -87,11 +87,68 @@ function convertOpenApiTypeToTypeScript(openApiType) {
         case 'number':
             return 'number';
         default:
-            return 'any';
+            return openApiType;
     }
 }
+function resolveSchemaToTypeScript(schema, allSchemas) {
+    if (!schema)
+        return 'any';
+    if (isReferenceObject(schema)) {
+        return getSchemaName(schema.$ref) || 'any';
+    }
+    if (schema.anyOf && Array.isArray(schema.anyOf) && schema.anyOf.length > 0) {
+        const unionTypes = schema.anyOf
+            .map(item => resolveSchemaToTypeScript(item, allSchemas))
+            .filter(Boolean);
+        if (unionTypes.length > 0) {
+            return [...new Set(unionTypes)].join(' | ');
+        }
+    }
+    if (schema.oneOf && Array.isArray(schema.oneOf) && schema.oneOf.length > 0) {
+        const unionTypes = schema.oneOf
+            .map(item => resolveSchemaToTypeScript(item, allSchemas))
+            .filter(Boolean);
+        if (unionTypes.length > 0) {
+            return [...new Set(unionTypes)].join(' | ');
+        }
+    }
+    if (schema.allOf && Array.isArray(schema.allOf) && schema.allOf.length > 0) {
+        const intersectionTypes = schema.allOf
+            .map(item => resolveSchemaToTypeScript(item, allSchemas))
+            .filter(Boolean);
+        if (intersectionTypes.length > 0) {
+            return [...new Set(intersectionTypes)].join(' & ');
+        }
+    }
+    if (schema.type === 'array') {
+        const itemType = resolveSchemaToTypeScript(schema.items, allSchemas);
+        return `${itemType || 'any'}[]`;
+    }
+    if (schema.type === 'object') {
+        if (schema.properties && Object.keys(schema.properties).length > 0) {
+            const requiredSet = new Set(schema.required || []);
+            const inlineFields = Object.entries(schema.properties).map(([key, value]) => {
+                const fieldType = resolveSchemaToTypeScript(value, allSchemas);
+                const optional = requiredSet.has(key) ? '' : '?';
+                return `${key}${optional}: ${fieldType || 'any'}`;
+            });
+            return `{ ${inlineFields.join('; ')} }`;
+        }
+        if (schema.additionalProperties) {
+            if (schema.additionalProperties === true) {
+                return 'Record<string, any>';
+            }
+            const valueType = resolveSchemaToTypeScript(schema.additionalProperties, allSchemas);
+            return `Record<string, ${valueType || 'any'}>`;
+        }
+        return 'any';
+    }
+    const baseType = convertOpenApiTypeToTypeScript(schema.type);
+    const nullable = schema.nullable ? ' | null' : '';
+    return `${baseType}${nullable}`;
+}
 function extractJsdocParamsFromSchema(schema, allSchemas) {
-    var _a;
+    var _a, _b;
     const params = [];
     if (!schema)
         return params;
@@ -106,9 +163,12 @@ function extractJsdocParamsFromSchema(schema, allSchemas) {
     if (targetSchema === null || targetSchema === void 0 ? void 0 : targetSchema.properties) {
         for (const propName in targetSchema.properties) {
             const prop = targetSchema.properties[propName];
-            let propType = 'any';
+            let propType = resolveSchemaToTypeScript(prop, allSchemas);
+            const propDescription = isReferenceObject(prop)
+                ? (((_a = allSchemas[getSchemaName(prop.$ref)]) === null || _a === void 0 ? void 0 : _a.description) || '')
+                : ((prop === null || prop === void 0 ? void 0 : prop.description) || '');
             // 处理 anyOf 数组 (FastAPI 常用的联合类型)
-            if (prop.anyOf && Array.isArray(prop.anyOf)) {
+            if (false && prop.anyOf && Array.isArray(prop.anyOf)) {
                 const types = prop.anyOf.map(item => {
                     if (isReferenceObject(item)) {
                         return getSchemaName(item.$ref);
@@ -130,7 +190,7 @@ function extractJsdocParamsFromSchema(schema, allSchemas) {
                 }
             }
             // 处理 oneOf 数组
-            else if (prop.oneOf && Array.isArray(prop.oneOf)) {
+            else if (false && prop.oneOf && Array.isArray(prop.oneOf)) {
                 const types = prop.oneOf.map(item => {
                     if (isReferenceObject(item)) {
                         return getSchemaName(item.$ref);
@@ -152,14 +212,26 @@ function extractJsdocParamsFromSchema(schema, allSchemas) {
                 }
             }
             // 处理普通类型
-            else if (prop.type) {
-                propType = convertOpenApiTypeToTypeScript(prop.type);
+            else if (false && prop.type) {
+                const propSchema = prop;
+                if (propSchema.type === 'array' && propSchema.items) {
+                    if (isReferenceObject(propSchema.items)) {
+                        propType = `${getSchemaName(propSchema.items.$ref)}[]`;
+                    }
+                    else {
+                        const itemType = convertOpenApiTypeToTypeScript(propSchema.items.type);
+                        propType = `${itemType}[]`;
+                    }
+                }
+                else {
+                    propType = convertOpenApiTypeToTypeScript(propSchema.type);
+                }
             }
             params.push({
                 name: propName,
-                type: propType,
-                description: (prop === null || prop === void 0 ? void 0 : prop.description) || '',
-                required: (_a = targetSchema.required) === null || _a === void 0 ? void 0 : _a.includes(propName)
+                type: propType || 'any',
+                description: propDescription,
+                required: (_b = targetSchema.required) === null || _b === void 0 ? void 0 : _b.includes(propName)
             });
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "czh-api",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "A CLI tool to generate TypeScript API clients from Swagger/OpenAPI documents.",
   "main": "dist/index.js",
   "bin": {