@bsb/base 9.0.0

package/lib/plugins/events-default/events/emit.d.ts

@@ -0,0 +1,38 @@
+/**
+ * BSB (Better-Service-Base) is an event-bus based microservice framework.
+ * Copyright (C) 2016 - 2025 BetterCorp (PTY) Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alternatively, you may obtain a commercial license for this program.
+ * The commercial license allows you to use the Program in a closed-source manner,
+ * including the right to create derivative works that are not subject to the terms
+ * of the AGPL.
+ *
+ * To obtain a commercial license, please contact the copyright holders at
+ * https://www.bettercorp.dev. The terms and conditions of the commercial license
+ * will be provided upon request.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import { EventEmitter } from "node:events";
+import { Observable, IPluginLogging } from "../../../index";
+export declare class emit extends EventEmitter {
+    private _lastReceivedMessageIds;
+    private set lastReceivedMessageIds(value);
+    constructor(_log: IPluginLogging);
+    dispose(): void;
+    onEvent(obs: Observable, pluginName: string, event: string, listener: {
+        (obs: Observable, args: Array<any>): Promise<void>;
+    }): Promise<void>;
+    emitEvent(obs: Observable, pluginName: string, event: string, args: Array<any>): Promise<void>;
+}

package/lib/plugins/events-default/events/emit.js

@@ -0,0 +1,104 @@
+"use strict";
+/**
+ * BSB (Better-Service-Base) is an event-bus based microservice framework.
+ * Copyright (C) 2016 - 2025 BetterCorp (PTY) Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alternatively, you may obtain a commercial license for this program.
+ * The commercial license allows you to use the Program in a closed-source manner,
+ * including the right to create derivative works that are not subject to the terms
+ * of the AGPL.
+ *
+ * To obtain a commercial license, please contact the copyright holders at
+ * https://www.bettercorp.dev. The terms and conditions of the commercial license
+ * will be provided upon request.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emit = void 0;
+const node_events_1 = require("node:events");
+const node_crypto_1 = require("node:crypto");
+class emit extends node_events_1.EventEmitter {
+    _lastReceivedMessageIds = [];
+    set lastReceivedMessageIds(value) {
+        // remove after 50 messages
+        if (this._lastReceivedMessageIds.length > 50) {
+            this._lastReceivedMessageIds.shift();
+        }
+        this._lastReceivedMessageIds.push(value);
+    }
+    constructor(_log) {
+        super();
+    }
+    dispose() {
+        this.removeAllListeners();
+    }
+    async onEvent(obs, pluginName, event, listener) {
+        obs.log.debug("onEvent: listening to {pluginName}-{event}", {
+            pluginName,
+            event,
+        });
+        this.on(`${pluginName}-${event}`, async (eobs, args) => {
+            if (this._lastReceivedMessageIds.includes(args.msgID)) {
+                return;
+            }
+            this.lastReceivedMessageIds = args.msgID;
+            // Create child observable for receiving the event
+            const receiveObs = eobs.startSpan("onEvent:receive", {
+                pluginName,
+                event,
+                messageId: args.msgID
+            });
+            try {
+                await listener(receiveObs, args.data);
+            }
+            catch (error) {
+                const errorObj = error instanceof Error ? error : new Error(error?.message || String(error));
+                receiveObs.error(errorObj);
+                throw error;
+            }
+            finally {
+                receiveObs.end();
+            }
+        });
+    }
+    async emitEvent(obs, pluginName, event, args) {
+        const msgID = (0, node_crypto_1.randomUUID)();
+        // Create child observable for sending the event
+        const sendObs = obs.startSpan("emitEvent:send", {
+            pluginName,
+            event,
+            messageId: msgID
+        });
+        try {
+            sendObs.log.debug("emitEvent: emitting {pluginName}-{event}", {
+                pluginName, event,
+            });
+            this.emit(`${pluginName}-${event}`, sendObs, {
+                msgID,
+                data: args,
+            });
+        }
+        catch (error) {
+            const errorObj = error instanceof Error ? error : new Error(error?.message || String(error));
+            sendObs.error(errorObj);
+            throw error;
+        }
+        finally {
+            sendObs.end();
+        }
+    }
+}
+exports.emit = emit;
+//# sourceMappingURL=emit.js.map

package/lib/plugins/events-default/events/emit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emit.js","sourceRoot":"","sources":["../../../../src/plugins/events-default/events/emit.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AAEH,6CAA2C;AAE3C,6CAAyC;AAEzC,MAAa,IACX,SAAQ,0BAAY;IACZ,uBAAuB,GAAkB,EAAE,CAAC;IACpD,IAAY,sBAAsB,CAAC,KAAa;QAC9C,2BAA2B;QAC3B,IAAI,IAAI,CAAC,uBAAuB,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YAC7C,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,YAAY,IAAoB;QAC9B,KAAK,EAAE,CAAC;IACV,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,OAAO,CAClB,GAAe,EACf,UAAkB,EAClB,KAAa,EACb,QAAgE;QAEhE,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,4CAA4C,EAAE;YAC1D,UAAU;YACV,KAAK;SACN,CAAC,CAAC;QACH,IAAI,CAAC,EAAE,CAAC,GAAI,UAAW,IAAK,KAAM,EAAE,EAAE,KAAK,EAAE,IAAgB,EAAE,IAAS,EAAE,EAAE;YAC1E,IAAI,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtD,OAAO;YACT,CAAC;YACD,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,KAAK,CAAC;YAEzC,kDAAkD;YAClD,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE;gBACnD,UAAU;gBACV,KAAK;gBACL,SAAS,EAAE,IAAI,CAAC,KAAK;aACtB,CAAC,CAAC;YAEH,IAAI,CAAC;gBACH,MAAM,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACxC,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,MAAM,QAAQ,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC7F,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAC3B,MAAM,KAAK,CAAC;YACd,CAAC;oBAAS,CAAC;gBACT,UAAU,CAAC,GAAG,EAAE,CAAC;YACnB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,SAAS,CACpB,GAAe,EACf,UAAkB,EAClB,KAAa,EACb,IAAgB;QAEhB,MAAM,KAAK,GAAG,IAAA,wBAAU,GAAE,CAAC;QAE3B,gDAAgD;QAChD,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,gBAAgB,EAAE;YAC9C,UAAU;YACV,KAAK;YACL,SAAS,EAAE,KAAK;SACjB,CAAC,CAAC;QAEH,IAAI,CAAC;YACH,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,0CAA0C,EAAE;gBAC5D,UAAU,EAAE,KAAK;aAClB,CAAC,CAAC;YAEH,IAAI,CAAC,IAAI,CAAC,GAAI,UAAW,IAAK,KAAM,EAAE,EAAE,OAAO,EAAE;gBAC/C,KAAK;gBACL,IAAI,EAAE,IAAI;aACX,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,QAAQ,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7F,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACxB,MAAM,KAAK,CAAC;QACd,CAAC;gBAAS,CAAC;YACT,OAAO,CAAC,GAAG,EAAE,CAAC;QAChB,CAAC;IACH,CAAC;CACF;AAtFD,oBAsFC"}

package/lib/plugins/events-default/events/emitAndReturn.d.ts

@@ -0,0 +1,36 @@
+/**
+ * BSB (Better-Service-Base) is an event-bus based microservice framework.
+ * Copyright (C) 2016 - 2025 BetterCorp (PTY) Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alternatively, you may obtain a commercial license for this program.
+ * The commercial license allows you to use the Program in a closed-source manner,
+ * including the right to create derivative works that are not subject to the terms
+ * of the AGPL.
+ *
+ * To obtain a commercial license, please contact the copyright holders at
+ * https://www.bettercorp.dev. The terms and conditions of the commercial license
+ * will be provided upon request.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import { EventEmitter } from "node:events";
+import { Observable, IPluginLogging } from "../../../index";
+export declare class emitAndReturn extends EventEmitter {
+    constructor(_log: IPluginLogging);
+    dispose(): void;
+    onReturnableEvent(obs: Observable, pluginName: string, event: string, listener: {
+        (obs: Observable, args: Array<any>): Promise<any>;
+    }): Promise<void>;
+    emitEventAndReturn(obs: Observable, pluginName: string, event: string, timeoutSeconds: number, args: Array<any>): Promise<any>;
+}

package/lib/plugins/events-default/events/emitAndReturn.js

@@ -0,0 +1,100 @@
+"use strict";
+/**
+ * BSB (Better-Service-Base) is an event-bus based microservice framework.
+ * Copyright (C) 2016 - 2025 BetterCorp (PTY) Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alternatively, you may obtain a commercial license for this program.
+ * The commercial license allows you to use the Program in a closed-source manner,
+ * including the right to create derivative works that are not subject to the terms
+ * of the AGPL.
+ *
+ * To obtain a commercial license, please contact the copyright holders at
+ * https://www.bettercorp.dev. The terms and conditions of the commercial license
+ * will be provided upon request.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emitAndReturn = void 0;
+const node_events_1 = require("node:events");
+const index_1 = require("../../../index");
+class emitAndReturn extends node_events_1.EventEmitter {
+    constructor(_log) {
+        super();
+    }
+    dispose() {
+        this.removeAllListeners();
+    }
+    async onReturnableEvent(obs, pluginName, event, listener) {
+        obs.log.debug("onReturnableEvent: listening to {pluginName}-{event}", {
+            pluginName,
+            event,
+        });
+        this.on(`${pluginName}-${event}`, async (eobs, resolve, reject, data) => {
+            // Create child observable for receiving and handling the returnable event
+            const receiveObs = eobs.startSpan("onReturnableEvent:receive", {
+                pluginName,
+                event,
+            });
+            try {
+                const result = await listener(receiveObs, data);
+                resolve(result);
+            }
+            catch (error) {
+                const errorObj = error instanceof Error ? error : new Error(error?.message || String(error));
+                receiveObs.error(errorObj);
+                reject(error);
+            }
+            finally {
+                receiveObs.end();
+            }
+        });
+    }
+    async emitEventAndReturn(obs, pluginName, event, timeoutSeconds, args) {
+        // Create child observable for sending the returnable event
+        const sendObs = obs.startSpan("emitEventAndReturn:send", {
+            pluginName,
+            event,
+            timeoutSeconds
+        });
+        sendObs.log.debug("emitReturnableEvent: emitting {pluginName}-{event}", {
+            pluginName, event,
+        });
+        const self = this;
+        return new Promise((resolve, reject) => {
+            const timeoutHandler = setTimeout(() => {
+                const timeoutError = new index_1.BSBError(sendObs.trace, "Timeout: {pluginName}-{event}", {
+                    pluginName,
+                    event,
+                });
+                sendObs.error(timeoutError);
+                sendObs.end();
+                reject(timeoutError);
+            }, timeoutSeconds * 1000);
+            self.emit(`${pluginName}-${event}`, sendObs, (result) => {
+                clearTimeout(timeoutHandler);
+                resolve(result);
+                sendObs.end();
+            }, (error) => {
+                clearTimeout(timeoutHandler);
+                const errorObj = error instanceof Error ? error : new Error(error?.message || String(error));
+                sendObs.error(errorObj);
+                reject(error);
+                sendObs.end();
+            }, args);
+        });
+    }
+}
+exports.emitAndReturn = emitAndReturn;
+//# sourceMappingURL=emitAndReturn.js.map

package/lib/plugins/events-default/events/emitAndReturn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emitAndReturn.js","sourceRoot":"","sources":["../../../../src/plugins/events-default/events/emitAndReturn.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AAEH,6CAA2C;AAC3C,0CAAsE;AAEtE,MAAa,aACX,SAAQ,0BAAY;IACpB,YAAY,IAAoB;QAC9B,KAAK,EAAE,CAAC;IACV,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAC5B,GAAe,EACf,UAAkB,EAClB,KAAa,EACb,QAA+D;QAE/D,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,sDAAsD,EAAE;YACpE,UAAU;YACV,KAAK;SACN,CAAC,CAAC;QACH,IAAI,CAAC,EAAE,CAAC,GAAI,UAAW,IAAK,KAAM,EAAE,EAAE,KAAK,EAAE,IAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;YACtF,0EAA0E;YAC1E,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,2BAA2B,EAAE;gBAC7D,UAAU;gBACV,KAAK;aACN,CAAC,CAAC;YAEH,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;gBAChD,OAAO,CAAC,MAAM,CAAC,CAAC;YAClB,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,MAAM,QAAQ,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC7F,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC;oBAAS,CAAC;gBACT,UAAU,CAAC,GAAG,EAAE,CAAC;YACnB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAC7B,GAAe,EACf,UAAkB,EAClB,KAAa,EACb,cAAsB,EACtB,IAAgB;QAEhB,2DAA2D;QAC3D,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,yBAAyB,EAAE;YACvD,UAAU;YACV,KAAK;YACL,cAAc;SACf,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,oDAAoD,EAAE;YACtE,UAAU,EAAE,KAAK;SAClB,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,IAAI,CAAC;QAClB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,EAAE;gBACrC,MAAM,YAAY,GAAG,IAAI,gBAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,+BAA+B,EAAE;oBAChF,UAAU;oBACV,KAAK;iBACN,CAAC,CAAC;gBACH,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBAC5B,OAAO,CAAC,GAAG,EAAE,CAAC;gBACd,MAAM,CAAC,YAAY,CAAC,CAAC;YACvB,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC,CAAC;YAE1B,IAAI,CAAC,IAAI,CACP,GAAI,UAAW,IAAK,KAAM,EAAE,EAC5B,OAAO,EACP,CAAC,MAAW,EAAE,EAAE;gBACd,YAAY,CAAC,cAAc,CAAC,CAAC;gBAC7B,OAAO,CAAC,MAAM,CAAC,CAAC;gBAChB,OAAO,CAAC,GAAG,EAAE,CAAC;YAChB,CAAC,EACD,CAAC,KAAU,EAAE,EAAE;gBACb,YAAY,CAAC,cAAc,CAAC,CAAC;gBAC7B,MAAM,QAAQ,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC7F,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBACxB,MAAM,CAAC,KAAK,CAAC,CAAC;gBACd,OAAO,CAAC,GAAG,EAAE,CAAC;YAChB,CAAC,EACD,IAAI,CACL,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAzFD,sCAyFC"}

package/lib/plugins/events-default/events/emitStreamAndReceiveStream.d.ts

@@ -0,0 +1,38 @@
+/**
+ * BSB (Better-Service-Base) is an event-bus based microservice framework.
+ * Copyright (C) 2016 - 2025 BetterCorp (PTY) Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alternatively, you may obtain a commercial license for this program.
+ * The commercial license allows you to use the Program in a closed-source manner,
+ * including the right to create derivative works that are not subject to the terms
+ * of the AGPL.
+ *
+ * To obtain a commercial license, please contact the copyright holders at
+ * https://www.bettercorp.dev. The terms and conditions of the commercial license
+ * will be provided upon request.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import { EventEmitter } from "node:events";
+import { Readable } from "node:stream";
+import { Observable, IPluginLogging } from "../../../index";
+export declare class emitStreamAndReceiveStream extends EventEmitter {
+    private readonly staticCommsTimeout;
+    constructor(_log: IPluginLogging);
+    dispose(): void;
+    receiveStream(obs: Observable, pluginName: string, event: string, listener: {
+        (eobs: Observable, error: Error | null, stream: Readable): Promise<void>;
+    }, timeoutSeconds?: number): Promise<string>;
+    sendStream(obs: Observable, pluginName: string, event: string, streamId: string, stream: Readable): Promise<void>;
+}

package/lib/plugins/events-default/events/emitStreamAndReceiveStream.js

@@ -0,0 +1,134 @@
+"use strict";
+/**
+ * BSB (Better-Service-Base) is an event-bus based microservice framework.
+ * Copyright (C) 2016 - 2025 BetterCorp (PTY) Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alternatively, you may obtain a commercial license for this program.
+ * The commercial license allows you to use the Program in a closed-source manner,
+ * including the right to create derivative works that are not subject to the terms
+ * of the AGPL.
+ *
+ * To obtain a commercial license, please contact the copyright holders at
+ * https://www.bettercorp.dev. The terms and conditions of the commercial license
+ * will be provided upon request.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emitStreamAndReceiveStream = void 0;
+const node_events_1 = require("node:events");
+const node_crypto_1 = require("node:crypto");
+const index_1 = require("../../../index");
+class emitStreamAndReceiveStream extends node_events_1.EventEmitter {
+    // If we try receive or send a stream and the other party is not ready for some reason, we will automatically timeout in 5s.
+    staticCommsTimeout = 1000;
+    constructor(_log) {
+        super();
+    }
+    dispose() {
+        this.removeAllListeners();
+    }
+    async receiveStream(obs, pluginName, event, listener, timeoutSeconds = 60) {
+        // Create child observable for receiving stream
+        const receiveObs = obs.startSpan("receiveStream:receive", {
+            event,
+            pluginName,
+            timeoutSeconds,
+        });
+        const streamId = `${(0, node_crypto_1.randomUUID)()}=${timeoutSeconds}`;
+        receiveObs.log.debug("receiveStream: listening to {streamId} ({pluginName}-{event})", {
+            streamId,
+            pluginName,
+            event,
+        });
+        const self = this;
+        return new Promise((resolve) => {
+            const receiptTimeoutHandler = setTimeout(() => {
+                const timeoutError = new index_1.BSBError(receiveObs.trace, "Receive Receipt Timeout");
+                receiveObs.error(timeoutError);
+                listener(receiveObs, timeoutError, null);
+                self.emit(`${streamId}-error`, receiveObs, timeoutError);
+                self.removeAllListeners(streamId);
+                receiveObs.end();
+            }, self.staticCommsTimeout);
+            self.once(streamId, (eobs, stream) => {
+                clearTimeout(receiptTimeoutHandler);
+                self.emit(`${streamId}-emit`);
+                stream.on("error", (error) => {
+                    const errorObj = error instanceof Error ? error : new Error(error?.message || String(error));
+                    receiveObs.error(errorObj);
+                    self.emit(`${streamId}-error`, errorObj);
+                });
+                stream.on("end", () => {
+                    self.emit(`${streamId}-end`);
+                    receiveObs.end();
+                });
+                listener(receiveObs, null, stream);
+            });
+            resolve(streamId);
+        });
+    }
+    async sendStream(obs, pluginName, event, streamId, stream) {
+        // Create child observable for sending stream
+        const sendObs = obs.startSpan("sendStream:send", {
+            event,
+            pluginName,
+            streamId
+        });
+        sendObs.log.debug("sendStream: emitting {streamId}", { streamId });
+        const self = this;
+        return new Promise((resolve, rejectI) => {
+            const timeout = Number.parseInt(streamId.split("=")[1]);
+            const clearSessions = (e) => {
+                stream.destroy(e);
+                if (receiptTimeoutHandler !== null) {
+                    clearTimeout(receiptTimeoutHandler);
+                }
+                receiptTimeoutHandler = null;
+                clearTimeout(timeoutHandler);
+                self.removeAllListeners(`${streamId}-emit`);
+                self.removeAllListeners(`${streamId}-end`);
+                self.removeAllListeners(`${streamId}-error`);
+                sendObs.end();
+            };
+            const reject = (e) => {
+                clearSessions(e);
+                sendObs.error(e);
+                rejectI(e);
+            };
+            let receiptTimeoutHandler = setTimeout(() => {
+                const timeoutError = new index_1.BSBError(sendObs.trace, "Send Receipt Timeout");
+                reject(timeoutError);
+            }, self.staticCommsTimeout);
+            const timeoutHandler = setTimeout(() => {
+                const timeoutError = new index_1.BSBError(sendObs.trace, "Stream Timeout");
+                reject(timeoutError);
+            }, timeout * 1000);
+            self.once(`${streamId}-emit`, () => {
+                if (receiptTimeoutHandler !== null) {
+                    clearTimeout(receiptTimeoutHandler);
+                }
+                receiptTimeoutHandler = null;
+            });
+            self.once(`${streamId}-end`, () => {
+                clearSessions();
+                resolve();
+            });
+            self.once(`${streamId}-error`, (error) => reject(error));
+            self.emit(streamId, sendObs, stream);
+        });
+    }
+}
+exports.emitStreamAndReceiveStream = emitStreamAndReceiveStream;
+//# sourceMappingURL=emitStreamAndReceiveStream.js.map

package/lib/plugins/events-default/events/emitStreamAndReceiveStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emitStreamAndReceiveStream.js","sourceRoot":"","sources":["../../../../src/plugins/events-default/events/emitStreamAndReceiveStream.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AAEH,6CAA2C;AAE3C,6CAAyC;AACzC,0CAAsE;AAEtE,MAAa,0BACX,SAAQ,0BAAY;IACpB,4HAA4H;IAC3G,kBAAkB,GAAG,IAAI,CAAC;IAE3C,YAAY,IAAoB;QAC9B,KAAK,EAAE,CAAC;IACV,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,GAAe,EACf,UAAkB,EAClB,KAAa,EACb,QAAsF,EACtF,iBAAyB,EAAE;QAE3B,+CAA+C;QAC/C,MAAM,UAAU,GAAG,GAAG,CAAC,SAAS,CAAC,uBAAuB,EAAE;YACxD,KAAK;YACL,UAAU;YACV,cAAc;SACf,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,GAAG,IAAA,wBAAU,GAAE,IAAI,cAAc,EAAE,CAAC;QACrD,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,+DAA+D,EAAE;YACpF,QAAQ;YACR,UAAU;YACV,KAAK;SACN,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,IAAI,CAAC;QAClB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,MAAM,qBAAqB,GAAmB,UAAU,CAAC,GAAG,EAAE;gBAC5D,MAAM,YAAY,GAAG,IAAI,gBAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,yBAAyB,CAAC,CAAC;gBAC/E,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBAC/B,QAAQ,CAAC,UAAU,EAAE,YAAY,EAAE,IAAK,CAAC,CAAC;gBAC1C,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,QAAQ,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;gBACzD,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;gBAClC,UAAU,CAAC,GAAG,EAAE,CAAC;YACnB,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAE5B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAgB,EAAE,MAAgB,EAAQ,EAAE;gBAC/D,YAAY,CAAC,qBAAqB,CAAC,CAAC;gBACpC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,OAAO,CAAC,CAAC;gBAE9B,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAU,EAAE,EAAE;oBAChC,MAAM,QAAQ,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC7F,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;oBAC3B,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,QAAQ,EAAE,QAAQ,CAAC,CAAC;gBAC3C,CAAC,CAAC,CAAC;gBAEH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;oBACpB,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,MAAM,CAAC,CAAC;oBAC7B,UAAU,CAAC,GAAG,EAAE,CAAC;gBACnB,CAAC,CAAC,CAAC;gBAEH,QAAQ,CAAC,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;YAEH,OAAO,CAAC,QAAQ,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,UAAU,CACd,GAAe,EACf,UAAkB,EAClB,KAAa,EACb,QAAgB,EAChB,MAAgB;QAEhB,6CAA6C;QAC7C,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,iBAAiB,EAAE;YAC/C,KAAK;YACL,UAAU;YACV,QAAQ;SACT,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAEnE,MAAM,IAAI,GAAG,IAAI,CAAC;QAClB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;YACtC,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAExD,MAAM,aAAa,GAAG,CAAC,CAAS,EAAE,EAAE;gBAClC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBAClB,IAAI,qBAAqB,KAAK,IAAI,EAAE,CAAC;oBACnC,YAAY,CAAC,qBAAqB,CAAC,CAAC;gBACtC,CAAC;gBACD,qBAAqB,GAAG,IAAI,CAAC;gBAC7B,YAAY,CAAC,cAAc,CAAC,CAAC;gBAC7B,IAAI,CAAC,kBAAkB,CAAC,GAAG,QAAQ,OAAO,CAAC,CAAC;gBAC5C,IAAI,CAAC,kBAAkB,CAAC,GAAG,QAAQ,MAAM,CAAC,CAAC;gBAC3C,IAAI,CAAC,kBAAkB,CAAC,GAAG,QAAQ,QAAQ,CAAC,CAAC;gBAC7C,OAAO,CAAC,GAAG,EAAE,CAAC;YAChB,CAAC,CAAC;YAEF,MAAM,MAAM,GAAG,CAAC,CAAQ,EAAE,EAAE;gBAC1B,aAAa,CAAC,CAAC,CAAC,CAAC;gBACjB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjB,OAAO,CAAC,CAAC,CAAC,CAAC;YACb,CAAC,CAAC;YAEF,IAAI,qBAAqB,GAA0B,UAAU,CAAC,GAAG,EAAE;gBACjE,MAAM,YAAY,GAAG,IAAI,gBAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,sBAAsB,CAAC,CAAC;gBACzE,MAAM,CAAC,YAAY,CAAC,CAAC;YACvB,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAE5B,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,EAAE;gBACrC,MAAM,YAAY,GAAG,IAAI,gBAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;gBACnE,MAAM,CAAC,YAAY,CAAC,CAAC;YACvB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC,CAAC;YAEnB,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,OAAO,EAAE,GAAG,EAAE;gBACjC,IAAI,qBAAqB,KAAK,IAAI,EAAE,CAAC;oBACnC,YAAY,CAAC,qBAAqB,CAAC,CAAC;gBACtC,CAAC;gBACD,qBAAqB,GAAG,IAAI,CAAC;YAC/B,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,MAAM,EAAE,GAAG,EAAE;gBAChC,aAAa,EAAE,CAAC;gBAChB,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,QAAQ,EAAE,CAAC,KAAY,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAEhE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AArID,gEAqIC"}

package/lib/plugins/events-default/events/index.d.ts

@@ -0,0 +1,30 @@
+/**
+ * BSB (Better-Service-Base) is an event-bus based microservice framework.
+ * Copyright (C) 2016 - 2025 BetterCorp (PTY) Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alternatively, you may obtain a commercial license for this program.
+ * The commercial license allows you to use the Program in a closed-source manner,
+ * including the right to create derivative works that are not subject to the terms
+ * of the AGPL.
+ *
+ * To obtain a commercial license, please contact the copyright holders at
+ * https://www.bettercorp.dev. The terms and conditions of the commercial license
+ * will be provided upon request.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+export { emit } from "./emit";
+export { emitAndReturn } from "./emitAndReturn";
+export { emitStreamAndReceiveStream } from "./emitStreamAndReceiveStream";
+export { broadcast } from "./broadcast";

package/lib/plugins/events-default/events/index.js

@@ -0,0 +1,38 @@
+"use strict";
+/**
+ * BSB (Better-Service-Base) is an event-bus based microservice framework.
+ * Copyright (C) 2016 - 2025 BetterCorp (PTY) Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alternatively, you may obtain a commercial license for this program.
+ * The commercial license allows you to use the Program in a closed-source manner,
+ * including the right to create derivative works that are not subject to the terms
+ * of the AGPL.
+ *
+ * To obtain a commercial license, please contact the copyright holders at
+ * https://www.bettercorp.dev. The terms and conditions of the commercial license
+ * will be provided upon request.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.broadcast = exports.emitStreamAndReceiveStream = exports.emitAndReturn = exports.emit = void 0;
+var emit_1 = require("./emit");
+Object.defineProperty(exports, "emit", { enumerable: true, get: function () { return emit_1.emit; } });
+var emitAndReturn_1 = require("./emitAndReturn");
+Object.defineProperty(exports, "emitAndReturn", { enumerable: true, get: function () { return emitAndReturn_1.emitAndReturn; } });
+var emitStreamAndReceiveStream_1 = require("./emitStreamAndReceiveStream");
+Object.defineProperty(exports, "emitStreamAndReceiveStream", { enumerable: true, get: function () { return emitStreamAndReceiveStream_1.emitStreamAndReceiveStream; } });
+var broadcast_1 = require("./broadcast");
+Object.defineProperty(exports, "broadcast", { enumerable: true, get: function () { return broadcast_1.broadcast; } });
+//# sourceMappingURL=index.js.map

package/lib/plugins/events-default/events/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/plugins/events-default/events/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AAEH,+BAA8B;AAArB,4FAAA,IAAI,OAAA;AACb,iDAAgD;AAAvC,8GAAA,aAAa,OAAA;AACtB,2EAA0E;AAAjE,wIAAA,0BAA0B,OAAA;AACnC,yCAAwC;AAA/B,sGAAA,SAAS,OAAA"}

package/lib/plugins/events-default/index.d.ts

@@ -0,0 +1,57 @@
+/**
+ * BSB (Better-Service-Base) is an event-bus based microservice framework.
+ * Copyright (C) 2016 - 2025 BetterCorp (PTY) Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alternatively, you may obtain a commercial license for this program.
+ * The commercial license allows you to use the Program in a closed-source manner,
+ * including the right to create derivative works that are not subject to the terms
+ * of the AGPL.
+ *
+ * To obtain a commercial license, please contact the copyright holders at
+ * https://www.bettercorp.dev. The terms and conditions of the commercial license
+ * will be provided upon request.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import { Readable } from "node:stream";
+import { emit, broadcast, emitAndReturn, emitStreamAndReceiveStream } from "../../plugins/events-default/events/index";
+import { Observable } from "../../index";
+import { BSBEvents, BSBEventsConstructor } from "../../base/BSBEvents";
+export declare const Config: import("../../index").BSBPluginConfigClass<undefined>;
+export declare class Plugin extends BSBEvents<InstanceType<typeof Config>> {
+    static Config: import("../../index").BSBPluginConfigClass<undefined>;
+    init?(): void;
+    protected broadcast: broadcast;
+    protected emit: emit;
+    protected ear: emitAndReturn;
+    protected eas: emitStreamAndReceiveStream;
+    constructor(config: BSBEventsConstructor<InstanceType<typeof Config>>);
+    dispose(): void;
+    onBroadcast(obs: Observable, pluginName: string, event: string, listener: {
+        (obs: Observable, args: Array<any>): Promise<void>;
+    }): Promise<void>;
+    emitBroadcast(obs: Observable, pluginName: string, event: string, args: Array<any>): Promise<void>;
+    onEvent(obs: Observable, pluginName: string, event: string, listener: {
+        (obs: Observable, args: Array<any>): Promise<void>;
+    }): Promise<void>;
+    emitEvent(obs: Observable, pluginName: string, event: string, args: Array<any>): Promise<void>;
+    onReturnableEvent(obs: Observable, pluginName: string, event: string, listener: {
+        (obs: Observable, args: Array<any>): Promise<any>;
+    }): Promise<void>;
+    emitEventAndReturn(obs: Observable, pluginName: string, event: string, timeoutSeconds: number, args: Array<any>): Promise<any>;
+    receiveStream(obs: Observable, pluginName: string, event: string, listener: {
+        (obs: Observable, error: Error | null, stream: Readable): Promise<void>;
+    }, timeoutSeconds?: number): Promise<string>;
+    sendStream(obs: Observable, pluginName: string, event: string, streamId: string, stream: Readable): Promise<void>;
+}