koa-ts-core 0.2.1 → 0.3.0

package/dist/{init → core}/register_middleware.d.ts

@@ -1,5 +1,6 @@
 import { ErrorConfig, Koa2CorsFn, PhaseMiddlewareMap, TrackIdConfig } from '../types/core';
 import Koa from "koa";
+import { Options as BodyParserOptions } from "koa-bodyparser";
 /**
  * 注册中间件
  * @param app
@@ -10,5 +11,6 @@ declare const registerMiddleware: (app: Koa, phaseMiddlewares: PhaseMiddlewareMa
     errorConfig?: ErrorConfig;
     koa2Cors?: Koa2CorsFn;
     trackConfig: TrackIdConfig;
+    bodyParser?: BodyParserOptions;
 }) => void;
 export default registerMiddleware;

package/dist/{init → core}/register_route.d.ts

@@ -3,8 +3,9 @@ import { AuthRouterHandler, FilePathMeta, RouteConfig } from '../types/route';
  * 注册路由
  * @param validateModulePath validate 根目录路径
  * @param filePath 控制器文件路径元信息
+ * @param controllerClass 控制器类
  * @param routesMap 路由映射
  * @param authCheckResult 鉴权结果处理函数
  */
-declare const registerRoute: (validateModulePath: string, filePath: FilePathMeta, routesMap: Map<string, RouteConfig>, authCheckResult: AuthRouterHandler) => void;
+declare const registerRoute: (validateModulePath: string, filePath: FilePathMeta, controllerClass: any, routesMap: Map<string, RouteConfig>, authCheckResult: AuthRouterHandler) => void;
 export default registerRoute;

package/dist/core/render_doc.d.ts

@@ -0,0 +1,12 @@
+import { IMetaData } from '../types/meta_data';
+export type TClassMeta = {
+    configs: IMetaData[];
+    desc: string;
+    name: string;
+    apiPrePath: string;
+    pathPrefix: string;
+};
+/**
+ * 扫描 doc 目录并提取元数据
+ */
+export declare const scanDocMetadata: () => TClassMeta[];

package/dist/core/swagger_collector.d.ts

@@ -0,0 +1,22 @@
+export declare class SwaggerCollector {
+    private static instance;
+    private paths;
+    static getInstance(): SwaggerCollector;
+    /**
+     * 添加路由定义到 Swagger Spec
+     */
+    addRoute(controllerClass: any, functionName: string, method: string, fullPath: string): void;
+    loadDocMetadata(): void;
+    generateSpec(): {
+        openapi: string;
+        info: {
+            title: string;
+            version: string;
+            description: string;
+        };
+        paths: any;
+        components: {
+            schemas: {};
+        };
+    };
+}

package/dist/decorators/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./router";
+export * from "./validate";
+export * from "./swagger";

package/dist/{decorate/router_decorate.d.ts → decorators/router.d.ts}

@@ -1,14 +1,6 @@
 import { HttpMethod } from '../types/route';
+import "reflect-metadata";
 export declare const INDEX_ROUTE = "index";
-/**
- * 注册路由
- * @param method HTTP 请求方法
- * @param path 路由地址，可选，默认根据函数名推断
- */
+export declare const ROUTE_METADATA_KEY: unique symbol;
 export declare function Router(method?: HttpMethod, path?: string): (target: any, functionName: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-/**
- * 注册「需要鉴权」的路由
- * @param method HTTP 请求方法
- * @param path 路由地址，可选，默认根据函数名推断
- */
 export declare function AuthRouter(method?: HttpMethod, path?: string): (target: any, functionName: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/decorators/swagger.d.ts

@@ -0,0 +1,51 @@
+import "reflect-metadata";
+export declare const SWAGGER_TAGS_KEY: unique symbol;
+export declare const SWAGGER_OPERATION_KEY: unique symbol;
+export declare const SWAGGER_PARAMETERS_KEY: unique symbol;
+export declare const SWAGGER_BODY_KEY: unique symbol;
+export declare const SWAGGER_RESPONSES_KEY: unique symbol;
+/**
+ * 定义控制器标签
+ * @param tags 标签列表
+ */
+export declare function ApiTags(tags: string[]): (target: any) => void;
+/**
+ * 定义接口摘要和描述
+ * @param summary 摘要
+ * @param description 详细描述
+ */
+export declare function ApiOperation(summary: string, description?: string): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+export interface ApiParamOptions {
+    name: string;
+    required?: boolean;
+    type?: string;
+    description?: string;
+    example?: any;
+}
+/**
+ * 定义 Query 参数
+ */
+export declare function ApiQuery(options: ApiParamOptions): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+ * 定义 Path 参数
+ */
+export declare function ApiParam(options: ApiParamOptions): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+export interface ApiBodyOptions {
+    description?: string;
+    required?: boolean;
+    schema?: any;
+}
+/**
+ * 定义 Request Body
+ */
+export declare function ApiBody(options: ApiBodyOptions): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+export interface ApiResponseOptions {
+    status: number;
+    description?: string;
+    type?: any;
+    schema?: any;
+}
+/**
+ * 定义响应
+ */
+export declare function ApiResponse(options: ApiResponseOptions): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/dist/decorators/validate.d.ts

@@ -0,0 +1,9 @@
+import "reflect-metadata";
+import { Context } from "koa";
+export declare const VALIDATE_METADATA_KEY: unique symbol;
+export type ValidatorFn = (ctx: Context) => void | Promise<void>;
+/**
+ * 参数校验装饰器
+ * @param validator 校验函数
+ */
+export declare function Validate(validator: ValidatorFn): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/{base/exception.d.ts → exceptions/base.d.ts}

@@ -8,6 +8,7 @@ interface ExceptionOptions {
  */
 declare abstract class BaseException extends Error {
     code: number;
+    statusCode: number;
     constructor(options?: ExceptionOptions);
     get toRspOptions(): {
         code: number;

package/dist/exceptions/index.d.ts

@@ -0,0 +1 @@
+export { default as BaseException } from "./base";

package/dist/global.d.ts

@@ -1,13 +1,17 @@
 import "koa";
 
 declare module "koa" {
+  interface Request {
+    body?: any;
+  }
+
   interface DefaultContext {
     // trackId
     trackId?: string;
     // log4js
     log4?: import("log4js").Log4js;
     // hook
-    hook?: (ctx: Koa.Context, type: "request" | "response" | "error") => void;
+    hook?: (ctx: Context, type: "request" | "response" | "error") => void;
     // runtimeLog
     runtimeLog: boolean;
     // 验证过的参数