@hastehaul/common 1.0.13 → 1.0.15

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