@univerjs/sheets 0.24.0 → 0.25.0

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

@@ -42,7 +42,8 @@ export declare class FRangePermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('A1:B2');
      * // Check if the A1:B2 range is protected
      * const isProtected = fRange.getRangePermission().isProtected();
@@ -57,7 +58,8 @@ export declare class FRangePermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('A1:B2');
      * const rule = await fRange.getRangePermission().protect({
      *   name: 'My protected range',
@@ -74,7 +76,8 @@ export declare class FRangePermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('A1:B2');
      * const result = await fRange.getRangePermission().unprotect();
      * console.log(result);
@@ -87,7 +90,8 @@ export declare class FRangePermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('A1:B2');
      * const rules = await fRange.getRangePermission().listRules();
      * console.log(rules);

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

@@ -60,7 +60,8 @@ export declare class FRangeProtectionRule {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
      * // Update the ranges to A1:C3 for the first rule
      * if (rules.length > 0) {
@@ -77,7 +78,8 @@ export declare class FRangeProtectionRule {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
      * // Remove the first protection rule
      * if (rules.length > 0) {
@@ -108,7 +110,8 @@ export declare class FRangeProtectionRule {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('A1:B2');
      * // First, create a protection rule
      * const rule = await fRange.getRangePermission().protect({ name: 'My Range', allowEdit: true });
@@ -125,7 +128,8 @@ export declare class FRangeProtectionRule {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
      * // Check if the first rule allows editing
      * if (rules.length > 0) {
@@ -142,7 +146,8 @@ export declare class FRangeProtectionRule {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
      * // Check if the first rule allows editing
      * const rule = rules[0];
@@ -158,7 +163,8 @@ export declare class FRangeProtectionRule {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
      * // Check if the first rule allows viewing
      * const rule = rules[0];
@@ -174,7 +180,8 @@ export declare class FRangeProtectionRule {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
      * // Check if the first rule allows managing collaborators
      * const rule = rules[0];
@@ -190,7 +197,8 @@ export declare class FRangeProtectionRule {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
      * // Check if the first rule allows deleting the rule
      * const rule = rules[0];
@@ -206,7 +214,8 @@ export declare class FRangeProtectionRule {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
      * // Get the permission snapshot of the first rule
      * if (rules.length > 0) {

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

@@ -45,7 +45,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * if (fWorksheet.getWorksheetPermission().isProtected()) {
      *   console.log('Worksheet is protected');
      * }
@@ -60,7 +61,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const permission = fWorksheet.getWorksheetPermission();
      *
      * // Create worksheet protection with collaborators
@@ -81,7 +83,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * await fWorksheet.getWorksheetPermission().unprotect();
      * ```
      */
@@ -94,7 +97,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * await fWorksheet.getWorksheetPermission().setMode('readOnly');
      * ```
      */
@@ -110,7 +114,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * await fWorksheet.getWorksheetPermission().setReadOnly();
      * ```
      */
@@ -121,7 +126,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * await fWorksheet.getWorksheetPermission().setEditable();
      * ```
      */
@@ -135,7 +141,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const permission = fWorksheet.getWorksheetPermission();
      * await permission.setPoint(univerAPI.Enum.WorksheetPermissionPoint.InsertRow, false);
      * ```
@@ -147,7 +154,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * if (fWorksheet.getWorksheetPermission().canEdit()) {
      *   console.log('Worksheet is editable');
      * }
@@ -162,7 +170,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Check if cell C3 can be edited
      * const fRange = fWorksheet.getRange('C3');
      * const canEdit = fWorksheet.getWorksheetPermission().canEditCell(fRange.getRow(), fRange.getColumn());
@@ -176,7 +185,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * if (fWorksheet.getWorksheetPermission().canView()) {
      *   console.log('Worksheet is viewable');
      * }
@@ -190,7 +200,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Check if cell C3 can be viewed
      * const fRange = fWorksheet.getRange('C3');
      * const canView = fWorksheet.getWorksheetPermission().canViewCell(fRange.getRow(), fRange.getColumn());
@@ -205,7 +216,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const permission = fWorksheet.getWorksheetPermission();
      * const canInsertRow = permission.getPoint(univerAPI.Enum.WorksheetPermissionPoint.InsertRow);
      * console.log(canInsertRow);
@@ -218,7 +230,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const snapshot = fWorksheet.getWorksheetPermission().getSnapshot();
      * console.log(snapshot);
      * ```
@@ -230,7 +243,8 @@ export declare class FWorksheetPermission extends FBase {
      * @returns {Promise<void>} A promise that resolves when the configuration is applied.
      * @example
      * ```ts
-     * const worksheet = univerAPI.getActiveWorkbook()?.getActiveSheet();
+     * const worksheet = univerAPI.getActiveWorkbook()?.getSheetByName('Sheet1');
+     * if (!worksheet) return;
      * const permission = worksheet?.getWorksheetPermission();
      * await permission?.applyConfig({
      *   mode: 'readOnly',
@@ -249,7 +263,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const rules = await fWorksheet.getWorksheetPermission().protectRanges([
      *   {
      *     ranges: [fWorksheet.getRange('A1:B2')],
@@ -274,7 +289,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const worksheetPermission = fWorksheet.getWorksheetPermission();
      * const rules = await worksheetPermission.listRangeProtectionRules();
      * // Unprotect the first rule as an example
@@ -291,7 +307,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
      * console.log(rules);
      * ```
@@ -307,7 +324,8 @@ export declare class FWorksheetPermission extends FBase {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Get debug info for cell C3
      * const fRange = fWorksheet.getRange('C3');
      * const debugInfo = await fWorksheet.getWorksheetPermission().debugCellPermission(fRange.getRow(), fRange.getColumn());

package/lib/types/index.d.ts

@@ -23,7 +23,7 @@ export { createTopMatrixFromMatrix, createTopMatrixFromRanges, findAllRectangle,
 export { convertPrimaryWithCoordToPrimary, convertSelectionDataToRange, type ISelectionStyle, type ISelectionWidgetConfig, type ISelectionWithCoord, type ISelectionWithStyle, type ISheetRangeLocation, SELECTION_CONTROL_BORDER_BUFFER_COLOR, SELECTION_CONTROL_BORDER_BUFFER_WIDTH, } from './basics/selection';
 export { SplitDelimiterEnum, splitRangeText } from './basics/split-range-text';
 export { findFirstNonEmptyCell } from './basics/utils';
-export { discreteRangeToRange, generateNullCell, generateNullCellValue, getVisibleRanges, rangeToDiscreteRange } from './basics/utils';
+export { deserializeListOptions, discreteRangeToRange, generateNullCell, generateNullCellValue, getVisibleRanges, rangeToDiscreteRange, serializeListOptions } from './basics/utils';
 export { AddRangeProtectionCommand, type IAddRangeProtectionCommandParams } from './commands/commands/add-range-protection.command';
 export { addMergeCellsUtil, AddWorksheetMergeAllCommand, AddWorksheetMergeCommand, AddWorksheetMergeHorizontalCommand, AddWorksheetMergeVerticalCommand, getClearContentMutationParamForRange, getClearContentMutationParamsForRanges, type IAddMergeCommandParams, type IMergeCellsUtilOptions, } from './commands/commands/add-worksheet-merge.command';
 export { AddWorksheetProtectionCommand } from './commands/commands/add-worksheet-protection.command';

package/lib/types/locale/ar-SA.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/de-DE.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/en-US.d.ts

@@ -25,6 +25,45 @@ declare const locale: {
             partOfCell: string;
             hideSheet: string;
         };
+        definedName: {
+            nameEmpty: string;
+            nameDuplicate: string;
+            nameInvalid: string;
+            nameSheetConflict: string;
+            formulaOrRefStringEmpty: string;
+            nameConflict: string;
+            defaultName: string;
+        };
+        permission: {
+            dialog: {
+                autoFillErr: string;
+                editErr: string;
+                formulaErr: string;
+                insertOrDeleteMoveRangeErr: string;
+                insertRowColErr: string;
+                moveRangeErr: string;
+                moveRowColErr: string;
+                operatorSheetErr: string;
+                removeRowColErr: string;
+                setRowColStyleErr: string;
+                setStyleErr: string;
+            };
+        };
+        autoFill: {
+            copy: string;
+            series: string;
+            formatOnly: string;
+            noFormat: string;
+        };
+        merge: {
+            confirm: {
+                title: string;
+                cancel: string;
+                confirm: string;
+                warning: string;
+                dismantleMergeCellWarning: string;
+            };
+        };
     };
 };
 export default locale;

package/lib/types/locale/id-ID.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/it-IT.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/pl-PL.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/pt-BR.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/zh-HK.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;