flowerbi-dates 2.0.0

package/.prettierignore

@@ -0,0 +1,25 @@
+**/build/**
+**/coverage/**
+**/dist/**
+**/built/**
+
+*.tf
+*.sln
+*.deployproj
+*.targets
+*.gitignore
+*.png
+*.svg
+*.config
+*.ps1
+*.ico
+*.lock
+*.jsbeautifyrc
+*.xml
+*.csv
+*.tsbuildinfo
+*.eslintignore
+*.env
+*.bat
+*.prettierignore
+*.scss.d.ts

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+    "trailingComma": "es5",
+    "tabWidth": 4,
+    "semi": true,
+    "singleQuote": false,
+    "printWidth": 160
+}

package/README.md

@@ -0,0 +1,3 @@
+# FlowerBI
+
+Core data/query helpers.

package/dist/fillDates.d.ts

@@ -0,0 +1,99 @@
+import { Moment } from "moment";
+export declare type FillDate = Date | string | number | Moment;
+/**
+ * Three operations on dates used by {@link fillDates}.
+ */
+export declare type FillDateType = {
+    /** Round the given date down to the nearest whole unit (e.g. start of month, quarter, year) */
+    round(d: Moment): Moment;
+    /** Format the given date to a string */
+    format(d: Moment): string;
+    /** Increment the date by the unit. The given date will already be rounded down. */
+    increment(d: Moment): Moment;
+};
+/**
+ * Standard built-in date types. To customise, implement the {@link FillDateType} interface.
+ */
+export declare const dateTypes: {
+    readonly days: FillDateType;
+    readonly months: FillDateType;
+    readonly quarters: FillDateType;
+    readonly years: FillDateType;
+};
+/**
+ * Examines a set of dates and chooses the most specific type that includes them all. If
+ * all fall on Jan, 1 then `years` is chosen, and so on.
+ */
+export declare function detectDateType(dates: Moment[]): FillDateType;
+/** Options for {@link fillDates} function. */
+export interface FillDatesOptions<T, R> {
+    /** The records to base the filled list on. */
+    records: T[];
+    /** The operations to use for rounding, incrementing and formatting dates. */
+    type?: FillDateType;
+    /** Extracts a date value from a record in the input list. */
+    getDate(record: T): FillDate;
+    /**
+     * Generate a record for a date, from the formatted {@link dateText} and
+     * the input record for that date, if any.
+     */
+    fill(dateText: string, record: T | undefined): R;
+    /**
+     * The minimum date to generate. It will be rounded down by the {@link type}
+     * so doesn't need to be on an exact boundary.
+     */
+    min?: FillDate;
+    /**
+     * The maximum date to generate. It will be rounded down by the {@link type}
+     * so doesn't need to be on an exact boundary.
+     */
+    max?: FillDate;
+}
+/**
+ * When querying for a time series chart, e.g. x-axis is _Month_ and y-axis is
+ * _Total Sales_, there may be months where nothing was sold so they are
+ * missing from the list of records.
+ *
+ * To render a proper time-series, we need these gaps to be filled in with
+ * runs of fake records that give zero amounts for those months. e.g.
+ *
+ * ```ts
+ * const filled = fillDates({
+ *     records: [
+ *         { date: '2020-04-01', totalSales: 10 },
+ *         { date: '2020-06-01', totalSales: 4 },
+ *         { date: '2020-07-01', totalSales: 9 },
+ *     ],
+ *     type: dateTypes.months,
+ *     getDate: rec => rec.date,
+ *     fill: (label, rec) => ({
+ *         label,
+ *         totalSales: 0,
+ *         ...rec
+ *     })
+ * });
+ * ```
+ *
+ * In the above example we add a `label` property to all the records, and
+ * for the records that fill the gaps we set the `totalSales` property to 0.
+ * For the real records, `...rec` will copy the real value of `totalSales`.
+ *
+ * To do this, we need to know:
+ *
+ * - how to round a date to the start of a unit (year, month, quarter),
+ * - how to increment a date by that unit,
+ * - how to format a date to a string for display.
+ *
+ * These operations are encapsulated by the {@link FillDateType} interface.
+ * Several built-in types are provided in {@link dateTypes}, but you can
+ * implement your own.
+ *
+ * Optionally you can also pass `min` and `max` dates, which will cause
+ * extra records to be added at the start and end of the range if necessary.
+ *
+ * If you don't pass a `type`, a suitable type will be detected based on
+ * how the input record dates fall on unit boundaries.
+ */
+export declare function fillDates<T, R>({ records, getDate, fill, min, max, type }: FillDatesOptions<T, R>): R[];
+/** @deprecated */
+export declare function smartDates<T, R>(records: T[], min: FillDate | undefined, max: FillDate | undefined, getDate: (record: T) => FillDate, fill: (dateText: string, record: T | undefined) => R): R[];

package/dist/fillDates.js

