@_tc/template-core 0.0.1-bate.2 → 0.0.1-bate.20

package/esm/packages/core/index.js

@@ -0,0 +1,109 @@
+import Koa from "koa";
+import "./types";
+import "../../app/typings";
+import env from "./env";
+import middlewareLoader from "./loader/middleware";
+import routerSchemaLoader from "./loader/router-schema";
+import routerLoader from "./loader/router";
+import controllerLoader from "./loader/controller";
+import serviceLoader from "./loader/service";
+import configLoader from "./loader/config";
+import extendLoader from "./loader/extend";
+import modelLoader from "./loader/model";
+import { resolve } from "../utils/path";
+import { runFileFn } from "../utils/index.js";
+export const loaderModel = modelLoader;
+export const start = (options = {}) => {
+    const app = new Koa();
+    const { frameBaseDir: _frameBaseDir, ..._options } = options;
+    app.options = _options;
+    const baseDir = (app.baseDir = process.cwd());
+    const frameBaseDir = (app.frameBaseDir =
+        _frameBaseDir ?? resolve(__dirname, ".."));
+    app.businessPath = resolve(baseDir, "app");
+    app.framePath = resolve(frameBaseDir, "app");
+    app.paths = [
+        { type: "frame", path: app.framePath },
+        { type: "business", path: app.businessPath },
+    ];
+    app.envs = env();
+    console.log(`-- [start] env: ${app.envs.get()} --`);
+    /**
+     * 第一个挂载
+     * 方便后续 所有带有app的方法中可以通过 app.config 获取配置
+     */
+    configLoader(app);
+    console.log(`-- [start] loader config done --`);
+    /**
+     * 	第二个挂载 扩展的方法
+     * 	因不确定会在何处调用 app.[extendFN]
+     *  所以需要调高挂载顺序
+     */
+    extendLoader(app);
+    console.log(`-- [start] loader extend done --`);
+    /**
+     *	参数校验规则，在中间件之前即可
+     */
+    routerSchemaLoader(app);
+    console.log(`-- [start] loader routerSchema done --`);
+    /**
+     *   service 在 controller 之前即可
+     *  以下俩loader在router前即可
+     */
+    serviceLoader(app);
+    console.log(`-- [start] loader service done --`);
+    controllerLoader(app);
+    console.log(`-- [start] loader controller done --`);
+    /**
+     * 挂载中间件文件
+     */
+    middlewareLoader(app);
+    console.log(`-- [start] loader middleware done --`);
+    // 加载全局中间件
+    mountMiddleware(app);
+    // 最后加载路由
+    routerLoader(app);
+    console.log(`-- [start] loader router done --`);
+    // modelLoader(app);
+    // console.log(`-- [start] loader model done --`);
+    // 启动服务
+    try {
+        const _p = app.config.port || process.env.PORT || "8080";
+        const port = parseInt(_p + "", 10);
+        const host = process.env.IP || "0.0.0.0";
+        app.listen(port, host);
+        console.log(`Server port:${port}`);
+    }
+    catch (error) {
+        console.error(error);
+    }
+    return app;
+};
+const mountMiddleware = (app) => {
+    app.paths.forEach((pathInfo) => {
+        let loaded = false;
+        let lastError = undefined;
+        for (const fileSymbol of ["ts", "js"]) {
+            const fileName = `middleware.${fileSymbol}`;
+            try {
+                const fn = runFileFn(require(resolve(pathInfo.path, fileName)));
+                fn?.(app);
+                console.log(`-- [start] loader ${pathInfo.type} appMiddlerare ${fileName} done -- (${pathInfo.path})`);
+                loaded = true;
+                break;
+            }
+            catch (error) {
+                const err = error;
+                const moduleNotFound = err?.code === "MODULE_NOT_FOUND" &&
+                    typeof err?.message === "string" &&
+                    err.message.includes(fileName);
+                if (!moduleNotFound)
+                    lastError = error;
+            }
+        }
+        if (!loaded && lastError) {
+            console.log(`-- [error] loader ${pathInfo.type} appMiddlerare middleware.(ts|js) error -- (${pathInfo.path})`);
+            console.log(lastError);
+        }
+    });
+};

package/esm/packages/core/loader/config.d.ts

@@ -0,0 +1,10 @@
+import type { KoaApp } from "../types";
+/**
+ * config loader 只处理一级
+ *
+ * @param app 加载 xx/config/ 下的文件
+ *  config/config.default.js
+ */
+declare const _default: (app: KoaApp) => void;
+export default _default;
+//# sourceMappingURL=config.d.ts.map

