@svton/cli 1.2.0 → 1.2.2

package/templates/apps/backend/src/object-storage/object-storage.controller.ts

@@ -0,0 +1,114 @@
+import {
+  Controller,
+  Post,
+  Get,
+  Query,
+  Req,
+  UnauthorizedException,
+  BadRequestException,
+  Logger,
+} from '@nestjs/common';
+import { ApiTags, ApiOperation, ApiBearerAuth } from '@nestjs/swagger';
+import { Request } from 'express';
+// import { InjectObjectStorage, ObjectStorageClient } from '@svton/nestjs-object-storage';
+
+/**
+ * 对象存储控制器示例
+ * 演示如何使用 @svton/nestjs-object-storage 进行文件上传和回调验签
+ *
+ * 使用前请先：
+ * 1. 安装依赖：pnpm add @svton/nestjs-object-storage @svton/nestjs-object-storage-qiniu-kodo
+ * 2. 在 AppModule 中启用 ObjectStorageModule
+ * 3. 配置环境变量
+ */
+@ApiTags('对象存储')
+@Controller('object-storage')
+export class ObjectStorageController {
+  private readonly logger = new Logger(ObjectStorageController.name);
+
+  // constructor(
+  //   @InjectObjectStorage() private readonly storage: ObjectStorageClient,
+  // ) {}
+
+  /**
+   * 获取上传预签名 URL
+   * 前端使用此 URL 直接上传文件到云存储
+   */
+  @ApiBearerAuth()
+  @Get('presign')
+  @ApiOperation({ summary: '获取上传预签名 URL' })
+  async getPresignedUrl(
+    @Query('key') key: string,
+    @Query('contentType') contentType?: string,
+  ) {
+    if (!key) {
+      throw new BadRequestException('key is required');
+    }
+
+    // 示例代码（启用 ObjectStorageModule 后取消注释）
+    // const result = await this.storage.presign({
+    //   key,
+    //   method: 'PUT',
+    //   expiresIn: 3600,
+    //   contentType,
+    //   callback: {
+    //     url: 'https://your-domain.com/object-storage/callback',
+    //     body: 'key=$(key)&hash=$(etag)&bucket=$(bucket)&fsize=$(fsize)',
+    //   },
+    // });
+    // return result;
+
+    return {
+      message: 'ObjectStorageModule not enabled. See app.module.ts for setup instructions.',
+    };
+  }
+
+  /**
+   * 对象存储回调接口
+   * 云存储上传完成后会调用此接口进行通知
+   *
+   * 注意：需要配置 raw body 中间件才能正确验签
+   * 参见 main.ts 中的 rawBody 配置
+   */
+  @Post('callback')
+  @ApiOperation({ summary: '对象存储回调（云存储调用）' })
+  async handleCallback(@Req() req: Request) {
+    // 获取 rawBody（需要在 main.ts 中配置）
+    const rawBody = (req as Request & { rawBody?: Buffer }).rawBody;
+
+    if (!rawBody) {
+      this.logger.warn('rawBody not available. Please configure raw body middleware.');
+      throw new BadRequestException('rawBody not available');
+    }
+
+    // 示例代码（启用 ObjectStorageModule 后取消注释）
+    // const result = await this.storage.verifyCallback({
+    //   method: req.method,
+    //   path: req.path,
+    //   query: req.query as Record<string, string | string[]>,
+    //   headers: req.headers as Record<string, string | string[]>,
+    //   rawBody,
+    // });
+
+    // if (!result.isValid) {
+    //   this.logger.warn('Invalid callback signature');
+    //   throw new UnauthorizedException('Invalid callback signature');
+    // }
+
+    // this.logger.log(`File uploaded: ${result.key}, size: ${result.size}`);
+
+    // // 在这里处理业务逻辑，例如：
+    // // - 保存文件记录到数据库
+    // // - 触发后续处理（如图片压缩、视频转码等）
+
+    // return {
+    //   success: true,
+    //   key: result.key,
+    //   etag: result.etag,
+    // };
+
+    return {
+      message: 'ObjectStorageModule not enabled. See app.module.ts for setup instructions.',
+    };
+  }
+}

