@backstage/plugin-api-docs 0.14.1-next.1 → 0.14.2-next.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/plugin-api-docs
 
+## 0.14.2-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-react@3.0.1-next.0
+  - @backstage/plugin-catalog@2.0.6-next.0
+  - @backstage/core-components@0.18.11-next.0
+
+## 0.14.1
+
+### Patch Changes
+
+- f635139: Limited `@remixicon/react` dependency to versions below 4.9.0 due to a license change in that release.
+- 44d77e9: Removed separate nav item extensions. Sidebar entries are now provided via `title` and `icon` on each plugin's page extension.
+- Updated dependencies
+  - @backstage/catalog-model@1.9.0
+  - @backstage/core-components@0.18.10
+  - @backstage/ui@0.15.0
+  - @backstage/plugin-catalog@2.0.5
+  - @backstage/frontend-plugin-api@0.17.0
+  - @backstage/core-plugin-api@1.12.6
+  - @backstage/plugin-catalog-react@3.0.0
+  - @backstage/plugin-catalog-common@1.1.10
+  - @backstage/plugin-permission-react@0.5.1
+
 ## 0.14.1-next.1
 
 ### Patch Changes

package/dist/alpha.d.ts

@@ -253,27 +253,6 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
             filter?: string | _backstage_filter_predicates.FilterPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
         };
     }>;
