@backstage/plugin-techdocs 0.0.0-nightly-20240813022007 → 0.0.0-nightly-20240815021638
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 +37 -13
- package/alpha/package.json +1 -1
- package/dist/alpha.esm.js +2 -2
- package/dist/alpha.esm.js.map +1 -1
- package/package.json +18 -18
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20240815021638
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
@@ -11,22 +11,46 @@
|
|
|
11
11
|
- bdc5471: Fixed issue where header styles were incorrectly generated when themes used CSS variables to define font size.
|
|
12
12
|
- 6349099: Added config input type to the extensions
|
|
13
13
|
- Updated dependencies
|
|
14
|
-
- @backstage/frontend-plugin-api@0.0.0-nightly-
|
|
15
|
-
- @backstage/plugin-catalog-react@0.0.0-nightly-
|
|
16
|
-
- @backstage/plugin-search-react@0.0.0-nightly-
|
|
17
|
-
- @backstage/core-components@0.0.0-nightly-
|
|
18
|
-
- @backstage/core-compat-api@0.0.0-nightly-
|
|
19
|
-
- @backstage/plugin-search-common@0.0.0-nightly-
|
|
20
|
-
- @backstage/integration@0.0.0-nightly-
|
|
21
|
-
- @backstage/plugin-techdocs-common@0.0.0-nightly-
|
|
22
|
-
- @backstage/plugin-auth-react@0.0.0-nightly-
|
|
23
|
-
- @backstage/catalog-model@0.0.0-nightly-
|
|
14
|
+
- @backstage/frontend-plugin-api@0.0.0-nightly-20240815021638
|
|
15
|
+
- @backstage/plugin-catalog-react@0.0.0-nightly-20240815021638
|
|
16
|
+
- @backstage/plugin-search-react@0.0.0-nightly-20240815021638
|
|
17
|
+
- @backstage/core-components@0.0.0-nightly-20240815021638
|
|
18
|
+
- @backstage/core-compat-api@0.0.0-nightly-20240815021638
|
|
19
|
+
- @backstage/plugin-search-common@0.0.0-nightly-20240815021638
|
|
20
|
+
- @backstage/integration@0.0.0-nightly-20240815021638
|
|
21
|
+
- @backstage/plugin-techdocs-common@0.0.0-nightly-20240815021638
|
|
22
|
+
- @backstage/plugin-auth-react@0.0.0-nightly-20240815021638
|
|
23
|
+
- @backstage/catalog-model@0.0.0-nightly-20240815021638
|
|
24
24
|
- @backstage/config@1.2.0
|
|
25
25
|
- @backstage/core-plugin-api@1.9.3
|
|
26
26
|
- @backstage/errors@1.2.4
|
|
27
|
-
- @backstage/integration-react@0.0.0-nightly-
|
|
27
|
+
- @backstage/integration-react@0.0.0-nightly-20240815021638
|
|
28
28
|
- @backstage/theme@0.5.6
|
|
29
|
-
- @backstage/plugin-techdocs-react@0.0.0-nightly-
|
|
29
|
+
- @backstage/plugin-techdocs-react@0.0.0-nightly-20240815021638
|
|
30
|
+
|
|
31
|
+
## 1.10.8-next.3
|
|
32
|
+
|
|
33
|
+
### Patch Changes
|
|
34
|
+
|
|
35
|
+
- 27794d1: Allow for more granular control of TechDocsReaderPage styling. Theme overrides can now be provided to TechDocs without affecting the theme in other areas of Backstage.
|
|
36
|
+
- 8543e72: TechDocs redirect feature now includes a notification to the user before they are redirected.
|
|
37
|
+
- Updated dependencies
|
|
38
|
+
- @backstage/frontend-plugin-api@0.7.0-next.3
|
|
39
|
+
- @backstage/catalog-model@1.6.0-next.0
|
|
40
|
+
- @backstage/core-compat-api@0.2.8-next.3
|
|
41
|
+
- @backstage/plugin-catalog-react@1.12.3-next.3
|
|
42
|
+
- @backstage/plugin-search-react@1.7.14-next.3
|
|
43
|
+
- @backstage/config@1.2.0
|
|
44
|
+
- @backstage/core-components@0.14.10-next.0
|
|
45
|
+
- @backstage/core-plugin-api@1.9.3
|
|
46
|
+
- @backstage/errors@1.2.4
|
|
47
|
+
- @backstage/integration@1.14.0-next.0
|
|
48
|
+
- @backstage/integration-react@1.1.30-next.0
|
|
49
|
+
- @backstage/theme@0.5.6
|
|
50
|
+
- @backstage/plugin-auth-react@0.1.5-next.0
|
|
51
|
+
- @backstage/plugin-search-common@1.2.14-next.1
|
|
52
|
+
- @backstage/plugin-techdocs-common@0.1.0-next.0
|
|
53
|
+
- @backstage/plugin-techdocs-react@1.2.7-next.1
|
|
30
54
|
|
|
31
55
|
## 1.10.8-next.2
|
|
32
56
|
|
package/alpha/package.json
CHANGED
package/dist/alpha.esm.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import LibraryBooks from '@material-ui/icons/LibraryBooks';
|
|
3
|
-
import { createApiExtension, createSchemaFromZod, createPageExtension, createNavItemExtension,
|
|
3
|
+
import { createApiExtension, createSchemaFromZod, createPageExtension, createNavItemExtension, createFrontendPlugin } from '@backstage/frontend-plugin-api';
|
|
4
4
|
import { createSearchResultListItemExtension } from '@backstage/plugin-search-react/alpha';
|
|
5
5
|
import { createApiFactory, configApiRef, discoveryApiRef, fetchApiRef } from '@backstage/core-plugin-api';
|
|
6
6
|
import { compatWrapper, convertLegacyRouteRef, convertLegacyRouteRefs } from '@backstage/core-compat-api';
|
|
@@ -81,7 +81,7 @@ const techDocsNavItem = createNavItemExtension({
|
|
|
81
81
|
title: "Docs",
|
|
82
82
|
routeRef: convertLegacyRouteRef(rootRouteRef)
|
|
83
83
|
});
|
|
84
|
-
var alpha =
|
|
84
|
+
var alpha = createFrontendPlugin({
|
|
85
85
|
id: "techdocs",
|
|
86
86
|
extensions: [
|
|
87
87
|
techDocsClientApi,
|
package/dist/alpha.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.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 */\n\nimport React from 'react';\nimport LibraryBooks from '@material-ui/icons/LibraryBooks';\nimport {\n
|
|
1
|
+
{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.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 */\n\nimport React from 'react';\nimport LibraryBooks from '@material-ui/icons/LibraryBooks';\nimport {\n createFrontendPlugin,\n createSchemaFromZod,\n createApiExtension,\n createPageExtension,\n createNavItemExtension,\n} from '@backstage/frontend-plugin-api';\nimport { createSearchResultListItemExtension } from '@backstage/plugin-search-react/alpha';\nimport {\n configApiRef,\n createApiFactory,\n discoveryApiRef,\n fetchApiRef,\n} from '@backstage/core-plugin-api';\nimport {\n compatWrapper,\n convertLegacyRouteRef,\n convertLegacyRouteRefs,\n} from '@backstage/core-compat-api';\nimport {\n techdocsApiRef,\n techdocsStorageApiRef,\n} from '@backstage/plugin-techdocs-react';\nimport { TechDocsClient, TechDocsStorageClient } from './client';\nimport {\n rootCatalogDocsRouteRef,\n rootDocsRouteRef,\n rootRouteRef,\n} from './routes';\nimport { createEntityContentExtension } from '@backstage/plugin-catalog-react/alpha';\n\n/** @alpha */\nconst techDocsStorageApi = createApiExtension({\n factory: createApiFactory({\n api: techdocsStorageApiRef,\n deps: {\n configApi: configApiRef,\n discoveryApi: discoveryApiRef,\n fetchApi: fetchApiRef,\n },\n factory: ({ configApi, discoveryApi, fetchApi }) =>\n new TechDocsStorageClient({\n configApi,\n discoveryApi,\n fetchApi,\n }),\n }),\n});\n\n/** @alpha */\nconst techDocsClientApi = createApiExtension({\n factory: 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\n/** @alpha */\nexport const techDocsSearchResultListItemExtension =\n createSearchResultListItemExtension({\n configSchema: createSchemaFromZod(z =>\n z.object({\n // TODO: Define how the icon can be configurable\n title: z.string().optional(),\n lineClamp: z.number().default(5),\n asLink: z.boolean().default(true),\n asListItem: z.boolean().default(true),\n noTrack: z.boolean().default(false),\n }),\n ),\n predicate: result => result.type === 'techdocs',\n component: async ({ config }) => {\n const { TechDocsSearchResultListItem } = await import(\n './search/components/TechDocsSearchResultListItem'\n );\n return props =>\n compatWrapper(<TechDocsSearchResultListItem {...props} {...config} />);\n },\n });\n\n/**\n * Responsible for rendering the provided router element\n *\n * @alpha\n */\nconst techDocsPage = createPageExtension({\n defaultPath: '/docs',\n routeRef: convertLegacyRouteRef(rootRouteRef),\n loader: () =>\n import('./home/components/TechDocsIndexPage').then(m =>\n compatWrapper(<m.TechDocsIndexPage />),\n ),\n});\n\n/**\n * Component responsible for composing a TechDocs reader page experience\n *\n * @alpha\n */\nconst techDocsReaderPage = createPageExtension({\n name: 'reader',\n defaultPath: '/docs/:namespace/:kind/:name',\n routeRef: convertLegacyRouteRef(rootDocsRouteRef),\n loader: () =>\n import('./reader/components/TechDocsReaderPage').then(m =>\n compatWrapper(<m.TechDocsReaderPage />),\n ),\n});\n\n/**\n * Component responsible for rendering techdocs on entity pages\n *\n * @alpha\n */\nconst techDocsEntityContent = createEntityContentExtension({\n defaultPath: 'docs',\n defaultTitle: 'TechDocs',\n loader: () =>\n import('./Router').then(m => compatWrapper(<m.EmbeddedDocsRouter />)),\n});\n\n/** @alpha */\nconst techDocsNavItem = createNavItemExtension({\n icon: LibraryBooks,\n title: 'Docs',\n routeRef: convertLegacyRouteRef(rootRouteRef),\n});\n\n/** @alpha */\nexport default createFrontendPlugin({\n id: 'techdocs',\n extensions: [\n techDocsClientApi,\n techDocsStorageApi,\n techDocsNavItem,\n techDocsPage,\n techDocsReaderPage,\n techDocsEntityContent,\n techDocsSearchResultListItemExtension,\n ],\n routes: convertLegacyRouteRefs({\n root: rootRouteRef,\n docRoot: rootDocsRouteRef,\n entityContent: rootCatalogDocsRouteRef,\n }),\n});\n"],"names":[],"mappings":";;;;;;;;;;;AAkDA,MAAM,qBAAqB,kBAAmB,CAAA;AAAA,EAC5C,SAAS,gBAAiB,CAAA;AAAA,IACxB,GAAK,EAAA,qBAAA;AAAA,IACL,IAAM,EAAA;AAAA,MACJ,SAAW,EAAA,YAAA;AAAA,MACX,YAAc,EAAA,eAAA;AAAA,MACd,QAAU,EAAA,WAAA;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,SAAA,EAAW,cAAc,QAAS,EAAA,KAC5C,IAAI,qBAAsB,CAAA;AAAA,MACxB,SAAA;AAAA,MACA,YAAA;AAAA,MACA,QAAA;AAAA,KACD,CAAA;AAAA,GACJ,CAAA;AACH,CAAC,CAAA,CAAA;AAGD,MAAM,oBAAoB,kBAAmB,CAAA;AAAA,EAC3C,SAAS,gBAAiB,CAAA;AAAA,IACxB,GAAK,EAAA,cAAA;AAAA,IACL,IAAM,EAAA;AAAA,MACJ,SAAW,EAAA,YAAA;AAAA,MACX,YAAc,EAAA,eAAA;AAAA,MACd,QAAU,EAAA,WAAA;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,SAAA,EAAW,cAAc,QAAS,EAAA,KAC5C,IAAI,cAAe,CAAA;AAAA,MACjB,SAAA;AAAA,MACA,YAAA;AAAA,MACA,QAAA;AAAA,KACD,CAAA;AAAA,GACJ,CAAA;AACH,CAAC,CAAA,CAAA;AAGM,MAAM,wCACX,mCAAoC,CAAA;AAAA,EAClC,YAAc,EAAA,mBAAA;AAAA,IAAoB,CAAA,CAAA,KAChC,EAAE,MAAO,CAAA;AAAA;AAAA,MAEP,KAAO,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,MAC3B,SAAW,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,CAAC,CAAA;AAAA,MAC/B,MAAQ,EAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,IAAI,CAAA;AAAA,MAChC,UAAY,EAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,IAAI,CAAA;AAAA,MACpC,OAAS,EAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,KAAK,CAAA;AAAA,KACnC,CAAA;AAAA,GACH;AAAA,EACA,SAAA,EAAW,CAAU,MAAA,KAAA,MAAA,CAAO,IAAS,KAAA,UAAA;AAAA,EACrC,SAAW,EAAA,OAAO,EAAE,MAAA,EAAa,KAAA;AAC/B,IAAA,MAAM,EAAE,4BAAA,EAAiC,GAAA,MAAM,OAC7C,yDACF,CAAA,CAAA;AACA,IAAO,OAAA,CAAA,KAAA,KACL,8BAAe,KAAA,CAAA,aAAA,CAAA,4BAAA,EAAA,EAA8B,GAAG,KAAQ,EAAA,GAAG,QAAQ,CAAE,CAAA,CAAA;AAAA,GACzE;AACF,CAAC,EAAA;AAOH,MAAM,eAAe,mBAAoB,CAAA;AAAA,EACvC,WAAa,EAAA,OAAA;AAAA,EACb,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,EAC5C,MAAQ,EAAA,MACN,OAAO,4CAAqC,CAAE,CAAA,IAAA;AAAA,IAAK,OACjD,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,iBAAA,EAAF,IAAoB,CAAE,CAAA;AAAA,GACvC;AACJ,CAAC,CAAA,CAAA;AAOD,MAAM,qBAAqB,mBAAoB,CAAA;AAAA,EAC7C,IAAM,EAAA,QAAA;AAAA,EACN,WAAa,EAAA,8BAAA;AAAA,EACb,QAAA,EAAU,sBAAsB,gBAAgB,CAAA;AAAA,EAChD,MAAQ,EAAA,MACN,OAAO,qDAAwC,CAAE,CAAA,IAAA;AAAA,IAAK,OACpD,aAAc,iBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,kBAAA,EAAF,IAAqB,CAAE,CAAA;AAAA,GACxC;AACJ,CAAC,CAAA,CAAA;AAOD,MAAM,wBAAwB,4BAA6B,CAAA;AAAA,EACzD,WAAa,EAAA,MAAA;AAAA,EACb,YAAc,EAAA,UAAA;AAAA,EACd,MAAQ,EAAA,MACN,OAAO,iBAAU,CAAE,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,aAAA,iBAAe,KAAA,CAAA,aAAA,CAAA,CAAA,CAAE,kBAAF,EAAA,IAAqB,CAAE,CAAC,CAAA;AACxE,CAAC,CAAA,CAAA;AAGD,MAAM,kBAAkB,sBAAuB,CAAA;AAAA,EAC7C,IAAM,EAAA,YAAA;AAAA,EACN,KAAO,EAAA,MAAA;AAAA,EACP,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAC9C,CAAC,CAAA,CAAA;AAGD,YAAe,oBAAqB,CAAA;AAAA,EAClC,EAAI,EAAA,UAAA;AAAA,EACJ,UAAY,EAAA;AAAA,IACV,iBAAA;AAAA,IACA,kBAAA;AAAA,IACA,eAAA;AAAA,IACA,YAAA;AAAA,IACA,kBAAA;AAAA,IACA,qBAAA;AAAA,IACA,qCAAA;AAAA,GACF;AAAA,EACA,QAAQ,sBAAuB,CAAA;AAAA,IAC7B,IAAM,EAAA,YAAA;AAAA,IACN,OAAS,EAAA,gBAAA;AAAA,IACT,aAAe,EAAA,uBAAA;AAAA,GAChB,CAAA;AACH,CAAC,CAAA;;;;"}
|
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-20240815021638",
|
|
4
4
|
"description": "The Backstage plugin that renders technical documentation for your components",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin",
|
|
@@ -58,21 +58,21 @@
|
|
|
58
58
|
"test": "backstage-cli package test"
|
|
59
59
|
},
|
|
60
60
|
"dependencies": {
|
|
61
|
-
"@backstage/catalog-model": "^0.0.0-nightly-
|
|
61
|
+
"@backstage/catalog-model": "^0.0.0-nightly-20240815021638",
|
|
62
62
|
"@backstage/config": "^1.2.0",
|
|
63
|
-
"@backstage/core-compat-api": "^0.0.0-nightly-
|
|
64
|
-
"@backstage/core-components": "^0.0.0-nightly-
|
|
63
|
+
"@backstage/core-compat-api": "^0.0.0-nightly-20240815021638",
|
|
64
|
+
"@backstage/core-components": "^0.0.0-nightly-20240815021638",
|
|
65
65
|
"@backstage/core-plugin-api": "^1.9.3",
|
|
66
66
|
"@backstage/errors": "^1.2.4",
|
|
67
|
-
"@backstage/frontend-plugin-api": "^0.0.0-nightly-
|
|
68
|
-
"@backstage/integration": "^0.0.0-nightly-
|
|
69
|
-
"@backstage/integration-react": "^0.0.0-nightly-
|
|
70
|
-
"@backstage/plugin-auth-react": "^0.0.0-nightly-
|
|
71
|
-
"@backstage/plugin-catalog-react": "^0.0.0-nightly-
|
|
72
|
-
"@backstage/plugin-search-common": "^0.0.0-nightly-
|
|
73
|
-
"@backstage/plugin-search-react": "^0.0.0-nightly-
|
|
74
|
-
"@backstage/plugin-techdocs-common": "^0.0.0-nightly-
|
|
75
|
-
"@backstage/plugin-techdocs-react": "^0.0.0-nightly-
|
|
67
|
+
"@backstage/frontend-plugin-api": "^0.0.0-nightly-20240815021638",
|
|
68
|
+
"@backstage/integration": "^0.0.0-nightly-20240815021638",
|
|
69
|
+
"@backstage/integration-react": "^0.0.0-nightly-20240815021638",
|
|
70
|
+
"@backstage/plugin-auth-react": "^0.0.0-nightly-20240815021638",
|
|
71
|
+
"@backstage/plugin-catalog-react": "^0.0.0-nightly-20240815021638",
|
|
72
|
+
"@backstage/plugin-search-common": "^0.0.0-nightly-20240815021638",
|
|
73
|
+
"@backstage/plugin-search-react": "^0.0.0-nightly-20240815021638",
|
|
74
|
+
"@backstage/plugin-techdocs-common": "^0.0.0-nightly-20240815021638",
|
|
75
|
+
"@backstage/plugin-techdocs-react": "^0.0.0-nightly-20240815021638",
|
|
76
76
|
"@backstage/theme": "^0.5.6",
|
|
77
77
|
"@material-ui/core": "^4.12.2",
|
|
78
78
|
"@material-ui/icons": "^4.9.1",
|
|
@@ -88,11 +88,11 @@
|
|
|
88
88
|
"react-use": "^17.2.4"
|
|
89
89
|
},
|
|
90
90
|
"devDependencies": {
|
|
91
|
-
"@backstage/cli": "^0.0.0-nightly-
|
|
92
|
-
"@backstage/core-app-api": "^0.0.0-nightly-
|
|
93
|
-
"@backstage/dev-utils": "^0.0.0-nightly-
|
|
94
|
-
"@backstage/plugin-techdocs-module-addons-contrib": "^0.0.0-nightly-
|
|
95
|
-
"@backstage/test-utils": "^0.0.0-nightly-
|
|
91
|
+
"@backstage/cli": "^0.0.0-nightly-20240815021638",
|
|
92
|
+
"@backstage/core-app-api": "^0.0.0-nightly-20240815021638",
|
|
93
|
+
"@backstage/dev-utils": "^0.0.0-nightly-20240815021638",
|
|
94
|
+
"@backstage/plugin-techdocs-module-addons-contrib": "^0.0.0-nightly-20240815021638",
|
|
95
|
+
"@backstage/test-utils": "^0.0.0-nightly-20240815021638",
|
|
96
96
|
"@testing-library/dom": "^10.0.0",
|
|
97
97
|
"@testing-library/jest-dom": "^6.0.0",
|
|
98
98
|
"@testing-library/react": "^15.0.0",
|