@red-hat-developer-hub/backstage-plugin-scorecard 2.8.1 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,66 @@
 # @red-hat-developer-hub/backstage-plugin-scorecard
 
+## 3.0.0
+
+### Major Changes
+
+- f4b8bd4: **BREAKING**: Graduated the New Frontend System (NFS) scorecard plugin to the stable entry point and simplified NFS feature registration.
+
+  - NFS APIs move from `./alpha` to `.`; OFS APIs move to `./legacy` only (not re-exported from the main entry); translations remain at `./alpha`.
+  - `scorecardCatalogModule` and `scorecardHomeModule` are removed. Entity tab, layout, and homepage widgets are now provided by the default `scorecardPlugin`. Keep only `scorecardTranslationsModule` as a separate app module.
+  - Extension IDs move from the `catalog` / `home` namespaces to `scorecard` (for example `entity-content:catalog/entity-content-scorecard` → `entity-content:scorecard/entity-content-scorecard`). Update any `app.extensions` config accordingly. See the plugin README migration notes.
+
+- 6ea1575: **BREAKING**: Rename aggregation KPI type `average` to `weightedStatusScore`.
+
+  ### App config
+
+  - `scorecard.aggregationKPIs.*.type`: `average` → `weightedStatusScore`
+
+  ### `GET /aggregations/:aggregationId` API
+
+  - `metadata.aggregationType`: `average` → `weightedStatusScore`
+  - `result.averageScore` → `result.weightedStatusScore`
+  - `result.averageWeightedSum` → `result.weightedStatusSum`
+  - `result.averageMaxPossible` → `result.weightedStatusMaxPossible`
+
+  ### Frontend translations (`metric.*`)
+
+  Update any scorecard translation overrides that used the old `average*` keys:
+
+  - `metric.averageCenterTooltipTotalLabel` → `metric.weightedStatusScoreCenterTooltipTotalLabel`
+  - `metric.averageCenterTooltipMaxLabel` → `metric.weightedStatusScoreCenterTooltipMaxLabel`
+  - `metric.averageCenterTooltipBreakdownRow_one` / `_other` → `metric.weightedStatusScoreCenterTooltipBreakdownRow_one` / `_other`
+  - `metric.averageLegendTooltipEntitiesEach_one` / `_other` → `metric.weightedStatusScoreLegendTooltipEntitiesEach_one` / `_other`
+  - `metric.averageLegendTooltipRowTotal` → `metric.weightedStatusScoreLegendTooltipRowTotal`
+
+  The `averageLegendTooltip*` keys served the removed side-legend tooltip; the center donut tooltip uses the `weightedStatusScoreCenterTooltip*` keys (including per-status breakdown rows).
+
+  ### UI `data-testid` values
+
+  Update downstream e2e selectors that targeted the weighted-status-score card center label:
+
+  - `average-card-center-percent` → `weighted-status-score-card-center-percent`
+  - `average-card-center-percent-hit-area` → `weighted-status-score-card-center-percent-hit-area`
+
+- dfb90b7: **BREAKING**: Standardize all metric and provider IDs from `snake_case` to `lowerCamelCase`.
+
+  This aligns metric IDs with the naming convention used in `app-config.yaml` and the planned Scorecard design. For example, `github.open_prs` is now `github.openPRs`, `sonarqube.quality_gate` is now `sonarqube.qualityGate`, and `dependabot.alerts_critical` is now `dependabot.alertsCritical`.
+
+  If you reference metric IDs in your `app-config.yaml` (e.g., in `metricId` fields or plugin schedule config keys), update them to use `lowerCamelCase`.
+
+### Minor Changes
+
+- 50447ac: Backstage version bump to v1.52.0
+- f024236: Introduce a MetricGroupCard component that aggregates related metrics into threshold-based bucket tiles with a filterable data sources dialog. ScorecardEntityContentGridView to render grouped metrics as MetricGroupCards and ungrouped metrics as individual Scorecard cards using a Masonry layout. Add i18n keys across all supported locales and comprehensive unit tests for all new components.
+
+### Patch Changes
+
+- 83d8a47: Removed unused `ScorecardStylesProvider` component and `@mui/styles` dependency. JSS class-name isolation is no longer needed after the MUI5 migration.
+- 963c98c: optimized how scorecard homepage is loaded
+- Updated dependencies [50447ac]
+- Updated dependencies [6ea1575]
+  - @red-hat-developer-hub/backstage-plugin-scorecard-common@3.0.0
+
 ## 2.8.1
 
 ### Patch Changes

package/README.md

@@ -2,12 +2,16 @@
 
 The Scorecard plugin provides a configurable framework to visualize Key Performance Indicators (KPIs) in Backstage. This frontend plugin integrates with the Scorecard backend to deliver Scorecards.
 
