@backstage/plugin-techdocs-react 1.2.16-next.0 → 1.2.16-next.1
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 +16 -0
- package/dist/addons.esm.js +3 -2
- package/dist/addons.esm.js.map +1 -1
- package/dist/alpha.d.ts +1 -1
- package/dist/alpha.esm.js +2 -2
- package/dist/alpha.esm.js.map +1 -1
- package/dist/component.esm.js +6 -2
- package/dist/component.esm.js.map +1 -1
- package/dist/context.esm.js +6 -5
- package/dist/context.esm.js.map +1 -1
- package/dist/index.d.ts +6 -4
- package/package.json +10 -10
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs-react
|
|
2
2
|
|
|
3
|
+
## 1.2.16-next.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- a47fd39: Removes instances of default React imports, a necessary update for the upcoming React 19 migration.
|
|
8
|
+
|
|
9
|
+
<https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html>
|
|
10
|
+
|
|
11
|
+
- Updated dependencies
|
|
12
|
+
- @backstage/frontend-plugin-api@0.10.1-next.1
|
|
13
|
+
- @backstage/core-components@0.17.1-next.1
|
|
14
|
+
- @backstage/core-plugin-api@1.10.6-next.0
|
|
15
|
+
- @backstage/catalog-model@1.7.3
|
|
16
|
+
- @backstage/config@1.3.2
|
|
17
|
+
- @backstage/version-bridge@1.0.11
|
|
18
|
+
|
|
3
19
|
## 1.2.16-next.0
|
|
4
20
|
|
|
5
21
|
### Patch Changes
|
package/dist/addons.esm.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { jsx } from 'react/jsx-runtime';
|
|
2
|
+
import { useCallback } from 'react';
|
|
2
3
|
import { useOutlet } from 'react-router-dom';
|
|
3
4
|
import { attachComponentData, createReactExtension, useElementFilter } from '@backstage/core-plugin-api';
|
|
4
5
|
|
|
@@ -14,7 +15,7 @@ function createTechDocsAddonExtension(options) {
|
|
|
14
15
|
return createReactExtension({
|
|
15
16
|
name,
|
|
16
17
|
component: {
|
|
17
|
-
sync: (props) => /* @__PURE__ */
|
|
18
|
+
sync: (props) => /* @__PURE__ */ jsx(TechDocsAddon, { ...props })
|
|
18
19
|
},
|
|
19
20
|
data: {
|
|
20
21
|
[TECHDOCS_ADDONS_KEY]: options,
|
package/dist/addons.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"addons.esm.js","sources":["../src/addons.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
|
|
1
|
+
{"version":3,"file":"addons.esm.js","sources":["../src/addons.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 { PropsWithChildren, ComponentType, useCallback } from 'react';\nimport { useOutlet } from 'react-router-dom';\n\nimport {\n attachComponentData,\n createReactExtension,\n ElementCollection,\n Extension,\n useElementFilter,\n} from '@backstage/core-plugin-api';\n\nimport { TechDocsAddonLocations, TechDocsAddonOptions } from './types';\n\n/**\n * Key for each addon.\n * @public\n */\nexport const TECHDOCS_ADDONS_KEY = 'techdocs.addons.addon.v1';\n\n/**\n * Marks the `<TechDocsAddons>` registry component.\n * @public\n */\nexport const TECHDOCS_ADDONS_WRAPPER_KEY = 'techdocs.addons.wrapper.v1';\n\n/**\n * TechDocs Addon registry.\n * @public\n */\nexport const TechDocsAddons: ComponentType<PropsWithChildren<{}>> = () => null;\n\nattachComponentData(TechDocsAddons, TECHDOCS_ADDONS_WRAPPER_KEY, true);\n\nexport const getDataKeyByName = (name: string) => {\n return `${TECHDOCS_ADDONS_KEY}.${name.toLocaleLowerCase('en-US')}`;\n};\n\n/**\n * Create a TechDocs addon overload signature without props.\n * @public\n */\nexport function createTechDocsAddonExtension(\n options: TechDocsAddonOptions,\n): Extension<() => JSX.Element | null>;\n\n/**\n * Create a TechDocs addon overload signature with props.\n * @public\n */\nexport function createTechDocsAddonExtension<TComponentProps>(\n options: TechDocsAddonOptions<TComponentProps>,\n): Extension<(props: TComponentProps) => JSX.Element | null>;\n\n/**\n * Create a TechDocs addon implementation.\n * @public\n */\nexport function createTechDocsAddonExtension<\n TComponentProps extends PropsWithChildren<{}>,\n>(\n options: TechDocsAddonOptions<TComponentProps>,\n): Extension<(props: TComponentProps) => JSX.Element | null> {\n const { name, component: TechDocsAddon } = options;\n return createReactExtension({\n name,\n component: {\n sync: (props: TComponentProps) => <TechDocsAddon {...props} />,\n },\n data: {\n [TECHDOCS_ADDONS_KEY]: options,\n [getDataKeyByName(name)]: true,\n },\n });\n}\n\nconst getTechDocsAddonByName = (\n collection: ElementCollection,\n key: string,\n): JSX.Element | undefined => {\n return collection.selectByComponentData({ key }).getElements()[0];\n};\n\nconst getAllTechDocsAddons = (collection: ElementCollection) => {\n return collection\n .selectByComponentData({\n key: TECHDOCS_ADDONS_WRAPPER_KEY,\n })\n .selectByComponentData({\n key: TECHDOCS_ADDONS_KEY,\n });\n};\n\nconst getAllTechDocsAddonsData = (collection: ElementCollection) => {\n return collection\n .selectByComponentData({\n key: TECHDOCS_ADDONS_WRAPPER_KEY,\n })\n .findComponentData<TechDocsAddonOptions>({\n key: TECHDOCS_ADDONS_KEY,\n });\n};\n\n/**\n * hook to use addons in components\n * @public\n */\nexport const useTechDocsAddons = () => {\n const node = useOutlet();\n const collection = useElementFilter(node, getAllTechDocsAddons);\n const options = useElementFilter(node, getAllTechDocsAddonsData);\n\n const findAddonByData = useCallback(\n (data: TechDocsAddonOptions | undefined) => {\n if (!collection || !data) return null;\n const nameKey = getDataKeyByName(data.name);\n return getTechDocsAddonByName(collection, nameKey) ?? null;\n },\n [collection],\n );\n\n const renderComponentByName = useCallback(\n (name: string) => {\n const data = options.find(option => option.name === name);\n return data ? findAddonByData(data) : null;\n },\n [options, findAddonByData],\n );\n\n const renderComponentsByLocation = useCallback(\n (location: keyof typeof TechDocsAddonLocations) => {\n const data = options.filter(option => option.location === location);\n return data.length ? data.map(findAddonByData) : null;\n },\n [options, findAddonByData],\n );\n\n return { renderComponentByName, renderComponentsByLocation };\n};\n"],"names":[],"mappings":";;;;;AAiCO,MAAM,mBAAsB,GAAA;AAM5B,MAAM,2BAA8B,GAAA;AAMpC,MAAM,iBAAuD,MAAM;AAE1E,mBAAoB,CAAA,cAAA,EAAgB,6BAA6B,IAAI,CAAA;AAExD,MAAA,gBAAA,GAAmB,CAAC,IAAiB,KAAA;AAChD,EAAA,OAAO,GAAG,mBAAmB,CAAA,CAAA,EAAI,IAAK,CAAA,iBAAA,CAAkB,OAAO,CAAC,CAAA,CAAA;AAClE;AAsBO,SAAS,6BAGd,OAC2D,EAAA;AAC3D,EAAA,MAAM,EAAE,IAAA,EAAM,SAAW,EAAA,aAAA,EAAkB,GAAA,OAAA;AAC3C,EAAA,OAAO,oBAAqB,CAAA;AAAA,IAC1B,IAAA;AAAA,IACA,SAAW,EAAA;AAAA,MACT,MAAM,CAAC,KAAA,qBAA4B,GAAA,CAAA,aAAA,EAAA,EAAe,GAAG,KAAO,EAAA;AAAA,KAC9D;AAAA,IACA,IAAM,EAAA;AAAA,MACJ,CAAC,mBAAmB,GAAG,OAAA;AAAA,MACvB,CAAC,gBAAA,CAAiB,IAAI,CAAC,GAAG;AAAA;AAC5B,GACD,CAAA;AACH;AAEA,MAAM,sBAAA,GAAyB,CAC7B,UAAA,EACA,GAC4B,KAAA;AAC5B,EAAO,OAAA,UAAA,CAAW,sBAAsB,EAAE,GAAA,EAAK,CAAE,CAAA,WAAA,GAAc,CAAC,CAAA;AAClE,CAAA;AAEA,MAAM,oBAAA,GAAuB,CAAC,UAAkC,KAAA;AAC9D,EAAA,OAAO,WACJ,qBAAsB,CAAA;AAAA,IACrB,GAAK,EAAA;AAAA,GACN,EACA,qBAAsB,CAAA;AAAA,IACrB,GAAK,EAAA;AAAA,GACN,CAAA;AACL,CAAA;AAEA,MAAM,wBAAA,GAA2B,CAAC,UAAkC,KAAA;AAClE,EAAA,OAAO,WACJ,qBAAsB,CAAA;AAAA,IACrB,GAAK,EAAA;AAAA,GACN,EACA,iBAAwC,CAAA;AAAA,IACvC,GAAK,EAAA;AAAA,GACN,CAAA;AACL,CAAA;AAMO,MAAM,oBAAoB,MAAM;AACrC,EAAA,MAAM,OAAO,SAAU,EAAA;AACvB,EAAM,MAAA,UAAA,GAAa,gBAAiB,CAAA,IAAA,EAAM,oBAAoB,CAAA;AAC9D,EAAM,MAAA,OAAA,GAAU,gBAAiB,CAAA,IAAA,EAAM,wBAAwB,CAAA;AAE/D,EAAA,MAAM,eAAkB,GAAA,WAAA;AAAA,IACtB,CAAC,IAA2C,KAAA;AAC1C,MAAA,IAAI,CAAC,UAAA,IAAc,CAAC,IAAA,EAAa,OAAA,IAAA;AACjC,MAAM,MAAA,OAAA,GAAU,gBAAiB,CAAA,IAAA,CAAK,IAAI,CAAA;AAC1C,MAAO,OAAA,sBAAA,CAAuB,UAAY,EAAA,OAAO,CAAK,IAAA,IAAA;AAAA,KACxD;AAAA,IACA,CAAC,UAAU;AAAA,GACb;AAEA,EAAA,MAAM,qBAAwB,GAAA,WAAA;AAAA,IAC5B,CAAC,IAAiB,KAAA;AAChB,MAAA,MAAM,OAAO,OAAQ,CAAA,IAAA,CAAK,CAAU,MAAA,KAAA,MAAA,CAAO,SAAS,IAAI,CAAA;AACxD,MAAO,OAAA,IAAA,GAAO,eAAgB,CAAA,IAAI,CAAI,GAAA,IAAA;AAAA,KACxC;AAAA,IACA,CAAC,SAAS,eAAe;AAAA,GAC3B;AAEA,EAAA,MAAM,0BAA6B,GAAA,WAAA;AAAA,IACjC,CAAC,QAAkD,KAAA;AACjD,MAAA,MAAM,OAAO,OAAQ,CAAA,MAAA,CAAO,CAAU,MAAA,KAAA,MAAA,CAAO,aAAa,QAAQ,CAAA;AAClE,MAAA,OAAO,IAAK,CAAA,MAAA,GAAS,IAAK,CAAA,GAAA,CAAI,eAAe,CAAI,GAAA,IAAA;AAAA,KACnD;AAAA,IACA,CAAC,SAAS,eAAe;AAAA,GAC3B;AAEA,EAAO,OAAA,EAAE,uBAAuB,0BAA2B,EAAA;AAC7D;;;;"}
|
package/dist/alpha.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
|
|
2
|
+
import { ComponentType } from 'react';
|
|
2
3
|
import { T as TechDocsAddonOptions } from './types/types.d-BooYUMWM.js';
|
|
3
4
|
export { a as TechDocsAddonLocations } from './types/types.d-BooYUMWM.js';
|
|
4
|
-
import { ComponentType } from 'react';
|
|
5
5
|
import '@backstage/catalog-model';
|
|
6
6
|
|
|
7
7
|
/** @alpha */
|
package/dist/alpha.esm.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { createElement } from 'react';
|
|
2
2
|
import { getComponentData, attachComponentData } from '@backstage/core-plugin-api';
|
|
3
3
|
import { TECHDOCS_ADDONS_KEY, getDataKeyByName } from './addons.esm.js';
|
|
4
4
|
import { createExtensionDataRef, createExtensionBlueprint } from '@backstage/frontend-plugin-api';
|
|
@@ -19,7 +19,7 @@ const AddonBlueprint = createExtensionBlueprint({
|
|
|
19
19
|
}
|
|
20
20
|
});
|
|
21
21
|
const attachTechDocsAddonComponentData = (techDocsAddon, data) => {
|
|
22
|
-
const element =
|
|
22
|
+
const element = createElement(techDocsAddon);
|
|
23
23
|
const isDataAttached = getComponentData(
|
|
24
24
|
element,
|
|
25
25
|
TECHDOCS_ADDONS_KEY
|
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
|
|
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\n/** @alpha */\nexport const 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: [\n { id: 'page:techdocs/reader', input: 'addons' },\n { id: 'entity-content:techdocs', input: 'addons' },\n ],\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":";;;;;AAgCa,MAAA,oBAAA,GACX,sBAA6C,EAAA,CAAE,IAAK,CAAA;AAAA,EAClD,EAAI,EAAA;AACN,CAAC;AAMI,MAAM,iBAAiB,wBAAyB,CAAA;AAAA,EACrD,IAAM,EAAA,OAAA;AAAA,EACN,QAAU,EAAA;AAAA,IACR,EAAE,EAAA,EAAI,sBAAwB,EAAA,KAAA,EAAO,QAAS,EAAA;AAAA,IAC9C,EAAE,EAAA,EAAI,yBAA2B,EAAA,KAAA,EAAO,QAAS;AAAA,GACnD;AAAA,EACA,MAAA,EAAQ,CAAC,oBAAoB,CAAA;AAAA,EAC7B,SAAS,CAAC,MAAA,KAAiC,CAAC,oBAAA,CAAqB,MAAM,CAAC,CAAA;AAAA,EACxE,QAAU,EAAA;AAAA,IACR,KAAO,EAAA;AAAA;AAEX,CAAC;AAGY,MAAA,gCAAA,GAAmC,CAC9C,aAAA,EACA,IACG,KAAA;AACH,EAAM,MAAA,OAAA,GAAU,cAAc,aAA8B,CAAA;AAE5D,EAAA,MAAM,cAAiB,GAAA,gBAAA;AAAA,IACrB,OAAA;AAAA,IACA;AAAA,GACF;AACA,EAAA,IAAI,CAAC,cAAgB,EAAA;AACnB,IAAoB,mBAAA,CAAA,aAAA,EAAe,qBAAqB,IAAI,CAAA;AAAA;AAG9D,EAAM,MAAA,OAAA,GAAU,gBAAiB,CAAA,IAAA,CAAK,IAAI,CAAA;AAC1C,EAAM,MAAA,iBAAA,GAAoB,gBAA0B,CAAA,OAAA,EAAS,OAAO,CAAA;AACpE,EAAA,IAAI,CAAC,iBAAmB,EAAA;AACtB,IAAoB,mBAAA,CAAA,aAAA,EAAe,SAAS,IAAI,CAAA;AAAA;AAEpD;;;;"}
|
package/dist/component.esm.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { jsx, Fragment, jsxs } from 'react/jsx-runtime';
|
|
2
|
+
import { useState, useEffect, useCallback } from 'react';
|
|
2
3
|
import { create } from 'jss';
|
|
3
4
|
import StylesProvider from '@material-ui/styles/StylesProvider';
|
|
4
5
|
import jssPreset from '@material-ui/styles/jssPreset';
|
|
@@ -83,7 +84,10 @@ const TechDocsShadowDom = (props) => {
|
|
|
83
84
|
},
|
|
84
85
|
[element, onAppend]
|
|
85
86
|
);
|
|
86
|
-
return /* @__PURE__ */
|
|
87
|
+
return /* @__PURE__ */ jsx(Fragment, { children: /* @__PURE__ */ jsxs(StylesProvider, { jss, sheetsManager: /* @__PURE__ */ new Map(), children: [
|
|
88
|
+
/* @__PURE__ */ jsx("div", { ref, "data-testid": "techdocs-native-shadowroot" }),
|
|
89
|
+
children
|
|
90
|
+
] }) });
|
|
87
91
|
};
|
|
88
92
|
|
|
89
93
|
export { SHADOW_DOM_STYLE_LOAD_EVENT, TechDocsShadowDom, useShadowDomStylesLoading };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"component.esm.js","sources":["../src/component.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
|
|
1
|
+
{"version":3,"file":"component.esm.js","sources":["../src/component.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 { PropsWithChildren, useState, useEffect, useCallback } from 'react';\n\nimport { create } from 'jss';\nimport StylesProvider from '@material-ui/styles/StylesProvider';\nimport jssPreset from '@material-ui/styles/jssPreset';\n\n/**\n * Name for the event dispatched when ShadowRoot styles are loaded.\n * @public\n */\nexport const SHADOW_DOM_STYLE_LOAD_EVENT = 'TECH_DOCS_SHADOW_DOM_STYLE_LOAD';\n\n/**\n * Dispatch style load event after all styles are loaded.\n * @param element - the ShadowRoot tree.\n */\nconst useShadowDomStylesEvents = (element: Element | null) => {\n useEffect(() => {\n if (!element) {\n return () => {};\n }\n\n const styles = element.querySelectorAll<HTMLElement>(\n 'head > link[rel=\"stylesheet\"]',\n );\n\n let count = styles?.length ?? 0;\n const event = new CustomEvent(SHADOW_DOM_STYLE_LOAD_EVENT);\n\n if (!count) {\n element.dispatchEvent(event);\n return () => {};\n }\n\n const handleLoad = () => {\n if (--count === 0) {\n element.dispatchEvent(event);\n }\n };\n\n styles?.forEach(style => {\n style.addEventListener('load', handleLoad);\n });\n\n return () => {\n styles?.forEach(style => {\n style.removeEventListener('load', handleLoad);\n });\n };\n }, [element]);\n};\n\n/**\n * Returns the style's loading state.\n *\n * @example\n * Here's an example that updates the sidebar position only after styles are calculated:\n * ```jsx\n * import {\n * TechDocsShadowDom,\n * useShadowDomStylesLoading,\n * } from '@backstage/plugin-techdocs-react';\n *\n * export const TechDocsReaderPageContent = () => {\n * // ...\n * const dom = useTechDocsReaderDom(entity);\n * const isStyleLoading = useShadowDomStylesLoading(dom);\n *\n * const updateSidebarPosition = useCallback(() => {\n * //...\n * }, [dom]);\n *\n * useEffect(() => {\n * if (!isStyleLoading) {\n * updateSidebarPosition();\n * }\n * }, [isStyleLoading, updateSidebarPosition]);\n *\n * const handleDomAppend = useCallback(\n * (newShadowRoot: ShadowRoot) => {\n * setShadowRoot(newShadowRoot);\n * },\n * [setShadowRoot],\n * );\n *\n * return <TechDocsShadowDom element={dom} onAppend={handleDomAppend} />;\n * };\n * ```\n *\n * @param element - which is the ShadowRoot tree.\n * @returns a boolean value, true if styles are being loaded.\n * @public\n */\nexport const useShadowDomStylesLoading = (element: Element | null) => {\n const [loading, setLoading] = useState(false);\n\n useEffect(() => {\n if (!element) return () => {};\n\n setLoading(true);\n\n const style = (element as HTMLElement).style;\n\n style.setProperty('opacity', '0');\n\n const handleLoad = () => {\n setLoading(false);\n style.setProperty('opacity', '1');\n };\n\n element.addEventListener(SHADOW_DOM_STYLE_LOAD_EVENT, handleLoad);\n\n return () => {\n element.removeEventListener(SHADOW_DOM_STYLE_LOAD_EVENT, handleLoad);\n };\n }, [element]);\n\n return loading;\n};\n\n/**\n * Props for {@link TechDocsShadowDom}.\n *\n * @remarks\n * If you want to use portals to render Material UI components in the Shadow DOM,\n * you must render these portals as children because this component wraps its children in a Material UI StylesProvider\n * to ensure that Material UI styles are applied.\n *\n * @public\n */\nexport type TechDocsShadowDomProps = PropsWithChildren<{\n /**\n * Element tree that is appended to ShadowRoot.\n */\n element: Element;\n /**\n * Callback called when the element tree is appended in ShadowRoot.\n */\n onAppend?: (shadowRoot: ShadowRoot) => void;\n}>;\n\n/**\n * Renders a tree of elements in a Shadow DOM.\n *\n * @remarks\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 * so if you want to know when Shadow DOM styles are computed, you can listen for the \"TECH_DOCS_SHADOW_DOM_STYLE_LOAD\" event dispatched by the element tree.\n *\n * @example\n * Here is an example using this component and also listening for styles loaded event:\n *```jsx\n * import {\n * TechDocsShadowDom,\n * SHADOW_DOM_STYLE_LOAD_EVENT,\n * } from '@backstage/plugin-techdocs-react';\n *\n * export const TechDocsReaderPageContent = ({ entity }: TechDocsReaderPageContentProps) => {\n * // ...\n * const dom = useTechDocsReaderDom(entity);\n *\n * useEffect(() => {\n * const updateSidebarPosition = () => {\n * // ...\n * };\n * dom?.addEventListener(SHADOW_DOM_STYLE_LOAD_EVENT, updateSidebarPosition);\n * return () => {\n * dom?.removeEventListener(SHADOW_DOM_STYLE_LOAD_EVENT, updateSidebarPosition);\n * };\n * }, [dom]);\n *\n * const handleDomAppend = useCallback(\n * (newShadowRoot: ShadowRoot) => {\n * setShadowRoot(newShadowRoot);\n * },\n * [setShadowRoot],\n * );\n *\n * return <TechDocsShadowDom element={dom} onAppend={handleDomAppend} />;\n * };\n * ```\n *\n * @param props - see {@link TechDocsShadowDomProps}.\n * @public\n */\nexport const TechDocsShadowDom = (props: TechDocsShadowDomProps) => {\n const { element, onAppend, children } = props;\n\n const [jss, setJss] = useState(\n create({\n ...jssPreset(),\n insertionPoint: undefined,\n }),\n );\n\n useShadowDomStylesEvents(element);\n\n const ref = useCallback(\n (shadowHost: HTMLDivElement) => {\n if (!element || !shadowHost) return;\n\n setJss(\n create({\n ...jssPreset(),\n insertionPoint: element.querySelector('head') || undefined,\n }),\n );\n\n let shadowRoot = shadowHost.shadowRoot;\n\n if (!shadowRoot) {\n shadowRoot = shadowHost.attachShadow({ mode: 'open' });\n }\n\n shadowRoot.replaceChildren(element);\n\n if (typeof onAppend === 'function') {\n onAppend(shadowRoot);\n }\n },\n [element, onAppend],\n );\n\n return (\n <>\n {/* The sheetsManager={new Map()} is needed in order to deduplicate the injection of CSS in the page. */}\n <StylesProvider jss={jss} sheetsManager={new Map()}>\n <div ref={ref} data-testid=\"techdocs-native-shadowroot\" />\n {children}\n </StylesProvider>\n </>\n );\n};\n"],"names":[],"mappings":";;;;;;AA0BO,MAAM,2BAA8B,GAAA;AAM3C,MAAM,wBAAA,GAA2B,CAAC,OAA4B,KAAA;AAC5D,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,CAAC,OAAS,EAAA;AACZ,MAAA,OAAO,MAAM;AAAA,OAAC;AAAA;AAGhB,IAAA,MAAM,SAAS,OAAQ,CAAA,gBAAA;AAAA,MACrB;AAAA,KACF;AAEA,IAAI,IAAA,KAAA,GAAQ,QAAQ,MAAU,IAAA,CAAA;AAC9B,IAAM,MAAA,KAAA,GAAQ,IAAI,WAAA,CAAY,2BAA2B,CAAA;AAEzD,IAAA,IAAI,CAAC,KAAO,EAAA;AACV,MAAA,OAAA,CAAQ,cAAc,KAAK,CAAA;AAC3B,MAAA,OAAO,MAAM;AAAA,OAAC;AAAA;AAGhB,IAAA,MAAM,aAAa,MAAM;AACvB,MAAI,IAAA,EAAE,UAAU,CAAG,EAAA;AACjB,QAAA,OAAA,CAAQ,cAAc,KAAK,CAAA;AAAA;AAC7B,KACF;AAEA,IAAA,MAAA,EAAQ,QAAQ,CAAS,KAAA,KAAA;AACvB,MAAM,KAAA,CAAA,gBAAA,CAAiB,QAAQ,UAAU,CAAA;AAAA,KAC1C,CAAA;AAED,IAAA,OAAO,MAAM;AACX,MAAA,MAAA,EAAQ,QAAQ,CAAS,KAAA,KAAA;AACvB,QAAM,KAAA,CAAA,mBAAA,CAAoB,QAAQ,UAAU,CAAA;AAAA,OAC7C,CAAA;AAAA,KACH;AAAA,GACF,EAAG,CAAC,OAAO,CAAC,CAAA;AACd,CAAA;AA2Ca,MAAA,yBAAA,GAA4B,CAAC,OAA4B,KAAA;AACpE,EAAA,MAAM,CAAC,OAAA,EAAS,UAAU,CAAA,GAAI,SAAS,KAAK,CAAA;AAE5C,EAAA,SAAA,CAAU,MAAM;AACd,IAAI,IAAA,CAAC,OAAS,EAAA,OAAO,MAAM;AAAA,KAAC;AAE5B,IAAA,UAAA,CAAW,IAAI,CAAA;AAEf,IAAA,MAAM,QAAS,OAAwB,CAAA,KAAA;AAEvC,IAAM,KAAA,CAAA,WAAA,CAAY,WAAW,GAAG,CAAA;AAEhC,IAAA,MAAM,aAAa,MAAM;AACvB,MAAA,UAAA,CAAW,KAAK,CAAA;AAChB,MAAM,KAAA,CAAA,WAAA,CAAY,WAAW,GAAG,CAAA;AAAA,KAClC;AAEA,IAAQ,OAAA,CAAA,gBAAA,CAAiB,6BAA6B,UAAU,CAAA;AAEhE,IAAA,OAAO,MAAM;AACX,MAAQ,OAAA,CAAA,mBAAA,CAAoB,6BAA6B,UAAU,CAAA;AAAA,KACrE;AAAA,GACF,EAAG,CAAC,OAAO,CAAC,CAAA;AAEZ,EAAO,OAAA,OAAA;AACT;AAkEa,MAAA,iBAAA,GAAoB,CAAC,KAAkC,KAAA;AAClE,EAAA,MAAM,EAAE,OAAA,EAAS,QAAU,EAAA,QAAA,EAAa,GAAA,KAAA;AAExC,EAAM,MAAA,CAAC,GAAK,EAAA,MAAM,CAAI,GAAA,QAAA;AAAA,IACpB,MAAO,CAAA;AAAA,MACL,GAAG,SAAU,EAAA;AAAA,MACb,cAAgB,EAAA,KAAA;AAAA,KACjB;AAAA,GACH;AAEA,EAAA,wBAAA,CAAyB,OAAO,CAAA;AAEhC,EAAA,MAAM,GAAM,GAAA,WAAA;AAAA,IACV,CAAC,UAA+B,KAAA;AAC9B,MAAI,IAAA,CAAC,OAAW,IAAA,CAAC,UAAY,EAAA;AAE7B,MAAA,MAAA;AAAA,QACE,MAAO,CAAA;AAAA,UACL,GAAG,SAAU,EAAA;AAAA,UACb,cAAgB,EAAA,OAAA,CAAQ,aAAc,CAAA,MAAM,CAAK,IAAA,KAAA;AAAA,SAClD;AAAA,OACH;AAEA,MAAA,IAAI,aAAa,UAAW,CAAA,UAAA;AAE5B,MAAA,IAAI,CAAC,UAAY,EAAA;AACf,QAAA,UAAA,GAAa,UAAW,CAAA,YAAA,CAAa,EAAE,IAAA,EAAM,QAAQ,CAAA;AAAA;AAGvD,MAAA,UAAA,CAAW,gBAAgB,OAAO,CAAA;AAElC,MAAI,IAAA,OAAO,aAAa,UAAY,EAAA;AAClC,QAAA,QAAA,CAAS,UAAU,CAAA;AAAA;AACrB,KACF;AAAA,IACA,CAAC,SAAS,QAAQ;AAAA,GACpB;AAEA,EAAA,uCAGI,QAAC,kBAAA,IAAA,CAAA,cAAA,EAAA,EAAe,KAAU,aAAe,kBAAA,IAAI,KAC3C,EAAA,QAAA,EAAA;AAAA,oBAAC,GAAA,CAAA,KAAA,EAAA,EAAI,GAAU,EAAA,aAAA,EAAY,4BAA6B,EAAA,CAAA;AAAA,IACvD;AAAA,GAAA,EACH,CACF,EAAA,CAAA;AAEJ;;;;"}
|
package/dist/context.esm.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { jsx } from 'react/jsx-runtime';
|
|
2
|
+
import { memo, useState, useEffect, useContext } from 'react';
|
|
2
3
|
import useAsync from 'react-use/esm/useAsync';
|
|
3
4
|
import useAsyncRetry from 'react-use/esm/useAsyncRetry';
|
|
4
5
|
import { stringifyEntityRef } from '@backstage/catalog-model';
|
|
@@ -65,12 +66,12 @@ const TechDocsReaderPageProvider = memo(
|
|
|
65
66
|
setSubtitle
|
|
66
67
|
};
|
|
67
68
|
const versionedValue = createVersionedValueMap({ 1: value });
|
|
68
|
-
return /* @__PURE__ */
|
|
69
|
+
return /* @__PURE__ */ jsx(
|
|
69
70
|
AnalyticsContext,
|
|
70
71
|
{
|
|
71
|
-
attributes: { entityRef: stringifyEntityRef(entityRef) }
|
|
72
|
-
|
|
73
|
-
|
|
72
|
+
attributes: { entityRef: stringifyEntityRef(entityRef) },
|
|
73
|
+
children: /* @__PURE__ */ jsx(TechDocsReaderPageContext.Provider, { value: versionedValue, children: children instanceof Function ? children(value) : children })
|
|
74
|
+
}
|
|
74
75
|
);
|
|
75
76
|
},
|
|
76
77
|
(prevProps, nextProps) => {
|
package/dist/context.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"context.esm.js","sources":["../src/context.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
|
|
1
|
+
{"version":3,"file":"context.esm.js","sources":["../src/context.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 {\n Dispatch,\n SetStateAction,\n useContext,\n useState,\n memo,\n ReactNode,\n useEffect,\n} from 'react';\nimport useAsync, { AsyncState } from 'react-use/esm/useAsync';\nimport useAsyncRetry from 'react-use/esm/useAsyncRetry';\n\nimport {\n CompoundEntityRef,\n stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport {\n createVersionedContext,\n createVersionedValueMap,\n} from '@backstage/version-bridge';\n\nimport {\n AnalyticsContext,\n configApiRef,\n useApi,\n} from '@backstage/core-plugin-api';\n\nimport { techdocsApiRef } from './api';\nimport { TechDocsEntityMetadata, TechDocsMetadata } from './types';\n\nimport { toLowercaseEntityRefMaybe } from './helpers';\n\nconst areEntityRefsEqual = (\n prevEntityRef: CompoundEntityRef,\n nextEntityRef: CompoundEntityRef,\n) => {\n return (\n stringifyEntityRef(prevEntityRef) === stringifyEntityRef(nextEntityRef)\n );\n};\n\n/**\n * @public type for the value of the TechDocsReaderPageContext\n */\nexport type TechDocsReaderPageValue = {\n metadata: AsyncState<TechDocsMetadata>;\n entityRef: CompoundEntityRef;\n entityMetadata: AsyncState<TechDocsEntityMetadata>;\n shadowRoot?: ShadowRoot;\n setShadowRoot: Dispatch<SetStateAction<ShadowRoot | undefined>>;\n title: string;\n setTitle: Dispatch<SetStateAction<string>>;\n subtitle: string;\n setSubtitle: Dispatch<SetStateAction<string>>;\n /**\n * @deprecated property can be passed down directly to the `TechDocsReaderPageContent` instead.\n */\n onReady?: () => void;\n};\n\nconst defaultTechDocsReaderPageValue: TechDocsReaderPageValue = {\n title: '',\n subtitle: '',\n setTitle: () => {},\n setSubtitle: () => {},\n setShadowRoot: () => {},\n metadata: { loading: true },\n entityMetadata: { loading: true },\n entityRef: { kind: '', name: '', namespace: '' },\n};\n\nconst TechDocsReaderPageContext = createVersionedContext<{\n 1: TechDocsReaderPageValue;\n}>('techdocs-reader-page-context');\n\n/**\n * render function for {@link TechDocsReaderPageProvider}\n *\n * @public\n */\nexport type TechDocsReaderPageProviderRenderFunction = (\n value: TechDocsReaderPageValue,\n) => JSX.Element;\n\n/**\n * Props for {@link TechDocsReaderPageProvider}\n *\n * @public\n */\nexport type TechDocsReaderPageProviderProps = {\n entityRef: CompoundEntityRef;\n children: TechDocsReaderPageProviderRenderFunction | ReactNode;\n};\n\n/**\n * A context to store the reader page state\n * @public\n */\nexport const TechDocsReaderPageProvider = memo(\n (props: TechDocsReaderPageProviderProps) => {\n const { entityRef, children } = props;\n\n const techdocsApi = useApi(techdocsApiRef);\n const config = useApi(configApiRef);\n\n const entityMetadata = useAsync(async () => {\n return techdocsApi.getEntityMetadata(entityRef);\n }, [entityRef]);\n\n const metadata = useAsyncRetry(async () => {\n return techdocsApi.getTechDocsMetadata(entityRef);\n }, [entityRef]);\n\n const [title, setTitle] = useState(defaultTechDocsReaderPageValue.title);\n const [subtitle, setSubtitle] = useState(\n defaultTechDocsReaderPageValue.subtitle,\n );\n const [shadowRoot, setShadowRoot] = useState<ShadowRoot | undefined>(\n defaultTechDocsReaderPageValue.shadowRoot,\n );\n\n useEffect(() => {\n if (shadowRoot && !metadata.value && !metadata.loading) {\n metadata.retry();\n }\n }, [\n metadata.value,\n metadata.loading,\n shadowRoot,\n metadata.retry,\n metadata,\n ]);\n\n const value: TechDocsReaderPageValue = {\n metadata,\n entityRef: toLowercaseEntityRefMaybe(entityRef, config),\n entityMetadata,\n shadowRoot,\n setShadowRoot,\n title,\n setTitle,\n subtitle,\n setSubtitle,\n };\n const versionedValue = createVersionedValueMap({ 1: value });\n\n return (\n <AnalyticsContext\n attributes={{ entityRef: stringifyEntityRef(entityRef) }}\n >\n <TechDocsReaderPageContext.Provider value={versionedValue}>\n {children instanceof Function ? children(value) : children}\n </TechDocsReaderPageContext.Provider>\n </AnalyticsContext>\n );\n },\n (prevProps, nextProps) => {\n return areEntityRefsEqual(prevProps.entityRef, nextProps.entityRef);\n },\n);\n\n/**\n * Hook used to get access to shared state between reader page components.\n * @public\n */\nexport const useTechDocsReaderPage = () => {\n const versionedContext = useContext(TechDocsReaderPageContext);\n\n if (versionedContext === undefined) {\n return defaultTechDocsReaderPageValue;\n }\n\n const context = versionedContext.atVersion(1);\n if (context === undefined) {\n throw new Error('No context found for version 1.');\n }\n\n return context;\n};\n"],"names":[],"mappings":";;;;;;;;;;AAgDA,MAAM,kBAAA,GAAqB,CACzB,aAAA,EACA,aACG,KAAA;AACH,EAAA,OACE,kBAAmB,CAAA,aAAa,CAAM,KAAA,kBAAA,CAAmB,aAAa,CAAA;AAE1E,CAAA;AAqBA,MAAM,8BAA0D,GAAA;AAAA,EAC9D,KAAO,EAAA,EAAA;AAAA,EACP,QAAU,EAAA,EAAA;AAAA,EACV,UAAU,MAAM;AAAA,GAAC;AAAA,EACjB,aAAa,MAAM;AAAA,GAAC;AAAA,EACpB,eAAe,MAAM;AAAA,GAAC;AAAA,EACtB,QAAA,EAAU,EAAE,OAAA,EAAS,IAAK,EAAA;AAAA,EAC1B,cAAA,EAAgB,EAAE,OAAA,EAAS,IAAK,EAAA;AAAA,EAChC,WAAW,EAAE,IAAA,EAAM,IAAI,IAAM,EAAA,EAAA,EAAI,WAAW,EAAG;AACjD,CAAA;AAEA,MAAM,yBAAA,GAA4B,uBAE/B,8BAA8B,CAAA;AAyB1B,MAAM,0BAA6B,GAAA,IAAA;AAAA,EACxC,CAAC,KAA2C,KAAA;AAC1C,IAAM,MAAA,EAAE,SAAW,EAAA,QAAA,EAAa,GAAA,KAAA;AAEhC,IAAM,MAAA,WAAA,GAAc,OAAO,cAAc,CAAA;AACzC,IAAM,MAAA,MAAA,GAAS,OAAO,YAAY,CAAA;AAElC,IAAM,MAAA,cAAA,GAAiB,SAAS,YAAY;AAC1C,MAAO,OAAA,WAAA,CAAY,kBAAkB,SAAS,CAAA;AAAA,KAChD,EAAG,CAAC,SAAS,CAAC,CAAA;AAEd,IAAM,MAAA,QAAA,GAAW,cAAc,YAAY;AACzC,MAAO,OAAA,WAAA,CAAY,oBAAoB,SAAS,CAAA;AAAA,KAClD,EAAG,CAAC,SAAS,CAAC,CAAA;AAEd,IAAA,MAAM,CAAC,KAAO,EAAA,QAAQ,CAAI,GAAA,QAAA,CAAS,+BAA+B,KAAK,CAAA;AACvE,IAAM,MAAA,CAAC,QAAU,EAAA,WAAW,CAAI,GAAA,QAAA;AAAA,MAC9B,8BAA+B,CAAA;AAAA,KACjC;AACA,IAAM,MAAA,CAAC,UAAY,EAAA,aAAa,CAAI,GAAA,QAAA;AAAA,MAClC,8BAA+B,CAAA;AAAA,KACjC;AAEA,IAAA,SAAA,CAAU,MAAM;AACd,MAAA,IAAI,cAAc,CAAC,QAAA,CAAS,KAAS,IAAA,CAAC,SAAS,OAAS,EAAA;AACtD,QAAA,QAAA,CAAS,KAAM,EAAA;AAAA;AACjB,KACC,EAAA;AAAA,MACD,QAAS,CAAA,KAAA;AAAA,MACT,QAAS,CAAA,OAAA;AAAA,MACT,UAAA;AAAA,MACA,QAAS,CAAA,KAAA;AAAA,MACT;AAAA,KACD,CAAA;AAED,IAAA,MAAM,KAAiC,GAAA;AAAA,MACrC,QAAA;AAAA,MACA,SAAA,EAAW,yBAA0B,CAAA,SAAA,EAAW,MAAM,CAAA;AAAA,MACtD,cAAA;AAAA,MACA,UAAA;AAAA,MACA,aAAA;AAAA,MACA,KAAA;AAAA,MACA,QAAA;AAAA,MACA,QAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,MAAM,cAAiB,GAAA,uBAAA,CAAwB,EAAE,CAAA,EAAG,OAAO,CAAA;AAE3D,IACE,uBAAA,GAAA;AAAA,MAAC,gBAAA;AAAA,MAAA;AAAA,QACC,UAAY,EAAA,EAAE,SAAW,EAAA,kBAAA,CAAmB,SAAS,CAAE,EAAA;AAAA,QAEvD,QAAA,kBAAA,GAAA,CAAC,yBAA0B,CAAA,QAAA,EAA1B,EAAmC,KAAA,EAAO,cACxC,EAAA,QAAA,EAAA,QAAA,YAAoB,QAAW,GAAA,QAAA,CAAS,KAAK,CAAA,GAAI,QACpD,EAAA;AAAA;AAAA,KACF;AAAA,GAEJ;AAAA,EACA,CAAC,WAAW,SAAc,KAAA;AACxB,IAAA,OAAO,kBAAmB,CAAA,SAAA,CAAU,SAAW,EAAA,SAAA,CAAU,SAAS,CAAA;AAAA;AAEtE;AAMO,MAAM,wBAAwB,MAAM;AACzC,EAAM,MAAA,gBAAA,GAAmB,WAAW,yBAAyB,CAAA;AAE7D,EAAA,IAAI,qBAAqB,KAAW,CAAA,EAAA;AAClC,IAAO,OAAA,8BAAA;AAAA;AAGT,EAAM,MAAA,OAAA,GAAU,gBAAiB,CAAA,SAAA,CAAU,CAAC,CAAA;AAC5C,EAAA,IAAI,YAAY,KAAW,CAAA,EAAA;AACzB,IAAM,MAAA,IAAI,MAAM,iCAAiC,CAAA;AAAA;AAGnD,EAAO,OAAA,OAAA;AACT;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
import
|
|
1
|
+
import * as react from 'react';
|
|
2
|
+
import { ComponentType, PropsWithChildren, Dispatch, SetStateAction, ReactNode } from 'react';
|
|
2
3
|
import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
|
|
3
4
|
import { Extension } from '@backstage/core-plugin-api';
|
|
4
5
|
import { T as TechDocsAddonOptions, a as TechDocsAddonLocations, b as TechDocsMetadata, c as TechDocsEntityMetadata } from './types/types.d-BooYUMWM.js';
|
|
5
6
|
import { CompoundEntityRef } from '@backstage/catalog-model';
|
|
7
|
+
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
6
8
|
import { AsyncState } from 'react-use/esm/useAsync';
|
|
7
9
|
import { Config } from '@backstage/config';
|
|
8
10
|
|
|
@@ -20,7 +22,7 @@ declare const TECHDOCS_ADDONS_WRAPPER_KEY = "techdocs.addons.wrapper.v1";
|
|
|
20
22
|
* TechDocs Addon registry.
|
|
21
23
|
* @public
|
|
22
24
|
*/
|
|
23
|
-
declare const TechDocsAddons:
|
|
25
|
+
declare const TechDocsAddons: ComponentType<PropsWithChildren<{}>>;
|
|
24
26
|
/**
|
|
25
27
|
* Create a TechDocs addon overload signature without props.
|
|
26
28
|
* @public
|
|
@@ -122,7 +124,7 @@ type TechDocsReaderPageProviderProps = {
|
|
|
122
124
|
* A context to store the reader page state
|
|
123
125
|
* @public
|
|
124
126
|
*/
|
|
125
|
-
declare const TechDocsReaderPageProvider:
|
|
127
|
+
declare const TechDocsReaderPageProvider: react.MemoExoticComponent<(props: TechDocsReaderPageProviderProps) => react_jsx_runtime.JSX.Element>;
|
|
126
128
|
/**
|
|
127
129
|
* Hook used to get access to shared state between reader page components.
|
|
128
130
|
* @public
|
|
@@ -239,7 +241,7 @@ type TechDocsShadowDomProps = PropsWithChildren<{
|
|
|
239
241
|
* @param props - see {@link TechDocsShadowDomProps}.
|
|
240
242
|
* @public
|
|
241
243
|
*/
|
|
242
|
-
declare const TechDocsShadowDom: (props: TechDocsShadowDomProps) =>
|
|
244
|
+
declare const TechDocsShadowDom: (props: TechDocsShadowDomProps) => react_jsx_runtime.JSX.Element;
|
|
243
245
|
|
|
244
246
|
/**
|
|
245
247
|
* Hook for use within TechDocs addons that provides access to the underlying
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs-react",
|
|
3
|
-
"version": "1.2.16-next.
|
|
3
|
+
"version": "1.2.16-next.1",
|
|
4
4
|
"description": "Shared frontend utilities for TechDocs and Addons",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "web-library",
|
|
@@ -45,11 +45,11 @@
|
|
|
45
45
|
"types": "./dist/index.d.ts",
|
|
46
46
|
"typesVersions": {
|
|
47
47
|
"*": {
|
|
48
|
-
"*": [
|
|
49
|
-
"dist/index.d.ts"
|
|
50
|
-
],
|
|
51
48
|
"alpha": [
|
|
52
49
|
"dist/alpha.d.ts"
|
|
50
|
+
],
|
|
51
|
+
"package.json": [
|
|
52
|
+
"package.json"
|
|
53
53
|
]
|
|
54
54
|
}
|
|
55
55
|
},
|
|
@@ -68,9 +68,9 @@
|
|
|
68
68
|
"dependencies": {
|
|
69
69
|
"@backstage/catalog-model": "1.7.3",
|
|
70
70
|
"@backstage/config": "1.3.2",
|
|
71
|
-
"@backstage/core-components": "0.17.1-next.
|
|
72
|
-
"@backstage/core-plugin-api": "1.10.
|
|
73
|
-
"@backstage/frontend-plugin-api": "0.10.1-next.
|
|
71
|
+
"@backstage/core-components": "0.17.1-next.1",
|
|
72
|
+
"@backstage/core-plugin-api": "1.10.6-next.0",
|
|
73
|
+
"@backstage/frontend-plugin-api": "0.10.1-next.1",
|
|
74
74
|
"@backstage/version-bridge": "1.0.11",
|
|
75
75
|
"@material-ui/core": "^4.12.2",
|
|
76
76
|
"@material-ui/styles": "^4.11.0",
|
|
@@ -80,9 +80,9 @@
|
|
|
80
80
|
"react-use": "^17.2.4"
|
|
81
81
|
},
|
|
82
82
|
"devDependencies": {
|
|
83
|
-
"@backstage/cli": "0.32.0-next.
|
|
84
|
-
"@backstage/test-utils": "1.7.
|
|
85
|
-
"@backstage/theme": "0.6.
|
|
83
|
+
"@backstage/cli": "0.32.0-next.2",
|
|
84
|
+
"@backstage/test-utils": "1.7.7-next.0",
|
|
85
|
+
"@backstage/theme": "0.6.5-next.0",
|
|
86
86
|
"@testing-library/jest-dom": "^6.0.0",
|
|
87
87
|
"@testing-library/react": "^16.0.0",
|
|
88
88
|
"@types/react": "^18.0.0",
|