matterbridge 3.5.2 → 3.5.3-dev-20260202-e19e9b6

package/dist/spawn.js

@@ -1,69 +1,28 @@
-/**
- * @description This file contains the spawn functions.
- * @file spawn.ts
- * @author Luca Liguori
- * @created 2025-02-16
- * @version 1.2.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 { AnsiLogger } from 'node-ansi-logger';
 import { hasParameter } from '@matterbridge/utils';
 import { BroadcastServer } from './broadcastServer.js';
-/**
- * Spawns a child process with the given command and arguments.
- *
- * @param {string} command - The command to execute.
- * @param {string[]} args - The arguments to pass to the command (default: []).
- * @param {'install' | 'uninstall'} packageCommand - The optional package command being executed (e.g., 'install', 'uninstall').
- * @param {string} [packageName] - The optional name of the package being installed.
- * @returns {Promise<boolean>} A promise that resolves to true if the command executed successfully, false otherwise.
- */
 export async function spawnCommand(command, args, packageCommand, packageName) {
     const { spawn } = await import('node:child_process');
-    /** Broadcast server */
     const debug = hasParameter('debug') || hasParameter('verbose');
     const verbose = hasParameter('verbose');
-    const log = new AnsiLogger({ logName: 'Spawn', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: debug ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
+    const log = new AnsiLogger({ logName: 'Spawn', logTimestampFormat: 4, logLevel: debug ? "debug" : "info" });
     const server = new BroadcastServer('spawn', log);
     const sendLog = (name, message) => {
         try {
             server.request({ type: 'frontend_logmessage', src: 'spawn', dst: 'frontend', params: { level: 'spawn', time: log.now(), name, message } });
         }
         catch (err) {
-            // istanbul ignore next cause it's a precaution
             log.debug(`Failed to send log message to frontend: ${err instanceof Error ? err.message : String(err)}`);
         }
     };
     if (verbose)
         log.debug(`Spawning command: ${command} with ${args.join(' ')} ${packageCommand} ${packageName}`);
-    /*
-     *  npm > npm.cmd on windows
-     *  cmd.exe ['dir'] on windows
-     */
     const cmdLine = command + ' ' + args.join(' ');
     if (process.platform === 'win32' && command === 'npm') {
-        // Must be spawn('cmd.exe', ['/c', 'npm -g install <package>']);
         const argstring = 'npm ' + args.join(' ');
         args.splice(0, args.length, '/c', argstring);
         command = 'cmd.exe';
     }
-    // Decide when using sudo on linux and macOS
-    // When you need sudo: Spawn stderr: npm error Error: EACCES: permission denied
-    // When you don't need sudo: Failed to start child process "npm install -g matterbridge-eve-door": spawn sudo ENOENT
     if (hasParameter('sudo') || (process.platform !== 'win32' && command === 'npm' && !hasParameter('docker') && !hasParameter('nosudo'))) {
         args.unshift(command);
         command = 'sudo';
@@ -119,20 +78,6 @@ export async function spawnCommand(command, args, packageCommand, packageName) {
                     sendLog('Matterbridge:spawn', line);
                 }
             });
-            /*
-            childProcess.stdout.on('close', () => {
-              log.debug(`Spawn output (stdout): closed`);
-              resolve(true);
-            });
-            childProcess.stdout.on('end', () => {
-              log.debug(`Spawn output (stdout): ended`);
-              resolve(true);
-            });
-            childProcess.stdout.on('error', () => {
-              log.debug(`Spawn output (stdout): error`);
-              resolve(true);
-            });
-            */
         }
         if (childProcess.stderr) {
             childProcess.stderr.on('data', (data) => {
@@ -143,23 +88,8 @@ export async function spawnCommand(command, args, packageCommand, packageName) {
                     sendLog('Matterbridge:spawn', line);
                 }
             });
-            /*
-            childProcess.stderr.on('close', () => {
-              log.debug(`Spawn verbose (stderr): closed`);
-              resolve(true);
-            });
-            childProcess.stderr.on('end', () => {
-              log.debug(`Spawn verbose (stderr): ended`);
-              resolve(true);
-            });
-            childProcess.stderr.on('error', () => {
-              log.debug(`Spawn verbose (stderr): error`);
-              resolve(true);
-            });
-            */
         }
     });
     server.close();
     return success;
 }
-//# sourceMappingURL=spawn.js.map

package/dist/storage/export.d.ts

@@ -1,2 +1 @@
 export * from 'node-persist-manager';
-//# sourceMappingURL=export.d.ts.map

package/dist/storage/export.js

@@ -1,2 +1 @@
 export * from 'node-persist-manager';
-//# sourceMappingURL=export.js.map

package/dist/utils/export.d.ts

@@ -1,2 +1 @@
 export * from '@matterbridge/utils';
