@8ms/helpers 1.40.6 → 1.40.10

package/dist/date/getFinancialYearToDate.d.mts

@@ -1,10 +0,0 @@
-import { i as FinancialYear } from "../index-CiGy7MyK.mjs";
-
-//#region src/date/getFinancialYearToDate.d.ts
-/**
- * Return the current financial year up to today.
- * Timezone should always be London based
- */
-declare const getFinancialYearToDate: () => FinancialYear;
-//#endregion
-export { getFinancialYearToDate as default };

package/dist/date/getFinancialYearToDate.mjs

@@ -1,15 +0,0 @@
-import getToday from "./getToday.mjs";
-import getFinancialYear from "./getFinancialYear.mjs";
-//#region src/date/getFinancialYearToDate.ts
-/**
-* Return the current financial year up to today.
-* Timezone should always be London based
-*/
-const getFinancialYearToDate = () => {
-	return {
-		end: getToday(),
-		start: getFinancialYear().start
-	};
-};
-//#endregion
-export { getFinancialYearToDate as default };

package/dist/date/getFinancialYearToYesterday.d.mts

@@ -1,10 +0,0 @@
-import { i as FinancialYear } from "../index-CiGy7MyK.mjs";
-
-//#region src/date/getFinancialYearToYesterday.d.ts
-/**
- * Return the current financial year up to yesterday.
- * Timezone should always be London based
- */
-declare const getFinancialYearToYesterday: () => FinancialYear;
-//#endregion
-export { getFinancialYearToYesterday as default };

package/dist/date/getFinancialYearToYesterday.mjs

@@ -1,15 +0,0 @@
-import getFinancialYear from "./getFinancialYear.mjs";
-import getYesterday from "./getYesterday.mjs";
-//#region src/date/getFinancialYearToYesterday.ts
-/**
-* Return the current financial year up to yesterday.
-* Timezone should always be London based
-*/
-const getFinancialYearToYesterday = () => {
-	return {
-		end: getYesterday(),
-		start: getFinancialYear().start
-	};
-};
-//#endregion
-export { getFinancialYearToYesterday as default };

package/dist/date/getFinancialYearWeeks.d.mts

@@ -1,12 +0,0 @@
-import { a as FinancialYearWeekType } from "../index-CiGy7MyK.mjs";
-
-//#region src/date/getFinancialYearWeeks.d.ts
-type GetFinancialYearWeeks = {
-  year?: number;
-};
-/**
- * Get the current financial year.
- */
-declare const getFinancialYearWeeks: (props?: GetFinancialYearWeeks) => FinancialYearWeekType[];
-//#endregion
-export { getFinancialYearWeeks as default };

package/dist/date/getFinancialYearWeeks.mjs

@@ -1,23 +0,0 @@
-import getTimeZoned from "./getTimeZoned.mjs";
-import getFinancialYear from "./getFinancialYear.mjs";
-import { addDays, eachWeekOfInterval } from "date-fns";
-//#region src/date/getFinancialYearWeeks.ts
-/**
-* Get the current financial year.
-*/
-const getFinancialYearWeeks = (props = {}) => {
-	return eachWeekOfInterval(getFinancialYear({ year: props.year }), { weekStartsOn: 1 }).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
-		};
-	});
-};
-//#endregion
-export { getFinancialYearWeeks as default };

package/dist/date/getLastWeek.d.mts

@@ -1,16 +0,0 @@
-import { c as Timeframe } from "../index-CiGy7MyK.mjs";
-import { t as GetMidnight } from "../getMidnight-Cr5sAuOj.mjs";
-import { t as GetTimeZoned } from "../getTimeZoned-D7uY_mE6.mjs";
-
-//#region src/date/getLastWeek.d.ts
-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;
-//#endregion
-export { getLastWeek as default };

package/dist/date/getLastWeek.mjs

