import {z} from 'zod' export type GetApiV1GoogleSearchArgs = {q: string, gl?: string | undefined, hl?: string | undefined, num?: number | undefined, start?: number | undefined, domain?: string | undefined, device?: string | undefined, location?: (string | null) | undefined, lr?: (string | null) | undefined, tbs?: (string | null) | undefined, safe?: string | undefined, uule?: (string | null) | undefined, filter?: (number | null) | undefined, nfpr?: number | undefined, cr?: (string | null) | undefined, ludocid?: (string | null) | undefined, lsig?: (string | null) | undefined, kgmid?: (string | null) | undefined, si?: (string | null) | undefined, ibp?: (string | null) | undefined, uds?: (string | null) | undefined, ai_overview?: boolean | undefined, mode?: ('full' | 'fast') | undefined}; export type GetApiV1GoogleSearchOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const searchInformation = z.object({query_displayed: z.string(), total_results: z.number().int().nullable().optional(), time_taken: z.number().nullable().optional(), organic_results_state: z.string().nullable().optional(), url: z.string().nullable().optional()}); export const snippetLink = z.object({link: z.string(), link_text: z.string()}); export const aiOverviewListItem = z.object({title: z.string().nullable().optional(), snippet: z.string().nullable().optional(), snippet_links: z.array(snippetLink).optional()}); export const aiOverviewVideo = z.object({link: z.string(), channel: z.string().nullable().optional(), source: z.string().nullable().optional(), date: z.string().nullable().optional(), thumbnail: z.string().nullable().optional(), duration: z.string().nullable().optional()}); export const aiOverviewTextBlock = z.object({type: z.enum(["paragraph", "heading", "list", "video", "table"]), snippet: z.string().nullable().optional(), snippet_links: z.array(snippetLink).optional(), list_items: z.array(aiOverviewListItem).optional(), video: aiOverviewVideo.nullable().optional(), video_links: z.array(aiOverviewVideo).optional()}); export const aiOverviewReference = z.object({index: z.number().int(), title: z.string(), link: z.string(), snippet: z.string().nullable().optional(), source: z.string().nullable().optional(), logo: z.string().nullable().optional()}); export const aiOverview = z.object({text_blocks: z.array(aiOverviewTextBlock).optional(), references: z.array(aiOverviewReference).optional(), page_token: z.string().nullable().optional(), deferred: z.boolean().optional()}); export const sitelink = z.object({title: z.string(), link: z.string().nullable().optional(), snippet: z.string().nullable().optional()}); export const inlineSitelink = z.object({title: z.string().nullable().optional(), date: z.string().nullable().optional()}); export const organicResult = z.object({position: z.number().int(), title: z.string(), link: z.string(), displayed_link: z.string().nullable().optional(), snippet: z.string().nullable().optional(), highlighted_keywords: z.array(z.string()).optional(), source: z.string().nullable().optional(), favicon: z.string().nullable().optional(), sitelinks: z.array(sitelink).optional(), inline_sitelinks: z.array(inlineSitelink).optional(), date: z.string().nullable().optional(), rank: z.number().int().nullable().optional(), page_rank: z.number().int().nullable().optional()}); export const adResult = z.object({position: z.number().int().nullable().optional(), title: z.string(), link: z.string(), displayed_link: z.string().nullable().optional(), description: z.string().nullable().optional(), extensions: z.array(z.string()).optional()}); export const knowledgeGraph = z.object({title: z.string().nullable().optional(), type: z.string().nullable().optional(), description: z.string().nullable().optional(), image: z.string().nullable().optional(), source: z.string().nullable().optional(), attributes: z.record(z.string(), z.string()).optional()}); export const gpsCoordinates = z.object({lat: z.number(), lng: z.number()}); export const localResult = z.object({title: z.string(), place_id: z.string().nullable().optional(), rating: z.number().nullable().optional(), reviews: z.number().int().nullable().optional(), address: z.string().nullable().optional(), phone: z.string().nullable().optional(), type: z.string().nullable().optional(), gps_coordinates: gpsCoordinates.nullable().optional()}); export const relatedQuestion = z.object({question: z.string(), rank: z.number().int().nullable().optional(), title: z.string().nullable().optional(), link: z.string().nullable().optional(), snippet: z.string().nullable().optional(), displayed_link: z.string().nullable().optional(), source_logo: z.string().nullable().optional()}); export const relatedSearch = z.object({query: z.string(), link: z.string().nullable().optional()}); export const newsResult = z.object({title: z.string(), link: z.string().nullable().optional(), source: z.string().nullable().optional(), date: z.string().nullable().optional(), thumbnail: z.string().nullable().optional()}); export const inlineVideo = z.object({title: z.string(), source: z.string().nullable().optional(), thumbnail: z.string().nullable().optional(), platform: z.string().nullable().optional(), duration: z.string().nullable().optional(), date: z.string().nullable().optional(), position: z.number().int().nullable().optional()}); export const shoppingResult = z.object({title: z.string(), price: z.string().nullable().optional(), source: z.string().nullable().optional(), link: z.string().nullable().optional(), thumbnail: z.string().nullable().optional(), rating: z.number().nullable().optional(), reviews: z.number().int().nullable().optional()}); export const pagination = z.object({current: z.union([z.number().int(), z.string()]).optional(), next: z.string().nullable().optional(), total_results: z.number().int().nullable().optional(), total_pages: z.number().int().nullable().optional(), page_no: z.record(z.string(), z.string()).optional()}); export const googleSearchResponse = z.object({search_information: searchInformation, ai_overview: aiOverview.nullable().optional(), organic_results: z.array(organicResult).optional(), ads: z.array(adResult).optional(), knowledge_graph: knowledgeGraph.nullable().optional(), local_results: z.array(localResult).optional(), related_questions: z.array(relatedQuestion).optional(), related_searches: z.array(relatedSearch).optional(), news_results: z.array(newsResult).optional(), inline_videos: z.array(inlineVideo).optional(), shopping_results: z.array(shoppingResult).optional(), pagination: pagination}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Google web search * * GET /v1/google/search */ export const getApiV1GoogleSearch = async (args: GetApiV1GoogleSearchArgs, options?: GetApiV1GoogleSearchOptions) => { const {baseUrl = "https://scrapebadger.com", fetch: fetchFn = fetch, apiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.q != null) query.append("q", String(args.q)) if (args.gl != null) query.append("gl", String(args.gl)) if (args.hl != null) query.append("hl", String(args.hl)) if (args.num != null) query.append("num", String(args.num)) if (args.start != null) query.append("start", String(args.start)) if (args.domain != null) query.append("domain", String(args.domain)) if (args.device != null) query.append("device", String(args.device)) if (args.location != null) query.append("location", String(args.location)) if (args.lr != null) query.append("lr", String(args.lr)) if (args.tbs != null) query.append("tbs", String(args.tbs)) if (args.safe != null) query.append("safe", String(args.safe)) if (args.uule != null) query.append("uule", String(args.uule)) if (args.filter != null) query.append("filter", String(args.filter)) if (args.nfpr != null) query.append("nfpr", String(args.nfpr)) if (args.cr != null) query.append("cr", String(args.cr)) if (args.ludocid != null) query.append("ludocid", String(args.ludocid)) if (args.lsig != null) query.append("lsig", String(args.lsig)) if (args.kgmid != null) query.append("kgmid", String(args.kgmid)) if (args.si != null) query.append("si", String(args.si)) if (args.ibp != null) query.append("ibp", String(args.ibp)) if (args.uds != null) query.append("uds", String(args.uds)) if (args.ai_overview != null) query.append("ai_overview", String(args.ai_overview)) if (args.mode != null) query.append("mode", String(args.mode)) if (apiKey !== undefined) headers.set("x-api-key", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/v1/google/search${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(googleSearchResponse, await res.json()) };