@beyondwork/docx-react-component 1.0.0 → 1.0.1

package/docs/plans/waves/wave-21.md

@@ -1,289 +0,0 @@
-# Wave 21 - API Reference And npm Package
-
-**Commit message**: `Build: API reference, quick-start docs, and npm package`
-
-## Project profile
-
-- project: React Word Editor
-- new-project: no
-- oversight-mode: dark-factory
-- lane: main
-
-## Sequencing note
-
-- Phase 3 of the shipping roadmap. Ship the component so others can use it.
-
-## Reference rule
-
-- Read the roadmap, current-state, and master-plan before execution.
-
-## Component promotions
-
-- npm-package-distribution: baseline-proved
-
-## Context7 defaults
-
-- bundle: word-editor-contracts
-- query: "React component API documentation, npm package publishing, ESM entry points, peer dependencies"
-
-## Agent A0: cont-QA
-
-### Role prompts
-
-- docs/agents/wave-cont-qa-role.md
-
-### Executor
-
-- profile: deep-review
-
-### Context7
-
-- bundle: none
-- query: "Architecture evaluation only; repository docs remain canonical"
-
-### Deliverables
-
-- docs/plans/waves/reviews/wave-21-cont-qa.md
-
-### Prompt
-
-```text
-Primary goal:
-- Verify documentation accuracy and package configuration correctness.
-
-Required context before coding:
-- docs/reference/repository-guidance.md
-- docs/research/agent-context-sources.md
-- docs/roadmap.md
-
-File ownership (only touch these paths):
-- docs/plans/waves/reviews/wave-21-cont-qa.md
-
-Requirements:
-1) Verify API docs match actual source exports.
-2) Verify `pnpm pack` succeeds.
-3) Verify peer dependencies are correct.
-
-Output:
-- Summarize the cont-QA verdict.
-```
-
-## Agent A8: Integration Steward
-
-### Role prompts
-
-- docs/agents/wave-integration-role.md
-
-### Executor
-
-- profile: deep-review
-
-### Context7
-
-- bundle: none
-- query: "Integration synthesis only; repository docs remain canonical"
-
-### Capabilities
-
-- integration
-- docs-shared-plan
-
-### Deliverables
-
-- .tmp/main-wave-launcher/integration/wave-21.md
-- .tmp/main-wave-launcher/integration/wave-21.json
-
-### Prompt
-
-```text
-Primary goal:
-- Synthesize the final Wave 21 state.
-
-Required context before coding:
-- docs/reference/repository-guidance.md
-- docs/research/agent-context-sources.md
-- docs/plans/current-state.md
-- docs/plans/master-plan.md
-
-File ownership (only touch these paths):
-- .tmp/main-wave-launcher/integration/wave-21.md
-- .tmp/main-wave-launcher/integration/wave-21.json
-
-Output:
-- Summarize the integration verdict and closure recommendation.
-```
-
-## Agent A9: Documentation Steward
-
-### Role prompts
-
-- docs/agents/wave-documentation-role.md
-
-### Executor
-
-- profile: docs-pass
-
-### Context7
-
-- bundle: none
-- query: "Shared plan documentation only; repository docs remain canonical"
-
-### Deliverables
-
-- docs/roadmap.md
-- docs/plans/current-state.md
-- docs/plans/master-plan.md
-- docs/plans/migration.md
-- docs/plans/component-cutover-matrix.md
-- docs/plans/component-cutover-matrix.json
-
-### Prompt
-
-```text
-Primary goal:
-- Keep shared plan docs aligned with Wave 21 packaging work.
-
-Required context before coding:
-- docs/reference/repository-guidance.md
-- docs/research/agent-context-sources.md
-- docs/plans/current-state.md
-- docs/plans/master-plan.md
-
-File ownership (only touch these paths):
-- docs/roadmap.md
-- docs/plans/current-state.md
-- docs/plans/master-plan.md
-- docs/plans/migration.md
-- docs/plans/component-cutover-matrix.md
-- docs/plans/component-cutover-matrix.json
-
-Output:
-- Summarize shared doc updates.
-```
-
-## Agent A1: API Documentation And Quick-Start
-
-### Executor
-
-- profile: docs-pass
-
-### Context7
-
-- bundle: word-editor-contracts
-- query: "React component API, WordReviewEditor props, DocumentRuntime, canonical document model types"
-
-### Components
-
-- npm-package-distribution
-
-### Deliverables
-
-- docs/reference/api-reference.md
-- docs/reference/quick-start.md
-- docs/reference/integration-guide.md
-- .tmp/wave-21-pkg-proof/docs-review.md
-
-### Proof artifacts
-
-- path: .tmp/wave-21-pkg-proof/docs-review.md | kind: proof-note | required-for: baseline-proved
-
-### Exit contract
-
-- completion: authoritative
-- durability: durable
-- proof: unit
-- doc-impact: owned
-
-### Prompt
-
-```text
-Primary goal:
-- Write complete API documentation for the WordReviewEditor component.
-
-Required context before coding:
-- docs/reference/repository-guidance.md
-- docs/research/agent-context-sources.md
-- Read src/ui/WordReviewEditor.tsx for all props and exported types.
-- Read src/runtime/document-runtime.ts for runtime API.
-- Read src/model/canonical-document.ts for document model types.
-- Read src/api/public-types.ts for public type exports.
-
-File ownership (only touch these paths):
-- docs/reference/api-reference.md
-- docs/reference/quick-start.md
-- docs/reference/integration-guide.md
-- .tmp/wave-21-pkg-proof/docs-review.md
-
-Requirements:
-1) api-reference.md: every prop, ref method, event, and exported type.
-2) quick-start.md: install, import, render, load a .docx, export — working code.
-3) integration-guide.md: datastore adapter, autosave, persistence.
-
-Output:
-- Summarize documentation coverage.
-```
-
-## Agent A2: npm Package Configuration
-
-### Executor
-
-- profile: implement-fast
-- budget.minutes: 40
-
-### Context7
-
-- bundle: word-editor-contracts
-- query: "npm package configuration, ESM exports, peer dependencies, GitHub Actions publish workflow"
-
-### Components
-
-- npm-package-distribution
-
-### Deliverables
-
-- package.json
-- README.md
-- .github/workflows/publish.yml
-- .tmp/wave-21-pkg-proof/pack-test.md
-
-### Proof artifacts
-
-- path: .tmp/wave-21-pkg-proof/pack-test.md | kind: proof-note | required-for: baseline-proved
-
-### Exit contract
-
-- completion: authoritative
-- durability: durable
-- proof: unit
-- doc-impact: owned
-
-### Prompt
-
-```text
-Primary goal:
-- Configure the package for npm publishing.
-
-Required context before coding:
-- docs/reference/repository-guidance.md
-- docs/research/agent-context-sources.md
-- Read package.json.
-- Read src/ entry points.
-
-File ownership (only touch these paths):
-- package.json
-- README.md
-- .github/workflows/publish.yml
-- .tmp/wave-21-pkg-proof/pack-test.md
-
-Requirements:
-1) Remove "private": true.
-2) Set up ESM exports and type declarations.
-3) Declare peer dependencies: react, react-dom, prosemirror-*.
-4) Add "files" field.
-5) Create publish workflow on release tag.
-6) Rewrite README to lead with shipped product.
-7) Verify `pnpm pack` works.
-
-Output:
-- Summarize package configuration and remaining steps.
-```

