@8ms/helpers 1.42.3 → 1.42.6

package/dist/esm/aws/s3cache/index.d.ts

@@ -1,6 +0,0 @@
-import { DurationComparison, Interval } from "../../date";
-export type Cache = {
-    duration: number;
-    from: DurationComparison;
-    timeframe: Interval;
-};

package/dist/esm/aws/s3cache/index.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/aws/s3cache/saveCache.d.ts

@@ -1,10 +0,0 @@
-type SaveCache = {
-    bucket: string;
-    data: any;
-    key: string;
-};
-/**
- * Save the cache.
- */
-declare const saveCache: ({ bucket, data, key }: SaveCache) => Promise<any>;
-export default saveCache;

package/dist/esm/aws/s3cache/saveCache.js

@@ -1,12 +0,0 @@
-import writeGzip from "../s3/writeGzip";
-/**
- * Save the cache.
- */
-const saveCache = async ({ bucket, data, key }) => {
-    return await writeGzip({
-        bucket,
-        data,
-        key,
-    });
-};
-export default saveCache;

package/dist/esm/aws/s3cache/updateCache.d.ts

@@ -1,10 +0,0 @@
-import { GetKey } from './getKey';
-type UpdateCache = GetKey & {
-    bucket: string;
-    data: any;
-};
-/**
- * Delete other caches if present, then save the new file.
- */
-declare const updateCache: ({ bucket, data, fileName, folder }: UpdateCache) => Promise<void>;
-export default updateCache;

package/dist/esm/aws/s3cache/updateCache.js

@@ -1,19 +0,0 @@
-import deleteFile from '../s3/deleteFile';
-import getKey from './getKey';
-import saveCache from './saveCache';
-/**
- * Delete other caches if present, then save the new file.
- */
-const updateCache = async ({ bucket, data, fileName, folder }) => {
-    if (data && null !== data) {
-        const key = getKey({
-            fileName,
-            folder,
-        });
-        // Delete the existing file
-        await deleteFile({ bucket, key });
-        // Save the new file
-        await saveCache({ bucket, data, key });
-    }
-};
-export default updateCache;

package/dist/esm/aws/ses/SimpleEmail.d.ts

@@ -1,51 +0,0 @@
-import BaseClass from "../../class/BaseClass";
-type Constructor = {
-    bcc?: string[];
-    cc?: string[];
-    from?: string;
-    html?: string;
-    subject?: string;
-    to?: string | string[];
-};
-/**
- * Class to build and send an AWS SES email.
- */
-declare class SimpleEmail extends BaseClass {
-    from?: string;
-    to: string[];
-    cc: string[];
-    bcc: string[];
-    html?: string;
-    subject?: string;
-    constructor({ bcc, cc, from, html, subject, to }: Constructor);
-    setFrom({ from }: {
-        from: string;
-    }): this;
-    setHtml({ html }: {
-        html: string;
-    }): this;
-    setSubject({ subject }: {
-        subject: string;
-    }): this;
-    pushBcc({ recipient }: {
-        recipient: string | string[];
-    }): this;
-    pushCc({ recipient }: {
-        recipient: string | string[];
-    }): this;
-    pushTo({ recipient }: {
-        recipient: string | string[];
-    }): this;
-    setBcc({ recipient }: {
-        recipient: string | string[];
-    }): this;
-    setCc({ recipient }: {
-        recipient: string | string[];
-    }): this;
-    setTo({ recipient }: {
-        recipient: string | string[];
-    }): this;
-    send(): Promise<boolean>;
-    private _filterRecipients;
-}
-export default SimpleEmail;

package/dist/esm/aws/ses/SimpleEmail.js

@@ -1,109 +0,0 @@
-import uniq from "lodash/uniq";
-import BaseClass from "../../class/BaseClass";
-/**
- * Class to build and send an AWS SES email.
- */
-class SimpleEmail extends BaseClass {
-    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 = uniq(response);
-        return response;
-    }
-}
-export default SimpleEmail;

package/dist/esm/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/dist/esm/aws/ses/initClient.js

@@ -1,14 +0,0 @@
-import getConfig from '../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 = getConfig({ config });
-        global.awsSesClient = new SESClient(formattedConfig);
-    }
-};
-export default initClient;

package/dist/esm/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/dist/esm/aws/sqs/addToQueue.js

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

package/dist/esm/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/dist/esm/aws/sqs/deleteFromQueue.js

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

package/dist/esm/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/dist/esm/aws/sqs/initClient.js

@@ -1,14 +0,0 @@
-import getConfig from '../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 = getConfig({ config });
-        global.awsSqsClient = new SQSClient(formattedConfig);
-    }
-};
-export default initClient;

package/dist/esm/aws/sqs/isEventSqs.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/aws/sqs/isEventSqs.js

