@alextheman/utility 4.17.0 → 5.0.0

package/dist/index.d.cts

@@ -1,17 +1,16 @@
 import z, { ZodError, ZodType, z as z$1 } from "zod";
 import { DotenvParseOutput } from "dotenv";
-import sodium from "libsodium-wrappers";
 
-//#region src/constants/FILE_PATH_REGEX.d.ts
+//#region src/root/constants/FILE_PATH_REGEX.d.ts
 declare const FILE_PATH_REGEX: string;
 //#endregion
-//#region src/constants/NAMESPACE_EXPORT_REGEX.d.ts
+//#region src/root/constants/NAMESPACE_EXPORT_REGEX.d.ts
 declare const NAMESPACE_EXPORT_REGEX = "export\\s+\\*\\s+from";
 //#endregion
-//#region src/constants/VERSION_NUMBER_REGEX.d.ts
+//#region src/root/constants/VERSION_NUMBER_REGEX.d.ts
 declare const VERSION_NUMBER_REGEX: string;
 //#endregion
-//#region src/functions/arrayHelpers/fillArray.d.ts
+//#region src/root/functions/arrayHelpers/fillArray.d.ts
 /**
  * Creates a new array where each element is the resolved result of the provided asynchronous callback.
  *
@@ -41,7 +40,7 @@ declare function fillArray<ItemType>(callback: (index: number) => Promise<ItemTy
  */
 declare function fillArray<ItemType>(callback: (index: number) => ItemType, length?: number): ItemType[];
 //#endregion
-//#region src/functions/arrayHelpers/paralleliseArrays.d.ts
+//#region src/root/functions/arrayHelpers/paralleliseArrays.d.ts
 type ParallelTuple<A, B> = [A, B | undefined];
 /**
  * Creates a new array of tuples, each containing the item at the given index from both arrays.
@@ -61,7 +60,7 @@ type ParallelTuple<A, B> = [A, B | undefined];
  */
 declare function paralleliseArrays<FirstArrayItem, SecondArrayItem>(firstArray: readonly FirstArrayItem[], secondArray: readonly SecondArrayItem[]): ParallelTuple<FirstArrayItem, SecondArrayItem>[];
 //#endregion
-//#region src/functions/arrayHelpers/randomiseArray.d.ts
+//#region src/root/functions/arrayHelpers/randomiseArray.d.ts
 /**
  * Randomises the order of a given array and returns the result in a new array without mutating the original.
  *
@@ -75,7 +74,7 @@ declare function paralleliseArrays<FirstArrayItem, SecondArrayItem>(firstArray:
  */
 declare function randomiseArray<ItemType>(array: ItemType[]): ItemType[];
 //#endregion
-//#region src/functions/arrayHelpers/range.d.ts
+//#region src/root/functions/arrayHelpers/range.d.ts
 /**
  * Creates an array of numbers within a given range.
  *
@@ -95,7 +94,7 @@ declare function randomiseArray<ItemType>(array: ItemType[]): ItemType[];
  */
 declare function range(start: number, stop: number, step?: number): number[];
 //#endregion
-//#region src/functions/arrayHelpers/removeDuplicates.d.ts
+//#region src/root/functions/arrayHelpers/removeDuplicates.d.ts
 /**
  * Removes duplicate values from an array.
  *
@@ -109,7 +108,7 @@ declare function range(start: number, stop: number, step?: number): number[];
  */
 declare function removeDuplicates<ItemType>(array: ItemType[] | readonly ItemType[]): ItemType[];
 //#endregion
-//#region src/functions/date/addDaysToDate.d.ts
+//#region src/root/functions/date/addDaysToDate.d.ts
 /**
  * Adds a given number of days to the provided date, returning the result as a new instance of Date.
  *
@@ -122,7 +121,7 @@ declare function removeDuplicates<ItemType>(array: ItemType[] | readonly ItemTyp
  */
 declare function addDaysToDate(currentDate?: Date, dayIncrement?: number): Date;
 //#endregion
-//#region src/functions/date/formatDateAndTime.d.ts
+//#region src/root/functions/date/formatDateAndTime.d.ts
 /**
  * Creates a human-readable string with information about the input date.
  *
@@ -138,7 +137,7 @@ declare function addDaysToDate(currentDate?: Date, dayIncrement?: number): Date;
  */
 declare function formatDateAndTime(inputDate: Date): string;
 //#endregion
-//#region src/functions/date/isAnniversary.d.ts
+//#region src/root/functions/date/isAnniversary.d.ts
 /**
  * Checks if the provided dates are exactly a whole number of years apart.
  *
@@ -151,7 +150,7 @@ declare function formatDateAndTime(inputDate: Date): string;
  */
 declare function isAnniversary(firstDate: Date, secondDate: Date): boolean;
 //#endregion
-//#region src/functions/date/isLeapYear.d.ts
+//#region src/root/functions/date/isLeapYear.d.ts
 /**
  * Checks if the provided year is a leap year.
  *
@@ -165,7 +164,7 @@ declare function isAnniversary(firstDate: Date, secondDate: Date): boolean;
  */
 declare function isLeapYear(year: number): boolean;
 //#endregion
