@8ms/helpers 1.39.0 → 1.40.1

package/aws/ses/SimpleEmail.js

@@ -1,114 +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 uniq_1 = __importDefault(require("lodash/uniq"));
-const BaseClass_1 = __importDefault(require("../../class/BaseClass"));
-/**
- * Class to build and send an AWS SES email.
- */
-class SimpleEmail extends BaseClass_1.default {
-    constructor({ bcc, cc, from, html, subject, to }) {
-        super();
-        this.to = [];
-        this.cc = [];
-        this.bcc = [];
-        if (bcc) {
-            this.setBcc({ recipient: bcc });
-        }
-        if (cc) {
-            this.setCc({ recipient: cc });
-        }
-        if (from) {
-            this.setFrom({ from });
-        }
-        if (html) {
-            this.setHtml({ html });
-        }
-        if (subject) {
-            this.setSubject({ subject });
-        }
-        if (to) {
-            this.setTo({ recipient: to });
-        }
-        return this;
-    }
-    setFrom({ from }) {
-        return this._setValue({ input: from, fields: "from" });
-    }
-    setHtml({ html }) {
-        return this._setValue({ input: html, fields: "html" });
-    }
-    setSubject({ subject }) {
-        return this._setValue({ input: subject, fields: "subject" });
-    }
-    pushBcc({ recipient }) {
-        return this._push({ input: recipient, fields: "bcc" });
-    }
-    pushCc({ recipient }) {
-        return this._push({ input: recipient, fields: "cc" });
-    }
-    pushTo({ recipient }) {
-        return this._push({ input: recipient, fields: "to" });
-    }
-    setBcc({ recipient }) {
-        return this._setArray({ input: recipient, fields: "bcc" });
-    }
-    setCc({ recipient }) {
-        return this._setArray({ input: recipient, fields: "cc" });
-    }
-    setTo({ recipient }) {
-        return this._setArray({ input: recipient, fields: "to" });
-    }
-    async send() {
-        const { SendEmailCommand } = require("@aws-sdk/client-ses");
-        let response;
-        // https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/ses-examples-sending-email.html
-        const params = {
-            Destination: {
-                BccAddresses: this._filterRecipients({ field: "bcc" }),
-                CcAddresses: this._filterRecipients({ field: "cc" }),
-                ToAddresses: this._filterRecipients({ field: "to" }),
-            },
-            Message: {
-                Body: {
-                    Html: {
-                        Charset: "UTF-8",
-                        Data: this.html,
-                    },
-                    Text: {
-                        Charset: "UTF-8",
-                        Data: this.html,
-                    },
-                },
-                Subject: {
-                    Charset: "UTF-8",
-                    Data: this.subject,
-                },
-            },
-            Source: this.from,
-        };
-        const command = new SendEmailCommand(params);
-        try {
-            response = await global.awsSesClient.send(command);
-        }
-        catch (exception) {
-            response = exception;
-        }
-        return response;
-    }
-    _filterRecipients({ field }) {
-        // Remove all undefined and null values
-        let response = this[field].filter(recipient => recipient && null !== recipient);
-        // Clean all the values
-        response = response.map(recipient => recipient.toLowerCase()
-            .trim());
-        // Remove all empty values
-        response = response.filter(recipient => "" !== recipient);
-        // Return only unique values
-        response = (0, uniq_1.default)(response);
-        return response;
-    }
-}
-exports.default = SimpleEmail;

package/aws/ses/initClient.d.ts

@@ -1,10 +0,0 @@
-import { Config } from '../getConfig';
-type InitClient = {
-    config: Config;
-};
-/**
- * Shorthand function to get the Lambda Client.
- * Library: @aws-sdk/client-ses
- */
-declare const initClient: ({ config }: InitClient) => void;
-export default initClient;

package/aws/ses/initClient.js

@@ -1,19 +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.awsSesClient = null;
-/**
- * Shorthand function to get the Lambda Client.
- * Library: @aws-sdk/client-ses
- */
-const initClient = ({ config }) => {
-    if (!global.awsSesClient) {
-        const { SESClient } = require('@aws-sdk/client-ses');
-        const formattedConfig = (0, getConfig_1.default)({ config });
-        global.awsSesClient = new SESClient(formattedConfig);
-    }
-};
-exports.default = initClient;

package/aws/sqs/addToQueue.d.ts

