@backstage/plugin-api-docs 0.10.4-next.1 → 0.11.0-next.3

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @backstage/plugin-api-docs
 
+## 0.11.0-next.3
+
+### Minor Changes
+
+- 172a717: Migrate the `api-docs` to the new frontend system. It is experimental and available via alpha subpath.
+
+### Patch Changes
+
+- 874e8cf: Updated README to list AsyncApi v3 as supported
+- Updated dependencies
+  - @backstage/plugin-catalog@1.17.0-next.3
+  - @backstage/core-components@0.14.0-next.2
+  - @backstage/plugin-catalog-react@1.10.0-next.3
+  - @backstage/catalog-model@1.4.4-next.0
+  - @backstage/core-compat-api@0.2.0-next.3
+  - @backstage/core-plugin-api@1.9.0-next.1
+  - @backstage/frontend-plugin-api@0.6.0-next.3
+  - @backstage/plugin-catalog-common@1.0.21-next.0
+  - @backstage/plugin-permission-react@0.4.20-next.1
+
+## 0.10.4-next.2
+
+### Patch Changes
+
+- 9aac2b0: Use `--cwd` as the first `yarn` argument
+- 8fe56a8: Widen `@types/react` dependency range to include version 18.
+- Updated dependencies
+  - @backstage/core-components@0.14.0-next.1
+  - @backstage/plugin-catalog@1.17.0-next.2
+  - @backstage/core-plugin-api@1.9.0-next.1
+  - @backstage/plugin-catalog-react@1.10.0-next.2
+  - @backstage/plugin-permission-react@0.4.20-next.1
+  - @backstage/catalog-model@1.4.4-next.0
+  - @backstage/plugin-catalog-common@1.0.21-next.0
+
 ## 0.10.4-next.1
 
 ### Patch Changes

package/README.md

@@ -1,5 +1,8 @@
 # API Documentation
 
+> Disclaimer:
+> If you are looking for documentation on the experimental new frontend system support, please go [here](./README-alpha.md).
+
 This is an extension for the catalog plugin that provides components to discover and display API entities.
 APIs define the interface between components, see the [system model](https://backstage.io/docs/features/software-catalog/system-model) for details.
 They are defined in machine readable formats and provide a human readable documentation.
@@ -13,7 +16,7 @@ The plugin provides a standalone list of APIs, as well as an integration into th
 Right now, the following API formats are supported:
 
 - [OpenAPI](https://swagger.io/specification/) 2 & 3
-- [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/latest)
+- [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/latest) 2 & 3
 - [GraphQL](https://graphql.org/learn/schema/)
 
 Other formats are displayed as plain text, but this can easily be extended.
@@ -29,7 +32,7 @@ To link that a component provides or consumes an API, see the [`providesApis`](h
 
 ```bash
 # From your Backstage root directory
-yarn add --cwd packages/app @backstage/plugin-api-docs
+yarn --cwd packages/app add @backstage/plugin-api-docs
 ```
 
 2. Add the `ApiExplorerPage` extension to the app:

package/alpha/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@backstage/plugin-api-docs",
+  "version": "0.11.0-next.3",
+  "main": "../dist/alpha.esm.js",
+  "module": "../dist/alpha.esm.js",
+  "types": "../dist/alpha.d.ts"
+}

package/dist/alpha.d.ts

@@ -0,0 +1,9 @@
+import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
+
+declare const _default: _backstage_frontend_plugin_api.BackstagePlugin<{
+    root: _backstage_frontend_plugin_api.RouteRef<undefined>;
+}, {
+    registerApi: _backstage_frontend_plugin_api.ExternalRouteRef<undefined, true>;
+}>;
+
+export { _default as default };

package/dist/alpha.esm.js

@@ -0,0 +1,169 @@
+import React from 'react';
+import { Grid } from '@material-ui/core';
+import { createNavItemExtension, createApiExtension, createApiFactory, createPageExtension, createSchemaFromZod, createPlugin } from '@backstage/frontend-plugin-api';
+import { convertLegacyRouteRef, compatWrapper } from '@backstage/core-compat-api';
+import { useApp } from '@backstage/core-plugin-api';
+import { createEntityCardExtension, createEntityContentExtension } from '@backstage/plugin-catalog-react/alpha';
+import { RELATION_HAS_PART, parseEntityRef } from '@backstage/catalog-model';
+import '@backstage/plugin-catalog-react';
+import '@material-ui/lab';
+import { r as rootRoute, a as apiDocsConfigRef, b as registerComponentRouteRef, d as defaultDefinitionWidgets } from './esm/ApiDefinitionWidget-798ee85f.esm.js';
+import '@backstage/core-components';
+import '@material-ui/core/Typography';
+import '@material-ui/core/styles';
+
+function ApiIcon() {
+  const app = useApp();
+  const KindApiSystemIcon = app.getSystemIcon("kind:api");
+  return /* @__PURE__ */ React.createElement(KindApiSystemIcon, null);
+}
+const apiDocsNavItem = createNavItemExtension({
+  title: "APIs",
+  routeRef: convertLegacyRouteRef(rootRoute),
+  icon: () => compatWrapper(/* @__PURE__ */ React.createElement(ApiIcon, null))
+});
+const apiDocsConfigApi = createApiExtension({
+  factory: createApiFactory({
+    api: apiDocsConfigRef,
+    deps: {},
+    factory: () => {
+      const definitionWidgets = defaultDefinitionWidgets();
+      return {
+        getApiDefinitionWidget: (apiEntity) => {
+          return definitionWidgets.find((d) => d.type === apiEntity.spec.type);
+        }
+      };
+    }
+  })
+});
+const apiDocsExplorerPage = createPageExtension({
+  defaultPath: "/api-docs",
+  routeRef: convertLegacyRouteRef(rootRoute),
+  // Mapping DefaultApiExplorerPageProps to config
+  configSchema: createSchemaFromZod(
+    (z) => z.object({
+      path: z.string().default("/api-docs"),
+      initiallySelectedFilter: z.enum(["owned", "starred", "all"]).optional()
+      // Ommiting columns and actions for now as their types are too complex to map to zod
+    })
+  ),
+  loader: ({ config }) => import('./esm/index-435dfc01.esm.js').then(
+    (m) => compatWrapper(
+      /* @__PURE__ */ React.createElement(
+        m.ApiExplorerIndexPage,
+        {
+          initiallySelectedFilter: config.initiallySelectedFilter
+        }
+      )
+    )
+  )
+});
+const apiDocsHasApisEntityCard = createEntityCardExtension({
+  name: "has-apis",
+  // Ommiting configSchema for now
+  // We are skipping variants and columns are too complex to map to zod
+  // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252
+  filter: (entity) => {
+    var _a;
+    return entity.kind === "Component" && ((_a = entity.relations) == null ? void 0 : _a.some(
+      ({ type, targetRef }) => type.toLocaleLowerCase("en-US") === RELATION_HAS_PART && parseEntityRef(targetRef).kind === "API"
+    ));
+  },
+  loader: () => import('./esm/index-5f0727eb.esm.js').then(
+    (m) => compatWrapper(/* @__PURE__ */ React.createElement(m.HasApisCard, null))
+  )
+});
+const apiDocsDefinitionEntityCard = createEntityCardExtension({
+  name: "definition",
+  filter: "kind:api",
+  loader: () => import('./esm/index-6f21bd2e.esm.js').then(
+    (m) => compatWrapper(/* @__PURE__ */ React.createElement(m.ApiDefinitionCard, null))
+  )
+});
+const apiDocsConsumedApisEntityCard = createEntityCardExtension({
+  name: "consumed-apis",
+  // Ommiting configSchema for now
+  // We are skipping variants and columns are too complex to map to zod
+  // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252
+  filter: "kind:component",
+  loader: () => import('./esm/index-5f0727eb.esm.js').then(
+    (m) => compatWrapper(/* @__PURE__ */ React.createElement(m.ConsumedApisCard, null))
+  )
+});
+const apiDocsProvidedApisEntityCard = createEntityCardExtension({
+  name: "provided-apis",
+  // Ommiting configSchema for now
+  // We are skipping variants and columns are too complex to map to zod
+  // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252
+  filter: "kind:component",
+  loader: () => import('./esm/index-5f0727eb.esm.js').then(
+    (m) => compatWrapper(/* @__PURE__ */ React.createElement(m.ProvidedApisCard, null))
+  )
+});
+const apiDocsConsumingComponentsEntityCard = createEntityCardExtension({
+  name: "consuming-components",
+  // Ommiting configSchema for now
+  // We are skipping variants
+  // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252
+  filter: "kind:api",
+  loader: () => import('./esm/index-c969ed3d.esm.js').then(
+    (m) => compatWrapper(/* @__PURE__ */ React.createElement(m.ConsumingComponentsCard, null))
+  )
+});
+const apiDocsProvidingComponentsEntityCard = createEntityCardExtension({
+  name: "providing-components",
+  // Ommiting configSchema for now
+  // We are skipping variants
+  // See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252
+  filter: "kind:api",
+  loader: () => import('./esm/index-c969ed3d.esm.js').then(
+    (m) => compatWrapper(/* @__PURE__ */ React.createElement(m.ProvidingComponentsCard, null))
+  )
+});
+const apiDocsDefinitionEntityContent = createEntityContentExtension({
+  name: "definition",
+  defaultPath: "/defintion",
+  defaultTitle: "Definition",
+  filter: "kind:api",
+  loader: async () => import('./esm/index-6f21bd2e.esm.js').then(
+    (m) => compatWrapper(
+      /* @__PURE__ */ React.createElement(Grid, { container: true, spacing: 3 }, /* @__PURE__ */ React.createElement(Grid, { item: true, xs: 12 }, /* @__PURE__ */ React.createElement(m.ApiDefinitionCard, null)))
+    )
+  )
+});
+const apiDocsApisEntityContent = createEntityContentExtension({
+  name: "apis",
+  defaultPath: "/apis",
+  defaultTitle: "APIs",
+  filter: "kind:component",
+  loader: async () => import('./esm/index-5f0727eb.esm.js').then(
+    (m) => compatWrapper(
+      /* @__PURE__ */ React.createElement(Grid, { container: true, spacing: 3, alignItems: "stretch" }, /* @__PURE__ */ React.createElement(Grid, { item: true, xs: 12 }, /* @__PURE__ */ React.createElement(m.ProvidedApisCard, null)), /* @__PURE__ */ React.createElement(Grid, { item: true, xs: 12 }, /* @__PURE__ */ React.createElement(m.ConsumedApisCard, null)))
+    )
+  )
+});
+var alpha = createPlugin({
+  id: "api-docs",
+  routes: {
+    root: convertLegacyRouteRef(rootRoute)
+  },
+  externalRoutes: {
+    registerApi: convertLegacyRouteRef(registerComponentRouteRef)
+  },
+  extensions: [
+    apiDocsNavItem,
+    apiDocsConfigApi,
+    apiDocsExplorerPage,
+    apiDocsHasApisEntityCard,
+    apiDocsDefinitionEntityCard,
+    apiDocsProvidedApisEntityCard,
+    apiDocsConsumedApisEntityCard,
+    apiDocsConsumingComponentsEntityCard,
+    apiDocsProvidingComponentsEntityCard,
+    apiDocsDefinitionEntityContent,
+    apiDocsApisEntityContent
+  ]
+});
+
+export { alpha as default };
+//# sourceMappingURL=alpha.esm.js.map

package/dist/alpha.esm.js.map

@@ -0,0 +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 React from 'react';\nimport { Grid } from '@material-ui/core';\n\nimport {\n  createApiExtension,\n  createApiFactory,\n  createNavItemExtension,\n  createPageExtension,\n  createPlugin,\n  createSchemaFromZod,\n} from '@backstage/frontend-plugin-api';\n\nimport {\n  compatWrapper,\n  convertLegacyRouteRef,\n} from '@backstage/core-compat-api';\nimport { useApp } from '@backstage/core-plugin-api';\n\nimport {\n  createEntityCardExtension,\n  createEntityContentExtension,\n} from '@backstage/plugin-catalog-react/alpha';\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';\n\nfunction ApiIcon() {\n  const app = useApp();\n  const KindApiSystemIcon = app.getSystemIcon('kind:api')!;\n  return <KindApiSystemIcon />;\n}\n\nconst apiDocsNavItem = createNavItemExtension({\n  title: 'APIs',\n  routeRef: convertLegacyRouteRef(rootRoute),\n  icon: () => compatWrapper(<ApiIcon />),\n});\n\nconst apiDocsConfigApi = createApiExtension({\n  factory: createApiFactory({\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 = createPageExtension({\n  defaultPath: '/api-docs',\n  routeRef: convertLegacyRouteRef(rootRoute),\n  // Mapping DefaultApiExplorerPageProps to config\n  configSchema: createSchemaFromZod(z =>\n    z.object({\n      path: z.string().default('/api-docs'),\n      initiallySelectedFilter: z.enum(['owned', 'starred', 'all']).optional(),\n      // Ommiting columns and actions for now as their types are too complex to map to zod\n    }),\n  ),\n  loader: ({ config }) =>\n    import('./components/ApiExplorerPage').then(m =>\n      compatWrapper(\n        <m.ApiExplorerIndexPage\n          initiallySelectedFilter={config.initiallySelectedFilter}\n        />,\n      ),\n    ),\n});\n\nconst apiDocsHasApisEntityCard = createEntityCardExtension({\n  name: 'has-apis',\n  // Ommiting 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: () =>\n    import('./components/ApisCards').then(m =>\n      compatWrapper(<m.HasApisCard />),\n    ),\n});\n\nconst apiDocsDefinitionEntityCard = createEntityCardExtension({\n  name: 'definition',\n  filter: 'kind:api',\n  loader: () =>\n    import('./components/ApiDefinitionCard').then(m =>\n      compatWrapper(<m.ApiDefinitionCard />),\n    ),\n});\n\nconst apiDocsConsumedApisEntityCard = createEntityCardExtension({\n  name: 'consumed-apis',\n  // Ommiting 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 =>\n      compatWrapper(<m.ConsumedApisCard />),\n    ),\n});\n\nconst apiDocsProvidedApisEntityCard = createEntityCardExtension({\n  name: 'provided-apis',\n  // Ommiting 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 =>\n      compatWrapper(<m.ProvidedApisCard />),\n    ),\n});\n\nconst apiDocsConsumingComponentsEntityCard = createEntityCardExtension({\n  name: 'consuming-components',\n  // Ommiting 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      compatWrapper(<m.ConsumingComponentsCard />),\n    ),\n});\n\nconst apiDocsProvidingComponentsEntityCard = createEntityCardExtension({\n  name: 'providing-components',\n  // Ommiting 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      compatWrapper(<m.ProvidingComponentsCard />),\n    ),\n});\n\nconst apiDocsDefinitionEntityContent = createEntityContentExtension({\n  name: 'definition',\n  defaultPath: '/defintion',\n  defaultTitle: 'Definition',\n  filter: 'kind:api',\n  loader: async () =>\n    import('./components/ApiDefinitionCard').then(m =>\n      compatWrapper(\n        <Grid container spacing={3}>\n          <Grid item xs={12}>\n            <m.ApiDefinitionCard />\n          </Grid>\n        </Grid>,\n      ),\n    ),\n});\n\nconst apiDocsApisEntityContent = createEntityContentExtension({\n  name: 'apis',\n  defaultPath: '/apis',\n  defaultTitle: 'APIs',\n  filter: 'kind:component',\n  loader: async () =>\n    import('./components/ApisCards').then(m =>\n      compatWrapper(\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 createPlugin({\n  id: 'api-docs',\n  routes: {\n    root: convertLegacyRouteRef(rootRoute),\n  },\n  externalRoutes: {\n    registerApi: convertLegacyRouteRef(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"],"names":[],"mappings":";;;;;;;;;;;;;;AAgDA,SAAS,OAAU,GAAA;AACjB,EAAA,MAAM,MAAM,MAAO,EAAA,CAAA;AACnB,EAAM,MAAA,iBAAA,GAAoB,GAAI,CAAA,aAAA,CAAc,UAAU,CAAA,CAAA;AACtD,EAAA,2CAAQ,iBAAkB,EAAA,IAAA,CAAA,CAAA;AAC5B,CAAA;AAEA,MAAM,iBAAiB,sBAAuB,CAAA;AAAA,EAC5C,KAAO,EAAA,MAAA;AAAA,EACP,QAAA,EAAU,sBAAsB,SAAS,CAAA;AAAA,EACzC,IAAM,EAAA,MAAM,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,aAAQ,CAAE,CAAA;AACvC,CAAC,CAAA,CAAA;AAED,MAAM,mBAAmB,kBAAmB,CAAA;AAAA,EAC1C,SAAS,gBAAiB,CAAA;AAAA,IACxB,GAAK,EAAA,gBAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,SAAS,MAAM;AACb,MAAA,MAAM,oBAAoB,wBAAyB,EAAA,CAAA;AACnD,MAAO,OAAA;AAAA,QACL,sBAAA,EAAwB,CAAC,SAAyB,KAAA;AAChD,UAAA,OAAO,kBAAkB,IAAK,CAAA,CAAA,CAAA,KAAK,EAAE,IAAS,KAAA,SAAA,CAAU,KAAK,IAAI,CAAA,CAAA;AAAA,SACnE;AAAA,OACF,CAAA;AAAA,KACF;AAAA,GACD,CAAA;AACH,CAAC,CAAA,CAAA;AAED,MAAM,sBAAsB,mBAAoB,CAAA;AAAA,EAC9C,WAAa,EAAA,WAAA;AAAA,EACb,QAAA,EAAU,sBAAsB,SAAS,CAAA;AAAA;AAAA,EAEzC,YAAc,EAAA,mBAAA;AAAA,IAAoB,CAAA,CAAA,KAChC,EAAE,MAAO,CAAA;AAAA,MACP,IAAM,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,WAAW,CAAA;AAAA,MACpC,uBAAA,EAAyB,EAAE,IAAK,CAAA,CAAC,SAAS,SAAW,EAAA,KAAK,CAAC,CAAA,CAAE,QAAS,EAAA;AAAA;AAAA,KAEvE,CAAA;AAAA,GACH;AAAA,EACA,QAAQ,CAAC,EAAE,QACT,KAAA,OAAO,6BAA8B,CAAE,CAAA,IAAA;AAAA,IAAK,CAC1C,CAAA,KAAA,aAAA;AAAA,sBACE,KAAA,CAAA,aAAA;AAAA,QAAC,CAAE,CAAA,oBAAA;AAAA,QAAF;AAAA,UACC,yBAAyB,MAAO,CAAA,uBAAA;AAAA,SAAA;AAAA,OAClC;AAAA,KACF;AAAA,GACF;AACJ,CAAC,CAAA,CAAA;AAED,MAAM,2BAA2B,yBAA0B,CAAA;AAAA,EACzD,IAAM,EAAA,UAAA;AAAA;AAAA;AAAA;AAAA,EAIN,QAAQ,CAAU,MAAA,KAAA;AArGpB,IAAA,IAAA,EAAA,CAAA;AAsGI,IAAA,OACE,MAAO,CAAA,IAAA,KAAS,WAChB,KAAA,CAAA,EAAA,GAAA,MAAA,CAAO,cAAP,IAAkB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA;AAAA,MAChB,CAAC,EAAE,IAAM,EAAA,SAAA,EACP,KAAA,IAAA,CAAK,iBAAkB,CAAA,OAAO,CAAM,KAAA,iBAAA,IACpC,cAAe,CAAA,SAAS,EAAE,IAAS,KAAA,KAAA;AAAA,KAAA,CAAA,CAAA;AAAA,GAG3C;AAAA,EACA,MAAQ,EAAA,MACN,OAAO,6BAAwB,CAAE,CAAA,IAAA;AAAA,IAAK,OACpC,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,WAAA,EAAF,IAAc,CAAE,CAAA;AAAA,GACjC;AACJ,CAAC,CAAA,CAAA;AAED,MAAM,8BAA8B,yBAA0B,CAAA;AAAA,EAC5D,IAAM,EAAA,YAAA;AAAA,EACN,MAAQ,EAAA,UAAA;AAAA,EACR,MAAQ,EAAA,MACN,OAAO,6BAAgC,CAAE,CAAA,IAAA;AAAA,IAAK,OAC5C,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,iBAAA,EAAF,IAAoB,CAAE,CAAA;AAAA,GACvC;AACJ,CAAC,CAAA,CAAA;AAED,MAAM,gCAAgC,yBAA0B,CAAA;AAAA,EAC9D,IAAM,EAAA,eAAA;AAAA;AAAA;AAAA;AAAA,EAIN,MAAQ,EAAA,gBAAA;AAAA,EACR,MAAQ,EAAA,MACN,OAAO,6BAAwB,CAAE,CAAA,IAAA;AAAA,IAAK,OACpC,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,gBAAA,EAAF,IAAmB,CAAE,CAAA;AAAA,GACtC;AACJ,CAAC,CAAA,CAAA;AAED,MAAM,gCAAgC,yBAA0B,CAAA;AAAA,EAC9D,IAAM,EAAA,eAAA;AAAA;AAAA;AAAA;AAAA,EAIN,MAAQ,EAAA,gBAAA;AAAA,EACR,MAAQ,EAAA,MACN,OAAO,6BAAwB,CAAE,CAAA,IAAA;AAAA,IAAK,OACpC,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,gBAAA,EAAF,IAAmB,CAAE,CAAA;AAAA,GACtC;AACJ,CAAC,CAAA,CAAA;AAED,MAAM,uCAAuC,yBAA0B,CAAA;AAAA,EACrE,IAAM,EAAA,sBAAA;AAAA;AAAA;AAAA;AAAA,EAIN,MAAQ,EAAA,UAAA;AAAA,EACR,MAAQ,EAAA,MACN,OAAO,6BAA8B,CAAE,CAAA,IAAA;AAAA,IAAK,OAC1C,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,uBAAA,EAAF,IAA0B,CAAE,CAAA;AAAA,GAC7C;AACJ,CAAC,CAAA,CAAA;AAED,MAAM,uCAAuC,yBAA0B,CAAA;AAAA,EACrE,IAAM,EAAA,sBAAA;AAAA;AAAA;AAAA;AAAA,EAIN,MAAQ,EAAA,UAAA;AAAA,EACR,MAAQ,EAAA,MACN,OAAO,6BAA8B,CAAE,CAAA,IAAA;AAAA,IAAK,OAC1C,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,uBAAA,EAAF,IAA0B,CAAE,CAAA;AAAA,GAC7C;AACJ,CAAC,CAAA,CAAA;AAED,MAAM,iCAAiC,4BAA6B,CAAA;AAAA,EAClE,IAAM,EAAA,YAAA;AAAA,EACN,WAAa,EAAA,YAAA;AAAA,EACb,YAAc,EAAA,YAAA;AAAA,EACd,MAAQ,EAAA,UAAA;AAAA,EACR,MAAQ,EAAA,YACN,OAAO,6BAAgC,CAAE,CAAA,IAAA;AAAA,IAAK,CAC5C,CAAA,KAAA,aAAA;AAAA,0CACG,IAAK,EAAA,EAAA,SAAA,EAAS,IAAC,EAAA,OAAA,EAAS,qBACtB,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,IAAI,EAAA,IAAA,EAAC,IAAI,EACb,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,EAAE,iBAAF,EAAA,IAAoB,CACvB,CACF,CAAA;AAAA,KACF;AAAA,GACF;AACJ,CAAC,CAAA,CAAA;AAED,MAAM,2BAA2B,4BAA6B,CAAA;AAAA,EAC5D,IAAM,EAAA,MAAA;AAAA,EACN,WAAa,EAAA,OAAA;AAAA,EACb,YAAc,EAAA,MAAA;AAAA,EACd,MAAQ,EAAA,gBAAA;AAAA,EACR,MAAQ,EAAA,YACN,OAAO,6BAAwB,CAAE,CAAA,IAAA;AAAA,IAAK,CACpC,CAAA,KAAA,aAAA;AAAA,sBACG,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,SAAS,EAAA,IAAA,EAAC,OAAS,EAAA,CAAA,EAAG,UAAW,EAAA,SAAA,EAAA,kBACpC,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,IAAI,EAAA,IAAA,EAAC,IAAI,EACb,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,gBAAA,EAAF,IAAmB,CACtB,CACA,kBAAA,KAAA,CAAA,aAAA,CAAC,QAAK,IAAI,EAAA,IAAA,EAAC,EAAI,EAAA,EAAA,EAAA,kBACZ,KAAA,CAAA,aAAA,CAAA,CAAA,CAAE,gBAAF,EAAA,IAAmB,CACtB,CACF,CAAA;AAAA,KACF;AAAA,GACF;AACJ,CAAC,CAAA,CAAA;AAED,YAAe,YAAa,CAAA;AAAA,EAC1B,EAAI,EAAA,UAAA;AAAA,EACJ,MAAQ,EAAA;AAAA,IACN,IAAA,EAAM,sBAAsB,SAAS,CAAA;AAAA,GACvC;AAAA,EACA,cAAgB,EAAA;AAAA,IACd,WAAA,EAAa,sBAAsB,yBAAyB,CAAA;AAAA,GAC9D;AAAA,EACA,UAAY,EAAA;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,wBAAA;AAAA,GACF;AACF,CAAC,CAAA;;;;"}

package/dist/esm/ApiDefinitionCard-504c2432.esm.js

@@ -0,0 +1,47 @@
+import { useEntity } from '@backstage/plugin-catalog-react';
+import { Alert } from '@material-ui/lab';
+import React from 'react';
+import { a as apiDocsConfigRef } from './ApiDefinitionWidget-798ee85f.esm.js';
+import { P as PlainApiDefinitionWidget } from './ApiTypeTitle-cc79a2f3.esm.js';
+import { TabbedCard, CardTab } from '@backstage/core-components';
+import { useApi } from '@backstage/core-plugin-api';
+
+const ApiDefinitionCard = () => {
+  var _a;
+  const { entity } = useEntity();
+  const config = useApi(apiDocsConfigRef);
+  const { getApiDefinitionWidget } = config;
+  if (!entity) {
+    return /* @__PURE__ */ React.createElement(Alert, { severity: "error" }, "Could not fetch the API");
+  }
+  const definitionWidget = getApiDefinitionWidget(entity);
+  const entityTitle = (_a = entity.metadata.title) != null ? _a : entity.metadata.name;
+  if (definitionWidget) {
+    return /* @__PURE__ */ React.createElement(TabbedCard, { title: entityTitle }, /* @__PURE__ */ React.createElement(CardTab, { label: definitionWidget.title, key: "widget" }, definitionWidget.component(entity.spec.definition)), /* @__PURE__ */ React.createElement(CardTab, { label: "Raw", key: "raw" }, /* @__PURE__ */ React.createElement(
+      PlainApiDefinitionWidget,
+      {
+        definition: entity.spec.definition,
+        language: definitionWidget.rawLanguage || entity.spec.type
+      }
+    )));
+  }
+  return /* @__PURE__ */ React.createElement(
+    TabbedCard,
+    {
+      title: entityTitle,
+      children: [
+        // Has to be an array, otherwise typescript doesn't like that this has only a single child
+        /* @__PURE__ */ React.createElement(CardTab, { label: entity.spec.type, key: "raw" }, /* @__PURE__ */ React.createElement(
+          PlainApiDefinitionWidget,
+          {
+            definition: entity.spec.definition,
+            language: entity.spec.type
+          }
+        ))
+      ]
+    }
+  );
+};
+
+export { ApiDefinitionCard as A };
+//# sourceMappingURL=ApiDefinitionCard-504c2432.esm.js.map

package/dist/esm/ApiDefinitionCard-504c2432.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiDefinitionCard-504c2432.esm.js","sources":["../../src/components/ApiDefinitionCard/ApiDefinitionCard.tsx"],"sourcesContent":["/*\n * Copyright 2020 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 { ApiEntity } from '@backstage/catalog-model';\nimport { useEntity } from '@backstage/plugin-catalog-react';\nimport { Alert } from '@material-ui/lab';\nimport React from 'react';\nimport { apiDocsConfigRef } from '../../config';\nimport { PlainApiDefinitionWidget } from '../PlainApiDefinitionWidget';\n\nimport { CardTab, TabbedCard } from '@backstage/core-components';\nimport { useApi } from '@backstage/core-plugin-api';\n\n/** @public */\nexport const ApiDefinitionCard = () => {\n  const { entity } = useEntity<ApiEntity>();\n  const config = useApi(apiDocsConfigRef);\n  const { getApiDefinitionWidget } = config;\n\n  if (!entity) {\n    return <Alert severity=\"error\">Could not fetch the API</Alert>;\n  }\n\n  const definitionWidget = getApiDefinitionWidget(entity);\n  const entityTitle = entity.metadata.title ?? entity.metadata.name;\n\n  if (definitionWidget) {\n    return (\n      <TabbedCard title={entityTitle}>\n        <CardTab label={definitionWidget.title} key=\"widget\">\n          {definitionWidget.component(entity.spec.definition)}\n        </CardTab>\n        <CardTab label=\"Raw\" key=\"raw\">\n          <PlainApiDefinitionWidget\n            definition={entity.spec.definition}\n            language={definitionWidget.rawLanguage || entity.spec.type}\n          />\n        </CardTab>\n      </TabbedCard>\n    );\n  }\n\n  return (\n    <TabbedCard\n      title={entityTitle}\n      children={[\n        // Has to be an array, otherwise typescript doesn't like that this has only a single child\n        <CardTab label={entity.spec.type} key=\"raw\">\n          <PlainApiDefinitionWidget\n            definition={entity.spec.definition}\n            language={entity.spec.type}\n          />\n        </CardTab>,\n      ]}\n    />\n  );\n};\n"],"names":[],"mappings":";;;;;;;;AA2BO,MAAM,oBAAoB,MAAM;AA3BvC,EAAA,IAAA,EAAA,CAAA;AA4BE,EAAM,MAAA,EAAE,MAAO,EAAA,GAAI,SAAqB,EAAA,CAAA;AACxC,EAAM,MAAA,MAAA,GAAS,OAAO,gBAAgB,CAAA,CAAA;AACtC,EAAM,MAAA,EAAE,wBAA2B,GAAA,MAAA,CAAA;AAEnC,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAA,uBAAQ,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA,EAAM,QAAS,EAAA,OAAA,EAAA,EAAQ,yBAAuB,CAAA,CAAA;AAAA,GACxD;AAEA,EAAM,MAAA,gBAAA,GAAmB,uBAAuB,MAAM,CAAA,CAAA;AACtD,EAAA,MAAM,eAAc,EAAO,GAAA,MAAA,CAAA,QAAA,CAAS,KAAhB,KAAA,IAAA,GAAA,EAAA,GAAyB,OAAO,QAAS,CAAA,IAAA,CAAA;AAE7D,EAAA,IAAI,gBAAkB,EAAA;AACpB,IACE,uBAAA,KAAA,CAAA,aAAA,CAAC,cAAW,KAAO,EAAA,WAAA,EAAA,sCAChB,OAAQ,EAAA,EAAA,KAAA,EAAO,gBAAiB,CAAA,KAAA,EAAO,GAAI,EAAA,QAAA,EAAA,EACzC,iBAAiB,SAAU,CAAA,MAAA,CAAO,IAAK,CAAA,UAAU,CACpD,CAAA,sCACC,OAAQ,EAAA,EAAA,KAAA,EAAM,KAAM,EAAA,GAAA,EAAI,KACvB,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,wBAAA;AAAA,MAAA;AAAA,QACC,UAAA,EAAY,OAAO,IAAK,CAAA,UAAA;AAAA,QACxB,QAAU,EAAA,gBAAA,CAAiB,WAAe,IAAA,MAAA,CAAO,IAAK,CAAA,IAAA;AAAA,OAAA;AAAA,KAE1D,CACF,CAAA,CAAA;AAAA,GAEJ;AAEA,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,UAAA;AAAA,IAAA;AAAA,MACC,KAAO,EAAA,WAAA;AAAA,MACP,QAAU,EAAA;AAAA;AAAA,4CAEP,OAAQ,EAAA,EAAA,KAAA,EAAO,OAAO,IAAK,CAAA,IAAA,EAAM,KAAI,KACpC,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,UAAC,wBAAA;AAAA,UAAA;AAAA,YACC,UAAA,EAAY,OAAO,IAAK,CAAA,UAAA;AAAA,YACxB,QAAA,EAAU,OAAO,IAAK,CAAA,IAAA;AAAA,WAAA;AAAA,SAE1B,CAAA;AAAA,OACF;AAAA,KAAA;AAAA,GACF,CAAA;AAEJ;;;;"}

package/dist/esm/ApiDefinitionWidget-798ee85f.esm.js

@@ -0,0 +1,116 @@
+import { createRouteRef, createExternalRouteRef, createApiRef } from '@backstage/core-plugin-api';
+import React, { Suspense } from 'react';
+import { Progress, CodeSnippet } from '@backstage/core-components';
+import { useTheme } from '@material-ui/core/styles';
+
+const rootRoute = createRouteRef({
+  id: "api-docs"
+});
+const registerComponentRouteRef = createExternalRouteRef({
+  id: "register-component",
+  optional: true
+});
+
+const apiDocsConfigRef = createApiRef({
+  id: "plugin.api-docs.config"
+});
+
+const LazyAsyncApiDefinition = React.lazy(
+  () => import('./AsyncApiDefinition-ffed9c50.esm.js').then((m) => ({
+    default: m.AsyncApiDefinition
+  }))
+);
+const AsyncApiDefinitionWidget = (props) => {
+  return /* @__PURE__ */ React.createElement(Suspense, { fallback: /* @__PURE__ */ React.createElement(Progress, null) }, /* @__PURE__ */ React.createElement(LazyAsyncApiDefinition, { ...props }));
+};
+
+const LazyGraphQlDefinition = React.lazy(
+  () => import('./GraphQlDefinition-49cc2c3b.esm.js').then((m) => ({
+    default: m.GraphQlDefinition
+  }))
+);
+const GraphQlDefinitionWidget = (props) => {
+  return /* @__PURE__ */ React.createElement(Suspense, { fallback: /* @__PURE__ */ React.createElement(Progress, null) }, /* @__PURE__ */ React.createElement(LazyGraphQlDefinition, { ...props }));
+};
+
+const LazyOpenApiDefinition = React.lazy(
+  () => import('./OpenApiDefinition-20ae2e8c.esm.js').then((m) => ({
+    default: m.OpenApiDefinition
+  }))
+);
+const OpenApiDefinitionWidget = (props) => {
+  var _a;
+  const validSubmitMethods = (_a = props.supportedSubmitMethods) == null ? void 0 : _a.map(
+    (method) => method.toLocaleLowerCase()
+  );
+  return /* @__PURE__ */ React.createElement(Suspense, { fallback: /* @__PURE__ */ React.createElement(Progress, null) }, /* @__PURE__ */ React.createElement(
+    LazyOpenApiDefinition,
+    {
+      ...props,
+      supportedSubmitMethods: validSubmitMethods
+    }
+  ));
+};
+
+const GrpcApiDefinitionWidget = (props) => {
+  const theme = useTheme();
+  return /* @__PURE__ */ React.createElement(
+    CodeSnippet,
+    {
+      customStyle: { backgroundColor: theme.palette.background.default },
+      text: props.definition,
+      language: "protobuf",
+      showCopyCodeButton: true
+    }
+  );
+};
+
+const TrpcApiDefinitionWidget = (props) => {
+  const { definition } = props;
+  const theme = useTheme();
+  return /* @__PURE__ */ React.createElement(
+    CodeSnippet,
+    {
+      customStyle: { backgroundColor: theme.palette.background.default },
+      text: definition,
+      language: "typescript",
+      showCopyCodeButton: true
+    }
+  );
+};
+
+function defaultDefinitionWidgets() {
+  return [
+    {
+      type: "openapi",
+      title: "OpenAPI",
+      rawLanguage: "yaml",
+      component: (definition) => /* @__PURE__ */ React.createElement(OpenApiDefinitionWidget, { definition })
+    },
+    {
+      type: "asyncapi",
+      title: "AsyncAPI",
+      rawLanguage: "yaml",
+      component: (definition) => /* @__PURE__ */ React.createElement(AsyncApiDefinitionWidget, { definition })
+    },
+    {
+      type: "graphql",
+      title: "GraphQL",
+      rawLanguage: "graphql",
+      component: (definition) => /* @__PURE__ */ React.createElement(GraphQlDefinitionWidget, { definition })
+    },
+    {
+      type: "grpc",
+      title: "gRPC",
+      component: (definition) => /* @__PURE__ */ React.createElement(GrpcApiDefinitionWidget, { definition })
+    },
+    {
+      type: "trpc",
+      title: "tRPC",
+      component: (definition) => /* @__PURE__ */ React.createElement(TrpcApiDefinitionWidget, { definition })
+    }
+  ];
+}
+
+export { AsyncApiDefinitionWidget as A, GraphQlDefinitionWidget as G, OpenApiDefinitionWidget as O, TrpcApiDefinitionWidget as T, apiDocsConfigRef as a, registerComponentRouteRef as b, defaultDefinitionWidgets as d, rootRoute as r };
+//# sourceMappingURL=ApiDefinitionWidget-798ee85f.esm.js.map

package/dist/esm/ApiDefinitionWidget-798ee85f.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiDefinitionWidget-798ee85f.esm.js","sources":["../../src/routes.ts","../../src/config.ts","../../src/components/AsyncApiDefinitionWidget/AsyncApiDefinitionWidget.tsx","../../src/components/GraphQlDefinitionWidget/GraphQlDefinitionWidget.tsx","../../src/components/OpenApiDefinitionWidget/OpenApiDefinitionWidget.tsx","../../src/components/GrpcApiDefinitionWidget/GrpcApiDefinitionWidget.tsx","../../src/components/TrpcDefinitionWidget/TrpcApiDefinitionWidget.tsx","../../src/components/ApiDefinitionCard/ApiDefinitionWidget.tsx"],"sourcesContent":["/*\n * Copyright 2020 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  createExternalRouteRef,\n  createRouteRef,\n} from '@backstage/core-plugin-api';\n\nexport const rootRoute = createRouteRef({\n  id: 'api-docs',\n});\n\nexport const registerComponentRouteRef = createExternalRouteRef({\n  id: 'register-component',\n  optional: true,\n});\n","/*\n * Copyright 2020 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 { ApiEntity } from '@backstage/catalog-model';\nimport { ApiDefinitionWidget } from './components/ApiDefinitionCard/ApiDefinitionWidget';\nimport { createApiRef } from '@backstage/core-plugin-api';\n\n/** @public */\nexport const apiDocsConfigRef = createApiRef<ApiDocsConfig>({\n  id: 'plugin.api-docs.config',\n});\n\n/** @public */\nexport interface ApiDocsConfig {\n  getApiDefinitionWidget: (\n    apiEntity: ApiEntity,\n  ) => ApiDefinitionWidget | undefined;\n}\n","/*\n * Copyright 2020 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 { Progress } from '@backstage/core-components';\nimport React, { Suspense } from 'react';\n\n// The asyncapi component and related CSS has a significant size, only load it\n// if the element is actually used.\nconst LazyAsyncApiDefinition = React.lazy(() =>\n  import('./AsyncApiDefinition').then(m => ({\n    default: m.AsyncApiDefinition,\n  })),\n);\n\n/** @public */\nexport type AsyncApiDefinitionWidgetProps = {\n  definition: string;\n};\n\n/** @public */\nexport const AsyncApiDefinitionWidget = (\n  props: AsyncApiDefinitionWidgetProps,\n) => {\n  return (\n    <Suspense fallback={<Progress />}>\n      <LazyAsyncApiDefinition {...props} />\n    </Suspense>\n  );\n};\n","/*\n * Copyright 2020 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 { Progress } from '@backstage/core-components';\nimport React, { Suspense } from 'react';\n\n// The graphql component, graphql and related CSS has a significant size, only\n// load it if the element is actually used.\nconst LazyGraphQlDefinition = React.lazy(() =>\n  import('./GraphQlDefinition').then(m => ({\n    default: m.GraphQlDefinition,\n  })),\n);\n\n/** @public */\nexport type GraphQlDefinitionWidgetProps = {\n  definition: string;\n};\n\n/** @public */\nexport const GraphQlDefinitionWidget = (\n  props: GraphQlDefinitionWidgetProps,\n) => {\n  return (\n    <Suspense fallback={<Progress />}>\n      <LazyGraphQlDefinition {...props} />\n    </Suspense>\n  );\n};\n","/*\n * Copyright 2020 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 { Progress } from '@backstage/core-components';\nimport React, { Suspense } from 'react';\n\n// The swagger-ui component and related CSS has a significant size, only load it\n// if the element is actually used.\nconst LazyOpenApiDefinition = React.lazy(() =>\n  import('./OpenApiDefinition').then(m => ({\n    default: m.OpenApiDefinition,\n  })),\n);\n\n/** @public */\nexport type OpenApiDefinitionWidgetProps = {\n  definition: string;\n  requestInterceptor?: (req: any) => any | Promise<any>;\n  supportedSubmitMethods?: string[];\n};\n\n/** @public */\nexport const OpenApiDefinitionWidget = (\n  props: OpenApiDefinitionWidgetProps,\n) => {\n  const validSubmitMethods = props.supportedSubmitMethods?.map(method =>\n    method.toLocaleLowerCase(),\n  );\n  return (\n    <Suspense fallback={<Progress />}>\n      <LazyOpenApiDefinition\n        {...props}\n        supportedSubmitMethods={validSubmitMethods}\n      />\n    </Suspense>\n  );\n};\n","/*\n * Copyright 2020 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 React from 'react';\nimport { CodeSnippet } from '@backstage/core-components';\nimport { useTheme } from '@material-ui/core/styles';\n\n/** @public */\nexport type GrpcApiDefinitionWidgetProps = {\n  definition: string;\n};\n\n/** @public */\nexport const GrpcApiDefinitionWidget = (\n  props: GrpcApiDefinitionWidgetProps,\n) => {\n  const theme = useTheme();\n  return (\n    <CodeSnippet\n      customStyle={{ backgroundColor: theme.palette.background.default }}\n      text={props.definition}\n      language=\"protobuf\"\n      showCopyCodeButton\n    />\n  );\n};\n","/*\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 */\nimport React from 'react';\nimport { CodeSnippet } from '@backstage/core-components';\nimport { useTheme } from '@material-ui/core/styles';\n\n/** @public */\nexport type TrpcApiDefinitionWidgetProps = {\n  definition: string;\n};\n\n/** @public */\nexport const TrpcApiDefinitionWidget = (\n  props: TrpcApiDefinitionWidgetProps,\n) => {\n  const { definition } = props;\n  const theme = useTheme();\n  return (\n    <CodeSnippet\n      customStyle={{ backgroundColor: theme.palette.background.default }}\n      text={definition}\n      language=\"typescript\"\n      showCopyCodeButton\n    />\n  );\n};\n","/*\n * Copyright 2020 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 React from 'react';\nimport { AsyncApiDefinitionWidget } from '../AsyncApiDefinitionWidget';\nimport { GraphQlDefinitionWidget } from '../GraphQlDefinitionWidget';\nimport { OpenApiDefinitionWidget } from '../OpenApiDefinitionWidget';\nimport { GrpcApiDefinitionWidget } from '../GrpcApiDefinitionWidget';\nimport { TrpcApiDefinitionWidget } from '../TrpcDefinitionWidget';\n\n/** @public */\nexport type ApiDefinitionWidget = {\n  type: string;\n  title: string;\n  component: (definition: string) => React.ReactElement;\n  rawLanguage?: string;\n};\n\n/** @public */\nexport function defaultDefinitionWidgets(): ApiDefinitionWidget[] {\n  return [\n    {\n      type: 'openapi',\n      title: 'OpenAPI',\n      rawLanguage: 'yaml',\n      component: definition => (\n        <OpenApiDefinitionWidget definition={definition} />\n      ),\n    },\n    {\n      type: 'asyncapi',\n      title: 'AsyncAPI',\n      rawLanguage: 'yaml',\n      component: definition => (\n        <AsyncApiDefinitionWidget definition={definition} />\n      ),\n    },\n    {\n      type: 'graphql',\n      title: 'GraphQL',\n      rawLanguage: 'graphql',\n      component: definition => (\n        <GraphQlDefinitionWidget definition={definition} />\n      ),\n    },\n    {\n      type: 'grpc',\n      title: 'gRPC',\n      component: definition => (\n        <GrpcApiDefinitionWidget definition={definition} />\n      ),\n    },\n    {\n      type: 'trpc',\n      title: 'tRPC',\n      component: definition => (\n        <TrpcApiDefinitionWidget definition={definition} />\n      ),\n    },\n  ];\n}\n"],"names":[],"mappings":";;;;;AAqBO,MAAM,YAAY,cAAe,CAAA;AAAA,EACtC,EAAI,EAAA,UAAA;AACN,CAAC,EAAA;AAEM,MAAM,4BAA4B,sBAAuB,CAAA;AAAA,EAC9D,EAAI,EAAA,oBAAA;AAAA,EACJ,QAAU,EAAA,IAAA;AACZ,CAAC;;ACPM,MAAM,mBAAmB,YAA4B,CAAA;AAAA,EAC1D,EAAI,EAAA,wBAAA;AACN,CAAC;;ACFD,MAAM,yBAAyB,KAAM,CAAA,IAAA;AAAA,EAAK,MACxC,OAAO,sCAAsB,CAAA,CAAE,KAAK,CAAM,CAAA,MAAA;AAAA,IACxC,SAAS,CAAE,CAAA,kBAAA;AAAA,GACX,CAAA,CAAA;AACJ,CAAA,CAAA;AAQa,MAAA,wBAAA,GAA2B,CACtC,KACG,KAAA;AACH,EACE,uBAAA,KAAA,CAAA,aAAA,CAAC,QAAS,EAAA,EAAA,QAAA,kBAAW,KAAA,CAAA,aAAA,CAAA,QAAA,EAAA,IAAS,qBAC3B,KAAA,CAAA,aAAA,CAAA,sBAAA,EAAA,EAAwB,GAAG,KAAA,EAAO,CACrC,CAAA,CAAA;AAEJ;;ACpBA,MAAM,wBAAwB,KAAM,CAAA,IAAA;AAAA,EAAK,MACvC,OAAO,qCAAqB,CAAA,CAAE,KAAK,CAAM,CAAA,MAAA;AAAA,IACvC,SAAS,CAAE,CAAA,iBAAA;AAAA,GACX,CAAA,CAAA;AACJ,CAAA,CAAA;AAQa,MAAA,uBAAA,GAA0B,CACrC,KACG,KAAA;AACH,EACE,uBAAA,KAAA,CAAA,aAAA,CAAC,QAAS,EAAA,EAAA,QAAA,kBAAW,KAAA,CAAA,aAAA,CAAA,QAAA,EAAA,IAAS,qBAC3B,KAAA,CAAA,aAAA,CAAA,qBAAA,EAAA,EAAuB,GAAG,KAAA,EAAO,CACpC,CAAA,CAAA;AAEJ;;ACpBA,MAAM,wBAAwB,KAAM,CAAA,IAAA;AAAA,EAAK,MACvC,OAAO,qCAAqB,CAAA,CAAE,KAAK,CAAM,CAAA,MAAA;AAAA,IACvC,SAAS,CAAE,CAAA,iBAAA;AAAA,GACX,CAAA,CAAA;AACJ,CAAA,CAAA;AAUa,MAAA,uBAAA,GAA0B,CACrC,KACG,KAAA;AArCL,EAAA,IAAA,EAAA,CAAA;AAsCE,EAAM,MAAA,kBAAA,GAAA,CAAqB,EAAM,GAAA,KAAA,CAAA,sBAAA,KAAN,IAA8B,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,GAAA;AAAA,IAAI,CAAA,MAAA,KAC3D,OAAO,iBAAkB,EAAA;AAAA,GAAA,CAAA;AAE3B,EAAA,uBACG,KAAA,CAAA,aAAA,CAAA,QAAA,EAAA,EAAS,QAAU,kBAAA,KAAA,CAAA,aAAA,CAAC,cAAS,CAC5B,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,qBAAA;AAAA,IAAA;AAAA,MACE,GAAG,KAAA;AAAA,MACJ,sBAAwB,EAAA,kBAAA;AAAA,KAAA;AAAA,GAE5B,CAAA,CAAA;AAEJ;;ACvBa,MAAA,uBAAA,GAA0B,CACrC,KACG,KAAA;AACH,EAAA,MAAM,QAAQ,QAAS,EAAA,CAAA;AACvB,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,WAAA;AAAA,IAAA;AAAA,MACC,aAAa,EAAE,eAAA,EAAiB,KAAM,CAAA,OAAA,CAAQ,WAAW,OAAQ,EAAA;AAAA,MACjE,MAAM,KAAM,CAAA,UAAA;AAAA,MACZ,QAAS,EAAA,UAAA;AAAA,MACT,kBAAkB,EAAA,IAAA;AAAA,KAAA;AAAA,GACpB,CAAA;AAEJ,CAAA;;ACba,MAAA,uBAAA,GAA0B,CACrC,KACG,KAAA;AACH,EAAM,MAAA,EAAE,YAAe,GAAA,KAAA,CAAA;AACvB,EAAA,MAAM,QAAQ,QAAS,EAAA,CAAA;AACvB,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,WAAA;AAAA,IAAA;AAAA,MACC,aAAa,EAAE,eAAA,EAAiB,KAAM,CAAA,OAAA,CAAQ,WAAW,OAAQ,EAAA;AAAA,MACjE,IAAM,EAAA,UAAA;AAAA,MACN,QAAS,EAAA,YAAA;AAAA,MACT,kBAAkB,EAAA,IAAA;AAAA,KAAA;AAAA,GACpB,CAAA;AAEJ;;ACPO,SAAS,wBAAkD,GAAA;AAChE,EAAO,OAAA;AAAA,IACL;AAAA,MACE,IAAM,EAAA,SAAA;AAAA,MACN,KAAO,EAAA,SAAA;AAAA,MACP,WAAa,EAAA,MAAA;AAAA,MACb,SAAW,EAAA,CAAA,UAAA,qBACR,KAAA,CAAA,aAAA,CAAA,uBAAA,EAAA,EAAwB,UAAwB,EAAA,CAAA;AAAA,KAErD;AAAA,IACA;AAAA,MACE,IAAM,EAAA,UAAA;AAAA,MACN,KAAO,EAAA,UAAA;AAAA,MACP,WAAa,EAAA,MAAA;AAAA,MACb,SAAW,EAAA,CAAA,UAAA,qBACR,KAAA,CAAA,aAAA,CAAA,wBAAA,EAAA,EAAyB,UAAwB,EAAA,CAAA;AAAA,KAEtD;AAAA,IACA;AAAA,MACE,IAAM,EAAA,SAAA;AAAA,MACN,KAAO,EAAA,SAAA;AAAA,MACP,WAAa,EAAA,SAAA;AAAA,MACb,SAAW,EAAA,CAAA,UAAA,qBACR,KAAA,CAAA,aAAA,CAAA,uBAAA,EAAA,EAAwB,UAAwB,EAAA,CAAA;AAAA,KAErD;AAAA,IACA;AAAA,MACE,IAAM,EAAA,MAAA;AAAA,MACN,KAAO,EAAA,MAAA;AAAA,MACP,SAAW,EAAA,CAAA,UAAA,qBACR,KAAA,CAAA,aAAA,CAAA,uBAAA,EAAA,EAAwB,UAAwB,EAAA,CAAA;AAAA,KAErD;AAAA,IACA;AAAA,MACE,IAAM,EAAA,MAAA;AAAA,MACN,KAAO,EAAA,MAAA;AAAA,MACP,SAAW,EAAA,CAAA,UAAA,qBACR,KAAA,CAAA,aAAA,CAAA,uBAAA,EAAA,EAAwB,UAAwB,EAAA,CAAA;AAAA,KAErD;AAAA,GACF,CAAA;AACF;;;;"}

package/dist/esm/ApiExplorerPage-ce544a95.esm.js

@@ -0,0 +1,60 @@
+import React from 'react';
+import { useOutlet } from 'react-router-dom';
+import { PageWithHeader, Content, ContentHeader, CreateButton, SupportButton } from '@backstage/core-components';
+import { useApi, configApiRef, useRouteRef } from '@backstage/core-plugin-api';
+import { CatalogTable } from '@backstage/plugin-catalog';
+import { EntityListProvider, CatalogFilterLayout, EntityKindPicker, EntityTypePicker, UserListPicker, EntityOwnerPicker, EntityLifecyclePicker, EntityTagPicker } from '@backstage/plugin-catalog-react';
+import { b as registerComponentRouteRef } from './ApiDefinitionWidget-798ee85f.esm.js';
+import { usePermission } from '@backstage/plugin-permission-react';
+import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common/alpha';
+
+const defaultColumns = [
+  CatalogTable.columns.createTitleColumn({ hidden: true }),
+  CatalogTable.columns.createNameColumn({ defaultKind: "API" }),
+  CatalogTable.columns.createSystemColumn(),
+  CatalogTable.columns.createOwnerColumn(),
+  CatalogTable.columns.createSpecTypeColumn(),
+  CatalogTable.columns.createSpecLifecycleColumn(),
+  CatalogTable.columns.createMetadataDescriptionColumn(),
+  CatalogTable.columns.createTagsColumn()
+];
+const DefaultApiExplorerPage = (props) => {
+  var _a;
+  const { initiallySelectedFilter = "all", columns, actions } = props;
+  const configApi = useApi(configApiRef);
+  const generatedSubtitle = `${(_a = configApi.getOptionalString("organization.name")) != null ? _a : "Backstage"} API Explorer`;
+  const registerComponentLink = useRouteRef(registerComponentRouteRef);
+  const { allowed } = usePermission({
+    permission: catalogEntityCreatePermission
+  });
+  return /* @__PURE__ */ React.createElement(
+    PageWithHeader,
+    {
+      themeId: "apis",
+      title: "APIs",
+      subtitle: generatedSubtitle,
+      pageTitleOverride: "APIs"
+    },
+    /* @__PURE__ */ React.createElement(Content, null, /* @__PURE__ */ React.createElement(ContentHeader, { title: "" }, allowed && /* @__PURE__ */ React.createElement(
+      CreateButton,
+      {
+        title: "Register Existing API",
+        to: registerComponentLink == null ? void 0 : registerComponentLink()
+      }
+    ), /* @__PURE__ */ React.createElement(SupportButton, null, "All your APIs")), /* @__PURE__ */ React.createElement(EntityListProvider, null, /* @__PURE__ */ React.createElement(CatalogFilterLayout, null, /* @__PURE__ */ React.createElement(CatalogFilterLayout.Filters, null, /* @__PURE__ */ React.createElement(EntityKindPicker, { initialFilter: "api", hidden: true }), /* @__PURE__ */ React.createElement(EntityTypePicker, null), /* @__PURE__ */ React.createElement(UserListPicker, { initialFilter: initiallySelectedFilter }), /* @__PURE__ */ React.createElement(EntityOwnerPicker, null), /* @__PURE__ */ React.createElement(EntityLifecyclePicker, null), /* @__PURE__ */ React.createElement(EntityTagPicker, null)), /* @__PURE__ */ React.createElement(CatalogFilterLayout.Content, null, /* @__PURE__ */ React.createElement(
+      CatalogTable,
+      {
+        columns: columns || defaultColumns,
+        actions
+      }
+    )))))
+  );
+};
+
+const ApiExplorerPage = (props) => {
+  const outlet = useOutlet();
+  return outlet || /* @__PURE__ */ React.createElement(DefaultApiExplorerPage, { ...props });
+};
+
+export { ApiExplorerPage as A, DefaultApiExplorerPage as D };
+//# sourceMappingURL=ApiExplorerPage-ce544a95.esm.js.map

package/dist/esm/ApiExplorerPage-ce544a95.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiExplorerPage-ce544a95.esm.js","sources":["../../src/components/ApiExplorerPage/DefaultApiExplorerPage.tsx","../../src/components/ApiExplorerPage/ApiExplorerPage.tsx"],"sourcesContent":["/*\n * Copyright 2021 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  Content,\n  ContentHeader,\n  CreateButton,\n  PageWithHeader,\n  SupportButton,\n  TableColumn,\n  TableProps,\n} from '@backstage/core-components';\nimport { configApiRef, useApi, useRouteRef } from '@backstage/core-plugin-api';\nimport { CatalogTable, CatalogTableRow } from '@backstage/plugin-catalog';\nimport {\n  EntityKindPicker,\n  EntityLifecyclePicker,\n  EntityListProvider,\n  EntityOwnerPicker,\n  EntityTagPicker,\n  EntityTypePicker,\n  UserListFilterKind,\n  UserListPicker,\n  CatalogFilterLayout,\n} from '@backstage/plugin-catalog-react';\nimport React from 'react';\nimport { registerComponentRouteRef } from '../../routes';\nimport { usePermission } from '@backstage/plugin-permission-react';\nimport { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common/alpha';\n\nconst defaultColumns: TableColumn<CatalogTableRow>[] = [\n  CatalogTable.columns.createTitleColumn({ hidden: true }),\n  CatalogTable.columns.createNameColumn({ defaultKind: 'API' }),\n  CatalogTable.columns.createSystemColumn(),\n  CatalogTable.columns.createOwnerColumn(),\n  CatalogTable.columns.createSpecTypeColumn(),\n  CatalogTable.columns.createSpecLifecycleColumn(),\n  CatalogTable.columns.createMetadataDescriptionColumn(),\n  CatalogTable.columns.createTagsColumn(),\n];\n\n/**\n * DefaultApiExplorerPageProps\n * @public\n */\nexport type DefaultApiExplorerPageProps = {\n  initiallySelectedFilter?: UserListFilterKind;\n  columns?: TableColumn<CatalogTableRow>[];\n  actions?: TableProps<CatalogTableRow>['actions'];\n};\n\n/**\n * DefaultApiExplorerPage\n * @public\n */\nexport const DefaultApiExplorerPage = (props: DefaultApiExplorerPageProps) => {\n  const { initiallySelectedFilter = 'all', columns, actions } = props;\n\n  const configApi = useApi(configApiRef);\n  const generatedSubtitle = `${\n    configApi.getOptionalString('organization.name') ?? 'Backstage'\n  } API Explorer`;\n  const registerComponentLink = useRouteRef(registerComponentRouteRef);\n  const { allowed } = usePermission({\n    permission: catalogEntityCreatePermission,\n  });\n\n  return (\n    <PageWithHeader\n      themeId=\"apis\"\n      title=\"APIs\"\n      subtitle={generatedSubtitle}\n      pageTitleOverride=\"APIs\"\n    >\n      <Content>\n        <ContentHeader title=\"\">\n          {allowed && (\n            <CreateButton\n              title=\"Register Existing API\"\n              to={registerComponentLink?.()}\n            />\n          )}\n          <SupportButton>All your APIs</SupportButton>\n        </ContentHeader>\n        <EntityListProvider>\n          <CatalogFilterLayout>\n            <CatalogFilterLayout.Filters>\n              <EntityKindPicker initialFilter=\"api\" hidden />\n              <EntityTypePicker />\n              <UserListPicker initialFilter={initiallySelectedFilter} />\n              <EntityOwnerPicker />\n              <EntityLifecyclePicker />\n              <EntityTagPicker />\n            </CatalogFilterLayout.Filters>\n            <CatalogFilterLayout.Content>\n              <CatalogTable\n                columns={columns || defaultColumns}\n                actions={actions}\n              />\n            </CatalogFilterLayout.Content>\n          </CatalogFilterLayout>\n        </EntityListProvider>\n      </Content>\n    </PageWithHeader>\n  );\n};\n","/*\n * Copyright 2021 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 React from 'react';\nimport { useOutlet } from 'react-router-dom';\nimport {\n  DefaultApiExplorerPage,\n  DefaultApiExplorerPageProps,\n} from './DefaultApiExplorerPage';\n\n/**\n * ApiExplorerPage\n * @public\n */\nexport const ApiExplorerPage = (props: DefaultApiExplorerPageProps) => {\n  const outlet = useOutlet();\n\n  return outlet || <DefaultApiExplorerPage {...props} />;\n};\n"],"names":[],"mappings":";;;;;;;;;;AA2CA,MAAM,cAAiD,GAAA;AAAA,EACrD,aAAa,OAAQ,CAAA,iBAAA,CAAkB,EAAE,MAAA,EAAQ,MAAM,CAAA;AAAA,EACvD,aAAa,OAAQ,CAAA,gBAAA,CAAiB,EAAE,WAAA,EAAa,OAAO,CAAA;AAAA,EAC5D,YAAA,CAAa,QAAQ,kBAAmB,EAAA;AAAA,EACxC,YAAA,CAAa,QAAQ,iBAAkB,EAAA;AAAA,EACvC,YAAA,CAAa,QAAQ,oBAAqB,EAAA;AAAA,EAC1C,YAAA,CAAa,QAAQ,yBAA0B,EAAA;AAAA,EAC/C,YAAA,CAAa,QAAQ,+BAAgC,EAAA;AAAA,EACrD,YAAA,CAAa,QAAQ,gBAAiB,EAAA;AACxC,CAAA,CAAA;AAgBa,MAAA,sBAAA,GAAyB,CAAC,KAAuC,KAAA;AApE9E,EAAA,IAAA,EAAA,CAAA;AAqEE,EAAA,MAAM,EAAE,uBAAA,GAA0B,KAAO,EAAA,OAAA,EAAS,SAAY,GAAA,KAAA,CAAA;AAE9D,EAAM,MAAA,SAAA,GAAY,OAAO,YAAY,CAAA,CAAA;AACrC,EAAA,MAAM,oBAAoB,CACxB,EAAA,CAAA,EAAA,GAAA,SAAA,CAAU,kBAAkB,mBAAmB,CAAA,KAA/C,YAAoD,WACtD,CAAA,aAAA,CAAA,CAAA;AACA,EAAM,MAAA,qBAAA,GAAwB,YAAY,yBAAyB,CAAA,CAAA;AACnE,EAAM,MAAA,EAAE,OAAQ,EAAA,GAAI,aAAc,CAAA;AAAA,IAChC,UAAY,EAAA,6BAAA;AAAA,GACb,CAAA,CAAA;AAED,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,cAAA;AAAA,IAAA;AAAA,MACC,OAAQ,EAAA,MAAA;AAAA,MACR,KAAM,EAAA,MAAA;AAAA,MACN,QAAU,EAAA,iBAAA;AAAA,MACV,iBAAkB,EAAA,MAAA;AAAA,KAAA;AAAA,wCAEjB,OACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,aAAc,EAAA,EAAA,KAAA,EAAM,MAClB,OACC,oBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,YAAA;AAAA,MAAA;AAAA,QACC,KAAM,EAAA,uBAAA;AAAA,QACN,EAAI,EAAA,qBAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,qBAAA,EAAA;AAAA,OAAA;AAAA,uBAGP,KAAA,CAAA,aAAA,CAAA,aAAA,EAAA,IAAA,EAAc,eAAa,CAC9B,CAAA,sCACC,kBACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,2CACE,KAAA,CAAA,aAAA,CAAA,mBAAA,CAAoB,SAApB,IACC,kBAAA,KAAA,CAAA,aAAA,CAAC,oBAAiB,aAAc,EAAA,KAAA,EAAM,QAAM,IAAC,EAAA,CAAA,kBAC5C,KAAA,CAAA,aAAA,CAAA,gBAAA,EAAA,IAAiB,mBACjB,KAAA,CAAA,aAAA,CAAA,cAAA,EAAA,EAAe,eAAe,uBAAyB,EAAA,CAAA,sCACvD,iBAAkB,EAAA,IAAA,CAAA,sCAClB,qBAAsB,EAAA,IAAA,CAAA,sCACtB,eAAgB,EAAA,IAAA,CACnB,mBACC,KAAA,CAAA,aAAA,CAAA,mBAAA,CAAoB,SAApB,IACC,kBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,YAAA;AAAA,MAAA;AAAA,QACC,SAAS,OAAW,IAAA,cAAA;AAAA,QACpB,OAAA;AAAA,OAAA;AAAA,KAEJ,CACF,CACF,CACF,CAAA;AAAA,GACF,CAAA;AAEJ;;AC3Fa,MAAA,eAAA,GAAkB,CAAC,KAAuC,KAAA;AACrE,EAAA,MAAM,SAAS,SAAU,EAAA,CAAA;AAEzB,EAAA,OAAO,MAAU,oBAAA,KAAA,CAAA,aAAA,CAAC,sBAAwB,EAAA,EAAA,GAAG,KAAO,EAAA,CAAA,CAAA;AACtD;;;;"}

package/dist/esm/ApiTypeTitle-cc79a2f3.esm.js

@@ -0,0 +1,27 @@
+import React from 'react';
+import { CodeSnippet } from '@backstage/core-components';
+import Typography from '@material-ui/core/Typography';
+import { a as apiDocsConfigRef } from './ApiDefinitionWidget-798ee85f.esm.js';
+import { useApi } from '@backstage/core-plugin-api';
+
+const PlainApiDefinitionWidget = (props) => {
+  return /* @__PURE__ */ React.createElement(
+    CodeSnippet,
+    {
+      text: props.definition,
+      language: props.language,
+      showCopyCodeButton: true
+    }
+  );
+};
+
+const ApiTypeTitle = (props) => {
+  const { apiEntity } = props;
+  const config = useApi(apiDocsConfigRef);
+  const definition = config.getApiDefinitionWidget(apiEntity);
+  const type = definition ? definition.title : apiEntity.spec.type;
+  return /* @__PURE__ */ React.createElement(Typography, { component: "span" }, type);
+};
+
+export { ApiTypeTitle as A, PlainApiDefinitionWidget as P };
+//# sourceMappingURL=ApiTypeTitle-cc79a2f3.esm.js.map

package/dist/esm/ApiTypeTitle-cc79a2f3.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiTypeTitle-cc79a2f3.esm.js","sources":["../../src/components/PlainApiDefinitionWidget/PlainApiDefinitionWidget.tsx","../../src/components/ApiDefinitionCard/ApiTypeTitle.tsx"],"sourcesContent":["/*\n * Copyright 2020 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 React from 'react';\nimport { CodeSnippet } from '@backstage/core-components';\n\n/** @public */\nexport type PlainApiDefinitionWidgetProps = {\n  definition: any;\n  language: string;\n};\n\n/** @public */\nexport const PlainApiDefinitionWidget = (\n  props: PlainApiDefinitionWidgetProps,\n) => {\n  return (\n    <CodeSnippet\n      text={props.definition}\n      language={props.language}\n      showCopyCodeButton\n    />\n  );\n};\n","/*\n * Copyright 2020 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 { ApiEntity } from '@backstage/catalog-model';\nimport Typography from '@material-ui/core/Typography';\nimport React from 'react';\nimport { apiDocsConfigRef } from '../../config';\nimport { useApi } from '@backstage/core-plugin-api';\n\n/**\n * @public\n */\nexport const ApiTypeTitle = (props: { apiEntity: ApiEntity }) => {\n  const { apiEntity } = props;\n  const config = useApi(apiDocsConfigRef);\n  const definition = config.getApiDefinitionWidget(apiEntity);\n  const type = definition ? definition.title : apiEntity.spec.type;\n\n  return <Typography component=\"span\">{type}</Typography>;\n};\n"],"names":[],"mappings":";;;;;;AA0Ba,MAAA,wBAAA,GAA2B,CACtC,KACG,KAAA;AACH,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,WAAA;AAAA,IAAA;AAAA,MACC,MAAM,KAAM,CAAA,UAAA;AAAA,MACZ,UAAU,KAAM,CAAA,QAAA;AAAA,MAChB,kBAAkB,EAAA,IAAA;AAAA,KAAA;AAAA,GACpB,CAAA;AAEJ;;ACXa,MAAA,YAAA,GAAe,CAAC,KAAoC,KAAA;AAC/D,EAAM,MAAA,EAAE,WAAc,GAAA,KAAA,CAAA;AACtB,EAAM,MAAA,MAAA,GAAS,OAAO,gBAAgB,CAAA,CAAA;AACtC,EAAM,MAAA,UAAA,GAAa,MAAO,CAAA,sBAAA,CAAuB,SAAS,CAAA,CAAA;AAC1D,EAAA,MAAM,IAAO,GAAA,UAAA,GAAa,UAAW,CAAA,KAAA,GAAQ,UAAU,IAAK,CAAA,IAAA,CAAA;AAE5D,EAAA,uBAAQ,KAAA,CAAA,aAAA,CAAA,UAAA,EAAA,EAAW,SAAU,EAAA,MAAA,EAAA,EAAQ,IAAK,CAAA,CAAA;AAC5C;;;;"}