@hlw-midway/core 1.0.0

package/dist/decorator/index.js

@@ -0,0 +1,120 @@
+"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.HlwDecorator = void 0;
+const cache_1 = require("./cache");
+const cache_manager_1 = require("@midwayjs/cache-manager");
+const core_1 = require("@midwayjs/core");
+const typeorm_1 = require("@midwayjs/typeorm");
+const comm_1 = require("../exception/comm");
+const transaction_1 = require("./transaction");
+const md5 = require("md5");
+const data_1 = require("../tag/data");
+/**
+ * 装饰器
+ */
+let HlwDecorator = class HlwDecorator {
+    async init() {
+        // 事务
+        await this.transaction();
+        // 缓存
+        await this.cache();
+        // URL标签
+        await this.hlwUrlTagData.init();
+    }
+    /**
+     * 缓存
+     */
+    async cache() {
+        this.decoratorService.registerMethodHandler(cache_1.HLW_CACHE, options => {
+            return {
+                around: async (joinPoint) => {
+                    const key = md5(joinPoint.target.constructor.name +
+                        joinPoint.methodName +
+                        JSON.stringify(joinPoint.args));
+                    // 缓存有数据就返回
+                    let data = await this.midwayCache.get(key);
+                    if (data) {
+                        return JSON.parse(data);
+                    }
+                    else {
+                        // 执行原始方法
+                        data = await joinPoint.proceed(...joinPoint.args);
+                        await this.midwayCache.set(key, JSON.stringify(data), options.metadata);
+                    }
+                    return data;
+                },
+            };
+        });
+    }
+    /**
+     * 事务
+     */
+    async transaction() {
+        this.decoratorService.registerMethodHandler(transaction_1.HLW_TRANSACTION, options => {
+            return {
+                around: async (joinPoint) => {
+                    const option = options.metadata;
+                    const dataSource = this.typeORMDataSourceManager.getDataSource((option === null || option === void 0 ? void 0 : option.connectionName) || 'default');
+                    const queryRunner = dataSource.createQueryRunner();
+                    await queryRunner.connect();
+                    if (option && option.isolation) {
+                        await queryRunner.startTransaction(option.isolation);
+                    }
+                    else {
+                        await queryRunner.startTransaction();
+                    }
+                    let data;
+                    try {
+                        joinPoint.args.push(queryRunner);
+                        data = await joinPoint.proceed(...joinPoint.args);
+                        await queryRunner.commitTransaction();
+                    }
+                    catch (error) {
+                        await queryRunner.rollbackTransaction();
+                        throw new comm_1.HlwCommException(error.message);
+                    }
+                    finally {
+                        await queryRunner.release();
+                    }
+                    return data;
+                },
+            };
+        });
+    }
+};
+exports.HlwDecorator = HlwDecorator;
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", typeorm_1.TypeORMDataSourceManager)
+], HlwDecorator.prototype, "typeORMDataSourceManager", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", core_1.MidwayDecoratorService)
+], HlwDecorator.prototype, "decoratorService", void 0);
+__decorate([
+    (0, core_1.InjectClient)(cache_manager_1.CachingFactory, 'default'),
+    __metadata("design:type", Object)
+], HlwDecorator.prototype, "midwayCache", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", data_1.HlwUrlTagData)
+], HlwDecorator.prototype, "hlwUrlTagData", void 0);
+__decorate([
+    (0, core_1.Init)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], HlwDecorator.prototype, "init", null);
+exports.HlwDecorator = HlwDecorator = __decorate([
+    (0, core_1.Provide)(),
+    (0, core_1.Scope)(core_1.ScopeEnum.Singleton)
+], HlwDecorator);

package/dist/decorator/tag.d.ts

