@8ms/helpers 2.3.4 → 2.3.6

package/googleCloud/bigquery/server/GoogleCloudBigqueryNamespace.d.ts

@@ -1,50 +0,0 @@
-import { BaseNamespace } from "../../../_class";
-import type { BigQuery, DatasetResource, QueryOptions } from "@google-cloud/bigquery";
-import { GoogleCloudConfig } from "../../server";
-export type QueryInput = string | {
-    query: string;
-    location?: string;
-    params: QueryOptions;
-};
-type Dataset = {
-    id: string;
-    location: string;
-    projectId: string;
-};
-type Table = {
-    id: string;
-};
-export declare class GoogleCloudBigqueryNamespace extends BaseNamespace {
-    client: BigQuery;
-    config: GoogleCloudConfig & {
-        projectId?: string;
-    };
-    ensureInit: () => Promise<void>;
-    /**
-     * Create a Dataset if it doesn't already exist.
-     * Returns table instance.
-     */
-    createDataset: (datasetId: string, options?: DatasetResource) => Promise<void>;
-    /**
-     * Check to see whether a given Bigquery dataset exists.
-     * Based off:
-     * https://github.com/googleapis/nodejs-bigquery/blob/main/samples/getDataset.js
-     */
-    datasetExists: (datasetId: string) => Promise<any>;
-    /**
-     * Retrieve all the Datasets
-     */
-    getDatasets: () => Promise<Dataset[]>;
-    query: (props: QueryInput) => Promise<any>;
-    /**
-     * Create a Table if it doesn't already exist.
-     */
-    createTable: (datasetId: string, datasetOptions: object, tableId: string, options?: object) => Promise<void>;
-    /**
-     * Check to see whether a given BigQuery table exists.
-     * https://cloud.google.com/bigquery/docs/samples/bigquery-table-exists
-     */
-    tableExists: (datasetId: string, tableId: string) => Promise<boolean>;
-    getTables: (datasetId: string) => Promise<Table[]>;
-}
-export {};

package/googleCloud/bigquery/server/GoogleCloudBigqueryNamespace.js

@@ -1,115 +0,0 @@
-import { BaseNamespace } from "../../../_class";
-import { getConfig } from "../../server";
-export class GoogleCloudBigqueryNamespace extends BaseNamespace {
-    ensureInit = async () => {
-        if (!this.client) {
-            try {
-                const { BigQuery } = await import("@google-cloud/bigquery");
-                const formattedConfig = getConfig(this.config, this.config?.projectId);
-                this.client = new BigQuery(formattedConfig);
-            }
-            catch (e) {
-                throw new Error("Google BigQuery Client not installed");
-            }
-        }
-    };
-    /**
-     * Create a Dataset if it doesn't already exist.
-     * Returns table instance.
-     */
-    createDataset = async (datasetId, options = {}) => {
-        await this.ensureInit();
-        const datasetExists = await this.datasetExists(datasetId);
-        if (!datasetExists) {
-            await this.client
-                .createDataset(datasetId);
-        }
-    };
-    /**
-     * Check to see whether a given Bigquery dataset exists.
-     * Based off:
-     * https://github.com/googleapis/nodejs-bigquery/blob/main/samples/getDataset.js
-     */
-    datasetExists = async (datasetId) => {
-        await this.ensureInit();
-        let response;
-        try {
-            await this.client.dataset(datasetId)
-                .get();
-            response = true;
-        }
-        catch (exception) {
-            response = false;
-        }
-        return response;
-    };
-    /**
-     * Retrieve all the Datasets
-     */
-    getDatasets = async () => {
-        await this.ensureInit();
-        let response = [];
-        const datasets = await this.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;
-    };
-    query = async (props) => {
-        await this.ensureInit();
-        let queryString = "string" === typeof props ? props : props.query;
-        let options = "string" === typeof props ? {} : props?.params;
-        const apiResponse = await this.client.query(queryString, options);
-        return apiResponse;
-    };
-    /**
-     * Create a Table if it doesn't already exist.
-     */
-    createTable = async (datasetId, datasetOptions = {}, tableId, options = {}) => {
-        await this.ensureInit();
-        // Create the BigQuery table if it doesn't exist
-        await this.createDataset(datasetId, datasetOptions);
-        const tableExists = await this.tableExists(datasetId, tableId);
-        if (!tableExists) {
-            await this.client
-                .dataset(datasetId)
-                .createTable(tableId, options || {});
-        }
-    };
-    /**
-     * Check to see whether a given BigQuery table exists.
-     * https://cloud.google.com/bigquery/docs/samples/bigquery-table-exists
-     */
-    tableExists = async (datasetId, tableId) => {
-        await this.ensureInit();
-        let response = false;
-        const tables = await this.getTables(datasetId);
-        for (let i = 0; i < tables.length; i++) {
-            if (tables[i].id === tableId) {
-                response = true;
-                break;
-            }
-        }
-        return response;
-    };
-    getTables = async (datasetId) => {
-        await this.ensureInit();
-        let response = [];
-        const tables = await this.client.dataset(datasetId)
-            .getTables();
-        if (tables?.[0]) {
-            for (let i = 0; i < tables[0].length; i++) {
-                response.push({
-                    id: tables[0][i].id,
-                });
-            }
-        }
-        return response;
-    };
-}