-    "nav-item:api-docs": _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:api-docs": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
         config: {
             initiallySelectedFilter: "all" | "owned" | "starred" | undefined;

package/dist/alpha.esm.js

@@ -1,6 +1,6 @@
 import { jsx, jsxs } from 'react/jsx-runtime';
 import Grid from '@material-ui/core/Grid';
-import { NavItemBlueprint, ApiBlueprint, PageBlueprint, createFrontendPlugin } from '@backstage/frontend-plugin-api';
+import { ApiBlueprint, PageBlueprint, createFrontendPlugin } from '@backstage/frontend-plugin-api';
 import { RELATION_HAS_PART, parseEntityRef } from '@backstage/catalog-model';
 import '@backstage/plugin-catalog-react';
 import { AppIcon } from '@backstage/core-components';
@@ -13,13 +13,6 @@ import '@material-ui/core/Typography';
 import { rootRoute, registerComponentRouteRef } from './routes.esm.js';
 import { EntityCardBlueprint, EntityContentBlueprint } from '@backstage/plugin-catalog-react/alpha';
 
-const apiDocsNavItem = NavItemBlueprint.make({
-  params: {
-    title: "APIs",
-    routeRef: rootRoute,
-    icon: () => /* @__PURE__ */ jsx(AppIcon, { fontSize: "inherit", id: "kind:api" })
-  }
-});
 const apiDocsConfigApi = ApiBlueprint.make({
   name: "config",
   params: (defineParams) => defineParams({
@@ -46,6 +39,8 @@ const apiDocsExplorerPage = PageBlueprint.makeWithOverrides({
     return originalFactory({
       path: "/api-docs",
       routeRef: rootRoute,
+      title: "APIs",
+      icon: /* @__PURE__ */ jsx(AppIcon, { fontSize: "inherit", id: "kind:api" }),
       loader: () => import('./components/ApiExplorerPage/DefaultApiExplorerPage.esm.js').then(
         (m) => /* @__PURE__ */ jsx(
           m.NfsApiExplorerPage,
@@ -153,7 +148,6 @@ var alpha = createFrontendPlugin({
     registerApi: registerComponentRouteRef
   },
   extensions: [
-    apiDocsNavItem,
     apiDocsConfigApi,
     apiDocsExplorerPage,
     apiDocsHasApisEntityCard,

package/dist/alpha.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.tsx"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport Grid from '@material-ui/core/Grid';\n\nimport {\n  ApiBlueprint,\n  NavItemBlueprint,\n  PageBlueprint,\n  createFrontendPlugin,\n} from '@backstage/frontend-plugin-api';\n\nimport {\n  ApiEntity,\n  parseEntityRef,\n  RELATION_HAS_PART,\n} from '@backstage/catalog-model';\n\nimport { defaultDefinitionWidgets } from './components/ApiDefinitionCard';\nimport { rootRoute, registerComponentRouteRef } from './routes';\nimport { apiDocsConfigRef } from './config';\nimport { AppIcon } from '@backstage/core-components';\n\nimport {\n  EntityCardBlueprint,\n  EntityContentBlueprint,\n} from '@backstage/plugin-catalog-react/alpha';\n\nconst apiDocsNavItem = NavItemBlueprint.make({\n  params: {\n    title: 'APIs',\n    routeRef: rootRoute,\n    icon: () => <AppIcon fontSize=\"inherit\" id=\"kind:api\" />,\n  },\n});\n\nconst apiDocsConfigApi = ApiBlueprint.make({\n  name: 'config',\n  params: defineParams =>\n    defineParams({\n      api: apiDocsConfigRef,\n      deps: {},\n      factory: () => {\n        const definitionWidgets = defaultDefinitionWidgets();\n        return {\n          getApiDefinitionWidget: (apiEntity: ApiEntity) => {\n            return definitionWidgets.find(d => d.type === apiEntity.spec.type);\n          },\n        };\n      },\n    }),\n});\n\nconst apiDocsExplorerPage = PageBlueprint.makeWithOverrides({\n  config: {\n    schema: {\n      // Omitting columns and actions for now as their types are too complex to map to zod\n      initiallySelectedFilter: z =>\n        z.enum(['owned', 'starred', 'all']).optional(),\n    },\n  },\n  factory(originalFactory, { config }) {\n    return originalFactory({\n      path: '/api-docs',\n      routeRef: rootRoute,\n      loader: () =>\n        import('./components/ApiExplorerPage/DefaultApiExplorerPage').then(\n          m => (\n            <m.NfsApiExplorerPage\n              initiallySelectedFilter={config.initiallySelectedFilter}\n            />\n          ),\n        ),\n    });\n  },\n});\n\nconst apiDocsHasApisEntityCard = EntityCardBlueprint.make({\n  name: 'has-apis',\n  params: {\n    // Omitting configSchema for now\n    // We are skipping variants and columns are too complex to map to zod\n    // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252\n    filter: entity => {\n      return (\n        entity.kind === 'Component' &&\n        entity.relations?.some(\n          ({ type, targetRef }) =>\n            type.toLocaleLowerCase('en-US') === RELATION_HAS_PART &&\n            parseEntityRef(targetRef).kind === 'API',\n        )!!\n      );\n    },\n    loader: () => import('./components/ApisCards').then(m => <m.HasApisCard />),\n  },\n});\n\nconst apiDocsDefinitionEntityCard = EntityCardBlueprint.make({\n  name: 'definition',\n  params: {\n    filter: { kind: 'api' },\n    loader: () =>\n      import('./components/ApiDefinitionCard').then(m => (\n        <m.ApiDefinitionCard />\n      )),\n  },\n});\n\nconst apiDocsConsumedApisEntityCard = EntityCardBlueprint.make({\n  name: 'consumed-apis',\n  params: {\n    // Omitting configSchema for now\n    // We are skipping variants and columns are too complex to map to zod\n    // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252\n    filter: { kind: 'component' },\n    loader: () =>\n      import('./components/ApisCards').then(m => <m.ConsumedApisCard />),\n  },\n});\n\nconst apiDocsProvidedApisEntityCard = EntityCardBlueprint.make({\n  name: 'provided-apis',\n  params: {\n    // Omitting configSchema for now\n    // We are skipping variants and columns are too complex to map to zod\n    // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252\n    filter: { kind: 'component' },\n    loader: () =>\n      import('./components/ApisCards').then(m => <m.ProvidedApisCard />),\n  },\n});\n\nconst apiDocsConsumingComponentsEntityCard = EntityCardBlueprint.make({\n  name: 'consuming-components',\n  params: {\n    // Omitting configSchema for now\n    // We are skipping variants\n    // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252\n    filter: { kind: 'api' },\n    loader: () =>\n      import('./components/ComponentsCards').then(m => (\n        <m.ConsumingComponentsCard />\n      )),\n  },\n});\n\nconst apiDocsProvidingComponentsEntityCard = EntityCardBlueprint.make({\n  name: 'providing-components',\n  params: {\n    // Omitting configSchema for now\n    // We are skipping variants\n    // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252\n    filter: { kind: 'api' },\n    loader: () =>\n      import('./components/ComponentsCards').then(m => (\n        <m.ProvidingComponentsCard />\n      )),\n  },\n});\n\nconst apiDocsDefinitionEntityContent = EntityContentBlueprint.make({\n  name: 'definition',\n  params: {\n    path: '/definition',\n    title: 'Definition',\n    group: 'documentation',\n    filter: { kind: 'api' },\n    loader: async () =>\n      import('./components/ApiDefinitionCard').then(m => (\n        <Grid container spacing={3}>\n          <Grid item xs={12}>\n            <m.ApiDefinitionCard />\n          </Grid>\n        </Grid>\n      )),\n  },\n});\n\nconst apiDocsApisEntityContent = EntityContentBlueprint.make({\n  name: 'apis',\n  params: {\n    path: '/apis',\n    title: 'APIs',\n    group: 'development',\n    filter: { kind: 'component' },\n    loader: async () =>\n      import('./components/ApisCards').then(m => (\n        <Grid container spacing={3} alignItems=\"stretch\">\n          <Grid item xs={12}>\n            <m.ProvidedApisCard />\n          </Grid>\n          <Grid item xs={12}>\n            <m.ConsumedApisCard />\n          </Grid>\n        </Grid>\n      )),\n  },\n});\n\nexport default createFrontendPlugin({\n  pluginId: 'api-docs',\n  title: 'APIs',\n  icon: <AppIcon fontSize=\"inherit\" id=\"kind:api\" />,\n  info: { packageJson: () => import('../package.json') },\n  routes: {\n    root: rootRoute,\n  },\n  externalRoutes: {\n    registerApi: registerComponentRouteRef,\n  },\n  extensions: [\n    apiDocsNavItem,\n    apiDocsConfigApi,\n    apiDocsExplorerPage,\n    apiDocsHasApisEntityCard,\n    apiDocsDefinitionEntityCard,\n    apiDocsProvidedApisEntityCard,\n    apiDocsConsumedApisEntityCard,\n    apiDocsConsumingComponentsEntityCard,\n    apiDocsProvidingComponentsEntityCard,\n    apiDocsDefinitionEntityContent,\n    apiDocsApisEntityContent,\n  ],\n});\n\nimport { apiDocsTranslationRef as _apiDocsTranslationRef } from './translation';\n\n/**\n * @alpha\n * @deprecated Import from `@backstage/plugin-api-docs` instead.\n */\nexport const apiDocsTranslationRef = _apiDocsTranslationRef;\n"],"names":["_apiDocsTranslationRef"],"mappings":";;;;;;;;;;;;;;;AAyCA,MAAM,cAAA,GAAiB,iBAAiB,IAAA,CAAK;AAAA,EAC3C,MAAA,EAAQ;AAAA,IACN,KAAA,EAAO,MAAA;AAAA,IACP,QAAA,EAAU,SAAA;AAAA,IACV,MAAM,sBAAM,GAAA,CAAC,WAAQ,QAAA,EAAS,SAAA,EAAU,IAAG,UAAA,EAAW;AAAA;AAE1D,CAAC,CAAA;AAED,MAAM,gBAAA,GAAmB,aAAa,IAAA,CAAK;AAAA,EACzC,IAAA,EAAM,QAAA;AAAA,EACN,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,gBAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,SAAS,MAAM;AACb,MAAA,MAAM,oBAAoB,wBAAA,EAAyB;AACnD,MAAA,OAAO;AAAA,QACL,sBAAA,EAAwB,CAAC,SAAA,KAAyB;AAChD,UAAA,OAAO,kBAAkB,IAAA,CAAK,CAAA,CAAA,KAAK,EAAE,IAAA,KAAS,SAAA,CAAU,KAAK,IAAI,CAAA;AAAA,QACnE;AAAA,OACF;AAAA,IACF;AAAA,GACD;AACL,CAAC,CAAA;AAED,MAAM,mBAAA,GAAsB,cAAc,iBAAA,CAAkB;AAAA,EAC1D,MAAA,EAAQ;AAAA,IACN,MAAA,EAAQ;AAAA;AAAA,MAEN,uBAAA,EAAyB,CAAA,CAAA,KACvB,CAAA,CAAE,IAAA,CAAK,CAAC,SAAS,SAAA,EAAW,KAAK,CAAC,CAAA,CAAE,QAAA;AAAS;AACjD,GACF;AAAA,EACA,OAAA,CAAQ,eAAA,EAAiB,EAAE,MAAA,EAAO,EAAG;AACnC,IAAA,OAAO,eAAA,CAAgB;AAAA,MACrB,IAAA,EAAM,WAAA;AAAA,MACN,QAAA,EAAU,SAAA;AAAA,MACV,MAAA,EAAQ,MACN,OAAO,4DAAqD,CAAA,CAAE,IAAA;AAAA,QAC5D,CAAA,CAAA,qBACE,GAAA;AAAA,UAAC,CAAA,CAAE,kBAAA;AAAA,UAAF;AAAA,YACC,yBAAyB,MAAA,CAAO;AAAA;AAAA;AAClC;AAEJ,KACH,CAAA;AAAA,EACH;AACF,CAAC,CAAA;AAED,MAAM,wBAAA,GAA2B,oBAAoB,IAAA,CAAK;AAAA,EACxD,IAAA,EAAM,UAAA;AAAA,EACN,MAAA,EAAQ;AAAA;AAAA;AAAA;AAAA,IAIN,QAAQ,CAAA,MAAA,KAAU;AAChB,MAAA,OACE,MAAA,CAAO,IAAA,KAAS,WAAA,IAChB,MAAA,CAAO,SAAA,EAAW,IAAA;AAAA,QAChB,CAAC,EAAE,IAAA,EAAM,SAAA,EAAU,KACjB,IAAA,CAAK,iBAAA,CAAkB,OAAO,CAAA,KAAM,iBAAA,IACpC,cAAA,CAAe,SAAS,EAAE,IAAA,KAAS;AAAA,OACvC;AAAA,IAEJ,CAAA;AAAA,IACA,MAAA,EAAQ,MAAM,OAAO,qCAAwB,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAAK,GAAA,CAAC,CAAA,CAAE,WAAA,EAAF,EAAc,CAAE;AAAA;AAE9E,CAAC,CAAA;AAED,MAAM,2BAAA,GAA8B,oBAAoB,IAAA,CAAK;AAAA,EAC3D,IAAA,EAAM,YAAA;AAAA,EACN,MAAA,EAAQ;AAAA,IACN,MAAA,EAAQ,EAAE,IAAA,EAAM,KAAA,EAAM;AAAA,IACtB,MAAA,EAAQ,MACN,OAAO,6CAAgC,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAC5C,GAAA,CAAC,CAAA,CAAE,iBAAA,EAAF,EAAoB,CACtB;AAAA;AAEP,CAAC,CAAA;AAED,MAAM,6BAAA,GAAgC,oBAAoB,IAAA,CAAK;AAAA,EAC7D,IAAA,EAAM,eAAA;AAAA,EACN,MAAA,EAAQ;AAAA;AAAA;AAAA;AAAA,IAIN,MAAA,EAAQ,EAAE,IAAA,EAAM,WAAA,EAAY;AAAA,IAC5B,MAAA,EAAQ,MACN,OAAO,qCAAwB,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAAK,GAAA,CAAC,CAAA,CAAE,gBAAA,EAAF,EAAmB,CAAE;AAAA;AAEvE,CAAC,CAAA;AAED,MAAM,6BAAA,GAAgC,oBAAoB,IAAA,CAAK;AAAA,EAC7D,IAAA,EAAM,eAAA;AAAA,EACN,MAAA,EAAQ;AAAA;AAAA;AAAA;AAAA,IAIN,MAAA,EAAQ,EAAE,IAAA,EAAM,WAAA,EAAY;AAAA,IAC5B,MAAA,EAAQ,MACN,OAAO,qCAAwB,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAAK,GAAA,CAAC,CAAA,CAAE,gBAAA,EAAF,EAAmB,CAAE;AAAA;AAEvE,CAAC,CAAA;AAED,MAAM,oCAAA,GAAuC,oBAAoB,IAAA,CAAK;AAAA,EACpE,IAAA,EAAM,sBAAA;AAAA,EACN,MAAA,EAAQ;AAAA;AAAA;AAAA;AAAA,IAIN,MAAA,EAAQ,EAAE,IAAA,EAAM,KAAA,EAAM;AAAA,IACtB,MAAA,EAAQ,MACN,OAAO,2CAA8B,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAC1C,GAAA,CAAC,CAAA,CAAE,uBAAA,EAAF,EAA0B,CAC5B;AAAA;AAEP,CAAC,CAAA;AAED,MAAM,oCAAA,GAAuC,oBAAoB,IAAA,CAAK;AAAA,EACpE,IAAA,EAAM,sBAAA;AAAA,EACN,MAAA,EAAQ;AAAA;AAAA;AAAA;AAAA,IAIN,MAAA,EAAQ,EAAE,IAAA,EAAM,KAAA,EAAM;AAAA,IACtB,MAAA,EAAQ,MACN,OAAO,2CAA8B,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAC1C,GAAA,CAAC,CAAA,CAAE,uBAAA,EAAF,EAA0B,CAC5B;AAAA;AAEP,CAAC,CAAA;AAED,MAAM,8BAAA,GAAiC,uBAAuB,IAAA,CAAK;AAAA,EACjE,IAAA,EAAM,YAAA;AAAA,EACN,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,aAAA;AAAA,IACN,KAAA,EAAO,YAAA;AAAA,IACP,KAAA,EAAO,eAAA;AAAA,IACP,MAAA,EAAQ,EAAE,IAAA,EAAM,KAAA,EAAM;AAAA,IACtB,MAAA,EAAQ,YACN,OAAO,6CAAgC,CAAA,CAAE,KAAK,CAAA,CAAA,qBAC5C,GAAA,CAAC,IAAA,EAAA,EAAK,SAAA,EAAS,IAAA,EAAC,OAAA,EAAS,GACvB,QAAA,kBAAA,GAAA,CAAC,IAAA,EAAA,EAAK,IAAA,EAAI,IAAA,EAAC,EAAA,EAAI,EAAA,EACb,QAAA,kBAAA,GAAA,CAAC,CAAA,CAAE,iBAAA,EAAF,EAAoB,CAAA,EACvB,CAAA,EACF,CACD;AAAA;AAEP,CAAC,CAAA;AAED,MAAM,wBAAA,GAA2B,uBAAuB,IAAA,CAAK;AAAA,EAC3D,IAAA,EAAM,MAAA;AAAA,EACN,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,OAAA;AAAA,IACN,KAAA,EAAO,MAAA;AAAA,IACP,KAAA,EAAO,aAAA;AAAA,IACP,MAAA,EAAQ,EAAE,IAAA,EAAM,WAAA,EAAY;AAAA,IAC5B,MAAA,EAAQ,YACN,OAAO,qCAAwB,EAAE,IAAA,CAAK,CAAA,CAAA,qBACpC,IAAA,CAAC,IAAA,EAAA,EAAK,SAAA,EAAS,IAAA,EAAC,OAAA,EAAS,CAAA,EAAG,YAAW,SAAA,EACrC,QAAA,EAAA;AAAA,sBAAA,GAAA,CAAC,IAAA,EAAA,EAAK,MAAI,IAAA,EAAC,EAAA,EAAI,IACb,QAAA,kBAAA,GAAA,CAAC,CAAA,CAAE,gBAAA,EAAF,EAAmB,CAAA,EACtB,CAAA;AAAA,sBACA,GAAA,CAAC,IAAA,EAAA,EAAK,IAAA,EAAI,IAAA,EAAC,EAAA,EAAI,IACb,QAAA,kBAAA,GAAA,CAAC,CAAA,CAAE,gBAAA,EAAF,EAAmB,CAAA,EACtB;AAAA,KAAA,EACF,CACD;AAAA;AAEP,CAAC,CAAA;AAED,YAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,UAAA;AAAA,EACV,KAAA,EAAO,MAAA;AAAA,EACP,sBAAM,GAAA,CAAC,OAAA,EAAA,EAAQ,QAAA,EAAS,SAAA,EAAU,IAAG,UAAA,EAAW,CAAA;AAAA,EAChD,MAAM,EAAE,WAAA,EAAa,MAAM,OAAO,uBAAiB,CAAA,EAAE;AAAA,EACrD,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM;AAAA,GACR;AAAA,EACA,cAAA,EAAgB;AAAA,IACd,WAAA,EAAa;AAAA,GACf;AAAA,EACA,UAAA,EAAY;AAAA,IACV,cAAA;AAAA,IACA,gBAAA;AAAA,IACA,mBAAA;AAAA,IACA,wBAAA;AAAA,IACA,2BAAA;AAAA,IACA,6BAAA;AAAA,IACA,6BAAA;AAAA,IACA,oCAAA;AAAA,IACA,oCAAA;AAAA,IACA,8BAAA;AAAA,IACA;AAAA;AAEJ,CAAC,CAAA;AAQM,MAAM,qBAAA,GAAwBA;;;;"}
+{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.tsx"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport Grid from '@material-ui/core/Grid';\n\nimport {\n  ApiBlueprint,\n  PageBlueprint,\n  createFrontendPlugin,\n} from '@backstage/frontend-plugin-api';\n\nimport {\n  ApiEntity,\n  parseEntityRef,\n  RELATION_HAS_PART,\n} from '@backstage/catalog-model';\n\nimport { defaultDefinitionWidgets } from './components/ApiDefinitionCard';\nimport { rootRoute, registerComponentRouteRef } from './routes';\nimport { apiDocsConfigRef } from './config';\nimport { AppIcon } from '@backstage/core-components';\n\nimport {\n  EntityCardBlueprint,\n  EntityContentBlueprint,\n} from '@backstage/plugin-catalog-react/alpha';\n\nconst apiDocsConfigApi = ApiBlueprint.make({\n  name: 'config',\n  params: defineParams =>\n    defineParams({\n      api: apiDocsConfigRef,\n      deps: {},\n      factory: () => {\n        const definitionWidgets = defaultDefinitionWidgets();\n        return {\n          getApiDefinitionWidget: (apiEntity: ApiEntity) => {\n            return definitionWidgets.find(d => d.type === apiEntity.spec.type);\n          },\n        };\n      },\n    }),\n});\n\nconst apiDocsExplorerPage = PageBlueprint.makeWithOverrides({\n  config: {\n    schema: {\n      // Omitting columns and actions for now as their types are too complex to map to zod\n      initiallySelectedFilter: z =>\n        z.enum(['owned', 'starred', 'all']).optional(),\n    },\n  },\n  factory(originalFactory, { config }) {\n    return originalFactory({\n      path: '/api-docs',\n      routeRef: rootRoute,\n      title: 'APIs',\n      icon: <AppIcon fontSize=\"inherit\" id=\"kind:api\" />,\n      loader: () =>\n        import('./components/ApiExplorerPage/DefaultApiExplorerPage').then(\n          m => (\n            <m.NfsApiExplorerPage\n              initiallySelectedFilter={config.initiallySelectedFilter}\n            />\n          ),\n        ),\n    });\n  },\n});\n\nconst apiDocsHasApisEntityCard = EntityCardBlueprint.make({\n  name: 'has-apis',\n  params: {\n    // Omitting configSchema for now\n    // We are skipping variants and columns are too complex to map to zod\n    // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252\n    filter: entity => {\n      return (\n        entity.kind === 'Component' &&\n        entity.relations?.some(\n          ({ type, targetRef }) =>\n            type.toLocaleLowerCase('en-US') === RELATION_HAS_PART &&\n            parseEntityRef(targetRef).kind === 'API',\n        )!!\n      );\n    },\n    loader: () => import('./components/ApisCards').then(m => <m.HasApisCard />),\n  },\n});\n\nconst apiDocsDefinitionEntityCard = EntityCardBlueprint.make({\n  name: 'definition',\n  params: {\n    filter: { kind: 'api' },\n    loader: () =>\n      import('./components/ApiDefinitionCard').then(m => (\n        <m.ApiDefinitionCard />\n      )),\n  },\n});\n\nconst apiDocsConsumedApisEntityCard = EntityCardBlueprint.make({\n  name: 'consumed-apis',\n  params: {\n    // Omitting configSchema for now\n    // We are skipping variants and columns are too complex to map to zod\n    // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252\n    filter: { kind: 'component' },\n    loader: () =>\n      import('./components/ApisCards').then(m => <m.ConsumedApisCard />),\n  },\n});\n\nconst apiDocsProvidedApisEntityCard = EntityCardBlueprint.make({\n  name: 'provided-apis',\n  params: {\n    // Omitting configSchema for now\n    // We are skipping variants and columns are too complex to map to zod\n    // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252\n    filter: { kind: 'component' },\n    loader: () =>\n      import('./components/ApisCards').then(m => <m.ProvidedApisCard />),\n  },\n});\n\nconst apiDocsConsumingComponentsEntityCard = EntityCardBlueprint.make({\n  name: 'consuming-components',\n  params: {\n    // Omitting configSchema for now\n    // We are skipping variants\n    // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252\n    filter: { kind: 'api' },\n    loader: () =>\n      import('./components/ComponentsCards').then(m => (\n        <m.ConsumingComponentsCard />\n      )),\n  },\n});\n\nconst apiDocsProvidingComponentsEntityCard = EntityCardBlueprint.make({\n  name: 'providing-components',\n  params: {\n    // Omitting configSchema for now\n    // We are skipping variants\n    // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252\n    filter: { kind: 'api' },\n    loader: () =>\n      import('./components/ComponentsCards').then(m => (\n        <m.ProvidingComponentsCard />\n      )),\n  },\n});\n\nconst apiDocsDefinitionEntityContent = EntityContentBlueprint.make({\n  name: 'definition',\n  params: {\n    path: '/definition',\n    title: 'Definition',\n    group: 'documentation',\n    filter: { kind: 'api' },\n    loader: async () =>\n      import('./components/ApiDefinitionCard').then(m => (\n        <Grid container spacing={3}>\n          <Grid item xs={12}>\n            <m.ApiDefinitionCard />\n          </Grid>\n        </Grid>\n      )),\n  },\n});\n\nconst apiDocsApisEntityContent = EntityContentBlueprint.make({\n  name: 'apis',\n  params: {\n    path: '/apis',\n    title: 'APIs',\n    group: 'development',\n    filter: { kind: 'component' },\n    loader: async () =>\n      import('./components/ApisCards').then(m => (\n        <Grid container spacing={3} alignItems=\"stretch\">\n          <Grid item xs={12}>\n            <m.ProvidedApisCard />\n          </Grid>\n          <Grid item xs={12}>\n            <m.ConsumedApisCard />\n          </Grid>\n        </Grid>\n      )),\n  },\n});\n\nexport default createFrontendPlugin({\n  pluginId: 'api-docs',\n  title: 'APIs',\n  icon: <AppIcon fontSize=\"inherit\" id=\"kind:api\" />,\n  info: { packageJson: () => import('../package.json') },\n  routes: {\n    root: rootRoute,\n  },\n  externalRoutes: {\n    registerApi: registerComponentRouteRef,\n  },\n  extensions: [\n    apiDocsConfigApi,\n    apiDocsExplorerPage,\n    apiDocsHasApisEntityCard,\n    apiDocsDefinitionEntityCard,\n    apiDocsProvidedApisEntityCard,\n    apiDocsConsumedApisEntityCard,\n    apiDocsConsumingComponentsEntityCard,\n    apiDocsProvidingComponentsEntityCard,\n    apiDocsDefinitionEntityContent,\n    apiDocsApisEntityContent,\n  ],\n});\n\nimport { apiDocsTranslationRef as _apiDocsTranslationRef } from './translation';\n\n/**\n * @alpha\n * @deprecated Import from `@backstage/plugin-api-docs` instead.\n */\nexport const apiDocsTranslationRef = _apiDocsTranslationRef;\n"],"names":["_apiDocsTranslationRef"],"mappings":";;;;;;;;;;;;;;;AAwCA,MAAM,gBAAA,GAAmB,aAAa,IAAA,CAAK;AAAA,EACzC,IAAA,EAAM,QAAA;AAAA,EACN,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,gBAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,SAAS,MAAM;AACb,MAAA,MAAM,oBAAoB,wBAAA,EAAyB;AACnD,MAAA,OAAO;AAAA,QACL,sBAAA,EAAwB,CAAC,SAAA,KAAyB;AAChD,UAAA,OAAO,kBAAkB,IAAA,CAAK,CAAA,CAAA,KAAK,EAAE,IAAA,KAAS,SAAA,CAAU,KAAK,IAAI,CAAA;AAAA,QACnE;AAAA,OACF;AAAA,IACF;AAAA,GACD;AACL,CAAC,CAAA;AAED,MAAM,mBAAA,GAAsB,cAAc,iBAAA,CAAkB;AAAA,EAC1D,MAAA,EAAQ;AAAA,IACN,MAAA,EAAQ;AAAA;AAAA,MAEN,uBAAA,EAAyB,CAAA,CAAA,KACvB,CAAA,CAAE,IAAA,CAAK,CAAC,SAAS,SAAA,EAAW,KAAK,CAAC,CAAA,CAAE,QAAA;AAAS;AACjD,GACF;AAAA,EACA,OAAA,CAAQ,eAAA,EAAiB,EAAE,MAAA,EAAO,EAAG;AACnC,IAAA,OAAO,eAAA,CAAgB;AAAA,MACrB,IAAA,EAAM,WAAA;AAAA,MACN,QAAA,EAAU,SAAA;AAAA,MACV,KAAA,EAAO,MAAA;AAAA,MACP,sBAAM,GAAA,CAAC,OAAA,EAAA,EAAQ,QAAA,EAAS,SAAA,EAAU,IAAG,UAAA,EAAW,CAAA;AAAA,MAChD,MAAA,EAAQ,MACN,OAAO,4DAAqD,CAAA,CAAE,IAAA;AAAA,QAC5D,CAAA,CAAA,qBACE,GAAA;AAAA,UAAC,CAAA,CAAE,kBAAA;AAAA,UAAF;AAAA,YACC,yBAAyB,MAAA,CAAO;AAAA;AAAA;AAClC;AAEJ,KACH,CAAA;AAAA,EACH;AACF,CAAC,CAAA;AAED,MAAM,wBAAA,GAA2B,oBAAoB,IAAA,CAAK;AAAA,EACxD,IAAA,EAAM,UAAA;AAAA,EACN,MAAA,EAAQ;AAAA;AAAA;AAAA;AAAA,IAIN,QAAQ,CAAA,MAAA,KAAU;AAChB,MAAA,OACE,MAAA,CAAO,IAAA,KAAS,WAAA,IAChB,MAAA,CAAO,SAAA,EAAW,IAAA;AAAA,QAChB,CAAC,EAAE,IAAA,EAAM,SAAA,EAAU,KACjB,IAAA,CAAK,iBAAA,CAAkB,OAAO,CAAA,KAAM,iBAAA,IACpC,cAAA,CAAe,SAAS,EAAE,IAAA,KAAS;AAAA,OACvC;AAAA,IAEJ,CAAA;AAAA,IACA,MAAA,EAAQ,MAAM,OAAO,qCAAwB,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAAK,GAAA,CAAC,CAAA,CAAE,WAAA,EAAF,EAAc,CAAE;AAAA;AAE9E,CAAC,CAAA;AAED,MAAM,2BAAA,GAA8B,oBAAoB,IAAA,CAAK;AAAA,EAC3D,IAAA,EAAM,YAAA;AAAA,EACN,MAAA,EAAQ;AAAA,IACN,MAAA,EAAQ,EAAE,IAAA,EAAM,KAAA,EAAM;AAAA,IACtB,MAAA,EAAQ,MACN,OAAO,6CAAgC,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAC5C,GAAA,CAAC,CAAA,CAAE,iBAAA,EAAF,EAAoB,CACtB;AAAA;AAEP,CAAC,CAAA;AAED,MAAM,6BAAA,GAAgC,oBAAoB,IAAA,CAAK;AAAA,EAC7D,IAAA,EAAM,eAAA;AAAA,EACN,MAAA,EAAQ;AAAA;AAAA;AAAA;AAAA,IAIN,MAAA,EAAQ,EAAE,IAAA,EAAM,WAAA,EAAY;AAAA,IAC5B,MAAA,EAAQ,MACN,OAAO,qCAAwB,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAAK,GAAA,CAAC,CAAA,CAAE,gBAAA,EAAF,EAAmB,CAAE;AAAA;AAEvE,CAAC,CAAA;AAED,MAAM,6BAAA,GAAgC,oBAAoB,IAAA,CAAK;AAAA,EAC7D,IAAA,EAAM,eAAA;AAAA,EACN,MAAA,EAAQ;AAAA;AAAA;AAAA;AAAA,IAIN,MAAA,EAAQ,EAAE,IAAA,EAAM,WAAA,EAAY;AAAA,IAC5B,MAAA,EAAQ,MACN,OAAO,qCAAwB,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAAK,GAAA,CAAC,CAAA,CAAE,gBAAA,EAAF,EAAmB,CAAE;AAAA;AAEvE,CAAC,CAAA;AAED,MAAM,oCAAA,GAAuC,oBAAoB,IAAA,CAAK;AAAA,EACpE,IAAA,EAAM,sBAAA;AAAA,EACN,MAAA,EAAQ;AAAA;AAAA;AAAA;AAAA,IAIN,MAAA,EAAQ,EAAE,IAAA,EAAM,KAAA,EAAM;AAAA,IACtB,MAAA,EAAQ,MACN,OAAO,2CAA8B,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAC1C,GAAA,CAAC,CAAA,CAAE,uBAAA,EAAF,EAA0B,CAC5B;AAAA;AAEP,CAAC,CAAA;AAED,MAAM,oCAAA,GAAuC,oBAAoB,IAAA,CAAK;AAAA,EACpE,IAAA,EAAM,sBAAA;AAAA,EACN,MAAA,EAAQ;AAAA;AAAA;AAAA;AAAA,IAIN,MAAA,EAAQ,EAAE,IAAA,EAAM,KAAA,EAAM;AAAA,IACtB,MAAA,EAAQ,MACN,OAAO,2CAA8B,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,qBAC1C,GAAA,CAAC,CAAA,CAAE,uBAAA,EAAF,EAA0B,CAC5B;AAAA;AAEP,CAAC,CAAA;AAED,MAAM,8BAAA,GAAiC,uBAAuB,IAAA,CAAK;AAAA,EACjE,IAAA,EAAM,YAAA;AAAA,EACN,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,aAAA;AAAA,IACN,KAAA,EAAO,YAAA;AAAA,IACP,KAAA,EAAO,eAAA;AAAA,IACP,MAAA,EAAQ,EAAE,IAAA,EAAM,KAAA,EAAM;AAAA,IACtB,MAAA,EAAQ,YACN,OAAO,6CAAgC,CAAA,CAAE,KAAK,CAAA,CAAA,qBAC5C,GAAA,CAAC,IAAA,EAAA,EAAK,SAAA,EAAS,IAAA,EAAC,OAAA,EAAS,GACvB,QAAA,kBAAA,GAAA,CAAC,IAAA,EAAA,EAAK,IAAA,EAAI,IAAA,EAAC,EAAA,EAAI,EAAA,EACb,QAAA,kBAAA,GAAA,CAAC,CAAA,CAAE,iBAAA,EAAF,EAAoB,CAAA,EACvB,CAAA,EACF,CACD;AAAA;AAEP,CAAC,CAAA;AAED,MAAM,wBAAA,GAA2B,uBAAuB,IAAA,CAAK;AAAA,EAC3D,IAAA,EAAM,MAAA;AAAA,EACN,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM,OAAA;AAAA,IACN,KAAA,EAAO,MAAA;AAAA,IACP,KAAA,EAAO,aAAA;AAAA,IACP,MAAA,EAAQ,EAAE,IAAA,EAAM,WAAA,EAAY;AAAA,IAC5B,MAAA,EAAQ,YACN,OAAO,qCAAwB,EAAE,IAAA,CAAK,CAAA,CAAA,qBACpC,IAAA,CAAC,IAAA,EAAA,EAAK,SAAA,EAAS,IAAA,EAAC,OAAA,EAAS,CAAA,EAAG,YAAW,SAAA,EACrC,QAAA,EAAA;AAAA,sBAAA,GAAA,CAAC,IAAA,EAAA,EAAK,MAAI,IAAA,EAAC,EAAA,EAAI,IACb,QAAA,kBAAA,GAAA,CAAC,CAAA,CAAE,gBAAA,EAAF,EAAmB,CAAA,EACtB,CAAA;AAAA,sBACA,GAAA,CAAC,IAAA,EAAA,EAAK,IAAA,EAAI,IAAA,EAAC,EAAA,EAAI,IACb,QAAA,kBAAA,GAAA,CAAC,CAAA,CAAE,gBAAA,EAAF,EAAmB,CAAA,EACtB;AAAA,KAAA,EACF,CACD;AAAA;AAEP,CAAC,CAAA;AAED,YAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,UAAA;AAAA,EACV,KAAA,EAAO,MAAA;AAAA,EACP,sBAAM,GAAA,CAAC,OAAA,EAAA,EAAQ,QAAA,EAAS,SAAA,EAAU,IAAG,UAAA,EAAW,CAAA;AAAA,EAChD,MAAM,EAAE,WAAA,EAAa,MAAM,OAAO,uBAAiB,CAAA,EAAE;AAAA,EACrD,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM;AAAA,GACR;AAAA,EACA,cAAA,EAAgB;AAAA,IACd,WAAA,EAAa;AAAA,GACf;AAAA,EACA,UAAA,EAAY;AAAA,IACV,gBAAA;AAAA,IACA,mBAAA;AAAA,IACA,wBAAA;AAAA,IACA,2BAAA;AAAA,IACA,6BAAA;AAAA,IACA,6BAAA;AAAA,IACA,oCAAA;AAAA,IACA,oCAAA;AAAA,IACA,8BAAA;AAAA,IACA;AAAA;AAEJ,CAAC,CAAA;AAQM,MAAM,qBAAA,GAAwBA;;;;"}

package/dist/package.json.esm.js

@@ -1,5 +1,5 @@
 var name = "@backstage/plugin-api-docs";
-var version = "0.14.1-next.1";
+var version = "0.14.2-next.0";
 var description = "A Backstage plugin that helps represent API entities in the frontend";
 var backstage = {
 	role: "frontend-plugin",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-api-docs",
-  "version": "0.14.1-next.1",
+  "version": "0.14.2-next.0",
   "description": "A Backstage plugin that helps represent API entities in the frontend",
   "backstage": {
     "role": "frontend-plugin",
@@ -66,15 +66,15 @@
   },
   "dependencies": {
     "@asyncapi/react-component": "^2.3.3",
-    "@backstage/catalog-model": "1.8.1-next.1",
-    "@backstage/core-components": "0.18.10-next.0",
-    "@backstage/core-plugin-api": "1.12.6-next.1",
-    "@backstage/frontend-plugin-api": "0.17.0-next.1",
-    "@backstage/plugin-catalog": "2.0.5-next.0",
-    "@backstage/plugin-catalog-common": "1.1.10-next.0",
-    "@backstage/plugin-catalog-react": "2.1.5-next.1",
-    "@backstage/plugin-permission-react": "0.5.1-next.0",
-    "@backstage/ui": "0.15.0-next.1",
+    "@backstage/catalog-model": "1.9.0",
+    "@backstage/core-components": "0.18.11-next.0",
+    "@backstage/core-plugin-api": "1.12.6",
+    "@backstage/frontend-plugin-api": "0.17.0",
+    "@backstage/plugin-catalog": "2.0.6-next.0",
+    "@backstage/plugin-catalog-common": "1.1.10",
+    "@backstage/plugin-catalog-react": "3.0.1-next.0",
+    "@backstage/plugin-permission-react": "0.5.1",
+    "@backstage/ui": "0.15.0",
     "@graphiql/react": "0.29.0",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
@@ -86,11 +86,11 @@
     "swagger-ui-react": "^5.27.1"
   },
   "devDependencies": {
-    "@backstage/cli": "0.36.2-next.1",
-    "@backstage/core-app-api": "1.20.1-next.0",
-    "@backstage/dev-utils": "1.1.23-next.0",
-    "@backstage/frontend-test-utils": "0.5.3-next.1",
-    "@backstage/test-utils": "1.7.18-next.0",
+    "@backstage/cli": "0.36.3-next.0",
+    "@backstage/core-app-api": "1.20.1",
+    "@backstage/dev-utils": "1.1.24-next.0",
+    "@backstage/frontend-test-utils": "0.6.1-next.0",
+    "@backstage/test-utils": "1.7.18",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",