fabricjs-document-engine 0.2.0 → 0.4.0

package/dist/engine/create-document-engine.cjs

@@ -1,3 +1,7 @@
+const require_asset_manifest = require("../assets/asset-manifest.cjs");
+const require_errors = require("./errors.cjs");
+const require_image_check = require("../assets/image-check.cjs");
+const require_asset_pipeline = require("../assets/asset-pipeline.cjs");
 require("../document/document-format.cjs");
 const require_ids = require("../document/ids.cjs");
 const require_create_document = require("../document/create-document.cjs");
@@ -5,12 +9,16 @@ const require_validate_document = require("../document/validate-document.cjs");
 const require_walk_objects = require("../fabric/walk-objects.cjs");
 const require_fabric_adapter = require("../fabric/fabric-adapter.cjs");
 const require_object_ids = require("../fabric/object-ids.cjs");
-const require_errors = require("./errors.cjs");
 const require_object_registry = require("../fabric/object-registry.cjs");
 const require_create_history = require("../history/create-history.cjs");
+const require_recovery_controller = require("../recovery/recovery-controller.cjs");
 const require_save_controller = require("../save/save-controller.cjs");
 const require_event_emitter = require("./event-emitter.cjs");
 //#region src/engine/create-document-engine.ts
+function isReplaceableImage(object) {
+	const candidate = object;
+	return typeof candidate.getSrc === "function" && typeof candidate.setSrc === "function";
+}
 function describeDocumentId(value) {
 	const id = value?.id;
 	return typeof id === "string" ? id : void 0;
@@ -21,6 +29,8 @@ function createDocumentEngine(options) {
 	const registry = require_object_registry.createObjectRegistry(options.customObjects);
 	const events = require_event_emitter.createEventEmitter();
 	const objectsById = /* @__PURE__ */ new Map();
+	const assetOptions = options.assets ?? {};
+	const uploadedUrls = /* @__PURE__ */ new Map();
 	let documentInfo = require_create_document.createDocumentInfo(options.document);
 	let activeLoad = null;
 	let destroyed = false;
@@ -61,19 +71,43 @@ function createDocumentEngine(options) {
 			return require_fabric_adapter.serializeCanvas(canvas, registry.propertiesToInclude()).objects;
 		},
 		onChange: (state) => events.emit("history:change", state),
-		onContentChange: () => saving.noteContentChange()
+		onContentChange: () => noteContentChange()
 	});
 	const saving = require_save_controller.createSaveController({
 		getStorage: () => requireStorage(),
-		createDocument: () => toDocument(),
+		createDocument: async () => {
+			const prepared = await require_asset_pipeline.prepareAssetsForSave(toDocument(), assetOptions, uploadedUrls);
+			if (prepared.warnings.length > 0) events.emit("assets:warning", { warnings: prepared.warnings });
+			return prepared.document;
+		},
 		retry: options.saveRetry,
 		autosave: options.autosave === true ? {} : options.autosave ?? false,
 		onStateChange: (state) => events.emit("save:status", state),
 		onStart: (document) => events.emit("save:start", { document }),
-		onSuccess: (document) => events.emit("save:success", { document }),
+		onSuccess: (document) => {
+			if (recovery && !saving.state().isDirty) recovery.remove(document.id);
+			events.emit("save:success", { document });
+		},
 		onError: (error) => events.emit("save:error", { error }),
 		onRetry: (event) => events.emit("save:retry", event)
 	});
+	const recovery = options.recovery ? require_recovery_controller.createRecoveryController({
+		...options.recovery,
+		createDocument: () => toDocument(),
+		shouldWrite: () => !destroyed && saving.state().isDirty,
+		onCheckpoint: (record) => events.emit("recovery:checkpoint", {
+			documentId: record.documentId,
+			savedAt: record.savedAt
+		}),
+		onError: (error) => {
+			const reason = error instanceof Error ? error.message : String(error);
+			events.emit("recovery:error", { error: new require_errors.DocumentEngineError("RECOVERY_FAILED", `Could not write the recovery copy: ${reason}`, { cause: error }) });
+		}
+	}) : void 0;
+	function noteContentChange() {
+		saving.noteContentChange();
+		recovery?.schedule();
+	}
 	function toDocument() {
 		ensureUsable();
 		rebuildIndex();
@@ -93,6 +127,7 @@ function createDocumentEngine(options) {
 				height: canvas.getHeight()
 			},
 			objects: serialized.objects,
+			assets: require_asset_manifest.buildAssetManifest(serialized.objects),
 			metadata: { ...documentInfo.metadata }
 		};
 		if (serialized.version !== void 0) document.fabricVersion = serialized.version;
