@microfox/brave
Version:
TypeScript SDK for Brave APIs.
1,458 lines (1,449 loc) • 931 kB
TypeScript
import { z } from 'zod';
declare const RequestHeadersSchema: z.ZodObject<{
Accept: z.ZodOptional<z.ZodDefault<z.ZodString>>;
'Accept-Encoding': z.ZodOptional<z.ZodDefault<z.ZodString>>;
'Api-Version': z.ZodOptional<z.ZodString>;
'Cache-Control': z.ZodOptional<z.ZodString>;
'User-Agent': z.ZodOptional<z.ZodString>;
'X-Loc-Lat': z.ZodOptional<z.ZodNumber>;
'X-Loc-Long': z.ZodOptional<z.ZodNumber>;
'X-Loc-Timezone': z.ZodOptional<z.ZodString>;
'X-Loc-City': z.ZodOptional<z.ZodString>;
'X-Loc-State': z.ZodOptional<z.ZodString>;
'X-Loc-State-Name': z.ZodOptional<z.ZodString>;
'X-Loc-Country': z.ZodOptional<z.ZodString>;
'X-Loc-Postal-Code': z.ZodOptional<z.ZodString>;
'X-Subscription-Token': z.ZodString;
}, "strip", z.ZodTypeAny, {
'X-Subscription-Token': string;
Accept?: string | undefined;
'Accept-Encoding'?: string | undefined;
'Api-Version'?: string | undefined;
'Cache-Control'?: string | undefined;
'User-Agent'?: string | undefined;
'X-Loc-Lat'?: number | undefined;
'X-Loc-Long'?: number | undefined;
'X-Loc-Timezone'?: string | undefined;
'X-Loc-City'?: string | undefined;
'X-Loc-State'?: string | undefined;
'X-Loc-State-Name'?: string | undefined;
'X-Loc-Country'?: string | undefined;
'X-Loc-Postal-Code'?: string | undefined;
}, {
'X-Subscription-Token': string;
Accept?: string | undefined;
'Accept-Encoding'?: string | undefined;
'Api-Version'?: string | undefined;
'Cache-Control'?: string | undefined;
'User-Agent'?: string | undefined;
'X-Loc-Lat'?: number | undefined;
'X-Loc-Long'?: number | undefined;
'X-Loc-Timezone'?: string | undefined;
'X-Loc-City'?: string | undefined;
'X-Loc-State'?: string | undefined;
'X-Loc-State-Name'?: string | undefined;
'X-Loc-Country'?: string | undefined;
'X-Loc-Postal-Code'?: string | undefined;
}>;
declare const LocalSearchHeadersSchema: z.ZodObject<Omit<{
Accept: z.ZodOptional<z.ZodDefault<z.ZodString>>;
'Accept-Encoding': z.ZodOptional<z.ZodDefault<z.ZodString>>;
'Api-Version': z.ZodOptional<z.ZodString>;
'Cache-Control': z.ZodOptional<z.ZodString>;
'User-Agent': z.ZodOptional<z.ZodString>;
'X-Loc-Lat': z.ZodOptional<z.ZodNumber>;
'X-Loc-Long': z.ZodOptional<z.ZodNumber>;
'X-Loc-Timezone': z.ZodOptional<z.ZodString>;
'X-Loc-City': z.ZodOptional<z.ZodString>;
'X-Loc-State': z.ZodOptional<z.ZodString>;
'X-Loc-State-Name': z.ZodOptional<z.ZodString>;
'X-Loc-Country': z.ZodOptional<z.ZodString>;
'X-Loc-Postal-Code': z.ZodOptional<z.ZodString>;
'X-Subscription-Token': z.ZodString;
}, "X-Loc-Lat" | "X-Loc-Long" | "X-Loc-Timezone" | "X-Loc-City" | "X-Loc-State" | "X-Loc-State-Name" | "X-Loc-Country" | "X-Loc-Postal-Code">, "strip", z.ZodTypeAny, {
'X-Subscription-Token': string;
Accept?: string | undefined;
'Accept-Encoding'?: string | undefined;
'Api-Version'?: string | undefined;
'Cache-Control'?: string | undefined;
'User-Agent'?: string | undefined;
}, {
'X-Subscription-Token': string;
Accept?: string | undefined;
'Accept-Encoding'?: string | undefined;
'Api-Version'?: string | undefined;
'Cache-Control'?: string | undefined;
'User-Agent'?: string | undefined;
}>;
type RequestHeaders$1 = z.infer<typeof RequestHeadersSchema>;
type LocalSearchHeaders$1 = z.infer<typeof LocalSearchHeadersSchema>;
type RequestHeaders = z.infer<typeof RequestHeadersSchema>;
type LocalSearchHeaders = z.infer<typeof LocalSearchHeadersSchema>;
declare const BraveSDKOptionsSchema: z.ZodObject<{
apiKey: z.ZodOptional<z.ZodString>;
headers: z.ZodOptional<z.ZodObject<{
Accept: z.ZodOptional<z.ZodDefault<z.ZodString>>;
'Accept-Encoding': z.ZodOptional<z.ZodDefault<z.ZodString>>;
'Api-Version': z.ZodOptional<z.ZodString>;
'Cache-Control': z.ZodOptional<z.ZodString>;
'User-Agent': z.ZodOptional<z.ZodString>;
'X-Loc-Lat': z.ZodOptional<z.ZodNumber>;
'X-Loc-Long': z.ZodOptional<z.ZodNumber>;
'X-Loc-Timezone': z.ZodOptional<z.ZodString>;
'X-Loc-City': z.ZodOptional<z.ZodString>;
'X-Loc-State': z.ZodOptional<z.ZodString>;
'X-Loc-State-Name': z.ZodOptional<z.ZodString>;
'X-Loc-Country': z.ZodOptional<z.ZodString>;
'X-Loc-Postal-Code': z.ZodOptional<z.ZodString>;
'X-Subscription-Token': z.ZodString;
}, "strip", z.ZodTypeAny, {
'X-Subscription-Token': string;
Accept?: string | undefined;
'Accept-Encoding'?: string | undefined;
'Api-Version'?: string | undefined;
'Cache-Control'?: string | undefined;
'User-Agent'?: string | undefined;
'X-Loc-Lat'?: number | undefined;
'X-Loc-Long'?: number | undefined;
'X-Loc-Timezone'?: string | undefined;
'X-Loc-City'?: string | undefined;
'X-Loc-State'?: string | undefined;
'X-Loc-State-Name'?: string | undefined;
'X-Loc-Country'?: string | undefined;
'X-Loc-Postal-Code'?: string | undefined;
}, {
'X-Subscription-Token': string;
Accept?: string | undefined;
'Accept-Encoding'?: string | undefined;
'Api-Version'?: string | undefined;
'Cache-Control'?: string | undefined;
'User-Agent'?: string | undefined;
'X-Loc-Lat'?: number | undefined;
'X-Loc-Long'?: number | undefined;
'X-Loc-Timezone'?: string | undefined;
'X-Loc-City'?: string | undefined;
'X-Loc-State'?: string | undefined;
'X-Loc-State-Name'?: string | undefined;
'X-Loc-Country'?: string | undefined;
'X-Loc-Postal-Code'?: string | undefined;
}>>;
localSearchHeaders: z.ZodOptional<z.ZodObject<Omit<{
Accept: z.ZodOptional<z.ZodDefault<z.ZodString>>;
'Accept-Encoding': z.ZodOptional<z.ZodDefault<z.ZodString>>;
'Api-Version': z.ZodOptional<z.ZodString>;
'Cache-Control': z.ZodOptional<z.ZodString>;
'User-Agent': z.ZodOptional<z.ZodString>;
'X-Loc-Lat': z.ZodOptional<z.ZodNumber>;
'X-Loc-Long': z.ZodOptional<z.ZodNumber>;
'X-Loc-Timezone': z.ZodOptional<z.ZodString>;
'X-Loc-City': z.ZodOptional<z.ZodString>;
'X-Loc-State': z.ZodOptional<z.ZodString>;
'X-Loc-State-Name': z.ZodOptional<z.ZodString>;
'X-Loc-Country': z.ZodOptional<z.ZodString>;
'X-Loc-Postal-Code': z.ZodOptional<z.ZodString>;
'X-Subscription-Token': z.ZodString;
}, "X-Loc-Lat" | "X-Loc-Long" | "X-Loc-Timezone" | "X-Loc-City" | "X-Loc-State" | "X-Loc-State-Name" | "X-Loc-Country" | "X-Loc-Postal-Code">, "strip", z.ZodTypeAny, {
'X-Subscription-Token': string;
Accept?: string | undefined;
'Accept-Encoding'?: string | undefined;
'Api-Version'?: string | undefined;
'Cache-Control'?: string | undefined;
'User-Agent'?: string | undefined;
}, {
'X-Subscription-Token': string;
Accept?: string | undefined;
'Accept-Encoding'?: string | undefined;
'Api-Version'?: string | undefined;
'Cache-Control'?: string | undefined;
'User-Agent'?: string | undefined;
}>>;
enableRedisTracking: z.ZodOptional<z.ZodBoolean>;
redisTrackingId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
apiKey?: string | undefined;
headers?: {
'X-Subscription-Token': string;
Accept?: string | undefined;
'Accept-Encoding'?: string | undefined;
'Api-Version'?: string | undefined;
'Cache-Control'?: string | undefined;
'User-Agent'?: string | undefined;
'X-Loc-Lat'?: number | undefined;
'X-Loc-Long'?: number | undefined;
'X-Loc-Timezone'?: string | undefined;
'X-Loc-City'?: string | undefined;
'X-Loc-State'?: string | undefined;
'X-Loc-State-Name'?: string | undefined;
'X-Loc-Country'?: string | undefined;
'X-Loc-Postal-Code'?: string | undefined;
} | undefined;
localSearchHeaders?: {
'X-Subscription-Token': string;
Accept?: string | undefined;
'Accept-Encoding'?: string | undefined;
'Api-Version'?: string | undefined;
'Cache-Control'?: string | undefined;
'User-Agent'?: string | undefined;
} | undefined;
enableRedisTracking?: boolean | undefined;
redisTrackingId?: string | undefined;
}, {
apiKey?: string | undefined;
headers?: {
'X-Subscription-Token': string;
Accept?: string | undefined;
'Accept-Encoding'?: string | undefined;
'Api-Version'?: string | undefined;
'Cache-Control'?: string | undefined;
'User-Agent'?: string | undefined;
'X-Loc-Lat'?: number | undefined;
'X-Loc-Long'?: number | undefined;
'X-Loc-Timezone'?: string | undefined;
'X-Loc-City'?: string | undefined;
'X-Loc-State'?: string | undefined;
'X-Loc-State-Name'?: string | undefined;
'X-Loc-Country'?: string | undefined;
'X-Loc-Postal-Code'?: string | undefined;
} | undefined;
localSearchHeaders?: {
'X-Subscription-Token': string;
Accept?: string | undefined;
'Accept-Encoding'?: string | undefined;
'Api-Version'?: string | undefined;
'Cache-Control'?: string | undefined;
'User-Agent'?: string | undefined;
} | undefined;
enableRedisTracking?: boolean | undefined;
redisTrackingId?: string | undefined;
}>;
declare const SummarizerSearchParamsSchema: z.ZodObject<{
key: z.ZodString;
entity_info: z.ZodOptional<z.ZodBoolean>;
}, "strip", z.ZodTypeAny, {
key: string;
entity_info?: boolean | undefined;
}, {
key: string;
entity_info?: boolean | undefined;
}>;
declare const ImageSearchParamsSchema: z.ZodObject<Omit<{
q: z.ZodString;
country: z.ZodDefault<z.ZodOptional<z.ZodString>>;
search_lang: z.ZodDefault<z.ZodOptional<z.ZodString>>;
ui_lang: z.ZodDefault<z.ZodOptional<z.ZodString>>;
count: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
offset: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
safesearch: z.ZodDefault<z.ZodOptional<z.ZodEnum<["off", "moderate", "strict"]>>>;
freshness: z.ZodOptional<z.ZodUnion<[z.ZodEnum<["pd", "pw", "pm", "py"]>, z.ZodString]>>;
text_decorations: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
spellcheck: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
result_filter: z.ZodOptional<z.ZodString>;
goggles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
units: z.ZodOptional<z.ZodEnum<["metric", "imperial"]>>;
extra_snippets: z.ZodOptional<z.ZodBoolean>;
summary: z.ZodOptional<z.ZodBoolean>;
}, "extra_snippets" | "summary">, "strip", z.ZodTypeAny, {
country: string;
q: string;
search_lang: string;
ui_lang: string;
count: number;
offset: number;
safesearch: "off" | "moderate" | "strict";
text_decorations: boolean;
spellcheck: boolean;
freshness?: string | undefined;
result_filter?: string | undefined;
goggles?: string[] | undefined;
units?: "metric" | "imperial" | undefined;
}, {
q: string;
country?: string | undefined;
search_lang?: string | undefined;
ui_lang?: string | undefined;
count?: number | undefined;
offset?: number | undefined;
safesearch?: "off" | "moderate" | "strict" | undefined;
freshness?: string | undefined;
text_decorations?: boolean | undefined;
spellcheck?: boolean | undefined;
result_filter?: string | undefined;
goggles?: string[] | undefined;
units?: "metric" | "imperial" | undefined;
}>;
declare const VideoSearchParamsSchema: z.ZodObject<Omit<{
q: z.ZodString;
country: z.ZodDefault<z.ZodOptional<z.ZodString>>;
search_lang: z.ZodDefault<z.ZodOptional<z.ZodString>>;
ui_lang: z.ZodDefault<z.ZodOptional<z.ZodString>>;
count: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
offset: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
safesearch: z.ZodDefault<z.ZodOptional<z.ZodEnum<["off", "moderate", "strict"]>>>;
freshness: z.ZodOptional<z.ZodUnion<[z.ZodEnum<["pd", "pw", "pm", "py"]>, z.ZodString]>>;
text_decorations: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
spellcheck: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
result_filter: z.ZodOptional<z.ZodString>;
goggles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
units: z.ZodOptional<z.ZodEnum<["metric", "imperial"]>>;
extra_snippets: z.ZodOptional<z.ZodBoolean>;
summary: z.ZodOptional<z.ZodBoolean>;
}, "extra_snippets" | "summary">, "strip", z.ZodTypeAny, {
country: string;
q: string;
search_lang: string;
ui_lang: string;
count: number;
offset: number;
safesearch: "off" | "moderate" | "strict";
text_decorations: boolean;
spellcheck: boolean;
freshness?: string | undefined;
result_filter?: string | undefined;
goggles?: string[] | undefined;
units?: "metric" | "imperial" | undefined;
}, {
q: string;
country?: string | undefined;
search_lang?: string | undefined;
ui_lang?: string | undefined;
count?: number | undefined;
offset?: number | undefined;
safesearch?: "off" | "moderate" | "strict" | undefined;
freshness?: string | undefined;
text_decorations?: boolean | undefined;
spellcheck?: boolean | undefined;
result_filter?: string | undefined;
goggles?: string[] | undefined;
units?: "metric" | "imperial" | undefined;
}>;
declare const NewsSearchParamsSchema: z.ZodObject<Omit<{
q: z.ZodString;
country: z.ZodDefault<z.ZodOptional<z.ZodString>>;
search_lang: z.ZodDefault<z.ZodOptional<z.ZodString>>;
ui_lang: z.ZodDefault<z.ZodOptional<z.ZodString>>;
count: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
offset: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
safesearch: z.ZodDefault<z.ZodOptional<z.ZodEnum<["off", "moderate", "strict"]>>>;
freshness: z.ZodOptional<z.ZodUnion<[z.ZodEnum<["pd", "pw", "pm", "py"]>, z.ZodString]>>;
text_decorations: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
spellcheck: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
result_filter: z.ZodOptional<z.ZodString>;
goggles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
units: z.ZodOptional<z.ZodEnum<["metric", "imperial"]>>;
extra_snippets: z.ZodOptional<z.ZodBoolean>;
summary: z.ZodOptional<z.ZodBoolean>;
}, "extra_snippets" | "summary">, "strip", z.ZodTypeAny, {
country: string;
q: string;
search_lang: string;
ui_lang: string;
count: number;
offset: number;
safesearch: "off" | "moderate" | "strict";
text_decorations: boolean;
spellcheck: boolean;
freshness?: string | undefined;
result_filter?: string | undefined;
goggles?: string[] | undefined;
units?: "metric" | "imperial" | undefined;
}, {
q: string;
country?: string | undefined;
search_lang?: string | undefined;
ui_lang?: string | undefined;
count?: number | undefined;
offset?: number | undefined;
safesearch?: "off" | "moderate" | "strict" | undefined;
freshness?: string | undefined;
text_decorations?: boolean | undefined;
spellcheck?: boolean | undefined;
result_filter?: string | undefined;
goggles?: string[] | undefined;
units?: "metric" | "imperial" | undefined;
}>;
declare const SuggestSearchParamsSchema: z.ZodObject<{
q: z.ZodString;
country: z.ZodOptional<z.ZodString>;
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
q: string;
country?: string | undefined;
count?: number | undefined;
}, {
q: string;
country?: string | undefined;
count?: number | undefined;
}>;
declare const SpellcheckSearchParamsSchema: z.ZodObject<{
q: z.ZodString;
country: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
q: string;
country?: string | undefined;
}, {
q: string;
country?: string | undefined;
}>;
type BraveSDKOptions = z.infer<typeof BraveSDKOptionsSchema>;
type SummarizerSearchParams = z.infer<typeof SummarizerSearchParamsSchema>;
type ImageSearchParams = z.infer<typeof ImageSearchParamsSchema>;
type VideoSearchParams = z.infer<typeof VideoSearchParamsSchema>;
type NewsSearchParams = z.infer<typeof NewsSearchParamsSchema>;
type SuggestSearchParams = z.infer<typeof SuggestSearchParamsSchema>;
type SpellcheckSearchParams = z.infer<typeof SpellcheckSearchParamsSchema>;
declare const ImageSearchApiResponseSchema: z.ZodObject<{
type: z.ZodLiteral<"images">;
query: z.ZodObject<{
original: z.ZodString;
altered: z.ZodString;
spellcheck_off: z.ZodBoolean;
show_strict_warning: z.ZodString;
}, "strip", z.ZodTypeAny, {
original: string;
altered: string;
spellcheck_off: boolean;
show_strict_warning: string;
}, {
original: string;
altered: string;
spellcheck_off: boolean;
show_strict_warning: string;
}>;
results: z.ZodArray<z.ZodObject<{
type: z.ZodLiteral<"image_result">;
title: z.ZodString;
url: z.ZodString;
source: z.ZodString;
page_fetched: z.ZodString;
thumbnail: z.ZodObject<{
src: z.ZodString;
original: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
src: string;
original?: string | undefined;
}, {
src: string;
original?: string | undefined;
}>;
properties: z.ZodObject<{
url: z.ZodString;
resized: z.ZodOptional<z.ZodString>;
placeholder: z.ZodString;
height: z.ZodOptional<z.ZodNumber>;
width: z.ZodOptional<z.ZodNumber>;
format: z.ZodOptional<z.ZodString>;
content_size: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
}, {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
}>;
meta_url: z.ZodObject<{
scheme: z.ZodString;
netloc: z.ZodString;
hostname: z.ZodOptional<z.ZodString>;
favicon: z.ZodString;
path: z.ZodString;
}, "strip", z.ZodTypeAny, {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
}, {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
type: "image_result";
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
meta_url: {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
};
source: string;
title: string;
page_fetched: string;
}, {
type: "image_result";
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
meta_url: {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
};
source: string;
title: string;
page_fetched: string;
}>, "many">;
}, "strip", z.ZodTypeAny, {
type: "images";
results: {
type: "image_result";
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
meta_url: {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
};
source: string;
title: string;
page_fetched: string;
}[];
query: {
original: string;
altered: string;
spellcheck_off: boolean;
show_strict_warning: string;
};
}, {
type: "images";
results: {
type: "image_result";
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
meta_url: {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
};
source: string;
title: string;
page_fetched: string;
}[];
query: {
original: string;
altered: string;
spellcheck_off: boolean;
show_strict_warning: string;
};
}>;
type ImageSearchApiResponse = z.infer<typeof ImageSearchApiResponseSchema>;
declare const NewsSearchApiResponseSchema: z.ZodObject<{
type: z.ZodLiteral<"news">;
query: z.ZodObject<{
original: z.ZodString;
altered: z.ZodString;
cleaned: z.ZodString;
spellcheck_off: z.ZodBoolean;
show_strict_warning: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
original: string;
altered: string;
spellcheck_off: boolean;
show_strict_warning: boolean;
cleaned: string;
}, {
original: string;
altered: string;
spellcheck_off: boolean;
show_strict_warning: boolean;
cleaned: string;
}>;
results: z.ZodArray<z.ZodObject<{
type: z.ZodLiteral<"news_result">;
url: z.ZodString;
title: z.ZodString;
description: z.ZodString;
age: z.ZodString;
page_age: z.ZodString;
page_fetched: z.ZodString;
breaking: z.ZodBoolean;
thumbnail: z.ZodObject<{
src: z.ZodString;
original: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
src: string;
original?: string | undefined;
}, {
src: string;
original?: string | undefined;
}>;
meta_url: z.ZodObject<{
scheme: z.ZodString;
netloc: z.ZodString;
hostname: z.ZodOptional<z.ZodString>;
favicon: z.ZodString;
path: z.ZodString;
}, "strip", z.ZodTypeAny, {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
}, {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
}>;
extra_snippets: z.ZodArray<z.ZodString, "many">;
}, "strip", z.ZodTypeAny, {
type: "news_result";
extra_snippets: string[];
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
meta_url: {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
};
breaking: boolean;
age: string;
description: string;
title: string;
page_age: string;
page_fetched: string;
}, {
type: "news_result";
extra_snippets: string[];
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
meta_url: {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
};
breaking: boolean;
age: string;
description: string;
title: string;
page_age: string;
page_fetched: string;
}>, "many">;
}, "strip", z.ZodTypeAny, {
type: "news";
results: {
type: "news_result";
extra_snippets: string[];
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
meta_url: {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
};
breaking: boolean;
age: string;
description: string;
title: string;
page_age: string;
page_fetched: string;
}[];
query: {
original: string;
altered: string;
spellcheck_off: boolean;
show_strict_warning: boolean;
cleaned: string;
};
}, {
type: "news";
results: {
type: "news_result";
extra_snippets: string[];
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
meta_url: {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
};
breaking: boolean;
age: string;
description: string;
title: string;
page_age: string;
page_fetched: string;
}[];
query: {
original: string;
altered: string;
spellcheck_off: boolean;
show_strict_warning: boolean;
cleaned: string;
};
}>;
type NewsSearchApiResponse = z.infer<typeof NewsSearchApiResponseSchema>;
declare const WebSearchParamsSchema: z.ZodObject<{
q: z.ZodString;
country: z.ZodDefault<z.ZodOptional<z.ZodString>>;
search_lang: z.ZodDefault<z.ZodOptional<z.ZodString>>;
ui_lang: z.ZodDefault<z.ZodOptional<z.ZodString>>;
count: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
offset: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
safesearch: z.ZodDefault<z.ZodOptional<z.ZodEnum<["off", "moderate", "strict"]>>>;
freshness: z.ZodOptional<z.ZodUnion<[z.ZodEnum<["pd", "pw", "pm", "py"]>, z.ZodString]>>;
text_decorations: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
spellcheck: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
result_filter: z.ZodOptional<z.ZodString>;
goggles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
units: z.ZodOptional<z.ZodEnum<["metric", "imperial"]>>;
extra_snippets: z.ZodOptional<z.ZodBoolean>;
summary: z.ZodOptional<z.ZodBoolean>;
}, "strip", z.ZodTypeAny, {
country: string;
q: string;
search_lang: string;
ui_lang: string;
count: number;
offset: number;
safesearch: "off" | "moderate" | "strict";
text_decorations: boolean;
spellcheck: boolean;
freshness?: string | undefined;
result_filter?: string | undefined;
goggles?: string[] | undefined;
units?: "metric" | "imperial" | undefined;
extra_snippets?: boolean | undefined;
summary?: boolean | undefined;
}, {
q: string;
country?: string | undefined;
search_lang?: string | undefined;
ui_lang?: string | undefined;
count?: number | undefined;
offset?: number | undefined;
safesearch?: "off" | "moderate" | "strict" | undefined;
freshness?: string | undefined;
text_decorations?: boolean | undefined;
spellcheck?: boolean | undefined;
result_filter?: string | undefined;
goggles?: string[] | undefined;
units?: "metric" | "imperial" | undefined;
extra_snippets?: boolean | undefined;
summary?: boolean | undefined;
}>;
declare const LocalSearchParamsSchema: z.ZodObject<{
ids: z.ZodArray<z.ZodString, "many">;
search_lang: z.ZodOptional<z.ZodString>;
ui_lang: z.ZodOptional<z.ZodString>;
units: z.ZodOptional<z.ZodEnum<["metric", "imperial"]>>;
}, "strip", z.ZodTypeAny, {
ids: string[];
search_lang?: string | undefined;
ui_lang?: string | undefined;
units?: "metric" | "imperial" | undefined;
}, {
ids: string[];
search_lang?: string | undefined;
ui_lang?: string | undefined;
units?: "metric" | "imperial" | undefined;
}>;
type WebSearchParams = z.infer<typeof WebSearchParamsSchema>;
type LocalSearchParams = z.infer<typeof LocalSearchParamsSchema>;
declare const SpellCheckSearchApiResponseSchema: z.ZodObject<{
type: z.ZodLiteral<"spellcheck">;
query: z.ZodObject<{
original: z.ZodString;
}, "strip", z.ZodTypeAny, {
original: string;
}, {
original: string;
}>;
results: z.ZodArray<z.ZodObject<{
query: z.ZodString;
}, "strip", z.ZodTypeAny, {
query: string;
}, {
query: string;
}>, "many">;
}, "strip", z.ZodTypeAny, {
type: "spellcheck";
results: {
query: string;
}[];
query: {
original: string;
};
}, {
type: "spellcheck";
results: {
query: string;
}[];
query: {
original: string;
};
}>;
type SpellCheckSearchApiResponse = z.infer<typeof SpellCheckSearchApiResponseSchema>;
declare const SuggestResultSchema: z.ZodObject<{
query: z.ZodString;
is_entity: z.ZodBoolean;
title: z.ZodString;
description: z.ZodString;
img: z.ZodString;
}, "strip", z.ZodTypeAny, {
img: string;
description: string;
query: string;
title: string;
is_entity: boolean;
}, {
img: string;
description: string;
query: string;
title: string;
is_entity: boolean;
}>;
declare const SuggestSearchApiResponseSchema: z.ZodObject<{
type: z.ZodLiteral<"suggest">;
query: z.ZodObject<{
original: z.ZodString;
}, "strip", z.ZodTypeAny, {
original: string;
}, {
original: string;
}>;
results: z.ZodArray<z.ZodObject<{
query: z.ZodString;
is_entity: z.ZodBoolean;
title: z.ZodString;
description: z.ZodString;
img: z.ZodString;
}, "strip", z.ZodTypeAny, {
img: string;
description: string;
query: string;
title: string;
is_entity: boolean;
}, {
img: string;
description: string;
query: string;
title: string;
is_entity: boolean;
}>, "many">;
}, "strip", z.ZodTypeAny, {
type: "suggest";
results: {
img: string;
description: string;
query: string;
title: string;
is_entity: boolean;
}[];
query: {
original: string;
};
}, {
type: "suggest";
results: {
img: string;
description: string;
query: string;
title: string;
is_entity: boolean;
}[];
query: {
original: string;
};
}>;
type SuggestResult = z.infer<typeof SuggestResultSchema>;
type SuggestSearchApiResponse = z.infer<typeof SuggestSearchApiResponseSchema>;
declare const summarizerSearchApiResponseSchema: z.ZodObject<{
type: z.ZodLiteral<"summarizer">;
status: z.ZodEnum<["failed", "complete"]>;
title: z.ZodString;
summary: z.ZodArray<z.ZodObject<{
type: z.ZodEnum<["token", "enum_item", "enum_start", "enum_end"]>;
data: z.ZodUnion<[z.ZodObject<{
uuid: z.ZodString;
name: z.ZodString;
url: z.ZodString;
text: z.ZodString;
images: z.ZodArray<z.ZodObject<{
thumbnail: z.ZodObject<{
src: z.ZodString;
original: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
src: string;
original?: string | undefined;
}, {
src: string;
original?: string | undefined;
}>;
url: z.ZodString;
properties: z.ZodObject<{
url: z.ZodString;
resized: z.ZodOptional<z.ZodString>;
placeholder: z.ZodString;
height: z.ZodOptional<z.ZodNumber>;
width: z.ZodOptional<z.ZodNumber>;
format: z.ZodOptional<z.ZodString>;
content_size: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
}, {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
}>;
text: z.ZodString;
}, "strip", z.ZodTypeAny, {
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
text: string;
}, {
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
text: string;
}>, "many">;
highlight: z.ZodArray<z.ZodObject<{
start: z.ZodNumber;
end: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
start: number;
end: number;
}, {
start: number;
end: number;
}>, "many">;
}, "strip", z.ZodTypeAny, {
name: string;
url: string;
text: string;
images: {
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
text: string;
}[];
uuid: string;
highlight: {
start: number;
end: number;
}[];
}, {
name: string;
url: string;
text: string;
images: {
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
text: string;
}[];
uuid: string;
highlight: {
start: number;
end: number;
}[];
}>, z.ZodString]>;
}, "strip", z.ZodTypeAny, {
type: "token" | "enum_item" | "enum_start" | "enum_end";
data: string | {
name: string;
url: string;
text: string;
images: {
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
text: string;
}[];
uuid: string;
highlight: {
start: number;
end: number;
}[];
};
}, {
type: "token" | "enum_item" | "enum_start" | "enum_end";
data: string | {
name: string;
url: string;
text: string;
images: {
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
text: string;
}[];
uuid: string;
highlight: {
start: number;
end: number;
}[];
};
}>, "many">;
enrichments: z.ZodObject<{
raw: z.ZodString;
images: z.ZodArray<z.ZodObject<{
thumbnail: z.ZodObject<{
src: z.ZodString;
original: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
src: string;
original?: string | undefined;
}, {
src: string;
original?: string | undefined;
}>;
url: z.ZodString;
properties: z.ZodObject<{
url: z.ZodString;
resized: z.ZodOptional<z.ZodString>;
placeholder: z.ZodString;
height: z.ZodOptional<z.ZodNumber>;
width: z.ZodOptional<z.ZodNumber>;
format: z.ZodOptional<z.ZodString>;
content_size: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
}, {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
}>;
text: z.ZodString;
}, "strip", z.ZodTypeAny, {
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
text: string;
}, {
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
text: string;
}>, "many">;
qa: z.ZodArray<z.ZodObject<{
answer: z.ZodString;
score: z.ZodNumber;
highlight: z.ZodObject<{
start: z.ZodNumber;
end: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
start: number;
end: number;
}, {
start: number;
end: number;
}>;
}, "strip", z.ZodTypeAny, {
score: number;
answer: string;
highlight: {
start: number;
end: number;
};
}, {
score: number;
answer: string;
highlight: {
start: number;
end: number;
};
}>, "many">;
entities: z.ZodArray<z.ZodObject<{
uuid: z.ZodString;
name: z.ZodString;
url: z.ZodString;
text: z.ZodString;
images: z.ZodArray<z.ZodObject<{
thumbnail: z.ZodObject<{
src: z.ZodString;
original: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
src: string;
original?: string | undefined;
}, {
src: string;
original?: string | undefined;
}>;
url: z.ZodString;
properties: z.ZodObject<{
url: z.ZodString;
resized: z.ZodOptional<z.ZodString>;
placeholder: z.ZodString;
height: z.ZodOptional<z.ZodNumber>;
width: z.ZodOptional<z.ZodNumber>;
format: z.ZodOptional<z.ZodString>;
content_size: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
}, {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
}>;
text: z.ZodString;
}, "strip", z.ZodTypeAny, {
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
text: string;
}, {
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
text: string;
}>, "many">;
highlight: z.ZodArray<z.ZodObject<{
start: z.ZodNumber;
end: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
start: number;
end: number;
}, {
start: number;
end: number;
}>, "many">;
}, "strip", z.ZodTypeAny, {
name: string;
url: string;
text: string;
images: {
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
text: string;
}[];
uuid: string;
highlight: {
start: number;
end: number;
}[];
}, {
name: string;
url: string;
text: string;
images: {
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
text: string;
}[];
uuid: string;
highlight: {
start: number;
end: number;
}[];
}>, "many">;
context: z.ZodArray<z.ZodObject<{
title: z.ZodString;
url: z.ZodString;
meta_url: z.ZodObject<{
scheme: z.ZodString;
netloc: z.ZodString;
hostname: z.ZodOptional<z.ZodString>;
favicon: z.ZodString;
path: z.ZodString;
}, "strip", z.ZodTypeAny, {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
}, {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
url: string;
meta_url: {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
};
title: string;
}, {
url: string;
meta_url: {
path: string;
scheme: string;
netloc: string;
favicon: string;
hostname?: string | undefined;
};
title: string;
}>, "many">;
}, "strip", z.ZodTypeAny, {
images: {
url: string;
thumbnail: {
src: string;
original?: string | undefined;
};
properties: {
url: string;
placeholder: string;
resized?: string | undefined;
height?: number | undefined;
width?: number | undefined;
format?: string | undefined;
content_size?: string | undefined;
};
text: string;
}[];
raw: string;
qa: {
score: number;
answer: string;
highlight: {
sta