@sjts/lib-date 1.0.0

package/.eslintrc.cjs

@@ -0,0 +1,9 @@
+module.exports = {
+	extends: [require.resolve('@sjts/lib-dev/eslintrc.base')],
+	ignorePatterns: ['*.d.ts', 'admin/*', '*.test.ts', '*/node_modules/*', '*.js'],
+	parserOptions: {
+		project: 'tsconfig.json',
+		tsconfigRootDir: __dirname,
+		createDefaultProgram: true,
+	},
+}

package/LICENCE

@@ -0,0 +1,5 @@
+
+Copyright (C) Mr Stephen James - All Rights Reserved
+Unauthorized copying of any files within this source code repository, via any medium is strictly prohibited
+Proprietary and confidential
+Written by Steve James <steve@stevejames.dev>, March 2019

package/dist/DateConsts.d.ts

@@ -0,0 +1,3 @@
+export declare const HOUR_MINS = 60;
+export declare const DAY_MINS: number;
+export declare const WEEK_MINS: number;

package/dist/DateConsts.js

@@ -0,0 +1,3 @@
+export const HOUR_MINS = 60;
+export const DAY_MINS = HOUR_MINS * 24;
+export const WEEK_MINS = DAY_MINS * 7;

package/dist/DateRange.d.ts

@@ -0,0 +1,6 @@
+import { DateTime } from 'luxon';
+export type DateRange = {
+    startDate: DateTime;
+    endDate: DateTime;
+};
+export default DateRange;

package/dist/DateRange.js

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

package/dist/Duration.d.ts

@@ -0,0 +1,6 @@
+import DurationUnit from './DurationUnit.js';
+export type Duration = {
+    unit: DurationUnit;
+    count: number;
+};
+export default Duration;

package/dist/Duration.js

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

package/dist/DurationUnit.d.ts

@@ -0,0 +1,9 @@
+export declare enum DurationUnit {
+    DAY = "day",
+    WEEK = "week",
+    FORTNIGHT = "fortnight",
+    MONTH = "month",
+    QUARTER = "quarter",
+    YEAR = "year"
+}
+export default DurationUnit;

package/dist/DurationUnit.js

@@ -0,0 +1,10 @@
+export var DurationUnit;
+(function (DurationUnit) {
+    DurationUnit["DAY"] = "day";
+    DurationUnit["WEEK"] = "week";
+    DurationUnit["FORTNIGHT"] = "fortnight";
+    DurationUnit["MONTH"] = "month";
+    DurationUnit["QUARTER"] = "quarter";
+    DurationUnit["YEAR"] = "year";
+})(DurationUnit || (DurationUnit = {}));
+export default DurationUnit;

package/dist/Tense.d.ts

@@ -0,0 +1,6 @@
+export declare enum Tense {
+    PAST = "PAST",
+    PRESENT = "PRESENT",
+    FUTURE = "FUTURE"
+}
+export default Tense;

package/dist/Tense.js

@@ -0,0 +1,7 @@
+export var Tense;
+(function (Tense) {
+    Tense["PAST"] = "PAST";
+    Tense["PRESENT"] = "PRESENT";
+    Tense["FUTURE"] = "FUTURE";
+})(Tense || (Tense = {}));
+export default Tense;

package/dist/TimeFrame.d.ts

@@ -0,0 +1,7 @@
+import { DateTime } from 'luxon';
+import Duration from './Duration.js';
+export type TimeFrame = {
+    startDate: DateTime;
+    duration: Duration;
+};
+export default TimeFrame;

package/dist/TimeFrame.js

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

package/dist/addDuration.d.ts

@@ -0,0 +1,4 @@
+import { DateTime } from 'luxon';
+import Duration from './Duration.js';
+export declare function addDuration(date: DateTime, duration: Duration): DateTime;
+export default addDuration;

package/dist/addDuration.js

@@ -0,0 +1,21 @@
+import DurationUnit from './DurationUnit.js';
+export function addDuration(date, duration) {
+    if (!duration)
+        return date;
+    const { unit, count = 1 } = duration;
+    switch (unit) {
+        case DurationUnit.DAY:
+            return date.plus({ day: count });
+        case DurationUnit.WEEK:
+            return date.plus({ day: count * 7 });
+        case DurationUnit.FORTNIGHT:
+            return date.plus({ day: count * 14 });
+        case DurationUnit.MONTH:
+            return date.plus({ month: count });
+        case DurationUnit.QUARTER:
+            return date.plus({ month: count * 3 });
+        case DurationUnit.YEAR:
+            return date.plus({ year: count });
+    }
+}
+export default addDuration;