package/esm/packages/core/loader/config.js

@@ -0,0 +1,43 @@
+import { resolve } from "../../utils/path";
+import { getAllFilesInFolder } from "../../utils/getAllFilesInFolder";
+/**
+ * config loader 只处理一级
+ *
+ * @param app 加载 xx/config/ 下的文件
+ *  config/config.default.js
+ */
+export default (app) => {
+    // 获取业务 config 目录
+    // 加载default 配置
+    // 获取env配置
+    // 加载配置
+    const files = getAllFilesInFolder(app.baseDir, "config");
+    // 框架默认配置
+    const frameFile = getAllFilesInFolder(app.frameBaseDir, "config");
+    const envKey = app.envs.get();
+    const configMap = {
+        default: false,
+        /**
+         * @type {typeof envKey}
+         */
+        [envKey]: false,
+    };
+    let envConfig = {};
+    Object.keys(configMap).forEach((k) => {
+        const configPath = [...frameFile, ...files].filter((f) => f.includes(k));
+        if (configPath.length) {
+            configMap[k] = true;
+            const configFile = configPath.reduce((preData, currentPath) => ({
+                ...preData,
+                ...require(resolve(currentPath)),
+            }), {});
+            envConfig = [envConfig, configFile][k === "default" ? "reduceRight" : "reduce"]((o, c) => ({ ...o, ...c }), {});
+        }
+    });
+    if (!configMap.default || !configMap[envKey]) {
+        console.error(!configMap.default
+            ? "[excption] Missing default configuration"
+            : "[excption] Missing [env] configuration");
+    }
+    app.config = envConfig;
+};

package/esm/packages/core/loader/controller.d.ts

@@ -0,0 +1,18 @@
+import type { KoaApp } from '../types';
+/**
+* 加载 xx/app/controller 文件夹下所有文件，可通过'app.controller.$｛目录｝.＇｝，访问
+*
+例子：
+    app/controller
+
+        |-- cuStom-moduLe
+
+        |-- custom-midd Leware.js
+
+    => app.controller.customModule. customMiddleware
+ *
+ * @param app
+ */
+declare const _default: (app: KoaApp) => void;
+export default _default;
+//# sourceMappingURL=controller.d.ts.map

package/esm/packages/core/loader/controller.js

@@ -0,0 +1,38 @@
+import { resolve } from '../../utils/path';
+import { loadFileFn } from '../../utils/loadFile';
+import { getAppPaths } from '../paths';
+import { runFileFn } from '../../utils/index.js';
+/**
+* 加载 xx/app/controller 文件夹下所有文件，可通过'app.controller.$｛目录｝.＇｝，访问
+*
+例子：
+    app/controller
+
+        |-- cuStom-moduLe
+
+        |-- custom-midd Leware.js
+
+    => app.controller.customModule. customMiddleware
+ *
+ * @param app
+ */
+export default (app) => {
+    /**
+     * 接收的是 (app) => class xxx{}
+     */
+    // app.controller = loadFileFn<IController>(app.businessPath, 'controller', {
+    // 	loadFileCallback: (file: string) => {
+    // 		const Controller = require(resolve(file))(app);
+    // 		return new Controller();
+    // 	},
+    // });
+    app.controller = getAppPaths(app).reduce((preData, currentPath) => ({
+        ...preData,
+        ...loadFileFn(currentPath, 'controller', {
+            loadFileCallback: (file) => {
+                const Controller = runFileFn(require(resolve(file)))(app);
+                return new Controller();
+            },
+        }),
+    }), {});
+};

package/esm/packages/core/loader/extend.d.ts

@@ -0,0 +1,9 @@
+import type { KoaApp } from "../types";
+/**
+ *  extend loader  扩展  koa app属性  只加载一级
+ *
+ *  加载 xx/app/extend 文件，可通过 'app.extends.${文件}' 访问
+ */
+declare const _default: (app: KoaApp) => void;
+export default _default;
+//# sourceMappingURL=extend.d.ts.map

package/esm/packages/core/loader/extend.js

