create-meadminjs 1.0.0

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

@@ -0,0 +1,258 @@
+import { ApiPropertyRule } from '@/decorators/index.js';
+import { uuid } from '@/helper/snowflake.js';
+import { listToTree } from '@/helper/utils.js';
+import { RuleType } from '@midwayjs/validate';
+import {
+  Attributes,
+  CreateOptions,
+  DataTypes,
+  FindOptions,
+  InferAttributes,
+  InferCreationAttributes,
+  InstanceDestroyOptions,
+  InstanceUpdateOptions,
+  Model,
+  ModelStatic,
+  Op,
+  sql,
+} from '@sequelize/core';
+import { AfterDestroy, AfterUpdate, Attribute, BeforeCreate, Table } from '@sequelize/core/decorators-legacy';
+import { AdminBaseModel } from './adminBase.entity.js';
+
+//无限级树形
+@Table.Abstract
+export class AdminTreeModel<M extends AdminTreeModel<any> = any> extends AdminBaseModel<M> {
+  @Attribute({
+    comment: '父级id',
+    type: DataTypes.STRING(100),
+  })
+  @ApiPropertyRule({ description: '父级id', rule: RuleType.string().max(100).allow(null) })
+  parentId: string;
+
+  @Attribute({
+    comment: '左树边界',
+    type: DataTypes.INTEGER.UNSIGNED,
+  })
+  left: number;
+
+  @Attribute({
+    comment: '右树边界',
+    type: DataTypes.INTEGER.UNSIGNED,
+  })
+  right: number;
+
+  @Attribute({
+    comment: '锁版本号',
+    type: DataTypes.STRING(100),
+    allowNull: false,
+    defaultValue: '',
+  })
+  lockVersion: string;
+
+  @BeforeCreate()
+  static async setLeftRightByCreate<M extends AdminTreeModel>(this: ModelStatic<M>, info: M, options: CreateOptions<any>) {
+    const model = info.modelDefinition.model;
+    type MInfo = Model<InferAttributes<AdminTreeModel>, InferCreationAttributes<AdminTreeModel>>;
+    let left = 1;
+    if (info.parentId) {
+      const parentinfo = (await model.findByPk<MInfo>(info.parentId, { transaction: options.transaction })) as M;
+      left = parentinfo.right;
+    } else {
+      const parentinfo = (await model.findOne<MInfo>({ order: [['right', 'DESC']], transaction: options.transaction })) as M;
+      if (parentinfo) {
+        left = parentinfo.right + 1;
+      }
+    }
+    info.left = left;
+    info.right = left + 1;
+    await model.increment<MInfo>(
+      {
+        right: 2,
+      },
+      {
+        where: { right: { [Op.gte]: info.left } },
+        transaction: options.transaction,
+      },
+    );
+    await model.increment<MInfo>(
+      {
+        left: 2,
+      },
+      {
+        where: { left: { [Op.gte]: info.left } },
+        transaction: options.transaction,
+      },
+    );
+  }
+
+  @AfterDestroy()
+  static async setLeftRightByDestory<M extends AdminTreeModel>(this: ModelStatic<M>, info: M, options: InstanceDestroyOptions) {
+    //删除子孙级
+    const model = info.modelDefinition.model;
+    type MInfo = Model<InferAttributes<AdminTreeModel>, InferCreationAttributes<AdminTreeModel>>;
+    await model.destroy<MInfo>({
+      where: {
+        left: { [Op.gt]: info.left },
+        right: { [Op.lt]: info.right },
+      },
+      transaction: options.transaction,
+    });
+    const step = info.right - info.left + 1;
+    //右侧的左移
+    await model.decrement<MInfo>(
+      {
+        right: step,
+      },
+      {
+        where: {
+          right: {
+            [Op.gt]: info.right,
+          },
+        },
+        transaction: options.transaction,
+      },
+    );
+    await model.decrement<MInfo>(
+      { left: step },
+      {
+        where: {
+          left: {
+            [Op.gt]: info.right,
+          },
+        },
+        transaction: options.transaction,
+      },
+    );
+  }
+
+  @AfterUpdate()
+  static async setLeftRightByUpdate<M extends AdminTreeModel>(this: ModelStatic<M>, info: M, options: InstanceUpdateOptions<any>) {
+    const version = uuid();
+    const oldLeft = info.left;
+    const model = info.modelDefinition.model;
+    type MInfo = Model<InferAttributes<AdminTreeModel>, InferCreationAttributes<AdminTreeModel>>;
+    //锁定当前及当前子孙数据
+    await model.update<MInfo>(
+      {
+        lockVersion: version,
+      },
+      {
+        where: {
+          left: {
+            [Op.gte]: info.left,
+          },
+          right: {
+            [Op.lte]: info.right,
+          },
+        },
+        transaction: options.transaction,
+      },
+    );
+    const step = info.right - info.left + 1;
+    //右侧的左移
+    await model.decrement<MInfo>(
+      {
+        right: step,
+      },
+      {
+        where: {
+          right: {
+            [Op.gt]: info.right,
+          },
+        },
+        transaction: options.transaction,
+      },
+    );
+    await model.decrement<MInfo>(
+      { left: step },
+      {
+        where: {
+          left: {
+            [Op.gt]: info.right,
+          },
+        },
+        transaction: options.transaction,
+      },
+    );
+    //添加
+    let left = 1;
+    if (info.parentId) {
+      const parentinfo = (await model.findByPk<MInfo>(info.parentId, { transaction: options.transaction })) as M;
+      left = parentinfo.right;
+    } else {
+      const parentinfo = (await model.findOne<MInfo>({ where: { lockVersion: { [Op.ne]: version } }, order: [['right', 'DESC']], transaction: options.transaction })) as M;
+      if (parentinfo) {
+        left = parentinfo.right + 1;
+      }
+    }
+    info.left = left;
+    info.right = left + step - 1;
+    await model.increment<MInfo>(
+      {
+        right: step,
+      },
+      {
+        where: {
+          lockVersion: {
+            [Op.ne]: version,
+          },
+          right: {
+            [Op.gte]: info.left,
+          },
+        },
+        transaction: options.transaction,
+      },
+    );
+    await model.increment<MInfo>(
+      {
+        left: step,
+      },
+      {
+        where: {
+          lockVersion: {
+            [Op.ne]: version,
+          },
+          left: {
+            [Op.gte]: info.left,
+          },
+        },
+        transaction: options.transaction,
+      },
+    );
+    if (oldLeft > info.left) {
+      await model.update<MInfo>(
+        { left: sql`${sql.attribute('left')} - ${oldLeft - info.left}`, right: sql`${sql.attribute('right')} - ${oldLeft - info.left}`, lockVersion: '' },
+        { where: { lockVersion: version }, transaction: options.transaction },
+      );
+    } else {
+      await model.update<MInfo>(
+        { left: sql`${sql.attribute('left')} + ${info.left - oldLeft}`, right: sql`${sql.attribute('right')} + ${info.left - oldLeft}`, lockVersion: '' },
+        { where: { lockVersion: version }, transaction: options.transaction },
+      );
+    }
+  }
+
+  //获取树形数据,返回值为普通object不是model
+  static async getTree<M extends Model>(this: ModelStatic<M>, options?: FindOptions<Attributes<M>> | (Omit<FindOptions<Attributes<M>>, 'raw'> & { raw: true })) {
+    const list = await this.findAll(options);
+    return listToTree<M>(list.map((item) => item.dataValues));
+  }
+
+  //获取所有后代,并以树形返回,返回值为普通object不是model
+  async getDescendants() {
+    const list = await this.modelDefinition.model.findAll({
+      where: {
+        left: {
+          [Op.gt]: this.left,
+        },
+        right: {
+          [Op.lt]: this.right,
+        },
+      },
+    });
+    return listToTree(list.map((item) => item.dataValues));
+  }
+
+  //TODO::根据parentId重置树形参数，尚未实现
+  static async perfectTree() {}
+}

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

