matterbridge 3.5.0 → 3.5.1-dev-20260121-22e98b4

package/dist/update.d.ts

@@ -1,84 +1,9 @@
-/**
- * This file contains the check updates functions.
- *
- * @file update.ts
- * @author Luca Liguori
- * @created 2025-02-24
- * @version 2.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.
- */
 import { AnsiLogger } from 'node-ansi-logger';
 import { ApiPlugin, SharedMatterbridge } from './matterbridgeTypes.js';
 import { BroadcastServer } from './broadcastServer.js';
-/**
- * Checks for updates for Matterbridge and its plugins.
- * If the 'shelly' parameter is present, also checks for Shelly updates.
- *
- * @param {SharedMatterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<void>} A promise that resolves when the update checks are complete.
- */
 export declare function checkUpdates(matterbridge: SharedMatterbridge): Promise<void>;
-/**
- * Checks for updates and logs from https://matterbridge.io/.
- * If the update check fails, logs a warning message.
- *
- * @param {SharedMatterbridge} matterbridge - The Matterbridge instance.
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- */
 export declare function checkUpdatesAndLog(matterbridge: SharedMatterbridge, log: AnsiLogger, server: BroadcastServer): Promise<void>;
-/**
- * Retrieves the latest version of Matterbridge and updates the matterbridgeLatestVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {SharedMatterbridge} matterbridge - The Matterbridge instance.
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest version is retrieved.
- */
 export declare function getMatterbridgeLatestVersion(matterbridge: SharedMatterbridge, log: AnsiLogger, server: BroadcastServer): Promise<string | undefined>;
-/**
- * Retrieves the latest dev version of Matterbridge and updates the matterbridgeDevVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {SharedMatterbridge} matterbridge - The Matterbridge instance.
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest dev version is retrieved.
- */
 export declare function getMatterbridgeDevVersion(matterbridge: SharedMatterbridge, log: AnsiLogger, server: BroadcastServer): Promise<string | undefined>;
-/**
- * Retrieves the latest version of a plugin and updates the plugin's latestVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- * @param {ApiPlugin} plugin - The plugin for which to retrieve the latest version.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest version is retrieved.
- */
 export declare function getPluginLatestVersion(log: AnsiLogger, server: BroadcastServer, plugin: ApiPlugin): Promise<string | undefined>;
-/**
- * Retrieves the latest dev version of a plugin and updates the plugin's devVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- * @param {ApiPlugin} plugin - The plugin for which to retrieve the latest version.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest dev version is retrieved.
- */
 export declare function getPluginDevVersion(log: AnsiLogger, server: BroadcastServer, plugin: ApiPlugin): Promise<string | undefined>;
-//# sourceMappingURL=update.d.ts.map

package/dist/update.js

@@ -1,43 +1,9 @@
-/**
- * This file contains the check updates functions.
- *
- * @file update.ts
- * @author Luca Liguori
- * @created 2025-02-24
- * @version 2.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.
- */
-// AnsiLogger module
 import { AnsiLogger, db, debugStringify, nt, wr } from 'node-ansi-logger';
-// Matterbridge module
+import { hasParameter, isValidString } from '@matterbridge/utils';
 import { plg } from './matterbridgeTypes.js';
 import { BroadcastServer } from './broadcastServer.js';
