@backstage/plugin-techdocs 1.10.4-next.1 → 1.10.5-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 +45 -0
- package/README.md +1 -1
- package/alpha/package.json +1 -1
- package/dist/EntityPageDocs.esm.js +23 -0
- package/dist/EntityPageDocs.esm.js.map +1 -0
- package/dist/Router.esm.js +47 -0
- package/dist/Router.esm.js.map +1 -0
- package/dist/alpha.esm.js +6 -7
- package/dist/alpha.esm.js.map +1 -1
- package/dist/api.esm.js +11 -0
- package/dist/api.esm.js.map +1 -0
- package/dist/{esm/routes-VopnMGN0.esm.js → client.esm.js} +2 -14
- package/dist/client.esm.js.map +1 -0
- package/dist/helpers.esm.js +8 -0
- package/dist/helpers.esm.js.map +1 -0
- package/dist/home/components/DefaultTechDocsHome.esm.js +15 -0
- package/dist/home/components/DefaultTechDocsHome.esm.js.map +1 -0
- package/dist/{esm/DocsCardGrid-AWTYz1vR.esm.js → home/components/Grids/DocsCardGrid.esm.js} +4 -4
- package/dist/home/components/Grids/DocsCardGrid.esm.js.map +1 -0
- package/dist/home/components/Grids/EntityListDocsGrid.esm.js +68 -0
- package/dist/home/components/Grids/EntityListDocsGrid.esm.js.map +1 -0
- package/dist/home/components/Tables/DocsTable.esm.js +87 -0
- package/dist/home/components/Tables/DocsTable.esm.js.map +1 -0
- package/dist/home/components/Tables/EntityListDocsTable.esm.js +50 -0
- package/dist/home/components/Tables/EntityListDocsTable.esm.js.map +1 -0
- package/dist/home/components/Tables/actions.esm.js +37 -0
- package/dist/home/components/Tables/actions.esm.js.map +1 -0
- package/dist/home/components/Tables/columns.esm.js +51 -0
- package/dist/home/components/Tables/columns.esm.js.map +1 -0
- package/dist/{esm/TechDocsCustomHome-CTmEWYTg.esm.js → home/components/TechDocsCustomHome.esm.js} +5 -17
- package/dist/home/components/TechDocsCustomHome.esm.js.map +1 -0
- package/dist/home/components/TechDocsIndexPage.esm.js +11 -0
- package/dist/home/components/TechDocsIndexPage.esm.js.map +1 -0
- package/dist/home/components/TechDocsPageWrapper.esm.js +22 -0
- package/dist/home/components/TechDocsPageWrapper.esm.js.map +1 -0
- package/dist/home/components/TechDocsPicker.esm.js +22 -0
- package/dist/home/components/TechDocsPicker.esm.js.map +1 -0
- package/dist/index.esm.js +17 -125
- package/dist/index.esm.js.map +1 -1
- package/dist/plugin.esm.js +97 -0
- package/dist/plugin.esm.js.map +1 -0
- package/dist/reader/components/TechDocsBuildLogs.esm.js +94 -0
- package/dist/reader/components/TechDocsBuildLogs.esm.js.map +1 -0
- package/dist/reader/components/TechDocsNotFound.esm.js +33 -0
- package/dist/reader/components/TechDocsNotFound.esm.js.map +1 -0
- package/dist/reader/components/TechDocsReaderPage/TechDocsReaderPage.esm.js +42 -0
- package/dist/reader/components/TechDocsReaderPage/TechDocsReaderPage.esm.js.map +1 -0
- package/dist/reader/components/TechDocsReaderPage/index.esm.js +2 -0
- package/dist/reader/components/TechDocsReaderPage/index.esm.js.map +1 -0
- package/dist/reader/components/TechDocsReaderPageContent/TechDocsReaderPageContent.esm.js +77 -0
- package/dist/reader/components/TechDocsReaderPageContent/TechDocsReaderPageContent.esm.js.map +1 -0
- package/dist/reader/components/TechDocsReaderPageContent/TechDocsReaderPageContentAddons.esm.js +43 -0
- package/dist/reader/components/TechDocsReaderPageContent/TechDocsReaderPageContentAddons.esm.js.map +1 -0
- package/dist/reader/components/TechDocsReaderPageContent/dom.esm.js +203 -0
- package/dist/reader/components/TechDocsReaderPageContent/dom.esm.js.map +1 -0
- package/dist/reader/components/TechDocsReaderPageContent/useNavigateUrl.esm.js +36 -0
- package/dist/reader/components/TechDocsReaderPageContent/useNavigateUrl.esm.js.map +1 -0
- package/dist/reader/components/TechDocsReaderPageHeader/TechDocsReaderPageHeader.esm.js +101 -0
- package/dist/reader/components/TechDocsReaderPageHeader/TechDocsReaderPageHeader.esm.js.map +1 -0
- package/dist/reader/components/TechDocsReaderPageSubheader/TechDocsReaderPageSubheader.esm.js +77 -0
- package/dist/reader/components/TechDocsReaderPageSubheader/TechDocsReaderPageSubheader.esm.js.map +1 -0
- package/dist/reader/components/TechDocsReaderProvider.esm.js +19 -0
- package/dist/reader/components/TechDocsReaderProvider.esm.js.map +1 -0
- package/dist/reader/components/TechDocsStateIndicator.esm.js +101 -0
- package/dist/reader/components/TechDocsStateIndicator.esm.js.map +1 -0
- package/dist/reader/components/useReaderState.esm.js +163 -0
- package/dist/reader/components/useReaderState.esm.js.map +1 -0
- package/dist/reader/transformers/addBaseUrl.esm.js +56 -0
- package/dist/reader/transformers/addBaseUrl.esm.js.map +1 -0
- package/dist/reader/transformers/addGitFeedbackLink.esm.js +53 -0
- package/dist/reader/transformers/addGitFeedbackLink.esm.js.map +1 -0
- package/dist/reader/transformers/addLinkClickListener.esm.js +23 -0
- package/dist/reader/transformers/addLinkClickListener.esm.js.map +1 -0
- package/dist/reader/transformers/addSidebarToggle.esm.js +27 -0
- package/dist/reader/transformers/addSidebarToggle.esm.js.map +1 -0
- package/dist/reader/transformers/copyToClipboard.esm.js +68 -0
- package/dist/reader/transformers/copyToClipboard.esm.js.map +1 -0
- package/dist/reader/transformers/html/hooks/iframes.esm.js +19 -0
- package/dist/reader/transformers/html/hooks/iframes.esm.js.map +1 -0
- package/dist/reader/transformers/html/hooks/links.esm.js +20 -0
- package/dist/reader/transformers/html/hooks/links.esm.js.map +1 -0
- package/dist/reader/transformers/html/transformer.esm.js +36 -0
- package/dist/reader/transformers/html/transformer.esm.js.map +1 -0
- package/dist/reader/transformers/onCssReady.esm.js +24 -0
- package/dist/reader/transformers/onCssReady.esm.js.map +1 -0
- package/dist/reader/transformers/removeMkdocsHeader.esm.js +10 -0
- package/dist/reader/transformers/removeMkdocsHeader.esm.js.map +1 -0
- package/dist/reader/transformers/renderReactElement.esm.js +18 -0
- package/dist/reader/transformers/renderReactElement.esm.js.map +1 -0
- package/dist/reader/transformers/rewriteDocLinks.esm.js +37 -0
- package/dist/reader/transformers/rewriteDocLinks.esm.js.map +1 -0
- package/dist/reader/transformers/scrollIntoNavigation.esm.js +21 -0
- package/dist/reader/transformers/scrollIntoNavigation.esm.js.map +1 -0
- package/dist/reader/transformers/simplifyMkdocsFooter.esm.js +11 -0
- package/dist/reader/transformers/simplifyMkdocsFooter.esm.js.map +1 -0
- package/dist/reader/transformers/styles/rules/animations.esm.js +13 -0
- package/dist/reader/transformers/styles/rules/animations.esm.js.map +1 -0
- package/dist/reader/transformers/styles/rules/extensions.esm.js +72 -0
- package/dist/reader/transformers/styles/rules/extensions.esm.js.map +1 -0
- package/dist/reader/transformers/styles/rules/layout.esm.js +224 -0
- package/dist/reader/transformers/styles/rules/layout.esm.js.map +1 -0
- package/dist/reader/transformers/styles/rules/reset.esm.js +14 -0
- package/dist/reader/transformers/styles/rules/reset.esm.js.map +1 -0
- package/dist/reader/transformers/styles/rules/rules.esm.js +18 -0
- package/dist/reader/transformers/styles/rules/rules.esm.js.map +1 -0
- package/dist/reader/transformers/styles/rules/typeset.esm.js +91 -0
- package/dist/reader/transformers/styles/rules/typeset.esm.js.map +1 -0
- package/dist/reader/transformers/styles/rules/variables.esm.js +126 -0
- package/dist/reader/transformers/styles/rules/variables.esm.js.map +1 -0
- package/dist/reader/transformers/styles/transformer.esm.js +27 -0
- package/dist/reader/transformers/styles/transformer.esm.js.map +1 -0
- package/dist/reader/transformers/transformer.esm.js +17 -0
- package/dist/reader/transformers/transformer.esm.js.map +1 -0
- package/dist/routes.esm.js +15 -0
- package/dist/routes.esm.js.map +1 -0
- package/dist/search/components/TechDocsSearch.esm.js +95 -0
- package/dist/search/components/TechDocsSearch.esm.js.map +1 -0
- package/dist/{esm/TechDocsSearchResultListItem-4Qzh5-3s.esm.js → search/components/TechDocsSearchResultListItem.esm.js} +1 -1
- package/dist/search/components/TechDocsSearchResultListItem.esm.js.map +1 -0
- package/package.json +20 -20
- package/dist/esm/DocsCardGrid-AWTYz1vR.esm.js.map +0 -1
- package/dist/esm/Router-jrzAl2lO.esm.js +0 -162
- package/dist/esm/Router-jrzAl2lO.esm.js.map +0 -1
- package/dist/esm/TechDocsCustomHome-CTmEWYTg.esm.js.map +0 -1
- package/dist/esm/TechDocsIndexPage-BCP1ggek.esm.js +0 -257
- package/dist/esm/TechDocsIndexPage-BCP1ggek.esm.js.map +0 -1
- package/dist/esm/TechDocsReaderPage-jsKVX28r.esm.js +0 -1925
- package/dist/esm/TechDocsReaderPage-jsKVX28r.esm.js.map +0 -1
- package/dist/esm/TechDocsSearchResultListItem-4Qzh5-3s.esm.js.map +0 -1
- package/dist/esm/index-up5BptkF.esm.js +0 -47
- package/dist/esm/index-up5BptkF.esm.js.map +0 -1
- package/dist/esm/routes-VopnMGN0.esm.js.map +0 -1
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import useCopyToClipboard from 'react-use/esm/useCopyToClipboard';
|
|
3
|
+
import { capitalize } from 'lodash';
|
|
4
|
+
import { WarningPanel, CodeSnippet } from '@backstage/core-components';
|
|
5
|
+
import { useEntityList, useStarredEntities } from '@backstage/plugin-catalog-react';
|
|
6
|
+
import { DocsTable } from './DocsTable.esm.js';
|
|
7
|
+
import { actionFactories } from './actions.esm.js';
|
|
8
|
+
import { columnFactories } from './columns.esm.js';
|
|
9
|
+
|
|
10
|
+
const EntityListDocsTable = (props) => {
|
|
11
|
+
var _a, _b;
|
|
12
|
+
const { columns, actions, options } = props;
|
|
13
|
+
const { loading, error, entities, filters } = useEntityList();
|
|
14
|
+
const { isStarredEntity, toggleStarredEntity } = useStarredEntities();
|
|
15
|
+
const [, copyToClipboard] = useCopyToClipboard();
|
|
16
|
+
const title = capitalize((_b = (_a = filters.user) == null ? void 0 : _a.value) != null ? _b : "all");
|
|
17
|
+
const defaultActions = [
|
|
18
|
+
actionFactories.createCopyDocsUrlAction(copyToClipboard),
|
|
19
|
+
actionFactories.createStarEntityAction(
|
|
20
|
+
isStarredEntity,
|
|
21
|
+
toggleStarredEntity
|
|
22
|
+
)
|
|
23
|
+
];
|
|
24
|
+
if (error) {
|
|
25
|
+
return /* @__PURE__ */ React.createElement(
|
|
26
|
+
WarningPanel,
|
|
27
|
+
{
|
|
28
|
+
severity: "error",
|
|
29
|
+
title: "Could not load available documentation."
|
|
30
|
+
},
|
|
31
|
+
/* @__PURE__ */ React.createElement(CodeSnippet, { language: "text", text: error.toString() })
|
|
32
|
+
);
|
|
33
|
+
}
|
|
34
|
+
return /* @__PURE__ */ React.createElement(
|
|
35
|
+
DocsTable,
|
|
36
|
+
{
|
|
37
|
+
title,
|
|
38
|
+
entities,
|
|
39
|
+
loading,
|
|
40
|
+
actions: actions || defaultActions,
|
|
41
|
+
columns,
|
|
42
|
+
options
|
|
43
|
+
}
|
|
44
|
+
);
|
|
45
|
+
};
|
|
46
|
+
EntityListDocsTable.columns = columnFactories;
|
|
47
|
+
EntityListDocsTable.actions = actionFactories;
|
|
48
|
+
|
|
49
|
+
export { EntityListDocsTable };
|
|
50
|
+
//# sourceMappingURL=EntityListDocsTable.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"EntityListDocsTable.esm.js","sources":["../../../../src/home/components/Tables/EntityListDocsTable.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 from 'react';\nimport useCopyToClipboard from 'react-use/esm/useCopyToClipboard';\nimport { capitalize } from 'lodash';\nimport {\n CodeSnippet,\n TableColumn,\n TableOptions,\n TableProps,\n WarningPanel,\n} from '@backstage/core-components';\nimport {\n useEntityList,\n useStarredEntities,\n} from '@backstage/plugin-catalog-react';\nimport { DocsTable } from './DocsTable';\nimport { actionFactories } from './actions';\nimport { columnFactories } from './columns';\nimport { DocsTableRow } from './types';\n\n/**\n * Props for {@link EntityListDocsTable}.\n *\n * @public\n */\nexport type EntityListDocsTableProps = {\n columns?: TableColumn<DocsTableRow>[];\n actions?: TableProps<DocsTableRow>['actions'];\n options?: TableOptions<DocsTableRow>;\n};\n\n/**\n * Component which renders a table with entities from catalog.\n *\n * @public\n */\nexport const EntityListDocsTable = (props: EntityListDocsTableProps) => {\n const { columns, actions, options } = props;\n const { loading, error, entities, filters } = useEntityList();\n const { isStarredEntity, toggleStarredEntity } = useStarredEntities();\n const [, copyToClipboard] = useCopyToClipboard();\n\n const title = capitalize(filters.user?.value ?? 'all');\n\n const defaultActions = [\n actionFactories.createCopyDocsUrlAction(copyToClipboard),\n actionFactories.createStarEntityAction(\n isStarredEntity,\n toggleStarredEntity,\n ),\n ];\n\n if (error) {\n return (\n <WarningPanel\n severity=\"error\"\n title=\"Could not load available documentation.\"\n >\n <CodeSnippet language=\"text\" text={error.toString()} />\n </WarningPanel>\n );\n }\n\n return (\n <DocsTable\n title={title}\n entities={entities}\n loading={loading}\n actions={actions || defaultActions}\n columns={columns}\n options={options}\n />\n );\n};\n\nEntityListDocsTable.columns = columnFactories;\nEntityListDocsTable.actions = actionFactories;\n"],"names":[],"mappings":";;;;;;;;;AAmDa,MAAA,mBAAA,GAAsB,CAAC,KAAoC,KAAA;AAnDxE,EAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAoDE,EAAA,MAAM,EAAE,OAAA,EAAS,OAAS,EAAA,OAAA,EAAY,GAAA,KAAA,CAAA;AACtC,EAAA,MAAM,EAAE,OAAS,EAAA,KAAA,EAAO,QAAU,EAAA,OAAA,KAAY,aAAc,EAAA,CAAA;AAC5D,EAAA,MAAM,EAAE,eAAA,EAAiB,mBAAoB,EAAA,GAAI,kBAAmB,EAAA,CAAA;AACpE,EAAA,MAAM,GAAG,eAAe,CAAA,GAAI,kBAAmB,EAAA,CAAA;AAE/C,EAAA,MAAM,QAAQ,UAAW,CAAA,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,OAAA,CAAQ,SAAR,IAAc,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,KAAA,KAAd,YAAuB,KAAK,CAAA,CAAA;AAErD,EAAA,MAAM,cAAiB,GAAA;AAAA,IACrB,eAAA,CAAgB,wBAAwB,eAAe,CAAA;AAAA,IACvD,eAAgB,CAAA,sBAAA;AAAA,MACd,eAAA;AAAA,MACA,mBAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAA,IAAI,KAAO,EAAA;AACT,IACE,uBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,YAAA;AAAA,MAAA;AAAA,QACC,QAAS,EAAA,OAAA;AAAA,QACT,KAAM,EAAA,yCAAA;AAAA,OAAA;AAAA,0CAEL,WAAY,EAAA,EAAA,QAAA,EAAS,QAAO,IAAM,EAAA,KAAA,CAAM,UAAY,EAAA,CAAA;AAAA,KACvD,CAAA;AAAA,GAEJ;AAEA,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,SAAA;AAAA,IAAA;AAAA,MACC,KAAA;AAAA,MACA,QAAA;AAAA,MACA,OAAA;AAAA,MACA,SAAS,OAAW,IAAA,cAAA;AAAA,MACpB,OAAA;AAAA,MACA,OAAA;AAAA,KAAA;AAAA,GACF,CAAA;AAEJ,EAAA;AAEA,mBAAA,CAAoB,OAAU,GAAA,eAAA,CAAA;AAC9B,mBAAA,CAAoB,OAAU,GAAA,eAAA;;;;"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import ShareIcon from '@material-ui/icons/Share';
|
|
3
|
+
import { withStyles } from '@material-ui/core/styles';
|
|
4
|
+
import Star from '@material-ui/icons/Star';
|
|
5
|
+
import StarBorder from '@material-ui/icons/StarBorder';
|
|
6
|
+
|
|
7
|
+
const YellowStar = withStyles({
|
|
8
|
+
root: {
|
|
9
|
+
color: "#f3ba37"
|
|
10
|
+
}
|
|
11
|
+
})(Star);
|
|
12
|
+
const actionFactories = {
|
|
13
|
+
createCopyDocsUrlAction(copyToClipboard) {
|
|
14
|
+
return (row) => {
|
|
15
|
+
return {
|
|
16
|
+
icon: () => /* @__PURE__ */ React.createElement(ShareIcon, { fontSize: "small" }),
|
|
17
|
+
tooltip: "Click to copy documentation link to clipboard",
|
|
18
|
+
onClick: () => copyToClipboard(`${window.location.origin}${row.resolved.docsUrl}`)
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
},
|
|
22
|
+
createStarEntityAction(isStarredEntity, toggleStarredEntity) {
|
|
23
|
+
return (row) => {
|
|
24
|
+
const entity = row.entity;
|
|
25
|
+
const isStarred = isStarredEntity(entity);
|
|
26
|
+
return {
|
|
27
|
+
cellStyle: { paddingLeft: "1em" },
|
|
28
|
+
icon: () => isStarred ? /* @__PURE__ */ React.createElement(YellowStar, null) : /* @__PURE__ */ React.createElement(StarBorder, null),
|
|
29
|
+
tooltip: isStarred ? "Remove from favorites" : "Add to favorites",
|
|
30
|
+
onClick: () => toggleStarredEntity(entity)
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
};
|
|
35
|
+
|
|
36
|
+
export { actionFactories };
|
|
37
|
+
//# sourceMappingURL=actions.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"actions.esm.js","sources":["../../../../src/home/components/Tables/actions.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 from 'react';\nimport ShareIcon from '@material-ui/icons/Share';\nimport { DocsTableRow } from './types';\nimport { withStyles } from '@material-ui/core/styles';\nimport Star from '@material-ui/icons/Star';\nimport StarBorder from '@material-ui/icons/StarBorder';\n\nconst YellowStar = withStyles({\n root: {\n color: '#f3ba37',\n },\n})(Star);\n\n/**\n * Not directly exported, but through DocsTable.actions and EntityListDocsTable.actions\n *\n * @public\n */\nexport const actionFactories = {\n createCopyDocsUrlAction(copyToClipboard: Function) {\n return (row: DocsTableRow) => {\n return {\n icon: () => <ShareIcon fontSize=\"small\" />,\n tooltip: 'Click to copy documentation link to clipboard',\n onClick: () =>\n copyToClipboard(`${window.location.origin}${row.resolved.docsUrl}`),\n };\n };\n },\n createStarEntityAction(\n isStarredEntity: Function,\n toggleStarredEntity: Function,\n ) {\n return (row: DocsTableRow) => {\n const entity = row.entity;\n const isStarred = isStarredEntity(entity);\n return {\n cellStyle: { paddingLeft: '1em' },\n icon: () => (isStarred ? <YellowStar /> : <StarBorder />),\n tooltip: isStarred ? 'Remove from favorites' : 'Add to favorites',\n onClick: () => toggleStarredEntity(entity),\n };\n };\n },\n};\n"],"names":[],"mappings":";;;;;;AAuBA,MAAM,aAAa,UAAW,CAAA;AAAA,EAC5B,IAAM,EAAA;AAAA,IACJ,KAAO,EAAA,SAAA;AAAA,GACT;AACF,CAAC,EAAE,IAAI,CAAA,CAAA;AAOA,MAAM,eAAkB,GAAA;AAAA,EAC7B,wBAAwB,eAA2B,EAAA;AACjD,IAAA,OAAO,CAAC,GAAsB,KAAA;AAC5B,MAAO,OAAA;AAAA,QACL,IAAM,EAAA,sBAAO,KAAA,CAAA,aAAA,CAAA,SAAA,EAAA,EAAU,UAAS,OAAQ,EAAA,CAAA;AAAA,QACxC,OAAS,EAAA,+CAAA;AAAA,QACT,OAAA,EAAS,MACP,eAAA,CAAgB,CAAG,EAAA,MAAA,CAAO,QAAS,CAAA,MAAM,CAAG,EAAA,GAAA,CAAI,QAAS,CAAA,OAAO,CAAE,CAAA,CAAA;AAAA,OACtE,CAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EACA,sBAAA,CACE,iBACA,mBACA,EAAA;AACA,IAAA,OAAO,CAAC,GAAsB,KAAA;AAC5B,MAAA,MAAM,SAAS,GAAI,CAAA,MAAA,CAAA;AACnB,MAAM,MAAA,SAAA,GAAY,gBAAgB,MAAM,CAAA,CAAA;AACxC,MAAO,OAAA;AAAA,QACL,SAAA,EAAW,EAAE,WAAA,EAAa,KAAM,EAAA;AAAA,QAChC,MAAM,MAAO,SAAA,uCAAa,UAAW,EAAA,IAAA,CAAA,uCAAM,UAAW,EAAA,IAAA,CAAA;AAAA,QACtD,OAAA,EAAS,YAAY,uBAA0B,GAAA,kBAAA;AAAA,QAC/C,OAAA,EAAS,MAAM,mBAAA,CAAoB,MAAM,CAAA;AAAA,OAC3C,CAAA;AAAA,KACF,CAAA;AAAA,GACF;AACF;;;;"}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { SubvalueCell, Link } from '@backstage/core-components';
|
|
3
|
+
import { EntityRefLinks } from '@backstage/plugin-catalog-react';
|
|
4
|
+
|
|
5
|
+
function customTitle(entity) {
|
|
6
|
+
return entity.metadata.title || entity.metadata.name;
|
|
7
|
+
}
|
|
8
|
+
const columnFactories = {
|
|
9
|
+
createNameColumn() {
|
|
10
|
+
return {
|
|
11
|
+
title: "Document",
|
|
12
|
+
field: "entity.metadata.name",
|
|
13
|
+
highlight: true,
|
|
14
|
+
render: (row) => /* @__PURE__ */ React.createElement(
|
|
15
|
+
SubvalueCell,
|
|
16
|
+
{
|
|
17
|
+
value: /* @__PURE__ */ React.createElement(Link, { to: row.resolved.docsUrl }, customTitle(row.entity)),
|
|
18
|
+
subvalue: row.entity.metadata.description
|
|
19
|
+
}
|
|
20
|
+
)
|
|
21
|
+
};
|
|
22
|
+
},
|
|
23
|
+
createOwnerColumn() {
|
|
24
|
+
return {
|
|
25
|
+
title: "Owner",
|
|
26
|
+
field: "resolved.ownedByRelationsTitle",
|
|
27
|
+
render: ({ resolved }) => /* @__PURE__ */ React.createElement(
|
|
28
|
+
EntityRefLinks,
|
|
29
|
+
{
|
|
30
|
+
entityRefs: resolved.ownedByRelations,
|
|
31
|
+
defaultKind: "group"
|
|
32
|
+
}
|
|
33
|
+
)
|
|
34
|
+
};
|
|
35
|
+
},
|
|
36
|
+
createKindColumn() {
|
|
37
|
+
return {
|
|
38
|
+
title: "Kind",
|
|
39
|
+
field: "entity.kind"
|
|
40
|
+
};
|
|
41
|
+
},
|
|
42
|
+
createTypeColumn() {
|
|
43
|
+
return {
|
|
44
|
+
title: "Type",
|
|
45
|
+
field: "entity.spec.type"
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
export { columnFactories };
|
|
51
|
+
//# sourceMappingURL=columns.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"columns.esm.js","sources":["../../../../src/home/components/Tables/columns.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 from 'react';\nimport { Link, SubvalueCell, TableColumn } from '@backstage/core-components';\nimport { EntityRefLinks } from '@backstage/plugin-catalog-react';\nimport { Entity } from '@backstage/catalog-model';\nimport { DocsTableRow } from './types';\n\nfunction customTitle(entity: Entity): string {\n return entity.metadata.title || entity.metadata.name;\n}\n\n/**\n * Not directly exported, but through DocsTable.columns and EntityListDocsTable.columns\n *\n * @public\n */\nexport const columnFactories = {\n createNameColumn(): TableColumn<DocsTableRow> {\n return {\n title: 'Document',\n field: 'entity.metadata.name',\n highlight: true,\n render: (row: DocsTableRow) => (\n <SubvalueCell\n value={\n <Link to={row.resolved.docsUrl}>{customTitle(row.entity)}</Link>\n }\n subvalue={row.entity.metadata.description}\n />\n ),\n };\n },\n createOwnerColumn(): TableColumn<DocsTableRow> {\n return {\n title: 'Owner',\n field: 'resolved.ownedByRelationsTitle',\n render: ({ resolved }) => (\n <EntityRefLinks\n entityRefs={resolved.ownedByRelations}\n defaultKind=\"group\"\n />\n ),\n };\n },\n createKindColumn(): TableColumn<DocsTableRow> {\n return {\n title: 'Kind',\n field: 'entity.kind',\n };\n },\n createTypeColumn(): TableColumn<DocsTableRow> {\n return {\n title: 'Type',\n field: 'entity.spec.type',\n };\n },\n};\n"],"names":[],"mappings":";;;;AAsBA,SAAS,YAAY,MAAwB,EAAA;AAC3C,EAAA,OAAO,MAAO,CAAA,QAAA,CAAS,KAAS,IAAA,MAAA,CAAO,QAAS,CAAA,IAAA,CAAA;AAClD,CAAA;AAOO,MAAM,eAAkB,GAAA;AAAA,EAC7B,gBAA8C,GAAA;AAC5C,IAAO,OAAA;AAAA,MACL,KAAO,EAAA,UAAA;AAAA,MACP,KAAO,EAAA,sBAAA;AAAA,MACP,SAAW,EAAA,IAAA;AAAA,MACX,MAAA,EAAQ,CAAC,GACP,qBAAA,KAAA,CAAA,aAAA;AAAA,QAAC,YAAA;AAAA,QAAA;AAAA,UACC,KAAA,kBACG,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,EAAI,EAAA,GAAA,CAAI,SAAS,OAAU,EAAA,EAAA,WAAA,CAAY,GAAI,CAAA,MAAM,CAAE,CAAA;AAAA,UAE3D,QAAA,EAAU,GAAI,CAAA,MAAA,CAAO,QAAS,CAAA,WAAA;AAAA,SAAA;AAAA,OAChC;AAAA,KAEJ,CAAA;AAAA,GACF;AAAA,EACA,iBAA+C,GAAA;AAC7C,IAAO,OAAA;AAAA,MACL,KAAO,EAAA,OAAA;AAAA,MACP,KAAO,EAAA,gCAAA;AAAA,MACP,MAAQ,EAAA,CAAC,EAAE,QAAA,EACT,qBAAA,KAAA,CAAA,aAAA;AAAA,QAAC,cAAA;AAAA,QAAA;AAAA,UACC,YAAY,QAAS,CAAA,gBAAA;AAAA,UACrB,WAAY,EAAA,OAAA;AAAA,SAAA;AAAA,OACd;AAAA,KAEJ,CAAA;AAAA,GACF;AAAA,EACA,gBAA8C,GAAA;AAC5C,IAAO,OAAA;AAAA,MACL,KAAO,EAAA,MAAA;AAAA,MACP,KAAO,EAAA,aAAA;AAAA,KACT,CAAA;AAAA,GACF;AAAA,EACA,gBAA8C,GAAA;AAC5C,IAAO,OAAA;AAAA,MACL,KAAO,EAAA,MAAA;AAAA,MACP,KAAO,EAAA,kBAAA;AAAA,KACT,CAAA;AAAA,GACF;AACF;;;;"}
|
package/dist/{esm/TechDocsCustomHome-CTmEWYTg.esm.js → home/components/TechDocsCustomHome.esm.js}
RENAMED
|
@@ -2,25 +2,13 @@ import React, { useState } from 'react';
|
|
|
2
2
|
import useAsync from 'react-use/esm/useAsync';
|
|
3
3
|
import { makeStyles } from '@material-ui/core/styles';
|
|
4
4
|
import { catalogApiRef, CATALOG_FILTER_EXISTS, useEntityOwnership } from '@backstage/plugin-catalog-react';
|
|
5
|
-
import
|
|
6
|
-
import {
|
|
5
|
+
import './Tables/EntityListDocsTable.esm.js';
|
|
6
|
+
import { DocsTable } from './Tables/DocsTable.esm.js';
|
|
7
|
+
import { DocsCardGrid } from './Grids/DocsCardGrid.esm.js';
|
|
7
8
|
import { Content, Progress, WarningPanel, CodeSnippet, HeaderTabs, ContentHeader, SupportButton } from '@backstage/core-components';
|
|
8
9
|
import '@material-ui/core/Typography';
|
|
10
|
+
import { TechDocsPageWrapper } from './TechDocsPageWrapper.esm.js';
|
|
9
11
|
import { useApi } from '@backstage/core-plugin-api';
|
|
10
|
-
import 'react-router-dom';
|
|
11
|
-
import 'react-use/esm/useCopyToClipboard';
|
|
12
|
-
import 'lodash';
|
|
13
|
-
import '@backstage/catalog-model';
|
|
14
|
-
import './routes-VopnMGN0.esm.js';
|
|
15
|
-
import '@backstage/errors';
|
|
16
|
-
import 'event-source-polyfill';
|
|
17
|
-
import '@material-ui/icons/Share';
|
|
18
|
-
import '@material-ui/icons/Star';
|
|
19
|
-
import '@material-ui/icons/StarBorder';
|
|
20
|
-
import '@material-ui/core/Card';
|
|
21
|
-
import '@material-ui/core/CardActions';
|
|
22
|
-
import '@material-ui/core/CardContent';
|
|
23
|
-
import '@material-ui/core/CardMedia';
|
|
24
12
|
|
|
25
13
|
const panels = {
|
|
26
14
|
DocsTable,
|
|
@@ -114,4 +102,4 @@ const TechDocsCustomHome = (props) => {
|
|
|
114
102
|
};
|
|
115
103
|
|
|
116
104
|
export { TechDocsCustomHome };
|
|
117
|
-
//# sourceMappingURL=TechDocsCustomHome
|
|
105
|
+
//# sourceMappingURL=TechDocsCustomHome.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"TechDocsCustomHome.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/esm/useAsync';\nimport { makeStyles } from '@material-ui/core/styles';\nimport { CSSProperties } from '@material-ui/styles/withStyles';\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,MAAO,CAAA,MAAA,CAAO,SAAS,CAAA,CAAA;AAErC,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,uBAEI,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,aAAc,EAAA,EAAA,KAAA,EAAO,MAAO,CAAA,KAAA,EAAO,WAAa,EAAA,MAAA,CAAO,WACrD,EAAA,EAAA,KAAA,KAAU,CACT,mBAAA,KAAA,CAAA,aAAA,CAAC,aAAc,EAAA,IAAA,EAAA,2CAEf,CACE,GAAA,IACN,CACA,kBAAA,KAAA,CAAA,aAAA,CAAC,KAAI,EAAA,EAAA,SAAA,EAAW,OAAQ,CAAA,cAAA,EAAA,kBACrB,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA,EAAM,aAAY,EAAA,uBAAA,EAAwB,QAAU,EAAA,aAAA,EAAe,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,EAAM,MAAA,gBAAA,GAAmB,WAAW,WAAW,CAAA,CAAA;AAE/C,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,IACE,uBAAA,KAAA,CAAA,aAAA,CAAC,mBACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,OACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,YAAA;AAAA,MAAA;AAAA,QACC,QAAS,EAAA,OAAA;AAAA,QACT,KAAM,EAAA,yCAAA;AAAA,OAAA;AAAA,0CAEL,WAAY,EAAA,EAAA,QAAA,EAAS,QAAO,IAAM,EAAA,KAAA,CAAM,UAAY,EAAA,CAAA;AAAA,KAEzD,CACF,CAAA,CAAA;AAAA,GAEJ;AAEA,EAAA,2CACG,mBACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,UAAA;AAAA,IAAA;AAAA,MACC,aAAe,EAAA,WAAA;AAAA,MACf,QAAA,EAAU,CAAS,KAAA,KAAA,cAAA,CAAe,KAAK,CAAA;AAAA,MACvC,MAAM,UAAW,CAAA,GAAA,CAAI,CAAC,EAAE,KAAA,IAAS,KAAW,MAAA;AAAA,QAC1C,EAAA,EAAI,MAAM,QAAS,EAAA;AAAA,QACnB,KAAA;AAAA,OACA,CAAA,CAAA;AAAA,KAAA;AAAA,GACJ,kBACC,KAAA,CAAA,aAAA,CAAA,OAAA,EAAA,EAAQ,aAAY,EAAA,kBAAA,EAAA,EAClB,iBAAiB,MAAO,CAAA,GAAA,CAAI,CAAC,MAAA,EAAQ,KACpC,qBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,WAAA;AAAA,IAAA;AAAA,MACC,GAAK,EAAA,KAAA;AAAA,MACL,MAAA;AAAA,MACA,QAAU,EAAA,CAAC,CAAC,QAAA,GAAW,WAAW,EAAC;AAAA,MACnC,KAAA;AAAA,KAAA;AAAA,GAEH,CACH,CACF,CAAA,CAAA;AAEJ;;;;"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { useOutlet } from 'react-router-dom';
|
|
3
|
+
import { DefaultTechDocsHome } from './DefaultTechDocsHome.esm.js';
|
|
4
|
+
|
|
5
|
+
const TechDocsIndexPage = (props) => {
|
|
6
|
+
const outlet = useOutlet();
|
|
7
|
+
return outlet || /* @__PURE__ */ React.createElement(DefaultTechDocsHome, { ...props });
|
|
8
|
+
};
|
|
9
|
+
|
|
10
|
+
export { TechDocsIndexPage };
|
|
11
|
+
//# sourceMappingURL=TechDocsIndexPage.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"TechDocsIndexPage.esm.js","sources":["../../../src/home/components/TechDocsIndexPage.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 from 'react';\nimport { useOutlet } from 'react-router-dom';\nimport { TableColumn, TableProps } from '@backstage/core-components';\nimport { UserListFilterKind } from '@backstage/plugin-catalog-react';\nimport { DefaultTechDocsHome } from './DefaultTechDocsHome';\nimport { DocsTableRow } from './Tables';\n\n/**\n * Props for {@link TechDocsIndexPage}\n *\n * @public\n */\nexport type TechDocsIndexPageProps = {\n initialFilter?: UserListFilterKind;\n columns?: TableColumn<DocsTableRow>[];\n actions?: TableProps<DocsTableRow>['actions'];\n};\n\nexport const TechDocsIndexPage = (props: TechDocsIndexPageProps) => {\n const outlet = useOutlet();\n\n return outlet || <DefaultTechDocsHome {...props} />;\n};\n"],"names":[],"mappings":";;;;AAkCa,MAAA,iBAAA,GAAoB,CAAC,KAAkC,KAAA;AAClE,EAAA,MAAM,SAAS,SAAU,EAAA,CAAA;AAEzB,EAAA,OAAO,MAAU,oBAAA,KAAA,CAAA,aAAA,CAAC,mBAAqB,EAAA,EAAA,GAAG,KAAO,EAAA,CAAA,CAAA;AACnD;;;;"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { PageWithHeader } from '@backstage/core-components';
|
|
3
|
+
import { useApi, configApiRef } from '@backstage/core-plugin-api';
|
|
4
|
+
|
|
5
|
+
const TechDocsPageWrapper = (props) => {
|
|
6
|
+
var _a;
|
|
7
|
+
const { children } = props;
|
|
8
|
+
const configApi = useApi(configApiRef);
|
|
9
|
+
const generatedSubtitle = `Documentation available in ${(_a = configApi.getOptionalString("organization.name")) != null ? _a : "Backstage"}`;
|
|
10
|
+
return /* @__PURE__ */ React.createElement(
|
|
11
|
+
PageWithHeader,
|
|
12
|
+
{
|
|
13
|
+
title: "Documentation",
|
|
14
|
+
subtitle: generatedSubtitle,
|
|
15
|
+
themeId: "documentation"
|
|
16
|
+
},
|
|
17
|
+
children
|
|
18
|
+
);
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
export { TechDocsPageWrapper };
|
|
22
|
+
//# sourceMappingURL=TechDocsPageWrapper.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"TechDocsPageWrapper.esm.js","sources":["../../../src/home/components/TechDocsPageWrapper.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 from 'react';\n\nimport { PageWithHeader } from '@backstage/core-components';\nimport { useApi, configApiRef } from '@backstage/core-plugin-api';\n\n/**\n * Props for {@link TechDocsPageWrapper}\n *\n * @public\n */\nexport type TechDocsPageWrapperProps = {\n children?: React.ReactNode;\n};\n\n/**\n * Component wrapping a TechDocs page with Page and Header components\n *\n * @public\n */\nexport const TechDocsPageWrapper = (props: TechDocsPageWrapperProps) => {\n const { children } = props;\n const configApi = useApi(configApiRef);\n const generatedSubtitle = `Documentation available in ${\n configApi.getOptionalString('organization.name') ?? 'Backstage'\n }`;\n\n return (\n <PageWithHeader\n title=\"Documentation\"\n subtitle={generatedSubtitle}\n themeId=\"documentation\"\n >\n {children}\n </PageWithHeader>\n );\n};\n"],"names":[],"mappings":";;;;AAmCa,MAAA,mBAAA,GAAsB,CAAC,KAAoC,KAAA;AAnCxE,EAAA,IAAA,EAAA,CAAA;AAoCE,EAAM,MAAA,EAAE,UAAa,GAAA,KAAA,CAAA;AACrB,EAAM,MAAA,SAAA,GAAY,OAAO,YAAY,CAAA,CAAA;AACrC,EAAA,MAAM,oBAAoB,CACxB,2BAAA,EAAA,CAAA,EAAA,GAAA,SAAA,CAAU,kBAAkB,mBAAmB,CAAA,KAA/C,YAAoD,WACtD,CAAA,CAAA,CAAA;AAEA,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,cAAA;AAAA,IAAA;AAAA,MACC,KAAM,EAAA,eAAA;AAAA,MACN,QAAU,EAAA,iBAAA;AAAA,MACV,OAAQ,EAAA,eAAA;AAAA,KAAA;AAAA,IAEP,QAAA;AAAA,GACH,CAAA;AAEJ;;;;"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { useEffect } from 'react';
|
|
2
|
+
import { useEntityList, CATALOG_FILTER_EXISTS } from '@backstage/plugin-catalog-react';
|
|
3
|
+
|
|
4
|
+
class TechDocsFilter {
|
|
5
|
+
getCatalogFilters() {
|
|
6
|
+
return {
|
|
7
|
+
"metadata.annotations.backstage.io/techdocs-ref": CATALOG_FILTER_EXISTS
|
|
8
|
+
};
|
|
9
|
+
}
|
|
10
|
+
}
|
|
11
|
+
const TechDocsPicker = () => {
|
|
12
|
+
const { updateFilters } = useEntityList();
|
|
13
|
+
useEffect(() => {
|
|
14
|
+
updateFilters({
|
|
15
|
+
techdocs: new TechDocsFilter()
|
|
16
|
+
});
|
|
17
|
+
}, [updateFilters]);
|
|
18
|
+
return null;
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
export { TechDocsPicker };
|
|
22
|
+
//# sourceMappingURL=TechDocsPicker.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"TechDocsPicker.esm.js","sources":["../../../src/home/components/TechDocsPicker.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 { useEffect } from 'react';\nimport {\n CATALOG_FILTER_EXISTS,\n DefaultEntityFilters,\n EntityFilter,\n useEntityList,\n} from '@backstage/plugin-catalog-react';\n\nclass TechDocsFilter implements EntityFilter {\n getCatalogFilters(): Record<string, string | symbol | (string | symbol)[]> {\n return {\n 'metadata.annotations.backstage.io/techdocs-ref': CATALOG_FILTER_EXISTS,\n };\n }\n}\n\ntype CustomFilters = DefaultEntityFilters & {\n techdocs?: TechDocsFilter;\n};\n\n/**\n * Component responsible for updating TechDocs filters\n *\n * @public\n */\nexport const TechDocsPicker = () => {\n const { updateFilters } = useEntityList<CustomFilters>();\n\n useEffect(() => {\n updateFilters({\n techdocs: new TechDocsFilter(),\n });\n }, [updateFilters]);\n\n return null;\n};\n"],"names":[],"mappings":";;;AAwBA,MAAM,cAAuC,CAAA;AAAA,EAC3C,iBAA2E,GAAA;AACzE,IAAO,OAAA;AAAA,MACL,gDAAkD,EAAA,qBAAA;AAAA,KACpD,CAAA;AAAA,GACF;AACF,CAAA;AAWO,MAAM,iBAAiB,MAAM;AAClC,EAAM,MAAA,EAAE,aAAc,EAAA,GAAI,aAA6B,EAAA,CAAA;AAEvD,EAAA,SAAA,CAAU,MAAM;AACd,IAAc,aAAA,CAAA;AAAA,MACZ,QAAA,EAAU,IAAI,cAAe,EAAA;AAAA,KAC9B,CAAA,CAAA;AAAA,GACH,EAAG,CAAC,aAAa,CAAC,CAAA,CAAA;AAElB,EAAO,OAAA,IAAA,CAAA;AACT;;;;"}
|
package/dist/index.esm.js
CHANGED
|
@@ -1,126 +1,18 @@
|
|
|
1
|
-
|
|
2
|
-
export {
|
|
3
|
-
export {
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
export {
|
|
10
|
-
export {
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
import './esm/TechDocsSearchResultListItem-4Qzh5-3s.esm.js';
|
|
19
|
-
import '@material-ui/core/ListItemIcon';
|
|
20
|
-
import '@material-ui/core/ListItemText';
|
|
21
|
-
import '@material-ui/core/CircularProgress';
|
|
22
|
-
import '@material-ui/core/Button';
|
|
23
|
-
import '@material-ui/lab/Alert';
|
|
24
|
-
import '@material-ui/core/Drawer';
|
|
25
|
-
import '@material-ui/core/IconButton';
|
|
26
|
-
import '@material-ui/icons/Close';
|
|
27
|
-
import 'react-use/esm/useAsync';
|
|
28
|
-
import 'react-use/esm/useAsyncRetry';
|
|
29
|
-
import '@material-ui/core/useMediaQuery';
|
|
30
|
-
import '@backstage/integration-react';
|
|
31
|
-
import 'dompurify';
|
|
32
|
-
import '@backstage/integration';
|
|
33
|
-
import '@material-ui/icons/FeedbackOutlined';
|
|
34
|
-
import 'git-url-parse';
|
|
35
|
-
import '@material-ui/icons/Menu';
|
|
36
|
-
import '@material-ui/core/SvgIcon';
|
|
37
|
-
import '@material-ui/core/Tooltip';
|
|
38
|
-
import 'react-use/esm/useCopyToClipboard';
|
|
39
|
-
import '@material-ui/core/Portal';
|
|
40
|
-
import 'react-helmet';
|
|
41
|
-
import '@material-ui/lab/Skeleton';
|
|
42
|
-
import '@material-ui/icons/Code';
|
|
43
|
-
import '@backstage/catalog-model';
|
|
44
|
-
import 'lodash';
|
|
45
|
-
import '@material-ui/core/Toolbar';
|
|
46
|
-
import '@material-ui/core/Menu';
|
|
47
|
-
import '@material-ui/core/Box';
|
|
48
|
-
import '@material-ui/icons/Settings';
|
|
49
|
-
import '@backstage/plugin-auth-react';
|
|
50
|
-
import '@material-ui/core/Card';
|
|
51
|
-
import '@material-ui/core/CardActions';
|
|
52
|
-
import '@material-ui/core/CardContent';
|
|
53
|
-
import '@material-ui/core/CardMedia';
|
|
54
|
-
import '@material-ui/icons/Share';
|
|
55
|
-
import '@material-ui/icons/Star';
|
|
56
|
-
import '@material-ui/icons/StarBorder';
|
|
57
|
-
|
|
58
|
-
const techdocsStorageApiRef = createApiRef({
|
|
59
|
-
id: "plugin.techdocs.storageservice"
|
|
60
|
-
});
|
|
61
|
-
const techdocsApiRef = createApiRef({
|
|
62
|
-
id: "plugin.techdocs.service"
|
|
63
|
-
});
|
|
64
|
-
|
|
65
|
-
const allEntitiesGroup = {
|
|
66
|
-
title: "All Documentation",
|
|
67
|
-
filterPredicate: () => true
|
|
68
|
-
};
|
|
69
|
-
const EntityListDocsGridGroup = (props) => {
|
|
70
|
-
const { entities, group } = props;
|
|
71
|
-
const { loading: loadingOwnership, isOwnedEntity } = useEntityOwnership();
|
|
72
|
-
const shownEntities = entities.filter((entity) => {
|
|
73
|
-
if (group.filterPredicate === "ownedByUser") {
|
|
74
|
-
if (loadingOwnership) {
|
|
75
|
-
return false;
|
|
76
|
-
}
|
|
77
|
-
return isOwnedEntity(entity);
|
|
78
|
-
}
|
|
79
|
-
return typeof group.filterPredicate === "function" && group.filterPredicate(entity);
|
|
80
|
-
});
|
|
81
|
-
const titleComponent = (() => {
|
|
82
|
-
return typeof group.title === "string" ? /* @__PURE__ */ React.createElement(ContentHeader, { title: group.title }) : group.title;
|
|
83
|
-
})();
|
|
84
|
-
if (shownEntities.length === 0) {
|
|
85
|
-
return null;
|
|
86
|
-
}
|
|
87
|
-
return /* @__PURE__ */ React.createElement(Content, null, titleComponent, /* @__PURE__ */ React.createElement(DocsCardGrid, { entities: shownEntities }));
|
|
88
|
-
};
|
|
89
|
-
const EntityListDocsGrid = (props) => {
|
|
90
|
-
const { loading, error, entities } = useEntityList();
|
|
91
|
-
if (error) {
|
|
92
|
-
return /* @__PURE__ */ React.createElement(
|
|
93
|
-
WarningPanel,
|
|
94
|
-
{
|
|
95
|
-
severity: "error",
|
|
96
|
-
title: "Could not load available documentation."
|
|
97
|
-
},
|
|
98
|
-
/* @__PURE__ */ React.createElement(CodeSnippet, { language: "text", text: error.toString() })
|
|
99
|
-
);
|
|
100
|
-
}
|
|
101
|
-
if (loading) {
|
|
102
|
-
return /* @__PURE__ */ React.createElement(Progress, null);
|
|
103
|
-
}
|
|
104
|
-
if (entities.length === 0) {
|
|
105
|
-
return /* @__PURE__ */ React.createElement("div", { "data-testid": "doc-not-found" }, /* @__PURE__ */ React.createElement(Typography, { variant: "body2" }, "No documentation found that match your filter. Learn more about", " ", /* @__PURE__ */ React.createElement(Link, { to: "https://backstage.io/docs/features/techdocs/creating-and-publishing" }, "publishing documentation"), "."));
|
|
106
|
-
}
|
|
107
|
-
entities.sort(
|
|
108
|
-
(a, b) => {
|
|
109
|
-
var _a, _b;
|
|
110
|
-
return ((_a = a.metadata.title) != null ? _a : a.metadata.name).localeCompare(
|
|
111
|
-
(_b = b.metadata.title) != null ? _b : b.metadata.name
|
|
112
|
-
);
|
|
113
|
-
}
|
|
114
|
-
);
|
|
115
|
-
return /* @__PURE__ */ React.createElement(Content, null, (props.groups || [allEntitiesGroup]).map((group, index) => /* @__PURE__ */ React.createElement(
|
|
116
|
-
EntityListDocsGridGroup,
|
|
117
|
-
{
|
|
118
|
-
entities,
|
|
119
|
-
group,
|
|
120
|
-
key: `${group.title}-${index}`
|
|
121
|
-
}
|
|
122
|
-
)));
|
|
123
|
-
};
|
|
124
|
-
|
|
125
|
-
export { DocsCardGrid, EntityListDocsGrid, techdocsApiRef, techdocsStorageApiRef };
|
|
1
|
+
export { techdocsApiRef, techdocsStorageApiRef } from './api.esm.js';
|
|
2
|
+
export { TechDocsClient, TechDocsStorageClient } from './client.esm.js';
|
|
3
|
+
export { TechDocsReaderProvider } from './reader/components/TechDocsReaderProvider.esm.js';
|
|
4
|
+
export { TechDocsReaderLayout } from './reader/components/TechDocsReaderPage/TechDocsReaderPage.esm.js';
|
|
5
|
+
export { TechDocsReaderPageHeader } from './reader/components/TechDocsReaderPageHeader/TechDocsReaderPageHeader.esm.js';
|
|
6
|
+
export { Reader, TechDocsReaderPageContent } from './reader/components/TechDocsReaderPageContent/TechDocsReaderPageContent.esm.js';
|
|
7
|
+
export { TechDocsReaderPageSubheader } from './reader/components/TechDocsReaderPageSubheader/TechDocsReaderPageSubheader.esm.js';
|
|
8
|
+
export { TechDocsSearch } from './search/components/TechDocsSearch.esm.js';
|
|
9
|
+
export { EntityListDocsGrid } from './home/components/Grids/EntityListDocsGrid.esm.js';
|
|
10
|
+
export { DocsCardGrid } from './home/components/Grids/DocsCardGrid.esm.js';
|
|
11
|
+
export { EntityListDocsTable } from './home/components/Tables/EntityListDocsTable.esm.js';
|
|
12
|
+
export { DocsTable } from './home/components/Tables/DocsTable.esm.js';
|
|
13
|
+
export { DefaultTechDocsHome } from './home/components/DefaultTechDocsHome.esm.js';
|
|
14
|
+
export { TechDocsPageWrapper } from './home/components/TechDocsPageWrapper.esm.js';
|
|
15
|
+
export { TechDocsPicker } from './home/components/TechDocsPicker.esm.js';
|
|
16
|
+
export { EntityTechdocsContent, TechDocsCustomHome, TechDocsIndexPage, TechDocsReaderPage, TechDocsSearchResultListItem, TechdocsPage, techdocsPlugin as plugin, techdocsPlugin } from './plugin.esm.js';
|
|
17
|
+
export { EmbeddedDocsRouter, Router, isTechDocsAvailable } from './Router.esm.js';
|
|
126
18
|
//# sourceMappingURL=index.esm.js.map
|
package/dist/index.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.esm.js","sources":[
|
|
1
|
+
{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;"}
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { techdocsStorageApiRef, techdocsApiRef } from '@backstage/plugin-techdocs-react';
|
|
2
|
+
import { TechDocsStorageClient, TechDocsClient } from './client.esm.js';
|
|
3
|
+
import { rootRouteRef, rootDocsRouteRef, rootCatalogDocsRouteRef } from './routes.esm.js';
|
|
4
|
+
import { createPlugin, createApiFactory, configApiRef, discoveryApiRef, identityApiRef, fetchApiRef, createRoutableExtension } from '@backstage/core-plugin-api';
|
|
5
|
+
import { createSearchResultListItemExtension } from '@backstage/plugin-search-react';
|
|
6
|
+
|
|
7
|
+
const techdocsPlugin = createPlugin({
|
|
8
|
+
id: "techdocs",
|
|
9
|
+
apis: [
|
|
10
|
+
createApiFactory({
|
|
11
|
+
api: techdocsStorageApiRef,
|
|
12
|
+
deps: {
|
|
13
|
+
configApi: configApiRef,
|
|
14
|
+
discoveryApi: discoveryApiRef,
|
|
15
|
+
identityApi: identityApiRef,
|
|
16
|
+
fetchApi: fetchApiRef
|
|
17
|
+
},
|
|
18
|
+
factory: ({ configApi, discoveryApi, identityApi, fetchApi }) => new TechDocsStorageClient({
|
|
19
|
+
configApi,
|
|
20
|
+
discoveryApi,
|
|
21
|
+
identityApi,
|
|
22
|
+
fetchApi
|
|
23
|
+
})
|
|
24
|
+
}),
|
|
25
|
+
createApiFactory({
|
|
26
|
+
api: techdocsApiRef,
|
|
27
|
+
deps: {
|
|
28
|
+
configApi: configApiRef,
|
|
29
|
+
discoveryApi: discoveryApiRef,
|
|
30
|
+
fetchApi: fetchApiRef
|
|
31
|
+
},
|
|
32
|
+
factory: ({ configApi, discoveryApi, fetchApi }) => new TechDocsClient({
|
|
33
|
+
configApi,
|
|
34
|
+
discoveryApi,
|
|
35
|
+
fetchApi
|
|
36
|
+
})
|
|
37
|
+
})
|
|
38
|
+
],
|
|
39
|
+
routes: {
|
|
40
|
+
root: rootRouteRef,
|
|
41
|
+
docRoot: rootDocsRouteRef,
|
|
42
|
+
entityContent: rootCatalogDocsRouteRef
|
|
43
|
+
}
|
|
44
|
+
});
|
|
45
|
+
const TechdocsPage = techdocsPlugin.provide(
|
|
46
|
+
createRoutableExtension({
|
|
47
|
+
name: "TechdocsPage",
|
|
48
|
+
component: () => import('./Router.esm.js').then((m) => m.Router),
|
|
49
|
+
mountPoint: rootRouteRef
|
|
50
|
+
})
|
|
51
|
+
);
|
|
52
|
+
const EntityTechdocsContent = techdocsPlugin.provide(
|
|
53
|
+
createRoutableExtension({
|
|
54
|
+
name: "EntityTechdocsContent",
|
|
55
|
+
component: () => import('./Router.esm.js').then((m) => m.EmbeddedDocsRouter),
|
|
56
|
+
mountPoint: rootCatalogDocsRouteRef
|
|
57
|
+
})
|
|
58
|
+
);
|
|
59
|
+
const TechDocsCustomHome = techdocsPlugin.provide(
|
|
60
|
+
createRoutableExtension({
|
|
61
|
+
name: "TechDocsCustomHome",
|
|
62
|
+
component: () => import('./home/components/TechDocsCustomHome.esm.js').then(
|
|
63
|
+
(m) => m.TechDocsCustomHome
|
|
64
|
+
),
|
|
65
|
+
mountPoint: rootRouteRef
|
|
66
|
+
})
|
|
67
|
+
);
|
|
68
|
+
const TechDocsIndexPage = techdocsPlugin.provide(
|
|
69
|
+
createRoutableExtension({
|
|
70
|
+
name: "TechDocsIndexPage",
|
|
71
|
+
component: () => import('./home/components/TechDocsIndexPage.esm.js').then(
|
|
72
|
+
(m) => m.TechDocsIndexPage
|
|
73
|
+
),
|
|
74
|
+
mountPoint: rootRouteRef
|
|
75
|
+
})
|
|
76
|
+
);
|
|
77
|
+
const TechDocsReaderPage = techdocsPlugin.provide(
|
|
78
|
+
createRoutableExtension({
|
|
79
|
+
name: "TechDocsReaderPage",
|
|
80
|
+
component: () => import('./reader/components/TechDocsReaderPage/index.esm.js').then(
|
|
81
|
+
(m) => m.TechDocsReaderPage
|
|
82
|
+
),
|
|
83
|
+
mountPoint: rootDocsRouteRef
|
|
84
|
+
})
|
|
85
|
+
);
|
|
86
|
+
const TechDocsSearchResultListItem = techdocsPlugin.provide(
|
|
87
|
+
createSearchResultListItemExtension({
|
|
88
|
+
name: "TechDocsSearchResultListItem",
|
|
89
|
+
component: () => import('./search/components/TechDocsSearchResultListItem.esm.js').then(
|
|
90
|
+
(m) => m.TechDocsSearchResultListItem
|
|
91
|
+
),
|
|
92
|
+
predicate: (result) => result.type === "techdocs"
|
|
93
|
+
})
|
|
94
|
+
);
|
|
95
|
+
|
|
96
|
+
export { EntityTechdocsContent, TechDocsCustomHome, TechDocsIndexPage, TechDocsReaderPage, TechDocsSearchResultListItem, TechdocsPage, techdocsPlugin };
|
|
97
|
+
//# sourceMappingURL=plugin.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin.esm.js","sources":["../src/plugin.ts"],"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 techdocsApiRef,\n techdocsStorageApiRef,\n} from '@backstage/plugin-techdocs-react';\nimport { TechDocsClient, TechDocsStorageClient } from './client';\nimport {\n rootDocsRouteRef,\n rootRouteRef,\n rootCatalogDocsRouteRef,\n} from './routes';\nimport {\n configApiRef,\n createApiFactory,\n createPlugin,\n createRoutableExtension,\n discoveryApiRef,\n fetchApiRef,\n identityApiRef,\n} from '@backstage/core-plugin-api';\nimport {\n createSearchResultListItemExtension,\n SearchResultListItemExtensionProps,\n} from '@backstage/plugin-search-react';\nimport { TechDocsSearchResultListItemProps } from './search/components/TechDocsSearchResultListItem';\n\n/**\n * The Backstage plugin that renders technical documentation for your components\n *\n * @public\n */\nexport const techdocsPlugin = createPlugin({\n id: 'techdocs',\n apis: [\n createApiFactory({\n api: techdocsStorageApiRef,\n deps: {\n configApi: configApiRef,\n discoveryApi: discoveryApiRef,\n identityApi: identityApiRef,\n fetchApi: fetchApiRef,\n },\n factory: ({ configApi, discoveryApi, identityApi, fetchApi }) =>\n new TechDocsStorageClient({\n configApi,\n discoveryApi,\n identityApi,\n fetchApi,\n }),\n }),\n createApiFactory({\n api: techdocsApiRef,\n deps: {\n configApi: configApiRef,\n discoveryApi: discoveryApiRef,\n fetchApi: fetchApiRef,\n },\n factory: ({ configApi, discoveryApi, fetchApi }) =>\n new TechDocsClient({\n configApi,\n discoveryApi,\n fetchApi,\n }),\n }),\n ],\n routes: {\n root: rootRouteRef,\n docRoot: rootDocsRouteRef,\n entityContent: rootCatalogDocsRouteRef,\n },\n});\n\n/**\n * Routable extension used to render docs\n *\n * @public\n */\nexport const TechdocsPage = techdocsPlugin.provide(\n createRoutableExtension({\n name: 'TechdocsPage',\n component: () => import('./Router').then(m => m.Router),\n mountPoint: rootRouteRef,\n }),\n);\n\n/**\n * Routable extension used to render docs on Entity page\n *\n * @public\n */\nexport const EntityTechdocsContent = techdocsPlugin.provide(\n createRoutableExtension({\n name: 'EntityTechdocsContent',\n component: () => import('./Router').then(m => m.EmbeddedDocsRouter),\n mountPoint: rootCatalogDocsRouteRef,\n }),\n);\n\n/**\n * Component which takes a custom tabs config object and renders a documentation landing page.\n *\n * @public\n */\nexport const TechDocsCustomHome = techdocsPlugin.provide(\n createRoutableExtension({\n name: 'TechDocsCustomHome',\n component: () =>\n import('./home/components/TechDocsCustomHome').then(\n m => m.TechDocsCustomHome,\n ),\n mountPoint: rootRouteRef,\n }),\n);\n\n/**\n * Responsible for rendering the provided router element\n *\n * @public\n */\nexport const TechDocsIndexPage = techdocsPlugin.provide(\n createRoutableExtension({\n name: 'TechDocsIndexPage',\n component: () =>\n import('./home/components/TechDocsIndexPage').then(\n m => m.TechDocsIndexPage,\n ),\n mountPoint: rootRouteRef,\n }),\n);\n\n/**\n * Component responsible for composing a TechDocs reader page experience\n *\n * @public\n */\nexport const TechDocsReaderPage = techdocsPlugin.provide(\n createRoutableExtension({\n name: 'TechDocsReaderPage',\n component: () =>\n import('./reader/components/TechDocsReaderPage').then(\n m => m.TechDocsReaderPage,\n ),\n mountPoint: rootDocsRouteRef,\n }),\n);\n\n/**\n * React extension used to render results on Search page or modal\n *\n * @public\n */\nexport const TechDocsSearchResultListItem: (\n props: SearchResultListItemExtensionProps<TechDocsSearchResultListItemProps>,\n) => JSX.Element | null = techdocsPlugin.provide(\n createSearchResultListItemExtension({\n name: 'TechDocsSearchResultListItem',\n component: () =>\n import('./search/components/TechDocsSearchResultListItem').then(\n m => m.TechDocsSearchResultListItem,\n ),\n predicate: result => result.type === 'techdocs',\n }),\n);\n"],"names":[],"mappings":";;;;;;AA8CO,MAAM,iBAAiB,YAAa,CAAA;AAAA,EACzC,EAAI,EAAA,UAAA;AAAA,EACJ,IAAM,EAAA;AAAA,IACJ,gBAAiB,CAAA;AAAA,MACf,GAAK,EAAA,qBAAA;AAAA,MACL,IAAM,EAAA;AAAA,QACJ,SAAW,EAAA,YAAA;AAAA,QACX,YAAc,EAAA,eAAA;AAAA,QACd,WAAa,EAAA,cAAA;AAAA,QACb,QAAU,EAAA,WAAA;AAAA,OACZ;AAAA,MACA,OAAA,EAAS,CAAC,EAAE,SAAA,EAAW,cAAc,WAAa,EAAA,QAAA,EAChD,KAAA,IAAI,qBAAsB,CAAA;AAAA,QACxB,SAAA;AAAA,QACA,YAAA;AAAA,QACA,WAAA;AAAA,QACA,QAAA;AAAA,OACD,CAAA;AAAA,KACJ,CAAA;AAAA,IACD,gBAAiB,CAAA;AAAA,MACf,GAAK,EAAA,cAAA;AAAA,MACL,IAAM,EAAA;AAAA,QACJ,SAAW,EAAA,YAAA;AAAA,QACX,YAAc,EAAA,eAAA;AAAA,QACd,QAAU,EAAA,WAAA;AAAA,OACZ;AAAA,MACA,OAAA,EAAS,CAAC,EAAE,SAAA,EAAW,cAAc,QAAS,EAAA,KAC5C,IAAI,cAAe,CAAA;AAAA,QACjB,SAAA;AAAA,QACA,YAAA;AAAA,QACA,QAAA;AAAA,OACD,CAAA;AAAA,KACJ,CAAA;AAAA,GACH;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,YAAA;AAAA,IACN,OAAS,EAAA,gBAAA;AAAA,IACT,aAAe,EAAA,uBAAA;AAAA,GACjB;AACF,CAAC,EAAA;AAOM,MAAM,eAAe,cAAe,CAAA,OAAA;AAAA,EACzC,uBAAwB,CAAA;AAAA,IACtB,IAAM,EAAA,cAAA;AAAA,IACN,SAAA,EAAW,MAAM,OAAO,iBAAU,EAAE,IAAK,CAAA,CAAA,CAAA,KAAK,EAAE,MAAM,CAAA;AAAA,IACtD,UAAY,EAAA,YAAA;AAAA,GACb,CAAA;AACH,EAAA;AAOO,MAAM,wBAAwB,cAAe,CAAA,OAAA;AAAA,EAClD,uBAAwB,CAAA;AAAA,IACtB,IAAM,EAAA,uBAAA;AAAA,IACN,SAAA,EAAW,MAAM,OAAO,iBAAU,EAAE,IAAK,CAAA,CAAA,CAAA,KAAK,EAAE,kBAAkB,CAAA;AAAA,IAClE,UAAY,EAAA,uBAAA;AAAA,GACb,CAAA;AACH,EAAA;AAOO,MAAM,qBAAqB,cAAe,CAAA,OAAA;AAAA,EAC/C,uBAAwB,CAAA;AAAA,IACtB,IAAM,EAAA,oBAAA;AAAA,IACN,SAAW,EAAA,MACT,OAAO,6CAAsC,CAAE,CAAA,IAAA;AAAA,MAC7C,OAAK,CAAE,CAAA,kBAAA;AAAA,KACT;AAAA,IACF,UAAY,EAAA,YAAA;AAAA,GACb,CAAA;AACH,EAAA;AAOO,MAAM,oBAAoB,cAAe,CAAA,OAAA;AAAA,EAC9C,uBAAwB,CAAA;AAAA,IACtB,IAAM,EAAA,mBAAA;AAAA,IACN,SAAW,EAAA,MACT,OAAO,4CAAqC,CAAE,CAAA,IAAA;AAAA,MAC5C,OAAK,CAAE,CAAA,iBAAA;AAAA,KACT;AAAA,IACF,UAAY,EAAA,YAAA;AAAA,GACb,CAAA;AACH,EAAA;AAOO,MAAM,qBAAqB,cAAe,CAAA,OAAA;AAAA,EAC/C,uBAAwB,CAAA;AAAA,IACtB,IAAM,EAAA,oBAAA;AAAA,IACN,SAAW,EAAA,MACT,OAAO,qDAAwC,CAAE,CAAA,IAAA;AAAA,MAC/C,OAAK,CAAE,CAAA,kBAAA;AAAA,KACT;AAAA,IACF,UAAY,EAAA,gBAAA;AAAA,GACb,CAAA;AACH,EAAA;AAOO,MAAM,+BAEa,cAAe,CAAA,OAAA;AAAA,EACvC,mCAAoC,CAAA;AAAA,IAClC,IAAM,EAAA,8BAAA;AAAA,IACN,SAAW,EAAA,MACT,OAAO,yDAAkD,CAAE,CAAA,IAAA;AAAA,MACzD,OAAK,CAAE,CAAA,4BAAA;AAAA,KACT;AAAA,IACF,SAAA,EAAW,CAAU,MAAA,KAAA,MAAA,CAAO,IAAS,KAAA,UAAA;AAAA,GACtC,CAAA;AACH;;;;"}
|