@8ms/helpers 1.39.0 → 2.0.1

package/date/getFinancialYearToYesterday.js

@@ -1,20 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getFinancialYear_1 = __importDefault(require("./getFinancialYear"));
-const getYesterday_1 = __importDefault(require("./getYesterday"));
-/**
- * Return the current financial year up to yesterday.
- * Timezone should always be London based
- */
-const getFinancialYearToYesterday = () => {
-    const yesterday = (0, getYesterday_1.default)();
-    const thisFinancialYear = (0, getFinancialYear_1.default)();
-    return {
-        end: yesterday,
-        start: thisFinancialYear.start,
-    };
-};
-exports.default = getFinancialYearToYesterday;

package/date/getFinancialYearWeeks.d.ts

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

package/date/getFinancialYearWeeks.js

@@ -1,33 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const date_fns_1 = require("date-fns");
-const getFinancialYear_1 = __importDefault(require("./getFinancialYear"));
-const getTimeZoned_1 = __importDefault(require("./getTimeZoned"));
-/**
- * Get the current financial year.
- */
-const getFinancialYearWeeks = (props = {}) => {
-    const financialYear = (0, getFinancialYear_1.default)({
-        year: props.year
-    });
-    const weeks = (0, date_fns_1.eachWeekOfInterval)(financialYear, {
-        weekStartsOn: 1
-    });
-    let response = weeks.map((week, index) => {
-        let weekStart = new Date(week.getTime());
-        weekStart = (0, getTimeZoned_1.default)({ input: weekStart });
-        let weekEnd = (0, date_fns_1.addDays)(weekStart, 6);
-        weekEnd = (0, getTimeZoned_1.default)({ input: weekEnd });
-        return {
-            start: weekStart,
-            end: weekEnd,
-            financialWeek: (index + 1),
-            financialYear: props.year,
-        };
-    });
-    return response;
-};
-exports.default = getFinancialYearWeeks;

package/date/getLastWeek.d.ts

@@ -1,10 +0,0 @@
-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/date/getLastWeek.js

@@ -1,34 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getMonday_1 = __importDefault(require("./getMonday"));
-const getNumber_1 = __importDefault(require("./getNumber"));
-const getSunday_1 = __importDefault(require("./getSunday"));
-const getTimeZoned_1 = require("./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 = getTimeZoned_1.timeZoneLondon } = { setMidnight: true, setTimeZone: getTimeZoned_1.timeZoneLondon }) => {
-    const sunday = (0, getSunday_1.default)({
-        weeksAgo: 0,
-        setMidnight,
-        setTimeZone,
-    });
-    const monday = (0, getMonday_1.default)({
-        weeksAgo: 1,
-        setMidnight,
-        setTimeZone,
-    });
-    return {
-        end: (0, getNumber_1.default)({
-            input: sunday
-        }),
-        start: (0, getNumber_1.default)({
-            input: monday
-        }),
-    };
-};
-exports.default = getLastWeek;

package/date/getMax.d.ts

@@ -1,13 +0,0 @@
-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/date/getMax.js

@@ -1,24 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const date_fns_1 = require("date-fns");
-const getDate_1 = __importDefault(require("./getDate"));
-/**
- * If a given date is beyond the maximum, return the maximum.
- */
-const getMax = (props) => {
-    const parsedMax = (0, getDate_1.default)({
-        input: props.max,
-        isUtc: props.isUtc,
-        setMidnight: props?.setMidnight || true,
-    });
-    const parsedInput = (0, getDate_1.default)({
-        input: props.input,
-        isUtc: props.isUtc,
-        setMidnight: props?.setMidnight || true,
-    });
-    return (0, date_fns_1.isAfter)(parsedInput, parsedMax) ? parsedMax : parsedInput;
-};
-exports.default = getMax;

package/date/getMidnight.d.ts

@@ -1,10 +0,0 @@
-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/date/getMidnight.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * 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;
-};
-exports.default = getMidnight;

package/date/getMin.d.ts

@@ -1,13 +0,0 @@
-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/date/getMin.js

