docs: remove custom searching mechanism (#11984)

* docs: remove custom searching mechanism

* remove grouping

* changes to grouping

* small title change

* update resources sitemap
This commit is contained in:
Shahed Nasser
2025-03-26 10:56:02 +02:00
committed by GitHub
parent 87b75ea959
commit c96560ccb7
10 changed files with 316 additions and 250 deletions

View File

@@ -21,8 +21,14 @@ const SearchProvider = ({ children }: SearchProviderProps) => {
apiKey: process.env.NEXT_PUBLIC_ALGOLIA_API_KEY || "temp",
mainIndexName: process.env.NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME || "temp",
indices: [
process.env.NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME || "temp",
process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
{
name: process.env.NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME || "temp",
title: "Store & Admin API",
},
{
name: process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
title: "Docs",
},
],
}}
searchProps={{

View File

@@ -1,5 +1,5 @@
export const metadata = {
title: `${pageNumber} Module Link`,
title: `${pageNumber} Define Module Link`,
}
# {metadata.title}

View File

@@ -16,8 +16,14 @@ const SearchProvider = ({ children }: SearchProviderProps) => {
mainIndexName:
process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
indices: [
process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
process.env.NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME || "temp",
{
name: process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
title: "Docs",
},
{
name: process.env.NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME || "temp",
title: "Store & Admin API",
},
],
}}
searchProps={{

View File

@@ -5,9 +5,54 @@ import { config } from "../config"
import { basePathUrl } from "../utils/base-path-url"
export default function sitemap(): MetadataRoute.Sitemap {
return retrieveMdxPages({
const items = retrieveMdxPages({
basePath: path.resolve("app"),
}).map((filePath) => ({
url: `${config.baseUrl}${basePathUrl(filePath)}`,
}))
// add some references
items.push(
{
url: `${config.baseUrl}${basePathUrl("/references/file-provider-module")}`,
},
{
url: `${config.baseUrl}${basePathUrl("/references/file-service")}`,
},
{
url: `${config.baseUrl}${basePathUrl("/references/locking-module-provider")}`,
},
{
url: `${config.baseUrl}${basePathUrl("/references/locking-service")}`,
},
{
url: `${config.baseUrl}${basePathUrl("/references/notification-provider-module")}`,
},
{
url: `${config.baseUrl}${basePathUrl("/references/notification-service")}`,
},
{
url: `${config.baseUrl}${basePathUrl("/references/event-service")}`,
},
{
url: `${config.baseUrl}${basePathUrl("/references/cache-service")}`,
},
{
url: `${config.baseUrl}${basePathUrl("/references/file-service")}`,
},
{
url: `${config.baseUrl}${basePathUrl("/references/auth/provider")}`,
},
{
url: `${config.baseUrl}${basePathUrl("/references/fulfillment/provider")}`,
},
{
url: `${config.baseUrl}${basePathUrl("/references/tax/provider")}`,
},
{
url: `${config.baseUrl}${basePathUrl("/references/payment/provider")}`,
}
)
return items
}

View File

@@ -16,8 +16,14 @@ const SearchProvider = ({ children }: SearchProviderProps) => {
mainIndexName:
process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
indices: [
process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
process.env.NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME || "temp",
{
name: process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
title: "Docs",
},
{
name: process.env.NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME || "temp",
title: "Store & Admin API",
},
],
}}
searchProps={{

View File

@@ -16,8 +16,14 @@ const SearchProvider = ({ children }: SearchProviderProps) => {
mainIndexName:
process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
indices: [
process.env.NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME || "temp",
process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
{
name: process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
title: "Docs",
},
{
name: process.env.NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME || "temp",
title: "Store & Admin API",
},
],
}}
searchProps={{

View File

@@ -16,8 +16,14 @@ const SearchProvider = ({ children }: SearchProviderProps) => {
mainIndexName:
process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
indices: [
process.env.NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME || "temp",
process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
{
name: process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
title: "Docs",
},
{
name: process.env.NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME || "temp",
title: "Store & Admin API",
},
],
}}
searchProps={{

View File

@@ -11,9 +11,8 @@ import {
useInstantSearch,
} from "react-instantsearch"
import { SearchNoResult } from "../NoResults"
import { SearchHitGroupName } from "./GroupName"
import { useSearch } from "@/providers"
import { Link } from "@/components"
import { AlgoliaIndex, useSearch } from "@/providers"
import { Link, SearchHitGroupName } from "@/components"
export type Hierarchy = "lvl0" | "lvl1" | "lvl2" | "lvl3" | "lvl4" | "lvl5"
@@ -43,7 +42,7 @@ export type GroupedHitType = {
export type SearchHitWrapperProps = {
configureProps: ConfigureProps
indices: string[]
indices: AlgoliaIndex[]
} & Omit<SearchHitsProps, "indexName" | "setNoResults">
export type IndexResults = {
@@ -57,8 +56,8 @@ export const SearchHitsWrapper = ({
}: SearchHitWrapperProps) => {
const { status } = useInstantSearch()
const [hasNoResults, setHashNoResults] = useState<IndexResults>({
[indices[0]]: false,
[indices[1]]: false,
[indices[0].name]: false,
[indices[1].name]: false,
})
const showNoResults = useMemo(() => {
return Object.values(hasNoResults).every((value) => value === true)
@@ -74,11 +73,14 @@ export const SearchHitsWrapper = ({
return (
<div className="h-full overflow-auto px-docs_0.5">
{status !== "loading" && showNoResults && <SearchNoResult />}
{indices.map((indexName, index) => (
{indices.map((index, key) => (
// @ts-expect-error React v19 doesn't see this type as a React element
<Index indexName={indexName} key={index}>
<Index indexName={index.name} key={key}>
{!hasNoResults[index.name] && (
<SearchHitGroupName name={index.title} />
)}
<SearchHits
indexName={indexName}
indexName={index.name}
setNoResults={setNoResults}
{...rest}
/>
@@ -104,30 +106,6 @@ export const SearchHits = ({
const { status } = useInstantSearch()
const { setIsOpen } = useSearch()
// group by lvl0
const grouped: GroupedHitType = useMemo(() => {
const grouped: GroupedHitType = {}
hits.forEach((hit) => {
if (hit.hierarchy.lvl0) {
if (!grouped[hit.hierarchy.lvl0]) {
grouped[hit.hierarchy.lvl0] = []
}
grouped[hit.hierarchy.lvl0].push(hit)
}
})
// sort groups by number of hits
const sortedGroups = Object.fromEntries(
Object.entries(grouped).sort(([, a], [, b]) => {
const lvl1CountA = a.filter((hit) => hit.type === "lvl1").length
const lvl1CountB = b.filter((hit) => hit.type === "lvl1").length
return lvl1CountB - lvl1CountA
})
)
return sortedGroups
}, [hits])
useEffect(() => {
if (status !== "loading" && status !== "stalled") {
setNoResults(indexName, hits.length === 0)
@@ -149,76 +127,71 @@ export const SearchHits = ({
"[&_mark]:text-medusa-fg-interactive"
)}
>
{Object.keys(grouped).map((groupName, index) => (
<Fragment key={index}>
<SearchHitGroupName name={groupName} />
{grouped[groupName].map((item, index) => {
const hierarchies = Object.values(item.hierarchy)
.filter(Boolean)
.join(" ")
return (
<div
className={clsx(
"gap-docs_0.25 relative flex flex-1 flex-col p-docs_0.5",
"overflow-x-hidden text-ellipsis whitespace-nowrap break-words",
"hover:bg-medusa-bg-base-hover",
"focus:bg-medusa-bg-base-hover",
"last:mb-docs_1 focus:outline-none"
)}
key={index}
tabIndex={index}
data-hit
onClick={(e) => {
const target = e.target as Element
if (target.tagName.toLowerCase() === "div") {
target.querySelector("a")?.click()
}
}}
>
<span
className={clsx(
"text-compact-small-plus text-medusa-fg-base",
"max-w-full"
)}
>
{hits.map((item, index) => {
const hierarchies = Object.values(item.hierarchy)
.filter(Boolean)
.join(" ")
return (
<div
className={clsx(
"gap-docs_0.25 relative flex flex-1 flex-col p-docs_0.5",
"overflow-x-hidden text-ellipsis whitespace-nowrap break-words",
"hover:bg-medusa-bg-base-hover",
"focus:bg-medusa-bg-base-hover",
"focus:outline-none"
)}
key={index}
tabIndex={index}
data-hit
onClick={(e) => {
const target = e.target as Element
if (target.tagName.toLowerCase() === "div") {
target.querySelector("a")?.click()
}
}}
>
<span
className={clsx(
"text-compact-small-plus text-medusa-fg-base",
"max-w-full"
)}
>
{/* @ts-expect-error React v19 doesn't see this type as a React element */}
<Snippet attribute={"hierarchy.lvl1"} hit={item} />
</span>
<span className="text-compact-small text-medusa-fg-subtle text-ellipsis overflow-hidden">
{item.type === "content" && (
<>
{/* @ts-expect-error React v19 doesn't see this type as a React element */}
<Snippet attribute={"hierarchy.lvl1"} hit={item} />
</span>
<span className="text-compact-small text-medusa-fg-subtle text-ellipsis overflow-hidden">
{item.type === "content" && (
<>
{/* @ts-expect-error React v19 doesn't see this type as a React element */}
<Snippet attribute={"content"} hit={item} />
</>
)}
{item.type !== "content" && item.description}
</span>
<Snippet attribute={"content"} hit={item} />
</>
)}
{item.type !== "content" && item.description}
</span>
<span
className={clsx(
"text-ellipsis overflow-hidden",
"text-medusa-fg-muted items-center text-compact-x-small"
)}
>
{hierarchies}
</span>
<Link
href={item.url}
className="absolute top-0 left-0 h-full w-full"
target="_self"
onClick={(e) => {
if (checkIfInternal(item.url)) {
e.preventDefault()
window.location.href = item.url
setIsOpen(false)
}
}}
/>
</div>
)
})}
</Fragment>
))}
<span
className={clsx(
"text-ellipsis overflow-hidden",
"text-medusa-fg-muted items-center text-compact-x-small"
)}
>
{hierarchies}
</span>
<Link
href={item.url}
className="absolute top-0 left-0 h-full w-full"
target="_self"
onClick={(e) => {
if (checkIfInternal(item.url)) {
e.preventDefault()
window.location.href = item.url
setIsOpen(false)
}
}}
/>
</div>
)
})}
</div>
)
}

View File

@@ -159,6 +159,7 @@ export const Search = ({
// to be applied between the items.
facetFilters: [facetFilters],
getRankingInfo: true,
hitsPerPage: 3,
}}
indices={algolia.indices}
checkInternalPattern={checkInternalPattern}

View File

@@ -13,14 +13,10 @@ import { checkArraySameElms } from "../../utils"
import {
liteClient as algoliasearch,
LiteClient as SearchClient,
type SearchResponses,
type SearchHits,
SearchResponse,
} from "algoliasearch/lite"
import clsx from "clsx"
// @ts-expect-error can't install the types package because it doesn't support React v19
import { CSSTransition, SwitchTransition } from "react-transition-group"
import { searchFilters } from "../.."
export type SearchCommand = {
name: string
@@ -46,11 +42,16 @@ export type SearchContextType = {
const SearchContext = createContext<SearchContextType | null>(null)
export type AlgoliaIndex = {
name: string
title: string
}
export type AlgoliaProps = {
appId: string
apiKey: string
mainIndexName: string
indices: string[]
indices: AlgoliaIndex[]
}
export type SearchProviderProps = {
@@ -83,154 +84,170 @@ export const SearchProvider = ({
const algoliaClient = algoliasearch(algolia.appId, algolia.apiKey)
return {
...algoliaClient,
async search(searchParams) {
const requests =
"requests" in searchParams ? searchParams.requests : searchParams
// always send this request, which is the main request with no filters
const mainRequest = requests[0]
const params = (mainRequest.params || {}) as Record<string, unknown>
if (!params.query) {
return Promise.resolve({
results: requests.map(() => ({
hits: [],
nbHits: 0,
nbPages: 0,
page: 0,
processingTimeMS: 0,
hitsPerPage: 0,
exhaustiveNbHits: false,
query: "",
params: "",
})),
})
}
// async search(searchParams) {
// const requests =
// "requests" in searchParams ? searchParams.requests : searchParams
// // always send this request, which is the main request with no filters
// const mainRequest = requests[0]
// const params = (mainRequest.params || {}) as Record<string, unknown>
// if (!params.query) {
// return Promise.resolve({
// results: requests.map(() => ({
// hits: [],
// nbHits: 0,
// nbPages: 0,
// page: 0,
// processingTimeMS: 0,
// hitsPerPage: 0,
// exhaustiveNbHits: false,
// query: "",
// params: "",
// })),
// })
// }
// retrieve only requests that have filters
// this is to ensure that we show no result if no filter is selected
const requestsWithFilters = requests.filter((item) => {
if (
!item.params ||
typeof item.params !== "object" ||
!("facetFilters" in item.params)
) {
return false
}
// // retrieve only requests that have filters
// // this is to ensure that we show no result if no filter is selected
// const requestsWithFilters = requests.filter((item) => {
// if (
// !item.params ||
// typeof item.params !== "object" ||
// !("facetFilters" in item.params)
// ) {
// return false
// }
const facetFilters = item.params.facetFilters as string[]
// const facetFilters = item.params.facetFilters as string[]
// if no tag filters are specified, there's still one item,
// which is an empty array
return facetFilters.length >= 1 && facetFilters[0].length > 0
})
// // if no tag filters are specified, there's still one item,
// // which is an empty array
// return facetFilters.length >= 1 && facetFilters[0].length > 0
// })
// check whether a query is entered in the search box
const noQueries = requestsWithFilters.every(
(item) =>
!item.facetQuery &&
(!item.params ||
typeof item.params !== "object" ||
!("query" in item.params) ||
!item.params.query)
)
// // check whether a query is entered in the search box
// const noQueries = requestsWithFilters.every(
// (item) =>
// !item.facetQuery &&
// (!item.params ||
// typeof item.params !== "object" ||
// !("query" in item.params) ||
// !item.params.query)
// )
const newRequests: typeof requestsWithFilters = [mainRequest]
if (!noQueries) {
// split requests per tags
for (const request of requestsWithFilters) {
const params = request.params as Record<string, unknown>
const facetFilters = (params.facetFilters as string[][])[0]
// const newRequests: typeof requestsWithFilters = [mainRequest]
// if (!noQueries) {
// // split requests per tags
// for (const request of requestsWithFilters) {
// const params = request.params as Record<string, unknown>
// const facetFilters = (params.facetFilters as string[][])[0]
// if only one tag is selected, keep the request as-is
if (facetFilters.length === 1) {
newRequests.push(request)
// // if only one tag is selected, keep the request as-is
// if (facetFilters.length === 1) {
// newRequests.push(request)
continue
}
// continue
// }
// if multiple tags are selected, split the tags
// to retrieve a small subset of results per each tag.
newRequests.push(
...facetFilters.map((tag) => {
// get the filter's details in case it has custom hitsPerPage
const filterDetails = searchFilters.find(
(item) => `_tags:${item.value}` === tag
)
return {
...request,
params: {
...params,
facetFilters: [tag],
},
hitsPerPage: filterDetails?.hitsPerPage || 3,
}
})
)
}
}
// // if multiple tags are selected, split the tags
// // to retrieve a small subset of results per each tag.
// newRequests.push(
// ...facetFilters.map((tag) => {
// // get the filter's details in case it has custom hitsPerPage
// const filterDetails = searchFilters.find(
// (item) => `_tags:${item.value}` === tag
// )
// return {
// ...request,
// params: {
// ...params,
// facetFilters: [tag],
// },
// hitsPerPage: filterDetails?.hitsPerPage || 3,
// }
// })
// )
// }
// }
return algoliaClient
.search<SearchHits>(newRequests)
.then((response) => {
if (newRequests.length === 1) {
return response
}
// combine results of the same index and return the results
const resultsByIndex: {
[indexName: string]: SearchResponse<SearchHits>
} = {}
// extract the response of the main request
const mainResult = response.results[0]
// return algoliaClient
// .search<ExpandedHits>(newRequests)
// .then((response) => {
// if (newRequests.length === 1) {
// return response
// }
// // combine results of the same index and return the results
// const resultsByIndex: {
// [indexName: string]: SearchResponse<ExpandedHits>
// } = {}
// // extract the response of the main request
// const mainResult = response.results[0]
response.results.forEach((result, indexNum) => {
if (indexNum === 0) {
// ignore the main request's result
return
}
const resultIndex = "index" in result ? result.index : undefined
const resultHits = "hits" in result ? result.hits : []
// response.results.forEach((result, indexNum) => {
// if (indexNum === 0) {
// // ignore the main request's result
// return
// }
// const resultIndex = "index" in result ? result.index : undefined
// const resultHits = "hits" in result ? result.hits : []
if (!resultIndex) {
return
}
// if (!resultIndex) {
// return
// }
resultsByIndex[resultIndex] = {
...result,
...(resultsByIndex[resultIndex] || {}),
hits: [
...(resultsByIndex[resultIndex]?.hits || []),
...resultHits,
],
nbHits:
(resultsByIndex[resultIndex]?.nbHits || 0) +
resultHits.length,
}
})
// resultsByIndex[resultIndex] = {
// ...result,
// ...(resultsByIndex[resultIndex] || {}),
// hits: [
// ...(resultsByIndex[resultIndex]?.hits || []),
// ...resultHits,
// ],
// nbHits:
// (resultsByIndex[resultIndex]?.nbHits || 0) +
// resultHits.length,
// }
// })
const newResults = Object.values(resultsByIndex).flatMap(
(result) => ({
...result,
hits: ("hits" in result ? result.hits : []).sort((a, b) => {
const typosA = a._rankingInfo?.nbTypos || 0
const typosB = b._rankingInfo?.nbTypos || 0
if (a.type === "lvl1" && typosA <= typosB) {
return -1
}
// const newResults = Object.values(resultsByIndex).flatMap(
// (result) => ({
// ...result,
// hits: ("hits" in result ? result.hits : []).sort((a, b) => {
// const typosA = a._rankingInfo?.nbTypos || 0
// const typosB = b._rankingInfo?.nbTypos || 0
// const tagASortOrder =
// searchFilters.find((item) =>
// a._tags.find((tag) => tag === item.value)
// )?.internalSortOrder || 0
// const tagBSortorder =
// searchFilters.find((item) =>
// b._tags.find((tag) => tag === item.value)
// )?.internalSortOrder || 0
// if (
// a.type === "lvl1" &&
// typosA <= typosB &&
// tagASortOrder >= tagBSortorder
// ) {
// return -1
// }
if (b.type === "lvl1" && typosB <= typosA) {
return 1
}
// if (
// b.type === "lvl1" &&
// typosB <= typosA &&
// tagBSortorder >= tagASortOrder
// ) {
// return 1
// }
return 0
}),
})
)
// return 0
// }),
// })
// )
return {
// append the results with the main request's results
results: [mainResult, ...newResults],
} as SearchResponses<any>
})
},
// return {
// // append the results with the main request's results
// results: [mainResult, ...newResults],
// } as SearchResponses<any>
// })
// },
}
}, [algolia.appId, algolia.apiKey])