@8ms/helpers 1.41.1 → 1.42.0

package/dist/esm/date/getTodayYmd.js

@@ -0,0 +1,16 @@
+import format from "./format";
+import getToday from "./getToday";
+/**
+ * Shorthand to get the current date.
+ */
+const getTodayYmd = () => {
+    const today = getToday({ setMidnight: false });
+    const todayYmd = format({
+        input: today,
+        isUtc: true,
+        dateFormat: "yyyy-MM-dd",
+        setMidnight: false,
+    });
+    return todayYmd;
+};
+export default getTodayYmd;

package/dist/esm/date/getTodayYmdhis.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Shorthand to get the current timestamp.
+ */
+declare const getTodayYmdhis: () => string;
+export default getTodayYmdhis;

package/dist/esm/date/getTodayYmdhis.js

@@ -0,0 +1,16 @@
+import format from './format';
+import getToday from './getToday';
+/**
+ * Shorthand to get the current timestamp.
+ */
+const getTodayYmdhis = () => {
+    const today = getToday({ setMidnight: false });
+    const todayYmdhis = format({
+        input: today,
+        isUtc: true,
+        dateFormat: 'yyyy-MM-dd HH:mm:ss',
+        setMidnight: false,
+    });
+    return todayYmdhis;
+};
+export default getTodayYmdhis;

package/dist/esm/date/getTwoWeeksAgo.d.ts

@@ -0,0 +1,10 @@
+import { GetMidnight } from "./getMidnight";
+import { GetTimeZoned } from "./getTimeZoned";
+import { Timeframe } from "./";
+type GetTwoWeeksAgo = GetTimeZoned & GetMidnight;
+/**
+ * Return an object of start/end predefined date of Two Weeks Ago.
+ * Creating a date from scratch (no user input), thus needs to be London time.
+ */
+declare const getTwoWeeksAgo: ({ setMidnight, setTimeZone }?: GetTwoWeeksAgo) => Timeframe;
+export default getTwoWeeksAgo;

package/dist/esm/date/getTwoWeeksAgo.js

@@ -0,0 +1,31 @@
+import getMonday from "./getMonday";
+import getNumber from "./getNumber";
+import getSunday from "./getSunday";
+import { timeZoneLondon } from "./getTimeZoned";
+/**
+ * Return an object of start/end predefined date of Two Weeks Ago.
+ * Creating a date from scratch (no user input), thus needs to be London time.
+ */
+const getTwoWeeksAgo = ({ setMidnight = true, setTimeZone = timeZoneLondon } = { setMidnight: true, setTimeZone: timeZoneLondon }) => {
+    const sunday = getSunday({
+        weeksAgo: 1,
+        setMidnight,
+        setTimeZone,
+    });
+    const monday = getMonday({
+        weeksAgo: 2,
+        setMidnight,
+        setTimeZone,
+    });
+    return {
+        end: getNumber({
+            input: sunday,
+            isUtc: true,
+        }),
+        start: getNumber({
+            input: monday,
+            isUtc: true,
+        }),
+    };
+};
+export default getTwoWeeksAgo;

package/dist/esm/date/getWeeksAgo.d.ts

@@ -0,0 +1,13 @@
+import { DateType } from './';
+import { GetTimeZoned } from './getTimeZoned';
+type GetWeeksAgo = GetTimeZoned & {
+    input: DateType;
+    isUtc: boolean;
+    weeksAgo: number;
+    setMidnight?: boolean;
+};
+/**
+ * From a given input, move the date back X weeksAgo
+ */
+declare const getWeeksAgo: ({ input, isUtc, weeksAgo, setMidnight, setTimeZone }: GetWeeksAgo) => number;
+export default getWeeksAgo;

package/dist/esm/date/getWeeksAgo.js

@@ -0,0 +1,20 @@
+import { sub } from 'date-fns';
+import getDate from './getDate';
+import getNumber from './getNumber';
+/**
+ * From a given input, move the date back X weeksAgo
+ */
+const getWeeksAgo = ({ input, isUtc, weeksAgo = 0, setMidnight = true, setTimeZone = false }) => {
+    let dateInstance = getDate({
+        input,
+        isUtc,
+        setMidnight,
+        setTimeZone
+    });
+    dateInstance = sub(dateInstance, { weeks: weeksAgo });
+    return getNumber({
+        input: dateInstance,
+        isUtc,
+    });
+};
+export default getWeeksAgo;

package/dist/esm/date/getYesterday.d.ts

