Feat: Role/ProjectMember

.env.development

@@ -1,2 +1,2 @@
 MYSQL_HOST=localhost
-MYSQL_PORT=33066
+MYSQL_PORT=3306

.github/workflows/build-dev.yml

@@ -22,6 +22,7 @@ jobs:
         id: docker_build
         uses: docker/build-push-action@v3
         with:
+          platforms: linux/amd64,linux/arm64
           push: true
           tags: eolinker/eoapi-remote-server:dev
       - name: Image digest

.github/workflows/build-latest.yml

@@ -1,9 +1,9 @@
 name: Build Latest Image
 
 on:
-  release:
-    types:
-      - "published"
+  push:
+  tags:
+    - 'v*.*.*'
 
 env:
   VERSION: ${{ github.ref_name }}

README.md

@@ -1,12 +1,17 @@
+此仓库已归档
+
 # eoapi-remote-server
 
 Eoapi 远程数据源后端服务，部署后即可通过公共数据源实现简单团队协作。
 
-如果你的数据不需要共享，也可以仅下载客户端单机使用。
+如果你的数据不需要共享，也可以仅下载 Eoapi 客户端单机使用。
 
 ## 部署
-请访问 [部署文档](https://docs.eoapi.io/docs/storage.html)
+
+请访问 [部署文档](https://github.com/eolinker/eoapi-remote-server/wiki/%E4%BA%91%E7%AB%AF%E6%9C%8D%E5%8A%A1)
+
 ## 开发
+
 Node.js 版本：^16
 
 如果想提高开发效率，可以安装 NestJS 官方提供的命令行 nestjs/cli 快速生成组件、服务等模板。
@@ -24,10 +29,11 @@ docker-compose run -d --service-ports mysql
 1. 安装依赖
 
 ```bash
-yarn 
+yarn
 ```
 
 2. 运行数据库迁移脚本
+
 ```bash
 yarn migration:run
 ```
@@ -40,8 +46,8 @@ yarn start:dev
 
 ### 运行
 
-| 命令            | 描述       |
-| --------------- | ---------- |
+| 命令                | 描述       |
+| ------------------- | ---------- |
 | `npm run start:dev` | 运行服务器 |
 
 ### 更新数据库

docker-compose.yaml

@@ -4,7 +4,7 @@ services:
   eoapi-remote-server:
     # build: 从当前路径构建镜像
     # build: .
-    image: eolinker/eoapi-remote-server:latest
+    image: eolinker/eoapi-remote-server:dev
     container_name: eoapi-remote-server
     deploy:
       restart_policy:
@@ -35,7 +35,7 @@ services:
       - eoapi_net
 
   eoapi:
-    image: eolinker/eoapi:latest
+    image: eolinker/eoapi:dev
     container_name: eoapi
     deploy:
       restart_policy:
@@ -51,7 +51,7 @@ services:
       - eoapi_net
 
   eoapi-test-server:
-    image: eolinker/eoapi-test-server:latest
+    image: eolinker/eoapi-test-server:dev
     container_name: eoapi-test-server
     deploy:
       restart_policy:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eoapi-remote-server",
-  "version": "1.11.0",
+  "version": "2.0.0",
   "description": "Storage api data in remote server",
   "author": "eoapi",
   "private": true,
@@ -13,9 +13,10 @@
     "start:dev": "rimraf dist && cross-env NODE_ENV=development nest start --watch",
     "start:debug": "nest start --debug --watch",
     "start:prod": "cross-env NODE_ENV=production node dist/src/main.js",
+    "createDatabase": "node ./scripts/auto-create-database.js",
     "migration:create": "npx typeorm-ts-node-commonjs migration:create ./src/migrations/create-table",
     "migration:generate": "node ./scripts/migration-generate.js",
-    "migration:run": "npm run build&&npx typeorm-ts-node-commonjs migration:run -d ./src/config/data-source.ts",
+    "migration:run": "npm run createDatabase && npm run build&&npx typeorm-ts-node-commonjs migration:run -d ./src/config/data-source.ts",
     "migration:revert": "npx typeorm-ts-node-commonjs migration:revert -d ./src/config/data-source.ts",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "typeorm": "npx typeorm-ts-node-commonjs",
@@ -46,6 +47,8 @@
     "class-validator": "^0.13.2",
     "cross-env": "^7.0.3",
     "crypto-js": "^4.1.1",
+    "dayjs": "^1.11.7",
+    "lodash": "^4.17.21",
     "mysql2": "^2.3.3",
     "nanoid": "^3.3.4",
     "passport": "^0.6.0",
@@ -64,6 +67,7 @@
     "@types/crypto-js": "^4.1.1",
     "@types/express": "^4.17.14",
     "@types/jest": "29.2.2",
+    "@types/lodash": "^4.14.191",
     "@types/node": "^18.11.9",
     "@types/passport": "^1.0.11",
     "@types/passport-http": "^0.3.9",

scripts/auto-create-database.js

@@ -0,0 +1,27 @@
+const mysql = require('mysql2');
+const dotenv = require('dotenv');
+dotenv.config();
+
+const con = mysql.createConnection({
+  host: process.env.MYSQL_HOST,
+  port: Number.parseInt(process.env.MYSQL_PORT, 10),
+  user: process.env.MYSQL_USERNAME,
+  password: process.env.MYSQL_PASSWORD || process.env.MYSQL_ROOT_PASSWORD,
+});
+
+con.connect((err) => {
+  if (err) throw err;
+  console.log('Connected!');
+
+  const sql = `CREATE DATABASE if not EXISTS ${process.env.MYSQL_DATABASE} CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci`;
+
+  con.query(sql, (err) => {
+    if (err) {
+      console.log(err.sqlMessage);
+    } else {
+      console.log('Database created');
+    }
+
+    process.exit();
+  });
+});

src/app.module.ts

@@ -1,6 +1,7 @@
 import { Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { ConfigModule, ConfigService } from '@nestjs/config';
+import { APP_GUARD } from '@nestjs/core';
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
 // 引入数据库的及配置文件
@@ -10,6 +11,7 @@ import { getConfiguration } from './config/configuration';
 import { UserModule } from '@/modules/user/user.module';
 import { WorkspaceModule } from '@/modules/workspace/workspace.module';
 import { SharedModule } from '@/shared/shared.module';
+import { JwtAuthGuard } from '@/guards';
 
 console.log('process.env.NODE_ENV', `.env.${process.env.NODE_ENV}`);
 @Module({
@@ -33,14 +35,21 @@ console.log('process.env.NODE_ENV', `.env.${process.env.NODE_ENV}`);
         logging: configService.get('database.logging'),
         timezone: configService.get('database.timezone'), // 时区
       }),
-    }), // 数据库
+    }),
+    // 数据库
     WorkspaceModule,
     SharedModule,
     AuthModule, // 认证
     UserModule,
     ShareDocsModule,
   ],
   controllers: [AppController],
