@8ms/helpers 1.41.1 → 1.42.0

package/dist/esm/date/getDurationHours.js

@@ -0,0 +1,22 @@
+/**
+ * Convert a number of seconds into HH:MM:SS
+ * https://www.codevertiser.com/convert-seconds-to-hours-and-minutes-javascript/
+ */
+const getDurationHours = (props) => {
+    let response = '00:00:00';
+    if (props.seconds > 0) {
+        const calculated = {
+            hours: Math.floor(props.seconds / 3600),
+            minutes: Math.floor((props.seconds % 3600) / 60),
+            seconds: props.seconds % 60,
+        };
+        const output = {
+            hours: calculated.hours < 10 ? '0' + calculated.hours : calculated.hours,
+            minutes: calculated.minutes < 10 ? '0' + calculated.minutes : calculated.minutes,
+            seconds: calculated.seconds < 10 ? '0' + calculated.seconds : calculated.seconds,
+        };
+        response = `${output.hours}:${output.minutes}:${output.seconds}`;
+    }
+    return response;
+};
+export default getDurationHours;

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

@@ -0,0 +1,9 @@
+type GetDurationMinutes = {
+    seconds: number;
+};
+/**
+ * Convert a number of seconds into MM:SS
+ * https://www.codevertiser.com/convert-seconds-to-hours-and-minutes-javascript/
+ */
+declare const getDurationMinutes: (props: GetDurationMinutes) => string;
+export default getDurationMinutes;

package/dist/esm/date/getDurationMinutes.js

@@ -0,0 +1,20 @@
+/**
+ * Convert a number of seconds into MM:SS
+ * https://www.codevertiser.com/convert-seconds-to-hours-and-minutes-javascript/
+ */
+const getDurationMinutes = (props) => {
+    let response = '00:00';
+    if (props.seconds > 0) {
+        const calculated = {
+            minutes: Math.floor((props.seconds % 3600) / 60),
+            seconds: props.seconds % 60,
+        };
+        const output = {
+            minutes: calculated.minutes < 10 ? '0' + calculated.minutes : calculated.minutes,
+            seconds: calculated.seconds < 10 ? '0' + calculated.seconds : calculated.seconds,
+        };
+        response = `${output.minutes}:${output.seconds}`;
+    }
+    return response;
+};
+export default getDurationMinutes;

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

@@ -0,0 +1,9 @@
+import { FinancialYear } from "./";
+type GetFinancialYearType = {
+    year?: number;
+};
+/**
+ * Get the current financial year.
+ */
+declare const getFinancialYear: (props?: GetFinancialYearType) => FinancialYear;
+export default getFinancialYear;

package/dist/esm/date/getFinancialYear.js

@@ -0,0 +1,47 @@
+import { isMonday, isSunday, nextSunday, previousMonday } from "date-fns";
+import getDate from "./getDate";
+import getToday from "./getToday";
+/**
+ * Get the current financial year.
+ */
+const getFinancialYear = (props = {}) => {
+    // Either use the current year or a specified year
+    let financialYear = props.year;
+    if (undefined === props.year) {
+        // As this isn't provided by the suer, we want to ensure its London timezone
+        const today = getToday();
+        // If today is before 1st of April, then use last year
+        if (today < new Date(today.getFullYear(), 3, 1)) {
+            financialYear = today.getFullYear() - 1;
+        }
+        // On or after 1st of April, use this year
+        else {
+            financialYear = today.getFullYear();
+        }
+    }
+    // The year-end needs to be 31st March next year
+    // We are specifying the date, so don't change the timezone
+    let yearEnd = getDate({
+        input: `${financialYear + 1}-03-31`,
+        isUtc: true,
+    });
+    // The year start needs to be 1st April this year
+    // We are specifying the date, so don't change the timezone
+    let yearStart = getDate({
+        input: `${financialYear}-04-01`,
+        isUtc: true,
+    });
+    // Get the previous Monday if the 1st of April isn't a Monday
+    if (!isMonday(yearStart)) {
+        yearStart = previousMonday(yearStart);
+    }
+    // Get the next Sunday if the 31st of March isn't a Sunday
+    if (!isSunday(yearEnd)) {
+        yearEnd = nextSunday(yearEnd);
+    }
+    return {
+        end: yearEnd,
+        start: yearStart,
+    };
+};
+export default getFinancialYear;

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