@@ -0,0 +1,69 @@
+import { ApiPropertyRule } from '@/decorators/index.js';
+import { ctx } from '@meadmin/core';
+import { BulkCreateOptions, InferAttributes, InferCreationAttributes, InstanceUpdateOptions, Model, ModelStatic, UpdateOptions } from '@sequelize/core';
+import { AfterBulkUpdate, Attribute, BeforeBulkCreate, BeforeCreate, BeforeUpdate, CreatedAt, Table, UpdatedAt } from '@sequelize/core/decorators-legacy';
+
+//基础model
+@Table.Abstract
+export class BaseModel<M extends Model<any, any>> extends Model<InferAttributes<M>, InferCreationAttributes<M>> {
+  @CreatedAt
+  @Attribute({ comment: '创建时间' })
+  @ApiPropertyRule({ description: '创建时间' })
+  declare createdAt: Date;
+
+  @UpdatedAt
+  @Attribute({ comment: '最后更新时间' })
+  @ApiPropertyRule({ description: '最后更新时间' })
+  declare updatedAt: Date;
+
+  @BeforeCreate()
+  static async setCreatedId(info: BaseModel<any>, options: InstanceUpdateOptions<BaseModel<any>>) {
+    if (ctx?.adminInfo && info.modelDefinition.attributes.has('createdAdminId')) {
+      //设置创建管理员Id
+      (info as any).createdAdminId = ctx.adminInfo.id;
+      if (ctx?.adminInfo && info.modelDefinition.attributes.has('updatedAdminId')) {
+        //设置更新管理员Id
+        (info as any).updatedAdminId = ctx.adminInfo.id;
+      }
+    }
+  }
+
+  @BeforeBulkCreate()
+  static async setCreatedIdBulk(instances: BaseModel<any>[], options: BulkCreateOptions<BaseModel<any>> & { model: ModelStatic<BaseModel<any>> }) {
+    if (ctx?.adminInfo && options.model.modelDefinition.attributes.has('createdAdminId')) {
+      //设置创建管理员Id
+      instances.forEach((instance) => {
+        (instance as any).createdAdminId = ctx.adminInfo.id;
+      });
+      if (options.model.modelDefinition.attributes.has('updatedAdminId')) {
+        //设置更新管理员Id
+        instances.forEach((instance) => {
+          (instance as any).updatedAdminId = ctx.adminInfo.id;
+        });
+      }
+    }
+  }
+
+  @BeforeUpdate()
+  static async setUpdatedId(info: BaseModel<any>, options: InstanceUpdateOptions<BaseModel<any>>) {
+    if (ctx?.adminInfo && info.modelDefinition.attributes.has('updatedAdminId')) {
+      //设置更新管理员Id
+      (info as any).updatedAdminId = ctx.adminInfo.id;
+    }
+  }
+
+  @AfterBulkUpdate()
+  static async setUpdatedIdBulk(options: UpdateOptions<BaseModel<any>> & { model: ModelStatic<BaseModel<any>> }) {
+    if (ctx?.adminInfo && options.model.modelDefinition.attributes.has('updatedAdminId')) {
+      //设置更新管理员Id
+      await options.model.update(
+        { updatedAdminId: ctx.adminInfo.id },
+        {
+          where: options.where,
+          transaction: options.transaction,
+          hooks: false,
+        },
+      );
+    }
+  }
+}

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

