@8ms/helpers 1.40.6 → 1.40.10

package/dist/aws/s3/getPresignedPost.d.mts

@@ -1,28 +0,0 @@
-//#region src/aws/s3/getPresignedPost.d.ts
-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>;
-//#endregion
-export { getPresignedPost as default };

package/dist/aws/s3/getPresignedPost.mjs

@@ -1,19 +0,0 @@
-import { t as __require } from "../../chunk-y_GBKt04.mjs";
-//#region src/aws/s3/getPresignedPost.ts
-/**
-* 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");
-	return await createPresignedPost(global.awsS3Client, {
-		Bucket: bucket,
-		Key: key,
-		Conditions: void 0 === conditions ? [] : conditions,
-		Fields: void 0 === fields ? {} : fields,
-		Expires: void 0 === expires ? 60 : expires
-	});
-};
-//#endregion
-export { getPresignedPost as default };

package/dist/aws/s3/getSignedUrl.d.mts

@@ -1,19 +0,0 @@
-import { t as Response } from "../../response-CKsarnP-.mjs";
-
-//#region src/aws/s3/getSignedUrl.d.ts
-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>;
-//#endregion
-export { getSignedUrl as default };

package/dist/aws/s3/getSignedUrl.mjs

@@ -1,17 +0,0 @@
-import { t as __require } from "../../chunk-y_GBKt04.mjs";
-//#region src/aws/s3/getSignedUrl.ts
-/**
-* 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
-	});
-	return await getSignedUrl(global.awsS3Client, command, { expiresIn: expires });
-};
-//#endregion
-export { getSignedUrl as default };

package/dist/aws/s3/initClient.d.mts

@@ -1,15 +0,0 @@
-import { Config } from "../getConfig.mjs";
-
-//#region src/aws/s3/initClient.d.ts
-type InitClient = {
-  config: Config;
-};
-/**
- * Shorthand function to get the Lambda Client.
- * Library: @aws-sdk/client-s3
- */
-declare const initClient: ({
-  config
-}: InitClient) => void;
-//#endregion
-export { initClient as default };

package/dist/aws/s3/initClient.mjs

@@ -1,17 +0,0 @@
-import { t as __require } from "../../chunk-y_GBKt04.mjs";
-import getConfig from "../getConfig.mjs";
-//#region src/aws/s3/initClient.ts
-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 = getConfig({ config });
-		global.awsS3Client = new S3Client(formattedConfig);
-	}
-};
-//#endregion
-export { initClient as default };

package/dist/aws/s3/isFileExists.d.mts

@@ -1,11 +0,0 @@
-//#region src/aws/s3/isFileExists.d.ts
-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>;
-//#endregion
-export { isFileExists as default };

package/dist/aws/s3/isFileExists.mjs

@@ -1,21 +0,0 @@
-import { t as __require } from "../../chunk-y_GBKt04.mjs";
-import isResponse200 from "../isResponse200.mjs";
-//#region src/aws/s3/isFileExists.ts
-/**
-* 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");
-		response = isResponse200({ apiResponse: await global.awsS3Client.send(new HeadObjectCommand({
-			Bucket: props.bucket,
-			Key: props.key
-		})) });
-	} catch (exception) {
-		response = false;
-	}
-	return response;
-};
-//#endregion
-export { isFileExists as default };

package/dist/aws/s3/listFiles.d.mts

@@ -1,14 +0,0 @@
-//#region src/aws/s3/listFiles.d.ts
-type ListFiles = {
-  bucket: string;
-  folder: string;
-};
-/**
- * List the files in the given bucket and option folder
- */
-declare const listFiles: ({
-  bucket,
-  folder
-}: ListFiles) => Promise<string[]>;
-//#endregion
-export { listFiles as default };

package/dist/aws/s3/listFiles.mjs

