@artstesh/postboy 2.1.9 → 3.0.0

package/README.md

@@ -1,81 +1,40 @@
-The `@artstesh/postboy` library is designed to simplify the development of TypeScript applications using an event-driven approach. It provides convenient tools for working with the `rxjs` library, managing events, and handling dependencies, allowing developers to focus on business logic rather than boilerplate.
+# Introduction
 
-## Purpose of the Library
+## 1.1. About the Library
+Modern web development often feels like a survival race: components are scattered across dependency trees, services communicate through layers of abstraction, and events multiply like rabbits in the Australian outback. In this chaos, managing communication isn’t just a task—it’s an art of balancing flexibility and order.
 
-In complex applications a developer always faces with a huge amount of services, subscriptions and, as a result, with a long list of dependencies in components of the system. Some services have to combine their own logic with providing of subscriptions, other exist only to define a list of observations to link components of the system. It is getting harder to support so many dependencies, testing becomes a nightmare add... to say the truth, it looks bad) Plus, it is neccessary to close all the subs properly to avoid memory leaks...
+**Postboy** was born from this chaos. It’s not just another RxJS-based Event Bus—it’s an attempt to bridge the gap between the power of reactive programming and everyday simplicity. Over years of working with Angular, I’ve watched standard event-handling approaches drown in boilerplate code, while complex state managers morphed into impenetrable "black boxes." Postboy is my answer to these challenges.
 
-`@artstesh/postboy` is a tool aimed at reducing this complexity by removing repetitive tasks from development. It focuses on minimizing boilerplate code and eliminating issues such as subscription leaks and improper dependency handling.
+**Key Features:**
+- Lightweight architecture with zero hidden dependencies.
+- Flexible messaging system backed by TypeScript typing.
+- Middleware for intercepting and transforming events (logging, validation, metrics).
+- Async operations and callback management tools.
+- Reactive patterns out of the box: ReplaySubject, BehaviorSubject, and more.
 
-## Key Features
+Postboy doesn’t aim to replace NgRx or Akita—it solves a narrower set of problems but does so with minimal entry barriers.
 
-1. **Event-Driven Architecture**  
-   Enables creating event-based applications with minimal overhead and explicit subscription management. This is especially useful for large-scale applications where data delivery and reaction to events play a critical role.
+---
 
-2. **Integration with `rxjs`**  
-   Reactive programming is supported out of the box. This enables easy use of `rxjs` to process events.
+## 1.2. Core Concepts
+Imagine Postboy as your app’s postal service. Here’s how it works:
 
-3. **Dependency Management**  
-   The library simplifies dependency handling by providing an efficient mechanism for managing them.
+- **Messages (PostboyMessage)**  
+  These are data envelopes. Every message has a unique `ID` and can carry anything: a simple notification, a complex DTO, or even a `UserLoggedInEvent` or `DataFetchRequest`.
 
-4. **Seamless Integration**  
-   `@artstesh/postboy` can be easily integrated into existing TypeScript projects and helps structure applications into independent components with clear responsibilities for events and reactions.
+- **Subscriptions**  
+  Like subscribing to a magazine. Components register interest in specific message types and react when they "arrive in the mailbox."
 
-5. **Modularity and Scalability**  
-   Thanks to its approach, the library is suitable for both small applications and large-scale projects with complex functionality.
+- **Handlers (Executors)**  
+  Special agents that execute synchronous tasks on demand. Need to fetch data from a store or validate permissions? An Executor handles it without event spaghetti.
 
-## Usage Example
+- **Middleware**  
+  Customs officers inspecting every message at the border. Need to add auth headers or log errors? Middleware centralizes these tasks.
 
-Let’s take a look at a simple example to demonstrate how `@artstesh/postboy` can be used to handle events.
+- **Registrators**  
+  Archivists managing subscription lifecycles. They prevent memory leaks and keep your codebase tidy.
 
