@jayfong/x-server 2.34.0 → 2.35.0

package/lib/_cjs/cli/api_generator.js

@@ -136,7 +136,9 @@ class ApiGenerator {
     this.debug('写入文件...');
     await Promise.all([_fsExtra.default.outputJSON(_path.default.join(this.cwd, 'temp/api.json'), apiData, {
       spaces: 2
-    }), _fsExtra.default.outputJSON(_path.default.join(this.cwd, 'temp/yapi.json'), this.genYApiData(apiData), {
+    }), _fsExtra.default.outputJSON(_path.default.join(this.cwd, 'temp/yapi.json'), this.apiDataToYApiData(apiData), {
+      spaces: 2
+    }), _fsExtra.default.outputJSON(_path.default.join(this.cwd, 'temp/openapi31.json'), this.apiDataToOpenAPI31Data(apiData), {
       spaces: 2
     })]);
   }
@@ -281,7 +283,7 @@ class ApiGenerator {
     }
     return jsonSchema;
   }
-  genYApiData(handles) {
+  apiDataToYApiData(handles) {
     const data = {};
     for (const handle of handles) {
       for (const path of handle.path) {
@@ -344,5 +346,50 @@ class ApiGenerator {
       list: data[cat]
     }));
   }
+  apiDataToOpenAPI31Data(handles) {
+    const data = {
+      openapi: '3.1.0',
+      info: {
+        title: `${process.env.APP_NAME}`,
+        version: '1.0.0'
+      },
+      paths: {},
+      servers: [{
+        url: `${process.env.APP_URL}`,
+        description: '生产'
+      }, {
+        url: `http://127.0.0.1:${process.env.APP_PORT}/`,
+        description: '本地'
+      }]
+    };
+    for (const handle of handles) {
+      for (const path of handle.path) {
+        data.paths[path] = {
+          [handle.method.toLowerCase()]: {
+            tags: [handle.category],
+            summary: handle.name,
+            requestBody: {
+              content: {
+                'application/json': {
+                  schema: handle.requestDataJsonSchema
+                }
+              }
+            },
+            responses: {
+              '200': {
+                description: 'success',
+                content: {
+                  'application/json': {
+                    schema: handle.responseDataJsonSchema
+                  }
+                }
+              }
+            }
+          }
+        };
+      }
+    }
+    return data;
+  }
 }
 exports.ApiGenerator = ApiGenerator;

package/lib/_cjs/cli/cli.js

@@ -8,7 +8,6 @@ var _vscodeGenerateIndexStandalone = require("vscode-generate-index-standalone")
 var _vtils = require("vtils");
 var _yargs = _interopRequireDefault(require("yargs"));
 var _api_generator = require("./api_generator");
-var _api_generator2 = require("./api_generator1");
 var _build_util = require("./build_util");
 var _deploy_util = require("./deploy_util");
 var _dev_util = require("./dev_util");
@@ -124,8 +123,6 @@ _yargs.default.command('dev', '开始开发', _ => _.positional('index', {
   console.log('构建成功');
 }).command('api', '生成 API', async () => {
   await new _api_generator.ApiGenerator().start();
-}).command('api1', '(old) 生成 API', async () => {
-  await new _api_generator2.ApiGenerator1().generate();
 }).command('prisma', 'prisma 代理，主要为了注入环境变量', _ => _.positional('production', {
   alias: 'p',
   describe: '是否生产模式',

package/lib/_cjs/cli/templates/models.ts

@@ -1,31 +1,29 @@
-import { x, HttpError } from '@jayfong/x-server'
-import { PrismaClient, Prisma } from '@prisma/client'
+import { x } from '@jayfong/x-server';
+import { Prisma, PrismaClient } from '@prisma/client';
 
-export const prismaClient = new PrismaClient({
-  rejectOnNotFound: err => new HttpError.NotFound(err.message),
-})
+export const prismaClient = new PrismaClient();
 
-x.dispose.add(() => prismaClient.$disconnect())
+x.dispose.add(() => prismaClient.$disconnect());
 
 type ModelName =
   // @index('../.prisma/client/index.d.ts', /(?<=const ModelName:).+?(?=\})/s, /(\S+?):/g, (m, _) => `| '${_.camel(m[1])}'`)
-  ''
+  '';
 // @endindex
 
 function makeBaseModel<TModelName extends ModelName>(name: TModelName) {
   return class BaseModel {
-    public query = prismaClient[name]
+    public query = prismaClient[name];
 
-    public transactionClient: Prisma.TransactionClient | null = null
+    public transactionClient: Prisma.TransactionClient | null = null;
 
     public transactionify = (tx: Prisma.TransactionClient) => {
       // @ts-ignore
       return new (class extends this.constructor {
-        public query = tx[name]
+        public query = tx[name];
 
-        public transactionClient = tx
-      })() as typeof this
-    }
+        public transactionClient = tx;
+      })() as typeof this;
+    };
 
     public getModel = <T extends ModelName>(
       name: T,
@@ -34,27 +32,29 @@ function makeBaseModel<TModelName extends ModelName>(name: TModelName) {
         ? require('../../src/models')[`${name}Model`].transactionify(
             this.transactionClient,
           )
-        : require('../../src/models')[`${name}Model`]
-    }
-  }
+        : require('../../src/models')[`${name}Model`];
+    };
+  };
 }
 
 // @index('../.prisma/client/index.d.ts', /(?<=const ModelName:).+?(?=\})/s, /(\S+?):/g, (m, _) => `export const ${m[1]}BaseModel = makeBaseModel('${_.camel(m[1])}')`)
 // @endindex
 
