@alextheman/utility 5.7.0 → 5.8.0

package/LICENSE

@@ -1,4 +1,4 @@
-MIT License Copyright (c) 2025 AlexMan123456
+MIT License Copyright (c) 2026 alextheman231
 
 Permission is hereby granted, free
 of charge, to any person obtaining a copy of this software and associated
@@ -18,4 +18,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
 EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

package/README.md

@@ -35,6 +35,6 @@ const myVariable: NonUndefined<string> = formatDateAndTime(new Date());
 
 ## Documentation
 
-You can find the relevant documentation of all features of the package in the [docs/features/markdown](https://github.com/alextheman231/utility/tree/main/docs/features/markdown) directory of the repository. The hosted documentation site can be found [here](https://alextheman231.github.io/utility/).
+You can find the relevant documentation of all features of the package in the hosted documentation site [here](https://alextheman231.github.io/utility/).
 
 See the GitHub repository [here](https://github.com/alextheman231/utility).

package/dist/index.cjs

@@ -1541,6 +1541,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
@@ -1617,6 +1629,7 @@ 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

@@ -616,16 +616,6 @@ declare class VersionNumber {
 }
 declare const zodVersionNumber: z$1.ZodType<VersionNumber>;
 //#endregion
-//#region src/root/deprecated/RecordKey.d.ts
-/**
- * Represents the native Record's possible key type.
- *
- * @category Types
- *
- * @deprecated Please use the native `PropertyKey` type instead.
- */
-type RecordKey = string | number | symbol;
-//#endregion
 //#region src/root/types/ArrayElement.d.ts
 /**
  * Gets the individual element types from an array type.
@@ -922,6 +912,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 +1125,14 @@ declare function normaliseIndents(strings: TemplateStringsArray, ...interpolatio
  */
 declare const normalizeIndents: typeof normaliseIndents;
 //#endregion
-export { APIError, ArrayElement, CallReturnType, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IsTypeArgumentString, KebabToCamelOptions, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, NullableOnCondition, ONE_DAY_IN_MILLISECONDS, OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, StringListToArrayOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, 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 };
+//#region src/root/deprecated/RecordKey.d.ts
+/**
+ * Represents the native Record's possible key type.
+ *
+ * @category Types
+ *
+ * @deprecated Please use the native `PropertyKey` type instead.
+ */
+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, 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

@@ -616,16 +616,6 @@ declare class VersionNumber {
 }
 declare const zodVersionNumber: z$1.ZodType<VersionNumber>;
 //#endregion
-//#region src/root/deprecated/RecordKey.d.ts
-/**
- * Represents the native Record's possible key type.
- *
- * @category Types
- *
- * @deprecated Please use the native `PropertyKey` type instead.
- */
-type RecordKey = string | number | symbol;
-//#endregion
 //#region src/root/types/ArrayElement.d.ts
 /**
  * Gets the individual element types from an array type.
@@ -922,6 +912,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 +1125,14 @@ declare function normaliseIndents(strings: TemplateStringsArray, ...interpolatio
  */
 declare const normalizeIndents: typeof normaliseIndents;
 //#endregion
-export { APIError, type ArrayElement, type CallReturnType, CamelToKebabOptions, type CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, KebabToCamelOptions, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, ParallelTuple, type RecordKey, RemoveUndefined, 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 };
+//#region src/root/deprecated/RecordKey.d.ts
+/**
+ * Represents the native Record's possible key type.
+ *
+ * @category Types
+ *
+ * @deprecated Please use the native `PropertyKey` type instead.
+ */
+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, 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

@@ -1516,6 +1516,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 +1582,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, encryptWithKey, 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.d.ts

@@ -1,6 +1,5 @@
 import z from "zod";
 import { ExecaMethod } from "execa";
-
 //#region src/root/functions/miscellaneous/sayHello.d.ts
 /**
  * Returns a string representing the lyrics to the package's theme song, Commit To You

package/dist/node/index.d.cts

@@ -65,4 +65,4 @@ declare function sayHello(): string;
 //#region src/root/types/IsTypeArgumentString.d.ts
 type IsTypeArgumentString<Argument extends string> = Argument;
 //#endregion
-export { IsTypeArgumentString, normaliseImportPath, normalizeImportPath, parseFilePath, sayHello };
+export { type IsTypeArgumentString, normaliseImportPath, normalizeImportPath, parseFilePath, sayHello };

package/dist/node/index.d.ts

@@ -1,5 +1,4 @@
 import z from "zod";
-
 //#region src/node/functions/normalizeImportPath.d.ts
 /**
  * Normalizes an import path meant for use in an import statement in JavaScript.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "5.7.0",
+  "version": "5.8.0",
   "description": "Helpful utility functions.",
   "repository": {
     "type": "git",
@@ -38,7 +38,7 @@
   "devDependencies": {
     "@alextheman/eslint-plugin": "^5.10.2",
     "@types/node": "^25.5.0",
-    "alex-c-line": "^2.2.5",
+    "alex-c-line": "^2.4.0",
     "cross-env": "^10.1.0",
     "dotenv-cli": "^11.0.0",
     "eslint": "^10.1.0",
@@ -47,12 +47,13 @@
     "jsdom": "^29.0.1",
     "prettier": "^3.8.1",
     "tempy": "^3.2.0",
-    "tsdown": "^0.21.4",
+    "tsdown": "^0.21.6",
     "tsx": "^4.21.0",
-    "typedoc": "^0.28.17",
+    "typedoc": "^0.28.18",
     "typescript": "^5.9.3",
+    "typescript-eslint": "^8.57.2",
     "vite-tsconfig-paths": "^6.1.1",
-    "vitest": "^4.1.0"
+    "vitest": "^4.1.2"
   },
   "engines": {
     "node": ">=22.3.0"