@midwayjs/core 3.0.0-beta.1 → 3.0.0-beta.5

package/dist/util/index.d.ts

@@ -1,5 +1,17 @@
+/**
+ * @since 2.0.0
+ * @param env
+ */
 export declare const isDevelopmentEnvironment: (env: any) => boolean;
+/**
+ * @since 2.0.0
+ */
 export declare const getCurrentEnvironment: () => string;
+/**
+ * @param p
+ * @param enabledCache
+ * @since 2.0.0
+ */
 export declare const safeRequire: (p: any, enabledCache?: boolean) => any;
 /**
  *  safelyGet(['a','b'],{a: {b: 2}})  // => 2
@@ -8,11 +20,13 @@ export declare const safeRequire: (p: any, enabledCache?: boolean) => any;
  *  safelyGet(['a','1'],{a: {b: 2}})  // => undefined
  *  safelyGet('a.b',{a: {b: 2}})  // => 2
  *  safelyGet('a.b',{c: {b: 2}})  // => undefined
+ *  @since 2.0.0
  */
 export declare function safelyGet(list: string | string[], obj?: Record<string, unknown>): any;
 /**
  * 剔除 @ 符号
  * @param provideId provideId
+ * @since 2.0.0
  */
 export declare function parsePrefix(provideId: string): string;
 export declare function getUserHome(): string;
@@ -21,19 +35,42 @@ export declare function joinURLPath(...strArray: any[]): string;
  * 代理目标所有的原型方法，不包括构造器和内部隐藏方法
  * @param derivedCtor
  * @param constructors
+ * @since 2.0.0
  */
 export declare function delegateTargetPrototypeMethod(derivedCtor: any, constructors: any[]): void;
 /**
  * 代理目标原型上的特定方法
  * @param derivedCtor
  * @param methods
+ * @since 2.0.0
  */
 export declare function delegateTargetMethod(derivedCtor: any, methods: string[]): void;
 /**
  * 代理目标原型属性
  * @param derivedCtor
  * @param properties
+ * @since 2.0.0
  */
 export declare function delegateTargetProperties(derivedCtor: any, properties: string[]): void;
+/**
+ * 代理目标原型属性
+ * @since 2.0.0
+ * @param timestamp
+ */
 export declare const getCurrentDateString: (timestamp?: number) => string;
+/**
+ *
+ * @param message
+ * @since 3.0.0
+ */
+export declare const deprecatedOutput: (message: string) => void;
+/**
+ * transform request object to definition type
+ *
+ * @param originValue
+ * @param targetType
+ * @since 3.0.0
+ */
+export declare const transformRequestObjectByType: (originValue: any, targetType?: any) => any;
+export declare function toPathMatch(pattern: any): any;
 //# sourceMappingURL=index.d.ts.map

package/dist/util/index.js

@@ -1,18 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCurrentDateString = exports.delegateTargetProperties = exports.delegateTargetMethod = exports.delegateTargetPrototypeMethod = exports.joinURLPath = exports.getUserHome = exports.parsePrefix = exports.safelyGet = exports.safeRequire = exports.getCurrentEnvironment = exports.isDevelopmentEnvironment = void 0;
+exports.toPathMatch = exports.transformRequestObjectByType = exports.deprecatedOutput = exports.getCurrentDateString = exports.delegateTargetProperties = exports.delegateTargetMethod = exports.delegateTargetPrototypeMethod = exports.joinURLPath = exports.getUserHome = exports.parsePrefix = exports.safelyGet = exports.safeRequire = exports.getCurrentEnvironment = exports.isDevelopmentEnvironment = void 0;
 const path_1 = require("path");
 const fs_1 = require("fs");
 const util_1 = require("util");
+const class_transformer_1 = require("class-transformer");
+const pathToRegexp_1 = require("./pathToRegexp");
+const error_1 = require("../error");
 const debug = (0, util_1.debuglog)('midway:container:util');