@@ -0,0 +1,7 @@
+import { FinancialYear } from './';
+/**
+ * Return the current financial year up to today.
+ * Timezone should always be London based
+ */
+declare const getFinancialYearToDate: () => FinancialYear;
+export default getFinancialYearToDate;

package/dist/esm/date/getFinancialYearToDate.js

@@ -0,0 +1,15 @@
+import getFinancialYear from './getFinancialYear';
+import getToday from './getToday';
+/**
+ * Return the current financial year up to today.
+ * Timezone should always be London based
+ */
+const getFinancialYearToDate = () => {
+    const today = getToday();
+    const thisFinancialYear = getFinancialYear();
+    return {
+        end: today,
+        start: thisFinancialYear.start,
+    };
+};
+export default getFinancialYearToDate;

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

@@ -0,0 +1,7 @@
+import { FinancialYear } from './';
+/**
+ * Return the current financial year up to yesterday.
+ * Timezone should always be London based
+ */
+declare const getFinancialYearToYesterday: () => FinancialYear;
+export default getFinancialYearToYesterday;

package/dist/esm/date/getFinancialYearToYesterday.js

@@ -0,0 +1,15 @@
+import getFinancialYear from './getFinancialYear';
+import getYesterday from './getYesterday';
+/**
+ * Return the current financial year up to yesterday.
+ * Timezone should always be London based
+ */
+const getFinancialYearToYesterday = () => {
+    const yesterday = getYesterday();
+    const thisFinancialYear = getFinancialYear();
+    return {
+        end: yesterday,
+        start: thisFinancialYear.start,
+    };
+};
+export default getFinancialYearToYesterday;

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

@@ -0,0 +1,9 @@
+import { FinancialYearWeekType } from "./";
+type GetFinancialYearWeeks = {
+    year?: number;
+};
+/**
+ * Get the current financial year.
+ */
+declare const getFinancialYearWeeks: (props?: GetFinancialYearWeeks) => FinancialYearWeekType[];
+export default getFinancialYearWeeks;

package/dist/esm/date/getFinancialYearWeeks.js

@@ -0,0 +1,28 @@
+import { addDays, eachWeekOfInterval } from "date-fns";
+import getFinancialYear from "./getFinancialYear";
+import getTimeZoned from "./getTimeZoned";
+/**
+ * Get the current financial year.
+ */
+const getFinancialYearWeeks = (props = {}) => {
+    const financialYear = getFinancialYear({
+        year: props.year
+    });
+    const weeks = eachWeekOfInterval(financialYear, {
+        weekStartsOn: 1
+    });
+    let response = weeks.map((week, index) => {
+        let weekStart = new Date(week.getTime());
+        weekStart = getTimeZoned({ input: weekStart });
+        let weekEnd = addDays(weekStart, 6);
+        weekEnd = getTimeZoned({ input: weekEnd });
+        return {
+            start: weekStart,
+            end: weekEnd,
+            financialWeek: (index + 1),
+            financialYear: props.year,
+        };
+    });
+    return response;
+};
+export default getFinancialYearWeeks;

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

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

package/dist/esm/date/getLastWeek.js

@@ -0,0 +1,29 @@
+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 Last Week.
+ * Creating a date from scratch (no user input), thus needs to be London time.
+ */
+const getLastWeek = ({ setMidnight = true, setTimeZone = timeZoneLondon } = { setMidnight: true, setTimeZone: timeZoneLondon }) => {
+    const sunday = getSunday({
+        weeksAgo: 0,
+        setMidnight,
+        setTimeZone,
+    });
+    const monday = getMonday({
+        weeksAgo: 1,
+        setMidnight,
+        setTimeZone,
+    });
+    return {
+        end: getNumber({
+            input: sunday
+        }),
+        start: getNumber({
+            input: monday
+        }),
+    };
+};
+export default getLastWeek;

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

@@ -0,0 +1,13 @@
+import { DateType } from "./";
+import { GetMidnight } from "./getMidnight";
+import { GetTimeZoned } from "./getTimeZoned";
+type GetMax = GetTimeZoned & GetMidnight & {
+    input: DateType;
+    isUtc: boolean;
+    max: DateType;
+};
+/**
+ * If a given date is beyond the maximum, return the maximum.
+ */
+declare const getMax: (props: GetMax) => Date;
+export default getMax;

