@univerjs/sheets 0.21.1 → 0.22.0

package/README.md

@@ -1,53 +1,41 @@
 # @univerjs/sheets
 
-## Package Overview
-
-| Package Name | UMD Namespace | Version | License | Downloads | Contains CSS | Contains i18n locales |
-| --- | --- | --- | --- | --- | :---: | :---: |
-| `@univerjs/sheets` | `UniverSheets` | [![][npm-version-shield]][npm-version-link] | ![][npm-license-shield] | ![][npm-downloads-shield] | ❌ | ⭕️ |
-
-## Introduction
+[![npm version](https://img.shields.io/npm/v/@univerjs/sheets?style=flat-square)](https://npmjs.com/package/@univerjs/sheets)
+[![license](https://img.shields.io/npm/l/@univerjs/sheets?style=flat-square)](https://npmjs.com/package/@univerjs/sheets)
+[![downloads](https://img.shields.io/npm/dm/@univerjs/sheets?style=flat-square)](https://npmjs.com/package/@univerjs/sheets)
 
-`@univerjs/sheets` serves as the foundation for the core business logic of spreadsheets, with base-sheets designed to be UI-agnostic, allowing for functionality such as collaborative editing to be implemented in a Node.js environment.
+`@univerjs/sheets` provides the core spreadsheet data model and business logic for Univer Sheets, independent of the UI layer.
 
-`@univerjs/sheets` provides the following capabilities for Univer Sheet:
-
-* Core functionality, including numerical formatting, selection management, permissions, etc.
-* Commands/mutations for modifying spreadsheet data
-* Formula core functionality
-* Core numerical formatting functionality
-
-## Usage
+## Package Overview
 
-### Installation
+| Package | UMD global | CSS | Locales | Facade entry |
+| --- | --- | :---: | :---: | :---: |
+| `@univerjs/sheets` | `UniverSheets` | No | Yes | Yes |
 
-```shell
-# Using npm
-npm install @univerjs/sheets
+## Installation
 
-# Using pnpm
+```sh
 pnpm add @univerjs/sheets
+# or
+npm install @univerjs/sheets
 ```
 
-### `SheetInterceptorService`
+Keep all `@univerjs/*` packages on the same version.
 
-`SheetInterceptorService` is a more specialized service provided by `@univerjs/sheets` that allows higher-level business to modify the results of operations such as obtaining cell data, retrieving row/column hiding information from a Worksheet, and supplementing mutations or operations at specific command executions. This service's primary goal is to enable specific functionalities, including:
+## Usage
 
-1. Sheet formulas
-2. Sheet conditional formatting
-3. Sheet data validation
-4. Sheet pivot tables
+```ts
+import EnUS from '@univerjs/sheets/locale/en-US';
+import { UniverSheetsPlugin } from '@univerjs/sheets';
 
-For detailed usage, please refer to the API documentation.
+univer.registerPlugin(UniverSheetsPlugin);
 
-#### When to use `SheetInterceptorService` and when not to?
+// Merge EnUS into your Univer locale map when this package contributes UI text.
+```
 
-Use `SheetInterceptorService` when multiple features need to operate on the same data or state, but do not have a clear dependency relationship. For example: pivot tables, formulas, conditional formatting, data validation, and raw cell data can all affect how other features retrieve a cell's value, but they do not depend on each other. In this case, using `SheetInterceptorService` to implement these features is appropriate.
+## Resources
 
-However, if one feature relies explicitly on another feature, such as a formula needing to perform certain actions when the fill down or copy-paste functions are called, the formula module should directly depend on the fill down and copy-paste modules, instead of using `SheetInterceptorService` for implementation.
+- [Documentation](https://docs.univer.ai)
+- [NPM package](https://npmjs.com/package/@univerjs/sheets)
+- [GitHub repository](https://github.com/dream-num/univer)
 
-<!-- Links -->
-[npm-version-shield]: https://img.shields.io/npm/v/@univerjs/sheets?style=flat-square
-[npm-version-link]: https://npmjs.com/package/@univerjs/sheets
-[npm-license-shield]: https://img.shields.io/npm/l/@univerjs/sheets?style=flat-square
-[npm-downloads-shield]: https://img.shields.io/npm/dm/@univerjs/sheets?style=flat-square

package/lib/cjs/facade.js

@@ -5,7 +5,7 @@ let _univerjs_sheets = require("@univerjs/sheets");
 let _univerjs_engine_formula = require("@univerjs/engine-formula");
 let _univerjs_protocol = require("@univerjs/protocol");
 
-//#region \0@oxc-project+runtime@0.124.0/helpers/typeof.js
+//#region \0@oxc-project+runtime@0.129.0/helpers/typeof.js
 function _typeof(o) {
 	"@babel/helpers - typeof";
 	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
@@ -16,7 +16,7 @@ function _typeof(o) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/toPrimitive.js
+//#region \0@oxc-project+runtime@0.129.0/helpers/toPrimitive.js
 function toPrimitive(t, r) {
 	if ("object" != _typeof(t) || !t) return t;
 	var e = t[Symbol.toPrimitive];
@@ -29,14 +29,14 @@ function toPrimitive(t, r) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/toPropertyKey.js
+//#region \0@oxc-project+runtime@0.129.0/helpers/toPropertyKey.js
 function toPropertyKey(t) {
 	var i = toPrimitive(t, "string");
 	return "symbol" == _typeof(i) ? i : i + "";
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/defineProperty.js
+//#region \0@oxc-project+runtime@0.129.0/helpers/defineProperty.js
 function _defineProperty(e, r, t) {
 	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
 		value: t,
@@ -47,7 +47,7 @@ function _defineProperty(e, r, t) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/decorateParam.js
+//#region \0@oxc-project+runtime@0.129.0/helpers/decorateParam.js
 function __decorateParam(paramIndex, decorator) {
 	return function(target, key) {
 		decorator(target, key, paramIndex);
@@ -55,7 +55,7 @@ function __decorateParam(paramIndex, decorator) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/decorate.js
+//#region \0@oxc-project+runtime@0.129.0/helpers/decorate.js
 function __decorate(decorators, target, key, desc) {
 	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
 	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -877,62 +877,62 @@ let RangePermissionPoint = /* @__PURE__ */ function(RangePermissionPoint) {
 * Mapping table from Workbook permission point enum to class constructors
 */
 const WORKBOOK_PERMISSION_POINT_MAP = {
-	[WorkbookPermissionPoint.Edit]: _univerjs_sheets.WorkbookEditablePermission,
-	[WorkbookPermissionPoint.View]: _univerjs_sheets.WorkbookViewPermission,
-	[WorkbookPermissionPoint.Print]: _univerjs_sheets.WorkbookPrintPermission,
-	[WorkbookPermissionPoint.Export]: _univerjs_sheets.WorkbookExportPermission,
-	[WorkbookPermissionPoint.Share]: _univerjs_sheets.WorkbookSharePermission,
-	[WorkbookPermissionPoint.CopyContent]: _univerjs_sheets.WorkbookCopyPermission,
-	[WorkbookPermissionPoint.DuplicateFile]: _univerjs_sheets.WorkbookDuplicatePermission,
-	[WorkbookPermissionPoint.Comment]: _univerjs_sheets.WorkbookCommentPermission,
-	[WorkbookPermissionPoint.ManageCollaborator]: _univerjs_sheets.WorkbookManageCollaboratorPermission,
-	[WorkbookPermissionPoint.CreateSheet]: _univerjs_sheets.WorkbookCreateSheetPermission,
-	[WorkbookPermissionPoint.DeleteSheet]: _univerjs_sheets.WorkbookDeleteSheetPermission,
-	[WorkbookPermissionPoint.RenameSheet]: _univerjs_sheets.WorkbookRenameSheetPermission,
-	[WorkbookPermissionPoint.MoveSheet]: _univerjs_sheets.WorkbookMoveSheetPermission,
-	[WorkbookPermissionPoint.HideSheet]: _univerjs_sheets.WorkbookHideSheetPermission,
-	[WorkbookPermissionPoint.ViewHistory]: _univerjs_sheets.WorkbookViewHistoryPermission,
-	[WorkbookPermissionPoint.RecoverHistory]: _univerjs_sheets.WorkbookRecoverHistoryPermission,
-	[WorkbookPermissionPoint.CreateProtection]: _univerjs_sheets.WorkbookCreateProtectPermission,
-	[WorkbookPermissionPoint.InsertRow]: _univerjs_sheets.WorkbookInsertRowPermission,
-	[WorkbookPermissionPoint.InsertColumn]: _univerjs_sheets.WorkbookInsertColumnPermission,
-	[WorkbookPermissionPoint.DeleteRow]: _univerjs_sheets.WorkbookDeleteRowPermission,
-	[WorkbookPermissionPoint.DeleteColumn]: _univerjs_sheets.WorkbookDeleteColumnPermission,
-	[WorkbookPermissionPoint.CopySheet]: _univerjs_sheets.WorkbookCopySheetPermission
+	["WorkbookEdit"]: _univerjs_sheets.WorkbookEditablePermission,
+	["WorkbookView"]: _univerjs_sheets.WorkbookViewPermission,
+	["WorkbookPrint"]: _univerjs_sheets.WorkbookPrintPermission,
+	["WorkbookExport"]: _univerjs_sheets.WorkbookExportPermission,
+	["WorkbookShare"]: _univerjs_sheets.WorkbookSharePermission,
+	["WorkbookCopy"]: _univerjs_sheets.WorkbookCopyPermission,
+	["WorkbookDuplicate"]: _univerjs_sheets.WorkbookDuplicatePermission,
+	["WorkbookComment"]: _univerjs_sheets.WorkbookCommentPermission,
+	["WorkbookManageCollaborator"]: _univerjs_sheets.WorkbookManageCollaboratorPermission,
+	["WorkbookCreateSheet"]: _univerjs_sheets.WorkbookCreateSheetPermission,
+	["WorkbookDeleteSheet"]: _univerjs_sheets.WorkbookDeleteSheetPermission,
+	["WorkbookRenameSheet"]: _univerjs_sheets.WorkbookRenameSheetPermission,
+	["WorkbookMoveSheet"]: _univerjs_sheets.WorkbookMoveSheetPermission,
+	["WorkbookHideSheet"]: _univerjs_sheets.WorkbookHideSheetPermission,
+	["WorkbookViewHistory"]: _univerjs_sheets.WorkbookViewHistoryPermission,
+	["WorkbookRecoverHistory"]: _univerjs_sheets.WorkbookRecoverHistoryPermission,
+	["WorkbookCreateProtect"]: _univerjs_sheets.WorkbookCreateProtectPermission,
+	["WorkbookInsertRow"]: _univerjs_sheets.WorkbookInsertRowPermission,
+	["WorkbookInsertColumn"]: _univerjs_sheets.WorkbookInsertColumnPermission,
+	["WorkbookDeleteRow"]: _univerjs_sheets.WorkbookDeleteRowPermission,
+	["WorkbookDeleteColumn"]: _univerjs_sheets.WorkbookDeleteColumnPermission,
+	["WorkbookCopySheet"]: _univerjs_sheets.WorkbookCopySheetPermission
 };
 /**
 * Mapping table from Worksheet permission point enum to class constructors
 */
 const WORKSHEET_PERMISSION_POINT_MAP = {
-	[WorksheetPermissionPoint.Edit]: _univerjs_sheets.WorksheetEditPermission,
-	[WorksheetPermissionPoint.View]: _univerjs_sheets.WorksheetViewPermission,
-	[WorksheetPermissionPoint.Copy]: _univerjs_sheets.WorksheetCopyPermission,
-	[WorksheetPermissionPoint.SetCellValue]: _univerjs_sheets.WorksheetSetCellValuePermission,
-	[WorksheetPermissionPoint.SetCellStyle]: _univerjs_sheets.WorksheetSetCellStylePermission,
-	[WorksheetPermissionPoint.SetRowStyle]: _univerjs_sheets.WorksheetSetRowStylePermission,
-	[WorksheetPermissionPoint.SetColumnStyle]: _univerjs_sheets.WorksheetSetColumnStylePermission,
-	[WorksheetPermissionPoint.InsertRow]: _univerjs_sheets.WorksheetInsertRowPermission,
-	[WorksheetPermissionPoint.InsertColumn]: _univerjs_sheets.WorksheetInsertColumnPermission,
-	[WorksheetPermissionPoint.DeleteRow]: _univerjs_sheets.WorksheetDeleteRowPermission,
-	[WorksheetPermissionPoint.DeleteColumn]: _univerjs_sheets.WorksheetDeleteColumnPermission,
-	[WorksheetPermissionPoint.Sort]: _univerjs_sheets.WorksheetSortPermission,
-	[WorksheetPermissionPoint.Filter]: _univerjs_sheets.WorksheetFilterPermission,
-	[WorksheetPermissionPoint.PivotTable]: _univerjs_sheets.WorksheetPivotTablePermission,
-	[WorksheetPermissionPoint.InsertHyperlink]: _univerjs_sheets.WorksheetInsertHyperlinkPermission,
-	[WorksheetPermissionPoint.EditExtraObject]: _univerjs_sheets.WorksheetEditExtraObjectPermission,
-	[WorksheetPermissionPoint.ManageCollaborator]: _univerjs_sheets.WorksheetManageCollaboratorPermission,
-	[WorksheetPermissionPoint.DeleteProtection]: _univerjs_sheets.WorksheetDeleteProtectionPermission,
-	[WorksheetPermissionPoint.SelectProtectedCells]: _univerjs_sheets.WorksheetSelectProtectedCellsPermission,
-	[WorksheetPermissionPoint.SelectUnProtectedCells]: _univerjs_sheets.WorksheetSelectUnProtectedCellsPermission
+	["WorksheetEdit"]: _univerjs_sheets.WorksheetEditPermission,
+	["WorksheetView"]: _univerjs_sheets.WorksheetViewPermission,
+	["WorksheetCopy"]: _univerjs_sheets.WorksheetCopyPermission,
+	["WorksheetSetCellValue"]: _univerjs_sheets.WorksheetSetCellValuePermission,
+	["WorksheetSetCellStyle"]: _univerjs_sheets.WorksheetSetCellStylePermission,
+	["WorksheetSetRowStyle"]: _univerjs_sheets.WorksheetSetRowStylePermission,
+	["WorksheetSetColumnStyle"]: _univerjs_sheets.WorksheetSetColumnStylePermission,
+	["WorksheetInsertRow"]: _univerjs_sheets.WorksheetInsertRowPermission,
+	["WorksheetInsertColumn"]: _univerjs_sheets.WorksheetInsertColumnPermission,
+	["WorksheetDeleteRow"]: _univerjs_sheets.WorksheetDeleteRowPermission,
+	["WorksheetDeleteColumn"]: _univerjs_sheets.WorksheetDeleteColumnPermission,
+	["WorksheetSort"]: _univerjs_sheets.WorksheetSortPermission,
+	["WorksheetFilter"]: _univerjs_sheets.WorksheetFilterPermission,
+	["WorksheetPivotTable"]: _univerjs_sheets.WorksheetPivotTablePermission,
+	["WorksheetInsertHyperlink"]: _univerjs_sheets.WorksheetInsertHyperlinkPermission,
+	["WorksheetEditExtraObject"]: _univerjs_sheets.WorksheetEditExtraObjectPermission,
+	["WorksheetManageCollaborator"]: _univerjs_sheets.WorksheetManageCollaboratorPermission,
+	["WorksheetDeleteProtection"]: _univerjs_sheets.WorksheetDeleteProtectionPermission,
+	["WorksheetSelectProtectedCells"]: _univerjs_sheets.WorksheetSelectProtectedCellsPermission,
+	["WorksheetSelectUnProtectedCells"]: _univerjs_sheets.WorksheetSelectUnProtectedCellsPermission
 };
 /**
 * Mapping table from Range permission point enum to class constructors
 */
 const RANGE_PERMISSION_POINT_MAP = {
-	[RangePermissionPoint.Edit]: _univerjs_sheets.RangeProtectionPermissionEditPoint,
-	[RangePermissionPoint.View]: _univerjs_sheets.RangeProtectionPermissionViewPoint,
-	[RangePermissionPoint.ManageCollaborator]: _univerjs_sheets.RangeProtectionPermissionManageCollaPoint,
-	[RangePermissionPoint.Delete]: _univerjs_sheets.RangeProtectionPermissionDeleteProtectionPoint
+	["RangeEdit"]: _univerjs_sheets.RangeProtectionPermissionEditPoint,
+	["RangeView"]: _univerjs_sheets.RangeProtectionPermissionViewPoint,
+	["RangeManageCollaborator"]: _univerjs_sheets.RangeProtectionPermissionManageCollaPoint,
+	["RangeDeleteProtection"]: _univerjs_sheets.RangeProtectionPermissionDeleteProtectionPoint
 };
 
 //#endregion
@@ -1201,7 +1201,7 @@ let FRangeProtectionRule = class FRangeProtectionRule {
 	* ```
 	*/
 	canEdit() {
-		return this.getPoint(RangePermissionPoint.Edit);
+		return this.getPoint("RangeEdit");
 	}
 	/**
 	* Check if the current user can view this range.
@@ -1219,7 +1219,7 @@ let FRangeProtectionRule = class FRangeProtectionRule {
 	* ```
 	*/
 	canView() {
-		return this.getPoint(RangePermissionPoint.View);
+		return this.getPoint("RangeView");
 	}
 	/**
 	* Check if the current user can manage collaborators for this range.
@@ -1237,7 +1237,7 @@ let FRangeProtectionRule = class FRangeProtectionRule {
 	* ```
 	*/
 	canManageCollaborator() {
-		return this.getPoint(RangePermissionPoint.ManageCollaborator);
+		return this.getPoint("RangeManageCollaborator");
 	}
 	/**
 	* Check if the current user can delete this protection rule.
@@ -1255,7 +1255,7 @@ let FRangeProtectionRule = class FRangeProtectionRule {
 	* ```
 	*/
 	canDelete() {
-		return this.getPoint(RangePermissionPoint.Delete);
+		return this.getPoint("RangeDeleteProtection");
 	}
 	/**
 	* Get the current permission snapshot.
@@ -1457,12 +1457,12 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
 				});
 				break;
 			case "readOnly":
-				pointsToSet[WorksheetPermissionPoint.View] = true;
+				pointsToSet["WorksheetView"] = true;
 				break;
 			case "filterOnly":
-				pointsToSet[WorksheetPermissionPoint.View] = true;
-				pointsToSet[WorksheetPermissionPoint.Sort] = true;
-				pointsToSet[WorksheetPermissionPoint.Filter] = true;
+				pointsToSet["WorksheetView"] = true;
+				pointsToSet["WorksheetSort"] = true;
+				pointsToSet["WorksheetFilter"] = true;
 				break;
 		}
 		return pointsToSet;
@@ -1544,7 +1544,7 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
 	* ```
 	*/
 	canEdit() {
-		return this.getPoint(WorksheetPermissionPoint.Edit);
+		return this.getPoint("WorksheetEdit");
 	}
 	/**
 	* Check if a specific cell can be edited.
@@ -1584,7 +1584,7 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
 	* }
 	*/
 	canView() {
-		return this.getPoint(WorksheetPermissionPoint.View);
+		return this.getPoint("WorksheetView");
 	}
 	/**
 	* Check if a specific cell can be viewed.
@@ -6527,32 +6527,32 @@ let FWorkbookPermission = class FWorkbookPermission extends _univerjs_core_facad
 				});
 				break;
 			case "editor":
-				pointsToSet[WorkbookPermissionPoint.Edit] = true;
-				pointsToSet[WorkbookPermissionPoint.View] = true;
-				pointsToSet[WorkbookPermissionPoint.Print] = true;
-				pointsToSet[WorkbookPermissionPoint.Export] = true;
-				pointsToSet[WorkbookPermissionPoint.CopyContent] = true;
-				pointsToSet[WorkbookPermissionPoint.Comment] = true;
-				pointsToSet[WorkbookPermissionPoint.CreateSheet] = true;
-				pointsToSet[WorkbookPermissionPoint.DeleteSheet] = true;
-				pointsToSet[WorkbookPermissionPoint.RenameSheet] = true;
-				pointsToSet[WorkbookPermissionPoint.MoveSheet] = true;
-				pointsToSet[WorkbookPermissionPoint.HideSheet] = true;
-				pointsToSet[WorkbookPermissionPoint.InsertRow] = true;
-				pointsToSet[WorkbookPermissionPoint.InsertColumn] = true;
-				pointsToSet[WorkbookPermissionPoint.DeleteRow] = true;
-				pointsToSet[WorkbookPermissionPoint.DeleteColumn] = true;
-				pointsToSet[WorkbookPermissionPoint.CopySheet] = true;
-				pointsToSet[WorkbookPermissionPoint.CreateProtection] = true;
+				pointsToSet["WorkbookEdit"] = true;
+				pointsToSet["WorkbookView"] = true;
+				pointsToSet["WorkbookPrint"] = true;
+				pointsToSet["WorkbookExport"] = true;
+				pointsToSet["WorkbookCopy"] = true;
+				pointsToSet["WorkbookComment"] = true;
+				pointsToSet["WorkbookCreateSheet"] = true;
+				pointsToSet["WorkbookDeleteSheet"] = true;
+				pointsToSet["WorkbookRenameSheet"] = true;
+				pointsToSet["WorkbookMoveSheet"] = true;
+				pointsToSet["WorkbookHideSheet"] = true;
+				pointsToSet["WorkbookInsertRow"] = true;
+				pointsToSet["WorkbookInsertColumn"] = true;
+				pointsToSet["WorkbookDeleteRow"] = true;
+				pointsToSet["WorkbookDeleteColumn"] = true;
+				pointsToSet["WorkbookCopySheet"] = true;
+				pointsToSet["WorkbookCreateProtect"] = true;
 				break;
 			case "viewer":
-				pointsToSet[WorkbookPermissionPoint.View] = true;
-				pointsToSet[WorkbookPermissionPoint.Print] = true;
+				pointsToSet["WorkbookView"] = true;
+				pointsToSet["WorkbookPrint"] = true;
 				break;
 			case "commenter":
-				pointsToSet[WorkbookPermissionPoint.View] = true;
-				pointsToSet[WorkbookPermissionPoint.Comment] = true;
-				pointsToSet[WorkbookPermissionPoint.Print] = true;
+				pointsToSet["WorkbookView"] = true;
+				pointsToSet["WorkbookComment"] = true;
+				pointsToSet["WorkbookPrint"] = true;
 				break;
 		}
 		return pointsToSet;
@@ -6608,7 +6608,7 @@ let FWorkbookPermission = class FWorkbookPermission extends _univerjs_core_facad
 			name: "",
 			strategies: [{
 				action: instance.subType,
-				role: value ? UnitRole$3.Editor : UnitRole$3.Owner
+				role: value ? 1 : 2
 			}],
 			scope: void 0,
 			collaborators: void 0
@@ -6627,7 +6627,7 @@ let FWorkbookPermission = class FWorkbookPermission extends _univerjs_core_facad
 	* ```
 	*/
 	canEdit() {
-		return this.getPoint(WorkbookPermissionPoint.Edit);
+		return this.getPoint("WorkbookEdit");
 	}
 	/**
 	* Get the value of a specific permission point.