@hastehaul/common 1.0.14 → 1.0.17

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/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/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.17",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",