@backstage/plugin-techdocs 1.17.3-next.1 → 1.17.3

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 (6) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist/alpha.d.ts +2 -2
  3. package/dist/home/components/Tables/helpers.esm.js +9 -3
  4. package/dist/home/components/Tables/helpers.esm.js.map +1 -1
  5. package/dist/plugins/techdocs/package.json.esm.js +1 -1
  6. package/package.json +24 -24
package/CHANGELOG.md CHANGED
@@ -1,5 +1,52 @@
1
1
  # @backstage/plugin-techdocs
2
2
 
3
+ ## 1.17.3
4
+
5
+ ### Patch Changes
6
+
7
+ - dc3cc87: Migrated the TechDocs alpha plugin pages to use BUI components. The index page and reader page now use BUI `Header` and `Container` instead of legacy `Page`/`Content`/`ContentHeader` wrappers. Added a `SupportButton` as a plugin header action. Changed plugin title to "Documentation" and icon to `RiArticleLine`.
8
+ - e5af44c: Replaced deprecated `humanizeEntityRef` usage with the Catalog Presentation API.
9
+ - Updated dependencies
10
+ - @backstage/ui@0.14.0
11
+ - @backstage/errors@1.3.0
12
+ - @backstage/theme@0.7.3
13
+ - @backstage/catalog-model@1.8.0
14
+ - @backstage/plugin-catalog-react@2.1.2
15
+ - @backstage/frontend-plugin-api@0.16.0
16
+ - @backstage/core-components@0.18.9
17
+ - @backstage/catalog-client@1.15.0
18
+ - @backstage/integration@2.0.1
19
+ - @backstage/config@1.3.7
20
+ - @backstage/core-plugin-api@1.12.5
21
+ - @backstage/integration-react@1.2.17
22
+ - @backstage/plugin-auth-react@0.1.26
23
+ - @backstage/plugin-search-common@1.2.23
24
+ - @backstage/plugin-search-react@1.11.1
25
+ - @backstage/plugin-techdocs-react@1.3.10
26
+
27
+ ## 1.17.3-next.2
28
+
29
+ ### Patch Changes
30
+
31
+ - e5af44c: Replaced deprecated `humanizeEntityRef` usage with the Catalog Presentation API.
32
+ - Updated dependencies
33
+ - @backstage/ui@0.14.0-next.2
34
+ - @backstage/errors@1.3.0-next.0
35
+ - @backstage/theme@0.7.3-next.0
36
+ - @backstage/core-components@0.18.9-next.1
37
+ - @backstage/plugin-catalog-react@2.1.2-next.2
38
+ - @backstage/integration@2.0.1-next.0
39
+ - @backstage/catalog-client@1.14.1-next.0
40
+ - @backstage/catalog-model@1.7.8-next.0
41
+ - @backstage/config@1.3.7-next.0
42
+ - @backstage/core-plugin-api@1.12.5-next.2
43
+ - @backstage/frontend-plugin-api@0.16.0-next.2
44
+ - @backstage/plugin-auth-react@0.1.26-next.1
45
+ - @backstage/plugin-search-react@1.11.1-next.2
46
+ - @backstage/plugin-techdocs-react@1.3.10-next.2
47
+ - @backstage/integration-react@1.2.17-next.1
48
+ - @backstage/plugin-search-common@1.2.23-next.0
49
+
3
50
  ## 1.17.3-next.1
4
51
 
5
52
  ### Patch Changes
package/dist/alpha.d.ts CHANGED
@@ -103,9 +103,9 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
103
103
  icon: string | undefined;
104
104
  };
105
105
  configInput: {
106
- filter?: _backstage_filter_predicates.FilterPredicate | undefined;
107
- title?: string | undefined;
108
106
  path?: string | undefined;
107
+ title?: string | undefined;
108
+ filter?: _backstage_filter_predicates.FilterPredicate | undefined;
109
109
  group?: string | false | undefined;
110
110
  icon?: string | undefined;
111
111
  };
