@beyondwork/docx-react-component 1.0.19 → 1.0.21

package/src/ui/editor-command-bag.ts

@@ -0,0 +1,120 @@
+import { useMemo, useRef } from "react";
+
+import type {
+  CommentSidebarThreadSnapshot,
+  FormattingAlignment,
+  HeaderFooterLinkPatch,
+  InsertImageOptions,
+  SectionBreakType,
+  SectionLayoutPatch,
+  SectionPageNumberingPatch,
+  TrackedChangeEntrySnapshot,
+  ZoomLevel,
+  WorkspaceMode,
+} from "../api/public-types.ts";
+import type { ReviewRailTab } from "../ui-tailwind/review/tw-review-rail.tsx";
+
+type CommandHandler = (...args: any[]) => unknown;
+
+export interface EditorCommandBag {
+  onWorkspaceModeChange(value: WorkspaceMode): void;
+  onZoomChange?(level: ZoomLevel): void;
+  onActiveRailTabChange(value: ReviewRailTab): void;
+  onShowTrackedChangesChange(show: boolean): void;
+  onUndo(): void;
+  onRedo(): void;
+  onSetParagraphStyle?(styleId: string): void;
+  onToggleBold?(): void;
+  onToggleItalic?(): void;
+  onToggleUnderline?(): void;
+  onSetSelectionTextColor?(color: string): void;
+  onSetSelectionHighlightColor?(color: string | null): void;
+  onToggleStrikethrough?(): void;
+  onToggleSuperscript?(): void;
+  onToggleSubscript?(): void;
+  onSetFontFamily?(fontFamily: string): void;
+  onSetFontSize?(fontSize: number): void;
+  onSetTextColor?(color: string): void;
+  onSetHighlightColor?(color: string | null): void;
+  onSetAlignment?(alignment: FormattingAlignment): void;
+  onOutdent?(): void;
+  onIndent?(): void;
+  onAddComment(): void;
+  onInsertPageBreak?(): void;
+  onInsertTable?(): void;
+  onInsertSectionBreak?(type: SectionBreakType): void;
+  onInsertImage?(options: InsertImageOptions): void;
+  onSetTableStyle?(styleId: string): void;
+  onAddRowBefore?(): void;
+  onAddRowAfter?(): void;
+  onAddColumnBefore?(): void;
+  onAddColumnAfter?(): void;
+  onDeleteRow?(): void;
+  onDeleteColumn?(): void;
+  onDeleteTable?(): void;
+  onMergeCells?(): void;
+  onSplitCell?(): void;
+  onSetCellBackground?(color: string): void;
+  onSetImageLayout?(
+    mediaId: string,
+    dimensions: { widthEmu: number; heightEmu: number },
+  ): void;
+  onSetImageFrame?(
+    mediaId: string,
+    offsets: { horizontalOffsetEmu?: number; verticalOffsetEmu?: number },
+  ): void;
+  onDeleteSectionBreak?(sectionIndex: number): void;
+  onUpdateSectionLayout?(sectionIndex: number, patch: SectionLayoutPatch): void;
+  onSetSectionPageNumbering?(
+    sectionIndex: number,
+    patch: SectionPageNumberingPatch | null,
+  ): void;
+  onSetHeaderFooterLink?(
+    sectionIndex: number,
+    patch: HeaderFooterLinkPatch,
+  ): void;
+  onExport(): void;
+  onOpenComment(thread: CommentSidebarThreadSnapshot): void;
+  onResolveComment(commentId: string): void;
+  onReopenComment?(commentId: string): void;
+  onAddReply?(commentId: string, body: string): void;
+  onEditBody?(commentId: string, body: string): void;
+  onOpenRevision(revision: TrackedChangeEntrySnapshot): void;
+  onAcceptRevision(revisionId: string): void;
+  onRejectRevision(revisionId: string): void;
+  onAcceptAllChanges(): void;
+  onRejectAllChanges(): void;
+  onCloseStory?(): void;
+  onOpenHeaderStory?(): void;
+  onOpenFooterStory?(): void;
+  onSetParagraphIndentation?(indentation: {
+    left?: number;
+    right?: number;
+    firstLine?: number;
+    hanging?: number;
+  }): void;
+  onSetParagraphTabStops?(
+    tabStops: Array<{ pos: number; val?: string; leader?: string }>,
+  ): void;
+  onRestartNumbering?(): void;
+  onContinueNumbering?(): void;
+  onNavigateHeading?(headingId: string): void;
+}
+
+export function useCommandBag<T extends object>(commands: T): T {
+  const commandsRef = useRef(commands);
+  commandsRef.current = commands;
+
+  return useMemo(() => {
+    const stableBag: Partial<T> = {};
+
+    for (const key of Object.keys(commands) as Array<keyof T>) {
+      stableBag[key] = ((...args: unknown[]) => {
+        const handler = commandsRef.current[key] as CommandHandler | undefined;
+        return handler?.(...args);
+      }) as T[typeof key];
+    }
+
+    return stableBag as T;
+  }, []);
+}