@8ms/helpers 1.40.0 → 1.40.1

package/dist/number/getCurrency.d.mts

@@ -0,0 +1,15 @@
+//#region src/number/getCurrency.d.ts
+type GetCurrency = {
+  currency: string;
+  input: any;
+};
+/**
+ * Use the International number formatting to return the currency value.
+ * https://www.freecodecamp.org/news/how-to-format-number-as-currency-in-javascript-one-line-of-code/
+ */
+declare const getCurrency: ({
+  currency,
+  input
+}: GetCurrency) => string;
+//#endregion
+export { getCurrency as default };

package/dist/number/getCurrency.mjs

@@ -0,0 +1,17 @@
+//#region src/number/getCurrency.ts
+/**
+* Use the International number formatting to return the currency value.
+* https://www.freecodecamp.org/news/how-to-format-number-as-currency-in-javascript-one-line-of-code/
+*/
+const getCurrency = ({ currency, input }) => {
+	const value = Number(input);
+	const currencyClean = currency.toUpperCase().trim();
+	let formatted = new Intl.NumberFormat("en-GB", {
+		style: "currency",
+		currency: currencyClean
+	}).format(value);
+	if ("USD" === currencyClean) formatted = formatted.replace("US$", "$");
+	return formatted;
+};
+//#endregion
+export { getCurrency as default };

package/dist/number/getDecimal.d.mts

@@ -0,0 +1,11 @@
+//#region src/number/getDecimal.d.ts
+type GetDecimal = {
+  dp?: number;
+  input: any;
+};
+/**
+ * Return a decimal number after rounding.
+ */
+declare const getDecimal: (props: GetDecimal) => number;
+//#endregion
+export { getDecimal as default };

package/dist/number/getDecimal.mjs

@@ -0,0 +1,11 @@
+import getNumber from "./getNumber.mjs";
+//#region src/number/getDecimal.ts
+/**
+* Return a decimal number after rounding.
+*/
+const getDecimal = (props) => {
+	const number = getNumber({ input: props.input });
+	return Number(number.toFixed(props?.dp || 2));
+};
+//#endregion
+export { getDecimal as default };

package/dist/number/getDivide.d.mts

@@ -0,0 +1,13 @@
+//#region src/number/getDivide.d.ts
+type GetDivide = {
+  defaultValue?: number;
+  dp?: number;
+  divisor: any;
+  numerator: any;
+};
+/**
+ * Shorthand function to divide number, but fallback if the divisor is 0.
+ */
+declare const getDivide: (props: GetDivide) => number;
+//#endregion
+export { getDivide as default };

package/dist/number/getDivide.mjs

@@ -0,0 +1,17 @@
+import getNumber from "./getNumber.mjs";
+import getDecimal from "./getDecimal.mjs";
+//#region src/number/getDivide.ts
+/**
+* Shorthand function to divide number, but fallback if the divisor is 0.
+*/
+const getDivide = (props) => {
+	const numeratorInt = getNumber({ input: props.numerator });
+	const divisorInt = getNumber({ input: props.divisor });
+	if (0 === divisorInt) return props.defaultValue || 0;
+	return getDecimal({
+		dp: props?.dp,
+		input: numeratorInt / divisorInt
+	});
+};
+//#endregion
+export { getDivide as default };

package/dist/number/getNumber.d.mts

@@ -0,0 +1,13 @@
+//#region src/number/getNumber.d.ts
+/**
+ * Take an input and return a number.
+ */
+declare const getNumber: ({
+  defaultValue,
+  input
+}: {
+  defaultValue?: number;
+  input: any;
+}) => number;
+//#endregion
+export { getNumber as default };

package/dist/number/getNumber.mjs

