@artstesh/postboy 1.2.3 → 1.3.0

package/lib/messages/lock-message.executor.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LockMessage = void 0;
+const postboy_executor_1 = require("../models/postboy-executor");
+/**
+ * Locks a specific message type to prevent firing of them.
+ *
+ * This class is used to handle operations associated with locking mechanisms
+ * for a specified message type.
+ *
+ * @template T - A type that extends {@link PostboyGenericMessage}.
+ */
+class LockMessage extends postboy_executor_1.PostboyExecutor {
+    /**
+     * Constructs an instance of the class with the specified message type.
+     *
+     * @param {MessageType<T>} type - The type of the message to be used for the instance.
+     */
+    constructor(type) {
+        super();
+        this.type = type;
+    }
+}
+exports.LockMessage = LockMessage;
+LockMessage.ID = '477df3e2-1f99-4476-9a3b-afd1fa426436';
+//# sourceMappingURL=lock-message.executor.js.map

package/lib/messages/lock-message.executor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock-message.executor.js","sourceRoot":"","sources":["../../src/messages/lock-message.executor.ts"],"names":[],"mappings":";;;AAEA,iEAA6D;AAE7D;;;;;;;GAOG;AACH,MAAa,WAA6C,SAAQ,kCAAqB;IAGrF;;;;OAIG;IACH,YAAmB,IAAoB;QACrC,KAAK,EAAE,CAAC;QADS,SAAI,GAAJ,IAAI,CAAgB;IAEvC,CAAC;;AAVH,kCAWC;AAViB,cAAE,GAAG,sCAAsC,CAAC"}

package/lib/messages/remove-middleware.executor.d.ts

@@ -0,0 +1,17 @@
+import { PostboyMiddleware } from '../models/postboy-middleware';
+import { PostboyExecutor } from '../models/postboy-executor';
+/**
+ * Represents a class responsible for removing {@link PostboyMiddleware} in execution flow.
+ * This class extends PostboyExecutor and operates with a void return type.
+ */
+export declare class RemoveMiddleware extends PostboyExecutor<void> {
+    middleware: PostboyMiddleware;
+    static readonly ID = "c25c708c-53c9-498d-a28b-936fbaf68b91";
+    /**
+     * Constructs an instance of the class with the specified middleware.
+     *
+     * @param {PostboyMiddleware} middleware - The {@link PostboyMiddleware} instance to be removed.
+     */
+    constructor(middleware: PostboyMiddleware);
+}
+//# sourceMappingURL=remove-middleware.executor.d.ts.map

package/lib/messages/remove-middleware.executor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove-middleware.executor.d.ts","sourceRoot":"","sources":["../../src/messages/remove-middleware.executor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAE7D;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,eAAe,CAAC,IAAI,CAAC;IAQtC,UAAU,EAAE,iBAAiB;IAPhD,MAAM,CAAC,QAAQ,CAAC,EAAE,0CAA0C;IAE5D;;;;OAIG;gBACgB,UAAU,EAAE,iBAAiB;CAGjD"}

package/lib/messages/remove-middleware.executor.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoveMiddleware = void 0;
+const postboy_executor_1 = require("../models/postboy-executor");
+/**
+ * Represents a class responsible for removing {@link PostboyMiddleware} in execution flow.
+ * This class extends PostboyExecutor and operates with a void return type.
+ */
+class RemoveMiddleware extends postboy_executor_1.PostboyExecutor {
+    /**
+     * Constructs an instance of the class with the specified middleware.
+     *
+     * @param {PostboyMiddleware} middleware - The {@link PostboyMiddleware} instance to be removed.
+     */
+    constructor(middleware) {
+        super();
+        this.middleware = middleware;
+    }
+}
+exports.RemoveMiddleware = RemoveMiddleware;
+RemoveMiddleware.ID = 'c25c708c-53c9-498d-a28b-936fbaf68b91';
+//# sourceMappingURL=remove-middleware.executor.js.map

package/lib/messages/remove-middleware.executor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove-middleware.executor.js","sourceRoot":"","sources":["../../src/messages/remove-middleware.executor.ts"],"names":[],"mappings":";;;AACA,iEAA6D;AAE7D;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,kCAAqB;IAGzD;;;;OAIG;IACH,YAAmB,UAA6B;QAC9C,KAAK,EAAE,CAAC;QADS,eAAU,GAAV,UAAU,CAAmB;IAEhD,CAAC;;AAVH,4CAWC;AAViB,mBAAE,GAAG,sCAAsC,CAAC"}