-import { hasParameter } from './utils/commandLine.js';
-import { isValidString } from './utils/isValid.js';
-/**
- * Checks for updates for Matterbridge and its plugins.
- * If the 'shelly' parameter is present, also checks for Shelly updates.
- *
- * @param {SharedMatterbridge} matterbridge - The Matterbridge instance.
- * @returns {Promise<void>} A promise that resolves when the update checks are complete.
- */
 export async function checkUpdates(matterbridge) {
-    /** Broadcast server */
-    const log = new AnsiLogger({ logName: 'MatterbridgeUpdates', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: matterbridge.logLevel });
+    const log = new AnsiLogger({ logName: 'MatterbridgeUpdates', logTimestampFormat: 4, logLevel: matterbridge.logLevel });
     const server = new BroadcastServer('updates', log);
     const checkUpdatePromise = checkUpdatesAndLog(matterbridge, log, server);
     const latestVersionPromise = getMatterbridgeLatestVersion(matterbridge, log, server);
@@ -58,16 +24,8 @@ export async function checkUpdates(matterbridge) {
     await Promise.all([checkUpdatePromise, latestVersionPromise, devVersionPromise, ...pluginsVersionPromises, ...pluginsDevVersionPromises, ...shellyUpdatesPromises]);
     server.close();
 }
-/**
- * Checks for updates and logs from https://matterbridge.io/.
- * If the update check fails, logs a warning message.
- *
- * @param {SharedMatterbridge} matterbridge - The Matterbridge instance.
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- */
 export async function checkUpdatesAndLog(matterbridge, log, server) {
-    const { getGitHubUpdate } = await import('./utils/network.js');
+    const { getGitHubUpdate } = await import('@matterbridge/utils');
     const branch = matterbridge.matterbridgeVersion.includes('-dev-') ? 'dev' : 'main';
     try {
         const updateJson = await getGitHubUpdate(branch, 'update.json', 5_000);
@@ -82,29 +40,17 @@ export async function checkUpdatesAndLog(matterbridge, log, server) {
                 dst: 'frontend',
                 params: { message: branch === 'main' ? updateJson.latestMessage : updateJson.devMessage, timeout: 0, severity: branch === 'main' ? updateJson.latestMessageSeverity : updateJson.devMessageSeverity },
             });
-            // matterbridge.frontend.wssSendSnackbarMessage(branch === 'main' ? updateJson.latestMessage : updateJson.devMessage, 0, branch === 'main' ? updateJson.latestMessageSeverity : updateJson.devMessageSeverity);
         }
     }
     catch (error) {
         log.debug(`Error checking GitHub ${branch} updates: ${error instanceof Error ? error.message : error}`);
     }
 }
