@cloudflare/ai-search-snippet 0.0.17

package/dist/main.d.ts

@@ -0,0 +1,359 @@
+export declare class AISearchClient extends Client {
+    private request;
+    /**
+     * Performs a search query with optional streaming
+     */
+    search(query: string, options?: Omit<SearchOptions, 'query'>): Promise<SearchResult[]>;
+    searchStream(query: string, options?: SearchOptions): AsyncGenerator<SearchResult | SearchError, void, undefined>;
+    chat(query: string, options?: SearchOptions): AsyncGenerator<ChatTypes, void, undefined>;
+    /**
+     * Cancels an active request by ID
+     */
+    cancelRequest(requestId: string): void;
+    /**
+     * Cancels all active requests
+     */
+    cancelAllRequests(): void;
+    /**
+     * Register an active request
+     */
+    private registerRequest;
+    /**
+     * Unregister a completed request
+     */
+    private unregisterRequest;
+    /**
+     * Generate unique request ID
+     */
+    private generateRequestId;
+}
+
+/**
+ * API error structure
+ */
+export declare interface ApiError {
+    message: string;
+    code?: string;
+    status?: number;
+    details?: Record<string, unknown>;
+}
+
+export declare class ChatBubbleSnippet extends HTMLElement {
+    private shadow;
+    private client;
+    private chatView;
+    private container;
+    private isExpanded;
+    private isMinimized;
+    private handleBubbleClick;
+    private handleCloseClick;
+    private handleMinimizeClick;
+    private handleClearClick;
+    static get observedAttributes(): readonly ["api-url", "placeholder", "theme", "hide-branding"];
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
+    private getProps;
+    private initializeClient;
+    private render;
+    private getBubbleStyles;
+    private getBaseHTML;
+    private attachEventListeners;
+    private removeEventListeners;
+    private toggleChat;
+    private closeChat;
+    private toggleMinimize;
+    private initializeChatView;
+    private updateTheme;
+    private cleanup;
+    clearChat(): void;
+    sendMessage(content: string): Promise<void>;
+    getMessages(): Message[];
+}
+
+declare type ChatError = {
+    type: 'error';
+    message: string;
+};
+
+/**
+ * Chat options
+ */
+export declare interface ChatOptions {
+    stream?: boolean;
+    signal?: AbortSignal;
+}
+
+export declare class ChatPageSnippet extends HTMLElement {
+    private shadow;
+    private client;
+    private chatView;
+    private container;
+    private sessions;
+    private currentSessionId;
+    private sidebarCollapsed;
+    private handleClearClick;
+    private handleNewChatClick;
+    private handleToggleSidebarClick;
+    private handleChatListClick;
+    private handleMessageEvent;
+    static get observedAttributes(): readonly ["api-url", "placeholder", "theme", "hide-branding"];
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
+    private getProps;
+    private initializeClient;
+    private render;
+    private getPageStyles;
+    private getBaseHTML;
+    private attachEventListeners;
+    private removeEventListeners;
+    private setupView;
+    private generateSessionId;
+    private loadSessions;
+    private saveSessions;
+    private saveCurrentSession;
+    private updateSessionTitle;
+    private createNewChat;
+    private switchToSession;
+    private deleteSession;
+    private clearCurrentChat;
+    private toggleSidebar;
+    private onChatListClick;
+    private renderChatList;
+    private renderChatListItem;
+    private formatDate;
+    private escapeHTML;
+    private updateTheme;
+    private cleanup;
+    clearChat(): void;
+    sendMessage(content: string): Promise<void>;
+    getMessages(): Message[];
+    getSessions(): ChatSession[];
+    getCurrentSession(): ChatSession | null;
+}
+
+declare type ChatResult = {
+    id: string;
+    title: string;
+    description: string;
+    url?: string;
+    metadata?: Record<string, unknown>;
+    type: 'result';
+};
+
+declare interface ChatSession {
+    id: string;
+    title: string;
+    messages: Message[];
+    createdAt: number;
+    updatedAt: number;
+}
+
+declare type ChatTextResponse = {
+    type: 'text';
+    message: string;
+};
+
+declare type ChatTypes = ChatResult | ChatTextResponse | ChatError;
+
+declare class Client {
+    activeRequests: Map<string, RequestState>;
+    baseUrl: string;
+    constructor(baseUrl: string);
+    search(_query: string, _options?: SearchOptions): Promise<SearchResult[]>;
+    searchStream(_query: string, _options?: SearchOptions): AsyncGenerator<SearchResult | SearchError, void, undefined>;
+    chat(_message: string, _options?: SearchOptions): AsyncGenerator<ChatTypes, void, undefined>;
+    cancelRequest(_requestId: string): void;
+    cancelAllRequests(): void;
+}
+
+declare interface Message {
+    id: string;
+    role: 'user' | 'assistant' | 'system';
+    content: string;
+    timestamp: number;
+    metadata?: Record<string, unknown>;
+}
+
+/**
+ * Request state
+ */
+declare interface RequestState {
+    id: string;
+    controller: AbortController;
+    timestamp: number;
+}
+
+/**
+ * Search Bar Snippet
+ * A search bar with results display
+ */
+declare class SearchBarSnippet extends HTMLElement {
+    private shadow;
+    private client;
+    private container;
+    private inputElement;
+    private resultsContainer;
+    private searchButton;
+    private isLoading;
+    private currentQuery;
+    private debouncedSearch;
+    private handleInputChange;
+    private handleInputKeydownEnter;
+    private handleInputKeydownEscape;
+    private handleSearchButtonClick;
+    static get observedAttributes(): readonly ["api-url", "placeholder", "max-results", "debounce-ms", "theme", "hide-branding"];
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
+    private getProps;
+    private initializeClient;
+    private render;
+    private attachEventListeners;
+    private performSearch;
+    private displayResults;
+    private renderResult;
+    private renderResultImage;
+    private attachResultHandlers;
+    private showLoadingState;
+    private showEmptyState;
+    private showNoResultsState;
+    private showErrorState;
+    private updateTheme;
+    private cleanup;
+    search(query: string): Promise<void>;
+}
+export { SearchBarSnippet }
+export default SearchBarSnippet;
+
+declare interface SearchError {
+    type: 'error';
+    message: string;
+    code?: string;
+    status?: number;
+    details?: Record<string, unknown>;
+}
+
+export declare class SearchModalSnippet extends HTMLElement {
+    private shadow;
+    private client;
+    private backdrop;
+    private modal;
+    private inputElement;
+    private resultsContainer;
+    private footerCount;
+    private isOpen;
+    private isLoading;
+    private results;
+    private activeIndex;
+    private debouncedSearch;
+    private handleGlobalKeydown;
+    private handleInputChange;
+    private handleInputKeydown;
+    private handleBackdropClick;
+    private savedBodyStyles;
+    private savedHtmlOverflow;
+    static get observedAttributes(): readonly ["api-url", "placeholder", "max-results", "theme", "shortcut", "use-meta-key", "debounce-ms", "hide-branding"];
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
+    private getProps;
+    private initializeClient;
+    private render;
+    private attachGlobalKeyboardShortcut;
+    private attachEventListeners;
+    private navigateResults;
+    private updateActiveResult;
+    private selectActiveResult;
+    private performSearch;
+    private displayResults;
+    private renderResult;
+    private renderResultImage;
+    private attachResultHandlers;
+    private renderEmptyState;
+    private showEmptyState;
+    private showLoadingState;
+    private showNoResultsState;
+    private showErrorState;
+    private updateTheme;
+    private lockBodyScroll;
+    private unlockBodyScroll;
+    private cleanup;
+    /**
+     * Open the search modal
+     */
+    open(): void;
+    /**
+     * Close the search modal
+     */
+    close(): void;
+    /**
+     * Toggle the search modal open/closed
+     */
+    toggle(): void;
+    /**
+     * Perform a search programmatically
+     */
+    search(query: string): Promise<void>;
+    /**
+     * Get current search results
+     */
+    getResults(): SearchResult[];
+    /**
+     * Check if modal is currently open
+     */
+    isModalOpen(): boolean;
+}
+
+/**
+ * Search options
+ */
+export declare interface SearchOptions {
+    query?: string;
+    streaming?: boolean;
+    signal?: AbortSignal;
+    maxResults?: number;
+}
+
+/**
+ * Search result item structure
+ */
+export declare interface SearchResult {
+    id: string;
+    title: string;
+    description: string;
+    url?: string;
+    image?: string;
+    metadata?: Record<string, unknown>;
+    type: 'result';
+}
+
+/**
+ * Main component properties
+ */
+export declare interface SearchSnippetProps {
+    /** Required: AI Search API endpoint */
+    apiUrl: string;
+    /** Input placeholder text */
+    placeholder?: string;
+    /** Maximum search results to display (search-bar only) */
+    maxResults?: number;
+    /** Input debounce delay in milliseconds (search-bar only) */
+    debounceMs?: number;
+    /** Color scheme */
+    theme?: Theme;
+    /** Hide the "Powered by Cloudflare AI Search" branding */
+    hideBranding?: boolean;
+}
+
+/**
+ * Core type definitions for the Search Snippet Library
+ */
+export declare type Theme = 'light' | 'dark' | 'auto';
+
+export { }