@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.
Files changed (132) hide show
  1. package/CHANGELOG.md +45 -0
  2. package/README.md +1 -1
  3. package/alpha/package.json +1 -1
  4. package/dist/EntityPageDocs.esm.js +23 -0
  5. package/dist/EntityPageDocs.esm.js.map +1 -0
  6. package/dist/Router.esm.js +47 -0
  7. package/dist/Router.esm.js.map +1 -0
  8. package/dist/alpha.esm.js +6 -7
  9. package/dist/alpha.esm.js.map +1 -1
  10. package/dist/api.esm.js +11 -0
  11. package/dist/api.esm.js.map +1 -0
  12. package/dist/{esm/routes-VopnMGN0.esm.js → client.esm.js} +2 -14
  13. package/dist/client.esm.js.map +1 -0
  14. package/dist/helpers.esm.js +8 -0
  15. package/dist/helpers.esm.js.map +1 -0
  16. package/dist/home/components/DefaultTechDocsHome.esm.js +15 -0
  17. package/dist/home/components/DefaultTechDocsHome.esm.js.map +1 -0
  18. package/dist/{esm/DocsCardGrid-AWTYz1vR.esm.js → home/components/Grids/DocsCardGrid.esm.js} +4 -4
  19. package/dist/home/components/Grids/DocsCardGrid.esm.js.map +1 -0
  20. package/dist/home/components/Grids/EntityListDocsGrid.esm.js +68 -0
  21. package/dist/home/components/Grids/EntityListDocsGrid.esm.js.map +1 -0
  22. package/dist/home/components/Tables/DocsTable.esm.js +87 -0
  23. package/dist/home/components/Tables/DocsTable.esm.js.map +1 -0
  24. package/dist/home/components/Tables/EntityListDocsTable.esm.js +50 -0
  25. package/dist/home/components/Tables/EntityListDocsTable.esm.js.map +1 -0
  26. package/dist/home/components/Tables/actions.esm.js +37 -0
  27. package/dist/home/components/Tables/actions.esm.js.map +1 -0
  28. package/dist/home/components/Tables/columns.esm.js +51 -0
  29. package/dist/home/components/Tables/columns.esm.js.map +1 -0
  30. package/dist/{esm/TechDocsCustomHome-CTmEWYTg.esm.js → home/components/TechDocsCustomHome.esm.js} +5 -17
  31. package/dist/home/components/TechDocsCustomHome.esm.js.map +1 -0
  32. package/dist/home/components/TechDocsIndexPage.esm.js +11 -0
  33. package/dist/home/components/TechDocsIndexPage.esm.js.map +1 -0
  34. package/dist/home/components/TechDocsPageWrapper.esm.js +22 -0
  35. package/dist/home/components/TechDocsPageWrapper.esm.js.map +1 -0
  36. package/dist/home/components/TechDocsPicker.esm.js +22 -0
  37. package/dist/home/components/TechDocsPicker.esm.js.map +1 -0
  38. package/dist/index.esm.js +17 -125
  39. package/dist/index.esm.js.map +1 -1
  40. package/dist/plugin.esm.js +97 -0
  41. package/dist/plugin.esm.js.map +1 -0
  42. package/dist/reader/components/TechDocsBuildLogs.esm.js +94 -0
  43. package/dist/reader/components/TechDocsBuildLogs.esm.js.map +1 -0
  44. package/dist/reader/components/TechDocsNotFound.esm.js +33 -0
  45. package/dist/reader/components/TechDocsNotFound.esm.js.map +1 -0
  46. package/dist/reader/components/TechDocsReaderPage/TechDocsReaderPage.esm.js +42 -0
  47. package/dist/reader/components/TechDocsReaderPage/TechDocsReaderPage.esm.js.map +1 -0
  48. package/dist/reader/components/TechDocsReaderPage/index.esm.js +2 -0
  49. package/dist/reader/components/TechDocsReaderPage/index.esm.js.map +1 -0
  50. package/dist/reader/components/TechDocsReaderPageContent/TechDocsReaderPageContent.esm.js +77 -0
  51. package/dist/reader/components/TechDocsReaderPageContent/TechDocsReaderPageContent.esm.js.map +1 -0
  52. package/dist/reader/components/TechDocsReaderPageContent/TechDocsReaderPageContentAddons.esm.js +43 -0
  53. package/dist/reader/components/TechDocsReaderPageContent/TechDocsReaderPageContentAddons.esm.js.map +1 -0
  54. package/dist/reader/components/TechDocsReaderPageContent/dom.esm.js +203 -0
  55. package/dist/reader/components/TechDocsReaderPageContent/dom.esm.js.map +1 -0
  56. package/dist/reader/components/TechDocsReaderPageContent/useNavigateUrl.esm.js +36 -0
  57. package/dist/reader/components/TechDocsReaderPageContent/useNavigateUrl.esm.js.map +1 -0
  58. package/dist/reader/components/TechDocsReaderPageHeader/TechDocsReaderPageHeader.esm.js +101 -0
  59. package/dist/reader/components/TechDocsReaderPageHeader/TechDocsReaderPageHeader.esm.js.map +1 -0
  60. package/dist/reader/components/TechDocsReaderPageSubheader/TechDocsReaderPageSubheader.esm.js +77 -0
  61. package/dist/reader/components/TechDocsReaderPageSubheader/TechDocsReaderPageSubheader.esm.js.map +1 -0
  62. package/dist/reader/components/TechDocsReaderProvider.esm.js +19 -0
  63. package/dist/reader/components/TechDocsReaderProvider.esm.js.map +1 -0
  64. package/dist/reader/components/TechDocsStateIndicator.esm.js +101 -0
  65. package/dist/reader/components/TechDocsStateIndicator.esm.js.map +1 -0
  66. package/dist/reader/components/useReaderState.esm.js +163 -0
  67. package/dist/reader/components/useReaderState.esm.js.map +1 -0
  68. package/dist/reader/transformers/addBaseUrl.esm.js +56 -0
  69. package/dist/reader/transformers/addBaseUrl.esm.js.map +1 -0
  70. package/dist/reader/transformers/addGitFeedbackLink.esm.js +53 -0
  71. package/dist/reader/transformers/addGitFeedbackLink.esm.js.map +1 -0
  72. package/dist/reader/transformers/addLinkClickListener.esm.js +23 -0
  73. package/dist/reader/transformers/addLinkClickListener.esm.js.map +1 -0
  74. package/dist/reader/transformers/addSidebarToggle.esm.js +27 -0
  75. package/dist/reader/transformers/addSidebarToggle.esm.js.map +1 -0
  76. package/dist/reader/transformers/copyToClipboard.esm.js +68 -0
  77. package/dist/reader/transformers/copyToClipboard.esm.js.map +1 -0
  78. package/dist/reader/transformers/html/hooks/iframes.esm.js +19 -0
  79. package/dist/reader/transformers/html/hooks/iframes.esm.js.map +1 -0
  80. package/dist/reader/transformers/html/hooks/links.esm.js +20 -0
  81. package/dist/reader/transformers/html/hooks/links.esm.js.map +1 -0
  82. package/dist/reader/transformers/html/transformer.esm.js +36 -0
  83. package/dist/reader/transformers/html/transformer.esm.js.map +1 -0
  84. package/dist/reader/transformers/onCssReady.esm.js +24 -0
  85. package/dist/reader/transformers/onCssReady.esm.js.map +1 -0
  86. package/dist/reader/transformers/removeMkdocsHeader.esm.js +10 -0
  87. package/dist/reader/transformers/removeMkdocsHeader.esm.js.map +1 -0
  88. package/dist/reader/transformers/renderReactElement.esm.js +18 -0
  89. package/dist/reader/transformers/renderReactElement.esm.js.map +1 -0
  90. package/dist/reader/transformers/rewriteDocLinks.esm.js +37 -0
  91. package/dist/reader/transformers/rewriteDocLinks.esm.js.map +1 -0
  92. package/dist/reader/transformers/scrollIntoNavigation.esm.js +21 -0
  93. package/dist/reader/transformers/scrollIntoNavigation.esm.js.map +1 -0
  94. package/dist/reader/transformers/simplifyMkdocsFooter.esm.js +11 -0
  95. package/dist/reader/transformers/simplifyMkdocsFooter.esm.js.map +1 -0
  96. package/dist/reader/transformers/styles/rules/animations.esm.js +13 -0
  97. package/dist/reader/transformers/styles/rules/animations.esm.js.map +1 -0
  98. package/dist/reader/transformers/styles/rules/extensions.esm.js +72 -0
  99. package/dist/reader/transformers/styles/rules/extensions.esm.js.map +1 -0
  100. package/dist/reader/transformers/styles/rules/layout.esm.js +224 -0
  101. package/dist/reader/transformers/styles/rules/layout.esm.js.map +1 -0
  102. package/dist/reader/transformers/styles/rules/reset.esm.js +14 -0
  103. package/dist/reader/transformers/styles/rules/reset.esm.js.map +1 -0
  104. package/dist/reader/transformers/styles/rules/rules.esm.js +18 -0
  105. package/dist/reader/transformers/styles/rules/rules.esm.js.map +1 -0
  106. package/dist/reader/transformers/styles/rules/typeset.esm.js +91 -0
  107. package/dist/reader/transformers/styles/rules/typeset.esm.js.map +1 -0
  108. package/dist/reader/transformers/styles/rules/variables.esm.js +126 -0
  109. package/dist/reader/transformers/styles/rules/variables.esm.js.map +1 -0
  110. package/dist/reader/transformers/styles/transformer.esm.js +27 -0
  111. package/dist/reader/transformers/styles/transformer.esm.js.map +1 -0
  112. package/dist/reader/transformers/transformer.esm.js +17 -0
  113. package/dist/reader/transformers/transformer.esm.js.map +1 -0
  114. package/dist/routes.esm.js +15 -0
  115. package/dist/routes.esm.js.map +1 -0
  116. package/dist/search/components/TechDocsSearch.esm.js +95 -0
  117. package/dist/search/components/TechDocsSearch.esm.js.map +1 -0
  118. package/dist/{esm/TechDocsSearchResultListItem-4Qzh5-3s.esm.js → search/components/TechDocsSearchResultListItem.esm.js} +1 -1
  119. package/dist/search/components/TechDocsSearchResultListItem.esm.js.map +1 -0
  120. package/package.json +20 -20
  121. package/dist/esm/DocsCardGrid-AWTYz1vR.esm.js.map +0 -1
  122. package/dist/esm/Router-jrzAl2lO.esm.js +0 -162
  123. package/dist/esm/Router-jrzAl2lO.esm.js.map +0 -1
  124. package/dist/esm/TechDocsCustomHome-CTmEWYTg.esm.js.map +0 -1
  125. package/dist/esm/TechDocsIndexPage-BCP1ggek.esm.js +0 -257
  126. package/dist/esm/TechDocsIndexPage-BCP1ggek.esm.js.map +0 -1
  127. package/dist/esm/TechDocsReaderPage-jsKVX28r.esm.js +0 -1925
  128. package/dist/esm/TechDocsReaderPage-jsKVX28r.esm.js.map +0 -1
  129. package/dist/esm/TechDocsSearchResultListItem-4Qzh5-3s.esm.js.map +0 -1
  130. package/dist/esm/index-up5BptkF.esm.js +0 -47
  131. package/dist/esm/index-up5BptkF.esm.js.map +0 -1
  132. package/dist/esm/routes-VopnMGN0.esm.js.map +0 -1
