fabricjs-document-engine 0.4.0 → 0.6.0

package/dist/export/preflight-export.cjs

@@ -0,0 +1,105 @@
+const require_font_check = require("../assets/font-check.cjs");
+const require_image_check = require("../assets/image-check.cjs");
+const require_export_options = require("./export-options.cjs");
+const require_object_ids = require("../fabric/object-ids.cjs");
+const require_walk_objects = require("../fabric/walk-objects.cjs");
+//#region src/export/preflight-export.ts
+function imageElementsOf(object) {
+	const elements = [];
+	const withElement = object;
+	if (typeof withElement.getElement === "function") elements.push(withElement.getElement());
+	for (const paint of [object.fill, object.stroke]) {
+		const source = paint?.source;
+		if (source !== void 0) elements.push(source);
+	}
+	return elements.filter((element) => typeof HTMLImageElement !== "undefined" && element instanceof HTMLImageElement);
+}
+function collectImageUses(objects) {
+	const uses = /* @__PURE__ */ new Map();
+	const pending = objects.map((object) => ({
+		object,
+		ownerId: require_object_ids.readObjectId(object)
+	}));
+	while (pending.length > 0) {
+		const { object, ownerId } = pending.pop();
+		const id = require_object_ids.readObjectId(object) ?? ownerId;
+		for (const element of imageElementsOf(object)) {
+			const url = element.currentSrc || element.src;
+			const use = uses.get(url) ?? {
+				element,
+				objectIds: /* @__PURE__ */ new Set()
+			};
+			if (id !== void 0) use.objectIds.add(id);
+			uses.set(url, use);
+		}
+		require_walk_objects.childrenOf(object).forEach((child) => pending.push({
+			object: child,
+			ownerId: id
+		}));
+		if (object.clipPath) pending.push({
+			object: object.clipPath,
+			ownerId: id
+		});
+	}
+	return uses;
+}
+function isBroken(element) {
+	return element.complete && element.naturalWidth === 0;
+}
+function shortUrl(url) {
+	return url.length > 80 ? `${url.slice(0, 77)}...` : url;
+}
+async function preflightExport(canvas, format, fonts, assetOptions) {
+	const problems = [];
+	const warnings = [];
+	if (format === "json") return {
+		ok: true,
+		problems,
+		warnings
+	};
+	for (const [url, use] of collectImageUses(canvas.getObjects())) {
+		const objectIds = [...use.objectIds];
+		if (isBroken(use.element)) problems.push({
+			code: "MISSING_IMAGE",
+			message: `The image ${shortUrl(url)} did not load`,
+			url,
+			objectIds
+		});
+		else if (require_export_options.isRasterFormat(format) && require_image_check.isCrossOriginUrl(url) && !use.element.crossOrigin) problems.push({
+			code: "CROSS_ORIGIN_IMAGE",
+			message: `The image ${shortUrl(url)} comes from another site without crossOrigin, so the browser blocks exporting it. Load it with crossOrigin: 'anonymous' from a server that allows CORS.`,
+			url,
+			objectIds
+		});
+		else if (format === "svg" && !require_image_check.isPortableUrl(url)) warnings.push({
+			code: "ASSET_NOT_PORTABLE",
+			message: `The SVG links to ${shortUrl(url)}, which only exists in this tab`,
+			url,
+			objectIds
+		});
+	}
+	const fontSet = typeof document === "undefined" ? void 0 : document.fonts;
+	if (fontSet) await fontSet.ready;
+	for (const font of await require_font_check.findUnavailableFonts(fonts, assetOptions.loadFont)) {
+		const message = `The font "${font.family}" (${font.weight}, ${font.style}) is not available`;
+		if (assetOptions.requireFonts) problems.push({
+			code: "MISSING_FONT",
+			message,
+			family: font.family,
+			objectIds: font.objectIds
+		});
+		else warnings.push({
+			code: "FONT_UNAVAILABLE",
+			message: `${message}, text will use a fallback font`,
+			family: font.family,
+			objectIds: font.objectIds
+		});
+	}
+	return {
+		ok: problems.length === 0,
+		problems,
+		warnings
+	};
+}
+//#endregion
+exports.preflightExport = preflightExport;

