@hlw-midway/core 1.0.0

package/README.md

@@ -0,0 +1,4 @@
+# HLW Admin Node
+
+hlw-admin 后台权限管理系统，开源免费，模块化、插件化、极速开发CRUD，方便快速构建迭代后台管理系统，支持serverless、docker、普通服务器等多种方式部署
+

package/dist/bin/check.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 检查配置文件
+ */
+export declare function check(): Promise<void>;

package/dist/bin/check.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.check = check;
+const fs_1 = require("fs");
+const uuid_1 = require("uuid");
+const path_1 = require("path");
+/**
+ * 检查并替换单个配置文件
+ */
+async function checkAndReplaceFile(config) {
+    const filePath = (0, path_1.join)(process.cwd(), config.path);
+    if (!(0, fs_1.existsSync)(filePath)) {
+        return;
+    }
+    let content = (0, fs_1.readFileSync)(filePath, 'utf-8');
+    if (content.includes(config.pattern)) {
+        console.log(`${config.path}，key is default, auto replace it`);
+        content = content.replace(config.pattern, (0, uuid_1.v4)());
+        (0, fs_1.writeFileSync)(filePath, content, 'utf-8');
+    }
+}
+/**
+ * 检查配置文件
+ */
+async function check() {
+    const configs = [
+        {
+            path: 'src/config/config.default.ts',
+            pattern: 'hlw-admin-keys-xxxxxx',
+        },
+        {
+            path: 'src/modules/system/config.ts',
+            pattern: 'hlw-admin-xxxxxx',
+        },
+        {
+            path: 'src/modules/user/config.ts',
+            pattern: 'hlw-app-xxxxx',
+        },
+    ];
+    await Promise.all(configs.map(config => checkAndReplaceFile(config)));
+}

package/dist/bin/entity.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 生成 entities.ts 文件
+ */
+export declare function generateEntitiesFile(): void;
+/**
+ * 清空 entities.ts 文件
+ */
+export declare function clearEntitiesFile(): void;

package/dist/bin/entity.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateEntitiesFile = generateEntitiesFile;
+exports.clearEntitiesFile = clearEntitiesFile;
+const fs = require("fs");
+const path = require("path");
+const glob = require("glob");
+const MODULES_PATH = 'src/modules';
+const OUTPUT_FILE = 'src/entities.ts';
+/**
+ * 生成 entities.ts 文件
+ */
+function generateEntitiesFile() {
+    // 扫描所有的 ts 文件
+    const entityFiles = glob.sync('*/entity/**/*.ts', {
+        cwd: MODULES_PATH,
+        absolute: true,
+    });
+    // 生成导入语句和导出数组
+    const imports = entityFiles.map((file, index) => {
+        const relativePath = path
+            .relative(path.dirname(OUTPUT_FILE), file)
+            .split(path.sep)
+            .join('/');
+        return `import * as entity${index} from './${relativePath.replace(/\.ts$/, '')}';`;
+    });
+    const exportEntities = `export const entities = [
+  ${entityFiles
+        .map((_, index) => `...Object.values(entity${index})`)
+        .join(',\n  ')},
+];`;
+    // 生成最终的文件内容
+    const fileContent = `// 自动生成的文件，请勿手动修改
+${imports.join('\n')}
+${exportEntities}
+`;
+    // 写入文件
+    fs.writeFileSync(OUTPUT_FILE, fileContent);
+    console.log('Entities file generated successfully!');
+}
+/**
+ * 清空 entities.ts 文件
+ */
+function clearEntitiesFile() {
+    const emptyContent = `// 自动生成的文件，请勿手动修改
+export const entities = [];
+`;
+    fs.writeFileSync(OUTPUT_FILE, emptyContent);
+    console.log('Entities file cleared successfully!');
+}

