@8ms/helpers 1.39.0 → 1.40.1

package/aws/lambda/getHandlerPath.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const getHandlerPath = (props) => {
-    return `${props.input.split(process.cwd())[1].substring(1)
-        .replace(/\\/g, '/')}`;
-};
-exports.default = getHandlerPath;

package/aws/lambda/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: (props: InitClient) => void;
-export default initClient;

package/aws/lambda/initClient.js

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

package/aws/lambda/invoke.d.ts

@@ -1,13 +0,0 @@
-type Invoke = {
-    awaitResponse?: boolean;
-    functionName: string;
-    isJson?: boolean;
-    payload?: object;
-};
-/**
- * Invoke a AWS Lambda function by passing in the Function name and optional Payload data.
- * Runs asynchronously, doesn't wait for function to fully end.
- * Library: @aws-sdk/client-lambda
- */
-declare const invoke: (props: Invoke) => Promise<any>;
-export default invoke;

package/aws/lambda/invoke.js

@@ -1,61 +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 ApiResponse_1 = __importDefault(require("../../api/ApiResponse"));
-/**
- * Invoke a AWS Lambda function by passing in the Function name and optional Payload data.
- * Runs asynchronously, doesn't wait for function to fully end.
- * Library: @aws-sdk/client-lambda
- */
-const invoke = async (props) => {
-    let response = false;
-    const params = {
-        FunctionName: props.functionName,
-        InvocationType: true === props.awaitResponse ? 'RequestResponse' : 'Event',
-    };
-    // Payload is defined add to parameters
-    if (undefined !== props.payload) {
-        params['Payload'] = new Uint8Array(Buffer.from(JSON.stringify(props.payload)));
-    }
-    // Create the Lambda Command
-    const { InvokeCommand } = require('@aws-sdk/client-lambda');
-    const command = new InvokeCommand(params);
-    // Fire the event but don't wait for it to complete
-    const apiResponse = await global.awsLambdaClient.send(command);
-    // Success
-    if ((0, isResponse200_1.default)({ apiResponse })) {
-        // Return the data
-        if (props.awaitResponse && undefined !== apiResponse.Payload) {
-            const asciiDecoder = new TextDecoder('ascii');
-            response = asciiDecoder.decode(apiResponse.Payload);
-            // Decode string as JSON object
-            if (true === props.isJson) {
-                response = JSON.parse(response);
-                // If it's still a string, double decode it
-                if ('string' === typeof response) {
-                    response = JSON.parse(response);
-                }
-                // If the response is a ApiResponse compatible
-                if (undefined !== response &&
-                    // @ts-ignore
-                    undefined !== response?.error &&
-                    // @ts-ignore
-                    undefined !== response?.state) {
-                    response = (new ApiResponse_1.default()).fromJson({
-                        // @ts-ignore
-                        input: response
-                    });
-                }
-            }
-        }
-        // Success but not waiting for response
-        else {
-            response = true;
-        }
-    }
-    return response;
-};
-exports.default = invoke;

package/aws/s3/copyFile.d.ts

@@ -1,13 +0,0 @@
-export type File = {
-    bucket: string;
-    key: string;
-};
-type CopyFile = {
-    from: File;
-    to: File;
-};
-/**
- * Copy a file from one bucket/path to another bucket/path.
- */
-declare const copyFile: ({ from, to }: CopyFile) => Promise<void>;
-export default copyFile;

package/aws/s3/copyFile.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Copy a file from one bucket/path to another bucket/path.
- */
-const copyFile = async ({ from, to }) => {
-    const { CopyObjectCommand } = require('@aws-sdk/client-s3');
-    await global.awsS3Client.send(new CopyObjectCommand({
-        Bucket: to.bucket,
-        CopySource: encodeURIComponent(`${from.bucket}/${from.key}`),
-        Key: to.key,
-    }));
-};
-exports.default = copyFile;

package/aws/s3/deleteFile.d.ts

@@ -1,9 +0,0 @@
-type DeleteFile = {
-    bucket: string;
-    key: string;
-};
-/**
- * Delete a single file.
- */
-declare const deleteFile: ({ bucket, key }: DeleteFile) => Promise<void>;
-export default deleteFile;

package/aws/s3/deleteFile.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Delete a single file.
- */
-const deleteFile = async ({ bucket, key }) => {
-    const { DeleteObjectCommand } = require('@aws-sdk/client-s3');
-    await global.awsS3Client.send(new DeleteObjectCommand({
-        Bucket: bucket,
-        Key: key,
-    }));
-};
-exports.default = deleteFile;

package/aws/s3/deleteFiles.d.ts

