@docx-editor.dev/editor-api 2.4.0 → 2.4.1

package/README.md

@@ -55,6 +55,12 @@ try {
 }
 ```
 
+`createServer` finishes its bounded parse before its promise resolves and does not retain the input
+`Uint8Array`; you may reuse or transfer that buffer afterward. Every `save()` returns a fresh,
+caller-owned `Uint8Array`, so transferring or mutating one result does not affect the runtime or a
+later save. Detached edits remain detached until your application explicitly loads the returned
+bytes into a live editor.
+
 ## In the browser
 
 The browser entry takes an editor the host already created, from `@docx-editor.dev/react` or a

package/dist/browser.d.mts

@@ -21,8 +21,8 @@
  * @packageDocumentation
  * @public
  */
-import { y as DocxEditorRuntime, C as CreateServerOptions, D as DocxEditorServerRuntime } from './server-BHhEJM8H.mjs';
-export { B as BesideLocation, a as Body, b as BodyInsertParagraphLocation, c as BodyInsertTextLocation, d as Bookmark, e as BookmarkCollection, f as ClientObject, g as ClientResult, h as Comment, i as CommentCollection, j as CommentReply, k as CommentReplyCollection, l as ContentControl, m as ContentControlCollection, n as ContentControlLockState, o as ContentControlSubtype, p as ContentControlValue, q as Document, r as DocumentCapabilities, s as DocumentLimits, t as DocumentXmlLimits, u as DocumentZipLimits, v as DocxEditorError, w as DocxEditorErrorCode, x as DocxEditorErrorInit, F as Font, H as HeaderFooterType, I as InsertLocation, L as List, z as ListCollection, A as ListItem, E as LoadOption, G as LoadQueryOptions, N as NoteItem, J as NoteItemCollection, K as NoteItemType, P as PageOrientation, M as PageSetup, O as Paragraph, Q as ParagraphAlignment, R as ParagraphCollection, S as ParagraphInsertTextLocation, T as Range, U as RangeCollection, V as RangeInsertTextLocation, W as RequestContext, X as Revision, Y as RevisionCollection, Z as RevisionType, _ as RunCallback, $ as SearchOptions, a0 as Section, a1 as SectionCollection, a2 as SelectionMode, a3 as TrackedObjects, a4 as isDocxEditorError } from './server-BHhEJM8H.mjs';
+import { y as DocxEditorRuntime, C as CreateServerOptions, D as DocxEditorServerRuntime } from './server-DbbWqWoz.mjs';
+export { B as BesideLocation, a as Body, b as BodyInsertParagraphLocation, c as BodyInsertTextLocation, d as Bookmark, e as BookmarkCollection, f as ClientObject, g as ClientResult, h as Comment, i as CommentCollection, j as CommentReply, k as CommentReplyCollection, l as ContentControl, m as ContentControlCollection, n as ContentControlLockState, o as ContentControlSubtype, p as ContentControlValue, q as Document, r as DocumentCapabilities, s as DocumentLimits, t as DocumentXmlLimits, u as DocumentZipLimits, v as DocxEditorError, w as DocxEditorErrorCode, x as DocxEditorErrorInit, F as Font, H as HeaderFooterType, I as InsertLocation, L as List, z as ListCollection, A as ListItem, E as LoadOption, G as LoadQueryOptions, N as NoteItem, J as NoteItemCollection, K as NoteItemType, P as PageOrientation, M as PageSetup, O as Paragraph, Q as ParagraphAlignment, R as ParagraphCollection, S as ParagraphInsertTextLocation, T as Range, U as RangeCollection, V as RangeInsertTextLocation, W as RequestContext, X as Revision, Y as RevisionCollection, Z as RevisionType, _ as RunCallback, $ as SearchOptions, a0 as Section, a1 as SectionCollection, a2 as SelectionMode, a3 as TrackedObjects, a4 as isDocxEditorError } from './server-DbbWqWoz.mjs';
 import { DocxEditorInstance } from '@docx-editor.dev/core/editor';
 import '@docx-editor.dev/core/automation';
 

package/dist/browser.d.ts

@@ -21,8 +21,8 @@
  * @packageDocumentation
  * @public
  */
-import { y as DocxEditorRuntime, C as CreateServerOptions, D as DocxEditorServerRuntime } from './server-BHhEJM8H.js';
-export { B as BesideLocation, a as Body, b as BodyInsertParagraphLocation, c as BodyInsertTextLocation, d as Bookmark, e as BookmarkCollection, f as ClientObject, g as ClientResult, h as Comment, i as CommentCollection, j as CommentReply, k as CommentReplyCollection, l as ContentControl, m as ContentControlCollection, n as ContentControlLockState, o as ContentControlSubtype, p as ContentControlValue, q as Document, r as DocumentCapabilities, s as DocumentLimits, t as DocumentXmlLimits, u as DocumentZipLimits, v as DocxEditorError, w as DocxEditorErrorCode, x as DocxEditorErrorInit, F as Font, H as HeaderFooterType, I as InsertLocation, L as List, z as ListCollection, A as ListItem, E as LoadOption, G as LoadQueryOptions, N as NoteItem, J as NoteItemCollection, K as NoteItemType, P as PageOrientation, M as PageSetup, O as Paragraph, Q as ParagraphAlignment, R as ParagraphCollection, S as ParagraphInsertTextLocation, T as Range, U as RangeCollection, V as RangeInsertTextLocation, W as RequestContext, X as Revision, Y as RevisionCollection, Z as RevisionType, _ as RunCallback, $ as SearchOptions, a0 as Section, a1 as SectionCollection, a2 as SelectionMode, a3 as TrackedObjects, a4 as isDocxEditorError } from './server-BHhEJM8H.js';
+import { y as DocxEditorRuntime, C as CreateServerOptions, D as DocxEditorServerRuntime } from './server-DbbWqWoz.js';
+export { B as BesideLocation, a as Body, b as BodyInsertParagraphLocation, c as BodyInsertTextLocation, d as Bookmark, e as BookmarkCollection, f as ClientObject, g as ClientResult, h as Comment, i as CommentCollection, j as CommentReply, k as CommentReplyCollection, l as ContentControl, m as ContentControlCollection, n as ContentControlLockState, o as ContentControlSubtype, p as ContentControlValue, q as Document, r as DocumentCapabilities, s as DocumentLimits, t as DocumentXmlLimits, u as DocumentZipLimits, v as DocxEditorError, w as DocxEditorErrorCode, x as DocxEditorErrorInit, F as Font, H as HeaderFooterType, I as InsertLocation, L as List, z as ListCollection, A as ListItem, E as LoadOption, G as LoadQueryOptions, N as NoteItem, J as NoteItemCollection, K as NoteItemType, P as PageOrientation, M as PageSetup, O as Paragraph, Q as ParagraphAlignment, R as ParagraphCollection, S as ParagraphInsertTextLocation, T as Range, U as RangeCollection, V as RangeInsertTextLocation, W as RequestContext, X as Revision, Y as RevisionCollection, Z as RevisionType, _ as RunCallback, $ as SearchOptions, a0 as Section, a1 as SectionCollection, a2 as SelectionMode, a3 as TrackedObjects, a4 as isDocxEditorError } from './server-DbbWqWoz.js';
 import { DocxEditorInstance } from '@docx-editor.dev/core/editor';
 import '@docx-editor.dev/core/automation';
 

package/dist/index.d.mts

@@ -58,8 +58,8 @@
  * @packageDocumentation
  * @public
  */
-import { C as CreateServerOptions, D as DocxEditorServerRuntime } from './server-BHhEJM8H.mjs';
-export { B as BesideLocation, a as Body, b as BodyInsertParagraphLocation, c as BodyInsertTextLocation, d as Bookmark, e as BookmarkCollection, f as ClientObject, g as ClientResult, h as Comment, i as CommentCollection, j as CommentReply, k as CommentReplyCollection, l as ContentControl, m as ContentControlCollection, n as ContentControlLockState, o as ContentControlSubtype, p as ContentControlValue, q as Document, r as DocumentCapabilities, s as DocumentLimits, t as DocumentXmlLimits, u as DocumentZipLimits, v as DocxEditorError, w as DocxEditorErrorCode, x as DocxEditorErrorInit, y as DocxEditorRuntime, F as Font, H as HeaderFooterType, I as InsertLocation, L as List, z as ListCollection, A as ListItem, E as LoadOption, G as LoadQueryOptions, N as NoteItem, J as NoteItemCollection, K as NoteItemType, P as PageOrientation, M as PageSetup, O as Paragraph, Q as ParagraphAlignment, R as ParagraphCollection, S as ParagraphInsertTextLocation, T as Range, U as RangeCollection, V as RangeInsertTextLocation, W as RequestContext, X as Revision, Y as RevisionCollection, Z as RevisionType, _ as RunCallback, $ as SearchOptions, a0 as Section, a1 as SectionCollection, a2 as SelectionMode, a3 as TrackedObjects, a4 as isDocxEditorError } from './server-BHhEJM8H.mjs';
+import { C as CreateServerOptions, D as DocxEditorServerRuntime } from './server-DbbWqWoz.mjs';
+export { B as BesideLocation, a as Body, b as BodyInsertParagraphLocation, c as BodyInsertTextLocation, d as Bookmark, e as BookmarkCollection, f as ClientObject, g as ClientResult, h as Comment, i as CommentCollection, j as CommentReply, k as CommentReplyCollection, l as ContentControl, m as ContentControlCollection, n as ContentControlLockState, o as ContentControlSubtype, p as ContentControlValue, q as Document, r as DocumentCapabilities, s as DocumentLimits, t as DocumentXmlLimits, u as DocumentZipLimits, v as DocxEditorError, w as DocxEditorErrorCode, x as DocxEditorErrorInit, y as DocxEditorRuntime, F as Font, H as HeaderFooterType, I as InsertLocation, L as List, z as ListCollection, A as ListItem, E as LoadOption, G as LoadQueryOptions, N as NoteItem, J as NoteItemCollection, K as NoteItemType, P as PageOrientation, M as PageSetup, O as Paragraph, Q as ParagraphAlignment, R as ParagraphCollection, S as ParagraphInsertTextLocation, T as Range, U as RangeCollection, V as RangeInsertTextLocation, W as RequestContext, X as Revision, Y as RevisionCollection, Z as RevisionType, _ as RunCallback, $ as SearchOptions, a0 as Section, a1 as SectionCollection, a2 as SelectionMode, a3 as TrackedObjects, a4 as isDocxEditorError } from './server-DbbWqWoz.mjs';
 import '@docx-editor.dev/core/automation';
 
 /**

package/dist/index.d.ts

@@ -58,8 +58,8 @@
  * @packageDocumentation
  * @public
  */
-import { C as CreateServerOptions, D as DocxEditorServerRuntime } from './server-BHhEJM8H.js';
-export { B as BesideLocation, a as Body, b as BodyInsertParagraphLocation, c as BodyInsertTextLocation, d as Bookmark, e as BookmarkCollection, f as ClientObject, g as ClientResult, h as Comment, i as CommentCollection, j as CommentReply, k as CommentReplyCollection, l as ContentControl, m as ContentControlCollection, n as ContentControlLockState, o as ContentControlSubtype, p as ContentControlValue, q as Document, r as DocumentCapabilities, s as DocumentLimits, t as DocumentXmlLimits, u as DocumentZipLimits, v as DocxEditorError, w as DocxEditorErrorCode, x as DocxEditorErrorInit, y as DocxEditorRuntime, F as Font, H as HeaderFooterType, I as InsertLocation, L as List, z as ListCollection, A as ListItem, E as LoadOption, G as LoadQueryOptions, N as NoteItem, J as NoteItemCollection, K as NoteItemType, P as PageOrientation, M as PageSetup, O as Paragraph, Q as ParagraphAlignment, R as ParagraphCollection, S as ParagraphInsertTextLocation, T as Range, U as RangeCollection, V as RangeInsertTextLocation, W as RequestContext, X as Revision, Y as RevisionCollection, Z as RevisionType, _ as RunCallback, $ as SearchOptions, a0 as Section, a1 as SectionCollection, a2 as SelectionMode, a3 as TrackedObjects, a4 as isDocxEditorError } from './server-BHhEJM8H.js';
+import { C as CreateServerOptions, D as DocxEditorServerRuntime } from './server-DbbWqWoz.js';
+export { B as BesideLocation, a as Body, b as BodyInsertParagraphLocation, c as BodyInsertTextLocation, d as Bookmark, e as BookmarkCollection, f as ClientObject, g as ClientResult, h as Comment, i as CommentCollection, j as CommentReply, k as CommentReplyCollection, l as ContentControl, m as ContentControlCollection, n as ContentControlLockState, o as ContentControlSubtype, p as ContentControlValue, q as Document, r as DocumentCapabilities, s as DocumentLimits, t as DocumentXmlLimits, u as DocumentZipLimits, v as DocxEditorError, w as DocxEditorErrorCode, x as DocxEditorErrorInit, y as DocxEditorRuntime, F as Font, H as HeaderFooterType, I as InsertLocation, L as List, z as ListCollection, A as ListItem, E as LoadOption, G as LoadQueryOptions, N as NoteItem, J as NoteItemCollection, K as NoteItemType, P as PageOrientation, M as PageSetup, O as Paragraph, Q as ParagraphAlignment, R as ParagraphCollection, S as ParagraphInsertTextLocation, T as Range, U as RangeCollection, V as RangeInsertTextLocation, W as RequestContext, X as Revision, Y as RevisionCollection, Z as RevisionType, _ as RunCallback, $ as SearchOptions, a0 as Section, a1 as SectionCollection, a2 as SelectionMode, a3 as TrackedObjects, a4 as isDocxEditorError } from './server-DbbWqWoz.js';
 import '@docx-editor.dev/core/automation';
 
 /**

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

@@ -1369,7 +1369,11 @@ interface DocxEditorRuntime {
  * @public
  */
 interface DocxEditorServerRuntime extends DocxEditorRuntime {
-    /** The current document as DOCX bytes. */
+    /**
+     * The current document as a fresh, caller-owned DOCX byte array.
+     *
+     * Mutating or transferring the returned array does not change this runtime or a later save.
+     */
     save(): Promise<Uint8Array>;
 }
 
@@ -2021,6 +2025,9 @@ interface DocumentLimits {
  * they did not author gets "not a document this API can open", so a probe cannot use the error to
  * learn the reader's limits.
  *
+ * The bounded parse is complete when this promise resolves. The runtime does not retain the
+ * caller's `Uint8Array`, so the caller may reuse or transfer that input buffer afterward.
+ *
  * @public
  */
 interface CreateServerOptions {

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

@@ -1369,7 +1369,11 @@ interface DocxEditorRuntime {
  * @public
  */
 interface DocxEditorServerRuntime extends DocxEditorRuntime {
-    /** The current document as DOCX bytes. */
+    /**
+     * The current document as a fresh, caller-owned DOCX byte array.
+     *
+     * Mutating or transferring the returned array does not change this runtime or a later save.
+     */
     save(): Promise<Uint8Array>;
 }
 
@@ -2021,6 +2025,9 @@ interface DocumentLimits {
  * they did not author gets "not a document this API can open", so a probe cannot use the error to
  * learn the reader's limits.
  *
+ * The bounded parse is complete when this promise resolves. The runtime does not retain the
+ * caller's `Uint8Array`, so the caller may reuse or transfer that input buffer afterward.
+ *
  * @public
  */
 interface CreateServerOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docx-editor.dev/editor-api",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "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",
@@ -73,6 +73,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@docx-editor.dev/core": "^2.4.0"
+    "@docx-editor.dev/core": "^2.4.1"
   }
 }