@beyondwork/docx-react-component 1.0.28 → 1.0.30

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

@@ -37,6 +37,8 @@ export interface EditorCommandBag {
   onSetTextColor?(color: string): void;
   onSetHighlightColor?(color: string | null): void;
   onSetAlignment?(alignment: FormattingAlignment): void;
+  onToggleBulletedList?(): void;
+  onToggleNumberedList?(): void;
   onOutdent?(): void;
   onIndent?(): void;
   onAddComment(): void;
@@ -98,6 +100,11 @@ export interface EditorCommandBag {
   ): void;
   onRestartNumbering?(): void;
   onContinueNumbering?(): void;
+  onUpdateFields?(): void;
+  onUpdateTableOfContents?(): void;
+  onGoToPreviousReviewItem?(): void;
+  onGoToNextReviewItem?(): void;
+  onMarkSectionForReview?(): string | null;
   onNavigateHeading?(headingId: string): void;
 }
 

package/src/ui/editor-runtime-boundary.ts

@@ -1,4 +1,4 @@
-import React, { useEffect, useMemo, useRef, useState } from "react";
+import React, { useEffect, useLayoutEffect, useMemo, useRef, useState } from "react";
 
 import type {
   AutosaveState,
@@ -15,6 +15,7 @@ import type {
   FieldSnapshot,
   PersistedEditorSnapshot,
   RuntimeRenderSnapshot,
+  SuggestionsSnapshot,
   TocRefreshResult,
   UpdateFieldsResult,
   ViewMode as EditorViewMode,
@@ -30,6 +31,7 @@ import {
 import { createCanonicalDocumentId } from "../core/state/editor-state.ts";
 import {
   createDocumentRuntime,
+  type DocumentRuntimeEvent,
   type DocumentRuntime,
 } from "../runtime/document-runtime.ts";
 import { loadDocxEditorSession } from "../io/docx-session.ts";
@@ -80,6 +82,7 @@ export interface WordReviewEditorRuntime extends DocumentRuntime {
   getFatalError?(): EditorError | undefined;
   dispose?(): void;
   setDefaultAuthorId?(authorId?: string): void;
+  drainBootstrapEvents?(): DocumentRuntimeEvent[];
   emitBlockedCommand(
     command: string,
     reasons: Extract<WordReviewEditorEvent, { type: "command_blocked" }>["reasons"],
@@ -267,6 +270,7 @@ export function useEditorRuntimeBoundary(
   const [runtime, setRuntime] = useState<WordReviewEditorRuntime | null>(null);
   const [loadError, setLoadError] = useState<EditorError | null>(null);
   const runtimeRef = useRef<WordReviewEditorRuntime | null>(null);
+  const pendingReadySourceRef = useRef<"docx" | "session" | "snapshot" | null>(null);
   const autosaveTimerRef = useRef<ReturnType<typeof setTimeout> | null>(null);
   const lastSavedRevisionTokenRef = useRef<string | null>(null);
   const hostAdapterRef = useRef(hostAdapter);
@@ -274,6 +278,7 @@ export function useEditorRuntimeBoundary(
   const onEventRef = useRef(onEvent);
   const onWarningRef = useRef(onWarning);
   const onErrorRef = useRef(onError);
+  const currentUserIdRef = useRef(currentUser.userId);
   const runtimeViewStateSeedRef = useRef<{
     workspaceMode: WorkspaceMode;
     zoomLevel: ZoomLevel;
@@ -299,6 +304,8 @@ export function useEditorRuntimeBoundary(
     };
   }
 
+  currentUserIdRef.current = currentUser.userId;
+
   const stableInitialSource = initialSourceRef.current;
   const sourceReloadKey = externalDocSource
     ? `external:${externalDocSource.kind}:${externalDocumentRevision ?? "static"}`
@@ -320,7 +327,7 @@ export function useEditorRuntimeBoundary(
     onErrorRef.current = onError;
   }, [datastore, hostAdapter, onError, onEvent, onWarning]);
 
-  useEffect(() => {
+  useLayoutEffect(() => {
     runtimeRef.current?.setDefaultAuthorId?.(currentUser.userId);
   }, [currentUser.userId]);
 
@@ -329,6 +336,15 @@ export function useEditorRuntimeBoundary(
 
     async function loadRuntime(): Promise<void> {
       setLoadError(null);
+      pendingReadySourceRef.current = null;
+      if (autosaveTimerRef.current) {
+        clearTimeout(autosaveTimerRef.current);
+        autosaveTimerRef.current = null;
+      }
+      lastSavedRevisionTokenRef.current = null;
+      runtimeRef.current?.dispose?.();
+      runtimeRef.current = null;
+      setRuntime(null);
 
       try {
         const source = await __resolveWordReviewEditorSource({
@@ -348,7 +364,6 @@ export function useEditorRuntimeBoundary(
           return;
         }
 
-        runtimeRef.current?.dispose?.();
         const nextRuntime = createRuntime(
           {
             documentId,
@@ -357,7 +372,7 @@ export function useEditorRuntimeBoundary(
             initialViewState: runtimeViewStateSeedRef.current,
             hostAdapter: hostAdapterRef.current,
             datastore: datastoreRef.current,
-            currentUserId: currentUser.userId,
+            currentUserId: currentUserIdRef.current,
           },
           {
             onWarning: onWarningRef.current,
@@ -366,13 +381,8 @@ export function useEditorRuntimeBoundary(
           },
         );
         recordPerfSample("runtime.create");
-        emitEditorEvent({
-          hostAdapter: hostAdapterRef.current,
-          datastore: datastoreRef.current,
-          onEvent: onEventRef.current,
-          event: createReadyEvent(nextRuntime, source.source),
-        });
         runtimeRef.current = nextRuntime;
+        pendingReadySourceRef.current = source.source;
         setRuntime(nextRuntime);
       } catch (error) {
         if (cancelled) {
@@ -406,6 +416,32 @@ export function useEditorRuntimeBoundary(
     sourceReloadKey,
   ]);
 
+  useEffect(() => {
+    if (!runtime || !pendingReadySourceRef.current) {
+      return;
+    }
+
+    emitEditorEvent({
+      hostAdapter: hostAdapterRef.current,
+      datastore: datastoreRef.current,
+      onEvent: onEventRef.current,
+      event: createReadyEvent(runtime, pendingReadySourceRef.current),
+    });
+    for (const event of runtime.drainBootstrapEvents?.() ?? []) {
+      if (event.type === "ready") {
+        continue;
+      }
+      const hostEvent = event as Exclude<WordReviewEditorEvent, { type: "ready" }>;
+      emitEditorEvent({
+        hostAdapter: hostAdapterRef.current,
+        datastore: datastoreRef.current,
+        onEvent: onEventRef.current,
+        event: hostEvent,
+      });
+    }
+    pendingReadySourceRef.current = null;
+  }, [runtime]);
+
   useEffect(() => {
     if (!runtime?.subscribeToEvents) {
       return;
@@ -518,6 +554,7 @@ function createRuntime(
   args: CreateRuntimeArgs,
   handlers: RuntimeLifecycleHandlers = {},
 ): WordReviewEditorRuntime {
+  const bootstrapEvents: DocumentRuntimeEvent[] = [];
   const docxSession = args.source.initialDocx
     ? loadDocxEditorSession({
         documentId: args.documentId,
@@ -574,8 +611,12 @@ function createRuntime(
     },
     onWarning: handlers.onWarning,
     onError: handlers.onError,
+    onEvent: (event) => {
+      bootstrapEvents.push(event);
+    },
     defaultAuthorId: args.currentUserId,
   }), {
+    drainBootstrapEvents: () => bootstrapEvents.splice(0, bootstrapEvents.length),
     emitBlockedCommand: (
       command: string,
       reasons: Extract<WordReviewEditorEvent, { type: "command_blocked" }>["reasons"],
@@ -712,6 +753,16 @@ function createLoadingRuntimeBridge(input: {
     entryCount: 0,
     entries: [],
   };
+  const emptySuggestions: SuggestionsSnapshot = {
+    totalCount: 0,
+    actionableSuggestionIds: [],
+    preserveOnlySuggestionIds: [],
+    activeSuggestionIds: [],
+    acceptedSuggestionIds: [],
+    rejectedSuggestionIds: [],
+    detachedSuggestionIds: [],
+    suggestions: [],
+  };
 
   return {
     subscribe: () => () => undefined,
@@ -750,6 +801,25 @@ function createLoadingRuntimeBridge(input: {
     setZoom: () => undefined,
     getPageLayoutSnapshot: () => null,
     getDocumentNavigationSnapshot: () => input.navigation,
+    getCurrentLocation: () => null,
+    getLocationForSelection: () => null,
+    getLocationForAnchor: () => null,
+    captureRestorePoint: () => null,
+    restoreToPoint: () => ({
+      status: "detached",
+      reasons: ["loading"],
+    }),
+    getOutlineSnapshot: () => ({
+      headings: [],
+    }),
+    getTocSnapshot: () => null,
+    getSections: () => [],
+    getSectionSnapshot: () => null,
+    describeEventImpact: () => ({
+      invalidate: ["render"],
+      staleTargets: ["none"],
+      changeKinds: ["content"],
+    }),
     getFieldSnapshot: () => emptyFieldSnapshot,
     updateFields: () => emptyFieldResult,
     updateTableOfContents: () => emptyTocResult,
@@ -768,6 +838,7 @@ function createLoadingRuntimeBridge(input: {
       errors: input.snapshot.fatalError ? [input.snapshot.fatalError] : [],
     }),
     getWarnings: () => input.snapshot.warnings,
+    getSuggestionsSnapshot: () => emptySuggestions,
     exportDocx: () =>
       Promise.reject(createLoadingBoundaryError(input.snapshot.documentId, "export")),
     setWorkflowOverlay: () => undefined,
@@ -778,12 +849,21 @@ function createLoadingRuntimeBridge(input: {
       totalCount: 0,
       items: [],
       highlights: [],
+      metadata: [],
       comments: [],
       revisions: [],
       fields: [],
       protectedRanges: [],
       opaqueFragments: [],
     }),
+    setWorkflowMetadataDefinitions: () => undefined,
+    clearWorkflowMetadataDefinitions: () => undefined,
+    setWorkflowMetadataEntries: () => undefined,
+    clearWorkflowMetadataEntries: () => undefined,
+    getWorkflowMetadataSnapshot: () => ({
+      definitions: [],
+      entries: [],
+    }),
     setHostAnnotationOverlay: () => undefined,
     clearHostAnnotationOverlay: () => undefined,
     getHostAnnotationSnapshot: () => ({
@@ -792,6 +872,16 @@ function createLoadingRuntimeBridge(input: {
     }),
     getWorkflowCandidateRanges: () => [],
     replaceWorkflowMarkupText: () => undefined,
+    getDocumentTextStream: () => [],
+    getStoryTextStream: () => null,
+    getDocumentChunks: () => [],
+    getWorkflowChunks: () => [],
+    getReviewWorkSnapshot: () => ({
+      openCommentCount: 0,
+      actionableRevisionCount: 0,
+      items: [],
+    }),
+    getRuntimeContextAnalytics: () => null,
   };
 }
 
@@ -851,6 +941,10 @@ export async function persistAndExport(input: {
     input.autosaveTimerRef.current = null;
   }
 
+  const revisionToken = input.runtime.getRenderSnapshot().revisionToken;
+  const previousSavedRevisionToken = input.lastSavedRevisionTokenRef.current;
+  input.lastSavedRevisionTokenRef.current = revisionToken;
+
   await persistSession({
     hostAdapter: input.hostAdapter,
     datastore: input.datastore,
@@ -860,6 +954,9 @@ export async function persistAndExport(input: {
     onError: input.onError,
     onEvent: input.onEvent,
     lastSavedRevisionTokenRef: input.lastSavedRevisionTokenRef,
+  }).catch((error) => {
+    input.lastSavedRevisionTokenRef.current = previousSavedRevisionToken;
+    throw error;
   });
 
   let result: ExportResult;
@@ -993,6 +1090,10 @@ export async function persistSession(input: {
   const snapshot = input.runtime.getPersistedSnapshot();
   const revisionToken = input.runtime.getRenderSnapshot().revisionToken;
 
+  if (input.isAutosave && input.lastSavedRevisionTokenRef.current === revisionToken) {
+    return;
+  }
+
   if (input.isAutosave) {
     emitEditorEvent({
       hostAdapter: input.hostAdapter,

package/src/ui/editor-shell-view.tsx

@@ -1,12 +1,17 @@
 import React, { type CSSProperties, type ReactNode } from "react";
 
 import type {
+  ActiveListContext,
   DocumentNavigationSnapshot,
   EditorError,
   FormattingStateSnapshot,
   InteractionGuardSnapshot,
+  ReviewQueueSnapshot,
+  RuntimeContextAnalyticsSnapshot,
   RuntimeRenderSnapshot,
   StyleCatalogSnapshot,
+  WordReviewEditorChromeOptions,
+  WordReviewEditorChromePreset,
   WordReviewEditorChromeVisibility,
   WorkflowScopeSnapshot,
   WorkspaceMode,
@@ -15,19 +20,12 @@ import type {
 import type { SessionCapabilities } from "../runtime/session-capabilities.ts";
 import type { MarkupDisplay } from "./headless/comment-decoration-model.ts";
 import type {
-  SelectionToolbarAnchor,
-  SelectionToolbarModel,
-  SuggestionCardModel,
-} from "./headless/selection-toolbar-model.ts";
+  ActiveSelectionToolModel,
+  SelectionToolAnchor,
+} from "./headless/selection-tool-types.ts";
 import type { EditorCommandBag } from "./editor-command-bag.ts";
 import type { ReviewRailTab } from "../ui-tailwind/review/tw-review-rail.tsx";
 import { TwReviewWorkspace } from "../ui-tailwind/tw-review-workspace.tsx";
-import type {
-  ActiveImageContext,
-} from "../ui-tailwind/chrome/tw-image-context-toolbar.tsx";
-import type {
-  ActiveObjectContext,
-} from "../ui-tailwind/chrome/tw-object-context-toolbar.tsx";
 import type { EditorViewStateSnapshot } from "../api/public-types.ts";
 
 export interface EditorShellViewProps {
@@ -50,6 +48,7 @@ export interface EditorShellViewProps {
   workspaceMode: WorkspaceMode;
   zoomLevel?: ZoomLevel;
   formattingState?: FormattingStateSnapshot;
+  activeListContext?: ActiveListContext | null;
   styleCatalog?: StyleCatalogSnapshot;
   activeRailTab: ReviewRailTab;
   activeCommentId?: string;
@@ -57,9 +56,14 @@ export interface EditorShellViewProps {
   showTrackedChanges: boolean;
   workflowScopeSnapshot?: WorkflowScopeSnapshot | null;
   interactionGuardSnapshot?: InteractionGuardSnapshot;
-  selectionToolbar?: SelectionToolbarModel | null;
-  suggestionCard?: SuggestionCardModel | null;
-  selectionToolbarAnchor?: SelectionToolbarAnchor | null;
+  chromePreset?: WordReviewEditorChromePreset;
+  chromeOptions?: Partial<WordReviewEditorChromeOptions>;
+  reviewQueue?: ReviewQueueSnapshot;
+  documentContextAnalytics?: RuntimeContextAnalyticsSnapshot | null;
+  selectionContextAnalytics?: RuntimeContextAnalyticsSnapshot | null;
+  currentScopeContextAnalytics?: RuntimeContextAnalyticsSnapshot | null;
+  activeSelectionTool?: ActiveSelectionToolModel | null;
+  selectionToolAnchor?: SelectionToolAnchor | null;
   documentNavigation?: DocumentNavigationSnapshot;
   commands: EditorCommandBag;
   document: ReactNode;
@@ -72,8 +76,6 @@ export interface EditorShellViewProps {
   onSelectionToolbarFocusCapture?: React.FocusEventHandler<HTMLDivElement>;
   onSelectionToolbarBlurCapture?: React.FocusEventHandler<HTMLDivElement>;
   selectionToolbarRef?: React.Ref<HTMLDivElement>;
-  activeImageContext?: ActiveImageContext | null;
-  activeObjectContext?: ActiveObjectContext | null;
   chromeVisibility?: Partial<WordReviewEditorChromeVisibility>;
 }
 

package/src/ui/editor-surface-controller.tsx

@@ -7,11 +7,13 @@ import type {
   SelectionSnapshot,
   WorkflowBlockedCommandReason,
   WorkflowCandidateRange,
+  WorkflowMetadataMarkup,
   WorkflowScope,
 } from "../api/public-types.ts";
 import type { CanonicalDocumentEnvelope } from "../core/state/editor-state.ts";
 import type { MarkupDisplay } from "./headless/comment-decoration-model.ts";
 import type { SelectionToolbarAnchor } from "./headless/selection-toolbar-model.ts";
+import type { ActiveSelectionToolModel } from "./headless/selection-tool-types.ts";
 import {
   TwProseMirrorSurface,
   type TwProseMirrorSurfaceRef,
@@ -25,7 +27,9 @@ export interface EditorSurfaceControllerProps {
   documentNavigation: DocumentNavigationSnapshot;
   reviewMode: "editing" | "review";
   markupDisplay: MarkupDisplay;
+  showUnsupportedObjectPreviews?: boolean;
   activeRevisionId?: string;
+  activeSelectionToolKind?: ActiveSelectionToolModel["kind"] | null;
   showTrackedChanges?: boolean;
   suggestionsEnabled?: boolean;
   mediaPreviews?: Record<string, MediaPreviewDescriptor>;
@@ -51,6 +55,7 @@ export interface EditorSurfaceControllerProps {
   workflowBlockedReasons?: readonly WorkflowBlockedCommandReason[];
   activeWorkflowWorkItemId?: string | null;
   activeWorkflowScopeIds?: readonly string[];
+  workflowMetadata?: readonly WorkflowMetadataMarkup[];
 }
 
 export const EditorSurfaceController = forwardRef<

package/src/ui/headless/selection-tool-context.ts

@@ -0,0 +1,19 @@
+import type {
+  DocumentNavigationSnapshot,
+  EditorViewStateSnapshot,
+  RuntimeRenderSnapshot,
+  StyleCatalogSnapshot,
+} from "../../api/public-types";
+import type { SessionCapabilities } from "../../runtime/session-capabilities";
+import type { SelectionToolResolverContext } from "./selection-tool-types";
+
+export interface SelectionToolResolverInput extends SelectionToolResolverContext {
+  snapshot: RuntimeRenderSnapshot;
+  viewState: EditorViewStateSnapshot;
+  capabilities: SessionCapabilities;
+  documentNavigation: DocumentNavigationSnapshot;
+  styleCatalog: StyleCatalogSnapshot;
+  preferListStructureContext?: boolean;
+  addCommentDisabledReason?: string;
+  suppressedSuggestionRevisionId?: string | null;
+}