@univerjs/sheets 1.0.0-alpha.2 → 1.0.0-alpha.3

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

@@ -81,6 +81,7 @@ export declare class FWorkbook extends FBaseInitialable {
     /**
      * Set the name of the workbook.
      * @param {string} name The new name of the workbook.
+     * @returns {FWorkbook} The current FWorkbook instance for chaining.
      * @example
      * ```ts
      * // The code below sets the name of the workbook
@@ -546,7 +547,6 @@ export declare class FWorkbook extends FBaseInitialable {
     /**
      * Insert a defined name by builder param.
      * @param {ISetDefinedNameMutationParam} param The param to insert the defined name
-     * @returns {void}
      * @example
      * ```ts
      * // The code below inserts a defined name by builder param
@@ -563,7 +563,6 @@ export declare class FWorkbook extends FBaseInitialable {
     /**
      * Update the defined name with the given name.
      * @param {ISetDefinedNameMutationParam} param The param to insert the defined name
-     * @returns {void}
      * @example
      * ```ts
      * // The code below updates the defined name with the given name
@@ -622,7 +621,6 @@ export declare class FWorkbook extends FBaseInitialable {
     /**
      * Register a custom range theme style.
      * @param {RangeThemeStyle} rangeThemeStyle The range theme style to register
-     * @returns {void}
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -640,7 +638,6 @@ export declare class FWorkbook extends FBaseInitialable {
     /**
      * Unregister a custom range theme style.
      * @param {string} themeName The name of the theme to unregister
-     * @returns {void}
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();

package/lib/types/facade/index.d.ts

@@ -19,7 +19,8 @@ export * from './f-enum';
 export * from './f-event';
 export { FRange } from './f-range';
 export { FSelection } from './f-selection';
+export type { FSheetEmbedUnitFacadeMapAugmentation } from './f-types';
+export type * from './f-univer';
 export { FWorkbook } from './f-workbook';
 export { FWorksheet } from './f-worksheet';
 export { FWorkbookPermission } from './permission/f-workbook-permission';
-export type * from './f-univer';

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

@@ -86,6 +86,8 @@ export declare class FRangePermission extends FBase {
     unprotect(): Promise<boolean>;
     /**
      * List all protection rules that intersect with the current range.
+     * @param {object} [options] Options for listing protection rules.
+     * @param {boolean} [options.ignoreCollaborators] Whether to skip fetching collaborators for performance.
      * @returns {Promise<FRangeProtectionRule[]>} Array of protection rules.
      * @example
      * ```ts

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

@@ -303,6 +303,8 @@ export declare class FWorksheetPermission extends FBase {
     unprotectRules(ruleIds: string[]): Promise<boolean>;
     /**
      * List all range protection rules for the worksheet.
+     * @param {object} [options] Options for listing range protection rules.
+     * @param {boolean} [options.ignoreCollaborators] Whether to skip fetching collaborators for performance.
      * @returns {Promise<FRangeProtectionRule[]>} Array of protection rules.
      * @example
      * ```ts

package/lib/types/facade/permission/util.d.ts

@@ -28,10 +28,21 @@ export declare function determineScope(editState: EditStateEnum, viewState: View
 /**
  * Check if there are no range protection rules for the given unit and subunit when removing a range protection rule.
  * If there are no rules left, also remove the associated worksheet protection and update the permission points accordingly.
+ * @param {Injector} injector The injector used to resolve permission services.
+ * @param {string} unitId The workbook unit id.
+ * @param {string} subUnitId The worksheet subunit id.
  */
 export declare function handleWorksheetRangePermissionIsEmpty(injector: Injector, unitId: string, subUnitId: string): void;
 /**
  * Get the list of range protection rules for a specific worksheet or range, and convert them to FRangeProtectionRule instances.
+ * @param {Injector} injector The injector used to resolve permission services.
+ * @param {string} unitId The workbook unit id.
+ * @param {string} subUnitId The worksheet subunit id.
+ * @param {object} options Options for listing range protection rules.
+ * @param {FWorksheet} options.worksheet The worksheet facade used to convert ranges.
+ * @param {FRange} [options.specificRange] Optional range used to filter rules.
+ * @param {boolean} [options.ignoreCollaborators] Whether to skip fetching collaborators for performance.
+ * @returns {Promise<FRangeProtectionRule[]>} The range protection rules.
  */
 export declare function getListRangeProtectionRules(injector: Injector, unitId: string, subUnitId: string, options: {
     worksheet: FWorksheet;

package/lib/types/services/permission/range-permission/range-protection.service.d.ts

@@ -25,4 +25,5 @@ export declare class RangeProtectionService extends Disposable {
     constructor(_selectionProtectionRuleModel: RangeProtectionRuleModel, _permissionService: IPermissionService, _resourceManagerService: IResourceManagerService, _selectionProtectionCache: RangeProtectionCache, _univerInstanceService: IUniverInstanceService);
     private _initRuleChange;
     private _initSnapshot;
+    private _addOrUpdatePermissionPoint;
 }

package/lib/types/services/permission/worksheet-permission/worksheet-permission.service.d.ts

@@ -33,4 +33,5 @@ export declare class WorksheetPermissionService extends RxDisposable {
     private _initRuleChange;
     private _initRuleSnapshot;
     private _initPointSnapshot;
+    private _addOrUpdatePermissionPoint;
 }