@8ms/helpers 1.42.3 → 1.42.6

package/dist/date/getToday.cjs

@@ -0,0 +1,21 @@
+const require_date_getMidnight = require("./getMidnight.cjs");
+const require_date_getTimeZoned = require("./getTimeZoned.cjs");
+//#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 = require_date_getMidnight({
+		input: today,
+		setMidnight: void 0 === props?.setMidnight ? true : props?.setMidnight
+	});
+	today = require_date_getTimeZoned.default({
+		input: today,
+		setTimeZone: void 0 === props?.setTimeZone ? void 0 : props?.setTimeZone
+	});
+	return today;
+};
+//#endregion
+module.exports = getToday;

package/dist/date/getToday.d.cts

@@ -0,0 +1,11 @@
+import { GetMidnight } from "./getMidnight.cjs";
+import { GetTimeZoned } from "./getTimeZoned.cjs";
+
+//#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;
+export = getToday;

package/dist/date/getToday.d.mts

@@ -0,0 +1,12 @@
+import { GetMidnight } from "./getMidnight.mjs";
+import { GetTimeZoned } from "./getTimeZoned.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.cjs

@@ -0,0 +1,16 @@
+const require_date_format = require("./format.cjs");
+const require_date_getToday = require("./getToday.cjs");
+//#region src/date/getTodayYmd.ts
+/**
+* Shorthand to get the current date.
+*/
+const getTodayYmd = () => {
+	return require_date_format({
+		input: require_date_getToday({ setMidnight: false }),
+		isUtc: true,
+		dateFormat: "yyyy-MM-dd",
+		setMidnight: false
+	});
+};
+//#endregion
+module.exports = getTodayYmd;

package/dist/date/getTodayYmd.d.cts

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

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.cjs

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

package/dist/date/getTodayYmdhis.d.cts

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

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.cjs

@@ -0,0 +1,36 @@
+const require_date_getNumber = require("./getNumber.cjs");
+const require_date_getTimeZoned = require("./getTimeZoned.cjs");
+const require_date_getMonday = require("./getMonday.cjs");
+const require_date_getSunday = require("./getSunday.cjs");
+//#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 = require_date_getTimeZoned.timeZoneLondon } = {
+	setMidnight: true,
+	setTimeZone: require_date_getTimeZoned.timeZoneLondon
+}) => {
+	const sunday = require_date_getSunday({
+		weeksAgo: 1,
+		setMidnight,
+		setTimeZone
+	});
+	const monday = require_date_getMonday({
+		weeksAgo: 2,
+		setMidnight,
+		setTimeZone
+	});
+	return {
+		end: require_date_getNumber({
+			input: sunday,
+			isUtc: true
+		}),
+		start: require_date_getNumber({
+			input: monday,
+			isUtc: true
+		})
+	};
+};
+//#endregion
+module.exports = getTwoWeeksAgo;

package/dist/date/getTwoWeeksAgo.d.cts

@@ -0,0 +1,15 @@
+import { Timeframe } from "./index.cjs";
+import { GetMidnight } from "./getMidnight.cjs";
+import { GetTimeZoned } from "./getTimeZoned.cjs";
+
+//#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;
+export = getTwoWeeksAgo;

package/dist/date/getTwoWeeksAgo.d.mts

@@ -0,0 +1,16 @@
+import { Timeframe } from "./index.mjs";
+import { GetMidnight } from "./getMidnight.mjs";
+import { GetTimeZoned } from "./getTimeZoned.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.cjs

@@ -0,0 +1,23 @@
+require("../_virtual/_rolldown/runtime.cjs");
+const require_date_getDate = require("./getDate.cjs");
+const require_date_getNumber = require("./getNumber.cjs");
+let date_fns = require("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 = require_date_getDate({
+		input,
+		isUtc,
+		setMidnight,
+		setTimeZone
+	});
+	dateInstance = (0, date_fns.sub)(dateInstance, { weeks: weeksAgo });
+	return require_date_getNumber({
+		input: dateInstance,
+		isUtc
+	});
+};
+//#endregion
+module.exports = getWeeksAgo;

package/dist/date/getWeeksAgo.d.cts

@@ -0,0 +1,21 @@
+import { DateType } from "./index.cjs";
+import { GetTimeZoned } from "./getTimeZoned.cjs";
+
+//#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;
+export = getWeeksAgo;

