matterbridge 3.2.4-dev-20250828-cf98212 → 3.2.4

package/dist/matterbridgeTypes.d.ts

@@ -0,0 +1,198 @@
+/**
+ * This file contains the types for Matterbridge.
+ *
+ * @file matterbridgeTypes.ts
+ * @author Luca Liguori
+ * @created 2024-07-12
+ * @version 1.0.2
+ * @license Apache-2.0
+ *
+ * Copyright 2023, 2024, 2025 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 { NodeStorage } from 'node-persist-manager';
+import { LogLevel } from 'node-ansi-logger';
+import { FabricIndex, VendorId, StorageContext, ServerNode, EndpointNumber, Endpoint as EndpointNode } from '@matter/main';
+import { AggregatorEndpoint } from '@matter/main/endpoints/aggregator';
+import { MatterbridgePlatform, PlatformConfig, PlatformSchema } from './matterbridgePlatform.js';
+import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
+export declare const plg = "\u001B[38;5;33m";
+export declare const dev = "\u001B[38;5;79m";
+export declare const typ = "\u001B[38;5;207m";
+export interface RegisteredPlugin extends BaseRegisteredPlugin {
+    nodeContext?: NodeStorage;
+    storageContext?: StorageContext;
+    serverNode?: ServerNode<ServerNode.RootEndpoint>;
+    aggregatorNode?: EndpointNode<AggregatorEndpoint>;
+    device?: MatterbridgeEndpoint;
+    platform?: MatterbridgePlatform;
+    reachabilityTimeout?: NodeJS.Timeout;
+}
+export interface BaseRegisteredPlugin {
+    name: string;
+    version: string;
+    description: string;
+    author: string;
+    path: string;
+    type: string;
+    latestVersion?: string;
+    devVersion?: string;
+    serialNumber?: string;
+    homepage?: string;
+    help?: string;
+    changelog?: string;
+    funding?: string;
+    locked?: boolean;
+    error?: boolean;
+    enabled?: boolean;
+    loaded?: boolean;
+    started?: boolean;
+    configured?: boolean;
+    restartRequired?: boolean;
+    registeredDevices?: number;
+    addedDevices?: number;
+    configJson?: PlatformConfig;
+    schemaJson?: PlatformSchema;
+    hasWhiteList?: boolean;
+    hasBlackList?: boolean;
+}
+export interface FrontendRegisteredPlugin extends BaseRegisteredPlugin {
+    paired?: boolean;
+    qrPairingCode?: string;
+    manualPairingCode?: string;
+    fabricInformations?: SanitizedExposedFabricInformation[];
+    sessionInformations?: SanitizedSession[];
+}
+export interface SystemInformation {
+    interfaceName: string;
+    macAddress: string;
+    ipv4Address: string;
+    ipv6Address: string;
+    nodeVersion: string;
+    hostname: string;
+    user: string;
+    osType: string;
+    osRelease: string;
+    osPlatform: string;
+    osArch: string;
+    totalMemory: string;
+    freeMemory: string;
+    systemUptime: string;
+    processUptime: string;
+    cpuUsage: string;
+    rss: string;
+    heapTotal: string;
+    heapUsed: string;
+}
+export interface MatterbridgeInformation {
+    homeDirectory: string;
+    rootDirectory: string;
+    matterbridgeDirectory: string;
+    matterbridgePluginDirectory: string;
+    matterbridgeCertDirectory: string;
+    globalModulesDirectory: string;
+    matterbridgeVersion: string;
+    matterbridgeLatestVersion: string;
+    matterbridgeDevVersion: string;
+    matterbridgeSerialNumber: string;
+    matterbridgeAdvertise: boolean | undefined;
+    matterbridgeEndAdvertise: boolean;
+    matterbridgePaired: boolean | undefined;
+    matterbridgeQrPairingCode: string | undefined;
+    matterbridgeManualPairingCode: string | undefined;
+    matterbridgeFabricInformations: SanitizedExposedFabricInformation[] | undefined;
+    matterbridgeSessionInformations: SanitizedSession[] | undefined;
+    frontendVersion?: string;
+    bridgeMode: string;
+    restartMode: string;
+    virtualMode: 'disabled' | 'outlet' | 'light' | 'switch' | 'mounted_switch';
+    readOnly: boolean;
+    shellyBoard: boolean;
+    shellySysUpdate: boolean;
+    shellyMainUpdate: boolean;
+    profile?: string;
+    loggerLevel: LogLevel;
+    fileLogger: boolean;
+    matterLoggerLevel: number;
+    matterFileLogger: boolean;
+    mattermdnsinterface: string | undefined;
+    matteripv4address: string | undefined;
+    matteripv6address: string | undefined;
+    matterPort: number;
+    matterDiscriminator: number | undefined;
+    matterPasscode: number | undefined;
+    restartRequired: boolean;
+    fixedRestartRequired: boolean;
+    updateRequired: boolean;
+}
+export interface SanitizedExposedFabricInformation {
+    fabricIndex: FabricIndex;
+    fabricId: string;
+    nodeId: string;
+    rootNodeId: string;
+    rootVendorId: VendorId;
+    rootVendorName: string;
+    label: string;
+}
+export interface SanitizedSession {
+    name: string;
+    nodeId: string;
+    peerNodeId: string;
+    fabric?: SanitizedExposedFabricInformation;
+    isPeerActive: boolean;
+    lastInteractionTimestamp: string;
+    lastActiveTimestamp: string;
+    numberOfActiveSubscriptions: number;
+}
+export interface ApiDevices {
+    pluginName: string;
+    type: string;
+    endpoint: EndpointNumber | undefined;
+    name: string;
+    serial: string;
+    productUrl: string;
+    configUrl?: string;
+    uniqueId: string;
+    reachable: boolean;
+    powerSource?: 'ac' | 'dc' | 'ok' | 'warning' | 'critical';
+    cluster: string;
+    matter?: ApiDevicesMatter;
+}
+export interface ApiDevicesMatter {
+    commissioned: boolean;
+    fabricInformations?: SanitizedExposedFabricInformation[];
+    sessionInformations?: SanitizedSession[];
+    qrPairingCode?: string;
+    manualPairingCode?: string;
+}
+export interface ApiClustersResponse {
+    plugin: string;
+    deviceName: string;
+    serialNumber: string;
+    endpoint: number;
+    deviceTypes: number[];
+    clusters: ApiClusters[];
+}
+export interface ApiClusters {
+    endpoint: string;
+    id: string;
+    deviceTypes: number[];
+    clusterName: string;
+    clusterId: string;
+    attributeName: string;
+    attributeId: string;
+    attributeValue: string;
+    attributeLocalValue: unknown;
+}
+//# sourceMappingURL=matterbridgeTypes.d.ts.map

package/dist/matterbridgeTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matterbridgeTypes.d.ts","sourceRoot":"","sources":["../src/matterbridgeTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,cAAc,EAAE,UAAU,EAAE,cAAc,EAAE,QAAQ,IAAI,YAAY,EAAE,MAAM,cAAc,CAAC;AAC3H,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAGvE,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACjG,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAGjE,eAAO,MAAM,GAAG,oBAAoB,CAAC;AACrC,eAAO,MAAM,GAAG,oBAAoB,CAAC;AACrC,eAAO,MAAM,GAAG,qBAAqB,CAAC;AAGtC,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IACjD,cAAc,CAAC,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAAC;IAClD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,mBAAmB,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;CACtC;AAGD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAGD,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IACzD,mBAAmB,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC1C;AAGD,MAAM,WAAW,iBAAiB;IAChC,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,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;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAGD,MAAM,WAAW,uBAAuB;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,2BAA2B,EAAE,MAAM,CAAC;IACpC,yBAAyB,EAAE,MAAM,CAAC;IAClC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,yBAAyB,EAAE,MAAM,CAAC;IAClC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,wBAAwB,EAAE,MAAM,CAAC;IACjC,qBAAqB,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3C,wBAAwB,EAAE,OAAO,CAAC;IAClC,kBAAkB,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC,yBAAyB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C,6BAA6B,EAAE,MAAM,GAAG,SAAS,CAAC;IAClD,8BAA8B,EAAE,iCAAiC,EAAE,GAAG,SAAS,CAAC;IAChF,+BAA+B,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAC;IAChE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,gBAAgB,CAAC;IAC3E,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,OAAO,CAAC;IACzB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,QAAQ,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,eAAe,EAAE,OAAO,CAAC;IACzB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,iCAAiC;IAChD,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,QAAQ,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,iCAAiC,CAAC;IAC3C,YAAY,EAAE,OAAO,CAAC;IACtB,wBAAwB,EAAE,MAAM,CAAC;IACjC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,2BAA2B,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,GAAG,UAAU,CAAC;IAC1D,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,OAAO,CAAC;IACtB,kBAAkB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IACzD,mBAAmB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;CAC9B"}

package/dist/matterbridgeTypes.js

@@ -1,3 +1,28 @@
+/**
+ * This file contains the types for Matterbridge.
+ *
+ * @file matterbridgeTypes.ts
+ * @author Luca Liguori
+ * @created 2024-07-12
+ * @version 1.0.2
+ * @license Apache-2.0
+ *
+ * Copyright 2023, 2024, 2025 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.
+ */
+// Default colors
 export const plg = '\u001B[38;5;33m';
 export const dev = '\u001B[38;5;79m';
 export const typ = '\u001B[38;5;207m';
