@8ms/helpers 1.39.0 → 1.40.1

package/dist/aws/ecs/runTask.d.mts

@@ -0,0 +1,19 @@
+import { LaunchType, NetworkConfiguration, TaskOverride } from "@aws-sdk/client-ecs";
+
+//#region src/aws/ecs/runTask.d.ts
+type RunTask = {
+  cluster?: string;
+  count?: number;
+  launchType?: LaunchType;
+  networkConfiguration?: NetworkConfiguration;
+  overrides?: TaskOverride;
+  taskDefinition?: string;
+};
+/**
+ * Initialise and run a task
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/RunTaskCommand/
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/RunTaskCommandInput/
+ */
+declare const runTask: (props: RunTask) => Promise<boolean>;
+//#endregion
+export { runTask };

package/dist/aws/ecs/runTask.mjs

@@ -0,0 +1,24 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+import isResponse200 from "../isResponse200.mjs";
+//#region src/aws/ecs/runTask.ts
+/**
+* Initialise and run a task
+* https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/RunTaskCommand/
+* https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/RunTaskCommandInput/
+*/
+const runTask = async (props) => {
+	let response = false;
+	const { RunTaskCommand } = __require("@aws-sdk/client-ecs");
+	const runtTaskCommand = new RunTaskCommand({
+		cluster: props?.cluster,
+		launchType: props?.launchType,
+		networkConfiguration: props?.networkConfiguration,
+		overrides: props?.overrides,
+		taskDefinition: props?.taskDefinition
+	});
+	const apiResponse = await global.awsEcsClient.send(runtTaskCommand);
+	if (isResponse200({ apiResponse })) response = apiResponse;
+	return response;
+};
+//#endregion
+export { runTask };

package/dist/aws/getConfig.d.mts

@@ -0,0 +1,18 @@
+//#region src/aws/getConfig.d.ts
+type Config = {
+  accessKeyId: string;
+  region: string;
+  secretAccessKey: string;
+};
+/**
+ * The config must be in a specific structure, if the properties aren't defined don't specify them as they could be inferred (e.g. Lambda).
+ */
+declare const getConfig: ({
+  config,
+  isAthenaExpress
+}: {
+  config: Config;
+  isAthenaExpress?: boolean;
+}) => object;
+//#endregion
+export { Config, getConfig as default };

package/dist/aws/getConfig.mjs

@@ -0,0 +1,17 @@
+//#region src/aws/getConfig.ts
+/**
+* The config must be in a specific structure, if the properties aren't defined don't specify them as they could be inferred (e.g. Lambda).
+*/
+const getConfig = ({ config, isAthenaExpress }) => {
+	let response = { region: config.region };
+	if ("" !== config.accessKeyId && "" !== config.secretAccessKey) if (true === isAthenaExpress) {
+		response["accessKeyId"] = config.accessKeyId;
+		response["secretAccessKey"] = config.secretAccessKey;
+	} else response["credentials"] = {
+		accessKeyId: config.accessKeyId,
+		secretAccessKey: config.secretAccessKey
+	};
+	return response;
+};
+//#endregion
+export { getConfig as default };

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

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

package/dist/aws/glue/initClient.mjs

@@ -0,0 +1,17 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+import getConfig from "../getConfig.mjs";
+//#region src/aws/glue/initClient.ts
+global.awsGlueClient = null;
+/**
+* Shorthand function to get the Glue Client.
+* Library: @aws-sdk/client-glue
+*/
+const initClient = (props) => {
+	if (!global.awsGlueClient) {
+		const { GlueClient } = __require("@aws-sdk/client-glue");
+		const formattedConfig = getConfig({ config: props.config });
+		global.awsGlueClient = new GlueClient(formattedConfig);
+	}
+};
+//#endregion
+export { initClient as default };

package/dist/aws/glue/invoke.d.mts

@@ -0,0 +1,11 @@
+//#region src/aws/glue/invoke.d.ts
+type Invoke = {
+  crawler: string;
+};
+/**
+ * Invoke an AWS Glue Crawler by passing in the name of the Crawler.
+ * Library: @aws-sdk/client-glue
+ */
+declare const invoke: (props: Invoke) => Promise<boolean>;
+//#endregion
+export { invoke as default };

package/dist/aws/glue/invoke.mjs

@@ -0,0 +1,14 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+import isResponse200 from "../isResponse200.mjs";
+//#region src/aws/glue/invoke.ts
+/**
+* Invoke an AWS Glue Crawler by passing in the name of the Crawler.
+* Library: @aws-sdk/client-glue
+*/
+const invoke = async (props) => {
+	const { StartCrawlerCommand } = __require("@aws-sdk/client-glue");
+	const command = new StartCrawlerCommand({ Name: props.crawler });
+	return isResponse200({ apiResponse: await global.awsGlueClient.send(command) });
+};
+//#endregion
+export { invoke as default };

package/dist/aws/isResponse200.d.mts

@@ -0,0 +1,11 @@
+//#region src/aws/isResponse200.d.ts
+/**
+ * Was the API response a 200?
+ */
+declare const isResponse200: ({
+  apiResponse
+}: {
+  apiResponse: any;
+}) => boolean;
+//#endregion
+export { isResponse200 as default };

package/dist/aws/isResponse200.mjs

@@ -0,0 +1,16 @@
+import defaultTo from "../util/defaultTo.mjs";
+//#region src/aws/isResponse200.ts
+/**
+* Was the API response a 200?
+*/
+const isResponse200 = ({ apiResponse }) => {
+	let response = false;
+	if (200 === defaultTo({
+		defaultValue: 0,
+		instance: apiResponse,
+		keys: ["$metadata", "httpStatusCode"]
+	})) response = true;
+	return response;
+};
+//#endregion
+export { isResponse200 as default };

