Skip to content

There can be more than Notion and Miro. AFFiNE(pronounced [ə‘fain]) is a next-gen knowledge base that brings planning, sorting and creating all together. Privacy first, open-source, customizable and ready to use.

refactor(editor): use spec builder (#9424)

Saul-Mironeb66a64bc9a77
diff --git a/blocksuite/affine/shared/src/utils/spec/spec-builder.ts b/blocksuite/affine/shared/src/utils/spec/spec-builder.ts
index 810288647e..922acbacdd 100644
--- a/blocksuite/affine/shared/src/utils/spec/spec-builder.ts
+++ b/blocksuite/affine/shared/src/utils/spec/spec-builder.ts
@@ -19,9 +19,10 @@ export class SpecBuilder {
this._value = this._value.filter(extension => extension !== target);
}
- replace(target: ExtensionType, newExtension: ExtensionType) {
- this._value = this._value.map(extension =>
- extension === target ? newExtension : extension
- );
+ replace(target: ExtensionType[], newExtension: ExtensionType[]) {
+ this._value = [
+ ...this._value.filter(extension => !target.includes(extension)),
+ ...newExtension,
+ ];
}
}
diff --git a/blocksuite/blocks/src/_specs/common.ts b/blocksuite/blocks/src/_specs/common.ts
index 7e11e58b56..39bc53f1eb 100644
--- a/blocksuite/blocks/src/_specs/common.ts
+++ b/blocksuite/blocks/src/_specs/common.ts
@@ -22,6 +22,7 @@ import {
RichTextExtensions,
} from '@blocksuite/affine-components/rich-text';
import {
+ DocDisplayMetaService,
EditPropsStore,
FontLoaderService,
} from '@blocksuite/affine-shared/services';
@@ -36,6 +37,7 @@ import {
} from '../surface-ref-block/surface-ref-spec.js';
export const CommonBlockSpecs: ExtensionType[] = [
+ DocDisplayMetaService,
RefNodeSlotsExtension,
EditPropsStore,
RichTextExtensions,
@@ -54,7 +56,7 @@ export const CommonBlockSpecs: ExtensionType[] = [
].flat();
export const PageFirstPartyBlockSpecs: ExtensionType[] = [
- ...CommonBlockSpecs,
+ CommonBlockSpecs,
NoteBlockSpec,
PageSurfaceBlockSpec,
PageSurfaceRefBlockSpec,
@@ -62,7 +64,7 @@ export const PageFirstPartyBlockSpecs: ExtensionType[] = [
].flat();
export const EdgelessFirstPartyBlockSpecs: ExtensionType[] = [
- ...CommonBlockSpecs,
+ CommonBlockSpecs,
EdgelessNoteBlockSpec,
EdgelessSurfaceBlockSpec,
diff --git a/blocksuite/blocks/src/_specs/group/common.ts b/blocksuite/blocks/src/_specs/group/common.ts
deleted file mode 100644
index bdcbd8fe9f..0000000000
--- a/blocksuite/blocks/src/_specs/group/common.ts
+++ /dev/null
@@ -1,44 +0,0 @@
-import { AttachmentBlockSpec } from '@blocksuite/affine-block-attachment';
-import { BookmarkBlockSpec } from '@blocksuite/affine-block-bookmark';
-import { CodeBlockSpec } from '@blocksuite/affine-block-code';
-import { DividerBlockSpec } from '@blocksuite/affine-block-divider';
-import {
- EmbedFigmaBlockSpec,
- EmbedGithubBlockSpec,
- EmbedHtmlBlockSpec,
- EmbedLinkedDocBlockSpec,
- EmbedLoomBlockSpec,
- EmbedSyncedDocBlockSpec,
- EmbedYoutubeBlockSpec,
-} from '@blocksuite/affine-block-embed';
-import { ImageBlockSpec } from '@blocksuite/affine-block-image';
-import { ListBlockSpec } from '@blocksuite/affine-block-list';
-import {
- EdgelessNoteBlockSpec,
- NoteBlockSpec,
-} from '@blocksuite/affine-block-note';
-import { ParagraphBlockSpec } from '@blocksuite/affine-block-paragraph';
-
-import { DataViewBlockSpec } from '../../data-view-block/data-view-spec.js';
-import { DatabaseBlockSpec } from '../../database-block/database-spec.js';
-
-export {
- AttachmentBlockSpec,
- BookmarkBlockSpec,
- CodeBlockSpec,
- DatabaseBlockSpec,
- DataViewBlockSpec,
- DividerBlockSpec,
- EdgelessNoteBlockSpec,
- EmbedFigmaBlockSpec,
- EmbedGithubBlockSpec,
- EmbedHtmlBlockSpec,
- EmbedLinkedDocBlockSpec,
- EmbedLoomBlockSpec,
- EmbedSyncedDocBlockSpec,
- EmbedYoutubeBlockSpec,
- ImageBlockSpec,
- ListBlockSpec,
- NoteBlockSpec,
- ParagraphBlockSpec,
-};
diff --git a/blocksuite/blocks/src/_specs/group/edgeless.ts b/blocksuite/blocks/src/_specs/group/edgeless.ts
deleted file mode 100644
index 5cb47c73dc..0000000000
--- a/blocksuite/blocks/src/_specs/group/edgeless.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-import { EdgelessTextBlockSpec } from '@blocksuite/affine-block-edgeless-text';
-import { FrameBlockSpec } from '@blocksuite/affine-block-frame';
-import { LatexBlockSpec } from '@blocksuite/affine-block-latex';
-import { EdgelessSurfaceBlockSpec } from '@blocksuite/affine-block-surface';
-
-import { EdgelessRootBlockSpec } from '../../root-block/edgeless/edgeless-root-spec.js';
-import { EdgelessSurfaceRefBlockSpec } from '../../surface-ref-block/surface-ref-spec.js';
-
-export {
- EdgelessRootBlockSpec,
- EdgelessSurfaceBlockSpec,
- EdgelessSurfaceRefBlockSpec,
- EdgelessTextBlockSpec,
- FrameBlockSpec,
- LatexBlockSpec,
-};
diff --git a/blocksuite/blocks/src/_specs/group/page.ts b/blocksuite/blocks/src/_specs/group/page.ts
deleted file mode 100644
index dffb3e1584..0000000000
--- a/blocksuite/blocks/src/_specs/group/page.ts
+++ /dev/null
@@ -1,6 +0,0 @@
-import { PageSurfaceBlockSpec } from '@blocksuite/affine-block-surface';
-
-import { PageRootBlockSpec } from '../../root-block/page/page-root-spec.js';
-import { PageSurfaceRefBlockSpec } from '../../surface-ref-block/surface-ref-spec.js';
-
-export { PageRootBlockSpec, PageSurfaceBlockSpec, PageSurfaceRefBlockSpec };
diff --git a/blocksuite/blocks/src/_specs/index.ts b/blocksuite/blocks/src/_specs/index.ts
index fe3771862a..4721e64cb7 100644
--- a/blocksuite/blocks/src/_specs/index.ts
+++ b/blocksuite/blocks/src/_specs/index.ts
@@ -1,4 +1,3 @@
-export * from './group/common.js';
export * from './preset/edgeless-specs.js';
export * from './preset/mobile-patch.js';
export * from './preset/page-specs.js';
diff --git a/blocksuite/blocks/src/_specs/preset/edgeless-specs.ts b/blocksuite/blocks/src/_specs/preset/edgeless-specs.ts
index 7c4c90b662..3225f68ed8 100644
--- a/blocksuite/blocks/src/_specs/preset/edgeless-specs.ts
+++ b/blocksuite/blocks/src/_specs/preset/edgeless-specs.ts
@@ -53,7 +53,7 @@ export const EdgelessBuiltInManager: ExtensionType[] = [
export const EdgelessEditorBlockSpecs: ExtensionType[] = [
EdgelessRootBlockSpec,
- ...EdgelessFirstPartyBlockSpecs,
+ EdgelessFirstPartyBlockSpecs,
EdgelessToolExtension,
EdgelessBuiltInManager,
].flat();
diff --git a/blocksuite/blocks/src/data-view-block/index.ts b/blocksuite/blocks/src/data-view-block/index.ts
index 1d022c0823..eb026ece5b 100644
--- a/blocksuite/blocks/src/data-view-block/index.ts
+++ b/blocksuite/blocks/src/data-view-block/index.ts
@@ -2,6 +2,7 @@ import type { DataViewBlockModel } from './data-view-model.js';
export * from './data-view-block.js';
export * from './data-view-model.js';
+export * from './data-view-spec.js';
declare global {
namespace BlockSuite {
diff --git a/blocksuite/blocks/src/database-block/index.ts b/blocksuite/blocks/src/database-block/index.ts
index f34697cf18..6d74b514ad 100644
--- a/blocksuite/blocks/src/database-block/index.ts
+++ b/blocksuite/blocks/src/database-block/index.ts
@@ -5,6 +5,7 @@ export type { DatabaseOptionsConfig } from './config.js';
export * from './data-source.js';
export * from './database-block.js';
export * from './database-service.js';
+export * from './database-spec.js';
export { databaseBlockColumns } from './properties/index.js';
declare global {
namespace BlockSuite {
diff --git a/blocksuite/blocks/src/index.ts b/blocksuite/blocks/src/index.ts
index 55c9cf88ad..cc42d52406 100644
--- a/blocksuite/blocks/src/index.ts
+++ b/blocksuite/blocks/src/index.ts
@@ -16,8 +16,8 @@ export * from './_common/test-utils/test-utils.js';
export * from './_common/transformers/index.js';
export { type AbstractEditor } from './_common/types.js';
export * from './_specs/index.js';
-export * from './data-view-block/index.js';
-export * from './database-block/index.js';
+export * from './data-view-block';
+export * from './database-block';
export { EdgelessTemplatePanel } from './root-block/edgeless/components/toolbar/template/template-panel.js';
export type {
Template,
diff --git a/blocksuite/blocks/src/root-block/edgeless/edgeless-root-spec.ts b/blocksuite/blocks/src/root-block/edgeless/edgeless-root-spec.ts
index 9dcc44fe2b..2b0416d85b 100644
--- a/blocksuite/blocks/src/root-block/edgeless/edgeless-root-spec.ts
+++ b/blocksuite/blocks/src/root-block/edgeless/edgeless-root-spec.ts
@@ -1,7 +1,6 @@
import { FileDropExtension } from '@blocksuite/affine-components/drag-indicator';
import {
DNDAPIExtension,
- DocDisplayMetaService,
DocModeService,
EmbedOptionService,
PageViewportServiceExtension,
@@ -99,7 +98,6 @@ const EdgelessCommonExtension: ExtensionType[] = [
ToolController,
DNDAPIExtension,
PageViewportServiceExtension,
- DocDisplayMetaService,
RootBlockAdapterExtensions,
FileDropExtension,
].flat();
diff --git a/blocksuite/blocks/src/root-block/page/page-root-spec.ts b/blocksuite/blocks/src/root-block/page/page-root-spec.ts
index a9414ecb57..fb8fdd7b91 100644
--- a/blocksuite/blocks/src/root-block/page/page-root-spec.ts
+++ b/blocksuite/blocks/src/root-block/page/page-root-spec.ts
@@ -1,7 +1,6 @@
import { FileDropExtension } from '@blocksuite/affine-components/drag-indicator';
import {
DNDAPIExtension,
- DocDisplayMetaService,
DocModeService,
EmbedOptionService,
PageViewportServiceExtension,
@@ -70,7 +69,6 @@ const PageCommonExtension: ExtensionType[] = [
DocModeService,
ThemeService,
EmbedOptionService,
- DocDisplayMetaService,
PageViewportServiceExtension,
];
diff --git a/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/common.ts b/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/common.ts
index d9423f4402..fe9721eb8e 100644
--- a/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/common.ts
+++ b/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/common.ts
@@ -15,6 +15,7 @@ import {
DividerBlockSpec,
EditPropsStore,
EmbedExtensions,
+ FontLoaderService,
ImageBlockSpec,
LatexBlockSpec,
ListBlockSpec,
@@ -36,6 +37,7 @@ const CommonBlockSpecs: ExtensionType[] = [
BookmarkBlockSpec,
AttachmentBlockSpec,
AdapterFactoryExtensions,
+ FontLoaderService,
].flat();
export const DefaultBlockSpecs: ExtensionType[] = [
diff --git a/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/custom/root-block.ts b/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/custom/root-block.ts
index c2cd8cb891..9b6a1c2642 100644
--- a/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/custom/root-block.ts
+++ b/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/custom/root-block.ts
@@ -1,11 +1,12 @@
import {
- AIEdgelessRootBlockSpec,
- AIPageRootBlockSpec,
+ AICodeBlockSpec,
+ AIImageBlockSpec,
+ AIParagraphBlockSpec,
} from '@affine/core/blocksuite/presets/ai';
+import { AIChatBlockSpec } from '@affine/core/blocksuite/presets/blocks';
import { DocService, DocsService } from '@affine/core/modules/doc';
import { DocDisplayMetaService } from '@affine/core/modules/doc-display-meta';
import { EditorSettingService } from '@affine/core/modules/editor-setting';
-import { FeatureFlagService } from '@affine/core/modules/feature-flag';
import { AppThemeService } from '@affine/core/modules/theme';
import { mixpanel } from '@affine/track';
import {
@@ -18,18 +19,17 @@ import type {
DocDisplayMetaExtension,
DocDisplayMetaParams,
RootBlockConfig,
+ SpecBuilder,
TelemetryEventMap,
ThemeExtension,
} from '@blocksuite/affine/blocks';
import {
+ CodeBlockSpec,
ColorScheme,
DocDisplayMetaProvider,
- EdgelessBuiltInManager,
- EdgelessRootBlockSpec,
- EdgelessToolExtension,
EditorSettingExtension,
- FontLoaderService,
- PageRootBlockSpec,
+ ImageBlockSpec,
+ ParagraphBlockSpec,
TelemetryProvider,
ThemeExtensionIdentifier,
} from '@blocksuite/affine/blocks';
@@ -258,36 +258,24 @@ export const extendEdgelessPreviewSpec = (function () {
};
})();
-export function createPageRootBlockSpec(
- framework: FrameworkProvider
-): ExtensionType[] {
- const featureFlagService = framework.get(FeatureFlagService);
- const enableAI = featureFlagService.flags.enable_ai.value;
- return [
- enableAI ? AIPageRootBlockSpec : PageRootBlockSpec,
- FontLoaderService,
- getThemeExtension(framework),
- getFontConfigExtension(),
- getTelemetryExtension(),
- getEditorConfigExtension(framework),
- buildDocDisplayMetaExtension(framework),
- ].flat();
+export function enableAffineExtension(
+ framework: FrameworkProvider,
+ specBuilder: SpecBuilder
+): void {
+ specBuilder.extend(
+ [
+ getThemeExtension(framework),
+ getFontConfigExtension(),
+ getTelemetryExtension(),
+ getEditorConfigExtension(framework),
+ buildDocDisplayMetaExtension(framework),
+ ].flat()
+ );
}
-export function createEdgelessRootBlockSpec(
- framework: FrameworkProvider
-): ExtensionType[] {
- const featureFlagService = framework.get(FeatureFlagService);
- const enableAI = featureFlagService.flags.enable_ai.value;
- return [
- enableAI ? AIEdgelessRootBlockSpec : EdgelessRootBlockSpec,
- FontLoaderService,
- getThemeExtension(framework),
- EdgelessToolExtension,
- EdgelessBuiltInManager,
- getFontConfigExtension(),
- getTelemetryExtension(),
- getEditorConfigExtension(framework),
- buildDocDisplayMetaExtension(framework),
- ].flat();
+export function enableAIExtension(specBuilder: SpecBuilder): void {
+ specBuilder.replace(CodeBlockSpec, AICodeBlockSpec);
+ specBuilder.replace(ImageBlockSpec, AIImageBlockSpec);
+ specBuilder.replace(ParagraphBlockSpec, AIParagraphBlockSpec);
+ specBuilder.extend(AIChatBlockSpec);
}
diff --git a/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/edgeless.ts b/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/edgeless.ts
index 3133d5b186..ab30c6b41b 100644
--- a/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/edgeless.ts
+++ b/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/edgeless.ts
@@ -1,36 +1,31 @@
+import { AIEdgelessRootBlockSpec } from '@affine/core/blocksuite/presets/ai';
import { FeatureFlagService } from '@affine/core/modules/feature-flag';
import { builtInTemplates as builtInEdgelessTemplates } from '@affine/templates/edgeless';
import { builtInTemplates as builtInStickersTemplates } from '@affine/templates/stickers';
import type { ExtensionType } from '@blocksuite/affine/block-std';
import type { TemplateManager } from '@blocksuite/affine/blocks';
import {
- EdgelessNoteBlockSpec,
- EdgelessSurfaceBlockSpec,
- EdgelessSurfaceRefBlockSpec,
+ EdgelessRootBlockSpec,
EdgelessTemplatePanel,
- EdgelessTextBlockSpec,
- FrameBlockSpec,
+ SpecProvider,
} from '@blocksuite/affine/blocks';
import { type FrameworkProvider } from '@toeverything/infra';
-import { AIBlockSpecs, DefaultBlockSpecs } from './common';
-import { createEdgelessRootBlockSpec } from './custom/root-block';
+import { enableAffineExtension, enableAIExtension } from './custom/root-block';
export function createEdgelessModeSpecs(
framework: FrameworkProvider
): ExtensionType[] {
const featureFlagService = framework.get(FeatureFlagService);
const enableAI = featureFlagService.flags.enable_ai.value;
- return [
- ...(enableAI ? AIBlockSpecs : DefaultBlockSpecs),
- EdgelessSurfaceBlockSpec,
- EdgelessSurfaceRefBlockSpec,
- FrameBlockSpec,
- EdgelessTextBlockSpec,
- EdgelessNoteBlockSpec,
- // special
- createEdgelessRootBlockSpec(framework),
- ].flat();
+ const edgelessSpec = SpecProvider.getInstance().getSpec('edgeless');
+ enableAffineExtension(framework, edgelessSpec);
+ if (enableAI) {
+ enableAIExtension(edgelessSpec);
+ edgelessSpec.replace(EdgelessRootBlockSpec, AIEdgelessRootBlockSpec);
+ }
+
+ return edgelessSpec.value;
}
export function effects() {
diff --git a/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/page.ts b/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/page.ts
index aee6a9f6c1..3a50712468 100644
--- a/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/page.ts
+++ b/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/page.ts
@@ -1,26 +1,22 @@
+import { AIPageRootBlockSpec } from '@affine/core/blocksuite/presets/ai';
import { FeatureFlagService } from '@affine/core/modules/feature-flag';
import type { ExtensionType } from '@blocksuite/affine/block-std';
-import {
- NoteBlockSpec,
- PageSurfaceBlockSpec,
- PageSurfaceRefBlockSpec,
-} from '@blocksuite/affine/blocks';
+import { PageRootBlockSpec, SpecProvider } from '@blocksuite/affine/blocks';
import { type FrameworkProvider } from '@toeverything/infra';
-import { AIBlockSpecs, DefaultBlockSpecs } from './common';
-import { createPageRootBlockSpec } from './custom/root-block';
+import { enableAffineExtension, enableAIExtension } from './custom/root-block';
export function createPageModeSpecs(
framework: FrameworkProvider
): ExtensionType[] {
const featureFlagService = framework.get(FeatureFlagService);
const enableAI = featureFlagService.flags.enable_ai.value;
- return [
- ...(enableAI ? AIBlockSpecs : DefaultBlockSpecs),
- PageSurfaceBlockSpec,
- PageSurfaceRefBlockSpec,
- NoteBlockSpec,
- // special
- createPageRootBlockSpec(framework),
- ].flat();
+ const provider = SpecProvider.getInstance();
+ const pageSpec = provider.getSpec('page');
+ enableAffineExtension(framework, pageSpec);
+ if (enableAI) {
+ enableAIExtension(pageSpec);
+ pageSpec.replace(PageRootBlockSpec, AIPageRootBlockSpec);
+ }
+ return pageSpec.value;
}