ooxml-core 1.22.0 → 1.23.0

package/README.md

@@ -24,7 +24,7 @@ Part of [ooxml](https://github.com/ChristopherVR/ooxml#readme): [Office](https:/
 
 ## Why ooxml-core?
 
-- **No UI, no framework.** Everything runs in browsers, Node.js, Bun, workers and serverless functions. The viewer apps ([docx](https://christophervr.github.io/ooxml/docx/), [xlsx](https://christophervr.github.io/ooxml/xlsx/), [visio](https://christophervr.github.io/ooxml/visio/), [teams](https://christophervr.github.io/ooxml/teams/) and [pptx-viewer](https://github.com/ChristopherVR/pptx-viewer)) are thin interfaces on top of it, and so can your application be.
+- **No UI, no framework.** Everything runs in browsers, Node.js, Bun, workers and serverless functions. The viewer apps ([docx](https://christophervr.github.io/ooxml/docx/), [xlsx](https://christophervr.github.io/ooxml/xlsx/), [visio](https://christophervr.github.io/ooxml/visio/), [teams](https://christophervr.github.io/ooxml/teams/) and [pptx](https://christophervr.github.io/ooxml/pptx/)) are thin interfaces on top of it, and so can your application be.
 - **One package, one structure.** All formats share the same XML model, packaging layer, units, colours and geometry. Each format is an _area_ of this one package, not a separate dependency to keep in step.
 - **Round-trips without losing what it does not understand.** Documents are loaded into a model, edited, and written back. Untouched parts stay byte-for-byte, unknown markup is preserved, and edits that would damage unsupported content are rejected instead of silently dropped.
 - **Strict by default.** New code is strict TypeScript with branded measurement units, the shared `xml` area parses strictly (no DTD or entity expansion), and the `docx` area is checked against the ECMA-376 schemas in the test suite.
@@ -47,12 +47,17 @@ import { xml, opc } from 'ooxml-core'; // or by namespace (shared building block
 | `color`      | Hex, RGB, HSL and linear colour primitives, OOXML percent and angle parsing.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | `geometry`   | DrawingML preset shapes, connection sites, clip paths, callouts and boolean shape operations.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | `diagram`    | SmartArt (DiagramML), format-neutral: data model, layout/colour/quick-style parts, the cached `dsp:drawing` shape tree, relationship resolution and a loader. Used by `docx`; `pptx` re-imports its parsers.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| `drawingml`  | Format-neutral DrawingML: colour, fill, text-body and geometry readers, the colour and fill writers and the theme model that docx and xlsx read their themes through.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| `chart`      | Format-neutral chart algorithms and formatting helpers: data calculations, axes, number formats, the Change Colors palettes and the SVG chart painter.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| `text`       | Shared text rules: script-category segmentation, tab leaders and styled-run wrapping.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| `i18n`       | Locale normalisation, dictionary merging and the translator every product UI uses.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+| `ribbon`     | DOM-free ribbon contracts every product shares, today the add-in tab descriptor a host uses to add its own tabs.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | `digest`     | Synchronous pure-TypeScript SHA-1, SHA-256, SHA-384 and SHA-512, ECMA-376 digest name normalisation (`SHA-512`, `SHA512`, `sha_512`, ...) and the agile password hash Office protection elements store (`hashPassword`, `verifyPasswordHash`). No Web Crypto, so it works on `http://`. Used by `xlsx` sheet and workbook protection.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 | `crypto`     | ECMA-376 package encryption ([MS-OFFCRYPTO]) for every format: `decryptOoxmlPackage`, `encryptOoxmlPackage` (agile AES-256/SHA-512 by default, or Standard), `isEncryptedOoxmlPackage`, and typed errors with a `code` (`password-required`, `incorrect-password`, `data-integrity`). The compound-file container comes from ole2 (inlined); not in the root entry.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 | `collab`     | Format-neutral real-time collaboration on Yjs: session and provider lifecycle, awareness/presence, transport-neutral sync (WebSocket, in-memory, any byte channel), update codecs, ordering helpers, asset sync and the product adapter seam. See `docs/collab-area.md`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | `docx`       | WordprocessingML: model, parser, preserving serializer, editing, validation. Also `/docx/embedded`. `/docx/layout` is the DOM-free pagination engine (an approximation of Word, not parity) and `/docx/load` detects and loads DOCX (also password-protected, `{ password }`) and legacy .doc (ole2 inlined).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | `pptx`       | PresentationML: model, parser, serializer, editing, charts, SmartArt, converters, CLI, signatures. Subpaths `/pptx/converter`, `/pptx/cli`, `/pptx/signature-node`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| `xlsx`       | SpreadsheetML: workbook model, `.xlsx`/`.xlsm` reader and preserving writer, formula engine (dependency graph, dynamic arrays, 380+ functions), Excel number formats, editing commands with undo, and the DOM-free grid layout (sizes, colours, conditional formats, charts as SVG, drawing anchors). SmartArt is shown from the cached drawing (not re-laid out) and kept verbatim on save. `/xlsx/load` detects and loads `.xlsx`, `.xlsm` (also password-protected: `loadWorkbook(bytes, { password })`, `saveWorkbook(workbook, 'xlsx', { password })`), legacy `.xls` (ole2 inlined) and CSV, and refuses `.xlsb` with a typed error. `/xlsx/collab` shares a workbook over Yjs (cells, formats, rows, columns, merges, sheets and defined names; see `docs/collab-area.md`). Digital signatures are detected and reported, never kept on save. An approximation of Excel, not parity. |
+| `xlsx`       | SpreadsheetML: workbook model, `.xlsx`/`.xlsm` reader and preserving writer, formula engine (dependency graph, dynamic arrays, 490+ functions), Excel number formats, editing commands with undo, and the DOM-free grid layout (sizes, colours, conditional formats, charts as SVG, drawing anchors). SmartArt is shown from the cached drawing (not re-laid out) and kept verbatim on save. `/xlsx/load` detects and loads `.xlsx`, `.xlsm` (also password-protected: `loadWorkbook(bytes, { password })`, `saveWorkbook(workbook, 'xlsx', { password })`), legacy `.xls` (ole2 inlined) and CSV, and refuses `.xlsb` with a typed error. `/xlsx/collab` shares a workbook over Yjs (cells, formats, rows, columns, merges, sheets and defined names; see `docs/collab-area.md`). Digital signatures are detected and reported, never kept on save. An approximation of Excel, not parity. |
 | `visio`      | Visio: `.vsdx` parsing, loading and bounded editing, page layers and visibility, and a conservative preview of legacy `.vsd` (through ole2). See `docs/visio-legacy-vsd.md`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | `math`       | Office Math: OMML to and from LaTeX and MathML, with colour and size helpers.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | `teams`      | The logic of the OpenTeams workspace: channels and chat on Yjs, presence, WebRTC calls with pluggable signalling, server configuration and the `createTeamsClient` store every UI binds to. Built on `collab`. See `docs/teams-area.md`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |

package/dist/automation/index.cjs

@@ -69917,6 +69917,7 @@ async function parseVsdx(input2, options2 = {}) {
     throw new VisioPackageError("INVALID_DOCUMENT", "Missing Visio pages part.");
   const pages = [], pageIds2 = /* @__PURE__ */ new Set();
   const comments = [];
+  const only = options2.pages ? new Set(options2.pages) : void 0;
   const pageNodes = pagesPart ? children3(await visioXml(pkg, pagesPart, "Pages"), "Page") : [];
   const foreground = pageNodes.filter((page) => !yes(attribute3(page, "Background")));
   const fieldProperties = await readVisioFieldProperties(pkg);
@@ -69926,6 +69927,7 @@ async function parseVsdx(input2, options2 = {}) {
     if (!id4 || pageIds2.has(id4))
       throw new VisioPackageError("INVALID_PAGE_ID", "Page IDs must be present and unique.");
     pageIds2.add(id4);
+    if (only && !only.has(id4)) continue;
     const part = await indexedPart(pkg, pagesPart, page, "page");
     const root = await visioXml(pkg, part, "PageContents");
     const localReport = (code, message, extra) => report(code, message, { part, pageId: id4, ...extra });
@@ -70035,16 +70037,16 @@ async function parseVsdx(input2, options2 = {}) {
     });
   }
   checkTime();
-  validateBackgrounds(pages, report);
+  if (!only) validateBackgrounds(pages, report);
   try {
-    comments.push(...await readVisioComments(pkg, documentPart, report));
+    if (!only) comments.push(...await readVisioComments(pkg, documentPart, report));
   } catch (error62) {
     if (!(error62 instanceof VisioPackageError) || error62.code === "LIMIT_RUNTIME") throw error62;
     report("invalid-comments", "The comments part could not be read; comments are not shown.");
   }
   let dataRecordsets = [];
   try {
-    dataRecordsets = await readDataRecordsets(pkg, documentPart, checkTime);
+    if (!only) dataRecordsets = await readDataRecordsets(pkg, documentPart, checkTime);
   } catch (error62) {
     if (error62 instanceof VisioPackageError && error62.code === "LIMIT_RUNTIME") throw error62;
     report(
@@ -70052,7 +70054,7 @@ async function parseVsdx(input2, options2 = {}) {
       `Saved external data could not be read and is preserved unchanged: ${error62 instanceof Error ? error62.message : String(error62)}`
     );
   }
-  const stencils = await readVisioStencilWindows(pkg, documentPart);
+  const stencils = only ? [] : await readVisioStencilWindows(pkg, documentPart);
   report(
     "cached-values-only",
     "ShapeSheet formulas, automatic connector routing, and external data are not evaluated; saved cached values and supported theme records are used.",

package/dist/automation/index.mjs

@@ -69911,6 +69911,7 @@ async function parseVsdx(input2, options2 = {}) {
     throw new VisioPackageError("INVALID_DOCUMENT", "Missing Visio pages part.");
   const pages = [], pageIds2 = /* @__PURE__ */ new Set();
   const comments = [];
+  const only = options2.pages ? new Set(options2.pages) : void 0;
   const pageNodes = pagesPart ? children3(await visioXml(pkg, pagesPart, "Pages"), "Page") : [];
   const foreground = pageNodes.filter((page) => !yes(attribute3(page, "Background")));
   const fieldProperties = await readVisioFieldProperties(pkg);
@@ -69920,6 +69921,7 @@ async function parseVsdx(input2, options2 = {}) {
     if (!id4 || pageIds2.has(id4))
       throw new VisioPackageError("INVALID_PAGE_ID", "Page IDs must be present and unique.");
     pageIds2.add(id4);
+    if (only && !only.has(id4)) continue;
     const part = await indexedPart(pkg, pagesPart, page, "page");
     const root = await visioXml(pkg, part, "PageContents");
     const localReport = (code, message, extra) => report(code, message, { part, pageId: id4, ...extra });
@@ -70029,16 +70031,16 @@ async function parseVsdx(input2, options2 = {}) {
     });
   }
   checkTime();
-  validateBackgrounds(pages, report);
+  if (!only) validateBackgrounds(pages, report);
   try {
-    comments.push(...await readVisioComments(pkg, documentPart, report));
+    if (!only) comments.push(...await readVisioComments(pkg, documentPart, report));
   } catch (error62) {
     if (!(error62 instanceof VisioPackageError) || error62.code === "LIMIT_RUNTIME") throw error62;
     report("invalid-comments", "The comments part could not be read; comments are not shown.");
   }
   let dataRecordsets = [];
   try {
-    dataRecordsets = await readDataRecordsets(pkg, documentPart, checkTime);
+    if (!only) dataRecordsets = await readDataRecordsets(pkg, documentPart, checkTime);
   } catch (error62) {
     if (error62 instanceof VisioPackageError && error62.code === "LIMIT_RUNTIME") throw error62;
     report(
@@ -70046,7 +70048,7 @@ async function parseVsdx(input2, options2 = {}) {
       `Saved external data could not be read and is preserved unchanged: ${error62 instanceof Error ? error62.message : String(error62)}`
     );
   }
-  const stencils = await readVisioStencilWindows(pkg, documentPart);
+  const stencils = only ? [] : await readVisioStencilWindows(pkg, documentPart);
   report(
     "cached-values-only",
     "ShapeSheet formulas, automatic connector routing, and external data are not evaluated; saved cached values and supported theme records are used.",

package/dist/collab/embedding.d.ts

@@ -3,6 +3,7 @@ import type { CollaborationRole } from './identity.js';
 import type { ConnectionStatus, ProviderFactory } from './provider.js';
 import { type CollabSession } from './session.js';
 import { type WebrtcOptions } from './webrtc-provider.js';
+import type { CollaborationWriteBackState } from './write-back.js';
 /** Who this window is in the room. */
 export interface CollaborationUser {
     /** Display name; each editor falls back to its own author name. */
@@ -58,6 +59,12 @@ export interface CollaborationState {
     /** The first exchange with the room finished. */
     synced: boolean;
     people: Collaborator[];
+    /**
+     * The owner's write-back (`onWriteBack`), present only in the window that writes back. `saved`
+     * means the host's callback returned (or its promise resolved): the host's acknowledgement and
+     * nothing more.
+     */
+    writeBack?: CollaborationWriteBackState;
 }
 /** The event every editor element dispatches, with a {@link CollaborationState} detail. */
 export declare const COLLABORATION_CHANGE_EVENT = "collaboration-change";

package/dist/collab/embedding.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"embedding.d.ts","sourceRoot":"","sources":["../../collab/embedding.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAoB,MAAM,qBAAqB,CAAC;AAC7E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EAAE,KAAK,aAAa,EAAuB,MAAM,WAAW,CAAC;AAGpE,OAAO,EAAE,KAAK,aAAa,EAAkB,MAAM,mBAAmB,CAAC;AAGvE,sCAAsC;AACtC,MAAM,WAAW,iBAAiB;IACjC,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gFAAgF;IAChF,IAAI,CAAC,EAAE,iBAAiB,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC9D,2FAA2F;IAC3F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+FAA+F;IAC/F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kGAAkG;IAClG,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gGAAgG;IAChG,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,gHAAgH;IAChH,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB;;;OAGG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAC3B,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAC3B;AAED,kFAAkF;AAClF,MAAM,WAAW,YAAY;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;CACd;AAED,wFAAwF;AACxF,MAAM,WAAW,kBAAkB;IAClC,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,0EAA0E;IAC1E,MAAM,EAAE,gBAAgB,GAAG,KAAK,CAAC;IACjC,iDAAiD;IACjD,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,YAAY,EAAE,CAAC;CACvB;AAED,2FAA2F;AAC3F,eAAO,MAAM,0BAA0B,yBAAyB,CAAC;AAEjE,eAAO,MAAM,uBAAuB,EAAE,kBAMpC,CAAC;AAEH;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC7D,aAAa,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAC9C,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAChD,kFAAkF;IAClF,iBAAiB,IAAI,IAAI,CAAC;IAC1B,sFAAsF;IACtF,sBAAsB,IAAI,IAAI,CAAC;CAC/B;AAED,2EAA2E;AAC3E,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM;IACpD,kFAAkF;IAClF,WAAW,EAAE,MAAM,CAAC;IACpB,gFAAgF;IAChF,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAC7D,eAAe,CAAC,EAAE,CAAC,CAAC;CACpB;AAED,eAAO,MAAM,oBAAoB,4EACyC,CAAC;AAC3E,eAAO,MAAM,oBAAoB,kEAAkE,CAAC;AAEpG;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,SAAS,MAAM,EACxD,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAChC,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAC9B;IAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAoC/C;AAOD,6EAA6E;AAC7E,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,kBAAkB,CAqBvF;AAED,2FAA2F;AAC3F,wBAAgB,0BAA0B,CACzC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAC9B,QAAQ,EAAE,MAAM,IAAI,GAClB,MAAM,IAAI,CASZ;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,eAAe,CAuBjF"}
+{"version":3,"file":"embedding.d.ts","sourceRoot":"","sources":["../../collab/embedding.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAoB,MAAM,qBAAqB,CAAC;AAC7E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EAAE,KAAK,aAAa,EAAuB,MAAM,WAAW,CAAC;AAGpE,OAAO,EAAE,KAAK,aAAa,EAAkB,MAAM,mBAAmB,CAAC;AAEvE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAEhE,sCAAsC;AACtC,MAAM,WAAW,iBAAiB;IACjC,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gFAAgF;IAChF,IAAI,CAAC,EAAE,iBAAiB,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC9D,2FAA2F;IAC3F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+FAA+F;IAC/F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kGAAkG;IAClG,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gGAAgG;IAChG,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,gHAAgH;IAChH,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB;;;OAGG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAC3B,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAC3B;AAED,kFAAkF;AAClF,MAAM,WAAW,YAAY;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;CACd;AAED,wFAAwF;AACxF,MAAM,WAAW,kBAAkB;IAClC,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,0EAA0E;IAC1E,MAAM,EAAE,gBAAgB,GAAG,KAAK,CAAC;IACjC,iDAAiD;IACjD,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,2BAA2B,CAAC;CACxC;AAED,2FAA2F;AAC3F,eAAO,MAAM,0BAA0B,yBAAyB,CAAC;AAEjE,eAAO,MAAM,uBAAuB,EAAE,kBAMpC,CAAC;AAEH;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC7D,aAAa,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAC9C,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAChD,kFAAkF;IAClF,iBAAiB,IAAI,IAAI,CAAC;IAC1B,sFAAsF;IACtF,sBAAsB,IAAI,IAAI,CAAC;CAC/B;AAED,2EAA2E;AAC3E,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM;IACpD,kFAAkF;IAClF,WAAW,EAAE,MAAM,CAAC;IACpB,gFAAgF;IAChF,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAC7D,eAAe,CAAC,EAAE,CAAC,CAAC;CACpB;AAED,eAAO,MAAM,oBAAoB,4EACyC,CAAC;AAC3E,eAAO,MAAM,oBAAoB,kEAAkE,CAAC;AAEpG;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,SAAS,MAAM,EACxD,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAChC,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAC9B;IAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAoC/C;AAOD,6EAA6E;AAC7E,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,kBAAkB,CAqBvF;AAED,2FAA2F;AAC3F,wBAAgB,0BAA0B,CACzC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAC9B,QAAQ,EAAE,MAAM,IAAI,GAClB,MAAM,IAAI,CASZ;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,eAAe,CAuBjF"}

package/dist/collab/index.cjs

@@ -1523,6 +1523,191 @@ function freezeDeep(value) {
   return value;
 }
 
+// collab/write-back.ts
+var DEFAULT_WRITE_BACK_DEBOUNCE_MS = 5e3;
+var DEFAULT_RETRY_BASE_MS = 1e3;
+var DEFAULT_RETRY_MAX_MS = 3e4;
+var globalTimers = {
+  setTimeout: (callback, ms) => globalThis.setTimeout(callback, ms),
+  clearTimeout: (handle) => globalThis.clearTimeout(handle)
+};
+var isThenable = (value) => typeof value === "object" && value !== null && typeof value.then === "function";
+function writeBackStateOf(state) {
+  const out = { status: state.status };
+  if (state.lastSavedAt !== void 0) out.lastSavedAt = state.lastSavedAt;
+  if (state.status === "failed" && state.lastError !== void 0) {
+    out.error = state.lastError instanceof Error ? state.lastError.message : String(state.lastError);
+  }
+  return out;
+}
+function createWriteBackScheduler(options) {
+  const timers = options.timers ?? globalTimers;
+  const now = options.now ?? Date.now;
+  const configured = options.debounceMs;
+  const debounceMs = configured !== void 0 && Number.isFinite(configured) && configured >= 0 ? configured : DEFAULT_WRITE_BACK_DEBOUNCE_MS;
+  const attempts = Math.max(1, Math.floor(options.retry?.attempts ?? 1) || 1);
+  const baseDelay = Math.max(0, options.retry?.baseDelayMs ?? DEFAULT_RETRY_BASE_MS);
+  const maxDelay = Math.max(baseDelay, options.retry?.maxDelayMs ?? DEFAULT_RETRY_MAX_MS);
+  let state = { status: "idle" };
+  let generation = 0;
+  let disposed = false;
+  let dirty = false;
+  let timer = null;
+  let running = null;
+  let wake = null;
+  let ended = false;
+  let rushing = 0;
+  const patch = (status, extra = {}) => {
+    const next = { status };
+    const saved = extra.lastSavedAt ?? state.lastSavedAt;
+    if (saved !== void 0) next.lastSavedAt = saved;
+    if (extra.lastError !== void 0) next.lastError = extra.lastError;
+    state = next;
+    options.onStatus?.(state);
+  };
+  const clearTimer = () => {
+    if (timer !== null) timers.clearTimeout(timer);
+    timer = null;
+  };
+  const arm = () => {
+    clearTimer();
+    timer = timers.setTimeout(() => {
+      timer = null;
+      void start();
+    }, debounceMs);
+    if (state.status !== "pending") patch("pending");
+  };
+  const sleep = (ms) => new Promise((resolve) => {
+    if (rushing > 0) return resolve();
+    const handle = timers.setTimeout(done, ms);
+    function done() {
+      timers.clearTimeout(handle);
+      wake = null;
+      resolve();
+    }
+    wake = done;
+  });
+  const settledStatus = () => state.lastSavedAt === void 0 ? "idle" : "saved";
+  async function run() {
+    const gen = generation;
+    const isCurrent = () => gen === generation;
+    patch("saving");
+    try {
+      for (let attempt = 1; ; attempt++) {
+        dirty = false;
+        try {
+          let bytes = options.serialize({ isCurrent });
+          if (isThenable(bytes)) bytes = await bytes;
+          if (!isCurrent()) return;
+          if (bytes === null || bytes === void 0) {
+            if (dirty) arm();
+            else patch(settledStatus());
+            return;
+          }
+          const acknowledged = options.write(bytes);
+          if (isThenable(acknowledged)) await acknowledged;
+          if (!isCurrent()) return;
+          const lastSavedAt = now();
+          if (dirty) {
+            patch("pending", { lastSavedAt });
+            arm();
+          } else {
+            patch("saved", { lastSavedAt });
+          }
+          return;
+        } catch (error) {
+          if (!isCurrent()) return;
+          if (attempt >= attempts) {
+            dirty = true;
+            patch("failed", { lastError: error });
+            return;
+          }
+          await sleep(Math.min(maxDelay, baseDelay * 2 ** (attempt - 1)));
+          if (!isCurrent()) return;
+        }
+      }
+    } finally {
+      ended = true;
+      running = null;
+      if (dirty && timer === null && !disposed && state.status !== "failed") arm();
+    }
+  }
+  function start() {
+    if (running) return running;
+    ended = false;
+    const promise = run();
+    if (!ended) running = promise;
+    return promise;
+  }
+  function cancel() {
+    generation++;
+    clearTimer();
+    dirty = false;
+    const waiting = wake;
+    wake = null;
+    waiting?.();
+    if (state.status === "pending" || state.status === "saving") patch(settledStatus());
+  }
+  return {
+    schedule() {
+      if (disposed) return;
+      dirty = true;
+      if (running) return;
+      arm();
+    },
+    async flush() {
+      if (disposed) return;
+      clearTimer();
+      rushing++;
+      try {
+        wake?.();
+        for (; ; ) {
+          if (running) await running;
+          else if (dirty) await start();
+          else return;
+          if (disposed) return;
+          if (state.status === "failed") throw state.lastError;
+          clearTimer();
+        }
+      } finally {
+        rushing--;
+      }
+    },
+    cancel,
+    dispose() {
+      if (disposed) return;
+      cancel();
+      disposed = true;
+    },
+    get state() {
+      return state;
+    },
+    get dirty() {
+      return dirty;
+    }
+  };
+}
+
+// collab/write-back-lifecycle.ts
+function flushWriteBackOnPageClose(scheduler, options = {}) {
+  const globals = globalThis;
+  const win = options.window === void 0 ? typeof globals.addEventListener === "function" ? globalThis : null : options.window;
+  const doc = options.document === void 0 ? globals.document ?? null : options.document;
+  const flush = () => {
+    if (!scheduler.dirty) return;
+    scheduler.flush().catch((error) => options.onError?.(error));
+  };
+  const hidden = () => {
+    if (doc?.visibilityState === "hidden") flush();
+  };
+  win?.addEventListener("pagehide", flush);
+  doc?.addEventListener("visibilitychange", hidden);
+  return () => {
+    win?.removeEventListener("pagehide", flush);
+    doc?.removeEventListener("visibilitychange", hidden);
+  };
+}
+
 exports.BROADCAST_THROTTLE_MS = BROADCAST_THROTTLE_MS;
 exports.BoundedMap = BoundedMap;
 exports.COLLABORATION_CHANGE_EVENT = COLLABORATION_CHANGE_EVENT;
@@ -1533,6 +1718,7 @@ exports.CONNECTION_TIMEOUT_MS = CONNECTION_TIMEOUT_MS;
 exports.CURSOR_PALETTE = CURSOR_PALETTE;
 exports.DEFAULT_COLOR = DEFAULT_COLOR;
 exports.DEFAULT_MAX_PACKAGE_BYTES = DEFAULT_MAX_PACKAGE_BYTES;
+exports.DEFAULT_WRITE_BACK_DEBOUNCE_MS = DEFAULT_WRITE_BACK_DEBOUNCE_MS;
 exports.DEPARTURE_CHANNEL = DEPARTURE_CHANNEL;
 exports.Emitter = Emitter;
 exports.INITIAL_SYNC_GRACE_MS = INITIAL_SYNC_GRACE_MS;
@@ -1575,11 +1761,13 @@ exports.createPresencePublisher = createPresencePublisher;
 exports.createSyncGate = createSyncGate;
 exports.createTransportProvider = createTransportProvider;
 exports.createWebSocketTransport = createWebSocketTransport;
+exports.createWriteBackScheduler = createWriteBackScheduler;
 exports.deriveCanvasPresence = deriveCanvasPresence;
 exports.derivePresence = derivePresence;
 exports.encodeDiff = encodeDiff;
 exports.encodeSnapshot = encodeSnapshot;
 exports.encodeStateVector = encodeStateVector2;
+exports.flushWriteBackOnPageClose = flushWriteBackOnPageClose;
 exports.formatCursorLabel = formatCursorLabel;
 exports.freezeDeep = freezeDeep;
 exports.fromBase64 = fromBase64;
@@ -1617,3 +1805,4 @@ exports.validateDisplayName = validateDisplayName;
 exports.validateRoomId = validateRoomId;
 exports.validateUpdate = validateUpdate;
 exports.webrtcProvider = webrtcProvider;
+exports.writeBackStateOf = writeBackStateOf;

package/dist/collab/index.d.ts

@@ -19,4 +19,6 @@ export * from './transport-provider.js';
 export * from './validation.js';
 export * from './webrtc-provider.js';
 export * from './websocket-transport.js';
+export * from './write-back.js';
+export * from './write-back-lifecycle.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/collab/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../collab/index.ts"],"names":[],"mappings":"AAIA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,uBAAuB,CAAC;AACtC,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../collab/index.ts"],"names":[],"mappings":"AAIA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,uBAAuB,CAAC;AACtC,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC"}

package/dist/collab/index.mjs

@@ -1499,4 +1499,189 @@ function freezeDeep(value) {
   return value;
 }
 
-export { BROADCAST_THROTTLE_MS, BoundedMap, COLLABORATION_CHANGE_EVENT, COLLABORATION_OFF_STATE, COLLABORATION_ROLES, COLLAB_LEAVE_MESSAGE, CONNECTION_TIMEOUT_MS, CURSOR_PALETTE, DEFAULT_COLOR, DEFAULT_MAX_PACKAGE_BYTES, DEPARTURE_CHANNEL, Emitter, INITIAL_SYNC_GRACE_MS, INVALID_ROOM_MESSAGE, IdempotencyCache, LEGACY_PPTX_DEPARTURE_CHANNEL, LEGACY_PPTX_LEAVE_MESSAGE, LOCAL_ORIGIN, MAX_LABEL_CHARS, MAX_UPDATE_BYTES, MESSAGE_AWARENESS, MESSAGE_QUERY_AWARENESS, MESSAGE_SYNC, NO_BROADCAST_MESSAGE, PRESENCE_FIELD, PRESENCE_HEARTBEAT_MS, STALE_PRESENCE_MS, SequenceTracker, adaptYjsProvider, applyUpdateSafe, asSelectionIds, assignUserColor, bindDocument, borrowAwareness, buildRoster, canBroadcast, canWrite, clampCoordinate, classifyVersion, clearLocalAwareness, collaborationStateOf, createAssetSync, createBroadcastTransport, createClientId, createCollabSession, createDepartureChannel, createIdGenerator, createMemoryHub, createPresencePublisher, createSyncGate, createTransportProvider, createWebSocketTransport, deriveCanvasPresence, derivePresence, encodeDiff, encodeSnapshot, encodeStateVector2 as encodeStateVector, formatCursorLabel, freezeDeep, fromBase64, getUserInitials, isMixedContentBlocked, isNonNegativeSafeInteger, isPresenceFresh, isValidId, isValidRoomId, mergeUpdates2 as mergeUpdates, observeExternalSession, onCollaborationStateChange, openCollaborationSession, packageAdapter, presenceToCursors, randomToken, registerTeardown, removeAwarenessStatesLocally, restoreSnapshot, roomUrl, sanitizeAvatarUrl, sanitizeCanvasPayload, sanitizeColor, sanitizeIdentity, sanitizeIndex, sanitizeRole, sanitizeUserName, shouldAutoFollowBroadcaster, shouldRoomReplaceLoad, stripHtmlTags, toBase64, toExternalSession, transportProvider, validateDisplayName, validateRoomId, validateUpdate, webrtcProvider };
+// collab/write-back.ts
+var DEFAULT_WRITE_BACK_DEBOUNCE_MS = 5e3;
+var DEFAULT_RETRY_BASE_MS = 1e3;
+var DEFAULT_RETRY_MAX_MS = 3e4;
+var globalTimers = {
+  setTimeout: (callback, ms) => globalThis.setTimeout(callback, ms),
+  clearTimeout: (handle) => globalThis.clearTimeout(handle)
+};
+var isThenable = (value) => typeof value === "object" && value !== null && typeof value.then === "function";
+function writeBackStateOf(state) {
+  const out = { status: state.status };
+  if (state.lastSavedAt !== void 0) out.lastSavedAt = state.lastSavedAt;
+  if (state.status === "failed" && state.lastError !== void 0) {
+    out.error = state.lastError instanceof Error ? state.lastError.message : String(state.lastError);
+  }
+  return out;
+}
+function createWriteBackScheduler(options) {
+  const timers = options.timers ?? globalTimers;
+  const now = options.now ?? Date.now;
+  const configured = options.debounceMs;
+  const debounceMs = configured !== void 0 && Number.isFinite(configured) && configured >= 0 ? configured : DEFAULT_WRITE_BACK_DEBOUNCE_MS;
+  const attempts = Math.max(1, Math.floor(options.retry?.attempts ?? 1) || 1);
+  const baseDelay = Math.max(0, options.retry?.baseDelayMs ?? DEFAULT_RETRY_BASE_MS);
+  const maxDelay = Math.max(baseDelay, options.retry?.maxDelayMs ?? DEFAULT_RETRY_MAX_MS);
+  let state = { status: "idle" };
+  let generation = 0;
+  let disposed = false;
+  let dirty = false;
+  let timer = null;
+  let running = null;
+  let wake = null;
+  let ended = false;
+  let rushing = 0;
+  const patch = (status, extra = {}) => {
+    const next = { status };
+    const saved = extra.lastSavedAt ?? state.lastSavedAt;
+    if (saved !== void 0) next.lastSavedAt = saved;
+    if (extra.lastError !== void 0) next.lastError = extra.lastError;
+    state = next;
+    options.onStatus?.(state);
+  };
+  const clearTimer = () => {
+    if (timer !== null) timers.clearTimeout(timer);
+    timer = null;
+  };
+  const arm = () => {
+    clearTimer();
+    timer = timers.setTimeout(() => {
+      timer = null;
+      void start();
+    }, debounceMs);
+    if (state.status !== "pending") patch("pending");
+  };
+  const sleep = (ms) => new Promise((resolve) => {
+    if (rushing > 0) return resolve();
+    const handle = timers.setTimeout(done, ms);
+    function done() {
+      timers.clearTimeout(handle);
+      wake = null;
+      resolve();
+    }
+    wake = done;
+  });
+  const settledStatus = () => state.lastSavedAt === void 0 ? "idle" : "saved";
+  async function run() {
+    const gen = generation;
+    const isCurrent = () => gen === generation;
+    patch("saving");
+    try {
+      for (let attempt = 1; ; attempt++) {
+        dirty = false;
+        try {
+          let bytes = options.serialize({ isCurrent });
+          if (isThenable(bytes)) bytes = await bytes;
+          if (!isCurrent()) return;
+          if (bytes === null || bytes === void 0) {
+            if (dirty) arm();
+            else patch(settledStatus());
+            return;
+          }
+          const acknowledged = options.write(bytes);
+          if (isThenable(acknowledged)) await acknowledged;
+          if (!isCurrent()) return;
+          const lastSavedAt = now();
+          if (dirty) {
+            patch("pending", { lastSavedAt });
+            arm();
+          } else {
+            patch("saved", { lastSavedAt });
+          }
+          return;
+        } catch (error) {
+          if (!isCurrent()) return;
+          if (attempt >= attempts) {
+            dirty = true;
+            patch("failed", { lastError: error });
+            return;
+          }
+          await sleep(Math.min(maxDelay, baseDelay * 2 ** (attempt - 1)));
+          if (!isCurrent()) return;
+        }
+      }
+    } finally {
+      ended = true;
+      running = null;
+      if (dirty && timer === null && !disposed && state.status !== "failed") arm();
+    }
+  }
+  function start() {
+    if (running) return running;
+    ended = false;
+    const promise = run();
+    if (!ended) running = promise;
+    return promise;
+  }
+  function cancel() {
+    generation++;
+    clearTimer();
+    dirty = false;
+    const waiting = wake;
+    wake = null;
+    waiting?.();
+    if (state.status === "pending" || state.status === "saving") patch(settledStatus());
+  }
+  return {
+    schedule() {
+      if (disposed) return;
+      dirty = true;
+      if (running) return;
+      arm();
+    },
+    async flush() {
+      if (disposed) return;
+      clearTimer();
+      rushing++;
+      try {
+        wake?.();
+        for (; ; ) {
+          if (running) await running;
+          else if (dirty) await start();
+          else return;
+          if (disposed) return;
+          if (state.status === "failed") throw state.lastError;
+          clearTimer();
+        }
+      } finally {
+        rushing--;
+      }
+    },
+    cancel,
+    dispose() {
+      if (disposed) return;
+      cancel();
+      disposed = true;
+    },
+    get state() {
+      return state;
+    },
+    get dirty() {
+      return dirty;
+    }
+  };
+}
+
+// collab/write-back-lifecycle.ts
+function flushWriteBackOnPageClose(scheduler, options = {}) {
+  const globals = globalThis;
+  const win = options.window === void 0 ? typeof globals.addEventListener === "function" ? globalThis : null : options.window;
+  const doc = options.document === void 0 ? globals.document ?? null : options.document;
+  const flush = () => {
+    if (!scheduler.dirty) return;
+    scheduler.flush().catch((error) => options.onError?.(error));
+  };
+  const hidden = () => {
+    if (doc?.visibilityState === "hidden") flush();
+  };
+  win?.addEventListener("pagehide", flush);
+  doc?.addEventListener("visibilitychange", hidden);
+  return () => {
+    win?.removeEventListener("pagehide", flush);
+    doc?.removeEventListener("visibilitychange", hidden);
+  };
+}
+
+export { BROADCAST_THROTTLE_MS, BoundedMap, COLLABORATION_CHANGE_EVENT, COLLABORATION_OFF_STATE, COLLABORATION_ROLES, COLLAB_LEAVE_MESSAGE, CONNECTION_TIMEOUT_MS, CURSOR_PALETTE, DEFAULT_COLOR, DEFAULT_MAX_PACKAGE_BYTES, DEFAULT_WRITE_BACK_DEBOUNCE_MS, DEPARTURE_CHANNEL, Emitter, INITIAL_SYNC_GRACE_MS, INVALID_ROOM_MESSAGE, IdempotencyCache, LEGACY_PPTX_DEPARTURE_CHANNEL, LEGACY_PPTX_LEAVE_MESSAGE, LOCAL_ORIGIN, MAX_LABEL_CHARS, MAX_UPDATE_BYTES, MESSAGE_AWARENESS, MESSAGE_QUERY_AWARENESS, MESSAGE_SYNC, NO_BROADCAST_MESSAGE, PRESENCE_FIELD, PRESENCE_HEARTBEAT_MS, STALE_PRESENCE_MS, SequenceTracker, adaptYjsProvider, applyUpdateSafe, asSelectionIds, assignUserColor, bindDocument, borrowAwareness, buildRoster, canBroadcast, canWrite, clampCoordinate, classifyVersion, clearLocalAwareness, collaborationStateOf, createAssetSync, createBroadcastTransport, createClientId, createCollabSession, createDepartureChannel, createIdGenerator, createMemoryHub, createPresencePublisher, createSyncGate, createTransportProvider, createWebSocketTransport, createWriteBackScheduler, deriveCanvasPresence, derivePresence, encodeDiff, encodeSnapshot, encodeStateVector2 as encodeStateVector, flushWriteBackOnPageClose, formatCursorLabel, freezeDeep, fromBase64, getUserInitials, isMixedContentBlocked, isNonNegativeSafeInteger, isPresenceFresh, isValidId, isValidRoomId, mergeUpdates2 as mergeUpdates, observeExternalSession, onCollaborationStateChange, openCollaborationSession, packageAdapter, presenceToCursors, randomToken, registerTeardown, removeAwarenessStatesLocally, restoreSnapshot, roomUrl, sanitizeAvatarUrl, sanitizeCanvasPayload, sanitizeColor, sanitizeIdentity, sanitizeIndex, sanitizeRole, sanitizeUserName, shouldAutoFollowBroadcaster, shouldRoomReplaceLoad, stripHtmlTags, toBase64, toExternalSession, transportProvider, validateDisplayName, validateRoomId, validateUpdate, webrtcProvider, writeBackStateOf };

package/dist/collab/write-back-lifecycle.d.ts

@@ -0,0 +1,33 @@
+import type { WriteBackScheduler } from './write-back.js';
+/** The part of `window` used: `pagehide` is listened on it. */
+export interface PageHideTarget {
+    addEventListener(type: 'pagehide', listener: () => void): void;
+    removeEventListener(type: 'pagehide', listener: () => void): void;
+}
+/** The part of `document` used: `visibilitychange` is listened on it. */
+export interface VisibilityTarget {
+    readonly visibilityState?: string;
+    addEventListener(type: 'visibilitychange', listener: () => void): void;
+    removeEventListener(type: 'visibilitychange', listener: () => void): void;
+}
+export interface FlushOnPageCloseOptions {
+    /** Default `globalThis` when it can listen (a browser window), otherwise no `pagehide` hook. */
+    window?: PageHideTarget | null;
+    /** Default `globalThis.document` when present. */
+    document?: VisibilityTarget | null;
+    /** Receives a flush that failed (it never throws). Default ignores it. */
+    onError?: (error: unknown) => void;
+}
+/**
+ * Flushes `scheduler` on `pagehide` and when the page turns hidden, and returns the function that
+ * removes the listeners. Only unsaved work is written.
+ *
+ * Browsers do not wait for asynchronous work when a page unloads: the flush starts the write, but
+ * a write that needs a network round trip can still be lost on close. A host that must survive a
+ * close should send the bytes with `navigator.sendBeacon(url, bytes)` or
+ * `fetch(url, { method: 'PUT', body: bytes, keepalive: true })` (the browser caps keepalive bodies
+ * at about 64 KiB, so a large document may still not make it), which the browser completes after
+ * the page is gone.
+ */
+export declare function flushWriteBackOnPageClose(scheduler: Pick<WriteBackScheduler, 'flush' | 'dirty'>, options?: FlushOnPageCloseOptions): () => void;
+//# sourceMappingURL=write-back-lifecycle.d.ts.map

package/dist/collab/write-back-lifecycle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"write-back-lifecycle.d.ts","sourceRoot":"","sources":["../../collab/write-back-lifecycle.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAEvD,+DAA+D;AAC/D,MAAM,WAAW,cAAc;IAC9B,gBAAgB,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAC/D,mBAAmB,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CAClE;AAED,yEAAyE;AACzE,MAAM,WAAW,gBAAgB;IAChC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,gBAAgB,CAAC,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IACvE,mBAAmB,CAAC,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CAC1E;AAED,MAAM,WAAW,uBAAuB;IACvC,gGAAgG;IAChG,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAC/B,kDAAkD;IAClD,QAAQ,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACnC,0EAA0E;IAC1E,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CACnC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,yBAAyB,CACxC,SAAS,EAAE,IAAI,CAAC,kBAAkB,EAAE,OAAO,GAAG,OAAO,CAAC,EACtD,OAAO,GAAE,uBAA4B,GACnC,MAAM,IAAI,CAyBZ"}