@blocksuite/store

This package is the data layer for modeling collaborative document states. It's natively built on the CRDT library Yjs, powering all BlockSuite documents with built-in real-time collaboration and time-travel capabilities.

Doc

In BlockSuite, a Doc is the container for a block tree, providing essential functionalities for creating, retrieving, updating, and deleting blocks inside it. Under the hood, every doc holds a Yjs subdocument.

Besides the block tree, the selection state is also stored in the doc.awarenessStore inside the doc. This store is also built on top of the Yjs awareness.

Workspace

In BlockSuite, a Workspace is defined as an opt-in collection of multiple docs, providing comprehensive features for managing cross-doc updates and data synchronization. You can access the workspace via the doc.workspace getter, or you can also create a workspace manually:

import { Workspace, Schema } from '@blocksuite/store';

const schema = new Schema();

// You can register a batch of block schemas to the workspace
schema.register(AffineSchemas);

const workspace = new Workspace({ schema });

Then multiple docs can be created under the workspace:

const workspace = new Workspace({ schema });

// This is an empty doc at this moment
const doc = workspace.createDoc();

As an example, the createEmptyDoc is a simple helper implemented exactly in this way (source):

import { AffineSchemas } from '@blocksuite/blocks/models';
import { Schema, Workspace } from '@blocksuite/store';

export function createEmptyDoc() {
  const schema = new Schema().register(AffineSchemas);
  const workspace = new Workspace({ schema });
  const doc = workspace.createDoc();

  return {
    doc,
    async init() {
      await doc.load(() => {
        const rootBlockId = doc.addBlock('affine:page', {});
        doc.addBlock('affine:surface', {}, rootBlockId);
        const noteId = doc.addBlock('affine:note', {}, rootBlockId);
        doc.addBlock('affine:paragraph', {}, noteId);
      });
      return doc;
    },
  };
}