All files / roosterjs-content-model-plugins/lib/paste/oneNote processPastedContentFromOneNote.ts

100% Statements 50/50
76.47% Branches 26/34
100% Functions 5/5
100% Lines 45/45

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 1521x             1x               1x                                                             1x 5x 5x 5x                   1x         35x   35x 35x 35x 35x 35x   35x 35x       35x                   1x         35x   35x 35x 35x   34x 34x       35x                     1x 77x 77x   77x 77x 77x 64x 64x   64x 30x 30x   30x   64x       77x   77x 30x           147x   147x 9x     147x    
import { setProcessor } from '../utils/setProcessor';
import type {
    BeforePasteEvent,
    DomToModelContext,
    ElementProcessor,
} from 'roosterjs-content-model-types';
 
const OrderedListStyleMap = {
    1: 'decimal',
    a: 'lower-alpha',
    A: 'upper-alpha',
    i: 'lower-roman',
    I: 'upper-roman',
} as const;
 
const UnorderedListStyleMap = {
    disc: 'disc',
    circle: 'circle',
    square: 'square',
} as const;
 
/**
 * @internal
 */
export interface OneNoteListContext {
    listStyleType?: string;
    startNumberOverride?: number;
}
 
/**
 * @internal
 */
export interface OneNoteDomToModelContext extends DomToModelContext {
    oneNoteListContext?: OneNoteListContext;
}
 
/**
 * @internal
 * Processes the content pasted from OneNote by setting up custom processors
 * for ordered lists (`<ol>`) and list items (`<li>`). These processors handle
 * specific list styles and numbering overrides that may be present in OneNote
 * content.
 *
 * @param event - The `BeforePasteEvent` containing the DOM-to-model options
 * and other context information for the paste operation.
 */
export function processPastedContentFromOneNote(event: BeforePasteEvent): void {
    setProcessor(event.domToModelOption, 'ol', processOrderedList);
    setProcessor(event.domToModelOption, 'ul', processUnorderedList);
    setProcessor(event.domToModelOption, 'li', processListItem);
}
 
/**
 * @internal exported only for unit test
 * Content from OneNote may have ordered lists with specific styles and start numbers.
 * This function processes the `<ol>` elements, extracting the `type` and `start` custom attributes
 * to set the appropriate list style and starting number in the `oneNoteListContext` of the provided context.
 * Which is then used to format the list items within the list.
 */
export const processOrderedList: ElementProcessor<HTMLOListElement> = (
    group,
    element,
    cmContext
) => {
    const context = ensureOneNoteListContext(cmContext);
 
    Eif (context.oneNoteListContext) {
        const typeOfList = element.getAttribute('type');
        Eif (typeOfList) {
            const listStyle = OrderedListStyleMap[typeOfList as keyof typeof OrderedListStyleMap];
            const startNumberOverride = parseInt(element.getAttribute('start') || '1') || 1;
 
            context.oneNoteListContext.listStyleType = listStyle;
            context.oneNoteListContext.startNumberOverride = startNumberOverride;
        }
    }
 
    context.defaultElementProcessors.ol?.(group, element, context);
};
 
/**
 * @internal exported only for unit test
 * Content from OneNote may have ordered lists with specific styles and start numbers.
 * This function processes the `<ul>` elements, extracting the `type` custom attribute
 * to set the appropriate list style in the `oneNoteListContext` of the provided context.
 * Which is then used to format the list items within the list.
 */
export const processUnorderedList: ElementProcessor<HTMLUListElement> = (
    group,
    element,
    cmContext
) => {
    const context = ensureOneNoteListContext(cmContext);
 
    Eif (context.oneNoteListContext) {
        const typeOfList = element.getAttribute('type');
        if (typeOfList) {
            const listStyle =
                UnorderedListStyleMap[typeOfList as keyof typeof UnorderedListStyleMap];
            context.oneNoteListContext.listStyleType = listStyle;
        }
    }
 
    context.defaultElementProcessors.ul?.(group, element, context);
};
 
/**
 * @internal exported only for unit test
 * Processes the `<li>` elements within a list. It checks if the `oneNoteListContext`
 * is present in the provided context. If so, it applies the list style type and
 * start number override to the last level of the list format.
 * This ensures that the list items are formatted correctly according to the
 * OneNote list context.
 */
export const processListItem: ElementProcessor<HTMLLIElement> = (group, element, cmContext) => {
    const context = ensureOneNoteListContext(cmContext);
    let removeStartNumberOverride = false;
 
    Eif (context.oneNoteListContext) {
        const { listStyleType, startNumberOverride } = context.oneNoteListContext;
        if (listStyleType) {
            const lastLevel = context.listFormat.levels[context.listFormat.levels.length - 1];
            lastLevel.format.listStyleType = listStyleType;
 
            if (startNumberOverride) {
                removeStartNumberOverride = true;
                lastLevel.format.startNumberOverride = startNumberOverride;
 
                delete context.oneNoteListContext.startNumberOverride;
            }
            delete context.oneNoteListContext.listStyleType;
        }
    }
 
    context.defaultElementProcessors.li?.(group, element, context);
 
    if (removeStartNumberOverride) {
        delete context.listFormat.levels[context.listFormat.levels.length - 1].format
            .startNumberOverride;
    }
};
 
function ensureOneNoteListContext(cmContext: DomToModelContext): OneNoteDomToModelContext {
    const context = cmContext as OneNoteDomToModelContext;
 
    if (!context.oneNoteListContext) {
        context.oneNoteListContext = {};
    }
 
    return context;
}