@beyondwork/docx-react-component 1.0.37 → 1.0.38

package/src/ui/headless/chrome-registry.ts

@@ -1,4 +1,7 @@
-import type { WordReviewEditorChromePreset } from "../../api/public-types";
+import type {
+  EditorRole,
+  WordReviewEditorChromePreset,
+} from "../../api/public-types";
 import type { SelectionToolKind } from "./selection-tool-types";
 
 export type ChromeSurface = "top-toolbar" | "selection-tool";
@@ -6,6 +9,7 @@ export type ChromeDensity = "compact";
 export type ToolbarChromePlacement = "inline" | "overflow" | "hidden";
 
 export type ToolbarChromeItemId =
+  // Universal formatting + history
   | "history"
   | "text-style-selectors"
   | "inline-formatting"
@@ -24,7 +28,25 @@ export type ToolbarChromeItemId =
   | "workspace-mode"
   | "zoom"
   | "health"
-  | "export";
+  | "export"
+  // R1: role-scoped action region entries
+  | "editor-scope-posture-menu"
+  | "review-queue-prev"
+  | "review-queue-next"
+  | "review-queue-counts"
+  | "review-queue-active-label"
+  | "review-accept"
+  | "review-reject"
+  | "review-accept-all"
+  | "review-reject-all"
+  | "review-markup-mode"
+  | "workflow-prev"
+  | "workflow-next"
+  | "workflow-mark-complete"
+  | "workflow-claim"
+  | "workflow-skip"
+  | "workflow-mark-blocked"
+  | "workflow-jump-to-scope";
 
 export interface ChromeRegistryEntryBase {
   id: string;
@@ -42,12 +64,33 @@ export interface ToolbarChromeRegistryEntry extends ChromeRegistryEntryBase {
   id: ToolbarChromeItemId;
   surfaces: ["top-toolbar"];
   presets: ReadonlyArray<WordReviewEditorChromePreset>;
+  /**
+   * Roles in which this entry appears.  Empty = appears in every role.
+   * R1 uses this to filter the inline action set down to the per-role
+   * matrix described in the chrome-phase plan.
+   */
+  roles: ReadonlyArray<EditorRole>;
   fullPlacement: Exclude<ToolbarChromePlacement, "hidden">;
   compactPlacement: ToolbarChromePlacement;
   runtimeBehavior: "always" | "formatting" | "structure" | "comment";
   scopeBehavior?: "default" | "scoped-only" | "hidden-when-scoped";
+  /**
+   * Optional per-role placement override.  When a role overrides the
+   * placement (for instance, "text-style-selectors" is `inline` in editor
+   * but `overflow` in review/workflow), list the role-specific placement
+   * here.  Missing roles inherit `fullPlacement` / `compactPlacement`.
+   */
+  rolePlacement?: Partial<
+    Record<EditorRole, Exclude<ToolbarChromePlacement, "hidden">>
+  >;
 }
 
+const ALL_ROLES: ReadonlyArray<EditorRole> = ["editor", "review", "workflow"];
+const EDITOR_ONLY: ReadonlyArray<EditorRole> = ["editor"];
+const REVIEW_ONLY: ReadonlyArray<EditorRole> = ["review"];
+const WORKFLOW_ONLY: ReadonlyArray<EditorRole> = ["workflow"];
+const EDITOR_AND_REVIEW: ReadonlyArray<EditorRole> = ["editor", "review"];
+
 export const SELECTION_TOOL_REGISTRY: ReadonlyArray<SelectionToolRegistryEntry> = [
   { id: "suggestion-review", surfaces: ["selection-tool"], group: "review", precedence: 10 },
   { id: "comment-thread", surfaces: ["selection-tool"], group: "review", precedence: 20 },
@@ -62,7 +105,8 @@ export const TOOLBAR_CHROME_REGISTRY: ReadonlyArray<ToolbarChromeRegistryEntry>
     id: "history",
     surfaces: ["top-toolbar"],
     group: "history",
-    presets: ["simple", "advanced", "review"],
+    presets: ["simple", "advanced", "review", "workflow"],
+    roles: ALL_ROLES,
     fullPlacement: "inline",
     compactPlacement: "inline",
     runtimeBehavior: "always",
@@ -71,61 +115,94 @@ export const TOOLBAR_CHROME_REGISTRY: ReadonlyArray<ToolbarChromeRegistryEntry>
     id: "text-style-selectors",
     surfaces: ["top-toolbar"],
     group: "text",
-    presets: ["advanced"],
+    presets: ["advanced", "workflow"],
+    roles: ALL_ROLES,
     fullPlacement: "inline",
     compactPlacement: "overflow",
     runtimeBehavior: "formatting",
+    rolePlacement: {
+      editor: "inline",
+      review: "overflow",
+      workflow: "overflow",
+    },
   },
   {
     id: "inline-formatting",
     surfaces: ["top-toolbar"],
     group: "text",
-    presets: ["simple", "advanced", "review"],
+    presets: ["simple", "advanced", "review", "workflow"],
+    roles: ALL_ROLES,
     fullPlacement: "inline",
     compactPlacement: "inline",
     runtimeBehavior: "formatting",
+    rolePlacement: {
+      editor: "inline",
+      review: "overflow",
+      workflow: "overflow",
+    },
   },
   {
     id: "text-colors",
     surfaces: ["top-toolbar"],
     group: "text",
     presets: ["simple", "advanced"],
+    roles: EDITOR_AND_REVIEW,
     fullPlacement: "inline",
     compactPlacement: "inline",
     runtimeBehavior: "formatting",
+    rolePlacement: {
+      editor: "inline",
+      review: "overflow",
+    },
   },
   {
     id: "paragraph-alignment",
     surfaces: ["top-toolbar"],
     group: "paragraph",
     presets: ["simple", "advanced"],
+    roles: EDITOR_AND_REVIEW,
     fullPlacement: "inline",
     compactPlacement: "inline",
     runtimeBehavior: "formatting",
+    rolePlacement: {
+      editor: "inline",
+      review: "overflow",
+    },
   },
   {
     id: "list-actions",
     surfaces: ["top-toolbar"],
     group: "paragraph",
     presets: ["simple", "advanced"],
+    roles: EDITOR_AND_REVIEW,
     fullPlacement: "inline",
     compactPlacement: "overflow",
     runtimeBehavior: "formatting",
+    rolePlacement: {
+      editor: "inline",
+      review: "overflow",
+    },
   },
   {
     id: "indentation",
     surfaces: ["top-toolbar"],
     group: "paragraph",
     presets: ["simple", "advanced"],
+    roles: EDITOR_AND_REVIEW,
     fullPlacement: "inline",
     compactPlacement: "overflow",
     runtimeBehavior: "formatting",
+    rolePlacement: {
+      editor: "inline",
+      review: "overflow",
+    },
   },
   {
     id: "list-continuation",
     surfaces: ["top-toolbar"],
     group: "paragraph",
     presets: ["simple", "advanced"],
+    roles: EDITOR_ONLY,
     fullPlacement: "inline",
     compactPlacement: "overflow",
     runtimeBehavior: "formatting",
@@ -135,6 +212,7 @@ export const TOOLBAR_CHROME_REGISTRY: ReadonlyArray<ToolbarChromeRegistryEntry>
     surfaces: ["top-toolbar"],
     group: "document",
     presets: ["simple", "advanced"],
+    roles: EDITOR_ONLY,
     fullPlacement: "inline",
     compactPlacement: "overflow",
     runtimeBehavior: "structure",
@@ -145,6 +223,7 @@ export const TOOLBAR_CHROME_REGISTRY: ReadonlyArray<ToolbarChromeRegistryEntry>
     surfaces: ["top-toolbar"],
     group: "document",
     presets: ["advanced"],
+    roles: EDITOR_ONLY,
     fullPlacement: "inline",
     compactPlacement: "overflow",
     runtimeBehavior: "structure",
@@ -154,7 +233,8 @@ export const TOOLBAR_CHROME_REGISTRY: ReadonlyArray<ToolbarChromeRegistryEntry>
     id: "scope-status",
     surfaces: ["top-toolbar"],
     group: "scope",
-    presets: ["simple", "advanced", "review"],
+    presets: ["simple", "advanced", "review", "workflow"],
+    roles: ALL_ROLES,
     fullPlacement: "inline",
     compactPlacement: "inline",
     runtimeBehavior: "always",
@@ -164,7 +244,8 @@ export const TOOLBAR_CHROME_REGISTRY: ReadonlyArray<ToolbarChromeRegistryEntry>
     id: "story-breadcrumb",
     surfaces: ["top-toolbar"],
     group: "scope",
-    presets: ["simple", "advanced", "review"],
+    presets: ["simple", "advanced", "review", "workflow"],
+    roles: ALL_ROLES,
     fullPlacement: "inline",
     compactPlacement: "inline",
     runtimeBehavior: "always",
@@ -173,7 +254,8 @@ export const TOOLBAR_CHROME_REGISTRY: ReadonlyArray<ToolbarChromeRegistryEntry>
     id: "sidebar-toggle",
     surfaces: ["top-toolbar"],
     group: "review",
-    presets: ["simple", "advanced", "review"],
+    presets: ["simple", "advanced", "review", "workflow"],
+    roles: ALL_ROLES,
     fullPlacement: "inline",
     compactPlacement: "inline",
     runtimeBehavior: "always",
@@ -182,7 +264,8 @@ export const TOOLBAR_CHROME_REGISTRY: ReadonlyArray<ToolbarChromeRegistryEntry>
     id: "comment",
     surfaces: ["top-toolbar"],
     group: "review",
-    presets: ["simple", "advanced", "review"],
+    presets: ["simple", "advanced", "review", "workflow"],
+    roles: ALL_ROLES,
     fullPlacement: "inline",
     compactPlacement: "inline",
     runtimeBehavior: "comment",
@@ -191,7 +274,10 @@ export const TOOLBAR_CHROME_REGISTRY: ReadonlyArray<ToolbarChromeRegistryEntry>
     id: "tracked-changes-toggle",
     surfaces: ["top-toolbar"],
     group: "review",
-    presets: ["advanced", "review"],
+    // R1 promotes this toggle to every preset that shows a toolbar so the
+    // editor role can see inline tracked changes without switching preset.
+    presets: ["simple", "advanced", "review", "workflow"],
+    roles: ALL_ROLES,
     fullPlacement: "inline",
     compactPlacement: "inline",
     runtimeBehavior: "always",
@@ -200,7 +286,8 @@ export const TOOLBAR_CHROME_REGISTRY: ReadonlyArray<ToolbarChromeRegistryEntry>
     id: "workspace-mode",
     surfaces: ["top-toolbar"],
     group: "view",
-    presets: ["simple", "advanced", "review"],
+    presets: ["simple", "advanced", "review", "workflow"],
+    roles: ALL_ROLES,
     fullPlacement: "inline",
     compactPlacement: "inline",
     runtimeBehavior: "always",
@@ -209,7 +296,8 @@ export const TOOLBAR_CHROME_REGISTRY: ReadonlyArray<ToolbarChromeRegistryEntry>
     id: "zoom",
     surfaces: ["top-toolbar"],
     group: "view",
-    presets: ["simple", "advanced", "review"],
+    presets: ["simple", "advanced", "review", "workflow"],
+    roles: ALL_ROLES,
     fullPlacement: "inline",
     compactPlacement: "inline",
     runtimeBehavior: "always",
@@ -218,7 +306,8 @@ export const TOOLBAR_CHROME_REGISTRY: ReadonlyArray<ToolbarChromeRegistryEntry>
     id: "health",
     surfaces: ["top-toolbar"],
     group: "status",
-    presets: ["simple", "advanced", "review"],
+    presets: ["simple", "advanced", "review", "workflow"],
+    roles: ALL_ROLES,
     fullPlacement: "inline",
     compactPlacement: "inline",
     runtimeBehavior: "always",
@@ -227,9 +316,186 @@ export const TOOLBAR_CHROME_REGISTRY: ReadonlyArray<ToolbarChromeRegistryEntry>
     id: "export",
     surfaces: ["top-toolbar"],
     group: "status",
-    presets: ["simple", "advanced", "review"],
+    presets: ["simple", "advanced", "review", "workflow"],
+    roles: ALL_ROLES,
+    fullPlacement: "inline",
+    compactPlacement: "inline",
+    runtimeBehavior: "always",
+  },
+
+  // ───── R1: Editor-role primaries ──────────────────────────────────────
+  {
+    id: "editor-scope-posture-menu",
+    surfaces: ["top-toolbar"],
+    group: "scope",
+    presets: ["advanced", "review", "workflow"],
+    roles: EDITOR_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "overflow",
+    runtimeBehavior: "always",
+  },
+
+  // ───── R1: Review-role primaries ──────────────────────────────────────
+  {
+    id: "review-queue-prev",
+    surfaces: ["top-toolbar"],
+    group: "review-queue",
+    presets: ["review", "workflow"],
+    roles: REVIEW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "inline",
+    runtimeBehavior: "always",
+  },
+  {
+    id: "review-queue-next",
+    surfaces: ["top-toolbar"],
+    group: "review-queue",
+    presets: ["review", "workflow"],
+    roles: REVIEW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "inline",
+    runtimeBehavior: "always",
+  },
+  {
+    id: "review-queue-counts",
+    surfaces: ["top-toolbar"],
+    group: "review-queue",
+    presets: ["review"],
+    roles: REVIEW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "overflow",
+    runtimeBehavior: "always",
+  },
+  {
+    id: "review-queue-active-label",
+    surfaces: ["top-toolbar"],
+    group: "review-queue",
+    presets: ["review"],
+    roles: REVIEW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "overflow",
+    runtimeBehavior: "always",
+  },
+  {
+    id: "review-accept",
+    surfaces: ["top-toolbar"],
+    group: "review-action",
+    presets: ["review"],
+    roles: REVIEW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "inline",
+    runtimeBehavior: "always",
+  },
+  {
+    id: "review-reject",
+    surfaces: ["top-toolbar"],
+    group: "review-action",
+    presets: ["review"],
+    roles: REVIEW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "inline",
+    runtimeBehavior: "always",
+  },
+  {
+    id: "review-accept-all",
+    surfaces: ["top-toolbar"],
+    group: "review-action",
+    presets: ["review"],
+    roles: REVIEW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "overflow",
+    runtimeBehavior: "always",
+  },
+  {
+    id: "review-reject-all",
+    surfaces: ["top-toolbar"],
+    group: "review-action",
+    presets: ["review"],
+    roles: REVIEW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "overflow",
+    runtimeBehavior: "always",
+  },
+  {
+    id: "review-markup-mode",
+    surfaces: ["top-toolbar"],
+    group: "review-action",
+    presets: ["review"],
+    roles: REVIEW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "inline",
+    runtimeBehavior: "always",
+  },
+
+  // ───── R1: Workflow-role primaries ────────────────────────────────────
+  {
+    id: "workflow-prev",
+    surfaces: ["top-toolbar"],
+    group: "workflow-queue",
+    presets: ["workflow"],
+    roles: WORKFLOW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "inline",
+    runtimeBehavior: "always",
+  },
+  {
+    id: "workflow-next",
+    surfaces: ["top-toolbar"],
+    group: "workflow-queue",
+    presets: ["workflow"],
+    roles: WORKFLOW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "inline",
+    runtimeBehavior: "always",
+  },
+  {
+    id: "workflow-mark-complete",
+    surfaces: ["top-toolbar"],
+    group: "workflow-action",
+    presets: ["workflow"],
+    roles: WORKFLOW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "inline",
+    runtimeBehavior: "always",
+  },
+  {
+    id: "workflow-claim",
+    surfaces: ["top-toolbar"],
+    group: "workflow-action",
+    presets: ["workflow"],
+    roles: WORKFLOW_ONLY,
     fullPlacement: "inline",
     compactPlacement: "inline",
     runtimeBehavior: "always",
   },
+  {
+    id: "workflow-skip",
+    surfaces: ["top-toolbar"],
+    group: "workflow-action",
+    presets: ["workflow"],
+    roles: WORKFLOW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "overflow",
+    runtimeBehavior: "always",
+  },
+  {
+    id: "workflow-mark-blocked",
+    surfaces: ["top-toolbar"],
+    group: "workflow-action",
+    presets: ["workflow"],
+    roles: WORKFLOW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "overflow",
+    runtimeBehavior: "always",
+  },
+  {
+    id: "workflow-jump-to-scope",
+    surfaces: ["top-toolbar"],
+    group: "workflow-action",
+    presets: ["workflow"],
+    roles: WORKFLOW_ONLY,
+    fullPlacement: "inline",
+    compactPlacement: "overflow",
+    runtimeBehavior: "always",
+  },
 ];

