@hlw-midway/core 1.0.0

package/dist/controller/base.d.ts

@@ -0,0 +1,107 @@
+import { CurdOption } from '../decorator/controller';
+import { IMidwayApplication } from '@midwayjs/core';
+import { Context } from '@midwayjs/koa';
+import { TypeORMDataSourceManager } from '@midwayjs/typeorm';
+/**
+ * 控制器基类
+ */
+export declare abstract class BaseController {
+    baseCtx: Context;
+    service: any;
+    baseApp: IMidwayApplication;
+    curdOption: CurdOption;
+    typeORMDataSourceManager: TypeORMDataSourceManager;
+    connectionName: any;
+    init(): Promise<void>;
+    /**
+     * 获取用户ID
+     * @param type 类型
+     * @returns
+     */
+    protected getUserId(type?: 'admin' | 'app'): any;
+    /**
+     * 创建动态方法
+     * @param curdOption 配置
+     */
+    private createDynamicMethods;
+    private before;
+    /**
+     * 插入参数值
+     * @param curdOption 配置
+     */
+    private insertParam;
+    /**
+     * 设置实体
+     * @param curdOption 配置
+     */
+    private setEntity;
+    /**
+     * 设置service
+     * @param curdOption
+     */
+    private setService;
+    /**
+     * 新增
+     * @returns
+     */
+    add(): Promise<{
+        code: number;
+        message: string;
+    }>;
+    /**
+     * 删除
+     * @returns
+     */
+    delete(): Promise<{
+        code: number;
+        message: string;
+    }>;
+    /**
+     * 更新
+     * @returns
+     */
+    update(): Promise<{
+        code: number;
+        message: string;
+    }>;
+    /**
+     * 分页查询
+     * @returns
+     */
+    page(): Promise<{
+        code: number;
+        message: string;
+    }>;
+    /**
+     * 列表查询
+     * @returns
+     */
+    list(): Promise<{
+        code: number;
+        message: string;
+    }>;
+    /**
+     * 根据ID查询信息
+     * @returns
+     */
+    info(): Promise<{
+        code: number;
+        message: string;
+    }>;
+    /**
+     * 成功返回
+     * @param data 返回数据
+     */
+    ok(data?: any): {
+        code: number;
+        message: string;
+    };
+    /**
+     * 失败返回
+     * @param message
+     */
+    fail(message?: string, code?: number): {
+        code: number;
+        message: string;
+    };
+}

package/dist/controller/base.js

