@raiyyan/brisk 0.0.0-stage → 0.1.0

package/dist/src/errors/http-errors.d.ts

@@ -0,0 +1,295 @@
+import type { z } from "zod";
+/** Options every error class accepts. */
+export interface HttpErrorOptions {
+    /** Machine-readable code for clients. Default: derived from the status, such as `NOT_FOUND`. */
+    code?: string;
+    /** Extra data sent to the client under `error.details`. */
+    details?: unknown;
+    /** The underlying error; logged with its stack, never sent to the client. */
+    cause?: unknown;
+    /** Response headers sent with the error, such as `Retry-After`. */
+    headers?: Readonly<Record<string, string>>;
+}
+/** Options for {@link TooManyRequestsError} and {@link ServiceUnavailableError}. */
+export interface RetryableErrorOptions extends HttpErrorOptions {
+    /** Seconds the client should wait before retrying; sent as `Retry-After`. */
+    retryAfter?: number;
+}
+/**
+ * The base of every error a client should see. Throw it, or a subclass, from anywhere: a handler, a service,
+ * a repository, a middleware. The app logs it and sends an {@link ErrorResponse}. Its message always reaches
+ * the client, so keep internals in `cause`. Domain errors read best as subclasses of the status classes.
+ *
+ * @example
+ * ```ts
+ * throw new HttpError(418, "I'm a teapot", { code: "TEAPOT" });
+ *
+ * export class EmailTakenError extends ConflictError {
+ *   constructor(email: string) {
+ *     super("Email already registered", { code: "EMAIL_TAKEN", details: { email } });
+ *   }
+ * }
+ * ```
+ */
+export declare class HttpError extends Error {
+    readonly status: number;
+    readonly code: string;
+    readonly details: unknown;
+    readonly headers: Readonly<Record<string, string>>;
+    constructor(status: number, message: string, options?: HttpErrorOptions);
+}
+/**
+ * 400 Bad Request. The request is malformed, or breaks a rule the client can fix.
+ *
+ * @example
+ * ```ts
+ * throw new BadRequestError("Start date must be before end date", { code: "INVALID_RANGE" });
+ * ```
+ */
+export declare class BadRequestError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/** Options for {@link UnauthorizedError}. */
+export interface UnauthorizedErrorOptions extends HttpErrorOptions {
+    /** Authentication scheme the client should use, sent as `WWW-Authenticate`, such as `Bearer`. */
+    challenge?: string;
+}
+/**
+ * 401 Unauthorized. Credentials are missing or invalid. `challenge` is sent as `WWW-Authenticate`.
+ *
+ * @example
+ * ```ts
+ * throw new UnauthorizedError("Login required", { challenge: "Bearer" });
+ * ```
+ */
+export declare class UnauthorizedError extends HttpError {
+    constructor(message?: string, { challenge, ...options }?: UnauthorizedErrorOptions);
+}
+/**
+ * 403 Forbidden. The caller is known but may not do this.
+ *
+ * @example
+ * ```ts
+ * if (user.role !== "admin") throw new ForbiddenError("Admins only");
+ * ```
+ */
+export declare class ForbiddenError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 404 Not Found. The resource does not exist, or the caller may not know that it does.
+ *
+ * @example
+ * ```ts
+ * if (!user) throw new NotFoundError("User not found", { details: { id } });
+ * ```
+ */
+export declare class NotFoundError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 405 Method Not Allowed. The path exists, but not for this method; sends `Allow`. brisk raises it for you.
+ *
+ * @example
+ * ```ts
+ * throw new MethodNotAllowedError(["GET", "HEAD"]);
+ * ```
+ */
+export declare class MethodNotAllowedError extends HttpError {
+    constructor(allowed: readonly string[], message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 406 Not Acceptable. Nothing matches the request's `Accept` header.
+ *
+ * @example
+ * ```ts
+ * if (!req.accepts("json")) throw new NotAcceptableError();
+ * ```
+ */
+export declare class NotAcceptableError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 408 Request Timeout. The client took too long to send the request.
+ *
+ * @example
+ * ```ts
+ * throw new RequestTimeoutError();
+ * ```
+ */
+export declare class RequestTimeoutError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 409 Conflict. The request conflicts with the current state, such as a duplicate. Subclass it for domain errors.
+ *
+ * @example
+ * ```ts
+ * throw new ConflictError("Email already registered", { code: "EMAIL_TAKEN" });
+ * ```
+ */
+export declare class ConflictError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 410 Gone. The resource existed and was removed for good.
+ *
+ * @example
+ * ```ts
+ * throw new GoneError("This invite has expired");
+ * ```
+ */
+export declare class GoneError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 412 Precondition Failed. Optimistic concurrency failed: the client's `If-Match` version is stale.
+ *
+ * @example
+ * ```ts
+ * if (req.get("if-match") !== doc.etag) throw new PreconditionFailedError();
+ * ```
+ */
+export declare class PreconditionFailedError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 413 Payload Too Large. The body is over the limit. brisk raises it for JSON over `http.bodyLimit`.
+ *
+ * @example
+ * ```ts
+ * if (file.size > MAX_UPLOAD) throw new PayloadTooLargeError("Files are limited to 10 MB");
+ * ```
+ */
+export declare class PayloadTooLargeError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 415 Unsupported Media Type. No parser accepts the body's type. brisk raises it on routes with a `body` schema.
+ *
+ * @example
+ * ```ts
+ * throw new UnsupportedMediaTypeError("Send JSON or CSV");
+ * ```
+ */
+export declare class UnsupportedMediaTypeError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 422 Unprocessable Entity. The input is well formed but cannot be acted on, such as an impossible state change.
+ *
+ * @example
+ * ```ts
+ * throw new UnprocessableEntityError("A shipped order cannot be cancelled");
+ * ```
+ */
+export declare class UnprocessableEntityError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 429 Too Many Requests. The client is rate limited. `retryAfter` is sent as `Retry-After`, in seconds.
+ *
+ * @example
+ * ```ts
+ * throw new TooManyRequestsError("Slow down", { retryAfter: 30 });
+ * ```
+ */
+export declare class TooManyRequestsError extends HttpError {
+    constructor(message?: string, options?: RetryableErrorOptions);
+}
+/**
+ * 500 Internal Server Error, on purpose. Its message reaches the client: keep it generic and put the reason in `cause`.
+ *
+ * @example
+ * ```ts
+ * throw new InternalServerError("Could not generate the report", { cause: error });
+ * ```
+ */
+export declare class InternalServerError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 501 Not Implemented. The server does not support this yet.
+ *
+ * @example
+ * ```ts
+ * throw new NotImplementedError("Exports are coming soon");
+ * ```
+ */
+export declare class NotImplementedError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 502 Bad Gateway. An upstream service answered badly. `cause` is logged, never sent.
+ *
+ * @example
+ * ```ts
+ * throw new BadGatewayError("Payment provider failed", { cause: error });
+ * ```
+ */
+export declare class BadGatewayError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/**
+ * 503 Service Unavailable. Temporarily unavailable, such as during maintenance. `retryAfter` is sent as `Retry-After`.
+ *
+ * @example
+ * ```ts
+ * throw new ServiceUnavailableError("Down for maintenance", { retryAfter: 120 });
+ * ```
+ */
+export declare class ServiceUnavailableError extends HttpError {
+    constructor(message?: string, options?: RetryableErrorOptions);
+}
+/**
+ * 504 Gateway Timeout. An upstream service did not answer in time.
+ *
+ * @example
+ * ```ts
+ * throw new GatewayTimeoutError("Search did not answer in time", { cause: error });
+ * ```
+ */
+export declare class GatewayTimeoutError extends HttpError {
+    constructor(message?: string, options?: HttpErrorOptions);
+}
+/** One failed check, in a shape clients can map straight onto form fields. */
+export interface ValidationIssue {
+    /** Dot path to the offending field, such as `address.zip` or `items.0.qty`; empty for the root. */
+    path: string;
+    message: string;
+    /** Zod issue code, such as `invalid_type` or `too_small`, or your own code for custom checks. */
+    code: string;
+}
+/**
+ * `details` of a {@link ValidationError}: where the input failed and every issue found.
+ */
+export interface ValidationDetails {
+    /** Which part of the request failed: `params`, `query`, `body`, `headers`, or `input` for a parse in app code. */
+    location: string;
+    issues: ValidationIssue[];
+}
+/**
+ * 400 `VALIDATION_FAILED`. brisk throws it for input that breaks a route's schemas; throw one yourself for checks
+ * a schema cannot express, so clients get the same field-level shape.
+ *
+ * @example
+ * ```ts
+ * throw new ValidationError("body", [{ path: "endsAt", message: "Must be after startsAt", code: "custom" }]);
+ * throw ValidationError.fromZod(result.error, "input");
+ * ```
+ */
+export declare class ValidationError extends HttpError {
+    readonly details: ValidationDetails;
+    constructor(location: string, issues: ValidationIssue[]);
+    static fromZod(error: z.ZodError, location: string): ValidationError;
+}
+/** The body of every error response. */
+export interface ErrorResponse {
+    error: {
+        code: string;
+        message: string;
+        details?: unknown;
+        requestId: string;
+    };
+}
+//# sourceMappingURL=http-errors.d.ts.map

package/dist/src/errors/http-errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-errors.d.ts","sourceRoot":"","sources":["../../../src/errors/http-errors.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,yCAAyC;AACzC,MAAM,WAAW,gBAAgB;IAC/B,gGAAgG;IAChG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,6EAA6E;IAC7E,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,mEAAmE;IACnE,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC5C;AAED,oFAAoF;AACpF,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,6EAA6E;IAC7E,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEnD,YAAY,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,EAO1E;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,eAAgB,SAAQ,SAAS;IAC5C,YAAY,OAAO,SAAgB,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAE9D;CACF;AAED,6CAA6C;AAC7C,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAChE,iGAAiG;IACjG,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,qBAAa,iBAAkB,SAAQ,SAAS;IAC9C,YAAY,OAAO,SAAiB,EAAE,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,GAAE,wBAA6B,EAM7F;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,cAAe,SAAQ,SAAS;IAC3C,YAAY,OAAO,SAAc,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAE5D;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,aAAc,SAAQ,SAAS;IAC1C,YAAY,OAAO,SAAc,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAE5D;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,qBAAsB,SAAQ,SAAS;IAClD,YAAY,OAAO,EAAE,SAAS,MAAM,EAAE,EAAE,OAAO,SAAuB,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAEjG;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,SAAS;IAC/C,YAAY,OAAO,SAAmB,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAEjE;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAoB,SAAQ,SAAS;IAChD,YAAY,OAAO,SAAoB,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAElE;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,aAAc,SAAQ,SAAS;IAC1C,YAAY,OAAO,SAAa,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAE3D;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,SAAU,SAAQ,SAAS;IACtC,YAAY,OAAO,SAAS,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAEvD;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,uBAAwB,SAAQ,SAAS;IACpD,YAAY,OAAO,SAAwB,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAEtE;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,oBAAqB,SAAQ,SAAS;IACjD,YAAY,OAAO,SAAsB,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAEpE;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,yBAA0B,SAAQ,SAAS;IACtD,YAAY,OAAO,SAA2B,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAEzE;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,wBAAyB,SAAQ,SAAS;IACrD,YAAY,OAAO,SAAyB,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAEvE;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,oBAAqB,SAAQ,SAAS;IACjD,YAAY,OAAO,SAAsB,EAAE,OAAO,CAAC,EAAE,qBAAqB,EAEzE;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAoB,SAAQ,SAAS;IAChD,YAAY,OAAO,SAA0B,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAExE;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAoB,SAAQ,SAAS;IAChD,YAAY,OAAO,SAAoB,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAElE;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,eAAgB,SAAQ,SAAS;IAC5C,YAAY,OAAO,SAAgB,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAE9D;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,uBAAwB,SAAQ,SAAS;IACpD,YAAY,OAAO,SAAwB,EAAE,OAAO,CAAC,EAAE,qBAAqB,EAE3E;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAoB,SAAQ,SAAS;IAChD,YAAY,OAAO,SAAoB,EAAE,OAAO,CAAC,EAAE,gBAAgB,EAElE;CACF;AAED,8EAA8E;AAC9E,MAAM,WAAW,eAAe;IAC9B,mGAAmG;IACnG,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,iGAAiG;IACjG,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,kHAAkH;IAClH,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED;;;;;;;;;GASG;AACH,qBAAa,eAAgB,SAAQ,SAAS;IAC5C,SAAkB,OAAO,EAAE,iBAAiB,CAAC;IAE7C,YAAY,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,EAItD;IAED,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,eAAe,CAKnE;CACF;AAED,wCAAwC;AACxC,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH"}

package/dist/src/errors/http-errors.js

@@ -0,0 +1,311 @@
+import { STATUS_CODES } from "node:http";
+/**
+ * The base of every error a client should see. Throw it, or a subclass, from anywhere: a handler, a service,
+ * a repository, a middleware. The app logs it and sends an {@link ErrorResponse}. Its message always reaches
+ * the client, so keep internals in `cause`. Domain errors read best as subclasses of the status classes.
+ *
+ * @example
+ * ```ts
+ * throw new HttpError(418, "I'm a teapot", { code: "TEAPOT" });
+ *
+ * export class EmailTakenError extends ConflictError {
+ *   constructor(email: string) {
+ *     super("Email already registered", { code: "EMAIL_TAKEN", details: { email } });
+ *   }
+ * }
+ * ```
+ */
+export class HttpError extends Error {
+    status;
+    code;
+    details;
+    headers;
+    constructor(status, message, options = {}) {
+        super(message, { cause: options.cause });
+        this.name = new.target.name;
+        this.status = status;
+        this.code = options.code ?? codeFor(status);
+        this.details = options.details;
+        this.headers = options.headers ?? {};
+    }
+}
+/**
+ * 400 Bad Request. The request is malformed, or breaks a rule the client can fix.
+ *
+ * @example
+ * ```ts
+ * throw new BadRequestError("Start date must be before end date", { code: "INVALID_RANGE" });
+ * ```
+ */
+export class BadRequestError extends HttpError {
+    constructor(message = "Bad request", options) {
+        super(400, message, options);
+    }
+}
+/**
+ * 401 Unauthorized. Credentials are missing or invalid. `challenge` is sent as `WWW-Authenticate`.
+ *
+ * @example
+ * ```ts
+ * throw new UnauthorizedError("Login required", { challenge: "Bearer" });
+ * ```
+ */
+export class UnauthorizedError extends HttpError {
+    constructor(message = "Unauthorized", { challenge, ...options } = {}) {
+        super(401, message, withHeaders(options, challenge === undefined ? {} : { "www-authenticate": challenge }));
+    }
+}
+/**
+ * 403 Forbidden. The caller is known but may not do this.
+ *
+ * @example
+ * ```ts
+ * if (user.role !== "admin") throw new ForbiddenError("Admins only");
+ * ```
+ */
+export class ForbiddenError extends HttpError {
+    constructor(message = "Forbidden", options) {
+        super(403, message, options);
+    }
+}
+/**
+ * 404 Not Found. The resource does not exist, or the caller may not know that it does.
+ *
+ * @example
+ * ```ts
+ * if (!user) throw new NotFoundError("User not found", { details: { id } });
+ * ```
+ */
+export class NotFoundError extends HttpError {
+    constructor(message = "Not found", options) {
+        super(404, message, options);
+    }
+}
+/**
+ * 405 Method Not Allowed. The path exists, but not for this method; sends `Allow`. brisk raises it for you.
+ *
+ * @example
+ * ```ts
+ * throw new MethodNotAllowedError(["GET", "HEAD"]);
+ * ```
+ */
+export class MethodNotAllowedError extends HttpError {
+    constructor(allowed, message = "Method not allowed", options) {
+        super(405, message, withHeaders(options, { allow: allowed.join(", ") }));
+    }
+}
+/**
+ * 406 Not Acceptable. Nothing matches the request's `Accept` header.
+ *
+ * @example
+ * ```ts
+ * if (!req.accepts("json")) throw new NotAcceptableError();
+ * ```
+ */
+export class NotAcceptableError extends HttpError {
+    constructor(message = "Not acceptable", options) {
+        super(406, message, options);
+    }
+}
+/**
+ * 408 Request Timeout. The client took too long to send the request.
+ *
+ * @example
+ * ```ts
+ * throw new RequestTimeoutError();
+ * ```
+ */
+export class RequestTimeoutError extends HttpError {
+    constructor(message = "Request timeout", options) {
+        super(408, message, options);
+    }
+}
+/**
+ * 409 Conflict. The request conflicts with the current state, such as a duplicate. Subclass it for domain errors.
+ *
+ * @example
+ * ```ts
+ * throw new ConflictError("Email already registered", { code: "EMAIL_TAKEN" });
+ * ```
+ */
+export class ConflictError extends HttpError {
+    constructor(message = "Conflict", options) {
+        super(409, message, options);
+    }
+}
+/**
+ * 410 Gone. The resource existed and was removed for good.
+ *
+ * @example
+ * ```ts
+ * throw new GoneError("This invite has expired");
+ * ```
+ */
+export class GoneError extends HttpError {
+    constructor(message = "Gone", options) {
+        super(410, message, options);
+    }
+}
+/**
+ * 412 Precondition Failed. Optimistic concurrency failed: the client's `If-Match` version is stale.
+ *
+ * @example
+ * ```ts
+ * if (req.get("if-match") !== doc.etag) throw new PreconditionFailedError();
+ * ```
+ */
+export class PreconditionFailedError extends HttpError {
+    constructor(message = "Precondition failed", options) {
+        super(412, message, options);
+    }
+}
+/**
+ * 413 Payload Too Large. The body is over the limit. brisk raises it for JSON over `http.bodyLimit`.
+ *
+ * @example
+ * ```ts
+ * if (file.size > MAX_UPLOAD) throw new PayloadTooLargeError("Files are limited to 10 MB");
+ * ```
+ */
+export class PayloadTooLargeError extends HttpError {
+    constructor(message = "Payload too large", options) {
+        super(413, message, options);
+    }
+}
+/**
+ * 415 Unsupported Media Type. No parser accepts the body's type. brisk raises it on routes with a `body` schema.
+ *
+ * @example
+ * ```ts
+ * throw new UnsupportedMediaTypeError("Send JSON or CSV");
+ * ```
+ */
+export class UnsupportedMediaTypeError extends HttpError {
+    constructor(message = "Unsupported media type", options) {
+        super(415, message, options);
+    }
+}
+/**
+ * 422 Unprocessable Entity. The input is well formed but cannot be acted on, such as an impossible state change.
+ *
+ * @example
+ * ```ts
+ * throw new UnprocessableEntityError("A shipped order cannot be cancelled");
+ * ```
+ */
+export class UnprocessableEntityError extends HttpError {
+    constructor(message = "Unprocessable entity", options) {
+        super(422, message, options);
+    }
+}
+/**
+ * 429 Too Many Requests. The client is rate limited. `retryAfter` is sent as `Retry-After`, in seconds.
+ *
+ * @example
+ * ```ts
+ * throw new TooManyRequestsError("Slow down", { retryAfter: 30 });
+ * ```
+ */
+export class TooManyRequestsError extends HttpError {
+    constructor(message = "Too many requests", options) {
+        super(429, message, retryable(options));
+    }
+}
+/**
+ * 500 Internal Server Error, on purpose. Its message reaches the client: keep it generic and put the reason in `cause`.
+ *
+ * @example
+ * ```ts
+ * throw new InternalServerError("Could not generate the report", { cause: error });
+ * ```
+ */
+export class InternalServerError extends HttpError {
+    constructor(message = "Internal server error", options) {
+        super(500, message, options);
+    }
+}
+/**
+ * 501 Not Implemented. The server does not support this yet.
+ *
+ * @example
+ * ```ts
+ * throw new NotImplementedError("Exports are coming soon");
+ * ```
+ */
+export class NotImplementedError extends HttpError {
+    constructor(message = "Not implemented", options) {
+        super(501, message, options);
+    }
+}
+/**
+ * 502 Bad Gateway. An upstream service answered badly. `cause` is logged, never sent.
+ *
+ * @example
+ * ```ts
+ * throw new BadGatewayError("Payment provider failed", { cause: error });
+ * ```
+ */
+export class BadGatewayError extends HttpError {
+    constructor(message = "Bad gateway", options) {
+        super(502, message, options);
+    }
+}
+/**
+ * 503 Service Unavailable. Temporarily unavailable, such as during maintenance. `retryAfter` is sent as `Retry-After`.
+ *
+ * @example
+ * ```ts
+ * throw new ServiceUnavailableError("Down for maintenance", { retryAfter: 120 });
+ * ```
+ */
+export class ServiceUnavailableError extends HttpError {
+    constructor(message = "Service unavailable", options) {
+        super(503, message, retryable(options));
+    }
+}
+/**
+ * 504 Gateway Timeout. An upstream service did not answer in time.
+ *
+ * @example
+ * ```ts
+ * throw new GatewayTimeoutError("Search did not answer in time", { cause: error });
+ * ```
+ */
+export class GatewayTimeoutError extends HttpError {
+    constructor(message = "Gateway timeout", options) {
+        super(504, message, options);
+    }
+}
+/**
+ * 400 `VALIDATION_FAILED`. brisk throws it for input that breaks a route's schemas; throw one yourself for checks
+ * a schema cannot express, so clients get the same field-level shape.
+ *
+ * @example
+ * ```ts
+ * throw new ValidationError("body", [{ path: "endsAt", message: "Must be after startsAt", code: "custom" }]);
+ * throw ValidationError.fromZod(result.error, "input");
+ * ```
+ */
+export class ValidationError extends HttpError {
+    details;
+    constructor(location, issues) {
+        const details = { location, issues };
+        super(400, `Invalid request ${location}`, { code: "VALIDATION_FAILED", details });
+        this.details = details;
+    }
+    static fromZod(error, location) {
+        return new ValidationError(location, error.issues.map((issue) => ({ path: issue.path.join("."), message: issue.message, code: issue.code })));
+    }
+}
+/** `404` gives `NOT_FOUND`, `413` gives `PAYLOAD_TOO_LARGE`. */
+function codeFor(status) {
+    const phrase = STATUS_CODES[status];
+    return phrase ? phrase.toUpperCase().replace(/[^A-Z0-9]+/g, "_") : "HTTP_ERROR";
+}
+function withHeaders(options = {}, headers) {
+    return { ...options, headers: { ...headers, ...options.headers } };
+}
+function retryable({ retryAfter, ...options } = {}) {
+    return withHeaders(options, retryAfter === undefined ? {} : { "retry-after": String(Math.ceil(retryAfter)) });
+}
+//# sourceMappingURL=http-errors.js.map

package/dist/src/errors/http-errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-errors.js","sourceRoot":"","sources":["../../../src/errors/http-errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAqBzC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IACzB,MAAM,CAAS;IACf,IAAI,CAAS;IACb,OAAO,CAAU;IACjB,OAAO,CAAmC;IAEnD,YAAY,MAAc,EAAE,OAAe,EAAE,OAAO,GAAqB,EAAE;QACzE,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;IACvC,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAC5C,YAAY,OAAO,GAAG,aAAa,EAAE,OAA0B;QAC7D,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAQD;;;;;;;GAOG;AACH,MAAM,OAAO,iBAAkB,SAAQ,SAAS;IAC9C,YAAY,OAAO,GAAG,cAAc,EAAE,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,GAA6B,EAAE;QAC5F,KAAK,CACH,GAAG,EACH,OAAO,EACP,WAAW,CAAC,OAAO,EAAE,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,SAAS,EAAE,CAAC,CACvF,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,cAAe,SAAQ,SAAS;IAC3C,YAAY,OAAO,GAAG,WAAW,EAAE,OAA0B;QAC3D,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS;IAC1C,YAAY,OAAO,GAAG,WAAW,EAAE,OAA0B;QAC3D,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,qBAAsB,SAAQ,SAAS;IAClD,YAAY,OAA0B,EAAE,OAAO,GAAG,oBAAoB,EAAE,OAA0B;QAChG,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3E,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,kBAAmB,SAAQ,SAAS;IAC/C,YAAY,OAAO,GAAG,gBAAgB,EAAE,OAA0B;QAChE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAoB,SAAQ,SAAS;IAChD,YAAY,OAAO,GAAG,iBAAiB,EAAE,OAA0B;QACjE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS;IAC1C,YAAY,OAAO,GAAG,UAAU,EAAE,OAA0B;QAC1D,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC,YAAY,OAAO,GAAG,MAAM,EAAE,OAA0B;QACtD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,uBAAwB,SAAQ,SAAS;IACpD,YAAY,OAAO,GAAG,qBAAqB,EAAE,OAA0B;QACrE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,oBAAqB,SAAQ,SAAS;IACjD,YAAY,OAAO,GAAG,mBAAmB,EAAE,OAA0B;QACnE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,yBAA0B,SAAQ,SAAS;IACtD,YAAY,OAAO,GAAG,wBAAwB,EAAE,OAA0B;QACxE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,wBAAyB,SAAQ,SAAS;IACrD,YAAY,OAAO,GAAG,sBAAsB,EAAE,OAA0B;QACtE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,oBAAqB,SAAQ,SAAS;IACjD,YAAY,OAAO,GAAG,mBAAmB,EAAE,OAA+B;QACxE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1C,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAoB,SAAQ,SAAS;IAChD,YAAY,OAAO,GAAG,uBAAuB,EAAE,OAA0B;QACvE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAoB,SAAQ,SAAS;IAChD,YAAY,OAAO,GAAG,iBAAiB,EAAE,OAA0B;QACjE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAC5C,YAAY,OAAO,GAAG,aAAa,EAAE,OAA0B;QAC7D,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,uBAAwB,SAAQ,SAAS;IACpD,YAAY,OAAO,GAAG,qBAAqB,EAAE,OAA+B;QAC1E,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1C,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAoB,SAAQ,SAAS;IAChD,YAAY,OAAO,GAAG,iBAAiB,EAAE,OAA0B;QACjE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAoBD;;;;;;;;;GASG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAC1B,OAAO,CAAoB;IAE7C,YAAY,QAAgB,EAAE,MAAyB;QACrD,MAAM,OAAO,GAAsB,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;QACxD,KAAK,CAAC,GAAG,EAAE,mBAAmB,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,EAAE,CAAC,CAAC;QAClF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,KAAiB,EAAE,QAAgB;QAChD,OAAO,IAAI,eAAe,CACxB,QAAQ,EACR,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CACxG,CAAC;IACJ,CAAC;CACF;AAYD,gEAAgE;AAChE,SAAS,OAAO,CAAC,MAAc;IAC7B,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACpC,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;AAClF,CAAC;AAED,SAAS,WAAW,CAAC,OAAO,GAAqB,EAAE,EAAE,OAA+B;IAClF,OAAO,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;AACrE,CAAC;AAED,SAAS,SAAS,CAAC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,GAA0B,EAAE;IACvE,OAAO,WAAW,CAChB,OAAO,EACP,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,CACjF,CAAC;AACJ,CAAC"}

package/dist/src/errors/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The HTTP error classes, such as `NotFoundError` and `ConflictError`, and the error response types.
+ * Everything here is also exported from `@raiyyan/brisk`.
+ *
+ * @module
+ */
+export * from "./http-errors.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/errors/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/errors/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,cAAc,kBAAkB,CAAC"}

package/dist/src/errors/index.js

@@ -0,0 +1,8 @@
+/**
+ * The HTTP error classes, such as `NotFoundError` and `ConflictError`, and the error response types.
+ * Everything here is also exported from `@raiyyan/brisk`.
+ *
+ * @module
+ */
+export * from "./http-errors.js";
+//# sourceMappingURL=index.js.map

package/dist/src/errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/errors/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,cAAc,kBAAkB,CAAC"}