@@ -0,0 +1,39 @@
+import { ApiPropertyRule } from '@/decorators/index.js';
+import { DataTypes, NonAttribute } from '@sequelize/core';
+import { Attribute, BelongsTo, Table } from '@sequelize/core/decorators-legacy';
+import { User } from '../user.entity.js';
+import { AdminBaseModel } from './adminBase.entity.js';
+
+//IndexBaseModel 前台台实体基础类
+@Table.Abstract
+export class IndexBaseModel<M extends IndexBaseModel<any>> extends AdminBaseModel<M> {
+  @ApiPropertyRule({
+    description: '创建者(用户)Id',
+    type: 'string',
+  })
+  @Attribute({
+    comment: '创建者(用户)Id',
+    type: DataTypes.STRING(20),
+  })
+  createdUserId: string | null;
+
+  @ApiPropertyRule({
+    description: '创建者(用户)',
+    type: () => User,
+  })
+  @BelongsTo(() => User, { foreignKey: 'createdUserId', foreignKeyConstraints: false })
+  declare createdUser?: NonAttribute<User>;
+
+  @Attribute({
+    comment: '最后更新者(用户)Id',
+    type: DataTypes.STRING(20),
+  })
+  updatedUserId: string | null;
+
+  @ApiPropertyRule({
+    description: '最后更新者(用户)',
+    type: () => User,
+  })
+  @BelongsTo(() => User, { foreignKey: 'updatedUserId', foreignKeyConstraints: false })
+  declare updatedUser?: NonAttribute<User>;
+}

