@8ms/helpers 2.0.0 → 2.0.1

package/date/financialYear.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFinancialYearWeeks = exports.getFinancialYearToYesterday = exports.getFinancialYearToDate = exports.getFinancialYear = void 0;
+const _1 = require("./");
+const luxon_1 = require("luxon");
+/**
+ * Get the current financial year.
+ */
+const getFinancialYear = (year) => {
+    // Either use the current year or a specified year
+    let financialYear = year;
+    if ("undefined" === typeof year) {
+        const todayInstance = (0, _1.getToday)();
+        // If today is before 1st of April, then use last year
+        if (todayInstance < (0, _1.getDate)(`${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 = (0, _1.getDate)(`${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 = (0, _1.getDate)(`${(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,
+    };
+};
+exports.getFinancialYear = getFinancialYear;
+/**
+ * Return the current financial year up to today.
+ */
+const getFinancialYearToDate = () => {
+    const todayInstance = (0, _1.getToday)();
+    const thisFinancialYear = (0, exports.getFinancialYear)();
+    return {
+        end: todayInstance,
+        start: thisFinancialYear.start,
+    };
+};
+exports.getFinancialYearToDate = getFinancialYearToDate;
+/**
+ * Return the current financial year up to yesterday.
+ * Timezone should always be London based
+ */
+const getFinancialYearToYesterday = () => {
+    const yesterdayInstance = (0, _1.getYesterday)();
+    const thisFinancialYear = (0, exports.getFinancialYear)();
+    return {
+        end: yesterdayInstance,
+        start: thisFinancialYear.start,
+    };
+};
+exports.getFinancialYearToYesterday = getFinancialYearToYesterday;
+/**
+ * Get the current financial year.
+ */
+const getFinancialYearWeeks = (year) => {
+    const financialYear = (0, exports.getFinancialYear)(year);
+    const response = luxon_1.Interval
+        .fromDateTimes(financialYear.start, financialYear.end)
+        .splitBy({ weeks: 1 });
+    return response;
+};
+exports.getFinancialYearWeeks = getFinancialYearWeeks;

package/date/format.d.ts

@@ -0,0 +1,68 @@
+import { InputDate } from "./";
+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;
+/**
+ * Shorthand to get the current date.
+ */
+export declare const getTodayYmdString: () => string;
+/**
+ * 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 parseExcelDate: (serial: number) => DateTime<true> | DateTime<false>;

package/date/format.js

@@ -0,0 +1,150 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseExcelDate = exports.getYmdString = exports.getYmdNumber = exports.getYmdHisString = exports.getYmdHisNumber = exports.getYearNumber = exports.getTodayYmdString = exports.getMonthYearString = exports.getFullDateTime = exports.getFullDate = exports.getDayNumber = exports.format = exports.getDurationMinutes = exports.getDurationHours = void 0;
+const _1 = require("./");
+const luxon_1 = require("luxon");
+/**
+ * Convert a number of seconds into HH:MM:SS
+ * https://www.codevertiser.com/convert-seconds-to-hours-and-minutes-javascript/
+ */
+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;
+};
+exports.getDurationHours = getDurationHours;
+/**
+ * Convert a number of seconds into MM:SS
+ * https://www.codevertiser.com/convert-seconds-to-hours-and-minutes-javascript/
+ */
+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;
+};
+exports.getDurationMinutes = getDurationMinutes;
+/**
+ * Simple function takes any DateTime, String or Number and formats it.
+ */
+const format = (input, dateFormat) => {
+    const instance = (0, _1.getDate)(input);
+    return instance.toFormat(dateFormat);
+};
+exports.format = format;
+/**
+ * Convert a Date into a dd number.
+ */
+const getDayNumber = (input) => {
+    return Number((0, exports.format)(input, "dd"));
+};
+exports.getDayNumber = getDayNumber;
+/**
+ * Whenever we are displaying a month and year date in Codex, this will be the standardised format.
+ * Example: 1901-02-03 → 3 Feb 1901
+ */
+const getFullDate = (input) => {
+    return (0, exports.format)(input, "d MMM yyyy");
+};
+exports.getFullDate = getFullDate;
+/**
+ * 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
+ */
+const getFullDateTime = (input) => {
+    return (0, exports.format)(input, "d MMM yyyy h:mmaaa");
+};
+exports.getFullDateTime = getFullDateTime;
+/**
+ * Returns a MMM YYYY value as a number for a given year.
+ * Example: 1901-02-03 → Feb 1901
+ */
+const getMonthYearString = (input) => {
+    return (0, exports.format)(input, "MMM yyyy");
+};
+exports.getMonthYearString = getMonthYearString;
+/**
+ * Shorthand to get the current date.
+ */
+const getTodayYmdString = () => {
+    const today = (0, _1.getToday)();
+    return (0, exports.getYmdString)(today);
+};
+exports.getTodayYmdString = getTodayYmdString;
+/**
+ * Convert a Date into a YYYY number.
+ */
+const getYearNumber = (input) => {
+    return Number((0, exports.format)(input, "yyyy"));
+};
+exports.getYearNumber = getYearNumber;
+/**
+ * Returns a YYYYMMDDHHIISS value as a number.
+ * Example: 1901-02-03 01:23:45 → 19010203012345
+ */
+const getYmdHisNumber = (input) => {
+    return Number((0, exports.format)(input, "yyyyMMddHHmmss"));
+};
+exports.getYmdHisNumber = getYmdHisNumber;
+/**
+ * Returns a YYYY-MM-DD HH:MM:SS value as a string.
+ * Example: 1901-02-03 → 1901-02-03 00:00:00
+ */
+const getYmdHisString = (input) => {
+    return (0, exports.format)(input, "yyyy-MM-dd HH:mm:ss");
+};
+exports.getYmdHisString = getYmdHisString;
+/**
+ * Returns a YYYYMMDD value as a number.
+ * Example: 1901-02-03 → 19010203
+ */
+const getYmdNumber = (input) => {
+    return Number((0, exports.format)(input, "yyyyMMdd"));
+};
+exports.getYmdNumber = getYmdNumber;
+/**
+ * Whenever we are displaying a YYYY-MM-DD date in Codex
+ * Example: 1901-02-03 → 1901-02-03
+ */
+const getYmdString = (input) => {
+    return (0, exports.format)(input, "yyyy-MM-dd");
+};
+exports.getYmdString = getYmdString;
+/**
+ * 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
+ */
+const parseExcelDate = (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 luxon_1.DateTime.fromISO(`${dateInfo.getFullYear()}-${dateInfo.getMonth()}-${dateInfo.getDate()}T${hours}:${minutes}:${seconds}Z`);
+};
+exports.parseExcelDate = parseExcelDate;

package/date/index.d.ts

@@ -0,0 +1,35 @@
+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;
+};
+/**
+ * Used by Google Ads API.
+ */
+export declare enum 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"
+}
+export { getUtcDate, getDate, getDatesBetween, getMax, getMin, getMonday, getSunday, getThisWeek, getLastWeek, getTwoWeeksAgo, getToday, getWeeksAgo, getYesterday, isThisWeek, isLastWeek, } from "./calculation";
+export { getFinancialYear, getFinancialYearToDate, getFinancialYearToYesterday, getFinancialYearWeeks, } from "./financialYear";
+export { format, getDayNumber, getFullDate, getFullDateTime, getDurationHours, getDurationMinutes, getMonthYearString, getTodayYmdString, getYearNumber, getYmdHisNumber, getYmdHisString, getYmdNumber, getYmdString, parseExcelDate } from "./format";

package/date/index.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseExcelDate = exports.getYmdString = exports.getYmdNumber = exports.getYmdHisString = exports.getYmdHisNumber = exports.getYearNumber = exports.getTodayYmdString = exports.getMonthYearString = exports.getDurationMinutes = exports.getDurationHours = exports.getFullDateTime = exports.getFullDate = exports.getDayNumber = exports.format = exports.getFinancialYearWeeks = exports.getFinancialYearToYesterday = exports.getFinancialYearToDate = exports.getFinancialYear = exports.isLastWeek = exports.isThisWeek = exports.getYesterday = exports.getWeeksAgo = exports.getToday = exports.getTwoWeeksAgo = exports.getLastWeek = exports.getThisWeek = exports.getSunday = exports.getMonday = exports.getMin = exports.getMax = exports.getDatesBetween = exports.getDate = exports.getUtcDate = exports.Month = void 0;
+/**
+ * Used by Google Ads API.
+ */
+var Month;
+(function (Month) {
+    Month["JANUARY"] = "JANUARY";
+    Month["FEBRUARY"] = "FEBRUARY";
+    Month["MARCH"] = "MARCH";
+    Month["APRIL"] = "APRIL";
+    Month["MAY"] = "MAY";
+    Month["JUNE"] = "JUNE";
+    Month["JULY"] = "JULY";
+    Month["AUGUST"] = "AUGUST";
+    Month["SEPTEMBER"] = "SEPTEMBER";
+    Month["OCTOBER"] = "OCTOBER";
+    Month["NOVEMBER"] = "NOVEMBER";
+    Month["DECEMBER"] = "DECEMBER";
+})(Month || (exports.Month = Month = {}));
+var calculation_1 = require("./calculation");
+Object.defineProperty(exports, "getUtcDate", { enumerable: true, get: function () { return calculation_1.getUtcDate; } });
+Object.defineProperty(exports, "getDate", { enumerable: true, get: function () { return calculation_1.getDate; } });
+Object.defineProperty(exports, "getDatesBetween", { enumerable: true, get: function () { return calculation_1.getDatesBetween; } });
+Object.defineProperty(exports, "getMax", { enumerable: true, get: function () { return calculation_1.getMax; } });
+Object.defineProperty(exports, "getMin", { enumerable: true, get: function () { return calculation_1.getMin; } });
+Object.defineProperty(exports, "getMonday", { enumerable: true, get: function () { return calculation_1.getMonday; } });
+Object.defineProperty(exports, "getSunday", { enumerable: true, get: function () { return calculation_1.getSunday; } });
+Object.defineProperty(exports, "getThisWeek", { enumerable: true, get: function () { return calculation_1.getThisWeek; } });
+Object.defineProperty(exports, "getLastWeek", { enumerable: true, get: function () { return calculation_1.getLastWeek; } });
+Object.defineProperty(exports, "getTwoWeeksAgo", { enumerable: true, get: function () { return calculation_1.getTwoWeeksAgo; } });
+Object.defineProperty(exports, "getToday", { enumerable: true, get: function () { return calculation_1.getToday; } });
+Object.defineProperty(exports, "getWeeksAgo", { enumerable: true, get: function () { return calculation_1.getWeeksAgo; } });
+Object.defineProperty(exports, "getYesterday", { enumerable: true, get: function () { return calculation_1.getYesterday; } });
+Object.defineProperty(exports, "isThisWeek", { enumerable: true, get: function () { return calculation_1.isThisWeek; } });
+Object.defineProperty(exports, "isLastWeek", { enumerable: true, get: function () { return calculation_1.isLastWeek; } });
+var financialYear_1 = require("./financialYear");
+Object.defineProperty(exports, "getFinancialYear", { enumerable: true, get: function () { return financialYear_1.getFinancialYear; } });
+Object.defineProperty(exports, "getFinancialYearToDate", { enumerable: true, get: function () { return financialYear_1.getFinancialYearToDate; } });
+Object.defineProperty(exports, "getFinancialYearToYesterday", { enumerable: true, get: function () { return financialYear_1.getFinancialYearToYesterday; } });
+Object.defineProperty(exports, "getFinancialYearWeeks", { enumerable: true, get: function () { return financialYear_1.getFinancialYearWeeks; } });
+var format_1 = require("./format");
+Object.defineProperty(exports, "format", { enumerable: true, get: function () { return format_1.format; } });
+Object.defineProperty(exports, "getDayNumber", { enumerable: true, get: function () { return format_1.getDayNumber; } });
+Object.defineProperty(exports, "getFullDate", { enumerable: true, get: function () { return format_1.getFullDate; } });
+Object.defineProperty(exports, "getFullDateTime", { enumerable: true, get: function () { return format_1.getFullDateTime; } });
+Object.defineProperty(exports, "getDurationHours", { enumerable: true, get: function () { return format_1.getDurationHours; } });
+Object.defineProperty(exports, "getDurationMinutes", { enumerable: true, get: function () { return format_1.getDurationMinutes; } });
+Object.defineProperty(exports, "getMonthYearString", { enumerable: true, get: function () { return format_1.getMonthYearString; } });
+Object.defineProperty(exports, "getTodayYmdString", { enumerable: true, get: function () { return format_1.getTodayYmdString; } });
+Object.defineProperty(exports, "getYearNumber", { enumerable: true, get: function () { return format_1.getYearNumber; } });
+Object.defineProperty(exports, "getYmdHisNumber", { enumerable: true, get: function () { return format_1.getYmdHisNumber; } });
+Object.defineProperty(exports, "getYmdHisString", { enumerable: true, get: function () { return format_1.getYmdHisString; } });
+Object.defineProperty(exports, "getYmdNumber", { enumerable: true, get: function () { return format_1.getYmdNumber; } });
+Object.defineProperty(exports, "getYmdString", { enumerable: true, get: function () { return format_1.getYmdString; } });
+Object.defineProperty(exports, "parseExcelDate", { enumerable: true, get: function () { return format_1.parseExcelDate; } });

package/environment/index.d.ts

@@ -0,0 +1,32 @@
+export declare enum Environment {
+    DEVELOPMENT = "development",
+    STAGING = "staging",
+    PRODUCTION = "production"
+}
+export declare enum Platform {
+    AWS = "AWS",
+    VERCEL = "VERCEL"
+}
+/**
+ * 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/index.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLocalhost = exports.isProduction = exports.isStaging = exports.isDevelopment = exports.isServer = exports.isVercel = exports.isAws = exports.getEnvironment = exports.Platform = exports.Environment = void 0;
+var Environment;
+(function (Environment) {
+    Environment["DEVELOPMENT"] = "development";
+    Environment["STAGING"] = "staging";
+    Environment["PRODUCTION"] = "production";
+})(Environment || (exports.Environment = Environment = {}));
+var Platform;
+(function (Platform) {
+    Platform["AWS"] = "AWS";
+    Platform["VERCEL"] = "VERCEL";
+})(Platform || (exports.Platform = Platform = {}));
+/**
+ * Determine the environment we're using.
+ */
+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;
+};
+exports.getEnvironment = getEnvironment;
+/**
+ * Check to see if we are working on AWS Lambda.
+ */
+const isAws = () => Platform.AWS === process.env["EMS_PLATFORM"];
+exports.isAws = isAws;
+const isVercel = () => undefined !== process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF;
+exports.isVercel = isVercel;
+/**
+ * Some code should only run on the server side to protect the data.
+ */
+exports.isServer = typeof window === 'undefined';
+/**
+ * Check the environment currently running.
+ */
+const isDevelopment = () => Environment.DEVELOPMENT === (0, exports.getEnvironment)();
+exports.isDevelopment = isDevelopment;
+const isStaging = () => Environment.STAGING === (0, exports.getEnvironment)();
+exports.isStaging = isStaging;
+const isProduction = () => Environment.PRODUCTION === (0, exports.getEnvironment)();
+exports.isProduction = isProduction;
+/**
+ * Check to see if we are developing locally or on the hosted platform.
+ */
+const isLocalhost = () => {
+    let response = false;
+    if ("true" === process.env["IS_LOCAL"]) {
+        response = true;
+    }
+    else if ((0, exports.isAws)()) {
+        response = "true" === process.env["AWS_SAM_LOCAL"];
+    }
+    else if ((0, exports.isVercel)()) {
+        // This value needs to only be included in Vercel but undefined in locally
+        response = undefined === process.env["NEXT_PUBLIC_VERCEL_GIT_REPO_ID"];
+    }
+    return response;
+};
+exports.isLocalhost = isLocalhost;

package/eskimi/getAgeGroup.d.ts

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

package/eskimi/getAgeGroup.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAgeGroup = void 0;
+const _1 = require("./");
+/**
+ * Map the Age Group and return the user-friendly string.
+ */
+const getAgeGroup = (input) => {
+    const matches = _1.ageGroups.filter(group => group.id === input);
+    if (1 === matches.length) {
+        return matches[0].name;
+    }
+    return "Undefined";
+};
+exports.getAgeGroup = getAgeGroup;

package/eskimi/getData.d.ts

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

package/eskimi/getData.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getData = void 0;
+const axios_1 = require("../axios");
+/**
+ * Make the request to Eskimi API using the access token.
+ */
+const getData = async (accessToken, data, url) => {
+    const response = await (0, axios_1.post)(url, data, {
+        headers: {
+            Authorization: `Bearer ${accessToken}`,
+            "Content-Type": "application/json",
+        },
+    });
+    return response.getBodyDefaultTo(["data"], null);
+};
+exports.getData = getData;

package/eskimi/getDevice.d.ts

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

package/eskimi/getDevice.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDevice = void 0;
+const _1 = require("./");
+/**
+ * Map the Devices and return the user-friendly string.
+ */
+const getDevice = (input) => {
+    const matches = _1.devices.filter(device => device.id === input);
+    if (1 === matches.length) {
+        return matches[0].name;
+    }
+    return "Undefined";
+};
+exports.getDevice = getDevice;

package/eskimi/getGender.d.ts

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

package/eskimi/getGender.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGender = void 0;
+const _1 = require("./");
+/**
+ * Map the Gender and return the user-friendly string.
+ */
+const getGender = (input) => {
+    const matches = _1.genders.filter(gender => gender.id === input);
+    if (1 === matches.length) {
+        return matches[0].name;
+    }
+    return "Undefined";
+};
+exports.getGender = getGender;

package/eskimi/index.d.ts

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