@beyondwork/docx-react-component 1.0.45 → 1.0.46

package/README.md

@@ -708,7 +708,21 @@ Fired when a comment is resolved (via `resolveComment` or the sidebar).
 }
 ```
 
-There is no separate `comment_removed` event — deletions are silent. Query `getComments()` after a `dirty_changed` event if you need to detect deletions.
+For a general-purpose "something about comments changed" signal (covering deletions, reply appends, body edits, reopen, and every other mutation — including Yjs-driven mutations that route through the editor's imperative ref), subscribe to `comments_changed`.
+
+#### `comments_changed`
+
+Fired once per commit whenever the runtime's comment snapshot differs from the previous commit. Use this when you render comments in a sibling component and need to know when to re-fetch via `editorRef.current.getComments()`.
+
+```ts
+{
+  type: "comments_changed";
+  documentId: string;
+  changedCommentIds: string[]; // always non-empty
+}
+```
+
+Covers: `addComment`, `deleteComment`, `resolveComment`, `reopenComment`, `addCommentReply`, `editCommentBody`, and any remote-origin mutation that funnels through the same runtime APIs. Does NOT fire on selection/focus changes.
 
 #### `change_accepted`
 
@@ -944,6 +958,9 @@ function CommentButton({ editorRef }: { editorRef: React.RefObject<WordReviewEdi
       case "comment_resolved":
         console.log("comment resolved:", event.commentId);
         break;
+      case "comments_changed":
+        console.log("comments changed:", event.changedCommentIds);
+        break;
       case "change_accepted":
         console.log("change accepted:", event.changeId);
         break;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@beyondwork/docx-react-component",
   "publisher": "beyondwork",
-  "version": "1.0.45",
+  "version": "1.0.46",
   "description": "Embeddable React Word (docx) editor with review, comments, tracked changes, and round-trip OOXML fidelity.",
   "packageManager": "pnpm@10.30.3",
   "type": "module",

package/src/api/public-types.ts

@@ -2416,6 +2416,23 @@ export type WordReviewEditorEvent =
       documentId: string;
       commentId: string;
     }
+  | {
+      type: "comments_changed";
+      documentId: string;
+      /**
+       * Stable ids of the comment threads whose state differs between
+       * the previous and current runtime render snapshot. Includes
+       * additions, deletions, body edits, reply appends, and
+       * resolution-state transitions. Consumers can call
+       * `editorRef.current.getComments()` to obtain the full updated
+       * `CommentSidebarSnapshot`.
+       *
+       * The array is always non-empty when this event fires. When the
+       * snapshot's `comments` reference is unchanged between commits,
+       * no event fires.
+       */
+      changedCommentIds: string[];
+    }
   | {
       type: "change_accepted";
       documentId: string;

package/src/runtime/document-runtime.ts

@@ -3071,6 +3071,20 @@ export function createDocumentRuntime(
       });
     }
 
+    if (previous.document.review.comments !== next.document.review.comments) {
+      const changedCommentIds = diffCommentMapKeys(
+        previous.document.review.comments,
+        next.document.review.comments,
+      );
+      if (changedCommentIds.length > 0) {
+        emit({
+          type: "comments_changed",
+          documentId: next.documentId,
+          changedCommentIds,
+        });
+      }
+    }
+
     if (transaction.effects.changeAccepted) {
       emit({
         type: "change_accepted",
@@ -3988,6 +4002,27 @@ function createSelectionFromPublicAnchor(
   }
 }
 
+/**
+ * Collect the stable ids of comment threads whose entry differs
+ * (present in one side but not the other, OR present in both but
+ * referencing a different object — which indicates any mutation to
+ * the thread, since the runtime treats `review.comments` as
+ * immutable per commit). Used by the `comments_changed` event.
+ */
+function diffCommentMapKeys(
+  previous: CanonicalDocumentEnvelope["review"]["comments"],
+  next: CanonicalDocumentEnvelope["review"]["comments"],
+): string[] {
+  const changed = new Set<string>();
+  for (const id of Object.keys(previous)) {
+    if (previous[id] !== next[id]) changed.add(id);
+  }
+  for (const id of Object.keys(next)) {
+    if (previous[id] !== next[id]) changed.add(id);
+  }
+  return Array.from(changed);
+}
+
 function toPublicCompatibilityReport(
   report: InternalCompatibilityReport,
 ): CompatibilityReport {

package/src/runtime/event-refresh-hints.ts

@@ -43,6 +43,7 @@ export function describeEventImpact(
     case "suggestion_updated":
     case "comment_added":
     case "comment_resolved":
+    case "comments_changed":
       return {
         invalidate: [
           "render",

package/src/runtime/layout/docx-font-loader.ts

@@ -45,12 +45,35 @@ export interface DocxFontLoader {
   refresh(input: FontLoaderInput): void;
 }
 
+interface MinimalFontFace {
+  load(): Promise<MinimalFontFace>;
+}
+
+interface MinimalFontFaceDescriptors {
+  weight?: string;
+  style?: string;
+}
+
+interface MinimalFontFaceConstructor {
+  new (
+    family: string,
+    source: ArrayBuffer | ArrayBufferView | string,
+    descriptors?: MinimalFontFaceDescriptors,
+  ): MinimalFontFace;
+}
+
+interface MinimalFontFaceSet {
+  add(face: MinimalFontFace): void;
+  check(font: string): boolean;
+  ready: Promise<MinimalFontFaceSet>;
+}
+
 export function createDocxFontLoader(initial: FontLoaderInput): DocxFontLoader {
+  const globalDocument = (globalThis as unknown as { document?: { fonts?: unknown } }).document;
   const supported =
-    typeof document !== "undefined" &&
+    globalDocument !== undefined &&
     typeof (globalThis as { FontFace?: unknown }).FontFace !== "undefined" &&
-    // Guard against jsdom which exposes FontFace but not document.fonts
-    Boolean((document as Document & { fonts?: FontFaceSet }).fonts);
+    Boolean(globalDocument.fonts);
 
   let current: FontLoaderInput = initial;
   let readyPromise: Promise<void>;
@@ -58,7 +81,7 @@ export function createDocxFontLoader(initial: FontLoaderInput): DocxFontLoader {
 
   function run(input: FontLoaderInput): Promise<void> {
     if (!supported) return Promise.resolve();
-    const fontSet = (document as Document & { fonts?: FontFaceSet }).fonts;
+    const fontSet = globalDocument?.fonts as MinimalFontFaceSet | undefined;
     if (!fontSet) return Promise.resolve();
 
     const pending: Array<Promise<unknown>> = [];
@@ -70,10 +93,8 @@ export function createDocxFontLoader(initial: FontLoaderInput): DocxFontLoader {
 
         for (const [descriptor, data] of variantsOf(variants)) {
           try {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            const FontFaceCtor = (globalThis as any).FontFace as {
-              new (family: string, source: BufferSource, descriptors?: FontFaceDescriptors): FontFace;
-            };
+            const FontFaceCtor = (globalThis as { FontFace?: MinimalFontFaceConstructor }).FontFace;
+            if (!FontFaceCtor) continue;
             const face = new FontFaceCtor(family, data, descriptor);
             pending.push(
               face.load().then((loaded) => {
@@ -88,8 +109,6 @@ export function createDocxFontLoader(initial: FontLoaderInput): DocxFontLoader {
       }
     }
 
-    // Mark declared families as registered if the browser already resolves
-    // them (e.g. system fonts like Calibri, Arial).
     for (const family of input.families) {
       try {
         const probe = `12px "${family.replace(/"/g, "'")}", serif`;
@@ -127,7 +146,7 @@ export function createDocxFontLoader(initial: FontLoaderInput): DocxFontLoader {
 
 function* variantsOf(
   variants: EmbeddedFontBytes,
-): IterableIterator<[FontFaceDescriptors, ArrayBuffer]> {
+): IterableIterator<[MinimalFontFaceDescriptors, ArrayBuffer]> {
   if (variants.regular) {
     yield [{ weight: "400", style: "normal" }, variants.regular];
   }