package/dist/date/getWeeksAgo.d.mts

@@ -0,0 +1,22 @@
+import { DateType } from "./index.mjs";
+import { GetTimeZoned } from "./getTimeZoned.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.cjs

@@ -0,0 +1,25 @@
+require("../_virtual/_rolldown/runtime.cjs");
+const require_date_getTimeZoned = require("./getTimeZoned.cjs");
+const require_date_getToday = require("./getToday.cjs");
+let date_fns = require("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 = require_date_getTimeZoned.timeZoneLondon } = {
+	setMidnight: true,
+	setTimeZone: require_date_getTimeZoned.timeZoneLondon
+}) => {
+	let yesterday = (0, date_fns.subDays)(require_date_getToday({
+		setMidnight,
+		setTimeZone: false
+	}), 1);
+	yesterday = require_date_getTimeZoned.default({
+		input: yesterday,
+		setTimeZone
+	});
+	return yesterday;
+};
+//#endregion
+module.exports = getYesterday;

package/dist/date/getYesterday.d.cts

@@ -0,0 +1,14 @@
+import { GetMidnight } from "./getMidnight.cjs";
+import { GetTimeZoned } from "./getTimeZoned.cjs";
+
+//#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;
+export = getYesterday;

package/dist/date/getYesterday.d.mts

@@ -0,0 +1,15 @@
+import { GetMidnight } from "./getMidnight.mjs";
+import { GetTimeZoned } from "./getTimeZoned.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.cjs

@@ -0,0 +1,42 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/date/index.ts
+/**
+* When a date isn't specified and we need a value.
+*/
+const defaultDate = "1901-01-01";
+/**
+* When a date time isn't specified and we need a value.
+*/
+const defaultDateTime = "1901-01-01 00:00:00";
+let DurationComparison = /* @__PURE__ */ function(DurationComparison) {
+	DurationComparison["VS_NOW"] = "VS_NOW";
+	DurationComparison["VS_MIDNIGHT"] = "VS_MIDNIGHT";
+	return DurationComparison;
+}({});
+let Interval = /* @__PURE__ */ function(Interval) {
+	Interval["FOREVER"] = "FOREVER";
+	Interval["MONTHS"] = "MONTHS";
+	Interval["DAYS"] = "DAYS";
+	Interval["HOURS"] = "HOURS";
+	Interval["MINUTES"] = "MINUTES";
+	return Interval;
+}({});
+let Timeframes = /* @__PURE__ */ function(Timeframes) {
+	Timeframes["CURRENT"] = "CURRENT";
+	Timeframes["COMPARISON"] = "COMPARISON";
+	return Timeframes;
+}({});
+let PredefinedTimeframe = /* @__PURE__ */ function(PredefinedTimeframe) {
+	PredefinedTimeframe["NONE"] = "NONE";
+	PredefinedTimeframe["CUSTOM"] = "CUSTOM";
+	PredefinedTimeframe["THIS_WEEK"] = "THIS_WEEK";
+	PredefinedTimeframe["LAST_WEEK"] = "LAST_WEEK";
+	return PredefinedTimeframe;
+}({});
+//#endregion
+exports.DurationComparison = DurationComparison;
+exports.Interval = Interval;
+exports.PredefinedTimeframe = PredefinedTimeframe;
+exports.Timeframes = Timeframes;
+exports.defaultDate = defaultDate;
+exports.defaultDateTime = defaultDateTime;

package/dist/date/index.d.cts

@@ -0,0 +1,58 @@
+//#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
+export { DateType, Duration, DurationComparison, FinancialYear, FinancialYearWeekType, Interval, PredefinedTimeframe, Timeframe, Timeframes, defaultDate, defaultDateTime };

package/dist/date/index.d.mts

@@ -0,0 +1,58 @@
+//#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
+export { DateType, Duration, DurationComparison, FinancialYear, FinancialYearWeekType, Interval, PredefinedTimeframe, Timeframe, Timeframes, defaultDate, defaultDateTime };

package/dist/date/index.mjs

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

package/dist/date/isDateValid.cjs

@@ -0,0 +1,17 @@
+require("../_virtual/_rolldown/runtime.cjs");
+let date_fns = require("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 ((0, date_fns.isValid)((0, date_fns.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
+module.exports = isDateValid;