@univerjs/sheets 0.4.1 → 0.4.2-nightly.202410301606

package/lib/locale/en-US.js

@@ -0,0 +1,17 @@
+const locale = {
+  sheets: {
+    tabs: {
+      sheetCopy: "(Copy{0})",
+      sheet: "Sheet"
+    },
+    info: {
+      overlappingSelections: "Cannot use that command on overlapping selections",
+      acrossMergedCell: "Across a merged cell",
+      partOfCell: "Only part of a merged cell is selected",
+      hideSheet: "No visible sheet after you hide this"
+    }
+  }
+};
+export {
+  locale as default
+};

package/lib/locale/fa-IR.js

@@ -0,0 +1,17 @@
+const locale = {
+  sheets: {
+    tabs: {
+      sheetCopy: "(کپی{0})",
+      sheet: "برگ"
+    },
+    info: {
+      overlappingSelections: "نمی‌توان از این دستور روی انتخاب‌های همپوشانی استفاده کرد",
+      acrossMergedCell: "در سراسر سلول ادغام شده",
+      partOfCell: "فقط بخشی از سلول ادغام شده انتخاب شده است",
+      hideSheet: "پس از پنهان کردن این برگ، هیچ برگی قابل مشاهده نخواهد بود"
+    }
+  }
+};
+export {
+  locale as default
+};

package/lib/locale/ru-RU.js

@@ -0,0 +1,17 @@
+const locale = {
+  sheets: {
+    tabs: {
+      sheetCopy: "(Копия{0})",
+      sheet: "Лист"
+    },
+    info: {
+      overlappingSelections: "Невозможно использовать эту команду на пересекающихся выделениях",
+      acrossMergedCell: "Через объединенную ячейку",
+      partOfCell: "Выделена только часть объединенной ячейки",
+      hideSheet: "После скрытия этого листа не будет видно ни одного листа"
+    }
+  }
+};
+export {
+  locale as default
+};

package/lib/locale/vi-VN.js

@@ -0,0 +1,17 @@
+const locale = {
+  sheets: {
+    tabs: {
+      sheetCopy: "（Bản sao {0}）",
+      sheet: "Bảng tính"
+    },
+    info: {
+      overlappingSelections: "Không thể sử dụng lệnh này trên các vùng chọn chồng chéo nhau",
+      acrossMergedCell: "Không thể vượt qua các ô đã hợp nhất",
+      partOfCell: "Chỉ chọn một phần của ô đã hợp nhất",
+      hideSheet: "Không có bảng tính nào hiển thị sau khi ẩn"
+    }
+  }
+};
+export {
+  locale as default
+};

package/lib/locale/zh-CN.js

@@ -0,0 +1,17 @@
+const locale = {
+  sheets: {
+    tabs: {
+      sheetCopy: "（副本{0}）",
+      sheet: "工作表"
+    },
+    info: {
+      overlappingSelections: "无法对重叠选区使用该命令",
+      acrossMergedCell: "无法跨越合并单元格",
+      partOfCell: "仅选择了合并单元格的一部分",
+      hideSheet: "隐藏后无可见工作表"
+    }
+  }
+};
+export {
+  locale as default
+};

package/lib/locale/zh-TW.js

@@ -0,0 +1,17 @@
+const locale = {
+  sheets: {
+    tabs: {
+      sheetCopy: "（副本{0}）",
+      sheet: "工作表"
+    },
+    info: {
+      overlappingSelections: "無法對重疊選區使用該命令",
+      acrossMergedCell: "無法跨越合併儲存格",
+      partOfCell: "僅選擇了合併儲存格的一部份",
+      hideSheet: "隱藏後無可見工作表"
+    }
+  }
+};
+export {
+  locale as default
+};

package/lib/types/basics/row-column-value.d.ts

@@ -0,0 +1,14 @@
+import { IColumnData, IRowData, Nullable } from '@univerjs/core';
+/**
+ * Reset the row data to undefined when undoing the operation
+ * @param currentRow
+ * @returns
+ */
+export declare function getOldRowData(currentRow: Nullable<Partial<IRowData>>, newRow: Nullable<Partial<IRowData>>): Nullable<Partial<IRowData>>;
+/**
+ * Reset the column data to undefined when undoing the operation
+ * @param currenColumn
+ * @param newColumn
+ * @returns
+ */
+export declare function getOldColumnData(currenColumn: Nullable<Partial<IColumnData>>, newColumn: Nullable<Partial<IColumnData>>): Nullable<Partial<IColumnData>>;