-### The case
-
-Suppose we such a simple structure in an Angular application:
-
-<img src="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI2MDAiIGhlaWdodD0iNDAwIiBzdHlsZT0iYmFja2dyb3VuZC1jb2xvcjogdHJhbnNwYXJlbnQ7IGZvbnQtZmFtaWx5OiBBcmlhbCwgc2Fucy1zZXJpZjsgZm9udC1zaXplOiAxNHB4OyI+DQogIDwhLS0gRmlyc3QgTGV2ZWwgQ29tcG9uZW50IC0tPg0KICA8cmVjdCB4PSIyMzAiIHk9IjIwIiB3aWR0aD0iMTQwIiBoZWlnaHQ9IjUwIiBmaWxsPSIjYzhlNmM5IiBzdHJva2U9IiMyZTdkMzIiIHN0cm9rZS13aWR0aD0iMiIgcng9IjYiPjwvcmVjdD4NCiAgPHRleHQgeD0iMzAwIiB5PSI1MCIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZmlsbD0iIzJlN2QzMiI+QXBwQ29tcG9uZW50PC90ZXh0Pg0KDQogIDwhLS0gU2Vjb25kIExldmVsIENvbXBvbmVudHMgLS0+DQogIDxyZWN0IHg9IjEzMCIgeT0iMTIwIiB3aWR0aD0iMTQwIiBoZWlnaHQ9IjUwIiBmaWxsPSIjZmZlY2IzIiBzdHJva2U9IiNmNTdjMDAiIHN0cm9rZS13aWR0aD0iMiIgcng9IjYiPjwvcmVjdD4NCiAgPHRleHQgeD0iMjAwIiB5PSIxNTAiIHRleHQtYW5jaG9yPSJtaWRkbGUiIGZpbGw9IiNmNTdjMDAiPlBhcmVudCBBPC90ZXh0Pg0KDQogIDxyZWN0IHg9IjMzMCIgeT0iMTIwIiB3aWR0aD0iMTQwIiBoZWlnaHQ9IjUwIiBmaWxsPSIjZmZlY2IzIiBzdHJva2U9IiNmNTdjMDAiIHN0cm9rZS13aWR0aD0iMiIgcng9IjYiPjwvcmVjdD4NCiAgPHRleHQgeD0iNDAwIiB5PSIxNTAiIHRleHQtYW5jaG9yPSJtaWRkbGUiIGZpbGw9IiNmNTdjMDAiPlBhcmVudCBCPC90ZXh0Pg0KDQogIDwhLS0gVGhpcmQgTGV2ZWwgQ29tcG9uZW50cyAtLT4NCiAgPHJlY3QgeD0iNzAiIHk9IjI0MCIgd2lkdGg9IjE0MCIgaGVpZ2h0PSI1MCIgZmlsbD0iI2UzZjJmZCIgc3Ryb2tlPSIjMDA3YWNjIiBzdHJva2Utd2lkdGg9IjIiIHJ4PSI2Ij48L3JlY3Q+DQogIDx0ZXh0IHg9IjE0MCIgeT0iMjcwIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBmaWxsPSIjMDA3YWNjIj5DaGlsZCBBPC90ZXh0Pg0KDQogIDxyZWN0IHg9IjIzMCIgeT0iMjQwIiB3aWR0aD0iMTQwIiBoZWlnaHQ9IjUwIiBmaWxsPSIjZTNmMmZkIiBzdHJva2U9IiMwMDdhY2MiIHN0cm9rZS13aWR0aD0iMiIgcng9IjYiPjwvcmVjdD4NCiAgPHRleHQgeD0iMzAwIiB5PSIyNzAiIHRleHQtYW5jaG9yPSJtaWRkbGUiIGZpbGw9IiMwMDdhY2MiPi4uLjwvdGV4dD4NCg0KICA8cmVjdCB4PSIzOTAiIHk9IjI0MCIgd2lkdGg9IjE0MCIgaGVpZ2h0PSI1MCIgZmlsbD0iI2UzZjJmZCIgc3Ryb2tlPSIjMDA3YWNjIiBzdHJva2Utd2lkdGg9IjIiIHJ4PSI2Ij48L3JlY3Q+DQogIDx0ZXh0IHg9IjQ2MCIgeT0iMjcwIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBmaWxsPSIjMDA3YWNjIj5DaGlsZCBCPC90ZXh0Pg0KDQogIDwhLS0gTGluZXMgQ29ubmVjdGluZyBDb21wb25lbnRzIC0tPg0KICA8IS0tIEZyb20gQXBwQ29tcG9uZW50IHRvIFNlY29uZCBMZXZlbCAtLT4NCiAgPGxpbmUgeDE9IjMwMCIgeTE9IjcwIiB4Mj0iMjAwIiB5Mj0iMTIwIiBzdHJva2U9IiM2MDYwNjAiIHN0cm9rZS13aWR0aD0iMiIgbWFya2VyLWVuZD0idXJsKCNhcnJvd2hlYWQpIj48L2xpbmU+DQogIDxsaW5lIHgxPSIzMDAiIHkxPSI3MCIgeDI9IjQwMCIgeTI9IjEyMCIgc3Ryb2tlPSIjNjA2MDYwIiBzdHJva2Utd2lkdGg9IjIiIG1hcmtlci1lbmQ9InVybCgjYXJyb3doZWFkKSI+PC9saW5lPg0KDQogIDwhLS0gRnJvbSBTZWNvbmQgTGV2ZWwgdG8gVGhpcmQgTGV2ZWwgLS0+DQogIDxsaW5lIHgxPSIyMDAiIHkxPSIxNzAiIHgyPSIxNDAiIHkyPSIyNDAiIHN0cm9rZT0iIzYwNjA2MCIgc3Ryb2tlLXdpZHRoPSIyIiBtYXJrZXItZW5kPSJ1cmwoI2Fycm93aGVhZCkiPjwvbGluZT4NCiAgPGxpbmUgeDE9IjQwMCIgeTE9IjE3MCIgeDI9IjQ2MCIgeTI9IjI0MCIgc3Ryb2tlPSIjNjA2MDYwIiBzdHJva2Utd2lkdGg9IjIiIG1hcmtlci1lbmQ9InVybCgjYXJyb3doZWFkKSI+PC9saW5lPg0KDQogIDwhLS0gQXJyb3doZWFkIG1hcmtlciAtLT4NCiAgPGRlZnM+DQogICAgPG1hcmtlciBpZD0iYXJyb3doZWFkIiBtYXJrZXJXaWR0aD0iMTAiIG1hcmtlckhlaWdodD0iNyIgcmVmWD0iMTAiIHJlZlk9IjMuNSIgb3JpZW50PSJhdXRvIj4NCiAgICAgIDxwb2x5Z29uIHBvaW50cz0iMCAwLCAxMCAzLjUsIDAgNyIgZmlsbD0iIzYwNjA2MCI+PC9wb2x5Z29uPg0KICAgIDwvbWFya2VyPg0KICA8L2RlZnM+DQo8L3N2Zz4NCg==">
-
-**Child B** contains a text input and **Child A** have show the value of the input.
-
-In a common case, we would create a specific service with an observable; but it alse means that we have to get an instance of the service in **Child A** and **Child B** and the service itself looks pretty bad - it is just a wrapper over the observable.
-
-*I don't event want to describe the idea of sending information through the parents - it is much more painful and dirty.
-
-### The postboy approach
-
-```typescript
-import {PostboyService} from '@artstesh/postboy';
-
-public class ChildA {
-  constructor(private postboy: PostboyService) {
-  }
-  
-  public ngOnInit(){
-    this.postboy.sub(UserInputEvent).subscribe(ev => {
-      console.log(ev.text);
-    })
-  }
-}
-
-public class ChildB {
-  constructor(private postboy: PostboyService) {
-  }
-
-  public onInput(){
-    this.postboy.fire(new UserInputEvent(this.text));
-  }
-}
-```
-
-### Key Benefits of This Approach
-
-- Clear separation of event generation and event handling.
-- TypeScript interfaces ensure strict typing for the data passed between different parts of the application.
-- The members of the system know nothing about each other
-- No need to create specific mediators
-
-## Advantages of the Library
-
-- **Simplicity:** Clear structure for managing events and their processing.
-- **Safety:** TypeScript ensures type-safety, minimizing potential errors.
-- **Flexibility:** `rxjs` integration allows advanced event processing, such as filtering, pre-processing, and combining event streams.
-- **Scalability:** Code becomes clean and easy to extend without introducing unnecessary complexity.
+---
 