@@ -0,0 +1,175 @@
+"use strict";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.smartDates = exports.fillDates = exports.detectDateType = exports.dateTypes = void 0;
+var moment_1 = __importDefault(require("moment"));
+function parseDate(val) {
+    // Ensure a numeric year is not interpreted as offset from 1970!
+    if (typeof val === "number") {
+        val = "" + val;
+    }
+    return (0, moment_1.default)(val);
+}
+var days = {
+    round: function (d) {
+        return d.clone().startOf("day");
+    },
+    format: function (d) {
+        return d.format("ll");
+    },
+    increment: function (d) {
+        return d.clone().add(1, "day");
+    }
+};
+var months = {
+    round: function (d) {
+        return d.clone().startOf("month");
+    },
+    format: function (d) {
+        return d.format("MMM YYYY");
+    },
+    increment: function (d) {
+        return d.clone().add(1, "month");
+    }
+};
+var quarters = {
+    round: function (d) {
+        return d.clone().startOf("quarter");
+    },
+    format: function (d) {
+        var monthFirst = d.format("MMM");
+        var monthLast = d.clone().add(2, "months").format("MMM");
+        var year = d.format("YYYY");
+        return "".concat(monthFirst, "-").concat(monthLast, " ").concat(year);
+    },
+    increment: function (d) {
+        return d.clone().add(3, "months");
+    }
+};
+var years = {
+    round: function (d) {
+        return d.clone().startOf("year");
+    },
+    format: function (d) {
+        return d.format("YYYY");
+    },
+    increment: function (d) {
+        return d.clone().add(1, "year");
+    }
+};
+/**
+ * Standard built-in date types. To customise, implement the {@link FillDateType} interface.
+ */
+exports.dateTypes = {
+    days: days,
+    months: months,
+    quarters: quarters,
+    years: years
+};
+/**
+ * Examines a set of dates and chooses the most specific type that includes them all. If
+ * all fall on Jan, 1 then `years` is chosen, and so on.
+ */
+function detectDateType(dates) {
+    return !dates.every(function (x) { return x.date() === 1; }) ? exports.dateTypes.days :
+        !dates.every(function (x) { return x.month() % 3 === 0; }) ? exports.dateTypes.months :
+            !dates.every(function (x) { return x.month() === 0; }) ? exports.dateTypes.quarters :
+                exports.dateTypes.years;
+}
+exports.detectDateType = detectDateType;
+/**
+ * When querying for a time series chart, e.g. x-axis is _Month_ and y-axis is
+ * _Total Sales_, there may be months where nothing was sold so they are
+ * missing from the list of records.
+ *
+ * To render a proper time-series, we need these gaps to be filled in with
+ * runs of fake records that give zero amounts for those months. e.g.
+ *
+ * ```ts
+ * const filled = fillDates({
+ *     records: [
+ *         { date: '2020-04-01', totalSales: 10 },
+ *         { date: '2020-06-01', totalSales: 4 },
+ *         { date: '2020-07-01', totalSales: 9 },
+ *     ],
+ *     type: dateTypes.months,
+ *     getDate: rec => rec.date,
+ *     fill: (label, rec) => ({
+ *         label,
+ *         totalSales: 0,
+ *         ...rec
+ *     })
+ * });
+ * ```
+ *
+ * In the above example we add a `label` property to all the records, and
+ * for the records that fill the gaps we set the `totalSales` property to 0.
+ * For the real records, `...rec` will copy the real value of `totalSales`.
+ *
+ * To do this, we need to know:
+ *
+ * - how to round a date to the start of a unit (year, month, quarter),
+ * - how to increment a date by that unit,
+ * - how to format a date to a string for display.
+ *
+ * These operations are encapsulated by the {@link FillDateType} interface.
+ * Several built-in types are provided in {@link dateTypes}, but you can
+ * implement your own.
+ *
+ * Optionally you can also pass `min` and `max` dates, which will cause
+ * extra records to be added at the start and end of the range if necessary.
+ *
+ * If you don't pass a `type`, a suitable type will be detected based on
+ * how the input record dates fall on unit boundaries.
+ */
+function fillDates(_a) {
+    var records = _a.records, getDate = _a.getDate, fill = _a.fill, min = _a.min, max = _a.max, type = _a.type;
+    records = __spreadArray([], records, true);
+    records.sort(function (x, y) { return parseDate(getDate(x)).diff(parseDate(getDate(y))); });
+    type = type !== null && type !== void 0 ? type : detectDateType(records.map(function (d) { return parseDate(getDate(d)); }));
+    var results = [];
+    var latest = undefined;
+    var lower = min ? type.round(parseDate(min)) : undefined;
+    for (var _i = 0, records_1 = records; _i < records_1.length; _i++) {
+        var record = records_1[_i];
+        var current = parseDate(getDate(record));
+        for (;;) {
+            latest = latest ? type.increment(latest) : lower;
+            if (!latest || latest >= current) {
+                break;
+            }
+            results.push(fill(type.format(latest), undefined));
+        }
+        results.push(fill(type.format(current), record));
+        latest = current;
+    }
+    if (latest && max) {
+        var upper = type.round(parseDate(max));
+        for (;;) {
+            latest = type.increment(latest);
+            if (latest > upper) {
+                break;
+            }
+            results.push(fill(type.format(latest), undefined));
+        }
+    }
+    return results;
+}
+exports.fillDates = fillDates;
+/** @deprecated */
+function smartDates(records, min, max, getDate, fill) {
+    return fillDates({ records: records, min: min, max: max, getDate: getDate, fill: fill });
+}
+exports.smartDates = smartDates;
+//# sourceMappingURL=fillDates.js.map

package/dist/fillDates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fillDates.js","sourceRoot":"","sources":["../src/fillDates.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,kDAAwC;AAIxC,SAAS,SAAS,CAAC,GAAa;IAC5B,gEAAgE;IAChE,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QACzB,GAAG,GAAG,EAAE,GAAG,GAAG,CAAC;KAClB;IAED,OAAO,IAAA,gBAAM,EAAC,GAAG,CAAC,CAAC;AACvB,CAAC;AAcD,IAAM,IAAI,GAAiB;IACvB,KAAK,YAAC,CAAC;QACH,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,YAAC,CAAC;QACJ,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IACD,SAAS,YAAC,CAAC;QACP,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC;CACJ,CAAC;AAEF,IAAM,MAAM,GAAiB;IACzB,KAAK,YAAC,CAAC;QACH,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IACD,MAAM,YAAC,CAAC;QACJ,OAAO,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAChC,CAAC;IACD,SAAS,YAAC,CAAC;QACP,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;CACJ,CAAA;AAED,IAAM,QAAQ,GAAiB;IAC3B,KAAK,YAAC,CAAC;QACH,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC;IACD,MAAM,YAAC,CAAC;QACJ,IAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnC,IAAM,SAAS,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3D,IAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC9B,OAAO,UAAG,UAAU,cAAI,SAAS,cAAI,IAAI,CAAE,CAAC;IAChD,CAAC;IACD,SAAS,YAAC,CAAC;QACP,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;CACJ,CAAA;AAED,IAAM,KAAK,GAAiB;IACxB,KAAK,YAAC,CAAC;QACH,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IACD,MAAM,YAAC,CAAC;QACJ,OAAO,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IACD,SAAS,YAAC,CAAC;QACP,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;CACJ,CAAA;AAED;;GAEG;AACU,QAAA,SAAS,GAAG;IACrB,IAAI,MAAA;IAAE,MAAM,QAAA;IAAE,QAAQ,UAAA;IAAE,KAAK,OAAA;CACvB,CAAC;AAEX;;;GAGG;AACH,SAAgB,cAAc,CAAC,KAAe;IAC1C,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAd,CAAc,CAAC,CAAC,CAAC,CAAC,iBAAS,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC,KAAK,CAAC,KAAK,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,EAAnB,CAAmB,CAAC,CAAC,CAAC,CAAC,iBAAS,CAAC,MAAM,CAAC,CAAC;YAC3D,CAAC,KAAK,CAAC,KAAK,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAf,CAAe,CAAC,CAAC,CAAC,CAAC,iBAAS,CAAC,QAAQ,CAAC,CAAC;gBACzD,iBAAS,CAAC,KAAK,CAAC;AACxB,CAAC;AALD,wCAKC;AA2BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,SAAgB,SAAS,CACrB,EAAkE;QAAhE,OAAO,aAAA,EAAE,OAAO,aAAA,EAAE,IAAI,UAAA,EAAE,GAAG,SAAA,EAAE,GAAG,SAAA,EAAE,IAAI,UAAA;IAExC,OAAO,qBAAO,OAAO,OAAC,CAAC;IACvB,OAAO,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAjD,CAAiD,CAAC,CAAC;IAE1E,IAAI,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,UAAA,CAAC,IAAI,OAAA,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAArB,CAAqB,CAAC,CAAC,CAAC;IAEvE,IAAM,OAAO,GAAQ,EAAE,CAAC;IACxB,IAAI,MAAM,GAAuB,SAAS,CAAC;IAC3C,IAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE3D,KAAqB,UAAO,EAAP,mBAAO,EAAP,qBAAO,EAAP,IAAO,EAAE;QAAzB,IAAM,MAAM,gBAAA;QACb,IAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QAE3C,SAAS;YACL,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YACjD,IAAI,CAAC,MAAM,IAAI,MAAM,IAAI,OAAO,EAAE;gBAC9B,MAAM;aACT;YAED,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;SACtD;QAED,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QACjD,MAAM,GAAG,OAAO,CAAC;KACpB;IAED,IAAI,MAAM,IAAI,GAAG,EAAE;QACf,IAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAA;QACxC,SAAS;YACL,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,MAAM,GAAG,KAAK,EAAE;gBAChB,MAAM;aACT;YAED,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;SACtD;KACJ;IAED,OAAO,OAAO,CAAC;AACnB,CAAC;AAzCD,8BAyCC;AAED,kBAAkB;AAClB,SAAgB,UAAU,CACtB,OAAY,EACZ,GAAyB,EACzB,GAAyB,EACzB,OAAgC,EAChC,IAAoD;IAEpD,OAAO,SAAS,CAAC,EAAE,OAAO,SAAA,EAAE,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,OAAO,SAAA,EAAE,IAAI,MAAA,EAAE,CAAC,CAAC;AAC3D,CAAC;AARD,gCAQC"}

