@arkyn/server 2.0.1-beta.10 → 2.0.1-beta.12

package/dist/config/arkynInstance.d.ts

@@ -0,0 +1,28 @@
+type InboxKeysProps = {
+    inboxKey: string;
+    inboxUserToken: string;
+};
+/**
+ * The `ArkynInstance` class is a singleton-like utility designed to manage and provide access
+ * to inbox configuration keys (`InboxKeysProps`) within the application. It ensures that the
+ * inbox keys are set before they can be retrieved, throwing an error if they are accessed
+ * without being initialized.
+ *
+ * @example
+ * ```typescript
+ * // Setting the inbox keys
+ * ArkynInstance.setInboxKeys({ key1: "value1", key2: "value2" });
+ *
+ * // Retrieving the inbox keys
+ * const inboxKeys = ArkynInstance.getInboxKeys();
+ * console.log(inboxKeys);
+ * ```
+ */
+declare class ArkynInstance {
+    static inboxKeys?: InboxKeysProps;
+    constructor();
+    static setInboxKeys(arkynConfig: InboxKeysProps): void;
+    static getInboxKeys(): InboxKeysProps | undefined;
+}
+export { ArkynInstance };
+//# sourceMappingURL=arkynInstance.d.ts.map

package/dist/config/arkynInstance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arkynInstance.d.ts","sourceRoot":"","sources":["../../src/config/arkynInstance.ts"],"names":[],"mappings":"AAAA,KAAK,cAAc,GAAG;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AAEH,cAAM,aAAa;IACjB,MAAM,CAAC,SAAS,CAAC,EAAE,cAAc,CAAC;;IAIlC,MAAM,CAAC,YAAY,CAAC,WAAW,EAAE,cAAc;IAI/C,MAAM,CAAC,YAAY;CAGpB;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/config/arkynInstance.js

@@ -0,0 +1,28 @@
+/**
+ * The `ArkynInstance` class is a singleton-like utility designed to manage and provide access
+ * to inbox configuration keys (`InboxKeysProps`) within the application. It ensures that the
+ * inbox keys are set before they can be retrieved, throwing an error if they are accessed
+ * without being initialized.
+ *
+ * @example
+ * ```typescript
+ * // Setting the inbox keys
+ * ArkynInstance.setInboxKeys({ key1: "value1", key2: "value2" });
+ *
+ * // Retrieving the inbox keys
+ * const inboxKeys = ArkynInstance.getInboxKeys();
+ * console.log(inboxKeys);
+ * ```
+ */
+class ArkynInstance {
+    static inboxKeys;
+    constructor() { }
+    static setInboxKeys(arkynConfig) {
+        if (!this.inboxKeys)
+            this.inboxKeys = arkynConfig;
+    }
+    static getInboxKeys() {
+        return this.inboxKeys;
+    }
+}
+export { ArkynInstance };

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

@@ -1,10 +1,33 @@
+/**
+ * Represents an HTTP error response with a status code of 502 (Bad Gateway).
+ * This class is used to standardize the structure of a "Bad Gateway" error response,
+ * including the response body, headers, status, and status text.
+ */
 declare class BadGateway {
     body: any;
     cause?: any;
     status: number;
     statusText: string;
+    /**
+     * Creates an instance of the `BadGateway` class.
+     *
+     * @param message - A descriptive message explaining the cause of the error.
+     * @param cause - Optional additional information about the cause of the error.
+     */
     constructor(message: string, cause?: any);
+    /**
+     * Converts the `BadGateway` instance into a `Response` object with a JSON body.
+     * This method ensures the response has the appropriate headers, status, and status text.
+     *
+     * @returns A `Response` object with the serialized JSON body and response metadata.
+     */
     toResponse(): Response;
+    /**
+     * Converts the `BadGateway` instance into a `Response` object using the `Response.json` method.
+     * This method is an alternative to `toResponse` for generating JSON error responses.
+     *
+     * @returns A `Response` object with the JSON body and response metadata.
+     */
     toJson(): Response;
 }
 export { BadGateway };

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

@@ -1 +1 @@
-{"version":3,"file":"badGateway.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/badGateway.ts"],"names":[],"mappings":"AAEA,cAAM,UAAU;IACd,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;gBAEP,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC,UAAU;IAUV,MAAM;CAQP;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"badGateway.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/badGateway.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH,cAAM,UAAU;IACd,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;gBAES,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC;;;;;OAKG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;;OAKG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/http/badResponses/badGateway.js

@@ -1,15 +1,32 @@
 import { httpDebug } from "../../services/httpDebug";