-//# sourceMappingURL=export.d.ts.map

package/dist/utils/export.js

@@ -1,2 +1 @@
 export * from '@matterbridge/utils';
-//# sourceMappingURL=export.js.map

package/dist/worker.d.ts

@@ -1,68 +1,7 @@
-/**
- * This file contains the worker functions.
- *
- * @file workers.ts
- * @author Luca Liguori
- * @created 2025-11-25
- * @version 1.1.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 { Worker } from 'node:worker_threads';
 import { AnsiLogger, LogLevel } from 'node-ansi-logger';
 import type { ParentPortMessage } from './workerTypes.js';
-/**
- * Sends a control message to the parent through parentPort
- *
- * @param {ControlMessage} message - The control message to send.
- */
 export declare function parentPost(message: ParentPortMessage): void;
-/**
- * Sends a control message to the parent through parentPort to log a message.
- *
- * @param {string | undefined} logName - The name of the logger.
- * @param {LogLevel} logLevel - The log level of the message.
- * @param {string} message - The log message to send.
- */
 export declare function parentLog(logName: string | undefined, logLevel: LogLevel, message: string): void;
-/**
- * Typed helper to create an ESM Worker.
- *
- * This function uses pathToFileURL to convert the relative path to a file URL,
- * which is necessary for ESM modules. It also sets the worker type to 'module'.
- *
- * @param {string} name - name of the worker
- * @param {string} relativePath - path to the worker file code: it must be an ESM module in javascript
- * @param {Record<string, boolean | number | string | object>} [workerData] - optional data to pass to the worker
- * @param {string[]} [argv] - optional command line arguments to pass to the worker. If not provided, inherits from the main thread.
- * @param {NodeJS.ProcessEnv} [env] - optional environment variables to pass to the worker. If not provided, inherits from the main thread.
- * @param {string[]} [execArgv] - optional execArgv to pass to the worker. If not provided no execArgv are passed.
- * @returns {Worker} - the created Worker instance
- *
- * @example
- * ```typescript
- * createESMWorker('NpmCommand', './dist/npmCommand.js', { command: 'npm list --global --depth=0' });
- * ```
- */
 export declare function createESMWorker(name: string, relativePath: string, workerData?: Record<string, boolean | number | string | object>, argv?: string[], env?: NodeJS.ProcessEnv, execArgv?: string[]): Worker;
-/**
- * Log worker information.
- *
- * @param {AnsiLogger} log - The logger instance to use for logging.
- * @param {boolean} [logEnv] - Whether to log environment variables. Defaults to false.
- */
 export declare function logWorkerInfo(log: AnsiLogger, logEnv?: boolean): void;
-//# sourceMappingURL=worker.d.ts.map

package/dist/worker.js

@@ -1,90 +1,30 @@
-/**
- * This file contains the worker functions.
- *
- * @file workers.ts
- * @author Luca Liguori
- * @created 2025-11-25
- * @version 1.1.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 { isMainThread, parentPort, threadId, Worker, workerData } from 'node:worker_threads';
 import { pathToFileURL } from 'node:url';
 import { resolve } from 'node:path';
 import { inspect } from 'node:util';
-/**
- * Sends a control message to the parent through parentPort
- *
- * @param {ControlMessage} message - The control message to send.
- */
 export function parentPost(message) {
     if (!parentPort)
         throw new Error(`WorkerServer ${workerData.threadName}: parentPort is not available.`);
     parentPort.postMessage(message);
 }
-/**
- * Sends a control message to the parent through parentPort to log a message.
- *
- * @param {string | undefined} logName - The name of the logger.
- * @param {LogLevel} logLevel - The log level of the message.
- * @param {string} message - The log message to send.
- */
 export function parentLog(logName, logLevel, message) {
     if (!parentPort)
         throw new Error(`WorkerServer ${workerData.threadName}: parentPort is not available.`);
     const logMessage = { type: 'log', threadId, threadName: workerData.threadName, logName, logLevel, message };
     parentPort.postMessage(logMessage);
 }
