@alextheman/utility 5.7.1 → 5.9.0

package/dist/index.cjs

@@ -23,8 +23,6 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 //#endregion
 let zod = require("zod");
 zod = __toESM(zod);
-let libsodium_wrappers = require("libsodium-wrappers");
-libsodium_wrappers = __toESM(libsodium_wrappers);
 //#region src/root/constants/FILE_PATH_REGEX.ts
 const FILE_PATH_PATTERN = String.raw`(?<directory>.+)[\/\\](?<base>[^\/\\]+)`;
 const FILE_PATH_REGEX = RegExp(`^${FILE_PATH_PATTERN}$`);
@@ -1464,26 +1462,6 @@ function deepCopy(object) {
 	return clonedObject;
 }
 //#endregion
-//#region src/root/functions/security/encryptWithKey.ts
-/**
-* Encrypt a secret given the public base64 key and the thing you want to encrypt.
-*
-* @param publicKey - The public base64 key to encrypt with.
-* @param plaintextValue - The value to encrypt in plaintext.
-*
-* @returns The encrypted string. This value will be different on repeat calls, but the result should always decrypt to the initial `plaintextValue` argument.
-*/
-async function encryptWithKey(publicKey, plaintextValue) {
-	try {
-		await libsodium_wrappers.default.ready;
-		const base64Key = libsodium_wrappers.default.from_base64(publicKey, libsodium_wrappers.default.base64_variants.ORIGINAL);
-		const encryptedValue = libsodium_wrappers.default.crypto_box_seal(plaintextValue, base64Key);
-		return libsodium_wrappers.default.to_base64(encryptedValue, libsodium_wrappers.default.base64_variants.ORIGINAL);
-	} catch {
-		throw new DataError({ publicKey }, "ENCRYPTION_FAILED", "Encryption failed. Please double-check that the given key is a valid base 64 string.");
-	}
-}
-//#endregion
 //#region src/root/functions/stringHelpers/appendSemicolon.ts
 /**
 * Appends a semicolon to the end of a string, trimming where necessary first.
@@ -1541,6 +1519,18 @@ function camelToKebab(string, options = { preserveConsecutiveCapitals: true }) {
 	return result;
 }
 //#endregion
+//#region src/root/functions/stringHelpers/escapeRegexPattern.ts
+/**
+* A function to properly handle escape sequences in a Regex pattern string, so it can be safely used with the `RegExp` constructor.
+*
+* @param regexPattern - The Regex pattern to escape.
+*
+* @returns A new string with escape sequences properly handled.
+*/
+function escapeRegexPattern(regexPattern) {
+	return regexPattern.replace(/[.*+?^${}()|[\]\\/]/g, "\\$&");
+}
+//#endregion
 //#region src/root/functions/stringHelpers/kebabToCamel.ts
 /**
 * Converts a string from kebab-case to camelCase
@@ -1616,7 +1606,7 @@ exports.createFormData = createFormData;
 exports.createTemplateStringsArray = createTemplateStringsArray;
 exports.deepCopy = deepCopy;
 exports.deepFreeze = deepFreeze;
-exports.encryptWithKey = encryptWithKey;
+exports.escapeRegexPattern = escapeRegexPattern;
 exports.fillArray = fillArray;
 exports.formatDateAndTime = formatDateAndTime;
 exports.getRandomNumber = getRandomNumber;

package/dist/index.d.cts

@@ -865,17 +865,6 @@ declare function deepCopy<ObjectType extends object>(object: ObjectType): Object
  */
 declare function deepFreeze<ObjectType extends object>(object: ObjectType): Readonly<ObjectType>;
 //#endregion