+/**
+ * Represents an HTTP error response with a status code of 502 (Bad Gateway).
+ * This class is used to standardize the structure of a "Bad Gateway" error response,
+ * including the response body, headers, status, and status text.
+ */
 class BadGateway {
     body;
     cause;
     status = 502;
     statusText;
+    /**
+     * Creates an instance of the `BadGateway` class.
+     *
+     * @param message - A descriptive message explaining the cause of the error.
+     * @param cause - Optional additional information about the cause of the error.
+     */
     constructor(message, cause) {
         this.body = { name: "BadGateway", message: message };
         this.statusText = message;
         this.cause = cause ? JSON.stringify(cause) : undefined;
         httpDebug("BadGateway", this.body, this.cause);
     }
+    /**
+     * Converts the `BadGateway` instance into a `Response` object with a JSON body.
+     * This method ensures the response has the appropriate headers, status, and status text.
+     *
+     * @returns A `Response` object with the serialized JSON body and response metadata.
+     */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },
@@ -18,6 +35,12 @@ class BadGateway {
         };
         return new Response(JSON.stringify(this.body), responseInit);
     }
+    /**
+     * Converts the `BadGateway` instance into a `Response` object using the `Response.json` method.
+     * This method is an alternative to `toResponse` for generating JSON error responses.
+     *
+     * @returns A `Response` object with the JSON body and response metadata.
+     */
     toJson() {
         const responseInit = {
             status: this.status,

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

@@ -1,10 +1,33 @@
+/**
+ * Represents an HTTP error response with a status code of 400 (Bad Request).
+ * This class is used to standardize the structure of a "Bad Request" error response,
+ * including the response body, headers, status, and status text.
+ */
 declare class BadRequest {
     body: any;
     cause?: any;
     status: number;
     statusText: string;
+    /**
+     * Creates an instance of the `BadRequest` class.
+     *
+     * @param message - A descriptive message explaining the cause of the error.
+     * @param cause - Optional additional information about the cause of the error.
+     */
     constructor(message: string, cause?: any);
+    /**
+     * Converts the `BadRequest` instance into a `Response` object with a JSON body.
+     * This method ensures the response has the appropriate headers, status, and status text.
+     *
+     * @returns A `Response` object with the serialized JSON body and response metadata.
+     */
     toResponse(): Response;
+    /**
+     * Converts the `BadRequest` instance into a `Response` object using the `Response.json` method.
+     * This method is an alternative to `toResponse` for generating JSON error responses.
+     *
+     * @returns A `Response` object with the JSON body and response metadata.
+     */
     toJson(): Response;
 }
 export { BadRequest };

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

@@ -1 +1 @@
-{"version":3,"file":"badRequest.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/badRequest.ts"],"names":[],"mappings":"AAEA,cAAM,UAAU;IACd,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;gBAEP,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC,UAAU;IAUV,MAAM;CAQP;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"badRequest.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/badRequest.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH,cAAM,UAAU;IACd,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;gBAES,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC;;;;;OAKG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;;OAKG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/http/badResponses/badRequest.js

@@ -1,15 +1,32 @@
 import { httpDebug } from "../../services/httpDebug";
+/**
+ * Represents an HTTP error response with a status code of 400 (Bad Request).
+ * This class is used to standardize the structure of a "Bad Request" error response,
+ * including the response body, headers, status, and status text.
+ */
 class BadRequest {
     body;
     cause;
     status = 400;
     statusText;
+    /**
+     * Creates an instance of the `BadRequest` class.
+     *
+     * @param message - A descriptive message explaining the cause of the error.
+     * @param cause - Optional additional information about the cause of the error.
+     */
     constructor(message, cause) {
         this.body = { name: "BadRequest", message: message };
         this.statusText = message;
         this.cause = cause ? JSON.stringify(cause) : undefined;
         httpDebug("BadRequest", this.body, this.cause);
     }
+    /**
+     * Converts the `BadRequest` instance into a `Response` object with a JSON body.
+     * This method ensures the response has the appropriate headers, status, and status text.
+     *
+     * @returns A `Response` object with the serialized JSON body and response metadata.
+     */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },
@@ -18,6 +35,12 @@ class BadRequest {
         };
         return new Response(JSON.stringify(this.body), responseInit);
     }
+    /**
+     * Converts the `BadRequest` instance into a `Response` object using the `Response.json` method.
+     * This method is an alternative to `toResponse` for generating JSON error responses.
+     *
+     * @returns A `Response` object with the JSON body and response metadata.
+     */
     toJson() {
         const responseInit = {
             status: this.status,

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

@@ -1,10 +1,33 @@
+/**
+ * Represents an HTTP error response with a status code of 409 (Conflict).
+ * This class is used to standardize the structure of a "Conflict" error response,
+ * including the response body, headers, status, and status text.
+ */
 declare class Conflict {
     body: any;
     cause?: any;
     status: number;
     statusText: string;
+    /**
+     * Creates an instance of the `Conflict` class.
+     *
+     * @param message - A descriptive message explaining the cause of the conflict.
+     * @param cause - Optional additional information about the cause of the conflict.
+     */
     constructor(message: string, cause?: any);
+    /**
+     * Converts the `Conflict` instance into a `Response` object with a JSON body.
+     * This method ensures the response has the appropriate headers, status, and status text.
+     *
+     * @returns A `Response` object with the serialized JSON body and response metadata.
+     */
     toResponse(): Response;
+    /**
+     * Converts the `Conflict` instance into a `Response` object using the `Response.json` method.
+     * This method is an alternative to `toResponse` for generating JSON error responses.
+     *
+     * @returns A `Response` object with the JSON body and response metadata.
+     */
     toJson(): Response;
 }
 export { Conflict };

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

@@ -1 +1 @@
-{"version":3,"file":"conflict.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/conflict.ts"],"names":[],"mappings":"AAEA,cAAM,QAAQ;IACZ,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;gBAEP,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC,UAAU;IAUV,MAAM;CAQP;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"conflict.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/conflict.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH,cAAM,QAAQ;IACZ,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;gBAES,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC;;;;;OAKG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;;OAKG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/dist/http/badResponses/conflict.js

@@ -1,15 +1,32 @@
 import { httpDebug } from "../../services/httpDebug";
+/**
+ * Represents an HTTP error response with a status code of 409 (Conflict).
+ * This class is used to standardize the structure of a "Conflict" error response,
+ * including the response body, headers, status, and status text.
+ */
 class Conflict {
     body;
     cause;
     status = 409;
     statusText;
+    /**
+     * Creates an instance of the `Conflict` class.
+     *
+     * @param message - A descriptive message explaining the cause of the conflict.
+     * @param cause - Optional additional information about the cause of the conflict.
+     */
     constructor(message, cause) {
         this.body = { name: "Conflict", message: message };
         this.statusText = message;
         this.cause = cause ? JSON.stringify(cause) : undefined;
         httpDebug("Conflict", this.body, this.cause);
     }
+    /**
+     * Converts the `Conflict` instance into a `Response` object with a JSON body.
+     * This method ensures the response has the appropriate headers, status, and status text.
+     *
+     * @returns A `Response` object with the serialized JSON body and response metadata.
+     */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },
@@ -18,6 +35,12 @@ class Conflict {
         };
         return new Response(JSON.stringify(this.body), responseInit);
     }
+    /**
+     * Converts the `Conflict` instance into a `Response` object using the `Response.json` method.
+     * This method is an alternative to `toResponse` for generating JSON error responses.
+     *
+     * @returns A `Response` object with the JSON body and response metadata.
+     */
     toJson() {
         const responseInit = {
             status: this.status,

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

@@ -1,10 +1,33 @@
+/**
+ * Represents an HTTP error response with a status code of 403 (Forbidden).
+ * This class is used to standardize the structure of a "Forbidden" error response,
+ * including the response body, headers, status, and status text.
+ */
 declare class Forbidden {
     body: any;
     cause?: any;
     status: number;
     statusText: string;
+    /**
+     * Creates an instance of the `Forbidden` class.
+     *
+     * @param message - A descriptive message explaining why access is forbidden.
+     * @param cause - Optional additional information about the cause of the error.
+     */
     constructor(message: string, cause?: any);
+    /**
+     * Converts the `Forbidden` instance into a `Response` object with a JSON body.
+     * This method ensures the response has the appropriate headers, status, and status text.
+     *
+     * @returns A `Response` object with the serialized JSON body and response metadata.
+     */
     toResponse(): Response;
+    /**
+     * Converts the `Forbidden` instance into a `Response` object using the `Response.json` method.
+     * This method is an alternative to `toResponse` for generating JSON error responses.
+     *
+     * @returns A `Response` object with the JSON body and response metadata.
+     */
     toJson(): Response;
 }
 export { Forbidden };

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

@@ -1 +1 @@
-{"version":3,"file":"forbidden.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/forbidden.ts"],"names":[],"mappings":"AAEA,cAAM,SAAS;IACb,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;gBAEP,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC,UAAU;IAUV,MAAM;CAQP;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}
+{"version":3,"file":"forbidden.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/forbidden.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH,cAAM,SAAS;IACb,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;gBAES,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC;;;;;OAKG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;;OAKG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/dist/http/badResponses/forbidden.js

@@ -1,15 +1,32 @@
 import { httpDebug } from "../../services/httpDebug";
+/**
+ * Represents an HTTP error response with a status code of 403 (Forbidden).
+ * This class is used to standardize the structure of a "Forbidden" error response,
+ * including the response body, headers, status, and status text.
+ */
 class Forbidden {
     body;
     cause;
-    status = 402;
+    status = 403;
     statusText;
+    /**
+     * Creates an instance of the `Forbidden` class.
+     *
+     * @param message - A descriptive message explaining why access is forbidden.
+     * @param cause - Optional additional information about the cause of the error.
+     */
     constructor(message, cause) {
         this.body = { name: "Forbidden", message: message };
         this.statusText = message;
         this.cause = cause ? JSON.stringify(cause) : undefined;
         httpDebug("Forbidden", this.body, this.cause);
     }
+    /**
+     * Converts the `Forbidden` instance into a `Response` object with a JSON body.
+     * This method ensures the response has the appropriate headers, status, and status text.
+     *
+     * @returns A `Response` object with the serialized JSON body and response metadata.
+     */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },
@@ -18,6 +35,12 @@ class Forbidden {
         };
         return new Response(JSON.stringify(this.body), responseInit);
     }
+    /**
+     * Converts the `Forbidden` instance into a `Response` object using the `Response.json` method.
+     * This method is an alternative to `toResponse` for generating JSON error responses.
+     *
+     * @returns A `Response` object with the JSON body and response metadata.
+     */
     toJson() {
         const responseInit = {
             status: this.status,

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

@@ -1,10 +1,33 @@
+/**
+ * Represents an HTTP error response with a status code of 404 (Not Found).
+ * This class is used to standardize the structure of a "Not Found" error response,
+ * including the response body, headers, status, and status text.
+ */
 declare class NotFound {
     body: any;
     cause?: any;
     status: number;
     statusText: string;
+    /**
+     * Creates an instance of the `NotFound` class.
+     *
+     * @param message - A descriptive message explaining the reason the resource was not found.
+     * @param cause - Optional additional information about the cause of the error.
+     */
     constructor(message: string, cause?: any);
+    /**
+     * Converts the `NotFound` instance into a `Response` object with a JSON body.
+     * This method ensures the response has the appropriate headers, status, and status text.
+     *
+     * @returns A `Response` object with the serialized JSON body and response metadata.
+     */
     toResponse(): Response;
+    /**
+     * Converts the `NotFound` instance into a `Response` object using the `Response.json` method.
+     * This method is an alternative to `toResponse` for generating JSON error responses.
+     *
+     * @returns A `Response` object with the JSON body and response metadata.
+     */
     toJson(): Response;
 }
 export { NotFound };

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

@@ -1 +1 @@
-{"version":3,"file":"notFound.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/notFound.ts"],"names":[],"mappings":"AAEA,cAAM,QAAQ;IACZ,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;gBAEP,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC,UAAU;IAUV,MAAM;CAQP;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"notFound.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/notFound.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH,cAAM,QAAQ;IACZ,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;gBAES,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC;;;;;OAKG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;;OAKG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/dist/http/badResponses/notFound.js

@@ -1,15 +1,32 @@
 import { httpDebug } from "../../services/httpDebug";
+/**
+ * Represents an HTTP error response with a status code of 404 (Not Found).
+ * This class is used to standardize the structure of a "Not Found" error response,
+ * including the response body, headers, status, and status text.
+ */
 class NotFound {
     body;
     cause;
     status = 404;
     statusText;
+    /**
+     * Creates an instance of the `NotFound` class.
+     *
+     * @param message - A descriptive message explaining the reason the resource was not found.
+     * @param cause - Optional additional information about the cause of the error.
+     */
     constructor(message, cause) {
         this.body = { name: "NotFound", message: message };
         this.statusText = message;
         this.cause = cause ? JSON.stringify(cause) : undefined;
         httpDebug("NotFound", this.body, this.cause);
     }
+    /**
+     * Converts the `NotFound` instance into a `Response` object with a JSON body.
+     * This method ensures the response has the appropriate headers, status, and status text.
+     *
+     * @returns A `Response` object with the serialized JSON body and response metadata.
+     */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },
@@ -18,6 +35,12 @@ class NotFound {
         };
         return new Response(JSON.stringify(this.body), responseInit);
     }
+    /**
+     * Converts the `NotFound` instance into a `Response` object using the `Response.json` method.
+     * This method is an alternative to `toResponse` for generating JSON error responses.
+     *
+     * @returns A `Response` object with the JSON body and response metadata.
+     */
     toJson() {
         const responseInit = {
             status: this.status,

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

@@ -1,10 +1,33 @@
+/**
+ * Represents an HTTP error response with a status code of 501 (Not Implemented).
+ * This class is used to standardize the structure of a "Not Implemented" error response,
+ * including the response body, headers, status, and status text.
+ */
 declare class NotImplemented {
     body: any;
     cause?: any;
     status: number;
     statusText: string;
+    /**
+     * Creates an instance of the `NotImplemented` class.
+     *
+     * @param message - A descriptive message explaining why the functionality is not implemented.
+     * @param cause - Optional additional information about the cause of the error.
+     */
     constructor(message: string, cause?: any);
+    /**
+     * Converts the `NotImplemented` instance into a `Response` object with a JSON body.
+     * This method ensures the response has the appropriate headers, status, and status text.
+     *
+     * @returns A `Response` object with the serialized JSON body and response metadata.
+     */
     toResponse(): Response;
+    /**
+     * Converts the `NotImplemented` instance into a `Response` object using the `Response.json` method.
+     * This method is an alternative to `toResponse` for generating JSON error responses.
+     *
+     * @returns A `Response` object with the JSON body and response metadata.
+     */
     toJson(): Response;
 }
 export { NotImplemented };

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

@@ -1 +1 @@
-{"version":3,"file":"notImplemented.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/notImplemented.ts"],"names":[],"mappings":"AAEA,cAAM,cAAc;IAClB,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;gBAEP,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC,UAAU;IAUV,MAAM;CAQP;AAED,OAAO,EAAE,cAAc,EAAE,CAAC"}
+{"version":3,"file":"notImplemented.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/notImplemented.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH,cAAM,cAAc;IAClB,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;gBAES,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC;;;;;OAKG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;;OAKG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/dist/http/badResponses/notImplemented.js

@@ -1,15 +1,32 @@
 import { httpDebug } from "../../services/httpDebug";
+/**
+ * Represents an HTTP error response with a status code of 501 (Not Implemented).
+ * This class is used to standardize the structure of a "Not Implemented" error response,
+ * including the response body, headers, status, and status text.
+ */
 class NotImplemented {
     body;
     cause;
     status = 501;
     statusText;
+    /**
+     * Creates an instance of the `NotImplemented` class.
+     *
+     * @param message - A descriptive message explaining why the functionality is not implemented.
+     * @param cause - Optional additional information about the cause of the error.
+     */
     constructor(message, cause) {
         this.body = { name: "NotImplemented", message: message };
         this.statusText = message;
         this.cause = cause ? JSON.stringify(cause) : undefined;
         httpDebug("NotImplemented", this.body, this.cause);
     }
+    /**
+     * Converts the `NotImplemented` instance into a `Response` object with a JSON body.
+     * This method ensures the response has the appropriate headers, status, and status text.
+     *
+     * @returns A `Response` object with the serialized JSON body and response metadata.
+     */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },
@@ -18,6 +35,12 @@ class NotImplemented {
         };
         return new Response(JSON.stringify(this.body), responseInit);
     }
+    /**
+     * Converts the `NotImplemented` instance into a `Response` object using the `Response.json` method.
+     * This method is an alternative to `toResponse` for generating JSON error responses.
+     *
+     * @returns A `Response` object with the JSON body and response metadata.
+     */
     toJson() {
         const responseInit = {
             status: this.status,

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

@@ -1,10 +1,33 @@
+/**
+ * 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.
+ */
 declare class ServerError {
     body: any;
     cause?: any;
     status: number;
     statusText: string;
+    /**
+     * Creates an instance of the `ServerError` class.
+     *
+     * @param message - A descriptive message explaining the cause of the server error.
+     * @param cause - Optional additional information about the cause of the error.
+     */
     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 A `Response` object with the serialized JSON body and response metadata.
+     */
     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 A `Response` object with the JSON body and response metadata.
+     */
     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":"AAEA,cAAM,WAAW;IACf,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;gBAEP,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC,UAAU;IAUV,MAAM;CAQP;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"serverError.d.ts","sourceRoot":"","sources":["../../../src/http/badResponses/serverError.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH,cAAM,WAAW;IACf,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAO;IACrB,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;gBAES,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;IAOxC;;;;;OAKG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;;OAKG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}