@8ms/helpers 2.3.4 → 2.3.6

package/date/financialYear.js

@@ -1,78 +0,0 @@
-import { getLuxonDate, getToday, getYesterday } from "./calculation";
-import { Interval } from "luxon";
-/**
- * Get the financial year based on an optional year.
- */
-export const getFinancialYear = (year) => {
-    // Either use the current year or a specified year
-    let financialYear = year;
-    if ("undefined" === typeof year) {
-        const todayInstance = getToday();
-        // If today is before 1st of April, then use last year
-        if (todayInstance < getLuxonDate(`${todayInstance.toFormat("yyyy")}-04-01`)) {
-            financialYear = Number(todayInstance.toFormat("yyyy")) - 1;
-        }
-        // On or after 1st of April, use this year
-        else {
-            financialYear = Number(todayInstance.toFormat("yyyy"));
-        }
-    }
-    // The year start needs to be 1st April this year - if its not a monday we need to shift this to the next monday.
-    let yearStartInstance = getLuxonDate(`${financialYear}-04-01`);
-    // Get the previous Monday if the 1st of April isn't a Monday
-    if ("Mon" !== yearStartInstance.toFormat("EEE")) {
-        // Get the ISO Day of the week (Monday - 1 to Sunday - 7)
-        const dayOfWeek = Number(yearStartInstance.toFormat("E"));
-        // Calculate days to subtract to get to previous Monday
-        const daysToSubtract = dayOfWeek - 1;
-        yearStartInstance = yearStartInstance.minus({ days: daysToSubtract });
-    }
-    // The year-end needs to be 31st March next year
-    // We are specifying the date, so don't change the timezone
-    let yearEndInstance = getLuxonDate(`${(financialYear + 1)}-03-31`);
-    // Get the next Sunday if the 31st of March isn't a Sunday
-    if ("Sun" !== yearEndInstance.toFormat("EEE")) {
-        // Get the ISO Day of the week (Monday - 1 to Sunday - 7)
-        const dayOfWeek = Number(yearEndInstance.toFormat("E"));
-        // Calculate days to add to get to next Sunday
-        const daysToAdd = 7 - dayOfWeek;
-        yearEndInstance = yearEndInstance.plus({ days: daysToAdd });
-    }
-    return {
-        end: yearEndInstance,
-        start: yearStartInstance,
-    };
-};
-/**
- * Return the current financial year up to today.
- */
-export const getFinancialYearToDate = () => {
-    const todayInstance = getToday();
-    const thisFinancialYear = getFinancialYear();
-    return {
-        end: todayInstance,
-        start: thisFinancialYear.start,
-    };
-};
-/**
- * Return the current financial year up to yesterday.
- * Timezone should always be London based
- */
-export const getFinancialYearToYesterday = () => {
-    const yesterdayInstance = getYesterday();
-    const thisFinancialYear = getFinancialYear();
-    return {
-        end: yesterdayInstance,
-        start: thisFinancialYear.start,
-    };
-};
-/**
- * Get the current financial year.
- */
-export const getFinancialYearWeeks = (year) => {
-    const financialYear = getFinancialYear(year);
-    const response = Interval
-        .fromDateTimes(financialYear.start, financialYear.end)
-        .splitBy({ weeks: 1 });
-    return response;
-};

package/date/format.d.ts

