plugins.ts

import { logger } from '@twilio/flex-dev-utils';
import { ElementHandle, Page } from 'puppeteer';

import { Base } from './base';

interface PluginResponse {
  name: string;
  version: string;
  phase: number;
  src: string;
}

export class Plugins extends Base {
  private static readonly _pluginList = 'pre';

  assert = {
    plugin: {
      /**
       * Checks whether plugin with the given text is visible in the UI
       * @param pluginText
       */
      isVisible: async (pluginText: string): Promise<ElementHandle<Element | Node>> =>
        this.elementVisible(this._plugin(pluginText), `Plugin with text: ${pluginText}`),
    },
  };

  private readonly _baseUrl: string;

  constructor(page: Page, baseUrl: string) {
    super(page);
    this._baseUrl = baseUrl.includes('flex.local.com') ? 'https://flex.twilio.com' : baseUrl;
  }

  /**
   * Retrieves all plugins from /plugins
   */
  async list(): Promise<PluginResponse[]> {
    await this.goto({ baseUrl: this._baseUrl, path: '/plugins' });

    const pluginListElementHandle = await this.elementVisible(Plugins._pluginList, 'Plugins in PRE tag');
    const pluginListAsString = await this.getText(pluginListElementHandle, 'Plugins in PRE tag');

    try {
      return JSON.parse(pluginListAsString);
    } catch (e) {
      logger.error('Plugin list retrieved from the /plugins is not a valid JSON');
      throw e;
    }
  }

  /**
   * Creates selector for plugin based on its text
   */
  private _plugin = (text: string): string => `//div[contains(text(), '${text}')]`;
}