@8ms/helpers 2.3.5 → 2.3.7

package/cache/server/cache.js

@@ -1,43 +0,0 @@
-const cache = new Map();
-export const getCache = (key) => {
-    let response = null;
-    if (cache.has(key)) {
-        const cacheItem = cache.get(key);
-        // Timed expiry
-        if (cacheItem.expires > 0) {
-            // https://ui.dev/get-current-timestamp-javascript
-            const expiresAt = Math.floor(cacheItem.insertedAt / 1000) + cacheItem.expires;
-            const now = Math.floor(Date.now() / 1000);
-            // If we are now beyond the expiry date, update the data
-            if (now < expiresAt) {
-                response = cacheItem;
-            }
-        }
-        // 0 - Never expires
-        else {
-            response = cacheItem;
-        }
-    }
-    return response;
-};
-export const setCache = (key, data, expires = 0, force = false) => {
-    const now = Math.floor(Date.now() / 1000);
-    if (cache.has(key) && !force) {
-        const cacheItem = cache.get(key);
-        // 0 - Never expires
-        if (cacheItem.expires > 0) {
-            // https://ui.dev/get-current-timestamp-javascript
-            const expiresAt = Math.floor(cacheItem.insertedAt / 1000) + cacheItem.expires;
-            // If we are now beyond the expiry date, update the data
-            if (now < expiresAt) {
-                return cacheItem;
-            }
-        }
-    }
-    cache.set(key, {
-        data,
-        expires,
-        insertedAt: now,
-    });
-    return data;
-};

package/cache/server/index.d.ts

@@ -1 +0,0 @@
-export * from "./cache";

package/cache/server/index.js

@@ -1 +0,0 @@
-export * from "./cache";

package/cache/server/test/cache.test.d.ts

@@ -1 +0,0 @@
-export {};

package/cache/server/test/cache.test.js

@@ -1,8 +0,0 @@
-import { getCache, setCache } from "../";
-test("cache", () => {
-    const item1 = getCache("test");
-    // console.log('item1', item1);
-    setCache("test", { "this is something": "item" });
-    const item2 = getCache("test");
-    // console.log('item2', item2);
-});

package/crud/crud.d.ts

@@ -1,7 +0,0 @@
-export declare const crudState: {
-    readonly CREATE: "CREATE";
-    readonly READ: "READ";
-    readonly UPDATE: "UPDATE";
-    readonly DELETE: "DELETE";
-};
-export type CrudState = typeof crudState[keyof typeof crudState];

package/crud/crud.js

@@ -1,6 +0,0 @@
-export const crudState = {
-    CREATE: "CREATE",
-    READ: "READ",
-    UPDATE: "UPDATE",
-    DELETE: "DELETE",
-};

package/crud/index.d.ts

@@ -1 +0,0 @@
-export * from "./crud";

package/crud/index.js

@@ -1 +0,0 @@
-export * from "./crud";

package/crypto/getDecrypt.d.ts

@@ -1,5 +0,0 @@
-/**
- * Decrypt an encoding string using a salt
- * Library: crypto-js
- */
-export declare const getDecrypt: (appSalt: string, input: string, salt: string) => Promise<string>;

package/crypto/getDecrypt.js

@@ -1,10 +0,0 @@
-/**
- * Decrypt an encoding string using a salt
- * Library: crypto-js
- */
-export const getDecrypt = async (appSalt, input, salt) => {
-    const { AES, enc } = await import("crypto-js");
-    const customSalt = `${appSalt}-${salt}`;
-    return AES.decrypt(input, customSalt)
-        .toString(enc.Utf8);
-};

package/crypto/getEncrypt.d.ts

@@ -1,5 +0,0 @@
-/**
- * Encrypt an encoding string using a salt
- * Library: crypto-js
- */
-export declare const getEncrypt: (appSalt: string, input: string, salt: string) => Promise<string>;

package/crypto/getEncrypt.js

@@ -1,10 +0,0 @@
-/**
- * Encrypt an encoding string using a salt
- * Library: crypto-js
- */
-export const getEncrypt = async (appSalt, input, salt) => {
-    const { AES } = await import("crypto-js");
-    const customSalt = `${appSalt}-${salt}`;
-    return AES.encrypt(input, customSalt)
-        .toString();
-};

