@seqera/docusaurus-theme-seqera 1.0.29 → 1.0.30-next.99

package/lib/theme/SearchBar/index.d.ts

@@ -5,6 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  *
  * Swizzled from docusaurus-theme-search-typesense SearchBar.
- * Adds full hierarchy breadcrumbs to the path shown under each modal result.
+ * Adds full hierarchy breadcrumbs and product labels to the path shown
+ * under each modal result. Product routes are configured via
+ * themeConfig.typesense.productRoutes.
  */
 export default function SearchBar(): JSX.Element;

package/lib/theme/SearchBar/index.js

@@ -5,7 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  *
  * Swizzled from docusaurus-theme-search-typesense SearchBar.
- * Adds full hierarchy breadcrumbs to the path shown under each modal result.
+ * Adds full hierarchy breadcrumbs and product labels to the path shown
+ * under each modal result. Product routes are configured via
+ * themeConfig.typesense.productRoutes.
  */
 import React, {useState, useRef, useCallback, useMemo} from 'react';
 // @ts-ignore
@@ -50,12 +52,22 @@ function ResultsFooter({state, onClose}) {
     </Link>
   );
 }
+/**
+ * Resolve a product label from a URL pathname using the configured productRoutes.
+ */
+function getProductLabel(pathname, productRoutes) {
+  const match = productRoutes.find(([prefix]) => pathname.startsWith(prefix));
+  return match ? match[1] : null;
+}
 /**
  * Build a breadcrumb string from all ancestor hierarchy levels of a hit.
  * For lvl2+ and content hits this replaces the single-level hierarchy.lvl1
  * path with the full parent chain (e.g. "Nextflow › Getting Started › Installation").
+ *
+ * When productRoutes are provided, the first level (lvl0, typically "Documentation")
+ * is replaced with the product name derived from the hit URL.
  */
-function buildBreadcrumb(item) {
+function buildBreadcrumb(item, productRoutes) {
   const {type} = item;
   const maxLevel =
     type === 'content' ? 7 : parseInt(type.replace('lvl', ''), 10);
@@ -64,9 +76,26 @@ function buildBreadcrumb(item) {
     const val = item[`hierarchy.lvl${i}`];
     if (val) parts.push(val);
   }
+  // Replace lvl0 (typically "Documentation") with the product label
+  if (parts.length > 0 && productRoutes.length > 0) {
+    try {
+      const pathname = new URL(item.url).pathname;
+      const product = getProductLabel(pathname, productRoutes);
+      if (product) {
+        parts[0] = product;
+      }
+    } catch {
+      // URL parsing failed — keep the original lvl0 value
+    }
+  }
   return parts.length > 1 ? parts.join(' › ') : null;
 }
-function DocSearch({contextualSearch, externalUrlRegex, ...props}) {
+function DocSearch({
+  contextualSearch,
+  externalUrlRegex,
+  productRoutes = [],
+  ...props
+}) {
   const contextualSearchFacetFilters = useTypesenseContextualFilters();
   const configFacetFilters = props.typesenseSearchParameters?.filter_by ?? '';
   const facetFilters = contextualSearch
@@ -144,7 +173,7 @@ function DocSearch({contextualSearch, externalUrlRegex, ...props}) {
           };
       // Overwrite hierarchy.lvl1 with the full ancestor breadcrumb so the
       // DocSearch-Hit-path slot shows the complete path for lvl2+ results.
-      const breadcrumb = buildBreadcrumb(withRelativeUrl);
+      const breadcrumb = buildBreadcrumb(withRelativeUrl, productRoutes);
       if (!breadcrumb) return withRelativeUrl;
       return {
         ...withRelativeUrl,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seqera/docusaurus-theme-seqera",
-  "version": "1.0.29",
+  "version": "1.0.30-next.99",
   "description": "Seqera docs theme for Docusaurus",
   "author": "Seqera docs team <education@seqera.io>",
   "license": "Apache-2.0",

package/src/theme/SearchBar/index.tsx

@@ -5,7 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  *
  * Swizzled from docusaurus-theme-search-typesense SearchBar.
- * Adds full hierarchy breadcrumbs to the path shown under each modal result.
+ * Adds full hierarchy breadcrumbs and product labels to the path shown
+ * under each modal result. Product routes are configured via
+ * themeConfig.typesense.productRoutes.
  */
 
 import React, {useState, useRef, useCallback, useMemo} from 'react';
@@ -48,6 +50,7 @@ type DocSearchProps = Omit<
   contextualSearch?: string;
   externalUrlRegex?: string;
   searchPagePath: boolean | string;
+  productRoutes?: [string, string, string | null, string | null][];
 };
 
 let DocSearchModal: typeof DocSearchModalType | null = null;
@@ -86,13 +89,30 @@ function ResultsFooter({state, onClose}: ResultsFooterProps) {
   );
 }
 
+/**
+ * Resolve a product label from a URL pathname using the configured productRoutes.
+ */
+function getProductLabel(
+  pathname: string,
+  productRoutes: [string, string, string | null, string | null][],
+): string | null {
+  const match = productRoutes.find(([prefix]) =>
+    pathname.startsWith(prefix),
+  );
+  return match ? match[1] : null;
+}
+
 /**
  * Build a breadcrumb string from all ancestor hierarchy levels of a hit.
  * For lvl2+ and content hits this replaces the single-level hierarchy.lvl1
  * path with the full parent chain (e.g. "Nextflow › Getting Started › Installation").
+ *
+ * When productRoutes are provided, the first level (lvl0, typically "Documentation")
+ * is replaced with the product name derived from the hit URL.
  */
 function buildBreadcrumb(
   item: InternalDocSearchHit | StoredDocSearchHit,
+  productRoutes: [string, string, string | null, string | null][],
 ): string | null {
   const {type} = item;
   const maxLevel =
@@ -106,12 +126,26 @@ function buildBreadcrumb(
     if (val) parts.push(val);
   }
 
+  // Replace lvl0 (typically "Documentation") with the product label
+  if (parts.length > 0 && productRoutes.length > 0) {
+    try {
+      const pathname = new URL(item.url).pathname;
+      const product = getProductLabel(pathname, productRoutes);
+      if (product) {
+        parts[0] = product;
+      }
+    } catch {
+      // URL parsing failed — keep the original lvl0 value
+    }
+  }
+
   return parts.length > 1 ? parts.join(' › ') : null;
 }
 
 function DocSearch({
   contextualSearch,
   externalUrlRegex,
+  productRoutes = [],
   ...props
 }: DocSearchProps) {
   const contextualSearchFacetFilters =
@@ -207,7 +241,7 @@ function DocSearch({
 
         // Overwrite hierarchy.lvl1 with the full ancestor breadcrumb so the
         // DocSearch-Hit-path slot shows the complete path for lvl2+ results.
-        const breadcrumb = buildBreadcrumb(withRelativeUrl);
+        const breadcrumb = buildBreadcrumb(withRelativeUrl, productRoutes);
         if (!breadcrumb) return withRelativeUrl;
 
         return {