@8ms/helpers 1.40.0 → 1.40.1

package/dist/aws/s3cache/saveCache.mjs

@@ -0,0 +1,14 @@
+import writeGzip from "../s3/writeGzip.mjs";
+//#region src/aws/s3cache/saveCache.ts
+/**
+* Save the cache.
+*/
+const saveCache = async ({ bucket, data, key }) => {
+	return await writeGzip({
+		bucket,
+		data,
+		key
+	});
+};
+//#endregion
+export { saveCache as default };

package/dist/aws/s3cache/updateCache.d.mts

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

package/dist/aws/s3cache/updateCache.mjs

@@ -0,0 +1,26 @@
+import deleteFile from "../s3/deleteFile.mjs";
+import getKey from "./getKey.mjs";
+import saveCache from "./saveCache.mjs";
+//#region src/aws/s3cache/updateCache.ts
+/**
+* Delete other caches if present, then save the new file.
+*/
+const updateCache = async ({ bucket, data, fileName, folder }) => {
+	if (data && null !== data) {
+		const key = getKey({
+			fileName,
+			folder
+		});
+		await deleteFile({
+			bucket,
+			key
+		});
+		await saveCache({
+			bucket,
+			data,
+			key
+		});
+	}
+};
+//#endregion
+export { updateCache as default };

package/dist/aws/ses/SimpleEmail.d.mts

@@ -0,0 +1,79 @@
+import BaseClass from "../../class/BaseClass.mjs";
+
+//#region src/aws/ses/SimpleEmail.d.ts
+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;
+}
+//#endregion
+export { SimpleEmail as default };

package/dist/aws/ses/SimpleEmail.mjs

@@ -0,0 +1,122 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+import BaseClass from "../../class/BaseClass.mjs";
+import uniq from "lodash/uniq.js";
+//#region src/aws/ses/SimpleEmail.ts
+/**
+* Class to build and send an AWS SES email.
+*/
+var SimpleEmail = class extends BaseClass {
+	from;
+	to = [];
+	cc = [];
+	bcc = [];
+	html;
+	subject;
+	constructor({ bcc, cc, from, html, subject, to }) {
+		super();
+		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;
+		const command = new SendEmailCommand({
+			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
+		});
+		try {
+			response = await global.awsSesClient.send(command);
+		} catch (exception) {
+			response = exception;
+		}
+		return response;
+	}
+	_filterRecipients({ field }) {
+		let response = this[field].filter((recipient) => recipient && null !== recipient);
+		response = response.map((recipient) => recipient.toLowerCase().trim());
+		response = response.filter((recipient) => "" !== recipient);
+		response = uniq(response);
+		return response;
+	}
+};
+//#endregion
+export { SimpleEmail as default };

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

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

package/dist/aws/ses/initClient.mjs

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

package/dist/aws/sqs/addToQueue.d.mts

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

package/dist/aws/sqs/addToQueue.mjs

@@ -0,0 +1,20 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+//#region src/aws/sqs/addToQueue.ts
+/**
+* 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
+	};
+	if (void 0 !== dedupeId) params["MessageDeduplicationId"] = dedupeId;
+	if (void 0 !== groupId) params["MessageGroupId"] = dedupeId;
+	return await global.awsSqsClient.send(new SendMessageCommand(params));
+};
+//#endregion
+export { addToQueue as default };

package/dist/aws/sqs/deleteFromQueue.d.mts

@@ -0,0 +1,16 @@
+import { AddedResponse } from "./addToQueue.mjs";
+
+//#region src/aws/sqs/deleteFromQueue.d.ts
+type DeleteFromQueue = {
+  queueUrl: string;
+  recipientHandle: string;
+};
+/**
+ * Delete a message from a queue.
+ */
+declare const deleteFromQueue: ({
+  queueUrl,
+  recipientHandle
+}: DeleteFromQueue) => Promise<AddedResponse>;
+//#endregion
+export { deleteFromQueue as default };

package/dist/aws/sqs/deleteFromQueue.mjs