@@ -1,27 +0,0 @@
-import { t as __require } from "../../chunk-y_GBKt04.mjs";
-import getFolder from "../../string/getFolder.mjs";
-//#region src/aws/s3/listFiles.ts
-/**
-* List the files in the given bucket and option folder
-*/
-const listFiles = async ({ bucket, folder = "" }) => {
-	const cleanFolder = getFolder({ 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 + "/"
-	}));
-	if (void 0 !== apiResponse["Contents"]) {
-		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;
-};
-//#endregion
-export { listFiles as default };

package/dist/aws/s3/listFilesIteratively.d.mts

@@ -1,11 +0,0 @@
-//#region src/aws/s3/listFilesIteratively.d.ts
-type ListFilesIteratively = {
-  bucket: string;
-  folder: string;
-};
-/**
- * Fetch all the files within a given directory recursively
- */
-declare const listFilesIteratively: (props: ListFilesIteratively) => Promise<string[]>;
-//#endregion
-export { listFilesIteratively as default };

package/dist/aws/s3/listFilesIteratively.mjs

@@ -1,40 +0,0 @@
-import listFiles from "./listFiles.mjs";
-import listFolders from "./listFolders.mjs";
-//#region src/aws/s3/listFilesIteratively.ts
-/**
-* Sub function
-*/
-const iterateFolders = async (props) => {
-	let response = [];
-	const folders = await listFolders({
-		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 listFiles({
-			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) => {
-	return await iterateFolders({
-		bucket: props.bucket,
-		folder: props.folder
-	});
-};
-//#endregion
-export { listFilesIteratively as default };

package/dist/aws/s3/listFolders.d.mts

@@ -1,14 +0,0 @@
-//#region src/aws/s3/listFolders.d.ts
-type ListFolders = {
-  bucket: string;
-  folder: string;
-};
-/**
- * List the files in the given bucket and option folder.
- */
-declare const listFolders: ({
-  bucket,
-  folder
-}: ListFolders) => Promise<string[]>;
-//#endregion
-export { listFolders as default };

package/dist/aws/s3/listFolders.mjs

@@ -1,23 +0,0 @@
-import { t as __require } from "../../chunk-y_GBKt04.mjs";
-import getFolder from "../../string/getFolder.mjs";
-//#region src/aws/s3/listFolders.ts
-/**
-* List the files in the given bucket and option folder.
-*/
-const listFolders = async ({ bucket, folder }) => {
-	const cleanFolder = getFolder({ 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 + "/"
-	}));
-	if (void 0 !== apiResponse["CommonPrefixes"]) response = apiResponse["CommonPrefixes"].map((prefix) => {
-		const fileFolders = prefix.Prefix.slice(0, -1).split("/");
-		return fileFolders[fileFolders.length - 1];
-	});
-	return response;
-};
-//#endregion
-export { listFolders as default };

package/dist/aws/s3/moveFile.d.mts

@@ -1,16 +0,0 @@
-import { File } from "./copyFile.mjs";
-
-//#region src/aws/s3/moveFile.d.ts
-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>;
-//#endregion
-export { moveFile as default };

package/dist/aws/s3/moveFile.mjs

@@ -1,18 +0,0 @@
-import copyFile from "./copyFile.mjs";
-import deleteFile from "./deleteFile.mjs";
-//#region src/aws/s3/moveFile.ts
-/**
-* 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 copyFile({
-		from,
-		to
-	});
-	await deleteFile({
-		bucket: from.bucket,
-		key: from.key
-	});
-};
-//#endregion
-export { moveFile as default };

package/dist/aws/s3/readBrotli.d.mts

@@ -1,18 +0,0 @@
-import { ReadFileResponse } from "./readFile.mjs";
-
-//#region src/aws/s3/readBrotli.d.ts
-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>;
-//#endregion
-export { readBrotli as default };

package/dist/aws/s3/readBrotli.mjs

@@ -1,20 +0,0 @@
-import getBrotliDecompressed from "../../util/getBrotliDecompressed.mjs";
-import readFile from "./readFile.mjs";
-//#region src/aws/s3/readBrotli.ts
-/**
-* Read a file from S3 and return either null, the content or JSON decoded.
-*/
-const readBrotli = async ({ bucket, key, isJson }) => {
-	let response = await readFile({
-		bucket,
-		key,
-		isJson: false
-	});
-	if (void 0 !== response.body) {
-		response.body = await getBrotliDecompressed({ input: response.body });
-		if (false !== isJson) response.body = JSON.parse(response.body);
-	}
-	return response;
-};
-//#endregion
-export { readBrotli as default };

package/dist/aws/s3/readBuffer.d.mts

@@ -1,19 +0,0 @@
-import { Modified } from "./readFile.mjs";
-
-//#region src/aws/s3/readBuffer.d.ts
-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>;
-//#endregion
-export { ReadBufferResponse, readBuffer as default };

package/dist/aws/s3/readBuffer.mjs

@@ -1,29 +0,0 @@
-import { t as __require } from "../../chunk-y_GBKt04.mjs";
-import isResponse200 from "../isResponse200.mjs";
-import { readFileDefault } from "./readFile.mjs";
-//#region src/aws/s3/readBuffer.ts
-/**
-* Similar function to reading the S3 file, but instead of a text file return a buffer.
-*/
-const readBuffer = async ({ bucket, key }) => {
-	let response = {
-		...readFileDefault,
-		buffer: void 0
-	};
-	const { GetObjectCommand } = __require("@aws-sdk/client-s3");
-	const apiResponse = await global.awsS3Client.send(new GetObjectCommand({
-		Bucket: bucket,
-		Key: key
-	}));
-	if (isResponse200({ apiResponse })) {
-		const chunks = [];
-		response.buffer = await new Promise((resolve, reject) => {
-			apiResponse.Body.on("data", (chunk) => chunks.push(chunk));
-			apiResponse.Body.on("error", (err) => reject(err));
-			apiResponse.Body.on("end", () => resolve(Buffer.concat(chunks)));
-		});
-	} else throw new Error("Error reading file.");
-	return response;
-};
-//#endregion
-export { readBuffer as default };

package/dist/aws/s3/readFile.d.mts

@@ -1,38 +0,0 @@
-import { r as DurationComparison } from "../../index-CiGy7MyK.mjs";
-
-//#region src/aws/s3/readFile.d.ts
-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;
-    };
-  };
-};
-type ReadFileResponse = Modified & {
-  body: any;
-};
-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>;
-//#endregion
-export { Modified, ReadFileResponse, readFile as default, readFileDefault };

