@a3s-lab/office 0.2.2 → 0.4.0

package/dist/internal/features/work/editors/spreadsheet-format-painter.d.ts

@@ -0,0 +1,27 @@
+import type { Cell } from '@fortune-sheet/core';
+export declare const spreadsheetCellFormatAttributes: readonly ["bl", "it", "ff", "fs", "fc", "ht", "vt", "tb", "cl", "un", "tr", "ct", "bg"];
+export type SpreadsheetCellFormatAttribute = (typeof spreadsheetCellFormatAttributes)[number];
+export type SpreadsheetFormatPainterMode = 'once' | 'locked';
+export type SpreadsheetCellFormatSnapshot = Record<SpreadsheetCellFormatAttribute, unknown>;
+export interface SpreadsheetFormatPattern {
+    cells: readonly (readonly SpreadsheetCellFormatSnapshot[])[];
+    columnCount: number;
+    rowCount: number;
+}
+export interface SpreadsheetFormatPainterRange {
+    column: number[];
+    row: number[];
+}
+export interface SpreadsheetFormatPainterSheetBounds {
+    columnCount: number;
+    rowCount: number;
+}
+export interface SpreadsheetFormatPainterBatch {
+    attribute: SpreadsheetCellFormatAttribute;
+    ranges: SpreadsheetFormatPainterRange[];
+    value: unknown;
+}
+export declare function captureSpreadsheetFormatPattern(cells: readonly (readonly (Cell | null)[])[]): SpreadsheetFormatPattern | null;
+export declare function spreadsheetFormatPainterTargetRange(target: SpreadsheetFormatPainterRange, pattern: Pick<SpreadsheetFormatPattern, 'columnCount' | 'rowCount'>, bounds: SpreadsheetFormatPainterSheetBounds): SpreadsheetFormatPainterRange | null;
+export declare function spreadsheetFormatPainterCellCount(range: SpreadsheetFormatPainterRange): number;
+export declare function spreadsheetFormatPainterBatches(pattern: SpreadsheetFormatPattern, target: SpreadsheetFormatPainterRange): SpreadsheetFormatPainterBatch[];

package/dist/internal/features/work/editors/spreadsheet-freeze-panes.d.ts

@@ -0,0 +1,14 @@
+import { type Selection } from '@fortune-sheet/core';
+import type { WorkSpreadsheetContent, WorkSpreadsheetSheet } from '../work-types';
+export type SpreadsheetFreezePanePreset = 'selection' | 'topRow' | 'firstColumn' | 'none';
+type SpreadsheetFrozenPane = NonNullable<WorkSpreadsheetSheet['frozen']>;
+export interface SpreadsheetFreezePaneBoundary {
+    columns: number;
+    rows: number;
+}
+export declare function spreadsheetFreezePaneForSelection(selection: Selection): SpreadsheetFrozenPane | null;
+export declare function spreadsheetFreezePanesSelectionLabel(selection: Selection): string;
+export declare function spreadsheetFreezePaneBoundary(frozen: WorkSpreadsheetSheet['frozen']): SpreadsheetFreezePaneBoundary;
+export declare function spreadsheetFreezePanesStatus(frozen: WorkSpreadsheetSheet['frozen']): string;
+export declare function updateSpreadsheetFreezePanes(content: WorkSpreadsheetContent, sheetId: string, preset: SpreadsheetFreezePanePreset, selection: Selection): WorkSpreadsheetContent | null;
+export {};

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

@@ -1,7 +1,7 @@
 import type { Editor } from '@tiptap/core';
 import { type MutableRefObject, type ReactNode } from 'react';
 import type { WorkDocumentCaptionKind } from '../work-document-captions';