@@ -1,9 +0,0 @@
-type DeleteFiles = {
-    bucket: string;
-    keys: string[];
-};
-/**
- * Delete multiple files.
- */
-declare const deleteFiles: ({ bucket, keys }: DeleteFiles) => Promise<void>;
-export default deleteFiles;

package/aws/s3/deleteFiles.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Delete multiple files.
- */
-const deleteFiles = async ({ bucket, keys }) => {
-    const { DeleteObjectsCommand } = require('@aws-sdk/client-s3');
-    await global.awsS3Client.send(new DeleteObjectsCommand({
-        Bucket: bucket,
-        Delete: {
-            Objects: keys.map(key => ({
-                Key: key,
-            })),
-        },
-    }));
-};
-exports.default = deleteFiles;

package/aws/s3/deleteFolder.d.ts

@@ -1,9 +0,0 @@
-type DeleteFolder = {
-    bucket: string;
-    folder: string;
-};
-/**
- * Iteratively delete all the files within a directory and delete the directory.
- */
-declare const deleteFolder: ({ bucket, folder }: DeleteFolder) => Promise<void>;
-export default deleteFolder;

package/aws/s3/deleteFolder.js

@@ -1,36 +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 getFolder_1 = __importDefault(require("../../string/getFolder"));
-/**
- * Iteratively delete all the files within a directory and delete the directory.
- */
-const deleteFolder = async ({ bucket, folder }) => {
-    const cleanFolder = (0, getFolder_1.default)({ input: folder });
-    const { ListObjectsV2Command, DeleteObjectsCommand } = require('@aws-sdk/client-s3');
-    // Get a list of all files to be deleted
-    const apiResponse = await global.awsS3Client.send(new ListObjectsV2Command({
-        Bucket: bucket,
-        Prefix: ('' === cleanFolder ? '' : cleanFolder + '/'),
-    }));
-    // No files to be deleted
-    if (apiResponse.Contents.length === 0) {
-        return;
-    }
-    // Map each of the files
-    const keys = apiResponse.Contents.map(file => ({ Key: file.Key }));
-    // Delete the files
-    await global.awsS3Client.send(new DeleteObjectsCommand({
-        Bucket: bucket,
-        Delete: {
-            Objects: keys,
-        },
-    }));
-    // If we didn't get all files, run it again
-    if (apiResponse.IsTruncated) {
-        await deleteFolder({ bucket, folder });
-    }
-};
-exports.default = deleteFolder;

package/aws/s3/getGlueJson.d.ts

@@ -1,8 +0,0 @@
-type GetGlueJson = {
-    data: any;
-};
-/**
- * @deprecated in favour of getJsonNewline
- */
-declare const getGlueJson: ({ data }: GetGlueJson) => string;
-export default getGlueJson;

package/aws/s3/getGlueJson.js

@@ -1,11 +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 getJsonNewline_1 = __importDefault(require("../../json/getJsonNewline"));
-/**
- * @deprecated in favour of getJsonNewline
- */
-const getGlueJson = ({ data }) => (0, getJsonNewline_1.default)({ data });
-exports.default = getGlueJson;

package/aws/s3/getPresignedPost.d.ts

@@ -1,20 +0,0 @@
-type PresignedPost = {
-    url: string;
-    fields: any;
-};
-type GetPresignedPost = {
-    bucket: string;
-    conditions: any[];
-    expires: number;
-    fields: {
-        [key: string]: string;
-    };
-    key: string;
-};
-/**
- * Returns a presigned post to upload a file directly to S3.
- * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_s3_presigned_post.html
- * https://github.com/8millionstories-organisation/test-vercel-upload-2/blob/50eb12fcb3870a59ab455811bfaa1bdcb886edf2/pages/api/upload-url.js
- */
-declare const getPresignedPost: ({ bucket, conditions, expires, fields, key }: GetPresignedPost) => Promise<PresignedPost>;
-export default getPresignedPost;

package/aws/s3/getPresignedPost.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Returns a presigned post to upload a file directly to S3.
- * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_s3_presigned_post.html
- * https://github.com/8millionstories-organisation/test-vercel-upload-2/blob/50eb12fcb3870a59ab455811bfaa1bdcb886edf2/pages/api/upload-url.js
- */
-const getPresignedPost = async ({ bucket, conditions, expires, fields, key }) => {
-    const { createPresignedPost } = require('@aws-sdk/client-s3');
-    const apiResponse = await createPresignedPost(global.awsS3Client, {
-        Bucket: bucket,
-        Key: key,
-        Conditions: undefined === conditions ? [] : conditions,
-        Fields: undefined === fields ? {} : fields,
-        Expires: undefined === expires ? 60 : expires, // Seconds
-    });
-    return apiResponse;
-};
-exports.default = getPresignedPost;