-The plugin supports both the **legacy** Backstage frontend and the **New Frontend System (NFS)**. Use the main package for legacy apps and the `/alpha` export for NFS apps. For NFS, the plugin currently provides three modules: a catalog module for the Scorecard entity tab, a home module for homepage widgets, and a translations module.
+The plugin supports both the **legacy** Backstage frontend and the **New Frontend System (NFS)**. NFS is the primary package entry point. OFS (legacy) exports are available only at `./legacy`. Translations remain available at `./alpha`.
+
+For NFS, register the default `scorecardPlugin` plus `scorecardTranslationsModule`. The plugin itself contributes the Scorecard page, entity tab, layout, and homepage widgets (no separate catalog/home modules).
+
 **Features:**
 
 - **Entity scorecard tab** — View scorecard metrics on catalog entity pages (components, websites, etc.).
-- **Scorecard homepage card** — Show aggregated KPIs on the home page (e.g. GitHub open PRs, Jira open issues). Supports **`statusGrouped`** (multi-slice pie) and **`average`** (weighted health donut) KPI types configured under **`scorecard.aggregationKPIs`**.
+- **Scorecard homepage card** — Show aggregated KPIs on the home page (e.g. GitHub open PRs, Jira open issues). Supports **`statusGrouped`** (multi-slice pie) and **`weightedStatusScore`** (weighted health donut) KPI types configured under **`scorecard.aggregationKPIs`**.
 - **Scorecard Entities page** — Drill down from an aggregated metric to see the list of entities contributing to that metric, with entity-level values and status, so you can identify services impacting the KPI and investigate issues.
+- **Metric group cards (grid layout)** — Group related metrics into cards with threshold bucket tiles, a filterable/sortable data sources dialog, and a Masonry grid layout. Enabled via app-config.yaml.
 
 ## Getting started
 
@@ -43,21 +47,18 @@ yarn workspace app-legacy add @red-hat-developer-hub/backstage-plugin-scorecard
    yarn workspace app add @red-hat-developer-hub/backstage-plugin-scorecard
    ```
 
-2. Register the plugin in `packages/app/src/App.tsx` using the **alpha** export:
+2. Register the plugin in `packages/app/src/App.tsx`:
 
    ```tsx
    // In packages/app/src/App.tsx
    import { createApp } from '@backstage/frontend-defaults';