-export * from '@prisma/client'
+export * from '@prisma/client';
 
 export const startTransaction = <T>(
-  cb: (models: {
-    [K in ModelName]: typeof import('../../src/models')[`${K}Model`]
-  }) => Promise<T>,
+  cb: (
+    models: {
+      [K in ModelName]: typeof import('../../src/models')[`${K}Model`];
+    },
+  ) => Promise<T>,
 ): Promise<T> => {
   return prismaClient.$transaction(async tx => {
-    const _models = require('../../src/models')
-    const cache = Object.create(null)
+    const _models = require('../../src/models');
+    const cache = Object.create(null);
     return cb({
       // @index('../.prisma/client/index.d.ts', /(?<=const ModelName:).+?(?=\})/s, /(\S+?):/g, (m, _) => `get ${_.camel(m[1])}() { return cache.${_.camel(m[1])} || (cache.${_.camel(m[1])} = _models.${_.camel(m[1])}Model.transactionify(tx)) }, `)
       // @endindex
-    })
-  })
-}
+    });
+  });
+};

package/lib/cli/api_generator.d.ts

@@ -1,5 +1,6 @@
 import createDebug from 'debug';
 import { type JSONSchema4 } from 'json-schema';
+import { type OpenAPIV3_1 } from 'openapi-types';
 import { ts } from 'ts-morph';
 import { LiteralUnion } from 'vtils/types';
 import { type XHandler } from '../core/types';
@@ -43,10 +44,23 @@ export declare class ApiGenerator {
         keySymbol?: ts.Symbol;
     }): ApiDto;
     apiDataToJsonSchema(apiData: ApiDto, jsonSchema?: JSONSchema4): JSONSchema4;
-    genYApiData(handles: ApiData[]): {
+    apiDataToYApiData(handles: ApiData[]): {
         name: string;
         desc: string;
         list: any;
     }[];
+    apiDataToOpenAPI31Data(handles: ApiData[]): Omit<Omit<import("openapi-types").OpenAPIV3.Document<{}>, "paths" | "components">, "info" | "paths" | "components" | "servers" | "webhooks" | "jsonSchemaDialect"> & {
+        info: OpenAPIV3_1.InfoObject;
+        jsonSchemaDialect?: string;
+        servers?: OpenAPIV3_1.ServerObject[];
+    } & Pick<{
+        paths: OpenAPIV3_1.PathsObject<{}, {}>;
+        webhooks: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.PathItemObject<{}>>;
+        components: OpenAPIV3_1.ComponentsObject;
+    }, "paths"> & Omit<Partial<{
+        paths: OpenAPIV3_1.PathsObject<{}, {}>;
+        webhooks: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.PathItemObject<{}>>;
+        components: OpenAPIV3_1.ComponentsObject;
+    }>, "paths">;
 }
 export {};

package/lib/cli/api_generator.js