package/dist/fillDates.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/fillDates.test.js

@@ -0,0 +1,211 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var fillDates_1 = require("./fillDates");
+var moment_1 = __importDefault(require("moment"));
+test("detects days", function () {
+    expect((0, fillDates_1.detectDateType)([
+        (0, moment_1.default)("2021-04-01"),
+        (0, moment_1.default)("2020-11-01"),
+        (0, moment_1.default)("2020-11-02"),
+        (0, moment_1.default)("2022-07-01"),
+    ])).toBe(fillDates_1.dateTypes.days);
+});
+test("detects months", function () {
+    expect((0, fillDates_1.detectDateType)([
+        (0, moment_1.default)("2021-04-01"),
+        (0, moment_1.default)("2020-11-01"),
+        (0, moment_1.default)("2022-07-01"),
+    ])).toBe(fillDates_1.dateTypes.months);
+});
+test("detects quarters", function () {
+    expect((0, fillDates_1.detectDateType)([
+        (0, moment_1.default)("2021-04-01"),
+        (0, moment_1.default)("2020-10-01"),
+        (0, moment_1.default)("2022-07-01"),
+    ])).toBe(fillDates_1.dateTypes.quarters);
+});
+test("detects years", function () {
+    expect((0, fillDates_1.detectDateType)([
+        (0, moment_1.default)("2021-01-01"),
+        (0, moment_1.default)("2020-01-01"),
+        (0, moment_1.default)("2022-01-01"),
+    ])).toBe(fillDates_1.dateTypes.years);
+});
+test("handles empty list", function () {
+    expect((0, fillDates_1.fillDates)({
+        records: [],
+        getDate: function (x) { return 0; },
+        fill: function () { return undefined; }
+    })).toStrictEqual([]);
+});
+test("leaves complete months alone", function () {
+    expect((0, fillDates_1.fillDates)({
+        records: [
+            { date: "2020-04-01", totalSales: 10 },
+            { date: "2020-05-01", totalSales: 4 },
+            { date: "2020-06-01", totalSales: 9 },
+            { date: "2020-07-01", totalSales: 3 },
+        ],
+        getDate: function (rec) { return rec.date; },
+        fill: function (label, rec) { return (__assign({ label: label, totalSales: 0 }, rec)); },
+        min: "2020-04-12",
+        max: "2020-07-06"
+    })).toStrictEqual([
+        { label: "Apr 2020", date: "2020-04-01", totalSales: 10 },
+        { label: "May 2020", date: "2020-05-01", totalSales: 4 },
+        { label: "Jun 2020", date: "2020-06-01", totalSales: 9 },
+        { label: "Jul 2020", date: "2020-07-01", totalSales: 3 },
+    ]);
+});
+test("fills in missing months", function () {
+    expect((0, fillDates_1.fillDates)({
+        records: [
+            { date: "2020-04-01", totalSales: 10 },
+            { date: "2020-06-01", totalSales: 4 },
+            { date: "2020-07-01", totalSales: 9 },
+            { date: "2020-11-01", totalSales: 3 },
+        ],
+        getDate: function (rec) { return rec.date; },
+        fill: function (label, rec) { return (__assign({ label: label, totalSales: 0 }, rec)); }
+    })).toStrictEqual([
+        { label: "Apr 2020", date: "2020-04-01", totalSales: 10 },
+        { label: "May 2020", totalSales: 0 },
+        { label: "Jun 2020", date: "2020-06-01", totalSales: 4 },
+        { label: "Jul 2020", date: "2020-07-01", totalSales: 9 },
+        { label: "Aug 2020", totalSales: 0 },
+        { label: "Sep 2020", totalSales: 0 },
+        { label: "Oct 2020", totalSales: 0 },
+        { label: "Nov 2020", date: "2020-11-01", totalSales: 3 },
+    ]);
+});
+test("fills in missing months and min/max range", function () {
+    expect((0, fillDates_1.fillDates)({
+        records: [
+            { date: "2020-04-01", totalSales: 10 },
+            { date: "2020-06-01", totalSales: 4 },
+            { date: "2020-07-01", totalSales: 9 },
+            { date: "2020-11-01", totalSales: 3 },
+        ],
+        getDate: function (rec) { return rec.date; },
+        fill: function (label, rec) { return (__assign({ label: label, totalSales: 0 }, rec)); },
+        min: "2020-02-15",
+        max: "2020-12-02"
+    })).toStrictEqual([
+        { label: "Feb 2020", totalSales: 0 },
+        { label: "Mar 2020", totalSales: 0 },
+        { label: "Apr 2020", date: "2020-04-01", totalSales: 10 },
+        { label: "May 2020", totalSales: 0 },
+        { label: "Jun 2020", date: "2020-06-01", totalSales: 4 },
+        { label: "Jul 2020", date: "2020-07-01", totalSales: 9 },
+        { label: "Aug 2020", totalSales: 0 },
+        { label: "Sep 2020", totalSales: 0 },
+        { label: "Oct 2020", totalSales: 0 },
+        { label: "Nov 2020", date: "2020-11-01", totalSales: 3 },
+        { label: "Dec 2020", totalSales: 0 },
+    ]);
+});
+test("leaves complete quarters alone", function () {
+    expect((0, fillDates_1.fillDates)({
+        records: [
+            { date: "2020-07-01", totalSales: 10 },
+            { date: "2020-10-01", totalSales: 4 },
+            { date: "2021-01-01", totalSales: 9 },
+            { date: "2021-04-01", totalSales: 3 },
+        ],
+        getDate: function (rec) { return rec.date; },
+        fill: function (label, rec) { return (__assign({ label: label, totalSales: 0 }, rec)); },
+        min: "2020-07-12",
+        max: "2020-04-06"
+    })).toStrictEqual([
+        { label: "Jul-Sep 2020", date: "2020-07-01", totalSales: 10 },
+        { label: "Oct-Dec 2020", date: "2020-10-01", totalSales: 4 },
+        { label: "Jan-Mar 2021", date: "2021-01-01", totalSales: 9 },
+        { label: "Apr-Jun 2021", date: "2021-04-01", totalSales: 3 },
+    ]);
+});
+test("fills in missing quarters", function () {
+    expect((0, fillDates_1.fillDates)({
+        records: [
+            { date: "2020-04-01", totalSales: 10 },
+            { date: "2020-10-01", totalSales: 4 },
+            { date: "2021-01-01", totalSales: 9 },
+            { date: "2021-10-01", totalSales: 3 },
+        ],
+        type: fillDates_1.dateTypes.quarters,
+        getDate: function (rec) { return rec.date; },
+        fill: function (label, rec) { return (__assign({ label: label, totalSales: 0 }, rec)); }
+    })).toStrictEqual([
+        { label: "Apr-Jun 2020", date: "2020-04-01", totalSales: 10 },
+        { label: "Jul-Sep 2020", totalSales: 0 },
+        { label: "Oct-Dec 2020", date: "2020-10-01", totalSales: 4 },
+        { label: "Jan-Mar 2021", date: "2021-01-01", totalSales: 9 },
+        { label: "Apr-Jun 2021", totalSales: 0 },
+        { label: "Jul-Sep 2021", totalSales: 0 },
+        { label: "Oct-Dec 2021", date: "2021-10-01", totalSales: 3 },
+    ]);
+});
+test("fills in missing quarters and min/max range", function () {
+    expect((0, fillDates_1.fillDates)({
+        records: [
+            { date: "2020-04-01", totalSales: 10 },
+            { date: "2020-10-01", totalSales: 4 },
+            { date: "2021-01-01", totalSales: 9 },
+            { date: "2021-10-01", totalSales: 3 },
+        ],
+        type: fillDates_1.dateTypes.quarters,
+        getDate: function (rec) { return rec.date; },
+        fill: function (label, rec) { return (__assign({ label: label, totalSales: 0 }, rec)); },
+        min: "2019-10-10",
+        max: "2022-01-06"
+    })).toStrictEqual([
+        { label: "Oct-Dec 2019", totalSales: 0 },
+        { label: "Jan-Mar 2020", totalSales: 0 },
+        { label: "Apr-Jun 2020", date: "2020-04-01", totalSales: 10 },
+        { label: "Jul-Sep 2020", totalSales: 0 },
+        { label: "Oct-Dec 2020", date: "2020-10-01", totalSales: 4 },
+        { label: "Jan-Mar 2021", date: "2021-01-01", totalSales: 9 },
+        { label: "Apr-Jun 2021", totalSales: 0 },
+        { label: "Jul-Sep 2021", totalSales: 0 },
+        { label: "Oct-Dec 2021", date: "2021-10-01", totalSales: 3 },
+        { label: "Jan-Mar 2022", totalSales: 0 },
+    ]);
+});
+test("explicit type overrides detection", function () {
+    expect((0, fillDates_1.fillDates)({
+        records: [
+            { date: "2020-07-01", totalSales: 10 },
+            { date: "2020-10-01", totalSales: 4 },
+            { date: "2021-01-01", totalSales: 9 },
+            { date: "2021-04-01", totalSales: 3 },
+        ],
+        getDate: function (rec) { return rec.date; },
+        fill: function (label, rec) { return (__assign({ label: label, totalSales: 0 }, rec)); },
+        type: fillDates_1.dateTypes.months
+    })).toStrictEqual([
+        { label: "Jul 2020", date: "2020-07-01", totalSales: 10 },
+        { label: "Aug 2020", totalSales: 0 },
+        { label: "Sep 2020", totalSales: 0 },
+        { label: "Oct 2020", date: "2020-10-01", totalSales: 4 },
+        { label: "Nov 2020", totalSales: 0 },
+        { label: "Dec 2020", totalSales: 0 },
+        { label: "Jan 2021", date: "2021-01-01", totalSales: 9 },
+        { label: "Feb 2021", totalSales: 0 },
+        { label: "Mar 2021", totalSales: 0 },
+        { label: "Apr 2021", date: "2021-04-01", totalSales: 3 },
+    ]);
+});
+//# sourceMappingURL=fillDates.test.js.map

