@svton/cli 1.2.1 → 1.2.2

package/templates/skills/authz.skill.md

@@ -0,0 +1,42 @@
+# 权限控制使用指南
+
+本项目已集成 `@svton/nestjs-authz` 权限控制模块，实现 RBAC 权限管理。
+
+## 已安装的包
+
+- `@svton/nestjs-authz` - 权限控制模块
+
+## 配置文件
+
+- `src/config/authz.config.ts` - 权限配置
+
+## 示例代码位置
+
+查看 `src/examples/authz/` 目录获取完整示例。
+
+## 核心装饰器
+
+### @Roles - 角色权限
+
+```typescript
+@Roles('admin')
+@Get('admin')
+async adminOnly() {
+  return { message: 'Admin only' };
+}
+```
+
+### @Permissions - 细粒度权限
+
+```typescript
+@Permissions('user:delete')
+@Delete(':id')
+async delete(@Param('id') id: string) {
+  // 删除用户
+}
+```
+
+## 文档链接
+
+- 官方文档：https://751848178.github.io/svton/packages/nestjs-authz
+- 示例代码：`src/examples/authz/`

package/templates/skills/base.skill.md

@@ -0,0 +1,57 @@
+# 项目能力索引
+
+本项目基于 Svton 全栈框架创建，这是一个企业级 Monorepo 架构。
+
+## 项目结构
+
+```
+src/
+├── config/          # 配置文件
+├── examples/        # 功能示例代码
+├── modules/         # 业务模块
+└── main.ts          # 应用入口
+```
+
+## 核心能力
+
+本项目已集成以下功能模块，每个模块都有对应的 skill 文档和示例代码。
+
+### 查看功能文档
+
+- 查看 `.kiro/skills/` 目录下的各个功能 skill 文档
+- 查看 `src/examples/` 目录下的示例代码
+- 查看 `src/config/` 目录下的配置文件
+
+## 开发建议
+
+当你需要使用某个功能时：
+
+1. 查看对应的 skill 文档了解 API 和最佳实践
+2. 参考 `src/examples/` 目录下的示例代码
+3. 根据需要修改 `src/config/` 中的配置
+4. 查看官方文档获取更多信息
+
+## 环境配置
+
+项目使用 `.env` 文件管理环境变量，请参考 `.env.example` 文件配置必要的环境变量。
+
+## 文档资源
+
+- Svton 官方文档：https://751848178.github.io/svton
+- GitHub：https://github.com/751848178/svton
+
+## 常用命令
+
+```bash
+# 开发模式
+pnpm dev
+
+# 构建
+pnpm build
+
+# 启动生产环境
+pnpm start
+
+# 运行测试
+pnpm test
+```

package/templates/skills/cache.skill.md

@@ -0,0 +1,88 @@
+# 缓存功能使用指南
+
+本项目已集成 `@svton/nestjs-cache` 缓存模块，提供声明式缓存能力。
+
+## 已安装的包
+
+- `@svton/nestjs-cache` - 缓存装饰器模块
+- `@svton/nestjs-redis` - Redis 连接模块
+
+## 配置文件
+
+- `src/config/cache.config.ts` - 缓存配置
+- `.env` - 环境变量配置（REDIS_HOST, REDIS_PORT, REDIS_PASSWORD）
+
+## 示例代码位置
+
+查看 `src/examples/cache/` 目录获取完整示例：
+- `user.service.ts` - Service 层缓存使用
+- `user.controller.ts` - Controller 层使用
+- `README.md` - 详细说明文档
+
+## 核心装饰器
+
+### @Cacheable - 缓存查询结果
+
+```typescript
+@Cacheable({ key: 'user:#id', ttl: 3600 })
+async findOne(id: number) {
+  return this.prisma.user.findUnique({ where: { id } });
+}
+```
+
+### @CacheEvict - 清除缓存
+
+```typescript
+@CacheEvict({ key: 'user:#id' })
+async update(id: number, data: UpdateUserDto) {
+  return this.prisma.user.update({ where: { id }, data });
+}
+```
+
+### @CachePut - 更新缓存
+
+```typescript
+@CachePut({ key: 'user:#id' })
+async updateAndRefresh(id: number, data: UpdateUserDto) {
+  return this.prisma.user.update({ where: { id }, data });
+}
+```
+
+## Key 表达式规则
+
+- `#id` - 从 request.params 获取
+- `#0`, `#1` - 位置参数
+- `#paramName` - 参数名
+- `#body.field` - 从 request.body 获取
+
+## 最佳实践
+
+1. **合理设置 TTL**：根据数据更新频率设置过期时间
+2. **及时清除缓存**：更新/删除操作使用 @CacheEvict
+3. **避免缓存穿透**：对空结果也进行缓存
+4. **使用命名空间**：key 前缀区分不同业务
+
+## 常见场景
+
+### 用户信息缓存
+```typescript
+@Cacheable({ key: 'user:#id', ttl: 3600 })
+async getUserById(id: number) { }
+```
+
+### 列表查询缓存
+```typescript
+@Cacheable({ key: 'users:list:#page:#pageSize', ttl: 300 })
+async getUsers(page: number, pageSize: number) { }
+```
+
+### 批量清除缓存
+```typescript
+@CacheEvict({ key: 'users:*', pattern: true })
+async clearAllUserCache() { }
+```
+
+## 文档链接
+
+- 官方文档：https://751848178.github.io/svton/packages/nestjs-cache
+- 示例代码：`src/examples/cache/`

package/templates/skills/oauth.skill.md

@@ -0,0 +1,41 @@
+# OAuth 登录使用指南
+
+本项目已集成 `@svton/nestjs-oauth` OAuth 登录模块，支持微信登录。
+
+## 已安装的包
+
+- `@svton/nestjs-oauth` - OAuth 登录模块
+
+## 配置文件
+
+- `src/config/oauth.config.ts` - OAuth 配置
+- `.env` - 环境变量配置
+
+## 示例代码位置
+
+查看 `src/examples/oauth/` 目录获取完整示例。
+
+## 支持的登录方式
+
+- 微信开放平台（PC 扫码登录）
+- 微信公众号（网页授权）
+- 微信小程序（code2Session）
+
+## 核心 API
+
+### 获取授权 URL
+
+```typescript
+const url = this.oauthService.wechat.getAuthorizationUrl('open', state);
+```
+
+### 小程序登录
+
+```typescript
+const result = await this.oauthService.wechat.code2Session(code);
+```
+
+## 文档链接
+
+- 官方文档：https://751848178.github.io/svton/packages/nestjs-oauth
+- 示例代码：`src/examples/oauth/`

package/templates/skills/payment.skill.md

@@ -0,0 +1,129 @@
+# 支付功能使用指南
+
+本项目已集成 `@svton/nestjs-payment` 支付模块，支持微信支付和支付宝。
+
+## 已安装的包
+
+- `@svton/nestjs-payment` - 支付模块（微信支付 V3 + 支付宝）
+
+## 配置文件
+
+- `src/config/payment.config.ts` - 支付配置
+- `.env` - 环境变量配置（商户信息、密钥等）
+
+## 示例代码位置
+
+查看 `src/examples/payment/` 目录获取完整示例：
+- `order.service.ts` - 订单创建服务
+- `order.controller.ts` - 支付接口
+- `webhook.controller.ts` - 支付回调处理
+- `README.md` - 详细说明文档
+
+## 支持的支付方式
+
+### 微信支付
+- JSAPI 支付（公众号/小程序）
+- Native 支付（扫码支付）
+- APP 支付
+- H5 支付
+- 小程序支付
+
+### 支付宝
+- 电脑网站支付（PC）
+- 手机网站支付（H5）
+- APP 支付
+
+## 核心 API
+
+### 创建微信订单
+
+```typescript
+const result = await this.paymentService.wechat.createOrder({
+  outTradeNo: orderId,
+  totalAmount: amount,
+  description: '商品购买',
+  userId: openid,
+}, 'jsapi');
+```
+
+### 创建支付宝订单
+
+```typescript
+const result = await this.paymentService.alipay.createOrder({
+  outTradeNo: orderId,
+  totalAmount: amount,
+  description: '商品购买',
+}, 'page');
+```
+
+### 查询订单状态
+
+```typescript
+const status = await this.paymentService.wechat.queryOrder(outTradeNo);
+```
+
+### 申请退款
+
+```typescript
+const refund = await this.paymentService.wechat.refund({
+  outTradeNo: orderId,
+  outRefundNo: refundId,
+  refundAmount: amount,
+  totalAmount: totalAmount,
+});
+```
+
+## 回调处理
+
+### 微信支付回调
+
+```typescript
+@Post('webhook/wechat')
+async wechatWebhook(@Req() req: Request) {
+  const result = await this.paymentService.wechat.handleNotify(req);
+  // 处理支付成功逻辑
+  return { code: 'SUCCESS', message: '成功' };
+}
+```
+
+### 支付宝回调
+
+```typescript
+@Post('webhook/alipay')
+async alipayWebhook(@Body() body: any) {
+  const result = await this.paymentService.alipay.handleNotify(body);
+  // 处理支付成功逻辑
+  return 'success';
+}
+```
+
+## 最佳实践
+
+1. **订单号唯一性**：确保 outTradeNo 全局唯一
+2. **金额单位**：统一使用分为单位
+3. **回调幂等性**：支付回调可能重复，需要幂等处理
+4. **异步通知**：优先使用异步通知，不依赖同步返回
+5. **安全验证**：验证回调签名，防止伪造
+
+## 环境变量配置
+
+```env
+# 微信支付
+WECHAT_MCH_ID=商户号
+WECHAT_PRIVATE_KEY=./certs/apiclient_key.pem
+WECHAT_SERIAL_NO=证书序列号
+WECHAT_API_V3_KEY=APIv3密钥
+WECHAT_APP_ID=关联的AppID
+
+# 支付宝
+ALIPAY_APP_ID=应用ID
+ALIPAY_PRIVATE_KEY=./certs/alipay_private_key.pem
+ALIPAY_PUBLIC_KEY=./certs/alipay_public_key.pem
+```
+
+## 文档链接
+
+- 官方文档：https://751848178.github.io/svton/packages/nestjs-payment
+- 示例代码：`src/examples/payment/`
+- 微信支付文档：https://pay.weixin.qq.com/wiki/doc/apiv3/
+- 支付宝文档：https://opendocs.alipay.com/

