@8ms/helpers 1.41.1 → 1.42.0

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;

package/dist/esm/eskimi/getAccessToken.js

@@ -0,0 +1,18 @@
+import getParameter from '../aws/ssm/getParameter';
+global.eskimiAccessToken = null;
+/**
+ * Retrieve the access token from SSM Parameter Store.
+ */
+const getAccessToken = async ({ force, parameterName }) => {
+    if (!global.eskimiAccessToken || force) {
+        // Get the credentials from SSM
+        const parameter = await getParameter({
+            name: parameterName,
+            withDecryption: true,
+            isJson: true,
+        });
+        global.eskimiAccessToken = parameter.accessToken;
+    }
+    return global.eskimiAccessToken;
+};
+export default getAccessToken;

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

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

package/dist/esm/eskimi/getAgeGroup.js

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

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

@@ -0,0 +1,7 @@
+/**
+ * Convert the Regex of Campaign Ids into an array of integers.
+ */
+declare const getCampaignIds: ({ accounts }: {
+    accounts: any;
+}) => number[];
+export default getCampaignIds;

package/dist/esm/eskimi/getCampaignIds.js

@@ -0,0 +1,10 @@
+/**
+ * Convert the Regex of Campaign Ids into an array of integers.
+ */
+const getCampaignIds = ({ accounts }) => {
+    return accounts[0].campaignIdRegex.replace('(', '')
+        .replace(')', '')
+        .split('|')
+        .map(id => parseInt(id));
+};
+export default getCampaignIds;

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

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

package/dist/esm/eskimi/getData.js

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

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

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

package/dist/esm/eskimi/getDevice.js

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

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

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

package/dist/esm/eskimi/getGender.js

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

package/dist/esm/file/createDirectory.d.ts

@@ -0,0 +1,9 @@
+type CreateDirectory = {
+    filePath: string;
+};
+/**
+ * Create a directory recursively.
+ * Requires fs-extra
+ */
+declare const createDirectory: ({ filePath }: CreateDirectory) => Promise<unknown>;
+export default createDirectory;

package/dist/esm/file/createDirectory.js

@@ -0,0 +1,14 @@
+/**
+ * Create a directory recursively.
+ * Requires fs-extra
+ */
+const createDirectory = ({ filePath }) => {
+    return new Promise(async (resolve, reject) => {
+        const fs = require('fs-extra');
+        const path = require('path');
+        const fileDir = path.parse(filePath).dir;
+        fs.ensureDirSync(fileDir);
+        resolve(true);
+    });
+};
+export default createDirectory;

package/dist/esm/file/writeFile.d.ts

@@ -0,0 +1 @@
+declare const writeFile: () => void;

package/dist/esm/file/writeFile.js

@@ -0,0 +1,2 @@
+const writeFile = () => {
+};

package/dist/esm/global/forceUpdate.d.ts

@@ -0,0 +1,8 @@
+type ForceUpdate = {
+    key: string;
+};
+/**
+ * Force an update of the cached data
+ */
+declare const forceUpdate: ({ key }: ForceUpdate) => Promise<any>;
+export default forceUpdate;

package/dist/esm/global/forceUpdate.js

@@ -0,0 +1,23 @@
+/**
+ * Force an update of the cached data
+ */
+const forceUpdate = async ({ key }) => {
+    // Doesn't exist
+    if (undefined === global['ems_cache'] ||
+        undefined === global['ems_cache']?.[key] ||
+        null === global['ems_cache']?.[key]) {
+        // Throw error - should always exist
+        throw `Global key '${key}' does not exist, requires initialisation.`;
+    }
+    // Reassign the global key using the update function
+    else {
+        global['ems_cache'][key] = {
+            expires: global['ems_cache'][key].expires,
+            insertedAt: Date.now(),
+            updateFn: global['ems_cache'][key].updateFn,
+            value: await global['ems_cache'][key].updateFn(),
+        };
+    }
+    return global['ems_cache'][key];
+};
+export default forceUpdate;