package/dist/home/components/Tables/helpers.esm.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import { RELATION_OWNED_BY } from '@backstage/catalog-model';
2
- import { getEntityRelations, humanizeEntityRef } from '@backstage/plugin-catalog-react';
2
+ import { getEntityRelations, entityPresentationSnapshot } from '@backstage/plugin-catalog-react';
3
3
  import { toLowerMaybe } from '../../../helpers.esm.js';
4
4
 
5
- function entitiesToDocsMapper(entities, getRouteToReaderPageFor, config) {
5
+ function entitiesToDocsMapper(entities, getRouteToReaderPageFor, config, entityPresentationApi) {
6
6
  return entities.map((entity) => {
7
7
  const ownedByRelations = getEntityRelations(entity, RELATION_OWNED_BY);
8
8
  return {
@@ -17,7 +17,13 @@ function entitiesToDocsMapper(entities, getRouteToReaderPageFor, config) {
17
17
  name: toLowerMaybe(entity.metadata.name, config)
18
18
  }),
19
19
  ownedByRelations,
20
- ownedByRelationsTitle: ownedByRelations.map((r) => humanizeEntityRef(r, { defaultKind: "group" })).join(", ")
20
+ ownedByRelationsTitle: ownedByRelations.map(
21
+ (r) => entityPresentationSnapshot(
22
+ r,
23
+ { defaultKind: "group" },
24
+ entityPresentationApi
25
+ ).primaryTitle
26
+ ).join(", ")
21
27
  }
22
28
  };
23
29
  });
