matterbridge 3.3.3-dev-20251018-66ae7a4 → 3.3.3

package/CHANGELOG.md

@@ -23,7 +23,7 @@ Advantages:
 - isolation between threads;
 - individual plugin isolation in childbridge mode;
 
-## [3.3.3] - Not released
+## [3.3.3] - 2025-10-18
 
 ### Added
 

package/dist/broadcastServer.d.ts

@@ -0,0 +1,105 @@
+/**
+ * This file contains the BroadcastServer class.
+ *
+ * @file broadcastServer.ts
+ * @author Luca Liguori
+ * @created 2025-10-05
+ * @version 1.0.0
+ * @license Apache-2.0
+ *
+ * Copyright 2024, 2025, 2026 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { EventEmitter } from 'node:events';
+import { type AnsiLogger } from 'node-ansi-logger';
+import type { WorkerMessage, WorkerMessageType, WorkerRequest, WorkerResponse, WorkerSrcType } from './broadcastServerTypes.js';
+interface BroadcastServerEvents {
+    'broadcast_message': [msg: WorkerMessage];
+}
+/**
+ * BroadcastServer class to handle broadcast messages between workers with BroadcastChannel.
+ */
+export declare class BroadcastServer extends EventEmitter<BroadcastServerEvents> {
+    readonly name: WorkerSrcType;
+    private readonly log;
+    private readonly channel;
+    private readonly broadcastChannel;
+    /**
+     * Creates an instance of BroadcastServer.
+     *
+     * @param {string} name - The name of the broadcast server.
+     * @param {AnsiLogger} log - The logger instance to use for logging.
+     * @param {string} channel - The channel name for the broadcast. Default is 'broadcast-channel'.
+     */
+    constructor(name: WorkerSrcType, log: AnsiLogger, channel?: string);
+    /**
+     * Closes the broadcast channel.
+     *
+     * @returns {void}
+     */
+    close(): void;
+    /**
+     * Generates a unique ID with range 100000-999999.
+     *
+     * @returns {number} - A unique ID between 100000 and 999999
+     */
+    getUniqueId(): number;
+    /**
+     * Type guard to check if a message is a request of a specific type.
+     *
+     * @param {unknown} msg - The message to check.
+     * @param {T} type - The type to check against.
+     * @returns {msg is WorkerRequest<T>} True if the message is a request of the specified type.
+     */
+    isWorkerRequest<T extends WorkerMessageType>(msg: unknown, type: T): msg is WorkerRequest<T>;
+    /**
+     * Type guard to check if a message is a response of a specific type.
+     *
+     * @param {unknown} msg - The message to check.
+     * @param {T} type - The type to check against.
+     * @returns {msg is WorkerResponse<T>} True if the message is a response of the specified type.
+     */
+    isWorkerResponse<T extends WorkerMessageType>(msg: unknown, type: T): msg is WorkerResponse<T>;
+    /**
+     * Handles incoming broadcast messages.
+     *
+     * @param {MessageEvent} event - The message event containing the broadcast message.
+     * @returns {void}
+     */
+    private broadcastMessageHandler;
+    /**
+     * Broadcast a request message to all workers.
+     *
+     * @param {WorkerRequest<T>} message - The typed request message to broadcast.
+     * @returns {void}
+     */
+    request<T extends WorkerMessageType>(message: WorkerRequest<T>): void;
+    /**
+     * Broadcast a response message to all workers.
+     *
+     * @param {WorkerResponse<T>} message - The typed response message to broadcast.
+     * @returns {void}
+     */
+    respond<T extends WorkerMessageType>(message: WorkerResponse<T>): void;
+    /**
+     * Fetch data from a worker.
+     * It broadcasts a request message and waits for a response with the same id.
+     *
+     * @param {WorkerRequest<T>} message - The typed request message to broadcast.
+     * @returns {Promise<WorkerResponse<T>>} A promise that resolves with the response from the worker or rejects on timeout.
+     */
+    fetch<T extends WorkerMessageType>(message: WorkerRequest<T>): Promise<WorkerResponse<T>>;
+}
+export {};
+//# sourceMappingURL=broadcastServer.d.ts.map