@@ -0,0 +1,15 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+//#region src/aws/sqs/deleteFromQueue.ts
+/**
+* Delete a message from a queue.
+*/
+const deleteFromQueue = async ({ queueUrl, recipientHandle }) => {
+	const { DeleteMessageCommand } = __require("@aws-sdk/client-sqs");
+	const params = {
+		QueueUrl: queueUrl,
+		ReceiptHandle: recipientHandle
+	};
+	return await global.awsSqsClient.send(new DeleteMessageCommand(params));
+};
+//#endregion
+export { deleteFromQueue as default };

package/dist/aws/sqs/index.d.mts

@@ -0,0 +1,18 @@
+//#region src/aws/sqs/index.d.ts
+type SqsEventRecord = {
+  messageId: string;
+  receiptHandle: string;
+  body: any;
+  attributes: object;
+  messageAttributes: object;
+  md5OfMessageAttributes: string;
+  md5OfBody: string;
+  eventSource: string;
+  eventSourceARN: string;
+  awsRegion: string;
+};
+type SqsEvent = {
+  Records: SqsEventRecord[];
+};
+//#endregion
+export { SqsEvent };

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

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

package/dist/aws/sqs/initClient.mjs

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

package/dist/aws/sqs/isEventSqs.d.mts

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

package/dist/aws/sqs/isEventSqs.mjs

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

package/dist/aws/ssm/getParameter.d.mts

@@ -0,0 +1,16 @@
+//#region src/aws/ssm/getParameter.d.ts
+type GetParameter = {
+  name: string;
+  withDecryption?: boolean;
+  isJson?: boolean;
+};
+/**
+ * Get a parameter and decryption if necessary (secure string)
+ */
+declare const getParameter: ({
+  name,
+  withDecryption,
+  isJson
+}: GetParameter) => Promise<any>;
+//#endregion
+export { getParameter as default };

package/dist/aws/ssm/getParameter.mjs

@@ -0,0 +1,22 @@
+import { t as __require } from "../../chunk-y_GBKt04.mjs";
+//#region src/aws/ssm/getParameter.ts
+global["awsSsmParameters"] = {};
+/**
+* Get a parameter and decryption if necessary (secure string)
+*/
+const getParameter = async ({ name, withDecryption, isJson }) => {
+	if (void 0 === global["awsSsmParameters"][name]) {
+		const { GetParameterCommand } = __require("@aws-sdk/client-ssm");
+		const apiResponse = await global.awsSsmClient.send(new GetParameterCommand({
+			Name: name,
+			WithDecryption: void 0 === withDecryption ? true : withDecryption
+		}));
+		if (apiResponse.Parameter.Value) if (void 0 === apiResponse.Parameter.Value) global["awsSsmParameters"][name] = null;
+		else if (void 0 === isJson || true === isJson) global["awsSsmParameters"][name] = JSON.parse(apiResponse.Parameter.Value) || null;
+		else global["awsSsmParameters"][name] = apiResponse.Parameter.Value;
+		else global["awsSsmParameters"][name] = null;
+	}
+	return global["awsSsmParameters"][name];
+};
+//#endregion
+export { getParameter as default };

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

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

package/dist/aws/ssm/initClient.mjs

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

package/dist/axios/delete.d.mts

@@ -0,0 +1,14 @@
+import ApiResponse from "../api/ApiResponse.mjs";
+
+//#region src/axios/delete.d.ts
+type Delete = {
+  config?: object;
+  url: string;
+};
+/**
+ * Make a DELETE request.
+ * Cant use the function name delete as its reserved
+ */
+declare const deleteRequest: (props: Delete) => Promise<ApiResponse>;
+//#endregion
+export { Delete, deleteRequest as default };

package/dist/axios/delete.mjs

