@utiliread/primitives 1.0.0-10 → 1.0.0-100

package/locales/en/units.json

@@ -0,0 +1,324 @@
+{
+  "unitless": {
+    "symbol": ""
+  },
+  "milliWattHour": {
+    "symbol": "mWh"
+  },
+  "wattHour": {
+    "symbol": "Wh"
+  },
+  "kiloWattHour": {
+    "symbol": "kWh"
+  },
+  "megaWattHour": {
+    "symbol": "MWh"
+  },
+  "gigaWattHour": {
+    "symbol": "GWh"
+  },
+  "calorie": {
+    "symbol": "cal"
+  },
+  "kiloCalorie": {
+    "symbol": "kcal"
+  },
+  "megaCalorie": {
+    "symbol": "Mcal"
+  },
+  "joule": {
+    "symbol": "J"
+  },
+  "kiloJoule": {
+    "symbol": "kJ"
+  },
+  "megaJoule": {
+    "symbol": "MJ"
+  },
+  "gigaJoule": {
+    "symbol": "GJ"
+  },
+  "liter": {
+    "symbol": "L"
+  },
+  "cubicMeter": {
+    "symbol": "m\u00B3"
+  },
+  "fluidOunce": {
+    "symbol": "fl oz"
+  },
+  "gallon": {
+    "symbol": "gal"
+  },
+  "gram": {
+    "symbol": "g"
+  },
+  "kiloGram": {
+    "symbol": "kg"
+  },
+  "tonne": {
+    "symbol": "T"
+  },
+  "ounce": {
+    "symbol": "oz"
+  },
+  "pound": {
+    "symbol": "lbs"
+  },
+  "ton": {
+    "symbol": "T"
+  },
+  "second": {
+    "name": "Second",
+    "symbol": "s"
+  },
+  "minute": {
+    "name": "Minute",
+    "symbol": "m"
+  },
+  "hour": {
+    "name": "Hour",
+    "symbol": "h"
+  },
+  "day": {
+    "name": "Day",
+    "symbol": "d"
+  },
+  "week": {
+    "name": "Week",
+    "symbol": "w"
+  },
+  "month": {
+    "name": "Month",
+    "symbol": "m"
+  },
+  "year": {
+    "name": "Year",
+    "symbol": "year"
+  },
+  "milliWatt": {
+    "symbol": "mW"
+  },
+  "milliWatt2": {
+    "symbol": "mW\u00B2"
+  },
+  "watt": {
+    "symbol": "W"
+  },
+  "watt2": {
+    "symbol": "W\u00B2"
+  },
+  "kiloWatt": {
+    "symbol": "kW"
+  },
+  "kiloWatt2": {
+    "symbol": "kW\u00B2"
+  },
+  "megaWatt": {
+    "symbol": "MW"
+  },
+  "megaWatt2": {
+    "symbol": "MW\u00B2"
+  },
+  "gigaWatt": {
+    "symbol": "GW"
+  },
+  "gigaWatt2": {
+    "symbol": "GW\u00B2"
+  },
+  "joulesPerSecond": {
+    "symbol": "J/s"
+  },
+  "joulesPerSecond2": {
+    "symbol": "J/s\u00B2"
+  },
+  "joulesPerMinute": {
+    "symbol": "J/m"
+  },
+  "joulesPerMinute2": {
+    "symbol": "J/m\u00B2"
+  },
+  "joulesPerHour": {
+    "symbol": "J/h"
+  },
+  "joulesPerHour2": {
+    "symbol": "J/h\u00B2"
+  },
+  "litersPerSecond": {
+    "symbol": "L/s"
+  },
+  "litersPerSecond2": {
+    "symbol": "L/s\u00B2"
+  },
+  "litersPerMinute": {
+    "symbol": "L/m"
+  },
+  "litersPerMinute2": {
+    "symbol": "L/m\u00B2"
+  },
+  "litersPerHour": {
+    "symbol": "L/h"
+  },
+  "litersPerHour2": {
+    "symbol": "L/h\u00B2"
+  },
+  "cubicMetersPerSecond": {
+    "symbol": "m\u00B3/s"
+  },
+  "cubicMetersPerSecond2": {
+    "symbol": "m\u00B3/s\u00B2"
+  },
+  "cubicMetersPerMinute": {
+    "symbol": "m\u00B3/m"
+  },
+  "cubicMetersPerMinute2": {
+    "symbol": "m\u00B3/m\u00B2"
+  },
+  "cubicMetersPerHour": {
+    "symbol": "m\u00B3/h"
+  },
+  "cubicMetersPerHour2": {
+    "symbol": "m\u00B3/h\u00B2"
+  },
+  "fluidOuncesPerSecond": {
+    "symbol": "fl oz/s"
+  },
+  "fluidOuncesPerSecond2": {
+    "symbol": "fl oz/s\u00B2"
+  },
+  "fluidOuncesPerMinute": {
+    "symbol": "fl oz/m"
+  },
+  "fluidOuncesPerMinute2": {
+    "symbol": "fl oz/m\u00B2"
+  },
+  "fluidOuncesPerHour": {
+    "symbol": "fl oz/h"
+  },
+  "fluidOuncesPerHour2": {
+    "symbol": "fl oz/h\u00B2"
+  },
+  "gallonsPerSecond": {
+    "symbol": "gal/s"
+  },
+  "gallonsPerSecond2": {
+    "symbol": "gal/s\u00B2"
+  },
+  "gallonsPerMinute": {
+    "symbol": "gal/m"
+  },
+  "gallonsPerMinute2": {
+    "symbol": "gal/m\u00B2"
+  },
+  "gallonsPerHour": {
+    "symbol": "gal/h"
+  },
+  "gallonsPerHour2": {
+    "symbol": "gal/h\u00B2"
+  },
+  "gramsPerSecond": {
+    "symbol": "g/s"
+  },
+  "gramsPerSecond2": {
+    "symbol": "g/s\u00B2"
+  },
+  "gramsPerMinute": {
+    "symbol": "g/m"
+  },
+  "gramsPerMinute2": {
+    "symbol": "g/m\u00B2"
+  },
+  "gramsPerHour": {
+    "symbol": "g/h"
+  },
+  "gramsPerHour2": {
+    "symbol": "g/h\u00B2"
+  },
+  "kiloGramsPerSecond": {
+    "symbol": "kg/s"
+  },
+  "kiloGramsPerSecond2": {
+    "symbol": "kg/s\u00B2"
+  },
+  "kiloGramsPerMinute": {
+    "symbol": "kg/m"
+  },
+  "kiloGramsPerMinute2": {
+    "symbol": "kg/m\u00B2"
+  },
+  "kiloGramsPerHour": {
+    "symbol": "kg/h"
+  },
+  "kiloGramsPerHour2": {
+    "symbol": "kg/h\u00B2"
+  },
+  "celcius": {
+    "symbol": "\u00B0C"
+  },
+  "celcius2": {
+    "symbol": "\u00B0C\u00B2"
+  },
+  "kelvin": {
+    "symbol": "K"
+  },
+  "kelvin2": {
+    "symbol": "K\u00B2"
+  },
+  "fahrenheit": {
+    "symbol": "F"
+  },
+  "fahrenheit2": {
+    "symbol": "F\u00B2"
+  },
+  "bar": {
+    "symbol": "bar"
+  },
+  "bar2": {
+    "symbol": "bar\u00B2"
+  },
+  "pascal": {
+    "symbol": "Pa"
+  },
+  "pascal2": {
+    "symbol": "Pa\u00B2"
+  },
+  "kiloPascal": {
+    "symbol": "kPa"
+  },
+  "kiloPascal2": {
+    "symbol": "kPa\u00B2"
+  },
+  "decibel": {
+    "symbol": "dB"
+  },
+  "var": {
+    "symbol": "var"
+  },
+  "kiloVar": {
+    "symbol": "kvar"
+  },
+  "megaVar": {
+    "symbol": "Mvar"
+  },
+  "varHour": {
+    "symbol": "varh"
+  },
+  "kiloVarHour": {
+    "symbol": "kvarh"
+  },
+  "megaVarHour": {
+    "symbol": "Mvarh"
+  },
+  "percentage": {
+    "symbol": "%"
+  },
+  "literCelcius": {
+    "symbol": "l\u00B7\u2103"
+  },
+  "cubicMeterCelcius": {
+    "symbol": "m\u00B3\u00B7\u2103"
+  },
+  "json": {
+    "symbol": "json"
+  }
+}

