@utiliread/primitives 1.0.0-94 → 1.0.0-96

package/dist/esm/step.spec.js

@@ -1,6 +1,6 @@
 import { DayOfWeek, Step } from "./step";
 import { DateTime } from "luxon";
-import { expect } from "@esm-bundle/chai";
+import { expect } from "chai";
 describe("startOf", () => {
     it("returns start of day", () => {
         const dt = DateTime.fromISO("2020-01-11T05:00:00+01:00");

package/dist/esm/step.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"step.spec.js","sourceRoot":"","sources":["../../src/step.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEzC,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACrB,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC5B,MAAM,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QACvC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CACpB,CAAC,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CACjD,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC7C,MAAM,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CACpB,CAAC,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CACjD,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACjD,MAAM,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CACpB,CAAC,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CACjD,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACzC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
+{"version":3,"file":"step.spec.js","sourceRoot":"","sources":["../../src/step.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEzC,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACrB,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC5B,MAAM,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QACvC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CACpB,CAAC,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CACjD,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC7C,MAAM,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CACpB,CAAC,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CACjD,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACjD,MAAM,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CACpB,CAAC,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CACjD,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACzC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@utiliread/primitives",
-  "version": "1.0.0-94",
+  "version": "1.0.0-96",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
@@ -27,11 +27,12 @@
     "./*.d.ts": "./dist/esm/*.d.ts"
   },
   "devDependencies": {
-    "@esm-bundle/chai": "^4.3.4-fix.0",
+    "@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",

package/src/breakdown-rule.spec.ts

@@ -0,0 +1,44 @@
+import { BreakdownRule } from "./breakdown-rule";
+import { expect } from "chai";
+
+describe("ctor", () => {
+    it("creates", () => {
+        expect(BreakdownRule({ count: 1, period: "hour"})).to.equal("1hour");
+        expect(BreakdownRule({ count: 2, period: "hour"})).to.equal("2hours");
+        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("", 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");
+    });
+});

package/src/breakdown-rule.ts

@@ -0,0 +1,75 @@
+import { Step } from "./step";
+import { TimeOrRule } from "./time-or-rule";
+
+export type BreakdownRule = string;
+export type BreakdownPeriod = Step;
+
+interface BreakdownRuleInit {
+    origin?: TimeOrRule;
+    count: number;
+    period: BreakdownPeriod;
+}
+
+export function BreakdownRule(init: BreakdownRuleInit): BreakdownRule;
+export function BreakdownRule(
+    count: number,
+    period: BreakdownPeriod,
+): 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 2:
+            init = {
+                origin: "",
+                count: params[0],
+                period: params[1],
+            };
+            break;
+        case 3:
+            init = {
+                origin: params[0],
+                count: params[1],
+                period: params[2],
+            };
+            break;
+        default:
+            throw new TypeError("Invalid breakdown rule format");
+    }
+    const origin = init.origin ?? "";
+    const periodName =
+        Math.abs(init.count) == 1 ? init.period : (init.period + "s");
+    return TimeOrRule.isRule(origin) && origin === ""
+        ? `${init.count}${periodName}`
+        : `${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[2] ?? "";
+        const count = parseInt(match[3]);
+        let period = match[4];
+        if (period.endsWith("s")) {
+            period = period.substring(0, period.length - 1);
+        }
+        return {
+            origin: origin as TimeOrRule,
+            count,
+            period: period as BreakdownPeriod,
+        };
+    }
+}

package/src/index.ts

@@ -1,6 +1,6 @@
 import "./repository"; // We need this to get the Repository namespace exported
 
-import * as registers from "./registers"
+import * as registers from "./registers";
 
 import { DayOfWeek, Step } from "./step";
 import {
@@ -10,6 +10,8 @@ import {
 } 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";
@@ -24,21 +26,23 @@ import type { UnitId } from "./unit-id";
 
 export {
     AggregateId,
-    Medium,
+    BreakdownPeriod,
+    BreakdownRule,
     DayOfWeek,
+    invariantDecimalSeparator,
+    localeDecimalSeparator,
     MeasureId,
+    Medium,
     NumberFormatter,
+    Optional,
     PrecisionNumber,
     RegisterConvention,
     RegisterDefinition,
     RegisterId,
     RegisterLibrary,
+    registers,
     Repository,
     Step,
     TimeOrRule,
     UnitId,
-    invariantDecimalSeparator,
-    localeDecimalSeparator,
-    Optional,
-    registers,
 };