fabricjs-document-engine 0.1.0 → 0.2.0

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

@@ -0,0 +1,14 @@
+import { DocumentStorage } from "./storage-contract.js";
+//#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

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

@@ -0,0 +1,35 @@
+import { DocumentEngineError, createConflictError } from "../engine/errors.js";
+//#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 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 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
+export { createKeyValueStorage };

package/dist/storage/local-storage.cjs

@@ -0,0 +1,24 @@
+const require_errors = require("../engine/errors.cjs");
+const require_key_value_storage = require("./key-value-storage.cjs");
+//#region src/storage/local-storage.ts
+function writeOrExplain(storage, key, value) {
+	try {
+		storage.setItem(key, value);
+	} catch (error) {
+		throw new require_errors.DocumentEngineError("SAVE_FAILED", "The browser refused to store the document, it may be out of space", {
+			cause: error,
+			retryable: false
+		});
+	}
+}
+function createLocalStorage(options = {}) {
+	const storage = options.storage ?? globalThis.localStorage;
+	return require_key_value_storage.createKeyValueStorage({
+		read: (key) => storage.getItem(key),
+		write: (key, value) => writeOrExplain(storage, key, value),
+		remove: (key) => storage.removeItem(key),
+		keys: () => Array.from({ length: storage.length }, (_, index) => storage.key(index) ?? "")
+	}, options.prefix ?? "fabric-document:");
+}
+//#endregion
+exports.createLocalStorage = createLocalStorage;

package/dist/storage/local-storage.d.cts

@@ -0,0 +1,8 @@
+import { ManagedDocumentStorage } from "./key-value-storage.cjs";
+//#region src/storage/local-storage.d.ts
+export interface LocalStorageOptions {
+  prefix?: string;
+  storage?: Storage;
+}
+export declare function createLocalStorage(options?: LocalStorageOptions): ManagedDocumentStorage;
+//#endregion

package/dist/storage/local-storage.d.ts

@@ -0,0 +1,8 @@
+import { ManagedDocumentStorage } from "./key-value-storage.js";
+//#region src/storage/local-storage.d.ts
+export interface LocalStorageOptions {
+  prefix?: string;
+  storage?: Storage;
+}
+export declare function createLocalStorage(options?: LocalStorageOptions): ManagedDocumentStorage;
+//#endregion

package/dist/storage/local-storage.js

@@ -0,0 +1,24 @@
+import { DocumentEngineError } from "../engine/errors.js";
+import { createKeyValueStorage } from "./key-value-storage.js";
+//#region src/storage/local-storage.ts
+function writeOrExplain(storage, key, value) {
+	try {
+		storage.setItem(key, value);
+	} catch (error) {
+		throw new DocumentEngineError("SAVE_FAILED", "The browser refused to store the document, it may be out of space", {
+			cause: error,
+			retryable: false
+		});
+	}
+}
+function createLocalStorage(options = {}) {
+	const storage = options.storage ?? globalThis.localStorage;
+	return createKeyValueStorage({
+		read: (key) => storage.getItem(key),
+		write: (key, value) => writeOrExplain(storage, key, value),
+		remove: (key) => storage.removeItem(key),
+		keys: () => Array.from({ length: storage.length }, (_, index) => storage.key(index) ?? "")
+	}, options.prefix ?? "fabric-document:");
+}
+//#endregion
+export { createLocalStorage };

package/dist/storage/memory-storage.cjs

@@ -0,0 +1,17 @@
+const require_key_value_storage = require("./key-value-storage.cjs");
+//#region src/storage/memory-storage.ts
+function createMemoryStorage() {
+	const records = /* @__PURE__ */ new Map();
+	return require_key_value_storage.createKeyValueStorage({
+		read: (key) => records.get(key) ?? null,
+		write: (key, value) => {
+			records.set(key, value);
+		},
+		remove: (key) => {
+			records.delete(key);
+		},
+		keys: () => [...records.keys()]
+	}, "");
+}
+//#endregion
+exports.createMemoryStorage = createMemoryStorage;

package/dist/storage/memory-storage.d.cts

