@_tc/template-core 0.0.1-bate.8 → 0.0.1-bate.9

package/{packages → cjs/packages}/core/loader/service.js

@@ -3,6 +3,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const loadFile_1 = require("../../utils/loadFile");
 const paths_1 = require("../paths");
 const utils_1 = require("../../utils/index.js");
+/**
+* 加载 xx/app/service 文件夹下所有文件 可通过'app.service.$｛目录｝.．｝，访问
+*
+例子：
+    app/service
+
+        |-- cuStom-moduLe
+
+        |-- custom-midd Leware.js
+
+    => app.service.customModule. customMiddleware
+ *
+ * @param app
+ */
 exports.default = (app) => {
     app.service = (0, paths_1.getAppPaths)(app).reduce((preData, currentPath) => ({
         ...preData,

package/cjs/packages/core/paths.d.ts

@@ -0,0 +1,11 @@
+export type AppPathType = "frame" | "business";
+export interface AppPathInfo {
+    type: AppPathType;
+    path: string;
+}
+export declare function getAppPath(app: {
+    paths?: AppPathInfo[];
+}, type: AppPathType): string | undefined;
+export declare function getAppPaths(app: {
+    paths?: AppPathInfo[];
+}): string[];

package/{packages → cjs/packages}/core/types.d.ts

@@ -70,5 +70,5 @@ export interface AppOptions extends StartOptions {
 export type KoaApp = Koa & KoaAppExtensions;
 export type KoaMiddleware = Koa.Middleware;
 export type { EnvType, EnvKeys } from "./env";
+/** 文件处理回调函数 */
 export type ProcessingFileCallbackFN = <T extends Record<string, unknown>>(fileName: string, filePath: string, isDir: boolean, tempData: T) => T | undefined;
-//# sourceMappingURL=types.d.ts.map

package/{packages → cjs/packages}/utils/getAllFilesInFolder.d.ts

@@ -1,5 +1,9 @@
 export interface GetAllFilesInFolder {
+    /**
+     *
+     * @param paths
+     * @returns filesPath
+     */
     getAllFilesInFolder(...paths: string[]): string[];
 }
 export declare const getAllFilesInFolder: (...paths: string[]) => string[];
-//# sourceMappingURL=getAllFilesInFolder.d.ts.map

package/cjs/packages/utils/getAllFnReturnValue.js

@@ -0,0 +1,6 @@
+"use strict";
+// export const getAllFnReturnValue =<T>(fnValue: T | Promise<T> ) =>{
+// if(fnValue instanceof Promise){
+//     retu
+// }
+// }

package/cjs/packages/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./path";
+export * from "./loadFile";
+export * from "./getAllFilesInFolder";
+export * from "./runFileFn";

package/{packages → cjs/packages}/utils/loadFile.d.ts

@@ -6,10 +6,15 @@ export interface LoadFileCallbackOptions {
     processingFileCallback?: ProcessingFileCallbackFN;
     preProcessingFileCallback?: PreProcessingFileCallbackFN;
 }
+/**
+ *
+ * @param baseDir
+ * @param key
+ * @param callbackOpt
+ */
 declare function loadFileFn<T extends Record<string, unknown>>(baseDir: string, key: string, callbackOpt?: LoadFileCallbackOptions): T;
 export { loadFileFn };
 declare const _default: {
     loadFileFn: typeof loadFileFn;
 };
 export default _default;
-//# sourceMappingURL=loadFile.d.ts.map

package/{packages → cjs/packages}/utils/loadFile.js

@@ -4,6 +4,12 @@ exports.loadFileFn = loadFileFn;
 const getAllFilesInFolder_1 = require("./getAllFilesInFolder");
 const path_1 = require("./path");
 const path_2 = require("path");
+/**
+ *
+ * @param baseDir
+ * @param key
+ * @param callbackOpt
+ */
 function loadFileFn(baseDir, key, callbackOpt) {
     const { loadFileCallback, processingFileCallback, preProcessingFileCallback, } = callbackOpt ?? {};
     if (!key ||
@@ -15,6 +21,7 @@ function loadFileFn(baseDir, key, callbackOpt) {
             ? processingFileCallback
             : (fileName, filePath, isDir, tempData) => {
                 if (!isDir) {
+                    // 最后一级
                     const fileContent = loadFileCallback(filePath);
                     if (fileContent)
                         tempData[fileName] = fileContent;
@@ -33,6 +40,7 @@ function loadFileFn(baseDir, key, callbackOpt) {
                 const searchString = (0, path_1.splicing)(key, { position: "after" });
                 const file = name;
                 name = name.substring(name.lastIndexOf(searchString) + searchString.length, name.lastIndexOf("."));
+                //  -_ 转为驼峰
                 name = name.replace(/[_-].{1}/gi, (key) => key[1].toUpperCase());
                 let tempData = result;
                 const names = name.split(path_2.sep);
@@ -49,6 +57,7 @@ function loadFileFn(baseDir, key, callbackOpt) {
     const fileList = (0, getAllFilesInFolder_1.getAllFilesInFolder)(baseDir, key);
     let result = {};
     fileList.forEach((file) => {
+        // 提取文件名称
         result = _preProcessingFileCallback((0, path_1.resolve)(file), result);
     });
     return result;

package/cjs/packages/utils/path.d.ts

@@ -0,0 +1,24 @@
+export interface SplicingOptions {
+    /**
+     * @default '/''
+     */
+    symbol?: string;
+    /**
+     * @default before
+     */
+    position?: "after" | "before";
+}
+/**
+ *  splicing('path') : /path
+ */
+export declare function splicing(str: string, opt?: SplicingOptions): string;
+/**
+ *
+ * @param paths
+ * @description input [a,b,c] -> out a/b/c
+ *
+ * window: input [a,b,c] -> out a\b\c
+ *
+ * 拼接路径
+ */
+export declare function resolve(...paths: string[]): string;

package/{packages → cjs/packages}/utils/path.js

@@ -37,13 +37,27 @@ exports.splicing = splicing;
 exports.resolve = resolve;
 const path = __importStar(require("path"));
 const path_1 = require("path");
+/**
+ *  splicing('path') : /path
+ */
 function splicing(str, opt) {
     const { symbol, position } = opt ?? {
         symbol: path_1.sep,
         position: "before",
     };
+    // before <- symbol + str
+    // after -> str + symbol
     return [str, symbol][position === "before" ? "reduceRight" : "reduce"]((o, c) => o + c, "");
 }
+/**
+ *
+ * @param paths
+ * @description input [a,b,c] -> out a/b/c
+ *
+ * window: input [a,b,c] -> out a\b\c
+ *
+ * 拼接路径
+ */
 function resolve(...paths) {
     const [basePath, ...otherPath] = paths;
     return path.resolve(basePath, otherPath.length ? "." + splicing(otherPath.join(path_1.sep)) : "");

package/cjs/packages/utils/runFileFn.d.ts

@@ -0,0 +1,5 @@
+type AnyFun = (...p: any[]) => any;
+export declare const runFileFn: (fn: {
+    default: AnyFun;
+} | AnyFun) => AnyFun;
+export {};

package/cjs/typings/type.d.ts

@@ -0,0 +1,4 @@
+export type MOmit<T, K extends keyof T> = Omit<T, K>;
+export type UnionToTuple<T> = [
+    T
+] extends [never] ? [] : ((t: T) => T) extends ((t: infer U) => infer U) ? [...UnionToTuple<Exclude<T, U>>, U] : never;

package/esm/app/controller/base.d.ts

@@ -0,0 +1,14 @@
+import { KoaApp } from "../type";
+import { Ctx } from "../type";
+declare const _default: (app: KoaApp) => {
+    new (): {
+        readonly app: KoaApp;
+        readonly config: KoaApp["config"];
+        get service(): import("../../packages/core/index.js").FrameworkAugment.IServiceAugmented;
+        success(ctx: Ctx, data: unknown): void;
+        fail(ctx: Ctx, code: number, message: string): void;
+        sendData(ctx: Ctx, data?: unknown, code?: number, message?: string | null, status?: number): void;
+    };
+};
+export default _default;
+//# sourceMappingURL=base.d.ts.map

package/esm/app/controller/base.js

@@ -0,0 +1,21 @@
+export default (app) => class BaseController {
+    app;
+    config;
+    constructor() {
+        this.app = app;
+        this.config = app.config;
+    }
+    get service() {
+        return app.service;
+    }
+    success(ctx, data) {
+        this.sendData(ctx, data);
+    }
+    fail(ctx, code, message) {
+        this.sendData(ctx, null, code, message);
+    }
+    sendData(ctx, data = null, code = 0, message = null, status = 200) {
+        ctx.status = status;
+        ctx.body = { data, code, message };
+    }
+};

package/esm/app/controller/project.d.ts

@@ -0,0 +1,12 @@
+import { KoaApp } from '../type';
+import { Ctx } from '../type';
+export interface IProjectController {
+    getModelList(ctx: Ctx): Promise<void>;
+    getProjectList(ctx: Ctx): Promise<void>;
+    getProject(ctx: Ctx): Promise<void>;
+    success(ctx: Ctx, data: unknown): void;
+    fail(ctx: Ctx, code: number, message: string): void;
+}
+declare const getProjectController: (app: KoaApp) => new () => IProjectController;
+export default getProjectController;
+//# sourceMappingURL=project.d.ts.map

package/{app → esm/app}/controller/project.js

@@ -1,11 +1,6 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const base_1 = __importDefault(require("./base"));
+import getBaseController from './base';
 const getProjectController = (app) => {
-    const BaseController = (0, base_1.default)(app);
+    const BaseController = getBaseController(app);
     return class ProjectController extends BaseController {
         getModelList = async (ctx) => {
             const res = await this.service.project.getModelList();
@@ -44,4 +39,4 @@ const getProjectController = (app) => {
         };
     };
 };
-exports.default = getProjectController;
+export default getProjectController;

package/esm/app/controller/view.d.ts

@@ -0,0 +1,9 @@
+import { KoaApp } from "../type";
+import { Ctx } from "../type";
+declare const getViewController: (app: KoaApp) => {
+    new (): {
+        renderPage(ctx: Ctx): Promise<void>;
+    };
+};
+export default getViewController;
+//# sourceMappingURL=view.d.ts.map

package/esm/app/controller/view.js

@@ -0,0 +1,12 @@
+const getViewController = (app) => class ViewController {
+    async renderPage(ctx) {
+        app.extends.renderView(`dist/entry.${ctx.params.page}`, ctx, {
+            projKey: ctx.query.proj_key,
+            name: app.options?.name,
+            env: app.envs.get(),
+            basePath: `/view/${ctx.params.page}`,
+            options: JSON.stringify(app.options),
+        });
+    }
+};
+export default getViewController;

package/esm/app/data/signKey.js

@@ -0,0 +1 @@
+export const signKey = "sakjdfnkjwjfnfkjkjldljksndf";

package/esm/app/extend/db.js

@@ -0,0 +1,9 @@
+export default async function getDB(app) {
+    // const Knex = (await import("knex")).default;
+    // const dbConfig = app.config?.db;
+    // if (!dbConfig) return;
+    // const kn = Knex(dbConfig as Parameters<typeof Knex>[0]);
+    // return kn;
+    console.log(app);
+    return {};
+}

package/esm/app/extend/generateErrorMessage.js

@@ -0,0 +1,12 @@
+export default () => {
+    /**
+     * 抛 出一个异常 打断洋葱模型
+     */
+    return (message, option) => {
+        const err = new Error(message);
+        err.status = option?.status;
+        err.code = option?.code;
+        err.returnError = option?.showError;
+        throw err;
+    };
+};

package/esm/app/extend/logger.js

@@ -0,0 +1,37 @@
+export default async (app) => {
+    let logger = console;
+    if (app.envs.get() !== "local") {
+        const log4js = await import("log4js");
+        log4js.configure({
+            appenders: {
+                console: {
+                    type: "console",
+                },
+                dateFile: {
+                    type: "dateFile",
+                    filename: "./log/application.log",
+                    pattern: ".yyyy-MM-dd",
+                },
+            },
+            categories: {
+                default: {
+                    appenders: ["console", "dateFile"],
+                    level: "trace",
+                },
+            },
+        });
+        const log4jsLogger = log4js.getLogger();
+        const overwriteOriginalLogs = app.options.overwriteOriginalLogs ??
+            process.env.overwriteOriginalLogs !== "false";
+        if (overwriteOriginalLogs) {
+            console.log = log4jsLogger.info.bind(log4jsLogger);
+            console.info = log4jsLogger.info.bind(log4jsLogger);
+            console.warn = log4jsLogger.warn.bind(log4jsLogger);
+            console.error = log4jsLogger.error.bind(log4jsLogger);
+            console.debug = log4jsLogger.debug.bind(log4jsLogger);
+            console.trace = log4jsLogger.trace.bind(log4jsLogger);
+        }
+        logger = log4jsLogger;
+    }
+    return logger;
+};

package/esm/app/extend/parsingParamsOnUrl.js

@@ -0,0 +1,20 @@
+export default () => {
+    return (urlRules, url) => {
+        const urlRulesChunk = urlRules.split('/');
+        const urlChunk = url.split('/');
+        if (urlRulesChunk.length !== urlChunk.length) {
+            return null;
+        }
+        const keySubscript = {};
+        urlRulesChunk.forEach((chunk, index) => {
+            if (chunk.indexOf(':') >= 0) {
+                const key = chunk.slice(1);
+                keySubscript[key] = index;
+            }
+        });
+        return Object.entries(keySubscript).reduce((o, [key, index]) => {
+            o[key] = urlChunk[index] ?? '';
+            return o;
+        }, {});
+    };
+};

package/esm/app/extend/render-view.d.ts

@@ -0,0 +1,5 @@
+import type { KoaApp } from "../type";
+import type { Ctx } from "../type";
+declare const _default: (app: KoaApp) => (view: string, ctx: Ctx, context?: Record<string, unknown>) => void;
+export default _default;
+//# sourceMappingURL=render-view.d.ts.map

package/esm/app/extend/render-view.js

@@ -0,0 +1,16 @@
+import nunjucks from "nunjucks";
+export default (app) => {
+    const viewsPath = app.config.viewsPath ?? "views";
+    const env = nunjucks.configure(viewsPath, {
+        autoescape: true,
+        throwOnUndefined: false,
+        trimBlocks: false,
+        lstripBlocks: false,
+        noCache: app.envs.get() === "local",
+        ...(typeof app.config.nunjucks === "object" ? app.config.nunjucks : {}),
+    });
+    app.extends.nunjucksEnv = env;
+    return (view, ctx, context) => {
+        ctx.body = env.render(view, Object.assign({}, ctx.state, context));
+    };
+};

package/esm/app/middleware/api-params-verify.d.ts

@@ -0,0 +1,6 @@
+import type Koa from "koa";
+import { KoaApp } from "../type";
+import { Ctx } from "../type";
+declare const _default: (app: KoaApp) => (ctx: Ctx, next: Koa.Next) => Promise<any>;
+export default _default;
+//# sourceMappingURL=api-params-verify.d.ts.map

package/esm/app/middleware/api-params-verify.js

@@ -0,0 +1,58 @@
+import Ajv from "ajv";
+const ajv = new Ajv();
+const $schema = "http://json-schema.org/draft-07/schema#";
+const validateFN = (key, data, schema) => {
+    if (data[key] && schema[key]) {
+        schema[key].$schema = $schema;
+        const validate = ajv.compile(schema[key]);
+        return [validate(data[key]), validate];
+    }
+    return undefined;
+};
+export default (app) => async (ctx, next) => {
+    const { path, method } = ctx;
+    if (path.indexOf("/api") < 0) {
+        return next();
+    }
+    const currentUseRouter = app.currentUseRouter;
+    const route = currentUseRouter.match(path, "get");
+    const routePath = route.path[0]?.path;
+    if (routePath) {
+        const params = app.extends.parsingParamsOnUrl(routePath, path);
+        const { body, query, headers } = ctx.request;
+        const orginData = {
+            params,
+            body,
+            query,
+            headers,
+        };
+        app.extends.logger?.info(`--[api params verify] [${method} ${path}] body: ${JSON.stringify(body)}--`);
+        app.extends.logger?.info(`--[api params verify] [${method} ${path}] query: ${JSON.stringify(query)}--`);
+        app.extends.logger?.info(`--[api params verify] [${method} ${path}] params: ${JSON.stringify(params)}--`);
+        app.extends.logger?.info(`--[api params verify] [${method} ${path}] headers: ${JSON.stringify(headers)}--`);
+        const schema = app.routerSchema[routePath]?.[method.toLowerCase()];
+        if (schema) {
+            let valid = true;
+            let validate;
+            const checkList = ["headers", "body", "query", "params"];
+            for (let index = 0; index < checkList.length; index++) {
+                const key = checkList[index];
+                if (valid) {
+                    const result = validateFN(key, { ...orginData }, schema);
+                    valid = result?.[0] ?? true;
+                    validate = result?.[1];
+                }
+                break;
+            }
+            if (!valid) {
+                const message = `request vaidate fail: ${ajv.errorsText(validate?.errors)}`;
+                app.extends.logger?.error(`--[api valid error] message: ${message}--`);
+                app.extends.generateErrorMessage(message, {
+                    showError: true,
+                    code: 442,
+                });
+            }
+        }
+    }
+    return next();
+};

package/esm/app/middleware/api-sign-verify.d.ts

@@ -0,0 +1,6 @@
+import type Koa from "koa";
+import { KoaApp } from "../type";
+import { Ctx } from "../type";
+declare const _default: (app: KoaApp) => (ctx: Ctx, next: Koa.Next) => Promise<void>;
+export default _default;
+//# sourceMappingURL=api-sign-verify.d.ts.map

package/esm/app/middleware/api-sign-verify.js

@@ -0,0 +1,23 @@
+import md5 from "md5";
+const keyTimeOut = 1000 * 60 * 10;
+export default (app) => async (ctx, next) => {
+    const { path, method } = ctx;
+    if (path.includes("api") &&
+        !app.config?.apiSignVerify?.whiteList?.includes(path)) {
+        app.extends.logger?.info("--[api-sign-verify]--");
+        const { s_sign: sSgin, s_t: st } = ctx.request.header;
+        const { signKey } = require("../data/signKey");
+        const signature = md5(`${signKey}_${st}`);
+        app.extends.logger?.info(`[${method} ${path}] signature: ${signature}`);
+        if (!st ||
+            !sSgin ||
+            sSgin.toLowerCase() !== signature ||
+            Date.now() - Number(st) > keyTimeOut) {
+            app.extends.generateErrorMessage("signature not correct or api timeout", {
+                showError: true,
+                code: 100014,
+            });
+        }
+    }
+    await next();
+};

package/esm/app/middleware/error-handle.d.ts

@@ -0,0 +1,6 @@
+import { KoaApp } from '../type';
+import { Ctx } from '../type';
+import type Koa from 'koa';
+declare const _default: (app: KoaApp) => (ctx: Ctx, next: Koa.Next) => Promise<void>;
+export default _default;
+//# sourceMappingURL=error-handle.d.ts.map

package/esm/app/middleware/error-handle.js

@@ -0,0 +1,31 @@
+export default (app) => async (ctx, next) => {
+    try {
+        await next();
+    }
+    catch (error) {
+        const err = error;
+        const { status = 200, message, detail, code = 50000, returnError, } = err;
+        app.extends.logger?.info(`error info -> ${JSON.stringify(error)}`);
+        app.extends.logger?.error('-- [excption] --', error);
+        app.extends.logger?.error('-- [excption] info --', status, message, detail);
+        if (message?.includes('template not found')) {
+            ctx.status = 302;
+            ctx.redirect(app.options?.homePage ?? '/');
+            return;
+        }
+        if (returnError) {
+            ctx.status = status;
+            ctx.body = {
+                code,
+                message,
+            };
+        }
+        else {
+            ctx.status = 200;
+            ctx.body = {
+                code: 50000,
+                message: '网络错误',
+            };
+        }
+    }
+};

package/esm/app/middleware/project-handler.d.ts

@@ -0,0 +1,5 @@
+import { Ctx } from '../type';
+import type Koa from 'koa';
+declare const _default: () => (ctx: Ctx, next: Koa.Next) => Promise<void>;
+export default _default;
+//# sourceMappingURL=project-handler.d.ts.map

package/esm/app/middleware/project-handler.js

@@ -0,0 +1,19 @@
+export default () => async (ctx, next) => {
+    const key = ctx.headers.proj_key;
+    const { path } = ctx;
+    if (path.indexOf('/api/proj/') !== -1) {
+        if (!key || ['undefined', 'null'].includes(key)) {
+            ctx.status = 200;
+            ctx.body = {
+                code: 110,
+                data: null,
+                message: '请求不合法',
+            };
+            return;
+        }
+    }
+    ctx.extInfo = {
+        key,
+    };
+    await next();
+};

package/esm/app/middleware.js

@@ -0,0 +1,55 @@
+import "../packages/core/index.js";
+import "./typings";
+import { resolve } from "path";
+import compress from "koa-compress";
+// import koaNunjucks from "koa-nunjucks-2";
+import koaStatic from "koa-static";
+import kb from "koa-bodyparser";
+const koaBody = kb({
+    formLimit: "1000mb",
+    enableTypes: ["form", "json", "text"],
+});
+export default (app) => {
+    const staticOpt = {
+        // 本地一分钟
+        // 线上1年
+        ...(app.envs.isLocal()
+            ? {
+                maxage: 60 * 1000,
+            }
+            : {
+                maxage: 365 * 24 * 60 * 60 * 1000,
+            }),
+    };
+    const basePublicPath = resolve(app.baseDir, "./app/public");
+    const framePublicPath = resolve(app.frameBaseDir, "./app/public");
+    // 错误捕获  层级越高捕获到的内容越多
+    app.use(app.middlewares.errorHandle);
+    // 开启 gzip 压缩
+    app.use(compress({
+        threshold: 2048, // 大于 2KB 的响应才会压缩
+        // flush: zlib.Z_SYNC_FLUSH,
+    }));
+    // 静态资源
+    app.use(koaStatic(framePublicPath, staticOpt));
+    app.use(koaStatic(basePublicPath, staticOpt));
+    // req.body 解析
+    app.use(koaBody);
+    // 扩展项目信息
+    app.use(app.middlewares.projectHandler);
+    // 渲染模版
+    // use(
+    //   koaNunjucks({
+    //     ext: "tpl",
+    //     path: basePublicPath,
+    //     nunjucksConfig: {
+    //       noCath: true,
+    //       trimBlocks: true,
+    //     },
+    //   }),
+    // );
+    // api 签名校验
+    !app.envs.isLocal() && app.use(app.middlewares.apiSignVerify);
+    // api参数校验
+    app.use(app.middlewares.apiParamsVerify);
+};

package/esm/app/router/project.js

@@ -0,0 +1,6 @@
+export default (app, router) => {
+    const { project: projectController } = app.controller;
+    router.get('/api/project/model_list', projectController.getModelList);
+    router.get('/api/project/list', projectController.getProjectList);
+    router.get('/api/project/:key', projectController.getProject);
+};

package/esm/app/router/view.js

@@ -0,0 +1,3 @@
+export default (app, router) => {
+    router.get(["/view/:page", "/view/:page(.*)"], app.controller.view.renderPage.bind(app.controller.view));
+};