package/dist/calcDateRangeDiff.d.ts

@@ -0,0 +1,3 @@
+import DateRange from './DateRange.js';
+export default calcDateRangeDiff;
+export declare function calcDateRangeDiff(range: DateRange, unit?: any): number;

package/dist/calcDateRangeDiff.js

@@ -0,0 +1,4 @@
+export default calcDateRangeDiff;
+export function calcDateRangeDiff(range, unit = 'days') {
+    return range.endDate.diff(range.startDate, unit)[unit];
+}

package/dist/calcDateRangeDiff.test.d.ts

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

package/dist/calcDateRangeDiff.test.js

@@ -0,0 +1,23 @@
+import { unitTest } from '@sjts/lib-dev';
+import calcDateRangeDiff from './calcDateRangeDiff';
+import newDateFromISO from './newDateFromISO';
+const file = 'File';
+const arg = 'Arg';
+describe('calcDateRangeOverlap', () => {
+    unitTest('good - month', async () => {
+        const t = {
+            startDate: newDateFromISO('2000-01-01'),
+            endDate: newDateFromISO('2000-02-01'),
+        };
+        const r = calcDateRangeDiff(t);
+        expect(r).toBe(31);
+    });
+    unitTest('good - 2 days', async () => {
+        const t = {
+            startDate: newDateFromISO('2000-01-01'),
+            endDate: newDateFromISO('2000-01-03'),
+        };
+        const r = calcDateRangeDiff(t);
+        expect(r).toBe(2);
+    });
+});

package/dist/calcDateRangeGaps.d.ts

@@ -0,0 +1,3 @@
+import DateRange from './DateRange.js';
+export default calcDateRangeGaps;
+export declare function calcDateRangeGaps(outerRange: DateRange, innerRanges: DateRange[]): DateRange[];

package/dist/calcDateRangeGaps.js

@@ -0,0 +1,25 @@
+import { sortBy } from 'lodash-es';
+export default calcDateRangeGaps;
+export function calcDateRangeGaps(outerRange, innerRanges) {
+    // Filter innerRanges to just include ranges that are within the outer range
+    // And sort them by their reverse start date (so we can POP the earliest)
+    const validInnerRanges = sortBy(innerRanges.filter(({ startDate, endDate }) => startDate < outerRange.endDate || endDate >= outerRange.startDate), ({ startDate }) => startDate.toMillis()).reverse();
+    // If there are no valid inner ranges, the entire outerRange is a "gap"
+    if (!validInnerRanges?.length)
+        return [outerRange];
+    // Build up an array of gaps
+    const results = [];
+    // Loop through all start dates, filling in gaps if necessary
+    let currentStartDate = outerRange.startDate;
+    while (!!validInnerRanges.length) {
+        const innerRange = validInnerRanges.pop();
+        // If our start date is before the innerRange start date, we have a gap
+        if (currentStartDate < innerRange.startDate && currentStartDate < innerRange.endDate)
+            results.push({ startDate: currentStartDate, endDate: innerRange.startDate });
+        // Our new start date is the end of the innerRange
+        currentStartDate = innerRange.endDate;
+    }
+    if (!outerRange.endDate || currentStartDate < outerRange.endDate)
+        results.push({ startDate: currentStartDate, endDate: outerRange.endDate });
+    return results;
+}

package/dist/calcDateRangeOverlap.d.ts

@@ -0,0 +1,3 @@
+import DateRange from './DateRange.js';
+export default calcDateRangeOverlap;
+export declare function calcDateRangeOverlap(base: DateRange, over: DateRange): DateRange | undefined;

package/dist/calcDateRangeOverlap.js

@@ -0,0 +1,16 @@
+export default calcDateRangeOverlap;
+export function calcDateRangeOverlap(base, over) {
+    const oS = over.startDate;
+    const oE = over.endDate;
+    const bS = base.startDate;
+    const bE = base.endDate;
+    if (oS > bE)
+        return undefined;
+    if (oE < bS)
+        return undefined;
+    // prettier-ignore
+    const startDate = (!oS && !!bS) || (oS < bS) ? bS : oS;
+    // prettier-ignore
+    const endDate = (!bE && !!oE) || (oE < bE) ? oE : bE;
+    return { startDate, endDate };
+}

