@a3s-lab/office 0.30.0 → 0.32.0

package/dist/index.js

@@ -2,14 +2,14 @@ var src_DOCUMENT_SNAPSHOT_VERSION = 1;
 var src_DOCUMENT_SOURCE_VERSION = 1;
 var src_OFFICE_COLLABORATION_VERSION = 1;
 export { AGENT_PROPOSAL_PROTOCOL, OFFICE_NOTIFICATION_EVENT, createAgentProposalInstruction, createAgentProposalRequest, getAgentProposalStatus, subscribeOfficeNotifications } from "./6489.js";
-export { DOCUMENT_SNAPSHOT_MEDIA_TYPE, DOCUMENT_SNAPSHOT_SCHEMA, DOCUMENT_SOURCE_MEDIA_TYPE, DOCUMENT_SOURCE_SCHEMA, OFFICE_COLLABORATION_DEFAULT_MAX_TRANSPORT_PAYLOAD_BYTES, OFFICE_COLLABORATION_MAX_TRANSPORT_PAYLOAD_BYTES, OFFICE_COLLABORATION_PRESENCE_FIELD, OFFICE_FILE_ACCEPT, applyDocumentSource, artifactExtension, artifactExtension as workArtifactExtension, artifactKindLabel, artifactKindLabel as workArtifactKindLabel, createArtifactBlob, createOfficeCollaborationPresence, createOfficeCollaborationTransportBinding, createPdfCollaborationContent, decodeDocumentSnapshot, defaultPptxRuntimeUrl, downloadArtifact, downloadArtifactPdf, encodeDocumentSnapshot, forgetSourceBlob, importOfficeFile, officeKindForFile, pdfPagesForExport, projectDocumentSource, readSourceBlob, registerSourceBlob } from "./4104.js";
+export { DOCUMENT_SNAPSHOT_MEDIA_TYPE, DOCUMENT_SNAPSHOT_SCHEMA, DOCUMENT_SOURCE_MEDIA_TYPE, DOCUMENT_SOURCE_SCHEMA, OFFICE_COLLABORATION_DEFAULT_MAX_TRANSPORT_PAYLOAD_BYTES, OFFICE_COLLABORATION_MAX_TRANSPORT_PAYLOAD_BYTES, OFFICE_COLLABORATION_PRESENCE_FIELD, OFFICE_FILE_ACCEPT, applyDocumentSource, artifactExtension, artifactExtension as workArtifactExtension, artifactKindLabel, artifactKindLabel as workArtifactKindLabel, createArtifactBlob, createOfficeCollaborationPresence, createOfficeCollaborationTransportBinding, createPdfCollaborationContent, decodeDocumentSnapshot, defaultPptxRuntimeUrl, downloadArtifact, downloadArtifactPdf, encodeDocumentSnapshot, importOfficeFile, officeKindForFile, pdfPagesForExport, projectDocumentSource } from "./core.js";
 export { DocumentEditor, MarkdownEditor, PDF_EVIDENCE_COORDINATE_BASIS, PdfViewer, PresentationEditor, SpreadsheetEditor, defaultDocumentArabicLayoutFontUrl, defaultDocumentHebrewLayoutFontUrl, defaultDocumentLatinLayoutFontUrl, defaultDocumentLayoutFontUrl, defaultDocumentLayoutFonts, defaultOfficeKernelWasmUrl, defaultPdfiumWasmUrl, preloadOfficeEditor } from "./432.js";
 export { OFFICE_COLLABORATION_NAMESPACE, OFFICE_COLLABORATION_PROTOCOL, OfficeCollaborationError, createOfficeCollaborationSession, readOfficeCollaborationMetadata } from "./9787.js";
 export { assertPdfCollaborationSource, createOfficePdfCollaborationBinding, initializeOfficePdfCollaboration, readOfficePdfCollaboration, readOfficePdfCollaborationSource, replaceOfficePdfCollaboration } from "./3818.js";
 export { createArtifact, createOfficeId, officeTemplates } from "./4121.js";
-export { createOfficeDocumentCollaborationBinding, initializeOfficeDocumentCollaboration, officeDocumentCollaborationFragment, readOfficeDocumentCollaboration } from "./6282.js";
+export { createOfficeDocumentCollaborationBinding, forgetSourceBlob, initializeOfficeDocumentCollaboration, officeDocumentCollaborationFragment, readOfficeDocumentCollaboration, readSourceBlob, registerSourceBlob } from "./4174.js";
 export { createOfficeMarkdownCollaborationBinding, initializeOfficeMarkdownCollaboration, readOfficeMarkdownCollaboration, replaceOfficeMarkdownCollaboration } from "./2591.js";
 export { createOfficePresentationCollaborationBinding, initializeOfficePresentationCollaboration, readOfficePresentationCollaboration, replaceOfficePresentationCollaboration } from "./4560.js";
