@backstage/plugin-techdocs 1.19.0-next.1 → 1.19.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 (7) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist/alpha.d.ts +2 -2
  3. package/dist/home/components/TechDocsPicker.esm.js +3 -3
  4. package/dist/home/components/TechDocsPicker.esm.js.map +1 -1
  5. package/dist/plugins/techdocs/package.json.esm.js +2 -1
  6. package/dist/plugins/techdocs/package.json.esm.js.map +1 -1
  7. package/package.json +25 -24
package/CHANGELOG.md CHANGED
@@ -1,5 +1,52 @@
1
1
  # @backstage/plugin-techdocs
2
2
 
3
+ ## 1.19.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 4a5b52d: TechDocs now uses the default `NotFoundErrorPage` when documentation is missing, instead of its own TechDocs-specific page.
8
+
9
+ This means if you have provided an override to the `NotFoundErrorPage` component it will now be used within TechDocs when documentation is missing as well.
10
+
11
+ One thing to note is that the default not found page shows "PAGE NOT FOUND" rather than "Documentation not found".
12
+
13
+ - 80a0da9: Added `withoutFeedbackLink` prop to `page:techdocs/reader` and `entity-content:techdocs` extensions, which can be set to `true` to disable the feedback button in the rendered documentation.
14
+
15
+ ### Patch Changes
16
+
17
+ - 24fd0e8: Fixed TechDocs addons silently not rendering in apps using the new frontend system, on both the standalone documentation reader page and the entity documentation tab.
18
+ - 6c74f3f: Migrated the `TechDocsPicker` filter from the deprecated `getCatalogFilters` to `getCatalogQuery`.
19
+ - Updated dependencies
20
+ - @backstage/frontend-plugin-api@0.18.2
21
+ - @backstage/integration@2.1.3
22
+ - @backstage/ui@0.19.0
23
+ - @backstage/plugin-techdocs-react@1.4.0
24
+ - @backstage/catalog-client@1.16.3
25
+ - @backstage/plugin-catalog-react@3.3.0
26
+ - @backstage/config@1.3.10
27
+ - @backstage/errors@1.3.2
28
+ - @backstage/filter-predicates@0.2.0
29
+ - @backstage/core-components@0.18.15
30
+ - @backstage/plugin-techdocs-common@0.1.2
31
+ - @backstage/catalog-model@1.10.2
32
+ - @backstage/core-plugin-api@1.12.11
33
+ - @backstage/integration-react@1.2.23
34
+ - @backstage/plugin-auth-react@0.1.32
35
+ - @backstage/plugin-search-common@1.2.26
36
+ - @backstage/plugin-search-react@1.11.9
37
+
38
+ ## 1.19.0-next.2
39
+
40
+ ### Patch Changes
41
+
42
+ - 6c74f3f: Migrated the `TechDocsPicker` filter from the deprecated `getCatalogFilters` to `getCatalogQuery`.
43
+ - Updated dependencies
44
+ - @backstage/frontend-plugin-api@0.18.2-next.1
45
+ - @backstage/catalog-client@1.16.3-next.1
46
+ - @backstage/plugin-catalog-react@3.3.0-next.2
47
+ - @backstage/core-components@0.18.15-next.3
48
+ - @backstage/ui@0.19.0-next.0
49
+
3
50
  ## 1.19.0-next.1
4
51
 
5
52
  ### Minor Changes
package/dist/alpha.d.ts CHANGED
@@ -141,7 +141,7 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
141
141
  withoutFeedbackLink: boolean;
142
142
  path: string | undefined;
143
143
  title: string | undefined;
144
- filter: _backstage_filter_predicates.FilterPredicate | undefined;
144
+ filter: string | _backstage_filter_predicates.FilterPredicate | undefined;
145
145
  group: string | false | undefined;
146
146
  icon: string | undefined;
147
147
  };
@@ -149,7 +149,7 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
149
149
  withoutFeedbackLink?: boolean | undefined;
150
150
  path?: string | undefined;
151
151
  title?: string | undefined;
152
- filter?: _backstage_filter_predicates.FilterPredicate | undefined;
152
+ filter?: string | _backstage_filter_predicates.FilterPredicate | undefined;
153
153
  group?: string | false | undefined;
154
154
  icon?: string | undefined;
155
155
  };
package/dist/home/components/TechDocsPicker.esm.js CHANGED
@@ -1,11 +1,11 @@
1
1
  import { useEffect } from 'react';
2
- import { useEntityList, CATALOG_FILTER_EXISTS } from '@backstage/plugin-catalog-react';
2
+ import { useEntityList } from '@backstage/plugin-catalog-react';
3
3
  import { TECHDOCS_ANNOTATION } from '@backstage/plugin-techdocs-common';