@@ -1,85 +0,0 @@
-import { InputDate } from "./date";
-import { DateTime } from "luxon";
-/**
- * Convert a number of seconds into HH:MM:SS
- * https://www.codevertiser.com/convert-seconds-to-hours-and-minutes-javascript/
- */
-export declare const getDurationHours: (seconds: number) => string;
-/**
- * Convert a number of seconds into MM:SS
- * https://www.codevertiser.com/convert-seconds-to-hours-and-minutes-javascript/
- */
-export declare const getDurationMinutes: (seconds: number) => string;
-/**
- * Simple function takes any DateTime, String or Number and formats it.
- */
-export declare const format: (input: InputDate, dateFormat: string) => string;
-/**
- * Convert a Date into a dd number.
- */
-export declare const getDayNumber: (input: InputDate) => number;
-/**
- * Whenever we are displaying a month and year date in Codex, this will be the standardised format.
- * Example: 1901-02-03 → 3 Feb 1901
- */
-export declare const getFullDate: (input: InputDate) => string;
-/**
- * Whenever we are displaying a month and year date in Codex, this will be the standardised format.
- * Example: 1901-02-03 01:23:45 → 1:23am 3 Feb 1901
- */
-export declare const getFullDateTime: (input: InputDate) => string;
-/**
- * Returns a MMM YYYY value as a number for a given year.
- * Example: 1901-02-03 → Feb 1901
- */
-export declare const getMonthYearString: (input: InputDate) => string;
-/**
- * Returns a YYYY MMM value as a number for a given year.
- * Example: 1901-02-03 → 1901 Feb
- */
-export declare const getYearMonthString: (input: InputDate) => string;
-/**
- * Shorthand to get the current date.
- */
-export declare const getTodayYmdString: (setMidnight?: boolean) => string;
-/**
- * Shorthand to get the current date.
- */
-export declare const getTodayYmdHisString: (setMidnight?: boolean) => string;
-/**
- * Shorthand to get the current date.
- */
-export declare const getTodayYmdNumber: (setMidnight?: boolean) => number;
-/**
- * Shorthand to get the current date.
- */
-export declare const getTodayYmdHisNumber: (setMidnight?: boolean) => number;
-/**
- * Convert a Date into a YYYY number.
- */
-export declare const getYearNumber: (input: InputDate) => number;
-/**
- * Returns a YYYYMMDDHHIISS value as a number.
- * Example: 1901-02-03 01:23:45 → 19010203012345
- */
-export declare const getYmdHisNumber: (input: InputDate) => number;
-/**
- * Returns a YYYY-MM-DD HH:MM:SS value as a string.
- * Example: 1901-02-03 → 1901-02-03 00:00:00
- */
-export declare const getYmdHisString: (input: InputDate) => string;
-/**
- * Returns a YYYYMMDD value as a number.
- * Example: 1901-02-03 → 19010203
- */
-export declare const getYmdNumber: (input: InputDate) => number;
-/**
- * Whenever we are displaying a YYYY-MM-DD date in Codex
- * Example: 1901-02-03 → 1901-02-03
- */
-export declare const getYmdString: (input: InputDate) => string;
-/**
- * Convert an Excel date "e.g. 44216" into a JavaScript date object.
- * https://stackoverflow.com/questions/16229494/converting-excel-date-serial-number-to-date-using-javascript
- */
-export declare const getLuxonDateFromExcel: (serial: number) => DateTime<true> | DateTime<false>;

package/date/format.js

