@beyondwork/docx-react-component 1.0.21 → 1.0.23

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "@beyondwork/docx-react-component",
   "publisher": "beyondwork",
-  "version": "1.0.21",
+  "version": "1.0.23",
   "description": "Embeddable React Word (docx) editor with review, comments, tracked changes, and round-trip OOXML fidelity.",
-  "packageManager": "pnpm@10.30.3",
   "type": "module",
   "sideEffects": [
     "**/*.css"
@@ -89,30 +88,6 @@
     "./ui-tailwind/theme/editor-theme.css": "./src/ui-tailwind/theme/editor-theme.css"
   },
   "types": "./src/index.ts",
-  "scripts": {
-    "build": "tsup",
-    "test": "bash scripts/run-workspace-tests.sh",
-    "test:repo": "node scripts/run-repo-tests.mjs core",
-    "test:repo:all": "node scripts/run-repo-tests.mjs all",
-    "test:repo:optional": "node scripts/run-repo-tests.mjs optional",
-    "test:wcag-audit": "node scripts/run-repo-tests.mjs wcag-audit",
-    "test:harness": "pnpm --filter @docx-react-component/react-word-editor-harness test",
-    "lint": "pnpm run lint:no-authored-js && pnpm run lint:docs-contracts && pnpm run lint:tsgo && pnpm run lint:tsgo:harness",
-    "lint:docs-contracts": "bash scripts/check-reference-load-contract.sh",
-    "lint:no-authored-js": "bash scripts/check-no-authored-js.sh",
-    "lint:tsgo": "tsgo --noEmit -p tsconfig.build.json",
-    "lint:tsgo:harness": "pnpm --filter @docx-react-component/react-word-editor-harness lint:tsgo",
-    "context7:api-check": "bash scripts/context7-export-env.sh run bash scripts/context7-api-check.sh",
-    "wave:doctor": "bash scripts/context7-export-env.sh run pnpm exec wave doctor --json",
-    "wave:dry-run": "bash scripts/context7-export-env.sh run pnpm exec wave launch --lane main --dry-run --no-dashboard",
-    "wave:launch": "bash scripts/context7-export-env.sh run pnpm exec wave launch --lane main",
-    "wave:launch:managed": "bash scripts/wave-launch.sh",
-    "wave:status": "bash scripts/wave-status.sh",
-    "wave:watch": "bash scripts/wave-watch.sh --follow",
-    "wave:dashboard:current": "bash scripts/wave-dashboard-attach.sh current",
-    "wave:dashboard:global": "bash scripts/wave-dashboard-attach.sh global",
-    "harness:dev": "pnpm --filter @docx-react-component/react-word-editor-harness dev"
-  },
   "keywords": [
     "docx",
     "word",
@@ -175,14 +150,28 @@
     "tsup": "^8.3.0",
     "tsx": "^4.21.0"
   },
-  "pnpm": {
-    "onlyBuiltDependencies": [
-      "esbuild",
-      "sharp"
-    ],
-    "overrides": {
-      "react": "19.2.4",
-      "react-dom": "19.2.4"
-    }
+  "scripts": {
+    "build": "tsup",
+    "test": "bash scripts/run-workspace-tests.sh",
+    "test:repo": "node scripts/run-repo-tests.mjs core",
+    "test:repo:all": "node scripts/run-repo-tests.mjs all",
+    "test:repo:optional": "node scripts/run-repo-tests.mjs optional",
+    "test:wcag-audit": "node scripts/run-repo-tests.mjs wcag-audit",
+    "test:harness": "pnpm --filter @docx-react-component/react-word-editor-harness test",
+    "lint": "pnpm run lint:no-authored-js && pnpm run lint:docs-contracts && pnpm run lint:tsgo && pnpm run lint:tsgo:harness",
+    "lint:docs-contracts": "bash scripts/check-reference-load-contract.sh",
+    "lint:no-authored-js": "bash scripts/check-no-authored-js.sh",
+    "lint:tsgo": "tsgo --noEmit -p tsconfig.build.json",
+    "lint:tsgo:harness": "pnpm --filter @docx-react-component/react-word-editor-harness lint:tsgo",
+    "context7:api-check": "bash scripts/context7-export-env.sh run bash scripts/context7-api-check.sh",
+    "wave:doctor": "bash scripts/context7-export-env.sh run pnpm exec wave doctor --json",
+    "wave:dry-run": "bash scripts/context7-export-env.sh run pnpm exec wave launch --lane main --dry-run --no-dashboard",
+    "wave:launch": "bash scripts/context7-export-env.sh run pnpm exec wave launch --lane main",
+    "wave:launch:managed": "bash scripts/wave-launch.sh",
+    "wave:status": "bash scripts/wave-status.sh",
+    "wave:watch": "bash scripts/wave-watch.sh --follow",
+    "wave:dashboard:current": "bash scripts/wave-dashboard-attach.sh current",
+    "wave:dashboard:global": "bash scripts/wave-dashboard-attach.sh global",
+    "harness:dev": "pnpm --filter @docx-react-component/react-word-editor-harness dev"
   }
-}
+}