package/package.json

@@ -1,29 +1,45 @@
 {
   "name": "@utiliread/primitives",
-  "version": "1.0.0-10",
+  "version": "1.0.0-100",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
+  "sideEffects": false,
   "scripts": {
     "build": "tsc && tsc -p tsconfig.cjs.json",
-    "test": "karma start --single-run --browsers ChromeHeadless karma.config.js",
-    "watch": "karma start --auto-watch --browsers ChromeDebugging karma.config.js",
+    "prettier": "prettier --write src/**/*.ts locales/**/*.json",
+    "test": "web-test-runner",
     "clean": "rimraf dist"
   },
   "publishConfig": {
     "access": "public"
   },
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./registers": {
+      "import": "./dist/esm/registers/index.js",
+      "require": "./dist/cjs/registers/index.js"
+    },
+    "./locales/*": "./locales/*",
+    "./*.d.ts": "./dist/esm/*.d.ts"
+  },
   "devDependencies": {
-    "@types/chai": "^4.2.16",
-    "@types/mocha": "^8.2.2",
-    "chai": "^4.3.4",
-    "karma": "^6.3.2",
-    "karma-chai": "^0.1.0",
-    "karma-chrome-launcher": "^3.1.0",
-    "karma-mocha": "^2.0.1",
-    "karma-typescript": "^5.5.1",
-    "mocha": "^8.3.2",
-    "rimraf": "^3.0.2",
-    "typescript": "^4.1.5"
+    "@types/chai": "^4.3.11",
+    "@types/luxon": "^3.0.1",
+    "@types/mocha": "^10.0.0",
+    "@web/dev-server-esbuild": "^1.0.1",
+    "@web/test-runner": "^0.18.0",
+    "chai": "^5.0.0",
+    "luxon": "^3.0.4",
+    "mocha": "^10.0.0",
+    "prettier": "^3.1.0",
+    "rimraf": "^5.0.1",
+    "typescript": "^5.1.6"
+  },
+  "peerDependencies": {
+    "luxon": "^2.1.0 || ^3.0.0"
   }
 }