package/crypto/getRandom.d.ts

@@ -1,4 +0,0 @@
-/**
- * Create a random string and return a number of characters from it.
- */
-export declare const getRandom: (length: number) => string;

package/crypto/getRandom.js

@@ -1,8 +0,0 @@
-/**
- * Create a random string and return a number of characters from it.
- */
-export const getRandom = (length) => {
-    return Math.random()
-        .toString(36)
-        .substr(0, length);
-};

package/crypto/getSha256.d.ts

@@ -1,5 +0,0 @@
-/**
- * Encrypt a string using sha256
- * Library: crypto-js
- */
-export declare const getSha256: (input: any) => Promise<string>;

package/crypto/getSha256.js

@@ -1,11 +0,0 @@
-import { getString } from "../string";
-/**
- * Encrypt a string using sha256
- * Library: crypto-js
- */
-export const getSha256 = async (input) => {
-    const { SHA256 } = await import("crypto-js");
-    const inputString = getString(input);
-    return SHA256(inputString)
-        .toString();
-};

package/crypto/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./getDecrypt";
-export * from "./getEncrypt";
-export * from "./getRandom";
-export * from "./getSha256";

package/crypto/index.js

@@ -1,4 +0,0 @@
-export * from "./getDecrypt";
-export * from "./getEncrypt";
-export * from "./getRandom";
-export * from "./getSha256";

package/date/calculation.d.ts

@@ -1,102 +0,0 @@
-import { DateTime } from "luxon";
-import { InputDate, Timeframe } from "./date";
-/**
- * Return unix timestamp in seconds.
- */
-export declare const getUnix: (input?: InputDate) => number;
-/**
- * Assume the input is always UTC.
- *
- * If it's not UTC, it needs to be converted to UTC before being used.
- */
-export declare const getLuxonDate: (input?: InputDate, setMidnight?: boolean) => DateTime<boolean>;
-export declare const isMonday: (input?: InputDate) => boolean;
-export declare const isTuesday: (input?: InputDate) => boolean;
-export declare const isWednesday: (input?: InputDate) => boolean;
-export declare const isThursday: (input?: InputDate) => boolean;
-export declare const isFriday: (input?: InputDate) => boolean;
-export declare const isSaturday: (input?: InputDate) => boolean;
-export declare const isSunday: (input?: InputDate) => boolean;
-/**
- * Determines if a given date falls on a weekend.
- *
- * This function checks whether the day of the week for the provided input corresponds
- * to Saturday or Sunday, where weekday values of 6 and 7 represent Saturday and Sunday, respectively.
- */
-export declare const isWeekend: (input?: InputDate) => boolean;
-/**
- * Calculates the difference in minutes between two provided dates.
- */
-export declare const differenceInMinutes: (start: InputDate, end: InputDate) => number;
-/**
- * Calculates the difference in business days between two dates.
- * Business days are considered as weekdays (Monday to Friday).
- */
-export declare const differenceInBusinessDays: (start: InputDate, end: InputDate) => number;
-/**
- * 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
- */
-export declare const getDatesBetween: (start: InputDate, end: InputDate) => DateTime<true>[];
-/**
- * Get an array of DateTime objects representing the 1st of each month between start and end dates.
- */
-export declare const getMonthsBetween: (start: InputDate, end: InputDate) => DateTime<boolean>[];
-/**
- * If a given date is beyond the maximum, return the maximum.
- */
-export declare const getMax: (input: DateTime, max: DateTime) => DateTime<boolean>;
-/**
- * If a given date is before the minimum, return the minimum.
- */
-export declare const getMin: (input: DateTime, min: DateTime) => DateTime<boolean>;
-/**
- * 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)
- */
-export declare const getMonday: (input?: InputDate, weeksAgo?: number) => DateTime<boolean>;
-/**
- * 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)
- */
-export declare const getSunday: (input?: InputDate, weeksAgo?: number) => DateTime<boolean>;
-/**
- * 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.
- */
-export declare const getLastWeek: () => Timeframe;
-/**
- * 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.
- */
-export declare const getThisWeek: () => Timeframe;
-/**
- * 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.
- */
-export declare const getTwoWeeksAgo: () => Timeframe;
-/**
- * Shortcut to get today's date.
- * Creating a date from scratch (no user input), thus needs to be London time.
- */
-export declare const getToday: (setMidnight?: boolean) => DateTime<boolean>;
-/**
- * From a given input, move the date back X weeksAgo
- */
-export declare const getWeeksAgo: (input?: InputDate, weeksAgo?: number) => DateTime<boolean>;
-/**
- * Shortcut to get yesterday's date.
- * Creating a date from scratch (no user input), thus needs to be London time.
- */
-export declare const getYesterday: (input?: InputDate) => DateTime<boolean>;
-/**
- * Check to see if a given timeframe is This Week.
- */
-export declare const isThisWeek: (start: InputDate, end: InputDate) => boolean;
-/**
- * Check to see if a given timeframe is Last Week.
- */
-export declare const isLastWeek: (start: InputDate, end: InputDate) => boolean;

