@backstage-community/plugin-lighthouse 0.13.0 → 0.13.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @backstage-community/plugin-lighthouse
 
+## 0.13.1
+
+### Patch Changes
+
+- a1ec06f: Added support for the new frontend system.
+- Updated dependencies [a1ec06f]
+  - @backstage-community/plugin-lighthouse-common@0.10.1
+
 ## 0.13.0
 
 ### Minor Changes

package/README.md

@@ -32,7 +32,30 @@ When you have an instance running that Backstage can hook into, first install th
 yarn --cwd packages/app add @backstage-community/plugin-lighthouse
 ```
 
-Modify your app routes in `App.tsx` to include the `LighthousePage` component exported from the plugin, for example:
+If you have [Feature Discovery](https://backstage.io/docs/frontend-system/architecture/app#feature-discovery) enabled, no additional configuration is required. Otherwise, you should be able to enable the plugin in your `packages/app/src/App.tsx`:
+
+```diff
++ import lighthousePlugin from '@backstage-community/plugin-lighthouse';
+
+
+  ...
+
+  export const app = createApp({
+    features: [
+      catalogPlugin,
+      catalogImportPlugin,
+      userSettingsPlugin,
++     lighthousePlugin,
+    // ...
+    ],
+  });
+```
+
+That's it!
+
+### Legacy Frontend
+
+If you are using the legacy frontend, modify your app routes in `App.tsx` to include the `LighthousePage` component exported from the plugin, for example:
 
 ```tsx
 // In packages/app/src/App.tsx

package/dist/alpha/extensions.esm.js

