@8ms/helpers 1.40.6 → 1.40.9

package/date/getTwoWeeksAgo.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getMonday_1 = __importDefault(require("./getMonday"));
+const getNumber_1 = __importDefault(require("./getNumber"));
+const getSunday_1 = __importDefault(require("./getSunday"));
+const getTimeZoned_1 = require("./getTimeZoned");
+/**
+ * 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 = getTimeZoned_1.timeZoneLondon } = { setMidnight: true, setTimeZone: getTimeZoned_1.timeZoneLondon }) => {
+    const sunday = (0, getSunday_1.default)({
+        weeksAgo: 1,
+        setMidnight,
+        setTimeZone,
+    });
+    const monday = (0, getMonday_1.default)({
+        weeksAgo: 2,
+        setMidnight,
+        setTimeZone,
+    });
+    return {
+        end: (0, getNumber_1.default)({
+            input: sunday,
+            isUtc: true,
+        }),
+        start: (0, getNumber_1.default)({
+            input: monday,
+            isUtc: true,
+        }),
+    };
+};
+exports.default = getTwoWeeksAgo;

package/date/getWeeksAgo.d.ts

@@ -0,0 +1,13 @@
+import { DateType } from './';
+import { GetTimeZoned } from './getTimeZoned';
+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 default getWeeksAgo;

package/date/getWeeksAgo.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const date_fns_1 = require("date-fns");
+const getDate_1 = __importDefault(require("./getDate"));
+const getNumber_1 = __importDefault(require("./getNumber"));
+/**
+ * From a given input, move the date back X weeksAgo
+ */
+const getWeeksAgo = ({ input, isUtc, weeksAgo = 0, setMidnight = true, setTimeZone = false }) => {
+    let dateInstance = (0, getDate_1.default)({
+        input,
+        isUtc,
+        setMidnight,
+        setTimeZone
+    });
+    dateInstance = (0, date_fns_1.sub)(dateInstance, { weeks: weeksAgo });
+    return (0, getNumber_1.default)({
+        input: dateInstance,
+        isUtc,
+    });
+};
+exports.default = getWeeksAgo;

package/date/getYesterday.d.ts

@@ -0,0 +1,9 @@
+import { GetMidnight } from './getMidnight';
+import { GetTimeZoned } from './getTimeZoned';
+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 default getYesterday;

package/date/getYesterday.js

@@ -0,0 +1,52 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const date_fns_1 = require("date-fns");
+const getTimeZoned_1 = __importStar(require("./getTimeZoned"));
+const getToday_1 = __importDefault(require("./getToday"));
+/**
+ * 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 = getTimeZoned_1.timeZoneLondon } = { setMidnight: true, setTimeZone: getTimeZoned_1.timeZoneLondon }) => {
+    const today = (0, getToday_1.default)({ setMidnight, setTimeZone: false });
+    let yesterday = (0, date_fns_1.subDays)(today, 1);
+    yesterday = (0, getTimeZoned_1.default)({ input: yesterday, setTimeZone });
+    return yesterday;
+};
+exports.default = getYesterday;

package/date/index.d.ts

@@ -0,0 +1,55 @@
+/**
+ * A date can be either a number (YYYYMMDD), string (YYYY-MM-DD) or Date instance.
+ */
+export type DateType = number | string | Date;
+/**
+ * When a date isn't specified and we need a value.
+ */
+export declare const defaultDate = "1901-01-01";
+/**
+ * When a date time isn't specified and we need a value.
+ */
+export declare const defaultDateTime = "1901-01-01 00:00:00";
+export type Duration = {
+    hours: number;
+    minutes: number;
+    seconds: number;
+};
+export declare enum DurationComparison {
+    VS_NOW = "VS_NOW",
+    VS_MIDNIGHT = "VS_MIDNIGHT"
+}
+export declare enum Interval {
+    FOREVER = "FOREVER",
+    MONTHS = "MONTHS",
+    DAYS = "DAYS",
+    HOURS = "HOURS",
+    MINUTES = "MINUTES"
+}
+export type FinancialYear = {
+    end: Date;
+    start: Date;
+};
+export type FinancialYearWeekType = {
+    end: Date;
+    financialWeek: number;
+    financialYear: number;
+    start: Date;
+};
+/**
+ * A timeframe has a start and an end date.
+ */
+export type Timeframe = {
+    end: DateType;
+    start: DateType;
+};
+export declare enum Timeframes {
+    CURRENT = "CURRENT",
+    COMPARISON = "COMPARISON"
+}
+export declare enum PredefinedTimeframe {
+    NONE = "NONE",
+    CUSTOM = "CUSTOM",
+    THIS_WEEK = "THIS_WEEK",
+    LAST_WEEK = "LAST_WEEK"
+}