package/date/calculation.js

@@ -1,272 +0,0 @@
-import { DateTime, Interval } from "luxon";
-/**
- * Return unix timestamp in seconds.
- */
-export const getUnix = (input) => {
-    return getLuxonDate(input)
-        .toUnixInteger();
-};
-/**
- * Assume the input is always UTC.
- *
- * If it's not UTC, it needs to be converted to UTC before being used.
- */
-export const getLuxonDate = (input, setMidnight) => {
-    let instance = DateTime.now()
-        .toUTC();
-    if (input) {
-        if (input instanceof Date) {
-            instance = DateTime.fromJSDate(input, { zone: "utc" });
-        }
-        else if (input instanceof DateTime) {
-            instance = input.toUTC();
-        }
-        else if ("number" === typeof input) {
-            // Handle different numeric formats
-            if (input >= 19000101 && input <= 99991231) {
-                // YYYYMMDD format (e.g., 20231225)
-                const dateStr = input.toString();
-                const year = parseInt(dateStr.substring(0, 4));
-                const month = parseInt(dateStr.substring(4, 6));
-                const day = parseInt(dateStr.substring(6, 8));
-                instance = DateTime.fromObject({ year, month, day }, { zone: "utc" });
-            }
-            else if (input < 10000000000) {
-                // Unix timestamp in seconds
-                instance = DateTime.fromSeconds(input, { zone: "utc" });
-            }
-            else {
-                // Unix timestamp in milliseconds
-                instance = DateTime.fromMillis(input, { zone: "utc" });
-            }
-        }
-        else {
-            instance = DateTime.fromISO(input.toString(), { zone: "utc" });
-            if (!instance.isValid) {
-                instance = DateTime.fromFormat(input.toString(), "yyyy-MM-dd HH:mm:ss", { zone: "utc" });
-            }
-        }
-    }
-    // Ensure the instance is in UTC timezone
-    instance = instance.setZone("utc", { keepLocalTime: false });
-    if (setMidnight) {
-        instance = instance.set({
-            hour: 0,
-            minute: 0,
-            second: 0,
-            millisecond: 0,
-        });
-    }
-    return instance;
-};
-export const isMonday = (input) => {
-    return getLuxonDate(input).weekday === 1;
-};
-export const isTuesday = (input) => {
-    return getLuxonDate(input).weekday === 2;
-};
-export const isWednesday = (input) => {
-    return getLuxonDate(input).weekday === 3;
-};
-export const isThursday = (input) => {
-    return getLuxonDate(input).weekday === 4;
-};
-export const isFriday = (input) => {
-    return getLuxonDate(input).weekday === 6;
-};
-export const isSaturday = (input) => {
-    return getLuxonDate(input).weekday === 6;
-};
-export const isSunday = (input) => {
-    return getLuxonDate(input).weekday === 7;
-};
-/**
- * Determines if a given date falls on a weekend.
- *
- * This function checks whether the day of the week for the provided input corresponds
- * to Saturday or Sunday, where weekday values of 6 and 7 represent Saturday and Sunday, respectively.
- */
-export const isWeekend = (input) => {
-    const luxonDate = getLuxonDate(input);
-    return 6 === luxonDate.weekday || 7 === luxonDate.weekday;
-};
-/**
- * Calculates the difference in minutes between two provided dates.
- */
-export const differenceInMinutes = (start, end) => {
-    const startDate = getLuxonDate(start);
-    const endDate = getLuxonDate(end);
-    return endDate.diff(startDate, "minutes").minutes;
-};
-/**
- * Calculates the difference in business days between two dates.
- * Business days are considered as weekdays (Monday to Friday).
- */
-export const differenceInBusinessDays = (start, end) => {
-    const startDate = getLuxonDate(start);
-    const endDate = getLuxonDate(end);
-    let businessDays = 0;
-    let current = startDate.startOf("day");
-    while (current < endDate.startOf("day")) {
-        // weekday 1-5 are Monday-Friday (business days)
-        if (current.weekday <= 5) {
-            businessDays++;
-        }
-        current = current.plus({ days: 1 });
-    }
-    return businessDays;
-};
-/**
- * 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
- */
-export const getDatesBetween = (start, end) => {
-    const startInstance = getLuxonDate(start);
-    const endInstance = getLuxonDate(end);
-    const response = Interval.fromDateTimes(startInstance.startOf("day"), endInstance.endOf("day"))
-        .splitBy({
-        day: 1
-    })
-        .map(d => d.start);
-    return response;
-};
-/**
- * Get an array of DateTime objects representing the 1st of each month between start and end dates.
- */
-export const getMonthsBetween = (start, end) => {
-    const months = [];
-    const endDate = getLuxonDate(end)
-        .startOf("month");
-    // Start from the 1st of the month containing startDate
-    let current = getLuxonDate(start)
-        .startOf("month");
-    while (current <= endDate) {
-        months.push(current);
-        // Move to next month
-        current = current.plus({ months: 1 });
-    }
-    return months;
-};
-/**
- * If a given date is beyond the maximum, return the maximum.
- */
-export const getMax = (input, max) => {
-    return input > max ? max : input;
-};
-/**
- * If a given date is before the minimum, return the minimum.
- */
-export const getMin = (input, min) => {
-    return input < min ? min : input;
-};
-/**
- * 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)
- */
-export const getMonday = (input, weeksAgo) => {
-    let instance = getLuxonDate(input);
-    if ("Mon" !== instance.toFormat("EEE")) {
-        // Get the ISO Day of week (Monday - 1 to Sunday - 7)
-        const isoDay = Number(instance.toFormat("E")) - 1;
-        instance = instance.minus({ days: isoDay });
-    }
-    // Move it back weeks
-    instance = instance.minus({ weeks: weeksAgo ?? 0 });
-    return instance;
-};
-/**
- * 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)
- */
-export const getSunday = (input, weeksAgo) => {
-    let instance = getLuxonDate(input);
-    if ("Sun" !== instance.toFormat("EEE")) {
-        // Get the ISO Day of week (Monday - 1 to Sunday - 7)
-        const isoDay = Number(instance.toFormat("E"));
-        instance = instance.minus({ days: isoDay });
-    }
-    // Move it back weeks
-    instance = instance.minus({ weeks: weeksAgo ?? 0 });
-    return instance;
-};
-/**
- * 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.
- */
-export const getLastWeek = () => {
-    return {
-        end: getMonday(undefined, 0),
-        start: getSunday(undefined, 1),
-    };
-};
-/**
- * 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.
- */
-export const getThisWeek = () => {
-    return {
-        end: getMonday(undefined, 0),
-        start: getSunday(undefined, -1),
-    };
-};
-/**
- * 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.
- */
-export const getTwoWeeksAgo = () => {
-    return {
-        end: getMonday(undefined, 1),
-        start: getSunday(undefined, 2),
-    };
-};
-/**
- * Shortcut to get today's date.
- * Creating a date from scratch (no user input), thus needs to be London time.
- */
-export const getToday = (setMidnight) => {
-    return getLuxonDate(undefined, setMidnight);
-};
-/**
- * From a given input, move the date back X weeksAgo
- */
-export const getWeeksAgo = (input, weeksAgo) => {
-    let instance = getLuxonDate(input);
-    instance = instance.plus({ weeks: weeksAgo });
-    return instance;
-};
-/**
- * Shortcut to get yesterday's date.
- * Creating a date from scratch (no user input), thus needs to be London time.
- */
-export const getYesterday = (input) => {
-    let instance = getLuxonDate(input);
-    instance = instance.minus({ days: 1 });
-    return instance;
-};
-/**
- * Check to see if a given timeframe is This Week.
- */
-export const isThisWeek = (start, end) => {
-    const inputWeek = {
-        start: getLuxonDate(start),
-        end: getLuxonDate(end),
-    };
-    const thisWeek = getThisWeek();
-    // Day confirms same year and month and day
-    return inputWeek.start.hasSame(thisWeek.start, "day") && inputWeek.end.hasSame(thisWeek.end, "day");
-};
-/**
- * Check to see if a given timeframe is Last Week.
- */
-export const isLastWeek = (start, end) => {
-    const inputWeek = {
-        start: getLuxonDate(start),
-        end: getLuxonDate(end),
-    };
-    const lastWeek = getLastWeek();
-    // Day confirms same year and month and day
-    return inputWeek.start.hasSame(lastWeek.start, "day") && inputWeek.end.hasSame(lastWeek.end, "day");
-};

