@8ms/helpers 1.40.6 → 1.40.10

package/aws/s3cache/getKey.d.ts

@@ -0,0 +1,10 @@
+export type GetKey = {
+    fileName: any;
+    folder: string;
+};
+/**
+ * Take an input and return the key.
+ * Always in the "_cache" folder with the "environment" followed by the optional folder then the key.
+ */
+declare const getKey: ({ fileName, folder }: GetKey) => string;
+export default getKey;

package/aws/s3cache/getKey.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const trimStart_1 = __importDefault(require("lodash/trimStart"));
+const getSha256_1 = __importDefault(require("../../crypto/getSha256"));
+const getEnvironment_1 = __importDefault(require("../../environment/getEnvironment"));
+/**
+ * Take an input and return the key.
+ * Always in the "_cache" folder with the "environment" followed by the optional folder then the key.
+ */
+const getKey = ({ fileName, folder }) => {
+    const fileNameString = (0, getSha256_1.default)({ input: fileName });
+    const folderPath = (0, trimStart_1.default)('' === folder ? '' : `${folder}/`, '/');
+    return `cache/${(0, getEnvironment_1.default)()}/${folderPath}${fileNameString}.json.gz`;
+};
+exports.default = getKey;

package/aws/s3cache/index.d.ts

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

package/aws/s3cache/index.js

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

package/aws/s3cache/saveCache.d.ts

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

package/aws/s3cache/saveCache.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const writeGzip_1 = __importDefault(require("../s3/writeGzip"));
+/**
+ * Save the cache.
+ */
+const saveCache = async ({ bucket, data, key }) => {
+    return await (0, writeGzip_1.default)({
+        bucket,
+        data,
+        key,
+    });
+};
+exports.default = saveCache;

package/aws/s3cache/updateCache.d.ts

@@ -0,0 +1,10 @@
+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/aws/s3cache/updateCache.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const deleteFile_1 = __importDefault(require("../s3/deleteFile"));
+const getKey_1 = __importDefault(require("./getKey"));
+const saveCache_1 = __importDefault(require("./saveCache"));
+/**
+ * Delete other caches if present, then save the new file.
+ */
+const updateCache = async ({ bucket, data, fileName, folder }) => {
+    if (data && null !== data) {
+        const key = (0, getKey_1.default)({
+            fileName,
+            folder,
+        });
+        // Delete the existing file
+        await (0, deleteFile_1.default)({ bucket, key });
+        // Save the new file
+        await (0, saveCache_1.default)({ bucket, data, key });
+    }
+};
+exports.default = updateCache;

package/aws/ses/SimpleEmail.d.ts

@@ -0,0 +1,51 @@
+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/aws/ses/SimpleEmail.js

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ky_1 = __importDefault(require("ky"));
+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 ky_1.default.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_1.default(data);
+        }
+        // General success - some APIs report 201
+        else if (response.status >= 200 && response.status <= 299) {
+            return (new ApiResponse_1.default()).setToSuccess({
+                body: data,
+            });
+        }
+        // Error
+        return (new ApiResponse_1.default()).setToError({
+            body: 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

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

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ky_1 = __importDefault(require("ky"));
+const ApiResponse_1 = __importDefault(require("../api/ApiResponse"));
+/**
+ * Make a GET request.
+ */
+const get = async ({ config = {}, url }) => {
+    const response = await ky_1.default.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_1.default(data);
+        }
+        // General success - some APIs report 201
+        else if (response.status >= 200 && response.status <= 299) {
+            return (new ApiResponse_1.default()).setToSuccess({
+                body: data,
+            });
+        }
+        // Error
+        return (new ApiResponse_1.default()).setToError({
+            body: 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

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