@utiliread/primitives 1.0.0-9 → 1.0.0-90

package/src/number-formatter.ts

@@ -1,50 +1,118 @@
-const invariantDecimalSeparator = (0.1).toString()[1];
-const localeDecimalSeparator = (0.1).toLocaleString()[1];
-
-class Formatter {
-    public toLocalePrecision(value: number, precision: number) {
-        const absValue = Math.abs(value);
-        if (absValue < 1) {
-            return toPrecision(value, precision);
-        }
-
-        const noOfIntegerDigits = Math.round(absValue).toString().length;
-        return precision >= noOfIntegerDigits
-            ? toFixed(value, precision - noOfIntegerDigits)
-            : toPrecision(value, precision);
-    }
-
-    public toLocaleFixed(value: number, precision: number) {
-        const formatted = this.toLocalePrecision(value, precision);
-        const match = /(.*)e\+(\d)$/.exec(formatted);
-        if (match) {
-            let number = match[1];
-            let exponent = parseInt(match[2]);
-            const decimalSeparatorIndex = number.indexOf(localeDecimalSeparator);
-            if (decimalSeparatorIndex === -1) {
-                return `${number}${"0".repeat(exponent)}`;
-            }
-            else if (decimalSeparatorIndex >= 0) {
-                const noOfDecimals = number.length - decimalSeparatorIndex - 1;
-                if (noOfDecimals < exponent) {
-                    number = number.replace(localeDecimalSeparator, "");
-                    exponent -= noOfDecimals;
-                    return `${number}${"0".repeat(exponent)}`;
-                }
-            }
-        }
-        return formatted;
-    }
-}
-
-function toFixed(value: number, fractionDigits: number) {
-    const formatted = value.toFixed(fractionDigits);
-    return formatted.replace(invariantDecimalSeparator, localeDecimalSeparator);
-}
-
-function toPrecision(value: number, precision: number) {
-    const formatted = value.toPrecision(precision);
-    return formatted.replace(invariantDecimalSeparator, localeDecimalSeparator);
-}
-
-export const NumberFormatter = new Formatter();
+export const invariantDecimalSeparator = (0.1).toString()[1];
+export const localeDecimalSeparator = (0.1).toLocaleString()[1];
+
+export interface Parts {
+    invariantPrecisionString: string;
+    invariantCoefficientString: string;
+    exponent: number;
+    noOfCoefficientDecimals: number;
+}
+
+class Formatter {
+    public toPrecision(value: number, precision: number, maxDecimals?: number) {
+        const absValue = Math.abs(value);
+        const noOfIntegerDigits = Math.round(absValue).toString().length;
+
+        // Adjust precision to maxDecimals
+        if (maxDecimals !== undefined) {
+            precision = Math.min(precision, noOfIntegerDigits + maxDecimals);
+        }
+
+        if (value === 0) {
+            // (0).toPrecision(1) == "0"
+            // (0).toPrecision(2) == "0.0"
+            // (0).toPrecision(3) == "0.00"
+            // However, we want:
+            // Formatter.toPrecision(0, 0) == "0"
+            // Formatter.toPrecision(0, 1) == "0.0"
+            // Formatter.toPrecision(0, 2) == "0.00"
+            return value.toPrecision(precision + 1);
+        }
+
+        if (absValue < 1) {
+            return value.toPrecision(precision);
+        }
+
+        return precision >= noOfIntegerDigits
+            ? value.toFixed(precision - noOfIntegerDigits)
+            : value.toPrecision(precision);
+    }
+
+    public toLocalePrecision(
+        value: number,
+        precision: number,
+        maxDecimals?: number,
+    ) {
+        return this.toPrecision(value, precision, maxDecimals).replace(
+            invariantDecimalSeparator,
+            localeDecimalSeparator,
+        );
+    }
+
+    public toFixed(value: number, precision: number, maxDecimals?: number) {
+        const parts = this.getParts(value, precision, maxDecimals);
+        if (parts.noOfCoefficientDecimals < parts.exponent) {
+            const number = parts.invariantCoefficientString.replace(
+                invariantDecimalSeparator,
+                "",
+            );
+            const zeros = parts.exponent - parts.noOfCoefficientDecimals;
+            return `${number}${"0".repeat(zeros)}`;
+        } else {
+            return parts.invariantPrecisionString;
+        }
+    }
+
+    public toLocaleFixed(
+        value: number,
+        precision: number,
+        maxDecimals?: number,
+    ) {
+        return this.toFixed(value, precision, maxDecimals).replace(
+            invariantDecimalSeparator,
+            localeDecimalSeparator,
+        );
+    }
+
+    public getParts(
+        value: number,
+        precision: number,
+        maxDecimals?: number,
+    ): Parts {
+        const precisionString = this.toPrecision(value, precision, maxDecimals);
+        if (precisionString.indexOf("e") >= 0) {
+            const match = /(.*)e([\+-]\d+)$/.exec(precisionString)!;
+            const coefficientString = match[1];
+            const exponent = parseInt(match[2]);
+            const decimalSeparatorIndex = coefficientString.indexOf(
+                invariantDecimalSeparator,
+            );
+            const noOfCoefficientDecimals =
+                decimalSeparatorIndex >= 0
+                    ? coefficientString.length - decimalSeparatorIndex - 1
+                    : 0;
+            return {
+                invariantPrecisionString: precisionString,
+                invariantCoefficientString: coefficientString,
+                exponent,
+                noOfCoefficientDecimals,
+            };
+        } else {
+            const decimalSeparatorIndex = precisionString.indexOf(
+                invariantDecimalSeparator,
+            );
+            const noOfCoefficientDecimals =
+                decimalSeparatorIndex >= 0
+                    ? precisionString.length - decimalSeparatorIndex - 1
+                    : 0;
+            return {
+                invariantPrecisionString: precisionString,
+                invariantCoefficientString: precisionString,
+                exponent: 0,
+                noOfCoefficientDecimals,
+            };
+        }
+    }
+}
+
+export const NumberFormatter = new Formatter();

