revise 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,133 @@
 # Changelog
 
+## 2.1.0
+
+### Added
+
+- **`source` on document inputs.** `{ id, source: file }` names the field for
+  what it takes: DOCX, Markdown, plain text, or HTML. `docx` still works as the
+  same field; passing both with different values throws.
+- **`context_notes` is optional in typed host calls.** `tools.execute()` and
+  `tools.call()` (browser and `revise/server`) fill in `"N/A"` for the read and
+  search tools, so application code no longer passes a model's working memory.
+  `executeDynamic()` keeps the schema requirement for model-provided calls.
+- **`leave_comment` reports a retargeted anchor.** When the anchor text is not
+  in the named block and the comment goes to the only read block that has it,
+  `data.requestedBlockId` names the block you asked for and the message says so.
+
+- **`read_table` and `edit_table_cells` agent tools.** Read a large table in
+  bounded windows (a summary, up to 50 rows, or one oversized cell in pages),
+  then set the plain text of up to 50 cells per call by row ID and column.
+  Cell text is written literally. Only cells a `read_table` call returned in
+  full can be edited, and that read stays valid across later `execute()` calls
+  on the same document while the cell and table geometry remain unchanged.
+  An invalid target rejects the whole batch with no changes. In suggesting mode each cell is its own suggestion. Read-only
+  surfaces and viewers get `read_table` only. Both tools are also in the
+  `revise/server` session. The SDK's `read_table` does not take the native
+  agent's task-declaration arguments (`task_kind`, `scope_*`,
+  `source_attachment_id`, `deliberate_blanks`). They are left out of the
+  published schema, and a call that supplies one fails with
+  `unsupported_argument` without reading anything. Empty placeholders
+  (`null`, `""`, `[]`) are ignored.
+
+### Changed
+
+- **The delegated agent plans long tasks.** `agent.run()`, `revise_run_agent`,
+  and comment agents keep a step-by-step plan for multi-step work, update it
+  in the same turns as their edits, and save it with the conversation, so
+  fewer turns go to bookkeeping. The embedded tool list is unchanged: plan
+  tools stay inside the delegated agent.
+- **Faster on long documents.** The scrollbar track and its markers are drawn
+  once and reused while scrolling, Find reuses each block's normalized text
+  between keystrokes, and tracked-change records are indexed in one pass
+  instead of one document walk per suggestion.
+
+### Fixed
+
+- **DOCX paragraph spacing follows the document's rules.** `w:contextualSpacing` no longer
+  zeroes a paragraph's declared space before and after on import. Spacing is
+  resolved from neighboring paragraphs on screen, in table cells and
+  containers, and in PDF export: the gap between two paragraphs is the larger
+  of their spacings, not the sum, and contextual spacing drops it only between
+  paragraphs of the same style. PDF keep-with-next reserves the whole gap, and
+  exported DOCX keeps the declared spacing. Documents whose paragraphs both
+  declare spacing lay out tighter than in 2.0.x.
+- **`style_blocks` with `list-style-type: none` turns list items into plain
+  paragraphs**, keeping their spacing and line spacing and applying the call's
+  other paragraph attributes in the same step.
+- **Unsupported DOCX content can be suggested for removal.** In suggesting
+  mode, removing a block the editor preserves but cannot render (an opaque
+  DOCX payload) now becomes a tracked deletion.
+- **Comment previews keep their layout.** In a comment chip's hover preview,
+  the avatar holds its size and a long author name is truncated.
+- **An editor with no agent configured sends nothing.** `agent.run()`, the
+  `revise_run_agent` tool, and comment agents used to stream the document,
+  unauthenticated, to Revise's hosted agent and then report a generic
+  connection error. Without a `turnStream`, `baseUrl`, or `token`, they now
+  fail at once with `agent_not_configured` (`AgentNotConfiguredError` from
+  `agent.run()`), and `getToolDefinitions()` leaves the delegation tool out.
+- **`documents.open()` activates the new document every time.** Opening a
+  document straight after another open, or after `documents.activate()`, left
+  the earlier one active. `documents.list()` status was also briefly stale
+  right after a document became ready.
+- **`tools.getDefinitions()` lists only the native tools.** It included
+  `revise_run_agent`, which the docs say it leaves out.
+- **Changing `agent.turnStream` no longer reloads the document.** A new
+  `turnStream` or `disableMetrics` value re-created the document runtime,
+  re-parsing the source and dropping unsaved edits, so an inline generator in
+  JSX reloaded the document on every render. Agent settings now apply to the
+  next run in place.
+- **Reads are not refused for the life of the editor.** After a window had
+  been read once, every later `read_blocks_from_index` of it failed with
+  `no_new_read_context`, so a host agent's second conversation could not read
+  the document. The guard now resets with each call, like the other per-turn
+  limits.
+- **Tool errors speak to SDK callers.** Messages no longer carry the internal
+  `Failed operation: <tool>: <Error>:` prefix or point at `<document_content>`,
+  which only Revise's own agent sees; they point at read results instead.
+- **The open-error screen shows a plain message.** A corrupt file showed the
+  parser's internals (a zip library's message and link) to the person who
+  picked it. `onError` still receives the full detail. Loading text no longer
+  says "DOCX" for other formats, and a `File` source's title drops `.md`,
+  `.txt`, and `.html` extensions as well as `.docx`.
+- **PDF export requests a failing font once.** When a font download failed
+  (a CSP or firewall blocking revise.io, say), export requested the same URL a
+  second time. The warning now says a fallback font was used and names
+  `setAssetBaseUrl()` for mirroring the fonts.
+- **Readable errors from the package in Node.** Bundled code is wrapped at
+  short lines, so an uncaught error (such as the missing-`jsdom` hint) is no
+  longer printed under a 100 KB line of minified source.
+- **Quieter host builds.** Vite no longer warns that `"buffer"` was
+  externalized, or prints the inlined WebAssembly's base64 as a file that
+  "doesn't exist at build time".
+
+## 2.0.1
+
+### Added
+
+- **`tools.export({ format, mode })`.** Export as DOCX, PDF, HTML, Markdown,
+  or plain text from code, not just the ribbon's Export menu. `mode: "final"`
+  accepts every pending change and drops comments first for a clean copy;
+  the default `"review"` keeps tracked changes and comments in a .docx. The
+  editor-level `tools.export(options, documentId?)` routes to any open
+  document.
+- **`exportDocument(source, options)` in `revise/server`.** The same export
+  for a room or a parsed document on the server: DOCX, HTML, Markdown, and
+  plain text, in review or final mode.
+- **`onImageUpload(file, documentId)`.** Store images users insert, paste, or
+  drop in your own storage and return the URL the document should use.
+
+### Fixed
+
+- **Inserting, pasting, or dropping an image works.** It used to post to
+  Revise's app API, which the SDK cannot reach, so the image never appeared.
+  Without `onImageUpload`, images are now embedded in the document as data
+  URLs and export into the .docx. `toolbar.insertImage()` resolves `false`
+  when an upload fails, and the failure reaches `onError`.
+- **Docs:** linked moves are described correctly in Support, the reserved
+  collaboration keys point to `RESERVED_DOCUMENT_KEYS`, and the delegated
+  agent page says how to get hosted-agent access.
+
 ## 2.0.0
 
 The SDK is now public: `npm i revise`. No account, token, or contact

package/README.md

@@ -19,7 +19,7 @@ import "revise/style.css";
 export function DocumentPane({ file }: { file: File }) {
   return (
     <ReviseEditor
-      initialDocuments={[{ id: "contract-1", title: "Contract", docx: file }]}
+      initialDocuments={[{ id: "contract-1", title: "Contract", source: file }]}
       onChange={(documentId, document) => {
         console.log(documentId, "now has", document.children.length, "blocks");
       }}
@@ -28,6 +28,9 @@ export function DocumentPane({ file }: { file: File }) {
 }
 ```
 
+The editor sends Revise one anonymous ping per page load, with its version and
+no user data or document content. Pass `telemetry={false}` to turn it off.
+
 Refer to the [SDK Docs](https://developer.revise.io/editor-sdk) for the full editor API, including agentic tool calling.
 
 ## License