@@ -0,0 +1,39 @@
+import { loadFileFn } from "../../utils/loadFile";
+import { resolve } from "../../utils/path";
+import { getAppPaths } from "../paths";
+import { runFileFn } from "../../utils/index.js";
+/**
+ *  extend loader  扩展  koa app属性  只加载一级
+ *
+ *  加载 xx/app/extend 文件，可通过 'app.extends.${文件}' 访问
+ */
+export default (app) => {
+    // 加载extend 文件夹内容
+    // 将属性挂在到app上
+    // 可统一管理 extends
+    app.extends = { ...app.extends };
+    getAppPaths(app).forEach((currentPath) => {
+        loadFileFn(currentPath, "extend", {
+            processingFileCallback: ((fileName, filePath, isDir) => {
+                if (!isDir) {
+                    for (const key in app) {
+                        if (key === fileName) {
+                            console.log("\x1b[31m%s\x1b[0m", `[extend loader error] name:${fileName} is already in app`);
+                            return undefined;
+                        }
+                    }
+                    const exs = runFileFn(require(resolve(filePath)))(app);
+                    if (exs instanceof Promise) {
+                        (async () => {
+                            app.extends[fileName] = await exs;
+                        })();
+                    }
+                    else {
+                        app.extends[fileName] = exs;
+                    }
+                }
+                return undefined;
+            }),
+        });
+    });
+};

package/esm/packages/core/loader/middleware.d.ts

@@ -0,0 +1,12 @@
+import type { KoaApp } from '../types';
+/**
+ *
+ *  middleware loader
+ *
+ * @param app
+ *
+ *  加载 xx/app/middleware 文件夹下所有文件，可通过 'app.middleware.${目录}.${文件}' 访问
+ */
+declare const _default: (app: KoaApp) => void;
+export default _default;
+//# sourceMappingURL=middleware.d.ts.map

package/esm/packages/core/loader/middleware.js

@@ -0,0 +1,36 @@
+import { loadFileFn } from '../../utils/loadFile';
+import { getAppPaths } from '../paths';
+import { runFileFn } from '../../utils/index.js';
+/**
+ *
+ *  middleware loader
+ *
+ * @param app
+ *
+ *  加载 xx/app/middleware 文件夹下所有文件，可通过 'app.middleware.${目录}.${文件}' 访问
+ */
+export default (app) => {
+    // 读取 middleware/**/*.js
+    // 加载文件到app.middleware下
+    /**
+     * xx/app/middleware/a/a.js -> app.middleware.a.a =
+     *  require('app/middleware/a/a.js')(app)
+     */
+    // 获取框架中间件
+    // const frameMiddlewares = loadFileFn(app.framePath, 'middleware', {
+    // 	loadFileCallback: (path) => require(path)(app),
+    // });
+    // // 获取业务中间件
+    // const businessMiddlewares = loadFileFn(app.businessPath, 'middleware', {
+    // 	loadFileCallback: (path) => require(path)(app),
+    // });
+    // app.middlewares = { ...frameMiddlewares, ...businessMiddlewares };
+    app.middlewares = getAppPaths(app).reduce((preData, currentPath) => {
+        const middlewares = loadFileFn(currentPath, 'middleware', {
+            loadFileCallback: (path) => {
+                return runFileFn(require(path))(app);
+            },
+        });
+        return { ...preData, ...middlewares };
+    }, {});
+};

package/esm/packages/core/loader/model.d.ts

@@ -0,0 +1,37 @@
+import { KoaApp } from '../types';
+/**
+ *  xx/model/* ->
+ *  [
+ *      {
+ *          model:{
+ *              key: '',
+ *              ...model.config
+ *          }
+ *          project: {
+ *              [projectKey]: {
+ *                  ...project.config,
+ *                  key:string,
+ *              }
+ *          }
+ *      }
+ *  ]
+ *
+ */
+export interface ModelItem {
+    model: {
+        key: string;
+        [k: string]: any;
+    };
+    project: {
+        key: string;
+        [k: string]: any;
+    };
+}
+export type ModelConfig = ModelItem[];
+/**
+ *
+ * @param app
+ */
+declare const modelLoader: (app: KoaApp) => ModelConfig;
+export default modelLoader;
+//# sourceMappingURL=model.d.ts.map

package/esm/packages/core/loader/model.js