@@ -1,27 +0,0 @@
-export type AddedResponse = {
-    '$metadata': {
-        httpStatusCode: number;
-        requestId: string;
-        extendedRequestId: undefined | string;
-        cfId: undefined | string;
-        attempts: number;
-        totalRetryDelay: number;
-    };
-    MD5OfMessageBody: string;
-    MD5OfMessageAttributes: undefined | string;
-    MD5OfMessageSystemAttributes: undefined | string;
-    MessageId: string;
-    SequenceNumber: string;
-};
-type AddToQueue = {
-    data: any;
-    dedupeId: string;
-    groupId?: string;
-    queueId?: string;
-    queueUrl: string;
-};
-/**
- * https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sqs-examples-send-receive-messages.html
- */
-declare const addToQueue: ({ data, dedupeId, groupId, queueId, queueUrl }: AddToQueue) => Promise<AddedResponse>;
-export default addToQueue;

package/aws/sqs/addToQueue.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sqs-examples-send-receive-messages.html
- */
-const addToQueue = async ({ data, dedupeId, groupId, queueId, queueUrl }) => {
-    const { SendMessageCommand } = require('@aws-sdk/client-sqs');
-    let params = {
-        MessageBody: JSON.stringify({
-            queueId,
-            data,
-        }),
-        QueueUrl: queueUrl,
-    };
-    // Required for FIFO
-    if (undefined !== dedupeId) {
-        params["MessageDeduplicationId"] = dedupeId;
-    }
-    // Required for FIFO
-    if (undefined !== groupId) {
-        params["MessageGroupId"] = dedupeId;
-    }
-    const sendData = await global.awsSqsClient.send(new SendMessageCommand(params));
-    return sendData;
-};
-exports.default = addToQueue;

package/aws/sqs/deleteFromQueue.d.ts

@@ -1,10 +0,0 @@
-import { AddedResponse } from './addToQueue';
-type DeleteFromQueue = {
-    queueUrl: string;
-    recipientHandle: string;
-};
-/**
- * Delete a message from a queue.
- */
-declare const deleteFromQueue: ({ queueUrl, recipientHandle }: DeleteFromQueue) => Promise<AddedResponse>;
-export default deleteFromQueue;

package/aws/sqs/deleteFromQueue.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Delete a message from a queue.
- */
-const deleteFromQueue = async ({ queueUrl, recipientHandle }) => {
-    const { DeleteMessageCommand } = require('@aws-sdk/client-sqs');
-    const params = {
-        QueueUrl: queueUrl,
-        ReceiptHandle: recipientHandle,
-    };
-    const sendData = await global.awsSqsClient.send(new DeleteMessageCommand(params));
-    return sendData;
-};
-exports.default = deleteFromQueue;

package/aws/sqs/initClient.d.ts

@@ -1,10 +0,0 @@
-import { Config } from '../getConfig';
-type InitClient = {
-    config: Config;
-};
-/**
- * Shorthand function to get the Lambda Client.
- * Library: @aws-sdk/client-lambda
- */
-declare const initClient: ({ config }: InitClient) => void;
-export default initClient;

package/aws/sqs/initClient.js

@@ -1,19 +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.awsSqsClient = null;
-/**
- * Shorthand function to get the Lambda Client.
- * Library: @aws-sdk/client-lambda
- */
-const initClient = ({ config }) => {
-    if (!global.awsLambdaClient) {
-        const { SQSClient } = require('@aws-sdk/client-sqs');
-        const formattedConfig = (0, getConfig_1.default)({ config });
-        global.awsSqsClient = new SQSClient(formattedConfig);
-    }
-};
-exports.default = initClient;

package/aws/sqs/isEventSqs.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Check to see if the request is an SQS queued event,
- */
-const isEventSqs = ({ event }) => {
-    let response = false;
-    if (undefined !== event['Records']) {
-        for (let i = 0; i < event['Records'].length; i++) {
-        }
-    }
-    return response;
-};

package/aws/ssm/getParameter.d.ts

@@ -1,10 +0,0 @@
-type GetParameter = {
-    name: string;
-    withDecryption?: boolean;
-    isJson?: boolean;
-};
-/**
- * Get a parameter and decryption if necessary (secure string)
- */
-declare const getParameter: ({ name, withDecryption, isJson }: GetParameter) => Promise<any>;
-export default getParameter;

