@midwayjs/decorator 3.4.11 → 3.7.0

package/dist/decorator/web/requestMapping.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.All = exports.Head = exports.Options = exports.Patch = exports.Put = exports.Del = exports.Get = exports.Post = exports.RequestMapping = exports.RequestMethod = void 0;
-/**
- * 'HEAD', 'OPTIONS', 'GET', 'PUT', 'PATCH', 'POST', 'DELETE' 封装
- */
-const __1 = require("../../");
-exports.RequestMethod = {
-    GET: 'get',
-    POST: 'post',
-    PUT: 'put',
-    DELETE: 'delete',
-    PATCH: 'patch',
-    ALL: 'all',
-    OPTIONS: 'options',
-    HEAD: 'head',
-};
-const defaultMetadata = {
-    path: '/',
-    requestMethod: exports.RequestMethod.GET,
-    routerName: null,
-    middleware: [],
-};
-const RequestMapping = (metadata = defaultMetadata) => {
-    const path = metadata.path || '/';
-    const requestMethod = metadata.requestMethod || exports.RequestMethod.GET;
-    const routerName = metadata.routerName;
-    const middleware = metadata.middleware;
-    return (target, key, descriptor) => {
-        var _a;
-        (0, __1.attachClassMetadata)(__1.WEB_ROUTER_KEY, {
-            path,
-            requestMethod,
-            routerName,
-            method: key,
-            middleware,
-            summary: (metadata === null || metadata === void 0 ? void 0 : metadata.summary) || '',
-            description: (metadata === null || metadata === void 0 ? void 0 : metadata.description) || '',
-            ignoreGlobalPrefix: (_a = metadata === null || metadata === void 0 ? void 0 : metadata.ignoreGlobalPrefix) !== null && _a !== void 0 ? _a : false,
-        }, target);
-        return descriptor;
-    };
-};
-exports.RequestMapping = RequestMapping;
-const createMappingDecorator = (method) => (path, routerOptions = { middleware: [] }) => {
-    return (0, exports.RequestMapping)(Object.assign(routerOptions, {
-        requestMethod: method,
-        path,
-    }));
-};
-/**
- * Routes HTTP POST requests to the specified path.
- */
-exports.Post = createMappingDecorator(exports.RequestMethod.POST);
-/**
- * Routes HTTP GET requests to the specified path.
- */
-exports.Get = createMappingDecorator(exports.RequestMethod.GET);
-/**
- * Routes HTTP DELETE requests to the specified path.
- */
-exports.Del = createMappingDecorator(exports.RequestMethod.DELETE);
-/**
- * Routes HTTP PUT requests to the specified path.
- */
-exports.Put = createMappingDecorator(exports.RequestMethod.PUT);
-/**
- * Routes HTTP PATCH requests to the specified path.
- */
-exports.Patch = createMappingDecorator(exports.RequestMethod.PATCH);
-/**
- * Routes HTTP OPTIONS requests to the specified path.
- */
-exports.Options = createMappingDecorator(exports.RequestMethod.OPTIONS);
-/**
- * Routes HTTP HEAD requests to the specified path.
- */
-exports.Head = createMappingDecorator(exports.RequestMethod.HEAD);
-/**
- * Routes all HTTP requests to the specified path.
- */
-exports.All = createMappingDecorator(exports.RequestMethod.ALL);
-//# sourceMappingURL=requestMapping.js.map

package/dist/decorator/web/response.d.ts

@@ -1,9 +0,0 @@
-export declare function Redirect(url: string, code?: number): (target: any, key: any, descriptor: PropertyDescriptor) => PropertyDescriptor;
-export declare function HttpCode(code: number): (target: any, key: any, descriptor: PropertyDescriptor) => PropertyDescriptor;
-export declare function SetHeader(headerKey: string | Record<string, any>, value?: string): (target: any, key: any, descriptor: PropertyDescriptor) => PropertyDescriptor;
-export declare function ContentType(contentType: string): (target: any, key: any, descriptor: PropertyDescriptor) => PropertyDescriptor;
-export declare function createRender(RenderEngine: {
-    render: () => string;
-    renderString: () => string;
-}): (templateName: string) => (target: any, key: any, descriptor: PropertyDescriptor) => PropertyDescriptor;
-//# sourceMappingURL=response.d.ts.map