-  providers: [AppService],
+  providers: [
+    AppService,
+    {
+      provide: APP_GUARD,
+      useClass: JwtAuthGuard,
+    },
+  ],
 })
 export class AppModule {}

src/common/decorators/permission.decorator.ts

@@ -0,0 +1,6 @@
+import { SetMetadata } from '@nestjs/common';
+import { PermissionEnum } from '@/enums/permission.enum';
+
+export const PERMISSIONS_KEY = 'permissions';
+export const Permissions = (permissions: PermissionEnum) =>
+  SetMetadata(PERMISSIONS_KEY, permissions);

src/config/data-source.ts

@@ -1,6 +1,7 @@
 import 'reflect-metadata';
 import * as dotenv from 'dotenv';
 import { DataSource } from 'typeorm';
+
 import { getConfiguration } from './configuration';
 dotenv.config();
 

src/entities/base.new.entity.ts

@@ -0,0 +1,70 @@
+import { ApiHideProperty, ApiProperty } from '@nestjs/swagger';
+import {
+  Column,
+  PrimaryGeneratedColumn,
+  CreateDateColumn,
+  UpdateDateColumn,
+  DeleteDateColumn,
+  Generated,
+} from 'typeorm';
+import { Exclude, Transform } from 'class-transformer';
+import dayjs from 'dayjs';
+
+export class BaseTimestampEntity {
+  @ApiProperty({ type: Date, description: '创建时间' })
+  @Transform(({ value }) => dayjs(value).format('YYYY-MM-DD HH:mm:ss'), {
+    toPlainOnly: true,
+  })
+  @CreateDateColumn({
+    type: 'datetime',
+    nullable: false,
+    name: 'created_at',
+    comment: '创建时间',
+  })
+  createdAt: Date | null;
+
+  @ApiProperty({ type: Date, description: '更新时间' })
+  @UpdateDateColumn({
+    type: 'datetime',
+    name: 'updated_at',
+    comment: '更新时间',
+  })
+  @Transform(({ value }) => dayjs(value).format('YYYY-MM-DD HH:mm:ss'), {
+    toPlainOnly: true,
+  })
+  updatedAt: Date | null;
+
+  @Exclude()
+  @DeleteDateColumn({
+    type: 'datetime',
+    name: 'deleted_at',
+    select: false,
+    comment: '删除时间',
+  })
+  @Transform(({ value }) => dayjs(value).format('YYYY-MM-DD HH:mm:ss'), {
+    toPlainOnly: true,
+  })
+  deletedAt: Date;
+}
+
+export class BaseGeneratedEntity extends BaseTimestampEntity {
+  @ApiHideProperty()
+  @Exclude()
+  @PrimaryGeneratedColumn({ name: 'id', comment: '主键ID' })
+  id: number;
+
+  @ApiProperty({ type: String, description: 'uuid' })
+  @Column({ comment: '业务 UUID' })
+  @Generated('uuid')
+  uuid: string;
+}
+
+export class BaseEntity extends BaseGeneratedEntity {
+  @ApiProperty({ type: Number, description: '创建者' })
+  @Column('bigint', { name: 'create_by', nullable: true, comment: '创建者' })
+  createBy: number | null;
+
+  @ApiProperty({ type: Number, description: '更新者' })
+  @Column('bigint', { name: 'update_by', nullable: true, comment: '更新者' })
+  updateBy: number | null;
+}

