权限控制

import type { IPermissionPoint } from '@univerjs/core'import { IPermissionService, PermissionStatus } from '@univerjs/core'import { UnitAction, UnitObject } from '@univerjs/protocol'export class CustomPermissionPoint implements IPermissionPoint {  type = UnitObject.Unkonwn // your type  subType = UnitAction.View // your subType  status = PermissionStatus.INIT  value = true // 权限的初始值  id: string  constructor(unitId: string, subUnitId: string, customId: string) {    // 这里自行拼凑一个 id，id 属性需要保证在整个 IPermissionService 中是唯一的凭证。    this.id = `${unitId}.${subUnitId}.${customId}`  }}class YourService {  constructor(@IPermissionService private _permissionService: IPermissionService) {    this._init()  }  _init() {    this._permissionService.addPermissionPoint(new CustomPermissionPoint('unitId', 'subUnitId', 'my-id'))  }}// 在其他地方如何使用class ConsumeService {  constructor(@IPermissionService private _permissionService: IPermissionService) {  }  doSomething() {    const point = this._permissionService.getPermissionPoint(new CustomPermissionPoint('unitId', 'subUnitId', 'my-id').id)    console.log(point.value)  }  bindEvent() {    // 这将获得一个 Rx 对象，使得你能够监听当前权限的变化作出一些改变    const point$ = this._permissionService.getPermissionPoint$(new CustomPermissionPoint('unitId', 'subUnitId', 'my-id').id)    console.log(point$)  }}

import type { Injector } from '@univerjs/core'import type { IActionInfo, IAllowedRequest, IBatchAllowedResponse, ICollaborator, ICreateRequest, ICreateRequestSelectRangeObject, IListPermPointRequest, IPermissionPoint, IPutCollaboratorsRequest, IUnitRoleKV, IUpdatePermPointRequest } from '@univerjs/protocol'import { createDefaultUser, generateRandomId, IAuthzIoService, Inject, IResourceManagerService, isDevRole, Univer, UserManagerService } from '@univerjs/core'import { ObjectScope, UnitAction, UnitObject, UnitRole, UniverType } from '@univerjs/protocol'class YourAuthzService implements IAuthzIoService {  private _permissionMap: Map<string, ICreateRequestSelectRangeObject & { objectType: UnitObject }> = new Map([])  constructor(    @IResourceManagerService private _resourceManagerService: IResourceManagerService,    @Inject(UserManagerService) private _userManagerService: UserManagerService,  ) {    this._initSnapshot()    this._initDefaultUser()  }  private _initDefaultUser() {    const currentUser = this._userManagerService.getCurrentUser()    const currentUserIsValid = currentUser && currentUser.userID    if (!currentUserIsValid) {      this._userManagerService.setCurrentUser(createDefaultUser(UnitRole.Owner))    }  }  private _getRole(type: UnitRole) {    const user = this._userManagerService.getCurrentUser()    if (!user) {      return false    }    return isDevRole(user.userID, type)  }  private _initSnapshot() {    this._resourceManagerService.registerPluginResource({      toJson: (_unitId: string) => {        const obj = [...this._permissionMap.keys()].reduce((r, k) => {          const v = this._permissionMap.get(k)          r[k] = v!          return r        }, {} as Record<string, ICreateRequestSelectRangeObject & { objectType: UnitObject }>)        return JSON.stringify(obj)      },      parseJson: (json: string) => {        return JSON.parse(json)      },      pluginName: 'SHEET_AuthzIoMockService_PLUGIN',      businesses: [UniverType.UNIVER_SHEET, UniverType.UNIVER_DOC, UniverType.UNIVER_SLIDE],      onLoad: (_unitId, resource) => {        for (const key in resource) {          this._permissionMap.set(key, resource[key])        }      },      onUnLoad: () => {        this._permissionMap.clear()      },    })  }  async create(config: ICreateRequest): Promise<string> {    const permissionId = generateRandomId(8)    if (config.objectType === UnitObject.SelectRange && config.selectRangeObject) {      this._permissionMap.set(permissionId, { ...config.selectRangeObject, objectType: config.objectType })    }    return permissionId  }  async batchAllowed(config: IAllowedRequest[]): Promise<IBatchAllowedResponse['objectActions']> {    const selectionRangeConfig = config.filter(c => c.objectType === UnitObject.SelectRange)    if (selectionRangeConfig.length) {      const currentUser = this._userManagerService.getCurrentUser()      const res = [] as IBatchAllowedResponse['objectActions']      selectionRangeConfig.forEach((c) => {        res.push({          unitID: c.unitID,          objectID: c.objectID,          actions: c.actions.map((action) => {            if (isDevRole(currentUser.userID, UnitRole.Owner)) {              return { action, allowed: true }            }            return { action, allowed: false }          }),        })      })      return res    }    return Promise.resolve([])  }  async list(config: IListPermPointRequest): Promise<IPermissionPoint[]> {    const result: IPermissionPoint[] = []    config.objectIDs.forEach((objectID) => {      const rule = this._permissionMap.get(objectID)      if (rule) {        const item = {          objectID,          unitID: config.unitID,          objectType: rule!.objectType,          name: rule!.name,          shareOn: false,          shareRole: UnitRole.Owner,          shareScope: -1,          scope: {            read: ObjectScope.AllCollaborator,            edit: ObjectScope.AllCollaborator,          },          creator: createDefaultUser(UnitRole.Owner),          strategies: [            {              action: UnitAction.View,              role: UnitRole.Owner,            },            {              action: UnitAction.Edit,              role: UnitRole.Owner,            },          ],          actions: config.actions.map((a) => {            return { action: a, allowed: this._getRole(UnitRole.Owner) }          }),        }        result.push(item)      }    })    return result  }  async listCollaborators(): Promise<ICollaborator[]> {    // List the existing collaborators    return []  }  async allowed(_config: IAllowedRequest): Promise<IActionInfo[]> {    // Because this is a mockService for handling permissions, we will not write real logic in it. We will only return an empty array to ensure that the permissions originally set by the user are not modified.    // If you want to achieve persistence of permissions, you can modify the logic here.    return Promise.resolve([])  }  async listRoles(): Promise<{ roles: IUnitRoleKV[], actions: UnitAction[] }> {    return {      roles: [],      actions: [],    }  }  async update(config: IUpdatePermPointRequest): Promise<void> {    // Update bit information  }  async updateCollaborator(): Promise<void> {    // Update collaborator information    return undefined  }  async createCollaborator(): Promise<void> {    // Create new collaborator information    return undefined  }  async deleteCollaborator(): Promise<void> {    return undefined  }  async putCollaborators(config: IPutCollaboratorsRequest): Promise<void> {    return undefined  }}export class YourPlugin extends Plugin {  constructor(    _config: unknown,    @Inject(Injector) protected override _injector: Injector,  ) {  }  override onStarting(): void {    this._injector.add([IAuthzIoService, { useClass: YourAuthzService }])  }}// 通过将 override 选项设置为 [[IAuthzIoService, null]]，可以告诉 Univer 不要注册内置的 IAuthzIoService。// 这样，Univer 将使用你在 YourAuthzService 中提供的服务作为权限服务的实现。const univer = new Univer({  override: [[IAuthzIoService, null]],})univer.registerPlugin(YourPlugin)

const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getActiveSheet()const worksheetPermission = fWorksheet.getWorksheetPermission()// 如果需要设置权限点位，必须先创建工作表保护await worksheetPermission.protect()// 设置为编辑模式await worksheetPermission.setMode('editable')// 设置为只读模式await worksheetPermission.setMode('readOnly')// 设置为仅筛选/排序模式await worksheetPermission.setMode('filterOnly')// 设置为自定义模式await worksheetPermission.applyConfig({  mode: 'readOnly',  points: {    [univerAPI.Enum.WorksheetPermissionPoint.InsertRow]: true,    [univerAPI.Enum.WorksheetPermissionPoint.InsertColumn]: true,  },})

const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getActiveSheet()const worksheetPermission = fWorksheet.getWorksheetPermission()// 设置多个保护范围，A1:B2 不允许编辑但允许他人查看，C3:D4 允许指定用户编辑但不允许他人查看const rules = await worksheetPermission.protectRanges([  {    ranges: [fWorksheet.getRange('A1:B2')],    options: { name: 'Protected Area 1', allowViewByOthers: true },  },  {    ranges: [fWorksheet.getRange('C3:D4')],    options: { name: 'Protected Area 2', allowViewByOthers: false, allowedUsers: ['user1'] },  },])console.log(rules)// 获取当前工作表所有保护范围规则const ruleList = await worksheetPermission.listRangeProtectionRules()console.log(ruleList)// 删除第一个保护范围规则await worksheetPermission.unprotectRules([ruleList[0].id])// 或者通过 `FRangeProtectionRule.remove()` 删除保护规则await ruleList[0].remove()

const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getActiveSheet()const fRange = fWorksheet.getRange('A1:B2')const rangePermission = fRange.getRangePermission()// 设置范围保护，允许指定用户编辑但不允许他人查看const rule = await rangePermission.protect({  name: 'My protected range',  allowViewByOthers: false,  allowedUsers: ['user1', 'user2'],})console.log(rule)// 获取当前范围内的所有保护规则const rules = await rangePermission.listRules()console.log(rules)// 删除当前范围内的所有保护规则await rangePermission.unprotect()// 或者通过 `FRangeProtectionRule.remove()` 删除保护规则await rules[0].remove()

const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getActiveSheet()const fRange = fWorksheet.getRange('A1:B2')const rangePermission = fRange.getRangePermission()// 如果需要设置权限点位，必须先创建区域保护if (rangePermission.isProtected()) {  const rules = await rangePermission.listRules()  // 设置第一个保护规则的编辑权限为不可用，查看权限为可用  await rules[0].setPoint(univerAPI.Enum.RangePermissionPoint.Edit, false)  await rules[0].setPoint(univerAPI.Enum.RangePermissionPoint.View, true)} else {  const rule = await rangePermission.protect({    name: 'My protected range',    allowViewByOthers: false,    allowedUsers: ['user1', 'user2'],  })  // 设置 A1:B2 选区的编辑权限为不可用，查看权限为可用  await rule.setPoint(univerAPI.Enum.RangePermissionPoint.Edit, false)  await rule.setPoint(univerAPI.Enum.RangePermissionPoint.View, true)}