@backstage-community/plugin-grafana 0.16.0 → 0.17.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @backstage-community/plugin-grafana
 
+## 0.17.0
+
+### Minor Changes
+
+- 7c226ff: Backstage version bump to v1.49.2
+
 ## 0.16.0
 
 ### Minor Changes

package/dist/alpha.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import * as _backstage_plugin_catalog_react_alpha from '@backstage/plugin-catalog-react/alpha';
 import * as _backstage_catalog_model from '@backstage/catalog-model';
 import * as react from 'react';
@@ -18,9 +17,7 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
         configInput: {};
         output: _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
         inputs: {};
-        params: <TApi, TImpl extends TApi, TDeps extends {
-            [x: string]: unknown;
-        }>(params: _backstage_frontend_plugin_api.ApiFactory<TApi, TImpl, TDeps>) => _backstage_frontend_plugin_api.ExtensionBlueprintParams<_backstage_frontend_plugin_api.AnyApiFactory>;
+        params: <TApi, TImpl extends TApi, TDeps extends { [name in string]: unknown; }>(params: _backstage_frontend_plugin_api.ApiFactory<TApi, TImpl, TDeps>) => _backstage_frontend_plugin_api.ExtensionBlueprintParams<_backstage_frontend_plugin_api.AnyApiFactory>;
     }>;
     "entity-card:grafana/alerts": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
         kind: "entity-card";
@@ -43,8 +40,8 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
         inputs: {};
         params: {
             loader: () => Promise<JSX.Element>;
-            filter?: _backstage_filter_predicates.FilterPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
-            type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
+            filter?: string | _backstage_filter_predicates.FilterPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
+            type?: _backstage_plugin_catalog_react_alpha.EntityCardType;
         };
     }>;
     "entity-card:grafana/dashboards": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
@@ -68,8 +65,8 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
         inputs: {};
         params: {
             loader: () => Promise<JSX.Element>;
-            filter?: _backstage_filter_predicates.FilterPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
-            type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
+            filter?: string | _backstage_filter_predicates.FilterPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
+            type?: _backstage_plugin_catalog_react_alpha.EntityCardType;
         };
     }>;
     "entity-card:grafana/overview-dashboard": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
@@ -93,8 +90,8 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
         inputs: {};
         params: {
             loader: () => Promise<JSX.Element>;
-            filter?: _backstage_filter_predicates.FilterPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
-            type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
+            filter?: string | _backstage_filter_predicates.FilterPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
+            type?: _backstage_plugin_catalog_react_alpha.EntityCardType;
         };
     }>;
 }>;

package/dist/api.esm.js

@@ -1,7 +1,7 @@
 import { createApiRef } from '@backstage/frontend-plugin-api';
 import { QueryEvaluator } from './query/QueryEvaluator.esm.js';
 
