@invariant--labs/foundation 1.1.2

package/src/utils/date/fillMissingRangeValues.spec.ts

@@ -0,0 +1,523 @@
+import { endOf, fillMissingRangeValues, groupBy, startOf } from "./date";
+
+describe("fillMissingRangeValues", () => {
+  it("should fill missing values grouped by day", () => {
+    const unit = "day";
+    const fixture = [
+      {
+        date: new Date(2022, 0, 1, 0),
+        value: 0,
+      },
+      {
+        date: new Date(2022, 0, 1, 1),
+        value: 1,
+      },
+      {
+        date: new Date(2022, 0, 4, 0),
+        value: 2,
+      },
+      {
+        date: new Date(2022, 0, 5, 0),
+        value: 3,
+      },
+    ];
+
+    const grouped = groupBy(fixture, "date", unit);
+    const result = fillMissingRangeValues(grouped, unit);
+    const expectedResult = [
+      {
+        beginOfUnit: startOf(fixture[0].date, unit),
+        endOfUnit: endOf(fixture[0].date, unit),
+        values: [fixture[0], fixture[1]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2022, 0, 2, 0), unit),
+        endOfUnit: endOf(new Date(2022, 0, 2, 0), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2022, 0, 3, 0), unit),
+        endOfUnit: endOf(new Date(2022, 0, 3, 0), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[2].date, unit),
+        endOfUnit: endOf(fixture[2].date, unit),
+        values: [fixture[2]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[3].date, unit),
+        endOfUnit: endOf(fixture[3].date, unit),
+        values: [fixture[3]],
+        unit,
+      },
+    ];
+
+    expect(result).toEqual(expect.arrayContaining(expectedResult));
+    expect(expectedResult).toEqual(expect.arrayContaining(result));
+  });
+
+  it("should fill missing values grouped by day within a given dateRange", () => {
+    const unit = "day";
+    const dateRange = {
+      from: new Date(2021, 11, 29, 0),
+      to: new Date(2022, 0, 6, 0, 0),
+    };
+    const fixture = [
+      {
+        date: new Date(2022, 0, 1, 0),
+        value: 0,
+      },
+      {
+        date: new Date(2022, 0, 1, 1),
+        value: 1,
+      },
+      {
+        date: new Date(2022, 0, 4, 0),
+        value: 2,
+      },
+      {
+        date: new Date(2022, 0, 5, 0),
+        value: 3,
+      },
+    ];
+
+    const grouped = groupBy(fixture, "date", unit);
+    const result = fillMissingRangeValues(grouped, unit, dateRange);
+    const expectedResult = [
+      {
+        beginOfUnit: startOf(new Date(2021, 11, 29, 0), unit),
+        endOfUnit: endOf(new Date(2021, 11, 29, 0), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2021, 11, 30, 0), unit),
+        endOfUnit: endOf(new Date(2021, 11, 30, 0), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2021, 11, 31, 0), unit),
+        endOfUnit: endOf(new Date(2021, 11, 31, 0), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[0].date, unit),
+        endOfUnit: endOf(fixture[0].date, unit),
+        values: [fixture[0], fixture[1]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2022, 0, 2, 0), unit),
+        endOfUnit: endOf(new Date(2022, 0, 2, 0), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2022, 0, 3, 0), unit),
+        endOfUnit: endOf(new Date(2022, 0, 3, 0), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[2].date, unit),
+        endOfUnit: endOf(fixture[2].date, unit),
+        values: [fixture[2]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[3].date, unit),
+        endOfUnit: endOf(fixture[3].date, unit),
+        values: [fixture[3]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2022, 0, 6, 0), unit),
+        endOfUnit: endOf(new Date(2022, 0, 6, 0), unit),
+        values: [],
+        unit,
+      },
+    ];
+
+    expect(result).toEqual(expect.arrayContaining(expectedResult));
+    expect(expectedResult).toEqual(expect.arrayContaining(result));
+  });
+
+  it("should fill missing values grouped by month", () => {
+    const unit = "month";
+    const fixture = [
+      {
+        date: new Date(2022, 0, 1),
+        value: 0,
+      },
+      {
+        date: new Date(2022, 0, 2),
+        value: 1,
+      },
+      {
+        date: new Date(2022, 2, 1),
+        value: 2,
+      },
+      {
+        date: new Date(2022, 3, 1),
+        value: 3,
+      },
+    ];
+
+    const grouped = groupBy(fixture, "date", unit);
+    const result = fillMissingRangeValues(grouped, unit);
+    const expectedResult = [
+      {
+        beginOfUnit: startOf(fixture[0].date, unit),
+        endOfUnit: endOf(fixture[0].date, unit),
+        values: [fixture[0], fixture[1]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2022, 1, 1), unit),
+        endOfUnit: endOf(new Date(2022, 1, 1), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[2].date, unit),
+        endOfUnit: endOf(fixture[2].date, unit),
+        values: [fixture[2]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[3].date, unit),
+        endOfUnit: endOf(fixture[3].date, unit),
+        values: [fixture[3]],
+        unit,
+      },
+    ];
+
+    expect(result).toEqual(expect.arrayContaining(expectedResult));
+    expect(expectedResult).toEqual(expect.arrayContaining(result));
+  });
+
+  it("should fill missing values grouped by month within a given dateRange", () => {
+    const unit = "month";
+    const dateRange = {
+      from: new Date(2021, 11, 1),
+      to: new Date(2022, 4, 1),
+    };
+    const fixture = [
+      {
+        date: new Date(2022, 0, 1),
+        value: 0,
+      },
+      {
+        date: new Date(2022, 0, 1),
+        value: 1,
+      },
+      {
+        date: new Date(2022, 2, 1),
+        value: 2,
+      },
+      {
+        date: new Date(2022, 3, 1),
+        value: 3,
+      },
+    ];
+
+    const grouped = groupBy(fixture, "date", unit);
+    const result = fillMissingRangeValues(grouped, unit, dateRange);
+    const expectedResult = [
+      {
+        beginOfUnit: startOf(new Date(2021, 11, 1), unit),
+        endOfUnit: endOf(new Date(2021, 11, 1), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[0].date, unit),
+        endOfUnit: endOf(fixture[0].date, unit),
+        values: [fixture[0], fixture[1]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2022, 1, 1), unit),
+        endOfUnit: endOf(new Date(2022, 1, 1), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[2].date, unit),
+        endOfUnit: endOf(fixture[2].date, unit),
+        values: [fixture[2]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[3].date, unit),
+        endOfUnit: endOf(fixture[3].date, unit),
+        values: [fixture[3]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2022, 4, 1), unit),
+        endOfUnit: endOf(new Date(2022, 4, 1), unit),
+        values: [],
+        unit,
+      },
+    ];
+
+    expect(result).toEqual(expect.arrayContaining(expectedResult));
+    expect(expectedResult).toEqual(expect.arrayContaining(result));
+  });
+
+  it("should fill missing values grouped by year", () => {
+    const unit = "year";
+    const fixture = [
+      {
+        date: new Date(2022, 0, 1),
+        value: 0,
+      },
+      {
+        date: new Date(2022, 0, 2),
+        value: 1,
+      },
+      {
+        date: new Date(2024, 0, 1),
+        value: 2,
+      },
+      {
+        date: new Date(2025, 0, 1),
+        value: 3,
+      },
+    ];
+
+    const grouped = groupBy(fixture, "date", unit);
+    const result = fillMissingRangeValues(grouped, unit);
+    const expectedResult = [
+      {
+        beginOfUnit: startOf(fixture[0].date, unit),
+        endOfUnit: endOf(fixture[0].date, unit),
+        values: [fixture[0], fixture[1]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2023, 0, 1), unit),
+        endOfUnit: endOf(new Date(2023, 0, 1), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[2].date, unit),
+        endOfUnit: endOf(fixture[2].date, unit),
+        values: [fixture[2]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[3].date, unit),
+        endOfUnit: endOf(fixture[3].date, unit),
+        values: [fixture[3]],
+        unit,
+      },
+    ];
+
+    expect(result).toEqual(expect.arrayContaining(expectedResult));
+    expect(expectedResult).toEqual(expect.arrayContaining(result));
+  });
+
+  it("should fill missing values grouped by year within a given dateRange", () => {
+    const unit = "year";
+    const dateRange = {
+      from: new Date(2021, 0, 1),
+      to: new Date(2026, 0, 1),
+    };
+    const fixture = [
+      {
+        date: new Date(2022, 0, 1),
+        value: 0,
+      },
+      {
+        date: new Date(2022, 0, 2),
+        value: 1,
+      },
+      {
+        date: new Date(2024, 0, 1),
+        value: 2,
+      },
+      {
+        date: new Date(2025, 0, 1),
+        value: 3,
+      },
+    ];
+
+    const grouped = groupBy(fixture, "date", unit);
+    const result = fillMissingRangeValues(grouped, unit, dateRange);
+    const expectedResult = [
+      {
+        beginOfUnit: startOf(new Date(2021, 0, 1), unit),
+        endOfUnit: endOf(new Date(2021, 0, 1), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[0].date, unit),
+        endOfUnit: endOf(fixture[0].date, unit),
+        values: [fixture[0], fixture[1]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2023, 0, 1), unit),
+        endOfUnit: endOf(new Date(2023, 0, 1), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[2].date, unit),
+        endOfUnit: endOf(fixture[2].date, unit),
+        values: [fixture[2]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[3].date, unit),
+        endOfUnit: endOf(fixture[3].date, unit),
+        values: [fixture[3]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2026, 0, 1), unit),
+        endOfUnit: endOf(new Date(2026, 0, 1), unit),
+        values: [],
+        unit,
+      },
+    ];
+
+    expect(result).toEqual(expect.arrayContaining(expectedResult));
+    expect(expectedResult).toEqual(expect.arrayContaining(result));
+  });
+
+  it("should fill missing values grouped by quarter", () => {
+    const unit = "quarter";
+    const fixture = [
+      {
+        date: new Date(2022, 0, 1),
+        value: 0,
+      },
+      {
+        date: new Date(2022, 1, 1),
+        value: 1,
+      },
+      {
+        date: new Date(2022, 7, 1),
+        value: 2,
+      },
+      {
+        date: new Date(2022, 10, 1),
+        value: 3,
+      },
+    ];
+
+    const grouped = groupBy(fixture, "date", unit);
+    const result = fillMissingRangeValues(grouped, unit);
+    const expectedResult = [
+      {
+        beginOfUnit: startOf(fixture[0].date, unit),
+        endOfUnit: endOf(fixture[0].date, unit),
+        values: [fixture[0], fixture[1]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2022, 3, 1), unit),
+        endOfUnit: endOf(new Date(2022, 3, 1), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[2].date, unit),
+        endOfUnit: endOf(fixture[2].date, unit),
+        values: [fixture[2]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[3].date, unit),
+        endOfUnit: endOf(fixture[3].date, unit),
+        values: [fixture[3]],
+        unit,
+      },
+    ];
+
+    expect(result).toEqual(expect.arrayContaining(expectedResult));
+    expect(expectedResult).toEqual(expect.arrayContaining(result));
+  });
+
+  it("should fill missing values grouped by year within a given dateRange", () => {
+    const unit = "quarter";
+    const dateRange = {
+      from: new Date(2021, 10, 1),
+      to: new Date(2023, 2, 1),
+    };
+    const fixture = [
+      {
+        date: new Date(2022, 0, 1),
+        value: 0,
+      },
+      {
+        date: new Date(2022, 1, 1),
+        value: 1,
+      },
+      {
+        date: new Date(2022, 7, 1),
+        value: 2,
+      },
+      {
+        date: new Date(2022, 10, 1),
+        value: 3,
+      },
+    ];
+
+    const grouped = groupBy(fixture, "date", unit);
+    const result = fillMissingRangeValues(grouped, unit, dateRange);
+    const expectedResult = [
+      {
+        beginOfUnit: startOf(new Date(2021, 9, 1), unit),
+        endOfUnit: endOf(new Date(2021, 9, 1), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[0].date, unit),
+        endOfUnit: endOf(fixture[0].date, unit),
+        values: [fixture[0], fixture[1]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2022, 3, 1), unit),
+        endOfUnit: endOf(new Date(2022, 3, 1), unit),
+        values: [],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[2].date, unit),
+        endOfUnit: endOf(fixture[2].date, unit),
+        values: [fixture[2]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[3].date, unit),
+        endOfUnit: endOf(fixture[3].date, unit),
+        values: [fixture[3]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(new Date(2023, 0, 1), unit),
+        endOfUnit: endOf(new Date(2023, 0, 1), unit),
+        values: [],
+        unit,
+      },
+    ];
+
+    expect(result).toEqual(expect.arrayContaining(expectedResult));
+    expect(expectedResult).toEqual(expect.arrayContaining(result));
+  });
+});