+### Why Does It Work?
+Over the past five years, I’ve built dozens of enterprise apps. One recurring issue? Logic fragmentation. Components communicate via `@Output()` chains and services until a single button change breaks three screens. Postboy offers an alternative: a centralized yet unobtrusive event bus that doesn’t demand architectural overhauls.

package/lib/i-postboy-depending.service.d.ts

@@ -1,4 +1,4 @@
-export interface IPostboyDependingService {
-    up(): void;
-}
+export interface IPostboyDependingService {
+    up(): void;
+}
 //# sourceMappingURL=i-postboy-depending.service.d.ts.map

package/lib/i-postboy-depending.service.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=i-postboy-depending.service.js.map

package/lib/index.d.ts

@@ -1,11 +1,10 @@
-export * from './postboy.service';
-export * from './mocks/postboy-service-mock';
-export * from './i-postboy-depending.service';
-export * from './postboy-abstract.registrator';
-export * from './models/postboy-generic-message';
-export * from './models/postboy-callback.message';
-export * from './models/postboy.locker';
-export * from './models/postboy-execution.handler';
-export * from './models/postboy-executor';
-export * from './models/message-queue.model';
+export * from './postboy.service';
+export * from './i-postboy-depending.service';
+export * from './postboy-abstract.registrator';
+export * from './models/postboy-generic-message';
+export * from './models/postboy-callback.message';
+export * from './models/postboy-execution.handler';
+export * from './models/postboy-executor';
+export * from './models/postboy-middleware';
+export * from './models/postboy.message';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,yBAAyB,CAAC;AACxC,cAAc,oCAAoC,CAAC;AACnD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,8BAA8B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,mBAAmB,CAAC;AAClC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC"}