@@ -1,12 +0,0 @@
-/**
- * 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;
-};
-export {};

package/dist/esm/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/dist/esm/aws/ssm/getParameter.js

@@ -1,38 +0,0 @@
-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];
-};
-export default getParameter;

package/dist/esm/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/dist/esm/aws/ssm/initClient.js

@@ -1,14 +0,0 @@
-import getConfig from '../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 = getConfig({ config });
-        global.awsSsmClient = new SSMClient(formattedConfig);
-    }
-};
-export default initClient;

package/dist/esm/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/dist/esm/axios/delete.js

@@ -1,38 +0,0 @@
-import ApiResponse from "../api/ApiResponse";
-/**
- * Make a DELETE request.
- * Cant use the function name delete as its reserved
- */
-const deleteRequest = async (props) => {
-    const { default: ky } = await import("ky");
-    const response = await ky.delete(props.url, {
-        throwHttpErrors: false,
-        ...props.config
-    })
-        .then(async (response) => {
-        const data = await response.json();
-        // Is API response
-        if (undefined !== data.body && undefined !== data.error && undefined !== data.state) {
-            return new ApiResponse(data);
-        }
-        // General success - some APIs report 201
-        else if (response.status >= 200 && response.status <= 299) {
-            return (new ApiResponse()).setToSuccess({
-                body: data,
-            });
-        }
-        // Error
-        return (new ApiResponse()).setToError({
-            body: data,
-            error: response.statusText,
-        });
-    })
-        .catch(error => {
-        // Error
-        return (new ApiResponse()).setToError({
-            error: error.message,
-        });
-    });
-    return response;
-};
-export default deleteRequest;

package/dist/esm/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/dist/esm/axios/get.js

@@ -1,34 +0,0 @@
-import ApiResponse from "../api/ApiResponse";
-/**
- * Make a GET request.
- */
-const get = async ({ config = {}, url }) => {
-    const { default: ky } = await import("ky");
-    const response = await ky.get(url, { throwHttpErrors: false, ...config })
-        .then(async (response) => {
-        const data = await response.json();
-        // Is API response
-        if (undefined !== data.body && undefined !== data.error && undefined !== data.state) {
-            return new ApiResponse(data);
-        }
-        // General success - some APIs report 201
-        else if (response.status >= 200 && response.status <= 299) {
-            return (new ApiResponse()).setToSuccess({
-                body: data,
-            });
-        }
-        // Error
-        return (new ApiResponse()).setToError({
-            body: data,
-            error: response.statusText,
-        });
-    })
-        .catch(error => {
-        // Error
-        return (new ApiResponse()).setToError({
-            error: error.message,
-        });
-    });
-    return response;
-};
-export default get;

package/dist/esm/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/dist/esm/axios/post.js

@@ -1,34 +0,0 @@
-import ApiResponse from "../api/ApiResponse";
-/**
- * Make a POST request.
- */
-const post = async ({ config = {}, data = {}, url }) => {
-    const { default: ky } = await import("ky");
-    const response = await ky.post(url, { throwHttpErrors: false, json: data, ...config })
-        .then(async (response) => {
-        const data = await response.json();
-        // Is API response
-        if (undefined !== data.body && undefined !== data.error && undefined !== data.state) {
-            return new ApiResponse(data);
-        }
-        // General success - some APIs report 201
-        else if (response.status >= 200 && response.status <= 299) {
-            return (new ApiResponse()).setToSuccess({
-                body: data,
-            });
-        }
-        // Error
-        return (new ApiResponse()).setToError({
-            body: data,
-            error: response.statusText,
-        });
-    })
-        .catch(error => {
-        // Error
-        return (new ApiResponse()).setToError({
-            error: error.message,
-        });
-    });
-    return response;
-};
-export default post;

package/dist/esm/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/dist/esm/boolean/getBoolean.js

@@ -1,11 +0,0 @@
-import isBoolean from 'lodash/isBoolean';
-/**
- * Convert an input from a variety of forms into boolean.
- */
-const getBoolean = ({ input }) => {
-    if (isBoolean(input)) {
-        return input;
-    }
-    return 'true' === input || 1 === input || '1' === input || 'yes' === input || 'y' === input;
-};
-export default getBoolean;

package/dist/esm/boolean/tests/getBoolean.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/boolean/tests/getBoolean.test.js

@@ -1,21 +0,0 @@
-import getBoolean from '../getBoolean';
-test('getBoolean - True', () => {
-    expect(getBoolean({ input: true }))
-        .toBeTruthy();
-    expect(getBoolean({ input: 1 }))
-        .toBeTruthy();
-    expect(getBoolean({ input: '1' }))
-        .toBeTruthy();
-});
-test('getBoolean - False', () => {
-    expect(getBoolean({ input: false }))
-        .toBeFalsy();
-    expect(getBoolean({ input: 0 }))
-        .toBeFalsy();
-    expect(getBoolean({ input: '0' }))
-        .toBeFalsy();
-});
-test('getBoolean - Unexpected', () => {
-    expect(getBoolean({ input: 'test' }))
-        .toBeFalsy();
-});

package/dist/esm/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;