create-meadminjs 1.0.0

package/template/meadmin/src/configuration.ts

@@ -0,0 +1,107 @@
+import { App, Configuration, ILogger, IMidwayApplication, IMidwayContainer, Init, Inject, Logger, MidwayDecoratorService } from '@midwayjs/core';
+import * as info from '@midwayjs/info';
+import * as koa from '@midwayjs/koa';
+import * as validate from '@midwayjs/validate';
+import './helper/dotenv.js';
+// import { ReportMiddleware } from './middleware/report.middleware.js';
+import DefaultConfig from '@/config/config.default.js';
+import UnittestConfig from '@/config/config.unittest.js';
+import * as meadmin from '@meadmin/core';
+import * as viteView from '@meadmin/midway-vite-view'; //引入view组件
+import * as busboy from '@midwayjs/busboy';
+import * as cacheManager from '@midwayjs/cache-manager';
+import * as captcha from '@midwayjs/captcha';
+import * as i18n from '@midwayjs/i18n';
+import * as redis from '@midwayjs/redis';
+import * as staticFile from '@midwayjs/static-file';
+import * as swagger from '@midwayjs/swagger';
+import { RegistreDecorators } from './decorators/index.js';
+import { filters } from './filter/index.js';
+import { initLogger } from './logger.js';
+
+const registreDecorators = new RegistreDecorators();
+
+@Configuration({
+  imports: [
+    koa,
+    i18n,
+    meadmin, //必须放在swagger之前引入
+    validate,
+    {
+      component: info,
+      enabledEnvironment: ['local'],
+    },
+    {
+      component: swagger,
+      enabledEnvironment: ['local', 'dev'],
+    },
+    staticFile,
+    viteView,
+    redis,
+    cacheManager,
+    captcha,
+    busboy,
+  ],
+  importConfigs: [
+    {
+      default: DefaultConfig,
+      unittest: UnittestConfig,
+    },
+  ],
+})
+export class MainConfiguration {
+  @App('koa')
+  app: koa.Application;
+
+  @Inject()
+  decoratorService: MidwayDecoratorService;
+
+  @Logger()
+  appLogger: ILogger;
+
+  @Logger('coreLogger')
+  coreLogger: ILogger;
+
+  @Init()
+  async init() {
+    registreDecorators.decoratorService = this.decoratorService;
+    registreDecorators.init();
+  }
+
+  /**
+   * 在应用配置加载后执行
+   */
+  async onConfigLoad?(container: IMidwayContainer, app: IMidwayApplication) {
+    registreDecorators.onConfigLoad(container, app);
+  }
+
+  /**
+   * 在依赖注入容器 ready 的时候执行
+   */
+  async onReady?(container: IMidwayContainer, app: IMidwayApplication) {
+    initLogger(this.appLogger, this.coreLogger);
+    this.app.useFilter(filters);
+    registreDecorators.onReady(container, app);
+  }
+
+  /**
+   * 在应用服务启动后执行
+   */
+  async onServerReady?(container: IMidwayContainer, app: IMidwayApplication) {
+    registreDecorators.onServerReady(container, app);
+  }
+
+  /**
+   * 在应用停止的时候执行
+   */
+  async onStop?(container: IMidwayContainer, app: IMidwayApplication) {
+    registreDecorators.onStop(container, app);
+  }
+
+  /**
+   * 在健康检查时执行
+   */
+  async onHealthCheck?(container: IMidwayContainer) {
+    registreDecorators.onHealthCheck(container);
+  }
+}

package/template/meadmin/src/controller/api.controller.ts

@@ -0,0 +1,21 @@
+import { CodeEunm } from '@/dict/code.enum.js';
+import { ResponseService } from '@/service/response.service.js';
+import { Controller, Inject } from '@midwayjs/core';
+
+@Controller('/api')
+export abstract class ApiController {
+  @Inject()
+  protected readonly responseService: ResponseService;
+
+  success<T extends Record<string, any>>(data: T = {} as T, message = '操作成功') {
+    return this.responseService.success(data, message);
+  }
+
+  error(message: string, code: Exclude<CodeEunm, CodeEunm.Success> = CodeEunm.Fail) {
+    return this.responseService.error(message, code);
+  }
+
+  successPage<T = any>(list: T[], total = 0, page = 1, size = 10, message = '列表数据获取成功') {
+    return this.responseService.successPage(list, total, page, size, message);
+  }
+}