package/dist/aws/s3/readFile.mjs

@@ -1,64 +0,0 @@
-import { t as __require } from "../../chunk-y_GBKt04.mjs";
-import isResponse200 from "../isResponse200.mjs";
-import getDate from "../../date/getDate.mjs";
-import getToday from "../../date/getToday.mjs";
-import { DurationComparison } from "../../date/index.mjs";
-import getStringFromStream from "../../string/getStringFromStream.mjs";
-import isFileExists from "./isFileExists.mjs";
-import { differenceInDays, differenceInHours, differenceInMinutes, differenceInMonths, getHours, getMinutes, getUnixTime } from "date-fns";
-import cloneDeep from "lodash/cloneDeep.js";
-//#region src/aws/s3/readFile.ts
-const readFileDefault = {
-	body: void 0,
-	now: void 0,
-	modified: {
-		unix: null,
-		[DurationComparison.VS_NOW]: {
-			months: 0,
-			days: 0,
-			hours: 0,
-			minutes: 0
-		},
-		[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 = cloneDeep(readFileDefault);
-	const today = getToday({ setMidnight: false });
-	response.now = getUnixTime(today);
-	if (await isFileExists({
-		bucket,
-		key
-	})) {
-		const { GetObjectCommand } = __require("@aws-sdk/client-s3");
-		const apiResponse = await global.awsS3Client.send(new GetObjectCommand({
-			Bucket: bucket,
-			Key: key
-		}));
-		if (isResponse200({ apiResponse })) {
-			let now = today;
-			let modified = getDate({
-				input: apiResponse.LastModified,
-				setMidnight: false
-			});
-			response.modified.unix = getUnixTime(modified);
-			response.modified[DurationComparison.VS_NOW].months = differenceInMonths(now, modified);
-			response.modified[DurationComparison.VS_NOW].days = differenceInDays(now, modified);
-			response.modified[DurationComparison.VS_NOW].hours = differenceInHours(now, modified);
-			response.modified[DurationComparison.VS_NOW].minutes = differenceInMinutes(now, modified);
-			response.modified[DurationComparison.VS_MIDNIGHT].hours = getHours(now);
-			response.modified[DurationComparison.VS_MIDNIGHT].minutes = getMinutes(now);
-			response.body = await getStringFromStream({ stream: apiResponse.Body });
-			if (false !== isJson) response.body = JSON.parse(response.body) || void 0;
-		}
-	}
-	return response;
-};
-//#endregion
-export { readFile as default, readFileDefault };

package/dist/aws/s3/readGzip.d.mts

@@ -1,18 +0,0 @@
-import { ReadFileResponse } from "./readFile.mjs";
-
-//#region src/aws/s3/readGzip.d.ts
-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>;
-//#endregion
-export { readGzip as default };

package/dist/aws/s3/readGzip.mjs

@@ -1,20 +0,0 @@
-import getGzipDecompressed from "../../util/getGzipDecompressed.mjs";
-import readFile from "./readFile.mjs";
-//#region src/aws/s3/readGzip.ts
-/**
-* Read a file from S3 and return either null, the content or JSON decoded.
-*/
-const readGzip = async ({ bucket, key, isJson }) => {
-	let response = await readFile({
-		bucket,
-		key,
-		isJson: false
-	});
-	if (void 0 !== response.body) {
-		response.body = await getGzipDecompressed({ input: response.body });
-		if (false !== isJson) response.body = JSON.parse(response.body);
-	}
-	return response;
-};
-//#endregion
-export { readGzip as default };

package/dist/aws/s3/writeBrotli.d.mts

@@ -1,20 +0,0 @@
-//#region src/aws/s3/writeBrotli.d.ts
-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>;
-//#endregion
-export { writeBrotli as default };

package/dist/aws/s3/writeBrotli.mjs

@@ -1,18 +0,0 @@
-import getBrotliCompressed from "../../util/getBrotliCompressed.mjs";
-import writeFile from "./writeFile.mjs";
-//#region src/aws/s3/writeBrotli.ts
-/**
-* Write a brotli file to S3.
-*/
-const writeBrotli = async ({ bucket, data, key, isJson, ...options }) => {
-	let finalData = data;
-	if (false !== isJson) finalData = JSON.stringify(data);
-	return await writeFile({
-		bucket,
-		data: await getBrotliCompressed({ input: finalData }),
-		key,
-		...options
-	});
-};
-//#endregion
-export { writeBrotli as default };

package/dist/aws/s3/writeFile.d.mts

@@ -1,18 +0,0 @@
-//#region src/aws/s3/writeFile.d.ts
-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>;
-//#endregion
-export { writeFile as default };

package/dist/aws/s3/writeFile.mjs

@@ -1,16 +0,0 @@
-import { t as __require } from "../../chunk-y_GBKt04.mjs";
-//#region src/aws/s3/writeFile.ts
-/**
-* Write a file to S3.
-*/
-const writeFile = async ({ bucket, data, key, ...options }) => {
-	const { PutObjectCommand } = __require("@aws-sdk/client-s3");
-	return await global.awsS3Client.send(new PutObjectCommand({
-		Bucket: bucket,
-		Body: data,
-		Key: key,
-		...options
-	}));
-};
-//#endregion
-export { writeFile as default };

package/dist/aws/s3/writeGzip.d.mts

@@ -1,20 +0,0 @@
-//#region src/aws/s3/writeGzip.d.ts
-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>;
-//#endregion
-export { writeGzip as default };