package/googleCloud/bigquery/server/googleCloudBigquery.d.ts

@@ -1,5 +0,0 @@
-import { GoogleCloudBigqueryNamespace } from "./GoogleCloudBigqueryNamespace";
-export type { GoogleCloudBigqueryNamespace } from "./GoogleCloudBigqueryNamespace";
-import type { GoogleAuthOptions } from "@google-cloud/common";
-export declare const googleCloudBigqueryClient: (key?: string, projectId?: string, config?: GoogleAuthOptions, vaultId?: string, itemId?: string) => Promise<GoogleCloudBigqueryNamespace>;
-export declare const getHandlerPath: (input: string) => string;

package/googleCloud/bigquery/server/googleCloudBigquery.js

@@ -1,41 +0,0 @@
-import { GoogleCloudBigqueryNamespace } from "./GoogleCloudBigqueryNamespace";
-import { onePasswordClient } from "../../../onePassword/server";
-const googleCloudBigqueryNamespaces = new Map();
-export const googleCloudBigqueryClient = async (key = "default", projectId, config, vaultId, itemId) => {
-    if (googleCloudBigqueryNamespaces.has(key)) {
-        return googleCloudBigqueryNamespaces.get(key);
-    }
-    let instanceConfig;
-    if (config) {
-        instanceConfig = {
-            ...config,
-            projectId,
-        };
-    }
-    else if (vaultId && itemId) {
-        const onePasswordConfig = await (await onePasswordClient())
-            .getJsonNote(vaultId, itemId);
-        instanceConfig = {
-            ...onePasswordConfig,
-            projectId,
-        };
-    }
-    else if (process.env.GOOGLE_CLOUD_VAULT_ID && process.env.GOOGLE_CLOUD_ITEM_ID) {
-        const onePasswordConfig = await (await onePasswordClient())
-            .getJsonNote(process.env.GOOGLE_CLOUD_VAULT_ID, process.env.GOOGLE_CLOUD_ITEM_ID);
-        instanceConfig = {
-            ...onePasswordConfig,
-            projectId,
-        };
-    }
-    else {
-        throw new Error(`Config required for namespace '${key}'`);
-    }
-    const namespace = new GoogleCloudBigqueryNamespace(key, instanceConfig);
-    googleCloudBigqueryNamespaces.set(key, namespace);
-    return namespace;
-};
-export const getHandlerPath = (input) => {
-    return `${input.split(process.cwd())[1].substring(1)
-        .replace(/\\/g, "/")}`;
-};

