@arbidocs/blocks 0.4.27 → 0.4.28

package/README.md

@@ -230,6 +230,23 @@ connection layer use `useShellWorkspaces` from `@arbidocs/react` and pass your o
 Small helpers for host copy: `formatCount(1, { one: 'document', other: 'documents' })` and
 `displayName(user)` for greetings. See `examples/custom-ui/HomePage.tsx`.
 
+## Streaming drafts in Word
+
+Use `ConnectedStreamedWordArtifact` from `@arbidocs/blocks/connect/docx` inside an
+ARBI connection, or `StreamedWordArtifact` from `@arbidocs/blocks/docx` with your
+own `NativeDocxAdapter`. Pass a stable `draftId`, the current Markdown `content`,
+`title`, and `busy`. The existing `AiMarkdown` renderer supplies HTML to the native
+Word engine; completed blocks stay in place while the unfinished block updates.
+
+Human editing and Save are locked during generation and the first DOCX save.
+Successful completion stores a DOCX and opens its collaborative editor. `onSaved`
+receives that document ID; `sourceDocumentId` optionally preserves source version
+lineage. A generation or storage error retains the read-only draft for recovery.
+This widget does not replace native tracked-edit operations for existing DOCX files.
+
+Run the real-engine streaming checks from the repository root with
+`npx playwright test -c packages/arbi-blocks/playwright.docx.config.ts`.
+
 ## Workspace isolation
 
 Blocks hold no keys and do no crypto. Parts take the data of one workspace and never merge data