package/dist/aws/lambda/getHandlerPath.d.mts

@@ -0,0 +1,7 @@
+//#region src/aws/lambda/getHandlerPath.d.ts
+type GetHandlerPath = {
+  input: string;
+};
+declare const getHandlerPath: (props: GetHandlerPath) => string;
+//#endregion
+export { getHandlerPath as default };

package/dist/aws/lambda/getHandlerPath.mjs

@@ -0,0 +1,6 @@
+//#region src/aws/lambda/getHandlerPath.ts
+const getHandlerPath = (props) => {
+	return `${props.input.split(process.cwd())[1].substring(1).replace(/\\/g, "/")}`;
+};
+//#endregion
+export { getHandlerPath as default };

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

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

package/dist/aws/lambda/initClient.mjs

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

package/dist/aws/lambda/invoke.d.mts

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

package/dist/aws/lambda/invoke.mjs

@@ -0,0 +1,31 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+import ApiResponse from "../../api/ApiResponse.mjs";
+import isResponse200 from "../isResponse200.mjs";
+//#region src/aws/lambda/invoke.ts
+/**
+* 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"
+	};
+	if (void 0 !== props.payload) params["Payload"] = new Uint8Array(Buffer.from(JSON.stringify(props.payload)));
+	const { InvokeCommand } = __require("@aws-sdk/client-lambda");
+	const command = new InvokeCommand(params);
+	const apiResponse = await global.awsLambdaClient.send(command);
+	if (isResponse200({ apiResponse })) if (props.awaitResponse && void 0 !== apiResponse.Payload) {
+		response = new TextDecoder("ascii").decode(apiResponse.Payload);
+		if (true === props.isJson) {
+			response = JSON.parse(response);
+			if ("string" === typeof response) response = JSON.parse(response);
+			if (void 0 !== response && void 0 !== response?.error && void 0 !== response?.state) response = new ApiResponse().fromJson({ input: response });
+		}
+	} else response = true;
+	return response;
+};
+//#endregion
+export { invoke as default };

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

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

package/dist/aws/s3/copyFile.mjs

@@ -0,0 +1,15 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+//#region src/aws/s3/copyFile.ts
+/**
+* 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
+	}));
+};
+//#endregion
+export { copyFile as default };

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

@@ -0,0 +1,14 @@
+//#region src/aws/s3/deleteFile.d.ts
+type DeleteFile = {
+  bucket: string;
+  key: string;
+};
+/**
+ * Delete a single file.
+ */
+declare const deleteFile: ({
+  bucket,
+  key
+}: DeleteFile) => Promise<void>;
+//#endregion
+export { deleteFile as default };

package/dist/aws/s3/deleteFile.mjs

@@ -0,0 +1,14 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+//#region src/aws/s3/deleteFile.ts
+/**
+* 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
+	}));
+};
+//#endregion
+export { deleteFile as default };

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

@@ -0,0 +1,14 @@
+//#region src/aws/s3/deleteFiles.d.ts
+type DeleteFiles = {
+  bucket: string;
+  keys: string[];
+};
+/**
+ * Delete multiple files.
+ */
+declare const deleteFiles: ({
+  bucket,
+  keys
+}: DeleteFiles) => Promise<void>;
+//#endregion
+export { deleteFiles as default };

package/dist/aws/s3/deleteFiles.mjs

@@ -0,0 +1,14 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+//#region src/aws/s3/deleteFiles.ts
+/**
+* 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 })) }
+	}));
+};
+//#endregion
+export { deleteFiles as default };

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

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

package/dist/aws/s3/deleteFolder.mjs

@@ -0,0 +1,26 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+import getFolder from "../../string/getFolder.mjs";
+//#region src/aws/s3/deleteFolder.ts
+/**
+* Iteratively delete all the files within a directory and delete the directory.
+*/
+const deleteFolder = async ({ bucket, folder }) => {
+	const cleanFolder = getFolder({ input: folder });
+	const { ListObjectsV2Command, DeleteObjectsCommand } = __require("@aws-sdk/client-s3");
+	const apiResponse = await global.awsS3Client.send(new ListObjectsV2Command({
+		Bucket: bucket,
+		Prefix: "" === cleanFolder ? "" : cleanFolder + "/"
+	}));
+	if (apiResponse.Contents.length === 0) return;
+	const keys = apiResponse.Contents.map((file) => ({ Key: file.Key }));
+	await global.awsS3Client.send(new DeleteObjectsCommand({
+		Bucket: bucket,
+		Delete: { Objects: keys }
+	}));
+	if (apiResponse.IsTruncated) await deleteFolder({
+		bucket,
+		folder
+	});
+};
+//#endregion
+export { deleteFolder as default };

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

@@ -0,0 +1,12 @@
+//#region src/aws/s3/getGlueJson.d.ts
+type GetGlueJson = {
+  data: any;
+};
+/**
+ * @deprecated in favour of getJsonNewline
+ */
+declare const getGlueJson: ({
+  data
+}: GetGlueJson) => string;
+//#endregion
+export { getGlueJson as default };

package/dist/aws/s3/getGlueJson.mjs

@@ -0,0 +1,8 @@
+import GetJsonNewline from "../../json/getJsonNewline.mjs";
+//#region src/aws/s3/getGlueJson.ts
+/**
+* @deprecated in favour of getJsonNewline
+*/
+const getGlueJson = ({ data }) => GetJsonNewline({ data });
+//#endregion
+export { getGlueJson as default };

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

@@ -0,0 +1,28 @@
+//#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

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

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

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

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

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

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

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

@@ -0,0 +1,14 @@
+//#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

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

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