fabricjs-document-engine 0.1.0 → 0.2.0

package/dist/index.cjs

@@ -4,9 +4,12 @@ const require_validate_document = require("./document/validate-document.cjs");
 const require_errors = require("./engine/errors.cjs");
 const require_create_document_engine = require("./engine/create-document-engine.cjs");
 const require_keyboard_shortcuts = require("./history/keyboard-shortcuts.cjs");
+const require_unsaved_changes_warning = require("./save/unsaved-changes-warning.cjs");
 exports.CURRENT_SCHEMA_VERSION = require_document_format.CURRENT_SCHEMA_VERSION;
 exports.DocumentEngineError = require_errors.DocumentEngineError;
 exports.bindKeyboardShortcuts = require_keyboard_shortcuts.bindKeyboardShortcuts;
+exports.bindUnsavedChangesWarning = require_unsaved_changes_warning.bindUnsavedChangesWarning;
+exports.createConflictError = require_errors.createConflictError;
 exports.createDocumentEngine = require_create_document_engine.createDocumentEngine;
 exports.isDocumentEngineError = require_errors.isDocumentEngineError;
 exports.validateDocument = require_validate_document.validateDocument;

package/dist/index.d.cts

@@ -2,9 +2,14 @@ import { CURRENT_SCHEMA_VERSION, DocumentCanvas, DocumentInfo, FabricDocument, S
 import { NewDocumentOptions } from "./document/create-document.cjs";
 import { CustomObjectDefinition } from "./fabric/object-registry.cjs";
 import { HistoryOptions, HistoryState } from "./history/create-history.cjs";
-import { DocumentEngineError, DocumentEngineErrorDetails, DocumentErrorCode, DocumentIssue, isDocumentEngineError } from "./engine/errors.cjs";
+import { AutosaveOptions } from "./save/autosave-scheduler.cjs";
+import { RetryOptions } from "./save/retry.cjs";
+import { DocumentEngineError, DocumentEngineErrorDetails, DocumentErrorCode, DocumentIssue, createConflictError, isDocumentEngineError } from "./engine/errors.cjs";
+import { DocumentStorage, SaveContext, SaveResult } from "./storage/storage-contract.cjs";
+import { SaveOptions, SaveRetryEvent, SaveState, SaveStatus } from "./save/save-controller.cjs";
 import { Unsubscribe } from "./engine/event-emitter.cjs";
-import { DocumentEngine, DocumentEngineEvents, DocumentEngineOptions, DocumentStorage, LoadOptions, createDocumentEngine } from "./engine/create-document-engine.cjs";
+import { DocumentEngine, DocumentEngineEvents, DocumentEngineOptions, LoadOptions, createDocumentEngine } from "./engine/create-document-engine.cjs";
 import { validateDocument } from "./document/validate-document.cjs";
 import { KeyboardShortcutOptions, UndoRedoTarget, bindKeyboardShortcuts } from "./history/keyboard-shortcuts.cjs";
-export { CURRENT_SCHEMA_VERSION, type CustomObjectDefinition, type DocumentCanvas, type DocumentEngine, DocumentEngineError, type DocumentEngineErrorDetails, type DocumentEngineEvents, type DocumentEngineOptions, type DocumentErrorCode, type DocumentInfo, type DocumentIssue, type DocumentStorage, type FabricDocument, type HistoryOptions, type HistoryState, type KeyboardShortcutOptions, type LoadOptions, type NewDocumentOptions, type SerializedFabricObject, type UndoRedoTarget, type Unsubscribe, bindKeyboardShortcuts, createDocumentEngine, isDocumentEngineError, validateDocument };
+import { UnsavedChangesSource, bindUnsavedChangesWarning } from "./save/unsaved-changes-warning.cjs";
+export { type AutosaveOptions, CURRENT_SCHEMA_VERSION, type CustomObjectDefinition, type DocumentCanvas, type DocumentEngine, DocumentEngineError, type DocumentEngineErrorDetails, type DocumentEngineEvents, type DocumentEngineOptions, type DocumentErrorCode, type DocumentInfo, type DocumentIssue, type DocumentStorage, type FabricDocument, type HistoryOptions, type HistoryState, type KeyboardShortcutOptions, type LoadOptions, type NewDocumentOptions, type RetryOptions, type SaveContext, type SaveOptions, type SaveResult, type SaveRetryEvent, type SaveState, type SaveStatus, type SerializedFabricObject, type UndoRedoTarget, type UnsavedChangesSource, type Unsubscribe, bindKeyboardShortcuts, bindUnsavedChangesWarning, createConflictError, createDocumentEngine, isDocumentEngineError, validateDocument };

package/dist/index.d.ts

@@ -2,9 +2,14 @@ import { CURRENT_SCHEMA_VERSION, DocumentCanvas, DocumentInfo, FabricDocument, S
 import { NewDocumentOptions } from "./document/create-document.js";
 import { CustomObjectDefinition } from "./fabric/object-registry.js";
 import { HistoryOptions, HistoryState } from "./history/create-history.js";
-import { DocumentEngineError, DocumentEngineErrorDetails, DocumentErrorCode, DocumentIssue, isDocumentEngineError } from "./engine/errors.js";
+import { AutosaveOptions } from "./save/autosave-scheduler.js";
+import { RetryOptions } from "./save/retry.js";
+import { DocumentEngineError, DocumentEngineErrorDetails, DocumentErrorCode, DocumentIssue, createConflictError, isDocumentEngineError } from "./engine/errors.js";
+import { DocumentStorage, SaveContext, SaveResult } from "./storage/storage-contract.js";
+import { SaveOptions, SaveRetryEvent, SaveState, SaveStatus } from "./save/save-controller.js";
 import { Unsubscribe } from "./engine/event-emitter.js";
-import { DocumentEngine, DocumentEngineEvents, DocumentEngineOptions, DocumentStorage, LoadOptions, createDocumentEngine } from "./engine/create-document-engine.js";
+import { DocumentEngine, DocumentEngineEvents, DocumentEngineOptions, LoadOptions, createDocumentEngine } from "./engine/create-document-engine.js";
 import { validateDocument } from "./document/validate-document.js";
 import { KeyboardShortcutOptions, UndoRedoTarget, bindKeyboardShortcuts } from "./history/keyboard-shortcuts.js";
-export { CURRENT_SCHEMA_VERSION, type CustomObjectDefinition, type DocumentCanvas, type DocumentEngine, DocumentEngineError, type DocumentEngineErrorDetails, type DocumentEngineEvents, type DocumentEngineOptions, type DocumentErrorCode, type DocumentInfo, type DocumentIssue, type DocumentStorage, type FabricDocument, type HistoryOptions, type HistoryState, type KeyboardShortcutOptions, type LoadOptions, type NewDocumentOptions, type SerializedFabricObject, type UndoRedoTarget, type Unsubscribe, bindKeyboardShortcuts, createDocumentEngine, isDocumentEngineError, validateDocument };
+import { UnsavedChangesSource, bindUnsavedChangesWarning } from "./save/unsaved-changes-warning.js";
+export { type AutosaveOptions, CURRENT_SCHEMA_VERSION, type CustomObjectDefinition, type DocumentCanvas, type DocumentEngine, DocumentEngineError, type DocumentEngineErrorDetails, type DocumentEngineEvents, type DocumentEngineOptions, type DocumentErrorCode, type DocumentInfo, type DocumentIssue, type DocumentStorage, type FabricDocument, type HistoryOptions, type HistoryState, type KeyboardShortcutOptions, type LoadOptions, type NewDocumentOptions, type RetryOptions, type SaveContext, type SaveOptions, type SaveResult, type SaveRetryEvent, type SaveState, type SaveStatus, type SerializedFabricObject, type UndoRedoTarget, type UnsavedChangesSource, type Unsubscribe, bindKeyboardShortcuts, bindUnsavedChangesWarning, createConflictError, createDocumentEngine, isDocumentEngineError, validateDocument };

package/dist/index.js

@@ -1,6 +1,7 @@
 import { CURRENT_SCHEMA_VERSION } from "./document/document-format.js";
 import { validateDocument } from "./document/validate-document.js";
-import { DocumentEngineError, isDocumentEngineError } from "./engine/errors.js";
+import { DocumentEngineError, createConflictError, isDocumentEngineError } from "./engine/errors.js";
 import { createDocumentEngine } from "./engine/create-document-engine.js";
 import { bindKeyboardShortcuts } from "./history/keyboard-shortcuts.js";
-export { CURRENT_SCHEMA_VERSION, DocumentEngineError, bindKeyboardShortcuts, createDocumentEngine, isDocumentEngineError, validateDocument };
+import { bindUnsavedChangesWarning } from "./save/unsaved-changes-warning.js";
+export { CURRENT_SCHEMA_VERSION, DocumentEngineError, bindKeyboardShortcuts, bindUnsavedChangesWarning, createConflictError, createDocumentEngine, isDocumentEngineError, validateDocument };

package/dist/save/autosave-scheduler.cjs

@@ -0,0 +1,28 @@
+//#region src/save/autosave-scheduler.ts
+function createAutosaveScheduler(run, options = {}) {
+	const delay = options.delay ?? 1e3;
+	const maxWait = Math.max(delay, options.maxWait ?? 1e4);
+	let timer;
+	let firstRequestAt;
+	function cancel() {
+		if (timer !== void 0) clearTimeout(timer);
+		timer = void 0;
+		firstRequestAt = void 0;
+	}
+	function fire() {
+		cancel();
+		run();
+	}
+	return {
+		schedule() {
+			const now = Date.now();
+			firstRequestAt ?? (firstRequestAt = now);
+			const timeLeftBeforeMaxWait = maxWait - (now - firstRequestAt);
+			if (timer !== void 0) clearTimeout(timer);
+			timer = setTimeout(fire, Math.max(0, Math.min(delay, timeLeftBeforeMaxWait)));
+		},
+		cancel
+	};
+}
+//#endregion
+exports.createAutosaveScheduler = createAutosaveScheduler;

package/dist/save/autosave-scheduler.d.cts

@@ -0,0 +1,6 @@
+//#region src/save/autosave-scheduler.d.ts
+export interface AutosaveOptions {
+  delay?: number;
+  maxWait?: number;
+}
+//#endregion

package/dist/save/autosave-scheduler.d.ts

@@ -0,0 +1,6 @@
+//#region src/save/autosave-scheduler.d.ts
+export interface AutosaveOptions {
+  delay?: number;
+  maxWait?: number;
+}
+//#endregion

package/dist/save/autosave-scheduler.js

@@ -0,0 +1,28 @@
+//#region src/save/autosave-scheduler.ts
+function createAutosaveScheduler(run, options = {}) {
+	const delay = options.delay ?? 1e3;
+	const maxWait = Math.max(delay, options.maxWait ?? 1e4);
+	let timer;
+	let firstRequestAt;
+	function cancel() {
+		if (timer !== void 0) clearTimeout(timer);
+		timer = void 0;
+		firstRequestAt = void 0;
+	}
+	function fire() {
+		cancel();
+		run();
+	}
+	return {
+		schedule() {
+			const now = Date.now();
+			firstRequestAt ?? (firstRequestAt = now);
+			const timeLeftBeforeMaxWait = maxWait - (now - firstRequestAt);
+			if (timer !== void 0) clearTimeout(timer);
+			timer = setTimeout(fire, Math.max(0, Math.min(delay, timeLeftBeforeMaxWait)));
+		},
+		cancel
+	};
+}
+//#endregion
+export { createAutosaveScheduler };

package/dist/save/retry.cjs

@@ -0,0 +1,33 @@
+//#region src/save/retry.ts
+function isRetryable(error) {
+	const hints = error ?? {};
+	if (hints.code === "SAVE_CONFLICT" || hints.code === "SAVE_CANCELLED") return false;
+	return hints.retryable !== false;
+}
+function retryDelay(attempt, options = {}) {
+	const baseDelay = options.baseDelay ?? 500;
+	const maxDelay = options.maxDelay ?? 8e3;
+	const ceiling = Math.min(maxDelay, baseDelay * 2 ** attempt);
+	return ceiling / 2 + Math.random() * (ceiling / 2);
+}
+function wait(milliseconds, signal) {
+	return new Promise((resolve, reject) => {
+		if (signal.aborted) {
+			reject(/* @__PURE__ */ new Error("aborted"));
+			return;
+		}
+		const stop = () => {
+			clearTimeout(timer);
+			reject(/* @__PURE__ */ new Error("aborted"));
+		};
+		const timer = setTimeout(() => {
+			signal.removeEventListener("abort", stop);
+			resolve();
+		}, milliseconds);
+		signal.addEventListener("abort", stop, { once: true });
+	});
+}
+//#endregion
+exports.isRetryable = isRetryable;
+exports.retryDelay = retryDelay;
+exports.wait = wait;

package/dist/save/retry.d.cts

@@ -0,0 +1,7 @@
+//#region src/save/retry.d.ts
+export interface RetryOptions {
+  attempts?: number;
+  baseDelay?: number;
+  maxDelay?: number;
+}
+//#endregion

package/dist/save/retry.d.ts

@@ -0,0 +1,7 @@
+//#region src/save/retry.d.ts
+export interface RetryOptions {
+  attempts?: number;
+  baseDelay?: number;
+  maxDelay?: number;
+}
+//#endregion

package/dist/save/retry.js

@@ -0,0 +1,31 @@
+//#region src/save/retry.ts
+function isRetryable(error) {
+	const hints = error ?? {};
+	if (hints.code === "SAVE_CONFLICT" || hints.code === "SAVE_CANCELLED") return false;
+	return hints.retryable !== false;
+}
+function retryDelay(attempt, options = {}) {
+	const baseDelay = options.baseDelay ?? 500;
+	const maxDelay = options.maxDelay ?? 8e3;
+	const ceiling = Math.min(maxDelay, baseDelay * 2 ** attempt);
+	return ceiling / 2 + Math.random() * (ceiling / 2);
+}
+function wait(milliseconds, signal) {
+	return new Promise((resolve, reject) => {
+		if (signal.aborted) {
+			reject(/* @__PURE__ */ new Error("aborted"));
+			return;
+		}
+		const stop = () => {
+			clearTimeout(timer);
+			reject(/* @__PURE__ */ new Error("aborted"));
+		};
+		const timer = setTimeout(() => {
+			signal.removeEventListener("abort", stop);
+			resolve();
+		}, milliseconds);
+		signal.addEventListener("abort", stop, { once: true });
+	});
+}
+//#endregion
+export { isRetryable, retryDelay, wait };

package/dist/save/save-controller.cjs

@@ -0,0 +1,148 @@
+const require_errors = require("../engine/errors.cjs");
+const require_autosave_scheduler = require("./autosave-scheduler.cjs");
+const require_retry = require("./retry.cjs");
+//#region src/save/save-controller.ts
+function cancelledError() {
+	return new require_errors.DocumentEngineError("SAVE_CANCELLED", "The save was cancelled because another document was opened");
+}
+function toSaveError(error, signal) {
+	if (require_errors.isDocumentEngineError(error)) return error;
+	if (signal.aborted) return cancelledError();
+	const hints = error ?? {};
+	const reason = typeof hints.message === "string" ? hints.message : String(error);
+	if (hints.code === "SAVE_CONFLICT") return new require_errors.DocumentEngineError("SAVE_CONFLICT", reason, { cause: error });
+	return new require_errors.DocumentEngineError("SAVE_FAILED", `Storage could not save the document: ${reason}`, {
+		cause: error,
+		retryable: require_retry.isRetryable(error)
+	});
+}
+function createSaveController(options) {
+	const attempts = Math.max(0, options.retry?.attempts ?? 3);
+	let contentVersion = 0;
+	let savedVersion = 0;
+	let revision = 0;
+	let lastSavedAt;
+	let lastError;
+	let saving = false;
+	let session = 0;
+	let sessionAbort = new AbortController();
+	let inFlight = null;
+	let queued = null;
+	const isDirty = () => contentVersion !== savedVersion;
+	function state() {
+		let status = isDirty() ? "unsaved" : "saved";
+		if (lastError) status = lastError.code === "SAVE_CONFLICT" ? "conflict" : "error";
+		if (saving) status = "saving";
+		return {
+			status,
+			isDirty: isDirty(),
+			isSaving: saving,
+			revision,
+			lastSavedAt,
+			error: lastError
+		};
+	}
+	const publish = () => options.onStateChange(state());
+	const autosave = options.autosave === false || options.autosave === void 0 ? null : require_autosave_scheduler.createAutosaveScheduler(() => {
+		if (isDirty()) save().catch(() => void 0);
+	}, options.autosave);
+	async function sendWithRetries(storage, document, expectedRevision, signal) {
+		for (let attempt = 0;; attempt += 1) try {
+			return await storage.saveDocument(document, {
+				expectedRevision,
+				signal
+			});
+		} catch (error) {
+			if (signal.aborted || !require_retry.isRetryable(error) || attempt >= attempts) throw error;
+			const delay = require_retry.retryDelay(attempt, options.retry);
+			options.onRetry({
+				attempt: attempt + 1,
+				delay,
+				error
+			});
+			await require_retry.wait(delay, signal);
+		}
+	}
+	async function runSave(saveOptions) {
+		const storage = options.getStorage();
+		const sessionAtStart = session;
+		const { signal } = sessionAbort;
+		const versionAtSnapshot = contentVersion;
+		const document = {
+			...options.createDocument(),
+			revision: revision + 1
+		};
+		const expectedRevision = saveOptions.overwrite === true ? null : revision;
+		saving = true;
+		lastError = void 0;
+		publish();
+		options.onStart(document);
+		try {
+			const result = await sendWithRetries(storage, document, expectedRevision, signal);
+			if (sessionAtStart !== session) return document;
+			revision = result?.revision ?? document.revision;
+			document.revision = revision;
+			savedVersion = versionAtSnapshot;
+			lastSavedAt = (/* @__PURE__ */ new Date()).toISOString();
+			options.onSuccess(document);
+			return document;
+		} catch (error) {
+			const saveError = toSaveError(error, signal);
+			if (sessionAtStart === session) {
+				lastError = saveError;
+				options.onError(saveError);
+			}
+			throw saveError;
+		} finally {
+			if (sessionAtStart === session) {
+				saving = false;
+				publish();
+			}
+		}
+	}
+	function save(saveOptions = {}) {
+		if (inFlight === null) {
+			inFlight = runSave(saveOptions).finally(() => {
+				inFlight = null;
+			});
+			return inFlight;
+		}
+		if (queued === null) {
+			const sessionWhenQueued = session;
+			queued = inFlight.catch(() => void 0).then(() => {
+				queued = null;
+				if (sessionWhenQueued !== session) throw cancelledError();
+				return save(saveOptions);
+			});
+		}
+		return queued;
+	}
+	return {
+		save,
+		noteContentChange() {
+			contentVersion += 1;
+			autosave?.schedule();
+			publish();
+		},
+		startSession(newRevision) {
+			session += 1;
+			sessionAbort.abort();
+			sessionAbort = new AbortController();
+			autosave?.cancel();
+			saving = false;
+			savedVersion = contentVersion;
+			revision = newRevision;
+			lastSavedAt = void 0;
+			lastError = void 0;
+			publish();
+		},
+		state,
+		destroy() {
+			session += 1;
+			sessionAbort.abort();
+			autosave?.cancel();
+		}
+	};
+}
+//#endregion
+exports.createSaveController = createSaveController;

package/dist/save/save-controller.d.cts

@@ -0,0 +1,20 @@
+import { DocumentEngineError } from "../engine/errors.cjs";
+//#region src/save/save-controller.d.ts
+export type SaveStatus = "saved" | "unsaved" | "saving" | "error" | "conflict";
+export interface SaveState {
+  status: SaveStatus;
+  isDirty: boolean;
+  isSaving: boolean;
+  revision: number;
+  lastSavedAt: string | undefined;
+  error: DocumentEngineError | undefined;
+}
+export interface SaveOptions {
+  overwrite?: boolean;
+}
+export interface SaveRetryEvent {
+  attempt: number;
+  delay: number;
+  error: unknown;
+}
+//#endregion

package/dist/save/save-controller.d.ts

@@ -0,0 +1,20 @@
+import { DocumentEngineError } from "../engine/errors.js";
+//#region src/save/save-controller.d.ts
+export type SaveStatus = "saved" | "unsaved" | "saving" | "error" | "conflict";
+export interface SaveState {
+  status: SaveStatus;
+  isDirty: boolean;
+  isSaving: boolean;
+  revision: number;
+  lastSavedAt: string | undefined;
+  error: DocumentEngineError | undefined;
+}
+export interface SaveOptions {
+  overwrite?: boolean;
+}
+export interface SaveRetryEvent {
+  attempt: number;
+  delay: number;
+  error: unknown;
+}
+//#endregion

package/dist/save/save-controller.js

@@ -0,0 +1,148 @@
+import { DocumentEngineError, isDocumentEngineError } from "../engine/errors.js";
+import { createAutosaveScheduler } from "./autosave-scheduler.js";
+import { isRetryable, retryDelay, wait } from "./retry.js";
+//#region src/save/save-controller.ts
+function cancelledError() {
+	return new DocumentEngineError("SAVE_CANCELLED", "The save was cancelled because another document was opened");
+}
+function toSaveError(error, signal) {
+	if (isDocumentEngineError(error)) return error;
+	if (signal.aborted) return cancelledError();
+	const hints = error ?? {};
+	const reason = typeof hints.message === "string" ? hints.message : String(error);
+	if (hints.code === "SAVE_CONFLICT") return new DocumentEngineError("SAVE_CONFLICT", reason, { cause: error });
+	return new DocumentEngineError("SAVE_FAILED", `Storage could not save the document: ${reason}`, {
+		cause: error,
+		retryable: isRetryable(error)
+	});
+}
+function createSaveController(options) {
+	const attempts = Math.max(0, options.retry?.attempts ?? 3);
+	let contentVersion = 0;
+	let savedVersion = 0;
+	let revision = 0;
+	let lastSavedAt;
+	let lastError;
+	let saving = false;
+	let session = 0;
+	let sessionAbort = new AbortController();
+	let inFlight = null;
+	let queued = null;
+	const isDirty = () => contentVersion !== savedVersion;
+	function state() {
+		let status = isDirty() ? "unsaved" : "saved";
+		if (lastError) status = lastError.code === "SAVE_CONFLICT" ? "conflict" : "error";
+		if (saving) status = "saving";
+		return {
+			status,
+			isDirty: isDirty(),
+			isSaving: saving,
+			revision,
+			lastSavedAt,
+			error: lastError
+		};
+	}
+	const publish = () => options.onStateChange(state());
+	const autosave = options.autosave === false || options.autosave === void 0 ? null : createAutosaveScheduler(() => {
+		if (isDirty()) save().catch(() => void 0);
+	}, options.autosave);
+	async function sendWithRetries(storage, document, expectedRevision, signal) {
+		for (let attempt = 0;; attempt += 1) try {
+			return await storage.saveDocument(document, {
+				expectedRevision,
+				signal
+			});
+		} catch (error) {
+			if (signal.aborted || !isRetryable(error) || attempt >= attempts) throw error;
+			const delay = retryDelay(attempt, options.retry);
+			options.onRetry({
+				attempt: attempt + 1,
+				delay,
+				error
+			});
+			await wait(delay, signal);
+		}
+	}
+	async function runSave(saveOptions) {
+		const storage = options.getStorage();
+		const sessionAtStart = session;
+		const { signal } = sessionAbort;
+		const versionAtSnapshot = contentVersion;
+		const document = {
+			...options.createDocument(),
+			revision: revision + 1
+		};
+		const expectedRevision = saveOptions.overwrite === true ? null : revision;
+		saving = true;
+		lastError = void 0;
+		publish();
+		options.onStart(document);
+		try {
+			const result = await sendWithRetries(storage, document, expectedRevision, signal);
+			if (sessionAtStart !== session) return document;
+			revision = result?.revision ?? document.revision;
+			document.revision = revision;
+			savedVersion = versionAtSnapshot;
+			lastSavedAt = (/* @__PURE__ */ new Date()).toISOString();
+			options.onSuccess(document);
+			return document;
+		} catch (error) {
+			const saveError = toSaveError(error, signal);
+			if (sessionAtStart === session) {
+				lastError = saveError;
+				options.onError(saveError);
+			}
+			throw saveError;
+		} finally {
+			if (sessionAtStart === session) {
+				saving = false;
+				publish();
+			}
+		}
+	}
+	function save(saveOptions = {}) {
+		if (inFlight === null) {
+			inFlight = runSave(saveOptions).finally(() => {
+				inFlight = null;
+			});
+			return inFlight;
+		}
+		if (queued === null) {
+			const sessionWhenQueued = session;
+			queued = inFlight.catch(() => void 0).then(() => {
+				queued = null;
+				if (sessionWhenQueued !== session) throw cancelledError();
+				return save(saveOptions);
+			});
+		}
+		return queued;
+	}
+	return {
+		save,
+		noteContentChange() {
+			contentVersion += 1;
+			autosave?.schedule();
+			publish();
+		},
+		startSession(newRevision) {
+			session += 1;
+			sessionAbort.abort();
+			sessionAbort = new AbortController();
+			autosave?.cancel();
+			saving = false;
+			savedVersion = contentVersion;
+			revision = newRevision;
+			lastSavedAt = void 0;
+			lastError = void 0;
+			publish();
+		},
+		state,
+		destroy() {
+			session += 1;
+			sessionAbort.abort();
+			autosave?.cancel();
+		}
+	};
+}
+//#endregion
+export { createSaveController };

package/dist/save/unsaved-changes-warning.cjs

@@ -0,0 +1,12 @@
+//#region src/save/unsaved-changes-warning.ts
+function bindUnsavedChangesWarning(engine, target = globalThis.window) {
+	const handleBeforeUnload = (event) => {
+		if (!engine.isDirty()) return;
+		event.preventDefault();
+		event.returnValue = "";
+	};
+	target.addEventListener("beforeunload", handleBeforeUnload);
+	return () => target.removeEventListener("beforeunload", handleBeforeUnload);
+}
+//#endregion
+exports.bindUnsavedChangesWarning = bindUnsavedChangesWarning;

package/dist/save/unsaved-changes-warning.d.cts

@@ -0,0 +1,6 @@
+//#region src/save/unsaved-changes-warning.d.ts
+export interface UnsavedChangesSource {
+  isDirty(): boolean;
+}
+export declare function bindUnsavedChangesWarning(engine: UnsavedChangesSource, target?: EventTarget): () => void;
+//#endregion

package/dist/save/unsaved-changes-warning.d.ts

@@ -0,0 +1,6 @@
+//#region src/save/unsaved-changes-warning.d.ts
+export interface UnsavedChangesSource {
+  isDirty(): boolean;
+}
+export declare function bindUnsavedChangesWarning(engine: UnsavedChangesSource, target?: EventTarget): () => void;
+//#endregion

package/dist/save/unsaved-changes-warning.js

@@ -0,0 +1,12 @@
+//#region src/save/unsaved-changes-warning.ts
+function bindUnsavedChangesWarning(engine, target = globalThis.window) {
+	const handleBeforeUnload = (event) => {
+		if (!engine.isDirty()) return;
+		event.preventDefault();
+		event.returnValue = "";
+	};
+	target.addEventListener("beforeunload", handleBeforeUnload);
+	return () => target.removeEventListener("beforeunload", handleBeforeUnload);
+}
+//#endregion
+export { bindUnsavedChangesWarning };

package/dist/storage/key-value-storage.cjs

@@ -0,0 +1,35 @@
+const require_errors = require("../engine/errors.cjs");
+//#region src/storage/key-value-storage.ts
+function readRevision(json) {
+	if (json === null) return 0;
+	const revision = JSON.parse(json).revision;
+	return typeof revision === "number" ? revision : 0;
+}
+function createKeyValueStorage(store, prefix) {
+	const keyFor = (id) => `${prefix}${id}`;
+	return {
+		async loadDocument(id) {
+			const json = store.read(keyFor(id));
+			if (json === null) throw new require_errors.DocumentEngineError("DOCUMENT_NOT_FOUND", `No document is stored with id "${id}"`);
+			return JSON.parse(json);
+		},
+		async saveDocument(document, { expectedRevision }) {
+			const storedRevision = readRevision(store.read(keyFor(document.id)));
+			if (expectedRevision !== null && storedRevision !== expectedRevision) throw require_errors.createConflictError(document.id, expectedRevision, storedRevision);
+			const revision = expectedRevision === null ? storedRevision + 1 : document.revision ?? storedRevision + 1;
+			store.write(keyFor(document.id), JSON.stringify({
+				...document,
+				revision
+			}));
+			return { revision };
+		},
+		async listDocuments() {
+			return store.keys().filter((key) => key.startsWith(prefix)).map((key) => key.slice(prefix.length));
+		},
+		async deleteDocument(id) {
+			store.remove(keyFor(id));
+		}
+	};
+}
+//#endregion
+exports.createKeyValueStorage = createKeyValueStorage;

package/dist/storage/key-value-storage.d.cts

@@ -0,0 +1,14 @@
+import { DocumentStorage } from "./storage-contract.cjs";
+//#region src/storage/key-value-storage.d.ts
+export interface KeyValueStore {
+  read(key: string): string | null;
+  write(key: string, value: string): void;
+  remove(key: string): void;
+  keys(): string[];
+}
+export interface ManagedDocumentStorage extends DocumentStorage {
+  listDocuments(): Promise<string[]>;
+  deleteDocument(id: string): Promise<void>;
+}
+export declare function createKeyValueStorage(store: KeyValueStore, prefix: string): ManagedDocumentStorage;
+//#endregion