@alextheman/utility 4.8.0 → 4.9.0

package/dist/index.cjs

@@ -851,25 +851,8 @@ function parseBoolean(inputString) {
 var parseBoolean_default = parseBoolean;
 
 //#endregion
-//#region src/functions/parsers/parseZodSchema.ts
-/**
-* An alternative function to zodSchema.parse() that can be used to strictly parse Zod schemas.
-*
-* @category Parsers
-*
-* @template SchemaType - The Zod schema type.
-* @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 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.
-*/
-function parseZodSchema(schema, data, onError) {
-	const parsedResult = schema.safeParse(data);
+//#region src/functions/parsers/zod/_parseZodSchema.ts
+function _parseZodSchema(parsedResult, data, onError) {
 	if (!parsedResult.success) {
 		if (onError) {
 			if (onError instanceof Error) throw onError;
@@ -887,10 +870,35 @@ function parseZodSchema(schema, data, onError) {
 			return secondCount - firstCount;
 		}).map(([code, count], _, allErrorCodes$1) => {
 			return allErrorCodes$1.length === 1 && count === 1 ? code : `${code}×${count}`;
-		}).join(","), `\n\n${zod.z.prettifyError(parsedResult.error)}\n`);
+		}).join(","), `\n\n${zod.default.prettifyError(parsedResult.error)}\n`);
 	}
 	return parsedResult.data;
 }
+var _parseZodSchema_default = _parseZodSchema;
+
+//#endregion
+//#region src/functions/parsers/zod/parseZodSchema.ts
+/**
+* An alternative function to zodSchema.parse() that can be used to strictly parse Zod schemas.
+*
+* NOTE: Use `parseZodSchemaAsync` if your schema includes an asynchronous function.
+*
+* @category Parsers
+*
+* @template SchemaType - The Zod schema type.
+* @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 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.
+*/
+function parseZodSchema(schema, data, onError) {
+	return _parseZodSchema_default(schema.safeParse(data), data, onError);
+}
 var parseZodSchema_default = parseZodSchema;
 
 //#endregion
@@ -973,6 +981,29 @@ function parseVersionType(data) {
 }
 var parseVersionType_default = parseVersionType;
 
