@alextheman/utility 5.23.0 → 5.23.2

package/dist/index.cjs

@@ -1942,6 +1942,8 @@ function normaliseIndents(first, ...args) {
 *     and another new line`.
 * ```
 *
+* @category Tagged Template
+*
 * @param first - The strings from the template to process, or the options to apply.
 * @param args - An array of all interpolations from the template.
 *

package/dist/index.d.cts

@@ -1154,6 +1154,8 @@ declare function normaliseIndents(options: NormaliseIndentsOptions): NormaliseIn
  *     and another new line`;
  * ```
  *
+ * @category Tagged Template
+ *
  * @template InterpolationsType - The type of the interpolations.
  *
  * @param strings - The strings from the template to process.
@@ -1181,6 +1183,8 @@ declare function normaliseIndents(strings: TemplateStringsArray, ...interpolatio
  *     and another new line`.
  * ```
  *
+ * @category Tagged Template
+ *
  * @param first - The strings from the template to process, or the options to apply.
  * @param args - An array of all interpolations from the template.
  *

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import z$1, { ZodCoercedDate, ZodCoercedNumber, ZodError, ZodType, z } from "zod";
+import z, { ZodCoercedDate, ZodCoercedNumber, ZodError, ZodType, z as z$1 } from "zod";
 import { DotenvParseOutput } from "dotenv";
 
 //#region src/root/constants/FILE_PATH_REGEX.d.ts
@@ -550,7 +550,7 @@ declare class VersionNumber {
    */
   toString(): string;
 }
-declare const zodVersionNumber: z$1.ZodType<VersionNumber>;
+declare const zodVersionNumber: z.ZodType<VersionNumber>;
 //#endregion
 //#region src/root/types/ArrayElement.d.ts
 /**
@@ -1154,6 +1154,8 @@ declare function normaliseIndents(options: NormaliseIndentsOptions): NormaliseIn
  *     and another new line`;
  * ```
  *
+ * @category Tagged Template
+ *
  * @template InterpolationsType - The type of the interpolations.
  *
  * @param strings - The strings from the template to process.
@@ -1181,6 +1183,8 @@ declare function normaliseIndents(strings: TemplateStringsArray, ...interpolatio
  *     and another new line`.
  * ```
  *
+ * @category Tagged Template
+ *
  * @param first - The strings from the template to process, or the options to apply.
  * @param args - An array of all interpolations from the template.
  *
@@ -1439,7 +1443,7 @@ declare class DataError$1<DataType extends object = Record<PropertyKey, unknown>
  *
  * @returns The parsed data from the Zod schema.
  */
-declare function parseZodSchema<SchemaType extends ZodType, ErrorType extends Error = DataError$1>(schema: SchemaType, input: unknown, onError?: ErrorType | ((zodError: ZodError) => ErrorType | void)): z.infer<SchemaType>;
+declare function parseZodSchema<SchemaType extends ZodType, ErrorType extends Error = DataError$1>(schema: SchemaType, input: unknown, onError?: ErrorType | ((zodError: ZodError) => ErrorType | void)): z$1.infer<SchemaType>;
 //#endregion
 //#region src/root/zod/parseZodSchemaAsync.d.ts
 /**
@@ -1460,10 +1464,10 @@ declare function parseZodSchema<SchemaType extends ZodType, ErrorType extends Er
  *
  * @returns The parsed data from the Zod schema.
  */
-declare function parseZodSchemaAsync<SchemaType extends ZodType, ErrorType extends Error = DataError$1>(schema: SchemaType, input: unknown, onError?: ErrorType | ((zodError: ZodError) => ErrorType | void)): Promise<z.infer<SchemaType>>;
+declare function parseZodSchemaAsync<SchemaType extends ZodType, ErrorType extends Error = DataError$1>(schema: SchemaType, input: unknown, onError?: ErrorType | ((zodError: ZodError) => ErrorType | void)): Promise<z$1.infer<SchemaType>>;
 //#endregion
 //#region src/root/zod/zodFieldWrapper.d.ts
-declare function zodFieldWrapper<SchemaType extends ZodType<unknown, string | null>>(schema: SchemaType): ZodType<z$1.infer<SchemaType>, string>;
+declare function zodFieldWrapper<SchemaType extends ZodType<unknown, string | null>>(schema: SchemaType): ZodType<z.infer<SchemaType>, string>;
 //#endregion
 //#region src/root/zod/az.d.ts
 declare const az: {
@@ -1472,15 +1476,15 @@ declare const az: {
   versionNumber: () => ZodType<VersionNumber, unknown>;
   fieldDate: () => ZodCoercedDate<string | null>;
   with: <SchemaType extends ZodType>(schema: SchemaType) => {
-    parse: <ErrorType extends Error = DataError$1<Record<PropertyKey, unknown>, string>>(input: unknown, error?: ErrorType | ((zodError: z$1.ZodError<unknown>) => void | ErrorType)) => ReturnType<typeof parseZodSchema<SchemaType, ErrorType>>;
-    parseAsync: <ErrorType extends Error = DataError$1<Record<PropertyKey, unknown>, string>>(input: unknown, error?: ErrorType | ((zodError: z$1.ZodError<unknown>) => void | ErrorType)) => ReturnType<typeof parseZodSchemaAsync<SchemaType, ErrorType>>;
+    parse: <ErrorType extends Error = DataError$1<Record<PropertyKey, unknown>, string>>(input: unknown, error?: ErrorType | ((zodError: z.ZodError<unknown>) => void | ErrorType)) => ReturnType<typeof parseZodSchema<SchemaType, ErrorType>>;
+    parseAsync: <ErrorType extends Error = DataError$1<Record<PropertyKey, unknown>, string>>(input: unknown, error?: ErrorType | ((zodError: z.ZodError<unknown>) => void | ErrorType)) => ReturnType<typeof parseZodSchemaAsync<SchemaType, ErrorType>>;
   };
 };
 //#endregion
 //#region src/root/zod/_parseZodSchema.d.ts
 interface ZodParsingErrorData {
   input: unknown;
-  issues: Array<z$1.core.$ZodIssue>;
+  issues: Array<z.core.$ZodIssue>;
 }
 //#endregion
 export { APIError, type ArrayElement, type CallReturnType, type 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, type KebabToCamelOptions, type NonNull, type NonUndefined, type NormaliseIndentsFunction, type NormaliseIndentsOptions, type NormalizeIndentsFunction, type NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, type ParallelTuple, type RecordKey, type RemoveUndefined, SortDirection, type StringListToArrayOptions, type ToTitleCaseOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, type ZodParsingErrorData, addDaysToDate, appendSemicolon, assertNotNull, assertNotNullable, assertNotUndefined, az, calculateMonthlyDifference, camelToKebab, containsKeys, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeHTML, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, identity, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isNonNullableObject, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, objectContainsKeys, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, pickProperties, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, sortBy, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };

package/dist/index.js

@@ -1,4 +1,4 @@
-import z$1, { z } from "zod";
+import z, { z as z$1 } from "zod";
 //#region src/root/constants/FILE_PATH_REGEX.ts
 const FILE_PATH_PATTERN = String.raw`(?<directory>.+)[\/\\](?<base>[^\/\\]+)`;
 const FILE_PATH_REGEX = RegExp(`^${FILE_PATH_PATTERN}$`);
@@ -1300,14 +1300,14 @@ var VersionNumber = class VersionNumber {
 		return VersionNumber.formatString(rawString, { omitPrefix: false });
 	}
 };
-const zodVersionNumber = z$1.union([
-	z$1.string(),
-	z$1.tuple([
-		z$1.number(),
-		z$1.number(),
-		z$1.number()
+const zodVersionNumber = z.union([
+	z.string(),
+	z.tuple([
+		z.number(),
+		z.number(),
+		z.number()
 	]),
-	z$1.instanceof(VersionNumber)
+	z.instanceof(VersionNumber)
 ]).transform((rawVersionNumber) => {
 	return new VersionNumber(rawVersionNumber);
 });
@@ -1325,7 +1325,7 @@ function _parseZodSchema(parsedResult, input, onError) {
 		throw new DataError$1({
 			input,
 			issues: parsedResult.error.issues
-		}, "ZOD_ERROR", `\n\n${z$1.prettifyError(parsedResult.error)}\n`);
+		}, "ZOD_ERROR", `\n\n${z.prettifyError(parsedResult.error)}\n`);
 	}
 	return parsedResult.data;
 }
@@ -1380,7 +1380,7 @@ async function parseZodSchemaAsync(schema, input, onError) {
 //#endregion
 //#region src/root/zod/zodFieldWrapper.ts
 function zodFieldWrapper(schema) {
-	return z$1.string().trim().transform((value) => {
+	return z.string().trim().transform((value) => {
 		return value === "" ? null : value;
 	}).pipe(schema);
 }
@@ -1389,13 +1389,13 @@ function zodFieldWrapper(schema) {
 const az = {
 	field: zodFieldWrapper,
 	fieldNumber: () => {
-		return z$1.coerce.number();
+		return z.coerce.number();
 	},
 	versionNumber: () => {
 		return zodVersionNumber;
 	},
 	fieldDate: () => {
-		return z$1.coerce.date();
+		return z.coerce.date();
 	},
 	with: (schema) => {
 		return {
@@ -1432,7 +1432,7 @@ const Env = {
 * @returns The specified environment if allowed.
 */
 function parseEnv(input) {
-	return az.with(z.enum(Env)).parse(input, new DataError$1({ input }, "INVALID_ENV", "The provided environment type must be one of `test | development | production`"));
+	return az.with(z$1.enum(Env)).parse(input, new DataError$1({ input }, "INVALID_ENV", "The provided environment type must be one of `test | development | production`"));
 }
 //#endregion
 //#region src/root/functions/parsers/parseFormData.ts
@@ -1498,7 +1498,7 @@ const VersionType = {
 * @returns The given version type if allowed.
 */
 function parseVersionType(input) {
-	return az.with(z$1.enum(VersionType)).parse(input, new DataError$1({ input }, "INVALID_VERSION_TYPE", "The provided version type must be one of `major | minor | patch`"));
+	return az.with(z.enum(VersionType)).parse(input, new DataError$1({ input }, "INVALID_VERSION_TYPE", "The provided version type must be one of `major | minor | patch`"));
 }
 //#endregion
 //#region src/root/functions/recursive/deepCopy.ts
@@ -1918,6 +1918,8 @@ function normaliseIndents(first, ...args) {
 *     and another new line`.
 * ```
 *
+* @category Tagged Template
+*
 * @param first - The strings from the template to process, or the options to apply.
 * @param args - An array of all interpolations from the template.
 *

package/dist/internal/index.cjs

@@ -244,49 +244,6 @@ var DataError = class DataError extends CodeError {
 	}
 };
 //#endregion
-//#region src/root/functions/parsers/parseIntStrict.ts
-/**
-* Converts a string to an integer and throws an error if it cannot be converted.
-*
-* @category Parsers
-*
-* @param string - A string to convert into a number.
-* @param radix - A value between 2 and 36 that specifies the base of the number in string. If this argument is not supplied, strings with a prefix of '0x' are considered hexadecimal. All other strings are considered decimal.
-*
-* @throws {DataError} If the provided string cannot safely be converted to an integer.
-*
-* @returns The integer parsed from the input string.
-*/
-function parseIntStrict(string, radix) {
-	const trimmedString = string.trim();
-	const maxAllowedAlphabeticalCharacter = radix && radix > 10 && radix <= 36 ? String.fromCharCode(87 + radix - 1) : void 0;
-	if (!(radix && radix > 10 && radix <= 36 ? new RegExp(`^[+-]?[0-9a-${maxAllowedAlphabeticalCharacter}]+$`, "i") : /^[+-]?\d+$/).test(trimmedString)) throw new DataError(radix ? {
-		string,
-		radix
-	} : { string }, "INTEGER_PARSING_ERROR", `Only numeric values${radix && radix > 10 && radix <= 36 ? ` or character${radix !== 11 ? "s" : ""} A${radix !== 11 ? `-${maxAllowedAlphabeticalCharacter?.toUpperCase()} ` : " "}` : " "}are allowed.`);
-	if (radix && radix < 10 && [...trimmedString.replace(/^[+-]/, "")].some((character) => {
-		return parseInt(character) >= radix;
-	})) throw new DataError({
-		string,
-		radix
-	}, "INTEGER_PARSING_ERROR", "Value contains one or more digits outside of the range of the given radix.");
-	const parseIntResult = parseInt(trimmedString, radix);
-	if (isNaN(parseIntResult)) throw new DataError({ string }, "INTEGER_PARSING_ERROR", "Value is not a valid integer.");
-	return parseIntResult;
-}
-//#endregion
-//#region src/root/functions/parsers/parseVersionType.ts
-/**
-* Represents the three common software version types.
-*
-* @category Types
-*/
-const VersionType = {
-	MAJOR: "major",
-	MINOR: "minor",
-	PATCH: "patch"
-};
-//#endregion
 //#region src/root/functions/arrayHelpers/range.ts
 /**
 * Creates an array of numbers within a given range.
@@ -428,6 +385,49 @@ function paralleliseArrays(firstArray, secondArray) {
 	return outputArray;
 }
 //#endregion
+//#region src/root/functions/parsers/parseIntStrict.ts
+/**
+* Converts a string to an integer and throws an error if it cannot be converted.
+*
+* @category Parsers
+*
+* @param string - A string to convert into a number.
+* @param radix - A value between 2 and 36 that specifies the base of the number in string. If this argument is not supplied, strings with a prefix of '0x' are considered hexadecimal. All other strings are considered decimal.
+*
+* @throws {DataError} If the provided string cannot safely be converted to an integer.
+*
+* @returns The integer parsed from the input string.
+*/
+function parseIntStrict(string, radix) {
+	const trimmedString = string.trim();
+	const maxAllowedAlphabeticalCharacter = radix && radix > 10 && radix <= 36 ? String.fromCharCode(87 + radix - 1) : void 0;
+	if (!(radix && radix > 10 && radix <= 36 ? new RegExp(`^[+-]?[0-9a-${maxAllowedAlphabeticalCharacter}]+$`, "i") : /^[+-]?\d+$/).test(trimmedString)) throw new DataError(radix ? {
+		string,
+		radix
+	} : { string }, "INTEGER_PARSING_ERROR", `Only numeric values${radix && radix > 10 && radix <= 36 ? ` or character${radix !== 11 ? "s" : ""} A${radix !== 11 ? `-${maxAllowedAlphabeticalCharacter?.toUpperCase()} ` : " "}` : " "}are allowed.`);
+	if (radix && radix < 10 && [...trimmedString.replace(/^[+-]/, "")].some((character) => {
+		return parseInt(character) >= radix;
+	})) throw new DataError({
+		string,
+		radix
+	}, "INTEGER_PARSING_ERROR", "Value contains one or more digits outside of the range of the given radix.");
+	const parseIntResult = parseInt(trimmedString, radix);
+	if (isNaN(parseIntResult)) throw new DataError({ string }, "INTEGER_PARSING_ERROR", "Value is not a valid integer.");
+	return parseIntResult;
+}
+//#endregion
+//#region src/root/functions/parsers/parseVersionType.ts
+/**
+* Represents the three common software version types.
+*
+* @category Types
+*/
+const VersionType = {
+	MAJOR: "major",
+	MINOR: "minor",
+	PATCH: "patch"
+};
+//#endregion
 //#region src/root/functions/taggedTemplate/interpolate.ts
 /**
 * Returns the result of interpolating a template string when given the strings and interpolations separately.

package/dist/internal/index.js

@@ -219,49 +219,6 @@ var DataError = class DataError extends CodeError {
 	}
 };
 //#endregion
-//#region src/root/functions/parsers/parseIntStrict.ts
-/**
-* Converts a string to an integer and throws an error if it cannot be converted.
-*
-* @category Parsers
-*
-* @param string - A string to convert into a number.
-* @param radix - A value between 2 and 36 that specifies the base of the number in string. If this argument is not supplied, strings with a prefix of '0x' are considered hexadecimal. All other strings are considered decimal.
-*
-* @throws {DataError} If the provided string cannot safely be converted to an integer.
-*
-* @returns The integer parsed from the input string.
-*/
-function parseIntStrict(string, radix) {
-	const trimmedString = string.trim();
-	const maxAllowedAlphabeticalCharacter = radix && radix > 10 && radix <= 36 ? String.fromCharCode(87 + radix - 1) : void 0;
-	if (!(radix && radix > 10 && radix <= 36 ? new RegExp(`^[+-]?[0-9a-${maxAllowedAlphabeticalCharacter}]+$`, "i") : /^[+-]?\d+$/).test(trimmedString)) throw new DataError(radix ? {
-		string,
-		radix
-	} : { string }, "INTEGER_PARSING_ERROR", `Only numeric values${radix && radix > 10 && radix <= 36 ? ` or character${radix !== 11 ? "s" : ""} A${radix !== 11 ? `-${maxAllowedAlphabeticalCharacter?.toUpperCase()} ` : " "}` : " "}are allowed.`);
-	if (radix && radix < 10 && [...trimmedString.replace(/^[+-]/, "")].some((character) => {
-		return parseInt(character) >= radix;
-	})) throw new DataError({
-		string,
-		radix
-	}, "INTEGER_PARSING_ERROR", "Value contains one or more digits outside of the range of the given radix.");
-	const parseIntResult = parseInt(trimmedString, radix);
-	if (isNaN(parseIntResult)) throw new DataError({ string }, "INTEGER_PARSING_ERROR", "Value is not a valid integer.");
-	return parseIntResult;
-}
-//#endregion
-//#region src/root/functions/parsers/parseVersionType.ts
-/**
-* Represents the three common software version types.
-*
-* @category Types
-*/
-const VersionType = {
-	MAJOR: "major",
-	MINOR: "minor",
-	PATCH: "patch"
-};
-//#endregion
 //#region src/root/functions/arrayHelpers/range.ts
 /**
 * Creates an array of numbers within a given range.
@@ -403,6 +360,49 @@ function paralleliseArrays(firstArray, secondArray) {
 	return outputArray;
 }
 //#endregion
+//#region src/root/functions/parsers/parseIntStrict.ts
+/**
+* Converts a string to an integer and throws an error if it cannot be converted.
+*
+* @category Parsers
+*
+* @param string - A string to convert into a number.
+* @param radix - A value between 2 and 36 that specifies the base of the number in string. If this argument is not supplied, strings with a prefix of '0x' are considered hexadecimal. All other strings are considered decimal.
+*
+* @throws {DataError} If the provided string cannot safely be converted to an integer.
+*
+* @returns The integer parsed from the input string.
+*/
+function parseIntStrict(string, radix) {
+	const trimmedString = string.trim();
+	const maxAllowedAlphabeticalCharacter = radix && radix > 10 && radix <= 36 ? String.fromCharCode(87 + radix - 1) : void 0;
+	if (!(radix && radix > 10 && radix <= 36 ? new RegExp(`^[+-]?[0-9a-${maxAllowedAlphabeticalCharacter}]+$`, "i") : /^[+-]?\d+$/).test(trimmedString)) throw new DataError(radix ? {
+		string,
+		radix
+	} : { string }, "INTEGER_PARSING_ERROR", `Only numeric values${radix && radix > 10 && radix <= 36 ? ` or character${radix !== 11 ? "s" : ""} A${radix !== 11 ? `-${maxAllowedAlphabeticalCharacter?.toUpperCase()} ` : " "}` : " "}are allowed.`);
+	if (radix && radix < 10 && [...trimmedString.replace(/^[+-]/, "")].some((character) => {
+		return parseInt(character) >= radix;
+	})) throw new DataError({
+		string,
+		radix
+	}, "INTEGER_PARSING_ERROR", "Value contains one or more digits outside of the range of the given radix.");
+	const parseIntResult = parseInt(trimmedString, radix);
+	if (isNaN(parseIntResult)) throw new DataError({ string }, "INTEGER_PARSING_ERROR", "Value is not a valid integer.");
+	return parseIntResult;
+}
+//#endregion
+//#region src/root/functions/parsers/parseVersionType.ts
+/**
+* Represents the three common software version types.
+*
+* @category Types
+*/
+const VersionType = {
+	MAJOR: "major",
+	MINOR: "minor",
+	PATCH: "patch"
+};
+//#endregion
 //#region src/root/functions/taggedTemplate/interpolate.ts
 /**
 * Returns the result of interpolating a template string when given the strings and interpolations separately.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "5.23.0",
+  "version": "5.23.2",
   "description": "Helpful utility functions.",
   "repository": {
     "type": "git",
@@ -40,27 +40,27 @@
     "execa": "9.6.1"
   },
   "devDependencies": {
-    "@alextheman/eslint-plugin": "5.17.0",
-    "@types/node": "25.9.3",
-    "alex-c-line": "2.9.3",
+    "@alextheman/eslint-plugin": "5.18.0",
+    "@types/node": "26.1.0",
+    "alex-c-line": "2.11.3",
     "cross-env": "10.1.0",
     "dotenv-cli": "11.0.0",
-    "eslint": "10.5.0",
-    "globals": "17.6.0",
+    "eslint": "10.6.0",
+    "globals": "17.7.0",
     "husky": "9.1.7",
     "jsdom": "29.1.1",
-    "markdownlint-cli2": "0.22.1",
-    "prettier": "3.8.4",
+    "markdownlint-cli2": "0.23.0",
+    "prettier": "3.9.4",
     "tempy": "3.2.0",
-    "tsdown": "0.22.2",
-    "tsx": "4.22.4",
+    "tsdown": "0.22.3",
+    "tsx": "4.23.0",
     "typedoc": "0.28.19",
     "typedoc-plugin-markdown": "4.12.0",
     "typedoc-rhineai-theme": "1.2.0",
     "typescript": "6.0.3",
-    "typescript-eslint": "8.61.0",
-    "vite": "8.0.16",
-    "vitest": "4.1.8",
+    "typescript-eslint": "8.62.1",
+    "vite": "8.1.3",
+    "vitest": "4.1.9",
     "zod": "4.4.3"
   },
   "engines": {
@@ -82,7 +82,7 @@
     "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-markdownlint pnpm run lint-prettier && pnpm run lint-pre-release",
+    "lint": "pnpm run lint-tsc && pnpm run lint-eslint && pnpm run lint-markdownlint && pnpm run lint-prettier && pnpm run lint-pre-release",
     "lint-eslint": "eslint \"package.json\" \"{src,tests,configs}/**/*.ts\"",
     "lint-markdownlint": "bash -o pipefail -c 'pnpm exec markdownlint-cli2 \"**/*.md\" \"!{node_modules,dist}/**\"| grep -v \"^Finding:\"'",
     "lint-pre-release": "alex-c-line package-json check --rules no-pre-release-dependencies",