@jayfong/x-server 2.32.0 → 2.35.0

package/lib/cli/api_generator1.js

@@ -1,279 +0,0 @@
-import path from 'node:path';
-import * as parseComment from 'comment-parser';
-import createDebug from 'debug';
-import fs from 'fs-extra';
-import * as ts from 'ts-morph';
-import { ii, pascalCase, snakeCase } from 'vtils';
-import { HandlerMethodToHttpMethod } from "../core/http_method";
-export class ApiGenerator1 {
-  constructor() {
-    this.debug = createDebug('api1');
-    this.cwd = process.cwd();
-    // cwd = '/Users/admin/Documents/jfWorks/x-server-test'
-    this.project = void 0;
-  }
-  getTypeBySymbol(symbol) {
-    return symbol.getTypeAtLocation(symbol.getDeclarations()[0] || symbol.getValueDeclarationOrThrow());
-  }
-  getComment(declaration) {
-    var _declaration$getLeadi;
-    const text = ((declaration == null || (_declaration$getLeadi = declaration.getLeadingCommentRanges()[0]) == null ? void 0 : _declaration$getLeadi.getText()) || '').trim();
-    const comment = parseComment.parse(text)[0];
-    const description = (comment == null ? void 0 : comment.description) || '';
-    const tags = new Map();
-    comment == null ? void 0 : comment.tags.forEach(tag => {
-      tags.set(tag.tag, tag.description);
-    });
-    return {
-      existing: !!comment,
-      description: description,
-      tags: tags
-    };
-  }
-  getCommentBySymbol(symbol) {
-    var _this$getComment;
-    return ((_this$getComment = this.getComment(symbol.getDeclarations()[0])) == null ? void 0 : _this$getComment.description) || '';
-  }
-  typeToApiData(type, _symbol) {
-    var _type$getSymbol, _type$getSymbol2, _type$getSymbol3;
-    // ws
-    if (((_type$getSymbol = type.getSymbol()) == null ? void 0 : _type$getSymbol.getName()) === 'SocketStream') {
-      return {
-        name: 'ws',
-        desc: 'ws',
-        required: false,
-        type: 'object',
-        children: [],
-        enum: []
-      };
-    }
-
-    // XFile
-    if (((_type$getSymbol2 = type.getSymbol()) == null ? void 0 : _type$getSymbol2.getName()) === 'MultipartFile') {
-      const symbol = _symbol || type.getSymbol();
-      return {
-        name: 'file',
-        desc: symbol && this.getCommentBySymbol(symbol) || '',
-        required: !!symbol && !(symbol.getFlags() & ts.SymbolFlags.Optional),
-        type: 'file',
-        children: [],
-        enum: []
-      };
-    }
-    let isRequired = true;
-    let isUnion = type.isUnion();
-    const unionTypes = isUnion ? type.getUnionTypes().filter(item => !item.isBooleanLiteral() && !item.isNull() && !item.isUndefined()) : [];
-    isUnion = !!unionTypes.length;
-    if (isUnion) {
-      if (unionTypes.length === 1 && !unionTypes[0].isLiteral()) {
-        isUnion = false;
-      }
-      // 兼容 prisma 生成的类型用 null 表示可选
-      isRequired = unionTypes.length === type.getUnionTypes().length;
-      // 必须用 getBaseTypeOfLiteralType 获取枚举字面量的原始类型
-      type = unionTypes[0].getBaseTypeOfLiteralType();
-    }
-    const isEnum = type.isEnum();
-    const enumData = isEnum ?
-    // @ts-ignore
-    type.compilerType.types.reduce((res, item) => {
-      res[item.getSymbol().getName()] = item.value;
-      return res;
-    }, {}) : {};
-    const enumKeys = Object.keys(enumData);
-    const enumValues = Object.values(enumData);
-    const isIntersection = type.isIntersection();
-    const intersectionTypes = isIntersection && type.getIntersectionTypes();
-    const isArray = type.isArray();
-    const isString = isEnum ? typeof enumValues[0] === 'string' : type.isString() || ['Date'].includes(((_type$getSymbol3 = type.getSymbol()) == null ? void 0 : _type$getSymbol3.getName()) || '');
-    const isNumber = isEnum ? typeof enumValues[0] === 'number' : type.isNumber();
-    const isBoolean = type.isBoolean() || type.isUnion() && type.getUnionTypes().some(item => item.isBooleanLiteral()) && type.getUnionTypes().every(item => item.isBooleanLiteral() || item.isNull() || item.isUndefined());
-    const isObject = !isArray && !isString && !isNumber && !isBoolean && type.isObject() ||
-    // 将交集类型视为对象
-    isIntersection;
-    const symbol = _symbol || type.getSymbol();
-    const parentSymbol = symbol;
-    const apiName = (symbol == null ? void 0 : symbol.getName()) || '__type';
-    const apiDesc = [symbol && this.getCommentBySymbol(symbol), isEnum && `枚举：${enumKeys.map((key, index) => `${key}->${enumValues[index]}`).join('; ')}`].filter(Boolean).join('\n');
-    const apiEnum = isUnion ? unionTypes.map(t => t.getLiteralValue()) : isEnum ? enumValues : [];
-    const apiType = isArray ? 'array' : isString ? 'string' : isNumber ? 'number' : isBoolean ? 'boolean' : 'object';
-    const apiRequired = isRequired === false ? false : !!symbol && !(symbol.getFlags() & ts.SymbolFlags.Optional);
-    const apiChildren = isArray ? [this.typeToApiData(type.getArrayElementTypeOrThrow())] : isObject ? ii(() => {
-      const context = type._context;
-      const compilerFactory = context.compilerFactory;
-      const rawChecker = type.compilerType.checker;
-      let symbols = [];
-      if (intersectionTypes) {
-        // https://github.com/microsoft/TypeScript/issues/38184
-        symbols = rawChecker.getAllPossiblePropertiesOfTypes(intersectionTypes.map(item => item.compilerType))
-        // https://github.com/dsherret/ts-morph/blob/a7072fcf6f9babb784b40f0326c80dea4563a4aa/packages/ts-morph/src/compiler/types/Type.ts#L296
-        .map(symbol => compilerFactory.getSymbol(symbol));
-      } else {
-        // symbols = type.getApparentProperties()
-        // https://github.com/microsoft/TypeScript/issues/38184
-        symbols = rawChecker.getAllPossiblePropertiesOfTypes([type.compilerType])
-        // https://github.com/dsherret/ts-morph/blob/a7072fcf6f9babb784b40f0326c80dea4563a4aa/packages/ts-morph/src/compiler/types/Type.ts#L296
-        .map(symbol => compilerFactory.getSymbol(symbol));
-      }
-      return symbols.map(symbol => {
-        return this.typeToApiData(!symbol.compilerSymbol.declarations ?
-        // 对于复杂对象，没有定义的，通过 type 直接获取（在前面通过 getText 预处理得到）
-        symbol.compilerSymbol.type ? compilerFactory.getType(symbol.compilerSymbol.type) :
-        // fix: symbol.compilerSymbol.type 为 undefined
-        // https://github.com/styleguidist/react-docgen-typescript/blob/master/src/parser.ts#L696
-        compilerFactory.getType(rawChecker.getTypeOfSymbolAtLocation(
-        // @ts-ignore
-        symbol.compilerSymbol,
-        // @ts-ignore
-        parentSymbol.compilerSymbol.declarations[0])) : this.getTypeBySymbol(symbol), symbol);
-      });
-    }) : [];
-    return {
-      name: apiName,
-      desc: apiDesc,
-      enum: apiEnum,
-      type: apiType,
-      required: apiRequired,
-      children: apiChildren
-    };
-  }
-  apiDataToJsonSchema(apiData, jsonSchema = {}) {
-    jsonSchema.description = apiData.desc;
-    if (apiData.type === 'object') {
-      jsonSchema.type = 'object';
-      jsonSchema.properties = apiData.children.reduce((res, item) => {
-        res[item.name] = this.apiDataToJsonSchema(item);
-        return res;
-      }, {});
-      jsonSchema.required = apiData.children.filter(item => item.required).map(item => item.name);
-    } else if (apiData.type === 'array') {
-      jsonSchema.type = 'array';
-      jsonSchema.items = apiData.children.map(item => this.apiDataToJsonSchema(item))[0];
-    } else {
-      jsonSchema.type = apiData.type;
-      if (apiData.enum.length) {
-        jsonSchema.enum = apiData.enum;
-      }
-    }
-    return jsonSchema;
-  }
-  genYApiData(handles) {
-    const data = {};
-    for (const handle of handles) {
-      data[handle.category] = data[handle.category] || [];
-      data[handle.category].push(handle.handlerMethod === 'GET' ? {
-        method: handle.method.toUpperCase(),
-        title: handle.name,
-        path: handle.path,
-        res_body_type: 'json',
-        req_body_is_json_schema: false,
-        res_body_is_json_schema: true,
-        req_params: [],
-        req_query: handle.requestData.children.map(item => ({
-          required: item.required ? 1 : 0,
-          name: item.name,
-          desc: item.desc,
-          type: 'string'
-        })),
-        req_headers: [],
-        req_body_form: [],
-        res_body: JSON.stringify(handle.responseDataJsonSchema)
-      } : handle.handlerMethod === 'FILE' ? {
-        method: handle.method.toUpperCase(),
-        title: handle.name,
-        path: handle.path,
-        req_body_type: 'form',
-        res_body_type: 'json',
-        req_body_is_json_schema: false,
-        res_body_is_json_schema: true,
-        req_params: [],
-        req_query: [],
-        req_headers: [],
-        req_body_form: handle.requestData.children.map(item => ({
-          required: item.required ? 1 : 0,
-          name: item.name,
-          desc: item.desc,
-          type: item.type === 'file' ? 'file' : 'text'
-        })),
-        res_body: JSON.stringify(handle.responseDataJsonSchema)
-      } : {
-        method: handle.method.toUpperCase(),
-        title: handle.name,
-        path: handle.path,
-        req_body_type: 'json',
-        res_body_type: 'json',
-        req_body_is_json_schema: true,
-        res_body_is_json_schema: true,
-        req_params: [],
-        req_query: [],
-        req_headers: [],
-        req_body_form: [],
-        req_body_other: JSON.stringify(handle.requestDataJsonSchema),
-        res_body: JSON.stringify(handle.responseDataJsonSchema)
-      });
-    }
-    return Object.keys(data).map(cat => ({
-      name: cat,
-      desc: cat,
-      list: data[cat]
-    }));
-  }
-  async generate() {
-    this.debug('启动项目...');
-    this.project = new ts.Project({
-      tsConfigFilePath: path.join(this.cwd, 'tsconfig.json')
-    });
-    this.debug('加载文件...');
-    const sourceFile = this.project.createSourceFile(path.join(this.cwd, 'src/generated/handlers.ts'), await fs.readFile(path.join(this.cwd, 'node_modules/.x/handlers.ts'), 'utf-8'));
-    this.debug('导出处理器...');
-    const handlerGroup = sourceFile.getExportSymbols();
-    const handles = [];
-    this.debug('生成API文档...');
-    for (const handlerList of handlerGroup) {
-      const handlerListSourceFile = this.getTypeBySymbol(handlerList).getProperties()[0].getDeclarations()[0].getSourceFile();
-      const basePath = `/${handlerListSourceFile.getFilePath().replace('.ts', '').split('/src/handlers/')[1].replace(/(^|\/)index$/, '/').split('/').map(v => snakeCase(v)).join('/')}/`.replace(/\/{2,}/g, '/');
-      for (const handler of handlerListSourceFile.getVariableStatements().filter(item => item.isExported())) {
-        // 重要：这一步必须，先调一遍 getText 获取看到的对象，后续对于复杂定义才不会报错
-        handler.getDeclarations().forEach(exp => {
-          exp.getType().getText();
-        });
-        const handlerExp = handler.getDeclarations()[0];
-        const handlerPath = `${basePath}${handlerExp.getName()}`;
-        this.debug('生成接口: %s ...', handlerPath);
-        const [requestType, responseType, methodType] = handlerExp.getType().getTypeArguments();
-        const handlerComment = this.getComment(handlerExp.getParent().getParent());
-        if (handlerComment.tags.has('private')) {
-          this.debug('跳过生成接口: %s', `${handlerPath}`);
-          continue;
-        }
-        const handlerCategory = pascalCase(basePath) || 'Index';
-        const handlerName = handlerComment.description || handlerPath;
-        const handlerMethod = methodType.getLiteralValueOrThrow();
-        const serverMethod = HandlerMethodToHttpMethod[handlerMethod];
-        const requestData = this.typeToApiData(requestType);
-        const responseData = this.typeToApiData(responseType);
-        const requestDataJsonSchema = this.apiDataToJsonSchema(requestData);
-        const responseDataJsonSchema = this.apiDataToJsonSchema(responseData);
-        handles.push({
-          category: handlerCategory,
-          name: handlerName,
-          path: handlerPath,
-          handlerMethod: handlerMethod,
-          method: serverMethod,
-          requestData: requestData,
-          responseData: responseData,
-          requestDataJsonSchema: requestDataJsonSchema,
-          responseDataJsonSchema: responseDataJsonSchema
-        });
-      }
-    }
-    this.debug('写入文件...');
-    await Promise.all([fs.outputJSON(path.join(this.cwd, 'temp/api1.json'), handles, {
-      spaces: 2
-    }), fs.outputJSON(path.join(this.cwd, 'temp/yapi1.json'), this.genYApiData(handles), {
-      spaces: 2
-    })]);
-  }
-}
-
-// new ApiGenerator().generate()