@nlweb-ai/search-components 0.1.9

package/dist/index.d.ts

@@ -0,0 +1,317 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { z } from 'zod';
+
+declare const RecipeSchema: z.ZodObject<{
+    "@type": z.ZodUnion<readonly [z.ZodLiteral<"Recipe">, z.ZodArray<z.ZodString>]>;
+    "@id": z.ZodString;
+    score: z.ZodNumber;
+    site: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    recipeIngredient: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodString>, z.ZodString]>>;
+    recipeInstructions: z.ZodOptional<z.ZodAny>;
+    recipeYield: z.ZodOptional<z.ZodAny>;
+    cookTime: z.ZodOptional<z.ZodString>;
+    prepTime: z.ZodOptional<z.ZodString>;
+    totalTime: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    image: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"ImageObject">>;
+        "@id": z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        contentUrl: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"ImageObject">>;
+        "@id": z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        contentUrl: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>]>>]>>;
+}, z.core.$loose>;
+type RecipeResult = z.infer<typeof RecipeSchema>;
+declare const ArticleSchema: z.ZodObject<{
+    "@type": z.ZodUnion<readonly [z.ZodLiteral<"Article">, z.ZodLiteral<"NewsArticle">, z.ZodLiteral<"BlogPosting">, z.ZodArray<z.ZodString>]>;
+    "@id": z.ZodString;
+    score: z.ZodNumber;
+    site: z.ZodString;
+    headline: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    image: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"ImageObject">>;
+        "@id": z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        contentUrl: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"ImageObject">>;
+        "@id": z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        contentUrl: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>]>>]>>;
+    author: z.ZodOptional<z.ZodAny>;
+    publisher: z.ZodOptional<z.ZodAny>;
+    datePublished: z.ZodOptional<z.ZodString>;
+    dateModified: z.ZodOptional<z.ZodString>;
+    thumbnailUrl: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+type ArticleResult = z.infer<typeof ArticleSchema>;
+declare const MovieSchema: z.ZodObject<{
+    "@type": z.ZodUnion<readonly [z.ZodLiteral<"Movie">, z.ZodArray<z.ZodString>]>;
+    "@id": z.ZodString;
+    score: z.ZodNumber;
+    site: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    image: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"ImageObject">>;
+        "@id": z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        contentUrl: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"ImageObject">>;
+        "@id": z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        contentUrl: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>]>>]>>;
+    url: z.ZodOptional<z.ZodString>;
+    genre: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    datePublished: z.ZodOptional<z.ZodString>;
+    director: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Person">>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodArray<z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Person">>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>]>>;
+    actor: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Person">>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodArray<z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Person">>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>]>>;
+    aggregateRating: z.ZodOptional<z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"AggregateRating">>;
+        ratingValue: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+        bestRating: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        worstRating: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        ratingCount: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        reviewCount: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    }, z.core.$loose>>;
+    duration: z.ZodOptional<z.ZodString>;
+    contentRating: z.ZodOptional<z.ZodString>;
+    productionCompany: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Organization">>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodArray<z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Organization">>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>]>>;
+    trailer: z.ZodOptional<z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"VideoObject">>;
+        name: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        thumbnailUrl: z.ZodOptional<z.ZodString>;
+        uploadDate: z.ZodOptional<z.ZodString>;
+        contentUrl: z.ZodOptional<z.ZodString>;
+        embedUrl: z.ZodOptional<z.ZodString>;
+        duration: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>;
+    review: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Review">>;
+        datePublished: z.ZodOptional<z.ZodString>;
+        reviewBody: z.ZodOptional<z.ZodString>;
+        reviewRating: z.ZodOptional<z.ZodObject<{
+            "@type": z.ZodOptional<z.ZodLiteral<"Rating">>;
+            ratingValue: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+            bestRating: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+            worstRating: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        }, z.core.$loose>>;
+        author: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+            "@type": z.ZodOptional<z.ZodLiteral<"Person">>;
+            name: z.ZodString;
+            url: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>, z.ZodObject<{
+            "@type": z.ZodOptional<z.ZodLiteral<"Organization">>;
+            name: z.ZodString;
+            url: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>, z.ZodString]>>;
+    }, z.core.$loose>, z.ZodArray<z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Review">>;
+        datePublished: z.ZodOptional<z.ZodString>;
+        reviewBody: z.ZodOptional<z.ZodString>;
+        reviewRating: z.ZodOptional<z.ZodObject<{
+            "@type": z.ZodOptional<z.ZodLiteral<"Rating">>;
+            ratingValue: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+            bestRating: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+            worstRating: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        }, z.core.$loose>>;
+        author: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+            "@type": z.ZodOptional<z.ZodLiteral<"Person">>;
+            name: z.ZodString;
+            url: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>, z.ZodObject<{
+            "@type": z.ZodOptional<z.ZodLiteral<"Organization">>;
+            name: z.ZodString;
+            url: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>, z.ZodString]>>;
+    }, z.core.$loose>>]>>;
+    sameAs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    countryOfOrigin: z.ZodOptional<z.ZodAny>;
+    musicBy: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Person">>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodArray<z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Person">>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>]>>;
+    producer: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Person">>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Organization">>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Person">>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodObject<{
+        "@type": z.ZodOptional<z.ZodLiteral<"Organization">>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>]>>]>>;
+}, z.core.$loose>;
+type MovieResult = z.infer<typeof MovieSchema>;
+type NlwebResult = RecipeResult | ArticleResult | MovieResult;
+
+/**
+ * Search state
+ */
+interface NLWebSearchState {
+    results: NlwebResult[];
+    resultOffset?: number;
+    streamingIndex: number;
+    summary?: string;
+    decontextualizedQuery?: string;
+    query: string | null;
+    loading: boolean;
+    error: string | null;
+    rawLogs?: object[];
+}
+interface NLWeb extends NLWebSearchState {
+    search: (params: NLWebSearchParams) => Promise<SearchResponse>;
+    cancelSearch: () => void;
+    clearResults: () => void;
+}
+/**
+ * Search request parameters
+ */
+interface NLWebSearchParams {
+    query: string;
+    mode?: "list" | "list,summarize";
+    userId?: string;
+    remember?: boolean;
+    conversationHistory?: string[];
+    resultOffset?: number;
+}
+/**
+ * Hook configuration
+ */
+interface UseNlWebConfig {
+    endpoint: string;
+    site: string;
+    maxResults?: number;
+    numRetrievalResults?: number;
+}
+interface SearchResponse {
+    results: NlwebResult[];
+    decontextualizedQuery?: string;
+    summary?: string;
+    rawLogs?: object[];
+}
+/**
+ * Custom hook for NLWeb search with SSE streaming support
+ *
+ * @param config - Hook configuration including endpoint URL
+ * @returns Search state and search function
+ */
+declare function useNlWeb(config: UseNlWebConfig): NLWeb;
+
+interface QueryResultSet {
+    id?: string;
+    sessionId: string;
+    query: string;
+    response: SearchResponse;
+}
+interface Backend {
+    site: string;
+    endpoint: string;
+}
+interface SearchSession {
+    query: string;
+    sessionId: string;
+    backend: Backend;
+    updated: Date;
+    created: Date;
+}
+
+declare function useSearchSessions(): {
+    sessions: SearchSession[];
+    startSession: (sessionId: string, query: string, backend: Backend) => Promise<void>;
+    deleteSession: (sessionId: string) => Promise<void>;
+};
+interface SearchSessionManager {
+    searches: QueryResultSet[];
+    addSearch: (data: QueryResultSet) => Promise<void>;
+    addResults: (id: string, results: NlwebResult[]) => Promise<void>;
+}
+declare function useSearchSession(sessionId: string | null): SearchSessionManager;
+
+declare function ChatSearch({ searches, addSearch, addResults, startSession, endSession, nlweb, config, children, sidebar, sessionId, }: {
+    sessionId?: string;
+    searches: QueryResultSet[];
+    addSearch: (r: QueryResultSet) => Promise<void> | void;
+    addResults: (id: string, results: NlwebResult[]) => Promise<void>;
+    startSession: (query: string) => Promise<string> | void;
+    endSession: () => void;
+    nlweb: NLWeb;
+    config: UseNlWebConfig;
+    children?: ReactNode;
+    sidebar?: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare function HistorySidebar({ selected, sessions, onSelect, onDelete, onCreate, }: {
+    selected?: string;
+    sessions: SearchSession[];
+    onSelect: (session: SearchSession) => void;
+    onDelete: (sessionId: string) => void;
+    onCreate: () => void;
+}): react_jsx_runtime.JSX.Element;
+
+declare function DebugTool({ searches, streamingState, config, }: {
+    searches: QueryResultSet[];
+    streamingState: NLWebSearchState;
+    config: UseNlWebConfig;
+}): react_jsx_runtime.JSX.Element;
+
+interface Site {
+    featured?: boolean;
+    url: string;
+}
+interface SiteDropdownProps {
+    sites: Site[];
+    selected: Site;
+    onSelect: (url: string | null) => void;
+    placeholder?: string;
+}
+declare function SiteDropdown({ sites, selected, onSelect, placeholder, }: SiteDropdownProps): react_jsx_runtime.JSX.Element;
+
+export { ChatSearch, DebugTool, HistorySidebar, type QueryResultSet, type SearchSession, type Site, SiteDropdown, useNlWeb, useSearchSession, useSearchSessions };