Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

next
tsx 235 lines 8.52 KB
Raw
1 'use client';
2
3 import Link from 'next/link';
4 import { ArrowUpRight } from 'lucide-react';
5 import { usePostHog } from 'posthog-js/react';
6 import type {
7 KnowledgeSearchResponse,
8 KnowledgeSearchResult,
9 } from '@/lib/knowledge/search';
10 import { plainKnowledgeExcerpt } from '@/lib/knowledge/search';
11 import type { KnowledgeSourceType } from '@/lib/knowledge/types';
12 import { PRODUCT_AREAS } from '@/lib/knowledge/taxonomy';
13 import { getKnowledgeDisplayDescription } from '@/lib/knowledge/display';
14
15 interface KnowledgeSearchResultsProps {
16 query: string;
17 initialResponse: KnowledgeSearchResponse | null;
18 failed: boolean;
19 }
20
21 export function getHighlightedSegments(
22 text: string,
23 query: string,
24 ): Array<{ text: string; highlighted: boolean }> {
25 const terms = [...new Set(
26 query.toLowerCase().match(/[a-z0-9_-]{2,}/g) ?? [],
27 )].sort((left, right) => right.length - left.length);
28 if (terms.length === 0) return [{ text, highlighted: false }];
29
30 const pattern = new RegExp(`(${terms.join('|')})`, 'gi');
31 return text.split(pattern).filter(Boolean).map((segment) => ({
32 text: segment,
33 highlighted: terms.includes(segment.toLowerCase()),
34 }));
35 }
36
37 export function getKnowledgeSearchDisplayExcerpt(
38 excerpt: string,
39 section?: string | null,
40 ): string {
41 const displayExcerpt = plainKnowledgeExcerpt(getKnowledgeDisplayDescription(excerpt));
42 const sectionTitle = section ? plainKnowledgeExcerpt(section) : '';
43 if (!sectionTitle || !displayExcerpt.toLowerCase().startsWith(sectionTitle.toLowerCase())) {
44 return displayExcerpt;
45 }
46
47 const remainder = displayExcerpt.slice(sectionTitle.length);
48 if (!remainder) return '';
49 if (!/^[\s,:;–—-]/.test(remainder)) return displayExcerpt;
50
51 const hadLeadingWhitespace = /^\s/.test(remainder);
52 const trimmedRemainder = remainder.trimStart();
53 if (!hadLeadingWhitespace && /^-\S/.test(trimmedRemainder)) return displayExcerpt;
54
55 return trimmedRemainder
56 .replace(/^(?:[:,;]|[–—]|-\s*)/, '')
57 .trimStart();
58 }
59
60 function getKnowledgeSearchDisplaySection(
61 title: string,
62 section?: string | null,
63 ): string | null {
64 const sectionTitle = section ? plainKnowledgeExcerpt(section) : '';
65 const displaySection = sectionTitle.replace(/[,:;]+$/, '').trimEnd();
66 if (!displaySection || displaySection.toLowerCase() === title.trim().toLowerCase()) {
67 return null;
68 }
69
70 return displaySection;
71 }
72
73 export function getKnowledgeSearchSourceLabel(sourceType: KnowledgeSourceType): string {
74 switch (sourceType) {
75 case 'docs':
76 return 'Documentation';
77 case 'kb':
78 return 'Support';
79 case 'oauth-guide':
80 return 'OAuth';
81 case 'toolkit':
82 return 'Toolkit';
83 case 'example':
84 return 'Example';
85 case 'reference':
86 return 'API Reference';
87 case 'changelog':
88 return 'Changelog';
89 case 'legacy':
90 return 'Legacy API Reference';
91 }
92 }
93
94 export function KnowledgeSearchResultCard({
95 result,
96 query,
97 onClick,
98 }: {
99 result: KnowledgeSearchResult;
100 query: string;
101 onClick?: () => void;
102 }) {
103 const sourceLabel = getKnowledgeSearchSourceLabel(result.sourceType);
104 const displaySection = getKnowledgeSearchDisplaySection(result.title, result.section);
105 const displayExcerpt = getKnowledgeSearchDisplayExcerpt(result.excerpt, result.section);
106
107 return (
108 <a
109 href={result.canonicalUrl}
110 onClick={onClick}
111 className="group block border border-fd-border bg-fd-background p-5 transition-colors hover:border-fd-primary/40 hover:bg-fd-accent/30 focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-fd-ring"
112 >
113 <span className="text-xs font-medium uppercase tracking-wide text-fd-muted-foreground">
114 {sourceLabel}
115 </span>
116 <div className="flex items-start justify-between gap-4">
117 <h3 className="text-base font-semibold group-hover:text-fd-primary sm:text-lg">
118 {getHighlightedSegments(result.title, query).map((segment, segmentIndex) => (
119 segment.highlighted
120 ? <mark key={segmentIndex} className="bg-fd-primary/15 text-inherit">{segment.text}</mark>
121 : segment.text
122 ))}
123 </h3>
124 <ArrowUpRight className="mt-1 size-4 shrink-0 text-fd-muted-foreground" aria-hidden="true" />
125 </div>
126 {displaySection && (
127 <p className="mt-1 text-sm font-medium text-fd-foreground/80">
128 {getHighlightedSegments(displaySection, query).map((segment, segmentIndex) => (
129 segment.highlighted
130 ? <mark key={segmentIndex} className="bg-fd-primary/15 text-inherit">{segment.text}</mark>
131 : segment.text
132 ))}
133 </p>
134 )}
135 {displayExcerpt && (
136 <p className="mt-2 max-w-3xl text-sm leading-6 text-fd-muted-foreground">
137 {getHighlightedSegments(displayExcerpt, query).map((segment, segmentIndex) => (
138 segment.highlighted
139 ? <mark key={segmentIndex} className="bg-fd-primary/15 text-inherit">{segment.text}</mark>
140 : segment.text
141 ))}
142 </p>
143 )}
144 </a>
145 );
146 }
147
148 function RecoveryLinks() {
149 return (
150 <div className="mt-6 flex flex-wrap gap-3">
151 <Link href="/kb#support-topics" className="border border-fd-border px-3 py-2 text-sm font-medium hover:bg-fd-accent">
152 Browse support topics
153 </Link>
154 <Link href="/kb/toolkits" className="border border-fd-border px-3 py-2 text-sm font-medium hover:bg-fd-accent">
155 Browse toolkits
156 </Link>
157 </div>
158 );
159 }
160
161 export function KnowledgeSearchResults({
162 query,
163 initialResponse,
164 failed,
165 }: KnowledgeSearchResultsProps) {
166 const normalizedQuery = query.trim();
167 const posthog = usePostHog();
168 const state: 'idle' | 'ready' | 'error' = !normalizedQuery
169 ? 'idle'
170 : failed || initialResponse === null
171 ? 'error'
172 : 'ready';
173 const response = state === 'ready' ? initialResponse : null;
174
175 return (
176 <section aria-label="Knowledge search results">
177 <div aria-live="polite">
178 {!normalizedQuery && (
179 <div>
180 <h2 id="knowledge-results-heading" className="text-xl font-semibold">Start with a product area</h2>
181 <p className="mt-2 text-sm text-fd-muted-foreground">Search by product question, exact error, action slug, or toolkit name.</p>
182 <div className="mt-5 grid gap-3 sm:grid-cols-2 lg:grid-cols-3">
183 {PRODUCT_AREAS.filter((area) => area.defaultBrowse).map((area) => (
184 <Link key={area.slug} href={`/kb/topic/${area.slug}`} className="border border-fd-border p-4 hover:bg-fd-accent/50">
185 <span className="font-medium">{area.title}</span>
186 </Link>
187 ))}
188 </div>
189 </div>
190 )}
191
192 {state === 'error' && (
193 <div className="border border-fd-border bg-fd-muted/20 p-6">
194 <h2 id="knowledge-results-heading" className="text-lg font-semibold">Search is temporarily unavailable</h2>
195 <p className="mt-2 text-sm text-fd-muted-foreground">Browse the curated paths below while the search service recovers.</p>
196 <RecoveryLinks />
197 </div>
198 )}
199
200 {state === 'ready' && response?.results.length === 0 && (
201 <div className="border border-fd-border bg-fd-muted/20 p-6">
202 <h2 id="knowledge-results-heading" className="text-lg font-semibold">No results for “{query}”</h2>
203 <p className="mt-2 text-sm text-fd-muted-foreground">Try a shorter error phrase, action slug, or toolkit name.</p>
204 <RecoveryLinks />
205 </div>
206 )}
207
208 {state === 'ready' && response && response.results.length > 0 && (
209 <>
210 <div className="flex items-baseline justify-between gap-4">
211 <h2 id="knowledge-results-heading" className="text-xl font-semibold">Results for “{query}”</h2>
212 <span className="text-sm text-fd-muted-foreground">{response.total} results</span>
213 </div>
214 <ol className="mt-5 grid gap-3">
215 {response.results.map((result, index) => (
216 <li key={result.objectID}>
217 <KnowledgeSearchResultCard
218 result={result}
219 query={query}
220 onClick={() => posthog?.capture('kb_search_result_clicked', {
221 object_id: result.objectID,
222 displayed_position: index + 1,
223 retrieval_mode: response.mode ?? 'keyword',
224 source_type: result.sourceType,
225 })}
226 />
227 </li>
228 ))}
229 </ol>
230 </>
231 )}
232 </div>
233 </section>
234 );
235 }