@x-9lab/xlab 1.6.1 → 2.0.1

package/dist/middleware/request-filter.js

@@ -2,34 +2,48 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-exports.default = _default;
-var _htmlFilter = _interopRequireWildcard(require("./@bin/html-filter"));
-var _url = _interopRequireDefault(require("url"));
-function _interopRequireDefault(obj) {
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+const _htmlfilter = /*#__PURE__*/ _interop_require_wildcard(require("./@bin/html-filter"));
+const _url = /*#__PURE__*/ _interop_require_default(require("url"));
+function _interop_require_default(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
     };
 }
-function _interopRequireWildcard(obj) {
-    if (obj && obj.__esModule) {
-        return obj;
-    } else {
-        var newObj = {};
-        if (obj != null) {
-            for(var key in obj){
-                if (Object.prototype.hasOwnProperty.call(obj, key)) {
-                    var desc = Object.defineProperty && Object.getOwnPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : {};
-                    if (desc.get || desc.set) {
-                        Object.defineProperty(newObj, key, desc);
-                    } else {
-                        newObj[key] = obj[key];
-                    }
-                }
-            }
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interop_require_wildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) return obj;
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") return {
+        default: obj
+    };
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) return cache.get(obj);
+    var newObj = {
+        __proto__: null
+    };
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) Object.defineProperty(newObj, key, desc);
+            else newObj[key] = obj[key];
         }
-        newObj.default = obj;
-        return newObj;
     }
+    newObj.default = obj;
+    if (cache) cache.set(obj, newObj);
+    return newObj;
 }
 const IS_STATIC_RE = /^\/.*\.(ttf|woff|eot|html|css|js|json|png|jpeg|jpg|gif|bmp|handlebars|mp3|mp4|m3u8|avi|mpg|mpeg|xml|json|tpl)$/i;
 const IS_IMG_RE = /\.(jpg|jpeg|png|gif)$/i;
