fabricjs-document-engine 0.0.0

package/dist/fabric/object-registry.js

@@ -0,0 +1,21 @@
+import { DocumentEngineError } from "../engine/errors.js";
+import { classRegistry } from "fabric";
+//#region src/fabric/object-registry.ts
+function createObjectRegistry(initialDefinitions = []) {
+	const extraProperties = /* @__PURE__ */ new Set(["id"]);
+	function register(definition) {
+		const { fabricClass } = definition;
+		if (typeof fabricClass?.type !== "string" || fabricClass.type.length === 0) throw new DocumentEngineError("INVALID_CUSTOM_OBJECT", "A custom object class needs a static \"type\" string, for example: static type = \"Sticker\"");
+		if (typeof fabricClass.fromObject !== "function") throw new DocumentEngineError("INVALID_CUSTOM_OBJECT", `Custom object "${fabricClass.type}" must extend a Fabric class so it has a static fromObject method`);
+		classRegistry.setClass(fabricClass);
+		for (const property of definition.properties ?? []) extraProperties.add(property);
+	}
+	initialDefinitions.forEach(register);
+	return {
+		register,
+		propertiesToInclude: () => [...extraProperties],
+		findUnknownTypes: (types) => [...types].filter((type) => !classRegistry.has(type))
+	};
+}
+//#endregion
+export { createObjectRegistry };

package/dist/fabric/walk-objects.cjs

@@ -0,0 +1,29 @@
+//#region src/fabric/walk-objects.ts
+function childrenOf(object) {
+	const container = object;
+	return typeof container.getObjects === "function" ? container.getObjects() : [];
+}
+function walkObjects(roots, visit) {
+	const pending = [...roots].reverse();
+	while (pending.length > 0) {
+		const object = pending.pop();
+		visit(object);
+		const children = childrenOf(object);
+		for (let index = children.length - 1; index >= 0; index -= 1) pending.push(children[index]);
+	}
+}
+function collectSerializedTypes(objects) {
+	const types = /* @__PURE__ */ new Set();
+	const pending = [...objects];
+	while (pending.length > 0) {
+		const object = pending.pop();
+		types.add(object.type);
+		if (object.objects) pending.push(...object.objects);
+		if (object.clipPath) pending.push(object.clipPath);
+	}
+	return types;
+}
+//#endregion
+exports.childrenOf = childrenOf;
+exports.collectSerializedTypes = collectSerializedTypes;
+exports.walkObjects = walkObjects;

package/dist/fabric/walk-objects.js

@@ -0,0 +1,27 @@
+//#region src/fabric/walk-objects.ts
+function childrenOf(object) {
+	const container = object;
+	return typeof container.getObjects === "function" ? container.getObjects() : [];
+}
+function walkObjects(roots, visit) {
+	const pending = [...roots].reverse();
+	while (pending.length > 0) {
+		const object = pending.pop();
+		visit(object);
+		const children = childrenOf(object);
+		for (let index = children.length - 1; index >= 0; index -= 1) pending.push(children[index]);
+	}
+}
+function collectSerializedTypes(objects) {
+	const types = /* @__PURE__ */ new Set();
+	const pending = [...objects];
+	while (pending.length > 0) {
+		const object = pending.pop();
+		types.add(object.type);
+		if (object.objects) pending.push(...object.objects);
+		if (object.clipPath) pending.push(object.clipPath);
+	}
+	return types;
+}
+//#endregion
+export { childrenOf, collectSerializedTypes, walkObjects };

package/dist/index.cjs

@@ -0,0 +1,10 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+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");
+exports.CURRENT_SCHEMA_VERSION = require_document_format.CURRENT_SCHEMA_VERSION;
+exports.DocumentEngineError = require_errors.DocumentEngineError;
+exports.createDocumentEngine = require_create_document_engine.createDocumentEngine;
+exports.isDocumentEngineError = require_errors.isDocumentEngineError;
+exports.validateDocument = require_validate_document.validateDocument;

package/dist/index.d.cts

