matterbridge 1.0.6 → 1.1.3

package/dist/matterbridge.d.ts

@@ -1,6 +1,26 @@
-/// <reference types="node" resolution-mode="require"/>
+/**
+ * This file contains the class Matterbridge.
+ *
+ * @file matterbridge.ts
+ * @author Luca Liguori
+ * @date 2023-12-29
+ * @version 1.1.1
+ *
+ * Copyright 2023, 2024 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 { MatterbridgeDevice } from './matterbridgeDevice.js';
-import EventEmitter from 'events';
 interface SystemInformation {
     ipv4Address: string;
     ipv6Address: string;
@@ -14,23 +34,21 @@ interface SystemInformation {
     freeMemory: string;
     systemUptime: string;
 }
-export interface MatterbridgeEvents {
-    shutdown: (reason: string) => void;
-    startAccessoryPlatform: (reason: string) => void;
-    startDynamicPlatform: (reason: string) => void;
-    registerDeviceAccessoryPlatform: (device: MatterbridgeDevice) => void;
-    registerDeviceDynamicPlatform: (device: MatterbridgeDevice) => void;
-}
-export declare class Matterbridge extends EventEmitter {
+/**
+ * Represents the Matterbridge application.
+ */
+export declare class Matterbridge {
     systemInformation: SystemInformation;
+    homeDirectory: string;
     rootDirectory: string;
+    matterbridgeDirectory: string;
     bridgeMode: 'bridge' | 'childbridge' | 'controller' | '';
     private log;
     private hasCleanupStarted;
     private registeredPlugins;
     private registeredDevices;
-    private storage;
-    private context;
+    private nodeStorage;
+    private nodeContext;
     private app;
     private storageManager;
     private matterbridgeContext;
@@ -39,32 +57,185 @@ export declare class Matterbridge extends EventEmitter {
     private matterAggregator;
     private commissioningServer;
     private commissioningController;
-    constructor();
-    private initialize;
+    private static instance;
+    private constructor();
+    /**
+     * Loads an instance of the Matterbridge class.
+     * If an instance already exists, an error will be thrown.
+     * @returns The loaded instance of the Matterbridge class.
+     * @throws Error if an instance of Matterbridge already exists.
+     */
+    static loadInstance(): Promise<Matterbridge>;
+    /**
+     * Initializes the Matterbridge application.
+     *
+     * @remarks
+     * This method performs the necessary setup and initialization steps for the Matterbridge application.
+     * It displays the help information if the 'help' parameter is provided, sets up the logger, checks the
+     * node version, registers signal handlers, initializes storage, and parses the command line.
+     *
+     * @returns A Promise that resolves when the initialization is complete.
+     */
+    initialize(): Promise<void>;
+    /**
+     * Parses the command line arguments and performs the corresponding actions.
+     * @private
+     * @returns {Promise<void>} A promise that resolves when the command line arguments have been processed.
+     */
     private parseCommandLine;
-    emit<Event extends keyof MatterbridgeEvents>(event: Event, ...args: Parameters<MatterbridgeEvents[Event]>): boolean;
-    on<Event extends keyof MatterbridgeEvents>(event: Event, listener: MatterbridgeEvents[Event]): this;
+    /**
+     * Loads a plugin from the specified package.json file path.
+     * @param packageJsonPath - The path to the package.json file of the plugin.
+     * @param mode - The mode of operation. Possible values are 'load', 'add', 'remove', 'enable', 'disable'.
+     * @returns A Promise that resolves when the plugin is loaded successfully, or rejects with an error if loading fails.
+     */
     private loadPlugin;
+    /**
+     * Registers the signal handlers for SIGINT and SIGTERM.
+     * When either of these signals are received, the cleanup method is called with an appropriate message.
+     */
     private registerSignalHandlers;
+    /**
+     * Performs cleanup operations before shutting down Matterbridge.
+     * @param message - The reason for the cleanup.
+     */
     private cleanup;
+    /**
+     * Sets the reachable attribute of a device.
+     *
+     * @param device - The device for which to set the reachable attribute.
+     * @param reachable - The value to set for the reachable attribute.
+     */
+    private setReachableAttribute;
+    /**
+     * Adds a device to the Matterbridge.
+     * @param pluginName - The name of the plugin.
+     * @param device - The device to be added.
+     */
     addDevice(pluginName: string, device: MatterbridgeDevice): Promise<void>;
+    /**
+     * Adds a bridged device to the Matterbridge.
+     * @param pluginName - The name of the plugin.
+     * @param device - The bridged device to add.
+     */
     addBridgedDevice(pluginName: string, device: MatterbridgeDevice): 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').
+     * @param {string} storageName - The name of the storage file.
+     * @returns {Promise<void>} - A promise that resolves when the storage process is started.
+     */
     private startStorage;
+    /**
+     * Makes a backup copy of the specified JSON storage file.
+     *
+     * @param storageName - The name of the JSON storage file to be backed up.
+     * @param backupName - The name of the backup file to be created.
+     */
     private backupJsonStorage;
+    /**
+     * Stops the storage.
+     * @returns {Promise<void>} A promise that resolves when the storage is stopped.
+     */
     private stopStorage;
+    /**
+     * Starts the Matterbridge based on the bridge mode.
+     * If the bridge mode is 'bridge', it creates a commissioning server, matter aggregator,
+     * and starts the matter server.
+     * If the bridge mode is 'childbridge', it starts the plugins, creates commissioning servers,
+     * and starts the matter server when all plugins are loaded and started.
+     * @private
+     * @returns {Promise<void>} A promise that resolves when the Matterbridge is started.
+     */
     private startMatterBridge;
+    private startMatterServer;
+    /**
+     * Imports the commissioning server context for a specific plugin and device.
+     * @param pluginName - The name of the plugin.
+     * @param device - The MatterbridgeDevice object representing the device.
+     * @returns The commissioning server context.
+     * @throws Error if the BasicInformationCluster is not found.
+     */
+    private importCommissioningServerContext;
+    /**
+     * Creates a commissioning server storage context.
+     *
+     * @param pluginName - The name of the plugin.
+     * @param deviceName - The name of the device.
+     * @param deviceType - The type of the device.
+     * @param vendorId - The vendor ID.
+     * @param vendorName - The vendor name.
+     * @param productId - The product ID.
+     * @param productName - The product name.
+     * @param serialNumber - The serial number of the device (optional).
+     * @param uniqueId - The unique ID of the device (optional).
+     * @param softwareVersion - The software version of the device (optional).
+     * @param softwareVersionString - The software version string of the device (optional).
+     * @param hardwareVersion - The hardware version of the device (optional).
+     * @param hardwareVersionString - The hardware version string of the device (optional).
+     * @returns The storage context for the commissioning server.
+     */
+    private createCommissioningServerContext;
+    /**
+     * Shows the commissioning QR code for a given commissioning server, storage context, and name.
+     * If any of the parameters are missing, the method returns early.
+     * If the commissioning server is not commissioned, it logs the QR code and pairing code.
+     * If the commissioning server is already commissioned, it waits for controllers to connect.
+     * If the bridge mode is 'childbridge', it sets the 'paired' property of the plugin to true.
+     *
+     * @param commissioningServer - The commissioning server to show the QR code for.
+     * @param storageContext - The storage context to store the pairing codes.
+     * @param name - The name of the commissioning server.
+     */
     private showCommissioningQRCode;
-    private createMatterCommisioningServer;
+    /**
+     * Finds a plugin by its name.
+     *
+     * @param pluginName - The name of the plugin to find.
+     * @returns The found plugin, or undefined if not found.
+     */
+    private findPlugin;
+    /**
+     * Creates a matter commissioning server.
+     *
+     * @param {StorageContext} context - The storage context.
+     * @param {string} name - The name of the commissioning server.
+     * @returns {CommissioningServer} The created commissioning server.
+     */
+    private createCommisioningServer;
+    /**
+     * Creates a Matter server using the provided storage manager.
+     * @param storageManager The storage manager to be used by the Matter server.
+     *
+     */
     private createMatterServer;
+    /**
+     * Creates a Matter Aggregator.
+     * @param {StorageContext} context - The storage context.
+     * @returns {Aggregator} - The created Matter Aggregator.
+     */
     private createMatterAggregator;
+    /**
+     * Stops the Matter server and associated controllers.
+     */
     private stopMatter;
+    /**
+     * Logs the node and system information.
+     */
     private logNodeAndSystemInfo;
+    private getBaseRegisteredPlugin;
     /**
      * Initializes the frontend of Matterbridge.
      *
      * @param port The port number to run the frontend server on. Default is 3000.
      */
     initializeFrontend(port?: number): Promise<void>;
+    /**
+     * Retrieves the cluster text from a given device.
+     * @param device - The MatterbridgeDevice object.
+     * @returns The attributes of the cluster servers in the device.
+     */
+    private getClusterTextFromDevice;
 }
 export {};
 //# sourceMappingURL=matterbridge.d.ts.map

package/dist/matterbridge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"matterbridge.d.ts","sourceRoot":"","sources":["../src/matterbridge.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAwB7D,OAAO,YAAY,MAAM,QAAQ,CAAC;AAsClC,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;AAGD,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,sBAAsB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACjD,oBAAoB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/C,+BAA+B,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACtE,6BAA6B,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;CACrE;AAED,qBAAa,YAAa,SAAQ,YAAY;IACrC,iBAAiB,EAAE,iBAAiB,CAYzC;IACK,aAAa,EAAG,MAAM,CAAC;IACvB,UAAU,EAAE,QAAQ,GAAG,aAAa,GAAG,YAAY,GAAG,EAAE,CAAM;IAErE,OAAO,CAAC,GAAG,CAAa;IACxB,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,OAAO,CAA6C;IAC5D,OAAO,CAAC,OAAO,CAAsC;IACrD,OAAO,CAAC,GAAG,CAAmB;IAE9B,OAAO,CAAC,cAAc,CAAkB;IACxC,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,uBAAuB,CAAkB;IAEjD,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,gBAAgB,CAAc;IACtC,OAAO,CAAC,mBAAmB,CAAuB;IAClD,OAAO,CAAC,uBAAuB,CAA2B;;YAyB5C,UAAU;YAaV,gBAAgB;IAmDrB,IAAI,CAAC,KAAK,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,GAAG,OAAO;IAKnH,EAAE,CAAC,KAAK,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,kBAAkB,CAAC,KAAK,CAAC,GAAG,IAAI;YAK9F,UAAU;IA2ExB,OAAO,CAAC,sBAAsB;YAUhB,OAAO;IA+Bf,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB;IA8BxD,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB;YAkBvD,YAAY;YAyBZ,iBAAiB;YAkBjB,WAAW;YAMX,iBAAiB;IAiH/B,OAAO,CAAC,uBAAuB;YAcjB,8BAA8B;YAgE9B,kBAAkB;YAKlB,sBAAsB;YAKtB,UAAU;IAUxB,OAAO,CAAC,oBAAoB;IAkE5B;;;;OAIG;IACG,kBAAkB,CAAC,IAAI,GAAE,MAAa;CA0D7C"}
+{"version":3,"file":"matterbridge.d.ts","sourceRoot":"","sources":["../src/matterbridge.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAsE7D,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;AAKD;;GAEG;AACH,qBAAa,YAAY;IAChB,iBAAiB,EAAE,iBAAiB,CAYzC;IACK,aAAa,EAAG,MAAM,CAAC;IACvB,aAAa,EAAG,MAAM,CAAC;IACvB,qBAAqB,EAAG,MAAM,CAAC;IAE/B,UAAU,EAAE,QAAQ,GAAG,aAAa,GAAG,YAAY,GAAG,EAAE,CAAM;IAErE,OAAO,CAAC,GAAG,CAAc;IACzB,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,WAAW,CAA6C;IAChE,OAAO,CAAC,WAAW,CAAsC;IACzD,OAAO,CAAC,GAAG,CAAmB;IAE9B,OAAO,CAAC,cAAc,CAAkB;IACxC,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,uBAAuB,CAAkB;IAEjD,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,gBAAgB,CAAc;IACtC,OAAO,CAAC,mBAAmB,CAAuB;IAClD,OAAO,CAAC,uBAAuB,CAA2B;IAE1D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAe;IAEtC,OAAO;IAIP;;;;;OAKG;WACU,YAAY;IAUzB;;;;;;;;;OASG;IACU,UAAU;IAoDvB;;;;OAIG;YACW,gBAAgB;IA6D9B;;;;;OAKG;YACW,UAAU;IA4FxB;;;OAGG;YACW,sBAAsB;IAUpC;;;OAGG;YACW,OAAO;IA6CrB;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAS7B;;;;OAIG;IACG,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB;IAyC9D;;;;OAIG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB;IA2BrE;;;;;OAKG;YACW,YAAY;IAyB1B;;;;;OAKG;YACW,iBAAiB;IAkB/B;;;OAGG;YACW,WAAW;IAMzB;;;;;;;;OAQG;YACW,iBAAiB;YA2HjB,iBAAiB;IAK/B;;;;;;OAMG;IACH,OAAO,CAAC,gCAAgC;IAwBxC;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,gCAAgC;IAmCxC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,uBAAuB;IAkB/B;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IASlB;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IA2GhC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAK1B;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAuC9B;;OAEG;YACW,UAAU;IAUxB;;OAEG;YACW,oBAAoB;IA+ElC,OAAO,CAAC,uBAAuB;IAkB/B;;;;OAIG;IACG,kBAAkB,CAAC,IAAI,GAAE,MAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAgH5D;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;CAsBjC"}