feat(editor): note extension (#11856)

Closes: BS-3200
Closes: BS-3201

blocksuite/affine/all/package.json

@@ -127,8 +127,12 @@
     "./blocks/list": "./src/blocks/list/index.ts",
     "./blocks/list/store": "./src/blocks/list/store.ts",
     "./blocks/list/view": "./src/blocks/list/view.ts",
-    "./blocks/note": "./src/blocks/note.ts",
-    "./blocks/paragraph": "./src/blocks/paragraph.ts",
+    "./blocks/note": "./src/blocks/note/index.ts",
+    "./blocks/note/store": "./src/blocks/note/store.ts",
+    "./blocks/note/view": "./src/blocks/note/view.ts",
+    "./blocks/paragraph": "./src/blocks/paragraph/index.ts",
+    "./blocks/paragraph/store": "./src/blocks/paragraph/store.ts",
+    "./blocks/paragraph/view": "./src/blocks/paragraph/view.ts",
     "./blocks/root": "./src/blocks/root.ts",
     "./blocks/surface": "./src/blocks/surface.ts",
     "./blocks/surface-ref": "./src/blocks/surface-ref.ts",

blocksuite/affine/all/src/blocks/note/store.ts

@@ -0,0 +1 @@
+export * from '@blocksuite/affine-block-note/store';

blocksuite/affine/all/src/blocks/note/view.ts

@@ -0,0 +1 @@
+export * from '@blocksuite/affine-block-note/view';

blocksuite/affine/all/src/blocks/paragraph/store.ts

@@ -0,0 +1 @@
+export * from '@blocksuite/affine-block-paragraph/store';

blocksuite/affine/all/src/blocks/paragraph/view.ts

@@ -0,0 +1 @@
+export * from '@blocksuite/affine-block-paragraph/view';

blocksuite/affine/blocks/image/src/store.ts

@@ -13,7 +13,9 @@ const ImageStoreExtensionOptionsSchema = z.object({
   imageProxyURL: z.string().optional(),
 });
 
-export class ImageStoreExtension extends StoreExtensionProvider {
+export class ImageStoreExtension extends StoreExtensionProvider<
+  z.infer<typeof ImageStoreExtensionOptionsSchema>
+> {
   override name = 'affine-image-block';
 
   override schema = ImageStoreExtensionOptionsSchema;

blocksuite/affine/blocks/note/package.json

@@ -13,6 +13,7 @@
     "@blocksuite/affine-block-embed": "workspace:*",
     "@blocksuite/affine-block-surface": "workspace:*",
     "@blocksuite/affine-components": "workspace:*",
+    "@blocksuite/affine-ext-loader": "workspace:*",
     "@blocksuite/affine-fragment-doc-title": "workspace:*",
     "@blocksuite/affine-gfx-turbo-renderer": "workspace:*",
     "@blocksuite/affine-inline-preset": "workspace:*",
@@ -39,7 +40,9 @@
   "exports": {
     ".": "./src/index.ts",
     "./effects": "./src/effects.ts",
-    "./turbo-painter": "./src/turbo/note-painter.worker.ts"
+    "./turbo-painter": "./src/turbo/note-painter.worker.ts",
+    "./store": "./src/store.ts",
+    "./view": "./src/view.ts"
   },
   "files": [
     "src",

blocksuite/affine/blocks/note/src/store.ts

@@ -0,0 +1,36 @@
+import {
+  type StoreExtensionContext,
+  StoreExtensionProvider,
+} from '@blocksuite/affine-ext-loader';
+import { NoteBlockSchemaExtension } from '@blocksuite/affine-model';
+import { z } from 'zod';
+
+import {
+  DocNoteBlockAdapterExtensions,
+  EdgelessNoteBlockAdapterExtensions,
+} from './adapters';
+
+const optionsSchema = z.object({
+  mode: z.enum(['doc', 'edgeless']).optional(),
+});
+
+export class NoteStoreExtension extends StoreExtensionProvider<
+  z.infer<typeof optionsSchema>
+> {
+  override name = 'affine-note-block';
+
+  override schema = optionsSchema;
+
+  override setup(
+    context: StoreExtensionContext,
+    options?: z.infer<typeof optionsSchema>
+  ) {
+    super.setup(context);
+    context.register(NoteBlockSchemaExtension);
+    if (options?.mode === 'edgeless') {
+      context.register(EdgelessNoteBlockAdapterExtensions);
+    } else {
+      context.register(DocNoteBlockAdapterExtensions);
+    }
+  }
+}

blocksuite/affine/blocks/note/src/view.ts

@@ -0,0 +1,47 @@
+import {
+  type ViewExtensionContext,
+  ViewExtensionProvider,
+} from '@blocksuite/affine-ext-loader';
+import { NoteBlockSchema } from '@blocksuite/affine-model';
+import { BlockViewExtension, FlavourExtension } from '@blocksuite/std';
+import { literal } from 'lit/static-html.js';
+
+import { NoteSlashMenuConfigExtension } from './configs/slash-menu';
+import { createBuiltinToolbarConfigExtension } from './configs/toolbar';
+import { effects } from './effects';
+import { NoteKeymapExtension } from './note-keymap';
+
+const flavour = NoteBlockSchema.model.flavour;
+
+export class NoteViewExtension extends ViewExtensionProvider {
+  override name = 'affine-note-block';
+
+  override effect() {
+    super.effect();
+    effects();
+  }
+
+  override setup(context: ViewExtensionContext) {
+    super.setup(context);
+    context.register([
+      FlavourExtension(flavour),
+      NoteSlashMenuConfigExtension,
+      NoteKeymapExtension,
+    ]);
+
+    const scope = context.scope;
+    const isEdgeless =
+      scope === 'edgeless' ||
+      scope === 'preview-edgeless' ||
+      scope === 'mobile-edgeless';
+
+    if (isEdgeless) {
+      context.register(
+        BlockViewExtension(flavour, literal`affine-edgeless-note`)
+      );
+      context.register(createBuiltinToolbarConfigExtension(flavour));
+    } else {
+      context.register(BlockViewExtension(flavour, literal`affine-note`));
+    }
+  }
+}

blocksuite/affine/blocks/note/tsconfig.json

@@ -10,6 +10,7 @@
     { "path": "../embed" },
     { "path": "../surface" },
     { "path": "../../components" },
+    { "path": "../../ext-loader" },
     { "path": "../../fragments/doc-title" },
     { "path": "../../gfx/turbo-renderer" },
     { "path": "../../inlines/preset" },

blocksuite/affine/blocks/paragraph/package.json

@@ -11,6 +11,7 @@
   "license": "MIT",
   "dependencies": {
     "@blocksuite/affine-components": "workspace:*",
+    "@blocksuite/affine-ext-loader": "workspace:*",
     "@blocksuite/affine-gfx-turbo-renderer": "workspace:*",
     "@blocksuite/affine-inline-preset": "workspace:*",
     "@blocksuite/affine-model": "workspace:*",
@@ -32,7 +33,9 @@
   "exports": {
     ".": "./src/index.ts",
     "./effects": "./src/effects.ts",
-    "./turbo-painter": "./src/turbo/paragraph-painter.worker.ts"
+    "./turbo-painter": "./src/turbo/paragraph-painter.worker.ts",
+    "./store": "./src/store.ts",
+    "./view": "./src/view.ts"
   },
   "files": [
     "src",

blocksuite/affine/blocks/paragraph/src/store.ts

@@ -0,0 +1,17 @@
+import {
+  type StoreExtensionContext,
+  StoreExtensionProvider,
+} from '@blocksuite/affine-ext-loader';
+import { ParagraphBlockSchemaExtension } from '@blocksuite/affine-model';
+
+import { ParagraphBlockAdapterExtensions } from './adapters/extension';
+
+export class ParagraphStoreExtension extends StoreExtensionProvider {
+  override name = 'affine-paragraph-block';
+
+  override setup(context: StoreExtensionContext) {
+    super.setup(context);
+    context.register(ParagraphBlockSchemaExtension);
+    context.register(ParagraphBlockAdapterExtensions);
+  }
+}

blocksuite/affine/blocks/paragraph/src/view.ts

@@ -0,0 +1,67 @@
+import {
+  type ViewExtensionContext,
+  ViewExtensionProvider,
+} from '@blocksuite/affine-ext-loader';
+import { BlockViewExtension, FlavourExtension } from '@blocksuite/std';
+import { literal } from 'lit/static-html.js';
+
+import { ParagraphBlockConfigExtension } from './paragraph-block-config.js';
+import {
+  ParagraphKeymapExtension,
+  ParagraphTextKeymapExtension,
+} from './paragraph-keymap.js';
+
+const placeholders = {
+  text: "Type '/' for commands",
+  h1: 'Heading 1',
+  h2: 'Heading 2',
+  h3: 'Heading 3',
+  h4: 'Heading 4',
+  h5: 'Heading 5',
+  h6: 'Heading 6',
+  quote: '',
+};
+
+import { ParagraphBlockModel } from '@blocksuite/affine-model';
+import { z } from 'zod';
+
+import { effects } from './effects';
+
+const optionsSchema = z.object({
+  getPlaceholder: z
+    .function()
+    .args(z.instanceof(ParagraphBlockModel))
+    .returns(z.string()),
+});
+
+export class ParagraphViewExtension extends ViewExtensionProvider<
+  z.infer<typeof optionsSchema>
+> {
+  override name = 'affine-paragraph-block';
+
+  override schema = optionsSchema;
+
+  override effect(): void {
+    super.effect();
+    effects();
+  }
+
+  override setup(
+    context: ViewExtensionContext,
+    options?: z.infer<typeof optionsSchema>
+  ) {
+    super.setup(context);
+    const getPlaceholder =
+      options?.getPlaceholder ?? (model => placeholders[model.props.type]);
+
+    context.register([
+      FlavourExtension('affine:paragraph'),
+      BlockViewExtension('affine:paragraph', literal`affine-paragraph`),
+      ParagraphTextKeymapExtension,
+      ParagraphKeymapExtension,
+      ParagraphBlockConfigExtension({
+        getPlaceholder,
+      }),
+    ]);
+  }
+}

blocksuite/affine/blocks/paragraph/tsconfig.json

@@ -8,6 +8,7 @@
   "include": ["./src"],
   "references": [
     { "path": "../../components" },
+    { "path": "../../ext-loader" },
     { "path": "../../gfx/turbo-renderer" },
     { "path": "../../inlines/preset" },
     { "path": "../../model" },