package/template/meadmin/src/decorators/admin/permission.ts

@@ -0,0 +1,41 @@
+// src/decorator/logging.decorator.ts
+import { RegistreDecorator } from '@/types/decorator.js';
+import { createCustomMethodDecorator, JoinPoint, MidwayDecoratorService, REQUEST_OBJ_CTX_KEY } from '@midwayjs/core';
+import { ForbiddenError, UnauthorizedError } from '@midwayjs/core/dist/error/http.js';
+import { Context } from '@midwayjs/koa';
+
+// 装饰器内部的唯一 id
+export const ADMIN_PERMISSION_KEY = 'decorator:admin_promise';
+
+export function AdminPermission(rule: string | string[]): MethodDecorator {
+  // 我们传递了一个可以修改展示格式的参数
+  return createCustomMethodDecorator(ADMIN_PERMISSION_KEY, { rules: Array.isArray(rule) ? rule : [rule] });
+}
+export class AdminPermissionRegistreDecorators implements RegistreDecorator {
+  decoratorService: MidwayDecoratorService;
+  async init(decoratorService: MidwayDecoratorService) {
+    this.decoratorService = decoratorService;
+  }
+  async onReady() {
+    // 实现方法装饰器
+    this.decoratorService.registerMethodHandler(ADMIN_PERMISSION_KEY, (options) => {
+      return {
+        around: async (joinPoint: JoinPoint) => {
+          // 装饰器所在的实例
+          const instance = joinPoint.target;
+          const ctx = instance[REQUEST_OBJ_CTX_KEY] as Context;
+          if (!ctx.adminInfo) {
+            throw new UnauthorizedError('请登录后再访问！');
+          }
+          if (!ctx.adminInfo.roles.some((item) => item.isSuper === 1) && !ctx.adminInfo.roleMenus.some((item) => options.metadata.rules.include(item.rule))) {
+            throw new ForbiddenError('无权限访问！');
+          }
+          // 执行原方法
+          const result = await joinPoint.proceed(...joinPoint.args);
+          // 返回执行结果
+          return result;
+        },
+      };
+    });
+  }
+}

package/template/meadmin/src/decorators/index/permission.ts

@@ -0,0 +1,37 @@
+// src/decorator/logging.decorator.ts
+import { RegistreDecorator } from '@/types/decorator.js';
+import { createCustomMethodDecorator, JoinPoint, MidwayDecoratorService, REQUEST_OBJ_CTX_KEY } from '@midwayjs/core';
+import { UnauthorizedError } from '@midwayjs/core/dist/error/http.js';
+
+// 装饰器内部的唯一 id
+export const INDEX_PERMISSION_KEY = 'decorator:index_promise';
+
+export function IndexPermission(): MethodDecorator {
+  // 我们传递了一个可以修改展示格式的参数
+  return createCustomMethodDecorator(INDEX_PERMISSION_KEY, {});
+}
+export class IndexPermissionRegistreDecorators implements RegistreDecorator {
+  decoratorService: MidwayDecoratorService;
+  async init(decoratorService: MidwayDecoratorService) {
+    this.decoratorService = decoratorService;
+  }
+  async onReady() {
+    // 实现方法装饰器
+    this.decoratorService.registerMethodHandler(INDEX_PERMISSION_KEY, () => {
+      return {
+        around: async (joinPoint: JoinPoint) => {
+          // 装饰器所在的实例
+          const instance = joinPoint.target;
+          const ctx = instance[REQUEST_OBJ_CTX_KEY];
+          if (!ctx.userInfo) {
+            throw new UnauthorizedError('请登录后再访问！');
+          }
+          // 执行原方法
+          const result = await joinPoint.proceed(...joinPoint.args);
+          // 返回执行结果
+          return result;
+        },
+      };
+    });
+  }
+}

