@alextheman/utility 3.9.0 → 3.10.0

package/dist/index.cjs

@@ -94,7 +94,7 @@ const IntegerParsingError = /* @__PURE__ */ new TypeError("INTEGER_PARSING_ERROR
 /**
 * Converts a string to an integer and throws an error if it cannot be converted.
 *
-* @param string — A string to convert into a number.
+* @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 {TypeError} If the provided string cannot safely be converted to an integer.
@@ -711,6 +711,27 @@ function parseZodSchema(schema, data) {
 }
 var parseZodSchema_default = parseZodSchema;
 
+//#endregion
+//#region src/functions/parsers/parseVersionType.ts
+const versionTypeSchema = zod.default.enum([
+	"major",
+	"minor",
+	"patch"
+]);
+/**
+* Parses the input and verifies it is a valid software version type (i.e. `"major" | "minor" | "patch"`)
+*
+* @param data - 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.
+*/
+function parseVersionType(data) {
+	return parseZodSchema_default(versionTypeSchema, data);
+}
+var parseVersionType_default = parseVersionType;
+
 //#endregion
 //#region src/functions/recursive/deepCopy.ts
 function callDeepCopy(input) {
@@ -1184,6 +1205,7 @@ exports.parseFormData = parseFormData_default;
 exports.parseIntStrict = parseIntStrict_default;
 exports.parseUUID = UUID_default;
 exports.parseVersion = parseVersion_default;
+exports.parseVersionType = parseVersionType_default;
 exports.parseZodSchema = parseZodSchema_default;
 exports.randomiseArray = randomiseArray_default;
 exports.range = range_default;

package/dist/index.d.cts

@@ -285,9 +285,6 @@ type OptionalOnCondition<Condition extends boolean, ResolvedTypeIfTrue> = Condit
 /** Represents the native Record's possible key type. */
 type RecordKey = string | number | symbol;
 //#endregion
-//#region src/types/VersionType.d.ts
-type VersionType = "major" | "minor" | "patch";
-//#endregion
 //#region src/functions/miscellaneous/createFormData.d.ts
 type FormDataNullableResolutionStrategy = "stringify" | "empty" | "omit";
 type FormDataArrayResolutionStrategy = "stringify" | "multiple";
@@ -461,7 +458,7 @@ declare function parseFormData(formData: FormData): Record<string, string | Blob
 /**
  * Converts a string to an integer and throws an error if it cannot be converted.
  *
- * @param string — A string to convert into a number.
+ * @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 {TypeError} If the provided string cannot safely be converted to an integer.
@@ -470,6 +467,24 @@ 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
+declare const versionTypeSchema: z.ZodEnum<{
+  major: "major";
+  minor: "minor";
+  patch: "patch";
+}>;
+type VersionType = z.infer<typeof versionTypeSchema>;
+/**
+ * Parses the input and verifies it is a valid software version type (i.e. `"major" | "minor" | "patch"`)
+ *
+ * @param data - 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;
+//#endregion
 //#region src/functions/parsers/parseZodSchema.d.ts
 /**
  * An alternative function to zodSchema.parse() that can be used to strictly parse Zod schemas.
@@ -762,4 +777,4 @@ interface ParseVersionOptions {
  */
 declare function parseVersion(input: string, options?: ParseVersionOptions): string;
 //#endregion
-export { APIError, ArrayElement, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DeepReadonly, DisallowUndefined, Email, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParseVersionOptions, RecordKey, RemoveIndentsFunction, RemoveIndentsOptions, StringListToArrayOptions, UUID, VERSION_NUMBER_REGEX, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, fillArray, formatDateAndTime, getIndividualVersionNumbers, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEmail, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersion, parseZodSchema, randomiseArray, range, removeDuplicates, removeIndents, stringListToArray, stringToBoolean, truncate, wait };
+export { APIError, ArrayElement, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DeepReadonly, DisallowUndefined, Email, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParseVersionOptions, RecordKey, RemoveIndentsFunction, RemoveIndentsOptions, StringListToArrayOptions, UUID, VERSION_NUMBER_REGEX, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, fillArray, formatDateAndTime, getIndividualVersionNumbers, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEmail, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, removeIndents, stringListToArray, stringToBoolean, truncate, wait };

package/dist/index.d.ts

@@ -285,9 +285,6 @@ type OptionalOnCondition<Condition extends boolean, ResolvedTypeIfTrue> = Condit
 /** Represents the native Record's possible key type. */
 type RecordKey = string | number | symbol;
 //#endregion
-//#region src/types/VersionType.d.ts
-type VersionType = "major" | "minor" | "patch";
-//#endregion
 //#region src/functions/miscellaneous/createFormData.d.ts
 type FormDataNullableResolutionStrategy = "stringify" | "empty" | "omit";
 type FormDataArrayResolutionStrategy = "stringify" | "multiple";
@@ -461,7 +458,7 @@ declare function parseFormData(formData: FormData): Record<string, string | Blob
 /**
  * Converts a string to an integer and throws an error if it cannot be converted.
  *
- * @param string — A string to convert into a number.
+ * @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 {TypeError} If the provided string cannot safely be converted to an integer.
@@ -470,6 +467,24 @@ 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
+declare const versionTypeSchema: z.ZodEnum<{
+  major: "major";
+  minor: "minor";
+  patch: "patch";
+}>;
+type VersionType = z.infer<typeof versionTypeSchema>;
+/**
+ * Parses the input and verifies it is a valid software version type (i.e. `"major" | "minor" | "patch"`)
+ *
+ * @param data - 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;
+//#endregion
 //#region src/functions/parsers/parseZodSchema.d.ts
 /**
  * An alternative function to zodSchema.parse() that can be used to strictly parse Zod schemas.
@@ -762,4 +777,4 @@ interface ParseVersionOptions {
  */
 declare function parseVersion(input: string, options?: ParseVersionOptions): string;
 //#endregion
-export { APIError, type ArrayElement, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DeepReadonly, type DisallowUndefined, type Email, type Env, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type OptionalOnCondition, type ParseVersionOptions, type RecordKey, RemoveIndentsFunction, RemoveIndentsOptions, type StringListToArrayOptions, type UUID, VERSION_NUMBER_REGEX, type VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, fillArray, formatDateAndTime, getIndividualVersionNumbers, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEmail, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersion, parseZodSchema, randomiseArray, range, removeDuplicates, removeIndents, stringListToArray, stringToBoolean, truncate, wait };
+export { APIError, type ArrayElement, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DeepReadonly, type DisallowUndefined, type Email, type Env, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type OptionalOnCondition, type ParseVersionOptions, type RecordKey, RemoveIndentsFunction, RemoveIndentsOptions, type StringListToArrayOptions, type UUID, VERSION_NUMBER_REGEX, type VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, fillArray, formatDateAndTime, getIndividualVersionNumbers, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEmail, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, removeIndents, stringListToArray, stringToBoolean, truncate, wait };

package/dist/index.js

@@ -65,7 +65,7 @@ const IntegerParsingError = /* @__PURE__ */ new TypeError("INTEGER_PARSING_ERROR
 /**
 * Converts a string to an integer and throws an error if it cannot be converted.
 *
-* @param string — A string to convert into a number.
+* @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 {TypeError} If the provided string cannot safely be converted to an integer.
@@ -682,6 +682,27 @@ function parseZodSchema(schema, data) {
 }
 var parseZodSchema_default = parseZodSchema;
 
+//#endregion
+//#region src/functions/parsers/parseVersionType.ts
+const versionTypeSchema = z.enum([
+	"major",
+	"minor",
+	"patch"
+]);
+/**
+* Parses the input and verifies it is a valid software version type (i.e. `"major" | "minor" | "patch"`)
+*
+* @param data - 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.
+*/
+function parseVersionType(data) {
+	return parseZodSchema_default(versionTypeSchema, data);
+}
+var parseVersionType_default = parseVersionType;
+
 //#endregion
 //#region src/functions/recursive/deepCopy.ts
 function callDeepCopy(input) {
@@ -1114,4 +1135,4 @@ function incrementVersion(version, incrementType, options) {
 var incrementVersion_default = incrementVersion;
 
 //#endregion
-export { APIError_default as APIError, DataError_default as DataError, NAMESPACE_EXPORT_REGEX_default as NAMESPACE_EXPORT_REGEX, VERSION_NUMBER_REGEX_default as VERSION_NUMBER_REGEX, 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, fillArray_default as fillArray, formatDateAndTime_default as formatDateAndTime, getIndividualVersionNumbers_default as getIndividualVersionNumbers, 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, Email_default as parseEmail, parseEnv_default as parseEnv, parseFormData_default as parseFormData, parseIntStrict_default as parseIntStrict, UUID_default as parseUUID, parseVersion_default as parseVersion, parseZodSchema_default as parseZodSchema, randomiseArray_default as randomiseArray, range_default as range, removeDuplicates_default as removeDuplicates, removeIndents_default as removeIndents, stringListToArray_default as stringListToArray, stringToBoolean, truncate_default as truncate, wait_default as wait };
+export { APIError_default as APIError, DataError_default as DataError, NAMESPACE_EXPORT_REGEX_default as NAMESPACE_EXPORT_REGEX, VERSION_NUMBER_REGEX_default as VERSION_NUMBER_REGEX, 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, fillArray_default as fillArray, formatDateAndTime_default as formatDateAndTime, getIndividualVersionNumbers_default as getIndividualVersionNumbers, 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, Email_default as parseEmail, parseEnv_default as parseEnv, parseFormData_default as parseFormData, parseIntStrict_default as parseIntStrict, UUID_default as parseUUID, parseVersion_default as parseVersion, parseVersionType_default as parseVersionType, parseZodSchema_default as parseZodSchema, randomiseArray_default as randomiseArray, range_default as range, removeDuplicates_default as removeDuplicates, removeIndents_default as removeIndents, stringListToArray_default as stringListToArray, stringToBoolean, truncate_default as truncate, wait_default as wait };

package/package.json

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