package/dist/bin/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin/index.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const check_1 = require("./check");
+const entity_1 = require("./entity");
+const obfuscate_1 = require("./obfuscate");
+const program = new commander_1.Command();
+// 设置版本号（从 package.json 中获取）
+program.version(require('../../package.json').version);
+// 修改命令定义部分
+const commands = {
+    check: async () => await (0, check_1.check)(),
+    entity: async (options = {}) => {
+        if (options.clear) {
+            await (0, entity_1.clearEntitiesFile)();
+        }
+        else {
+            await (0, entity_1.generateEntitiesFile)();
+        }
+    },
+    obfuscate: async () => await (0, obfuscate_1.obfuscate)(),
+};
+// 移除原有的单独命令定义
+program
+    .arguments('[cmds...]')
+    .option('--clear', 'Clear entities file when using entity command')
+    .description('Run one or multiple commands: check, entity, obfuscate')
+    .action(async (cmds, options) => {
+    if (!cmds.length) {
+        program.outputHelp();
+        return;
+    }
+    for (const cmd of cmds) {
+        if (cmd in commands) {
+            console.log(`Executing ${cmd}...`);
+            await commands[cmd](options);
+        }
+        else {
+            console.error(`Unknown command: ${cmd}`);
+        }
+    }
+});
+// 解析命令行参数
+program.parse(process.argv);
+// 如果没有任何命令，显示帮助信息
+if (!process.argv.slice(2).length) {
+    program.outputHelp();
+}

package/dist/bin/obfuscate.d.ts

@@ -0,0 +1 @@
+export declare function obfuscate(): Promise<void>;

package/dist/bin/obfuscate.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.obfuscate = obfuscate;
+const fs = require("fs");
+const path = require("path");
+const JavaScriptObfuscator = require("javascript-obfuscator");
+// 混淆配置
+const obfuscatorOptions = {
+    compact: true,
+    controlFlowFlattening: true,
+    controlFlowFlatteningThreshold: 0.7,
+    deadCodeInjection: true,
+    deadCodeInjectionThreshold: 0.4,
+    debugProtection: false,
+    debugProtectionInterval: 0,
+    disableConsoleOutput: true,
+    identifierNamesGenerator: 'hexadecimal',
+    log: false,
+    numbersToExpressions: true,
+    renameGlobals: false,
+    rotateStringArray: true,
+    selfDefending: true,
+    shuffleStringArray: true,
+    splitStrings: true,
+    splitStringsChunkLength: 10,
+    stringArray: true,
+    stringArrayEncoding: ['base64'],
+    stringArrayThreshold: 0.75,
+    transformObjectKeys: true,
+    unicodeEscapeSequence: false,
+};
+// 处理单个文件的函数
+function obfuscateFile(filePath) {
+    try {
+        const code = fs.readFileSync(filePath, 'utf8');
+        const obfuscationResult = JavaScriptObfuscator.obfuscate(code, obfuscatorOptions);
+        fs.writeFileSync(filePath, obfuscationResult.getObfuscatedCode());
+        // console.log(`成功混淆文件: ${filePath}`);
+    }
+    catch (error) {
+        console.error(`处理文件 ${filePath} 时出错:`, error);
+    }
+}
+// 递归处理目录的函数
+function processDirectory(directory) {
+    const files = fs.readdirSync(directory);
+    files.forEach(file => {
+        const fullPath = path.join(directory, file);
+        const stat = fs.statSync(fullPath);
+        if (stat.isDirectory()) {
+            processDirectory(fullPath);
+        }
+        else if (path.extname(file) === '.js') {
+            obfuscateFile(fullPath);
+        }
+    });
+}
+// 导出主函数
+async function obfuscate() {
+    const distPath = path.join(process.cwd(), 'dist');
+    if (fs.existsSync(distPath)) {
+        console.log('开始混淆 dist 目录下的 JS 文件...');
+        processDirectory(distPath);
+        console.log('混淆完成！打包成功！');
+    }
+    else {
+        console.error('错误: dist 目录不存在！');
+    }
+}

package/dist/cache/store.d.ts