@@ -131,7 +131,9 @@ export class ApiGenerator {
     this.debug('写入文件...');
     await Promise.all([fs.outputJSON(path.join(this.cwd, 'temp/api.json'), apiData, {
       spaces: 2
-    }), fs.outputJSON(path.join(this.cwd, 'temp/yapi.json'), this.genYApiData(apiData), {
+    }), fs.outputJSON(path.join(this.cwd, 'temp/yapi.json'), this.apiDataToYApiData(apiData), {
+      spaces: 2
+    }), fs.outputJSON(path.join(this.cwd, 'temp/openapi31.json'), this.apiDataToOpenAPI31Data(apiData), {
       spaces: 2
     })]);
   }
@@ -276,7 +278,7 @@ export class ApiGenerator {
     }
     return jsonSchema;
   }
-  genYApiData(handles) {
+  apiDataToYApiData(handles) {
     const data = {};
     for (const handle of handles) {
       for (const path of handle.path) {
@@ -339,4 +341,49 @@ export class ApiGenerator {
       list: data[cat]
     }));
   }
+  apiDataToOpenAPI31Data(handles) {
+    const data = {
+      openapi: '3.1.0',
+      info: {
+        title: `${process.env.APP_NAME}`,
+        version: '1.0.0'
+      },
+      paths: {},
+      servers: [{
+        url: `${process.env.APP_URL}`,
+        description: '生产'
+      }, {
+        url: `http://127.0.0.1:${process.env.APP_PORT}/`,
+        description: '本地'
+      }]
+    };
+    for (const handle of handles) {
+      for (const path of handle.path) {
+        data.paths[path] = {
+          [handle.method.toLowerCase()]: {
+            tags: [handle.category],
+            summary: handle.name,
+            requestBody: {
+              content: {
+                'application/json': {
+                  schema: handle.requestDataJsonSchema
+                }
+              }
+            },
+            responses: {
+              '200': {
+                description: 'success',
+                content: {
+                  'application/json': {
+                    schema: handle.responseDataJsonSchema
+                  }
+                }
+              }
+            }
+          }
+        };
+      }
+    }
+    return data;
+  }
 }

package/lib/cli/cli.js

@@ -5,7 +5,6 @@ import { generateManyIndex } from 'vscode-generate-index-standalone';
 import { castArray, debounce } from 'vtils';
 import yargs from 'yargs';
 import { ApiGenerator } from "./api_generator";
-import { ApiGenerator1 } from "./api_generator1";
 import { BuildUtil } from "./build_util";
 import { DeployUtil } from "./deploy_util";
 import { DevUtil } from "./dev_util";
@@ -121,8 +120,6 @@ yargs.command('dev', '开始开发', _ => _.positional('index', {
   console.log('构建成功');
 }).command('api', '生成 API', async () => {
   await new ApiGenerator().start();
-}).command('api1', '(old) 生成 API', async () => {
-  await new ApiGenerator1().generate();
 }).command('prisma', 'prisma 代理，主要为了注入环境变量', _ => _.positional('production', {
   alias: 'p',
   describe: '是否生产模式',

package/lib/cli/templates/models.ts

@@ -1,31 +1,29 @@
-import { x, HttpError } from '@jayfong/x-server'
-import { PrismaClient, Prisma } from '@prisma/client'
+import { x } from '@jayfong/x-server';
+import { Prisma, PrismaClient } from '@prisma/client';
 
-export const prismaClient = new PrismaClient({
-  rejectOnNotFound: err => new HttpError.NotFound(err.message),
-})
+export const prismaClient = new PrismaClient();
 
-x.dispose.add(() => prismaClient.$disconnect())
+x.dispose.add(() => prismaClient.$disconnect());
 
 type ModelName =
   // @index('../.prisma/client/index.d.ts', /(?<=const ModelName:).+?(?=\})/s, /(\S+?):/g, (m, _) => `| '${_.camel(m[1])}'`)
-  ''
+  '';
 // @endindex
 
 function makeBaseModel<TModelName extends ModelName>(name: TModelName) {
   return class BaseModel {
-    public query = prismaClient[name]
+    public query = prismaClient[name];
 
-    public transactionClient: Prisma.TransactionClient | null = null
+    public transactionClient: Prisma.TransactionClient | null = null;
 
     public transactionify = (tx: Prisma.TransactionClient) => {
       // @ts-ignore
       return new (class extends this.constructor {
-        public query = tx[name]
+        public query = tx[name];
 
-        public transactionClient = tx
-      })() as typeof this
-    }
+        public transactionClient = tx;
+      })() as typeof this;
+    };
 
     public getModel = <T extends ModelName>(
       name: T,
@@ -34,27 +32,29 @@ function makeBaseModel<TModelName extends ModelName>(name: TModelName) {
         ? require('../../src/models')[`${name}Model`].transactionify(
             this.transactionClient,
           )
-        : require('../../src/models')[`${name}Model`]
-    }
-  }
+        : require('../../src/models')[`${name}Model`];
+    };
+  };
 }
 
 // @index('../.prisma/client/index.d.ts', /(?<=const ModelName:).+?(?=\})/s, /(\S+?):/g, (m, _) => `export const ${m[1]}BaseModel = makeBaseModel('${_.camel(m[1])}')`)
 // @endindex
 
