@alextheman/utility 5.15.0 → 5.16.0

package/dist/index.cjs

@@ -38,6 +38,51 @@ const UUID_REGEX = new RegExp(`^${UUID_PATTERN}$`);
 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}$`);
 //#endregion
+//#region src/root/deprecated/APIError.ts
+const httpErrorCodeLookup = {
+	400: "BAD_REQUEST",
+	401: "UNAUTHORISED",
+	403: "FORBIDDEN",
+	404: "NOT_FOUND",
+	418: "I_AM_A_TEAPOT",
+	500: "INTERNAL_SERVER_ERROR"
+};
+/**
+* Represents common errors you may get from a HTTP API request.
+*
+* @category Types
+*
+* @deprecated Please use `APIError` from `@alextheman/utility/v6` instead.
+*/
+var APIError = class APIError extends Error {
+	status;
+	/**
+	* @param status - A HTTP status code. Can be any number, but numbers between 400 and 600 are encouraged to fit with HTTP status code conventions.
+	* @param message - An error message to display alongside the status code.
+	* @param options - Extra options to be passed to super Error constructor.
+	*/
+	constructor(status = 500, message, options) {
+		super(message, options);
+		this.status = status;
+		if (message) this.message = message;
+		else this.message = httpErrorCodeLookup[this.status] ?? "API_ERROR";
+		Object.defineProperty(this, "message", { enumerable: true });
+		Object.setPrototypeOf(this, new.target.prototype);
+	}
+	/**
+	* Checks whether the given input may have been caused by an APIError.
+	*
+	* @param input - The input to check.
+	*
+	* @returns `true` if the input is an APIError, and `false` otherwise. The type of the input will also be narrowed down to APIError if `true`.
+	*/
+	static check(input) {
+		if (input instanceof APIError) return true;
+		const data = input;
+		return typeof data === "object" && data !== null && typeof data?.status === "number" && typeof data?.message === "string";
+	}
+};
+//#endregion
 //#region src/root/functions/arrayHelpers/fillArray.ts
 /**
 * Creates a new array where each element is the result of the provided callback.
@@ -185,6 +230,17 @@ var CodeError = class CodeError extends Error {
 		}
 		throw new Error(`Expected a ${this.name} to be thrown but none was thrown`);
 	}
+	/**
+	* Converts the `CodeError` instance to a serialised JSON payload.
+	*
+	* @returns A JSON serialised version of the current `CodeError` instance.
+	*/
+	toJSON() {
+		return {
+			code: this.code,
+			message: this.message
+		};
+	}
 };
 //#endregion
 //#region src/v6/DataError.ts
@@ -193,14 +249,15 @@ var CodeError = class CodeError extends Error {
 *
 * @category Types
 *
-* @template DataType - The type of the data that caused the error.
+* @template DataType The type of the data that caused the error.
+* @template ErrorCode The type of the standardised error code.
 */
 var DataError$1 = class DataError$1 extends CodeError {
 	data;
 	/**
 	* @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 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, code, message = "The data provided is invalid", options) {
@@ -220,7 +277,7 @@ var DataError$1 = class DataError$1 extends CodeError {
 	*/
 	static check(input) {
 		if (input instanceof DataError$1) return true;
-		return typeof input === "object" && input !== null && "message" in input && typeof input.message === "string" && "code" in input && typeof input.code === "string" && "data" in input;
+		return typeof input === "object" && input !== null && "message" in input && typeof input.message === "string" && "code" in input && typeof input.code === "string" && "data" in input && typeof input.data === "object" && input.data !== null;
 	}
 	/**
 	* Check a `DataError` against its error code
@@ -265,6 +322,17 @@ var DataError$1 = class DataError$1 extends CodeError {
 	static async expectErrorAsync(errorFunction, options) {
 		return await super.expectErrorAsync(errorFunction, options);
 	}
+	/**
+	* Converts the `DataError` instance to a serialised JSON payload.
+	*
+	* @returns A JSON serialised version of the current `DataError` instance.
+	*/
+	toJSON() {
+		return {
+			...super.toJSON(),
+			data: this.data
+		};
+	}
 };
 //#endregion
 //#region src/root/functions/parsers/parseIntStrict.ts
@@ -922,49 +990,6 @@ function parseBoolean(inputString) {
 	return normalisedString === "true";
 }
 //#endregion
-//#region src/root/types/APIError.ts
-const httpErrorCodeLookup = {
-	400: "BAD_REQUEST",
-	401: "UNAUTHORISED",
-	403: "FORBIDDEN",
-	404: "NOT_FOUND",
-	418: "I_AM_A_TEAPOT",
-	500: "INTERNAL_SERVER_ERROR"
-};
-/**
-* Represents common errors you may get from a HTTP API request.
-*
-* @category Types
-*/
-var APIError = class APIError extends Error {
-	status;
-	/**
-	* @param status - A HTTP status code. Can be any number, but numbers between 400 and 600 are encouraged to fit with HTTP status code conventions.
-	* @param message - An error message to display alongside the status code.
-	* @param options - Extra options to be passed to super Error constructor.
-	*/
-	constructor(status = 500, message, options) {
-		super(message, options);
-		this.status = status;
-		if (message) this.message = message;
-		else this.message = httpErrorCodeLookup[this.status] ?? "API_ERROR";
-		Object.defineProperty(this, "message", { enumerable: true });
-		Object.setPrototypeOf(this, new.target.prototype);
-	}
-	/**
-	* Checks whether the given input may have been caused by an APIError.
-	*
-	* @param input - The input to check.
-	*
-	* @returns `true` if the input is an APIError, and `false` otherwise. The type of the input will also be narrowed down to APIError if `true`.
-	*/
-	static check(input) {
-		if (input instanceof APIError) return true;
-		const data = input;
-		return typeof data === "object" && data !== null && typeof data?.status === "number" && typeof data?.message === "string";
-	}
-};
-//#endregion
 //#region src/root/types/VersionNumber.ts
 /**
 * Represents a software version number, considered to be made up of a major, minor, and patch part.
@@ -1830,6 +1855,22 @@ var DataError = class DataError extends Error {
 	}
 };
 //#endregion
+//#region src/root/errors/assertNotNull.ts
+/**
+* Asserts that a given input is not `null`, and throws a DataError if it does.
+*
+* If no error is thrown from this, the input type gets narrowed down to not include `null`.
+*
+* @template InputType The type of the input.
+*
+* @param input - The input to assert against
+*
+* @throws {DataError} If the input is `null`.
+*/
+function assertNotNull(input) {
+	if (input === null) throw new DataError$1({ input }, "NULL_INPUT", "Expected the input not to be null");
+}
+//#endregion
 exports.APIError = APIError;
 exports.DataError = DataError;
 exports.Env = Env;
@@ -1844,6 +1885,7 @@ exports.VersionNumber = VersionNumber;
 exports.VersionType = VersionType;
 exports.addDaysToDate = addDaysToDate;
 exports.appendSemicolon = appendSemicolon;
+exports.assertNotNull = assertNotNull;
 exports.az = az;
 exports.calculateMonthlyDifference = calculateMonthlyDifference;
 exports.camelToKebab = camelToKebab;