refactor(editor): improve config extension (#11006)

blocksuite/affine/rich-text/src/inline/presets/affine-inline-specs.ts

@@ -11,7 +11,7 @@ import { FootNoteNodeConfigIdentifier } from './nodes/footnote-node/footnote-con
 import { builtinInlineLinkToolbarConfig } from './nodes/link-node/configs/toolbar.js';
 import { builtinInlineReferenceToolbarConfig } from './nodes/reference-node/configs/toolbar.js';
 import {
-  ReferenceNodeConfigIdentifier,
+  ReferenceNodeConfigExtension,
   ReferenceNodeConfigProvider,
 } from './nodes/reference-node/reference-config.js';
 
@@ -123,7 +123,8 @@ export const ReferenceInlineSpecExtension = InlineSpecExtension(
   provider => {
     const std = provider.get(StdIdentifier);
     const configProvider = new ReferenceNodeConfigProvider(std);
-    const config = provider.getOptional(ReferenceNodeConfigIdentifier) ?? {};
+    const config =
+      provider.getOptional(ReferenceNodeConfigExtension.identifier) ?? {};
     if (config.customContent) {
       configProvider.setCustomContent(config.customContent);
     }

blocksuite/affine/rich-text/src/inline/presets/nodes/reference-node/reference-config.ts

@@ -1,6 +1,7 @@
-import type { BlockStdScope } from '@blocksuite/block-std';
-import { createIdentifier } from '@blocksuite/global/di';
-import type { ExtensionType } from '@blocksuite/store';
+import {
+  type BlockStdScope,
+  ConfigExtensionFactory,
+} from '@blocksuite/block-std';
 import type { TemplateResult } from 'lit';
 
 import type { AffineReference } from './reference-node';
@@ -11,18 +12,8 @@ export interface ReferenceNodeConfig {
   hidePopup?: boolean;
 }
 
-export const ReferenceNodeConfigIdentifier =
-  createIdentifier<ReferenceNodeConfig>('AffineReferenceNodeConfig');
-
-export function ReferenceNodeConfigExtension(
-  config: ReferenceNodeConfig
-): ExtensionType {
-  return {
-    setup: di => {
-      di.addImpl(ReferenceNodeConfigIdentifier, () => ({ ...config }));
-    },
-  };
-}
+export const ReferenceNodeConfigExtension =
+  ConfigExtensionFactory<ReferenceNodeConfig>('AffineReferenceNodeConfig');
 
 export class ReferenceNodeConfigProvider {
   private _customContent:

blocksuite/docs/api/@blocksuite/block-std/index/functions/ConfigExtensionFactory.md

@@ -6,13 +6,13 @@
 
 # Function: ConfigExtensionFactory()
 
-> **ConfigExtensionFactory**\<`Config`\>(`flavor`): (`config`) => `ExtensionType` & `object`
+> **ConfigExtensionFactory**\<`Config`\>(`configId`): `ConfigFactory`\<`Config`\>
 
 Create a config extension.
 A config extension provides a configuration object for a block flavour.
 The configuration object can be used like:
 ```ts
-const config = std.provider.get(ConfigIdentifier('my-flavour'));
+const config = std.provider.getOptional(ConfigIdentifier('my-flavour'));
 ```
 
 ## Type Parameters
@@ -23,15 +23,15 @@ const config = std.provider.get(ConfigIdentifier('my-flavour'));
 
 ## Parameters
 
-### flavor
+### configId
 
 `string`
 
-The flavour of the block that the config is for.
+The id of the config. Should be unique for each config.
 
 ## Returns
 
-(`config`) => `ExtensionType` & `object`
+`ConfigFactory`\<`Config`\>
 
 ## Example
 

blocksuite/framework/block-std/src/extension/config.ts

@@ -3,16 +3,20 @@ import type { ExtensionType } from '@blocksuite/store';
 
 import { ConfigIdentifier } from '../identifier.js';
 
+export interface ConfigFactory<Config extends Record<string, any>> {
+  (config: Config): ExtensionType;
+  identifier: ServiceIdentifier<Config>;
+}
+
 /**
  * Create a config extension.
  * A config extension provides a configuration object for a block flavour.
  * The configuration object can be used like:
  * ```ts
- * const config = std.provider.get(ConfigIdentifier('my-flavour'));
+ * const config = std.provider.getOptional(ConfigIdentifier('my-flavour'));
  * ```
  *
- * @param flavor The flavour of the block that the config is for.
- * @param config The configuration object.
+ * @param configId The id of the config. Should be unique for each config.
  *
  * @example
  * ```ts
@@ -25,14 +29,14 @@ import { ConfigIdentifier } from '../identifier.js';
  * ```
  */
 export function ConfigExtensionFactory<Config extends Record<string, any>>(
-  flavor: string
-): ((config: Config) => ExtensionType) & {
-  identifier: ServiceIdentifier<Config>;
-} {
-  const identifier = ConfigIdentifier(flavor) as ServiceIdentifier<Config>;
+  configId: string
+): ConfigFactory<Config> {
+  const identifier = ConfigIdentifier(configId) as ServiceIdentifier<Config>;
   const extensionFactory = (config: Config): ExtensionType => ({
     setup: di => {
-      di.override(ConfigIdentifier(flavor), () => config);
+      di.override(ConfigIdentifier(configId), () => {
+        return config;
+      });
     },
   });
   extensionFactory.identifier = identifier;