@hastehaul/common 1.0.14 → 1.0.15

package/build/errors/bad-request-error.d.ts

@@ -1,10 +1,32 @@
 import { StatusCodes } from "../utils/enums";
 import { CustomError } from "./custom-error";
+/**
+ * Class representing a "Bad Request" error.
+ *
+ * This error class extends the `CustomError` abstract class and provides specific error details for a "Bad Request" scenario.
+ * Instances of this class are thrown when the client's request is malformed or contains invalid data.
+ */
 export declare class BadRequestError extends CustomError {
     message: string;
+    /**
+     * The HTTP status code associated with the "Bad Request" error (400).
+     */
     statusCode: StatusCodes;
+    /**
+     * Constructs a new instance of the "Bad Request" error.
+     *
+     * @param {string} message - The error message providing details about the "Bad Request" error.
+     */
     constructor(message: string);
-    serializeErrors(): {
+    /**
+     * Method to serialize the "Bad Request" error details into an array of error objects.
+     *
+     * This method returns an array containing a single error object with the error message provided during construction.
+     * The array format is consistent with the `CustomError` class's expectation for error serialization.
+     *
+     * @returns {Array<{ message: string }>} - An array containing a single error object with the error message.
+     */
+    serializeErrors(): Array<{
         message: string;
-    }[];
+    }>;
 }

package/build/errors/bad-request-error.js

@@ -3,13 +3,35 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BadRequestError = void 0;
 const enums_1 = require("../utils/enums");
 const custom_error_1 = require("./custom-error");