@@ -0,0 +1,236 @@
+"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.BaseController = void 0;
+const core_1 = require("@midwayjs/core");
+const global_1 = require("../constant/global");
+const typeorm_1 = require("@midwayjs/typeorm");
+const validate_1 = require("../exception/validate");
+/**
+ * 控制器基类
+ */
+let BaseController = class BaseController {
+    async init() {
+        const option = (0, core_1.getClassMetadata)(core_1.CONTROLLER_KEY, this);
+        this.service = await this.baseCtx.requestContext.getAsync('baseService');
+        const curdOption = option.curdOption;
+        this.curdOption = curdOption;
+        if (!this.curdOption) {
+            return;
+        }
+        // 操作之前
+        await this.before(curdOption);
+        // 设置service
+        await this.setService(curdOption);
+        // 设置实体
+        await this.setEntity(curdOption);
+        // 创建动态方法
+        await this.createDynamicMethods(curdOption);
+    }
+    /**
+     * 获取用户ID
+     * @param type 类型
+     * @returns
+     */
+    getUserId(type = 'admin') {
+        var _a, _b;
+        return type === 'admin'
+            ? (_a = this.baseCtx.admin) === null || _a === void 0 ? void 0 : _a.userId
+            : (_b = this.baseCtx.user) === null || _b === void 0 ? void 0 : _b.id;
+    }
+    /**
+     * 创建动态方法
+     * @param curdOption 配置
+     */
+    async createDynamicMethods(curdOption) {
+        if (!curdOption.serviceApis) {
+            return;
+        }
+        // 过滤出非标准方法
+        const customMethods = curdOption.serviceApis;
+        // 为每个自定义方法创建对应的控制器方法
+        for (const api of customMethods) {
+            const methodName = typeof api === 'string' ? api : api.method;
+            if (this[methodName]) {
+                continue; // 如果方法已存在则跳过
+            }
+            this[methodName] = async function () {
+                const { body } = this.baseCtx.request;
+                const serviceMethod = this.service[methodName];
+                if (typeof serviceMethod !== 'function') {
+                    throw new validate_1.HlwValidateException(`Service method ${methodName} not found`);
+                }
+                return this.ok(await serviceMethod.call(this.service, body));
+            };
+        }
+    }
+    async before(curdOption) {
+        if (!(curdOption === null || curdOption === void 0 ? void 0 : curdOption.before)) {
+            return;
+        }
+        await curdOption.before(this.baseCtx, this.baseApp);
+    }
+    /**
+     * 插入参数值
+     * @param curdOption 配置
+     */
+    async insertParam(curdOption) {
+        if (!(curdOption === null || curdOption === void 0 ? void 0 : curdOption.insertParam)) {
+            return;
+        }
+        const body = this.baseCtx.request.body;
+        if (body) {
+            // 判断body是否是数组
+            if (Array.isArray(body)) {
+                for (let i = 0; i < body.length; i++) {
+                    body[i] = {
+                        ...body[i],
+                        ...(await curdOption.insertParam(this.baseCtx, this.baseApp)),
+                    };
+                }
+                this.baseCtx.request.body = body;
+                return;
+            }
+            this.baseCtx.request.body = {
+                // @ts-ignore
+                ...this.baseCtx.request.body,
+                ...(await curdOption.insertParam(this.baseCtx, this.baseApp)),
+            };
+        }
+    }
+    /**
+     * 设置实体
+     * @param curdOption 配置
+     */
+    async setEntity(curdOption) {
+        const entity = curdOption === null || curdOption === void 0 ? void 0 : curdOption.entity;
+        if (entity) {
+            const dataSourceName = this.typeORMDataSourceManager.getDataSourceNameByModel(entity);
+            this.connectionName = dataSourceName;
+            const entityModel = this.typeORMDataSourceManager
+                .getDataSource(dataSourceName)
+                .getRepository(entity);
+            this.service.setEntity(entityModel);
+        }
+    }
+    /**
+     * 设置service
+     * @param curdOption
+     */
+    async setService(curdOption) {
+        if (curdOption.service) {
+            this.service = await this.baseCtx.requestContext.getAsync(curdOption.service);
+        }
+    }
+    /**
+     * 新增
+     * @returns
+     */
+    async add() {
+        // 插入参数
+        await this.insertParam(this.curdOption);
+        const { body } = this.baseCtx.request;
+        return this.ok(await this.service.add(body));
+    }
+    /**
+     * 删除
+     * @returns
+     */
+    async delete() {
+        // @ts-ignore
+        const { ids } = this.baseCtx.request.body;
+        return this.ok(await this.service.delete(ids));
+    }
+    /**
+     * 更新
+     * @returns
+     */
+    async update() {
+        const { body } = this.baseCtx.request;
+        return this.ok(await this.service.update(body));
+    }
+    /**
+     * 分页查询
+     * @returns
+     */
+    async page() {
+        const { body } = this.baseCtx.request;
+        return this.ok(await this.service.page(body, this.curdOption.pageQueryOp, this.connectionName));
+    }
+    /**
+     * 列表查询
+     * @returns
+     */
+    async list() {
+        const { body } = this.baseCtx.request;
+        return this.ok(await this.service.list(body, this.curdOption.listQueryOp, this.connectionName));
+    }
+    /**
+     * 根据ID查询信息
+     * @returns
+     */
+    async info() {
+        const { id } = this.baseCtx.query;
+        return this.ok(await this.service.info(id, this.curdOption.infoIgnoreProperty));
+    }
+    /**
+     * 成功返回
+     * @param data 返回数据
+     */
+    ok(data) {
+        const { RESCODE, RESMESSAGE } = global_1.GlobalConfig.getInstance();
+        const res = {
+            code: RESCODE.SUCCESS,
+            message: RESMESSAGE.SUCCESS,
+        };
+        if (data || data == 0) {
+            res['data'] = data;
+        }
+        return res;
+    }
+    /**
+     * 失败返回
+     * @param message
+     */
+    fail(message, code) {
+        const { RESCODE, RESMESSAGE } = global_1.GlobalConfig.getInstance();
+        return {
+            code: code ? code : RESCODE.COMMFAIL,
+            message: message
+                ? message
+                : code == RESCODE.VALIDATEFAIL
+                    ? RESMESSAGE.VALIDATEFAIL
+                    : RESMESSAGE.COMMFAIL,
+        };
+    }
+};
+exports.BaseController = BaseController;
+__decorate([
+    (0, core_1.Inject)('ctx'),
+    __metadata("design:type", Object)
+], BaseController.prototype, "baseCtx", void 0);
+__decorate([
+    (0, core_1.App)(),
+    __metadata("design:type", Object)
+], BaseController.prototype, "baseApp", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", typeorm_1.TypeORMDataSourceManager)
+], BaseController.prototype, "typeORMDataSourceManager", void 0);
+__decorate([
+    (0, core_1.Init)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], BaseController.prototype, "init", null);
+exports.BaseController = BaseController = __decorate([
+    (0, core_1.Provide)()
+], BaseController);

