@8ms/helpers 1.38.0 → 2.0.0

package/aws/s3/writeBrotli.js

@@ -1,28 +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 getBrotliCompressed_1 = __importDefault(require("../../util/getBrotliCompressed"));
-const writeFile_1 = __importDefault(require("./writeFile"));
-/**
- * Write a brotli file to S3.
- */
-const writeBrotli = async ({ bucket, data, key, isJson, ...options }) => {
-    let finalData = data;
-    if (false !== isJson) {
-        finalData = JSON.stringify(data);
-    }
-    // Compress the data
-    const brotliData = await (0, getBrotliCompressed_1.default)({
-        input: finalData,
-    });
-    const apiResponse = await (0, writeFile_1.default)({
-        bucket,
-        data: brotliData,
-        key,
-        ...options,
-    });
-    return apiResponse;
-};
-exports.default = writeBrotli;

package/aws/s3/writeFile.d.ts

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

package/aws/s3/writeFile.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Write a file to S3.
- */
-const writeFile = async ({ bucket, data, key, ...options }) => {
-    const { PutObjectCommand } = require('@aws-sdk/client-s3');
-    const apiResponse = await global.awsS3Client.send(new PutObjectCommand({
-        Bucket: bucket,
-        Body: data,
-        Key: key,
-        ...options,
-    }));
-    return apiResponse;
-};
-exports.default = writeFile;

package/aws/s3/writeGzip.d.ts

@@ -1,12 +0,0 @@
-type WriteGzip = {
-    bucket: string;
-    data: any;
-    key: string;
-    isJson?: boolean;
-    [options: string]: any;
-};
-/**
- * Write a gzip file to S3.
- */
-declare const writeGzip: ({ bucket, data, key, isJson, ...options }: WriteGzip) => Promise<any>;
-export default writeGzip;

package/aws/s3/writeGzip.js

@@ -1,28 +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 getGzipCompressed_1 = __importDefault(require("../../util/getGzipCompressed"));
-const writeFile_1 = __importDefault(require("./writeFile"));
-/**
- * Write a gzip file to S3.
- */
-const writeGzip = async ({ bucket, data, key, isJson, ...options }) => {
-    let finalData = data;
-    if (false !== isJson) {
-        finalData = JSON.stringify(data);
-    }
-    // Compress the data
-    const brotliData = await (0, getGzipCompressed_1.default)({
-        input: finalData,
-    });
-    const apiResponse = await (0, writeFile_1.default)({
-        bucket,
-        data: brotliData,
-        key,
-        ...options,
-    });
-    return apiResponse;
-};
-exports.default = writeGzip;

package/aws/s3/writePresignedPost.d.ts

@@ -1,14 +0,0 @@
-import { Config } from '../getConfig';
-type WritePresignedPost = {
-    bucket: string;
-    config: Config;
-    fields: any;
-    file: any;
-    key: string;
-    url: string;
-};
-/**
- * Get a presigned post URL so we can upload directly to S3 via frontend.
- */
-declare const writePresignedPost: ({ bucket, config, fields, file, key, url }: WritePresignedPost) => Promise<null | string>;
-export default writePresignedPost;

package/aws/s3/writePresignedPost.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Get a presigned post URL so we can upload directly to S3 via frontend.
- */
-const writePresignedPost = async ({ bucket, config, fields, file, key, url }) => {
-    return new Promise(async (resolve, reject) => {
-        let response;
-        const formData = new FormData();
-        Object.entries({ fields, file })
-            .forEach(([key, value]) => {
-            // @ts-ignore
-            formData.append(key, value);
-        });
-        const upload = await fetch(url, {
-            method: 'POST',
-            body: formData,
-        });
-        // Uploaded to S3
-        if (upload.ok) {
-            response = `https://${bucket}.s3.${config.region}.amazonaws.com/${key}`;
-            resolve(response);
-        }
-        // Failed to upload to S3
-        else {
-            response = null;
-            reject(response);
-        }
-    });
-};
-exports.default = writePresignedPost;

package/aws/s3/writeUrlContents.d.ts

@@ -1,10 +0,0 @@
-type WriteUrlContents = {
-    bucket: string;
-    key: string;
-    url: string;
-};
-/**
- * Download a file and write to S3.
- */
-declare const writeUrlContents: ({ bucket, key, url }: WriteUrlContents) => Promise<void>;
-export default writeUrlContents;

package/aws/s3/writeUrlContents.js

@@ -1,26 +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 writeFile_1 = __importDefault(require("./writeFile"));
-/**
- * Download a file and write to S3.
- */
-const writeUrlContents = async ({ bucket, key, url }) => {
-    return (0, axios_1.default)(url, {
-        responseType: "arraybuffer",
-        responseEncoding: "binary",
-    })
-        .then(async (response) => {
-        await (0, writeFile_1.default)({
-            bucket,
-            data: response.data,
-            key,
-            ContentType: response.headers["content-type"],
-            ContentLength: response.headers["content-length"],
-        });
-    });
-};
-exports.default = writeUrlContents;

package/aws/s3cache/getCache.d.ts

@@ -1,11 +0,0 @@
-import { Cache } from "./";
-import { GetKey } from "./getKey";
-type GetCache = GetKey & {
-    bucket: string;
-    cache: Cache;
-};
-/**
- * Get the stored cache if it exists.
- */
-declare const getCache: ({ bucket, cache, fileName, folder }: GetCache) => Promise<any>;
-export default getCache;

package/aws/s3cache/getCache.js

@@ -1,37 +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 date_1 = require("../../date");
-const getKey_1 = __importDefault(require("./getKey"));
-const readGzip_1 = __importDefault(require("../s3/readGzip"));
-/**
- * Get the stored cache if it exists.
- */
-const getCache = async ({ bucket, cache, fileName, folder }) => {
-    let response = undefined;
-    // Store the cache key
-    const s3CacheKey = (0, getKey_1.default)({ fileName, folder });
-    // If a cache timeframe is provided and we're not preloading this data
-    if (cache) {
-        // Try to get the cache
-        try {
-            const cached = await (0, readGzip_1.default)({
-                bucket,
-                key: s3CacheKey,
-                isJson: true,
-            });
-            // Cache exists and is still within our caching timeframe
-            if (undefined !== cached.body && (date_1.Interval.FOREVER === cache.timeframe || cached.modified[cache.from][cache.timeframe] < cache.duration)) {
-                response = cached.body;
-            }
-        }
-        catch (error) {
-            // sendError(error, req, res, next);
-            // console.log('s3 error - ', error.message);
-        }
-    }
-    return response;
-};
-exports.default = getCache;

package/aws/s3cache/getKey.d.ts

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

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

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

package/aws/s3cache/index.js

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

package/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/aws/s3cache/saveCache.js

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

@@ -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/aws/s3cache/updateCache.js

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

@@ -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/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.d.ts

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