+/**
+ * Class representing a "Bad Request" error.
+ *
+ * This error class extends the `CustomError` abstract class and provides specific error details for a "Bad Request" scenario.
+ * Instances of this class are thrown when the client's request is malformed or contains invalid data.
+ */
 class BadRequestError extends custom_error_1.CustomError {
+    /**
+     * Constructs a new instance of the "Bad Request" error.
+     *
+     * @param {string} message - The error message providing details about the "Bad Request" error.
+     */
     constructor(message) {
         super(message);
         this.message = message;
+        /**
+         * The HTTP status code associated with the "Bad Request" error (400).
+         */
         this.statusCode = enums_1.StatusCodes.BAD_REQUEST;
         Object.setPrototypeOf(this, BadRequestError.prototype);
     }
+    /**
+     * Method to serialize the "Bad Request" error details into an array of error objects.
+     *
+     * This method returns an array containing a single error object with the error message provided during construction.
+     * The array format is consistent with the `CustomError` class's expectation for error serialization.
+     *
+     * @returns {Array<{ message: string }>} - An array containing a single error object with the error message.
+     */
     serializeErrors() {
         return [{ message: this.message }];
     }

package/build/errors/custom-error.d.ts

@@ -1,6 +1,30 @@
+/**
+ * Abstract class representing a custom error.
+ *
+ * This abstract class extends the base Error class and serves as a foundation for creating specific error classes for different types of errors.
+ * Classes that extend this abstract class must implement the `statusCode` property and the `serializeErrors` method.
+ */
 export declare abstract class CustomError extends Error {
+    /**
+     * The HTTP status code associated with the error.
+     *
+     * Classes extending `CustomError` must provide a value for this property.
+     */
     abstract statusCode: number;
+    /**
+     * Constructs a new instance of the custom error.
+     *
+     * @param {string} message - The error message.
+     */
     constructor(message?: string);
+    /**
+     * Abstract method that must be implemented in classes extending `CustomError`.
+     *
+     * This method returns an array of error objects containing error messages and optional field information.
+     * The specific implementation of this method depends on the type of custom error and how errors are serialized for responses.
+     *
+     * @returns {Array<{ message: string; field?: string }>} - An array of error objects containing error messages and optional field information.
+     */
     abstract serializeErrors(): {
         message: string;
         field?: string;

package/build/errors/custom-error.js

@@ -1,7 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomError = void 0;
+/**
+ * Abstract class representing a custom error.
+ *
+ * This abstract class extends the base Error class and serves as a foundation for creating specific error classes for different types of errors.
+ * Classes that extend this abstract class must implement the `statusCode` property and the `serializeErrors` method.
+ */
 class CustomError extends Error {
+    /**
+     * Constructs a new instance of the custom error.
+     *
+     * @param {string} message - The error message.
+     */
     constructor(message) {
         super(message);
         Object.setPrototypeOf(this, CustomError.prototype);

package/build/errors/database-error.d.ts

@@ -1,9 +1,31 @@
 import { StatusCodes } from '../utils/enums';
 import { CustomError } from './custom-error';
+/**
+ * Class representing a database-related error.
+ *
+ * This error class extends the `CustomError` abstract class and provides specific error details for database-related errors.
+ * Instances of this class are thrown when there are errors related to connecting to or interacting with the database.
+ */
 export declare class DatabaseError extends CustomError {
+    /**
+     * The HTTP status code associated with the database-related error (500 - Internal Server Error).
+     */
     statusCode: StatusCodes;
+    /**
+     * Constructs a new instance of the database-related error.
+     *
+     * @param {string} message - The error message providing details about the database-related error.
+     */
     constructor(message?: string);
-    serializeErrors: () => {
+    /**
+     * Method to serialize the database-related error details into an array of error objects.
+     *
+     * This method returns an array containing a single error object with the error message provided during construction.
+     * The array format is consistent with the `CustomError` class's expectation for error serialization.
+     *
+     * @returns {Array<{ message: string }>} - An array containing a single error object with the error message.
+     */
+    serializeErrors: () => Array<{
         message: string;
-    }[];
+    }>;
 }

package/build/errors/database-error.js

@@ -3,10 +3,32 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DatabaseError = void 0;
 const enums_1 = require("../utils/enums");
 const custom_error_1 = require("./custom-error");
+/**
+ * Class representing a database-related error.
+ *
+ * This error class extends the `CustomError` abstract class and provides specific error details for database-related errors.
+ * Instances of this class are thrown when there are errors related to connecting to or interacting with the database.
+ */
 class DatabaseError extends custom_error_1.CustomError {
+    /**
+     * Constructs a new instance of the database-related error.
+     *
+     * @param {string} message - The error message providing details about the database-related error.
+     */
     constructor(message = "Error connecting to database") {
         super(message);
-        this.statusCode = enums_1.StatusCodes.INTERNALE_SERVER_ERROR;
+        /**
+         * The HTTP status code associated with the database-related error (500 - Internal Server Error).
+         */
+        this.statusCode = enums_1.StatusCodes.INTERNAL_SERVER_ERROR;
+        /**
+         * Method to serialize the database-related error details into an array of error objects.
+         *
+         * This method returns an array containing a single error object with the error message provided during construction.
+         * The array format is consistent with the `CustomError` class's expectation for error serialization.
+         *
+         * @returns {Array<{ message: string }>} - An array containing a single error object with the error message.
+         */
         this.serializeErrors = () => [{ message: this.message }];
         Object.setPrototypeOf(this, DatabaseError.prototype);
     }

package/build/errors/index.d.ts

@@ -1,5 +1,30 @@
+/**
+ * Re-exports the "BadRequestError" class from the "bad-request-error" file.
+ *
+ * The "BadRequestError" class represents a specific "Bad Request" error and is used to handle client requests with invalid or malformed data.
+ */
 export * from "./bad-request-error";
+/**
+ * Re-exports the "CustomError" abstract class from the "custom-error" file.
+ *
+ * The "CustomError" abstract class serves as the foundation for creating specific error classes for different types of errors.
+ */
 export * from "./custom-error";
+/**
+ * Re-exports the "DatabaseError" class from the "database-error" file.
+ *
+ * The "DatabaseError" class represents a specific error related to database operations or connectivity issues.
+ */
 export * from "./database-error";
+/**
+ * Re-exports the "NotFoundError" class from the "not-found-error" file.
+ *
+ * The "NotFoundError" class represents a specific "Not Found" error and is used when a requested resource is not found.
+ */
 export * from "./not-found-error";
+/**
+ * Re-exports the "SystemError" class from the "system-error" file.
+ *
+ * The "SystemError" class represents a specific "System Error" that can occur due to unexpected issues in the system.
+ */
 export * from "./system-error";

package/build/errors/index.js

@@ -1,4 +1,5 @@
 "use strict";
+// Import and re-export custom error classes for easier access.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -14,8 +15,33 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Re-exports the "BadRequestError" class from the "bad-request-error" file.
+ *
+ * The "BadRequestError" class represents a specific "Bad Request" error and is used to handle client requests with invalid or malformed data.
+ */
 __exportStar(require("./bad-request-error"), exports);
+/**
+ * Re-exports the "CustomError" abstract class from the "custom-error" file.
+ *
+ * The "CustomError" abstract class serves as the foundation for creating specific error classes for different types of errors.
+ */
 __exportStar(require("./custom-error"), exports);
+/**
+ * Re-exports the "DatabaseError" class from the "database-error" file.
+ *
+ * The "DatabaseError" class represents a specific error related to database operations or connectivity issues.
+ */
 __exportStar(require("./database-error"), exports);
+/**
+ * Re-exports the "NotFoundError" class from the "not-found-error" file.
+ *
+ * The "NotFoundError" class represents a specific "Not Found" error and is used when a requested resource is not found.
+ */
 __exportStar(require("./not-found-error"), exports);
+/**
+ * Re-exports the "SystemError" class from the "system-error" file.
+ *
+ * The "SystemError" class represents a specific "System Error" that can occur due to unexpected issues in the system.
+ */
 __exportStar(require("./system-error"), exports);

package/build/errors/not-found-error.d.ts

@@ -1,9 +1,31 @@
 import { StatusCodes } from "../utils/enums";
 import { CustomError } from "./custom-error";
+/**
+ * Class representing a "Not Found" error.
+ *
+ * This error class extends the `CustomError` abstract class and provides specific error details for a "Not Found" scenario.
+ * Instances of this class are thrown when a requested resource is not found.
+ */
 export declare class NotFoundError extends CustomError {
+    /**
+     * The HTTP status code associated with the "Not Found" error (404).
+     */
     statusCode: StatusCodes;
+    /**
+     * Constructs a new instance of the "Not Found" error.
+     *
+     * @param {string} message - The error message providing details about the "Not Found" error.
+     */
     constructor(message: string);
-    serializeErrors: () => {
+    /**
+     * Method to serialize the "Not Found" error details into an array of error objects.
+     *
+     * This method returns an array containing a single error object with the error message provided during construction.
+     * The array format is consistent with the `CustomError` class's expectation for error serialization.
+     *
+     * @returns {Array<{ message: string }>} - An array containing a single error object with the error message.
+     */
+    serializeErrors: () => Array<{
         message: string;
-    }[];
+    }>;
 }

package/build/errors/not-found-error.js

@@ -3,10 +3,32 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotFoundError = void 0;
 const enums_1 = require("../utils/enums");
 const custom_error_1 = require("./custom-error");
+/**
+ * Class representing a "Not Found" error.
+ *
+ * This error class extends the `CustomError` abstract class and provides specific error details for a "Not Found" scenario.
+ * Instances of this class are thrown when a requested resource is not found.
+ */
 class NotFoundError extends custom_error_1.CustomError {
+    /**
+     * Constructs a new instance of the "Not Found" error.
+     *
+     * @param {string} message - The error message providing details about the "Not Found" error.
+     */
     constructor(message) {
         super(message);
+        /**
+         * The HTTP status code associated with the "Not Found" error (404).
+         */
         this.statusCode = enums_1.StatusCodes.NOT_FOUND;
+        /**
+         * Method to serialize the "Not Found" error details into an array of error objects.
+         *
+         * This method returns an array containing a single error object with the error message provided during construction.
+         * The array format is consistent with the `CustomError` class's expectation for error serialization.
+         *
+         * @returns {Array<{ message: string }>} - An array containing a single error object with the error message.
+         */
         this.serializeErrors = () => [{ message: this.message }];
         Object.setPrototypeOf(this, NotFoundError.prototype);
     }

package/build/errors/system-error.d.ts

@@ -1,9 +1,32 @@
 import { StatusCodes } from "../utils/enums";
 import { CustomError } from "./custom-error";
+/**
+ * Class representing a "System Error".
+ *
+ * This error class extends the `CustomError` abstract class and provides specific error details for a "System Error".
+ * Instances of this class are thrown when there are unexpected issues in the system.
+ */
 export declare class SystemError extends CustomError {
+    /**
+     * The HTTP status code associated with the "System Error" (500 - Internal Server Error).
+     */
     statusCode: StatusCodes;
+    /**
+     * Constructs a new instance of the "System Error".
+     *
+     * @param {string} message - The error message providing details about the "System Error".
+     *                           If no message is provided, the default message "Something went wrong" is used.
+     */
     constructor(message?: string);
-    serializeErrors: () => {
+    /**
+     * Method to serialize the "System Error" details into an array of error objects.
+     *
+     * This method returns an array containing a single error object with the error message provided during construction.
+     * The array format is consistent with the `CustomError` class's expectation for error serialization.
+     *
+     * @returns {Array<{ message: string }>} - An array containing a single error object with the error message.
+     */
+    serializeErrors: () => Array<{
         message: string;
-    }[];
+    }>;
 }

package/build/errors/system-error.js

@@ -3,10 +3,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SystemError = void 0;
 const enums_1 = require("../utils/enums");
 const custom_error_1 = require("./custom-error");
+/**
+ * Class representing a "System Error".
+ *
+ * This error class extends the `CustomError` abstract class and provides specific error details for a "System Error".
+ * Instances of this class are thrown when there are unexpected issues in the system.
+ */
 class SystemError extends custom_error_1.CustomError {
+    /**
+     * Constructs a new instance of the "System Error".
+     *
+     * @param {string} message - The error message providing details about the "System Error".
+     *                           If no message is provided, the default message "Something went wrong" is used.
+     */
     constructor(message = "Something went wrong") {
         super(message);
-        this.statusCode = enums_1.StatusCodes.INTERNALE_SERVER_ERROR;
+        /**
+         * The HTTP status code associated with the "System Error" (500 - Internal Server Error).
+         */
+        this.statusCode = enums_1.StatusCodes.INTERNAL_SERVER_ERROR;
+        /**
+         * Method to serialize the "System Error" details into an array of error objects.
+         *
+         * This method returns an array containing a single error object with the error message provided during construction.
+         * The array format is consistent with the `CustomError` class's expectation for error serialization.
+         *
+         * @returns {Array<{ message: string }>} - An array containing a single error object with the error message.
+         */
         this.serializeErrors = () => [{ message: this.message }];
         Object.setPrototypeOf(this, SystemError.prototype);
     }

package/build/events/base/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Re-exports the "BaseConsumer" class from the "base-consumer" file.
+ *
+ * The "BaseConsumer" class serves as a base class for implementing event consumers.
+ * It provides common functionality and methods that can be extended by specific consumer implementations.
+ */
+export * from "./base-consumer";
+/**
+ * Re-exports the "BasePublisher" class from the "base-publisher" file.
+ *
+ * The "BasePublisher" class serves as a base class for implementing event publishers.
+ * It provides common functionality and methods that can be extended by specific publisher implementations.
+ */
+export * from "./base-publisher";
+/**
+ * Re-exports the "BaseStream" class from the "base-stream" file.
+ *
+ * The "BaseStream" class serves as a base class for implementing event streams.
+ * It provides common functionality and methods that can be extended by specific stream implementations.
+ */
+export * from "./base-stream";

package/build/events/base/index.js

@@ -0,0 +1,38 @@
+"use strict";
+// Import and re-export base classes for consumers, publishers, and streams.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Re-exports the "BaseConsumer" class from the "base-consumer" file.
+ *
+ * The "BaseConsumer" class serves as a base class for implementing event consumers.
+ * It provides common functionality and methods that can be extended by specific consumer implementations.
+ */
+__exportStar(require("./base-consumer"), exports);
+/**
+ * Re-exports the "BasePublisher" class from the "base-publisher" file.
+ *
+ * The "BasePublisher" class serves as a base class for implementing event publishers.
+ * It provides common functionality and methods that can be extended by specific publisher implementations.
+ */
+__exportStar(require("./base-publisher"), exports);
+/**
+ * Re-exports the "BaseStream" class from the "base-stream" file.
+ *
+ * The "BaseStream" class serves as a base class for implementing event streams.
+ * It provides common functionality and methods that can be extended by specific stream implementations.
+ */
+__exportStar(require("./base-stream"), exports);

package/build/events/common/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Re-exports all the enums from the "enums" module.
+ *
+ * The "enums" module contains various enumerations used in the application.
+ * Enumerations are used to define named constant values, such as status codes, subject names, or stream names.
+ */
+export * from "./enums";
+/**
+ * Re-exports all the interfaces from the "interfaces" module.
+ *
+ * The "interfaces" module contains various interfaces used in the application to define data structures and contracts.
+ * Interfaces are used to describe the shape of objects and provide a common structure for communication between different parts of the application.
+ */
+export * from "./interfaces";

package/build/events/common/index.js

@@ -0,0 +1,31 @@
+"use strict";
+// Import and re-export multiple modules related to enums and interfaces.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Re-exports all the enums from the "enums" module.
+ *
+ * The "enums" module contains various enumerations used in the application.
+ * Enumerations are used to define named constant values, such as status codes, subject names, or stream names.
+ */
+__exportStar(require("./enums"), exports);
+/**
+ * Re-exports all the interfaces from the "interfaces" module.
+ *
+ * The "interfaces" module contains various interfaces used in the application to define data structures and contracts.
+ * Interfaces are used to describe the shape of objects and provide a common structure for communication between different parts of the application.
+ */
+__exportStar(require("./interfaces"), exports);

package/build/events/common/interfaces/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Re-exports all the interfaces related to order events from the "order-events-interfaces" file.
+ *
+ * The "order-events-interfaces" file contains interfaces for various order-related events such as order requested, order cancelled, and order completed.
+ */
+export * from "./order-events-interfaces";
+/**
+ * Re-exports all the interfaces related to streams from the "stream-interfaces" file.
+ *
+ * The "stream-interfaces" file contains interfaces for various streams used in the application.
+ * For example, "OrderStreamEvent" represents an event associated with the "Order" stream.
+ */
+export * from "./stream-interfaces";

package/build/events/common/interfaces/index.js

@@ -0,0 +1,33 @@
+"use strict";
+// Import and re-export multiple interfaces related to different events and streams.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Re-exports all the interfaces related to order events from the "order-events-interfaces" file.
+ *
+ * The "order-events-interfaces" file contains interfaces for various order-related events such as order requested, order cancelled, and order completed.
+ */
+__exportStar(require("./order-events-interfaces"), exports);
+// Interfaces related to payment events are currently commented out using '//'.
+// If needed, uncomment the following line to re-export the payment event interfaces.
+// export * from "./payment-event-interfaces";
+/**
+ * Re-exports all the interfaces related to streams from the "stream-interfaces" file.
+ *
+ * The "stream-interfaces" file contains interfaces for various streams used in the application.
+ * For example, "OrderStreamEvent" represents an event associated with the "Order" stream.
+ */
+__exportStar(require("./stream-interfaces"), exports);

package/build/events/common/interfaces/order-events-interfaces/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Re-exports the "OrderCancelledEvent" class from the "order-cancelled-event" file.
+ *
+ * The "OrderCancelledEvent" class represents an event related to the cancellation of an order.
+ */
+export * from "./order-cancelled-event";
+/**
+ * Re-exports the "OrderCompletedEvent" class from the "order-completed-event" file.
+ *
+ * The "OrderCompletedEvent" class represents an event related to the completion of an order.
+ */
+export * from "./order-completed-event";
+/**
+ * Re-exports the "OrderRequestedEvent" class from the "order-requested-event" file.
+ *
+ * The "OrderRequestedEvent" class represents an event related to a request for an order.
+ */
+export * from "./order-requested-event";

package/build/events/common/interfaces/order-events-interfaces/index.js

@@ -0,0 +1,35 @@
+"use strict";
+// Import and re-export event classes for easier access.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Re-exports the "OrderCancelledEvent" class from the "order-cancelled-event" file.
+ *
+ * The "OrderCancelledEvent" class represents an event related to the cancellation of an order.
+ */
+__exportStar(require("./order-cancelled-event"), exports);
+/**
+ * Re-exports the "OrderCompletedEvent" class from the "order-completed-event" file.
+ *
+ * The "OrderCompletedEvent" class represents an event related to the completion of an order.
+ */
+__exportStar(require("./order-completed-event"), exports);
+/**
+ * Re-exports the "OrderRequestedEvent" class from the "order-requested-event" file.
+ *
+ * The "OrderRequestedEvent" class represents an event related to a request for an order.
+ */
+__exportStar(require("./order-requested-event"), exports);

package/build/events/common/interfaces/order-events-interfaces/order-cancelled-event.d.ts

@@ -1,15 +1,51 @@
 import { OrderDurableName } from '../../enums/durable-names/order-dname';
 import { OrderStream } from '../../enums/streams/order-stream';
 import { OrderSubjects } from '../../enums/subjects/order-subjects';
+/**
+ * Interface representing the "Order Cancelled" event.
+ *
+ * The "OrderCancelledEvent" interface defines the structure of an event related to the cancellation of an order.
+ * Events of this type are used to communicate order cancellation details across the application.
+ */
 export interface OrderCancelledEvent {
+    /**
+     * The subject of the event, specifying that it represents an "Order Cancelled" event.
+     */
     subject: OrderSubjects.OrderCancelled;
+    /**
+     * The durable name associated with the consumer handling the "Order Cancelled" event.
+     * This property is optional and may be used to identify the consumer processing the event in a durable manner.
+     */
     durableName?: OrderDurableName.OrderCancelledDurablename;
+    /**
+     * The stream to which the event belongs, specifying that it is an "Order" stream.
+     * Events of different types may be grouped into different streams based on their common characteristics.
+     */
     stream: OrderStream.Order;
+    /**
+     * The data payload of the "Order Cancelled" event.
+     * The data payload contains specific details related to the order cancellation, such as order ID, version, status, user ID, and trip ID.
+     */
     data: {
+        /**
+         * The unique identifier of the order associated with the cancellation event.
+         */
         id: string;
+        /**
+         * The version number of the order at the time of the cancellation event.
+         */
         version: number;
+        /**
+         * The status of the order after the cancellation event (e.g., "cancelled").
+         */
         status: string;
+        /**
+         * The unique identifier of the user who initiated the order cancellation.
+         */
         userid: string;
+        /**
+         * The unique identifier of the trip associated with the cancelled order.
+         */
         tripid: string;
     };
 }

package/build/events/common/interfaces/order-events-interfaces/order-completed-event.d.ts

@@ -1,15 +1,51 @@
 import { OrderDurableName } from '../../enums/durable-names/order-dname';
 import { OrderStream } from '../../enums/streams/order-stream';
 import { OrderSubjects } from '../../enums/subjects/order-subjects';
+/**
+ * Interface representing the "Order Completed" event.
+ *
+ * The "OrderCompletedEvent" interface defines the structure of an event related to the completion of an order.
+ * Events of this type are used to communicate order completion details across the application.
+ */
 export interface OrderCompletedEvent {
+    /**
+     * The subject of the event, specifying that it represents an "Order Completed" event.
+     */
     subject: OrderSubjects.OrderCompleted;
+    /**
+     * The durable name associated with the consumer handling the "Order Completed" event.
+     * This property is optional and may be used to identify the consumer processing the event in a durable manner.
+     */
     durableName?: OrderDurableName.OrderCompletedDurablename;
+    /**
+     * The stream to which the event belongs, specifying that it is an "Order" stream.
+     * Events of different types may be grouped into different streams based on their common characteristics.
+     */
     stream: OrderStream.Order;
+    /**
+     * The data payload of the "Order Completed" event.
+     * The data payload contains specific details related to the order completion, such as order ID, version, status, user ID, and trip ID.
+     */
     data: {
+        /**
+         * The unique identifier of the order associated with the completion event.
+         */
         id: string;
+        /**
+         * The version number of the order at the time of the completion event.
+         */
         version: number;
+        /**
+         * The status of the order after the completion event (e.g., "completed").
+         */
         status: string;
+        /**
+         * The unique identifier of the user who initiated the order completion.
+         */
         userid: string;
+        /**
+         * The unique identifier of the trip associated with the completed order.
+         */
         tripid: string;
     };
 }

package/build/events/common/interfaces/order-events-interfaces/order-requested-event.d.ts

@@ -1,15 +1,51 @@
 import { OrderDurableName } from '../../enums/durable-names/order-dname';
 import { OrderStream } from '../../enums/streams/order-stream';
 import { OrderSubjects } from '../../enums/subjects/order-subjects';
+/**
+ * Interface representing the "Order Requested" event.
+ *
+ * The "OrderRequestedEvent" interface defines the structure of an event related to the request for an order.
+ * Events of this type are used to communicate order request details across the application.
+ */
 export interface OrderRequestedEvent {
+    /**
+     * The subject of the event, specifying that it represents an "Order Requested" event.
+     */
     subject: OrderSubjects.OrderRequested;
+    /**
+     * The durable name associated with the consumer handling the "Order Requested" event.
+     * This property is optional and may be used to identify the consumer processing the event in a durable manner.
+     */
     durableName?: OrderDurableName.OrderRequestDurablename;
+    /**
+     * The stream to which the event belongs, specifying that it is an "Order" stream.
+     * Events of different types may be grouped into different streams based on their common characteristics.
+     */
     stream: OrderStream.Order;
+    /**
+     * The data payload of the "Order Requested" event.
+     * The data payload contains specific details related to the order request, such as order ID, version, status, user ID, and trip ID.
+     */
     data: {
+        /**
+         * The unique identifier of the order associated with the request event.
+         */
         id: string;
+        /**
+         * The version number of the order at the time of the request event.
+         */
         version: number;
+        /**
+         * The status of the order after the request event (e.g., "requested").
+         */
         status: string;
+        /**
+         * The unique identifier of the user who initiated the order request.
+         */
         userid: string;
+        /**
+         * The unique identifier of the trip associated with the requested order.
+         */
         tripid: string;
     };
 }

package/build/events/common/interfaces/payment-event-interfaces/index.js

@@ -0,0 +1,3 @@
+"use strict";
+// export * from "./payment-created-event"
+// export * from "./payment-failed-event"

package/build/events/common/interfaces/stream-interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from "./order-stream-interface";

package/build/events/common/interfaces/stream-interfaces/index.js

@@ -0,0 +1,18 @@
+"use strict";
+// Import and re-export the contents of the "order-stream-interface.ts" file.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./order-stream-interface"), exports);

package/build/events/common/interfaces/stream-interfaces/order-stream-interface.d.ts

@@ -1,6 +1,23 @@
 import { OrderStream } from '../../enums/streams/order-stream';
 import { MainSubjects } from '../../enums/subjects/main-subjects';
+/**
+ * Interface representing an event associated with the "Order" stream.
+ *
+ * The "OrderStreamEvent" interface defines the structure of an event related to the "Order" stream.
+ * Events of this type are used to communicate specific details related to the "Order" stream.
+ */
 export interface OrderStreamEvent {
+    /**
+     * The subject of the event, specifying that it is associated with the "Order" stream.
+     *
+     * In this case, the subject is derived from the "MainSubjects.ORDER" enum value, indicating that this event is related to orders.
+     */
     subject: MainSubjects.ORDER;
+    /**
+     * The stream to which the event belongs, specifying that it is an "Order" stream.
+     *
+     * Events of different types may be grouped into different streams based on their common characteristics.
+     * In this case, the stream is of type "OrderStream.Order", indicating that it is an event related to the "Order" stream.
+     */
     stream: OrderStream.Order;
 }

package/build/events/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Re-exports all the contents from the "base" module.
+ *
+ * The "base" module contains base classes and utilities that provide foundational functionality for various parts of the application.
+ * This includes base classes for consumers, publishers, streams, etc., that can be extended to implement specific functionality.
+ */
+export * from "./base";
+/**
+ * Re-exports all the contents from the "common" module.
+ *
+ * The "common" module contains shared utilities, helper functions, enums, and interfaces that are commonly used across the application.
+ * These shared resources provide a common set of functionalities to be used by different components or modules within the application.
+ */
+export * from "./common";

package/build/events/index.js

@@ -0,0 +1,31 @@
+"use strict";
+// Import and re-export multiple modules related to "base" and "common" functionalities.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Re-exports all the contents from the "base" module.
+ *
+ * The "base" module contains base classes and utilities that provide foundational functionality for various parts of the application.
+ * This includes base classes for consumers, publishers, streams, etc., that can be extended to implement specific functionality.
+ */
+__exportStar(require("./base"), exports);
+/**
+ * Re-exports all the contents from the "common" module.
+ *
+ * The "common" module contains shared utilities, helper functions, enums, and interfaces that are commonly used across the application.
+ * These shared resources provide a common set of functionalities to be used by different components or modules within the application.
+ */
+__exportStar(require("./common"), exports);

package/build/index.d.ts

@@ -2,3 +2,4 @@ export * from "./connections-wrappers";
 export * from "./errors";
 export * from "./middlewares";
 export * from "./utils";
+export * from "./events";

package/build/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./connections-wrappers"), exports);
 __exportStar(require("./errors"), exports);
 __exportStar(require("./middlewares"), exports);
 __exportStar(require("./utils"), exports);
+__exportStar(require("./events"), exports);

package/build/utils/base_classes/index.d.ts

@@ -1,3 +1,21 @@
+/**
+ * Re-exports all the contents from the "base-producers" module.
+ *
+ * The "base-producers" module contains base classes and utilities for implementing job producers in the application.
+ * Job producers are responsible for generating and queuing jobs to be processed by job workers.
+ */
 export * from "./jobs/base-producers";
+/**
+ * Re-exports all the contents from the "base-worker" module.
+ *
+ * The "base-worker" module contains base classes and utilities for implementing job workers in the application.
+ * Job workers are responsible for processing jobs generated by job producers and executing the required tasks.
+ */
 export * from "./jobs/base-worker";
+/**
+ * Re-exports all the contents from the "base-namespace" module.
+ *
+ * The "base-namespace" module contains base classes and utilities for implementing custom namespaces in the application.
+ * Custom namespaces provide separate channels for communication between connected clients and the server, allowing for organized event handling within separate contexts.
+ */
 export * from "./listeners/base-namespace";

package/build/utils/base_classes/index.js

@@ -1,4 +1,5 @@
 "use strict";
+// Import and re-export multiple modules related to jobs and listeners.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -14,6 +15,24 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Re-exports all the contents from the "base-producers" module.
+ *
+ * The "base-producers" module contains base classes and utilities for implementing job producers in the application.
+ * Job producers are responsible for generating and queuing jobs to be processed by job workers.
+ */
 __exportStar(require("./jobs/base-producers"), exports);
+/**
+ * Re-exports all the contents from the "base-worker" module.
+ *
+ * The "base-worker" module contains base classes and utilities for implementing job workers in the application.
+ * Job workers are responsible for processing jobs generated by job producers and executing the required tasks.
+ */
 __exportStar(require("./jobs/base-worker"), exports);
+/**
+ * Re-exports all the contents from the "base-namespace" module.
+ *
+ * The "base-namespace" module contains base classes and utilities for implementing custom namespaces in the application.
+ * Custom namespaces provide separate channels for communication between connected clients and the server, allowing for organized event handling within separate contexts.
+ */
 __exportStar(require("./listeners/base-namespace"), exports);

package/build/utils/base_classes/listeners/base-namespace.d.ts

@@ -1,4 +1,19 @@
 import { Server } from 'socket.io';
+/**
+ * Abstract class representing a Socket.IO namespace.
+ *
+ * The "IoNamespace" class serves as a base class for implementing custom Socket.IO namespaces in the application.
+ * A Socket.IO namespace provides a separate channel for communication between connected clients and the server.
+ * Custom namespaces allow developers to organize events and logic within separate contexts.
+ */
 export declare abstract class IoNamespace {
+    /**
+     * Abstract method to be implemented by subclasses.
+     *
+     * The "connect" method is used to establish a connection between the Socket.IO namespace and the server.
+     * Subclasses should override this method to define the specific logic and event handling for the namespace.
+     *
+     * @param io The Socket.IO server instance to which the namespace is connected.
+     */
     abstract connect(io: Server): void;
 }

package/build/utils/base_classes/listeners/base-namespace.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IoNamespace = void 0;
+/**
+ * Abstract class representing a Socket.IO namespace.
+ *
+ * The "IoNamespace" class serves as a base class for implementing custom Socket.IO namespaces in the application.
+ * A Socket.IO namespace provides a separate channel for communication between connected clients and the server.
+ * Custom namespaces allow developers to organize events and logic within separate contexts.
+ */
 class IoNamespace {
 }
 exports.IoNamespace = IoNamespace;

package/build/utils/enums.d.ts

@@ -61,7 +61,7 @@ export declare enum StatusCodes {
     TOO_MANY_REQUEST = 429,
     REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
     UNAVAILABLE_FOR_LEGAL_REASONS = 451,
-    INTERNALE_SERVER_ERROR = 500,
+    INTERNAL_SERVER_ERROR = 500,
     NOT_IMPLEMENTED = 501,
     BAD_GATEWAY = 502,
     SERVICE_UNAVAILABLE = 503,

package/build/utils/enums.js

@@ -67,7 +67,7 @@ var StatusCodes;
     StatusCodes[StatusCodes["TOO_MANY_REQUEST"] = 429] = "TOO_MANY_REQUEST";
     StatusCodes[StatusCodes["REQUEST_HEADER_FIELDS_TOO_LARGE"] = 431] = "REQUEST_HEADER_FIELDS_TOO_LARGE";
     StatusCodes[StatusCodes["UNAVAILABLE_FOR_LEGAL_REASONS"] = 451] = "UNAVAILABLE_FOR_LEGAL_REASONS";
-    StatusCodes[StatusCodes["INTERNALE_SERVER_ERROR"] = 500] = "INTERNALE_SERVER_ERROR";
+    StatusCodes[StatusCodes["INTERNAL_SERVER_ERROR"] = 500] = "INTERNAL_SERVER_ERROR";
     StatusCodes[StatusCodes["NOT_IMPLEMENTED"] = 501] = "NOT_IMPLEMENTED";
     StatusCodes[StatusCodes["BAD_GATEWAY"] = 502] = "BAD_GATEWAY";
     StatusCodes[StatusCodes["SERVICE_UNAVAILABLE"] = 503] = "SERVICE_UNAVAILABLE";

package/build/utils/index.d.ts

@@ -1,3 +1,21 @@
+/**
+ * Re-exports all the enums from the "enums" module.
+ *
+ * The "enums" module contains various enumerations used in the application.
+ * Enumerations are used to define named constant values, such as status codes, subject names, or stream names.
+ */
 export * from "./enums";
+/**
+ * Re-exports all the base classes from the "base_classes" module.
+ *
+ * The "base_classes" module contains base classes and utilities that provide foundational functionality for different parts of the application.
+ * This includes base classes for consumers, publishers, streams, etc., which can be extended to implement specific functionality.
+ */
 export * from "./base_classes";
+/**
+ * Re-exports all the functions related to reading directories from the "read-dir" module.
+ *
+ * The "read-dir" module contains utility functions to read and access files and directories in the application.
+ * These functions are used for dynamic loading, configuration, and other file-related operations.
+ */
 export * from "./read-dir";

package/build/utils/index.js

@@ -1,4 +1,5 @@
 "use strict";
+// Import and re-export multiple modules for enums, base classes, and read-dir functionality.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -14,6 +15,24 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Re-exports all the enums from the "enums" module.
+ *
+ * The "enums" module contains various enumerations used in the application.
+ * Enumerations are used to define named constant values, such as status codes, subject names, or stream names.
+ */
 __exportStar(require("./enums"), exports);
+/**
+ * Re-exports all the base classes from the "base_classes" module.
+ *
+ * The "base_classes" module contains base classes and utilities that provide foundational functionality for different parts of the application.
+ * This includes base classes for consumers, publishers, streams, etc., which can be extended to implement specific functionality.
+ */
 __exportStar(require("./base_classes"), exports);
+/**
+ * Re-exports all the functions related to reading directories from the "read-dir" module.
+ *
+ * The "read-dir" module contains utility functions to read and access files and directories in the application.
+ * These functions are used for dynamic loading, configuration, and other file-related operations.
+ */
 __exportStar(require("./read-dir"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hastehaul/common",
-  "version": "1.0.14",
+  "version": "1.0.15",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",