@8ms/helpers 1.42.3 → 1.42.6

package/dist/esm/google/bigQuery/loadData.js

@@ -1,27 +0,0 @@
-import isTableExists from './IsTableExists';
-import getBigqueryClient from "./getClient";
-import getStorageClient from "../storage/getClient";
-/**
- * Load data into a given table.
- */
-const loadData = async ({ file, table }) => {
-    const tableExists = await isTableExists({
-        datasetId: table.datasetId,
-        projectId: table.projectId,
-        tableId: table.tableId,
-    });
-    if (tableExists) {
-        let bigqueryClient = getBigqueryClient({
-            projectId: table.projectId
-        });
-        let storageClient = getStorageClient({
-            projectId: file.projectId
-        });
-        await bigqueryClient
-            .dataset(table.datasetId)
-            .table(table.tableId)
-            .load(storageClient.bucket(file.bucket)
-            .file(file.key), file.metadata);
-    }
-};
-export default loadData;

package/dist/esm/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/dist/esm/google/bigQuery/query.js

@@ -1,10 +0,0 @@
-import getClient from "./getClient";
-/**
- * Build the query and return the data.
- */
-const query = async ({ input, projectId }) => {
-    let client = getClient({ projectId });
-    const apiResponse = await client.query(input);
-    return apiResponse;
-};
-export default query;

package/dist/esm/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/dist/esm/google/getConfig.js

@@ -1,21 +0,0 @@
-/**
- * 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;
-};
-export default getConfig;

package/dist/esm/google/sheets/getAssociatedData.d.ts

@@ -1,16 +0,0 @@
-type GetAssociatedData = {
-    spreadsheetId: string;
-    ranges: [
-        format: string,
-        defaultRange: string,
-        heading: string,
-        data: string
-    ];
-    dateTimeRender: 'FORMATTED_STRING' | 'SERIAL_NUMBER';
-    valueRender: 'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
-};
-/**
- * Make a batch get to Google Sheets to retrieve the data correctly formatted, with default values provided.
- */
-declare const getAssociatedData: ({ dateTimeRender, ranges, spreadsheetId, valueRender }: GetAssociatedData) => Promise<object[]>;
-export default getAssociatedData;

package/dist/esm/google/sheets/getAssociatedData.js

@@ -1,48 +0,0 @@
-import getBatchData from './getBatchData';
-/**
- * Make a batch get to Google Sheets to retrieve the data correctly formatted, with default values provided.
- */
-const getAssociatedData = async ({ dateTimeRender, ranges, spreadsheetId, valueRender }) => {
-    // Make the API request
-    const apiResponse = await getBatchData({
-        spreadsheetId,
-        ranges,
-        dateTimeRender,
-        valueRender,
-    });
-    let template = [];
-    let response = [];
-    // Missing ranges or too many ranges
-    if (4 !== apiResponse.valueRanges.length) {
-        throw new Error("Associated data response length must be 4.");
-    }
-    // Get the first data range
-    const initialRangeLength = apiResponse.valueRanges[0].values[0].length;
-    // Loop through the headings
-    for (let i = 0; i < initialRangeLength; i++) {
-        template.push({
-            format: apiResponse.valueRanges[0].values[0][i],
-            default: apiResponse.valueRanges[1].values[0][i],
-            heading: apiResponse.valueRanges[2].values[0][i],
-            index: i,
-        });
-    }
-    // console.log('template', template);
-    // Loop through each row of data
-    if (undefined !== apiResponse.valueRanges[3].values) {
-        for (let rowIndex = 0; rowIndex < apiResponse.valueRanges[3].values.length; rowIndex++) {
-            let row = {};
-            // Loop through each column within the row
-            for (let columnIndex = 0; columnIndex < apiResponse.valueRanges[3].values[rowIndex].length; columnIndex++) {
-                const refValue = apiResponse.valueRanges[3].values[rowIndex][columnIndex];
-                const value = ('' === refValue ? template[columnIndex]['default'] : refValue);
-                // Add this to our row
-                row[template[columnIndex]['heading']] = value;
-            }
-            // Add the row to our response
-            response.push(row);
-        }
-    }
-    return response;
-};
-export default getAssociatedData;

package/dist/esm/google/sheets/getBatchData.d.ts

@@ -1,18 +0,0 @@
-type BatchData = {
-    spreadsheetId: string;
-    valueRanges: {
-        range: string;
-        majorDimension: 'rows' | 'dimension';
-        values: [
-            any[]
-        ];
-    }[];
-};
-type GetBatchData = {
-    spreadsheetId: string;
-    ranges: string[];
-    dateTimeRender?: string;
-    valueRender?: string;
-};
-declare const getBatchData: ({ spreadsheetId, ranges, dateTimeRender, valueRender, }: GetBatchData) => Promise<BatchData>;
-export default getBatchData;

package/dist/esm/google/sheets/getBatchData.js