package/dist/export/preflight-export.d.cts

@@ -0,0 +1,17 @@
+import { AssetWarning } from "../assets/asset-pipeline.cjs";
+import { StaticCanvas } from "fabric";
+//#region src/export/preflight-export.d.ts
+export type ExportProblemCode = "MISSING_IMAGE" | "CROSS_ORIGIN_IMAGE" | "MISSING_FONT";
+export interface ExportProblem {
+  code: ExportProblemCode;
+  message: string;
+  url?: string;
+  family?: string;
+  objectIds: string[];
+}
+export interface ExportPreflight {
+  ok: boolean;
+  problems: ExportProblem[];
+  warnings: AssetWarning[];
+}
+//#endregion

package/dist/export/preflight-export.d.ts

@@ -0,0 +1,17 @@
+import { AssetWarning } from "../assets/asset-pipeline.js";
+import { StaticCanvas } from "fabric";
+//#region src/export/preflight-export.d.ts
+export type ExportProblemCode = "MISSING_IMAGE" | "CROSS_ORIGIN_IMAGE" | "MISSING_FONT";
+export interface ExportProblem {
+  code: ExportProblemCode;
+  message: string;
+  url?: string;
+  family?: string;
+  objectIds: string[];
+}
+export interface ExportPreflight {
+  ok: boolean;
+  problems: ExportProblem[];
+  warnings: AssetWarning[];
+}
+//#endregion

package/dist/export/preflight-export.js

@@ -0,0 +1,105 @@
+import { findUnavailableFonts } from "../assets/font-check.js";
+import { isCrossOriginUrl, isPortableUrl } from "../assets/image-check.js";
+import { isRasterFormat } from "./export-options.js";
+import { readObjectId } from "../fabric/object-ids.js";
+import { childrenOf } from "../fabric/walk-objects.js";
+//#region src/export/preflight-export.ts
+function imageElementsOf(object) {
+	const elements = [];
+	const withElement = object;
+	if (typeof withElement.getElement === "function") elements.push(withElement.getElement());
+	for (const paint of [object.fill, object.stroke]) {
+		const source = paint?.source;
+		if (source !== void 0) elements.push(source);
+	}
+	return elements.filter((element) => typeof HTMLImageElement !== "undefined" && element instanceof HTMLImageElement);
+}
+function collectImageUses(objects) {
+	const uses = /* @__PURE__ */ new Map();
+	const pending = objects.map((object) => ({
+		object,
+		ownerId: readObjectId(object)
+	}));
+	while (pending.length > 0) {
+		const { object, ownerId } = pending.pop();
+		const id = readObjectId(object) ?? ownerId;
+		for (const element of imageElementsOf(object)) {
+			const url = element.currentSrc || element.src;
+			const use = uses.get(url) ?? {
+				element,
+				objectIds: /* @__PURE__ */ new Set()
+			};
+			if (id !== void 0) use.objectIds.add(id);
+			uses.set(url, use);
+		}
+		childrenOf(object).forEach((child) => pending.push({
+			object: child,
+			ownerId: id
+		}));
+		if (object.clipPath) pending.push({
+			object: object.clipPath,
+			ownerId: id
+		});
+	}
+	return uses;
+}
+function isBroken(element) {
+	return element.complete && element.naturalWidth === 0;
+}
+function shortUrl(url) {
+	return url.length > 80 ? `${url.slice(0, 77)}...` : url;
+}
+async function preflightExport(canvas, format, fonts, assetOptions) {
+	const problems = [];
+	const warnings = [];
+	if (format === "json") return {
+		ok: true,
+		problems,
+		warnings
+	};
+	for (const [url, use] of collectImageUses(canvas.getObjects())) {
+		const objectIds = [...use.objectIds];
+		if (isBroken(use.element)) problems.push({
+			code: "MISSING_IMAGE",
+			message: `The image ${shortUrl(url)} did not load`,
+			url,
+			objectIds
+		});
+		else if (isRasterFormat(format) && isCrossOriginUrl(url) && !use.element.crossOrigin) problems.push({
+			code: "CROSS_ORIGIN_IMAGE",
+			message: `The image ${shortUrl(url)} comes from another site without crossOrigin, so the browser blocks exporting it. Load it with crossOrigin: 'anonymous' from a server that allows CORS.`,
+			url,
+			objectIds
+		});
+		else if (format === "svg" && !isPortableUrl(url)) warnings.push({
+			code: "ASSET_NOT_PORTABLE",
+			message: `The SVG links to ${shortUrl(url)}, which only exists in this tab`,
+			url,
+			objectIds
+		});
+	}
+	const fontSet = typeof document === "undefined" ? void 0 : document.fonts;
+	if (fontSet) await fontSet.ready;
+	for (const font of await findUnavailableFonts(fonts, assetOptions.loadFont)) {
+		const message = `The font "${font.family}" (${font.weight}, ${font.style}) is not available`;
+		if (assetOptions.requireFonts) problems.push({
+			code: "MISSING_FONT",
+			message,
+			family: font.family,
+			objectIds: font.objectIds
+		});
+		else warnings.push({
+			code: "FONT_UNAVAILABLE",
+			message: `${message}, text will use a fallback font`,
+			family: font.family,
+			objectIds: font.objectIds
+		});
+	}
+	return {
+		ok: problems.length === 0,
+		problems,
+		warnings
+	};
+}
+//#endregion
+export { preflightExport };

