@backstage/plugin-techdocs 0.0.0-nightly-20250129022746 → 0.0.0-nightly-20250131022942
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
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20250131022942
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
|
+
- eb3d91a: Use the custom error page if provided for displaying errors instead of the default error page
|
|
7
8
|
- 524f0af: Add missing route ref to the `/alpha` entity content extension.
|
|
8
9
|
- f4be934: Changed the base URL in addLinkClickListener from window.location.origin to app.baseUrl for improved path handling. This fixes an issue where Backstage, when running on a subpath, was unable to handle non-Backstage URLs of the same origin correctly.
|
|
9
10
|
- 1f40e6b: Add optional props to `TechDocCustomHome` to allow for more flexibility:
|
|
@@ -119,16 +120,16 @@
|
|
|
119
120
|
|
|
120
121
|
- 58ec9e7: Removed older versions of React packages as a preparatory step for upgrading to React 19. This commit does not introduce any functional changes, but removes dependencies on previous React versions, allowing for a cleaner upgrade path in subsequent commits.
|
|
121
122
|
- Updated dependencies
|
|
122
|
-
- @backstage/plugin-search-react@0.0.0-nightly-
|
|
123
|
-
- @backstage/core-components@0.0.0-nightly-
|
|
124
|
-
- @backstage/
|
|
125
|
-
- @backstage/
|
|
126
|
-
- @backstage/
|
|
127
|
-
- @backstage/core-
|
|
128
|
-
- @backstage/plugin-
|
|
129
|
-
- @backstage/plugin-
|
|
130
|
-
- @backstage/plugin-auth-react@0.0.0-nightly-
|
|
131
|
-
- @backstage/theme@0.0.0-nightly-
|
|
123
|
+
- @backstage/plugin-search-react@0.0.0-nightly-20250131022942
|
|
124
|
+
- @backstage/core-components@0.0.0-nightly-20250131022942
|
|
125
|
+
- @backstage/plugin-catalog-react@0.0.0-nightly-20250131022942
|
|
126
|
+
- @backstage/frontend-plugin-api@0.0.0-nightly-20250131022942
|
|
127
|
+
- @backstage/integration-react@0.0.0-nightly-20250131022942
|
|
128
|
+
- @backstage/core-compat-api@0.0.0-nightly-20250131022942
|
|
129
|
+
- @backstage/core-plugin-api@0.0.0-nightly-20250131022942
|
|
130
|
+
- @backstage/plugin-techdocs-react@0.0.0-nightly-20250131022942
|
|
131
|
+
- @backstage/plugin-auth-react@0.0.0-nightly-20250131022942
|
|
132
|
+
- @backstage/theme@0.0.0-nightly-20250131022942
|
|
132
133
|
- @backstage/catalog-client@1.9.1
|
|
133
134
|
- @backstage/catalog-model@1.7.3
|
|
134
135
|
- @backstage/config@1.3.2
|
|
@@ -2,12 +2,13 @@ import React, { useEffect, useCallback } from 'react';
|
|
|
2
2
|
import Grid from '@material-ui/core/Grid';
|
|
3
3
|
import { makeStyles } from '@material-ui/core/styles';
|
|
4
4
|
import { useTechDocsReaderPage, useShadowDomStylesLoading, useShadowRootElements, TechDocsShadowDom } from '@backstage/plugin-techdocs-react';
|
|
5
|
-
import {
|
|
5
|
+
import { Content, Progress } from '@backstage/core-components';
|
|
6
6
|
import { TechDocsSearch } from '../../../search/components/TechDocsSearch.esm.js';
|
|
7
7
|
import { TechDocsStateIndicator } from '../TechDocsStateIndicator.esm.js';
|
|
8
8
|
import { useTechDocsReaderDom } from './dom.esm.js';
|
|
9
9
|
import { withTechDocsReaderProvider, useTechDocsReader } from '../TechDocsReaderProvider.esm.js';
|
|
10
10
|
import { TechDocsReaderPageContentAddons } from './TechDocsReaderPageContentAddons.esm.js';
|
|
11
|
+
import { useApp } from '@backstage/core-plugin-api';
|
|
11
12
|
|
|
12
13
|
const useStyles = makeStyles({
|
|
13
14
|
search: {
|
|
@@ -36,6 +37,8 @@ const TechDocsReaderPageContent = withTechDocsReaderProvider(
|
|
|
36
37
|
const hash = window.location.hash;
|
|
37
38
|
const isStyleLoading = useShadowDomStylesLoading(dom);
|
|
38
39
|
const [hashElement] = useShadowRootElements([`[id="${hash.slice(1)}"]`]);
|
|
40
|
+
const app = useApp();
|
|
41
|
+
const { NotFoundErrorPage } = app.getComponents();
|
|
39
42
|
useEffect(() => {
|
|
40
43
|
if (isStyleLoading) return;
|
|
41
44
|
if (hash) {
|
|
@@ -56,7 +59,7 @@ const TechDocsReaderPageContent = withTechDocsReaderProvider(
|
|
|
56
59
|
[setShadowRoot, onReady]
|
|
57
60
|
);
|
|
58
61
|
if (entityMetadataLoading === false && !entityMetadata)
|
|
59
|
-
return /* @__PURE__ */ React.createElement(
|
|
62
|
+
return /* @__PURE__ */ React.createElement(NotFoundErrorPage, null);
|
|
60
63
|
if (!dom) {
|
|
61
64
|
return /* @__PURE__ */ React.createElement(Content, null, /* @__PURE__ */ React.createElement(Grid, { container: true }, /* @__PURE__ */ React.createElement(Grid, { xs: 12, item: true }, /* @__PURE__ */ React.createElement(TechDocsStateIndicator, null))));
|
|
62
65
|
}
|
package/dist/reader/components/TechDocsReaderPageContent/TechDocsReaderPageContent.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TechDocsReaderPageContent.esm.js","sources":["../../../../src/reader/components/TechDocsReaderPageContent/TechDocsReaderPageContent.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, { useCallback, useEffect } from 'react';\n\nimport Grid from '@material-ui/core/Grid';\nimport { makeStyles } from '@material-ui/core/styles';\n\nimport {\n TechDocsShadowDom,\n useShadowDomStylesLoading,\n useShadowRootElements,\n useTechDocsReaderPage,\n} from '@backstage/plugin-techdocs-react';\nimport { CompoundEntityRef } from '@backstage/catalog-model';\nimport { Content,
|
|
1
|
+
{"version":3,"file":"TechDocsReaderPageContent.esm.js","sources":["../../../../src/reader/components/TechDocsReaderPageContent/TechDocsReaderPageContent.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, { useCallback, useEffect } from 'react';\n\nimport Grid from '@material-ui/core/Grid';\nimport { makeStyles } from '@material-ui/core/styles';\n\nimport {\n TechDocsShadowDom,\n useShadowDomStylesLoading,\n useShadowRootElements,\n useTechDocsReaderPage,\n} from '@backstage/plugin-techdocs-react';\nimport { CompoundEntityRef } from '@backstage/catalog-model';\nimport { Content, Progress } from '@backstage/core-components';\n\nimport { TechDocsSearch } from '../../../search';\nimport { TechDocsStateIndicator } from '../TechDocsStateIndicator';\n\nimport { useTechDocsReaderDom } from './dom';\nimport {\n useTechDocsReader,\n withTechDocsReaderProvider,\n} from '../TechDocsReaderProvider';\nimport { TechDocsReaderPageContentAddons } from './TechDocsReaderPageContentAddons';\nimport { useApp } from '@backstage/core-plugin-api';\n\nconst useStyles = makeStyles({\n search: {\n width: '100%',\n '@media (min-width: 76.1875em)': {\n width: 'calc(100% - 34.4rem)',\n margin: '0 auto',\n },\n '@media print': {\n display: 'none',\n },\n },\n});\n\n/**\n * Props for {@link TechDocsReaderPageContent}\n * @public\n */\nexport type TechDocsReaderPageContentProps = {\n /**\n * @deprecated No need to pass down entityRef as property anymore. Consumes the entityName from `TechDocsReaderPageContext`. Use the {@link @backstage/plugin-techdocs-react#useTechDocsReaderPage} hook for custom reader page content.\n */\n entityRef?: CompoundEntityRef;\n /**\n * Show or hide the search bar, defaults to true.\n */\n withSearch?: boolean;\n /**\n * If {@link TechDocsReaderPageContentProps.withSearch | withSearch} is true,\n * this will redirect the search result urls, e.g. turn search results into\n * links within the \"Docs\" tab of the entity page, instead of the global docs\n * page.\n */\n searchResultUrlMapper?: (url: string) => string;\n /**\n * Callback called when the content is rendered.\n */\n onReady?: () => void;\n};\n\n/**\n * Renders the reader page content\n * @public\n */\nexport const TechDocsReaderPageContent = withTechDocsReaderProvider(\n (props: TechDocsReaderPageContentProps) => {\n const { withSearch = true, searchResultUrlMapper, onReady } = props;\n const classes = useStyles();\n\n const {\n entityMetadata: { value: entityMetadata, loading: entityMetadataLoading },\n entityRef,\n setShadowRoot,\n } = useTechDocsReaderPage();\n const { state } = useTechDocsReader();\n const dom = useTechDocsReaderDom(entityRef);\n const path = window.location.pathname;\n const hash = window.location.hash;\n const isStyleLoading = useShadowDomStylesLoading(dom);\n const [hashElement] = useShadowRootElements([`[id=\"${hash.slice(1)}\"]`]);\n const app = useApp();\n const { NotFoundErrorPage } = app.getComponents();\n\n useEffect(() => {\n if (isStyleLoading) return;\n\n if (hash) {\n if (hashElement) {\n hashElement.scrollIntoView();\n }\n } else {\n document?.querySelector('header')?.scrollIntoView();\n }\n }, [path, hash, hashElement, isStyleLoading]);\n\n const handleAppend = useCallback(\n (newShadowRoot: ShadowRoot) => {\n setShadowRoot(newShadowRoot);\n if (onReady instanceof Function) {\n onReady();\n }\n },\n [setShadowRoot, onReady],\n );\n\n // No entity metadata = 404. Don't render content at all.\n if (entityMetadataLoading === false && !entityMetadata)\n return <NotFoundErrorPage />;\n\n // Do not return content until dom is ready; instead, render a state\n // indicator, which handles progress and content errors on our behalf.\n if (!dom) {\n return (\n <Content>\n <Grid container>\n <Grid xs={12} item>\n <TechDocsStateIndicator />\n </Grid>\n </Grid>\n </Content>\n );\n }\n\n return (\n <Content>\n <Grid container>\n <Grid xs={12} item>\n <TechDocsStateIndicator />\n </Grid>\n {withSearch && (\n <Grid className={classes.search} xs=\"auto\" item>\n <TechDocsSearch\n entityId={entityRef}\n entityTitle={entityMetadata?.metadata?.title}\n searchResultUrlMapper={searchResultUrlMapper}\n />\n </Grid>\n )}\n <Grid xs={12} item>\n {/* Centers the styles loaded event to avoid having multiple locations setting the opacity style in Shadow Dom causing the screen to flash multiple times */}\n {(state === 'CHECKING' || isStyleLoading) && <Progress />}\n\n <TechDocsShadowDom element={dom} onAppend={handleAppend}>\n <TechDocsReaderPageContentAddons />\n </TechDocsShadowDom>\n </Grid>\n </Grid>\n </Content>\n );\n },\n);\n\n/**\n * Props for {@link Reader}\n *\n * @public\n * @deprecated use `TechDocsReaderPageContentProps` instead.\n */\nexport type ReaderProps = TechDocsReaderPageContentProps;\n\n/**\n * Component responsible for rendering TechDocs documentation\n * @public\n * @deprecated use `TechDocsReaderPageContent` component instead.\n */\nexport const Reader = TechDocsReaderPageContent;\n"],"names":[],"mappings":";;;;;;;;;;;;AAyCA,MAAM,YAAY,UAAW,CAAA;AAAA,EAC3B,MAAQ,EAAA;AAAA,IACN,KAAO,EAAA,MAAA;AAAA,IACP,+BAAiC,EAAA;AAAA,MAC/B,KAAO,EAAA,sBAAA;AAAA,MACP,MAAQ,EAAA;AAAA,KACV;AAAA,IACA,cAAgB,EAAA;AAAA,MACd,OAAS,EAAA;AAAA;AACX;AAEJ,CAAC,CAAA;AAgCM,MAAM,yBAA4B,GAAA,0BAAA;AAAA,EACvC,CAAC,KAA0C,KAAA;AACzC,IAAA,MAAM,EAAE,UAAA,GAAa,IAAM,EAAA,qBAAA,EAAuB,SAAY,GAAA,KAAA;AAC9D,IAAA,MAAM,UAAU,SAAU,EAAA;AAE1B,IAAM,MAAA;AAAA,MACJ,cAAgB,EAAA,EAAE,KAAO,EAAA,cAAA,EAAgB,SAAS,qBAAsB,EAAA;AAAA,MACxE,SAAA;AAAA,MACA;AAAA,QACE,qBAAsB,EAAA;AAC1B,IAAM,MAAA,EAAE,KAAM,EAAA,GAAI,iBAAkB,EAAA;AACpC,IAAM,MAAA,GAAA,GAAM,qBAAqB,SAAS,CAAA;AAC1C,IAAM,MAAA,IAAA,GAAO,OAAO,QAAS,CAAA,QAAA;AAC7B,IAAM,MAAA,IAAA,GAAO,OAAO,QAAS,CAAA,IAAA;AAC7B,IAAM,MAAA,cAAA,GAAiB,0BAA0B,GAAG,CAAA;AACpD,IAAM,MAAA,CAAC,WAAW,CAAA,GAAI,qBAAsB,CAAA,CAAC,CAAQ,KAAA,EAAA,IAAA,CAAK,KAAM,CAAA,CAAC,CAAC,CAAA,EAAA,CAAI,CAAC,CAAA;AACvE,IAAA,MAAM,MAAM,MAAO,EAAA;AACnB,IAAA,MAAM,EAAE,iBAAA,EAAsB,GAAA,GAAA,CAAI,aAAc,EAAA;AAEhD,IAAA,SAAA,CAAU,MAAM;AACd,MAAA,IAAI,cAAgB,EAAA;AAEpB,MAAA,IAAI,IAAM,EAAA;AACR,QAAA,IAAI,WAAa,EAAA;AACf,UAAA,WAAA,CAAY,cAAe,EAAA;AAAA;AAC7B,OACK,MAAA;AACL,QAAU,QAAA,EAAA,aAAA,CAAc,QAAQ,CAAA,EAAG,cAAe,EAAA;AAAA;AACpD,OACC,CAAC,IAAA,EAAM,IAAM,EAAA,WAAA,EAAa,cAAc,CAAC,CAAA;AAE5C,IAAA,MAAM,YAAe,GAAA,WAAA;AAAA,MACnB,CAAC,aAA8B,KAAA;AAC7B,QAAA,aAAA,CAAc,aAAa,CAAA;AAC3B,QAAA,IAAI,mBAAmB,QAAU,EAAA;AAC/B,UAAQ,OAAA,EAAA;AAAA;AACV,OACF;AAAA,MACA,CAAC,eAAe,OAAO;AAAA,KACzB;AAGA,IAAI,IAAA,qBAAA,KAA0B,SAAS,CAAC,cAAA;AACtC,MAAA,2CAAQ,iBAAkB,EAAA,IAAA,CAAA;AAI5B,IAAA,IAAI,CAAC,GAAK,EAAA;AACR,MAAA,2CACG,OACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,IAAK,EAAA,EAAA,SAAA,EAAS,wBACZ,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,EAAI,EAAA,EAAA,EAAI,MAAI,IAChB,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,sBAAuB,EAAA,IAAA,CAC1B,CACF,CACF,CAAA;AAAA;AAIJ,IACE,uBAAA,KAAA,CAAA,aAAA,CAAC,OACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,IAAK,EAAA,EAAA,SAAA,EAAS,wBACZ,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,EAAI,EAAA,EAAA,EAAI,IAAI,EAAA,IAAA,EAAA,sCACf,sBAAuB,EAAA,IAAA,CAC1B,CACC,EAAA,UAAA,oBACE,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,SAAW,EAAA,OAAA,CAAQ,MAAQ,EAAA,EAAA,EAAG,MAAO,EAAA,IAAA,EAAI,IAC7C,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,cAAA;AAAA,MAAA;AAAA,QACC,QAAU,EAAA,SAAA;AAAA,QACV,WAAA,EAAa,gBAAgB,QAAU,EAAA,KAAA;AAAA,QACvC;AAAA;AAAA,KAEJ,CAEF,kBAAA,KAAA,CAAA,aAAA,CAAC,IAAK,EAAA,EAAA,EAAA,EAAI,IAAI,IAAI,EAAA,IAAA,EAAA,EAAA,CAEd,KAAU,KAAA,UAAA,IAAc,cAAmB,qBAAA,KAAA,CAAA,aAAA,CAAC,cAAS,CAEvD,kBAAA,KAAA,CAAA,aAAA,CAAC,iBAAkB,EAAA,EAAA,OAAA,EAAS,GAAK,EAAA,QAAA,EAAU,YACzC,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,+BAAgC,EAAA,IAAA,CACnC,CACF,CACF,CACF,CAAA;AAAA;AAGN;AAeO,MAAM,MAAS,GAAA;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs",
|
|
3
|
-
"version": "0.0.0-nightly-
|
|
3
|
+
"version": "0.0.0-nightly-20250131022942",
|
|
4
4
|
"description": "The Backstage plugin that renders technical documentation for your components",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin",
|
|
@@ -71,20 +71,20 @@
|
|
|
71
71
|
"@backstage/catalog-client": "1.9.1",
|
|
72
72
|
"@backstage/catalog-model": "1.7.3",
|
|
73
73
|
"@backstage/config": "1.3.2",
|
|
74
|
-
"@backstage/core-compat-api": "0.0.0-nightly-
|
|
75
|
-
"@backstage/core-components": "0.0.0-nightly-
|
|
76
|
-
"@backstage/core-plugin-api": "0.0.0-nightly-
|
|
74
|
+
"@backstage/core-compat-api": "0.0.0-nightly-20250131022942",
|
|
75
|
+
"@backstage/core-components": "0.0.0-nightly-20250131022942",
|
|
76
|
+
"@backstage/core-plugin-api": "0.0.0-nightly-20250131022942",
|
|
77
77
|
"@backstage/errors": "1.2.7",
|
|
78
|
-
"@backstage/frontend-plugin-api": "0.0.0-nightly-
|
|
78
|
+
"@backstage/frontend-plugin-api": "0.0.0-nightly-20250131022942",
|
|
79
79
|
"@backstage/integration": "1.16.1",
|
|
80
|
-
"@backstage/integration-react": "0.0.0-nightly-
|
|
81
|
-
"@backstage/plugin-auth-react": "0.0.0-nightly-
|
|
82
|
-
"@backstage/plugin-catalog-react": "0.0.0-nightly-
|
|
80
|
+
"@backstage/integration-react": "0.0.0-nightly-20250131022942",
|
|
81
|
+
"@backstage/plugin-auth-react": "0.0.0-nightly-20250131022942",
|
|
82
|
+
"@backstage/plugin-catalog-react": "0.0.0-nightly-20250131022942",
|
|
83
83
|
"@backstage/plugin-search-common": "1.2.17",
|
|
84
|
-
"@backstage/plugin-search-react": "0.0.0-nightly-
|
|
84
|
+
"@backstage/plugin-search-react": "0.0.0-nightly-20250131022942",
|
|
85
85
|
"@backstage/plugin-techdocs-common": "0.1.0",
|
|
86
|
-
"@backstage/plugin-techdocs-react": "0.0.0-nightly-
|
|
87
|
-
"@backstage/theme": "0.0.0-nightly-
|
|
86
|
+
"@backstage/plugin-techdocs-react": "0.0.0-nightly-20250131022942",
|
|
87
|
+
"@backstage/theme": "0.0.0-nightly-20250131022942",
|
|
88
88
|
"@material-ui/core": "^4.12.2",
|
|
89
89
|
"@material-ui/icons": "^4.9.1",
|
|
90
90
|
"@material-ui/lab": "4.0.0-alpha.61",
|
|
@@ -98,12 +98,12 @@
|
|
|
98
98
|
"react-use": "^17.2.4"
|
|
99
99
|
},
|
|
100
100
|
"devDependencies": {
|
|
101
|
-
"@backstage/cli": "0.0.0-nightly-
|
|
102
|
-
"@backstage/core-app-api": "0.0.0-nightly-
|
|
103
|
-
"@backstage/dev-utils": "0.0.0-nightly-
|
|
104
|
-
"@backstage/plugin-catalog": "0.0.0-nightly-
|
|
105
|
-
"@backstage/plugin-techdocs-module-addons-contrib": "0.0.0-nightly-
|
|
106
|
-
"@backstage/test-utils": "0.0.0-nightly-
|
|
101
|
+
"@backstage/cli": "0.0.0-nightly-20250131022942",
|
|
102
|
+
"@backstage/core-app-api": "0.0.0-nightly-20250131022942",
|
|
103
|
+
"@backstage/dev-utils": "0.0.0-nightly-20250131022942",
|
|
104
|
+
"@backstage/plugin-catalog": "0.0.0-nightly-20250131022942",
|
|
105
|
+
"@backstage/plugin-techdocs-module-addons-contrib": "0.0.0-nightly-20250131022942",
|
|
106
|
+
"@backstage/test-utils": "0.0.0-nightly-20250131022942",
|
|
107
107
|
"@testing-library/dom": "^10.0.0",
|
|
108
108
|
"@testing-library/jest-dom": "^6.0.0",
|
|
109
109
|
"@testing-library/react": "^16.0.0",
|