@beyondwork/docx-react-component 1.0.1 → 1.0.2

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

@@ -0,0 +1,168 @@
+import {
+  createNodeAnchor,
+  createRangeAnchor,
+  mapAnchor,
+  normalizeRange,
+  type Assoc,
+  type BoundaryAssoc,
+  type DocRange,
+  type EditorAnchorProjection,
+  type TransactionMapping,
+} from "../../core/selection/mapping.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";
+}
+
+export interface RevisionMetadataEnvelope {
+  source: "runtime" | "import";
+  preserveOnlyReason?: string;
+  importedRevisionForm?:
+    | "run-insertion"
+    | "run-deletion"
+    | "paragraph-insertion"
+    | "paragraph-deletion";
+  originalRevisionType?: string;
+  ooxmlRevisionId?: string;
+  propertyChangeData?: PropertyChangeData;
+  moveData?: MoveData;
+}
+
+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 function createRevisionRangeAnchor(
+  from: number,
+  to = from,
+  assoc?: BoundaryAssoc,
+): RevisionAnchor {
+  return createRangeAnchor(from, to, assoc);
+}
+
+export function createRevisionNodeAnchor(at: number, assoc?: Assoc): RevisionAnchor {
+  return createNodeAnchor(at, assoc);
+}
+
+export function remapRevisionAnchor(
+  anchor: RevisionAnchor,
+  mapping: TransactionMapping,
+): RevisionAnchor {
+  return mapAnchor(anchor, mapping);
+}
+
+export function isDetachedRevisionAnchor(anchor: RevisionAnchor): boolean {
+  return anchor.kind === "detached";
+}
+
+export function summarizeRevisionAnchor(anchor: RevisionAnchor): RevisionAnchorSummary {
+  if (anchor.kind === "range") {
+    return {
+      anchor,
+      state: "active",
+      range: normalizeRange(anchor.range),
+    };
+  }
+
+  if (anchor.kind === "node") {
+    return {
+      anchor,
+      state: "active",
+      range: {
+        from: anchor.at,
+        to: anchor.at,
+      },
+    };
+  }
+
+  return {
+    anchor,
+    state: "detached",
+    range: normalizeRange(anchor.lastKnownRange),
+  };
+}
+
+export function getRevisionActionability(
+  revision:
+    | RevisionKind
+    | Pick<RevisionRecord, "kind" | "metadata">,
+): RevisionActionability {
+  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/review/store/runtime-comment-store.ts

@@ -0,0 +1,43 @@
+import {
+  normalizeCommentThreadRecord,
+  type CommentThreadRecord,
+} from "../../core/state/editor-state.ts";
+import {
+  createCommentStore,
+  type CommentStore,
+  type CommentThread,
+} from "./comment-store.ts";
+
+export function createCommentStoreFromRuntimeComments(
+  comments: Record<string, CommentThreadRecord>,
+): CommentStore {
+  const threads = Object.fromEntries(
+    Object.values(comments).map((comment) => [
+      comment.commentId,
+      toCommentThread(comment),
+    ]),
+  );
+
+  return createCommentStore(threads);
+}
+
+function toCommentThread(comment: CommentThreadRecord): CommentThread {
+  const normalized = normalizeCommentThreadRecord(comment);
+
+  return {
+    commentId: normalized.commentId,
+    anchor: normalized.anchor,
+    status:
+      normalized.anchor.kind === "detached"
+        ? "detached"
+        : normalized.status === "resolved"
+          ? "resolved"
+          : "open",
+    entries: normalized.entries ?? [],
+    createdBy: normalized.createdBy ?? normalized.authorId ?? "unknown",
+    createdAt: normalized.createdAt,
+    resolution: normalized.resolution,
+    warningIds: [...(normalized.warningIds ?? [])],
+    metadata: normalized.metadata,
+  };
+}

package/src/runtime/README.md

@@ -0,0 +1,3 @@
+# Runtime
+
+The document controller and coordination between canonical state, review state, UI state, preservation, validation, and IO belong here.