@8ms/helpers 1.38.0 → 2.0.0

package/environment/isDevelopment.js

@@ -1,9 +0,0 @@
-"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

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

package/environment/isLocalhost.js

@@ -1,25 +0,0 @@
-"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

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

package/environment/isProduction.js

@@ -1,9 +0,0 @@
-"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

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

package/environment/isStaging.js

@@ -1,9 +0,0 @@
-"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

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

package/environment/isVercel.js

@@ -1,7 +0,0 @@
-"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

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

package/eskimi/ageGroups.js

@@ -1,41 +0,0 @@
-"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

@@ -1,19 +0,0 @@
-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

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

package/eskimi/devices.d.ts

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

package/eskimi/devices.js

@@ -1,13 +0,0 @@
-"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

@@ -1,16 +0,0 @@
-/**
- * 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/eskimi/endpoints.js

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

package/eskimi/genders.d.ts

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

package/eskimi/genders.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const genders = [
-    {
-        "id": 1,
-        "name": "Male",
-    },
-    {
-        "id": 2,
-        "name": "Female",
-    },
-];
-exports.default = genders;

package/eskimi/getAccessToken.d.ts

@@ -1,9 +0,0 @@
-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/eskimi/getAccessToken.js

@@ -1,23 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getParameter_1 = __importDefault(require("../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 (0, getParameter_1.default)({
-            name: parameterName,
-            withDecryption: true,
-            isJson: true,
-        });
-        global.eskimiAccessToken = parameter.accessToken;
-    }
-    return global.eskimiAccessToken;
-};
-exports.default = getAccessToken;

package/eskimi/getAgeGroup.d.ts

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

package/eskimi/getAgeGroup.js

@@ -1,17 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const ageGroups_1 = __importDefault(require("./ageGroups"));
-/**
- * Map the Age Group and return the user-friendly string.
- */
-const getAgeGroup = ({ input }) => {
-    const matches = ageGroups_1.default.filter(group => group.id === input);
-    if (1 === matches.length) {
-        return matches[0].name;
-    }
-    return 'Undefined';
-};
-exports.default = getAgeGroup;

package/eskimi/getCampaignIds.d.ts

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

package/eskimi/getCampaignIds.js

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

package/eskimi/getData.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/eskimi/getData.js

@@ -1,23 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const post_1 = __importDefault(require("../axios/post"));
-/**
- * Make the request to Eskimi API using the access token.
- */
-const getData = async ({ data, url }) => {
-    const response = await (0, post_1.default)({
-        config: {
-            headers: {
-                Authorization: `Bearer ${global.eskimiAccessToken}`,
-                "Content-Type": "application/json",
-            },
-        },
-        data: data,
-        url: url,
-    });
-    return response.getBodyDefaultTo({ defaultValue: null, keys: ['data'] });
-};
-exports.default = getData;

package/eskimi/getDevice.d.ts

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

package/eskimi/getDevice.js

@@ -1,17 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const devices_1 = __importDefault(require("./devices"));
-/**
- * Map the Devices and return the user-friendly string.
- */
-const getDevice = ({ input }) => {
-    const matches = devices_1.default.filter(device => device.id === input);
-    if (1 === matches.length) {
-        return matches[0].name;
-    }
-    return 'Undefined';
-};
-exports.default = getDevice;

package/eskimi/getGender.d.ts

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

package/eskimi/getGender.js

@@ -1,17 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const genders_1 = __importDefault(require("./genders"));
-/**
- * Map the Gender and return the user-friendly string.
- */
-const getGender = ({ input }) => {
-    const matches = genders_1.default.filter(gender => gender.id === input);
-    if (1 === matches.length) {
-        return matches[0].name;
-    }
-    return 'Undefined';
-};
-exports.default = getGender;

package/file/createDirectory.d.ts

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

package/file/createDirectory.js

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

package/file/writeFile.d.ts

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

package/file/writeFile.js

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

package/global/forceUpdate.d.ts

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

package/global/forceUpdate.js

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

package/global/init.d.ts

@@ -1,10 +0,0 @@
-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/global/init.js

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

package/global/isSet.d.ts

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

package/global/isSet.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Checks to see if a global key is set.
- */
-const isSet = async ({ key }) => {
-    return undefined === global['ems_cache'][key];
-};
-exports.default = isSet;

package/global/maxCache.d.ts

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

package/global/maxCache.js

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

package/global/read.d.ts

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

package/global/read.js

@@ -1,30 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const forceUpdate_1 = __importDefault(require("./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 (0, forceUpdate_1.default)({ key });
-        }
-    }
-    return global['ems_cache'][key].value;
-};
-exports.default = read;

package/google/bigQuery/IsTableExists.d.ts

@@ -1,11 +0,0 @@
-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;

package/google/bigQuery/IsTableExists.js

@@ -1,25 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getClient_1 = __importDefault(require("./getClient"));
-/**
- * Check to see whether a given BigQuery table exists.
- * https://cloud.google.com/bigquery/docs/samples/bigquery-table-exists
- */
-const isTableExists = async ({ datasetId, projectId, tableId }) => {
-    let response;
-    let client = (0, getClient_1.default)({ projectId });
-    const dataset = client.dataset(datasetId);
-    try {
-        await dataset.table(tableId)
-            .get();
-        response = true;
-    }
-    catch (exception) {
-        response = false;
-    }
-    return response;
-};
-exports.default = isTableExists;