-export * from '@prisma/client'
+export * from '@prisma/client';
 
 export const startTransaction = <T>(
-  cb: (models: {
-    [K in ModelName]: typeof import('../../src/models')[`${K}Model`]
-  }) => Promise<T>,
+  cb: (
+    models: {
+      [K in ModelName]: typeof import('../../src/models')[`${K}Model`];
+    },
+  ) => Promise<T>,
 ): Promise<T> => {
   return prismaClient.$transaction(async tx => {
-    const _models = require('../../src/models')
-    const cache = Object.create(null)
+    const _models = require('../../src/models');
+    const cache = Object.create(null);
     return cb({
       // @index('../.prisma/client/index.d.ts', /(?<=const ModelName:).+?(?=\})/s, /(\S+?):/g, (m, _) => `get ${_.camel(m[1])}() { return cache.${_.camel(m[1])} || (cache.${_.camel(m[1])} = _models.${_.camel(m[1])}Model.transactionify(tx)) }, `)
       // @endindex
-    })
-  })
-}
+    });
+  });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jayfong/x-server",
-  "version": "2.34.0",
+  "version": "2.35.0",
   "license": "ISC",
   "sideEffects": false,
   "main": "lib/_cjs/index.js",
@@ -9,9 +9,7 @@
   "bin": {
     "xs": "lib/_cjs/cli/cli.js"
   },