package/src/utils/date/groubBy.spec.ts

@@ -0,0 +1,183 @@
+import { endOf, groupBy, startOf } from "./date";
+
+describe("groupBy", () => {
+  it("should grouped by day", () => {
+    const unit = "day";
+    const fixture = [
+      {
+        date: new Date(2022, 0, 1, 0),
+        value: 0,
+      },
+      {
+        date: new Date(2022, 0, 1, 1),
+        value: 1,
+      },
+      {
+        date: new Date(2022, 0, 2, 0),
+        value: 2,
+      },
+      {
+        date: new Date(2022, 0, 3, 0),
+        value: 3,
+      },
+    ];
+
+    const result = groupBy(fixture, "date", unit);
+
+    expect(result).toEqual([
+      {
+        beginOfUnit: startOf(fixture[0].date, unit),
+        endOfUnit: endOf(fixture[0].date, unit),
+        values: [fixture[0], fixture[1]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[2].date, unit),
+        endOfUnit: endOf(fixture[2].date, unit),
+        values: [fixture[2]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[3].date, unit),
+        endOfUnit: endOf(fixture[3].date, unit),
+        values: [fixture[3]],
+        unit,
+      },
+    ]);
+  });
+
+  it("should grouped by month", () => {
+    const unit = "month";
+    const fixture = [
+      {
+        date: new Date(2022, 0, 1),
+        value: 0,
+      },
+      {
+        date: new Date(2022, 0, 2),
+        value: 1,
+      },
+      {
+        date: new Date(2022, 1, 1),
+        value: 2,
+      },
+      {
+        date: new Date(2022, 2, 1),
+        value: 3,
+      },
+    ];
+
+    const result = groupBy(fixture, "date", unit);
+
+    expect(result).toEqual([
+      {
+        beginOfUnit: startOf(fixture[0].date, unit),
+        endOfUnit: endOf(fixture[0].date, unit),
+        values: [fixture[0], fixture[1]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[2].date, unit),
+        endOfUnit: endOf(fixture[2].date, unit),
+        values: [fixture[2]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[3].date, unit),
+        endOfUnit: endOf(fixture[3].date, unit),
+        values: [fixture[3]],
+        unit,
+      },
+    ]);
+  });
+
+  it("should grouped by year", () => {
+    const unit = "year";
+    const fixture = [
+      {
+        date: new Date(2021, 0, 1),
+        value: 0,
+      },
+      {
+        date: new Date(2021, 1, 1),
+        value: 1,
+      },
+      {
+        date: new Date(2022, 1, 1),
+        value: 2,
+      },
+      {
+        date: new Date(2023, 2, 1),
+        value: 3,
+      },
+    ];
+
+    const result = groupBy(fixture, "date", unit);
+
+    expect(result).toEqual([
+      {
+        beginOfUnit: startOf(fixture[0].date, unit),
+        endOfUnit: endOf(fixture[0].date, unit),
+        values: [fixture[0], fixture[1]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[2].date, unit),
+        endOfUnit: endOf(fixture[2].date, unit),
+        values: [fixture[2]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[3].date, unit),
+        endOfUnit: endOf(fixture[3].date, unit),
+        values: [fixture[3]],
+        unit,
+      },
+    ]);
+  });
+
+  it("should grouped by quarter", () => {
+    const unit = "quarter";
+    const fixture = [
+      {
+        date: new Date(2022, 0, 1),
+        value: 0,
+      },
+      {
+        date: new Date(2022, 1, 2),
+        value: 1,
+      },
+      {
+        date: new Date(2022, 7, 1),
+        value: 2,
+      },
+      {
+        date: new Date(2022, 10, 1),
+        value: 3,
+      },
+    ];
+
+    const result = groupBy(fixture, "date", unit);
+
+    expect(result).toEqual([
+      {
+        beginOfUnit: startOf(fixture[0].date, unit),
+        endOfUnit: endOf(fixture[0].date, unit),
+        values: [fixture[0], fixture[1]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[2].date, unit),
+        endOfUnit: endOf(fixture[2].date, unit),
+        values: [fixture[2]],
+        unit,
+      },
+      {
+        beginOfUnit: startOf(fixture[3].date, unit),
+        endOfUnit: endOf(fixture[3].date, unit),
+        values: [fixture[3]],
+        unit,
+      },
+    ]);
+  });
+});

package/src/utils/date/index.ts

@@ -0,0 +1,2 @@
+export * from "./date";
+export * from "./date-range";