package/src/ui/headless/scoped-chrome-policy.ts

@@ -1,5 +1,6 @@
 import type {
   ActiveListContext,
+  EditorRole,
   InteractionGuardSnapshot,
   WorkflowScopeSnapshot,
   WordReviewEditorChromePreset,
@@ -36,6 +37,13 @@ export interface ResolveScopedChromePolicyInput {
   interactionGuardSnapshot?: InteractionGuardSnapshot;
   workflowScopeSnapshot?: WorkflowScopeSnapshot | null;
   activeListContext?: ActiveListContext | null;
+  /**
+   * Active chrome role (spec §6.4).  When supplied, the policy filters
+   * registry entries whose `roles` array excludes the active role.  When
+   * omitted, the preset filter alone drives visibility (back-compat for
+   * callers that haven't adopted the role model yet).
+   */
+  role?: EditorRole;
 }
 
 export function resolveScopedChromePolicy(
@@ -62,6 +70,13 @@ export function resolveScopedChromePolicy(
     TOOLBAR_CHROME_REGISTRY.map((entry) => {
       let visible = entry.presets.includes(input.preset);
 
+      // Role filter — apply only when the caller supplied a role so existing
+      // host apps that haven't adopted the role model keep the pre-R1
+      // behavior (preset + capability only).
+      if (visible && input.role !== undefined) {
+        visible = entry.roles.includes(input.role);
+      }
+
       if (visible) {
         switch (entry.runtimeBehavior) {
           case "formatting":
@@ -93,8 +108,12 @@ export function resolveScopedChromePolicy(
         visible = !hasScopedContext;
       }
 
+      // Resolve placement: when the entry overrides placement for the
+      // active role, that wins over the preset-density default.
+      const fullPlacement =
+        (input.role && entry.rolePlacement?.[input.role]) ?? entry.fullPlacement;
       const placement = visible
-        ? (input.compactMode ? entry.compactPlacement : entry.fullPlacement)
+        ? (input.compactMode ? entry.compactPlacement : fullPlacement)
         : "hidden";
       const enabled =
         visible &&

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

@@ -59,6 +59,16 @@ export interface FormattingInlineSelectionToolModel extends BaseSelectionToolMod
   italicActive: boolean;
   underlineActive: boolean;
   canAddComment: boolean;
+  /**
+   * One-click "apply" color for the text-color affordance.  R2.5 plumbs
+   * the current `formattingState.textColor` (or the user's most recent
+   * pick) here so the mini-toolbar reflects the active color instead of
+   * a hardcoded blue.  Consumers fall back to a fixed default when
+   * absent.
+   */
+  textColorDefault?: string;
+  /** Matching one-click highlight color.  See `textColorDefault`. */
+  highlightColorDefault?: string;
 }
 
 export interface SuggestionReviewSelectionToolModel extends BaseSelectionToolModel {

package/src/ui-tailwind/chrome/chrome-preset-model.ts

@@ -7,12 +7,15 @@ import type {
 
 export function resolveChromePreset(
   chromePreset: WordReviewEditorProps["chromePreset"],
-  _reviewMode: WordReviewEditorProps["reviewMode"] = "review",
+  reviewMode: WordReviewEditorProps["reviewMode"] = "review",
 ): WordReviewEditorChromePreset {
   if (chromePreset) {
     return chromePreset;
   }
-  return "advanced";
+  // When the host does not set an explicit preset, pick one from the
+  // review-mode signal so review sessions get the review strip inline
+  // with the toolbar (rather than the density default "advanced").
+  return reviewMode === "review" ? "review" : "advanced";
 }
 
 export function resolveChromePresetOptions(
@@ -40,6 +43,14 @@ export function resolveChromePresetOptions(
       showSectionTagAction: true,
       showReviewRail: true,
     },
+    workflow: {
+      // Workflow role consolidates prev/next + mark-section into the top
+      // toolbar via the role-action region, so the separate queue bar
+      // strip is suppressed.
+      showReviewQueueBar: false,
+      showSectionTagAction: false,
+      showReviewRail: true,
+    },
   };
 
   return {
@@ -95,6 +106,16 @@ export function resolveChromeVisibilityForPreset(input: {
       statusBar: true,
       reviewRail: options.showReviewRail,
     },
+    workflow: {
+      toolbar: true,
+      alerts: true,
+      selectionOverlay: true,
+      contextToolbars: true,
+      contextAnalytics: true,
+      pageChrome: true,
+      statusBar: true,
+      reviewRail: options.showReviewRail,
+    },
   };
 
   return {

package/src/ui-tailwind/chrome/role-action-sets.ts

@@ -0,0 +1,74 @@
+/**
+ * Role → ordered primary-action id mapping for the top-toolbar's inline
+ * role-action region (spec §6.4).
+ *
+ * The registry in `chrome-registry.ts` knows which ids exist per role;
+ * this module decides the *rendering order* so the role region presents
+ * a tight, task-focused set instead of the preset-density order.
+ *
+ * Consumers of `TwRoleActionRegion` look up the array for the active
+ * role, iterate it in order, and let `scoped-chrome-policy` filter out
+ * anything currently invisible (for instance, review-role accept/reject
+ * buttons disappear when there are no pending revisions).
+ */
+
+import type { EditorRole } from "../../api/public-types";
+import type { ToolbarChromeItemId } from "../../ui/headless/chrome-registry";
+
+/**
+ * Ordered role-action ids.  Each array covers the *role-primary* actions
+ * only — the general left cluster (history, formatting, style selectors)
+ * and right cluster (tracked-changes, workspace mode, zoom, health,
+ * export) stay in the base `TwToolbar` layout regardless of role.
+ */
+export const ROLE_ACTION_SETS: Record<
+  EditorRole,
+  ReadonlyArray<ToolbarChromeItemId>
+> = {
+  editor: [
+    // Posture menu replaces the flat "Mark section" button per spec §6.4.
+    "editor-scope-posture-menu",
+    // Insert menu (tables / images / page breaks / section breaks) — only
+    // meaningful for authoring, so it lives in the editor role's action
+    // region rather than the base toolbar.
+    "insert-actions",
+    "update-actions",
+    "list-continuation",
+  ],
+  review: [
+    // Queue navigation + counts, collapsed from the old TwReviewQueueBar.
+    "review-queue-prev",
+    "review-queue-next",
+    "review-queue-counts",
+    "review-queue-active-label",
+    // Per-item accept/reject — the canonical review actions.
+    "review-accept",
+    "review-reject",
+    // Batch + markup-mode live in the overflow popover.
+    "review-accept-all",
+    "review-reject-all",
+    "review-markup-mode",
+  ],
+  workflow: [
+    // Work-item navigation (distinct from review-queue nav).
+    "workflow-prev",
+    "workflow-next",
+    // Primary workflow actions.
+    "workflow-mark-complete",
+    "workflow-claim",
+    "workflow-skip",
+    "workflow-mark-blocked",
+    "workflow-jump-to-scope",
+  ],
+};
+
+/**
+ * Reverse lookup: role → entry order with registry details merged in.
+ * Consumers who need to iterate role actions with presets/runtimeBehavior
+ * import from here to avoid re-running `Array.find` per render.
+ */
+export function resolveRoleActionOrder(
+  role: EditorRole,
+): ReadonlyArray<ToolbarChromeItemId> {
+  return ROLE_ACTION_SETS[role];
+}