-import type { WorkDocumentFieldKind } from '../work-document-fields';
+import type { WorkDocumentFieldContextResolver, WorkDocumentFieldKind } from '../work-document-fields';
 import type { WorkDocumentNoteKind } from '../work-document-notes';
 import type { WorkDocumentContent } from '../work-types';
 export interface DocumentInsertCommands {
@@ -13,7 +13,8 @@ export interface DocumentInsertCommands {
     insertNote: (kind: WorkDocumentNoteKind) => boolean;
     refreshFields: () => boolean;
 }
-export declare function useDocumentInsertCommands({ contentRef, editor, }: {
+export declare function useDocumentInsertCommands({ contentRef, editor, resolveFieldContext, }: {
     contentRef: MutableRefObject<WorkDocumentContent>;
     editor: Editor | null;
+    resolveFieldContext?: WorkDocumentFieldContextResolver | null;
 }): DocumentInsertCommands;

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

@@ -1,9 +1,10 @@
 import type { Editor } from '@tiptap/core';
 import type { Node as ProseMirrorNode } from '@tiptap/pm/model';
 import type { OfficeKernelLayoutResult, OfficeKernelPageMetrics } from '../../../kernel/office-kernel-protocol';
+import type { WorkDocumentFieldContextResolver } from '../work-document-fields';
 import { type WorkDocumentLayoutFont } from '../work-document-fonts';
-import { type MeasuredDocumentLayoutBlock } from '../work-document-pagination';
 import { type ResolvedDocumentPageChrome } from '../work-document-page-chrome';
+import { type MeasuredDocumentLayoutBlock } from '../work-document-pagination';
 import type { WorkDocumentSectionLayout } from '../work-types';
 export interface DocumentPaginationResult {
     layout: OfficeKernelLayoutResult;
@@ -22,6 +23,7 @@ export interface DocumentPaginationPageDescriptor {
     sectionIndex: number;
     layout: WorkDocumentSectionLayout;
     pageChrome: ResolvedDocumentPageChrome;
+    page: OfficeKernelPageMetrics;
 }
 export interface DocumentPaginationPageDescriptorDerivation {
     pages: DocumentPaginationPageDescriptor[];
@@ -45,8 +47,11 @@ export interface UseDocumentPaginationValue {
     pageCount: number | null;
     pages: readonly DocumentPaginationPageDescriptor[];
     paginating: boolean;
+    resolveFieldContext: WorkDocumentFieldContextResolver | null;
 }
 export declare function useDocumentPagination({ editor, documentRevision, enabled, layoutKey, page, selectionVersion, wasmUrl, layoutFonts, loadedLayoutFontIds, }: UseDocumentPaginationOptions): UseDocumentPaginationValue;
+export declare function createDocumentFieldPaginationContextResolver(pagination: DocumentPaginationResult): WorkDocumentFieldContextResolver;
+export declare function documentResizeObservationPositions(blocks: readonly MeasuredDocumentLayoutBlock[]): ReadonlyMap<HTMLElement, number>;
 export declare function documentPaginationPageDescriptors(layout: OfficeKernelLayoutResult, blocks: readonly MeasuredDocumentLayoutBlock[], documentNode?: ProseMirrorNode): DocumentPaginationPageDescriptor[];
 export declare function deriveDocumentPaginationPageDescriptors(layout: OfficeKernelLayoutResult, blocks: readonly MeasuredDocumentLayoutBlock[], documentNode?: ProseMirrorNode, previousPages?: readonly DocumentPaginationPageDescriptor[], requestedReusedPageCount?: number): DocumentPaginationPageDescriptorDerivation;
 export declare function pageForPosition(pagination: DocumentPaginationResult, position: number): number;

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

@@ -0,0 +1,28 @@
+import type { Editor } from '@tiptap/core';
+import type { WorkDocumentEditorInput } from '../work-document-model';
+import { type WorkDocumentReviewConflict, type WorkDocumentReviewConflictEvent } from '../work-document-review-conflicts';
+import type { WorkDocumentContent } from '../work-types';
+interface MutableValue<T> {
+    current: T;
+}
+export interface UseDocumentReviewConflictsOptions {
+    activeConflictsRef: MutableValue<WorkDocumentReviewConflict[]>;
+    appliedSourceKeyRef: MutableValue<string>;
+    artifactId?: string;
+    content: WorkDocumentContent;
+    editor: Editor | null;
+    editorInput: WorkDocumentEditorInput;
+    normalizedContent: string;
+    onReviewConflict?: (event: WorkDocumentReviewConflictEvent) => void;
+    publishedDocumentRef: MutableValue<Editor['state']['doc'] | null>;
+    reconcileControlledUpdates?: boolean;
+}
+export declare function useDocumentReviewConflicts({ activeConflictsRef, appliedSourceKeyRef, artifactId, content, editor, editorInput, normalizedContent, onReviewConflict, publishedDocumentRef, reconcileControlledUpdates, }: UseDocumentReviewConflictsOptions): {
+    dismiss: () => void;
+    visibleConflicts: WorkDocumentReviewConflict[];
+};
+export declare function DocumentReviewConflictNotice({ conflicts, onDismiss, }: {
+    conflicts: readonly WorkDocumentReviewConflict[];
+    onDismiss: () => void;
+}): import("react").JSX.Element | null;
+export {};

package/dist/internal/features/work/editors/use-spreadsheet-auto-filter.d.ts

@@ -0,0 +1,21 @@
+import type { Selection } from '@fortune-sheet/core';
+import { type RefObject } from 'react';
+import type { WorkSpreadsheetContent } from '../work-types';
+import type { SpreadsheetAutoFilterCommandPort, SpreadsheetWorkbookCommandPort } from './spreadsheet-command-controller';
+export interface UseSpreadsheetAutoFilterOptions {
+    canvasRef: RefObject<HTMLElement | null>;
+    content: WorkSpreadsheetContent;
+    editable: boolean;
+    mountRevision?: number;
+    onChange: (content: WorkSpreadsheetContent) => void;
+    selection: Selection;
+    sheetId: string;
+    workbook?: Pick<SpreadsheetWorkbookCommandPort, 'getSelection'> | null;
+}
+export interface SpreadsheetAutoFilterController {
+    active: boolean;
+    commandPort: SpreadsheetAutoFilterCommandPort;
+    reserveAltKey: () => boolean;
+    status: string;
+}
+export declare function useSpreadsheetAutoFilter({ canvasRef, content, editable, mountRevision, onChange, selection, sheetId, workbook, }: UseSpreadsheetAutoFilterOptions): SpreadsheetAutoFilterController;

package/dist/internal/features/work/editors/use-spreadsheet-collaboration.d.ts

@@ -0,0 +1,27 @@
+import type { Selection } from '@fortune-sheet/core';
+import type { WorkOfficeCollaborationSession } from '../../../collaboration/office-collaboration';
+import type { WorkSpreadsheetContent } from '../work-types';
+export interface SpreadsheetCollaborationHistory {
+    canRedo: boolean;
+    canUndo: boolean;
+    redo: () => boolean;
+    undo: () => boolean;
+}
+export interface SpreadsheetCollaborationViewController {
+    activateSheet: (sheetId: string) => void;
+    select: (sheetId: string, selection: Selection) => void;
+    setZoom: (sheetId: string, zoomRatio: number) => void;
+}
+interface UseSpreadsheetCollaborationOptions {
+    initialContent: WorkSpreadsheetContent;
+    onChange: (content: WorkSpreadsheetContent) => void;
+    session: WorkOfficeCollaborationSession;
+}
+export declare function useSpreadsheetCollaboration({ initialContent, onChange, session, }: UseSpreadsheetCollaborationOptions): {
+    content: WorkSpreadsheetContent;
+    history: SpreadsheetCollaborationHistory;
+    onChange: (next: WorkSpreadsheetContent) => void;
+    readOnly: boolean;
+    view: SpreadsheetCollaborationViewController;
+};
+export {};

package/dist/internal/features/work/editors/use-spreadsheet-format-painter.d.ts

@@ -0,0 +1,18 @@
+import type { WorkSpreadsheetContent } from '../work-types';
+import type { SpreadsheetCommandRange, SpreadsheetFormatPainterCommandPort, SpreadsheetWorkbookCommandPort } from './spreadsheet-command-controller';
+import { type SpreadsheetFormatPainterMode } from './spreadsheet-format-painter';
+export type { SpreadsheetFormatPainterMode } from './spreadsheet-format-painter';
+export declare const spreadsheetFormatPainterMaximumCells = 50000;
+export interface UseSpreadsheetFormatPainterOptions {
+    content: WorkSpreadsheetContent;
+    editable: boolean;
+    onError: (message: string) => void;
+    sourceRange: SpreadsheetCommandRange;
+    sourceSheetId: string;
+    workbook: SpreadsheetWorkbookCommandPort | null;
+}
+export interface SpreadsheetFormatPainterController {
+    commandPort: SpreadsheetFormatPainterCommandPort;
+    mode: SpreadsheetFormatPainterMode | null;
+}
+export declare function useSpreadsheetFormatPainter({ content, editable, onError, sourceRange, sourceSheetId, workbook, }: UseSpreadsheetFormatPainterOptions): SpreadsheetFormatPainterController;

package/dist/internal/features/work/editors/work-office-chrome.d.ts

@@ -3,6 +3,7 @@ export interface WorkOfficeRibbonTab<T extends string> {
     id: T;
     label: string;
     compactLabel?: string;
+    contextual?: boolean;
 }
 export interface WorkOfficeFileAction {
     id: string;
@@ -13,7 +14,16 @@ export interface WorkOfficeFileAction {
     separatorBefore?: boolean;
     onSelect: () => void | Promise<void>;
 }
-export declare function WorkOfficeRibbon<T extends string>({ ariaLabel, tabs, defaultTab, activeTab, onTabChange, panels, fileActions, className, toolbarClassName, }: {
+export interface WorkOfficeQuickAccessAction {
+    id: string;
+    label: string;
+    icon: ReactNode;
+    shortcut?: string;
+    ariaKeyShortcuts?: string;
+    disabled?: boolean;
+    onSelect: () => void | Promise<void>;
+}
+export declare function WorkOfficeRibbon<T extends string>({ ariaLabel, tabs, defaultTab, activeTab, onTabChange, panels, fileActions, quickAccessActions, adaptive, collapsible, collapsed: controlledCollapsed, defaultCollapsed, onCollapsedChange, className, toolbarClassName, }: {
     ariaLabel: string;
     tabs: readonly WorkOfficeRibbonTab<T>[];
     defaultTab: T;
@@ -21,6 +31,12 @@ export declare function WorkOfficeRibbon<T extends string>({ ariaLabel, tabs, de
     onTabChange?: (tab: T) => void;
     panels: Record<T, ReactNode>;
     fileActions?: readonly WorkOfficeFileAction[];
+    quickAccessActions?: readonly WorkOfficeQuickAccessAction[];
+    adaptive?: boolean;
+    collapsible?: boolean;
+    collapsed?: boolean;
+    defaultCollapsed?: boolean;
+    onCollapsedChange?: (collapsed: boolean) => void;
     className?: string;
     toolbarClassName?: string;
 }): import("react").JSX.Element;
@@ -31,8 +47,9 @@ export declare function WorkOfficePreviewBar({ ariaLabel, label, detail, fileAct
     fileActions?: readonly WorkOfficeFileAction[];
     className?: string;
 }): import("react").JSX.Element;
-export declare function WorkOfficeRibbonGroup({ label, children, }: {
+export declare function WorkOfficeRibbonGroup({ label, priority, children, }: {
     label: string;
+    priority?: 'high' | 'normal' | 'low';
     children: ReactNode;
 }): import("react").JSX.Element;
 export declare function WorkOfficeRibbonButton({ label, visibleLabel, badge, active, displayLabel, className, title, children, ...props }: Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'aria-label' | 'children'> & {
@@ -43,9 +60,11 @@ export declare function WorkOfficeRibbonButton({ label, visibleLabel, badge, act
     displayLabel?: boolean;
     children: ReactNode;
 }): import("react").JSX.Element;
-export declare function WorkOfficeStatusBar({ children, controls, className, }: {
+export declare function WorkOfficeStatusBar({ ariaLabel, children, controls, controlsLabel, className, }: {
+    ariaLabel?: string;
     children: ReactNode;
     controls?: ReactNode;
+    controlsLabel?: string;
     className?: string;
 }): import("react").JSX.Element;
 export declare function WorkOfficeZoomControls({ zoom, minimum, maximum, step, decreaseLabel, increaseLabel, outputLabel, sliderLabel, onChange, }: {

package/dist/internal/features/work/editors/work-office-ribbon-overflow.d.ts

@@ -1,4 +1,6 @@
 export declare const WORK_OFFICE_RIBBON_SCROLL_INSET = 34;
+export type WorkOfficeRibbonDensity = 'comfortable' | 'compact-low' | 'compact-normal';
+export declare function calculateRibbonDensity(clientWidth: number): WorkOfficeRibbonDensity;
 export interface WorkOfficeRibbonItemGeometry {
     left: number;
     right: number;

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

@@ -0,0 +1,37 @@
+import type { Node as ProseMirrorNode } from '@tiptap/pm/model';
+import type { EditorState, Transaction } from '@tiptap/pm/state';
+export interface WorkDocumentBookmarkReferenceTarget {
+    type: 'bookmark';
+    id: string;
+    name: string;
+    title: string;
+    display: string;
+    instruction: string;
+}
+export interface WorkDocumentBookmarkReferenceRange {
+    id: string;
+    name: string;
+    from: number;
+    to: number;
+}
+export interface WorkDocumentBookmarkReferenceRename {
+    from: number;
+    to: number;
+    previousId: string;
+    nextId: string;
+    previousName: string;
+    nextName: string;
+}
+export declare function docxBookmarkReferenceTarget(instruction: string): string | null;
+export declare function supportedDocxBookmarkReferenceInstruction(instruction: string): boolean;
+export declare function documentBookmarkReferenceInstruction(name: string, source?: string): string;
+export declare function documentBookmarkReferenceDisplay(document: ProseMirrorNode, bookmark: Pick<WorkDocumentBookmarkReferenceRange, 'from' | 'to' | 'name'>): string;
+export declare function synchronizeDocumentBookmarkReferenceNodes(state: EditorState, transaction: Transaction, bookmarks: readonly WorkDocumentBookmarkReferenceRange[], renames: readonly WorkDocumentBookmarkReferenceRename[]): void;
+export declare function normalizeDocumentBookmarkReferencesHtml(source: string): string;
+export declare function retargetDomBookmarkReferences(root: HTMLElement, start: HTMLElement, end: HTMLElement, previous: {
+    id: string;
+    name: string;
+}, next: {
+    id: string;
+    name: string;
+}): void;

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

@@ -0,0 +1,29 @@
+import { type Editor, Node } from '@tiptap/core';
+import { type WorkDocumentBookmarkReferenceTarget } from './work-document-bookmark-references';
+export type WorkDocumentBookmarkBoundaryKind = 'start' | 'end';
+export interface WorkDocumentBookmark {
+    id: string;
+    name: string;
+    nativeId: number;
+    from: number;
+    to: number;
+}
+export declare const DOCUMENT_BOOKMARK_VALIDATION_MESSAGE = "\u4E66\u7B7E\u540D\u79F0\u9700\u4EE5\u5B57\u6BCD\u5F00\u5934\uFF0C\u53EA\u80FD\u5305\u542B\u5B57\u6BCD\u3001\u6570\u5B57\u548C\u4E0B\u5212\u7EBF\uFF0C\u4E14\u4E0D\u8D85\u8FC7 40 \u4E2A\u5B57\u7B26\u3002";
+export declare const DOCUMENT_BOOKMARK_DUPLICATE_MESSAGE = "\u6587\u6863\u4E2D\u5DF2\u5B58\u5728\u540C\u540D\u4E66\u7B7E\u3002";
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        documentBookmark: {
+            insertDocumentBookmark: (name: string) => ReturnType;
+            deleteDocumentBookmark: (id: string) => ReturnType;
+        };
+    }
+}
+export declare const DocumentBookmarkBoundary: Node<any, any>;
+export declare function validateDocumentBookmarkName(value: string): string | null;
+export declare function normalizeDocumentBookmarkName(value: unknown): string | null;
+export declare function normalizeDocumentBookmarkNativeId(value: unknown): number | null;
+export declare function editorDocumentBookmarks(editor: Editor): WorkDocumentBookmark[];
+export declare function editorDocumentBookmarkReferenceTargets(editor: Editor): WorkDocumentBookmarkReferenceTarget[];
+export declare function activeDocumentBookmark(editor: Editor): WorkDocumentBookmark | null;
+export declare function documentBookmarkNameExists(editor: Editor, value: string, exceptId?: string): boolean;
+export declare function normalizeDocumentBookmarksHtml(source: string): string;

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

@@ -1,13 +1,16 @@
 import { type Editor, Node } from '@tiptap/core';
+import type { WorkDocumentBookmarkReferenceTarget } from './work-document-bookmark-references';
 import { type WorkDocumentCaptionKind, type WorkDocumentCaptionTarget } from './work-document-captions';
+type WorkDocumentCrossReferenceTarget = WorkDocumentCaptionTarget | WorkDocumentBookmarkReferenceTarget;
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         documentCaption: {
             insertDocumentCaption: (kind: WorkDocumentCaptionKind, title: string) => ReturnType;
-            insertDocumentCrossReference: (target: WorkDocumentCaptionTarget) => ReturnType;
+            insertDocumentCrossReference: (target: WorkDocumentCrossReferenceTarget) => ReturnType;
         };
     }
 }
 export declare const DocumentCaption: Node<any, any>;
 export declare const DocumentCrossReference: Node<any, any>;
 export declare function editorDocumentCaptionTargets(editor: Editor): WorkDocumentCaptionTarget[];
+export {};

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

@@ -40,7 +40,7 @@ export declare function canInsertDocumentComment(editor: Editor, range?: WorkDoc
 export declare function documentCommentDraftRange(editor: Editor): WorkDocumentCommentRange | null;
 export declare function collectDocumentCommentAnchors(document: ProseMirrorNode): WorkDocumentCommentAnchor[];
 export declare function documentCommentViews(comments: readonly WorkDocumentComment[], anchors: readonly WorkDocumentCommentAnchor[]): WorkDocumentCommentView[];
-export declare function retainAnchoredDocumentComments(comments: readonly WorkDocumentComment[], anchors: readonly WorkDocumentCommentAnchor[]): WorkDocumentComment[];
+export declare function retainAnchoredDocumentComments(comments: readonly WorkDocumentComment[], anchors: readonly WorkDocumentCommentAnchor[], retainedIds?: ReadonlySet<string>): WorkDocumentComment[];
 export declare function appendDocumentCommentReply(comments: readonly WorkDocumentComment[], id: string, reply: WorkDocumentCommentReply): WorkDocumentComment[];
 export declare function toggleDocumentCommentResolved(comments: readonly WorkDocumentComment[], id: string): WorkDocumentComment[];
 export declare function removeDocumentCommentRecord(comments: readonly WorkDocumentComment[], id: string): WorkDocumentComment[];