package/dist/esm/date/getMax.js

@@ -0,0 +1,19 @@
+import { isAfter } from "date-fns";
+import getDate from "./getDate";
+/**
+ * If a given date is beyond the maximum, return the maximum.
+ */
+const getMax = (props) => {
+    const parsedMax = getDate({
+        input: props.max,
+        isUtc: props.isUtc,
+        setMidnight: props?.setMidnight || true,
+    });
+    const parsedInput = getDate({
+        input: props.input,
+        isUtc: props.isUtc,
+        setMidnight: props?.setMidnight || true,
+    });
+    return isAfter(parsedInput, parsedMax) ? parsedMax : parsedInput;
+};
+export default getMax;

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

@@ -0,0 +1,10 @@
+export type GetMidnight = {
+    setMidnight?: boolean;
+};
+/**
+ * Set a date's time to 0 hours, 0 minutes, 0 seconds, 0 milliseconds
+ */
+declare const getMidnight: (props: GetMidnight & {
+    input: Date;
+}) => Date;
+export default getMidnight;

package/dist/esm/date/getMidnight.js

@@ -0,0 +1,11 @@
+/**
+ * Set a date's time to 0 hours, 0 minutes, 0 seconds, 0 milliseconds
+ */
+const getMidnight = (props) => {
+    let dateInstance = props.input;
+    if (true === props?.setMidnight) {
+        dateInstance.setUTCHours(0, 0, 0, 0);
+    }
+    return dateInstance;
+};
+export default getMidnight;

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

@@ -0,0 +1,13 @@
+import { DateType } from './';
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+type GetMin = GetTimeZoned & GetMidnight & {
+    input: DateType;
+    isUtc: boolean;
+    min: DateType;
+};
+/**
+ * If a given date is before the minimum, return the minimum.
+ */
+declare const getMin: (props: GetMin) => Date;
+export default getMin;

package/dist/esm/date/getMin.js

@@ -0,0 +1,19 @@
+import { isBefore } from 'date-fns';
+import getDate from './getDate';
+/**
+ * If a given date is before the minimum, return the minimum.
+ */
+const getMin = (props) => {
+    const parsedMin = getDate({
+        input: props.min,
+        isUtc: props.isUtc,
+        setMidnight: props?.setMidnight || true,
+    });
+    const parsedInput = getDate({
+        input: props.input,
+        isUtc: props.isUtc,
+        setMidnight: props?.setMidnight || true,
+    });
+    return isBefore(parsedInput, parsedMin) ? parsedMin : parsedInput;
+};
+export default getMin;

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

@@ -0,0 +1,15 @@
+import { DateType } from "./";
+import { GetMidnight } from "./getMidnight";
+import { GetTimeZoned } from "./getTimeZoned";
+type GetMonday = GetTimeZoned & GetMidnight & {
+    input?: DateType;
+    isUtc?: boolean;
+    weeksAgo: number;
+};
+/**
+ * Retrieve the closest last Monday relative to the input or today.
+ * 0 weeksAgo - Tuesday (10th), return Monday (8th)
+ * 1 weeksAgo - Tuesday (10th), return Monday (1st)
+ */
+declare const getMonday: (props: GetMonday) => Date;
+export default getMonday;

package/dist/esm/date/getMonday.js

@@ -0,0 +1,41 @@
+import { getISODay, isMonday, subDays } from "date-fns";
+import getDate from "./getDate";
+import getMidnight from "./getMidnight";
+import getToday from "./getToday";
+/**
+ * Retrieve the closest last Monday relative to the input or today.
+ * 0 weeksAgo - Tuesday (10th), return Monday (8th)
+ * 1 weeksAgo - Tuesday (10th), return Monday (1st)
+ */
+const getMonday = (props) => {
+    let dateInstance;
+    if (props?.input) {
+        dateInstance = getDate({
+            input: props.input,
+            isUtc: props.isUtc,
+            setMidnight: false,
+        });
+    }
+    else {
+        // As we are getting today's date we don't want to convert this timezone
+        dateInstance = getToday({
+            setMidnight: false,
+        });
+        //		console.log('dateInstance', dateInstance);
+    }
+    if (!isMonday(dateInstance)) {
+        // Get the ISO Day of week (Monday - 1 to Sunday - 7)
+        const isoDay = getISODay(dateInstance);
+        // Move back to Monday
+        dateInstance = subDays(dateInstance, isoDay - 1);
+    }
+    // Move it back a given number of weeks
+    dateInstance = subDays(dateInstance, 7 * props.weeksAgo);
+    //	console.log('dateInstance', dateInstance);
+    dateInstance = getMidnight({
+        input: dateInstance,
+        setMidnight: props.setMidnight,
+    });
+    return dateInstance;
+};
+export default getMonday;

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

