@backstage/plugin-techdocs-react 1.3.7 → 1.3.8-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.
- package/CHANGELOG.md +17 -0
- package/dist/alpha.d.ts +1 -3
- package/dist/alpha.esm.js +2 -5
- package/dist/alpha.esm.js.map +1 -1
- package/package.json +11 -11
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,22 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs-react
|
|
2
2
|
|
|
3
|
+
## 1.3.8-next.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 22dce2b: TechDocs addons in the new frontend system now use a Utility API pattern instead of multiple attachment points. The `AddonBlueprint` now uses this new approach, and while addons created with older versions still work, they will produce a deprecation warning and will stop working in a future release.
|
|
8
|
+
|
|
9
|
+
As part of this change, the `techDocsAddonDataRef` alpha export was removed.
|
|
10
|
+
|
|
11
|
+
- Updated dependencies
|
|
12
|
+
- @backstage/core-components@0.18.6-next.0
|
|
13
|
+
- @backstage/frontend-plugin-api@0.14.0-next.0
|
|
14
|
+
- @backstage/core-plugin-api@1.12.2-next.0
|
|
15
|
+
- @backstage/catalog-model@1.7.6
|
|
16
|
+
- @backstage/config@1.3.6
|
|
17
|
+
- @backstage/version-bridge@1.0.11
|
|
18
|
+
- @backstage/plugin-techdocs-common@0.1.1
|
|
19
|
+
|
|
3
20
|
## 1.3.7
|
|
4
21
|
|
|
5
22
|
### Patch Changes
|
package/dist/alpha.d.ts
CHANGED
|
@@ -4,8 +4,6 @@ import { a as TechDocsAddonOptions } from './types/types.d-BlEjzAuE.js';
|
|
|
4
4
|
export { T as TechDocsAddonLocations } from './types/types.d-BlEjzAuE.js';
|
|
5
5
|
import '@backstage/catalog-model';
|
|
6
6
|
|
|
7
|
-
/** @alpha */
|
|
8
|
-
declare const techDocsAddonDataRef: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<TechDocsAddonOptions, "techdocs.addon", {}>;
|
|
9
7
|
/**
|
|
10
8
|
* Creates an extension to add addons to the TechDocs standalone reader and entity pages.
|
|
11
9
|
* @alpha
|
|
@@ -24,4 +22,4 @@ declare const AddonBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<
|
|
|
24
22
|
/** @alpha */
|
|
25
23
|
declare const attachTechDocsAddonComponentData: <P>(techDocsAddon: ComponentType<P>, data: TechDocsAddonOptions) => void;
|
|
26
24
|
|
|
27
|
-
export { AddonBlueprint, TechDocsAddonOptions, attachTechDocsAddonComponentData
|
|
25
|
+
export { AddonBlueprint, TechDocsAddonOptions, attachTechDocsAddonComponentData };
|
package/dist/alpha.esm.js
CHANGED
|
@@ -8,10 +8,7 @@ const techDocsAddonDataRef = createExtensionDataRef().with({
|
|
|
8
8
|
});
|
|
9
9
|
const AddonBlueprint = createExtensionBlueprint({
|
|
10
10
|
kind: "addon",
|
|
11
|
-
attachTo:
|
|
12
|
-
{ id: "page:techdocs/reader", input: "addons" },
|
|
13
|
-
{ id: "entity-content:techdocs", input: "addons" }
|
|
14
|
-
],
|
|
11
|
+
attachTo: { id: "api:techdocs/addons", input: "addons" },
|
|
15
12
|
output: [techDocsAddonDataRef],
|
|
16
13
|
factory: (params) => [techDocsAddonDataRef(params)],
|
|
17
14
|
dataRefs: {
|
|
@@ -34,5 +31,5 @@ const attachTechDocsAddonComponentData = (techDocsAddon, data) => {
|
|
|
34
31
|
}
|
|
35
32
|
};
|
|
36
33
|
|
|
37
|
-
export { AddonBlueprint, attachTechDocsAddonComponentData
|
|
34
|
+
export { AddonBlueprint, attachTechDocsAddonComponentData };
|
|
38
35
|
//# sourceMappingURL=alpha.esm.js.map
|
package/dist/alpha.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { createElement, ComponentType } from 'react';\n\nimport { TechDocsAddonOptions } from './types';\nimport {\n attachComponentData,\n getComponentData,\n} from '@backstage/core-plugin-api';\nimport { getDataKeyByName, TECHDOCS_ADDONS_KEY } from './addons';\nimport {\n createExtensionBlueprint,\n createExtensionDataRef,\n} from '@backstage/frontend-plugin-api';\n\n/** @alpha */\nexport type { TechDocsAddonOptions, TechDocsAddonLocations } from './types';\n\
|
|
1
|
+
{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { createElement, ComponentType } from 'react';\n\nimport { TechDocsAddonOptions } from './types';\nimport {\n attachComponentData,\n getComponentData,\n} from '@backstage/core-plugin-api';\nimport { getDataKeyByName, TECHDOCS_ADDONS_KEY } from './addons';\nimport {\n createExtensionBlueprint,\n createExtensionDataRef,\n} from '@backstage/frontend-plugin-api';\n\n/** @alpha */\nexport type { TechDocsAddonOptions, TechDocsAddonLocations } from './types';\n\nconst techDocsAddonDataRef =\n createExtensionDataRef<TechDocsAddonOptions>().with({\n id: 'techdocs.addon',\n });\n\n/**\n * Creates an extension to add addons to the TechDocs standalone reader and entity pages.\n * @alpha\n */\nexport const AddonBlueprint = createExtensionBlueprint({\n kind: 'addon',\n attachTo: { id: 'api:techdocs/addons', input: 'addons' },\n output: [techDocsAddonDataRef],\n factory: (params: TechDocsAddonOptions) => [techDocsAddonDataRef(params)],\n dataRefs: {\n addon: techDocsAddonDataRef,\n },\n});\n\n/** @alpha */\nexport const attachTechDocsAddonComponentData = <P>(\n techDocsAddon: ComponentType<P>,\n data: TechDocsAddonOptions,\n) => {\n const element = createElement(techDocsAddon as ComponentType);\n\n const isDataAttached = getComponentData<TechDocsAddonOptions>(\n element,\n TECHDOCS_ADDONS_KEY,\n );\n if (!isDataAttached) {\n attachComponentData(techDocsAddon, TECHDOCS_ADDONS_KEY, data);\n }\n\n const dataKey = getDataKeyByName(data.name);\n const isDataKeyAttached = getComponentData<boolean>(element, dataKey);\n if (!isDataKeyAttached) {\n attachComponentData(techDocsAddon, dataKey, true);\n }\n};\n"],"names":[],"mappings":";;;;;AA+BA,MAAM,oBAAA,GACJ,sBAAA,EAA6C,CAAE,IAAA,CAAK;AAAA,EAClD,EAAA,EAAI;AACN,CAAC,CAAA;AAMI,MAAM,iBAAiB,wBAAA,CAAyB;AAAA,EACrD,IAAA,EAAM,OAAA;AAAA,EACN,QAAA,EAAU,EAAE,EAAA,EAAI,qBAAA,EAAuB,OAAO,QAAA,EAAS;AAAA,EACvD,MAAA,EAAQ,CAAC,oBAAoB,CAAA;AAAA,EAC7B,SAAS,CAAC,MAAA,KAAiC,CAAC,oBAAA,CAAqB,MAAM,CAAC,CAAA;AAAA,EACxE,QAAA,EAAU;AAAA,IACR,KAAA,EAAO;AAAA;AAEX,CAAC;AAGM,MAAM,gCAAA,GAAmC,CAC9C,aAAA,EACA,IAAA,KACG;AACH,EAAA,MAAM,OAAA,GAAU,cAAc,aAA8B,CAAA;AAE5D,EAAA,MAAM,cAAA,GAAiB,gBAAA;AAAA,IACrB,OAAA;AAAA,IACA;AAAA,GACF;AACA,EAAA,IAAI,CAAC,cAAA,EAAgB;AACnB,IAAA,mBAAA,CAAoB,aAAA,EAAe,qBAAqB,IAAI,CAAA;AAAA,EAC9D;AAEA,EAAA,MAAM,OAAA,GAAU,gBAAA,CAAiB,IAAA,CAAK,IAAI,CAAA;AAC1C,EAAA,MAAM,iBAAA,GAAoB,gBAAA,CAA0B,OAAA,EAAS,OAAO,CAAA;AACpE,EAAA,IAAI,CAAC,iBAAA,EAAmB;AACtB,IAAA,mBAAA,CAAoB,aAAA,EAAe,SAAS,IAAI,CAAA;AAAA,EAClD;AACF;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs-react",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.8-next.0",
|
|
4
4
|
"description": "Shared frontend utilities for TechDocs and Addons",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "web-library",
|
|
@@ -66,13 +66,13 @@
|
|
|
66
66
|
"test": "backstage-cli package test"
|
|
67
67
|
},
|
|
68
68
|
"dependencies": {
|
|
69
|
-
"@backstage/catalog-model": "
|
|
70
|
-
"@backstage/config": "
|
|
71
|
-
"@backstage/core-components": "
|
|
72
|
-
"@backstage/core-plugin-api": "
|
|
73
|
-
"@backstage/frontend-plugin-api": "
|
|
74
|
-
"@backstage/plugin-techdocs-common": "
|
|
75
|
-
"@backstage/version-bridge": "
|
|
69
|
+
"@backstage/catalog-model": "1.7.6",
|
|
70
|
+
"@backstage/config": "1.3.6",
|
|
71
|
+
"@backstage/core-components": "0.18.6-next.0",
|
|
72
|
+
"@backstage/core-plugin-api": "1.12.2-next.0",
|
|
73
|
+
"@backstage/frontend-plugin-api": "0.14.0-next.0",
|
|
74
|
+
"@backstage/plugin-techdocs-common": "0.1.1",
|
|
75
|
+
"@backstage/version-bridge": "1.0.11",
|
|
76
76
|
"@material-ui/core": "^4.12.2",
|
|
77
77
|
"@material-ui/styles": "^4.11.0",
|
|
78
78
|
"jss": "~10.10.0",
|
|
@@ -81,9 +81,9 @@
|
|
|
81
81
|
"react-use": "^17.2.4"
|
|
82
82
|
},
|
|
83
83
|
"devDependencies": {
|
|
84
|
-
"@backstage/cli": "
|
|
85
|
-
"@backstage/test-utils": "
|
|
86
|
-
"@backstage/theme": "
|
|
84
|
+
"@backstage/cli": "0.35.3-next.0",
|
|
85
|
+
"@backstage/test-utils": "1.7.15-next.0",
|
|
86
|
+
"@backstage/theme": "0.7.1",
|
|
87
87
|
"@testing-library/jest-dom": "^6.0.0",
|
|
88
88
|
"@testing-library/react": "^16.0.0",
|
|
89
89
|
"@types/react": "^18.0.0",
|