@8ms/helpers 2.4.8 → 2.4.9

package/dist/url/server/writeUrlContents.d.mts

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

package/dist/url/server/writeUrlContents.mjs

@@ -0,0 +1,31 @@
+import { createDirectory } from "../../file/server/createDirectory.mjs";
+import "../../file/server/index.mjs";
+import { Readable } from "stream";
+//#region src/url/server/writeUrlContents.ts
+/**
+* Downloads a given URL's contents to a local file.
+*
+* Requires fs-extra
+*/
+const writeUrlContents = async (filePath, url) => {
+	const { default: ky } = await import("ky");
+	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 { writeUrlContents };

package/dist/url/url.cjs

@@ -0,0 +1,42 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_lodash_merge = require("../lodash/merge.cjs");
+//#region src/url/url.ts
+/**
+* Does the URL begin with HTTP or HTTPS?
+*/
+const isAbsolute = (input) => {
+	try {
+		new URL(input);
+	} catch (error) {
+		return false;
+	}
+	return true;
+};
+/**
+* Does the URL begin with a slash.
+*/
+const isRelative = (input) => "/" === input.trim().charAt(0);
+/**
+* Take an object and return the parameter for a given URL irrespective of path.
+*/
+const buildParameters = (existing = {}, updated = {}) => {
+	const merged = require_lodash_merge.merge(existing, updated);
+	let response = "";
+	if (Object.values(merged).length) for (const key in merged) {
+		const value = void 0 === updated[key] ? existing[key] : updated[key];
+		response += "" === response ? "?" : "&";
+		response += `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+	}
+	return response;
+};
+/**
+* Create a new relative URL based on the current path.
+*/
+const buildRelative = (router, updated = {}) => {
+	return `${router.pathname}${buildParameters(router.query, updated || {})}`;
+};
+//#endregion
+exports.buildParameters = buildParameters;
+exports.buildRelative = buildRelative;
+exports.isAbsolute = isAbsolute;
+exports.isRelative = isRelative;

package/dist/url/url.d.cts

@@ -0,0 +1,19 @@
+//#region src/url/url.d.ts
+/**
+ * Does the URL begin with HTTP or HTTPS?
+ */
+declare const isAbsolute: (input: string) => boolean;
+/**
+ * Does the URL begin with a slash.
+ */
+declare const isRelative: (input: string) => boolean;
+/**
+ * Take an object and return the parameter for a given URL irrespective of path.
+ */
+declare const buildParameters: (existing?: object, updated?: object) => string;
+/**
+ * Create a new relative URL based on the current path.
+ */
+declare const buildRelative: (router: any, updated?: object) => string;
+//#endregion
+export { buildParameters, buildRelative, isAbsolute, isRelative };

package/dist/url/url.d.mts

@@ -0,0 +1,19 @@
+//#region src/url/url.d.ts
+/**
+ * Does the URL begin with HTTP or HTTPS?
+ */
+declare const isAbsolute: (input: string) => boolean;
+/**
+ * Does the URL begin with a slash.
+ */
+declare const isRelative: (input: string) => boolean;
+/**
+ * Take an object and return the parameter for a given URL irrespective of path.
+ */
+declare const buildParameters: (existing?: object, updated?: object) => string;
+/**
+ * Create a new relative URL based on the current path.
+ */
+declare const buildRelative: (router: any, updated?: object) => string;
+//#endregion
+export { buildParameters, buildRelative, isAbsolute, isRelative };

package/dist/url/url.mjs

@@ -0,0 +1,38 @@
+import { merge } from "../lodash/merge.mjs";
+//#region src/url/url.ts
+/**
+* Does the URL begin with HTTP or HTTPS?
+*/
+const isAbsolute = (input) => {
+	try {
+		new URL(input);
+	} catch (error) {
+		return false;
+	}
+	return true;
+};
+/**
+* Does the URL begin with a slash.
+*/
+const isRelative = (input) => "/" === input.trim().charAt(0);
+/**
+* Take an object and return the parameter for a given URL irrespective of path.
+*/
+const buildParameters = (existing = {}, updated = {}) => {
+	const merged = merge(existing, updated);
+	let response = "";
+	if (Object.values(merged).length) for (const key in merged) {
+		const value = void 0 === updated[key] ? existing[key] : updated[key];
+		response += "" === response ? "?" : "&";
+		response += `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+	}
+	return response;
+};
+/**
+* Create a new relative URL based on the current path.
+*/
+const buildRelative = (router, updated = {}) => {
+	return `${router.pathname}${buildParameters(router.query, updated || {})}`;
+};
+//#endregion
+export { buildParameters, buildRelative, isAbsolute, isRelative };

package/dist/util/defaultTo.cjs

@@ -0,0 +1,21 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_lodash_isObject = require("../lodash/isObject.cjs");
+const require_array_array = require("../array/array.cjs");
+//#region src/util/defaultTo.ts
+/**
+* Function to default to a value, whilst filtering through an instance
+*/
+const defaultTo = (instance, keys, defaultValue = null) => {
+	const keysArray = require_array_array.getArray(keys);
+	let found = true;
+	let pointer = instance;
+	if ("undefined" === typeof instance || null === pointer) found = false;
+	else keysArray.forEach((key) => {
+		if (found) if (require_lodash_isObject.isObject(pointer)) if (void 0 === pointer[key] || null === pointer[key]) found = false;
+		else pointer = pointer[key];
+		else found = false;
+	});
+	return found ? pointer : defaultValue;
+};
+//#endregion
+exports.defaultTo = defaultTo;

package/dist/util/defaultTo.d.cts

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

package/dist/util/defaultTo.d.mts

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

package/dist/util/defaultTo.mjs

@@ -0,0 +1,20 @@
+import { isObject } from "../lodash/isObject.mjs";
+import { getArray } from "../array/array.mjs";
+//#region src/util/defaultTo.ts
+/**
+* Function to default to a value, whilst filtering through an instance
+*/
+const defaultTo = (instance, keys, defaultValue = null) => {
+	const keysArray = getArray(keys);
+	let found = true;
+	let pointer = instance;
+	if ("undefined" === typeof 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 : defaultValue;
+};
+//#endregion
+export { defaultTo };

package/dist/util/getClean.cjs

@@ -0,0 +1,16 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_util_getWithoutParameter = require("./getWithoutParameter.cjs");
+const require_util_getWithoutHash = require("./getWithoutHash.cjs");
+//#region src/util/getClean.ts
+/**
+* Return a clean URL with a few options.
+*/
+const getClean = (props) => {
+	let response = props.input.toString().trim();
+	if (props.parameter) response = require_util_getWithoutParameter.getWithoutParameter(response);
+	if (props.hash) response = require_util_getWithoutHash.getWithoutHash(response);
+	if (props.lowercase) response = response.toLowerCase();
+	return response;
+};
+//#endregion
+exports.getClean = getClean;

package/dist/util/getClean.d.cts

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

package/dist/util/getClean.d.mts

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

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 = (props) => {
+	let response = props.input.toString().trim();
+	if (props.parameter) response = getWithoutParameter(response);
+	if (props.hash) response = getWithoutHash(response);
+	if (props.lowercase) response = response.toLowerCase();
+	return response;
+};
+//#endregion
+export { getClean };

package/dist/util/getError.cjs

@@ -0,0 +1,10 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/util/getError.ts
+const getError = (error) => {
+	let response = "";
+	if (typeof error === "string") response = error.toUpperCase();
+	else if (error instanceof Error) response = error.message;
+	return response;
+};
+//#endregion
+exports.getError = getError;

package/dist/util/getError.d.cts

@@ -0,0 +1,4 @@
+//#region src/util/getError.d.ts
+declare const getError: (error: any) => string;
+//#endregion
+export { getError };

package/dist/util/getError.d.mts

@@ -0,0 +1,4 @@
+//#region src/util/getError.d.ts
+declare const getError: (error: any) => string;
+//#endregion
+export { getError };

package/dist/util/getError.mjs

@@ -0,0 +1,9 @@
+//#region src/util/getError.ts
+const getError = (error) => {
+	let response = "";
+	if (typeof error === "string") response = error.toUpperCase();
+	else if (error instanceof Error) response = error.message;
+	return response;
+};
+//#endregion
+export { getError };

package/dist/util/getWithoutHash.cjs

@@ -0,0 +1,15 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#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
+exports.getWithoutHash = getWithoutHash;

package/dist/util/getWithoutHash.d.cts

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

package/dist/util/getWithoutHash.d.mts

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

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 };

package/dist/util/getWithoutParameter.cjs

@@ -0,0 +1,15 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#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
+exports.getWithoutParameter = getWithoutParameter;

package/dist/util/getWithoutParameter.d.cts

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

package/dist/util/getWithoutParameter.d.mts

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

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 };

