@docx-editor.dev/editor-api 2.8.0 → 2.9.0

package/dist/{server-DbbWqWoz.d.mts → server-CLl0SanG.d.mts}

@@ -85,6 +85,8 @@ declare abstract class HandleCollection<T extends ClientObject & PromisedItem> e
 }
 
 declare abstract class ModelObject extends ClientObject {
+    /** Runtime-wide revision view behind standard Office-compatible text reads and searches. */
+    protected revisionTextView(): 'allMarkup' | 'original';
     /** Queue a read whose text answer becomes the loaded property `name`. */
     protected loadTextInto(name: string, plan: () => AutomationOperation): void;
     /** Queue a command with nothing to answer. Nothing is written until `sync()`. */
@@ -1376,6 +1378,17 @@ interface DocxEditorServerRuntime extends DocxEditorRuntime {
      */
     save(): Promise<Uint8Array>;
 }
+/**
+ * The tracked-revision view used by this runtime's ordinary Office-compatible text reads.
+ *
+ * `allMarkup` preserves the historical behavior. `original` matches Word's Original review view:
+ * pending deletions remain visible and pending insertions stay hidden.
+ *
+ * This is a DocxEditor runtime option. It is not part of the Office.js object model.
+ *
+ * @public
+ */
+type RevisionTextView = 'allMarkup' | 'original';
 
 /**
  * The objects a context keeps addressable beyond the run that created them.
@@ -1403,6 +1416,8 @@ interface RuntimeSession {
     readonly capabilities: AutomationCapabilities;
     /** Who a comment this runtime writes is recorded as, or absent when it may not write one. */
     readonly author?: string;
+    /** Revision view used by standard Office-compatible text reads and searches. */
+    readonly revisionTextView: RevisionTextView;
     /** Identity for adoption checks. The session object itself. */
     readonly id: object;
     roots(): RootHandles;
@@ -1485,6 +1500,8 @@ interface ContextInternals {
      * write refuses (`NotSupported`) rather than putting a made-up name in the file.
      */
     readonly author?: string;
+    /** Revision view used by standard Office-compatible text reads and searches. */
+    readonly revisionTextView: RevisionTextView;
     readonly queue: ActionQueue;
     /**
      * Identity of the runtime session behind this context.
@@ -2046,6 +2063,12 @@ interface CreateServerOptions {
      * placeholder name into someone's document.
      */
     readonly author?: string;
+    /**
+     * Revision view for ordinary Office-compatible `text` loads and `search()` calls.
+     *
+     * Omitted means `allMarkup`.
+     */
+    readonly revisionTextView?: RevisionTextView;
 }
 
-export { type SearchOptions as $, ListItem as A, type BesideLocation as B, type CreateServerOptions as C, type DocxEditorServerRuntime as D, type LoadOption as E, Font as F, type LoadQueryOptions as G, type HeaderFooterType as H, type InsertLocation as I, NoteItemCollection as J, type NoteItemType as K, List as L, PageSetup as M, NoteItem as N, Paragraph as O, type PageOrientation as P, type ParagraphAlignment as Q, ParagraphCollection as R, type ParagraphInsertTextLocation as S, Range as T, RangeCollection as U, type RangeInsertTextLocation as V, RequestContext as W, Revision as X, RevisionCollection as Y, type RevisionType as Z, type RunCallback as _, Body as a, Section as a0, SectionCollection as a1, type SelectionMode as a2, TrackedObjects as a3, isDocxEditorError as a4, type BodyInsertParagraphLocation as b, type BodyInsertTextLocation as c, Bookmark as d, BookmarkCollection as e, ClientObject as f, ClientResult as g, Comment as h, CommentCollection as i, CommentReply as j, CommentReplyCollection as k, ContentControl as l, ContentControlCollection as m, type ContentControlLockState as n, type ContentControlSubtype as o, type ContentControlValue as p, Document as q, type DocumentCapabilities as r, type DocumentLimits as s, type DocumentXmlLimits as t, type DocumentZipLimits as u, DocxEditorError as v, type DocxEditorErrorCode as w, type DocxEditorErrorInit as x, type DocxEditorRuntime as y, ListCollection as z };
+export { type RunCallback as $, ListItem as A, type BesideLocation as B, type CreateServerOptions as C, type DocxEditorServerRuntime as D, type LoadOption as E, Font as F, type LoadQueryOptions as G, type HeaderFooterType as H, type InsertLocation as I, NoteItemCollection as J, type NoteItemType as K, List as L, PageSetup as M, NoteItem as N, Paragraph as O, type PageOrientation as P, type ParagraphAlignment as Q, ParagraphCollection as R, type ParagraphInsertTextLocation as S, Range as T, RangeCollection as U, type RangeInsertTextLocation as V, RequestContext as W, Revision as X, RevisionCollection as Y, type RevisionTextView as Z, type RevisionType as _, Body as a, type SearchOptions as a0, Section as a1, SectionCollection as a2, type SelectionMode as a3, TrackedObjects as a4, isDocxEditorError as a5, type BodyInsertParagraphLocation as b, type BodyInsertTextLocation as c, Bookmark as d, BookmarkCollection as e, ClientObject as f, ClientResult as g, Comment as h, CommentCollection as i, CommentReply as j, CommentReplyCollection as k, ContentControl as l, ContentControlCollection as m, type ContentControlLockState as n, type ContentControlSubtype as o, type ContentControlValue as p, Document as q, type DocumentCapabilities as r, type DocumentLimits as s, type DocumentXmlLimits as t, type DocumentZipLimits as u, DocxEditorError as v, type DocxEditorErrorCode as w, type DocxEditorErrorInit as x, type DocxEditorRuntime as y, ListCollection as z };

package/dist/{server-DbbWqWoz.d.ts → server-CLl0SanG.d.ts}

@@ -85,6 +85,8 @@ declare abstract class HandleCollection<T extends ClientObject & PromisedItem> e
 }
 
 declare abstract class ModelObject extends ClientObject {
+    /** Runtime-wide revision view behind standard Office-compatible text reads and searches. */
+    protected revisionTextView(): 'allMarkup' | 'original';
     /** Queue a read whose text answer becomes the loaded property `name`. */
     protected loadTextInto(name: string, plan: () => AutomationOperation): void;
     /** Queue a command with nothing to answer. Nothing is written until `sync()`. */
@@ -1376,6 +1378,17 @@ interface DocxEditorServerRuntime extends DocxEditorRuntime {
      */
     save(): Promise<Uint8Array>;
 }
+/**
+ * The tracked-revision view used by this runtime's ordinary Office-compatible text reads.
+ *
+ * `allMarkup` preserves the historical behavior. `original` matches Word's Original review view:
+ * pending deletions remain visible and pending insertions stay hidden.
+ *
+ * This is a DocxEditor runtime option. It is not part of the Office.js object model.
+ *
+ * @public
+ */
+type RevisionTextView = 'allMarkup' | 'original';
 
 /**
  * The objects a context keeps addressable beyond the run that created them.
@@ -1403,6 +1416,8 @@ interface RuntimeSession {
     readonly capabilities: AutomationCapabilities;
     /** Who a comment this runtime writes is recorded as, or absent when it may not write one. */
     readonly author?: string;
+    /** Revision view used by standard Office-compatible text reads and searches. */
+    readonly revisionTextView: RevisionTextView;
     /** Identity for adoption checks. The session object itself. */
     readonly id: object;
     roots(): RootHandles;
@@ -1485,6 +1500,8 @@ interface ContextInternals {
      * write refuses (`NotSupported`) rather than putting a made-up name in the file.
      */
     readonly author?: string;
+    /** Revision view used by standard Office-compatible text reads and searches. */
+    readonly revisionTextView: RevisionTextView;
     readonly queue: ActionQueue;
     /**
      * Identity of the runtime session behind this context.
@@ -2046,6 +2063,12 @@ interface CreateServerOptions {
      * placeholder name into someone's document.
      */
     readonly author?: string;
+    /**
+     * Revision view for ordinary Office-compatible `text` loads and `search()` calls.
+     *
+     * Omitted means `allMarkup`.
+     */
+    readonly revisionTextView?: RevisionTextView;
 }
 
-export { type SearchOptions as $, ListItem as A, type BesideLocation as B, type CreateServerOptions as C, type DocxEditorServerRuntime as D, type LoadOption as E, Font as F, type LoadQueryOptions as G, type HeaderFooterType as H, type InsertLocation as I, NoteItemCollection as J, type NoteItemType as K, List as L, PageSetup as M, NoteItem as N, Paragraph as O, type PageOrientation as P, type ParagraphAlignment as Q, ParagraphCollection as R, type ParagraphInsertTextLocation as S, Range as T, RangeCollection as U, type RangeInsertTextLocation as V, RequestContext as W, Revision as X, RevisionCollection as Y, type RevisionType as Z, type RunCallback as _, Body as a, Section as a0, SectionCollection as a1, type SelectionMode as a2, TrackedObjects as a3, isDocxEditorError as a4, type BodyInsertParagraphLocation as b, type BodyInsertTextLocation as c, Bookmark as d, BookmarkCollection as e, ClientObject as f, ClientResult as g, Comment as h, CommentCollection as i, CommentReply as j, CommentReplyCollection as k, ContentControl as l, ContentControlCollection as m, type ContentControlLockState as n, type ContentControlSubtype as o, type ContentControlValue as p, Document as q, type DocumentCapabilities as r, type DocumentLimits as s, type DocumentXmlLimits as t, type DocumentZipLimits as u, DocxEditorError as v, type DocxEditorErrorCode as w, type DocxEditorErrorInit as x, type DocxEditorRuntime as y, ListCollection as z };
+export { type RunCallback as $, ListItem as A, type BesideLocation as B, type CreateServerOptions as C, type DocxEditorServerRuntime as D, type LoadOption as E, Font as F, type LoadQueryOptions as G, type HeaderFooterType as H, type InsertLocation as I, NoteItemCollection as J, type NoteItemType as K, List as L, PageSetup as M, NoteItem as N, Paragraph as O, type PageOrientation as P, type ParagraphAlignment as Q, ParagraphCollection as R, type ParagraphInsertTextLocation as S, Range as T, RangeCollection as U, type RangeInsertTextLocation as V, RequestContext as W, Revision as X, RevisionCollection as Y, type RevisionTextView as Z, type RevisionType as _, Body as a, type SearchOptions as a0, Section as a1, SectionCollection as a2, type SelectionMode as a3, TrackedObjects as a4, isDocxEditorError as a5, type BodyInsertParagraphLocation as b, type BodyInsertTextLocation as c, Bookmark as d, BookmarkCollection as e, ClientObject as f, ClientResult as g, Comment as h, CommentCollection as i, CommentReply as j, CommentReplyCollection as k, ContentControl as l, ContentControlCollection as m, type ContentControlLockState as n, type ContentControlSubtype as o, type ContentControlValue as p, Document as q, type DocumentCapabilities as r, type DocumentLimits as s, type DocumentXmlLimits as t, type DocumentZipLimits as u, DocxEditorError as v, type DocxEditorErrorCode as w, type DocxEditorErrorInit as x, type DocxEditorRuntime as y, ListCollection as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docx-editor.dev/editor-api",
-  "version": "2.8.0",
+  "version": "2.9.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,
   "main": "./dist/index.js",
@@ -27,6 +27,7 @@
     }
   },
   "devDependencies": {
+    "@docx-editor.dev/core": "workspace:*",
     "@microsoft/api-extractor": "^7.50.0",
     "fflate": "^0.8.2",
     "license-check-and-add": "^4.0.5"
@@ -73,7 +74,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "dependencies": {
+  "peerDependencies": {
     "@docx-editor.dev/core": "^2.8.0"
   }
 }