+//# sourceMappingURL=matterbridgeTypes.js.map

package/dist/matterbridgeTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matterbridgeTypes.js","sourceRoot":"","sources":["../src/matterbridgeTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAaH,iBAAiB;AACjB,MAAM,CAAC,MAAM,GAAG,GAAG,iBAAiB,CAAC;AACrC,MAAM,CAAC,MAAM,GAAG,GAAG,iBAAiB,CAAC;AACrC,MAAM,CAAC,MAAM,GAAG,GAAG,kBAAkB,CAAC"}

package/dist/pluginManager.d.ts

@@ -0,0 +1,270 @@
+/**
+ * This file contains the Plugins class.
+ *
+ * @file plugins.ts
+ * @author Luca Liguori
+ * @created 2024-07-14
+ * @version 1.2.0
+ * @license Apache-2.0
+ *
+ * Copyright 2024, 2025, 2026 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 EventEmitter from 'node:events';
+import { LogLevel } from 'node-ansi-logger';
+import type { Matterbridge } from './matterbridge.js';
+import type { MatterbridgePlatform, PlatformConfig, PlatformSchema } from './matterbridgePlatform.js';
+import { RegisteredPlugin } from './matterbridgeTypes.js';
+interface PluginManagerEvents {
+    added: [name: string];
+    removed: [name: string];
+    loaded: [name: string];
+    enabled: [name: string];
+    disabled: [name: string];
+    installed: [name: string, version: string | undefined];
+    uninstalled: [name: string];
+    started: [name: string];
+    configured: [name: string];
+    shutdown: [name: string];
+}
+export declare class PluginManager extends EventEmitter<PluginManagerEvents> {
+    private _plugins;
+    private matterbridge;
+    private log;
+    constructor(matterbridge: Matterbridge);
+    get length(): number;
+    get size(): number;
+    has(name: string): boolean;
+    get(name: string): RegisteredPlugin | undefined;
+    set(plugin: RegisteredPlugin): RegisteredPlugin;
+    clear(): void;
+    array(): RegisteredPlugin[];
+    [Symbol.iterator](): MapIterator<RegisteredPlugin>;
+    forEach(callback: (plugin: RegisteredPlugin) => Promise<void>): Promise<void>;
+    set logLevel(logLevel: LogLevel);
+    /**
+     * Loads registered plugins from storage.
+     *
+     * This method retrieves an array of registered plugins from the storage and converts it
+     * into a map where the plugin names are the keys and the plugin objects are the values.
+     *
+     * @returns {Promise<RegisteredPlugin[]>} A promise that resolves to an array of registered plugins.
+     */
+    loadFromStorage(): Promise<RegisteredPlugin[]>;
+    /**
+     * Loads registered plugins from storage.
+     *
+     * This method retrieves an array of registered plugins from the storage and converts it
+     * into a map where the plugin names are the keys and the plugin objects are the values.
+     *
+     * @returns {Promise<RegisteredPlugin[]>} A promise that resolves to an array of registered plugins.
+     */
+    saveToStorage(): Promise<number>;
+    /**
+     * Resolves the name of a plugin by loading and parsing its package.json file.
+     *
+     * @param {string} pluginPath - The path to the plugin or the path to the plugin's package.json file.
+     * @returns {Promise<string | null>} A promise that resolves to the path of the plugin's package.json file or null if it could not be resolved.
+     */
+    resolve(pluginPath: string): Promise<string | null>;
+    /**
+     * Get the author of a plugin from its package.json.
+     *
+     * @param {Record<string, string | number | Record<string, string | number | object>>} packageJson - The package.json object of the plugin.
+     * @returns {string} The author of the plugin, or 'Unknown author' if not found.
+     */
+    getAuthor(packageJson: Record<string, string | number | Record<string, string | number | object>>): string;
+    /**
+     * Get the homepage of a plugin from its package.json.
+     *
+     * @param {Record<string, string | number | Record<string, string | number | object>>} packageJson - The package.json object of the plugin.
+     * @returns {string | undefined} The homepage of the plugin, or undefined if not found.
+     */
+    getHomepage(packageJson: Record<string, string | number | Record<string, string | number | object>>): string | undefined;
+    /**
+     * Get the help URL of a plugin from its package.json.
+     *
+     * @param {Record<string, string | number | Record<string, string | number | object>>} packageJson - The package.json object of the plugin.
+     * @returns {string | undefined} The URL to the help page or to the README file, or undefined if not found.
+     */
+    getHelp(packageJson: Record<string, string | number | Record<string, string | number | object>>): string | undefined;
+    /**
+     * Get the changelog URL of a plugin from its package.json.
+     *
+     * @param {Record<string, string | number | Record<string, string | number | object>>} packageJson - The package.json object of the plugin.
+     * @returns {string | undefined} The URL to the CHANGELOG file, or undefined if not found.
+     */
+    getChangelog(packageJson: Record<string, string | number | Record<string, string | number | object>>): string | undefined;
+    /**
+     * Get the first funding URL(s) of a plugin from its package.json.
+     *
+     * @param {Record<string, any>} packageJson - The package.json object of the plugin.
+     * @returns {string | undefined} The first funding URLs, or undefined if not found.
+     */
+    getFunding(packageJson: Record<string, any>): string | undefined;
+    /**
+     * Loads and parse the plugin package.json and returns it.
+     *
+     * @param {RegisteredPlugin} plugin - The plugin to load the package from.
+     * @returns {Promise<Record<string, string | number | object> | null>} A promise that resolves to the parsed package.json object or null if it could not be parsed.
+     */
+    parse(plugin: RegisteredPlugin): Promise<Record<string, string | number | object> | null>;
+    /**
+     * Enables a plugin by its name or path.
+     *
+     * This method enables a plugin by setting its `enabled` property to `true` and saving the updated
+     * plugin information to storage. It first checks if the plugin is already registered in the `_plugins` map.
+     * If not, it attempts to resolve the plugin's `package.json` file to retrieve its name and enable it.
+     *
+     * @param {string} nameOrPath - The name or path of the plugin to enable.
+     * @returns {Promise<RegisteredPlugin | null>} A promise that resolves to the enabled plugin object, or null if the plugin could not be enabled.
+     */
+    enable(nameOrPath: string): Promise<RegisteredPlugin | null>;
+    /**
+     * Enables a plugin by its name or path.
+     *
+     * This method enables a plugin by setting its `enabled` property to `true` and saving the updated
+     * plugin information to storage. It first checks if the plugin is already registered in the `_plugins` map.
+     * If not, it attempts to resolve the plugin's `package.json` file to retrieve its name and enable it.
+     *
+     * @param {string} nameOrPath - The name or path of the plugin to enable.
+     * @returns {Promise<RegisteredPlugin | null>} A promise that resolves to the enabled plugin object, or null if the plugin could not be enabled.
+     */
+    disable(nameOrPath: string): Promise<RegisteredPlugin | null>;
+    /**
+     * Removes a plugin by its name or path.
+     *
+     * This method removes a plugin from the `_plugins` map and saves the updated plugin information to storage.
+     * It first checks if the plugin is already registered in the `_plugins` map. If not, it attempts to resolve
+     * the plugin's `package.json` file to retrieve its name and remove it.
+     *
+     * @param {string} nameOrPath - The name or path of the plugin to remove.
+     * @returns {Promise<RegisteredPlugin | null>} A promise that resolves to the removed plugin object, or null if the plugin could not be removed.
+     */
+    remove(nameOrPath: string): Promise<RegisteredPlugin | null>;
+    /**
+     * Adds a plugin by its name or path.
+     *
+     * This method adds a plugin to the plugins map and saves the updated plugin information to storage.
+     * It first resolves the plugin's `package.json` file to retrieve its details. If the plugin is already
+     * registered, it logs an info message and returns null. Otherwise, it registers the plugin, enables it,
+     * and saves the updated plugin information to storage.
+     *
+     * @param {string} nameOrPath - The name or path of the plugin to add.
+     * @returns {Promise<RegisteredPlugin | null>} A promise that resolves to the added plugin object, or null if the plugin could not be added.
+     */
+    add(nameOrPath: string): Promise<RegisteredPlugin | null>;
+    /**
+     * Loads a plugin and returns the corresponding MatterbridgePlatform instance.
+     *
+     * @param {RegisteredPlugin} plugin - The plugin to load.
+     * @param {boolean} start - Optional flag indicating whether to start the plugin after loading. Default is false.
+     * @param {string} message - Optional message to pass to the plugin when starting.
+     * @param {boolean} configure - Optional flag indicating whether to configure the plugin after loading. Default is false.
+     * @returns {Promise<MatterbridgePlatform | undefined>} A Promise that resolves to the loaded MatterbridgePlatform instance or undefined.
+     */
+    load(plugin: RegisteredPlugin, start?: boolean, message?: string, configure?: boolean): Promise<MatterbridgePlatform | undefined>;
+    /**
+     * Starts a plugin.
+     *
+     * @param {RegisteredPlugin} plugin - The plugin to start.
+     * @param {string} [message] - Optional message to pass to the plugin's onStart method.
+     * @param {boolean} [configure] - Indicates whether to configure the plugin after starting (default false).
+     * @returns {Promise<RegisteredPlugin | undefined>} A promise that resolves when the plugin is started successfully, or rejects with an error if starting the plugin fails.
+     */
+    start(plugin: RegisteredPlugin, message?: string, configure?: boolean): Promise<RegisteredPlugin | undefined>;
+    /**
+     * Configures a plugin.
+     *
+     * @param {RegisteredPlugin} plugin - The plugin to configure.
+     * @returns {Promise<RegisteredPlugin | undefined>} A promise that resolves when the plugin is configured successfully, or rejects with an error if configuration fails.
+     */
+    configure(plugin: RegisteredPlugin): Promise<RegisteredPlugin | undefined>;
+    /**
+     * Shuts down a plugin.
+     *
+     * This method shuts down a plugin by calling its `onShutdown` method and resetting its state.
+     * It logs the shutdown process and optionally removes all devices associated with the plugin.
+     *
+     * @param {RegisteredPlugin} plugin - The plugin to shut down.
+     * @param {string} [reason] - The reason for shutting down the plugin.
+     * @param {boolean} [removeAllDevices] - Whether to remove all devices associated with the plugin.
+     * @param {boolean} [force] - Whether to force the shutdown even if the plugin is not loaded or started.
+     * @returns {Promise<RegisteredPlugin | undefined>} A promise that resolves to the shut down plugin object, or undefined if the shutdown failed.
+     */
+    shutdown(plugin: RegisteredPlugin, reason?: string, removeAllDevices?: boolean, force?: boolean): Promise<RegisteredPlugin | undefined>;
+    /**
+     * Loads the configuration for a plugin.
+     * If the configuration file exists, it reads the file and returns the parsed JSON data.
+     * If the configuration file does not exist, it creates a new file with default configuration and returns it.
+     * If any error occurs during file access or creation, it logs an error and return un empty config.
+     *
+     * @param {RegisteredPlugin} plugin - The plugin for which to load the configuration.
+     * @returns {Promise<PlatformConfig>} A promise that resolves to the loaded or created configuration.
+     */
+    loadConfig(plugin: RegisteredPlugin): Promise<PlatformConfig>;
+    /**
+     * Saves the configuration of a plugin to a file.
+     *
+     * This method saves the configuration of the specified plugin to a JSON file in the matterbridge directory.
+     * If the plugin's configuration is not found, it logs an error and rejects the promise. If the configuration
+     * is successfully saved, it logs a debug message. If an error occurs during the file write operation, it logs
+     * the error and rejects the promise.
+     *
+     * @param {RegisteredPlugin} plugin - The plugin whose configuration is to be saved.
+     * @param {boolean} [restartRequired] - Indicates whether a restart is required after saving the configuration.
+     * @returns {Promise<void>} A promise that resolves when the configuration is successfully saved, or rejects if an error occurs.
+     * @throws {Error} If the plugin's configuration is not found.
+     */
+    saveConfigFromPlugin(plugin: RegisteredPlugin, restartRequired?: boolean): Promise<void>;
+    /**
+     * Saves the configuration of a plugin from a JSON object to a file.
+     *
+     * This method saves the provided configuration of the specified plugin to a JSON file in the matterbridge directory.
+     * It first checks if the configuration data is valid by ensuring it contains the correct name and type, and matches
+     * the plugin's name. If the configuration data is invalid, it logs an error and returns. If the configuration is
+     * successfully saved, it updates the plugin's `configJson` property and logs a debug message. If an error occurs
+     * during the file write operation, it logs the error and returns.
+     *
+     * @param {RegisteredPlugin} plugin - The plugin whose configuration is to be saved.
+     * @param {PlatformConfig} config - The configuration data to be saved.
+     * @param {boolean} [restartRequired] - Indicates whether a restart is required after saving the configuration.
+     * @returns {Promise<void>} A promise that resolves when the configuration is successfully saved, or returns if an error occurs.
+     */
+    saveConfigFromJson(plugin: RegisteredPlugin, config: PlatformConfig, restartRequired?: boolean): Promise<void>;
+    /**
+     * Loads the schema for a plugin.
+     *
+     * This method attempts to load the schema file for the specified plugin. If the schema file is found,
+     * it reads and parses the file, updates the schema's title and description, and logs the process.
+     * If the schema file is not found, it logs the event and loads a default schema for the plugin.
+     *
+     * @param {RegisteredPlugin} plugin - The plugin whose schema is to be loaded.
+     * @returns {Promise<PlatformSchema>} A promise that resolves to the loaded schema object, or the default schema if the schema file is not found.
+     */
+    loadSchema(plugin: RegisteredPlugin): Promise<PlatformSchema>;
+    /**
+     * Returns the default schema for a plugin.
+     *
+     * This method generates a default schema object for the specified plugin. The schema includes
+     * metadata such as the plugin's title, description, version, and author. It also defines the
+     * properties of the schema, including the plugin's name, type, debug flag, and unregisterOnShutdown flag.
+     *
+     * @param {RegisteredPlugin} plugin - The plugin for which the default schema is to be generated.
+     * @returns {PlatformSchema} The default schema object for the plugin.
+     */
+    getDefaultSchema(plugin: RegisteredPlugin): PlatformSchema;
+}
+export {};
+//# sourceMappingURL=pluginManager.d.ts.map