package/dist/decorator/web/response.js

@@ -1,65 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRender = exports.ContentType = exports.SetHeader = exports.HttpCode = exports.Redirect = void 0;
-const __1 = require("../../");
-function Redirect(url, code = 302) {
-    return (target, key, descriptor) => {
-        (0, __1.attachPropertyMetadata)(__1.WEB_RESPONSE_KEY, {
-            type: __1.WEB_RESPONSE_REDIRECT,
-            url,
-            code,
-        }, target, key);
-        return descriptor;
-    };
-}
-exports.Redirect = Redirect;
-function HttpCode(code) {
-    return (target, key, descriptor) => {
-        (0, __1.attachPropertyMetadata)(__1.WEB_RESPONSE_KEY, {
-            type: __1.WEB_RESPONSE_HTTP_CODE,
-            code,
-        }, target, key);
-        return descriptor;
-    };
-}
-exports.HttpCode = HttpCode;
-function SetHeader(headerKey, value) {
-    return (target, key, descriptor) => {
-        let headerObject = {};
-        if (value) {
-            headerObject[headerKey] = value;
-        }
-        else {
-            headerObject = headerKey;
-        }
-        (0, __1.attachPropertyMetadata)(__1.WEB_RESPONSE_KEY, {
-            type: __1.WEB_RESPONSE_HEADER,
-            setHeaders: headerObject,
-        }, target, key);
-        return descriptor;
-    };
-}
-exports.SetHeader = SetHeader;
-function ContentType(contentType) {
-    return (target, key, descriptor) => {
-        (0, __1.attachPropertyMetadata)(__1.WEB_RESPONSE_KEY, {
-            type: __1.WEB_RESPONSE_CONTENT_TYPE,
-            contentType,
-        }, target, key);
-        return descriptor;
-    };
-}
-exports.ContentType = ContentType;
-function createRender(RenderEngine) {
-    return (templateName) => {
-        return (target, key, descriptor) => {
-            (0, __1.attachPropertyMetadata)(__1.WEB_RESPONSE_KEY, {
-                type: __1.WEB_RESPONSE_RENDER,
-                templateName,
-            }, target, key);
-            return descriptor;
-        };
-    };
-}
-exports.createRender = createRender;
-//# sourceMappingURL=response.js.map

package/dist/decorator/ws/webSocketController.d.ts

@@ -1,10 +0,0 @@
-import { MiddlewareParamArray } from '../../interface';
-export interface WSControllerOption {
-    namespace: string;
-    routerOptions: {
-        connectionMiddleware?: MiddlewareParamArray;
-        middleware?: MiddlewareParamArray;
-    };
-}
-export declare function WSController(namespace?: string | RegExp, routerOptions?: WSControllerOption['routerOptions']): ClassDecorator;
-//# sourceMappingURL=webSocketController.d.ts.map

package/dist/decorator/ws/webSocketController.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WSController = void 0;
-const common_1 = require("../common");
-const __1 = require("../../");
-function WSController(namespace = '/', routerOptions = {
-    middleware: [],
-    connectionMiddleware: [],
-}) {
-    return (target) => {
-        (0, __1.saveModule)(__1.WS_CONTROLLER_KEY, target);
-        (0, __1.saveClassMetadata)(__1.WS_CONTROLLER_KEY, {
-            namespace,
-            routerOptions,
-        }, target);
-        (0, common_1.Scope)(__1.ScopeEnum.Request)(target);
-        (0, __1.Provide)()(target);
-    };
-}
-exports.WSController = WSController;
-//# sourceMappingURL=webSocketController.js.map

package/dist/decorator/ws/webSocketEvent.d.ts

