@beyondwork/docx-react-component 1.0.29 → 1.0.31

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "@beyondwork/docx-react-component",
   "publisher": "beyondwork",
-  "version": "1.0.29",
+  "version": "1.0.31",
   "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"
@@ -11,129 +10,84 @@
   "files": [
     "README.md",
     "LICENSE.md",
-    "dist"
+    "src"
   ],
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "types": "./src/index.ts",
+      "import": "./src/index.ts"
     },
     "./public-types": {
-      "types": "./dist/public-types.d.ts",
-      "import": "./dist/public-types.js",
-      "require": "./dist/public-types.cjs"
+      "types": "./src/api/public-types.ts",
+      "import": "./src/api/public-types.ts"
     },
     "./ui-tailwind": {
-      "types": "./dist/ui-tailwind/index.d.ts",
-      "import": "./dist/ui-tailwind/index.js",
-      "require": "./dist/ui-tailwind/index.cjs"
+      "types": "./src/ui-tailwind/index.ts",
+      "import": "./src/ui-tailwind/index.ts"
     },
     "./tailwind": {
-      "types": "./dist/ui-tailwind/index.d.ts",
-      "import": "./dist/ui-tailwind/index.js",
-      "require": "./dist/ui-tailwind/index.cjs"
+      "types": "./src/ui-tailwind/index.ts",
+      "import": "./src/ui-tailwind/index.ts"
     },
     "./api/public-types": {
-      "types": "./dist/public-types.d.ts",
-      "import": "./dist/public-types.js",
-      "require": "./dist/public-types.cjs"
+      "types": "./src/api/public-types.ts",
+      "import": "./src/api/public-types.ts"
     },
     "./compare": {
-      "types": "./dist/compare/index.d.ts",
-      "import": "./dist/compare/index.js",
-      "require": "./dist/compare/index.cjs"
+      "types": "./src/compare/index.ts",
+      "import": "./src/compare/index.ts"
     },
     "./io/docx-session": {
-      "types": "./dist/io/docx-session.d.ts",
-      "import": "./dist/io/docx-session.js",
-      "require": "./dist/io/docx-session.cjs"
+      "types": "./src/io/docx-session.ts",
+      "import": "./src/io/docx-session.ts"
     },
     "./legal": {
-      "types": "./dist/legal/index.d.ts",
-      "import": "./dist/legal/index.js",
-      "require": "./dist/legal/index.cjs"
+      "types": "./src/legal/index.ts",
+      "import": "./src/legal/index.ts"
     },
     "./runtime/document-runtime": {
-      "types": "./dist/runtime/document-runtime.d.ts",
-      "import": "./dist/runtime/document-runtime.js",
-      "require": "./dist/runtime/document-runtime.cjs"
+      "types": "./src/runtime/document-runtime.ts",
+      "import": "./src/runtime/document-runtime.ts"
     },
     "./core/commands/formatting-commands": {
-      "types": "./dist/core/commands/formatting-commands.d.ts",
-      "import": "./dist/core/commands/formatting-commands.js",
-      "require": "./dist/core/commands/formatting-commands.cjs"
+      "types": "./src/core/commands/formatting-commands.ts",
+      "import": "./src/core/commands/formatting-commands.ts"
     },
     "./core/commands/text-commands": {
-      "types": "./dist/core/commands/text-commands.d.ts",
-      "import": "./dist/core/commands/text-commands.js",
-      "require": "./dist/core/commands/text-commands.cjs"
+      "types": "./src/core/commands/text-commands.ts",
+      "import": "./src/core/commands/text-commands.ts"
     },
     "./core/commands/image-commands": {
-      "types": "./dist/core/commands/image-commands.d.ts",
-      "import": "./dist/core/commands/image-commands.js",
-      "require": "./dist/core/commands/image-commands.cjs"
+      "types": "./src/core/commands/image-commands.ts",
+      "import": "./src/core/commands/image-commands.ts"
     },
     "./core/selection/mapping": {
-      "types": "./dist/core/selection/mapping.d.ts",
-      "import": "./dist/core/selection/mapping.js",
-      "require": "./dist/core/selection/mapping.cjs"
+      "types": "./src/core/selection/mapping.ts",
+      "import": "./src/core/selection/mapping.ts"
     },
     "./ui-tailwind/editor-surface/search-plugin": {
-      "types": "./dist/ui-tailwind/editor-surface/search-plugin.d.ts",
-      "import": "./dist/ui-tailwind/editor-surface/search-plugin.js",
-      "require": "./dist/ui-tailwind/editor-surface/search-plugin.cjs"
+      "types": "./src/ui-tailwind/editor-surface/search-plugin.ts",
+      "import": "./src/ui-tailwind/editor-surface/search-plugin.ts"
     },
     "./core/commands/table-structure-commands": {
-      "types": "./dist/core/commands/table-structure-commands.d.ts",
-      "import": "./dist/core/commands/table-structure-commands.js",
-      "require": "./dist/core/commands/table-structure-commands.cjs"
+      "types": "./src/core/commands/table-structure-commands.ts",
+      "import": "./src/core/commands/table-structure-commands.ts"
     },
     "./core/commands/style-commands": {
-      "types": "./dist/core/commands/style-commands.d.ts",
-      "import": "./dist/core/commands/style-commands.js",
-      "require": "./dist/core/commands/style-commands.cjs"
+      "types": "./src/core/commands/style-commands.ts",
+      "import": "./src/core/commands/style-commands.ts"
     },
     "./core/commands/section-layout-commands": {
-      "types": "./dist/core/commands/section-layout-commands.d.ts",
-      "import": "./dist/core/commands/section-layout-commands.js",
-      "require": "./dist/core/commands/section-layout-commands.cjs"
+      "types": "./src/core/commands/section-layout-commands.ts",
+      "import": "./src/core/commands/section-layout-commands.ts"
     },
     "./core/state/editor-state": {
-      "types": "./dist/core/state/editor-state.d.ts",
-      "import": "./dist/core/state/editor-state.js",
-      "require": "./dist/core/state/editor-state.cjs"
+      "types": "./src/core/state/editor-state.ts",
+      "import": "./src/core/state/editor-state.ts"
     },