-//#region src/root/functions/security/encryptWithKey.d.ts
-/**
- * Encrypt a secret given the public base64 key and the thing you want to encrypt.
- *
- * @param publicKey - The public base64 key to encrypt with.
- * @param plaintextValue - The value to encrypt in plaintext.
- *
- * @returns The encrypted string. This value will be different on repeat calls, but the result should always decrypt to the initial `plaintextValue` argument.
- */
-declare function encryptWithKey(publicKey: string, plaintextValue: string): Promise<string>;
-//#endregion
 //#region src/root/functions/stringHelpers/appendSemicolon.d.ts
 /**
  * Appends a semicolon to the end of a string, trimming where necessary first.
@@ -912,6 +901,16 @@ interface CamelToKebabOptions {
  */
 declare function camelToKebab(string: string, options?: CamelToKebabOptions): string;
 //#endregion
+//#region src/root/functions/stringHelpers/escapeRegexPattern.d.ts
+/**
+ * A function to properly handle escape sequences in a Regex pattern string, so it can be safely used with the `RegExp` constructor.
+ *
+ * @param regexPattern - The Regex pattern to escape.
+ *
+ * @returns A new string with escape sequences properly handled.
+ */
+declare function escapeRegexPattern(regexPattern: string): string;
+//#endregion
 //#region src/root/functions/stringHelpers/kebabToCamel.d.ts
 /**
  * Options to apply to the conversion from kebab-case to camelCase
@@ -1125,4 +1124,4 @@ declare const normalizeIndents: typeof normaliseIndents;
  */
 type RecordKey = string | number | symbol;
 //#endregion
-export { APIError, type ArrayElement, type CallReturnType, CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, KebabToCamelOptions, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, type StringListToArrayOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };
+export { APIError, type ArrayElement, type CallReturnType, CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, KebabToCamelOptions, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, type StringListToArrayOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };

package/dist/index.d.ts

@@ -865,17 +865,6 @@ declare function deepCopy<ObjectType extends object>(object: ObjectType): Object
  */
 declare function deepFreeze<ObjectType extends object>(object: ObjectType): Readonly<ObjectType>;
 //#endregion
-//#region src/root/functions/security/encryptWithKey.d.ts
-/**
- * Encrypt a secret given the public base64 key and the thing you want to encrypt.
- *
- * @param publicKey - The public base64 key to encrypt with.
- * @param plaintextValue - The value to encrypt in plaintext.
- *
- * @returns The encrypted string. This value will be different on repeat calls, but the result should always decrypt to the initial `plaintextValue` argument.
- */
-declare function encryptWithKey(publicKey: string, plaintextValue: string): Promise<string>;
-//#endregion
 //#region src/root/functions/stringHelpers/appendSemicolon.d.ts
 /**
  * Appends a semicolon to the end of a string, trimming where necessary first.
@@ -912,6 +901,16 @@ interface CamelToKebabOptions {
  */
 declare function camelToKebab(string: string, options?: CamelToKebabOptions): string;
 //#endregion
+//#region src/root/functions/stringHelpers/escapeRegexPattern.d.ts
+/**
+ * A function to properly handle escape sequences in a Regex pattern string, so it can be safely used with the `RegExp` constructor.
+ *
+ * @param regexPattern - The Regex pattern to escape.
+ *
+ * @returns A new string with escape sequences properly handled.
+ */
+declare function escapeRegexPattern(regexPattern: string): string;
+//#endregion
 //#region src/root/functions/stringHelpers/kebabToCamel.d.ts
 /**
  * Options to apply to the conversion from kebab-case to camelCase
@@ -1125,4 +1124,4 @@ declare const normalizeIndents: typeof normaliseIndents;
  */
 type RecordKey = string | number | symbol;
 //#endregion
-export { APIError, type ArrayElement, type CallReturnType, CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, KebabToCamelOptions, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, type StringListToArrayOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };
+export { APIError, type ArrayElement, type CallReturnType, CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, KebabToCamelOptions, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, type StringListToArrayOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };

package/dist/index.js

@@ -1,5 +1,4 @@
 import z$1, { z } from "zod";
-import sodium from "libsodium-wrappers";
 //#region src/root/constants/FILE_PATH_REGEX.ts
 const FILE_PATH_PATTERN = String.raw`(?<directory>.+)[\/\\](?<base>[^\/\\]+)`;
 const FILE_PATH_REGEX = RegExp(`^${FILE_PATH_PATTERN}$`);