@@ -0,0 +1,36 @@
1
+ import { useApi, configApiRef } from '@backstage/core-plugin-api';
2
+ import { useCallback } from 'react';
3
+ import { useNavigate } from 'react-router-dom';
4
+
5
+ function resolveUrlToRelative(url, baseUrl) {
6
+ const parsedAppUrl = new URL(baseUrl);
7
+ const appUrlPath = `${parsedAppUrl.origin}${parsedAppUrl.pathname.replace(
8
+ /\/$/,
9
+ ""
10
+ )}`;
11
+ const relativeUrl = url.replace(appUrlPath, "").replace(/^\/+/, "");
12
+ const parsedUrl = new URL(`http://localhost/${relativeUrl}`);
13
+ return `${parsedUrl.pathname}${parsedUrl.search}${parsedUrl.hash}`;
14
+ }
15
+ function useNavigateUrl() {
16
+ const navigate = useNavigate();
17
+ const configApi = useApi(configApiRef);
18
+ const appBaseUrl = configApi.getOptionalString("app.baseUrl");
19
+ const navigateFn = useCallback(
20
+ (to) => {
21
+ let url = to;
22
+ if (appBaseUrl) {
23
+ try {
24
+ url = resolveUrlToRelative(to, appBaseUrl);
25
+ } catch (err) {
26
+ }
27
+ }
28
+ navigate(url);
29
+ },
30
+ [navigate, appBaseUrl]
31
+ );
32
+ return navigateFn;
33
+ }
34
+
35
+ export { resolveUrlToRelative, useNavigateUrl };
36
+ //# sourceMappingURL=useNavigateUrl.esm.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useNavigateUrl.esm.js","sources":["../../../../src/reader/components/TechDocsReaderPageContent/useNavigateUrl.tsx"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { configApiRef, useApi } from '@backstage/core-plugin-api';\nimport { useCallback } from 'react';\nimport { useNavigate } from 'react-router-dom';\n\n/**\n * Resolve a URL to a relative URL given a base URL that may or may not include subpaths.\n * @param url - URL to parse into a relative url based on the baseUrl.\n * @param baseUrl - Application base url, where the application is currently hosted.\n * @returns relative path without any subpaths from website config.\n */\nexport function resolveUrlToRelative(url: string, baseUrl: string) {\n const parsedAppUrl = new URL(baseUrl);\n const appUrlPath = `${parsedAppUrl.origin}${parsedAppUrl.pathname.replace(\n /\\/$/,\n '',\n )}`;\n\n const relativeUrl = url\n .replace(appUrlPath, '')\n // Remove any leading slashes.\n .replace(/^\\/+/, '');\n const parsedUrl = new URL(`http://localhost/${relativeUrl}`);\n return `${parsedUrl.pathname}${parsedUrl.search}${parsedUrl.hash}`;\n}\n\n/**\n * A helper hook that allows for full internal website urls to be processed through the navigate\n * hook provided by `react-router-dom`.\n *\n * NOTE: This does not support routing to external URLs. That should be done with a `Link` or `a`\n * element instead, or just `window.location.href`.\n *\n * TODO: Update this to use `useRouteRef` instead of `useApi`.\n *\n * @returns Navigation function that is a wrapper over `react-router-dom`'s\n * to support passing full URLs for navigation.\n *\n * @public\n */\nexport function useNavigateUrl() {\n const navigate = useNavigate();\n const configApi = useApi(configApiRef);\n const appBaseUrl = configApi.getOptionalString('app.baseUrl');\n const navigateFn = useCallback(\n (to: string) => {\n let url = to;\n /**\n * This should always be true when running the application, this just allows\n * test cases that do not have the configApi set up to run still.\n */\n if (appBaseUrl) {\n try {\n url = resolveUrlToRelative(to, appBaseUrl);\n } catch (err) {\n // URL passed in was relative.\n }\n }\n navigate(url);\n },\n [navigate, appBaseUrl],\n );\n return navigateFn;\n}\n"],"names":[],"mappings":";;;;AAyBgB,SAAA,oBAAA,CAAqB,KAAa,OAAiB,EAAA;AACjE,EAAM,MAAA,YAAA,GAAe,IAAI,GAAA,CAAI,OAAO,CAAA,CAAA;AACpC,EAAA,MAAM,aAAa,CAAG,EAAA,YAAA,CAAa,MAAM,CAAA,EAAG,aAAa,QAAS,CAAA,OAAA;AAAA,IAChE,KAAA;AAAA,IACA,EAAA;AAAA,GACD,CAAA,CAAA,CAAA;AAED,EAAM,MAAA,WAAA,GAAc,IACjB,OAAQ,CAAA,UAAA,EAAY,EAAE,CAEtB,CAAA,OAAA,CAAQ,QAAQ,EAAE,CAAA,CAAA;AACrB,EAAA,MAAM,SAAY,GAAA,IAAI,GAAI,CAAA,CAAA,iBAAA,EAAoB,WAAW,CAAE,CAAA,CAAA,CAAA;AAC3D,EAAO,OAAA,CAAA,EAAG,UAAU,QAAQ,CAAA,EAAG,UAAU,MAAM,CAAA,EAAG,UAAU,IAAI,CAAA,CAAA,CAAA;AAClE,CAAA;AAgBO,SAAS,cAAiB,GAAA;AAC/B,EAAA,MAAM,WAAW,WAAY,EAAA,CAAA;AAC7B,EAAM,MAAA,SAAA,GAAY,OAAO,YAAY,CAAA,CAAA;AACrC,EAAM,MAAA,UAAA,GAAa,SAAU,CAAA,iBAAA,CAAkB,aAAa,CAAA,CAAA;AAC5D,EAAA,MAAM,UAAa,GAAA,WAAA;AAAA,IACjB,CAAC,EAAe,KAAA;AACd,MAAA,IAAI,GAAM,GAAA,EAAA,CAAA;AAKV,MAAA,IAAI,UAAY,EAAA;AACd,QAAI,IAAA;AACF,UAAM,GAAA,GAAA,oBAAA,CAAqB,IAAI,UAAU,CAAA,CAAA;AAAA,iBAClC,GAAK,EAAA;AAAA,SAEd;AAAA,OACF;AACA,MAAA,QAAA,CAAS,GAAG,CAAA,CAAA;AAAA,KACd;AAAA,IACA,CAAC,UAAU,UAAU,CAAA;AAAA,GACvB,CAAA;AACA,EAAO,OAAA,UAAA,CAAA;AACT;;;;"}
@@ -0,0 +1,101 @@
1
+ import React, { useEffect } from 'react';
2
+ import Helmet from 'react-helmet';
3
+ import Grid from '@material-ui/core/Grid';
4
+ import Skeleton from '@material-ui/lab/Skeleton';
5
+ import CodeIcon from '@material-ui/icons/Code';
6
+ import { useTechDocsAddons, useTechDocsReaderPage, TechDocsAddonLocations } from '@backstage/plugin-techdocs-react';
7
+ import { getEntityRelations, EntityRefLink, EntityRefLinks } from '@backstage/plugin-catalog-react';
8
+ import { RELATION_OWNED_BY } from '@backstage/catalog-model';
9
+ import { HeaderLabel, Header } from '@backstage/core-components';
10
+ import { useApi, configApiRef, useRouteRef } from '@backstage/core-plugin-api';
11
+ import { capitalize } from 'lodash';
12
+ import { rootRouteRef } from '../../../routes.esm.js';
13
+
14
+ const skeleton = /* @__PURE__ */ React.createElement(Skeleton, { animation: "wave", variant: "text", height: 40 });
15
+ const TechDocsReaderPageHeader = (props) => {
16
+ const { children } = props;
17
+ const addons = useTechDocsAddons();
18
+ const configApi = useApi(configApiRef);
19
+ const {
20
+ title,
21
+ setTitle,
22
+ subtitle,
23
+ setSubtitle,
24
+ entityRef,
25
+ metadata: { value: metadata, loading: metadataLoading },
26
+ entityMetadata: { value: entityMetadata, loading: entityMetadataLoading }
27
+ } = useTechDocsReaderPage();
28
+ useEffect(() => {
29
+ if (!metadata)
30
+ return;
31
+ setTitle(metadata.site_name);
32
+ setSubtitle(() => {
33
+ let { site_description } = metadata;
34
+ if (!site_description || site_description === "None") {
35
+ site_description = "";
36
+ }
37
+ return site_description;
38
+ });
39
+ }, [metadata, setTitle, setSubtitle]);
40
+ const appTitle = configApi.getOptional("app.title") || "Backstage";
41
+ const tabTitle = [title, subtitle, appTitle].filter(Boolean).join(" | ");
42
+ const { locationMetadata, spec } = entityMetadata || {};
43
+ const lifecycle = spec == null ? void 0 : spec.lifecycle;
44
+ const ownedByRelations = entityMetadata ? getEntityRelations(entityMetadata, RELATION_OWNED_BY) : [];
45
+ const docsRootLink = useRouteRef(rootRouteRef)();
46
+ const labels = /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement(
47
+ HeaderLabel,
48
+ {
49
+ label: capitalize((entityMetadata == null ? void 0 : entityMetadata.kind) || "entity"),
50
+ value: /* @__PURE__ */ React.createElement(
51
+ EntityRefLink,
52
+ {
53
+ color: "inherit",
54
+ entityRef,
55
+ title: entityMetadata == null ? void 0 : entityMetadata.metadata.title,
56
+ defaultKind: "Component"
57
+ }
58
+ )
59
+ }
60
+ ), ownedByRelations.length > 0 && /* @__PURE__ */ React.createElement(
61
+ HeaderLabel,
62
+ {
63
+ label: "Owner",
64
+ value: /* @__PURE__ */ React.createElement(
65
+ EntityRefLinks,
66
+ {
67
+ color: "inherit",
68
+ entityRefs: ownedByRelations,
69
+ defaultKind: "group"
70
+ }
71
+ )
72
+ }
73
+ ), lifecycle ? /* @__PURE__ */ React.createElement(HeaderLabel, { label: "Lifecycle", value: String(lifecycle) }) : null, locationMetadata && locationMetadata.type !== "dir" && locationMetadata.type !== "file" ? /* @__PURE__ */ React.createElement(
74
+ HeaderLabel,
75
+ {
76
+ label: "",
77
+ value: /* @__PURE__ */ React.createElement(Grid, { container: true, direction: "column", alignItems: "center" }, /* @__PURE__ */ React.createElement(Grid, { style: { padding: 0 }, item: true }, /* @__PURE__ */ React.createElement(CodeIcon, { style: { marginTop: "-25px" } })), /* @__PURE__ */ React.createElement(Grid, { style: { padding: 0 }, item: true }, "Source")),
78
+ url: locationMetadata.target
79
+ }
80
+ ) : null);
81
+ const noEntMetadata = !entityMetadataLoading && entityMetadata === void 0;
82
+ const noTdMetadata = !metadataLoading && metadata === void 0;
83
+ if (noEntMetadata || noTdMetadata)
84
+ return null;
85
+ return /* @__PURE__ */ React.createElement(
86
+ Header,
87
+ {
88
+ type: "Documentation",
89
+ typeLink: docsRootLink,
90
+ title: title || skeleton,
91
+ subtitle: subtitle === "" ? void 0 : subtitle || skeleton
92
+ },
93
+ /* @__PURE__ */ React.createElement(Helmet, { titleTemplate: "%s" }, /* @__PURE__ */ React.createElement("title", null, tabTitle)),
94
+ labels,
95
+ children,
96
+ addons.renderComponentsByLocation(TechDocsAddonLocations.Header)
97
+ );
98
+ };
99
+
100
+ export { TechDocsReaderPageHeader };
101
+ //# sourceMappingURL=TechDocsReaderPageHeader.esm.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"TechDocsReaderPageHeader.esm.js","sources":["../../../../src/reader/components/TechDocsReaderPageHeader/TechDocsReaderPageHeader.tsx"],"sourcesContent":["/*\n * Copyright 2022 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, { PropsWithChildren, useEffect } from 'react';\nimport Helmet from 'react-helmet';\n\nimport Grid from '@material-ui/core/Grid';\nimport Skeleton from '@material-ui/lab/Skeleton';\nimport CodeIcon from '@material-ui/icons/Code';\n\nimport {\n TechDocsAddonLocations as locations,\n useTechDocsAddons,\n useTechDocsReaderPage,\n TechDocsEntityMetadata,\n TechDocsMetadata,\n} from '@backstage/plugin-techdocs-react';\nimport {\n EntityRefLink,\n EntityRefLinks,\n getEntityRelations,\n} from '@backstage/plugin-catalog-react';\nimport { RELATION_OWNED_BY, CompoundEntityRef } from '@backstage/catalog-model';\nimport { Header, HeaderLabel } from '@backstage/core-components';\nimport { useRouteRef, configApiRef, useApi } from '@backstage/core-plugin-api';\n\nimport { capitalize } from 'lodash';\n\nimport { rootRouteRef } from '../../../routes';\n\nconst skeleton = <Skeleton animation=\"wave\" variant=\"text\" height={40} />;\n\n/**\n * Props for {@link TechDocsReaderPageHeader}\n *\n * @public\n * @deprecated No need to pass down properties anymore. The component consumes data from `TechDocsReaderPageContext` instead. Use the {@link @backstage/plugin-techdocs-react#useTechDocsReaderPage} hook for custom header.\n */\nexport type TechDocsReaderPageHeaderProps = PropsWithChildren<{\n entityRef?: CompoundEntityRef;\n entityMetadata?: TechDocsEntityMetadata;\n techDocsMetadata?: TechDocsMetadata;\n}>;\n\n/**\n * Renders the reader page header.\n * This component does not accept props, please use\n * the Tech Docs add-ons to customize it\n * @public\n */\nexport const TechDocsReaderPageHeader = (\n props: TechDocsReaderPageHeaderProps,\n) => {\n const { children } = props;\n const addons = useTechDocsAddons();\n const configApi = useApi(configApiRef);\n\n const {\n title,\n setTitle,\n subtitle,\n setSubtitle,\n entityRef,\n metadata: { value: metadata, loading: metadataLoading },\n entityMetadata: { value: entityMetadata, loading: entityMetadataLoading },\n } = useTechDocsReaderPage();\n\n useEffect(() => {\n if (!metadata) return;\n setTitle(metadata.site_name);\n setSubtitle(() => {\n let { site_description } = metadata;\n if (!site_description || site_description === 'None') {\n site_description = '';\n }\n return site_description;\n });\n }, [metadata, setTitle, setSubtitle]);\n\n const appTitle = configApi.getOptional('app.title') || 'Backstage';\n const tabTitle = [title, subtitle, appTitle].filter(Boolean).join(' | ');\n\n const { locationMetadata, spec } = entityMetadata || {};\n const lifecycle = spec?.lifecycle;\n\n const ownedByRelations = entityMetadata\n ? getEntityRelations(entityMetadata, RELATION_OWNED_BY)\n : [];\n\n const docsRootLink = useRouteRef(rootRouteRef)();\n\n const labels = (\n <>\n <HeaderLabel\n label={capitalize(entityMetadata?.kind || 'entity')}\n value={\n <EntityRefLink\n color=\"inherit\"\n entityRef={entityRef}\n title={entityMetadata?.metadata.title}\n defaultKind=\"Component\"\n />\n }\n />\n {ownedByRelations.length > 0 && (\n <HeaderLabel\n label=\"Owner\"\n value={\n <EntityRefLinks\n color=\"inherit\"\n entityRefs={ownedByRelations}\n defaultKind=\"group\"\n />\n }\n />\n )}\n {lifecycle ? (\n <HeaderLabel label=\"Lifecycle\" value={String(lifecycle)} />\n ) : null}\n {locationMetadata &&\n locationMetadata.type !== 'dir' &&\n locationMetadata.type !== 'file' ? (\n <HeaderLabel\n label=\"\"\n value={\n <Grid container direction=\"column\" alignItems=\"center\">\n <Grid style={{ padding: 0 }} item>\n <CodeIcon style={{ marginTop: '-25px' }} />\n </Grid>\n <Grid style={{ padding: 0 }} item>\n Source\n </Grid>\n </Grid>\n }\n url={locationMetadata.target}\n />\n ) : null}\n </>\n );\n\n // If there is no entity or techdocs metadata, there's no reason to show the\n // header (hides the header on 404 error pages).\n const noEntMetadata = !entityMetadataLoading && entityMetadata === undefined;\n const noTdMetadata = !metadataLoading && metadata === undefined;\n if (noEntMetadata || noTdMetadata) return null;\n\n return (\n <Header\n type=\"Documentation\"\n typeLink={docsRootLink}\n title={title || skeleton}\n subtitle={subtitle === '' ? undefined : subtitle || skeleton}\n >\n <Helmet titleTemplate=\"%s\">\n <title>{tabTitle}</title>\n </Helmet>\n {labels}\n {children}\n {addons.renderComponentsByLocation(locations.Header)}\n </Header>\n );\n};\n"],"names":["locations"],"mappings":";;;;;;;;;;;;;AA2CA,MAAM,QAAA,uCAAY,QAAS,EAAA,EAAA,SAAA,EAAU,QAAO,OAAQ,EAAA,MAAA,EAAO,QAAQ,EAAI,EAAA,CAAA,CAAA;AAoB1D,MAAA,wBAAA,GAA2B,CACtC,KACG,KAAA;AACH,EAAM,MAAA,EAAE,UAAa,GAAA,KAAA,CAAA;AACrB,EAAA,MAAM,SAAS,iBAAkB,EAAA,CAAA;AACjC,EAAM,MAAA,SAAA,GAAY,OAAO,YAAY,CAAA,CAAA;AAErC,EAAM,MAAA;AAAA,IACJ,KAAA;AAAA,IACA,QAAA;AAAA,IACA,QAAA;AAAA,IACA,WAAA;AAAA,IACA,SAAA;AAAA,IACA,QAAU,EAAA,EAAE,KAAO,EAAA,QAAA,EAAU,SAAS,eAAgB,EAAA;AAAA,IACtD,cAAgB,EAAA,EAAE,KAAO,EAAA,cAAA,EAAgB,SAAS,qBAAsB,EAAA;AAAA,MACtE,qBAAsB,EAAA,CAAA;AAE1B,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,CAAC,QAAA;AAAU,MAAA,OAAA;AACf,IAAA,QAAA,CAAS,SAAS,SAAS,CAAA,CAAA;AAC3B,IAAA,WAAA,CAAY,MAAM;AAChB,MAAI,IAAA,EAAE,kBAAqB,GAAA,QAAA,CAAA;AAC3B,MAAI,IAAA,CAAC,gBAAoB,IAAA,gBAAA,KAAqB,MAAQ,EAAA;AACpD,QAAmB,gBAAA,GAAA,EAAA,CAAA;AAAA,OACrB;AACA,MAAO,OAAA,gBAAA,CAAA;AAAA,KACR,CAAA,CAAA;AAAA,GACA,EAAA,CAAC,QAAU,EAAA,QAAA,EAAU,WAAW,CAAC,CAAA,CAAA;AAEpC,EAAA,MAAM,QAAW,GAAA,SAAA,CAAU,WAAY,CAAA,WAAW,CAAK,IAAA,WAAA,CAAA;AACvD,EAAM,MAAA,QAAA,GAAW,CAAC,KAAA,EAAO,QAAU,EAAA,QAAQ,EAAE,MAAO,CAAA,OAAO,CAAE,CAAA,IAAA,CAAK,KAAK,CAAA,CAAA;AAEvE,EAAA,MAAM,EAAE,gBAAA,EAAkB,IAAK,EAAA,GAAI,kBAAkB,EAAC,CAAA;AACtD,EAAA,MAAM,YAAY,IAAM,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,IAAA,CAAA,SAAA,CAAA;AAExB,EAAA,MAAM,mBAAmB,cACrB,GAAA,kBAAA,CAAmB,cAAgB,EAAA,iBAAiB,IACpD,EAAC,CAAA;AAEL,EAAM,MAAA,YAAA,GAAe,WAAY,CAAA,YAAY,CAAE,EAAA,CAAA;AAE/C,EAAA,MAAM,yBAEF,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,WAAA;AAAA,IAAA;AAAA,MACC,KAAO,EAAA,UAAA,CAAA,CAAW,cAAgB,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,cAAA,CAAA,IAAA,KAAQ,QAAQ,CAAA;AAAA,MAClD,KACE,kBAAA,KAAA,CAAA,aAAA;AAAA,QAAC,aAAA;AAAA,QAAA;AAAA,UACC,KAAM,EAAA,SAAA;AAAA,UACN,SAAA;AAAA,UACA,KAAA,EAAO,iDAAgB,QAAS,CAAA,KAAA;AAAA,UAChC,WAAY,EAAA,WAAA;AAAA,SAAA;AAAA,OACd;AAAA,KAAA;AAAA,GAEJ,EACC,gBAAiB,CAAA,MAAA,GAAS,CACzB,oBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,WAAA;AAAA,IAAA;AAAA,MACC,KAAM,EAAA,OAAA;AAAA,MACN,KACE,kBAAA,KAAA,CAAA,aAAA;AAAA,QAAC,cAAA;AAAA,QAAA;AAAA,UACC,KAAM,EAAA,SAAA;AAAA,UACN,UAAY,EAAA,gBAAA;AAAA,UACZ,WAAY,EAAA,OAAA;AAAA,SAAA;AAAA,OACd;AAAA,KAAA;AAAA,KAIL,SACC,mBAAA,KAAA,CAAA,aAAA,CAAC,eAAY,KAAM,EAAA,WAAA,EAAY,OAAO,MAAO,CAAA,SAAS,CAAG,EAAA,CAAA,GACvD,MACH,gBACD,IAAA,gBAAA,CAAiB,SAAS,KAC1B,IAAA,gBAAA,CAAiB,SAAS,MACxB,mBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,WAAA;AAAA,IAAA;AAAA,MACC,KAAM,EAAA,EAAA;AAAA,MACN,uBACG,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,SAAS,EAAA,IAAA,EAAC,WAAU,QAAS,EAAA,UAAA,EAAW,QAC5C,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,QAAK,KAAO,EAAA,EAAE,OAAS,EAAA,CAAA,IAAK,IAAI,EAAA,IAAA,EAAA,kBAC9B,KAAA,CAAA,aAAA,CAAA,QAAA,EAAA,EAAS,OAAO,EAAE,SAAA,EAAW,OAAQ,EAAA,EAAG,CAC3C,CACA,kBAAA,KAAA,CAAA,aAAA,CAAC,IAAK,EAAA,EAAA,KAAA,EAAO,EAAE,OAAS,EAAA,CAAA,IAAK,IAAI,EAAA,IAAA,EAAA,EAAC,QAElC,CACF,CAAA;AAAA,MAEF,KAAK,gBAAiB,CAAA,MAAA;AAAA,KAAA;AAAA,MAEtB,IACN,CAAA,CAAA;AAKF,EAAM,MAAA,aAAA,GAAgB,CAAC,qBAAA,IAAyB,cAAmB,KAAA,KAAA,CAAA,CAAA;AACnE,EAAM,MAAA,YAAA,GAAe,CAAC,eAAA,IAAmB,QAAa,KAAA,KAAA,CAAA,CAAA;AACtD,EAAA,IAAI,aAAiB,IAAA,YAAA;AAAc,IAAO,OAAA,IAAA,CAAA;AAE1C,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,MAAA;AAAA,IAAA;AAAA,MACC,IAAK,EAAA,eAAA;AAAA,MACL,QAAU,EAAA,YAAA;AAAA,MACV,OAAO,KAAS,IAAA,QAAA;AAAA,MAChB,QAAU,EAAA,QAAA,KAAa,EAAK,GAAA,KAAA,CAAA,GAAY,QAAY,IAAA,QAAA;AAAA,KAAA;AAAA,wCAEnD,MAAO,EAAA,EAAA,aAAA,EAAc,wBACnB,KAAA,CAAA,aAAA,CAAA,OAAA,EAAA,IAAA,EAAO,QAAS,CACnB,CAAA;AAAA,IACC,MAAA;AAAA,IACA,QAAA;AAAA,IACA,MAAA,CAAO,0BAA2B,CAAAA,sBAAA,CAAU,MAAM,CAAA;AAAA,GACrD,CAAA;AAEJ;;;;"}
@@ -0,0 +1,77 @@
1
+ import React, { useState, useCallback } from 'react';
2
+ import { makeStyles } from '@material-ui/core/styles';
3
+ import IconButton from '@material-ui/core/IconButton';
4
+ import Toolbar from '@material-ui/core/Toolbar';
5
+ import Tooltip from '@material-ui/core/Tooltip';
6
+ import Menu from '@material-ui/core/Menu';
7
+ import Box from '@material-ui/core/Box';
8
+ import SettingsIcon from '@material-ui/icons/Settings';
9
+ import { useTechDocsReaderPage, useTechDocsAddons, TechDocsAddonLocations } from '@backstage/plugin-techdocs-react';
10
+
11
+ const useStyles = makeStyles((theme) => ({
12
+ root: {
13
+ gridArea: "pageSubheader",
14
+ flexDirection: "column",
15
+ minHeight: "auto",
16
+ padding: theme.spacing(3, 3, 0),
17
+ "@media print": {
18
+ display: "none"
19
+ }
20
+ }
21
+ }));
22
+ const TechDocsReaderPageSubheader = (props) => {
23
+ const classes = useStyles();
24
+ const [anchorEl, setAnchorEl] = useState(null);
25
+ const handleClick = useCallback((event) => {
26
+ setAnchorEl(event.currentTarget);
27
+ }, []);
28
+ const handleClose = useCallback(() => {
29
+ setAnchorEl(null);
30
+ }, []);
31
+ const {
32
+ entityMetadata: { value: entityMetadata, loading: entityMetadataLoading }
33
+ } = useTechDocsReaderPage();
34
+ const addons = useTechDocsAddons();
35
+ const subheaderAddons = addons.renderComponentsByLocation(
36
+ TechDocsAddonLocations.Subheader
37
+ );
38
+ const settingsAddons = addons.renderComponentsByLocation(TechDocsAddonLocations.Settings);
39
+ if (!subheaderAddons && !settingsAddons)
40
+ return null;
41
+ if (entityMetadataLoading === false && !entityMetadata)
42
+ return null;
43
+ return /* @__PURE__ */ React.createElement(Toolbar, { classes, ...props.toolbarProps }, /* @__PURE__ */ React.createElement(
44
+ Box,
45
+ {
46
+ display: "flex",
47
+ justifyContent: "flex-end",
48
+ width: "100%",
49
+ flexWrap: "wrap"
50
+ },
51
+ subheaderAddons,
52
+ settingsAddons ? /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement(Tooltip, { title: "Settings" }, /* @__PURE__ */ React.createElement(
53
+ IconButton,
54
+ {
55
+ "aria-controls": "tech-docs-reader-page-settings",
56
+ "aria-haspopup": "true",
57
+ onClick: handleClick
58
+ },
59
+ /* @__PURE__ */ React.createElement(SettingsIcon, null)
60
+ )), /* @__PURE__ */ React.createElement(
61
+ Menu,
62
+ {
63
+ id: "tech-docs-reader-page-settings",
64
+ getContentAnchorEl: null,
65
+ anchorEl,
66
+ anchorOrigin: { vertical: "bottom", horizontal: "right" },
67
+ open: Boolean(anchorEl),
68
+ onClose: handleClose,
69
+ keepMounted: true
70
+ },
71
+ /* @__PURE__ */ React.createElement("div", null, settingsAddons)
72
+ )) : null
73
+ ));
74
+ };
75
+
76
+ export { TechDocsReaderPageSubheader };
77
+ //# sourceMappingURL=TechDocsReaderPageSubheader.esm.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"TechDocsReaderPageSubheader.esm.js","sources":["../../../../src/reader/components/TechDocsReaderPageSubheader/TechDocsReaderPageSubheader.tsx"],"sourcesContent":["/*\n * Copyright 2022 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, { MouseEvent, useState, useCallback } from 'react';\n\nimport { makeStyles } from '@material-ui/core/styles';\nimport IconButton from '@material-ui/core/IconButton';\nimport Toolbar from '@material-ui/core/Toolbar';\nimport { ToolbarProps } from '@material-ui/core/Toolbar';\nimport Tooltip from '@material-ui/core/Tooltip';\nimport Menu from '@material-ui/core/Menu';\nimport Box from '@material-ui/core/Box';\nimport SettingsIcon from '@material-ui/icons/Settings';\n\nimport {\n TechDocsAddonLocations as locations,\n useTechDocsAddons,\n useTechDocsReaderPage,\n} from '@backstage/plugin-techdocs-react';\n\nconst useStyles = makeStyles(theme => ({\n root: {\n gridArea: 'pageSubheader',\n flexDirection: 'column',\n minHeight: 'auto',\n padding: theme.spacing(3, 3, 0),\n '@media print': {\n display: 'none',\n },\n },\n}));\n\n/**\n * Renders the reader page subheader.\n * Please use the Tech Docs add-ons to customize it\n * @public\n */\nexport const TechDocsReaderPageSubheader = (props: {\n toolbarProps?: ToolbarProps;\n}) => {\n const classes = useStyles();\n const [anchorEl, setAnchorEl] = useState<null | HTMLElement>(null);\n\n const handleClick = useCallback((event: MouseEvent<HTMLButtonElement>) => {\n setAnchorEl(event.currentTarget);\n }, []);\n\n const handleClose = useCallback(() => {\n setAnchorEl(null);\n }, []);\n\n const {\n entityMetadata: { value: entityMetadata, loading: entityMetadataLoading },\n } = useTechDocsReaderPage();\n\n const addons = useTechDocsAddons();\n\n const subheaderAddons = addons.renderComponentsByLocation(\n locations.Subheader,\n );\n\n const settingsAddons = addons.renderComponentsByLocation(locations.Settings);\n\n if (!subheaderAddons && !settingsAddons) return null;\n\n // No entity metadata = 404. Don't render subheader on 404.\n if (entityMetadataLoading === false && !entityMetadata) return null;\n\n return (\n <Toolbar classes={classes} {...props.toolbarProps}>\n <Box\n display=\"flex\"\n justifyContent=\"flex-end\"\n width=\"100%\"\n flexWrap=\"wrap\"\n >\n {subheaderAddons}\n {settingsAddons ? (\n <>\n <Tooltip title=\"Settings\">\n <IconButton\n aria-controls=\"tech-docs-reader-page-settings\"\n aria-haspopup=\"true\"\n onClick={handleClick}\n >\n <SettingsIcon />\n </IconButton>\n </Tooltip>\n <Menu\n id=\"tech-docs-reader-page-settings\"\n getContentAnchorEl={null}\n anchorEl={anchorEl}\n anchorOrigin={{ vertical: 'bottom', horizontal: 'right' }}\n open={Boolean(anchorEl)}\n onClose={handleClose}\n keepMounted\n >\n <div>{settingsAddons}</div>\n </Menu>\n </>\n ) : null}\n </Box>\n </Toolbar>\n );\n};\n"],"names":["locations"],"mappings":";;;;;;;;;;AAiCA,MAAM,SAAA,GAAY,WAAW,CAAU,KAAA,MAAA;AAAA,EACrC,IAAM,EAAA;AAAA,IACJ,QAAU,EAAA,eAAA;AAAA,IACV,aAAe,EAAA,QAAA;AAAA,IACf,SAAW,EAAA,MAAA;AAAA,IACX,OAAS,EAAA,KAAA,CAAM,OAAQ,CAAA,CAAA,EAAG,GAAG,CAAC,CAAA;AAAA,IAC9B,cAAgB,EAAA;AAAA,MACd,OAAS,EAAA,MAAA;AAAA,KACX;AAAA,GACF;AACF,CAAE,CAAA,CAAA,CAAA;AAOW,MAAA,2BAAA,GAA8B,CAAC,KAEtC,KAAA;AACJ,EAAA,MAAM,UAAU,SAAU,EAAA,CAAA;AAC1B,EAAA,MAAM,CAAC,QAAA,EAAU,WAAW,CAAA,GAAI,SAA6B,IAAI,CAAA,CAAA;AAEjE,EAAM,MAAA,WAAA,GAAc,WAAY,CAAA,CAAC,KAAyC,KAAA;AACxE,IAAA,WAAA,CAAY,MAAM,aAAa,CAAA,CAAA;AAAA,GACjC,EAAG,EAAE,CAAA,CAAA;AAEL,EAAM,MAAA,WAAA,GAAc,YAAY,MAAM;AACpC,IAAA,WAAA,CAAY,IAAI,CAAA,CAAA;AAAA,GAClB,EAAG,EAAE,CAAA,CAAA;AAEL,EAAM,MAAA;AAAA,IACJ,cAAgB,EAAA,EAAE,KAAO,EAAA,cAAA,EAAgB,SAAS,qBAAsB,EAAA;AAAA,MACtE,qBAAsB,EAAA,CAAA;AAE1B,EAAA,MAAM,SAAS,iBAAkB,EAAA,CAAA;AAEjC,EAAA,MAAM,kBAAkB,MAAO,CAAA,0BAAA;AAAA,IAC7BA,sBAAU,CAAA,SAAA;AAAA,GACZ,CAAA;AAEA,EAAA,MAAM,cAAiB,GAAA,MAAA,CAAO,0BAA2B,CAAAA,sBAAA,CAAU,QAAQ,CAAA,CAAA;AAE3E,EAAI,IAAA,CAAC,mBAAmB,CAAC,cAAA;AAAgB,IAAO,OAAA,IAAA,CAAA;AAGhD,EAAI,IAAA,qBAAA,KAA0B,SAAS,CAAC,cAAA;AAAgB,IAAO,OAAA,IAAA,CAAA;AAE/D,EAAA,uBACG,KAAA,CAAA,aAAA,CAAA,OAAA,EAAA,EAAQ,OAAmB,EAAA,GAAG,MAAM,YACnC,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,GAAA;AAAA,IAAA;AAAA,MACC,OAAQ,EAAA,MAAA;AAAA,MACR,cAAe,EAAA,UAAA;AAAA,MACf,KAAM,EAAA,MAAA;AAAA,MACN,QAAS,EAAA,MAAA;AAAA,KAAA;AAAA,IAER,eAAA;AAAA,IACA,cACC,mBAAA,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,kBACG,KAAA,CAAA,aAAA,CAAA,OAAA,EAAA,EAAQ,OAAM,UACb,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,UAAA;AAAA,MAAA;AAAA,QACC,eAAc,EAAA,gCAAA;AAAA,QACd,eAAc,EAAA,MAAA;AAAA,QACd,OAAS,EAAA,WAAA;AAAA,OAAA;AAAA,0CAER,YAAa,EAAA,IAAA,CAAA;AAAA,KAElB,CACA,kBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,IAAA;AAAA,MAAA;AAAA,QACC,EAAG,EAAA,gCAAA;AAAA,QACH,kBAAoB,EAAA,IAAA;AAAA,QACpB,QAAA;AAAA,QACA,YAAc,EAAA,EAAE,QAAU,EAAA,QAAA,EAAU,YAAY,OAAQ,EAAA;AAAA,QACxD,IAAA,EAAM,QAAQ,QAAQ,CAAA;AAAA,QACtB,OAAS,EAAA,WAAA;AAAA,QACT,WAAW,EAAA,IAAA;AAAA,OAAA;AAAA,sBAEX,KAAA,CAAA,aAAA,CAAC,aAAK,cAAe,CAAA;AAAA,KAEzB,CACE,GAAA,IAAA;AAAA,GAER,CAAA,CAAA;AAEJ;;;;"}
@@ -0,0 +1,19 @@
1
+ import React, { createContext, useContext } from 'react';
2
+ import { useParams } from 'react-router-dom';
3
+ import { useTechDocsReaderPage } from '@backstage/plugin-techdocs-react';
4
+ import { useReaderState } from './useReaderState.esm.js';
5
+
6
+ const TechDocsReaderContext = createContext({});
7
+ const useTechDocsReader = () => useContext(TechDocsReaderContext);
8
+ const TechDocsReaderProvider = (props) => {
9
+ const { children } = props;
10
+ const { "*": path = "" } = useParams();
11
+ const { entityRef } = useTechDocsReaderPage();
12
+ const { kind, namespace, name } = entityRef;
13
+ const value = useReaderState(kind, namespace, name, path);
14
+ return /* @__PURE__ */ React.createElement(TechDocsReaderContext.Provider, { value }, children instanceof Function ? children(value) : children);
15
+ };
16
+ const withTechDocsReaderProvider = (Component) => (props) => /* @__PURE__ */ React.createElement(TechDocsReaderProvider, null, /* @__PURE__ */ React.createElement(Component, { ...props }));
17
+
18
+ export { TechDocsReaderProvider, useTechDocsReader, withTechDocsReaderProvider };
19
+ //# sourceMappingURL=TechDocsReaderProvider.esm.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"TechDocsReaderProvider.esm.js","sources":["../../../src/reader/components/TechDocsReaderProvider.tsx"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport React, {\n ComponentType,\n createContext,\n useContext,\n ReactNode,\n} from 'react';\nimport { useParams } from 'react-router-dom';\nimport { useTechDocsReaderPage } from '@backstage/plugin-techdocs-react';\n\nimport { useReaderState, ReaderState } from './useReaderState';\n\nconst TechDocsReaderContext = createContext<ReaderState>({} as ReaderState);\n\nexport const useTechDocsReader = () => useContext(TechDocsReaderContext);\n\n/**\n * @public Render function for {@link TechDocsReaderProvider}\n */\nexport type TechDocsReaderProviderRenderFunction = (\n value: ReaderState,\n) => JSX.Element;\n\n/**\n * @public Props for {@link TechDocsReaderProvider}\n */\nexport type TechDocsReaderProviderProps = {\n children: TechDocsReaderProviderRenderFunction | ReactNode;\n};\n\n/**\n * Provides shared building process state to the reader page components.\n *\n * @public\n */\nexport const TechDocsReaderProvider = (props: TechDocsReaderProviderProps) => {\n const { children } = props;\n\n const { '*': path = '' } = useParams();\n const { entityRef } = useTechDocsReaderPage();\n const { kind, namespace, name } = entityRef;\n const value = useReaderState(kind, namespace, name, path);\n\n return (\n <TechDocsReaderContext.Provider value={value}>\n {children instanceof Function ? children(value) : children}\n </TechDocsReaderContext.Provider>\n );\n};\n\nexport const withTechDocsReaderProvider =\n <T extends {}>(Component: ComponentType<T>) =>\n (props: T) =>\n (\n <TechDocsReaderProvider>\n <Component {...props} />\n </TechDocsReaderProvider>\n );\n"],"names":[],"mappings":";;;;;AA2BA,MAAM,qBAAA,GAAwB,aAA2B,CAAA,EAAiB,CAAA,CAAA;AAE7D,MAAA,iBAAA,GAAoB,MAAM,UAAA,CAAW,qBAAqB,EAAA;AAqB1D,MAAA,sBAAA,GAAyB,CAAC,KAAuC,KAAA;AAC5E,EAAM,MAAA,EAAE,UAAa,GAAA,KAAA,CAAA;AAErB,EAAA,MAAM,EAAE,GAAA,EAAK,IAAO,GAAA,EAAA,KAAO,SAAU,EAAA,CAAA;AACrC,EAAM,MAAA,EAAE,SAAU,EAAA,GAAI,qBAAsB,EAAA,CAAA;AAC5C,EAAA,MAAM,EAAE,IAAA,EAAM,SAAW,EAAA,IAAA,EAAS,GAAA,SAAA,CAAA;AAClC,EAAA,MAAM,KAAQ,GAAA,cAAA,CAAe,IAAM,EAAA,SAAA,EAAW,MAAM,IAAI,CAAA,CAAA;AAExD,EACE,uBAAA,KAAA,CAAA,aAAA,CAAC,qBAAsB,CAAA,QAAA,EAAtB,EAA+B,KAAA,EAAA,EAC7B,oBAAoB,QAAW,GAAA,QAAA,CAAS,KAAK,CAAA,GAAI,QACpD,CAAA,CAAA;AAEJ,EAAA;AAEa,MAAA,0BAAA,GACX,CAAe,SAAA,KACf,CAAC,KAAA,qBAEI,KAAA,CAAA,aAAA,CAAA,sBAAA,EAAA,IAAA,kBACE,KAAA,CAAA,aAAA,CAAA,SAAA,EAAA,EAAW,GAAG,KAAA,EAAO,CACxB;;;;"}
@@ -0,0 +1,101 @@
1
+ import React from 'react';
2
+ import CircularProgress from '@material-ui/core/CircularProgress';
3
+ import Button from '@material-ui/core/Button';
4
+ import { makeStyles } from '@material-ui/core/styles';
5
+ import Alert from '@material-ui/lab/Alert';
6
+ import { TechDocsBuildLogs } from './TechDocsBuildLogs.esm.js';
7
+ import { TechDocsNotFound } from './TechDocsNotFound.esm.js';
8
+ import { useTechDocsReader } from './TechDocsReaderProvider.esm.js';
9
+
10
+ const useStyles = makeStyles((theme) => ({
11
+ root: {
12
+ marginBottom: theme.spacing(2)
13
+ },
14
+ message: {
15
+ // `word-break: break-word` is deprecated, but gives legacy support to browsers not supporting `overflow-wrap` yet
16
+ // https://developer.mozilla.org/en-US/docs/Web/CSS/word-break
17
+ wordBreak: "break-word",
18
+ overflowWrap: "anywhere"
19
+ }
20
+ }));
21
+ const TechDocsStateIndicator = () => {
22
+ let StateAlert = null;
23
+ const classes = useStyles();
24
+ const {
25
+ state,
26
+ contentReload,
27
+ contentErrorMessage,
28
+ syncErrorMessage,
29
+ buildLog
30
+ } = useTechDocsReader();
31
+ if (state === "INITIAL_BUILD") {
32
+ StateAlert = /* @__PURE__ */ React.createElement(
33
+ Alert,
34
+ {
35
+ classes: { root: classes.root },
36
+ variant: "outlined",
37
+ severity: "info",
38
+ icon: /* @__PURE__ */ React.createElement(CircularProgress, { size: "24px" }),
39
+ action: /* @__PURE__ */ React.createElement(TechDocsBuildLogs, { buildLog })
40
+ },
41
+ "Documentation is accessed for the first time and is being prepared. The subsequent loads are much faster."
42
+ );
43
+ }
44
+ if (state === "CONTENT_STALE_REFRESHING") {
45
+ StateAlert = /* @__PURE__ */ React.createElement(
46
+ Alert,
47
+ {
48
+ variant: "outlined",
49
+ severity: "info",
50
+ icon: /* @__PURE__ */ React.createElement(CircularProgress, { size: "24px" }),
51
+ action: /* @__PURE__ */ React.createElement(TechDocsBuildLogs, { buildLog }),
52
+ classes: { root: classes.root }
53
+ },
54
+ "A newer version of this documentation is being prepared and will be available shortly."
55
+ );
56
+ }
57
+ if (state === "CONTENT_STALE_READY") {
58
+ StateAlert = /* @__PURE__ */ React.createElement(
59
+ Alert,
60
+ {
61
+ variant: "outlined",
62
+ severity: "success",
63
+ action: /* @__PURE__ */ React.createElement(Button, { color: "inherit", onClick: () => contentReload() }, "Refresh"),
64
+ classes: { root: classes.root }
65
+ },
66
+ "A newer version of this documentation is now available, please refresh to view."
67
+ );
68
+ }
69
+ if (state === "CONTENT_STALE_ERROR") {
70
+ StateAlert = /* @__PURE__ */ React.createElement(
71
+ Alert,
72
+ {
73
+ variant: "outlined",
74
+ severity: "error",
75
+ action: /* @__PURE__ */ React.createElement(TechDocsBuildLogs, { buildLog }),
76
+ classes: { root: classes.root, message: classes.message }
77
+ },
78
+ "Building a newer version of this documentation failed.",
79
+ " ",
80
+ syncErrorMessage
81
+ );
82
+ }
83
+ if (state === "CONTENT_NOT_FOUND") {
84
+ StateAlert = /* @__PURE__ */ React.createElement(React.Fragment, null, syncErrorMessage && /* @__PURE__ */ React.createElement(
85
+ Alert,
86
+ {
87
+ variant: "outlined",
88
+ severity: "error",
89
+ action: /* @__PURE__ */ React.createElement(TechDocsBuildLogs, { buildLog }),
90
+ classes: { root: classes.root, message: classes.message }
91
+ },
92
+ "Building a newer version of this documentation failed.",
93
+ " ",
94
+ syncErrorMessage
95
+ ), /* @__PURE__ */ React.createElement(TechDocsNotFound, { errorMessage: contentErrorMessage }));
96
+ }
97
+ return StateAlert;
98
+ };
99
+
100
+ export { TechDocsStateIndicator };
101
+ //# sourceMappingURL=TechDocsStateIndicator.esm.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"TechDocsStateIndicator.esm.js","sources":["../../../src/reader/components/TechDocsStateIndicator.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 CircularProgress from '@material-ui/core/CircularProgress';\nimport Button from '@material-ui/core/Button';\nimport { makeStyles } from '@material-ui/core/styles';\nimport Alert from '@material-ui/lab/Alert';\n\nimport { TechDocsBuildLogs } from './TechDocsBuildLogs';\nimport { TechDocsNotFound } from './TechDocsNotFound';\nimport { useTechDocsReader } from './TechDocsReaderProvider';\n\nconst useStyles = makeStyles(theme => ({\n root: {\n marginBottom: theme.spacing(2),\n },\n message: {\n // `word-break: break-word` is deprecated, but gives legacy support to browsers not supporting `overflow-wrap` yet\n // https://developer.mozilla.org/en-US/docs/Web/CSS/word-break\n wordBreak: 'break-word',\n overflowWrap: 'anywhere',\n },\n}));\n\nexport const TechDocsStateIndicator = () => {\n let StateAlert: JSX.Element | null = null;\n const classes = useStyles();\n\n const {\n state,\n contentReload,\n contentErrorMessage,\n syncErrorMessage,\n buildLog,\n } = useTechDocsReader();\n\n if (state === 'INITIAL_BUILD') {\n StateAlert = (\n <Alert\n classes={{ root: classes.root }}\n variant=\"outlined\"\n severity=\"info\"\n icon={<CircularProgress size=\"24px\" />}\n action={<TechDocsBuildLogs buildLog={buildLog} />}\n >\n Documentation is accessed for the first time and is being prepared. The\n subsequent loads are much faster.\n </Alert>\n );\n }\n\n if (state === 'CONTENT_STALE_REFRESHING') {\n StateAlert = (\n <Alert\n variant=\"outlined\"\n severity=\"info\"\n icon={<CircularProgress size=\"24px\" />}\n action={<TechDocsBuildLogs buildLog={buildLog} />}\n classes={{ root: classes.root }}\n >\n A newer version of this documentation is being prepared and will be\n available shortly.\n </Alert>\n );\n }\n\n if (state === 'CONTENT_STALE_READY') {\n StateAlert = (\n <Alert\n variant=\"outlined\"\n severity=\"success\"\n action={\n <Button color=\"inherit\" onClick={() => contentReload()}>\n Refresh\n </Button>\n }\n classes={{ root: classes.root }}\n >\n A newer version of this documentation is now available, please refresh\n to view.\n </Alert>\n );\n }\n\n if (state === 'CONTENT_STALE_ERROR') {\n StateAlert = (\n <Alert\n variant=\"outlined\"\n severity=\"error\"\n action={<TechDocsBuildLogs buildLog={buildLog} />}\n classes={{ root: classes.root, message: classes.message }}\n >\n Building a newer version of this documentation failed.{' '}\n {syncErrorMessage}\n </Alert>\n );\n }\n\n if (state === 'CONTENT_NOT_FOUND') {\n StateAlert = (\n <>\n {syncErrorMessage && (\n <Alert\n variant=\"outlined\"\n severity=\"error\"\n action={<TechDocsBuildLogs buildLog={buildLog} />}\n classes={{ root: classes.root, message: classes.message }}\n >\n Building a newer version of this documentation failed.{' '}\n {syncErrorMessage}\n </Alert>\n )}\n <TechDocsNotFound errorMessage={contentErrorMessage} />\n </>\n );\n }\n\n return StateAlert;\n};\n"],"names":[],"mappings":";;;;;;;;;AA0BA,MAAM,SAAA,GAAY,WAAW,CAAU,KAAA,MAAA;AAAA,EACrC,IAAM,EAAA;AAAA,IACJ,YAAA,EAAc,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,GAC/B;AAAA,EACA,OAAS,EAAA;AAAA;AAAA;AAAA,IAGP,SAAW,EAAA,YAAA;AAAA,IACX,YAAc,EAAA,UAAA;AAAA,GAChB;AACF,CAAE,CAAA,CAAA,CAAA;AAEK,MAAM,yBAAyB,MAAM;AAC1C,EAAA,IAAI,UAAiC,GAAA,IAAA,CAAA;AACrC,EAAA,MAAM,UAAU,SAAU,EAAA,CAAA;AAE1B,EAAM,MAAA;AAAA,IACJ,KAAA;AAAA,IACA,aAAA;AAAA,IACA,mBAAA;AAAA,IACA,gBAAA;AAAA,IACA,QAAA;AAAA,MACE,iBAAkB,EAAA,CAAA;AAEtB,EAAA,IAAI,UAAU,eAAiB,EAAA;AAC7B,IACE,UAAA,mBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,KAAA;AAAA,MAAA;AAAA,QACC,OAAS,EAAA,EAAE,IAAM,EAAA,OAAA,CAAQ,IAAK,EAAA;AAAA,QAC9B,OAAQ,EAAA,UAAA;AAAA,QACR,QAAS,EAAA,MAAA;AAAA,QACT,IAAM,kBAAA,KAAA,CAAA,aAAA,CAAC,gBAAiB,EAAA,EAAA,IAAA,EAAK,MAAO,EAAA,CAAA;AAAA,QACpC,MAAA,kBAAS,KAAA,CAAA,aAAA,CAAA,iBAAA,EAAA,EAAkB,QAAoB,EAAA,CAAA;AAAA,OAAA;AAAA,MAChD,2GAAA;AAAA,KAGD,CAAA;AAAA,GAEJ;AAEA,EAAA,IAAI,UAAU,0BAA4B,EAAA;AACxC,IACE,UAAA,mBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,KAAA;AAAA,MAAA;AAAA,QACC,OAAQ,EAAA,UAAA;AAAA,QACR,QAAS,EAAA,MAAA;AAAA,QACT,IAAM,kBAAA,KAAA,CAAA,aAAA,CAAC,gBAAiB,EAAA,EAAA,IAAA,EAAK,MAAO,EAAA,CAAA;AAAA,QACpC,MAAA,kBAAS,KAAA,CAAA,aAAA,CAAA,iBAAA,EAAA,EAAkB,QAAoB,EAAA,CAAA;AAAA,QAC/C,OAAS,EAAA,EAAE,IAAM,EAAA,OAAA,CAAQ,IAAK,EAAA;AAAA,OAAA;AAAA,MAC/B,wFAAA;AAAA,KAGD,CAAA;AAAA,GAEJ;AAEA,EAAA,IAAI,UAAU,qBAAuB,EAAA;AACnC,IACE,UAAA,mBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,KAAA;AAAA,MAAA;AAAA,QACC,OAAQ,EAAA,UAAA;AAAA,QACR,QAAS,EAAA,SAAA;AAAA,QACT,MAAA,sCACG,MAAO,EAAA,EAAA,KAAA,EAAM,WAAU,OAAS,EAAA,MAAM,aAAc,EAAA,EAAA,EAAG,SAExD,CAAA;AAAA,QAEF,OAAS,EAAA,EAAE,IAAM,EAAA,OAAA,CAAQ,IAAK,EAAA;AAAA,OAAA;AAAA,MAC/B,iFAAA;AAAA,KAGD,CAAA;AAAA,GAEJ;AAEA,EAAA,IAAI,UAAU,qBAAuB,EAAA;AACnC,IACE,UAAA,mBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,KAAA;AAAA,MAAA;AAAA,QACC,OAAQ,EAAA,UAAA;AAAA,QACR,QAAS,EAAA,OAAA;AAAA,QACT,MAAA,kBAAS,KAAA,CAAA,aAAA,CAAA,iBAAA,EAAA,EAAkB,QAAoB,EAAA,CAAA;AAAA,QAC/C,SAAS,EAAE,IAAA,EAAM,QAAQ,IAAM,EAAA,OAAA,EAAS,QAAQ,OAAQ,EAAA;AAAA,OAAA;AAAA,MACzD,wDAAA;AAAA,MACwD,GAAA;AAAA,MACtD,gBAAA;AAAA,KACH,CAAA;AAAA,GAEJ;AAEA,EAAA,IAAI,UAAU,mBAAqB,EAAA;AACjC,IAAA,UAAA,6DAEK,gBACC,oBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,KAAA;AAAA,MAAA;AAAA,QACC,OAAQ,EAAA,UAAA;AAAA,QACR,QAAS,EAAA,OAAA;AAAA,QACT,MAAA,kBAAS,KAAA,CAAA,aAAA,CAAA,iBAAA,EAAA,EAAkB,QAAoB,EAAA,CAAA;AAAA,QAC/C,SAAS,EAAE,IAAA,EAAM,QAAQ,IAAM,EAAA,OAAA,EAAS,QAAQ,OAAQ,EAAA;AAAA,OAAA;AAAA,MACzD,wDAAA;AAAA,MACwD,GAAA;AAAA,MACtD,gBAAA;AAAA,KAGL,kBAAA,KAAA,CAAA,aAAA,CAAC,gBAAiB,EAAA,EAAA,YAAA,EAAc,qBAAqB,CACvD,CAAA,CAAA;AAAA,GAEJ;AAEA,EAAO,OAAA,UAAA,CAAA;AACT;;;;"}
@@ -0,0 +1,163 @@
1
+ import { useApi } from '@backstage/core-plugin-api';
2
+ import { useReducer, useRef, useMemo } from 'react';
3
+ import useAsync from 'react-use/esm/useAsync';
4
+ import useAsyncRetry from 'react-use/esm/useAsyncRetry';
5
+ import { techdocsStorageApiRef } from '@backstage/plugin-techdocs-react';
6
+
7
+ function calculateDisplayState({
8
+ contentLoading,
9
+ content,
10
+ activeSyncState
11
+ }) {
12
+ if (contentLoading) {
13
+ return "CHECKING";
14
+ }
15
+ if (activeSyncState === "BUILD_READY_RELOAD") {
16
+ return "CHECKING";
17
+ }
18
+ if (!content && activeSyncState === "CHECKING") {
19
+ return "CHECKING";
20
+ }
21
+ if (!content && activeSyncState === "BUILDING") {
22
+ return "INITIAL_BUILD";
23
+ }
24
+ if (!content) {
25
+ return "CONTENT_NOT_FOUND";
26
+ }
27
+ if (activeSyncState === "BUILDING") {
28
+ return "CONTENT_STALE_REFRESHING";
29
+ }
30
+ if (activeSyncState === "BUILD_READY") {
31
+ return "CONTENT_STALE_READY";
32
+ }
33
+ if (activeSyncState === "ERROR") {
34
+ return "CONTENT_STALE_ERROR";
35
+ }
36
+ return "CONTENT_FRESH";
37
+ }
38
+ function reducer(oldState, action) {
39
+ const newState = { ...oldState };
40
+ switch (action.type) {
41
+ case "sync":
42
+ if (action.state === "CHECKING") {
43
+ newState.buildLog = [];
44
+ }
45
+ newState.activeSyncState = action.state;
46
+ newState.syncError = action.syncError;
47
+ break;
48
+ case "contentLoading":
49
+ newState.contentLoading = true;
50
+ newState.contentError = void 0;
51
+ break;
52
+ case "content":
53
+ if (typeof action.path === "string") {
54
+ newState.path = action.path;
55
+ }
56
+ newState.contentLoading = false;
57
+ newState.content = action.content;
58
+ newState.contentError = action.contentError;
59
+ break;
60
+ case "buildLog":
61
+ newState.buildLog = newState.buildLog.concat(action.log);
62
+ break;
63
+ default:
64
+ throw new Error();
65
+ }
66
+ if (["BUILD_READY", "BUILD_READY_RELOAD"].includes(newState.activeSyncState) && ["contentLoading", "content"].includes(action.type)) {
67
+ newState.activeSyncState = "UP_TO_DATE";
68
+ newState.buildLog = [];
69
+ }
70
+ return newState;
71
+ }
72
+ function useReaderState(kind, namespace, name, path) {
73
+ var _a, _b;
74
+ const [state, dispatch] = useReducer(reducer, {
75
+ activeSyncState: "CHECKING",
76
+ path,
77
+ contentLoading: true,
78
+ buildLog: []
79
+ });
80
+ const techdocsStorageApi = useApi(techdocsStorageApiRef);
81
+ const { retry: contentReload } = useAsyncRetry(async () => {
82
+ dispatch({ type: "contentLoading" });
83
+ try {
84
+ const entityDocs = await techdocsStorageApi.getEntityDocs(
85
+ { kind, namespace, name },
86
+ path
87
+ );
88
+ dispatch({ type: "content", content: entityDocs, path });
89
+ return entityDocs;
90
+ } catch (e) {
91
+ dispatch({ type: "content", contentError: e, path });
92
+ }
93
+ return void 0;
94
+ }, [techdocsStorageApi, kind, namespace, name, path]);
95
+ const contentRef = useRef({
96
+ content: void 0,
97
+ reload: () => {
98
+ }
99
+ });
100
+ contentRef.current = { content: state.content, reload: contentReload };
101
+ useAsync(async () => {
102
+ dispatch({ type: "sync", state: "CHECKING" });
103
+ const buildingTimeout = setTimeout(() => {
104
+ dispatch({ type: "sync", state: "BUILDING" });
105
+ }, 1e3);
106
+ try {
107
+ const result = await techdocsStorageApi.syncEntityDocs(
108
+ {
109
+ kind,
110
+ namespace,
111
+ name
112
+ },
113
+ (log) => {
114
+ dispatch({ type: "buildLog", log });
115
+ }
116
+ );
117
+ switch (result) {
118
+ case "updated":
119
+ if (!contentRef.current.content) {
120
+ contentRef.current.reload();
121
+ dispatch({ type: "sync", state: "BUILD_READY_RELOAD" });
122
+ } else {
123
+ dispatch({ type: "sync", state: "BUILD_READY" });
124
+ }
125
+ break;
126
+ case "cached":
127
+ dispatch({ type: "sync", state: "UP_TO_DATE" });
128
+ break;
129
+ default:
130
+ dispatch({
131
+ type: "sync",
132
+ state: "ERROR",
133
+ syncError: new Error("Unexpected return state")
134
+ });
135
+ break;
136
+ }
137
+ } catch (e) {
138
+ dispatch({ type: "sync", state: "ERROR", syncError: e });
139
+ } finally {
140
+ clearTimeout(buildingTimeout);
141
+ }
142
+ }, [kind, name, namespace, techdocsStorageApi, dispatch, contentRef]);
143
+ const displayState = useMemo(
144
+ () => calculateDisplayState({
145
+ activeSyncState: state.activeSyncState,
146
+ contentLoading: state.contentLoading,
147
+ content: state.content
148
+ }),
149
+ [state.activeSyncState, state.content, state.contentLoading]
150
+ );
151
+ return {
152
+ state: displayState,
153
+ contentReload,
154
+ path: state.path,
155
+ content: state.content,
156
+ contentErrorMessage: (_a = state.contentError) == null ? void 0 : _a.toString(),
157
+ syncErrorMessage: (_b = state.syncError) == null ? void 0 : _b.toString(),
158
+ buildLog: state.buildLog
159
+ };
160
+ }
161
+
162
+ export { calculateDisplayState, reducer, useReaderState };
163
+ //# sourceMappingURL=useReaderState.esm.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useReaderState.esm.js","sources":["../../../src/reader/components/useReaderState.ts"],"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 { useApi } from '@backstage/core-plugin-api';\nimport { useMemo, useReducer, useRef } from 'react';\nimport useAsync from 'react-use/esm/useAsync';\nimport useAsyncRetry from 'react-use/esm/useAsyncRetry';\nimport { techdocsStorageApiRef } from '@backstage/plugin-techdocs-react';\n\n/**\n * @public\n * A state representation that is used to configure the UI of <Reader />\n */\nexport type ContentStateTypes =\n /** There is nothing to display but a loading indicator */\n | 'CHECKING'\n\n /** There is no content yet -> present a full screen loading page */\n | 'INITIAL_BUILD'\n\n /** There is content, but the backend is about to update it */\n | 'CONTENT_STALE_REFRESHING'\n\n /** There is content, but after a reload, the content will be different */\n | 'CONTENT_STALE_READY'\n\n /** There is content, the backend tried to update it, but failed */\n | 'CONTENT_STALE_ERROR'\n\n /** There is nothing to see but a \"not found\" page. Is also shown on page load errors */\n | 'CONTENT_NOT_FOUND'\n\n /** There is only the latest and greatest content */\n | 'CONTENT_FRESH';\n\n/**\n * Calculate the state that should be reported to the display component.\n */\nexport function calculateDisplayState({\n contentLoading,\n content,\n activeSyncState,\n}: Pick<\n ReducerState,\n 'contentLoading' | 'content' | 'activeSyncState'\n>): ContentStateTypes {\n // we have nothing to display yet\n if (contentLoading) {\n return 'CHECKING';\n }\n\n // the build is ready, but it triggered a content reload and the content variable is not trusted\n if (activeSyncState === 'BUILD_READY_RELOAD') {\n return 'CHECKING';\n }\n\n // there is no content, but the sync process is still evaluating\n if (!content && activeSyncState === 'CHECKING') {\n return 'CHECKING';\n }\n\n // there is no content yet so we assume that we are building it for the first time\n if (!content && activeSyncState === 'BUILDING') {\n return 'INITIAL_BUILD';\n }\n\n // if there is still no content after building, it might just not exist\n if (!content) {\n return 'CONTENT_NOT_FOUND';\n }\n\n // we are still building, but we already show stale content\n if (activeSyncState === 'BUILDING') {\n return 'CONTENT_STALE_REFRESHING';\n }\n\n // the build is ready, but the content is still stale\n if (activeSyncState === 'BUILD_READY') {\n return 'CONTENT_STALE_READY';\n }\n\n // the build failed, but the content is still stale\n if (activeSyncState === 'ERROR') {\n return 'CONTENT_STALE_ERROR';\n }\n\n // seems like the content is up-to-date (or we don't know yet and the sync process is still evaluating in the background)\n return 'CONTENT_FRESH';\n}\n\n/**\n * The state of the synchronization task. It checks whether the docs are\n * up-to-date. If they aren't, it triggers a build.\n */\ntype SyncStates =\n /** Checking if it should be synced */\n | 'CHECKING'\n\n /** Building the documentation */\n | 'BUILDING'\n\n /** Finished building the documentation */\n | 'BUILD_READY'\n\n /**\n * Finished building the documentation and triggered a content reload.\n * This state is left toward UP_TO_DATE when the content loading has finished.\n */\n | 'BUILD_READY_RELOAD'\n\n /** No need for a sync. The content was already up-to-date. */\n | 'UP_TO_DATE'\n\n /** An error occurred */\n | 'ERROR';\n\ntype ReducerActions =\n | {\n type: 'sync';\n state: SyncStates;\n syncError?: Error;\n }\n | { type: 'contentLoading' }\n | {\n type: 'content';\n path?: string;\n content?: string;\n contentError?: Error;\n }\n | { type: 'buildLog'; log: string };\n\ntype ReducerState = {\n /**\n * The path of the current page\n */\n path: string;\n\n /**\n * The current sync state\n */\n activeSyncState: SyncStates;\n\n /**\n * If true, the content is downloading from the storage.\n */\n contentLoading: boolean;\n /**\n * The content that has been downloaded and should be displayed.\n */\n content?: string;\n\n contentError?: Error;\n syncError?: Error;\n\n /**\n * A list of log messages that were emitted by the build process.\n */\n buildLog: string[];\n};\n\nexport function reducer(\n oldState: ReducerState,\n action: ReducerActions,\n): ReducerState {\n const newState = { ...oldState };\n\n switch (action.type) {\n case 'sync':\n // reset the build log when a new check starts\n if (action.state === 'CHECKING') {\n newState.buildLog = [];\n }\n\n newState.activeSyncState = action.state;\n newState.syncError = action.syncError;\n break;\n\n case 'contentLoading':\n newState.contentLoading = true;\n\n // only reset errors but keep the old content until it is replaced by the 'content' action\n newState.contentError = undefined;\n break;\n\n case 'content':\n // only override the path if it is part of the action\n if (typeof action.path === 'string') {\n newState.path = action.path;\n }\n\n newState.contentLoading = false;\n newState.content = action.content;\n newState.contentError = action.contentError;\n break;\n\n case 'buildLog':\n newState.buildLog = newState.buildLog.concat(action.log);\n break;\n\n default:\n throw new Error();\n }\n\n // a content update loads fresh content so the build is updated to being up-to-date\n if (\n ['BUILD_READY', 'BUILD_READY_RELOAD'].includes(newState.activeSyncState) &&\n ['contentLoading', 'content'].includes(action.type)\n ) {\n newState.activeSyncState = 'UP_TO_DATE';\n newState.buildLog = [];\n }\n\n return newState;\n}\n/**\n * @public shared reader state\n */\nexport type ReaderState = {\n state: ContentStateTypes;\n path: string;\n contentReload: () => void;\n content?: string;\n contentErrorMessage?: string;\n syncErrorMessage?: string;\n buildLog: string[];\n};\n\nexport function useReaderState(\n kind: string,\n namespace: string,\n name: string,\n path: string,\n): ReaderState {\n const [state, dispatch] = useReducer(reducer, {\n activeSyncState: 'CHECKING',\n path,\n contentLoading: true,\n buildLog: [],\n });\n\n const techdocsStorageApi = useApi(techdocsStorageApiRef);\n\n // try to load the content. the function will fire events and we don't care for the return values\n const { retry: contentReload } = useAsyncRetry(async () => {\n dispatch({ type: 'contentLoading' });\n\n try {\n const entityDocs = await techdocsStorageApi.getEntityDocs(\n { kind, namespace, name },\n path,\n );\n\n // update content and path at the same time\n dispatch({ type: 'content', content: entityDocs, path });\n\n return entityDocs;\n } catch (e) {\n dispatch({ type: 'content', contentError: e, path });\n }\n\n return undefined;\n }, [techdocsStorageApi, kind, namespace, name, path]);\n\n // create a ref that holds the latest content. This provides a useAsync hook\n // with the latest content without restarting the useAsync hook.\n const contentRef = useRef<{ content?: string; reload: () => void }>({\n content: undefined,\n reload: () => {},\n });\n contentRef.current = { content: state.content, reload: contentReload };\n\n // try to derive the state. the function will fire events and we don't care for the return values\n useAsync(async () => {\n dispatch({ type: 'sync', state: 'CHECKING' });\n\n // should only switch to BUILDING if the request takes more than 1 seconds\n const buildingTimeout = setTimeout(() => {\n dispatch({ type: 'sync', state: 'BUILDING' });\n }, 1000);\n\n try {\n const result = await techdocsStorageApi.syncEntityDocs(\n {\n kind,\n namespace,\n name,\n },\n log => {\n dispatch({ type: 'buildLog', log });\n },\n );\n\n switch (result) {\n case 'updated':\n // if there was no content prior to building, retry the loading\n if (!contentRef.current.content) {\n contentRef.current.reload();\n dispatch({ type: 'sync', state: 'BUILD_READY_RELOAD' });\n } else {\n dispatch({ type: 'sync', state: 'BUILD_READY' });\n }\n break;\n case 'cached':\n dispatch({ type: 'sync', state: 'UP_TO_DATE' });\n break;\n\n default:\n dispatch({\n type: 'sync',\n state: 'ERROR',\n syncError: new Error('Unexpected return state'),\n });\n break;\n }\n } catch (e) {\n dispatch({ type: 'sync', state: 'ERROR', syncError: e });\n } finally {\n // Cancel the timer that sets the state \"BUILDING\"\n clearTimeout(buildingTimeout);\n }\n }, [kind, name, namespace, techdocsStorageApi, dispatch, contentRef]);\n\n const displayState = useMemo(\n () =>\n calculateDisplayState({\n activeSyncState: state.activeSyncState,\n contentLoading: state.contentLoading,\n content: state.content,\n }),\n [state.activeSyncState, state.content, state.contentLoading],\n );\n\n return {\n state: displayState,\n contentReload,\n path: state.path,\n content: state.content,\n contentErrorMessage: state.contentError?.toString(),\n syncErrorMessage: state.syncError?.toString(),\n buildLog: state.buildLog,\n };\n}\n"],"names":[],"mappings":";;;;;;AAmDO,SAAS,qBAAsB,CAAA;AAAA,EACpC,cAAA;AAAA,EACA,OAAA;AAAA,EACA,eAAA;AACF,CAGsB,EAAA;AAEpB,EAAA,IAAI,cAAgB,EAAA;AAClB,IAAO,OAAA,UAAA,CAAA;AAAA,GACT;AAGA,EAAA,IAAI,oBAAoB,oBAAsB,EAAA;AAC5C,IAAO,OAAA,UAAA,CAAA;AAAA,GACT;AAGA,EAAI,IAAA,CAAC,OAAW,IAAA,eAAA,KAAoB,UAAY,EAAA;AAC9C,IAAO,OAAA,UAAA,CAAA;AAAA,GACT;AAGA,EAAI,IAAA,CAAC,OAAW,IAAA,eAAA,KAAoB,UAAY,EAAA;AAC9C,IAAO,OAAA,eAAA,CAAA;AAAA,GACT;AAGA,EAAA,IAAI,CAAC,OAAS,EAAA;AACZ,IAAO,OAAA,mBAAA,CAAA;AAAA,GACT;AAGA,EAAA,IAAI,oBAAoB,UAAY,EAAA;AAClC,IAAO,OAAA,0BAAA,CAAA;AAAA,GACT;AAGA,EAAA,IAAI,oBAAoB,aAAe,EAAA;AACrC,IAAO,OAAA,qBAAA,CAAA;AAAA,GACT;AAGA,EAAA,IAAI,oBAAoB,OAAS,EAAA;AAC/B,IAAO,OAAA,qBAAA,CAAA;AAAA,GACT;AAGA,EAAO,OAAA,eAAA,CAAA;AACT,CAAA;AAwEgB,SAAA,OAAA,CACd,UACA,MACc,EAAA;AACd,EAAM,MAAA,QAAA,GAAW,EAAE,GAAG,QAAS,EAAA,CAAA;AAE/B,EAAA,QAAQ,OAAO,IAAM;AAAA,IACnB,KAAK,MAAA;AAEH,MAAI,IAAA,MAAA,CAAO,UAAU,UAAY,EAAA;AAC/B,QAAA,QAAA,CAAS,WAAW,EAAC,CAAA;AAAA,OACvB;AAEA,MAAA,QAAA,CAAS,kBAAkB,MAAO,CAAA,KAAA,CAAA;AAClC,MAAA,QAAA,CAAS,YAAY,MAAO,CAAA,SAAA,CAAA;AAC5B,MAAA,MAAA;AAAA,IAEF,KAAK,gBAAA;AACH,MAAA,QAAA,CAAS,cAAiB,GAAA,IAAA,CAAA;AAG1B,MAAA,QAAA,CAAS,YAAe,GAAA,KAAA,CAAA,CAAA;AACxB,MAAA,MAAA;AAAA,IAEF,KAAK,SAAA;AAEH,MAAI,IAAA,OAAO,MAAO,CAAA,IAAA,KAAS,QAAU,EAAA;AACnC,QAAA,QAAA,CAAS,OAAO,MAAO,CAAA,IAAA,CAAA;AAAA,OACzB;AAEA,MAAA,QAAA,CAAS,cAAiB,GAAA,KAAA,CAAA;AAC1B,MAAA,QAAA,CAAS,UAAU,MAAO,CAAA,OAAA,CAAA;AAC1B,MAAA,QAAA,CAAS,eAAe,MAAO,CAAA,YAAA,CAAA;AAC/B,MAAA,MAAA;AAAA,IAEF,KAAK,UAAA;AACH,MAAA,QAAA,CAAS,QAAW,GAAA,QAAA,CAAS,QAAS,CAAA,MAAA,CAAO,OAAO,GAAG,CAAA,CAAA;AACvD,MAAA,MAAA;AAAA,IAEF;AACE,MAAA,MAAM,IAAI,KAAM,EAAA,CAAA;AAAA,GACpB;AAGA,EAAA,IACE,CAAC,aAAA,EAAe,oBAAoB,CAAA,CAAE,SAAS,QAAS,CAAA,eAAe,CACvE,IAAA,CAAC,kBAAkB,SAAS,CAAA,CAAE,QAAS,CAAA,MAAA,CAAO,IAAI,CAClD,EAAA;AACA,IAAA,QAAA,CAAS,eAAkB,GAAA,YAAA,CAAA;AAC3B,IAAA,QAAA,CAAS,WAAW,EAAC,CAAA;AAAA,GACvB;AAEA,EAAO,OAAA,QAAA,CAAA;AACT,CAAA;AAcO,SAAS,cACd,CAAA,IAAA,EACA,SACA,EAAA,IAAA,EACA,IACa,EAAA;AArPf,EAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAsPE,EAAA,MAAM,CAAC,KAAA,EAAO,QAAQ,CAAA,GAAI,WAAW,OAAS,EAAA;AAAA,IAC5C,eAAiB,EAAA,UAAA;AAAA,IACjB,IAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,UAAU,EAAC;AAAA,GACZ,CAAA,CAAA;AAED,EAAM,MAAA,kBAAA,GAAqB,OAAO,qBAAqB,CAAA,CAAA;AAGvD,EAAA,MAAM,EAAE,KAAA,EAAO,aAAc,EAAA,GAAI,cAAc,YAAY;AACzD,IAAS,QAAA,CAAA,EAAE,IAAM,EAAA,gBAAA,EAAkB,CAAA,CAAA;AAEnC,IAAI,IAAA;AACF,MAAM,MAAA,UAAA,GAAa,MAAM,kBAAmB,CAAA,aAAA;AAAA,QAC1C,EAAE,IAAM,EAAA,SAAA,EAAW,IAAK,EAAA;AAAA,QACxB,IAAA;AAAA,OACF,CAAA;AAGA,MAAA,QAAA,CAAS,EAAE,IAAM,EAAA,SAAA,EAAW,OAAS,EAAA,UAAA,EAAY,MAAM,CAAA,CAAA;AAEvD,MAAO,OAAA,UAAA,CAAA;AAAA,aACA,CAAG,EAAA;AACV,MAAA,QAAA,CAAS,EAAE,IAAM,EAAA,SAAA,EAAW,YAAc,EAAA,CAAA,EAAG,MAAM,CAAA,CAAA;AAAA,KACrD;AAEA,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,KACN,CAAC,kBAAA,EAAoB,MAAM,SAAW,EAAA,IAAA,EAAM,IAAI,CAAC,CAAA,CAAA;AAIpD,EAAA,MAAM,aAAa,MAAiD,CAAA;AAAA,IAClE,OAAS,EAAA,KAAA,CAAA;AAAA,IACT,QAAQ,MAAM;AAAA,KAAC;AAAA,GAChB,CAAA,CAAA;AACD,EAAA,UAAA,CAAW,UAAU,EAAE,OAAA,EAAS,KAAM,CAAA,OAAA,EAAS,QAAQ,aAAc,EAAA,CAAA;AAGrE,EAAA,QAAA,CAAS,YAAY;AACnB,IAAA,QAAA,CAAS,EAAE,IAAA,EAAM,MAAQ,EAAA,KAAA,EAAO,YAAY,CAAA,CAAA;AAG5C,IAAM,MAAA,eAAA,GAAkB,WAAW,MAAM;AACvC,MAAA,QAAA,CAAS,EAAE,IAAA,EAAM,MAAQ,EAAA,KAAA,EAAO,YAAY,CAAA,CAAA;AAAA,OAC3C,GAAI,CAAA,CAAA;AAEP,IAAI,IAAA;AACF,MAAM,MAAA,MAAA,GAAS,MAAM,kBAAmB,CAAA,cAAA;AAAA,QACtC;AAAA,UACE,IAAA;AAAA,UACA,SAAA;AAAA,UACA,IAAA;AAAA,SACF;AAAA,QACA,CAAO,GAAA,KAAA;AACL,UAAA,QAAA,CAAS,EAAE,IAAA,EAAM,UAAY,EAAA,GAAA,EAAK,CAAA,CAAA;AAAA,SACpC;AAAA,OACF,CAAA;AAEA,MAAA,QAAQ,MAAQ;AAAA,QACd,KAAK,SAAA;AAEH,UAAI,IAAA,CAAC,UAAW,CAAA,OAAA,CAAQ,OAAS,EAAA;AAC/B,YAAA,UAAA,CAAW,QAAQ,MAAO,EAAA,CAAA;AAC1B,YAAA,QAAA,CAAS,EAAE,IAAA,EAAM,MAAQ,EAAA,KAAA,EAAO,sBAAsB,CAAA,CAAA;AAAA,WACjD,MAAA;AACL,YAAA,QAAA,CAAS,EAAE,IAAA,EAAM,MAAQ,EAAA,KAAA,EAAO,eAAe,CAAA,CAAA;AAAA,WACjD;AACA,UAAA,MAAA;AAAA,QACF,KAAK,QAAA;AACH,UAAA,QAAA,CAAS,EAAE,IAAA,EAAM,MAAQ,EAAA,KAAA,EAAO,cAAc,CAAA,CAAA;AAC9C,UAAA,MAAA;AAAA,QAEF;AACE,UAAS,QAAA,CAAA;AAAA,YACP,IAAM,EAAA,MAAA;AAAA,YACN,KAAO,EAAA,OAAA;AAAA,YACP,SAAA,EAAW,IAAI,KAAA,CAAM,yBAAyB,CAAA;AAAA,WAC/C,CAAA,CAAA;AACD,UAAA,MAAA;AAAA,OACJ;AAAA,aACO,CAAG,EAAA;AACV,MAAA,QAAA,CAAS,EAAE,IAAM,EAAA,MAAA,EAAQ,OAAO,OAAS,EAAA,SAAA,EAAW,GAAG,CAAA,CAAA;AAAA,KACvD,SAAA;AAEA,MAAA,YAAA,CAAa,eAAe,CAAA,CAAA;AAAA,KAC9B;AAAA,GACF,EAAG,CAAC,IAAM,EAAA,IAAA,EAAM,WAAW,kBAAoB,EAAA,QAAA,EAAU,UAAU,CAAC,CAAA,CAAA;AAEpE,EAAA,MAAM,YAAe,GAAA,OAAA;AAAA,IACnB,MACE,qBAAsB,CAAA;AAAA,MACpB,iBAAiB,KAAM,CAAA,eAAA;AAAA,MACvB,gBAAgB,KAAM,CAAA,cAAA;AAAA,MACtB,SAAS,KAAM,CAAA,OAAA;AAAA,KAChB,CAAA;AAAA,IACH,CAAC,KAAM,CAAA,eAAA,EAAiB,KAAM,CAAA,OAAA,EAAS,MAAM,cAAc,CAAA;AAAA,GAC7D,CAAA;AAEA,EAAO,OAAA;AAAA,IACL,KAAO,EAAA,YAAA;AAAA,IACP,aAAA;AAAA,IACA,MAAM,KAAM,CAAA,IAAA;AAAA,IACZ,SAAS,KAAM,CAAA,OAAA;AAAA,IACf,mBAAA,EAAA,CAAqB,EAAM,GAAA,KAAA,CAAA,YAAA,KAAN,IAAoB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,QAAA,EAAA;AAAA,IACzC,gBAAA,EAAA,CAAkB,EAAM,GAAA,KAAA,CAAA,SAAA,KAAN,IAAiB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,QAAA,EAAA;AAAA,IACnC,UAAU,KAAM,CAAA,QAAA;AAAA,GAClB,CAAA;AACF;;;;"}