npm - scavio - Versions diffs - 0.24.1 → 0.25.0 - Mend

scavio 0.24.1 → 0.25.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/dist/index.d.cts CHANGED Viewed

@@ -377,11 +377,128 @@ interface GoogleTrendingOptions {
     status?: "all" | "active";
     [key: string]: unknown;
 }
+interface GoogleCustomSearchOptions {
+    /** Search query. */
+    q: string;
+    /** Accepted and echoed back; results come from the whole web. */
+    cx?: string;
+    /** Results to return, 1-10 (default 10). */
+    num?: number;
+    /** 1-based index of the first result (default 1); start + num <= 100. */
+    start?: number;
+    /** Country of the search (ISO 3166-1 alpha-2, e.g. 'us'). */
+    gl?: string;
+    /** UI language (e.g. 'en', 'zh-TW'). */
+    hl?: string;
+    /** Language restrict (e.g. 'lang_en'). */
+    lr?: string;
+    /** Country restrict, a single value (e.g. 'countryUS'). */
+    cr?: string;
+    /** SafeSearch (default 'off'). */
+    safe?: "active" | "off";
+    /** '0' turns off duplicate-content filtering. */
+    filter?: "0" | "1";
+    /** d[N], w[N], m[N] or y[N] (e.g. 'm6'). Sent as dateRestrict. */
+    date_restrict?: string;
+    /** Site to include or exclude (e.g. 'example.com'); enforced on results. Sent as siteSearch. */
+    site_search?: string;
+    /** 'i' include site_search (default), 'e' exclude it. Sent as siteSearchFilter. */
+    site_search_filter?: "i" | "e";
+    /** Phrase every result must contain. Sent as exactTerms. */
+    exact_terms?: string;
+    /** Word or phrase no result may contain. Sent as excludeTerms. */
+    exclude_terms?: string;
+    /** Space-separated terms; each result contains at least one. Sent as orTerms. */
+    or_terms?: string;
+    /** Extra terms ANDed onto the query. */
+    hq?: string;
+    /** File extension to restrict to (e.g. 'pdf'). Sent as fileType. */
+    file_type?: string;
+    /** Google domain to search (e.g. 'google.co.uk'). */
+    googlehost?: string;
+    /** Canonical location name (Scavio extension). */
+    location?: string;
+    /** Device to emulate (Scavio extension). */
+    device?: "desktop" | "mobile";
+    /** Disable spelling autocorrection when true (Scavio extension). */
+    nfpr?: boolean;
+    /** Skip the 24h result cache when true (Scavio extension). */
+    no_cache?: boolean;
+    [key: string]: unknown;
+}
+/** One result in the Custom Search JSON API format. */
+interface GoogleCustomSearchItem {
+    kind: "customsearch#result";
+    title: string;
+    htmlTitle: string;
+    link: string;
+    displayLink: string;
+    snippet: string;
+    htmlSnippet: string;
+    formattedUrl: string;
+    htmlFormattedUrl: string;
+    pagemap?: {
+        cse_thumbnail?: {
+            src: string;
+        }[];
+        [key: string]: unknown;
+    };
+}
+/** queries.request / nextPage / previousPage entry. */
+interface GoogleCustomSearchQuery {
+    title: string;
+    totalResults: string;
+    searchTerms: string;
+    count: number;
+    startIndex: number;
+    inputEncoding: string;
+    outputEncoding: string;
+    safe: string;
+    cx?: string;
+    [key: string]: unknown;
+}
+/** customsearch#search response, plus Scavio's billing object. */
+interface GoogleCustomSearchResponse {
+    kind: "customsearch#search";
+    url: {
+        type: string;
+        template: string;
+    };
+    queries: {
+        request: GoogleCustomSearchQuery[];
+        nextPage?: GoogleCustomSearchQuery[];
+        previousPage?: GoogleCustomSearchQuery[];
+    };
+    searchInformation: {
+        searchTime: number;
+        formattedSearchTime: string;
+        totalResults: string;
+        formattedTotalResults: string;
+    };
+    /** Omitted when there are no results, as in the Custom Search JSON API. */
+    items?: GoogleCustomSearchItem[];
+    scavio: {
+        credits_used: number;
+        credits_remaining: number;
+        cached: boolean;
+        response_time: number;
+    };
+    [key: string]: unknown;
+}
 declare class GoogleNamespace {
     private client;
     constructor(client: Scavio);
     /** Google SERP search (includes the AI Overview when Google returns one). */
     search(options: GoogleSearchOptions): Promise<Record<string, unknown>>;
+    /**
+     * Google search in the Custom Search JSON API format: a drop-in for cse.list.
+     * Returns customsearch#search (items[], searchInformation, queries.nextPage)
+     * plus a scavio billing object, so CSE parsing code keeps working. For the
+     * full SERP (knowledge graph, AI overview, People Also Ask) use search().
+     * Unsupported CSE params (image search, sort, rights) throw BadRequestError.
+     * 1 credit.
+     */
+    customSearch(options: GoogleCustomSearchOptions): Promise<GoogleCustomSearchResponse>;
     /** Google AI Mode answer. */
     aiMode(options: GoogleAiModeOptions): Promise<Record<string, unknown>>;
     /** Google Maps local results. */
@@ -5898,4 +6015,4 @@ declare class ScavioJobTimeoutError extends ScavioError {
     constructor(jobType: "crawl" | "batch", jobId: string, statusUrl: string, lastStatus: string);
 }
-export { type AirbnbListingOptions, AirbnbNamespace, type AirbnbReviewsOptions, type AirbnbSearchOptions, AmazonNamespace, type AmazonOffersOptions, type AmazonProductOptions, type AmazonSearchOptions, type AppStoreAppOptions, AppStoreNamespace, type AppStoreReviewsOptions, type AppStoreSearchOptions, BadRequestError, type BookingHotelOptions, BookingNamespace, type BookingReviewsOptions, type BookingSearchOptions, CapterraNamespace, type CapterraProductOptions, type CapterraReviewsOptions, type CapterraSearchOptions, type CompaniesHouseCompanyOptions, type CompaniesHouseFilingHistoryOptions, CompaniesHouseNamespace, type CompaniesHouseOfficersOptions, type CompaniesHouseSearchOptions, type CostcoAutocompleteOptions, type CostcoAvailabilityOptions, type CostcoCategoriesOptions, type CostcoCategoryOptions, type CostcoClearanceOptions, type CostcoCountry, type CostcoCouponsOptions, type CostcoDealType, type CostcoDealsOptions, type CostcoGasOptions, type CostcoListingFilters, type CostcoNaCountry, CostcoNamespace, type CostcoPriceCode, type CostcoPricesOptions, type CostcoProductOptions, type CostcoReviewsOptions, type CostcoSearchOptions, type CostcoSortBy, type CostcoWarehousesOptions, DEFAULT_MAX_REQUESTS_PER_SECOND, EbayNamespace, type EbayProductOptions, type EbaySearchOptions, type EbaySellerOptions, type Extract, type ExtractBatchOptions, type ExtractCrawlOptions, type ExtractFormat, type ExtractJobCreatedResponse, type ExtractJobRequestOptions, type ExtractJobResult, type ExtractJobState, type ExtractJobStatusQuery, type ExtractJobStatusResponse, type ExtractJobSummary, type ExtractJobSummaryResponse, type ExtractJobWaitResponse, type ExtractMapLink, type ExtractMapOptions, type ExtractMapResponse, type ExtractMode, ExtractNamespace, type ExtractOptions, type ExtractSitemapMode, G2Namespace, type G2ProductOptions, type G2ReviewsOptions, type G2SearchOptions, type GlassdoorCompaniesOptions, type GlassdoorCompanyOptions, GlassdoorNamespace, type GlassdoorReviewsOptions, type GlassdoorSalariesOptions, type GoogleAdsAdvertisersOptions, type GoogleAdsCreativeOptions, GoogleAdsNamespace, type GoogleAdsSearchOptions, type GoogleAiModeOptions, type GoogleFlightsOptions, type GoogleHotelsDetailOptions, type GoogleHotelsOptions, type GoogleMapsPlaceOptions, type GoogleMapsReviewsOptions, type GoogleMapsSearchOptions, GoogleNamespace, type GoogleNewsOptions, type GooglePlayAppOptions, GooglePlayNamespace, type GooglePlayReviewsOptions, type GooglePlaySearchOptions, type GoogleSearchOptions, type GoogleShoppingOptions, type GoogleShoppingProductOptions, type GoogleShoppingStoresOptions, type GoogleTrendingOptions, type GoogleTrendsOptions, HomeDepotNamespace, type HomeDepotProductOptions, type HomeDepotReviewsOptions, type HomeDepotSearchOptions, type IndeedCompanyOptions, type IndeedCompanyReviewsOptions, type IndeedJobOptions, IndeedNamespace, type IndeedSearchOptions, type InstagramCommentRepliesOptions, type InstagramFollowOptions, type InstagramHighlightStoriesOptions, type InstagramKeywordOptions, type InstagramMusicPostsOptions, InstagramNamespace, type InstagramPostCommentsOptions, type InstagramPostLikersOptions, type InstagramPostOptions, type InstagramProfileOptions, type InstagramSearchOptions, type InstagramStoriesOptions, type InstagramUserFeedOptions, type InstagramUserRefOptions, InsufficientCreditsError, InvalidAPIKeyError, type KuaishouCommentRepliesOptions, KuaishouNamespace, type KuaishouProfileOptions, type KuaishouSearchLiveOptions, type KuaishouSearchOptions, type KuaishouSearchUsersOptions, type KuaishouSearchVideosOptions, type KuaishouTagFeedOptions, type KuaishouTrendingOptions, type KuaishouUserLiveOptions, type KuaishouUserPostsOptions, type KuaishouUserResolveOptions, type KuaishouVideoCommentsOptions, type KuaishouVideoOptions, type KuaishouVideosBatchOptions, type LinkedInCompanyOptions, type LinkedInCompanyPostsOptions, type LinkedInCompanyPostsRequest, type LinkedInCompanyRefOptions, type LinkedInJobOptions, LinkedInNamespace, type LinkedInPersonContactOptions, type LinkedInPersonOptions, type LinkedInPersonPostsOptions, type LinkedInPersonPostsRequest, type LinkedInPersonRefOptions, type LinkedInPostCommentsOptions, type LinkedInPostOptions, type LinkedInSearchJobsOptions, type LinkedInSearchPeopleOptions, type LinkedInSearchPostsOptions, MAX_REQUESTS_PER_SECOND, type MercadoLibreBestSellersCountry, type MercadoLibreBestSellersOptions, type MercadoLibreCondition, type MercadoLibreCountry, type MercadoLibreDiscount, MercadoLibreNamespace, type MercadoLibreProductOptions, type MercadoLibreQuestionsOptions, type MercadoLibreReviewsOptions, type MercadoLibreSearchOptions, type MercadoLibreSort, type MetaAdsAdOptions, type MetaAdsAdvertiserOptions, MetaAdsNamespace, type MetaAdsSearchOptions, MissingAPIKeyError, NotFoundError, RateLimitError, type RealtorAgentOptions, type RealtorAgentsOptions, type RealtorListingStatus, type RealtorLocationsOptions, type RealtorMarketOptions, RealtorNamespace, type RealtorPropertyOptions, type RealtorPropertyType, type RealtorSearchOptions, type RealtorSort, type RedditCommentRepliesOptions, type RedditCommentSearchSort, type RedditFeedSort, RedditNamespace, type RedditPopularOptions, type RedditPostCommentsOptions, type RedditPostOptions, type RedditSearchCommentsOptions, type RedditSearchOptions, type RedditSearchSubredditsOptions, type RedditSearchSuggestionsOptions, type RedditSort, type RedditSubredditOptions, type RedditSubredditPostsOptions, type RedditUserFeedOptions, type RedditUserOptions, type RedfinMarketOptions, RedfinNamespace, type RedfinPropertyOptions, type RedfinSearchOptions, type RightmoveAgentOptions, type RightmoveAgentsOptions, type RightmoveExclude, type RightmoveFurnishing, type RightmoveLetType, type RightmoveListingStatus, type RightmoveLocationsOptions, type RightmoveMustHave, RightmoveNamespace, type RightmovePropertyOptions, type RightmovePropertyType, type RightmoveRadius, type RightmoveSearchOptions, type RightmoveSoldOptions, type RightmoveSoldPropertyOptions, type RightmoveSoldPropertyType, type RightmoveSoldSort, type RightmoveSort, type RightmoveTenure, type SECCompanyOptions, type SECConceptOptions, type SECFactsOptions, type SECFilingsOptions, type SECLookupOptions, SECNamespace, type SECSearchOptions, Scavio, ScavioAPIError, type ScavioConfig, ScavioConnectionError, ScavioError, ScavioJobTimeoutError, ScavioTimeoutError, type TargetCategoryOptions, TargetNamespace, type TargetProductOptions, type TargetReviewsOptions, type TargetSearchOptions, ThreadsNamespace, type ThreadsPostCommentsOptions, type ThreadsPostOptions, type ThreadsProfileOptions, type ThreadsSearchUsersOptions, type ThreadsUserPostsOptions, type ThreadsUserRepliesOptions, type TikTokCommentRepliesOptions, type TikTokHashtagOptions, type TikTokHashtagVideosOptions, type TikTokMusicChartOptions, type TikTokMusicOptions, type TikTokMusicVideosOptions, TikTokNamespace, type TikTokPlaylistVideosOptions, type TikTokProfileOptions, type TikTokSearchMusicOptions, type TikTokSearchSuggestionsOptions, type TikTokSearchUsersOptions, type TikTokSearchVideosOptions, type TikTokShopCategoryProductsOptions, type TikTokShopListingRegion, TikTokShopNamespace, type TikTokShopProductOptions, type TikTokShopProductReviewsOptions, type TikTokShopRegion, type TikTokShopResolveOptions, type TikTokShopReviewSort, type TikTokShopSearchOptions, type TikTokShopShopProductsOptions, type TikTokShopSuggestionsOptions, type TikTokTrendingVideosOptions, type TikTokUserFollowersOptions, type TikTokUserFollowingsOptions, type TikTokUserPlaylistsOptions, type TikTokUserPostsOptions, type TikTokUserSimilarOptions, type TikTokUsernameOptions, type TikTokVideoCommentsOptions, type TikTokVideoOptions, type TikTokVideoTranscriptOptions, type TripadvisorLocationOptions, type TripadvisorLocationsOptions, TripadvisorNamespace, type TripadvisorReviewsOptions, type TripadvisorSearchOptions, type TrustpilotBusinessAddress, type TrustpilotBusinessOptions, type TrustpilotCategoriesOptions, type TrustpilotCategoryOptions, type TrustpilotCategorySort, TrustpilotNamespace, type TrustpilotReviewOptions, type TrustpilotReviewsDateRange, type TrustpilotReviewsOptions, type TrustpilotReviewsSort, type TrustpilotSearchOptions, type TrustpilotStars, type WalmartCategoryOptions, WalmartNamespace, type WalmartOffersOptions, type WalmartProductOptions, type WalmartReviewsOptions, type WalmartSearchOptions, type WalmartSellerOptions, type WalmartSellerProductsOptions, type WalmartStore, type WalmartStoresData, type WalmartStoresOptions, type WalmartStoresResponse, type XCommunityOptions, type XCommunityTweetsOptions, XNamespace, type XSearchCommunitiesOptions, type XSearchOptions, type XTrendingOptions, type XTweetCommentsOptions, type XTweetOptions, type XTweetRetweetersOptions, type XUserFeedOptions, type XUserOptions, type YelpBusinessOptions, YelpNamespace, type YelpReviewsOptions, type YelpSearchOptions, type YouTubeChannelCommunityOptions, type YouTubeChannelOptions, type YouTubeChannelResolveOptions, type YouTubeChannelSearchOptions, type YouTubeChannelShortsOptions, type YouTubeChannelVideosOptions, type YouTubeCommentRepliesOptions, type YouTubeCommentsOptions, type YouTubeCommunityPostCommentsOptions, type YouTubeCommunityPostOptions, type YouTubeMetadataOptions, YouTubeNamespace, type YouTubeRelatedOptions, type YouTubeSearchOptions, type YouTubeShortsOptions, type YouTubeStreamsOptions, type YouTubeSuggestionsOptions, type YouTubeTranscriptOptions, type YouTubeVideoOptions, type ZillowAgentReviewsOptions, ZillowNamespace, type ZillowPropertyOptions, type ZillowSearchOptions, verifyWebhook };
+export { type AirbnbListingOptions, AirbnbNamespace, type AirbnbReviewsOptions, type AirbnbSearchOptions, AmazonNamespace, type AmazonOffersOptions, type AmazonProductOptions, type AmazonSearchOptions, type AppStoreAppOptions, AppStoreNamespace, type AppStoreReviewsOptions, type AppStoreSearchOptions, BadRequestError, type BookingHotelOptions, BookingNamespace, type BookingReviewsOptions, type BookingSearchOptions, CapterraNamespace, type CapterraProductOptions, type CapterraReviewsOptions, type CapterraSearchOptions, type CompaniesHouseCompanyOptions, type CompaniesHouseFilingHistoryOptions, CompaniesHouseNamespace, type CompaniesHouseOfficersOptions, type CompaniesHouseSearchOptions, type CostcoAutocompleteOptions, type CostcoAvailabilityOptions, type CostcoCategoriesOptions, type CostcoCategoryOptions, type CostcoClearanceOptions, type CostcoCountry, type CostcoCouponsOptions, type CostcoDealType, type CostcoDealsOptions, type CostcoGasOptions, type CostcoListingFilters, type CostcoNaCountry, CostcoNamespace, type CostcoPriceCode, type CostcoPricesOptions, type CostcoProductOptions, type CostcoReviewsOptions, type CostcoSearchOptions, type CostcoSortBy, type CostcoWarehousesOptions, DEFAULT_MAX_REQUESTS_PER_SECOND, EbayNamespace, type EbayProductOptions, type EbaySearchOptions, type EbaySellerOptions, type Extract, type ExtractBatchOptions, type ExtractCrawlOptions, type ExtractFormat, type ExtractJobCreatedResponse, type ExtractJobRequestOptions, type ExtractJobResult, type ExtractJobState, type ExtractJobStatusQuery, type ExtractJobStatusResponse, type ExtractJobSummary, type ExtractJobSummaryResponse, type ExtractJobWaitResponse, type ExtractMapLink, type ExtractMapOptions, type ExtractMapResponse, type ExtractMode, ExtractNamespace, type ExtractOptions, type ExtractSitemapMode, G2Namespace, type G2ProductOptions, type G2ReviewsOptions, type G2SearchOptions, type GlassdoorCompaniesOptions, type GlassdoorCompanyOptions, GlassdoorNamespace, type GlassdoorReviewsOptions, type GlassdoorSalariesOptions, type GoogleAdsAdvertisersOptions, type GoogleAdsCreativeOptions, GoogleAdsNamespace, type GoogleAdsSearchOptions, type GoogleAiModeOptions, type GoogleCustomSearchItem, type GoogleCustomSearchOptions, type GoogleCustomSearchQuery, type GoogleCustomSearchResponse, type GoogleFlightsOptions, type GoogleHotelsDetailOptions, type GoogleHotelsOptions, type GoogleMapsPlaceOptions, type GoogleMapsReviewsOptions, type GoogleMapsSearchOptions, GoogleNamespace, type GoogleNewsOptions, type GooglePlayAppOptions, GooglePlayNamespace, type GooglePlayReviewsOptions, type GooglePlaySearchOptions, type GoogleSearchOptions, type GoogleShoppingOptions, type GoogleShoppingProductOptions, type GoogleShoppingStoresOptions, type GoogleTrendingOptions, type GoogleTrendsOptions, HomeDepotNamespace, type HomeDepotProductOptions, type HomeDepotReviewsOptions, type HomeDepotSearchOptions, type IndeedCompanyOptions, type IndeedCompanyReviewsOptions, type IndeedJobOptions, IndeedNamespace, type IndeedSearchOptions, type InstagramCommentRepliesOptions, type InstagramFollowOptions, type InstagramHighlightStoriesOptions, type InstagramKeywordOptions, type InstagramMusicPostsOptions, InstagramNamespace, type InstagramPostCommentsOptions, type InstagramPostLikersOptions, type InstagramPostOptions, type InstagramProfileOptions, type InstagramSearchOptions, type InstagramStoriesOptions, type InstagramUserFeedOptions, type InstagramUserRefOptions, InsufficientCreditsError, InvalidAPIKeyError, type KuaishouCommentRepliesOptions, KuaishouNamespace, type KuaishouProfileOptions, type KuaishouSearchLiveOptions, type KuaishouSearchOptions, type KuaishouSearchUsersOptions, type KuaishouSearchVideosOptions, type KuaishouTagFeedOptions, type KuaishouTrendingOptions, type KuaishouUserLiveOptions, type KuaishouUserPostsOptions, type KuaishouUserResolveOptions, type KuaishouVideoCommentsOptions, type KuaishouVideoOptions, type KuaishouVideosBatchOptions, type LinkedInCompanyOptions, type LinkedInCompanyPostsOptions, type LinkedInCompanyPostsRequest, type LinkedInCompanyRefOptions, type LinkedInJobOptions, LinkedInNamespace, type LinkedInPersonContactOptions, type LinkedInPersonOptions, type LinkedInPersonPostsOptions, type LinkedInPersonPostsRequest, type LinkedInPersonRefOptions, type LinkedInPostCommentsOptions, type LinkedInPostOptions, type LinkedInSearchJobsOptions, type LinkedInSearchPeopleOptions, type LinkedInSearchPostsOptions, MAX_REQUESTS_PER_SECOND, type MercadoLibreBestSellersCountry, type MercadoLibreBestSellersOptions, type MercadoLibreCondition, type MercadoLibreCountry, type MercadoLibreDiscount, MercadoLibreNamespace, type MercadoLibreProductOptions, type MercadoLibreQuestionsOptions, type MercadoLibreReviewsOptions, type MercadoLibreSearchOptions, type MercadoLibreSort, type MetaAdsAdOptions, type MetaAdsAdvertiserOptions, MetaAdsNamespace, type MetaAdsSearchOptions, MissingAPIKeyError, NotFoundError, RateLimitError, type RealtorAgentOptions, type RealtorAgentsOptions, type RealtorListingStatus, type RealtorLocationsOptions, type RealtorMarketOptions, RealtorNamespace, type RealtorPropertyOptions, type RealtorPropertyType, type RealtorSearchOptions, type RealtorSort, type RedditCommentRepliesOptions, type RedditCommentSearchSort, type RedditFeedSort, RedditNamespace, type RedditPopularOptions, type RedditPostCommentsOptions, type RedditPostOptions, type RedditSearchCommentsOptions, type RedditSearchOptions, type RedditSearchSubredditsOptions, type RedditSearchSuggestionsOptions, type RedditSort, type RedditSubredditOptions, type RedditSubredditPostsOptions, type RedditUserFeedOptions, type RedditUserOptions, type RedfinMarketOptions, RedfinNamespace, type RedfinPropertyOptions, type RedfinSearchOptions, type RightmoveAgentOptions, type RightmoveAgentsOptions, type RightmoveExclude, type RightmoveFurnishing, type RightmoveLetType, type RightmoveListingStatus, type RightmoveLocationsOptions, type RightmoveMustHave, RightmoveNamespace, type RightmovePropertyOptions, type RightmovePropertyType, type RightmoveRadius, type RightmoveSearchOptions, type RightmoveSoldOptions, type RightmoveSoldPropertyOptions, type RightmoveSoldPropertyType, type RightmoveSoldSort, type RightmoveSort, type RightmoveTenure, type SECCompanyOptions, type SECConceptOptions, type SECFactsOptions, type SECFilingsOptions, type SECLookupOptions, SECNamespace, type SECSearchOptions, Scavio, ScavioAPIError, type ScavioConfig, ScavioConnectionError, ScavioError, ScavioJobTimeoutError, ScavioTimeoutError, type TargetCategoryOptions, TargetNamespace, type TargetProductOptions, type TargetReviewsOptions, type TargetSearchOptions, ThreadsNamespace, type ThreadsPostCommentsOptions, type ThreadsPostOptions, type ThreadsProfileOptions, type ThreadsSearchUsersOptions, type ThreadsUserPostsOptions, type ThreadsUserRepliesOptions, type TikTokCommentRepliesOptions, type TikTokHashtagOptions, type TikTokHashtagVideosOptions, type TikTokMusicChartOptions, type TikTokMusicOptions, type TikTokMusicVideosOptions, TikTokNamespace, type TikTokPlaylistVideosOptions, type TikTokProfileOptions, type TikTokSearchMusicOptions, type TikTokSearchSuggestionsOptions, type TikTokSearchUsersOptions, type TikTokSearchVideosOptions, type TikTokShopCategoryProductsOptions, type TikTokShopListingRegion, TikTokShopNamespace, type TikTokShopProductOptions, type TikTokShopProductReviewsOptions, type TikTokShopRegion, type TikTokShopResolveOptions, type TikTokShopReviewSort, type TikTokShopSearchOptions, type TikTokShopShopProductsOptions, type TikTokShopSuggestionsOptions, type TikTokTrendingVideosOptions, type TikTokUserFollowersOptions, type TikTokUserFollowingsOptions, type TikTokUserPlaylistsOptions, type TikTokUserPostsOptions, type TikTokUserSimilarOptions, type TikTokUsernameOptions, type TikTokVideoCommentsOptions, type TikTokVideoOptions, type TikTokVideoTranscriptOptions, type TripadvisorLocationOptions, type TripadvisorLocationsOptions, TripadvisorNamespace, type TripadvisorReviewsOptions, type TripadvisorSearchOptions, type TrustpilotBusinessAddress, type TrustpilotBusinessOptions, type TrustpilotCategoriesOptions, type TrustpilotCategoryOptions, type TrustpilotCategorySort, TrustpilotNamespace, type TrustpilotReviewOptions, type TrustpilotReviewsDateRange, type TrustpilotReviewsOptions, type TrustpilotReviewsSort, type TrustpilotSearchOptions, type TrustpilotStars, type WalmartCategoryOptions, WalmartNamespace, type WalmartOffersOptions, type WalmartProductOptions, type WalmartReviewsOptions, type WalmartSearchOptions, type WalmartSellerOptions, type WalmartSellerProductsOptions, type WalmartStore, type WalmartStoresData, type WalmartStoresOptions, type WalmartStoresResponse, type XCommunityOptions, type XCommunityTweetsOptions, XNamespace, type XSearchCommunitiesOptions, type XSearchOptions, type XTrendingOptions, type XTweetCommentsOptions, type XTweetOptions, type XTweetRetweetersOptions, type XUserFeedOptions, type XUserOptions, type YelpBusinessOptions, YelpNamespace, type YelpReviewsOptions, type YelpSearchOptions, type YouTubeChannelCommunityOptions, type YouTubeChannelOptions, type YouTubeChannelResolveOptions, type YouTubeChannelSearchOptions, type YouTubeChannelShortsOptions, type YouTubeChannelVideosOptions, type YouTubeCommentRepliesOptions, type YouTubeCommentsOptions, type YouTubeCommunityPostCommentsOptions, type YouTubeCommunityPostOptions, type YouTubeMetadataOptions, YouTubeNamespace, type YouTubeRelatedOptions, type YouTubeSearchOptions, type YouTubeShortsOptions, type YouTubeStreamsOptions, type YouTubeSuggestionsOptions, type YouTubeTranscriptOptions, type YouTubeVideoOptions, type ZillowAgentReviewsOptions, ZillowNamespace, type ZillowPropertyOptions, type ZillowSearchOptions, verifyWebhook };

package/dist/index.d.ts CHANGED Viewed

@@ -377,11 +377,128 @@ interface GoogleTrendingOptions {
     status?: "all" | "active";
     [key: string]: unknown;
 }
+interface GoogleCustomSearchOptions {
+    /** Search query. */
+    q: string;
+    /** Accepted and echoed back; results come from the whole web. */
+    cx?: string;
+    /** Results to return, 1-10 (default 10). */
+    num?: number;
+    /** 1-based index of the first result (default 1); start + num <= 100. */
+    start?: number;
+    /** Country of the search (ISO 3166-1 alpha-2, e.g. 'us'). */
+    gl?: string;
+    /** UI language (e.g. 'en', 'zh-TW'). */
+    hl?: string;
+    /** Language restrict (e.g. 'lang_en'). */
+    lr?: string;
+    /** Country restrict, a single value (e.g. 'countryUS'). */
+    cr?: string;
+    /** SafeSearch (default 'off'). */
+    safe?: "active" | "off";
+    /** '0' turns off duplicate-content filtering. */
+    filter?: "0" | "1";
+    /** d[N], w[N], m[N] or y[N] (e.g. 'm6'). Sent as dateRestrict. */
+    date_restrict?: string;
+    /** Site to include or exclude (e.g. 'example.com'); enforced on results. Sent as siteSearch. */
+    site_search?: string;
+    /** 'i' include site_search (default), 'e' exclude it. Sent as siteSearchFilter. */
+    site_search_filter?: "i" | "e";
+    /** Phrase every result must contain. Sent as exactTerms. */
+    exact_terms?: string;
+    /** Word or phrase no result may contain. Sent as excludeTerms. */
+    exclude_terms?: string;
+    /** Space-separated terms; each result contains at least one. Sent as orTerms. */
+    or_terms?: string;
+    /** Extra terms ANDed onto the query. */
+    hq?: string;
+    /** File extension to restrict to (e.g. 'pdf'). Sent as fileType. */
+    file_type?: string;
+    /** Google domain to search (e.g. 'google.co.uk'). */
+    googlehost?: string;
+    /** Canonical location name (Scavio extension). */
+    location?: string;
+    /** Device to emulate (Scavio extension). */
+    device?: "desktop" | "mobile";
+    /** Disable spelling autocorrection when true (Scavio extension). */
+    nfpr?: boolean;
+    /** Skip the 24h result cache when true (Scavio extension). */
+    no_cache?: boolean;
+    [key: string]: unknown;
+}
+/** One result in the Custom Search JSON API format. */
+interface GoogleCustomSearchItem {
+    kind: "customsearch#result";
+    title: string;
+    htmlTitle: string;
+    link: string;
+    displayLink: string;
+    snippet: string;
+    htmlSnippet: string;
+    formattedUrl: string;
+    htmlFormattedUrl: string;
+    pagemap?: {
+        cse_thumbnail?: {
+            src: string;
+        }[];
+        [key: string]: unknown;
+    };
+}
+/** queries.request / nextPage / previousPage entry. */
+interface GoogleCustomSearchQuery {
+    title: string;
+    totalResults: string;
+    searchTerms: string;
+    count: number;
+    startIndex: number;
+    inputEncoding: string;
+    outputEncoding: string;
+    safe: string;
+    cx?: string;
+    [key: string]: unknown;
+}
+/** customsearch#search response, plus Scavio's billing object. */
+interface GoogleCustomSearchResponse {
+    kind: "customsearch#search";
+    url: {
+        type: string;
+        template: string;
+    };
+    queries: {
+        request: GoogleCustomSearchQuery[];
+        nextPage?: GoogleCustomSearchQuery[];
+        previousPage?: GoogleCustomSearchQuery[];
+    };
+    searchInformation: {
+        searchTime: number;
+        formattedSearchTime: string;
+        totalResults: string;
+        formattedTotalResults: string;
+    };
+    /** Omitted when there are no results, as in the Custom Search JSON API. */
+    items?: GoogleCustomSearchItem[];
+    scavio: {
+        credits_used: number;
+        credits_remaining: number;
+        cached: boolean;
+        response_time: number;
+    };
+    [key: string]: unknown;
+}
 declare class GoogleNamespace {
     private client;
     constructor(client: Scavio);
     /** Google SERP search (includes the AI Overview when Google returns one). */
     search(options: GoogleSearchOptions): Promise<Record<string, unknown>>;
+    /**
+     * Google search in the Custom Search JSON API format: a drop-in for cse.list.
+     * Returns customsearch#search (items[], searchInformation, queries.nextPage)
+     * plus a scavio billing object, so CSE parsing code keeps working. For the
+     * full SERP (knowledge graph, AI overview, People Also Ask) use search().
+     * Unsupported CSE params (image search, sort, rights) throw BadRequestError.
+     * 1 credit.
+     */
+    customSearch(options: GoogleCustomSearchOptions): Promise<GoogleCustomSearchResponse>;
     /** Google AI Mode answer. */
     aiMode(options: GoogleAiModeOptions): Promise<Record<string, unknown>>;
     /** Google Maps local results. */
@@ -5898,4 +6015,4 @@ declare class ScavioJobTimeoutError extends ScavioError {
     constructor(jobType: "crawl" | "batch", jobId: string, statusUrl: string, lastStatus: string);
 }
-export { type AirbnbListingOptions, AirbnbNamespace, type AirbnbReviewsOptions, type AirbnbSearchOptions, AmazonNamespace, type AmazonOffersOptions, type AmazonProductOptions, type AmazonSearchOptions, type AppStoreAppOptions, AppStoreNamespace, type AppStoreReviewsOptions, type AppStoreSearchOptions, BadRequestError, type BookingHotelOptions, BookingNamespace, type BookingReviewsOptions, type BookingSearchOptions, CapterraNamespace, type CapterraProductOptions, type CapterraReviewsOptions, type CapterraSearchOptions, type CompaniesHouseCompanyOptions, type CompaniesHouseFilingHistoryOptions, CompaniesHouseNamespace, type CompaniesHouseOfficersOptions, type CompaniesHouseSearchOptions, type CostcoAutocompleteOptions, type CostcoAvailabilityOptions, type CostcoCategoriesOptions, type CostcoCategoryOptions, type CostcoClearanceOptions, type CostcoCountry, type CostcoCouponsOptions, type CostcoDealType, type CostcoDealsOptions, type CostcoGasOptions, type CostcoListingFilters, type CostcoNaCountry, CostcoNamespace, type CostcoPriceCode, type CostcoPricesOptions, type CostcoProductOptions, type CostcoReviewsOptions, type CostcoSearchOptions, type CostcoSortBy, type CostcoWarehousesOptions, DEFAULT_MAX_REQUESTS_PER_SECOND, EbayNamespace, type EbayProductOptions, type EbaySearchOptions, type EbaySellerOptions, type Extract, type ExtractBatchOptions, type ExtractCrawlOptions, type ExtractFormat, type ExtractJobCreatedResponse, type ExtractJobRequestOptions, type ExtractJobResult, type ExtractJobState, type ExtractJobStatusQuery, type ExtractJobStatusResponse, type ExtractJobSummary, type ExtractJobSummaryResponse, type ExtractJobWaitResponse, type ExtractMapLink, type ExtractMapOptions, type ExtractMapResponse, type ExtractMode, ExtractNamespace, type ExtractOptions, type ExtractSitemapMode, G2Namespace, type G2ProductOptions, type G2ReviewsOptions, type G2SearchOptions, type GlassdoorCompaniesOptions, type GlassdoorCompanyOptions, GlassdoorNamespace, type GlassdoorReviewsOptions, type GlassdoorSalariesOptions, type GoogleAdsAdvertisersOptions, type GoogleAdsCreativeOptions, GoogleAdsNamespace, type GoogleAdsSearchOptions, type GoogleAiModeOptions, type GoogleFlightsOptions, type GoogleHotelsDetailOptions, type GoogleHotelsOptions, type GoogleMapsPlaceOptions, type GoogleMapsReviewsOptions, type GoogleMapsSearchOptions, GoogleNamespace, type GoogleNewsOptions, type GooglePlayAppOptions, GooglePlayNamespace, type GooglePlayReviewsOptions, type GooglePlaySearchOptions, type GoogleSearchOptions, type GoogleShoppingOptions, type GoogleShoppingProductOptions, type GoogleShoppingStoresOptions, type GoogleTrendingOptions, type GoogleTrendsOptions, HomeDepotNamespace, type HomeDepotProductOptions, type HomeDepotReviewsOptions, type HomeDepotSearchOptions, type IndeedCompanyOptions, type IndeedCompanyReviewsOptions, type IndeedJobOptions, IndeedNamespace, type IndeedSearchOptions, type InstagramCommentRepliesOptions, type InstagramFollowOptions, type InstagramHighlightStoriesOptions, type InstagramKeywordOptions, type InstagramMusicPostsOptions, InstagramNamespace, type InstagramPostCommentsOptions, type InstagramPostLikersOptions, type InstagramPostOptions, type InstagramProfileOptions, type InstagramSearchOptions, type InstagramStoriesOptions, type InstagramUserFeedOptions, type InstagramUserRefOptions, InsufficientCreditsError, InvalidAPIKeyError, type KuaishouCommentRepliesOptions, KuaishouNamespace, type KuaishouProfileOptions, type KuaishouSearchLiveOptions, type KuaishouSearchOptions, type KuaishouSearchUsersOptions, type KuaishouSearchVideosOptions, type KuaishouTagFeedOptions, type KuaishouTrendingOptions, type KuaishouUserLiveOptions, type KuaishouUserPostsOptions, type KuaishouUserResolveOptions, type KuaishouVideoCommentsOptions, type KuaishouVideoOptions, type KuaishouVideosBatchOptions, type LinkedInCompanyOptions, type LinkedInCompanyPostsOptions, type LinkedInCompanyPostsRequest, type LinkedInCompanyRefOptions, type LinkedInJobOptions, LinkedInNamespace, type LinkedInPersonContactOptions, type LinkedInPersonOptions, type LinkedInPersonPostsOptions, type LinkedInPersonPostsRequest, type LinkedInPersonRefOptions, type LinkedInPostCommentsOptions, type LinkedInPostOptions, type LinkedInSearchJobsOptions, type LinkedInSearchPeopleOptions, type LinkedInSearchPostsOptions, MAX_REQUESTS_PER_SECOND, type MercadoLibreBestSellersCountry, type MercadoLibreBestSellersOptions, type MercadoLibreCondition, type MercadoLibreCountry, type MercadoLibreDiscount, MercadoLibreNamespace, type MercadoLibreProductOptions, type MercadoLibreQuestionsOptions, type MercadoLibreReviewsOptions, type MercadoLibreSearchOptions, type MercadoLibreSort, type MetaAdsAdOptions, type MetaAdsAdvertiserOptions, MetaAdsNamespace, type MetaAdsSearchOptions, MissingAPIKeyError, NotFoundError, RateLimitError, type RealtorAgentOptions, type RealtorAgentsOptions, type RealtorListingStatus, type RealtorLocationsOptions, type RealtorMarketOptions, RealtorNamespace, type RealtorPropertyOptions, type RealtorPropertyType, type RealtorSearchOptions, type RealtorSort, type RedditCommentRepliesOptions, type RedditCommentSearchSort, type RedditFeedSort, RedditNamespace, type RedditPopularOptions, type RedditPostCommentsOptions, type RedditPostOptions, type RedditSearchCommentsOptions, type RedditSearchOptions, type RedditSearchSubredditsOptions, type RedditSearchSuggestionsOptions, type RedditSort, type RedditSubredditOptions, type RedditSubredditPostsOptions, type RedditUserFeedOptions, type RedditUserOptions, type RedfinMarketOptions, RedfinNamespace, type RedfinPropertyOptions, type RedfinSearchOptions, type RightmoveAgentOptions, type RightmoveAgentsOptions, type RightmoveExclude, type RightmoveFurnishing, type RightmoveLetType, type RightmoveListingStatus, type RightmoveLocationsOptions, type RightmoveMustHave, RightmoveNamespace, type RightmovePropertyOptions, type RightmovePropertyType, type RightmoveRadius, type RightmoveSearchOptions, type RightmoveSoldOptions, type RightmoveSoldPropertyOptions, type RightmoveSoldPropertyType, type RightmoveSoldSort, type RightmoveSort, type RightmoveTenure, type SECCompanyOptions, type SECConceptOptions, type SECFactsOptions, type SECFilingsOptions, type SECLookupOptions, SECNamespace, type SECSearchOptions, Scavio, ScavioAPIError, type ScavioConfig, ScavioConnectionError, ScavioError, ScavioJobTimeoutError, ScavioTimeoutError, type TargetCategoryOptions, TargetNamespace, type TargetProductOptions, type TargetReviewsOptions, type TargetSearchOptions, ThreadsNamespace, type ThreadsPostCommentsOptions, type ThreadsPostOptions, type ThreadsProfileOptions, type ThreadsSearchUsersOptions, type ThreadsUserPostsOptions, type ThreadsUserRepliesOptions, type TikTokCommentRepliesOptions, type TikTokHashtagOptions, type TikTokHashtagVideosOptions, type TikTokMusicChartOptions, type TikTokMusicOptions, type TikTokMusicVideosOptions, TikTokNamespace, type TikTokPlaylistVideosOptions, type TikTokProfileOptions, type TikTokSearchMusicOptions, type TikTokSearchSuggestionsOptions, type TikTokSearchUsersOptions, type TikTokSearchVideosOptions, type TikTokShopCategoryProductsOptions, type TikTokShopListingRegion, TikTokShopNamespace, type TikTokShopProductOptions, type TikTokShopProductReviewsOptions, type TikTokShopRegion, type TikTokShopResolveOptions, type TikTokShopReviewSort, type TikTokShopSearchOptions, type TikTokShopShopProductsOptions, type TikTokShopSuggestionsOptions, type TikTokTrendingVideosOptions, type TikTokUserFollowersOptions, type TikTokUserFollowingsOptions, type TikTokUserPlaylistsOptions, type TikTokUserPostsOptions, type TikTokUserSimilarOptions, type TikTokUsernameOptions, type TikTokVideoCommentsOptions, type TikTokVideoOptions, type TikTokVideoTranscriptOptions, type TripadvisorLocationOptions, type TripadvisorLocationsOptions, TripadvisorNamespace, type TripadvisorReviewsOptions, type TripadvisorSearchOptions, type TrustpilotBusinessAddress, type TrustpilotBusinessOptions, type TrustpilotCategoriesOptions, type TrustpilotCategoryOptions, type TrustpilotCategorySort, TrustpilotNamespace, type TrustpilotReviewOptions, type TrustpilotReviewsDateRange, type TrustpilotReviewsOptions, type TrustpilotReviewsSort, type TrustpilotSearchOptions, type TrustpilotStars, type WalmartCategoryOptions, WalmartNamespace, type WalmartOffersOptions, type WalmartProductOptions, type WalmartReviewsOptions, type WalmartSearchOptions, type WalmartSellerOptions, type WalmartSellerProductsOptions, type WalmartStore, type WalmartStoresData, type WalmartStoresOptions, type WalmartStoresResponse, type XCommunityOptions, type XCommunityTweetsOptions, XNamespace, type XSearchCommunitiesOptions, type XSearchOptions, type XTrendingOptions, type XTweetCommentsOptions, type XTweetOptions, type XTweetRetweetersOptions, type XUserFeedOptions, type XUserOptions, type YelpBusinessOptions, YelpNamespace, type YelpReviewsOptions, type YelpSearchOptions, type YouTubeChannelCommunityOptions, type YouTubeChannelOptions, type YouTubeChannelResolveOptions, type YouTubeChannelSearchOptions, type YouTubeChannelShortsOptions, type YouTubeChannelVideosOptions, type YouTubeCommentRepliesOptions, type YouTubeCommentsOptions, type YouTubeCommunityPostCommentsOptions, type YouTubeCommunityPostOptions, type YouTubeMetadataOptions, YouTubeNamespace, type YouTubeRelatedOptions, type YouTubeSearchOptions, type YouTubeShortsOptions, type YouTubeStreamsOptions, type YouTubeSuggestionsOptions, type YouTubeTranscriptOptions, type YouTubeVideoOptions, type ZillowAgentReviewsOptions, ZillowNamespace, type ZillowPropertyOptions, type ZillowSearchOptions, verifyWebhook };
+export { type AirbnbListingOptions, AirbnbNamespace, type AirbnbReviewsOptions, type AirbnbSearchOptions, AmazonNamespace, type AmazonOffersOptions, type AmazonProductOptions, type AmazonSearchOptions, type AppStoreAppOptions, AppStoreNamespace, type AppStoreReviewsOptions, type AppStoreSearchOptions, BadRequestError, type BookingHotelOptions, BookingNamespace, type BookingReviewsOptions, type BookingSearchOptions, CapterraNamespace, type CapterraProductOptions, type CapterraReviewsOptions, type CapterraSearchOptions, type CompaniesHouseCompanyOptions, type CompaniesHouseFilingHistoryOptions, CompaniesHouseNamespace, type CompaniesHouseOfficersOptions, type CompaniesHouseSearchOptions, type CostcoAutocompleteOptions, type CostcoAvailabilityOptions, type CostcoCategoriesOptions, type CostcoCategoryOptions, type CostcoClearanceOptions, type CostcoCountry, type CostcoCouponsOptions, type CostcoDealType, type CostcoDealsOptions, type CostcoGasOptions, type CostcoListingFilters, type CostcoNaCountry, CostcoNamespace, type CostcoPriceCode, type CostcoPricesOptions, type CostcoProductOptions, type CostcoReviewsOptions, type CostcoSearchOptions, type CostcoSortBy, type CostcoWarehousesOptions, DEFAULT_MAX_REQUESTS_PER_SECOND, EbayNamespace, type EbayProductOptions, type EbaySearchOptions, type EbaySellerOptions, type Extract, type ExtractBatchOptions, type ExtractCrawlOptions, type ExtractFormat, type ExtractJobCreatedResponse, type ExtractJobRequestOptions, type ExtractJobResult, type ExtractJobState, type ExtractJobStatusQuery, type ExtractJobStatusResponse, type ExtractJobSummary, type ExtractJobSummaryResponse, type ExtractJobWaitResponse, type ExtractMapLink, type ExtractMapOptions, type ExtractMapResponse, type ExtractMode, ExtractNamespace, type ExtractOptions, type ExtractSitemapMode, G2Namespace, type G2ProductOptions, type G2ReviewsOptions, type G2SearchOptions, type GlassdoorCompaniesOptions, type GlassdoorCompanyOptions, GlassdoorNamespace, type GlassdoorReviewsOptions, type GlassdoorSalariesOptions, type GoogleAdsAdvertisersOptions, type GoogleAdsCreativeOptions, GoogleAdsNamespace, type GoogleAdsSearchOptions, type GoogleAiModeOptions, type GoogleCustomSearchItem, type GoogleCustomSearchOptions, type GoogleCustomSearchQuery, type GoogleCustomSearchResponse, type GoogleFlightsOptions, type GoogleHotelsDetailOptions, type GoogleHotelsOptions, type GoogleMapsPlaceOptions, type GoogleMapsReviewsOptions, type GoogleMapsSearchOptions, GoogleNamespace, type GoogleNewsOptions, type GooglePlayAppOptions, GooglePlayNamespace, type GooglePlayReviewsOptions, type GooglePlaySearchOptions, type GoogleSearchOptions, type GoogleShoppingOptions, type GoogleShoppingProductOptions, type GoogleShoppingStoresOptions, type GoogleTrendingOptions, type GoogleTrendsOptions, HomeDepotNamespace, type HomeDepotProductOptions, type HomeDepotReviewsOptions, type HomeDepotSearchOptions, type IndeedCompanyOptions, type IndeedCompanyReviewsOptions, type IndeedJobOptions, IndeedNamespace, type IndeedSearchOptions, type InstagramCommentRepliesOptions, type InstagramFollowOptions, type InstagramHighlightStoriesOptions, type InstagramKeywordOptions, type InstagramMusicPostsOptions, InstagramNamespace, type InstagramPostCommentsOptions, type InstagramPostLikersOptions, type InstagramPostOptions, type InstagramProfileOptions, type InstagramSearchOptions, type InstagramStoriesOptions, type InstagramUserFeedOptions, type InstagramUserRefOptions, InsufficientCreditsError, InvalidAPIKeyError, type KuaishouCommentRepliesOptions, KuaishouNamespace, type KuaishouProfileOptions, type KuaishouSearchLiveOptions, type KuaishouSearchOptions, type KuaishouSearchUsersOptions, type KuaishouSearchVideosOptions, type KuaishouTagFeedOptions, type KuaishouTrendingOptions, type KuaishouUserLiveOptions, type KuaishouUserPostsOptions, type KuaishouUserResolveOptions, type KuaishouVideoCommentsOptions, type KuaishouVideoOptions, type KuaishouVideosBatchOptions, type LinkedInCompanyOptions, type LinkedInCompanyPostsOptions, type LinkedInCompanyPostsRequest, type LinkedInCompanyRefOptions, type LinkedInJobOptions, LinkedInNamespace, type LinkedInPersonContactOptions, type LinkedInPersonOptions, type LinkedInPersonPostsOptions, type LinkedInPersonPostsRequest, type LinkedInPersonRefOptions, type LinkedInPostCommentsOptions, type LinkedInPostOptions, type LinkedInSearchJobsOptions, type LinkedInSearchPeopleOptions, type LinkedInSearchPostsOptions, MAX_REQUESTS_PER_SECOND, type MercadoLibreBestSellersCountry, type MercadoLibreBestSellersOptions, type MercadoLibreCondition, type MercadoLibreCountry, type MercadoLibreDiscount, MercadoLibreNamespace, type MercadoLibreProductOptions, type MercadoLibreQuestionsOptions, type MercadoLibreReviewsOptions, type MercadoLibreSearchOptions, type MercadoLibreSort, type MetaAdsAdOptions, type MetaAdsAdvertiserOptions, MetaAdsNamespace, type MetaAdsSearchOptions, MissingAPIKeyError, NotFoundError, RateLimitError, type RealtorAgentOptions, type RealtorAgentsOptions, type RealtorListingStatus, type RealtorLocationsOptions, type RealtorMarketOptions, RealtorNamespace, type RealtorPropertyOptions, type RealtorPropertyType, type RealtorSearchOptions, type RealtorSort, type RedditCommentRepliesOptions, type RedditCommentSearchSort, type RedditFeedSort, RedditNamespace, type RedditPopularOptions, type RedditPostCommentsOptions, type RedditPostOptions, type RedditSearchCommentsOptions, type RedditSearchOptions, type RedditSearchSubredditsOptions, type RedditSearchSuggestionsOptions, type RedditSort, type RedditSubredditOptions, type RedditSubredditPostsOptions, type RedditUserFeedOptions, type RedditUserOptions, type RedfinMarketOptions, RedfinNamespace, type RedfinPropertyOptions, type RedfinSearchOptions, type RightmoveAgentOptions, type RightmoveAgentsOptions, type RightmoveExclude, type RightmoveFurnishing, type RightmoveLetType, type RightmoveListingStatus, type RightmoveLocationsOptions, type RightmoveMustHave, RightmoveNamespace, type RightmovePropertyOptions, type RightmovePropertyType, type RightmoveRadius, type RightmoveSearchOptions, type RightmoveSoldOptions, type RightmoveSoldPropertyOptions, type RightmoveSoldPropertyType, type RightmoveSoldSort, type RightmoveSort, type RightmoveTenure, type SECCompanyOptions, type SECConceptOptions, type SECFactsOptions, type SECFilingsOptions, type SECLookupOptions, SECNamespace, type SECSearchOptions, Scavio, ScavioAPIError, type ScavioConfig, ScavioConnectionError, ScavioError, ScavioJobTimeoutError, ScavioTimeoutError, type TargetCategoryOptions, TargetNamespace, type TargetProductOptions, type TargetReviewsOptions, type TargetSearchOptions, ThreadsNamespace, type ThreadsPostCommentsOptions, type ThreadsPostOptions, type ThreadsProfileOptions, type ThreadsSearchUsersOptions, type ThreadsUserPostsOptions, type ThreadsUserRepliesOptions, type TikTokCommentRepliesOptions, type TikTokHashtagOptions, type TikTokHashtagVideosOptions, type TikTokMusicChartOptions, type TikTokMusicOptions, type TikTokMusicVideosOptions, TikTokNamespace, type TikTokPlaylistVideosOptions, type TikTokProfileOptions, type TikTokSearchMusicOptions, type TikTokSearchSuggestionsOptions, type TikTokSearchUsersOptions, type TikTokSearchVideosOptions, type TikTokShopCategoryProductsOptions, type TikTokShopListingRegion, TikTokShopNamespace, type TikTokShopProductOptions, type TikTokShopProductReviewsOptions, type TikTokShopRegion, type TikTokShopResolveOptions, type TikTokShopReviewSort, type TikTokShopSearchOptions, type TikTokShopShopProductsOptions, type TikTokShopSuggestionsOptions, type TikTokTrendingVideosOptions, type TikTokUserFollowersOptions, type TikTokUserFollowingsOptions, type TikTokUserPlaylistsOptions, type TikTokUserPostsOptions, type TikTokUserSimilarOptions, type TikTokUsernameOptions, type TikTokVideoCommentsOptions, type TikTokVideoOptions, type TikTokVideoTranscriptOptions, type TripadvisorLocationOptions, type TripadvisorLocationsOptions, TripadvisorNamespace, type TripadvisorReviewsOptions, type TripadvisorSearchOptions, type TrustpilotBusinessAddress, type TrustpilotBusinessOptions, type TrustpilotCategoriesOptions, type TrustpilotCategoryOptions, type TrustpilotCategorySort, TrustpilotNamespace, type TrustpilotReviewOptions, type TrustpilotReviewsDateRange, type TrustpilotReviewsOptions, type TrustpilotReviewsSort, type TrustpilotSearchOptions, type TrustpilotStars, type WalmartCategoryOptions, WalmartNamespace, type WalmartOffersOptions, type WalmartProductOptions, type WalmartReviewsOptions, type WalmartSearchOptions, type WalmartSellerOptions, type WalmartSellerProductsOptions, type WalmartStore, type WalmartStoresData, type WalmartStoresOptions, type WalmartStoresResponse, type XCommunityOptions, type XCommunityTweetsOptions, XNamespace, type XSearchCommunitiesOptions, type XSearchOptions, type XTrendingOptions, type XTweetCommentsOptions, type XTweetOptions, type XTweetRetweetersOptions, type XUserFeedOptions, type XUserOptions, type YelpBusinessOptions, YelpNamespace, type YelpReviewsOptions, type YelpSearchOptions, type YouTubeChannelCommunityOptions, type YouTubeChannelOptions, type YouTubeChannelResolveOptions, type YouTubeChannelSearchOptions, type YouTubeChannelShortsOptions, type YouTubeChannelVideosOptions, type YouTubeCommentRepliesOptions, type YouTubeCommentsOptions, type YouTubeCommunityPostCommentsOptions, type YouTubeCommunityPostOptions, type YouTubeMetadataOptions, YouTubeNamespace, type YouTubeRelatedOptions, type YouTubeSearchOptions, type YouTubeShortsOptions, type YouTubeStreamsOptions, type YouTubeSuggestionsOptions, type YouTubeTranscriptOptions, type YouTubeVideoOptions, type ZillowAgentReviewsOptions, ZillowNamespace, type ZillowPropertyOptions, type ZillowSearchOptions, verifyWebhook };

package/dist/index.js CHANGED Viewed

@@ -145,7 +145,7 @@ function parseRetryAfter(header) {
 var BASE_URL = "https://api.scavio.dev";
 var DEFAULT_TIMEOUT = 3e4;
 var DEFAULT_MAX_RETRIES = 2;
-var SDK_VERSION = true ? "0.24.1" : "0.0.0";
+var SDK_VERSION = true ? "0.25.0" : "0.0.0";
 var USER_AGENT = `scavio-js/${SDK_VERSION}`;
 function isServerRuntime() {
   const g = globalThis;
@@ -334,6 +334,15 @@ var AmazonNamespace = class {
 };
 // src/namespaces/google.ts
+var CUSTOM_SEARCH_WIRE = {
+  date_restrict: "dateRestrict",
+  site_search: "siteSearch",
+  site_search_filter: "siteSearchFilter",
+  exact_terms: "exactTerms",
+  exclude_terms: "excludeTerms",
+  or_terms: "orTerms",
+  file_type: "fileType"
+};
 var GoogleNamespace = class {
   constructor(client) {
     this.client = client;
@@ -343,6 +352,21 @@ var GoogleNamespace = class {
   async search(options) {
     return this.client._post("/api/v2/google", options);
   }
+  /**
+   * Google search in the Custom Search JSON API format: a drop-in for cse.list.
+   * Returns customsearch#search (items[], searchInformation, queries.nextPage)
+   * plus a scavio billing object, so CSE parsing code keeps working. For the
+   * full SERP (knowledge graph, AI overview, People Also Ask) use search().
+   * Unsupported CSE params (image search, sort, rights) throw BadRequestError.
+   * 1 credit.
+   */
+  async customSearch(options) {
+    const body = {};
+    for (const [key, value] of Object.entries(options)) {
+      body[CUSTOM_SEARCH_WIRE[key] ?? key] = value;
+    }
+    return await this.client._post("/api/v1/google/customsearch", body);
+  }
   /** Google AI Mode answer. */
   async aiMode(options) {
     return this.client._post("/api/v2/google/ai-mode", options);