upstream-mattermost/e2e-tests/cypress/tests/support/api/system.d.ts

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

/// <reference types="cypress" />

// ***************************************************************
// Each command should be properly documented using JSDoc.
// See https://jsdoc.app/index.html for reference.
// Basic requirements for documentation are the following:
// - Meaningful description
// - Specific link to https://api.mattermost.com
// - Each parameter with `@params`
// - Return value with `@returns`
// - Example usage with `@example`
// Custom command should follow naming convention of having `api` prefix, e.g. `apiLogin`.
// ***************************************************************

declare namespace Cypress {
    interface Chainable {

        /**
         * Get a subset of the server license needed by the client.
         * See https://api.mattermost.com/#tag/system/paths/~1license~1client/get
         * @returns {ClientLicense} `out.license` as `ClientLicense`
         * @returns {Boolean} `out.isLicensed`
         * @returns {Boolean} `out.isCloudLicensed`
         *
         * @example
         *   cy.apiGetClientLicense().then(({license}) => {
         *       // do something with license
         *   });
         */
        apiGetClientLicense(): Chainable<ClientLicense>;

        /**
         * Verify if server has license for a certain feature and fail test if not found.
         * Upload a license if it does not exist.
         * @param {string[]} ...features - accepts multiple arguments of features to check, e.g. 'LDAP'
         * @returns {ClientLicense} `out.license` as `ClientLicense`
         *
         * @example
         *   cy.apiRequireLicenseForFeature('LDAP');
        *    cy.apiRequireLicenseForFeature('LDAP', 'SAML');
         */
        apiRequireLicenseForFeature(...features: string[]): Chainable<ClientLicense>;

        /**
         * Verify if server has license and fail test if not found.
         * Upload a license if it does not exist.
         * @returns {ClientLicense} `out.license` as `ClientLicense`
         *
         * @example
         *   cy.apiRequireLicense();
         */
        apiRequireLicense(): Chainable<ClientLicense>;

        /**
         * Upload a license to enable enterprise features.
         * See https://api.mattermost.com/#tag/system/paths/~1license/post
         * @param {String} filePath - path of the license file relative to fixtures folder
         * @returns {Response} response: Cypress-chainable response which should have successful HTTP status of 200 OK to continue or pass.
         *
         * @example
         *   const filePath = 'mattermost-license.txt';
         *   cy.apiUploadLicense(filePath);
         */
        apiUploadLicense(filePath: string): Chainable<Response>;

        /**
         * Request and install a trial license for your server.
         * See https://api.mattermost.com/#tag/system/paths/~1trial-license/post
         * @returns {Object} `out.data` as response status
         *
         * @example
         *   cy.apiInstallTrialLicense();
         */
        apiInstallTrialLicense(): Chainable<Record<string, any>>;

        /**
         * Remove the license file from the server. This will disable all enterprise features.
         * See https://api.mattermost.com/#tag/system/paths/~1license/delete
         * @returns {Response} response: Cypress-chainable response which should have successful HTTP status of 200 OK to continue or pass.
         *
         * @example
         *   cy.apiDeleteLicense();
         */
        apiDeleteLicense(): Chainable<Response>;

        /**
         * Update configuration.
         * See https://api.mattermost.com/#tag/system/paths/~1config/put
         * @param {AdminConfig} newConfig - new config
         * @returns {AdminConfig} `out.config` as `AdminConfig`
         *
         * @example
         *   cy.apiUpdateConfig().then(({config}) => {
         *       // do something with config
         *   });
         */
        apiUpdateConfig(newConfig: DeepPartial<AdminConfig>): Chainable<{config: AdminConfig}>;

        /**
         * Reload the configuration file to pick up on any changes made to it.
         * See https://api.mattermost.com/#tag/system/paths/~1config~1reload/post
         * @returns {AdminConfig} `out.config` as `AdminConfig`
         *
         * @example
         *   cy.apiReloadConfig().then(({config}) => {
         *       // do something with config
         *   });
         */
        apiReloadConfig(): Chainable<AdminConfig>;

        /**
         * Get configuration.
         * See https://api.mattermost.com/#tag/system/paths/~1config/get
         * @param {Boolean} old - false (default) or true to return old format of client config
         * @returns {AdminConfig} `out.config` as `AdminConfig`
         *
         * @example
         *   cy.apiGetConfig().then(({config}) => {
         *       // do something with config
         *   });
         */
        apiGetConfig(): Chainable<{config: AdminConfig}>;

        /**
         * Get analytics.
         * See https://api.mattermost.com/#tag/system/paths/~1analytics~1old/get
         * @returns {AnalyticsRow[]} `out.analytics` as `AnalyticsRow[]`
         *
         * @example
         *   cy.apiGetAnalytics().then(({analytics}) => {
         *       // do something with analytics
         *   });
         */
        apiGetAnalytics(): Chainable<AnalyticsRow[]>;

        /**
         * Invalidate all the caches.
         * See https://api.mattermost.com/#tag/system/paths/~1caches~1invalidate/post
         * @returns {Object} `out.data` as response status
         *
         * @example
         *   cy.apiInvalidateCache();
         */
        apiInvalidateCache(): Chainable<Record<string, any>>;

        /**
         * Allow test if matches elastic search disabled.
         * Otherwise, fail fast.
         * @example
         *   cy.shouldHaveElasticsearchDisabled();
         */
        shouldHaveElasticsearchDisabled(): Chainable;

        /**
         * Allow test for server other than Cloud edition or with Cloud license.
         * Otherwise, fail fast.
         * @example
         *   cy.shouldNotRunOnCloudEdition();
         */
        shouldNotRunOnCloudEdition(): Chainable;

        /**
         * Allow test for server on Team edition or without license.
         * Otherwise, fail fast.
         * @example
         *   cy.shouldRunOnTeamEdition();
         */
        shouldRunOnTeamEdition(): Chainable;

        /**
         * Allow test for server with Plugin upload enabled.
         * Otherwise, fail fast.
         * @example
         *   cy.shouldHavePluginUploadEnabled();
         */
        shouldHavePluginUploadEnabled(): Chainable;

        /**
         * Allow test for server running with subpath.
         * Otherwise, fail fast.
         * @example
         *   cy.shouldRunWithSubpath();
         */
        shouldRunWithSubpath(): Chainable;

        /**
         * Allow test if matches feature flag setting
         * Otherwise, fail fast.
         *
         * @param {string} feature - feature name
         * @param {string} expectedValue - expected value
         *
         * @example
         *   cy.shouldHaveFeatureFlag('feature', 'expected-value');
         */
        shouldHaveFeatureFlag(feature: string, expectedValue: any): Chainable;

        /**
         * Require email service to be reachable by the server
         * thru "/api/v4/email/test" if sysadmin account has
         * permission to do so. Otherwise, skip email test.
         *
         * @example
         *   cy.shouldHaveEmailEnabled();
         */
        shouldHaveEmailEnabled(): Chainable;
    }
}