package/templates/apps/backend/src/object-storage/object-storage.module.ts

@@ -0,0 +1,7 @@
+import { Module } from '@nestjs/common';
+import { ObjectStorageController } from './object-storage.controller';
+
+@Module({
+  controllers: [ObjectStorageController],
+})
+export class ObjectStorageExampleModule {}

package/templates/apps/backend/src/prisma/prisma.module.ts

@@ -0,0 +1,9 @@
+import { Global, Module } from '@nestjs/common';
+import { PrismaService } from './prisma.service';
+
+@Global()
+@Module({
+  providers: [PrismaService],
+  exports: [PrismaService],
+})
+export class PrismaModule {}

package/templates/apps/backend/src/prisma/prisma.service.ts

@@ -0,0 +1,13 @@
+import { Injectable, OnModuleInit, OnModuleDestroy } from '@nestjs/common';
+import { PrismaClient } from '@prisma/client';
+
+@Injectable()
+export class PrismaService extends PrismaClient implements OnModuleInit, OnModuleDestroy {
+  async onModuleInit() {
+    await this.$connect();
+  }
+
+  async onModuleDestroy() {
+    await this.$disconnect();
+  }
+}

package/templates/apps/backend/src/user/user.controller.ts

@@ -0,0 +1,50 @@
+import {
+  Controller,
+  Get,
+  Put,
+  Delete,
+  Body,
+  Param,
+  Query,
+  UseGuards,
+  ParseIntPipe,
+} from '@nestjs/common';
+import { ApiTags, ApiOperation, ApiBearerAuth } from '@nestjs/swagger';
+import { UserService } from './user.service';
+import { JwtAuthGuard } from '../auth/jwt-auth.guard';
+import type { UserListParams, UpdateUserDto } from '{{ORG_NAME}}/types';
+
+@ApiTags('用户管理')
+@Controller('users')
+@UseGuards(JwtAuthGuard)
+@ApiBearerAuth()
+export class UserController {
+  constructor(private userService: UserService) {}
+
+  @Get()
+  @ApiOperation({ summary: '获取用户列表' })
+  async findAll(@Query() params: UserListParams) {
+    return this.userService.findAll(params);
+  }
+
+  @Get(':id')
+  @ApiOperation({ summary: '获取用户详情' })
+  async findOne(@Param('id', ParseIntPipe) id: number) {
+    return this.userService.findOne(id);
+  }
+
+  @Put(':id')
+  @ApiOperation({ summary: '更新用户' })
+  async update(
+    @Param('id', ParseIntPipe) id: number,
+    @Body() dto: UpdateUserDto,
+  ) {
+    return this.userService.update(id, dto);
+  }
+
+  @Delete(':id')
+  @ApiOperation({ summary: '删除用户' })
+  async remove(@Param('id', ParseIntPipe) id: number) {
+    return this.userService.remove(id);
+  }
+}

package/templates/apps/backend/src/user/user.module.ts

@@ -0,0 +1,12 @@
+import { Module } from '@nestjs/common';
+import { UserController } from './user.controller';
+import { UserService } from './user.service';
+import { PrismaModule } from '../prisma/prisma.module';
+
+@Module({
+  imports: [PrismaModule],
+  controllers: [UserController],
+  providers: [UserService],
+  exports: [UserService],
+})
+export class UserModule {}

package/templates/apps/backend/src/user/user.service.ts

@@ -0,0 +1,117 @@
+import { Injectable, NotFoundException } from '@nestjs/common';
+import { PrismaService } from '../prisma/prisma.service';
+import type { UserListParams, UpdateUserDto, PaginatedResponse, UserVo } from '{{ORG_NAME}}/types';
+
+@Injectable()
+export class UserService {
+  constructor(private prisma: PrismaService) {}
+
+  async findAll(params: UserListParams): Promise<PaginatedResponse<UserVo>> {
+    const { page = 1, pageSize = 10, keyword, role, status } = params;
+    const skip = (page - 1) * pageSize;
+
+    const where: any = {};
+    if (keyword) {
+      where.OR = [
+        { phone: { contains: keyword } },
+        { nickname: { contains: keyword } },
+      ];
+    }
+    if (role) where.role = role;
+    if (status !== undefined) where.status = status;
+
+    const [list, total] = await Promise.all([
+      this.prisma.user.findMany({
+        where,
+        skip,
+        take: pageSize,
+        orderBy: { createdAt: 'desc' },
+        select: {
+          id: true,
+          phone: true,
+          nickname: true,
+          avatar: true,
+          role: true,
+          status: true,
+          createdAt: true,
+          updatedAt: true,
+        },
+      }),
+      this.prisma.user.count({ where }),
+    ]);
+
+    return {
+      list: list.map((u) => ({
+        ...u,
+        role: u.role as any,
+        status: u.status as any,
+        createdAt: u.createdAt.toISOString(),
+        updatedAt: u.updatedAt.toISOString(),
+      })),
+      total,
+      page,
+      pageSize,
+      totalPages: Math.ceil(total / pageSize),
+    };
+  }
+
+  async findOne(id: number): Promise<UserVo> {
+    const user = await this.prisma.user.findUnique({
+      where: { id },
+      select: {
+        id: true,
+        phone: true,
+        nickname: true,
+        avatar: true,
+        role: true,
+        status: true,
+        createdAt: true,
+        updatedAt: true,
+      },
+    });
+
+    if (!user) {
+      throw new NotFoundException('用户不存在');
+    }
+
+    return {
+      ...user,
+      role: user.role as any,
+      status: user.status as any,
+      createdAt: user.createdAt.toISOString(),
+      updatedAt: user.updatedAt.toISOString(),
+    };
+  }
+
+  async update(id: number, dto: UpdateUserDto): Promise<UserVo> {
+    await this.findOne(id);
+
+    const user = await this.prisma.user.update({
+      where: { id },
+      data: dto,
+      select: {
+        id: true,
+        phone: true,
+        nickname: true,
+        avatar: true,
+        role: true,
+        status: true,
+        createdAt: true,
+        updatedAt: true,
+      },
+    });
+
+    return {
+      ...user,
+      role: user.role as any,
+      status: user.status as any,
+      createdAt: user.createdAt.toISOString(),
+      updatedAt: user.updatedAt.toISOString(),
+    };
+  }
+
+  async remove(id: number): Promise<void> {
+    await this.findOne(id);
+    await this.prisma.user.delete({ where: { id } });
+  }
+}

package/templates/apps/backend/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2021",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": true,
+    "noImplicitAny": true,
+    "strictBindCallApply": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true
+  }
+}

package/templates/apps/mobile/babel.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  presets: [
+    ['taro', {
+      framework: 'react',
+      ts: true,
+    }],
+  ],
+};

package/templates/apps/mobile/config/index.ts

@@ -0,0 +1,65 @@
+import type { UserConfigExport } from '@tarojs/cli';
+
+export default {
+  projectName: 'mobile',
+  date: '2024-1-1',
+  designWidth: 750,
+  deviceRatio: {
+    640: 2.34 / 2,
+    750: 1,
+    828: 1.81 / 2,
+  },
+  sourceRoot: 'src',
+  outputRoot: 'dist',
+  plugins: [],
+  defineConstants: {},
+  copy: {
+    patterns: [],
+    options: {},
+  },
+  framework: 'react',
+  compiler: {
+    type: 'webpack5',
+    prebundle: {
+      enable: false,
+    },
+  },
+  mini: {
+    postcss: {
+      pxtransform: {
+        enable: true,
+        config: {},
+      },
+      url: {
+        enable: true,
+        config: {
+          limit: 1024,
+        },
+      },
+      cssModules: {
+        enable: false,
+        config: {
+          namingPattern: 'module',
+          generateScopedName: '[name]__[local]___[hash:base64:5]',
+        },
+      },
+    },
+  },
+  h5: {
+    publicPath: '/',
+    staticDirectory: 'static',
+    postcss: {
+      autoprefixer: {
+        enable: true,
+        config: {},
+      },
+      cssModules: {
+        enable: false,
+        config: {
+          namingPattern: 'module',
+          generateScopedName: '[name]__[local]___[hash:base64:5]',
+        },
+      },
+    },
+  },
+} satisfies UserConfigExport;