@@ -0,0 +1,23 @@
+import isJson from "../json/isJson.mjs";
+//#region src/number/getNumber.ts
+/**
+* Take an input and return a number.
+*/
+const getNumber = ({ defaultValue = 0, input = "" }) => {
+	const actualDefaultValue = defaultValue || 0;
+	let response = input;
+	if (isJson({ input })) if ("string" === typeof input) response = JSON.parse(input);
+	else response = input;
+	if ("number" === typeof response) response = response;
+	else if ("string" === typeof response) {
+		response = Number(response);
+		if (isNaN(response)) {
+			const match = RegExp(/^\D*([0-9\.]*)\D*$/, "g").exec(input);
+			if (match.length) response = Number(match[1]);
+		}
+	} else response = Number(response);
+	if (isNaN(response)) response = actualDefaultValue;
+	return response;
+};
+//#endregion
+export { getNumber as default };

package/dist/number/getPercentIncrease.d.mts

@@ -0,0 +1,16 @@
+//#region src/number/getPercentIncrease.d.ts
+type GetPercentageIncrease = {
+  comparison: any;
+  current: any;
+  defaultValue: number;
+};
+/**
+ * Formula to work out the percentage increase/decrease.
+ */
+declare const getPercentageIncrease: ({
+  comparison,
+  current,
+  defaultValue
+}: GetPercentageIncrease) => number;
+//#endregion
+export { getPercentageIncrease as default };

package/dist/number/getPercentIncrease.mjs

@@ -0,0 +1,13 @@
+import getNumber from "./getNumber.mjs";
+//#region src/number/getPercentIncrease.ts
+/**
+* Formula to work out the percentage increase/decrease.
+*/
+const getPercentageIncrease = ({ comparison, current, defaultValue }) => {
+	const currentValue = getNumber({ input: current });
+	const comparisonValue = getNumber({ input: comparison });
+	if (0 === comparisonValue) return defaultValue;
+	return (currentValue - comparisonValue) / comparisonValue * 100;
+};
+//#endregion
+export { getPercentageIncrease as default };

package/dist/object/replaceKeys.d.mts

@@ -0,0 +1,15 @@
+//#region src/object/replaceKeys.d.ts
+type ReplaceKeys = {
+  instance: any;
+  getNewKey: Function;
+};
+/**
+ * Iteratively replace all the keys in an object.
+ * https://www.techighness.com/post/replace-all-keys-of-deeply-nested-objects-or-array-of-objects/
+ */
+declare const replaceKeys: ({
+  instance,
+  getNewKey
+}: ReplaceKeys) => object;
+//#endregion
+export { replaceKeys as default };

package/dist/object/replaceKeys.mjs

@@ -0,0 +1,27 @@
+//#region src/object/replaceKeys.ts
+/**
+* Iteratively replace all the keys in an object.
+* https://www.techighness.com/post/replace-all-keys-of-deeply-nested-objects-or-array-of-objects/
+*/
+const replaceKeys = ({ instance, getNewKey }) => {
+	let response = instance;
+	if (Array.isArray(instance)) {
+		response = [];
+		for (let i = 0; i < instance.length; i++) response[i] = replaceKeys({
+			instance: instance[i],
+			getNewKey
+		});
+	} else if ("object" === typeof instance) {
+		response = {};
+		for (const key in instance) {
+			const newKey = getNewKey(key);
+			response[newKey] = replaceKeys({
+				instance: instance[key],
+				getNewKey
+			});
+		}
+	}
+	return response;
+};
+//#endregion
+export { replaceKeys as default };

package/dist/prisma/getDecimal.d.mts

@@ -0,0 +1,11 @@
+//#region src/prisma/getDecimal.d.ts
+type GetDecimal = {
+  input: any;
+  dp?: number;
+};
+/**
+ * Fetch the number from a prisma decimal (comes through as an object).
+ */
+declare const getDecimal: (props: GetDecimal) => number;
+//#endregion
+export { getDecimal as default };

package/dist/prisma/getDecimal.mjs

@@ -0,0 +1,17 @@
+import getDecimal$1 from "../number/getDecimal.mjs";
+import isArray from "lodash/isArray.js";
+//#region src/prisma/getDecimal.ts
+/**
+* Fetch the number from a prisma decimal (comes through as an object).
+*/
+const getDecimal = (props) => {
+	let numberString = "";
+	if (isArray(props?.input?.d)) numberString = props.input.absoluteValue();
+	else numberString = props?.input.toString();
+	return getDecimal$1({
+		input: numberString,
+		dp: props?.dp
+	});
+};
+//#endregion
+export { getDecimal as default };

