@8ms/helpers 2.3.4 → 2.3.6

package/dist/stream/server/index.d.mts

@@ -0,0 +1,15 @@
+//#region src/stream/server/sort.d.ts
+declare const Transform: any;
+/**
+ * Batch sort stream without overloading the memory limit.
+ * https://www.npmjs.com/package/fast-stream-sort
+ */
+declare class SortStreamer extends Transform {
+  constructor(options: any, comp: any);
+  _transform(data: any, _: any, callback: any): void;
+  _flush(): void;
+  fullflush(): void;
+}
+declare const sort: (comp: any, options: any) => SortStreamer;
+//#endregion
+export { sort };

package/dist/stream/server/index.mjs

@@ -0,0 +1,48 @@
+import { n as __require } from "../../chunk-CgI6uo-e.mjs";
+
+//#region src/stream/server/sort.ts
+const Transform = __require("stream").Transform;
+const batch = 15e3;
+/**
+* Batch sort stream without overloading the memory limit.
+* https://www.npmjs.com/package/fast-stream-sort
+*/
+var SortStreamer = class extends Transform {
+	constructor(options, comp) {
+		super(options);
+		this.a = new Array(batch);
+		this.i = 0;
+		this.k = 0;
+		this.currentSize = batch;
+		this.isDone = false;
+		this.sortedArray = void 0;
+		this.comp = comp;
+	}
+	_transform(data, _, callback) {
+		if (data) {
+			this.a[this.i++] = data;
+			if (this.i == this.currentSize) {
+				this.currentSize = this.currentSize * 2;
+				var tmp = new Array(this.currentSize);
+				for (var j = 0; j < this.i; j++) tmp[j] = this.a[j];
+				this.a = tmp;
+			}
+		}
+		callback();
+	}
+	_flush() {
+		this.sortedArray = this.a.slice(0, this.i).sort(this.comp);
+		this.fullflush();
+	}
+	fullflush() {
+		while (this.k < this.i) this.push(this.sortedArray[this.k++]);
+		this.push(null);
+	}
+};
+const sort = (comp, options) => {
+	options = options || { objectMode: true };
+	return new SortStreamer(options, comp);
+};
+
+//#endregion
+export { sort };

package/dist/string/index.d.mts

