plugin.ts

/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 *
 * Any modifications Copyright OpenSearch Contributors. See
 * GitHub history for details.
 */

/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you 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 { i18n } from '@osd/i18n';
import { Plugin, CoreSetup } from 'src/core/public';

import { FeatureCatalogueCategory } from '../../home/public';
import { AppSetupUIPluginDependencies } from './types';

export class ConsoleUIPlugin implements Plugin<void, void, AppSetupUIPluginDependencies> {
  public setup(
    { notifications, getStartServices, http }: CoreSetup,
    { devTools, home, usageCollection }: AppSetupUIPluginDependencies
  ) {
    if (home) {
      home.featureCatalogue.register({
        id: 'console',
        title: i18n.translate('console.devToolsTitle', {
          defaultMessage: 'Interact with the OpenSearch API',
        }),
        description: i18n.translate('console.devToolsDescription', {
          defaultMessage: 'Skip cURL and use a JSON interface to work with your data in Console.',
        }),
        icon: 'consoleApp',
        path: '/app/dev_tools#/console',
        showOnHomePage: false,
        category: FeatureCatalogueCategory.ADMIN,
      });
    }

    devTools.register({
      id: 'console',
      order: 1,
      title: i18n.translate('console.consoleDisplayName', {
        defaultMessage: 'Console',
      }),
      enableRouting: false,
      mount: async ({ element, dataSourceId }) => {
        const [core] = await getStartServices();

        const {
          i18n: { Context: I18nContext },
          docLinks: { DOC_LINK_VERSION },
          uiSettings,
        } = core;

        const { renderApp } = await import('./application');

        return renderApp({
          http,
          docLinkVersion: DOC_LINK_VERSION,
          I18nContext,
          notifications,
          usageCollection,
          element,
          dataSourceId,
          uiSettings,
        });
      },
    });
  }

  public start() {}
}