package/src/aggregate-id.ts

@@ -1,9 +1,9 @@
-export type AggregateId =
-    "instant" |
-    "diff" |
-    "min" |
-    "max" |
-    "avg" |
-    "sum" |
-    "cnt" |
-    "ssq";
+export type AggregateId =
+    | "instant"
+    | "diff"
+    | "min"
+    | "max"
+    | "avg"
+    | "sum"
+    | "cnt"
+    | "ssq";

package/src/breakdown-rule.spec.ts

@@ -0,0 +1,63 @@
+import { BreakdownRule } from "./breakdown-rule";
+import { DateTime } from "luxon";
+import { TimeOrRule } from ".";
+import { expect } from "chai";
+
+describe("ctor", () => {
+    it("creates", () => {
+        expect(
+            BreakdownRule({ origin: "", count: 1, period: "hour" }),
+        ).to.equal("/1hour");
+        expect(
+            BreakdownRule({ origin: "", count: 2, period: "hour" }),
+        ).to.equal("/2hours");
+        expect(
+            BreakdownRule({ origin: "day", count: 1, period: "hour" }),
+        ).to.equal("day/1hour");
+        expect(
+            BreakdownRule({ origin: "day", count: 2, period: "hour" }),
+        ).to.equal("day/2hours");
+
+        expect(BreakdownRule("", 1, "hour")).to.equal("/1hour");
+        expect(BreakdownRule("", 2, "hour")).to.equal("/2hours");
+        expect(BreakdownRule("day", 1, "hour")).to.equal("day/1hour");
+        expect(BreakdownRule("day", 2, "hour")).to.equal("day/2hours");
+    });
+});
+
+describe("split", () => {
+    it("splits without origin", () => {
+        const { origin, count, period } = BreakdownRule.split("/1hour");
+        expect(origin).to.equal("");
+        expect(count).to.equal(1);
+        expect(period).to.equal("hour");
+    });
+
+    it("splits with simple origin", () => {
+        const { origin, count, period } = BreakdownRule.split("day/1hour");
+        expect(origin).to.equal("day");
+        expect(count).to.equal(1);
+        expect(period).to.equal("hour");
+    });
+
+    it("splits with complex origin and plural count", () => {
+        const { origin, count, period } = BreakdownRule.split(
+            "day+PT1H_year^month/10hours",
+        );
+        expect(origin).to.equal("day+PT1H_year^month");
+        expect(count).to.equal(10);
+        expect(period).to.equal("hour");
+    });
+
+    it("splits with time origin", () => {
+        const { origin, count, period } = BreakdownRule.split(
+            "2024-01-25T00:00:00.000+01:00/1hour",
+        );
+        expect(TimeOrRule.isTime(origin)).to.equal(true);
+        expect(+origin).to.equal(
+            +DateTime.local(2024, 1, 25),
+        );
+        expect(count).to.equal(1);
+        expect(period).to.equal("hour");
+    });
+});

