@univerjs/sheets 0.20.1 → 0.21.0

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

@@ -13,10 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IUser } from '@univerjs/protocol';
-import type { Observable } from 'rxjs';
-import type { ICollaborator, IWorkbookPermission, UnsubscribeFn, WorkbookMode, WorkbookPermissionSnapshot } from './permission-types';
+import type { ICollaborator, ICollaboratorUser, WorkbookMode, WorkbookPermissionSnapshot } from './permission-types';
 import { IAuthzIoService, Injector, IPermissionService } from '@univerjs/core';
+import { FBase } from '@univerjs/core/facade';
 import { UnitRole, WorkbookPermissionPoint } from './permission-types';
 /**
  * Implementation class for WorkbookPermission
@@ -24,68 +23,20 @@ import { UnitRole, WorkbookPermissionPoint } from './permission-types';
  *
  * @hideconstructor
  */
-export declare class FWorkbookPermission implements IWorkbookPermission {
+export declare class FWorkbookPermission extends FBase {
     private readonly _unitId;
     private readonly _injector;
-    private readonly _permissionService;
+    protected readonly _permissionService: IPermissionService;
     private readonly _authzIoService;
-    private readonly _permissionSubject;
-    private readonly _collaboratorChangeSubject;
-    /**
-     * Observable stream of permission snapshot changes (BehaviorSubject)
-     * Emits immediately on subscription with current state, then on any permission point change
-     */
-    readonly permission$: Observable<WorkbookPermissionSnapshot>;
-    /**
-     * Observable stream of individual permission point changes
-     * Emits when a specific permission point value changes
-     */
-    readonly pointChange$: Observable<{
-        point: WorkbookPermissionPoint;
-        value: boolean;
-        oldValue: boolean;
-    }>;
-    /**
-     * Observable stream of collaborator changes
-     * Emits when collaborators are added, updated, or removed
-     */
-    readonly collaboratorChange$: Observable<{
-        type: 'add' | 'update' | 'delete';
-        collaborator: ICollaborator;
-    }>;
-    private _subscriptions;
-    private readonly _fPermission;
     constructor(_unitId: string, _injector: Injector, _permissionService: IPermissionService, _authzIoService: IAuthzIoService);
-    /**
-     * Create permission snapshot stream from IPermissionService
-     * @private
-     */
-    private _createPermissionStream;
-    /**
-     * Create point change stream from IPermissionService
-     * @private
-     */
-    private _createPointChangeStream;
-    /**
-     * Extract WorkbookPermissionPoint type from permission point ID
-     * @private
-     */
-    private _extractWorkbookPointType;
-    /**
-     * Build permission snapshot
-     */
-    private _buildSnapshot;
-    /**
-     * Listen to permission point changes
     /**
      * Set permission mode for the workbook.
      * @param {WorkbookMode} mode The permission mode to set ('owner' | 'editor' | 'viewer' | 'commenter').
      * @returns {Promise<void>} A promise that resolves when the mode is set.
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * await permission?.setMode('editor');
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * await fWorkbook.getWorkbookPermission().setMode('editor');
      * ```
      */
     setMode(mode: WorkbookMode): Promise<void>;
@@ -94,19 +45,13 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * @private
      */
     private _getModePermissions;
-    /**
-     * Batch set multiple permission points efficiently
-     * @private
-     */
-    private _batchSetPermissionPoints;
     /**
      * Set the workbook to read-only mode (viewer mode).
      * @returns {Promise<void>} A promise that resolves when the mode is set.
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * await permission?.setReadOnly();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * await fWorkbook.getWorkbookPermission().setReadOnly();
      * ```
      */
     setReadOnly(): Promise<void>;
@@ -115,25 +60,11 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * @returns {Promise<void>} A promise that resolves when the mode is set.
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * await permission?.setEditable();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * await fWorkbook.getWorkbookPermission().setEditable();
      * ```
      */
     setEditable(): Promise<void>;
-    /**
-     * Check if the workbook is editable.
-     * @returns {boolean} true if the workbook can be edited, false otherwise.
-     * @example
-     * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * if (permission?.canEdit()) {
-     *   console.log('Workbook is editable');
-     * }
-     * ```
-     */
-    canEdit(): boolean;
     /**
      * Set a specific permission point.
      * @param {WorkbookPermissionPoint} point The permission point to set.
@@ -141,21 +72,33 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * @returns {Promise<void>} A promise that resolves when the point is set.
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * await permission?.setPoint(univerAPI.Enum.WorkbookPermissionPoint.Print, false);
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const permission = fWorkbook.getWorkbookPermission();
+     * await permission.setPoint(univerAPI.Enum.WorkbookPermissionPoint.Print, false);
      * ```
      */
     setPoint(point: WorkbookPermissionPoint, value: boolean): Promise<void>;
+    /**
+     * Check if the workbook is editable.
+     * @returns {boolean} true if the workbook can be edited, false otherwise.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * if (fWorkbook.getWorkbookPermission().canEdit()) {
+     *   console.log('Workbook is editable');
+     * }
+     * ```
+     */
+    canEdit(): boolean;
     /**
      * Get the value of a specific permission point.
      * @param {WorkbookPermissionPoint} point The permission point to query.
      * @returns {boolean} true if allowed, false if denied.
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * const canPrint = permission?.getPoint(univerAPI.Enum.WorkbookPermissionPoint.Print);
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const permission = fWorkbook.getWorkbookPermission();
+     * const canPrint = permission.getPoint(univerAPI.Enum.WorkbookPermissionPoint.Print);
      * console.log(canPrint);
      * ```
      */
@@ -165,9 +108,8 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * @returns {WorkbookPermissionSnapshot} An object containing all permission point values.
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * const snapshot = permission?.getSnapshot();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const snapshot = fWorkbook.getWorkbookPermission().getSnapshot();
      * console.log(snapshot);
      * ```
      */
@@ -178,9 +120,9 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * @returns {Promise<void>} A promise that resolves when the collaborators are set.
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * await permission?.setCollaborators([
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const permission = fWorkbook.getWorkbookPermission();
+     * await permission.setCollaborators([
      *   {
      *     user: { userID: 'user1', name: 'John Doe', avatar: 'https://...' },
      *     role: univerAPI.Enum.UnitRole.Editor
@@ -193,7 +135,7 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * ```
      */
     setCollaborators(collaborators: Array<{
-        user: IUser;
+        user: ICollaboratorUser;
         role: UnitRole;
     }>): Promise<void>;
     /**
@@ -203,15 +145,15 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * @returns {Promise<void>} A promise that resolves when the collaborator is added.
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * await permission?.addCollaborator(
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const permission = fWorkbook.getWorkbookPermission();
+     * await permission.addCollaborator(
      *   { userID: 'user1', name: 'John Doe', avatar: 'https://...' },
      *   univerAPI.Enum.UnitRole.Editor
      * );
      * ```
      */
-    addCollaborator(user: IUser, role: UnitRole): Promise<void>;
+    addCollaborator(user: ICollaboratorUser, role: UnitRole): Promise<void>;
     /**
      * Update an existing collaborator's role and information.
      * @param {IUser} user The updated user information (userID, name, avatar).
@@ -219,24 +161,24 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * @returns {Promise<void>} A promise that resolves when the collaborator is updated.
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * await permission?.updateCollaborator(
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const permission = fWorkbook.getWorkbookPermission();
+     * await permission.updateCollaborator(
      *   { userID: 'user1', name: 'John Doe Updated', avatar: 'https://...' },
      *   univerAPI.Enum.UnitRole.Reader
      * );
      * ```
      */
-    updateCollaborator(user: IUser, role: UnitRole): Promise<void>;
+    updateCollaborator(user: ICollaboratorUser, role: UnitRole): Promise<void>;
     /**
      * Remove a collaborator from the workbook.
      * @param {string} userId The user ID to remove.
      * @returns {Promise<void>} A promise that resolves when the collaborator is removed.
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * await permission?.removeCollaborator('user1');
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const permission = fWorkbook.getWorkbookPermission();
+     * await permission.removeCollaborator('user1');
      * ```
      */
     removeCollaborator(userId: string): Promise<void>;
@@ -246,9 +188,9 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * @returns {Promise<void>} A promise that resolves when the collaborators are removed.
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * await permission?.removeCollaborators(['user1', 'user2']);
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const permission = fWorkbook.getWorkbookPermission();
+     * await permission.removeCollaborators(['user1', 'user2']);
      * ```
      */
     removeCollaborators(userIds: string[]): Promise<void>;
@@ -257,31 +199,11 @@ export declare class FWorkbookPermission implements IWorkbookPermission {
      * @returns {Promise<ICollaborator[]>} Array of collaborators with their roles.
      * @example
      * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * const collaborators = await permission?.listCollaborators();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const permission = fWorkbook.getWorkbookPermission();
+     * const collaborators = await permission.listCollaborators();
      * console.log(collaborators);
      * ```
      */
     listCollaborators(): Promise<ICollaborator[]>;
-    /**
-     * Subscribe to permission changes (simplified interface for users not familiar with RxJS).
-     * @param {Function} listener Callback function to be called when permissions change.
-     * @returns {UnsubscribeFn} Unsubscribe function.
-     * @example
-     * ```ts
-     * const workbook = univerAPI.getActiveWorkbook();
-     * const permission = workbook?.getWorkbookPermission();
-     * const unsubscribe = permission?.subscribe((snapshot) => {
-     *   console.log('Permission changed:', snapshot);
-     * });
-     * // Later, to stop listening:
-     * unsubscribe?.();
-     * ```
-     */
-    subscribe(listener: (snapshot: WorkbookPermissionSnapshot) => void): UnsubscribeFn;
-    /**
-     * Clean up resources
-     */
-    dispose(): void;
 }