kibana/x-pack/plugins/actions/common/connector_feature_config.ts

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */

import { i18n } from '@kbn/i18n';

interface ConnectorFeatureConfig {
  /**
   * Unique identifier for this feature.
   */
  id: string;

  /**
   * Display name for this feature.
   * This will be displayed to end-users, so a translatable string is advised for i18n.
   */
  name: string;
  compatibility: string;
}

export const AlertingConnectorFeatureId = 'alerting';
export const CasesConnectorFeatureId = 'cases';
export const UptimeConnectorFeatureId = 'uptime';
export const SecurityConnectorFeatureId = 'siem';
export const GenerativeAIConnectorFeatureId = 'generativeAI';

const compatibilityGenerativeAI = i18n.translate(
  'xpack.actions.availableConnectorFeatures.compatibility.generativeAI',
  {
    defaultMessage: 'Generative AI',
  }
);

const compatibilityAlertingRules = i18n.translate(
  'xpack.actions.availableConnectorFeatures.compatibility.alertingRules',
  {
    defaultMessage: 'Alerting Rules',
  }
);

const compatibilityCases = i18n.translate(
  'xpack.actions.availableConnectorFeatures.compatibility.cases',
  {
    defaultMessage: 'Cases',
  }
);

export const AlertingConnectorFeature: ConnectorFeatureConfig = {
  id: AlertingConnectorFeatureId,
  name: i18n.translate('xpack.actions.availableConnectorFeatures.alerting', {
    defaultMessage: 'Alerting',
  }),
  compatibility: compatibilityAlertingRules,
};

export const CasesConnectorFeature: ConnectorFeatureConfig = {
  id: CasesConnectorFeatureId,
  name: i18n.translate('xpack.actions.availableConnectorFeatures.cases', {
    defaultMessage: 'Cases',
  }),
  compatibility: compatibilityCases,
};

export const UptimeConnectorFeature: ConnectorFeatureConfig = {
  id: UptimeConnectorFeatureId,
  name: i18n.translate('xpack.actions.availableConnectorFeatures.uptime', {
    defaultMessage: 'Uptime',
  }),
  compatibility: compatibilityAlertingRules,
};

export const SecuritySolutionFeature: ConnectorFeatureConfig = {
  id: SecurityConnectorFeatureId,
  name: i18n.translate('xpack.actions.availableConnectorFeatures.securitySolution', {
    defaultMessage: 'Security Solution',
  }),
  compatibility: compatibilityAlertingRules,
};

export const GenerativeAIFeature: ConnectorFeatureConfig = {
  id: GenerativeAIConnectorFeatureId,
  name: compatibilityGenerativeAI,
  compatibility: compatibilityGenerativeAI,
};

const AllAvailableConnectorFeatures = {
  [AlertingConnectorFeature.id]: AlertingConnectorFeature,
  [CasesConnectorFeature.id]: CasesConnectorFeature,
  [UptimeConnectorFeature.id]: UptimeConnectorFeature,
  [SecuritySolutionFeature.id]: SecuritySolutionFeature,
  [GenerativeAIFeature.id]: GenerativeAIFeature,
};

export function areValidFeatures(ids: string[]) {
  return ids.every((id: string) => !!AllAvailableConnectorFeatures[id]);
}

export function getConnectorFeatureName(id: string) {
  const featureConfig = AllAvailableConnectorFeatures[id];
  return featureConfig ? featureConfig.name : id;
}

export function getConnectorCompatibility(featureIds?: string[]): string[] {
  const compatibility = new Set<string>();

  if (featureIds && featureIds.length > 0) {
    for (const featureId of featureIds) {
      if (AllAvailableConnectorFeatures[featureId]) {
        compatibility.add(AllAvailableConnectorFeatures[featureId].compatibility);
      }
    }
  }

  return Array.from(compatibility);
}