+//#endregion
+//#region src/functions/parsers/zod/parseZodSchemaAsync.ts
+/**
+* An alternative function to zodSchema.parseAsync() that can be used to strictly parse asynchronous Zod schemas.
+*
+* @category Parsers
+*
+* @template SchemaType - The Zod schema type.
+* @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 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.
+*/
+async function parseZodSchemaAsync(schema, data, onError) {
+	return _parseZodSchema_default(await schema.safeParseAsync(data), data, onError);
+}
+var parseZodSchemaAsync_default = parseZodSchemaAsync;
+
 //#endregion
 //#region src/functions/recursive/deepCopy.ts
 function callDeepCopy(input) {
@@ -1527,6 +1558,7 @@ exports.parseIntStrict = parseIntStrict_default;
 exports.parseVersion = parseVersion_default;
 exports.parseVersionType = parseVersionType_default;
 exports.parseZodSchema = parseZodSchema_default;
+exports.parseZodSchemaAsync = parseZodSchemaAsync_default;
 exports.randomiseArray = randomiseArray_default;
 exports.range = range_default;
 exports.removeDuplicates = removeDuplicates_default;

package/dist/index.d.cts

@@ -678,10 +678,12 @@ type VersionType = CreateEnumType<typeof VersionType>;
  */
 declare function parseVersionType(data: unknown): VersionType;
 //#endregion
-//#region src/functions/parsers/parseZodSchema.d.ts
+//#region src/functions/parsers/zod/parseZodSchema.d.ts
 /**
  * An alternative function to zodSchema.parse() that can be used to strictly parse Zod schemas.
  *
+ * NOTE: Use `parseZodSchemaAsync` if your schema includes an asynchronous function.
+ *
  * @category Parsers
  *
  * @template SchemaType - The Zod schema type.
@@ -697,6 +699,25 @@ declare function parseVersionType(data: unknown): VersionType;
  */
 declare function parseZodSchema<SchemaType extends ZodType, ErrorType extends Error>(schema: SchemaType, data: unknown, onError?: ErrorType | ((zodError: ZodError) => ErrorType | void)): z.infer<SchemaType>;
 //#endregion
+//#region src/functions/parsers/zod/parseZodSchemaAsync.d.ts
+/**
+ * An alternative function to zodSchema.parseAsync() that can be used to strictly parse asynchronous Zod schemas.
+ *
+ * @category Parsers
+ *
+ * @template SchemaType - The Zod schema type.
+ * @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 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>(schema: SchemaType, data: unknown, onError?: ErrorType | ((zodError: ZodError) => ErrorType | void)): Promise<z.infer<SchemaType>>;
+//#endregion
 //#region src/functions/recursive/deepCopy.d.ts
 /**
  * Deeply copies an object or array such that all child objects/arrays are also copied.
@@ -1051,4 +1072,4 @@ interface ParseVersionOptions {
  */
 declare function parseVersion(input: string, options?: ParseVersionOptions): string;
 //#endregion
-export { APIError, ArrayElement, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, stringifyDotenv, truncate, wait };
+export { APIError, ArrayElement, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, stringListToArray, stringifyDotenv, truncate, wait };

package/dist/index.d.ts

@@ -678,10 +678,12 @@ type VersionType = CreateEnumType<typeof VersionType>;
  */
 declare function parseVersionType(data: unknown): VersionType;
 //#endregion
-//#region src/functions/parsers/parseZodSchema.d.ts
+//#region src/functions/parsers/zod/parseZodSchema.d.ts
 /**
  * An alternative function to zodSchema.parse() that can be used to strictly parse Zod schemas.
  *
+ * NOTE: Use `parseZodSchemaAsync` if your schema includes an asynchronous function.
+ *
  * @category Parsers
  *
  * @template SchemaType - The Zod schema type.
@@ -697,6 +699,25 @@ declare function parseVersionType(data: unknown): VersionType;
  */
 declare function parseZodSchema<SchemaType extends ZodType, ErrorType extends Error>(schema: SchemaType, data: unknown, onError?: ErrorType | ((zodError: ZodError) => ErrorType | void)): z$1.infer<SchemaType>;
 //#endregion
+//#region src/functions/parsers/zod/parseZodSchemaAsync.d.ts
+/**
+ * An alternative function to zodSchema.parseAsync() that can be used to strictly parse asynchronous Zod schemas.
+ *
+ * @category Parsers
+ *
+ * @template SchemaType - The Zod schema type.
+ * @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 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>(schema: SchemaType, data: unknown, onError?: ErrorType | ((zodError: ZodError) => ErrorType | void)): Promise<z$1.infer<SchemaType>>;
+//#endregion
 //#region src/functions/recursive/deepCopy.d.ts
 /**
  * Deeply copies an object or array such that all child objects/arrays are also copied.
@@ -1051,4 +1072,4 @@ interface ParseVersionOptions {
  */
 declare function parseVersion(input: string, options?: ParseVersionOptions): string;
 //#endregion
-export { APIError, ArrayElement, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, type IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, type ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, stringifyDotenv, truncate, wait };
+export { APIError, ArrayElement, CamelToKebabOptions, CreateEnumType, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, type IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParallelTuple, type ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionNumber, VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, encryptWithKey, fillArray, formatDateAndTime, getIndividualVersionNumbers, getInterpolations, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, stringListToArray, stringifyDotenv, truncate, wait };

package/dist/index.js

@@ -821,25 +821,8 @@ function parseBoolean(inputString) {
 var parseBoolean_default = parseBoolean;
 
 //#endregion
-//#region src/functions/parsers/parseZodSchema.ts
-/**
-* An alternative function to zodSchema.parse() that can be used to strictly parse Zod schemas.
-*
-* @category Parsers
-*
-* @template SchemaType - The Zod schema type.
-* @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 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.
-*/
-function parseZodSchema(schema, data, onError) {
-	const parsedResult = schema.safeParse(data);
+//#region src/functions/parsers/zod/_parseZodSchema.ts
+function _parseZodSchema(parsedResult, data, onError) {
 	if (!parsedResult.success) {
 		if (onError) {
 			if (onError instanceof Error) throw onError;
@@ -857,10 +840,35 @@ function parseZodSchema(schema, data, onError) {
 			return secondCount - firstCount;
 		}).map(([code, count], _, allErrorCodes$1) => {
 			return allErrorCodes$1.length === 1 && count === 1 ? code : `${code}×${count}`;
-		}).join(","), `\n\n${z$1.prettifyError(parsedResult.error)}\n`);
+		}).join(","), `\n\n${z.prettifyError(parsedResult.error)}\n`);
 	}
 	return parsedResult.data;
 }
+var _parseZodSchema_default = _parseZodSchema;
+
+//#endregion
+//#region src/functions/parsers/zod/parseZodSchema.ts
+/**
+* An alternative function to zodSchema.parse() that can be used to strictly parse Zod schemas.
+*
+* NOTE: Use `parseZodSchemaAsync` if your schema includes an asynchronous function.
+*
+* @category Parsers
+*
+* @template SchemaType - The Zod schema type.
+* @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 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.
+*/
+function parseZodSchema(schema, data, onError) {
+	return _parseZodSchema_default(schema.safeParse(data), data, onError);
+}
 var parseZodSchema_default = parseZodSchema;
 
 //#endregion
@@ -943,6 +951,29 @@ function parseVersionType(data) {
 }
 var parseVersionType_default = parseVersionType;
 