-   import {
-     scorecardHomeModule,
+   import scorecardPlugin, {
      scorecardTranslationsModule,
-     scorecardCatalogModule,
-   } from '@red-hat-developer-hub/backstage-plugin-scorecard/alpha';
+   } from '@red-hat-developer-hub/backstage-plugin-scorecard';
 
    const app = createApp({
      features: [
-       scorecardHomeModule,
-       scorecardCatalogModule,
+       scorecardPlugin,
        scorecardTranslationsModule,
        // ... other plugins
      ],
@@ -71,7 +72,7 @@ yarn workspace app-legacy add @red-hat-developer-hub/backstage-plugin-scorecard
    ```yaml
    app:
      extensions:
-       - entity-content:catalog/entity-content-scorecard:
+       - entity-content:scorecard/entity-content-scorecard:
            config:
              allowedFilters:
                - kind: component
@@ -122,7 +123,46 @@ To align with the legacy EntityPage (Scorecard on component pages and default en
 
 5. Start the NFS app (e.g. `yarn start`), go to **Catalog**, open an entity. The **Scorecard** tab appears for entities that match your `allowedFilters` (or all entities if the extension config is omitted or empty).
 
-6. (Optional) Enable homepage Scorecard widgets by adding `scorecardHomeModule` to app features (see step 2) and configuring home page extensions in `app-config.yaml`:
+6. (Optional) Enable the **grid layout** with metric group cards. The grid layout extension is disabled by default. Enable it and define `groups` in `app-config.yaml` to organize metrics into themed cards:
+
+   ```yaml
+   app:
+     extensions:
+       - scorecard-layout:scorecard/scorecard-entity-layout-grid:
+           config:
+             groups:
+               codeQuality:
+                 title: 'Code Quality'
+                 description: 'SonarQube code quality metrics'
+                 metrics:
+                   - sonarqube.reliabilityIssues
+                   - sonarqube.codeCoverage
+                   - sonarqube.securityIssues
+               operations:
+                 title: 'Operations'
+                 metrics:
+                   - github.openPrs
+                   - jira.openIssues
+   ```
+
+   **Groups config schema:**
+
+   | Field         | Type       | Required | Description                                          |
+   | ------------- | ---------- | -------- | ---------------------------------------------------- |
+   | `title`       | `string`   | Yes      | Display title for the group card.                    |
+   | `description` | `string`   | No       | Optional description shown below the title.          |
+   | `metrics`     | `string[]` | Yes      | Ordered list of metric IDs to include in this group. |
+
+   **Behavior:**
+
+   - Metrics listed in `groups` are rendered as **MetricGroupCard** components. Each card shows threshold bucket tiles (e.g. Passing, Warning, Failing) with counts. Clicking a tile opens a **data sources dialog** pre-filtered to that status.
+   - The data sources dialog displays a sortable, filterable table with columns: Plugin, Check, Value, Status, and Last Synced. A threshold legend allows toggling visibility by status.
+   - Metrics **not** listed in any group are rendered as individual Scorecard cards below the group cards.
+   - All cards are arranged in a responsive **Masonry** grid (1 column on mobile, 2 on tablet, 3 on desktop).
+   - If `groups` is empty or omitted, the grid layout falls back to the default `EntityScorecardContent` view (individual cards for all metrics).
+   - When multiple layout extensions are enabled, the Scorecard tab renders a toggle to switch between them.
+
+7. (Optional) Enable homepage Scorecard widgets by configuring home page extensions in `app-config.yaml` (widgets are registered by `scorecardPlugin`):
 
    ```yaml
    app:
@@ -215,27 +255,96 @@ To align with the legacy EntityPage (Scorecard on component pages and default en
 
 ##### Modules and extensions (NFS)
 
-The following modules and extensions are available from `@red-hat-developer-hub/backstage-plugin-scorecard/alpha` for NFS apps:
+The following modules and extensions are available from `@red-hat-developer-hub/backstage-plugin-scorecard` for NFS apps:
 
 **Modules**
 
-| Module                        | Description                                                                                                                                                                                                                                                                                                                                                |
-| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `scorecardHomeModule`         | Registers Scorecard homepage widgets for the home plugin (`AggregatedCardWithDeprecatedMetricId`, `AggregatedCardWithDefaultAggregation`, `AggregatedCardWithJiraOpenIssues`, `AggregatedCardWithGithubOpenPrs`, `AggregatedCardWithGithubFilecheckLicense`, `AggregatedCardWithGithubFilecheckCodeowners` and `AggregatedCardWithGithubOpenPrsWeighted`). |
-| `scorecardCatalogModule`      | Registers the Scorecard entity tab with the catalog plugin. Add to your app's `features`. Which entities show the tab is configured via `app.extensions` (see step 3).                                                                                                                                                                                     |
-| `scorecardTranslationsModule` | Registers Scorecard translations with the app. Add to your app's `features`.                                                                                                                                                                                                                                                                               |
+| Module                        | Description                                                                  |
+| ----------------------------- | ---------------------------------------------------------------------------- |
+| `scorecardTranslationsModule` | Registers Scorecard translations with the app. Add to your app's `features`. |
+
+The default `scorecardPlugin` registers the Scorecard page, API, entity tab, layout, and homepage widgets.
+
+**Extension IDs**
+
+| Extension ID                                                       | Description                                                                                                                      |
+| ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
+| `api:scorecard`                                                    | Scorecard API (auto-discovered when the plugin is installed).                                                                    |
+| `page:scorecard`                                                   | Scorecard entities / drill-down page.                                                                                            |
+| `entity-content:scorecard/entity-content-scorecard`                | Scorecard tab on catalog entity pages. Configure with `allowedFilters` in `app.extensions` to limit by kind and optionally type. |
+| `scorecard-layout:scorecard/scorecard-entity-layout-grid`          | Grid layout with metric group cards (disabled by default). Enable via `app.extensions` and define `groups` (see step 6).         |
+| `home-page-widget:scorecard/scorecard-deprecated-metric-id`        | Homepage widget using deprecated `metricId` (Jira open issues).                                                                  |
+| `home-page-widget:scorecard/scorecard-default-aggregation`         | Homepage widget using default aggregation (GitHub open PRs).                                                                     |
+| `home-page-widget:scorecard/scorecard-jira-open-issues`            | Homepage widget for Jira open blocking tickets.                                                                                  |
+| `home-page-widget:scorecard/scorecard-github-open-prs`             | Homepage widget for GitHub open PRs.                                                                                             |
+| `home-page-widget:scorecard/scorecard-github-filecheck-license`    | Homepage widget for file check "License".                                                                                        |
+| `home-page-widget:scorecard/scorecard-github-filecheck-codeowners` | Homepage widget for file check "Codeowners".                                                                                     |
+| `home-page-widget:scorecard/scorecard-github-open-prs-weighted`    | Homepage widget for weighted GitHub open PRs health.                                                                             |
+
+##### Migration notes (NFS graduation)
+
+If you previously imported Scorecard NFS APIs from `/alpha` and registered separate catalog/home modules, update as follows.
+
+**1. Features registration**
+
+```diff
+- import scorecardPlugin, {
+-   scorecardCatalogModule,
+-   scorecardHomeModule,
+-   scorecardTranslationsModule,
+- } from '@red-hat-developer-hub/backstage-plugin-scorecard/alpha';
++ import scorecardPlugin, {
++   scorecardTranslationsModule,
++ } from '@red-hat-developer-hub/backstage-plugin-scorecard';
+
+  features: [
+    scorecardPlugin,
+-   scorecardCatalogModule,
+-   scorecardHomeModule,
+    scorecardTranslationsModule,
+  ]
+```
 
-**Extensions**
+`scorecardCatalogModule` and `scorecardHomeModule` are removed. Entity tab and homepage widgets are provided by `scorecardPlugin` directly.
+
+**2. `app.extensions` IDs**
+
+Extension IDs now use the `scorecard` plugin namespace (not `catalog` / `home`):
+
+| Old ID                                                        | New ID                                                             |
+| ------------------------------------------------------------- | ------------------------------------------------------------------ |
+| `entity-content:catalog/entity-content-scorecard`             | `entity-content:scorecard/entity-content-scorecard`                |
+| `scorecard-layout:catalog/scorecard-entity-layout-grid`       | `scorecard-layout:scorecard/scorecard-entity-layout-grid`          |
+| `home-page-widget:home/scorecard-deprecated-metric-id`        | `home-page-widget:scorecard/scorecard-deprecated-metric-id`        |
+| `home-page-widget:home/scorecard-default-aggregation`         | `home-page-widget:scorecard/scorecard-default-aggregation`         |
+| `home-page-widget:home/scorecard-jira-open-issues`            | `home-page-widget:scorecard/scorecard-jira-open-issues`            |
+| `home-page-widget:home/scorecard-github-open-prs`             | `home-page-widget:scorecard/scorecard-github-open-prs`             |
+| `home-page-widget:home/scorecard-github-filecheck-license`    | `home-page-widget:scorecard/scorecard-github-filecheck-license`    |
+| `home-page-widget:home/scorecard-github-filecheck-codeowners` | `home-page-widget:scorecard/scorecard-github-filecheck-codeowners` |
+| `home-page-widget:home/scorecard-github-open-prs-weighted`    | `home-page-widget:scorecard/scorecard-github-open-prs-weighted`    |
+
+Example:
+
+```diff
+  app:
+    extensions:
+-     - entity-content:catalog/entity-content-scorecard:
++     - entity-content:scorecard/entity-content-scorecard:
+          config:
+            allowedFilters:
+              - kind: component
+```
 
-- `api:scorecard` — Scorecard API (provided by the plugin; auto-discovered when the plugin is installed).
-- `entity-content:catalog/entity-content-scorecard` — Scorecard tab on catalog entity pages. Configure with `allowedFilters` in `app.extensions` to limit by kind and optionally type.
-- `home-page-widget:home/scorecard-deprecated-metric-id` — Homepage widget using deprecated metricId property (Jira open issues).
-- `home-page-widget:home/scorecard-default-aggregation` — Homepage widget using default aggregation config (GitHub open PRs).
-- `home-page-widget:home/scorecard-jira-open-issues` — Homepage widget showing Jira open blocking tickets.
-- `home-page-widget:home/scorecard-github-open-prs` — Homepage widget showing GitHub open PRs.
-- `home-page-widget:home/scorecard-github-filecheck-license` - Homepage widget showing file check "License".
-- `home-page-widget:home/scorecard-github-filecheck-codeowners` - Homepage widget showing file check "Codeowners".
-- `home-page-widget:home/scorecard-github-open-prs-weighted` - Homepage widget showing average GitHub open PRs.
+Homepage widget **layout** config under `home-page-layout:home/dynamic-homepage-layout` (widget names like `AggregatedCardWithGithubOpenPrs`) is unchanged; only the extension IDs above move namespaces.
+
+**3. Legacy (OFS) imports**
+
+OFS components, the OFS plugin, and status icons are available only from `./legacy` (not re-exported from the main entry):
+
+```diff
+- import { EntityScorecardContent } from '@red-hat-developer-hub/backstage-plugin-scorecard';
++ import { EntityScorecardContent } from '@red-hat-developer-hub/backstage-plugin-scorecard/legacy';
+```
 
 #### Legacy app
 
@@ -248,7 +357,7 @@ The following modules and extensions are available from `@red-hat-developer-hub/
 2. Add the Scorecard tab to the entity overview in `packages/app-legacy/src/components/catalog/EntityPage.tsx` (or your legacy app's equivalent):
 
    ```tsx
-   import { EntityScorecardContent } from '@red-hat-developer-hub/backstage-plugin-scorecard';
+   import { EntityScorecardContent } from '@red-hat-developer-hub/backstage-plugin-scorecard/legacy';
 
    const scorecardRoute = (
      <EntityLayout.Route path="/scorecard" title="Scorecard">
@@ -293,13 +402,13 @@ The following modules and extensions are available from `@red-hat-developer-hub/
 3. (Optional) Add Scorecard homepage cards to your home page:
 
    ```tsx
-   import { ScorecardHomepageCard } from '@red-hat-developer-hub/backstage-plugin-scorecard';
+   import { ScorecardHomepageCard } from '@red-hat-developer-hub/backstage-plugin-scorecard/legacy';
 
    // GitHub open PRs
-   <ScorecardHomepageCard metricId="github.open_prs" />
+   <ScorecardHomepageCard metricId="github.openPRs" />
 
    // Jira open issues
-   <ScorecardHomepageCard metricId="jira.open_issues" />
+   <ScorecardHomepageCard metricId="jira.openIssues" />
    ```
 
 4. Ensure the frontend can reach the Scorecard backend by configuring discovery in `app-config.yaml` (see discovery snippet under [NFS](#nfs-new-frontend-system--app)).
@@ -337,15 +446,15 @@ permission:
 
 ### Homepage scorecard cards
 
-The plugin exports **`ScorecardHomepageCard`** (see [`plugin.ts`](./src/plugin.ts)) for use on customizable home pages (for example **Dynamic Home Page** mount points such as `home.page/cards`).
+The plugin exports **`ScorecardHomepageCard`** from `@red-hat-developer-hub/backstage-plugin-scorecard/legacy` (see [`plugin.ts`](./src/plugin.ts)) for use on customizable home pages (for example **Dynamic Home Page** mount points such as `home.page/cards`).
 
 #### Backend configuration
 
 Define KPI ids and optional labels under **`scorecard.aggregationKPIs`** so each card can call **`GET /aggregations/<aggregationId>`** with a stable id. See [Scorecard backend README — Aggregation KPIs](../scorecard-backend/README.md#aggregation-kpis-homepage-and-get-aggregations). If you omit a KPI entry, use the **metric id** as `aggregationId` (default status-grouped aggregation).
 
-**`type: average`** KPIs require **`options.statusScores`** (weights per threshold rule key). Optionally set **`options.thresholds`** so the API returns **`aggregationChartDisplayColor`** for the headline percentage. Behavior, validation, and drill-down notes are described in [aggregation.md](../scorecard-backend/docs/aggregation.md).
+**`type: weightedStatusScore`** KPIs require **`options.statusScores`** (weights per threshold rule key). Optionally set **`options.thresholds`** so the API returns **`aggregationChartDisplayColor`** for the headline percentage. Behavior, validation, and drill-down notes are described in [aggregation.md](../scorecard-backend/docs/aggregation.md).
 
-For **`type: average`**, the homepage card shows a **centered donut** with the headline percentage. Hovering the **center** opens a tooltip with **total score**, **max possible score**, and a **per-status breakdown** (from aggregation **`result.values`**). There is **no side status legend**; **`statusGrouped`** cards use a multi-slice pie with a legend instead.
+For **`type: weightedStatusScore`**, the homepage card shows a **centered donut** with the headline percentage. Hovering the **center** opens a tooltip with **total score**, **max possible score**, and a **per-status breakdown** (from aggregation **`result.values`**). There is **no side status legend**; **`statusGrouped`** cards use a multi-slice pie with a legend instead.
 
 #### Card props
 
@@ -368,7 +477,7 @@ The supported model is **a single `aggregationId` string** whose value is either
 Example (Dynamic Home Page–style mount point): register **`ScorecardHomepageCard`** and pass **`props.aggregationId`** (and **`metricId`** only if you still run an older card API):
 
 ```tsx
-import { ScorecardHomepageCard } from '@red-hat-developer-hub/backstage-plugin-scorecard';
+import { ScorecardHomepageCard } from '@red-hat-developer-hub/backstage-plugin-scorecard/legacy';
 import { ComponentType } from 'react';
 
 // Inside your home page cards config:
@@ -380,7 +489,7 @@ import { ComponentType } from 'react';
     layouts: { /* … */ },
     props: {
       aggregationId: 'openIssuesKpi',
-      // metricId: 'jira.open_issues', // legacy only; remove when only aggregationId is supported
+      // metricId: 'jira.openIssues', // legacy only; remove when only aggregationId is supported
     },
   },
 },
@@ -448,7 +557,7 @@ If a translation key is not found, the plugin will automatically fall back to:
 ```typescript
 // In ref.ts
 metric: {
-  'github.open_prs': {
+  'github.openPRs': {
     title: 'GitHub open PRs',
     description: 'Current count of open Pull Requests for a given GitHub repository',
   },

package/dist/alpha.d.ts

@@ -1,88 +1,124 @@
-import * as react from 'react';
 import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
-import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
-export { s as scorecardTranslationRef, a as scorecardTranslations } from './types/index.d-DLQMegMp.js';
 
 /**
- * The primary Scorecard frontend plugin.
- * @alpha
+ * Translation reference for scorecard plugin
+ * @public
  */
-declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin<{
-    root: _backstage_core_plugin_api.RouteRef<undefined>;
-    drillDown: _backstage_core_plugin_api.RouteRef<{
-        aggregationId: string;
-        metricId: string;
-    }>;
-}, {}, {
-    "api:scorecard": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
-        kind: "api";
-        name: undefined;
-        config: {};
-        configInput: {};
-        output: _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
-        inputs: {};
-        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>;
-    }>;
-    "page:scorecard": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
-        kind: "page";
-        name: undefined;
-        config: {
-            path: string | undefined;
-            title: string | undefined;
-        };
-        configInput: {
-            path?: string | undefined;
-            title?: string | undefined;
-        };
-        output: _backstage_frontend_plugin_api.ExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
-            optional: true;
-        }> | _backstage_frontend_plugin_api.ExtensionDataRef<string, "core.title", {
-            optional: true;
-        }> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.IconElement, "core.icon", {
-            optional: true;
-        }>;
-        inputs: {
-            pages: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
-                optional: true;
-            }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.title", {
-                optional: true;
-            }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.IconElement, "core.icon", {
-                optional: true;
-            }>, {
-                singleton: false;
-                optional: false;
-                internal: false;
-            }>;
-        };
-        params: {
-            path: string;
-            title?: string;
-            icon?: _backstage_frontend_plugin_api.IconElement;
-            loader?: () => Promise<react.JSX.Element>;
-            routeRef?: _backstage_frontend_plugin_api.RouteRef;
-            noHeader?: boolean;
-        };
-    }>;
+declare const scorecardTranslationRef: _backstage_frontend_plugin_api.TranslationRef<"plugin.scorecard", {
+    readonly "emptyState.title": string;
+    readonly "emptyState.description": string;
+    readonly "emptyState.button": string;
+    readonly "emptyState.altText": string;
+    readonly "notFound.title": string;
+    readonly "notFound.description": string;
+    readonly "notFound.altText": string;
+    readonly "notFound.readMore": string;
+    readonly "notFound.goBack": string;
+    readonly "notFound.contactSupport": string;
+    readonly "permissionRequired.title": string;
+    readonly "permissionRequired.description": string;
+    readonly "permissionRequired.button": string;
+    readonly "permissionRequired.altText": string;
+    readonly "common.loading": string;
+    readonly "errors.entityMissingProperties": string;
+    readonly "errors.missingAggregationId": string;
+    readonly "errors.invalidApiResponse": string;
+    readonly "errors.fetchError": string;
+    readonly "errors.metricDataUnavailable": string;
+    readonly "errors.invalidThresholds": string;
+    readonly "errors.missingPermission": string;
+    readonly "errors.noDataFound": string;
+    readonly "errors.authenticationError": string;
+    readonly "errors.missingPermissionMessage": string;
+    readonly "errors.userNotFoundInCatalogMessage": string;
+    readonly "errors.noDataFoundMessage": string;
+    readonly "errors.unsupportedAggregationType": string;
+    readonly "errors.authenticationErrorMessage": string;
+    readonly "metric.github.openPRs.title": string;
+    readonly "metric.github.openPRs.description": string;
+    readonly "metric.jira.openIssues.title": string;
+    readonly "metric.jira.openIssues.description": string;
+    readonly "metric.sonarqube.qualityGate.title": string;
+    readonly "metric.sonarqube.qualityGate.description": string;
+    readonly "metric.sonarqube.openIssues.title": string;
+    readonly "metric.sonarqube.openIssues.description": string;
+    readonly "metric.sonarqube.securityRating.title": string;
+    readonly "metric.sonarqube.securityRating.description": string;
+    readonly "metric.sonarqube.securityIssues.title": string;
+    readonly "metric.sonarqube.securityIssues.description": string;
+    readonly "metric.sonarqube.securityReviewRating.title": string;
+    readonly "metric.sonarqube.securityReviewRating.description": string;
+    readonly "metric.sonarqube.securityHotspots.title": string;
+    readonly "metric.sonarqube.securityHotspots.description": string;
+    readonly "metric.sonarqube.reliabilityRating.title": string;
+    readonly "metric.sonarqube.reliabilityRating.description": string;
+    readonly "metric.sonarqube.reliabilityIssues.title": string;
+    readonly "metric.sonarqube.reliabilityIssues.description": string;
+    readonly "metric.sonarqube.maintainabilityRating.title": string;
+    readonly "metric.sonarqube.maintainabilityRating.description": string;
+    readonly "metric.sonarqube.maintainabilityIssues.title": string;
+    readonly "metric.sonarqube.maintainabilityIssues.description": string;
+    readonly "metric.sonarqube.codeCoverage.title": string;
+    readonly "metric.sonarqube.codeCoverage.description": string;
+    readonly "metric.sonarqube.codeDuplications.title": string;
+    readonly "metric.sonarqube.codeDuplications.description": string;
+    readonly "metric.filecheck.title": string;
+    readonly "metric.filecheck.description": string;
+    readonly "metric.lastUpdated": string;
+    readonly "metric.lastUpdatedNotAvailable": string;
+    readonly "metric.someEntitiesNotReportingValues": string;
+    readonly "metric.weightedStatusScoreCenterTooltipTotalLabel": string;
+    readonly "metric.weightedStatusScoreCenterTooltipMaxLabel": string;
+    readonly "metric.weightedStatusScoreCenterTooltipBreakdownRow_one": string;
+    readonly "metric.weightedStatusScoreCenterTooltipBreakdownRow_other": string;
+    readonly "metric.weightedStatusScoreLegendTooltipEntitiesEach_one": string;
+    readonly "metric.weightedStatusScoreLegendTooltipEntitiesEach_other": string;
+    readonly "metric.weightedStatusScoreLegendTooltipRowTotal": string;
+    readonly "metric.drillDownCalculationFailures": string;
+    readonly "metric.homepageEntityHealthRatio": string;
+    readonly "metric.homepageEntityCalculationHealth": string;
+    readonly "thresholds.success": string;
+    readonly "thresholds.warning": string;
+    readonly "thresholds.error": string;
+    readonly "thresholds.exist": string;
+    readonly "thresholds.missing": string;
+    readonly "thresholds.noEntities": string;
+    readonly "thresholds.entities_one": string;
+    readonly "thresholds.entities_other": string;
+    readonly "dataSourcesDialog.title": string;
+    readonly "dataSourcesDialog.close": string;
+    readonly "dataSourcesDialog.unknownPlugin": string;
+    readonly "dataSourcesDialog.statusTooltip": string;
+    readonly "dataSourcesDialog.columns.plugin": string;
+    readonly "dataSourcesDialog.columns.check": string;
+    readonly "dataSourcesDialog.columns.value": string;
+    readonly "dataSourcesDialog.columns.status": string;
+    readonly "dataSourcesDialog.columns.lastSynced": string;
+    readonly "metricGroupCard.menuAriaLabel": string;
+    readonly "metricGroupCard.viewDataSources": string;
+    readonly "entitiesPage.missingPermission": string;
+    readonly "entitiesPage.noDataFound": string;
+    readonly "entitiesPage.unknownMetric": string;
+    readonly "entitiesPage.metricProviderNotRegistered": string;
+    readonly "entitiesPage.entitiesTable.title": string;
+    readonly "entitiesPage.entitiesTable.unavailable": string;
+    readonly "entitiesPage.entitiesTable.titleWithCount": string;
+    readonly "entitiesPage.entitiesTable.header.lastUpdated": string;
+    readonly "entitiesPage.entitiesTable.header.value": string;
+    readonly "entitiesPage.entitiesTable.header.status": string;
+    readonly "entitiesPage.entitiesTable.header.entity": string;
+    readonly "entitiesPage.entitiesTable.header.owner": string;
+    readonly "entitiesPage.entitiesTable.header.kind": string;
+    readonly "entitiesPage.entitiesTable.footer.of": string;
+    readonly "entitiesPage.entitiesTable.footer.allRows": string;
+    readonly "entitiesPage.entitiesTable.footer.rows_one": string;
+    readonly "entitiesPage.entitiesTable.footer.rows_other": string;
 }>;
 
 /**
- * Catalog module that injects the Scorecard tab and into Catalog entity pages.
- *
- * Also ships grid and list layout extensions (disabled by default).
- * Enable them in app-config.yaml to get a layout toggle in the entity tab.
- *
- * @alpha
+ * Translation Resource for scorecard
+ * @public
  */
-declare const scorecardCatalogModule: _backstage_frontend_plugin_api.FrontendModule;
-/**
- * App module that automatically registers Scorecard translations.
- * @alpha
- */
-declare const scorecardTranslationsModule: _backstage_frontend_plugin_api.FrontendModule;
-/**
- * Home module that contributes scorecard homepage widget and layout.
- * @alpha
- */
-declare const scorecardHomeModule: _backstage_frontend_plugin_api.FrontendModule;
+declare const scorecardTranslations: _backstage_frontend_plugin_api.TranslationResource<"plugin.scorecard">;
 
-export { _default as default, scorecardCatalogModule, scorecardHomeModule, scorecardTranslationsModule };
+export { scorecardTranslationRef, scorecardTranslations };

package/dist/alpha.esm.js

@@ -1,51 +1,3 @@
-import { createFrontendPlugin, createFrontendModule } from '@backstage/frontend-plugin-api';
-import { TranslationBlueprint } from '@backstage/plugin-app-react';
-import { scorecardDrillDownRouteRef, rootRouteRef } from './routes.esm.js';
-import { scorecardTranslations } from './translations/index.esm.js';
-import { scorecardApi } from './alpha/extensions/api.esm.js';
-import { scorecardEntityContent } from './alpha/extensions/entityTab.esm.js';
-import { aggregatedCardWithDeprecatedMetricIdWidget, aggregatedCardWithDefaultAggregationWidget, aggregatedCardWithJiraOpenIssuesWidget, aggregatedCardWithGithubOpenPrsWidget, aggregatedCardWithGithubFilecheckLicenseWidget, aggregatedCardWithGithubFilecheckCodeownersWidget, aggregatedCardWithGithubOpenPrsWeightedWidget } from './alpha/extensions/homePageCards.esm.js';
-import { scorecardPage } from './alpha/extensions/scorecardPage.esm.js';
-import { scorecardEntityLayoutGrid, scorecardEntityLayoutList } from './alpha/extensions/scorecardLayoutExtensions.esm.js';
+export { scorecardTranslations } from './translations/index.esm.js';
 export { scorecardTranslationRef } from './translations/ref.esm.js';
-
-const scorecardTranslation = TranslationBlueprint.make({
-  params: {
-    resource: scorecardTranslations
-  }
-});
-var index = createFrontendPlugin({
-  pluginId: "scorecard",
-  extensions: [scorecardApi, scorecardPage],
-  routes: {
-    root: rootRouteRef,
-    drillDown: scorecardDrillDownRouteRef
-  }
-});
-const scorecardCatalogModule = createFrontendModule({
-  pluginId: "catalog",
-  extensions: [
-    scorecardEntityContent,
-    scorecardEntityLayoutGrid,
-    scorecardEntityLayoutList
-  ]
-});
-const scorecardTranslationsModule = createFrontendModule({
-  pluginId: "app",
-  extensions: [scorecardTranslation]
-});
-const scorecardHomeModule = createFrontendModule({
-  pluginId: "home",
-  extensions: [
-    aggregatedCardWithDeprecatedMetricIdWidget,
-    aggregatedCardWithDefaultAggregationWidget,
-    aggregatedCardWithJiraOpenIssuesWidget,
-    aggregatedCardWithGithubOpenPrsWidget,
-    aggregatedCardWithGithubFilecheckLicenseWidget,
-    aggregatedCardWithGithubFilecheckCodeownersWidget,
-    aggregatedCardWithGithubOpenPrsWeightedWidget
-  ]
-});
-
-export { index as default, scorecardCatalogModule, scorecardHomeModule, scorecardTranslations, scorecardTranslationsModule };
 //# sourceMappingURL=alpha.esm.js.map

package/dist/alpha.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.esm.js","sources":["../src/alpha/index.tsx"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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  createFrontendModule,\n  createFrontendPlugin,\n} from '@backstage/frontend-plugin-api';\nimport { TranslationBlueprint } from '@backstage/plugin-app-react';\nimport { rootRouteRef, scorecardDrillDownRouteRef } from '../routes';\nimport { scorecardTranslations } from '../translations';\nimport { scorecardApi } from './extensions/api';\nimport { scorecardEntityContent } from './extensions/entityTab';\nimport {\n  aggregatedCardWithDeprecatedMetricIdWidget,\n  aggregatedCardWithDefaultAggregationWidget,\n  aggregatedCardWithGithubOpenPrsWidget,\n  aggregatedCardWithJiraOpenIssuesWidget,\n  aggregatedCardWithGithubFilecheckLicenseWidget,\n  aggregatedCardWithGithubFilecheckCodeownersWidget,\n  aggregatedCardWithGithubOpenPrsWeightedWidget,\n} from './extensions/homePageCards';\nimport { scorecardPage } from './extensions/scorecardPage';\nimport {\n  scorecardEntityLayoutGrid,\n  scorecardEntityLayoutList,\n} from './extensions/scorecardLayoutExtensions';\n\n/**\n * Extension for Scorecard translations.\n */\nconst scorecardTranslation = TranslationBlueprint.make({\n  params: {\n    resource: scorecardTranslations,\n  },\n});\n\n/**\n * The primary Scorecard frontend plugin.\n * @alpha\n */\nexport default createFrontendPlugin({\n  pluginId: 'scorecard',\n  extensions: [scorecardApi, scorecardPage],\n  routes: {\n    root: rootRouteRef,\n    drillDown: scorecardDrillDownRouteRef,\n  },\n});\n\n/**\n * Catalog module that injects the Scorecard tab and into Catalog entity pages.\n *\n * Also ships grid and list layout extensions (disabled by default).\n * Enable them in app-config.yaml to get a layout toggle in the entity tab.\n *\n * @alpha\n */\nexport const scorecardCatalogModule = createFrontendModule({\n  pluginId: 'catalog',\n  extensions: [\n    scorecardEntityContent,\n    scorecardEntityLayoutGrid,\n    scorecardEntityLayoutList,\n  ],\n});\n\n/**\n * App module that automatically registers Scorecard translations.\n * @alpha\n */\nexport const scorecardTranslationsModule = createFrontendModule({\n  pluginId: 'app',\n  extensions: [scorecardTranslation],\n});\n\n/**\n * Home module that contributes scorecard homepage widget and layout.\n * @alpha\n */\nexport const scorecardHomeModule = createFrontendModule({\n  pluginId: 'home',\n  extensions: [\n    aggregatedCardWithDeprecatedMetricIdWidget,\n    aggregatedCardWithDefaultAggregationWidget,\n    aggregatedCardWithJiraOpenIssuesWidget,\n    aggregatedCardWithGithubOpenPrsWidget,\n    aggregatedCardWithGithubFilecheckLicenseWidget,\n    aggregatedCardWithGithubFilecheckCodeownersWidget,\n    aggregatedCardWithGithubOpenPrsWeightedWidget,\n  ],\n});\n\n/**\n * Re-exporting translations for external usage.\n * @alpha\n */\nexport * from '../translations';\n"],"names":[],"mappings":";;;;;;;;;;;AA2CA,MAAM,oBAAA,GAAuB,qBAAqB,IAAA,CAAK;AAAA,EACrD,MAAA,EAAQ;AAAA,IACN,QAAA,EAAU;AAAA;AAEd,CAAC,CAAA;AAMD,YAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,WAAA;AAAA,EACV,UAAA,EAAY,CAAC,YAAA,EAAc,aAAa,CAAA;AAAA,EACxC,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,YAAA;AAAA,IACN,SAAA,EAAW;AAAA;AAEf,CAAC,CAAA;AAUM,MAAM,yBAAyB,oBAAA,CAAqB;AAAA,EACzD,QAAA,EAAU,SAAA;AAAA,EACV,UAAA,EAAY;AAAA,IACV,sBAAA;AAAA,IACA,yBAAA;AAAA,IACA;AAAA;AAEJ,CAAC;AAMM,MAAM,8BAA8B,oBAAA,CAAqB;AAAA,EAC9D,QAAA,EAAU,KAAA;AAAA,EACV,UAAA,EAAY,CAAC,oBAAoB;AACnC,CAAC;AAMM,MAAM,sBAAsB,oBAAA,CAAqB;AAAA,EACtD,QAAA,EAAU,MAAA;AAAA,EACV,UAAA,EAAY;AAAA,IACV,0CAAA;AAAA,IACA,0CAAA;AAAA,IACA,sCAAA;AAAA,IACA,qCAAA;AAAA,IACA,8CAAA;AAAA,IACA,iDAAA;AAAA,IACA;AAAA;AAEJ,CAAC;;;;"}
+{"version":3,"file":"alpha.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}