package/dist/util/index.cjs

@@ -0,0 +1,17 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_util_defaultTo = require("./defaultTo.cjs");
+const require_util_getWithoutParameter = require("./getWithoutParameter.cjs");
+const require_util_getWithoutHash = require("./getWithoutHash.cjs");
+const require_util_getClean = require("./getClean.cjs");
+const require_util_getError = require("./getError.cjs");
+const require_util_isUndefined = require("./isUndefined.cjs");
+const require_util_sleep = require("./sleep.cjs");
+const require_util_promiseChunks = require("./promiseChunks.cjs");
+exports.defaultTo = require_util_defaultTo.defaultTo;
+exports.getClean = require_util_getClean.getClean;
+exports.getError = require_util_getError.getError;
+exports.getWithoutHash = require_util_getWithoutHash.getWithoutHash;
+exports.getWithoutParameter = require_util_getWithoutParameter.getWithoutParameter;
+exports.isUndefined = require_util_isUndefined.isUndefined;
+exports.promiseChunks = require_util_promiseChunks.promiseChunks;
+exports.sleep = require_util_sleep.sleep;

package/dist/util/index.d.cts

@@ -0,0 +1,9 @@
+import { defaultTo } from "./defaultTo.cjs";
+import { getClean } from "./getClean.cjs";
+import { getError } from "./getError.cjs";
+import { getWithoutHash } from "./getWithoutHash.cjs";
+import { getWithoutParameter } from "./getWithoutParameter.cjs";
+import { isUndefined } from "./isUndefined.cjs";
+import { promiseChunks } from "./promiseChunks.cjs";
+import { sleep } from "./sleep.cjs";
+export { defaultTo, getClean, getError, getWithoutHash, getWithoutParameter, isUndefined, promiseChunks, sleep };

