@configura/web-utilities 1.3.0-alpha.1 → 1.3.0-alpha.5

package/__tests__/convertLength.test.ts

@@ -0,0 +1,37 @@
+import { convertLength, toLengthUnit } from "../dist/utilitiesUnits";
+
+test("to m", () => {
+	expect(toLengthUnit("M")).toBe("m");
+});
+
+test("to in", () => {
+	expect(toLengthUnit("Inch")).toBe("in");
+});
+
+test("ft to ft", () => {
+	expect(convertLength(2, "ft", "ft")).toBe(2);
+});
+
+test("cm to m", () => {
+	expect(convertLength(2, "cm", "m")).toBe(0.02);
+});
+
+test("dm to mm", () => {
+	expect(convertLength(12.34, "dm", "mm")).toBe(1234);
+});
+
+test("ft to mm", () => {
+	expect(convertLength(12.34, "ft", "mm")).toBeCloseTo(3761.232, 3);
+});
+
+test("cm to inch", () => {
+	expect(convertLength(5, "cm", "in")).toBeCloseTo(1.96850394, 3);
+});
+
+test("feet to inch", () => {
+	expect(convertLength(1, "ft", "in")).toBe(12);
+});
+
+test("inch to feet", () => {
+	expect(convertLength(12, "in", "ft")).toBe(1);
+});

package/dist/GenericCache.d.ts

@@ -1,7 +1,15 @@
 export declare class GenericCache<Key, Item> {
+    private _keyLookupFunction?;
+    /** @remarks Using a keyLoopupFunction makes the cache much much slower! */
+    constructor(_keyLookupFunction?: ((key1: Key, key2: Key) => boolean) | undefined);
     _cache: Map<Key, Item>;
     get(key: Key, createMissing: () => Item): Item;
     delete: (key: Key) => boolean;
     clear: () => void;
+    /**
+     * This might seem unnecessary, but for non-primitive datatypes equality is compared on
+     * reference, not value, so finding the right key is a thing that must be done.
+     */
+    findExistingKeyOrReturnInput(key: Key, keyLookupFunction: (key1: Key, key2: Key) => boolean): Key;
 }
 //# sourceMappingURL=GenericCache.d.ts.map

package/dist/GenericCache.js