-  "files": [
-    "lib"
-  ],
+  "files": ["lib"],
   "scripts": {
     "build": "haoma compile",
     "build_test_pkg": "tyn build && rm -rf ./lib_test && mkdir -p ./lib_test && cp -r ./lib ./lib_test/lib && cp ./package.json ./lib_test/package.json && cd ./tests/app && tyn add file:../../lib_test",
@@ -19,16 +17,14 @@
     "test": "tsc --noEmit -p ./tsconfig.build.json && jest \"$(pwd)/src/\"",
     "test_all": "tsc --noEmit -p ./tsconfig.build.json && jest",
     "test_api_bot": "cd /Users/admin/Documents/jfWorks/qiqi-bot && DEBUG=api tsx /Users/admin/Documents/jfWorks/x/packages/x-server/src/cli/cli.ts api",
-    "test_api_qiqi": "cd /Users/admin/Documents/jfWorks/qiqi-server && DEBUG=api tsx /Users/admin/Documents/jfWorks/x/packages/x-server/src/cli/cli.ts api",
-    "test_api1_bot": "cd /Users/admin/Documents/jfWorks/qiqi-bot && DEBUG=api1 tsx /Users/admin/Documents/jfWorks/x/packages/x-server/src/cli/cli.ts api1",
-    "test_api1_qiqi": "cd /Users/admin/Documents/jfWorks/qiqi-server && DEBUG=api1 tsx /Users/admin/Documents/jfWorks/x/packages/x-server/src/cli/cli.ts api1"
+    "test_api_qiqi": "cd /Users/admin/Documents/jfWorks/qiqi-server && DEBUG=api tsx /Users/admin/Documents/jfWorks/x/packages/x-server/src/cli/cli.ts api"
   },
   "dependencies": {
     "@fastify/cors": "^8.3.0",
     "@fastify/formbody": "^7.4.0",
     "@fastify/multipart": "^7.7.0",
     "@fastify/websocket": "^8.1.0",
-    "@prisma/client": "^4.8.0",
+    "@prisma/client": "^5.8.0",
     "@types/busboy": "^0.3.2",
     "@types/http-errors": "^1.8.2",
     "@types/jsonwebtoken": "^8.5.8",
@@ -62,7 +58,7 @@
     "nodemailer": "^6.7.3",
     "pino-pretty": "^10.0.1",
     "pirates": "^4.0.6",
-    "prisma": "^4.8.0",
+    "prisma": "^5.8.0",
     "select-run": "^1.1.2",
     "supports-color": "^8",
     "svg-captcha": "^1.4.0",
@@ -85,7 +81,8 @@
     "ioredis-mock": "^8.7.0",
     "json-xml-parse": "^1.2.4",
     "node-fetch": "^3.3.1",
-    "npm-check-updates": "^12.5.9"
+    "npm-check-updates": "^12.5.9",
+    "openapi-types": "^12.1.3"
   },
   "publishConfig": {
     "access": "public"

package/lib/_cjs/cli/api_generator1.js

@@ -1,286 +0,0 @@
-"use strict";
-
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.ApiGenerator1 = void 0;
-var _nodePath = _interopRequireDefault(require("node:path"));
-var parseComment = _interopRequireWildcard(require("comment-parser"));
-var _debug = _interopRequireDefault(require("debug"));
-var _fsExtra = _interopRequireDefault(require("fs-extra"));
-var ts = _interopRequireWildcard(require("ts-morph"));
-var _vtils = require("vtils");
-var _http_method = require("../core/http_method");
-class ApiGenerator1 {
-  constructor() {
-    this.debug = (0, _debug.default)('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 ? (0, _vtils.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: _nodePath.default.join(this.cwd, 'tsconfig.json')
-    });
-    this.debug('加载文件...');
-    const sourceFile = this.project.createSourceFile(_nodePath.default.join(this.cwd, 'src/generated/handlers.ts'), await _fsExtra.default.readFile(_nodePath.default.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 => (0, _vtils.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 = (0, _vtils.pascalCase)(basePath) || 'Index';
-        const handlerName = handlerComment.description || handlerPath;
-        const handlerMethod = methodType.getLiteralValueOrThrow();
-        const serverMethod = _http_method.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([_fsExtra.default.outputJSON(_nodePath.default.join(this.cwd, 'temp/api1.json'), handles, {
-      spaces: 2
-    }), _fsExtra.default.outputJSON(_nodePath.default.join(this.cwd, 'temp/yapi1.json'), this.genYApiData(handles), {
-      spaces: 2
-    })]);
-  }
-}
-
-// new ApiGenerator().generate()
-exports.ApiGenerator1 = ApiGenerator1;

package/lib/cli/api_generator1.d.ts

@@ -1,44 +0,0 @@
-import createDebug from 'debug';
-import type { JSONSchema4 } from 'json-schema';
-import * as ts from 'ts-morph';
-import type { XHandler } from '../core/types';
-interface ApiData {
-    name: string;
-    desc: string;
-    type: 'string' | 'number' | 'boolean' | 'object' | 'array' | 'file';
-    enum: any[];
-    required: boolean;
-    children: ApiData[];
-}
-type ApiHandles = Array<{
-    category: string;
-    name: string;
-    path: string;
-    handlerMethod: XHandler.Method;
-    method: string;
-    requestData: ApiData;
-    responseData: ApiData;
-    requestDataJsonSchema: JSONSchema4;
-    responseDataJsonSchema: JSONSchema4;
-}>;
-export declare class ApiGenerator1 {
-    debug: createDebug.Debugger;
-    cwd: string;
-    project: ts.Project;
-    getTypeBySymbol(symbol: ts.Symbol): ts.Type;
-    getComment(declaration?: ts.Node): {
-        existing: boolean;
-        description: string;
-        tags: Map<string, string>;
-    };
-    getCommentBySymbol(symbol: ts.Symbol): string;
-    typeToApiData(type: ts.Type, _symbol?: ts.Symbol): ApiData;
-    apiDataToJsonSchema(apiData: ApiData, jsonSchema?: JSONSchema4): JSONSchema4;
-    genYApiData(handles: ApiHandles): {
-        name: string;
-        desc: string;
-        list: any;
-    }[];
-    generate(): Promise<void>;
-}
-export {};

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()