package/lib/messages/unlock-message.executor.d.ts

@@ -0,0 +1,21 @@
+import { PostboyGenericMessage } from '../models/postboy-generic-message';
+import { PostboyExecutor } from '../models/postboy-executor';
+import { MessageType } from '../postboy-abstract.registrator';
+/**
+ * A specialized executor that handles the unlocking process for messages of a specified type.
+ * Unlocks a previously locked message, making it available for processing again.
+ *
+ * @template T - The type parameter extending {@link PostboyGenericMessage}, representing the message type handled by the executor.
+ * @extends {PostboyExecutor<void>}
+ */
+export declare class UnlockMessage<T extends PostboyGenericMessage> extends PostboyExecutor<void> {
+    type: MessageType<T>;
+    static readonly ID = "d71d25e3-90ac-4009-b972-9e6c6b05611e";
+    /**
+     * Creates an instance of the class with the specified message type.
+     *
+     * @param {MessageType<T>} type - The message type for this instance.
+     */
+    constructor(type: MessageType<T>);
+}
+//# sourceMappingURL=unlock-message.executor.d.ts.map

package/lib/messages/unlock-message.executor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unlock-message.executor.d.ts","sourceRoot":"","sources":["../../src/messages/unlock-message.executor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAE9D;;;;;;GAMG;AACH,qBAAa,aAAa,CAAC,CAAC,SAAS,qBAAqB,CAAE,SAAQ,eAAe,CAAC,IAAI,CAAC;IAQpE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;IAPvC,MAAM,CAAC,QAAQ,CAAC,EAAE,0CAA0C;IAE5D;;;;OAIG;gBACgB,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;CAGxC"}

package/lib/messages/unlock-message.executor.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnlockMessage = void 0;
+const postboy_executor_1 = require("../models/postboy-executor");
+/**
+ * A specialized executor that handles the unlocking process for messages of a specified type.
+ * Unlocks a previously locked message, making it available for processing again.
+ *
+ * @template T - The type parameter extending {@link PostboyGenericMessage}, representing the message type handled by the executor.
+ * @extends {PostboyExecutor<void>}
+ */
+class UnlockMessage extends postboy_executor_1.PostboyExecutor {
+    /**
+     * Creates an instance of the class with the specified message type.
+     *
+     * @param {MessageType<T>} type - The message type for this instance.
+     */
+    constructor(type) {
+        super();
+        this.type = type;
+    }
+}
+exports.UnlockMessage = UnlockMessage;
+UnlockMessage.ID = 'd71d25e3-90ac-4009-b972-9e6c6b05611e';
+//# sourceMappingURL=unlock-message.executor.js.map

package/lib/messages/unlock-message.executor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unlock-message.executor.js","sourceRoot":"","sources":["../../src/messages/unlock-message.executor.ts"],"names":[],"mappings":";;;AACA,iEAA6D;AAG7D;;;;;;GAMG;AACH,MAAa,aAA+C,SAAQ,kCAAqB;IAGvF;;;;OAIG;IACH,YAAmB,IAAoB;QACrC,KAAK,EAAE,CAAC;QADS,SAAI,GAAJ,IAAI,CAAgB;IAEvC,CAAC;;AAVH,sCAWC;AAViB,gBAAE,GAAG,sCAAsC,CAAC"}

package/lib/models/cancel-details.d.ts

@@ -0,0 +1,9 @@
+import { MiddlewareStage } from "./middleware-stage.enum";
+export interface CancelDetails {
+    stage: MiddlewareStage;
+    reason?: string;
+    middleware?: string;
+    messageId?: string;
+    namespace?: string;
+}
+//# sourceMappingURL=cancel-details.d.ts.map

package/lib/models/cancel-details.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel-details.d.ts","sourceRoot":"","sources":["../../src/models/cancel-details.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,eAAe,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/lib/models/cancel-details.js

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

package/lib/models/cancel-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel-details.js","sourceRoot":"","sources":["../../src/models/cancel-details.ts"],"names":[],"mappings":""}

package/lib/models/cancel-error.d.ts