@@ -94,13 +108,13 @@ async function filter(ctx, next) {
         // 提取页面必要的信息
         // 由于 dir 也可能直接返回 HTML 页面
         // 所以这里也需要经过 HTML 的过滤器处理
-        ctx.state.ver = (0, _htmlFilter).filter(ctx.url);
+        ctx.state.ver = (0, _htmlfilter.filter)(ctx.url);
     } else if (isStatic(pathname)) {
         srcType.static = true;
         if (isHtml(pathname)) {
             srcType.html = true;
             // 提取页面必要的信息
-            ctx.state.ver = (0, _htmlFilter).filter(ctx.url);
+            ctx.state.ver = (0, _htmlfilter.filter)(ctx.url);
         } else if (isJS(pathname)) {
             srcType.js = true;
         } else if (isImg(pathname)) {
@@ -117,6 +131,6 @@ async function filter(ctx, next) {
     await next();
 }
 function _default() {
-    (0, _htmlFilter).default();
+    (0, _htmlfilter.default)();
     return filter;
 }

package/dist/middleware/service-mark.js

@@ -2,31 +2,28 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-exports.default = _default;
-var _utils = require("@x-drive/utils");
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+const _utils = require("@x-drive/utils");
+const _config = require("../config");
 const serverPackge = require("../../package.json");
-var info = {};
-// 业务名称
-info.mark = getSysConfig("mark") || getSysConfig("name");
-// 业务版本
-info.version = getSysConfig("version");
-// 服务端版本
-info.serverVer = serverPackge.version;
-info.serverName = serverPackge.name;
-// 业务启动时间
-// FIX ME : 服务器不是北京时间的时候这个数据跟实际启动的时间存在时差
-info.date = (0, _utils).date(new Date(), "Y-m-d H:i:s");
-// 模块版本信息
-const CLIENT_MARK = `${info.mark}@${info.version}`;
-const SERVER_MARK = `${info.serverName}@${info.serverVer}`;
-const MARK = `${CLIENT_MARK},${SERVER_MARK};Startup@${info.date}`;
-info = null;
-/**
- * 处理函数
- */ async function handler(ctx, next) {
-    ctx.set("X-Mark", MARK);
-    await next();
-}
 function _default() {
-    return handler;
+    const conf = (0, _config.get)();
+    // 业务名称与版本
+    const CLIENT_MARK = `${conf.mark || conf.name}@${conf.version}`;
+    // 服务端版本
+    const SERVER_MARK = `${serverPackge.name}@${serverPackge.version}`;
+    // 业务启动时间
+    // FIX ME : 服务器不是北京时间的时候这个数据跟实际启动的时间存在时差
+    const MARK = `${CLIENT_MARK},${SERVER_MARK};Startup@${(0, _utils.date)(new Date(), "Y-m-d H:i:s")}`;
+    /**
+     * 处理函数
+     */ return async function handler(ctx, next) {
+        ctx.set("X-Mark", MARK);
+        await next();
+    };
 }

package/dist/middlewares.js

@@ -2,18 +2,23 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-exports.default = void 0;
-var _utils = require("@x-drive/utils");
-var _common = require("./components/common");
-var _defaultXConfig = _interopRequireDefault(require("./default-x-config"));
-function _interopRequireDefault(obj) {
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+const _utils = require("@x-drive/utils");
+const _common = require("./components/common");
+const _config = require("./config");
+const _defaultxconfig = /*#__PURE__*/ _interop_require_default(require("./default-x-config"));
+function _interop_require_default(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
     };
 }
 const cwd = process.cwd();
 /**内部中间件 */ const INTERNAL_MIDDLEWARE = {
-    "combo": true,
     "bad-request": true,
     "fresh-filter": true,
     "handle-pre-dir": true,
@@ -23,7 +28,7 @@ const cwd = process.cwd();
     "cors": true
 };
 /**获取中间件加载执行列表 */ function getExeList() {
-    const config = getSysConfig();
+    const config = (0, _config.get)();
     var mConfig;
     if (config.middlewares) {
         mConfig = config.middlewares;
@@ -31,37 +36,34 @@ const cwd = process.cwd();
         mConfig = null;
     }
     if (mConfig) {
-        return Object.keys(mConfig).filter((key)=>(0, _utils).isBoolean(mConfig[key]) ? mConfig[key] : true
-        ).map((key, index)=>{
-            if ((0, _utils).isBoolean(mConfig[key])) {
+        return Object.keys(mConfig).filter((key)=>(0, _utils.isBoolean)(mConfig[key]) ? mConfig[key] : true).map((key, index)=>{
+            if ((0, _utils.isBoolean)(mConfig[key])) {
                 mConfig[key] = {};
             }
-            if (!(0, _utils).isString(mConfig[key].name)) {
+            if (!(0, _utils.isString)(mConfig[key].name)) {
                 mConfig[key].name = key;
             }
-            if (!(0, _utils).isNumber(mConfig[key].index)) {
+            if (!(0, _utils.isNumber)(mConfig[key].index)) {
                 mConfig[key].index = index;
             }
             return mConfig[key];
-        }).sort((now, next)=>now.index - next.index
-        );
+        }).sort((now, next)=>now.index - next.index);
     }
     return [];
 }
 // ［最后3个中间件固定是 系统路由，静态文件服务，错误请求处理模块］
 /**加载中间件 */ function loadMiddleware(app) {
     const list = getExeList();
-    if ((0, _utils).isArray(list) && list.length) {
+    if ((0, _utils.isArray)(list) && list.length) {
         list.forEach((item)=>{
             if (INTERNAL_MIDDLEWARE[item.name]) {
-                app.use((0, _common).getRealDefaultMod(require(`./middleware/${item.name}`))(item.config));
+                app.use((0, _common.getRealDefaultMod)(require(`./middleware/${item.name}`))(item.config));
             } else {
-                app.use((0, _common).getRealDefaultMod(require(`${cwd}/${_defaultXConfig.default.businessDir}/middleware/${item.name}`))(item.config));
+                app.use((0, _common.getRealDefaultMod)(require(`${cwd}/${_defaultxconfig.default.businessDir}/middleware/${item.name}`))(item.config));
             }
-            masterLog(`MIDDLEWARE >>> [${item.name}] launch`);
+            (0, _config.log)(`MIDDLEWARE >>> [${item.name}] launch`);
         });
         console.log("");
     }
 }
-var _default = loadMiddleware;
-exports.default = _default;
+const _default = loadMiddleware;

package/dist/router.js

@@ -2,170 +2,203 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-exports.default = void 0;
-var _utils = require("@x-drive/utils");
-var _common = require("./components/common");
-var _defaultXConfig = _interopRequireDefault(require("./default-x-config"));
-var _path = _interopRequireDefault(require("path"));
-var _fs = _interopRequireDefault(require("fs"));
-function _interopRequireDefault(obj) {
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get default () {
+        return _default;
+    },
+    get defineApi () {
+        return defineApi;
+    }
+});
+const _utils = require("@x-drive/utils");
+const _common = require("./components/common");
+const _config = require("./config");
+const _defaultxconfig = /*#__PURE__*/ _interop_require_default(require("./default-x-config"));
+const _path = /*#__PURE__*/ _interop_require_default(require("path"));
+const _fs = /*#__PURE__*/ _interop_require_default(require("fs"));
+function _interop_require_default(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
     };
 }
 /**API 服务目录 */ const API_BUSINESS_DIR = "business";
+/**API 地址前缀检测 */ const IS_API_REGEXP = /^\/api\//;
+/**支持的请求方法, 同时也是「文件名即方法」约定支持的文件名 */ const HTTP_METHODS = [
+    "get",
+    "post",
+    "put",
+    "delete",
+    "patch",
+    "head",
+    "options",
+    "all"
+];
+/**
+ * 定义一个业务接口
+
+ * 运行时恒等返回, 仅为路由模块提供类型推导
+ */ function defineApi(def) {
+    return def;
+}
 /**生成 api */ function buildApi(api) {
     if (!api.startsWith("/")) {
         api = `/${api}`;
     }
     return `/api${api}`;
 }
-/**
- * 递归处理文件夹
- * @param  path         文件目录
- * @param  middlewares  接口中间件
- * @param  callback     查找到文件时的处理函数
- */ function walk(dir, middlewares, callback) {
-    var files = _fs.default.readdirSync(dir);
-    files.forEach(function(item) {
-        if (!item.startsWith(".") && !item.endsWith(".d.ts")) {
-            var tmpPath = _path.default.join(dir, item);
-            var stats = _fs.default.statSync(tmpPath);
-            if (stats.isDirectory() && item.startsWith("$")) {
-                // 接口级别中间件
-                let middlewaresFiles = _fs.default.readdirSync(tmpPath);
-                let mws = [];
-                middlewaresFiles.forEach(function(name) {
-                    let tmpMwPath = _path.default.join(tmpPath, name);
-                    let fileStat = _fs.default.statSync(tmpMwPath);
-                    if (!fileStat.isDirectory() && !item.startsWith(".") && !item.endsWith(".d.ts")) {
-                        mws.push(tmpMwPath);
-                    }
-                });
-                // 简单做下排序
-                mws.sort();
-                const partPath = dir.split(API_BUSINESS_DIR)[1] || _path.default.posix.sep;
-                middlewares[partPath] = mws;
-            }
-            if (stats.isDirectory() && !item.startsWith("@") && !item.startsWith("$")) {
-                walk(tmpPath, middlewares, callback);
-            } else if (!stats.isDirectory()) {
-                callback(tmpPath, item, middlewares);
+/**把相对路径统一为以 / 开头的 url 风格路径 */ function toUrlPath(rel) {
+    return "/" + rel.split(_path.default.sep).filter(Boolean).join("/");
+}
+/**
+ * 递归收集业务目录下的路由文件与目录级中间件
+ * @param dir         当前目录
+ * @param root        business 根目录
+ * @param middlewares 目录级中间件收集对象
+ * @param files       路由文件收集数组
+ */ function collect(dir, root, middlewares, files) {
+    _fs.default.readdirSync(dir).forEach(function(item) {
+        if (item.startsWith(".") || item.endsWith(".d.ts")) {
+            return;
+        }
+        const tmpPath = _path.default.join(dir, item);
+        const stats = _fs.default.statSync(tmpPath);
+        if (stats.isDirectory()) {
+            if (item.startsWith("$")) {
+                // 目录级中间件, 生效于所在层级及以下; 不递归, 按文件名排序执行
+                const mws = _fs.default.readdirSync(tmpPath).filter(function(name) {
+                    return !name.startsWith(".") && !name.endsWith(".d.ts") && _fs.default.statSync(_path.default.join(tmpPath, name)).isFile();
+                }).sort().map((name)=>_path.default.join(tmpPath, name));
+                const key = toUrlPath(_path.default.relative(root, dir));
+                middlewares[key] = (middlewares[key] || []).concat(mws);
+            } else if (!item.startsWith("@")) {
+                collect(tmpPath, root, middlewares, files);
             }
+        } else {
+            files.push(tmpPath);
         }
     });
 }
-/**加载业务服务接口 */ function appRouter(router) {
-    const IS_API_REGEXP = /^\/api\//;
-    var processBusiness = function(modPath, item, middlewares) {
-        var mod = require(_path.default.resolve(modPath));
-        if (mod) {
-            mod = (0, _common).getRealDefaultMod(mod);
-            let api_path = modPath.split(API_BUSINESS_DIR);
-            let api;
-            let apiPart;
-            let modName;
-            // 根据路径生成 url 规则
-            api = api_path[1].replace(".js", "").split(_path.default.posix.sep);
-            // 文件名是 index
-            const lastIsIndex = api[api.length - 1] === "index";
-            // 文件名是 index 的则会被从 api 上先强行去掉
-            // 如果需要命名成 index 的需要自己用 object 形式，用 api 字段定义
-            if (lastIsIndex) {
-                api.pop();
-            }
-            // 如果模块返回的是数组，则使用文件名做为方法名，并在 api 上去掉文件名
-            if ((0, _utils).isArray(mod)) {
-                if (!lastIsIndex) {
-                    api.pop();
-                }
-                apiPart = api;
-                api = buildApi(api.join("/"));
-                mod.unshift(api);
-            } else {
-                apiPart = api;
-                // 不是数组则把文件当作正常的 api 地址
-                api = buildApi(api.join("/"));
-            }
-            // 是对象则取对应的字段
-            if ((0, _utils).isObject(mod)) {
-                const subjectMod = mod;
-                if ((0, _utils).isFunction(subjectMod.handler) || (0, _utils).isAsyncFunction(subjectMod.handler)) {
-                    modName = subjectMod.method || "get";
-                    api = subjectMod.api || api;
-                    apiPart = api.split("/");
-                    if (apiPart[0] !== "") {
-                        apiPart.unshift("");
-                    }
-                    // 如果没有声明忽略检测则保证接口一定是以 api 开头的
-                    if (!subjectMod.ignoreApiNameCheck && !IS_API_REGEXP.test(api)) {
-                        api = buildApi(api);
-                    }
-                    if ((0, _utils).isArray(subjectMod.middleware)) {
-                        mod = [
-                            api,
-                            ...subjectMod.middleware,
-                            subjectMod.handler
-                        ];
-                    } else {
-                        mod = [
-                            api,
-                            subjectMod.handler
-                        ];
-                    }
-                }
-            }
-            var dirMws = [];
-            var prevPart = "";
-            for(let i = 0; i < apiPart.length; i++){
-                if (!apiPart[i] || apiPart[i] === "api") {
-                    continue;
-                }
-                const part = `${prevPart}${_path.default.posix.sep}${apiPart[i]}`;
-                if (middlewares[part]) {
-                    dirMws = dirMws.concat(middlewares[part]);
+/**
+ * 把一个路由模块归一化为注册单元
+
+ * 支持的导出形态:
+ * 1. 函数: 绑定为处理函数, 方法由文件名约定决定
+ * 2. 对象(推荐配合 defineApi): { method?, api?, middleware?, handler, ignoreApiNameCheck? }
+ *
+ * 文件名约定: `index` 从 api 上去掉; 文件名是请求方法名(get/post/...)时,
+ * 从 api 上去掉并作为该接口的请求方法
+ * @param modPath 模块文件地址
+ * @param root    business 根目录
+ */ function normalize(modPath, root) {
+    var mod = (0, _common.getRealDefaultMod)(require(_path.default.resolve(modPath)));
+    if (!mod) {
+        return null;
+    }
+    if ((0, _utils.isArray)(mod)) {
+        throw new Error(`[xlab] 数组形式的路由定义已在 v2 移除: ${modPath}\n` + "请改用 defineApi 对象形式或「文件名即方法」约定, 参见 MIGRATION.md");
+    }
+    const rel = _path.default.relative(root, modPath);
+    const ext = _path.default.extname(rel);
+    const parts = rel.slice(0, rel.length - ext.length).split(_path.default.sep).filter(Boolean);
+    const fileName = parts[parts.length - 1];
+    var method = "get";
+    if (fileName === "index") {
+        parts.pop();
+    } else if (HTTP_METHODS.indexOf(fileName) !== -1) {
+        method = fileName;
+        parts.pop();
+    }
+    var api = buildApi(parts.join("/"));
+    var middlewares = [];
+    var handler = null;
+    if ((0, _utils.isFunction)(mod) || (0, _utils.isAsyncFunction)(mod)) {
+        handler = mod;
+    } else if ((0, _utils.isObject)(mod)) {
+        const def = mod;
+        if ((0, _utils.isFunction)(def.handler) || (0, _utils.isAsyncFunction)(def.handler)) {
+            handler = def.handler;
+            method = def.method || method;
+            if ((0, _utils.isString)(def.api)) {
+                api = def.api;
+                if (!api.startsWith("/")) {
+                    api = `/${api}`;
                 }
-                prevPart = part;
-            }
-            // 直接返回函数则直接绑定
-            if ((0, _utils).isFunction(mod) || (0, _utils).isAsyncFunction(mod)) {
-                mod = [
-                    api,
-                    mod
-                ];
-            }
-            if (!modName) {
-                modName = item.replace(".js", "");
-                if (modName === "index") {
-                    modName = "get";
+                // 如果没有声明忽略检测则保证接口一定是以 api 开头的
+                if (!def.ignoreApiNameCheck && !IS_API_REGEXP.test(api)) {
+                    api = buildApi(api);
                 }
             }
-            if (dirMws && dirMws.length) {
-                let mws = dirMws.map((name)=>(0, _common).getRealDefaultMod(require(name))
-                );
-                mod.splice.apply(mod, [
-                    1,
-                    0,
-                    ...mws
-                ]);
-                mws = null;
+            if ((0, _utils.isArray)(def.middleware)) {
+                middlewares = def.middleware;
             }
-            router[modName].apply(router, mod);
-            masterLog("router", `Handling API >>> [${modName}] ${api}`);
         }
+    }
+    if (!handler) {
+        return null;
+    }
+    return {
+        method,
+        api,
+        middlewares,
+        handler
     };
-    // 业务基本目录
+}
+/**
+ * 解析一个 api 命中的目录级中间件链
+ * @param api         api 地址
+ * @param middlewares 目录级中间件映射
+ */ function resolveDirMiddlewares(api, middlewares) {
+    var chain = [];
+    if (middlewares["/"]) {
+        chain = chain.concat(middlewares["/"]);
+    }
+    const parts = api.split("/").filter((part)=>part && part !== "api");
+    var prev = "";
+    for (const part of parts){
+        prev = `${prev}/${part}`;
+        if (middlewares[prev]) {
+            chain = chain.concat(middlewares[prev]);
+        }
+    }
+    return chain.map((file)=>(0, _common.getRealDefaultMod)(require(file)));
+}
+/**加载业务服务接口 */ function appRouter(router) {
+    function register(root) {
+        const middlewares = {};
+        const files = [];
+        collect(root, root, middlewares, files);
+        files.forEach(function(modPath) {
+            const route = normalize(modPath, root);
+            if (!route) {
+                (0, _config.log)("router", "warn", `Ignore invalid api module: ${modPath}`);
+                return;
+            }
+            const dirMws = resolveDirMiddlewares(route.api, middlewares);
+            router[route.method === "delete" ? "del" : route.method].apply(router, [
+                route.api,
+                ...dirMws,
+                ...route.middlewares,
+                route.handler
+            ]);
+            (0, _config.log)("router", `Handling API >>> [${route.method}] ${route.api}`);
+        });
+    }
+    // 框架内置业务
     var _p = _path.default.resolve(__dirname, API_BUSINESS_DIR);
-    if ((0, _common).checkFileStat(_p)) {
-        walk(_p, {}, processBusiness);
+    if ((0, _common.checkFileStat)(_p)) {
+        register(_p);
     }
-    // 支持自定义 api
-    _p = _path.default.resolve(process.cwd(), _defaultXConfig.default.businessDir, API_BUSINESS_DIR);
-    if (process.cwd() !== __dirname && (0, _common).checkFileStat(_p)) {
-        walk(_p, {}, processBusiness);
+    // 业务自定义业务
+    _p = _path.default.resolve(process.cwd(), _defaultxconfig.default.businessDir, API_BUSINESS_DIR);
+    if (process.cwd() !== __dirname && (0, _common.checkFileStat)(_p)) {
+        register(_p);
     }
-    processBusiness = null;
     console.log("");
 }
-var _default = appRouter;
-exports.default = _default;
+const _default = appRouter;