-export { createOfficeSpreadsheetCollaborationBinding, initializeOfficeSpreadsheetCollaboration, readOfficeSpreadsheetCollaboration, replaceOfficeSpreadsheetCollaboration } from "./1544.js";
+export { createOfficeSpreadsheetCollaborationBinding, initializeOfficeSpreadsheetCollaboration, readOfficeSpreadsheetCollaboration, replaceOfficeSpreadsheetCollaboration } from "./3266.js";
 export { normalizeWorkSpreadsheetBubbleScale, normalizeWorkSpreadsheetBubbleSizeRepresents, normalizeWorkSpreadsheetChartAxisGroup, normalizeWorkSpreadsheetCombinationSeriesType, normalizeWorkSpreadsheetDataLabelPosition, normalizeWorkSpreadsheetDataLabels, normalizeWorkSpreadsheetDoughnutHoleSize, normalizeWorkSpreadsheetErrorBars, normalizeWorkSpreadsheetRadarStyle, normalizeWorkSpreadsheetScatterStyle, normalizeWorkSpreadsheetTrendline, normalizeWorkSpreadsheetTrendlineType, workSpreadsheetChartSupportsAxes, workSpreadsheetChartSupportsErrorBars, workSpreadsheetChartSupportsTrendlines, workSpreadsheetChartTypeLabel, workSpreadsheetChartUsesNumericXAxis, workSpreadsheetCombinationSeriesTypeLabel, workSpreadsheetDataLabelPositionLabel, workSpreadsheetErrorBarTypeLabel, workSpreadsheetErrorBarValueTypeLabel, workSpreadsheetTrendlineTypeLabel } from "./8715.js";
 export { src_DOCUMENT_SNAPSHOT_VERSION as DOCUMENT_SNAPSHOT_VERSION, src_DOCUMENT_SOURCE_VERSION as DOCUMENT_SOURCE_VERSION, src_OFFICE_COLLABORATION_VERSION as OFFICE_COLLABORATION_VERSION };

package/dist/internal/features/work/editors/document-command-catalog.d.ts

@@ -616,6 +616,33 @@ export declare const documentCommandCatalog: {
             readonly group: "tableOfContents";
         };
     };