@@ -1,60 +0,0 @@
-import { MiddlewareParamArray } from '../../';
-export declare enum WSEventTypeEnum {
-    ON_CONNECTION = "ws:onConnection",
-    ON_DISCONNECTION = "ws:onDisconnection",
-    ON_MESSAGE = "ws:onMessage",
-    ON_SOCKET_ERROR = "ws:onSocketError",
-    EMIT = "ws:Emit",
-    BROADCAST = "ws:broadcast"
-}
-export interface WSEventInfo {
-    /**
-     * web socket event name in enum
-     */
-    eventType: WSEventTypeEnum;
-    /**
-     * decorator method name
-     */
-    propertyName: string;
-    descriptor: PropertyDescriptor;
-    /**
-     * the event name by user definition
-     */
-    messageEventName?: string;
-    /**
-     * the room name to emit
-     */
-    roomName?: string[];
-    /**
-     * event options, like middleware
-     */
-    eventOptions?: {
-        middleware?: MiddlewareParamArray;
-    };
-}
-export declare function OnWSConnection(eventOptions?: {
-    middleware?: MiddlewareParamArray;
-}): MethodDecorator;
-export declare function OnWSDisConnection(): MethodDecorator;
-export declare function OnWSMessage(eventName: string, eventOptions?: {
-    middleware?: MiddlewareParamArray;
-}): MethodDecorator;
-export declare function WSEmit(messageName: string, roomName?: string | string[]): MethodDecorator;
-export declare function WSBroadCast(messageName?: string, roomName?: string | string[]): MethodDecorator;
-/**
- * @deprecated please use @OnWSMessage
- */
-export declare const OnMessage: typeof OnWSMessage;
-/**
- * @deprecated please use @WSEmit
- */
-export declare const Emit: typeof WSEmit;
-/**
- * @deprecated please use @OnWSDisConnection
- */
-export declare const OnDisConnection: typeof OnWSDisConnection;
-/**
- * @deprecated please use @OnWSConnection
- */
-export declare const OnConnection: typeof OnWSConnection;
-//# sourceMappingURL=webSocketEvent.d.ts.map

package/dist/decorator/ws/webSocketEvent.js

@@ -1,87 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OnConnection = exports.OnDisConnection = exports.Emit = exports.OnMessage = exports.WSBroadCast = exports.WSEmit = exports.OnWSMessage = exports.OnWSDisConnection = exports.OnWSConnection = exports.WSEventTypeEnum = void 0;
-const __1 = require("../../");
-var WSEventTypeEnum;
-(function (WSEventTypeEnum) {
-    WSEventTypeEnum["ON_CONNECTION"] = "ws:onConnection";
-    WSEventTypeEnum["ON_DISCONNECTION"] = "ws:onDisconnection";
-    WSEventTypeEnum["ON_MESSAGE"] = "ws:onMessage";
-    WSEventTypeEnum["ON_SOCKET_ERROR"] = "ws:onSocketError";
-    WSEventTypeEnum["EMIT"] = "ws:Emit";
-    WSEventTypeEnum["BROADCAST"] = "ws:broadcast";
-})(WSEventTypeEnum = exports.WSEventTypeEnum || (exports.WSEventTypeEnum = {}));
-function OnWSConnection(eventOptions = {}) {
-    return (target, propertyKey, descriptor) => {
-        (0, __1.attachClassMetadata)(__1.WS_EVENT_KEY, {
-            eventType: WSEventTypeEnum.ON_CONNECTION,
-            propertyName: propertyKey,
-            eventOptions,
-            descriptor,
-        }, target.constructor);
-    };
-}
-exports.OnWSConnection = OnWSConnection;
-function OnWSDisConnection() {
-    return (target, propertyKey, descriptor) => {
-        (0, __1.attachClassMetadata)(__1.WS_EVENT_KEY, {
-            eventType: WSEventTypeEnum.ON_DISCONNECTION,
-            propertyName: propertyKey,
-            descriptor,
-        }, target.constructor);
-    };
-}
-exports.OnWSDisConnection = OnWSDisConnection;
-function OnWSMessage(eventName, eventOptions = {}) {
-    return (target, propertyKey, descriptor) => {
-        (0, __1.attachClassMetadata)(__1.WS_EVENT_KEY, {
-            eventType: WSEventTypeEnum.ON_MESSAGE,
-            messageEventName: eventName,
-            propertyName: propertyKey,
-            eventOptions,
-            descriptor,
-        }, target.constructor);
-    };
-}
-exports.OnWSMessage = OnWSMessage;
-function WSEmit(messageName, roomName = []) {
-    return (target, propertyKey, descriptor) => {
-        (0, __1.attachClassMetadata)(__1.WS_EVENT_KEY, {
-            eventType: WSEventTypeEnum.EMIT,
-            propertyName: propertyKey,
-            messageEventName: messageName,
-            roomName: [].concat(roomName),
-            descriptor,
-        }, target.constructor);
-    };
-}
-exports.WSEmit = WSEmit;
-function WSBroadCast(messageName = '', roomName = []) {
-    return (target, propertyKey, descriptor) => {
-        (0, __1.attachClassMetadata)(__1.WS_EVENT_KEY, {
-            eventType: WSEventTypeEnum.BROADCAST,
-            propertyName: propertyKey,
-            messageEventName: messageName,
-            roomName: [].concat(roomName),
-            descriptor,
-        }, target.constructor);
-    };
-}
-exports.WSBroadCast = WSBroadCast;
-/**
- * @deprecated please use @OnWSMessage
- */
-exports.OnMessage = OnWSMessage;
-/**
- * @deprecated please use @WSEmit
- */
-exports.Emit = WSEmit;
-/**
- * @deprecated please use @OnWSDisConnection
- */
-exports.OnDisConnection = OnWSDisConnection;
-/**
- * @deprecated please use @OnWSConnection
- */
-exports.OnConnection = OnWSConnection;
-//# sourceMappingURL=webSocketEvent.js.map

