feat(editor): schema extension

blocksuite/affine/block-data-view/src/data-view-model.ts

@@ -5,7 +5,11 @@ import {
   type InsertToPosition,
 } from '@blocksuite/affine-shared/utils';
 import type { DataViewDataType } from '@blocksuite/data-view';
-import { BlockModel, defineBlockSchema } from '@blocksuite/store';
+import {
+  BlockModel,
+  BlockSchemaExtension,
+  defineBlockSchema,
+} from '@blocksuite/store';
 
 type Props = {
   title: string;
@@ -93,3 +97,6 @@ export const DataViewBlockSchema = defineBlockSchema({
     return new DataViewBlockModel();
   },
 });
+
+export const DataViewBlockSchemaExtension =
+  BlockSchemaExtension(DataViewBlockSchema);

blocksuite/affine/block-root/src/edgeless/clipboard/clipboard.ts

@@ -374,7 +374,7 @@ export class EdgelessClipboardController extends PageClipboard {
         const elementsRawData = JSON.parse(mayBeSurfaceDataJson);
         const { snapshot, blobs } = elementsRawData;
         const job = new Transformer({
-          schema: this.std.workspace.schema,
+          schema: this.std.store.schema,
           blobCRUD: this.std.workspace.blobSync,
           docCRUD: {
             create: (id: string) => this.std.workspace.createDoc({ id }),
@@ -1378,7 +1378,7 @@ export async function prepareClipboardData(
   std: BlockStdScope
 ) {
   const job = new Transformer({
-    schema: std.workspace.schema,
+    schema: std.store.schema,
     blobCRUD: std.workspace.blobSync,
     docCRUD: {
       create: (id: string) => std.workspace.createDoc({ id }),

blocksuite/affine/block-root/src/edgeless/services/template.ts

@@ -91,7 +91,7 @@ export class TemplateJob {
 
   constructor({ model, type, middlewares }: TemplateJobConfig) {
     this.job = new Transformer({
-      schema: model.doc.workspace.schema,
+      schema: model.doc.schema,
       blobCRUD: model.doc.workspace.blobSync,
       docCRUD: {
         create: (id: string) => model.doc.workspace.createDoc({ id }),
@@ -320,8 +320,7 @@ export class TemplateJob {
     from: Record<string, Record<string, unknown>>,
     to: Y.Map<Y.Map<unknown>>
   ) {
-    const schema =
-      this.model.doc.workspace.schema.flavourSchemaMap.get('affine:surface');
+    const schema = this.model.doc.schema.get('affine:surface');
     const surfaceTransformer = schema?.transformer?.(
       new Map()
     ) as SurfaceBlockTransformer;

blocksuite/affine/block-root/src/edgeless/utils/clone-utils.ts

@@ -41,7 +41,7 @@ export function getSortedCloneElements(elements: GfxModel[]) {
 export function prepareCloneData(elements: GfxModel[], std: BlockStdScope) {
   elements = sortEdgelessElements(elements);
   const job = new Transformer({
-    schema: std.workspace.schema,
+    schema: std.store.schema,
     blobCRUD: std.workspace.blobSync,
     docCRUD: {
       create: (id: string) => std.workspace.createDoc({ id }),

blocksuite/affine/block-root/src/transformers/html.ts

@@ -8,19 +8,21 @@ import {
 import { SpecProvider } from '@blocksuite/affine-shared/utils';
 import { Container } from '@blocksuite/global/di';
 import { sha } from '@blocksuite/global/utils';
-import type { Store, Workspace } from '@blocksuite/store';
+import type { Schema, Store, Workspace } from '@blocksuite/store';
 import { extMimeMap, Transformer } from '@blocksuite/store';
 
 import { createAssetsArchive, download, Unzip } from './utils.js';
 
 type ImportHTMLToDocOptions = {
   collection: Workspace;
+  schema: Schema;
   html: string;
   fileName?: string;
 };
 
 type ImportHTMLZipOptions = {
   collection: Workspace;
+  schema: Schema;
   imported: Blob;
 };
 
@@ -87,18 +89,20 @@ async function exportDoc(doc: Store) {
  *
  * @param options - The import options.
  * @param options.collection - The target doc collection.
+ * @param options.schema - The schema of the target doc collection.
  * @param options.html - The HTML content to import.
  * @param options.fileName - Optional filename for the imported doc.
  * @returns A Promise that resolves to the ID of the newly created doc, or undefined if import fails.
  */
 async function importHTMLToDoc({
   collection,
+  schema,
   html,
   fileName,
 }: ImportHTMLToDocOptions) {
   const provider = getProvider();
   const job = new Transformer({
-    schema: collection.schema,
+    schema,
     blobCRUD: collection.blobSync,
     docCRUD: {
       create: (id: string) => collection.createDoc({ id }),
@@ -127,10 +131,15 @@ async function importHTMLToDoc({
  *
  * @param options - The import options.
  * @param options.collection - The target doc collection.
+ * @param options.schema - The schema of the target doc collection.
  * @param options.imported - The zip file as a Blob.
  * @returns A Promise that resolves to an array of IDs of the newly created docs.
  */
-async function importHTMLZip({ collection, imported }: ImportHTMLZipOptions) {
+async function importHTMLZip({
+  collection,
+  schema,
+  imported,
+}: ImportHTMLZipOptions) {
   const provider = getProvider();
   const unzip = new Unzip();
   await unzip.load(imported);
@@ -161,7 +170,7 @@ async function importHTMLZip({ collection, imported }: ImportHTMLZipOptions) {
     htmlBlobs.map(async ([fileName, blob]) => {
       const fileNameWithoutExt = fileName.replace(/\.[^/.]+$/, '');
       const job = new Transformer({
-        schema: collection.schema,
+        schema,
         blobCRUD: collection.blobSync,
         docCRUD: {
           create: (id: string) => collection.createDoc({ id }),

blocksuite/affine/block-root/src/transformers/markdown.ts

@@ -9,7 +9,7 @@ import { SpecProvider } from '@blocksuite/affine-shared/utils';
 import { Container } from '@blocksuite/global/di';
 import { BlockSuiteError, ErrorCode } from '@blocksuite/global/exceptions';
 import { assertExists, sha } from '@blocksuite/global/utils';
-import type { Store, Workspace } from '@blocksuite/store';
+import type { Schema, Store, Workspace } from '@blocksuite/store';
 import { extMimeMap, Transformer } from '@blocksuite/store';
 
 import { createAssetsArchive, download, Unzip } from './utils.js';
@@ -31,12 +31,14 @@ type ImportMarkdownToBlockOptions = {
 
 type ImportMarkdownToDocOptions = {
   collection: Workspace;
+  schema: Schema;
   markdown: string;
   fileName?: string;
 };
 
 type ImportMarkdownZipOptions = {
   collection: Workspace;
+  schema: Schema;
   imported: Blob;
 };
 
@@ -143,18 +145,20 @@ async function importMarkdownToBlock({
  * Imports Markdown content into a new doc within a collection.
  * @param options Object containing import options
  * @param options.collection The target doc collection
+ * @param options.schema The schema of the target doc collection
  * @param options.markdown The Markdown content to import
  * @param options.fileName Optional filename for the imported doc
  * @returns A Promise that resolves to the ID of the newly created doc, or undefined if import fails
  */
 async function importMarkdownToDoc({
   collection,
+  schema,
   markdown,
   fileName,
 }: ImportMarkdownToDocOptions) {
   const provider = getProvider();
   const job = new Transformer({
-    schema: collection.schema,
+    schema,
     blobCRUD: collection.blobSync,
     docCRUD: {
       create: (id: string) => collection.createDoc({ id }),
@@ -182,11 +186,13 @@ async function importMarkdownToDoc({
  * Imports a zip file containing Markdown files and assets into a collection.
  * @param options Object containing import options
  * @param options.collection The target doc collection
+ * @param options.schema The schema of the target doc collection
  * @param options.imported The zip file as a Blob
  * @returns A Promise that resolves to an array of IDs of the newly created docs
  */
 async function importMarkdownZip({
   collection,
+  schema,
   imported,
 }: ImportMarkdownZipOptions) {
   const provider = getProvider();
@@ -219,7 +225,7 @@ async function importMarkdownZip({
     markdownBlobs.map(async ([fileName, blob]) => {
       const fileNameWithoutExt = fileName.replace(/\.[^/.]+$/, '');
       const job = new Transformer({
-        schema: collection.schema,
+        schema,
         blobCRUD: collection.blobSync,
         docCRUD: {
           create: (id: string) => collection.createDoc({ id }),

blocksuite/affine/block-root/src/transformers/notion-html.ts

@@ -3,12 +3,18 @@ import { NotionHtmlAdapter } from '@blocksuite/affine-shared/adapters';
 import { SpecProvider } from '@blocksuite/affine-shared/utils';
 import { Container } from '@blocksuite/global/di';
 import { sha } from '@blocksuite/global/utils';
-import { extMimeMap, Transformer, type Workspace } from '@blocksuite/store';
+import {
+  extMimeMap,
+  type Schema,
+  Transformer,
+  type Workspace,
+} from '@blocksuite/store';
 
 import { Unzip } from './utils.js';
 
 type ImportNotionZipOptions = {
   collection: Workspace;
+  schema: Schema;
   imported: Blob;
 };
 
@@ -26,6 +32,7 @@ function getProvider() {
  *
  * @param options - The options for importing.
  * @param options.collection - The BlockSuite document collection.
+ * @param options.schema - The schema of the BlockSuite document collection.
  * @param options.imported - The imported zip file as a Blob.
  *
  * @returns A promise that resolves to an object containing:
@@ -36,6 +43,7 @@ function getProvider() {
  */
 async function importNotionZip({
   collection,
+  schema,
   imported,
 }: ImportNotionZipOptions) {
   const provider = getProvider();
@@ -117,7 +125,7 @@ async function importNotionZip({
     }
     const pagePromises = Array.from(pagePaths).map(async path => {
       const job = new Transformer({
-        schema: collection.schema,
+        schema,
         blobCRUD: collection.blobSync,
         docCRUD: {
           create: (id: string) => collection.createDoc({ id }),

blocksuite/affine/block-root/src/transformers/zip.ts

@@ -3,15 +3,19 @@ import {
   titleMiddleware,
 } from '@blocksuite/affine-shared/adapters';
 import { sha } from '@blocksuite/global/utils';
-import type { DocSnapshot, Store, Workspace } from '@blocksuite/store';
+import type { DocSnapshot, Schema, Store, Workspace } from '@blocksuite/store';
 import { extMimeMap, getAssetName, Transformer } from '@blocksuite/store';
 
 import { download, Unzip, Zip } from '../transformers/utils.js';
 
-async function exportDocs(collection: Workspace, docs: Store[]) {
+async function exportDocs(
+  collection: Workspace,
+  schema: Schema,
+  docs: Store[]
+) {
   const zip = new Zip();
   const job = new Transformer({
-    schema: collection.schema,
+    schema,
     blobCRUD: collection.blobSync,
     docCRUD: {
       create: (id: string) => collection.createDoc({ id }),
@@ -70,7 +74,11 @@ async function exportDocs(collection: Workspace, docs: Store[]) {
   return download(downloadBlob, `${collection.id}.bs.zip`);
 }
 
-async function importDocs(collection: Workspace, imported: Blob) {
+async function importDocs(
+  collection: Workspace,
+  schema: Schema,
+  imported: Blob
+) {
   const unzip = new Unzip();
   await unzip.load(imported);
 
@@ -98,7 +106,7 @@ async function importDocs(collection: Workspace, imported: Blob) {
   }
 
   const job = new Transformer({
-    schema: collection.schema,
+    schema,
     blobCRUD: collection.blobSync,
     docCRUD: {
       create: (id: string) => collection.createDoc({ id }),

blocksuite/affine/block-root/src/widgets/linked-doc/config.ts

@@ -233,6 +233,7 @@ export function createNewDocMenuGroup(
           };
           showImportModal({
             collection: doc.workspace,
+            schema: doc.schema,
             onSuccess,
             onFail,
           });

blocksuite/affine/block-root/src/widgets/linked-doc/import-doc/import-doc.ts

@@ -8,7 +8,7 @@ import {
 } from '@blocksuite/affine-components/icons';
 import { openFileOrFiles } from '@blocksuite/affine-shared/utils';
 import { WithDisposable } from '@blocksuite/global/utils';
-import type { Workspace } from '@blocksuite/store';
+import type { Schema, Workspace } from '@blocksuite/store';
 import { html, LitElement, type PropertyValues } from 'lit';
 import { query, state } from 'lit/decorators.js';
 
@@ -31,6 +31,7 @@ export class ImportDoc extends WithDisposable(LitElement) {
 
   constructor(
     private readonly collection: Workspace,
+    private readonly schema: Schema,
     private readonly onSuccess?: OnSuccessHandler,
     private readonly onFail?: OnFailHandler,
     private readonly abortController = new AbortController()
@@ -63,6 +64,7 @@ export class ImportDoc extends WithDisposable(LitElement) {
       }
       const pageId = await HtmlTransformer.importHTMLToDoc({
         collection: this.collection,
+        schema: this.schema,
         html: text,
         fileName,
       });
@@ -93,6 +95,7 @@ export class ImportDoc extends WithDisposable(LitElement) {
       }
       const pageId = await MarkdownTransformer.importMarkdownToDoc({
         collection: this.collection,
+        schema: this.schema,
         markdown: text,
         fileName,
       });
@@ -117,6 +120,7 @@ export class ImportDoc extends WithDisposable(LitElement) {
     const { entryId, pageIds, isWorkspaceFile, hasMarkdown } =
       await NotionHtmlTransformer.importNotionZip({
         collection: this.collection,
+        schema: this.schema,
         imported: file,
       });
     needLoading && this.abortController.abort();

blocksuite/affine/block-root/src/widgets/linked-doc/import-doc/index.ts

@@ -1,4 +1,4 @@
-import type { Workspace } from '@blocksuite/store';
+import type { Schema, Workspace } from '@blocksuite/store';
 
 import {
   ImportDoc,
@@ -7,12 +7,14 @@ import {
 } from './import-doc.js';
 
 export function showImportModal({
+  schema,
   collection,
   onSuccess,
   onFail,
   container = document.body,
   abortController = new AbortController(),
 }: {
+  schema: Schema;
   collection: Workspace;
   onSuccess?: OnSuccessHandler;
   onFail?: OnFailHandler;
@@ -22,6 +24,7 @@ export function showImportModal({
 }) {
   const importDoc = new ImportDoc(
     collection,
+    schema,
     onSuccess,
     onFail,
     abortController

blocksuite/affine/block-surface/src/index.ts

@@ -50,7 +50,11 @@ export {
 } from './adapters/index.js';
 export type { SurfaceContext } from './surface-block.js';
 export { SurfaceBlockComponent } from './surface-block.js';
-export { SurfaceBlockModel, SurfaceBlockSchema } from './surface-model.js';
+export {
+  SurfaceBlockModel,
+  SurfaceBlockSchema,
+  SurfaceBlockSchemaExtension,
+} from './surface-model.js';
 export type { SurfaceBlockService } from './surface-service.js';
 export {
   EdgelessSurfaceBlockSpec,