@backstage-community/plugin-badges 0.7.1 → 0.8.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
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { jsxs, jsx, Fragment } from 'react/jsx-runtime';
|
|
1
2
|
import { useAsyncEntity } from '@backstage/plugin-catalog-react';
|
|
2
3
|
import Box from '@material-ui/core/Box';
|
|
3
4
|
import Button from '@material-ui/core/Button';
|
|
@@ -13,7 +14,7 @@ import FormControl from '@material-ui/core/FormControl';
|
|
|
13
14
|
import Select from '@material-ui/core/Select';
|
|
14
15
|
import Typography from '@material-ui/core/Typography';
|
|
15
16
|
import { useTheme } from '@material-ui/core/styles';
|
|
16
|
-
import
|
|
17
|
+
import { useState } from 'react';
|
|
17
18
|
import useAsync from 'react-use/esm/useAsync';
|
|
18
19
|
import 'react-router-dom';
|
|
19
20
|
import '@backstage/errors';
|
|
@@ -39,33 +40,54 @@ const EntityBadgesDialog = (props) => {
|
|
|
39
40
|
}
|
|
40
41
|
return [];
|
|
41
42
|
}, [badgesApi, entity, open, style]);
|
|
42
|
-
return /* @__PURE__ */
|
|
43
|
-
|
|
44
|
-
{
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
43
|
+
return /* @__PURE__ */ jsxs(Dialog, { fullScreen, open, onClose, children: [
|
|
44
|
+
/* @__PURE__ */ jsx(DialogTitle, { children: "Entity Badges" }),
|
|
45
|
+
/* @__PURE__ */ jsxs(DialogContent, { children: [
|
|
46
|
+
/* @__PURE__ */ jsx(DialogContentText, { children: "Embed badges in other web sites that link back to this entity. Copy the relevant snippet of Markdown code to use the badge." }),
|
|
47
|
+
/* @__PURE__ */ jsx(Typography, { variant: "subtitle1", children: "Select Badge Style" }),
|
|
48
|
+
/* @__PURE__ */ jsxs(
|
|
49
|
+
FormControl,
|
|
50
|
+
{
|
|
51
|
+
variant: "standard",
|
|
52
|
+
style: { width: "100%", marginBottom: "16px" },
|
|
53
|
+
children: [
|
|
54
|
+
/* @__PURE__ */ jsx(InputLabel, { id: "badge-style-label", children: "Style" }),
|
|
55
|
+
/* @__PURE__ */ jsxs(
|
|
56
|
+
Select,
|
|
57
|
+
{
|
|
58
|
+
labelId: "badge-style-label",
|
|
59
|
+
id: "badge-style",
|
|
60
|
+
value: style,
|
|
61
|
+
label: "Style",
|
|
62
|
+
onChange: (e) => setStyle(e.target.value),
|
|
63
|
+
children: [
|
|
64
|
+
/* @__PURE__ */ jsx(MenuItem, { value: void 0, children: /* @__PURE__ */ jsx("em", { children: "Default" }) }),
|
|
65
|
+
BADGE_STYLES.map((s) => /* @__PURE__ */ jsx(MenuItem, { value: s, children: s }, s))
|
|
66
|
+
]
|
|
67
|
+
}
|
|
68
|
+
)
|
|
69
|
+
]
|
|
70
|
+
}
|
|
71
|
+
),
|
|
72
|
+
loading && /* @__PURE__ */ jsx(Progress, {}),
|
|
73
|
+
error && /* @__PURE__ */ jsx(ResponseErrorPanel, { error }),
|
|
74
|
+
badges && /* @__PURE__ */ jsxs(Fragment, { children: [
|
|
75
|
+
/* @__PURE__ */ jsx(Typography, { variant: "subtitle1", children: "Badge Previews" }),
|
|
76
|
+
badges.map(({ badge: { description }, id, url, markdown }) => /* @__PURE__ */ jsx(Box, { marginTop: 2, marginBottom: 2, children: /* @__PURE__ */ jsxs(DialogContentText, { component: "div", children: [
|
|
77
|
+
/* @__PURE__ */ jsx("img", { alt: description || id, src: url }),
|
|
78
|
+
/* @__PURE__ */ jsx(
|
|
79
|
+
CodeSnippet,
|
|
80
|
+
{
|
|
81
|
+
language: "markdown",
|
|
82
|
+
text: markdown,
|
|
83
|
+
showCopyCodeButton: true
|
|
84
|
+
}
|
|
85
|
+
)
|
|
86
|
+
] }) }, id))
|
|
87
|
+
] })
|
|
88
|
+
] }),
|
|
89
|
+
/* @__PURE__ */ jsx(DialogActions, { children: /* @__PURE__ */ jsx(Button, { onClick: onClose, color: "primary", children: "Close" }) })
|
|
90
|
+
] });
|
|
69
91
|
};
|
|
70
92
|
|
|
71
93
|
export { EntityBadgesDialog };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"EntityBadgesDialog.esm.js","sources":["../../src/components/EntityBadgesDialog.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { useAsyncEntity } from '@backstage/plugin-catalog-react';\nimport Box from '@material-ui/core/Box';\nimport Button from '@material-ui/core/Button';\nimport Dialog from '@material-ui/core/Dialog';\nimport DialogActions from '@material-ui/core/DialogActions';\nimport DialogContent from '@material-ui/core/DialogContent';\nimport DialogContentText from '@material-ui/core/DialogContentText';\nimport DialogTitle from '@material-ui/core/DialogTitle';\nimport useMediaQuery from '@material-ui/core/useMediaQuery';\nimport InputLabel from '@material-ui/core/InputLabel';\nimport MenuItem from '@material-ui/core/MenuItem';\nimport FormControl from '@material-ui/core/FormControl';\nimport Select from '@material-ui/core/Select';\nimport Typography from '@material-ui/core/Typography';\nimport { useTheme } from '@material-ui/core/styles';\nimport
|
|
1
|
+
{"version":3,"file":"EntityBadgesDialog.esm.js","sources":["../../src/components/EntityBadgesDialog.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { useAsyncEntity } from '@backstage/plugin-catalog-react';\nimport Box from '@material-ui/core/Box';\nimport Button from '@material-ui/core/Button';\nimport Dialog from '@material-ui/core/Dialog';\nimport DialogActions from '@material-ui/core/DialogActions';\nimport DialogContent from '@material-ui/core/DialogContent';\nimport DialogContentText from '@material-ui/core/DialogContentText';\nimport DialogTitle from '@material-ui/core/DialogTitle';\nimport useMediaQuery from '@material-ui/core/useMediaQuery';\nimport InputLabel from '@material-ui/core/InputLabel';\nimport MenuItem from '@material-ui/core/MenuItem';\nimport FormControl from '@material-ui/core/FormControl';\nimport Select from '@material-ui/core/Select';\nimport Typography from '@material-ui/core/Typography';\nimport { useTheme } from '@material-ui/core/styles';\nimport { useState } from 'react';\nimport useAsync from 'react-use/esm/useAsync';\nimport { BadgeStyle, BADGE_STYLES, badgesApiRef } from '../api';\n\nimport {\n CodeSnippet,\n Progress,\n ResponseErrorPanel,\n} from '@backstage/core-components';\nimport { useApi } from '@backstage/core-plugin-api';\n\nexport const EntityBadgesDialog = (props: {\n open: boolean;\n onClose?: () => any;\n}) => {\n const { open, onClose } = props;\n const theme = useTheme();\n const { entity } = useAsyncEntity();\n const fullScreen = useMediaQuery(theme.breakpoints.down('sm'));\n const badgesApi = useApi(badgesApiRef);\n\n const [style, setStyle] = useState<BadgeStyle>();\n\n const {\n value: badges,\n loading,\n error,\n } = useAsync(async () => {\n if (open && entity) {\n return await badgesApi.getEntityBadgeSpecs(entity, { style });\n }\n return [];\n }, [badgesApi, entity, open, style]);\n\n return (\n <Dialog fullScreen={fullScreen} open={open} onClose={onClose}>\n <DialogTitle>Entity Badges</DialogTitle>\n <DialogContent>\n <DialogContentText>\n Embed badges in other web sites that link back to this entity. Copy\n the relevant snippet of Markdown code to use the badge.\n </DialogContentText>\n\n <Typography variant=\"subtitle1\">Select Badge Style</Typography>\n <FormControl\n variant=\"standard\"\n style={{ width: '100%', marginBottom: '16px' }}\n >\n <InputLabel id=\"badge-style-label\">Style</InputLabel>\n <Select\n labelId=\"badge-style-label\"\n id=\"badge-style\"\n value={style}\n label=\"Style\"\n onChange={e => setStyle(e.target.value as BadgeStyle)}\n >\n <MenuItem value={undefined}>\n <em>Default</em>\n </MenuItem>\n {BADGE_STYLES.map(s => (\n <MenuItem key={s} value={s}>\n {s}\n </MenuItem>\n ))}\n </Select>\n </FormControl>\n\n {loading && <Progress />}\n {error && <ResponseErrorPanel error={error} />}\n\n {badges && (\n <>\n <Typography variant=\"subtitle1\">Badge Previews</Typography>\n {badges.map(({ badge: { description }, id, url, markdown }) => (\n <Box marginTop={2} marginBottom={2} key={id}>\n <DialogContentText component=\"div\">\n <img alt={description || id} src={url} />\n <CodeSnippet\n language=\"markdown\"\n text={markdown}\n showCopyCodeButton\n />\n </DialogContentText>\n </Box>\n ))}\n </>\n )}\n </DialogContent>\n\n <DialogActions>\n <Button onClick={onClose} color=\"primary\">\n Close\n </Button>\n </DialogActions>\n </Dialog>\n );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AA0Ca,MAAA,kBAAA,GAAqB,CAAC,KAG7B,KAAA;AACJ,EAAM,MAAA,EAAE,IAAM,EAAA,OAAA,EAAY,GAAA,KAAA;AAC1B,EAAA,MAAM,QAAQ,QAAS,EAAA;AACvB,EAAM,MAAA,EAAE,MAAO,EAAA,GAAI,cAAe,EAAA;AAClC,EAAA,MAAM,aAAa,aAAc,CAAA,KAAA,CAAM,WAAY,CAAA,IAAA,CAAK,IAAI,CAAC,CAAA;AAC7D,EAAM,MAAA,SAAA,GAAY,OAAO,YAAY,CAAA;AAErC,EAAA,MAAM,CAAC,KAAA,EAAO,QAAQ,CAAA,GAAI,QAAqB,EAAA;AAE/C,EAAM,MAAA;AAAA,IACJ,KAAO,EAAA,MAAA;AAAA,IACP,OAAA;AAAA,IACA;AAAA,GACF,GAAI,SAAS,YAAY;AACvB,IAAA,IAAI,QAAQ,MAAQ,EAAA;AAClB,MAAA,OAAO,MAAM,SAAU,CAAA,mBAAA,CAAoB,MAAQ,EAAA,EAAE,OAAO,CAAA;AAAA;AAE9D,IAAA,OAAO,EAAC;AAAA,KACP,CAAC,SAAA,EAAW,MAAQ,EAAA,IAAA,EAAM,KAAK,CAAC,CAAA;AAEnC,EAAA,uBACG,IAAA,CAAA,MAAA,EAAA,EAAO,UAAwB,EAAA,IAAA,EAAY,OAC1C,EAAA,QAAA,EAAA;AAAA,oBAAA,GAAA,CAAC,eAAY,QAAa,EAAA,eAAA,EAAA,CAAA;AAAA,yBACzB,aACC,EAAA,EAAA,QAAA,EAAA;AAAA,sBAAA,GAAA,CAAC,qBAAkB,QAGnB,EAAA,6HAAA,EAAA,CAAA;AAAA,sBAEC,GAAA,CAAA,UAAA,EAAA,EAAW,OAAQ,EAAA,WAAA,EAAY,QAAkB,EAAA,oBAAA,EAAA,CAAA;AAAA,sBAClD,IAAA;AAAA,QAAC,WAAA;AAAA,QAAA;AAAA,UACC,OAAQ,EAAA,UAAA;AAAA,UACR,KAAO,EAAA,EAAE,KAAO,EAAA,MAAA,EAAQ,cAAc,MAAO,EAAA;AAAA,UAE7C,QAAA,EAAA;AAAA,4BAAC,GAAA,CAAA,UAAA,EAAA,EAAW,EAAG,EAAA,mBAAA,EAAoB,QAAK,EAAA,OAAA,EAAA,CAAA;AAAA,4BACxC,IAAA;AAAA,cAAC,MAAA;AAAA,cAAA;AAAA,gBACC,OAAQ,EAAA,mBAAA;AAAA,gBACR,EAAG,EAAA,aAAA;AAAA,gBACH,KAAO,EAAA,KAAA;AAAA,gBACP,KAAM,EAAA,OAAA;AAAA,gBACN,QAAU,EAAA,CAAA,CAAA,KAAK,QAAS,CAAA,CAAA,CAAE,OAAO,KAAmB,CAAA;AAAA,gBAEpD,QAAA,EAAA;AAAA,kCAAA,GAAA,CAAC,YAAS,KAAO,EAAA,KAAA,CAAA,EACf,QAAC,kBAAA,GAAA,CAAA,IAAA,EAAA,EAAG,qBAAO,CACb,EAAA,CAAA;AAAA,kBACC,YAAA,CAAa,IAAI,CAChB,CAAA,qBAAA,GAAA,CAAC,YAAiB,KAAO,EAAA,CAAA,EACtB,QADY,EAAA,CAAA,EAAA,EAAA,CAEf,CACD;AAAA;AAAA;AAAA;AACH;AAAA;AAAA,OACF;AAAA,MAEC,OAAA,wBAAY,QAAS,EAAA,EAAA,CAAA;AAAA,MACrB,KAAA,oBAAU,GAAA,CAAA,kBAAA,EAAA,EAAmB,KAAc,EAAA,CAAA;AAAA,MAE3C,0BAEG,IAAA,CAAA,QAAA,EAAA,EAAA,QAAA,EAAA;AAAA,wBAAC,GAAA,CAAA,UAAA,EAAA,EAAW,OAAQ,EAAA,WAAA,EAAY,QAAc,EAAA,gBAAA,EAAA,CAAA;AAAA,QAC7C,MAAA,CAAO,IAAI,CAAC,EAAE,OAAO,EAAE,WAAA,IAAe,EAAI,EAAA,GAAA,EAAK,UAC9C,qBAAA,GAAA,CAAC,OAAI,SAAW,EAAA,CAAA,EAAG,cAAc,CAC/B,EAAA,QAAA,kBAAA,IAAA,CAAC,iBAAkB,EAAA,EAAA,SAAA,EAAU,KAC3B,EAAA,QAAA,EAAA;AAAA,0BAAA,GAAA,CAAC,KAAI,EAAA,EAAA,GAAA,EAAK,WAAe,IAAA,EAAA,EAAI,KAAK,GAAK,EAAA,CAAA;AAAA,0BACvC,GAAA;AAAA,YAAC,WAAA;AAAA,YAAA;AAAA,cACC,QAAS,EAAA,UAAA;AAAA,cACT,IAAM,EAAA,QAAA;AAAA,cACN,kBAAkB,EAAA;AAAA;AAAA;AACpB,SACF,EAAA,CAAA,EAAA,EARuC,EASzC,CACD;AAAA,OACH,EAAA;AAAA,KAEJ,EAAA,CAAA;AAAA,oBAEA,GAAA,CAAC,iBACC,QAAC,kBAAA,GAAA,CAAA,MAAA,EAAA,EAAO,SAAS,OAAS,EAAA,KAAA,EAAM,SAAU,EAAA,QAAA,EAAA,OAAA,EAE1C,CACF,EAAA;AAAA,GACF,EAAA,CAAA;AAEJ;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
import * as react from 'react';
|
|
1
|
+
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
3
2
|
import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
|
|
4
3
|
|
|
5
4
|
/** @public */
|
|
@@ -8,6 +7,6 @@ declare const badgesPlugin: _backstage_core_plugin_api.BackstagePlugin<{}, {}, {
|
|
|
8
7
|
declare const EntityBadgesDialog: (props: {
|
|
9
8
|
open: boolean;
|
|
10
9
|
onClose?: (() => any) | undefined;
|
|
11
|
-
}) =>
|
|
10
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
12
11
|
|
|
13
12
|
export { EntityBadgesDialog, badgesPlugin };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage-community/plugin-badges",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"description": "A Backstage plugin that generates README badges for your entities",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin",
|
|
@@ -39,18 +39,18 @@
|
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
41
|
"@backstage/catalog-model": "^1.7.3",
|
|
42
|
-
"@backstage/core-components": "^0.17.
|
|
43
|
-
"@backstage/core-plugin-api": "^1.10.
|
|
42
|
+
"@backstage/core-components": "^0.17.1",
|
|
43
|
+
"@backstage/core-plugin-api": "^1.10.6",
|
|
44
44
|
"@backstage/errors": "^1.2.7",
|
|
45
|
-
"@backstage/plugin-catalog-react": "^1.
|
|
45
|
+
"@backstage/plugin-catalog-react": "^1.17.0",
|
|
46
46
|
"@material-ui/core": "^4.12.2",
|
|
47
47
|
"@types/react": "^16.13.1 || ^17.0.0 || ^18.0.0",
|
|
48
48
|
"react-use": "^17.2.4"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
|
-
"@backstage/cli": "^0.
|
|
52
|
-
"@backstage/dev-utils": "^1.1.
|
|
53
|
-
"@backstage/test-utils": "^1.7.
|
|
51
|
+
"@backstage/cli": "^0.32.0",
|
|
52
|
+
"@backstage/dev-utils": "^1.1.9",
|
|
53
|
+
"@backstage/test-utils": "^1.7.7",
|
|
54
54
|
"@testing-library/dom": "^10.0.0",
|
|
55
55
|
"@testing-library/jest-dom": "^6.0.0",
|
|
56
56
|
"@testing-library/react": "^15.0.0",
|
|
@@ -64,5 +64,12 @@
|
|
|
64
64
|
"react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
|
|
65
65
|
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
|
|
66
66
|
},
|
|
67
|
+
"typesVersions": {
|
|
68
|
+
"*": {
|
|
69
|
+
"package.json": [
|
|
70
|
+
"package.json"
|
|
71
|
+
]
|
|
72
|
+
}
|
|
73
|
+
},
|
|
67
74
|
"module": "./dist/index.esm.js"
|
|
68
75
|
}
|