@@ -0,0 +1,18 @@
+interface FsCacheStoreOptions {
+    path?: string;
+    ttl?: number;
+}
+/**
+ * hlw 基于磁盘的缓存
+ */
+declare class FsCacheStore {
+    options: FsCacheStoreOptions;
+    store: any;
+    constructor(options?: FsCacheStoreOptions);
+    get(key: string): Promise<any>;
+    set(key: string, value: any, ttl?: number): Promise<void>;
+    del(key: string): Promise<void>;
+    reset(): Promise<void>;
+}
+export declare const HlwCacheStore: (options?: FsCacheStoreOptions) => FsCacheStore;
+export {};

package/dist/cache/store.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HlwCacheStore = void 0;
+const FsStore = require("@hlw-midway/cache-manager-fs-hash");
+/**
+ * hlw 基于磁盘的缓存
+ */
+class FsCacheStore {
+    constructor(options = {}) {
+        options = {
+            path: 'cache',
+            ttl: -1,
+            ...options,
+        };
+        this.options = options;
+        this.store = FsStore.create(options);
+    }
+    async get(key) {
+        return await this.store.get(key);
+    }
+    async set(key, value, ttl) {
+        let t = ttl ? ttl : this.options.ttl;
+        if (t > 0) {
+            t = t / 1000;
+        }
+        await this.store.set(key, value, { ttl: t });
+    }
+    async del(key) {
+        await this.store.del(key);
+    }
+    async reset() {
+        await this.store.reset();
+    }
+}
+const HlwCacheStore = function (options = {}) {
+    return new FsCacheStore(options);
+};
+exports.HlwCacheStore = HlwCacheStore;

package/dist/config/config.default.d.ts

@@ -0,0 +1,8 @@
+import { HlwConfig } from '../interface';
+/**
+ * hlw的配置
+ */
+declare const _default: {
+    hlw: HlwConfig;
+};
+export default _default;

package/dist/config/config.default.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * hlw的配置
+ */
+exports.default = {
+    hlw: {
+        // 是否自动导入数据库
+        initDB: false,
+        // 是否自动导入模块菜单
+        initMenu: true,
+        // 判断是否初始化的方式
+        initJudge: 'db',
+        // crud配置
+        crud: {
+            // 软删除
+            softDelete: true,
+            // 分页查询每页条数
+            pageSize: 15,
+        },
+    },
+};

package/dist/configuration.d.ts

@@ -0,0 +1,17 @@
+import { ILifeCycle, ILogger, IMidwayApplication, IMidwayContainer, MidwayWebRouterService } from '@midwayjs/core';
+import * as koa from '@midwayjs/koa';
+import { HlwEventManager } from './event';
+export declare class HlwConfiguration implements ILifeCycle {
+    coreLogger: ILogger;
+    app: koa.Application;
+    hlwEventManager: HlwEventManager;
+    allConfig: any;
+    webRouterService: MidwayWebRouterService;
+    onReady(container: IMidwayContainer): Promise<void>;
+    onConfigLoad(container: IMidwayContainer, app: IMidwayApplication): Promise<void>;
+    onServerReady(container: IMidwayContainer): Promise<void>;
+    /**
+     * 事件初始化
+     */
+    eventInit(): Promise<void>;
+}

package/dist/configuration.js

