revise 2.0.0 → 2.1.0

package/chunks/web-tree-sitter-BXGZGnNj.js

@@ -1 +1,2 @@
-class e{constructor(t){this.endIndex=t,this.childCount=0,this.startIndex=0,this.parent=null,this.type="text"}child(){return this}}class s{static async load(){return new s}}class n{static async init(){}setLanguage(){}parse(t){return{rootNode:new e(t.length)}}}export{s as Language,n as Parser};
+class e{constructor(t){this.endIndex=t,this.childCount=0,this.startIndex=0,this.parent=null,this.type="text"}child(){return this}}class s{static async load(){return new s}}class n{static async init(){}setLanguage(){}parse(t){
+return{rootNode:new e(t.length)}}}export{s as Language,n as Parser};

package/full.js

@@ -1 +1 @@
-import{c8 as s,c7 as a,ca as e,cd as c,cb as r,c9 as o,ca as E,ce as t,cc as R}from"./chunks/index-F-kHIwWT.js";export{s as REVISE_SDK_BUILD,a as REVISE_SDK_VERSION,e as ReviseEditor,c as ReviseRoleError,r as ReviseToolError,o as createEmptyDocx,E as default,t as rolePolicy,R as setAssetBaseUrl};
+import{cf as s,ce as a,ch as e,ck as r,ci as c,cg as o,ch as E,cl as t,cj as i}from"./chunks/index-C-4H81OE.js";export{s as REVISE_SDK_BUILD,a as REVISE_SDK_VERSION,e as ReviseEditor,r as ReviseRoleError,c as ReviseToolError,o as createEmptyDocx,E as default,t as rolePolicy,i as setAssetBaseUrl};

package/index.d.ts

