refactor: rename page to doc (toeverything#6290)

donteatfriedrice · Feb 27, 2024 · fb79e2f · fb79e2f · github-actions · Feb 28, 2024
1 parent f8f6883
commit fb79e2f
Show file tree

Hide file tree

Showing 539 changed files with 4,859 additions and 4,873 deletions.
diff --git a/README.md b/README.md
@@ -30,10 +30,10 @@ BlockSuite is a toolkit for building editors and collaborative applications. It
 You can consider BlockSuite as a [UI component library](https://blocksuite.io/components/overview.html) for building various editors, based on a minimized vanilla framework as their runtime. With BlockSuite, you can:
 
 - Reuse multiple first-party BlockSuite editors:
-  - [**`DocEditor`**](https://blocksuite.io/components/editors/doc-editor.html): A comprehensive block-based document editor, offering extensive customization and flexibility.
-  - [**`EdgelessEditor`**](https://blocksuite.io/components/editors/edgeless-editor.html): A graphics editor with opt-in canvas rendering support, but also shares the same rich-text capabilities with the `DocEditor`.
+  - [**`PageEditor`**](https://blocksuite.io/components/editors/page-editor.html): A comprehensive block-based document editor, offering extensive customization and flexibility.
+  - [**`EdgelessEditor`**](https://blocksuite.io/components/editors/edgeless-editor.html): A graphics editor with opt-in canvas rendering support, but also shares the same rich-text capabilities with the `PageEditor`.
 - Customize, extend and enhance these editors with a rich set of [BlockSuite components](https://blocksuite.io/components/overview.html). All BlockSuite components (including editors) are native web components, making them framework-agnostic and easy to interop with popular frameworks.
-- Or, build new editors from scratch based on the underlying vallina framework.
+- Or, build new editors from scratch based on the underlying vanilla framework.
 
 > 🚧 BlockSuite is currently in its early stage, with components and extension capabilities still under refinement. Hope you can stay tuned, try it out, or share your feedback!
 
@@ -108,7 +108,7 @@ To that end, the BlockSuite project is structured around key packages that are c
   </tr>
   <tr>
     <td><code>@blocksuite/presets</code></td>
-    <td>Plug-and-play editable components including <i>editors</i> (<code>DocEditor</code> / <code>EdgelessEditor</code>) and auxiliary UI components named <i>fragments</i> (<code>CopilotPanel</code>, <code>DocTitle</code>...).</td>
+    <td>Plug-and-play editable components including <i>editors</i> (<code>PageEditor</code> / <code>EdgelessEditor</code>) and auxiliary UI components named <i>fragments</i> (<code>CopilotPanel</code>, <code>DocTitle</code>...).</td>
   </tr>
 </table>
 

diff --git a/packages/blocks/src/__tests__/adapters/html.unit.spec.ts b/packages/blocks/src/__tests__/adapters/html.unit.spec.ts
@@ -38,7 +38,7 @@ const template = (html: string) =>
   </style>
 </head>
 <body>
-<div style="width: 70vw; margin: 60px auto;"><!--BlockSuitePageTitlePlaceholder-->
+<div style="width: 70vw; margin: 60px auto;"><!--BlockSuiteDocTitlePlaceholder-->
 <!--HtmlTemplate-->
 </div>
 </body>

diff --git a/packages/blocks/src/__tests__/database/database.unit.spec.ts b/packages/blocks/src/__tests__/database/database.unit.spec.ts
@@ -2,7 +2,7 @@
 import '../../database-block/kanban/define.js';
 import '../../database-block/table/define.js';
 
-import type { BlockModel, Page } from '@blocksuite/store';
+import type { BlockModel, Doc } from '@blocksuite/store';
 import { Generator, Schema, Workspace } from '@blocksuite/store';
 import { beforeEach, describe, expect, test } from 'vitest';
 
@@ -13,13 +13,13 @@ import type { DatabaseBlockModel } from '../../database-block/database-model.js'
 import { DatabaseBlockSchema } from '../../database-block/database-model.js';
 import type { Cell, Column } from '../../database-block/types.js';
 import { NoteBlockSchema } from '../../note-block/note-model.js';
-import { PageBlockSchema } from '../../page-block/page-model.js';
 import { ParagraphBlockSchema } from '../../paragraph-block/paragraph-model.js';
+import { RootBlockSchema } from '../../root-block/root-model.js';
 
 const AffineSchemas = [
-  ParagraphBlockSchema,
-  PageBlockSchema,
+  RootBlockSchema,
   NoteBlockSchema,
+  ParagraphBlockSchema,
   DatabaseBlockSchema,
 ];
 
@@ -30,19 +30,19 @@ function createTestOptions() {
   return { id: 'test-workspace', idGenerator, schema };
 }
 
-function createTestPage(pageId = 'page0') {
+function createTestDoc(docId = 'doc0') {
   const options = createTestOptions();
   const workspace = new Workspace(options);
-  const page = workspace.createPage({ id: pageId });
-  page.load();
-  return page;
+  const doc = workspace.createDoc({ id: docId });
+  doc.load();
+  return doc;
 }
 
 describe('DatabaseManager', () => {
-  let page: Page;
+  let doc: Doc;
   let db: DatabaseBlockModel;
 
-  let pageBlockId: BlockModel['id'];
+  let rootId: BlockModel['id'];
   let noteBlockId: BlockModel['id'];
   let databaseBlockId: BlockModel['id'];
   let p1: BlockModel['id'];
@@ -58,14 +58,14 @@ describe('DatabaseManager', () => {
   ];
 
   beforeEach(() => {
-    page = createTestPage();
+    doc = createTestDoc();
 
-    pageBlockId = page.addBlock('affine:page', {
-      title: new page.Text('database test'),
+    rootId = doc.addBlock('affine:page', {
+      title: new doc.Text('database test'),
     });
-    noteBlockId = page.addBlock('affine:note', {}, pageBlockId);
+    noteBlockId = doc.addBlock('affine:note', {}, rootId);
 
-    databaseBlockId = page.addBlock(
+    databaseBlockId = doc.addBlock(
       'affine:database' as BlockSuite.ModelKeys,
       {
         columns: [],
@@ -74,7 +74,7 @@ describe('DatabaseManager', () => {
       noteBlockId
     );
 
-    const databaseModel = page.getBlockById(
+    const databaseModel = doc.getBlockById(
       databaseBlockId
     ) as DatabaseBlockModel;
     db = databaseModel;
@@ -86,21 +86,21 @@ describe('DatabaseManager', () => {
     );
     col3 = db.addColumn('end', richTextPureColumnConfig.create('Rich Text'));
 
-    page.updateBlock(databaseModel, {
+    doc.updateBlock(databaseModel, {
       columns: [col1, col2, col3],
     });
 
-    p1 = page.addBlock(
+    p1 = doc.addBlock(
       'affine:paragraph',
       {
-        text: new page.Text('text1'),
+        text: new doc.Text('text1'),
       },
       databaseBlockId
     );
-    p2 = page.addBlock(
+    p2 = doc.addBlock(
       'affine:paragraph',
       {
-        text: new page.Text('text2'),
+        text: new doc.Text('text2'),
       },
       databaseBlockId
     );
@@ -148,10 +148,10 @@ describe('DatabaseManager', () => {
   });
 
   test('getCell', () => {
-    const modelId = page.addBlock(
+    const modelId = doc.addBlock(
       'affine:paragraph',
       {
-        text: new page.Text('paragraph'),
+        text: new doc.Text('paragraph'),
       },
       noteBlockId
     );
@@ -167,7 +167,7 @@ describe('DatabaseManager', () => {
     db.addColumn('end', column);
     db.updateCell(modelId, cell);
 
-    const model = page.getBlockById(modelId);
+    const model = doc.getBlockById(modelId);
 
     expect(model).not.toBeNull();
 
@@ -177,10 +177,10 @@ describe('DatabaseManager', () => {
   });
 
   test('updateCell', () => {
-    const newRowId = page.addBlock(
+    const newRowId = doc.addBlock(
       'affine:paragraph',
       {
-        text: new page.Text('text3'),
+        text: new doc.Text('text3'),
       },
       databaseBlockId
     );

diff --git a/packages/blocks/src/__tests__/migration/migration.unit.spec.ts b/packages/blocks/src/__tests__/migration/migration.unit.spec.ts
@@ -11,8 +11,8 @@ import { DatabaseBlockSchema } from '../../database-block/database-model.js';
 import { FrameBlockSchema } from '../../frame-block/frame-model.js';
 import { ListBlockSchema } from '../../list-block/list-model.js';
 import { NoteBlockSchema } from '../../note-block/note-model.js';
-import { PageBlockSchema } from '../../page-block/page-model.js';
 import { ParagraphBlockSchema } from '../../paragraph-block/paragraph-model.js';
+import { RootBlockSchema } from '../../root-block/root-model.js';
 import { SurfaceBlockSchema } from '../../surface-block/surface-model.js';
 
 async function loadBinary(name: string) {
@@ -27,7 +27,7 @@ async function loadBinary(name: string) {
 
 const schema = new Schema();
 schema.register([
-  PageBlockSchema,
+  RootBlockSchema,
   SurfaceBlockSchema,
   NoteBlockSchema,
   ParagraphBlockSchema,
@@ -76,7 +76,7 @@ describe('block migration', () => {
     assert.isUndefined(shape.get('bold'));
     assert.isUndefined(shape.get('italic'));
 
-    schema.upgradePage(
+    schema.upgradeDoc(
       0,
       {
         'affine:page': 1,
@@ -121,7 +121,7 @@ describe('block migration', () => {
 
     assert.exists(connector);
 
-    schema.upgradePage(
+    schema.upgradeDoc(
       0,
       {
         'affine:list': 1,
@@ -152,7 +152,7 @@ describe('block migration', () => {
       .get('value') as Y.Map<unknown>;
     assert.exists(surfaceElements.get('2'));
 
-    schema.upgradePage(
+    schema.upgradeDoc(
       0,
       {
         'affine:surface': 5,
@@ -182,7 +182,7 @@ describe('block migration', () => {
     ).toBeUndefined();
     expect(databaseBlock['prop:views'].length).toBe(2);
 
-    schema.upgradePage(
+    schema.upgradeDoc(
       0,
       {
         'affine:page': 1,

diff --git a/packages/blocks/src/_common/adapters/attachment.ts b/packages/blocks/src/_common/adapters/attachment.ts
@@ -2,18 +2,18 @@ import type { AssetsManager } from '@blocksuite/store';
 import {
   BaseAdapter,
   type BlockSnapshot,
+  type DocSnapshot,
   type FromBlockSnapshotPayload,
   type FromBlockSnapshotResult,
-  type FromPageSnapshotPayload,
-  type FromPageSnapshotResult,
+  type FromDocSnapshotPayload,
+  type FromDocSnapshotResult,
   type FromSliceSnapshotPayload,
   type FromSliceSnapshotResult,
   nanoid,
-  type PageSnapshot,
   sha,
   type SliceSnapshot,
   type ToBlockSnapshotPayload,
-  type ToPageSnapshotPayload,
+  type ToDocSnapshotPayload,
 } from '@blocksuite/store';
 
 export type Attachment = File[];
@@ -29,9 +29,9 @@ type AttachmentToSliceSnapshotPayload = {
 };
 
 export class AttachmentAdapter extends BaseAdapter<Attachment> {
-  override fromPageSnapshot(
-    _payload: FromPageSnapshotPayload
-  ): Promise<FromPageSnapshotResult<Attachment>> {
+  override fromDocSnapshot(
+    _payload: FromDocSnapshotPayload
+  ): Promise<FromDocSnapshotResult<Attachment>> {
     throw new Error('Method not implemented.');
   }
   override fromBlockSnapshot(
@@ -59,9 +59,9 @@ export class AttachmentAdapter extends BaseAdapter<Attachment> {
     }
     return Promise.resolve({ file: attachments, assetsIds: [] });
   }
-  override toPageSnapshot(
-    _payload: ToPageSnapshotPayload<Attachment>
-  ): Promise<PageSnapshot> {
+  override toDocSnapshot(
+    _payload: ToDocSnapshotPayload<Attachment>
+  ): Promise<DocSnapshot> {
     throw new Error('Method not implemented.');
   }
   override toBlockSnapshot(

diff --git a/packages/blocks/src/_common/adapters/html.ts b/packages/blocks/src/_common/adapters/html.ts
@@ -3,12 +3,12 @@ import type { DeltaInsert } from '@blocksuite/inline';
 import type {
   FromBlockSnapshotPayload,
   FromBlockSnapshotResult,
-  FromPageSnapshotPayload,
-  FromPageSnapshotResult,
+  FromDocSnapshotPayload,
+  FromDocSnapshotResult,
   FromSliceSnapshotPayload,
   FromSliceSnapshotResult,
   ToBlockSnapshotPayload,
-  ToPageSnapshotPayload,
+  ToDocSnapshotPayload,
 } from '@blocksuite/store';
 import {
   type AssetsManager,
@@ -20,7 +20,7 @@ import {
 import { ASTWalker, BaseAdapter } from '@blocksuite/store';
 import {
   type BlockSnapshot,
-  type PageSnapshot,
+  type DocSnapshot,
   type SliceSnapshot,
 } from '@blocksuite/store';
 import type { ElementContent, Root, Text } from 'hast';
@@ -60,16 +60,16 @@ type HtmlToSliceSnapshotPayload = {
 };
 
 export class HtmlAdapter extends BaseAdapter<Html> {
-  override async fromPageSnapshot(
-    payload: FromPageSnapshotPayload
-  ): Promise<FromPageSnapshotResult<string>> {
+  override async fromDocSnapshot(
+    payload: FromDocSnapshotPayload
+  ): Promise<FromDocSnapshotResult<string>> {
     const { file, assetsIds } = await this.fromBlockSnapshot({
       snapshot: payload.snapshot.blocks,
       assets: payload.assets,
     });
     return {
       file: file.replace(
-        '<!--BlockSuitePageTitlePlaceholder-->',
+        '<!--BlockSuiteDocTitlePlaceholder-->',
         `<h1>${payload.snapshot.meta.title}</h1>`
       ),
       assetsIds,
@@ -120,9 +120,9 @@ export class HtmlAdapter extends BaseAdapter<Html> {
       assetsIds: sliceAssetsIds,
     };
   }
-  override async toPageSnapshot(
-    payload: ToPageSnapshotPayload<string>
-  ): Promise<PageSnapshot> {
+  override async toDocSnapshot(
+    payload: ToDocSnapshotPayload<string>
+  ): Promise<DocSnapshot> {
     const htmlAst = this._htmlToAst(payload.file);
     const titleAst = hastQuerySelector(htmlAst, 'title');
     const blockSnapshotRoot = {
@@ -346,7 +346,7 @@ export class HtmlAdapter extends BaseAdapter<Html> {
             )
             .openNode({
               type: 'comment',
-              value: 'BlockSuitePageTitlePlaceholder',
+              value: 'BlockSuiteDocTitlePlaceholder',
             })
             .closeNode();
           break;

diff --git a/packages/blocks/src/_common/adapters/image.ts b/packages/blocks/src/_common/adapters/image.ts
@@ -2,18 +2,18 @@ import type { AssetsManager } from '@blocksuite/store';
 import {
   BaseAdapter,
   type BlockSnapshot,
+  type DocSnapshot,
   type FromBlockSnapshotPayload,
   type FromBlockSnapshotResult,
-  type FromPageSnapshotPayload,
-  type FromPageSnapshotResult,
+  type FromDocSnapshotPayload,
+  type FromDocSnapshotResult,
   type FromSliceSnapshotPayload,
   type FromSliceSnapshotResult,
   nanoid,
-  type PageSnapshot,
   sha,
   type SliceSnapshot,
   type ToBlockSnapshotPayload,
-  type ToPageSnapshotPayload,
+  type ToDocSnapshotPayload,
 } from '@blocksuite/store';
 
 export type Image = File[];
@@ -29,9 +29,9 @@ type ImageToSliceSnapshotPayload = {
 };
 
 export class ImageAdapter extends BaseAdapter<Image> {
-  override fromPageSnapshot(
-    _payload: FromPageSnapshotPayload
-  ): Promise<FromPageSnapshotResult<Image>> {
+  override fromDocSnapshot(
+    _payload: FromDocSnapshotPayload
+  ): Promise<FromDocSnapshotResult<Image>> {
     throw new Error('Method not implemented.');
   }
   override fromBlockSnapshot(
@@ -59,9 +59,9 @@ export class ImageAdapter extends BaseAdapter<Image> {
     }
     return Promise.resolve({ file: images, assetsIds: [] });
   }
-  override toPageSnapshot(
-    _payload: ToPageSnapshotPayload<Image>
-  ): Promise<PageSnapshot> {
+  override toDocSnapshot(
+    _payload: ToDocSnapshotPayload<Image>
+  ): Promise<DocSnapshot> {
     throw new Error('Method not implemented.');
   }
   override toBlockSnapshot(
Name	Size	Gzip	Brotli
blocks	2.18 MB (-816 B)	507 kB (+398 B)	370 kB (-80 B)
editor	84 B	89 B	63 B
store	83 B	88 B	63 B
inline	84 B	88 B	63 B