feat: 支持 NestJS 后端

packages/cli/commands/src/version.ts

@@ -24,7 +24,7 @@ export default async function () {
   if (toolkitName) {
     try {
       const pkgPath = path.join(home.getModulesPath(), toolkitName, 'package.json');
-      log.debug(`${toolkitName} pacage.json path = ${pkgPath}`);
+      log.debug(`${toolkitName} package.json path = ${pkgPath}`);
       const pkg = require(pkgPath);
       console.log(chalk.magenta(`${toolkitName} v${pkg.version}`));
     } catch (e) {

packages/toolkits/pro/template/server/nestJs/.env

@@ -0,0 +1,9 @@
+DATABASE_HOST = 'localhost'
+DATABASE_PORT = 3306
+DATABASE_USERNAME = 'root'
+DATABASE_PASSWORD = 'root'
+DATABASE_NAME = 'ospp-nest'
+DATABASE_SYNCHRONIZE = 'true'
+DATABASE_AUTOLOADENTITIES = 'true'
+
+AUTH_SECRET = 'secret'

packages/toolkits/pro/template/server/nestJs/.gitignore

@@ -18,4 +18,4 @@ npm-debug.log
 /.nyc_output
 
 # dist
-/dist
+/dist

packages/toolkits/pro/template/server/nestJs/libs/config/config.module.ts

@@ -0,0 +1,14 @@
+import { Module } from '@nestjs/common';
+import { ConfigService } from './config.service';
+
+@Module({
+  providers: [
+    {
+      provide: ConfigService,
+      // 刚刚的ConfigService要传入.env路径及文件名
+      useValue: new ConfigService(`.env`),
+    },
+  ],
+  exports: [ConfigService],
+})
+export class ConfigModule {}

packages/toolkits/pro/template/server/nestJs/libs/config/config.service.spec.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { ConfigService } from './config.service';
+
+describe('ConfigService', () => {
+  let service: ConfigService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [ConfigService],
+    }).compile();
+
+    service = module.get<ConfigService>(ConfigService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});

packages/toolkits/pro/template/server/nestJs/libs/config/config.service.ts

@@ -0,0 +1,18 @@
+import { Injectable, Logger } from '@nestjs/common';
+import * as dotenv from 'dotenv';
+import * as fs from 'fs';
+
+@Injectable()
+export class ConfigService {
+  private envConfig: { [key: string]: string };
+
+  constructor(filePath: string) {
+    // 读取.env文件，通过dotenv.parse方法形成key-value pairs
+    // 存在envConfig变量里
+    this.envConfig = dotenv.parse(fs.readFileSync(filePath));
+  }
+
+  get(key: string) {
+    return this.envConfig[key];
+  }
+}

packages/toolkits/pro/template/server/nestJs/libs/db/src/db.module.ts

@@ -0,0 +1,19 @@
+import { Module } from '@nestjs/common';
+import { DbService } from './db.service';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { ConfigService } from '../../config/config.service';
+import { ConfigModule } from '../../config/config.module';
+
+@Module({
+  imports: [
+    TypeOrmModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useClass: DbService,
+    }),
+    ConfigModule,
+  ],
+  providers: [DbService],
+  exports: [DbService],
+})
+export class DbModule {}

packages/toolkits/pro/template/server/nestJs/libs/db/src/db.service.spec.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { DbService } from './db.service';
+
+describe('DbService', () => {
+  let service: DbService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [DbService],
+    }).compile();
+
+    service = module.get<DbService>(DbService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});

packages/toolkits/pro/template/server/nestJs/libs/db/src/db.service.ts

@@ -0,0 +1,23 @@
+import { Injectable } from '@nestjs/common';
+import { TypeOrmModuleOptions, TypeOrmOptionsFactory } from '@nestjs/typeorm';
+import { ConfigService } from '../../config/config.service';
+
+@Injectable()
+export class DbService implements TypeOrmOptionsFactory {
+  // 注入config service取得env变量
+  constructor(private readonly configService: ConfigService) {}
+  // 回传TypeOrmOptions对象
+  createTypeOrmOptions(): TypeOrmModuleOptions {
+    return {
+      type: 'mysql',
+      host: this.configService.get('DATABASE_HOST'),
+      port: parseInt(this.configService.get('DATABASE_PORT')),
+      username: this.configService.get('DATABASE_USERNAME'),
+      password: this.configService.get('DATABASE_PASSWORD'),
+      database: this.configService.get('DATABASE_NAME'),
+      synchronize: this.configService.get('DATABASE_SYNCHRONIZE') === 'true',
+      autoLoadEntities:
+        this.configService.get('DATABASE_AUTOLOADENTITIES') === 'true',
+    };
+  }
+}

packages/toolkits/pro/template/server/nestJs/libs/db/src/index.ts

@@ -0,0 +1,2 @@
+export * from './db.module';
+export * from './db.service';

packages/toolkits/pro/template/server/nestJs/libs/db/tsconfig.lib.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "../../dist/libs/db"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+}

packages/toolkits/pro/template/server/nestJs/libs/models/src/index.ts

@@ -0,0 +1,4 @@
+export * from './user';
+export * from './permission';
+export * from './role';
+export * from './menu';

packages/toolkits/pro/template/server/nestJs/libs/models/src/menu.ts

@@ -0,0 +1,21 @@
+import { Column, Entity, PrimaryGeneratedColumn } from 'typeorm';
+
+@Entity('menu')
+export class Menu {
+  @PrimaryGeneratedColumn()
+  id: number;
+  @Column()
+  name: string;
+  @Column()
+  order: number;
+  @Column({ nullable: true })
+  parentId: number;
+  @Column()
+  menuType: string;
+  @Column({ nullable: true })
+  icon: string;
+  @Column()
+  component: string;
+  @Column()
+  path: string;
+}

