@backstage/plugin-techdocs 1.11.1-next.1 → 1.11.1-next.2

package/dist/search/components/TechDocsSearchResultListItem.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"TechDocsSearchResultListItem.esm.js","sources":["../../../src/search/components/TechDocsSearchResultListItem.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 React, { PropsWithChildren, ReactNode } from 'react';\nimport ListItemIcon from '@material-ui/core/ListItemIcon';\nimport ListItemText from '@material-ui/core/ListItemText';\nimport { makeStyles } from '@material-ui/core/styles';\nimport Typography from '@material-ui/core/Typography';\nimport { Link } from '@backstage/core-components';\nimport { ResultHighlight } from '@backstage/plugin-search-common';\nimport { HighlightedSearchResultText } from '@backstage/plugin-search-react';\n\nconst useStyles = makeStyles({\n  flexContainer: {\n    flexWrap: 'wrap',\n  },\n  itemText: {\n    width: '100%',\n    marginBottom: '1rem',\n  },\n});\n\n/**\n * Props for {@link TechDocsSearchResultListItem}.\n *\n * @public\n */\nexport type TechDocsSearchResultListItemProps = {\n  icon?: ReactNode | ((result: any) => ReactNode);\n  result?: any;\n  highlight?: ResultHighlight;\n  rank?: number;\n  lineClamp?: number;\n  asListItem?: boolean;\n  asLink?: boolean;\n  title?: string;\n};\n\n/**\n * Component which renders documentation and related metadata.\n *\n * @public\n */\nexport const TechDocsSearchResultListItem = (\n  props: TechDocsSearchResultListItemProps,\n) => {\n  const {\n    result,\n    highlight,\n    lineClamp = 5,\n    asListItem = true,\n    asLink = true,\n    title,\n    icon,\n  } = props;\n  const classes = useStyles();\n\n  const LinkWrapper = ({ children }: PropsWithChildren<{}>) =>\n    asLink ? (\n      <Link noTrack to={result.location}>\n        {children}\n      </Link>\n    ) : (\n      <>{children}</>\n    );\n\n  const TextItem = () => {\n    const resultTitle = highlight?.fields.title ? (\n      <HighlightedSearchResultText\n        text={highlight.fields.title}\n        preTag={highlight.preTag}\n        postTag={highlight.postTag}\n      />\n    ) : (\n      result.title\n    );\n\n    const entityTitle = highlight?.fields.entityTitle ? (\n      <HighlightedSearchResultText\n        text={highlight.fields.entityTitle}\n        preTag={highlight.preTag}\n        postTag={highlight.postTag}\n      />\n    ) : (\n      result.entityTitle\n    );\n\n    const resultName = highlight?.fields.name ? (\n      <HighlightedSearchResultText\n        text={highlight.fields.name}\n        preTag={highlight.preTag}\n        postTag={highlight.postTag}\n      />\n    ) : (\n      result.name\n    );\n\n    if (!result) return null;\n\n    return (\n      <ListItemText\n        className={classes.itemText}\n        primaryTypographyProps={{ variant: 'h6' }}\n        primary={\n          <LinkWrapper>\n            {title ? (\n              title\n            ) : (\n              <>\n                {resultTitle} | {entityTitle ?? resultName} docs\n              </>\n            )}\n          </LinkWrapper>\n        }\n        secondary={\n          <Typography\n            component=\"span\"\n            style={{\n              display: '-webkit-box',\n              WebkitBoxOrient: 'vertical',\n              WebkitLineClamp: lineClamp,\n              overflow: 'hidden',\n            }}\n            color=\"textSecondary\"\n            variant=\"body2\"\n          >\n            {highlight?.fields.text ? (\n              <HighlightedSearchResultText\n                text={highlight.fields.text}\n                preTag={highlight.preTag}\n                postTag={highlight.postTag}\n              />\n            ) : (\n              result.text\n            )}\n          </Typography>\n        }\n      />\n    );\n  };\n\n  const ListItemWrapper = ({ children }: PropsWithChildren<{}>) =>\n    asListItem ? (\n      <>\n        {icon && (\n          <ListItemIcon>\n            {typeof icon === 'function' ? icon(result) : icon}\n          </ListItemIcon>\n        )}\n        <div className={classes.flexContainer}>{children}</div>\n      </>\n    ) : (\n      <>{children}</>\n    );\n\n  return (\n    <ListItemWrapper>\n      <TextItem />\n    </ListItemWrapper>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;AAyBA,MAAM,YAAY,UAAW,CAAA;AAAA,EAC3B,aAAe,EAAA;AAAA,IACb,QAAU,EAAA,MAAA;AAAA,GACZ;AAAA,EACA,QAAU,EAAA;AAAA,IACR,KAAO,EAAA,MAAA;AAAA,IACP,YAAc,EAAA,MAAA;AAAA,GAChB;AACF,CAAC,CAAA,CAAA;AAuBY,MAAA,4BAAA,GAA+B,CAC1C,KACG,KAAA;AACH,EAAM,MAAA;AAAA,IACJ,MAAA;AAAA,IACA,SAAA;AAAA,IACA,SAAY,GAAA,CAAA;AAAA,IACZ,UAAa,GAAA,IAAA;AAAA,IACb,MAAS,GAAA,IAAA;AAAA,IACT,KAAA;AAAA,IACA,IAAA;AAAA,GACE,GAAA,KAAA,CAAA;AACJ,EAAA,MAAM,UAAU,SAAU,EAAA,CAAA;AAE1B,EAAA,MAAM,cAAc,CAAC,EAAE,QAAS,EAAA,KAC9B,yBACG,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,OAAO,EAAA,IAAA,EAAC,IAAI,MAAO,CAAA,QAAA,EAAA,EACtB,QACH,CAAA,6DAEG,QAAS,CAAA,CAAA;AAGhB,EAAA,MAAM,WAAW,MAAM;AACrB,IAAM,MAAA,WAAA,GAAc,SAAW,EAAA,MAAA,CAAO,KACpC,mBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,2BAAA;AAAA,MAAA;AAAA,QACC,IAAA,EAAM,UAAU,MAAO,CAAA,KAAA;AAAA,QACvB,QAAQ,SAAU,CAAA,MAAA;AAAA,QAClB,SAAS,SAAU,CAAA,OAAA;AAAA,OAAA;AAAA,QAGrB,MAAO,CAAA,KAAA,CAAA;AAGT,IAAM,MAAA,WAAA,GAAc,SAAW,EAAA,MAAA,CAAO,WACpC,mBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,2BAAA;AAAA,MAAA;AAAA,QACC,IAAA,EAAM,UAAU,MAAO,CAAA,WAAA;AAAA,QACvB,QAAQ,SAAU,CAAA,MAAA;AAAA,QAClB,SAAS,SAAU,CAAA,OAAA;AAAA,OAAA;AAAA,QAGrB,MAAO,CAAA,WAAA,CAAA;AAGT,IAAM,MAAA,UAAA,GAAa,SAAW,EAAA,MAAA,CAAO,IACnC,mBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,2BAAA;AAAA,MAAA;AAAA,QACC,IAAA,EAAM,UAAU,MAAO,CAAA,IAAA;AAAA,QACvB,QAAQ,SAAU,CAAA,MAAA;AAAA,QAClB,SAAS,SAAU,CAAA,OAAA;AAAA,OAAA;AAAA,QAGrB,MAAO,CAAA,IAAA,CAAA;AAGT,IAAI,IAAA,CAAC,QAAe,OAAA,IAAA,CAAA;AAEpB,IACE,uBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,YAAA;AAAA,MAAA;AAAA,QACC,WAAW,OAAQ,CAAA,QAAA;AAAA,QACnB,sBAAA,EAAwB,EAAE,OAAA,EAAS,IAAK,EAAA;AAAA,QACxC,OAAA,kBACG,KAAA,CAAA,aAAA,CAAA,WAAA,EAAA,IAAA,EACE,KACC,GAAA,KAAA,mBAGG,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,EAAA,WAAA,EAAY,KAAI,EAAA,WAAA,IAAe,UAAW,EAAA,OAC7C,CAEJ,CAAA;AAAA,QAEF,SACE,kBAAA,KAAA,CAAA,aAAA;AAAA,UAAC,UAAA;AAAA,UAAA;AAAA,YACC,SAAU,EAAA,MAAA;AAAA,YACV,KAAO,EAAA;AAAA,cACL,OAAS,EAAA,aAAA;AAAA,cACT,eAAiB,EAAA,UAAA;AAAA,cACjB,eAAiB,EAAA,SAAA;AAAA,cACjB,QAAU,EAAA,QAAA;AAAA,aACZ;AAAA,YACA,KAAM,EAAA,eAAA;AAAA,YACN,OAAQ,EAAA,OAAA;AAAA,WAAA;AAAA,UAEP,SAAA,EAAW,OAAO,IACjB,mBAAA,KAAA,CAAA,aAAA;AAAA,YAAC,2BAAA;AAAA,YAAA;AAAA,cACC,IAAA,EAAM,UAAU,MAAO,CAAA,IAAA;AAAA,cACvB,QAAQ,SAAU,CAAA,MAAA;AAAA,cAClB,SAAS,SAAU,CAAA,OAAA;AAAA,aAAA;AAAA,cAGrB,MAAO,CAAA,IAAA;AAAA,SAEX;AAAA,OAAA;AAAA,KAEJ,CAAA;AAAA,GAEJ,CAAA;AAEA,EAAM,MAAA,eAAA,GAAkB,CAAC,EAAE,QAAS,EAAA,KAClC,UACE,mBAAA,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,EACG,IACC,oBAAA,KAAA,CAAA,aAAA,CAAC,YACE,EAAA,IAAA,EAAA,OAAO,IAAS,KAAA,UAAA,GAAa,IAAK,CAAA,MAAM,CAAI,GAAA,IAC/C,CAEF,kBAAA,KAAA,CAAA,aAAA,CAAC,KAAI,EAAA,EAAA,SAAA,EAAW,OAAQ,CAAA,aAAA,EAAA,EAAgB,QAAS,CACnD,CAEA,mBAAA,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,EAAG,QAAS,CAAA,CAAA;AAGhB,EAAA,uBACG,KAAA,CAAA,aAAA,CAAA,eAAA,EAAA,IAAA,kBACE,KAAA,CAAA,aAAA,CAAA,QAAA,EAAA,IAAS,CACZ,CAAA,CAAA;AAEJ;;;;"}
+{"version":3,"file":"TechDocsSearchResultListItem.esm.js","sources":["../../../src/search/components/TechDocsSearchResultListItem.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 React, { PropsWithChildren, ReactNode } from 'react';\nimport ListItemIcon from '@material-ui/core/ListItemIcon';\nimport ListItemText from '@material-ui/core/ListItemText';\nimport { makeStyles } from '@material-ui/core/styles';\nimport Typography from '@material-ui/core/Typography';\nimport { Link } from '@backstage/core-components';\nimport { ResultHighlight } from '@backstage/plugin-search-common';\nimport { HighlightedSearchResultText } from '@backstage/plugin-search-react';\n\nconst useStyles = makeStyles({\n  flexContainer: {\n    flexWrap: 'wrap',\n  },\n  itemText: {\n    width: '100%',\n    marginBottom: '1rem',\n  },\n});\n\n/**\n * Props for {@link TechDocsSearchResultListItem}.\n *\n * @public\n */\nexport type TechDocsSearchResultListItemProps = {\n  icon?: ReactNode | ((result: any) => ReactNode);\n  result?: any;\n  highlight?: ResultHighlight;\n  rank?: number;\n  lineClamp?: number;\n  asListItem?: boolean;\n  asLink?: boolean;\n  title?: string;\n};\n\n/**\n * Component which renders documentation and related metadata.\n *\n * @public\n */\nexport const TechDocsSearchResultListItem = (\n  props: TechDocsSearchResultListItemProps,\n) => {\n  const {\n    result,\n    highlight,\n    lineClamp = 5,\n    asListItem = true,\n    asLink = true,\n    title,\n    icon,\n  } = props;\n  const classes = useStyles();\n\n  const LinkWrapper = ({ children }: PropsWithChildren<{}>) =>\n    asLink ? (\n      <Link noTrack to={result.location}>\n        {children}\n      </Link>\n    ) : (\n      <>{children}</>\n    );\n\n  const TextItem = () => {\n    const resultTitle = highlight?.fields.title ? (\n      <HighlightedSearchResultText\n        text={highlight.fields.title}\n        preTag={highlight.preTag}\n        postTag={highlight.postTag}\n      />\n    ) : (\n      result.title\n    );\n\n    const entityTitle = highlight?.fields.entityTitle ? (\n      <HighlightedSearchResultText\n        text={highlight.fields.entityTitle}\n        preTag={highlight.preTag}\n        postTag={highlight.postTag}\n      />\n    ) : (\n      result.entityTitle\n    );\n\n    const resultName = highlight?.fields.name ? (\n      <HighlightedSearchResultText\n        text={highlight.fields.name}\n        preTag={highlight.preTag}\n        postTag={highlight.postTag}\n      />\n    ) : (\n      result.name\n    );\n\n    if (!result) return null;\n\n    return (\n      <ListItemText\n        className={classes.itemText}\n        primaryTypographyProps={{ variant: 'h6' }}\n        primary={\n          <LinkWrapper>\n            {title ? (\n              title\n            ) : (\n              <>\n                {resultTitle} | {entityTitle ?? resultName} docs\n              </>\n            )}\n          </LinkWrapper>\n        }\n        secondary={\n          <Typography\n            component=\"span\"\n            style={{\n              display: '-webkit-box',\n              WebkitBoxOrient: 'vertical',\n              WebkitLineClamp: lineClamp,\n              overflow: 'hidden',\n            }}\n            color=\"textSecondary\"\n            variant=\"body2\"\n          >\n            {highlight?.fields.text ? (\n              <HighlightedSearchResultText\n                text={highlight.fields.text}\n                preTag={highlight.preTag}\n                postTag={highlight.postTag}\n              />\n            ) : (\n              result.text\n            )}\n          </Typography>\n        }\n      />\n    );\n  };\n\n  const ListItemWrapper = ({ children }: PropsWithChildren<{}>) =>\n    asListItem ? (\n      <>\n        {icon && (\n          <ListItemIcon>\n            {typeof icon === 'function' ? icon(result) : icon}\n          </ListItemIcon>\n        )}\n        <div className={classes.flexContainer}>{children}</div>\n      </>\n    ) : (\n      <>{children}</>\n    );\n\n  return (\n    <ListItemWrapper>\n      <TextItem />\n    </ListItemWrapper>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;AAyBA,MAAM,YAAY,UAAW,CAAA;AAAA,EAC3B,aAAe,EAAA;AAAA,IACb,QAAU,EAAA;AAAA,GACZ;AAAA,EACA,QAAU,EAAA;AAAA,IACR,KAAO,EAAA,MAAA;AAAA,IACP,YAAc,EAAA;AAAA;AAElB,CAAC,CAAA;AAuBY,MAAA,4BAAA,GAA+B,CAC1C,KACG,KAAA;AACH,EAAM,MAAA;AAAA,IACJ,MAAA;AAAA,IACA,SAAA;AAAA,IACA,SAAY,GAAA,CAAA;AAAA,IACZ,UAAa,GAAA,IAAA;AAAA,IACb,MAAS,GAAA,IAAA;AAAA,IACT,KAAA;AAAA,IACA;AAAA,GACE,GAAA,KAAA;AACJ,EAAA,MAAM,UAAU,SAAU,EAAA;AAE1B,EAAA,MAAM,cAAc,CAAC,EAAE,QAAS,EAAA,KAC9B,yBACG,KAAA,CAAA,aAAA,CAAA,IAAA,EAAA,EAAK,OAAO,EAAA,IAAA,EAAC,IAAI,MAAO,CAAA,QAAA,EAAA,EACtB,QACH,CAAA,6DAEG,QAAS,CAAA;AAGhB,EAAA,MAAM,WAAW,MAAM;AACrB,IAAM,MAAA,WAAA,GAAc,SAAW,EAAA,MAAA,CAAO,KACpC,mBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,2BAAA;AAAA,MAAA;AAAA,QACC,IAAA,EAAM,UAAU,MAAO,CAAA,KAAA;AAAA,QACvB,QAAQ,SAAU,CAAA,MAAA;AAAA,QAClB,SAAS,SAAU,CAAA;AAAA;AAAA,QAGrB,MAAO,CAAA,KAAA;AAGT,IAAM,MAAA,WAAA,GAAc,SAAW,EAAA,MAAA,CAAO,WACpC,mBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,2BAAA;AAAA,MAAA;AAAA,QACC,IAAA,EAAM,UAAU,MAAO,CAAA,WAAA;AAAA,QACvB,QAAQ,SAAU,CAAA,MAAA;AAAA,QAClB,SAAS,SAAU,CAAA;AAAA;AAAA,QAGrB,MAAO,CAAA,WAAA;AAGT,IAAM,MAAA,UAAA,GAAa,SAAW,EAAA,MAAA,CAAO,IACnC,mBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,2BAAA;AAAA,MAAA;AAAA,QACC,IAAA,EAAM,UAAU,MAAO,CAAA,IAAA;AAAA,QACvB,QAAQ,SAAU,CAAA,MAAA;AAAA,QAClB,SAAS,SAAU,CAAA;AAAA;AAAA,QAGrB,MAAO,CAAA,IAAA;AAGT,IAAI,IAAA,CAAC,QAAe,OAAA,IAAA;AAEpB,IACE,uBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,YAAA;AAAA,MAAA;AAAA,QACC,WAAW,OAAQ,CAAA,QAAA;AAAA,QACnB,sBAAA,EAAwB,EAAE,OAAA,EAAS,IAAK,EAAA;AAAA,QACxC,OAAA,kBACG,KAAA,CAAA,aAAA,CAAA,WAAA,EAAA,IAAA,EACE,KACC,GAAA,KAAA,mBAGG,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,EAAA,WAAA,EAAY,KAAI,EAAA,WAAA,IAAe,UAAW,EAAA,OAC7C,CAEJ,CAAA;AAAA,QAEF,SACE,kBAAA,KAAA,CAAA,aAAA;AAAA,UAAC,UAAA;AAAA,UAAA;AAAA,YACC,SAAU,EAAA,MAAA;AAAA,YACV,KAAO,EAAA;AAAA,cACL,OAAS,EAAA,aAAA;AAAA,cACT,eAAiB,EAAA,UAAA;AAAA,cACjB,eAAiB,EAAA,SAAA;AAAA,cACjB,QAAU,EAAA;AAAA,aACZ;AAAA,YACA,KAAM,EAAA,eAAA;AAAA,YACN,OAAQ,EAAA;AAAA,WAAA;AAAA,UAEP,SAAA,EAAW,OAAO,IACjB,mBAAA,KAAA,CAAA,aAAA;AAAA,YAAC,2BAAA;AAAA,YAAA;AAAA,cACC,IAAA,EAAM,UAAU,MAAO,CAAA,IAAA;AAAA,cACvB,QAAQ,SAAU,CAAA,MAAA;AAAA,cAClB,SAAS,SAAU,CAAA;AAAA;AAAA,cAGrB,MAAO,CAAA;AAAA;AAEX;AAAA,KAEJ;AAAA,GAEJ;AAEA,EAAM,MAAA,eAAA,GAAkB,CAAC,EAAE,QAAS,EAAA,KAClC,UACE,mBAAA,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,EACG,IACC,oBAAA,KAAA,CAAA,aAAA,CAAC,YACE,EAAA,IAAA,EAAA,OAAO,IAAS,KAAA,UAAA,GAAa,IAAK,CAAA,MAAM,CAAI,GAAA,IAC/C,CAEF,kBAAA,KAAA,CAAA,aAAA,CAAC,KAAI,EAAA,EAAA,SAAA,EAAW,OAAQ,CAAA,aAAA,EAAA,EAAgB,QAAS,CACnD,CAEA,mBAAA,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,EAAG,QAAS,CAAA;AAGhB,EAAA,uBACG,KAAA,CAAA,aAAA,CAAA,eAAA,EAAA,IAAA,kBACE,KAAA,CAAA,aAAA,CAAA,QAAA,EAAA,IAAS,CACZ,CAAA;AAEJ;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-techdocs",
-  "version": "1.11.1-next.1",
+  "version": "1.11.1-next.2",
   "description": "The Backstage plugin that renders technical documentation for your components",
   "backstage": {
     "role": "frontend-plugin",
@@ -69,7 +69,7 @@
     "@backstage/integration": "1.15.1",
     "@backstage/integration-react": "1.2.0",
     "@backstage/plugin-auth-react": "0.1.8-next.1",
-    "@backstage/plugin-catalog-react": "1.14.1-next.1",
+    "@backstage/plugin-catalog-react": "1.14.1-next.2",
     "@backstage/plugin-search-common": "1.2.14",
     "@backstage/plugin-search-react": "1.8.2-next.1",
     "@backstage/plugin-techdocs-common": "0.1.0",
@@ -88,9 +88,9 @@
     "react-use": "^17.2.4"
   },
   "devDependencies": {
-    "@backstage/cli": "0.29.0-next.1",
+    "@backstage/cli": "0.29.0-next.2",
     "@backstage/core-app-api": "1.15.1",
-    "@backstage/dev-utils": "1.1.3-next.1",
+    "@backstage/dev-utils": "1.1.3-next.2",
     "@backstage/plugin-techdocs-module-addons-contrib": "1.1.17-next.1",
     "@backstage/test-utils": "1.7.1-next.0",
     "@testing-library/dom": "^10.0.0",