@@ -2,8 +2,8 @@ import * as React from "react";
 // The canonical tool contract, shared verbatim with the backend entry: the
 // browser surface returns the same envelopes and throws the same error.
 import type {
+  ReviseHostToolInput,
   ReviseSuggestionDecision,
-  ReviseToolInput,
   ReviseToolName,
   ReviseToolResponse,
   ReviseToolResult,
@@ -66,15 +66,27 @@ export type ReviseAgentTurnStream = (
   request: ReviseAgentTurnRequest,
 ) => AsyncGenerator<ReviseAgentStreamEvent, void, unknown>;
 
+/** Where agent work goes, and how it is signed. Configure one transport —
+ * `turnStream`, `baseUrl`, or `token` — or agent runs fail fast with
+ * `agent_not_configured` and send nothing. */
 export interface ReviseAgentConfig {
-  /** Display name for comments and tracked changes. Defaults to Revise Agent. */
+  /** Display name for comments and tracked changes made through
+   * `tools.execute` and agent runs. Defaults to "Revise Agent". */
   name?: string;
+  /** Your own Revise agent backend. Without it, runs go to Revise's hosted
+   * agent, which needs a `token`. */
   baseUrl?: string;
+  /** Bearer token. Required for Revise's hosted agent; an anonymous
+   * `baseUrl` backend needs none. */
   token?: string;
   conversationId?: string;
   provider?: string;
   model?: string;
+  /** Run turns through your own model or gateway. Changing it takes effect on
+   * the next run, without reopening the document. */
   turnStream?: ReviseAgentTurnStream;
+  /** Skip the run-completion call (cost accounting) to the agent backend at
+   * `baseUrl`. Implied by `turnStream`. */
   disableMetrics?: boolean;
 }
 
@@ -121,10 +133,12 @@ export interface ReviseEditorToolExecutionOptions {
 
 /** Tool arguments, with input optional only when its schema has no required
  * fields — the browser twin of the server contract's argument tuple. */
+/** Typed host arguments. `context_notes` is optional here and defaults to
+ * "N/A"; `executeDynamic()`, for model-provided calls, still requires it. */
 export type ReviseEditorToolArguments<Name extends ReviseToolName> =
-  Record<string, never> extends ReviseToolInput<Name>
-    ? [input?: ReviseToolInput<Name>, options?: ReviseEditorToolExecutionOptions]
-    : [input: ReviseToolInput<Name>, options?: ReviseEditorToolExecutionOptions];
+  Record<string, never> extends ReviseHostToolInput<Name>
+    ? [input?: ReviseHostToolInput<Name>, options?: ReviseEditorToolExecutionOptions]
+    : [input: ReviseHostToolInput<Name>, options?: ReviseEditorToolExecutionOptions];
 
 export interface ReviseEditorTool extends ReviseEditorToolDefinition {
   execute(
@@ -158,6 +172,13 @@ export interface ReviseEditorTools {
   ): Promise<ReviseToolResponse<Name>>;
   getDefinitions(): ReviseEditorToolDefinition[];
   exportDocx(): Promise<Blob>;
+  /**
+   * Export the document as a file. `format` defaults to "docx". In
+   * "review" mode (the default) a .docx keeps pending tracked changes and
+   * comments; other formats show the text with changes accepted. "final"
+   * accepts every pending change and drops comments first: a clean copy.
+   */
+  export(options?: ReviseExportOptions): Promise<Blob>;
   /** Settle every open suggestion, collaborators' included. Prefer ID-based
    * review.acceptSuggestions() with IDs from mutation results. */
   acceptAllSuggestions(): ReviseSuggestionDecision;
@@ -229,6 +250,14 @@ export type InlineFormattingCommand =
   | "superscript"
   | "subscript";
 
+/** File formats `tools.export()` can produce. */
+export type ReviseExportFormat = "docx" | "pdf" | "html" | "markdown" | "txt";
+
+export interface ReviseExportOptions {
+  format?: ReviseExportFormat;
+  mode?: "review" | "final";
+}
+
 export type ReviseToolbarMode = "native" | "none";
 export type ReviseZoom = number | "fit-width";
 
@@ -631,10 +660,10 @@ export interface ReviseCollaborationConfig {
    * The recommended form: the editor builds the document and awareness with
    * the settings it requires, and this connects them.
    *
-   * The editor reserves eight top-level keys in the document — content,
-   * chrome, notes, comments, annotations, metadata, sdt-wrappers, paragraphs
-   * — so a document built elsewhere may already use those names or hold
-   * another schema. Let the editor build its own.
+   * The editor reserves the top-level keys listed in RESERVED_DOCUMENT_KEYS
+   * (content, comments, metadata, and others), so a document built elsewhere
+   * may already use those names or hold another schema. Let the editor build
+   * its own.
    */
   connect?: ReviseCollaborationConnect;
   /** A provider that already owns its document. The document is validated
@@ -702,10 +731,11 @@ export declare class ReviseRoleError extends Error {
 export interface ReviseTrackedChange {
   id: string;
   /** Word's three revision kinds, plus "move" for a linked move pair. A
-   * replacement appears as both a delete and an insert, as it does in Word.
-   * A linked move is ONE change: `deletedText` is the text at the source,
-   * `insertedText` the text at the destination, and resolving it settles
-   * both locations atomically. */
+   * replacement made in one operation (the agent's `replace` tool) is ONE
+   * change with both `deletedText` and `insertedText` set; its kind is
+   * the one it was recorded with, usually "delete". A linked move is also ONE
+   * change: `deletedText` is the text at the source, `insertedText` the
+   * text at the destination, and resolving it settles both locations. */
   kind: "insert" | "delete" | "format" | "move";
   /** A person, "Revise Agent", an external agent, or "Anonymous". */
   author: string;
@@ -728,8 +758,11 @@ export interface ReviseTrackedChange {
 export interface ReviseDocumentInput {
   /** Stable host-owned ID used by APIs, agent tools, and callbacks. */
   id: string;
-  /** The source document: DOCX, Markdown, plain text, or HTML. Optional when
-   * joining an established collaborative document. */
+  /** The document to open: DOCX, Markdown, plain text, or HTML. Optional
+   * when joining an established collaborative document. */
+  source?: ReviseDocumentSource;
+  /** The original name for `source`, accepted for compatibility. Pass one
+   * or the other. */
   docx?: ReviseDocumentSource;
   /** Share this document over a Yjs transport you own. */
   collaboration?: ReviseCollaborationConfig;
@@ -790,6 +823,7 @@ export type ReviseDocumentScoped<T> = T & {
 export interface ReviseMultiDocumentTools extends ReviseEditorTools {
   forDocument(documentId: string): ReviseEditorTools;
   exportDocx(documentId?: string): Promise<Blob>;
+  export(options?: ReviseExportOptions, documentId?: string): Promise<Blob>;
   acceptAllSuggestions(documentId?: string): ReviseSuggestionDecision;
   rejectAllSuggestions(documentId?: string): ReviseSuggestionDecision;
 }
@@ -862,7 +896,8 @@ export interface ReviseEditorProps {
   /** Once per page load, the SDK sends Revise one anonymous ping carrying
    * its version; the browser adds your site's origin. Development hosts
    * (localhost and similar) are only counted, never named. No cookies, user
-   * data, or document content. Set false to turn it off. Defaults to true. */
+   * data, or document content. Set false to turn it off. Defaults to true.
+   * An agent, when you configure one, talks only to the backend you chose. */
   telemetry?: boolean;
   initialDocuments?: readonly ReviseDocumentInput[];
   /** Controlled active document ID. */
@@ -909,6 +944,13 @@ export interface ReviseEditorProps {
   pageBorderColor?: string;
   toolbarMode?: ReviseToolbarMode;
   fonts?: readonly ReviseFontDefinition[];
+  /**
+   * Store an image the user inserts, pastes, or drops, and resolve to the URL
+   * the document should reference. Without it, images are embedded in the
+   * document as data URLs, which export into the .docx like any other image.
+   * A rejection shows the user a notice and reaches onError.
+   */
+  onImageUpload?: (file: File, documentId: string) => Promise<string>;
   className?: string;
   style?: React.CSSProperties;
   onReady?: (editor: ReviseEditorHandle) => void;

package/index.js

@@ -1 +1 @@
-import{c8 as s,c7 as a,ca as e,cd as c,cb as r,c9 as o,ca as E,ce as t,cc as R}from"./chunks/index-CLw_BlSL.js";export{s as REVISE_SDK_BUILD,a as REVISE_SDK_VERSION,e as ReviseEditor,c as ReviseRoleError,r as ReviseToolError,o as createEmptyDocx,E as default,t as rolePolicy,R as setAssetBaseUrl};
+import{cf as s,ce as a,ch as e,ck as r,ci as c,cg as o,ch as E,cl as t,cj as i}from"./chunks/index-iZC8xN0t.js";export{s as REVISE_SDK_BUILD,a as REVISE_SDK_VERSION,e as ReviseEditor,r as ReviseRoleError,c as ReviseToolError,o as createEmptyDocx,E as default,t as rolePolicy,i as setAssetBaseUrl};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "revise",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A word processor for React: DOCX in and out, real pagination, tracked changes, comments, collaboration, and agent tools. Free for evaluation, personal projects, and education.",
   "keywords": [
     "docx",
@@ -85,7 +85,7 @@
     "node": ">=18"
   },
   "license": "SEE LICENSE IN LICENSE",
-  "homepage": "https://revise.io",
+  "homepage": "https://revise.io/sdk",
   "bugs": {
     "email": "sdk@revise.io",
     "url": "https://developer.revise.io/editor-sdk/support"

package/root.js

@@ -1,2 +1,2 @@
-export const REVISE_SDK_VERSION = "2.0.0";
-export const REVISE_SDK_BUILD = "7bebae559";
+export const REVISE_SDK_VERSION = "2.1.0";
+export const REVISE_SDK_BUILD = "86f2c47ed";

package/serverToolContract.d.ts

@@ -221,7 +221,11 @@ export interface ReviseMutationData {
 
 export interface ReviseCommentData {
   commentId: string;
+  /** The block the comment is anchored to. */
   blockId: string;
+  /** Set when the requested block did not hold the anchor text and the
+   * comment went to the only read block that did. */
+  requestedBlockId?: string;
   anchor: ReviseJsonObject;
 }
 
@@ -253,11 +257,25 @@ export type ReviseToolDataMap = {
 export type ReviseToolData<Name extends ReviseToolName> =
   ReviseToolDataMap[Name];
 
+/**
+ * A tool's input as application code writes it for typed `execute()` and
+ * `call()`.
+ *
+ * `context_notes` is a model's working memory, carried from one read to the
+ * next, and the model-facing schemas require it. Host code keeps its own
+ * state, so the field is optional here and defaults to `"N/A"`.
+ * `executeDynamic()`, the path for model-provided calls, still requires it.
+ */
+export type ReviseHostToolInput<Name extends ReviseToolName> =
+  ReviseToolInput<Name> extends { context_notes: string }
+    ? Omit<ReviseToolInput<Name>, "context_notes"> & { context_notes?: string }
+    : ReviseToolInput<Name>;
+
 /** Tool arguments, with input optional only when its schema has no required fields. */
 export type ReviseToolArguments<Name extends ReviseToolName> =
-  Record<string, never> extends ReviseToolInput<Name>
-    ? [input?: ReviseToolInput<Name>, options?: ReviseToolCallOptions]
-    : [input: ReviseToolInput<Name>, options?: ReviseToolCallOptions];
+  Record<string, never> extends ReviseHostToolInput<Name>
+    ? [input?: ReviseHostToolInput<Name>, options?: ReviseToolCallOptions]
+    : [input: ReviseHostToolInput<Name>, options?: ReviseToolCallOptions];
 
 /** Semantic document context returned by read and search calls. */
 export interface ReviseDocumentContext {

package/serverToolInputs.generated.d.ts

@@ -1,5 +1,4 @@
-// Generated from backend/agent/internal/tools/definitions.go.
-// Run `npm run generate:sdk-tools` after changing agent tool schemas.
+// Input types for every Revise tool, generated from the tool schemas.
 export type ReviseJsonPrimitive = string | number | boolean | null;
 export type ReviseJsonValue =
   | ReviseJsonPrimitive
@@ -26,6 +25,19 @@ export interface ReviseToolInputMap {
     block_ids: Array<string>;
     context_notes: string;
   };
+  read_table: {
+    cell_id?: string;
+    column_count?: number;
+    column_start?: number;
+    context_notes: string;
+    continuation_revision?: string;
+    mode?: "summary" | "rows" | "cell_text";
+    row_count?: number;
+    row_ids?: Array<string>;
+    row_start?: number;
+    table_id: string;
+    text_offset?: number;
+  };
   measure_document: {
     heading_levels?: Array<1 | 2 | 3>;
     include_sections?: boolean;
@@ -215,6 +227,15 @@ export interface ReviseToolInputMap {
     columnIndex: number;
     tableId: string;
   };
+  edit_table_cells: {
+    cells: Array<{
+      column: number;
+      row_id: string;
+      text: string;
+    }>;
+    mode: "fill_if_empty" | "replace";
+    table_id: string;
+  };
   remove_block: {
     count?: number;
     id?: string;