package/dist/fillDates.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fillDates.test.js","sourceRoot":"","sources":["../src/fillDates.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAmE;AACnE,kDAA4B;AAE5B,IAAI,CAAC,cAAc,EAAE;IACjB,MAAM,CAAC,IAAA,0BAAc,EAAC;QAClB,IAAA,gBAAM,EAAC,YAAY,CAAC;QACpB,IAAA,gBAAM,EAAC,YAAY,CAAC;QACpB,IAAA,gBAAM,EAAC,YAAY,CAAC;QACpB,IAAA,gBAAM,EAAC,YAAY,CAAC;KACvB,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAS,CAAC,IAAI,CAAC,CAAC;AAC7B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,gBAAgB,EAAE;IACnB,MAAM,CAAC,IAAA,0BAAc,EAAC;QAClB,IAAA,gBAAM,EAAC,YAAY,CAAC;QACpB,IAAA,gBAAM,EAAC,YAAY,CAAC;QACpB,IAAA,gBAAM,EAAC,YAAY,CAAC;KACvB,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAS,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kBAAkB,EAAE;IACrB,MAAM,CAAC,IAAA,0BAAc,EAAC;QAClB,IAAA,gBAAM,EAAC,YAAY,CAAC;QACpB,IAAA,gBAAM,EAAC,YAAY,CAAC;QACpB,IAAA,gBAAM,EAAC,YAAY,CAAC;KACvB,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAS,CAAC,QAAQ,CAAC,CAAC;AACjC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,eAAe,EAAE;IAClB,MAAM,CAAC,IAAA,0BAAc,EAAC;QAClB,IAAA,gBAAM,EAAC,YAAY,CAAC;QACpB,IAAA,gBAAM,EAAC,YAAY,CAAC;QACpB,IAAA,gBAAM,EAAC,YAAY,CAAC;KACvB,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAS,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,oBAAoB,EAAE;IACvB,MAAM,CAAC,IAAA,qBAAS,EAAC;QACb,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,UAAA,CAAC,IAAI,OAAA,CAAC,EAAD,CAAC;QACf,IAAI,EAAE,cAAM,OAAA,SAAS,EAAT,CAAS;KACxB,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;AAC1B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,8BAA8B,EAAE;IACjC,MAAM,CAAC,IAAA,qBAAS,EAAC;QACb,OAAO,EAAE;YACL,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;YACtC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;SACxC;QACD,OAAO,EAAE,UAAA,GAAG,IAAI,OAAA,GAAG,CAAC,IAAI,EAAR,CAAQ;QACxB,IAAI,EAAE,UAAC,KAAK,EAAE,GAAG,IAAK,OAAA,YAClB,KAAK,OAAA,EACL,UAAU,EAAE,CAAC,IACV,GAAG,EACR,EAJoB,CAIpB;QACF,GAAG,EAAE,YAAY;QACjB,GAAG,EAAE,YAAY;KACpB,CAAC,CAAC,CAAC,aAAa,CAAC;QACd,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;QACzD,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QACxD,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QACxD,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;KAC3D,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,yBAAyB,EAAE;IAC5B,MAAM,CAAC,IAAA,qBAAS,EAAC;QACb,OAAO,EAAE;YACL,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;YACtC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;SACxC;QACD,OAAO,EAAE,UAAA,GAAG,IAAI,OAAA,GAAG,CAAC,IAAI,EAAR,CAAQ;QACxB,IAAI,EAAE,UAAC,KAAK,EAAE,GAAG,IAAK,OAAA,YAClB,KAAK,OAAA,EACL,UAAU,EAAE,CAAC,IACV,GAAG,EACR,EAJoB,CAIpB;KACL,CAAC,CAAC,CAAC,aAAa,CAAC;QACd,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;QACzD,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QACxD,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QACxD,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;KAC3D,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2CAA2C,EAAE;IAC9C,MAAM,CAAC,IAAA,qBAAS,EAAC;QACb,OAAO,EAAE;YACL,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;YACtC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;SACxC;QACD,OAAO,EAAE,UAAA,GAAG,IAAI,OAAA,GAAG,CAAC,IAAI,EAAR,CAAQ;QACxB,IAAI,EAAE,UAAC,KAAK,EAAE,GAAG,IAAK,OAAA,YAClB,KAAK,OAAA,EACL,UAAU,EAAE,CAAC,IACV,GAAG,EACR,EAJoB,CAIpB;QACF,GAAG,EAAE,YAAY;QACjB,GAAG,EAAE,YAAY;KACpB,CAAC,CAAC,CAAC,aAAa,CAAC;QACd,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;QACzD,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QACxD,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QACxD,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QACxD,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;KACvC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,gCAAgC,EAAE;IACnC,MAAM,CAAC,IAAA,qBAAS,EAAC;QACb,OAAO,EAAE;YACL,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;YACtC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;SACxC;QACD,OAAO,EAAE,UAAA,GAAG,IAAI,OAAA,GAAG,CAAC,IAAI,EAAR,CAAQ;QACxB,IAAI,EAAE,UAAC,KAAK,EAAE,GAAG,IAAK,OAAA,YAClB,KAAK,OAAA,EACL,UAAU,EAAE,CAAC,IACV,GAAG,EACR,EAJoB,CAIpB;QACF,GAAG,EAAE,YAAY;QACjB,GAAG,EAAE,YAAY;KACpB,CAAC,CAAC,CAAC,aAAa,CAAC;QACd,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;QAC7D,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QAC5D,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QAC5D,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;KAC/D,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2BAA2B,EAAE;IAC9B,MAAM,CAAC,IAAA,qBAAS,EAAC;QACb,OAAO,EAAE;YACL,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;YACtC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;SACxC;QACD,IAAI,EAAE,qBAAS,CAAC,QAAQ;QACxB,OAAO,EAAE,UAAA,GAAG,IAAI,OAAA,GAAG,CAAC,IAAI,EAAR,CAAQ;QACxB,IAAI,EAAE,UAAC,KAAK,EAAE,GAAG,IAAK,OAAA,YAClB,KAAK,OAAA,EACL,UAAU,EAAE,CAAC,IACV,GAAG,EACR,EAJoB,CAIpB;KACL,CAAC,CAAC,CAAC,aAAa,CAAC;QACd,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;QAC7D,EAAE,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,EAAE;QACxC,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QAC5D,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QAC5D,EAAE,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,EAAE;QACxC,EAAE,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,EAAE;QACxC,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;KAC/D,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6CAA6C,EAAE;IAChD,MAAM,CAAC,IAAA,qBAAS,EAAC;QACb,OAAO,EAAE;YACL,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;YACtC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;SACxC;QACD,IAAI,EAAE,qBAAS,CAAC,QAAQ;QACxB,OAAO,EAAE,UAAA,GAAG,IAAI,OAAA,GAAG,CAAC,IAAI,EAAR,CAAQ;QACxB,IAAI,EAAE,UAAC,KAAK,EAAE,GAAG,IAAK,OAAA,YAClB,KAAK,OAAA,EACL,UAAU,EAAE,CAAC,IACV,GAAG,EACR,EAJoB,CAIpB;QACF,GAAG,EAAE,YAAY;QACjB,GAAG,EAAE,YAAY;KACpB,CAAC,CAAC,CAAC,aAAa,CAAC;QACd,EAAE,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,EAAE;QACxC,EAAE,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,EAAE;QACxC,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;QAC7D,EAAE,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,EAAE;QACxC,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QAC5D,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QAC5D,EAAE,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,EAAE;QACxC,EAAE,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,EAAE;QACxC,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QAC5D,EAAE,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,EAAE;KAC3C,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mCAAmC,EAAE;IACtC,MAAM,CAAC,IAAA,qBAAS,EAAC;QACb,OAAO,EAAE;YACL,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;YACtC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;YACrC,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;SACxC;QACD,OAAO,EAAE,UAAA,GAAG,IAAI,OAAA,GAAG,CAAC,IAAI,EAAR,CAAQ;QACxB,IAAI,EAAE,UAAC,KAAK,EAAE,GAAG,IAAK,OAAA,YAClB,KAAK,OAAA,EACL,UAAU,EAAE,CAAC,IACV,GAAG,EACR,EAJoB,CAIpB;QACF,IAAI,EAAE,qBAAS,CAAC,MAAM;KACzB,CAAC,CAAC,CAAC,aAAa,CAAC;QACd,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;QACzD,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QACxD,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;QACxD,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,EAAE;QACpC,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE;KAC3D,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./fillDates";

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./fillDates"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAA4B"}