@@ -0,0 +1,9 @@
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+type GetYesterday = GetTimeZoned & GetMidnight;
+/**
+ * Shortcut to get yesterday's date.
+ * Creating a date from scratch (no user input), thus needs to be London time.
+ */
+declare const getYesterday: ({ setMidnight, setTimeZone }?: GetYesterday) => Date;
+export default getYesterday;

package/dist/esm/date/getYesterday.js

@@ -0,0 +1,14 @@
+import { subDays } from 'date-fns';
+import getTimeZoned, { timeZoneLondon } from './getTimeZoned';
+import getToday from './getToday';
+/**
+ * Shortcut to get yesterday's date.
+ * Creating a date from scratch (no user input), thus needs to be London time.
+ */
+const getYesterday = ({ setMidnight = true, setTimeZone = timeZoneLondon } = { setMidnight: true, setTimeZone: timeZoneLondon }) => {
+    const today = getToday({ setMidnight, setTimeZone: false });
+    let yesterday = subDays(today, 1);
+    yesterday = getTimeZoned({ input: yesterday, setTimeZone });
+    return yesterday;
+};
+export default getYesterday;

package/dist/esm/date/index.d.ts

@@ -0,0 +1,55 @@
+/**
+ * A date can be either a number (YYYYMMDD), string (YYYY-MM-DD) or Date instance.
+ */
+export type DateType = number | string | Date;
+/**
+ * When a date isn't specified and we need a value.
+ */
+export declare const defaultDate = "1901-01-01";
+/**
+ * When a date time isn't specified and we need a value.
+ */
+export declare const defaultDateTime = "1901-01-01 00:00:00";
+export type Duration = {
+    hours: number;
+    minutes: number;
+    seconds: number;
+};
+export declare enum DurationComparison {
+    VS_NOW = "VS_NOW",
+    VS_MIDNIGHT = "VS_MIDNIGHT"
+}
+export declare enum Interval {
+    FOREVER = "FOREVER",
+    MONTHS = "MONTHS",
+    DAYS = "DAYS",
+    HOURS = "HOURS",
+    MINUTES = "MINUTES"
+}
+export type FinancialYear = {
+    end: Date;
+    start: Date;
+};
+export type FinancialYearWeekType = {
+    end: Date;
+    financialWeek: number;
+    financialYear: number;
+    start: Date;
+};
+/**
+ * A timeframe has a start and an end date.
+ */
+export type Timeframe = {
+    end: DateType;
+    start: DateType;
+};
+export declare enum Timeframes {
+    CURRENT = "CURRENT",
+    COMPARISON = "COMPARISON"
+}
+export declare enum PredefinedTimeframe {
+    NONE = "NONE",
+    CUSTOM = "CUSTOM",
+    THIS_WEEK = "THIS_WEEK",
+    LAST_WEEK = "LAST_WEEK"
+}

package/dist/esm/date/index.js

@@ -0,0 +1,33 @@
+/**
+ * When a date isn't specified and we need a value.
+ */
+export const defaultDate = "1901-01-01";
+/**
+ * When a date time isn't specified and we need a value.
+ */
+export const defaultDateTime = "1901-01-01 00:00:00";
+export var DurationComparison;
+(function (DurationComparison) {
+    DurationComparison["VS_NOW"] = "VS_NOW";
+    DurationComparison["VS_MIDNIGHT"] = "VS_MIDNIGHT";
+})(DurationComparison || (DurationComparison = {}));
+export var Interval;
+(function (Interval) {
+    Interval["FOREVER"] = "FOREVER";
+    Interval["MONTHS"] = "MONTHS";
+    Interval["DAYS"] = "DAYS";
+    Interval["HOURS"] = "HOURS";
+    Interval["MINUTES"] = "MINUTES";
+})(Interval || (Interval = {}));
+export var Timeframes;
+(function (Timeframes) {
+    Timeframes["CURRENT"] = "CURRENT";
+    Timeframes["COMPARISON"] = "COMPARISON";
+})(Timeframes || (Timeframes = {}));
+export var PredefinedTimeframe;
+(function (PredefinedTimeframe) {
+    PredefinedTimeframe["NONE"] = "NONE";
+    PredefinedTimeframe["CUSTOM"] = "CUSTOM";
+    PredefinedTimeframe["THIS_WEEK"] = "THIS_WEEK";
+    PredefinedTimeframe["LAST_WEEK"] = "LAST_WEEK";
+})(PredefinedTimeframe || (PredefinedTimeframe = {}));

package/dist/esm/date/isDateValid.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Ensure the date string provided is in YYYY-MM-DD format and is a valid date.
+ */
+declare const isDateValid: ({ input }: {
+    input: string;
+}) => boolean;
+export default isDateValid;

