@alextheman/utility 5.23.2 → 5.25.0

package/dist/index.cjs

@@ -24,19 +24,19 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 let zod = require("zod");
 zod = __toESM(zod, 1);
 //#region src/root/constants/FILE_PATH_REGEX.ts
-const FILE_PATH_PATTERN = String.raw`(?<directory>.+)[\/\\](?<base>[^\/\\]+)`;
-const FILE_PATH_REGEX = RegExp(`^${FILE_PATH_PATTERN}$`);
+const FILE_PATH_REGEX_PATTERN = String.raw`(?<directory>.+)[\/\\](?<base>[^\/\\]+)`;
+const FILE_PATH_REGEX = RegExp(`^${FILE_PATH_REGEX_PATTERN}$`);
 //#endregion
 //#region src/root/constants/ONE_DAY_IN_MILLISECONDS.ts
 const ONE_DAY_IN_MILLISECONDS = 1440 * 60 * 1e3;
 //#endregion
 //#region src/root/constants/UUID_REGEX.ts
-const UUID_PATTERN = "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}";
-const UUID_REGEX = new RegExp(`^${UUID_PATTERN}$`);
+const UUID_REGEX_PATTERN = "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}";
+const UUID_REGEX = new RegExp(`^${UUID_REGEX_PATTERN}$`);
 //#endregion
 //#region src/root/constants/VERSION_NUMBER_REGEX.ts
-const VERSION_NUMBER_PATTERN = String.raw`^(?:v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$`;
-const VERSION_NUMBER_REGEX = RegExp(`^${VERSION_NUMBER_PATTERN}$`);
+const VERSION_NUMBER_REGEX_PATTERN = String.raw`(?:v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)`;
+const VERSION_NUMBER_REGEX = RegExp(`^${VERSION_NUMBER_REGEX_PATTERN}$`);
 //#endregion
 //#region src/root/deprecated/APIError.ts
 const httpErrorCodeLookup = {
@@ -2042,17 +2042,32 @@ var DataError = class DataError extends Error {
 	}
 };
 //#endregion
+//#region src/root/deprecated/FILE_PATH_PATTERN.ts
+/** @deprecated This has been renamed to `FILE_PATH_REGEX_PATTERN`. */
+const FILE_PATH_PATTERN = FILE_PATH_REGEX_PATTERN;
+//#endregion
+//#region src/root/deprecated/UUID_PATTERN.ts
+/** @deprecated This has been renamed to `UUID_REGEX_PATTERN`. */
+const UUID_PATTERN = UUID_REGEX_PATTERN;
+//#endregion
+//#region src/root/deprecated/VERSION_NUMBER_PATTERN.ts
+/** @deprecated This has been renamed to `VERSION_NUMBER_REGEX_PATTERN`. */
+const VERSION_NUMBER_PATTERN = String.raw`^(?:v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$`;
+//#endregion
 exports.APIError = APIError;
 exports.DataError = DataError;
 exports.Env = Env;
 exports.FILE_PATH_PATTERN = FILE_PATH_PATTERN;
 exports.FILE_PATH_REGEX = FILE_PATH_REGEX;
+exports.FILE_PATH_REGEX_PATTERN = FILE_PATH_REGEX_PATTERN;
 exports.ONE_DAY_IN_MILLISECONDS = ONE_DAY_IN_MILLISECONDS;
 exports.SortDirection = SortDirection;
 exports.UUID_PATTERN = UUID_PATTERN;
 exports.UUID_REGEX = UUID_REGEX;
+exports.UUID_REGEX_PATTERN = UUID_REGEX_PATTERN;
 exports.VERSION_NUMBER_PATTERN = VERSION_NUMBER_PATTERN;
 exports.VERSION_NUMBER_REGEX = VERSION_NUMBER_REGEX;
+exports.VERSION_NUMBER_REGEX_PATTERN = VERSION_NUMBER_REGEX_PATTERN;
 exports.VersionNumber = VersionNumber;
 exports.VersionType = VersionType;
 exports.addDaysToDate = addDaysToDate;

package/dist/index.d.cts