package/lib/types/commands/commands/__tests__/set-col-data.command.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/commands/commands/__tests__/set-row-data.command.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/commands/commands/__tests__/set-worksheet-default-style.command.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/commands/commands/set-col-data.command.d.ts

@@ -0,0 +1,7 @@
+import { IColumnData, ICommand, IObjectArrayPrimitiveType, Nullable } from '@univerjs/core';
+import { ISheetCommandSharedParams } from '../utils/interface';
+export type IColumnProperties = Omit<IColumnData, 'w' | 'hd'>;
+export interface ISetColDataCommandParams extends Partial<ISheetCommandSharedParams> {
+    columnData: IObjectArrayPrimitiveType<Nullable<IColumnProperties>>;
+}
+export declare const SetColDataCommand: ICommand;

package/lib/types/commands/commands/set-frozen.command.d.ts

@@ -1,2 +1,15 @@
 import { ICommand } from '@univerjs/core';
+export interface ISetFrozenCommandParams {
+    startRow: number;
+    startColumn: number;
+    ySplit: number;
+    xSplit: number;
+    unitId?: string;
+    subUnitId?: string;
+}
 export declare const SetFrozenCommand: ICommand;
+export interface ICancelFrozenCommandParams {
+    unitId?: string;
+    subUnitId?: string;
+}
+export declare const CancelFrozenCommand: ICommand<ICancelFrozenCommandParams>;

package/lib/types/commands/commands/set-row-data.command.d.ts

@@ -0,0 +1,7 @@
+import { ICommand, IObjectArrayPrimitiveType, IRowData, Nullable } from '@univerjs/core';
+import { ISheetCommandSharedParams } from '../utils/interface';
+export type IRowProperties = Omit<IRowData, 'h' | 'ia' | 'ah' | 'hd'>;
+export interface ISetRowDataCommandParams extends Partial<ISheetCommandSharedParams> {
+    rowData: IObjectArrayPrimitiveType<Nullable<IRowProperties>>;
+}
+export declare const SetRowDataCommand: ICommand;

package/lib/types/commands/commands/set-style.command.d.ts

@@ -46,7 +46,7 @@ export interface ISetFontSizeCommandParams {
 }
 export declare const SetFontSizeCommand: ICommand<ISetFontSizeCommandParams>;
 export interface ISetColorCommandParams {
-    value: string;
+    value: string | null;
 }
 export declare const SetTextColorCommand: ICommand<ISetColorCommandParams>;
 export declare const ResetTextColorCommand: ICommand;

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

@@ -11,3 +11,9 @@ export interface ISetColWidthCommandParams {
     value: number;
 }
 export declare const SetColWidthCommand: ICommand;
+export interface ISetWorksheetColIsAutoWidthCommandParams {
+    unitId?: string;
+    subUnitId?: string;
+    ranges?: IRange[];
+}
+export declare const SetWorksheetColIsAutoWidthCommand: ICommand;

package/lib/types/commands/commands/set-worksheet-default-style.command.d.ts

@@ -0,0 +1,2 @@
+import { ICommand } from '@univerjs/core';
+export declare const SetWorksheetDefaultStyleCommand: ICommand;

package/lib/types/commands/commands/toggle-gridlines.command.d.ts

@@ -0,0 +1,7 @@
+import { ICommand, BooleanNumber } from '@univerjs/core';
+export interface IToggleGridlinesCommandParams {
+    showGridlines?: BooleanNumber;
+    unitId?: string;
+    subUnitId?: string;
+}
+export declare const ToggleGridlinesCommand: ICommand;

package/lib/types/commands/mutations/add-range-protection.mutation.d.ts

@@ -1,6 +1,6 @@
 import { IMutation, IMutationInfo } from '@univerjs/core';
 import { IRangeProtectionRule } from '../../model/range-protection-rule.model';