+    readonly markIndexEntry: {
+        readonly id: "references.markIndexEntry";
+        readonly label: "标记索引项";
+        readonly location: {
+            readonly area: "ribbon";
+            readonly tab: "references";
+            readonly group: "index";
+        };
+    };
+    readonly index: {
+        readonly id: "references.index";
+        readonly label: "插入或自定义索引";
+        readonly location: {
+            readonly area: "ribbon";
+            readonly tab: "references";
+            readonly group: "index";
+        };
+    };
+    readonly refreshIndex: {
+        readonly id: "references.refreshIndex";
+        readonly label: "更新索引";
+        readonly location: {
+            readonly area: "ribbon";
+            readonly tab: "references";
+            readonly group: "index";
+        };
+    };
     readonly refreshFields: {
         readonly id: "references.refreshFields";
         readonly label: "更新域";

package/dist/internal/features/work/editors/document-compare-dialog.d.ts

@@ -0,0 +1,14 @@
+import type { DocumentComparisonApplyResult, DocumentComparisonMode } from '../work-document-compare';
+export interface DocumentCompareDialogRequest {
+    author: string;
+    file: File;
+    mode: DocumentComparisonMode;
+}
+export interface DocumentCompareDialogProps {
+    initialMode: DocumentComparisonMode;
+    restoreFocusTarget: () => HTMLElement | null;
+    onApplied: (result: DocumentComparisonApplyResult) => void;
+    onClose: () => void;
+    onSubmit: (request: DocumentCompareDialogRequest) => Promise<DocumentComparisonApplyResult>;
+}
+export declare function DocumentCompareDialog({ initialMode, restoreFocusTarget, onApplied, onClose, onSubmit, }: DocumentCompareDialogProps): import("react").JSX.Element;

package/dist/internal/features/work/editors/document-dom-selection.d.ts

@@ -0,0 +1,7 @@
+import type { Editor } from '@tiptap/core';
+/**
+ * Reconciles a visible browser text selection before a capture-phase command
+ * snapshots editor state. Selection-change delivery can lag behind a keyboard
+ * shortcut under load, leaving ProseMirror with an older collapsed selection.
+ */
+export declare function synchronizeDocumentEditorSelectionFromDom(editor: Editor): boolean;

package/dist/internal/features/work/editors/document-editor-support.d.ts

@@ -28,3 +28,4 @@ interface CustomSelectionMenuItem<Context> {
 export declare function customSelectionMenuItems<Context>(items: readonly CustomSelectionMenuItem<Context>[], createAction: () => CustomSelectionAction<Context>): WorkspaceContextMenuItem[];
 export declare function documentPageCount(editor: Editor): number;
 export declare function documentCurrentPage(editor: Editor): number;
+export declare function documentHasRefreshableFields(editor: Editor): boolean;

package/dist/internal/features/work/editors/document-index-dialog.d.ts

@@ -0,0 +1,10 @@
+import type { WorkDocumentIndexOptions } from '../work-document-index';
+export interface DocumentIndexDialogProps {
+    editing: boolean;
+    options: WorkDocumentIndexOptions;
+    restoreFocusTarget: () => HTMLElement | null;
+    onCancel: () => void;
+    onOptionsChange: (options: WorkDocumentIndexOptions) => void;
+    onSubmit: () => void;
+}
+export declare function DocumentIndexDialog({ editing, options, restoreFocusTarget, onCancel, onOptionsChange, onSubmit, }: DocumentIndexDialogProps): import("react").JSX.Element;

package/dist/internal/features/work/editors/document-index-entry-dialog.d.ts

@@ -0,0 +1,10 @@
+import type { WorkDocumentIndexEntryDraft } from '../work-document-index';
+export interface DocumentIndexEntryDialogProps {
+    editing: boolean;
+    value: WorkDocumentIndexEntryDraft;
+    restoreFocusTarget: () => HTMLElement | null;
+    onCancel: () => void;
+    onChange: (value: WorkDocumentIndexEntryDraft) => void;
+    onSubmit: () => void;
+}
+export declare function DocumentIndexEntryDialog({ editing, value, restoreFocusTarget, onCancel, onChange, onSubmit, }: DocumentIndexEntryDialogProps): import("react").JSX.Element;

package/dist/internal/features/work/editors/document-references-ribbon.d.ts

@@ -0,0 +1,19 @@
+import type { Editor } from '@tiptap/core';
+import type { WorkDocumentCaptionKind } from '../work-document-captions';
+import type { WorkDocumentNoteKind } from '../work-document-notes';
+export interface DocumentReferencesRibbonProps {
+    editor: Editor;
+    citationsOpen: boolean;
+    citationSourceCount: number;
+    onInsertNote: (kind: WorkDocumentNoteKind) => void;
+    onInsertCaption: (kind: WorkDocumentCaptionKind) => void;
+    onInsertCrossReference: () => void;
+    onOpenTableOfContents: () => void;
+    onRefreshTableOfContents: () => void;
+    onOpenIndexEntry: () => void;
+    onOpenIndex: () => void;
+    onRefreshIndex: () => void;
+    onToggleCitations: () => void;
+    onRefreshFields: () => void;
+}
+export declare function DocumentReferencesRibbon({ editor, citationsOpen, citationSourceCount, onInsertNote, onInsertCaption, onInsertCrossReference, onOpenTableOfContents, onRefreshTableOfContents, onOpenIndexEntry, onOpenIndex, onRefreshIndex, onToggleCitations, onRefreshFields, }: DocumentReferencesRibbonProps): import("react").JSX.Element;

package/dist/internal/features/work/editors/document-toolbar.d.ts

@@ -1,6 +1,7 @@
 import type { Editor } from '@tiptap/core';
 import type { WorkDocumentCaptionKind } from '../work-document-captions';
 import { type WorkDocumentChange } from '../work-document-changes';
+import type { DocumentComparisonMode } from '../work-document-compare';
 import type { WorkDocumentFieldKind } from '../work-document-fields';
 import type { WorkDocumentLayoutFont } from '../work-document-fonts';
 import type { WorkDocumentNoteKind } from '../work-document-notes';
@@ -58,11 +59,14 @@ interface DocumentToolbarProps {
     onInsertCaption: (kind: WorkDocumentCaptionKind) => void;
     onInsertCrossReference: () => void;
     onOpenTableOfContents: () => void;
+    onOpenIndexEntry: () => void;
+    onOpenIndex: () => void;
     citationsOpen: boolean;
     citationSourceCount: number;
     onToggleCitations: () => void;
     onInsertField: (kind: WorkDocumentFieldKind) => void;
     onRefreshFields: () => void;
+    onRefreshIndex: () => void;
     onRefreshTableOfContents: () => void;
     canInsertComment: boolean;
     onInsertComment: () => void;
@@ -77,9 +81,10 @@ interface DocumentToolbarProps {
     onRibbonTabChange?: (tab: DocumentRibbonTabId) => boolean | undefined | Promise<boolean | undefined>;
     onToggleTrackChanges: () => void;
     onToggleChanges: () => void;
+    onOpenComparison: (mode: DocumentComparisonMode) => void;
     onDecideChange?: (change: WorkDocumentChange, decision: 'accept' | 'reject') => boolean;
     onOpenWordCount: () => void;
     onOpenFindReplace: (mode: DocumentFindReplaceMode) => void;
 }
-export declare function DocumentToolbar({ editor, defaultRibbonCollapsed, reviewOnly, suggestionOnly, history, layoutOpen, layout, layoutFonts, navigationOpen, pageColor, showPageNumbers, showHiddenText, showRulers, spellcheckEnabled, viewMode, zoom, pageChromeEditor, pageChromeEditingPart, pageChromeShowPageNumber, onRequestImage, onPageChromeEditingPartChange, onClosePageChrome, onTogglePageChromePageNumber, onToggleLayout, onLayoutChange, onOpenLayout, onToggleNavigation, onTogglePageNumbers, onToggleHiddenText, onToggleRulers, onPageColorChange, onToggleSpellcheck, onViewModeChange, onZoomChange, onZoomFit, onInsertSection, onInsertNote, onInsertCaption, onInsertCrossReference, onOpenTableOfContents, citationsOpen, citationSourceCount, onToggleCitations, onInsertField, onRefreshFields, onRefreshTableOfContents, canInsertComment, onInsertComment, commentsOpen, commentCount, onToggleComments, trackChanges, changesOpen, changeCount, findReplaceMode, fileActions, onRibbonTabChange, onToggleTrackChanges, onToggleChanges, onDecideChange, onOpenWordCount, onOpenFindReplace, }: DocumentToolbarProps): import("react").JSX.Element;
+export declare function DocumentToolbar({ editor, defaultRibbonCollapsed, reviewOnly, suggestionOnly, history, layoutOpen, layout, layoutFonts, navigationOpen, pageColor, showPageNumbers, showHiddenText, showRulers, spellcheckEnabled, viewMode, zoom, pageChromeEditor, pageChromeEditingPart, pageChromeShowPageNumber, onRequestImage, onPageChromeEditingPartChange, onClosePageChrome, onTogglePageChromePageNumber, onToggleLayout, onLayoutChange, onOpenLayout, onToggleNavigation, onTogglePageNumbers, onToggleHiddenText, onToggleRulers, onPageColorChange, onToggleSpellcheck, onViewModeChange, onZoomChange, onZoomFit, onInsertSection, onInsertNote, onInsertCaption, onInsertCrossReference, onOpenTableOfContents, onOpenIndexEntry, onOpenIndex, citationsOpen, citationSourceCount, onToggleCitations, onInsertField, onRefreshFields, onRefreshIndex, onRefreshTableOfContents, canInsertComment, onInsertComment, commentsOpen, commentCount, onToggleComments, trackChanges, changesOpen, changeCount, findReplaceMode, fileActions, onRibbonTabChange, onToggleTrackChanges, onToggleChanges, onOpenComparison, onDecideChange, onOpenWordCount, onOpenFindReplace, }: DocumentToolbarProps): import("react").JSX.Element;
 export {};

package/dist/internal/features/work/editors/use-document-comparison.d.ts

@@ -0,0 +1,9 @@
+import type { Editor } from '@tiptap/core';
+import { type DocumentComparisonMode } from '../work-document-compare';
+export declare function useDocumentComparison({ editor, onApplied, }: {
+    editor: Editor | null;
+    onApplied: () => void;
+}): {
+    dialog: import("react").JSX.Element | null;
+    open: (mode: DocumentComparisonMode) => void;
+};

package/dist/internal/features/work/editors/use-document-insert-commands.d.ts

@@ -11,8 +11,11 @@ export interface DocumentInsertCommands {
     insertField: (kind: WorkDocumentFieldKind) => void;
     insertImage: (file: File) => Promise<void>;
     insertNote: (kind: WorkDocumentNoteKind) => boolean;
+    openIndexEntry: () => void;
+    openIndex: () => void;
     openTableOfContents: () => void;
     refreshFields: () => boolean;
+    refreshIndex: () => boolean;
     refreshTableOfContents: () => boolean;
 }
 export declare function useDocumentInsertCommands({ contentRef, editor, resolveFieldContext, }: {

package/dist/internal/features/work/work-document-changes.d.ts

@@ -36,3 +36,8 @@ declare module '@tiptap/core' {
 }
 export declare const DocumentChange: Mark<DocumentChangeOptions, any>;
 export declare function collectDocumentChanges(document: ProseMirrorNode): WorkDocumentChange[];
+/**
+ * Resolves every revision on an immutable document snapshot. A malformed
+ * formatting snapshot returns `null` instead of approximating the baseline.
+ */
+export declare function resolveAllDocumentChanges(document: ProseMirrorNode, decision: 'accept' | 'reject'): ProseMirrorNode | null;

package/dist/internal/features/work/work-document-compare-diff.d.ts

@@ -0,0 +1,38 @@
+export type DocumentSequenceDiff<T> = {
+    kind: 'equal';
+    left: T[];
+    right: T[];
+} | {
+    kind: 'delete';
+    left: T[];
+    right: [];
+} | {
+    kind: 'insert';
+    left: [];
+    right: T[];
+};
+export type DocumentSequenceAlignment<T> = {
+    kind: 'equal' | 'substitute';
+    left: T;
+    right: T;
+} | {
+    kind: 'delete';
+    left: T;
+    right: null;
+} | {
+    kind: 'insert';
+    left: null;
+    right: T;
+};
+/**
+ * Computes a deterministic LCS diff while bounding the allocated matrix.
+ * Callers can fall back to one replacement when the requested matrix is too
+ * large instead of allowing adversarial documents to allocate without limit.
+ */
+export declare function boundedDocumentSequenceDiff<T>(left: readonly T[], right: readonly T[], equal: (left: T, right: T) => boolean, maximumCells: number): DocumentSequenceDiff<T>[] | null;
+/**
+ * Aligns document blocks with a weighted substitution cost. A substitution
+ * cost below two pairs related blocks; a cost of two or more prefers an
+ * explicit deletion plus insertion.
+ */
+export declare function boundedDocumentSequenceAlignment<T>(left: readonly T[], right: readonly T[], substitutionCost: (left: T, right: T) => number, maximumCells: number): DocumentSequenceAlignment<T>[] | null;

package/dist/internal/features/work/work-document-compare-stability.d.ts

@@ -0,0 +1,5 @@
+export declare function stableJson(value: unknown): string;
+export declare function stableHash(value: string): string;
+export declare function wordParagraphId(value: string): string;
+export declare function normalizedDate(value: string): string;
+export declare function boundedMetadata(value: string, maximum: number): string;

package/dist/internal/features/work/work-document-compare.d.ts

@@ -0,0 +1,27 @@
+import { type Content, type Editor } from '@tiptap/core';
+export type DocumentComparisonMode = 'compare' | 'combine';
+export type DocumentComparisonDiagnosticCode = 'changed-complex-structure' | 'combine-baseline-mismatch' | 'combine-resolution-invalid' | 'combine-structural-revisions' | 'combine-without-revisions' | 'comparison-limit-exceeded' | 'current-revisions-present' | 'empty-structural-change' | 'invalid-revised-content' | 'revised-revisions-present' | 'section-layout-mismatch' | 'unsupported-inline-review-state';
+export interface DocumentComparisonDiagnostic {
+    code: DocumentComparisonDiagnosticCode;
+    message: string;
+    section?: number;
+    block?: number;
+}
+export interface DocumentComparisonSummary {
+    insertions: number;
+    deletions: number;
+    formatting: number;
+    paragraphFormatting: number;
+}
+export interface DocumentComparisonOptions {
+    mode: DocumentComparisonMode;
+    author: string;
+    date: string;
+    sourceName: string;
+}
+export interface DocumentComparisonApplyResult {
+    status: 'applied' | 'unchanged' | 'unsupported';
+    summary: DocumentComparisonSummary;
+    diagnostics: DocumentComparisonDiagnostic[];
+}
+export declare function applyDocumentComparison(editor: Editor, revisedContent: Content, options: DocumentComparisonOptions): DocumentComparisonApplyResult;

package/dist/internal/features/work/work-document-index-fields.d.ts

@@ -0,0 +1,19 @@
+import { type WorkDocumentIndexEntryDraft, type WorkDocumentIndexOptions } from './work-document-index';
+export type WorkDocumentIndexEntryInstructionResult = {
+    supported: true;
+    value: WorkDocumentIndexEntryDraft;
+} | {
+    supported: false;
+    reason: 'not-index-entry' | 'invalid-instruction' | 'invalid-entry' | 'unsupported-switch';
+};
+export type WorkDocumentIndexInstructionResult = {
+    supported: true;
+    options: WorkDocumentIndexOptions;
+} | {
+    supported: false;
+    reason: 'not-index' | 'invalid-instruction' | 'invalid-columns' | 'unsupported-switch';
+};
+export declare function parseDocumentIndexEntryInstruction(instruction: string): WorkDocumentIndexEntryInstructionResult;
+export declare function documentIndexEntryInstruction(source: WorkDocumentIndexEntryDraft): string;
+export declare function parseDocumentIndexInstruction(instruction: string): WorkDocumentIndexInstructionResult;
+export declare function documentIndexInstruction(source: WorkDocumentIndexOptions): string;

package/dist/internal/features/work/work-document-index-nodes.d.ts

@@ -0,0 +1,32 @@
+import { Node, type CommandProps } from '@tiptap/core';
+import { type WorkDocumentIndexBuildOptions, type WorkDocumentIndexEntry, type WorkDocumentIndexEntryDraft, type WorkDocumentIndexOptions } from './work-document-index';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        documentIndexEntry: {
+            markDocumentIndexEntry: (value: WorkDocumentIndexEntryDraft) => ReturnType;
+            updateDocumentIndexEntry: (value: WorkDocumentIndexEntryDraft) => ReturnType;
+        };
+        documentIndex: {
+            insertDocumentIndex: (options?: WorkDocumentIndexOptions, buildOptions?: WorkDocumentIndexBuildOptions) => ReturnType;
+            updateDocumentIndex: (options: WorkDocumentIndexOptions, buildOptions?: WorkDocumentIndexBuildOptions) => ReturnType;
+            refreshDocumentIndexes: (buildOptions?: WorkDocumentIndexBuildOptions) => ReturnType;
+        };
+    }
+}
+export declare const DocumentIndexEntry: Node<any, any>;
+export declare const DocumentIndex: Node<any, any>;
+export declare function selectedDocumentIndexEntry(editor: {
+    state: CommandProps['state'];
+}): WorkDocumentIndexEntry | null;
+export declare function selectedDocumentIndexOptions(editor: {
+    state: CommandProps['state'];
+}): WorkDocumentIndexOptions | null;
+export declare function selectedDocumentIndexDraft(editor: {
+    state: CommandProps['state'];
+}): WorkDocumentIndexEntryDraft | null;
+export declare function documentHasIndexEntries(editor: {
+    state: CommandProps['state'];
+}): boolean;
+export declare function documentHasIndex(editor: {
+    state: CommandProps['state'];
+}): boolean;

package/dist/internal/features/work/work-document-index.d.ts

@@ -0,0 +1,63 @@
+import type { Node as ProseMirrorNode } from '@tiptap/pm/model';
+import type { WorkDocumentFieldContextResolver } from './work-document-fields';
+export type WorkDocumentIndexLeader = 'dot' | 'dash' | 'underline' | 'none';
+export type WorkDocumentIndexFormat = 'indented' | 'run-in';
+export interface WorkDocumentIndexEntryDraft {
+    mainEntry: string;
+    subEntry: string;
+    crossReference: string;
+    pageBold: boolean;
+    pageItalic: boolean;
+}
+export interface WorkDocumentIndexEntry extends WorkDocumentIndexEntryDraft {
+    id: string;
+}
+export interface WorkDocumentIndexPage {
+    pageNumber: number;
+    pageBold: boolean;
+    pageItalic: boolean;
+    targetIds: string[];
+}
+export interface WorkDocumentIndexGeneratedEntry {
+    mainEntry: string;
+    subEntry: string;
+    crossReference: string;
+    pages: WorkDocumentIndexPage[];
+}
+export interface WorkDocumentIndexOptions {
+    columns: number;
+    format: WorkDocumentIndexFormat;
+    rightAlignPageNumbers: boolean;
+    leader: WorkDocumentIndexLeader;
+}
+export interface WorkDocumentIndexValue {
+    id: string;
+    options: WorkDocumentIndexOptions;
+    entries: WorkDocumentIndexGeneratedEntry[];
+    truncated: boolean;
+}
+export interface WorkDocumentIndexBuildOptions {
+    resolveContext?: WorkDocumentFieldContextResolver;
+}
+export declare const DEFAULT_DOCUMENT_INDEX_OPTIONS: WorkDocumentIndexOptions;
+export declare const MAX_DOCUMENT_INDEX_ENTRIES = 512;
+export declare const MAX_DOCUMENT_INDEX_MARKERS = 2048;
+export declare const MAX_DOCUMENT_INDEX_TERM_LENGTH = 240;
+export declare function normalizeDocumentIndexEntryDraft(source: Partial<WorkDocumentIndexEntryDraft> | null | undefined): WorkDocumentIndexEntryDraft | null;
+export declare function normalizeDocumentIndexEntry(source: Partial<WorkDocumentIndexEntry> | null | undefined, fallbackId?: string): WorkDocumentIndexEntry | null;
+export declare function normalizeDocumentIndexOptions(source: Partial<WorkDocumentIndexOptions> | null | undefined): WorkDocumentIndexOptions;
+export declare function normalizeDocumentIndexValue(source: Omit<WorkDocumentIndexValue, 'truncated'> & {
+    truncated?: boolean;
+}): WorkDocumentIndexValue;
+export declare function buildDocumentIndexEntries(document: ProseMirrorNode, options?: WorkDocumentIndexBuildOptions): {
+    entries: WorkDocumentIndexGeneratedEntry[];
+    truncated: boolean;
+};
+export declare function documentIndexEntryHtml(source: Partial<WorkDocumentIndexEntry>): string;
+export declare function documentIndexHtml(source: Omit<WorkDocumentIndexValue, 'truncated'> & {
+    truncated?: boolean;
+}): string;
+export declare function documentIndexEntryFromElement(element: HTMLElement, index?: number): WorkDocumentIndexEntry | null;
+export declare function documentIndexValueFromElement(element: HTMLElement, index?: number): WorkDocumentIndexValue;
+export declare function normalizeDocumentIndexesHtml(source: string): string;
+export declare function indexLeader(value: unknown): WorkDocumentIndexLeader | null;

package/dist/internal/features/work/work-docx-import.d.ts

@@ -5,6 +5,7 @@ import { type ImportedDocxCitationMarkers } from './work-docx-citation-import';
 import { type ImportedDocxCommentMarkers } from './work-docx-comment-import';
 import { type ImportedDocxEquationMarkers } from './work-docx-equation-import';
 import { type ImportedDocxFieldMarkers } from './work-docx-field-import';
+import { type ImportedDocxIndexMarkers } from './work-docx-index-import';
 import { type ImportedDocxTableOfContentsMarkers } from './work-docx-table-of-contents-import';
 import { type ImportedDocxImageLayoutMarkers } from './work-docx-image-layout-import';
 import { type ImportedDocxListMarkers } from './work-docx-list-import';
@@ -38,6 +39,7 @@ export interface PreparedDocxImport {
     commentMarkers: ImportedDocxCommentMarkers;
     fieldMarkers: ImportedDocxFieldMarkers;
     tableOfContentsMarkers: ImportedDocxTableOfContentsMarkers;
+    indexMarkers: ImportedDocxIndexMarkers;
     equationMarkers: ImportedDocxEquationMarkers;
     citationMarkers: ImportedDocxCitationMarkers;
     listMarkers: ImportedDocxListMarkers;
@@ -60,6 +62,6 @@ export interface PreparedDocxImport {
     trackChanges: boolean;
 }
 export declare function prepareDocxImport(buffer: ArrayBuffer, sourcePackage?: OoxmlPackage): Promise<PreparedDocxImport>;
-export declare function applyDocxSectionsToHtml(html: string, sections: PreparedDocxImport['sections'], captionMarkers?: ImportedDocxCaptionMarkers, bookmarkMarkers?: ImportedDocxBookmarkMarkers, changeMarkers?: ImportedDocxChangeMarkers, commentMarkers?: ImportedDocxCommentMarkers, fieldMarkers?: ImportedDocxFieldMarkers, tableOfContentsMarkers?: ImportedDocxTableOfContentsMarkers, equationMarkers?: ImportedDocxEquationMarkers, citationMarkers?: ImportedDocxCitationMarkers, listMarkers?: ImportedDocxListMarkers, imageLayoutMarkers?: ImportedDocxImageLayoutMarkers, paragraphIdentityMarkers?: ImportedDocxParagraphIdentityMarkers, paragraphFormattingChangeMarkers?: ImportedDocxParagraphFormattingChangeMarkers, paragraphAlignmentMarkers?: ImportedDocxParagraphAlignmentMarkers, runFormattingMarkers?: ImportedDocxRunFormattingMarkers, paragraphDirectionMarkers?: ImportedDocxParagraphDirectionMarkers, paragraphIndentMarkers?: ImportedDocxParagraphIndentMarkers, paragraphSpacingMarkers?: ImportedDocxParagraphSpacingMarkers, paragraphBorderMarkers?: ImportedDocxParagraphBorderMarkers, paragraphShadingMarkers?: ImportedDocxParagraphShadingMarkers, paragraphPaginationMarkers?: ImportedDocxParagraphPaginationMarkers, bibliography?: WorkDocumentContent['bibliography'], tabStopMarkers?: ImportedDocxParagraphTabStopMarkers, tableCellMarkers?: ImportedDocxTableCellMarkers, tableRowMarkers?: ImportedDocxTableRowMarkers, tableSizingMarkers?: ImportedDocxTableSizingMarkers): string;
+export declare function applyDocxSectionsToHtml(html: string, sections: PreparedDocxImport['sections'], captionMarkers?: ImportedDocxCaptionMarkers, bookmarkMarkers?: ImportedDocxBookmarkMarkers, changeMarkers?: ImportedDocxChangeMarkers, commentMarkers?: ImportedDocxCommentMarkers, fieldMarkers?: ImportedDocxFieldMarkers, tableOfContentsMarkers?: ImportedDocxTableOfContentsMarkers, indexMarkers?: ImportedDocxIndexMarkers, equationMarkers?: ImportedDocxEquationMarkers, citationMarkers?: ImportedDocxCitationMarkers, listMarkers?: ImportedDocxListMarkers, imageLayoutMarkers?: ImportedDocxImageLayoutMarkers, paragraphIdentityMarkers?: ImportedDocxParagraphIdentityMarkers, paragraphFormattingChangeMarkers?: ImportedDocxParagraphFormattingChangeMarkers, paragraphAlignmentMarkers?: ImportedDocxParagraphAlignmentMarkers, runFormattingMarkers?: ImportedDocxRunFormattingMarkers, paragraphDirectionMarkers?: ImportedDocxParagraphDirectionMarkers, paragraphIndentMarkers?: ImportedDocxParagraphIndentMarkers, paragraphSpacingMarkers?: ImportedDocxParagraphSpacingMarkers, paragraphBorderMarkers?: ImportedDocxParagraphBorderMarkers, paragraphShadingMarkers?: ImportedDocxParagraphShadingMarkers, paragraphPaginationMarkers?: ImportedDocxParagraphPaginationMarkers, bibliography?: WorkDocumentContent['bibliography'], tabStopMarkers?: ImportedDocxParagraphTabStopMarkers, tableCellMarkers?: ImportedDocxTableCellMarkers, tableRowMarkers?: ImportedDocxTableRowMarkers, tableSizingMarkers?: ImportedDocxTableSizingMarkers): string;
 export declare function readDocxLayout(buffer: ArrayBuffer): Promise<ImportedDocumentLayout>;
 export {};

package/dist/internal/features/work/work-docx-index-export.d.ts

@@ -0,0 +1,14 @@
+import type { FileChild, ParagraphChild } from 'docx';
+import { type WorkDocumentIndexGeneratedEntry, type WorkDocumentIndexOptions } from './work-document-index';
+export interface DocxIndexPatch {
+    marker: string;
+    options: WorkDocumentIndexOptions;
+    entries: WorkDocumentIndexGeneratedEntry[];
+}
+export declare class DocxIndexPatchCollector {
+    readonly patches: DocxIndexPatch[];
+    add(element: HTMLElement): DocxIndexPatch;
+}
+export declare function docxDocumentIndex(element: HTMLElement, docx: typeof import('docx'), collector: DocxIndexPatchCollector): FileChild[];
+export declare function docxIndexEntryRun(element: HTMLElement, docx: typeof import('docx')): ParagraphChild | null;
+export declare function patchDocxIndexes(buffer: ArrayBuffer, patches: readonly DocxIndexPatch[]): Promise<ArrayBuffer>;

package/dist/internal/features/work/work-docx-index-import.d.ts

@@ -0,0 +1,23 @@
+import { type WorkDocumentIndexEntryDraft, type WorkDocumentIndexGeneratedEntry, type WorkDocumentIndexOptions } from './work-document-index';
+import { type DocxFieldOccurrence } from './work-docx-field-instructions';
+export interface ImportedDocxIndexMarkers {
+    entries: ImportedDocxIndexEntryMarker[];
+    indexes: ImportedDocxIndexMarker[];
+}
+export interface ImportedDocxIndexEntryMarker {
+    start: string;
+    end: string;
+    id: string;
+    value: WorkDocumentIndexEntryDraft;
+}
+export interface ImportedDocxIndexMarker {
+    marker: string;
+    id: string;
+    options: WorkDocumentIndexOptions;
+    entries: WorkDocumentIndexGeneratedEntry[];
+}
+export declare function markDocxIndexes(document: Document): ImportedDocxIndexMarkers;
+export declare function applyImportedDocxIndexMarkers(document: Document, markers: ImportedDocxIndexMarkers): void;
+export declare function hasImportedDocxIndexMarkers(markers: ImportedDocxIndexMarkers): boolean;
+export declare function supportedDocxIndexEntryField(field: DocxFieldOccurrence): boolean;
+export declare function supportedDocxIndexField(field: DocxFieldOccurrence): boolean;