@arkyn/server 3.0.1-beta.142 → 3.0.1-beta.144

package/dist/http/badResponses/serverError.d.ts

@@ -1,30 +1,21 @@
 import { BadResponse } from "./_badResponse";
 /**
- * Represents an HTTP error response with a status code of 500 (Internal Server Error).
- * This class is used to standardize the structure of a "Server Error" response,
- * including the response body, headers, status, and status text.
+ * HTTP 500 Internal Server Error — an unexpected condition prevented the server from fulfilling the request.
+ *
+ * @example
+ * ```typescript
+ * throw new ServerError("Failed to connect to the database");
+ * ```
  */
 declare class ServerError extends BadResponse {
     /**
-     * Creates an instance of the `ServerError` class.
-     *
-     * @param {string} message - A descriptive message explaining the cause of the server error.
-     * @param {any} cause - Optional additional information about the cause of the error.
+     * @param message - Error description.
+     * @param cause - Optional extra context (serialized to JSON).
      */
     constructor(message: string, cause?: any);
-    /**
-     * Converts the `ServerError` instance into a `Response` object with a JSON body.
-     * This method ensures the response has the appropriate headers, status, and status text.
-     *
-     * @returns {Response} A `Response` object with the serialized JSON body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse(): Response;
-    /**
-     * Converts the `ServerError` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON error responses.
-     *
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson(): Response;
 }
 export { ServerError };

package/dist/http/badResponses/serverError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"serverError.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/serverError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;GAIG;AAEH,cAAM,WAAY,SAAQ,WAAW;IACnC;;;;;OAKG;gBAES,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAWxC;;;;;OAKG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;;OAKG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"serverError.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/serverError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;;;;GAOG;AACH,cAAM,WAAY,SAAQ,WAAW;IACnC;;;OAGG;gBACS,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAWxC,6EAA6E;IAC7E,UAAU,IAAI,QAAQ;IAUtB,uFAAuF;IACvF,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/http/badResponses/serverError.js

@@ -1,15 +1,16 @@
 import { BadResponse } from "./_badResponse";
 /**
- * Represents an HTTP error response with a status code of 500 (Internal Server Error).
- * This class is used to standardize the structure of a "Server Error" response,
- * including the response body, headers, status, and status text.
+ * HTTP 500 Internal Server Error — an unexpected condition prevented the server from fulfilling the request.
+ *
+ * @example
+ * ```typescript
+ * throw new ServerError("Failed to connect to the database");
+ * ```
  */
 class ServerError extends BadResponse {
     /**
-     * Creates an instance of the `ServerError` class.
-     *
-     * @param {string} message - A descriptive message explaining the cause of the server error.
-     * @param {any} cause - Optional additional information about the cause of the error.
+     * @param message - Error description.
+     * @param cause - Optional extra context (serialized to JSON).
      */
     constructor(message, cause) {
         super();
@@ -19,12 +20,7 @@ class ServerError extends BadResponse {
         this.cause = cause ? JSON.stringify(cause) : undefined;
         this.onDebug();
     }
-    /**
-     * Converts the `ServerError` instance into a `Response` object with a JSON body.
-     * This method ensures the response has the appropriate headers, status, and status text.
-     *
-     * @returns {Response} A `Response` object with the serialized JSON body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },
@@ -33,12 +29,7 @@ class ServerError extends BadResponse {
         };
         return new Response(JSON.stringify(this.makeBody()), responseInit);
     }
-    /**
-     * Converts the `ServerError` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON error responses.
-     *
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson() {
         const responseInit = {
             status: this.status,

package/dist/http/badResponses/unauthorized.d.ts

@@ -1,30 +1,21 @@
 import { BadResponse } from "./_badResponse";
 /**
- * Represents an HTTP error response with a status code of 401 (Unauthorized).
- * This class is used to standardize the structure of an "Unauthorized" error response,
- * including the response body, headers, status, and status text.
+ * HTTP 401 Unauthorized — the request lacks valid authentication credentials.
+ *
+ * @example
+ * ```typescript
+ * throw new Unauthorized("Invalid or expired token");
+ * ```
  */
 declare class Unauthorized extends BadResponse {
     /**
-     * Creates an instance of the `Unauthorized` class.
-     *
-     * @param message - A descriptive message explaining why the request is unauthorized.
-     * @param cause - Optional additional information about the cause of the error.
+     * @param message - Error description.
+     * @param cause - Optional extra context (serialized to JSON).
      */
     constructor(message: string, cause?: any);
-    /**
-     * Converts the `Unauthorized` instance into a `Response` object with a JSON body.
-     * This method ensures the response has the appropriate headers, status, and status text.
-     *
-     * @returns {Response} A `Response` object with the serialized JSON body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse(): Response;
-    /**
-     * Converts the `Unauthorized` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON error responses.
-     *
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson(): Response;
 }
 export { Unauthorized };

package/dist/http/badResponses/unauthorized.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unauthorized.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/unauthorized.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;GAIG;AAEH,cAAM,YAAa,SAAQ,WAAW;IACpC;;;;;OAKG;gBAES,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAYxC;;;;;OAKG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;;OAKG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"unauthorized.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/unauthorized.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;;;;GAOG;AACH,cAAM,YAAa,SAAQ,WAAW;IACpC;;;OAGG;gBACS,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAYxC,6EAA6E;IAC7E,UAAU,IAAI,QAAQ;IAUtB,uFAAuF;IACvF,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/http/badResponses/unauthorized.js

@@ -1,15 +1,16 @@
 import { BadResponse } from "./_badResponse";
 /**
- * Represents an HTTP error response with a status code of 401 (Unauthorized).
- * This class is used to standardize the structure of an "Unauthorized" error response,
- * including the response body, headers, status, and status text.
+ * HTTP 401 Unauthorized — the request lacks valid authentication credentials.
+ *
+ * @example
+ * ```typescript
+ * throw new Unauthorized("Invalid or expired token");
+ * ```
  */
 class Unauthorized extends BadResponse {
     /**
-     * Creates an instance of the `Unauthorized` class.
-     *
-     * @param message - A descriptive message explaining why the request is unauthorized.
-     * @param cause - Optional additional information about the cause of the error.
+     * @param message - Error description.
+     * @param cause - Optional extra context (serialized to JSON).
      */
     constructor(message, cause) {
         super();
@@ -20,12 +21,7 @@ class Unauthorized extends BadResponse {
         this.cause = cause ? JSON.stringify(cause) : undefined;
         this.onDebug();
     }
-    /**
-     * Converts the `Unauthorized` instance into a `Response` object with a JSON body.
-     * This method ensures the response has the appropriate headers, status, and status text.
-     *
-     * @returns {Response} A `Response` object with the serialized JSON body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },
@@ -34,12 +30,7 @@ class Unauthorized extends BadResponse {
         };
         return new Response(JSON.stringify(this.makeBody()), responseInit);
     }
-    /**
-     * Converts the `Unauthorized` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON error responses.
-     *
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson() {
         const responseInit = {
             status: this.status,

package/dist/http/badResponses/unprocessableEntity.d.ts

@@ -1,18 +1,23 @@
 import { BadResponse } from "./_badResponse";
 /**
- * Represents an HTTP error response with a status code of 422 (Unprocessable Entity).
- * This class is used to standardize the structure of an "Unprocessable Entity" error response,
- * including the response body, headers, status, and status text.
+ * HTTP 422 Unprocessable Entity — the request is well-formed but contains semantic validation errors.
+ * Typically used for form field validation failures.
+ *
+ * @example
+ * ```typescript
+ * throw new UnprocessableEntity({
+ *   message: "Validation failed",
+ *   fieldErrors: { email: "Invalid email format", age: "Must be 18 or older" },
+ *   fields: { email: "not-an-email", age: "15" },
+ * });
+ * ```
  */
 declare class UnprocessableEntity extends BadResponse {
     /**
-     * Creates an instance of the `UnprocessableEntity` class.
-     *
-     * @param {object} props - An object containing details about the error, such as:
-     * @param {any} [props.data] - `data`: Additional data related to the error.
-     * @param {Record<string, string>} [props.fieldErrors] - `fieldErrors`: A record of field-specific error messages.
-     * @param {Record<string, string>} [props.fields] - `fields`: A record of field values that caused the error.
-     * @param {string} [props.message] - `message`: A descriptive message explaining the error.
+     * @param props.message - Human-readable description of the error.
+     * @param props.fieldErrors - Per-field validation messages keyed by field name.
+     * @param props.fields - Original submitted field values (useful for repopulating forms).
+     * @param props.data - Any extra data to include in the response body.
      */
     constructor(props: {
         data?: any;
@@ -20,19 +25,9 @@ declare class UnprocessableEntity extends BadResponse {
         fields?: Record<string, string>;
         message?: string;
     });
-    /**
-     * Converts the `UnprocessableEntity` instance into a `Response` object with a JSON body.
-     * This method ensures the response has the appropriate headers, status, and status text.
-     *
-     * @returns {Response} A `Response` object with the serialized JSON body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse(): Response;
-    /**
-     * Converts the `UnprocessableEntity` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON error responses.
-     *
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson(): Response;
 }
 export { UnprocessableEntity };

package/dist/http/badResponses/unprocessableEntity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unprocessableEntity.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/unprocessableEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;GAIG;AAEH,cAAM,mBAAoB,SAAQ,WAAW;IAC3C;;;;;;;;OAQG;gBAES,KAAK,EAAE;QACjB,IAAI,CAAC,EAAE,GAAG,CAAC;QACX,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACrC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAgBD;;;;;OAKG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;;OAKG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"unprocessableEntity.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/unprocessableEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;;;;;;;;;GAYG;AACH,cAAM,mBAAoB,SAAQ,WAAW;IAC3C;;;;;OAKG;gBACS,KAAK,EAAE;QACjB,IAAI,CAAC,EAAE,GAAG,CAAC;QACX,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACrC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAgBD,6EAA6E;IAC7E,UAAU,IAAI,QAAQ;IAUtB,uFAAuF;IACvF,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}

package/dist/http/badResponses/unprocessableEntity.js

@@ -1,18 +1,23 @@
 import { BadResponse } from "./_badResponse";
 /**
- * Represents an HTTP error response with a status code of 422 (Unprocessable Entity).
- * This class is used to standardize the structure of an "Unprocessable Entity" error response,
- * including the response body, headers, status, and status text.
+ * HTTP 422 Unprocessable Entity — the request is well-formed but contains semantic validation errors.
+ * Typically used for form field validation failures.
+ *
+ * @example
+ * ```typescript
+ * throw new UnprocessableEntity({
+ *   message: "Validation failed",
+ *   fieldErrors: { email: "Invalid email format", age: "Must be 18 or older" },
+ *   fields: { email: "not-an-email", age: "15" },
+ * });
+ * ```
  */
 class UnprocessableEntity extends BadResponse {
     /**
-     * Creates an instance of the `UnprocessableEntity` class.
-     *
-     * @param {object} props - An object containing details about the error, such as:
-     * @param {any} [props.data] - `data`: Additional data related to the error.
-     * @param {Record<string, string>} [props.fieldErrors] - `fieldErrors`: A record of field-specific error messages.
-     * @param {Record<string, string>} [props.fields] - `fields`: A record of field values that caused the error.
-     * @param {string} [props.message] - `message`: A descriptive message explaining the error.
+     * @param props.message - Human-readable description of the error.
+     * @param props.fieldErrors - Per-field validation messages keyed by field name.
+     * @param props.fields - Original submitted field values (useful for repopulating forms).
+     * @param props.data - Any extra data to include in the response body.
      */
     constructor(props) {
         super();
@@ -27,12 +32,7 @@ class UnprocessableEntity extends BadResponse {
         };
         this.onDebug();
     }
-    /**
-     * Converts the `UnprocessableEntity` instance into a `Response` object with a JSON body.
-     * This method ensures the response has the appropriate headers, status, and status text.
-     *
-     * @returns {Response} A `Response` object with the serialized JSON body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },
@@ -41,12 +41,7 @@ class UnprocessableEntity extends BadResponse {
         };
         return new Response(JSON.stringify(this.makeBody()), responseInit);
     }
-    /**
-     * Converts the `UnprocessableEntity` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON error responses.
-     *
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson() {
         const responseInit = {
             status: this.status,

package/dist/http/successResponses/created.d.ts

@@ -1,25 +1,21 @@
 import { SuccessResponse } from "./_successResponse";
 /**
- * Class representing a successful HTTP 201 Created response.
+ * HTTP 201 Created — the request succeeded and a new resource was created.
+ *
+ * @example
+ * ```typescript
+ * return new Created("User created successfully", { id: user.id }).toJson();
+ * ```
  */
 declare class Created extends SuccessResponse {
     /**
-     * Creates an instance of the `Created` class.
-     *
-     * @param {string} message - A message describing the creation status.
-     * @param {any} body - The response body to be included in the HTTP response.
+     * @param message - Description included in the response status text.
+     * @param body - Data to include in the response body.
      */
     constructor(message: string, body?: any);
-    /**
-     * Converts the `Created` instance into a `Response` object.
-     * @returns {Response} A `Response` object with the body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse(): Response;
-    /**
-     * Converts the `Created` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON responses.
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson(): Response;
 }
 export { Created };

package/dist/http/successResponses/created.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"created.d.ts","sourceRoot":"","sources":["../../../src/http/successResponses/created.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;GAEG;AAEH,cAAM,OAAQ,SAAQ,eAAe;IACnC;;;;;OAKG;gBAES,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG;IAWvC;;;OAGG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;OAIG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"created.d.ts","sourceRoot":"","sources":["../../../src/http/successResponses/created.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;;;;GAOG;AACH,cAAM,OAAQ,SAAQ,eAAe;IACnC;;;OAGG;gBACS,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG;IAWvC,6EAA6E;IAC7E,UAAU,IAAI,QAAQ;IAUtB,uFAAuF;IACvF,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/dist/http/successResponses/created.js

@@ -1,13 +1,16 @@
 import { SuccessResponse } from "./_successResponse";
 /**
- * Class representing a successful HTTP 201 Created response.
+ * HTTP 201 Created — the request succeeded and a new resource was created.
+ *
+ * @example
+ * ```typescript
+ * return new Created("User created successfully", { id: user.id }).toJson();
+ * ```
  */
 class Created extends SuccessResponse {
     /**
-     * Creates an instance of the `Created` class.
-     *
-     * @param {string} message - A message describing the creation status.
-     * @param {any} body - The response body to be included in the HTTP response.
+     * @param message - Description included in the response status text.
+     * @param body - Data to include in the response body.
      */
     constructor(message, body) {
         super();
@@ -17,10 +20,7 @@ class Created extends SuccessResponse {
         this.body = body || undefined;
         this.onDebug();
     }
-    /**
-     * Converts the `Created` instance into a `Response` object.
-     * @returns {Response} A `Response` object with the body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },
@@ -29,11 +29,7 @@ class Created extends SuccessResponse {
         };
         return new Response(JSON.stringify(this.body), responseInit);
     }
-    /**
-     * Converts the `Created` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON responses.
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson() {
         const responseInit = {
             status: this.status,

package/dist/http/successResponses/found.d.ts

@@ -1,25 +1,21 @@
 import { SuccessResponse } from "./_successResponse";
 /**
- * Class representing a successful HTTP 302 Found response.
+ * HTTP 302 Found — the resource was located and the response includes it in the body.
+ *
+ * @example
+ * ```typescript
+ * return new Found("Products retrieved", { products }).toJson();
+ * ```
  */
 declare class Found extends SuccessResponse {
     /**
-     * Creates an instance of the `Found` class.
-     *
-     * @param {string} message - A message describing the creation status.
-     * @param {any} body - The response body to be included in the HTTP response.
+     * @param message - Description included in the response status text.
+     * @param body - Data to include in the response body.
      */
     constructor(message: string, body?: any);
-    /**
-     * Converts the `Found` instance into a `Response` object.
-     * @returns {Response} A `Response` object with the body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse(): Response;
-    /**
-     * Converts the `Found` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON responses.
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson(): Response;
 }
 export { Found };

package/dist/http/successResponses/found.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"found.d.ts","sourceRoot":"","sources":["../../../src/http/successResponses/found.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;GAEG;AAEH,cAAM,KAAM,SAAQ,eAAe;IACjC;;;;;OAKG;gBAES,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG;IAWvC;;;OAGG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;OAIG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,KAAK,EAAE,CAAC"}
+{"version":3,"file":"found.d.ts","sourceRoot":"","sources":["../../../src/http/successResponses/found.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;;;;GAOG;AACH,cAAM,KAAM,SAAQ,eAAe;IACjC;;;OAGG;gBACS,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG;IAWvC,6EAA6E;IAC7E,UAAU,IAAI,QAAQ;IAUtB,uFAAuF;IACvF,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/dist/http/successResponses/found.js

@@ -1,13 +1,16 @@
 import { SuccessResponse } from "./_successResponse";
 /**
- * Class representing a successful HTTP 302 Found response.
+ * HTTP 302 Found — the resource was located and the response includes it in the body.
+ *
+ * @example
+ * ```typescript
+ * return new Found("Products retrieved", { products }).toJson();
+ * ```
  */
 class Found extends SuccessResponse {
     /**
-     * Creates an instance of the `Found` class.
-     *
-     * @param {string} message - A message describing the creation status.
-     * @param {any} body - The response body to be included in the HTTP response.
+     * @param message - Description included in the response status text.
+     * @param body - Data to include in the response body.
      */
     constructor(message, body) {
         super();
@@ -17,10 +20,7 @@ class Found extends SuccessResponse {
         this.body = body || undefined;
         this.onDebug();
     }
-    /**
-     * Converts the `Found` instance into a `Response` object.
-     * @returns {Response} A `Response` object with the body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },
@@ -29,11 +29,7 @@ class Found extends SuccessResponse {
         };
         return new Response(JSON.stringify(this.body), responseInit);
     }
-    /**
-     * Converts the `Found` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON responses.
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson() {
         const responseInit = {
             status: this.status,

package/dist/http/successResponses/noContent.d.ts

@@ -1,17 +1,19 @@
 import { SuccessResponse } from "./_successResponse";
 /**
- * Class representing a successful HTTP 204 NoContent response.
+ * HTTP 204 No Content — the request succeeded but there is no content to return.
+ * Typically used for delete or update operations where a body is not needed.
+ *
+ * @example
+ * ```typescript
+ * return new NoContent("Record deleted").toResponse();
+ * ```
  */
 declare class NoContent extends SuccessResponse {
     /**
-     * Creates an instance of the `NoContent` class.
-     * @param {string} message - A message describing the creation status.
+     * @param message - Description included in the response status text.
      */
     constructor(message: string);
-    /**
-     * Converts the `NoContent` instance into a `Response` object.
-     * @returns {Response} A `Response` object with the body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header and no body. */
     toResponse(): Response;
 }
 export { NoContent };

package/dist/http/successResponses/noContent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"noContent.d.ts","sourceRoot":"","sources":["../../../src/http/successResponses/noContent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;GAEG;AAEH,cAAM,SAAU,SAAQ,eAAe;IACrC;;;OAGG;gBAES,OAAO,EAAE,MAAM;IAU3B;;;OAGG;IAEH,UAAU,IAAI,QAAQ;CASvB;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}
+{"version":3,"file":"noContent.d.ts","sourceRoot":"","sources":["../../../src/http/successResponses/noContent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;;;;;GAQG;AACH,cAAM,SAAU,SAAQ,eAAe;IACrC;;OAEG;gBACS,OAAO,EAAE,MAAM;IAU3B,yFAAyF;IACzF,UAAU,IAAI,QAAQ;CASvB;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/dist/http/successResponses/noContent.js

@@ -1,11 +1,16 @@
 import { SuccessResponse } from "./_successResponse";
 /**
- * Class representing a successful HTTP 204 NoContent response.
+ * HTTP 204 No Content — the request succeeded but there is no content to return.
+ * Typically used for delete or update operations where a body is not needed.
+ *
+ * @example
+ * ```typescript
+ * return new NoContent("Record deleted").toResponse();
+ * ```
  */
 class NoContent extends SuccessResponse {
     /**
-     * Creates an instance of the `NoContent` class.
-     * @param {string} message - A message describing the creation status.
+     * @param message - Description included in the response status text.
      */
     constructor(message) {
         super();
@@ -14,10 +19,7 @@ class NoContent extends SuccessResponse {
         this.statusText = message;
         this.onDebug();
     }
-    /**
-     * Converts the `NoContent` instance into a `Response` object.
-     * @returns {Response} A `Response` object with the body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header and no body. */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },

package/dist/http/successResponses/success.d.ts

@@ -1,25 +1,21 @@
 import { SuccessResponse } from "./_successResponse";
 /**
- * Class representing a successful HTTP 200 Success response.
+ * HTTP 200 OK — the request succeeded and the response body contains the result.
+ *
+ * @example
+ * ```typescript
+ * return new Success("Order fetched", { order }).toJson();
+ * ```
  */
 declare class Success extends SuccessResponse {
     /**
-     * Creates an instance of the `Success` class.
-     *
-     * @param {string} message - A message describing the creation status.
-     * @param {any} body - The response body to be included in the HTTP response.
+     * @param message - Description included in the response status text.
+     * @param body - Data to include in the response body.
      */
     constructor(message: string, body?: any);
-    /**
-     * Converts the `Success` instance into a `Response` object.
-     * @returns {Response} A `Response` object with the body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse(): Response;
-    /**
-     * Converts the `Success` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON responses.
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson(): Response;
 }
 export { Success };

package/dist/http/successResponses/success.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"success.d.ts","sourceRoot":"","sources":["../../../src/http/successResponses/success.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;GAEG;AAEH,cAAM,OAAQ,SAAQ,eAAe;IACnC;;;;;OAKG;gBAES,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG;IAWvC;;;OAGG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;OAIG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"success.d.ts","sourceRoot":"","sources":["../../../src/http/successResponses/success.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;;;;GAOG;AACH,cAAM,OAAQ,SAAQ,eAAe;IACnC;;;OAGG;gBACS,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG;IAWvC,6EAA6E;IAC7E,UAAU,IAAI,QAAQ;IAUtB,uFAAuF;IACvF,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,OAAO,EAAE,CAAC"}