package/aws/s3/getSignedUrl.d.ts

@@ -1,12 +0,0 @@
-import { Response } from '../../api/response';
-type GetSignedUrl = {
-    bucket: string;
-    expires: number;
-    key: string;
-};
-/**
- * Returns a signed for URL to allow download of private buckets for a given duration.
- * Library: @aws-sdk/s3-request-presigner
- */
-declare const getSignedUrl: ({ bucket, expires, key }: GetSignedUrl) => Promise<Response>;
-export default getSignedUrl;

package/aws/s3/getSignedUrl.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Returns a signed for URL to allow download of private buckets for a given duration.
- * Library: @aws-sdk/s3-request-presigner
- */
-const getSignedUrl = async ({ bucket, expires, key }) => {
-    const { GetObjectCommand } = require('@aws-sdk/client-s3');
-    const { getSignedUrl } = require('@aws-sdk/s3-request-presigner');
-    const command = new GetObjectCommand({
-        Bucket: bucket,
-        Key: key,
-    });
-    const response = await getSignedUrl(global.awsS3Client, command, { expiresIn: expires });
-    return response;
-};
-exports.default = getSignedUrl;

package/aws/s3/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-s3
- */
-declare const initClient: ({ config }: InitClient) => void;
-export default initClient;

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

package/aws/s3/isFileExists.d.ts

@@ -1,9 +0,0 @@
-type IsFileExists = {
-    bucket: string;
-    key: string;
-};
-/**
- * Check to see if a file exists but don't get the contents.
- */
-declare const isFileExists: (props: IsFileExists) => Promise<boolean>;
-export default isFileExists;

package/aws/s3/isFileExists.js

@@ -1,27 +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"));
-/**
- * Check to see if a file exists but don't get the contents.
- */
-const isFileExists = async (props) => {
-    let response = false;
-    try {
-        const { HeadObjectCommand } = require("@aws-sdk/client-s3");
-        // Fetch from S3
-        const apiResponse = await global.awsS3Client.send(new HeadObjectCommand({
-            Bucket: props.bucket,
-            Key: props.key,
-        }));
-        // If the status is 200 then it does exist
-        response = (0, isResponse200_1.default)({ apiResponse });
-    }
-    catch (exception) {
-        response = false;
-    }
-    return response;
-};
-exports.default = isFileExists;

package/aws/s3/listFiles.d.ts

@@ -1,9 +0,0 @@
-type ListFiles = {
-    bucket: string;
-    folder: string;
-};
-/**
- * List the files in the given bucket and option folder
- */
-declare const listFiles: ({ bucket, folder }: ListFiles) => Promise<string[]>;
-export default listFiles;

package/aws/s3/listFiles.js

@@ -1,33 +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 getFolder_1 = __importDefault(require("../../string/getFolder"));
-/**
- * List the files in the given bucket and option folder
- */
-const listFiles = async ({ bucket, folder = '' }) => {
-    const cleanFolder = (0, getFolder_1.default)({ input: folder });
-    let response = [];
-    let valid = [];
-    const { ListObjectsV2Command } = require('@aws-sdk/client-s3');
-    const apiResponse = await global.awsS3Client.send(new ListObjectsV2Command({
-        Bucket: bucket,
-        Delimiter: '/',
-        Prefix: ('' === cleanFolder ? '' : cleanFolder + '/'),
-    }));
-    // Ensure the data exists
-    if (undefined !== apiResponse['Contents']) {
-        // Return an array of files
-        valid = apiResponse['Contents'].filter(content => {
-            const keyExploded = content['Key'].split('/');
-            return keyExploded[keyExploded.length - 1].indexOf('.') > -1;
-        });
-        if (valid.length) {
-            response = valid.map(entry => entry['Key']);
-        }
-    }
-    return response;
-};
-exports.default = listFiles;

package/aws/s3/listFilesIteratively.d.ts

@@ -1,9 +0,0 @@
-type ListFilesIteratively = {
-    bucket: string;
-    folder: string;
-};
-/**
- * Fetch all the files within a given directory recursively
- */
-declare const listFilesIteratively: (props: ListFilesIteratively) => Promise<string[]>;
-export default listFilesIteratively;

package/aws/s3/listFilesIteratively.js