package/jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package/package.json

@@ -0,0 +1,28 @@
+{
+    "name": "flowerbi-dates",
+    "version": "2.0.0",
+    "author": "Daniel Earwicker <dan@earwicker.com>",
+    "license": "MIT",
+    "description": "FlowerBI: ultra-minimal BI analytics query and UI tools",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "devDependencies": {
+        "@types/jest": "^27.4.0",
+        "jest": "^27.4.7",
+        "moment": "^2.29.1",
+        "prettier": "^2.5.1",
+        "ts-jest": "^27.1.3",
+        "typedoc": "^0.22.11",
+        "typescript": "^4.5.5"
+    },
+    "peerDependencies": {
+        "moment": "^2.29.1"
+    },
+    "scripts": {
+        "build": "tsc",
+        "watch": "tsc -w",
+        "test": "jest",
+        "docs": "typedoc --excludePrivate --readme home.md --out ../../../docs/typedoc/flowerbi src",
+        "prepare": "npm run test && npm run build && npm run docs"
+    }
+}

package/src/fillDates.test.ts

@@ -0,0 +1,234 @@
+import { fillDates, dateTypes, detectDateType } from "./fillDates";
+import moment from "moment";
+
+test("detects days", () => {
+    expect(detectDateType([
+        moment("2021-04-01"),
+        moment("2020-11-01"),
+        moment("2020-11-02"),
+        moment("2022-07-01"),
+    ])).toBe(dateTypes.days);
+});
+
+test("detects months", () => {
+    expect(detectDateType([
+        moment("2021-04-01"),
+        moment("2020-11-01"),
+        moment("2022-07-01"),
+    ])).toBe(dateTypes.months);
+});
+
+test("detects quarters", () => {
+    expect(detectDateType([
+        moment("2021-04-01"),
+        moment("2020-10-01"),
+        moment("2022-07-01"),
+    ])).toBe(dateTypes.quarters);
+});
+
+test("detects years", () => {
+    expect(detectDateType([
+        moment("2021-01-01"),
+        moment("2020-01-01"),
+        moment("2022-01-01"),
+    ])).toBe(dateTypes.years);
+});
+
+test("handles empty list", () => {
+    expect(fillDates({
+        records: [], 
+        getDate: x => 0, 
+        fill: () => undefined
+    })).toStrictEqual([]);
+});
+
+test("leaves complete months alone", () => {
+    expect(fillDates({
+        records: [
+            { date: "2020-04-01", totalSales: 10 },
+            { date: "2020-05-01", totalSales: 4 },
+            { date: "2020-06-01", totalSales: 9 },            
+            { date: "2020-07-01", totalSales: 3 },
+        ],
+        getDate: rec => rec.date,
+        fill: (label, rec) => ({
+            label,
+            totalSales: 0,
+            ...rec
+        }),
+        min: "2020-04-12",
+        max: "2020-07-06"
+    })).toStrictEqual([
+        { label: "Apr 2020", date: "2020-04-01", totalSales: 10 },        
+        { label: "May 2020", date: "2020-05-01", totalSales: 4 },
+        { label: "Jun 2020", date: "2020-06-01", totalSales: 9 },
+        { label: "Jul 2020", date: "2020-07-01", totalSales: 3 },
+    ]);
+});
+
+test("fills in missing months", () => {
+    expect(fillDates({
+        records: [
+            { date: "2020-04-01", totalSales: 10 },
+            { date: "2020-06-01", totalSales: 4 },
+            { date: "2020-07-01", totalSales: 9 },            
+            { date: "2020-11-01", totalSales: 3 },
+        ],
+        getDate: rec => rec.date,
+        fill: (label, rec) => ({
+            label,
+            totalSales: 0,
+            ...rec
+        })
+    })).toStrictEqual([
+        { label: "Apr 2020", date: "2020-04-01", totalSales: 10 },
+        { label: "May 2020", totalSales: 0 },
+        { label: "Jun 2020", date: "2020-06-01", totalSales: 4 },
+        { label: "Jul 2020", date: "2020-07-01", totalSales: 9 },
+        { label: "Aug 2020", totalSales: 0 },
+        { label: "Sep 2020", totalSales: 0 },
+        { label: "Oct 2020", totalSales: 0 },
+        { label: "Nov 2020", date: "2020-11-01", totalSales: 3 },
+    ]);
+});
+
+test("fills in missing months and min/max range", () => {
+    expect(fillDates({
+        records: [
+            { date: "2020-04-01", totalSales: 10 },
+            { date: "2020-06-01", totalSales: 4 },
+            { date: "2020-07-01", totalSales: 9 },            
+            { date: "2020-11-01", totalSales: 3 },
+        ],
+        getDate: rec => rec.date,
+        fill: (label, rec) => ({
+            label,
+            totalSales: 0,
+            ...rec
+        }),
+        min: "2020-02-15",
+        max: "2020-12-02"
+    })).toStrictEqual([
+        { label: "Feb 2020", totalSales: 0 },
+        { label: "Mar 2020", totalSales: 0 },
+        { label: "Apr 2020", date: "2020-04-01", totalSales: 10 },
+        { label: "May 2020", totalSales: 0 },
+        { label: "Jun 2020", date: "2020-06-01", totalSales: 4 },
+        { label: "Jul 2020", date: "2020-07-01", totalSales: 9 },
+        { label: "Aug 2020", totalSales: 0 },
+        { label: "Sep 2020", totalSales: 0 },
+        { label: "Oct 2020", totalSales: 0 },
+        { label: "Nov 2020", date: "2020-11-01", totalSales: 3 },
+        { label: "Dec 2020", totalSales: 0 },
+    ]);
+});
+
+test("leaves complete quarters alone", () => {
+    expect(fillDates({
+        records: [
+            { date: "2020-07-01", totalSales: 10 },
+            { date: "2020-10-01", totalSales: 4 },
+            { date: "2021-01-01", totalSales: 9 },            
+            { date: "2021-04-01", totalSales: 3 },
+        ],
+        getDate: rec => rec.date,
+        fill: (label, rec) => ({
+            label,
+            totalSales: 0,
+            ...rec
+        }),
+        min: "2020-07-12",
+        max: "2020-04-06"
+    })).toStrictEqual([
+        { label: "Jul-Sep 2020", date: "2020-07-01", totalSales: 10 },        
+        { label: "Oct-Dec 2020", date: "2020-10-01", totalSales: 4 },
+        { label: "Jan-Mar 2021", date: "2021-01-01", totalSales: 9 },
+        { label: "Apr-Jun 2021", date: "2021-04-01", totalSales: 3 },
+    ]);
+});
+
+test("fills in missing quarters", () => {
+    expect(fillDates({
+        records: [
+            { date: "2020-04-01", totalSales: 10 },
+            { date: "2020-10-01", totalSales: 4 },
+            { date: "2021-01-01", totalSales: 9 },            
+            { date: "2021-10-01", totalSales: 3 },
+        ],
+        type: dateTypes.quarters,
+        getDate: rec => rec.date,
+        fill: (label, rec) => ({
+            label,
+            totalSales: 0,
+            ...rec
+        })
+    })).toStrictEqual([
+        { label: "Apr-Jun 2020", date: "2020-04-01", totalSales: 10 },
+        { label: "Jul-Sep 2020", totalSales: 0 },
+        { label: "Oct-Dec 2020", date: "2020-10-01", totalSales: 4 },
+        { label: "Jan-Mar 2021", date: "2021-01-01", totalSales: 9 },
+        { label: "Apr-Jun 2021", totalSales: 0 },
+        { label: "Jul-Sep 2021", totalSales: 0 },        
+        { label: "Oct-Dec 2021", date: "2021-10-01", totalSales: 3 },
+    ]);
+});
+
+test("fills in missing quarters and min/max range", () => {
+    expect(fillDates({
+        records: [
+            { date: "2020-04-01", totalSales: 10 },
+            { date: "2020-10-01", totalSales: 4 },
+            { date: "2021-01-01", totalSales: 9 },            
+            { date: "2021-10-01", totalSales: 3 },
+        ],
+        type: dateTypes.quarters,
+        getDate: rec => rec.date,
+        fill: (label, rec) => ({
+            label,
+            totalSales: 0,
+            ...rec
+        }),
+        min: "2019-10-10",
+        max: "2022-01-06"
+    })).toStrictEqual([
+        { label: "Oct-Dec 2019", totalSales: 0 },
+        { label: "Jan-Mar 2020", totalSales: 0 },
+        { label: "Apr-Jun 2020", date: "2020-04-01", totalSales: 10 },
+        { label: "Jul-Sep 2020", totalSales: 0 },
+        { label: "Oct-Dec 2020", date: "2020-10-01", totalSales: 4 },
+        { label: "Jan-Mar 2021", date: "2021-01-01", totalSales: 9 },
+        { label: "Apr-Jun 2021", totalSales: 0 },
+        { label: "Jul-Sep 2021", totalSales: 0 },
+        { label: "Oct-Dec 2021", date: "2021-10-01", totalSales: 3 },
+        { label: "Jan-Mar 2022", totalSales: 0 },
+    ]);
+});
+
+test("explicit type overrides detection", () => {
+    expect(fillDates({
+        records: [
+            { date: "2020-07-01", totalSales: 10 },
+            { date: "2020-10-01", totalSales: 4 },
+            { date: "2021-01-01", totalSales: 9 },            
+            { date: "2021-04-01", totalSales: 3 },
+        ],
+        getDate: rec => rec.date,
+        fill: (label, rec) => ({
+            label,
+            totalSales: 0,
+            ...rec
+        }),
+        type: dateTypes.months
+    })).toStrictEqual([
+        { label: "Jul 2020", date: "2020-07-01", totalSales: 10 },
+        { label: "Aug 2020", totalSales: 0 },
+        { label: "Sep 2020", totalSales: 0 },
+        { label: "Oct 2020", date: "2020-10-01", totalSales: 4 },
+        { label: "Nov 2020", totalSales: 0 },
+        { label: "Dec 2020", totalSales: 0 },
+        { label: "Jan 2021", date: "2021-01-01", totalSales: 9 },
+        { label: "Feb 2021", totalSales: 0 },
+        { label: "Mar 2021", totalSales: 0 },
+        { label: "Apr 2021", date: "2021-04-01", totalSales: 3 },
+    ]);
+});

