@hlw-midway/core 1.0.0

package/dist/rest/eps.d.ts

@@ -0,0 +1,51 @@
+import { MidwayWebRouterService } from '@midwayjs/core';
+import { TypeORMDataSourceManager } from '@midwayjs/typeorm';
+import { HlwUrlTagData } from '../tag/data';
+import { CurdOption, QueryOp } from '../decorator/controller';
+/**
+ * 实体路径
+ */
+export declare class HlwEps {
+    admin: {};
+    app: {};
+    module: {};
+    midwayWebRouterService: MidwayWebRouterService;
+    typeORMDataSourceManager: TypeORMDataSourceManager;
+    epsConfig: boolean;
+    moduleConfig: any;
+    hlwUrlTagData: HlwUrlTagData;
+    init(): Promise<void>;
+    /**
+     * 获取分页查询配置
+     * @param curdOption
+     * @returns
+     */
+    getPageOp(curdOption: CurdOption): Promise<QueryOp>;
+    /**
+     * 处理列
+     * @param entitys
+     * @param entityColumns
+     * @param curdOption
+     */
+    pageColumns(entitys: Record<string, any[]>, curdOption: CurdOption): Promise<any[]>;
+    /**
+     * 模块信息
+     * @param module
+     */
+    modules(module?: string): Promise<any>;
+    /**
+     * 所有controller
+     * @returns
+     */
+    controller(): Promise<any[]>;
+    /**
+     * 所有路由
+     * @returns
+     */
+    router(): Promise<any>;
+    /**
+     * 所有实体
+     * @returns
+     */
+    entity(): Promise<{}>;
+}

package/dist/rest/eps.js

