@cyberalien/svg-utils 0.0.1 → 0.0.2

package/lib/helpers/hash/css.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Convert hash to a string, usable in CSS for class names and keyframes
+ */
+declare function hashToCSSString(value: number[], limit?: number, hasPrefix?: boolean): string;
+export { hashToCSSString };

package/lib/helpers/hash/css.js

@@ -0,0 +1,27 @@
+const firstChars = "abcdefghijklmnopqrstuvwxyz";
+const chars = firstChars + "0123456789_-";
+const firstLetterRadix = 26;
+const letterRadix = 38;
+/**
+* Convert hash to a string, usable in CSS for class names and keyframes
+*/
+function hashToCSSString(value, limit = 8, hasPrefix = false) {
+	const result = [];
+	let num = value.shift() ?? 0;
+	if (!hasPrefix) {
+		result.push(firstChars[num % firstLetterRadix]);
+		num = Math.floor(num / firstLetterRadix);
+	}
+	while (true) {
+		while (num < 1) {
+			if (!value.length) return result.join("");
+			num = value.shift() ?? 0;
+		}
+		const isLastChar = result.length === limit - 1;
+		result.push(isLastChar ? firstChars[num % firstLetterRadix] : chars[num % letterRadix]);
+		if (result.length === limit) return result.join("");
+		num = Math.floor(num / letterRadix);
+	}
+}
+
+export { hashToCSSString };

package/lib/helpers/hash/hash.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Simple hashing function, based on https://gist.github.com/jlevy/c246006675becc446360a798e2b2d781
+ */
+declare function hashString(str: string, seed?: number): [number, number];
+export { hashString };

package/lib/helpers/hash/hash.js

@@ -0,0 +1,18 @@
+/**
+* Simple hashing function, based on https://gist.github.com/jlevy/c246006675becc446360a798e2b2d781
+*/
+function hashString(str, seed = 0) {
+	let h1 = 3735928559 ^ seed, h2 = 1103547991 ^ seed;
+	for (let i = 0, ch; i < str.length; i++) {
+		ch = str.charCodeAt(i);
+		h1 = Math.imul(h1 ^ ch, 2654435761);
+		h2 = Math.imul(h2 ^ ch, 1597334677);
+	}
+	h1 = Math.imul(h1 ^ h1 >>> 16, 2246822507);
+	h1 ^= Math.imul(h2 ^ h2 >>> 13, 3266489909);
+	h2 = Math.imul(h2 ^ h2 >>> 16, 2246822507);
+	h2 ^= Math.imul(h1 ^ h1 >>> 13, 3266489909);
+	return [h2 >>> 0, h1 >>> 0];
+}
+
+export { hashString };

package/lib/helpers/hash/unique.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Hash an object, make sure hash is unique
+ */
+declare function uniqueCSSHash(data: unknown, hasPrefix?: boolean): string;
+export { uniqueCSSHash };

package/lib/helpers/hash/unique.js

@@ -0,0 +1,23 @@
+import { sortObject } from "../misc/sort-object.js";
+import { hashString } from "./hash.js";
+import { hashToCSSString } from "./css.js";
+
+const uniqueHashes = Object.create(null);
+const uniqueWithPrefixHashes = Object.create(null);
+/**
+* Hash an object, make sure hash is unique
+*/
+function uniqueCSSHash(data, hasPrefix = false) {
+	const str = JSON.stringify(sortObject(data));
+	const hash = hashToCSSString(hashString(str), 6, hasPrefix);
+	const cache = hasPrefix ? uniqueWithPrefixHashes : uniqueHashes;
+	if (!cache[hash]) cache[hash] = str;
+	else if (cache[hash] !== str) {
+		console.warn("Data 1:", cache[hash]);
+		console.warn("Data 2:", str);
+		throw new Error(`Hash collision detected: ${hash}`);
+	}
+	return hash;
+}
+
+export { uniqueCSSHash };

package/lib/helpers/misc/clone.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Clone object, maintaining types
+ */
+declare function cloneObject<T>(item: T): T;
+export { cloneObject };

package/lib/helpers/misc/clone.js

