fabricjs-document-engine 0.4.0 → 0.6.0

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

@@ -1,4 +1,5 @@
 const require_errors = require("../engine/errors.cjs");
+const require_document_version = require("../versions/document-version.cjs");
 //#region src/storage/key-value-storage.ts
 function readRevision(json) {
 	if (json === null) return 0;
@@ -6,7 +7,19 @@ function readRevision(json) {
 	return typeof revision === "number" ? revision : 0;
 }
 function createKeyValueStorage(store, prefix) {
+	const versionMarker = "::version::";
 	const keyFor = (id) => `${prefix}${id}`;
+	const versionPrefixFor = (documentId) => `${keyFor(documentId)}${versionMarker}`;
+	const versionKeyFor = (documentId, versionId) => `${versionPrefixFor(documentId)}${versionId}`;
+	function readVersion(documentId, versionId) {
+		const json = store.read(versionKeyFor(documentId, versionId));
+		if (json === null) throw new require_errors.DocumentEngineError("VERSION_NOT_FOUND", `Document "${documentId}" has no version "${versionId}"`);
+		return JSON.parse(json);
+	}
+	function versionKeysOf(documentId) {
+		const versionPrefix = versionPrefixFor(documentId);
+		return store.keys().filter((key) => key.startsWith(versionPrefix));
+	}
 	return {
 		async loadDocument(id) {
 			const json = store.read(keyFor(id));
@@ -24,10 +37,23 @@ function createKeyValueStorage(store, prefix) {
 			return { revision };
 		},
 		async listDocuments() {
-			return store.keys().filter((key) => key.startsWith(prefix)).map((key) => key.slice(prefix.length));
+			return store.keys().filter((key) => key.startsWith(prefix) && !key.includes(versionMarker)).map((key) => key.slice(prefix.length));
 		},
 		async deleteDocument(id) {
+			versionKeysOf(id).forEach((key) => store.remove(key));
 			store.remove(keyFor(id));
+		},
+		async saveVersion(version) {
+			store.write(versionKeyFor(version.documentId, version.id), JSON.stringify(version));
+		},
+		async listVersions(documentId) {
+			return versionKeysOf(documentId).map((key) => require_document_version.summarize(JSON.parse(store.read(key) ?? "null"))).sort(require_document_version.newestFirst);
+		},
+		async loadVersion(documentId, versionId) {
+			return readVersion(documentId, versionId);
+		},
+		async deleteVersion(documentId, versionId) {
+			store.remove(versionKeyFor(documentId, versionId));
 		}
 	};
 }

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

@@ -1,3 +1,4 @@
+import { VersionStorage } from "../versions/document-version.cjs";
 import { DocumentStorage } from "./storage-contract.cjs";
 //#region src/storage/key-value-storage.d.ts
 export interface KeyValueStore {
@@ -6,7 +7,7 @@ export interface KeyValueStore {
   remove(key: string): void;
   keys(): string[];
 }
-export interface ManagedDocumentStorage extends DocumentStorage {
+export interface ManagedDocumentStorage extends DocumentStorage, VersionStorage {
   listDocuments(): Promise<string[]>;
   deleteDocument(id: string): Promise<void>;
 }

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

@@ -1,3 +1,4 @@
+import { VersionStorage } from "../versions/document-version.js";
 import { DocumentStorage } from "./storage-contract.js";
 //#region src/storage/key-value-storage.d.ts
 export interface KeyValueStore {
@@ -6,7 +7,7 @@ export interface KeyValueStore {
   remove(key: string): void;
   keys(): string[];
 }
-export interface ManagedDocumentStorage extends DocumentStorage {
+export interface ManagedDocumentStorage extends DocumentStorage, VersionStorage {
   listDocuments(): Promise<string[]>;
   deleteDocument(id: string): Promise<void>;
 }

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

@@ -1,4 +1,5 @@
 import { DocumentEngineError, createConflictError } from "../engine/errors.js";
+import { newestFirst, summarize } from "../versions/document-version.js";
 //#region src/storage/key-value-storage.ts
 function readRevision(json) {
 	if (json === null) return 0;
@@ -6,7 +7,19 @@ function readRevision(json) {
 	return typeof revision === "number" ? revision : 0;
 }
 function createKeyValueStorage(store, prefix) {
+	const versionMarker = "::version::";
 	const keyFor = (id) => `${prefix}${id}`;
+	const versionPrefixFor = (documentId) => `${keyFor(documentId)}${versionMarker}`;
+	const versionKeyFor = (documentId, versionId) => `${versionPrefixFor(documentId)}${versionId}`;
+	function readVersion(documentId, versionId) {
+		const json = store.read(versionKeyFor(documentId, versionId));
+		if (json === null) throw new DocumentEngineError("VERSION_NOT_FOUND", `Document "${documentId}" has no version "${versionId}"`);
+		return JSON.parse(json);
+	}
+	function versionKeysOf(documentId) {
+		const versionPrefix = versionPrefixFor(documentId);
+		return store.keys().filter((key) => key.startsWith(versionPrefix));
+	}
 	return {
 		async loadDocument(id) {
 			const json = store.read(keyFor(id));
@@ -24,10 +37,23 @@ function createKeyValueStorage(store, prefix) {
 			return { revision };
 		},
 		async listDocuments() {
-			return store.keys().filter((key) => key.startsWith(prefix)).map((key) => key.slice(prefix.length));
+			return store.keys().filter((key) => key.startsWith(prefix) && !key.includes(versionMarker)).map((key) => key.slice(prefix.length));
 		},
 		async deleteDocument(id) {
+			versionKeysOf(id).forEach((key) => store.remove(key));
 			store.remove(keyFor(id));
+		},
+		async saveVersion(version) {
+			store.write(versionKeyFor(version.documentId, version.id), JSON.stringify(version));
+		},
+		async listVersions(documentId) {
+			return versionKeysOf(documentId).map((key) => summarize(JSON.parse(store.read(key) ?? "null"))).sort(newestFirst);
+		},
+		async loadVersion(documentId, versionId) {
+			return readVersion(documentId, versionId);
+		},
+		async deleteVersion(documentId, versionId) {
+			store.remove(versionKeyFor(documentId, versionId));
 		}
 	};
 }

package/dist/storage.d.cts

@@ -1,5 +1,6 @@
+import { DocumentVersion, VersionStorage, VersionSummary } from "./versions/document-version.cjs";
 import { DocumentStorage, SaveContext, SaveResult } from "./storage/storage-contract.cjs";
 import { KeyValueStore, ManagedDocumentStorage, createKeyValueStorage } from "./storage/key-value-storage.cjs";
 import { createMemoryStorage } from "./storage/memory-storage.cjs";
 import { LocalStorageOptions, createLocalStorage } from "./storage/local-storage.cjs";
-export { type DocumentStorage, type KeyValueStore, type LocalStorageOptions, type ManagedDocumentStorage, type SaveContext, type SaveResult, createKeyValueStorage, createLocalStorage, createMemoryStorage };
+export { type DocumentStorage, type DocumentVersion, type KeyValueStore, type LocalStorageOptions, type ManagedDocumentStorage, type SaveContext, type SaveResult, type VersionStorage, type VersionSummary, createKeyValueStorage, createLocalStorage, createMemoryStorage };

package/dist/storage.d.ts

@@ -1,5 +1,6 @@
+import { DocumentVersion, VersionStorage, VersionSummary } from "./versions/document-version.js";
 import { DocumentStorage, SaveContext, SaveResult } from "./storage/storage-contract.js";
 import { KeyValueStore, ManagedDocumentStorage, createKeyValueStorage } from "./storage/key-value-storage.js";
 import { createMemoryStorage } from "./storage/memory-storage.js";
 import { LocalStorageOptions, createLocalStorage } from "./storage/local-storage.js";
-export { type DocumentStorage, type KeyValueStore, type LocalStorageOptions, type ManagedDocumentStorage, type SaveContext, type SaveResult, createKeyValueStorage, createLocalStorage, createMemoryStorage };
+export { type DocumentStorage, type DocumentVersion, type KeyValueStore, type LocalStorageOptions, type ManagedDocumentStorage, type SaveContext, type SaveResult, type VersionStorage, type VersionSummary, createKeyValueStorage, createLocalStorage, createMemoryStorage };

package/dist/versions/document-version.cjs

@@ -0,0 +1,20 @@
+//#region src/versions/document-version.ts
+function summarize(version) {
+	const { document: _document, ...summary } = version;
+	return summary;
+}
+function newestFirst(first, second) {
+	return second.createdAt.localeCompare(first.createdAt);
+}
+function versionsToPrune(versions, keepAuto) {
+	return versions.filter((version) => version.kind === "auto").sort(newestFirst).slice(Math.max(0, keepAuto));
+}
+function supportsVersions(storage) {
+	const candidate = storage;
+	return typeof candidate?.saveVersion === "function" && typeof candidate.listVersions === "function" && typeof candidate.loadVersion === "function" && typeof candidate.deleteVersion === "function";
+}
+//#endregion
+exports.newestFirst = newestFirst;
+exports.summarize = summarize;
+exports.supportsVersions = supportsVersions;
+exports.versionsToPrune = versionsToPrune;

package/dist/versions/document-version.d.cts

@@ -0,0 +1,25 @@
+import { FabricDocument } from "../document/document-format.cjs";
+//#region src/versions/document-version.d.ts
+export type VersionKind = "named" | "auto";
+export interface VersionSummary {
+  id: string;
+  documentId: string;
+  name: string;
+  kind: VersionKind;
+  createdAt: string;
+  revision: number;
+}
+export interface DocumentVersion extends VersionSummary {
+  document: FabricDocument;
+}
+export interface VersionStorage {
+  saveVersion(version: DocumentVersion): Promise<void>;
+  listVersions(documentId: string): Promise<VersionSummary[]>;
+  loadVersion(documentId: string, versionId: string): Promise<DocumentVersion>;
+  deleteVersion(documentId: string, versionId: string): Promise<void>;
+}
+export interface VersionOptions {
+  keepAuto?: number;
+  autoEvery?: number;
+}
+//#endregion

package/dist/versions/document-version.d.ts

@@ -0,0 +1,25 @@
+import { FabricDocument } from "../document/document-format.js";
+//#region src/versions/document-version.d.ts
+export type VersionKind = "named" | "auto";
+export interface VersionSummary {
+  id: string;
+  documentId: string;
+  name: string;
+  kind: VersionKind;
+  createdAt: string;
+  revision: number;
+}
+export interface DocumentVersion extends VersionSummary {
+  document: FabricDocument;
+}
+export interface VersionStorage {
+  saveVersion(version: DocumentVersion): Promise<void>;
+  listVersions(documentId: string): Promise<VersionSummary[]>;
+  loadVersion(documentId: string, versionId: string): Promise<DocumentVersion>;
+  deleteVersion(documentId: string, versionId: string): Promise<void>;
+}
+export interface VersionOptions {
+  keepAuto?: number;
+  autoEvery?: number;
+}
+//#endregion

package/dist/versions/document-version.js

@@ -0,0 +1,17 @@
+//#region src/versions/document-version.ts
+function summarize(version) {
+	const { document: _document, ...summary } = version;
+	return summary;
+}
+function newestFirst(first, second) {
+	return second.createdAt.localeCompare(first.createdAt);
+}
+function versionsToPrune(versions, keepAuto) {
+	return versions.filter((version) => version.kind === "auto").sort(newestFirst).slice(Math.max(0, keepAuto));
+}
+function supportsVersions(storage) {
+	const candidate = storage;
+	return typeof candidate?.saveVersion === "function" && typeof candidate.listVersions === "function" && typeof candidate.loadVersion === "function" && typeof candidate.deleteVersion === "function";
+}
+//#endregion
+export { newestFirst, summarize, supportsVersions, versionsToPrune };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fabricjs-document-engine",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Turn an existing Fabric.js canvas into a dependable editable document: stable object ids, versioned save and load, undo and redo, safe autosave with conflict protection, custom objects and clear errors.",
   "keywords": [
     "fabric",