Refactor paste options handling to use editor environment settings an…

…d simplify function signatures
microsoft · Dec 10, 2024 · 20fa3e5 · 20fa3e5
1 parent 5d0c2ad
commit 20fa3e5
Show file tree

Hide file tree

Showing 9 changed files with 60 additions and 43 deletions.
diff --git a/packages/roosterjs-content-model-core/lib/command/paste/generatePasteOptionFromPlugins.ts b/packages/roosterjs-content-model-core/lib/command/paste/generatePasteOptionFromPlugins.ts
@@ -7,16 +7,6 @@ import type {
     IEditor,
 } from 'roosterjs-content-model-types';
 
-const emptyDomToModelOption: Readonly<DomToModelOptionForSanitizing> = {
-    additionalAllowedTags: [],
-    additionalDisallowedTags: [],
-    additionalFormatParsers: {},
-    formatParserOverride: {},
-    processorOverride: {},
-    styleSanitizers: {},
-    attributeSanitizers: {},
-};
-
 /**
  * @internal
  */
@@ -25,8 +15,7 @@ export function generatePasteOptionFromPlugins(
     clipboardData: ClipboardData,
     fragment: DocumentFragment,
     htmlFromClipboard: HtmlFromClipboard,
-    pasteType: PasteType,
-    domToModelOption: Readonly<Partial<DomToModelOptionForSanitizing>>
+    pasteType: PasteType
 ): BeforePasteEvent {
     const event: BeforePasteEvent = {
         eventType: 'beforePaste',
@@ -36,11 +25,24 @@ export function generatePasteOptionFromPlugins(
         htmlAfter: htmlFromClipboard.htmlAfter ?? '',
         htmlAttributes: htmlFromClipboard.metadata,
         pasteType: pasteType,
-        domToModelOption: Object.assign({}, emptyDomToModelOption, domToModelOption),
+        domToModelOption: createDomToModelOption(editor),
         containsBlockElements: !!htmlFromClipboard.containsBlockElements,
     };
 
     return pasteType == 'asPlainText'
         ? event
         : editor.triggerEvent('beforePaste', event, true /* broadcast */);
 }
+function createDomToModelOption(editor: IEditor): DomToModelOptionForSanitizing {
+    const pasteDomToModel = editor.getEnvironment().domToModelSettings.paste;
+    const emptyDomToModelOption: Readonly<DomToModelOptionForSanitizing> = {
+        additionalAllowedTags: [],
+        additionalDisallowedTags: [],
+        additionalFormatParsers: {},
+        formatParserOverride: {},
+        processorOverride: {},
+        styleSanitizers: {},
+        attributeSanitizers: {},
+    };
+    return Object.assign({}, emptyDomToModelOption, pasteDomToModel);
+}
diff --git a/packages/roosterjs-content-model-core/lib/command/paste/paste.ts b/packages/roosterjs-content-model-core/lib/command/paste/paste.ts
@@ -8,7 +8,6 @@ import type {
     ClipboardData,
     TrustedHTMLHandler,
     IEditor,
-    DomToModelOptionForSanitizing,
 } from 'roosterjs-content-model-types';
 
 /**
@@ -20,8 +19,7 @@ import type {
 export function paste(
     editor: IEditor,
     clipboardData: ClipboardData,
-    pasteTypeOrGetter: PasteTypeOrGetter = 'normal',
-    pasteDomToModelOption: Readonly<Partial<DomToModelOptionForSanitizing>> = {}
+    pasteTypeOrGetter: PasteTypeOrGetter = 'normal'
 ) {
     editor.focus();
 
@@ -62,8 +60,7 @@ export function paste(
         clipboardData,
         sourceFragment,
         htmlFromClipboard,
-        pasteType,
-        pasteDomToModelOption
+        pasteType
     );
 
     // 5. Convert global CSS to inline CSS

diff --git a/packages/roosterjs-content-model-core/lib/corePlugin/copyPaste/CopyPastePlugin.ts b/packages/roosterjs-content-model-core/lib/corePlugin/copyPaste/CopyPastePlugin.ts
@@ -52,7 +52,6 @@ class CopyPastePlugin implements PluginWithState<CopyPastePluginState> {
             allowedCustomPasteType: option.allowedCustomPasteType || [],
             tempDiv: null,
             defaultPasteType: option.defaultPasteType,
-            pasteOptionDomToModel: option.pasteOptionDomToModel,
         };
     }
 
@@ -206,12 +205,7 @@ class CopyPastePlugin implements PluginWithState<CopyPastePluginState> {
                     this.state.allowedCustomPasteType
                 ).then((clipboardData: ClipboardData) => {
                     if (!editor.isDisposed()) {
-                        paste(
-                            editor,
-                            clipboardData,
-                            this.state.defaultPasteType,
-                            this.state.pasteOptionDomToModel
-                        );
+                        paste(editor, clipboardData, this.state.defaultPasteType);
                     }
                 });
             }

diff --git a/packages/roosterjs-content-model-core/lib/editor/core/createEditorDefaultSettings.ts b/packages/roosterjs-content-model-core/lib/editor/core/createEditorDefaultSettings.ts
@@ -4,29 +4,27 @@ import {
     listLevelMetadataApplier,
 } from '../../override/listMetadataApplier';
 import type {
-    ContentModelSettings,
     DomToModelOption,
-    DomToModelSettings,
     ModelToDomOption,
-    ModelToDomSettings,
     EditorOptions,
+    ModelToDomSetting,
+    DomToModelSetting,
 } from 'roosterjs-content-model-types';
 
 /**
  * @internal
  * Create default DOM to Content Model conversion settings for an editor
  * @param options The editor options
  */
-export function createDomToModelSettings(
-    options: EditorOptions
-): ContentModelSettings<DomToModelOption, DomToModelSettings> {
+export function createDomToModelSettings(options: EditorOptions): DomToModelSetting {
     const builtIn: DomToModelOption = {};
     const customized: DomToModelOption = options.defaultDomToModelOptions ?? {};
 
     return {
         builtIn,
         customized,
         calculated: createDomToModelConfig([builtIn, customized]),
+        paste: options.pasteOptionDomToModel ?? {},
     };
 }
 
@@ -35,9 +33,7 @@ export function createDomToModelSettings(
  * Create default Content Model to DOM conversion settings for an editor
  * @param options The editor options
  */
-export function createModelToDomSettings(
-    options: EditorOptions
-): ContentModelSettings<ModelToDomOption, ModelToDomSettings> {
+export function createModelToDomSettings(options: EditorOptions): ModelToDomSetting {
     const builtIn: ModelToDomOption = {
         metadataAppliers: {
             listItem: listItemMetadataApplier,

diff --git a/...ges/roosterjs-content-model-core/test/command/paste/generatePasteOptionFromPluginsTest.ts b/...ges/roosterjs-content-model-core/test/command/paste/generatePasteOptionFromPluginsTest.ts
@@ -4,6 +4,7 @@ import { IEditor } from 'roosterjs-content-model-types';
 describe('generatePasteOptionFromPlugins', () => {
     let editor: IEditor;
     let triggerPluginEventSpy: jasmine.Spy;
+    let getEnvironmentSpy: jasmine.Spy;
 
     const mockedClipboardData = 'CLIPBOARDDATA' as any;
     const mockedFragment = 'FRAGMENT' as any;
@@ -19,8 +20,14 @@ describe('generatePasteOptionFromPlugins', () => {
 
     beforeEach(() => {
         triggerPluginEventSpy = jasmine.createSpy('triggerEvent');
+        getEnvironmentSpy = jasmine.createSpy('getEnvironment').and.returnValue({
+            domToModelSettings: {
+                paste: {},
+            },
+        });
         editor = {
             triggerEvent: triggerPluginEventSpy,
+            getEnvironment: getEnvironmentSpy,
         } as any;
     });
 

diff --git a/packages/roosterjs-content-model-core/test/editor/core/createEditorDefaultSettingsTest.ts b/packages/roosterjs-content-model-core/test/editor/core/createEditorDefaultSettingsTest.ts
@@ -25,20 +25,24 @@ describe('createDomToModelSettings', () => {
             builtIn: {},
             customized: {},
             calculated: mockedCalculatedConfig,
+            paste: {},
         });
         expect(createDomToModelContext.createDomToModelConfig).toHaveBeenCalledWith([{}, {}]);
     });
 
     it('Has options', () => {
         const defaultDomToModelOptions = 'MockedOptions' as any;
+        const pasteOptionDomToModel = 'PasteMockedOptions' as any;
         const settings = createDomToModelSettings({
             defaultDomToModelOptions: defaultDomToModelOptions,
+            pasteOptionDomToModel,
         });
 
         expect(settings).toEqual({
             builtIn: {},
             customized: defaultDomToModelOptions,
             calculated: mockedCalculatedConfig,
+            paste: pasteOptionDomToModel,
         });
         expect(createDomToModelContext.createDomToModelConfig).toHaveBeenCalledWith([
             {},

diff --git a/packages/roosterjs-content-model-types/lib/index.ts b/packages/roosterjs-content-model-types/lib/index.ts
@@ -389,7 +389,12 @@ export {
 export { ContextMenuPluginState } from './pluginState/ContextMenuPluginState';
 
 export { AutoLinkOptions } from './parameter/AutoLinkOptions';
-export { EditorEnvironment, ContentModelSettings } from './parameter/EditorEnvironment';
+export {
+    EditorEnvironment,
+    ContentModelSettings,
+    DomToModelSetting,
+    ModelToDomSetting,
+} from './parameter/EditorEnvironment';
 export {
     EntityState,
     DeletedEntity,

diff --git a/packages/roosterjs-content-model-types/lib/parameter/EditorEnvironment.ts b/packages/roosterjs-content-model-types/lib/parameter/EditorEnvironment.ts
@@ -23,8 +23,26 @@ export interface ContentModelSettings<OptionType, ConfigType> {
      * This is a cached object so that we don't need to cache it every time when we use Content Model
      */
     calculated: ConfigType;
+
+    /**
+     * Paste option used by editor
+     */
+    paste: OptionType;
 }
 
+/**
+ * Settings used by DOM to Content Model conversion
+ */
+export type DomToModelSetting = ContentModelSettings<DomToModelOption, DomToModelSettings>;
+
+/**
+ * Settings used by Content Model to DOM conversion
+ */
+export type ModelToDomSetting = Omit<
+    ContentModelSettings<ModelToDomOption, ModelToDomSettings>,
+    'paste'
+>;
+
 /**
  * Current running environment
  */
@@ -52,10 +70,10 @@ export interface EditorEnvironment {
     /**
      * Settings used by DOM to Content Model conversion
      */
-    readonly domToModelSettings: ContentModelSettings<DomToModelOption, DomToModelSettings>;
+    readonly domToModelSettings: DomToModelSetting;
 
     /**
      * Settings used by Content Model to DOM conversion
      */
-    readonly modelToDomSettings: ContentModelSettings<ModelToDomOption, ModelToDomSettings>;
+    readonly modelToDomSettings: ModelToDomSetting;
 }
diff --git a/packages/roosterjs-content-model-types/lib/pluginState/CopyPastePluginState.ts b/packages/roosterjs-content-model-types/lib/pluginState/CopyPastePluginState.ts
@@ -1,4 +1,3 @@
-import type { DomToModelOptionForSanitizing } from '../context/DomToModelOption';
 import type { PasteTypeOrGetter } from '../parameter/PasteTypeOrGetter';
 
 /**
@@ -20,9 +19,4 @@ export interface CopyPastePluginState {
      * Default paste type. By default will use the normal (as-is) paste type.
      */
     defaultPasteType?: PasteTypeOrGetter;
-
-    /**
-     * Paste options for sanitizing HTML before paste
-     */
-    pasteOptionDomToModel?: Partial<DomToModelOptionForSanitizing>;
 }