@@ -1,44 +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 listFolders_1 = __importDefault(require("./listFolders"));
-const listFiles_1 = __importDefault(require("./listFiles"));
-/**
- * Sub function
- */
-const iterateFolders = async (props) => {
-    let response = [];
-    const folders = await (0, listFolders_1.default)({
-        bucket: props.bucket,
-        folder: props.folder,
-    });
-    for (let i = 0; i < folders.length; i++) {
-        const subFolderFiles = await iterateFolders({
-            bucket: props.bucket,
-            folder: `${props.folder}/${folders[i]}`,
-        });
-        const files = await (0, listFiles_1.default)({
-            bucket: props.bucket,
-            folder: `${props.folder}/${folders[i]}`,
-        });
-        response = [
-            ...response,
-            ...files,
-            ...subFolderFiles,
-        ];
-    }
-    return response;
-};
-/**
- * Fetch all the files within a given directory recursively
- */
-const listFilesIteratively = async (props) => {
-    const response = await iterateFolders({
-        bucket: props.bucket,
-        folder: props.folder,
-    });
-    return response;
-};
-exports.default = listFilesIteratively;

package/aws/s3/listFolders.d.ts

@@ -1,9 +0,0 @@
-type ListFolders = {
-    bucket: string;
-    folder: string;
-};
-/**
- * List the files in the given bucket and option folder.
- */
-declare const listFolders: ({ bucket, folder }: ListFolders) => Promise<string[]>;
-export default listFolders;

package/aws/s3/listFolders.js

@@ -1,32 +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 getFolder_1 = __importDefault(require("../../string/getFolder"));
-/**
- * List the files in the given bucket and option folder.
- */
-const listFolders = async ({ bucket, folder }) => {
-    const cleanFolder = (0, getFolder_1.default)({ input: folder });
-    let response = [];
-    const { ListObjectsV2Command } = require('@aws-sdk/client-s3');
-    const apiResponse = await global.awsS3Client.send(new ListObjectsV2Command({
-        Bucket: bucket,
-        Delimiter: '/',
-        Prefix: ('' === cleanFolder ? '' : cleanFolder + '/'),
-    }));
-    // Ensure the data exists
-    if (undefined !== apiResponse['CommonPrefixes']) {
-        // Return an array of folders removing the trailing folder
-        response = apiResponse['CommonPrefixes'].map(prefix => {
-            // Remove the trailing slash then split by slash
-            const fileFolders = prefix.Prefix.slice(0, -1)
-                .split('/');
-            // Return the last folder without a trailing slash
-            return fileFolders[fileFolders.length - 1];
-        });
-    }
-    return response;
-};
-exports.default = listFolders;

package/aws/s3/moveFile.d.ts

@@ -1,10 +0,0 @@
-import { File } from './copyFile';
-type MoveFiles = {
-    from: File;
-    to: File;
-};
-/**
- * It's not possible to just move or rename a file, you must copy then delete the old file.
- */
-declare const moveFile: ({ from, to }: MoveFiles) => Promise<void>;
-export default moveFile;

package/aws/s3/moveFile.js

@@ -1,21 +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 copyFile_1 = __importDefault(require("./copyFile"));
-const deleteFile_1 = __importDefault(require("./deleteFile"));
-/**
- * It's not possible to just move or rename a file, you must copy then delete the old file.
- */
-const moveFile = async ({ from, to }) => {
-    await (0, copyFile_1.default)({
-        from,
-        to,
-    });
-    await (0, deleteFile_1.default)({
-        bucket: from.bucket,
-        key: from.key,
-    });
-};
-exports.default = moveFile;

package/aws/s3/readBrotli.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 readBrotli: ({ bucket, key, isJson }: ReadBrotli) => Promise<ReadFileResponse>;
-export default readBrotli;

package/aws/s3/readBrotli.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 getBrotliDecompressed_1 = __importDefault(require("../../util/getBrotliDecompressed"));
-const readFile_1 = __importDefault(require("./readFile"));
-/**
- * Read a file from S3 and return either null, the content or JSON decoded.
- */
-const readBrotli = 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, getBrotliDecompressed_1.default)({
-            input: response.body,
-        });
-        if (false !== isJson) {
-            response.body = JSON.parse(response.body);
-        }
-    }
-    return response;
-};
-exports.default = readBrotli;

package/aws/s3/readBuffer.d.ts

@@ -1,13 +0,0 @@
-import { Modified } from "./readFile";
-export type ReadBufferResponse = Modified & {
-    buffer: any;
-};
-type ReadBuffer = {
-    bucket: string;
-    key: string;
-};
-/**
- * Similar function to reading the S3 file, but instead of a text file return a buffer.
- */
-declare const readBuffer: ({ bucket, key }: ReadBuffer) => Promise<ReadBufferResponse>;
-export default readBuffer;