refactor: rename BlocksuiteWorkspace and WorkspaceInfo

packages/data-center/src/provider/affine/affine.ts

@@ -1,7 +1,7 @@
 import { BaseProvider } from '../base.js';
 import type { ProviderConstructorParams } from '../base';
-import type { User, Workspace as WS, WorkspaceMeta } from '../../types';
-import { Workspace } from '@blocksuite/store';
+import type { User, WorkspaceInfo, WorkspaceMeta } from '../../types';
+import { Workspace as BlocksuiteWorkspace } from '@blocksuite/store';
 import { BlockSchema } from '@blocksuite/blocks/models';
 import { applyUpdate } from 'yjs';
 import { storage } from './storage.js';
@@ -19,7 +19,7 @@ export interface AffineProviderConstructorParams
 
 export class AffineProvider extends BaseProvider {
   public id = 'affine';
-  private _workspacesCache: Map<string, Workspace> = new Map();
+  private _workspacesCache: Map<string, BlocksuiteWorkspace> = new Map();
   private _onTokenRefresh?: Callback = undefined;
   private _wsMap: Map<string, WebsocketProvider> = new Map();
   private _apis: Apis;
@@ -58,7 +58,7 @@ export class AffineProvider extends BaseProvider {
     }
   }
 
-  override async warpWorkspace(workspace: Workspace) {
+  override async warpWorkspace(workspace: BlocksuiteWorkspace) {
     const { doc, room } = workspace;
     assert(room);
     this.linkLocal(workspace);
@@ -97,7 +97,7 @@ export class AffineProvider extends BaseProvider {
       return [];
     }
     const workspacesList = await this._apis.getWorkspaces();
-    const workspaces: WS[] = workspacesList.map(w => {
+    const workspaces: WorkspaceInfo[] = workspacesList.map(w => {
       return {
         ...w,
         memberCount: 0,
@@ -108,12 +108,12 @@ export class AffineProvider extends BaseProvider {
     const workspaceInstances = workspaces.map(({ id }) => {
       const workspace =
         this._workspacesCache.get(id) ||
-        new Workspace({
+        new BlocksuiteWorkspace({
           room: id,
         }).register(BlockSchema);
       this._workspacesCache.set(id, workspace);
       if (workspace) {
-        return new Promise<Workspace>(resolve => {
+        return new Promise<BlocksuiteWorkspace>(resolve => {
           this._apis.downloadWorkspace(id).then(data => {
             applyUpdate(workspace.doc, new Uint8Array(data));
             resolve(workspace);
@@ -235,7 +235,7 @@ export class AffineProvider extends BaseProvider {
     return await this._apis.removeMember({ permissionId });
   }
 
-  public override async linkLocal(workspace: Workspace) {
+  public override async linkLocal(workspace: BlocksuiteWorkspace) {
     return workspace;
     // assert(workspace.room);
     // let idb = this._idbMap.get(workspace.room);
@@ -249,19 +249,19 @@ export class AffineProvider extends BaseProvider {
 
   public override async createWorkspace(
     meta: WorkspaceMeta
-  ): Promise<Workspace | undefined> {
+  ): Promise<BlocksuiteWorkspace | undefined> {
     assert(meta.name, 'Workspace name is required');
     const { id } = await this._apis.createWorkspace(
       meta as Required<WorkspaceMeta>
     );
     this._logger('Creating affine workspace');
-    const nw = new Workspace({
+    const nw = new BlocksuiteWorkspace({
       room: id,
     }).register(BlockSchema);
     nw.meta.setName(meta.name);
     this.linkLocal(nw);
 
-    const workspaceInfo: WS = {
+    const workspaceInfo: WorkspaceInfo = {
       name: meta.name,
       id,
       isPublish: false,

packages/data-center/src/provider/base.ts

@@ -1,5 +1,5 @@
-import { BlobStorage, Workspace } from '@blocksuite/store';
-import { Logger, User, Workspace as WS, WorkspaceMeta } from '../types';
+import { Workspace as BlocksuiteWorkspace } from '@blocksuite/store';
+import { Logger, User, WorkspaceInfo, WorkspaceMeta } from '../types';
 import type { WorkspacesScope } from '../workspaces';
 
 const defaultLogger = () => {
@@ -47,14 +47,16 @@ export class BaseProvider {
    * @param workspace
    * @returns
    */
-  public async warpWorkspace(workspace: Workspace): Promise<Workspace> {
+  public async warpWorkspace(
+    workspace: BlocksuiteWorkspace
+  ): Promise<BlocksuiteWorkspace> {
     return workspace;
   }
 
   /**
    * load workspaces
    **/
-  public async loadWorkspaces(): Promise<WS[]> {
+  public async loadWorkspaces(): Promise<WorkspaceInfo[]> {
     throw new Error(`provider: ${this.id} loadWorkSpace Not implemented`);
   }
 
@@ -154,7 +156,7 @@ export class BaseProvider {
    */
   public async createWorkspace(
     meta: WorkspaceMeta
-  ): Promise<Workspace | undefined> {
+  ): Promise<BlocksuiteWorkspace | undefined> {
     meta;
     return;
   }
@@ -175,7 +177,9 @@ export class BaseProvider {
    * @param workspace
    * @returns
    */
-  public async linkLocal(workspace: Workspace): Promise<Workspace> {
+  public async linkLocal(
+    workspace: BlocksuiteWorkspace
+  ): Promise<BlocksuiteWorkspace> {
     return workspace;
   }
 }

packages/data-center/src/provider/local/local.ts

@@ -1,8 +1,8 @@
 import { BaseProvider } from '../base.js';
 import type { ProviderConstructorParams } from '../base';
 import { varStorage as storage } from 'lib0/storage';
-import { Workspace as WS, WorkspaceMeta } from '../../types';
-import { Workspace, uuidv4 } from '@blocksuite/store';
+import { WorkspaceInfo, WorkspaceMeta } from '../../types';
+import { Workspace as BlocksuiteWorkspace, uuidv4 } from '@blocksuite/store';
 import { IndexedDBProvider } from './indexeddb.js';
 import assert from 'assert';
 import { getDefaultHeadImgBlob } from '../../utils/index.js';
@@ -18,11 +18,11 @@ export class LocalProvider extends BaseProvider {
     this.loadWorkspaces();
   }
 
-  private _storeWorkspaces(workspaces: WS[]) {
+  private _storeWorkspaces(workspaces: WorkspaceInfo[]) {
     storage.setItem(WORKSPACE_KEY, JSON.stringify(workspaces));
   }
 
-  public override async linkLocal(workspace: Workspace) {
+  public override async linkLocal(workspace: BlocksuiteWorkspace) {
     assert(workspace.room);
     let idb = this._idbMap.get(workspace.room);
     idb?.destroy();
@@ -33,19 +33,19 @@ export class LocalProvider extends BaseProvider {
   }
 
   public override async warpWorkspace(
-    workspace: Workspace
-  ): Promise<Workspace> {
+    workspace: BlocksuiteWorkspace
+  ): Promise<BlocksuiteWorkspace> {
     assert(workspace.room);
     await this.linkLocal(workspace);
     return workspace;
   }
 
-  override loadWorkspaces(): Promise<WS[]> {
+  override loadWorkspaces(): Promise<WorkspaceInfo[]> {
     const workspaceStr = storage.getItem(WORKSPACE_KEY);
-    let workspaces: WS[] = [];
+    let workspaces: WorkspaceInfo[] = [];
     if (workspaceStr) {
       try {
-        workspaces = JSON.parse(workspaceStr) as WS[];
+        workspaces = JSON.parse(workspaceStr) as WorkspaceInfo[];
         workspaces.forEach(workspace => {
           this._workspaces.add(workspace);
         });
@@ -77,11 +77,11 @@ export class LocalProvider extends BaseProvider {
 
   public override async createWorkspace(
     meta: WorkspaceMeta
-  ): Promise<Workspace | undefined> {
+  ): Promise<BlocksuiteWorkspace | undefined> {
     assert(meta.name, 'Workspace name is required');
     this._logger('Creating affine workspace');
 
-    const workspaceInfo: WS = {
+    const workspaceInfo: WorkspaceInfo = {
       name: meta.name,
       id: uuidv4(),
       isPublish: false,
@@ -92,7 +92,7 @@ export class LocalProvider extends BaseProvider {
       provider: 'local',
     };
 
-    const workspace = new Workspace({ room: workspaceInfo.id });
+    const workspace = new BlocksuiteWorkspace({ room: workspaceInfo.id });
     this.linkLocal(workspace);
     workspace.meta.setName(meta.name);
     if (!meta.avatar) {