@backstage/plugin-catalog-unprocessed-entities 0.2.31-next.0 → 0.2.32-next.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @backstage/plugin-catalog-unprocessed-entities
 
+## 0.2.32-next.0
+
+### Patch Changes
+
+- 80b4370: Updated instructions for enabling the `catalog-unprocessed-entities` page
+- Updated dependencies
+  - @backstage/core-components@0.18.11-next.0
+  - @backstage/core-compat-api@0.5.12-next.0
+
+## 0.2.31
+
+### Patch Changes
+
+- 44d77e9: Removed separate nav item extensions. Sidebar entries are now provided via `title` and `icon` on each plugin's page extension.
+- Updated dependencies
+  - @backstage/core-components@0.18.10
+  - @backstage/ui@0.15.0
+  - @backstage/errors@1.3.1
+  - @backstage/frontend-plugin-api@0.17.0
+  - @backstage/core-plugin-api@1.12.6
+  - @backstage/core-compat-api@0.5.11
+  - @backstage/plugin-catalog-unprocessed-entities-common@0.0.16
+
 ## 0.2.30-next.0
 
 ### Patch Changes

package/README.md

@@ -32,19 +32,18 @@ Requires the `@backstage/plugin-catalog-backend-module-unprocessed` module to be
 yarn --cwd packages/app add @backstage/plugin-catalog-unprocessed-entities
 ```
 
-Once installed, the plugin is automatically available in your app through the default feature discovery. For more details and alternative installation methods, see [installing plugins](https://backstage.io/docs/frontend-system/building-apps/installing-plugins).
+The page is disabled by default. To enable it, add the following to your app configuration:
 
-You can optionally add unprocessed entities as a tab in DevTools through configuration:
-
-```yaml
-app:
-  extensions:
-    # Enable the catalog-unprocessed-entities tab in devtools
-    - devtools-content:catalog-unprocessed-entities: true
-    # Disable the catalog-unprocessed-entities element outside devtools including the sidebar
-    - page:catalog-unprocessed-entities: false
+```diff
+  app:
+    extensions:
++     - page:catalog-unprocessed-entities
 ```
 