@@ -0,0 +1,269 @@
+"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.HlwEps = void 0;
+const core_1 = require("@midwayjs/core");
+const _ = require("lodash");
+const core_2 = require("@midwayjs/core");
+const typeorm_1 = require("@midwayjs/typeorm");
+const data_1 = require("../tag/data");
+const tag_1 = require("../decorator/tag");
+/**
+ * 实体路径
+ */
+let HlwEps = class HlwEps {
+    constructor() {
+        this.admin = {};
+        this.app = {};
+        this.module = {};
+    }
+    // @Init()
+    async init() {
+        var _a, _b, _c, _d;
+        if (!this.epsConfig)
+            return;
+        const entitys = await this.entity();
+        const controllers = await this.controller();
+        const routers = await this.router();
+        await this.modules();
+        const adminArr = [];
+        const appArr = [];
+        for (const controller of controllers) {
+            const { prefix, module, curdOption, routerOptions } = controller;
+            const pageQueryOp = await this.getPageOp(curdOption);
+            const name = (_a = curdOption === null || curdOption === void 0 ? void 0 : curdOption.entity) === null || _a === void 0 ? void 0 : _a.name;
+            (_.startsWith(prefix, '/admin/') ? adminArr : appArr).push({
+                module,
+                info: {
+                    type: {
+                        name: prefix.split('/').pop(),
+                        description: (routerOptions === null || routerOptions === void 0 ? void 0 : routerOptions.description) || '',
+                    },
+                },
+                api: routers[prefix],
+                name,
+                columns: entitys[name] || [],
+                pageQueryOp: {
+                    keyWordLikeFields: ((_b = pageQueryOp === null || pageQueryOp === void 0 ? void 0 : pageQueryOp.keyWordLikeFields) === null || _b === void 0 ? void 0 : _b.map(field => field.includes('.') ? field : `a.${field}`)) || [],
+                    fieldEq: ((_c = pageQueryOp === null || pageQueryOp === void 0 ? void 0 : pageQueryOp.fieldEq) === null || _c === void 0 ? void 0 : _c.map(field => typeof field === 'string'
+                        ? field.includes('.')
+                            ? field
+                            : `a.${field}`
+                        : field)) || [],
+                    fieldLike: ((_d = pageQueryOp === null || pageQueryOp === void 0 ? void 0 : pageQueryOp.fieldLike) === null || _d === void 0 ? void 0 : _d.map(field => typeof field === 'string'
+                        ? field.includes('.')
+                            ? field
+                            : `a.${field}`
+                        : field)) || [],
+                },
+                pageColumns: await this.pageColumns(entitys, curdOption),
+                prefix,
+            });
+        }
+        this.admin = _.groupBy(adminArr, 'module');
+        this.app = _.groupBy(appArr, 'module');
+    }
+    /**
+     * 获取分页查询配置
+     * @param curdOption
+     * @returns
+     */
+    async getPageOp(curdOption) {
+        let pageQueryOp = curdOption === null || curdOption === void 0 ? void 0 : curdOption.pageQueryOp;
+        if (typeof pageQueryOp === 'function') {
+            pageQueryOp = await pageQueryOp();
+        }
+        return pageQueryOp;
+    }
+    /**
+     * 处理列
+     * @param entitys
+     * @param entityColumns
+     * @param curdOption
+     */
+    async pageColumns(entitys, curdOption) {
+        var _a;
+        const pageQueryOp = await this.getPageOp(curdOption);
+        // 检查 pageQueryOp 是否为对象且具有 select 属性
+        if (pageQueryOp &&
+            typeof pageQueryOp === 'object' &&
+            'select' in pageQueryOp &&
+            ((_a = curdOption === null || curdOption === void 0 ? void 0 : curdOption.entity) === null || _a === void 0 ? void 0 : _a.name)) {
+            const select = pageQueryOp.select;
+            const join = pageQueryOp.join || [];
+            // 所有的关联entitys
+            const joinEntitys = [{ name: curdOption.entity.name, alias: 'a' }];
+            if (join.length > 0) {
+                joinEntitys.push(...join.map(item => {
+                    return { name: item.entity.name, alias: item.alias };
+                }));
+            }
+            // 处理 select
+            const result = [];
+            for (const selectItem of select) {
+                // 处理 'a.*' 这种情况
+                if (selectItem.endsWith('.*')) {
+                    const alias = selectItem.split('.')[0];
+                    const entity = joinEntitys.find(e => e.alias === alias);
+                    if (entity) {
+                        const entityColumns = entitys[entity.name] || [];
+                        result.push(...entityColumns.map(e => {
+                            return {
+                                ...e,
+                                source: `${alias}.${e.propertyName}`,
+                            };
+                        }));
+                    }
+                    continue;
+                }
+                // 处理单个字段，如 'b.name' 或 'b.name as userName'
+                const asRegex = /\s+as\s+/i;
+                const [field, asName] = selectItem.split(asRegex).map(s => s.trim());
+                const [alias, fieldName] = field.split('.');
+                const entity = joinEntitys.find(e => e.alias === alias);
+                if (entity) {
+                    const entityColumns = entitys[entity.name] || [];
+                    const column = entityColumns.find(col => col.propertyName === fieldName);
+                    if (column) {
+                        result.push({
+                            ...column,
+                            propertyName: asName || column.propertyName,
+                            source: `${alias}.${column.propertyName}`,
+                        });
+                    }
+                }
+            }
+            // 将 createdAt 和 updatedAt 移到末尾
+            const finalResult = [...result];
+            const timeFields = ['createdAt', 'updatedAt'];
+            const timeColumns = [];
+            // 先找出并删除所有时间字段
+            for (let i = finalResult.length - 1; i >= 0; i--) {
+                if (timeFields.includes(finalResult[i].propertyName)) {
+                    timeColumns.unshift(finalResult.splice(i, 1)[0]);
+                }
+            }
+            // 将时间字段添加到末尾
+            finalResult.push(...timeColumns);
+            return finalResult;
+        }
+        return [];
+    }
+    /**
+     * 模块信息
+     * @param module
+     */
+    async modules(module) {
+        for (const key in this.moduleConfig) {
+            const config = this.moduleConfig[key];
+            this.module[key] = {
+                name: config.name,
+                description: config.description,
+            };
+        }
+        return module ? this.module[module] : this.module;
+    }
+    /**
+     * 所有controller
+     * @returns
+     */
+    async controller() {
+        const result = [];
+        const controllers = (0, core_1.listModule)(core_1.CONTROLLER_KEY);
+        for (const controller of controllers) {
+            result.push((0, core_1.getClassMetadata)(core_1.CONTROLLER_KEY, controller));
+        }
+        return result;
+    }
+    /**
+     * 所有路由
+     * @returns
+     */
+    async router() {
+        let ignoreUrls = this.hlwUrlTagData.byKey(tag_1.TagTypes.IGNORE_TOKEN);
+        if (_.isEmpty(ignoreUrls)) {
+            ignoreUrls = [];
+        }
+        return _.groupBy((await this.midwayWebRouterService.getFlattenRouterTable()).map(item => {
+            return {
+                method: item.requestMethod,
+                path: item.url,
+                summary: item.summary,
+                dts: {},
+                tag: '',
+                prefix: item.prefix,
+                ignoreToken: ignoreUrls.includes(item.prefix + item.url),
+            };
+        }), 'prefix');
+    }
+    /**
+     * 所有实体
+     * @returns
+     */
+    async entity() {
+        const result = {};
+        const dataSourceNames = this.typeORMDataSourceManager.getDataSourceNames();
+        for (const dataSourceName of dataSourceNames) {
+            const entityMetadatas = await this.typeORMDataSourceManager.getDataSource(dataSourceName).entityMetadatas;
+            for (const entityMetadata of entityMetadatas) {
+                const commColums = [];
+                let columns = entityMetadata.columns;
+                if (entityMetadata.tableType != 'regular')
+                    continue;
+                columns = _.filter(columns.map(e => {
+                    return {
+                        propertyName: e.propertyName,
+                        type: typeof e.type === 'string' ? e.type : e.type.name.toLowerCase(),
+                        length: e.length,
+                        comment: e.comment,
+                        nullable: e.isNullable,
+                        defaultValue: e.default,
+                        dict: e['dict'],
+                        source: `a.${e.propertyName}`,
+                    };
+                }), o => {
+                    if (['createdAt', 'updatedAt'].includes(o.propertyName)) {
+                        commColums.push(o);
+                    }
+                    return (o &&
+                        !['createdAt', 'updatedAt', 'tenantId'].includes(o.propertyName));
+                }).concat(commColums);
+                result[entityMetadata.name] = columns;
+            }
+        }
+        return result;
+    }
+};
+exports.HlwEps = HlwEps;
+__decorate([
+    (0, core_2.Inject)(),
+    __metadata("design:type", core_2.MidwayWebRouterService)
+], HlwEps.prototype, "midwayWebRouterService", void 0);
+__decorate([
+    (0, core_2.Inject)(),
+    __metadata("design:type", typeorm_1.TypeORMDataSourceManager)
+], HlwEps.prototype, "typeORMDataSourceManager", void 0);
+__decorate([
+    (0, core_2.Config)('hlw.eps'),
+    __metadata("design:type", Boolean)
+], HlwEps.prototype, "epsConfig", void 0);
+__decorate([
+    (0, core_2.Config)('module'),
+    __metadata("design:type", Object)
+], HlwEps.prototype, "moduleConfig", void 0);
+__decorate([
+    (0, core_2.Inject)(),
+    __metadata("design:type", data_1.HlwUrlTagData)
+], HlwEps.prototype, "hlwUrlTagData", void 0);
+exports.HlwEps = HlwEps = __decorate([
+    (0, core_1.Provide)(),
+    (0, core_2.Scope)(core_2.ScopeEnum.Singleton)
+], HlwEps);

