@backstage/plugin-techdocs-module-addons-contrib 1.1.22 → 1.1.23-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 +13 -0
- package/dist/ReportIssue/IssueLink.esm.js +1 -4
- package/dist/ReportIssue/IssueLink.esm.js.map +1 -1
- package/dist/ReportIssue/ReportIssue.esm.js +13 -72
- package/dist/ReportIssue/ReportIssue.esm.js.map +1 -1
- package/dist/ReportIssue/ReportIssueContent.esm.js +82 -0
- package/dist/ReportIssue/ReportIssueContent.esm.js.map +1 -0
- package/dist/ReportIssue/constants.esm.js +2 -1
- package/dist/ReportIssue/constants.esm.js.map +1 -1
- package/dist/ReportIssue/hooks.esm.js +1 -1
- package/package.json +10 -10
package/CHANGELOG.md
CHANGED
@@ -1,5 +1,18 @@
|
|
1
1
|
# @backstage/plugin-techdocs-module-addons-contrib
|
2
2
|
|
3
|
+
## 1.1.23-next.0
|
4
|
+
|
5
|
+
### Patch Changes
|
6
|
+
|
7
|
+
- 9c12a76: Fixed rendering issues in `ReportIssue` addon for unsupported repository types and improved shadow DOM event handling. The addon now properly prevents initialization when encountering unsupported repository types and correctly handles selection events within the shadow DOM.
|
8
|
+
- Updated dependencies
|
9
|
+
- @backstage/plugin-techdocs-react@1.2.16-next.0
|
10
|
+
- @backstage/core-components@0.17.1-next.0
|
11
|
+
- @backstage/integration-react@1.2.6-next.0
|
12
|
+
- @backstage/integration@1.16.3-next.0
|
13
|
+
- @backstage/frontend-plugin-api@0.10.1-next.0
|
14
|
+
- @backstage/core-plugin-api@1.10.5
|
15
|
+
|
3
16
|
## 1.1.22
|
4
17
|
|
5
18
|
### Patch Changes
|
@@ -21,10 +21,7 @@ const getIcon = ({ type }) => {
|
|
21
21
|
return BugReportIcon;
|
22
22
|
};
|
23
23
|
const getName = ({ type }) => {
|
24
|
-
|
25
|
-
return "Github";
|
26
|
-
}
|
27
|
-
return "Gitlab";
|
24
|
+
return type.charAt(0).toLocaleUpperCase("en-US") + type.slice(1);
|
28
25
|
};
|
29
26
|
const getUrl = (repository, template) => {
|
30
27
|
const { title, body } = template;
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"IssueLink.esm.js","sources":["../../src/ReportIssue/IssueLink.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 React from 'react';\n\nimport { makeStyles } from '@material-ui/core';\nimport BugReportIcon from '@material-ui/icons/BugReport';\n\nimport { Link, GitHubIcon } from '@backstage/core-components';\n\nimport { ReportIssueTemplate, Repository } from './types';\n\nconst useStyles = makeStyles(theme => ({\n root: {\n display: 'grid',\n gridGap: theme.spacing(1),\n gridAutoFlow: 'column',\n justifyContent: 'center',\n alignItems: 'center',\n color: theme.palette.common.black,\n fontSize: theme.typography.button.fontSize,\n },\n}));\n\ntype IssueLinkProps = {\n template: ReportIssueTemplate;\n repository: Repository;\n};\n\nconst getIcon = ({ type }: Repository) => {\n if (type === 'github') {\n return GitHubIcon;\n }\n return BugReportIcon;\n};\n\nconst getName = ({ type }: Repository) => {\n
|
1
|
+
{"version":3,"file":"IssueLink.esm.js","sources":["../../src/ReportIssue/IssueLink.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 React from 'react';\n\nimport { makeStyles } from '@material-ui/core';\nimport BugReportIcon from '@material-ui/icons/BugReport';\n\nimport { Link, GitHubIcon } from '@backstage/core-components';\n\nimport { ReportIssueTemplate, Repository } from './types';\n\nconst useStyles = makeStyles(theme => ({\n root: {\n display: 'grid',\n gridGap: theme.spacing(1),\n gridAutoFlow: 'column',\n justifyContent: 'center',\n alignItems: 'center',\n color: theme.palette.common.black,\n fontSize: theme.typography.button.fontSize,\n },\n}));\n\ntype IssueLinkProps = {\n template: ReportIssueTemplate;\n repository: Repository;\n};\n\nconst getIcon = ({ type }: Repository) => {\n if (type === 'github') {\n return GitHubIcon;\n }\n return BugReportIcon;\n};\n\nconst getName = ({ type }: Repository) => {\n return type.charAt(0).toLocaleUpperCase('en-US') + type.slice(1);\n};\n\nconst getUrl = (repository: Repository, template: ReportIssueTemplate) => {\n const { title, body } = template;\n const encodedTitle = encodeURIComponent(title);\n const encodedBody = encodeURIComponent(body);\n const { protocol, resource, owner, name, type } = repository;\n\n const url = `${protocol}://${resource}/${owner}/${name}`;\n const encodedUrl = encodeURI(url);\n if (type === 'github') {\n return `${encodedUrl}/issues/new?title=${encodedTitle}&body=${encodedBody}`;\n }\n return `${encodedUrl}/issues/new?issue[title]=${encodedTitle}&issue[description]=${encodedBody}`;\n};\n\nexport const IssueLink = ({ template, repository }: IssueLinkProps) => {\n const classes = useStyles();\n\n const Icon = getIcon(repository);\n const url = getUrl(repository, template);\n\n return (\n <Link className={classes.root} to={url} target=\"_blank\">\n <Icon /> Open new {getName(repository)} issue\n </Link>\n );\n};\n"],"names":[],"mappings":";;;;;AAyBA,MAAM,SAAA,GAAY,WAAW,CAAU,KAAA,MAAA;AAAA,EACrC,IAAM,EAAA;AAAA,IACJ,OAAS,EAAA,MAAA;AAAA,IACT,OAAA,EAAS,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,IACxB,YAAc,EAAA,QAAA;AAAA,IACd,cAAgB,EAAA,QAAA;AAAA,IAChB,UAAY,EAAA,QAAA;AAAA,IACZ,KAAA,EAAO,KAAM,CAAA,OAAA,CAAQ,MAAO,CAAA,KAAA;AAAA,IAC5B,QAAA,EAAU,KAAM,CAAA,UAAA,CAAW,MAAO,CAAA;AAAA;AAEtC,CAAE,CAAA,CAAA;AAOF,MAAM,OAAU,GAAA,CAAC,EAAE,IAAA,EAAuB,KAAA;AACxC,EAAA,IAAI,SAAS,QAAU,EAAA;AACrB,IAAO,OAAA,UAAA;AAAA;AAET,EAAO,OAAA,aAAA;AACT,CAAA;AAEA,MAAM,OAAU,GAAA,CAAC,EAAE,IAAA,EAAuB,KAAA;AACxC,EAAO,OAAA,IAAA,CAAK,OAAO,CAAC,CAAA,CAAE,kBAAkB,OAAO,CAAA,GAAI,IAAK,CAAA,KAAA,CAAM,CAAC,CAAA;AACjE,CAAA;AAEA,MAAM,MAAA,GAAS,CAAC,UAAA,EAAwB,QAAkC,KAAA;AACxE,EAAM,MAAA,EAAE,KAAO,EAAA,IAAA,EAAS,GAAA,QAAA;AACxB,EAAM,MAAA,YAAA,GAAe,mBAAmB,KAAK,CAAA;AAC7C,EAAM,MAAA,WAAA,GAAc,mBAAmB,IAAI,CAAA;AAC3C,EAAA,MAAM,EAAE,QAAU,EAAA,QAAA,EAAU,KAAO,EAAA,IAAA,EAAM,MAAS,GAAA,UAAA;AAElD,EAAM,MAAA,GAAA,GAAM,GAAG,QAAQ,CAAA,GAAA,EAAM,QAAQ,CAAI,CAAA,EAAA,KAAK,IAAI,IAAI,CAAA,CAAA;AACtD,EAAM,MAAA,UAAA,GAAa,UAAU,GAAG,CAAA;AAChC,EAAA,IAAI,SAAS,QAAU,EAAA;AACrB,IAAA,OAAO,CAAG,EAAA,UAAU,CAAqB,kBAAA,EAAA,YAAY,SAAS,WAAW,CAAA,CAAA;AAAA;AAE3E,EAAA,OAAO,CAAG,EAAA,UAAU,CAA4B,yBAAA,EAAA,YAAY,uBAAuB,WAAW,CAAA,CAAA;AAChG,CAAA;AAEO,MAAM,SAAY,GAAA,CAAC,EAAE,QAAA,EAAU,YAAiC,KAAA;AACrE,EAAA,MAAM,UAAU,SAAU,EAAA;AAE1B,EAAM,MAAA,IAAA,GAAO,QAAQ,UAAU,CAAA;AAC/B,EAAM,MAAA,GAAA,GAAM,MAAO,CAAA,UAAA,EAAY,QAAQ,CAAA;AAEvC,EAAA,2CACG,IAAK,EAAA,EAAA,SAAA,EAAW,OAAQ,CAAA,IAAA,EAAM,IAAI,GAAK,EAAA,MAAA,EAAO,QAC7C,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,UAAK,CAAE,EAAA,YAAA,EAAW,OAAQ,CAAA,UAAU,GAAE,QACzC,CAAA;AAEJ;;;;"}
|
@@ -1,83 +1,24 @@
|
|
1
|
-
import React
|
2
|
-
import {
|
3
|
-
import {
|
4
|
-
import {
|
5
|
-
import { IssueLink } from './IssueLink.esm.js';
|
6
|
-
import { useShadowRootSelection, useShadowRootElements } from '@backstage/plugin-techdocs-react';
|
1
|
+
import React from 'react';
|
2
|
+
import { useGitRepository } from './hooks.esm.js';
|
3
|
+
import { ADDON_ISSUE_REPO_TYPES_SUPPORTED } from './constants.esm.js';
|
4
|
+
import { ReportIssueAddonContent } from './ReportIssueContent.esm.js';
|
7
5
|
|
8
|
-
const useStyles = makeStyles((theme) => ({
|
9
|
-
root: {
|
10
|
-
transform: "translate(-100%, -100%)",
|
11
|
-
position: "absolute",
|
12
|
-
padding: theme.spacing(1),
|
13
|
-
zIndex: theme.zIndex.tooltip,
|
14
|
-
background: theme.palette.common.white
|
15
|
-
}
|
16
|
-
}));
|
17
6
|
const ReportIssueAddon = ({
|
18
7
|
debounceTime = 500,
|
19
|
-
templateBuilder
|
8
|
+
templateBuilder
|
20
9
|
}) => {
|
21
|
-
const classes = useStyles();
|
22
|
-
const [style, setStyle] = useState();
|
23
10
|
const repository = useGitRepository();
|
24
|
-
|
25
|
-
const selection = useShadowRootSelection(debounceTime);
|
26
|
-
const [mainContent, feedbackLink] = useShadowRootElements([
|
27
|
-
PAGE_MAIN_CONTENT_SELECTOR,
|
28
|
-
PAGE_FEEDBACK_LINK_SELECTOR
|
29
|
-
]);
|
30
|
-
let [feedbackContainer] = useShadowRootElements([
|
31
|
-
ADDON_FEEDBACK_CONTAINER_SELECTOR
|
32
|
-
]);
|
33
|
-
if (feedbackLink) {
|
34
|
-
feedbackLink.style.display = "none";
|
35
|
-
}
|
36
|
-
useEffect(() => {
|
37
|
-
if (
|
38
|
-
// todo(backstage/techdocs-core) handle non-repo rendering
|
39
|
-
!repository || !selection || !selection.containsNode(mainContent, true) || selection?.containsNode(feedbackContainer, true)
|
40
|
-
) {
|
41
|
-
return;
|
42
|
-
}
|
43
|
-
const mainContentPosition = mainContent.getBoundingClientRect();
|
44
|
-
const selectionPosition = selection.getRangeAt(0).getBoundingClientRect();
|
45
|
-
const distanceFromTop = selectionPosition.top - mainContentPosition.top;
|
46
|
-
const minDistanceFromTop = 50;
|
47
|
-
let top = distanceFromTop < minDistanceFromTop ? 101 : distanceFromTop - 16;
|
48
|
-
if (mainContentPosition.top < 0) {
|
49
|
-
const absMainContentTop = Math.abs(mainContentPosition.top);
|
50
|
-
if (distanceFromTop - absMainContentTop < minDistanceFromTop) {
|
51
|
-
top += 89;
|
52
|
-
}
|
53
|
-
}
|
54
|
-
setStyle({
|
55
|
-
top: `${top}px`,
|
56
|
-
left: `${selectionPosition.left + selectionPosition.width / 2}px`
|
57
|
-
});
|
58
|
-
}, [selection, mainContent, feedbackContainer]);
|
59
|
-
if (!selection || !repository || !["github", "gitlab"].includes(repository.type))
|
11
|
+
if (!repository || !ADDON_ISSUE_REPO_TYPES_SUPPORTED.includes(repository.type)) {
|
60
12
|
return null;
|
61
|
-
if (!feedbackContainer) {
|
62
|
-
feedbackContainer = document.createElement("div");
|
63
|
-
feedbackContainer.setAttribute("id", ADDON_FEEDBACK_CONTAINER_ID);
|
64
|
-
mainContent.prepend(feedbackContainer);
|
65
13
|
}
|
66
|
-
return /* @__PURE__ */ React.createElement(
|
67
|
-
|
14
|
+
return /* @__PURE__ */ React.createElement(
|
15
|
+
ReportIssueAddonContent,
|
68
16
|
{
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
}
|
73
|
-
|
74
|
-
IssueLink,
|
75
|
-
{
|
76
|
-
repository,
|
77
|
-
template: buildTemplate ? buildTemplate({ selection }) : defaultTemplate
|
78
|
-
}
|
79
|
-
)
|
80
|
-
));
|
17
|
+
debounceTime,
|
18
|
+
templateBuilder,
|
19
|
+
repository
|
20
|
+
}
|
21
|
+
);
|
81
22
|
};
|
82
23
|
|
83
24
|
export { ReportIssueAddon };
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"ReportIssue.esm.js","sources":["../../src/ReportIssue/ReportIssue.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 React
|
1
|
+
{"version":3,"file":"ReportIssue.esm.js","sources":["../../src/ReportIssue/ReportIssue.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 React from 'react';\nimport { useGitRepository } from './hooks';\nimport { ReportIssueTemplateBuilder } from './types';\nimport { ADDON_ISSUE_REPO_TYPES_SUPPORTED } from './constants';\nimport { ReportIssueAddonContent } from './ReportIssueContent';\n\n/**\n * Props customizing the <ReportIssue /> Addon.\n *\n * @public\n */\nexport type ReportIssueProps = {\n /**\n * Number of milliseconds after a user highlights some text before the report\n * issue link appears above the highlighted text. Defaults to 500ms.\n */\n debounceTime?: number;\n\n /**\n * An optional function defining how a custom issue title and body should be\n * constructed, given some selected text.\n */\n templateBuilder?: ReportIssueTemplateBuilder;\n};\n\nexport const ReportIssueAddon = ({\n debounceTime = 500,\n templateBuilder,\n}: ReportIssueProps) => {\n const repository = useGitRepository();\n\n if (\n !repository ||\n !ADDON_ISSUE_REPO_TYPES_SUPPORTED.includes(repository.type)\n ) {\n return null;\n }\n\n return (\n <ReportIssueAddonContent\n debounceTime={debounceTime}\n templateBuilder={templateBuilder}\n repository={repository}\n />\n );\n};\n"],"names":[],"mappings":";;;;;AAyCO,MAAM,mBAAmB,CAAC;AAAA,EAC/B,YAAe,GAAA,GAAA;AAAA,EACf;AACF,CAAwB,KAAA;AACtB,EAAA,MAAM,aAAa,gBAAiB,EAAA;AAEpC,EAAA,IACE,CAAC,UACD,IAAA,CAAC,iCAAiC,QAAS,CAAA,UAAA,CAAW,IAAI,CAC1D,EAAA;AACA,IAAO,OAAA,IAAA;AAAA;AAGT,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,uBAAA;AAAA,IAAA;AAAA,MACC,YAAA;AAAA,MACA,eAAA;AAAA,MACA;AAAA;AAAA,GACF;AAEJ;;;;"}
|
@@ -0,0 +1,82 @@
|
|
1
|
+
import React, { useState, useEffect } from 'react';
|
2
|
+
import { makeStyles, Portal, Paper } from '@material-ui/core';
|
3
|
+
import { useGitTemplate } from './hooks.esm.js';
|
4
|
+
import { PAGE_MAIN_CONTENT_SELECTOR, PAGE_FEEDBACK_LINK_SELECTOR, ADDON_FEEDBACK_CONTAINER_SELECTOR, ADDON_FEEDBACK_CONTAINER_ID } from './constants.esm.js';
|
5
|
+
import { IssueLink } from './IssueLink.esm.js';
|
6
|
+
import { useShadowRootSelection, useShadowRootElements } from '@backstage/plugin-techdocs-react';
|
7
|
+
|
8
|
+
const useStyles = makeStyles((theme) => ({
|
9
|
+
root: {
|
10
|
+
transform: "translate(-100%, -100%)",
|
11
|
+
position: "absolute",
|
12
|
+
padding: theme.spacing(1),
|
13
|
+
zIndex: theme.zIndex.tooltip,
|
14
|
+
background: theme.palette.common.white
|
15
|
+
}
|
16
|
+
}));
|
17
|
+
const ReportIssueAddonContent = ({
|
18
|
+
debounceTime,
|
19
|
+
templateBuilder,
|
20
|
+
repository
|
21
|
+
}) => {
|
22
|
+
const classes = useStyles();
|
23
|
+
const [style, setStyle] = useState();
|
24
|
+
const defaultTemplate = useGitTemplate(debounceTime);
|
25
|
+
const selection = useShadowRootSelection(debounceTime);
|
26
|
+
const [mainContent, feedbackLink] = useShadowRootElements([
|
27
|
+
PAGE_MAIN_CONTENT_SELECTOR,
|
28
|
+
PAGE_FEEDBACK_LINK_SELECTOR
|
29
|
+
]);
|
30
|
+
let [feedbackContainer] = useShadowRootElements([
|
31
|
+
ADDON_FEEDBACK_CONTAINER_SELECTOR
|
32
|
+
]);
|
33
|
+
if (feedbackLink) {
|
34
|
+
feedbackLink.style.display = "none";
|
35
|
+
}
|
36
|
+
useEffect(() => {
|
37
|
+
if (!selection || !selection.containsNode(mainContent, true) || selection.containsNode(feedbackContainer, true)) {
|
38
|
+
return;
|
39
|
+
}
|
40
|
+
const mainContentPosition = mainContent.getBoundingClientRect();
|
41
|
+
const selectionPosition = selection.getRangeAt(0).getBoundingClientRect();
|
42
|
+
const distanceFromTop = selectionPosition.top - mainContentPosition.top;
|
43
|
+
const minDistanceFromTop = 50;
|
44
|
+
let top = distanceFromTop < minDistanceFromTop ? 101 : distanceFromTop - 16;
|
45
|
+
if (mainContentPosition.top < 0) {
|
46
|
+
const absMainContentTop = Math.abs(mainContentPosition.top);
|
47
|
+
if (distanceFromTop - absMainContentTop < minDistanceFromTop) {
|
48
|
+
top += 89;
|
49
|
+
}
|
50
|
+
}
|
51
|
+
setStyle({
|
52
|
+
top: `${top}px`,
|
53
|
+
left: `${selectionPosition.left + selectionPosition.width / 2}px`
|
54
|
+
});
|
55
|
+
}, [selection, mainContent, feedbackContainer]);
|
56
|
+
if (!feedbackContainer) {
|
57
|
+
feedbackContainer = document.createElement("div");
|
58
|
+
feedbackContainer.setAttribute("id", ADDON_FEEDBACK_CONTAINER_ID);
|
59
|
+
mainContent.prepend(feedbackContainer);
|
60
|
+
}
|
61
|
+
if (!selection || !selection.containsNode(mainContent, true)) {
|
62
|
+
return null;
|
63
|
+
}
|
64
|
+
return /* @__PURE__ */ React.createElement(Portal, { container: feedbackContainer }, /* @__PURE__ */ React.createElement(
|
65
|
+
Paper,
|
66
|
+
{
|
67
|
+
"data-testid": "report-issue-addon",
|
68
|
+
className: classes.root,
|
69
|
+
style
|
70
|
+
},
|
71
|
+
/* @__PURE__ */ React.createElement(
|
72
|
+
IssueLink,
|
73
|
+
{
|
74
|
+
repository,
|
75
|
+
template: templateBuilder ? templateBuilder({ selection }) : defaultTemplate
|
76
|
+
}
|
77
|
+
)
|
78
|
+
));
|
79
|
+
};
|
80
|
+
|
81
|
+
export { ReportIssueAddonContent };
|
82
|
+
//# sourceMappingURL=ReportIssueContent.esm.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"ReportIssueContent.esm.js","sources":["../../src/ReportIssue/ReportIssueContent.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 React, { useState, useEffect } from 'react';\nimport { makeStyles, Portal, Paper } from '@material-ui/core';\nimport { useGitTemplate } from './hooks';\nimport {\n PAGE_MAIN_CONTENT_SELECTOR,\n PAGE_FEEDBACK_LINK_SELECTOR,\n ADDON_FEEDBACK_CONTAINER_ID,\n ADDON_FEEDBACK_CONTAINER_SELECTOR,\n} from './constants';\nimport { IssueLink } from './IssueLink';\nimport {\n useShadowRootElements,\n useShadowRootSelection,\n} from '@backstage/plugin-techdocs-react';\nimport { Repository } from './types';\nimport { ReportIssueProps } from './ReportIssue';\n\nconst useStyles = makeStyles(theme => ({\n root: {\n transform: 'translate(-100%, -100%)',\n position: 'absolute',\n padding: theme.spacing(1),\n zIndex: theme.zIndex.tooltip,\n background: theme.palette.common.white,\n },\n}));\n\ntype Style = {\n top: string;\n left: string;\n};\n\n// Props customizing the <ReportIssue /> Addon.\nexport type ReportIssueAddonContentProps = ReportIssueProps & {\n repository: Repository;\n};\n\nexport const ReportIssueAddonContent = ({\n debounceTime,\n templateBuilder,\n repository,\n}: ReportIssueAddonContentProps) => {\n const classes = useStyles();\n const [style, setStyle] = useState<Style>();\n const defaultTemplate = useGitTemplate(debounceTime);\n const selection = useShadowRootSelection(debounceTime);\n\n const [mainContent, feedbackLink] = useShadowRootElements([\n PAGE_MAIN_CONTENT_SELECTOR,\n PAGE_FEEDBACK_LINK_SELECTOR,\n ]);\n\n let [feedbackContainer] = useShadowRootElements([\n ADDON_FEEDBACK_CONTAINER_SELECTOR,\n ]);\n\n if (feedbackLink) {\n feedbackLink.style.display = 'none';\n }\n\n useEffect(() => {\n if (\n !selection ||\n !selection.containsNode(mainContent, true) ||\n selection.containsNode(feedbackContainer, true)\n ) {\n return;\n }\n\n const mainContentPosition = mainContent.getBoundingClientRect();\n const selectionPosition = selection.getRangeAt(0).getBoundingClientRect();\n\n const distanceFromTop = selectionPosition.top - mainContentPosition.top;\n const minDistanceFromTop = 50;\n\n let top = distanceFromTop < minDistanceFromTop ? 101 : distanceFromTop - 16;\n\n if (mainContentPosition.top < 0) {\n const absMainContentTop = Math.abs(mainContentPosition.top);\n if (distanceFromTop - absMainContentTop < minDistanceFromTop) {\n top += 89;\n }\n }\n\n setStyle({\n top: `${top}px`,\n left: `${selectionPosition.left + selectionPosition.width / 2}px`,\n });\n }, [selection, mainContent, feedbackContainer]);\n\n if (!feedbackContainer) {\n feedbackContainer = document.createElement('div');\n feedbackContainer.setAttribute('id', ADDON_FEEDBACK_CONTAINER_ID);\n mainContent!.prepend(feedbackContainer);\n }\n\n if (!selection || !selection.containsNode(mainContent, true)) {\n return null;\n }\n\n return (\n <Portal container={feedbackContainer}>\n <Paper\n data-testid=\"report-issue-addon\"\n className={classes.root}\n style={style}\n >\n <IssueLink\n repository={repository}\n template={\n templateBuilder ? templateBuilder({ selection }) : defaultTemplate\n }\n />\n </Paper>\n </Portal>\n );\n};\n"],"names":[],"mappings":";;;;;;;AAiCA,MAAM,SAAA,GAAY,WAAW,CAAU,KAAA,MAAA;AAAA,EACrC,IAAM,EAAA;AAAA,IACJ,SAAW,EAAA,yBAAA;AAAA,IACX,QAAU,EAAA,UAAA;AAAA,IACV,OAAA,EAAS,KAAM,CAAA,OAAA,CAAQ,CAAC,CAAA;AAAA,IACxB,MAAA,EAAQ,MAAM,MAAO,CAAA,OAAA;AAAA,IACrB,UAAA,EAAY,KAAM,CAAA,OAAA,CAAQ,MAAO,CAAA;AAAA;AAErC,CAAE,CAAA,CAAA;AAYK,MAAM,0BAA0B,CAAC;AAAA,EACtC,YAAA;AAAA,EACA,eAAA;AAAA,EACA;AACF,CAAoC,KAAA;AAClC,EAAA,MAAM,UAAU,SAAU,EAAA;AAC1B,EAAA,MAAM,CAAC,KAAA,EAAO,QAAQ,CAAA,GAAI,QAAgB,EAAA;AAC1C,EAAM,MAAA,eAAA,GAAkB,eAAe,YAAY,CAAA;AACnD,EAAM,MAAA,SAAA,GAAY,uBAAuB,YAAY,CAAA;AAErD,EAAA,MAAM,CAAC,WAAA,EAAa,YAAY,CAAA,GAAI,qBAAsB,CAAA;AAAA,IACxD,0BAAA;AAAA,IACA;AAAA,GACD,CAAA;AAED,EAAI,IAAA,CAAC,iBAAiB,CAAA,GAAI,qBAAsB,CAAA;AAAA,IAC9C;AAAA,GACD,CAAA;AAED,EAAA,IAAI,YAAc,EAAA;AAChB,IAAA,YAAA,CAAa,MAAM,OAAU,GAAA,MAAA;AAAA;AAG/B,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IACE,CAAC,SAAA,IACD,CAAC,SAAA,CAAU,YAAa,CAAA,WAAA,EAAa,IAAI,CAAA,IACzC,SAAU,CAAA,YAAA,CAAa,iBAAmB,EAAA,IAAI,CAC9C,EAAA;AACA,MAAA;AAAA;AAGF,IAAM,MAAA,mBAAA,GAAsB,YAAY,qBAAsB,EAAA;AAC9D,IAAA,MAAM,iBAAoB,GAAA,SAAA,CAAU,UAAW,CAAA,CAAC,EAAE,qBAAsB,EAAA;AAExE,IAAM,MAAA,eAAA,GAAkB,iBAAkB,CAAA,GAAA,GAAM,mBAAoB,CAAA,GAAA;AACpE,IAAA,MAAM,kBAAqB,GAAA,EAAA;AAE3B,IAAA,IAAI,GAAM,GAAA,eAAA,GAAkB,kBAAqB,GAAA,GAAA,GAAM,eAAkB,GAAA,EAAA;AAEzE,IAAI,IAAA,mBAAA,CAAoB,MAAM,CAAG,EAAA;AAC/B,MAAA,MAAM,iBAAoB,GAAA,IAAA,CAAK,GAAI,CAAA,mBAAA,CAAoB,GAAG,CAAA;AAC1D,MAAI,IAAA,eAAA,GAAkB,oBAAoB,kBAAoB,EAAA;AAC5D,QAAO,GAAA,IAAA,EAAA;AAAA;AACT;AAGF,IAAS,QAAA,CAAA;AAAA,MACP,GAAA,EAAK,GAAG,GAAG,CAAA,EAAA,CAAA;AAAA,MACX,MAAM,CAAG,EAAA,iBAAA,CAAkB,IAAO,GAAA,iBAAA,CAAkB,QAAQ,CAAC,CAAA,EAAA;AAAA,KAC9D,CAAA;AAAA,GACA,EAAA,CAAC,SAAW,EAAA,WAAA,EAAa,iBAAiB,CAAC,CAAA;AAE9C,EAAA,IAAI,CAAC,iBAAmB,EAAA;AACtB,IAAoB,iBAAA,GAAA,QAAA,CAAS,cAAc,KAAK,CAAA;AAChD,IAAkB,iBAAA,CAAA,YAAA,CAAa,MAAM,2BAA2B,CAAA;AAChE,IAAA,WAAA,CAAa,QAAQ,iBAAiB,CAAA;AAAA;AAGxC,EAAA,IAAI,CAAC,SAAa,IAAA,CAAC,UAAU,YAAa,CAAA,WAAA,EAAa,IAAI,CAAG,EAAA;AAC5D,IAAO,OAAA,IAAA;AAAA;AAGT,EACE,uBAAA,KAAA,CAAA,aAAA,CAAC,MAAO,EAAA,EAAA,SAAA,EAAW,iBACjB,EAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,KAAA;AAAA,IAAA;AAAA,MACC,aAAY,EAAA,oBAAA;AAAA,MACZ,WAAW,OAAQ,CAAA,IAAA;AAAA,MACnB;AAAA,KAAA;AAAA,oBAEA,KAAA,CAAA,aAAA;AAAA,MAAC,SAAA;AAAA,MAAA;AAAA,QACC,UAAA;AAAA,QACA,UACE,eAAkB,GAAA,eAAA,CAAgB,EAAE,SAAA,EAAW,CAAI,GAAA;AAAA;AAAA;AAEvD,GAEJ,CAAA;AAEJ;;;;"}
|
@@ -1,8 +1,9 @@
|
|
1
1
|
const ADDON_FEEDBACK_CONTAINER_ID = "techdocs-report-issue";
|
2
2
|
const ADDON_FEEDBACK_CONTAINER_SELECTOR = `#${ADDON_FEEDBACK_CONTAINER_ID}`;
|
3
|
+
const ADDON_ISSUE_REPO_TYPES_SUPPORTED = ["github", "gitlab"];
|
3
4
|
const PAGE_EDIT_LINK_SELECTOR = '[title^="Edit this page"]';
|
4
5
|
const PAGE_FEEDBACK_LINK_SELECTOR = '[title^="Leave feedback for"]';
|
5
6
|
const PAGE_MAIN_CONTENT_SELECTOR = '[data-md-component="main"] .md-content';
|
6
7
|
|
7
|
-
export { ADDON_FEEDBACK_CONTAINER_ID, ADDON_FEEDBACK_CONTAINER_SELECTOR, PAGE_EDIT_LINK_SELECTOR, PAGE_FEEDBACK_LINK_SELECTOR, PAGE_MAIN_CONTENT_SELECTOR };
|
8
|
+
export { ADDON_FEEDBACK_CONTAINER_ID, ADDON_FEEDBACK_CONTAINER_SELECTOR, ADDON_ISSUE_REPO_TYPES_SUPPORTED, PAGE_EDIT_LINK_SELECTOR, PAGE_FEEDBACK_LINK_SELECTOR, PAGE_MAIN_CONTENT_SELECTOR };
|
8
9
|
//# sourceMappingURL=constants.esm.js.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"constants.esm.js","sources":["../../src/ReportIssue/constants.ts"],"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\nexport const ADDON_FEEDBACK_CONTAINER_ID = 'techdocs-report-issue';\nexport const ADDON_FEEDBACK_CONTAINER_SELECTOR = `#${ADDON_FEEDBACK_CONTAINER_ID}`;\nexport const PAGE_EDIT_LINK_SELECTOR = '[title^=\"Edit this page\"]';\nexport const PAGE_FEEDBACK_LINK_SELECTOR = '[title^=\"Leave feedback for\"]';\nexport const PAGE_MAIN_CONTENT_SELECTOR =\n '[data-md-component=\"main\"] .md-content';\n"],"names":[],"mappings":"AAgBO,MAAM,2BAA8B,GAAA;AAC9B,MAAA,iCAAA,GAAoC,IAAI,2BAA2B,CAAA;
|
1
|
+
{"version":3,"file":"constants.esm.js","sources":["../../src/ReportIssue/constants.ts"],"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\nexport const ADDON_FEEDBACK_CONTAINER_ID = 'techdocs-report-issue';\nexport const ADDON_FEEDBACK_CONTAINER_SELECTOR = `#${ADDON_FEEDBACK_CONTAINER_ID}`;\nexport const ADDON_ISSUE_REPO_TYPES_SUPPORTED = ['github', 'gitlab'];\nexport const PAGE_EDIT_LINK_SELECTOR = '[title^=\"Edit this page\"]';\nexport const PAGE_FEEDBACK_LINK_SELECTOR = '[title^=\"Leave feedback for\"]';\nexport const PAGE_MAIN_CONTENT_SELECTOR =\n '[data-md-component=\"main\"] .md-content';\n"],"names":[],"mappings":"AAgBO,MAAM,2BAA8B,GAAA;AAC9B,MAAA,iCAAA,GAAoC,IAAI,2BAA2B,CAAA;AACnE,MAAA,gCAAA,GAAmC,CAAC,QAAA,EAAU,QAAQ;AAC5D,MAAM,uBAA0B,GAAA;AAChC,MAAM,2BAA8B,GAAA;AACpC,MAAM,0BACX,GAAA;;;;"}
|
@@ -2,7 +2,7 @@ import parseGitUrl from 'git-url-parse';
|
|
2
2
|
import { useApi, configApiRef } from '@backstage/core-plugin-api';
|
3
3
|
import { replaceGithubUrlType, replaceGitLabUrlType } from '@backstage/integration';
|
4
4
|
import { scmIntegrationsApiRef } from '@backstage/integration-react';
|
5
|
-
import {
|
5
|
+
import { useShadowRootElements, useShadowRootSelection } from '@backstage/plugin-techdocs-react';
|
6
6
|
import { PAGE_EDIT_LINK_SELECTOR } from './constants.esm.js';
|
7
7
|
|
8
8
|
const resolveBlobUrl = (url, type) => {
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@backstage/plugin-techdocs-module-addons-contrib",
|
3
|
-
"version": "1.1.
|
3
|
+
"version": "1.1.23-next.0",
|
4
4
|
"description": "Plugin module for contributed TechDocs Addons",
|
5
5
|
"backstage": {
|
6
6
|
"role": "frontend-plugin-module",
|
@@ -60,12 +60,12 @@
|
|
60
60
|
"test": "backstage-cli package test"
|
61
61
|
},
|
62
62
|
"dependencies": {
|
63
|
-
"@backstage/core-components": "
|
64
|
-
"@backstage/core-plugin-api": "
|
65
|
-
"@backstage/frontend-plugin-api": "
|
66
|
-
"@backstage/integration": "
|
67
|
-
"@backstage/integration-react": "
|
68
|
-
"@backstage/plugin-techdocs-react": "
|
63
|
+
"@backstage/core-components": "0.17.1-next.0",
|
64
|
+
"@backstage/core-plugin-api": "1.10.5",
|
65
|
+
"@backstage/frontend-plugin-api": "0.10.1-next.0",
|
66
|
+
"@backstage/integration": "1.16.3-next.0",
|
67
|
+
"@backstage/integration-react": "1.2.6-next.0",
|
68
|
+
"@backstage/plugin-techdocs-react": "1.2.16-next.0",
|
69
69
|
"@material-ui/core": "^4.12.2",
|
70
70
|
"@material-ui/icons": "^4.9.1",
|
71
71
|
"@react-hookz/web": "^24.0.0",
|
@@ -73,9 +73,9 @@
|
|
73
73
|
"photoswipe": "^5.3.7"
|
74
74
|
},
|
75
75
|
"devDependencies": {
|
76
|
-
"@backstage/cli": "
|
77
|
-
"@backstage/plugin-techdocs-addons-test-utils": "
|
78
|
-
"@backstage/test-utils": "
|
76
|
+
"@backstage/cli": "0.32.0-next.1",
|
77
|
+
"@backstage/plugin-techdocs-addons-test-utils": "1.0.47-next.1",
|
78
|
+
"@backstage/test-utils": "1.7.6",
|
79
79
|
"@testing-library/dom": "^10.0.0",
|
80
80
|
"@testing-library/jest-dom": "^6.0.0",
|
81
81
|
"@testing-library/react": "^16.0.0",
|