@openpresentation/opf-editor 0.26.8 → 0.26.9

package/README.md

@@ -707,7 +707,7 @@ const persistence = createPersistence(editor, {
   storage: "indexeddb",               // default; or "localstorage", "memory", false, or your own { get, set, delete } adapter
   onRestorePrompt: ui.prompt,         // or return "restore" | "discard" | "later" (or a promise) yourself
   onStatus: ui.status,                // "Saved on this device at 2:03 PM", or why autosave is off
-  beforeFlush: () => canvas.commit(), // commit a draft before every write and before the page unloads
+  beforeFlush: () => canvas.commit(), // commit a draft before an explicit flush and before the page unloads (the debounced write leaves a draft alone)
 });
 await persistence.ready;              // { available, offered }: storage opened and read (it does not wait for the user's decision)
 await persistence.markSaved();        // after the host saved the document somewhere of its own: not unsaved, and the stored copy says so

package/dist/persistence.d.ts

@@ -63,7 +63,7 @@ export interface PersistenceOptions {
   onRestorePrompt?: (offer: RestoreOffer, actions: { restore(): Promise<boolean>; discard(): Promise<boolean> }) => RestoreChoice | Promise<RestoreChoice>;
   /** Called on every status change, for an indicator. */
   onStatus?: (status: AutosaveStatus) => void;
-  /** Called synchronously before each explicit, debounced or lifecycle flush, even before any session edit. Commit the active draft; returning false or throwing refuses the write and reports a draft error. */
+  /** Called synchronously before each explicit or lifecycle flush (`flush()`, `markSaved()`, `beforeunload`, `pagehide`), even before any session edit. The debounced autosave does not call it: it writes the committed document and leaves an edit in progress alone. Commit the active draft; returning false or throwing refuses the write and reports a draft error. */
   beforeFlush?: () => boolean | void;
   /** Warn before the page closes while the document is `dirty` (default true). */
   warnOnUnload?: boolean;

package/dist/persistence.js

@@ -223,29 +223,38 @@ export function createPersistence(editor, options = {}) {
     if (!firstDirtyAt) firstDirtyAt = at;
     clearTimeout(timer);
     const wait = Math.max(0, Math.min(debounceMs, firstDirtyAt + maxWaitMs - at));
-    timer = setTimeout(() => { void flush(); }, wait);
+    timer = setTimeout(() => { void flushNow(false); }, wait);
   }
   /** Write the document now (cancelling the debounce) and resolve when it is stored. Resolves false when nothing could be written. */
   function flush() {
+    return flushNow(true);
+  }
+  // The debounce timer writes what is committed and leaves an edit in progress alone: committing it would close the inline editor
+  // under the user's hands, a moment after an earlier change (the timer starts at that change) and long before they stop typing.
+  // The draft is not lost: the page is still open, and every flush that precedes leaving (unload, page hide, `flush()`, `markSaved()`)
+  // commits it first.
+  function flushNow(commitDraft) {
     clearTimeout(timer);
     firstDirtyAt = 0;
     if (destroyed) return Promise.resolve(false);
-    // Commit synchronously, including a draft in an otherwise untouched session. The lifecycle
-    // warning below must see that edit before it decides whether leaving would lose work.
-    // A commit emits a change; clear its debounce again and avoid recursive host flush hooks.
-    if (preparingFlush) return chain;
-    preparingFlush = true;
-    try {
-      if (options.beforeFlush?.() === false) throw new Error("Commit or cancel the active draft first.");
-      flushRefused = false;
-    } catch (error) {
-      flushRefused = true;
-      setStatus({ state: "error", error: "draft", message: `Autosave could not commit the active draft (${String(error?.message ?? error)}). Keep this page open to recover your work.` });
-      return Promise.resolve(false);
-    } finally {
-      preparingFlush = false;
-      clearTimeout(timer);
-      firstDirtyAt = 0;
+    if (commitDraft) {
+      // Commit synchronously, including a draft in an otherwise untouched session. The lifecycle
+      // warning below must see that edit before it decides whether leaving would lose work.
+      // A commit emits a change; clear its debounce again and avoid recursive host flush hooks.
+      if (preparingFlush) return chain;
+      preparingFlush = true;
+      try {
+        if (options.beforeFlush?.() === false) throw new Error("Commit or cancel the active draft first.");
+        flushRefused = false;
+      } catch (error) {
+        flushRefused = true;
+        setStatus({ state: "error", error: "draft", message: `Autosave could not commit the active draft (${String(error?.message ?? error)}). Keep this page open to recover your work.` });
+        return Promise.resolve(false);
+      } finally {
+        preparingFlush = false;
+        clearTimeout(timer);
+        firstDirtyAt = 0;
+      }
     }
     if (!touched) return chain.then(() => true);
     chain = chain.then(writeRecord, writeRecord);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openpresentation/opf-editor",
-  "version": "0.26.8",
+  "version": "0.26.9",
   "description": "Embeddable local OPF editor primitives built on the deterministic renderer.",
   "license": "MIT",
   "type": "module",
@@ -287,10 +287,10 @@
     "@lezer/highlight": "1.2.5",
     "jsonc-parser": "3.3.1",
     "yaml": "^2.9.1",
-    "@openpresentation/opf": "^0.26.8"
+    "@openpresentation/opf": "^0.26.9"
   },
   "peerDependencies": {
-    "@openpresentation/opf-render": "^0.26.8"
+    "@openpresentation/opf-render": "^0.26.9"
   },
   "peerDependenciesMeta": {
     "@openpresentation/opf-render": {
@@ -349,9 +349,9 @@
     "pdf-lib": "1.17.1",
     "pdfjs-dist": "6.4.299",
     "playwright": "1.64.0",
-    "@openpresentation/gallery": "0.26.8",
-    "@openpresentation/opf-pptx": "0.26.8",
-    "@openpresentation/opf-render": "0.26.8"
+    "@openpresentation/opf-pptx": "0.26.9",
+    "@openpresentation/gallery": "0.26.9",
+    "@openpresentation/opf-render": "0.26.9"
   },
   "scripts": {
     "build": "node scripts/build.mjs",
@@ -402,5 +402,5 @@
     "test:export-menu-browser": "node test/export-menu-browser.mjs",
     "test:agent-handoff-browser": "node test/agent-handoff-browser.mjs"
   },
-  "gitHead": "bb6faa40bebc1654f607bf6a434c43b5e95d0b1e"
+  "gitHead": "7563d8dea2ba24a36b032614a50f665876d145e5"
 }