@@ -0,0 +1,7 @@
+import { GetDate } from "./getDate";
+type GetNumber = GetDate;
+/**
+ * Convert a (number | string | Date) into a YYYYMMDD number.
+ */
+declare const getNumber: (props: GetNumber) => number;
+export default getNumber;

package/dist/esm/date/getNumber.js

@@ -0,0 +1,15 @@
+import { format } from "date-fns";
+import getDate from "./getDate";
+/**
+ * Convert a (number | string | Date) into a YYYYMMDD number.
+ */
+const getNumber = (props) => {
+    let date = getDate({
+        input: props.input,
+        isUtc: props.isUtc,
+        setMidnight: props.setMidnight,
+        setTimeZone: props.setTimeZone,
+    });
+    return Number(format(date, "yyyyMMdd"));
+};
+export default getNumber;

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

@@ -0,0 +1,8 @@
+import { PredefinedTimeframe, Timeframe } from "./";
+/**
+ * Check to see the date matches a predefined time frame
+ */
+declare const getPredefinedTimeframe: ({ timeframe }: {
+    timeframe: Timeframe;
+}) => PredefinedTimeframe;
+export default getPredefinedTimeframe;

package/dist/esm/date/getPredefinedTimeframe.js

@@ -0,0 +1,19 @@
+import isLastWeek from "./isLastWeek";
+import isThisWeek from "./isThisWeek";
+import { PredefinedTimeframe } from "./";
+/**
+ * Check to see the date matches a predefined time frame
+ */
+const getPredefinedTimeframe = ({ timeframe }) => {
+    let response = PredefinedTimeframe.CUSTOM;
+    // If the selected date matches last week
+    if (isLastWeek(timeframe)) {
+        response = PredefinedTimeframe.LAST_WEEK;
+    }
+    // If the selected date matches this week
+    else if (isThisWeek(timeframe)) {
+        response = PredefinedTimeframe.THIS_WEEK;
+    }
+    return response;
+};
+export default getPredefinedTimeframe;

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

@@ -0,0 +1,15 @@
+import { DateType } from "./";
+import { GetMidnight } from "./getMidnight";
+import { GetTimeZoned } from "./getTimeZoned";
+type GetSunday = GetTimeZoned & GetMidnight & {
+    input?: DateType;
+    isUtc?: boolean;
+    weeksAgo: number;
+};
+/**
+ * Retrieve the closest last Sunday relative to the input or today.
+ * 0 weeksAgo - Tuesday (17th), return Sunday (14th)
+ * 1 weeksAgo - Tuesday (17th), return Monday (7th)
+ */
+declare const getSunday: (props: GetSunday) => Date;
+export default getSunday;

package/dist/esm/date/getSunday.js

@@ -0,0 +1,37 @@
+import { getISODay } from "date-fns";
+import { isSunday } from "date-fns";
+import { subDays } from "date-fns";
+import getDate from "./getDate";
+import getToday from "./getToday";
+/**
+ * Retrieve the closest last Sunday relative to the input or today.
+ * 0 weeksAgo - Tuesday (17th), return Sunday (14th)
+ * 1 weeksAgo - Tuesday (17th), return Monday (7th)
+ */
+const getSunday = (props) => {
+    let dateInstance;
+    if (props?.input) {
+        dateInstance = getDate({
+            input: props.input,
+            isUtc: props.isUtc,
+            setMidnight: props.setMidnight,
+            setTimeZone: props.setTimeZone,
+        });
+    }
+    else {
+        // As we are getting today's date we don't want to convert this timezone
+        dateInstance = getToday({
+            setTimeZone: props.setTimeZone,
+        });
+    }
+    if (!isSunday(dateInstance)) {
+        // Get the ISO Day of week (Monday - 1 to Sunday - 7)
+        const isoDay = getISODay(dateInstance);
+        // Move back to Monday
+        dateInstance = subDays(dateInstance, isoDay);
+    }
+    // Move it back a given number of weeks
+    dateInstance = subDays(dateInstance, 7 * props.weeksAgo);
+    return dateInstance;
+};
+export default getSunday;

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

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