4
4
 
5
5
  class TechDocsFilter {
6
- getCatalogFilters() {
6
+ getCatalogQuery() {
7
7
  return {
8
- [`metadata.annotations.${TECHDOCS_ANNOTATION}`]: CATALOG_FILTER_EXISTS
8
+ [`metadata.annotations.${TECHDOCS_ANNOTATION}`]: { $exists: true }
9
9
  };
10
10
  }
11
11
  }
package/dist/home/components/TechDocsPicker.esm.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"TechDocsPicker.esm.js","sources":["../../../src/home/components/TechDocsPicker.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { useEffect } from 'react';\nimport {\n CATALOG_FILTER_EXISTS,\n DefaultEntityFilters,\n EntityFilter,\n useEntityList,\n} from '@backstage/plugin-catalog-react';\nimport { TECHDOCS_ANNOTATION } from '@backstage/plugin-techdocs-common';\n\nclass TechDocsFilter implements EntityFilter {\n getCatalogFilters(): Record<string, string | symbol | (string | symbol)[]> {\n return {\n [`metadata.annotations.${TECHDOCS_ANNOTATION}`]: CATALOG_FILTER_EXISTS,\n };\n }\n}\n\ntype CustomFilters = DefaultEntityFilters & {\n techdocs?: TechDocsFilter;\n};\n\n/**\n * Component responsible for updating TechDocs filters\n *\n * @public\n */\nexport const TechDocsPicker = () => {\n const { updateFilters } = useEntityList<CustomFilters>();\n\n useEffect(() => {\n updateFilters({\n techdocs: new TechDocsFilter(),\n });\n }, [updateFilters]);\n\n return null;\n};\n"],"names":[],"mappings":";;;;AAyBA,MAAM,cAAA,CAAuC;AAAA,EAC3C,iBAAA,GAA2E;AACzE,IAAA,OAAO;AAAA,MACL,CAAC,CAAA,qBAAA,EAAwB,mBAAmB,CAAA,CAAE,GAAG;AAAA,KACnD;AAAA,EACF;AACF;AAWO,MAAM,iBAAiB,MAAM;AAClC,EAAA,MAAM,EAAE,aAAA,EAAc,GAAI,aAAA,EAA6B;AAEvD,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,aAAA,CAAc;AAAA,MACZ,QAAA,EAAU,IAAI,cAAA;AAAe,KAC9B,CAAA;AAAA,EACH,CAAA,EAAG,CAAC,aAAa,CAAC,CAAA;AAElB,EAAA,OAAO,IAAA;AACT;;"}
1
+ {"version":3,"file":"TechDocsPicker.esm.js","sources":["../../../src/home/components/TechDocsPicker.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { useEffect } from 'react';\nimport { FilterPredicate } from '@backstage/filter-predicates';\nimport {\n DefaultEntityFilters,\n EntityFilter,\n useEntityList,\n} from '@backstage/plugin-catalog-react';\nimport { TECHDOCS_ANNOTATION } from '@backstage/plugin-techdocs-common';\n\nclass TechDocsFilter implements EntityFilter {\n getCatalogQuery(): FilterPredicate {\n return {\n [`metadata.annotations.${TECHDOCS_ANNOTATION}`]: { $exists: true },\n };\n }\n}\n\ntype CustomFilters = DefaultEntityFilters & {\n techdocs?: TechDocsFilter;\n};\n\n/**\n * Component responsible for updating TechDocs filters\n *\n * @public\n */\nexport const TechDocsPicker = () => {\n const { updateFilters } = useEntityList<CustomFilters>();\n\n useEffect(() => {\n updateFilters({\n techdocs: new TechDocsFilter(),\n });\n }, [updateFilters]);\n\n return null;\n};\n"],"names":[],"mappings":";;;;AAyBA,MAAM,cAAA,CAAuC;AAAA,EAC3C,eAAA,GAAmC;AACjC,IAAA,OAAO;AAAA,MACL,CAAC,CAAA,qBAAA,EAAwB,mBAAmB,EAAE,GAAG,EAAE,SAAS,IAAA;AAAK,KACnE;AAAA,EACF;AACF;AAWO,MAAM,iBAAiB,MAAM;AAClC,EAAA,MAAM,EAAE,aAAA,EAAc,GAAI,aAAA,EAA6B;AAEvD,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,aAAA,CAAc;AAAA,MACZ,QAAA,EAAU,IAAI,cAAA;AAAe,KAC9B,CAAA;AAAA,EACH,CAAA,EAAG,CAAC,aAAa,CAAC,CAAA;AAElB,EAAA,OAAO,IAAA;AACT;;"}
package/dist/plugins/techdocs/package.json.esm.js CHANGED
@@ -1,5 +1,5 @@
1
1
  var name = "@backstage/plugin-techdocs";