-/**
- * Typed helper to create an ESM Worker.
- *
- * This function uses pathToFileURL to convert the relative path to a file URL,
- * which is necessary for ESM modules. It also sets the worker type to 'module'.
- *
- * @param {string} name - name of the worker
- * @param {string} relativePath - path to the worker file code: it must be an ESM module in javascript
- * @param {Record<string, boolean | number | string | object>} [workerData] - optional data to pass to the worker
- * @param {string[]} [argv] - optional command line arguments to pass to the worker. If not provided, inherits from the main thread.
- * @param {NodeJS.ProcessEnv} [env] - optional environment variables to pass to the worker. If not provided, inherits from the main thread.
- * @param {string[]} [execArgv] - optional execArgv to pass to the worker. If not provided no execArgv are passed.
- * @returns {Worker} - the created Worker instance
- *
- * @example
- * ```typescript
- * createESMWorker('NpmCommand', './dist/npmCommand.js', { command: 'npm list --global --depth=0' });
- * ```
- */
 export function createESMWorker(name, relativePath, workerData, argv, env, execArgv) {
     const fileURL = pathToFileURL(resolve(relativePath));
     const options = {
-        workerData: { ...workerData, threadName: name }, // Pass threadName in workerData cause worker_threads don't have it natively in node 20
+        workerData: { ...workerData, threadName: name },
         type: 'module',
         name,
-        argv: argv ?? process.argv.slice(2), // Pass command line arguments to worker
-        env: env ?? process.env, // Inherit environment variables
-        execArgv, // execArgv for node like --inspect
+        argv: argv ?? process.argv.slice(2),
+        env: env ?? process.env,
+        execArgv,
     };
     return new Worker(fileURL, options);
 }
-/**
- * Log worker information.
- *
- * @param {AnsiLogger} log - The logger instance to use for logging.
- * @param {boolean} [logEnv] - Whether to log environment variables. Defaults to false.
- */
 export function logWorkerInfo(log, logEnv = false) {
     log.debug(`${isMainThread ? 'Main thread' : 'Worker thread'}: ${workerData?.threadName}:${threadId} Pid: ${process.pid}`);
     log.debug(`ParentPort: ${parentPort ? 'active' : 'not active'}`);
@@ -93,4 +33,3 @@ export function logWorkerInfo(log, logEnv = false) {
     log.debug(`Argv: ${argv.length ? argv.join(' ') : 'none'}`);
     log.debug(`Env: ${logEnv ? inspect(process.env, true, 10, true) : 'not logged'}`);
 }
-//# sourceMappingURL=worker.js.map

package/dist/workerCheckUpdates.d.ts

@@ -1,25 +1 @@
-/**
- * This file contains the workerCheckUpdates functions.
- *
- * @file workerCheckUpdates.ts
- * @author Luca Liguori
- * @created 2025-11-25
- * @version 1.1.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=workerCheckUpdates.d.ts.map

package/dist/workerCheckUpdates.js

@@ -1,26 +1,3 @@
-/**
- * This file contains the workerCheckUpdates functions.
- *
- * @file workerCheckUpdates.ts
- * @author Luca Liguori
- * @created 2025-11-25
- * @version 1.1.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 { threadId, isMainThread, parentPort, workerData } from 'node:worker_threads';
 import { AnsiLogger } from 'node-ansi-logger';
 import { hasParameter, inspectError } from '@matterbridge/utils';
@@ -29,16 +6,13 @@ import { logWorkerInfo, parentLog, parentPost } from './worker.js';
 import { checkUpdates } from './checkUpdates.js';
 const debug = hasParameter('debug') || hasParameter('verbose');
 const verbose = hasParameter('verbose');
-// Send init message
 if (!isMainThread && parentPort) {
     parentPost({ type: 'init', threadId, threadName: workerData.threadName, success: true });
     if (debug)
-        parentLog('MatterbridgeCheckUpdates', "info" /* LogLevel.INFO */, `Worker ${workerData.threadName}:${threadId} initialized.`);
+        parentLog('MatterbridgeCheckUpdates', "info", `Worker ${workerData.threadName}:${threadId} initialized.`);
 }
