@docx-editor.dev/editor-api 2.19.0 → 2.20.0

package/dist/{server-wsxDd90b.d.ts → server-mLIW1Y6U.d.ts}

@@ -1,4 +1,4 @@
-import { AutomationHandle, AutomationSpan, AutomationOperation, AutomationValue, AutomationSpanRef, AutomationHost, AutomationCapabilities, AutomationPaginationOptions } from '@docx-editor.dev/core/automation';
+import { AutomationHandle, AutomationSpan, AutomationOperation, AutomationValue, AutomationSpanRef, RevisionBatchResult, AutomationHost, AutomationCapabilities, AutomationPaginationOptions } from '@docx-editor.dev/core/automation';
 import { CollaborationModuleContribution } from '@docx-editor.dev/core/collaboration';
 
 /** Locations used by Office-shaped insertion calls. Each call validates its allowed subset. @public */
@@ -1025,6 +1025,39 @@ declare class ContentControlCollection extends HandleCollection<ContentControl>
     protected promised(label: string, nullable: boolean): ContentControl & PromisedItem;
 }
 
+/**
+ * A value a queued method promised to produce, readable after the next `sync()`.
+ *
+ * Deliberately not a `Promise`. A method call inside a batch has not been sent yet, so there is
+ * no pending work to await and nothing that could resolve on its own — awaiting one would
+ * deadlock a consumer who then never calls `sync()`. A result is a box that stays EMPTY until the
+ * sync fills it, and reading it early is `ValueNotLoaded` rather than `undefined` flowing onwards
+ * into something that misinterprets it.
+ *
+ * RevisionCollection.resolve returns a ClientResult with the resolved and skipped decisions.
+ *
+ * @public
+ */
+declare class ClientResult<T> {
+    #private;
+    /** @internal Use `clientResult()`; only the creator gets the filling half. */
+    private constructor();
+    /**
+     * The value, once a `sync()` has filled it in.
+     *
+     * Reading before then is `ValueNotLoaded` rather than `undefined`, so a mistake surfaces at the
+     * read instead of flowing onwards into something that misinterprets it.
+     */
+    get value(): T;
+    /** Whether the sync that fills this has happened. */
+    get isLoaded(): boolean;
+    /** @internal The box and the way to fill it, so only the creator can settle it. */
+    static create<T>(target: string): {
+        result: ClientResult<T>;
+        fill: (value: T) => void;
+    };
+}
+
 /**
  * Word's own names for a kind of change.
  *
@@ -1202,6 +1235,8 @@ declare class Revision extends ModelObject implements PromisedItem {
     reject(): void;
     /** @internal Plan the read this object's `load(...)` asked for. */
     protected onLoad(request: ResolvedLoadOptions): void;
+    /** @internal Capture a batch target without exposing engine identity. */
+    static batchHandle(revision: Revision, context: RequestContext): AutomationHandle;
 }
 /**
  * The tracked changes on a document, story or range, as of the batch that loaded them.
@@ -1228,6 +1263,22 @@ declare class RevisionCollection extends HandleCollection<Revision> {
     acceptAll(): void;
     /** Undo every change, likewise as one decision. */
     rejectAll(): void;
+    /**
+     * Resolve eligible revisions in this story and report skipped decisions after sync.
+     * Omit revisions to include unsupported and structural decisions absent from items.
+     * Pass an empty array to select nothing. Duplicate objects resolve once; stale targets
+     * are reported as unknown-revision. This must be the only write in its sync batch.
+     * Unlike acceptAll/rejectAll, unsupported decisions do not block independent changes.
+     *
+     * @example
+     * ```ts
+     * const result = context.document.revisions.resolve('accept');
+     * await context.sync();
+     * console.log(result.value.resolved.length, result.value.remaining);
+     * for (const skipped of result.value.skipped) console.log(skipped.reason);
+     * ```
+     */
+    resolve(action: 'accept' | 'reject', revisions?: readonly Revision[]): ClientResult<RevisionBatchResult>;
     /** @internal The read that answers this collection's members. */
     protected listing(): AutomationOperation;
     /** @internal Build one member from an address the listing answered. */
@@ -2208,40 +2259,6 @@ declare abstract class ClientObject implements RuntimeManagedObject {
     [REBIND](context: RequestContext): void;
 }
 
-/**
- * A value a queued method promised to produce, readable after the next `sync()`.
- *
- * Deliberately not a `Promise`. A method call inside a batch has not been sent yet, so there is
- * no pending work to await and nothing that could resolve on its own — awaiting one would
- * deadlock a consumer who then never calls `sync()`. A result is a box that stays EMPTY until the
- * sync fills it, and reading it early is `ValueNotLoaded` rather than `undefined` flowing onwards
- * into something that misinterprets it.
- *
- * This is a support type. No current public document method produces a ClientResult.
- * Document collections expose loaded `items`; read their length after `load('items')` and `sync()`.
- *
- * @public
- */
-declare class ClientResult<T> {
-    #private;
-    /** @internal Use `clientResult()`; only the creator gets the filling half. */
-    private constructor();
-    /**
-     * The value, once a `sync()` has filled it in.
-     *
-     * Reading before then is `ValueNotLoaded` rather than `undefined`, so a mistake surfaces at the
-     * read instead of flowing onwards into something that misinterprets it.
-     */
-    get value(): T;
-    /** Whether the sync that fills this has happened. */
-    get isLoaded(): boolean;
-    /** @internal The box and the way to fill it, so only the creator can settle it. */
-    static create<T>(target: string): {
-        result: ClientResult<T>;
-        fill: (value: T) => void;
-    };
-}
-
 /** What went wrong, as a value a consumer may branch on. */
 type DocxEditorErrorCode = 
 /** A property was read before a `load(...)` for it completed in a `sync()`. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docx-editor.dev/editor-api",
-  "version": "2.19.0",
+  "version": "2.20.0",
   "description": "Document automation for DOCX: a batching object model that drives a document from a server or from an editor already open in a page",
   "sideEffects": false,
   "engines": {
@@ -82,6 +82,6 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@docx-editor.dev/core": "~2.19.0"
+    "@docx-editor.dev/core": "~2.20.0"
   }
 }