package/dist/util/index.d.mts

@@ -1,50 +1,9 @@
-//#region src/util/defaultTo.d.ts
-/**
- * Function to default to a value, whilst filtering through an instance
- */
-declare const defaultTo: (instance: any, keys: any | any[], defaultValue?: any) => any;
-//#endregion
-//#region src/util/getClean.d.ts
-type GetClean = {
-  hash?: boolean;
-  input: any;
-  lowercase?: boolean;
-  parameter?: boolean;
-};
-/**
- * Return a clean URL with a few options.
- */
-declare const getClean: (props: GetClean) => string;
-//#endregion
-//#region src/util/getError.d.ts
-declare const getError: (error: any) => string;
-//#endregion
-//#region src/util/getWithoutHash.d.ts
-/**
- * Get a URL without the parameter query.
- */
-declare const getWithoutHash: (input: string) => string;
-//#endregion
-//#region src/util/getWithoutParameter.d.ts
-/**
- * Get a URL without the parameter query.
- */
-declare const getWithoutParameter: (input: string) => string;
-//#endregion
-//#region src/util/isUndefined.d.ts
-/**
- * Check to see if a value is undefined.
- */
-declare const isUndefined: (instance: any, keys: any | any[]) => boolean;
-//#endregion
-//#region src/util/promiseChunks.d.ts
-/**
- * Chunk a queue of promises into controlled chunks to prevent overloading.
- * https://stackoverflow.com/a/53964407
- */
-declare const promiseChunks: (promises: Promise<any>[], size: number, sleepSeconds?: number, callbackFunction?: Function) => Promise<any[]>;
-//#endregion
-//#region src/util/sleep.d.ts
-declare const sleep: (seconds: number) => Promise<void>;
-//#endregion
+import { defaultTo } from "./defaultTo.mjs";
+import { getClean } from "./getClean.mjs";
+import { getError } from "./getError.mjs";
+import { getWithoutHash } from "./getWithoutHash.mjs";
+import { getWithoutParameter } from "./getWithoutParameter.mjs";
+import { isUndefined } from "./isUndefined.mjs";
+import { promiseChunks } from "./promiseChunks.mjs";
+import { sleep } from "./sleep.mjs";
 export { defaultTo, getClean, getError, getWithoutHash, getWithoutParameter, isUndefined, promiseChunks, sleep };