@@ -0,0 +1,4 @@
+import { ManagedDocumentStorage } from "./key-value-storage.cjs";
+//#region src/storage/memory-storage.d.ts
+export declare function createMemoryStorage(): ManagedDocumentStorage;
+//#endregion

package/dist/storage/memory-storage.d.ts

@@ -0,0 +1,4 @@
+import { ManagedDocumentStorage } from "./key-value-storage.js";
+//#region src/storage/memory-storage.d.ts
+export declare function createMemoryStorage(): ManagedDocumentStorage;
+//#endregion

package/dist/storage/memory-storage.js

@@ -0,0 +1,17 @@
+import { createKeyValueStorage } from "./key-value-storage.js";
+//#region src/storage/memory-storage.ts
+function createMemoryStorage() {
+	const records = /* @__PURE__ */ new Map();
+	return createKeyValueStorage({
+		read: (key) => records.get(key) ?? null,
+		write: (key, value) => {
+			records.set(key, value);
+		},
+		remove: (key) => {
+			records.delete(key);
+		},
+		keys: () => [...records.keys()]
+	}, "");
+}
+//#endregion
+export { createMemoryStorage };

package/dist/storage/storage-contract.d.cts

@@ -0,0 +1,14 @@
+import { FabricDocument } from "../document/document-format.cjs";
+//#region src/storage/storage-contract.d.ts
+export interface SaveContext {
+  expectedRevision: number | null;
+  signal: AbortSignal;
+}
+export interface SaveResult {
+  revision?: number;
+}
+export interface DocumentStorage {
+  loadDocument(id: string): Promise<unknown>;
+  saveDocument(document: FabricDocument, context: SaveContext): Promise<void | SaveResult>;
+}
+//#endregion

package/dist/storage/storage-contract.d.ts

@@ -0,0 +1,14 @@
+import { FabricDocument } from "../document/document-format.js";
+//#region src/storage/storage-contract.d.ts
+export interface SaveContext {
+  expectedRevision: number | null;
+  signal: AbortSignal;
+}
+export interface SaveResult {
+  revision?: number;
+}
+export interface DocumentStorage {
+  loadDocument(id: string): Promise<unknown>;
+  saveDocument(document: FabricDocument, context: SaveContext): Promise<void | SaveResult>;
+}
+//#endregion

package/dist/storage.cjs

@@ -0,0 +1,7 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_key_value_storage = require("./storage/key-value-storage.cjs");
+const require_memory_storage = require("./storage/memory-storage.cjs");
+const require_local_storage = require("./storage/local-storage.cjs");
+exports.createKeyValueStorage = require_key_value_storage.createKeyValueStorage;
+exports.createLocalStorage = require_local_storage.createLocalStorage;
+exports.createMemoryStorage = require_memory_storage.createMemoryStorage;

package/dist/storage.d.cts

@@ -0,0 +1,5 @@
+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 };

package/dist/storage.d.ts

@@ -0,0 +1,5 @@
+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 };

package/dist/storage.js

@@ -0,0 +1,4 @@
+import { createKeyValueStorage } from "./storage/key-value-storage.js";
+import { createMemoryStorage } from "./storage/memory-storage.js";
+import { createLocalStorage } from "./storage/local-storage.js";
+export { createKeyValueStorage, createLocalStorage, createMemoryStorage };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fabricjs-document-engine",
-  "version": "0.1.0",
-  "description": "Turn an existing Fabric.js canvas into a dependable editable document: stable object ids, versioned save and load, custom object registration and clear load errors.",
+  "version": "0.2.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",
     "fabricjs",
@@ -17,7 +17,8 @@
     "redo",
     "autosave",
     "editor",
-    "typescript"
+    "typescript",
+    "storage"
   ],
   "license": "MIT",
   "author": "Sohail Khan (https://me.jscrate.dev)",
@@ -42,6 +43,16 @@
         "default": "./dist/index.cjs"
       }
     },
+    "./storage": {
+      "import": {
+        "types": "./dist/storage.d.ts",
+        "default": "./dist/storage.js"
+      },
+      "require": {
+        "types": "./dist/storage.d.cts",
+        "default": "./dist/storage.cjs"
+      }
+    },
     "./package.json": "./package.json"
   },
   "scripts": {