package/dist/service/base.d.ts

@@ -0,0 +1,167 @@
+import { BaseMysqlService } from './mysql';
+import { BasePgService } from './postgres';
+import { Application, Context } from '@midwayjs/koa';
+import { TypeORMDataSourceManager } from '@midwayjs/typeorm';
+import { Repository } from 'typeorm';
+import { QueryOp } from '../decorator/controller';
+import { HlwEventManager } from '../event';
+import { BaseSqliteService } from './sqlite';
+/**
+ * 服务基类
+ */
+export declare abstract class BaseService {
+    baseMysqlService: BaseMysqlService;
+    basePgService: BasePgService;
+    baseSqliteService: BaseSqliteService;
+    ormType: any;
+    service: BaseMysqlService | BasePgService | BaseSqliteService;
+    protected entity: Repository<any>;
+    protected sqlParams: any;
+    typeORMDataSourceManager: TypeORMDataSourceManager;
+    hlwEventManager: HlwEventManager;
+    baseCtx: Context;
+    baseApp: Application;
+    init(): Promise<void>;
+    /**
+     * 获取用户ID
+     * @param type 类型
+     * @returns
+     */
+    /**
+     * 获取用户ID
+     * @param type 类型
+     * @returns
+     */
+    protected getUserId(type?: 'admin' | 'app'): any;
+    setEntity(entity: any): void;
+    setCtx(ctx: Context): void;
+    setApp(app: Application): void;
+    /**
+     * 设置sql
+     * @param condition 条件是否成立
+     * @param sql sql语句
+     * @param params 参数
+     */
+    setSql(condition: any, sql: any, params: any): any;
+    /**
+     * 获得查询个数的SQL
+     * @param sql
+     */
+    getCountSql(sql: any): string;
+    /**
+     * 参数安全性检查
+     * @param params
+     */
+    paramSafetyCheck(params: any): Promise<boolean>;
+    /**
+     * 原生查询
+     * @param sql
+     * @param params
+     * @param connectionName
+     */
+    nativeQuery(sql: any, params?: any, connectionName?: any): Promise<any>;
+    /**
+     * 获得ORM管理
+     *  @param connectionName 连接名称
+     */
+    getOrmManager(connectionName?: string): import("typeorm").DataSource;
+    /**
+     * 操作entity获得分页数据，不用写sql
+     * @param find QueryBuilder
+     * @param query
+     * @param autoSort
+     * @param connectionName
+     */
+    entityRenderPage(find: any, query: any, autoSort?: boolean): Promise<{
+        list: any[];
+        pagination: {
+            page: number;
+            size: number;
+            total: number;
+        };
+    }>;
+    /**
+     * 执行SQL并获得分页数据
+     * @param sql 执行的sql语句
+     * @param query 分页查询条件
+     * @param autoSort 是否自动排序
+     * @param connectionName 连接名称
+     */
+    sqlRenderPage(sql: any, query?: {}, autoSort?: boolean, connectionName?: any): Promise<{
+        list: any;
+        pagination: {
+            page: number;
+            size: number;
+            total: number;
+        };
+    }>;
+    /**
+     * 获得单个ID
+     * @param id ID
+     * @param infoIgnoreProperty 忽略返回属性
+     */
+    info(id: any, infoIgnoreProperty?: string[]): Promise<any>;
+    /**
+     * 删除
+     * @param ids 删除的ID集合 如：[1,2,3] 或者 1,2,3
+     */
+    delete(ids: any): Promise<void>;
+    /**
+     * 软删除
+     * @param ids 删除的ID数组
+     * @param entity 实体
+     */
+    softDelete(ids: number[], entity?: Repository<any>): Promise<void>;
+    /**
+     * 修改
+     * @param param 数据
+     */
+    update(param: any): Promise<void>;
+    /**
+     * 新增
+     * @param param 数据
+     */
+    add(param: any | any[]): Promise<Object>;
+    /**
+     * 新增|修改
+     * @param param 数据
+     */
+    addOrUpdate(param: any | any[], type?: 'add' | 'update'): Promise<void>;
+    /**
+     * 非分页查询
+     * @param query 查询条件
+     * @param option 查询配置
+     * @param connectionName 连接名
+     */
+    list(query: any, option: any, connectionName?: any): Promise<any>;
+    /**
+     * 分页查询
+     * @param query 查询条件
+     * @param option 查询配置
+     * @param connectionName 连接名
+     */
+    page(query: any, option: any, connectionName?: any): Promise<{
+        list: any;
+        pagination: {
+            page: number;
+            size: number;
+            total: number;
+        };
+    }>;
+    /**
+     * 构建查询配置
+     * @param query 前端查询
+     * @param option
+     */
+    getOptionFind(query: any, option: QueryOp): Promise<string>;
+    /**
+     * 新增|修改|删除 之后的操作
+     * @param data 对应数据
+     */
+    modifyAfter(data: any, type: 'delete' | 'update' | 'add'): Promise<void>;
+    /**
+     * 新增|修改|删除 之前的操作
+     * @param data 对应数据
+     */
+    modifyBefore(data: any, type: 'delete' | 'update' | 'add'): Promise<void>;
+}