package/src/fillDates.ts

@@ -0,0 +1,217 @@
+import moment, { Moment } from "moment";
+
+export type FillDate = Date | string | number | Moment;
+
+function parseDate(val: FillDate) {
+    // Ensure a numeric year is not interpreted as offset from 1970!
+    if (typeof val === "number") {
+        val = "" + val;
+    }
+
+    return moment(val);
+}
+
+/**
+ * Three operations on dates used by {@link fillDates}.
+ */
+export type FillDateType = {
+    /** Round the given date down to the nearest whole unit (e.g. start of month, quarter, year) */
+    round(d: Moment): Moment;
+    /** Format the given date to a string */
+    format(d: Moment): string;
+    /** Increment the date by the unit. The given date will already be rounded down. */
+    increment(d: Moment): Moment;
+}
+
+const days: FillDateType = {
+    round(d) {
+        return d.clone().startOf("day");
+    },
+    format(d) {
+        return d.format("ll");
+    },
+    increment(d) {
+        return d.clone().add(1, "day");
+    }
+};
+
+const months: FillDateType = {
+    round(d) {
+        return d.clone().startOf("month");
+    },
+    format(d) {
+        return d.format("MMM YYYY");
+    },
+    increment(d) {
+        return d.clone().add(1, "month");
+    }
+}
+
+const quarters: FillDateType = {
+    round(d) {
+        return d.clone().startOf("quarter");
+    },
+    format(d) {
+        const monthFirst = d.format("MMM");
+        const monthLast = d.clone().add(2, "months").format("MMM");
+        const year = d.format("YYYY");
+        return `${monthFirst}-${monthLast} ${year}`;
+    },
+    increment(d) {
+        return d.clone().add(3, "months");
+    }
+}
+
+const years: FillDateType = {
+    round(d) {
+        return d.clone().startOf("year");
+    },
+    format(d) {
+        return d.format("YYYY");
+    },
+    increment(d) {
+        return d.clone().add(1, "year");
+    }
+}
+
+/**
+ * Standard built-in date types. To customise, implement the {@link FillDateType} interface.
+ */
+export const dateTypes = {
+    days, months, quarters, years
+} as const;
+
+/**
+ * Examines a set of dates and chooses the most specific type that includes them all. If
+ * all fall on Jan, 1 then `years` is chosen, and so on.
+ */
+export function detectDateType(dates: Moment[]): FillDateType {
+    return !dates.every(x => x.date() === 1) ? dateTypes.days :
+        !dates.every(x => x.month() % 3 === 0) ? dateTypes.months :
+        !dates.every(x => x.month() === 0) ? dateTypes.quarters :
+        dateTypes.years;
+}
+
+/** Options for {@link fillDates} function. */
+export interface FillDatesOptions<T, R> {
+    /** The records to base the filled list on. */
+    records: T[];
+    /** The operations to use for rounding, incrementing and formatting dates. */
+    type?: FillDateType;
+    /** Extracts a date value from a record in the input list. */
+    getDate(record: T): FillDate;
+    /** 
+     * Generate a record for a date, from the formatted {@link dateText} and
+     * the input record for that date, if any.
+     */
+    fill(dateText: string, record: T | undefined): R;
+    /** 
+     * The minimum date to generate. It will be rounded down by the {@link type}
+     * so doesn't need to be on an exact boundary. 
+     */
+    min?: FillDate;
+    /** 
+     * The maximum date to generate. It will be rounded down by the {@link type}
+     * so doesn't need to be on an exact boundary. 
+     */
+    max?: FillDate;
+}
+
+/**
+ * When querying for a time series chart, e.g. x-axis is _Month_ and y-axis is
+ * _Total Sales_, there may be months where nothing was sold so they are
+ * missing from the list of records.
+ * 
+ * To render a proper time-series, we need these gaps to be filled in with
+ * runs of fake records that give zero amounts for those months. e.g.
+ * 
+ * ```ts
+ * const filled = fillDates({
+ *     records: [
+ *         { date: '2020-04-01', totalSales: 10 },
+ *         { date: '2020-06-01', totalSales: 4 },
+ *         { date: '2020-07-01', totalSales: 9 },
+ *     ],
+ *     type: dateTypes.months,
+ *     getDate: rec => rec.date,
+ *     fill: (label, rec) => ({
+ *         label,
+ *         totalSales: 0,
+ *         ...rec
+ *     })
+ * });
+ * ```
+ * 
+ * In the above example we add a `label` property to all the records, and
+ * for the records that fill the gaps we set the `totalSales` property to 0. 
+ * For the real records, `...rec` will copy the real value of `totalSales`.
+ * 
+ * To do this, we need to know:
+ * 
+ * - how to round a date to the start of a unit (year, month, quarter),
+ * - how to increment a date by that unit,
+ * - how to format a date to a string for display.
+ * 
+ * These operations are encapsulated by the {@link FillDateType} interface.
+ * Several built-in types are provided in {@link dateTypes}, but you can
+ * implement your own.
+ * 
+ * Optionally you can also pass `min` and `max` dates, which will cause
+ * extra records to be added at the start and end of the range if necessary.
+ * 
+ * If you don't pass a `type`, a suitable type will be detected based on
+ * how the input record dates fall on unit boundaries.
+ */
+export function fillDates<T, R>(
+    { records, getDate, fill, min, max, type }: FillDatesOptions<T, R>
+) {    
+    records = [...records];
+    records.sort((x, y) => parseDate(getDate(x)).diff(parseDate(getDate(y))));
+
+    type = type ?? detectDateType(records.map(d => parseDate(getDate(d))));
+
+    const results: R[] = [];
+    let latest: Moment | undefined = undefined;
+    const lower = min ? type.round(parseDate(min)) : undefined;
+    
+    for (const record of records) {
+        const current = parseDate(getDate(record));
+        
+        for (;;) {
+            latest = latest ? type.increment(latest) : lower;
+            if (!latest || latest >= current) {
+                break;
+            }
+
+            results.push(fill(type.format(latest), undefined));                
+        }
+        
+        results.push(fill(type.format(current), record));
+        latest = current;
+    }
+    
+    if (latest && max) {
+        const upper = type.round(parseDate(max))
+        for (;;) {
+            latest = type.increment(latest);
+            if (latest > upper) {
+                break;
+            }
+
+            results.push(fill(type.format(latest), undefined));                
+        }
+    }
+
+    return results;
+}
+
+/** @deprecated */
+export function smartDates<T, R>(
+    records: T[],
+    min: FillDate | undefined,
+    max: FillDate | undefined,
+    getDate: (record: T) => FillDate,
+    fill: (dateText: string, record: T | undefined) => R
+) {
+    return fillDates({ records, min, max, getDate, fill });
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./fillDates";

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+    "compilerOptions": {
+        "target": "es5",
+        "lib": ["dom", "dom.iterable", "esnext"],
+        "allowJs": true,
+        "skipLibCheck": true,
+        "esModuleInterop": true,
+        "allowSyntheticDefaultImports": true,
+        "strict": true,
+        "forceConsistentCasingInFileNames": true,
+        "module": "commonjs",
+        "moduleResolution": "node",
+        "resolveJsonModule": true,
+        "isolatedModules": true,
+        "outDir": "dist",
+        "declaration": true,
+        "sourceMap": true,
+        "jsx": "react"
+    },
+    "include": ["src"]
+}