+/**
+ * @since 2.0.0
+ * @param env
+ */
 const isDevelopmentEnvironment = env => {
     return ['local', 'test', 'unittest'].includes(env);
 };
 exports.isDevelopmentEnvironment = isDevelopmentEnvironment;
+/**
+ * @since 2.0.0
+ */
 const getCurrentEnvironment = () => {
     return process.env['MIDWAY_SERVER_ENV'] || process.env['NODE_ENV'] || 'prod';
 };
 exports.getCurrentEnvironment = getCurrentEnvironment;
+/**
+ * @param p
+ * @param enabledCache
+ * @since 2.0.0
+ */
 const safeRequire = (p, enabledCache = true) => {
     if (p.startsWith(`.${path_1.sep}`) || p.startsWith(`..${path_1.sep}`)) {
         p = (0, path_1.resolve)((0, path_1.dirname)(module.parent.filename), p);
@@ -41,6 +56,7 @@ exports.safeRequire = safeRequire;
  *  safelyGet(['a','1'],{a: {b: 2}})  // => undefined
  *  safelyGet('a.b',{a: {b: 2}})  // => 2
  *  safelyGet('a.b',{c: {b: 2}})  // => undefined
+ *  @since 2.0.0
  */
 function safelyGet(list, obj) {
     if (arguments.length === 1) {
@@ -66,6 +82,7 @@ exports.safelyGet = safelyGet;
 /**
  * 剔除 @ 符号
  * @param provideId provideId
+ * @since 2.0.0
  */
 function parsePrefix(provideId) {
     if (provideId.includes('@')) {
@@ -79,6 +96,7 @@ function getUserHome() {
 }
 exports.getUserHome = getUserHome;
 function joinURLPath(...strArray) {
+    strArray = strArray.filter(item => !!item);
     if (strArray.length === 0) {
         return '';
     }
@@ -94,6 +112,7 @@ exports.joinURLPath = joinURLPath;
  * 代理目标所有的原型方法，不包括构造器和内部隐藏方法
  * @param derivedCtor
  * @param constructors
+ * @since 2.0.0
  */
 function delegateTargetPrototypeMethod(derivedCtor, constructors) {
     constructors.forEach(baseCtor => {
@@ -111,6 +130,7 @@ exports.delegateTargetPrototypeMethod = delegateTargetPrototypeMethod;
  * 代理目标原型上的特定方法
  * @param derivedCtor
  * @param methods
+ * @since 2.0.0
  */
 function delegateTargetMethod(derivedCtor, methods) {
     methods.forEach(name => {
@@ -124,6 +144,7 @@ exports.delegateTargetMethod = delegateTargetMethod;
  * 代理目标原型属性
  * @param derivedCtor
  * @param properties
+ * @since 2.0.0
  */
 function delegateTargetProperties(derivedCtor, properties) {
     properties.forEach(name => {
@@ -135,6 +156,11 @@ function delegateTargetProperties(derivedCtor, properties) {
     });
 }
 exports.delegateTargetProperties = delegateTargetProperties;
+/**
+ * 代理目标原型属性
+ * @since 2.0.0
+ * @param timestamp
+ */
 const getCurrentDateString = (timestamp = Date.now()) => {
     const d = new Date(timestamp);
     return `${d.getFullYear()}-${(d.getMonth() + 1)
@@ -142,4 +168,72 @@ const getCurrentDateString = (timestamp = Date.now()) => {
         .padStart(2, '0')}-${d.getDate().toString().padStart(2, '0')}`;
 };
 exports.getCurrentDateString = getCurrentDateString;
+/**
+ *
+ * @param message
+ * @since 3.0.0
+ */
+const deprecatedOutput = (message) => {
+    console.warn('DeprecationWarning: ' + message);
+};
+exports.deprecatedOutput = deprecatedOutput;
+/**
+ * transform request object to definition type
+ *
+ * @param originValue
+ * @param targetType
+ * @since 3.0.0
+ */
+const transformRequestObjectByType = (originValue, targetType) => {
+    if (targetType === undefined ||
+        targetType === null ||
+        targetType === Object) {
+        return originValue;
+    }
+    switch (targetType) {
+        case Number:
+            return Number(originValue);
+        case String:
+            return String(originValue);
+        case Boolean:
+            if (originValue === '0' || originValue === 'false') {
+                return false;
+            }
+            return Boolean(originValue);
+        default:
+            if (originValue instanceof targetType) {
+                return originValue;
+            }
+            else {
+                return (0, class_transformer_1.plainToClass)(targetType, originValue);
+            }
+    }
+};
+exports.transformRequestObjectByType = transformRequestObjectByType;
+function toPathMatch(pattern) {
+    if (typeof pattern === 'boolean') {
+        return ctx => pattern;
+    }
+    if (typeof pattern === 'string') {
+        const reg = (0, pathToRegexp_1.pathToRegexp)(pattern, [], { end: false });
+        if (reg.global)
+            reg.lastIndex = 0;
+        return ctx => reg.test(ctx.path);
+    }
+    if (pattern instanceof RegExp) {
+        return ctx => {
+            if (pattern.global)
+                pattern.lastIndex = 0;
+            return pattern.test(ctx.path);
+        };
+    }
+    if (typeof pattern === 'function')
+        return pattern;
+    if (Array.isArray(pattern)) {
+        const matchs = pattern.map(item => toPathMatch(item));
+        return ctx => matchs.some(match => match(ctx));
+    }
+    throw new error_1.MidwayCommonError('match/ignore pattern must be RegExp, Array or String, but got ' + pattern);
+}
+exports.toPathMatch = toPathMatch;
 //# sourceMappingURL=index.js.map

package/dist/util/webRouterParam.d.ts

@@ -1,3 +1,3 @@
-export declare const extractKoaLikeValue: (key: any, data: any) => (ctx: any, next: any) => any;
-export declare const extractExpressLikeValue: (key: any, data: any) => (req: any, res: any, next: any) => any;
+export declare const extractKoaLikeValue: (key: any, data: any, paramType?: any) => (ctx: any, next: any) => any;
+export declare const extractExpressLikeValue: (key: any, data: any, paramType?: any) => (req: any, res: any, next: any) => any;
 //# sourceMappingURL=webRouterParam.d.ts.map

package/dist/util/webRouterParam.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractExpressLikeValue = exports.extractKoaLikeValue = void 0;
 const decorator_1 = require("@midwayjs/decorator");
-const extractKoaLikeValue = (key, data) => {
+const index_1 = require("./index");
+const extractKoaLikeValue = (key, data, paramType) => {
     if (decorator_1.ALL === data) {
         data = undefined;
     }
@@ -11,17 +12,15 @@ const extractKoaLikeValue = (key, data) => {
             case decorator_1.RouteParamTypes.NEXT:
                 return next;
             case decorator_1.RouteParamTypes.BODY:
-                return data && ctx.request.body
-                    ? ctx.request.body[data]
-                    : ctx.request.body;
+                return (0, index_1.transformRequestObjectByType)(data && ctx.request.body ? ctx.request.body[data] : ctx.request.body, paramType);
             case decorator_1.RouteParamTypes.PARAM:
-                return data ? ctx.params[data] : ctx.params;
+                return (0, index_1.transformRequestObjectByType)(data ? ctx.params[data] : ctx.params, paramType);
             case decorator_1.RouteParamTypes.QUERY:
-                return data ? ctx.query[data] : ctx.query;
+                return (0, index_1.transformRequestObjectByType)(data ? ctx.query[data] : ctx.query, paramType);
             case decorator_1.RouteParamTypes.HEADERS:
-                return data ? ctx.get(data) : ctx.headers;
+                return (0, index_1.transformRequestObjectByType)(data ? ctx.get(data) : ctx.headers, paramType);
             case decorator_1.RouteParamTypes.SESSION:
-                return data ? ctx.session[data] : ctx.session;
+                return (0, index_1.transformRequestObjectByType)(data ? ctx.session[data] : ctx.session, paramType);
             case decorator_1.RouteParamTypes.FILESTREAM:
                 return ctx.getFileStream && ctx.getFileStream(data);
             case decorator_1.RouteParamTypes.FILESSTREAM:
@@ -32,10 +31,10 @@ const extractKoaLikeValue = (key, data) => {
                 return ctx['ip'];
             case decorator_1.RouteParamTypes.QUERIES:
                 if (ctx.queries) {
-                    return data ? ctx.queries[data] : ctx.queries;
+                    return (0, index_1.transformRequestObjectByType)(data ? ctx.queries[data] : ctx.queries, paramType);
                 }
                 else {
-                    return data ? ctx.query[data] : ctx.query;
+                    return (0, index_1.transformRequestObjectByType)(data ? ctx.query[data] : ctx.query, paramType);
                 }
             default:
                 return null;
@@ -43,7 +42,7 @@ const extractKoaLikeValue = (key, data) => {
     };
 };
 exports.extractKoaLikeValue = extractKoaLikeValue;
-const extractExpressLikeValue = (key, data) => {
+const extractExpressLikeValue = (key, data, paramType) => {
     if (decorator_1.ALL === data) {
         data = undefined;
     }
@@ -52,15 +51,15 @@ const extractExpressLikeValue = (key, data) => {
             case decorator_1.RouteParamTypes.NEXT:
                 return next;
             case decorator_1.RouteParamTypes.BODY:
-                return data && req.body ? req.body[data] : req.body;
+                return (0, index_1.transformRequestObjectByType)(data && req.body ? req.body[data] : req.body, paramType);
             case decorator_1.RouteParamTypes.PARAM:
-                return data ? req.params[data] : req.params;
+                return (0, index_1.transformRequestObjectByType)(data ? req.params[data] : req.params, paramType);
             case decorator_1.RouteParamTypes.QUERY:
-                return data ? req.query[data] : req.query;
+                return (0, index_1.transformRequestObjectByType)(data ? req.query[data] : req.query, paramType);
             case decorator_1.RouteParamTypes.HEADERS:
-                return data ? req.get(data) : req.headers;
+                return (0, index_1.transformRequestObjectByType)(data ? req.get(data) : req.headers, paramType);
             case decorator_1.RouteParamTypes.SESSION:
-                return data ? req.session[data] : req.session;
+                return (0, index_1.transformRequestObjectByType)(data ? req.session[data] : req.session, paramType);
             case decorator_1.RouteParamTypes.FILESTREAM:
                 return req.getFileStream && req.getFileStream(data);
             case decorator_1.RouteParamTypes.FILESSTREAM:
@@ -71,10 +70,10 @@ const extractExpressLikeValue = (key, data) => {
                 return req['ip'];
             case decorator_1.RouteParamTypes.QUERIES:
                 if (req.queries) {
-                    return data ? req.queries[data] : req.queries;
+                    return (0, index_1.transformRequestObjectByType)(data ? req.queries[data] : req.queries, paramType);
                 }
                 else {
-                    return data ? req.query[data] : req.query;
+                    return (0, index_1.transformRequestObjectByType)(data ? req.query[data] : req.query, paramType);
                 }
             default:
                 return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/core",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.5",
   "description": "midway core",
   "main": "dist/index",
   "typings": "dist/index.d.ts",
@@ -21,7 +21,7 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/decorator": "^3.0.0-beta.1",
+    "@midwayjs/decorator": "^3.0.0-beta.5",
     "midway-test-component": "*",
     "mm": "3",
     "sinon": "^7.2.2"
@@ -31,8 +31,8 @@
   },
   "dependencies": {
     "@midwayjs/glob": "^1.0.2",
-    "@midwayjs/logger": "^3.0.0-beta.1",
-    "class-transformer": "^0.3.1",
+    "@midwayjs/logger": "^3.0.0-beta.5",
+    "class-transformer": "^0.4.0",
     "extend2": "^1.0.0",
     "picomatch": "^2.2.2",
     "reflect-metadata": "^0.1.13"
@@ -45,5 +45,5 @@
   "engines": {
     "node": ">=12"
   },
-  "gitHead": "72e4d20c678e65a5440c4e9a6d3b70046daa497c"
+  "gitHead": "ab0bf05ae6d13f6435db2f7223202be61d585a1b"
 }

package/dist/util/exceptionFilterManager.d.ts

@@ -1,13 +0,0 @@
-import { CommonExceptionFilterUnion, IMidwayContainer, IMidwayContext } from '../interface';
-export declare class ExceptionFilterManager<T extends IMidwayContext = IMidwayContext, R = any, N = any> {
-    private filterList;
-    private exceptionMap;
-    private defaultFilter;
-    useFilter(Filter: CommonExceptionFilterUnion<T, R, N>): void;
-    init(applicationContext: IMidwayContainer): Promise<void>;
-    run(err: Error, ctx: T, res?: R, next?: N): Promise<{
-        result: any;
-        error: any;
-    }>;
-}
-//# sourceMappingURL=exceptionFilterManager.d.ts.map

package/dist/util/exceptionFilterManager.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExceptionFilterManager = void 0;
-const decorator_1 = require("@midwayjs/decorator");
-class ExceptionFilterManager {
-    constructor() {
-        this.filterList = [];
-        this.exceptionMap = new WeakMap();
-        this.defaultFilter = undefined;
-    }
-    useFilter(Filter) {
-        if (Array.isArray(Filter)) {
-            this.filterList.push(...Filter);
-        }
-        else {
-            this.filterList.push(Filter);
-        }
-    }
-    async init(applicationContext) {
-        for (const FilterClass of this.filterList) {
-            const filter = await applicationContext.getAsync(FilterClass);
-            const exceptionMetadata = (0, decorator_1.getClassMetadata)(decorator_1.CATCH_KEY, FilterClass);
-            if (exceptionMetadata && exceptionMetadata.catchTargets) {
-                for (const Exception of exceptionMetadata.catchTargets) {
-                    this.exceptionMap.set(Exception, filter);
-                }
-            }
-            else {
-                // default filter
-                this.defaultFilter = filter;
-            }
-        }
-    }
-    async run(err, ctx, res, next) {
-        let result, error;
-        if (this.exceptionMap.has(err.constructor)) {
-            const filter = this.exceptionMap.get(err.constructor);
-            result = await filter.catch(err, ctx, res, next);
-        }
-        else if (this.defaultFilter) {
-            result = await this.defaultFilter.catch(err, ctx, res, next);
-        }
-        else {
-            error = err;
-        }
-        return {
-            result,
-            error,
-        };
-    }
-}
-exports.ExceptionFilterManager = ExceptionFilterManager;
-//# sourceMappingURL=exceptionFilterManager.js.map

package/dist/util/middlewareManager.d.ts

@@ -1,11 +0,0 @@
-import { CommonMiddleware, CommonMiddlewareUnion, IMidwayContext } from '../interface';
-export declare class ContextMiddlewareManager<T extends IMidwayContext = IMidwayContext, R = any, N = any> extends Array<CommonMiddleware<T, R, N>> {
-    insertFirst(middleware: CommonMiddlewareUnion<T, R, N>): void;
-    insertBefore(middleware: CommonMiddlewareUnion<T, R, N>, idxOrBeforeMiddleware: number): any;
-    insertBefore(middleware: CommonMiddlewareUnion<T, R, N>, idxOrBeforeMiddleware: CommonMiddlewareUnion<T, R, N>): any;
-    insertAfter(middleware: CommonMiddlewareUnion<T, R, N>, idxOrAfterMiddleware: number): any;
-    insertAfter(middleware: CommonMiddlewareUnion<T, R, N>, idxOrAfterMiddleware: CommonMiddlewareUnion<T, R, N>): any;
-    insertLast(middleware: CommonMiddlewareUnion<T, R, N>): void;
-    private findItemIndex;
-}
-//# sourceMappingURL=middlewareManager.d.ts.map