@@ -1439,26 +1438,6 @@ function deepCopy(object) {
 	return clonedObject;
 }
 //#endregion
-//#region src/root/functions/security/encryptWithKey.ts
-/**
-* Encrypt a secret given the public base64 key and the thing you want to encrypt.
-*
-* @param publicKey - The public base64 key to encrypt with.
-* @param plaintextValue - The value to encrypt in plaintext.
-*
-* @returns The encrypted string. This value will be different on repeat calls, but the result should always decrypt to the initial `plaintextValue` argument.
-*/
-async function encryptWithKey(publicKey, plaintextValue) {
-	try {
-		await sodium.ready;
-		const base64Key = sodium.from_base64(publicKey, sodium.base64_variants.ORIGINAL);
-		const encryptedValue = sodium.crypto_box_seal(plaintextValue, base64Key);
-		return sodium.to_base64(encryptedValue, sodium.base64_variants.ORIGINAL);
-	} catch {
-		throw new DataError({ publicKey }, "ENCRYPTION_FAILED", "Encryption failed. Please double-check that the given key is a valid base 64 string.");
-	}
-}
-//#endregion
 //#region src/root/functions/stringHelpers/appendSemicolon.ts
 /**
 * Appends a semicolon to the end of a string, trimming where necessary first.
@@ -1516,6 +1495,18 @@ function camelToKebab(string, options = { preserveConsecutiveCapitals: true }) {
 	return result;
 }
 //#endregion
+//#region src/root/functions/stringHelpers/escapeRegexPattern.ts
+/**
+* A function to properly handle escape sequences in a Regex pattern string, so it can be safely used with the `RegExp` constructor.
+*
+* @param regexPattern - The Regex pattern to escape.
+*
+* @returns A new string with escape sequences properly handled.
+*/
+function escapeRegexPattern(regexPattern) {
+	return regexPattern.replace(/[.*+?^${}()|[\]\\/]/g, "\\$&");
+}
+//#endregion
 //#region src/root/functions/stringHelpers/kebabToCamel.ts
 /**
 * Converts a string from kebab-case to camelCase
@@ -1570,4 +1561,4 @@ function truncate(stringToTruncate, maxLength = 5) {
 	return stringToTruncate.length > maxLength ? `${stringToTruncate.slice(0, maxLength)}...` : stringToTruncate;
 }
 //#endregion
-export { APIError, DataError, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, ONE_DAY_IN_MILLISECONDS, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, VersionType, addDaysToDate, appendSemicolon, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };
+export { APIError, DataError, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, ONE_DAY_IN_MILLISECONDS, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, VersionType, addDaysToDate, appendSemicolon, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };

package/dist/internal/index.cjs

@@ -23,7 +23,6 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 //#endregion
 let zod = require("zod");
 zod = __toESM(zod);
-require("libsodium-wrappers");
 let execa = require("execa");
 let node_fs_promises = require("node:fs/promises");
 let node_path = require("node:path");

package/dist/internal/index.js

@@ -1,5 +1,4 @@
 import z from "zod";
-import "libsodium-wrappers";
 import { execa } from "execa";
 import { readFile, writeFile } from "node:fs/promises";
 import path from "node:path";

package/dist/node/index.cjs

@@ -25,7 +25,8 @@ let node_path = require("node:path");
 node_path = __toESM(node_path);
 let zod = require("zod");
 zod = __toESM(zod);
-require("libsodium-wrappers");
+let libsodium_wrappers = require("libsodium-wrappers");
+libsodium_wrappers = __toESM(libsodium_wrappers);
 //#region src/node/functions/normalizeImportPath.ts
 /**
 * Normalizes an import path meant for use in an import statement in JavaScript.
@@ -655,6 +656,27 @@ function parseFilePath(filePath) {
 //#region src/node/functions/sayHello.ts
 var sayHello_default = sayHello;
 //#endregion
+//#region src/node/functions/security/encryptWithKey.ts
+/**
+* Encrypt a secret given the public base64 key and the thing you want to encrypt.
+*
+* @param publicKey - The public base64 key to encrypt with.
+* @param plaintextValue - The value to encrypt in plaintext.
+*
+* @returns The encrypted string. This value will be different on repeat calls, but the result should always decrypt to the initial `plaintextValue` argument.
+*/
+async function encryptWithKey(publicKey, plaintextValue) {
+	try {
+		await libsodium_wrappers.default.ready;
+		const base64Key = libsodium_wrappers.default.from_base64(publicKey, libsodium_wrappers.default.base64_variants.ORIGINAL);
+		const encryptedValue = libsodium_wrappers.default.crypto_box_seal(plaintextValue, base64Key);
+		return libsodium_wrappers.default.to_base64(encryptedValue, libsodium_wrappers.default.base64_variants.ORIGINAL);
+	} catch {
+		throw new DataError({ publicKey }, "ENCRYPTION_FAILED", "Encryption failed. Please double-check that the given key is a valid base 64 string.");
+	}
+}
+//#endregion
+exports.encryptWithKey = encryptWithKey;
 exports.normaliseImportPath = normaliseImportPath;
 exports.normalizeImportPath = normalizeImportPath;
 exports.parseFilePath = parseFilePath;