package/googleCloud/bigquery/server/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./googleCloudBigquery";
-export * from "./GoogleCloudBigqueryNamespace";
-export * from "./loadData";

package/googleCloud/bigquery/server/index.js

@@ -1,3 +0,0 @@
-export * from "./googleCloudBigquery";
-export * from "./GoogleCloudBigqueryNamespace";
-export * from "./loadData";

package/googleCloud/bigquery/server/loadData.d.ts

@@ -1,19 +0,0 @@
-import { GoogleCloudBigqueryNamespace } from "./GoogleCloudBigqueryNamespace";
-type LoadData = {
-    googleCloudBigqueryClient: GoogleCloudBigqueryNamespace;
-    googleCloudStorageClient: any;
-    file: {
-        bucket: string;
-        key: string;
-        metadata: object;
-    };
-    table: {
-        datasetId: string;
-        tableId: string;
-    };
-};
-/**
- * Load data into a given table using Google Cloud Storage.
- */
-export declare const loadData: ({ file, googleCloudBigqueryClient, googleCloudStorageClient, table }: LoadData) => Promise<void>;
-export {};

package/googleCloud/bigquery/server/loadData.js

@@ -1,14 +0,0 @@
-/**
- * Load data into a given table using Google Cloud Storage.
- */
-export const loadData = async ({ file, googleCloudBigqueryClient, googleCloudStorageClient, table }) => {
-    const tableExists = await googleCloudBigqueryClient.tableExists(table.datasetId, table.tableId);
-    if (tableExists) {
-        await googleCloudBigqueryClient.client
-            .dataset(table.datasetId)
-            .table(table.tableId)
-            .load(googleCloudStorageClient.client
-            .bucket(file.bucket)
-            .file(file.key), file.metadata);
-    }
-};

package/googleCloud/server/googleCloud.d.ts

@@ -1,29 +0,0 @@
-export type GoogleCloudConfig = {
-    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;
-};
-/**
- * Using the response from Parameter Store and format it ready to be used with Google API.
- */
-export declare const getConfig: (parameter: GoogleCloudConfig, projectId?: string) => {
-    credentials: {
-        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;
-    };
-};

package/googleCloud/server/googleCloud.js

@@ -1,25 +0,0 @@
-/**
- * Using the response from Parameter Store and format it ready to be used with Google API.
- */
-export const getConfig = (parameter, projectId) => {
-    // Format the private key to be in the same format as required by Google
-    const privateKey = parameter["private_key"].replace(/\\n/g, "\n");
-    let response = {
-        credentials: {
-            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"],
-        },
-    };
-    if (projectId) {
-        response['projectId'] = projectId;
-    }
-    return response;
-};

package/googleCloud/server/index.d.ts

@@ -1 +0,0 @@
-export * from "./googleCloud";

package/googleCloud/server/index.js

@@ -1 +0,0 @@
-export * from "./googleCloud";

package/googleCloud/sheets/server/GoogleCloudSheetsNamespace.d.ts

@@ -1,18 +0,0 @@
-import { BaseNamespace } from "../../../_class";
-import { GoogleCloudConfig } from "../../server";
-import type { GoogleAuth } from "googleapis-common";
-type GetBatchDataProps = {
-    spreadsheetId: string;
-    ranges: string[];
-    dateTimeRender?: string;
-    valueRender?: string;
-};
-export declare class GoogleCloudSheetsNamespace extends BaseNamespace {
-    client: GoogleAuth;
-    config: GoogleCloudConfig & {
-        projectId?: string;
-    };
-    ensureInit: () => Promise<void>;
-    getBatchData: (props: GetBatchDataProps) => Promise<import("@googleapis/sheets").sheets_v4.Schema$BatchGetValuesResponse>;
-}
-export {};

package/googleCloud/sheets/server/GoogleCloudSheetsNamespace.js

