@8ms/helpers 1.40.0 → 1.40.2

package/dist/date/getMin.mjs

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,53 @@
+//#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

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

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

@@ -0,0 +1,7 @@
+//#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

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

@@ -0,0 +1,7 @@
+//#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

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

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

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

package/dist/date/getWeeksAgo.d.mts

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

package/dist/date/getWeeksAgo.mjs

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

package/dist/date/getYesterday.d.mts

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

package/dist/date/getYesterday.mjs

@@ -0,0 +1,24 @@
+import getTimeZoned, { timeZoneLondon } from "./getTimeZoned.mjs";
+import getToday from "./getToday.mjs";
+import { subDays } from "date-fns";
+//#region src/date/getYesterday.ts
+/**
+* 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
+}) => {
+	let yesterday = subDays(getToday({
+		setMidnight,
+		setTimeZone: false
+	}), 1);
+	yesterday = getTimeZoned({
+		input: yesterday,
+		setTimeZone
+	});
+	return yesterday;
+};
+//#endregion
+export { getYesterday as default };

package/dist/date/index.d.mts

@@ -1,58 +1,2 @@
-//#region src/date/index.d.ts
-/**
- * A date can be either a number (YYYYMMDD), string (YYYY-MM-DD) or Date instance.
- */
-type DateType = number | string | Date;
-/**
- * When a date isn't specified and we need a value.
- */
-declare const defaultDate = "1901-01-01";
-/**
- * When a date time isn't specified and we need a value.
- */
-declare const defaultDateTime = "1901-01-01 00:00:00";
-type Duration = {
-  hours: number;
-  minutes: number;
-  seconds: number;
-};
-declare enum DurationComparison {
-  VS_NOW = "VS_NOW",
-  VS_MIDNIGHT = "VS_MIDNIGHT"
-}
-declare enum Interval {
-  FOREVER = "FOREVER",
-  MONTHS = "MONTHS",
-  DAYS = "DAYS",
-  HOURS = "HOURS",
-  MINUTES = "MINUTES"
-}
-type FinancialYear = {
-  end: Date;
-  start: Date;
-};
-type FinancialYearWeekType = {
-  end: Date;
-  financialWeek: number;
-  financialYear: number;
-  start: Date;
-};
-/**
- * A timeframe has a start and an end date.
- */
-type Timeframe = {
-  end: DateType;
-  start: DateType;
-};
-declare enum Timeframes {
-  CURRENT = "CURRENT",
-  COMPARISON = "COMPARISON"
-}
-declare enum PredefinedTimeframe {
-  NONE = "NONE",
-  CUSTOM = "CUSTOM",
-  THIS_WEEK = "THIS_WEEK",
-  LAST_WEEK = "LAST_WEEK"
-}
-//#endregion
+import { a as FinancialYearWeekType, c as Timeframe, d as defaultDateTime, i as FinancialYear, l as Timeframes, n as Duration, o as Interval, r as DurationComparison, s as PredefinedTimeframe, t as DateType, u as defaultDate } from "../index-CiGy7MyK.mjs";
 export { DateType, Duration, DurationComparison, FinancialYear, FinancialYearWeekType, Interval, PredefinedTimeframe, Timeframe, Timeframes, defaultDate, defaultDateTime };

package/dist/date/isDateValid.d.mts

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

package/dist/date/isDateValid.mjs

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

package/dist/date/isLastWeek.d.mts

@@ -0,0 +1,12 @@
+import { c as Timeframe } from "../index-CiGy7MyK.mjs";
+
+//#region src/date/isLastWeek.d.ts
+/**
+ * Check to see if a given timeframe is Last Week.
+ */
+declare const isLastWeek: ({
+  end,
+  start
+}: Timeframe) => boolean;
+//#endregion
+export { isLastWeek as default };

package/dist/date/isLastWeek.mjs

@@ -0,0 +1,11 @@
+import getLastWeek from "./getLastWeek.mjs";
+//#region src/date/isLastWeek.ts
+/**
+* Check to see if a given timeframe is Last Week.
+*/
+const isLastWeek = ({ end, start }) => {
+	const lastWeek = getLastWeek();
+	return start === lastWeek.start && end === lastWeek.end;
+};
+//#endregion
+export { isLastWeek as default };

package/dist/date/isThisWeek.d.mts

@@ -0,0 +1,12 @@
+import { c as Timeframe } from "../index-CiGy7MyK.mjs";
+
+//#region src/date/isThisWeek.d.ts
+/**
+ * Check to see if a given timeframe is This Week.
+ */
+declare const isThisWeek: ({
+  end,
+  start
+}: Timeframe) => boolean;
+//#endregion
+export { isThisWeek as default };

package/dist/date/isThisWeek.mjs

@@ -0,0 +1,11 @@
+import getThisWeek from "./getThisWeek.mjs";
+//#region src/date/isThisWeek.ts
+/**
+* Check to see if a given timeframe is This Week.
+*/
+const isThisWeek = ({ end, start }) => {
+	const thisWeek = getThisWeek();
+	return start === thisWeek.start && end === thisWeek.end;
+};
+//#endregion
+export { isThisWeek as default };