@@ -0,0 +1,22 @@
+export declare const HLW_URL_TAG_KEY = "decorator:hlw:url:tag";
+export declare const HLW_METHOD_TAG_KEY = "decorator:hlw:method:tag";
+export declare enum TagTypes {
+    IGNORE_TOKEN = "ignoreToken",
+    IGNORE_SIGN = "ignoreSign"
+}
+export interface HlwUrlTagConfig {
+    key: TagTypes | string;
+    value?: string[];
+}
+/**
+ * 打标记
+ * @param data
+ * @returns
+ */
+export declare function HlwUrlTag(data?: HlwUrlTagConfig): ClassDecorator;
+/**
+ * 方法打标记
+ * @param data
+ * @returns
+ */
+export declare function HlwTag(tag: TagTypes | string): MethodDecorator;

package/dist/decorator/tag.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TagTypes = exports.HLW_METHOD_TAG_KEY = exports.HLW_URL_TAG_KEY = void 0;
+exports.HlwUrlTag = HlwUrlTag;
+exports.HlwTag = HlwTag;
+const core_1 = require("@midwayjs/core");
+exports.HLW_URL_TAG_KEY = 'decorator:hlw:url:tag';
+exports.HLW_METHOD_TAG_KEY = 'decorator:hlw:method:tag';
+var TagTypes;
+(function (TagTypes) {
+    TagTypes["IGNORE_TOKEN"] = "ignoreToken";
+    TagTypes["IGNORE_SIGN"] = "ignoreSign";
+})(TagTypes || (exports.TagTypes = TagTypes = {}));
+/**
+ * 打标记
+ * @param data
+ * @returns
+ */
+function HlwUrlTag(data) {
+    return (target) => {
+        // 将装饰的类，绑定到该装饰器，用于后续能获取到 class
+        (0, core_1.saveModule)(exports.HLW_URL_TAG_KEY, target);
+        // 保存一些元数据信息，任意你希望存的东西
+        (0, core_1.saveClassMetadata)(exports.HLW_URL_TAG_KEY, data, target);
+    };
+}
+/**
+ * 方法打标记
+ * @param data
+ * @returns
+ */
+function HlwTag(tag) {
+    return (target, key, descriptor) => {
+        (0, core_1.savePropertyDataToClass)(exports.HLW_METHOD_TAG_KEY, {
+            key,
+            tag,
+        }, target, key);
+        return descriptor;
+    };
+}

package/dist/decorator/transaction.d.ts

@@ -0,0 +1,8 @@
+type IsolationLevel = 'READ UNCOMMITTED' | 'READ COMMITTED' | 'REPEATABLE READ' | 'SERIALIZABLE';
+export interface TransactionOptions {
+    connectionName?: string;
+    isolation?: IsolationLevel;
+}
+export declare const HLW_TRANSACTION = "decorator:hlw_transaction";
+export declare function HlwTransaction(option?: TransactionOptions): MethodDecorator;
+export {};

package/dist/decorator/transaction.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HLW_TRANSACTION = void 0;
+exports.HlwTransaction = HlwTransaction;
+const core_1 = require("@midwayjs/core");
+// 装饰器内部的唯一 id
+exports.HLW_TRANSACTION = 'decorator:hlw_transaction';
+function HlwTransaction(option) {
+    return (0, core_1.createCustomMethodDecorator)(exports.HLW_TRANSACTION, option);
+}

package/dist/entity/base.d.ts

@@ -0,0 +1,10 @@
+import { HlwBaseEntity } from './typeorm';
+/**
+ * 模型基类
+ */
+export declare abstract class BaseEntity extends HlwBaseEntity {
+    id: number;
+    createdAt: Date;
+    updatedAt: Date;
+    tenantId: number;
+}

package/dist/entity/base.js