package/docs/plans/waves/wave-22.md

@@ -1,221 +0,0 @@
-# Wave 22 - OpenXML Validator In CI
-
-**Commit message**: `Build: OpenXML SDK validator in CI pipeline`
-
-## Project profile
-
-- project: React Word Editor
-- new-project: no
-- oversight-mode: dark-factory
-- lane: main
-
-## Sequencing note
-
-- Phase 4 of the shipping roadmap. Wire the existing validator service into CI.
-
-## Reference rule
-
-- Read the roadmap, current-state, and master-plan before execution.
-
-## Component promotions
-
-- openxml-sdk-validator-service: qa-proved
-
-## Context7 defaults
-
-- bundle: word-editor-testing
-- query: "OpenXML SDK validation, OOXML compliance checking, fixture validation in CI"
-
-## Agent A0: cont-QA
-
-### Role prompts
-
-- docs/agents/wave-cont-qa-role.md
-
-### Executor
-
-- profile: deep-review
-
-### Context7
-
-- bundle: none
-- query: "Architecture evaluation only; repository docs remain canonical"
-
-### Deliverables
-
-- docs/plans/waves/reviews/wave-22-cont-qa.md
-
-### Prompt
-
-```text
-Primary goal:
-- Verify validator is correctly integrated into CI.
-
-Required context before coding:
-- docs/reference/repository-guidance.md
-- docs/research/agent-context-sources.md
-- docs/roadmap.md
-
-File ownership (only touch these paths):
-- docs/plans/waves/reviews/wave-22-cont-qa.md
-
-Output:
-- Summarize the cont-QA verdict.
-```
-
-## Agent A8: Integration Steward
-
-### Role prompts
-
-- docs/agents/wave-integration-role.md
-
-### Executor
-
-- profile: deep-review
-
-### Context7
-
-- bundle: none
-- query: "Integration synthesis only; repository docs remain canonical"
-
-### Capabilities
-
-- integration
-- docs-shared-plan
-
-### Deliverables
-
-- .tmp/main-wave-launcher/integration/wave-22.md
-- .tmp/main-wave-launcher/integration/wave-22.json
-
-### Prompt
-
-```text
-Primary goal:
-- Synthesize Wave 22 state.
-
-Required context before coding:
-- docs/reference/repository-guidance.md
-- docs/research/agent-context-sources.md
-- docs/plans/current-state.md
-
-File ownership (only touch these paths):
-- .tmp/main-wave-launcher/integration/wave-22.md
-- .tmp/main-wave-launcher/integration/wave-22.json
-
-Output:
-- Integration verdict and closure recommendation.
-```
-
-## Agent A9: Documentation Steward
-
-### Role prompts
-
-- docs/agents/wave-documentation-role.md
-
-### Executor
-
-- profile: docs-pass
-
-### Context7
-
-- bundle: none
-- query: "Shared plan documentation only; repository docs remain canonical"
-
-### Deliverables
-
-- docs/roadmap.md
-- docs/plans/current-state.md
-- docs/plans/master-plan.md
-- docs/plans/migration.md
-- docs/plans/component-cutover-matrix.md
-- docs/plans/component-cutover-matrix.json
-
-### Prompt
-
-```text
-Primary goal:
-- Keep shared plan docs aligned with Wave 22.
-
-Required context before coding:
-- docs/reference/repository-guidance.md
-- docs/research/agent-context-sources.md
-- docs/plans/current-state.md
-
-File ownership (only touch these paths):
-- docs/roadmap.md
-- docs/plans/current-state.md
-- docs/plans/master-plan.md
-- docs/plans/migration.md
-- docs/plans/component-cutover-matrix.md
-- docs/plans/component-cutover-matrix.json
-
-Output:
-- Summarize shared doc updates.
-```
-
-## Agent A1: Validator CI Integration
-
-### Executor
-
-- profile: implement-fast
-
-### Context7
-
-- bundle: word-editor-testing
-- query: "OpenXML SDK validator, Docker in CI, fixture validation script"
-
-### Components
-
-- openxml-sdk-validator-service
-
-### Deliverables
-
-- .github/workflows/ci.yml
-- scripts/validate-fixtures.sh
-- docs/reference/validation-guide.md
-- .tmp/wave-22-validator-proof/ci-validation.md
-
-### Proof artifacts
-
-- path: .tmp/wave-22-validator-proof/ci-validation.md | kind: proof-note | required-for: qa-proved
-
-### Exit contract
-
-- completion: authoritative
-- durability: durable
-- proof: integration
-- doc-impact: owned
-
-### Prompt
-
-```text
-Primary goal:
-- Wire the OpenXML SDK validator into CI so every PR validates exported fixtures.
-
-Required context before coding:
-- docs/reference/repository-guidance.md
-- docs/research/agent-context-sources.md
-- Read services/openxml-validator/ for the existing validator service.
-- Read .github/workflows/ci.yml for current CI setup.
-- Read test/io/ for fixture patterns.
-- Read docs/roadmap.md Phase 4 requirements.
-
-File ownership (only touch these paths):
-- .github/workflows/ci.yml
-- scripts/validate-fixtures.sh
-- docs/reference/validation-guide.md
-- .tmp/wave-22-validator-proof/ci-validation.md
-
-Requirements:
-1) CI step: export all fixtures → run through SDK validator → fail on errors.
-2) scripts/validate-fixtures.sh runs locally too.
-3) Document the Word reopen manual release gate.
-4) Validator service containerized for CI (Docker).
-
-Validation:
-- pnpm test:repo
-
-Output:
-- Summarize validator integration and remaining gaps.
-```