algolia
blocksidepanel-askaisource: ok · hit
Sidepanel Ask AI
Sidepanel chat experience with Ask AI, powered by Algolia's Ask AI
npx shadcn add "https://sitesearch.algolia.com/r/sidepanel-askai.json"free
Where it goes
chat
Tags auto-generated by rules on 9/24/2026 — empty means no evidence, not lack of support.
Dependencies
Bundle weight · lighticonslucide-react
Registry dependencies
button
Files4 · source cached 10/8/2026, 10:50:36 PM
src/registry/experiences/sidepanel-askai/components/sidepanel-askai.tsx
/** biome-ignore-all lint/suspicious/noArrayIndexKey: . */
/** biome-ignore-all lint/a11y/useFocusableInteractive: hand crafted interactions */
/** biome-ignore-all lint/a11y/useSemanticElements: hand crafted interactions */
/** biome-ignore-all lint/a11y/noStaticElementInteractions: hand crafted interactions */
/** biome-ignore-all lint/a11y/useKeyWithClickEvents: hand crafted interactions */
"use client";
import type { UIMessage } from "@ai-sdk/react";
import type { UIDataTypes, UIMessagePart } from "ai";
import { liteClient } from "algoliasearch/lite";
import type { BaseHit, Hit } from "instantsearch.js";
import {
ArrowUpIcon,
BrainIcon,
CheckIcon,
CopyIcon,
Link2Icon,
Maximize2,
Minimize2,
Sparkles,
SquarePen,
ThumbsDown,
ThumbsUp,
XIcon,
} from "lucide-react";
import { marked, type Tokens } from "marked";
import type React from "react";
import {
type ComponentPropsWithoutRef,
type CSSProperties,
type FC,
memo,
useCallback,
useEffect,
useMemo,
useRef,
useState,
} from "react";
import { createPortal } from "react-dom";
import { Button } from "@/components/ui/button";
import { cn } from "@/lib/utils";
import {
isThreadDepthError,
postAgentStudioFeedback,
postFeedback,
threadDepthErrorDetail,
useAskai,
} from "@/registry/experiences/sidepanel-askai/hooks/use-askai";
import {
type SuggestedQuestionHit,
useSuggestedQuestions,
} from "@/registry/experiences/sidepanel-askai/hooks/use-suggested-questions";
// ============================================================================
// Types
// ============================================================================
export interface SidepanelAskAIConfig {
/** Algolia Application ID (required) */
applicationId: string;
/** Algolia API Key (required) */
apiKey: string;
/** Algolia Index Name (required) */
indexName: string;
/** AI Assistant ID (required for chat functionality) */
assistantId: string;
/** Suggested Questions Enabled (optional, defaults to false) */
suggestedQuestionsEnabled?: boolean;
/** Placeholder text for input (optional, defaults to "Ask AI anything about Algolia") */
placeholder?: string;
/** Custom button text (optional, defaults to "Ask AI") */
buttonText?: string;
/** Custom button props (optional) */
buttonProps?: React.ComponentProps<typeof Button>;
/** Display variant (optional, defaults to 'floating') */
variant?: "floating" | "inline";
/** Route Ask AI requests through Agent Studio endpoints (optional, defaults to false). */
agentStudio?: boolean;
}
export interface SearchIndexTool {
input: {
query: string;
};
output: {
query: string;
hits: Hit<BaseHit>[];
};
}
export type Message = UIMessage<
unknown,
UIDataTypes,
{
searchIndex: SearchIndexTool;
}
>;
export type AIMessagePart = UIMessagePart<
UIDataTypes,
{
searchIndex: SearchIndexTool;
}
>;
interface Exchange {
id: string;
userMessage: Message;
assistantMessage: Message | null;
}
interface ExtractedLink {
url: string;
title?: string;
}
// ============================================================================
// Utilities & Helpers
// ============================================================================
function useClipboard() {
const copyText = useCallback(async (text: string) => {
try {
await navigator.clipboard.writeText(text);
} catch {
// Silently fail - clipboard access might be blocked
}
}, []);
return { copyText };
}
function escapeHtml(html: string): string {
return html
.replace(/&/g, "&")
.replace(/</g, "<")
.replace(/>/g, ">")
.replace(/"/g, """)
.replace(/'/g, "'");
}
function decodeUrlForSchemeCheck(value: string): string {
let current = value;
for (let i = 0; i < 3; i += 1) {
try {
const decoded = decodeURIComponent(current);
if (decoded === current) {
break;
}
current = decoded;
} catch {
break;
}
}
return current;
}
function stripControlsAndWhitespace(value: string): string {
let result = "";
for (let i = 0; i < value.length; i += 1) {
const code = value.charCodeAt(i);
if (code > 0x20 && code !== 0x7f) {
result += value.charAt(i);
}
}
return result;
}
function sanitizeUrl(url: string | null | undefined): string {
if (!url) {
return "";
}
const trimmed = url.trim();
if (!trimmed) {
return "";
}
// Decode / strip controls for scheme checks only — return the original trimmed
// URL when safe so percent-encoding in the path/query is preserved.
const normalized = stripControlsAndWhitespace(
decodeUrlForSchemeCheck(trimmed),
).replace(/\\/g, "/");
if (!normalized) {
return "";
}
// Protocol-relative and backslash-obfuscated hosts (e.g. /\evil.com → //evil.com).
if (normalized.startsWith("//")) {
return "";
}
if (!/^[a-zA-Z][a-zA-Z0-9+.-]*:/.test(normalized)) {
return trimmed;
}
try {
const parsed = new URL(normalized);
if (
parsed.protocol === "http:" ||
parsed.protocol === "https:" ||
parsed.protocol === "mailto:"
) {
return trimmed;
}
} catch {
return "";
}
return "";
}
function extractLinksFromMessage(message: Message | null): ExtractedLink[] {
const links: ExtractedLink[] = [];
// Used to dedupe multiple urls
const seen = new Set<string>();
if (!message) {
return [];
}
message.parts.forEach((part) => {
if (part.type !== "text") {
return;
}
if (typeof part.text !== "string" || part.text.length === 0) {
return;
}
const markdownLinkRegex = /\[([^\]]*)\]\(([^)]+)\)/g;
const markdownImageRegex = /!\[([^\]]*)\]\(([^)]+)\)/g;
const plainLinkRegex = /(?<!\]\()https?:\/\/[^\s<>"{}|\\^`[\]]+/g;
// Strip out all code blocks e.g. ```
const textWithoutCodeBlocks = part.text.replace(/```[\s\S]*?```/g, "");
// Strip out all inline code blocks e.g. `
const cleanText = textWithoutCodeBlocks.replace(/`[^`]*`/g, "");
// Get all markdown image links to exclude them
const imageMatches = cleanText.matchAll(markdownImageRegex);
const imageUrls = new Set<string>();
for (const match of imageMatches) {
imageUrls.add(match[2]);
}
// Get all markdown based links e.g. []()
const markdownMatches = cleanText.matchAll(markdownLinkRegex);
// Parses the title and url from the found links
for (const match of markdownMatches) {
const title = match[1].trim();
const url = sanitizeUrl(match[2]);
// Skip image URLs
if (!url || imageUrls.has(url) || imageUrls.has(match[2])) {
continue;
}
if (!seen.has(url)) {
seen.add(url);
links.push({ url, title: title || undefined });
}
}
// Get all "plain" links e.g. https://algolia.com/doc
const plainUrls = cleanText.matchAll(plainLinkRegex);
for (const match of plainUrls) {
// Strip any extra punctuation
const cleanUrl = sanitizeUrl(match[0].replace(/[.,;:!?]+$/, ""));
// Skip image URLs
if (!cleanUrl || imageUrls.has(cleanUrl)) {
continue;
}
if (!seen.has(cleanUrl)) {
seen.add(cleanUrl);
links.push({ url: cleanUrl });
}
}
});
return links;
}
// ============================================================================
// Markdown Renderer
// ============================================================================
/* eslint-disable xss/no-mixed-html -- marked renderer: interpolations escaped/sanitized */
const markdownRenderer = new marked.Renderer();
markdownRenderer.code = ({ text, lang = "", escaped }: Tokens.Code): string => {
const safeLang = /^[a-zA-Z0-9_-]+$/.test(lang) ? lang : "";
const languageClass = safeLang ? `language-${safeLang}` : "";
const safeCode = escaped ? text : escapeHtml(text);
const encodedCode = encodeURIComponent(text);
const copyIconSvg = `
<svg class="markdown-copy-icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<rect x="9" y="9" width="13" height="13" rx="2" ry="2"></rect>
<path d="m5 15-4-4 4-4"></path>
</svg>
`;
const checkIconSvg = `
<svg class="markdown-check-icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<polyline points="20,6 9,17 4,12"></polyline>
</svg>
`;
return `
<div class="markdown-code-snippet">
<button class="markdown-copy-button" data-code="${encodedCode}" aria-label="Copy code to clipboard" title="Copy code">
${copyIconSvg}${checkIconSvg}
<span class="markdown-copy-label">Copy</span>
</button>
<pre><code class="${languageClass}">${safeCode}</code></pre>
</div>
`;
};
markdownRenderer.link = ({ href, title, text }: Tokens.Link): string => {
const safeHref = escapeHtml(sanitizeUrl(href));
const textEscaped = escapeHtml(text);
if (!safeHref) {
return textEscaped;
}
const titleAttr = title ? ' title="' + escapeHtml(title) + '"' : "";
// href/text/title are sanitized + escaped above.
return (
'<a href="' +
safeHref +
'" target="_blank" rel="noopener noreferrer"' +
titleAttr +
">" +
textEscaped +
"</a>"
); // nosemgrep
};
markdownRenderer.image = ({ href, title, text }: Tokens.Image): string => {
const safeHref = escapeHtml(sanitizeUrl(href));
if (!safeHref) {
return escapeHtml(text);
}
const titleAttr = title ? ' title="' + escapeHtml(title) + '"' : "";
// src/alt/title are sanitized + escaped above.
return (
'<img src="' +
safeHref +
'" alt="' +
escapeHtml(text) +
'"' +
titleAttr +
" />"
); // nosemgrep
};
markdownRenderer.html = ({ text }: Tokens.HTML | Tokens.Tag): string =>
escapeHtml(text);
/* eslint-enable xss/no-mixed-html */
// ============================================================================
// Icon Components
// ============================================================================
interface IconProps {
size?: number | string;
color?: string;
className?: string;
}
const AlgoliaLogo = ({ size = 150 }: IconProps) => (
<svg
width="80"
height="24"
aria-label="Algolia"
role="img"
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 2196.2 500"
style={{ maxWidth: size }}
>
<defs>
{/* eslint-disable-nextLine @docusaurus/no-untranslated-text */}
<style>{`.cls-1,.cls-2{fill:#003dff}.cls-2{fillRule:evenodd}`}</style>
</defs>
<path
className="cls-2"
d="M1070.38,275.3V5.91c0-3.63-3.24-6.39-6.82-5.83l-50.46,7.94c-2.87,.45-4.99,2.93-4.99,5.84l.17,273.22c0,12.92,0,92.7,95.97,95.49,3.33,.1,6.09-2.58,6.09-5.91v-40.78c0-2.96-2.19-5.51-5.12-5.84-34.85-4.01-34.85-47.57-34.85-54.72Z"
/>
<rect
className="cls-1"
x="1845.88"
y="104.73"
width="62.58"
height="277.9"
rx="5.9"
ry="5.9"
/>
<path
className="cls-2"
d="M1851.78,71.38h50.77c3.26,0,5.9-2.64,5.9-5.9V5.9c0-3.62-3.24-6.39-6.82-5.83l-50.77,7.95c-2.87,.45-4.99,2.92-4.99,5.83v51.62c0,3.26,2.64,5.9,5.9,5.9Z"
/>
<path
className="cls-2"
d="M1764.03,275.3V5.91c0-3.63-3.24-6.39-6.82-5.83l-50.46,7.94c-2.87,.45-4.99,2.93-4.99,5.84l.17,273.22c0,12.92,0,92.7,95.97,95.49,3.33,.1,6.09-2.58,6.09-5.91v-40.78c0-2.96-2.19-5.51-5.12-5.84-34.85-4.01-34.85-47.57-34.85-54.72Z"
/>
<path
className="cls-2"
d="M1631.95,142.72c-11.14-12.25-24.83-21.65-40.78-28.31-15.92-6.53-33.26-9.85-52.07-9.85-18.78,0-36.15,3.17-51.92,9.85-15.59,6.66-29.29,16.05-40.76,28.31-11.47,12.23-20.38,26.87-26.76,44.03-6.38,17.17-9.24,37.37-9.24,58.36,0,20.99,3.19,36.87,9.55,54.21,6.38,17.32,15.14,32.11,26.45,44.36,11.29,12.23,24.83,21.62,40.6,28.46,15.77,6.83,40.12,10.33,52.4,10.48,12.25,0,36.78-3.82,52.7-10.48,15.92-6.68,29.46-16.23,40.78-28.46,11.29-12.25,20.05-27.04,26.25-44.36,6.22-17.34,9.24-33.22,9.24-54.21,0-20.99-3.34-41.19-10.03-58.36-6.38-17.17-15.14-31.8-26.43-44.03Zm-44.43,163.75c-11.47,15.75-27.56,23.7-48.09,23.7-20.55,0-36.63-7.8-48.1-23.7-11.47-15.75-17.21-34.01-17.21-61.2,0-26.89,5.59-49.14,17.06-64.87,11.45-15.75,27.54-23.52,48.07-23.52,20.55,0,36.63,7.78,48.09,23.52,11.47,15.57,17.36,37.98,17.36,64.87,0,27.19-5.72,45.3-17.19,61.2Z"
/>
<path
className="cls-2"
d="M894.42,104.73h-49.33c-48.36,0-90.91,25.48-115.75,64.1-14.52,22.58-22.99,49.63-22.99,78.73,0,44.89,20.13,84.92,51.59,111.1,2.93,2.6,6.05,4.98,9.31,7.14,12.86,8.49,28.11,13.47,44.52,13.47,1.23,0,2.46-.03,3.68-.09,.36-.02,.71-.05,1.07-.07,.87-.05,1.75-.11,2.62-.2,.34-.03,.68-.08,1.02-.12,.91-.1,1.82-.21,2.73-.34,.21-.03,.42-.07,.63-.1,32.89-5.07,61.56-30.82,70.9-62.81v57.83c0,3.26,2.64,5.9,5.9,5.9h50.42c3.26,0,5.9-2.64,5.9-5.9V110.63c0-3.26-2.64-5.9-5.9-5.9h-56.32Zm0,206.92c-12.2,10.16-27.97,13.98-44.84,15.12-.16,.01-.33,.03-.49,.04-1.12,.07-2.24,.1-3.36,.1-42.24,0-77.12-35.89-77.12-79.37,0-10.25,1.96-20.01,5.42-28.98,11.22-29.12,38.77-49.74,71.06-49.74h49.33v142.83Z"
/>
<path
className="cls-2"
d="M2133.97,104.73h-49.33c-48.36,0-90.91,25.48-115.75,64.1-14.52,22.58-22.99,49.63-22.99,78.73,0,44.89,20.13,84.92,51.59,111.1,2.93,2.6,6.05,4.98,9.31,7.14,12.86,8.49,28.11,13.47,44.52,13.47,1.23,0,2.46-.03,3.68-.09,.36-.02,.71-.05,1.07-.07,.87-.05,1.75-.11,2.62-.2,.34-.03,.68-.08,1.02-.12,.91-.1,1.82-.21,2.73-.34,.21-.03,.42-.07,.63-.1,32.89-5.07,61.56-30.82,70.9-62.81v57.83c0,3.26,2.64,5.9,5.9,5.9h50.42c3.26,0,5.9-2.64,5.9-5.9V110.63c0-3.26-2.64-5.9-5.9-5.9h-56.32Zm0,206.92c-12.2,10.16-27.97,13.98-44.84,15.12-.16,.01-.33,.03-.49,.04-1.12,.07-2.24,.1-3.36,.1-42.24,0-77.12-35.89-77.12-79.37,0-10.25,1.96-20.01,5.42-28.98,11.22-29.12,38.77-49.74,71.06-49.74h49.33v142.83Z"
/>
<path
className="cls-2"
d="M1314.05,104.73h-49.33c-48.36,0-90.91,25.48-115.75,64.1-11.79,18.34-19.6,39.64-22.11,62.59-.58,5.3-.88,10.68-.88,16.14s.31,11.15,.93,16.59c4.28,38.09,23.14,71.61,50.66,94.52,2.93,2.6,6.05,4.98,9.31,7.14,12.86,8.49,28.11,13.47,44.52,13.47h0c17.99,0,34.61-5.93,48.16-15.97,16.29-11.58,28.88-28.54,34.48-47.75v50.26h-.11v11.08c0,21.84-5.71,38.27-17.34,49.36-11.61,11.08-31.04,16.63-58.25,16.63-11.12,0-28.79-.59-46.6-2.41-2.83-.29-5.46,1.5-6.27,4.22l-12.78,43.11c-1.02,3.46,1.27,7.02,4.83,7.53,21.52,3.08,42.52,4.68,54.65,4.68,48.91,0,85.16-10.75,108.89-32.21,21.48-19.41,33.15-48.89,35.2-88.52V110.63c0-3.26-2.64-5.9-5.9-5.9h-56.32Zm0,64.1s.65,139.13,0,143.36c-12.08,9.77-27.11,13.59-43.49,14.7-.16,.01-.33,.03-.49,.04-1.12,.07-2.24,.1-3.36,.1-1.32,0-2.63-.03-3.94-.1-40.41-2.11-74.52-37.26-74.52-79.38,0-10.25,1.96-20.01,5.42-28.98,11.22-29.12,38.77-49.74,71.06-49.74h49.33Z"
/>
<path
className="cls-1"
d="M249.83,0C113.3,0,2,110.09,.03,246.16c-2,138.19,110.12,252.7,248.33,253.5,42.68,.25,83.79-10.19,120.3-30.03,3.56-1.93,4.11-6.83,1.08-9.51l-23.38-20.72c-4.75-4.21-11.51-5.4-17.36-2.92-25.48,10.84-53.17,16.38-81.71,16.03-111.68-1.37-201.91-94.29-200.13-205.96,1.76-110.26,92-199.41,202.67-199.41h202.69V407.41l-115-102.18c-3.72-3.31-9.42-2.66-12.42,1.31-18.46,24.44-48.53,39.64-81.93,37.34-46.33-3.2-83.87-40.5-87.34-86.81-4.15-55.24,39.63-101.52,94-101.52,49.18,0,89.68,37.85,93.91,85.95,.38,4.28,2.31,8.27,5.52,11.12l29.95,26.55c3.4,3.01,8.79,1.17,9.63-3.3,2.16-11.55,2.92-23.58,2.07-35.92-4.82-70.34-61.8-126.93-132.17-131.26-80.68-4.97-148.13,58.14-150.27,137.25-2.09,77.1,61.08,143.56,138.19,145.26,32.19,.71,62.03-9.41,86.14-26.95l150.26,133.2c6.44,5.71,16.61,1.14,16.61-7.47V9.48C499.66,4.25,495.42,0,490.18,0H249.83Z"
/>
</svg>
);
// ============================================================================
// UI Helper Components
// ============================================================================
export interface AnimatedShinyTextProps
extends ComponentPropsWithoutRef<"span"> {
shimmerWidth?: number;
}
export const AnimatedShinyText: FC<AnimatedShinyTextProps> = ({
children,
shimmerWidth = 100,
...props
}) => {
return (
<span
style={
{
"--shiny-width": `${shimmerWidth}px`,
} as CSSProperties
}
className="text-neutral-600/70 dark:text-neutral-400/70 animate-shiny-text [background-size:var(--shiny-width)_100%] bg-clip-text [background-position:0_0] bg-no-repeat [transition:background-position_1s_cubic-bezier(.6,.6,0,1)_infinite] bg-gradient-to-r from-transparent via-black/80 via-50% to-transparent dark:via-white/80"
{...props}
>
{children}
</span>
);
};
// ============================================================================
// Markdown Component
// ============================================================================
interface MemoizedMarkdownProps {
children: string;
className?: string;
}
const MemoizedMarkdown = memo(function MemoizedMarkdown({
children,
className = "",
}: MemoizedMarkdownProps) {
const containerRef = useRef<HTMLDivElement>(null);
const html = useMemo(() => {
try {
return marked(children, {
renderer: markdownRenderer,
breaks: true,
gfm: true,
});
} catch (error) {
console.error("Error parsing markdown:", error);
return escapeHtml(children);
}
}, [children]);
// biome-ignore lint/correctness/useExhaustiveDependencies: expected
useEffect(() => {
const container = containerRef.current;
if (!container) return;
const handleCopyClick = async (event: Event) => {
const target = event.target as HTMLElement;
const button = target.closest(
".markdown-copy-button",
) as HTMLButtonElement;
if (!button) return;
event.preventDefault();
event.stopPropagation();
const encodedCode = button.getAttribute("data-code");
if (!encodedCode) return;
try {
const code = decodeURIComponent(encodedCode);
await navigator.clipboard.writeText(code);
button.classList.add("markdown-copied");
setTimeout(() => {
button.classList.remove("markdown-copied");
}, 2000);
} catch (error) {
console.error("Failed to copy code:", error);
}
};
container.addEventListener("click", handleCopyClick);
return () => {
container.removeEventListener("click", handleCopyClick);
};
}, [html]);
return (
<div
ref={containerRef}
className={`text-foreground [word-break:break-word] leading-relaxed max-w-none flex flex-col word [&_h1]:font-semibold [&_h1]:leading-tight [&_h1]:mb-2 [&_h1]:text-foreground [&_h1]:text-2xl [&_h1]:border-b [&_h1]:border-border [&_h1]:pb-2
[&_h2]:font-semibold [&_h2]:leading-tight [&_h2]:mb-2 [&_h2]:text-foreground [&_h2]:text-xl
[&_h3]:font-semibold [&_h3]:leading-tight [&_h3]:mb-2 [&_h3]:text-foreground [&_h3]:text-lg
[&_h4]:font-semibold [&_h4]:leading-tight [&_h4]:mb-2 [&_h4]:text-foreground [&_h4]:text-base
[&_h5]:font-semibold [&_h5]:leading-tight [&_h5]:mb-2 [&_h5]:text-foreground [&_h5]:text-base
[&_h6]:font-semibold [&_h6]:leading-tight [&_h6]:mb-2 [&_h6]:text-foreground [&_h6]:text-base
[&_p]:p-0 [&_p]:my-2 [&_p:last-child]:mb-0
[&_a]:text-blue-600 [&_a]:no-underline [&_a]:border-b [&_a]:border-transparent [&_a]:transition-all [&_a]:duration-200 [&_a:hover]:border-blue-600 [&_a:hover]:bg-blue-50 dark:[&_a:hover]:bg-slate-900
[&_ul]:ps-6 [&_ul]:mt-0 [&_ul]:mb-0 [&_ul]:list-disc
[&_ol]:ps-6 [&_ol]:mt-0 [&_ol]:mb-0 [&_ol]:list-decimal
[&_li]:mb-1 [&_li::marker]:text-muted-foreground
[&_ul_ul]:mb-0 [&_ul_ul]:mt-1 [&_ol_ol]:mb-0 [&_ol_ol]:mt-1 [&_ul_ol]:mb-0 [&_ul_ol]:mt-1 [&_ol_ul]:mb-0 [&_ol_ul]:mt-1
[&_code:not(.markdown-code-snippet_code)]:bg-muted [&_code:not(.markdown-code-snippet_code)]:text-foreground [&_code:not(.markdown-code-snippet_code)]:text-sm [&_code:not(.markdown-code-snippet_code)]:font-mono [&_code:not(.markdown-code-snippet_code)]:px-1 [&_code:not(.markdown-code-snippet_code)]:py-0.5 [&_code:not(.markdown-code-snippet_code)]:rounded [&_code:not(.markdown-code-snippet_code)]:border [&_code:not(.markdown-code-snippet_code)]:border-border
[&_.markdown-code-snippet]:relative [&_.markdown-code-snippet]:my-4 [&_.markdown-code-snippet]:rounded-lg [&_.markdown-code-snippet]:overflow-hidden [&_.markdown-code-snippet]:border [&_.markdown-code-snippet]:border-border [&_.markdown-code-snippet]:bg-muted
[&_.markdown-code-snippet_pre]:m-0 [&_.markdown-code-snippet_pre]:p-4 [&_.markdown-code-snippet_pre]:overflow-x-auto [&_.markdown-code-snippet_pre]:text-sm [&_.markdown-code-snippet_pre]:leading-normal [&_.markdown-code-snippet_pre]:font-mono [&_.markdown-code-snippet_pre]:bg-transparent
[&_.markdown-code-snippet_code]:bg-transparent [&_.markdown-code-snippet_code]:text-foreground [&_.markdown-code-snippet_code]:p-0 [&_.markdown-code-snippet_code]:border-none
[&_.markdown-copy-button]:absolute [&_.markdown-copy-button]:top-2 [&_.markdown-copy-button]:right-2 [&_.markdown-copy-button]:flex [&_.markdown-copy-button]:items-center [&_.markdown-copy-button]:gap-1 [&_.markdown-copy-button]:px-3 [&_.markdown-copy-button]:py-1.5 [&_.markdown-copy-button]:bg-background [&_.markdown-copy-button]:border [&_.markdown-copy-button]:border-border [&_.markdown-copy-button]:rounded-md [&_.markdown-copy-button]:text-xs [&_.markdown-copy-button]:cursor-pointer [&_.markdown-copy-button]:transition-all [&_.markdown-copy-button]:duration-200 [&_.markdown-copy-button]:text-foreground [&_.markdown-copy-button]:opacity-0 [&_.markdown-copy-button]:-translate-y-1
[&_.markdown-code-snippet:hover_.markdown-copy-button]:opacity-100 [&_.markdown-code-snippet:hover_.markdown-copy-button]:translate-y-0
[&_.markdown-copy-button:hover]:bg-blue-50 dark:[&_.markdown-copy-button:hover]:bg-slate-900 [&_.markdown-copy-button:hover]:shadow-sm
[&_.markdown-copy-button_.markdown-check-icon]:hidden
[&_.markdown-copy-button.markdown-copied_.markdown-copy-icon]:hidden
[&_.markdown-copy-button.markdown-copied_.markdown-check-icon]:block
[&_.markdown-copy-button.markdown-copied]:text-green-600 [&_.markdown-copy-button.markdown-copied]:border-green-600
[&_.markdown-copy-label]:font-medium
[&_.markdown-copied_.markdown-copy-label]:after:content-['ed']
[&_table]:w-full [&_table]:border-collapse [&_table]:text-sm [&_table]:bg-background [&_table]:my-4 [&_table]:rounded-lg [&_table]:border [&_table]:border-border [&_table]:overflow-hidden
[&_thead]:bg-muted
[&_th]:px-4 [&_th]:py-3 [&_th]:text-left [&_th]:font-semibold [&_th]:text-foreground [&_th]:border-b-2 [&_th]:border-border
[&_td]:px-4 [&_td]:py-3 [&_td]:border-b [&_td]:border-border [&_td]:text-foreground
[&_tr:last-child_td]:border-b-0
[&_tbody_tr:hover]:bg-blue-50 dark:[&_tbody_tr:hover]:bg-slate-900
[&_blockquote]:border-l-4 [&_blockquote]:border-blue-600 [&_blockquote]:my-4 [&_blockquote]:py-2 [&_blockquote]:px-4 [&_blockquote]:bg-blue-50 [&_blockquote]:text-foreground [&_blockquote]:italic
[&_blockquote_p]:mb-2 [&_blockquote_p:last-child]:mb-0
[&_strong]:font-semibold [&_strong]:text-foreground
[&_em]:italic
[&_hr]:border-none [&_hr]:border-t [&_hr]:border-border [&_hr]:my-6
[&_img]:max-w-full [&_img]:h-auto [&_img]:rounded-md [&_img]:my-2
${className}`.trim()}
// eslint-disable-next-line xss/no-mixed-html -- sanitized marked output
// biome-ignore lint/security/noDangerouslySetInnerHtml: HTML escaped via marked renderer (html/link/image)
dangerouslySetInnerHTML={{ __html: html }}
/>
);
});
// ============================================================================
// Related Sources Component
// ============================================================================
interface RelatedSourcesProps {
links: ExtractedLink[];
}
const RelatedSources = memo(function RelatedSources({
links,
}: RelatedSourcesProps) {
if (links.length === 0) {
return null;
}
return (
<div className="mt-4 pt-4 border-t border-border">
<h3 className="text-xs font-medium text-muted-foreground mb-3">
Related sources
</h3>
<div className="flex flex-wrap gap-2">
{links.map((link, index) => {
const displayText = link.title || link.url;
return (
<a
key={`${link.url}-${index}`}
href={link.url}
target="_blank"
rel="noopener noreferrer"
className="inline-flex items-center gap-1 px-3 py-1.5 text-xs font-medium rounded-md border border-border bg-background text-foreground hover:bg-blue-50 dark:hover:bg-slate-900 hover:border-blue-600 transition-colors duration-200 no-underline"
>
<Link2Icon className="shrink-0" size={16} />
<span>{displayText}</span>
</a>
);
})}
</div>
</div>
);
});
// ============================================================================
// Thread Depth Error Banner Component
// ============================================================================
interface ThreadDepthErrorBannerProps {
onNewChat: () => void;
detailMessage?: string;
}
const ThreadDepthErrorBanner = ({
onNewChat,
detailMessage,
}: ThreadDepthErrorBannerProps) => (
<div className="text-gray-900 text-sm leading-normal">
{detailMessage ? (
<p className="m-0 mb-2 font-semibold text-foreground">{detailMessage}</p>
) : null}
<p className="m-0">
<button
type="button"
className="text-blue-600 underline font-normal cursor-pointer bg-transparent border-none p-0 hover:text-blue-800 focus:outline-2 focus:outline-blue-600 focus:outline-offset-2 focus:rounded-sm"
onClick={onNewChat}
>
Start a new conversation
</button>{" "}
to continue.
</p>
</div>
);
// ============================================================================
// Chat Component
// ============================================================================
interface ChatWidgetProps {
messages: Message[];
error: Error | null;
isGenerating: boolean;
onCopy?: (text: string) => Promise<void> | void;
onThumbsUp?: (userMessageId: string) => Promise<void> | void;
onThumbsDown?: (userMessageId: string) => Promise<void> | void;
applicationId: string;
apiKey?: string;
assistantId: string;
agentStudio?: boolean;
suggestedQuestions: SuggestedQuestionHit[];
onSuggestedQuestionClick: (question: string) => void;
onNewChat?: () => void;
}
const ChatWidget = memo(function ChatWidget({
messages,
error,
isGenerating,
onCopy,
onThumbsUp,
onThumbsDown,
applicationId,
apiKey,
assistantId,
agentStudio,
suggestedQuestions,
onSuggestedQuestionClick,
onNewChat,
}: ChatWidgetProps) {
const { copyText } = useClipboard();
const [copiedExchangeId, setCopiedExchangeId] = useState<string | null>(null);
const copyResetTimeoutRef = useRef<number | null>(null);
const [acknowledgedExchangeIds, setAcknowledgedExchangeIds] = useState<
Set<string>
>(new Set());
const [submittingExchangeId, setSubmittingExchangeId] = useState<
string | null
>(null);
const handleFeedback = async (exchange: Exchange, vote: 0 | 1) => {
if (!exchange.assistantMessage) return;
const customHandler = vote === 1 ? onThumbsUp : onThumbsDown;
try {
setSubmittingExchangeId(exchange.id);
if (customHandler) {
await customHandler(exchange.userMessage.id);
} else if (agentStudio) {
if (apiKey) {
await postAgentStudioFeedback({
agentId: assistantId,
vote,
messageId: exchange.assistantMessage.id,
appId: applicationId,
apiKey,
});
}
} else {
await postFeedback({
assistantId,
appId: applicationId,
messageId: exchange.userMessage.id,
thumbs: vote,
});
}
setAcknowledgedExchangeIds((prev) => {
const next = new Set(prev);
next.add(exchange.id);
return next;
});
} catch {
// ignore errors
} finally {
setSubmittingExchangeId(null);
}
};
const messagesEndRef = useRef<HTMLDivElement>(null);
// Group messages into exchanges (user + assistant pairs)
const exchanges = useMemo(() => {
const grouped: Exchange[] = [];
for (let i = 0; i < messages.length; i++) {
const current = messages[i];
if (current.role === "user") {
const userMessage = current as Message;
const nextMessage = messages[i + 1];
if (nextMessage?.role === "assistant") {
grouped.push({
id: userMessage.id,
userMessage,
assistantMessage: nextMessage as Message,
});
i++; // Skip the assistant message since we've already processed it
} else {
// No assistant yet – show a pending exchange immediately
grouped.push({
id: userMessage.id,
userMessage,
assistantMessage: null,
});
}
}
}
return grouped;
}, [messages]);
// Auto-scroll to bottom when new messages arrive
// biome-ignore lint/correctness/useExhaustiveDependencies: scroll on message changes
useEffect(() => {
messagesEndRef.current?.scrollIntoView({ behavior: "smooth" });
}, [exchanges.length, isGenerating]);
// Cleanup any pending reset timers on unmount
useEffect(() => {
return () => {
if (copyResetTimeoutRef.current) {
window.clearTimeout(copyResetTimeoutRef.current);
}
};
}, []);
return (
<div className="flex flex-col h-full overflow-y-auto p-4 bg-muted">
<div className="flex flex-col gap-4">
{exchanges.length === 0 && (
<div className="flex flex-col gap-4 py-8">
<h2 className="text-2xl font-semibold text-foreground">
How can I help you today?
</h2>
<p className="text-muted-foreground">
I search through your content to help you find answers to your
questions, fast.
</p>
{suggestedQuestions.length > 0 && (
<div className="flex flex-wrap gap-2">
{suggestedQuestions.map((question) => (
<Button
key={question.objectID}
type="button"
variant="outline"
className="cursor-pointer text-left"
onClick={() => onSuggestedQuestionClick(question.question)}
>
{question.question}
</Button>
))}
</div>
)}
</div>
)}
{/* errors */}
{error && (
<div className="border border-red-300 bg-red-100 text-red-900 px-4 py-3 rounded-lg">
{isThreadDepthError(error) && onNewChat ? (
<ThreadDepthErrorBanner
onNewChat={onNewChat}
detailMessage={threadDepthErrorDetail(error)}
/>
) : (
error.message
)}
</div>
)}
{/* exchanges */}
{exchanges.map((exchange) => {
const isLastExchange =
exchanges[exchanges.length - 1]?.id === exchange.id;
return (
<article key={exchange.id} className="rounded-sm bg-background p-4">
<div className="flex items-start gap-3">
<div className="font-semibold text-xl text-foreground mb-2">
{exchange.userMessage.parts.map((part, index) =>
part.type === "text" ? (
<span key={index}>{part.text}</span>
) : null,
)}
</div>
</div>
<div className="mt-3 flex items-start gap-3">
<div className="flex-1 gap-3">
{exchange.assistantMessage ? (
<>
<div className="text-foreground">
{exchange.assistantMessage.parts.map((part, index) => {
if (typeof part === "string") {
return <p key={`${index}`}>{part}</p>;
}
if (part.type === "text") {
return (
<MemoizedMarkdown key={`${index}`}>
{part.text}
</MemoizedMarkdown>
);
} else if (
part.type === "reasoning" &&
part.state === "streaming"
) {
return (
<p
className="text-[0.95rem] flex my-2 gap-2 items-center text-muted-foreground"
key={`${index}`}
>
<BrainIcon />{" "}
<AnimatedShinyText>
Reasoning...
</AnimatedShinyText>
</p>
);
} else if (part.type === "tool-searchIndex") {
if (part.state === "input-streaming") {
return (
<p
className="text-[0.95rem] flex my-2 gap-2 items-center text-muted-foreground"
key={`${index}`}
>
<AnimatedShinyText>
Searching...
</AnimatedShinyText>
</p>
);
} else if (part.state === "input-available") {
return (
<p
className="text-[0.95rem] flex my-2 gap-2 items-center text-muted-foreground"
key={`${index}`}
>
<AnimatedShinyText>
Looking for{" "}
<mark className="bg-transparent text-muted-foreground underline decoration-2 underline-offset-4">
"{part.input?.query || ""}"
</mark>
</AnimatedShinyText>
</p>
);
} else if (part.state === "output-available") {
return (
<p
className="text-[0.95rem] flex my-2 gap-2 items-center text-muted-foreground"
key={`${index}`}
>
<span>
Searched for{" "}
<mark className="bg-transparent text-muted-foreground underline decoration-1 underline-offset-4">
"{part.output?.query}"
</mark>{" "}
found{" "}
{Array.isArray(part.output?.hits)
? part.output.hits.length
: "no"}{" "}
results
</span>
</p>
);
} else if (part.state === "output-error") {
return (
<p
className="text-[0.95rem] flex my-2 gap-2 items-center text-muted-foreground"
key={`${index}`}
>
{part.errorText}
</p>
);
} else {
return null;
}
} else {
return null;
}
})}
</div>
{
<RelatedSources
links={extractLinksFromMessage(
exchange.assistantMessage,
)}
/>
}
</>
) : (
<div className="text-muted-foreground">
<AnimatedShinyText>
{isGenerating && isLastExchange ? "Thinking..." : ""}
</AnimatedShinyText>
</div>
)}
</div>
</div>
{exchange.assistantMessage && !isGenerating ? (
<div className="mt-4 flex items-center justify-start gap-2">
{acknowledgedExchangeIds.has(exchange.id) ? (
<span className="text-muted-foreground text-[0.85rem] animate-in fade-in slide-in-from-bottom-1">
Thanks for your feedback!
</span>
) : submittingExchangeId === exchange.id ? (
<span className="text-muted-foreground text-[0.85rem] shimmer-text">
Submitting...
</span>
) : (
<div className="inline-flex items-center gap-2">
<button
type="button"
title="Like"
aria-label="Like"
className="border-none bg-transparent rounded-md px-2.5 py-1.5 text-muted-foreground cursor-pointer flex items-center justify-center gap-2 transition-all duration-150 hover:bg-blue-50 dark:hover:bg-slate-900 disabled:text-foreground disabled:cursor-not-allowed"
disabled={
!exchange.assistantMessage ||
submittingExchangeId === exchange.id
}
onClick={() => handleFeedback(exchange, 1)}
>
<ThumbsUp size={18} />
</button>
<button
type="button"
title="Dislike"
aria-label="Dislike"
className="border-none bg-transparent rounded-md px-2.5 py-1.5 text-muted-foreground cursor-pointer flex items-center justify-center gap-2 transition-all duration-150 hover:bg-blue-50 dark:hover:bg-slate-900 disabled:text-foreground disabled:cursor-not-allowed"
disabled={
!exchange.assistantMessage ||
submittingExchangeId === exchange.id
}
onClick={() => handleFeedback(exchange, 0)}
>
<ThumbsDown size={18} />
</button>
</div>
)}
<button
type="button"
className={`border-none bg-transparent rounded-md px-2.5 py-1.5 text-muted-foreground cursor-pointer flex items-center justify-center gap-2 transition-all duration-150 hover:bg-blue-50 dark:hover:bg-slate-900 disabled:text-foreground disabled:cursor-not-allowed ${
copiedExchangeId === exchange.id
? "bg-blue-50 dark:bg-slate-900 text-blue-600 -translate-y-px"
: ""
}`}
aria-label={
copiedExchangeId === exchange.id
? "Copied"
: "Copy answer"
}
title={
copiedExchangeId === exchange.id
? "Copied"
: "Copy answer"
}
disabled={
!exchange.assistantMessage ||
copiedExchangeId === exchange.id
}
onClick={async () => {
const parts = exchange.assistantMessage?.parts ?? [];
const textContent = parts
.flatMap((part) =>
part.type === "text" ? [part.text] : [],
)
.join("")
.trim();
if (!textContent) return;
try {
if (onCopy) {
await onCopy(textContent);
} else {
await copyText(textContent);
}
setCopiedExchangeId(exchange.id);
if (copyResetTimeoutRef.current) {
window.clearTimeout(copyResetTimeoutRef.current);
}
copyResetTimeoutRef.current = window.setTimeout(() => {
setCopiedExchangeId(null);
}, 1500);
} catch {
// noop – copy may fail silently
}
}}
>
{copiedExchangeId === exchange.id ? (
<CheckIcon size={18} />
) : (
<CopyIcon size={18} />
)}
</button>
</div>
) : null}
</article>
);
})}
<div ref={messagesEndRef} />
</div>
</div>
);
});
// ============================================================================
// Sidepanel Component
// ============================================================================
interface SidepanelProps {
isOpen: boolean;
onClose: () => void;
config: SidepanelAskAIConfig;
messages: Message[];
error: Error | null;
isGenerating: boolean;
suggestedQuestions: SuggestedQuestionHit[];
sendMessage: (options: { text: string }) => void | Promise<void>;
inputRef: React.RefObject<HTMLTextAreaElement | null>;
onOpenNewConversation: () => void;
}
const MAX_PROMPT_ROWS = 20;
const Sidepanel = memo(function Sidepanel({
isOpen,
onClose,
config,
messages,
error,
isGenerating,
suggestedQuestions,
sendMessage,
inputRef,
onOpenNewConversation,
}: SidepanelProps) {
const [inputValue, setInputValue] = useState("");
const [shouldRender, setShouldRender] = useState(false);
const [isVisible, setIsVisible] = useState(false);
const [isMaximized, setIsMaximized] = useState(false);
const variant = config.variant || "floating";
// Handle mount/unmount and closing animation
useEffect(() => {
if (isOpen) {
setShouldRender(true);
// allow initial render before animating in
requestAnimationFrame(() => {
setIsVisible(true);
});
// Focus input when opening
setTimeout(() => {
inputRef.current?.focus();
}, 100);
} else if (shouldRender) {
// Start closing animation
setIsVisible(false);
// Unmount after animation completes
const timer = setTimeout(() => {
setShouldRender(false);
}, 200); // Match transition duration
return () => clearTimeout(timer);
}
}, [isOpen, shouldRender, inputRef]);
useEffect(() => {
const handleEscape = (event: KeyboardEvent) => {
if (event.key === "Escape" && isOpen) {
onClose();
}
};
if (isOpen) {
document.addEventListener("keydown", handleEscape);
}
return () => {
document.removeEventListener("keydown", handleEscape);
};
}, [isOpen, onClose]);
// Inline variant: push page content by adjusting body padding-right on desktop
useEffect(() => {
if (variant !== "inline") return;
if (typeof window === "undefined") return;
const isDesktop = window.matchMedia("(min-width: 768px)").matches;
const panelWidth = isMaximized ? 580 : 360;
if (isOpen && isDesktop) {
const prevPadding = document.body.style.paddingRight;
const prevTransition = document.body.style.transition;
document.body.style.transition =
"padding-right 0.28s cubic-bezier(0.22, 1, 0.36, 1)";
document.body.style.paddingRight = `${panelWidth}px`;
return () => {
document.body.style.paddingRight = prevPadding;
document.body.style.transition = prevTransition;
};
}
return;
}, [variant, isOpen, isMaximized]);
const managePromptHeight = useCallback((): void => {
if (!inputRef.current) return;
const textArea = inputRef.current;
textArea.style.height = "auto";
const styles = getComputedStyle(textArea);
const lineHeight = parseFloat(styles.lineHeight);
const paddingTop = parseFloat(styles.paddingTop);
const paddingBottom = parseFloat(styles.paddingBottom);
const padding = paddingTop + paddingBottom;
const fullHeight = textArea.scrollHeight;
const maxHeight = MAX_PROMPT_ROWS * lineHeight + padding;
textArea.style.overflowY = fullHeight > maxHeight ? "auto" : "hidden";
textArea.style.height = `${Math.min(fullHeight, maxHeight)}px`;
}, [inputRef]);
const sendMessageAndReset = useCallback(
(text: string) => {
const trimmed = text.trim();
if (!trimmed || isGenerating) return;
sendMessage({ text: trimmed });
setInputValue("");
// Reset textarea height after clearing input
setTimeout(() => {
managePromptHeight();
inputRef.current?.focus();
}, 50);
},
[isGenerating, sendMessage, inputRef, managePromptHeight],
);
const handleSubmit = useCallback(
(e?: React.FormEvent) => {
e?.preventDefault();
sendMessageAndReset(inputValue);
},
[inputValue, sendMessageAndReset],
);
const handleSuggestedQuestionClick = useCallback(
(question: string) => {
sendMessageAndReset(question);
},
[sendMessageAndReset],
);
const resizeSidepanel = useCallback(() => {
setIsMaximized((prev) => !prev);
}, []);
if (!shouldRender) return null;
const basePoweredByUrl =
"https://www.algolia.com/developers?utm_medium=referral&utm_content=powered_by&utm_campaign=sitesearch";
const poweredByHref =
typeof window !== "undefined"
? `${basePoweredByUrl}&utm_source=${encodeURIComponent(window.location.hostname)}`
: basePoweredByUrl;
return createPortal(
<div
className={`fixed inset-0 z-50 ${
variant === "inline"
? "bg-transparent dark:bg-transparent md:p-0"
: "bg-black/20 dark:bg-black/60 md:p-4"
} flex items-center justify-end pointer-events-none ${
isVisible ? "animate-in fade-in-0" : "animate-out fade-out-0"
}`}
style={{ animationDuration: "0.2s" }}
>
<div
className={`bg-background h-screen w-full md:h-full flex flex-col pointer-events-auto transition-all duration-300 ease-out ${variant === "inline" ? "rounded-none border-l border-border" : "md:rounded-lg shadow-2xl"} ${
isVisible
? "animate-in slide-in-from-right"
: "animate-out slide-out-to-right"
} ${isMaximized ? "md:w-[580px]" : "md:w-[360px]"}`}
onClick={(e) => e.stopPropagation()}
style={{
animationDuration: "0.28s",
animationTimingFunction: "cubic-bezier(0.22, 1, 0.36, 1)",
animationFillMode: "both",
}}
>
{/* Header */}
<div className="flex items-center justify-between px-4 py-2 border-b border-border">
<div className="flex items-center gap-2 min-w-0">
<Sparkles
className="h-[18px] w-[18px] shrink-0 text-blue-600 dark:text-blue-500"
strokeWidth={2}
aria-hidden
/>
<h2 className="text-sm font-semibold text-foreground">Ask AI</h2>
</div>
<div className="flex items-center gap-2">
<Button
variant="ghost"
onClick={onOpenNewConversation}
disabled={messages.length === 0}
className="px-1 text-muted-foreground disabled:cursor-not-allowed"
aria-label="Open new conversation"
title="Open new conversation"
>
<SquarePen size={18} />
</Button>
<Button
variant="ghost"
onClick={resizeSidepanel}
className="hidden md:flex px-1 cursor-pointer text-muted-foreground"
aria-label={isMaximized ? "Minimize" : "Maximize"}
title={isMaximized ? "Minimize" : "Maximize"}
>
{isMaximized ? <Minimize2 size={18} /> : <Maximize2 size={18} />}
</Button>
<Button
variant="ghost"
className="px-1 text-xs text-muted-foreground cursor-pointer"
onClick={onClose}
aria-label="Close"
title="Close"
>
<span className="hidden md:inline">
<XIcon size={18} />
</span>
<span className="md:hidden">
<XIcon />
</span>
</Button>
</div>
</div>
{/* Chat Content */}
<ChatWidget
messages={messages}
error={error}
isGenerating={isGenerating}
applicationId={config.applicationId}
apiKey={config.apiKey}
assistantId={config.assistantId}
agentStudio={config.agentStudio}
suggestedQuestions={suggestedQuestions}
onSuggestedQuestionClick={handleSuggestedQuestionClick}
onNewChat={onOpenNewConversation}
/>
{/* Input Bar — match search-askai composer (primary border + rule above footer). */}
<div className="border-t border-border px-4 pb-4 pt-2">
<form
onSubmit={handleSubmit}
className={cn(
"flex items-center gap-2 rounded-lg border border-blue-600 py-1.5 pl-2 pr-1.5 transition-all dark:border-blue-500",
"focus-within:ring-1 focus-within:ring-blue-600 focus-within:ring-offset-0 dark:focus-within:ring-blue-500",
)}
>
<textarea
ref={inputRef}
value={inputValue}
id="sidepanel-input"
onChange={(e) => {
setInputValue(e.target.value);
}}
onKeyDown={(e) => {
if (e.key === "Enter" && !e.shiftKey) {
e.preventDefault();
handleSubmit();
}
}}
onInput={managePromptHeight}
rows={1}
placeholder={config.placeholder || "Ask AI anything"}
disabled={isGenerating}
className="flex-1 border-none bg-background py-0.5 leading-tight text-foreground outline-none placeholder:text-muted-foreground focus:border-transparent focus:outline-none focus:ring-0 disabled:cursor-not-allowed disabled:opacity-50 resize-none overflow-y-hidden"
/>
<Button
type="submit"
variant="secondary"
size="icon"
className="h-10 w-10 shrink-0 text-muted-foreground hover:bg-muted/80 hover:text-foreground"
disabled={!inputValue.trim() || isGenerating}
title="Send message"
aria-label="Send message"
>
<ArrowUpIcon size={22} strokeWidth={2.25} />
</Button>
</form>
<div className="mt-2 flex items-start justify-start text-xs text-muted-foreground">
<p className="m-0 w-full text-left">
Answers are generated with AI which can make mistakes.
</p>
</div>
<div className="mt-2 flex items-center justify-end">
<a
className="inline-flex items-center gap-2 text-muted-foreground text-xs no-underline transition-colors hover:text-blue-600"
href={poweredByHref}
target="_blank"
rel="noopener noreferrer"
>
<span className="hidden sm:inline">Powered by </span>
<AlgoliaLogo size={80} />
</a>
</div>
</div>
</div>
</div>,
document.body,
);
});
// ============================================================================
// Main Export Component
// ============================================================================
export default function SidepanelExperience(config: SidepanelAskAIConfig) {
const [isOpen, setIsOpen] = useState(false);
const inputRef = useRef<HTMLTextAreaElement | null>(null);
const searchClient = useMemo(() => {
const client = liteClient(config.applicationId, config.apiKey);
client.addAlgoliaAgent("algolia-sitesearch");
return client;
}, [config.applicationId, config.apiKey]);
const { messages, startNewConversation, error, isGenerating, sendMessage } =
useAskai({
applicationId: config.applicationId,
apiKey: config.apiKey,
indexName: config.indexName,
assistantId: config.assistantId,
agentStudio: config.agentStudio,
});
const suggestedQuestions = useSuggestedQuestions({
searchClient,
assistantId: config.assistantId,
suggestedQuestionsEnabled: config.suggestedQuestionsEnabled ?? false,
isOpen,
});
// Keyboard shortcut: Command+I (Mac) or Ctrl+I (Windows)
useEffect(() => {
const handleKeyDown = (event: KeyboardEvent) => {
const isModifierPressed = event.metaKey || event.ctrlKey;
if (isModifierPressed && event.key.toLowerCase() === "i") {
event.preventDefault();
setIsOpen((prev) => !prev);
}
};
document.addEventListener("keydown", handleKeyDown);
return () => document.removeEventListener("keydown", handleKeyDown);
}, []);
const openSidepanel = () => setIsOpen(true);
const closeSidepanel = () => setIsOpen(false);
const openNewConversation = () => {
startNewConversation();
setIsOpen(true);
};
const buttonProps = {
...config.buttonProps,
onClick: openSidepanel,
};
const [modifierLabel, setModifierLabel] = useState("⌘");
const [isModifierPressed, setIsModifierPressed] = useState(false);
const [isIPressed, setIsIPressed] = useState(false);
useEffect(() => {
if (typeof navigator === "undefined") return;
const isMac = /(Mac|iPhone|iPod|iPad)/i.test(navigator.platform);
setModifierLabel(isMac ? "⌘" : "Ctrl");
}, []);
useEffect(() => {
const handleKeyDown = (event: KeyboardEvent) => {
if (event.metaKey || event.ctrlKey) setIsModifierPressed(true);
if (event.key.toLowerCase() === "i") setIsIPressed(true);
};
const handleKeyUp = (event: KeyboardEvent) => {
if (!event.metaKey && !event.ctrlKey) setIsModifierPressed(false);
if (event.key.toLowerCase() === "i") setIsIPressed(false);
};
const resetKeys = () => {
setIsModifierPressed(false);
setIsIPressed(false);
};
document.addEventListener("keydown", handleKeyDown);
document.addEventListener("keyup", handleKeyUp);
window.addEventListener("blur", resetKeys);
return () => {
document.removeEventListener("keydown", handleKeyDown);
document.removeEventListener("keyup", handleKeyUp);
window.removeEventListener("blur", resetKeys);
};
}, []);
const baseClassName =
"justify-between hover:shadow-md transition-transform duration-400 translate-y-0 py-3 h-auto cursor-pointer hover:bg-transparent hover:translate-y-[-2px] border shadow-none";
return (
<>
<Button
{...buttonProps}
variant="outline"
className={cn(baseClassName, buttonProps.className)}
>
<span className="flex items-center gap-2 opacity-80">
<span className="inline text-muted-foreground">
{config.buttonText || "Ask AI"}
</span>
</span>
<div className="hidden md:flex gap-0.5">
<kbd
className={`h-5 min-w-5 rounded grid place-items-center bg-muted text-xs text-muted-foreground transition-all duration-200 ${
isModifierPressed
? "inset-shadow-sm inset-shadow-foreground/30"
: "shadow-none"
}`}
>
{modifierLabel}
</kbd>
<kbd
className={`h-5 min-w-5 rounded grid place-items-center bg-muted text-xs text-muted-foreground transition-all duration-200 ${
isIPressed
? "inset-shadow-sm inset-shadow-foreground/30"
: "shadow-none"
}`}
>
I
</kbd>
</div>
</Button>
<Sidepanel
isOpen={isOpen}
onClose={closeSidepanel}
config={config}
messages={messages as unknown as Message[]}
error={error as Error | null}
isGenerating={isGenerating}
suggestedQuestions={suggestedQuestions}
sendMessage={sendMessage}
inputRef={inputRef}
onOpenNewConversation={openNewConversation}
/>
</>
);
}
src/registry/experiences/sidepanel-askai/hooks/use-askai.ts
import { useChat } from "@ai-sdk/react";
import {
DefaultChatTransport,
generateId,
lastAssistantMessageIsCompleteWithToolCalls,
} from "ai";
import { useCallback, useMemo, useRef, useState } from "react";
export interface AskAIConfig {
applicationId: string;
apiKey: string;
indexName: string;
assistantId: string;
agentStudio?: boolean;
}
/**
* Checks if an error is a thread depth error (AI-217)
* Thread depth errors occur when a conversation has reached its maximum depth limit
*/
export function isThreadDepthError(error?: Error | null): boolean {
if (!error) return false;
// Check if error has a code property
const errorWithCode = error as Error & { code?: string };
if (errorWithCode.code === "AI-217") return true;
// Check message content for AI-217 or thread depth references
const message = error.message?.toLowerCase() || "";
if (message.includes("ai-217") || message.includes("conversation depth")) {
return true;
}
try {
const parsed = JSON.parse(error.message) as {
code?: string;
message?: string;
};
if (
typeof parsed.code === "string" &&
parsed.code.toUpperCase() === "AI-217"
) {
return true;
}
const nested = (parsed.message ?? "").toLowerCase();
return nested.includes("ai-217") || nested.includes("conversation depth");
} catch {
return false;
}
}
function threadDepthRawMessage(error: unknown): string {
if (!error) return "";
if (error instanceof Error) return (error.message ?? "").trim();
if (
typeof error === "object" &&
error !== null &&
"message" in error &&
typeof (error as { message: unknown }).message === "string"
) {
return (error as { message: string }).message.trim();
}
return "";
}
/** Plain or JSON `{"message":"…"}` body from the API for thread-depth errors. */
export function threadDepthErrorDetail(error?: unknown): string | undefined {
if (!isThreadDepthError(error as Error | null)) return undefined;
const raw = threadDepthRawMessage(error);
if (!raw) return undefined;
try {
const parsed = JSON.parse(raw) as { message?: string };
if (typeof parsed.message === "string" && parsed.message.trim()) {
return parsed.message.trim();
}
} catch {
// not JSON
}
return raw;
}
const BASE_ASKAI_URL = "https://askai.algolia.com";
const agentStudioBaseUrl = (appId: string): string =>
`https://${appId}.algolia.net/agent-studio/1`;
function getChatApiUrl(config: AskAIConfig): string {
if (config.agentStudio) {
return `${agentStudioBaseUrl(config.applicationId)}/agents/${config.assistantId}/completions?stream=true&compatibilityMode=ai-sdk-5`;
}
return `${BASE_ASKAI_URL}/chat`;
}
export function useAskai(config: AskAIConfig) {
if (!config) {
throw new Error("config is required for useAskai");
}
const [chatId, setChatId] = useState(() => generateId());
const transport = useMemo(() => {
return new DefaultChatTransport({
api: getChatApiUrl(config),
headers: async () => {
if (config.agentStudio) {
return {
"x-algolia-api-key": config.apiKey,
"x-algolia-application-id": config.applicationId,
} as Record<string, string>;
}
const token = await getValidToken({ assistantId: config.assistantId });
return {
"x-algolia-api-key": config.apiKey,
"x-algolia-application-id": config.applicationId,
"x-algolia-index-name": config.indexName,
"x-algolia-assistant-id": config.assistantId,
"x-ai-sdk-version": "v5",
authorization: `TOKEN ${token}`,
} as Record<string, string>;
},
});
}, [
config.apiKey,
config.applicationId,
config.indexName,
config.assistantId,
config.agentStudio,
config,
]);
const chat = useChat({
id: chatId,
transport,
sendAutomaticallyWhen: lastAssistantMessageIsCompleteWithToolCalls,
});
const chatRef = useRef(chat);
chatRef.current = chat;
const startNewConversation = useCallback(() => {
chatRef.current.stop();
chatRef.current.clearError();
setChatId(generateId());
}, []);
const isGenerating =
chat.status === "submitted" || chat.status === "streaming";
// Check if there's a thread depth error (AI-217)
const hasThreadDepthError = useMemo(() => {
return (
chat.status === "error" && isThreadDepthError(chat.error as Error | null)
);
}, [chat.status, chat.error]);
return {
...chat,
startNewConversation,
isGenerating,
hasThreadDepthError,
};
}
const TOKEN_KEY = "askai_token";
type TokenPayload = { exp: number };
const decode = (token: string): TokenPayload => {
const [b64] = token.split(".");
return JSON.parse(atob(b64));
};
const isExpired = (token?: string | null): boolean => {
if (!token) return true;
try {
const { exp } = decode(token);
// refresh 30 s before the backend rejects it
return Date.now() / 1000 > exp - 30;
} catch {
return true;
}
};
let inflight: Promise<string> | null = null;
// call /token once, cache the promise while it’s running
// eslint-disable-next-line require-await
export const getValidToken = async ({
assistantId,
}: {
assistantId: string;
}): Promise<string> => {
const cached = sessionStorage.getItem(TOKEN_KEY);
if (!isExpired(cached)) return cached as string;
if (!inflight) {
inflight = fetch(`${BASE_ASKAI_URL}/chat/token`, {
method: "POST",
headers: {
"x-algolia-assistant-id": assistantId,
"content-type": "application/json",
},
})
.then((r) => r.json())
.then(({ token }) => {
sessionStorage.setItem(TOKEN_KEY, token);
return token;
})
.finally(() => {
inflight = null;
});
}
return inflight;
};
export const postAgentStudioFeedback = ({
agentId,
vote,
messageId,
appId,
apiKey,
}: {
agentId: string;
vote: 0 | 1;
messageId: string;
appId: string;
apiKey: string;
}): Promise<Response> => {
const headers = new Headers();
headers.set("x-algolia-application-id", appId);
headers.set("x-algolia-api-key", apiKey);
headers.set("content-type", "application/json");
const baseUrl = `${agentStudioBaseUrl(appId)}/feedback`;
return fetch(baseUrl, {
method: "POST",
body: JSON.stringify({
messageId,
agentId,
vote,
}),
headers,
});
};
export const postFeedback = async ({
assistantId,
thumbs,
messageId,
appId,
}: {
assistantId: string;
thumbs: 0 | 1;
messageId: string;
appId: string;
}): Promise<Response> => {
const headers = new Headers();
headers.set("x-algolia-assistant-id", assistantId);
headers.set("content-type", "application/json");
const token = await getValidToken({ assistantId });
headers.set("authorization", `TOKEN ${token}`);
return fetch(`${BASE_ASKAI_URL}/chat/feedback`, {
method: "POST",
body: JSON.stringify({
appId,
messageId,
thumbs,
}),
headers,
});
};
src/registry/experiences/sidepanel-askai/hooks/use-suggested-questions.ts
import type { Hit, LiteClient, SearchResponse } from "algoliasearch/lite";
import { useEffect, useRef, useState } from "react";
export const SUGGESTED_QUETIONS_INDEX_NAME =
"algolia_ask_ai_suggested_questions";
type SuggestedQuestion = {
appId: string;
assistantId: string;
question: string;
locale?: string;
state: "published";
source: string;
order: number;
};
export type SuggestedQuestionHit = Hit<SuggestedQuestion>;
type UseSuggestedQuestionsProps = {
assistantId: string | null;
suggestedQuestionsEnabled?: boolean;
searchClient: LiteClient;
isOpen?: boolean;
};
export const useSuggestedQuestions = ({
assistantId,
suggestedQuestionsEnabled = false,
searchClient,
isOpen = false,
}: UseSuggestedQuestionsProps): SuggestedQuestionHit[] => {
const [suggestedQuestions, setSuggestedQuestions] = useState<
SuggestedQuestionHit[]
>([]);
const hasFetchedRef = useRef(false);
useEffect(() => {
// Only fetch once when sidepanel opens
if (hasFetchedRef.current || !isOpen) {
return;
}
const getSuggestedQuestions = async (): Promise<void> => {
if (!suggestedQuestionsEnabled || !assistantId || assistantId === "") {
return;
}
try {
const { results } = await searchClient.search<SuggestedQuestion>({
requests: [
{
indexName: SUGGESTED_QUETIONS_INDEX_NAME,
filters: `state:published AND assistantId:${assistantId}`,
hitsPerPage: 3,
},
],
});
const result = results[0] as SearchResponse<SuggestedQuestion>;
setSuggestedQuestions(result.hits);
hasFetchedRef.current = true;
} catch (error) {
console.error("Failed to fetch suggested questions:", error);
}
};
getSuggestedQuestions();
}, [suggestedQuestionsEnabled, assistantId, isOpen, searchClient]);
return suggestedQuestions;
};
src/registry/experiences/sidepanel-askai/page.tsx
"use client";
import SidepanelExperience from "@/registry/experiences/sidepanel-askai/components/sidepanel-askai";
export default function Page() {
return (
<div className="flex items-center justify-center min-h-[100px] md:min-h-[400px] relative p-4">
<SidepanelExperience
applicationId="06YAZFOHSQ"
apiKey="94b6afdc316917b6e6cdf2763fa561df"
indexName="algolia_podcast_sample_dataset"
assistantId="UpR727VnXnoG"
/>
</div>
);
}