@matterbridge/core 3.6.2-dev-20260314-f95be8a → 3.6.2-dev-20260315-d23fd18

package/dist/frontend.d.ts

@@ -56,5 +56,6 @@ export declare class Frontend extends EventEmitter<FrontendEvents> {
     wssSendCloseSnackbarMessage(message: string): void;
     wssSendAttributeChangedMessage(plugin: string, serialNumber: string, uniqueId: string, number: EndpointNumber, id: string, cluster: string, attribute: string, value: number | string | boolean | null): void;
     wssBroadcastMessage(msg: WsMessageBroadcast): void;
+    zip(command: 'zip' | 'verify' | 'unzip', archivePath: string, sourcePaths: string[], destinationPath: string): void;
 }
 export {};

package/dist/frontend.js

@@ -16,7 +16,6 @@ import { inspectError } from '@matterbridge/utils/error';
 import { formatBytes, formatPercent, formatUptime } from '@matterbridge/utils/format';
 import { isValidArray, isValidBoolean, isValidNumber, isValidObject, isValidString } from '@matterbridge/utils/validate';
 import { wait, withTimeout } from '@matterbridge/utils/wait';
-import { createZip } from '@matterbridge/utils/zip';
 import { AnsiLogger, CYAN, db, debugStringify, er, nf, nt, rs, stringify, UNDERLINE, UNDERLINEOFF, YELLOW } from 'node-ansi-logger';
 import { cliEmitter, lastOsCpuUsage, lastProcessCpuUsage } from './cliEmitter.js';
 import { generateHistoryPage } from './cliHistory.js';
@@ -134,6 +133,29 @@ export class Frontend extends EventEmitter {
                         }
                     }
                     break;
+                case 'manager_archive_response':
+                    if (msg.result &&
+                        msg.result.success &&
+                        isValidString(msg.result.command) &&
+                        isValidString(msg.result.archivePath) &&
+                        isValidArray(msg.result.sourcePaths) &&
+                        isValidString(msg.result.destinationPath)) {
+                        this.log.debug(`***Received broadcast response ${CYAN}${msg.type}${db} from ${CYAN}${msg.src}${db}: ${debugStringify(msg)}${db}`);
+                        this.wssBroadcastMessage({
+                            id: 0,
+                            src: 'Matterbridge',
+                            dst: 'Frontend',
+                            method: 'archive',
+                            success: true,
+                            response: {
+                                command: msg.result.command,
+                                archivePath: msg.result.archivePath,
+                                sourcePaths: msg.result.sourcePaths,
+                                destinationPath: msg.result.destinationPath,
+                            },
+                        });
+                    }
+                    break;
             }
         }
     }
@@ -496,6 +518,31 @@ export class Frontend extends EventEmitter {
                 res.status(500).send('Error reading matterbridge log file. Please enable the matterbridge log on file in the settings.');
             }
         });
+        this.expressApp.get('/api/download-mblog', async (req, res) => {
+            this.log.debug(`The frontend sent /api/download-mblog ${path.join(this.matterbridge.matterbridgeDirectory, MATTERBRIDGE_LOGGER_FILE)}`);
+            if (!this.validateReq(req, res))
+                return;
+            const fs = await import('node:fs');
+            try {
+                await fs.promises.access(path.join(this.matterbridge.matterbridgeDirectory, MATTERBRIDGE_LOGGER_FILE), fs.constants.F_OK);
+                const data = await fs.promises.readFile(path.join(this.matterbridge.matterbridgeDirectory, MATTERBRIDGE_LOGGER_FILE), 'utf8');
+                await fs.promises.writeFile(path.join(os.tmpdir(), MATTERBRIDGE_LOGGER_FILE), data, 'utf-8');
+            }
+            catch (error) {
+                await fs.promises.writeFile(path.join(os.tmpdir(), MATTERBRIDGE_LOGGER_FILE), 'Enable the matterbridge log on file in the settings to download the matterbridge log.', 'utf-8');
+                this.log.debug(`Error in /api/download-mblog: ${error instanceof Error ? error.message : error}`);
+            }
+            res.type('text/plain; charset=utf-8');
+            res.download(path.join(os.tmpdir(), MATTERBRIDGE_LOGGER_FILE), 'matterbridge.log', (error) => {
+                if (error) {
+                    this.log.error(`Error downloading log file ${MATTERBRIDGE_LOGGER_FILE}: ${error instanceof Error ? error.message : error}`);
+                    res.status(500).send('Error downloading the matterbridge log file');
+                }
+                else {
+                    this.log.debug(`Matterbridge log file ${MATTERBRIDGE_LOGGER_FILE} downloaded successfully`);
+                }
+            });
+        });
         this.expressApp.get('/api/view-mjlog', async (req, res) => {
             this.log.debug('The frontend sent /api/view-mjlog');
             if (!this.validateReq(req, res))
@@ -511,6 +558,31 @@ export class Frontend extends EventEmitter {
                 res.status(500).send('Error reading matter log file. Please enable the matter log on file in the settings.');
             }
         });
