@rootreeweb/js-lib 4.0.10

package/dist/cjs/general/numbers.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Converts a decimal number to a fraction.
+ *
+ * @param decimal - The decimal number to convert.
+ * @returns An object containing the numerator and denominator of the fraction.
+ */
+export declare function decimalToFraction(decimal: number): {
+    denominator: number;
+    numerator: number;
+    whole: number;
+};
+/**
+ * Calculate the greatest common divisor of two numbers.
+ *
+ * @param a The first number.
+ * @param b The second number.
+ * @returns The greatest common divisor.
+ */
+export declare function gcd(a: number, b: number): number;
+/**
+ * Get the aspect ratio of an image.
+ *
+ * @param width The width of the image.
+ * @param height The height of the image.
+ * @returns The aspect ratio.
+ */
+export declare function getAspectRatio(width: number, height: number): string;
+/**
+ * Checks if the given value is numeric.
+ *
+ * @param value The value to check.
+ * @returns A boolean value indicating whether the value is numeric.
+ */
+export declare function isNumeric(value: unknown): boolean;
+/**
+ * Round a number to a specific precision.
+ *
+ * @param value The value to round.
+ * @param precision The number of decimal places to round to.
+ * @returns The rounded value.
+ */
+export declare function toPrecision(value: number, precision: number): number;
+//# sourceMappingURL=numbers.d.ts.map

package/dist/cjs/general/numbers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"numbers.d.ts","sourceRoot":"","sources":["../../../src/general/numbers.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACd,CAuCA;AAED;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAGpE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAIjD;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAGpE"}

package/dist/cjs/general/numbers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"numbers.js","sourceRoot":"","sources":["../../../src/general/numbers.ts"],"names":[],"mappings":";;AAMA,8CA2CC;AASD,kBAEC;AASD,wCAGC;AAQD,8BAIC;AASD,kCAGC;AAhGD;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,OAAe;IAKhD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClC,MAAM,cAAc,GAAG,OAAO,GAAG,KAAK,CAAC;IAEvC,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,WAAW,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC;IAChD,CAAC;IAED,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,IAAI,eAAe,GAAG,CAAC,CAAC;IACxB,IAAI,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,GAAG,aAAa,GAAG,eAAe,CAAC,CAAC;IAE1E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;QAChC,gCAAgC;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7B,MAAM,eAAe,GAAG,CAAC,GAAG,CAAC,CAAC;YAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,GAAG,eAAe,CAAC,CAAC;YAEzD,IAAI,KAAK,GAAG,QAAQ,EAAE,CAAC;gBACtB,QAAQ,GAAG,KAAK,CAAC;gBACjB,aAAa,GAAG,CAAC,CAAC;gBAClB,eAAe,GAAG,CAAC,CAAC;gBACpB,IAAI,KAAK,GAAG,QAAQ,EAAE,CAAC;oBACtB,+BAA+B;oBAC/B,MAAM,CAAC,kDAAkD;gBAC1D,CAAC;YACF,CAAC;QACF,CAAC;QACD,IAAI,QAAQ,GAAG,QAAQ,EAAE,CAAC;YACzB,MAAM,CAAC,iBAAiB;QACzB,CAAC;IACF,CAAC;IAED,MAAM,OAAO,GAAG,GAAG,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;IACpD,OAAO;QACN,WAAW,EAAE,eAAe,GAAG,OAAO;QACtC,SAAS,EAAE,aAAa,GAAG,OAAO;QAClC,KAAK;KACL,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,GAAG,CAAC,CAAS,EAAE,CAAS;IACvC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,KAAa,EAAE,MAAc;IAC3D,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACnC,OAAO,GAAG,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC;AACjE,CAAC;AAED;;;;;GAKG;AACH,SAAgB,SAAS,CAAC,KAAc;IACvC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtE,OAAO,KAAK,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,KAAa,EAAE,SAAiB;IAC3D,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IACvC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC;AAC5C,CAAC","sourcesContent":["/**\n * Converts a decimal number to a fraction.\n *\n * @param decimal - The decimal number to convert.\n * @returns An object containing the numerator and denominator of the fraction.\n */\nexport function decimalToFraction(decimal: number): {\n\tdenominator: number;\n\tnumerator: number;\n\twhole: number;\n} {\n\tconst whole = Math.floor(decimal);\n\tconst fractionalPart = decimal - whole;\n\n\tif (fractionalPart === 0) {\n\t\treturn { denominator: 1, numerator: 0, whole };\n\t}\n\n\tlet bestNumerator = 0;\n\tlet bestDenominator = 1;\n\tlet minError = Math.abs(fractionalPart - bestNumerator / bestDenominator);\n\n\tfor (let i = 1; i <= 1000; i++) {\n\t\t// Check denominators up to 1000\n\t\tfor (let j = 0; j <= i; j++) {\n\t\t\tconst currentFraction = j / i;\n\t\t\tconst error = Math.abs(fractionalPart - currentFraction);\n\n\t\t\tif (error < minError) {\n\t\t\t\tminError = error;\n\t\t\t\tbestNumerator = j;\n\t\t\t\tbestDenominator = i;\n\t\t\t\tif (error < 0.000001) {\n\t\t\t\t\t//Added a small error threshold\n\t\t\t\t\tbreak; //Exit inner loop once a reasonable value is found\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif (minError < 0.000001) {\n\t\t\tbreak; //Exit outer loop\n\t\t}\n\t}\n\n\tconst divisor = gcd(bestNumerator, bestDenominator);\n\treturn {\n\t\tdenominator: bestDenominator / divisor,\n\t\tnumerator: bestNumerator / divisor,\n\t\twhole,\n\t};\n}\n\n/**\n * Calculate the greatest common divisor of two numbers.\n *\n * @param a The first number.\n * @param b The second number.\n * @returns The greatest common divisor.\n */\nexport function gcd(a: number, b: number): number {\n\treturn b == 0 ? a : gcd(b, a % b);\n}\n\n/**\n * Get the aspect ratio of an image.\n *\n * @param width The width of the image.\n * @param height The height of the image.\n * @returns The aspect ratio.\n */\nexport function getAspectRatio(width: number, height: number): string {\n\tconst divisor = gcd(width, height);\n\treturn `${String(width / divisor)}:${String(height / divisor)}`;\n}\n\n/**\n * Checks if the given value is numeric.\n *\n * @param value The value to check.\n * @returns A boolean value indicating whether the value is numeric.\n */\nexport function isNumeric(value: unknown): boolean {\n\tif (typeof value === \"number\") return true;\n\tif (typeof value === \"string\") return /^-?\\d+(?:\\.\\d+)?$/.test(value);\n\treturn false;\n}\n\n/**\n * Round a number to a specific precision.\n *\n * @param value The value to round.\n * @param precision The number of decimal places to round to.\n * @returns The rounded value.\n */\nexport function toPrecision(value: number, precision: number): number {\n\tconst factor = Math.pow(10, precision);\n\treturn Math.round(value * factor) / factor;\n}\n"]}

package/dist/cjs/general/objects.cjs

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deepMerge = deepMerge;
+exports.flattenObject = flattenObject;
+exports.isEmptyObject = isEmptyObject;
+exports.isPlainObject = isPlainObject;
+exports.safeishGetProperty = safeishGetProperty;
+const arrays_js_1 = require("./arrays.cjs");
+/**
+ * Deep merge two objects.
+ *
+ * @template T The type of the objects to merge.
+ * @template U The type of the data object.
+ * @param defaults The defaults object.
+ * @param data The data object to merge into the defaults.
+ * @returns The merged object.
+ */
+function deepMerge(defaults, data) {
+    const output = { ...defaults };
+    for (const key in data) {
+        if (Object.prototype.hasOwnProperty.call(data, key)) {
+            const dataValue = safeishGetProperty(data, key);
+            const defaultsValue = safeishGetProperty(defaults, key);
+            if (isObject(dataValue) && isObject(defaultsValue)) {
+                output[key] = deepMerge(defaultsValue, dataValue);
+            }
+            else if (Array.isArray(dataValue) && Array.isArray(defaultsValue)) {
+                output[key] = (0, arrays_js_1.dedupe)([...defaultsValue, ...dataValue]);
+            }
+            else {
+                output[key] = dataValue;
+            }
+        }
+    }
+    return output;
+}
+/**
+ * Removes any unserializable objects from the object.
+ *
+ * @template T The type of the object.
+ * @param obj The object to flatten.
+ * @returns The flattened object.
+ */
+function flattenObject(obj) {
+    return JSON.parse(JSON.stringify(obj));
+}
+/**
+ * Determines if an object is empty.
+ *
+ * @param obj The object to check.
+ * @returns True if the object is empty.
+ */
+function isEmptyObject(obj) {
+    return Object.keys(obj).length === 0;
+}
+/**
+ * Test if a value is a plain object for RSC purposes.
+ *
+ * @param value The value to check.
+ * @param parentKey The nested key being checked.
+ * @returns True if the object is deemed passable to a client component.
+ */
+function isPlainObject(value, parentKey) {
+    if (!isObject(value))
+        return true;
+    for (const key in value) {
+        if (!isPlainObject(value[key], key)) {
+            return false;
+        }
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const ownPrototype = Object.getPrototypeOf(value);
+    const isSelfPlain = ownPrototype === Object.prototype;
+    if (!isSelfPlain) {
+        console.error(
+        // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+        `Non-plain object found at ${parentKey || "root"}: ${String(ownPrototype)}`);
+        return false;
+    }
+    return true;
+}
+function safeishGetProperty(object, field) {
+    if (Object.prototype.hasOwnProperty.call(object, field)) {
+        // eslint-disable-next-line security/detect-object-injection
+        return object[field];
+    }
+    return undefined;
+}
+/**
+ * Check if a value is an object.
+ *
+ * @param obj The value to check.
+ * @returns True if the value is an object.
+ */
+function isObject(obj) {
+    return !!(obj && typeof obj === "object" && !Array.isArray(obj));
+}
+//# sourceMappingURL=objects.js.map

package/dist/cjs/general/objects.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Deep merge two objects.
+ *
+ * @template T The type of the objects to merge.
+ * @template U The type of the data object.
+ * @param defaults The defaults object.
+ * @param data The data object to merge into the defaults.
+ * @returns The merged object.
+ */
+export declare function deepMerge<T extends object, U extends object>(defaults: T, data: U): T & U;
+/**
+ * Removes any unserializable objects from the object.
+ *
+ * @template T The type of the object.
+ * @param obj The object to flatten.
+ * @returns The flattened object.
+ */
+export declare function flattenObject<T>(obj: T): T;
+/**
+ * Determines if an object is empty.
+ *
+ * @param obj The object to check.
+ * @returns True if the object is empty.
+ */
+export declare function isEmptyObject(obj: object): boolean;
+/**
+ * Test if a value is a plain object for RSC purposes.
+ *
+ * @param value The value to check.
+ * @param parentKey The nested key being checked.
+ * @returns True if the object is deemed passable to a client component.
+ */
+export declare function isPlainObject(value: unknown, parentKey?: string): boolean;
+/**
+ * Checks that the field exists on the object itself before getting it.
+ *
+ * @template TParent The type of the object.
+ * @template TField The key of the of the object.
+ * @param object The object to get the property from.
+ * @param field The field to get.
+ * @returns The value of the field, or undefined if it does not exist.
+ */
+export declare function safeishGetProperty<TParent extends object, TField extends keyof TParent>(object: TParent, field: TField): TParent[TField];
+export declare function safeishGetProperty<TParent extends object>(object: TParent, field: PropertyKey): unknown;
+//# sourceMappingURL=objects.d.ts.map

package/dist/cjs/general/objects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.d.ts","sourceRoot":"","sources":["../../../src/general/objects.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAC3D,QAAQ,EAAE,CAAC,EACX,IAAI,EAAE,CAAC,GACL,CAAC,GAAG,CAAC,CAmBP;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAE1C;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAElD;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAkBzE;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CACjC,OAAO,SAAS,MAAM,EACtB,MAAM,SAAS,MAAM,OAAO,EAC3B,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AACnD,wBAAgB,kBAAkB,CAAC,OAAO,SAAS,MAAM,EACxD,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,WAAW,GAChB,OAAO,CAAC"}

package/dist/cjs/general/objects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.js","sourceRoot":"","sources":["../../../src/general/objects.ts"],"names":[],"mappings":";;AAWA,8BAsBC;AASD,sCAEC;AAQD,sCAEC;AASD,sCAkBC;AAmBD,gDASC;AA7GD,2CAAqC;AAErC;;;;;;;;GAQG;AACH,SAAgB,SAAS,CACxB,QAAW,EACX,IAAO;IAEP,MAAM,MAAM,GAAG,EAAE,GAAG,QAAQ,EAAW,CAAC;IAExC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;YACrD,MAAM,SAAS,GAAG,kBAAkB,CAAC,IAAI,EAAE,GAAc,CAAC,CAAC;YAC3D,MAAM,aAAa,GAAG,kBAAkB,CAAC,QAAiB,EAAE,GAAG,CAAC,CAAC;YAEjE,IAAI,QAAQ,CAAC,SAAS,CAAC,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;gBACpD,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;YACnD,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;gBACpE,MAAc,CAAC,GAAG,CAAC,GAAG,IAAA,kBAAM,EAAC,CAAC,GAAG,aAAa,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC;YACjE,CAAC;iBAAM,CAAC;gBACN,MAAc,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;YAClC,CAAC;QACF,CAAC;IACF,CAAC;IAED,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,aAAa,CAAI,GAAM;IACtC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAM,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,GAAW;IACxC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,aAAa,CAAC,KAAc,EAAE,SAAkB;IAC/D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAClC,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,GAAyB,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;YAC3D,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IACD,mEAAmE;IACnE,MAAM,YAAY,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAClD,MAAM,WAAW,GAAG,YAAY,KAAK,MAAM,CAAC,SAAS,CAAC;IACtD,IAAI,CAAC,WAAW,EAAE,CAAC;QAClB,OAAO,CAAC,KAAK;QACZ,wEAAwE;QACxE,6BAA6B,SAAS,IAAI,MAAM,KAAK,MAAM,CAAC,YAAY,CAAC,EAAE,CAC3E,CAAC;QACF,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAmBD,SAAgB,kBAAkB,CACjC,MAAe,EACf,KAAkB;IAElB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;QACzD,4DAA4D;QAC5D,OAAQ,MAAuC,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AACD;;;;;GAKG;AACH,SAAS,QAAQ,CAAC,GAAY;IAC7B,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;AAClE,CAAC","sourcesContent":["import { dedupe } from \"./arrays.js\";\n\n/**\n * Deep merge two objects.\n *\n * @template T The type of the objects to merge.\n * @template U The type of the data object.\n * @param defaults The defaults object.\n * @param data The data object to merge into the defaults.\n * @returns The merged object.\n */\nexport function deepMerge<T extends object, U extends object>(\n\tdefaults: T,\n\tdata: U,\n): T & U {\n\tconst output = { ...defaults } as T & U;\n\n\tfor (const key in data) {\n\t\tif (Object.prototype.hasOwnProperty.call(data, key)) {\n\t\t\tconst dataValue = safeishGetProperty(data, key as keyof U);\n\t\t\tconst defaultsValue = safeishGetProperty(defaults as T & U, key);\n\n\t\t\tif (isObject(dataValue) && isObject(defaultsValue)) {\n\t\t\t\toutput[key] = deepMerge(defaultsValue, dataValue);\n\t\t\t} else if (Array.isArray(dataValue) && Array.isArray(defaultsValue)) {\n\t\t\t\t(output as any)[key] = dedupe([...defaultsValue, ...dataValue]);\n\t\t\t} else {\n\t\t\t\t(output as any)[key] = dataValue;\n\t\t\t}\n\t\t}\n\t}\n\n\treturn output;\n}\n\n/**\n * Removes any unserializable objects from the object.\n *\n * @template T The type of the object.\n * @param obj The object to flatten.\n * @returns The flattened object.\n */\nexport function flattenObject<T>(obj: T): T {\n\treturn JSON.parse(JSON.stringify(obj)) as T;\n}\n\n/**\n * Determines if an object is empty.\n *\n * @param obj The object to check.\n * @returns True if the object is empty.\n */\nexport function isEmptyObject(obj: object): boolean {\n\treturn Object.keys(obj).length === 0;\n}\n\n/**\n * Test if a value is a plain object for RSC purposes.\n *\n * @param value The value to check.\n * @param parentKey The nested key being checked.\n * @returns True if the object is deemed passable to a client component.\n */\nexport function isPlainObject(value: unknown, parentKey?: string): boolean {\n\tif (!isObject(value)) return true;\n\tfor (const key in value) {\n\t\tif (!isPlainObject(value[key as keyof typeof value], key)) {\n\t\t\treturn false;\n\t\t}\n\t}\n\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\tconst ownPrototype = Object.getPrototypeOf(value);\n\tconst isSelfPlain = ownPrototype === Object.prototype;\n\tif (!isSelfPlain) {\n\t\tconsole.error(\n\t\t\t// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing\n\t\t\t`Non-plain object found at ${parentKey || \"root\"}: ${String(ownPrototype)}`,\n\t\t);\n\t\treturn false;\n\t}\n\treturn true;\n}\n\n/**\n * Checks that the field exists on the object itself before getting it.\n *\n * @template TParent The type of the object.\n * @template TField The key of the of the object.\n * @param object The object to get the property from.\n * @param field The field to get.\n * @returns The value of the field, or undefined if it does not exist.\n */\nexport function safeishGetProperty<\n\tTParent extends object,\n\tTField extends keyof TParent,\n>(object: TParent, field: TField): TParent[TField];\nexport function safeishGetProperty<TParent extends object>(\n\tobject: TParent,\n\tfield: PropertyKey,\n): unknown;\nexport function safeishGetProperty<TParent extends object>(\n\tobject: TParent,\n\tfield: PropertyKey,\n): unknown {\n\tif (Object.prototype.hasOwnProperty.call(object, field)) {\n\t\t// eslint-disable-next-line security/detect-object-injection\n\t\treturn (object as Record<PropertyKey, unknown>)[field];\n\t}\n\treturn undefined;\n}\n/**\n * Check if a value is an object.\n *\n * @param obj The value to check.\n * @returns True if the value is an object.\n */\nfunction isObject(obj: unknown): obj is Record<PropertyKey, unknown> {\n\treturn !!(obj && typeof obj === \"object\" && !Array.isArray(obj));\n}\n"]}

package/dist/cjs/general/sorting.cjs

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compareForSort = compareForSort;
+exports.compareForSortByField = compareForSortByField;
+exports.sortOnField = sortOnField;
+const objects_js_1 = require("./objects.cjs");
+/**
+ * Compare two values for sorting
+ *
+ * @param aValue The first value to compare
+ * @param bValue The second value to compare
+ * @param ascending Whether to sort ascending
+ * @returns The sort order
+ * @throws {TypeError} An error if the types are not supported
+ */
+function compareForSort(aValue, bValue, ascending = true) {
+    let diff = 0;
+    if (aValue && !bValue) {
+        diff = 1;
+    }
+    else if (!aValue && bValue) {
+        diff = -1;
+    }
+    else if (aValue || bValue) {
+        if (typeof aValue === "string" && typeof bValue === "string") {
+            diff = aValue.localeCompare(bValue);
+        }
+        else if (typeof aValue === "number" && typeof bValue === "number") {
+            diff = aValue - bValue;
+        }
+        else if (aValue instanceof Date && bValue instanceof Date) {
+            diff = aValue.getTime() - bValue.getTime();
+        }
+        else if (typeof aValue !== "boolean" || typeof bValue !== "boolean") {
+            throw new TypeError(`Unsupported types for sorting: A type: "${typeof aValue}" A Value: "${String(aValue)}" B Type: "${typeof bValue}" && B Value: "${String(bValue)}"`);
+        }
+    }
+    if (ascending) {
+        return diff;
+    }
+    return Object.is(-diff, -0) ? 0 : -diff;
+}
+/**
+ * Compare two objects for sorting by a field
+ *
+ * @template T The type of the objects
+ * @param a The first object to compare
+ * @param b The second object to compare
+ * @param field The field to compare by
+ * @param ascending Whether to sort ascending
+ * @returns The sort order
+ */
+function compareForSortByField(a, b, field, ascending = true) {
+    const valueA = (0, objects_js_1.safeishGetProperty)(a, field);
+    const valueB = (0, objects_js_1.safeishGetProperty)(b, field);
+    return compareForSort(valueA, valueB, ascending);
+}
+/**
+ * Sort an array of objects by a field
+ *
+ * @template T The type of the objects
+ * @param rows The rows to sort
+ * @param field The field to sort by
+ * @param ascending Whether to sort ascending
+ * @returns The sorted rows
+ */
+function sortOnField(rows, field, ascending = true) {
+    return rows
+        .slice()
+        .sort((a, b) => compareForSortByField(a, b, field, ascending));
+}
+//# sourceMappingURL=sorting.js.map

package/dist/cjs/general/sorting.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Compare two values for sorting
+ *
+ * @param aValue The first value to compare
+ * @param bValue The second value to compare
+ * @param ascending Whether to sort ascending
+ * @returns The sort order
+ * @throws {TypeError} An error if the types are not supported
+ */
+export declare function compareForSort(aValue: unknown, bValue: unknown, ascending?: boolean): number;
+/**
+ * Compare two objects for sorting by a field
+ *
+ * @template T The type of the objects
+ * @param a The first object to compare
+ * @param b The second object to compare
+ * @param field The field to compare by
+ * @param ascending Whether to sort ascending
+ * @returns The sort order
+ */
+export declare function compareForSortByField<T extends object>(a: T, b: T, field: keyof T & string, ascending?: boolean): number;
+/**
+ * Sort an array of objects by a field
+ *
+ * @template T The type of the objects
+ * @param rows The rows to sort
+ * @param field The field to sort by
+ * @param ascending Whether to sort ascending
+ * @returns The sorted rows
+ */
+export declare function sortOnField<T extends object>(rows: T[], field: keyof T & string, ascending?: boolean): T[];
+//# sourceMappingURL=sorting.d.ts.map

package/dist/cjs/general/sorting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sorting.d.ts","sourceRoot":"","sources":["../../../src/general/sorting.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC7B,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,EACf,SAAS,UAAO,GACd,MAAM,CAwBR;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,MAAM,EACrD,CAAC,EAAE,CAAC,EACJ,CAAC,EAAE,CAAC,EACJ,KAAK,EAAE,MAAM,CAAC,GAAG,MAAM,EACvB,SAAS,UAAO,GACd,MAAM,CAIR;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAC3C,IAAI,EAAE,CAAC,EAAE,EACT,KAAK,EAAE,MAAM,CAAC,GAAG,MAAM,EACvB,SAAS,UAAO,GACd,CAAC,EAAE,CAIL"}

package/dist/cjs/general/sorting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sorting.js","sourceRoot":"","sources":["../../../src/general/sorting.ts"],"names":[],"mappings":";;AAWA,wCA4BC;AAYD,sDASC;AAWD,kCAQC;AA/ED,6CAAkD;AAElD;;;;;;;;GAQG;AACH,SAAgB,cAAc,CAC7B,MAAe,EACf,MAAe,EACf,SAAS,GAAG,IAAI;IAEhB,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACvB,IAAI,GAAG,CAAC,CAAC;IACV,CAAC;SAAM,IAAI,CAAC,MAAM,IAAI,MAAM,EAAE,CAAC;QAC9B,IAAI,GAAG,CAAC,CAAC,CAAC;IACX,CAAC;SAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;QAC7B,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC9D,IAAI,GAAG,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;aAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACrE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAC;QACxB,CAAC;aAAM,IAAI,MAAM,YAAY,IAAI,IAAI,MAAM,YAAY,IAAI,EAAE,CAAC;YAC7D,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC5C,CAAC;aAAM,IAAI,OAAO,MAAM,KAAK,SAAS,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE,CAAC;YACvE,MAAM,IAAI,SAAS,CAClB,2CAA2C,OAAO,MAAM,eAAe,MAAM,CAAC,MAAM,CAAC,cAAc,OAAO,MAAM,kBAAkB,MAAM,CAAC,MAAM,CAAC,GAAG,CACnJ,CAAC;QACH,CAAC;IACF,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACb,CAAC;IACD,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACzC,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,qBAAqB,CACpC,CAAI,EACJ,CAAI,EACJ,KAAuB,EACvB,SAAS,GAAG,IAAI;IAEhB,MAAM,MAAM,GAAG,IAAA,+BAAkB,EAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,IAAA,+BAAkB,EAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5C,OAAO,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAClD,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,WAAW,CAC1B,IAAS,EACT,KAAuB,EACvB,SAAS,GAAG,IAAI;IAEhB,OAAO,IAAI;SACT,KAAK,EAAE;SACP,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;AACjE,CAAC","sourcesContent":["import { safeishGetProperty } from \"./objects.js\";\n\n/**\n * Compare two values for sorting\n *\n * @param aValue The first value to compare\n * @param bValue The second value to compare\n * @param ascending Whether to sort ascending\n * @returns The sort order\n * @throws {TypeError} An error if the types are not supported\n */\nexport function compareForSort(\n\taValue: unknown,\n\tbValue: unknown,\n\tascending = true,\n): number {\n\tlet diff = 0;\n\tif (aValue && !bValue) {\n\t\tdiff = 1;\n\t} else if (!aValue && bValue) {\n\t\tdiff = -1;\n\t} else if (aValue || bValue) {\n\t\tif (typeof aValue === \"string\" && typeof bValue === \"string\") {\n\t\t\tdiff = aValue.localeCompare(bValue);\n\t\t} else if (typeof aValue === \"number\" && typeof bValue === \"number\") {\n\t\t\tdiff = aValue - bValue;\n\t\t} else if (aValue instanceof Date && bValue instanceof Date) {\n\t\t\tdiff = aValue.getTime() - bValue.getTime();\n\t\t} else if (typeof aValue !== \"boolean\" || typeof bValue !== \"boolean\") {\n\t\t\tthrow new TypeError(\n\t\t\t\t`Unsupported types for sorting: A type: \"${typeof aValue}\" A Value: \"${String(aValue)}\" B Type: \"${typeof bValue}\" && B Value: \"${String(bValue)}\"`,\n\t\t\t);\n\t\t}\n\t}\n\n\tif (ascending) {\n\t\treturn diff;\n\t}\n\treturn Object.is(-diff, -0) ? 0 : -diff;\n}\n\n/**\n * Compare two objects for sorting by a field\n *\n * @template T The type of the objects\n * @param a The first object to compare\n * @param b The second object to compare\n * @param field The field to compare by\n * @param ascending Whether to sort ascending\n * @returns The sort order\n */\nexport function compareForSortByField<T extends object>(\n\ta: T,\n\tb: T,\n\tfield: keyof T & string,\n\tascending = true,\n): number {\n\tconst valueA = safeishGetProperty(a, field);\n\tconst valueB = safeishGetProperty(b, field);\n\treturn compareForSort(valueA, valueB, ascending);\n}\n\n/**\n * Sort an array of objects by a field\n *\n * @template T The type of the objects\n * @param rows The rows to sort\n * @param field The field to sort by\n * @param ascending Whether to sort ascending\n * @returns The sorted rows\n */\nexport function sortOnField<T extends object>(\n\trows: T[],\n\tfield: keyof T & string,\n\tascending = true,\n): T[] {\n\treturn rows\n\t\t.slice()\n\t\t.sort((a, b) => compareForSortByField(a, b, field, ascending));\n}\n"]}

package/dist/cjs/general/string.cjs

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.capitalizeString = capitalizeString;
+exports.decodeHTMLEntities = decodeHTMLEntities;
+exports.toTitleCase = toTitleCase;
+const namedEntities_js_1 = require("./namedEntities.cjs");
+/**
+ * Capitalizes a string.
+ *
+ * @example
+ * 	const str = capitalizeString("hello world!");
+ * 	console.log(str);
+ * 	// Hello world!
+ *
+ * @param str The string to capitalize.
+ * @returns The capitalized string.
+ */
+function capitalizeString(str) {
+    return (str[0] ?? "").toUpperCase() + str.slice(1);
+}
+/**
+ * Decode HTML entities in a string.
+ *
+ * @example
+ * 	decodeHTMLEntities("That's cool!"); // => "That's cool!"
+ * 	decodeHTMLEntities("&lt;div&gt;"); // => "<div>" Note that this should be used with caution, as it can be a security risk.
+ *
+ * @param string The string to decode
+ * @returns The decoded string
+ */
+function decodeHTMLEntities(string) {
+    let str = string.replace(/&#(\d+);/g, (_, dec) => {
+        return String.fromCharCode(dec);
+    });
+    for (const [key, value] of Object.entries(namedEntities_js_1.namedEntities)) {
+        // From an internal source.
+        // eslint-disable-next-line security/detect-non-literal-regexp
+        str = str.replace(new RegExp(`&${key};`, "g"), value);
+    }
+    return str;
+}
+/**
+ * Converts a string to title-case.
+ *
+ * @param string The text to convert to title-case
+ * @returns The text in title-case
+ */
+function toTitleCase(string) {
+    if (string.length === 0) {
+        return string;
+    }
+    return handleSplitter(handleSplitter(string.toLowerCase(), " "), "\n");
+}
+/**
+ * Converts a string to sentence-case, for a given splitter.
+ *
+ * @param string The text to convert to sentence-case
+ * @param splitter The character to split the string by
+ * @returns The text in sentence-case
+ */
+function handleSplitter(string, splitter) {
+    const sentence = string.split(splitter);
+    for (let i = 0; i < sentence.length; i++) {
+        // eslint-disable-next-line security/detect-object-injection
+        if (!sentence[i]?.length) {
+            continue;
+        }
+        // eslint-disable-next-line security/detect-object-injection, @typescript-eslint/no-non-null-assertion
+        sentence[i] = capitalizeString(sentence[i]);
+    }
+    return sentence.join(splitter);
+}
+//# sourceMappingURL=string.js.map

package/dist/cjs/general/string.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Capitalizes a string.
+ *
+ * @example
+ * 	const str = capitalizeString("hello world!");
+ * 	console.log(str);
+ * 	// Hello world!
+ *
+ * @param str The string to capitalize.
+ * @returns The capitalized string.
+ */
+export declare function capitalizeString(str: string): string;
+/**
+ * Decode HTML entities in a string.
+ *
+ * @example
+ * 	decodeHTMLEntities("That's cool!"); // => "That's cool!"
+ * 	decodeHTMLEntities("&lt;div&gt;"); // => "<div>" Note that this should be used with caution, as it can be a security risk.
+ *
+ * @param string The string to decode
+ * @returns The decoded string
+ */
+export declare function decodeHTMLEntities(string: string): string;
+/**
+ * Converts a string to title-case.
+ *
+ * @param string The text to convert to title-case
+ * @returns The text in title-case
+ */
+export declare function toTitleCase(string: string): string;
+//# sourceMappingURL=string.d.ts.map

package/dist/cjs/general/string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../src/general/string.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAUzD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAKlD"}