@@ -1,5 +1,7 @@
 export class GenericCache {
-    constructor() {
+    /** @remarks Using a keyLoopupFunction makes the cache much much slower! */
+    constructor(_keyLookupFunction) {
+        this._keyLookupFunction = _keyLookupFunction;
         this._cache = new Map();
         this.delete = (key) => {
             return this._cache.delete(key);
@@ -9,6 +11,10 @@ export class GenericCache {
         };
     }
     get(key, createMissing) {
+        key =
+            this._keyLookupFunction === undefined
+                ? key
+                : this.findExistingKeyOrReturnInput(key, this._keyLookupFunction);
         let item = this._cache.get(key);
         if (item !== undefined) {
             return item;
@@ -17,4 +23,16 @@ export class GenericCache {
         this._cache.set(key, item);
         return item;
     }
+    /**
+     * This might seem unnecessary, but for non-primitive datatypes equality is compared on
+     * reference, not value, so finding the right key is a thing that must be done.
+     */
+    findExistingKeyOrReturnInput(key, keyLookupFunction) {
+        for (const otherKey of this._cache.keys()) {
+            if (keyLookupFunction(key, otherKey)) {
+                return otherKey;
+            }
+        }
+        return key;
+    }
 }

package/dist/Observable/LogObservable.js

@@ -1,3 +1,4 @@
+import { hashCode } from "../index.js";
 import { AccumulatingObservable } from "./AccumulatingObservable.js";
 export var LogLevel;
 (function (LogLevel) {
@@ -16,13 +17,7 @@ export class LogMessage {
         return `${this.level}_${this.message}_${this.optionalParams.join("_")}`;
     }
     get levelMessageHash() {
-        const k = `${this.level}_${this.message}`;
-        let hash = 0;
-        for (let i = 0; i < k.length; i++) {
-            const chr = k.charCodeAt(i);
-            hash = (hash << 5) - hash + chr;
-        }
-        return hash;
+        return hashCode(`${this.level}_${this.message}`);
     }
     equals(other) {
         return this.key === other.key;
@@ -67,7 +62,7 @@ export class LogObservable extends AccumulatingObservable {
     static set accumulate(v) {
         this._accumulate = v;
         if (!v) {
-            LogObservable.clear();
+            this.clear();
         }
     }
     static get allMessages() {

package/dist/cmMips.d.ts

@@ -1,4 +1,5 @@
 import { LogObservable } from "./Observable/LogObservable.js";
+/** The mime type (or media type) is only used internally, so using the "x." sub type is OK. */
 export declare const CMMIPS_MIMETYPE = "image/x.cmmips";
 /**
  * Extracts the specified MIP level image data from the CmMips container.

package/dist/cmMips.js

@@ -1,7 +1,7 @@
-/// The mime type (or media type) is only used internally, so using the "x." sub type is OK.
+/** The mime type (or media type) is only used internally, so using the "x." sub type is OK. */
 export const CMMIPS_MIMETYPE = "image/x.cmmips";
 const CMMIPS_MAGIC = 0xee77;
-/// Set to true to get verbose CmMips parsing info to the console
+/** Set to true to get verbose CmMips parsing info to the console. */
 const CMMIPS_VERBOSE = false;
 /**
  * Extracts the specified MIP level image data from the CmMips container.
@@ -115,10 +115,12 @@ export class CmMip {
         this.data = data;
     }
 }
-/// Helper class for reading the serialized CmMips header.
-///
-/// The string format is from CM / DEX (?) and called "TinyNanoCStr".
-/// Numbers are stored in little endian.
+/**
+ * Helper class for reading the serialized CmMips header.
+ *
+ * The string format is from CM / DEX (?) and called "TinyNanoCStr".
+ * Numbers are stored in little endian.
+ */
 class CmMipsStream {
     constructor(bytes) {
         this.pos = 0;

package/dist/index.d.ts

@@ -15,5 +15,7 @@ export * from "./utilitiesImage.js";
 export * from "./utilitiesMath.js";
 export * from "./utilitiesPrice.js";
 export * from "./utilitiesPromise.js";
+export * from "./utilitiesString.js";
+export * from "./utilitiesUnits.js";
 export * from "./utilitiesWeb.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -15,4 +15,6 @@ export * from "./utilitiesImage.js";
 export * from "./utilitiesMath.js";
 export * from "./utilitiesPrice.js";
 export * from "./utilitiesPromise.js";
+export * from "./utilitiesString.js";
+export * from "./utilitiesUnits.js";
 export * from "./utilitiesWeb.js";

package/dist/utilitiesString.d.ts

@@ -0,0 +1,2 @@
+export declare function hashCode(str: string): number;
+//# sourceMappingURL=utilitiesString.d.ts.map

package/dist/utilitiesString.js

@@ -0,0 +1,12 @@
+export function hashCode(str) {
+    const len = str.length;
+    let hash = 0, i, chr;
+    if (len === 0)
+        return hash;
+    for (i = 0; i < len; i++) {
+        chr = str.charCodeAt(i);
+        hash = (hash << 5) - hash + chr;
+        hash |= 0; // Convert to 32bit integer
+    }
+    return hash;
+}

package/dist/utilitiesUnits.d.ts

@@ -0,0 +1,12 @@
+export declare type LengthUnit = "mm" | "cm" | "dm" | "m" | "in" | "ft";
+/**
+ * Converts string to LengthUnit.
+ * @throws an error if the supplied string isn't a known length unit
+ */
+export declare function toLengthUnit(unit: string): LengthUnit;
+/**
+ * As we accept inch as an alias for in we can't make this a typeguard
+ */
+export declare function isLengthUnit(unit: string): boolean;
+export declare function convertLength(l: number, from: LengthUnit, to: LengthUnit): number;
+//# sourceMappingURL=utilitiesUnits.d.ts.map

package/dist/utilitiesUnits.js

@@ -0,0 +1,61 @@
+const metricUnits = ["mm", "cm", "dm", "m"];
+const meterPerInch = 0.0254;
+const inchPerFeet = 12;
+const meterPerFeet = meterPerInch * inchPerFeet;
+/**
+ * Converts string to LengthUnit.
+ * @throws an error if the supplied string isn't a known length unit
+ */
+export function toLengthUnit(unit) {
+    unit = unit === null || unit === void 0 ? void 0 : unit.toLowerCase();
+    if (unit === "inch") {
+        unit = "in";
+    }
+    if (unit === "mm" ||
+        unit === "cm" ||
+        unit === "dm" ||
+        unit === "m" ||
+        unit === "in" ||
+        unit === "ft") {
+        return unit;
+    }
+    throw new Error(`Unknown length unit ${unit}`);
+}
+/**
+ * As we accept inch as an alias for in we can't make this a typeguard
+ */
+export function isLengthUnit(unit) {
+    return (metricUnits.find((m) => m === unit) !== undefined ||
+        unit === "in" ||
+        unit === "inch" ||
+        unit === "ft");
+}
+export function convertLength(l, from, to) {
+    if (from === "ft" && to === "in") {
+        return l * inchPerFeet;
+    }
+    if (from === "in" && to === "ft") {
+        return l / inchPerFeet;
+    }
+    if (from === "ft") {
+        l *= meterPerFeet;
+        from = "m";
+    }
+    else if (from === "in") {
+        l *= meterPerInch;
+        from = "m";
+    }
+    if (to === "ft") {
+        l /= meterPerFeet;
+        to = "m";
+    }
+    else if (to === "in") {
+        l /= meterPerInch;
+        to = "m";
+    }
+    if (from === to) {
+        return l;
+    }
+    l *= Math.pow(10, metricUnits.indexOf(from) - metricUnits.indexOf(to));
+    return l;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@configura/web-utilities",
-	"version": "1.3.0-alpha.1",
+	"version": "1.3.0-alpha.5",
 	"license": "Apache-2.0",
 	"type": "module",
 	"main": "dist/index.js",
@@ -22,5 +22,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "b0ef255a9f27f06a00378e09b24a40a840ba4722"
+	"gitHead": "7f22abef2c1047db092c871d9e9eceecbce5831e"
 }