@8ms/helpers 1.39.0 → 1.40.1

package/aws/s3/readBuffer.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 isResponse200_1 = __importDefault(require("../isResponse200"));
-const readFile_1 = require("./readFile");
-/**
- * Similar function to reading the S3 file, but instead of a text file return a buffer.
- */
-const readBuffer = async ({ bucket, key }) => {
-    let response = {
-        ...readFile_1.readFileDefault,
-        buffer: undefined,
-    };
-    const { GetObjectCommand } = require("@aws-sdk/client-s3");
-    const apiResponse = await global.awsS3Client.send(new GetObjectCommand({
-        Bucket: bucket,
-        Key: key,
-    }));
-    // console.log('apiResponse', apiResponse);
-    if ((0, isResponse200_1.default)({ apiResponse })) {
-        const chunks = [];
-        // Store the response
-        response.buffer = await new Promise((resolve, reject) => {
-            // @ts-ignore
-            apiResponse.Body.on("data", (chunk) => chunks.push(chunk));
-            // @ts-ignore
-            apiResponse.Body.on("error", (err) => reject(err));
-            // @ts-ignore
-            apiResponse.Body.on("end", () => resolve(Buffer.concat(chunks)));
-        });
-    }
-    else {
-        throw new Error("Error reading file.");
-    }
-    return response;
-};
-exports.default = readBuffer;

package/aws/s3/readFile.d.ts

@@ -1,31 +0,0 @@
-import { DurationComparison } from "../../date";
-export type Modified = {
-    now: number;
-    modified: {
-        unix: null | number;
-        [DurationComparison.VS_NOW]: {
-            months: number;
-            days: number;
-            hours: number;
-            minutes: number;
-        };
-        [DurationComparison.VS_MIDNIGHT]: {
-            hours: number;
-            minutes: number;
-        };
-    };
-};
-export type ReadFileResponse = Modified & {
-    body: any;
-};
-export declare const readFileDefault: ReadFileResponse;
-type ReadFile = {
-    bucket: string;
-    key: string;
-    isJson?: boolean;
-};
-/**
- * Read a file from S3 and return either null, the content or JSON decoded.
- */
-declare const readFile: ({ bucket, key, isJson }: ReadFile) => Promise<ReadFileResponse>;
-export default readFile;

package/aws/s3/readFile.js

@@ -1,83 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readFileDefault = void 0;
-const date_fns_1 = require("date-fns");
-const date_fns_2 = require("date-fns");
-const date_fns_3 = require("date-fns");
-const date_fns_4 = require("date-fns");
-const date_fns_5 = require("date-fns");
-const date_fns_6 = require("date-fns");
-const date_fns_7 = require("date-fns");
-const getToday_1 = __importDefault(require("../../date/getToday"));
-const getDate_1 = __importDefault(require("../../date/getDate"));
-const getStringFromStream_1 = __importDefault(require("../../string/getStringFromStream"));
-const isResponse200_1 = __importDefault(require("../isResponse200"));
-const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
-const isFileExists_1 = __importDefault(require("./isFileExists"));
-const date_1 = require("../../date");
-exports.readFileDefault = {
-    body: undefined,
-    now: undefined,
-    modified: {
-        unix: null,
-        [date_1.DurationComparison.VS_NOW]: {
-            months: 0,
-            days: 0,
-            hours: 0,
-            minutes: 0,
-        },
-        [date_1.DurationComparison.VS_MIDNIGHT]: {
-            hours: 0,
-            minutes: 0,
-        },
-    },
-};
-/**
- * Read a file from S3 and return either null, the content or JSON decoded.
- */
-const readFile = async ({ bucket, key, isJson }) => {
-    let response = (0, cloneDeep_1.default)(exports.readFileDefault);
-    const today = (0, getToday_1.default)({
-        setMidnight: false
-    });
-    response.now = (0, date_fns_7.getUnixTime)(today);
-    const doesFileExist = await (0, isFileExists_1.default)({
-        bucket,
-        key
-    });
-    // Only fetch the file if it exists
-    if (doesFileExist) {
-        const { GetObjectCommand } = require("@aws-sdk/client-s3");
-        const apiResponse = await global.awsS3Client.send(new GetObjectCommand({
-            Bucket: bucket,
-            Key: key,
-        }));
-        if ((0, isResponse200_1.default)({ apiResponse })) {
-            let now = today;
-            let modified = (0, getDate_1.default)({ input: apiResponse.LastModified, setMidnight: false });
-            // Convert the date to unix
-            response.modified.unix = (0, date_fns_7.getUnixTime)(modified);
-            // Compare now to unix
-            response.modified[date_1.DurationComparison.VS_NOW].months = (0, date_fns_4.differenceInMonths)(now, modified);
-            response.modified[date_1.DurationComparison.VS_NOW].days = (0, date_fns_1.differenceInDays)(now, modified);
-            response.modified[date_1.DurationComparison.VS_NOW].hours = (0, date_fns_2.differenceInHours)(now, modified);
-            response.modified[date_1.DurationComparison.VS_NOW].minutes = (0, date_fns_3.differenceInMinutes)(now, modified);
-            // Compare now to midnight
-            response.modified[date_1.DurationComparison.VS_MIDNIGHT].hours = (0, date_fns_5.getHours)(now);
-            response.modified[date_1.DurationComparison.VS_MIDNIGHT].minutes = (0, date_fns_6.getMinutes)(now);
-            // Convert stream into a string
-            response.body = await (0, getStringFromStream_1.default)({
-                stream: apiResponse.Body
-            });
-            // If we need to return JSON, parse it. On error return undefined
-            if (false !== isJson) {
-                response.body = JSON.parse(response.body) || undefined;
-            }
-        }
-    }
-    return response;
-};
-exports.default = readFile;

package/aws/s3/readGzip.d.ts

@@ -1,11 +0,0 @@
-import { ReadFileResponse } from "./readFile";
-type ReadBrotli = {
-    bucket: string;
-    key: string;
-    isJson?: boolean;
-};
-/**
- * Read a file from S3 and return either null, the content or JSON decoded.
- */
-declare const readGzip: ({ bucket, key, isJson }: ReadBrotli) => Promise<ReadFileResponse>;
-export default readGzip;

package/aws/s3/readGzip.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 readFile_1 = __importDefault(require("./readFile"));
-const getGzipDecompressed_1 = __importDefault(require("../../util/getGzipDecompressed"));
-/**
- * Read a file from S3 and return either null, the content or JSON decoded.
- */
-const readGzip = async ({ bucket, key, isJson }) => {
-    let response = await (0, readFile_1.default)({
-        bucket,
-        key,
-        isJson: false
-    });
-    // Cache exists and is still within our caching timeframe
-    if (undefined !== response.body) {
-        response.body = await (0, getGzipDecompressed_1.default)({
-            input: response.body,
-        });
-        if (false !== isJson) {
-            response.body = JSON.parse(response.body);
-        }
-    }
-    return response;
-};
-exports.default = readGzip;

package/aws/s3/writeBrotli.d.ts

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

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;