Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

2.6 KB
Raw Blame
/**
 * Copyright 2023-present DreamNum Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import type { JSONXActions } from '@univerjs/core';
import { JSON1 } from '@univerjs/core';

export type DocMutationAffectedDrawingIds = ReadonlySet<string> | null;

/**
 * Returns the drawing ids that can be refreshed independently. `null` means
 * the mutation is drawing-related but needs a conservative full refresh.
 */
export function getDocMutationAffectedDrawingIds(actions: JSONXActions): DocMutationAffectedDrawingIds {
    if (!Array.isArray(actions) || actions.length === 0) {
        return null;
    }

    const drawingIds = new Set<string>();
    let sawComponent = false;
    let needsFullRefresh = false;
    try {
        const cursor = JSON1.type.readCursor(actions);
        cursor.traverse(null, () => {
            sawComponent = true;
            const path = cursor.getPath();
            const root = String(path[0]);
            const drawingIndex = root === 'notes' ? 2 : 0;
            if (path[drawingIndex] === 'drawings') {
                const drawingId = path[drawingIndex + 1];
                if (typeof drawingId === 'string' && drawingId.length > 0) {
                    drawingIds.add(drawingId);
                } else {
                    needsFullRefresh = true;
                }
            } else if (path[drawingIndex] === 'drawingsOrder' || (root === 'notes' && path.length <= 2) || path.includes('customBlocks')) {
                needsFullRefresh = true;
            }
        });
    } catch {
        return null;
    }

    return !sawComponent || needsFullRefresh ? null : drawingIds;
}

/**
 * Drawing editability and immediate overlay transforms only need refreshing
 * when a rich-text mutation changes drawing metadata or custom-block records.
 * Text, table, list, and document-style mutations are repainted from the next
 * document-layout publication instead of scanning every drawing eagerly.
 */
export function doesDocMutationAffectDrawingPresentation(actions: JSONXActions): boolean {
    const drawingIds = getDocMutationAffectedDrawingIds(actions);
    return drawingIds == null || drawingIds.size > 0;
}