-/**
- * Retrieves the latest version of Matterbridge and updates the matterbridgeLatestVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {SharedMatterbridge} matterbridge - The Matterbridge instance.
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest version is retrieved.
- */
 export async function getMatterbridgeLatestVersion(matterbridge, log, server) {
-    const { getNpmPackageVersion } = await import('./utils/network.js');
+    const { getNpmPackageVersion } = await import('@matterbridge/utils');
     try {
         const version = await getNpmPackageVersion('matterbridge');
         server.request({ type: 'matterbridge_latest_version', src: server.name, dst: 'matterbridge', params: { version } });
-        // matterbridge.matterbridgeLatestVersion = version;
-        // await matterbridge.nodeContext?.set<string>('matterbridgeLatestVersion', matterbridge.matterbridgeLatestVersion);
         if (matterbridge.matterbridgeVersion !== version) {
             log.notice(`Matterbridge is out of date. Current version: ${matterbridge.matterbridgeVersion}. Latest version: ${version}.`);
             server.request({
@@ -113,11 +59,8 @@ export async function getMatterbridgeLatestVersion(matterbridge, log, server) {
                 dst: 'frontend',
                 params: { message: 'Matterbridge latest update available', timeout: 0, severity: 'info' },
             });
-            // matterbridge.frontend.wssSendSnackbarMessage('Matterbridge latest update available', 0, 'info');
             server.request({ type: 'frontend_updaterequired', src: server.name, dst: 'frontend', params: { devVersion: false } });
-            // matterbridge.frontend.wssSendUpdateRequired();
             server.request({ type: 'frontend_refreshrequired', src: server.name, dst: 'frontend', params: { changed: 'settings' } });
-            // matterbridge.frontend.wssSendRefreshRequired('settings');
         }
         else {
             log.debug(`Matterbridge is up to date. Current version: ${matterbridge.matterbridgeVersion}. Latest version: ${version}.`);
@@ -125,26 +68,14 @@ export async function getMatterbridgeLatestVersion(matterbridge, log, server) {
         return version;
     }
     catch (error) {
-        // logError(matterbridge.log, `Error getting Matterbridge latest version`, error);
         log.warn(`Error getting Matterbridge latest version: ${error instanceof Error ? error.message : error}`);
     }
 }
-/**
- * Retrieves the latest dev version of Matterbridge and updates the matterbridgeDevVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {SharedMatterbridge} matterbridge - The Matterbridge instance.
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest dev version is retrieved.
- */
 export async function getMatterbridgeDevVersion(matterbridge, log, server) {
-    const { getNpmPackageVersion } = await import('./utils/network.js');
+    const { getNpmPackageVersion } = await import('@matterbridge/utils');
     try {
         const version = await getNpmPackageVersion('matterbridge', 'dev');
         server.request({ type: 'matterbridge_dev_version', src: server.name, dst: 'matterbridge', params: { version } });
-        // matterbridge.matterbridgeDevVersion = version;
-        // await matterbridge.nodeContext?.set<string>('matterbridgeDevVersion', version);
         if (matterbridge.matterbridgeVersion.includes('-dev-') && matterbridge.matterbridgeVersion !== version) {
             log.notice(`Matterbridge@dev is out of date. Current version: ${matterbridge.matterbridgeVersion}. Latest dev version: ${version}.`);
             server.request({
@@ -153,11 +84,8 @@ export async function getMatterbridgeDevVersion(matterbridge, log, server) {
                 dst: 'frontend',
                 params: { message: 'Matterbridge dev update available', timeout: 0, severity: 'info' },
             });
-            // matterbridge.frontend.wssSendSnackbarMessage('Matterbridge dev update available', 0, 'info');
             server.request({ type: 'frontend_updaterequired', src: server.name, dst: 'frontend', params: { devVersion: true } });
-            // matterbridge.frontend.wssSendUpdateRequired(true);
             server.request({ type: 'frontend_refreshrequired', src: server.name, dst: 'frontend', params: { changed: 'settings' } });
-            // matterbridge.frontend.wssSendRefreshRequired('settings');
         }
         else if (matterbridge.matterbridgeVersion.includes('-dev-') && matterbridge.matterbridgeVersion === version) {
             log.debug(`Matterbridge@dev is up to date. Current version: ${matterbridge.matterbridgeVersion}. Latest dev version: ${version}.`);
@@ -168,17 +96,8 @@ export async function getMatterbridgeDevVersion(matterbridge, log, server) {
         log.warn(`Error getting Matterbridge latest dev version: ${error instanceof Error ? error.message : error}`);
     }
 }
-/**
- * Retrieves the latest version of a plugin and updates the plugin's latestVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- * @param {ApiPlugin} plugin - The plugin for which to retrieve the latest version.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest version is retrieved.
- */
 export async function getPluginLatestVersion(log, server, plugin) {
-    const { getNpmPackageVersion } = await import('./utils/network.js');
+    const { getNpmPackageVersion } = await import('@matterbridge/utils');
     try {
         const version = await getNpmPackageVersion(plugin.name);
         plugin.latestVersion = version;
@@ -186,7 +105,6 @@ export async function getPluginLatestVersion(log, server, plugin) {
         if (plugin.version !== plugin.latestVersion) {
             log.notice(`The plugin ${plg}${plugin.name}${nt} is out of date. Current version: ${plugin.version}. Latest version: ${plugin.latestVersion}.`);
             server.request({ type: 'frontend_refreshrequired', src: server.name, dst: 'frontend', params: { changed: 'plugins' } });
-            // matterbridge.frontend.wssSendRefreshRequired('plugins');
         }
         else {
             log.debug(`The plugin ${plg}${plugin.name}${db} is up to date. Current version: ${plugin.version}. Latest version: ${plugin.latestVersion}.`);
@@ -197,17 +115,8 @@ export async function getPluginLatestVersion(log, server, plugin) {
         log.warn(`Error getting plugin ${plg}${plugin.name}${wr} latest version: ${error instanceof Error ? error.message : error}`);
     }
 }
-/**
- * Retrieves the latest dev version of a plugin and updates the plugin's devVersion property.
- * If there is an error retrieving the latest version, logs an error message.
- *
- * @param {AnsiLogger} log - The logger instance.
- * @param {BroadcastServer} server - The broadcast server instance.
- * @param {ApiPlugin} plugin - The plugin for which to retrieve the latest version.
- * @returns {Promise<string | undefined>} A promise that resolves when the latest dev version is retrieved.
- */
 export async function getPluginDevVersion(log, server, plugin) {
-    const { getNpmPackageVersion } = await import('./utils/network.js');
+    const { getNpmPackageVersion } = await import('@matterbridge/utils');
     try {
         const version = await getNpmPackageVersion(plugin.name, 'dev');
         plugin.devVersion = version;
@@ -215,7 +124,6 @@ export async function getPluginDevVersion(log, server, plugin) {
         if (plugin.version.includes('-dev-') && plugin.version !== plugin.devVersion) {
             log.notice(`The plugin ${plg}${plugin.name}${nt} is out of date. Current version: ${plugin.version}. Latest dev version: ${plugin.devVersion}.`);
             server.request({ type: 'frontend_refreshrequired', src: server.name, dst: 'frontend', params: { changed: 'plugins' } });
-            // matterbridge.frontend.wssSendRefreshRequired('plugins');
         }
         else if (plugin.version.includes('-dev-') && plugin.version === plugin.devVersion) {
             log.debug(`The plugin ${plg}${plugin.name}${db} is up to date. Current version: ${plugin.version}. Latest dev version: ${plugin.devVersion}.`);
@@ -226,4 +134,3 @@ export async function getPluginDevVersion(log, server, plugin) {
         log.debug(`Error getting plugin ${plg}${plugin.name}${db} latest dev version: ${error instanceof Error ? error.message : error}`);
     }
 }
-//# sourceMappingURL=update.js.map

package/dist/utils/export.d.ts

@@ -1,13 +1 @@
-export * from './network.js';
-export * from './commandLine.js';
-export * from './isValid.js';
-export * from './colorUtils.js';
-export * from './deepCopy.js';
-export * from './deepEqual.js';
-export * from './copyDirectory.js';
-export * from './createDirectory.js';
-export * from './createZip.js';
-export * from './wait.js';
-export * from './hex.js';
-export * from './error.js';
-//# sourceMappingURL=export.d.ts.map
+export * from '@matterbridge/utils';

package/dist/utils/export.js

@@ -1,13 +1 @@
-export * from './network.js';
-export * from './commandLine.js';
-export * from './isValid.js';
-export * from './colorUtils.js';
-export * from './deepCopy.js';
-export * from './deepEqual.js';
-export * from './copyDirectory.js';
-export * from './createDirectory.js';
-export * from './createZip.js';
-export * from './wait.js';
-export * from './hex.js';
-export * from './error.js';
-//# sourceMappingURL=export.js.map
+export * from '@matterbridge/utils';

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.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=workerGlobalPrefix.d.ts.map

package/dist/workerGlobalPrefix.js

@@ -1,46 +1,17 @@
-/**
- * This file contains the workerGlobalPrefix functions.
- *
- * @file workerGlobalPrefix.ts
- * @author Luca Liguori
- * @created 2025-11-25
- * @version 1.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 { threadId, isMainThread, parentPort, workerData } from 'node:worker_threads';
 import { AnsiLogger } from 'node-ansi-logger';
-import { getGlobalNodeModules } from './utils/network.js';
+import { getGlobalNodeModules, hasParameter, inspectError } from '@matterbridge/utils';
 import { BroadcastServer } from './broadcastServer.js';
-import { inspectError } from './utils/error.js';
 import { logWorkerInfo, parentLog, parentPost } from './workers.js';
-import { hasParameter } from './utils/commandLine.js';
 const debug = hasParameter('debug') || hasParameter('verbose');
 const verbose = hasParameter('verbose');
-// Send init message
-// istanbul ignore next cause it's available only in worker threads
 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;
@@ -51,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);
 }
 server.close();
-// Send exit message
-// istanbul ignore next cause it's available only in worker threads
 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.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';
-/** 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.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=workerTypes.js.map

package/dist/workers.d.ts

@@ -1,69 +1,8 @@
-/**
- * This file contains the worker functions.
- *
- * @file workers.ts
- * @author Luca Liguori
- * @created 2025-11-25
- * @version 1.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 { 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;
 export { ParentPortMessage };
-//# sourceMappingURL=workers.d.ts.map

package/dist/workers.js

@@ -1,94 +1,31 @@
-/**
- * This file contains the worker functions.
- *
- * @file workers.ts
- * @author Luca Liguori
- * @created 2025-11-25
- * @version 1.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 { 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.
- */
-// istanbul ignore next cause it's available only in worker threads
 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.
- */
-// istanbul ignore next cause it's available only in worker threads
 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 worker info
     log.debug(`${isMainThread ? 'Main thread' : 'Worker thread'}: ${workerData?.threadName}:${threadId} Pid: ${process.pid}`);
     log.debug(`ParentPort: ${parentPort ? 'active' : 'not active'}`);
     log.debug(`WorkerData: ${workerData ? inspect(workerData, true, 10, true) : 'none'}`);
@@ -96,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=workers.js.map