package/dist/home/components/Tables/helpers.esm.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"helpers.esm.js","sources":["../../../../src/home/components/Tables/helpers.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { RELATION_OWNED_BY, Entity } from '@backstage/catalog-model';\nimport {\n getEntityRelations,\n humanizeEntityRef,\n} from '@backstage/plugin-catalog-react';\nimport { toLowerMaybe } from '../../../helpers';\nimport { ConfigApi, RouteFunc } from '@backstage/core-plugin-api';\n\ntype getRouteFunc = RouteFunc<{\n namespace: string;\n kind: string;\n name: string;\n}>;\n\nexport function entitiesToDocsMapper(\n entities: Entity[],\n getRouteToReaderPageFor: getRouteFunc,\n config: ConfigApi,\n) {\n return entities.map(entity => {\n const ownedByRelations = getEntityRelations(entity, RELATION_OWNED_BY);\n return {\n entity,\n resolved: {\n docsUrl: getRouteToReaderPageFor({\n namespace: toLowerMaybe(\n entity.metadata.namespace ?? 'default',\n config,\n ),\n kind: toLowerMaybe(entity.kind, config),\n name: toLowerMaybe(entity.metadata.name, config),\n }),\n ownedByRelations,\n ownedByRelationsTitle: ownedByRelations\n .map(r => humanizeEntityRef(r, { defaultKind: 'group' }))\n .join(', '),\n },\n };\n });\n}\n"],"names":[],"mappings":";;;;AA8BO,SAAS,oBAAA,CACd,QAAA,EACA,uBAAA,EACA,MAAA,EACA;AACA,EAAA,OAAO,QAAA,CAAS,IAAI,CAAA,MAAA,KAAU;AAC5B,IAAA,MAAM,gBAAA,GAAmB,kBAAA,CAAmB,MAAA,EAAQ,iBAAiB,CAAA;AACrE,IAAA,OAAO;AAAA,MACL,MAAA;AAAA,MACA,QAAA,EAAU;AAAA,QACR,SAAS,uBAAA,CAAwB;AAAA,UAC/B,SAAA,EAAW,YAAA;AAAA,YACT,MAAA,CAAO,SAAS,SAAA,IAAa,SAAA;AAAA,YAC7B;AAAA,WACF;AAAA,UACA,IAAA,EAAM,YAAA,CAAa,MAAA,CAAO,IAAA,EAAM,MAAM,CAAA;AAAA,UACtC,IAAA,EAAM,YAAA,CAAa,MAAA,CAAO,QAAA,CAAS,MAAM,MAAM;AAAA,SAChD,CAAA;AAAA,QACD,gBAAA;AAAA,QACA,qBAAA,EAAuB,gBAAA,CACpB,GAAA,CAAI,CAAA,CAAA,KAAK,iBAAA,CAAkB,CAAA,EAAG,EAAE,WAAA,EAAa,OAAA,EAAS,CAAC,CAAA,CACvD,KAAK,IAAI;AAAA;AACd,KACF;AAAA,EACF,CAAC,CAAA;AACH;;;;"}
1
+ {"version":3,"file":"helpers.esm.js","sources":["../../../../src/home/components/Tables/helpers.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { RELATION_OWNED_BY, Entity } from '@backstage/catalog-model';\nimport {\n entityPresentationSnapshot,\n getEntityRelations,\n type EntityPresentationApi,\n} from '@backstage/plugin-catalog-react';\nimport { toLowerMaybe } from '../../../helpers';\nimport { ConfigApi, RouteFunc } from '@backstage/core-plugin-api';\n\ntype getRouteFunc = RouteFunc<{\n namespace: string;\n kind: string;\n name: string;\n}>;\n\nexport function entitiesToDocsMapper(\n entities: Entity[],\n getRouteToReaderPageFor: getRouteFunc,\n config: ConfigApi,\n entityPresentationApi?: EntityPresentationApi,\n) {\n return entities.map(entity => {\n const ownedByRelations = getEntityRelations(entity, RELATION_OWNED_BY);\n return {\n entity,\n resolved: {\n docsUrl: getRouteToReaderPageFor({\n namespace: toLowerMaybe(\n entity.metadata.namespace ?? 'default',\n config,\n ),\n kind: toLowerMaybe(entity.kind, config),\n name: toLowerMaybe(entity.metadata.name, config),\n }),\n ownedByRelations,\n ownedByRelationsTitle: ownedByRelations\n .map(\n r =>\n entityPresentationSnapshot(\n r,\n { defaultKind: 'group' },\n entityPresentationApi,\n ).primaryTitle,\n )\n .join(', '),\n },\n };\n });\n}\n"],"names":[],"mappings":";;;;AA+BO,SAAS,oBAAA,CACd,QAAA,EACA,uBAAA,EACA,MAAA,EACA,qBAAA,EACA;AACA,EAAA,OAAO,QAAA,CAAS,IAAI,CAAA,MAAA,KAAU;AAC5B,IAAA,MAAM,gBAAA,GAAmB,kBAAA,CAAmB,MAAA,EAAQ,iBAAiB,CAAA;AACrE,IAAA,OAAO;AAAA,MACL,MAAA;AAAA,MACA,QAAA,EAAU;AAAA,QACR,SAAS,uBAAA,CAAwB;AAAA,UAC/B,SAAA,EAAW,YAAA;AAAA,YACT,MAAA,CAAO,SAAS,SAAA,IAAa,SAAA;AAAA,YAC7B;AAAA,WACF;AAAA,UACA,IAAA,EAAM,YAAA,CAAa,MAAA,CAAO,IAAA,EAAM,MAAM,CAAA;AAAA,UACtC,IAAA,EAAM,YAAA,CAAa,MAAA,CAAO,QAAA,CAAS,MAAM,MAAM;AAAA,SAChD,CAAA;AAAA,QACD,gBAAA;AAAA,QACA,uBAAuB,gBAAA,CACpB,GAAA;AAAA,UACC,CAAA,CAAA,KACE,0BAAA;AAAA,YACE,CAAA;AAAA,YACA,EAAE,aAAa,OAAA,EAAQ;AAAA,YACvB;AAAA,WACF,CAAE;AAAA,SACN,CACC,KAAK,IAAI;AAAA;AACd,KACF;AAAA,EACF,CAAC,CAAA;AACH;;;;"}
package/dist/plugins/techdocs/package.json.esm.js CHANGED
@@ -1,5 +1,5 @@
1
1
  var name = "@backstage/plugin-techdocs";