package/template/meadmin/src/entities/exampleBook.entity.ts

@@ -0,0 +1,22 @@
+import { ApiPropertyRule } from '@/decorators/index.js';
+import { uuid } from '@/helper/snowflake.js';
+import { RuleType } from '@/ruleType/index.js';
+import { DataTypes } from '@sequelize/core';
+import { Attribute, Default, PrimaryKey, Table } from '@sequelize/core/decorators-legacy';
+import { AdminBaseModel } from './abstract/adminBase.entity.js';
+
+//rule规则使用添加接口的校验规则,建议字符串的默认值统一使用空串，否则RuleType.string需要显示声明allow(null)允许传入null
+@Table({ tableName: 'example_book', comment: '示例_书籍' })
+//继承自DelParanoidModel则使用软删除。
+export class ExampleBook extends AdminBaseModel<ExampleBook> {
+  //自动生成的主键
+  @Attribute({ type: DataTypes.STRING(20), allowNull: false })
+  @PrimaryKey
+  @Default(uuid)
+  @ApiPropertyRule({ description: 'ID', rule: RuleType.string() })
+  id: string;
+
+  @Attribute({ type: DataTypes.STRING(20), comment: '名称', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '名称', rule: RuleType.string().max(20).min(1).required() })
+  name: string;
+}

package/template/meadmin/src/entities/exampleDemo.entity.ts