package/dist/node/index.d.cts

@@ -65,4 +65,15 @@ declare function sayHello(): string;
 //#region src/root/types/IsTypeArgumentString.d.ts
 type IsTypeArgumentString<Argument extends string> = Argument;
 //#endregion
-export { type IsTypeArgumentString, normaliseImportPath, normalizeImportPath, parseFilePath, sayHello };
+//#region src/node/functions/security/encryptWithKey.d.ts
+/**
+ * Encrypt a secret given the public base64 key and the thing you want to encrypt.
+ *
+ * @param publicKey - The public base64 key to encrypt with.
+ * @param plaintextValue - The value to encrypt in plaintext.
+ *
+ * @returns The encrypted string. This value will be different on repeat calls, but the result should always decrypt to the initial `plaintextValue` argument.
+ */
+declare function encryptWithKey(publicKey: string, plaintextValue: string): Promise<string>;
+//#endregion
+export { type IsTypeArgumentString, encryptWithKey, normaliseImportPath, normalizeImportPath, parseFilePath, sayHello };

package/dist/node/index.d.ts

@@ -66,4 +66,15 @@ declare function sayHello(): string;
 //#region src/root/types/IsTypeArgumentString.d.ts
 type IsTypeArgumentString<Argument extends string> = Argument;
 //#endregion
-export { type IsTypeArgumentString, normaliseImportPath, normalizeImportPath, parseFilePath, sayHello };
+//#region src/node/functions/security/encryptWithKey.d.ts
+/**
+ * Encrypt a secret given the public base64 key and the thing you want to encrypt.
+ *
+ * @param publicKey - The public base64 key to encrypt with.
+ * @param plaintextValue - The value to encrypt in plaintext.
+ *
+ * @returns The encrypted string. This value will be different on repeat calls, but the result should always decrypt to the initial `plaintextValue` argument.
+ */
+declare function encryptWithKey(publicKey: string, plaintextValue: string): Promise<string>;
+//#endregion
+export { type IsTypeArgumentString, encryptWithKey, normaliseImportPath, normalizeImportPath, parseFilePath, sayHello };

package/dist/node/index.js

@@ -1,6 +1,6 @@
 import path from "node:path";
 import z from "zod";