+        this.expressApp.get('/api/download-mjlog', async (req, res) => {
+            this.log.debug(`The frontend sent /api/download-mjlog ${path.join(this.matterbridge.matterbridgeDirectory, MATTER_LOGGER_FILE)}`);
+            if (!this.validateReq(req, res))
+                return;
+            const fs = await import('node:fs');
+            try {
+                await fs.promises.access(path.join(this.matterbridge.matterbridgeDirectory, MATTER_LOGGER_FILE), fs.constants.F_OK);
+                const data = await fs.promises.readFile(path.join(this.matterbridge.matterbridgeDirectory, MATTER_LOGGER_FILE), 'utf8');
+                await fs.promises.writeFile(path.join(os.tmpdir(), MATTER_LOGGER_FILE), data, 'utf-8');
+            }
+            catch (error) {
+                await fs.promises.writeFile(path.join(os.tmpdir(), MATTER_LOGGER_FILE), 'Enable the matter log on file in the settings to download the matter log.', 'utf-8');
+                this.log.debug(`Error in /api/download-mjlog: ${error instanceof Error ? error.message : error}`);
+            }
+            res.type('text/plain; charset=utf-8');
+            res.download(path.join(os.tmpdir(), MATTER_LOGGER_FILE), 'matter.log', (error) => {
+                if (error) {
+                    this.log.error(`Error downloading log file ${MATTER_LOGGER_FILE}: ${error instanceof Error ? error.message : error}`);
+                    res.status(500).send('Error downloading the matter log file');
+                }
+                else {
+                    this.log.debug(`Matter log file ${MATTER_LOGGER_FILE} downloaded successfully`);
+                }
+            });
+        });
         this.expressApp.get('/api/view-diagnostic', async (req, res) => {
             this.log.debug('The frontend sent /api/view-diagnostic');
             if (!this.validateReq(req, res))
@@ -547,6 +619,9 @@ export class Frontend extends EventEmitter {
                     this.log.error(`Error downloading file ${MATTERBRIDGE_DIAGNOSTIC_FILE}: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send('Error downloading the diagnostic log file');
                 }
+                else {
+                    this.log.debug(`Diagnostic log file ${MATTERBRIDGE_DIAGNOSTIC_FILE} downloaded successfully`);
+                }
             });
         });
         this.expressApp.get('/api/viewhistory', async (req, res) => {
@@ -579,6 +654,9 @@ export class Frontend extends EventEmitter {
                         this.log.error(`Error in /api/downloadhistory downloading history file ${MATTERBRIDGE_HISTORY_FILE}: ${error instanceof Error ? error.message : error}`);
                         res.status(500).send('Error downloading history file');
                     }
+                    else {
+                        this.log.debug(`History file ${MATTERBRIDGE_HISTORY_FILE} downloaded successfully`);
+                    }
                 });
             }
             catch (error) {
@@ -586,84 +664,18 @@ export class Frontend extends EventEmitter {
                 res.status(500).send('Error reading history file.');
             }
         });
-        this.expressApp.get('/api/shellyviewsystemlog', async (req, res) => {
-            this.log.debug('The frontend sent /api/shellyviewsystemlog');
-            if (!this.validateReq(req, res))
-                return;
-            try {
-                const fs = await import('node:fs');
-                const data = await fs.promises.readFile(path.join(this.matterbridge.matterbridgeDirectory, 'shelly.log'), 'utf8');
-                res.type('text/plain; charset=utf-8');
-                res.send(data);
-            }
-            catch (error) {
-                this.log.error(`Error reading shelly log file ${MATTERBRIDGE_LOGGER_FILE}: ${error instanceof Error ? error.message : error}`);
-                res.status(500).send('Error reading shelly log file. Please create the shelly system log before loading it.');
-            }
-        });
-        this.expressApp.get('/api/download-mblog', async (req, res) => {
-            this.log.debug(`The frontend sent /api/download-mblog ${path.join(this.matterbridge.matterbridgeDirectory, MATTERBRIDGE_LOGGER_FILE)}`);
-            if (!this.validateReq(req, res))
-                return;
-            const fs = await import('node:fs');
-            try {
-                await fs.promises.access(path.join(this.matterbridge.matterbridgeDirectory, MATTERBRIDGE_LOGGER_FILE), fs.constants.F_OK);
-                const data = await fs.promises.readFile(path.join(this.matterbridge.matterbridgeDirectory, MATTERBRIDGE_LOGGER_FILE), 'utf8');
-                await fs.promises.writeFile(path.join(os.tmpdir(), MATTERBRIDGE_LOGGER_FILE), data, 'utf-8');
-            }
-            catch (error) {
-                await fs.promises.writeFile(path.join(os.tmpdir(), MATTERBRIDGE_LOGGER_FILE), 'Enable the matterbridge log on file in the settings to download the matterbridge log.', 'utf-8');
-                this.log.debug(`Error in /api/download-mblog: ${error instanceof Error ? error.message : error}`);
-            }
-            res.type('text/plain; charset=utf-8');
-            res.download(path.join(os.tmpdir(), MATTERBRIDGE_LOGGER_FILE), 'matterbridge.log', (error) => {
-                if (error) {
-                    this.log.error(`Error downloading log file ${MATTERBRIDGE_LOGGER_FILE}: ${error instanceof Error ? error.message : error}`);
-                    res.status(500).send('Error downloading the matterbridge log file');
-                }
-            });
-        });
-        this.expressApp.get('/api/download-mjlog', async (req, res) => {
-            this.log.debug(`The frontend sent /api/download-mjlog ${path.join(this.matterbridge.matterbridgeDirectory, MATTERBRIDGE_LOGGER_FILE)}`);
+        this.expressApp.get('/api/download-backup', async (req, res) => {
+            this.log.debug('The frontend sent /api/download-backup');
             if (!this.validateReq(req, res))
                 return;
-            const fs = await import('node:fs');
-            try {
-                await fs.promises.access(path.join(this.matterbridge.matterbridgeDirectory, MATTER_LOGGER_FILE), fs.constants.F_OK);
-                const data = await fs.promises.readFile(path.join(this.matterbridge.matterbridgeDirectory, MATTER_LOGGER_FILE), 'utf8');
-                await fs.promises.writeFile(path.join(os.tmpdir(), MATTER_LOGGER_FILE), data, 'utf-8');
-            }
-            catch (error) {
-                await fs.promises.writeFile(path.join(os.tmpdir(), MATTER_LOGGER_FILE), 'Enable the matter log on file in the settings to download the matter log.', 'utf-8');
-                this.log.debug(`Error in /api/download-mblog: ${error instanceof Error ? error.message : error}`);
-            }
-            res.type('text/plain; charset=utf-8');
-            res.download(path.join(os.tmpdir(), MATTER_LOGGER_FILE), 'matter.log', (error) => {
+            res.download(path.join(os.tmpdir(), `matterbridge.backup.zip`), `matterbridge.backup.zip`, (error) => {
+                this.wssSendCloseSnackbarMessage('Creating matterbridge backup...');
                 if (error) {
-                    this.log.error(`Error downloading log file ${MATTER_LOGGER_FILE}: ${error instanceof Error ? error.message : error}`);
-                    res.status(500).send('Error downloading the matter log file');
+                    this.log.error(`Error downloading file matterbridge.backup.zip: ${error instanceof Error ? error.message : error}`);
+                    res.status(500).send(`Error downloading file matterbridge.backup.zip: ${error instanceof Error ? error.message : error}`);
                 }
-            });
-        });
-        this.expressApp.get('/api/shellydownloadsystemlog', async (req, res) => {
-            this.log.debug('The frontend sent /api/shellydownloadsystemlog');
-            if (!this.validateReq(req, res))
-                return;
-            const fs = await import('node:fs');
-            try {
-                await fs.promises.access(path.join(this.matterbridge.matterbridgeDirectory, 'shelly.log'), fs.constants.F_OK);
-                const data = await fs.promises.readFile(path.join(this.matterbridge.matterbridgeDirectory, 'shelly.log'), 'utf8');
-                await fs.promises.writeFile(path.join(os.tmpdir(), 'shelly.log'), data, 'utf-8');
-            }
-            catch (error) {
-                await fs.promises.writeFile(path.join(os.tmpdir(), 'shelly.log'), 'Create the Shelly system log before downloading it.', 'utf-8');
-                this.log.debug(`Error in /api/shellydownloadsystemlog: ${error instanceof Error ? error.message : error}`);
-            }
-            res.type('text/plain; charset=utf-8');
-            res.download(path.join(os.tmpdir(), 'shelly.log'), 'shelly.log', (error) => {
-                if (error) {
-                    this.log.error(`Error downloading Shelly system log file: ${error instanceof Error ? error.message : error}`);
-                    res.status(500).send('Error downloading Shelly system log file');
+                else {
+                    this.log.debug('Backup matterbridge.backup.zip downloaded successfully');
                 }
             });
         });
@@ -671,58 +683,59 @@ export class Frontend extends EventEmitter {
             this.log.debug('The frontend sent /api/download-mbstorage');
             if (!this.validateReq(req, res))
                 return;
-            await createZip(path.join(os.tmpdir(), `matterbridge.${NODE_STORAGE_DIR}.zip`), path.join(this.matterbridge.matterbridgeDirectory, NODE_STORAGE_DIR));
             res.download(path.join(os.tmpdir(), `matterbridge.${NODE_STORAGE_DIR}.zip`), `matterbridge.${NODE_STORAGE_DIR}.zip`, (error) => {
+                this.wssSendCloseSnackbarMessage('Creating matterbridge storage backup...');
                 if (error) {
                     this.log.error(`Error downloading file ${`matterbridge.${NODE_STORAGE_DIR}.zip`}: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send('Error downloading the matterbridge storage file');
                 }
+                else {
+                    this.log.debug(`Matterbridge storage matterbridge.${NODE_STORAGE_DIR}.zip downloaded successfully`);
+                }
             });
         });
         this.expressApp.get('/api/download-mjstorage', async (req, res) => {
             this.log.debug('The frontend sent /api/download-mjstorage');
             if (!this.validateReq(req, res))
                 return;
-            await createZip(path.join(os.tmpdir(), `matterbridge.${MATTER_STORAGE_NAME}.zip`), path.join(this.matterbridge.matterbridgeDirectory, MATTER_STORAGE_NAME));
             res.download(path.join(os.tmpdir(), `matterbridge.${MATTER_STORAGE_NAME}.zip`), `matterbridge.${MATTER_STORAGE_NAME}.zip`, (error) => {
+                this.wssSendCloseSnackbarMessage('Creating matter storage backup...');
                 if (error) {
                     this.log.error(`Error downloading the matter storage matterbridge.${MATTER_STORAGE_NAME}.zip: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send('Error downloading the matter storage zip file');
                 }
+                else {
+                    this.log.debug(`Matter storage matterbridge.${MATTER_STORAGE_NAME}.zip downloaded successfully`);
+                }
             });
         });
         this.expressApp.get('/api/download-pluginstorage', async (req, res) => {
             this.log.debug('The frontend sent /api/download-pluginstorage');
             if (!this.validateReq(req, res))
                 return;
-            await createZip(path.join(os.tmpdir(), `matterbridge.pluginstorage.zip`), this.matterbridge.matterbridgePluginDirectory);
             res.download(path.join(os.tmpdir(), `matterbridge.pluginstorage.zip`), `matterbridge.pluginstorage.zip`, (error) => {
+                this.wssSendCloseSnackbarMessage('Creating plugin backup...');
                 if (error) {
                     this.log.error(`Error downloading file matterbridge.pluginstorage.zip: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send('Error downloading the matterbridge plugin storage file');
                 }
+                else {
+                    this.log.debug('Plugin storage matterbridge.pluginstorage.zip downloaded successfully');
+                }
             });
         });
         this.expressApp.get('/api/download-pluginconfig', async (req, res) => {
             this.log.debug('The frontend sent /api/download-pluginconfig');
             if (!this.validateReq(req, res))
                 return;
-            await createZip(path.join(os.tmpdir(), `matterbridge.pluginconfig.zip`), path.relative(process.cwd(), path.join(this.matterbridge.matterbridgeDirectory, '*.config.json')));
             res.download(path.join(os.tmpdir(), `matterbridge.pluginconfig.zip`), `matterbridge.pluginconfig.zip`, (error) => {
+                this.wssSendCloseSnackbarMessage('Creating config backup...');
                 if (error) {
                     this.log.error(`Error downloading file matterbridge.pluginconfig.zip: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send('Error downloading the matterbridge plugin config file');
                 }
-            });
-        });
-        this.expressApp.get('/api/download-backup', async (req, res) => {
-            this.log.debug('The frontend sent /api/download-backup');
-            if (!this.validateReq(req, res))
-                return;
-            res.download(path.join(os.tmpdir(), `matterbridge.backup.zip`), `matterbridge.backup.zip`, (error) => {
-                if (error) {
-                    this.log.error(`Error downloading file matterbridge.backup.zip: ${error instanceof Error ? error.message : error}`);
-                    res.status(500).send(`Error downloading file matterbridge.backup.zip: ${error instanceof Error ? error.message : error}`);
+                else {
+                    this.log.debug('Plugin config matterbridge.pluginconfig.zip downloaded successfully');
                 }
             });
         });
@@ -1231,11 +1244,7 @@ export class Frontend extends EventEmitter {
         };
         try {
             data = JSON.parse(message.toString());
-            if (!isValidNumber(data.id) ||
-                !isValidString(data.dst) ||
-                !isValidString(data.src) ||
-                !isValidString(data.method) ||
-                data.dst !== 'Matterbridge') {
+            if (!isValidNumber(data.id) || !isValidString(data.dst) || !isValidString(data.src) || !isValidString(data.method) || data.dst !== 'Matterbridge') {
                 this.log.error(`Invalid message from websocket client: ${debugStringify(data)}`);
                 sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: 'Invalid message' });
                 return;
@@ -1490,12 +1499,35 @@ export class Frontend extends EventEmitter {
                 sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
             }
             else if (data.method === '/api/create-backup') {
-                this.wssSendSnackbarMessage('Creating backup...', 0);
-                this.log.notice(`Creating the backup...`);
-                await createZip(path.join(os.tmpdir(), `matterbridge.backup.zip`), path.join(this.matterbridge.matterbridgeDirectory), path.join(this.matterbridge.matterbridgePluginDirectory), path.join(this.matterbridge.matterbridgeCertDirectory));
-                this.log.notice(`Backup ready to be downloaded.`);
-                this.wssSendCloseSnackbarMessage('Creating backup...');
-                this.wssSendSnackbarMessage('Backup ready to be downloaded', 10);
+                this.wssSendSnackbarMessage('Creating matterbridge backup...', 0);
+                this.log.notice(`Creating matterbridge backup...`);
+                this.zip('zip', path.join(os.tmpdir(), `matterbridge.backup.zip`), [this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbridgePluginDirectory, this.matterbridge.matterbridgeCertDirectory], '');
+                sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
+            }
+            else if (data.method === '/api/create-matterbridge-storage-backup') {
+                this.wssSendSnackbarMessage('Creating matterbridge storage backup...', 0);
+                this.log.notice(`Creating matterbridge storage backup...`);
+                this.zip('zip', path.join(os.tmpdir(), `matterbridge.${NODE_STORAGE_DIR}.zip`), [path.join(this.matterbridge.matterbridgeDirectory, NODE_STORAGE_DIR)], '');
+                sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
+            }
+            else if (data.method === '/api/create-matter-storage-backup') {
+                this.wssSendSnackbarMessage('Creating matter storage backup...', 0);
+                this.log.notice(`Creating matter storage backup...`);
+                this.zip('zip', path.join(os.tmpdir(), `matterbridge.${MATTER_STORAGE_NAME}.zip`), [path.join(this.matterbridge.matterbridgeDirectory, MATTER_STORAGE_NAME)], '');
+                sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
+            }
+            else if (data.method === '/api/create-plugin-backup') {
+                this.wssSendSnackbarMessage('Creating plugin backup...', 0);
+                this.log.notice(`Creating plugin backup...`);
+                this.zip('zip', path.join(os.tmpdir(), `matterbridge.pluginstorage.zip`), [this.matterbridge.matterbridgePluginDirectory], '');
+                sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
+            }
+            else if (data.method === '/api/create-config-backup') {
+                this.wssSendSnackbarMessage('Creating config backup...', 0);
+                this.log.notice(`Creating config backup...`);
+                const plugins = (await this.server.fetch({ type: 'plugins_storagepluginarray', src: this.server.name, dst: 'plugins' }, 5000)).result.plugins || [];
+                const pluginsPaths = plugins.map((p) => path.join(this.matterbridge.matterbridgeDirectory, p.name + '.config.json'));
+                this.zip('zip', path.join(os.tmpdir(), `matterbridge.pluginconfig.zip`), pluginsPaths, '');
                 sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
             }
             else if (data.method === '/api/unregister') {
@@ -2120,4 +2152,21 @@ export class Frontend extends EventEmitter {
             }
         });
     }
+    zip(command, archivePath, sourcePaths, destinationPath) {
+        this.server.request({
+            type: 'manager_run',
+            src: 'frontend',
+            dst: 'manager',
+            params: {
+                name: 'ArchiveCommand',
+                workerData: {
+                    threadName: 'ArchiveCommand',
+                    command,
+                    archivePath,
+                    sourcePaths,
+                    destinationPath,
+                },
+            },
+        });
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@matterbridge/core",
-  "version": "3.6.2-dev-20260314-f95be8a",
+  "version": "3.6.2-dev-20260315-d23fd18",
   "description": "Matterbridge core library",
   "author": "https://github.com/Luligu",
   "homepage": "https://matterbridge.io/",
@@ -122,13 +122,11 @@
   ],
   "dependencies": {
     "@matter/main": "0.16.10",
-    "@matterbridge/dgram": "3.6.2-dev-20260314-f95be8a",
-    "@matterbridge/thread": "3.6.2-dev-20260314-f95be8a",
-    "@matterbridge/types": "3.6.2-dev-20260314-f95be8a",
-    "@matterbridge/utils": "3.6.2-dev-20260314-f95be8a",
-    "archiver": "7.0.1",
+    "@matterbridge/dgram": "3.6.2-dev-20260315-d23fd18",
+    "@matterbridge/thread": "3.6.2-dev-20260315-d23fd18",
+    "@matterbridge/types": "3.6.2-dev-20260315-d23fd18",
+    "@matterbridge/utils": "3.6.2-dev-20260315-d23fd18",
     "express": "5.2.1",
-    "glob": "13.0.6",
     "multer": "2.1.1",
     "node-ansi-logger": "3.2.0",
     "node-persist-manager": "2.0.1",