package/dist/calcDateRangeOverlap.test.d.ts

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

package/dist/calcDateRangeOverlap.test.js

@@ -0,0 +1,63 @@
+import { unitTest } from '@sjts/lib-dev';
+import calcDateRangeOverlap from './calcDateRangeOverlap';
+import newDateFromISO from './newDateFromISO';
+const file = 'File';
+const arg = 'Arg';
+describe('calcDateRangeOverlap', () => {
+    const testRange = {
+        startDate: newDateFromISO('2000-01-01'),
+        endDate: newDateFromISO('2000-02-01'),
+    };
+    unitTest('good - fully inside', async () => {
+        const t = {
+            startDate: newDateFromISO('2000-01-10'),
+            endDate: newDateFromISO('2000-01-12'),
+        };
+        const r = calcDateRangeOverlap(testRange, t);
+        expect(r?.startDate === t.startDate).toBeTruthy();
+        expect(r?.endDate === t.endDate).toBeTruthy();
+    });
+    unitTest('good - fully outside after', async () => {
+        const t = {
+            startDate: newDateFromISO('2000-03-01'),
+            endDate: newDateFromISO('2000-03-10'),
+        };
+        const r = calcDateRangeOverlap(testRange, t);
+        expect(r).toBeUndefined();
+    });
+    unitTest('good - fully outside before', async () => {
+        const t = {
+            startDate: newDateFromISO('1999-03-01'),
+            endDate: newDateFromISO('1999-03-10'),
+        };
+        const r = calcDateRangeOverlap(testRange, t);
+        expect(r).toBeUndefined();
+    });
+    unitTest('good - fully overlap', async () => {
+        const t = {
+            startDate: newDateFromISO('1999-03-01'),
+            endDate: newDateFromISO('2003-03-10'),
+        };
+        const r = calcDateRangeOverlap(testRange, t);
+        expect(r?.startDate === testRange.startDate).toBeTruthy();
+        expect(r?.endDate === testRange.endDate).toBeTruthy();
+    });
+    unitTest('good - part overlap - before', async () => {
+        const t = {
+            startDate: newDateFromISO('1999-03-01'),
+            endDate: newDateFromISO('2000-01-10'),
+        };
+        const r = calcDateRangeOverlap(testRange, t);
+        expect(r?.startDate === testRange.startDate).toBeTruthy();
+        expect(r?.endDate === t.endDate).toBeTruthy();
+    });
+    unitTest('good - part overlap - after', async () => {
+        const t = {
+            startDate: newDateFromISO('2000-01-10'),
+            endDate: newDateFromISO('2000-03-10'),
+        };
+        const r = calcDateRangeOverlap(testRange, t);
+        expect(r?.startDate === t.startDate).toBeTruthy();
+        expect(r?.endDate === testRange.endDate).toBeTruthy();
+    });
+});

package/dist/dateRange2Tense.d.ts

@@ -0,0 +1,4 @@
+import DateRange from './DateRange.js';
+import Tense from './Tense.js';
+export default dateRange2Tense;
+export declare function dateRange2Tense(dateRange: DateRange): Tense;

package/dist/dateRange2Tense.js

@@ -0,0 +1,11 @@
+import { DateTime } from 'luxon';
+import Tense from './Tense.js';
+export default dateRange2Tense;
+export function dateRange2Tense(dateRange) {
+    const now = DateTime.now().startOf('day');
+    if (dateRange?.startDate > now)
+        return Tense.FUTURE;
+    if (dateRange?.endDate < now)
+        return Tense.PAST;
+    return Tense.PRESENT;
+}

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+export * from './DateConsts.js';
+export { DateRange } from './DateRange.js';
+export { Duration } from './Duration.js';
+export { DurationUnit } from './DurationUnit.js';
+export { Tense } from './Tense.js';
+export { TimeFrame } from './TimeFrame.js';
+export { addDuration } from './addDuration.js';
+export { calcDateRangeDiff } from './calcDateRangeDiff.js';
+export { calcDateRangeGaps } from './calcDateRangeGaps.js';
+export { calcDateRangeOverlap } from './calcDateRangeOverlap.js';
+export { dateRange2Tense } from './dateRange2Tense.js';
+export { isDateWithinRange } from './isDateWithinRange.js';
+export { logDateRange } from './logDateRange.js';
+export { logTimeFrame } from './logTimeFrame.js';
+export { mergeDateRanges } from './mergeDateRanges.js';
+export { newDateFromISO } from './newDateFromISO.js';
+export { newDateFromJS } from './newDateFromJS.js';
+export { newDateFromMillis } from './newDateFromMillis.js';
+export { noOfWeekdays } from './noOfWeekdays.js';
+export { timeFrame2DateRange } from './timeFrame2DateRange.js';
+export { timeFrame2Tense } from './timeFrame2Tense.js';