-// Broadcast server
-const log = new AnsiLogger({ logName: 'MatterbridgeCheckUpdates', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: debug ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
+const log = new AnsiLogger({ logName: 'MatterbridgeCheckUpdates', logTimestampFormat: 4, logLevel: debug ? "debug" : "info" });
 const server = new BroadcastServer('matterbridge', log);
-// Log worker info
 if (verbose)
     logWorkerInfo(log, verbose);
 let success = false;
@@ -48,21 +22,16 @@ try {
     success = true;
     log.debug(`Check updates succeeded`);
     if (!isMainThread && parentPort)
-        parentLog('MatterbridgeCheckUpdates', "debug" /* LogLevel.DEBUG */, `Check updates succeeded`);
+        parentLog('MatterbridgeCheckUpdates', "debug", `Check updates succeeded`);
 }
 catch (error) {
-    // istanbul ignore next cause it's just an error log
     const errorMessage = inspectError(log, `Failed to check updates`, error);
-    // istanbul ignore next cause it's just an error log
     if (!isMainThread && parentPort)
-        parentLog('MatterbridgeCheckUpdates', "error" /* LogLevel.ERROR */, errorMessage);
+        parentLog('MatterbridgeCheckUpdates', "error", errorMessage);
 }
-// Close the broadcast server
 server.close();
-// Send exit message
 if (!isMainThread && parentPort) {
     parentPost({ type: 'exit', threadId, threadName: workerData.threadName, success });
     if (debug)
-        parentLog('MatterbridgeCheckUpdates', "info" /* LogLevel.INFO */, `Worker ${workerData.threadName}:${threadId} exiting with success: ${success}.`);
+        parentLog('MatterbridgeCheckUpdates', "info", `Worker ${workerData.threadName}:${threadId} exiting with success: ${success}.`);
 }
-//# sourceMappingURL=workerCheckUpdates.js.map

package/dist/workerGlobalPrefix.d.ts

@@ -1,25 +1 @@
-/**
- * This file contains the workerGlobalPrefix functions.
- *
- * @file workerGlobalPrefix.ts
- * @author Luca Liguori
- * @created 2025-11-25
- * @version 1.1.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=workerGlobalPrefix.d.ts.map

package/dist/workerGlobalPrefix.js

@@ -1,26 +1,3 @@
-/**
- * This file contains the workerGlobalPrefix functions.
- *
- * @file workerGlobalPrefix.ts
- * @author Luca Liguori
- * @created 2025-11-25
- * @version 1.1.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 { threadId, isMainThread, parentPort, workerData } from 'node:worker_threads';
 import { AnsiLogger } from 'node-ansi-logger';
 import { getGlobalNodeModules, hasParameter, inspectError } from '@matterbridge/utils';
@@ -28,16 +5,13 @@ import { BroadcastServer } from './broadcastServer.js';
 import { logWorkerInfo, parentLog, parentPost } from './worker.js';
 const debug = hasParameter('debug') || hasParameter('verbose');
 const verbose = hasParameter('verbose');
-// Send init message
 if (!isMainThread && parentPort) {
     parentPost({ type: 'init', threadId, threadName: workerData.threadName, success: true });
     if (debug)
-        parentLog('MatterbridgePrefix', "info" /* LogLevel.INFO */, `Worker ${workerData.threadName}:${threadId} initialized.`);
+        parentLog('MatterbridgePrefix', "info", `Worker ${workerData.threadName}:${threadId} initialized.`);
 }
-// Broadcast server
-const log = new AnsiLogger({ logName: 'MatterbridgePrefix', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: debug ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
+const log = new AnsiLogger({ logName: 'MatterbridgePrefix', logTimestampFormat: 4, logLevel: debug ? "debug" : "info" });
 const server = new BroadcastServer('matterbridge', log);
-// Log worker info
 if (verbose)
     logWorkerInfo(log, verbose);
 let prefix;
@@ -48,21 +22,16 @@ try {
     server.request({ type: 'matterbridge_global_prefix', src: `matterbridge`, dst: 'matterbridge', params: { prefix } });
     success = true;
     if (!isMainThread && parentPort)
-        parentLog('MatterbridgePrefix', "debug" /* LogLevel.DEBUG */, `Global node_modules Directory: ${prefix}`);
+        parentLog('MatterbridgePrefix', "debug", `Global node_modules Directory: ${prefix}`);
 }
 catch (error) {
-    // istanbul ignore next cause it's just an error log
     const errorMessage = inspectError(log, `Failed to get global node modules`, error);
-    // istanbul ignore next cause it's just an error log
     if (!isMainThread && parentPort)
-        parentLog('MatterbridgePrefix', "error" /* LogLevel.ERROR */, errorMessage);
+        parentLog('MatterbridgePrefix', "error", errorMessage);
 }
-// Close the broadcast server
 server.close();
-// Send exit message
 if (!isMainThread && parentPort) {
     parentPost({ type: 'exit', threadId, threadName: workerData.threadName, success });
     if (debug)
-        parentLog('MatterbridgePrefix', "info" /* LogLevel.INFO */, `Worker ${workerData.threadName}:${threadId} exiting with success: ${success}.`);
+        parentLog('MatterbridgePrefix', "info", `Worker ${workerData.threadName}:${threadId} exiting with success: ${success}.`);
 }
-//# sourceMappingURL=workerGlobalPrefix.js.map

package/dist/workerTypes.d.ts

@@ -1,28 +1,4 @@
-/**
- * This file contains the worker types.
- *
- * @file workerTypes.ts
- * @author Luca Liguori
- * @created 2025-11-25
- * @version 1.1.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 type { LogLevel } from 'node-ansi-logger';
-/** Control messages sent through parentPort manager <-> workers */
 export type ParentPortMessage = {
     type: 'init';
     threadName: string | null;
@@ -49,4 +25,3 @@ export type ParentPortMessage = {
     threadId: number;
     success: boolean;
 };
-//# sourceMappingURL=workerTypes.d.ts.map

package/dist/workerTypes.js

@@ -1,25 +1 @@
-/**
- * This file contains the worker types.
- *
- * @file workerTypes.ts
- * @author Luca Liguori
- * @created 2025-11-25
- * @version 1.1.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=workerTypes.js.map