@backstage/plugin-techdocs 1.17.1-next.2 → 1.17.2

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

@@ -1 +1 @@
-{"version":3,"file":"TechDocsSearch.esm.js","sources":["../../../src/search/components/TechDocsSearch.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 { CompoundEntityRef } from '@backstage/catalog-model';\nimport { ResultHighlight } from '@backstage/plugin-search-common';\nimport {\n  SearchAutocomplete,\n  SearchContextProvider,\n  useSearch,\n} from '@backstage/plugin-search-react';\nimport { useEffect, useState } from 'react';\nimport { useNavigate } from 'react-router-dom';\nimport { TechDocsSearchResultListItem } from './TechDocsSearchResultListItem';\n\n/**\n * Props for {@link TechDocsSearch}\n *\n * @public\n */\nexport type TechDocsSearchProps = {\n  entityId: CompoundEntityRef;\n  entityTitle?: string;\n  debounceTime?: number;\n  searchResultUrlMapper?: (url: string) => string;\n};\n\ntype TechDocsDoc = {\n  namespace: string;\n  kind: string;\n  name: string;\n  path: string;\n  location: string;\n  title: string;\n};\n\ntype TechDocsSearchResult = {\n  type: string;\n  document: TechDocsDoc;\n  highlight?: ResultHighlight;\n};\n\nconst isTechDocsSearchResult = (\n  option: any,\n): option is TechDocsSearchResult => {\n  return option?.document;\n};\n\nconst TechDocsSearchBar = (props: TechDocsSearchProps) => {\n  const {\n    entityId,\n    entityTitle,\n    debounceTime = 150,\n    searchResultUrlMapper,\n  } = props;\n  const [open, setOpen] = useState(false);\n  const navigate = useNavigate();\n  const {\n    setFilters,\n    term,\n    result: { loading, value: searchVal },\n  } = useSearch();\n  const [options, setOptions] = useState<any[]>([]);\n  useEffect(() => {\n    let mounted = true;\n\n    if (mounted && searchVal) {\n      // TODO: Change this into getting only subset of search results from the BE in the first place\n      // once pagination is implemented for search engines\n      // See: https://github.com/backstage/backstage/issues/6062\n      const searchResults = searchVal.results.slice(0, 10);\n      setOptions(searchResults);\n    }\n    return () => {\n      mounted = false;\n    };\n  }, [loading, searchVal]);\n\n  // Update the filter context when the entityId changes, e.g. when the search\n  // bar continues to be rendered, navigating between different TechDocs sites.\n  const { kind, name, namespace } = entityId;\n  useEffect(() => {\n    setFilters(prevFilters => {\n      return {\n        ...prevFilters,\n        kind,\n        namespace,\n        name,\n      };\n    });\n  }, [kind, namespace, name, setFilters]);\n\n  const handleSelection = (\n    _: any,\n    selection: TechDocsSearchResult | string | null,\n  ) => {\n    if (isTechDocsSearchResult(selection)) {\n      const { location } = selection.document;\n      navigate(\n        searchResultUrlMapper ? searchResultUrlMapper(location) : location,\n      );\n    }\n  };\n\n  return (\n    <SearchAutocomplete\n      data-testid=\"techdocs-search-bar\"\n      size=\"small\"\n      open={open && Boolean(term)}\n      getOptionLabel={() => ''}\n      filterOptions={x => {\n        return x; // This is needed to get renderOption to be called after options change. Bug in material-ui?\n      }}\n      onClose={() => {\n        setOpen(false);\n      }}\n      onOpen={() => {\n        setOpen(true);\n      }}\n      onChange={handleSelection}\n      blurOnSelect\n      noOptionsText=\"No results found\"\n      value={null}\n      options={options}\n      renderOption={({ document, highlight }) => (\n        <TechDocsSearchResultListItem\n          result={document}\n          lineClamp={3}\n          asListItem={false}\n          asLink={false}\n          title={document.title}\n          highlight={highlight}\n        />\n      )}\n      loading={loading}\n      inputDebounceTime={debounceTime}\n      inputPlaceholder={`Search ${entityTitle || entityId.name} docs`}\n      freeSolo={false}\n    />\n  );\n};\n\n/**\n * Component used to render search bar on TechDocs page, scoped to\n *\n * @public\n */\nexport const TechDocsSearch = (props: TechDocsSearchProps) => {\n  const initialState = {\n    term: '',\n    types: ['techdocs'],\n    pageCursor: '',\n    filters: props.entityId,\n  };\n  return (\n    <SearchContextProvider initialState={initialState}>\n      <TechDocsSearchBar {...props} />\n    </SearchContextProvider>\n  );\n};\n"],"names":[],"mappings":";;;;;;AAsDA,MAAM,sBAAA,GAAyB,CAC7B,MAAA,KACmC;AACnC,EAAA,OAAO,MAAA,EAAQ,QAAA;AACjB,CAAA;AAEA,MAAM,iBAAA,GAAoB,CAAC,KAAA,KAA+B;AACxD,EAAA,MAAM;AAAA,IACJ,QAAA;AAAA,IACA,WAAA;AAAA,IACA,YAAA,GAAe,GAAA;AAAA,IACf;AAAA,GACF,GAAI,KAAA;AACJ,EAAA,MAAM,CAAC,IAAA,EAAM,OAAO,CAAA,GAAI,SAAS,KAAK,CAAA;AACtC,EAAA,MAAM,WAAW,WAAA,EAAY;AAC7B,EAAA,MAAM;AAAA,IACJ,UAAA;AAAA,IACA,IAAA;AAAA,IACA,MAAA,EAAQ,EAAE,OAAA,EAAS,KAAA,EAAO,SAAA;AAAU,MAClC,SAAA,EAAU;AACd,EAAA,MAAM,CAAC,OAAA,EAAS,UAAU,CAAA,GAAI,QAAA,CAAgB,EAAE,CAAA;AAChD,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,OAAA,GAAU,IAAA;AAEd,IAAA,IAAI,WAAW,SAAA,EAAW;AAIxB,MAAA,MAAM,aAAA,GAAgB,SAAA,CAAU,OAAA,CAAQ,KAAA,CAAM,GAAG,EAAE,CAAA;AACnD,MAAA,UAAA,CAAW,aAAa,CAAA;AAAA,IAC1B;AACA,IAAA,OAAO,MAAM;AACX,MAAA,OAAA,GAAU,KAAA;AAAA,IACZ,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,OAAA,EAAS,SAAS,CAAC,CAAA;AAIvB,EAAA,MAAM,EAAE,IAAA,EAAM,IAAA,EAAM,SAAA,EAAU,GAAI,QAAA;AAClC,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,UAAA,CAAW,CAAA,WAAA,KAAe;AACxB,MAAA,OAAO;AAAA,QACL,GAAG,WAAA;AAAA,QACH,IAAA;AAAA,QACA,SAAA;AAAA,QACA;AAAA,OACF;AAAA,IACF,CAAC,CAAA;AAAA,EACH,GAAG,CAAC,IAAA,EAAM,SAAA,EAAW,IAAA,EAAM,UAAU,CAAC,CAAA;AAEtC,EAAA,MAAM,eAAA,GAAkB,CACtB,CAAA,EACA,SAAA,KACG;AACH,IAAA,IAAI,sBAAA,CAAuB,SAAS,CAAA,EAAG;AACrC,MAAA,MAAM,EAAE,QAAA,EAAS,GAAI,SAAA,CAAU,QAAA;AAC/B,MAAA,QAAA;AAAA,QACE,qBAAA,GAAwB,qBAAA,CAAsB,QAAQ,CAAA,GAAI;AAAA,OAC5D;AAAA,IACF;AAAA,EACF,CAAA;AAEA,EAAA,uBACE,GAAA;AAAA,IAAC,kBAAA;AAAA,IAAA;AAAA,MACC,aAAA,EAAY,qBAAA;AAAA,MACZ,IAAA,EAAK,OAAA;AAAA,MACL,IAAA,EAAM,IAAA,IAAQ,OAAA,CAAQ,IAAI,CAAA;AAAA,MAC1B,gBAAgB,MAAM,EAAA;AAAA,MACtB,eAAe,CAAA,CAAA,KAAK;AAClB,QAAA,OAAO,CAAA;AAAA,MACT,CAAA;AAAA,MACA,SAAS,MAAM;AACb,QAAA,OAAA,CAAQ,KAAK,CAAA;AAAA,MACf,CAAA;AAAA,MACA,QAAQ,MAAM;AACZ,QAAA,OAAA,CAAQ,IAAI,CAAA;AAAA,MACd,CAAA;AAAA,MACA,QAAA,EAAU,eAAA;AAAA,MACV,YAAA,EAAY,IAAA;AAAA,MACZ,aAAA,EAAc,kBAAA;AAAA,MACd,KAAA,EAAO,IAAA;AAAA,MACP,OAAA;AAAA,MACA,YAAA,EAAc,CAAC,EAAE,QAAA,EAAU,WAAU,qBACnC,GAAA;AAAA,QAAC,4BAAA;AAAA,QAAA;AAAA,UACC,MAAA,EAAQ,QAAA;AAAA,UACR,SAAA,EAAW,CAAA;AAAA,UACX,UAAA,EAAY,KAAA;AAAA,UACZ,MAAA,EAAQ,KAAA;AAAA,UACR,OAAO,QAAA,CAAS,KAAA;AAAA,UAChB;AAAA;AAAA,OACF;AAAA,MAEF,OAAA;AAAA,MACA,iBAAA,EAAmB,YAAA;AAAA,MACnB,gBAAA,EAAkB,CAAA,OAAA,EAAU,WAAA,IAAe,QAAA,CAAS,IAAI,CAAA,KAAA,CAAA;AAAA,MACxD,QAAA,EAAU;AAAA;AAAA,GACZ;AAEJ,CAAA;AAOO,MAAM,cAAA,GAAiB,CAAC,KAAA,KAA+B;AAC5D,EAAA,MAAM,YAAA,GAAe;AAAA,IACnB,IAAA,EAAM,EAAA;AAAA,IACN,KAAA,EAAO,CAAC,UAAU,CAAA;AAAA,IAClB,UAAA,EAAY,EAAA;AAAA,IACZ,SAAS,KAAA,CAAM;AAAA,GACjB;AACA,EAAA,2BACG,qBAAA,EAAA,EAAsB,YAAA,EACrB,8BAAC,iBAAA,EAAA,EAAmB,GAAG,OAAO,CAAA,EAChC,CAAA;AAEJ;;;;"}
+{"version":3,"file":"TechDocsSearch.esm.js","sources":["../../../src/search/components/TechDocsSearch.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 { CompoundEntityRef } from '@backstage/catalog-model';\nimport {\n  SearchAutocomplete,\n  SearchContextProvider,\n} from '@backstage/plugin-search-react';\nimport { useState } from 'react';\nimport { useNavigate } from 'react-router-dom';\nimport { TechDocsSearchResultListItem } from './TechDocsSearchResultListItem';\nimport {\n  useTechDocsSearch,\n  TechDocsSearchResult,\n} from '../../hooks/useTechDocsSearch';\n\n/**\n * Props for {@link TechDocsSearch}\n *\n * @public\n */\nexport type TechDocsSearchProps = {\n  entityId: CompoundEntityRef;\n  entityTitle?: string;\n  debounceTime?: number;\n  searchResultUrlMapper?: (url: string) => string;\n};\n\nconst isTechDocsSearchResult = (\n  option: any,\n): option is TechDocsSearchResult => {\n  return option?.document;\n};\n\nconst TechDocsSearchBar = (props: TechDocsSearchProps) => {\n  const {\n    entityId,\n    entityTitle,\n    debounceTime = 150,\n    searchResultUrlMapper,\n  } = props;\n  const [open, setOpen] = useState(false);\n  const navigate = useNavigate();\n  const { results, term, loading } = useTechDocsSearch(entityId);\n\n  const handleSelection = (\n    _: any,\n    selection: TechDocsSearchResult | string | null,\n  ) => {\n    if (isTechDocsSearchResult(selection)) {\n      const { location } = selection.document;\n      navigate(\n        searchResultUrlMapper ? searchResultUrlMapper(location) : location,\n      );\n    }\n  };\n\n  return (\n    <SearchAutocomplete\n      data-testid=\"techdocs-search-bar\"\n      size=\"small\"\n      open={open && Boolean(term)}\n      getOptionLabel={() => ''}\n      filterOptions={x => {\n        return x; // This is needed to get renderOption to be called after options change. Bug in material-ui?\n      }}\n      onClose={() => {\n        setOpen(false);\n      }}\n      onOpen={() => {\n        setOpen(true);\n      }}\n      onChange={handleSelection}\n      blurOnSelect\n      noOptionsText=\"No results found\"\n      value={null}\n      options={results}\n      renderOption={({ document, highlight }) => (\n        <TechDocsSearchResultListItem\n          result={document}\n          lineClamp={3}\n          asListItem={false}\n          asLink={false}\n          title={document.title}\n          highlight={highlight}\n        />\n      )}\n      loading={loading}\n      inputDebounceTime={debounceTime}\n      inputPlaceholder={`Search ${entityTitle || entityId.name} docs`}\n      freeSolo={false}\n    />\n  );\n};\n\n/**\n * Component used to render search bar on TechDocs page, scoped to\n *\n * @public\n */\nexport const TechDocsSearch = (props: TechDocsSearchProps) => {\n  const initialState = {\n    term: '',\n    types: ['techdocs'],\n    pageCursor: '',\n    filters: props.entityId,\n  };\n  return (\n    <SearchContextProvider initialState={initialState}>\n      <TechDocsSearchBar {...props} />\n    </SearchContextProvider>\n  );\n};\n"],"names":[],"mappings":";;;;;;;AAyCA,MAAM,sBAAA,GAAyB,CAC7B,MAAA,KACmC;AACnC,EAAA,OAAO,MAAA,EAAQ,QAAA;AACjB,CAAA;AAEA,MAAM,iBAAA,GAAoB,CAAC,KAAA,KAA+B;AACxD,EAAA,MAAM;AAAA,IACJ,QAAA;AAAA,IACA,WAAA;AAAA,IACA,YAAA,GAAe,GAAA;AAAA,IACf;AAAA,GACF,GAAI,KAAA;AACJ,EAAA,MAAM,CAAC,IAAA,EAAM,OAAO,CAAA,GAAI,SAAS,KAAK,CAAA;AACtC,EAAA,MAAM,WAAW,WAAA,EAAY;AAC7B,EAAA,MAAM,EAAE,OAAA,EAAS,IAAA,EAAM,OAAA,EAAQ,GAAI,kBAAkB,QAAQ,CAAA;AAE7D,EAAA,MAAM,eAAA,GAAkB,CACtB,CAAA,EACA,SAAA,KACG;AACH,IAAA,IAAI,sBAAA,CAAuB,SAAS,CAAA,EAAG;AACrC,MAAA,MAAM,EAAE,QAAA,EAAS,GAAI,SAAA,CAAU,QAAA;AAC/B,MAAA,QAAA;AAAA,QACE,qBAAA,GAAwB,qBAAA,CAAsB,QAAQ,CAAA,GAAI;AAAA,OAC5D;AAAA,IACF;AAAA,EACF,CAAA;AAEA,EAAA,uBACE,GAAA;AAAA,IAAC,kBAAA;AAAA,IAAA;AAAA,MACC,aAAA,EAAY,qBAAA;AAAA,MACZ,IAAA,EAAK,OAAA;AAAA,MACL,IAAA,EAAM,IAAA,IAAQ,OAAA,CAAQ,IAAI,CAAA;AAAA,MAC1B,gBAAgB,MAAM,EAAA;AAAA,MACtB,eAAe,CAAA,CAAA,KAAK;AAClB,QAAA,OAAO,CAAA;AAAA,MACT,CAAA;AAAA,MACA,SAAS,MAAM;AACb,QAAA,OAAA,CAAQ,KAAK,CAAA;AAAA,MACf,CAAA;AAAA,MACA,QAAQ,MAAM;AACZ,QAAA,OAAA,CAAQ,IAAI,CAAA;AAAA,MACd,CAAA;AAAA,MACA,QAAA,EAAU,eAAA;AAAA,MACV,YAAA,EAAY,IAAA;AAAA,MACZ,aAAA,EAAc,kBAAA;AAAA,MACd,KAAA,EAAO,IAAA;AAAA,MACP,OAAA,EAAS,OAAA;AAAA,MACT,YAAA,EAAc,CAAC,EAAE,QAAA,EAAU,WAAU,qBACnC,GAAA;AAAA,QAAC,4BAAA;AAAA,QAAA;AAAA,UACC,MAAA,EAAQ,QAAA;AAAA,UACR,SAAA,EAAW,CAAA;AAAA,UACX,UAAA,EAAY,KAAA;AAAA,UACZ,MAAA,EAAQ,KAAA;AAAA,UACR,OAAO,QAAA,CAAS,KAAA;AAAA,UAChB;AAAA;AAAA,OACF;AAAA,MAEF,OAAA;AAAA,MACA,iBAAA,EAAmB,YAAA;AAAA,MACnB,gBAAA,EAAkB,CAAA,OAAA,EAAU,WAAA,IAAe,QAAA,CAAS,IAAI,CAAA,KAAA,CAAA;AAAA,MACxD,QAAA,EAAU;AAAA;AAAA,GACZ;AAEJ,CAAA;AAOO,MAAM,cAAA,GAAiB,CAAC,KAAA,KAA+B;AAC5D,EAAA,MAAM,YAAA,GAAe;AAAA,IACnB,IAAA,EAAM,EAAA;AAAA,IACN,KAAA,EAAO,CAAC,UAAU,CAAA;AAAA,IAClB,UAAA,EAAY,EAAA;AAAA,IACZ,SAAS,KAAA,CAAM;AAAA,GACjB;AACA,EAAA,2BACG,qBAAA,EAAA,EAAsB,YAAA,EACrB,8BAAC,iBAAA,EAAA,EAAmB,GAAG,OAAO,CAAA,EAChC,CAAA;AAEJ;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-techdocs",
-  "version": "1.17.1-next.2",
+  "version": "1.17.2",
   "description": "The Backstage plugin that renders technical documentation for your components",
   "backstage": {
     "role": "frontend-plugin",
@@ -71,27 +71,29 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-client": "1.14.0-next.2",
-    "@backstage/catalog-model": "1.7.6",
-    "@backstage/config": "1.3.6",
-    "@backstage/core-components": "0.18.8-next.1",
-    "@backstage/core-plugin-api": "1.12.4-next.1",
-    "@backstage/errors": "1.2.7",
-    "@backstage/frontend-plugin-api": "0.15.0-next.1",
-    "@backstage/integration": "2.0.0-next.2",
-    "@backstage/integration-react": "1.2.16-next.1",
-    "@backstage/plugin-auth-react": "0.1.25-next.0",
-    "@backstage/plugin-catalog-react": "2.1.0-next.2",
-    "@backstage/plugin-search-common": "1.2.22",
-    "@backstage/plugin-search-react": "1.10.5-next.1",
-    "@backstage/plugin-techdocs-common": "0.1.1",
-    "@backstage/plugin-techdocs-react": "1.3.9-next.1",
-    "@backstage/theme": "0.7.2",
+    "@backstage/catalog-client": "^1.14.0",
+    "@backstage/catalog-model": "^1.7.7",
+    "@backstage/config": "^1.3.6",
+    "@backstage/core-components": "^0.18.8",
+    "@backstage/core-plugin-api": "^1.12.4",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/frontend-plugin-api": "^0.15.1",
+    "@backstage/integration": "^2.0.0",
+    "@backstage/integration-react": "^1.2.16",
+    "@backstage/plugin-auth-react": "^0.1.25",
+    "@backstage/plugin-catalog-react": "^2.1.0",
+    "@backstage/plugin-search-common": "^1.2.22",
+    "@backstage/plugin-search-react": "^1.11.0",
+    "@backstage/plugin-techdocs-common": "^0.1.1",
+    "@backstage/plugin-techdocs-react": "^1.3.9",
+    "@backstage/theme": "^0.7.2",
+    "@backstage/ui": "^0.13.1",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
     "@material-ui/styles": "^4.10.0",
     "@microsoft/fetch-event-source": "^2.0.1",
+    "@remixicon/react": "^4.6.0",
     "dompurify": "^3.3.2",
     "git-url-parse": "^15.0.0",
     "lodash": "^4.17.21",
@@ -99,12 +101,12 @@
     "react-use": "^17.2.4"
   },
   "devDependencies": {
-    "@backstage/cli": "0.36.0-next.2",
-    "@backstage/core-app-api": "1.19.6-next.1",
-    "@backstage/dev-utils": "1.1.21-next.1",
-    "@backstage/plugin-catalog": "2.0.0-next.2",
-    "@backstage/plugin-techdocs-module-addons-contrib": "1.1.34-next.2",
-    "@backstage/test-utils": "1.7.16-next.0",
+    "@backstage/cli": "^0.36.0",
+    "@backstage/core-app-api": "^1.19.6",
+    "@backstage/dev-utils": "^1.1.21",
+    "@backstage/plugin-catalog": "^2.0.1",
+    "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.34",
+    "@backstage/test-utils": "^1.7.16",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",