package/date/date.d.ts

@@ -1,36 +0,0 @@
-import type { DateTime } from "luxon";
-export type InputDate = Date | DateTime | string | number;
-export type FinancialWeek = {
-    end: DateTime;
-    start: DateTime;
-    weekNumber: number;
-    year: number;
-};
-/**
- * A timeframe has a start and an end date.
- */
-export type Timeframe = {
-    end: DateTime;
-    start: DateTime;
-};
-export declare const defaultDate: "1901-01-01";
-export declare const defaultDateNumber: 19010101;
-export declare const defaultDateTime: "1901-01-01 00:00:00";
-/**
- * Used by Google Ads API.
- */
-export declare const month: {
-    readonly JANUARY: "JANUARY";
-    readonly FEBRUARY: "FEBRUARY";
-    readonly MARCH: "MARCH";
-    readonly APRIL: "APRIL";
-    readonly MAY: "MAY";
-    readonly JUNE: "JUNE";
-    readonly JULY: "JULY";
-    readonly AUGUST: "AUGUST";
-    readonly SEPTEMBER: "SEPTEMBER";
-    readonly OCTOBER: "OCTOBER";
-    readonly NOVEMBER: "NOVEMBER";
-    readonly DECEMBER: "DECEMBER";
-};
-export type Month = typeof month[keyof typeof month];