package/src/breakdown-rule.ts

@@ -0,0 +1,60 @@
+import { TimeOrRule } from "./time-or-rule";
+
+export type BreakdownRule = string;
+export type BreakdownPeriod = "hour" | "day" | "week" | "month" | "year";
+
+interface BreakdownRuleInit {
+    origin: TimeOrRule;
+    count: number;
+    period: BreakdownPeriod;
+}
+
+export function BreakdownRule(init: BreakdownRuleInit): BreakdownRule;
+export function BreakdownRule(
+    origin: TimeOrRule,
+    count: number,
+    period: BreakdownPeriod,
+): BreakdownRule;
+export function BreakdownRule(...params: any[]): BreakdownRule {
+    let init: BreakdownRuleInit;
+    switch (params.length) {
+        case 1:
+            init = params[0];
+            break;
+        case 3:
+            init = {
+                origin: params[0],
+                count: params[1],
+                period: params[2],
+            };
+            break;
+        default:
+            throw new TypeError("Invalid breakdown rule format");
+    }
+    const periodName =
+        Math.abs(init.count) == 1 ? init.period : (init.period + "s");
+    return `${init.origin}/${init.count}${periodName}`;
+}
+
+export namespace BreakdownRule {
+    const regex = new RegExp(
+        "(.*)/([-+]?[0-9]+)(hour|day|week|month|year)s?",
+    );
+    export function split(rule: BreakdownRule) {
+        const match = regex.exec(rule);
+        if (!match) {
+            throw new Error("Invalid breakdown rule format");
+        }
+        const origin = match[1];
+        const count = parseInt(match[2]);
+        let period = match[3];
+        if (period.endsWith("s")) {
+            period = period.substring(0, period.length - 1);
+        }
+        return {
+            origin: TimeOrRule.parse(origin),
+            count,
+            period: period as BreakdownPeriod,
+        };
+    }
+}

package/src/index.ts