package/dist/prisma/initClient.d.mts

@@ -0,0 +1,8 @@
+//#region src/prisma/initClient.d.ts
+type InitClient = {
+  debug?: boolean;
+  planetScale?: boolean;
+};
+declare const initClient: (props?: InitClient) => void;
+//#endregion
+export { initClient as default };

package/dist/prisma/initClient.mjs

@@ -0,0 +1,25 @@
+import { t as __require } from "../chunk-y_GBKt04.mjs";
+//#region src/prisma/initClient.ts
+global.prisma = null;
+const initClient = (props = {}) => {
+	if (!global.prisma) {
+		const { PrismaClient } = __require("@prisma/client");
+		let adapter = null;
+		if (true === props?.planetScale) {
+			const { Client } = __require("@planetscale/database");
+			const client = new Client({ url: process.env.DATABASE_URL });
+			const { PrismaPlanetScale } = __require("@prisma/adapter-planetscale");
+			adapter = new PrismaPlanetScale(client);
+		}
+		if (true === props?.debug) global.prisma = new PrismaClient({
+			adapter,
+			log: [{
+				emit: "event",
+				level: "query"
+			}]
+		});
+		else global.prisma = new PrismaClient({ adapter });
+	}
+};
+//#endregion
+export { initClient as default };

package/dist/response-CKsarnP-.d.mts

@@ -0,0 +1,11 @@
+import { t as State } from "./index-gGQBTUJU.mjs";
+
+//#region src/api/response.d.ts
+type Response = {
+  body: any | null;
+  error: string | null;
+  state: State;
+};
+declare const response: Response;
+//#endregion
+export { response as n, Response as t };

package/dist/snapchat/getAccessToken.d.mts

@@ -0,0 +1,14 @@
+//#region src/snapchat/getAccessToken.d.ts
+type GetAccessToken = {
+  force?: boolean;
+  parameterName: string;
+};
+/**
+ * Renew the access token as it expires every 3 hours.
+ */
+declare const getAccessToken: ({
+  force,
+  parameterName
+}: GetAccessToken) => Promise<void>;
+//#endregion
+export { getAccessToken as default };

package/dist/snapchat/getAccessToken.mjs

@@ -0,0 +1,29 @@
+import getParameter from "../aws/ssm/getParameter.mjs";
+import post from "../axios/post.mjs";
+//#region src/snapchat/getAccessToken.ts
+global.snapchatAccessToken = null;
+/**
+* Renew the access token as it expires every 3 hours.
+*/
+const getAccessToken = async ({ force, parameterName }) => {
+	if (!global.snapchatAccessToken || force) {
+		const parameter = await getParameter({
+			name: parameterName,
+			withDecryption: true,
+			isJson: true
+		});
+		let url = `https://accounts.snapchat.com/login/oauth2/access_token`;
+		url += `?client_id=${parameter.clientId}`;
+		url += `&client_secret=${parameter.clientSecret}`;
+		url += `&grant_type=refresh_token`;
+		url += `&refresh_token=${parameter.refreshToken}`;
+		const apiResponse = await post({ url });
+		if (apiResponse.isSuccess()) global.snapchatAccessToken = apiResponse.getBodyDefaultTo({
+			defaultValue: null,
+			keys: ["data", "access_token"]
+		});
+	}
+	return global.snapchatAccessToken;
+};
+//#endregion
+export { getAccessToken as default };

package/dist/sorting/byNumberAscending.d.mts

@@ -0,0 +1,13 @@
+//#region src/sorting/byNumberAscending.d.ts
+/**
+ * Take two values, ensure they are numbers and return the sorting value.
+ */
+declare const byNumberAscending: ({
+  valueA,
+  valueB
+}: {
+  valueA: any;
+  valueB: any;
+}) => number;
+//#endregion
+export { byNumberAscending as default };

package/dist/sorting/byNumberAscending.mjs

@@ -0,0 +1,13 @@
+//#region src/sorting/byNumberAscending.ts
+/**
+* Take two values, ensure they are numbers and return the sorting value.
+*/
+const byNumberAscending = ({ valueA, valueB }) => {
+	let valueAClean = Number(valueA);
+	let valueBClean = Number(valueB);
+	if (valueAClean > valueBClean) return 1;
+	if (valueBClean > valueAClean) return -1;
+	return 0;
+};
+//#endregion
+export { byNumberAscending as default };

package/dist/sorting/byNumberDescending.d.mts

@@ -0,0 +1,13 @@
+//#region src/sorting/byNumberDescending.d.ts
+/**
+ * Take two values, ensure they are numbers and return the sorting value.
+ */
+declare const byNumberDescending: ({
+  valueA,
+  valueB
+}: {
+  valueA: any;
+  valueB: any;
+}) => number;
+//#endregion
+export { byNumberDescending as default };

package/dist/sorting/byNumberDescending.mjs

@@ -0,0 +1,13 @@
+//#region src/sorting/byNumberDescending.ts
+/**
+* Take two values, ensure they are numbers and return the sorting value.
+*/
+const byNumberDescending = ({ valueA, valueB }) => {
+	let valueAClean = Number(valueA);
+	let valueBClean = Number(valueB);
+	if (valueAClean > valueBClean) return -1;
+	if (valueBClean > valueAClean) return 1;
+	return 0;
+};
+//#endregion
+export { byNumberDescending as default };

package/dist/sorting/byStringAscending.d.mts

@@ -0,0 +1,13 @@
+//#region src/sorting/byStringAscending.d.ts
+/**
+ * Take two values, clean the strings and return the sorting value.
+ */
+declare const byStringAscending: ({
+  valueA,
+  valueB
+}: {
+  valueA: any;
+  valueB: any;
+}) => number;
+//#endregion
+export { byStringAscending as default };

package/dist/sorting/byStringAscending.mjs

@@ -0,0 +1,13 @@
+//#region src/sorting/byStringAscending.ts
+/**
+* Take two values, clean the strings and return the sorting value.
+*/
+const byStringAscending = ({ valueA, valueB }) => {
+	let valueAClean = valueA.trim().toLowerCase();
+	let valueBClean = valueB.trim().toLowerCase();
+	if (valueAClean > valueBClean) return 1;
+	if (valueBClean > valueAClean) return -1;
+	return 0;
+};
+//#endregion
+export { byStringAscending as default };

package/dist/sorting/byStringDescending.d.mts

@@ -0,0 +1,13 @@
+//#region src/sorting/byStringDescending.d.ts
+/**
+ * Take two values, clean the strings and return the sorting value.
+ */
+declare const byStringDescending: ({
+  valueA,
+  valueB
+}: {
+  valueA: any;
+  valueB: any;
+}) => number;
+//#endregion
+export { byStringDescending as default };

package/dist/sorting/byStringDescending.mjs

@@ -0,0 +1,13 @@
+//#region src/sorting/byStringDescending.ts
+/**
+* Take two values, clean the strings and return the sorting value.
+*/
+const byStringDescending = ({ valueA, valueB }) => {
+	let valueAClean = valueA.trim().toLowerCase();
+	let valueBClean = valueB.trim().toLowerCase();
+	if (valueAClean > valueBClean) return -1;
+	if (valueBClean > valueAClean) return 1;
+	return 0;
+};
+//#endregion
+export { byStringDescending as default };

package/dist/stream/sort.d.mts

@@ -0,0 +1,16 @@
+//#region src/stream/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 {
+  static [x: string]: any;
+  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 as default };

package/dist/stream/sort.mjs

@@ -0,0 +1,46 @@
+import { t as __require } from "../chunk-y_GBKt04.mjs";
+//#region src/stream/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 as default };

package/dist/string/getCapitalised.d.mts

