@backstage/plugin-techdocs 0.0.0-nightly-20221121024025 → 0.0.0-nightly-20221123023445
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 +33 -12
- package/dist/esm/{TechDocsCustomHome-02667b22.esm.js → TechDocsCustomHome-3613566f.esm.js} +2 -2
- package/dist/esm/{TechDocsCustomHome-02667b22.esm.js.map → TechDocsCustomHome-3613566f.esm.js.map} +1 -1
- package/dist/esm/{index-847211c1.esm.js → index-54417ed8.esm.js} +4 -4
- package/dist/esm/index-54417ed8.esm.js.map +1 -0
- package/dist/esm/{index-5ce38e4c.esm.js → index-ef644ee7.esm.js} +2 -2
- package/dist/esm/index-ef644ee7.esm.js.map +1 -0
- package/dist/index.esm.js +1 -1
- package/package.json +17 -17
- package/dist/esm/index-5ce38e4c.esm.js.map +0 -1
- package/dist/esm/index-847211c1.esm.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,22 +1,43 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20221123023445
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
|
+
- d3fea4ae0a: Internal fixes to avoid implicit usage of globals
|
|
8
|
+
- 3280711113: Updated dependency `msw` to `^0.49.0`.
|
|
7
9
|
- Updated dependencies
|
|
8
|
-
- @backstage/plugin-techdocs-react@0.0.0-nightly-
|
|
9
|
-
- @backstage/core-components@0.0.0-nightly-
|
|
10
|
-
- @backstage/core-plugin-api@0.0.0-nightly-
|
|
11
|
-
- @backstage/
|
|
12
|
-
- @backstage/integration@0.0.0-nightly-
|
|
13
|
-
- @backstage/catalog-
|
|
14
|
-
- @backstage/
|
|
15
|
-
- @backstage/
|
|
16
|
-
- @backstage/
|
|
10
|
+
- @backstage/plugin-techdocs-react@0.0.0-nightly-20221123023445
|
|
11
|
+
- @backstage/core-components@0.0.0-nightly-20221123023445
|
|
12
|
+
- @backstage/core-plugin-api@0.0.0-nightly-20221123023445
|
|
13
|
+
- @backstage/integration-react@0.0.0-nightly-20221123023445
|
|
14
|
+
- @backstage/integration@0.0.0-nightly-20221123023445
|
|
15
|
+
- @backstage/plugin-catalog-react@0.0.0-nightly-20221123023445
|
|
16
|
+
- @backstage/catalog-model@0.0.0-nightly-20221123023445
|
|
17
|
+
- @backstage/config@0.0.0-nightly-20221123023445
|
|
18
|
+
- @backstage/errors@0.0.0-nightly-20221123023445
|
|
17
19
|
- @backstage/theme@0.2.16
|
|
18
|
-
- @backstage/plugin-search-common@0.0.0-nightly-
|
|
19
|
-
- @backstage/plugin-search-react@0.0.0-nightly-
|
|
20
|
+
- @backstage/plugin-search-common@0.0.0-nightly-20221123023445
|
|
21
|
+
- @backstage/plugin-search-react@0.0.0-nightly-20221123023445
|
|
22
|
+
|
|
23
|
+
## 1.4.1-next.0
|
|
24
|
+
|
|
25
|
+
### Patch Changes
|
|
26
|
+
|
|
27
|
+
- 3280711113: Updated dependency `msw` to `^0.49.0`.
|
|
28
|
+
- Updated dependencies
|
|
29
|
+
- @backstage/plugin-techdocs-react@1.0.7-next.0
|
|
30
|
+
- @backstage/core-components@0.12.1-next.0
|
|
31
|
+
- @backstage/core-plugin-api@1.1.1-next.0
|
|
32
|
+
- @backstage/integration-react@1.1.7-next.0
|
|
33
|
+
- @backstage/integration@1.4.1-next.0
|
|
34
|
+
- @backstage/plugin-catalog-react@1.2.2-next.0
|
|
35
|
+
- @backstage/catalog-model@1.1.4-next.0
|
|
36
|
+
- @backstage/config@1.0.5-next.0
|
|
37
|
+
- @backstage/errors@1.1.4-next.0
|
|
38
|
+
- @backstage/theme@0.2.16
|
|
39
|
+
- @backstage/plugin-search-common@1.1.2-next.0
|
|
40
|
+
- @backstage/plugin-search-react@1.2.2-next.0
|
|
20
41
|
|
|
21
42
|
## 1.4.0
|
|
22
43
|
|
|
@@ -2,7 +2,7 @@ import React, { useState } from 'react';
|
|
|
2
2
|
import useAsync from 'react-use/lib/useAsync';
|
|
3
3
|
import { makeStyles } from '@material-ui/core';
|
|
4
4
|
import { catalogApiRef, CATALOG_FILTER_EXISTS, useEntityOwnership } from '@backstage/plugin-catalog-react';
|
|
5
|
-
import { T as TechDocsPageWrapper, D as DocsTable, a as DocsCardGrid } from './index-
|
|
5
|
+
import { T as TechDocsPageWrapper, D as DocsTable, a as DocsCardGrid } from './index-54417ed8.esm.js';
|
|
6
6
|
import { Content, Progress, WarningPanel, CodeSnippet, HeaderTabs, ContentHeader, SupportButton } from '@backstage/core-components';
|
|
7
7
|
import { useApi } from '@backstage/core-plugin-api';
|
|
8
8
|
import '@backstage/errors';
|
|
@@ -127,4 +127,4 @@ const TechDocsCustomHome = (props) => {
|
|
|
127
127
|
};
|
|
128
128
|
|
|
129
129
|
export { TechDocsCustomHome };
|
|
130
|
-
//# sourceMappingURL=TechDocsCustomHome-
|
|
130
|
+
//# sourceMappingURL=TechDocsCustomHome-3613566f.esm.js.map
|
package/dist/esm/{TechDocsCustomHome-02667b22.esm.js.map → TechDocsCustomHome-3613566f.esm.js.map}
RENAMED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TechDocsCustomHome-
|
|
1
|
+
{"version":3,"file":"TechDocsCustomHome-3613566f.esm.js","sources":["../../src/home/components/TechDocsCustomHome.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 React, { useState } from 'react';\nimport useAsync from 'react-use/lib/useAsync';\nimport { makeStyles } from '@material-ui/core';\nimport { CSSProperties } from '@material-ui/styles';\nimport {\n CATALOG_FILTER_EXISTS,\n catalogApiRef,\n CatalogApi,\n useEntityOwnership,\n} from '@backstage/plugin-catalog-react';\nimport { Entity } from '@backstage/catalog-model';\nimport { DocsTable } from './Tables';\nimport { DocsCardGrid } from './Grids';\nimport { TechDocsPageWrapper } from './TechDocsPageWrapper';\n\nimport {\n CodeSnippet,\n Content,\n HeaderTabs,\n Progress,\n WarningPanel,\n SupportButton,\n ContentHeader,\n} from '@backstage/core-components';\nimport { useApi } from '@backstage/core-plugin-api';\n\nconst panels = {\n DocsTable: DocsTable,\n DocsCardGrid: DocsCardGrid,\n};\n\n/**\n * Available panel types\n *\n * @public\n */\nexport type PanelType = 'DocsCardGrid' | 'DocsTable';\n\n/**\n * Type representing a TechDocsCustomHome panel.\n *\n * @public\n */\nexport interface PanelConfig {\n title: string;\n description: string;\n panelType: PanelType;\n panelCSS?: CSSProperties;\n filterPredicate: ((entity: Entity) => boolean) | string;\n}\n\n/**\n * Type representing a TechDocsCustomHome tab.\n *\n * @public\n */\nexport interface TabConfig {\n label: string;\n panels: PanelConfig[];\n}\n\n/**\n * Type representing a list of TechDocsCustomHome tabs.\n *\n * @public\n */\nexport type TabsConfig = TabConfig[];\n\nconst CustomPanel = ({\n config,\n entities,\n index,\n}: {\n config: PanelConfig;\n entities: Entity[];\n index: number;\n}) => {\n const useStyles = makeStyles({\n panelContainer: {\n marginBottom: '2rem',\n ...(config.panelCSS ? config.panelCSS : {}),\n },\n });\n const classes = useStyles();\n const { loading: loadingOwnership, isOwnedEntity } = useEntityOwnership();\n\n const Panel = panels[config.panelType];\n\n const shownEntities = entities.filter(entity => {\n if (config.filterPredicate === 'ownedByUser') {\n if (loadingOwnership) {\n return false;\n }\n return isOwnedEntity(entity);\n }\n\n return (\n typeof config.filterPredicate === 'function' &&\n config.filterPredicate(entity)\n );\n });\n\n return (\n <>\n <ContentHeader title={config.title} description={config.description}>\n {index === 0 ? (\n <SupportButton>\n Discover documentation in your ecosystem.\n </SupportButton>\n ) : null}\n </ContentHeader>\n <div className={classes.panelContainer}>\n <Panel data-testid=\"techdocs-custom-panel\" entities={shownEntities} />\n </div>\n </>\n );\n};\n\n/**\n * Props for {@link TechDocsCustomHome}\n *\n * @public\n */\nexport type TechDocsCustomHomeProps = {\n tabsConfig: TabsConfig;\n};\n\nexport const TechDocsCustomHome = (props: TechDocsCustomHomeProps) => {\n const { tabsConfig } = props;\n const [selectedTab, setSelectedTab] = useState<number>(0);\n const catalogApi: CatalogApi = useApi(catalogApiRef);\n\n const {\n value: entities,\n loading,\n error,\n } = useAsync(async () => {\n const response = await catalogApi.getEntities({\n filter: {\n 'metadata.annotations.backstage.io/techdocs-ref': CATALOG_FILTER_EXISTS,\n },\n fields: [\n 'apiVersion',\n 'kind',\n 'metadata',\n 'relations',\n 'spec.owner',\n 'spec.type',\n ],\n });\n return response.items.filter((entity: Entity) => {\n return !!entity.metadata.annotations?.['backstage.io/techdocs-ref'];\n });\n });\n\n const currentTabConfig = tabsConfig[selectedTab];\n\n if (loading) {\n return (\n <TechDocsPageWrapper>\n <Content>\n <Progress />\n </Content>\n </TechDocsPageWrapper>\n );\n }\n\n if (error) {\n return (\n <TechDocsPageWrapper>\n <Content>\n <WarningPanel\n severity=\"error\"\n title=\"Could not load available documentation.\"\n >\n <CodeSnippet language=\"text\" text={error.toString()} />\n </WarningPanel>\n </Content>\n </TechDocsPageWrapper>\n );\n }\n\n return (\n <TechDocsPageWrapper>\n <HeaderTabs\n selectedIndex={selectedTab}\n onChange={index => setSelectedTab(index)}\n tabs={tabsConfig.map(({ label }, index) => ({\n id: index.toString(),\n label,\n }))}\n />\n <Content data-testid=\"techdocs-content\">\n {currentTabConfig.panels.map((config, index) => (\n <CustomPanel\n key={index}\n config={config}\n entities={!!entities ? entities : []}\n index={index}\n />\n ))}\n </Content>\n </TechDocsPageWrapper>\n );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,MAAM,MAAS,GAAA;AAAA,EACb,SAAA;AAAA,EACA,YAAA;AACF,CAAA,CAAA;AAuCA,MAAM,cAAc,CAAC;AAAA,EACnB,MAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AACF,CAIM,KAAA;AACJ,EAAA,MAAM,YAAY,UAAW,CAAA;AAAA,IAC3B,cAAgB,EAAA;AAAA,MACd,YAAc,EAAA,MAAA;AAAA,MACd,GAAI,MAAA,CAAO,QAAW,GAAA,MAAA,CAAO,WAAW,EAAC;AAAA,KAC3C;AAAA,GACD,CAAA,CAAA;AACD,EAAA,MAAM,UAAU,SAAU,EAAA,CAAA;AAC1B,EAAA,MAAM,EAAE,OAAA,EAAS,gBAAkB,EAAA,aAAA,KAAkB,kBAAmB,EAAA,CAAA;AAExE,EAAM,MAAA,KAAA,GAAQ,OAAO,MAAO,CAAA,SAAA,CAAA,CAAA;AAE5B,EAAM,MAAA,aAAA,GAAgB,QAAS,CAAA,MAAA,CAAO,CAAU,MAAA,KAAA;AAC9C,IAAI,IAAA,MAAA,CAAO,oBAAoB,aAAe,EAAA;AAC5C,MAAA,IAAI,gBAAkB,EAAA;AACpB,QAAO,OAAA,KAAA,CAAA;AAAA,OACT;AACA,MAAA,OAAO,cAAc,MAAM,CAAA,CAAA;AAAA,KAC7B;AAEA,IAAA,OACE,OAAO,MAAO,CAAA,eAAA,KAAoB,UAClC,IAAA,MAAA,CAAO,gBAAgB,MAAM,CAAA,CAAA;AAAA,GAEhC,CAAA,CAAA;AAED,EAAA,iFAEK,KAAA,CAAA,aAAA,CAAA,aAAA,EAAA;AAAA,IAAc,OAAO,MAAO,CAAA,KAAA;AAAA,IAAO,aAAa,MAAO,CAAA,WAAA;AAAA,GACrD,EAAA,KAAA,KAAU,oBACR,KAAA,CAAA,aAAA,CAAA,aAAA,EAAA,IAAA,EAAc,2CAEf,CACE,GAAA,IACN,mBACC,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA;AAAA,IAAI,WAAW,OAAQ,CAAA,cAAA;AAAA,GAAA,kBACrB,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA;AAAA,IAAM,aAAY,EAAA,uBAAA;AAAA,IAAwB,QAAU,EAAA,aAAA;AAAA,GAAe,CACtE,CACF,CAAA,CAAA;AAEJ,CAAA,CAAA;AAWa,MAAA,kBAAA,GAAqB,CAAC,KAAmC,KAAA;AACpE,EAAM,MAAA,EAAE,YAAe,GAAA,KAAA,CAAA;AACvB,EAAA,MAAM,CAAC,WAAA,EAAa,cAAc,CAAA,GAAI,SAAiB,CAAC,CAAA,CAAA;AACxD,EAAM,MAAA,UAAA,GAAyB,OAAO,aAAa,CAAA,CAAA;AAEnD,EAAM,MAAA;AAAA,IACJ,KAAO,EAAA,QAAA;AAAA,IACP,OAAA;AAAA,IACA,KAAA;AAAA,GACF,GAAI,SAAS,YAAY;AACvB,IAAM,MAAA,QAAA,GAAW,MAAM,UAAA,CAAW,WAAY,CAAA;AAAA,MAC5C,MAAQ,EAAA;AAAA,QACN,gDAAkD,EAAA,qBAAA;AAAA,OACpD;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,YAAA;AAAA,QACA,MAAA;AAAA,QACA,UAAA;AAAA,QACA,WAAA;AAAA,QACA,YAAA;AAAA,QACA,WAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AACD,IAAA,OAAO,QAAS,CAAA,KAAA,CAAM,MAAO,CAAA,CAAC,MAAmB,KAAA;AAtKrD,MAAA,IAAA,EAAA,CAAA;AAuKM,MAAA,OAAO,CAAC,EAAA,CAAC,EAAO,GAAA,MAAA,CAAA,QAAA,CAAS,gBAAhB,IAA8B,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,2BAAA,CAAA,CAAA,CAAA;AAAA,KACxC,CAAA,CAAA;AAAA,GACF,CAAA,CAAA;AAED,EAAA,MAAM,mBAAmB,UAAW,CAAA,WAAA,CAAA,CAAA;AAEpC,EAAA,IAAI,OAAS,EAAA;AACX,IAAA,2CACG,mBACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,+BACE,KAAA,CAAA,aAAA,CAAA,QAAA,EAAA,IAAS,CACZ,CACF,CAAA,CAAA;AAAA,GAEJ;AAEA,EAAA,IAAI,KAAO,EAAA;AACT,IAAA,uBACG,KAAA,CAAA,aAAA,CAAA,mBAAA,EAAA,IAAA,kBACE,KAAA,CAAA,aAAA,CAAA,OAAA,EAAA,IAAA,kBACE,KAAA,CAAA,aAAA,CAAA,YAAA,EAAA;AAAA,MACC,QAAS,EAAA,OAAA;AAAA,MACT,KAAM,EAAA,yCAAA;AAAA,KAAA,kBAEL,KAAA,CAAA,aAAA,CAAA,WAAA,EAAA;AAAA,MAAY,QAAS,EAAA,MAAA;AAAA,MAAO,IAAA,EAAM,MAAM,QAAS,EAAA;AAAA,KAAG,CACvD,CACF,CACF,CAAA,CAAA;AAAA,GAEJ;AAEA,EACE,uBAAA,KAAA,CAAA,aAAA,CAAC,2CACE,KAAA,CAAA,aAAA,CAAA,UAAA,EAAA;AAAA,IACC,aAAe,EAAA,WAAA;AAAA,IACf,QAAA,EAAU,CAAS,KAAA,KAAA,cAAA,CAAe,KAAK,CAAA;AAAA,IACvC,MAAM,UAAW,CAAA,GAAA,CAAI,CAAC,EAAE,KAAA,IAAS,KAAW,MAAA;AAAA,MAC1C,EAAA,EAAI,MAAM,QAAS,EAAA;AAAA,MACnB,KAAA;AAAA,KACA,CAAA,CAAA;AAAA,GACJ,mBACC,KAAA,CAAA,aAAA,CAAA,OAAA,EAAA;AAAA,IAAQ,aAAY,EAAA,kBAAA;AAAA,GAAA,EAClB,iBAAiB,MAAO,CAAA,GAAA,CAAI,CAAC,MAAA,EAAQ,0BACnC,KAAA,CAAA,aAAA,CAAA,WAAA,EAAA;AAAA,IACC,GAAK,EAAA,KAAA;AAAA,IACL,MAAA;AAAA,IACA,QAAU,EAAA,CAAC,CAAC,QAAA,GAAW,WAAW,EAAC;AAAA,IACnC,KAAA;AAAA,GACF,CACD,CACH,CACF,CAAA,CAAA;AAEJ;;;;"}
|
|
@@ -1445,7 +1445,7 @@ const CopyToClipboardIcon = () => /* @__PURE__ */ React.createElement(SvgIcon, n
|
|
|
1445
1445
|
const CopyToClipboardButton = ({ text }) => {
|
|
1446
1446
|
const [open, setOpen] = useState(false);
|
|
1447
1447
|
const handleClick = useCallback(() => {
|
|
1448
|
-
navigator.clipboard.writeText(text);
|
|
1448
|
+
window.navigator.clipboard.writeText(text);
|
|
1449
1449
|
setOpen(true);
|
|
1450
1450
|
}, [text]);
|
|
1451
1451
|
const handleClose = useCallback(() => {
|
|
@@ -2392,7 +2392,7 @@ const EntityTechdocsContent = techdocsPlugin.provide(
|
|
|
2392
2392
|
const TechDocsCustomHome = techdocsPlugin.provide(
|
|
2393
2393
|
createRoutableExtension({
|
|
2394
2394
|
name: "TechDocsCustomHome",
|
|
2395
|
-
component: () => import('./TechDocsCustomHome-
|
|
2395
|
+
component: () => import('./TechDocsCustomHome-3613566f.esm.js').then(
|
|
2396
2396
|
(m) => m.TechDocsCustomHome
|
|
2397
2397
|
),
|
|
2398
2398
|
mountPoint: rootRouteRef
|
|
@@ -2410,7 +2410,7 @@ const TechDocsIndexPage$2 = techdocsPlugin.provide(
|
|
|
2410
2410
|
const TechDocsReaderPage = techdocsPlugin.provide(
|
|
2411
2411
|
createRoutableExtension({
|
|
2412
2412
|
name: "TechDocsReaderPage",
|
|
2413
|
-
component: () => import('./index-
|
|
2413
|
+
component: () => import('./index-ef644ee7.esm.js').then(
|
|
2414
2414
|
(m) => m.TechDocsReaderPage
|
|
2415
2415
|
),
|
|
2416
2416
|
mountPoint: rootDocsRouteRef
|
|
@@ -2487,4 +2487,4 @@ var Router$1 = /*#__PURE__*/Object.freeze({
|
|
|
2487
2487
|
});
|
|
2488
2488
|
|
|
2489
2489
|
export { DocsTable as D, EntityTechdocsContent as E, Reader as R, TechDocsPageWrapper as T, DocsCardGrid as a, TechDocsReaderPage$1 as b, TechDocsReaderLayout as c, TechDocsCustomHome as d, TechDocsIndexPage$2 as e, TechdocsPage as f, TechDocsReaderPage as g, techdocsStorageApiRef as h, techdocsApiRef as i, TechDocsClient as j, TechDocsStorageClient as k, TechDocsReaderProvider as l, TechDocsReaderPageHeader as m, TechDocsReaderPageContent as n, TechDocsReaderPageSubheader as o, TechDocsSearchResultListItem as p, TechDocsSearch as q, EntityListDocsGrid as r, EntityListDocsTable as s, techdocsPlugin as t, DefaultTechDocsHome as u, TechDocsPicker as v, isTechDocsAvailable as w, Router as x, EmbeddedDocsRouter as y };
|
|
2490
|
-
//# sourceMappingURL=index-
|
|
2490
|
+
//# sourceMappingURL=index-54417ed8.esm.js.map
|