@@ -1,37 +0,0 @@
-import { BaseNamespace } from "../../../_class";
-import { getConfig } from "../../server";
-export class GoogleCloudSheetsNamespace extends BaseNamespace {
-    ensureInit = async () => {
-        if (!this.client) {
-            try {
-                const googleApisSheets = await import("@googleapis/sheets");
-                const formattedConfig = getConfig(this.config, this.config?.projectId);
-                this.client = new googleApisSheets.auth.GoogleAuth({
-                    ...formattedConfig,
-                    scopes: [
-                        "https://www.googleapis.com/auth/spreadsheets",
-                    ],
-                });
-            }
-            catch (e) {
-                throw new Error("Google Sheets Client not installed");
-            }
-        }
-    };
-    getBatchData = async (props) => {
-        await this.ensureInit();
-        const googleApisSheets = await import("@googleapis/sheets");
-        // Make the API request
-        const apiResponse = await googleApisSheets.sheets("v4")
-            .spreadsheets
-            .values
-            .batchGet({
-            auth: this.client,
-            dateTimeRenderOption: props?.dateTimeRender || "FORMATTED_STRING",
-            ranges: props.ranges,
-            spreadsheetId: props.spreadsheetId,
-            valueRenderOption: props?.valueRender || "UNFORMATTED_VALUE"
-        });
-        return apiResponse.data;
-    };
-}

package/googleCloud/sheets/server/getAssociatedData.d.ts

@@ -1,10 +0,0 @@
-type GetAssociatedDataProps = {
-    data: any;
-    dateTimeRender: 'FORMATTED_STRING' | 'SERIAL_NUMBER';
-    valueRender: 'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
-};
-/**
- * Pass a batch request using getBatchData and format the data into a key => value object per row.
- */
-export declare const getAssociatedData: (props: GetAssociatedDataProps) => Promise<object[]>;
-export {};

package/googleCloud/sheets/server/getAssociatedData.js

