@hastehaul/common 1.0.15 → 1.0.17

package/build/events/base/base-consumer.d.ts

@@ -1,6 +1,8 @@
 import { NatsConnection, ConsumerConfig, JsMsg } from "nats";
-import { DurableName, Subjects, Streams } from "../common/enums";
 import { MainSubjects, ValidateSubjectFormat } from "../common/enums/subjects/main-subjects";
+import { Subjects } from '../common/enums/subjects';
+import { DurableName } from '../common/enums/durable-names';
+import { Streams } from '../common/enums/streams';
 /**
  * Interface representing an event published to NATS.
  */

package/build/events/base/base-publisher.d.ts

@@ -1,6 +1,6 @@
 import { PubAck, NatsConnection } from "nats";
-import { Subjects } from "../common/enums";
 import { MainSubjects, ValidateSubjectFormat } from "../common/enums/subjects/main-subjects";
+import { Subjects } from '../common/enums/subjects';
 /**
  * Interface representing an event to be published to NATS.
  */

package/build/events/base/base-stream.d.ts

@@ -1,6 +1,6 @@
 import { NatsConnection } from "nats";
-import { Streams } from "../common/enums";
 import { MainSubjects } from "../common/enums/subjects/main-subjects";
+import { Streams } from '../common/enums/streams';
 /**
  * Interface representing an event to be used with NATS streams.
  */

package/build/index.d.ts

@@ -1,5 +1,166 @@
-export * from "./connections-wrappers";
-export * from "./errors";
-export * from "./middlewares";
-export * from "./utils";
-export * from "./events";
+/**
+ * Re-exports all the contents from the "redis-connection-wrapper" module.
+ *
+ * The "redis-connection-wrapper" module contains a class that wraps the Redis client connection and provides easy access to the Redis client instance.
+ * It also includes error handling and connection management features.
+ */
+export * from "./connections-wrappers/redis-connection-wrapper";
+/**
+ * Re-exports all the contents from the "socket-connection-wrapper" module.
+ *
+ * The "socket-connection-wrapper" module contains a class that wraps the Socket.IO server connection and provides easy access to the Socket.IO server instance.
+ * It includes error handling and connection management features for Socket.IO server connections.
+ */
+export * from "./connections-wrappers/socket-connection-wrapper";
+/**
+ * Re-exports all the contents from the "nats-wrapper" module.
+ *
+ * The "nats-wrapper" module contains a class that wraps the NATS (NATS Streaming Server) client connection and provides easy access to the NATS client instance.
+ * It includes error handling and connection management features for NATS client connections.
+ */
+export * from "./connections-wrappers/nats-wrapper";
+/**
+ * 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 "./errors/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 "./errors/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 "./errors/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 "./errors/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 "./errors/system-error";
+/**
+ * Re-exports the "currentUser" middleware from the "current-user" module.
+ *
+ * The "currentUser" middleware is used to extract and verify the current user's information from the request headers.
+ * It checks for a valid bearer token in the "Authorization" header, verifies the JWT token, and attaches the user payload to the request object for further processing in subsequent middleware or route handlers.
+ */
+export * from "./middlewares/current-user";
+/**
+ * Re-exports the "errorHandler" middleware from the "error-handler" module.
+ *
+ * The "errorHandler" middleware is a custom error-handling middleware used to handle and respond to errors that occur during request processing.
+ * It intercepts any uncaught errors in the application, such as custom errors or other exceptions, and sends appropriate error responses to the client.
+ * If the error is a custom error (e.g., BadRequestError, NotFoundError, DatabaseError, etc.), the middleware serializes the error and sends it with the corresponding status code and error messages.
+ * If the error is not a custom error, a generic error response is sent with a 500 status code and a default error message.
+ */
+export * from "./middlewares/error-handler";
+/**
+ *? 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 "./utils/enums";
+/**
+ *? 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 "./utils/read-dir";
+/**
+ *? 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 "./utils/base_classes/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 "./utils/base_classes/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 "./utils/base_classes/listeners/base-namespace";
+/**
+ *? 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 "./events/base/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 "./events/base/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 "./events/base/base-stream";
+/**
+ * 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 "./events/common/interfaces/order-events-interfaces/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 "./events/common/interfaces/order-events-interfaces/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 "./events/common/interfaces/order-events-interfaces/order-requested-event";
+/**
+ * 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 "./events/common/interfaces/stream-interfaces/order-stream-interface";
+/**
+ * Re-exports all the types related to durable names from the "durable-names" file.
+ *
+ * The types include enums and utility types used to define durable names for consumers of different event types.
+ */
+export * from "./events/common/enums/durable-names";
+/**
+ * Re-exports the type related to streams from the "streams" file.
+ *
+ * The "Streams" type alias represents a JetStream stream that can handle different event types.
+ */
+export * from "./events/common/enums/streams";
+/**
+ * Re-exports the type related to subjects from the "subjects" file.
+ *
+ * The "Subjects" type alias represents the subjects for different event types.
+ */
+export * from "./events/common/enums/subjects";

package/build/index.js

@@ -1,4 +1,5 @@
 "use strict";
+//* Import and re-export multiple modules related to connection wrappers.
 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,177 @@ 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("./connections-wrappers"), exports);
