matterbridge/dist/update.d.ts

Matterbridge plugin manager for Matter

/**
 * This file contains the check updates functions.
 *
 * @file update.ts
 * @author Luca Liguori
 * @date 2025-02-24
 * @version 1.0.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 { Matterbridge } from './matterbridge.js';
import { RegisteredPlugin } from './matterbridgeTypes.js';
/**
 * Checks for updates for Matterbridge and its plugins.
 * If the 'shelly' parameter is present, also checks for Shelly updates.
 *
 * @param {Matterbridge} matterbridge - The Matterbridge instance.
 * @returns {Promise<void>} A promise that resolves when the update checks are complete.
 */
export declare function checkUpdates(matterbridge: Matterbridge): 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 {Matterbridge} matterbridge - The Matterbridge instance.
 * @returns {Promise<String | undefined>} A promise that resolves when the latest version is retrieved.
 */
export declare function getMatterbridgeLatestVersion(matterbridge: Matterbridge): 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 {Matterbridge} matterbridge - The Matterbridge instance.
 * @returns {Promise<string | undefined>} A promise that resolves when the latest dev version is retrieved.
 */
export declare function getMatterbridgeDevVersion(matterbridge: Matterbridge): 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 {Matterbridge} matterbridge - The Matterbridge instance.
 * @param {RegisteredPlugin} 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(matterbridge: Matterbridge, plugin: RegisteredPlugin): Promise<string | undefined>;
//# sourceMappingURL=update.d.ts.map