@@ -2,18 +2,18 @@ import z, { ZodCoercedDate, ZodCoercedNumber, ZodError, ZodType, z as z$1 } from
 import { DotenvParseOutput } from "dotenv";
 
 //#region src/root/constants/FILE_PATH_REGEX.d.ts
-declare const FILE_PATH_PATTERN: string;
+declare const FILE_PATH_REGEX_PATTERN: string;
 declare const FILE_PATH_REGEX: RegExp;
 //#endregion
 //#region src/root/constants/ONE_DAY_IN_MILLISECONDS.d.ts
 declare const ONE_DAY_IN_MILLISECONDS: number;
 //#endregion
 //#region src/root/constants/UUID_REGEX.d.ts
-declare const UUID_PATTERN = "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}";
+declare const UUID_REGEX_PATTERN = "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}";
 declare const UUID_REGEX: RegExp;
 //#endregion
 //#region src/root/constants/VERSION_NUMBER_REGEX.d.ts
-declare const VERSION_NUMBER_PATTERN: string;
+declare const VERSION_NUMBER_REGEX_PATTERN: string;
 declare const VERSION_NUMBER_REGEX: RegExp;
 //#endregion
 //#region src/root/deprecated/APIError.d.ts
@@ -102,6 +102,18 @@ declare class DataError<DataType extends Record<PropertyKey, unknown> = Record<P
   static expectErrorAsync(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions$1): Promise<DataError>;
 }
 //#endregion