package/template/meadmin/src/decorators/index.ts

@@ -0,0 +1,61 @@
+import { IMidwayApplication, IMidwayContainer, MidwayDecoratorService } from '@midwayjs/core';
+
+export * from './admin/permission.js';
+export * from './index/permission.js';
+export * from './sequelize.js';
+export * from './swagger.js';
+export * from './transactions.js';
+
+import { RegistreDecorator } from '@/types/decorator.js';
+import { AdminPermissionRegistreDecorators } from './admin/permission.js';
+import { IndexPermissionRegistreDecorators } from './index/permission.js';
+import { SequelizeRegistreDecorators } from './sequelize.js';
+import { TransactionRegistreDecorators } from './transactions.js';
+
+export class RegistreDecorators {
+  decoratorService: MidwayDecoratorService;
+
+  regitserDecorators: RegistreDecorator[] = [new SequelizeRegistreDecorators(), new IndexPermissionRegistreDecorators(), new AdminPermissionRegistreDecorators(), new TransactionRegistreDecorators()];
+  /**
+   * 对象初始化时自动执行的方法
+   * @returns
+   */
+  async init() {
+    return await Promise.all(this.regitserDecorators.map((v) => v.init?.(this.decoratorService)));
+  }
+
+  /**
+   * 在应用配置加载后执行
+   */
+  async onConfigLoad?(container: IMidwayContainer, app: IMidwayApplication) {
+    return await Promise.all(this.regitserDecorators.map((v) => v.onConfigLoad?.(container, app)));
+  }
+
+  /**
+   * 在依赖注入容器 ready 的时候执行
+   */
+  async onReady?(container: IMidwayContainer, app: IMidwayApplication) {
+    return await Promise.all(this.regitserDecorators.map((v) => v.onReady?.(container, app)));
+  }
+
+  /**
+   * 在应用服务启动后执行
+   */
+  async onServerReady?(container: IMidwayContainer, app: IMidwayApplication) {
+    return await Promise.all(this.regitserDecorators.map((v) => v.onServerReady?.(container, app)));
+  }
+
+  /**
+   * 在应用停止的时候执行
+   */
+  async onStop?(container: IMidwayContainer, app: IMidwayApplication) {
+    return await Promise.all(this.regitserDecorators.map((v) => v.onStop?.(container, app)));
+  }
+
+  /**
+   * 在健康检查时执行
+   */
+  async onHealthCheck?(container: IMidwayContainer) {
+    return await Promise.all(this.regitserDecorators.map((v) => v.onHealthCheck?.(container)));
+  }
+}

package/template/meadmin/src/decorators/sequelize.ts

@@ -0,0 +1,65 @@
+import { SequelizeDataSourceManagerService } from '@/service/dataSourceManager.service.js';
+import { RegistreDecorator } from '@/types/decorator.js';
+import { createCustomPropertyDecorator, IMidwayContainer, MidwayDecoratorService } from '@midwayjs/core';
+import { Model } from '@sequelize/core';
+
+//sequize获取Repository
+export const ENTITY_MODEL_KEY = 'meadmin:sequelize:entity_model_key';
+export function InjectRepository(modelKey: { new (): Model<any, any> }, connectionName?: string) {
+  return createCustomPropertyDecorator(ENTITY_MODEL_KEY, {
+    modelKey,
+    connectionName,
+  });
+}
+
+//sequize获取dataSourceName
+export const DATA_SOURCE_KEY = 'meadmin:sequelize:data_source_key';
+export function InjectDataSource(dataSourceName?: string) {
+  return createCustomPropertyDecorator(DATA_SOURCE_KEY, {
+    dataSourceName,
+  });
+}
+
+export class SequelizeRegistreDecorators implements RegistreDecorator {
+  decoratorService: MidwayDecoratorService;
+  dataSourceManager: SequelizeDataSourceManagerService;
+  async init(decoratorService: MidwayDecoratorService) {
+    this.decoratorService = decoratorService;
+    this.decoratorService.registerPropertyHandler(
+      ENTITY_MODEL_KEY,
+      (
+        propertyName,
+        meta: {
+          modelKey: { new (): Model<any, any> };
+          connectionName?: string;
+        },
+      ) => {
+        return this.dataSourceManager
+          .getDataSource(meta.connectionName || this.dataSourceManager.getDataSourceNameByModel(meta.modelKey) || this.dataSourceManager.getDefaultDataSourceName())
+          .models.get(meta.modelKey.name);
+      },
+    );
+
+    this.decoratorService.registerPropertyHandler(
+      DATA_SOURCE_KEY,
+      (
+        propertyName,
+        meta: {
+          dataSourceName?: string;
+        },
+      ) => {
+        return this.dataSourceManager.getDataSource(meta.dataSourceName || this.dataSourceManager.getDefaultDataSourceName());
+      },
+    );
+  }
+
+  async onReady(container: IMidwayContainer) {
+    this.dataSourceManager = await container.getAsync(SequelizeDataSourceManagerService);
+  }
+
+  async onStop() {
+    if (this.dataSourceManager) {
+      await this.dataSourceManager.stop();
+    }
+  }
+}