package/date/index.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PredefinedTimeframe = exports.Timeframes = exports.Interval = exports.DurationComparison = exports.defaultDateTime = exports.defaultDate = void 0;
+/**
+ * When a date isn't specified and we need a value.
+ */
+exports.defaultDate = "1901-01-01";
+/**
+ * When a date time isn't specified and we need a value.
+ */
+exports.defaultDateTime = "1901-01-01 00:00:00";
+var DurationComparison;
+(function (DurationComparison) {
+    DurationComparison["VS_NOW"] = "VS_NOW";
+    DurationComparison["VS_MIDNIGHT"] = "VS_MIDNIGHT";
+})(DurationComparison || (exports.DurationComparison = DurationComparison = {}));
+var Interval;
+(function (Interval) {
+    Interval["FOREVER"] = "FOREVER";
+    Interval["MONTHS"] = "MONTHS";
+    Interval["DAYS"] = "DAYS";
+    Interval["HOURS"] = "HOURS";
+    Interval["MINUTES"] = "MINUTES";
+})(Interval || (exports.Interval = Interval = {}));
+var Timeframes;
+(function (Timeframes) {
+    Timeframes["CURRENT"] = "CURRENT";
+    Timeframes["COMPARISON"] = "COMPARISON";
+})(Timeframes || (exports.Timeframes = Timeframes = {}));
+var PredefinedTimeframe;
+(function (PredefinedTimeframe) {
+    PredefinedTimeframe["NONE"] = "NONE";
+    PredefinedTimeframe["CUSTOM"] = "CUSTOM";
+    PredefinedTimeframe["THIS_WEEK"] = "THIS_WEEK";
+    PredefinedTimeframe["LAST_WEEK"] = "LAST_WEEK";
+})(PredefinedTimeframe || (exports.PredefinedTimeframe = PredefinedTimeframe = {}));

package/date/isDateValid.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Ensure the date string provided is in YYYY-MM-DD format and is a valid date.
+ */
+declare const isDateValid: ({ input }: {
+    input: string;
+}) => boolean;
+export default isDateValid;

package/date/isDateValid.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const date_fns_1 = require("date-fns");
+const date_fns_2 = require("date-fns");
+/**
+ * Ensure the date string provided is in YYYY-MM-DD format and is a valid date.
+ */
+const isDateValid = ({ input }) => {
+    const cleanInput = input.trim();
+    const parsedInput = (0, date_fns_2.parseISO)(cleanInput);
+    if ((0, date_fns_1.isValid)(parsedInput)) {
+        const matches = cleanInput.match(/^([0-9]{4}-[0-9]{2}-[0-9]{2})$/);
+        if (matches) {
+            return matches.length ? true : false;
+        }
+        return false;
+    }
+    return false;
+};
+exports.default = isDateValid;

package/date/isLastWeek.d.ts

@@ -0,0 +1,6 @@
+import { Timeframe } from './';
+/**
+ * Check to see if a given timeframe is Last Week.
+ */
+declare const isLastWeek: ({ end, start }: Timeframe) => boolean;
+export default isLastWeek;

package/date/isLastWeek.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getLastWeek_1 = __importDefault(require("./getLastWeek"));
+/**
+ * Check to see if a given timeframe is Last Week.
+ */
+const isLastWeek = ({ end, start }) => {
+    const lastWeek = (0, getLastWeek_1.default)();
+    return start === lastWeek.start && end === lastWeek.end;
+};
+exports.default = isLastWeek;

package/date/isThisWeek.d.ts

@@ -0,0 +1,6 @@
+import { Timeframe } from './';
+/**
+ * Check to see if a given timeframe is This Week.
+ */
+declare const isThisWeek: ({ end, start }: Timeframe) => boolean;
+export default isThisWeek;

package/date/isThisWeek.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getThisWeek_1 = __importDefault(require("./getThisWeek"));
+/**
+ * Check to see if a given timeframe is This Week.
+ */
+const isThisWeek = ({ end, start }) => {
+    const thisWeek = (0, getThisWeek_1.default)();
+    return start === thisWeek.start && end === thisWeek.end;
+};
+exports.default = isThisWeek;

package/date/parseExcelDate.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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
+ */
+declare const parseExcelDate: ({ serial }: {
+    serial: number;
+}) => Date;
+export default parseExcelDate;

package/date/parseExcelDate.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * 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 new Date(dateInfo.getFullYear(), dateInfo.getMonth(), dateInfo.getDate(), hours, minutes, seconds);
+};
+exports.default = parseExcelDate;

package/environment/getEnvironment.d.ts

@@ -0,0 +1,6 @@
+import { Environment } from './';
+/**
+ * Determine the environment we're using.
+ */
+declare const getEnvironment: () => Environment;
+export default getEnvironment;

