Class: FPermission

// Old API
const permission = workbook.getPermission();
await permission.addRangeBaseProtection(unitId, subUnitId, ranges);
 
// New API
const worksheet = workbook.getSheetBySheetId(subUnitId);
const permission = worksheet.getWorksheetPermission();
await permission.protectRanges([{ ranges, options: { name: 'Protected', allowEdit: false } }]);

addRangeBaseProtection(
   unitId, 
   subUnitId, 
   ranges, 
   options?): Promise<{
  permissionId: ...;
  ruleId: ...;
}>

// Old API
const workbook = univerAPI.getActiveWorkbook();
const permission = workbook.getPermission();
const unitId = workbook.getId();
const worksheet = workbook.getActiveSheet();
const subUnitId = worksheet.getSheetId();
const range = worksheet.getRange('A1:B2');
const ranges = [];
ranges.push(range);
const res = await permission.addRangeBaseProtection(unitId, subUnitId, ranges, {
  name: 'Protected Area',
  allowEdit: false
});
const {permissionId, ruleId} = res;
console.log('debugger', permissionId, ruleId);
 
// New API (recommended)
const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
const permission = worksheet.getWorksheetPermission();
const range = worksheet.getRange('A1:B2');
await permission.protectRanges([{
  ranges: [range],
  options: { name: 'Protected Area', allowEdit: false }
}]);

addWorksheetBasePermission(
   unitId, 
   subUnitId, 
options?): Promise<string>

const workbook = univerAPI.getActiveWorkbook();
const permission = workbook.getPermission();
const unitId = workbook.getId();
const worksheet = workbook.getActiveSheet();
const subUnitId = worksheet.getSheetId();
// Note that there will be no permission changes after this step is completed. It only returns an ID for subsequent permission changes.
// For details, please see the example of the **`setWorksheetPermissionPoint`** API.
const permissionId = await permission.addWorksheetBasePermission(unitId, subUnitId, {
  allowedUsers: ['user1', 'user2'],
  name: 'My Protection'
})
// Can still edit and read it.
console.log('debugger', permissionId)

checkWorkbookPermissionPoint(unitId, FPointClass): boolean

const workbook = univerAPI.getActiveWorkbook();
const permission = workbook.getPermission();
const unitId = workbook.getId();
// Check if the workbook is editable
const isEditable = permission.checkWorkbookPermissionPoint(unitId, permission.permissionPointsDefinition.WorkbookEditablePermission);
console.log('Workbook is editable:', isEditable);

checkWorksheetPermissionPoint(
   unitId, 
   subUnitId, 
   FPointClass): boolean

const workbook = univerAPI.getActiveWorkbook();
const permission = workbook.getPermission();
const unitId = workbook.getId();
const worksheet = workbook.getActiveSheet();
const subUnitId = worksheet.getSheetId();
// Check if the worksheet is editable
const isEditable = permission.checkWorksheetPermissionPoint(unitId, subUnitId, permission.permissionPointsDefinition.WorksheetEditPermission);
console.log('Worksheet is editable:', isEditable);

getPermissionInfoWithCell(
   unitId, 
   subUnitId, 
   row, 
   column): {
  permissionId: string;
  ruleId: string;
}

{
  permissionId: string;
  ruleId: string;
}

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const permission = fWorkbook.getPermission();
const unitId = fWorkbook.getId();
const subUnitId = fWorksheet.getSheetId();
 
// Get the permission information for cell C3
const cell = fWorksheet.getRange('C3');
const permissionInfo = permission.getPermissionInfoWithCell(
  unitId,
  subUnitId,
  cell.getRow(),
  cell.getColumn()
);
console.log(permissionInfo);
 
// If the cell is protected, you can remove the protection like this:
if (permissionInfo) {
  const { ruleId } = permissionInfo;
 
  // After 2 seconds, remove the protection for the cell
  setTimeout(() => {
    permission.removeRangeProtection(unitId, subUnitId, [ruleId]);
  }, 2000);
}

removeRangeProtection(
   unitId, 
   subUnitId, 
   ruleIds): void