@@ -0,0 +1,106 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HlwConfiguration = void 0;
+const core_1 = require("@midwayjs/core");
+const core_2 = require("@midwayjs/core");
+const DefaultConfig = require("./config/config.default");
+const filter_1 = require("./exception/filter");
+const func_1 = require("./util/func");
+const koa = require("@midwayjs/koa");
+const config_1 = require("./module/config");
+const import_1 = require("./module/import");
+const event_1 = require("./event");
+const eps_1 = require("./rest/eps");
+const decorator_1 = require("./decorator");
+const cache = require("@midwayjs/cache-manager");
+const location_1 = require("./util/location");
+let HlwConfiguration = class HlwConfiguration {
+    async onReady(container) {
+        this.hlwEventManager.emit('onReady');
+        this.hlwEventManager.globalEmit('onReadyOnce', true);
+        // 处理模块配置
+        await container.getAsync(config_1.HlwModuleConfig);
+        // 常用函数处理
+        await container.getAsync(func_1.FuncUtil);
+        // 异常处理
+        this.app.useFilter([filter_1.HlwExceptionFilter]);
+        // 装饰器
+        await container.getAsync(decorator_1.HlwDecorator);
+        // 注册一个路由，用于处理静态资源
+        this.webRouterService.addRouter(async (ctx) => {
+            ctx.redirect('/index.html');
+        }, {
+            url: '/',
+            requestMethod: 'GET',
+        });
+    }
+    async onConfigLoad(container, app) {
+        await container.getAsync(location_1.LocationUtil);
+        // 替换app的getBaseDir
+        app.getBaseDir = () => {
+            return container.get(location_1.LocationUtil).getDistPath();
+        };
+    }
+    async onServerReady(container) {
+        // 事件
+        await (await container.getAsync(event_1.HlwEventManager)).init();
+        // 导入模块数据
+        (await container.getAsync(import_1.HlwModuleImport)).init();
+        // 实体与路径
+        const eps = await container.getAsync(eps_1.HlwEps);
+        eps.init();
+        await this.eventInit();
+    }
+    /**
+     * 事件初始化
+     */
+    async eventInit() {
+        this.hlwEventManager.emit('onServerReady');
+        const env = this.app.getEnv();
+        const isMainProcess = process.env.NODE_APP_INSTANCE == '0';
+        if (env == 'local' || isMainProcess) {
+            this.hlwEventManager.globalEmit('onServerReadyOnce', true);
+        }
+    }
+};
+exports.HlwConfiguration = HlwConfiguration;
+__decorate([
+    (0, core_1.Logger)(),
+    __metadata("design:type", Object)
+], HlwConfiguration.prototype, "coreLogger", void 0);
+__decorate([
+    (0, core_1.App)(),
+    __metadata("design:type", Object)
+], HlwConfiguration.prototype, "app", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", event_1.HlwEventManager)
+], HlwConfiguration.prototype, "hlwEventManager", void 0);
+__decorate([
+    (0, core_1.Config)(core_1.ALL),
+    __metadata("design:type", Object)
+], HlwConfiguration.prototype, "allConfig", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", core_1.MidwayWebRouterService)
+], HlwConfiguration.prototype, "webRouterService", void 0);
+exports.HlwConfiguration = HlwConfiguration = __decorate([
+    (0, core_2.Configuration)({
+        namespace: 'hlw',
+        imports: [cache],
+        importConfigs: [
+            {
+                default: DefaultConfig,
+            },
+        ],
+    })
+], HlwConfiguration);

package/dist/constant/global.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 返回码
+ */
+export declare enum RESCODE {
+    SUCCESS = 1000,
+    COMMFAIL = 1001,
+    VALIDATEFAIL = 1002,
+    COREFAIL = 1003
+}
+/**
+ * 返回信息
+ */
+export declare enum RESMESSAGE {
+    SUCCESS = "success",
+    COMMFAIL = "comm fail",
+    VALIDATEFAIL = "validate fail",
+    COREFAIL = "core fail"
+}
+/**
+ * 错误提示
+ */
+export declare enum ERRINFO {
+    NOENTITY = "\u672A\u8BBE\u7F6E\u64CD\u4F5C\u5B9E\u4F53",
+    NOID = "\u67E5\u8BE2\u53C2\u6570[id]\u4E0D\u5B58\u5728",
+    SORTFIELD = "\u6392\u5E8F\u53C2\u6570\u4E0D\u6B63\u786E",
+    NOTFOUND = "\u6570\u636E\u4E0D\u5B58\u5728~"
+}
+/**
+ * 国际化服务
+ */
+export declare const I18N: {
+    DEFAULT_SERVICE_URL: string;
+};
+/**
+ * 事件
+ */
+export declare enum EVENT {
+    SOFT_DELETE = "onSoftDelete",
+    SERVER_READY = "onServerReady",
+    READY = "onReady",
+    ES_DATA_CHANGE = "esDataChange"
+}
+export declare class GlobalConfig {
+    private static instance;
+    RESCODE: {
+        SUCCESS: number;
+        COMMFAIL: number;
+        VALIDATEFAIL: number;
+        COREFAIL: number;
+    };
+    RESMESSAGE: {
+        SUCCESS: string;
+        COMMFAIL: string;
+        VALIDATEFAIL: string;
+        COREFAIL: string;
+    };
+    private constructor();
+    static getInstance(): GlobalConfig;
+}