package/dist/index.js

@@ -0,0 +1,18 @@
+export * from './DateConsts.js';
+export { DurationUnit } from './DurationUnit.js';
+export { Tense } from './Tense.js';
+export { addDuration } from './addDuration.js';
+export { calcDateRangeDiff } from './calcDateRangeDiff.js';
+export { calcDateRangeGaps } from './calcDateRangeGaps.js';
+export { calcDateRangeOverlap } from './calcDateRangeOverlap.js';
+export { dateRange2Tense } from './dateRange2Tense.js';
+export { isDateWithinRange } from './isDateWithinRange.js';
+export { logDateRange } from './logDateRange.js';
+export { logTimeFrame } from './logTimeFrame.js';
+export { mergeDateRanges } from './mergeDateRanges.js';
+export { newDateFromISO } from './newDateFromISO.js';
+export { newDateFromJS } from './newDateFromJS.js';
+export { newDateFromMillis } from './newDateFromMillis.js';
+export { noOfWeekdays } from './noOfWeekdays.js';
+export { timeFrame2DateRange } from './timeFrame2DateRange.js';
+export { timeFrame2Tense } from './timeFrame2Tense.js';

package/dist/isDateWithinRange.d.ts

@@ -0,0 +1,4 @@
+import { DateTime } from 'luxon';
+import DateRange from './DateRange.js';
+export default isDateWithinRange;
+export declare function isDateWithinRange(date: DateTime, range: DateRange): boolean;

package/dist/isDateWithinRange.js

@@ -0,0 +1,6 @@
+export default isDateWithinRange;
+export function isDateWithinRange(date, range) {
+    if (!date || !range?.startDate || !range?.endDate)
+        return false;
+    return date >= range.startDate && date <= range.endDate;
+}

package/dist/logDateRange.d.ts

@@ -0,0 +1,3 @@
+import DateRange from './DateRange.js';
+export default logDateRange;
+export declare function logDateRange(d: DateRange): void;

package/dist/logDateRange.js

@@ -0,0 +1,4 @@
+export default logDateRange;
+export function logDateRange(d) {
+    console.log(d.startDate.toFormat('DD') + ' - ' + d.endDate.toFormat('DD'));
+}

package/dist/logTimeFrame.d.ts

@@ -0,0 +1,3 @@
+import TimeFrame from './TimeFrame.js';
+export default logTimeFrame;
+export declare function logTimeFrame(tf: TimeFrame): void;

package/dist/logTimeFrame.js

@@ -0,0 +1,4 @@
+export default logTimeFrame;
+export function logTimeFrame(tf) {
+    console.log(tf.startDate.toFormat('DD'), tf.duration.count, tf.duration.unit);
+}

package/dist/mergeDateRanges.d.ts

@@ -0,0 +1,3 @@
+import DateRange from './DateRange.js';
+export default mergeDateRanges;
+export declare function mergeDateRanges(dateRanges: DateRange[]): DateRange | undefined;

package/dist/mergeDateRanges.js

@@ -0,0 +1,14 @@
+export default mergeDateRanges;
+export function mergeDateRanges(dateRanges) {
+    let startDate;
+    let endDate;
+    dateRanges.forEach(d => {
+        if (!d)
+            return;
+        if (!!d.startDate && (!startDate || d.startDate < startDate))
+            startDate = d.startDate;
+        if (!!d.endDate && (!endDate || d.endDate < endDate))
+            endDate = d.endDate;
+    });
+    return !!startDate || !!endDate ? { startDate, endDate } : undefined;
+}

package/dist/newDateFromISO.d.ts