package/aws/ssm/getParameter.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-global["awsSsmParameters"] = {};
-/**
- * Get a parameter and decryption if necessary (secure string)
- */
-const getParameter = async ({ name, withDecryption, isJson }) => {
-    // Haven't fetched already
-    if (undefined === global["awsSsmParameters"][name]) {
-        const { GetParameterCommand } = require('@aws-sdk/client-ssm');
-        const apiResponse = await global.awsSsmClient.send(new GetParameterCommand({
-            Name: name,
-            WithDecryption: undefined === withDecryption ? true : withDecryption,
-        }));
-        if (apiResponse.Parameter.Value) {
-            // Value is undefined
-            if (undefined === apiResponse.Parameter.Value) {
-                global["awsSsmParameters"][name] = null;
-            }
-            // Value is defined
-            else {
-                // isJson is default - decode
-                if (undefined === isJson || true === isJson) {
-                    global["awsSsmParameters"][name] = JSON.parse(apiResponse.Parameter.Value) || null;
-                }
-                // Not JSON don't decode
-                else {
-                    global["awsSsmParameters"][name] = apiResponse.Parameter.Value;
-                }
-            }
-        }
-        // Value not found (null so it can be sent from server to front end)
-        else {
-            global["awsSsmParameters"][name] = null;
-        }
-    }
-    // Return the loaded result
-    return global["awsSsmParameters"][name];
-};
-exports.default = getParameter;

package/aws/ssm/initClient.d.ts

@@ -1,10 +0,0 @@
-import { Config } from '../getConfig';
-type InitClient = {
-    config: Config;
-};
-/**
- * Shorthand function to get the Lambda Client.
- * Library: @aws-sdk/client-ssm
- */
-declare const initClient: ({ config }: InitClient) => void;
-export default initClient;

package/aws/ssm/initClient.js

@@ -1,19 +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.awsSsmClient = null;
-/**
- * Shorthand function to get the Lambda Client.
- * Library: @aws-sdk/client-ssm
- */
-const initClient = ({ config }) => {
-    if (!global.awsSsmClient) {
-        const { SSMClient } = require('@aws-sdk/client-ssm');
-        const formattedConfig = (0, getConfig_1.default)({ config });
-        global.awsSsmClient = new SSMClient(formattedConfig);
-    }
-};
-exports.default = initClient;

package/axios/delete.d.ts

@@ -1,11 +0,0 @@
-import ApiResponse from '../api/ApiResponse';
-export type Delete = {
-    config?: object;
-    url: string;
-};
-/**
- * Make a DELETE request.
- * Cant use the function name delete as its reserved
- */
-declare const deleteRequest: (props: Delete) => Promise<ApiResponse>;
-export default deleteRequest;

package/axios/delete.js

@@ -1,39 +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 axios_1 = __importDefault(require("axios"));
-const ApiResponse_1 = __importDefault(require("../api/ApiResponse"));
-/**
- * Make a DELETE request.
- * Cant use the function name delete as its reserved
- */
-const deleteRequest = async (props) => {
-    const response = await axios_1.default.delete(props.url, props?.config ?? {})
-        .then(async (response) => {
-        // Is API response
-        if (undefined !== response.data.body && undefined !== response.data.error && undefined !== response.data.state) {
-            return new ApiResponse_1.default(response.data);
-        }
-        // General success - some APIs report 201
-        else if (response.status >= 200 && response.status <= 299) {
-            return (new ApiResponse_1.default()).setToSuccess({
-                body: response.data,
-            });
-        }
-        // Error
-        return (new ApiResponse_1.default()).setToError({
-            body: response.data,
-            error: response.statusText,
-        });
-    })
-        .catch(error => {
-        // Error
-        return (new ApiResponse_1.default()).setToError({
-            error: error.message,
-        });
-    });
-    return response;
-};
-exports.default = deleteRequest;

package/axios/get.d.ts

@@ -1,10 +0,0 @@
-import ApiResponse from '../api/ApiResponse';
-export type Get = {
-    config?: object;
-    url: string;
-};
-/**
- * Make a GET request.
- */
-declare const get: ({ config, url }: Get) => Promise<ApiResponse>;
-export default get;

package/axios/get.js

@@ -1,38 +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 axios_1 = __importDefault(require("axios"));
-const ApiResponse_1 = __importDefault(require("../api/ApiResponse"));
-/**
- * Make a GET request.
- */
-const get = async ({ config = {}, url }) => {
-    const response = await axios_1.default.get(url, config)
-        .then(async (response) => {
-        // Is API response
-        if (undefined !== response.data.body && undefined !== response.data.error && undefined !== response.data.state) {
-            return new ApiResponse_1.default(response.data);
-        }
-        // General success - some APIs report 201
-        else if (response.status >= 200 && response.status <= 299) {
-            return (new ApiResponse_1.default()).setToSuccess({
-                body: response.data,
-            });
-        }
-        // Error
-        return (new ApiResponse_1.default()).setToError({
-            body: response.data,
-            error: response.statusText,
-        });
-    })
-        .catch(error => {
-        // Error
-        return (new ApiResponse_1.default()).setToError({
-            error: error.message,
-        });
-    });
-    return response;
-};
-exports.default = get;

package/axios/post.d.ts

