@beyondwork/docx-react-component 1.0.11 → 1.0.13

package/README.md

@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/bwllaming/React-OOXML-Office/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/bwllaming/React-OOXML-Office/actions/workflows/ci.yml)
 
-`@beyondwork/docx-react-component` is the shipped product in this repository: `WordReviewEditor`, a fidelity-first React editor for legal-review-safe `docx` workflows. Wave 21 lands the package-facing docs, npm metadata, publish workflow, and `pnpm pack` proof for this surface.
+`@beyondwork/docx-react-component` is the shipped product in this repository: `WordReviewEditor`, a fidelity-first React editor for legal-review-safe `docx` workflows. Waves 20 through 23 land live table editing, package distribution, validator-backed CI, and legal workflow helpers. Wave 24 is the next production-hardening packet.
 
 The broader repository is still evolving toward a layered `react-ooxml-office` platform, but the source reality is unchanged:
 
@@ -43,6 +43,11 @@ import { WordReviewEditor } from "@beyondwork/docx-react-component";
 - runtime owns the live working session
 - host receives events, warnings, errors, snapshots, and exported artifacts
 
+Snapshot/export note:
+
+- when a session starts from a real `.docx`, persisted snapshots now carry embedded source-package provenance so later snapshot-origin `.docx` export can use the same package-backed exporter
+- legacy snapshots without that provenance still load, but `.docx` export is intentionally blocked rather than falling back to a lossy minimal package
+
 The current public ESM exports are:
 
 - `@beyondwork/docx-react-component` -> `WordReviewEditor`
@@ -87,7 +92,7 @@ Start here:
 Current shipped docx contracts:
 
 - `docs/reference/public-api.md`
-  This doc separates the shipped Wave 21 surface from the future Waves 25 through 27 ref expansion.
+  This doc separates the shipped Waves 20-23 surface from the future Waves 25 through 27 ref expansion.
 - `docs/reference/ooxml-compliance.md`
 - `docs/reference/word-review-editor-frontend-architecture.md`
 - `docs/reference/word-review-editor-ux-guide.md`
@@ -117,6 +122,7 @@ Shared platform and planned xlsx docs:
 - do not silently drop unknown OOXML
 - keep docs honest about shipped versus planned behavior
 - add or extend fixtures for compatibility-critical changes
+- `bash scripts/validate-fixtures.sh` now uses the Railway validator service and requires `OPENXML_VALIDATOR_AUTH_TOKEN` when hitting the public domain
 
 ## Guiding Principle
 

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@beyondwork/docx-react-component",
   "publisher": "beyondwork",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "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"
@@ -45,6 +46,29 @@
     "./package.json": "./package.json"
   },
   "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:tsgo && pnpm run lint:tsgo:harness",
+    "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",
@@ -90,7 +114,7 @@
     "tailwindcss": "^4.2.2"
   },
   "devDependencies": {
-    "@chllming/wave-orchestration": "^0.9.12",
+    "@chllming/wave-orchestration": "^0.9.13",
     "@types/react": "19.2.14",
     "@types/react-dom": "19.2.3",
     "@typescript/native-preview": "7.0.0-dev.20260409.1",
@@ -107,24 +131,14 @@
     "tsup": "^8.3.0",
     "tsx": "^4.21.0"
   },
-  "scripts": {
-    "build": "tsup",
-    "test": "bash scripts/run-workspace-tests.sh",
-    "test:repo": "pnpm exec tsx --test $(find test -type f \\( -name '*.test.ts' -o -name '*.test.tsx' \\) | sort)",
-    "test:harness": "pnpm --filter @docx-react-component/react-word-editor-harness test",
-    "lint": "pnpm run lint:no-authored-js && pnpm run lint:tsgo && pnpm run lint:tsgo:harness",
-    "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"
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild",
+      "sharp"
+    ],
+    "overrides": {
+      "react": "19.2.4",
+      "react-dom": "19.2.4"
+    }
   }
 }

package/src/api/public-types.ts

@@ -123,11 +123,62 @@ export interface TrackedChangesSnapshot {
   revisions: TrackedChangeEntrySnapshot[];
 }
 