+//#endregion
+//#region src/functions/parsers/zod/parseZodSchemaAsync.ts
+/**
+* An alternative function to zodSchema.parseAsync() that can be used to strictly parse asynchronous Zod schemas.
+*
+* @category Parsers
+*
+* @template SchemaType - The Zod schema type.
+* @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 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.
+*/
+async function parseZodSchemaAsync(schema, data, onError) {
+	return _parseZodSchema_default(await schema.safeParseAsync(data), data, onError);
+}
+var parseZodSchemaAsync_default = parseZodSchemaAsync;
+
 //#endregion
 //#region src/functions/recursive/deepCopy.ts
 function callDeepCopy(input) {
@@ -1451,4 +1482,4 @@ function incrementVersion(version, incrementType, options) {
 var incrementVersion_default = incrementVersion;
 
 //#endregion
-export { APIError_default as APIError, DataError_default as DataError, Env, NAMESPACE_EXPORT_REGEX_default as NAMESPACE_EXPORT_REGEX, VERSION_NUMBER_REGEX_default as VERSION_NUMBER_REGEX, VersionNumber_default as VersionNumber, VersionType, addDaysToDate_default as addDaysToDate, appendSemicolon_default as appendSemicolon, camelToKebab_default as camelToKebab, convertFileToBase64_default as convertFileToBase64, createFormData_default as createFormData, createTemplateStringsArray_default as createTemplateStringsArray, deepCopy_default as deepCopy, deepFreeze_default as deepFreeze, determineVersionType_default as determineVersionType, encryptWithKey_default as encryptWithKey, fillArray_default as fillArray, formatDateAndTime_default as formatDateAndTime, getIndividualVersionNumbers_default as getIndividualVersionNumbers, getInterpolations_default as getInterpolations, getRandomNumber_default as getRandomNumber, getRecordKeys_default as getRecordKeys, httpErrorCodeLookup, incrementVersion_default as incrementVersion, interpolate_default as interpolate, interpolateObjects_default as interpolateObjects, isAnniversary_default as isAnniversary, isLeapYear_default as isLeapYear, isMonthlyMultiple_default as isMonthlyMultiple, isOrdered_default as isOrdered, isSameDate_default as isSameDate, kebabToCamel_default as kebabToCamel, normaliseImportPath, normaliseIndents_default as normaliseIndents, normalizeImportPath_default as normalizeImportPath, normalizeIndents, omitProperties_default as omitProperties, paralleliseArrays_default as paralleliseArrays, parseBoolean_default as parseBoolean, parseEnv_default as parseEnv, parseFormData_default as parseFormData, parseIntStrict_default as parseIntStrict, parseVersion_default as parseVersion, parseVersionType_default as parseVersionType, parseZodSchema_default as parseZodSchema, randomiseArray_default as randomiseArray, range_default as range, removeDuplicates_default as removeDuplicates, stringListToArray_default as stringListToArray, stringifyDotenv_default as stringifyDotenv, truncate_default as truncate, wait_default as wait };
+export { APIError_default as APIError, DataError_default as DataError, Env, NAMESPACE_EXPORT_REGEX_default as NAMESPACE_EXPORT_REGEX, VERSION_NUMBER_REGEX_default as VERSION_NUMBER_REGEX, VersionNumber_default as VersionNumber, VersionType, addDaysToDate_default as addDaysToDate, appendSemicolon_default as appendSemicolon, camelToKebab_default as camelToKebab, convertFileToBase64_default as convertFileToBase64, createFormData_default as createFormData, createTemplateStringsArray_default as createTemplateStringsArray, deepCopy_default as deepCopy, deepFreeze_default as deepFreeze, determineVersionType_default as determineVersionType, encryptWithKey_default as encryptWithKey, fillArray_default as fillArray, formatDateAndTime_default as formatDateAndTime, getIndividualVersionNumbers_default as getIndividualVersionNumbers, getInterpolations_default as getInterpolations, getRandomNumber_default as getRandomNumber, getRecordKeys_default as getRecordKeys, httpErrorCodeLookup, incrementVersion_default as incrementVersion, interpolate_default as interpolate, interpolateObjects_default as interpolateObjects, isAnniversary_default as isAnniversary, isLeapYear_default as isLeapYear, isMonthlyMultiple_default as isMonthlyMultiple, isOrdered_default as isOrdered, isSameDate_default as isSameDate, kebabToCamel_default as kebabToCamel, normaliseImportPath, normaliseIndents_default as normaliseIndents, normalizeImportPath_default as normalizeImportPath, normalizeIndents, omitProperties_default as omitProperties, paralleliseArrays_default as paralleliseArrays, parseBoolean_default as parseBoolean, parseEnv_default as parseEnv, parseFormData_default as parseFormData, parseIntStrict_default as parseIntStrict, parseVersion_default as parseVersion, parseVersionType_default as parseVersionType, parseZodSchema_default as parseZodSchema, parseZodSchemaAsync_default as parseZodSchemaAsync, randomiseArray_default as randomiseArray, range_default as range, removeDuplicates_default as removeDuplicates, stringListToArray_default as stringListToArray, stringifyDotenv_default as stringifyDotenv, truncate_default as truncate, wait_default as wait };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "4.8.0",
+  "version": "4.9.0",
   "description": "Helpful utility functions.",
   "repository": {
     "type": "git",