package/dist/pluginManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginManager.d.ts","sourceRoot":"","sources":["../src/pluginManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,YAAY,MAAM,aAAa,CAAC;AAGvC,OAAO,EAAc,QAAQ,EAA0E,MAAM,kBAAkB,CAAC;AAGhI,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACtG,OAAO,EAAO,gBAAgB,EAAO,MAAM,wBAAwB,CAAC;AAGpE,UAAU,mBAAmB;IAC3B,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtB,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxB,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACvB,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxB,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACzB,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IACvD,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5B,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxB,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;CAC1B;AAED,qBAAa,aAAc,SAAQ,YAAY,CAAC,mBAAmB,CAAC;IAClE,OAAO,CAAC,QAAQ,CAAuC;IACvD,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,GAAG,CAAa;gBAEZ,YAAY,EAAE,YAAY;IAOtC,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI1B,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAI/C,GAAG,CAAC,MAAM,EAAE,gBAAgB,GAAG,gBAAgB;IAK/C,KAAK,IAAI,IAAI;IAIb,KAAK,IAAI,gBAAgB,EAAE;IAI3B,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIX,OAAO,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAanF,IAAI,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAE9B;IAED;;;;;;;OAOG;IACG,eAAe,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAUpD;;;;;;;OAOG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAuBtC;;;;;OAKG;IACG,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAyFzD;;;;;OAKG;IACH,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,MAAM;IAM1G;;;;;OAKG;IACH,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,MAAM,GAAG,SAAS;IAQxH;;;;;OAKG;IACH,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,MAAM,GAAG,SAAS;IAWpH;;;;;OAKG;IACH,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,MAAM,GAAG,SAAS;IAWzH;;;;;OAKG;IAEH,UAAU,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,GAAG,SAAS;IAmBhE;;;;;OAKG;IACG,KAAK,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC;IA4E/F;;;;;;;;;OASG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAkClE;;;;;;;;;OASG;IACG,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAkCnE;;;;;;;;;OASG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAkClE;;;;;;;;;;OAUG;IACG,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAmC/D;;;;;;;;OAQG;IACG,IAAI,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,GAAE,OAAe,EAAE,OAAO,GAAE,MAAW,EAAE,SAAS,GAAE,OAAe,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;IAgFzJ;;;;;;;OAOG;IACG,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,SAAS,GAAE,OAAe,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IA6B1H;;;;;OAKG;IACG,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IA+BhF;;;;;;;;;;;OAWG;IACG,QAAQ,CAAC,MAAM,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,gBAAgB,GAAE,OAAe,EAAE,KAAK,GAAE,OAAe,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAyC3J;;;;;;;;OAQG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,cAAc,CAAC;IAsDnE;;;;;;;;;;;;OAYG;IACG,oBAAoB,CAAC,MAAM,EAAE,gBAAgB,EAAE,eAAe,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBrG;;;;;;;;;;;;;OAaG;IACG,kBAAkB,CAAC,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE,eAAe,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAwB3H;;;;;;;;;OASG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,cAAc,CAAC;IAkBnE;;;;;;;;;OASG;IACH,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,GAAG,cAAc;CA6B3D"}