2
- var version = "1.19.0-next.1";
2
+ var version = "1.19.0";
3
3
  var description = "The Backstage plugin that renders technical documentation for your components";
4
4
  var backstage = {
5
5
  role: "frontend-plugin",
@@ -64,6 +64,7 @@ var dependencies = {
64
64
  "@backstage/core-components": "workspace:^",
65
65
  "@backstage/core-plugin-api": "workspace:^",
66
66
  "@backstage/errors": "workspace:^",
67
+ "@backstage/filter-predicates": "workspace:^",
67
68
  "@backstage/frontend-plugin-api": "workspace:^",
68
69
  "@backstage/integration": "workspace:^",
69
70
  "@backstage/integration-react": "workspace:^",
package/dist/plugins/techdocs/package.json.esm.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"package.json.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"package.json.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs",
3
- "version": "1.19.0-next.1",
3
+ "version": "1.19.0",
4
4
  "description": "The Backstage plugin that renders technical documentation for your components",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -71,23 +71,24 @@
71
71
  "test": "backstage-cli package test"
72
72
  },
73
73
  "dependencies": {
74
- "@backstage/catalog-client": "1.16.3-next.0",
75
- "@backstage/catalog-model": "1.10.2-next.0",
76
- "@backstage/config": "1.3.10-next.0",
77
- "@backstage/core-components": "0.18.15-next.2",
78
- "@backstage/core-plugin-api": "1.12.11-next.0",
79
- "@backstage/errors": "1.3.2-next.0",
80
- "@backstage/frontend-plugin-api": "0.18.2-next.0",
81
- "@backstage/integration": "2.1.3-next.1",
82
- "@backstage/integration-react": "1.2.23-next.0",
83
- "@backstage/plugin-auth-react": "0.1.32-next.0",
84
- "@backstage/plugin-catalog-react": "3.2.4-next.1",
85
- "@backstage/plugin-search-common": "1.2.26-next.0",
86
- "@backstage/plugin-search-react": "1.11.9-next.0",
87
- "@backstage/plugin-techdocs-common": "0.1.2-next.0",
88
- "@backstage/plugin-techdocs-react": "1.3.16-next.2",
89
- "@backstage/theme": "0.7.3",
90
- "@backstage/ui": "0.18.0",
74
+ "@backstage/catalog-client": "^1.16.3",
75
+ "@backstage/catalog-model": "^1.10.2",
76
+ "@backstage/config": "^1.3.10",
77
+ "@backstage/core-components": "^0.18.15",
78
+ "@backstage/core-plugin-api": "^1.12.11",
79
+ "@backstage/errors": "^1.3.2",
80
+ "@backstage/filter-predicates": "^0.2.0",
81
+ "@backstage/frontend-plugin-api": "^0.18.2",
82
+ "@backstage/integration": "^2.1.3",
83
+ "@backstage/integration-react": "^1.2.23",
84
+ "@backstage/plugin-auth-react": "^0.1.32",
85
+ "@backstage/plugin-catalog-react": "^3.3.0",
86
+ "@backstage/plugin-search-common": "^1.2.26",
87
+ "@backstage/plugin-search-react": "^1.11.9",
88
+ "@backstage/plugin-techdocs-common": "^0.1.2",
89
+ "@backstage/plugin-techdocs-react": "^1.4.0",
90
+ "@backstage/theme": "^0.7.3",
91
+ "@backstage/ui": "^0.19.0",
91
92
  "@material-ui/core": "^4.12.2",
92
93
  "@material-ui/icons": "^4.9.1",
93
94
  "@material-ui/lab": "4.0.0-alpha.61",
@@ -102,12 +103,12 @@
102
103
  "zod": "^4.0.0"
103
104
  },
104
105
  "devDependencies": {
105
- "@backstage/cli": "0.36.7-next.0",
106
- "@backstage/core-app-api": "1.20.6-next.0",
107
- "@backstage/dev-utils": "1.1.28-next.0",
108
- "@backstage/plugin-catalog": "2.0.10-next.2",
109
- "@backstage/plugin-techdocs-module-addons-contrib": "1.1.41-next.0",
110
- "@backstage/test-utils": "1.7.23-next.0",
106
+ "@backstage/cli": "^0.36.7",
107
+ "@backstage/core-app-api": "^1.20.6",
108
+ "@backstage/dev-utils": "^1.1.28",
109
+ "@backstage/plugin-catalog": "^2.0.10",
110
+ "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.41",
111
+ "@backstage/test-utils": "^1.7.23",
111
112
  "@testing-library/dom": "^10.0.0",
112
113
  "@testing-library/jest-dom": "^6.0.0",
113
114
  "@testing-library/react": "^16.0.0",