package/dist/esm/date/isDateValid.js

@@ -0,0 +1,18 @@
+import { isValid } from 'date-fns';
+import { parseISO } from 'date-fns';
+/**
+ * Ensure the date string provided is in YYYY-MM-DD format and is a valid date.
+ */
+const isDateValid = ({ input }) => {
+    const cleanInput = input.trim();
+    const parsedInput = parseISO(cleanInput);
+    if (isValid(parsedInput)) {
+        const matches = cleanInput.match(/^([0-9]{4}-[0-9]{2}-[0-9]{2})$/);
+        if (matches) {
+            return matches.length ? true : false;
+        }
+        return false;
+    }
+    return false;
+};
+export default isDateValid;

package/dist/esm/date/isLastWeek.d.ts

@@ -0,0 +1,6 @@
+import { Timeframe } from './';
+/**
+ * Check to see if a given timeframe is Last Week.
+ */
+declare const isLastWeek: ({ end, start }: Timeframe) => boolean;
+export default isLastWeek;

package/dist/esm/date/isLastWeek.js

@@ -0,0 +1,9 @@
+import getLastWeek from './getLastWeek';
+/**
+ * Check to see if a given timeframe is Last Week.
+ */
+const isLastWeek = ({ end, start }) => {
+    const lastWeek = getLastWeek();
+    return start === lastWeek.start && end === lastWeek.end;
+};
+export default isLastWeek;

package/dist/esm/date/isThisWeek.d.ts

@@ -0,0 +1,6 @@
+import { Timeframe } from './';
+/**
+ * Check to see if a given timeframe is This Week.
+ */
+declare const isThisWeek: ({ end, start }: Timeframe) => boolean;
+export default isThisWeek;

package/dist/esm/date/isThisWeek.js

@@ -0,0 +1,9 @@
+import getThisWeek from './getThisWeek';
+/**
+ * Check to see if a given timeframe is This Week.
+ */
+const isThisWeek = ({ end, start }) => {
+    const thisWeek = getThisWeek();
+    return start === thisWeek.start && end === thisWeek.end;
+};
+export default isThisWeek;

package/dist/esm/date/parseExcelDate.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Convert an excel date "e.g. 44216" into a JavaScript date object.
+ * https://stackoverflow.com/questions/16229494/converting-excel-date-serial-number-to-date-using-javascript
+ */
+declare const parseExcelDate: ({ serial }: {
+    serial: number;
+}) => Date;
+export default parseExcelDate;

package/dist/esm/date/parseExcelDate.js

@@ -0,0 +1,17 @@
+/**
+ * Convert an excel date "e.g. 44216" into a JavaScript date object.
+ * https://stackoverflow.com/questions/16229494/converting-excel-date-serial-number-to-date-using-javascript
+ */
+const parseExcelDate = ({ serial }) => {
+    const utcDates = Math.floor(serial - 25569);
+    const utcValue = utcDates * 86400;
+    const dateInfo = new Date(utcValue * 1000);
+    const fractionalDay = serial - Math.floor(serial) + 0.0000001;
+    let totalSeconds = Math.floor(86400 * fractionalDay);
+    const seconds = totalSeconds % 60;
+    totalSeconds -= seconds;
+    const hours = Math.floor(totalSeconds / (60 * 60));
+    const minutes = Math.floor(totalSeconds / 60) % 60;
+    return new Date(dateInfo.getFullYear(), dateInfo.getMonth(), dateInfo.getDate(), hours, minutes, seconds);
+};
+export default parseExcelDate;

package/dist/esm/date/tests/format.test.d.ts

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

package/dist/esm/date/tests/format.test.js

@@ -0,0 +1,8 @@
+import format from '../format';
+test('format', () => {
+    const expected = '01/02/2021';
+    const dateFormat = 'dd/MM/yyyy';
+    const dateNumber = 20210201;
+    expect(format({ input: dateNumber, dateFormat }))
+        .toBe(expected);
+});

package/dist/esm/date/tests/getDate.test.d.ts

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

package/dist/esm/date/tests/getDate.test.js