@@ -1,19 +1,48 @@
-import { ConsumptionTypeId } from "./consumption-type-id";
-import { RegisterId } from "./register-id";
-import { UnitId } from "./unit-id";
-import { RegisterLibrary } from "./register-library";
-import { RegisterDefinition } from "./register-definition";
-import { RegisterConverter } from "./register-converter";
-import { NumberFormatter } from "./number-formatter";
-import { RegisterConvention } from "./register-convention";
-
-export {
-    ConsumptionTypeId,
-    RegisterId,
-    RegisterDefinition,
-    UnitId,
-    RegisterLibrary,
-    RegisterConvention,
-    RegisterConverter,
-    NumberFormatter,
-};
+import "./repository"; // We need this to get the Repository namespace exported
+
+import * as registers from "./registers";
+
+import { DayOfWeek, Step } from "./step";
+import {
+    NumberFormatter,
+    invariantDecimalSeparator,
+    localeDecimalSeparator,
+} from "./number-formatter";
+
+import type { AggregateId } from "./aggregate-id";
+import type { BreakdownPeriod } from "./breakdown-rule";
+import { BreakdownRule } from "./breakdown-rule";
+import type { MeasureId } from "./measure-id";
+import type { Medium } from "./medium";
+import type { Optional } from "./optional";
+import { PrecisionNumber } from "./precision-number";
+import { RegisterConvention } from "./register-convention";
+import type { RegisterDefinition } from "./register-definition";
+import type { RegisterId } from "./register-id";
+import { RegisterLibrary } from "./register-library";
+import { Repository } from "./repository";
+import { TimeOrRule } from "./time-or-rule";
+import type { UnitId } from "./unit-id";
+
+export {
+    AggregateId,
+    BreakdownPeriod,
+    BreakdownRule,
+    DayOfWeek,
+    invariantDecimalSeparator,
+    localeDecimalSeparator,
+    MeasureId,
+    Medium,
+    NumberFormatter,
+    Optional,
+    PrecisionNumber,
+    RegisterConvention,
+    RegisterDefinition,
+    RegisterId,
+    RegisterLibrary,
+    registers,
+    Repository,
+    Step,
+    TimeOrRule,
+    UnitId,
+};

package/src/measure-id.ts

@@ -0,0 +1,17 @@
+export type MeasureId =
+    | "none"
+    | "duration"
+    | "energy"
+    | "humidity"
+    | "mass"
+    | "massFlow"
+    | "noise"
+    | "power"
+    | "pressure"
+    | "reactiveEnergy"
+    | "reactivePower"
+    | "temperature"
+    | "time"
+    | "volume"
+    | "volumeFlow"
+    | "infocode";

package/src/measures/duration.ts

@@ -0,0 +1,11 @@
+import { UnitId } from "../unit-id";
+
+export const units: ReadonlyArray<UnitId> = [
+    "second",
+    "minute",
+    "hour",
+    "day",
+    "week",
+    "month",
+    "year",
+];

package/src/measures/energy.ts

@@ -0,0 +1,12 @@
+import { UnitId } from "../unit-id";
+
+export const units: ReadonlyArray<UnitId> = [
+    "milliWattHour",
+    "wattHour",
+    "kiloWattHour",
+    "megaWattHour",
+    "gigaWattHour",
+    "calorie",
+    "kiloCalorie",
+    "megaCalorie",
+];

package/src/measures/humidity.ts

@@ -0,0 +1,3 @@
+import { UnitId } from "../unit-id";
+
+export const units: ReadonlyArray<UnitId> = [];

package/src/measures/infocode.ts

@@ -0,0 +1,3 @@
+import { UnitId } from "../unit-id";
+
+export const units: ReadonlyArray<UnitId> = ["unitless", "json"];

package/src/measures/mass-flow.ts

@@ -0,0 +1,19 @@
+import { UnitId } from "../unit-id";
+
+export const units: ReadonlyArray<UnitId> = [
+    "gramsPerSecond",
+    "gramsPerMinute",
+    "gramsPerHour",
+    "kiloGramsPerSecond",
+    "kiloGramsPerMinute",
+    "kiloGramsPerHour",
+];
+
+export const sqUnits: ReadonlyArray<UnitId> = [
+    "gramsPerSecond2",
+    "gramsPerMinute2",
+    "gramsPerHour2",
+    "kiloGramsPerSecond2",
+    "kiloGramsPerMinute2",
+    "kiloGramsPerHour2",
+];

package/src/measures/mass.ts

@@ -0,0 +1,10 @@
+import { UnitId } from "../unit-id";
+
+export const units: ReadonlyArray<UnitId> = [
+    "gram",
+    "kiloGram",
+    "tonne",
+    "ounce",
+    "pound",
+    "ton",
+];

package/src/measures/noise.ts

@@ -0,0 +1,5 @@
+import { UnitId } from "../unit-id";
+
+export const units: ReadonlyArray<UnitId> = ["decibel"];
+
+export const sqUnits: ReadonlyArray<UnitId> = ["decibel2"];