package/dist/broadcastServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcastServer.d.ts","sourceRoot":"","sources":["../src/broadcastServer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAKH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG3C,OAAO,EAAE,KAAK,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAEnE,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAEhI,UAAU,qBAAqB;IAC7B,mBAAmB,EAAE,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;CAC3C;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,YAAY,CAAC,qBAAqB,CAAC;IAWpE,QAAQ,CAAC,IAAI,EAAE,aAAa;IAC5B,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAZ1B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAmB;IAEpD;;;;;;OAMG;gBAEQ,IAAI,EAAE,aAAa,EACX,GAAG,EAAE,UAAU,EACf,OAAO,GAAE,MAA4B;IAOxD;;;;OAIG;IACH,KAAK,IAAI,IAAI;IAMb;;;;OAIG;IACH,WAAW,IAAI,MAAM;IAIrB;;;;;;OAMG;IACH,eAAe,CAAC,CAAC,SAAS,iBAAiB,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,GAAG,GAAG,IAAI,aAAa,CAAC,CAAC,CAAC;IAI5F;;;;;;OAMG;IACH,gBAAgB,CAAC,CAAC,SAAS,iBAAiB,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,GAAG,GAAG,IAAI,cAAc,CAAC,CAAC,CAAC;IAI9F;;;;;OAKG;IACH,OAAO,CAAC,uBAAuB;IAM/B;;;;;OAKG;IACH,OAAO,CAAC,CAAC,SAAS,iBAAiB,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI;IAerE;;;;;OAKG;IACH,OAAO,CAAC,CAAC,SAAS,iBAAiB,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI;IAYtE;;;;;;OAMG;IACG,KAAK,CAAC,CAAC,SAAS,iBAAiB,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;CA4BhG"}

package/dist/broadcastServer.js