+//#region src/root/deprecated/FILE_PATH_PATTERN.d.ts
+/** @deprecated This has been renamed to `FILE_PATH_REGEX_PATTERN`. */
+declare const FILE_PATH_PATTERN: string;
+//#endregion
+//#region src/root/deprecated/UUID_PATTERN.d.ts
+/** @deprecated This has been renamed to `UUID_REGEX_PATTERN`. */
+declare const UUID_PATTERN = "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}";
+//#endregion
+//#region src/root/deprecated/VERSION_NUMBER_PATTERN.d.ts
+/** @deprecated This has been renamed to `VERSION_NUMBER_REGEX_PATTERN`. */
+declare const VERSION_NUMBER_PATTERN: string;
+//#endregion
 //#region src/root/deprecated/RecordKey.d.ts
 /**
  * Represents the native Record's possible key type.
@@ -1487,4 +1499,4 @@ interface ZodParsingErrorData {
   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 };
+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, FILE_PATH_REGEX_PATTERN, 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, UUID_REGEX_PATTERN, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VERSION_NUMBER_REGEX_PATTERN, 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.d.ts

@@ -2,18 +2,18 @@ import z, { ZodCoercedDate, ZodCoercedNumber, ZodError, ZodType, z as z$1 } from
 import { DotenvParseOutput } from "dotenv";
 
 //#region src/root/constants/FILE_PATH_REGEX.d.ts
-declare const FILE_PATH_PATTERN: string;
+declare const FILE_PATH_REGEX_PATTERN: string;
 declare const FILE_PATH_REGEX: RegExp;
 //#endregion
 //#region src/root/constants/ONE_DAY_IN_MILLISECONDS.d.ts
 declare const ONE_DAY_IN_MILLISECONDS: number;
 //#endregion
 //#region src/root/constants/UUID_REGEX.d.ts
-declare const UUID_PATTERN = "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}";
+declare const UUID_REGEX_PATTERN = "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}";
 declare const UUID_REGEX: RegExp;
 //#endregion
 //#region src/root/constants/VERSION_NUMBER_REGEX.d.ts
-declare const VERSION_NUMBER_PATTERN: string;
+declare const VERSION_NUMBER_REGEX_PATTERN: string;
 declare const VERSION_NUMBER_REGEX: RegExp;
 //#endregion
 //#region src/root/deprecated/APIError.d.ts
@@ -102,6 +102,18 @@ declare class DataError<DataType extends Record<PropertyKey, unknown> = Record<P
   static expectErrorAsync(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions$1): Promise<DataError>;
 }
 //#endregion
+//#region src/root/deprecated/FILE_PATH_PATTERN.d.ts
+/** @deprecated This has been renamed to `FILE_PATH_REGEX_PATTERN`. */
+declare const FILE_PATH_PATTERN: string;
+//#endregion
+//#region src/root/deprecated/UUID_PATTERN.d.ts
+/** @deprecated This has been renamed to `UUID_REGEX_PATTERN`. */
+declare const UUID_PATTERN = "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}";
+//#endregion
+//#region src/root/deprecated/VERSION_NUMBER_PATTERN.d.ts
+/** @deprecated This has been renamed to `VERSION_NUMBER_REGEX_PATTERN`. */
+declare const VERSION_NUMBER_PATTERN: string;
+//#endregion
 //#region src/root/deprecated/RecordKey.d.ts
 /**
  * Represents the native Record's possible key type.
@@ -1487,4 +1499,4 @@ interface ZodParsingErrorData {
   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 };
+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, FILE_PATH_REGEX_PATTERN, 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, UUID_REGEX_PATTERN, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VERSION_NUMBER_REGEX_PATTERN, 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,18 +1,18 @@
 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}$`);
+const FILE_PATH_REGEX_PATTERN = String.raw`(?<directory>.+)[\/\\](?<base>[^\/\\]+)`;
+const FILE_PATH_REGEX = RegExp(`^${FILE_PATH_REGEX_PATTERN}$`);
 //#endregion
 //#region src/root/constants/ONE_DAY_IN_MILLISECONDS.ts
 const ONE_DAY_IN_MILLISECONDS = 1440 * 60 * 1e3;
 //#endregion
 //#region src/root/constants/UUID_REGEX.ts
-const UUID_PATTERN = "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}";
-const UUID_REGEX = new RegExp(`^${UUID_PATTERN}$`);
+const UUID_REGEX_PATTERN = "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}";
+const UUID_REGEX = new RegExp(`^${UUID_REGEX_PATTERN}$`);
 //#endregion
 //#region src/root/constants/VERSION_NUMBER_REGEX.ts
-const VERSION_NUMBER_PATTERN = String.raw`^(?:v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$`;
-const VERSION_NUMBER_REGEX = RegExp(`^${VERSION_NUMBER_PATTERN}$`);
+const VERSION_NUMBER_REGEX_PATTERN = String.raw`(?:v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)`;
+const VERSION_NUMBER_REGEX = RegExp(`^${VERSION_NUMBER_REGEX_PATTERN}$`);
 //#endregion
 //#region src/root/deprecated/APIError.ts
 const httpErrorCodeLookup = {
@@ -2018,4 +2018,16 @@ var DataError = class DataError extends Error {
 	}
 };
 //#endregion
-export { APIError, DataError, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, ONE_DAY_IN_MILLISECONDS, SortDirection, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, VersionType, 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 };
+//#region src/root/deprecated/FILE_PATH_PATTERN.ts
+/** @deprecated This has been renamed to `FILE_PATH_REGEX_PATTERN`. */
+const FILE_PATH_PATTERN = FILE_PATH_REGEX_PATTERN;
+//#endregion
+//#region src/root/deprecated/UUID_PATTERN.ts
+/** @deprecated This has been renamed to `UUID_REGEX_PATTERN`. */
+const UUID_PATTERN = UUID_REGEX_PATTERN;
+//#endregion
+//#region src/root/deprecated/VERSION_NUMBER_PATTERN.ts
+/** @deprecated This has been renamed to `VERSION_NUMBER_REGEX_PATTERN`. */
+const VERSION_NUMBER_PATTERN = String.raw`^(?:v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$`;
+//#endregion
+export { APIError, DataError, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, FILE_PATH_REGEX_PATTERN, ONE_DAY_IN_MILLISECONDS, SortDirection, UUID_PATTERN, UUID_REGEX, UUID_REGEX_PATTERN, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VERSION_NUMBER_REGEX_PATTERN, VersionNumber, VersionType, 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/internal/index.cjs

@@ -34,8 +34,8 @@ const DependencyGroup = {
 };
 //#endregion
 //#region src/root/constants/VERSION_NUMBER_REGEX.ts
-const VERSION_NUMBER_PATTERN = String.raw`^(?:v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$`;
-const VERSION_NUMBER_REGEX = RegExp(`^${VERSION_NUMBER_PATTERN}$`);
+const VERSION_NUMBER_REGEX_PATTERN = String.raw`(?:v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)`;
+const VERSION_NUMBER_REGEX = RegExp(`^${VERSION_NUMBER_REGEX_PATTERN}$`);
 //#endregion
 //#region src/v6/CodeError.ts
 /**

package/dist/internal/index.js

@@ -9,8 +9,8 @@ const DependencyGroup = {
 };
 //#endregion
 //#region src/root/constants/VERSION_NUMBER_REGEX.ts
-const VERSION_NUMBER_PATTERN = String.raw`^(?:v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$`;
-const VERSION_NUMBER_REGEX = RegExp(`^${VERSION_NUMBER_PATTERN}$`);
+const VERSION_NUMBER_REGEX_PATTERN = String.raw`(?:v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)`;
+const VERSION_NUMBER_REGEX = RegExp(`^${VERSION_NUMBER_REGEX_PATTERN}$`);
 //#endregion
 //#region src/v6/CodeError.ts
 /**

package/dist/node/index.cjs

@@ -60,8 +60,8 @@ function normalizeImportPath(importPath) {
 const normaliseImportPath = normalizeImportPath;
 //#endregion
 //#region src/root/constants/FILE_PATH_REGEX.ts
-const FILE_PATH_PATTERN = String.raw`(?<directory>.+)[\/\\](?<base>[^\/\\]+)`;
-const FILE_PATH_REGEX = RegExp(`^${FILE_PATH_PATTERN}$`);
+const FILE_PATH_REGEX_PATTERN = String.raw`(?<directory>.+)[\/\\](?<base>[^\/\\]+)`;
+const FILE_PATH_REGEX = RegExp(`^${FILE_PATH_REGEX_PATTERN}$`);
 //#endregion
 //#region src/root/functions/arrayHelpers/range.ts
 /**

package/dist/node/index.js

@@ -36,8 +36,8 @@ function normalizeImportPath(importPath) {
 const normaliseImportPath = normalizeImportPath;
 //#endregion
 //#region src/root/constants/FILE_PATH_REGEX.ts
-const FILE_PATH_PATTERN = String.raw`(?<directory>.+)[\/\\](?<base>[^\/\\]+)`;
-const FILE_PATH_REGEX = RegExp(`^${FILE_PATH_PATTERN}$`);
+const FILE_PATH_REGEX_PATTERN = String.raw`(?<directory>.+)[\/\\](?<base>[^\/\\]+)`;
+const FILE_PATH_REGEX = RegExp(`^${FILE_PATH_REGEX_PATTERN}$`);
 //#endregion
 //#region src/root/functions/arrayHelpers/range.ts
 /**

package/dist/temporal/index.cjs

@@ -0,0 +1,35 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/temporal/formatRelativeDateAndTime.ts
+/**
+* Creates a human-readable string describing the input date relative to the reference date.
+*
+* If no reference date is provided, the current local date and time is used as the reference.
+*
+* @category Temporal
+*
+* @param input - The date and time to format.
+* @param reference - The date and time to compare the input against.
+*
+* @returns A human-readable string describing the input date relative to the reference date.
+*
+* - If the date given is today, the output will be something like `Today at HH:MM`
+* - If the date given happened yesterday, the output will be something like `Yesterday at HH:MM`
+* - For any other date, the output will be something like `DD/MM/YYYY, HH:MM`
+*/
+function formatRelativeDateAndTime(input, reference = Temporal.Now.plainDateTimeISO()) {
+	const inputPlainDate = input.toPlainDate();
+	const referencePlainDate = reference.toPlainDate();
+	const formattedTime = input.toLocaleString("en-GB", {
+		hour: "2-digit",
+		minute: "2-digit"
+	});
+	if (inputPlainDate.equals(referencePlainDate.subtract({ days: 1 }))) return `Yesterday at ${formattedTime}`;
+	if (inputPlainDate.equals(referencePlainDate)) return `Today at ${formattedTime}`;
+	return `${input.toLocaleString("en-GB", {
+		day: "2-digit",
+		month: "2-digit",
+		year: "numeric"
+	})}, ${formattedTime}`;
+}
+//#endregion
+exports.formatRelativeDateAndTime = formatRelativeDateAndTime;

package/dist/temporal/index.d.cts

@@ -0,0 +1,20 @@
+//#region src/temporal/formatRelativeDateAndTime.d.ts
+/**
+ * Creates a human-readable string describing the input date relative to the reference date.
+ *
+ * If no reference date is provided, the current local date and time is used as the reference.
+ *
+ * @category Temporal
+ *
+ * @param input - The date and time to format.
+ * @param reference - The date and time to compare the input against.
+ *
+ * @returns A human-readable string describing the input date relative to the reference date.
+ *
+ * - If the date given is today, the output will be something like `Today at HH:MM`
+ * - If the date given happened yesterday, the output will be something like `Yesterday at HH:MM`
+ * - For any other date, the output will be something like `DD/MM/YYYY, HH:MM`
+ */
+declare function formatRelativeDateAndTime(input: Temporal.PlainDateTime | Temporal.ZonedDateTime, reference?: Temporal.PlainDateTime | Temporal.ZonedDateTime): string;
+//#endregion
+export { formatRelativeDateAndTime };

package/dist/temporal/index.d.ts

@@ -0,0 +1,20 @@
+//#region src/temporal/formatRelativeDateAndTime.d.ts
+/**
+ * Creates a human-readable string describing the input date relative to the reference date.
+ *
+ * If no reference date is provided, the current local date and time is used as the reference.
+ *
+ * @category Temporal
+ *
+ * @param input - The date and time to format.
+ * @param reference - The date and time to compare the input against.
+ *
+ * @returns A human-readable string describing the input date relative to the reference date.
+ *
+ * - If the date given is today, the output will be something like `Today at HH:MM`
+ * - If the date given happened yesterday, the output will be something like `Yesterday at HH:MM`
+ * - For any other date, the output will be something like `DD/MM/YYYY, HH:MM`
+ */
+declare function formatRelativeDateAndTime(input: Temporal.PlainDateTime | Temporal.ZonedDateTime, reference?: Temporal.PlainDateTime | Temporal.ZonedDateTime): string;
+//#endregion
+export { formatRelativeDateAndTime };

package/dist/temporal/index.js

@@ -0,0 +1,34 @@
+//#region src/temporal/formatRelativeDateAndTime.ts
+/**
+* Creates a human-readable string describing the input date relative to the reference date.
+*
+* If no reference date is provided, the current local date and time is used as the reference.
+*
+* @category Temporal
+*
+* @param input - The date and time to format.
+* @param reference - The date and time to compare the input against.
+*
+* @returns A human-readable string describing the input date relative to the reference date.
+*
+* - If the date given is today, the output will be something like `Today at HH:MM`
+* - If the date given happened yesterday, the output will be something like `Yesterday at HH:MM`
+* - For any other date, the output will be something like `DD/MM/YYYY, HH:MM`
+*/
+function formatRelativeDateAndTime(input, reference = Temporal.Now.plainDateTimeISO()) {
+	const inputPlainDate = input.toPlainDate();
+	const referencePlainDate = reference.toPlainDate();
+	const formattedTime = input.toLocaleString("en-GB", {
+		hour: "2-digit",
+		minute: "2-digit"
+	});
+	if (inputPlainDate.equals(referencePlainDate.subtract({ days: 1 }))) return `Yesterday at ${formattedTime}`;
+	if (inputPlainDate.equals(referencePlainDate)) return `Today at ${formattedTime}`;
+	return `${input.toLocaleString("en-GB", {
+		day: "2-digit",
+		month: "2-digit",
+		year: "numeric"
+	})}, ${formattedTime}`;
+}
+//#endregion
+export { formatRelativeDateAndTime };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "5.23.2",
+  "version": "5.25.0",
   "description": "Helpful utility functions.",
   "repository": {
     "type": "git",
@@ -26,6 +26,11 @@
       "import": "./dist/node/index.js",
       "require": "./dist/node/index.cjs"
     },
+    "./temporal": {
+      "types": "./dist/temporal/index.d.ts",
+      "import": "./dist/temporal/index.js",
+      "require": "./dist/temporal/index.cjs"
+    },
     "./v6": {
       "types": "./dist/v6/index.d.ts",
       "import": "./dist/v6/index.js",