@plolink/sdk 0.0.4

package/dist/modules/rbac/index.d.cts

@@ -0,0 +1,293 @@
+import { P as PlolinkClient } from '../../client-CAjIQKPm.cjs';
+import { S as ScopeType, R as RoleType, A as AssignRoleParams } from '../../shared-6ZepUSPW.cjs';
+import '../../core-77EbLgbp.cjs';
+import 'axios';
+
+/**
+ * RBAC 模块类型
+ */
+
+/**
+ * 权限点定义项
+ */
+interface PermissionDefinitionItem {
+    code: string;
+    name: string;
+    description: string;
+}
+/**
+ * 按模块分组的权限点定义
+ */
+type PermissionDefinitionsByModule = Record<string, PermissionDefinitionItem[]>;
+/**
+ * 系统角色定义（来自后端硬编码 definitions）
+ */
+interface SystemRoleDefinitionItem {
+    code: string;
+    name: string;
+    description: string;
+    permissions: string[];
+    defaultScopeType: ScopeType;
+}
+/**
+ * GET /api/v1/permissions 响应（data 部分）
+ */
+interface PermissionDefinitionsResponse {
+    permissions: PermissionDefinitionsByModule;
+    systemRoles: SystemRoleDefinitionItem[];
+}
+/**
+ * 团队自定义角色信息
+ */
+interface CustomRoleInfo {
+    id: string;
+    name: string;
+    code: string;
+    teamId: string;
+    permissions: string[];
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    version?: number;
+}
+/**
+ * 团队角色列表中的系统角色项
+ */
+interface SystemRoleListItem extends SystemRoleDefinitionItem {
+    type: 'SYSTEM';
+    isSystem: true;
+    membersCount: number;
+}
+/**
+ * 团队角色列表中的自定义角色项
+ */
+interface CustomRoleListItem extends CustomRoleInfo {
+    type: 'CUSTOM';
+    isSystem: false;
+    membersCount: number;
+}
+/**
+ * GET /api/v1/teams/:teamId/roles 响应（data 部分）
+ */
+interface TeamRolesResponse {
+    systemRoles: SystemRoleListItem[];
+    customRoles: CustomRoleListItem[];
+}
+/**
+ * 创建自定义角色参数
+ */
+interface CreateCustomRoleParams {
+    name: string;
+    code: string;
+    permissions: string[];
+}
+/**
+ * 更新自定义角色参数
+ *
+ * @description
+ * 后端约束：code 创建后不可修改，但接口层仍可能接受该字段并在服务端拒绝。
+ */
+interface UpdateCustomRoleParams {
+    name?: string;
+    code?: string;
+    permissions?: string[];
+}
+/**
+ * 删除角色结果
+ */
+interface DeleteRoleResult {
+    success: true;
+}
+/**
+ * 角色详情中的成员使用情况
+ */
+interface RoleMemberUsageItem {
+    memberRoleId: string;
+    memberId: string;
+    userId: string;
+    scopeType: ScopeType;
+    scopeValue: Record<string, unknown> | null;
+    joinedAt?: string | null;
+}
+/**
+ * 系统角色详情（GET /api/v1/teams/:teamId/roles/:roleId 返回的 data）
+ */
+interface SystemRoleDetail {
+    code: string;
+    name: string;
+    description: string;
+    permissions: string[];
+    type: 'SYSTEM';
+    isSystem: true;
+    memberCount: number;
+    members: RoleMemberUsageItem[];
+}
+/**
+ * 自定义角色详情（GET /api/v1/teams/:teamId/roles/:roleId 返回的 data）
+ */
+interface CustomRoleDetail {
+    id: string;
+    code: string;
+    name: string;
+    permissions: string[];
+    type: 'CUSTOM';
+    isSystem: false;
+    memberCount: number;
+    members: RoleMemberUsageItem[];
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * 角色详情（系统/自定义联合类型）
+ */
+type TeamRoleDetail = SystemRoleDetail | CustomRoleDetail;
+/**
+ * 成员角色列表项（GET /api/v1/teams/:teamId/members/:memberId/roles 返回的 data）
+ */
+interface MemberRoleListItem {
+    memberRoleId: string;
+    roleType: RoleType;
+    roleCode?: string | null;
+    roleId?: string | null;
+    roleName: string;
+    roleDescription?: string;
+    permissions: string[];
+    scopeType: ScopeType;
+    scopeValue: Record<string, unknown> | null;
+    createdAt: string;
+}
+/**
+ * 成员角色记录（POST/PUT/talent 等接口直接返回 memberRole）
+ */
+interface MemberRoleRecord {
+    id: string;
+    memberId: string;
+    roleType: RoleType;
+    roleCode: string | null;
+    roleId: string | null;
+    scopeType: ScopeType;
+    scopeValue: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    role?: CustomRoleInfo | null;
+}
+/**
+ * 更新成员角色数据范围参数
+ */
+interface UpdateMemberRoleScopeParams {
+    scopeType: ScopeType;
+    scopeValue?: Record<string, unknown>;
+}
+/**
+ * 快捷授权人才模块参数
+ */
+interface QuickGrantTalentAccessParams {
+    companyIds?: string[];
+    roleCode?: 'SUB_UNIT_VIEWER' | 'SUB_UNIT_MANAGER';
+}
+
+/**
+ * RBAC 模块 (Rbac)
+ *
+ * @description
+ * 提供权限点、角色、成员角色分配等能力封装，覆盖后端 `docs/api/rbac.md` 中的核心接口：
+ * - 获取权限点定义 + 系统角色定义
+ * - 团队角色管理（系统角色列表 + 自定义角色 CRUD）
+ * - 成员角色管理（查询/分配/更新数据范围/移除）
+ * - 人才模块快捷授权（SUB_UNIT_VIEWER / SUB_UNIT_MANAGER）
+ *
+ * @example
+ * ```typescript
+ * import { PlolinkClient } from '@plolink/sdk';
+ * import { Team } from '@plolink/sdk/team';
+ * import { Rbac } from '@plolink/sdk/rbac';
+ * import { VirtualAccount } from '@plolink/sdk/virtual-account';
+ *
+ * const client = new PlolinkClient({ token: 'session-or-apikey' });
+ * const virtualAccount = new VirtualAccount(client);
+ * const team = new Team(client);
+ * const rbac = new Rbac(client);
+ *
+ * const created = await virtualAccount.createVirtualAccount({
+ *   mode: 'EXISTING_TEAM',
+ *   teamId: 'team-123',
+ *   virtualAccountName: 'Bot'
+ * });
+ *
+ * const members = await team.listTeamMembers(created.virtualAccount.virtualAccountTeamId);
+ * const memberId = team.getMemberIdByUserId(members, created.virtualAccount.id);
+ *
+ * await rbac.assignMemberRole(created.virtualAccount.virtualAccountTeamId, memberId, {
+ *   roleType: 'SYSTEM',
+ *   roleCode: 'SUB_UNIT_VIEWER',
+ *   scopeType: 'TEAM'
+ * });
+ * ```
+ *
+ * @module rbac
+ */
+
+declare class Rbac {
+    private client;
+    constructor(client: PlolinkClient);
+    /**
+     * 获取所有权限点定义 + 系统角色定义
+     * GET /api/v1/permissions
+     */
+    getPermissionDefinitions(): Promise<PermissionDefinitionsResponse>;
+    /**
+     * 列出团队角色（系统角色 + 自定义角色）
+     * GET /api/v1/teams/:teamId/roles
+     */
+    listTeamRoles(teamId: string): Promise<TeamRolesResponse>;
+    /**
+     * 创建自定义角色
+     * POST /api/v1/teams/:teamId/roles
+     */
+    createCustomRole(teamId: string, params: CreateCustomRoleParams): Promise<CustomRoleInfo>;
+    /**
+     * 更新自定义角色
+     * PUT /api/v1/teams/:teamId/roles/:roleId
+     */
+    updateCustomRole(teamId: string, roleId: string, params: UpdateCustomRoleParams): Promise<CustomRoleInfo>;
+    /**
+     * 删除自定义角色
+     * DELETE /api/v1/teams/:teamId/roles/:roleId?force=true
+     */
+    deleteCustomRole(teamId: string, roleId: string, options?: {
+        force?: boolean;
+    }): Promise<DeleteRoleResult>;
+    /**
+     * 获取角色详情（系统角色或自定义角色）
+     * GET /api/v1/teams/:teamId/roles/:roleId
+     */
+    getRoleDetail(teamId: string, roleId: string): Promise<TeamRoleDetail>;
+    /**
+     * 获取成员的所有角色（带角色信息与权限）
+     * GET /api/v1/teams/:teamId/members/:memberId/roles
+     */
+    listMemberRoles(teamId: string, memberId: string): Promise<MemberRoleListItem[]>;
+    /**
+     * 为成员分配角色（系统/自定义）及数据范围
+     * POST /api/v1/teams/:teamId/members/:memberId/roles
+     */
+    assignMemberRole(teamId: string, memberId: string, params: AssignRoleParams): Promise<MemberRoleRecord>;
+    /**
+     * 更新成员角色的数据范围
+     * PUT /api/v1/teams/:teamId/members/:memberId/roles/:memberRoleId
+     */
+    updateMemberRoleScope(teamId: string, memberId: string, memberRoleId: string, params: UpdateMemberRoleScopeParams): Promise<MemberRoleRecord>;
+    /**
+     * 移除成员角色
+     * DELETE /api/v1/teams/:teamId/members/:memberId/roles/:memberRoleId
+     */
+    removeMemberRole(teamId: string, memberId: string, memberRoleId: string): Promise<DeleteRoleResult>;
+    /**
+     * 快捷授权人才模块（公司访问范围）
+     * POST /api/v1/teams/:teamId/members/:memberId/roles/talent
+     */
+    quickGrantTalentAccess(teamId: string, memberId: string, params?: QuickGrantTalentAccessParams): Promise<MemberRoleRecord>;
+}
+
+export { AssignRoleParams, type CreateCustomRoleParams, type CustomRoleInfo, type DeleteRoleResult, type MemberRoleListItem, type MemberRoleRecord, type PermissionDefinitionsResponse, type QuickGrantTalentAccessParams, Rbac, RoleType, ScopeType, type TeamRoleDetail, type TeamRolesResponse, type UpdateCustomRoleParams, type UpdateMemberRoleScopeParams };

package/dist/modules/rbac/index.d.ts

@@ -0,0 +1,293 @@
+import { P as PlolinkClient } from '../../client-CwNikk7i.js';
+import { S as ScopeType, R as RoleType, A as AssignRoleParams } from '../../shared-6ZepUSPW.js';
+import '../../core-77EbLgbp.js';
+import 'axios';
+
+/**
+ * RBAC 模块类型
+ */
+
+/**
+ * 权限点定义项
+ */
+interface PermissionDefinitionItem {
+    code: string;
+    name: string;
+    description: string;
+}
+/**
+ * 按模块分组的权限点定义
+ */
+type PermissionDefinitionsByModule = Record<string, PermissionDefinitionItem[]>;
+/**
+ * 系统角色定义（来自后端硬编码 definitions）
+ */
+interface SystemRoleDefinitionItem {
+    code: string;
+    name: string;
+    description: string;
+    permissions: string[];
+    defaultScopeType: ScopeType;
+}
+/**
+ * GET /api/v1/permissions 响应（data 部分）
+ */
+interface PermissionDefinitionsResponse {
+    permissions: PermissionDefinitionsByModule;
+    systemRoles: SystemRoleDefinitionItem[];
+}
+/**
+ * 团队自定义角色信息
+ */
+interface CustomRoleInfo {
+    id: string;
+    name: string;
+    code: string;
+    teamId: string;
+    permissions: string[];
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    version?: number;
+}
+/**
+ * 团队角色列表中的系统角色项
+ */
+interface SystemRoleListItem extends SystemRoleDefinitionItem {
+    type: 'SYSTEM';
+    isSystem: true;
+    membersCount: number;
+}
+/**
+ * 团队角色列表中的自定义角色项
+ */
+interface CustomRoleListItem extends CustomRoleInfo {
+    type: 'CUSTOM';
+    isSystem: false;
+    membersCount: number;
+}
+/**
+ * GET /api/v1/teams/:teamId/roles 响应（data 部分）
+ */
+interface TeamRolesResponse {
+    systemRoles: SystemRoleListItem[];
+    customRoles: CustomRoleListItem[];
+}
+/**
+ * 创建自定义角色参数
+ */
+interface CreateCustomRoleParams {
+    name: string;
+    code: string;
+    permissions: string[];
+}
+/**
+ * 更新自定义角色参数
+ *
+ * @description
+ * 后端约束：code 创建后不可修改，但接口层仍可能接受该字段并在服务端拒绝。
+ */
+interface UpdateCustomRoleParams {
+    name?: string;
+    code?: string;
+    permissions?: string[];
+}
+/**
+ * 删除角色结果
+ */
+interface DeleteRoleResult {
+    success: true;
+}
+/**
+ * 角色详情中的成员使用情况
+ */
+interface RoleMemberUsageItem {
+    memberRoleId: string;
+    memberId: string;
+    userId: string;
+    scopeType: ScopeType;
+    scopeValue: Record<string, unknown> | null;
+    joinedAt?: string | null;
+}
+/**
+ * 系统角色详情（GET /api/v1/teams/:teamId/roles/:roleId 返回的 data）
+ */
+interface SystemRoleDetail {
+    code: string;
+    name: string;
+    description: string;
+    permissions: string[];
+    type: 'SYSTEM';
+    isSystem: true;
+    memberCount: number;
+    members: RoleMemberUsageItem[];
+}
+/**
+ * 自定义角色详情（GET /api/v1/teams/:teamId/roles/:roleId 返回的 data）
+ */
+interface CustomRoleDetail {
+    id: string;
+    code: string;
+    name: string;
+    permissions: string[];
+    type: 'CUSTOM';
+    isSystem: false;
+    memberCount: number;
+    members: RoleMemberUsageItem[];
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * 角色详情（系统/自定义联合类型）
+ */
+type TeamRoleDetail = SystemRoleDetail | CustomRoleDetail;
+/**
+ * 成员角色列表项（GET /api/v1/teams/:teamId/members/:memberId/roles 返回的 data）
+ */
+interface MemberRoleListItem {
+    memberRoleId: string;
+    roleType: RoleType;
+    roleCode?: string | null;
+    roleId?: string | null;
+    roleName: string;
+    roleDescription?: string;
+    permissions: string[];
+    scopeType: ScopeType;
+    scopeValue: Record<string, unknown> | null;
+    createdAt: string;
+}
+/**
+ * 成员角色记录（POST/PUT/talent 等接口直接返回 memberRole）
+ */
+interface MemberRoleRecord {
+    id: string;
+    memberId: string;
+    roleType: RoleType;
+    roleCode: string | null;
+    roleId: string | null;
+    scopeType: ScopeType;
+    scopeValue: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    role?: CustomRoleInfo | null;
+}
+/**
+ * 更新成员角色数据范围参数
+ */
+interface UpdateMemberRoleScopeParams {
+    scopeType: ScopeType;
+    scopeValue?: Record<string, unknown>;
+}
+/**
+ * 快捷授权人才模块参数
+ */
+interface QuickGrantTalentAccessParams {
+    companyIds?: string[];
+    roleCode?: 'SUB_UNIT_VIEWER' | 'SUB_UNIT_MANAGER';
+}
+
+/**
+ * RBAC 模块 (Rbac)
+ *
+ * @description
+ * 提供权限点、角色、成员角色分配等能力封装，覆盖后端 `docs/api/rbac.md` 中的核心接口：
+ * - 获取权限点定义 + 系统角色定义
+ * - 团队角色管理（系统角色列表 + 自定义角色 CRUD）
+ * - 成员角色管理（查询/分配/更新数据范围/移除）
+ * - 人才模块快捷授权（SUB_UNIT_VIEWER / SUB_UNIT_MANAGER）
+ *
+ * @example
+ * ```typescript
+ * import { PlolinkClient } from '@plolink/sdk';
+ * import { Team } from '@plolink/sdk/team';
+ * import { Rbac } from '@plolink/sdk/rbac';
+ * import { VirtualAccount } from '@plolink/sdk/virtual-account';
+ *
+ * const client = new PlolinkClient({ token: 'session-or-apikey' });
+ * const virtualAccount = new VirtualAccount(client);
+ * const team = new Team(client);
+ * const rbac = new Rbac(client);
+ *
+ * const created = await virtualAccount.createVirtualAccount({
+ *   mode: 'EXISTING_TEAM',
+ *   teamId: 'team-123',
+ *   virtualAccountName: 'Bot'
+ * });
+ *
+ * const members = await team.listTeamMembers(created.virtualAccount.virtualAccountTeamId);
+ * const memberId = team.getMemberIdByUserId(members, created.virtualAccount.id);
+ *
+ * await rbac.assignMemberRole(created.virtualAccount.virtualAccountTeamId, memberId, {
+ *   roleType: 'SYSTEM',
+ *   roleCode: 'SUB_UNIT_VIEWER',
+ *   scopeType: 'TEAM'
+ * });
+ * ```
+ *
+ * @module rbac
+ */
+
+declare class Rbac {
+    private client;
+    constructor(client: PlolinkClient);
+    /**
+     * 获取所有权限点定义 + 系统角色定义
+     * GET /api/v1/permissions
+     */
+    getPermissionDefinitions(): Promise<PermissionDefinitionsResponse>;
+    /**
+     * 列出团队角色（系统角色 + 自定义角色）
+     * GET /api/v1/teams/:teamId/roles
+     */
+    listTeamRoles(teamId: string): Promise<TeamRolesResponse>;
+    /**
+     * 创建自定义角色
+     * POST /api/v1/teams/:teamId/roles
+     */
+    createCustomRole(teamId: string, params: CreateCustomRoleParams): Promise<CustomRoleInfo>;
+    /**
+     * 更新自定义角色
+     * PUT /api/v1/teams/:teamId/roles/:roleId
+     */
+    updateCustomRole(teamId: string, roleId: string, params: UpdateCustomRoleParams): Promise<CustomRoleInfo>;
+    /**
+     * 删除自定义角色
+     * DELETE /api/v1/teams/:teamId/roles/:roleId?force=true
+     */
+    deleteCustomRole(teamId: string, roleId: string, options?: {
+        force?: boolean;
+    }): Promise<DeleteRoleResult>;
+    /**
+     * 获取角色详情（系统角色或自定义角色）
+     * GET /api/v1/teams/:teamId/roles/:roleId
+     */
+    getRoleDetail(teamId: string, roleId: string): Promise<TeamRoleDetail>;
+    /**
+     * 获取成员的所有角色（带角色信息与权限）
+     * GET /api/v1/teams/:teamId/members/:memberId/roles
+     */
+    listMemberRoles(teamId: string, memberId: string): Promise<MemberRoleListItem[]>;
+    /**
+     * 为成员分配角色（系统/自定义）及数据范围
+     * POST /api/v1/teams/:teamId/members/:memberId/roles
+     */
+    assignMemberRole(teamId: string, memberId: string, params: AssignRoleParams): Promise<MemberRoleRecord>;
+    /**
+     * 更新成员角色的数据范围
+     * PUT /api/v1/teams/:teamId/members/:memberId/roles/:memberRoleId
+     */
+    updateMemberRoleScope(teamId: string, memberId: string, memberRoleId: string, params: UpdateMemberRoleScopeParams): Promise<MemberRoleRecord>;
+    /**
+     * 移除成员角色
+     * DELETE /api/v1/teams/:teamId/members/:memberId/roles/:memberRoleId
+     */
+    removeMemberRole(teamId: string, memberId: string, memberRoleId: string): Promise<DeleteRoleResult>;
+    /**
+     * 快捷授权人才模块（公司访问范围）
+     * POST /api/v1/teams/:teamId/members/:memberId/roles/talent
+     */
+    quickGrantTalentAccess(teamId: string, memberId: string, params?: QuickGrantTalentAccessParams): Promise<MemberRoleRecord>;
+}
+
+export { AssignRoleParams, type CreateCustomRoleParams, type CustomRoleInfo, type DeleteRoleResult, type MemberRoleListItem, type MemberRoleRecord, type PermissionDefinitionsResponse, type QuickGrantTalentAccessParams, Rbac, RoleType, ScopeType, type TeamRoleDetail, type TeamRolesResponse, type UpdateCustomRoleParams, type UpdateMemberRoleScopeParams };