package/dist/cjs/general/string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../src/general/string.ts"],"names":[],"mappings":";;AAaA,4CAEC;AAYD,gDAUC;AAQD,kCAKC;AAlDD,yDAAmD;AAEnD;;;;;;;;;;GAUG;AACH,SAAgB,gBAAgB,CAAC,GAAW;IAC3C,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,kBAAkB,CAAC,MAAc;IAChD,IAAI,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,GAAW,EAAE,EAAE;QACxD,OAAO,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IACH,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,gCAAa,CAAC,EAAE,CAAC;QAC1D,2BAA2B;QAC3B,8DAA8D;QAC9D,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,GAAG,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,MAAc;IACzC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC;IACf,CAAC;IACD,OAAO,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;AACxE,CAAC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,MAAc,EAAE,QAAgB;IACvD,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1C,4DAA4D;QAC5D,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;YAC1B,SAAS;QACV,CAAC;QACD,sGAAsG;QACtG,QAAQ,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAE,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAChC,CAAC","sourcesContent":["import { namedEntities } from \"./namedEntities.js\";\n\n/**\n * Capitalizes a string.\n *\n * @example\n * \tconst str = capitalizeString(\"hello world!\");\n * \tconsole.log(str);\n * \t// Hello world!\n *\n * @param str The string to capitalize.\n * @returns The capitalized string.\n */\nexport function capitalizeString(str: string): string {\n\treturn (str[0] ?? \"\").toUpperCase() + str.slice(1);\n}\n\n/**\n * Decode HTML entities in a string.\n *\n * @example\n * \tdecodeHTMLEntities(\"That&#39;s cool!\"); // => \"That's cool!\"\n * \tdecodeHTMLEntities(\"&lt;div&gt;\"); // => \"<div>\" Note that this should be used with caution, as it can be a security risk.\n *\n * @param string The string to decode\n * @returns The decoded string\n */\nexport function decodeHTMLEntities(string: string): string {\n\tlet str = string.replace(/&#(\\d+);/g, (_, dec: number) => {\n\t\treturn String.fromCharCode(dec);\n\t});\n\tfor (const [key, value] of Object.entries(namedEntities)) {\n\t\t// From an internal source.\n\t\t// eslint-disable-next-line security/detect-non-literal-regexp\n\t\tstr = str.replace(new RegExp(`&${key};`, \"g\"), value);\n\t}\n\treturn str;\n}\n\n/**\n * Converts a string to title-case.\n *\n * @param string The text to convert to title-case\n * @returns The text in title-case\n */\nexport function toTitleCase(string: string): string {\n\tif (string.length === 0) {\n\t\treturn string;\n\t}\n\treturn handleSplitter(handleSplitter(string.toLowerCase(), \" \"), \"\\n\");\n}\n\n/**\n * Converts a string to sentence-case, for a given splitter.\n *\n * @param string The text to convert to sentence-case\n * @param splitter The character to split the string by\n * @returns The text in sentence-case\n */\nfunction handleSplitter(string: string, splitter: string) {\n\tconst sentence = string.split(splitter);\n\tfor (let i = 0; i < sentence.length; i++) {\n\t\t// eslint-disable-next-line security/detect-object-injection\n\t\tif (!sentence[i]?.length) {\n\t\t\tcontinue;\n\t\t}\n\t\t// eslint-disable-next-line security/detect-object-injection, @typescript-eslint/no-non-null-assertion\n\t\tsentence[i] = capitalizeString(sentence[i]!);\n\t}\n\treturn sentence.join(splitter);\n}\n"]}

package/dist/cjs/general/timeout.cjs

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitForTimeout = waitForTimeout;
+/**
+ * Wait for a set amount of time.
+ *
+ * @param timeout The amount of time to wait.
+ * @returns A promise that resolves after the timeout.
+ */
+function waitForTimeout(timeout) {
+    return new Promise((resolve) => {
+        setTimeout(() => {
+            resolve(true);
+        }, timeout);
+    });
+}
+//# sourceMappingURL=timeout.js.map

package/dist/cjs/general/timeout.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Wait for a set amount of time.
+ *
+ * @param timeout The amount of time to wait.
+ * @returns A promise that resolves after the timeout.
+ */
+export declare function waitForTimeout(timeout: number): Promise<true>;
+//# sourceMappingURL=timeout.d.ts.map

package/dist/cjs/general/timeout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeout.d.ts","sourceRoot":"","sources":["../../../src/general/timeout.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAM7D"}

package/dist/cjs/general/timeout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeout.js","sourceRoot":"","sources":["../../../src/general/timeout.ts"],"names":[],"mappings":";;AAMA,wCAMC;AAZD;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,OAAe;IAC7C,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;QACpC,UAAU,CAAC,GAAG,EAAE;YACf,OAAO,CAAC,IAAI,CAAC,CAAC;QACf,CAAC,EAAE,OAAO,CAAC,CAAC;IACb,CAAC,CAAC,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Wait for a set amount of time.\n *\n * @param timeout The amount of time to wait.\n * @returns A promise that resolves after the timeout.\n */\nexport function waitForTimeout(timeout: number): Promise<true> {\n\treturn new Promise<true>((resolve) => {\n\t\tsetTimeout(() => {\n\t\t\tresolve(true);\n\t\t}, timeout);\n\t});\n}\n"]}

package/dist/cjs/index.cjs

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./browser/index.cjs"), exports);
+__exportStar(require("./general/index.cjs"), exports);
+__exportStar(require("./node/index.cjs"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./browser/index.js";
+export * from "./general/index.js";
+export * from "./node/index.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC"}

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AACnC,qDAAmC;AACnC,kDAAgC","sourcesContent":["export * from \"./browser/index.js\";\nexport * from \"./general/index.js\";\nexport * from \"./node/index.js\";\n"]}

package/dist/cjs/node/index.cjs

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkEnvironmentVariables = checkEnvironmentVariables;
+const objects_js_1 = require("../general/objects.cjs");
+/**
+ * Checks if the expected environment variables are set.
+ *
+ * @template TKey An expected environment key.
+ * @param expected The expected environment variables.
+ * @returns A key, value set of the environment variables requested for
+ *   validation.
+ * @throws {TypeError} If an expected environment variable hasn't been set.
+ */
+function checkEnvironmentVariables(expected) {
+    const env = process.env.NODE_ENV;
+    const result = {};
+    for (const variable of expected) {
+        const key = (typeof variable === "string" ? variable : variable.name);
+        const value = (0, objects_js_1.safeishGetProperty)(process.env, key);
+        if (!value) {
+            const message = typeof variable === "string"
+                ? `Environment variable ${variable} is not set in ${String(env)} environment`
+                : variable.message;
+            throw new TypeError(message);
+        }
+        result[key] = value;
+    }
+    return result;
+}
+//# sourceMappingURL=index.js.map