@@ -100,8 +135,8 @@ function createDocumentEngine(options) {
 		return document;
 	}
 	function toLoadError(error, signal) {
-		if (require_errors.isDocumentEngineError(error)) return error;
 		if (signal.aborted) return new require_errors.DocumentEngineError("LOAD_ABORTED", "Loading stopped because a newer load started", { cause: error });
+		if (require_errors.isDocumentEngineError(error)) return error;
 		const reason = error instanceof Error ? error.message : String(error);
 		return new require_errors.DocumentEngineError("LOAD_FAILED", `Fabric could not load the document: ${reason}`, { cause: error });
 	}
@@ -121,9 +156,14 @@ function createDocumentEngine(options) {
 		activeLoad?.abort();
 		const controller = new AbortController();
 		activeLoad = controller;
-		events.emit("load:start", { documentId: describeDocumentId(input) });
+		const documentId = describeDocumentId(input);
+		events.emit("load:start", { documentId });
 		try {
-			const document = checkDocument(input);
+			await recovery?.markLoadStarted(documentId);
+			if (controller.signal.aborted) throw new Error("aborted");
+			const checked = checkDocument(input);
+			const { document, warnings } = await require_asset_pipeline.prepareAssetsForLoad(checked, assetOptions, controller.signal);
+			if (controller.signal.aborted) throw new Error("aborted");
 			await history.withoutRecording(() => require_fabric_adapter.loadIntoCanvas(canvas, {
 				version: document.fabricVersion,
 				background: document.canvas.background,
@@ -142,16 +182,24 @@ function createDocumentEngine(options) {
 			};
 			rebuildIndex();
 			history.reset();
+			recovery?.cancel();
 			saving.startSession(document.revision ?? 0);
 			canvas.requestRenderAll();
-			events.emit("load:success", { document });
+			if (warnings.length > 0) events.emit("assets:warning", { warnings });
+			events.emit("load:success", {
+				document,
+				warnings
+			});
 			return document;
 		} catch (error) {
 			const engineError = toLoadError(error, controller.signal);
 			events.emit("load:error", { error: engineError });
 			throw engineError;
 		} finally {
-			if (activeLoad === controller) activeLoad = null;
+			if (activeLoad === controller) {
+				activeLoad = null;
+				await recovery?.markLoadFinished();
+			}
 		}
 	}
 	function requireStorage() {
@@ -186,7 +234,9 @@ function createDocumentEngine(options) {
 		history.withoutRecording(() => canvas.clear());
 		objectsById.clear();
 		documentInfo = require_create_document.createDocumentInfo(newOptions);
+		uploadedUrls.clear();
 		history.reset();
+		recovery?.cancel();
 		saving.startSession(0);
 	}
 	function getObjectById(id) {
@@ -196,6 +246,45 @@ function createDocumentEngine(options) {
 		rebuildIndex();
 		return objectsById.get(id);
 	}
+	function checkAssets() {
+		ensureUsable();
+		return require_asset_pipeline.inspectAssets(toDocument(), assetOptions, new AbortController().signal);
+	}
+	async function replaceImage(oldUrl, newUrl) {
+		ensureUsable();
+		const images = [];
+		require_walk_objects.walkObjects(canvas.getObjects(), (object) => {
+			if (isReplaceableImage(object) && require_image_check.isSameUrl(object.getSrc(), oldUrl)) images.push(object);
+		});
+		if (images.length === 0) return 0;
+		await history.transaction("Replace image", () => Promise.all(images.map(async (image) => {
+			const displayedWidth = image.width * image.scaleX;
+			const displayedHeight = image.height * image.scaleY;
+			await image.setSrc(newUrl, { crossOrigin: image.crossOrigin ?? null });
+			image.set({
+				scaleX: displayedWidth / image.width,
+				scaleY: displayedHeight / image.height
+			});
+			image.setCoords();
+		})));
+		canvas.requestRenderAll();
+		return images.length;
+	}
+	function requireRecovery() {
+		ensureUsable();
+		if (!recovery) throw new require_errors.DocumentEngineError("RECOVERY_MISSING", "Pass recovery: { store } to createDocumentEngine to use recovery");
+		return recovery;
+	}
+	async function restoreRecovery(documentId, loadOptions) {
+		const source = requireRecovery();
+		const id = documentId ?? documentInfo.id;
+		const record = await source.read(id);
+		if (!record) throw new require_errors.DocumentEngineError("RECOVERY_NOT_FOUND", `There is no recovery copy for document "${id}"`);
+		const loaded = await loadDocument(await require_recovery_controller.restoreRecordedFiles(record), loadOptions);
+		noteContentChange();
+		events.emit("recovery:restored", { document: loaded });
+		return loaded;
+	}
 	async function travelThroughHistory(direction) {
 		ensureUsable();
 		try {
@@ -213,6 +302,7 @@ function createDocumentEngine(options) {
 		activeLoad?.abort();
 		history.destroy();
 		saving.destroy();
+		recovery?.destroy();
 		canvas.off("object:added", handleObjectAdded);
 		canvas.off("object:removed", handleObjectRemoved);
 		objectsById.clear();
@@ -233,7 +323,7 @@ function createDocumentEngine(options) {
 					...changes
 				}
 			};
-			saving.noteContentChange();
+			noteContentChange();
 		},
 		newDocument,
 		toDocument,
@@ -247,6 +337,18 @@ function createDocumentEngine(options) {
 			registry.register(definition);
 		},
 		getObjectById,
+		getAssetManifest: () => toDocument().assets ?? {
+			images: [],
+			fonts: []
+		},
+		checkAssets,
+		replaceImage,
+		flushRecovery: async () => requireRecovery().flush(),
+		getRecoverableDocuments: async () => requireRecovery().list(),
+		getRecovery: async (documentId) => requireRecovery().read(documentId ?? documentInfo.id),
+		restoreRecovery,
+		discardRecovery: async (documentId) => requireRecovery().remove(documentId ?? documentInfo.id),
+		getInterruptedLoad: async () => requireRecovery().interruptedLoad(),
 		transaction(label, work) {
 			ensureUsable();
 			return history.transaction(label, work);

package/dist/engine/create-document-engine.d.cts

@@ -1,7 +1,10 @@
 import { DocumentInfo, FabricDocument } from "../document/document-format.cjs";
+import { AssetManifest } from "../assets/asset-manifest.cjs";
+import { AssetOptions, AssetReport, AssetWarning } from "../assets/asset-pipeline.cjs";
 import { NewDocumentOptions } from "../document/create-document.cjs";
 import { CustomObjectDefinition } from "../fabric/object-registry.cjs";
 import { HistoryOptions, HistoryState } from "../history/create-history.cjs";
+import { InterruptedLoad, RecoveryOptions, RecoveryRecord } from "../recovery/recovery-controller.cjs";
 import { AutosaveOptions } from "../save/autosave-scheduler.cjs";
 import { RetryOptions } from "../save/retry.cjs";
 import { DocumentEngineError } from "./errors.cjs";
@@ -18,6 +21,8 @@ export interface DocumentEngineOptions {
   history?: HistoryOptions;
   autosave?: boolean | AutosaveOptions;
   saveRetry?: RetryOptions;
+  assets?: AssetOptions;
+  recovery?: RecoveryOptions;
 }
 export interface LoadOptions {
   restoreCanvasSize?: boolean;
@@ -28,6 +33,10 @@ export interface DocumentEngineEvents {
   };
   "load:success": {
     document: FabricDocument;
+    warnings: AssetWarning[];
+  };
+  "assets:warning": {
+    warnings: AssetWarning[];
   };
   "load:error": {
     error: DocumentEngineError;
@@ -47,6 +56,16 @@ export interface DocumentEngineEvents {
   "history:error": {
     error: DocumentEngineError;
   };
+  "recovery:checkpoint": {
+    documentId: string;
+    savedAt: string;
+  };
+  "recovery:restored": {
+    document: FabricDocument;
+  };
+  "recovery:error": {
+    error: DocumentEngineError;
+  };
 }
 export interface DocumentEngine {
   readonly canvas: StaticCanvas;
@@ -72,6 +91,15 @@ export interface DocumentEngine {
   };
   clearHistory(): void;
   getObjectById(id: string): FabricObject | undefined;
+  getAssetManifest(): AssetManifest;
+  checkAssets(): Promise<AssetReport>;
+  replaceImage(oldUrl: string, newUrl: string): Promise<number>;
+  flushRecovery(): Promise<void>;
+  getRecoverableDocuments(): Promise<RecoveryRecord[]>;
+  getRecovery(documentId?: string): Promise<RecoveryRecord | undefined>;
+  restoreRecovery(documentId?: string, options?: LoadOptions): Promise<FabricDocument>;
+  discardRecovery(documentId?: string): Promise<void>;
+  getInterruptedLoad(): Promise<InterruptedLoad | undefined>;
   on<Name extends keyof DocumentEngineEvents>(name: Name, handler: (payload: DocumentEngineEvents[Name]) => void): Unsubscribe;
   destroy(): void;
 }

package/dist/engine/create-document-engine.d.ts

@@ -1,7 +1,10 @@
 import { DocumentInfo, FabricDocument } from "../document/document-format.js";
+import { AssetManifest } from "../assets/asset-manifest.js";
+import { AssetOptions, AssetReport, AssetWarning } from "../assets/asset-pipeline.js";
 import { NewDocumentOptions } from "../document/create-document.js";
 import { CustomObjectDefinition } from "../fabric/object-registry.js";
 import { HistoryOptions, HistoryState } from "../history/create-history.js";
+import { InterruptedLoad, RecoveryOptions, RecoveryRecord } from "../recovery/recovery-controller.js";
 import { AutosaveOptions } from "../save/autosave-scheduler.js";
 import { RetryOptions } from "../save/retry.js";
 import { DocumentEngineError } from "./errors.js";
@@ -18,6 +21,8 @@ export interface DocumentEngineOptions {
   history?: HistoryOptions;
   autosave?: boolean | AutosaveOptions;
   saveRetry?: RetryOptions;
+  assets?: AssetOptions;
+  recovery?: RecoveryOptions;
 }
 export interface LoadOptions {
   restoreCanvasSize?: boolean;
@@ -28,6 +33,10 @@ export interface DocumentEngineEvents {
   };
   "load:success": {
     document: FabricDocument;
+    warnings: AssetWarning[];
+  };
+  "assets:warning": {
+    warnings: AssetWarning[];
   };
   "load:error": {
     error: DocumentEngineError;
@@ -47,6 +56,16 @@ export interface DocumentEngineEvents {
   "history:error": {
     error: DocumentEngineError;
   };
+  "recovery:checkpoint": {
+    documentId: string;
+    savedAt: string;
+  };
+  "recovery:restored": {
+    document: FabricDocument;
+  };
+  "recovery:error": {
+    error: DocumentEngineError;
+  };
 }
 export interface DocumentEngine {
   readonly canvas: StaticCanvas;
@@ -72,6 +91,15 @@ export interface DocumentEngine {
   };
   clearHistory(): void;
   getObjectById(id: string): FabricObject | undefined;
+  getAssetManifest(): AssetManifest;
+  checkAssets(): Promise<AssetReport>;
+  replaceImage(oldUrl: string, newUrl: string): Promise<number>;
+  flushRecovery(): Promise<void>;
+  getRecoverableDocuments(): Promise<RecoveryRecord[]>;
+  getRecovery(documentId?: string): Promise<RecoveryRecord | undefined>;
+  restoreRecovery(documentId?: string, options?: LoadOptions): Promise<FabricDocument>;
+  discardRecovery(documentId?: string): Promise<void>;
+  getInterruptedLoad(): Promise<InterruptedLoad | undefined>;
   on<Name extends keyof DocumentEngineEvents>(name: Name, handler: (payload: DocumentEngineEvents[Name]) => void): Unsubscribe;
   destroy(): void;
 }

package/dist/engine/create-document-engine.js

@@ -1,3 +1,7 @@
+import { buildAssetManifest } from "../assets/asset-manifest.js";
+import { DocumentEngineError, isDocumentEngineError } from "./errors.js";
+import { isSameUrl } from "../assets/image-check.js";
+import { inspectAssets, prepareAssetsForLoad, prepareAssetsForSave } from "../assets/asset-pipeline.js";
 import "../document/document-format.js";
 import { createId } from "../document/ids.js";
 import { createDocumentInfo } from "../document/create-document.js";
@@ -5,12 +9,16 @@ import { validateDocument } from "../document/validate-document.js";
 import { collectSerializedTypes, walkObjects } from "../fabric/walk-objects.js";
 import { loadIntoCanvas, serializeCanvas } from "../fabric/fabric-adapter.js";
 import { readObjectId, writeObjectId } from "../fabric/object-ids.js";
-import { DocumentEngineError, isDocumentEngineError } from "./errors.js";
 import { createObjectRegistry } from "../fabric/object-registry.js";
 import { createHistory } from "../history/create-history.js";
+import { createRecoveryController, restoreRecordedFiles } from "../recovery/recovery-controller.js";
 import { createSaveController } from "../save/save-controller.js";
 import { createEventEmitter } from "./event-emitter.js";
 //#region src/engine/create-document-engine.ts
+function isReplaceableImage(object) {
+	const candidate = object;
+	return typeof candidate.getSrc === "function" && typeof candidate.setSrc === "function";
+}
 function describeDocumentId(value) {
 	const id = value?.id;
 	return typeof id === "string" ? id : void 0;
@@ -21,6 +29,8 @@ function createDocumentEngine(options) {
 	const registry = createObjectRegistry(options.customObjects);
 	const events = createEventEmitter();
 	const objectsById = /* @__PURE__ */ new Map();
+	const assetOptions = options.assets ?? {};
+	const uploadedUrls = /* @__PURE__ */ new Map();
 	let documentInfo = createDocumentInfo(options.document);
 	let activeLoad = null;
 	let destroyed = false;
@@ -61,19 +71,43 @@ function createDocumentEngine(options) {
 			return serializeCanvas(canvas, registry.propertiesToInclude()).objects;
 		},
 		onChange: (state) => events.emit("history:change", state),
-		onContentChange: () => saving.noteContentChange()
+		onContentChange: () => noteContentChange()
 	});
 	const saving = createSaveController({
 		getStorage: () => requireStorage(),
-		createDocument: () => toDocument(),
+		createDocument: async () => {
+			const prepared = await prepareAssetsForSave(toDocument(), assetOptions, uploadedUrls);
+			if (prepared.warnings.length > 0) events.emit("assets:warning", { warnings: prepared.warnings });
+			return prepared.document;
+		},
 		retry: options.saveRetry,
 		autosave: options.autosave === true ? {} : options.autosave ?? false,
 		onStateChange: (state) => events.emit("save:status", state),
 		onStart: (document) => events.emit("save:start", { document }),
-		onSuccess: (document) => events.emit("save:success", { document }),
+		onSuccess: (document) => {
+			if (recovery && !saving.state().isDirty) recovery.remove(document.id);
+			events.emit("save:success", { document });
+		},
 		onError: (error) => events.emit("save:error", { error }),
 		onRetry: (event) => events.emit("save:retry", event)
 	});
+	const recovery = options.recovery ? createRecoveryController({
+		...options.recovery,
+		createDocument: () => toDocument(),
+		shouldWrite: () => !destroyed && saving.state().isDirty,
+		onCheckpoint: (record) => events.emit("recovery:checkpoint", {
+			documentId: record.documentId,
+			savedAt: record.savedAt
+		}),
+		onError: (error) => {
+			const reason = error instanceof Error ? error.message : String(error);
+			events.emit("recovery:error", { error: new DocumentEngineError("RECOVERY_FAILED", `Could not write the recovery copy: ${reason}`, { cause: error }) });
+		}
+	}) : void 0;
+	function noteContentChange() {
+		saving.noteContentChange();
+		recovery?.schedule();
+	}
 	function toDocument() {
 		ensureUsable();
 		rebuildIndex();
@@ -93,6 +127,7 @@ function createDocumentEngine(options) {
 				height: canvas.getHeight()
 			},
 			objects: serialized.objects,
+			assets: buildAssetManifest(serialized.objects),
 			metadata: { ...documentInfo.metadata }
 		};
 		if (serialized.version !== void 0) document.fabricVersion = serialized.version;
@@ -100,8 +135,8 @@ function createDocumentEngine(options) {
 		return document;
 	}
 	function toLoadError(error, signal) {
-		if (isDocumentEngineError(error)) return error;
 		if (signal.aborted) return new DocumentEngineError("LOAD_ABORTED", "Loading stopped because a newer load started", { cause: error });
+		if (isDocumentEngineError(error)) return error;
 		const reason = error instanceof Error ? error.message : String(error);
 		return new DocumentEngineError("LOAD_FAILED", `Fabric could not load the document: ${reason}`, { cause: error });
 	}
@@ -121,9 +156,14 @@ function createDocumentEngine(options) {
 		activeLoad?.abort();
 		const controller = new AbortController();
 		activeLoad = controller;
-		events.emit("load:start", { documentId: describeDocumentId(input) });
+		const documentId = describeDocumentId(input);
+		events.emit("load:start", { documentId });
 		try {
-			const document = checkDocument(input);
+			await recovery?.markLoadStarted(documentId);
+			if (controller.signal.aborted) throw new Error("aborted");
+			const checked = checkDocument(input);
+			const { document, warnings } = await prepareAssetsForLoad(checked, assetOptions, controller.signal);
+			if (controller.signal.aborted) throw new Error("aborted");
 			await history.withoutRecording(() => loadIntoCanvas(canvas, {
 				version: document.fabricVersion,
 				background: document.canvas.background,
@@ -142,16 +182,24 @@ function createDocumentEngine(options) {
 			};
 			rebuildIndex();
 			history.reset();
+			recovery?.cancel();
 			saving.startSession(document.revision ?? 0);
 			canvas.requestRenderAll();
-			events.emit("load:success", { document });
+			if (warnings.length > 0) events.emit("assets:warning", { warnings });
+			events.emit("load:success", {
+				document,
+				warnings
+			});
 			return document;
 		} catch (error) {
 			const engineError = toLoadError(error, controller.signal);
 			events.emit("load:error", { error: engineError });
 			throw engineError;
 		} finally {
-			if (activeLoad === controller) activeLoad = null;
+			if (activeLoad === controller) {
+				activeLoad = null;
+				await recovery?.markLoadFinished();
+			}
 		}
 	}
 	function requireStorage() {
@@ -186,7 +234,9 @@ function createDocumentEngine(options) {
 		history.withoutRecording(() => canvas.clear());
 		objectsById.clear();
 		documentInfo = createDocumentInfo(newOptions);
+		uploadedUrls.clear();
 		history.reset();
+		recovery?.cancel();
 		saving.startSession(0);
 	}
 	function getObjectById(id) {
@@ -196,6 +246,45 @@ function createDocumentEngine(options) {
 		rebuildIndex();
 		return objectsById.get(id);
 	}
+	function checkAssets() {
+		ensureUsable();
+		return inspectAssets(toDocument(), assetOptions, new AbortController().signal);
+	}
+	async function replaceImage(oldUrl, newUrl) {
+		ensureUsable();
+		const images = [];
+		walkObjects(canvas.getObjects(), (object) => {
+			if (isReplaceableImage(object) && isSameUrl(object.getSrc(), oldUrl)) images.push(object);
+		});
+		if (images.length === 0) return 0;
+		await history.transaction("Replace image", () => Promise.all(images.map(async (image) => {
+			const displayedWidth = image.width * image.scaleX;
+			const displayedHeight = image.height * image.scaleY;
+			await image.setSrc(newUrl, { crossOrigin: image.crossOrigin ?? null });
+			image.set({
+				scaleX: displayedWidth / image.width,
+				scaleY: displayedHeight / image.height
+			});
+			image.setCoords();
+		})));
+		canvas.requestRenderAll();
+		return images.length;
+	}
+	function requireRecovery() {
+		ensureUsable();
+		if (!recovery) throw new DocumentEngineError("RECOVERY_MISSING", "Pass recovery: { store } to createDocumentEngine to use recovery");
+		return recovery;
+	}
+	async function restoreRecovery(documentId, loadOptions) {
+		const source = requireRecovery();
+		const id = documentId ?? documentInfo.id;
+		const record = await source.read(id);
+		if (!record) throw new DocumentEngineError("RECOVERY_NOT_FOUND", `There is no recovery copy for document "${id}"`);
+		const loaded = await loadDocument(await restoreRecordedFiles(record), loadOptions);
+		noteContentChange();
+		events.emit("recovery:restored", { document: loaded });
+		return loaded;
+	}
 	async function travelThroughHistory(direction) {
 		ensureUsable();
 		try {
@@ -213,6 +302,7 @@ function createDocumentEngine(options) {
 		activeLoad?.abort();
 		history.destroy();
 		saving.destroy();
+		recovery?.destroy();
 		canvas.off("object:added", handleObjectAdded);
 		canvas.off("object:removed", handleObjectRemoved);
 		objectsById.clear();
@@ -233,7 +323,7 @@ function createDocumentEngine(options) {
 					...changes
 				}
 			};
-			saving.noteContentChange();
+			noteContentChange();
 		},
 		newDocument,
 		toDocument,
@@ -247,6 +337,18 @@ function createDocumentEngine(options) {
 			registry.register(definition);
 		},
 		getObjectById,
+		getAssetManifest: () => toDocument().assets ?? {
+			images: [],
+			fonts: []
+		},
+		checkAssets,
+		replaceImage,
+		flushRecovery: async () => requireRecovery().flush(),
+		getRecoverableDocuments: async () => requireRecovery().list(),
+		getRecovery: async (documentId) => requireRecovery().read(documentId ?? documentInfo.id),
+		restoreRecovery,
+		discardRecovery: async (documentId) => requireRecovery().remove(documentId ?? documentInfo.id),
+		getInterruptedLoad: async () => requireRecovery().interruptedLoad(),
 		transaction(label, work) {
 			ensureUsable();
 			return history.transaction(label, work);

package/dist/engine/errors.cjs

@@ -6,6 +6,8 @@ var DocumentEngineError = class extends Error {
 		this.code = code;
 		this.issues = details.issues ?? [];
 		this.unknownTypes = details.unknownTypes ?? [];
+		this.missingAssets = details.missingAssets ?? [];
+		this.missingFonts = details.missingFonts ?? [];
 		this.cause = details.cause;
 		this.retryable = details.retryable ?? false;
 	}

package/dist/engine/errors.d.cts

@@ -1,5 +1,6 @@
+import { FontAsset, ImageAsset } from "../assets/asset-manifest.cjs";
 //#region src/engine/errors.d.ts
-export type DocumentErrorCode = "INVALID_DOCUMENT" | "UNSUPPORTED_SCHEMA" | "UNKNOWN_OBJECT_TYPE" | "INVALID_CUSTOM_OBJECT" | "LOAD_ABORTED" | "LOAD_FAILED" | "STORAGE_MISSING" | "SAVE_FAILED" | "SAVE_CONFLICT" | "SAVE_CANCELLED" | "DOCUMENT_NOT_FOUND" | "HISTORY_FAILED" | "ENGINE_DESTROYED";
+export type DocumentErrorCode = "INVALID_DOCUMENT" | "UNSUPPORTED_SCHEMA" | "UNKNOWN_OBJECT_TYPE" | "INVALID_CUSTOM_OBJECT" | "LOAD_ABORTED" | "LOAD_FAILED" | "MISSING_ASSETS" | "MISSING_FONTS" | "ASSET_UPLOAD_FAILED" | "STORAGE_MISSING" | "SAVE_FAILED" | "SAVE_CONFLICT" | "SAVE_CANCELLED" | "DOCUMENT_NOT_FOUND" | "HISTORY_FAILED" | "RECOVERY_MISSING" | "RECOVERY_NOT_FOUND" | "RECOVERY_FAILED" | "ENGINE_DESTROYED";
 export interface DocumentIssue {
   code: DocumentErrorCode;
   path: string;
@@ -8,6 +9,8 @@ export interface DocumentIssue {
 export interface DocumentEngineErrorDetails {
   issues?: DocumentIssue[];
   unknownTypes?: string[];
+  missingAssets?: ImageAsset[];
+  missingFonts?: FontAsset[];
   cause?: unknown;
   retryable?: boolean;
 }
@@ -15,6 +18,8 @@ export declare class DocumentEngineError extends Error {
   readonly code: DocumentErrorCode;
   readonly issues: DocumentIssue[];
   readonly unknownTypes: string[];
+  readonly missingAssets: ImageAsset[];
+  readonly missingFonts: FontAsset[];
   readonly cause: unknown;
   readonly retryable: boolean;
   constructor(code: DocumentErrorCode, message: string, details?: DocumentEngineErrorDetails);

package/dist/engine/errors.d.ts

@@ -1,5 +1,6 @@
+import { FontAsset, ImageAsset } from "../assets/asset-manifest.js";
 //#region src/engine/errors.d.ts
-export type DocumentErrorCode = "INVALID_DOCUMENT" | "UNSUPPORTED_SCHEMA" | "UNKNOWN_OBJECT_TYPE" | "INVALID_CUSTOM_OBJECT" | "LOAD_ABORTED" | "LOAD_FAILED" | "STORAGE_MISSING" | "SAVE_FAILED" | "SAVE_CONFLICT" | "SAVE_CANCELLED" | "DOCUMENT_NOT_FOUND" | "HISTORY_FAILED" | "ENGINE_DESTROYED";
+export type DocumentErrorCode = "INVALID_DOCUMENT" | "UNSUPPORTED_SCHEMA" | "UNKNOWN_OBJECT_TYPE" | "INVALID_CUSTOM_OBJECT" | "LOAD_ABORTED" | "LOAD_FAILED" | "MISSING_ASSETS" | "MISSING_FONTS" | "ASSET_UPLOAD_FAILED" | "STORAGE_MISSING" | "SAVE_FAILED" | "SAVE_CONFLICT" | "SAVE_CANCELLED" | "DOCUMENT_NOT_FOUND" | "HISTORY_FAILED" | "RECOVERY_MISSING" | "RECOVERY_NOT_FOUND" | "RECOVERY_FAILED" | "ENGINE_DESTROYED";
 export interface DocumentIssue {
   code: DocumentErrorCode;
   path: string;
@@ -8,6 +9,8 @@ export interface DocumentIssue {
 export interface DocumentEngineErrorDetails {
   issues?: DocumentIssue[];
   unknownTypes?: string[];
+  missingAssets?: ImageAsset[];
+  missingFonts?: FontAsset[];
   cause?: unknown;
   retryable?: boolean;
 }
@@ -15,6 +18,8 @@ export declare class DocumentEngineError extends Error {
   readonly code: DocumentErrorCode;
   readonly issues: DocumentIssue[];
   readonly unknownTypes: string[];
+  readonly missingAssets: ImageAsset[];
+  readonly missingFonts: FontAsset[];
   readonly cause: unknown;
   readonly retryable: boolean;
   constructor(code: DocumentErrorCode, message: string, details?: DocumentEngineErrorDetails);

package/dist/engine/errors.js

@@ -6,6 +6,8 @@ var DocumentEngineError = class extends Error {
 		this.code = code;
 		this.issues = details.issues ?? [];
 		this.unknownTypes = details.unknownTypes ?? [];
+		this.missingAssets = details.missingAssets ?? [];
+		this.missingFonts = details.missingFonts ?? [];
 		this.cause = details.cause;
 		this.retryable = details.retryable ?? false;
 	}

package/dist/index.cjs

@@ -1,7 +1,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_errors = require("./engine/errors.cjs");
 const require_document_format = require("./document/document-format.cjs");
 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");