@8ms/helpers 1.41.0 → 1.42.0

package/dist/esm/date/parseExcelDate.js

@@ -0,0 +1,17 @@
+/**
+ * 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);
+};
+export default parseExcelDate;

package/dist/esm/date/tests/format.test.d.ts

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

package/dist/esm/date/tests/format.test.js

@@ -0,0 +1,8 @@
+import format from '../format';
+test('format', () => {
+    const expected = '01/02/2021';
+    const dateFormat = 'dd/MM/yyyy';
+    const dateNumber = 20210201;
+    expect(format({ input: dateNumber, dateFormat }))
+        .toBe(expected);
+});

package/dist/esm/date/tests/getDate.test.d.ts

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

package/dist/esm/date/tests/getDate.test.js

@@ -0,0 +1,158 @@
+import timezoneMock from 'timezone-mock';
+import getTimeZoned, { timeZoneLondon } from '../getTimeZoned';
+import getDate from '../getDate';
+import format from '../format';
+test('getDate - 2024-05-20T15:52:12.673Z (string)', () => {
+    const parsed = format({
+        dateFormat: 'yyyy-MM-dd HH:mm:ss',
+        input: `2024-05-20T15:52:12.673Z`,
+        setMidnight: false,
+    });
+    const expected = '2024-05-20 15:52:12';
+    console.log('parsed', parsed);
+    expect(parsed)
+        .toBe(expected);
+});
+test('getDate - 2024-04-30 (string)', () => {
+    const parsed = format({
+        input: `2024-04-30`,
+        setMidnight: true,
+    });
+    const expected = '2024-04-30';
+    expect(parsed)
+        .toBe(expected);
+});
+test('getDate - 20210201 (number)', () => {
+    let expected = new Date('2021-02-01 00:00:00');
+    expected = getTimeZoned({
+        input: expected
+    });
+    const parsed = getDate({
+        input: 20210201,
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+/**
+test('getDate - 20210601 (string)', () =>
+{
+    let expected = new Date('2021-06-01 00:00:00');
+    expected = getTimeZoned({
+        input: expected
+    });
+
+    const parsed = getDate({
+        input: '20210601'
+    });
+
+    expect(parsed)
+    .toMatchObject(expected);
+
+});*/
+test('getDate - 2021-06-01 01:02:03 (string)', () => {
+    let expected = new Date('2021-06-01 01:02:03');
+    expected = getTimeZoned({
+        input: expected
+    });
+    const parsed = getDate({
+        input: '2021-06-01 01:02:03',
+        setMidnight: false
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - UTC (October to March)', () => {
+    let expected = new Date('2021-02-01 00:00:00');
+    expected = getTimeZoned({ input: expected });
+    const parsed = getDate({
+        input: '2021-02-01 00:00:00',
+        setMidnight: false,
+    });
+    expect(expected)
+        .toMatchObject(parsed);
+});
+test('getDate - DST (March to October)', () => {
+    let expected = new Date('2021-03-01 01:02:03');
+    expected = getTimeZoned({ input: expected });
+    const parsed = getDate({
+        input: '2021-03-01 01:02:03',
+        setMidnight: false,
+    });
+    // console.log('expected = ', expected);
+    // console.log('parsed = ', parsed);
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - Korean Standard Time', () => {
+    let expected = new Date('2017-03-11 02:30:00');
+    expected = getTimeZoned({ input: expected });
+    const parsed = getDate({
+        input: 'Sat Mar 11 2017 11:30:00 GMT+0900 (KST)',
+        setMidnight: false,
+    });
+    // console.log('expected = ', expected);
+    // console.log('parsed = ', parsed);
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - Zulu', () => {
+    let expected = new Date('2022-03-17 19:56:44');
+    expected = getTimeZoned({ input: expected });
+    const parsed = getDate({
+        input: '2022-03-17T19:56:44Z',
+        setMidnight: false,
+    });
+    // console.log('expected = ', expected);
+    // console.log('parsed = ', parsed);
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - timezone - US', () => {
+    let expected = new Date('2021-02-01 00:00:00');
+    timezoneMock.register('US/Pacific');
+    const parsed = getDate({
+        input: 20210201,
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+// https://www.worldtimebuddy.com/
+test('getDate - timezone - UK with time', () => {
+    timezoneMock.register('Europe/London');
+    let expected = new Date('2021-02-01 10:05:20');
+    const parsed = getDate({
+        input: '2021-02-01 10:05:20',
+        setMidnight: false,
+        setTimeZone: timeZoneLondon,
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - timezone - US with time', () => {
+    let expected = '2021-02-01 18:05:20';
+    timezoneMock.register('US/Pacific');
+    let parsed = format({
+        input: '2021-02-01 02:05:20',
+        dateFormat: 'yyyy-MM-dd HH:mm:ss',
+        setMidnight: false,
+        setTimeZone: timeZoneLondon,
+    });
+    expect(parsed)
+        .toMatch(expected);
+});
+test('getDate - timezone - US with time - change of dates', () => {
+    let expected = new Date();
+    expected.setUTCDate(1);
+    expected.setFullYear(2021);
+    expected.setUTCMonth(1);
+    expected.setUTCDate(2);
+    expected.setUTCHours(1, 5, 20, 0);
+    timezoneMock.register('US/Pacific');
+    let parsed = getDate({
+        input: '2021-02-02 09:05:20',
+        setMidnight: false,
+        setTimeZone: timeZoneLondon,
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});

package/dist/esm/date/tests/getDateMore.test.d.ts

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

package/dist/esm/date/tests/getDateMore.test.js

@@ -0,0 +1,30 @@
+import getDate from '../getDate';
+test('getDate - 2022-04-18', () => {
+    let expected = new Date('2022-04-18 01:00:00');
+    let parsed = getDate({ input: '2022-04-18' });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - 2022-04-18 12:34:56', () => {
+    let expected = new Date('2022-04-18 13:34:56');
+    let parsed = getDate({
+        input: '2022-04-18 12:34:56',
+        setMidnight: false
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test('getDate - 2024-06-02', () => {
+    let expected = new Date();
+    expected.setUTCDate(1);
+    expected.setFullYear(2024);
+    expected.setUTCMonth(5);
+    expected.setUTCDate(2);
+    expected.setUTCHours(0, 0, 0, 0);
+    let parsed = getDate({
+        input: '2024-06-02',
+        setMidnight: true,
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});

package/dist/esm/date/tests/getDatesBetween.test.d.ts

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

package/dist/esm/date/tests/getDatesBetween.test.js

@@ -0,0 +1,53 @@
+import getDate from "../getDate";
+import getDatesBetween from "../getDatesBetween";
+test("getDatesBetween - Date input", () => {
+    const start = getDate({ input: "2022-10-07" });
+    const end = getDate({ input: "2022-10-10" });
+    //	console.log("getDate({input: '2022-10-07'})", getDate({input: '2022-10-07'}));
+    let expected = [
+        getDate({ input: "2022-10-07" }),
+        getDate({ input: "2022-10-08" }),
+        getDate({ input: "2022-10-09" }),
+        getDate({ input: "2022-10-10" }),
+    ];
+    let parsed = getDatesBetween({ end, start });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test("getDatesBetween - String input", () => {
+    let expected = [
+        getDate({ input: "2022-10-07" }),
+        getDate({ input: "2022-10-08" }),
+        getDate({ input: "2022-10-09" }),
+        getDate({ input: "2022-10-10" }),
+    ];
+    let parsed = getDatesBetween({
+        end: "2022-10-10",
+        start: "2022-10-07",
+    });
+    expect(parsed)
+        .toMatchObject(expected);
+});
+test("getDatesBetween - String input", () => {
+    let expected = [
+        getDate({
+            input: "2022-02-02",
+            setMidnight: true,
+        }),
+        getDate({
+            input: "2022-02-03",
+            setMidnight: true,
+        }),
+        getDate({
+            input: "2022-02-04",
+            setMidnight: true,
+        }),
+        getDate({
+            input: "2022-02-05",
+            setMidnight: true,
+        }),
+    ];
+    let parsed = getDatesBetween({ end: "2022-02-05", start: "2022-02-02" });
+    expect(parsed)
+        .toMatchObject(expected);
+});

package/dist/esm/date/tests/getFinancialYear.test.d.ts

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

package/dist/esm/date/tests/getFinancialYear.test.js

@@ -0,0 +1,20 @@
+import format from '../format';
+import getFinancialYearWeeks from '../getFinancialYearWeeks';
+test('getFinancialYearWeeks - 2021', () => {
+    const financialWeeks = getFinancialYearWeeks({ year: 2021 });
+    const output = {
+        start: format({ input: financialWeeks[0].start }),
+        end: format({ input: financialWeeks[0].end }),
+    };
+    const expected = {
+        start: format({ input: new Date('2021-03-29 00:00:00') }),
+        end: format({ input: new Date('2021-04-04 00:00:00') }),
+    };
+    //console.log('financialWeeks', financialWeeks);
+    // console.log('output', output);
+    // console.log('expected', expected);
+    expect(output.start)
+        .toBe(expected.start);
+    expect(output.end)
+        .toBe(expected.end);
+});

package/dist/esm/date/tests/getNumber.test.d.ts

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

package/dist/esm/date/tests/getNumber.test.js

@@ -0,0 +1,7 @@
+import getNumber from '../getNumber';
+test('getNumber', () => {
+    const expected = 20210201;
+    const parsed = getNumber({ input: new Date('2021-02-01 00:00:00') });
+    expect(parsed)
+        .toBe(expected);
+});

package/dist/esm/date/tests/timezone-issue.test.d.ts

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

package/dist/esm/date/tests/timezone-issue.test.js

@@ -0,0 +1,17 @@
+import getMonday from "../getMonday";
+import getDate from "../getDate";
+test("timezone date", () => {
+    const expected = getDate({
+        input: "2024-04-29T00:00:00.000Z",
+        isUtc: true,
+        setMidnight: true,
+    });
+    // console.log('expected', expected);
+    const parsed = getMonday({
+        weeksAgo: 0,
+        setMidnight: true,
+    });
+    // console.log('parsed', parsed);
+    expect(parsed)
+        .toMatchObject(expected);
+});

package/dist/esm/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/dist/esm/environment/getEnvironment.js

@@ -0,0 +1,41 @@
+import { Environment } from './';
+/**
+ * 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 = Environment.DEVELOPMENT;
+            break;
+        case 'demo':
+        case 'preview':
+        case 'staging':
+            response = Environment.STAGING;
+            break;
+        default:
+            response = Environment.PRODUCTION;
+    }
+    return response;
+};
+export default getEnvironment;

package/dist/esm/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/dist/esm/environment/index.js

@@ -0,0 +1,11 @@
+export var Environment;
+(function (Environment) {
+    Environment["DEVELOPMENT"] = "development";
+    Environment["STAGING"] = "staging";
+    Environment["PRODUCTION"] = "production";
+})(Environment || (Environment = {}));
+export var Platform;
+(function (Platform) {
+    Platform["AWS"] = "AWS";
+    Platform["VERCEL"] = "VERCEL";
+})(Platform || (Platform = {}));

package/dist/esm/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/dist/esm/environment/isAws.js

@@ -0,0 +1,6 @@
+import { Platform } from "./";
+/**
+ * Check to see if we are working on AWS Lambda.
+ */
+const isAws = () => Platform.AWS === process.env["EMS_PLATFORM"];
+export default isAws;

package/dist/esm/environment/isDevelopment.d.ts

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

package/dist/esm/environment/isDevelopment.js

@@ -0,0 +1,4 @@
+import { Environment } from "./";
+import getEnvironment from "./getEnvironment";
+const isDevelopment = () => Environment.DEVELOPMENT === getEnvironment();
+export default isDevelopment;

package/dist/esm/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/dist/esm/environment/isLocalhost.js

@@ -0,0 +1,20 @@
+import isAws from './isAws';
+import isVercel from './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 (isAws()) {
+        response = 'true' === process.env['AWS_SAM_LOCAL'];
+    }
+    else if (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;
+};
+export default isLocalhost;

package/dist/esm/environment/isProduction.d.ts

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

package/dist/esm/environment/isProduction.js

@@ -0,0 +1,4 @@
+import { Environment } from "./";
+import getEnvironment from './getEnvironment';
+const isProduction = () => Environment.PRODUCTION === getEnvironment();
+export default isProduction;

package/dist/esm/environment/isStaging.d.ts

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

package/dist/esm/environment/isStaging.js

@@ -0,0 +1,4 @@
+import { Environment } from "./";
+import getEnvironment from './getEnvironment';
+const isStaging = () => Environment.STAGING === getEnvironment();
+export default isStaging;

package/dist/esm/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/dist/esm/environment/isVercel.js

@@ -0,0 +1,5 @@
+/**
+ * Check to see if we are working on Vercel.
+ */
+const isVercel = () => undefined !== process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF;
+export default isVercel;

package/dist/esm/eskimi/ageGroups.d.ts

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

package/dist/esm/eskimi/ageGroups.js

@@ -0,0 +1,39 @@
+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 default ageGroups;

package/dist/esm/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/dist/esm/eskimi/campaign.js

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

package/dist/esm/eskimi/devices.d.ts

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

package/dist/esm/eskimi/devices.js

@@ -0,0 +1,11 @@
+const devices = [
+    {
+        "id": 2,
+        "name": "Personal Computer",
+    },
+    {
+        "id": 3,
+        "name": "Connected TV",
+    },
+];
+export default devices;

package/dist/esm/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;

package/dist/esm/eskimi/endpoints.js

@@ -0,0 +1,16 @@
+/**
+ * https://dsp-api.eskimi.com/docs/api/v1/#api-Report-GetCampaignReportByAgeGroups
+ */
+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',
+    },
+};
+export default endpoints;

package/dist/esm/eskimi/genders.d.ts

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

package/dist/esm/eskimi/genders.js

@@ -0,0 +1,11 @@
+const genders = [
+    {
+        "id": 1,
+        "name": "Male",
+    },
+    {
+        "id": 2,
+        "name": "Female",
+    },
+];
+export default genders;

package/dist/esm/eskimi/getAccessToken.d.ts

@@ -0,0 +1,9 @@
+export type GetAccessToken = {
+    force: boolean;
+    parameterName: string;
+};
+/**
+ * Retrieve the access token from SSM Parameter Store.
+ */
+declare const getAccessToken: ({ force, parameterName }: GetAccessToken) => Promise<void>;
+export default getAccessToken;