@8ms/helpers 1.39.0 → 1.40.1

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;

package/google/bigQuery/createDataset.d.ts

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

@@ -1,22 +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"));
-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

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

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

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

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

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

@@ -1,27 +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"));
-/**
- * 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

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

@@ -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"));
-/**
- * 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

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

package/google/bigQuery/initClient.js

@@ -1,29 +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 getConfig_1 = __importDefault(require("../getConfig"));
-global.googleBigQueryDefault = {
-    credentials: null,
-    projectId: null,
-};
-global.googleBigQueryClient = null;
-/**
- * Initialise the Big Query client.
- * It's possible to use multiple clients, so we set one up per project id.
- */
-const initClient = ({ parameter, projectId }) => {
-    if (!global.googleBigQueryClient) {
-        const { BigQuery } = require('@google-cloud/bigquery');
-        const formattedConfig = (0, getConfig_1.default)({ parameter });
-        global.googleBigQueryDefault.credentials = formattedConfig;
-        global.googleBigQueryDefault.projectId = projectId;
-        global.googleBigQueryClient = new BigQuery({
-            credentials: global.googleBigQueryDefault.credentials,
-            location: "europe-west2",
-            projectId: global.googleBigQueryDefault.projectId,
-        });
-    }
-};
-exports.default = initClient;

package/google/bigQuery/isDatasetExists.d.ts

@@ -1,11 +0,0 @@
-type IsDatasetExists = {
-    datasetId: string;
-    projectId?: string;
-};
-/**
- * Check to see whether a given BigQuery dataset exists.
- * Based off:
- * https://github.com/googleapis/nodejs-bigquery/blob/main/samples/getDataset.js
- */
-declare const isDatasetExists: ({ datasetId, projectId }: IsDatasetExists) => Promise<boolean>;
-export default isDatasetExists;

package/google/bigQuery/isDatasetExists.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 dataset exists.
- * Based off:
- * https://github.com/googleapis/nodejs-bigquery/blob/main/samples/getDataset.js
- */
-const isDatasetExists = async ({ datasetId, projectId }) => {
-    let response;
-    let client = (0, getClient_1.default)({ projectId });
-    try {
-        await client.dataset(datasetId)
-            .get();
-        response = true;
-    }
-    catch (exception) {
-        response = false;
-    }
-    return response;
-};
-exports.default = isDatasetExists;

package/google/bigQuery/loadData.d.ts

@@ -1,18 +0,0 @@
-type LoadData = {
-    file: {
-        bucket: string;
-        key: string;
-        metadata: object;
-        projectId?: string;
-    };
-    table: {
-        projectId?: string;
-        datasetId: string;
-        tableId: string;
-    };
-};
-/**
- * Load data into a given table.
- */
-declare const loadData: ({ file, table }: LoadData) => Promise<void>;
-export default loadData;

package/google/bigQuery/loadData.js

@@ -1,32 +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 IsTableExists_1 = __importDefault(require("./IsTableExists"));
-const getClient_1 = __importDefault(require("./getClient"));
-const getClient_2 = __importDefault(require("../storage/getClient"));
-/**
- * Load data into a given table.
- */
-const loadData = async ({ file, table }) => {
-    const tableExists = await (0, IsTableExists_1.default)({
-        datasetId: table.datasetId,
-        projectId: table.projectId,
-        tableId: table.tableId,
-    });
-    if (tableExists) {
-        let bigqueryClient = (0, getClient_1.default)({
-            projectId: table.projectId
-        });
-        let storageClient = (0, getClient_2.default)({
-            projectId: file.projectId
-        });
-        await bigqueryClient
-            .dataset(table.datasetId)
-            .table(table.tableId)
-            .load(storageClient.bucket(file.bucket)
-            .file(file.key), file.metadata);
-    }
-};
-exports.default = loadData;

package/google/bigQuery/query.d.ts

@@ -1,19 +0,0 @@
-/**
- * https://cloud.google.com/bigquery/docs/parameterized-queries
- */
-export type QueryInput = string | {
-    query: string;
-    location?: string;
-    params: {
-        [key: string]: any;
-    };
-};
-export type Query = {
-    input: QueryInput;
-    projectId?: string;
-};
-/**
- * Build the query and return the data.
- */
-declare const query: ({ input, projectId }: Query) => Promise<any>;
-export default query;

package/google/bigQuery/query.js

@@ -1,15 +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"));
-/**
- * Build the query and return the data.
- */
-const query = async ({ input, projectId }) => {
-    let client = (0, getClient_1.default)({ projectId });
-    const apiResponse = await client.query(input);
-    return apiResponse;
-};
-exports.default = query;

package/google/getConfig.d.ts

@@ -1,20 +0,0 @@
-export type Config = {
-    type: string;
-    project_id: string;
-    private_key_id: string;
-    private_key: string;
-    client_email: string;
-    client_id: string;
-    auth_uri: string;
-    token_uri: string;
-    auth_provider_x509_cert_url: string;
-    client_x509_cert_url: string;
-};
-export type GetConfig = {
-    parameter: Config;
-};
-/**
- * Using the response from Parameter Store and format it ready to be used with Google API.
- */
-declare const getConfig: ({ parameter }: GetConfig) => Config;
-export default getConfig;

package/google/getConfig.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Using the response from Parameter Store and format it ready to be used with Google API.
- */
-const getConfig = ({ parameter }) => {
-    // Format the private key to be in the same format as required by Google
-    const privateKey = parameter['private_key'].replace(/\\n/g, '\n');
-    const response = {
-        type: parameter['type'],
-        project_id: parameter['project_id'],
-        private_key_id: parameter['private_key_id'],
-        private_key: privateKey,
-        client_email: parameter['client_email'],
-        client_id: parameter['client_id'],
-        auth_uri: parameter['auth_uri'],
-        token_uri: parameter['token_uri'],
-        auth_provider_x509_cert_url: parameter['auth_provider_x509_cert_url'],
-        client_x509_cert_url: parameter['client_x509_cert_url'],
-    };
-    return response;
-};
-exports.default = getConfig;