@8ms/helpers 1.39.0 → 1.40.1

package/dist/crud/index.mjs

@@ -0,0 +1,10 @@
+//#region src/crud/index.ts
+let Action = /* @__PURE__ */ function(Action) {
+	Action["CREATE"] = "CREATE";
+	Action["READ"] = "READ";
+	Action["UPDATE"] = "UPDATE";
+	Action["DELETE"] = "DELETE";
+	return Action;
+}({});
+//#endregion
+export { Action };

package/dist/crypto/getDecrypt.d.mts

@@ -0,0 +1,16 @@
+//#region src/crypto/getDecrypt.d.ts
+/**
+ * Decrypt an encoding string using a salt
+ * Library: crypto-js
+ */
+declare const getDecrypt: ({
+  appSalt,
+  input,
+  salt
+}: {
+  appSalt: string;
+  input: string;
+  salt: string;
+}) => string;
+//#endregion
+export { getDecrypt as default };

package/dist/crypto/getDecrypt.mjs

@@ -0,0 +1,13 @@
+import { t as __require } from "../chunk-y_GBKt04.mjs";
+//#region src/crypto/getDecrypt.ts
+/**
+* Decrypt an encoding string using a salt
+* Library: crypto-js
+*/
+const getDecrypt = ({ appSalt, input, salt }) => {
+	const { AES, enc } = __require("crypto-js");
+	const customSalt = `${appSalt}-${salt}`;
+	return AES.decrypt(input, customSalt).toString(enc.Utf8);
+};
+//#endregion
+export { getDecrypt as default };

package/dist/crypto/getEncrypt.d.mts

@@ -0,0 +1,16 @@
+//#region src/crypto/getEncrypt.d.ts
+/**
+ * Encrypt an encoding string using a salt
+ * Library: crypto-js
+ */
+declare const getEncrypt: ({
+  appSalt,
+  input,
+  salt
+}: {
+  appSalt: string;
+  input: string;
+  salt: string;
+}) => string;
+//#endregion
+export { getEncrypt as default };

package/dist/crypto/getEncrypt.mjs

@@ -0,0 +1,13 @@
+import { t as __require } from "../chunk-y_GBKt04.mjs";
+//#region src/crypto/getEncrypt.ts
+/**
+* Encrypt an encoding string using a salt
+* Library: crypto-js
+*/
+const getEncrypt = ({ appSalt, input, salt }) => {
+	const { AES } = __require("crypto-js");
+	const customSalt = `${appSalt}-${salt}`;
+	return AES.encrypt(input, customSalt).toString();
+};
+//#endregion
+export { getEncrypt as default };

package/dist/crypto/getRandom.d.mts

@@ -0,0 +1,12 @@
+//#region src/crypto/getRandom.d.ts
+/**
+ * Create a random string and return a number of characters from it.
+ * Library: crypto-js
+ */
+declare const getRandom: ({
+  length
+}: {
+  length: number;
+}) => string;
+//#endregion
+export { getRandom as default };

package/dist/crypto/getRandom.mjs

@@ -0,0 +1,10 @@
+//#region src/crypto/getRandom.ts
+/**
+* Create a random string and return a number of characters from it.
+* Library: crypto-js
+*/
+const getRandom = ({ length }) => {
+	return Math.random().toString(36).substr(0, length);
+};
+//#endregion
+export { getRandom as default };

package/dist/crypto/getSha256.d.mts

@@ -0,0 +1,12 @@
+//#region src/crypto/getSha256.d.ts
+/**
+ * Encrypt a string using sha256
+ * Library: crypto-js
+ */
+declare const getSha256: ({
+  input
+}: {
+  input: any;
+}) => string;
+//#endregion
+export { getSha256 as default };

package/dist/crypto/getSha256.mjs

@@ -0,0 +1,13 @@
+import { t as __require } from "../chunk-y_GBKt04.mjs";
+import getString from "../string/getString.mjs";
+//#region src/crypto/getSha256.ts
+/**
+* Encrypt a string using sha256
+* Library: crypto-js
+*/
+const getSha256 = ({ input }) => {
+	const { SHA256 } = __require("crypto-js");
+	return SHA256(getString({ input })).toString();
+};
+//#endregion
+export { getSha256 as default };

package/dist/date/format.d.mts

@@ -0,0 +1,13 @@
+import { GetDate } from "./getDate.mjs";
+
+//#region src/date/format.d.ts
+type Format = GetDate & {
+  dateFormat?: string;
+};
+/**
+ * Convert a (number | string | Date) into a "yyyy-MM-dd" string or a specified format.
+ * As the user would be providing the input we don't want to change the timezone typically.
+ */
+declare const format: (props: Format) => string;
+//#endregion
+export { format as default };

package/dist/date/format.mjs

