feat(store): add block collection and selector

[Saul-Mirone]

Block Collection and Selector

Block collection is the abstract layer that holds the data source of a y.doc.
It is used to compute block models of a doc.
The compute process can be controlled by a selector.

This feature is designed to make it possible to partially render the data source.

Doc = BlockCollection(Selector)

If there's a doc contains following blocks:

<affine-page id="0">
  <affine-note id="1">
    <affine-paragraph id="2" />
    <affine-list id="3" />
  </affine-note>
</affine-page>

If we pass in a selector like this:

const selector = (block, doc) => {
  return block.model.flavour !== 'affine:list';
} 
const doc = collection.getDoc(docId, selector)

You'll get:

<affine-page id="0">
  <affine-note id="1">
    <affine-paragraph id="2" />
  </affine-note>
</affine-page>

With the same selector, you'll always get the same instance:

const selector = (block, doc) => {
  return block.model.flavour !== 'affine:list';
} 
const doc1 = collection.getDoc(docId, selector)
const doc2 = collection.getDoc(docId, selector)

doc1 === doc2 // true;

All getDoc and createDoc will have () => true as the default selector.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
blocksuite	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 12, 2024 7:49am

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
blocksuite-docs	⬜️ Ignored (Inspect)	Visit Preview		Apr 12, 2024 7:49am