-//#region src/functions/date/isMonthlyMultiple.d.ts
+//#region src/root/functions/date/isMonthlyMultiple.d.ts
 /**
  * Checks if the provided dates are exactly a whole number of months apart.
  *
@@ -178,7 +177,7 @@ declare function isLeapYear(year: number): boolean;
  */
 declare function isMonthlyMultiple(firstDate: Date, secondDate: Date): boolean;
 //#endregion
-//#region src/functions/date/isSameDate.d.ts
+//#region src/root/functions/date/isSameDate.d.ts
 /**
  * Checks if the provided dates happen on the exact same day, month, and year.
  *
@@ -191,7 +190,7 @@ declare function isMonthlyMultiple(firstDate: Date, secondDate: Date): boolean;
  */
 declare function isSameDate(firstDate: Date, secondDate: Date): boolean;
 //#endregion
-//#region src/functions/miscellaneous/convertFileToBase64.d.ts
+//#region src/root/functions/miscellaneous/convertFileToBase64.d.ts
 /**
  * Asynchronously converts a file to a base 64 string
  *
@@ -205,7 +204,7 @@ declare function isSameDate(firstDate: Date, secondDate: Date): boolean;
  */
 declare function convertFileToBase64(file: File): Promise<string>;
 //#endregion
-//#region src/types/APIError.d.ts
+//#region src/root/types/APIError.d.ts
 type HTTPErrorCode = 400 | 401 | 403 | 404 | 418 | 500;
 declare const httpErrorCodeLookup: Record<HTTPErrorCode, string>;
 /**
@@ -231,22 +230,32 @@ declare class APIError extends Error {
   static check(input: unknown): input is APIError;
 }
 //#endregion
-//#region src/types/DataError.d.ts
+//#region src/root/types/RecordKey.d.ts
+/**
+ * Represents the native Record's possible key type.
+ *
+ * @category Types
+ */
+type RecordKey = string | number | symbol;
+//#endregion
+//#region src/root/types/DataError.d.ts
 /**
  * Represents errors you may get that may've been caused by a specific piece of data.
  *
  * @category Types
+ *
+ * @template DataType - The type of the data that caused the error.
  */