package/templates/apps/mobile/package.json.tpl

@@ -0,0 +1,48 @@
+{
+  "name": "{{ORG_NAME}}/mobile",
+  "version": "1.0.0",
+  "description": "{{PROJECT_NAME}} 移动端小程序",
+  "private": true,
+  "templateInfo": {
+    "name": "default",
+    "typescript": true,
+    "css": "sass"
+  },
+  "scripts": {
+    "build:weapp": "taro build --type weapp",
+    "dev": "npm run dev:weapp",
+    "dev:weapp": "npm run build:weapp -- --watch",
+    "dev:h5": "taro build --type h5 --watch",
+    "lint": "eslint \"src/**/*.{ts,tsx}\"",
+    "type-check": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.23.6",
+    "@svton/api-client": "^1.0.0",
+    "@svton/hooks": "^1.0.0",
+    "@svton/taro-ui": "^1.0.0",
+    "{{ORG_NAME}}/types": "workspace:*",
+    "@tarojs/components": "3.6.23",
+    "@tarojs/helper": "3.6.23",
+    "@tarojs/plugin-framework-react": "3.6.23",
+    "@tarojs/plugin-platform-weapp": "3.6.23",
+    "@tarojs/react": "3.6.23",
+    "@tarojs/runtime": "3.6.23",
+    "@tarojs/taro": "3.6.23",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "zustand": "^4.4.7"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.23.6",
+    "@tarojs/cli": "3.6.23",
+    "@tarojs/webpack5-runner": "3.6.23",
+    "@types/react": "^18.2.45",
+    "@typescript-eslint/eslint-plugin": "^6.15.0",
+    "@typescript-eslint/parser": "^6.15.0",
+    "babel-preset-taro": "3.6.23",
+    "eslint": "^8.56.0",
+    "eslint-config-taro": "3.6.23",
+    "typescript": "^5.3.3"
+  }
+}

package/templates/apps/mobile/project.config.json.tpl

@@ -0,0 +1,17 @@
+{
+  "miniprogramRoot": "dist/",
+  "projectname": "{{PROJECT_NAME}}",
+  "description": "{{PROJECT_NAME}} 小程序",
+  "appid": "",
+  "setting": {
+    "urlCheck": true,
+    "es6": false,
+    "enhance": false,
+    "compileHotReLoad": false,
+    "postcss": false,
+    "minified": false,
+    "bundle": false,
+    "nodeModules": false
+  },
+  "compileType": "miniprogram"
+}

package/templates/apps/mobile/src/app.config.ts

@@ -0,0 +1,9 @@
+export default defineAppConfig({
+  pages: ['pages/index/index'],
+  window: {
+    backgroundTextStyle: 'light',
+    navigationBarBackgroundColor: '#fff',
+    navigationBarTitleText: '首页',
+    navigationBarTextStyle: 'black',
+  },
+});

package/templates/apps/mobile/src/app.scss

@@ -0,0 +1,4 @@
+page {
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
+  background-color: #f5f5f5;
+}

package/templates/apps/mobile/src/app.ts

@@ -0,0 +1,8 @@
+import { PropsWithChildren } from 'react';
+import './app.scss';
+
+function App({ children }: PropsWithChildren) {
+  return children;
+}
+
+export default App;