@@ -0,0 +1,104 @@
+import { ApiPropertyRule } from '@/decorators/index.js';
+import { uuid } from '@/helper/snowflake.js';
+import { RuleType } from '@/ruleType/index.js';
+import { BelongsManyModel, BelongsToModel } from '@/types/entity.js';
+import { DataTypes, NonAttribute, Op } from '@sequelize/core';
+import { Attribute, BelongsTo, BelongsToMany, Default, DeletedAt, Index, PrimaryKey, Table } from '@sequelize/core/decorators-legacy';
+import { AdminBaseModel } from './abstract/adminBase.entity.js';
+import { ExampleBook } from './exampleBook.entity.js';
+import { File } from './file.entity.js';
+import { User } from './user.entity.js';
+
+//rule规则使用添加接口的校验规则,建议字符串的默认值统一使用空串，否则RuleType.string需要显示声明allow(null)允许传入null
+@Table({ tableName: 'example_demo', comment: '示例_Demo' })
+//继承自DelParanoidModel则使用软删除。
+export class ExampleDemo extends AdminBaseModel<ExampleDemo> {
+  //自动生成的主键
+  @Attribute({ type: DataTypes.STRING(20), allowNull: false })
+  @PrimaryKey
+  @Default(uuid)
+  @ApiPropertyRule({ description: 'ID', rule: RuleType.string() })
+  id: string;
+
+  //唯一索引名称必须全库唯一，当两个null值时唯一索引会认为不是同一个值
+  @Index({ unique: true, where: { deleted_at: { [Op.isNot]: null } } }) //局部唯一索引设置只有不删除的数据加索引
+  @Attribute({ type: DataTypes.STRING(11), comment: '手机号' })
+  @ApiPropertyRule({ description: '手机号', rule: RuleType.string().mobile().description('手机号').required() })
+  mobile: string;
+
+  //以“名称:值1=说明1;值2=说明2”，格式声明的备注会自动创建字典和下拉列表，并且支持number、string两种类型
+  @Attribute({
+    comment: '类型:0=书籍;1=电子产品;2=卡片',
+    defaultValue: 0,
+    allowNull: false,
+    type: DataTypes.TINYINT.UNSIGNED,
+  })
+  @ApiPropertyRule({ description: '类型:0=书籍;1=电子产品;2=卡片', rule: RuleType.number().equal(0, 1, 2).required() })
+  type: number;
+
+  //ApiPropertyRule对RuleType规则做了封面，对于非必填的number和string自动允许null值，如果不允许null请设置required()或者设置invalid(null)
+  //前端会根据rule生成表达校验，包括必填、类型(string、number)、mobile、email、min、max。
+  @Attribute({ type: DataTypes.STRING(20), comment: '名称', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '名称', rule: RuleType.string().max(20).min(1).required() })
+  name: string;
+
+  //多对多关联 文档 可参考https://sequelize.org/docs/v7/associations/belongs-to-many/
+  @BelongsToMany(() => ExampleBook, {
+    through: 'example_demo_books', //中间表名称 或者 对应的Model，
+    foreignKeyConstraints: false, //数据库不创建外键，外键应用层解决
+    // 如果需要在ExampleBook定义反向关联可以添加参数  inverse: {as: 'demos',}, 并在 ExampleBook中添加 /** Declared by {@link Person.likedToots} */  declare demo?: NonAttribute<ExampleBook[]>;
+  })
+  @ApiPropertyRule({
+    description: '书籍',
+    type: 'array',
+    items: {
+      type: () => ExampleBook,
+    },
+    rule: RuleType.array().items(RuleType.object({ id: RuleType.string().required() })),
+  })
+  books?: NonAttribute<ExampleBook[]>;
+
+  //反向BelongsTo关联从属， 文档 可参考https://sequelize.org/docs/v7/associations/belongs-to/
+  @Attribute({ type: DataTypes.STRING(20), comment: '关联前台用户id' })
+  userId: string;
+  @ApiPropertyRule({ description: '用户', type: () => User, rule: RuleType.object({ id: RuleType.string().required() }).pattern(RuleType.string(), RuleType.any()) })
+  @BelongsTo(() => User, {
+    foreignKey: 'userId', //外键名称
+    foreignKeyConstraints: false, //数据库不创建外键，外键应用层解决
+  })
+  user?: NonAttribute<User>;
+
+  //反向BelongsTo关联从属，File类型创建单文件
+  @Attribute({ type: DataTypes.STRING(20), comment: '头像附件id' })
+  avatarFileId: string;
+  @ApiPropertyRule({ description: '头像', type: () => File, rule: RuleType.object({ id: RuleType.string().required() }).pattern(RuleType.string(), RuleType.any()) })
+  @BelongsTo(() => File, {
+    foreignKey: 'avatarFileId', //外键名称
+    foreignKeyConstraints: false, //数据库不创建外键，外键应用层解决
+  })
+  avatar?: NonAttribute<File>;
+
+  //BelongsTo多对多关联从属，File类型创建多文件选择
+  @BelongsToMany(() => File, {
+    through: 'example_demo_files', //中间表名称 或者 对应的Model，
+    foreignKeyConstraints: false, //数据库不创建外键，外键应用层解决
+  })
+  @ApiPropertyRule({
+    description: '附件',
+    type: 'array',
+    items: {
+      type: () => File,
+    },
+    rule: RuleType.array().items(RuleType.object({ id: RuleType.string().required() })),
+  })
+  files?: NonAttribute<File[]>;
+
+  @DeletedAt //设置为软删除
+  @Attribute({ comment: '删除时间' })
+  declare deletedAt: Date | null;
+}
+//声明自动关联方法
+export declare interface ExampleDemo extends BelongsManyModel<'books', 'book', 'books', ExampleBook> {}
+export declare interface ExampleDemo extends BelongsToModel<'user', User> {}
+export declare interface ExampleDemo extends BelongsToModel<'avatar', File> {}
+export declare interface ExampleDemo extends BelongsManyModel<'files', 'file', 'files', File> {}