@@ -0,0 +1,15 @@
+//#region src/string/getCapitalised.d.ts
+type GetCapitalised = {
+  input: string;
+  split?: string;
+};
+/**
+ * Convert a string into Capitalised Text.
+ * https://stackoverflow.com/a/196991/2664955
+ */
+declare const getCapitalised: ({
+  input,
+  split
+}: GetCapitalised) => string;
+//#endregion
+export { getCapitalised as default };

package/dist/string/getCapitalised.mjs

@@ -0,0 +1,13 @@
+//#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) {
+		return txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase();
+	});
+};
+//#endregion
+export { getCapitalised as default };

package/dist/string/getClean.d.mts

@@ -0,0 +1,32 @@
+//#region src/string/getClean.d.ts
+type GetClean = {
+  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: ({
+  accents,
+  decoded,
+  htmlTags,
+  input,
+  lowercase,
+  propercase,
+  punctuation,
+  trim,
+  underscores,
+  uppercase,
+  whitespace
+}: GetClean) => string;
+//#endregion
+export { getClean as default };

package/dist/string/getClean.mjs

@@ -0,0 +1,28 @@
+import getString from "./getString.mjs";
+import getWithoutHtmlTags from "./getWithoutHtmlTags.mjs";
+import getWithoutAccents from "./getWithoutAccents.mjs";
+import getProperCase from "./getProperCase.mjs";
+import getWithoutWhitespaces from "./getWithoutWhitespaces.mjs";
+import getWithoutPunctuation from "./getWithoutPunctuation.mjs";
+import getWithoutUnderscores from "./getWithoutUnderscores.mjs";
+import getDecoded from "./getDecoded.mjs";
+//#region src/string/getClean.ts
+/**
+* Shorthand function to get a clean version of a string.
+*/
+const getClean = ({ accents, decoded, htmlTags, input, lowercase, propercase, punctuation, trim, underscores, uppercase, whitespace }) => {
+	let response = getString({ input });
+	if (decoded) response = getDecoded({ input: response });
+	if (accents) response = getWithoutAccents({ input: response });
+	if (htmlTags) response = getWithoutHtmlTags({ input: response });
+	if (underscores) response = getWithoutUnderscores({ input: response });
+	if (punctuation) response = getWithoutPunctuation({ input: response });
+	if (whitespace) response = getWithoutWhitespaces({ input: response });
+	if (lowercase) response = response.toLowerCase();
+	if (propercase) response = getProperCase({ input: response });
+	if (uppercase) response = response.toUpperCase();
+	if (trim) response = response.trim();
+	return response;
+};
+//#endregion
+export { getClean as default };

package/dist/string/getDecoded.d.mts

@@ -0,0 +1,14 @@
+//#region src/string/getDecoded.d.ts
+type GetDecoded = {
+  input: any;
+};
+/**
+ * Convert escaped copy into unescaped.
+ * E.g. there's => there's
+ * https://stackoverflow.com/a/42182294/2664955
+ */
+declare const getDecoded: ({
+  input
+}: GetDecoded) => string;
+//#endregion
+export { getDecoded as default };

package/dist/string/getDecoded.mjs

@@ -0,0 +1,19 @@
+import getString from "./getString.mjs";
+import _unescape from "lodash/unescape.js";
+//#region src/string/getDecoded.ts
+/**
+* Convert escaped copy into unescaped.
+* E.g. there's => there's
+* https://stackoverflow.com/a/42182294/2664955
+*/
+const getDecoded = ({ input }) => {
+	let response = getString({ input });
+	if ("undefined" !== typeof document) {
+		let el = document.createElement("textarea");
+		el.innerHTML = response;
+		response = el.value;
+	} else response = _unescape(response);
+	return response;
+};
+//#endregion
+export { getDecoded as default };

package/dist/string/getFolder.d.mts

@@ -0,0 +1,12 @@
+//#region src/string/getFolder.d.ts
+type GetFolder = {
+  input: string;
+};
+/**
+ * Take an input that may have a / before or after the input and return just the folder.
+ */
+declare const getFolder: ({
+  input
+}: GetFolder) => string;
+//#endregion
+export { getFolder as default };