@@ -1,13 +1,47 @@
+/**
+ * This file contains the BroadcastServer class.
+ *
+ * @file broadcastServer.ts
+ * @author Luca Liguori
+ * @created 2025-10-05
+ * @version 1.0.0
+ * @license Apache-2.0
+ *
+ * Copyright 2024, 2025, 2026 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// eslint-disable-next-line no-console
 if (process.argv.includes('--loader') || process.argv.includes('-loader'))
     console.log('\u001B[32mBroadcastServer loaded.\u001B[40;0m');
 import { EventEmitter } from 'node:events';
 import { BroadcastChannel } from 'node:worker_threads';
 import { debugStringify } from 'node-ansi-logger';
+/**
+ * BroadcastServer class to handle broadcast messages between workers with BroadcastChannel.
+ */
 export class BroadcastServer extends EventEmitter {
     name;
     log;
     channel;
     broadcastChannel;
+    /**
+     * Creates an instance of BroadcastServer.
+     *
+     * @param {string} name - The name of the broadcast server.
+     * @param {AnsiLogger} log - The logger instance to use for logging.
+     * @param {string} channel - The channel name for the broadcast. Default is 'broadcast-channel'.
+     */
     constructor(name, log, channel = 'broadcast-channel') {
         super();
         this.name = name;
@@ -16,24 +50,61 @@ export class BroadcastServer extends EventEmitter {
         this.broadcastChannel = new BroadcastChannel(this.channel);
         this.broadcastChannel.onmessage = this.broadcastMessageHandler.bind(this);
     }
+    /**
+     * Closes the broadcast channel.
+     *
+     * @returns {void}
+     */
     close() {
+        // @ts-expect-error: wrong type definition in node.d.ts
         this.broadcastChannel.onmessage = null;
         this.broadcastChannel.close();
     }
+    /**
+     * Generates a unique ID with range 100000-999999.
+     *
+     * @returns {number} - A unique ID between 100000 and 999999
+     */
     getUniqueId() {
-        return Math.floor(Math.random() * (999999 - 100000 + 1)) + 100000;
+        return Math.floor(Math.random() * (999999 - 100000 + 1)) + 100000; // random int between 100000 and 999999
     }
+    /**
+     * Type guard to check if a message is a request of a specific type.
+     *
+     * @param {unknown} msg - The message to check.
+     * @param {T} type - The type to check against.
+     * @returns {msg is WorkerRequest<T>} True if the message is a request of the specified type.
+     */
     isWorkerRequest(msg, type) {
         return typeof msg === 'object' && msg !== null && 'id' in msg && 'timestamp' in msg && 'type' in msg && msg.type === type && !('response' in msg) && 'src' in msg && 'dst' in msg;
     }
+    /**
+     * Type guard to check if a message is a response of a specific type.
+     *
+     * @param {unknown} msg - The message to check.
+     * @param {T} type - The type to check against.
+     * @returns {msg is WorkerResponse<T>} True if the message is a response of the specified type.
+     */
     isWorkerResponse(msg, type) {
         return typeof msg === 'object' && msg !== null && 'id' in msg && 'timestamp' in msg && 'type' in msg && msg.type === type && 'response' in msg && 'src' in msg && 'dst' in msg;
     }
+    /**
+     * Handles incoming broadcast messages.
+     *
+     * @param {MessageEvent} event - The message event containing the broadcast message.
+     * @returns {void}
+     */
     broadcastMessageHandler(event) {
         const data = event.data;
         this.log.debug(`*Received broadcast message: ${debugStringify(data)}`);
         this.emit('broadcast_message', data);
     }
+    /**
+     * Broadcast a request message to all workers.
+     *
+     * @param {WorkerRequest<T>} message - The typed request message to broadcast.
+     * @returns {void}
+     */
     request(message) {
         if (message.id === undefined) {
             message.id = this.getUniqueId();
@@ -48,6 +119,12 @@ export class BroadcastServer extends EventEmitter {
         this.log.debug(`*Broadcasting message: ${debugStringify(message)}`);
         this.broadcastChannel.postMessage(message);
     }
+    /**
+     * Broadcast a response message to all workers.
+     *
+     * @param {WorkerResponse<T>} message - The typed response message to broadcast.
+     * @returns {void}
+     */
     respond(message) {
         if (message.timestamp === undefined) {
             message.timestamp = Date.now();
@@ -59,6 +136,13 @@ export class BroadcastServer extends EventEmitter {
         this.log.debug(`*Broadcasting message: ${debugStringify(message)}`);
         this.broadcastChannel.postMessage(message);
     }
+    /**
+     * Fetch data from a worker.
+     * It broadcasts a request message and waits for a response with the same id.
+     *
+     * @param {WorkerRequest<T>} message - The typed request message to broadcast.
+     * @returns {Promise<WorkerResponse<T>>} A promise that resolves with the response from the worker or rejects on timeout.
+     */
     async fetch(message) {
         if (message.id === undefined) {
             message.id = this.getUniqueId();
@@ -85,3 +169,4 @@ export class BroadcastServer extends EventEmitter {
         });
     }
 }
+//# sourceMappingURL=broadcastServer.js.map

package/dist/broadcastServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcastServer.js","sourceRoot":"","sources":["../src/broadcastServer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,sCAAsC;AACtC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IAAE,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;AAExI,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,OAAO,EAAmB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAQnE;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,YAAmC;IAW3D;IACQ;IACA;IAZF,gBAAgB,CAAmB;IAEpD;;;;;;OAMG;IACH,YACW,IAAmB,EACX,GAAe,EACf,UAAkB,mBAAmB;QAEtD,KAAK,EAAE,CAAC;QAJC,SAAI,GAAJ,IAAI,CAAe;QACX,QAAG,GAAH,GAAG,CAAY;QACf,YAAO,GAAP,OAAO,CAA8B;QAGtD,IAAI,CAAC,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3D,IAAI,CAAC,gBAAgB,CAAC,SAAS,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,uDAAuD;QACvD,IAAI,CAAC,gBAAgB,CAAC,SAAS,GAAG,IAAI,CAAC;QACvC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,uCAAuC;IAC5G,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CAA8B,GAAY,EAAE,IAAO;QAChE,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,IAAI,IAAI,GAAG,IAAI,WAAW,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,UAAU,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,GAAG,IAAI,KAAK,IAAI,GAAG,CAAC;IACpL,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CAA8B,GAAY,EAAE,IAAO;QACjE,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,IAAI,IAAI,GAAG,IAAI,WAAW,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,UAAU,IAAI,GAAG,IAAI,KAAK,IAAI,GAAG,IAAI,KAAK,IAAI,GAAG,CAAC;IACjL,CAAC;IAED;;;;;OAKG;IACK,uBAAuB,CAAC,KAAmB;QACjD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAqB,CAAC;QACzC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gCAAgC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvE,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAA8B,OAAyB;QAC5D,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAClC,CAAC;QACD,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACpC,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACjD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iDAAiD,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC3F,OAAO;QACT,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAA8B,OAA0B;QAC7D,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACpC,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAClD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kDAAkD,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC5F,OAAO;QACT,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAA8B,OAAyB;QAChE,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAClC,CAAC;QACD,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACpC,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,sBAAsB,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEhE,OAAO,IAAI,OAAO,CAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxD,MAAM,eAAe,GAAG,CAAC,GAAkB,EAAE,EAAE;gBAC7C,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,EAAE,CAAC;oBACtE,YAAY,CAAC,SAAS,CAAC,CAAC;oBACxB,IAAI,CAAC,GAAG,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAAC;oBAC/C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oBAAoB,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAC1D,OAAO,CAAC,GAAG,CAAC,CAAC;gBACf,CAAC;YACH,CAAC,CAAC;YAEF,IAAI,CAAC,EAAE,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAAC;YAC9C,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAEtB,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;gBAChC,IAAI,CAAC,GAAG,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAAC;gBAC/C,MAAM,CAAC,IAAI,KAAK,CAAC,4CAA4C,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC9E,CAAC,EAAE,GAAG,CAAC,CAAC;QACV,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}