univer/packages/docs/src/layout-worker/protocol.ts

/**
 * 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 { DocLayoutExecutorType, IDocLayoutExecutor } from '../services/doc-layout-executor.service';

export const DOCS_LAYOUT_WORKER_CHANNEL = 'univer.docs-layout-worker';
export const DOCS_LAYOUT_WORKER_PROTOCOL_VERSION = 5;

export interface IDocsLayoutWorkerFontProbe {
    content: string;
    font: string;
    width: number;
    actualBoundingBoxAscent: number;
    actualBoundingBoxDescent: number;
}

export interface IDocsLayoutWorkerCapabilities {
    protocolVersion: typeof DOCS_LAYOUT_WORKER_PROTOCOL_VERSION;
    executor: DocLayoutExecutorType.WORKER;
    offscreenCanvas: boolean;
    structuredClone: boolean;
    fontProbe: IDocsLayoutWorkerFontProbe;
}

export interface IDocsLayoutWorkerRuntime extends IDocLayoutExecutor {
    getCapabilities(): Promise<IDocsLayoutWorkerCapabilities>;
}