@@ -1,24 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const date_fns_1 = require("date-fns");
-const getDate_1 = __importDefault(require("./getDate"));
-/**
- * If a given date is before the minimum, return the minimum.
- */
-const getMin = (props) => {
-    const parsedMin = (0, getDate_1.default)({
-        input: props.min,
-        isUtc: props.isUtc,
-        setMidnight: props?.setMidnight || true,
-    });
-    const parsedInput = (0, getDate_1.default)({
-        input: props.input,
-        isUtc: props.isUtc,
-        setMidnight: props?.setMidnight || true,
-    });
-    return (0, date_fns_1.isBefore)(parsedInput, parsedMin) ? parsedMin : parsedInput;
-};
-exports.default = getMin;

package/date/getMonday.d.ts

@@ -1,15 +0,0 @@
-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/date/getMonday.js

@@ -1,46 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const date_fns_1 = require("date-fns");
-const getDate_1 = __importDefault(require("./getDate"));
-const getMidnight_1 = __importDefault(require("./getMidnight"));
-const getToday_1 = __importDefault(require("./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 = (0, getDate_1.default)({
-            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 = (0, getToday_1.default)({
-            setMidnight: false,
-        });
-        //		console.log('dateInstance', dateInstance);
-    }
-    if (!(0, date_fns_1.isMonday)(dateInstance)) {
-        // Get the ISO Day of week (Monday - 1 to Sunday - 7)
-        const isoDay = (0, date_fns_1.getISODay)(dateInstance);
-        // Move back to Monday
-        dateInstance = (0, date_fns_1.subDays)(dateInstance, isoDay - 1);
-    }
-    // Move it back a given number of weeks
-    dateInstance = (0, date_fns_1.subDays)(dateInstance, 7 * props.weeksAgo);
-    //	console.log('dateInstance', dateInstance);
-    dateInstance = (0, getMidnight_1.default)({
-        input: dateInstance,
-        setMidnight: props.setMidnight,
-    });
-    return dateInstance;
-};
-exports.default = getMonday;

package/date/getNumber.d.ts

@@ -1,7 +0,0 @@
-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/date/getNumber.js

@@ -1,20 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const date_fns_1 = require("date-fns");
-const getDate_1 = __importDefault(require("./getDate"));
-/**
- * Convert a (number | string | Date) into a YYYYMMDD number.
- */
-const getNumber = (props) => {
-    let date = (0, getDate_1.default)({
-        input: props.input,
-        isUtc: props.isUtc,
-        setMidnight: props.setMidnight,
-        setTimeZone: props.setTimeZone,
-    });
-    return Number((0, date_fns_1.format)(date, "yyyyMMdd"));
-};
-exports.default = getNumber;

package/date/getPredefinedTimeframe.d.ts

@@ -1,8 +0,0 @@
-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/date/getPredefinedTimeframe.js

@@ -1,24 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const isLastWeek_1 = __importDefault(require("./isLastWeek"));
-const isThisWeek_1 = __importDefault(require("./isThisWeek"));
-const _1 = require("./");
-/**
- * Check to see the date matches a predefined time frame
- */
-const getPredefinedTimeframe = ({ timeframe }) => {
-    let response = _1.PredefinedTimeframe.CUSTOM;
-    // If the selected date matches last week
-    if ((0, isLastWeek_1.default)(timeframe)) {
-        response = _1.PredefinedTimeframe.LAST_WEEK;
-    }
-    // If the selected date matches this week
-    else if ((0, isThisWeek_1.default)(timeframe)) {
-        response = _1.PredefinedTimeframe.THIS_WEEK;
-    }
-    return response;
-};
-exports.default = getPredefinedTimeframe;

package/date/getSunday.d.ts

@@ -1,15 +0,0 @@
-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/date/getSunday.js