@@ -0,0 +1,107 @@
+//#region src/string/getCapitalised.d.ts
+/**
+ * Convert a string into Capitalised Text.
+ * https://stackoverflow.com/a/196991/2664955
+ */
+declare const getCapitalised: (input: string, split?: string) => string;
+//#endregion
+//#region src/string/getClean.d.ts
+type GetCleanProps = {
+  accents?: boolean;
+  decoded?: boolean;
+  htmlTags?: boolean;
+  input: any;
+  lowercase?: boolean;
+  propercase?: boolean;
+  punctuation?: boolean;
+  trim?: boolean;
+  underscores?: boolean;
+  uppercase?: boolean;
+  whitespace?: boolean;
+};
+/**
+ * Shorthand function to get a clean version of a string.
+ */
+declare const getClean: (props: GetCleanProps) => string;
+//#endregion
+//#region src/string/getFolder.d.ts
+/**
+ * Take an input that may have a / before or after the input and return just the folder.
+ */
+declare const getFolder: (input: string) => string;
+//#endregion
+//#region src/string/getProperCase.d.ts
+type GetProperCaseProps = {
+  input: any;
+  hyphen?: boolean;
+  pipe?: boolean;
+  underscore?: boolean;
+};
+/**
+ * Return a string "With Proper Casing".
+ */
+declare const getProperCase: (props: GetProperCaseProps) => string;
+//#endregion
+//#region src/string/getString.d.ts
+/**
+ * Convert into string.
+ */
+declare const getString: (input: any) => string;
+//#endregion
+//#region src/string/getStringFromStream.d.ts
+/**
+ * Converts a stream into a string.
+ * https://stackoverflow.com/a/49428486
+ */
+declare const getStringFromStream: (stream: any) => Promise<string>;
+//#endregion
+//#region src/string/getUnescaped.d.ts
+/**
+ * Convert escaped copy into unescaped.
+ * E.g. there&#39;s => there's
+ * https://stackoverflow.com/a/42182294/2664955
+ */
+declare const getUnescaped: (input: string) => string;
+//#endregion
+//#region src/string/getWithoutAccents.d.ts
+/**
+ * Remove the accents from a string.
+ * https://stackoverflow.com/a/37511463
+ */
+declare const getWithoutAccents: (input: string) => string;
+//#endregion
+//#region src/string/getWithoutHtmlTags.d.ts
+/**
+ * Removes all HTML tags from an input.
+ * https://css-tricks.com/snippets/javascript/strip-html-tags-in-javascript/
+ */
+declare const getWithoutHtmlTags: (input: string) => string;
+//#endregion
+//#region src/string/getWithoutPunctuation.d.ts
+/**
+ * Remove all punctuation from a string and replace with a space.
+ * https://stackoverflow.com/a/25575009
+ */
+declare const getWithoutPunctuation: (input: string) => string;
+//#endregion
+//#region src/string/getWithoutUnderscores.d.ts
+/**
+ * Replace all underscores with a space.
+ */
+declare const getWithoutUnderscores: (input: string) => string;
+//#endregion
+//#region src/string/getWithoutWhitespaces.d.ts
+/**
+ * Remove all new lines, tabs multiple spaces, with a single space.
+ * https://stackoverflow.com/a/45029224
+ */
+declare const getWithoutWhitespaces: (input: string) => string;
+//#endregion
+//#region src/string/reservedWords.d.ts
+declare const reservedWords: string[];
+/**
+ * Check if its a reserved word, the casing may be specific eg, OpenAI.
+ */
+declare const isReservedWord: (word: string) => any;
+//#endregion
+export { getCapitalised, getClean, getFolder, getProperCase, getString, getStringFromStream, getUnescaped, getWithoutAccents, getWithoutHtmlTags, getWithoutPunctuation, getWithoutUnderscores, getWithoutWhitespaces, isReservedWord, reservedWords };

package/dist/string/index.mjs