-import { IDeleteSelectionProtectionMutationParams } from './delete-range-protection.mutation';
+import { IDeleteRangeProtectionMutationParams } from './delete-range-protection.mutation';
 export interface IAddRangeProtectionMutationParams {
     rules: IRangeProtectionRule[];
     unitId: string;
@@ -8,5 +8,5 @@ export interface IAddRangeProtectionMutationParams {
     name?: string;
     description?: string;
 }
-export declare const FactoryAddRangeProtectionMutation: (param: IAddRangeProtectionMutationParams) => IMutationInfo<IDeleteSelectionProtectionMutationParams>;
+export declare const FactoryAddRangeProtectionMutation: (param: IAddRangeProtectionMutationParams) => IMutationInfo<IDeleteRangeProtectionMutationParams>;
 export declare const AddRangeProtectionMutation: IMutation<IAddRangeProtectionMutationParams>;

package/lib/types/commands/mutations/delete-range-protection.mutation.d.ts

@@ -1,9 +1,9 @@
 import { IAccessor, IMutation, IMutationInfo } from '@univerjs/core';
 import { IAddRangeProtectionMutationParams } from './add-range-protection.mutation';
-export interface IDeleteSelectionProtectionMutationParams {
+export interface IDeleteRangeProtectionMutationParams {
     ruleIds: string[];
     unitId: string;
     subUnitId: string;
 }
-export declare const FactoryDeleteRangeProtectionMutation: (accessor: IAccessor, param: IDeleteSelectionProtectionMutationParams) => IMutationInfo<Omit<IAddRangeProtectionMutationParams, "name">>;
-export declare const DeleteRangeProtectionMutation: IMutation<IDeleteSelectionProtectionMutationParams>;
+export declare const FactoryDeleteRangeProtectionMutation: (accessor: IAccessor, param: IDeleteRangeProtectionMutationParams) => IMutationInfo<Omit<IAddRangeProtectionMutationParams, "name">>;
+export declare const DeleteRangeProtectionMutation: IMutation<IDeleteRangeProtectionMutationParams>;

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

@@ -0,0 +1,8 @@
+import { IColumnData, IMutation, IObjectArrayPrimitiveType, Nullable, Worksheet } from '@univerjs/core';
+export interface ISetColDataMutationParams {
+    unitId: string;
+    subUnitId: string;
+    columnData: IObjectArrayPrimitiveType<Nullable<IColumnData>>;
+}
+export declare const SetColDataMutationFactory: (params: ISetColDataMutationParams, worksheet: Worksheet) => ISetColDataMutationParams;
+export declare const SetColDataMutation: IMutation<ISetColDataMutationParams>;

package/lib/types/commands/mutations/set-frozen.mutation.d.ts

@@ -4,7 +4,15 @@ export interface ISetFrozenMutationParams {
     subUnitId: string;
     startRow: number;
     startColumn: number;
+    /**
+     * Number of frozen rows.
+     * if row freeze start at 7, end at 10, then ySplit is 3
+     */
     ySplit: number;
+    /**
+     * Number of frozen columns.
+     * if column freeze start at 7, end at 10, then xSplit is 3
+     */
     xSplit: number;
     resetScroll?: boolean;
 }

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

@@ -0,0 +1,8 @@
+import { IMutation, IObjectArrayPrimitiveType, IRowData, Nullable, Worksheet } from '@univerjs/core';
+export interface ISetRowDataMutationParams {
+    unitId: string;
+    subUnitId: string;
+    rowData: IObjectArrayPrimitiveType<Nullable<IRowData>>;
+}
+export declare const SetRowDataMutationFactory: (params: ISetRowDataMutationParams, worksheet: Worksheet) => ISetRowDataMutationParams;
+export declare const SetRowDataMutation: IMutation<ISetRowDataMutationParams>;

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

@@ -12,4 +12,7 @@ export interface ISetWorksheetColWidthMutationParams {
  * for each column in the range.
  */
 export declare const SetWorksheetColWidthMutationFactory: (params: ISetWorksheetColWidthMutationParams, worksheet: Worksheet) => ISetWorksheetColWidthMutationParams;
+/**
+ * Set width of column manually
+ */
 export declare const SetWorksheetColWidthMutation: IMutation<ISetWorksheetColWidthMutationParams>;

package/lib/types/commands/mutations/set-worksheet-default-style.mutation.d.ts

@@ -0,0 +1,12 @@
+import { IAccessor, IMutation, IStyleData, Nullable } from '@univerjs/core';
+export interface ISetWorksheetDefaultStyleMutationParams {
+    unitId: string;
+    subUnitId: string;
+    defaultStyle: string | Nullable<IStyleData>;
+}
+export declare const SetWorksheetDefaultStyleMutation: IMutation<ISetWorksheetDefaultStyleMutationParams>;
+export declare const SetWorksheetDefaultStyleMutationFactory: (accessor: IAccessor, params: ISetWorksheetDefaultStyleMutationParams) => {
+    unitId: string;
+    subUnitId: string;
+    defaultStyle: string | Nullable<IStyleData>;
+};

package/lib/types/commands/mutations/toggle-gridlines.mutation.d.ts

@@ -0,0 +1,7 @@
+import { BooleanNumber, IMutation } from '@univerjs/core';
+export interface IToggleGridlinesMutationParams {
+    showGridlines: BooleanNumber;
+    unitId: string;
+    subUnitId: string;
+}
+export declare const ToggleGridlinesMutation: IMutation<IToggleGridlinesMutationParams>;

package/lib/types/controllers/config.schema.d.ts

@@ -9,5 +9,9 @@ export interface IUniverSheetsConfig {
      * web worker environment or server-side-calculation.
      */
     onlyRegisterFormulaRelatedMutations?: true;
+    /**
+     * If the row style and column style be set both, and the row style should precede the column style or not.
+     */
+    isRowStylePrecedeColumnStyle?: boolean;
 }
 export declare const defaultPluginConfig: IUniverSheetsConfig;

package/lib/types/facade/__tests__/utils.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

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

@@ -0,0 +1,106 @@
+import { IRange, RangePermissionPointConstructor, WorkbookPermissionPointConstructor, WorkSheetPermissionPointConstructor, FBase, IAuthzIoService, ICommandService, Injector, IPermissionService } from '@univerjs/core';
+import { RangeProtectionRuleModel, WorksheetProtectionPointModel, WorksheetProtectionRuleModel } from '@univerjs/sheets';
+export declare class FPermission extends FBase {
+    protected readonly _injector: Injector;
+    protected readonly _commandService: ICommandService;
+    protected readonly _permissionService: IPermissionService;
+    protected readonly _worksheetProtectionRuleModel: WorksheetProtectionRuleModel;
+    protected readonly _rangeProtectionRuleModel: RangeProtectionRuleModel;
+    protected readonly _worksheetProtectionPointRuleModel: WorksheetProtectionPointModel;
+    protected readonly _authzIoService: IAuthzIoService;
+    constructor(_injector: Injector, _commandService: ICommandService, _permissionService: IPermissionService, _worksheetProtectionRuleModel: WorksheetProtectionRuleModel, _rangeProtectionRuleModel: RangeProtectionRuleModel, _worksheetProtectionPointRuleModel: WorksheetProtectionPointModel, _authzIoService: IAuthzIoService);
+    /**
+     * Configures a specific permission point for a workbook.
+     *
+     * This function sets or updates a permission point for a workbook identified by `unitId`.
+     * It creates a new permission point if it does not already exist, and updates the point with the provided value.
+     *
+     * @param {string} unitId - The unique identifier of the workbook for which the permission is being set.
+     * @param {WorkbookPermissionPointConstructor} FPointClass - The constructor function for creating a permission point instance. Other point constructors can See the [permission-point documentation](https://github.com/dream-num/univer/tree/dev/packages/sheets/src/services/permission/permission-point) for more details.
+     * @param {boolean} value - The boolean value to determine whether the permission point is enabled or disabled.
+     *
+     */
+    setWorkbookPermissionPoint(unitId: string, FPointClass: WorkbookPermissionPointConstructor, value: boolean): void;
+    /**
+     * This function is used to set whether the workbook can be edited
+     *
+     * @param {string} unitId - The unique identifier of the workbook for which the permission is being set.
+     * @param {boolean} value - A value that controls whether the workbook can be edited
+     *
+     */
+    setWorkbookEditPermission(unitId: string, value: boolean): void;
+    /**
+     * This function is used to add a base permission for a worksheet.
+     *
+     * @param {string} unitId - The unique identifier of the workbook for which the permission is being set.
+     * @param {string} subUnitId - The unique identifier of the worksheet for which the permission is being set.
+     *
+     * @returns {Promise<string | undefined>} - Returns the `permissionId` if the permission is successfully added. If the operation fails or no result is returned, it resolves to `undefined`.
+     */
+    addWorksheetBasePermission(unitId: string, subUnitId: string): Promise<string | undefined>;
+    /**
+     * Delete the entire table protection set for the worksheet and reset the point permissions of the worksheet to true
+     *
+     * @param {string} unitId - The unique identifier of the workbook for which the permission is being set.
+     * @param {string} subUnitId - The unique identifier of the worksheet for which the permission is being set.
+     */
+    removeWorksheetPermission(unitId: string, subUnitId: string): void;
+    /**
+     * Sets the worksheet permission point by updating or adding the permission point for the worksheet.
+     * If the worksheet doesn't have a base permission, it creates one to used render
+     *
+     * @param {string} unitId - The unique identifier of the workbook.
+     * @param {string} subUnitId - The unique identifier of the worksheet.
+     * @param {WorkSheetPermissionPointConstructor} FPointClass - The constructor for the permission point class.
+     *    See the [permission-point documentation](https://github.com/dream-num/univer/tree/dev/packages/sheets/src/services/permission/permission-point) for more details.
+     * @param {boolean} value - The new permission value to be set for the worksheet.
+     *
+     * @returns {Promise<string | undefined>} - Returns the `permissionId` if the permission point is successfully set or created. If no permission is set, it resolves to `undefined`.
+     */
+    setWorksheetPermissionPoint(unitId: string, subUnitId: string, FPointClass: WorkSheetPermissionPointConstructor, value: boolean): Promise<string | undefined>;
+    /**
+     * Adds a range protection to the worksheet.
+     *
+     * @param {string} unitId - The unique identifier of the workbook.
+     * @param {string} subUnitId - The unique identifier of the worksheet.
+     * @param {IRange[]} ranges - The ranges to be protected.
+     *
+     * @returns {Promise<{ permissionId: string, ruleId: string } | undefined>} - Returns an object containing the `permissionId` and `ruleId` if the range protection is successfully added. If the operation fails or no result is returned, it resolves to `undefined`. permissionId is used to stitch permission point ID，ruleId is used to store permission rules
+     */
+    addRangeBaseProtection(unitId: string, subUnitId: string, ranges: IRange[]): Promise<{
+        permissionId: string;
+        ruleId: string;
+    } | undefined>;
+    /**
+     * Removes the range protection from the worksheet.
+     *
+     * @param {string} unitId - The unique identifier of the workbook.
+     * @param {string} subUnitId - The unique identifier of the worksheet.
+     * @param {string[]} ruleIds - The rule IDs of the range protection to be removed.
+     */
+    removeRangeProtection(unitId: string, subUnitId: string, ruleIds: string[]): void;
+    /**
+     * Modify the permission points of a custom area
+     *
+     * @param {string} unitId - The unique identifier of the workbook.
+     * @param {string} subUnitId - The unique identifier of the worksheet within the workbook.
+     * @param {string} permissionId - The unique identifier of the permission that controls access to the range.
+     * @param {RangePermissionPointConstructor} FPointClass - The constructor for the range permission point class.
+     *    See the [permission-point documentation](https://github.com/dream-num/univer/tree/dev/packages/sheets/src/services/permission/permission-point) for more details.
+     * @param {boolean} value - The new permission value to be set for the range (e.g., true for allowing access, false for restricting access).
+     */
+    setRangeProtectionPermissionPoint(unitId: string, subUnitId: string, permissionId: string, FPointClass: RangePermissionPointConstructor, value: boolean): void;
+    /**
+     * Sets the ranges for range protection in a worksheet.
+     *
+     * This method finds the rule by unitId, subUnitId, and ruleId, and updates the rule with the provided ranges.
+     * It checks for overlaps with existing ranges in the same subunit and shows an error message if any overlap is detected.
+     * If no overlap is found, it executes the command to update the range protection with the new ranges.
+     *
+     * @param {string} unitId - The unique identifier of the workbook.
+     * @param {string} subUnitId - The unique identifier of the worksheet within the workbook.
+     * @param {string} ruleId - The ruleId of the range protection rule that is being updated.
+     * @param {IRange[]} ranges - The array of new ranges to be set for the range protection rule.
+     */
+    setRangeProtectionRanges(unitId: string, subUnitId: string, ruleId: string, ranges: IRange[]): void;
+}