@@ -0,0 +1,127 @@
+import { sep } from 'path';
+import { loadFileFn } from '../../utils/loadFile';
+import _ from 'lodash';
+/**
+ *
+ * @param app
+ */
+const modelLoader = (app) => {
+    /**
+     * @type {ModelConfig}
+     */
+    const modelConfig = [];
+    loadFileFn(app.baseDir, 'model', {
+        /**
+         *  1.遍历当前文件夹
+         *  2.根据路径区分 model ｜ project
+         *  3.根据不同的 类型后去key
+         */
+        loadFileCallback: (file) => {
+            // 只有不为model/index.js 的文件
+            if (file.indexOf(`model${sep}index.js`) === -1) {
+                const filePathChunk = file.split(sep);
+                const suspectedFileType = filePathChunk[filePathChunk.length - 2];
+                if (suspectedFileType === 'project') {
+                    // project
+                    const modelKey = filePathChunk[filePathChunk.length - 3];
+                    const projectKey = filePathChunk[filePathChunk.length - 1]?.split('.')[0];
+                    if (modelKey && projectKey) {
+                        setProject(modelConfig, modelKey, projectKey, file);
+                    }
+                }
+                else {
+                    // model
+                    const modelKey = filePathChunk[filePathChunk.length - 2];
+                    if (modelKey) {
+                        setModel(modelConfig, modelKey, file);
+                    }
+                }
+            }
+        },
+    });
+    // 数据进行继承
+    modelConfig.forEach((config) => {
+        const { model, project } = config;
+        for (const key in project) {
+            const projectConfig = project[key];
+            if (projectConfig) {
+                project[key] = etendsObj(model, projectConfig);
+            }
+        }
+    });
+    return modelConfig;
+};
+/**
+ *
+ * @param model
+ * @param project
+ */
+function etendsObj(model, project) {
+    return _.mergeWith({}, model, project, function customizer(modelValue, projectValue) {
+        // 处理数组合并
+        if (Array.isArray(modelValue) && Array.isArray(projectValue)) {
+            let result = [];
+            // 都存在 修改/覆盖 (重载)
+            // project 不存在  (继承)
+            // model 不存在    (拓展)
+            // 修改 ｜ 保留
+            for (let index = 0; index < modelValue.length; index++) {
+                const modelItem = modelValue[index];
+                const projectItem = projectValue.find((p) => p.key === modelItem.key);
+                result.push(projectItem
+                    ? etendsObj(modelItem, projectItem)
+                    : modelItem);
+            }
+            // 新增
+            for (let index = 0; index < projectValue.length; index++) {
+                const projectItem = projectValue[index];
+                const modelItem = modelValue.find((m) => m.key === projectItem.key);
+                if (!modelItem) {
+                    result.push(projectItem);
+                }
+            }
+            return result;
+        }
+    });
+}
+/**
+ *
+ * 副作用函数
+ * @param config
+ * @param modelKey
+ * @param key
+ * @param file
+ */
+const setProject = (config, modelKey, key, file) => {
+    const currentModel = setModel(config, modelKey);
+    const projectItem = {
+        key,
+        modelKey,
+        ...require(file),
+    };
+    currentModel.project[key] = projectItem;
+};
+/**
+ *
+ * 副作用函数
+ * @param config
+ * @param key
+ * @param filePath
+ */
+const setModel = (config, key, filePath) => {
+    let modelItem = config.find((i) => i.model.key === key);
+    // 初始化model数据
+    if (!modelItem) {
+        const newModel = {
+            model: { key },
+            project: { key },
+        };
+        config.push(newModel);
+        modelItem = newModel;
+    }
+    if (filePath) {
+        modelItem.model = { ...require(filePath), key };
+    }
+    return modelItem;
+};
+export default modelLoader;

package/esm/packages/core/loader/router-schema.d.ts

@@ -0,0 +1,19 @@
+import { KoaApp } from '../types';
+/**
+ *
+ *  router-schema loader 只处理一级
+ *
+ * @param app
+ *
+ * xx/app/router-schema/**.js
+ *
+ * 输出：
+ *  app.routerSchema = {
+ *      [api1]: jsonSchema
+ *  }
+ *
+ *
+ */
+declare const _default: (app: KoaApp) => void;
+export default _default;
+//# sourceMappingURL=router-schema.d.ts.map

package/esm/packages/core/loader/router-schema.js

@@ -0,0 +1,33 @@
+import { loadFileFn } from '../../utils/loadFile';
+import { resolve } from '../../utils/path';
+import { getAppPaths } from '../paths';
+/**
+ *
+ *  router-schema loader 只处理一级
+ *
+ * @param app
+ *
+ * xx/app/router-schema/**.js
+ *
+ * 输出：
+ *  app.routerSchema = {
+ *      [api1]: jsonSchema
+ *  }
+ *
+ *
+ */
+export default (app) => {
+    // 加载 app/router-schema/**.js
+    let routerSchema = {};
+    getAppPaths(app).forEach((currentPath) => {
+        loadFileFn(currentPath, 'router-schema', {
+            preProcessingFileCallback(file) {
+                routerSchema = {
+                    ...routerSchema,
+                    ...require(resolve(file)),
+                };
+            },
+        });
+    });
+    app.routerSchema = routerSchema;
+};