@@ -0,0 +1,158 @@
+import timezoneMock from 'timezone-mock';
+import getTimeZoned, { timeZoneLondon } from '../getTimeZoned';
+import getDate from '../getDate';
+import format from '../format';
+test('getDate - 2024-05-20T15:52:12.673Z (string)', () => {
+    const parsed = format({
+        dateFormat: 'yyyy-MM-dd HH:mm:ss',
+        input: `2024-05-20T15:52:12.673Z`,
+        setMidnight: false,
+    });
+    const expected = '2024-05-20 15:52:12';
+    console.log('parsed', parsed);
+    expect(parsed)
+        .toBe(expected);
+});
+test('getDate - 2024-04-30 (string)', () => {
+    const parsed = format({
+        input: `2024-04-30`,
+        setMidnight: true,
+    });
+    const expected = '2024-04-30';
+    expect(parsed)
+        .toBe(expected);
+});
+test('getDate - 20210201 (number)', () => {
+    let expected = new Date('2021-02-01 00:00:00');
+    expected = getTimeZoned({
+        input: expected
+    });
+    const parsed = getDate({
+        input: 20210201,
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+/**
+test('getDate - 20210601 (string)', () =>
+{
+    let expected = new Date('2021-06-01 00:00:00');
+    expected = getTimeZoned({
+        input: expected
+    });
+
+    const parsed = getDate({
+        input: '20210601'
+    });
+
+    expect(parsed)
+    .toMatchObject(expected);
+
+});*/
+test('getDate - 2021-06-01 01:02:03 (string)', () => {
+    let expected = new Date('2021-06-01 01:02:03');
+    expected = getTimeZoned({
+        input: expected
+    });
+    const parsed = getDate({
+        input: '2021-06-01 01:02:03',
+        setMidnight: false
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - UTC (October to March)', () => {
+    let expected = new Date('2021-02-01 00:00:00');
+    expected = getTimeZoned({ input: expected });
+    const parsed = getDate({
+        input: '2021-02-01 00:00:00',
+        setMidnight: false,
+    });
+    expect(expected)
+        .toMatchObject(parsed);
+});
+test('getDate - DST (March to October)', () => {
+    let expected = new Date('2021-03-01 01:02:03');
+    expected = getTimeZoned({ input: expected });
+    const parsed = getDate({
+        input: '2021-03-01 01:02:03',
+        setMidnight: false,
+    });
+    // console.log('expected = ', expected);
+    // console.log('parsed = ', parsed);
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - Korean Standard Time', () => {
+    let expected = new Date('2017-03-11 02:30:00');
+    expected = getTimeZoned({ input: expected });
+    const parsed = getDate({
+        input: 'Sat Mar 11 2017 11:30:00 GMT+0900 (KST)',
+        setMidnight: false,
+    });
+    // console.log('expected = ', expected);
+    // console.log('parsed = ', parsed);
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - Zulu', () => {
+    let expected = new Date('2022-03-17 19:56:44');
+    expected = getTimeZoned({ input: expected });
+    const parsed = getDate({
+        input: '2022-03-17T19:56:44Z',
+        setMidnight: false,
+    });
+    // console.log('expected = ', expected);
+    // console.log('parsed = ', parsed);
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - timezone - US', () => {
+    let expected = new Date('2021-02-01 00:00:00');
+    timezoneMock.register('US/Pacific');
+    const parsed = getDate({
+        input: 20210201,
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+// https://www.worldtimebuddy.com/
+test('getDate - timezone - UK with time', () => {
+    timezoneMock.register('Europe/London');
+    let expected = new Date('2021-02-01 10:05:20');
+    const parsed = getDate({
+        input: '2021-02-01 10:05:20',
+        setMidnight: false,
+        setTimeZone: timeZoneLondon,
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - timezone - US with time', () => {
+    let expected = '2021-02-01 18:05:20';
+    timezoneMock.register('US/Pacific');
+    let parsed = format({
+        input: '2021-02-01 02:05:20',
+        dateFormat: 'yyyy-MM-dd HH:mm:ss',
+        setMidnight: false,
+        setTimeZone: timeZoneLondon,
+    });
+    expect(parsed)
+        .toMatch(expected);
+});
+test('getDate - timezone - US with time - change of dates', () => {
+    let expected = new Date();
+    expected.setUTCDate(1);
+    expected.setFullYear(2021);
+    expected.setUTCMonth(1);
+    expected.setUTCDate(2);
+    expected.setUTCHours(1, 5, 20, 0);
+    timezoneMock.register('US/Pacific');
+    let parsed = getDate({
+        input: '2021-02-02 09:05:20',
+        setMidnight: false,
+        setTimeZone: timeZoneLondon,
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});

package/dist/esm/date/tests/getDateMore.test.d.ts

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

package/dist/esm/date/tests/getDateMore.test.js

@@ -0,0 +1,30 @@
+import getDate from '../getDate';
+test('getDate - 2022-04-18', () => {
+    let expected = new Date('2022-04-18 01:00:00');
+    let parsed = getDate({ input: '2022-04-18' });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - 2022-04-18 12:34:56', () => {
+    let expected = new Date('2022-04-18 13:34:56');
+    let parsed = getDate({
+        input: '2022-04-18 12:34:56',
+        setMidnight: false
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - 2024-06-02', () => {
+    let expected = new Date();
+    expected.setUTCDate(1);
+    expected.setFullYear(2024);
+    expected.setUTCMonth(5);
+    expected.setUTCDate(2);
+    expected.setUTCHours(0, 0, 0, 0);
+    let parsed = getDate({
+        input: '2024-06-02',
+        setMidnight: true,
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});

package/dist/esm/date/tests/getDatesBetween.test.d.ts

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

package/dist/esm/date/tests/getDatesBetween.test.js

@@ -0,0 +1,53 @@
+import getDate from "../getDate";
+import getDatesBetween from "../getDatesBetween";
+test("getDatesBetween - Date input", () => {
+    const start = getDate({ input: "2022-10-07" });
+    const end = getDate({ input: "2022-10-10" });
+    //	console.log("getDate({input: '2022-10-07'})", getDate({input: '2022-10-07'}));
+    let expected = [
+        getDate({ input: "2022-10-07" }),
+        getDate({ input: "2022-10-08" }),
+        getDate({ input: "2022-10-09" }),
+        getDate({ input: "2022-10-10" }),
+    ];
+    let parsed = getDatesBetween({ end, start });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test("getDatesBetween - String input", () => {
+    let expected = [
+        getDate({ input: "2022-10-07" }),
+        getDate({ input: "2022-10-08" }),
+        getDate({ input: "2022-10-09" }),
+        getDate({ input: "2022-10-10" }),
+    ];
+    let parsed = getDatesBetween({
+        end: "2022-10-10",
+        start: "2022-10-07",
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test("getDatesBetween - String input", () => {
+    let expected = [
+        getDate({
+            input: "2022-02-02",
+            setMidnight: true,
+        }),
+        getDate({
+            input: "2022-02-03",
+            setMidnight: true,
+        }),
+        getDate({
+            input: "2022-02-04",
+            setMidnight: true,
+        }),
+        getDate({
+            input: "2022-02-05",
+            setMidnight: true,
+        }),
+    ];
+    let parsed = getDatesBetween({ end: "2022-02-05", start: "2022-02-02" });
+    expect(parsed)
+        .toMatchObject(expected);
+});

package/dist/esm/date/tests/getFinancialYear.test.d.ts

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

package/dist/esm/date/tests/getFinancialYear.test.js

@@ -0,0 +1,20 @@
+import format from '../format';
+import getFinancialYearWeeks from '../getFinancialYearWeeks';
+test('getFinancialYearWeeks - 2021', () => {
+    const financialWeeks = getFinancialYearWeeks({ year: 2021 });
+    const output = {
+        start: format({ input: financialWeeks[0].start }),
+        end: format({ input: financialWeeks[0].end }),
+    };
+    const expected = {
+        start: format({ input: new Date('2021-03-29 00:00:00') }),
+        end: format({ input: new Date('2021-04-04 00:00:00') }),
+    };
+    //console.log('financialWeeks', financialWeeks);
+    // console.log('output', output);
+    // console.log('expected', expected);
+    expect(output.start)
+        .toBe(expected.start);
+    expect(output.end)
+        .toBe(expected.end);
+});

package/dist/esm/date/tests/getNumber.test.d.ts

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

package/dist/esm/date/tests/getNumber.test.js

@@ -0,0 +1,7 @@
+import getNumber from '../getNumber';
+test('getNumber', () => {
+    const expected = 20210201;
+    const parsed = getNumber({ input: new Date('2021-02-01 00:00:00') });
+    expect(parsed)
+        .toBe(expected);
+});

package/dist/esm/date/tests/timezone-issue.test.d.ts

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

package/dist/esm/date/tests/timezone-issue.test.js

@@ -0,0 +1,17 @@
+import getMonday from "../getMonday";
+import getDate from "../getDate";
+test("timezone date", () => {
+    const expected = getDate({
+        input: "2024-04-29T00:00:00.000Z",
+        isUtc: true,
+        setMidnight: true,
+    });
+    // console.log('expected', expected);
+    const parsed = getMonday({
+        weeksAgo: 0,
+        setMidnight: true,
+    });
+    // console.log('parsed', parsed);
+    expect(parsed)
+        .toMatchObject(expected);
+});

package/dist/esm/environment/getEnvironment.d.ts

@@ -0,0 +1,6 @@
+import { Environment } from './';
+/**
+ * Determine the environment we're using.
+ */
+declare const getEnvironment: () => Environment;
+export default getEnvironment;