@@ -1,39 +0,0 @@
-/**
- * Pass a batch request using getBatchData and format the data into a key => value object per row.
- */
-export const getAssociatedData = async (props) => {
-    let template = [];
-    let response = [];
-    // Missing ranges or too many ranges
-    if (4 !== props.data.valueRanges.length) {
-        throw new Error("Associated data response length must be 4.");
-    }
-    // Get the first data range
-    const initialRangeLength = props.data.valueRanges[0].values[0].length;
-    // Loop through the headings
-    for (let i = 0; i < initialRangeLength; i++) {
-        template.push({
-            format: props.data.valueRanges[0].values[0][i],
-            default: props.data.valueRanges[1].values[0][i],
-            heading: props.data.valueRanges[2].values[0][i],
-            index: i,
-        });
-    }
-    // console.log('template', template);
-    // Loop through each row of data
-    if (undefined !== props.data.valueRanges[3].values) {
-        for (let rowIndex = 0; rowIndex < props.data.valueRanges[3].values.length; rowIndex++) {
-            let row = {};
-            // Loop through each column within the row
-            for (let columnIndex = 0; columnIndex < props.data.valueRanges[3].values[rowIndex].length; columnIndex++) {
-                const refValue = props.data.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;
-};

package/googleCloud/sheets/server/index.d.ts

@@ -1 +0,0 @@
-export * from "./GoogleCloudSheetsNamespace";

package/googleCloud/sheets/server/index.js

@@ -1 +0,0 @@
-export * from "./GoogleCloudSheetsNamespace";

package/googleCloud/storage/server/GoogleCloudStorageNamespace.d.ts

@@ -1,22 +0,0 @@
-import { BaseNamespace } from "../../../_class";
-import type { Storage } from "@google-cloud/storage";
-import { GoogleCloudConfig } from "../../server";
-export declare class GoogleCloudStorageNamespace extends BaseNamespace {
-    client: Storage;
-    config: GoogleCloudConfig & {
-        projectId?: string;
-    };
-    ensureInit: () => Promise<void>;
-    /**
-     * Copy a local file to Google Cloud Storage.
-     */
-    copyToCloud: (bucket: string, localFile: string, options?: {}) => Promise<import("@google-cloud/storage").UploadResponse>;
-    /**
-     * Check to see if a file exists but don't get the contents.
-     */
-    fileExists: (bucket: string, key: string) => Promise<boolean>;
-    /**
-     * Write a file to Google Cloud Storage.
-     */
-    writeFile: (bucket: string, key: string, data: any, options?: {}) => Promise<unknown>;
-}

package/googleCloud/storage/server/GoogleCloudStorageNamespace.js

@@ -1,66 +0,0 @@
-import { BaseNamespace } from "../../../_class";
-import { getConfig } from "../../server";
-export class GoogleCloudStorageNamespace extends BaseNamespace {
-    ensureInit = async () => {
-        if (!this.client) {
-            try {
-                const { Storage } = await import("@google-cloud/storage");
-                const formattedConfig = getConfig(this.config, this.config?.projectId);
-                this.client = new Storage(formattedConfig);
-            }
-            catch (e) {
-                throw new Error("Google Cloud Storage Client not installed");
-            }
-        }
-    };
-    /**
-     * Copy a local file to Google Cloud Storage.
-     */
-    copyToCloud = async (bucket, localFile, options = {}) => {
-        await this.ensureInit();
-        const apiResponse = await this.client
-            .bucket(bucket)
-            .upload(localFile, options);
-        return apiResponse;
-    };
-    /**
-     * Check to see if a file exists but don't get the contents.
-     */
-    fileExists = async (bucket, key) => {
-        await this.ensureInit();
-        const googleFile = await this.client
-            .bucket(bucket)
-            .file(key)
-            .exists();
-        const response = googleFile?.[0];
-        return response;
-    };
-    /**
-     * Write a file to Google Cloud Storage.
-     */
-    writeFile = async (bucket, key, data, options = {}) => {
-        await this.ensureInit();
-        const stream = await import("stream");
-        const dataStream = new stream.PassThrough();
-        const googleFile = this.client
-            .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);
-            });
-        });
-    };
-}

package/googleCloud/storage/server/googleCloudStorage.d.ts

@@ -1,3 +0,0 @@
-import { GoogleCloudStorageNamespace } from "./GoogleCloudStorageNamespace";
-import type { GoogleAuthOptions } from "@google-cloud/common";
-export declare const googleCloudStorageClient: (key?: string, projectId?: string, config?: GoogleAuthOptions, vaultId?: string, itemId?: string) => Promise<GoogleCloudStorageNamespace>;

package/googleCloud/storage/server/googleCloudStorage.js

@@ -1,37 +0,0 @@
-import { GoogleCloudStorageNamespace } from "./GoogleCloudStorageNamespace";
-import { onePasswordClient } from "../../../onePassword/server";
-const googleCloudStorageNamespaces = new Map();
-export const googleCloudStorageClient = async (key = "default", projectId, config, vaultId, itemId) => {
-    if (googleCloudStorageNamespaces.has(key)) {
-        return googleCloudStorageNamespaces.get(key);
-    }
-    let instanceConfig;
-    if (config) {
-        instanceConfig = {
-            ...config,
-            projectId,
-        };
-    }
-    else if (vaultId && itemId) {
-        const onePasswordConfig = await (await onePasswordClient())
-            .getJsonNote(vaultId, itemId);
-        instanceConfig = {
-            ...onePasswordConfig,
-            projectId,
-        };
-    }
-    else if (process.env.GOOGLE_CLOUD_VAULT_ID && process.env.GOOGLE_CLOUD_ITEM_ID) {
-        const onePasswordConfig = await (await onePasswordClient())
-            .getJsonNote(process.env.GOOGLE_CLOUD_VAULT_ID, process.env.GOOGLE_CLOUD_ITEM_ID);
-        instanceConfig = {
-            ...onePasswordConfig,
-            projectId,
-        };
-    }
-    else {
-        throw new Error(`Config required for namespace '${key}'`);
-    }
-    const namespace = new GoogleCloudStorageNamespace(key, instanceConfig);
-    googleCloudStorageNamespaces.set(key, namespace);
-    return namespace;
-};