@@ -0,0 +1,54 @@
+import { jsx } from 'react/jsx-runtime';
+import { PageBlueprint, ApiBlueprint, configApiRef, NavItemBlueprint } from '@backstage/frontend-plugin-api';
+import { convertLegacyRouteRef, compatWrapper } from '@backstage/core-compat-api';
+import { rootRouteRef } from '../plugin.esm.js';
+import { lighthouseApiRef } from '../api.esm.js';
+import { LighthouseRestApi } from '@backstage-community/plugin-lighthouse-common';
+import { EntityCardBlueprint, EntityContentBlueprint } from '@backstage/plugin-catalog-react/alpha';
+import { isLighthouseAvailable } from '../Router.esm.js';
+import Highlight from '@material-ui/icons/Highlight';
+
+const lighthousePage = PageBlueprint.make({
+  params: {
+    path: "/lighthouse",
+    routeRef: convertLegacyRouteRef(rootRouteRef),
+    loader: async () => import('../Router.esm.js').then((m) => compatWrapper(/* @__PURE__ */ jsx(m.Router, {})))
+  }
+});
+const lighthouseApi = ApiBlueprint.make({
+  params: (defineParams) => defineParams({
+    api: lighthouseApiRef,
+    deps: {
+      configApi: configApiRef
+    },
+    factory: ({ configApi }) => LighthouseRestApi.fromConfig(configApi)
+  })
+});
+const lighthouseNavItem = NavItemBlueprint.make({
+  params: {
+    icon: Highlight,
+    routeRef: convertLegacyRouteRef(rootRouteRef),
+    title: "Lighthouse"
+  }
+});
+const lighthouseEntityCard = EntityCardBlueprint.make({
+  name: "lighthouse",
+  params: {
+    filter: isLighthouseAvailable,
+    loader: async () => import('../components/Cards/LastLighthouseAuditCard.esm.js').then(
+      (m) => compatWrapper(/* @__PURE__ */ jsx(m.LastLighthouseAuditCard, {}))
+    )
+  }
+});
+const lighthouseEntityContent = EntityContentBlueprint.make({
+  name: "lighthouse",
+  params: {
+    path: "/lighthouse",
+    title: "Lighthouse",
+    filter: isLighthouseAvailable,
+    loader: async () => import('../Router.esm.js').then((m) => compatWrapper(/* @__PURE__ */ jsx(m.EmbeddedRouter, {})))
+  }
+});
+
+export { lighthouseApi, lighthouseEntityCard, lighthouseEntityContent, lighthouseNavItem, lighthousePage };
+//# sourceMappingURL=extensions.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"extensions.esm.js","sources":["../../src/alpha/extensions.tsx"],"sourcesContent":["/*\n * Copyright 2025 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 */\nimport {\n  ApiBlueprint,\n  configApiRef,\n  NavItemBlueprint,\n  PageBlueprint,\n} from '@backstage/frontend-plugin-api';\nimport {\n  compatWrapper,\n  convertLegacyRouteRef,\n} from '@backstage/core-compat-api';\nimport { rootRouteRef } from '../plugin';\nimport { lighthouseApiRef } from '../api';\nimport { LighthouseRestApi } from '@backstage-community/plugin-lighthouse-common';\nimport {\n  EntityCardBlueprint,\n  EntityContentBlueprint,\n} from '@backstage/plugin-catalog-react/alpha';\nimport { isLighthouseAvailable } from '../Router';\nimport Highlight from '@material-ui/icons/Highlight';\n\nexport const lighthousePage = PageBlueprint.make({\n  params: {\n    path: '/lighthouse',\n    routeRef: convertLegacyRouteRef(rootRouteRef),\n    loader: async () =>\n      import('../Router').then(m => compatWrapper(<m.Router />)),\n  },\n});\n\nexport const lighthouseApi = ApiBlueprint.make({\n  params: defineParams =>\n    defineParams({\n      api: lighthouseApiRef,\n      deps: {\n        configApi: configApiRef,\n      },\n      factory: ({ configApi }) => LighthouseRestApi.fromConfig(configApi),\n    }),\n});\n\nexport const lighthouseNavItem = NavItemBlueprint.make({\n  params: {\n    icon: Highlight,\n    routeRef: convertLegacyRouteRef(rootRouteRef),\n    title: 'Lighthouse',\n  },\n});\n\nexport const lighthouseEntityCard = EntityCardBlueprint.make({\n  name: 'lighthouse',\n  params: {\n    filter: isLighthouseAvailable,\n    loader: async () =>\n      import('../components/Cards/LastLighthouseAuditCard').then(m =>\n        compatWrapper(<m.LastLighthouseAuditCard />),\n      ),\n  },\n});\n\nexport const lighthouseEntityContent = EntityContentBlueprint.make({\n  name: 'lighthouse',\n  params: {\n    path: '/lighthouse',\n    title: 'Lighthouse',\n    filter: isLighthouseAvailable,\n    loader: async () =>\n      import('../Router').then(m => compatWrapper(<m.EmbeddedRouter />)),\n  },\n});\n"],"names":[],"mappings":";;;;;;;;;;AAmCa,MAAA,cAAA,GAAiB,cAAc,IAAK,CAAA;AAAA,EAC/C,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,aAAA;AAAA,IACN,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,IAC5C,MAAQ,EAAA,YACN,OAAO,kBAAW,CAAE,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,aAAA,iBAAe,GAAA,CAAA,CAAA,CAAE,MAAF,EAAA,EAAS,CAAE,CAAC;AAAA;AAE/D,CAAC;AAEY,MAAA,aAAA,GAAgB,aAAa,IAAK,CAAA;AAAA,EAC7C,MAAA,EAAQ,kBACN,YAAa,CAAA;AAAA,IACX,GAAK,EAAA,gBAAA;AAAA,IACL,IAAM,EAAA;AAAA,MACJ,SAAW,EAAA;AAAA,KACb;AAAA,IACA,SAAS,CAAC,EAAE,WAAgB,KAAA,iBAAA,CAAkB,WAAW,SAAS;AAAA,GACnE;AACL,CAAC;AAEY,MAAA,iBAAA,GAAoB,iBAAiB,IAAK,CAAA;AAAA,EACrD,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,SAAA;AAAA,IACN,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,IAC5C,KAAO,EAAA;AAAA;AAEX,CAAC;AAEY,MAAA,oBAAA,GAAuB,oBAAoB,IAAK,CAAA;AAAA,EAC3D,IAAM,EAAA,YAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA,qBAAA;AAAA,IACR,MAAQ,EAAA,YACN,OAAO,oDAA6C,CAAE,CAAA,IAAA;AAAA,MAAK,OACzD,aAAc,iBAAA,GAAA,CAAC,CAAE,CAAA,uBAAA,EAAF,EAA0B,CAAE;AAAA;AAC7C;AAEN,CAAC;AAEY,MAAA,uBAAA,GAA0B,uBAAuB,IAAK,CAAA;AAAA,EACjE,IAAM,EAAA,YAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,aAAA;AAAA,IACN,KAAO,EAAA,YAAA;AAAA,IACP,MAAQ,EAAA,qBAAA;AAAA,IACR,MAAQ,EAAA,YACN,OAAO,kBAAW,CAAE,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,aAAA,iBAAe,GAAA,CAAA,CAAA,CAAE,cAAF,EAAA,EAAiB,CAAE,CAAC;AAAA;AAEvE,CAAC;;;;"}

