@8ms/helpers 1.40.0 → 1.40.2

package/dist/url/url.d.mts

@@ -0,0 +1,9 @@
+//#region src/url/url.d.ts
+type Url = {
+  localhost: string;
+  development: string;
+  staging: string;
+  production: string;
+};
+//#endregion
+export { Url };

package/dist/url/url.mjs

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

package/dist/url/writeUrlContents.d.mts

@@ -0,0 +1,16 @@
+//#region src/url/writeUrlContents.d.ts
+type WriteUrlContents = {
+  filePath: string;
+  url: string;
+};
+/**
+ * Downloads a given URL's contents to a local file.
+ *
+ * Requires fs-extra
+ */
+declare const saveUrlContents: ({
+  filePath,
+  url
+}: WriteUrlContents) => Promise<void>;
+//#endregion
+export { saveUrlContents as default };

package/dist/url/writeUrlContents.mjs

@@ -0,0 +1,30 @@
+import createDirectory from "../file/createDirectory.mjs";
+import ky from "ky";
+import { Readable } from "stream";
+//#region src/url/writeUrlContents.ts
+/**
+* Downloads a given URL's contents to a local file.
+*
+* Requires fs-extra
+*/
+const saveUrlContents = async ({ filePath, url }) => {
+	const fs = await import("fs-extra");
+	await createDirectory({ filePath });
+	const writer = fs.createWriteStream(filePath);
+	const response = await ky.get(url);
+	const stream = Readable.fromWeb(response.body);
+	await new Promise((resolve, reject) => {
+		stream.pipe(writer);
+		let error = null;
+		writer.on("error", (err) => {
+			error = err;
+			writer.close();
+			reject(err);
+		});
+		writer.on("close", () => {
+			if (!error) resolve();
+		});
+	});
+};
+//#endregion
+export { saveUrlContents as default };

package/dist/util/defaultTo.d.mts

@@ -0,0 +1,12 @@
+//#region src/util/defaultTo.d.ts
+type DefaultTo = {
+  defaultValue: any;
+  instance: any;
+  keys: any | any[];
+};
+/**
+ * Function to default to a value, whilst filtering through an instance
+ */
+declare const defaultTo: (props: DefaultTo) => any;
+//#endregion
+export { defaultTo as default };

package/dist/util/defaultTo.mjs

@@ -0,0 +1,20 @@
+import getArray from "../array/getArray.mjs";
+import isObject from "lodash/isObject.js";
+//#region src/util/defaultTo.ts
+/**
+* Function to default to a value, whilst filtering through an instance
+*/
+const defaultTo = (props) => {
+	const keysArray = getArray({ input: props.keys });
+	let found = true;
+	let pointer = props.instance;
+	if (void 0 === props.instance || null === pointer) found = false;
+	else keysArray.forEach((key) => {
+		if (found) if (isObject(pointer)) if (void 0 === pointer[key] || null === pointer[key]) found = false;
+		else pointer = pointer[key];
+		else found = false;
+	});
+	return found ? pointer : props.defaultValue;
+};
+//#endregion
+export { defaultTo as default };

package/dist/util/getBrotliCompressed.d.mts

@@ -0,0 +1,14 @@
+//#region src/util/getBrotliCompressed.d.ts
+type GetBrotliCompressed = {
+  input?: any;
+  options?: object;
+};
+/**
+ * Compress a given input using Brotli.
+ */
+declare const getBrotliCompressed: ({
+  input,
+  options
+}?: GetBrotliCompressed) => Promise<unknown>;
+//#endregion
+export { getBrotliCompressed as default };

package/dist/util/getBrotliCompressed.mjs

@@ -0,0 +1,15 @@
+import { t as __require } from "../chunk-y_GBKt04.mjs";
+//#region src/util/getBrotliCompressed.ts
+/**
+* Compress a given input using Brotli.
+*/
+const getBrotliCompressed = async ({ input, options } = {}) => {
+	return new Promise(async (resolve, reject) => {
+		__require("zlib").brotliCompress(input || "", options || {}, (err, data) => {
+			if (err) reject(`Error compressing - ${err.code}`);
+			else resolve(data.toString("base64"));
+		});
+	});
+};
+//#endregion
+export { getBrotliCompressed as default };

package/dist/util/getBrotliDecompressed.d.mts

@@ -0,0 +1,14 @@
+//#region src/util/getBrotliDecompressed.d.ts
+type GetBrotliDecompressed = {
+  input?: any;
+  options?: object;
+};
+/**
+ * Decompress a given Brotli input into a string.
+ */
+declare const getBrotliDecompressed: ({
+  input,
+  options
+}?: GetBrotliDecompressed) => Promise<unknown>;
+//#endregion
+export { getBrotliDecompressed as default };

package/dist/util/getBrotliDecompressed.mjs

