All files / roosterjs-content-model-dom/lib/domToModel/context createDomToModelContext.ts

100% Statements 32/32
97.62% Branches 41/42
100% Functions 15/15
100% Lines 32/32

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 152 153 154 1551x 1x 1x                                               1x   2663x   1033x               1x       1197x                     1197x       1197x   1197x                       1197x                                     1x     1176x       875x     875x 875x       875x                     1x 1182x 1182x   1179x   1179x   30654x     161523x           22750x       30654x   30654x             1179x 875x 2x       1179x    
import { defaultProcessorMap } from './defaultProcessors';
import { getObjectKeys } from '../../domUtils/getObjectKeys';
import {
    defaultFormatKeysPerCategory,
    defaultFormatParsers,
} from '../../formatHandlers/defaultFormatHandlers';
import type {
    ContentModelBlockFormat,
    DomToModelContext,
    DomToModelDecoratorContext,
    DomToModelFormatContext,
    DomToModelOption,
    DomToModelSelectionContext,
    DomToModelSettings,
    EditorContext,
    FormatParser,
    FormatParsers,
    FormatParsersPerCategory,
    TextFormatParser,
} from 'roosterjs-content-model-types';
 
/**
 * Create context object for DOM to Content Model conversion
 * @param editorContext Context of editor
 * @param options Option array to customize the DOM to Model conversion behavior
 */
export function createDomToModelContext(
    editorContext?: EditorContext,
    ...options: (DomToModelOption | undefined)[]
): DomToModelContext {
    return createDomToModelContextWithConfig(createDomToModelConfig(options), editorContext);
}
 
/**
 * Create context object for DOM to Content Model conversion with an existing configure
 * @param config A full config object to define how to convert DOM tree to Content Model
 * @param editorContext Context of editor
 */
export function createDomToModelContextWithConfig(
    config: DomToModelSettings,
    editorContext?: EditorContext
): DomToModelContext {
    return Object.assign(
        {},
        editorContext,
        createDomToModelSelectionContext(),
        createDomToModelFormatContext(editorContext?.isRootRtl),
        createDomToModelDecoratorContext(),
        config
    );
}
 
function createDomToModelSelectionContext(): DomToModelSelectionContext {
    return { isInSelection: false };
}
 
function createDomToModelFormatContext(isRootRtl?: boolean): DomToModelFormatContext {
    const blockFormat: ContentModelBlockFormat = isRootRtl ? { direction: 'rtl' } : {};
 
    return {
        blockFormat,
        segmentFormat: {},
 
        listFormat: {
            levels: [],
            threadItemCounts: [],
        },
    };
}
 
function createDomToModelDecoratorContext(): DomToModelDecoratorContext {
    return {
        link: {
            format: {},
            dataset: {},
        },
        code: {
            format: {},
        },
        blockDecorator: {
            format: {},
            tagName: '',
        },
    };
}
 
/**
 * Create Dom to Content Model Config object
 * @param options All customizations of content model creation
 */
export function createDomToModelConfig(
    options: (DomToModelOption | undefined)[]
): DomToModelSettings {
    return {
        elementProcessors: Object.assign(
            {},
            defaultProcessorMap,
            ...options.map(x => x?.processorOverride)
        ),
        formatParsers: buildFormatParsers(
            options.map(x => x?.formatParserOverride),
            options.map(x => x?.additionalFormatParsers)
        ),
        defaultElementProcessors: defaultProcessorMap,
        defaultFormatParsers,
        processNonVisibleElements: options.some(x => !!x?.processNonVisibleElements),
    };
}
 
/**
 * @internal Export for test only
 * Build format parsers used by DOM to Content Model conversion
 * @param override
 * @param additionalParsersArray
 * @returns
 */
export function buildFormatParsers(
    overrides: (Partial<FormatParsers> | undefined)[] = [],
    additionalParsersArray: (Partial<FormatParsersPerCategory> | undefined)[] = []
): FormatParsersPerCategory {
    const combinedOverrides = Object.assign({}, ...overrides);
 
    const result = getObjectKeys(defaultFormatKeysPerCategory).reduce(
        (result, key) => {
            const value = defaultFormatKeysPerCategory[key]
                .map(
                    formatKey =>
                        (combinedOverrides[formatKey] === undefined
                            ? defaultFormatParsers[formatKey]
                            : combinedOverrides[formatKey]) as FormatParser<any>
                )
                .concat(
                    ...additionalParsersArray.map(
                        parsers => (parsers?.[key] ?? []) as FormatParser<any>[]
                    )
                );
 
            result[key] = value;
 
            return result;
        },
        {
            text: [] as TextFormatParser[],
        } as FormatParsersPerCategory
    );
 
    additionalParsersArray.forEach(parsers => {
        if (parsers?.text) {
            result.text = result.text.concat(parsers.text);
        }
    });
 
    return result;
}