@matterbridge/core 3.5.3 → 3.5.4-dev-20260211-c4f9359

package/README.md

@@ -19,4 +19,4 @@
 
 ---
 
-Matterbridge internal package (not intended for direct use).
+[Matterbridge](https://matterbridge.io) internal package (not intended for direct use).

package/dist/cli.d.ts

@@ -1,29 +1,5 @@
-/**
- * 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 { Inspector, Tracker } from '@matterbridge/utils';
 import type { Matterbridge } from './matterbridge.js';
 export declare let instance: Matterbridge | undefined;
 export declare const tracker: Tracker;
 export declare const inspector: Inspector;
-//# sourceMappingURL=cli.d.ts.map

package/dist/cli.js

@@ -1,33 +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.
- */
-/* eslint-disable no-console */
-/* eslint-disable n/no-process-exit */
 if (process.argv.includes('--loader') || process.argv.includes('-loader'))
     console.log('\u001B[32mCli loaded.\u001B[40;0m');
-// AnsiLogger module
 import { AnsiLogger } from 'node-ansi-logger';
-// Cli
 import { formatBytes, formatUptime, hasAnyParameter, hasParameter, Inspector, inspectError, Tracker } from '@matterbridge/utils';
 import { cliEmitter } from './cliEmitter.js';
 export let instance;
@@ -35,10 +8,7 @@ export const tracker = new Tracker('Cli', false, false);
 export const inspector = new Inspector('Cli', false, false);
 if (process.argv.includes('--no-ansi') || process.argv.includes('-no-ansi'))
     process.env.NO_COLOR = '1';
-const log = new AnsiLogger({ logName: 'Cli', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
-/**
- * Starts the CPU and memory tracker.
- */
+const log = new AnsiLogger({ logName: 'Cli', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
 function startCpuMemoryCheck() {
     log.debug(`Cpu memory check starting...`);
     tracker.start();
@@ -51,50 +21,26 @@ function startCpuMemoryCheck() {
     });
     log.debug(`Cpu memory check started`);
 }
-/**
- * Stops the CPU and memory tracker.
- */
 function stopCpuMemoryCheck() {
     log.debug(`Cpu memory check stopping...`);
     tracker.stop();
     tracker.removeAllListeners();
     log.debug(`Cpu memory check stopped`);
 }
-/**
- * Starts the inspector for heap sampling.
- * This function is called when the -inspect parameter is passed.
- */
 async function startInspector() {
     await inspector.start();
 }
-/**
- * Stops the heap sampling and saves the profile.
- * This function is called when the -inspect parameter is passed.
- */
 async function stopInspector() {
     await inspector.stop();
 }
-/**
- * Takes a heap snapshot
- */
 async function takeHeapSnapshot() {
     await inspector.takeHeapSnapshot();
 }
-/**
- * Triggers a manual garbage collection.
- * This function is working only if the node process is started with --expose_gc.
- *
- * @remarks To check the effect of the garbage collection, add also --trace_gc or --trace_gc_verbose.
- */
 function triggerGarbageCollection() {
     inspector.runGarbageCollector();
 }
-/**
- * Registers event handlers for the Matterbridge instance.
- */
 function registerHandlers() {
     log.debug('Registering event handlers...');
-    // istanbul ignore next cause registerHandlers is called only if instance is defined
     if (!instance)
         return;
     instance.on('shutdown', () => shutdown());
@@ -108,9 +54,6 @@ function registerHandlers() {
     instance.on('triggergarbagecollection', () => triggerGarbageCollection());
     log.debug('Registered event handlers');
 }
-/**
- * Shuts down the Matterbridge instance and exits the process.
- */
 async function shutdown() {
     log.debug('Received shutdown event, exiting...');
     if (hasParameter('inspect'))
@@ -119,56 +62,26 @@ async function shutdown() {
     cliEmitter.emit('shutdown');
     process.exit(0);
 }
-/**
- * Restarts the Matterbridge instance.
- */
 async function restart() {
     log.debug('Received restart event, loading...');
     const { Matterbridge } = await import('./matterbridge.js');
     instance = await Matterbridge.loadInstance(true);
     registerHandlers();
 }
-/**
- * Updates the Matterbridge instance.
- */
 async function update() {
     log.debug('Received update event, updating...');
-    // TODO: Implement update logic outside of matterbridge
     const { Matterbridge } = await import('./matterbridge.js');
     instance = await Matterbridge.loadInstance(true);
     registerHandlers();
 }
-/**
- * Starts the CPU and memory check when the -startmemorycheck parameter is passed.
- */
 function start() {
     log.debug('Received start memory check event');
     startCpuMemoryCheck();
 }
-/**
- * Stops the CPU and memory check when the -stopmemorycheck parameter is passed.
- */
 function stop() {
     log.debug('Received stop memory check event');
     stopCpuMemoryCheck();
 }
-/**
- * Main function that initializes the Matterbridge instance and starts the CLI.
- *
- * @remarks
- *
- * Debug parameters:
- *
- * --debug enables debug logging.
- *
- * --verbose enables verbose logging.
- *
- * --loader enables loader logging.
- *
- * --inspect enables the inspector for heap sampling.
- *
- * --snapshotinterval <milliseconds> can be used to set the heap snapshot interval. Default is undefined. Minimum is 30000 ms.
- */
 async function main() {
     log.debug(`Cli main() started`);
     startCpuMemoryCheck();
@@ -178,7 +91,6 @@ async function main() {
     const { Matterbridge } = await import('./matterbridge.js');
     instance = await Matterbridge.loadInstance(true);
     log.debug(`***Matterbridge.loadInstance(true) exited`);
-    // Check if the instance needs to shut down from parseCommandLine()
     if (!instance || instance.shutdown) {
         shutdown();
     }
@@ -196,18 +108,11 @@ main().catch((error) => {
     inspectError(log, 'Matterbridge.loadInstance() failed with error', error);
     shutdown();
 });
-/**
- * Displays the version.
- */
 async function version() {
-    // Dynamic JSON import (Node >= 20) with import attributes
     const { default: pkg } = await import('../package.json', { with: { type: 'json' } });
     console.log(`Matterbridge version ${pkg.version}`);
     process.exit(0);
 }
-/**
- * Displays the help.
- */
 function help() {
     console.log(`
   Usage: matterbridge [options] [command] 
@@ -265,4 +170,3 @@ function help() {
   `);
     process.exit(0);
 }
-//# sourceMappingURL=cli.js.map

package/dist/cliEmitter.d.ts

@@ -1,26 +1,3 @@
-/**
- * This file contains the CLI emitter.
- *
- * @file cliEmitter.ts
- * @author Luca Liguori
- * @created 2025-07-04
- * @version 1.0.2
- * @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 { EventEmitter } from 'node:events';
 interface CliEvents {
     shutdown: [];
@@ -32,19 +9,6 @@ interface CliEvents {
 export declare const cliEmitter: EventEmitter<CliEvents>;
 export declare let lastOsCpuUsage: number;
 export declare let lastProcessCpuUsage: number;
-/**
- * Sets the last os CPU usage.
- *
- * @param {number} val - The os CPU usage percentage to set.
- * @returns {void}
- */
 export declare function setLastOsCpuUsage(val: number): void;
-/**
- * Sets the last process CPU usage.
- *
- * @param {number} val - The process CPU usage percentage to set.
- * @returns {void}
- */
 export declare function setLastProcessCpuUsage(val: number): void;
 export {};
-//# sourceMappingURL=cliEmitter.d.ts.map

package/dist/cliEmitter.js

@@ -1,49 +1,12 @@
-/**
- * This file contains the CLI emitter.
- *
- * @file cliEmitter.ts
- * @author Luca Liguori
- * @created 2025-07-04
- * @version 1.0.2
- * @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.
- */
-// eslint-disable-next-line no-console
 if (process.argv.includes('--loader') || process.argv.includes('-loader'))
     console.log('\u001B[32mCli emitter loaded.\u001B[40;0m');
 import { EventEmitter } from 'node:events';
 export const cliEmitter = new EventEmitter();
 export let lastOsCpuUsage = 0;
 export let lastProcessCpuUsage = 0;
-/**
- * Sets the last os CPU usage.
- *
- * @param {number} val - The os CPU usage percentage to set.
- * @returns {void}
- */
 export function setLastOsCpuUsage(val) {
     lastOsCpuUsage = val;
 }
-/**
- * Sets the last process CPU usage.
- *
- * @param {number} val - The process CPU usage percentage to set.
- * @returns {void}
- */
 export function setLastProcessCpuUsage(val) {
     lastProcessCpuUsage = val;
 }
-//# sourceMappingURL=cliEmitter.js.map

package/dist/cliHistory.d.ts

@@ -1,48 +1,6 @@
-/**
- * This file contains the CLI history page generator.
- *
- * @file cliHistory.ts
- * @author Luca Liguori
- * @created 2025-10-09
- * @version 1.0.1
- * @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 type GenerateHistoryPageOptions = {
-    /**
-     * Full path (file name included) for the generated HTML file.
-     * Defaults to `<current working directory>/history.html`.
-     */
     outputPath?: string;
-    /**
-     * Title shown in the generated page and browser tab.
-     * Defaults to `Matterbridge CPU & Memory History`.
-     */
     pageTitle?: string;
-    /**
-     * Hostname shown in the generated page and browser tab.
-     */
     hostname?: string;
 };
-/**
- * Generates a static HTML dashboard displaying CPU and memory history.
- *
- * @param {GenerateHistoryPageOptions} [options] - Optional configuration for output path, page title, and refresh interval.
- *
- * @returns {string | undefined} The absolute path to the generated HTML file, or undefined if no samples exist.
- */
 export declare function generateHistoryPage(options?: GenerateHistoryPageOptions): string | undefined;
-//# sourceMappingURL=cliHistory.d.ts.map

package/dist/cliHistory.js

@@ -1,40 +1,9 @@
-/**
- * This file contains the CLI history page generator.
- *
- * @file cliHistory.ts
- * @author Luca Liguori
- * @created 2025-10-09
- * @version 1.0.1
- * @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.
- */
-// eslint-disable-next-line no-console
 if (process.argv.includes('--loader') || process.argv.includes('-loader'))
     console.log('\u001B[32mCli history loaded.\u001B[40;0m');
 import { writeFileSync } from 'node:fs';
 import path from 'node:path';
 import os from 'node:os';
 import { Tracker } from '@matterbridge/utils';
-/**
- * Generates a static HTML dashboard displaying CPU and memory history.
- *
- * @param {GenerateHistoryPageOptions} [options] - Optional configuration for output path, page title, and refresh interval.
- *
- * @returns {string | undefined} The absolute path to the generated HTML file, or undefined if no samples exist.
- */
 export function generateHistoryPage(options = {}) {
     const pageTitle = options.pageTitle ?? 'Matterbridge CPU & Memory History';
     const hostname = options.hostname ?? os.hostname();
@@ -814,13 +783,6 @@ export function generateHistoryPage(options = {}) {
     writeFileSync(outputPath, html, { encoding: 'utf-8' });
     return outputPath;
 }
-/**
- * Escapes HTML special characters to prevent breaking embedded markup.
- *
- * @param {string} input - The string to escape.
- * @returns {string} The escaped string safe for HTML contexts.
- */
 function escapeHtml(input) {
     return input.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&#39;');
 }
-//# sourceMappingURL=cliHistory.js.map

package/dist/clusters/export.d.ts

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=export.d.ts.map

package/dist/clusters/export.js

@@ -1,3 +1 @@
 export {};
-// Nothing to export right now, but this file is here to make it easier to add exports in the future
-//# sourceMappingURL=export.js.map

package/dist/deviceManager.d.ts

@@ -1,135 +1,27 @@
-/**
- * This file contains the DeviceManager class.
- *
- * @file devices.ts
- * @author Luca Liguori
- * @created 2024-07-26
- * @version 1.1.2
- * @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 { LogLevel } from 'node-ansi-logger';
 import type { BaseDevice } from '@matterbridge/types';
 import type { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
-/**
- * Converts a MatterbridgeEndpoint to a BaseDevice.
- *
- * @param {MatterbridgeEndpoint} device The MatterbridgeEndpoint to convert.
- * @returns {BaseDevice} The converted BaseDevice.
- */
 export declare function toBaseDevice(device: MatterbridgeEndpoint | BaseDevice): BaseDevice;
-/**
- * Manages Matterbridge devices.
- */
 export declare class DeviceManager {
     private readonly _devices;
     private readonly log;
     private readonly server;
     private readonly debug;
     private readonly verbose;
-    /**
-     * Creates an instance of DeviceManager.
-     */
     constructor();
     destroy(): void;
     private msgHandler;
-    /**
-     * Gets the number of devices.
-     *
-     * @returns {number} The number of devices.
-     */
     get length(): number;
-    /**
-     * Gets the number of devices.
-     *
-     * @returns {number} The number of devices.
-     */
     get size(): number;
-    /**
-     * Checks if a device with the specified unique ID exists.
-     *
-     * @param {string} uniqueId - The unique ID of the device.
-     * @returns {boolean} True if the device exists, false otherwise.
-     */
     has(uniqueId: string): boolean;
-    /**
-     * Gets a device by its unique ID.
-     *
-     * @param {string} uniqueId - The unique ID of the device.
-     * @returns {MatterbridgeEndpoint | undefined} The device, or undefined if not found.
-     */
     get(uniqueId: string): MatterbridgeEndpoint | undefined;
-    /**
-     * Adds a device to the manager.
-     *
-     * @param {MatterbridgeEndpoint} device - The device to add.
-     * @returns {MatterbridgeEndpoint} The added device.
-     * @throws {Error} If the device does not have a unique ID.
-     */
     set(device: MatterbridgeEndpoint): MatterbridgeEndpoint;
-    /**
-     * Removes a device from the manager.
-     *
-     * @param {MatterbridgeEndpoint} device - The device to remove.
-     * @returns {boolean} True if the device was removed, false otherwise.
-     * @throws {Error} If the device does not have a unique ID.
-     */
     remove(device: MatterbridgeEndpoint): boolean;
-    /**
-     * Clears all devices from the manager.
-     */
     clear(): void;
-    /**
-     * Converts a MatterbridgeEndpoint to a BaseDevice.
-     *
-     * @param {MatterbridgeEndpoint} device The MatterbridgeEndpoint to convert.
-     * @returns {BaseDevice} The converted BaseDevice.
-     */
     private toBaseDevice;
-    /**
-     * Gets an array of all devices.
-     *
-     * @returns {MatterbridgeEndpoint[]} An array of all devices.
-     */
     array(): MatterbridgeEndpoint[];
-    /**
-     * Gets a base array of all devices suitable for serialization.
-     *
-     * @param {string} [pluginName] - Optional plugin name to filter devices.
-     * @returns {ApiDevices[]} A base array of all devices.
-     */
     baseArray(pluginName?: string): BaseDevice[];
-    /**
-     * Iterates over all devices.
-     *
-     * @returns {IterableIterator<MatterbridgeEndpoint>} An iterator for the devices.
-     */
     [Symbol.iterator](): MapIterator<MatterbridgeEndpoint>;
-    /**
-     * Asynchronously iterates over each device and calls the provided callback function.
-     *
-     * @param {(device: MatterbridgeEndpoint) => Promise<void>} callback - The callback function to call with each device.
-     * @returns {Promise<void>} A promise that resolves when all callbacks have been called.
-     */
     forEach(callback: (device: MatterbridgeEndpoint) => Promise<void>): Promise<void>;
-    /**
-     * Sets the log level.
-     *
-     * @param {LogLevel} logLevel - The log level to set.
-     */
     set logLevel(logLevel: LogLevel);
 }
-//# sourceMappingURL=deviceManager.d.ts.map