package/src/optional.ts

@@ -0,0 +1 @@
+export type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;

package/src/precision-number.spec.ts

@@ -0,0 +1,28 @@
+import { PrecisionNumber } from "./precision-number";
+import { expect } from "@esm-bundle/chai";
+
+describe("precision-number", () => {
+    it("should not parse ''", () => {
+        const number = PrecisionNumber.parse("");
+        expect(Number.isNaN(number.value)).to.equal(true);
+        expect(number.precision).to.equal(0);
+    });
+
+    it("should parse '1'", () => {
+        const number = PrecisionNumber.parse("1");
+        expect(number.value).to.equal(1);
+        expect(number.precision).to.equal(1);
+    });
+
+    it("should parse '1.'", () => {
+        const number = PrecisionNumber.parse("1.");
+        expect(number.value).to.equal(1);
+        expect(number.precision).to.equal(2);
+    });
+
+    it("should parse '1.0'", () => {
+        const number = PrecisionNumber.parse("1.0");
+        expect(number.value).to.equal(1);
+        expect(number.precision).to.equal(2);
+    });
+});

package/src/precision-number.ts

@@ -0,0 +1,44 @@
+import { invariantDecimalSeparator } from ".";
+import { localeDecimalSeparator, NumberFormatter } from "./number-formatter";
+
+export class PrecisionNumber {
+    constructor(
+        public value: number,
+        public precision: number,
+    ) {}
+
+    static parse(input: string) {
+        let normalized = input
+            .trim()
+            .replace(",", ".")
+            .replace(localeDecimalSeparator, invariantDecimalSeparator);
+        if (normalized.endsWith(invariantDecimalSeparator)) {
+            normalized += "0";
+        }
+        const precision = normalized
+            .replace(".", "")
+            .replace("+", "")
+            .replace("-", "").length;
+        return new PrecisionNumber(parseFloat(normalized), precision);
+    }
+
+    toString() {
+        return this.value.toString();
+    }
+
+    toFixed() {
+        return NumberFormatter.toFixed(this.value, this.precision);
+    }
+
+    toPrecision() {
+        return NumberFormatter.toPrecision(this.value, this.precision);
+    }
+
+    toLocaleFixed() {
+        return NumberFormatter.toLocaleFixed(this.value, this.precision);
+    }
+
+    toLocalePrecision() {
+        return NumberFormatter.toLocalePrecision(this.value, this.precision);
+    }
+}