@@ -0,0 +1,3 @@
+import { DateTime } from 'luxon';
+export default newDateFromISO;
+export declare function newDateFromISO(iso: string): DateTime;

package/dist/newDateFromISO.js

@@ -0,0 +1,5 @@
+import { DateTime } from 'luxon';
+export default newDateFromISO;
+export function newDateFromISO(iso) {
+    return DateTime.fromISO(iso);
+}

package/dist/newDateFromJS.d.ts

@@ -0,0 +1,3 @@
+import { DateTime } from 'luxon';
+export default newDateFromJS;
+export declare function newDateFromJS(js: Date): DateTime;

package/dist/newDateFromJS.js

@@ -0,0 +1,5 @@
+import { DateTime } from 'luxon';
+export default newDateFromJS;
+export function newDateFromJS(js) {
+    return DateTime.fromJSDate(js);
+}

package/dist/newDateFromMillis.d.ts

@@ -0,0 +1,3 @@
+import { DateTime } from 'luxon';
+export default newDateFromMillis;
+export declare function newDateFromMillis(millis: number): DateTime;

package/dist/newDateFromMillis.js

@@ -0,0 +1,5 @@
+import { DateTime } from 'luxon';
+export default newDateFromMillis;
+export function newDateFromMillis(millis) {
+    return DateTime.fromMillis(millis);
+}

package/dist/noOfWeekdays.d.ts

@@ -0,0 +1,3 @@
+import DateRange from './DateRange.js';
+export default noOfWeekdays;
+export declare function noOfWeekdays(dateRange: DateRange): number | undefined;

package/dist/noOfWeekdays.js

@@ -0,0 +1,16 @@
+export default noOfWeekdays;
+export function noOfWeekdays(dateRange) {
+    if (!dateRange)
+        return undefined;
+    const { startDate, endDate } = dateRange;
+    if (!startDate || !endDate)
+        return undefined;
+    let count = 0;
+    let currentDate = startDate;
+    while (currentDate <= endDate) {
+        if (currentDate.weekday < 6)
+            count++;
+        currentDate = currentDate.plus({ day: 1 });
+    }
+    return count;
+}

package/dist/timeFrame2DateRange.d.ts

@@ -0,0 +1,4 @@
+import DateRange from './DateRange.js';
+import TimeFrame from './TimeFrame.js';
+export default timeFrame2DateRange;
+export declare function timeFrame2DateRange(timeFrame: TimeFrame): DateRange;

package/dist/timeFrame2DateRange.js

@@ -0,0 +1,14 @@
+import addDuration from './addDuration.js';
+export default timeFrame2DateRange;
+// NOTE: Time frames and addDuration are subtly DIFFERENT
+//
+// 1st October ADD 1 month is 1st November (addDuration)
+// The timeframe starting on 1st October and lasting 1 month ... ends on 31st of October
+export function timeFrame2DateRange(timeFrame) {
+    return {
+        startDate: timeFrame?.startDate?.startOf('day') ?? undefined,
+        endDate: addDuration(timeFrame?.startDate, timeFrame?.duration)
+            ?.startOf('day')
+            .minus({ day: 1 }),
+    };
+}

package/dist/timeFrame2Tense.d.ts

@@ -0,0 +1,4 @@
+import Tense from './Tense.js';
+import TimeFrame from './TimeFrame.js';
+export default timeFrame2Tense;
+export declare function timeFrame2Tense(timeFrame: TimeFrame): Tense;

package/dist/timeFrame2Tense.js

@@ -0,0 +1,6 @@
+import dateRange2Tense from './dateRange2Tense.js';
+import timeFrame2DateRange from './timeFrame2DateRange.js';
+export default timeFrame2Tense;
+export function timeFrame2Tense(timeFrame) {
+    return dateRange2Tense(timeFrame2DateRange(timeFrame));
+}

package/package.json

@@ -0,0 +1,25 @@
+{
+    "name": "@sjts/lib-date",
+    "description": "The Steve James Typescript date utils package",
+    "version": "1.0.0",
+    "type": "module",
+    "main": "./dist/index.js",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "require": "./dist/index.js"
+        }
+    },
+    "dependencies": {
+        "lodash-es": "4.17.21",
+        "luxon": "3.1.1"
+    },
+    "devDependencies": {
+        "@sjts/lib-dev": "1.1.0"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}