package/src/api/public-types.ts

@@ -235,6 +235,7 @@ export interface TrackedChangeEntrySnapshot {
   label: string;
   status: "active" | "accepted" | "rejected" | "detached";
   actionability: "actionable" | "preserve-only";
+  storyTarget?: EditorStoryTarget;
   importedRevisionForm?:
     | "run-insertion"
     | "run-deletion"
@@ -552,6 +553,8 @@ export interface SurfaceTableCellSnapshot {
 
 export interface SurfaceTableRowSnapshot {
   cells: SurfaceTableCellSnapshot[];
+  gridBefore?: number;
+  gridAfter?: number;
   height?: number;
   heightRule?: "auto" | "atLeast" | "exact";
   isHeader?: boolean;
@@ -954,7 +957,8 @@ export interface WorkflowBlockedCommandReason {
     | "document_read_only"
     | "document_viewing_mode"
     | "protected_range"
-    | "unsupported_surface";
+    | "unsupported_surface"
+    | "suggesting_unsupported";
   message: string;
   scopeId?: string;
   workItemId?: string;
@@ -971,7 +975,13 @@ export interface WorkflowScopeSnapshot {
   blockedReasons: WorkflowBlockedCommandReason[];
 }
 
+export type EffectiveSelectionMode = WorkflowScopeMode | "blocked";
+
 export interface InteractionGuardSnapshot {
+  effectiveMode: EffectiveSelectionMode;
+  matchedScopeId?: string;
+  matchedScopeMode?: WorkflowScopeMode;
+  disabledReason?: string;
   blockedReasons: WorkflowBlockedCommandReason[];
 }
 
@@ -1064,6 +1074,36 @@ export interface WorkflowMarkupSnapshot {
   opaqueFragments: WorkflowOpaqueFragmentMarkup[];
 }
 
+export type HostAnnotationKind =
+  | "note"
+  | "scope_hint"
+  | "readonly_marker"
+  | "suggestion"
+  | "warning";
+
+export interface HostAnnotationItem {
+  annotationId: string;
+  kind: HostAnnotationKind;
+  label: string;
+  anchor: EditorAnchorProjection;
+  storyTarget?: EditorStoryTarget;
+  detail?: string;
+  scopeMode?: WorkflowScopeMode;
+  severity?: "low" | "medium" | "high";
+  workItemId?: string;
+  provenance: "host";
+}
+
+export interface HostAnnotationOverlay {
+  overlayVersion: "host-annotation-overlay/1";
+  annotations: HostAnnotationItem[];
+}
+
+export interface HostAnnotationSnapshot {
+  totalCount: number;
+  annotations: HostAnnotationItem[];
+}
+
 export interface WorkflowCandidateRangeOptions {
   kinds?: WorkflowMarkupKind[];
   includeDetached?: boolean;
@@ -1177,6 +1217,17 @@ export type WordReviewEditorEvent =
       documentId: string;
       activeWorkItemId: string | null;
     }
+  | {
+      type: "host_annotation_overlay_changed";
+      documentId: string;
+      snapshot: HostAnnotationSnapshot;
+    }
+  | {
+      type: "change_authored";
+      documentId: string;
+      changeId: string;
+      kind: "insertion" | "deletion";
+    }
   | {
       type: "command_blocked";
       documentId: string;
@@ -1327,6 +1378,9 @@ export interface WordReviewEditorRef {
   getWorkflowScopeSnapshot(): WorkflowScopeSnapshot | null;
   getInteractionGuardSnapshot(): InteractionGuardSnapshot;
   getWorkflowMarkupSnapshot(): WorkflowMarkupSnapshot;
+  setHostAnnotationOverlay(overlay: HostAnnotationOverlay): void;
+  clearHostAnnotationOverlay(): void;
+  getHostAnnotationSnapshot(): HostAnnotationSnapshot;
   getWorkflowCandidateRanges(options?: WorkflowCandidateRangeOptions): WorkflowCandidateRange[];
   replaceWorkflowMarkupText(markupId: string, text: string): void;
 }
@@ -1346,6 +1400,7 @@ export interface WordReviewEditorProps {
   reviewMode?: "editing" | "review";
   markupDisplay?: "clean" | "simple" | "all";
   showReviewPanel?: boolean;
+  chromeVisibility?: Partial<WordReviewEditorChromeVisibility>;
   hostAdapter?: EditorHostAdapter;
   datastore?: EditorDatastoreAdapter;
   autosave?: AutosaveConfig;
@@ -1353,3 +1408,13 @@ export interface WordReviewEditorProps {
   onWarning?: (warning: EditorWarning) => void;
   onError?: (error: EditorError) => void;
 }
+
+export interface WordReviewEditorChromeVisibility {
+  toolbar: boolean;
+  alerts: boolean;
+  selectionOverlay: boolean;
+  contextToolbars: boolean;
+  pageChrome: boolean;
+  statusBar: boolean;
+  reviewRail: boolean;
+}