@@ -0,0 +1,17 @@
+import getDate from "./getDate.mjs";
+import { format as format$1 } from "date-fns";
+//#region src/date/format.ts
+/**
+* Convert a (number | string | Date) into a "yyyy-MM-dd" string or a specified format.
+* As the user would be providing the input we don't want to change the timezone typically.
+*/
+const format = (props) => {
+	return format$1(getDate({
+		input: props.input,
+		isUtc: props.isUtc,
+		setMidnight: props?.setMidnight,
+		setTimeZone: props?.setTimeZone
+	}), props?.dateFormat || "yyyy-MM-dd");
+};
+//#endregion
+export { format as default };

package/dist/date/getDate.d.mts

@@ -0,0 +1,17 @@
+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/getDate.d.ts
+type GetDate = GetTimeZoned & GetMidnight & {
+  input: DateType;
+  isUtc?: boolean;
+};
+/**
+ * Convert a (number | string | Date) into a Date object.
+ * As the user would be providing the input we don't want to change the timezone typically.
+ * By default assumption is that the input is UTC, however it can be switched to timezoned time.
+ */
+declare const getDate: (props: GetDate) => Date;
+//#endregion
+export { GetDate, getDate as default };

package/dist/date/getDate.mjs

@@ -0,0 +1,107 @@
+import getMidnight from "./getMidnight.mjs";
+//#region src/date/getDate.ts
+/**
+* Convert a (number | string | Date) into a Date object.
+* As the user would be providing the input we don't want to change the timezone typically.
+* By default assumption is that the input is UTC, however it can be switched to timezoned time.
+*/
+const getDate = (props) => {
+	let date;
+	let isUtc = void 0 === props?.isUtc ? true : props.isUtc;
+	if (props.input instanceof Date) date = new Date(props.input.valueOf());
+	else if ("string" === typeof props.input || "number" === typeof props.input) {
+		const dateString = props.input.toString();
+		const regexes = {
+			ymdDash: /* @__PURE__ */ new RegExp("^[0-9]{4}-[0-9]{2}-[0-9]{2}$"),
+			ymdNumber: /* @__PURE__ */ new RegExp("^[0-9]{8}$"),
+			ymdHisDash: /* @__PURE__ */ new RegExp("^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"),
+			ymdHisNumber: /* @__PURE__ */ new RegExp("^[0-9]{14}$")
+		};
+		if (regexes.ymdNumber.test(dateString)) {
+			const year = Number(dateString.substring(0, 4));
+			const month = Number(dateString.substring(4, 6)) - 1;
+			const day = Number(dateString.substring(6, 8));
+			date = /* @__PURE__ */ new Date();
+			date.setUTCDate(1);
+			date.setUTCHours(1, 0, 0, 0);
+			if (isUtc) {
+				date.setUTCFullYear(year);
+				date.setUTCMonth(month);
+				date.setUTCDate(day);
+				date.setUTCHours(0, 0, 0, 0);
+			} else {
+				date.setFullYear(year);
+				date.setMonth(month);
+				date.setDate(day);
+				date.setHours(0, 0, 0, 0);
+			}
+		} else if (regexes.ymdDash.test(dateString)) {
+			const year = Number(dateString.substring(0, 4));
+			const month = Number(dateString.substring(5, 7)) - 1;
+			const day = Number(dateString.substring(8, 10));
+			date = /* @__PURE__ */ new Date();
+			date.setUTCDate(1);
+			date.setUTCHours(1, 0, 0, 0);
+			if (isUtc) {
+				date.setUTCFullYear(year);
+				date.setUTCMonth(month);
+				date.setUTCDate(day);
+				date.setUTCHours(0, 0, 0, 0);
+			} else {
+				date.setFullYear(year);
+				date.setMonth(month);
+				date.setDate(day);
+				date.setHours(0, 0, 0, 0);
+			}
+		} else if (regexes.ymdHisDash.test(dateString)) {
+			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));
+			date = /* @__PURE__ */ new Date();
+			date.setUTCDate(1);
+			date.setUTCHours(1, 0, 0, 0);
+			if (isUtc) {
+				date.setUTCFullYear(year);
+				date.setUTCMonth(month);
+				date.setUTCDate(day);
+				date.setUTCHours(hours, minutes, seconds);
+			} else {
+				date.setFullYear(year);
+				date.setMonth(month);
+				date.setDate(day);
+				date.setHours(hours, minutes, seconds);
+			}
+		} else if (regexes.ymdHisNumber.test(dateString)) {
+			const year = Number(dateString.substring(0, 4));
+			const month = Number(dateString.substring(4, 6)) - 1;
+			const day = Number(dateString.substring(6, 8));
+			const hours = Number(dateString.substring(8, 10));
+			const minutes = Number(dateString.substring(10, 12));
+			const seconds = Number(dateString.substring(12, 14));
+			date = /* @__PURE__ */ new Date();
+			date.setUTCDate(1);
+			date.setUTCHours(1, 0, 0, 0);
+			if (isUtc) {
+				date.setUTCFullYear(year);
+				date.setUTCMonth(month);
+				date.setUTCDate(day);
+				date.setUTCHours(hours, minutes, seconds);
+			} else {
+				date.setFullYear(year);
+				date.setMonth(month);
+				date.setDate(day);
+				date.setHours(hours, minutes, seconds);
+			}
+		} else date = new Date(dateString);
+	}
+	date = getMidnight({
+		input: date,
+		setMidnight: props?.setMidnight
+	});
+	return date;
+};
+//#endregion
+export { getDate as default };