@@ -1,11 +0,0 @@
-import ApiResponse from '../api/ApiResponse';
-export type Post = {
-    config?: object;
-    data?: object;
-    url: string;
-};
-/**
- * Make a POST request.
- */
-declare const post: ({ config, data, url }: Post) => Promise<ApiResponse>;
-export default post;

package/axios/post.js

@@ -1,38 +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 axios_1 = __importDefault(require("axios"));
-const ApiResponse_1 = __importDefault(require("../api/ApiResponse"));
-/**
- * Make a POST request.
- */
-const post = async ({ config = {}, data = {}, url }) => {
-    const response = await axios_1.default.post(url, data, config)
-        .then(async (response) => {
-        // Is API response
-        if (undefined !== response.data.body && undefined !== response.data.error && undefined !== response.data.state) {
-            return new ApiResponse_1.default(response.data);
-        }
-        // General success - some APIs report 201
-        else if (response.status >= 200 && response.status <= 299) {
-            return (new ApiResponse_1.default()).setToSuccess({
-                body: response.data,
-            });
-        }
-        // Error
-        return (new ApiResponse_1.default()).setToError({
-            body: response.data,
-            error: response.statusText,
-        });
-    })
-        .catch(error => {
-        // Error
-        return (new ApiResponse_1.default()).setToError({
-            error: error.message,
-        });
-    });
-    return response;
-};
-exports.default = post;

package/boolean/getBoolean.d.ts

@@ -1,7 +0,0 @@
-/**
- * Convert an input from a variety of forms into boolean.
- */
-declare const getBoolean: ({ input }: {
-    input: any;
-}) => boolean;
-export default getBoolean;

package/boolean/getBoolean.js

@@ -1,16 +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 isBoolean_1 = __importDefault(require("lodash/isBoolean"));
-/**
- * Convert an input from a variety of forms into boolean.
- */
-const getBoolean = ({ input }) => {
-    if ((0, isBoolean_1.default)(input)) {
-        return input;
-    }
-    return 'true' === input || 1 === input || '1' === input || 'yes' === input || 'y' === input;
-};
-exports.default = getBoolean;

package/brightData/getCustomerId.d.ts

@@ -1,10 +0,0 @@
-import { Param } from "./param";
-type GetCustomerId = {
-    auth: Param;
-    prefix?: string;
-};
-/**
- * Return the customer Id based on the username.
- */
-declare const getCustomerId: (props: GetCustomerId) => string;
-export default getCustomerId;

package/brightData/getCustomerId.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Return the customer Id based on the username.
- */
-const getCustomerId = (props) => {
-    const segments = props.auth.username.split("-")[2];
-    const customerId = segments[2].replace("hl_", "");
-    return (props?.prefix || "") + customerId;
-};
-exports.default = getCustomerId;

package/brightData/getZone.d.ts

@@ -1,9 +0,0 @@
-import { Param } from "./param";
-type GetZone = {
-    auth: Param;
-};
-/**
- * Return the Zone based on the username.
- */
-declare const getZone: (props: GetZone) => string;
-export default getZone;

package/brightData/getZone.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Return the Zone based on the username.
- */
-const getZone = (props) => {
-    const segments = props.auth.username.split("-");
-    return segments[segments.length - 1];
-};
-exports.default = getZone;

package/brightData/param.d.ts

@@ -1,9 +0,0 @@
-export type Param = {
-    apiKey: string;
-    host: string;
-    port: string;
-    username: string;
-    password: string;
-};
-declare const _default: {};
-export default _default;

package/brightData/param.js

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

package/brightData/serpApi/buildGoogleSerpUrl.d.ts

@@ -1,32 +0,0 @@
-type BuildGoogleSerpUrl = {
-    country?: string;
-    device?: "mobile" | "android" | "androidTablet" | "iphone" | "ipad";
-    language?: string;
-    geoLocation?: string;
-    hotel?: {
-        dates?: string;
-        occupancy?: number;
-    };
-    pagination?: {
-        offset?: number;
-        perPage?: number;
-    };
-    searchType?: "images" | "jobs" | "news" | "shopping" | "video";
-    query: string;
-    googleDomain: string;
-    output?: "html" | "json";
-    returnType: "url" | "json";
-};
-/**
- * Construct the Google SERP url using Bright Data's API:
- * https://brightdata.com/cp/serp_api/api/google/search?id=c_2cef083f
- *
- * For geolocation use value from:
- * https://developers.google.com/google-ads/api/data/geotargets
- */
-declare const buildGoogleSerpUrl: (props: BuildGoogleSerpUrl) => string | {
-    query: {
-        q: string;
-    };
-};
-export default buildGoogleSerpUrl;