@backstage/plugin-api-docs 0.11.0 → 0.11.1-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/alpha/package.json +1 -1
- package/dist/alpha.esm.js +3 -8
- package/dist/alpha.esm.js.map +1 -1
- package/package.json +41 -41
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @backstage/plugin-api-docs
|
|
2
2
|
|
|
3
|
+
## 0.11.1-next.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 7854120: Use the `AppIcon` component in the navigation item extension.
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/core-components@0.14.1-next.0
|
|
10
|
+
- @backstage/plugin-catalog-react@1.10.1-next.0
|
|
11
|
+
- @backstage/plugin-catalog@1.17.1-next.0
|
|
12
|
+
- @backstage/catalog-model@1.4.5-next.0
|
|
13
|
+
- @backstage/core-plugin-api@1.9.1-next.0
|
|
14
|
+
- @backstage/frontend-plugin-api@0.6.1-next.0
|
|
15
|
+
- @backstage/core-compat-api@0.2.1-next.0
|
|
16
|
+
- @backstage/plugin-catalog-common@1.0.22-next.0
|
|
17
|
+
- @backstage/plugin-permission-react@0.4.21-next.0
|
|
18
|
+
|
|
3
19
|
## 0.11.0
|
|
4
20
|
|
|
5
21
|
### Minor Changes
|
package/alpha/package.json
CHANGED
package/dist/alpha.esm.js
CHANGED
|
@@ -2,25 +2,20 @@ import React from 'react';
|
|
|
2
2
|
import { Grid } from '@material-ui/core';
|
|
3
3
|
import { createNavItemExtension, createApiExtension, createApiFactory, createPageExtension, createSchemaFromZod, createPlugin } from '@backstage/frontend-plugin-api';
|
|
4
4
|
import { convertLegacyRouteRef, compatWrapper } from '@backstage/core-compat-api';
|
|
5
|
-
import { useApp } from '@backstage/core-plugin-api';
|
|
6
5
|
import { createEntityCardExtension, createEntityContentExtension } from '@backstage/plugin-catalog-react/alpha';
|
|
7
6
|
import { RELATION_HAS_PART, parseEntityRef } from '@backstage/catalog-model';
|
|
8
7
|
import '@backstage/plugin-catalog-react';
|
|
9
8
|
import '@material-ui/lab';
|
|
10
9
|
import { r as rootRoute, a as apiDocsConfigRef, b as registerComponentRouteRef, d as defaultDefinitionWidgets } from './esm/ApiDefinitionWidget-798ee85f.esm.js';
|
|
11
|
-
import '@backstage/core-components';
|
|
10
|
+
import { AppIcon } from '@backstage/core-components';
|
|
11
|
+
import '@backstage/core-plugin-api';
|
|
12
12
|
import '@material-ui/core/Typography';
|
|
13
13
|
import '@material-ui/core/styles';
|
|
14
14
|
|
|
15
|
-
function ApiIcon() {
|
|
16
|
-
const app = useApp();
|
|
17
|
-
const KindApiSystemIcon = app.getSystemIcon("kind:api");
|
|
18
|
-
return /* @__PURE__ */ React.createElement(KindApiSystemIcon, null);
|
|
19
|
-
}
|
|
20
15
|
const apiDocsNavItem = createNavItemExtension({
|
|
21
16
|
title: "APIs",
|
|
22
17
|
routeRef: convertLegacyRouteRef(rootRoute),
|
|
23
|
-
icon: () => compatWrapper(/* @__PURE__ */ React.createElement(
|
|
18
|
+
icon: () => compatWrapper(/* @__PURE__ */ React.createElement(AppIcon, { id: "kind:api" }))
|
|
24
19
|
});
|
|
25
20
|
const apiDocsConfigApi = createApiExtension({
|
|
26
21
|
factory: createApiFactory({
|
package/dist/alpha.esm.js.map
CHANGED
|
@@ -1 +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 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;;;;"}
|
|
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';\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';\nimport { AppIcon } from '@backstage/core-components';\n\nconst apiDocsNavItem = createNavItemExtension({\n title: 'APIs',\n routeRef: convertLegacyRouteRef(rootRoute),\n icon: () => compatWrapper(<AppIcon id=\"kind:api\" />),\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,MAAM,iBAAiB,sBAAuB,CAAA;AAAA,EAC5C,KAAO,EAAA,MAAA;AAAA,EACP,QAAA,EAAU,sBAAsB,SAAS,CAAA;AAAA,EACzC,MAAM,MAAM,aAAA,qCAAe,OAAQ,EAAA,EAAA,EAAA,EAAG,YAAW,CAAE,CAAA;AACrD,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;AA/FpB,IAAA,IAAA,EAAA,CAAA;AAgGI,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/package.json
CHANGED
|
@@ -1,13 +1,24 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-api-docs",
|
|
3
|
+
"version": "0.11.1-next.0",
|
|
3
4
|
"description": "A Backstage plugin that helps represent API entities in the frontend",
|
|
4
|
-
"
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
"license": "Apache-2.0",
|
|
5
|
+
"backstage": {
|
|
6
|
+
"role": "frontend-plugin"
|
|
7
|
+
},
|
|
8
8
|
"publishConfig": {
|
|
9
9
|
"access": "public"
|
|
10
10
|
},
|
|
11
|
+
"keywords": [
|
|
12
|
+
"backstage"
|
|
13
|
+
],
|
|
14
|
+
"homepage": "https://backstage.io",
|
|
15
|
+
"repository": {
|
|
16
|
+
"type": "git",
|
|
17
|
+
"url": "https://github.com/backstage/backstage",
|
|
18
|
+
"directory": "plugins/api-docs"
|
|
19
|
+
},
|
|
20
|
+
"license": "Apache-2.0",
|
|
21
|
+
"sideEffects": false,
|
|
11
22
|
"exports": {
|
|
12
23
|
".": {
|
|
13
24
|
"import": "./dist/index.esm.js",
|
|
@@ -21,39 +32,32 @@
|
|
|
21
32
|
},
|
|
22
33
|
"./package.json": "./package.json"
|
|
23
34
|
},
|
|
24
|
-
"
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
"type": "git",
|
|
30
|
-
"url": "https://github.com/backstage/backstage",
|
|
31
|
-
"directory": "plugins/api-docs"
|
|
32
|
-
},
|
|
33
|
-
"keywords": [
|
|
34
|
-
"backstage"
|
|
35
|
+
"main": "./dist/index.esm.js",
|
|
36
|
+
"types": "./dist/index.d.ts",
|
|
37
|
+
"files": [
|
|
38
|
+
"dist",
|
|
39
|
+
"alpha"
|
|
35
40
|
],
|
|
36
|
-
"sideEffects": false,
|
|
37
41
|
"scripts": {
|
|
38
42
|
"build": "backstage-cli package build",
|
|
39
|
-
"
|
|
43
|
+
"clean": "backstage-cli package clean",
|
|
40
44
|
"lint": "backstage-cli package lint",
|
|
41
|
-
"test": "backstage-cli package test",
|
|
42
45
|
"prepack": "backstage-cli package prepack",
|
|
43
46
|
"postpack": "backstage-cli package postpack",
|
|
44
|
-
"
|
|
47
|
+
"start": "backstage-cli package start",
|
|
48
|
+
"test": "backstage-cli package test"
|
|
45
49
|
},
|
|
46
50
|
"dependencies": {
|
|
47
51
|
"@asyncapi/react-component": "1.2.13",
|
|
48
|
-
"@backstage/catalog-model": "^1.4.
|
|
49
|
-
"@backstage/core-compat-api": "^0.2.0",
|
|
50
|
-
"@backstage/core-components": "^0.14.0",
|
|
51
|
-
"@backstage/core-plugin-api": "^1.9.0",
|
|
52
|
-
"@backstage/frontend-plugin-api": "^0.6.0",
|
|
53
|
-
"@backstage/plugin-catalog": "^1.17.0",
|
|
54
|
-
"@backstage/plugin-catalog-common": "^1.0.
|
|
55
|
-
"@backstage/plugin-catalog-react": "^1.10.0",
|
|
56
|
-
"@backstage/plugin-permission-react": "^0.4.
|
|
52
|
+
"@backstage/catalog-model": "^1.4.5-next.0",
|
|
53
|
+
"@backstage/core-compat-api": "^0.2.1-next.0",
|
|
54
|
+
"@backstage/core-components": "^0.14.1-next.0",
|
|
55
|
+
"@backstage/core-plugin-api": "^1.9.1-next.0",
|
|
56
|
+
"@backstage/frontend-plugin-api": "^0.6.1-next.0",
|
|
57
|
+
"@backstage/plugin-catalog": "^1.17.1-next.0",
|
|
58
|
+
"@backstage/plugin-catalog-common": "^1.0.22-next.0",
|
|
59
|
+
"@backstage/plugin-catalog-react": "^1.10.1-next.0",
|
|
60
|
+
"@backstage/plugin-permission-react": "^0.4.21-next.0",
|
|
57
61
|
"@graphiql/react": "^0.20.0",
|
|
58
62
|
"@material-ui/core": "^4.12.2",
|
|
59
63
|
"@material-ui/icons": "^4.9.1",
|
|
@@ -66,25 +70,21 @@
|
|
|
66
70
|
"isomorphic-form-data": "^2.0.0",
|
|
67
71
|
"swagger-ui-react": "^5.0.0"
|
|
68
72
|
},
|
|
69
|
-
"peerDependencies": {
|
|
70
|
-
"react": "^16.13.1 || ^17.0.0 || ^18.0.0",
|
|
71
|
-
"react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
|
|
72
|
-
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
|
|
73
|
-
},
|
|
74
73
|
"devDependencies": {
|
|
75
|
-
"@backstage/cli": "^0.25.
|
|
76
|
-
"@backstage/core-app-api": "^1.12.0",
|
|
77
|
-
"@backstage/dev-utils": "^1.0.
|
|
78
|
-
"@backstage/test-utils": "^1.5.0",
|
|
74
|
+
"@backstage/cli": "^0.25.3-next.0",
|
|
75
|
+
"@backstage/core-app-api": "^1.12.1-next.0",
|
|
76
|
+
"@backstage/dev-utils": "^1.0.28-next.0",
|
|
77
|
+
"@backstage/test-utils": "^1.5.1-next.0",
|
|
79
78
|
"@testing-library/dom": "^9.0.0",
|
|
80
79
|
"@testing-library/jest-dom": "^6.0.0",
|
|
81
80
|
"@testing-library/react": "^14.0.0",
|
|
82
81
|
"@testing-library/user-event": "^14.0.0",
|
|
83
82
|
"@types/swagger-ui-react": "^4.18.0"
|
|
84
83
|
},
|
|
85
|
-
"
|
|
86
|
-
"
|
|
87
|
-
"
|
|
88
|
-
|
|
84
|
+
"peerDependencies": {
|
|
85
|
+
"react": "^16.13.1 || ^17.0.0 || ^18.0.0",
|
|
86
|
+
"react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
|
|
87
|
+
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
|
|
88
|
+
},
|
|
89
89
|
"module": "./dist/index.esm.js"
|
|
90
90
|
}
|