package/template/meadmin/src/decorators/swagger.ts

@@ -0,0 +1,170 @@
+import { ApiPageRes, PageRes } from '@/response/apiPage.res.js';
+import { ApiSuccessRes, ApiSuccessResArr } from '@/response/apiSuccess.res.js';
+import { getKeyInfo } from '@meadmin/cli/utils/formatting';
+import { createCustomMethodDecorator } from '@midwayjs/core';
+import { ApiExtraModel, ApiOperation, ApiOperationOptions, ApiProperty, ApiPropertyOptions, ApiResponse, getSchemaPath, Type } from '@midwayjs/swagger';
+import { Rule, RuleType } from '@midwayjs/validate';
+
+// 装饰器内部的唯一 id
+export const API_OPERATIN_RESONSE_KEY = 'meadmin:swagger:api_operation_respose';
+/**
+ * swagger返回参数装饰器
+ * @param options
+ * @returns
+ */
+export function ApiOperationResponse<TModel extends Type<any>>(
+  options: ApiOperationOptions & {
+    responseType?: TModel | false | string; //返回格式
+    responsePage?: TModel; //分页返回list格式
+    responseList?: TModel; //data数组返回,元素格式
+  },
+): MethodDecorator {
+  const classDecorators = [ApiExtraModel(ApiSuccessRes), ApiExtraModel(ApiPageRes), ApiExtraModel(PageRes)];
+  const methodDecorators = [];
+  if (options.responsePage) {
+    classDecorators.push(ApiExtraModel(options.responsePage));
+    methodDecorators.push(
+      ApiResponse({
+        schema: {
+          $ref: getSchemaPath(ApiPageRes),
+          properties: {
+            data: {
+              $ref: getSchemaPath(PageRes),
+              description: '数据,code非200时值为undefined',
+              properties: {
+                list: {
+                  type: 'array',
+                  items: {
+                    type: 'object',
+                    $ref: getSchemaPath(options.responsePage),
+                  },
+                  description: '分页数据',
+                },
+              },
+            },
+          },
+        },
+      }),
+    );
+  } else if (options.responseList) {
+    if (typeof options.responseList === 'object') {
+      classDecorators.push(ApiExtraModel(options.responseList));
+    }
+    methodDecorators.push(
+      ApiResponse({
+        description: '请求成功',
+        schema: {
+          $ref: getSchemaPath(ApiSuccessResArr),
+          properties: {
+            data: {
+              type: 'array',
+              description: '数据,code非200时值为undefined',
+              items: {
+                $ref: typeof options.responseList === 'object' ? getSchemaPath(options.responseList) : undefined,
+                type: typeof options.responseList === 'object' ? undefined : options.responseList,
+              },
+            },
+          },
+        },
+      }),
+    );
+  } else if (typeof options.responseType === 'function' || typeof options.responseType === 'object') {
+    classDecorators.push(ApiExtraModel(options.responseType));
+    methodDecorators.push(
+      ApiResponse({
+        description: '请求成功',
+        schema: {
+          $ref: getSchemaPath(ApiSuccessRes),
+          properties: {
+            data: {
+              type: 'object',
+              $ref: getSchemaPath(options.responseType),
+              description: '数据,code非200时值为undefined',
+            },
+          },
+        },
+      }),
+    );
+  } else if (options.responseType !== false) {
+    methodDecorators.push(
+      ApiResponse({
+        description: '请求成功',
+        schema: {
+          $ref: getSchemaPath(ApiSuccessRes),
+          properties:
+            typeof options.responseType === 'string'
+              ? {
+                  data: {
+                    type: options.responseType,
+                    description: '数据,code非200时值为undefined',
+                  },
+                }
+              : undefined,
+        },
+      }),
+    );
+  }
+  methodDecorators.push(ApiOperation(Object.assign(options, { successType: undefined, responsePage: undefined })));
+  return <T>(target: (...args: any[]) => any, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => {
+    classDecorators.forEach((fn) => fn(target));
+    methodDecorators.forEach((fn) => fn(target, propertyKey, descriptor));
+    return createCustomMethodDecorator(API_OPERATIN_RESONSE_KEY, {}, false)(target, propertyKey, descriptor);
+  };
+}
+
+/**
+ * swagger和rule校验结合，会自动根据rule规则生成对应配置
+ * @param options
+ * @returns
+ */
+export function ApiPropertyRule(options?: ApiPropertyOptions & { rule?: RuleType.AnySchema<any> }): PropertyDecorator {
+  const propertyDecorators = [] as PropertyDecorator[];
+  if (options && options.rule) {
+    if (!options.rule.$_getFlag('label') && options.description) {
+      options.rule = options.rule.label(`{${getKeyInfo(options.description).name}}`);
+    }
+    if (options.required === undefined) {
+      options.required = options.rule.$_getFlag('presence') === 'required' ? true : undefined;
+    }
+    if (!options.enum && options.rule.describe().allow && options.rule.$_getFlag('only')) {
+      options.enum = options.rule.describe().allow;
+    } else if (options.enum && !options.enum.length) {
+      options.enum = undefined;
+    }
+    if (!options.required && !(options.rule as any)._invalids?._values.has(null)) {
+      //如果不是必填值，允许null
+      options.rule = options.rule.allow(null);
+    }
+    if (options.rule.type === 'number') {
+      if (options.maximum !== undefined) {
+        options.maximum = options.rule.$_getRule('max')?.args?.limit;
+      }
+      if (options.minimum !== undefined) {
+        options.minimum = options.rule.$_getRule('min')?.args?.limit;
+      }
+    }
+    if (options.rule.type === 'string') {
+      options.rule.empty(''); //将 空串视为空而不是无效值,否则空串会被 stripUnknown 配置 视为无效值处理掉
+      if (options.maxLength !== undefined) {
+        options.maxLength = options.rule.$_getRule('max')?.args?.limit;
+      }
+      if (options.minLength !== undefined) {
+        options.minLength = options.rule.$_getRule('min')?.args?.limit;
+      }
+      if (!options.required && !(options.rule as any)._invalids?._values.has('')) {
+        //如果不是必填值，允许空串
+        options.rule = options.rule.allow('');
+      }
+    }
+
+    if (options.default !== undefined) {
+      options.default = options.rule.$_getFlag('default');
+    }
+    propertyDecorators.push(Rule(options.rule));
+  }
+  propertyDecorators.push(ApiProperty(options));
+
+  return (target: (...args: any[]) => any, propertyKey: string | symbol) => {
+    propertyDecorators.forEach((fn) => fn(target, propertyKey));
+  };
+}

package/template/meadmin/src/decorators/transactions.ts

@@ -0,0 +1,42 @@
+// 开启事务
+import { SequelizeDataSourceManagerService } from '@/service/dataSourceManager.service.js';
+import { RegistreDecorator } from '@/types/decorator.js';
+import { createCustomMethodDecorator, IMidwayContainer, JoinPoint, MidwayDecoratorService } from '@midwayjs/core';
+import { ManagedTransactionOptions } from '@sequelize/core';
+
+// 装饰器内部的唯一 id
+export const TRANSACTION_KEY = 'decorator:transaction';
+export type TransactionOptions = {
+  sourceName?: string; //使用的seqlize实例，不传使用默认值
+  options?: ManagedTransactionOptions; //事务参数
+};
+export function Transaction(options?: TransactionOptions): MethodDecorator {
+  // 我们传递了一个可以修改展示格式的参数
+  return createCustomMethodDecorator(TRANSACTION_KEY, options);
+}
+export class TransactionRegistreDecorators implements RegistreDecorator {
+  decoratorService: MidwayDecoratorService;
+  async init(decoratorService: MidwayDecoratorService) {
+    this.decoratorService = decoratorService;
+  }
+  async onReady(container: IMidwayContainer) {
+    // 实现方法装饰器
+    this.decoratorService.registerMethodHandler(TRANSACTION_KEY, (options) => {
+      return {
+        around: async (joinPoint: JoinPoint) => {
+          const dataSourceManager = await container.getAsync(SequelizeDataSourceManagerService);
+          const seqlize = dataSourceManager.getDataSource(options.metadata?.sourceName ?? dataSourceManager.getDefaultDataSourceName());
+          return options.metadata?.options
+            ? await seqlize.transaction(options.metadata.options, async () => {
+                // 执行原方法
+                return await joinPoint.proceed(...joinPoint.args);
+              })
+            : await seqlize.transaction(async () => {
+                // 执行原方法
+                return await joinPoint.proceed(...joinPoint.args);
+              });
+        },
+      };
+    });
+  }
+}

package/template/meadmin/src/dict/code.enum.ts

@@ -0,0 +1,8 @@
+export enum CodeEunm {
+  Success = '200', //成功
+  Unauthorized = '401', //未登录
+  Forbidden = '403', //没权限
+  Fail = '400', //失败(业务错误)
+  ValidateFail = '422', //校验失败
+  Error = '500', //异常
+}

package/template/meadmin/src/dto/page.dto.ts

@@ -0,0 +1,16 @@
+import { ApiProperty } from '@midwayjs/swagger';
+import { Rule, RuleType } from '@midwayjs/validate';
+
+export class PageDto {
+  @ApiProperty({ description: '页数', default: 1, type: 'integer' })
+  @Rule(RuleType.number().default(1))
+  page: number;
+  @Rule(RuleType.number().default(10))
+  @ApiProperty({
+    description: '每页记录数',
+    default: 10,
+
+    type: 'integer',
+  })
+  pageSize: number;
+}

package/template/meadmin/src/entities/abstract/adminBase.entity.ts

@@ -0,0 +1,35 @@
+import { ApiPropertyRule } from '@/decorators/swagger.js';
+import { DataTypes, NonAttribute } from '@sequelize/core';
+import { Attribute, BelongsTo, Table } from '@sequelize/core/decorators-legacy';
+import { SystemAdmin } from '../systemAdmin.entity.js';
+import { BaseModel } from './base.entity.js';
+
+//AdminBaseModel 后台实体基础类
+@Table.Abstract
+export class AdminBaseModel<M extends AdminBaseModel<any>> extends BaseModel<M> {
+  @Attribute({
+    comment: '创建者(管理员)Id',
+    type: DataTypes.STRING(20),
+  })
+  createdAdminId: string;
+
+  @ApiPropertyRule({
+    description: '创建者(管理员)',
+    type: () => SystemAdmin,
+  })
+  @BelongsTo(() => SystemAdmin, { foreignKey: 'createdAdminId', foreignKeyConstraints: false })
+  declare createdAdmin?: NonAttribute<SystemAdmin | null>;
+
+  @Attribute({
+    comment: '最后更新者(管理员)Id',
+    type: DataTypes.STRING(20),
+  })
+  updatedAdminId: string;
+
+  @ApiPropertyRule({
+    description: '最后更新者(管理员)',
+    type: () => SystemAdmin,
+  })
+  @BelongsTo(() => SystemAdmin, { foreignKey: 'updatedAdminId', foreignKeyConstraints: false })
+  declare updatedAdmin?: NonAttribute<SystemAdmin | null>;
+}