@eggjs/controller-decorator 4.0.0-beta.6 → 4.0.0-beta.8

package/dist/index.d.ts

@@ -1,24 +1,248 @@
-import { ControllerMetaBuilderFactory } from "./builder/ControllerMetaBuilderFactory.js";
-import { Host } from "./decorator/http/Host.js";
-import { HTTPController } from "./decorator/http/HTTPController.js";
-import { HTTPMethod } from "./decorator/http/HTTPMethod.js";
-import { Cookies, HTTPBody, HTTPHeaders, HTTPParam, HTTPQueries, HTTPQuery, Request } from "./decorator/http/HTTPParam.js";
-import { Acl } from "./decorator/Acl.js";
-import { Context } from "./decorator/Context.js";
-import { Middleware } from "./decorator/Middleware.js";
-import { BodyParamMeta, CookiesParamMeta, HTTPMethodMeta, HeadersParamMeta, ParamMeta, ParamMetaUtil, PathParamMeta, QueriesParamMeta, QueryParamMeta, RequestParamMeta } from "./model/HTTPMethodMeta.js";
-import { HTTPControllerMeta } from "./model/HTTPControllerMeta.js";
-import { HTTPCookies } from "./model/HTTPCookies.js";
-import { HTTPRequest } from "./model/HTTPRequest.js";
-import { HTTPResponse } from "./model/HTTPResponse.js";
-import { HTTPControllerMetaBuilder } from "./impl/http/HTTPControllerMetaBuilder.js";
-import { HTTPControllerMethodMetaBuilder } from "./impl/http/HTTPControllerMethodMetaBuilder.js";
-import { ControllerValidator } from "./util/validator/ControllerValidator.js";
-import { MethodValidator } from "./util/validator/MethodValidator.js";
-import { ControllerInfoUtil } from "./util/ControllerInfoUtil.js";
-import { ControllerMetadataUtil } from "./util/ControllerMetadataUtil.js";
-import { HTTPInfoUtil } from "./util/HTTPInfoUtil.js";
-import { HTTPPriorityUtil } from "./util/HTTPPriorityUtil.js";
-import { MethodInfoUtil } from "./util/MethodInfoUtil.js";
+import { ControllerMetaBuilder, ControllerMetaBuilderCreator, ControllerMetadata, ControllerType, ControllerTypeLike, EggProtoImplClass, EggPrototypeName, HTTPControllerParams, HTTPMethodEnum, HTTPMethodParams, HTTPParamParams, HTTPParamType, HTTPQueriesParams, HTTPQueryParams, HostType, IAdvice, MethodMeta, MiddlewareFunc } from "@eggjs/tegg-types";
+import { Cookies as Cookies$1 } from "@eggjs/cookies";
 export * from "@eggjs/tegg-types/controller-decorator";