package/template/meadmin/src/entities/file.entity.ts

@@ -0,0 +1,68 @@
+import { ApiPropertyRule } from '@/decorators/index.js';
+import { uuid } from '@/helper/snowflake.js';
+import { RuleType } from '@/ruleType/index.js';
+import { DataTypes, NonAttribute } from '@sequelize/core';
+import { Attribute, Default, HasMany, PrimaryKey, Table } from '@sequelize/core/decorators-legacy';
+import { AdminBaseModel } from './abstract/adminBase.entity.js';
+import { SystemAdmin } from './systemAdmin.entity.js';
+
+//rule规则使用添加接口的校验规则
+@Table({ tableName: 'file', comment: '附件表' })
+export class File extends AdminBaseModel<File> {
+  @Attribute({ type: DataTypes.STRING(20), allowNull: false })
+  @PrimaryKey
+  @Default(uuid)
+  @ApiPropertyRule({ description: 'ID', rule: RuleType.string() })
+  id: string;
+
+  @Attribute({ type: DataTypes.STRING(300), comment: '文件名', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '文件名', rule: RuleType.string().max(300).min(1).required().empty('') })
+  name: string;
+
+  @Attribute({ type: DataTypes.STRING(200), comment: '路径', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '路径', rule: RuleType.string() })
+  path: string;
+
+  @Attribute({ type: DataTypes.STRING(50), comment: 'mime类型', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: 'mime类型', rule: RuleType.string() })
+  mimeType: string;
+
+  @Attribute({ type: DataTypes.INTEGER(), comment: '文件大小(b)' })
+  @ApiPropertyRule({ description: '文件大小', rule: RuleType.number() })
+  size: number;
+
+  @Attribute({ type: DataTypes.STRING(50), comment: '存储引擎', allowNull: false, defaultValue: 'storage' })
+  @ApiPropertyRule({ description: '存储引擎', rule: RuleType.string() })
+  storage: string;
+
+  @Attribute({ type: DataTypes.STRING(32), comment: '文件MD5值', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '文件MD5值', rule: RuleType.string() })
+  md5: string;
+
+  @Attribute(DataTypes.VIRTUAL(DataTypes.STRING, ['storage', 'id', 'name', 'path'])) //增加DataTypes.VIRTUAL可以确保在属性列表中model.get获得到对应属性，并且包含在查询的属性列表中时，此属性用于自动加载依赖项。
+  @ApiPropertyRule({
+    description: '文件url',
+    type: 'string',
+  })
+  get url(): string {
+    return '/api/admin/file/get/' + this.id + '/' + this.name;
+  }
+
+  //为了规避admin和file的循环引用问题，在file声明admin avatar的关联
+  @HasMany(() => SystemAdmin, {
+    foreignKey: 'avatarFileId',
+    inverse: { as: 'avatar' },
+    foreignKeyConstraints: false, //数据库不创建外键，外键应用层解决
+  })
+  declare avatarAdmins?: NonAttribute<SystemAdmin[]>;
+
+  //json转义需要加上url属性，否则创建成功后的返回实体没有对应参数返回
+  toJSON() {
+    return Object.assign(
+      { url: this.url },
+      this.get({
+        plain: true,
+      }),
+    );
+  }
+}