@@ -1,17 +0,0 @@
-const getBatchData = async ({ spreadsheetId, ranges, dateTimeRender = 'FORMATTED_STRING', valueRender = 'UNFORMATTED_VALUE', }) => {
-    const googleApisSheets = require('@googleapis/sheets');
-    const request = {
-        auth: global.googleSheetsClient,
-        dateTimeRenderOption: dateTimeRender,
-        ranges: ranges,
-        spreadsheetId: spreadsheetId,
-        valueRenderOption: valueRender,
-    };
-    // Make the API request
-    const apiResponse = (await googleApisSheets.sheets('v4')
-        .spreadsheets
-        .values
-        .batchGet(request));
-    return apiResponse.data;
-};
-export default getBatchData;

package/dist/esm/google/sheets/initClient.d.ts

@@ -1,11 +0,0 @@
-import { Config } from '../getConfig';
-type InitClient = {
-    parameter: Config;
-};
-/**
- * Initialise the Google Sheets instance using the separate service method.
- * https://github.com/googleapis/google-api-nodejs-client
- * Library: @googleapis/sheets
- */
-declare const initClient: ({ parameter }: InitClient) => void;
-export default initClient;

package/dist/esm/google/sheets/initClient.js

@@ -1,20 +0,0 @@
-import getConfig from '../getConfig';
-global.googleSheetsClient = null;
-/**
- * Initialise the Google Sheets instance using the separate service method.
- * https://github.com/googleapis/google-api-nodejs-client
- * Library: @googleapis/sheets
- */
-const initClient = ({ parameter }) => {
-    if (!global.googleSheetsClient) {
-        const googleApisSheets = require('@googleapis/sheets');
-        const formattedConfig = getConfig({ parameter });
-        global.googleSheetsClient = new googleApisSheets.auth.GoogleAuth({
-            credentials: formattedConfig,
-            scopes: [
-                'https://www.googleapis.com/auth/spreadsheets',
-            ],
-        });
-    }
-};
-export default initClient;

package/dist/esm/google/sheets/isCellNa.d.ts

@@ -1,7 +0,0 @@
-/**
- * Noticed sometimes Google Sheets can struggle with import XML resulting to N/A values.
- */
-declare const isCellNa: ({ input }: {
-    input: any;
-}) => boolean;
-export default isCellNa;

package/dist/esm/google/sheets/isCellNa.js

@@ -1,5 +0,0 @@
-/**
- * Noticed sometimes Google Sheets can struggle with import XML resulting to N/A values.
- */
-const isCellNa = ({ input }) => '#N/A' === input;
-export default isCellNa;

package/dist/esm/google/storage/copyToCloud.d.ts

@@ -1,11 +0,0 @@
-type CopyToCloud = {
-    bucket: string;
-    localFile: string;
-    options?: object;
-    projectId?: string;
-};
-/**
- * Copy a local file to Google Cloud Storage.
- */
-export declare const copyToCloud: ({ bucket, localFile, options, projectId }: CopyToCloud) => Promise<any>;
-export default copyToCloud;

package/dist/esm/google/storage/copyToCloud.js

@@ -1,11 +0,0 @@
-import getClient from "./getClient";
-/**
- * Copy a local file to Google Cloud Storage.
- */
-export const copyToCloud = async ({ bucket, localFile, options, projectId }) => {
-    const bucketInstance = getClient({ projectId })
-        .bucket(bucket);
-    const apiResponse = await bucketInstance.upload(localFile, options);
-    return apiResponse;
-};
-export default copyToCloud;

package/dist/esm/google/storage/getClient.d.ts

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

package/dist/esm/google/storage/getClient.js

@@ -1,16 +0,0 @@
-/**
- * Create a new client if the project id differs from the global.
- */
-const getClient = ({ projectId }) => {
-    let client = global.googleStorageClient;
-    if (undefined !== projectId && projectId !== global.googleStorageDefault.projectId) {
-        const { Storage } = require('@google-cloud/storage');
-        client = new Storage({
-            credentials: global.googleStorageDefault.credentials,
-            location: "europe-west2",
-            projectId: projectId,
-        });
-    }
-    return client;
-};
-export default getClient;

package/dist/esm/google/storage/initClient.d.ts

@@ -1,12 +0,0 @@
-import { Config } from '../getConfig';
-type InitClient = {
-    parameter: Config;
-    projectId: string;
-};
-/**
- * Initialise the Google Sheets instance using the separate service method.
- * https://github.com/googleapis/google-api-nodejs-client
- * Library: @googleapis/sheets
- */
-declare const initClient: ({ parameter, projectId }: InitClient) => void;
-export default initClient;

package/dist/esm/google/storage/initClient.js