package/dist/alpha/plugin.esm.js

@@ -0,0 +1,16 @@
+import { createFrontendPlugin } from '@backstage/frontend-plugin-api';
+import { lighthousePage, lighthouseApi, lighthouseEntityCard, lighthouseNavItem, lighthouseEntityContent } from './extensions.esm.js';
+
+const lighthousePlugin = createFrontendPlugin({
+  pluginId: "lighthouse",
+  extensions: [
+    lighthousePage,
+    lighthouseApi,
+    lighthouseEntityCard,
+    lighthouseNavItem,
+    lighthouseEntityContent
+  ]
+});
+
+export { lighthousePlugin };
+//# sourceMappingURL=plugin.esm.js.map

package/dist/alpha/plugin.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.esm.js","sources":["../../src/alpha/plugin.ts"],"sourcesContent":["/*\n * Copyright 2025 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 */\nimport { createFrontendPlugin } from '@backstage/frontend-plugin-api';\nimport {\n  lighthouseApi,\n  lighthouseEntityCard,\n  lighthouseEntityContent,\n  lighthouseNavItem,\n  lighthousePage,\n} from './extensions';\n\n/**\n * @alpha\n */\nexport const lighthousePlugin = createFrontendPlugin({\n  pluginId: 'lighthouse',\n  extensions: [\n    lighthousePage,\n    lighthouseApi,\n    lighthouseEntityCard,\n    lighthouseNavItem,\n    lighthouseEntityContent,\n  ],\n});\n"],"names":[],"mappings":";;;AA2BO,MAAM,mBAAmB,oBAAqB,CAAA;AAAA,EACnD,QAAU,EAAA,YAAA;AAAA,EACV,UAAY,EAAA;AAAA,IACV,cAAA;AAAA,IACA,aAAA;AAAA,IACA,oBAAA;AAAA,IACA,iBAAA;AAAA,IACA;AAAA;AAEJ,CAAC;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,124 @@
+/// <reference types="react" />
+import * as _backstage_catalog_model from '@backstage/catalog-model';
+import * as react from 'react';
+import * as _backstage_plugin_catalog_react_alpha from '@backstage/plugin-catalog-react/alpha';
+import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
+import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
+
+/**
+ * @alpha
+ */
+declare const lighthousePlugin: _backstage_frontend_plugin_api.OverridableFrontendPlugin<{}, {}, {
+    "api:lighthouse": _backstage_frontend_plugin_api.ExtensionDefinition<{
+        kind: "api";
+        name: undefined;
+        config: {};
+        configInput: {};
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_core_plugin_api.AnyApiFactory, "core.api.factory", {}>;
+        inputs: {};
+        params: <TApi, TImpl extends TApi, TDeps extends {
+            [x: string]: unknown;
+        }>(params: _backstage_core_plugin_api.ApiFactory<TApi, TImpl, TDeps>) => _backstage_frontend_plugin_api.ExtensionBlueprintParams<_backstage_core_plugin_api.AnyApiFactory>;
+    }>;
+    "entity-card:lighthouse/lighthouse": _backstage_frontend_plugin_api.ExtensionDefinition<{
+        kind: "entity-card";
+        name: "lighthouse";
+        config: {
+            filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
+            type: "content" | "summary" | "info" | undefined;
+        };
+        configInput: {
+            filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
+            type?: "content" | "summary" | "info" | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
+            optional: true;
+        }> | _backstage_frontend_plugin_api.ExtensionDataRef<string, "catalog.entity-filter-expression", {
+            optional: true;
+        }> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_plugin_catalog_react_alpha.EntityCardType, "catalog.entity-card-type", {
+            optional: true;
+        }>;
+        inputs: {};
+        params: {
+            loader: () => Promise<JSX.Element>;
+            filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
+            type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
+        };
+    }>;
+    "entity-content:lighthouse/lighthouse": _backstage_frontend_plugin_api.ExtensionDefinition<{
+        kind: "entity-content";
+        name: "lighthouse";
+        config: {
+            path: string | undefined;
+            title: string | undefined;
+            filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
+            group: string | false | undefined;
+        };
+        configInput: {
+            filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
+            title?: string | undefined;
+            path?: string | undefined;
+            group?: string | false | 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<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
+            optional: true;
+        }> | _backstage_frontend_plugin_api.ExtensionDataRef<string, "catalog.entity-filter-expression", {
+            optional: true;
+        }> | _backstage_frontend_plugin_api.ExtensionDataRef<string, "catalog.entity-content-title", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<string, "catalog.entity-content-group", {
+            optional: true;
+        }>;
+        inputs: {};
+        params: {
+            defaultPath?: [Error: "Use the 'path' param instead"] | undefined;
+            path: string;
+            defaultTitle?: [Error: "Use the 'title' param instead"] | undefined;
+            title: string;
+            defaultGroup?: [Error: "Use the 'group' param instead"] | undefined;
+            group?: (string & {}) | "development" | "deployment" | "overview" | "documentation" | "operation" | "observability" | undefined;
+            loader: () => Promise<JSX.Element>;
+            routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
+            filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
+        };
+    }>;
+    "nav-item:lighthouse": _backstage_frontend_plugin_api.ExtensionDefinition<{
+        kind: "nav-item";
+        name: undefined;
+        config: {};
+        configInput: {};
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<{
+            title: string;
+            icon: _backstage_core_plugin_api.IconComponent;
+            routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
+        }, "core.nav-item.target", {}>;
+        inputs: {};
+        params: {
+            title: string;
+            icon: _backstage_core_plugin_api.IconComponent;
+            routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
+        };
+    }>;
+    "page:lighthouse": _backstage_frontend_plugin_api.ExtensionDefinition<{
+        kind: "page";
+        name: undefined;
+        config: {
+            path: string | undefined;
+        };
+        configInput: {
+            path?: 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;
+        }>;
+        inputs: {};
+        params: {
+            defaultPath?: [Error: "Use the 'path' param instead"] | undefined;
+            path: string;
+            loader: () => Promise<JSX.Element>;
+            routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
+        };
+    }>;
+}>;
+
+export { lighthousePlugin as default };