-declare class DataError extends Error {
+declare class DataError<DataType extends Record<RecordKey, unknown> = Record<RecordKey, unknown>> extends Error {
   code: string;
-  data: unknown;
+  data: DataType;
   /**
    * @param data - The data that caused the error.
    * @param code - A standardised code (e.g. UNEXPECTED_DATA).
    * @param message  - A human-readable error message (e.g. The data provided is invalid).
    * @param options - Extra options to pass to super Error constructor.
    */
-  constructor(data: unknown, code?: string, message?: string, options?: ErrorOptions);
+  constructor(data: DataType, code?: string, message?: string, options?: ErrorOptions);
   /**
    * Checks whether the given input may have been caused by a DataError.
    *
@@ -254,19 +263,32 @@ declare class DataError extends Error {
    *
    * @returns `true` if the input is a DataError, and `false` otherwise. The type of the input will also be narrowed down to DataError if `true`.
    */
-  static check(input: unknown): input is DataError;
+  static check<DataType extends Record<RecordKey, unknown> = Record<RecordKey, unknown>>(input: unknown): input is DataError<DataType>;
 }
 //#endregion
-//#region src/types/VersionNumber.d.ts
+//#region src/root/types/VersionNumber.d.ts
 /**
  * Options to apply to the stringification of the version number.
  *
  * @category Class Options
  */
-interface VersionNumberToStringOptions {
+interface FormatOptionsBase {
   /** Whether you want to omit the "v" prefix or not (defaults to false). */
   omitPrefix?: boolean;
 }
+interface FormatOptionsIncludeMinor extends FormatOptionsBase {
+  /** Whether you want to omit the minor version or not */
+  omitMinor?: false;
+  /** Whether you want to omit the patch version or not */
+  omitPatch?: boolean;
+}
+interface FormatOptionsOmitMinor extends FormatOptionsBase {
+  /** Whether you want to omit the minor version or not */
+  omitMinor?: true;
+  /** Whether you want to omit the patch version or not */
+  omitPatch?: never;
+}
+type FormatStringOptions = FormatOptionsIncludeMinor | FormatOptionsOmitMinor;
 /**
  * Represents a software version number, considered to be made up of a major, minor, and patch part.
  *
@@ -300,6 +322,14 @@ declare class VersionNumber {
    * @returns `true` if the provided version numbers have exactly the same major, minor, and patch numbers, and returns `false` otherwise.
    */
   static isEqual(firstVersion: VersionNumber, secondVersion: VersionNumber): boolean;
+  /**
+   * Get a formatted string representation of the current version number
+   *
+   * @param options - Options to apply to the string formatting.
+   *
+   * @returns A formatted string representation of the current version number with the options applied.
+   */
+  format(options?: FormatStringOptions): string;
   /**
    * Increments the current version number by the given increment type, returning the result as a new reference in memory.
    *
@@ -329,15 +359,13 @@ declare class VersionNumber {
   /**
    * Get a string representation of the current version number.
    *
-   * @param options - Extra additional options to apply.
-   *
-   * @returns A stringified representation of the current version number, leaving out the prefix if `omitPrefix` option was set to true.
+   * @returns A stringified representation of the current version number with the prefix.
    */
-  toString(options?: VersionNumberToStringOptions): string;
+  toString(): string;
 }
 declare const zodVersionNumber: z.ZodType<VersionNumber>;
 //#endregion
-//#region src/types/ArrayElement.d.ts
+//#region src/root/types/ArrayElement.d.ts
 /**
  * Gets the individual element types from an array type.
  *
@@ -347,18 +375,10 @@ declare const zodVersionNumber: z.ZodType<VersionNumber>;
  */
 type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never;
 //#endregion
-//#region src/types/CallReturnType.d.ts
+//#region src/root/types/CallReturnType.d.ts
 type CallReturnType<Function, Arguments> = Function extends ((arg: Arguments) => infer Return) ? Return : never;
 //#endregion
-//#region src/types/RecordKey.d.ts
-/**
- * Represents the native Record's possible key type.
- *
- * @category Types
- */
-type RecordKey = string | number | symbol;
-//#endregion
-//#region src/types/CreateEnumType.d.ts
+//#region src/root/types/CreateEnumType.d.ts
 /**
  * Get the value types from a const object so the object can behave similarly to an enum.
  *
@@ -368,7 +388,7 @@ type RecordKey = string | number | symbol;
  */
 type CreateEnumType<ObjectType extends Record<RecordKey, unknown>> = ObjectType[keyof ObjectType];
 //#endregion
-//#region src/types/DisallowUndefined.d.ts
+//#region src/root/types/DisallowUndefined.d.ts
 /**
  * Resolves to an error message type if the type argument could potentially be undefined.
  *
@@ -378,7 +398,7 @@ type CreateEnumType<ObjectType extends Record<RecordKey, unknown>> = ObjectType[
  */
 type DisallowUndefined<InputType> = undefined extends InputType ? ["Error: Generic type cannot include undefined"] : InputType;
 //#endregion
-//#region src/types/IgnoreCase.d.ts
+//#region src/root/types/IgnoreCase.d.ts
 /**
  * Allows case-insensitive variants of a known string type.
  *
@@ -388,10 +408,10 @@ type DisallowUndefined<InputType> = undefined extends InputType ? ["Error: Gener
  */
 type IgnoreCase<StringType extends string> = string extends StringType ? string : StringType extends `${infer FirstCharacter}${infer SecondCharacter}${infer Remainder}` ? `${Uppercase<FirstCharacter> | Lowercase<FirstCharacter>}${Uppercase<SecondCharacter> | Lowercase<SecondCharacter>}${IgnoreCase<Remainder>}` : StringType extends `${infer FirstCharacter}${infer Remainder}` ? `${Uppercase<FirstCharacter> | Lowercase<FirstCharacter>}${IgnoreCase<Remainder>}` : "";
 //#endregion
-//#region src/types/IsTypeArgumentString.d.ts
+//#region src/root/types/IsTypeArgumentString.d.ts
 type IsTypeArgumentString<Argument extends string> = Argument;
 //#endregion
-//#region src/types/NonUndefined.d.ts
+//#region src/root/types/NonUndefined.d.ts
 /**
  * Resolves to `never` if the given type may be undefined.
  *
@@ -401,7 +421,7 @@ type IsTypeArgumentString<Argument extends string> = Argument;
  */
 type NonUndefined<InputType> = InputType extends undefined ? never : InputType;
 //#endregion
-//#region src/types/OptionalOnCondition.d.ts
+//#region src/root/types/OptionalOnCondition.d.ts
 /**
  * Resolves to the given type if the first type is `true`, otherwise resolves to `undefined`
  *
@@ -412,7 +432,7 @@ type NonUndefined<InputType> = InputType extends undefined ? never : InputType;
  */
 type OptionalOnCondition<Condition extends boolean, ResolvedTypeIfTrue> = Condition extends true ? ResolvedTypeIfTrue : ResolvedTypeIfTrue | undefined;
 //#endregion
-//#region src/functions/miscellaneous/createFormData.d.ts
+//#region src/root/functions/miscellaneous/createFormData.d.ts
 type FormDataNullableResolutionStrategy = "stringify" | "empty" | "omit";
 type FormDataArrayResolutionStrategy = "stringify" | "multiple";
 /**
@@ -478,7 +498,25 @@ type CreateFormDataOptions<Key extends RecordKey> = CreateFormDataOptionsUndefin
  */
 declare function createFormData<DataType extends Record<RecordKey, unknown>>(data: DataType, options?: CreateFormDataOptions<keyof DataType>): FormData;
 //#endregion
-//#region src/functions/miscellaneous/getRandomNumber.d.ts
+//#region src/root/functions/miscellaneous/getDependenciesFromGroup.d.ts
+declare const DependencyGroup: {
+  readonly DEPENDENCIES: "dependencies";
+  readonly DEV_DEPENDENCIES: "devDependencies";
+};
+type DependencyGroup = CreateEnumType<typeof DependencyGroup>;
+/**
+ * Get the dependencies from a given dependency group in `package.json`.
+ *
+ * @category Miscellaneous
+ *
+ * @param packageInfo - The data coming from `package.json`.
+ * @param dependencyGroup - The group to get dependency information about (can be `dependencies` or `devDependencies`).
+ *
+ * @returns A record consisting of the package names and version ranges from the given dependency group.
+ */
+declare function getDependenciesFromGroup(packageInfo: Record<string, unknown>, dependencyGroup: DependencyGroup): Record<string, string>;
+//#endregion
+//#region src/root/functions/miscellaneous/getRandomNumber.d.ts
 /**
  * Gets a random number between the given bounds.
  *
@@ -491,7 +529,7 @@ declare function createFormData<DataType extends Record<RecordKey, unknown>>(dat
  */
 declare function getRandomNumber(lowerBound: number, upperBound: number): number;
 //#endregion
-//#region src/functions/miscellaneous/isOrdered.d.ts
+//#region src/root/functions/miscellaneous/isOrdered.d.ts
 /**
  * Checks to see if the given array is sorted in ascending order.
  *
@@ -503,7 +541,7 @@ declare function getRandomNumber(lowerBound: number, upperBound: number): number
  */
 declare function isOrdered(array: readonly number[]): boolean;
 //#endregion
-//#region src/functions/miscellaneous/sayHello.d.ts
+//#region src/root/functions/miscellaneous/sayHello.d.ts
 /**
  * Returns a string representing the lyrics to the package's theme song, Commit To You
  *
@@ -513,7 +551,7 @@ declare function isOrdered(array: readonly number[]): boolean;
  */
 declare function sayHello(): string;
 //#endregion
-//#region src/functions/miscellaneous/stringifyDotenv.d.ts
+//#region src/root/functions/miscellaneous/stringifyDotenv.d.ts
 type QuoteStyle = "double" | "single" | "none";
 interface StringifyDotenvOptions {
   /** The quote style to use for the values (defaults to `"double"`) */
@@ -529,7 +567,7 @@ interface StringifyDotenvOptions {
  */
 declare function stringifyDotenv(contents: Record<RecordKey, string> | DotenvParseOutput, options?: StringifyDotenvOptions): string;
 //#endregion
-//#region src/functions/miscellaneous/stringListToArray.d.ts
+//#region src/root/functions/miscellaneous/stringListToArray.d.ts
 /**
  * Options to apply to the conversion of a string list to an array.
  *
@@ -558,7 +596,7 @@ declare function stringListToArray(stringList: string, {
   trimWhitespace
 }?: StringListToArrayOptions): string[];
 //#endregion
-//#region src/functions/miscellaneous/wait.d.ts
+//#region src/root/functions/miscellaneous/wait.d.ts
 /**
  * Waits for the given number of seconds
  *
@@ -570,7 +608,7 @@ declare function stringListToArray(stringList: string, {
  */
 declare function wait(seconds: number): Promise<void>;
 //#endregion
-//#region src/functions/objectHelpers/getRecordKeys.d.ts
+//#region src/root/functions/objectHelpers/getRecordKeys.d.ts
 /**
  * Gets the keys from a given record object, properly typed to be an array of the key of the input object's type.
  *
@@ -584,7 +622,7 @@ declare function wait(seconds: number): Promise<void>;
  */
 declare function getRecordKeys<InputRecordType extends Record<RecordKey, unknown>>(record: InputRecordType & object): (keyof InputRecordType)[];
 //#endregion
-//#region src/functions/objectHelpers/omitProperties.d.ts
+//#region src/root/functions/objectHelpers/omitProperties.d.ts
 /**
  * Omits properties from a given object.
  *
@@ -600,7 +638,7 @@ declare function getRecordKeys<InputRecordType extends Record<RecordKey, unknown
  */
 declare function omitProperties<ObjectType extends Record<string, unknown> | Readonly<Record<string, unknown>>, KeysToOmit extends keyof ObjectType>(object: ObjectType, keysToOmit: KeysToOmit | readonly KeysToOmit[]): Omit<ObjectType, KeysToOmit>;
 //#endregion
-//#region src/functions/objectHelpers/removeUndefinedFromObject.d.ts
+//#region src/root/functions/objectHelpers/removeUndefinedFromObject.d.ts
 type RemoveUndefined<RecordType extends Record<RecordKey, unknown>> = { [Key in keyof RecordType]: Exclude<RecordType[Key], undefined> };
 /**
  * Removes entries whose values are `undefined` from a given object (not including null etc.).
@@ -611,7 +649,7 @@ type RemoveUndefined<RecordType extends Record<RecordKey, unknown>> = { [Key in
  */
 declare function removeUndefinedFromObject<RecordType extends Record<RecordKey, unknown>>(object: RecordType): RemoveUndefined<RecordType>;
 //#endregion
-//#region src/functions/parsers/parseBoolean.d.ts
+//#region src/root/functions/parsers/parseBoolean.d.ts
 /**
  * Takes a stringly-typed boolean and converts it to an actual boolean type.
  *
@@ -625,7 +663,7 @@ declare function removeUndefinedFromObject<RecordType extends Record<RecordKey,
  */
 declare function parseBoolean(inputString: string): boolean;
 //#endregion
-//#region src/functions/parsers/parseEnv.d.ts
+//#region src/root/functions/parsers/parseEnv.d.ts
 /**
  * Represents the three common development environments.
  *
@@ -642,15 +680,15 @@ type Env = CreateEnumType<typeof Env>;
  *
  * @category Parsers
  *
- * @param data - The data to parse.
+ * @param input - The data to parse.
  *
  * @throws {DataError} If the data does not match one of the environments allowed by the Env types ("test" | "development" | "production").
  *
  * @returns The specified environment if allowed.
  */
-declare function parseEnv(data: unknown): Env;
+declare function parseEnv(input: unknown): Env;
 //#endregion
-//#region src/functions/parsers/parseFilePath.d.ts
+//#region src/root/functions/parsers/parseFilePath.d.ts
 interface FilePathData {
   /** The file path without the final part. */
   directory: string;
@@ -672,7 +710,7 @@ interface FilePathData {
  */
 declare function parseFilePath(filePath: string): FilePathData;
 //#endregion
-//#region src/functions/parsers/parseFormData.d.ts
+//#region src/root/functions/parsers/parseFormData.d.ts
 /**
  * Returns a parsed object given FormData and a data parser function to call on the resulting object.
  *
@@ -693,7 +731,7 @@ declare function parseFormData<DataType>(formData: FormData, dataParser: (data:
  */
 declare function parseFormData(formData: FormData): Record<string, string | Blob>;
 //#endregion
-//#region src/functions/parsers/parseIntStrict.d.ts
+//#region src/root/functions/parsers/parseIntStrict.d.ts
 /**
  * Converts a string to an integer and throws an error if it cannot be converted.
  *
@@ -708,7 +746,7 @@ declare function parseFormData(formData: FormData): Record<string, string | Blob
  */
 declare function parseIntStrict(string: string, radix?: number): number;
 //#endregion
-//#region src/functions/parsers/parseVersionType.d.ts
+//#region src/root/functions/parsers/parseVersionType.d.ts
 /**
  * Represents the three common software version types.
  *
@@ -725,15 +763,15 @@ type VersionType = CreateEnumType<typeof VersionType>;
  *
  * @category Parsers
  *
- * @param data - The data to parse.
+ * @param input - The data to parse.
  *
  * @throws {DataError} If the data does not match one of the allowed version types (`"major" | "minor" | "patch"`).
  *
  * @returns The given version type if allowed.
  */
-declare function parseVersionType(data: unknown): VersionType;
+declare function parseVersionType(input: unknown): VersionType;
 //#endregion
-//#region src/functions/parsers/zod/parseZodSchema.d.ts
+//#region src/root/functions/parsers/zod/parseZodSchema.d.ts
 /**
  * An alternative function to zodSchema.parse() that can be used to strictly parse Zod schemas.
  *
@@ -745,16 +783,16 @@ declare function parseVersionType(data: unknown): VersionType;
  * @template ErrorType - The type of error to throw on invalid data.
  *
  * @param schema - The Zod schema to use in parsing.
- * @param data - The data to parse.
+ * @param input - The data to parse.
  * @param onError - A custom error to throw on invalid data (defaults to `DataError`). May either be the error itself, or a function that returns the error or nothing. If nothing is returned, the default error is thrown instead.
  *
  * @throws {DataError} If the given data cannot be parsed according to the schema.
  *
  * @returns The parsed data from the Zod schema.
  */
-declare function parseZodSchema<SchemaType extends ZodType, ErrorType extends Error = DataError>(schema: SchemaType, data: unknown, onError?: ErrorType | ((zodError: ZodError) => ErrorType | void)): z$1.infer<SchemaType>;
+declare function parseZodSchema<SchemaType extends ZodType, ErrorType extends Error = DataError>(schema: SchemaType, input: unknown, onError?: ErrorType | ((zodError: ZodError) => ErrorType | void)): z$1.infer<SchemaType>;
 //#endregion
-//#region src/functions/parsers/zod/parseZodSchemaAsync.d.ts
+//#region src/root/functions/parsers/zod/parseZodSchemaAsync.d.ts
 /**
  * An alternative function to zodSchema.parseAsync() that can be used to strictly parse asynchronous Zod schemas.
  *
@@ -764,16 +802,16 @@ declare function parseZodSchema<SchemaType extends ZodType, ErrorType extends Er
  * @template ErrorType - The type of error to throw on invalid data.
  *
  * @param schema - The Zod schema to use in parsing.
- * @param data - The data to parse.
+ * @param input - The data to parse.
  * @param onError - A custom error to throw on invalid data (defaults to `DataError`). May either be the error itself, or a function that returns the error or nothing. If nothing is returned, the default error is thrown instead.
  *
  * @throws {DataError} If the given data cannot be parsed according to the schema.
  *
  * @returns The parsed data from the Zod schema.
  */
-declare function parseZodSchemaAsync<SchemaType extends ZodType, ErrorType extends Error = DataError>(schema: SchemaType, data: unknown, onError?: ErrorType | ((zodError: ZodError) => ErrorType | void)): Promise<z$1.infer<SchemaType>>;
+declare function parseZodSchemaAsync<SchemaType extends ZodType, ErrorType extends Error = DataError>(schema: SchemaType, input: unknown, onError?: ErrorType | ((zodError: ZodError) => ErrorType | void)): Promise<z$1.infer<SchemaType>>;
 //#endregion
-//#region src/functions/recursive/deepCopy.d.ts
+//#region src/root/functions/recursive/deepCopy.d.ts
 /**
  * Deeply copies an object or array such that all child objects/arrays are also copied.
  *
@@ -787,7 +825,7 @@ declare function parseZodSchemaAsync<SchemaType extends ZodType, ErrorType exten
  */
 declare function deepCopy<ObjectType extends object>(object: ObjectType): ObjectType;
 //#endregion
-//#region src/functions/recursive/deepFreeze.d.ts
+//#region src/root/functions/recursive/deepFreeze.d.ts
 /**
  * Deeply freezes an object or array such that all child objects/arrays are also frozen.
  *
@@ -804,7 +842,7 @@ declare function deepCopy<ObjectType extends object>(object: ObjectType): Object
  */
 declare function deepFreeze<ObjectType extends object>(object: ObjectType): Readonly<ObjectType>;
 //#endregion
-//#region src/functions/security/encryptWithKey.d.ts
+//#region src/root/functions/security/encryptWithKey.d.ts
 /**
  * Encrypt a secret given the public base64 key and the thing you want to encrypt.
  *
@@ -815,57 +853,7 @@ declare function deepFreeze<ObjectType extends object>(object: ObjectType): Read
  */
 declare function encryptWithKey(publicKey: string, plaintextValue: string): Promise<string>;
 //#endregion
-//#region src/functions/security/getPublicAndPrivateKey.d.ts
-interface PublicAndPrivateKey<KeyType extends Uint8Array | string> {
-  /** The generated public key from libsodium */
-  publicKey: KeyType;
-  /** The generated private key from libsodium */
-  privateKey: KeyType;
-  /** The key type from libsodium */
-  keyType: ReturnType<typeof sodium.crypto_box_keypair>["keyType"];
-}
-/**
- * Returns the public key and private key, properly narrowing down types depending on the provided `outputFormat`.
- *
- * @deprecated Please use `sodium.crypto_box_keypair` from `libsodium-wrappers` instead.
- *
- * This function was initially created to deal with a typing issue with the package introduced in v0.8.1 of said package, but this seems to have been fixed in v0.8.2
- *
- * @returns An object containing both the publicKey and privateKey, along with a keyType.
- *
- * Because you have not provided an `outputFormat`, the keys will be typed as `Uint8Array`.
- */
-declare function getPublicAndPrivateKey(): PublicAndPrivateKey<Uint8Array>;
-/**
- * Returns the public key and private key, properly narrowing down types depending on the provided `outputFormat`.
- *
- * @deprecated Please use `sodium.crypto_box_keypair` from `libsodium-wrappers` instead.
- *
- * This function was initially created to deal with a typing issue with the package introduced in v0.8.1 of said package, but this seems to have been fixed in v0.8.2
- *
- * @param outputFormat - The format of the resulting publicKey and privateKey you would like to use.
- *
- * @returns An object containing both the publicKey and privateKey, along with a keyType.
- *
- * Because you provided an `outputFormat` of `uint8array`, the keys will be typed as `Uint8Array`.
- */
-declare function getPublicAndPrivateKey(outputFormat: "uint8array"): PublicAndPrivateKey<Uint8Array>;
-/**
- * Returns the public key and private key, properly narrowing down types depending on the provided `outputFormat`.
- *
- * @deprecated Please use `sodium.crypto_box_keypair` from `libsodium-wrappers` instead.
- *
- * This function was initially created to deal with a typing issue with the package introduced in v0.8.1 of said package, but this seems to have been fixed in v0.8.2
- *
- * @param outputFormat - The format of the resulting publicKey and privateKey you would like to use.
- *
- * @returns An object containing both the publicKey and privateKey, along with a keyType.
- *
- * Because you provided an `outputFormat` of either `text`, `hex` or `base64`, the keys will be typed as `string`.
- */
-declare function getPublicAndPrivateKey(outputFormat: "text" | "hex" | "base64"): PublicAndPrivateKey<string>;
-//#endregion
-//#region src/functions/stringHelpers/appendSemicolon.d.ts
+//#region src/root/functions/stringHelpers/appendSemicolon.d.ts
 /**
  * Appends a semicolon to the end of a string, trimming where necessary first.
  *
@@ -879,7 +867,7 @@ declare function getPublicAndPrivateKey(outputFormat: "text" | "hex" | "base64")
  */
 declare function appendSemicolon(stringToAppendTo: string): string;
 //#endregion
-//#region src/functions/stringHelpers/camelToKebab.d.ts
+//#region src/root/functions/stringHelpers/camelToKebab.d.ts
 /**
  * Options to apply to the conversion from camelCase to kebab-case
  *
@@ -901,7 +889,7 @@ interface CamelToKebabOptions {
  */
 declare function camelToKebab(string: string, options?: CamelToKebabOptions): string;
 //#endregion
-//#region src/functions/stringHelpers/kebabToCamel.d.ts
+//#region src/root/functions/stringHelpers/kebabToCamel.d.ts
 /**
  * Options to apply to the conversion from kebab-case to camelCase
  *
@@ -923,39 +911,7 @@ interface KebabToCamelOptions {
  */
 declare function kebabToCamel(string: string, options?: KebabToCamelOptions): string;
 //#endregion
-//#region src/functions/stringHelpers/normalizeImportPath.d.ts
-/**
- * Normalizes an import path meant for use in an import statement in JavaScript.
- * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. If the path is a zero-length string, '.' is returned, representing the current working directory.
- *
- * If the path starts with ./, it is preserved (unlike what would happen with path.posix.normalize() normally).
- *
- * Helpful for custom linter rules that need to check (or fix) import paths.
- *
- * @category String Helpers
- *
- * @param importPath - The import path to normalize.
- *
- * @returns The import path normalized.
- */
-declare function normalizeImportPath(importPath: string): string;
-/**
- * Normalises an import path meant for use in an import statement in JavaScript.
- * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. If the path is a zero-length string, '.' is returned, representing the current working directory.
- *
- * If the path starts with ./, it is preserved (unlike what would happen with path.posix.normalize() normally).
- *
- * Helpful for custom linter rules that need to check (or fix) import paths.
- *
- * @category String Helpers
- *
- * @param importPath - The import path to normalise.
- *
- * @returns The import path normalised.
- */
-declare const normaliseImportPath: typeof normalizeImportPath;
-//#endregion
-//#region src/functions/stringHelpers/truncate.d.ts
+//#region src/root/functions/stringHelpers/truncate.d.ts
 /**
  * Truncates a string and appends `...` to the end of it
  *
@@ -968,7 +924,7 @@ declare const normaliseImportPath: typeof normalizeImportPath;
  */
 declare function truncate(stringToTruncate: string, maxLength?: number): string;
 //#endregion
-//#region src/functions/taggedTemplate/createTemplateStringsArray.d.ts
+//#region src/root/functions/taggedTemplate/createTemplateStringsArray.d.ts
 /**
  * Creates a template strings array given a regular array of strings
  *
@@ -980,28 +936,7 @@ declare function truncate(stringToTruncate: string, maxLength?: number): string;
  */
 declare function createTemplateStringsArray(strings: readonly string[]): TemplateStringsArray;
 //#endregion
-//#region src/functions/taggedTemplate/getInterpolations.d.ts
-/**
- *
- * Gets the strings and interpolations separately from a template string.
- * You can pass a template string directly by doing:
- *
- * ```typescript
- * getInterpolations`Template string here`.
- * ```
- *
- * @category Tagged Template
- *
- * @deprecated Please use `getStringsAndInterpolations` instead.
- *
- * @param strings - The strings from the template to process.
- * @param interpolations - An array of all interpolations from the template.
- *
- * @returns A tuple where the first item is the strings from the template, and the second is the interpolations.
- */
-declare function getInterpolations(strings: TemplateStringsArray, ...interpolations: unknown[]): [TemplateStringsArray, unknown[]];
-//#endregion
-//#region src/functions/taggedTemplate/getStringsAndInterpolations.d.ts
+//#region src/root/functions/taggedTemplate/getStringsAndInterpolations.d.ts
 /**
  *
  * Gets the strings and interpolations separately from a template string.
@@ -1033,7 +968,7 @@ declare function getInterpolations(strings: TemplateStringsArray, ...interpolati
  */
 declare function getStringsAndInterpolations<const InterpolationsType extends readonly unknown[]>(strings: TemplateStringsArray, ...interpolations: InterpolationsType): [TemplateStringsArray, ...InterpolationsType];
 //#endregion
-//#region src/functions/taggedTemplate/interpolate.d.ts
+//#region src/root/functions/taggedTemplate/interpolate.d.ts
 /**
  * Returns the result of interpolating a template string when given the strings and interpolations separately.
  *
@@ -1056,7 +991,7 @@ declare function getStringsAndInterpolations<const InterpolationsType extends re
  */
 declare function interpolate<const InterpolationsType extends readonly unknown[]>(strings: TemplateStringsArray, ...interpolations: InterpolationsType): string;
 //#endregion
-//#region src/functions/taggedTemplate/interpolateObjects.d.ts
+//#region src/root/functions/taggedTemplate/interpolateObjects.d.ts
 /**
  * Returns the result of interpolating a template string, also stringifying objects.
  *
@@ -1077,7 +1012,7 @@ declare function interpolate<const InterpolationsType extends readonly unknown[]
  */
 declare function interpolateObjects<const InterpolationsType extends readonly unknown[]>(strings: TemplateStringsArray, ...interpolations: InterpolationsType): string;
 //#endregion
-//#region src/functions/taggedTemplate/isTemplateStringsArray.d.ts
+//#region src/root/functions/taggedTemplate/isTemplateStringsArray.d.ts
 /**
  * Determines whether or not the input is a valid `TemplateStringsArray`.
  *
@@ -1089,7 +1024,7 @@ declare function interpolateObjects<const InterpolationsType extends readonly un
  */
 declare function isTemplateStringsArray(input: unknown): input is TemplateStringsArray;
 //#endregion
-//#region src/functions/taggedTemplate/normaliseIndents.d.ts
+//#region src/root/functions/taggedTemplate/normaliseIndents.d.ts
 /**
  * Options to apply to the normalisation of indents in multi-line template strings
  *
@@ -1157,75 +1092,4 @@ declare function normaliseIndents(strings: TemplateStringsArray, ...interpolatio
  */
 declare const normalizeIndents: typeof normaliseIndents;
 //#endregion
-//#region src/functions/versioning/determineVersionType.d.ts
-/**
- * Determines whether the given version is a major, minor, or patch version.
- *
- * @deprecated This function does not support the new class-based handling of VersionNumber. Please use `new VersionNumber(version).type` instead.
- *
- * @param version - The version number.
- *
- * @returns Either `"major"`, `"minor"`, or `"patch"`, depending on the version type.
- */
-declare function determineVersionType(version: string): VersionType;
-//#endregion
-//#region src/functions/versioning/getIndividualVersionNumbers.d.ts
-/**
- * Gets the individual version numbers from a given version number as a tuple of numbers.
- *
- * @deprecated This function does not support the new class-based handling of VersionNumber. Please use one of the following instead:
- *      ```typescript
- *      new VersionNumber(version).major
- *      new VersionNumber(version).minor
- *      new VersionNumber(version).patch
- *      ```
- *
- * @param version - The version number.
- *
- * @returns A tuple of three numbers indicating `[major, minor, patch]`.
- */
-declare function getIndividualVersionNumbers(version: string): [number, number, number];
-//#endregion
-//#region src/functions/versioning/incrementVersion.d.ts
-interface IncrementVersionOptions {
-  /** Whether to omit the `v` prefix from the output version or not. */
-  omitPrefix?: boolean;
-}
-/**
- * Increments the given input version depending on the given increment type.
- *
- * @deprecated This function does not support the new class-based handling of VersionNumber. Please use `new VersionNumber(version).increment(incrementType)` instead.
- *
- * @param version - The version to increment
- * @param incrementType - The type of increment. Can be one of the following:
- * - `"major"`: Change the major version `v1.2.3` → `v2.0.0`
- * - `"minor"`: Change the minor version `v1.2.3` → `v1.3.0`
- * - `"patch"`: Change the patch version `v1.2.3` → `v1.2.4`
- * @param options - Extra options to apply.
- *
- * @returns A new string representing the version with the increment applied.
- */
-declare function incrementVersion(version: string, incrementType: VersionType, options?: IncrementVersionOptions): string;
-//#endregion
-//#region src/functions/versioning/parseVersion.d.ts
-interface ParseVersionOptions {
-  /** Whether to omit the `v` prefix from the output version or not. */
-  omitPrefix?: boolean;
-}
-/**
- * Parses a string and verifies it is a valid package version number.
- *
- * Valid formats: `X.Y.Z` or `vX.Y.Z`, where X, Y, and Z are non-negative integers.
- *
- * @deprecated This function does not support the new class-based handling of VersionNumber. Please use `new VersionNumber(input)` instead.
- *
- * @param input - The version string to parse.
- * @param options - Extra options to apply.
- *
- * @throws {DataError} If the input is not a valid version number.
- *
- * @returns The validated version number, prefixed with `v` if it was not already.
- */
-declare function parseVersion(input: string, options?: ParseVersionOptions): string;
-//#endregion
-export { APIError, ArrayElement, CallReturnType, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FILE_PATH_REGEX, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, IsTypeArgumentString, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, ParseVersionOptions, PublicAndPrivateKey, RecordKey, RemoveUndefined, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getPublicAndPrivateKey, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFilePath, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };
+export { APIError, ArrayElement, CallReturnType, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FILE_PATH_REGEX, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IsTypeArgumentString, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getDependenciesFromGroup, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFilePath, parseFormData, parseIntStrict, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };