matterbridge 1.1.9 → 1.1.11

package/CHANGELOG.md

@@ -2,11 +2,28 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.1.11] - 2024-03-15
+
+### Added
+
+- [frontend]: Frontend got updated to 0.8.3.
+
+## [1.1.10] - 2024-03-15
+
+### Added
+
+- [matterbridge]: added unregisterAllDevices() to the platforms 
+- [matterbridge]: added unregisterDevice(device: MatterbridgeDevice) to the platforms
+- [frontend]: Enable and disable plugin are now available. Restart Matteerbridge after.
+- [frontend]: Frontend got updated to 0.8.2.
+
 ## [1.1.9] - 2024-03-15
 
 ### Added
 
+- [frontend]: Selecting a plugin in the home page show the corresponding QR code.
 - [frontend]: Settings page now controll the global logger level.
+- [frontend]: Restart from the header is available.
 - [frontend]: Frontend got updated to 0.8.1.
 
 ## [1.1.8] - 2024-03-15

package/README.md

@@ -174,21 +174,37 @@ The easiest way is to clone:
 
 Then change the name, version, description and author in the package.json.
 
-Add your plugin logic in platform.ts:
+Add your plugin logic in platform.ts.
 
-### onStart(reason?: string)
+## MatterbridgeDynamicPlatform and MatterbridgeAccessoryPlatform api
+
+### async onStart(reason?: string)
 The method onStart() is where you have to create your MatterbridgeDevice and add all needed clusters and command handlers. 
 
 The MatterbridgeDevice class has the create cluster methods already done and all command handlers needed (see plugin examples).
 
 The method is called when Matterbridge load the plugin.
 
-### onConfigure()
+### async onConfigure()
 The method onConfigure() is where you can configure or initialize your device. 
 
 The method is called when the platform is commissioned.
 
-### onShutdown(reason?: string)
+### async onShutdown(reason?: string)
 The method onShutdown() is where you have to eventually cleanup some resources. 
 
 The method is called when Matterbridge is shutting down.
+
+### async registerDevice(device: MatterbridgeDevice)
+After you created your device, add it to the platform.
+
+### async unregisterDevice(device: MatterbridgeDevice)
+You can unregister one or more device.
+
+### async unregisterAllDevices()
+You can unregister all devices you added.
+
+It can me be useful to call this method from onShutdown if you don't want to keep all the devices.
+
+## MatterbridgeDevice api
+

package/dist/cli.js

@@ -21,17 +21,33 @@
  * See the License for the specific language governing permissions and
  * limitations under the License. *
  */
+/* eslint-disable no-console */
+//import wtf from 'wtfnode';
 import { Matterbridge } from './matterbridge.js';
+let instance;
 async function main() {
-    // eslint-disable-next-line no-console
     console.log('CLI: Matterbridge.loadInstance() called');
-    await Matterbridge.loadInstance(true);
-    // eslint-disable-next-line no-console
+    instance = await Matterbridge.loadInstance(true);
+    registerHandlers();
     console.log('CLI: Matterbridge.loadInstance() exited');
 }
+function registerHandlers() {
+    instance.on('shutdown', async () => shutdown());
+    instance.on('restart', async () => restart());
+}
+async function shutdown() {
+    console.log('CLI: received shutdown event, exiting...');
+    //wtf.dump();
+    process.exit(0);
+}
+async function restart() {
+    console.log('CLI: received restart event, loading...');
+    //wtf.dump();
+    instance = await Matterbridge.loadInstance(true);
+    registerHandlers();
+}
 process.title = 'matterbridge';
 main().catch((error) => {
-    // eslint-disable-next-line no-console
     console.error(`CLI: Matterbridge.loadInstance() failed with error: ${error}`);
 });
 //# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,KAAK,UAAU,IAAI;IACjB,sCAAsC;IACtC,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;IACvD,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACtC,sCAAsC;IACtC,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;AACzD,CAAC;AAED,OAAO,CAAC,KAAK,GAAG,cAAc,CAAC;AAE/B,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,sCAAsC;IACtC,OAAO,CAAC,KAAK,CAAC,uDAAuD,KAAK,EAAE,CAAC,CAAC;AAChF,CAAC,CAAC,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,+BAA+B;AAC/B,4BAA4B;AAC5B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,IAAI,QAAkC,CAAC;AAEvC,KAAK,UAAU,IAAI;IACjB,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;IACvD,QAAQ,GAAG,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACjD,gBAAgB,EAAE,CAAC;IACnB,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,gBAAgB;IACvB,QAAS,CAAC,EAAE,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;IACjD,QAAS,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;AACjD,CAAC;AAED,KAAK,UAAU,QAAQ;IACrB,OAAO,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAC;IACxD,aAAa;IACb,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,KAAK,UAAU,OAAO;IACpB,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;IACvD,aAAa;IACb,QAAQ,GAAG,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACjD,gBAAgB,EAAE,CAAC;AACrB,CAAC;AAED,OAAO,CAAC,KAAK,GAAG,cAAc,CAAC;AAE/B,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,uDAAuD,KAAK,EAAE,CAAC,CAAC;AAChF,CAAC,CAAC,CAAC"}

package/dist/matterbridge.d.ts

@@ -20,7 +20,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License. *
  */
+/// <reference types="node" resolution-mode="require"/>
 import { MatterbridgeDevice } from './matterbridgeDevice.js';
