@univerjs/sheets 0.12.1 → 0.12.2-nightly.202511241159

package/lib/types/commands/mutations/set-worksheet-col-width.mutation.d.ts

@@ -1,13 +1,9 @@
 import { IMutation, IObjectArrayPrimitiveType, IRange, Nullable, Worksheet } from '@univerjs/core';
-import { PackedNumberMap } from '../utils/pack-number-map';
 export interface ISetWorksheetColWidthMutationParams {
     unitId: string;
     subUnitId: string;
     ranges: IRange[];
-    colWidth: number | IObjectArrayPrimitiveType<Nullable<number>> | {
-        compress: true;
-        data: PackedNumberMap;
-    };
+    colWidth: number | IObjectArrayPrimitiveType<Nullable<number>>;
 }
 /**
  * This factory is for generating undo mutations for command {@link DeltaColumnWidthCommand}.

package/lib/types/commands/mutations/set-worksheet-row-height.mutation.d.ts

@@ -1,13 +1,9 @@
 import { BooleanNumber, IMutation, IObjectArrayPrimitiveType, IRange, IRowAutoHeightInfo, Nullable, Worksheet } from '@univerjs/core';
-import { PackedNumberMap } from '../utils/pack-number-map';
 export interface ISetWorksheetRowHeightMutationParams {
     unitId: string;
     subUnitId: string;
     ranges: IRange[];
-    rowHeight: number | IObjectArrayPrimitiveType<Nullable<number>> | {
-        compress: true;
-        data: PackedNumberMap;
-    };
+    rowHeight: number | IObjectArrayPrimitiveType<Nullable<number>>;
 }
 export interface ISetWorksheetRowIsAutoHeightMutationParams {
     unitId: string;

package/lib/types/facade/f-enum.d.ts

@@ -1,4 +1,5 @@
 import { SheetSkeletonChangeType, SheetValueChangeType, SplitDelimiterEnum } from '@univerjs/sheets';
+import { RangePermissionPoint, UnitRole, WorkbookPermissionPoint, WorksheetPermissionPoint } from './permission';
 /**
  * @ignore
  */