@@ -1,30 +0,0 @@
-import getNumber from "./getNumber.mjs";
-import { timeZoneLondon } from "./getTimeZoned.mjs";
-import getMonday from "./getMonday.mjs";
-import getSunday from "./getSunday.mjs";
-//#region src/date/getLastWeek.ts
-/**
-* 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 })
-	};
-};
-//#endregion
-export { getLastWeek as default };

package/dist/date/getMax.d.mts

@@ -1,16 +0,0 @@
-import { t as DateType } from "../index-CiGy7MyK.mjs";
-import { t as GetMidnight } from "../getMidnight-Cr5sAuOj.mjs";
-import { t as GetTimeZoned } from "../getTimeZoned-D7uY_mE6.mjs";
-
-//#region src/date/getMax.d.ts
-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;
-//#endregion
-export { getMax as default };

package/dist/date/getMax.mjs

@@ -1,21 +0,0 @@
-import getDate from "./getDate.mjs";
-import { isAfter } from "date-fns";
-//#region src/date/getMax.ts
-/**
-* 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;
-};
-//#endregion
-export { getMax as default };

package/dist/date/getMidnight.d.mts

@@ -1,2 +0,0 @@
-import { n as getMidnight, t as GetMidnight } from "../getMidnight-Cr5sAuOj.mjs";
-export { GetMidnight, getMidnight as default };

package/dist/date/getMidnight.mjs

@@ -1,11 +0,0 @@
-//#region src/date/getMidnight.ts
-/**
-* 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;
-};
-//#endregion
-export { getMidnight as default };

package/dist/date/getMin.d.mts

@@ -1,16 +0,0 @@
-import { t as DateType } from "../index-CiGy7MyK.mjs";
-import { t as GetMidnight } from "../getMidnight-Cr5sAuOj.mjs";
-import { t as GetTimeZoned } from "../getTimeZoned-D7uY_mE6.mjs";
-
-//#region src/date/getMin.d.ts
-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;
-//#endregion
-export { getMin as default };

package/dist/date/getMin.mjs

@@ -1,21 +0,0 @@
-import getDate from "./getDate.mjs";
-import { isBefore } from "date-fns";
-//#region src/date/getMin.ts
-/**
-* 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;
-};
-//#endregion
-export { getMin as default };

package/dist/date/getMonday.d.mts

@@ -1,18 +0,0 @@
-import { t as DateType } from "../index-CiGy7MyK.mjs";
-import { t as GetMidnight } from "../getMidnight-Cr5sAuOj.mjs";
-import { t as GetTimeZoned } from "../getTimeZoned-D7uY_mE6.mjs";
-
-//#region src/date/getMonday.d.ts
-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;
-//#endregion
-export { getMonday as default };

package/dist/date/getMonday.mjs

@@ -1,31 +0,0 @@
-import getMidnight from "./getMidnight.mjs";
-import getDate from "./getDate.mjs";
-import getToday from "./getToday.mjs";
-import { getISODay, isMonday, subDays } from "date-fns";
-//#region src/date/getMonday.ts
-/**
-* 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 dateInstance = getToday({ setMidnight: false });
-	if (!isMonday(dateInstance)) {
-		const isoDay = getISODay(dateInstance);
-		dateInstance = subDays(dateInstance, isoDay - 1);
-	}
-	dateInstance = subDays(dateInstance, 7 * props.weeksAgo);
-	dateInstance = getMidnight({
-		input: dateInstance,
-		setMidnight: props.setMidnight
-	});
-	return dateInstance;
-};
-//#endregion
-export { getMonday as default };

package/dist/date/getNumber.d.mts

@@ -1,10 +0,0 @@
-import { GetDate } from "./getDate.mjs";
-
-//#region src/date/getNumber.d.ts
-type GetNumber = GetDate;
-/**
- * Convert a (number | string | Date) into a YYYYMMDD number.
- */
-declare const getNumber: (props: GetNumber) => number;
-//#endregion
-export { getNumber as default };

package/dist/date/getNumber.mjs

@@ -1,17 +0,0 @@
-import getDate from "./getDate.mjs";
-import { format } from "date-fns";
-//#region src/date/getNumber.ts
-/**
-* 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"));
-};
-//#endregion
-export { getNumber as default };

package/dist/date/getPredefinedTimeframe.d.mts

@@ -1,13 +0,0 @@
-import { c as Timeframe, s as PredefinedTimeframe } from "../index-CiGy7MyK.mjs";
-
-//#region src/date/getPredefinedTimeframe.d.ts
-/**
- * Check to see the date matches a predefined time frame
- */
-declare const getPredefinedTimeframe: ({
-  timeframe
-}: {
-  timeframe: Timeframe;
-}) => PredefinedTimeframe;
-//#endregion
-export { getPredefinedTimeframe as default };

package/dist/date/getPredefinedTimeframe.mjs

@@ -1,15 +0,0 @@
-import isLastWeek from "./isLastWeek.mjs";
-import isThisWeek from "./isThisWeek.mjs";
-import { PredefinedTimeframe } from "./index.mjs";
-//#region src/date/getPredefinedTimeframe.ts
-/**
-* Check to see the date matches a predefined time frame
-*/
-const getPredefinedTimeframe = ({ timeframe }) => {
-	let response = PredefinedTimeframe.CUSTOM;
-	if (isLastWeek(timeframe)) response = PredefinedTimeframe.LAST_WEEK;
-	else if (isThisWeek(timeframe)) response = PredefinedTimeframe.THIS_WEEK;
-	return response;
-};
-//#endregion
-export { getPredefinedTimeframe as default };

package/dist/date/getSunday.d.mts

@@ -1,18 +0,0 @@
-import { t as DateType } from "../index-CiGy7MyK.mjs";
-import { t as GetMidnight } from "../getMidnight-Cr5sAuOj.mjs";
-import { t as GetTimeZoned } from "../getTimeZoned-D7uY_mE6.mjs";
-
-//#region src/date/getSunday.d.ts
-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;
-//#endregion
-export { getSunday as default };

package/dist/date/getSunday.mjs

