@augment-vir/core 31.4.0 → 31.6.0

package/dist/augments/http/http-status.d.ts

@@ -1,4 +1,5 @@
 import type { ArrayElement } from '../array/array.js';
+import type { ExtractKeysWithMatchingValues } from '../object/object-keys.js';
 /**
  * All standardized HTTP status codes.
  *
@@ -498,6 +499,120 @@ export declare enum HttpStatusCategory {
     ClientError = "clientError",
     ServerError = "serverError"
 }
+/**
+ * All {@link HttpStatusCategory} entries that indicate a failed response as a runtime value that can
+ * be used to check actual response statuses.
+ *
+ * @category HTTP
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare const errorHttpStatusCategories: readonly [HttpStatusCategory.ClientError, HttpStatusCategory.ServerError];
+/**
+ * All {@link HttpStatusCategory} entries that indicate a failed response.
+ *
+ * @category HTTP
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export type ErrorHttpStatusCategories = ArrayElement<typeof errorHttpStatusCategories>;
+/**
+ * All {@link HttpStatusCategory} entries that indicate a successful response.
+ *
+ * @category HTTP
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export type SuccessHttpStatusCategories = Exclude<HttpStatusCategory, ErrorHttpStatusCategories>;
+/**
+ * Checks if the given HTTP status is an error status. Type guards the input.
+ *
+ * @category HTTP
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function isErrorHttpStatus(input: HttpStatus): input is ExtractKeysWithMatchingValues<typeof httpStatusToCategory, ErrorHttpStatusCategories>;
+/**
+ * A type that maps the given {@link HttpStatus} type parameter to its respective
+ * {@link HttpStatusCategory}.
+ *
+ * @category HTTP
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export type HttpStatusToCategory<Status extends HttpStatus> = (typeof httpStatusToCategory)[Status];
+/**
+ * All standardized HTTP statuses mapped to their respective category.
+ *
+ * @category HTTP
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare const httpStatusToCategory: {
+    readonly 100: HttpStatusCategory.Information;
+    readonly 101: HttpStatusCategory.Information;
+    readonly 102: HttpStatusCategory.Information;
+    readonly 103: HttpStatusCategory.Information;
+    readonly 200: HttpStatusCategory.Success;
+    readonly 201: HttpStatusCategory.Success;
+    readonly 202: HttpStatusCategory.Success;
+    readonly 203: HttpStatusCategory.Success;
+    readonly 204: HttpStatusCategory.Success;
+    readonly 205: HttpStatusCategory.Success;
+    readonly 206: HttpStatusCategory.Success;
+    readonly 207: HttpStatusCategory.Success;
+    readonly 208: HttpStatusCategory.Success;
+    readonly 226: HttpStatusCategory.Success;
+    readonly 300: HttpStatusCategory.Redirect;
+    readonly 301: HttpStatusCategory.Redirect;
+    readonly 302: HttpStatusCategory.Redirect;
+    readonly 303: HttpStatusCategory.Redirect;
+    readonly 304: HttpStatusCategory.Redirect;
+    readonly 305: HttpStatusCategory.Redirect;
+    readonly 306: HttpStatusCategory.Redirect;
+    readonly 307: HttpStatusCategory.Redirect;
+    readonly 308: HttpStatusCategory.Redirect;
+    readonly 400: HttpStatusCategory.ClientError;
+    readonly 401: HttpStatusCategory.ClientError;
+    readonly 402: HttpStatusCategory.ClientError;
+    readonly 403: HttpStatusCategory.ClientError;
+    readonly 404: HttpStatusCategory.ClientError;
+    readonly 405: HttpStatusCategory.ClientError;
+    readonly 406: HttpStatusCategory.ClientError;
+    readonly 407: HttpStatusCategory.ClientError;
+    readonly 408: HttpStatusCategory.ClientError;
+    readonly 409: HttpStatusCategory.ClientError;
+    readonly 410: HttpStatusCategory.ClientError;
+    readonly 411: HttpStatusCategory.ClientError;
+    readonly 412: HttpStatusCategory.ClientError;
+    readonly 413: HttpStatusCategory.ClientError;
+    readonly 414: HttpStatusCategory.ClientError;
+    readonly 415: HttpStatusCategory.ClientError;
+    readonly 416: HttpStatusCategory.ClientError;
+    readonly 417: HttpStatusCategory.ClientError;
+    readonly 418: HttpStatusCategory.ClientError;
+    readonly 421: HttpStatusCategory.ClientError;
+    readonly 422: HttpStatusCategory.ClientError;
+    readonly 423: HttpStatusCategory.ClientError;
+    readonly 424: HttpStatusCategory.ClientError;
+    readonly 425: HttpStatusCategory.ClientError;
+    readonly 426: HttpStatusCategory.ClientError;
+    readonly 428: HttpStatusCategory.ClientError;
+    readonly 429: HttpStatusCategory.ClientError;
+    readonly 431: HttpStatusCategory.ClientError;
+    readonly 451: HttpStatusCategory.ClientError;
+    readonly 500: HttpStatusCategory.ServerError;
+    readonly 501: HttpStatusCategory.ServerError;
+    readonly 502: HttpStatusCategory.ServerError;
+    readonly 503: HttpStatusCategory.ServerError;
+    readonly 504: HttpStatusCategory.ServerError;
+    readonly 505: HttpStatusCategory.ServerError;
+    readonly 506: HttpStatusCategory.ServerError;
+    readonly 507: HttpStatusCategory.ServerError;
+    readonly 508: HttpStatusCategory.ServerError;
+    readonly 510: HttpStatusCategory.ServerError;
+    readonly 511: HttpStatusCategory.ServerError;
+};
 /**
  * All standardized HTTP status codes grouped into their respective categories.
  *
@@ -506,11 +621,11 @@ export declare enum HttpStatusCategory {
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare const httpStatusByCategory: {
-    readonly information: readonly [HttpStatus.Continue, HttpStatus.SwitchingProtocols, HttpStatus.Processing, HttpStatus.EarlyHints];
-    readonly success: readonly [HttpStatus.Ok, HttpStatus.Created, HttpStatus.Accepted, HttpStatus.NonAuthoritativeInformation, HttpStatus.NoContent, HttpStatus.ResetContent, HttpStatus.PartialContent, HttpStatus.MultiStatus, HttpStatus.AlreadyReported, HttpStatus.ImUsed];
-    readonly redirect: readonly [HttpStatus.MultipleChoices, HttpStatus.MovedPermanently, HttpStatus.Found, HttpStatus.SeeOther, HttpStatus.NotModified, HttpStatus.UseProxy, HttpStatus.Unused, HttpStatus.TemporaryRedirect, HttpStatus.PermanentRedirect];
-    readonly clientError: readonly [HttpStatus.BadRequest, HttpStatus.Unauthorized, HttpStatus.PaymentRequired, HttpStatus.Forbidden, HttpStatus.NotFound, HttpStatus.MethodNotAllowed, HttpStatus.NotAcceptable, HttpStatus.ProxyAuthenticationRequired, HttpStatus.RequestTimeout, HttpStatus.Conflict, HttpStatus.Gone, HttpStatus.LengthRequired, HttpStatus.PreconditionFailed, HttpStatus.PayloadTooLarge, HttpStatus.UriTooLong, HttpStatus.UnsupportedMediaType, HttpStatus.RangeNotSatisfiable, HttpStatus.ExpectationFailed, HttpStatus.ImATeapot, HttpStatus.MisdirectedRequest, HttpStatus.UnprocessableContent, HttpStatus.Locked, HttpStatus.FailedDependency, HttpStatus.TooEarly, HttpStatus.UpgradeRequired, HttpStatus.PreconditionRequired, HttpStatus.TooManyRequests, HttpStatus.RequestHeaderFieldsTooLarge, HttpStatus.UnavailableForLegalReasons];
-    readonly serverError: readonly [HttpStatus.InternalServerError, HttpStatus.NotImplemented, HttpStatus.BadGateway, HttpStatus.ServiceUnavailable, HttpStatus.GatewayTimeout, HttpStatus.HttpVersionNotSupported, HttpStatus.VariantAlsoNegotiates, HttpStatus.InsufficientStorage, HttpStatus.LoopDetected, HttpStatus.NotExtended, HttpStatus.NetworkAuthenticationRequired];
+    readonly information: [HttpStatus.Continue, HttpStatus.SwitchingProtocols, HttpStatus.Processing, HttpStatus.EarlyHints];
+    readonly success: [HttpStatus.Ok, HttpStatus.Created, HttpStatus.Accepted, HttpStatus.NonAuthoritativeInformation, HttpStatus.NoContent, HttpStatus.ResetContent, HttpStatus.PartialContent, HttpStatus.MultiStatus, HttpStatus.AlreadyReported, HttpStatus.ImUsed];
+    readonly redirect: [HttpStatus.MultipleChoices, HttpStatus.MovedPermanently, HttpStatus.Found, HttpStatus.SeeOther, HttpStatus.NotModified, HttpStatus.UseProxy, HttpStatus.Unused, HttpStatus.TemporaryRedirect, HttpStatus.PermanentRedirect];
+    readonly clientError: [HttpStatus.BadRequest, HttpStatus.Unauthorized, HttpStatus.PaymentRequired, HttpStatus.Forbidden, HttpStatus.NotFound, HttpStatus.MethodNotAllowed, HttpStatus.NotAcceptable, HttpStatus.ProxyAuthenticationRequired, HttpStatus.RequestTimeout, HttpStatus.Conflict, HttpStatus.Gone, HttpStatus.LengthRequired, HttpStatus.PreconditionFailed, HttpStatus.PayloadTooLarge, HttpStatus.UriTooLong, HttpStatus.UnsupportedMediaType, HttpStatus.RangeNotSatisfiable, HttpStatus.ExpectationFailed, HttpStatus.ImATeapot, HttpStatus.MisdirectedRequest, HttpStatus.UnprocessableContent, HttpStatus.Locked, HttpStatus.FailedDependency, HttpStatus.TooEarly, HttpStatus.UpgradeRequired, HttpStatus.PreconditionRequired, HttpStatus.TooManyRequests, HttpStatus.RequestHeaderFieldsTooLarge, HttpStatus.UnavailableForLegalReasons];
+    readonly serverError: [HttpStatus.InternalServerError, HttpStatus.NotImplemented, HttpStatus.BadGateway, HttpStatus.ServiceUnavailable, HttpStatus.GatewayTimeout, HttpStatus.HttpVersionNotSupported, HttpStatus.VariantAlsoNegotiates, HttpStatus.InsufficientStorage, HttpStatus.LoopDetected, HttpStatus.NotExtended, HttpStatus.NetworkAuthenticationRequired];
 };
 /**
  * All possible HTTP status codes for the given {@link HttpStatusCategory}.

package/dist/augments/http/http-status.js

@@ -499,6 +499,100 @@ export var HttpStatusCategory;
     HttpStatusCategory["ClientError"] = "clientError";
     HttpStatusCategory["ServerError"] = "serverError";
 })(HttpStatusCategory || (HttpStatusCategory = {}));
+/**
+ * All {@link HttpStatusCategory} entries that indicate a failed response as a runtime value that can
+ * be used to check actual response statuses.
+ *
+ * @category HTTP
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export const errorHttpStatusCategories = [
+    HttpStatusCategory.ClientError,
+    HttpStatusCategory.ServerError,
+];
+/**
+ * Checks if the given HTTP status is an error status. Type guards the input.
+ *
+ * @category HTTP
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function isErrorHttpStatus(input) {
+    return errorHttpStatusCategories.includes(httpStatusToCategory[input]);
+}
+/**
+ * All standardized HTTP statuses mapped to their respective category.
+ *
+ * @category HTTP
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export const httpStatusToCategory = {
+    [HttpStatus.Continue]: HttpStatusCategory.Information,
+    [HttpStatus.SwitchingProtocols]: HttpStatusCategory.Information,
+    [HttpStatus.Processing]: HttpStatusCategory.Information,
+    [HttpStatus.EarlyHints]: HttpStatusCategory.Information,
+    [HttpStatus.Ok]: HttpStatusCategory.Success,
+    [HttpStatus.Created]: HttpStatusCategory.Success,
+    [HttpStatus.Accepted]: HttpStatusCategory.Success,
+    [HttpStatus.NonAuthoritativeInformation]: HttpStatusCategory.Success,
+    [HttpStatus.NoContent]: HttpStatusCategory.Success,
+    [HttpStatus.ResetContent]: HttpStatusCategory.Success,
+    [HttpStatus.PartialContent]: HttpStatusCategory.Success,
+    [HttpStatus.MultiStatus]: HttpStatusCategory.Success,
+    [HttpStatus.AlreadyReported]: HttpStatusCategory.Success,
+    [HttpStatus.ImUsed]: HttpStatusCategory.Success,
+    [HttpStatus.MultipleChoices]: HttpStatusCategory.Redirect,
+    [HttpStatus.MovedPermanently]: HttpStatusCategory.Redirect,
+    [HttpStatus.Found]: HttpStatusCategory.Redirect,
+    [HttpStatus.SeeOther]: HttpStatusCategory.Redirect,
+    [HttpStatus.NotModified]: HttpStatusCategory.Redirect,
+    [HttpStatus.UseProxy]: HttpStatusCategory.Redirect,
+    [HttpStatus.Unused]: HttpStatusCategory.Redirect,
+    [HttpStatus.TemporaryRedirect]: HttpStatusCategory.Redirect,
+    [HttpStatus.PermanentRedirect]: HttpStatusCategory.Redirect,
+    [HttpStatus.BadRequest]: HttpStatusCategory.ClientError,
+    [HttpStatus.Unauthorized]: HttpStatusCategory.ClientError,
+    [HttpStatus.PaymentRequired]: HttpStatusCategory.ClientError,
+    [HttpStatus.Forbidden]: HttpStatusCategory.ClientError,
+    [HttpStatus.NotFound]: HttpStatusCategory.ClientError,
+    [HttpStatus.MethodNotAllowed]: HttpStatusCategory.ClientError,
+    [HttpStatus.NotAcceptable]: HttpStatusCategory.ClientError,
+    [HttpStatus.ProxyAuthenticationRequired]: HttpStatusCategory.ClientError,
+    [HttpStatus.RequestTimeout]: HttpStatusCategory.ClientError,
+    [HttpStatus.Conflict]: HttpStatusCategory.ClientError,
+    [HttpStatus.Gone]: HttpStatusCategory.ClientError,
+    [HttpStatus.LengthRequired]: HttpStatusCategory.ClientError,
+    [HttpStatus.PreconditionFailed]: HttpStatusCategory.ClientError,
+    [HttpStatus.PayloadTooLarge]: HttpStatusCategory.ClientError,
+    [HttpStatus.UriTooLong]: HttpStatusCategory.ClientError,
+    [HttpStatus.UnsupportedMediaType]: HttpStatusCategory.ClientError,
+    [HttpStatus.RangeNotSatisfiable]: HttpStatusCategory.ClientError,
+    [HttpStatus.ExpectationFailed]: HttpStatusCategory.ClientError,
+    [HttpStatus.ImATeapot]: HttpStatusCategory.ClientError,
+    [HttpStatus.MisdirectedRequest]: HttpStatusCategory.ClientError,
+    [HttpStatus.UnprocessableContent]: HttpStatusCategory.ClientError,
+    [HttpStatus.Locked]: HttpStatusCategory.ClientError,
+    [HttpStatus.FailedDependency]: HttpStatusCategory.ClientError,
+    [HttpStatus.TooEarly]: HttpStatusCategory.ClientError,
+    [HttpStatus.UpgradeRequired]: HttpStatusCategory.ClientError,
+    [HttpStatus.PreconditionRequired]: HttpStatusCategory.ClientError,
+    [HttpStatus.TooManyRequests]: HttpStatusCategory.ClientError,
+    [HttpStatus.RequestHeaderFieldsTooLarge]: HttpStatusCategory.ClientError,
+    [HttpStatus.UnavailableForLegalReasons]: HttpStatusCategory.ClientError,
+    [HttpStatus.InternalServerError]: HttpStatusCategory.ServerError,
+    [HttpStatus.NotImplemented]: HttpStatusCategory.ServerError,
+    [HttpStatus.BadGateway]: HttpStatusCategory.ServerError,
+    [HttpStatus.ServiceUnavailable]: HttpStatusCategory.ServerError,
+    [HttpStatus.GatewayTimeout]: HttpStatusCategory.ServerError,
+    [HttpStatus.HttpVersionNotSupported]: HttpStatusCategory.ServerError,
+    [HttpStatus.VariantAlsoNegotiates]: HttpStatusCategory.ServerError,
+    [HttpStatus.InsufficientStorage]: HttpStatusCategory.ServerError,
+    [HttpStatus.LoopDetected]: HttpStatusCategory.ServerError,
+    [HttpStatus.NotExtended]: HttpStatusCategory.ServerError,
+    [HttpStatus.NetworkAuthenticationRequired]: HttpStatusCategory.ServerError,
+};
 /**
  * All standardized HTTP status codes grouped into their respective categories.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/core",
-    "version": "31.4.0",
+    "version": "31.6.0",
     "description": "Core augment-vir augments. Use @augment-vir/common instead.",
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {