Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Content Model: Add back ContentModelBeforePasteEvent #2347

Merged
merged 1 commit into from
Jan 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { convertDomSelectionToRangeEx, convertRangeExToDomSelection } from './selectionConverter';
import { createDefaultHtmlSanitizerOptions } from 'roosterjs-editor-dom';
import type { ContentModelBeforePasteEvent } from '../../publicTypes/ContentModelBeforePasteEvent';
import {
KnownAnnounceStrings as OldKnownAnnounceStrings,
PasteType as OldPasteType,
Expand Down Expand Up @@ -133,20 +134,23 @@ export function oldEventToNewEvent<TOldEvent extends OldEvent>(

case PluginEventType.BeforePaste:
const refBeforePasteEvent = refEvent?.eventType == 'beforePaste' ? refEvent : undefined;
const cmBeforePasteEvent = input as ContentModelBeforePasteEvent;

return {
eventType: 'beforePaste',
clipboardData: input.clipboardData,
customizedMerge: refBeforePasteEvent?.customizedMerge,
domToModelOption: refBeforePasteEvent?.domToModelOption ?? {
additionalAllowedTags: [],
additionalDisallowedTags: [],
additionalFormatParsers: {},
formatParserOverride: {},
processorOverride: {},
styleSanitizers: {},
attributeSanitizers: {},
},
customizedMerge:
cmBeforePasteEvent.customizedMerge ?? refBeforePasteEvent?.customizedMerge,
domToModelOption: cmBeforePasteEvent.domToModelOption ??
refBeforePasteEvent?.domToModelOption ?? {
additionalAllowedTags: [],
additionalDisallowedTags: [],
additionalFormatParsers: {},
formatParserOverride: {},
processorOverride: {},
styleSanitizers: {},
attributeSanitizers: {},
},
eventDataCache: input.eventDataCache,
fragment: input.fragment,
htmlAfter: input.htmlAfter,
Expand Down Expand Up @@ -349,7 +353,7 @@ export function newEventToOldEvent(input: NewEvent, refEvent?: OldEvent): OldEve
const refBeforePasteEvent =
refEvent?.eventType == PluginEventType.BeforePaste ? refEvent : undefined;

return {
const oldBeforePasteEvent: ContentModelBeforePasteEvent = {
eventType: PluginEventType.BeforePaste,
clipboardData: input.clipboardData,
eventDataCache: input.eventDataCache,
Expand All @@ -360,8 +364,12 @@ export function newEventToOldEvent(input: NewEvent, refEvent?: OldEvent): OldEve
pasteType: PasteTypeNewToOld[input.pasteType],
sanitizingOption:
refBeforePasteEvent?.sanitizingOption ?? createDefaultHtmlSanitizerOptions(),
domToModelOption: input.domToModelOption,
customizedMerge: input.customizedMerge,
};

return oldBeforePasteEvent;

case 'beforeSetContent':
return {
eventType: PluginEventType.BeforeSetContent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export {
export { IContentModelEditor, ContentModelEditorOptions } from './publicTypes/IContentModelEditor';
export { ContextMenuPluginState } from './publicTypes/ContextMenuPluginState';
export { ContentModelCorePluginState } from './publicTypes/ContentModelCorePlugins';
export { ContentModelBeforePasteEvent } from './publicTypes/ContentModelBeforePasteEvent';

export { ContentModelEditor } from './editor/ContentModelEditor';
export { isContentModelEditor } from './editor/isContentModelEditor';
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import type { BeforePasteEvent } from 'roosterjs-editor-types';
import type {
DomToModelOptionForPaste,
MergePastedContentFunc,
} from 'roosterjs-content-model-types';

/**
* A temporary event type to be compatible with both legacy plugin and content model editor
*/
export interface ContentModelBeforePasteEvent extends BeforePasteEvent {
/**
* domToModel Options to use when creating the content model from the paste fragment
*/
readonly domToModelOption: DomToModelOptionForPaste;

/**
* customizedMerge Customized merge function to use when merging the paste fragment into the editor
*/
customizedMerge?: MergePastedContentFunc;
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
} from 'roosterjs-editor-types';
import type { ContentChangedEvent, PluginEvent as OldEvent } from 'roosterjs-editor-types';
import type { PluginEvent as NewEvent } from 'roosterjs-content-model-types';
import type { ContentModelBeforePasteEvent } from '../../../lib/publicTypes/ContentModelBeforePasteEvent';

describe('oldEventToNewEvent', () => {
function runTest(
Expand Down Expand Up @@ -744,7 +745,9 @@ describe('newEventToOldEvent', () => {
preserveHtmlComments: false,
unknownTagReplacement: null,
},
}
customizedMerge: mockedCustomizedMerge,
domToModelOption: mockedDomToModelOption,
} as ContentModelBeforePasteEvent
);
});

Expand Down Expand Up @@ -792,7 +795,9 @@ describe('newEventToOldEvent', () => {
htmlAttributes: mockedHTmlAttributes,
pasteType: PasteType.AsImage,
sanitizingOption: mockedSanitizeOption,
}
customizedMerge: mockedCustomizedMerge,
domToModelOption: mockedDomToModelOption,
} as ContentModelBeforePasteEvent
);
});

Expand Down
Loading