@@ -0,0 +1,8 @@
+/**
+* Clone object, maintaining types
+*/
+function cloneObject(item) {
+	return JSON.parse(JSON.stringify(item));
+}
+
+export { cloneObject };

package/lib/helpers/misc/compare.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Compare sets, returns true if identical
+ */
+declare function compareSets<T>(set1: Set<T> | undefined, set2: Set<T> | undefined): boolean;
+/**
+ * Compare two values, returns true if identical
+ */
+declare function compareValues<T>(value1: T, value2: T): boolean;
+export { compareSets, compareValues };

package/lib/helpers/misc/compare.js

@@ -0,0 +1,19 @@
+import { sortObject } from "./sort-object.js";
+
+/**
+* Compare sets, returns true if identical
+*/
+function compareSets(set1, set2) {
+	if (!set1 || !set2) return false;
+	if (set1.size !== set2.size) return false;
+	for (const value of set1) if (!set2.has(value)) return false;
+	return true;
+}
+/**
+* Compare two values, returns true if identical
+*/
+function compareValues(value1, value2) {
+	return value1 === value2 || JSON.stringify(sortObject(value1)) === JSON.stringify(sortObject(value2));
+}
+
+export { compareSets, compareValues };

package/lib/helpers/misc/sort-object.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Sort object keys to generate consistend JSON output
+ *
+ * Used to hash objects
+ */
+declare function sortObject<T>(data: T): T;
+export { sortObject };

package/lib/helpers/misc/sort-object.js

@@ -0,0 +1,21 @@
+/**
+* Sort object keys to generate consistend JSON output
+*
+* Used to hash objects
+*/
+function sortObject(data) {
+	if (typeof data !== "object" || data === null) return data;
+	if (Array.isArray(data)) return data.map(sortObject);
+	if (data instanceof Set) {
+		const values = Array.from(data).map(sortObject);
+		values.sort();
+		return new Set(values);
+	}
+	const keys = Object.keys(data);
+	keys.sort();
+	const newObject = Object.create(null);
+	for (const key of keys) newObject[key] = sortObject(data[key]);
+	return newObject;
+}
+
+export { sortObject };

package/lib/index.d.ts

@@ -1,5 +1,9 @@
+import { hashString } from "./helpers/hash/hash.js";
+import { cloneObject } from "./helpers/misc/clone.js";
+import { compareSets, compareValues } from "./helpers/misc/compare.js";
+import { sortObject } from "./helpers/misc/sort-object.js";
 import { ParsedXMLNode, ParsedXMLTagElement, ParsedXMLTextElement } from "./xml/types.js";
 import { iterateXMLContent } from "./xml/iterate.js";
 import { parseXMLContent } from "./xml/parse.js";
 import { stringifyXMLContent } from "./xml/stringify.js";
-export { ParsedXMLNode, ParsedXMLTagElement, ParsedXMLTextElement, iterateXMLContent, parseXMLContent, stringifyXMLContent };
+export { ParsedXMLNode, ParsedXMLTagElement, ParsedXMLTextElement, cloneObject, compareSets, compareValues, hashString, iterateXMLContent, parseXMLContent, sortObject, stringifyXMLContent };

package/lib/index.js

@@ -1,5 +1,9 @@
+import { cloneObject } from "./helpers/misc/clone.js";
+import { sortObject } from "./helpers/misc/sort-object.js";
+import { compareSets, compareValues } from "./helpers/misc/compare.js";
+import { hashString } from "./helpers/hash/hash.js";
 import { iterateXMLContent } from "./xml/iterate.js";
 import { parseXMLContent } from "./xml/parse.js";
 import { stringifyXMLContent } from "./xml/stringify.js";
 
-export { iterateXMLContent, parseXMLContent, stringifyXMLContent };
+export { cloneObject, compareSets, compareValues, hashString, iterateXMLContent, parseXMLContent, sortObject, stringifyXMLContent };

package/package.json

@@ -3,7 +3,7 @@
   "type": "module",
   "description": "Common functions for working with SVG used by various packages.",
   "author": "Vjacheslav Trushkin",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license": "MIT",
   "bugs": "https://github.com/cyberalien/svg-utils/issues",
   "homepage": "https://cyberalien.dev/",