@@ -0,0 +1,7 @@
+import { CancelDetails } from "./cancel-details";
+export declare class CancelError extends Error {
+    readonly details: CancelDetails;
+    constructor(details: CancelDetails);
+}
+export declare function isCancelError(error: unknown): error is CancelError;
+//# sourceMappingURL=cancel-error.d.ts.map

package/lib/models/cancel-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel-error.d.ts","sourceRoot":"","sources":["../../src/models/cancel-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAG/C,qBAAa,WAAY,SAAQ,KAAK;IACpC,SAAgB,OAAO,EAAE,aAAa,CAAC;gBAE3B,OAAO,EAAE,aAAa;CAKnC;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAElE"}

package/lib/models/cancel-error.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CancelError = void 0;
+exports.isCancelError = isCancelError;
+const middleware_stage_enum_1 = require("./middleware-stage.enum");
+class CancelError extends Error {
+    constructor(details) {
+        var _a;
+        super((_a = details.reason) !== null && _a !== void 0 ? _a : `Postboy operation was cancelled at stage "${middleware_stage_enum_1.MiddlewareStage[details.stage]}"`);
+        this.name = 'PostboyCancelError';
+        this.details = details;
+    }
+}
+exports.CancelError = CancelError;
+function isCancelError(error) {
+    return error instanceof CancelError;
+}
+//# sourceMappingURL=cancel-error.js.map

package/lib/models/cancel-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel-error.js","sourceRoot":"","sources":["../../src/models/cancel-error.ts"],"names":[],"mappings":";;;AAaA,sCAEC;AAdD,mEAAwD;AAExD,MAAa,WAAY,SAAQ,KAAK;IAGpC,YAAY,OAAsB;;QAChC,KAAK,CAAC,MAAA,OAAO,CAAC,MAAM,mCAAI,6CAA6C,uCAAe,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACxG,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AARD,kCAQC;AAED,SAAgB,aAAa,CAAC,KAAc;IAC1C,OAAO,KAAK,YAAY,WAAW,CAAC;AACtC,CAAC"}

package/lib/models/middleware-decision.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum MiddlewareDecision {
+    Continue = 1,
+    Interrupt = 2
+}
+//# sourceMappingURL=middleware-decision.enum.d.ts.map

package/lib/models/middleware-decision.enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware-decision.enum.d.ts","sourceRoot":"","sources":["../../src/models/middleware-decision.enum.ts"],"names":[],"mappings":"AACA,oBAAY,kBAAkB;IAC5B,QAAQ,IAAG;IACX,SAAS,IAAA;CACV"}

package/lib/models/middleware-decision.enum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MiddlewareDecision = void 0;
+var MiddlewareDecision;
+(function (MiddlewareDecision) {
+    MiddlewareDecision[MiddlewareDecision["Continue"] = 1] = "Continue";
+    MiddlewareDecision[MiddlewareDecision["Interrupt"] = 2] = "Interrupt";
+})(MiddlewareDecision || (exports.MiddlewareDecision = MiddlewareDecision = {}));
+//# sourceMappingURL=middleware-decision.enum.js.map

package/lib/models/middleware-decision.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware-decision.enum.js","sourceRoot":"","sources":["../../src/models/middleware-decision.enum.ts"],"names":[],"mappings":";;;AACA,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,mEAAW,CAAA;IACX,qEAAS,CAAA;AACX,CAAC,EAHW,kBAAkB,kCAAlB,kBAAkB,QAG7B"}

package/lib/models/middleware-stage.enum.d.ts

@@ -0,0 +1,6 @@
+export declare enum MiddlewareStage {
+    Publish = 1,
+    Callback = 2,
+    Execute = 3
+}
+//# sourceMappingURL=middleware-stage.enum.d.ts.map

package/lib/models/middleware-stage.enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware-stage.enum.d.ts","sourceRoot":"","sources":["../../src/models/middleware-stage.enum.ts"],"names":[],"mappings":"AAAA,oBAAY,eAAe;IACzB,OAAO,IAAI;IACX,QAAQ,IAAA;IACR,OAAO,IAAA;CACR"}

package/lib/models/middleware-stage.enum.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MiddlewareStage = void 0;
+var MiddlewareStage;
+(function (MiddlewareStage) {
+    MiddlewareStage[MiddlewareStage["Publish"] = 1] = "Publish";
+    MiddlewareStage[MiddlewareStage["Callback"] = 2] = "Callback";
+    MiddlewareStage[MiddlewareStage["Execute"] = 3] = "Execute";
+})(MiddlewareStage || (exports.MiddlewareStage = MiddlewareStage = {}));
+//# sourceMappingURL=middleware-stage.enum.js.map