@@ -1,42 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const date_fns_1 = require("date-fns");
-const date_fns_2 = require("date-fns");
-const date_fns_3 = require("date-fns");
-const getDate_1 = __importDefault(require("./getDate"));
-const getToday_1 = __importDefault(require("./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 = (0, getDate_1.default)({
-            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 = (0, getToday_1.default)({
-            setTimeZone: props.setTimeZone,
-        });
-    }
-    if (!(0, date_fns_2.isSunday)(dateInstance)) {
-        // Get the ISO Day of week (Monday - 1 to Sunday - 7)
-        const isoDay = (0, date_fns_1.getISODay)(dateInstance);
-        // Move back to Monday
-        dateInstance = (0, date_fns_3.subDays)(dateInstance, isoDay);
-    }
-    // Move it back a given number of weeks
-    dateInstance = (0, date_fns_3.subDays)(dateInstance, 7 * props.weeksAgo);
-    return dateInstance;
-};
-exports.default = getSunday;

package/date/getThisWeek.d.ts

@@ -1,10 +0,0 @@
-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/date/getThisWeek.js

@@ -1,36 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getMonday_1 = __importDefault(require("./getMonday"));
-const getNumber_1 = __importDefault(require("./getNumber"));
-const getSunday_1 = __importDefault(require("./getSunday"));
-const getTimeZoned_1 = require("./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 = getTimeZoned_1.timeZoneLondon } = { setMidnight: true, setTimeZone: getTimeZoned_1.timeZoneLondon }) => {
-    const sunday = (0, getSunday_1.default)({
-        weeksAgo: -1,
-        setMidnight,
-        setTimeZone,
-    });
-    const monday = (0, getMonday_1.default)({
-        weeksAgo: 0,
-        setMidnight,
-        setTimeZone,
-    });
-    return {
-        end: (0, getNumber_1.default)({
-            input: sunday,
-            isUtc: true,
-        }),
-        start: (0, getNumber_1.default)({
-            input: monday,
-            isUtc: true,
-        }),
-    };
-};
-exports.default = getThisWeek;

package/date/getTimeZoned.d.ts

@@ -1,13 +0,0 @@
-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/date/getTimeZoned.js

@@ -1,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.timeZoneLondon = void 0;
-exports.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;
-};
-exports.default = getTimeZoned;

package/date/getToday.d.ts

@@ -1,9 +0,0 @@
-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/date/getToday.js

@@ -1,24 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getMidnight_1 = __importDefault(require("./getMidnight"));
-const getTimeZoned_1 = __importDefault(require("./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 = (0, getMidnight_1.default)({
-        input: today,
-        setMidnight: undefined === props?.setMidnight ? true : props?.setMidnight,
-    });
-    today = (0, getTimeZoned_1.default)({
-        input: today,
-        setTimeZone: undefined === props?.setTimeZone ? undefined : props?.setTimeZone,
-    });
-    return today;
-};
-exports.default = getToday;

package/date/getTodayYmd.d.ts

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

package/date/getTodayYmd.js

@@ -1,21 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const format_1 = __importDefault(require("./format"));
-const getToday_1 = __importDefault(require("./getToday"));
-/**
- * Shorthand to get the current date.
- */
-const getTodayYmd = () => {
-    const today = (0, getToday_1.default)({ setMidnight: false });
-    const todayYmd = (0, format_1.default)({
-        input: today,
-        isUtc: true,
-        dateFormat: "yyyy-MM-dd",
-        setMidnight: false,
-    });
-    return todayYmd;
-};
-exports.default = getTodayYmd;

package/date/getTodayYmdhis.d.ts

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

package/date/getTodayYmdhis.js

@@ -1,21 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const format_1 = __importDefault(require("./format"));
-const getToday_1 = __importDefault(require("./getToday"));
-/**
- * Shorthand to get the current timestamp.
- */
-const getTodayYmdhis = () => {
-    const today = (0, getToday_1.default)({ setMidnight: false });
-    const todayYmdhis = (0, format_1.default)({
-        input: today,
-        isUtc: true,
-        dateFormat: 'yyyy-MM-dd HH:mm:ss',
-        setMidnight: false,
-    });
-    return todayYmdhis;
-};
-exports.default = getTodayYmdhis;

package/date/getTwoWeeksAgo.d.ts

@@ -1,10 +0,0 @@
-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;