@@ -0,0 +1,191 @@
+import { getYmdString } from "../date/index.mjs";
+import isArray from "lodash/isArray";
+import isObject from "lodash/isObject";
+import isDate from "lodash/isDate";
+import _unescape from "lodash/unescape";
+import trim from "lodash/trim";
+
+//#region src/string/reservedWords.ts
+const reservedWords = [
+	"AI",
+	"GA4",
+	"GSC",
+	"OpenAI",
+	"PPC",
+	"SEO",
+	"UpTimeRobot"
+];
+/**
+* Check if its a reserved word, the casing may be specific eg, OpenAI.
+*/
+const isReservedWord = (word) => {
+	let response = null;
+	for (let i = 0; i < reservedWords.length; i++) if (reservedWords[i].toLowerCase() === word.toLowerCase()) {
+		response = reservedWords[i];
+		break;
+	}
+	return response;
+};
+
+//#endregion
+//#region src/string/getCapitalised.ts
+/**
+* Convert a string into Capitalised Text.
+* https://stackoverflow.com/a/196991/2664955
+*/
+const getCapitalised = (input, split = "_") => {
+	const regex = new RegExp(split || "_", "g");
+	return input.replace(regex, " ").replace(/\w\S*/g, function(txt) {
+		const reservedWord = isReservedWord(txt);
+		if (reservedWord) return reservedWord;
+		return txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase();
+	});
+};
+
+//#endregion
+//#region src/string/getString.ts
+/**
+* Convert into string.
+*/
+const getString = (input) => {
+	let string = "";
+	if ("string" === typeof input) string = input;
+	else if ("number" === typeof input) string = input.toString();
+	else if (isObject(input) || isArray(input)) string = JSON.stringify(input);
+	else if (isDate(input)) string = getYmdString(input);
+	return string;
+};
+
+//#endregion
+//#region src/string/getWithoutHtmlTags.ts
+/**
+* Removes all HTML tags from an input.
+* https://css-tricks.com/snippets/javascript/strip-html-tags-in-javascript/
+*/
+const getWithoutHtmlTags = (input) => {
+	return input.replace(/(<([^>]+)>)/gi, "");
+};
+
+//#endregion
+//#region src/string/getWithoutAccents.ts
+/**
+* Remove the accents from a string.
+* https://stackoverflow.com/a/37511463
+*/
+const getWithoutAccents = (input) => {
+	return input.normalize("NFD").replace(/[\u0300-\u036f]/g, "");
+};
+
+//#endregion
+//#region src/string/getProperCase.ts
+/**
+* Return a string "With Proper Casing".
+*/
+const getProperCase = (props) => {
+	const cleanInput = props.input.toString().trim();
+	if (reservedWords.includes(cleanInput.toUpperCase())) return cleanInput;
+	let splitPattern = /\s+/;
+	const separators = [];
+	if (props?.hyphen) separators.push("-");
+	if (props?.pipe) separators.push("\\|");
+	if (props?.underscore) separators.push("_");
+	if (separators.length > 0) splitPattern = new RegExp(`[\\s${separators.join("")}]+`, "g");
+	return cleanInput.split(splitPattern).filter((word) => word.length > 0).map((word) => {
+		const reservedWord = isReservedWord(word);
+		if (reservedWord) return reservedWord;
+		return word.charAt(0).toUpperCase() + word.slice(1).toLowerCase();
+	}).join(" ");
+};
+
+//#endregion
+//#region src/string/getWithoutWhitespaces.ts
+/**
+* Remove all new lines, tabs multiple spaces, with a single space.
+* https://stackoverflow.com/a/45029224
+*/
+const getWithoutWhitespaces = (input) => {
+	return input.replace(/\s+/g, " ").trim();
+};
+
+//#endregion
+//#region src/string/getWithoutPunctuation.ts
+/**
+* Remove all punctuation from a string and replace with a space.
+* https://stackoverflow.com/a/25575009
+*/
+const getWithoutPunctuation = (input) => {
+	return input.replace(/[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,\-.\/:;<=>?@\[\]^_`{|}~]/g, "").replace(/\s+/g, " ");
+};
+
+//#endregion
+//#region src/string/getWithoutUnderscores.ts
+/**
+* Replace all underscores with a space.
+*/
+const getWithoutUnderscores = (input) => {
+	return input.replace("_", " ");
+};
+
+//#endregion
+//#region src/string/getUnescaped.ts
+/**
+* Convert escaped copy into unescaped.
+* E.g. there&#39;s => there's
+* https://stackoverflow.com/a/42182294/2664955
+*/
+const getUnescaped = (input) => {
+	let response = input;
+	if ("undefined" !== typeof document) {
+		let el = document.createElement("textarea");
+		el.innerHTML = response;
+		response = el.value;
+	} else response = _unescape(response);
+	return response;
+};
+
+//#endregion
+//#region src/string/getClean.ts
+/**
+* Shorthand function to get a clean version of a string.
+*/
+const getClean = (props) => {
+	let response = getString(props.input);
+	if (props.decoded) response = getUnescaped(response);
+	if (props.accents) response = getWithoutAccents(response);
+	if (props.htmlTags) response = getWithoutHtmlTags(response);
+	if (props.underscores) response = getWithoutUnderscores(response);
+	if (props.punctuation) response = getWithoutPunctuation(response);
+	if (props.whitespace) response = getWithoutWhitespaces(response);
+	if (props.lowercase) response = response.toLowerCase();
+	if (props.propercase) response = getProperCase({ input: response });
+	if (props.uppercase) response = response.toUpperCase();
+	if (props.trim) response = response.trim();
+	return response;
+};
+
+//#endregion
+//#region src/string/getFolder.ts
+/**
+* Take an input that may have a / before or after the input and return just the folder.
+*/
+const getFolder = (input) => {
+	return trim(input, "/").trim();
+};
+
+//#endregion
+//#region src/string/getStringFromStream.ts
+/**
+* Converts a stream into a string.
+* https://stackoverflow.com/a/49428486
+*/
+const getStringFromStream = (stream) => {
+	const chunks = [];
+	return new Promise((resolve, reject) => {
+		stream.on("data", (chunk) => chunks.push(Buffer.from(chunk)));
+		stream.on("error", (err) => reject(err));
+		stream.on("end", () => resolve(Buffer.concat(chunks).toString("utf8")));
+	});
+};
+
+//#endregion
+export { getCapitalised, getClean, getFolder, getProperCase, getString, getStringFromStream, getUnescaped, getWithoutAccents, getWithoutHtmlTags, getWithoutPunctuation, getWithoutUnderscores, getWithoutWhitespaces, isReservedWord, reservedWords };

package/dist/swr/client/index.d.mts

@@ -0,0 +1,46 @@
+import { c as ApiState } from "../../index-B20FTOvk.mjs";
+
+//#region src/swr/client/swr.d.ts
+type Swr = {
+  data: any;
+  onSuccess?: Function;
+  skipFetch?: boolean;
+  url: string;
+};
+type SwrResponse = {
+  data: any;
+  error: any;
+  fetcher: Function;
+  mutate: {
+    data: any;
+    url: string;
+  };
+  state?: ApiState;
+  swrMutate: Function;
+};
+/**
+ * Check to see if a single SWR has an error.
+ */
+declare const isData: (swr: SwrResponse) => boolean;
+/**
+ * Check to see if a single SWR is loading.
+ */
+declare const isLoading: (swr: SwrResponse) => boolean;
+/**
+ * Check to see if a single SWR has an error.
+ */
+declare const isError: (swr: SwrResponse) => boolean;
+/**
+ * Are any of SWRs loading
+ */
+declare const isAnyLoading: (swrs: SwrResponse[]) => boolean;
+/**
+ * Are any of the SWRs marked as an error.
+ */
+declare const isAnyError: (swrs: SwrResponse[]) => boolean;
+/**
+ * Are all SWRs data ready.
+ */
+declare const isAllData: (swrs: SwrResponse[]) => boolean;
+//#endregion
+export { Swr, SwrResponse, isAllData, isAnyError, isAnyLoading, isData, isError, isLoading };

package/dist/swr/client/index.mjs

@@ -0,0 +1,40 @@
+//#region src/swr/client/swr.ts
+/**
+* Check to see if a single SWR has an error.
+*/
+const isData = (swr) => (void 0 === swr.error || null === swr.error) && "undefined" !== typeof swr.data && "undefined" !== swr.data;
+/**
+* Check to see if a single SWR is loading.
+*/
+const isLoading = (swr) => !isError(swr) && !isData(swr);
+/**
+* Check to see if a single SWR has an error.
+*/
+const isError = (swr) => void 0 !== swr.error && null !== swr.error;
+/**
+* Are any of SWRs loading
+*/
+const isAnyLoading = (swrs) => {
+	let counter = 0;
+	for (const swr in swrs) if (isLoading(swrs[swr])) counter++;
+	return counter > 0;
+};
+/**
+* Are any of the SWRs marked as an error.
+*/
+const isAnyError = (swrs) => {
+	let counter = 0;
+	for (const swr in swrs) if (isError(swrs[swr])) counter++;
+	return counter > 0;
+};
+/**
+* Are all SWRs data ready.
+*/
+const isAllData = (swrs) => {
+	let counter = 0;
+	for (const swr in swrs) if (isData(swrs[swr])) counter++;
+	return counter === Object.keys(swrs).length;
+};
+
+//#endregion
+export { isAllData, isAnyError, isAnyLoading, isData, isError, isLoading };

package/dist/upTimeRobot/server/index.d.mts

@@ -0,0 +1,72 @@
+import { t as BaseNamespace } from "../../index-CFaAdPAh.mjs";
+
+//#region src/upTimeRobot/server/UpTimeRobotNamespace.d.ts
+type GetReportProps = {
+  custom_uptime_ranges?: string;
+  logs?: boolean;
+  logs_start_date?: string;
+  logs_end_date?: string;
+  monitors?: string | string[];
+  response_times?: boolean;
+  response_times_start_date?: string;
+  response_times_end_date?: string;
+  search?: string;
+  statuses?: number | number[];
+  types?: number | number[];
+  limit?: number;
+  offset?: number;
+};
+/**
+ * Use the Up Time Robot API to retrieve up to 50 monitors at a time.
+ * https://uptimerobot.com/api/
+ */
+declare class UpTimeRobotNamespace extends BaseNamespace {
+  client: boolean;
+  config: UpTimeRobotConfig;
+  /**
+   * Renew the access token as it expires every 3 hours.
+   */
+  ensureInit: () => Promise<void>;
+  getReport: (props?: GetReportProps) => Promise<any>;
+}
+//#endregion
+//#region src/upTimeRobot/server/upTimeRobot.d.ts
+type UpTimeRobotConfig = {
+  apiKey: string;
+};
+declare const upTimeRobotClient: (key?: string, config?: UpTimeRobotConfig, vaultId?: string, itemId?: string) => Promise<UpTimeRobotNamespace>;
+declare const logTypes: {
+  DOWN: number;
+  UP: number;
+  PAUSED: number;
+  STARTED: number;
+};
+declare const monitorStatuses: {
+  PAUSED: number;
+  NOT_CHECKED: number;
+  UP: number;
+  SEEMS_DOWN: number;
+  DOWN: number;
+};
+declare const monitorSubTypes: {
+  HTTP: number;
+  HTTPS: number;
+  FTP: number;
+  SMTP: number;
+  POP3: number;
+  IMAP: number;
+  CUSTOM_PORT: number;
+};
+declare const monitorTypes: {
+  HTTPS: number;
+  KEYWORD: number;
+  PING: number;
+  PORT: number;
+  HEARTBEAT: number;
+};
+declare const requestStatuses: {
+  ERROR: string;
+  SUCCESS: string;
+};
+//#endregion
+export { UpTimeRobotConfig, UpTimeRobotNamespace, logTypes, monitorStatuses, monitorSubTypes, monitorTypes, requestStatuses, upTimeRobotClient };

package/dist/upTimeRobot/server/index.mjs

@@ -0,0 +1,83 @@
+import { BaseNamespace } from "../../_class/index.mjs";
+import "../../api-DGKJDAfb.mjs";
+import { post } from "../../axios/index.mjs";
+import { onePasswordClient } from "../../onePassword/server/index.mjs";
+import isArray from "lodash/isArray";
+
+//#region src/upTimeRobot/server/UpTimeRobotNamespace.ts
+/**
+* Use the Up Time Robot API to retrieve up to 50 monitors at a time.
+* https://uptimerobot.com/api/
+*/
+var UpTimeRobotNamespace = class extends BaseNamespace {
+	/**
+	* Renew the access token as it expires every 3 hours.
+	*/
+	ensureInit = async () => {
+		if (!this.client) this.client = true;
+	};
+	getReport = async (props) => {
+		let response = null;
+		let finalParams = {};
+		if (void 0 !== props) {
+			finalParams = { ...props };
+			if (void 0 !== props.monitors && isArray(props.monitors)) finalParams["monitors"] = props.monitors.join("-");
+			if (void 0 !== props.statuses && isArray(props.statuses)) finalParams["statuses"] = props.statuses.join("-");
+			if (void 0 !== props.types && isArray(props.types)) finalParams["types"] = props.types.join("-");
+		}
+		const apiResponse = await post(`https://api.uptimerobot.com/v2/getMonitors?api_key=${this.config.apiKey}`, finalParams);
+		if (apiResponse.isSuccess()) response = apiResponse.getBody();
+		return response;
+	};
+};
+
+//#endregion
+//#region src/upTimeRobot/server/upTimeRobot.ts
+const upTimeRobotNamespaces = /* @__PURE__ */ new Map();
+const upTimeRobotClient = async (key = "default", config, vaultId, itemId) => {
+	if (upTimeRobotNamespaces.has(key)) return upTimeRobotNamespaces.get(key);
+	let instanceConfig;
+	if (config) instanceConfig = config;
+	else if (vaultId && itemId) instanceConfig = await (await onePasswordClient()).getJsonNote(vaultId, itemId);
+	else if (process.env.UP_TIME_ROBOT_VAULT_ID && process.env.UP_TIME_ROBOT_ITEM_ID) instanceConfig = await (await onePasswordClient()).getJsonNote(process.env.UP_TIME_ROBOT_VAULT_ID, process.env.UP_TIME_ROBOT_ITEM_ID);
+	else throw new Error(`Config required for namespace '${key}'`);
+	const namespace = new UpTimeRobotNamespace(key, instanceConfig);
+	upTimeRobotNamespaces.set(key, namespace);
+	return namespace;
+};
+const logTypes = {
+	DOWN: 1,
+	UP: 2,
+	PAUSED: 99,
+	STARTED: 98
+};
+const monitorStatuses = {
+	PAUSED: 0,
+	NOT_CHECKED: 1,
+	UP: 2,
+	SEEMS_DOWN: 8,
+	DOWN: 9
+};
+const monitorSubTypes = {
+	HTTP: 1,
+	HTTPS: 2,
+	FTP: 3,
+	SMTP: 4,
+	POP3: 5,
+	IMAP: 6,
+	CUSTOM_PORT: 99
+};
+const monitorTypes = {
+	HTTPS: 1,
+	KEYWORD: 2,
+	PING: 3,
+	PORT: 4,
+	HEARTBEAT: 5
+};
+const requestStatuses = {
+	ERROR: "fail",
+	SUCCESS: "ok"
+};
+
+//#endregion
+export { UpTimeRobotNamespace, logTypes, monitorStatuses, monitorSubTypes, monitorTypes, requestStatuses, upTimeRobotClient };

package/dist/url/index.d.mts

@@ -0,0 +1,29 @@
+//#region src/url/url.d.ts
+type EnvironmentUrl = {
+  localhost: string;
+  development: string;
+  staging: string;
+  production: string;
+};
+/**
+ * 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;
+/**
+ * Get the current base url.
+ */
+declare const buildEnvironmentUrl: (path: string, url: EnvironmentUrl) => string;
+//#endregion
+export { EnvironmentUrl, buildEnvironmentUrl, buildParameters, buildRelative, isAbsolute, isRelative };

package/dist/url/index.mjs

@@ -0,0 +1,52 @@
+import { isDevelopment, isLocalhost, isProduction, isStaging } from "../environment/index.mjs";
+import merge from "lodash/merge";
+
+//#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 || {})}`;
+};
+/**
+* Get the current base url.
+*/
+const buildEnvironmentUrl = (path, url) => {
+	let response;
+	if (isDevelopment() && isLocalhost()) response = url.localhost;
+	else if (isStaging()) response = url.staging;
+	else if (isProduction()) response = url.production;
+	else response = url.development;
+	return response + path || "";
+};
+
+//#endregion
+export { buildEnvironmentUrl, buildParameters, buildRelative, isAbsolute, isRelative };

package/dist/url/server/index.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 };