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

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));
+};

package/esm/app/router-schema/project.js

@@ -0,0 +1,31 @@
+const routerSchema = {
+    '/api/project/:key': {
+        get: {
+            params: {
+                type: 'object',
+                properties: {
+                    key: {
+                        type: 'string',
+                    },
+                },
+                required: ['key'],
+            },
+        },
+    },
+    '/api/project/list': {
+        get: {
+            query: {
+                type: 'object',
+                properties: {
+                    proj_key: {
+                        type: 'string',
+                    },
+                },
+            },
+        },
+    },
+    '/api/project/model_list': {
+        get: {},
+    },
+};
+export default routerSchema;

package/esm/app/service/bese.js

@@ -0,0 +1,12 @@
+import superagent from "superagent";
+export default (app) => class BaseService {
+    get app() {
+        return app;
+    }
+    get config() {
+        return app.config;
+    }
+    get curl() {
+        return superagent;
+    }
+};

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

@@ -1,13 +1,9 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const core_1 = require("../../packages/core/index.js");
-const bese_1 = __importDefault(require("./bese"));
+import { loaderModel } from "../../packages/core/index.js";
+import getBaseService from "./bese";
 const getProjectService = (app) => {
-    const BaseService = (0, bese_1.default)(app);
-    const modelData = (core_1.loaderModel)(app);
+    const BaseService = getBaseService(app);
+    // const modelData = require('../../model')(app) as ModelItem[];
+    const modelData = (loaderModel)(app);
     return class ProjectService extends BaseService {
         async getModelList() {
             return modelData;
@@ -35,5 +31,4 @@ const getProjectService = (app) => {
         };
     };
 };
-exports.default = getProjectService;
-//# sourceMappingURL=project.js.map
+export default getProjectService;

package/esm/app/type.js

@@ -0,0 +1 @@
+export {};

package/esm/app/typings.d.ts

@@ -0,0 +1,51 @@
+import type { FrameworkAugment, KoaApp, KoaAppExtensions } from "../packages/core/index.js";
+import type getProjectService from "./service/project";
+import type getProjectController from "./controller/project";
+import type getViewController from "./controller/view";
+import type getDB from "./extend/db";
+import type getLogger from "./extend/logger";
+import type generateErrorMessage from "./extend/generateErrorMessage";
+import type parsingParamsOnUrl from "./extend/parsingParamsOnUrl";
+import renderView from "./extend/render-view";
+type UnwrapPromise<T> = T extends Promise<infer U> ? U : T;
+type GetInstance<T extends (...args: never[]) => unknown> = T extends (...args: never[]) => infer R ? R extends new () => infer C ? C : R extends Promise<infer P> ? P extends new () => infer C2 ? C2 : never : never : never;
+declare module "../packages/core/index.js" {
+    namespace FrameworkAugment {
+        interface IServiceAugmented {
+            project: GetInstance<typeof getProjectService>;
+        }
+        interface IControllerAugmented {
+            project: GetInstance<typeof getProjectController>;
+            view: GetInstance<typeof getViewController>;
+        }
+        interface IExtendsAugmented {
+            db: UnwrapPromise<ReturnType<typeof getDB>>;
+            logger: UnwrapPromise<ReturnType<typeof getLogger>>;
+            generateErrorMessage: ReturnType<typeof generateErrorMessage>;
+            parsingParamsOnUrl: ReturnType<typeof parsingParamsOnUrl>;
+            nunjucksEnv: import("nunjucks").Environment;
+            renderView: ReturnType<typeof renderView>;
+        }
+        interface IMiddlewaresAugmented {
+            errorHandle: import("koa").Middleware;
+            apiSignVerify: import("koa").Middleware;
+            apiParamsVerify: import("koa").Middleware;
+            projectHandler: import("koa").Middleware;
+        }
+        interface AppConfigAugmented {
+            frameName: string;
+            port?: number;
+            host?: string;
+            env?: string;
+            apiSignVerify?: {
+                whiteList?: string[];
+            };
+            viewsPath?: string;
+            nunjucks?: import("nunjucks").ConfigureOptions;
+        }
+    }
+}
+export type { FrameworkAugment };
+export { KoaAppExtensions };
+export type { KoaApp };
+//# sourceMappingURL=typings.d.ts.map

package/esm/app/typings.js

@@ -0,0 +1 @@
+export {};

package/esm/app/view/entry.tpl

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html lang="en" class="dark">
+
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <link rel="icon" type="image/x-icon" href="/static/logo.png">
+    <title>{{name}}</title>
+</head>
+
+<script id="input">
+    window['_basePath'] = '{{basePath}}';
+    window['_projKey'] = '{{projKey}}';
+
+    const tmpDom = document.createElement('div')
+
+    tmpDom.innerHTML = `{{options}}`;
+
+    window['appOptions'] = JSON.parse(tmpDom.innerText || tmpDom.textContent);
+    const s = document.getElementById('input');
+    s.parentElement.removeChild(s)
+</script>
+
+<body>
+    <div id="root"></div>
+</body>
+
+<!-- {{InsertScript}} -->
+
+</html>

package/esm/bundler/dev.d.ts

@@ -0,0 +1,2 @@
+export declare function dev(): Promise<void>;
+//# sourceMappingURL=dev.d.ts.map

package/esm/bundler/dev.js

@@ -0,0 +1,16 @@
+import { entries, VBuildFE, watchFiles } from "./utils";
+const init = async () => {
+    const input = entries();
+    console.log(input);
+    if (!Object.keys(input).length) {
+        console.error("no entry found");
+        process.exit(1);
+    }
+    await VBuildFE(input);
+};
+export async function dev() {
+    // 获取入口
+    await init();
+    // 监听文件变化
+    watchFiles(async () => init());
+}

package/esm/bundler/index.d.ts

@@ -0,0 +1,2 @@
+export declare const buildFE: (mode: "dev" | "prod") => void;
+//# sourceMappingURL=index.d.ts.map

package/esm/bundler/index.js

@@ -0,0 +1,14 @@
+import { dev } from "./dev";
+import { prod } from "./prod";
+export const buildFE = (mode) => {
+    switch (mode) {
+        case "dev":
+            dev();
+            break;
+        case "prod":
+            prod();
+            break;
+        default:
+            console.log("Usage: npx tsx scripts/index.ts [dev|prod]");
+    }
+};

package/esm/bundler/prod.d.ts

@@ -0,0 +1,2 @@
+export declare function prod(): Promise<void>;
+//# sourceMappingURL=prod.d.ts.map

package/esm/bundler/prod.js

@@ -0,0 +1,16 @@
+import { entries, VBuildFE } from "./utils";
+export async function prod() {
+    const input = entries();
+    if (!Object.keys(input).length) {
+        console.error("no entry found");
+        process.exit(1);
+    }
+    try {
+        await VBuildFE(input);
+        console.log("build done");
+    }
+    catch (err) {
+        console.error(String(err));
+        process.exit(1);
+    }
+}

package/esm/bundler/utils.d.ts

@@ -0,0 +1,10 @@
+/**
+ *
+ * 寻找 frontend\/**\/*.entry.[j|t]s(x)?
+ * 生成入口
+ */
+export declare function entries(): Record<string, string>;
+export declare function outDir(): string;
+export declare const watchFiles: (callback?: () => Promise<any>) => Promise<void>;
+export declare const VBuildFE: (input: Record<string, string>) => Promise<void>;
+//# sourceMappingURL=utils.d.ts.map

package/esm/bundler/utils.js

@@ -0,0 +1,171 @@
+import path from "path";
+import * as glob from "glob";
+import { build } from "vite";
+import { resolve } from "../packages/utils";
+import { copyFileSync, existsSync, readdirSync, readFileSync, rmdirSync, unlinkSync, writeFileSync, } from "fs";
+const base = process.cwd();
+// 瞄准输出后的产物路径
+const framePath = path.resolve(__dirname, "../../");
+const frameNodePath = path.resolve(__dirname, "../");
+const frameFEPath = path.resolve(framePath, "./fe/frontend");
+const runPath = path.resolve(base, ".");
+const runFEPath = path.resolve(runPath, "./frontend");
+/**
+ *
+ * 寻找 frontend\/**\/*.entry.[j|t]s(x)?
+ * 生成入口
+ */
+export function entries() {
+    console.log("frameFEPath: ", frameFEPath);
+    console.log("runFEPath: ", runFEPath);
+    /**
+     * 所有包含 entry 的文件
+     */
+    const files = [frameFEPath, runFEPath].reduce((o, fileDir) => {
+        const fileType = ["js", "jsx", "ts", "tsx"].map((fileExtension) => resolve(fileDir, "/**", "/*." + fileExtension));
+        const files = glob
+            .sync(fileType)
+            .filter((fileName) => fileName.includes(".entry."))
+            .filter((fileName) => !fileName.includes(".d.ts"));
+        return [...o, ...files];
+    }, []);
+    const input = {};
+    if (!files.length)
+        return input;
+    /**
+     * 查找 file 同级是否存在 .html 文件
+     * 如果存在直接使用 如果不存在 生成一份
+     */
+    let templateHtml;
+    for (let index = 0; index < files.length; index++) {
+        const filePath = files[index];
+        const fileDIr = path.resolve(filePath, "../");
+        const fileHtml = glob.sync(resolve(fileDIr, "*.html"))[0];
+        if (!fileHtml) {
+            if (!templateHtml) {
+                templateHtml = readFileSync(path.resolve(frameNodePath, "./app/view/entry.tpl"), "utf-8");
+            }
+            //
+            const scriptStr = filePath.split(path.sep).at(-1);
+            const content = templateHtml.replace(`<!-- {{InsertScript}} -->`, `<script type="module" src="./${scriptStr}"></script>`);
+            const htmlName = fileDIr.split(path.sep).at(-1);
+            const htmlPath = path.join(fileDIr, htmlName + ".html");
+            writeFileSync(htmlPath, content);
+            input[htmlName] = htmlPath;
+        }
+        else {
+            fileHtml;
+            const key = path.basename(fileHtml, ".html");
+            input[key] = path.resolve(base, fileHtml);
+        }
+    }
+    // for (const file of readdirSync(base)) {
+    //   if (!file.endsWith(".html")) continue;
+    //   const key = path.basename(file, ".html");
+    //   input[key] = path.resolve(base, file);
+    // }
+    return input;
+}
+export function outDir() {
+    // // 为了保持代码 能见性 输出地址应该为 runPath/app/public/dist
+    // 放在框架路径比较保险
+    return path.join(frameNodePath, "./app/public/dist");
+}
+export const watchFiles = async (callback) => {
+    const chokidar = await import("chokidar");
+    // 在实际使用时  只有使用方的文件会变化
+    const watcher = chokidar.watch(runFEPath, {
+        ignored: /(^|[\/\\])\../,
+        persistent: true,
+        ignoreInitial: true,
+    });
+    let building = false;
+    watcher.on("change", async (filePath) => {
+        if (building)
+            return;
+        building = true;
+        console.log(`changed: ${filePath}`);
+        await callback?.();
+        console.log("rebuild done");
+        building = false;
+    });
+    console.log(`watching ${runFEPath}/...`);
+};
+/**
+ *
+ * 1. 在 build 结束后
+ * 2. 获取输出目录下的html文件
+ * 3. 移动内部的html 至 输出目录的根节点
+ */
+function flattenHtmlPlugin(suffix = ".html") {
+    return {
+        name: "flatten-html",
+        apply: "build",
+        closeBundle() {
+            const feDir = outDir();
+            if (!existsSync(feDir))
+                return;
+            // 移动文件
+            const htmlFiles = glob.sync("**/*.html", { cwd: feDir });
+            for (const file of htmlFiles) {
+                const src = path.join(feDir, file);
+                let fileOName = path.basename(file, ".html");
+                // 如果文件名没有 entry 补上后缀
+                const entrySuffix = ".entry";
+                if (fileOName.indexOf(entrySuffix) === -1) {
+                    fileOName = fileOName + entrySuffix;
+                }
+                const fileName = fileOName + suffix;
+                const dest = path.join(feDir, fileName);
+                if (src !== dest) {
+                    copyFileSync(src, dest);
+                    unlinkSync(src);
+                }
+            }
+            const parents = [...new Set(htmlFiles.map((f) => path.dirname(f)))]
+                .sort()
+                .reverse();
+            /**
+             *
+             * 删除空的目录
+             */
+            const delEmptyDir = (pathStr) => {
+                const currentDir = existsSync(pathStr) ? readdirSync(pathStr) : [1];
+                if (!currentDir.length) {
+                    rmdirSync(pathStr);
+                    const pa = pathStr.split(path.sep).slice(0, -1);
+                    pa.length && delEmptyDir(pa.join(path.sep));
+                }
+            };
+            for (const dir of parents) {
+                if (dir && dir !== ".") {
+                    const fullPath = path.join(feDir, dir);
+                    delEmptyDir(fullPath);
+                }
+            }
+        },
+    };
+}
+export const VBuildFE = async (input) => {
+    // 根据入口构建
+    await build({
+        configFile: false,
+        plugins: [
+            (await import("@vitejs/plugin-react")).default(),
+            flattenHtmlPlugin(".tpl"),
+        ],
+        build: {
+            outDir: outDir(),
+            emptyOutDir: true,
+            rollupOptions: {
+                input,
+            },
+        },
+        resolve: {
+            alias: {
+                // 需要配置打包后的文件地址
+                "@tc/ui-react": path.resolve(__dirname, "../../fe/packages/ui/react/"),
+            },
+        },
+    });
+};

package/esm/index.js

@@ -0,0 +1,13 @@
+import { start } from "./packages/core/index.js";
+import "./app/typings";
+import { resolve } from "./packages/utils/index.js";
+import baseControllerFn from "./app/controller/base";
+import baseServiceFn from "./app/service/bese";
+export const serverStart = (options) => {
+    return start({ ...options, frameBaseDir: resolve(__dirname, ".") });
+};
+export const baseFn = {
+    baseControllerFn,
+    baseServiceFn,
+};
+export { default as modelLoader } from "./packages/core/loader/model";

package/esm/packages/core/env.js

@@ -0,0 +1,23 @@
+export default () => {
+    return {
+        isLocal() {
+            return process.env._ENV === 'local';
+        },
+        isBate() {
+            return process.env._ENV === 'bate';
+        },
+        isProd() {
+            return process.env._ENV === 'prod';
+        },
+        get() {
+            return (process.env._ENV ?? 'local');
+        },
+        getEnvKeys() {
+            return {
+                local: 'local',
+                bate: 'bate',
+                prod: 'prod',
+            };
+        },
+    };
+};