package/dist/esm/date/getThisWeek.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 This Week.
+ * Creating a date from scratch (no user input), thus needs to be London time.
+ */
+const getThisWeek = ({ setMidnight = true, setTimeZone = timeZoneLondon } = { setMidnight: true, setTimeZone: timeZoneLondon }) => {
+    const sunday = getSunday({
+        weeksAgo: -1,
+        setMidnight,
+        setTimeZone,
+    });
+    const monday = getMonday({
+        weeksAgo: 0,
+        setMidnight,
+        setTimeZone,
+    });
+    return {
+        end: getNumber({
+            input: sunday,
+            isUtc: true,
+        }),
+        start: getNumber({
+            input: monday,
+            isUtc: true,
+        }),
+    };
+};
+export default getThisWeek;

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

@@ -0,0 +1,13 @@
+export type GetTimeZoned = {
+    setTimeZone?: string | false;
+};
+export declare const timeZoneLondon = "Europe/London";
+/**
+ * Convert an input into a given timezone.
+ * We can't use getDate here as it becomes a circular issue.
+ * Returns a new Date instance.
+ */
+declare const getTimeZoned: (props: GetTimeZoned & {
+    input: Date;
+}) => Date;
+export default getTimeZoned;

package/dist/esm/date/getTimeZoned.js

@@ -0,0 +1,52 @@
+export const timeZoneLondon = 'Europe/London';
+/**
+ * Convert an input into a given timezone.
+ * We can't use getDate here as it becomes a circular issue.
+ * Returns a new Date instance.
+ */
+const getTimeZoned = (props) => {
+    let dateInstance = props.input;
+    /**
+
+    if (props?.input && 'string' === typeof props.setTimeZone)
+    {
+        // Cannot convert YYYY-MM-DD into new Date as Safari doesn't support this
+        const dateString = formatInTimeZone(
+            dateInstance,
+            props?.setTimeZone,
+            'yyyy-MM-dd HH:mm:ss'
+        );
+
+        const year = Number(dateString.substring(0, 4));
+        const month = Number(dateString.substring(5, 7)) - 1;
+        const day = Number(dateString.substring(8, 10));
+
+        const hours = Number(dateString.substring(11, 13));
+        const minutes = Number(dateString.substring(14, 16));
+        const seconds = Number(dateString.substring(17, 19));
+
+        dateInstance = new Date();
+
+        // Reset the date to the 1st initially at 1am
+        dateInstance.setUTCDate(1);
+        dateInstance.setUTCHours(1, 0, 0, 0);
+
+        dateInstance.setFullYear(year);
+        dateInstance.setUTCMonth(month);
+        dateInstance.setUTCDate(day);
+        dateInstance.setUTCHours(hours, minutes, seconds);
+
+        // console.log('dateInstance', dateInstance);
+        // console.log('dateInstance.getTimezoneOffset()', dateInstance.getTimezoneOffset());
+
+        // Fixes the timezone offset due to daylight savings
+        dateInstance = addMinutes(
+            dateInstance,
+            dateInstance.getTimezoneOffset() * -1
+        );
+    }
+
+    */
+    return dateInstance;
+};
+export default getTimeZoned;

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

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

package/dist/esm/date/getToday.js

@@ -0,0 +1,19 @@
+import getMidnight from "./getMidnight";
+import getTimeZoned from "./getTimeZoned";
+/**
+ * Shortcut to get today's date.
+ * Creating a date from scratch (no user input), thus needs to be London time.
+ */
+const getToday = (props = {}) => {
+    let today = new Date();
+    today = getMidnight({
+        input: today,
+        setMidnight: undefined === props?.setMidnight ? true : props?.setMidnight,
+    });
+    today = getTimeZoned({
+        input: today,
+        setTimeZone: undefined === props?.setTimeZone ? undefined : props?.setTimeZone,
+    });
+    return today;
+};
+export default getToday;

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

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