package/lib/index.js

@@ -1,30 +1,29 @@
-"use strict";
-/*
- * Public API Surface of postboy
- */
-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("./postboy.service"), exports);
-__exportStar(require("./mocks/postboy-service-mock"), exports);
-__exportStar(require("./i-postboy-depending.service"), exports);
-__exportStar(require("./postboy-abstract.registrator"), exports);
-__exportStar(require("./models/postboy-generic-message"), exports);
-__exportStar(require("./models/postboy-callback.message"), exports);
-__exportStar(require("./models/postboy.locker"), exports);
-__exportStar(require("./models/postboy-execution.handler"), exports);
-__exportStar(require("./models/postboy-executor"), exports);
-__exportStar(require("./models/message-queue.model"), exports);
+"use strict";
+/*
+ * Public API Surface of postboy
+ */
+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("./postboy.service"), exports);
+__exportStar(require("./i-postboy-depending.service"), exports);
+__exportStar(require("./postboy-abstract.registrator"), exports);
+__exportStar(require("./models/postboy-generic-message"), exports);
+__exportStar(require("./models/postboy-callback.message"), exports);
+__exportStar(require("./models/postboy-execution.handler"), exports);
+__exportStar(require("./models/postboy-executor"), exports);
+__exportStar(require("./models/postboy-middleware"), exports);
+__exportStar(require("./models/postboy.message"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;AAEH,oDAAkC;AAClC,+DAA6C;AAC7C,gEAA8C;AAC9C,iEAA+C;AAC/C,mEAAiD;AACjD,oEAAkD;AAClD,0DAAwC;AACxC,qEAAmD;AACnD,4DAA0C;AAC1C,+DAA6C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;AAEH,oDAAkC;AAClC,gEAA8C;AAC9C,iEAA+C;AAC/C,mEAAiD;AACjD,oEAAkD;AAClD,qEAAmD;AACnD,4DAA0C;AAC1C,8DAA4C;AAC5C,2DAAyC"}

package/lib/models/message-queue.model.d.ts

@@ -1,44 +1,44 @@
-import { PostboyCallbackMessage } from './postboy-callback.message';
-export declare class MessageQueue<D> {
-    private cache;
-    /**
-     * Gets the current data stored in the instance.
-     *
-     * @return {D | null} The current data or null if no data is set.
-     */
-    get data(): D | null;
-    private queries;
-    private _requestInProgress;
-    private _data;
-    constructor(cache?: boolean);
-    /**
-     * Resets the state of the instance by clearing stored data.
-     * This method sets the internal data to null, effectively resetting the object.
-     *
-     * @return {void} Does not return a value.
-     */
-    reset(): MessageQueue<D>;
-    /**
-     * Attempts to finalize the provided query. It either queues the query for later processing
-     * if a request is in progress or data is missing, or completes the query immediately.
-     *
-     * @param {PostboyCallbackMessage<D>} query - The callback message to be finalized.
-     * @return {boolean} - Returns true if the query was successfully finalized, otherwise false.
-     */
-    tryFinish(query: PostboyCallbackMessage<D>): boolean;
-    /**
-     * Adds a new query to the query queue.
-     *
-     * @param {PostboyCallbackMessage<D>} query - The query to be added to the queue.
-     * @return {MessageQueue<D>} The updated QueryQueue instance.
-     */
-    add(query: PostboyCallbackMessage<D>): MessageQueue<D>;
-    /**
-     * Marks the operation as finished by updating the internal state and handling each query.
-     *
-     * @param {D} data - The data to be set for the current operation.
-     * @return {void} This method does not return a value.
-     */
-    finish(data: D): void;
-}
+import { PostboyCallbackMessage } from './postboy-callback.message';
+export declare class MessageQueue<D> {
+    private cache;
+    /**
+     * Gets the current data stored in the instance.
+     *
+     * @return {D | null} The current data or null if no data is set.
+     */
+    get data(): D | null;
+    private queries;
+    private _requestInProgress;
+    private _data;
+    constructor(cache?: boolean);
+    /**
+     * Resets the state of the instance by clearing stored data.
+     * This method sets the internal data to null, effectively resetting the object.
+     *
+     * @return {void} Does not return a value.
+     */
+    reset(): MessageQueue<D>;
+    /**
+     * Attempts to finalize the provided query. It either queues the query for later processing
+     * if a request is in progress or data is missing, or completes the query immediately.
+     *
+     * @param {PostboyCallbackMessage<D>} query - The callback message to be finalized.
+     * @return {boolean} - Returns true if the query was successfully finalized, otherwise false.
+     */
+    tryFinish(query: PostboyCallbackMessage<D>): boolean;
+    /**
+     * Adds a new query to the query queue.
+     *
+     * @param {PostboyCallbackMessage<D>} query - The query to be added to the queue.
+     * @return {MessageQueue<D>} The updated QueryQueue instance.
+     */
+    add(query: PostboyCallbackMessage<D>): MessageQueue<D>;
+    /**
+     * Marks the operation as finished by updating the internal state and handling each query.
+     *
+     * @param {D} data - The data to be set for the current operation.
+     * @return {void} This method does not return a value.
+     */
+    finish(data: D): void;
+}
 //# sourceMappingURL=message-queue.model.d.ts.map

package/lib/models/message-queue.model.js

@@ -1,66 +1,66 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageQueue = void 0;
-const collections_1 = require("@artstesh/collections");
-class MessageQueue {
-    /**
-     * Gets the current data stored in the instance.
-     *
-     * @return {D | null} The current data or null if no data is set.
-     */
-    get data() {
-        return this._data;
-    }
-    constructor(cache = true) {
-        this.cache = cache;
-        this.queries = new collections_1.Queue();
-        this._requestInProgress = true;
-        this._data = null;
-    }
-    /**
-     * Resets the state of the instance by clearing stored data.
-     * This method sets the internal data to null, effectively resetting the object.
-     *
-     * @return {void} Does not return a value.
-     */
-    reset() {
-        this._data = null;
-        return this;
-    }
-    /**
-     * Attempts to finalize the provided query. It either queues the query for later processing
-     * if a request is in progress or data is missing, or completes the query immediately.
-     *
-     * @param {PostboyCallbackMessage<D>} query - The callback message to be finalized.
-     * @return {boolean} - Returns true if the query was successfully finalized, otherwise false.
-     */
-    tryFinish(query) {
-        if (this._requestInProgress || this._data === null)
-            return this.queries.put(query) && false;
-        query.finish(this._data);
-        return true;
-    }
-    /**
-     * Adds a new query to the query queue.
-     *
-     * @param {PostboyCallbackMessage<D>} query - The query to be added to the queue.
-     * @return {MessageQueue<D>} The updated QueryQueue instance.
-     */
-    add(query) {
-        return this.queries.put(query) && this;
-    }
-    /**
-     * Marks the operation as finished by updating the internal state and handling each query.
-     *
-     * @param {D} data - The data to be set for the current operation.
-     * @return {void} This method does not return a value.
-     */
-    finish(data) {
-        if (this.cache)
-            this._data = data;
-        this._requestInProgress = false;
-        this.queries.each((q) => q.finish(data));
-    }
-}
-exports.MessageQueue = MessageQueue;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageQueue = void 0;
+const queue_1 = require("./queue");
+class MessageQueue {
+    /**
+     * Gets the current data stored in the instance.
+     *
+     * @return {D | null} The current data or null if no data is set.
+     */
+    get data() {
+        return this._data;
+    }
+    constructor(cache = true) {
+        this.cache = cache;
+        this.queries = new queue_1.Queue();
+        this._requestInProgress = true;
+        this._data = null;
+    }
+    /**
+     * Resets the state of the instance by clearing stored data.
+     * This method sets the internal data to null, effectively resetting the object.
+     *
+     * @return {void} Does not return a value.
+     */
+    reset() {
+        this._data = null;
+        return this;
+    }
+    /**
+     * Attempts to finalize the provided query. It either queues the query for later processing
+     * if a request is in progress or data is missing, or completes the query immediately.
+     *
+     * @param {PostboyCallbackMessage<D>} query - The callback message to be finalized.
+     * @return {boolean} - Returns true if the query was successfully finalized, otherwise false.
+     */
+    tryFinish(query) {
+        if (this._requestInProgress || this._data === null)
+            return this.queries.put(query) && false;
+        query.finish(this._data);
+        return true;
+    }
+    /**
+     * Adds a new query to the query queue.
+     *
+     * @param {PostboyCallbackMessage<D>} query - The query to be added to the queue.
+     * @return {MessageQueue<D>} The updated QueryQueue instance.
+     */
+    add(query) {
+        return this.queries.put(query) && this;
+    }
+    /**
+     * Marks the operation as finished by updating the internal state and handling each query.
+     *
+     * @param {D} data - The data to be set for the current operation.
+     * @return {void} This method does not return a value.
+     */
+    finish(data) {
+        if (this.cache)
+            this._data = data;
+        this._requestInProgress = false;
+        this.queries.each((q) => q.finish(data));
+    }
+}
+exports.MessageQueue = MessageQueue;
 //# sourceMappingURL=message-queue.model.js.map

package/lib/models/message-queue.model.js.map

@@ -1 +1 @@
-{"version":3,"file":"message-queue.model.js","sourceRoot":"","sources":["../../src/models/message-queue.model.ts"],"names":[],"mappings":";;;AACA,uDAA8C;AAE9C,MAAa,YAAY;IACvB;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAMD,YAAoB,QAAiB,IAAI;QAArB,UAAK,GAAL,KAAK,CAAgB;QAJjC,YAAO,GAAqC,IAAI,mBAAK,EAA6B,CAAC;QACnF,uBAAkB,GAAY,IAAI,CAAC;QACnC,UAAK,GAAa,IAAI,CAAC;IAEa,CAAC;IAE7C;;;;;OAKG;IACI,KAAK;QACV,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CAAC,KAAgC;QAC/C,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;QAC5F,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,GAAG,CAAC,KAAgC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,IAAO;QACnB,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;QAChC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC;CACF;AA7DD,oCA6DC"}
+{"version":3,"file":"message-queue.model.js","sourceRoot":"","sources":["../../src/models/message-queue.model.ts"],"names":[],"mappings":";;;AACA,mCAA8B;AAE9B,MAAa,YAAY;IACvB;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAMD,YAAoB,QAAiB,IAAI;QAArB,UAAK,GAAL,KAAK,CAAgB;QAJjC,YAAO,GAAqC,IAAI,aAAK,EAA6B,CAAC;QACnF,uBAAkB,GAAY,IAAI,CAAC;QACnC,UAAK,GAAa,IAAI,CAAC;IAEa,CAAC;IAE7C;;;;;OAKG;IACI,KAAK;QACV,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CAAC,KAAgC;QAC/C,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;QAC5F,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,GAAG,CAAC,KAAgC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,IAAO;QACnB,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;QAChC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC;CACF;AA7DD,oCA6DC"}

package/lib/models/postboy-callback.message.d.ts

@@ -1,9 +1,27 @@
-import { Observable, Subject } from 'rxjs';
-import { PostboyGenericMessage } from './postboy-generic-message';
-export declare abstract class PostboyCallbackMessage<T> extends PostboyGenericMessage {
-    protected result$: Subject<T>;
-    result: Observable<T>;
-    next: (value: T) => void;
-    finish(value: T): void;
-}
+import { Observable, Subject } from 'rxjs';
+import { PostboyGenericMessage } from './postboy-generic-message';
+/**
+ * An abstract class extending PostboyGenericMessage that provides mechanisms for managing
+ * asynchronous data communication using RxJS observables. It is designed to work with
+ * callback-based operations that emit a result of type T.
+ *
+ * @template T - The type of the data emitted by the observables in this class.
+ *
+ * @extends PostboyGenericMessage
+ *
+ * @property {Observable<T>} result - An observable that emits the result of the operation
+ * and completes once the operation is finished.
+ *
+ * @method next - Emits the next value for the result observable.
+ * @param {T} value - The value to be emitted by the result observable.
+ *
+ * @method finish - Emits the final value for the result observable and completes it.
+ * @param {T} value - The final value for the observable emission.
+ */
+export declare abstract class PostboyCallbackMessage<T> extends PostboyGenericMessage {
+    protected result$: Subject<T>;
+    result: Observable<T>;
+    next: (value: T) => void;
+    finish(value: T): void;
+}
 //# sourceMappingURL=postboy-callback.message.d.ts.map

package/lib/models/postboy-callback.message.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postboy-callback.message.d.ts","sourceRoot":"","sources":["../../src/models/postboy-callback.message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAElE,8BAAsB,sBAAsB,CAAC,CAAC,CAAE,SAAQ,qBAAqB;IAC3E,SAAS,CAAC,OAAO,aAAoB;IAC9B,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAA+B;IAEpD,IAAI,UAAW,CAAC,KAAG,IAAI,CAA6B;IAEpD,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI;CAI9B"}
+{"version":3,"file":"postboy-callback.message.d.ts","sourceRoot":"","sources":["../../src/models/postboy-callback.message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAElE;;;;;;;;;;;;;;;;;GAiBG;AACH,8BAAsB,sBAAsB,CAAC,CAAC,CAAE,SAAQ,qBAAqB;IAC3E,SAAS,CAAC,OAAO,aAAoB;IAC9B,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAA+B;IAEpD,IAAI,UAAW,CAAC,KAAG,IAAI,CAA6B;IAEpD,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI;CAI9B"}

package/lib/models/postboy-callback.message.js

@@ -1,19 +1,37 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PostboyCallbackMessage = void 0;
-const rxjs_1 = require("rxjs");
-const postboy_generic_message_1 = require("./postboy-generic-message");
-class PostboyCallbackMessage extends postboy_generic_message_1.PostboyGenericMessage {
-    constructor() {
-        super(...arguments);
-        this.result$ = new rxjs_1.Subject();
-        this.result = this.result$.asObservable();
-        this.next = (value) => this.result$.next(value);
-    }
-    finish(value) {
-        this.result$.next(value);
-        this.result$.complete();
-    }
-}
-exports.PostboyCallbackMessage = PostboyCallbackMessage;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostboyCallbackMessage = void 0;
+const rxjs_1 = require("rxjs");
+const postboy_generic_message_1 = require("./postboy-generic-message");
+/**
+ * An abstract class extending PostboyGenericMessage that provides mechanisms for managing
+ * asynchronous data communication using RxJS observables. It is designed to work with
+ * callback-based operations that emit a result of type T.
+ *
+ * @template T - The type of the data emitted by the observables in this class.
+ *
+ * @extends PostboyGenericMessage
+ *
+ * @property {Observable<T>} result - An observable that emits the result of the operation
+ * and completes once the operation is finished.
+ *
+ * @method next - Emits the next value for the result observable.
+ * @param {T} value - The value to be emitted by the result observable.
+ *
+ * @method finish - Emits the final value for the result observable and completes it.
+ * @param {T} value - The final value for the observable emission.
+ */
+class PostboyCallbackMessage extends postboy_generic_message_1.PostboyGenericMessage {
+    constructor() {
+        super(...arguments);
+        this.result$ = new rxjs_1.Subject();
+        this.result = this.result$.asObservable();
+        this.next = (value) => this.result$.next(value);
+    }
+    finish(value) {
+        this.result$.next(value);
+        this.result$.complete();
+    }
+}
+exports.PostboyCallbackMessage = PostboyCallbackMessage;
 //# sourceMappingURL=postboy-callback.message.js.map

package/lib/models/postboy-callback.message.js.map

@@ -1 +1 @@
-{"version":3,"file":"postboy-callback.message.js","sourceRoot":"","sources":["../../src/models/postboy-callback.message.ts"],"names":[],"mappings":";;;AAAA,+BAA2C;AAC3C,uEAAkE;AAElE,MAAsB,sBAA0B,SAAQ,+CAAqB;IAA7E;;QACY,YAAO,GAAG,IAAI,cAAO,EAAK,CAAC;QAC9B,WAAM,GAAkB,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;QAEpD,SAAI,GAAG,CAAC,KAAQ,EAAQ,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAM7D,CAAC;IAJQ,MAAM,CAAC,KAAQ;QACpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;CACF;AAVD,wDAUC"}
+{"version":3,"file":"postboy-callback.message.js","sourceRoot":"","sources":["../../src/models/postboy-callback.message.ts"],"names":[],"mappings":";;;AAAA,+BAA2C;AAC3C,uEAAkE;AAElE;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAsB,sBAA0B,SAAQ,+CAAqB;IAA7E;;QACY,YAAO,GAAG,IAAI,cAAO,EAAK,CAAC;QAC9B,WAAM,GAAkB,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;QAEpD,SAAI,GAAG,CAAC,KAAQ,EAAQ,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAM7D,CAAC;IAJQ,MAAM,CAAC,KAAQ;QACpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;CACF;AAVD,wDAUC"}

package/lib/models/postboy-execution.handler.d.ts

@@ -1,15 +1,15 @@
-import { PostboyExecutor } from './postboy-executor';
-/**
- * Abstract class representing a handler for executing a Postboy task.
- *
- * This class is intended to manage the execution flow of a PostboyExecutor instance.
- * Subclasses must implement the `handle` method, which executes a given PostboyExecutor
- * and returns a result of type R.
- *
- * @template R The type of the result returned by the `handle` method.
- * @template E The type of the executor extending the PostboyExecutor.
- */
-export declare abstract class PostboyExecutionHandler<R, E extends PostboyExecutor<R>> {
-    abstract handle(executor: E): R;
-}
+import { PostboyExecutor } from './postboy-executor';
+/**
+ * Abstract class representing a handler for executing a Postboy task.
+ *
+ * This class is intended to manage the execution flow of a PostboyExecutor instance.
+ * Subclasses must implement the `handle` method, which executes a given PostboyExecutor
+ * and returns a result of type R.
+ *
+ * @template R The type of the result returned by the `handle` method.
+ * @template E The type of the executor extending the PostboyExecutor.
+ */
+export declare abstract class PostboyExecutionHandler<R, E extends PostboyExecutor<R>> {
+    abstract handle(executor: E): R;
+}
 //# sourceMappingURL=postboy-execution.handler.d.ts.map

package/lib/models/postboy-execution.handler.js

@@ -1,17 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PostboyExecutionHandler = void 0;
-/**
- * Abstract class representing a handler for executing a Postboy task.
- *
- * This class is intended to manage the execution flow of a PostboyExecutor instance.
- * Subclasses must implement the `handle` method, which executes a given PostboyExecutor
- * and returns a result of type R.
- *
- * @template R The type of the result returned by the `handle` method.
- * @template E The type of the executor extending the PostboyExecutor.
- */
-class PostboyExecutionHandler {
-}
-exports.PostboyExecutionHandler = PostboyExecutionHandler;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostboyExecutionHandler = void 0;
+/**
+ * Abstract class representing a handler for executing a Postboy task.
+ *
+ * This class is intended to manage the execution flow of a PostboyExecutor instance.
+ * Subclasses must implement the `handle` method, which executes a given PostboyExecutor
+ * and returns a result of type R.
+ *
+ * @template R The type of the result returned by the `handle` method.
+ * @template E The type of the executor extending the PostboyExecutor.
+ */
+class PostboyExecutionHandler {
+}
+exports.PostboyExecutionHandler = PostboyExecutionHandler;
 //# sourceMappingURL=postboy-execution.handler.js.map