@brainfish-ai/components 0.13.6 → 0.13.8

package/dist/lib/addUtmParams.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Adds UTM parameters to a URL for tracking purposes.
+ *
+ * @param url The URL to add UTM parameters to
+ * @param options UTM parameters to add (all optional)
+ * @param options.source The UTM source (e.g., 'brainfish')
+ * @param options.medium The UTM medium (e.g., 'popup_widget')
+ * @param options.campaign Optional UTM campaign parameter
+ * @returns The URL with UTM parameters added
+ */
+export declare function addUtmParameters(url: string, options: {
+    source?: string;
+    medium?: string;
+    campaign?: string;
+}): string;
+/**
+ * Curried function that adds popup widget-specific UTM parameters to URLs.
+ * Uses 'brainfish' as source and 'popup_widget' as medium.
+ */
+export declare const addPopupWidgetUtm: (url: string) => string;

package/dist/lib/api.d.ts

@@ -0,0 +1,96 @@
+import { SearchResponse, FeedbackResponse, APIFeedbackResponse, SearchResult, ActionInputs, ClientExecutionResult, SearchQueryAttributes } from '../components/chat-search/types';
+export declare function searchApi({ endpoint, query, collectionId, headers, conversationId, attributes, secretAttributes, allowedRegions, }: {
+    endpoint: string;
+    query: string;
+    collectionId?: string;
+    headers?: Record<string, string>;
+    conversationId?: string;
+    attributes?: SearchQueryAttributes;
+    secretAttributes?: string;
+    allowedRegions?: string[];
+}): Promise<SearchResponse>;
+export declare function fetchAnswer({ endpoint, searchQueryId, headers, conversationId, }: {
+    endpoint: string;
+    searchQueryId: string;
+    headers?: Record<string, string>;
+    conversationId?: string;
+}): Promise<Response>;
+export declare function fetchAnswerStream({ endpoint, headers, body, }: {
+    endpoint: string;
+    headers?: Record<string, string>;
+    body: {
+        type: 'generate-for-query';
+        conversationId?: string;
+        searchQueryId: string;
+    } | {
+        type: 'invoke-action';
+        conversationId?: string;
+        searchQueryId: string;
+        searchIntentId: string;
+        actionId: string;
+        parameters: ActionInputs;
+    } | {
+        type: 'client-execution-result';
+        conversationId?: string;
+        searchQueryId: string;
+        searchIntentId: string;
+        actionId: string;
+        results: ClientExecutionResult;
+    };
+}): Promise<Response>;
+export declare function createConversationId(): string;
+export declare function sendFeedback({ endpoint, searchQueryId, response, headers, conversationId, }: {
+    endpoint: string;
+    searchQueryId: string;
+    response: FeedbackResponse;
+    headers?: Record<string, string>;
+    conversationId?: string;
+}): Promise<void>;
+export declare function sendFeedbackReason({ endpoint, searchQueryId, reason, headers, }: {
+    endpoint: string;
+    searchQueryId: string;
+    reason: string;
+    headers?: Record<string, string>;
+    conversationId?: string;
+}): Promise<void>;
+export interface ConversationResponse {
+    data: Array<{
+        question: string;
+        answer: string;
+        searchQueryId: string;
+        searchResults?: SearchResult[];
+        searchIntentId?: string;
+        feedback?: APIFeedbackResponse;
+    }>;
+}
+export declare function loadConversation({ endpoint, conversationId, headers, signal, }: {
+    endpoint: string;
+    conversationId: string;
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+}): Promise<{
+    data: ConversationResponse['data'];
+}>;
+export declare function fetchFollowUpQuestions({ endpoint, searchQueryId, headers, conversationId, }: {
+    endpoint: string;
+    searchQueryId: string;
+    headers?: Record<string, string>;
+    conversationId?: string;
+}): Promise<string[]>;
+interface AutocompleteResponse {
+    response: {
+        results: Array<{
+            id: string;
+            question: string;
+        }>;
+    };
+}
+export declare function fetchAutocomplete({ endpoint, query, collectionId, headers, conversationId, allowedRegions, }: {
+    endpoint: string;
+    query: string;
+    collectionId?: string;
+    headers?: Record<string, string>;
+    conversationId?: string;
+    allowedRegions?: string[];
+}): Promise<AutocompleteResponse>;
+export {};

package/dist/lib/feature-flags.d.ts

@@ -0,0 +1,9 @@
+import { default as React, ReactNode } from 'react';
+export type FeatureFlags = {
+    [key: string]: boolean | string | number;
+};
+export declare function FeatureFlagProvider({ children, flags }: {
+    children: ReactNode;
+    flags: FeatureFlags | undefined;
+}): React.JSX.Element;
+export declare function useBooleanFlagValue(flagKey: string, defaultValue: boolean): boolean;

package/dist/lib/features.d.ts

@@ -0,0 +1,3 @@
+export declare const Features: {
+    readonly UseSseForAnswers: "use-sse-for-answers";
+};

package/dist/lib/fetchClient.d.ts

@@ -0,0 +1,19 @@
+interface RetryOptions {
+    maxRetries?: number;
+    baseDelay?: number;
+    shouldRetry?: (error: Error, attempt: number) => boolean | Promise<boolean>;
+}
+interface FallbackConfig {
+    emptyResponse?: string;
+    errorResponse?: string;
+}
+interface RequestConfig<T> extends Omit<RequestInit, 'body'> {
+    retry?: RetryOptions;
+    body?: T;
+    isStream?: boolean;
+    fallback?: FallbackConfig;
+}
+export declare function configureRetry(options: RetryOptions): void;
+export declare function configureFallback(config: FallbackConfig): void;
+export declare function makeRequest<TResponse, TBody = unknown>(url: string | URL, config?: RequestConfig<TBody>): Promise<TResponse>;
+export {};

package/dist/lib/getContentType.d.ts

@@ -0,0 +1 @@
+export declare function getContentType(attachmentId: string, apiHost?: string, signal?: AbortSignal): Promise<'image' | 'video' | 'audio' | 'pdf' | 'unknown'>;

package/dist/lib/hooks.d.ts

@@ -0,0 +1,15 @@
+import { Suggestion } from '../components/chat-search/types';
+export declare function useDebounce<T>(value: T, delay: number): T;
+export declare function useAutocomplete({ query, endpoint, allowedRegions, collectionId, headers, conversationId, delay, }: {
+    query: string;
+    endpoint: string;
+    allowedRegions?: string[];
+    collectionId?: string;
+    headers?: Record<string, string>;
+    conversationId?: string;
+    delay?: number;
+}): {
+    suggestions: Suggestion[];
+    isLoading: boolean;
+    error: string | undefined;
+};

package/dist/lib/utils.d.ts

@@ -0,0 +1,8 @@
+import { ClassValue } from 'clsx';
+export declare function cn(...inputs: ClassValue[]): string;
+export declare function useId(prefix?: string): string;
+export declare function isAnswerUncertain(response: string): {
+    uncertain: boolean;
+    language: string | null;
+};
+export declare function getLuminance(rgb: string): number;