packages/toolkits/pro/template/server/nestJs/libs/models/src/permission.ts

@@ -0,0 +1,11 @@
+import { Column, Entity, PrimaryGeneratedColumn } from 'typeorm';
+
+@Entity('permission')
+export class Permission {
+  @PrimaryGeneratedColumn()
+  id: number;
+  @Column()
+  desc: string;
+  @Column()
+  name: string;
+}

packages/toolkits/pro/template/server/nestJs/libs/models/src/role.ts

@@ -0,0 +1,26 @@
+import {
+  Column,
+  Entity,
+  JoinTable,
+  ManyToMany,
+  PrimaryGeneratedColumn,
+} from 'typeorm';
+import { Permission } from './permission';
+import { Menu } from './menu';
+
+@Entity('role')
+export class Role {
+  @PrimaryGeneratedColumn()
+  id: number;
+  @Column()
+  name: string;
+  @ManyToMany(() => Permission, {
+    onUpdate: 'CASCADE',
+  })
+  @JoinTable({ name: 'role_permission' })
+  permission: Permission[];
+
+  @ManyToMany(() => Menu)
+  @JoinTable({ name: 'role_menu' })
+  menus: Menu[];
+}

packages/toolkits/pro/template/server/nestJs/libs/models/src/user.ts

@@ -0,0 +1,49 @@
+import {
+  BeforeInsert,
+  Column,
+  CreateDateColumn,
+  DeleteDateColumn,
+  Entity,
+  JoinTable,
+  ManyToMany,
+  PrimaryColumn,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+} from 'typeorm';
+import { Role } from './role';
+import * as crypto from 'crypto';
+
+export const encry = (value: string, salt: string) =>
+  crypto.pbkdf2Sync(value, salt, 1000, 18, 'sha256').toString('hex');
+
+@Entity('user')
+export class User {
+  @PrimaryGeneratedColumn()
+  id: number;
+  @Column()
+  name: string;
+  @Column()
+  email: string;
+  @Column()
+  password: string;
+  @ManyToMany(() => Role)
+  @JoinTable({ name: 'user_role' })
+  role: Role[];
+  @CreateDateColumn()
+  createTime: Date;
+  @UpdateDateColumn()
+  updateTime: Date;
+  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
+  create_time: Date;
+  @Column({ nullable: true })
+  salt: string;
+  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
+  update_time: Date;
+  @DeleteDateColumn()
+  deleteAt: Date;
+  @BeforeInsert()
+  beforeInsert() {
+    this.salt = crypto.randomBytes(4).toString('base64');
+    this.password = encry(this.password, this.salt);
+  }
+}

packages/toolkits/pro/template/server/nestJs/libs/models/tsconfig.lib.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "../../dist/libs/models"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+}

packages/toolkits/pro/template/server/nestJs/nest-cli.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true,
+    "webpack": true
+  },
+  "projects": {
+    "db": {
+      "type": "library",
+      "root": "libs/db",
+      "entryFile": "index",
+      "sourceRoot": "libs/db/src",
+      "compilerOptions": {
+        "tsConfigPath": "libs/db/tsconfig.lib.json"
+      }
+    },
+    "models": {
+      "type": "library",
+      "root": "libs/models",
+      "entryFile": "index",
+      "sourceRoot": "libs/models/src",
+      "compilerOptions": {
+        "tsConfigPath": "libs/models/tsconfig.lib.json"
+      }
+    }
+  }
+}

packages/toolkits/pro/template/server/nestJs/package.json

@@ -20,15 +20,24 @@
   },
   "dependencies": {
     "@nestjs/common": "10.0.3",
+    "@nestjs/config": "^3.2.3",
     "@nestjs/core": "10.0.3",
+    "@nestjs/jwt": "^10.2.0",
+    "@nestjs/mapped-types": "*",
     "@nestjs/platform-express": "10.0.3",
     "@nestjs/sequelize": "10.0.0",
+    "@nestjs/typeorm": "^10.0.2",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
+    "dotenv": "^16.4.5",
     "mysql2": "3.4.3",
+    "pg": "^8.12.0",
     "reflect-metadata": "0.1.13",
     "rimraf": "5.0.1",
     "rxjs": "7.8.1",
     "sequelize": "6.32.1",
     "sequelize-typescript": "2.1.5",
+    "typeorm": "^0.3.20",
     "typescript": "5.1.6"
   },
   "devDependencies": {
@@ -46,6 +55,7 @@
     "eslint-plugin-import": "2.27.5",
     "jest": "29.6.1",
     "prettier": "2.8.8",
+    "source-map-support": "^0.5.20",
     "supertest": "6.3.3",
     "ts-jest": "29.1.1",
     "ts-loader": "9.4.4",

packages/toolkits/pro/template/server/nestJs/src/app.controller.spec.ts

@@ -0,0 +1,22 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+describe('AppController', () => {
+  let appController: AppController;
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      controllers: [AppController],
+      providers: [AppService],
+    }).compile();
+
+    appController = app.get<AppController>(AppController);
+  });
+
+  describe('root', () => {
+    it('should return "Hello World!"', () => {
+      expect(appController.getHello()).toBe('Hello World!');
+    });
+  });
+});

packages/toolkits/pro/template/server/nestJs/src/app.controller.ts

@@ -0,0 +1,12 @@
+import { Controller, Get } from '@nestjs/common';
+import { AppService } from './app.service';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get()
+  getHello(): string {
+    return this.appService.getHello();
+  }
+}