package/templates/skills/queue.skill.md

@@ -0,0 +1,140 @@
+# 消息队列使用指南
+
+本项目已集成 `@svton/nestjs-queue` 消息队列模块，基于 BullMQ 实现。
+
+## 已安装的包
+
+- `@svton/nestjs-queue` - 队列模块
+- `@svton/nestjs-redis` - Redis 连接模块
+
+## 配置文件
+
+- `src/config/queue.config.ts` - 队列配置
+- `.env` - 环境变量配置（REDIS_HOST, REDIS_PORT）
+
+## 示例代码位置
+
+查看 `src/examples/queue/` 目录获取完整示例：
+- `email.processor.ts` - 邮件队列处理器
+- `email.service.ts` - 邮件发送服务
+- `email.controller.ts` - API 接口
+- `README.md` - 详细说明文档
+
+## 核心概念
+
+- **Queue（队列）**：任务的容器
+- **Job（任务）**：具体的执行单元
+- **Processor（处理器）**：任务的执行逻辑
+- **Worker（工作进程）**：执行任务的进程
+
+## 添加任务
+
+```typescript
+await this.queueService.addJob('email', 'send', {
+  to: 'user@example.com',
+  subject: 'Welcome',
+  body: 'Welcome to our platform!',
+});
+```
+
+## 定义处理器
+
+```typescript
+@Processor({ name: 'email' })
+@Injectable()
+export class EmailProcessor {
+  @Process('send')
+  async handleSend(job: Job<EmailData>) {
+    const { to, subject, body } = job.data;
+    await this.sendEmail(to, subject, body);
+  }
+}
+```
+
+## 任务选项
+
+### 延迟执行
+
+```typescript
+await this.queueService.addJob('email', 'send', data, {
+  delay: 60000, // 延迟 60 秒
+});
+```
+
+### 重试策略
+
+```typescript
+await this.queueService.addJob('email', 'send', data, {
+  attempts: 3,
+  backoff: {
+    type: 'exponential',
+    delay: 1000,
+  },
+});
+```
+
+### 定时任务
+
+```typescript
+await this.queueService.addJob('report', 'daily', data, {
+  repeat: {
+    cron: '0 0 * * *', // 每天 0 点执行
+  },
+});
+```
+
+## 任务优先级
+
+```typescript
+await this.queueService.addJob('email', 'send', data, {
+  priority: 1, // 数字越小优先级越高
+});
+```
+
+## 监听任务事件
+
+```typescript
+@OnQueueCompleted({ name: 'email' })
+async onCompleted(job: Job) {
+  console.log(`Job ${job.id} completed`);
+}
+
+@OnQueueFailed({ name: 'email' })
+async onFailed(job: Job, error: Error) {
+  console.error(`Job ${job.id} failed:`, error);
+}
+```
+
+## 常见场景
+
+### 发送邮件
+```typescript
+await this.queueService.addJob('email', 'send', emailData);
+```
+
+### 生成报表
+```typescript
+await this.queueService.addJob('report', 'generate', reportData);
+```
+
+### 数据同步
+```typescript
+await this.queueService.addJob('sync', 'user', userData, {
+  attempts: 5,
+  backoff: { type: 'exponential', delay: 2000 },
+});
+```
+
+## 最佳实践
+
+1. **任务幂等性**：确保任务可以安全重试
+2. **合理设置重试**：根据业务场景设置重试次数和策略
+3. **任务拆分**：大任务拆分成小任务，提高并发度
+4. **监控告警**：监听失败事件，及时处理异常
+5. **资源限制**：控制并发数，避免资源耗尽
+
+## 文档链接
+
+- 官方文档：https://751848178.github.io/svton/packages/nestjs-queue
+- 示例代码：`src/examples/queue/`
+- BullMQ 文档：https://docs.bullmq.io/

