refactor(store): Workspace -> DocCollection

packages/blocks/src/__tests__/database/database.unit.spec.ts

@@ -3,7 +3,7 @@ import '../../database-block/kanban/define.js';
 import '../../database-block/table/define.js';
 
 import type { BlockModel, Doc } from '@blocksuite/store';
-import { Generator, Schema, Workspace } from '@blocksuite/store';
+import { DocCollection, Generator, Schema } from '@blocksuite/store';
 import { beforeEach, describe, expect, test } from 'vitest';
 
 import { numberPureColumnConfig } from '../../database-block/common/columns/number/define.js';
@@ -27,13 +27,13 @@ function createTestOptions() {
   const idGenerator = Generator.AutoIncrement;
   const schema = new Schema();
   schema.register(AffineSchemas);
-  return { id: 'test-workspace', idGenerator, schema };
+  return { id: 'test-collection', idGenerator, schema };
 }
 
 function createTestDoc(docId = 'doc0') {
   const options = createTestOptions();
-  const workspace = new Workspace(options);
-  const doc = workspace.createDoc({ id: docId });
+  const collection = new DocCollection(options);
+  const doc = collection.createDoc({ id: docId });
   doc.load();
   return doc;
 }

packages/blocks/src/__tests__/migration/migration.unit.spec.ts