2
- var version = "1.17.3-next.1";
2
+ var version = "1.17.3";
3
3
  var description = "The Backstage plugin that renders technical documentation for your components";
4
4
  var backstage = {
5
5
  role: "frontend-plugin",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs",
3
- "version": "1.17.3-next.1",
3
+ "version": "1.17.3",
4
4
  "description": "The Backstage plugin that renders technical documentation for your components",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -71,23 +71,23 @@
71
71
  "test": "backstage-cli package test"
72
72
  },
73
73
  "dependencies": {
74
- "@backstage/catalog-client": "1.14.0",
75
- "@backstage/catalog-model": "1.7.7",
76
- "@backstage/config": "1.3.6",
77
- "@backstage/core-components": "0.18.9-next.0",
78
- "@backstage/core-plugin-api": "1.12.5-next.1",
79
- "@backstage/errors": "1.2.7",
80
- "@backstage/frontend-plugin-api": "0.16.0-next.1",
81
- "@backstage/integration": "2.0.0",
82
- "@backstage/integration-react": "1.2.17-next.0",
83
- "@backstage/plugin-auth-react": "0.1.26-next.0",
84
- "@backstage/plugin-catalog-react": "2.1.2-next.1",
85
- "@backstage/plugin-search-common": "1.2.22",
86
- "@backstage/plugin-search-react": "1.11.1-next.1",
87
- "@backstage/plugin-techdocs-common": "0.1.1",
88
- "@backstage/plugin-techdocs-react": "1.3.10-next.1",
89
- "@backstage/theme": "0.7.2",
90
- "@backstage/ui": "0.14.0-next.1",
74
+ "@backstage/catalog-client": "^1.15.0",
75
+ "@backstage/catalog-model": "^1.8.0",
76
+ "@backstage/config": "^1.3.7",
77
+ "@backstage/core-components": "^0.18.9",
78
+ "@backstage/core-plugin-api": "^1.12.5",
79
+ "@backstage/errors": "^1.3.0",
80
+ "@backstage/frontend-plugin-api": "^0.16.0",
81
+ "@backstage/integration": "^2.0.1",
82
+ "@backstage/integration-react": "^1.2.17",
83
+ "@backstage/plugin-auth-react": "^0.1.26",
84
+ "@backstage/plugin-catalog-react": "^2.1.2",
85
+ "@backstage/plugin-search-common": "^1.2.23",
86
+ "@backstage/plugin-search-react": "^1.11.1",
87
+ "@backstage/plugin-techdocs-common": "^0.1.1",
88
+ "@backstage/plugin-techdocs-react": "^1.3.10",
89
+ "@backstage/theme": "^0.7.3",
90
+ "@backstage/ui": "^0.14.0",
91
91
  "@material-ui/core": "^4.12.2",
92
92
  "@material-ui/icons": "^4.9.1",
93
93
  "@material-ui/lab": "4.0.0-alpha.61",
@@ -101,12 +101,12 @@
101
101
  "react-use": "^17.2.4"
102
102
  },
103
103
  "devDependencies": {
104
- "@backstage/cli": "0.36.1-next.1",
105
- "@backstage/core-app-api": "1.20.0-next.1",
106
- "@backstage/dev-utils": "1.1.22-next.1",
107
- "@backstage/plugin-catalog": "2.0.2-next.1",
108
- "@backstage/plugin-techdocs-module-addons-contrib": "1.1.35-next.1",
109
- "@backstage/test-utils": "1.7.17-next.1",
104
+ "@backstage/cli": "^0.36.1",
105
+ "@backstage/core-app-api": "^1.20.0",
106
+ "@backstage/dev-utils": "^1.1.22",
107
+ "@backstage/plugin-catalog": "^2.0.2",
108
+ "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.35",
109
+ "@backstage/test-utils": "^1.7.17",
110
110
  "@testing-library/dom": "^10.0.0",
111
111
  "@testing-library/jest-dom": "^6.0.0",
112
112
  "@testing-library/react": "^16.0.0",