package/dist/date/getDatesBetween.d.mts

@@ -0,0 +1,16 @@
+import { t as DateType } from "../index-CiGy7MyK.mjs";
+
+//#region src/date/getDatesBetween.d.ts
+type GetDatesBetween = {
+  end: DateType;
+  start: DateType;
+  isUtc?: boolean;
+};
+/**
+ * Similar to date-fns' eachDayOfInterval, however the timezone messes this function up.
+ * https://date-fns.org/v2.28.0/docs/eachDayOfInterval
+ * https://www.gov.uk/when-do-the-clocks-change
+ */
+declare const getDatesBetween: (props: GetDatesBetween) => Date[];
+//#endregion
+export { getDatesBetween as default };

package/dist/date/getDatesBetween.mjs

@@ -0,0 +1,37 @@
+import getDate from "./getDate.mjs";
+import format$1 from "./format.mjs";
+import { addDays, addHours } from "date-fns";
+//#region src/date/getDatesBetween.ts
+/**
+* Similar to date-fns' eachDayOfInterval, however the timezone messes this function up.
+* https://date-fns.org/v2.28.0/docs/eachDayOfInterval
+* https://www.gov.uk/when-do-the-clocks-change
+*/
+const getDatesBetween = (props) => {
+	let response = [];
+	let endDate = getDate({
+		input: props.end,
+		isUtc: props.isUtc
+	});
+	endDate = addHours(endDate, 2);
+	let pointer = getDate({
+		input: format$1({
+			input: props.start,
+			isUtc: props.isUtc
+		}),
+		isUtc: props.isUtc
+	});
+	while (pointer <= endDate) {
+		const entry = getDate({
+			input: pointer,
+			isUtc: props.isUtc,
+			setMidnight: true
+		});
+		response.push(entry);
+		pointer = addDays(pointer, 1);
+		if (pointer.getMonth() >= 2 && pointer.getMonth() < 8 && 0 === pointer.getHours()) pointer = addHours(pointer, 1);
+	}
+	return response;
+};
+//#endregion
+export { getDatesBetween as default };

package/dist/date/getDurationHours.d.mts

@@ -0,0 +1,11 @@
+//#region src/date/getDurationHours.d.ts
+type GetDurationHours = {
+  seconds: number;
+};
+/**
+ * Convert a number of seconds into HH:MM:SS
+ * https://www.codevertiser.com/convert-seconds-to-hours-and-minutes-javascript/
+ */
+declare const getDurationHours: (props: GetDurationHours) => string;
+//#endregion
+export { getDurationHours as default };

package/dist/date/getDurationHours.mjs

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

package/dist/date/getDurationMinutes.d.mts

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

package/dist/date/getDurationMinutes.mjs

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

package/dist/date/getFinancialYear.d.mts

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

package/dist/date/getFinancialYear.mjs

@@ -0,0 +1,31 @@
+import getDate from "./getDate.mjs";
+import getToday from "./getToday.mjs";
+import { isMonday, isSunday, nextSunday, previousMonday } from "date-fns";
+//#region src/date/getFinancialYear.ts
+/**
+* Get the current financial year.
+*/
+const getFinancialYear = (props = {}) => {
+	let financialYear = props.year;
+	if (void 0 === props.year) {
+		const today = getToday();
+		if (today < new Date(today.getFullYear(), 3, 1)) financialYear = today.getFullYear() - 1;
+		else financialYear = today.getFullYear();
+	}
+	let yearEnd = getDate({
+		input: `${financialYear + 1}-03-31`,
+		isUtc: true
+	});
+	let yearStart = getDate({
+		input: `${financialYear}-04-01`,
+		isUtc: true
+	});
+	if (!isMonday(yearStart)) yearStart = previousMonday(yearStart);
+	if (!isSunday(yearEnd)) yearEnd = nextSunday(yearEnd);
+	return {
+		end: yearEnd,
+		start: yearStart
+	};
+};
+//#endregion
+export { getFinancialYear as default };

package/dist/date/getFinancialYearToDate.d.mts

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

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

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

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

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

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

@@ -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/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

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

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

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

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

package/dist/date/getMidnight.mjs

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