package/dist/decorator/cache.d.ts

@@ -0,0 +1,2 @@
+export declare const HLW_CACHE = "decorator:hlw_cache";
+export declare function HlwCache(ttl?: number): MethodDecorator;

package/dist/decorator/cache.js

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

package/dist/decorator/controller.d.ts

@@ -0,0 +1,71 @@
+import { MiddlewareParamArray } from '@midwayjs/core';
+export type ApiTypes = 'add' | 'delete' | 'update' | 'page' | 'info' | 'list';
+/** 服务映射接口 */
+export type ServiceApis = {
+    /** 方法 */
+    method: string;
+    /** 描述 */
+    summary: string;
+};
+export interface CurdOption {
+    prefix?: string;
+    api?: ApiTypes[];
+    serviceApis?: (ServiceApis | string)[];
+    pageQueryOp?: QueryOp | Function;
+    listQueryOp?: QueryOp | Function;
+    insertParam?: Function;
+    before?: Function;
+    infoIgnoreProperty?: string[];
+    entity?: any;
+    service?: any;
+    urlTag?: {
+        name: 'ignoreToken' | string;
+        url: ApiTypes[];
+    };
+}
+export interface JoinOp {
+    entity: any;
+    alias: string;
+    condition: string;
+    type?: 'innerJoin' | 'leftJoin';
+}
+export interface FieldEq {
+    column: string;
+    requestParam: string;
+}
+export interface QueryOp {
+    keyWordLikeFields?: string[];
+    where?: Function | any[][];
+    select?: string[];
+    fieldLike?: string[] | FieldEq[] | (string | FieldEq)[];
+    fieldEq?: string[] | FieldEq[] | (string | FieldEq)[];
+    addOrderBy?: {};
+    join?: JoinOp[];
+    extend?: Function;
+}
+export interface ControllerOption {
+    curdOption?: CurdOption & string;
+    routerOptions?: {
+        sensitive?: boolean;
+        middleware?: MiddlewareParamArray;
+        alias?: string[];
+        description?: string;
+        tagName?: string;
+    };
+}
+export interface RouterOptions {
+    sensitive?: boolean;
+    middleware?: MiddlewareParamArray;
+    description?: string;
+    tagName?: string;
+    ignoreGlobalPrefix?: boolean;
+}
+export declare function HlwController(curdOption?: CurdOption | string | RouterOptions, routerOptions?: RouterOptions): ClassDecorator;
+export declare const apiDesc: {
+    add: string;
+    delete: string;
+    update: string;
+    page: string;
+    list: string;
+    info: string;
+};

package/dist/decorator/controller.js