-import "libsodium-wrappers";
+import sodium from "libsodium-wrappers";
 //#region src/node/functions/normalizeImportPath.ts
 /**
 * Normalizes an import path meant for use in an import statement in JavaScript.
@@ -630,4 +630,24 @@ function parseFilePath(filePath) {
 //#region src/node/functions/sayHello.ts
 var sayHello_default = sayHello;
 //#endregion
-export { normaliseImportPath, normalizeImportPath, parseFilePath, sayHello_default as sayHello };
+//#region src/node/functions/security/encryptWithKey.ts
+/**
+* Encrypt a secret given the public base64 key and the thing you want to encrypt.
+*
+* @param publicKey - The public base64 key to encrypt with.
+* @param plaintextValue - The value to encrypt in plaintext.
+*
+* @returns The encrypted string. This value will be different on repeat calls, but the result should always decrypt to the initial `plaintextValue` argument.
+*/
+async function encryptWithKey(publicKey, plaintextValue) {
+	try {
+		await sodium.ready;
+		const base64Key = sodium.from_base64(publicKey, sodium.base64_variants.ORIGINAL);
+		const encryptedValue = sodium.crypto_box_seal(plaintextValue, base64Key);
+		return sodium.to_base64(encryptedValue, sodium.base64_variants.ORIGINAL);
+	} catch {
+		throw new DataError({ publicKey }, "ENCRYPTION_FAILED", "Encryption failed. Please double-check that the given key is a valid base 64 string.");
+	}
+}
+//#endregion
+export { encryptWithKey, normaliseImportPath, normalizeImportPath, parseFilePath, sayHello_default as sayHello };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "5.7.1",
+  "version": "5.9.0",
   "description": "Helpful utility functions.",
   "repository": {
     "type": "git",
@@ -36,7 +36,7 @@
     "zod": "^4.3.6"
   },
   "devDependencies": {
-    "@alextheman/eslint-plugin": "^5.10.2",
+    "@alextheman/eslint-plugin": "^5.10.4",
     "@types/node": "^25.5.0",
     "alex-c-line": "^2.4.0",
     "cross-env": "^10.1.0",
@@ -47,11 +47,11 @@
     "jsdom": "^29.0.1",
     "prettier": "^3.8.1",
     "tempy": "^3.2.0",
-    "tsdown": "^0.21.6",
+    "tsdown": "^0.21.7",
     "tsx": "^4.21.0",
     "typedoc": "^0.28.18",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.57.2",
+    "typescript": "^6.0.2",
+    "typescript-eslint": "^8.58.0",
     "vite-tsconfig-paths": "^6.1.1",
     "vitest": "^4.1.2"
   },
@@ -64,13 +64,13 @@
     "create-local-package": "pnpm run build && rm -f alextheman-utility-*.tgz && pnpm pack",
     "create-release-note": "bash -c 'git pull origin main && alex-c-line template release-note create $@' --",
     "format": "pnpm run format-prettier && pnpm run format-eslint",
-    "format-eslint": "eslint --fix --suppress-all \"package.json\" \"src/**/*.ts\" \"tests/**/*.ts\" \"configs/**/*.ts\" && rm -f eslint-suppressions.json",
+    "format-eslint": "eslint --fix --suppress-all \"package.json\" \"{src,tests,configs}/**/*.ts\" && rm -f eslint-suppressions.json",
     "format-prettier": "pnpm run format-prettier-typescript && pnpm run format-prettier-javascript && pnpm run format-prettier-yml",
     "format-prettier-javascript": "prettier --write \"./**/*.js\"",
     "format-prettier-typescript": "prettier --write --parser typescript \"./**/*.ts\"",
     "format-prettier-yml": "prettier --write \"./**/*.{yml,yaml}\"",
     "lint": "pnpm run lint-tsc && pnpm run lint-eslint && pnpm run lint-prettier && pnpm run lint-pre-release",
-    "lint-eslint": "eslint \"package.json\" \"src/**/*.ts\" \"tests/**/*.ts\" \"configs/**/*.ts\"",
+    "lint-eslint": "eslint \"package.json\" \"{src,tests,configs}/**/*.ts\"",
     "lint-pre-release": "alex-c-line package-json check --rules no-pre-release-dependencies",
     "lint-prettier": "pnpm run lint-prettier-typescript && pnpm run lint-prettier-javascript && pnpm run lint-prettier-yml",
     "lint-prettier-javascript": "prettier --check \"./**/*.js\"",