@@ -1,160 +0,0 @@
-import { getLuxonDate, getToday } from "./calculation";
-import { DateTime } from "luxon";
-/**
- * Convert a number of seconds into HH:MM:SS
- * https://www.codevertiser.com/convert-seconds-to-hours-and-minutes-javascript/
- */
-export const getDurationHours = (seconds) => {
-    let response = "00:00:00";
-    if (seconds > 0) {
-        const calculated = {
-            hours: Math.floor(seconds / 3600),
-            minutes: Math.floor((seconds % 3600) / 60),
-            seconds: 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;
-};
-/**
- * Convert a number of seconds into MM:SS
- * https://www.codevertiser.com/convert-seconds-to-hours-and-minutes-javascript/
- */
-export const getDurationMinutes = (seconds) => {
-    let response = "00:00";
-    if (seconds > 0) {
-        const calculated = {
-            minutes: Math.floor((seconds % 3600) / 60),
-            seconds: 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;
-};
-/**
- * Simple function takes any DateTime, String or Number and formats it.
- */
-export const format = (input, dateFormat) => {
-    return getLuxonDate(input).toFormat(dateFormat);
-};
-/**
- * Convert a Date into a dd number.
- */
-export const getDayNumber = (input) => {
-    return Number(format(input, "dd"));
-};
-/**
- * Whenever we are displaying a month and year date in Codex, this will be the standardised format.
- * Example: 1901-02-03 → 3 Feb 1901
- */
-export const getFullDate = (input) => {
-    return format(input, "d MMM yyyy");
-};
-/**
- * Whenever we are displaying a month and year date in Codex, this will be the standardised format.
- * Example: 1901-02-03 01:23:45 → 1:23am 3 Feb 1901
- */
-export const getFullDateTime = (input) => {
-    return format(input, "d MMM yyyy h:mm:ss");
-};
-/**
- * Returns a MMM YYYY value as a number for a given year.
- * Example: 1901-02-03 → Feb 1901
- */
-export const getMonthYearString = (input) => {
-    return format(input, "MMM yyyy");
-};
-/**
- * Returns a YYYY MMM value as a number for a given year.
- * Example: 1901-02-03 → 1901 Feb
- */
-export const getYearMonthString = (input) => {
-    return format(input, "yyyy MMM");
-};
-/**
- * Shorthand to get the current date.
- */
-export const getTodayYmdString = (setMidnight) => {
-    const today = getToday(setMidnight);
-    return getYmdString(today);
-};
-/**
- * Shorthand to get the current date.
- */
-export const getTodayYmdHisString = (setMidnight) => {
-    const today = getToday(setMidnight);
-    return getYmdHisString(today);
-};
-/**
- * Shorthand to get the current date.
- */
-export const getTodayYmdNumber = (setMidnight) => {
-    const today = getToday(setMidnight);
-    return getYmdNumber(today);
-};
-/**
- * Shorthand to get the current date.
- */
-export const getTodayYmdHisNumber = (setMidnight) => {
-    const today = getToday(setMidnight);
-    return getYmdHisNumber(today);
-};
-/**
- * Convert a Date into a YYYY number.
- */
-export const getYearNumber = (input) => {
-    return Number(format(input, "yyyy"));
-};
-/**
- * Returns a YYYYMMDDHHIISS value as a number.
- * Example: 1901-02-03 01:23:45 → 19010203012345
- */
-export const getYmdHisNumber = (input) => {
-    return Number(format(input, "yyyyMMddHHmmss"));
-};
-/**
- * Returns a YYYY-MM-DD HH:MM:SS value as a string.
- * Example: 1901-02-03 → 1901-02-03 00:00:00
- */
-export const getYmdHisString = (input) => {
-    return format(input, "yyyy-MM-dd HH:mm:ss");
-};
-/**
- * Returns a YYYYMMDD value as a number.
- * Example: 1901-02-03 → 19010203
- */
-export const getYmdNumber = (input) => {
-    return Number(format(input, "yyyyMMdd"));
-};
-/**
- * Whenever we are displaying a YYYY-MM-DD date in Codex
- * Example: 1901-02-03 → 1901-02-03
- */
-export const getYmdString = (input) => {
-    return format(input, "yyyy-MM-dd");
-};
-/**
- * Convert an Excel date "e.g. 44216" into a JavaScript date object.
- * https://stackoverflow.com/questions/16229494/converting-excel-date-serial-number-to-date-using-javascript
- */
-export const getLuxonDateFromExcel = (serial) => {
-    const utcDates = Math.floor(serial - 25569);
-    const utcValue = utcDates * 86400;
-    const dateInfo = new Date(utcValue * 1000);
-    const fractionalDay = serial - Math.floor(serial) + 0.0000001;
-    let totalSeconds = Math.floor(86400 * fractionalDay);
-    const seconds = totalSeconds % 60;
-    totalSeconds -= seconds;
-    const hours = Math.floor(totalSeconds / (60 * 60));
-    const minutes = Math.floor(totalSeconds / 60) % 60;
-    return DateTime.fromISO(`${dateInfo.getFullYear()}-${dateInfo.getMonth()}-${dateInfo.getDate()}T${hours}:${minutes}:${seconds}Z`);
-};

package/date/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./date";
-export * from "./calculation";
-export * from "./financialYear";
-export * from "./format";

package/date/index.js

@@ -1,4 +0,0 @@
-export * from "./date";
-export * from "./calculation";
-export * from "./financialYear";
-export * from "./format";

package/environment/environment.d.ts

@@ -1,34 +0,0 @@
-export declare const environment: {
-    readonly DEVELOPMENT: "development";
-    readonly STAGING: "staging";
-    readonly PRODUCTION: "production";
-};
-export type Environment = typeof environment[keyof typeof environment];
-export declare const platform: {
-    readonly AWS: "AWS";
-    readonly VERCEL: "VERCEL";
-};
-export type Platform = typeof platform[keyof typeof platform];
-/**
- * Determine the environment we're using.
- */
-export declare const getEnvironment: () => Environment;
-/**
- * Check to see if we are working on AWS Lambda.
- */
-export declare const isAws: () => boolean;
-export declare const isVercel: () => boolean;
-/**
- * Some code should only run on the server side to protect the data.
- */
-export declare const isServer: boolean;
-/**
- * Check the environment currently running.
- */
-export declare const isDevelopment: () => boolean;
-export declare const isStaging: () => boolean;
-export declare const isProduction: () => boolean;
-/**
- * Check to see if we are developing locally or on the hosted platform.
- */
-export declare const isLocalhost: () => boolean;

package/environment/environment.js

@@ -1,79 +0,0 @@
-export const environment = {
-    DEVELOPMENT: "development",
-    STAGING: "staging",
-    PRODUCTION: "production",
-};
-export const platform = {
-    AWS: "AWS",
-    VERCEL: "VERCEL",
-};
-/**
- * Determine the environment we're using.
- */
-export const getEnvironment = () => {
-    let platformEnvironment = process.env.ENVIRONMENT;
-    let response;
-    // Custom - Backend/AWS
-    if (process.env.EMS_ENVIRONMENT) {
-        platformEnvironment = process.env.EMS_ENVIRONMENT;
-    }
-    // Custom - Frontend
-    else if (process.env.NEXT_PUBLIC_EMS_ENVIRONMENT) {
-        platformEnvironment = process.env.NEXT_PUBLIC_EMS_ENVIRONMENT;
-    }
-    // Vercel - Frontend
-    else if (process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF) {
-        platformEnvironment = process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF;
-    }
-    // Vercel - Backend
-    else if (process.env.VERCEL_GIT_COMMIT_REF) {
-        platformEnvironment = process.env.VERCEL_GIT_COMMIT_REF;
-    }
-    const platformEnvironmentClean = platformEnvironment
-        .toLowerCase()
-        .trim();
-    switch (platformEnvironmentClean) {
-        case "production":
-            response = environment.PRODUCTION;
-            break;
-        case "demo":
-        case "preview":
-        case "staging":
-            response = environment.STAGING;
-            break;
-        default:
-            response = environment.DEVELOPMENT;
-    }
-    return response;
-};
-/**
- * Check to see if we are working on AWS Lambda.
- */
-export const isAws = () => platform.AWS === process.env["EMS_PLATFORM"];
-export const isVercel = () => undefined !== process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF;
-/**
- * Some code should only run on the server side to protect the data.
- */
-export const isServer = typeof window === "undefined";
-/**
- * Check the environment currently running.
- */
-export const isDevelopment = () => environment.DEVELOPMENT === getEnvironment();
-export const isStaging = () => environment.STAGING === getEnvironment();
-export const isProduction = () => environment.PRODUCTION === getEnvironment();
-/**
- * Check to see if we are developing locally or on the hosted platform.
- */
-export const isLocalhost = () => {
-    if ("true" === process.env["IS_LOCAL"]) {
-        return true;
-    }
-    if (isAws()) {
-        return "true" === process.env["AWS_SAM_LOCAL"];
-    }
-    // This value needs to only be included in Vercel but undefined in locally
-    if (isVercel()) {
-        return undefined === process.env["NEXT_PUBLIC_VERCEL_GIT_REPO_ID"];
-    }
-    return false;
-};

package/environment/index.d.ts

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

package/environment/index.js

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

package/eskimi/eskimi.d.ts

@@ -1,49 +0,0 @@
-import { z } from "zod/v4";
-/**
- * https://dsp-api.eskimi.com/docs/api/v1/#api-Report-GetCampaignReportByAgeGroups
- */
-export declare const endpoints: {
-    campaign: {
-        age: string;
-        gender: string;
-        list: string;
-        performance: string;
-        video: string;
-    };
-    site: {
-        list: string;
-    };
-};
-declare const campaignSchema: z.ZodObject<{
-    id: z.ZodNumber;
-    name: z.ZodString;
-    type: z.ZodNumber;
-    user_id: z.ZodNumber;
-    ad_domain: z.ZodString;
-    click_url: z.ZodString;
-    bid: z.ZodString;
-    budget: z.ZodAny;
-    dates: z.ZodAny;
-    creative_set_ids: z.ZodAny;
-    audience_ids: z.ZodAny;
-    ad_placement_type_ids: z.ZodAny;
-    ad_placement_position_ids: z.ZodAny;
-    operator_ids: z.ZodAny;
-    devices: z.ZodAny;
-    auto_start: z.ZodNumber;
-    created_at: z.ZodString;
-}, z.core.$strip>;
-export type CampaignSchemaType = z.infer<typeof campaignSchema>;
-export declare const ageGroups: {
-    id: number;
-    name: string;
-}[];
-export declare const devices: {
-    id: number;
-    name: string;
-}[];
-export declare const genders: {
-    id: number;
-    name: string;
-}[];
-export {};

package/eskimi/eskimi.js

@@ -1,93 +0,0 @@
-import { z } from "zod/v4";
-/**
- * https://dsp-api.eskimi.com/docs/api/v1/#api-Report-GetCampaignReportByAgeGroups
- */
-export const endpoints = {
-    campaign: {
-        age: "https://dsp-api.eskimi.com/api/v1/report/ageGroups/get",
-        gender: "https://dsp-api.eskimi.com/api/v1/report/genders/get",
-        list: "https://dsp-api.eskimi.com/api/v1/campaign/get",
-        performance: "https://dsp-api.eskimi.com/api/v1/report/campaigns/get",
-        video: "https://dsp-api.eskimi.com/api/v1/report/videoCampaigns/get",
-    },
-    site: {
-        list: "https://dsp-api.eskimi.com/api/v1/report/sites/get",
-    },
-};
-const campaignSchema = z.object({
-    id: z.number(),
-    name: z.string(),
-    type: z.number(),
-    user_id: z.number(),
-    ad_domain: z.string(),
-    click_url: z.string(),
-    bid: z.string(),
-    budget: z.any(),
-    dates: z.any(),
-    creative_set_ids: z.any(),
-    audience_ids: z.any(),
-    ad_placement_type_ids: z.any(),
-    ad_placement_position_ids: z.any(),
-    operator_ids: z.any(),
-    devices: z.any(),
-    auto_start: z.number(),
-    created_at: z.string(),
-});
-export const ageGroups = [
-    {
-        "id": 0,
-        "name": "0-17",
-    },
-    {
-        "id": 1,
-        "name": "18-24",
-    },
-    {
-        "id": 2,
-        "name": "25-29",
-    },
-    {
-        "id": 3,
-        "name": "30-34",
-    },
-    {
-        "id": 4,
-        "name": "35-39",
-    },
-    {
-        "id": 5,
-        "name": "40-44",
-    },
-    {
-        "id": 6,
-        "name": "45-54",
-    },
-    {
-        "id": 7,
-        "name": "55-64",
-    },
-    {
-        "id": 8,
-        "name": "65+",
-    },
-];
-export const devices = [
-    {
-        "id": 2,
-        "name": "Personal Computer",
-    },
-    {
-        "id": 3,
-        "name": "Connected TV",
-    },
-];
-export const genders = [
-    {
-        "id": 1,
-        "name": "Male",
-    },
-    {
-        "id": 2,
-        "name": "Female",
-    },
-];

package/eskimi/index.d.ts

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

package/eskimi/index.js

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

package/eskimi/server/getAgeGroup.d.ts

@@ -1,4 +0,0 @@
-/**
- * Map the Age Group and return the user-friendly string.
- */
-export declare const getAgeGroup: (input: number) => string;

package/eskimi/server/getAgeGroup.js

@@ -1,11 +0,0 @@
-import { ageGroups } from "../";
-/**
- * Map the Age Group and return the user-friendly string.
- */
-export const getAgeGroup = (input) => {
-    const matches = ageGroups.filter(group => group.id === input);
-    if (1 === matches.length) {
-        return matches[0].name;
-    }
-    return "Undefined";
-};

package/eskimi/server/getData.d.ts

@@ -1,4 +0,0 @@
-/**
- * Make the request to Eskimi API using the access token.
- */
-export declare const getData: (accessToken: string, data: object, url: string) => Promise<any>;

package/eskimi/server/getData.js

@@ -1,13 +0,0 @@
-import { post } from "../../axios";
-/**
- * Make the request to Eskimi API using the access token.
- */
-export const getData = async (accessToken, data, url) => {
-    const response = await post(url, data, {
-        headers: {
-            Authorization: `Bearer ${accessToken}`,
-            "Content-Type": "application/json",
-        },
-    });
-    return response.getBodyDefaultTo(["data"], null);
-};

package/eskimi/server/getDevice.d.ts

@@ -1,4 +0,0 @@
-/**
- * Map the Devices and return the user-friendly string.
- */
-export declare const getDevice: (input: number) => string;

package/eskimi/server/getDevice.js

@@ -1,11 +0,0 @@
-import { devices } from "../";
-/**
- * Map the Devices and return the user-friendly string.
- */
-export const getDevice = (input) => {
-    const matches = devices.filter(device => device.id === input);
-    if (1 === matches.length) {
-        return matches[0].name;
-    }
-    return "Undefined";
-};

package/eskimi/server/getGender.d.ts

@@ -1,4 +0,0 @@
-/**
- * Map the Gender and return the user-friendly string.
- */
-export declare const getGender: (input: number) => string;

package/eskimi/server/getGender.js

@@ -1,11 +0,0 @@
-import { genders } from "../";
-/**
- * Map the Gender and return the user-friendly string.
- */
-export const getGender = (input) => {
-    const matches = genders.filter(gender => gender.id === input);
-    if (1 === matches.length) {
-        return matches[0].name;
-    }
-    return "Undefined";
-};