@redocly/realm-plugin-asciidoc 0.1.0

package/src/search-facets.ts

@@ -0,0 +1,46 @@
+import type { SearchFacet } from '@redocly/theme';
+
+const SEARCH_GROUP_FIELD = 'redocly_category';
+const SEARCH_GROUP_NAME_DOCS = 'Documentation';
+
+export function setDocumentSearchFacets(
+  documentSearchFacets: Record<string, string | Set<string>>,
+  getSearchFacets: () => Map<string, SearchFacet>,
+  setSearchFacets: (searchFacets: Map<string, SearchFacet>) => void,
+): void {
+  const searchFacets = getSearchFacets();
+
+  for (const [key, value] of Object.entries(documentSearchFacets)) {
+    const facet = searchFacets.get(key);
+    if (facet) {
+      const facetValues = new Set((facet.values as string[]) ?? []);
+      if (value instanceof Set) {
+        [...value].forEach((v) => (facet.values = Array.from(facetValues.add(v))));
+      } else {
+        facet.values = Array.from(facetValues.add(value));
+      }
+    }
+  }
+
+  setSearchFacets(searchFacets);
+}
+
+export function extractDocumentSearchFacets(
+  metadata?: Record<string, unknown>,
+  getSearchFacets?: () => Map<string, SearchFacet>,
+): Record<string, string> {
+  const searchFacets: Record<string, string> = {
+    [SEARCH_GROUP_FIELD]: SEARCH_GROUP_NAME_DOCS,
+  };
+
+  if (!metadata || !getSearchFacets) return searchFacets;
+
+  const targetSearchFacets = getSearchFacets();
+
+  for (const [key, value] of Object.entries(metadata)) {
+    if (!targetSearchFacets.has(key)) continue;
+    searchFacets[key] = String(value);
+  }
+
+  return searchFacets;
+}

package/src/search-resolver.ts

@@ -0,0 +1,98 @@
+import { REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '@redocly/config';
+
+import type { PageRouteDetails, SearchDocument } from '@redocly/realm/dist/server/types';
+import type { SearchFacet } from '@redocly/theme';
+import type { AsciidocSection, AsciidocFrontmatter } from './types.js';
+
+import { extractDocumentSearchFacets, setDocumentSearchFacets } from './search-facets.js';
+
+export function searchResolver(
+  frontmatter: AsciidocFrontmatter,
+  relativePath: string,
+  sections: AsciidocSection[],
+  getSearchFacets: () => Map<string, SearchFacet>,
+  setSearchFacets: (searchFacets: Map<string, SearchFacet>) => void,
+): (route: PageRouteDetails, staticData: Record<string, unknown>) => Promise<SearchDocument[]> {
+  return async (route: PageRouteDetails, staticData: Record<string, unknown>) => {
+    if (frontmatter.excludeFromSearch) return [];
+
+    const metadata = route.metadata || {};
+    const facets = extractDocumentSearchFacets(metadata, getSearchFacets);
+    setDocumentSearchFacets(facets, getSearchFacets, setSearchFacets);
+
+    const pageTitle = frontmatter.seo?.title || frontmatter.title || relativePath;
+    const pageUrl = route.slug;
+    const teamsRbac = staticData[REDOCLY_TEAMS_RBAC] as { [key: string]: string } | undefined;
+    const routeRbac = staticData[REDOCLY_ROUTE_RBAC] as
+      | { slug?: string; fsPath?: string }
+      | undefined;
+
+    const searchDocuments: SearchDocument[] = [];
+
+    // Add the main page document
+    const allText = flattenSectionsText(sections);
+    searchDocuments.push({
+      id: pageUrl,
+      url: pageUrl,
+      title: pageTitle,
+      text: allText,
+      facets,
+      [REDOCLY_TEAMS_RBAC]: teamsRbac,
+      [REDOCLY_ROUTE_RBAC]: routeRbac,
+    });
+
+    // Add individual sections as search documents
+    for (const section of sections) {
+      addSectionDocuments(
+        section,
+        pageUrl,
+        pageTitle,
+        facets,
+        teamsRbac,
+        routeRbac,
+        searchDocuments,
+      );
+    }
+
+    return searchDocuments;
+  };
+}
+
+function addSectionDocuments(
+  section: AsciidocSection,
+  pageUrl: string,
+  pageTitle: string,
+  facets: Record<string, string>,
+  teamsRbac: { [key: string]: string } | undefined,
+  routeRbac: { slug?: string; fsPath?: string } | undefined,
+  documents: SearchDocument[],
+): void {
+  if (section.textContent) {
+    const sectionUrl = `${pageUrl}#${section.id}`;
+    documents.push({
+      id: sectionUrl,
+      url: sectionUrl,
+      title: section.title,
+      text: section.textContent,
+      path: [pageTitle, section.title],
+      facets,
+      [REDOCLY_TEAMS_RBAC]: teamsRbac,
+      [REDOCLY_ROUTE_RBAC]: routeRbac,
+    });
+  }
+
+  for (const child of section.children) {
+    addSectionDocuments(child, pageUrl, pageTitle, facets, teamsRbac, routeRbac, documents);
+  }
+}
+
+function flattenSectionsText(sections: AsciidocSection[]): string {
+  const parts: string[] = [];
+  for (const section of sections) {
+    if (section.textContent) parts.push(section.textContent);
+    if (section.children.length) {
+      parts.push(flattenSectionsText(section.children));
+    }
+  }
+  return parts.join('\n');
+}