@@ -0,0 +1,41 @@
+"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.BaseEntity = void 0;
+const typeorm_1 = require("typeorm");
+const typeorm_2 = require("./typeorm");
+/**
+ * 模型基类
+ */
+class BaseEntity extends typeorm_2.HlwBaseEntity {
+}
+exports.BaseEntity = BaseEntity;
+__decorate([
+    (0, typeorm_1.PrimaryGeneratedColumn)('increment', {
+        comment: 'ID',
+    }),
+    __metadata("design:type", Number)
+], BaseEntity.prototype, "id", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.CreateDateColumn)({ comment: '创建时间' }),
+    __metadata("design:type", Date)
+], BaseEntity.prototype, "createdAt", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.UpdateDateColumn)({ comment: '更新时间' }),
+    __metadata("design:type", Date)
+], BaseEntity.prototype, "updatedAt", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.Column)({ comment: '租户ID', nullable: true }),
+    __metadata("design:type", Number)
+], BaseEntity.prototype, "tenantId", void 0);

package/dist/entity/mongo.d.ts

@@ -0,0 +1,10 @@
+import { ObjectID } from 'typeorm';
+import { HlwBaseEntity } from './typeorm';
+/**
+ * 模型基类
+ */
+export declare abstract class BaseMongoEntity extends HlwBaseEntity {
+    id: ObjectID;
+    createdAt: Date;
+    updatedAt: Date;
+}

package/dist/entity/mongo.js

@@ -0,0 +1,35 @@
+"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);
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseMongoEntity = void 0;
+const typeorm_1 = require("typeorm");
+const typeorm_2 = require("./typeorm");
+/**
+ * 模型基类
+ */
+class BaseMongoEntity extends typeorm_2.HlwBaseEntity {
+}
+exports.BaseMongoEntity = BaseMongoEntity;
+__decorate([
+    (0, typeorm_1.ObjectIdColumn)({ comment: 'id' }),
+    __metadata("design:type", typeof (_a = typeof typeorm_1.ObjectID !== "undefined" && typeorm_1.ObjectID) === "function" ? _a : Object)
+], BaseMongoEntity.prototype, "id", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.CreateDateColumn)({ comment: '创建时间' }),
+    __metadata("design:type", Date)
+], BaseMongoEntity.prototype, "createdAt", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.UpdateDateColumn)({ comment: '更新时间' }),
+    __metadata("design:type", Date)
+], BaseMongoEntity.prototype, "updatedAt", void 0);

package/dist/entity/typeorm.d.ts

@@ -0,0 +1,3 @@
+import { BaseEntity } from 'typeorm';
+export declare abstract class HlwBaseEntity extends BaseEntity {
+}

package/dist/entity/typeorm.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HlwBaseEntity = void 0;
+const typeorm_1 = require("typeorm");
+class HlwBaseEntity extends typeorm_1.BaseEntity {
+}
+exports.HlwBaseEntity = HlwBaseEntity;

package/dist/event/index.d.ts

@@ -0,0 +1,53 @@
+import * as Events from 'events';
+import { IMidwayApplication } from '@midwayjs/core';
+export declare const HLW_EVENT_MESSAGE = "hlw:event:message";
+/**
+ * 事件
+ */
+export declare class HlwEventManager extends Events {
+    app: IMidwayApplication;
+    keys: string;
+    eventData: {
+        [key: string]: {
+            module: any;
+            method: string;
+        }[];
+    };
+    /**
+     * 初始化
+     */
+    init(): Promise<void>;
+    /**
+     * 发送事件
+     * @param event
+     * @param args
+     * @returns
+     */
+    emit(event: string | symbol, ...args: any[]): boolean;
+    /**
+     * 发送全局事件
+     * @param event 事件
+     * @param random 是否随机一个
+     * @param args 参数
+     * @returns
+     */
+    globalEmit(event: string, random?: boolean, ...args: any[]): Promise<void>;
+    /**
+     * 处理事件
+     * @param module
+     */
+    handlerEvent(module: any): Promise<void>;
+    /**
+     * 全局事件
+     */
+    globalEvent(): Promise<void>;
+    /**
+     * 普通事件
+     */
+    commEvent(): Promise<void>;
+    /**
+     * 执行事件
+     * @param message
+     */
+    doAction(message: any): Promise<void>;
+}