@@ -1,27 +0,0 @@
-import getDate from "./getDate.mjs";
-import getToday from "./getToday.mjs";
-import { getISODay, isSunday, subDays } from "date-fns";
-//#region src/date/getSunday.ts
-/**
-* 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 dateInstance = getToday({ setTimeZone: props.setTimeZone });
-	if (!isSunday(dateInstance)) {
-		const isoDay = getISODay(dateInstance);
-		dateInstance = subDays(dateInstance, isoDay);
-	}
-	dateInstance = subDays(dateInstance, 7 * props.weeksAgo);
-	return dateInstance;
-};
-//#endregion
-export { getSunday as default };

package/dist/date/getThisWeek.d.mts

@@ -1,16 +0,0 @@
-import { c as Timeframe } from "../index-CiGy7MyK.mjs";
-import { t as GetMidnight } from "../getMidnight-Cr5sAuOj.mjs";
-import { t as GetTimeZoned } from "../getTimeZoned-D7uY_mE6.mjs";
-
-//#region src/date/getThisWeek.d.ts
-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;
-//#endregion
-export { getThisWeek as default };

package/dist/date/getThisWeek.mjs

@@ -1,36 +0,0 @@
-import getNumber from "./getNumber.mjs";
-import { timeZoneLondon } from "./getTimeZoned.mjs";
-import getMonday from "./getMonday.mjs";
-import getSunday from "./getSunday.mjs";
-//#region src/date/getThisWeek.ts
-/**
-* 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
-		})
-	};
-};
-//#endregion
-export { getThisWeek as default };

package/dist/date/getTimeZoned.d.mts

@@ -1,2 +0,0 @@
-import { n as getTimeZoned, r as timeZoneLondon, t as GetTimeZoned } from "../getTimeZoned-D7uY_mE6.mjs";
-export { GetTimeZoned, getTimeZoned as default, timeZoneLondon };

package/dist/date/getTimeZoned.mjs

@@ -1,53 +0,0 @@
-//#region src/date/getTimeZoned.ts
-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) => {
-	/**
-	
-	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 props.input;
-};
-//#endregion
-export { getTimeZoned as default, timeZoneLondon };

package/dist/date/getToday.d.mts

@@ -1,12 +0,0 @@
-import { t as GetMidnight } from "../getMidnight-Cr5sAuOj.mjs";
-import { t as GetTimeZoned } from "../getTimeZoned-D7uY_mE6.mjs";
-
-//#region src/date/getToday.d.ts
-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;
-//#endregion
-export { getToday as default };

package/dist/date/getToday.mjs

@@ -1,21 +0,0 @@
-import getMidnight from "./getMidnight.mjs";
-import getTimeZoned from "./getTimeZoned.mjs";
-//#region src/date/getToday.ts
-/**
-* 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 = /* @__PURE__ */ new Date();
-	today = getMidnight({
-		input: today,
-		setMidnight: void 0 === props?.setMidnight ? true : props?.setMidnight
-	});
-	today = getTimeZoned({
-		input: today,
-		setTimeZone: void 0 === props?.setTimeZone ? void 0 : props?.setTimeZone
-	});
-	return today;
-};
-//#endregion
-export { getToday as default };

package/dist/date/getTodayYmd.d.mts

@@ -1,7 +0,0 @@
-//#region src/date/getTodayYmd.d.ts
-/**
- * Shorthand to get the current date.
- */
-declare const getTodayYmd: () => string;
-//#endregion
-export { getTodayYmd as default };

package/dist/date/getTodayYmd.mjs

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

package/dist/date/getTodayYmdhis.d.mts

@@ -1,7 +0,0 @@
-//#region src/date/getTodayYmdhis.d.ts
-/**
- * Shorthand to get the current timestamp.
- */
-declare const getTodayYmdhis: () => string;
-//#endregion
-export { getTodayYmdhis as default };

package/dist/date/getTodayYmdhis.mjs

@@ -1,16 +0,0 @@
-import format from "./format.mjs";
-import getToday from "./getToday.mjs";
-//#region src/date/getTodayYmdhis.ts
-/**
-* Shorthand to get the current timestamp.
-*/
-const getTodayYmdhis = () => {
-	return format({
-		input: getToday({ setMidnight: false }),
-		isUtc: true,
-		dateFormat: "yyyy-MM-dd HH:mm:ss",
-		setMidnight: false
-	});
-};
-//#endregion
-export { getTodayYmdhis as default };

package/dist/date/getTwoWeeksAgo.d.mts

@@ -1,16 +0,0 @@
-import { c as Timeframe } from "../index-CiGy7MyK.mjs";
-import { t as GetMidnight } from "../getMidnight-Cr5sAuOj.mjs";
-import { t as GetTimeZoned } from "../getTimeZoned-D7uY_mE6.mjs";
-
-//#region src/date/getTwoWeeksAgo.d.ts
-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;
-//#endregion
-export { getTwoWeeksAgo as default };

package/dist/date/getTwoWeeksAgo.mjs

@@ -1,36 +0,0 @@
-import getNumber from "./getNumber.mjs";
-import { timeZoneLondon } from "./getTimeZoned.mjs";
-import getMonday from "./getMonday.mjs";
-import getSunday from "./getSunday.mjs";
-//#region src/date/getTwoWeeksAgo.ts
-/**
-* 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
-		})
-	};
-};
-//#endregion
-export { getTwoWeeksAgo as default };