@@ -0,0 +1,25 @@
+import ApiResponse from "../api/ApiResponse.mjs";
+import ky from "ky";
+//#region src/axios/delete.ts
+/**
+* Make a DELETE request.
+* Cant use the function name delete as its reserved
+*/
+const deleteRequest = async (props) => {
+	return await ky.delete(props.url, {
+		throwHttpErrors: false,
+		...props.config
+	}).then(async (response) => {
+		const data = await response.json();
+		if (void 0 !== data.body && void 0 !== data.error && void 0 !== data.state) return new ApiResponse(data);
+		else if (response.status >= 200 && response.status <= 299) return new ApiResponse().setToSuccess({ body: data });
+		return new ApiResponse().setToError({
+			body: data,
+			error: response.statusText
+		});
+	}).catch((error) => {
+		return new ApiResponse().setToError({ error: error.message });
+	});
+};
+//#endregion
+export { deleteRequest as default };

package/dist/axios/get.d.mts

@@ -0,0 +1,16 @@
+import ApiResponse from "../api/ApiResponse.mjs";
+
+//#region src/axios/get.d.ts
+type Get = {
+  config?: object;
+  url: string;
+};
+/**
+ * Make a GET request.
+ */
+declare const get: ({
+  config,
+  url
+}: Get) => Promise<ApiResponse>;
+//#endregion
+export { Get, get as default };

package/dist/axios/get.mjs

@@ -0,0 +1,24 @@
+import ApiResponse from "../api/ApiResponse.mjs";
+import ky from "ky";
+//#region src/axios/get.ts
+/**
+* Make a GET request.
+*/
+const get = async ({ config = {}, url }) => {
+	return await ky.get(url, {
+		throwHttpErrors: false,
+		...config
+	}).then(async (response) => {
+		const data = await response.json();
+		if (void 0 !== data.body && void 0 !== data.error && void 0 !== data.state) return new ApiResponse(data);
+		else if (response.status >= 200 && response.status <= 299) return new ApiResponse().setToSuccess({ body: data });
+		return new ApiResponse().setToError({
+			body: data,
+			error: response.statusText
+		});
+	}).catch((error) => {
+		return new ApiResponse().setToError({ error: error.message });
+	});
+};
+//#endregion
+export { get as default };

package/dist/axios/post.d.mts

@@ -0,0 +1,18 @@
+import ApiResponse from "../api/ApiResponse.mjs";
+
+//#region src/axios/post.d.ts
+type Post = {
+  config?: object;
+  data?: object;
+  url: string;
+};
+/**
+ * Make a POST request.
+ */
+declare const post: ({
+  config,
+  data,
+  url
+}: Post) => Promise<ApiResponse>;
+//#endregion
+export { Post, post as default };

package/dist/axios/post.mjs

@@ -0,0 +1,25 @@
+import ApiResponse from "../api/ApiResponse.mjs";
+import ky from "ky";
+//#region src/axios/post.ts
+/**
+* Make a POST request.
+*/
+const post = async ({ config = {}, data = {}, url }) => {
+	return await ky.post(url, {
+		throwHttpErrors: false,
+		json: data,
+		...config
+	}).then(async (response) => {
+		const data = await response.json();
+		if (void 0 !== data.body && void 0 !== data.error && void 0 !== data.state) return new ApiResponse(data);
+		else if (response.status >= 200 && response.status <= 299) return new ApiResponse().setToSuccess({ body: data });
+		return new ApiResponse().setToError({
+			body: data,
+			error: response.statusText
+		});
+	}).catch((error) => {
+		return new ApiResponse().setToError({ error: error.message });
+	});
+};
+//#endregion
+export { post as default };

package/dist/boolean/getBoolean.d.mts

@@ -0,0 +1,11 @@
+//#region src/boolean/getBoolean.d.ts
+/**
+ * Convert an input from a variety of forms into boolean.
+ */
+declare const getBoolean: ({
+  input
+}: {
+  input: any;
+}) => boolean;
+//#endregion
+export { getBoolean as default };

package/dist/boolean/getBoolean.mjs

@@ -0,0 +1,11 @@
+import isBoolean from "lodash/isBoolean.js";
+//#region src/boolean/getBoolean.ts
+/**
+* Convert an input from a variety of forms into boolean.
+*/
+const getBoolean = ({ input }) => {
+	if (isBoolean(input)) return input;
+	return "true" === input || 1 === input || "1" === input || "yes" === input || "y" === input;
+};
+//#endregion
+export { getBoolean as default };