package/dist/event/index.js

@@ -0,0 +1,188 @@
+"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.HlwEventManager = exports.HLW_EVENT_MESSAGE = void 0;
+const core_1 = require("@midwayjs/core");
+const Events = require("events");
+const core_2 = require("@midwayjs/core");
+const event_1 = require("../decorator/event");
+const pm2 = require("pm2");
+const _ = require("lodash");
+exports.HLW_EVENT_MESSAGE = 'hlw:event:message';
+/**
+ * 事件
+ */
+let HlwEventManager = class HlwEventManager extends Events {
+    constructor() {
+        super(...arguments);
+        // 事件数据 某个事件对应的模块对应的方法
+        this.eventData = {};
+    }
+    /**
+     * 初始化
+     */
+    async init() {
+        const eventModules = (0, core_1.listModule)(event_1.HLW_CLS_EVENT_KEY);
+        for (const module of eventModules) {
+            await this.handlerEvent(module);
+        }
+        await this.commEvent();
+        await this.globalEvent();
+    }
+    /**
+     * 发送事件
+     * @param event
+     * @param args
+     * @returns
+     */
+    emit(event, ...args) {
+        return super.emit(exports.HLW_EVENT_MESSAGE, {
+            type: exports.HLW_EVENT_MESSAGE,
+            data: {
+                event,
+                args,
+            },
+        });
+    }
+    /**
+     * 发送全局事件
+     * @param event 事件
+     * @param random 是否随机一个
+     * @param args 参数
+     * @returns
+     */
+    async globalEmit(event, random = false, ...args) {
+        // 如果是本地运行还是转普通模式
+        if (this.app.getEnv() === 'local') {
+            this.emit(event, ...args);
+            return;
+        }
+        pm2.connect(() => {
+            pm2.list((err, list) => {
+                const ps = list.map(e => {
+                    return {
+                        id: e.pm_id,
+                        name: e.name,
+                    };
+                });
+                // random 为 true 时随机发给同名称的一个进程
+                if (random) {
+                    // 按名称分组
+                    const group = _.groupBy(ps, 'name');
+                    const names = Object.keys(group);
+                    // 遍历名称
+                    names.forEach(name => {
+                        const pss = group[name];
+                        // 随机一个
+                        const index = _.random(0, pss.length - 1);
+                        const ps = pss[index];
+                        // 发给这个进程
+                        // @ts-ignore
+                        pm2.sendDataToProcessId({
+                            type: 'process:msg',
+                            data: {
+                                type: `${exports.HLW_EVENT_MESSAGE}@${this.keys}`,
+                                event,
+                                args,
+                            },
+                            id: ps.id,
+                            topic: 'hlw:event:topic',
+                        }, (err, res) => { });
+                    });
+                }
+                else {
+                    // 发给所有进程
+                    ps.forEach(e => {
+                        // @ts-ignore
+                        pm2.sendDataToProcessId({
+                            type: 'process:msg',
+                            data: {
+                                type: `${exports.HLW_EVENT_MESSAGE}@${this.keys}`,
+                                event,
+                                args,
+                            },
+                            id: e.id,
+                            topic: 'hlw:event:topic',
+                        }, (err, res) => { });
+                    });
+                }
+            });
+        });
+    }
+    /**
+     * 处理事件
+     * @param module
+     */
+    async handlerEvent(module) {
+        const events = (0, core_1.getClassMetadata)(event_1.HLW_EVENT_KEY, module);
+        for (const event of events) {
+            const listen = event.eventName ? event.eventName : event.propertyKey;
+            if (!this.eventData[listen]) {
+                this.eventData[listen] = [];
+            }
+            this.eventData[listen].push({
+                module,
+                method: event.propertyKey,
+            });
+        }
+    }
+    /**
+     * 全局事件
+     */
+    async globalEvent() {
+        process.on('message', async (message) => {
+            const data = message === null || message === void 0 ? void 0 : message.data;
+            if (!data)
+                return;
+            if (data.type != `${exports.HLW_EVENT_MESSAGE}@${this.keys}`)
+                return;
+            await this.doAction(message);
+        });
+    }
+    /**
+     * 普通事件
+     */
+    async commEvent() {
+        this.on(exports.HLW_EVENT_MESSAGE, async (message) => {
+            await this.doAction(message);
+        });
+    }
+    /**
+     * 执行事件
+     * @param message
+     */
+    async doAction(message) {
+        const data = message.data;
+        const method = data.event;
+        const args = data.args;
+        if (this.eventData[method]) {
+            for (const event of this.eventData[method]) {
+                const moduleInstance = await this.app
+                    .getApplicationContext()
+                    .getAsync(event.module);
+                moduleInstance[event.method](...args);
+            }
+        }
+    }
+};
+exports.HlwEventManager = HlwEventManager;
+__decorate([
+    (0, core_1.App)(),
+    __metadata("design:type", Object)
+], HlwEventManager.prototype, "app", void 0);
+__decorate([
+    (0, core_2.Config)('keys'),
+    __metadata("design:type", String)
+], HlwEventManager.prototype, "keys", void 0);
+exports.HlwEventManager = HlwEventManager = __decorate([
+    (0, core_1.Provide)(),
+    (0, core_2.Scope)(core_2.ScopeEnum.Singleton)
+], HlwEventManager);

