@lark-apaas/nestjs-authzpaas 0.1.0-alpha.0 → 0.1.0-alpha.10

package/README.md

@@ -230,257 +230,6 @@ export class SensitiveController {
 }
 ```
 
-### 2. CanPermission - 权限检查
-
-使用 `@CanPermission()` 装饰器检查用户对特定资源的操作权限。
-
-#### 示例 1: 单个操作检查
-
-```typescript
-import { Controller, Get } from '@nestjs/common';
-import { CanPermission } from '@lark-apaas/nestjs-authzpaas';
-
-@Controller('demo')
-export class DemoController {
-  // 需要对 User 资源有 read 权限
-  @CanPermission([{ actions: ['read'], subject: 'User' }])
-  @Get('read-user')
-  readUser() {
-    return {
-      message: '✅ 用户读取成功（需要 read 权限）',
-    };
-  }
-
-  // 需要对 User 资源有 create 权限
-  @CanPermission([{ actions: ['create'], subject: 'User' }])
-  @Get('create-user')
-  createUser() {
-    return {
-      message: '✅ 用户创建成功（需要 create 权限）',
-    };
-  }
-}
-```
-
-#### 示例 2: 多个操作检查（AND 逻辑，默认）
-
-```typescript
-@Controller('articles')
-export class ArticleController {
-  // 需要同时拥有 read 和 update 权限
-  @CanPermission([{ 
-    actions: ['read', 'update'], 
-    subject: 'Article',
-    requireAll: true  // 默认为 true，可省略
-  }])
-  @Get('publish')
-  publish() {
-    return '发布文章';
-  }
-}
-```
-
-#### 示例 3: 多个操作检查（OR 逻辑）
-
-```typescript
-@Controller('articles')
-export class ArticleController {
-  // 拥有 read 或 preview 任一权限即可
-  @CanPermission([{ 
-    actions: ['read', 'preview'], 
-    subject: 'Article',
-    requireAll: false  // OR 逻辑
-  }])
-  @Get('preview')
-  preview() {
-    return '预览文章';
-  }
-}
-```
-
-#### 示例 4: 多个资源权限检查
-
-```typescript
-@Controller('articles')
-export class ArticleController {
-  // 需要同时满足：能读文章 AND 能创建评论
-  @CanPermission([
-    { actions: ['read'], subject: 'Article' },
-    { actions: ['create'], subject: 'Comment' }
-  ])
-  @Get('comment')
-  addComment() {
-    return '添加评论';
-  }
-
-  // 需要同时满足：能读文章 AND (能更新或删除评论)
-  @CanPermission([
-    { actions: ['read'], subject: 'Article' },
-    { actions: ['update', 'delete'], subject: 'Comment', requireAll: false }
-  ])
-  @Get('manage-comment')
-  manageComment() {
-    return '管理评论';
-  }
-}
-```
-
-### 3. UserId - 获取用户ID
-
-使用 `@UserId()` 参数装饰器获取当前用户ID。
-
-#### 示例 1: 基本用法
-
-```typescript
-import { Controller, Get } from '@nestjs/common';
-import { UserId } from '@lark-apaas/nestjs-authzpaas';
-
-@Controller('demo')
-export class DemoController {
-  @Get('profile')
-  getProfile(@UserId() userId: string) {
-    return {
-      message: '获取用户资料',
-      userId,
-    };
-  }
-}
-```
-
-#### 示例 2: 结合 PermissionService 使用
-
-```typescript
-import { Controller, Get } from '@nestjs/common';
-import { UserId, PermissionService } from '@lark-apaas/nestjs-authzpaas';
-
-@Controller('demo')
-export class DemoController {
-  constructor(private readonly permissionService: PermissionService) {}
-
-  @Get('check-permission')
-  async checkPermission(@UserId() userId: string) {
-    // 手动检查权限
-    const hasPermission = await this.permissionService.checkPermissions(
-      [{ actions: ['read'], subject: 'User' }], 
-      userId
-    );
-    
-    return {
-      message: '权限检查成功',
-      userId,
-      hasPermission,
-    };
-  }
-}
-```
-
-#### 示例 3: 使用 CASL Ability
-
-```typescript
-import { Controller, Get } from '@nestjs/common';
-import { UserId, PermissionService, ROLE_SUBJECT } from '@lark-apaas/nestjs-authzpaas';
-
-@Controller('demo')
-export class DemoController {
-  constructor(private readonly permissionService: PermissionService) {}
-
-  @Get('ability')
-  async getAbility(@UserId() userId: string) {
-    const ability = await this.permissionService.getAbility(userId);
-    
-    // 使用 CASL Ability 检查权限
-    const canReadUser = ability.can('read', 'User');
-    const canWriteTask = ability.can('write', 'Task');
-    const isAdmin = ability.can('admin', ROLE_SUBJECT);
-    
-    return {
-      userId,
-      permissions: {
-        canReadUser,
-        canWriteTask,
-        isAdmin,
-      },
-    };
-  }
-}
-```
-
-### 4. MockRoles - 角色模拟
-
-使用 `@MockRoles()` 参数装饰器获取模拟角色，仅在 `enableMockRole: true` 时有效。
-
-#### 示例 1: 基本用法
-
-```typescript
-import { Controller, Get } from '@nestjs/common';
-import { MockRoles } from '@lark-apaas/nestjs-authzpaas';
-
-@Controller('demo')
-export class DemoController {
-  @Get('mock-roles')
-  getMockRoles(@MockRoles() mockRoles: string[]) {
-    return {
-      message: '获取模拟角色',
-      mockRoles: mockRoles || [],
-      hasMockRoles: !!mockRoles,
-    };
-  }
-}
-```
-
-#### 示例 2: 结合权限检查
-
-```typescript
-@Controller('admin')
-export class AdminController {
-  @Get('test')
-  @CanRole(['admin'])  // 会优先使用模拟角色进行验证
-  testWithMockRoles(@MockRoles() mockRoles: string[]) {
-    return {
-      message: '管理员测试接口',
-      mockRoles,
-    };
-  }
-}
-```
-
-### 5. 装饰器组合使用
-
-可以组合使用多个装饰器实现复杂的鉴权需求。
-
-#### 示例 1: 角色 + 权限
-
-```typescript
-import { Controller, Get } from '@nestjs/common';
-import { CanRole, CanPermission } from '@lark-apaas/nestjs-authzpaas';
-
-@Controller('posts')
-export class PostController {
-  // 需要 editor 角色 + 对 Post 有 delete 权限
-  @CanRole(['editor'])
-  @CanPermission([{ actions: ['delete'], subject: 'Post' }])
-  @Get('delete')
-  delete() {
-    return '删除帖子';
-  }
-}
-```
-
-#### 示例 2: 多层权限检查
-
-```typescript
-@Controller('tasks')
-export class TasksController {
-  // 需要 admin 或 manager 角色 + Task 的 manage 权限
-  @CanRole(['admin', 'manager'])
-  @CanPermission([{ actions: ['manage'], subject: 'Task' }])
-  @Get('manage')
-  manageTasks() {
-    return '管理任务';
-  }
-}
-```
-
 ## 核心组件
 
 > 📚 **核心组件是装饰器的底层实现**，了解核心组件有助于深入理解权限系统的工作原理。
@@ -491,8 +240,6 @@ export class TasksController {
 
 1. **提取用户ID**: 从 `req.userContext.userId` 中提取用户ID
 2. **角色检查**: 如果使用了 `@CanRole()`，检查用户角色
-3. **权限检查**: 如果使用了 `@CanPermission()`，检查用户权限
-4. **环境检查**: 如果使用了 `@RequireEnvironment()`，检查环境条件
 5. **注入权限数据**: 将权限数据附加到 `req.userPermissions`
 
 **工作流程**: