matterbridge 3.4.7 → 3.5.0-dev-20260113-96c82db

package/CHANGELOG.md

@@ -28,6 +28,16 @@ Advantages:
 - individual plugin isolation in childbridge mode;
 - ability to update the plugin in childbridge mode without restarting matterbridge;
 
+## [3.5.0] - Dev branch
+
+### Added
+
+### Changed
+
+- [package]: Updated dependencies.
+
+<a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
+
 ## [3.4.7] - 2026-01-12
 
 ### Added

package/dist/broadcastServer.d.ts

@@ -1,35 +1,9 @@
-/**
- * This file contains the BroadcastServer class.
- *
- * @file broadcastServer.ts
- * @author Luca Liguori
- * @created 2025-10-05
- * @version 2.0.1
- * @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, WorkerMessageRequest, WorkerMessageRequestAny, WorkerMessageResponse, WorkerMessageResponseSuccess, WorkerMessageTypes, 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;
@@ -38,107 +12,18 @@ export declare class BroadcastServer extends EventEmitter<BroadcastServerEvents>
     private closed;
     private readonly debug;
     private readonly verbose;
-    /**
-     * 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;
-    /**
-     * Handles incoming broadcast messages.
-     *
-     * @param {MessageEvent} event - The message event containing the broadcast message.
-     * @returns {void}
-     */
     private broadcastMessageHandler;
-    /**
-     * Handles incoming broadcast error messages.
-     *
-     * @param {MessageEvent} event - The message event containing the broadcast message.
-     * @returns {void}
-     */
     private broadcastMessageErrorHandler;
-    /**
-     * Generate a pseudo-random identifier between 100,000,000 and 999,999,999.
-     *
-     * @returns {number} A nine-digit identifier.
-     */
     getUniqueId(): number;
-    /**
-     * Type guard to verify a value matches the WorkerMessageRequest structure.
-     *
-     * @param {unknown} value Value to test.
-     * @returns {value is WorkerMessageRequest} True when the value looks like a request message.
-     */
     isWorkerRequest(value: unknown): value is WorkerMessageRequest;
-    /**
-     * Type guard to verify a value matches a specific WorkerMessageRequest structure.
-     *
-     * @param {unknown} value Value to test.
-     * @param {K} type Worker message type to match.
-     * @returns {value is WorkerMessageRequest<K>} True when the value looks like a request message of the requested type.
-     */
     isWorkerRequestOfType<K extends keyof WorkerMessageTypes>(value: unknown, type: K): value is WorkerMessageRequest<K>;
-    /**
-     * Type guard to verify a value matches the WorkerMessageResponse structure.
-     *
-     * @param {unknown} value Value to test.
-     * @returns {value is WorkerMessageResponse} True when the value looks like a response message.
-     */
     isWorkerResponse(value: unknown): value is WorkerMessageResponse;
-    /**
-     * Type guard to verify a value matches a specific WorkerMessageResponse structure.
-     *
-     * @param {unknown} value Value to test.
-     * @param {K} type Worker message type to match.
-     * @returns {value is WorkerMessageResponse<K>} True when the value looks like a response message of the requested type.
-     */
     isWorkerResponseOfType<K extends keyof WorkerMessageTypes>(value: unknown, type: K): value is WorkerMessageResponse<K>;
-    /**
-     * Broadcast a message to all workers.
-     *
-     * @param {WorkerMessage} message - The message to broadcast.
-     * @returns {void}
-     *
-     * @remarks No checks are performed on the message structure.
-     */
     broadcast(message: WorkerMessage): void;
-    /**
-     * Send a request message from the worker implementation.
-     *
-     * @template K
-     * @param {WorkerMessageRequest<K>} message The request message to send.
-     * @returns {void}
-     */
     request<K extends keyof WorkerMessageTypes>(message: WorkerMessageRequest<K>): void;
-    /**
-     * Send a response message from the worker implementation.
-     * It also calculates the elapsed time since the request was sent and swaps the source and destination fields.
-     *
-     * @template K
-     * @param {WorkerMessageResponse<K>} message The response message to send.
-     * @returns {void}
-     */
     respond<K extends keyof WorkerMessageTypes>(message: WorkerMessageResponse<K>): void;
-    /**
-     * Fetch data from a worker.
-     * It broadcasts a request message and waits for a valid response with the same id.
-     *
-     * @template K
-     * @param {WorkerMessageRequest<K>} message - The typed request message to fetch.
-     * @param {number} timeout - The timeout in milliseconds to wait for a response. Default is 250ms.
-     * @returns {Promise<WorkerMessageResponseSuccess<K>>} A promise that resolves with the successful response from the worker or rejects on timeout.
-     * @throws {Error} If the fetch operation times out after 250ms or if an error response is received or if the response is malformed.
-     */
     fetch<T extends WorkerMessageRequestAny, K extends Extract<keyof WorkerMessageTypes, T['type']>>(message: T, timeout?: number): Promise<WorkerMessageResponseSuccess<K>>;
 }
 export {};
-//# sourceMappingURL=broadcastServer.d.ts.map

package/dist/broadcastServer.js

@@ -1,27 +1,3 @@
-/**
- * This file contains the BroadcastServer class.
- *
- * @file broadcastServer.ts
- * @author Luca Liguori
- * @created 2025-10-05
- * @version 2.0.1
- * @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';
@@ -29,9 +5,6 @@ import { BroadcastChannel } from 'node:worker_threads';
 import { CYAN, db, debugStringify, er } from 'node-ansi-logger';
 import { hasParameter } from './utils/commandLine.js';
 import { logError } from './utils/error.js';
-/**
- * BroadcastServer class to handle broadcast messages between workers with BroadcastChannel.
- */
 export class BroadcastServer extends EventEmitter {
     name;
     log;
@@ -40,40 +13,21 @@ export class BroadcastServer extends EventEmitter {
     closed = false;
     debug = hasParameter('debug') || hasParameter('verbose');
     verbose = hasParameter('verbose');
-    /**
-     * 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;
         this.log = log;
         this.channel = channel;
         this.broadcastChannel = new BroadcastChannel(this.channel);
-        // this.broadcastChannel.unref();
         this.broadcastChannel.onmessage = this.broadcastMessageHandler.bind(this);
         this.broadcastChannel.onmessageerror = this.broadcastMessageErrorHandler.bind(this);
     }
-    /**
-     * Closes the broadcast channel.
-     *
-     * @returns {void}
-     */
     close() {
         this.broadcastChannel.onmessage = null;
         this.broadcastChannel.onmessageerror = null;
         this.broadcastChannel.close();
         this.closed = true;
     }
-    /**
-     * Handles incoming broadcast messages.
-     *
-     * @param {MessageEvent} event - The message event containing the broadcast message.
-     * @returns {void}
-     */
     broadcastMessageHandler(event) {
         const msg = event.data;
         if (msg.dst === this.name || msg.dst === 'all') {
@@ -86,30 +40,13 @@ export class BroadcastServer extends EventEmitter {
                 this.log.debug(`Server ${CYAN}${this.name}${db} received unrelated broadcast message: ${debugStringify(msg)}`);
         }
     }
-    /**
-     * Handles incoming broadcast error messages.
-     *
-     * @param {MessageEvent} event - The message event containing the broadcast message.
-     * @returns {void}
-     */
     broadcastMessageErrorHandler(event) {
         const msg = event.data;
         this.log.error(`Server ${CYAN}${this.name}${db} received message error: ${debugStringify(msg)}`);
     }
-    /**
-     * Generate a pseudo-random identifier between 100,000,000 and 999,999,999.
-     *
-     * @returns {number} A nine-digit identifier.
-     */
     getUniqueId() {
         return Math.floor(Math.random() * 900000000) + 100000000;
     }
-    /**
-     * Type guard to verify a value matches the WorkerMessageRequest structure.
-     *
-     * @param {unknown} value Value to test.
-     * @returns {value is WorkerMessageRequest} True when the value looks like a request message.
-     */
     isWorkerRequest(value) {
         if (typeof value !== 'object' || value === null) {
             return false;
@@ -120,22 +57,9 @@ export class BroadcastServer extends EventEmitter {
         }
         return message.result === undefined && message.error === undefined;
     }
-    /**
-     * Type guard to verify a value matches a specific WorkerMessageRequest structure.
-     *
-     * @param {unknown} value Value to test.
-     * @param {K} type Worker message type to match.
-     * @returns {value is WorkerMessageRequest<K>} True when the value looks like a request message of the requested type.
-     */
     isWorkerRequestOfType(value, type) {
         return this.isWorkerRequest(value) && value.type === type;
     }
-    /**
-     * Type guard to verify a value matches the WorkerMessageResponse structure.
-     *
-     * @param {unknown} value Value to test.
-     * @returns {value is WorkerMessageResponse} True when the value looks like a response message.
-     */
     isWorkerResponse(value) {
         if (typeof value !== 'object' || value === null) {
             return false;
@@ -148,24 +72,9 @@ export class BroadcastServer extends EventEmitter {
         const hasResult = message.result !== undefined;
         return hasError !== hasResult;
     }
-    /**
-     * Type guard to verify a value matches a specific WorkerMessageResponse structure.
-     *
-     * @param {unknown} value Value to test.
-     * @param {K} type Worker message type to match.
-     * @returns {value is WorkerMessageResponse<K>} True when the value looks like a response message of the requested type.
-     */
     isWorkerResponseOfType(value, type) {
         return this.isWorkerResponse(value) && value.type === type;
     }
-    /**
-     * Broadcast a message to all workers.
-     *
-     * @param {WorkerMessage} message - The message to broadcast.
-     * @returns {void}
-     *
-     * @remarks No checks are performed on the message structure.
-     */
     broadcast(message) {
         if (this.closed) {
             this.log.error('Broadcast channel is closed');
@@ -187,13 +96,6 @@ export class BroadcastServer extends EventEmitter {
             logError(this.log, `Failed to broadcast message ${debugStringify(message)}${er}`, error);
         }
     }
-    /**
-     * Send a request message from the worker implementation.
-     *
-     * @template K
-     * @param {WorkerMessageRequest<K>} message The request message to send.
-     * @returns {void}
-     */
     request(message) {
         if (this.closed) {
             this.log.error('Broadcast channel is closed');
@@ -219,14 +121,6 @@ export class BroadcastServer extends EventEmitter {
             logError(this.log, `Failed to broadcast request message ${debugStringify(message)}${er}`, error);
         }
     }
-    /**
-     * Send a response message from the worker implementation.
-     * It also calculates the elapsed time since the request was sent and swaps the source and destination fields.
-     *
-     * @template K
-     * @param {WorkerMessageResponse<K>} message The response message to send.
-     * @returns {void}
-     */
     respond(message) {
         if (this.closed) {
             this.log.error('Broadcast channel is closed');
@@ -255,16 +149,6 @@ export class BroadcastServer extends EventEmitter {
             logError(this.log, `Failed to broadcast response message ${debugStringify(message)}${er}`, error);
         }
     }
-    /**
-     * Fetch data from a worker.
-     * It broadcasts a request message and waits for a valid response with the same id.
-     *
-     * @template K
-     * @param {WorkerMessageRequest<K>} message - The typed request message to fetch.
-     * @param {number} timeout - The timeout in milliseconds to wait for a response. Default is 250ms.
-     * @returns {Promise<WorkerMessageResponseSuccess<K>>} A promise that resolves with the successful response from the worker or rejects on timeout.
-     * @throws {Error} If the fetch operation times out after 250ms or if an error response is received or if the response is malformed.
-     */
     async fetch(message, timeout = 250) {
         if (this.closed) {
             return Promise.reject(new Error('Broadcast channel is closed'));
@@ -305,4 +189,3 @@ export class BroadcastServer extends EventEmitter {
         });
     }
 }
-//# sourceMappingURL=broadcastServer.js.map

package/dist/broadcastServerTypes.d.ts

@@ -1,36 +1,10 @@
-/**
- * This file contains the BroadcastServer types.
- *
- * @file broadcastServerTypes.ts
- * @author Luca Liguori
- * @created 2025-10-05
- * @version 2.0.0
- * @license Apache-2.0
- *
- * Copyright 2025, 2026, 2027 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 { LogLevel } from 'node-ansi-logger';
 import { EndpointNumber } from '@matter/types/datatype';
 import { RefreshRequiredChanged, WsMessageBroadcast } from './frontendTypes.js';
 import type { PlatformConfig, PlatformSchema } from './matterbridgePlatform.js';
 import type { ApiMatter, ApiPlugin, BaseDevice, Plugin, StoragePlugin } from './matterbridgeTypes.js';
-/** Types of worker source */
 export type WorkerSrcType = 'manager' | 'matterbridge' | 'plugins' | 'devices' | 'frontend' | 'matter' | 'platform' | 'spawn' | 'updates';
-/** Types of worker destination */
 export type WorkerDstType = 'manager' | 'matterbridge' | 'plugins' | 'devices' | 'frontend' | 'matter' | 'platform' | 'spawn' | 'updates' | 'all';
-/** Normalized message request structure */
 type NormalizeRequest<T> = T extends {
     params: infer P;
 } ? ([P] extends [undefined] ? {
@@ -38,7 +12,6 @@ type NormalizeRequest<T> = T extends {
 } : {
     params: P;
 }) : Record<never, never>;
-/** Message request structure with id, timestamp, src and dst */
 type WorkerMessageRequestMap = {
     [K in keyof WorkerMessageTypes]: {
         type: K;
@@ -48,21 +21,16 @@ type WorkerMessageRequestMap = {
         dst: WorkerDstType;
     } & NormalizeRequest<WorkerMessageTypes[K]['request']>;
 };
-/** Message request structure with id, timestamp, src and dst */
 export type WorkerMessageRequest<K extends keyof WorkerMessageTypes = keyof WorkerMessageTypes> = WorkerMessageRequestMap[K];
-/** Normalized message response success structure that guarantees a successful result */
 type NormalizeResponseSuccess<T> = T & {
     error?: never;
 };
-/** Normalized message response error structure that guarantees an error-only payload */
 type NormalizeResponseError<T> = {
     error: string;
 } & {
     [K in keyof T]?: never;
 };
-/** Normalized message response structure */
 type NormalizeResponse<T> = NormalizeResponseSuccess<T> | NormalizeResponseError<T>;
-/** Message response structure with id, timestamp, elapsed, src and dst */
 type WorkerMessageResponseMap = {
     [K in keyof WorkerMessageTypes]: {
         type: K;
@@ -73,9 +41,7 @@ type WorkerMessageResponseMap = {
         dst: WorkerDstType;
     } & NormalizeResponse<WorkerMessageTypes[K]['response']>;
 };
-/** Message response structure with id, timestamp, elapsed, src and dst */
 export type WorkerMessageResponse<K extends keyof WorkerMessageTypes = keyof WorkerMessageTypes> = WorkerMessageResponseMap[K];
-/** Message response success structure that guarantees a successful result */
 type WorkerMessageResponseSuccessMap = {
     [K in keyof WorkerMessageTypes]: {
         type: K;
@@ -86,9 +52,7 @@ type WorkerMessageResponseSuccessMap = {
         dst: WorkerDstType;
     } & NormalizeResponseSuccess<WorkerMessageTypes[K]['response']>;
 };
-/** Message response success structure that guarantees a successful result */
 export type WorkerMessageResponseSuccess<K extends keyof WorkerMessageTypes = keyof WorkerMessageTypes> = WorkerMessageResponseSuccessMap[K];
-/** Message response error structure */
 type WorkerMessageResponseErrorMap = {
     [K in keyof WorkerMessageTypes]: {
         type: K;
@@ -99,17 +63,11 @@ type WorkerMessageResponseErrorMap = {
         dst: WorkerDstType;
     } & NormalizeResponseError<WorkerMessageTypes[K]['response']>;
 };
-/** Message response error structure */
 export type WorkerMessageResponseError<K extends keyof WorkerMessageTypes = keyof WorkerMessageTypes> = WorkerMessageResponseErrorMap[K];
-/** Convenience alias for any worker request */
 export type WorkerMessageRequestAny = WorkerMessageRequest<keyof WorkerMessageTypes>;
-/** Resolve a successful response type based on the originating request */
 export type WorkerMessageResponseSuccessForRequest<T extends WorkerMessageRequestAny> = WorkerMessageResponseSuccess<Extract<keyof WorkerMessageTypes, T['type']>>;
-/** Resolve an error response type based on the originating request */
 export type WorkerMessageResponseErrorForRequest<T extends WorkerMessageRequestAny> = WorkerMessageResponseError<Extract<keyof WorkerMessageTypes, T['type']>>;
-/** Union type for WorkerMessageRequest and WorkerMessageResponse */
 export type WorkerMessage<K extends keyof WorkerMessageTypes = keyof WorkerMessageTypes> = WorkerMessageRequest<K> | WorkerMessageResponse<K> | WorkerMessageResponseSuccess<K> | WorkerMessageResponseError<K>;
-/** Map of all worker message types with their request and response structures */
 export type WorkerMessageTypes = {
     'jest': {
         request: {
@@ -838,4 +796,3 @@ export type WorkerMessageTypes = {
     };
 };
 export {};
-//# sourceMappingURL=broadcastServerTypes.d.ts.map

package/dist/broadcastServerTypes.js

@@ -1,25 +1 @@
-/**
- * This file contains the BroadcastServer types.
- *
- * @file broadcastServerTypes.ts
- * @author Luca Liguori
- * @created 2025-10-05
- * @version 2.0.0
- * @license Apache-2.0
- *
- * Copyright 2025, 2026, 2027 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.
- */
 export {};
-//# sourceMappingURL=broadcastServerTypes.js.map

package/dist/cli.d.ts

@@ -1,30 +1,6 @@
-/**
- * This file contains the CLI entry point of Matterbridge.
- *
- * @file cli.ts
- * @author Luca Liguori
- * @created 2023-12-29
- * @version 3.0.0
- * @license Apache-2.0
- *
- * Copyright 2023, 2024, 2025 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 type { Matterbridge } from './matterbridge.js';
 import { Tracker } from './utils/tracker.js';
 import { Inspector } from './utils/inspector.js';
 export declare let instance: Matterbridge | undefined;
 export declare const tracker: Tracker;
 export declare const inspector: Inspector;
-//# sourceMappingURL=cli.d.ts.map