package/dist/exception/base.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 异常基类
+ */
+export declare class BaseException extends Error {
+    status: number;
+    statusCode: number;
+    constructor(name: string, code: number, message: string, statusCode?: number);
+}

package/dist/exception/base.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseException = void 0;
+/**
+ * 异常基类
+ */
+class BaseException extends Error {
+    constructor(name, code, message, statusCode) {
+        super(message);
+        this.name = name;
+        this.status = code;
+        this.statusCode = statusCode;
+    }
+}
+exports.BaseException = BaseException;

package/dist/exception/comm.d.ts

@@ -0,0 +1,7 @@
+import { BaseException } from './base';
+/**
+ * 通用异常
+ */
+export declare class HlwCommException extends BaseException {
+    constructor(message: string, statusCode?: number);
+}

package/dist/exception/comm.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HlwCommException = void 0;
+const global_1 = require("../constant/global");
+const base_1 = require("./base");
+/**
+ * 通用异常
+ */
+class HlwCommException extends base_1.BaseException {
+    constructor(message, statusCode) {
+        const { RESCODE, RESMESSAGE } = global_1.GlobalConfig.getInstance();
+        super('HlwCommException', RESCODE.COMMFAIL, message ? message : RESMESSAGE.COMMFAIL, statusCode);
+    }
+}
+exports.HlwCommException = HlwCommException;

package/dist/exception/core.d.ts

@@ -0,0 +1,7 @@
+import { BaseException } from './base';
+/**
+ * 核心异常
+ */
+export declare class HlwCoreException extends BaseException {
+    constructor(message: string, statusCode?: number);
+}

package/dist/exception/core.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HlwCoreException = void 0;
+const global_1 = require("../constant/global");
+const base_1 = require("./base");
+/**
+ * 核心异常
+ */
+class HlwCoreException extends base_1.BaseException {
+    constructor(message, statusCode) {
+        const { RESCODE, RESMESSAGE } = global_1.GlobalConfig.getInstance();
+        super('HlwCoreException', RESCODE.COREFAIL, message ? message : RESMESSAGE.COREFAIL, statusCode);
+    }
+}
+exports.HlwCoreException = HlwCoreException;

package/dist/exception/filter.d.ts

@@ -0,0 +1,11 @@
+import { ILogger } from '@midwayjs/core';
+/**
+ * 全局异常处理
+ */
+export declare class HlwExceptionFilter {
+    coreLogger: ILogger;
+    catch(err: any): Promise<{
+        code: any;
+        message: any;
+    }>;
+}