package/dist/alpha.esm.js

@@ -0,0 +1,6 @@
+import { lighthousePlugin } from './alpha/plugin.esm.js';
+
+
+
+export { lighthousePlugin as default };
+//# sourceMappingURL=alpha.esm.js.map

package/dist/alpha.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alpha.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage-community/plugin-lighthouse",
-  "version": "0.13.0",
+  "version": "0.13.1",
   "description": "A Backstage plugin that integrates towards Lighthouse",
   "backstage": {
     "role": "frontend-plugin",
@@ -9,12 +9,13 @@
       "@backstage-community/plugin-lighthouse",
       "@backstage-community/plugin-lighthouse-backend",
       "@backstage-community/plugin-lighthouse-common"
-    ]
+    ],
+    "features": {
+      "./alpha": "@backstage/FrontendPlugin"
+    }
   },
   "publishConfig": {
-    "access": "public",
-    "main": "dist/index.esm.js",
-    "types": "dist/index.d.ts"
+    "access": "public"
   },
   "keywords": [
     "backstage",
@@ -28,8 +29,32 @@
   },
   "license": "Apache-2.0",
   "sideEffects": false,
-  "main": "dist/index.esm.js",
-  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.esm.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.esm.js"
+    },
+    "./alpha": {
+      "backstage": "@backstage/FrontendPlugin",
+      "import": "./dist/alpha.esm.js",
+      "types": "./dist/alpha.d.ts",
+      "default": "./dist/alpha.esm.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "alpha": [
+        "dist/alpha.d.ts"
+      ],
+      "package.json": [
+        "package.json"
+      ]
+    }
+  },
   "files": [
     "dist"
   ],
@@ -43,10 +68,12 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage-community/plugin-lighthouse-common": "^0.10.0",
+    "@backstage-community/plugin-lighthouse-common": "^0.10.1",
     "@backstage/catalog-model": "^1.7.5",
+    "@backstage/core-compat-api": "^0.5.1",
     "@backstage/core-components": "^0.17.5",
     "@backstage/core-plugin-api": "^1.10.9",
+    "@backstage/frontend-plugin-api": "^0.11.0",
     "@backstage/plugin-catalog-react": "^1.20.1",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
@@ -58,6 +85,8 @@
     "@backstage/cli": "^0.34.1",
     "@backstage/core-app-api": "^1.18.0",
     "@backstage/dev-utils": "^1.1.13",
+    "@backstage/frontend-defaults": "^0.3.0",
+    "@backstage/plugin-catalog": "^1.31.2",
     "@backstage/test-utils": "^1.7.11",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
@@ -89,12 +118,5 @@
       }
     }
   },
-  "typesVersions": {
-    "*": {
-      "package.json": [
-        "package.json"
-      ]
-    }
-  },
   "module": "./dist/index.esm.js"
 }