package/dist/export/render-export.cjs

@@ -0,0 +1,69 @@
+//#region src/export/render-export.ts
+const identity = [
+	1,
+	0,
+	0,
+	1,
+	0,
+	0
+];
+const mimeTypes = {
+	png: "image/png",
+	jpeg: "image/jpeg",
+	webp: "image/webp",
+	svg: "image/svg+xml",
+	json: "application/json"
+};
+function chooseBackground(background, format, current) {
+	if (background === "transparent") return format === "jpeg" ? "white" : "";
+	if (background !== "keep") return background;
+	return format === "jpeg" && !(current !== void 0 && current !== null && current !== "") ? "white" : current;
+}
+function withExportView(canvas, background, format, work) {
+	const savedTransform = [...canvas.viewportTransform];
+	const savedBackground = canvas.backgroundColor;
+	canvas.setViewportTransform(identity);
+	canvas.backgroundColor = chooseBackground(background, format, savedBackground);
+	try {
+		return work();
+	} finally {
+		canvas.backgroundColor = savedBackground;
+		canvas.setViewportTransform(savedTransform);
+		canvas.requestRenderAll();
+	}
+}
+function renderRaster(canvas, area, format, scale, quality) {
+	return canvas.toDataURL({
+		...area,
+		format,
+		quality,
+		multiplier: scale,
+		enableRetinaScaling: false
+	});
+}
+function renderSvg(canvas, area, scale) {
+	return canvas.toSVG({
+		viewBox: {
+			x: area.left,
+			y: area.top,
+			width: area.width,
+			height: area.height
+		},
+		width: String(area.width * scale),
+		height: String(area.height * scale)
+	});
+}
+function dataUrlToBlob(dataUrl) {
+	const [header, payload = ""] = dataUrl.split(",");
+	const mimeType = /data:([^;]+)/.exec(header ?? "")?.[1] ?? "application/octet-stream";
+	const binary = atob(payload);
+	const bytes = new Uint8Array(binary.length);
+	for (let index = 0; index < binary.length; index += 1) bytes[index] = binary.charCodeAt(index);
+	return new Blob([bytes], { type: mimeType });
+}
+//#endregion
+exports.dataUrlToBlob = dataUrlToBlob;
+exports.mimeTypes = mimeTypes;
+exports.renderRaster = renderRaster;
+exports.renderSvg = renderSvg;
+exports.withExportView = withExportView;

