@beyondwork/docx-react-component 1.0.67 → 1.0.70

package/src/model/snapshot.ts

@@ -159,6 +159,34 @@ export interface PersistedWorkflowOverlay {
   activeWorkItemId?: string | null;
 }
 
+/**
+ * W10 — class-A overlay-visibility policies persisted alongside the
+ * session state. Optional; absent arrays on older documents read as
+ * "no authored policy."
+ */
+export interface PersistedOverlayVisibilityPolicy {
+  readonly kind:
+    | "scope-rail"
+    | "comments"
+    | "tracked-changes"
+    | "suggestions"
+    | "debug-panel"
+    | "presence";
+  readonly enforcement: "authored-default" | "always" | "never";
+  readonly defaultOn: boolean;
+  readonly authoredBy?: { readonly actorId: string; readonly at: string };
+}
+
+/**
+ * X5 — class-A markup-mode policy (single record). Mirrors
+ * `PersistedOverlayVisibilityPolicy` shape but single-value.
+ */
+export interface PersistedMarkupModePolicy {
+  readonly mode: "clean" | "simple" | "all";
+  readonly enforcement: "authored-default" | "always";
+  readonly authoredBy?: { readonly actorId: string; readonly at: string };
+}
+
 export interface PersistedEditorSnapshot {
   snapshotVersion: PersistedEditorSnapshotVersion;
   schemaVersion: typeof CDS_SCHEMA_VERSION;
@@ -175,6 +203,8 @@ export interface PersistedEditorSnapshot {
   sourcePackage?: PersistedSourcePackage;
   workflowOverlay?: PersistedWorkflowOverlay;
   workflowMetadata?: PersistedWorkflowMetadataSnapshot;
+  visibilityPolicies?: readonly PersistedOverlayVisibilityPolicy[];
+  markupModePolicy?: PersistedMarkupModePolicy;
 }
 
 const SNAPSHOT_REQUIRED_TOP_LEVEL_KEYS = [
@@ -196,6 +226,8 @@ const SNAPSHOT_OPTIONAL_TOP_LEVEL_KEYS = [
   "protectionSnapshot",
   "workflowOverlay",
   "workflowMetadata",
+  "visibilityPolicies",
+  "markupModePolicy",
 ] as const;
 
 export interface ProtectionRangeRecord {

package/src/review/store/comment-store.ts

@@ -6,53 +6,27 @@ import {
   type CommentAnchor,
 } from "./comment-anchors.ts";
 
-export interface CommentEntry {
-  entryId: string;
-  authorId: string;
-  body: string;
-  createdAt: string;
-  metadata?: CommentEntryMetadata;
-}
-
-export interface CommentEntryMetadata {
-  ooxmlCommentId?: string;
-  paraId?: string;
-  parentParaId?: string;
-  durableId?: string;
-  initials?: string;
-}
-
-export interface CommentResolution {
-  resolvedAt: string;
-  resolvedBy: string;
-}
-
-export type CommentThreadStatus = "open" | "resolved" | "detached";
-
-export interface CommentThread {
-  commentId: string;
-  anchor: CommentAnchor;
-  status: CommentThreadStatus;
-  entries: CommentEntry[];
-  createdBy: string;
-  createdAt: string;
-  resolution?: CommentResolution;
-  warningIds: string[];
-  metadata?: CommentThreadMetadata;
-}
-
-export interface CommentThreadMetadata {
-  source?: "runtime" | "import";
-  rootOoxmlCommentId?: string;
-  rootParaId?: string;
-  detachedReason?: "incomplete-markers" | "multi-paragraph" | "opaque-region" | "revision-overlap";
-  actionabilityNote?: string;
-}
-
-export interface CommentStore {
-  version: "comment-store/1";
-  threads: Record<string, CommentThread>;
-}
+// Type definitions now live at src/model/review/comment-types.ts so the
+// session layer can consume them without importing from src/review/**.
+// Store operations (construct/upsert/resolve/remap/project) remain here
+// — those are runtime-state concerns, not model shapes.
+export type {
+  CommentEntry,
+  CommentEntryMetadata,
+  CommentResolution,
+  CommentStore,
+  CommentThread,
+  CommentThreadMetadata,
+  CommentThreadStatus,
+} from "../../model/review/comment-types.ts";
+
+import type {
+  CommentEntry,
+  CommentStore,
+  CommentThread,
+  CommentThreadMetadata,
+  CommentThreadStatus,
+} from "../../model/review/comment-types.ts";
 
 export interface CreateCommentThreadParams {
   commentId: string;

package/src/review/store/revision-types.ts

@@ -1,3 +1,14 @@
+/**
+ * Back-compat shim — every type that used to live here has moved to
+ * `src/model/review/revision-types.ts` so the session layer can consume
+ * revision records without importing from `src/review/**`. Existing
+ * call-sites (~25 in-tree) continue to work via the re-exports below.
+ *
+ * The anchor-constructor / remap helpers stay here: they depend on the
+ * mapping machinery in `src/core/selection/mapping.ts` and are not pure
+ * data concerns.
+ */
+
 import {
   createNodeAnchor,
   createRangeAnchor,
@@ -5,134 +16,38 @@ import {
   normalizeRange,
   type Assoc,
   type BoundaryAssoc,
-  type DocRange,
-  type EditorAnchorProjection,
   type TransactionMapping,
 } from "../../core/selection/mapping.ts";
-import type { RevisionStoryTargetRecord } from "../../model/canonical-document.ts";
-
-export type RevisionAnchor = EditorAnchorProjection;
-
-export type SupportedRevisionKind = "insertion" | "deletion" | "property-change";
-export type PreserveOnlyRevisionKind = "formatting" | "move";
-export type RevisionKind = SupportedRevisionKind | PreserveOnlyRevisionKind;
-
-export type RevisionStatus = "active" | "accepted" | "rejected" | "detached";
-export type RevisionActionability = "actionable" | "preserve-only";
-export type RevisionAnchorState = "active" | "detached";
-
-export interface PropertyChangeData {
-  xmlTag: "pPrChange" | "sectPrChange" | "tblPrChange" | "rPrChange";
-  beforeXml: string;
-}
-
-export interface MoveData {
-  moveId: string;
-  direction: "from" | "to";
-  linkedRevisionId?: string;
-}
-
-/**
- * Payload for `w:cellMerge` revisions. `direction` is the `w:vMerge`
- * attribute on the marker:
- *   `"rest"` — this cell begins a vertical merge span (restart cell).
- *   `"cont"` — this cell continues a vertical merge span.
- *
- * Accept commits `TableCellNode.verticalMerge` to the matching state;
- * reject clears `verticalMerge` to undefined. No row topology changes
- * (mirrors LibreOffice's treatment — vMerge is a rendering property, not
- * a structural mutation).
- */
-export interface CellMergeData {
-  direction: "rest" | "cont";
-}
-
-/**
- * Ordinal coordinates of a structural table revision within the canonical
- * document tree.
- *
- * Lane 7b row-insertion revisions (`<w:trPr><w:ins/></w:trPr>`) point at an
- * entire row, not a text range — the runtime anchor position alone can't
- * identify which row to remove on reject. This envelope carries the table's
- * ordinal (the Nth `<w:tbl>` in the body) and the row's index within that
- * table, both fixed at parse time. Accept/reject resolves these to a
- * canonical-document `tableBlockIndex` by walking `doc.content.children[]`
- * at action time.
- */
-export interface TableRevisionCoordinates {
-  tableOrdinal: number;
-  rowIndex: number;
-  /**
-   * Cell index within `row.cells[]`. Present on cell-level structural
-   * revisions (`cellIns` / `cellDel` / `cellMerge`); `undefined` on
-   * row-level records (`row-ins` / `row-del`).
-   */
-  cellIndex?: number;
-  /**
-   * For revisions inside nested tables (a `<w:tbl>` inside a cell), this
-   * carries the full ordinal path so `resolveCanonicalTableRow` can
-   * tree-walk the canonical document:
-   *   `[bodyTableOrdinal, nestedTableIndex, ...]`
-   * Body-level revisions omit this field and use the flat `tableOrdinal`.
-   * Lane 7b Phase Q.
-   */
-  tableOrdinalPath?: readonly number[];
-}
 
-export interface RevisionMetadataEnvelope {
-  source: "runtime" | "import";
-  storyTarget?: RevisionStoryTargetRecord;
-  preserveOnlyReason?: string;
-  suggestionId?: string;
-  semanticKind?:
-    | "insertion"
-    | "deletion"
-    | "replacement"
-    | "formatting-change"
-    | "paragraph-property-change"
-    | "structural-change"
-    | "object-change";
-  linkedRevisionIds?: string[];
-  predecessorSuggestionId?: string;
-  importedRevisionForm?:
-    | "run-insertion"
-    | "run-deletion"
-    | "paragraph-insertion"
-    | "paragraph-deletion";
-  originalRevisionType?: string;
-  ooxmlRevisionId?: string;
-  propertyChangeData?: PropertyChangeData;
-  moveData?: MoveData;
-  cellMergeData?: CellMergeData;
-  tableRevisionCoordinates?: TableRevisionCoordinates;
-}
-
-export type PropertyChangeRevision = RevisionRecord & {
-  kind: "property-change";
-  metadata: RevisionMetadataEnvelope & { propertyChangeData: PropertyChangeData };
-};
-
-export type MoveRevision = RevisionRecord & {
-  kind: "move";
-  metadata: RevisionMetadataEnvelope & { moveData: MoveData };
-};
-
-export interface RevisionRecord {
-  revisionId: string;
-  kind: RevisionKind;
-  anchor: RevisionAnchor;
-  authorId: string;
-  createdAt: string;
-  status: RevisionStatus;
-  warningIds: string[];
-  metadata: RevisionMetadataEnvelope;
-}
-
-export interface RevisionAnchorSummary {
-  anchor: RevisionAnchor;
-  state: RevisionAnchorState;
-  range: DocRange;
-}
+export type {
+  CellMergeData,
+  MoveData,
+  MoveRevision,
+  PreserveOnlyRevisionKind,
+  PropertyChangeData,
+  PropertyChangeRevision,
+  RevisionActionability,
+  RevisionAnchor,
+  RevisionAnchorState,
+  RevisionAnchorSummary,
+  RevisionKind,
+  RevisionMetadataEnvelope,
+  RevisionRecord,
+  RevisionStatus,
+  SupportedRevisionKind,
+  TableRevisionCoordinates,
+} from "../../model/review/revision-types.ts";
+
+export {
+  describeRevisionKind,
+  getRevisionActionability,
+  isRevisionActionable,
+} from "../../model/review/revision-types.ts";
+
+import type {
+  RevisionAnchor,
+  RevisionAnchorSummary,
+} from "../../model/review/revision-types.ts";
 
 export function createRevisionRangeAnchor(
   from: number,
@@ -183,76 +98,3 @@ export function summarizeRevisionAnchor(anchor: RevisionAnchor): RevisionAnchorS
     range: normalizeRange(anchor.lastKnownRange),
   };
 }
-
-export function getRevisionActionability(
-  revision:
-    | RevisionKind
-    | Pick<RevisionRecord, "kind" | "metadata">,
-): RevisionActionability {
-  // Lane 7b promotions run BEFORE the preserveOnlyReason check on purpose:
-  // `createRevisionRecord` injects a default "Imported preserve-only revision."
-  // reason for any kind that `getRevisionActionability(kind)` returns as
-  // preserve-only (see revision-store.ts), which covers both `kind: "move"`
-  // and `kind: "formatting"`. The overrides below flip the default back to
-  // actionable for the specific shapes that Lane 7b promoted: cellIns
-  // structural-table revisions, and linked-pair move revisions. Do not add a
-  // `&& !preserveOnlyReason` guard here — that would re-lock these shapes
-  // against the injected default and regress 7b.
-  if (
-    typeof revision !== "string" &&
-    (revision.metadata.originalRevisionType === "cellIns" ||
-      revision.metadata.originalRevisionType === "cellDel" ||
-      revision.metadata.originalRevisionType === "cellMerge")
-  ) {
-    return "actionable";
-  }
-
-  if (
-    typeof revision !== "string" &&
-    revision.kind === "move" &&
-    typeof revision.metadata.moveData?.linkedRevisionId === "string" &&
-    revision.metadata.moveData.linkedRevisionId.length > 0
-  ) {
-    return "actionable";
-  }
-
-  if (
-    typeof revision !== "string" &&
-    typeof revision.metadata.preserveOnlyReason === "string" &&
-    revision.metadata.preserveOnlyReason.length > 0
-  ) {
-    return "preserve-only";
-  }
-
-  const kind = typeof revision === "string" ? revision : revision.kind;
-  switch (kind) {
-    case "insertion":
-    case "deletion":
-    case "property-change":
-      return "actionable";
-    case "formatting":
-    case "move":
-      return "preserve-only";
-  }
-}
-
-export function isRevisionActionable(
-  record: Pick<RevisionRecord, "kind" | "metadata" | "status">,
-): boolean {
-  return getRevisionActionability(record) === "actionable" && record.status === "active";
-}
-
-export function describeRevisionKind(kind: RevisionKind): string {
-  switch (kind) {
-    case "insertion":
-      return "Insertion";
-    case "deletion":
-      return "Deletion";
-    case "formatting":
-      return "Formatting change";
-    case "move":
-      return "Move";
-    case "property-change":
-      return "Property change";
-  }
-}

package/src/runtime/collab/base-doc-fingerprint.ts

@@ -20,11 +20,13 @@ import { sha256Hex } from "../../io/source-package-provenance.ts";
  * | `media` | yes | embedded media are base content |
  * | `content` | yes | the editable body tree |
  * | `preservation` | yes | opaque fragments round-trip identically from the source |
+ * | `subParts` | yes | headers/footers/footnotes/theme are base content |
+ * | `fieldRegistry` | yes | deterministic from `{content, styles, subParts}` — see `buildFieldRegistry` |
+ * | `fontTable` | yes | fontTable.xml is base content |
  * | `docId` | **no** | session-local |
  * | `createdAt` / `updatedAt` | **no** | session-local timestamps |
  * | `review` | **no** | tracked changes are session state |
  * | `diagnostics` | **no** | validator output is session state |
- * | `subParts` / `fieldRegistry` | **no** | may be partially session-computed |
  *
  * Hash pipeline: the subset is serialized via {@link stableStringify}
  * (sorts object keys recursively, preserves array order, follows
@@ -44,6 +46,9 @@ export function computeBaseDocFingerprint(envelope: CanonicalDocumentEnvelope):
     media: envelope.media,
     content: envelope.content,
     preservation: envelope.preservation,
+    subParts: envelope.subParts,
+    fieldRegistry: envelope.fieldRegistry,
+    fontTable: envelope.fontTable,
   };
   const serialized = stableStringify(subset);
   const bytes = new TextEncoder().encode(serialized);

package/src/runtime/collab/runtime-collab-sync.ts

@@ -7,7 +7,10 @@ import type {
   EditorTransaction,
 } from "../../core/commands/index.ts";
 import type { CanonicalDocumentEnvelope } from "../../core/state/editor-state.ts";
-import type { BlockNode } from "../../model/canonical-document.ts";
+import type {
+  BlockNode,
+  MutableCanonicalDocument,
+} from "../../model/canonical-document.ts";
 import type {
   CommandAppliedMeta,
   DocumentRuntime,
@@ -82,12 +85,19 @@ export function compressDocumentReplaceForBroadcast(
     return command;
   }
 
-  const patch: Partial<CanonicalDocumentEnvelope> = {};
+  const patch: Partial<MutableCanonicalDocument> = {};
   let anyTopLevelChange = false;
+  const assignPatch = <K extends keyof MutableCanonicalDocument>(
+    target: Partial<MutableCanonicalDocument>,
+    key: K,
+    value: MutableCanonicalDocument[K],
+  ): void => {
+    target[key] = value;
+  };
   for (const key of PATCHABLE_TOP_LEVEL_KEYS) {
     if (key === "content") continue;
     if (next[key] !== priorDocument[key]) {
-      (patch as Record<string, unknown>)[key] = next[key];
+      assignPatch(patch, key, next[key] as MutableCanonicalDocument[typeof key]);
       anyTopLevelChange = true;
     }
   }

package/src/runtime/collab-session.ts

@@ -38,7 +38,7 @@ import {
   type MetadataIntegrity,
   type TamperGate,
   type TamperGateEvent,
-} from "./tamper-gate.ts";
+} from "./workflow/tamper-gate.ts";
 
 /**
  * Event union emitted by the session. Merges the bridge's event