package/src/register-convention.spec.ts

@@ -1,14 +1,52 @@
-import { expect } from "chai";
-import { RegisterConvention } from "./register-convention";
-
-describe("getAggregate", () => {
-    it("instant register is instant", () => {
-        const result = RegisterConvention.getAggregate("flowTemperature");
-        expect(result).to.equal("instant");
-    });
-
-    it("avg register is avg", () => {
-        const result = RegisterConvention.getAggregate("avgFlowTemperature");
-        expect(result).to.equal("avg");
-    });
-});
+import { RegisterConvention } from "./register-convention";
+import { expect } from "@esm-bundle/chai";
+
+describe("getAggregate", () => {
+    it("instant register is instant", () => {
+        const result = RegisterConvention.getAggregate("flowTemperature");
+        expect(result).to.equal("instant");
+    });
+
+    it("avg register is avg", () => {
+        const result = RegisterConvention.getAggregate("avgFlowTemperature");
+        expect(result).to.equal("avg");
+    });
+});
+
+describe("toInstant", () => {
+    it("should convert instant", () => {
+        const registerId = RegisterConvention.toInstant("flowTemperature");
+        expect(registerId).to.equal("flowTemperature");
+    });
+
+    it("should convert aggregate", () => {
+        const registerId = RegisterConvention.toInstant("avgFlowTemperature");
+        expect(registerId).to.equal("flowTemperature");
+    });
+});
+
+describe("toAggregate", () => {
+    it("should convert instant to aggregate", () => {
+        const registerId = RegisterConvention.toAggregate(
+            "flowTemperature",
+            "avg",
+        );
+        expect(registerId).to.equal("avgFlowTemperature");
+    });
+
+    it("should convert aggregate to same aggregate", () => {
+        const registerId = RegisterConvention.toAggregate(
+            "avgFlowTemperature",
+            "avg",
+        );
+        expect(registerId).to.equal("avgFlowTemperature");
+    });
+
+    it("should convert aggregate to other aggregate", () => {
+        const registerId = RegisterConvention.toAggregate(
+            "avgFlowTemperature",
+            "min",
+        );
+        expect(registerId).to.equal("minFlowTemperature");
+    });
+});

package/src/register-convention.ts

