@univerjs/docs 1.0.0-insiders.20260813-7c9aa50 → 1.0.0

package/lib/types/facade/f-document.d.ts

@@ -16,9 +16,10 @@
 import type { DocumentDataModel, IDocumentBody, IDocumentData, IParagraphBorder, ISectionBreak, SectionType } from '@univerjs/core';
 import type { IHeaderFooterProps } from '@univerjs/docs';
 import type { IFDocumentTextRange } from './utils';
-import { DocumentFlavor, ICommandService, Injector, IResourceLoaderService, IUniverInstanceService } from '@univerjs/core';
+import { DocumentFlavor, ICommandService, Injector, IPermissionService, IResourceLoaderService, IUniverInstanceService } from '@univerjs/core';
 import { FBaseInitialable } from '@univerjs/core/facade';
 import { FDocumentParagraph } from './f-document-paragraph';
+import { FDocumentObjectPermission, FDocumentPermission } from './f-document-permission';
 import { FDocumentSection } from './f-document-section';
 import { FDocumentTextRange } from './f-document-text-range';
 export interface IFDocumentParagraphQuery {
@@ -64,11 +65,15 @@ export declare class FDocument extends FBaseInitialable {
     protected readonly _univerInstanceService: IUniverInstanceService;
     protected readonly _resourceLoaderService: IResourceLoaderService;
     private readonly _commandService;
+    private readonly _permissionService;
+    /**
+     * The document unit id used to identify this document in commands and snapshots.
+     */
     readonly id: string;
-    constructor(_documentDataModel: DocumentDataModel, _injector: Injector, _univerInstanceService: IUniverInstanceService, _resourceLoaderService: IResourceLoaderService, _commandService: ICommandService);
+    constructor(_documentDataModel: DocumentDataModel, _injector: Injector, _univerInstanceService: IUniverInstanceService, _resourceLoaderService: IResourceLoaderService, _commandService: ICommandService, _permissionService: IPermissionService);
     /**
      * Get the document data model of the document.
-     * @param {string} segmentId The segment id used to get the header/footer data model. Defaults to an empty string for the document data model of the document.
+     * @param {string} [segmentId] The segment id used to get the header/footer data model. Defaults to an empty string for the document data model of the document.
      * @returns {DocumentDataModel} The document data model.
      * @example
      * ```typescript
@@ -99,7 +104,7 @@ export declare class FDocument extends FBaseInitialable {
      * Get the document body or header/footer body by the segment id.
      * The main body has an empty segment id.
      * The header and footer body have their respective segment ids.
-     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @param {string} [segmentId] The segment id of the body. Defaults to an empty string for the main body.
      * @returns {IDocumentBody} The document body.
      * @example
      * ```typescript
@@ -111,6 +116,7 @@ export declare class FDocument extends FBaseInitialable {
      * ```
      */
     getBody(segmentId?: string): IDocumentBody;
+    /** Releases this facade's resources. Use `univerAPI.disposeUnit()` to unload the owning unit. */
     dispose(): void;
     /**
      * Get the document id.
@@ -122,6 +128,36 @@ export declare class FDocument extends FBaseInitialable {
      * ```
      */
     getId(): string;
+    /**
+     * Returns the Document unit permission facade.
+     * @returns {FDocumentPermission} Permission facade for Edit, Copy, Print, Export, and Comment.
+     * @example
+     * ```ts
+     * const document = univerAPI.getActiveDocument();
+     * if (!document) throw new Error('No active Document.');
+     * await document.getPermission().setReadOnly();
+     * ```
+     */
+    getPermission(): FDocumentPermission;
+    /**
+     * Returns the permission facade for an entity with a stable id, such as a Table, Drawing, or Custom Block.
+     *
+     * Parent Section and Paragraph permission ceilings are resolved from the current Document model.
+     * @param {string} segmentId Segment id, or an empty string for the main body.
+     * @param {string} entityType Stable entity type used by the owning Doc feature.
+     * @param {string} entityId Stable entity id.
+     * @returns {FDocumentObjectPermission} Effective permission facade for the entity.
+     * @example Make one drawing read-only
+     * ```ts
+     * const document = univerAPI.getActiveDocument();
+     * if (!document) throw new Error('No active Document.');
+     * const snapshot = document.getDocumentDataModel().getSnapshot();
+     * const drawingId = snapshot.drawingsOrder?.[0];
+     * if (!drawingId) throw new Error('Drawing not found.');
+     * await document.getEntityPermission('', 'drawing', drawingId).setReadOnly();
+     * ```
+     */
+    getEntityPermission(segmentId: string, entityType: string, entityId: string): FDocumentObjectPermission;
     /**
      * Get the document name.
      * @returns {string} The document name.
@@ -239,7 +275,7 @@ export declare class FDocument extends FBaseInitialable {
     redo(): boolean;
     /**
      * Ensure the page header segment exists and return its segment id.
-     * @param {number} pageIndex The zero-based page index. Defaults to the first page.
+     * @param {number} [pageIndex] The zero-based page index. Defaults to the first page.
      * @returns {string} The header segment id.
      * @example
      * ```ts
@@ -251,7 +287,7 @@ export declare class FDocument extends FBaseInitialable {
     ensurePageHeader(pageIndex?: number): string;
     /**
      * Ensure the page footer segment exists and return its segment id.
-     * @param {number} pageIndex The zero-based page index. Defaults to the first page.
+     * @param {number} [pageIndex] The zero-based page index. Defaults to the first page.
      * @returns {string} The footer segment id.
      * @example
      * ```ts
@@ -265,7 +301,7 @@ export declare class FDocument extends FBaseInitialable {
      * Insert plain text at a document body offset.
      * @param {number} index The zero-based insertion offset.
      * @param {string} text The plain text to insert.
-     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @param {string} [segmentId] The segment id of the body. Defaults to an empty string for the main body.
      * @returns {boolean} `true` if the edit was applied.
      * @example
      * ```ts
@@ -292,6 +328,8 @@ export declare class FDocument extends FBaseInitialable {
      * Traditional and Unspecified documents keep the legacy header/footer
      * behavior. Modern documents reject this API. `marginHeader` and
      * `marginFooter` use 96-DPI layout pixels.
+     * @param {IHeaderFooterProps} options Header/footer switches and margins to update. Omitted properties are preserved.
+     * @returns {boolean} Whether the update command succeeded.
      * @example
      * ```ts
      * const fDocument = univerAPI.getActiveDocument();
@@ -309,7 +347,7 @@ export declare class FDocument extends FBaseInitialable {
      * The end offset is exclusive, and offsets are scoped to the selected body segment.
      * @param {number} startOffset The inclusive start offset.
      * @param {number} endOffset The exclusive end offset.
-     * @param {string} segmentId The header/footer segment id, or an empty string for the main body.
+     * @param {string} [segmentId] The header/footer segment id, or an empty string for the main body.
      * @returns {FDocumentTextRange} A fixed text-range facade.
      * @example
      * ```ts
@@ -332,6 +370,8 @@ export declare class FDocument extends FBaseInitialable {
     getSections(): FDocumentSection[];
     /**
      * Returns a traditional section by zero-based index, or `null` in modern documents.
+     * @param {number} index Zero-based section index.
+     * @returns {FDocumentSection | null} The matching section, or `null` if none exists or the document is not Traditional.
      * @example
      * ```ts
      * const fDocument = univerAPI.getActiveDocument();
@@ -342,6 +382,8 @@ export declare class FDocument extends FBaseInitialable {
     getSection(index: number): FDocumentSection | null;
     /**
      * Returns the traditional section containing a data-stream offset, or `null` in modern documents.
+     * @param {number} offset Zero-based data-stream offset in the main document body.
+     * @returns {FDocumentSection | null} The matching section, or `null` if none exists or the document is not Traditional.
      * @example
      * ```ts
      * const fDocument = univerAPI.getActiveDocument();
@@ -410,6 +452,8 @@ export declare class FDocument extends FBaseInitialable {
      * In a single-column section, the traditional renderer advances to the next physical page.
      * Modern documents must use ColumnGroup. Unspecified documents must resolve
      * their flavor first. Both throw `DocsSectionUnsupportedDocumentFlavorError`.
+     * @param {number} offset Zero-based data-stream offset at which to insert the column break.
+     * @returns {boolean} Whether the insertion succeeded.
      * @example
      * ```ts
      * const fDocument = univerAPI.getActiveDocument();
@@ -427,6 +471,10 @@ export declare class FDocument extends FBaseInitialable {
      * Inserts a horizontal rule using the existing paragraph `borderBottom` mechanism.
      * The returned paragraph can be inspected or removed with normal paragraph APIs.
      * Border width and padding are in points (pt).
+     * @param {number} offset Zero-based insertion offset in the selected body segment.
+     * @param {IParagraphBorder} [border] Bottom border appearance. Defaults to a solid gray 1 pt line with 5 pt padding.
+     * @param {string} [segmentId] Header/footer segment ID, or an empty string for the main body (default).
+     * @returns {FDocumentParagraph | null} The inserted paragraph, or `null` if insertion fails.
      * @example
      * ```ts
      * const fDocument = univerAPI.getActiveDocument();
@@ -439,7 +487,7 @@ export declare class FDocument extends FBaseInitialable {
     insertHorizontalRule(offset: number, border?: IParagraphBorder, segmentId?: string): FDocumentParagraph | null;
     /**
      * Get all paragraphs in the document body or header/footer body by the segment id.
-     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @param {string} [segmentId] The segment id of the body. Defaults to an empty string for the main body.
      * @returns {FDocumentParagraph[]} An array of paragraph facade instances.
      * @example
      * ```ts
@@ -456,7 +504,7 @@ export declare class FDocument extends FBaseInitialable {
     /**
      * Get a paragraph by its paragraph id and segment id.
      * @param {string} paragraphId The paragraph id.
-     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @param {string} [segmentId] The segment id of the body. Defaults to an empty string for the main body.
      * @returns {FDocumentParagraph | null} The paragraph facade instance, or `null` if the paragraph is not found.
      * @example
      * ```ts
@@ -473,7 +521,7 @@ export declare class FDocument extends FBaseInitialable {
     /**
      * Find a paragraph by its text content and segment id.
      * @param {string} text The text content to search for.
-     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @param {string} [segmentId] The segment id of the body. Defaults to an empty string for the main body.
      * @returns {FDocumentParagraph | null} The paragraph facade instance, or `null` if the paragraph is not found.
      * @example
      * ```ts
@@ -509,8 +557,8 @@ export declare class FDocument extends FBaseInitialable {
     /**
      * Insert a plain-text paragraph before the paragraph at the given paragraph index.
      * @param {number} index The zero-based paragraph insertion index.
-     * @param {string} text The paragraph text. Defaults to an empty paragraph.
-     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @param {string} [text] The paragraph text. Defaults to an empty paragraph.
+     * @param {string} [segmentId] The segment id of the body. Defaults to an empty string for the main body.
      * @returns {FDocumentParagraph} The inserted paragraph facade instance.
      * @example
      * ```ts
@@ -526,8 +574,8 @@ export declare class FDocument extends FBaseInitialable {
     insertParagraph(index: number, text?: string, segmentId?: string): FDocumentParagraph;
     /**
      * Append a plain-text paragraph at the end of the body.
-     * @param {string} text The paragraph text. Defaults to an empty paragraph.
-     * @param {string} segmentId The segment id of the body. Defaults to an empty string for the main body.
+     * @param {string} [text] The paragraph text. Defaults to an empty paragraph.
+     * @param {string} [segmentId] The segment id of the body. Defaults to an empty string for the main body.
      * @returns {FDocumentParagraph} The appended paragraph wrapper.
      * @example
      * ```ts

package/lib/types/facade/f-univer.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IDocumentData } from '@univerjs/core';
+import type { ICreateUnitOptions, IDocumentData } from '@univerjs/core';
 import { FUniver } from '@univerjs/core/facade';
 import { FDocument } from './f-document';
 /**
@@ -23,14 +23,15 @@ export interface IFUniverDocsMixin {
     /**
      * Create a new document and get the API handler of that document.
      * @param {Partial<IDocumentData>} data The snapshot of the document.
+     * @param {ICreateUnitOptions} [options] The options of creating the document.
      * @returns {FDocument} The document API instance.
      * @example
      * ```typescript
-     * const fDocument = univerAPI.createUniverDoc({ id: 'document-01', title: 'Document1'  });
+     * const fDocument = univerAPI.createDocument({ id: 'document-01', title: 'Document1'  });
      * console.log(fDocument);
      * ```
      */
-    createDocument(data: Partial<IDocumentData>): FDocument;
+    createDocument(data: Partial<IDocumentData>, options?: ICreateUnitOptions): FDocument;
     /**
      * Get the currently focused Univer document.
      * @returns {FDocument | null} The currently focused Univer document API instance, or null if there is no focused Univer document.
@@ -54,7 +55,7 @@ export interface IFUniverDocsMixin {
     getDocument(id: string): FDocument | null;
 }
 export declare class FUniverDocsMixin extends FUniver implements IFUniverDocsMixin {
-    createDocument(data: Partial<IDocumentData>): FDocument;
+    createDocument(data: Partial<IDocumentData>, options?: ICreateUnitOptions): FDocument;
     getActiveDocument(): FDocument | null;
     getDocument(id: string): FDocument | null;
 }

package/lib/types/facade/index.d.ts

@@ -18,6 +18,7 @@ import './f-enum';
 export { FDocument, type IDocumentCustomBlockLayout, type IDocumentCustomBlockLayoutItem, } from './f-document';
 export { FDocumentParagraph, isParagraphFacade } from './f-document-paragraph';
 export type { IFDocumentFindTextOptions, IFDocumentParagraphInfo } from './f-document-paragraph';
+export { FDocumentObjectPermission, FDocumentPermission } from './f-document-permission';
 export { DocsSectionUnsupportedDocumentFlavorError, FDocumentSection } from './f-document-section';
 export type { FDocumentSectionPageSetup, IFDocumentSectionColumnOptions, IFDocumentSectionDescription } from './f-document-section';
 export { FDocumentTextRange } from './f-document-text-range';

package/lib/types/facade/utils.d.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import type { DocumentDataModel, IDocumentBody, Injector, IParagraphStyle, UpdateDocsAttributeType } from '@univerjs/core';
+import { ICommandService } from '@univerjs/core';
 export interface IBuildPlainTextInsertBodyOptions {
     paragraphStyle?: IParagraphStyle;
     removeLeadingParagraphBreak?: boolean;
@@ -33,6 +34,6 @@ export declare function getRemovedLeadingParagraphBreakLength(dataStream: string
 export declare function getNormalizedPlainTextCursorOffset(dataStream: string, cursorOffset: number, removeLeadingParagraphBreak?: boolean): number;
 export declare function getParagraphStyleAtOffset(body: IDocumentBody, offset: number): IParagraphStyle | undefined;
 export declare function buildPlainTextInsertBody(dataStream: string, options?: IBuildPlainTextInsertBodyOptions): IDocumentBody;
-export declare function replaceBodyRange(range: IFDocumentTextRange, insertBody: IDocumentBody, docDataModel: DocumentDataModel, injector: Injector): boolean;
+export declare function replaceBodyRange(range: IFDocumentTextRange, insertBody: IDocumentBody, docDataModel: DocumentDataModel, commandService: ICommandService): boolean;
 export declare function retainBodyRange(range: IFDocumentTextRange, updateBody: IDocumentBody, coverType: UpdateDocsAttributeType, docDataModel: DocumentDataModel, injector: Injector): boolean;
 export declare function stripBlockTokens(text: string): string;

package/lib/types/index.d.ts

@@ -21,18 +21,25 @@ export { SetDocumentDefaultParagraphStyleCommand } from './commands/commands/set
 export type { IDocumentDefaultParagraphStylePatch, ISetDocumentDefaultParagraphStyleCommandParams, } from './commands/commands/set-document-default-paragraph-style.command';
 export { SetDocumentNameCommand } from './commands/commands/set-document-name.command';
 export type { ISetDocumentNameCommandParams } from './commands/commands/set-document-name.command';
+export { SetDocumentPermissionCommand } from './commands/commands/set-document-permission.command';
+export type { ISetDocumentPermissionCommandParams } from './commands/commands/set-document-permission.command';
+export { SetDocumentPermissionsCommand } from './commands/commands/set-document-permissions.command';
 export { SetSectionHeaderFooterLinkCommand } from './commands/commands/set-section-header-footer-link.command';
 export type { ISetSectionHeaderFooterLinkCommandParams } from './commands/commands/set-section-header-footer-link.command';
 export { UpdateDocumentParagraphStyleCommand } from './commands/commands/update-document-paragraph-style.command';
 export { DeleteDocumentSectionBreakCommand, InsertDocumentColumnBreakCommand, InsertDocumentSectionBreakCommand, UpdateDocumentSectionCommand } from './commands/commands/update-document-section.command';
 export type { IDeleteDocumentSectionBreakCommandParams, IDocumentSectionConfig, IDocumentSectionUpdate, IInsertDocumentColumnBreakCommandParams, IInsertDocumentSectionBreakCommandParams, IUpdateDocumentSectionCommandParams } from './commands/commands/update-document-section.command';
-export { RichTextEditingMutation } from './commands/mutations/core-editing.mutation';
+export { DocHistoryAction, RichTextEditingMutation, transformDocumentTextRanges } from './commands/mutations/core-editing.mutation';
 export type { IRichTextEditingMutationParams } from './commands/mutations/core-editing.mutation';
+export { SetDocumentPermissionRuleMutation } from './commands/mutations/set-document-permission-rule.mutation';
+export { SetDocumentPermissionRulesMutation } from './commands/mutations/set-document-permission-rules.mutation';
 export { SetTextSelectionsOperation } from './commands/operations/text-selection.operation';
 export type { ISetTextSelectionsOperationParams } from './commands/operations/text-selection.operation';
 export type { IUniverDocsConfig } from './config/config';
 export { createDocsCustomBlockDrawing, createDocsCustomBlockInsertMutation, createDocsCustomBlockRemoveMutation, createEmbedDocsCustomBlockData, createInsertCustomBlockActions, createRemoveCustomBlockActions, EMBED_DOCS_CUSTOM_BLOCK_DEFAULT_COMPONENT_KEY, isEmbedDocsCustomBlockData, isSheetLikeDocsCustomBlockChildType, resolveDocsCustomBlockSize, shouldUseInlineTextSelectionForDocsCustomBlockDrawing, } from './embed-host-anchor';
 export type { EmbedDocsCustomBlockInteractionMode, IDocsCustomBlockMutationParams, IEmbedDocsCustomBlockData, } from './embed-host-anchor';
+export { DocsLayoutWorkerCapabilityError, DocsLayoutWorkerClientService, startDocsLayoutWorker, UniverDocsLayoutWorkerPlugin } from './layout-worker';
+export type { IDocsLayoutWorkerCapabilities, IDocsLayoutWorkerFontProbe, IDocsLayoutWorkerRuntime, IUniverDocsLayoutWorkerConfig } from './layout-worker';
 export { UniverDocsPlugin } from './plugin';
 export { DocBlockMoveValidatorService } from './services/doc-block-move-validator.service';
 export type { DocBlockMoveTransformer, DocBlockMoveValidator, IDocBlockMoveResult, IDocBlockMoveTransformContext, IDocBlockMoveValidationContext, } from './services/doc-block-move-validator.service';
@@ -40,6 +47,8 @@ export { DocContentInsertService } from './services/doc-content-insert.service';
 export type { IDocContentInsertRange } from './services/doc-content-insert.service';
 export { DocInterceptorService } from './services/doc-interceptor/doc-interceptor.service';
 export { DOC_INTERCEPTOR_POINT } from './services/doc-interceptor/interceptor-const';
+export { DocLayoutExecutorService, DocLayoutExecutorState, DocLayoutExecutorType, DocLayoutSessionStatus, } from './services/doc-layout-executor.service';
+export type { IDocLayoutCancelRequest, IDocLayoutCreateSessionRequest, IDocLayoutCustomRangePresentation, IDocLayoutCustomRangePresentationContext, IDocLayoutCustomRangePresentationEntry, IDocLayoutCustomRangePresentationPatch, IDocLayoutDisposeMountRequest, IDocLayoutDisposeSessionRequest, IDocLayoutExecutor, IDocLayoutExecutorStatus, IDocLayoutMountIdentity, IDocLayoutMutationProjection, IDocLayoutPageRequest, IDocLayoutPageResult, IDocLayoutPerformanceMetrics, IDocLayoutRecordPatch, IDocLayoutStartOptions, IDocLayoutStartRequest, IDocLayoutStartResult, IDocLayoutStepRequest, IDocLayoutStepResult, } from './services/doc-layout-executor.service';
 export { DOC_SELECTION_OPTION_PRESERVE_CARET, DocSelectionManagerService, } from './services/doc-selection-manager.service';
 export { DocSkeletonManagerService } from './services/doc-skeleton-manager.service';
 export { DocStateChangeManagerService, IDocStateChangeInterceptorService, } from './services/doc-state-change-manager.service';
@@ -47,6 +56,9 @@ export type { IDocStateChangeInfo, IDocStateChangeParams } from './services/doc-
 export { DocStateEmitService } from './services/doc-state-emit.service';
 export { DocTextResolverService } from './services/doc-text-resolver.service';
 export type { IDocTextReplacement, IDocTextResolver, IResolvedDocText, IResolvedDocTextCharacter, } from './services/doc-text-resolver.service';
+export { canEditDocumentTargets, createDocumentPermissionPoint, DOCUMENT_UNIT_PERMISSION_ACTIONS, getDocumentEntityPermissionObjectId, getDocumentParagraphPermissionObjectId, getDocumentPermissionValue, getDocumentSectionPermissionObjectId, setDocumentPermissionValue, } from './services/permission/document-permission';
+export type { DocumentUnitPermissionAction } from './services/permission/document-permission';
+export { getDocumentDrawingSegmentId, getDocumentEditTargetObjectIds, getDocumentEntityParentPermissionObjectIds, getDocumentParagraphParentPermissionObjectIds, } from './services/permission/document-permission-resolver';
 export { addCustomRangeBySelectionFactory, addCustomRangeFactory, deleteCustomRangeFactory, } from './utils/custom-range-factory';
 export { generateParagraphs } from './utils/paragraphs';
 export { replaceSelectionFactory } from './utils/replace-selection-factory';

package/lib/types/layout-worker/config/config.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+export declare const DOCS_LAYOUT_WORKER_PLUGIN_CONFIG_KEY = "docs-layout-worker.config";
+export declare const configSymbol: unique symbol;
+export declare const DEFAULT_DOCS_LAYOUT_WORKER_REQUEST_TIMEOUT_MS = 15000;
+export interface IDocsLayoutFontFace {
+    family: string;
+    /** Font bytes or a CSS FontFace source, such as url("https://example.test/font.woff2"). */
+    source: string | ArrayBuffer;
+    descriptors?: FontFaceDescriptors;
+}
+export interface IUniverDocsLayoutWorkerConfig {
+    workerFactory?: () => Worker;
+    /** Licensed web fonts to load in both the rendering context and the layout Worker before layout. */
+    fontFaces?: IDocsLayoutFontFace[];
+    /** Maximum time allowed for one Worker RPC request before recovery starts. */
+    requestTimeoutMs?: number;
+}
+export declare const defaultPluginDocsLayoutWorkerConfig: IUniverDocsLayoutWorkerConfig;

package/lib/types/layout-worker/document-font-metrics.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+/** Collect once from the snapshot, then only from mutation payloads (including JSON1 font replacements). */
+export declare function collectDocumentFontFamilies(value: unknown, families: Set<string>): void;
+export declare function measureDocumentFontFamilies(families: Set<string>): Record<string, number>;

package/lib/types/layout-worker/font-loader.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 { IDocsLayoutFontFace } from './config/config';
+import { Disposable } from '@univerjs/core';
+/** Owns the same explicitly supplied font faces in the rendering and layout realms. */
+export declare class DocsLayoutFontLoader extends Disposable {
+    private _loading;
+    private _fontSet;
+    private _faces;
+    load(fonts: readonly IDocsLayoutFontFace[]): Promise<void>;
+    dispose(): void;
+    private _load;
+}

package/lib/types/layout-worker/index.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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 { IDocLayoutCancelRequest, IDocLayoutCreateSessionRequest, IDocLayoutDisposeMountRequest, IDocLayoutDisposeSessionRequest, IDocLayoutExecutor, IDocLayoutPageRequest, IDocLayoutPageResult, IDocLayoutPerformanceMetrics, IDocLayoutStartRequest, IDocLayoutStartResult, IDocLayoutStepRequest, IDocLayoutStepResult } from '../services/doc-layout-executor.service';
+import type { IDocsLayoutFontFace, IUniverDocsLayoutWorkerConfig } from './config/config';
+import type { IDocsLayoutWorkerCapabilities } from './protocol';
+import { Disposable, IConfigService, Injector, Plugin } from '@univerjs/core';
+import { DocLayoutExecutorService, DocLayoutExecutorType } from '../services/doc-layout-executor.service';
+import { startDocsLayoutWorker } from './worker';
+export declare class DocsLayoutWorkerCapabilityError extends Error {
+    constructor(message: string);
+}
+export declare class DocsLayoutWorkerClientService extends Disposable implements IDocLayoutExecutor {
+    private readonly _workerFactory;
+    private readonly _requestTimeoutMs;
+    private readonly _fontFaces;
+    readonly type = DocLayoutExecutorType.WORKER;
+    private _worker;
+    private _channelService;
+    private _runtime;
+    private _initialization;
+    private _initialized;
+    private readonly _performanceTracker;
+    private readonly _fontFamilies;
+    private readonly _fontLoader;
+    constructor(_workerFactory: () => Worker, _requestTimeoutMs?: number, _fontFaces?: IDocsLayoutFontFace[]);
+    initialize(): Promise<void>;
+    get renderingFontsReady(): Promise<void> | undefined;
+    getCapabilities(): Promise<IDocsLayoutWorkerCapabilities>;
+    recover(): Promise<void>;
+    createSession(request: IDocLayoutCreateSessionRequest): Promise<void>;
+    startLayout(request: IDocLayoutStartRequest): Promise<IDocLayoutStartResult>;
+    stepLayout(request: IDocLayoutStepRequest): Promise<IDocLayoutStepResult>;
+    publishBacklog(request: Omit<IDocLayoutStepRequest, 'budgetMs'>): Promise<IDocLayoutStepResult>;
+    getLayoutPage(request: IDocLayoutPageRequest): Promise<IDocLayoutPageResult>;
+    cancelLayout(request: IDocLayoutCancelRequest): Promise<void>;
+    getPerformanceMetrics(unitId: string): Promise<Omit<IDocLayoutPerformanceMetrics, 'hydrationMs'>>;
+    resetPerformanceMetrics(unitId: string): Promise<void>;
+    disposeLayoutMount(request: IDocLayoutDisposeMountRequest): Promise<void>;
+    disposeSession(request: IDocLayoutDisposeSessionRequest): Promise<void>;
+    dispose(): void;
+    private _replaceRuntime;
+    private _disposeRuntime;
+    private _getRuntime;
+    private _withTimeout;
+    private _verifyCapabilities;
+}
+export declare class UniverDocsLayoutWorkerPlugin extends Plugin {
+    private readonly _config;
+    readonly _injector: Injector;
+    private readonly _layoutExecutorService;
+    private readonly _configService;
+    static pluginName: string;
+    static packageName: string;
+    static version: string;
+    constructor(_config: Partial<IUniverDocsLayoutWorkerConfig> | undefined, _injector: Injector, _layoutExecutorService: DocLayoutExecutorService, _configService: IConfigService);
+    onStarting(): void;
+}
+export type { IUniverDocsLayoutWorkerConfig } from './config/config';
+export type { IDocsLayoutWorkerCapabilities, IDocsLayoutWorkerFontProbe, IDocsLayoutWorkerRuntime } from './protocol';
+export { startDocsLayoutWorker };

package/lib/types/layout-worker/performance-tracker.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 { IDocLayoutPerformanceMetrics } from '../services/doc-layout-executor.service';
+type WorkerTransferMetrics = Omit<IDocLayoutPerformanceMetrics, 'hydrationMs'>;
+export declare class DocsLayoutWorkerPerformanceTracker {
+    private readonly _metrics;
+    recordRequest(message: unknown, durationMs: number): void;
+    recordResponse(message: unknown, durationMs: number): void;
+    getMetrics(unitId: string): WorkerTransferMetrics;
+    reset(unitId: string): void;
+    resetAll(): void;
+    private _append;
+}
+export {};

package/lib/types/layout-worker/protocol.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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';
+import type { IDocsLayoutFontFace } from './config/config';
+export declare const DOCS_LAYOUT_WORKER_CHANNEL = "univer.docs-layout-worker";
+export declare 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 {
+    initialize(fontFaces?: IDocsLayoutFontFace[]): Promise<void>;
+    getCapabilities(): Promise<IDocsLayoutWorkerCapabilities>;
+}

package/lib/types/layout-worker/worker.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { IDocLayoutCancelRequest, IDocLayoutCreateSessionRequest, IDocLayoutDisposeMountRequest, IDocLayoutDisposeSessionRequest, IDocLayoutPageRequest, IDocLayoutPageResult, IDocLayoutPerformanceMetrics, IDocLayoutStartRequest, IDocLayoutStartResult, IDocLayoutStepRequest, IDocLayoutStepResult } from '../services/doc-layout-executor.service';
+import type { IDocsLayoutFontFace } from './config/config';
+import type { IDocsLayoutWorkerCapabilities, IDocsLayoutWorkerRuntime } from './protocol';
+import { ChannelService } from '@univerjs/rpc';
+import { DocLayoutExecutorType } from '../services/doc-layout-executor.service';
+import { DocsLayoutWorkerPerformanceTracker } from './performance-tracker';
+export declare class DocsLayoutWorkerRuntime implements IDocsLayoutWorkerRuntime {
+    private readonly _performanceTracker;
+    private readonly _sessions;
+    private readonly _fontLoader;
+    readonly type = DocLayoutExecutorType.WORKER;
+    constructor(_performanceTracker?: DocsLayoutWorkerPerformanceTracker);
+    initialize(fontFaces?: IDocsLayoutFontFace[]): Promise<void>;
+    getCapabilities(): Promise<IDocsLayoutWorkerCapabilities>;
+    recover(): Promise<void>;
+    createSession(request: IDocLayoutCreateSessionRequest): Promise<void>;
+    startLayout(request: IDocLayoutStartRequest): Promise<IDocLayoutStartResult>;
+    private _applyMutations;
+    private _applyCustomRangePresentations;
+    private _updateCustomRangePresentations;
+    stepLayout(request: IDocLayoutStepRequest): Promise<IDocLayoutStepResult>;
+    publishBacklog(request: Omit<IDocLayoutStepRequest, 'budgetMs'>): Promise<IDocLayoutStepResult>;
+    getLayoutPage(request: IDocLayoutPageRequest): Promise<IDocLayoutPageResult>;
+    cancelLayout(request: IDocLayoutCancelRequest): Promise<void>;
+    getPerformanceMetrics(unitId: string): Promise<Omit<IDocLayoutPerformanceMetrics, 'hydrationMs'>>;
+    resetPerformanceMetrics(unitId: string): Promise<void>;
+    disposeLayoutMount(request: IDocLayoutDisposeMountRequest): Promise<void>;
+    disposeSession(request: IDocLayoutDisposeSessionRequest): Promise<void>;
+    dispose(): void;
+    private _getSession;
+    private _getLayoutMount;
+    private _runLayoutStep;
+    private _runWithCustomBlockViewports;
+    private _disposeSession;
+}
+export declare function startDocsLayoutWorker(): ChannelService;

package/lib/types/plugin.d.ts

@@ -24,6 +24,7 @@ export declare class UniverDocsPlugin extends Plugin {
     static version: string;
     constructor(_config: Partial<IUniverDocsConfig> | undefined, _injector: Injector, _configService: IConfigService);
     onStarting(): void;
+    private _initializeWordResources;
     private _initializeCommands;
     private _initializeDependencies;
     onReady(): void;

package/lib/types/services/doc-interceptor/interceptor-const.d.ts

@@ -13,11 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { ICustomDecoration, ICustomDecorationForInterceptor, ICustomRange, ICustomRangeForInterceptor } from '@univerjs/core';
+import type { ICustomDecoration, ICustomDecorationForInterceptor, ICustomRange, ICustomRangeForInterceptor, IDocumentBody } from '@univerjs/core';
 export declare const DOC_INTERCEPTOR_POINT: {
     CUSTOM_RANGE: import("@univerjs/core").IInterceptor<ICustomRangeForInterceptor, {
         index: number;
         unitId: string;
+        body: IDocumentBody | undefined;
         customRanges: ICustomRange[];
     }>;
     CUSTOM_DECORATION: import("@univerjs/core").IInterceptor<ICustomDecorationForInterceptor, {