src/entities/permission.entity.ts

@@ -0,0 +1,19 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Column, Entity } from 'typeorm';
+import { BaseEntity } from './base.new.entity';
+
+@Entity({ name: 'permission' })
+export class PermissionEntity extends BaseEntity {
+  @ApiProperty({ type: String, description: '权限名称' })
+  @Column({ type: 'varchar', unique: true, length: 120, comment: '权限名称' })
+  name: string;
+
+  @ApiProperty({ type: Number, description: '权限状态' })
+  @Column({
+    type: 'tinyint',
+    width: 1,
+    default: 1,
+    comment: '状态：0=禁用 1=启用',
+  })
+  status: number;
+}

src/entities/project-user-role.entity.ts

@@ -0,0 +1,22 @@
+import { Column, Entity } from 'typeorm';
+import { BaseEntity } from './base.new.entity';
+
+@Entity({ name: 'project_user_role' })
+export class ProjectUserRoleEntity extends BaseEntity {
+  @Column({
+    name: 'project_id',
+    type: 'int',
+    comment: '项目ID',
+  })
+  projectID: number;
+
+  @Column({
+    name: 'user_id',
+    type: 'int',
+    comment: '用户ID',
+  })
+  userID: number;
+
+  @Column({ name: 'role_id', type: 'int', comment: '角色ID' })
+  roleID: number;
+}

src/entities/role-permission.entity.ts

@@ -0,0 +1,15 @@
+import { Column, Entity } from 'typeorm';
+import { BaseEntity } from './base.new.entity';
+
+@Entity({ name: 'role_permission' })
+export class RolePermissionEntity extends BaseEntity {
+  @Column({ type: 'int', name: 'role_id', unsigned: true, comment: '角色ID' })
+  roleID: number;
+
+  @Column({
+    type: 'int',
+    name: 'permission_id',
+    comment: '权限ID',
+  })
+  permissionID: number;
+}

src/entities/role.entity.ts

@@ -0,0 +1,23 @@
+import { Column, Entity } from 'typeorm';
+import { BaseEntity } from './base.new.entity';
+
+@Entity({ name: 'role' })
+export class RoleEntity extends BaseEntity {
+  @Column({
+    type: 'varchar',
+    length: 50,
+    comment: '角色名称',
+  })
+  name: string;
+
+  @Column({
+    type: 'tinyint',
+    width: 1,
+    unsigned: true,
+    comment: '角色类别: 1=空间 2=项目',
+  })
+  module: number;
+
+  @Column({ type: 'varchar', length: 200, default: '', comment: '角色备注' })
+  remark: string;
+}

src/entities/workspace-user-role.entity.ts

@@ -0,0 +1,22 @@
+import { Column, Entity } from 'typeorm';
+import { BaseEntity } from './base.new.entity';
+
+@Entity({ name: 'workspace_user_role' })
+export class WorkspaceUserRoleEntity extends BaseEntity {
+  @Column({
+    name: 'workspace_id',
+    type: 'int',
+    comment: '空间ID',
+  })
+  workspaceID: number;
+
+  @Column({
+    name: 'user_id',
+    type: 'int',
+    comment: '用户ID',
+  })
+  userID: number;
+
+  @Column({ name: 'role_id', type: 'int', comment: '角色ID' })
+  roleID: number;
+}