@@ -0,0 +1,17 @@
+import { t as __require } from "../chunk-y_GBKt04.mjs";
+//#region src/util/getBrotliDecompressed.ts
+/**
+* Decompress a given Brotli input into a string.
+*/
+const getBrotliDecompressed = async ({ input, options } = {}) => {
+	return new Promise(async (resolve, reject) => {
+		const zlib = __require("zlib");
+		const compressedData = Buffer.from(input || "", "base64");
+		zlib.brotliDecompress(compressedData, options || {}, (err, data) => {
+			if (err) reject(`Error decompressing - ${err.code}`);
+			else resolve(data.toString("utf8"));
+		});
+	});
+};
+//#endregion
+export { getBrotliDecompressed as default };

package/dist/util/getClean.d.mts

@@ -0,0 +1,18 @@
+//#region src/util/getClean.d.ts
+type GetClean = {
+  hash?: boolean;
+  input: string;
+  lowercase?: boolean;
+  parameter?: boolean;
+};
+/**
+ * Return a clean URL with a few options.
+ */
+declare const getClean: ({
+  hash,
+  input,
+  lowercase,
+  parameter
+}: GetClean) => string;
+//#endregion
+export { getClean as default };

package/dist/util/getClean.mjs

@@ -0,0 +1,15 @@
+import getWithoutParameter from "./getWithoutParameter.mjs";
+import getWithoutHash from "./getWithoutHash.mjs";
+//#region src/util/getClean.ts
+/**
+* Return a clean URL with a few options.
+*/
+const getClean = ({ hash, input, lowercase, parameter }) => {
+	let response = input.trim();
+	if (parameter) response = getWithoutParameter({ input: response });
+	if (hash) response = getWithoutHash({ input: response });
+	if (lowercase) response = response.toLowerCase();
+	return response;
+};
+//#endregion
+export { getClean as default };

package/dist/util/getGzipCompressed.d.mts

@@ -0,0 +1,14 @@
+//#region src/util/getGzipCompressed.d.ts
+type GetGzipCompressed = {
+  input?: any;
+  options?: object;
+};
+/**
+ * Compress a given input using Gzip.
+ */
+declare const getGzipCompressed: ({
+  input,
+  options
+}?: GetGzipCompressed) => Promise<unknown>;
+//#endregion
+export { getGzipCompressed as default };

package/dist/util/getGzipCompressed.mjs

@@ -0,0 +1,15 @@
+import { t as __require } from "../chunk-y_GBKt04.mjs";
+//#region src/util/getGzipCompressed.ts
+/**
+* Compress a given input using Gzip.
+*/
+const getGzipCompressed = async ({ input, options } = {}) => {
+	return new Promise(async (resolve, reject) => {
+		__require("zlib").gzip(input || "", options || {}, (err, data) => {
+			if (err) reject(`Error compressing - ${err.code}`);
+			else resolve(data.toString("base64"));
+		});
+	});
+};
+//#endregion
+export { getGzipCompressed as default };

package/dist/util/getGzipDecompressed.d.mts

@@ -0,0 +1,14 @@
+//#region src/util/getGzipDecompressed.d.ts
+type GetBrotliDecompressed = {
+  input?: any;
+  options?: object;
+};
+/**
+ * Decompress a given Gzip input into a string.
+ */
+declare const getGzipDecompressed: ({
+  input,
+  options
+}?: GetBrotliDecompressed) => Promise<unknown>;
+//#endregion
+export { getGzipDecompressed as default };

package/dist/util/getGzipDecompressed.mjs

@@ -0,0 +1,17 @@
+import { t as __require } from "../chunk-y_GBKt04.mjs";
+//#region src/util/getGzipDecompressed.ts
+/**
+* Decompress a given Gzip input into a string.
+*/
+const getGzipDecompressed = async ({ input, options } = {}) => {
+	return new Promise(async (resolve, reject) => {
+		const zlib = __require("zlib");
+		const compressedData = Buffer.from(input || "", "base64");
+		zlib.gunzip(compressedData, options || {}, (err, data) => {
+			if (err) reject(`Error decompressing - ${err.code}`);
+			else resolve(data.toString("utf8"));
+		});
+	});
+};
+//#endregion
+export { getGzipDecompressed as default };

package/dist/util/getWithoutHash.d.mts

@@ -0,0 +1,12 @@
+//#region src/util/getWithoutHash.d.ts
+type GetWithoutHash = {
+  input: string;
+};
+/**
+ * Get a URL without the parameter query.
+ */
+declare const getWithoutHash: ({
+  input
+}: GetWithoutHash) => string;
+//#endregion
+export { getWithoutHash as default };

package/dist/util/getWithoutHash.mjs

@@ -0,0 +1,14 @@
+//#region src/util/getWithoutHash.ts
+/**
+* Get a URL without the parameter query.
+*/
+const getWithoutHash = ({ input }) => {
+	let response = input;
+	if (-1 !== response.indexOf("#")) {
+		const split = response.split("#");
+		if (split.length > 1) response = split[0];
+	}
+	return response;
+};
+//#endregion
+export { getWithoutHash as default };

package/dist/util/getWithoutParameter.d.mts

@@ -0,0 +1,12 @@
+//#region src/util/getWithoutParameter.d.ts
+type GetWithoutParameter = {
+  input: string;
+};
+/**
+ * Get a URL without the parameter query.
+ */
+declare const getWithoutParameter: ({
+  input
+}: GetWithoutParameter) => string;
+//#endregion
+export { getWithoutParameter as default };

package/dist/util/getWithoutParameter.mjs

@@ -0,0 +1,14 @@
+//#region src/util/getWithoutParameter.ts
+/**
+* Get a URL without the parameter query.
+*/
+const getWithoutParameter = ({ input }) => {
+	let response = input;
+	if (-1 !== response.indexOf("?")) {
+		const split = response.split("?");
+		if (split.length > 1) response = split[0];
+	}
+	return response;
+};
+//#endregion
+export { getWithoutParameter as default };

package/dist/util/isUndefined.d.mts

@@ -0,0 +1,14 @@
+//#region src/util/isUndefined.d.ts
+type IsUndefined = {
+  instance: any;
+  keys: any | any[];
+};
+/**
+ * Check to see if a value is undefined.
+ */
+declare const isUndefined: ({
+  instance,
+  keys
+}: IsUndefined) => boolean;
+//#endregion
+export { isUndefined as default };

package/dist/util/isUndefined.mjs

@@ -0,0 +1,15 @@
+import defaultTo from "./defaultTo.mjs";
+//#region src/util/isUndefined.ts
+/**
+* Check to see if a value is undefined.
+*/
+const isUndefined = ({ instance, keys }) => {
+	const undefinedValue = "__!!UNDEFINED!!__";
+	return undefinedValue === defaultTo({
+		defaultValue: undefinedValue,
+		instance,
+		keys
+	});
+};
+//#endregion
+export { isUndefined as default };

package/dist/util/promiseChunks.d.mts

@@ -0,0 +1,12 @@
+//#region src/util/promiseChunks.d.ts
+type PromiseChunks = {
+  promises: Promise<any>[];
+  size: number;
+};
+/**
+ * Chunk a queue of promises into controlled chunks to prevent overloading.
+ * https://stackoverflow.com/a/53964407
+ */
+declare const promiseChunks: (props: PromiseChunks) => Promise<any[]>;
+//#endregion
+export { promiseChunks as default };

package/dist/util/promiseChunks.mjs

@@ -0,0 +1,18 @@
+import { chunk, flatten } from "lodash";
+//#region src/util/promiseChunks.ts
+/**
+* Chunk a queue of promises into controlled chunks to prevent overloading.
+* https://stackoverflow.com/a/53964407
+*/
+const promiseChunks = async (props) => {
+	const batches = chunk(props.promises, props.size);
+	let results = [];
+	while (batches.length) {
+		const batch = batches.shift();
+		const result = await Promise.all(batch);
+		results.push(result);
+	}
+	return flatten(results);
+};
+//#endregion
+export { promiseChunks as default };

package/dist/util/sleep.d.mts

@@ -0,0 +1,7 @@
+//#region src/util/sleep.d.ts
+type Sleep = {
+  seconds: number;
+};
+declare const sleep: (props: Sleep) => Promise<void>;
+//#endregion
+export { sleep as default };

package/dist/util/sleep.mjs

@@ -0,0 +1,6 @@
+//#region src/util/sleep.ts
+const sleep = (props) => {
+	return new Promise((resolve) => setTimeout(resolve, props.seconds * 1e3));
+};
+//#endregion
+export { sleep as default };

package/dist/xml/getXml.d.mts

@@ -0,0 +1,7 @@
+//#region src/xml/getXml.d.ts
+type GetXml = {
+  url: string;
+};
+declare const getXml: (props: GetXml) => Promise<string>;
+//#endregion
+export { getXml as default };

package/dist/xml/getXml.mjs

@@ -0,0 +1,14 @@
+import get from "../axios/get.mjs";
+//#region src/xml/getXml.ts
+const getXml = async (props) => {
+	let response = "";
+	const apiResponse = await get({ url: props.url });
+	if (apiResponse.isSuccess()) {
+		response = apiResponse.getBody().toString();
+		response = response.trim();
+		response = response.replace(/[ ]{2}|\r\n|\n|\r|\t/gm, "");
+	}
+	return response;
+};
+//#endregion
+export { getXml as default };