+import EventEmitter from 'events';
 interface SystemInformation {
     ipv4Address: string;
     ipv6Address: string;
@@ -37,15 +39,26 @@ interface SystemInformation {
 /**
  * Represents the Matterbridge application.
  */
-export declare class Matterbridge {
+export declare class Matterbridge extends EventEmitter {
     systemInformation: SystemInformation;
+    matterbridgeInformation: {
+        homeDirectory: string;
+        rootDirectory: string;
+        matterbridgeDirectory: string;
+        matterbridgePluginDirectory: string;
+        globalModulesDirectory: string;
+        matterbridgeVersion: string;
+        matterbridgeLatestVersion: string;
+        bridgeMode: string;
+        debugEnabled: boolean;
+    };
     homeDirectory: string;
     rootDirectory: string;
     matterbridgeDirectory: string;
     matterbridgePluginDirectory: string;
+    globalModulesDirectory: string;
     matterbridgeVersion: string;
     matterbridgeLatestVersion: string;
-    globalModulesDir: string;
     bridgeMode: 'bridge' | 'childbridge' | 'controller' | '';
     debugEnabled: boolean;
     private log;
@@ -82,6 +95,13 @@ export declare class Matterbridge {
      * @returns A Promise that resolves when the initialization is complete.
      */
     initialize(): Promise<void>;
+    /**
+     * Spawns a child process with the given command and arguments.
+     * @param command - The command to execute.
+     * @param args - The arguments to pass to the command (default: []).
+     * @returns A promise that resolves when the child process exits successfully, or rejects if there is an error.
+     */
+    private spawnCommand;
     /**
      * Parses the command line arguments and performs the corresponding actions.
      * @private
@@ -131,6 +151,14 @@ export declare class Matterbridge {
      * @returns {Promise<void>} - A promise that resolves when the storage process is started.
      */
     addBridgedDevice(pluginName: string, device: MatterbridgeDevice): Promise<void>;
+    removeBridgedDevice(pluginName: string, device: MatterbridgeDevice): Promise<void>;
+    /**
+     * Removes all bridged devices associated with a specific plugin.
+     *
+     * @param pluginName - The name of the plugin.
+     * @returns A promise that resolves when all devices have been removed.
+     */
+    removeAllBridgedDevices(pluginName: string): Promise<void>;
     /**
      * Starts the storage process based on the specified storage type and name.
      * @param {string} storageType - The type of storage to start (e.g., 'disk', 'json').
@@ -241,6 +269,11 @@ export declare class Matterbridge {
      * @returns A Promise that resolves to the latest version of the package.
      */
     private getLatestVersion;
+    /**
+     * Retrieves the path to the global Node.js modules directory.
+     * @returns A promise that resolves to the path of the global Node.js modules directory.
+     */
+    private getGlobalNodeModules;
     /**
      * Logs the node and system information.
      */

package/dist/matterbridge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"matterbridge.d.ts","sourceRoot":"","sources":["../src/matterbridge.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,kBAAkB,EAAgC,MAAM,yBAAyB,CAAC;AA4E3F,UAAU,iBAAiB;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB;AAMD;;GAEG;AACH,qBAAa,YAAY;IAChB,iBAAiB,EAAE,iBAAiB,CAYzC;IACK,aAAa,EAAE,MAAM,CAAM;IAC3B,aAAa,EAAE,MAAM,CAAM;IAC3B,qBAAqB,EAAE,MAAM,CAAM;IACnC,2BAA2B,EAAE,MAAM,CAAM;IACzC,mBAAmB,EAAE,MAAM,CAAM;IACjC,yBAAyB,EAAE,MAAM,CAAM;IACvC,gBAAgB,EAAE,MAAM,CAAM;IAE9B,UAAU,EAAE,QAAQ,GAAG,aAAa,GAAG,YAAY,GAAG,EAAE,CAAM;IAC9D,YAAY,UAAS;IAE5B,OAAO,CAAC,GAAG,CAAc;IACzB,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,WAAW,CAA0B;IAC7C,OAAO,CAAC,UAAU,CAA8B;IAChD,OAAO,CAAC,aAAa,CAAqB;IAE1C,OAAO,CAAC,cAAc,CAA6B;IACnD,OAAO,CAAC,mBAAmB,CAA6B;IACxD,OAAO,CAAC,uBAAuB,CAA6B;IAE5D,OAAO,CAAC,YAAY,CAA2B;IAC/C,OAAO,CAAC,gBAAgB,CAAyB;IACjD,OAAO,CAAC,mBAAmB,CAAkC;IAC7D,OAAO,CAAC,uBAAuB,CAAsC;IAErE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAe;IAEtC,OAAO;IAIP;;;;OAIG;WACU,YAAY,CAAC,UAAU,UAAQ;IAa5C;;;;;;;;;OASG;IACU,UAAU;IAkEvB;;;;OAIG;YACW,gBAAgB;YAkFhB,iBAAiB;IAoC/B;;;;;OAKG;YACW,kBAAkB;IA8DhC;;;OAGG;YACW,sBAAsB;IAUpC;;OAEG;YACW,cAAc;IAQ5B;;;OAGG;YACW,OAAO;IA6ErB;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAS7B;;;;;OAKG;IACG,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA+B9E;;;;;OAKG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA+BrF;;;;;OAKG;YACW,YAAY;IA0B1B;;;;;OAKG;YACW,iBAAiB;IAkB/B;;;OAGG;YACW,WAAW;YASX,qBAAqB;YA+CrB,WAAW;YA6BX,eAAe;YA4Bf,UAAU;IA+CxB;;;;;;;;OAQG;YACW,iBAAiB;YA0IjB,iBAAiB;IAW/B;;;;;;OAMG;IACH,OAAO,CAAC,gCAAgC;IAwBxC;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,gCAAgC;IAuCxC;;;;;;;;;;OAUG;YACW,uBAAuB;IA4CrC;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IASlB;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IAgHhC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAM1B;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAuC9B;;OAEG;YACW,UAAU;IAcxB;;;;OAIG;YACW,gBAAgB;IAY9B;;OAEG;YACW,oBAAoB;IAgIlC,OAAO,CAAC,wBAAwB;IAqBhC,OAAO,CAAC,wBAAwB;IAkBhC;;;;OAIG;IACG,kBAAkB,CAAC,IAAI,GAAE,MAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IA0J5D;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;CAsBjC"}
+{"version":3,"file":"matterbridge.d.ts","sourceRoot":"","sources":["../src/matterbridge.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;AAEH,OAAO,EAAE,kBAAkB,EAAgC,MAAM,yBAAyB,CAAC;AAQ3F,OAAO,YAAY,MAAM,QAAQ,CAAC;AAkElC,UAAU,iBAAiB;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB;AAMD;;GAEG;AACH,qBAAa,YAAa,SAAQ,YAAY;IACrC,iBAAiB,EAAE,iBAAiB,CAYzC;IAEK,uBAAuB;;;;;;;;;;MAU5B;IAEK,aAAa,EAAE,MAAM,CAAM;IAC3B,aAAa,EAAE,MAAM,CAAM;IAC3B,qBAAqB,EAAE,MAAM,CAAM;IACnC,2BAA2B,EAAE,MAAM,CAAM;IACzC,sBAAsB,EAAE,MAAM,CAAM;IACpC,mBAAmB,EAAE,MAAM,CAAM;IACjC,yBAAyB,EAAE,MAAM,CAAM;IAEvC,UAAU,EAAE,QAAQ,GAAG,aAAa,GAAG,YAAY,GAAG,EAAE,CAAM;IAC9D,YAAY,UAAS;IAE5B,OAAO,CAAC,GAAG,CAAc;IACzB,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,WAAW,CAA0B;IAC7C,OAAO,CAAC,UAAU,CAA8B;IAChD,OAAO,CAAC,aAAa,CAAqB;IAE1C,OAAO,CAAC,cAAc,CAA6B;IACnD,OAAO,CAAC,mBAAmB,CAA6B;IACxD,OAAO,CAAC,uBAAuB,CAA6B;IAE5D,OAAO,CAAC,YAAY,CAA2B;IAC/C,OAAO,CAAC,gBAAgB,CAAyB;IACjD,OAAO,CAAC,mBAAmB,CAAkC;IAC7D,OAAO,CAAC,uBAAuB,CAAsC;IAErE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA2B;IAElD,OAAO;IAKP;;;;OAIG;WACU,YAAY,CAAC,UAAU,UAAQ;IAa5C;;;;;;;;;OASG;IACU,UAAU;IAuEvB;;;;;OAKG;YACW,YAAY;IAmC1B;;;;OAIG;YACW,gBAAgB;YAoGhB,iBAAiB;IAoC/B;;;;;OAKG;YACW,kBAAkB;IA8DhC;;;OAGG;YACW,sBAAsB;IAUpC;;OAEG;YACW,cAAc;IAQ5B;;;OAGG;YACW,OAAO;IAwFrB;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAS7B;;;;;OAKG;IACG,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA+B9E;;;;;OAKG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA+B/E,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuDxF;;;;;OAKG;IACG,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBhE;;;;;OAKG;YACW,YAAY;IA0B1B;;;;;OAKG;YACW,iBAAiB;IAkB/B;;;OAGG;YACW,WAAW;YASX,qBAAqB;YA+CrB,WAAW;YA6BX,eAAe;YA4Bf,UAAU;IA+CxB;;;;;;;;OAQG;YACW,iBAAiB;YA2JjB,iBAAiB;IAW/B;;;;;;OAMG;IACH,OAAO,CAAC,gCAAgC;IAwBxC;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,gCAAgC;IAuCxC;;;;;;;;;;OAUG;YACW,uBAAuB;IA4CrC;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IASlB;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IAmHhC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAM1B;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAuC9B;;OAEG;YACW,UAAU;IAcxB;;;;OAIG;YACW,gBAAgB;IAY9B;;;OAGG;YACW,oBAAoB;IAYlC;;OAEG;YACW,oBAAoB;IAuIlC,OAAO,CAAC,wBAAwB;IAqBhC,OAAO,CAAC,wBAAwB;IAkBhC;;;;OAIG;IACG,kBAAkB,CAAC,IAAI,GAAE,MAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAwM5D;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;CAsBjC"}