package/googleCloud/storage/server/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./googleCloudStorage";
-export * from "./GoogleCloudStorageNamespace";

package/googleCloud/storage/server/index.js

@@ -1,2 +0,0 @@
-export * from "./googleCloudStorage";
-export * from "./GoogleCloudStorageNamespace";

package/googlePageSpeed/server/GooglePageSpeedNamespace.d.ts

@@ -1,11 +0,0 @@
-import { BaseNamespace } from "../../_class";
-import { Category, GooglePageSpeedConfig, Strategy } from "./";
-/**
- * Based on https://developers.google.com/speed/docs/insights/rest/v5/pagespeedapi/runpagespeed
- */
-export declare class GooglePageSpeedNamespace extends BaseNamespace {
-    client: boolean;
-    config: GooglePageSpeedConfig;
-    ensureInit: () => Promise<void>;
-    getReport: (url: string, inputCategory?: Category, inputStrategy?: Strategy) => Promise<any>;
-}

package/googlePageSpeed/server/GooglePageSpeedNamespace.js

@@ -1,27 +0,0 @@
-import { BaseNamespace } from "../../_class";
-import { category, strategy } from "./";
-import { get } from "../../axios";
-/**
- * Based on https://developers.google.com/speed/docs/insights/rest/v5/pagespeedapi/runpagespeed
- */
-export class GooglePageSpeedNamespace extends BaseNamespace {
-    ensureInit = async () => {
-        if (!this.client) {
-            try {
-                // There is not API client but potentially multiple keys to manage instances
-                this.client = true;
-            }
-            catch (e) {
-                throw new Error("Google PageSpeed Client not installed");
-            }
-        }
-    };
-    getReport = async (url, inputCategory = category.PERFORMANCE, inputStrategy = strategy.MOBILE) => {
-        const requestUrl = `https://www.googleapis.com/pagespeedonline/v5/runPagespeed?url=${url}&strategy=${inputStrategy}&category=${inputCategory}&key=${this.config.apiKey}`;
-        const apiResponse = await get(requestUrl);
-        if (apiResponse.isSuccess()) {
-            return apiResponse.getBody();
-        }
-        return null;
-    };
-}

package/googlePageSpeed/server/googlePageSpeed.d.ts

@@ -1,19 +0,0 @@
-import { GooglePageSpeedNamespace } from "./GooglePageSpeedNamespace";
-export type GooglePageSpeedConfig = {
-    apiKey: string;
-};
-export declare const googlePageSpeedClient: (key?: string, config?: GooglePageSpeedConfig, vaultId?: string, itemId?: string) => Promise<GooglePageSpeedNamespace>;
-export declare const category: {
-    readonly CATEGORY_UNSPECIFIED: "CATEGORY_UNSPECIFIED";
-    readonly ACCESSIBILITY: "ACCESSIBILITY";
-    readonly BEST_PRACTICES: "BEST_PRACTICES";
-    readonly PERFORMANCE: "PERFORMANCE";
-    readonly SEO: "SEO";
-};
-export type Category = typeof category[keyof typeof category];
-export declare const strategy: {
-    readonly STRATEGY_UNSPECIFIED: "STRATEGY_UNSPECIFIED";
-    readonly DESKTOP: "DESKTOP";
-    readonly MOBILE: "MOBILE";
-};
-export type Strategy = typeof strategy[keyof typeof strategy];