-    "./ui-tailwind/theme/editor-theme.css": "./dist/ui-tailwind/theme/editor-theme.css"
-  },
-  "types": "./dist/index.d.ts",
-  "scripts": {
-    "build": "tsup && mkdir -p dist/ui-tailwind/theme && cp src/ui-tailwind/theme/editor-theme.css dist/ui-tailwind/theme/editor-theme.css",
-    "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:repo:browser-ui": "node scripts/run-repo-tests.mjs browser-ui",
-    "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"
+    "./ui-tailwind/theme/editor-theme.css": "./src/ui-tailwind/theme/editor-theme.css"
   },
+  "types": "./src/index.ts",
   "keywords": [
     "docx",
     "word",
@@ -196,14 +150,29 @@
     "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:repo:browser-ui": "node scripts/run-repo-tests.mjs browser-ui",
+    "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/README.md

@@ -0,0 +1,85 @@
+# Source Layout
+
+The landed source tree is still organized around the active docx implementation, not around the future target office-wide layout.
+
+## Current Landed Layout
+
+```text
+src/
+  api/
+  model/
+  core/
+    schema/
+    state/
+    commands/
+    selection/
+  review/
+    store/
+  io/
+    opc/
+    ooxml/
+    normalize/
+    export/
+  preservation/
+  validation/
+  runtime/
+  ui/
+    headless/            # Shared pure logic (framework-free)
+    shared/              # Shared utilities (revision-filters)
+    WordReviewEditor.tsx  # Entry point
+  ui-tailwind/           # Default rendering (Tailwind + Radix + Lucide)
+    editor-surface/
+    toolbar/
+    review/
+    status/
+    chrome/
+    theme/
+```
+
+This is the truthful current layout for implementation work today.
+
+## Target Broader Layout
+
+The broader repo story now targets a future layout like this:
+
+```text
+src/
+  platform/
+  formats/
+    docx/
+    xlsx/
+    pdf/
+```
+
+That layout is not landed yet. Use it as a planning direction, not as evidence that the current code has already been reorganized.
+
+## UI Layer Strategy
+
+- `ui/headless/` — Pure logic: keyboard handling, decoration models, selection utilities. No React dependencies.
+- `ui-tailwind/` — Default rendering: Tailwind CSS, Radix UI primitives, Lucide icons. All styling via CSS custom properties.
+- `ui/WordReviewEditor.tsx` — Public entry point that bridges the runtime to the Tailwind layer.
+
+Legacy inline-CSSProperties components have been removed. See `docs/reference/word-review-editor-frontend-architecture.md` for the canonical frontend architecture.
+
+Keep business rules close to the subsystem that owns them. Do not centralize unrelated logic into generic utility layers.
+
+Ownership rules:
+
+- `api` exposes public contracts only.
+- `model`, `core`, `review`, `io`, `preservation`, and `validation` should remain React-free when possible.
+- `runtime` is the only mutation boundary the UI calls into.
+- `ui` consumes runtime contracts and design tokens; it does not own canonical document truth.
+
+## Broader Repo Direction
+
+As the repo broadens:
+
+- shared package and preservation concerns should move toward `src/platform/`
+- current docx runtime code remains the active implementation track until a deliberate source move lands
+- future xlsx work should gain its own source area rather than widening docx-specific modules by implication
+- future pdf work should remain separate from the first OOXML platform layer unless architecture decisions intentionally broaden it
+
+Wave 0 inventory references:
+
+- `component-inventory.md`
+  Wave-owned inventory for the major editor subsystems, their boundaries, and the promotion target for this scaffold phase.

package/src/api/README.md

@@ -0,0 +1,26 @@
+# API
+
+Public TypeScript contracts for `WordReviewEditor` belong here.
+
+This layer should expose:
+
+- component props and ref types
+- session-state and snapshot compatibility types
+- host adapter and datastore adapter interfaces
+- runtime-derived position and selection projection types used by the public API
+- discriminated event unions
+- warning and error payloads
+- persisted snapshot contracts
+- export and compatibility report types
+
+Do not place runtime logic here.
+
+Frozen naming and boundary rules:
+
+- the shipped component name is `WordReviewEditor`
+- `DocumentRuntime` is an internal runtime contract, not a public React component name
+- `EditorSessionState` is the canonical host-facing live-session contract
+- `PersistedEditorSnapshot` is the legacy/store compatibility envelope
+- `EditorHostAdapter` is the preferred persistence boundary; `EditorDatastoreAdapter` remains the snapshot-compatible bridge
+- public range references are canonical-position projections, not DOM-path handles
+- render snapshots stay in `src/runtime`; `src/api` only exposes persisted host-facing snapshot types