package/dist/export/render-export.js

@@ -0,0 +1,65 @@
+//#region src/export/render-export.ts
+const identity = [
+	1,
+	0,
+	0,
+	1,
+	0,
+	0
+];
+const mimeTypes = {
+	png: "image/png",
+	jpeg: "image/jpeg",
+	webp: "image/webp",
+	svg: "image/svg+xml",
+	json: "application/json"
+};
+function chooseBackground(background, format, current) {
+	if (background === "transparent") return format === "jpeg" ? "white" : "";
+	if (background !== "keep") return background;
+	return format === "jpeg" && !(current !== void 0 && current !== null && current !== "") ? "white" : current;
+}
+function withExportView(canvas, background, format, work) {
+	const savedTransform = [...canvas.viewportTransform];
+	const savedBackground = canvas.backgroundColor;
+	canvas.setViewportTransform(identity);
+	canvas.backgroundColor = chooseBackground(background, format, savedBackground);
+	try {
+		return work();
+	} finally {
+		canvas.backgroundColor = savedBackground;
+		canvas.setViewportTransform(savedTransform);
+		canvas.requestRenderAll();
+	}
+}
+function renderRaster(canvas, area, format, scale, quality) {
+	return canvas.toDataURL({
+		...area,
+		format,
+		quality,
+		multiplier: scale,
+		enableRetinaScaling: false
+	});
+}
+function renderSvg(canvas, area, scale) {
+	return canvas.toSVG({
+		viewBox: {
+			x: area.left,
+			y: area.top,
+			width: area.width,
+			height: area.height
+		},
+		width: String(area.width * scale),
+		height: String(area.height * scale)
+	});
+}
+function dataUrlToBlob(dataUrl) {
+	const [header, payload = ""] = dataUrl.split(",");
+	const mimeType = /data:([^;]+)/.exec(header ?? "")?.[1] ?? "application/octet-stream";
+	const binary = atob(payload);
+	const bytes = new Uint8Array(binary.length);
+	for (let index = 0; index < binary.length; index += 1) bytes[index] = binary.charCodeAt(index);
+	return new Blob([bytes], { type: mimeType });
+}
+//#endregion
+export { dataUrlToBlob, mimeTypes, renderRaster, renderSvg, withExportView };

package/dist/history/apply-state.cjs

@@ -1,5 +1,5 @@
-const require_fabric_adapter = require("../fabric/fabric-adapter.cjs");
 const require_object_ids = require("../fabric/object-ids.cjs");
