@8ms/helpers 1.40.6 → 1.40.9

package/eskimi/endpoints.js

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

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

package/eskimi/genders.js

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

@@ -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/eskimi/getAccessToken.js

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

@@ -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/eskimi/getAgeGroup.js

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

@@ -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/eskimi/getCampaignIds.js

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

@@ -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/eskimi/getData.js

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

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

package/eskimi/getDevice.js

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

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

package/eskimi/getGender.js

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

@@ -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/file/createDirectory.js

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

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

package/file/writeFile.js

@@ -0,0 +1,3 @@
+"use strict";
+const writeFile = () => {
+};

package/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/global/forceUpdate.js

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

@@ -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/global/init.js

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

@@ -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/global/isSet.js

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

@@ -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/global/maxCache.js

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

@@ -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/global/read.js

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

@@ -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;

package/google/bigQuery/IsTableExists.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 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;

package/google/bigQuery/createDataset.d.ts

@@ -0,0 +1,11 @@
+type CreateDataset = {
+    datasetId: string;
+    projectId?: string;
+    options: object;
+};
+/**
+ * Create a Dataset if it doesn't already exist.
+ * Returns table instance.
+ */
+declare const createDataset: ({ datasetId, options, projectId }: CreateDataset) => Promise<void>;
+export default createDataset;

package/google/bigQuery/createDataset.js

@@ -0,0 +1,22 @@
+"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"));
+const isDatasetExists_1 = __importDefault(require("./isDatasetExists"));
+/**
+ * Create a Dataset if it doesn't already exist.
+ * Returns table instance.
+ */
+const createDataset = async ({ datasetId, options, projectId }) => {
+    const datasetExists = await (0, isDatasetExists_1.default)({
+        datasetId,
+        projectId,
+    });
+    if (!datasetExists) {
+        let client = (0, getClient_1.default)({ projectId });
+        await client.createDataset(datasetId, options || {});
+    }
+};
+exports.default = createDataset;

package/google/bigQuery/createTable.d.ts

@@ -0,0 +1,12 @@
+type CreateTable = {
+    datasetId: string;
+    datasetOptions?: object;
+    projectId?: string;
+    options?: object;
+    tableId: string;
+};
+/**
+ * Create a Table if it doesn't already exist.
+ */
+declare const createTable: ({ datasetId, datasetOptions, options, projectId, tableId }: CreateTable) => Promise<void>;
+export default createTable;

package/google/bigQuery/createTable.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const IsTableExists_1 = __importDefault(require("./IsTableExists"));
+const getClient_1 = __importDefault(require("./getClient"));
+const createDataset_1 = __importDefault(require("./createDataset"));
+/**
+ * Create a Table if it doesn't already exist.
+ */
+const createTable = async ({ datasetId, datasetOptions, options, projectId, tableId }) => {
+    // Create the BigQuery table if it doesn't exist
+    await (0, createDataset_1.default)({
+        datasetId,
+        options: datasetOptions,
+        projectId,
+    });
+    const tableExists = await (0, IsTableExists_1.default)({
+        datasetId,
+        projectId,
+        tableId
+    });
+    if (!tableExists) {
+        let client = (0, getClient_1.default)({ projectId });
+        await client
+            .dataset(datasetId)
+            .createTable(tableId, options || {});
+    }
+};
+exports.default = createTable;

package/google/bigQuery/getClient.d.ts

@@ -0,0 +1,9 @@
+type GetClient = {
+    location?: string;
+    projectId?: string;
+};
+/**
+ * Create a new client if the project id differs from the global.
+ */
+declare const getClient: (props: GetClient) => any;
+export default getClient;

package/google/bigQuery/getClient.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Create a new client if the project id differs from the global.
+ */
+const getClient = (props) => {
+    let client = global.googleBigQueryClient;
+    if (props?.projectId && props?.projectId !== global.googleBigQueryDefaultProjectId) {
+        const { BigQuery } = require('@google-cloud/bigquery');
+        client = new BigQuery({
+            credentials: global.googleBigQueryDefault.credentials,
+            location: props?.location || "europe-west2",
+            projectId: props?.projectId,
+        });
+    }
+    return client;
+};
+exports.default = getClient;

package/google/bigQuery/getDatasets.d.ts

@@ -0,0 +1,13 @@
+type GetDatasets = {
+    projectId?: string;
+};
+type Datasets = {
+    id: string;
+    location: string;
+    projectId: string;
+};
+/**
+ * Retrieve all the Datasets from a given Project.
+ */
+declare const getDatasets: ({ projectId }: GetDatasets) => Promise<Datasets[]>;
+export default getDatasets;

package/google/bigQuery/getDatasets.js

@@ -0,0 +1,27 @@
+"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"));
+/**
+ * Retrieve all the Datasets from a given Project.
+ */
+const getDatasets = async ({ projectId }) => {
+    let response = [];
+    const client = (0, getClient_1.default)({
+        projectId,
+    });
+    const datasets = await client.getDatasets();
+    if (datasets?.[0]) {
+        for (let i = 0; i < datasets[0].length; i++) {
+            response.push({
+                id: datasets[0][i].id,
+                location: datasets[0][i].location,
+                projectId: datasets[0][i].bigQuery.projectId,
+            });
+        }
+    }
+    return response;
+};
+exports.default = getDatasets;

package/google/bigQuery/getTables.d.ts

@@ -0,0 +1,12 @@
+type GetTables = {
+    datasetId?: string;
+    projectId?: string;
+};
+type Tables = {
+    id: string;
+};
+/**
+ * Retrieve all the Tables from a given Project/Dataset.
+ */
+declare const getTables: (props: GetTables) => Promise<Tables[]>;
+export default getTables;

package/google/bigQuery/getTables.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 getClient_1 = __importDefault(require("./getClient"));
+/**
+ * Retrieve all the Tables from a given Project/Dataset.
+ */
+const getTables = async (props) => {
+    let response = [];
+    const client = (0, getClient_1.default)({
+        projectId: props.projectId,
+    });
+    const tables = await client.dataset(props.datasetId).getTables();
+    if (tables?.[0]) {
+        for (let i = 0; i < tables[0].length; i++) {
+            response.push({
+                id: tables[0][i].id,
+            });
+        }
+    }
+    return response;
+};
+exports.default = getTables;

package/google/bigQuery/initClient.d.ts

@@ -0,0 +1,11 @@
+import { Config } from '../getConfig';
+type InitClient = {
+    parameter: Config;
+    projectId: string;
+};
+/**
+ * Initialise the Big Query client.
+ * It's possible to use multiple clients, so we set one up per project id.
+ */
+declare const initClient: ({ parameter, projectId }: InitClient) => void;
+export default initClient;