@red-hat-developer-hub/backstage-plugin-scorecard 2.4.0 → 2.5.0

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @red-hat-developer-hub/backstage-plugin-scorecard
 
+## 2.5.0
+
+### Minor Changes
+
+- d706601: Backstage version bump to v1.49.3
+- 55226c2: Introduces custom threshold rule icons that can be configured in `app-config.yaml`.
+- f13f583: Adding scorecardHomepage and metric page extension, also added e2e support in nfs
+- 0d64361: Adds a Scorecard Entities page that allows users to drill down from aggregated scorecard KPIs to view the individual entities contributing to the overall score. The page displays entity-level metric values and status, enabling users to identify services impacting the metric and investigate issues more effectively.
+- 243ad0a: Aggregated scorecards now use **aggregation IDs** and dedicated HTTP routes. The old catalog-aggregations URL still works but is **deprecated** (not removed).
+
+  **Backend (`@red-hat-developer-hub/backstage-plugin-scorecard-backend`)**
+
+  - **Deprecated:** `GET /metrics/:metricId/catalog/aggregations` — responses are unchanged, but the handler emits [RFC 8594](https://datatracker.ietf.org/doc/html/rfc8594) `Deprecation` and `Link` headers (alternate successor: `GET .../aggregations/:aggregationId`) and logs a warning. Prefer **`GET /aggregations/:aggregationId`** for new integrations.
+  - **Added:** `GET /aggregations/:aggregationId` for aggregated results using configured aggregation.
+  - **Added:** `GET /aggregations/:aggregationId/metadata` for KPI titles, descriptions, and aggregation metadata consumed by the UI.
+
+  **Common (`@red-hat-developer-hub/backstage-plugin-scorecard-common`)**
+
+  - Types and constants aligned with the aggregation config and new API shapes.
+
+  **Frontend (`@red-hat-developer-hub/backstage-plugin-scorecard`)**
+
+  - Homepage and aggregated flows resolve cards via **`aggregationId`**, fetch metadata from the new endpoint, and keep localized threshold and error strings where translation keys exist.
+
+  **Action for adopters:** Configure aggregated scorecards with `aggregationId` values that match backend aggregation config, replace direct calls to `GET /metrics/:metricId/catalog/aggregations` with `GET /aggregations/:aggregationId` (and metadata if you need the same labels as the plugin UI).
+
+- 99aa8ff: Added support for the New Frontend System (NFS), including an alpha export for NFS apps and a new `app-next` package.
+
+### Patch Changes
+
+- 6bd7c38: Enable sorting for all other columns in entities table
+- ff005a3: add translation for the scorecard entities table status column
+- afd7a1e: Update translations for Scorecard.
+- 2667f70: Fix scorecard entity table column header Metric to Status
+- Updated dependencies [d706601]
+- Updated dependencies [55226c2]
+- Updated dependencies [243ad0a]
+- Updated dependencies [c83b206]
+  - @red-hat-developer-hub/backstage-plugin-scorecard-common@2.5.0
+
 ## 2.4.0
 
 ### Minor Changes

package/README.md

@@ -1,7 +1,14 @@
-# 📊 Scorecard Plugin for Backstage
+# Scorecard Plugin for Backstage
 
 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.
+**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).
+- **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.
+
 ## Getting started
 
 Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/scorecard](http://localhost:3000/scorecard).
@@ -16,43 +23,174 @@ It is only meant for local development, and the setup for it can be found inside
 
 Before installing the frontend plugin, ensure that the Scorecard backend is integrated into your Backstage instance. Follow the [Scorecard backend plugin README](https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/scorecard/plugins/scorecard-backend/README.md) for setup instructions.
 
-### Installation
+### Installation and usage
 
-To install the Scorecard plugin, run the following command:
+Install the package in your frontend (use `app` for NFS or `app-legacy` for legacy):
 
 ```sh
 yarn workspace app add @red-hat-developer-hub/backstage-plugin-scorecard
+# or for the legacy frontend:
+yarn workspace app-legacy add @red-hat-developer-hub/backstage-plugin-scorecard
 ```
 
-**Note**
+### Procedure
 
-### Permission Framework Support
+#### NFS (New Frontend System) — app
 
-The Scorecard plugin has support for the permission framework.
+1. Install the Scorecard frontend plugin (see [Installation and usage](#installation-and-usage)) using `app`:
 
-- When [RBAC permission](https://github.com/backstage/community-plugins/tree/main/workspaces/rbac/plugins/rbac-backend#installation) framework is enabled, for non-admin users to access scorecard UI, the role associated with your user should have the following permission policies associated with it. Add the following in your permission policies configuration file named `rbac-policy.csv`:
+   ```console
+   yarn workspace app add @red-hat-developer-hub/backstage-plugin-scorecard
+   ```
 
-```CSV
-p, role:default/team_a, scorecard.metric.read, read, allow
+2. Register the plugin in `packages/app/src/App.tsx` using the **alpha** export:
 
-g, user:default/<your-user-name>, role:default/team_a
+   ```tsx
+   // In packages/app/src/App.tsx
+   import { createApp } from '@backstage/frontend-defaults';
+   import {
+     scorecardHomeModule,
+     scorecardTranslationsModule,
+     scorecardCatalogModule,
+   } from '@red-hat-developer-hub/backstage-plugin-scorecard/alpha';
+
+   const app = createApp({
+     features: [
+       scorecardHomeModule,
+       scorecardCatalogModule,
+       scorecardTranslationsModule,
+       // ... other plugins
+     ],
+   });
+
+   export default app.createRoot();
+   ```
+
+3. (Optional) Configure which entities show the Scorecard tab in `app-config.yaml` under `app.extensions`. If you do not add this extension config, the tab is shown for all entity kinds. To restrict by kind and optionally by type:
+
+   ```yaml
+   app:
+     extensions:
+       - entity-content:catalog/entity-content-scorecard:
+           config:
+             allowedFilters:
+               - kind: component
+               - kind: template
+               - kind: resource
+               - kind: location
+   ```
+
+   Each filter can include optional `kind` and/or `type`. An entity shows the tab if it matches at least one filter. You can restrict by **kind only**, by **type only**, or by **kind and type**:
+
+   **By kind only:**
+
+```yaml
+allowedFilters:
+  - kind: component
+  - kind: template
 ```
 
-You can specify the path to this configuration file in your application configuration:
+**By type only** (e.g. any entity with `spec.type` equal to `service` or `website`):
 
 ```yaml
-permission:
-  enabled: true
-  rbac:
-    policies-csv-file: /some/path/rbac-policy.csv
-    policyFileReload: true
+allowedFilters:
+  - type: service
+  - type: website
 ```
 
-**Note:** The backend also checks `catalog.entity.read` for each entity. Make sure your users/roles can read the catalog entities they want to view scorecards for.
+**By kind and type** (e.g. only `component` with type `website` or type `service`):
 
-### Configuration
+```yaml
+allowedFilters:
+  - kind: component
+    type: website
+  - kind: component
+    type: service
+```
+
+To align with the legacy EntityPage (Scorecard on component pages and default entity page, not on api/group/user/system/domain), use the first example (by kind only).
+
+4. Ensure the frontend can reach the Scorecard backend by configuring discovery in `app-config.yaml`:
+
+   ```yaml
+   discovery:
+     endpoints:
+       - target: http://localhost:7007/api/{{ pluginId }}
+         plugins:
+           - scorecard
+   ```
+
+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`:
+
+   ```yaml
+   app:
+     extensions:
+       - page:home:
+           config:
+             path: /
+       - api:home/visits: true
+       - app-root-element:home/visit-listener: true
+       - home-page-layout:home/dynamic-homepage-layout:
+           config:
+             customizable: true
+             widgetLayout:
+               ScorecardJiraHomepage:
+                 priority: 240
+                 breakpoints:
+                   xl: { w: 4, h: 6 }
+                   lg: { w: 4, h: 6 }
+                   md: { w: 4, h: 6 }
+                   sm: { w: 4, h: 6 }
+                   xs: { w: 4, h: 6 }
+                   xxs: { w: 4, h: 6 }
+               ScorecardGithubHomepage:
+                 priority: 250
+                 breakpoints:
+                   xl: { w: 4, h: 6, x: 4 }
+                   lg: { w: 4, h: 6, x: 4 }
+                   md: { w: 4, h: 6, x: 4 }
+                   sm: { w: 4, h: 6, x: 4 }
+                   xs: { w: 4, h: 6, x: 4 }
+                   xxs: { w: 4, h: 6, x: 4 }
+   ```
+
+   The home module contributes two widgets:
+
+   - `ScorecardGithubHomepage` (title: **Scorecard: GitHub open PRs**)
+   - `ScorecardJiraHomepage` (title: **Scorecard: Jira open blocking tickets**)
+
+   These widgets render the same `ScorecardHomepageCard` component used in legacy apps, preconfigured for `github.open_prs` and `jira.open_issues`.
+
+##### Modules and extensions (NFS)
+
+The following modules and extensions are available from `@red-hat-developer-hub/backstage-plugin-scorecard/alpha` for NFS apps:
 
-1. Add the Scorecard page to you Entity overview page by modifying `packages/app/src/components/catalog/EntityPage.tsx`:
+**Modules**
+
+| Module                        | Description                                                                                                                                                            |
+| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `scorecardHomeModule`         | Registers Scorecard homepage widgets for the home plugin (`ScorecardGithubHomepage` and `ScorecardJiraHomepage`).                                                      |
+| `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`.                                                                                           |
+
+**Extensions**
+
+- `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-github-homepage` — Homepage widget showing GitHub open PR metric.
+- `home-page-widget:home/scorecard-jira-homepage` — Homepage widget showing Jira open issues metric.
+
+#### Legacy app
+
+1. Install the Scorecard frontend plugin (see [Installation and usage](#installation-and-usage)) using `app-legacy`:
+
+   ```console
+   yarn workspace app-legacy add @red-hat-developer-hub/backstage-plugin-scorecard
+   ```
+
+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';
@@ -82,7 +220,6 @@ permission:
        <EntitySwitch.Case if={isComponentType('service')}>
          {serviceEntityPage}
        </EntitySwitch.Case>
-
        <EntitySwitch.Case if={isComponentType('website')}>
          {websiteEntityPage}
        </EntitySwitch.Case>
@@ -98,11 +235,103 @@ permission:
    );
    ```
 
+3. (Optional) Add Scorecard homepage cards to your home page:
+
+   ```tsx
+   import { ScorecardHomepageCard } from '@red-hat-developer-hub/backstage-plugin-scorecard';
+
+   // GitHub open PRs
+   <ScorecardHomepageCard metricId="github.open_prs" />
+
+   // Jira open issues
+   <ScorecardHomepageCard metricId="jira.open_issues" />
+   ```
+
+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)).
+
+5. Start the legacy app (e.g. `yarn start:legacy`) and open the **Scorecard** tab on catalog entity pages.
+
+### Permission Framework Support
+
+The Scorecard plugin has support for the permission framework.
+
+- When [RBAC permission](https://github.com/backstage/community-plugins/tree/main/workspaces/rbac/plugins/rbac-backend#installation) framework is enabled, for non-admin users to access scorecard UI, the role associated with your user should have the following permission policies associated with it. Add the following in your permission policies configuration file named `rbac-policy.csv`:
+
+```CSV
+p, role:default/team_a, scorecard.metric.read, read, allow
+
+g, user:default/<your-user-name>, role:default/team_a
+```
+
+You can specify the path to this configuration file in your application configuration:
+
+```yaml
+permission:
+  enabled: true
+  rbac:
+    policies-csv-file: /some/path/rbac-policy.csv
+    policyFileReload: true
+```
+
+**Note:** The backend also checks `catalog.entity.read` for each entity. Make sure your users/roles can read the catalog entities they want to view scorecards for.
+
 ### Accessing the Plugin
 
-1. Open your Backstage application.
-2. Navigate to the Entity overview page from catalog.
-3. Explore and analyze scorecard metrics using the scorecards tab.
+- **app (NFS):** Open your Backstage app, go to **Catalog**, open an entity. The **Scorecard** tab appears when the entity matches your `allowedFilters` in app-config (or for all entities if the extension config is omitted).
+- **app-legacy:** Open your Backstage app, go to the entity overview from the catalog, and open the **Scorecard** tab to view and analyze scorecard metrics.
+
+### 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`).
+
+#### 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).
+
+#### Card props
+
+The supported model is **a single `aggregationId` string** whose value is either:
+
+- a **KPI key** from **`scorecard.aggregationKPIs`** in app-config (custom title, description, type, backing metric), or
+- a **metric id** when you have no KPI row for that card (default **statusGrouped** aggregation and metric-defined metadata).
+
+| Prop                | Status       | Description                                                                                                                          |
+| ------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
+| **`aggregationId`** | **Use this** | KPI id from **`scorecard.aggregationKPIs`** _or_ **metric id** for the default case. Sent to **`GET /aggregations/:aggregationId`**. |
+| **`metricId`**      | **Legacy**   | Default aggregated card metadata: resolved as **`aggregationId ?? metricId`**.                                                       |
+
+**Migrating**
+
+- **Homepage `props`:** set **`aggregationId`** to your KPI key or metric id - drop **`metricId`** when your plugin version no longer requires it.
+- **Custom HTTP clients:** replace **`GET .../metrics/<metricId>/catalog/aggregations`** with **`GET .../aggregations/<aggregationId>`** (same segment value when you used the metric id before). Deprecation **`Link`** headers point at the successor URL.
+- **User-editable home cards:** if your **`settings.schema`** still exposes **`metricId`**, plan to rename or replace it with **`aggregationId`** using the same KPI vs metric-id rules once the frontend supports it.
+
+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 { ComponentType } from 'react';
+
+// Inside your home page cards config:
+{
+  Component: ScorecardHomepageCard as ComponentType,
+  config: {
+    id: 'scorecard-jira-open-issues',
+    title: 'Scorecard: Jira open issues',
+    layouts: { /* … */ },
+    props: {
+      aggregationId: 'openIssuesKpi',
+      // metricId: 'jira.open_issues', // legacy only; remove when only aggregationId is supported
+    },
+  },
+},
+```
+
+#### Default labels and translations
+
+- The API returns **title** and **description** in **`metadata`** (from **`aggregationKPIs`** or from the metric definition).
+- The homepage card applies **plugin translations** when keys exist for **`metric.<id>.title`** and **`metric.<id>.description`**, where **`<id>`** is the value passed into the translation hook (**`aggregationId ?? metricId`**). If no translation key matches, the UI shows the **metadata** strings from the API.
+- **Custom `title` / `description` in `aggregationKPIs`** are returned as-is from the backend; add matching translation keys for **`metric.<yourKpiId>.*`** if you want those strings localized.
 
 ## Adding Translations
 
@@ -139,14 +368,16 @@ const scorecardTranslationDe = createTranslationMessages({
 });
 ```
 
-### 3. Translation Key Format
+### 2. Translation Key Format
 
 Translation keys follow this pattern:
 
 - **Metric titles**: `metric.{metric-id}.title`
 - **Metric descriptions**: `metric.{metric-id}.description`
 
-### 4. Fallback Behavior
+Use the same pattern with a **KPI id** as `{metric-id}` when localizing **`aggregationKPIs`** titles (for example **`metric.openIssuesKpi.title`**).
+
+### 3. Fallback Behavior
 
 If a translation key is not found, the plugin will automatically fall back to:
 

package/dist/alpha/extensions/api.esm.js

@@ -0,0 +1,15 @@
+import { ApiBlueprint, createApiFactory, discoveryApiRef, fetchApiRef } from '@backstage/frontend-plugin-api';
+import { ScorecardApiClient, scorecardApiRef } from '../../api/index.esm.js';
+
+const scorecardApi = ApiBlueprint.make({
+  params: (defineParams) => defineParams(
+    createApiFactory({
+      api: scorecardApiRef,
+      deps: { fetchApi: fetchApiRef, discoveryApi: discoveryApiRef },
+      factory: ({ fetchApi, discoveryApi }) => new ScorecardApiClient({ fetchApi, discoveryApi })
+    })
+  )
+});
+
+export { scorecardApi };
+//# sourceMappingURL=api.esm.js.map

package/dist/alpha/extensions/api.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.esm.js","sources":["../../../src/alpha/extensions/api.ts"],"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  ApiBlueprint,\n  createApiFactory,\n  discoveryApiRef,\n  fetchApiRef,\n} from '@backstage/frontend-plugin-api';\nimport { ScorecardApiClient, scorecardApiRef } from '../../api';\n\n/** Scorecard API extension. */\nexport const scorecardApi = ApiBlueprint.make({\n  params: defineParams =>\n    defineParams(\n      createApiFactory({\n        api: scorecardApiRef,\n        deps: { fetchApi: fetchApiRef, discoveryApi: discoveryApiRef },\n        factory: ({ fetchApi, discoveryApi }) =>\n          new ScorecardApiClient({ fetchApi, discoveryApi }),\n      }),\n    ),\n});\n"],"names":[],"mappings":";;;AAyBa,MAAA,YAAA,GAAe,aAAa,IAAK,CAAA;AAAA,EAC5C,QAAQ,CACN,YAAA,KAAA,YAAA;AAAA,IACE,gBAAiB,CAAA;AAAA,MACf,GAAK,EAAA,eAAA;AAAA,MACL,IAAM,EAAA,EAAE,QAAU,EAAA,WAAA,EAAa,cAAc,eAAgB,EAAA;AAAA,MAC7D,OAAA,EAAS,CAAC,EAAE,QAAU,EAAA,YAAA,EACpB,KAAA,IAAI,kBAAmB,CAAA,EAAE,QAAU,EAAA,YAAA,EAAc;AAAA,KACpD;AAAA;AAEP,CAAC;;;;"}

package/dist/alpha/extensions/entityTab.esm.js

@@ -0,0 +1,42 @@
+import { jsx } from 'react/jsx-runtime';
+import { EntityContentBlueprint } from '@backstage/plugin-catalog-react/alpha';
+import { rootRouteRef } from '../../routes.esm.js';
+
+const scorecardEntityContent = EntityContentBlueprint.makeWithOverrides({
+  name: "entity-content-scorecard",
+  config: {
+    schema: {
+      // Allows flexible filtering: { kind: 'Component', type: 'service' }
+      // or just { type: 'service' } for all services.
+      allowedFilters: (schema) => schema.array(
+        schema.object({
+          kind: schema.string().optional(),
+          type: schema.string().optional()
+        })
+      ).optional()
+    }
+  },
+  factory(original, { config }) {
+    return original({
+      path: "/scorecard",
+      title: "Scorecard",
+      routeRef: rootRouteRef,
+      filter: (entity) => {
+        const filters = config.allowedFilters;
+        if (!filters || filters.length === 0) return true;
+        return filters.some((f) => {
+          const kindMatch = !f.kind || f.kind.toLowerCase() === entity.kind.toLowerCase();
+          const typeMatch = !f.type || f.type.toLowerCase() === entity.spec?.type?.toLowerCase();
+          return kindMatch && typeMatch;
+        });
+      },
+      loader: async () => {
+        const { EntityScorecardContent } = await import('../../components/Scorecard/index.esm.js');
+        return /* @__PURE__ */ jsx(EntityScorecardContent, {});
+      }
+    });
+  }
+});
+
+export { scorecardEntityContent };
+//# sourceMappingURL=entityTab.esm.js.map

package/dist/alpha/extensions/entityTab.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entityTab.esm.js","sources":["../../../src/alpha/extensions/entityTab.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 { Entity } from '@backstage/catalog-model';\nimport { EntityContentBlueprint } from '@backstage/plugin-catalog-react/alpha';\nimport { rootRouteRef } from '../../routes';\n\n/**\n * Extension for the Scorecard tab on Entity pages.\n * @alpha\n */\nexport const scorecardEntityContent = EntityContentBlueprint.makeWithOverrides({\n  name: 'entity-content-scorecard',\n  config: {\n    schema: {\n      // Allows flexible filtering: { kind: 'Component', type: 'service' }\n      // or just { type: 'service' } for all services.\n      allowedFilters: schema =>\n        schema\n          .array(\n            schema.object({\n              kind: schema.string().optional(),\n              type: schema.string().optional(),\n            }),\n          )\n          .optional(),\n    },\n  },\n  factory(original, { config }) {\n    return original({\n      path: '/scorecard',\n      title: 'Scorecard',\n      routeRef: rootRouteRef,\n      filter: (entity: Entity): boolean => {\n        const filters = config.allowedFilters;\n\n        if (!filters || filters.length === 0) return true;\n\n        return filters.some(f => {\n          const kindMatch =\n            !f.kind || f.kind.toLowerCase() === entity.kind.toLowerCase();\n          const typeMatch =\n            !f.type ||\n            f.type.toLowerCase() ===\n              (entity.spec?.type as string)?.toLowerCase();\n\n          return kindMatch && typeMatch;\n        });\n      },\n      loader: async () => {\n        const { EntityScorecardContent } = await import(\n          '../../components/Scorecard'\n        );\n        return <EntityScorecardContent />;\n      },\n    });\n  },\n});\n"],"names":[],"mappings":";;;;AAwBa,MAAA,sBAAA,GAAyB,uBAAuB,iBAAkB,CAAA;AAAA,EAC7E,IAAM,EAAA,0BAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA;AAAA;AAAA,MAGN,cAAA,EAAgB,YACd,MACG,CAAA,KAAA;AAAA,QACC,OAAO,MAAO,CAAA;AAAA,UACZ,IAAM,EAAA,MAAA,CAAO,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,UAC/B,IAAM,EAAA,MAAA,CAAO,MAAO,EAAA,CAAE,QAAS;AAAA,SAChC;AAAA,QAEF,QAAS;AAAA;AAChB,GACF;AAAA,EACA,OAAQ,CAAA,QAAA,EAAU,EAAE,MAAA,EAAU,EAAA;AAC5B,IAAA,OAAO,QAAS,CAAA;AAAA,MACd,IAAM,EAAA,YAAA;AAAA,MACN,KAAO,EAAA,WAAA;AAAA,MACP,QAAU,EAAA,YAAA;AAAA,MACV,MAAA,EAAQ,CAAC,MAA4B,KAAA;AACnC,QAAA,MAAM,UAAU,MAAO,CAAA,cAAA;AAEvB,QAAA,IAAI,CAAC,OAAA,IAAW,OAAQ,CAAA,MAAA,KAAW,GAAU,OAAA,IAAA;AAE7C,QAAO,OAAA,OAAA,CAAQ,KAAK,CAAK,CAAA,KAAA;AACvB,UAAM,MAAA,SAAA,GACJ,CAAC,CAAA,CAAE,IAAQ,IAAA,CAAA,CAAE,KAAK,WAAY,EAAA,KAAM,MAAO,CAAA,IAAA,CAAK,WAAY,EAAA;AAC9D,UAAM,MAAA,SAAA,GACJ,CAAC,CAAA,CAAE,IACH,IAAA,CAAA,CAAE,IAAK,CAAA,WAAA,EACJ,KAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAiB,WAAY,EAAA;AAE/C,UAAA,OAAO,SAAa,IAAA,SAAA;AAAA,SACrB,CAAA;AAAA,OACH;AAAA,MACA,QAAQ,YAAY;AAClB,QAAA,MAAM,EAAE,sBAAA,EAA2B,GAAA,MAAM,OACvC,yCACF,CAAA;AACA,QAAA,2BAAQ,sBAAuB,EAAA,EAAA,CAAA;AAAA;AACjC,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}

package/dist/alpha/extensions/homePageCards.esm.js

@@ -0,0 +1,90 @@
+import { jsx } from 'react/jsx-runtime';
+import { HomePageWidgetBlueprint } from '@backstage/plugin-home-react/alpha';
+import { ScorecardHomepageCard } from '../../components/ScorecardHomepageSection/ScorecardHomepageCard.esm.js';
+
+const defaultCardLayout = {
+  width: {
+    minColumns: 3,
+    maxColumns: 12,
+    defaultColumns: 4
+  },
+  height: {
+    minRows: 5,
+    maxRows: 12,
+    defaultRows: 6
+  }
+};
+function AggregatedCardWithDeprecatedMetricIdContent() {
+  return /* @__PURE__ */ jsx(ScorecardHomepageCard, { metricId: "jira.open_issues" });
+}
+function AggregatedCardWithDefaultAggregationContent() {
+  return /* @__PURE__ */ jsx(ScorecardHomepageCard, { aggregationId: "github.open_prs" });
+}
+function AggregatedCardWithJiraOpenIssuesContent() {
+  return /* @__PURE__ */ jsx(ScorecardHomepageCard, { aggregationId: "openIssuesKpi" });
+}
+function AggregatedCardWithGithubOpenPrsContent() {
+  return /* @__PURE__ */ jsx(ScorecardHomepageCard, { aggregationId: "openPrsKpi" });
+}
+function BorderlessHomeWidgetRenderer({ Content }) {
+  return /* @__PURE__ */ jsx(Content, {});
+}
+const aggregatedCardWithDeprecatedMetricIdWidget = HomePageWidgetBlueprint.make({
+  name: "scorecard-deprecated-metric-id",
+  params: {
+    name: "AggregatedCardWithDeprecatedMetricId",
+    title: "Scorecard: With deprecated metricId property (Jira)",
+    layout: defaultCardLayout,
+    componentProps: {
+      Renderer: BorderlessHomeWidgetRenderer
+    },
+    components: () => Promise.resolve({
+      Content: AggregatedCardWithDeprecatedMetricIdContent
+    })
+  }
+});
+const aggregatedCardWithDefaultAggregationWidget = HomePageWidgetBlueprint.make({
+  name: "scorecard-default-aggregation",
+  params: {
+    name: "AggregatedCardWithDefaultAggregation",
+    title: "Scorecard: With default aggregation config (GitHub)",
+    layout: defaultCardLayout,
+    componentProps: {
+      Renderer: BorderlessHomeWidgetRenderer
+    },
+    components: () => Promise.resolve({
+      Content: AggregatedCardWithDefaultAggregationContent
+    })
+  }
+});
+const aggregatedCardWithJiraOpenIssuesWidget = HomePageWidgetBlueprint.make({
+  name: "scorecard-jira-open-issues",
+  params: {
+    name: "AggregatedCardWithJiraOpenIssues",
+    title: "Scorecard: Jira open blocking tickets",
+    layout: defaultCardLayout,
+    componentProps: {
+      Renderer: BorderlessHomeWidgetRenderer
+    },
+    components: () => Promise.resolve({
+      Content: AggregatedCardWithJiraOpenIssuesContent
+    })
+  }
+});
+const aggregatedCardWithGithubOpenPrsWidget = HomePageWidgetBlueprint.make({
+  name: "scorecard-github-open-prs",
+  params: {
+    name: "AggregatedCardWithGithubOpenPrs",
+    title: "Scorecard: GitHub open PRs",
+    layout: defaultCardLayout,
+    componentProps: {
+      Renderer: BorderlessHomeWidgetRenderer
+    },
+    components: () => Promise.resolve({
+      Content: AggregatedCardWithGithubOpenPrsContent
+    })
+  }
+});
+
+export { aggregatedCardWithDefaultAggregationWidget, aggregatedCardWithDeprecatedMetricIdWidget, aggregatedCardWithGithubOpenPrsWidget, aggregatedCardWithJiraOpenIssuesWidget };
+//# sourceMappingURL=homePageCards.esm.js.map

package/dist/alpha/extensions/homePageCards.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"homePageCards.esm.js","sources":["../../../src/alpha/extensions/homePageCards.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 { HomePageWidgetBlueprint } from '@backstage/plugin-home-react/alpha';\nimport type { RendererProps } from '@backstage/plugin-home-react';\nimport { ScorecardHomepageCard } from '../../components/ScorecardHomepageSection';\n\nconst defaultCardLayout = {\n  width: {\n    minColumns: 3,\n    maxColumns: 12,\n    defaultColumns: 4,\n  },\n  height: {\n    minRows: 5,\n    maxRows: 12,\n    defaultRows: 6,\n  },\n} as const;\n\nfunction AggregatedCardWithDeprecatedMetricIdContent() {\n  return <ScorecardHomepageCard metricId=\"jira.open_issues\" />;\n}\n\nfunction AggregatedCardWithDefaultAggregationContent() {\n  return <ScorecardHomepageCard aggregationId=\"github.open_prs\" />;\n}\n\nfunction AggregatedCardWithJiraOpenIssuesContent() {\n  return <ScorecardHomepageCard aggregationId=\"openIssuesKpi\" />;\n}\n\nfunction AggregatedCardWithGithubOpenPrsContent() {\n  return <ScorecardHomepageCard aggregationId=\"openPrsKpi\" />;\n}\n\nfunction BorderlessHomeWidgetRenderer({ Content }: RendererProps) {\n  return <Content />;\n}\n\n/**\n * NFS widget: AggregatedCardWithDeprecatedMetricId.\n * @alpha\n */\nexport const aggregatedCardWithDeprecatedMetricIdWidget =\n  HomePageWidgetBlueprint.make({\n    name: 'scorecard-deprecated-metric-id',\n    params: {\n      name: 'AggregatedCardWithDeprecatedMetricId',\n      title: 'Scorecard: With deprecated metricId property (Jira)',\n      layout: defaultCardLayout,\n      componentProps: {\n        Renderer: BorderlessHomeWidgetRenderer,\n      },\n      components: () =>\n        Promise.resolve({\n          Content: AggregatedCardWithDeprecatedMetricIdContent,\n        }),\n    },\n  });\n\n/**\n * NFS widget: AggregatedCardWithDefaultAggregation.\n * @alpha\n */\nexport const aggregatedCardWithDefaultAggregationWidget =\n  HomePageWidgetBlueprint.make({\n    name: 'scorecard-default-aggregation',\n    params: {\n      name: 'AggregatedCardWithDefaultAggregation',\n      title: 'Scorecard: With default aggregation config (GitHub)',\n      layout: defaultCardLayout,\n      componentProps: {\n        Renderer: BorderlessHomeWidgetRenderer,\n      },\n      components: () =>\n        Promise.resolve({\n          Content: AggregatedCardWithDefaultAggregationContent,\n        }),\n    },\n  });\n\n/**\n * NFS widget: AggregatedCardWithJiraOpenIssues.\n * @alpha\n */\nexport const aggregatedCardWithJiraOpenIssuesWidget =\n  HomePageWidgetBlueprint.make({\n    name: 'scorecard-jira-open-issues',\n    params: {\n      name: 'AggregatedCardWithJiraOpenIssues',\n      title: 'Scorecard: Jira open blocking tickets',\n      layout: defaultCardLayout,\n      componentProps: {\n        Renderer: BorderlessHomeWidgetRenderer,\n      },\n      components: () =>\n        Promise.resolve({\n          Content: AggregatedCardWithJiraOpenIssuesContent,\n        }),\n    },\n  });\n\n/**\n * NFS widget: AggregatedCardWithGithubOpenPrs.\n * @alpha\n */\nexport const aggregatedCardWithGithubOpenPrsWidget =\n  HomePageWidgetBlueprint.make({\n    name: 'scorecard-github-open-prs',\n    params: {\n      name: 'AggregatedCardWithGithubOpenPrs',\n      title: 'Scorecard: GitHub open PRs',\n      layout: defaultCardLayout,\n      componentProps: {\n        Renderer: BorderlessHomeWidgetRenderer,\n      },\n      components: () =>\n        Promise.resolve({\n          Content: AggregatedCardWithGithubOpenPrsContent,\n        }),\n    },\n  });\n"],"names":[],"mappings":";;;;AAoBA,MAAM,iBAAoB,GAAA;AAAA,EACxB,KAAO,EAAA;AAAA,IACL,UAAY,EAAA,CAAA;AAAA,IACZ,UAAY,EAAA,EAAA;AAAA,IACZ,cAAgB,EAAA;AAAA,GAClB;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,OAAS,EAAA,CAAA;AAAA,IACT,OAAS,EAAA,EAAA;AAAA,IACT,WAAa,EAAA;AAAA;AAEjB,CAAA;AAEA,SAAS,2CAA8C,GAAA;AACrD,EAAO,uBAAA,GAAA,CAAC,qBAAsB,EAAA,EAAA,QAAA,EAAS,kBAAmB,EAAA,CAAA;AAC5D;AAEA,SAAS,2CAA8C,GAAA;AACrD,EAAO,uBAAA,GAAA,CAAC,qBAAsB,EAAA,EAAA,aAAA,EAAc,iBAAkB,EAAA,CAAA;AAChE;AAEA,SAAS,uCAA0C,GAAA;AACjD,EAAO,uBAAA,GAAA,CAAC,qBAAsB,EAAA,EAAA,aAAA,EAAc,eAAgB,EAAA,CAAA;AAC9D;AAEA,SAAS,sCAAyC,GAAA;AAChD,EAAO,uBAAA,GAAA,CAAC,qBAAsB,EAAA,EAAA,aAAA,EAAc,YAAa,EAAA,CAAA;AAC3D;AAEA,SAAS,4BAAA,CAA6B,EAAE,OAAA,EAA0B,EAAA;AAChE,EAAA,2BAAQ,OAAQ,EAAA,EAAA,CAAA;AAClB;AAMa,MAAA,0CAAA,GACX,wBAAwB,IAAK,CAAA;AAAA,EAC3B,IAAM,EAAA,gCAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,sCAAA;AAAA,IACN,KAAO,EAAA,qDAAA;AAAA,IACP,MAAQ,EAAA,iBAAA;AAAA,IACR,cAAgB,EAAA;AAAA,MACd,QAAU,EAAA;AAAA,KACZ;AAAA,IACA,UAAA,EAAY,MACV,OAAA,CAAQ,OAAQ,CAAA;AAAA,MACd,OAAS,EAAA;AAAA,KACV;AAAA;AAEP,CAAC;AAMU,MAAA,0CAAA,GACX,wBAAwB,IAAK,CAAA;AAAA,EAC3B,IAAM,EAAA,+BAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,sCAAA;AAAA,IACN,KAAO,EAAA,qDAAA;AAAA,IACP,MAAQ,EAAA,iBAAA;AAAA,IACR,cAAgB,EAAA;AAAA,MACd,QAAU,EAAA;AAAA,KACZ;AAAA,IACA,UAAA,EAAY,MACV,OAAA,CAAQ,OAAQ,CAAA;AAAA,MACd,OAAS,EAAA;AAAA,KACV;AAAA;AAEP,CAAC;AAMU,MAAA,sCAAA,GACX,wBAAwB,IAAK,CAAA;AAAA,EAC3B,IAAM,EAAA,4BAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,kCAAA;AAAA,IACN,KAAO,EAAA,uCAAA;AAAA,IACP,MAAQ,EAAA,iBAAA;AAAA,IACR,cAAgB,EAAA;AAAA,MACd,QAAU,EAAA;AAAA,KACZ;AAAA,IACA,UAAA,EAAY,MACV,OAAA,CAAQ,OAAQ,CAAA;AAAA,MACd,OAAS,EAAA;AAAA,KACV;AAAA;AAEP,CAAC;AAMU,MAAA,qCAAA,GACX,wBAAwB,IAAK,CAAA;AAAA,EAC3B,IAAM,EAAA,2BAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,iCAAA;AAAA,IACN,KAAO,EAAA,4BAAA;AAAA,IACP,MAAQ,EAAA,iBAAA;AAAA,IACR,cAAgB,EAAA;AAAA,MACd,QAAU,EAAA;AAAA,KACZ;AAAA,IACA,UAAA,EAAY,MACV,OAAA,CAAQ,OAAQ,CAAA;AAAA,MACd,OAAS,EAAA;AAAA,KACV;AAAA;AAEP,CAAC;;;;"}

package/dist/alpha/extensions/scorecardPage.esm.js

@@ -0,0 +1,14 @@
+import { jsx } from 'react/jsx-runtime';
+import { PageBlueprint } from '@backstage/frontend-plugin-api';
+import { scorecardDrillDownRouteRef } from '../../routes.esm.js';
+
+const scorecardPage = PageBlueprint.make({
+  params: {
+    path: "/scorecard/aggregations/:aggregationId/metrics/:metricId",
+    routeRef: scorecardDrillDownRouteRef,
+    loader: () => import('../../pages/ScorecardPage.esm.js').then((m) => /* @__PURE__ */ jsx(m.ScorecardPage, {}))
+  }
+});
+
+export { scorecardPage };
+//# sourceMappingURL=scorecardPage.esm.js.map

package/dist/alpha/extensions/scorecardPage.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scorecardPage.esm.js","sources":["../../../src/alpha/extensions/scorecardPage.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 { PageBlueprint } from '@backstage/frontend-plugin-api';\nimport { scorecardDrillDownRouteRef } from '../../routes';\n\n/**\n * NFS page extension for the Scorecard drill-down page.\n * @alpha\n */\nexport const scorecardPage = PageBlueprint.make({\n  params: {\n    path: '/scorecard/aggregations/:aggregationId/metrics/:metricId',\n    routeRef: scorecardDrillDownRouteRef,\n    loader: () =>\n      import('../../pages/ScorecardPage').then(m => <m.ScorecardPage />),\n  },\n});\n"],"names":[],"mappings":";;;;AAuBa,MAAA,aAAA,GAAgB,cAAc,IAAK,CAAA;AAAA,EAC9C,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,0DAAA;AAAA,IACN,QAAU,EAAA,0BAAA;AAAA,IACV,MAAA,EAAQ,MACN,OAAO,kCAA2B,CAAA,CAAE,IAAK,CAAA,CAAA,CAAA,qBAAM,GAAA,CAAA,CAAA,CAAE,aAAF,EAAA,EAAgB,CAAE;AAAA;AAEvE,CAAC;;;;"}