package/dist/esm/global/init.d.ts

@@ -0,0 +1,10 @@
+type Init = {
+    expires: number;
+    key: string;
+    updateFn: Function;
+};
+/**
+ * Initialise a new global data.
+ */
+declare const init: ({ expires, key, updateFn }: Init) => Promise<any>;
+export default init;

package/dist/esm/global/init.js

@@ -0,0 +1,16 @@
+/**
+ * Initialise a new global data.
+ */
+const init = async ({ expires, key, updateFn }) => {
+    if (undefined === global['ems_cache']) {
+        global['ems_cache'] = {};
+    }
+    global['ems_cache'][key] = {
+        expires,
+        insertedAt: Date.now(),
+        updateFn,
+        value: await updateFn(),
+    };
+    return global['ems_cache'][key].value;
+};
+export default init;

package/dist/esm/global/isSet.d.ts

@@ -0,0 +1,8 @@
+type IsSet = {
+    key: string;
+};
+/**
+ * Checks to see if a global key is set.
+ */
+declare const isSet: ({ key }: IsSet) => Promise<boolean>;
+export default isSet;

package/dist/esm/global/isSet.js

@@ -0,0 +1,7 @@
+/**
+ * Checks to see if a global key is set.
+ */
+const isSet = async ({ key }) => {
+    return undefined === global['ems_cache'][key];
+};
+export default isSet;

package/dist/esm/global/maxCache.d.ts

@@ -0,0 +1,8 @@
+type MaxCache = {
+    limit: number;
+};
+/**
+ * Clear cache more than the provided number of cache.
+ */
+declare const maxCache: ({ limit }: MaxCache) => void;
+export default maxCache;

package/dist/esm/global/maxCache.js

@@ -0,0 +1,15 @@
+/**
+ * Clear cache more than the provided number of cache.
+ */
+const maxCache = ({ limit }) => {
+    if (undefined !== global['ems_cache']) {
+        let counter = 0;
+        for (let cacheKey in global['ems_cache']) {
+            if (counter > limit) {
+                delete global['ems_cache'][cacheKey];
+            }
+            counter++;
+        }
+    }
+};
+export default maxCache;

package/dist/esm/global/read.d.ts

@@ -0,0 +1,8 @@
+type Update = {
+    key: string;
+};
+/**
+ * Retrieve a value from global memory.
+ */
+declare const read: ({ key }: Update) => Promise<any>;
+export default read;

package/dist/esm/global/read.js

@@ -0,0 +1,25 @@
+import forceUpdate from './forceUpdate';
+/**
+ * Retrieve a value from global memory.
+ */
+const read = async ({ key }) => {
+    // Doesn't exist
+    if (undefined === global['ems_cache'] ||
+        undefined === global['ems_cache']?.[key] ||
+        null === global['ems_cache']?.[key]) {
+        // Throw error - should always exist
+        throw `Global key '${key}' does not exist, requires initialisation.`;
+    }
+    // Exists (0 is determined as forever)
+    else if (0 != global['ems_cache'][key].expires) {
+        // https://ui.dev/get-current-timestamp-javascript
+        const expiresAt = Math.floor(global['ems_cache'][key].insertedAt / 1000) + global['ems_cache'][key].expires;
+        const now = Math.floor(Date.now() / 1000);
+        // If we are now beyond the expiry date, update the data
+        if (now > expiresAt) {
+            await forceUpdate({ key });
+        }
+    }
+    return global['ems_cache'][key].value;
+};
+export default read;

package/dist/esm/google/bigQuery/IsTableExists.d.ts

@@ -0,0 +1,11 @@
+type IsTableExists = {
+    datasetId: string;
+    projectId?: string;
+    tableId: string;
+};
+/**
+ * Check to see whether a given BigQuery table exists.
+ * https://cloud.google.com/bigquery/docs/samples/bigquery-table-exists
+ */
+declare const isTableExists: ({ datasetId, projectId, tableId }: IsTableExists) => Promise<boolean>;
+export default isTableExists;