package/date/date.js

@@ -1,20 +0,0 @@
-export const defaultDate = "1901-01-01";
-export const defaultDateNumber = 19010101;
-export const defaultDateTime = "1901-01-01 00:00:00";
-/**
- * Used by Google Ads API.
- */
-export const month = {
-    JANUARY: "JANUARY",
-    FEBRUARY: "FEBRUARY",
-    MARCH: "MARCH",
-    APRIL: "APRIL",
-    MAY: "MAY",
-    JUNE: "JUNE",
-    JULY: "JULY",
-    AUGUST: "AUGUST",
-    SEPTEMBER: "SEPTEMBER",
-    OCTOBER: "OCTOBER",
-    NOVEMBER: "NOVEMBER",
-    DECEMBER: "DECEMBER",
-};

package/date/financialYear.d.ts

@@ -1,19 +0,0 @@
-import { Timeframe } from "./date";
-import { Interval } from "luxon";
-/**
- * Get the financial year based on an optional year.
- */
-export declare const getFinancialYear: (year?: number) => Timeframe;
-/**
- * Return the current financial year up to today.
- */
-export declare const getFinancialYearToDate: () => Timeframe;
-/**
- * Return the current financial year up to yesterday.
- * Timezone should always be London based
- */
-export declare const getFinancialYearToYesterday: () => Timeframe;
-/**
- * Get the current financial year.
- */
-export declare const getFinancialYearWeeks: (year?: number) => Interval<boolean>[];