package/dist/decoratorManager.d.ts

@@ -1,301 +0,0 @@
-import 'reflect-metadata';
-import { GroupModeType, IModuleStore, ObjectDefinitionOptions, ObjectIdentifier, TagPropsMetadata } from './interface';
-export declare const PRELOAD_MODULE_KEY = "INJECTION_PRELOAD_MODULE_KEY";
-export declare const INJECT_CLASS_KEY_PREFIX = "INJECTION_CLASS_META_DATA";
-export declare class DecoratorManager extends Map implements IModuleStore {
-    /**
-     * the key for meta data store in class
-     */
-    injectClassKeyPrefix: string;
-    /**
-     * the key for method meta data store in class
-     */
-    injectClassMethodKeyPrefix: string;
-    /**
-     * the key for method meta data store in method
-     */
-    injectMethodKeyPrefix: string;
-    container: IModuleStore;
-    saveModule(key: any, module: any): any;
-    listModule(key: any): any;
-    resetModule(key: any): void;
-    bindContainer(container: IModuleStore): void;
-    static getDecoratorClassKey(decoratorNameKey: ObjectIdentifier): string;
-    static removeDecoratorClassKeySuffix(decoratorNameKey: ObjectIdentifier): string;
-    static getDecoratorMethodKey(decoratorNameKey: ObjectIdentifier): string;
-    static getDecoratorClsExtendedKey(decoratorNameKey: ObjectIdentifier): string;
-    static getDecoratorClsMethodPrefix(decoratorNameKey: ObjectIdentifier): string;
-    static getDecoratorClsMethodKey(decoratorNameKey: ObjectIdentifier, methodKey: ObjectIdentifier): string;
-    static getDecoratorMethod(decoratorNameKey: ObjectIdentifier, methodKey: ObjectIdentifier): string;
-    static saveMetadata(metaKey: string, target: any, dataKey: string, data: any): void;
-    static attachMetadata(metaKey: string, target: any, dataKey: string, data: any, groupBy?: string, groupMode?: GroupModeType): void;
-    static getMetadata(metaKey: string, target: any, dataKey?: string): any;
-    /**
-     * save meta data to class or property
-     * @param decoratorNameKey the alias name for decorator
-     * @param data the data you want to store
-     * @param target target class
-     * @param propertyName
-     */
-    saveMetadata(decoratorNameKey: ObjectIdentifier, data: any, target: any, propertyName?: any): void;
-    /**
-     * attach data to class or property
-     * @param decoratorNameKey
-     * @param data
-     * @param target
-     * @param propertyName
-     * @param groupBy
-     */
-    attachMetadata(decoratorNameKey: ObjectIdentifier, data: any, target: any, propertyName?: string, groupBy?: string, groupMode?: GroupModeType): void;
-    /**
-     * get single data from class or property
-     * @param decoratorNameKey
-     * @param target
-     * @param propertyName
-     */
-    getMetadata(decoratorNameKey: ObjectIdentifier, target: any, propertyName?: any): any;
-    /**
-     * save property data to class
-     * @param decoratorNameKey
-     * @param data
-     * @param target
-     * @param propertyName
-     */
-    savePropertyDataToClass(decoratorNameKey: ObjectIdentifier, data: any, target: any, propertyName: any): void;
-    /**
-     * attach property data to class
-     * @param decoratorNameKey
-     * @param data
-     * @param target
-     * @param propertyName
-     * @param groupBy
-     */
-    attachPropertyDataToClass(decoratorNameKey: ObjectIdentifier, data: any, target: any, propertyName: any, groupBy?: string): void;
-    /**
-     * get property data from class
-     * @param decoratorNameKey
-     * @param target
-     * @param propertyName
-     */
-    getPropertyDataFromClass(decoratorNameKey: ObjectIdentifier, target: any, propertyName: any): any;
-    /**
-     * list property data from class
-     * @param decoratorNameKey
-     * @param target
-     */
-    listPropertyDataFromClass(decoratorNameKey: ObjectIdentifier, target: any): any[];
-}
-/**
- * save data to class
- * @param decoratorNameKey
- * @param data
- * @param target
- * @param mergeIfExist
- */
-export declare function saveClassMetadata(decoratorNameKey: ObjectIdentifier, data: any, target: any, mergeIfExist?: boolean): void;
-/**
- * attach data to class
- * @param decoratorNameKey
- * @param data
- * @param target
- * @param groupBy
- */
-export declare function attachClassMetadata(decoratorNameKey: ObjectIdentifier, data: any, target: any, groupBy?: string, groupMode?: GroupModeType): void;
-/**
- * get data from class and proto
- * @param decoratorNameKey
- * @param target
- * @param propertyName
- * @param useCache
- */
-export declare function getClassExtendedMetadata(decoratorNameKey: ObjectIdentifier, target: any, propertyName?: string, useCache?: boolean): any;
-/**
- * get data from class
- * @param decoratorNameKey
- * @param target
- */
-export declare function getClassMetadata(decoratorNameKey: ObjectIdentifier, target: any): any;
-/**
- * save property data to class
- * @param decoratorNameKey
- * @param data
- * @param target
- * @param propertyName
- */
-export declare function savePropertyDataToClass(decoratorNameKey: ObjectIdentifier, data: any, target: any, propertyName: any): void;
-/**
- * attach property data to class
- * @param decoratorNameKey
- * @param data
- * @param target
- * @param propertyName
- * @param groupBy
- */
-export declare function attachPropertyDataToClass(decoratorNameKey: ObjectIdentifier, data: any, target: any, propertyName: any, groupBy?: string): void;
-/**
- * get property data from class
- * @param decoratorNameKey
- * @param target
- * @param propertyName
- */
-export declare function getPropertyDataFromClass(decoratorNameKey: ObjectIdentifier, target: any, propertyName: any): any;
-/**
- * list property data from class
- * @param decoratorNameKey
- * @param target
- */
-export declare function listPropertyDataFromClass(decoratorNameKey: ObjectIdentifier, target: any): any[];
-/**
- * save property data
- * @param decoratorNameKey
- * @param data
- * @param target
- * @param propertyName
- */
-export declare function savePropertyMetadata(decoratorNameKey: ObjectIdentifier, data: any, target: any, propertyName: any): void;
-/**
- * attach property data
- * @param decoratorNameKey
- * @param data
- * @param target
- * @param propertyName
- */
-export declare function attachPropertyMetadata(decoratorNameKey: ObjectIdentifier, data: any, target: any, propertyName: any): void;
-/**
- * get property data
- * @param decoratorNameKey
- * @param target
- * @param propertyName
- */
-export declare function getPropertyMetadata(decoratorNameKey: ObjectIdentifier, target: any, propertyName: any): any;
-/**
- * save preload module by target
- * @param target
- */
-export declare function savePreloadModule(target: any): any;
-/**
- * list preload module
- */
-export declare function listPreloadModule(): any[];
-/**
- * save module to inner map
- * @param decoratorNameKey
- * @param target
- */
-export declare function saveModule(decoratorNameKey: ObjectIdentifier, target: any): any;
-export declare function bindContainer(container: any): void;
-export declare function clearBindContainer(): any;
-/**
- * list module from decorator key
- * @param decoratorNameKey
- * @param filter
- */
-export declare function listModule(decoratorNameKey: ObjectIdentifier, filter?: (module: any) => boolean): any[];
-/**
- * reset module
- * @param decoratorNameKey
- */
-export declare function resetModule(decoratorNameKey: ObjectIdentifier): void;
-/**
- * clear all module
- */
-export declare function clearAllModule(): void;
-export interface TSDesignType {
-    name: string;
-    originDesign: any;
-    isBaseType: boolean;
-}
-/**
- * save property inject args
- * @param opts 参数
- */
-export declare function savePropertyInject(opts: {
-    identifier: ObjectIdentifier;
-    target: any;
-    targetKey: string;
-    args?: any;
-}): void;
-/**
- * get property inject args
- * @param target
- * @param useCache
- */
-export declare function getPropertyInject(target: any, useCache?: boolean): {
-    [methodName: string]: TagPropsMetadata;
-};
-/**
- * save class object definition
- * @param target class
- * @param props property data
- */
-export declare function saveObjectDefinition(target: any, props?: {}): any;
-/**
- * get class object definition from metadata
- * @param target
- */
-export declare function getObjectDefinition(target: any): ObjectDefinitionOptions;
-/**
- * class provider id
- * @param identifier id
- * @param target class
- */
-export declare function saveProviderId(identifier: ObjectIdentifier, target: any): any;
-/**
- * get provider id from module
- * @param module
- */
-export declare function getProviderId(module: any): string;
-export declare function getProviderName(module: any): string;
-/**
- * get provider uuid from module
- * @param module
- */
-export declare function getProviderUUId(module: any): string;
-/**
- * use @Provide decorator or not
- * @param target class
- */
-export declare function isProvide(target: any): boolean;
-export declare enum BaseType {
-    Boolean = "boolean",
-    Number = "number",
-    String = "string"
-}
-/**
- * get parameters type by reflect-metadata
- */
-export declare function getMethodParamTypes(target: any, methodName: string | symbol): any;
-/**
- * get property(method) type from metadata
- * @param target
- * @param methodName
- */
-export declare function getPropertyType(target: any, methodName: string | symbol): TSDesignType;
-/**
- * get method return type from metadata
- * @param target
- * @param methodName
- */
-export declare function getMethodReturnTypes(target: any, methodName: string | symbol): any;
-/**
- * create a custom property inject
- * @param decoratorKey
- * @param metadata
- * @param impl default true, configuration need decoratorService.registerMethodHandler
- */
-export declare function createCustomPropertyDecorator(decoratorKey: string, metadata: any, impl?: boolean): PropertyDecorator;
-/**
- *
- * @param decoratorKey
- * @param metadata
- * @param impl default true, configuration need decoratorService.registerMethodHandler
- */
-export declare function createCustomMethodDecorator(decoratorKey: string, metadata: any, impl?: boolean): MethodDecorator;
-/**
- *
- * @param decoratorKey
- * @param metadata
- * @param impl default true, configuration need decoratorService.registerMethodHandler
- */
-export declare function createCustomParamDecorator(decoratorKey: string, metadata: any, impl?: boolean): ParameterDecorator;
-//# sourceMappingURL=decoratorManager.d.ts.map