-const grafanaApiRef = createApiRef({
+const grafanaApiRef = createApiRef().with({
   id: "plugin.grafana.service"
 });
 const DEFAULT_PROXY_PATH = "/grafana/api";

package/dist/api.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.esm.js","sources":["../src/api.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  createApiRef,\n  DiscoveryApi,\n  FetchApi,\n} from '@backstage/frontend-plugin-api';\nimport { QueryEvaluator } from './query';\nimport { Alert, Dashboard } from './types';\n\n/**\n * Interface for the Grafana API\n * @public\n */\nexport interface GrafanaApi {\n  /**\n   * Returns the found dashboards in Grafana with the defined query\n   * @param query - The query used to list the dashboards\n   */\n  listDashboards(query: string): Promise<Dashboard[]>;\n  /**\n   * Returns a list of alerts found in Grafana that have any of the defined alert selectors\n   * @param selectors - One or multiple alert selectors\n   */\n  alertsForSelector(selectors: string | string[]): Promise<Alert[]>;\n}\n\ninterface AggregatedAlertState {\n  Normal: number;\n  Pending: number;\n  Alerting: number;\n  NoData: number;\n  Error: number;\n  Invalid: number;\n}\n\ntype AlertState =\n  | 'Normal'\n  | 'Pending'\n  | 'Alerting'\n  | 'NoData'\n  | 'Error'\n  | 'n/a';\n\ninterface AlertInstance {\n  labels: Record<string, string>;\n  state: AlertState;\n}\n\ninterface AlertsData {\n  data: { alerts: AlertInstance[] };\n}\n\ninterface AlertRuleGroupConfig {\n  name: string;\n  rules: AlertRule[];\n}\n\ninterface GrafanaAlert {\n  id: number;\n  panelId: number;\n  name: string;\n  state: string;\n  url: string;\n}\n\ninterface UnifiedGrafanaAlert {\n  uid: string;\n  title: string;\n}\n\ninterface AlertRule {\n  labels: Record<string, string>;\n  grafana_alert: UnifiedGrafanaAlert;\n}\n\n/**\n * The grafana API reference\n * @public\n */\nexport const grafanaApiRef = createApiRef<GrafanaApi>({\n  id: 'plugin.grafana.service',\n});\n\nexport type Options = {\n  discoveryApi: DiscoveryApi;\n  fetchApi: FetchApi;\n\n  /**\n   * Domain used by users to access Grafana web UI.\n   * Example: https://monitoring.my-company.com/\n   */\n  domain: string;\n\n  /**\n   * Path to use for requests via the proxy, defaults to /grafana/api\n   */\n  proxyPath?: string;\n\n  /**\n   * Limit value to pass in Grafana Dashboard search query.\n   */\n  grafanaDashboardSearchLimit?: number;\n\n  /**\n   * Max pages of Grafana Dashboard search query to fetch.\n   */\n  grafanaDashboardMaxPages?: number;\n};\n\nconst DEFAULT_PROXY_PATH = '/grafana/api';\n// upstream default if no limit is specified.\nconst DEFAULT_DASHBOARDS_LIMIT: number = 1000;\nconst DEFAULT_PAGES_LIMIT: number = 1;\n// upstream limit: https://github.com/grafana/grafana/blob/2ee956192064343c73009ffe106178bf4e983844/pkg/api/search.go#L43\nconst UPSTREAM_DASHBOARDS_LIMIT_MAX: number = 5000;\n\nconst isSingleWord = (input: string): boolean => {\n  return input.match(/^[\\w-]+$/g) !== null;\n};\n\nclass Client {\n  private readonly discoveryApi: DiscoveryApi;\n  private readonly fetchApi: FetchApi;\n  private readonly proxyPath: string;\n  private readonly queryEvaluator: QueryEvaluator;\n  private readonly grafanaDashboardSearchLimit: number;\n  private readonly grafanaDashboardMaxPages: number;\n\n  constructor(opts: Options) {\n    this.discoveryApi = opts.discoveryApi;\n    this.fetchApi = opts.fetchApi;\n    this.proxyPath = opts.proxyPath ?? DEFAULT_PROXY_PATH;\n    this.queryEvaluator = new QueryEvaluator();\n    this.grafanaDashboardSearchLimit = Math.min(\n      opts.grafanaDashboardSearchLimit ?? DEFAULT_DASHBOARDS_LIMIT,\n      UPSTREAM_DASHBOARDS_LIMIT_MAX,\n    );\n    this.grafanaDashboardMaxPages =\n      opts.grafanaDashboardMaxPages ?? DEFAULT_PAGES_LIMIT;\n  }\n\n  public async fetch<T = any>(input: string, init?: RequestInit): Promise<T> {\n    const apiUrl = await this.apiUrl();\n    const resp = await this.fetchApi.fetch(`${apiUrl}${input}`, init);\n    if (!resp.ok) {\n      throw new Error(`Request failed with ${resp.status} ${resp.statusText}`);\n    }\n\n    return await resp.json();\n  }\n\n  async listDashboards(domain: string, query: string): Promise<Dashboard[]> {\n    if (isSingleWord(query)) {\n      return this.dashboardsByTag(domain, query);\n    }\n\n    return this.dashboardsForQuery(domain, query);\n  }\n\n  private async fetchSomeDashboards(options: {\n    domain: string;\n    page: number;\n    limit: number;\n    tag?: string;\n  }): Promise<Dashboard[]> {\n    const query = `/api/search?type=dash-db&limit=${options.limit}&page=${\n      options.page\n    }${options.tag !== undefined ? `&tag=${options.tag}` : ''}`;\n    const response = await this.fetch<Dashboard[]>(query);\n    return this.fullyQualifiedDashboardMetadata(options.domain, response);\n  }\n\n  // Grafana Search API does not have pagination metadata in the response body or headers\n  // so we have to guess if we are at the end based on number of items in the result\n  // https://grafana.com/docs/grafana/latest/developers/http_api/folder_dashboard_search/\n  // The API also does not use continuation tokens, so there is no guarantee\n  // that dashboards have not been added or deleted since listing the previous\n  // page.\n  private async fetchAllDashboards(options: {\n    domain: string;\n    tag?: string;\n  }): Promise<Dashboard[]> {\n    let page: number = 0;\n    const allDashboards: Dashboard[] = [];\n    let more: boolean = true;\n    do {\n      const dashboards: Dashboard[] = await this.fetchSomeDashboards({\n        domain: options.domain,\n        page: page++,\n        limit: this.grafanaDashboardSearchLimit,\n        tag: options.tag,\n      });\n      allDashboards.push(...dashboards);\n      // pages limit exists to prevent accidental infinite loops from Grafana\n      more =\n        dashboards.length >= this.grafanaDashboardSearchLimit &&\n        page < this.grafanaDashboardMaxPages;\n    } while (more);\n    return allDashboards;\n  }\n\n  async dashboardsForQuery(\n    domain: string,\n    query: string,\n  ): Promise<Dashboard[]> {\n    const parsedQuery = this.queryEvaluator.parse(query);\n    const allDashboards = await this.fetchAllDashboards({ domain: domain });\n    return allDashboards.filter(dashboard => {\n      return this.queryEvaluator.evaluate(parsedQuery, dashboard) === true;\n    });\n  }\n\n  async dashboardsByTag(domain: string, tag: string): Promise<Dashboard[]> {\n    return this.fetchAllDashboards({ domain: domain, tag: tag });\n  }\n\n  private fullyQualifiedDashboardMetadata(\n    domain: string,\n    dashboards: Dashboard[],\n  ): Dashboard[] {\n    return dashboards.map(dashboard => ({\n      ...dashboard,\n      url: domain + dashboard.url,\n      folderTitle: dashboard.folderTitle ?? '',\n      folderUrl: domain + dashboard.folderUrl,\n    }));\n  }\n\n  private async apiUrl() {\n    const proxyUrl = await this.discoveryApi.getBaseUrl('proxy');\n    return proxyUrl + this.proxyPath;\n  }\n}\n\nexport class GrafanaApiClient implements GrafanaApi {\n  private readonly domain: string;\n  private readonly client: Client;\n\n  constructor(opts: Options) {\n    this.domain = opts.domain;\n    this.client = new Client(opts);\n  }\n\n  async listDashboards(query: string): Promise<Dashboard[]> {\n    return this.client.listDashboards(this.domain, query);\n  }\n\n  async alertsForSelector(dashboardTag: string): Promise<Alert[]> {\n    const response = await this.client.fetch<GrafanaAlert[]>(\n      `/api/alerts?dashboardTag=${dashboardTag}`,\n    );\n\n    return response.map(alert => ({\n      name: alert.name,\n      state: alert.state,\n      matchingSelector: dashboardTag,\n      url: `${this.domain}${alert.url}?panelId=${alert.panelId}&fullscreen&refresh=30s`,\n    }));\n  }\n}\n\nexport class UnifiedAlertingGrafanaApiClient implements GrafanaApi {\n  private readonly domain: string;\n  private readonly client: Client;\n\n  constructor(opts: Options) {\n    this.domain = opts.domain;\n    this.client = new Client(opts);\n  }\n\n  async listDashboards(query: string): Promise<Dashboard[]> {\n    return this.client.listDashboards(this.domain, query);\n  }\n\n  async alertsForSelector(selectors: string | string[]): Promise<Alert[]> {\n    let labelSelectors: string[] = [];\n    if (typeof selectors === 'string') {\n      labelSelectors = [selectors];\n    } else {\n      labelSelectors = selectors;\n    }\n\n    const rulesResponse = await this.client.fetch<\n      Record<string, AlertRuleGroupConfig[]>\n    >('/api/ruler/grafana/api/v1/rules');\n    const rules = Object.values(rulesResponse)\n      .flat()\n      .map(ruleGroup => ruleGroup.rules)\n      .flat();\n    const alertsResponse = await this.client.fetch<AlertsData>(\n      '/api/prometheus/grafana/api/v1/alerts',\n    );\n\n    return labelSelectors\n      .map(selector => {\n        const [label, labelValue] = selector.split('=');\n\n        const matchingRules = rules.filter(\n          rule => rule.labels && rule.labels[label] === labelValue,\n        );\n        const alertInstances = alertsResponse.data.alerts.filter(\n          alertInstance => alertInstance.labels[label] === labelValue,\n        );\n\n        return matchingRules.map(rule => {\n          const matchingAlertInstances = alertInstances.filter(\n            alertInstance =>\n              alertInstance.labels.alertname === rule.grafana_alert.title,\n          );\n\n          const aggregatedAlertStates: AggregatedAlertState =\n            matchingAlertInstances.reduce(\n              (previous, alert) => {\n                switch (alert.state) {\n                  case 'Normal':\n                    previous.Normal += 1;\n                    break;\n                  case 'Pending':\n                    previous.Pending += 1;\n                    break;\n                  case 'Alerting':\n                    previous.Alerting += 1;\n                    break;\n                  case 'NoData':\n                    previous.NoData += 1;\n                    break;\n                  case 'Error':\n                    previous.Error += 1;\n                    break;\n                  default:\n                    previous.Invalid += 1;\n                }\n\n                return previous;\n              },\n              {\n                Normal: 0,\n                Pending: 0,\n                Alerting: 0,\n                NoData: 0,\n                Error: 0,\n                Invalid: 0,\n              },\n            );\n\n          return {\n            name: rule.grafana_alert.title,\n            url: `${this.domain}/alerting/grafana/${rule.grafana_alert.uid}/view`,\n            matchingSelector: selector,\n            state: this.getState(\n              aggregatedAlertStates,\n              matchingAlertInstances.length,\n            ),\n          };\n        });\n      })\n      .flat();\n  }\n\n  private getState(\n    states: AggregatedAlertState,\n    totalAlerts: number,\n  ): AlertState {\n    if (states.Alerting > 0) {\n      return 'Alerting';\n    } else if (states.Error > 0) {\n      return 'Error';\n    } else if (states.Pending > 0) {\n      return 'Pending';\n    }\n    if (states.NoData === totalAlerts) {\n      return 'NoData';\n    } else if (\n      states.Normal === totalAlerts ||\n      states.Normal + states.NoData === totalAlerts\n    ) {\n      return 'Normal';\n    }\n\n    return 'n/a';\n  }\n}\n"],"names":[],"mappings":";;;AA8FO,MAAM,gBAAgB,YAAyB,CAAA;AAAA,EACpD,EAAI,EAAA;AACN,CAAC;AA4BD,MAAM,kBAAqB,GAAA,cAAA;AAE3B,MAAM,wBAAmC,GAAA,GAAA;AACzC,MAAM,mBAA8B,GAAA,CAAA;AAEpC,MAAM,6BAAwC,GAAA,GAAA;AAE9C,MAAM,YAAA,GAAe,CAAC,KAA2B,KAAA;AAC/C,EAAO,OAAA,KAAA,CAAM,KAAM,CAAA,WAAW,CAAM,KAAA,IAAA;AACtC,CAAA;AAEA,MAAM,MAAO,CAAA;AAAA,EACM,YAAA;AAAA,EACA,QAAA;AAAA,EACA,SAAA;AAAA,EACA,cAAA;AAAA,EACA,2BAAA;AAAA,EACA,wBAAA;AAAA,EAEjB,YAAY,IAAe,EAAA;AACzB,IAAA,IAAA,CAAK,eAAe,IAAK,CAAA,YAAA;AACzB,IAAA,IAAA,CAAK,WAAW,IAAK,CAAA,QAAA;AACrB,IAAK,IAAA,CAAA,SAAA,GAAY,KAAK,SAAa,IAAA,kBAAA;AACnC,IAAK,IAAA,CAAA,cAAA,GAAiB,IAAI,cAAe,EAAA;AACzC,IAAA,IAAA,CAAK,8BAA8B,IAAK,CAAA,GAAA;AAAA,MACtC,KAAK,2BAA+B,IAAA,wBAAA;AAAA,MACpC;AAAA,KACF;AACA,IAAK,IAAA,CAAA,wBAAA,GACH,KAAK,wBAA4B,IAAA,mBAAA;AAAA;AACrC,EAEA,MAAa,KAAe,CAAA,KAAA,EAAe,IAAgC,EAAA;AACzE,IAAM,MAAA,MAAA,GAAS,MAAM,IAAA,CAAK,MAAO,EAAA;AACjC,IAAM,MAAA,IAAA,GAAO,MAAM,IAAA,CAAK,QAAS,CAAA,KAAA,CAAM,GAAG,MAAM,CAAA,EAAG,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA;AAChE,IAAI,IAAA,CAAC,KAAK,EAAI,EAAA;AACZ,MAAM,MAAA,IAAI,MAAM,CAAuB,oBAAA,EAAA,IAAA,CAAK,MAAM,CAAI,CAAA,EAAA,IAAA,CAAK,UAAU,CAAE,CAAA,CAAA;AAAA;AAGzE,IAAO,OAAA,MAAM,KAAK,IAAK,EAAA;AAAA;AACzB,EAEA,MAAM,cAAe,CAAA,MAAA,EAAgB,KAAqC,EAAA;AACxE,IAAI,IAAA,YAAA,CAAa,KAAK,CAAG,EAAA;AACvB,MAAO,OAAA,IAAA,CAAK,eAAgB,CAAA,MAAA,EAAQ,KAAK,CAAA;AAAA;AAG3C,IAAO,OAAA,IAAA,CAAK,kBAAmB,CAAA,MAAA,EAAQ,KAAK,CAAA;AAAA;AAC9C,EAEA,MAAc,oBAAoB,OAKT,EAAA;AACvB,IAAA,MAAM,KAAQ,GAAA,CAAA,+BAAA,EAAkC,OAAQ,CAAA,KAAK,SAC3D,OAAQ,CAAA,IACV,CAAG,EAAA,OAAA,CAAQ,QAAQ,KAAY,CAAA,GAAA,CAAA,KAAA,EAAQ,OAAQ,CAAA,GAAG,KAAK,EAAE,CAAA,CAAA;AACzD,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,KAAA,CAAmB,KAAK,CAAA;AACpD,IAAA,OAAO,IAAK,CAAA,+BAAA,CAAgC,OAAQ,CAAA,MAAA,EAAQ,QAAQ,CAAA;AAAA;AACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAc,mBAAmB,OAGR,EAAA;AACvB,IAAA,IAAI,IAAe,GAAA,CAAA;AACnB,IAAA,MAAM,gBAA6B,EAAC;AACpC,IAAA,IAAI,IAAgB,GAAA,IAAA;AACpB,IAAG,GAAA;AACD,MAAM,MAAA,UAAA,GAA0B,MAAM,IAAA,CAAK,mBAAoB,CAAA;AAAA,QAC7D,QAAQ,OAAQ,CAAA,MAAA;AAAA,QAChB,IAAM,EAAA,IAAA,EAAA;AAAA,QACN,OAAO,IAAK,CAAA,2BAAA;AAAA,QACZ,KAAK,OAAQ,CAAA;AAAA,OACd,CAAA;AACD,MAAc,aAAA,CAAA,IAAA,CAAK,GAAG,UAAU,CAAA;AAEhC,MAAA,IAAA,GACE,UAAW,CAAA,MAAA,IAAU,IAAK,CAAA,2BAAA,IAC1B,OAAO,IAAK,CAAA,wBAAA;AAAA,KACP,QAAA,IAAA;AACT,IAAO,OAAA,aAAA;AAAA;AACT,EAEA,MAAM,kBACJ,CAAA,MAAA,EACA,KACsB,EAAA;AACtB,IAAA,MAAM,WAAc,GAAA,IAAA,CAAK,cAAe,CAAA,KAAA,CAAM,KAAK,CAAA;AACnD,IAAA,MAAM,gBAAgB,MAAM,IAAA,CAAK,kBAAmB,CAAA,EAAE,QAAgB,CAAA;AACtE,IAAO,OAAA,aAAA,CAAc,OAAO,CAAa,SAAA,KAAA;AACvC,MAAA,OAAO,IAAK,CAAA,cAAA,CAAe,QAAS,CAAA,WAAA,EAAa,SAAS,CAAM,KAAA,IAAA;AAAA,KACjE,CAAA;AAAA;AACH,EAEA,MAAM,eAAgB,CAAA,MAAA,EAAgB,GAAmC,EAAA;AACvE,IAAA,OAAO,IAAK,CAAA,kBAAA,CAAmB,EAAE,MAAA,EAAgB,KAAU,CAAA;AAAA;AAC7D,EAEQ,+BAAA,CACN,QACA,UACa,EAAA;AACb,IAAO,OAAA,UAAA,CAAW,IAAI,CAAc,SAAA,MAAA;AAAA,MAClC,GAAG,SAAA;AAAA,MACH,GAAA,EAAK,SAAS,SAAU,CAAA,GAAA;AAAA,MACxB,WAAA,EAAa,UAAU,WAAe,IAAA,EAAA;AAAA,MACtC,SAAA,EAAW,SAAS,SAAU,CAAA;AAAA,KAC9B,CAAA,CAAA;AAAA;AACJ,EAEA,MAAc,MAAS,GAAA;AACrB,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,WAAW,OAAO,CAAA;AAC3D,IAAA,OAAO,WAAW,IAAK,CAAA,SAAA;AAAA;AAE3B;AAEO,MAAM,gBAAuC,CAAA;AAAA,EACjC,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,IAAe,EAAA;AACzB,IAAA,IAAA,CAAK,SAAS,IAAK,CAAA,MAAA;AACnB,IAAK,IAAA,CAAA,MAAA,GAAS,IAAI,MAAA,CAAO,IAAI,CAAA;AAAA;AAC/B,EAEA,MAAM,eAAe,KAAqC,EAAA;AACxD,IAAA,OAAO,IAAK,CAAA,MAAA,CAAO,cAAe,CAAA,IAAA,CAAK,QAAQ,KAAK,CAAA;AAAA;AACtD,EAEA,MAAM,kBAAkB,YAAwC,EAAA;AAC9D,IAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACjC,4BAA4B,YAAY,CAAA;AAAA,KAC1C;AAEA,IAAO,OAAA,QAAA,CAAS,IAAI,CAAU,KAAA,MAAA;AAAA,MAC5B,MAAM,KAAM,CAAA,IAAA;AAAA,MACZ,OAAO,KAAM,CAAA,KAAA;AAAA,MACb,gBAAkB,EAAA,YAAA;AAAA,MAClB,GAAA,EAAK,GAAG,IAAK,CAAA,MAAM,GAAG,KAAM,CAAA,GAAG,CAAY,SAAA,EAAA,KAAA,CAAM,OAAO,CAAA,uBAAA;AAAA,KACxD,CAAA,CAAA;AAAA;AAEN;AAEO,MAAM,+BAAsD,CAAA;AAAA,EAChD,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,IAAe,EAAA;AACzB,IAAA,IAAA,CAAK,SAAS,IAAK,CAAA,MAAA;AACnB,IAAK,IAAA,CAAA,MAAA,GAAS,IAAI,MAAA,CAAO,IAAI,CAAA;AAAA;AAC/B,EAEA,MAAM,eAAe,KAAqC,EAAA;AACxD,IAAA,OAAO,IAAK,CAAA,MAAA,CAAO,cAAe,CAAA,IAAA,CAAK,QAAQ,KAAK,CAAA;AAAA;AACtD,EAEA,MAAM,kBAAkB,SAAgD,EAAA;AACtE,IAAA,IAAI,iBAA2B,EAAC;AAChC,IAAI,IAAA,OAAO,cAAc,QAAU,EAAA;AACjC,MAAA,cAAA,GAAiB,CAAC,SAAS,CAAA;AAAA,KACtB,MAAA;AACL,MAAiB,cAAA,GAAA,SAAA;AAAA;AAGnB,IAAA,MAAM,aAAgB,GAAA,MAAM,IAAK,CAAA,MAAA,CAAO,MAEtC,iCAAiC,CAAA;AACnC,IAAA,MAAM,KAAQ,GAAA,MAAA,CAAO,MAAO,CAAA,aAAa,CACtC,CAAA,IAAA,EACA,CAAA,GAAA,CAAI,CAAa,SAAA,KAAA,SAAA,CAAU,KAAK,CAAA,CAChC,IAAK,EAAA;AACR,IAAM,MAAA,cAAA,GAAiB,MAAM,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACvC;AAAA,KACF;AAEA,IAAO,OAAA,cAAA,CACJ,IAAI,CAAY,QAAA,KAAA;AACf,MAAA,MAAM,CAAC,KAAO,EAAA,UAAU,CAAI,GAAA,QAAA,CAAS,MAAM,GAAG,CAAA;AAE9C,MAAA,MAAM,gBAAgB,KAAM,CAAA,MAAA;AAAA,QAC1B,UAAQ,IAAK,CAAA,MAAA,IAAU,IAAK,CAAA,MAAA,CAAO,KAAK,CAAM,KAAA;AAAA,OAChD;AACA,MAAM,MAAA,cAAA,GAAiB,cAAe,CAAA,IAAA,CAAK,MAAO,CAAA,MAAA;AAAA,QAChD,CAAiB,aAAA,KAAA,aAAA,CAAc,MAAO,CAAA,KAAK,CAAM,KAAA;AAAA,OACnD;AAEA,MAAO,OAAA,aAAA,CAAc,IAAI,CAAQ,IAAA,KAAA;AAC/B,QAAA,MAAM,yBAAyB,cAAe,CAAA,MAAA;AAAA,UAC5C,CACE,aAAA,KAAA,aAAA,CAAc,MAAO,CAAA,SAAA,KAAc,KAAK,aAAc,CAAA;AAAA,SAC1D;AAEA,QAAA,MAAM,wBACJ,sBAAuB,CAAA,MAAA;AAAA,UACrB,CAAC,UAAU,KAAU,KAAA;AACnB,YAAA,QAAQ,MAAM,KAAO;AAAA,cACnB,KAAK,QAAA;AACH,gBAAA,QAAA,CAAS,MAAU,IAAA,CAAA;AACnB,gBAAA;AAAA,cACF,KAAK,SAAA;AACH,gBAAA,QAAA,CAAS,OAAW,IAAA,CAAA;AACpB,gBAAA;AAAA,cACF,KAAK,UAAA;AACH,gBAAA,QAAA,CAAS,QAAY,IAAA,CAAA;AACrB,gBAAA;AAAA,cACF,KAAK,QAAA;AACH,gBAAA,QAAA,CAAS,MAAU,IAAA,CAAA;AACnB,gBAAA;AAAA,cACF,KAAK,OAAA;AACH,gBAAA,QAAA,CAAS,KAAS,IAAA,CAAA;AAClB,gBAAA;AAAA,cACF;AACE,gBAAA,QAAA,CAAS,OAAW,IAAA,CAAA;AAAA;AAGxB,YAAO,OAAA,QAAA;AAAA,WACT;AAAA,UACA;AAAA,YACE,MAAQ,EAAA,CAAA;AAAA,YACR,OAAS,EAAA,CAAA;AAAA,YACT,QAAU,EAAA,CAAA;AAAA,YACV,MAAQ,EAAA,CAAA;AAAA,YACR,KAAO,EAAA,CAAA;AAAA,YACP,OAAS,EAAA;AAAA;AACX,SACF;AAEF,QAAO,OAAA;AAAA,UACL,IAAA,EAAM,KAAK,aAAc,CAAA,KAAA;AAAA,UACzB,KAAK,CAAG,EAAA,IAAA,CAAK,MAAM,CAAqB,kBAAA,EAAA,IAAA,CAAK,cAAc,GAAG,CAAA,KAAA,CAAA;AAAA,UAC9D,gBAAkB,EAAA,QAAA;AAAA,UAClB,OAAO,IAAK,CAAA,QAAA;AAAA,YACV,qBAAA;AAAA,YACA,sBAAuB,CAAA;AAAA;AACzB,SACF;AAAA,OACD,CAAA;AAAA,KACF,EACA,IAAK,EAAA;AAAA;AACV,EAEQ,QAAA,CACN,QACA,WACY,EAAA;AACZ,IAAI,IAAA,MAAA,CAAO,WAAW,CAAG,EAAA;AACvB,MAAO,OAAA,UAAA;AAAA,KACT,MAAA,IAAW,MAAO,CAAA,KAAA,GAAQ,CAAG,EAAA;AAC3B,MAAO,OAAA,OAAA;AAAA,KACT,MAAA,IAAW,MAAO,CAAA,OAAA,GAAU,CAAG,EAAA;AAC7B,MAAO,OAAA,SAAA;AAAA;AAET,IAAI,IAAA,MAAA,CAAO,WAAW,WAAa,EAAA;AACjC,MAAO,OAAA,QAAA;AAAA,KACT,MAAA,IACE,OAAO,MAAW,KAAA,WAAA,IAClB,OAAO,MAAS,GAAA,MAAA,CAAO,WAAW,WAClC,EAAA;AACA,MAAO,OAAA,QAAA;AAAA;AAGT,IAAO,OAAA,KAAA;AAAA;AAEX;;;;"}
+{"version":3,"file":"api.esm.js","sources":["../src/api.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  createApiRef,\n  DiscoveryApi,\n  FetchApi,\n} from '@backstage/frontend-plugin-api';\nimport { QueryEvaluator } from './query';\nimport { Alert, Dashboard } from './types';\n\n/**\n * Interface for the Grafana API\n * @public\n */\nexport interface GrafanaApi {\n  /**\n   * Returns the found dashboards in Grafana with the defined query\n   * @param query - The query used to list the dashboards\n   */\n  listDashboards(query: string): Promise<Dashboard[]>;\n  /**\n   * Returns a list of alerts found in Grafana that have any of the defined alert selectors\n   * @param selectors - One or multiple alert selectors\n   */\n  alertsForSelector(selectors: string | string[]): Promise<Alert[]>;\n}\n\ninterface AggregatedAlertState {\n  Normal: number;\n  Pending: number;\n  Alerting: number;\n  NoData: number;\n  Error: number;\n  Invalid: number;\n}\n\ntype AlertState =\n  | 'Normal'\n  | 'Pending'\n  | 'Alerting'\n  | 'NoData'\n  | 'Error'\n  | 'n/a';\n\ninterface AlertInstance {\n  labels: Record<string, string>;\n  state: AlertState;\n}\n\ninterface AlertsData {\n  data: { alerts: AlertInstance[] };\n}\n\ninterface AlertRuleGroupConfig {\n  name: string;\n  rules: AlertRule[];\n}\n\ninterface GrafanaAlert {\n  id: number;\n  panelId: number;\n  name: string;\n  state: string;\n  url: string;\n}\n\ninterface UnifiedGrafanaAlert {\n  uid: string;\n  title: string;\n}\n\ninterface AlertRule {\n  labels: Record<string, string>;\n  grafana_alert: UnifiedGrafanaAlert;\n}\n\n/**\n * The grafana API reference\n * @public\n */\nexport const grafanaApiRef = createApiRef<GrafanaApi>().with({\n  id: 'plugin.grafana.service',\n});\n\nexport type Options = {\n  discoveryApi: DiscoveryApi;\n  fetchApi: FetchApi;\n\n  /**\n   * Domain used by users to access Grafana web UI.\n   * Example: https://monitoring.my-company.com/\n   */\n  domain: string;\n\n  /**\n   * Path to use for requests via the proxy, defaults to /grafana/api\n   */\n  proxyPath?: string;\n\n  /**\n   * Limit value to pass in Grafana Dashboard search query.\n   */\n  grafanaDashboardSearchLimit?: number;\n\n  /**\n   * Max pages of Grafana Dashboard search query to fetch.\n   */\n  grafanaDashboardMaxPages?: number;\n};\n\nconst DEFAULT_PROXY_PATH = '/grafana/api';\n// upstream default if no limit is specified.\nconst DEFAULT_DASHBOARDS_LIMIT: number = 1000;\nconst DEFAULT_PAGES_LIMIT: number = 1;\n// upstream limit: https://github.com/grafana/grafana/blob/2ee956192064343c73009ffe106178bf4e983844/pkg/api/search.go#L43\nconst UPSTREAM_DASHBOARDS_LIMIT_MAX: number = 5000;\n\nconst isSingleWord = (input: string): boolean => {\n  return input.match(/^[\\w-]+$/g) !== null;\n};\n\nclass Client {\n  private readonly discoveryApi: DiscoveryApi;\n  private readonly fetchApi: FetchApi;\n  private readonly proxyPath: string;\n  private readonly queryEvaluator: QueryEvaluator;\n  private readonly grafanaDashboardSearchLimit: number;\n  private readonly grafanaDashboardMaxPages: number;\n\n  constructor(opts: Options) {\n    this.discoveryApi = opts.discoveryApi;\n    this.fetchApi = opts.fetchApi;\n    this.proxyPath = opts.proxyPath ?? DEFAULT_PROXY_PATH;\n    this.queryEvaluator = new QueryEvaluator();\n    this.grafanaDashboardSearchLimit = Math.min(\n      opts.grafanaDashboardSearchLimit ?? DEFAULT_DASHBOARDS_LIMIT,\n      UPSTREAM_DASHBOARDS_LIMIT_MAX,\n    );\n    this.grafanaDashboardMaxPages =\n      opts.grafanaDashboardMaxPages ?? DEFAULT_PAGES_LIMIT;\n  }\n\n  public async fetch<T = any>(input: string, init?: RequestInit): Promise<T> {\n    const apiUrl = await this.apiUrl();\n    const resp = await this.fetchApi.fetch(`${apiUrl}${input}`, init);\n    if (!resp.ok) {\n      throw new Error(`Request failed with ${resp.status} ${resp.statusText}`);\n    }\n\n    return await resp.json();\n  }\n\n  async listDashboards(domain: string, query: string): Promise<Dashboard[]> {\n    if (isSingleWord(query)) {\n      return this.dashboardsByTag(domain, query);\n    }\n\n    return this.dashboardsForQuery(domain, query);\n  }\n\n  private async fetchSomeDashboards(options: {\n    domain: string;\n    page: number;\n    limit: number;\n    tag?: string;\n  }): Promise<Dashboard[]> {\n    const query = `/api/search?type=dash-db&limit=${options.limit}&page=${\n      options.page\n    }${options.tag !== undefined ? `&tag=${options.tag}` : ''}`;\n    const response = await this.fetch<Dashboard[]>(query);\n    return this.fullyQualifiedDashboardMetadata(options.domain, response);\n  }\n\n  // Grafana Search API does not have pagination metadata in the response body or headers\n  // so we have to guess if we are at the end based on number of items in the result\n  // https://grafana.com/docs/grafana/latest/developers/http_api/folder_dashboard_search/\n  // The API also does not use continuation tokens, so there is no guarantee\n  // that dashboards have not been added or deleted since listing the previous\n  // page.\n  private async fetchAllDashboards(options: {\n    domain: string;\n    tag?: string;\n  }): Promise<Dashboard[]> {\n    let page: number = 0;\n    const allDashboards: Dashboard[] = [];\n    let more: boolean = true;\n    do {\n      const dashboards: Dashboard[] = await this.fetchSomeDashboards({\n        domain: options.domain,\n        page: page++,\n        limit: this.grafanaDashboardSearchLimit,\n        tag: options.tag,\n      });\n      allDashboards.push(...dashboards);\n      // pages limit exists to prevent accidental infinite loops from Grafana\n      more =\n        dashboards.length >= this.grafanaDashboardSearchLimit &&\n        page < this.grafanaDashboardMaxPages;\n    } while (more);\n    return allDashboards;\n  }\n\n  async dashboardsForQuery(\n    domain: string,\n    query: string,\n  ): Promise<Dashboard[]> {\n    const parsedQuery = this.queryEvaluator.parse(query);\n    const allDashboards = await this.fetchAllDashboards({ domain: domain });\n    return allDashboards.filter(dashboard => {\n      return this.queryEvaluator.evaluate(parsedQuery, dashboard) === true;\n    });\n  }\n\n  async dashboardsByTag(domain: string, tag: string): Promise<Dashboard[]> {\n    return this.fetchAllDashboards({ domain: domain, tag: tag });\n  }\n\n  private fullyQualifiedDashboardMetadata(\n    domain: string,\n    dashboards: Dashboard[],\n  ): Dashboard[] {\n    return dashboards.map(dashboard => ({\n      ...dashboard,\n      url: domain + dashboard.url,\n      folderTitle: dashboard.folderTitle ?? '',\n      folderUrl: domain + dashboard.folderUrl,\n    }));\n  }\n\n  private async apiUrl() {\n    const proxyUrl = await this.discoveryApi.getBaseUrl('proxy');\n    return proxyUrl + this.proxyPath;\n  }\n}\n\nexport class GrafanaApiClient implements GrafanaApi {\n  private readonly domain: string;\n  private readonly client: Client;\n\n  constructor(opts: Options) {\n    this.domain = opts.domain;\n    this.client = new Client(opts);\n  }\n\n  async listDashboards(query: string): Promise<Dashboard[]> {\n    return this.client.listDashboards(this.domain, query);\n  }\n\n  async alertsForSelector(dashboardTag: string): Promise<Alert[]> {\n    const response = await this.client.fetch<GrafanaAlert[]>(\n      `/api/alerts?dashboardTag=${dashboardTag}`,\n    );\n\n    return response.map(alert => ({\n      name: alert.name,\n      state: alert.state,\n      matchingSelector: dashboardTag,\n      url: `${this.domain}${alert.url}?panelId=${alert.panelId}&fullscreen&refresh=30s`,\n    }));\n  }\n}\n\nexport class UnifiedAlertingGrafanaApiClient implements GrafanaApi {\n  private readonly domain: string;\n  private readonly client: Client;\n\n  constructor(opts: Options) {\n    this.domain = opts.domain;\n    this.client = new Client(opts);\n  }\n\n  async listDashboards(query: string): Promise<Dashboard[]> {\n    return this.client.listDashboards(this.domain, query);\n  }\n\n  async alertsForSelector(selectors: string | string[]): Promise<Alert[]> {\n    let labelSelectors: string[] = [];\n    if (typeof selectors === 'string') {\n      labelSelectors = [selectors];\n    } else {\n      labelSelectors = selectors;\n    }\n\n    const rulesResponse = await this.client.fetch<\n      Record<string, AlertRuleGroupConfig[]>\n    >('/api/ruler/grafana/api/v1/rules');\n    const rules = Object.values(rulesResponse)\n      .flat()\n      .map(ruleGroup => ruleGroup.rules)\n      .flat();\n    const alertsResponse = await this.client.fetch<AlertsData>(\n      '/api/prometheus/grafana/api/v1/alerts',\n    );\n\n    return labelSelectors\n      .map(selector => {\n        const [label, labelValue] = selector.split('=');\n\n        const matchingRules = rules.filter(\n          rule => rule.labels && rule.labels[label] === labelValue,\n        );\n        const alertInstances = alertsResponse.data.alerts.filter(\n          alertInstance => alertInstance.labels[label] === labelValue,\n        );\n\n        return matchingRules.map(rule => {\n          const matchingAlertInstances = alertInstances.filter(\n            alertInstance =>\n              alertInstance.labels.alertname === rule.grafana_alert.title,\n          );\n\n          const aggregatedAlertStates: AggregatedAlertState =\n            matchingAlertInstances.reduce(\n              (previous, alert) => {\n                switch (alert.state) {\n                  case 'Normal':\n                    previous.Normal += 1;\n                    break;\n                  case 'Pending':\n                    previous.Pending += 1;\n                    break;\n                  case 'Alerting':\n                    previous.Alerting += 1;\n                    break;\n                  case 'NoData':\n                    previous.NoData += 1;\n                    break;\n                  case 'Error':\n                    previous.Error += 1;\n                    break;\n                  default:\n                    previous.Invalid += 1;\n                }\n\n                return previous;\n              },\n              {\n                Normal: 0,\n                Pending: 0,\n                Alerting: 0,\n                NoData: 0,\n                Error: 0,\n                Invalid: 0,\n              },\n            );\n\n          return {\n            name: rule.grafana_alert.title,\n            url: `${this.domain}/alerting/grafana/${rule.grafana_alert.uid}/view`,\n            matchingSelector: selector,\n            state: this.getState(\n              aggregatedAlertStates,\n              matchingAlertInstances.length,\n            ),\n          };\n        });\n      })\n      .flat();\n  }\n\n  private getState(\n    states: AggregatedAlertState,\n    totalAlerts: number,\n  ): AlertState {\n    if (states.Alerting > 0) {\n      return 'Alerting';\n    } else if (states.Error > 0) {\n      return 'Error';\n    } else if (states.Pending > 0) {\n      return 'Pending';\n    }\n    if (states.NoData === totalAlerts) {\n      return 'NoData';\n    } else if (\n      states.Normal === totalAlerts ||\n      states.Normal + states.NoData === totalAlerts\n    ) {\n      return 'Normal';\n    }\n\n    return 'n/a';\n  }\n}\n"],"names":[],"mappings":";;;AA8Fa,MAAA,aAAA,GAAgB,YAAyB,EAAA,CAAE,IAAK,CAAA;AAAA,EAC3D,EAAI,EAAA;AACN,CAAC;AA4BD,MAAM,kBAAqB,GAAA,cAAA;AAE3B,MAAM,wBAAmC,GAAA,GAAA;AACzC,MAAM,mBAA8B,GAAA,CAAA;AAEpC,MAAM,6BAAwC,GAAA,GAAA;AAE9C,MAAM,YAAA,GAAe,CAAC,KAA2B,KAAA;AAC/C,EAAO,OAAA,KAAA,CAAM,KAAM,CAAA,WAAW,CAAM,KAAA,IAAA;AACtC,CAAA;AAEA,MAAM,MAAO,CAAA;AAAA,EACM,YAAA;AAAA,EACA,QAAA;AAAA,EACA,SAAA;AAAA,EACA,cAAA;AAAA,EACA,2BAAA;AAAA,EACA,wBAAA;AAAA,EAEjB,YAAY,IAAe,EAAA;AACzB,IAAA,IAAA,CAAK,eAAe,IAAK,CAAA,YAAA;AACzB,IAAA,IAAA,CAAK,WAAW,IAAK,CAAA,QAAA;AACrB,IAAK,IAAA,CAAA,SAAA,GAAY,KAAK,SAAa,IAAA,kBAAA;AACnC,IAAK,IAAA,CAAA,cAAA,GAAiB,IAAI,cAAe,EAAA;AACzC,IAAA,IAAA,CAAK,8BAA8B,IAAK,CAAA,GAAA;AAAA,MACtC,KAAK,2BAA+B,IAAA,wBAAA;AAAA,MACpC;AAAA,KACF;AACA,IAAK,IAAA,CAAA,wBAAA,GACH,KAAK,wBAA4B,IAAA,mBAAA;AAAA;AACrC,EAEA,MAAa,KAAe,CAAA,KAAA,EAAe,IAAgC,EAAA;AACzE,IAAM,MAAA,MAAA,GAAS,MAAM,IAAA,CAAK,MAAO,EAAA;AACjC,IAAM,MAAA,IAAA,GAAO,MAAM,IAAA,CAAK,QAAS,CAAA,KAAA,CAAM,GAAG,MAAM,CAAA,EAAG,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA;AAChE,IAAI,IAAA,CAAC,KAAK,EAAI,EAAA;AACZ,MAAM,MAAA,IAAI,MAAM,CAAuB,oBAAA,EAAA,IAAA,CAAK,MAAM,CAAI,CAAA,EAAA,IAAA,CAAK,UAAU,CAAE,CAAA,CAAA;AAAA;AAGzE,IAAO,OAAA,MAAM,KAAK,IAAK,EAAA;AAAA;AACzB,EAEA,MAAM,cAAe,CAAA,MAAA,EAAgB,KAAqC,EAAA;AACxE,IAAI,IAAA,YAAA,CAAa,KAAK,CAAG,EAAA;AACvB,MAAO,OAAA,IAAA,CAAK,eAAgB,CAAA,MAAA,EAAQ,KAAK,CAAA;AAAA;AAG3C,IAAO,OAAA,IAAA,CAAK,kBAAmB,CAAA,MAAA,EAAQ,KAAK,CAAA;AAAA;AAC9C,EAEA,MAAc,oBAAoB,OAKT,EAAA;AACvB,IAAA,MAAM,KAAQ,GAAA,CAAA,+BAAA,EAAkC,OAAQ,CAAA,KAAK,SAC3D,OAAQ,CAAA,IACV,CAAG,EAAA,OAAA,CAAQ,QAAQ,KAAY,CAAA,GAAA,CAAA,KAAA,EAAQ,OAAQ,CAAA,GAAG,KAAK,EAAE,CAAA,CAAA;AACzD,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,KAAA,CAAmB,KAAK,CAAA;AACpD,IAAA,OAAO,IAAK,CAAA,+BAAA,CAAgC,OAAQ,CAAA,MAAA,EAAQ,QAAQ,CAAA;AAAA;AACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAc,mBAAmB,OAGR,EAAA;AACvB,IAAA,IAAI,IAAe,GAAA,CAAA;AACnB,IAAA,MAAM,gBAA6B,EAAC;AACpC,IAAA,IAAI,IAAgB,GAAA,IAAA;AACpB,IAAG,GAAA;AACD,MAAM,MAAA,UAAA,GAA0B,MAAM,IAAA,CAAK,mBAAoB,CAAA;AAAA,QAC7D,QAAQ,OAAQ,CAAA,MAAA;AAAA,QAChB,IAAM,EAAA,IAAA,EAAA;AAAA,QACN,OAAO,IAAK,CAAA,2BAAA;AAAA,QACZ,KAAK,OAAQ,CAAA;AAAA,OACd,CAAA;AACD,MAAc,aAAA,CAAA,IAAA,CAAK,GAAG,UAAU,CAAA;AAEhC,MAAA,IAAA,GACE,UAAW,CAAA,MAAA,IAAU,IAAK,CAAA,2BAAA,IAC1B,OAAO,IAAK,CAAA,wBAAA;AAAA,KACP,QAAA,IAAA;AACT,IAAO,OAAA,aAAA;AAAA;AACT,EAEA,MAAM,kBACJ,CAAA,MAAA,EACA,KACsB,EAAA;AACtB,IAAA,MAAM,WAAc,GAAA,IAAA,CAAK,cAAe,CAAA,KAAA,CAAM,KAAK,CAAA;AACnD,IAAA,MAAM,gBAAgB,MAAM,IAAA,CAAK,kBAAmB,CAAA,EAAE,QAAgB,CAAA;AACtE,IAAO,OAAA,aAAA,CAAc,OAAO,CAAa,SAAA,KAAA;AACvC,MAAA,OAAO,IAAK,CAAA,cAAA,CAAe,QAAS,CAAA,WAAA,EAAa,SAAS,CAAM,KAAA,IAAA;AAAA,KACjE,CAAA;AAAA;AACH,EAEA,MAAM,eAAgB,CAAA,MAAA,EAAgB,GAAmC,EAAA;AACvE,IAAA,OAAO,IAAK,CAAA,kBAAA,CAAmB,EAAE,MAAA,EAAgB,KAAU,CAAA;AAAA;AAC7D,EAEQ,+BAAA,CACN,QACA,UACa,EAAA;AACb,IAAO,OAAA,UAAA,CAAW,IAAI,CAAc,SAAA,MAAA;AAAA,MAClC,GAAG,SAAA;AAAA,MACH,GAAA,EAAK,SAAS,SAAU,CAAA,GAAA;AAAA,MACxB,WAAA,EAAa,UAAU,WAAe,IAAA,EAAA;AAAA,MACtC,SAAA,EAAW,SAAS,SAAU,CAAA;AAAA,KAC9B,CAAA,CAAA;AAAA;AACJ,EAEA,MAAc,MAAS,GAAA;AACrB,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,WAAW,OAAO,CAAA;AAC3D,IAAA,OAAO,WAAW,IAAK,CAAA,SAAA;AAAA;AAE3B;AAEO,MAAM,gBAAuC,CAAA;AAAA,EACjC,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,IAAe,EAAA;AACzB,IAAA,IAAA,CAAK,SAAS,IAAK,CAAA,MAAA;AACnB,IAAK,IAAA,CAAA,MAAA,GAAS,IAAI,MAAA,CAAO,IAAI,CAAA;AAAA;AAC/B,EAEA,MAAM,eAAe,KAAqC,EAAA;AACxD,IAAA,OAAO,IAAK,CAAA,MAAA,CAAO,cAAe,CAAA,IAAA,CAAK,QAAQ,KAAK,CAAA;AAAA;AACtD,EAEA,MAAM,kBAAkB,YAAwC,EAAA;AAC9D,IAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACjC,4BAA4B,YAAY,CAAA;AAAA,KAC1C;AAEA,IAAO,OAAA,QAAA,CAAS,IAAI,CAAU,KAAA,MAAA;AAAA,MAC5B,MAAM,KAAM,CAAA,IAAA;AAAA,MACZ,OAAO,KAAM,CAAA,KAAA;AAAA,MACb,gBAAkB,EAAA,YAAA;AAAA,MAClB,GAAA,EAAK,GAAG,IAAK,CAAA,MAAM,GAAG,KAAM,CAAA,GAAG,CAAY,SAAA,EAAA,KAAA,CAAM,OAAO,CAAA,uBAAA;AAAA,KACxD,CAAA,CAAA;AAAA;AAEN;AAEO,MAAM,+BAAsD,CAAA;AAAA,EAChD,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,IAAe,EAAA;AACzB,IAAA,IAAA,CAAK,SAAS,IAAK,CAAA,MAAA;AACnB,IAAK,IAAA,CAAA,MAAA,GAAS,IAAI,MAAA,CAAO,IAAI,CAAA;AAAA;AAC/B,EAEA,MAAM,eAAe,KAAqC,EAAA;AACxD,IAAA,OAAO,IAAK,CAAA,MAAA,CAAO,cAAe,CAAA,IAAA,CAAK,QAAQ,KAAK,CAAA;AAAA;AACtD,EAEA,MAAM,kBAAkB,SAAgD,EAAA;AACtE,IAAA,IAAI,iBAA2B,EAAC;AAChC,IAAI,IAAA,OAAO,cAAc,QAAU,EAAA;AACjC,MAAA,cAAA,GAAiB,CAAC,SAAS,CAAA;AAAA,KACtB,MAAA;AACL,MAAiB,cAAA,GAAA,SAAA;AAAA;AAGnB,IAAA,MAAM,aAAgB,GAAA,MAAM,IAAK,CAAA,MAAA,CAAO,MAEtC,iCAAiC,CAAA;AACnC,IAAA,MAAM,KAAQ,GAAA,MAAA,CAAO,MAAO,CAAA,aAAa,CACtC,CAAA,IAAA,EACA,CAAA,GAAA,CAAI,CAAa,SAAA,KAAA,SAAA,CAAU,KAAK,CAAA,CAChC,IAAK,EAAA;AACR,IAAM,MAAA,cAAA,GAAiB,MAAM,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACvC;AAAA,KACF;AAEA,IAAO,OAAA,cAAA,CACJ,IAAI,CAAY,QAAA,KAAA;AACf,MAAA,MAAM,CAAC,KAAO,EAAA,UAAU,CAAI,GAAA,QAAA,CAAS,MAAM,GAAG,CAAA;AAE9C,MAAA,MAAM,gBAAgB,KAAM,CAAA,MAAA;AAAA,QAC1B,UAAQ,IAAK,CAAA,MAAA,IAAU,IAAK,CAAA,MAAA,CAAO,KAAK,CAAM,KAAA;AAAA,OAChD;AACA,MAAM,MAAA,cAAA,GAAiB,cAAe,CAAA,IAAA,CAAK,MAAO,CAAA,MAAA;AAAA,QAChD,CAAiB,aAAA,KAAA,aAAA,CAAc,MAAO,CAAA,KAAK,CAAM,KAAA;AAAA,OACnD;AAEA,MAAO,OAAA,aAAA,CAAc,IAAI,CAAQ,IAAA,KAAA;AAC/B,QAAA,MAAM,yBAAyB,cAAe,CAAA,MAAA;AAAA,UAC5C,CACE,aAAA,KAAA,aAAA,CAAc,MAAO,CAAA,SAAA,KAAc,KAAK,aAAc,CAAA;AAAA,SAC1D;AAEA,QAAA,MAAM,wBACJ,sBAAuB,CAAA,MAAA;AAAA,UACrB,CAAC,UAAU,KAAU,KAAA;AACnB,YAAA,QAAQ,MAAM,KAAO;AAAA,cACnB,KAAK,QAAA;AACH,gBAAA,QAAA,CAAS,MAAU,IAAA,CAAA;AACnB,gBAAA;AAAA,cACF,KAAK,SAAA;AACH,gBAAA,QAAA,CAAS,OAAW,IAAA,CAAA;AACpB,gBAAA;AAAA,cACF,KAAK,UAAA;AACH,gBAAA,QAAA,CAAS,QAAY,IAAA,CAAA;AACrB,gBAAA;AAAA,cACF,KAAK,QAAA;AACH,gBAAA,QAAA,CAAS,MAAU,IAAA,CAAA;AACnB,gBAAA;AAAA,cACF,KAAK,OAAA;AACH,gBAAA,QAAA,CAAS,KAAS,IAAA,CAAA;AAClB,gBAAA;AAAA,cACF;AACE,gBAAA,QAAA,CAAS,OAAW,IAAA,CAAA;AAAA;AAGxB,YAAO,OAAA,QAAA;AAAA,WACT;AAAA,UACA;AAAA,YACE,MAAQ,EAAA,CAAA;AAAA,YACR,OAAS,EAAA,CAAA;AAAA,YACT,QAAU,EAAA,CAAA;AAAA,YACV,MAAQ,EAAA,CAAA;AAAA,YACR,KAAO,EAAA,CAAA;AAAA,YACP,OAAS,EAAA;AAAA;AACX,SACF;AAEF,QAAO,OAAA;AAAA,UACL,IAAA,EAAM,KAAK,aAAc,CAAA,KAAA;AAAA,UACzB,KAAK,CAAG,EAAA,IAAA,CAAK,MAAM,CAAqB,kBAAA,EAAA,IAAA,CAAK,cAAc,GAAG,CAAA,KAAA,CAAA;AAAA,UAC9D,gBAAkB,EAAA,QAAA;AAAA,UAClB,OAAO,IAAK,CAAA,QAAA;AAAA,YACV,qBAAA;AAAA,YACA,sBAAuB,CAAA;AAAA;AACzB,SACF;AAAA,OACD,CAAA;AAAA,KACF,EACA,IAAK,EAAA;AAAA;AACV,EAEQ,QAAA,CACN,QACA,WACY,EAAA;AACZ,IAAI,IAAA,MAAA,CAAO,WAAW,CAAG,EAAA;AACvB,MAAO,OAAA,UAAA;AAAA,KACT,MAAA,IAAW,MAAO,CAAA,KAAA,GAAQ,CAAG,EAAA;AAC3B,MAAO,OAAA,OAAA;AAAA,KACT,MAAA,IAAW,MAAO,CAAA,OAAA,GAAU,CAAG,EAAA;AAC7B,MAAO,OAAA,SAAA;AAAA;AAET,IAAI,IAAA,MAAA,CAAO,WAAW,WAAa,EAAA;AACjC,MAAO,OAAA,QAAA;AAAA,KACT,MAAA,IACE,OAAO,MAAW,KAAA,WAAA,IAClB,OAAO,MAAS,GAAA,MAAA,CAAO,WAAW,WAClC,EAAA;AACA,MAAO,OAAA,QAAA;AAAA;AAGT,IAAO,OAAA,KAAA;AAAA;AAEX;;;;"}

package/dist/index.d.ts

@@ -107,12 +107,12 @@ declare const grafanaPlugin: _backstage_core_plugin_api.BackstagePlugin<{}, {},
  * Component which displays the grafana dashboards found for an entity
  * @public
  */
-declare const EntityGrafanaDashboardsCard: (opts?: DashboardCardOpts | undefined) => react_jsx_runtime.JSX.Element;
+declare const EntityGrafanaDashboardsCard: (opts?: DashboardCardOpts) => react_jsx_runtime.JSX.Element;
 /**
  * Component which displays the grafana alerts found for an entity
  * @public
  */
-declare const EntityGrafanaAlertsCard: (opts?: AlertsCardOpts | undefined) => react_jsx_runtime.JSX.Element;
+declare const EntityGrafanaAlertsCard: (opts?: AlertsCardOpts) => react_jsx_runtime.JSX.Element;
 /**
  * Component which displays the defined grafana dashboard for an entity
  * @public
@@ -185,6 +185,8 @@ interface GrafanaApi {
  * The grafana API reference
  * @public
  */
-declare const grafanaApiRef: _backstage_frontend_plugin_api.ApiRef<GrafanaApi>;
+declare const grafanaApiRef: _backstage_frontend_plugin_api.ApiRef<GrafanaApi, "plugin.grafana.service"> & {
+    readonly $$type: "@backstage/ApiRef";
+};
 
 export { type Alert, type AlertsCardOpts, type Dashboard, type DashboardCardOpts, DashboardViewer, EntityDashboardViewer, EntityGrafanaAlertsCard, EntityGrafanaDashboardsCard, EntityOverviewDashboardViewer, GRAFANA_ANNOTATION_ALERT_LABEL_SELECTOR, GRAFANA_ANNOTATION_DASHBOARD_SELECTOR, GRAFANA_ANNOTATION_OVERVIEW_DASHBOARD, type GrafanaApi, alertSelectorFromEntity, dashboardSelectorFromEntity, grafanaApiRef, grafanaPlugin, isAlertSelectorAvailable, isDashboardSelectorAvailable, isOverviewDashboardAvailable, overviewDashboardFromEntity };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage-community/plugin-grafana",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "A Backstage backend plugin that integrates towards Grafana",
   "main": "./dist/index.esm.js",
   "types": "./dist/index.d.ts",
@@ -62,11 +62,11 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/catalog-model": "^1.7.6",
-    "@backstage/core-components": "^0.18.7",
-    "@backstage/core-plugin-api": "^1.12.3",
-    "@backstage/frontend-plugin-api": "^0.14.1",
-    "@backstage/plugin-catalog-react": "^2.0.0",
+    "@backstage/catalog-model": "^1.7.7",
+    "@backstage/core-components": "^0.18.8",
+    "@backstage/core-plugin-api": "^1.12.4",
+    "@backstage/frontend-plugin-api": "^0.15.1",
+    "@backstage/plugin-catalog-react": "^2.1.0",
     "@material-ui/core": "^4.12.2",
     "@material-ui/lab": "4.0.0-alpha.61",
     "cross-fetch": "^4.0.0",
@@ -79,11 +79,11 @@
     "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.35.4",
-    "@backstage/core-app-api": "^1.19.5",
-    "@backstage/dev-utils": "^1.1.20",
-    "@backstage/frontend-test-utils": "^0.5.0",
-    "@backstage/test-utils": "^1.7.15",
+    "@backstage/cli": "^0.36.0",
+    "@backstage/core-app-api": "^1.19.6",
+    "@backstage/dev-utils": "^1.1.21",
+    "@backstage/frontend-test-utils": "^0.5.1",
+    "@backstage/test-utils": "^1.7.16",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^15.0.0",
     "@testing-library/user-event": "^14.0.0",