@@ -0,0 +1,169 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiDesc = void 0;
+exports.HlwController = HlwController;
+const core_1 = require("@midwayjs/core");
+const fs = require("fs");
+const _ = require("lodash");
+const location_1 = require("../util/location");
+// HLW 的装饰器
+function HlwController(curdOption, routerOptions = { middleware: [], sensitive: true }) {
+    return (target) => {
+        // 将装饰的类，绑定到该装饰器，用于后续能获取到 class
+        (0, core_1.saveModule)(core_1.CONTROLLER_KEY, target);
+        let prefix;
+        if (curdOption) {
+            // 判断 curdOption 的类型
+            if (typeof curdOption === 'string') {
+                prefix = curdOption;
+            }
+            else if (curdOption && 'api' in curdOption) {
+                // curdOption 是 CurdOption 类型
+                prefix = curdOption.prefix || '';
+            }
+            else {
+                // curdOption 是 RouterOptions 类型 合并到 routerOptions
+                routerOptions = { ...curdOption, ...routerOptions };
+            }
+        }
+        // 如果已有明确的 prefix，同步加载模块中间件并注册
+        if (prefix) {
+            location_1.default.scriptPath(target).then(async (res) => {
+                if (res === null || res === void 0 ? void 0 : res.path) {
+                    const pathSps = res.path.split('.');
+                    const paths = pathSps[pathSps.length - 2].split(/[/\\]/);
+                    let module = null;
+                    for (const p of paths.reverse()) {
+                        if (p == 'controller' && paths.includes('modules')) {
+                            module = 'ready';
+                        }
+                        else if (module === 'ready' && p != 'controller') {
+                            module = p;
+                            break;
+                        }
+                    }
+                    if (module) {
+                        const configPath = `${res.path.split(new RegExp(`modules[/\\\\]${module}`))[0]}modules/${module}/config.${_.endsWith(res.path, 'ts') ? 'ts' : 'js'}`;
+                        if (fs.existsSync(configPath)) {
+                            const config = require(configPath).default();
+                            routerOptions.middleware = (config.middlewares || []).concat(routerOptions.middleware || []);
+                        }
+                        saveMetadata(prefix, routerOptions, target, curdOption, module);
+                    }
+                    else {
+                        saveMetadata(prefix, routerOptions, target, curdOption, null);
+                    }
+                }
+                else {
+                    saveMetadata(prefix, routerOptions, target, curdOption, null);
+                }
+            });
+            // 同步先保存 prefix，确保 HlwUrlTagData 能及时读到
+            saveMetadata(prefix, routerOptions, target, curdOption, null);
+            return;
+        }
+        // 如果不存在路由前缀，那么自动根据当前文件夹路径
+        location_1.default.scriptPath(target).then(async (res) => {
+            if (!(res === null || res === void 0 ? void 0 : res.path))
+                return;
+            const pathSps = res.path.split('.');
+            const paths = pathSps[pathSps.length - 2].split(/[/\\]/);
+            const pathArr = [];
+            let module = null;
+            for (const path of paths.reverse()) {
+                if (path != 'controller' && !module) {
+                    pathArr.push(path);
+                }
+                if (path == 'controller' && !paths.includes('modules')) {
+                    break;
+                }
+                if (path == 'controller' && paths.includes('modules')) {
+                    module = 'ready';
+                }
+                if (module && path != 'controller') {
+                    module = `${path}`;
+                    break;
+                }
+            }
+            if (module) {
+                pathArr.reverse();
+                pathArr.splice(1, 0, module);
+                if (pathArr[pathArr.length - 1] === 'index') {
+                    pathArr.pop();
+                }
+                // 追加模块中间件
+                const path = `${res.path.split(new RegExp(`modules[/\\\\]${module}`))[0]}modules/${module}/config.${_.endsWith(res.path, 'ts') ? 'ts' : 'js'}`;
+                if (fs.existsSync(path)) {
+                    const config = require(path).default();
+                    routerOptions.middleware = (config.middlewares || []).concat(routerOptions.middleware || []);
+                }
+            }
+            if (!prefix) {
+                prefix = `/${pathArr.map(p => p.replace(/-/g, '/')).join('/')}`;
+            }
+            saveMetadata(prefix, routerOptions, target, curdOption, module);
+        });
+    };
+}
+exports.apiDesc = {
+    add: '新增',
+    delete: '删除',
+    update: '修改',
+    page: '分页查询',
+    list: '列表查询',
+    info: '单个信息',
+};
+// 保存一些元数据信息，任意你希望存的东西
+function saveMetadata(prefix, routerOptions, target, curdOption, module) {
+    // 统一转小写，避免文件名大小写导致路由不一致
+    prefix = (prefix || '').toLowerCase();
+    if (module && !routerOptions.tagName) {
+        routerOptions = routerOptions || {};
+        routerOptions.tagName = module;
+    }
+    (0, core_1.saveClassMetadata)(core_1.CONTROLLER_KEY, {
+        prefix,
+        routerOptions,
+        curdOption,
+        module,
+    }, target);
+    // 追加CRUD路由
+    if (!_.isEmpty(curdOption === null || curdOption === void 0 ? void 0 : curdOption.api)) {
+        // 获取已存在的路由
+        const existingRoutes = (0, core_1.getClassMetadata)(core_1.WEB_ROUTER_KEY, target) || [];
+        const existingPaths = existingRoutes.map(route => route.path);
+        curdOption === null || curdOption === void 0 ? void 0 : curdOption.api.forEach(path => {
+            const routePath = `/${path}`;
+            // 检查路由是否已存在
+            if (!existingPaths.includes(routePath)) {
+                (0, core_1.attachClassMetadata)(core_1.WEB_ROUTER_KEY, {
+                    path: routePath,
+                    requestMethod: path == 'info' ? 'get' : 'post',
+                    method: path,
+                    summary: exports.apiDesc[path] || path,
+                    description: '',
+                }, target);
+            }
+        });
+    }
+    if (!_.isEmpty(curdOption === null || curdOption === void 0 ? void 0 : curdOption.serviceApis)) {
+        // 获取已存在的路由
+        const existingRoutes = (0, core_1.getClassMetadata)(core_1.WEB_ROUTER_KEY, target) || [];
+        const existingPaths = existingRoutes.map(route => route.path);
+        curdOption.serviceApis.forEach(api => {
+            const methodName = typeof api === 'string' ? api : api.method;
+            const routePath = `/${methodName}`;
+            // 检查路由是否已存在
+            if (!existingPaths.includes(routePath)) {
+                (0, core_1.attachClassMetadata)(core_1.WEB_ROUTER_KEY, {
+                    path: routePath,
+                    requestMethod: 'post',
+                    method: methodName,
+                    summary: typeof api === 'string' ? api : api.summary,
+                    description: '',
+                }, target);
+            }
+        });
+    }
+    (0, core_1.Scope)(core_1.ScopeEnum.Request)(target);
+}