@@ -5,7 +5,7 @@ import { readFile } from 'node:fs/promises';
 import { join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 
-import { Schema, Workspace, type Y } from '@blocksuite/store';
+import { DocCollection, Schema, type Y } from '@blocksuite/store';
 import { assert, describe, expect, test } from 'vitest';
 
 import { DatabaseBlockSchema } from '../../database-block/database-model.js';
@@ -21,8 +21,8 @@ async function loadBinary(name: string) {
   const path = join(originPath, `../ydocs/${name}.ydoc`);
   const buffer = await readFile(path);
   const update = new Uint8Array(buffer);
-  const doc = new Workspace.Y.Doc();
-  Workspace.Y.applyUpdate(doc, update);
+  const doc = new DocCollection.Y.Doc();
+  DocCollection.Y.applyUpdate(doc, update);
   return doc;
 }
 
@@ -37,16 +37,16 @@ schema.register([
   FrameBlockSchema,
 ]);
 
-describe('workspace migration', () => {
-  test('add pageVersion in workspace meta', async () => {
+describe('collection migration', () => {
+  test('add pageVersion in collection meta', async () => {
     const doc = await loadBinary('workspace-v1-v2');
 
     const meta = doc.getMap('meta');
     const before = meta.toJSON();
     assert.equal(before['workspaceVersion'], 1);
     assert.isUndefined(before['pageVersion']);
 
-    schema.upgradeWorkspace(doc);
+    schema.upgradeCollection(doc);
 
     const after = meta.toJSON();
     assert.equal(after['workspaceVersion'], 2);

packages/blocks/src/_common/components/embed-card/embed-card-toolbar.ts

@@ -4,7 +4,7 @@ import { assertExists } from '@blocksuite/global/utils';
 import type { EditorHost } from '@blocksuite/lit';
 import { WithDisposable } from '@blocksuite/lit';
 import type { BlockModel } from '@blocksuite/store';
-import { Workspace } from '@blocksuite/store';
+import { DocCollection } from '@blocksuite/store';
 import { flip } from '@floating-ui/dom';
 import { css, html, LitElement, nothing } from 'lit';
 import { customElement, property, query } from 'lit/decorators.js';
@@ -308,7 +308,7 @@ export class EmbedCardToolbar extends WithDisposable(LitElement) {
     const parent = doc.getParent(this._model);
     const index = parent?.children.indexOf(this._model);
 
-    const yText = new Workspace.Y.Text();
+    const yText = new DocCollection.Y.Text();
     const insert = this._model.title || this._model.caption || this._model.url;
     yText.insert(0, insert);
     yText.format(0, insert.length, { link: this._model.url });

packages/blocks/src/_common/components/rich-text/keymap/container.ts

@@ -422,7 +422,7 @@ export const bindContainerHotkey = (blockElement: BlockElement) => {
     });
     inlineEditor.setInlineRange({ index: inlineRange.index - 1, length: 0 });
 
-    const doc = createDefaultDoc(blockElement.doc.workspace, {
+    const doc = createDefaultDoc(blockElement.doc.collection, {
       title: docName,
     });
     insertLinkedNode({

packages/blocks/src/_common/components/rich-text/rich-text.ts

@@ -10,7 +10,7 @@ import {
 } from '@blocksuite/inline';
 import { ShadowlessElement, WithDisposable } from '@blocksuite/lit';
 import type { Y } from '@blocksuite/store';
-import { Text, Workspace } from '@blocksuite/store';
+import { DocCollection, Text } from '@blocksuite/store';
 import { css, html } from 'lit';
 import { customElement, property, query } from 'lit/decorators.js';
 import { classMap } from 'lit/directives/class-map.js';
@@ -318,7 +318,7 @@ export class RichText extends WithDisposable(ShadowlessElement) {
     assertExists(this._yText.doc, 'yText should be bind to yDoc.');
 
     if (!this.undoManager) {
-      this.undoManager = new Workspace.Y.UndoManager(this._yText, {
+      this.undoManager = new DocCollection.Y.UndoManager(this._yText, {
         trackedOrigins: new Set([this._yText.doc.clientID]),
       });
     }

packages/blocks/src/_common/configs/quick-action/config.ts

@@ -131,7 +131,7 @@ export const quickActionConfig: QuickActionConfig[] = [
       host.selection.clear();
 
       const doc = host.doc;
-      const linkedDoc = doc.workspace.createDoc({});
+      const linkedDoc = doc.collection.createDoc({});
       linkedDoc.load(() => {
         const rootId = linkedDoc.addBlock('affine:page', {
           title: new doc.Text(''),
@@ -158,7 +158,7 @@ export const quickActionConfig: QuickActionConfig[] = [
           firstBlock.type.match(/^h[1-6]$/)
         ) {
           const title = firstBlock.text.toString();
-          linkedDoc.workspace.setDocMeta(linkedDoc.id, {
+          linkedDoc.collection.setDocMeta(linkedDoc.id, {
             title,
           });
 

packages/blocks/src/_common/inline/presets/nodes/reference-node/reference-node.ts

@@ -149,7 +149,7 @@ export class AffineReference extends WithDisposable(ShadowlessElement) {
     const doc = this.doc;
     this._updateRefMeta(doc);
     this._disposables.add(
-      doc.workspace.slots.docUpdated.on(() => this._updateRefMeta(doc))
+      doc.collection.slots.docUpdated.on(() => this._updateRefMeta(doc))
     );
 
     this.updateComplete
@@ -166,7 +166,7 @@ export class AffineReference extends WithDisposable(ShadowlessElement) {
     const refAttribute = this.delta.attributes?.reference;
     assertExists(refAttribute, 'Failed to get reference attribute!');
     this._refAttribute = refAttribute;
-    const refMeta = doc.workspace.meta.docMetas.find(
+    const refMeta = doc.collection.meta.docMetas.find(
       doc => doc.id === refAttribute.pageId
     );
     this._refMeta = refMeta

packages/blocks/src/_common/mind-map/draw.ts

@@ -1,4 +1,4 @@
-import { Workspace } from '@blocksuite/store';
+import { DocCollection } from '@blocksuite/store';
 
 import type { EdgelessRootService } from '../../root-block/edgeless/edgeless-root-service.js';
 import { getFontString } from '../../surface-block/canvas-renderer/element-renderer/text/utils.js';
@@ -97,7 +97,7 @@ const drawAllNode = (
         : service.addElement(CanvasElementType.SHAPE, {
             ...DEFAULT_SHAPE_PROPS,
             xywh: `[${0},${0},${0},${0}]`,
-            text: new Workspace.Y.Text(text),
+            text: new DocCollection.Y.Text(text),
           });
     shapeIds.push(id);
     const ele = service.getElementById(id) as ShapeElementModel;
@@ -229,7 +229,7 @@ export const createNode = (
   const id = service.addElement(CanvasElementType.SHAPE, {
     ...DEFAULT_SHAPE_PROPS,
     xywh: `[${0},${0},${0},${0}]`,
-    text: new Workspace.Y.Text(text),
+    text: new DocCollection.Y.Text(text),
   });
   const ele = service.getElementById(id) as ShapeElementModel;
   const maxWidth =
@@ -268,7 +268,7 @@ export const changeText = (
   service: EdgelessRootService
 ) => {
   service.updateElement(id, {
-    text: new Workspace.Y.Text(text),
+    text: new DocCollection.Y.Text(text),
   });
   const ele = service.getElementById(id) as ShapeElementModel;
   const maxWidth =

packages/blocks/src/_common/transformers/html.ts

@@ -5,7 +5,7 @@ import { HtmlAdapter } from '../adapters/index.js';
 import { createAssetsArchive, download } from './utils.js';
 
 async function exportDoc(doc: Doc) {
-  const job = new Job({ workspace: doc.workspace });
+  const job = new Job({ collection: doc.collection });
   const snapshot = await job.docToSnapshot(doc);
   const adapter = new HtmlAdapter();
   const htmlResult = await adapter.fromDocSnapshot({

packages/blocks/src/_common/transformers/markdown.ts

@@ -7,7 +7,7 @@ import { defaultImageProxyMiddleware } from './middlewares.js';
 import { createAssetsArchive, download } from './utils.js';
 
 async function exportDoc(doc: Doc) {
-  const job = new Job({ workspace: doc.workspace });
+  const job = new Job({ collection: doc.collection });
   const snapshot = await job.docToSnapshot(doc);
 
   const adapter = new MarkdownAdapter();
@@ -47,17 +47,17 @@ async function importMarkdown({
   noteId,
 }: ImportMarkdownOptions) {
   const job = new Job({
-    workspace: doc.workspace,
+    collection: doc.collection,
     middlewares: [defaultImageProxyMiddleware],
   });
   const adapter = new MarkdownAdapter();
   adapter.applyConfigs(job.adapterConfigs);
   const snapshot = await adapter.toSliceSnapshot({
     file: markdown,
     assets: job.assetsManager,
-    pageVersion: doc.workspace.meta.pageVersion!,
-    workspaceVersion: doc.workspace.meta.workspaceVersion!,
-    workspaceId: doc.workspace.id,
+    pageVersion: doc.collection.meta.pageVersion!,
+    workspaceVersion: doc.collection.meta.workspaceVersion!,
+    workspaceId: doc.collection.id,
     pageId: doc.id,
   });
 

packages/blocks/src/_common/transformers/middlewares.ts

@@ -6,7 +6,7 @@ import type { ListBlockModel } from '../../list-block/index.js';
 import type { ParagraphBlockModel } from '../../paragraph-block/index.js';
 import { DEFAULT_IMAGE_PROXY_ENDPOINT } from '../consts.js';
 
-export const replaceIdMiddleware: JobMiddleware = ({ slots, workspace }) => {
+export const replaceIdMiddleware: JobMiddleware = ({ slots, collection }) => {
   const idMap = new Map<string, string>();
   slots.afterImport.on(payload => {
     if (
@@ -63,7 +63,7 @@ export const replaceIdMiddleware: JobMiddleware = ({ slots, workspace }) => {
   });
   slots.beforeImport.on(payload => {
     if (payload.type === 'page') {
-      const newId = workspace.idGenerator();
+      const newId = collection.idGenerator();
       idMap.set(payload.snapshot.meta.id, newId);
       payload.snapshot.meta.id = newId;
       return;
@@ -86,7 +86,7 @@ export const replaceIdMiddleware: JobMiddleware = ({ slots, workspace }) => {
       if (idMap.has(original)) {
         newId = idMap.get(original)!;
       } else {
-        newId = workspace.idGenerator();
+        newId = collection.idGenerator();
         idMap.set(original, newId);
       }
       snapshot.id = newId;
@@ -98,7 +98,7 @@ export const replaceIdMiddleware: JobMiddleware = ({ slots, workspace }) => {
           if (idMap.has(original)) {
             newId = idMap.get(original)!;
           } else {
-            newId = workspace.idGenerator();
+            newId = collection.idGenerator();
             idMap.set(original, newId);
           }
         });

packages/blocks/src/_common/transformers/zip.ts

@@ -1,24 +1,24 @@
 import { assertExists } from '@blocksuite/global/utils';
 import type {
+  CollectionInfoSnapshot,
   Doc,
+  DocCollection,
   DocSnapshot,
   JobMiddleware,
-  Workspace,
-  WorkspaceInfoSnapshot,
 } from '@blocksuite/store';
 import { getAssetName, Job, sha } from '@blocksuite/store';
 import JSZip from 'jszip';
 
 import { replaceIdMiddleware } from './middlewares.js';
 
-async function exportDocs(workspace: Workspace, docs: Doc[]) {
+async function exportDocs(collection: DocCollection, docs: Doc[]) {
   const zip = new JSZip();
 
-  const job = new Job({ workspace });
+  const job = new Job({ collection });
   const snapshots = await Promise.all(docs.map(job.docToSnapshot));
 
-  const workspaceInfo = job.workspaceInfoToSnapshot();
-  zip.file('info.json', JSON.stringify(workspaceInfo, null, 2));
+  const collectionInfo = job.collectionInfoToSnapshot();
+  zip.file('info.json', JSON.stringify(collectionInfo, null, 2));
 
   snapshots.forEach(snapshot => {
     const snapshotName = `${snapshot.meta.id}.snapshot.json`;
@@ -38,14 +38,14 @@ async function exportDocs(workspace: Workspace, docs: Doc[]) {
   return zip.generateAsync({ type: 'blob' });
 }
 
-async function importDocs(workspace: Workspace, imported: Blob) {
+async function importDocs(collection: DocCollection, imported: Blob) {
   const zip = new JSZip();
   const { files } = await zip.loadAsync(imported);
 
   const assetObjs: JSZip.JSZipObject[] = [];
   const snapshotsObjs: JSZip.JSZipObject[] = [];
   let infoObj: JSZip.JSZipObject | undefined;
-  let info: WorkspaceInfoSnapshot | undefined;
+  let info: CollectionInfoSnapshot | undefined;
 
   Object.entries(files).map(([name, fileObj]) => {
     if (name.includes('MACOSX') || name.includes('DS_Store')) {
@@ -71,13 +71,13 @@ async function importDocs(workspace: Workspace, imported: Blob) {
   {
     const json = await infoObj?.async('text');
     assertExists(json);
-    info = JSON.parse(json) as WorkspaceInfoSnapshot;
+    info = JSON.parse(json) as CollectionInfoSnapshot;
   }
 
-  const migrationMiddleware: JobMiddleware = ({ slots, workspace }) => {
+  const migrationMiddleware: JobMiddleware = ({ slots, collection }) => {
     slots.afterImport.on(payload => {
       if (payload.type === 'page') {
-        workspace.schema.upgradeDoc(
+        collection.schema.upgradeDoc(
           info?.pageVersion ?? 0,
           {},
           payload.page.spaceDoc
@@ -86,12 +86,12 @@ async function importDocs(workspace: Workspace, imported: Blob) {
     });
   };
   const job = new Job({
-    workspace,
+    collection,
     middlewares: [replaceIdMiddleware, migrationMiddleware],
   });
   const assetsMap = job.assets;
 
-  job.snapshotToWorkspaceInfo(info);
+  job.snapshotToCollectionInfo(info);
 
   await Promise.all(
     assetObjs.map(async fileObj => {

packages/blocks/src/_common/utils/init.ts

@@ -1,17 +1,17 @@
-import type { Workspace } from '@blocksuite/store';
+import type { DocCollection } from '@blocksuite/store';
 
 export function createDefaultDoc(
-  workspace: Workspace,
+  collection: DocCollection,
   options: { id?: string; title?: string } = {}
 ) {
-  const doc = workspace.createDoc({ id: options.id });
+  const doc = collection.createDoc({ id: options.id });
 
   doc.load();
   const title = options.title ?? '';
   const rootId = doc.addBlock('affine:page', {
     title: new doc.Text(title),
   });
-  workspace.setDocMeta(doc.id, {
+  collection.setDocMeta(doc.id, {
     title,
   });
   doc.addBlock('affine:surface', {}, rootId);

packages/blocks/src/database-block/common/columns/rich-text/cell-renderer.ts

@@ -1,6 +1,6 @@
 import { assertExists } from '@blocksuite/global/utils';
 import type { Y } from '@blocksuite/store';
-import { Text, Workspace } from '@blocksuite/store';
+import { DocCollection, Text } from '@blocksuite/store';
 import { css, nothing } from 'lit';
 import { customElement, query } from 'lit/decorators.js';
 import { html } from 'lit/static-html.js';
@@ -142,7 +142,7 @@ export class RichTextCell extends BaseCellRenderer<Y.Text> {
   }
 
   private _initYText = (text?: string) => {
-    const yText = new Workspace.Y.Text(text);
+    const yText = new DocCollection.Y.Text(text);
     this.onChange(yText);
   };