// Old API
const workbook = univerAPI.getActiveWorkbook();
const permission = workbook.getPermission();
const unitId = workbook.getId();
const worksheet = workbook.getActiveSheet();
const subUnitId = worksheet.getSheetId();
const range = worksheet.getRange('A1:B2');
const ranges = [];
ranges.push(range);
const res = await permission.addRangeBaseProtection(unitId, subUnitId, ranges);
const ruleId = res.ruleId;
permission.removeRangeProtection(unitId, subUnitId, [ruleId]);
 
// New API (recommended)
const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
const permission = worksheet.getWorksheetPermission();
await permission.unprotectRules([ruleId]);

removeWorksheetPermission(unitId, subUnitId): void

const workbook = univerAPI.getActiveWorkbook();
const permission = workbook.getPermission();
const unitId = workbook.getId();
const worksheet = workbook.getActiveSheet();
const subUnitId = worksheet.getSheetId();
permission.removeWorksheetPermission(unitId, subUnitId);

setPermissionDialogVisible(visible): void

const fWorkbook = univerAPI.getActiveWorkbook();
const permission = fWorkbook.getPermission();
permission.setPermissionDialogVisible(false);

setRangeProtectionPermissionPoint(
   unitId, 
   subUnitId, 
   permissionId, 
   FPointClass, 
   value): void

const workbook = univerAPI.getActiveWorkbook();
const permission = workbook.getPermission();
const unitId = workbook.getId();
const worksheet = workbook.getActiveSheet();
const subUnitId = worksheet.getSheetId();
const range = worksheet.getRange('A1:B2');
const ranges = [];
ranges.push(range);
// Note that there will be no permission changes after this step is completed. It only returns an ID for subsequent permission changes.
// For details, please see the example of the **`setRangeProtectionPermissionPoint`** API.
const res = await permission.addRangeBaseProtection(unitId, subUnitId, ranges);
const {permissionId, ruleId} = res;
// After passing the following line of code, the range set above will become uneditable
permission.setRangeProtectionPermissionPoint(unitId,subUnitId,permissionId, permission.permissionPointsDefinition.RangeProtectionPermissionEditPoint, false);

setRangeProtectionRanges(
   unitId, 
   subUnitId, 
   ruleId, 
   ranges): void

const workbook = univerAPI.getActiveWorkbook();
const permission = workbook.getPermission();
const unitId = workbook.getId();
const worksheet = workbook.getActiveSheet();
const subUnitId = worksheet.getSheetId();
const range = worksheet.getRange('A1:B2');
const ranges = [];
ranges.push(range);
const res = await permission.addRangeBaseProtection(unitId, subUnitId, ranges);
const {permissionId, ruleId} = res;
const newRange = worksheet.getRange('C1:D2');
permission.setRangeProtectionRanges(unitId, subUnitId, ruleId, [newRange]);

setWorkbookEditPermission(unitId, value): void

const workbook = univerAPI.getActiveWorkbook();
const permission = workbook.getPermission();
const unitId = workbook.getId();
permission.setWorkbookEditPermission(unitId, false);

setWorkbookPermissionPoint(
   unitId, 
   FPointClass, 
   value): void

const workbook = univerAPI.getActiveWorkbook();
const permission = workbook.getPermission();
const unitId = workbook.getId();
permission.setWorkbookPermissionPoint(unitId, permission.permissionPointsDefinition.WorkbookEditablePermission, false)

setWorksheetPermissionPoint(
   unitId, 
   subUnitId, 
   FPointClass, 
value): Promise<string>

const workbook = univerAPI.getActiveWorkbook();
const permission = workbook.getPermission();
const unitId = workbook.getId();
const worksheet = workbook.getActiveSheet();
const subUnitId = worksheet.getSheetId();
const permissionId = await permission.addWorksheetBasePermission(unitId, subUnitId)
// After this line of code , the worksheet will no longer be editable
permission.setWorksheetPermissionPoint(unitId, subUnitId, permission.permissionPointsDefinition.WorksheetEditPermission, false);