package/dist/decorator/event.d.ts

@@ -0,0 +1,21 @@
+export declare const HLW_CLS_EVENT_KEY = "decorator:hlw:cls:event";
+/**
+ * 事件配置
+ */
+export interface HlwEventOptions {
+    /** 是否全局 */
+    isGlobal: boolean;
+}
+/**
+ * 事件
+ * @param options
+ * @returns
+ */
+export declare function HlwEvent(options?: HlwEventOptions): ClassDecorator;
+export declare const HLW_EVENT_KEY = "decorator:hlw:event";
+/**
+ * 事件
+ * @param eventName
+ * @returns
+ */
+export declare function Event(eventName?: string): MethodDecorator;

package/dist/decorator/event.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HLW_EVENT_KEY = exports.HLW_CLS_EVENT_KEY = void 0;
+exports.HlwEvent = HlwEvent;
+exports.Event = Event;
+const core_1 = require("@midwayjs/core");
+const core_2 = require("@midwayjs/core");
+exports.HLW_CLS_EVENT_KEY = 'decorator:hlw:cls:event';
+/**
+ * 事件
+ * @param options
+ * @returns
+ */
+function HlwEvent(options = {}) {
+    return (target) => {
+        // 将装饰的类，绑定到该装饰器，用于后续能获取到 class
+        (0, core_1.saveModule)(exports.HLW_CLS_EVENT_KEY, target);
+        // 保存一些元数据信息，任意你希望存的东西
+        (0, core_1.saveClassMetadata)(exports.HLW_CLS_EVENT_KEY, options, target);
+        // 指定 IoC 容器创建实例的作用域，这里注册为请求作用域，这样能取到 ctx
+        (0, core_2.Scope)(core_2.ScopeEnum.Singleton)(target);
+    };
+}
+exports.HLW_EVENT_KEY = 'decorator:hlw:event';
+/**
+ * 事件
+ * @param eventName
+ * @returns
+ */
+function Event(eventName) {
+    return (target, propertyKey, descriptor) => {
+        // 将装饰的类，绑定到该装饰器，用于后续能获取到 class
+        (0, core_1.attachClassMetadata)(exports.HLW_EVENT_KEY, {
+            eventName,
+            propertyKey,
+            descriptor,
+        }, target);
+    };
+}

package/dist/decorator/index.d.ts

@@ -0,0 +1,22 @@
+import { MidwayCache } from '@midwayjs/cache-manager';
+import { MidwayDecoratorService } from '@midwayjs/core';
+import { TypeORMDataSourceManager } from '@midwayjs/typeorm';
+import { HlwUrlTagData } from '../tag/data';
+/**
+ * 装饰器
+ */
+export declare class HlwDecorator {
+    typeORMDataSourceManager: TypeORMDataSourceManager;
+    decoratorService: MidwayDecoratorService;
+    midwayCache: MidwayCache;
+    hlwUrlTagData: HlwUrlTagData;
+    init(): Promise<void>;
+    /**
+     * 缓存
+     */
+    cache(): Promise<void>;
+    /**
+     * 事务
+     */
+    transaction(): Promise<void>;
+}