-__exportStar(require("./errors"), exports);
-__exportStar(require("./middlewares"), exports);
-__exportStar(require("./utils"), exports);
-__exportStar(require("./events"), exports);
+/**
+ * Re-exports all the contents from the "redis-connection-wrapper" module.
+ *
+ * The "redis-connection-wrapper" module contains a class that wraps the Redis client connection and provides easy access to the Redis client instance.
+ * It also includes error handling and connection management features.
+ */
+__exportStar(require("./connections-wrappers/redis-connection-wrapper"), exports);
+/**
+ * Re-exports all the contents from the "socket-connection-wrapper" module.
+ *
+ * The "socket-connection-wrapper" module contains a class that wraps the Socket.IO server connection and provides easy access to the Socket.IO server instance.
+ * It includes error handling and connection management features for Socket.IO server connections.
+ */
+__exportStar(require("./connections-wrappers/socket-connection-wrapper"), exports);
+/**
+ * Re-exports all the contents from the "nats-wrapper" module.
+ *
+ * The "nats-wrapper" module contains a class that wraps the NATS (NATS Streaming Server) client connection and provides easy access to the NATS client instance.
+ * It includes error handling and connection management features for NATS client connections.
+ */
+__exportStar(require("./connections-wrappers/nats-wrapper"), exports);
+//* Import and re-export custom error classes for easier access.
+/**
+ * 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("./errors/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("./errors/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("./errors/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("./errors/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("./errors/system-error"), exports);
+//* Import and re-export multiple middleware modules.
+/**
+ * Re-exports the "currentUser" middleware from the "current-user" module.
+ *
+ * The "currentUser" middleware is used to extract and verify the current user's information from the request headers.
+ * It checks for a valid bearer token in the "Authorization" header, verifies the JWT token, and attaches the user payload to the request object for further processing in subsequent middleware or route handlers.
+ */
+__exportStar(require("./middlewares/current-user"), exports);
+/**
+ * Re-exports the "errorHandler" middleware from the "error-handler" module.
+ *
+ * The "errorHandler" middleware is a custom error-handling middleware used to handle and respond to errors that occur during request processing.
+ * It intercepts any uncaught errors in the application, such as custom errors or other exceptions, and sends appropriate error responses to the client.
+ * If the error is a custom error (e.g., BadRequestError, NotFoundError, DatabaseError, etc.), the middleware serializes the error and sends it with the corresponding status code and error messages.
+ * If the error is not a custom error, a generic error response is sent with a 500 status code and a default error message.
+ */
+__exportStar(require("./middlewares/error-handler"), exports);
+//* Import and re-export multiple modules for enums, base classes, and read-dir functionality.
+/**
+ *? 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("./utils/enums"), 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("./utils/read-dir"), exports);
+/**
+ *? 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("./utils/base_classes/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("./utils/base_classes/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("./utils/base_classes/listeners/base-namespace"), exports);
+//* Import and re-export base classes for consumers, publishers, and streams.
+/**
+ *? 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("./events/base/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("./events/base/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("./events/base/base-stream"), exports);
+//* Import and re-export multiple interfaces related to different events and streams.
+/**
+ * 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("./events/common/interfaces/order-events-interfaces/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("./events/common/interfaces/order-events-interfaces/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("./events/common/interfaces/order-events-interfaces/order-requested-event"), exports);
+//! Interfaces related to payment events are currently commented out using '//'.
+// 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("./events/common/interfaces/stream-interfaces/order-stream-interface"), exports);
+//* Import and re-export types from other files in events enums for easier access.
+/**
+ * Re-exports all the types related to durable names from the "durable-names" file.
+ *
+ * The types include enums and utility types used to define durable names for consumers of different event types.
+ */
+__exportStar(require("./events/common/enums/durable-names"), exports);
+/**
+ * Re-exports the type related to streams from the "streams" file.
+ *
+ * The "Streams" type alias represents a JetStream stream that can handle different event types.
+ */
+__exportStar(require("./events/common/enums/streams"), exports);
+/**
+ * Re-exports the type related to subjects from the "subjects" file.
+ *
+ * The "Subjects" type alias represents the subjects for different event types.
+ */
+__exportStar(require("./events/common/enums/subjects"), exports);

package/build/utils/base_classes/jobs/base-producers.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractJobQueue = void 0;
 const bullmq_1 = require("bullmq");
-const connections_wrappers_1 = require("../../../connections-wrappers");
+const redis_connection_wrapper_1 = require("../../../connections-wrappers/redis-connection-wrapper");
 /**
  * Abstract class representing a Job Queue.
  */
@@ -14,7 +14,7 @@ class AbstractJobQueue {
      */
     constructor(queueName) {
         // Initialize the job queue with the provided name and a Redis connection from the redisWrapper.
-        this.que = new bullmq_1.Queue(queueName, { connection: connections_wrappers_1.redisWrapper.client });
+        this.que = new bullmq_1.Queue(queueName, { connection: redis_connection_wrapper_1.redisWrapper.client });
     }
 }
 exports.AbstractJobQueue = AbstractJobQueue;

package/build/utils/base_classes/jobs/base-worker.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractWorker = void 0;
 const bullmq_1 = require("bullmq");
-const connections_wrappers_1 = require("../../../connections-wrappers");
+const redis_connection_wrapper_1 = require("../../../connections-wrappers/redis-connection-wrapper");
 /**
  * Abstract class representing a worker for processing jobs from a Job Queue.
  */
@@ -15,7 +15,7 @@ class AbstractWorker {
     constructor(queueName) {
         // Create a worker instance with the provided queueName and bind the 'process' method to this worker.
         this.worker = new bullmq_1.Worker(queueName, this.process.bind(this), {
-            connection: connections_wrappers_1.redisWrapper.client,
+            connection: redis_connection_wrapper_1.redisWrapper.client,
             autorun: false,
         });
         // Handle errors that may occur during job processing.

package/package.json

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