package/dist/util/index.mjs

@@ -1,98 +1,9 @@
-import { chunk, flatten, isObject } from "../lodash/index.mjs";
-import { getArray } from "../array/index.mjs";
-//#region src/util/defaultTo.ts
-/**
-* Function to default to a value, whilst filtering through an instance
-*/
-const defaultTo = (instance, keys, defaultValue = null) => {
-	const keysArray = getArray(keys);
-	let found = true;
-	let pointer = instance;
-	if ("undefined" === typeof 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 : defaultValue;
-};
-//#endregion
-//#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
-//#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
-//#region src/util/getClean.ts
-/**
-* Return a clean URL with a few options.
-*/
-const getClean = (props) => {
-	let response = props.input.toString().trim();
-	if (props.parameter) response = getWithoutParameter(response);
-	if (props.hash) response = getWithoutHash(response);
-	if (props.lowercase) response = response.toLowerCase();
-	return response;
-};
-//#endregion
-//#region src/util/getError.ts
-const getError = (error) => {
-	let response = "";
-	if (typeof error === "string") response = error.toUpperCase();
-	else if (error instanceof Error) response = error.message;
-	return response;
-};
-//#endregion
-//#region src/util/isUndefined.ts
-const undefinedValue = "__!!UNDEFINED!!__";
-/**
-* Check to see if a value is undefined.
-*/
-const isUndefined = (instance, keys) => {
-	return undefinedValue === defaultTo(instance, keys, undefinedValue);
-};
-//#endregion
-//#region src/util/sleep.ts
-const sleep = (seconds) => {
-	return new Promise((resolve) => setTimeout(resolve, seconds * 1e3));
-};
-//#endregion
-//#region src/util/promiseChunks.ts
-/**
-* Chunk a queue of promises into controlled chunks to prevent overloading.
-* https://stackoverflow.com/a/53964407
-*/
-const promiseChunks = async (promises, size, sleepSeconds = 0, callbackFunction) => {
-	const batches = chunk(promises, size);
-	let results = [];
-	while (batches.length) {
-		const batch = batches.shift();
-		const result = await Promise.all(batch);
-		results.push(result);
-		if (callbackFunction) await callbackFunction(result);
-		await sleep(sleepSeconds);
-	}
-	return flatten(results);
-};
-//#endregion
+import { defaultTo } from "./defaultTo.mjs";
+import { getWithoutParameter } from "./getWithoutParameter.mjs";
+import { getWithoutHash } from "./getWithoutHash.mjs";
+import { getClean } from "./getClean.mjs";
+import { getError } from "./getError.mjs";
+import { isUndefined } from "./isUndefined.mjs";
+import { sleep } from "./sleep.mjs";
+import { promiseChunks } from "./promiseChunks.mjs";
 export { defaultTo, getClean, getError, getWithoutHash, getWithoutParameter, isUndefined, promiseChunks, sleep };

package/dist/util/isUndefined.cjs

@@ -0,0 +1,12 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_util_defaultTo = require("./defaultTo.cjs");
+//#region src/util/isUndefined.ts
+const undefinedValue = "__!!UNDEFINED!!__";
+/**
+* Check to see if a value is undefined.
+*/
+const isUndefined = (instance, keys) => {
+	return undefinedValue === require_util_defaultTo.defaultTo(instance, keys, undefinedValue);
+};
+//#endregion
+exports.isUndefined = isUndefined;

package/dist/util/isUndefined.d.cts

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

package/dist/util/isUndefined.d.mts

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