-export { Acl, BodyParamMeta, Context, ControllerInfoUtil, ControllerMetaBuilderFactory, ControllerMetadataUtil, ControllerValidator, Cookies, CookiesParamMeta, HTTPBody, HTTPController, HTTPControllerMeta, HTTPControllerMetaBuilder, HTTPControllerMethodMetaBuilder, HTTPCookies, HTTPHeaders, HTTPInfoUtil, HTTPMethod, HTTPMethodMeta, HTTPParam, HTTPPriorityUtil, HTTPQueries, HTTPQuery, HTTPRequest, HTTPResponse, HeadersParamMeta, Host, MethodInfoUtil, MethodValidator, Middleware, ParamMeta, ParamMetaUtil, PathParamMeta, QueriesParamMeta, QueryParamMeta, Request, RequestParamMeta };
+
+//#region src/builder/ControllerMetaBuilderFactory.d.ts
+declare class ControllerMetaBuilderFactory {
+  private static builderCreatorMap;
+  static registerControllerMetaBuilder(controllerType: ControllerTypeLike, controllerBuilderCreator: ControllerMetaBuilderCreator): void;
+  static createControllerMetaBuilder(clazz: EggProtoImplClass, controllerType?: ControllerTypeLike): ControllerMetaBuilder | undefined;
+  static build(clazz: EggProtoImplClass, controllerType?: ControllerTypeLike): ControllerMetadata | undefined;
+}
+//#endregion
+//#region src/decorator/http/Host.d.ts
+declare function Host(host: HostType): (target: any, propertyKey?: PropertyKey) => void;
+//#endregion
+//#region src/decorator/http/HTTPController.d.ts
+declare function HTTPController(param?: HTTPControllerParams): (constructor: EggProtoImplClass) => void;
+//#endregion
+//#region src/decorator/http/HTTPMethod.d.ts
+declare function HTTPMethod(param: HTTPMethodParams): (target: any, propertyKey: PropertyKey) => void;
+//#endregion
+//#region src/decorator/http/HTTPParam.d.ts
+declare function HTTPBody(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+declare function HTTPHeaders(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+declare function HTTPQuery(param?: HTTPQueryParams): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+declare function HTTPQueries(param?: HTTPQueriesParams): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+declare function HTTPParam(param?: HTTPParamParams): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+declare function Request$1(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+declare function Cookies(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+//#endregion
+//#region src/decorator/Acl.d.ts
+declare function Acl(code?: string): (target: any, propertyKey?: PropertyKey) => void;
+//#endregion
+//#region src/decorator/Context.d.ts
+declare function Context(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+//#endregion
+//#region src/decorator/Middleware.d.ts
+declare function Middleware(...middlewares: Array<MiddlewareFunc> | Array<EggProtoImplClass<IAdvice>>): (target: any, propertyKey?: PropertyKey) => void;
+//#endregion
+//#region src/model/HTTPMethodMeta.d.ts
+declare abstract class ParamMeta {
+  type: HTTPParamType;
+  abstract validate(httpPath: string): void;
+}
+declare class RequestParamMeta extends ParamMeta {
+  type: HTTPParamType;
+  validate(): void;
+}
+declare class BodyParamMeta extends ParamMeta {
+  type: HTTPParamType;
+  validate(): void;
+}
+declare class HeadersParamMeta extends ParamMeta {
+  type: HTTPParamType;
+  validate(): void;
+}
+declare class QueryParamMeta extends ParamMeta {
+  type: HTTPParamType;
+  name: string;
+  constructor(name: string);
+  validate(): void;
+}
+declare class QueriesParamMeta extends ParamMeta {
+  type: HTTPParamType;
+  name: string;
+  constructor(name: string);
+  validate(): void;
+}
+declare class PathParamMeta extends ParamMeta {
+  type: HTTPParamType;
+  name: string;
+  constructor(name: string);
+  validate(httpPath: string): void;
+}
+declare class CookiesParamMeta extends ParamMeta {
+  type: HTTPParamType;
+  validate(): void;
+}
+declare class HTTPMethodMeta implements MethodMeta {
+  readonly name: string;
+  readonly path: string;
+  readonly method: HTTPMethodEnum;
+  readonly middlewares: readonly MiddlewareFunc[];
+  readonly contextParamIndex: number | undefined;
+  readonly paramMap: Map<number, ParamMeta>;
+  readonly priority: number;
+  readonly needAcl: boolean;
+  readonly aclCode: string | undefined;
+  readonly hosts: string[] | undefined;
+  constructor(name: string, path: string, method: HTTPMethodEnum, middlewares: MiddlewareFunc[], contextParamIndex: number | undefined, paramTypeMap: Map<number, ParamMeta>, priority: number, needAcl: boolean, aclCode: string | undefined, hosts: string[] | undefined);
+}
+declare class ParamMetaUtil {
+  static createParam(type: HTTPParamType, name?: string): RequestParamMeta | BodyParamMeta | HeadersParamMeta | QueryParamMeta | QueriesParamMeta | PathParamMeta | CookiesParamMeta;
+}
+//#endregion
+//#region src/model/HTTPControllerMeta.d.ts
+declare class HTTPControllerMeta implements ControllerMetadata {
+  readonly protoName: EggPrototypeName;
+  readonly controllerName: string;
+  readonly className: string;
+  readonly type = ControllerType.HTTP;
+  readonly path?: string;
+  readonly middlewares: readonly MiddlewareFunc[];
+  readonly methods: readonly HTTPMethodMeta[];
+  readonly needAcl: boolean;
+  readonly aclCode?: string;
+  readonly hosts?: string[];
+  constructor(className: string, protoName: EggPrototypeName, controllerName: string, path: string | undefined, middlewares: MiddlewareFunc[], methods: HTTPMethodMeta[], needAcl: boolean, aclCode: string | undefined, hosts: string[] | undefined);
+  getMethodRealPath(method: HTTPMethodMeta): string;
+  getMethodHosts(method: HTTPMethodMeta): string[] | undefined;
+  getMethodName(method: HTTPMethodMeta): string;
+  getMethodMiddlewares(method: HTTPMethodMeta): MiddlewareFunc[];
+  hasMethodAcl(method: HTTPMethodMeta): boolean;
+  getMethodAcl(method: HTTPMethodMeta): string | undefined;
+}
+//#endregion
+//#region src/model/HTTPCookies.d.ts
+declare class HTTPCookies extends Cookies$1 {}
+//#endregion
+//#region src/model/HTTPRequest.d.ts
+declare const HTTPRequest_base: ObjectConstructor | {
+  new (input: RequestInfo | URL, init?: RequestInit): Request;
+  prototype: Request;
+};
+declare class HTTPRequest extends HTTPRequest_base {}
+//#endregion
+//#region src/model/HTTPResponse.d.ts
+declare const HTTPResponse_base: {
+  new (body?: BodyInit | null, init?: ResponseInit): Response;
+  prototype: Response;
+  error(): Response;
+  json(data: any, init?: ResponseInit): Response;
+  redirect(url: string | URL, status?: number): Response;
+} | ObjectConstructor;
+declare class HTTPResponse extends HTTPResponse_base {}
+//#endregion
+//#region src/impl/http/HTTPControllerMetaBuilder.d.ts
+declare class HTTPControllerMetaBuilder {
+  private readonly clazz;
+  constructor(clazz: EggProtoImplClass);
+  private buildMethod;
+  build(): HTTPControllerMeta;
+  static create(clazz: EggProtoImplClass): HTTPControllerMetaBuilder;
+}
+//#endregion
+//#region src/impl/http/HTTPControllerMethodMetaBuilder.d.ts
+declare class HTTPControllerMethodMetaBuilder {
+  private readonly clazz;
+  private readonly methodName;
+  constructor(clazz: EggProtoImplClass, methodName: string);
+  private checkParamDecorators;
+  private buildParamType;
+  getPriority(): number;
+  build(): HTTPMethodMeta | undefined;
+}
+//#endregion
+//#region src/util/validator/ControllerValidator.d.ts
+declare class ControllerValidator {
+  static validate(clazz: EggProtoImplClass): void;
+}
+//#endregion
+//#region src/util/validator/MethodValidator.d.ts
+declare class MethodValidator {
+  static validate(clazz: EggProtoImplClass, methodName: string): void;
+}
+//#endregion
+//#region src/util/ControllerInfoUtil.d.ts
+declare class ControllerInfoUtil {
+  static addControllerMiddleware(middleware: MiddlewareFunc, clazz: EggProtoImplClass): void;
+  static addControllerAopMiddleware(middleware: EggProtoImplClass<IAdvice>, clazz: EggProtoImplClass): void;
+  static getControllerMiddlewares(clazz: EggProtoImplClass): MiddlewareFunc[];
+  static getControllerAopMiddlewares(clazz: EggProtoImplClass): EggProtoImplClass<IAdvice>[];
+  static setControllerType(clazz: EggProtoImplClass, controllerType: ControllerTypeLike): void;
+  static setControllerName(clazz: EggProtoImplClass, controllerName: string): void;
+  static getControllerName(clazz: EggProtoImplClass): string | undefined;
+  static getControllerType(clazz: EggProtoImplClass): ControllerTypeLike | undefined;
+  static setControllerAcl(code: string | undefined, clazz: EggProtoImplClass): void;
+  static hasControllerAcl(clazz: EggProtoImplClass): boolean;
+  static getControllerAcl(clazz: EggProtoImplClass): string | undefined;
+  static addControllerHosts(hosts: string[], clazz: EggProtoImplClass): void;
+  static getControllerHosts(clazz: EggProtoImplClass): string[] | undefined;
+}
+//#endregion
+//#region src/util/ControllerMetadataUtil.d.ts
+declare class ControllerMetadataUtil {
+  static setControllerMetadata(clazz: EggProtoImplClass, metaData: ControllerMetadata): void;
+  static getControllerMetadata(clazz: EggProtoImplClass): ControllerMetadata | undefined;
+}
+//#endregion
+//#region src/util/HTTPInfoUtil.d.ts
+declare class HTTPInfoUtil {
+  static setHTTPPath(path: string, clazz: EggProtoImplClass): void;
+  static getHTTPPath(clazz: EggProtoImplClass): string | undefined;
+  static setHTTPMethodPath(path: string, clazz: EggProtoImplClass, methodName: string): void;
+  static getHTTPMethodPath(clazz: EggProtoImplClass, methodName: string): string | undefined;
+  static setHTTPMethodMethod(method: HTTPMethodEnum, clazz: EggProtoImplClass, methodName: string): void;
+  static getHTTPMethodMethod(clazz: EggProtoImplClass, methodName: string): HTTPMethodEnum | undefined;
+  static setHTTPMethodParamType(paramType: HTTPParamType, parameterIndex: number, clazz: EggProtoImplClass, methodName: string): void;
+  static getParamIndexList(clazz: EggProtoImplClass, methodName: string): number[];
+  static getHTTPMethodParamType(parameterIndex: number, clazz: EggProtoImplClass, methodName: string): HTTPParamType | undefined;
+  static setHTTPMethodParamName(paramName: string, parameterIndex: number, clazz: EggProtoImplClass, methodName: string): void;
+  static getHTTPMethodParamName(parameterIndex: number, clazz: EggProtoImplClass, methodName: string): string | undefined;
+  static getHTTPMethodPriority(clazz: EggProtoImplClass, methodName: string): number | undefined;
+  static setHTTPMethodPriority(priority: number, clazz: EggProtoImplClass, methodName: string): void;
+}
+//#endregion
+//#region src/util/HTTPPriorityUtil.d.ts
+declare class HTTPPriorityUtil {
+  static readonly DEFAULT_PRIORITY = 100000;
+  private static readonly TOKEN_PRIORITY;
+  /**
+   * | Path | RegExp index | priority |
+   * | --- | --- | --- |
+   * | /* | [0] | 0 |
+   * | /hello/:name | [1] | 1000 |
+   * | /hello/world/message/:message | [3] | 3000 |
+   * | /hello/:name/message/:message | [1, 3] | 4000 |
+   * | /hello/world | [] | 100000/Infinity？ |
+   *
+   * priority = hasRegExp
+   *   : regexpIndex.reduce((p,c) => p + c * 1000, 0)
+   *   : 100000;
+   * @param {string} path -
+   */
+  static calcPathPriority(path: string): number;
+}
+//#endregion
+//#region src/util/MethodInfoUtil.d.ts
+declare class MethodInfoUtil {
+  static setMethodControllerType(clazz: EggProtoImplClass, methodName: string, controllerType: ControllerTypeLike): void;
+  static getMethodControllerType(clazz: EggProtoImplClass, methodName: string): ControllerTypeLike | undefined;
+  static setMethodContextIndexInArgs(index: number, clazz: EggProtoImplClass, methodName: string): void;
+  static getMethodContextIndex(clazz: EggProtoImplClass, methodName: string): number | undefined;
+  static addMethodMiddleware(middleware: MiddlewareFunc, clazz: EggProtoImplClass, methodName: string): void;
+  static getMethodMiddlewares(clazz: EggProtoImplClass, methodName: string): MiddlewareFunc[];
+  static addMethodAopMiddleware(middleware: EggProtoImplClass<IAdvice>, clazz: EggProtoImplClass, methodName: string): void;
+  static getMethodAopMiddlewares(clazz: EggProtoImplClass, methodName: string): EggProtoImplClass<IAdvice>[];
+  static setMethodAcl(code: string | undefined, clazz: EggProtoImplClass, methodName: string): void;
+  static hasMethodAcl(clazz: EggProtoImplClass, methodName: string): boolean;
+  static getMethodAcl(clazz: EggProtoImplClass, methodName: string): string | undefined;
+  static setMethodHosts(hosts: string[], clazz: EggProtoImplClass, methodName: string): void;
+  static getMethodHosts(clazz: EggProtoImplClass, methodName: string): string[] | undefined;
+  static getMethods(clazz: EggProtoImplClass): string[];
+  static shouldRegisterAopMiddlewarePointCut(clazz: EggProtoImplClass, methodName: string): boolean;
+  static registerAopMiddlewarePointcut(clazz: EggProtoImplClass, methodName: string): void;
+}
+//#endregion
+export { Acl, BodyParamMeta, Context, ControllerInfoUtil, ControllerMetaBuilderFactory, ControllerMetadataUtil, ControllerValidator, Cookies, CookiesParamMeta, HTTPBody, HTTPController, HTTPControllerMeta, HTTPControllerMetaBuilder, HTTPControllerMethodMetaBuilder, HTTPCookies, HTTPHeaders, HTTPInfoUtil, HTTPMethod, HTTPMethodMeta, HTTPParam, HTTPPriorityUtil, HTTPQueries, HTTPQuery, HTTPRequest, HTTPResponse, HeadersParamMeta, Host, MethodInfoUtil, MethodValidator, Middleware, ParamMeta, ParamMetaUtil, PathParamMeta, QueriesParamMeta, QueryParamMeta, Request$1 as Request, RequestParamMeta };