@@ -1,24 +0,0 @@
-import getConfig from '../getConfig';
-global.googleStorageDefault = {
-    credentials: null,
-    projectId: null,
-};
-global.googleStorageClient = null;
-/**
- * Initialise the Google Sheets instance using the separate service method.
- * https://github.com/googleapis/google-api-nodejs-client
- * Library: @googleapis/sheets
- */
-const initClient = ({ parameter, projectId }) => {
-    if (!global.googleStorageClient) {
-        const { Storage } = require('@google-cloud/storage');
-        const formattedConfig = getConfig({ parameter });
-        global.googleStorageDefault.credentials = formattedConfig;
-        global.googleStorageDefault.projectId = projectId;
-        global.googleStorageClient = new Storage({
-            credentials: formattedConfig,
-            projectId: projectId,
-        });
-    }
-};
-export default initClient;

package/dist/esm/google/storage/isFileExists.d.ts

@@ -1,10 +0,0 @@
-type IsFileExists = {
-    bucket: string;
-    key: string;
-    projectId?: string;
-};
-/**
- * Check to see if a file exists but don't get the contents.
- */
-declare const isFileExists: (props: IsFileExists) => Promise<boolean>;
-export default isFileExists;

package/dist/esm/google/storage/isFileExists.js

@@ -1,14 +0,0 @@
-import getClient from "./getClient";
-/**
- * Check to see if a file exists but don't get the contents.
- */
-const isFileExists = async (props) => {
-    const { bucket, key, projectId, } = props;
-    const googleFile = await getClient({ projectId })
-        .bucket(bucket)
-        .file(key)
-        .exists();
-    const response = googleFile?.[0];
-    return response;
-};
-export default isFileExists;

package/dist/esm/google/storage/writeFile.d.ts

@@ -1,11 +0,0 @@
-type WriteFile = {
-    bucket: string;
-    data: any;
-    key: string;
-    [options: string]: any;
-};
-/**
- * Write a file to Google Cloud Storage.
- */
-export declare const writeFile: (props: WriteFile) => Promise<any>;
-export default writeFile;

package/dist/esm/google/storage/writeFile.js

@@ -1,30 +0,0 @@
-import getClient from "./getClient";
-/**
- * Write a file to Google Cloud Storage.
- */
-export const writeFile = async (props) => {
-    const { bucket, contentType, data, key, projectId, ...options } = props;
-    const stream = require("stream");
-    const dataStream = new stream.PassThrough();
-    const googleFile = getClient({ projectId })
-        .bucket(bucket)
-        .file(key);
-    dataStream.push(data);
-    dataStream.push(null);
-    return await new Promise((resolve, reject) => {
-        dataStream.pipe(googleFile.createWriteStream({
-            contentType: "auto",
-            resumable: false,
-            validation: false,
-            metadata: {},
-            ...options,
-        }))
-            .on("error", (error) => {
-            reject(error);
-        })
-            .on("finish", () => {
-            resolve(true);
-        });
-    });
-};
-export default writeFile;

package/dist/esm/googleAds/getCustomer.d.ts

@@ -1,8 +0,0 @@
-type GetCustomer = {
-    customerId: string;
-};
-/**
- * Return the Google Ads Client with the specified customer set.
- */
-declare const getCustomer: ({ customerId }: GetCustomer) => Promise<any>;
-export default getCustomer;

package/dist/esm/googleAds/getCustomer.js

@@ -1,12 +0,0 @@
-/**
- * Return the Google Ads Client with the specified customer set.
- */
-const getCustomer = async ({ customerId }) => {
-    const customer = global.googleAdsClient.instance.Customer({
-        customer_id: customerId,
-        login_customer_id: global.googleAdsClient.mccAccountId,
-        refresh_token: global.googleAdsClient.refreshToken,
-    });
-    return customer;
-};
-export default getCustomer;

package/dist/esm/googleAds/initClient.d.ts

@@ -1,16 +0,0 @@
-export type GoogleAdsParameter = {
-    clientId: string;
-    clientSecret: string;
-    developerToken: string;
-    mccAccountId: string;
-    refreshToken: string;
-};
-type InitClient = {
-    parameter: GoogleAdsParameter;
-};
-/**
- * Shorthand function to get the Google Ads Client.
- * Library: google-ads-api
- */
-declare const initClient: ({ parameter }: InitClient) => Promise<void>;
-export default initClient;

package/dist/esm/googleAds/initClient.js

@@ -1,23 +0,0 @@
-global.googleAdsClient = {
-    instance: null,
-    mccAccountId: '',
-    refreshToken: '',
-};
-/**
- * Shorthand function to get the Google Ads Client.
- * Library: google-ads-api
- */
-const initClient = async ({ parameter }) => {
-    if (!global.googleAdsClient.instance) {
-        const { GoogleAdsApi } = require('google-ads-api');
-        // Create a new client instance
-        global.googleAdsClient.instance = new GoogleAdsApi({
-            client_id: parameter.clientId,
-            client_secret: parameter.clientSecret,
-            developer_token: parameter.developerToken,
-        });
-        global.googleAdsClient.mccAccountId = parameter.mccAccountId;
-        global.googleAdsClient.refreshToken = parameter.refreshToken;
-    }
-};
-export default initClient;