package/dist/cjs/node/index.d.ts

@@ -0,0 +1,25 @@
+export type ExpectedEnvironmentSuccess<TKey extends string> = Record<ExtractVariableNames<ExpectedEnvironmentVariables<TKey>>, string>;
+/**
+ * The expected environment variables.
+ *
+ * @template TKey An expected environment key.
+ */
+export type ExpectedEnvironmentVariables<TKey extends string> = TKey[] | {
+    message: string;
+    name: TKey;
+}[];
+type ExtractVariableNames<T extends ExpectedEnvironmentVariables<string>> = T extends string[] ? T[number] : T extends {
+    name: infer N;
+}[] ? N extends string ? N : never : never;
+/**
+ * Checks if the expected environment variables are set.
+ *
+ * @template TKey An expected environment key.
+ * @param expected The expected environment variables.
+ * @returns A key, value set of the environment variables requested for
+ *   validation.
+ * @throws {TypeError} If an expected environment variable hasn't been set.
+ */
+export declare function checkEnvironmentVariables<TKey extends string>(expected: ExpectedEnvironmentVariables<TKey>): ExpectedEnvironmentSuccess<TKey>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/node/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/node/index.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,0BAA0B,CAAC,IAAI,SAAS,MAAM,IAAI,MAAM,CACnE,oBAAoB,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC,EACxD,MAAM,CACN,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,CAAC,IAAI,SAAS,MAAM,IACzD,IAAI,EAAE,GACN;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,IAAI,CAAA;CAAE,EAAE,CAAC;AAErC,KAAK,oBAAoB,CAAC,CAAC,SAAS,4BAA4B,CAAC,MAAM,CAAC,IACvE,CAAC,SAAS,MAAM,EAAE,GACf,CAAC,CAAC,MAAM,CAAC,GACT,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC,CAAA;CAAE,EAAE,GAC5B,CAAC,SAAS,MAAM,GACf,CAAC,GACD,KAAK,GACN,KAAK,CAAC;AACX;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,SAAS,MAAM,EAC5D,QAAQ,EAAE,4BAA4B,CAAC,IAAI,CAAC,GAC1C,0BAA0B,CAAC,IAAI,CAAC,CAkBlC"}

package/dist/cjs/node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/node/index.ts"],"names":[],"mappings":";;AAiCA,8DAoBC;AArDD,sDAA2D;AAwB3D;;;;;;;;GAQG;AACH,SAAgB,yBAAyB,CACxC,QAA4C;IAE5C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;IACjC,MAAM,MAAM,GAA8C,EAAE,CAAC;IAC7D,KAAK,MAAM,QAAQ,IAAI,QAAQ,EAAE,CAAC;QACjC,MAAM,GAAG,GAAG,CACX,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CACd,CAAC;QAC3C,MAAM,KAAK,GAAG,IAAA,+BAAkB,EAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACnD,IAAI,CAAC,KAAK,EAAE,CAAC;YACZ,MAAM,OAAO,GACZ,OAAO,QAAQ,KAAK,QAAQ;gBAC3B,CAAC,CAAC,wBAAwB,QAAQ,kBAAkB,MAAM,CAAC,GAAG,CAAC,cAAc;gBAC7E,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;YACrB,MAAM,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACrB,CAAC;IACD,OAAO,MAA0C,CAAC;AACnD,CAAC","sourcesContent":["import { safeishGetProperty } from \"../general/objects.js\";\n\nexport type ExpectedEnvironmentSuccess<TKey extends string> = Record<\n\tExtractVariableNames<ExpectedEnvironmentVariables<TKey>>,\n\tstring\n>;\n\n/**\n * The expected environment variables.\n *\n * @template TKey An expected environment key.\n */\nexport type ExpectedEnvironmentVariables<TKey extends string> =\n\t| TKey[]\n\t| { message: string; name: TKey }[];\n\ntype ExtractVariableNames<T extends ExpectedEnvironmentVariables<string>> =\n\tT extends string[]\n\t\t? T[number]\n\t\t: T extends { name: infer N }[]\n\t\t\t? N extends string\n\t\t\t\t? N\n\t\t\t\t: never\n\t\t\t: never;\n/**\n * Checks if the expected environment variables are set.\n *\n * @template TKey An expected environment key.\n * @param expected The expected environment variables.\n * @returns A key, value set of the environment variables requested for\n *   validation.\n * @throws {TypeError} If an expected environment variable hasn't been set.\n */\nexport function checkEnvironmentVariables<TKey extends string>(\n\texpected: ExpectedEnvironmentVariables<TKey>,\n): ExpectedEnvironmentSuccess<TKey> {\n\tconst env = process.env.NODE_ENV;\n\tconst result: Partial<ExpectedEnvironmentSuccess<TKey>> = {};\n\tfor (const variable of expected) {\n\t\tconst key = (\n\t\t\ttypeof variable === \"string\" ? variable : variable.name\n\t\t) as ExtractVariableNames<typeof expected>;\n\t\tconst value = safeishGetProperty(process.env, key);\n\t\tif (!value) {\n\t\t\tconst message =\n\t\t\t\ttypeof variable === \"string\"\n\t\t\t\t\t? `Environment variable ${variable} is not set in ${String(env)} environment`\n\t\t\t\t\t: variable.message;\n\t\t\tthrow new TypeError(message);\n\t\t}\n\t\tresult[key] = value;\n\t}\n\treturn result as ExpectedEnvironmentSuccess<TKey>;\n}\n"]}