package/esm/packages/core/loader/router.d.ts

@@ -0,0 +1,9 @@
+import { KoaApp } from "../types";
+/**
+ * reouter loader
+ *
+ * 解析 xx/app/router/下的所有文件 加载到 koa-router上
+ */
+declare const _default: (app: KoaApp) => void;
+export default _default;
+//# sourceMappingURL=router.d.ts.map

package/esm/packages/core/loader/router.js

@@ -0,0 +1,57 @@
+import KoaRouter from "koa-router";
+import { loadFileFn } from "../../utils/loadFile";
+import { resolve } from "../../utils/path";
+import { getAppPath, getAppPaths } from "../paths";
+import { runFileFn } from "../../utils/index.js";
+/**
+ * reouter loader
+ *
+ * 解析 xx/app/router/下的所有文件 加载到 koa-router上
+ */
+export default (app) => {
+    // 找到路由文件
+    // 实例化 KoaRouter
+    // 注册所有路由
+    // 路由}
+    const router = new KoaRouter();
+    let routerGuard;
+    try {
+        // 在app目录下寻找
+        const businessPath = getAppPath(app, "business");
+        if (businessPath) {
+            routerGuard = runFileFn(require(resolve(businessPath, "router-guard.js")))(app);
+        }
+    }
+    catch (error) {
+        console.info("-- [router-guard] -- not router-guard.js file");
+    }
+    getAppPaths(app).forEach((currentPath) => {
+        loadFileFn(currentPath, "router", {
+            preProcessingFileCallback: (filePath) => {
+                /**
+                 *  module.export = (app,router) => {
+                 *      router.get('/xxx/xxxx', app.controller)
+                 *  }
+                 */
+                runFileFn(require(resolve(filePath)))(app, router);
+            },
+        });
+    });
+    router.get("(.*)", async (ctx, _next) => {
+        console.info("\x1b[31m%s\x1b[0m", `-- notFound path: ${ctx.path} --`);
+        ctx.status = 302; // 临时重定向
+        const executionResults = routerGuard?.(ctx);
+        if (executionResults) {
+            ctx.redirect(executionResults ?? "/");
+        }
+        else {
+            ctx.redirect(app.options?.homePage ?? "/");
+        }
+        // throw new Error();
+        return;
+        // await next();
+    });
+    app.use(router.routes()); // koa 注入路由 中间件
+    app.use(router.allowedMethods()); // 允许所有请求方式
+    app.currentUseRouter = router;
+};

package/esm/packages/core/loader/service.d.ts

@@ -0,0 +1,18 @@
+import type { KoaApp } from '../types';
+/**
+* 加载 xx/app/service 文件夹下所有文件 可通过'app.service.$｛目录｝.．｝，访问
+*
+例子：
+    app/service
+
+        |-- cuStom-moduLe
+
+        |-- custom-midd Leware.js
+
+    => app.service.customModule. customMiddleware
+ *
+ * @param app
+ */
+declare const _default: (app: KoaApp) => void;
+export default _default;
+//# sourceMappingURL=service.d.ts.map

package/esm/packages/core/loader/service.js

@@ -0,0 +1,28 @@
+import { loadFileFn } from '../../utils/loadFile';
+import { getAppPaths } from '../paths';
+import { runFileFn } from '../../utils/index.js';
+/**
+* 加载 xx/app/service 文件夹下所有文件 可通过'app.service.$｛目录｝.．｝，访问
+*
+例子：
+    app/service
+
+        |-- cuStom-moduLe
+
+        |-- custom-midd Leware.js
+
+    => app.service.customModule. customMiddleware
+ *
+ * @param app
+ */
+export default (app) => {
+    app.service = getAppPaths(app).reduce((preData, currentPath) => ({
+        ...preData,
+        ...loadFileFn(currentPath, 'service', {
+            loadFileCallback: (file) => {
+                const Service = runFileFn(require(file))(app);
+                return new Service();
+            },
+        }),
+    }), {});
+};

package/esm/packages/core/paths.js

@@ -0,0 +1,6 @@
+export function getAppPath(app, type) {
+    return app.paths?.find((p) => p.type === type)?.path;
+}
+export function getAppPaths(app) {
+    return (app.paths ?? []).map((p) => p.path);
+}