@@ -1,41 +1,70 @@
-import { RegisterDefinition } from ".";
-import { AggregateId } from "./aggregate-id";
-import { RegisterId } from "./register-id";
-import { getRegisterId } from "./register-utils";
-
-export const aggregatePrefixes: { [aggregateId in AggregateId]: string } = {
-    instant: "",
-    diff: "diff",
-    min: "min",
-    max: "max",
-    avg: "avg",
-    sum: "sum",
-    cnt: "cnt",
-    ssq: "ssq",
-};
-
-class Convention {
-    public getAggregate(register: RegisterId | RegisterDefinition) {
-        const registerId = getRegisterId(register);
-        // Brute force all prefixes - if none of them, then it must be instant.
-        for (const aggregateString of Object.keys(aggregatePrefixes)) {
-            const aggregate = <AggregateId>aggregateString;
-            const prefix = aggregatePrefixes[aggregate];
-            if (prefix.length && isPrefix(registerId, prefix)) {
-                // Not instant - it was any of the others.
-                return aggregate;
-            }
-        }
-        return "instant";
-    }
-}
-
-export function isPrefix(registerId: RegisterId, prefix: string) {
-    return registerId.startsWith(prefix) && isUppercase(registerId[prefix.length]);
-}
-
-function isUppercase(input: string) {
-    return input.toUpperCase() === input;
-}
-
-export const RegisterConvention = new Convention();
+import { RegisterDefinition } from "./register-definition";
+import { AggregateId } from "./aggregate-id";
+import { RegisterId } from "./register-id";
+import { getRegisterId } from "./register-utils";
+
+export const aggregatePrefixes: { [aggregateId in AggregateId]: string } = {
+    instant: "",
+    diff: "diff",
+    min: "min",
+    max: "max",
+    avg: "avg",
+    sum: "sum",
+    cnt: "cnt",
+    ssq: "ssq",
+};
+
+class Convention {
+    public getAggregate(register: RegisterId | RegisterDefinition) {
+        const registerId = getRegisterId(register);
+        // Brute force all prefixes - if none of them, then it must be instant.
+        for (const aggregateString of Object.keys(aggregatePrefixes)) {
+            const aggregate = <AggregateId>aggregateString;
+            const prefix = aggregatePrefixes[aggregate];
+            if (prefix.length && isPrefix(registerId, prefix)) {
+                // Not instant - it was any of the others.
+                return aggregate;
+            }
+        }
+        return "instant";
+    }
+
+    toInstant(register: RegisterId | RegisterDefinition) {
+        const registerId = getRegisterId(register);
+        for (const prefix of Object.values(aggregatePrefixes)) {
+            if (prefix.length && isPrefix(registerId, prefix)) {
+                const tail = registerId.substr(prefix.length);
+                return <RegisterId>(tail[0].toLowerCase() + tail.substr(1));
+            }
+        }
+        return registerId;
+    }
+
+    toAggregate(
+        register: RegisterId | RegisterDefinition,
+        aggregate: AggregateId,
+    ) {
+        const instantRegisterId = this.toInstant(register);
+        if (aggregate === "instant") {
+            return instantRegisterId;
+        }
+        const prefix = aggregatePrefixes[aggregate];
+        return <RegisterId>(
+            (prefix +
+                instantRegisterId[0].toUpperCase() +
+                instantRegisterId.substr(1))
+        );
+    }
+}
+
+export function isPrefix(registerId: RegisterId, prefix: string) {
+    return (
+        registerId.startsWith(prefix) && isUppercase(registerId[prefix.length])
+    );
+}
+
+function isUppercase(input: string) {
+    return input.toUpperCase() === input;
+}
+
+export const RegisterConvention = new Convention();

package/src/register-definition.ts

@@ -1,14 +1,23 @@
-import { UnitId } from ".";
-import { AggregateId } from "./aggregate-id";
-import { RegisterId } from "./register-id";
-
-export interface RegisterDefinition {
-    /// The id of the register
-    id: RegisterId;
-    /// The aggregate of the register
-    aggregate: AggregateId;
-    /// The possible register units
-    units: ReadonlyArray<UnitId>;
-    /// Whether the register can only be resolved by "present value".
-    immediate?: true;
-}
+import { AggregateId } from "./aggregate-id";
+import { MeasureId } from "./measure-id";
+import { RegisterId } from "./register-id";
+import { UnitId } from "./unit-id";
+
+export interface RegisterDefinition {
+    /// The id of the register
+    id: RegisterId;
+    /// The register measure
+    measure: MeasureId;
+    /// The aggregate of the register
+    aggregate: AggregateId;
+    /// The possible register units
+    units: ReadonlyArray<UnitId>;
+    /// Whether the register can only be resolved by "present value".
+    immediate?: true;
+    /// An optional concise register name.
+    /// Only used for custom registers as locales exist for standard registers.
+    name?: string;
+    /// An optional register description.
+    /// Only used for custom registers as locales exist for standard registers.
+    description?: string;
+}