package/environment/getEnvironment.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = require("./");
+/**
+ * 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 'development':
+            response = _1.Environment.DEVELOPMENT;
+            break;
+        case 'demo':
+        case 'preview':
+        case 'staging':
+            response = _1.Environment.STAGING;
+            break;
+        default:
+            response = _1.Environment.PRODUCTION;
+    }
+    return response;
+};
+exports.default = getEnvironment;

package/environment/index.d.ts

@@ -0,0 +1,9 @@
+export declare enum Environment {
+    DEVELOPMENT = "development",
+    STAGING = "staging",
+    PRODUCTION = "production"
+}
+export declare enum Platform {
+    AWS = "AWS",
+    VERCEL = "VERCEL"
+}

package/environment/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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 = {}));

package/environment/isAws.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Check to see if we are working on AWS Lambda.
+ */
+declare const isAws: () => boolean;
+export default isAws;

package/environment/isAws.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = require("./");
+/**
+ * Check to see if we are working on AWS Lambda.
+ */
+const isAws = () => _1.Platform.AWS === process.env["EMS_PLATFORM"];
+exports.default = isAws;

package/environment/isDevelopment.d.ts

@@ -0,0 +1,2 @@
+declare const isDevelopment: () => boolean;
+export default isDevelopment;

package/environment/isDevelopment.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = require("./");
+const getEnvironment_1 = __importDefault(require("./getEnvironment"));
+const isDevelopment = () => _1.Environment.DEVELOPMENT === (0, getEnvironment_1.default)();
+exports.default = isDevelopment;

package/environment/isLocalhost.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Check to see if we are developing locally or on the hosted platform.
+ */
+declare const isLocalhost: () => boolean;
+export default isLocalhost;

package/environment/isLocalhost.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const isAws_1 = __importDefault(require("./isAws"));
+const isVercel_1 = __importDefault(require("./isVercel"));
+/**
+ * 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, isAws_1.default)()) {
+        response = 'true' === process.env['AWS_SAM_LOCAL'];
+    }
+    else if ((0, isVercel_1.default)()) {
+        // 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.default = isLocalhost;

package/environment/isProduction.d.ts

@@ -0,0 +1,2 @@
+declare const isProduction: () => boolean;
+export default isProduction;

package/environment/isProduction.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = require("./");
+const getEnvironment_1 = __importDefault(require("./getEnvironment"));
+const isProduction = () => _1.Environment.PRODUCTION === (0, getEnvironment_1.default)();
+exports.default = isProduction;

package/environment/isStaging.d.ts

@@ -0,0 +1,2 @@
+declare const isStaging: () => boolean;
+export default isStaging;

package/environment/isStaging.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = require("./");
+const getEnvironment_1 = __importDefault(require("./getEnvironment"));
+const isStaging = () => _1.Environment.STAGING === (0, getEnvironment_1.default)();
+exports.default = isStaging;

package/environment/isVercel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Check to see if we are working on Vercel.
+ */
+declare const isVercel: () => boolean;
+export default isVercel;

package/environment/isVercel.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Check to see if we are working on Vercel.
+ */
+const isVercel = () => undefined !== process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF;
+exports.default = isVercel;

package/eskimi/ageGroups.d.ts

@@ -0,0 +1,5 @@
+declare const ageGroups: {
+    id: number;
+    name: string;
+}[];
+export default ageGroups;

package/eskimi/ageGroups.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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+",
+    },
+];
+exports.default = ageGroups;

package/eskimi/campaign.d.ts

@@ -0,0 +1,19 @@
+export type Campaign = {
+    id: number;
+    name: string;
+    type: number;
+    user_id: number;
+    ad_domain: string;
+    click_url: string;
+    bid: string;
+    budget: any;
+    dates: any;
+    creative_set_ids: any;
+    audience_ids: any;
+    ad_placement_type_ids: any;
+    ad_placement_position_ids: any;
+    operator_ids: any;
+    devices: any;
+    auto_start: number;
+    created_at: string;
+};

package/eskimi/campaign.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/eskimi/devices.d.ts

@@ -0,0 +1,5 @@
+declare const devices: {
+    id: number;
+    name: string;
+}[];
+export default devices;

package/eskimi/devices.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const devices = [
+    {
+        "id": 2,
+        "name": "Personal Computer",
+    },
+    {
+        "id": 3,
+        "name": "Connected TV",
+    },
+];
+exports.default = devices;

package/eskimi/endpoints.d.ts

@@ -0,0 +1,16 @@
+/**
+ * https://dsp-api.eskimi.com/docs/api/v1/#api-Report-GetCampaignReportByAgeGroups
+ */
+declare const endpoints: {
+    campaign: {
+        age: string;
+        gender: string;
+        list: string;
+        performance: string;
+        video: string;
+    };
+    site: {
+        list: string;
+    };
+};
+export default endpoints;