@@ -17,11 +18,31 @@ export interface IFSheetsEnum {
      * Split delimiter types.
      */
     SplitDelimiterType: typeof SplitDelimiterEnum;
+    /**
+     * Unit roles.
+     */
+    UnitRole: typeof UnitRole;
+    /**
+     * Workbook permission points.
+     */
+    WorkbookPermissionPoint: typeof WorkbookPermissionPoint;
+    /**
+     * Worksheet permission points.
+     */
+    WorksheetPermissionPoint: typeof WorksheetPermissionPoint;
+    /**
+     * Range permission points.
+     */
+    RangePermissionPoint: typeof RangePermissionPoint;
 }
 export declare class FSheetsEnum implements IFSheetsEnum {
     get SheetValueChangeType(): typeof SheetValueChangeType;
     get SheetSkeletonChangeType(): typeof SheetSkeletonChangeType;
     get SplitDelimiterType(): typeof SplitDelimiterEnum;
+    get UnitRole(): typeof UnitRole;
+    get WorkbookPermissionPoint(): typeof WorkbookPermissionPoint;
+    get WorksheetPermissionPoint(): typeof WorksheetPermissionPoint;
+    get RangePermissionPoint(): typeof RangePermissionPoint;
 }
 declare module '@univerjs/core/facade' {
     interface FEnum extends IFSheetsEnum {

package/lib/types/facade/permission/f-range-permission.d.ts

@@ -65,7 +65,7 @@ export declare class FRangePermission implements IRangePermission {
      * ```ts
      * const range = univerAPI.getActiveWorkbook()?.getActiveSheet()?.getRange('A1:B2');
      * const permission = range?.getRangePermission();
-     * const canEdit = permission?.getPoint(RangePermissionPoint.Edit);
+     * const canEdit = permission?.getPoint(univerAPI.Enum.RangePermissionPoint.Edit);
      * console.log(canEdit);
      * ```
      */
@@ -158,8 +158,8 @@ export declare class FRangePermission implements IRangePermission {
      * const range = univerAPI.getActiveWorkbook()?.getActiveSheet()?.getRange('A1:B2');
      * const permission = range?.getRangePermission();
      * // Can set permission points without calling protect() first (local-only mode)
-     * await permission?.setPoint(RangePermissionPoint.Edit, false); // Disable edit
-     * await permission?.setPoint(RangePermissionPoint.View, true);  // Enable view
+     * await permission?.setPoint(univerAPI.Enum.RangePermissionPoint.Edit, false); // Disable edit
+     * await permission?.setPoint(univerAPI.Enum.RangePermissionPoint.View, true);  // Enable view
      * ```
      */
     setPoint(point: RangePermissionPoint, value: boolean): Promise<void>;

package/lib/types/facade/permission/f-range-protection-rule.d.ts

@@ -25,7 +25,7 @@ export declare class FRangeProtectionRule implements IRangeProtectionRule {
      * @example
      * ```ts
      * const worksheet = univerAPI.getActiveWorkbook()?.getActiveSheet();
-     * const permission = worksheet?.permission();
+     * const permission = worksheet?.getWorksheetPermission();
      * const rules = await permission?.listRangeProtectionRules();
      * const ruleId = rules?.[0]?.id;
      * console.log(ruleId);
@@ -38,7 +38,7 @@ export declare class FRangeProtectionRule implements IRangeProtectionRule {
      * @example
      * ```ts
      * const worksheet = univerAPI.getActiveWorkbook()?.getActiveSheet();
-     * const permission = worksheet?.permission();
+     * const permission = worksheet?.getWorksheetPermission();
      * const rules = await permission?.listRangeProtectionRules();
      * const ranges = rules?.[0]?.ranges;
      * console.log(ranges);
@@ -51,7 +51,7 @@ export declare class FRangeProtectionRule implements IRangeProtectionRule {
      * @example
      * ```ts
      * const worksheet = univerAPI.getActiveWorkbook()?.getActiveSheet();
-     * const permission = worksheet?.permission();
+     * const permission = worksheet?.getWorksheetPermission();
      * const rules = await permission?.listRangeProtectionRules();
      * const options = rules?.[0]?.options;
      * console.log(options);
@@ -65,7 +65,7 @@ export declare class FRangeProtectionRule implements IRangeProtectionRule {
      * @example
      * ```ts
      * const worksheet = univerAPI.getActiveWorkbook()?.getActiveSheet();
-     * const permission = worksheet?.permission();
+     * const permission = worksheet?.getWorksheetPermission();
      * const rules = await permission?.listRangeProtectionRules();
      * const rule = rules?.[0];
      * await rule?.updateRanges([worksheet.getRange('A1:C3')]);
@@ -79,7 +79,7 @@ export declare class FRangeProtectionRule implements IRangeProtectionRule {
      * @example
      * ```ts
      * const worksheet = univerAPI.getActiveWorkbook()?.getActiveSheet();
-     * const permission = worksheet?.permission();
+     * const permission = worksheet?.getWorksheetPermission();
      * const rules = await permission?.listRangeProtectionRules();
      * const rule = rules?.[0];
      * await rule?.updateOptions({ name: 'New Protection Name', allowEdit: true });
@@ -92,7 +92,7 @@ export declare class FRangeProtectionRule implements IRangeProtectionRule {
      * @example
      * ```ts
      * const worksheet = univerAPI.getActiveWorkbook()?.getActiveSheet();
-     * const permission = worksheet?.permission();
+     * const permission = worksheet?.getWorksheetPermission();
      * const rules = await permission?.listRangeProtectionRules();
      * const rule = rules?.[0];
      * await rule?.remove();

package/lib/types/facade/permission/f-workbook-permission.d.ts

@@ -126,7 +126,7 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
      * const permission = workbook?.getWorkbookPermission();
-     * await permission?.setPoint(WorkbookPermissionPoint.Print, false);
+     * await permission?.setPoint(univerAPI.Enum.WorkbookPermissionPoint.Print, false);
      * ```
      */
     setPoint(point: WorkbookPermissionPoint, value: boolean): Promise<void>;
@@ -138,7 +138,7 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
      * const permission = workbook?.getWorkbookPermission();
-     * const canPrint = permission?.getPoint(WorkbookPermissionPoint.Print);
+     * const canPrint = permission?.getPoint(univerAPI.Enum.WorkbookPermissionPoint.Print);
      * console.log(canPrint);
      * ```
      */
@@ -166,11 +166,11 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * await permission?.setCollaborators([
      *   {
      *     user: { userID: 'user1', name: 'John Doe', avatar: 'https://...' },
-     *     role: UnitRole.Editor
+     *     role: univerAPI.Enum.UnitRole.Editor
      *   },
      *   {
      *     user: { userID: 'user2', name: 'Jane Smith', avatar: '' },
-     *     role: UnitRole.Reader
+     *     role: univerAPI.Enum.UnitRole.Reader
      *   }
      * ]);
      * ```
@@ -190,7 +190,7 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * const permission = workbook?.getWorkbookPermission();
      * await permission?.addCollaborator(
      *   { userID: 'user1', name: 'John Doe', avatar: 'https://...' },
-     *   UnitRole.Editor
+     *   univerAPI.Enum.UnitRole.Editor
      * );
      * ```
      */
@@ -206,7 +206,7 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * const permission = workbook?.getWorkbookPermission();
      * await permission?.updateCollaborator(
      *   { userID: 'user1', name: 'John Doe Updated', avatar: 'https://...' },
-     *   UnitRole.Reader
+     *   univerAPI.Enum.UnitRole.Reader
      * );
      * ```
      */

package/lib/types/facade/permission/f-worksheet-permission.d.ts

@@ -196,7 +196,7 @@ export declare class FWorksheetPermission implements IWorksheetPermission {
      * ```ts
      * const worksheet = univerAPI.getActiveWorkbook()?.getActiveSheet();
      * const permission = worksheet?.getWorksheetPermission();
-     * await permission?.setPoint(WorksheetPermissionPoint.InsertRow, false);
+     * await permission?.setPoint(univerAPI.Enum.WorksheetPermissionPoint.InsertRow, false);
      * ```
      */
     setPoint(point: WorksheetPermissionPoint, value: boolean): Promise<void>;
@@ -208,7 +208,7 @@ export declare class FWorksheetPermission implements IWorksheetPermission {
      * ```ts
      * const worksheet = univerAPI.getActiveWorkbook()?.getActiveSheet();
      * const permission = worksheet?.getWorksheetPermission();
-     * const canInsertRow = permission?.getPoint(WorksheetPermissionPoint.InsertRow);
+     * const canInsertRow = permission?.getPoint(univerAPI.Enum.WorksheetPermissionPoint.InsertRow);
      * console.log(canInsertRow);
      * ```
      */
@@ -236,8 +236,8 @@ export declare class FWorksheetPermission implements IWorksheetPermission {
      * await permission?.applyConfig({
      *   mode: 'readOnly',
      *   points: {
-     *     [WorksheetPermissionPoint.View]: true,
-     *     [WorksheetPermissionPoint.Edit]: false
+     *     [univerAPI.Enum.WorksheetPermissionPoint.View]: true,
+     *     [univerAPI.Enum.WorksheetPermissionPoint.Edit]: false
      *   }
      * });
      * ```
@@ -254,11 +254,11 @@ export declare class FWorksheetPermission implements IWorksheetPermission {
      * const rules = await permission?.protectRanges([
      *   {
      *     ranges: [worksheet.getRange('A1:B2')],
-     *     options: { name: 'Protected Area 1', allowEdit: false, allowView: true }
+     *     options: { name: 'Protected Area 1', allowEdit: false, allowViewByOthers: true }
      *   },
      *   {
      *     ranges: [worksheet.getRange('C3:D4')],
-     *     options: { name: 'Protected Area 2', allowEdit: true, allowView: false }
+     *     options: { name: 'Protected Area 2', allowEdit: true, allowViewByOthers: false }
      *   }
      * ]);
      * console.log(rules);

package/lib/types/index.d.ts

@@ -152,7 +152,6 @@ export { handleDeleteRangeMutation } from './commands/utils/handle-range-mutatio
 export { getInsertRangeMutations, getRemoveRangeMutations } from './commands/utils/handle-range-mutation';
 export { handleInsertRangeMutation } from './commands/utils/handle-range-mutation';
 export { type ISheetCommandSharedParams } from './commands/utils/interface';
-export { type IntervalValue, type PackedNumberMap, packNumberMap, unpackNumberMap } from './commands/utils/pack-number-map';
 export { getSelectionsService } from './commands/utils/selection-command-util';
 export { type IUniverSheetsConfig } from './controllers/config.schema';
 export { MAX_CELL_PER_SHEET_KEY } from './controllers/config/config';