+Alternatively, unprocessed entities are available as a tab in [DevTools](https://github.com/backstage/backstage/tree/master/plugins/devtools) without any additional configuration if the DevTools plugin is installed.
+
+For more details and alternative installation methods, see [installing plugins](https://backstage.io/docs/frontend-system/building-apps/installing-plugins).
+
 ## Old Frontend System
 
 If your Backstage app uses the old frontend system, you need to manually wire the
@@ -63,7 +62,7 @@ import { CatalogUnprocessedEntitiesPage } from '@backstage/plugin-catalog-unproc
 />;
 ```
 
-## Customization
+### Customization
 
 If you want to use the provided endpoints in a different way, you can use the ApiRef doing the following:
 
@@ -74,7 +73,7 @@ import { useApi } from '@backstage/core-plugin-api';
 const catalogUnprocessedEntitiesApi = useApi(catalogUnprocessedEntitiesApiRef);
 ```
 
-Note that if you are not rendering the `CatalogUnprocessedEntitiesPage` in the `App.tsx` tree, you will need to export the `catalogUnproccessedEntitiesPlugin` from your `plugins.ts` file to setup the plugin otherwise you will receive an error like `No implementation available for apiRef{plugin.catalog-unprocessed-entities.service}`
+Note that if you are not rendering the `CatalogUnprocessedEntitiesPage` in the `App.tsx` tree, you will need to export the `catalogUnprocessedEntitiesPlugin` from your `plugins.ts` file to setup the plugin otherwise you will receive an error like `No implementation available for apiRef{plugin.catalog-unprocessed-entities.service}`
 
 ```typescript
 // In packages/app/src/plugins.ts
@@ -96,11 +95,11 @@ const app = createApp({
 });
 ```
 
-## Getting started
+## Development
 
 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 [/catalog-unprocessed-entities](http://localhost:3000/catalog-unprocessed-entities).
+and then navigating to [/devtools/unprocessed-entities](http://localhost:3000/devtools/unprocessed-entities).
 
 You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
 This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.

package/dist/alpha/plugin.esm.js

@@ -1,5 +1,5 @@
 import { jsx } from 'react/jsx-runtime';
-import { ApiBlueprint, fetchApiRef, discoveryApiRef, PageBlueprint, NavItemBlueprint, SubPageBlueprint, createFrontendPlugin } from '@backstage/frontend-plugin-api';
+import { ApiBlueprint, fetchApiRef, discoveryApiRef, PageBlueprint, SubPageBlueprint, createFrontendPlugin } from '@backstage/frontend-plugin-api';
 import { CatalogUnprocessedEntitiesClient, catalogUnprocessedEntitiesApiRef } from '../api/index.esm.js';
 import QueueIcon from '@material-ui/icons/Queue';
 import { rootRouteRef } from '../routes.esm.js';
@@ -20,14 +20,9 @@ const catalogUnprocessedEntitiesPage = PageBlueprint.make({
   params: {
     path: "/catalog-unprocessed-entities",
     routeRef: rootRouteRef,
-    loader: () => import('../components/UnprocessedEntities.esm.js').then((m) => /* @__PURE__ */ jsx(m.NfsUnprocessedEntities, {}))
-  }
-});
-const catalogUnprocessedEntitiesNavItem = NavItemBlueprint.make({
-  params: {
     title: "Unprocessed Entities",
-    routeRef: rootRouteRef,
-    icon: QueueIcon
+    icon: /* @__PURE__ */ jsx(QueueIcon, { fontSize: "inherit" }),
+    loader: () => import('../components/UnprocessedEntities.esm.js').then((m) => /* @__PURE__ */ jsx(m.NfsUnprocessedEntities, {}))
   }
 });
 const unprocessedEntitiesDevToolsContent = SubPageBlueprint.make({
@@ -49,10 +44,9 @@ var plugin = createFrontendPlugin({
   extensions: [
     catalogUnprocessedEntitiesApi,
     catalogUnprocessedEntitiesPage,
-    catalogUnprocessedEntitiesNavItem,
     unprocessedEntitiesDevToolsContent
   ]
 });
 
-export { catalogUnprocessedEntitiesApi, catalogUnprocessedEntitiesNavItem, catalogUnprocessedEntitiesPage, plugin as default, unprocessedEntitiesDevToolsContent };
+export { catalogUnprocessedEntitiesApi, catalogUnprocessedEntitiesPage, plugin as default, unprocessedEntitiesDevToolsContent };
 //# sourceMappingURL=plugin.esm.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"plugin.esm.js","sources":["../../src/alpha/plugin.tsx"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  createFrontendPlugin,\n  discoveryApiRef,\n  fetchApiRef,\n  ApiBlueprint,\n  PageBlueprint,\n  NavItemBlueprint,\n  SubPageBlueprint,\n} from '@backstage/frontend-plugin-api';\n\nimport {\n  catalogUnprocessedEntitiesApiRef,\n  CatalogUnprocessedEntitiesClient,\n} from '../api';\nimport QueueIcon from '@material-ui/icons/Queue';\nimport { rootRouteRef } from '../routes';\nimport { Container } from '@backstage/ui';\n\n/** @alpha */\nexport const catalogUnprocessedEntitiesApi = ApiBlueprint.make({\n  params: defineParams =>\n    defineParams({\n      api: catalogUnprocessedEntitiesApiRef,\n      deps: {\n        discoveryApi: discoveryApiRef,\n        fetchApi: fetchApiRef,\n      },\n      factory: ({ discoveryApi, fetchApi }) =>\n        new CatalogUnprocessedEntitiesClient(discoveryApi, fetchApi),\n    }),\n});\n\n/** @alpha */\nexport const catalogUnprocessedEntitiesPage = PageBlueprint.make({\n  disabled: true,\n  params: {\n    path: '/catalog-unprocessed-entities',\n    routeRef: rootRouteRef,\n    loader: () =>\n      import('../components/UnprocessedEntities').then(m => (\n        <m.NfsUnprocessedEntities />\n      )),\n  },\n});\n\n/** @alpha */\nexport const catalogUnprocessedEntitiesNavItem = NavItemBlueprint.make({\n  params: {\n    title: 'Unprocessed Entities',\n    routeRef: rootRouteRef,\n    icon: QueueIcon,\n  },\n});\n\n/**\n * DevTools content for catalog unprocessed entities.\n *\n * @alpha\n */\nexport const unprocessedEntitiesDevToolsContent = SubPageBlueprint.make({\n  attachTo: { id: 'page:devtools', input: 'pages' },\n  params: {\n    path: 'unprocessed-entities',\n    title: 'Unprocessed Entities',\n    loader: () =>\n      import('../components/UnprocessedEntities').then(m => (\n        <Container>\n          <m.UnprocessedEntitiesContent />\n        </Container>\n      )),\n  },\n});\n\n/** @alpha */\nexport default createFrontendPlugin({\n  pluginId: 'catalog-unprocessed-entities',\n  title: 'Unprocessed Entities',\n  icon: <QueueIcon fontSize=\"inherit\" />,\n  info: { packageJson: () => import('../../package.json') },\n  routes: {\n    root: rootRouteRef,\n  },\n  extensions: [\n    catalogUnprocessedEntitiesApi,\n    catalogUnprocessedEntitiesPage,\n    catalogUnprocessedEntitiesNavItem,\n    unprocessedEntitiesDevToolsContent,\n  ],\n});\n"],"names":[],"mappings":";;;;;;;AAmCO,MAAM,6BAAA,GAAgC,aAAa,IAAA,CAAK;AAAA,EAC7D,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,gCAAA;AAAA,IACL,IAAA,EAAM;AAAA,MACJ,YAAA,EAAc,eAAA;AAAA,MACd,QAAA,EAAU;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,YAAA,EAAc,UAAS,KACjC,IAAI,gCAAA,CAAiC,YAAA,EAAc,QAAQ;AAAA,GAC9D;AACL,CAAC;AAGM,MAAM,8BAAA,GAAiC,cAAc,IAAA,CAAK;AAAA,EAC/D,QAAA,EAAU,IAAA;AAAA,EACV,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,+BAAA;AAAA,IACN,QAAA,EAAU,YAAA;AAAA,IACV,MAAA,EAAQ,MACN,OAAO,0CAAmC,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAC/C,GAAA,CAAC,CAAA,CAAE,sBAAA,EAAF,EAAyB,CAC3B;AAAA;AAEP,CAAC;AAGM,MAAM,iCAAA,GAAoC,iBAAiB,IAAA,CAAK;AAAA,EACrE,MAAA,EAAQ;AAAA,IACN,KAAA,EAAO,sBAAA;AAAA,IACP,QAAA,EAAU,YAAA;AAAA,IACV,IAAA,EAAM;AAAA;AAEV,CAAC;AAOM,MAAM,kCAAA,GAAqC,iBAAiB,IAAA,CAAK;AAAA,EACtE,QAAA,EAAU,EAAE,EAAA,EAAI,eAAA,EAAiB,OAAO,OAAA,EAAQ;AAAA,EAChD,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,sBAAA;AAAA,IACN,KAAA,EAAO,sBAAA;AAAA,IACP,MAAA,EAAQ,MACN,OAAO,0CAAmC,EAAE,IAAA,CAAK,CAAA,CAAA,qBAC/C,GAAA,CAAC,SAAA,EAAA,EACC,QAAA,kBAAA,GAAA,CAAC,CAAA,CAAE,0BAAA,EAAF,EAA6B,GAChC,CACD;AAAA;AAEP,CAAC;AAGD,aAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,8BAAA;AAAA,EACV,KAAA,EAAO,sBAAA;AAAA,EACP,IAAA,kBAAM,GAAA,CAAC,SAAA,EAAA,EAAU,QAAA,EAAS,SAAA,EAAU,CAAA;AAAA,EACpC,MAAM,EAAE,WAAA,EAAa,MAAM,OAAO,wBAAoB,CAAA,EAAE;AAAA,EACxD,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM;AAAA,GACR;AAAA,EACA,UAAA,EAAY;AAAA,IACV,6BAAA;AAAA,IACA,8BAAA;AAAA,IACA,iCAAA;AAAA,IACA;AAAA;AAEJ,CAAC,CAAA;;;;"}
+{"version":3,"file":"plugin.esm.js","sources":["../../src/alpha/plugin.tsx"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  createFrontendPlugin,\n  discoveryApiRef,\n  fetchApiRef,\n  ApiBlueprint,\n  PageBlueprint,\n  SubPageBlueprint,\n} from '@backstage/frontend-plugin-api';\n\nimport {\n  catalogUnprocessedEntitiesApiRef,\n  CatalogUnprocessedEntitiesClient,\n} from '../api';\nimport QueueIcon from '@material-ui/icons/Queue';\nimport { rootRouteRef } from '../routes';\nimport { Container } from '@backstage/ui';\n\n/** @alpha */\nexport const catalogUnprocessedEntitiesApi = ApiBlueprint.make({\n  params: defineParams =>\n    defineParams({\n      api: catalogUnprocessedEntitiesApiRef,\n      deps: {\n        discoveryApi: discoveryApiRef,\n        fetchApi: fetchApiRef,\n      },\n      factory: ({ discoveryApi, fetchApi }) =>\n        new CatalogUnprocessedEntitiesClient(discoveryApi, fetchApi),\n    }),\n});\n\n/** @alpha */\nexport const catalogUnprocessedEntitiesPage = PageBlueprint.make({\n  disabled: true,\n  params: {\n    path: '/catalog-unprocessed-entities',\n    routeRef: rootRouteRef,\n    title: 'Unprocessed Entities',\n    icon: <QueueIcon fontSize=\"inherit\" />,\n    loader: () =>\n      import('../components/UnprocessedEntities').then(m => (\n        <m.NfsUnprocessedEntities />\n      )),\n  },\n});\n\n/**\n * DevTools content for catalog unprocessed entities.\n *\n * @alpha\n */\nexport const unprocessedEntitiesDevToolsContent = SubPageBlueprint.make({\n  attachTo: { id: 'page:devtools', input: 'pages' },\n  params: {\n    path: 'unprocessed-entities',\n    title: 'Unprocessed Entities',\n    loader: () =>\n      import('../components/UnprocessedEntities').then(m => (\n        <Container>\n          <m.UnprocessedEntitiesContent />\n        </Container>\n      )),\n  },\n});\n\n/** @alpha */\nexport default createFrontendPlugin({\n  pluginId: 'catalog-unprocessed-entities',\n  title: 'Unprocessed Entities',\n  icon: <QueueIcon fontSize=\"inherit\" />,\n  info: { packageJson: () => import('../../package.json') },\n  routes: {\n    root: rootRouteRef,\n  },\n  extensions: [\n    catalogUnprocessedEntitiesApi,\n    catalogUnprocessedEntitiesPage,\n    unprocessedEntitiesDevToolsContent,\n  ],\n});\n"],"names":[],"mappings":";;;;;;;AAkCO,MAAM,6BAAA,GAAgC,aAAa,IAAA,CAAK;AAAA,EAC7D,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,gCAAA;AAAA,IACL,IAAA,EAAM;AAAA,MACJ,YAAA,EAAc,eAAA;AAAA,MACd,QAAA,EAAU;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,YAAA,EAAc,UAAS,KACjC,IAAI,gCAAA,CAAiC,YAAA,EAAc,QAAQ;AAAA,GAC9D;AACL,CAAC;AAGM,MAAM,8BAAA,GAAiC,cAAc,IAAA,CAAK;AAAA,EAC/D,QAAA,EAAU,IAAA;AAAA,EACV,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,+BAAA;AAAA,IACN,QAAA,EAAU,YAAA;AAAA,IACV,KAAA,EAAO,sBAAA;AAAA,IACP,IAAA,kBAAM,GAAA,CAAC,SAAA,EAAA,EAAU,QAAA,EAAS,SAAA,EAAU,CAAA;AAAA,IACpC,MAAA,EAAQ,MACN,OAAO,0CAAmC,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAC/C,GAAA,CAAC,CAAA,CAAE,sBAAA,EAAF,EAAyB,CAC3B;AAAA;AAEP,CAAC;AAOM,MAAM,kCAAA,GAAqC,iBAAiB,IAAA,CAAK;AAAA,EACtE,QAAA,EAAU,EAAE,EAAA,EAAI,eAAA,EAAiB,OAAO,OAAA,EAAQ;AAAA,EAChD,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,sBAAA;AAAA,IACN,KAAA,EAAO,sBAAA;AAAA,IACP,MAAA,EAAQ,MACN,OAAO,0CAAmC,EAAE,IAAA,CAAK,CAAA,CAAA,qBAC/C,GAAA,CAAC,SAAA,EAAA,EACC,QAAA,kBAAA,GAAA,CAAC,CAAA,CAAE,0BAAA,EAAF,EAA6B,GAChC,CACD;AAAA;AAEP,CAAC;AAGD,aAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,8BAAA;AAAA,EACV,KAAA,EAAO,sBAAA;AAAA,EACP,IAAA,kBAAM,GAAA,CAAC,SAAA,EAAA,EAAU,QAAA,EAAS,SAAA,EAAU,CAAA;AAAA,EACpC,MAAM,EAAE,WAAA,EAAa,MAAM,OAAO,wBAAoB,CAAA,EAAE;AAAA,EACxD,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM;AAAA,GACR;AAAA,EACA,UAAA,EAAY;AAAA,IACV,6BAAA;AAAA,IACA,8BAAA;AAAA,IACA;AAAA;AAEJ,CAAC,CAAA;;;;"}

package/dist/alpha.d.ts

@@ -15,27 +15,6 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
         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>;
     }>;
-    "nav-item:catalog-unprocessed-entities": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
-        kind: "nav-item";
-        name: undefined;
-        config: {
-            title: string | undefined;
-        };
-        configInput: {
-            title?: string | undefined;
-        };
-        output: _backstage_frontend_plugin_api.ExtensionDataRef<{
-            title: string;
-            icon: _backstage_frontend_plugin_api.IconComponent;
-            routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
-        }, "core.nav-item.target", {}>;
-        inputs: {};
-        params: {
-            title: string;
-            icon: _backstage_frontend_plugin_api.IconComponent;
-            routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
-        };
-    }>;
     "page:catalog-unprocessed-entities": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
         kind: "page";
         name: undefined;

package/dist/package.json.esm.js

@@ -1,5 +1,5 @@
 var name = "@backstage/plugin-catalog-unprocessed-entities";
-var version = "0.2.31-next.0";
+var version = "0.2.32-next.0";
 var backstage = {
 	role: "frontend-plugin",
 	pluginId: "catalog-unprocessed-entities",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-unprocessed-entities",
-  "version": "0.2.31-next.0",
+  "version": "0.2.32-next.0",
   "backstage": {
     "role": "frontend-plugin",
     "pluginId": "catalog-unprocessed-entities",
@@ -62,13 +62,13 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/core-compat-api": "0.5.11-next.0",
-    "@backstage/core-components": "0.18.10-next.1",
-    "@backstage/core-plugin-api": "1.12.6-next.1",
-    "@backstage/errors": "1.3.1-next.0",
-    "@backstage/frontend-plugin-api": "0.17.0-next.1",
-    "@backstage/plugin-catalog-unprocessed-entities-common": "0.0.16-next.1",
-    "@backstage/ui": "0.15.0-next.2",
+    "@backstage/core-compat-api": "0.5.12-next.0",
+    "@backstage/core-components": "0.18.11-next.0",
+    "@backstage/core-plugin-api": "1.12.6",
+    "@backstage/errors": "1.3.1",
+    "@backstage/frontend-plugin-api": "0.17.0",
+    "@backstage/plugin-catalog-unprocessed-entities-common": "0.0.16",
+    "@backstage/ui": "0.15.0",
     "@material-ui/core": "^4.9.13",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "^4.0.0-alpha.60",
@@ -76,8 +76,8 @@
     "react-use": "^17.2.4"
   },
   "devDependencies": {
-    "@backstage/cli": "0.36.2-next.1",
-    "@backstage/dev-utils": "1.1.23-next.0",
+    "@backstage/cli": "0.36.3-next.0",
+    "@backstage/dev-utils": "1.1.24-next.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
     "@types/react": "^18.0.0",