package/dist/constant/global.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GlobalConfig = exports.EVENT = exports.I18N = exports.ERRINFO = exports.RESMESSAGE = exports.RESCODE = void 0;
+/**
+ * 返回码
+ */
+var RESCODE;
+(function (RESCODE) {
+    // 成功
+    RESCODE[RESCODE["SUCCESS"] = 1000] = "SUCCESS";
+    // 失败
+    RESCODE[RESCODE["COMMFAIL"] = 1001] = "COMMFAIL";
+    // 参数验证失败
+    RESCODE[RESCODE["VALIDATEFAIL"] = 1002] = "VALIDATEFAIL";
+    // 参数验证失败
+    RESCODE[RESCODE["COREFAIL"] = 1003] = "COREFAIL";
+})(RESCODE || (exports.RESCODE = RESCODE = {}));
+/**
+ * 返回信息
+ */
+var RESMESSAGE;
+(function (RESMESSAGE) {
+    // 成功
+    RESMESSAGE["SUCCESS"] = "success";
+    // 失败
+    RESMESSAGE["COMMFAIL"] = "comm fail";
+    // 参数验证失败
+    RESMESSAGE["VALIDATEFAIL"] = "validate fail";
+    // 核心异常
+    RESMESSAGE["COREFAIL"] = "core fail";
+})(RESMESSAGE || (exports.RESMESSAGE = RESMESSAGE = {}));
+/**
+ * 错误提示
+ */
+var ERRINFO;
+(function (ERRINFO) {
+    ERRINFO["NOENTITY"] = "\u672A\u8BBE\u7F6E\u64CD\u4F5C\u5B9E\u4F53";
+    ERRINFO["NOID"] = "\u67E5\u8BE2\u53C2\u6570[id]\u4E0D\u5B58\u5728";
+    ERRINFO["SORTFIELD"] = "\u6392\u5E8F\u53C2\u6570\u4E0D\u6B63\u786E";
+    ERRINFO["NOTFOUND"] = "\u6570\u636E\u4E0D\u5B58\u5728~";
+})(ERRINFO || (exports.ERRINFO = ERRINFO = {}));
+/**
+ * 国际化服务
+ */
+exports.I18N = {
+    DEFAULT_SERVICE_URL: 'https://www.baidu.com',
+};
+/**
+ * 事件
+ */
+var EVENT;
+(function (EVENT) {
+    // 软删除
+    EVENT["SOFT_DELETE"] = "onSoftDelete";
+    // 服务成功启动
+    EVENT["SERVER_READY"] = "onServerReady";
+    // 服务就绪
+    EVENT["READY"] = "onReady";
+    // ES 数据改变
+    EVENT["ES_DATA_CHANGE"] = "esDataChange";
+})(EVENT || (exports.EVENT = EVENT = {}));
+class GlobalConfig {
+    // ... 其他的配置 ...
+    constructor() {
+        this.RESCODE = {
+            SUCCESS: 1000,
+            COMMFAIL: 1001,
+            VALIDATEFAIL: 1002,
+            COREFAIL: 1003,
+        };
+        this.RESMESSAGE = {
+            SUCCESS: 'success',
+            COMMFAIL: 'comm fail',
+            VALIDATEFAIL: 'validate fail',
+            COREFAIL: 'core fail',
+        };
+    }
+    static getInstance() {
+        if (!GlobalConfig.instance) {
+            GlobalConfig.instance = new GlobalConfig();
+        }
+        return GlobalConfig.instance;
+    }
+}
+exports.GlobalConfig = GlobalConfig;