@@ -0,0 +1,8 @@
+import { CURRENT_SCHEMA_VERSION, DocumentCanvas, DocumentInfo, FabricDocument, SerializedFabricObject } from "./document/document-format.cjs";
+import { NewDocumentOptions } from "./document/create-document.cjs";
+import { CustomObjectDefinition } from "./fabric/object-registry.cjs";
+import { DocumentEngineError, DocumentEngineErrorDetails, DocumentErrorCode, DocumentIssue, isDocumentEngineError } from "./engine/errors.cjs";
+import { Unsubscribe } from "./engine/event-emitter.cjs";
+import { DocumentEngine, DocumentEngineEvents, DocumentEngineOptions, DocumentStorage, LoadOptions, createDocumentEngine } from "./engine/create-document-engine.cjs";
+import { validateDocument } from "./document/validate-document.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 LoadOptions, type NewDocumentOptions, type SerializedFabricObject, type Unsubscribe, createDocumentEngine, isDocumentEngineError, validateDocument };

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { CURRENT_SCHEMA_VERSION, DocumentCanvas, DocumentInfo, FabricDocument, SerializedFabricObject } from "./document/document-format.js";
+import { NewDocumentOptions } from "./document/create-document.js";
+import { CustomObjectDefinition } from "./fabric/object-registry.js";
+import { DocumentEngineError, DocumentEngineErrorDetails, DocumentErrorCode, DocumentIssue, isDocumentEngineError } from "./engine/errors.js";
+import { Unsubscribe } from "./engine/event-emitter.js";
+import { DocumentEngine, DocumentEngineEvents, DocumentEngineOptions, DocumentStorage, LoadOptions, createDocumentEngine } from "./engine/create-document-engine.js";
+import { validateDocument } from "./document/validate-document.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 LoadOptions, type NewDocumentOptions, type SerializedFabricObject, type Unsubscribe, createDocumentEngine, isDocumentEngineError, validateDocument };

package/dist/index.js

@@ -0,0 +1,5 @@
+import { CURRENT_SCHEMA_VERSION } from "./document/document-format.js";
+import { validateDocument } from "./document/validate-document.js";
+import { DocumentEngineError, isDocumentEngineError } from "./engine/errors.js";
+import { createDocumentEngine } from "./engine/create-document-engine.js";
+export { CURRENT_SCHEMA_VERSION, DocumentEngineError, createDocumentEngine, isDocumentEngineError, validateDocument };

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "fabricjs-document-engine",
+  "version": "0.0.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.",
+  "keywords": [
+    "fabric",
+    "fabricjs",
+    "fabric.js",
+    "canvas",
+    "canvas editor",
+    "document",
+    "document engine",
+    "save",
+    "load",
+    "serialization",
+    "undo",
+    "redo",
+    "autosave",
+    "editor",
+    "typescript"
+  ],
+  "license": "MIT",
+  "author": "Sohail Khan (https://me.jscrate.dev)",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "tsdown && npm run lint:publint && npm run lint:attw",
+    "dev": "tsdown --watch",
+    "typecheck": "tsc --noEmit && tsc --noEmit -p tsconfig.tools.json",
+    "test": "vitest run",
+    "test:unit": "vitest run --project unit",
+    "test:browser": "vitest run --project browser-fabric7 --project browser-fabric6",
+    "test:watch": "vitest",
+    "lint:publint": "publint --strict",
+    "lint:attw": "attw --pack . --profile node16",
+    "prepublishOnly": "npm run build",
+    "release": "changeset publish"
+  },
+  "peerDependencies": {
+    "fabric": "^6.0.0 || ^7.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/re-sohail/fabricjs-document-engine.git"
+  },
+  "homepage": "https://github.com/re-sohail/fabricjs-document-engine#readme",
+  "bugs": {
+    "url": "https://github.com/re-sohail/fabricjs-document-engine/issues"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@changesets/cli": "^3.0.3",
+    "@types/node": "^22.20.4",
+    "@vitest/browser-playwright": "^5.0.2",
+    "fabric": "^7.4.0",
+    "fabric6": "npm:fabric@^6.9.1",
+    "playwright": "^1.63.0",
+    "publint": "^0.3.24",
+    "tsdown": "^0.23.0",
+    "typescript": "^5.9.3",
+    "vitest": "^5.0.2"
+  }
+}