package/templates/skills/rate-limit.skill.md

@@ -0,0 +1,38 @@
+# 限流功能使用指南
+
+本项目已集成 `@svton/nestjs-rate-limit` 限流模块，基于 Redis 实现。
+
+## 已安装的包
+
+- `@svton/nestjs-rate-limit` - 限流模块
+- `@svton/nestjs-redis` - Redis 连接模块
+
+## 配置文件
+
+- `src/config/rate-limit.config.ts` - 限流配置
+- `.env` - 环境变量配置
+
+## 示例代码位置
+
+查看 `src/examples/rate-limit/` 目录获取完整示例。
+
+## 核心装饰器
+
+### @RateLimit - 接口限流
+
+```typescript
+@RateLimit({ ttl: 60, limit: 10 })
+@Get('api')
+async api() {
+  return { message: 'Success' };
+}
+```
+
+### 全局限流
+
+在 `app.module.ts` 中配置全局限流规则。
+
+## 文档链接
+
+- 官方文档：https://751848178.github.io/svton/packages/nestjs-rate-limit
+- 示例代码：`src/examples/rate-limit/`

package/templates/skills/sms.skill.md

@@ -0,0 +1,39 @@
+# 短信功能使用指南
+
+本项目已集成 `@svton/nestjs-sms` 短信模块，支持阿里云和腾讯云。
+
+## 已安装的包
+
+- `@svton/nestjs-sms` - 短信发送模块
+
+## 配置文件
+
+- `src/config/sms.config.ts` - 短信配置
+- `.env` - 环境变量配置
+
+## 示例代码位置
+
+查看 `src/examples/sms/` 目录获取完整示例。
+
+## 核心 API
+
+### 发送短信
+
+```typescript
+await this.smsService.send({
+  phoneNumber: '13800138000',
+  templateCode: 'SMS_123456',
+  templateParams: { code: '123456' },
+});
+```
+
+### 发送验证码
+
+```typescript
+await this.smsService.sendVerificationCode('13800138000', '123456');
+```
+
+## 文档链接
+
+- 官方文档：https://751848178.github.io/svton/packages/nestjs-sms
+- 示例代码：`src/examples/sms/`

package/templates/skills/storage.skill.md

@@ -0,0 +1,42 @@
+# 对象存储使用指南
+
+本项目已集成 `@svton/nestjs-object-storage` 对象存储模块，支持七牛云和阿里云 OSS。
+
+## 已安装的包
+
+- `@svton/nestjs-object-storage` - 对象存储抽象层
+- `@svton/nestjs-object-storage-qiniu-kodo` - 七牛云实现
+
+## 配置文件
+
+- `src/config/storage.config.ts` - 存储配置
+- `.env` - 环境变量配置
+
+## 示例代码位置
+
+查看 `src/examples/storage/` 目录获取完整示例。
+
+## 核心 API
+
+### 上传文件
+
+```typescript
+const result = await this.storageService.upload(file, 'uploads/');
+```
+
+### 获取上传凭证
+
+```typescript
+const token = await this.storageService.getUploadToken();
+```
+
+### 删除文件
+
+```typescript
+await this.storageService.delete(key);
+```
+
+## 文档链接
+
+- 官方文档：https://751848178.github.io/svton/packages/nestjs-object-storage
+- 示例代码：`src/examples/storage/`