+export type FormattingAlignment = "left" | "center" | "right" | "justify";
+
+export interface FormattingStateSnapshot {
+  bold: boolean;
+  italic: boolean;
+  underline: boolean;
+  strikethrough: boolean;
+  superscript: boolean;
+  subscript: boolean;
+  fontFamily?: string;
+  fontSize?: number;
+  textColor?: string;
+  highlightColor?: string | null;
+  alignment?: FormattingAlignment;
+}
+
+export interface SearchOptions {
+  matchCase?: boolean;
+  wholeWord?: boolean;
+  limit?: number;
+}
+
+export interface SearchResultSnapshot {
+  resultId: string;
+  anchor: EditorAnchorProjection;
+  excerpt: string;
+  isActive: boolean;
+}
+
+export interface InsertTableOptions {
+  rows: number;
+  columns: number;
+}
+
+export interface InsertImageOptions {
+  data: Uint8Array;
+  mimeType: string;
+  width?: number;
+  height?: number;
+  altText?: string;
+}
+
 export type SurfaceTextMark =
   | "bold"
   | "italic"
   | "underline"
-  | "strikethrough";
+  | "strikethrough"
+  | "doubleStrikethrough"
+  | "superscript"
+  | "subscript"
+  | "vanish"
+  | "emboss"
+  | "imprint"
+  | "shadow"
+  | "smallCaps"
+  | "allCaps";
 
 export type SurfaceInlineSegment =
   | {
@@ -137,6 +188,15 @@ export type SurfaceInlineSegment =
       to: number;
       text: string;
       marks?: SurfaceTextMark[];
+      markAttrs?: {
+        backgroundColor?: string;
+        charSpacing?: number;
+        kerning?: number;
+        textFill?: string;
+        fontFamily?: string;
+        fontSize?: number;
+        textColor?: string;
+      };
       hyperlinkHref?: string;
     }
   | {
@@ -174,6 +234,7 @@ export interface SurfaceTableCellSnapshot {
   verticalMerge: "restart" | "continue" | null;
   colspan: number;
   rowspan: number;
+  backgroundColor?: string | null;
   content: SurfaceBlockSnapshot[];
 }
 
@@ -192,6 +253,17 @@ export type SurfaceBlockSnapshot =
         numberingInstanceId: string;
         level: number;
       };
+      alignment?: "left" | "center" | "right" | "both" | "distribute";
+      spacing?: { before?: number; after?: number; line?: number; lineRule?: string };
+      indentation?: { left?: number; right?: number; firstLine?: number; hanging?: number };
+      borders?: { top?: unknown; left?: unknown; bottom?: unknown; right?: unknown; bar?: unknown; between?: unknown };
+      shading?: { fill?: string; color?: string; val?: string };
+      tabStops?: Array<{ pos: number; val?: string; leader?: string }>;
+      keepNext?: boolean;
+      keepLines?: boolean;
+      pageBreakBefore?: boolean;
+      outlineLevel?: number;
+      bidi?: boolean;
       segments: SurfaceInlineSegment[];
     }
   | {
@@ -346,6 +418,7 @@ export interface PersistedEditorSnapshot {
   canonicalDocument: RuntimePersistedEditorSnapshot["canonicalDocument"];
   compatibility: CompatibilityReport;
   warningLog: EditorWarning[];
+  sourcePackage?: RuntimePersistedEditorSnapshot["sourcePackage"];
 }
 
 export interface AddCommentParams {
@@ -508,6 +581,35 @@ export interface WordReviewEditorRef {
   getWarnings(): EditorWarning[];
   getComments(): CommentSidebarSnapshot;
   getTrackedChanges(): TrackedChangesSnapshot;
+  getFormattingState(): FormattingStateSnapshot;
+  toggleBold(): void;
+  toggleItalic(): void;
+  toggleUnderline(): void;
+  toggleStrikethrough(): void;
+  toggleSuperscript(): void;
+  toggleSubscript(): void;
+  setFontFamily(fontFamily: string | null): void;
+  setFontSize(size: number | null): void;
+  setTextColor(color: string | null): void;
+  setHighlightColor(color: string | null): void;
+  setAlignment(alignment: FormattingAlignment): void;
+  indent(): void;
+  outdent(): void;
+  insertPageBreak(): void;
+  insertTable(options: InsertTableOptions): void;
+  insertImage(options: InsertImageOptions): void;
+  addRowBefore(): void;
+  addRowAfter(): void;
+  addColumnBefore(): void;
+  addColumnAfter(): void;
+  deleteRow(): void;
+  deleteColumn(): void;
+  deleteTable(): void;
+  mergeCells(): void;
+  splitCell(): void;
+  setCellBackground(color: string): void;
+  search(query: string, options?: SearchOptions): SearchResultSnapshot[];
+  clearSearch(): void;
   scrollToRevision(revisionId: string): void;
   scrollToComment(commentId: string): void;
 }