package/lib/models/middleware-stage.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware-stage.enum.js","sourceRoot":"","sources":["../../src/models/middleware-stage.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,2DAAW,CAAA;IACX,6DAAQ,CAAA;IACR,2DAAO,CAAA;AACT,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B"}

package/lib/models/pipeline-context.d.ts

@@ -0,0 +1,7 @@
+import { PostboyMessage } from "./postboy.message";
+import { MiddlewareStage } from "./middleware-stage.enum";
+export interface PipelineContext<T extends PostboyMessage = PostboyMessage> {
+    stage: MiddlewareStage;
+    message: T;
+}
+//# sourceMappingURL=pipeline-context.d.ts.map

package/lib/models/pipeline-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline-context.d.ts","sourceRoot":"","sources":["../../src/models/pipeline-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAC,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc;IACxE,KAAK,EAAE,eAAe,CAAC;IACvB,OAAO,EAAE,CAAC,CAAC;CACZ"}

package/lib/models/pipeline-context.js

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

package/lib/models/pipeline-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline-context.js","sourceRoot":"","sources":["../../src/models/pipeline-context.ts"],"names":[],"mappings":""}

package/lib/models/pipeline-result.d.ts

@@ -0,0 +1,6 @@
+export type PipelineResult = {
+    cancelled: boolean;
+    cancelledBy?: string;
+    reason?: string;
+};
+//# sourceMappingURL=pipeline-result.d.ts.map

package/lib/models/pipeline-result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline-result.d.ts","sourceRoot":"","sources":["../../src/models/pipeline-result.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/lib/models/pipeline-result.js

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

package/lib/models/pipeline-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline-result.js","sourceRoot":"","sources":["../../src/models/pipeline-result.ts"],"names":[],"mappings":""}

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

@@ -21,7 +21,28 @@ import { PostboyGenericMessage } from './postboy-generic-message';
 export declare abstract class PostboyCallbackMessage<T> extends PostboyGenericMessage {
     protected result$: Subject<T>;
     result: Observable<T>;
+    /**
+     * Emits the provided value.
+     *
+     * @template T - The type of the value to emit.
+     * @param {T} value - The value to emit through the `result$` observable.
+     * @returns {void}
+     */
     next: (value: T) => void;
+    /**
+     * Marks the operation as complete by emitting the provided value and then completing the result stream.
+     *
+     * @param {T} value - The value to emit prior to completing the result stream.
+     * @return {void} This method does not return a value.
+     */
     finish(value: T): void;
+    /**
+     * Completes the current observable result stream.
+     * This method marks the result observable as complete, ensuring no further values
+     * or events will be emitted from it.
+     *
+     * @return {void} No value is returned from this method.
+     */
+    complete(): 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;;;;;;;;;;;;;;;;;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"}
+{"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;IAE3D;;;;;;OAMG;IACI,IAAI,UAAW,CAAC,KAAG,IAAI,CAA6B;IAE3D;;;;;OAKG;IACI,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI;IAK7B;;;;;;OAMG;IACI,QAAQ,IAAI,IAAI;CAGxB"}

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

@@ -26,12 +26,35 @@ class PostboyCallbackMessage extends postboy_generic_message_1.PostboyGenericMes
         super(...arguments);
         this.result$ = new rxjs_1.Subject();
         this.result = this.result$.asObservable();
+        /**
+         * Emits the provided value.
+         *
+         * @template T - The type of the value to emit.
+         * @param {T} value - The value to emit through the `result$` observable.
+         * @returns {void}
+         */
         this.next = (value) => this.result$.next(value);
     }
+    /**
+     * Marks the operation as complete by emitting the provided value and then completing the result stream.
+     *
+     * @param {T} value - The value to emit prior to completing the result stream.
+     * @return {void} This method does not return a value.
+     */
     finish(value) {
         this.result$.next(value);
         this.result$.complete();
     }
