// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved. // See LICENSE.txt for license information. import path from 'path'; import client from './client'; import {apiUploadFile, getResponseFromError} from './common'; // **************************************************************** // Plugins // https://api.mattermost.com/#tag/plugins // // Exported API function should have the following: // - documented using JSDoc // - meaningful description // - match the referenced API endpoints // - parameter/s defined by `@param` // - return value defined by `@return` // **************************************************************** const prepackagedPlugins = [ 'antivirus', 'mattermost-autolink', 'com.mattermost.aws-sns', 'com.mattermost.plugin-channel-export', 'com.mattermost.custom-attributes', 'github', 'com.github.manland.mattermost-plugin-gitlab', 'com.mattermost.plugin-incident-management', 'jenkins', 'jira', 'com.mattermost.nps', 'com.mattermost.welcomebot', 'zoom', ]; /** * Disable non-prepackaged plugins. * @param {string} baseUrl - the base server URL */ export const apiDisableNonPrepackagedPlugins = async (baseUrl: string): Promise => { const {plugins} = await apiGetAllPlugins(baseUrl); if (!plugins) { return; } plugins.active.forEach(async (plugin: any) => { if (!prepackagedPlugins.includes(plugin.id)) { await apiDisablePluginById(baseUrl, plugin.id); } }); }; /** * Disable plugin. * See https://api.mattermost.com/#operation/DisablePlugin * @param {string} baseUrl - the base server URL * @param {string} pluginId - the plugin ID * @return {Object} returns response on success or {error, status} on error */ export const apiDisablePluginById = async (baseUrl: string, pluginId: string): Promise => { try { return await client.post(`${baseUrl}/api/v4/plugins/${encodeURIComponent(pluginId)}/disable`); } catch (err) { return getResponseFromError(err); } }; /** * Enable plugin. * See https://api.mattermost.com/#operation/EnablePlugin * @param {string} baseUrl - the base server URL * @param {string} pluginId - the plugin ID * @return {Object} returns response on success or {error, status} on error */ export const apiEnablePluginById = async (baseUrl: string, pluginId: string): Promise => { try { return await client.post(`${baseUrl}/api/v4/plugins/${encodeURIComponent(pluginId)}/enable`); } catch (err) { return getResponseFromError(err); } }; /** * Get plugins. * See https://api.mattermost.com/#operation/GetPlugins * @param {string} baseUrl - the base server URL * @return {Object} returns {plugins} on success or {error, status} on error */ export const apiGetAllPlugins = async (baseUrl: string): Promise => { try { const response = await client.get(`${baseUrl}/api/v4/plugins`); return {plugins: response.data}; } catch (err) { return getResponseFromError(err); } }; /** * Install plugin from URL. * See https://api.mattermost.com/#operation/InstallPluginFromUrl * @param {string} baseUrl - the base server URL * @param {string} pluginDownloadUrl - URL used to download the plugin * @param {string} force - Set to 'true' to overwrite a previously installed plugin with the same ID, if any * @return {Object} returns {plugin} on success or {error, status} on error */ export const apiInstallPluginFromUrl = async (baseUrl: string, pluginDownloadUrl: string, force = false): Promise => { try { const response = await client.post(`${baseUrl}/api/v4/plugins/install_from_url?plugin_download_url=${encodeURIComponent(pluginDownloadUrl)}&force=${force}`); return {plugin: response.data}; } catch (err) { return getResponseFromError(err); } }; /** * Remove plugin. * See https://api.mattermost.com/#operation/RemovePlugin * @param {string} baseUrl - the base server URL * @param {string} pluginId - the plugin ID * @return {Object} returns response on success or {error, status} on error */ export const apiRemovePluginById = async (baseUrl: string, pluginId: string): Promise => { try { return await client.delete(`${baseUrl}/api/v4/plugins/${encodeURIComponent(pluginId)}`); } catch (err) { return getResponseFromError(err); } }; /** * Upload plugin. * See https://api.mattermost.com/#operation/UploadPlugin * @param {string} baseUrl - the base server URL * @param {string} filename - the filename of plugin to be uploaded * @return {Object} returns response on success or {error, status} on error */ export const apiUploadPlugin = async (baseUrl: string, filename: string): Promise => { try { const absFilePath = path.resolve(__dirname, `../../support/fixtures/${filename}`); return await apiUploadFile('plugin', absFilePath, {url: `${baseUrl}/api/v4/plugins`, method: 'POST'}); } catch (err) { return getResponseFromError(err); } }; export const Plugin = { apiDisableNonPrepackagedPlugins, apiDisablePluginById, apiEnablePluginById, apiGetAllPlugins, apiInstallPluginFromUrl, apiRemovePluginById, apiUploadPlugin, }; export default Plugin;