+const require_fabric_adapter = require("../fabric/fabric-adapter.cjs");
 //#region src/history/apply-state.ts
 function arrangeObjects(current, change, created) {
 	const arranged = [];

package/dist/history/apply-state.js

@@ -1,5 +1,5 @@
-import { createObjects } from "../fabric/fabric-adapter.js";
 import { readObjectId } from "../fabric/object-ids.js";
+import { createObjects } from "../fabric/fabric-adapter.js";
 //#region src/history/apply-state.ts
 function arrangeObjects(current, change, created) {
 	const arranged = [];

package/dist/index.cjs

@@ -2,14 +2,19 @@ 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_migrate_document = require("./migrations/migrate-document.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");
+const require_download_export = require("./export/download-export.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.detectSchemaVersion = require_migrate_document.detectSchemaVersion;
+exports.downloadExport = require_download_export.downloadExport;
 exports.isDocumentEngineError = require_errors.isDocumentEngineError;
+exports.migrateDocument = require_migrate_document.migrateDocument;
 exports.validateDocument = require_validate_document.validateDocument;

package/dist/index.d.cts

@@ -2,9 +2,12 @@ import { CURRENT_SCHEMA_VERSION, DocumentCanvas, DocumentInfo, FabricDocument, S
 import { AssetManifest, FontAsset, ImageAsset } from "./assets/asset-manifest.cjs";
 import { FontLoader } from "./assets/font-check.cjs";
 import { AssetOptions, AssetReport, AssetWarning, AssetWarningCode, UploadRequest } from "./assets/asset-pipeline.cjs";
+import { ExportArea, ExportBackground, ExportFormat, ExportOptions, ExportRect } from "./export/export-options.cjs";
+import { ExportPreflight, ExportProblem, ExportProblemCode } from "./export/preflight-export.cjs";
 import { NewDocumentOptions } from "./document/create-document.cjs";
 import { CustomObjectDefinition } from "./fabric/object-registry.cjs";
 import { HistoryOptions, HistoryState } from "./history/create-history.cjs";
+import { DocumentVersion, VersionKind, VersionOptions, VersionStorage, VersionSummary } from "./versions/document-version.cjs";
 import { RecoveryStore } from "./recovery/recovery-store.cjs";
 import { InterruptedLoad, RecoveryOptions, RecoveryRecord } from "./recovery/recovery-controller.cjs";
 import { AutosaveOptions } from "./save/autosave-scheduler.cjs";
@@ -13,8 +16,10 @@ import { DocumentEngineError, DocumentEngineErrorDetails, DocumentErrorCode, Doc
 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, LoadOptions, createDocumentEngine } from "./engine/create-document-engine.cjs";
+import { DocumentEngine, DocumentEngineEvents, DocumentEngineOptions, ExportResult, ImportOptions, LoadOptions, createDocumentEngine } from "./engine/create-document-engine.cjs";
 import { validateDocument } from "./document/validate-document.cjs";
 import { KeyboardShortcutOptions, UndoRedoTarget, bindKeyboardShortcuts } from "./history/keyboard-shortcuts.cjs";
 import { UnsavedChangesSource, bindUnsavedChangesWarning } from "./save/unsaved-changes-warning.cjs";
-export { type AssetManifest, type AssetOptions, type AssetReport, type AssetWarning, type AssetWarningCode, 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 FontAsset, type FontLoader, type HistoryOptions, type HistoryState, type ImageAsset, type InterruptedLoad, type KeyboardShortcutOptions, type LoadOptions, type NewDocumentOptions, type RecoveryOptions, type RecoveryRecord, type RecoveryStore, type RetryOptions, type SaveContext, type SaveOptions, type SaveResult, type SaveRetryEvent, type SaveState, type SaveStatus, type SerializedFabricObject, type UndoRedoTarget, type UnsavedChangesSource, type Unsubscribe, type UploadRequest, bindKeyboardShortcuts, bindUnsavedChangesWarning, createConflictError, createDocumentEngine, isDocumentEngineError, validateDocument };
+import { DownloadableExport, downloadExport } from "./export/download-export.cjs";
+import { Migration, MigrationContext, MigrationResult, detectSchemaVersion, migrateDocument } from "./migrations/migrate-document.cjs";
+export { type AssetManifest, type AssetOptions, type AssetReport, type AssetWarning, type AssetWarningCode, 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 DocumentVersion, type DownloadableExport, type ExportArea, type ExportBackground, type ExportFormat, type ExportOptions, type ExportPreflight, type ExportProblem, type ExportProblemCode, type ExportRect, type ExportResult, type FabricDocument, type FontAsset, type FontLoader, type HistoryOptions, type HistoryState, type ImageAsset, type ImportOptions, type InterruptedLoad, type KeyboardShortcutOptions, type LoadOptions, type Migration, type MigrationContext, type MigrationResult, type NewDocumentOptions, type RecoveryOptions, type RecoveryRecord, type RecoveryStore, type RetryOptions, type SaveContext, type SaveOptions, type SaveResult, type SaveRetryEvent, type SaveState, type SaveStatus, type SerializedFabricObject, type UndoRedoTarget, type UnsavedChangesSource, type Unsubscribe, type UploadRequest, type VersionKind, type VersionOptions, type VersionStorage, type VersionSummary, bindKeyboardShortcuts, bindUnsavedChangesWarning, createConflictError, createDocumentEngine, detectSchemaVersion, downloadExport, isDocumentEngineError, migrateDocument, validateDocument };

package/dist/index.d.ts

@@ -2,9 +2,12 @@ import { CURRENT_SCHEMA_VERSION, DocumentCanvas, DocumentInfo, FabricDocument, S
 import { AssetManifest, FontAsset, ImageAsset } from "./assets/asset-manifest.js";
 import { FontLoader } from "./assets/font-check.js";
 import { AssetOptions, AssetReport, AssetWarning, AssetWarningCode, UploadRequest } from "./assets/asset-pipeline.js";
+import { ExportArea, ExportBackground, ExportFormat, ExportOptions, ExportRect } from "./export/export-options.js";
+import { ExportPreflight, ExportProblem, ExportProblemCode } from "./export/preflight-export.js";
 import { NewDocumentOptions } from "./document/create-document.js";
 import { CustomObjectDefinition } from "./fabric/object-registry.js";
 import { HistoryOptions, HistoryState } from "./history/create-history.js";
+import { DocumentVersion, VersionKind, VersionOptions, VersionStorage, VersionSummary } from "./versions/document-version.js";
 import { RecoveryStore } from "./recovery/recovery-store.js";
 import { InterruptedLoad, RecoveryOptions, RecoveryRecord } from "./recovery/recovery-controller.js";
 import { AutosaveOptions } from "./save/autosave-scheduler.js";
@@ -13,8 +16,10 @@ import { DocumentEngineError, DocumentEngineErrorDetails, DocumentErrorCode, Doc
 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, LoadOptions, createDocumentEngine } from "./engine/create-document-engine.js";
+import { DocumentEngine, DocumentEngineEvents, DocumentEngineOptions, ExportResult, ImportOptions, LoadOptions, createDocumentEngine } from "./engine/create-document-engine.js";
 import { validateDocument } from "./document/validate-document.js";
 import { KeyboardShortcutOptions, UndoRedoTarget, bindKeyboardShortcuts } from "./history/keyboard-shortcuts.js";
 import { UnsavedChangesSource, bindUnsavedChangesWarning } from "./save/unsaved-changes-warning.js";
-export { type AssetManifest, type AssetOptions, type AssetReport, type AssetWarning, type AssetWarningCode, 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 FontAsset, type FontLoader, type HistoryOptions, type HistoryState, type ImageAsset, type InterruptedLoad, type KeyboardShortcutOptions, type LoadOptions, type NewDocumentOptions, type RecoveryOptions, type RecoveryRecord, type RecoveryStore, type RetryOptions, type SaveContext, type SaveOptions, type SaveResult, type SaveRetryEvent, type SaveState, type SaveStatus, type SerializedFabricObject, type UndoRedoTarget, type UnsavedChangesSource, type Unsubscribe, type UploadRequest, bindKeyboardShortcuts, bindUnsavedChangesWarning, createConflictError, createDocumentEngine, isDocumentEngineError, validateDocument };
+import { DownloadableExport, downloadExport } from "./export/download-export.js";
+import { Migration, MigrationContext, MigrationResult, detectSchemaVersion, migrateDocument } from "./migrations/migrate-document.js";
+export { type AssetManifest, type AssetOptions, type AssetReport, type AssetWarning, type AssetWarningCode, 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 DocumentVersion, type DownloadableExport, type ExportArea, type ExportBackground, type ExportFormat, type ExportOptions, type ExportPreflight, type ExportProblem, type ExportProblemCode, type ExportRect, type ExportResult, type FabricDocument, type FontAsset, type FontLoader, type HistoryOptions, type HistoryState, type ImageAsset, type ImportOptions, type InterruptedLoad, type KeyboardShortcutOptions, type LoadOptions, type Migration, type MigrationContext, type MigrationResult, type NewDocumentOptions, type RecoveryOptions, type RecoveryRecord, type RecoveryStore, type RetryOptions, type SaveContext, type SaveOptions, type SaveResult, type SaveRetryEvent, type SaveState, type SaveStatus, type SerializedFabricObject, type UndoRedoTarget, type UnsavedChangesSource, type Unsubscribe, type UploadRequest, type VersionKind, type VersionOptions, type VersionStorage, type VersionSummary, bindKeyboardShortcuts, bindUnsavedChangesWarning, createConflictError, createDocumentEngine, detectSchemaVersion, downloadExport, isDocumentEngineError, migrateDocument, validateDocument };

package/dist/index.js

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

package/dist/migrations/migrate-document.cjs

@@ -0,0 +1,65 @@
+const require_errors = require("../engine/errors.cjs");
+require("../document/document-format.cjs");
+const require_ids = require("../document/ids.cjs");
+//#region src/migrations/migrate-document.ts
+function isPlainObject(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function positiveNumberOr(value, fallback) {
+	return typeof value === "number" && Number.isFinite(value) && value > 0 ? value : fallback;
+}
+function fromFabricJson(json, context) {
+	const now = (/* @__PURE__ */ new Date()).toISOString();
+	const document = {
+		schemaVersion: 1,
+		id: context.id ?? (typeof json.id === "string" && json.id.length > 0 ? json.id : require_ids.createId()),
+		createdAt: now,
+		updatedAt: now,
+		revision: 0,
+		canvas: {
+			width: positiveNumberOr(json.width, context.canvasWidth),
+			height: positiveNumberOr(json.height, context.canvasHeight),
+			...json.background === void 0 ? {} : { background: json.background }
+		},
+		objects: json.objects,
+		metadata: { ...context.metadata }
+	};
+	if (typeof json.version === "string") document.fabricVersion = json.version;
+	return document;
+}
+const migrations = { 0: fromFabricJson };
+function detectSchemaVersion(value) {
+	if (!isPlainObject(value)) return void 0;
+	if (typeof value.schemaVersion === "number" && Number.isInteger(value.schemaVersion)) return value.schemaVersion;
+	if (value.schemaVersion === void 0 && Array.isArray(value.objects)) return 0;
+}
+function migrateDocument(value, context, steps = migrations, targetVersion = 1) {
+	const startVersion = detectSchemaVersion(value);
+	if (startVersion === void 0 || startVersion >= targetVersion || startVersion < 0) return {
+		document: value,
+		migratedFrom: void 0
+	};
+	let document = JSON.parse(JSON.stringify(value));
+	for (let version = startVersion; version < targetVersion; version += 1) {
+		const step = steps[version];
+		if (!step) throw new require_errors.DocumentEngineError("MIGRATION_FAILED", `There is no migration from schema version ${version}`, { migrationFrom: version });
+		try {
+			document = step(document, context);
+		} catch (error) {
+			const reason = error instanceof Error ? error.message : String(error);
+			throw new require_errors.DocumentEngineError("MIGRATION_FAILED", `Could not migrate the document from schema version ${version} to ${version + 1}: ${reason}`, {
+				cause: error,
+				migrationFrom: version
+			});
+		}
+		if (document.schemaVersion !== version + 1) throw new require_errors.DocumentEngineError("MIGRATION_FAILED", `The migration from schema version ${version} produced version ${String(document.schemaVersion)} instead of ${version + 1}`, { migrationFrom: version });
+	}
+	return {
+		document,
+		migratedFrom: startVersion
+	};
+}
+//#endregion
+exports.detectSchemaVersion = detectSchemaVersion;
+exports.migrateDocument = migrateDocument;
+exports.migrations = migrations;

package/dist/migrations/migrate-document.d.cts

@@ -0,0 +1,15 @@
+//#region src/migrations/migrate-document.d.ts
+export interface MigrationContext {
+  canvasWidth: number;
+  canvasHeight: number;
+  id?: string;
+  metadata?: Record<string, unknown>;
+}
+export type Migration = (document: Record<string, unknown>, context: MigrationContext) => Record<string, unknown>;
+export interface MigrationResult {
+  document: unknown;
+  migratedFrom: number | undefined;
+}
+export declare function detectSchemaVersion(value: unknown): number | undefined;
+export declare function migrateDocument(value: unknown, context: MigrationContext, steps?: Readonly<Record<number, Migration>>, targetVersion?: number): MigrationResult;
+//#endregion

package/dist/migrations/migrate-document.d.ts

@@ -0,0 +1,15 @@
+//#region src/migrations/migrate-document.d.ts
+export interface MigrationContext {
+  canvasWidth: number;
+  canvasHeight: number;
+  id?: string;
+  metadata?: Record<string, unknown>;
+}
+export type Migration = (document: Record<string, unknown>, context: MigrationContext) => Record<string, unknown>;
+export interface MigrationResult {
+  document: unknown;
+  migratedFrom: number | undefined;
+}
+export declare function detectSchemaVersion(value: unknown): number | undefined;
+export declare function migrateDocument(value: unknown, context: MigrationContext, steps?: Readonly<Record<number, Migration>>, targetVersion?: number): MigrationResult;
+//#endregion

package/dist/migrations/migrate-document.js

@@ -0,0 +1,63 @@
+import { DocumentEngineError } from "../engine/errors.js";
+import "../document/document-format.js";
+import { createId } from "../document/ids.js";
+//#region src/migrations/migrate-document.ts
+function isPlainObject(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function positiveNumberOr(value, fallback) {
+	return typeof value === "number" && Number.isFinite(value) && value > 0 ? value : fallback;
+}
+function fromFabricJson(json, context) {
+	const now = (/* @__PURE__ */ new Date()).toISOString();
+	const document = {
+		schemaVersion: 1,
+		id: context.id ?? (typeof json.id === "string" && json.id.length > 0 ? json.id : createId()),
+		createdAt: now,
+		updatedAt: now,
+		revision: 0,
+		canvas: {
+			width: positiveNumberOr(json.width, context.canvasWidth),
+			height: positiveNumberOr(json.height, context.canvasHeight),
+			...json.background === void 0 ? {} : { background: json.background }
+		},
+		objects: json.objects,
+		metadata: { ...context.metadata }
+	};
+	if (typeof json.version === "string") document.fabricVersion = json.version;
+	return document;
+}
+const migrations = { 0: fromFabricJson };
+function detectSchemaVersion(value) {
+	if (!isPlainObject(value)) return void 0;
+	if (typeof value.schemaVersion === "number" && Number.isInteger(value.schemaVersion)) return value.schemaVersion;
+	if (value.schemaVersion === void 0 && Array.isArray(value.objects)) return 0;
+}
+function migrateDocument(value, context, steps = migrations, targetVersion = 1) {
+	const startVersion = detectSchemaVersion(value);
+	if (startVersion === void 0 || startVersion >= targetVersion || startVersion < 0) return {
+		document: value,
+		migratedFrom: void 0
+	};
+	let document = JSON.parse(JSON.stringify(value));
+	for (let version = startVersion; version < targetVersion; version += 1) {
+		const step = steps[version];
+		if (!step) throw new DocumentEngineError("MIGRATION_FAILED", `There is no migration from schema version ${version}`, { migrationFrom: version });
+		try {
+			document = step(document, context);
+		} catch (error) {
+			const reason = error instanceof Error ? error.message : String(error);
+			throw new DocumentEngineError("MIGRATION_FAILED", `Could not migrate the document from schema version ${version} to ${version + 1}: ${reason}`, {
+				cause: error,
+				migrationFrom: version
+			});
+		}
+		if (document.schemaVersion !== version + 1) throw new DocumentEngineError("MIGRATION_FAILED", `The migration from schema version ${version} produced version ${String(document.schemaVersion)} instead of ${version + 1}`, { migrationFrom: version });
+	}
+	return {
+		document,
+		migratedFrom: startVersion
+	};
+}
+//#endregion
+export { detectSchemaVersion, migrateDocument, migrations };