+    /**
+     * Completes the current observable result stream.
+     * This method marks the result observable as complete, ensuring no further values
+     * or events will be emitted from it.
+     *
+     * @return {void} No value is returned from this method.
+     */
+    complete() {
+        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;;;;;;;;;;;;;;;;;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"}
+{"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;QAE3D;;;;;;WAMG;QACI,SAAI,GAAG,CAAC,KAAQ,EAAQ,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAuB7D,CAAC;IArBC;;;;;OAKG;IACI,MAAM,CAAC,KAAQ;QACpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,QAAQ;QACb,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;CACF;AAlCD,wDAkCC"}

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

@@ -10,6 +10,12 @@ import { PostboyExecutor } from './postboy-executor';
  * @template E The type of the executor extending the PostboyExecutor.
  */
 export declare abstract class PostboyExecutionHandler<R, E extends PostboyExecutor<R>> {
+    /**
+     * Abstract method to handle the specified executor and return a result.
+     *
+     * @param {E} executor - The executor that will be processed by the method.
+     * @return {R} The result obtained after handling the executor.
+     */
     abstract handle(executor: E): R;
 }
 //# sourceMappingURL=postboy-execution.handler.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"postboy-execution.handler.d.ts","sourceRoot":"","sources":["../../src/models/postboy-execution.handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;;;;;;GASG;AACH,8BAAsB,uBAAuB,CAAC,CAAC,EAAE,CAAC,SAAS,eAAe,CAAC,CAAC,CAAC;IAC3E,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC;CAChC"}
+{"version":3,"file":"postboy-execution.handler.d.ts","sourceRoot":"","sources":["../../src/models/postboy-execution.handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;;;;;;GASG;AACH,8BAAsB,uBAAuB,CAAC,CAAC,EAAE,CAAC,SAAS,eAAe,CAAC,CAAC,CAAC;IAC3E;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC;CAChC"}

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

@@ -1 +1 @@
-{"version":3,"file":"postboy-execution.handler.js","sourceRoot":"","sources":["../../src/models/postboy-execution.handler.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;GASG;AACH,MAAsB,uBAAuB;CAE5C;AAFD,0DAEC"}
+{"version":3,"file":"postboy-execution.handler.js","sourceRoot":"","sources":["../../src/models/postboy-execution.handler.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;GASG;AACH,MAAsB,uBAAuB;CAQ5C;AARD,0DAQC"}

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

@@ -0,0 +1,26 @@
+/**
+ * Represents metadata associated with a Postboy message.
+ *
+ * This interface can be used to store optional metadata that provides
+ * additional context or tracking information for a message. It supports
+ * flexible extension by allowing additional properties through an index signature.
+ *
+ * Properties:
+ * - `correlationId` (optional): A unique identifier used to correlate
+ *   related messages or operations across systems.
+ * - `causationId` (optional): The identifier of the preceding message
+ *   or event that caused the current message to be produced.
+ * - `source` (optional): The origin or source of the message, such as
+ *   a particular service or system.
+ * - `tags` (optional): An array of tags or labels that can be attached
+ *   to the message for categorization, filtering, or logging purposes.
+ * - `[key: string]` (optional): Additional custom properties can be
+ *   added to capture specific metadata not covered by the predefined fields.
+ */
+export interface PostboyMessageMetadata {
+    correlationId?: string;
+    causationId?: string;
+    tags?: Set<string>;
+    [key: string]: any;
+}
+//# sourceMappingURL=postboy-message-metadata.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"postboy-message-metadata.d.ts","sourceRoot":"","sources":["../../src/models/postboy-message-metadata.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,sBAAsB;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"postboy-message-metadata.js","sourceRoot":"","sources":["../../src/models/postboy-message-metadata.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,9 @@
+export interface PostboyMessageContext {
+    correlationId: string;
+    currentMessageId: string;
+    parentMessageId?: string;
+    depth: number;
+    startedAt: Date;
+    tags?: Set<string>;
+}
+//# sourceMappingURL=postboy-message.context.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"postboy-message.context.d.ts","sourceRoot":"","sources":["../../src/models/postboy-message.context.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,qBAAqB;IACpC,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,IAAI,CAAC;IAChB,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CACpB"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"postboy-message.context.js","sourceRoot":"","sources":["../../src/models/postboy-message.context.ts"],"names":[],"mappings":""}

package/lib/models/postboy-subscription.d.ts

@@ -1,10 +1,39 @@
 import { Observable, Subject } from 'rxjs';
+/**
+ * A class that manages a reactive subscription using a provided Subject and transformation pipe.
+ * Offers methods to interact with the subscription, such as emitting data, completing the subscription,
+ * and accessing the transformed observable.
+ *
+ * @template T The type of data managed by the subscription.
+ */
 export declare class PostboySubscription<T> {
     private subscription;
-    private pipe;
-    constructor(subscription: Subject<T>, pipe: (s: Subject<T>) => Observable<T>);
+    private readonly _subscription;
+    /**
+     * Constructs an instance of the class with a given subscription and a transformation pipe.
+     *
+     * @param {Subject<T>} subscription - The source Subject that will be transformed.
+     * @param {(s: Subject<T>) => Observable<T>} pipe - A function that applies a transformation to the subscription.
+     */
+    constructor(subscription: Subject<T>, pipe?: (s: Subject<T>) => Observable<T>);
+    /**
+     * Returns an observable subscription.
+     *
+     * @return {Observable<T>} An observable instance of type T.
+     */
     sub(): Observable<T>;
+    /**
+     * Triggers an event by emitting the provided data to all subscribers.
+     *
+     * @param {T} data - The data to emit to the subscribers.
+     * @return {void} - Does not return any value.
+     */
     fire(data: T): void;
+    /**
+     * Completes the subscription, signaling that no further values will be sent.
+     * This is typically used to finalize or clean up resources.
+     * @return {void} This method does not return any value.
+     */
     finish(): void;
 }
 //# sourceMappingURL=postboy-subscription.d.ts.map

package/lib/models/postboy-subscription.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postboy-subscription.d.ts","sourceRoot":"","sources":["../../src/models/postboy-subscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE3C,qBAAa,mBAAmB,CAAC,CAAC;IAE9B,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,IAAI;gBADJ,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,EACxB,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC;IAGzC,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC;IAIpB,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI;IAInB,MAAM,IAAI,IAAI;CAGtB"}
+{"version":3,"file":"postboy-subscription.d.ts","sourceRoot":"","sources":["../../src/models/postboy-subscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE3C;;;;;;GAMG;AACH,qBAAa,mBAAmB,CAAC,CAAC;IAU9B,OAAO,CAAC,YAAY;IATtB,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAE9C;;;;;OAKG;gBAEO,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,EAChC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC;IAKzC;;;;OAIG;IACI,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC;IAI3B;;;;;OAKG;IACI,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI;IAI1B;;;;OAIG;IACI,MAAM,IAAI,IAAI;CAGtB"}

package/lib/models/postboy-subscription.js

@@ -1,17 +1,46 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PostboySubscription = void 0;
+/**
+ * A class that manages a reactive subscription using a provided Subject and transformation pipe.
+ * Offers methods to interact with the subscription, such as emitting data, completing the subscription,
+ * and accessing the transformed observable.
+ *
+ * @template T The type of data managed by the subscription.
+ */
 class PostboySubscription {
+    /**
+     * Constructs an instance of the class with a given subscription and a transformation pipe.
+     *
+     * @param {Subject<T>} subscription - The source Subject that will be transformed.
+     * @param {(s: Subject<T>) => Observable<T>} pipe - A function that applies a transformation to the subscription.
+     */
     constructor(subscription, pipe) {
         this.subscription = subscription;
-        this.pipe = pipe;
+        this._subscription = !!pipe ? pipe(subscription) : subscription.asObservable();
     }
+    /**
+     * Returns an observable subscription.
+     *
+     * @return {Observable<T>} An observable instance of type T.
+     */
     sub() {
-        return this.pipe(this.subscription);
+        return this._subscription;
     }
+    /**
+     * Triggers an event by emitting the provided data to all subscribers.
+     *
+     * @param {T} data - The data to emit to the subscribers.
+     * @return {void} - Does not return any value.
+     */
     fire(data) {
         this.subscription.next(data);
     }
+    /**
+     * Completes the subscription, signaling that no further values will be sent.
+     * This is typically used to finalize or clean up resources.
+     * @return {void} This method does not return any value.
+     */
     finish() {
         this.subscription.complete();
     }

package/lib/models/postboy-subscription.js.map

@@ -1 +1 @@
-{"version":3,"file":"postboy-subscription.js","sourceRoot":"","sources":["../../src/models/postboy-subscription.ts"],"names":[],"mappings":";;;AAEA,MAAa,mBAAmB;IAC9B,YACU,YAAwB,EACxB,IAAsC;QADtC,iBAAY,GAAZ,YAAY,CAAY;QACxB,SAAI,GAAJ,IAAI,CAAkC;IAC7C,CAAC;IAEG,GAAG;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACtC,CAAC;IAEM,IAAI,CAAC,IAAO;QACjB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAEM,MAAM;QACX,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;IAC/B,CAAC;CACF;AAjBD,kDAiBC"}
+{"version":3,"file":"postboy-subscription.js","sourceRoot":"","sources":["../../src/models/postboy-subscription.ts"],"names":[],"mappings":";;;AAEA;;;;;;GAMG;AACH,MAAa,mBAAmB;IAG9B;;;;;OAKG;IACH,YACU,YAAwB,EAChC,IAAuC;QAD/B,iBAAY,GAAZ,YAAY,CAAY;QAGhC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACI,GAAG;QACR,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,IAAO;QACjB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,MAAM;QACX,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;IAC/B,CAAC;CACF;AA3CD,kDA2CC"}

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

@@ -1,4 +1,7 @@
+import { PostboyMessageMetadata } from './postboy-message-metadata';
 export declare abstract class PostboyMessage {
+    metadata: PostboyMessageMetadata;
     get id(): string;
+    setMetadata(metadata: Partial<PostboyMessageMetadata>): this;
 }
 //# sourceMappingURL=postboy.message.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"postboy.message.d.ts","sourceRoot":"","sources":["../../src/models/postboy.message.ts"],"names":[],"mappings":"AAAA,8BAAsB,cAAc;IAClC,IAAW,EAAE,IAAI,MAAM,CAEtB;CACF"}
+{"version":3,"file":"postboy.message.d.ts","sourceRoot":"","sources":["../../src/models/postboy.message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEpE,8BAAsB,cAAc;IAC3B,QAAQ,EAAE,sBAAsB,CAAM;IAC7C,IAAW,EAAE,IAAI,MAAM,CAEtB;IAED,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAAG,IAAI;CAI7D"}

package/lib/models/postboy.message.js

@@ -2,9 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PostboyMessage = void 0;
 class PostboyMessage {
+    constructor() {
+        this.metadata = {};
+    }
     get id() {
         return this.constructor.ID;
     }
+    setMetadata(metadata) {
+        this.metadata = { ...this.metadata, ...metadata };
+        return this;
+    }
 }
 exports.PostboyMessage = PostboyMessage;
 //# sourceMappingURL=postboy.message.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"postboy.message.js","sourceRoot":"","sources":["../../src/models/postboy.message.ts"],"names":[],"mappings":";;;AAAA,MAAsB,cAAc;IAClC,IAAW,EAAE;QACX,OAAQ,IAAI,CAAC,WAAmB,CAAC,EAAE,CAAC;IACtC,CAAC;CACF;AAJD,wCAIC"}
+{"version":3,"file":"postboy.message.js","sourceRoot":"","sources":["../../src/models/postboy.message.ts"],"names":[],"mappings":";;;AAEA,MAAsB,cAAc;IAApC;QACS,aAAQ,GAA2B,EAAE,CAAC;IAS/C,CAAC;IARC,IAAW,EAAE;QACX,OAAQ,IAAI,CAAC,WAAmB,CAAC,EAAE,CAAC;IACtC,CAAC;IAED,WAAW,CAAC,QAAyC;QACnD,IAAI,CAAC,QAAQ,GAAG,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAAC;QAClD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAVD,wCAUC"}

package/lib/models/postboy.settings.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Represents configurable settings for the Postboy system.
+ */
+export declare class PostboySettings {
+    metadata: boolean;
+    /**
+     * Constructs an instance of the class with optional settings.
+     *
+     * @param {Partial<PostboySettings>} [settings] - Optional settings to configure the instance. Can include partial metadata or other configurations.
+     */
+    constructor(settings?: Partial<PostboySettings>);
+}
+//# sourceMappingURL=postboy.settings.d.ts.map

package/lib/models/postboy.settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postboy.settings.d.ts","sourceRoot":"","sources":["../../src/models/postboy.settings.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,eAAe;IACnB,QAAQ,EAAE,OAAO,CAAS;IAEjC;;;;OAIG;gBACS,QAAQ,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC;CAGhD"}