@microsoft/webiq 0.1.5 → 0.1.7

package/README.md

@@ -47,16 +47,6 @@ const page = await client.browse.fetch('https://www.microsoft.com', {
 });
 console.log(page.content);
 
-// Classic search with multiple answer types
-const classic = await client.classic.search('Artificial intelligence trends', {
-  responseFilter: ['webResults'],
-});
-// responseFilter selects which answer types come back; the matching
-// fields (e.g. classic.webResults) are populated dynamically and typed as `any`.
-for (const r of classic.webResults ?? []) {
-  console.log(`  - ${r.title}: ${r.url}`);
-}
-
 await client.close();
 ```
 
@@ -140,11 +130,11 @@ const results = await client.videos.search(query, {
 ### Browse
 
 ```typescript
-import { BrowseContentFormat, BrowseLiveCrawl } from '@microsoft/webiq';
+import { BrowseContentFormat, LiveCrawlMode } from '@microsoft/webiq';
 
 const page = await client.browse.fetch(url, {
   maxLength: 10000, // 1-500000
-  liveCrawl: BrowseLiveCrawl.FALLBACK, // NONE (default), FALLBACK, FORCE
+  liveCrawl: LiveCrawlMode.FALLBACK, // NONE (default), FALLBACK, FORCE
   includeWebLinks: true,
   includeImageLinks: true,
   renderDynamicPages: false,
@@ -170,30 +160,6 @@ const results = await client.images.search(query, {
 // results.imageResults → [{title, url, hostPageUrl, caption, width, height, thumbnailUrl, ...}]
 ```
 
-### Classic Search
-
-Given a query, classic search will search and retrieve content from webpages, images, videos, news, weather, sports, etc.
-
-```typescript
-import { ContentFormat, SafeSearch } from '@microsoft/webiq';
-
-const response = await client.classic.search(query, {
-  maxAnswerTypes: 6, // 1-6, default 6
-  language: 'en', // ISO 639-1/2 or BCP 47
-  region: 'US', // Country/region code
-  location: 'lat:40.7;long:-74.0', // Optional
-  maxResultsWeb: 10, // 1-50, default 10
-  maxLength: 10000, // 1-500000
-  contentFormat: ContentFormat.HTML,
-  freshness: 'month', // day, week, month, year, or date range
-  responseFilter: ['webResults', 'newsResults'], // Answer types to include
-  safeSearch: SafeSearch.STRICT, // OFF, STRICT
-});
-// response.querySignals → {originalQuery, normalizedQuery, isDefensive, isAdult, isNav, isFresh}
-// response.traceId → string
-// Additional dynamic fields for different answer types
-```
-
 ### Enum Types
 
 Some parameters require enum values instead of plain strings. Import them from `@microsoft/webiq`:
@@ -201,7 +167,7 @@ Some parameters require enum values instead of plain strings. Import them from `
 ```typescript
 import { BrowseContentFormat, ContentFormat } from '@microsoft/webiq';
 
-// ContentFormat: format of returned content for web, news, and classic search
+// ContentFormat: format of returned content for web and news search
 ContentFormat.PASSAGE; // Selected passages only (plain text)
 ContentFormat.TEXT; // Full page text (plain text)
 ContentFormat.HTML; // HTML format (default for web search)

package/dist/index.d.mts

@@ -692,7 +692,7 @@ declare enum BrowseContentFormat {
     MARKDOWN = "markdown"
 }
 
-declare enum BrowseLiveCrawl {
+declare enum LiveCrawlMode {
     NONE = "none",
     FALLBACK = "fallback",
     FORCE = "force"
@@ -745,8 +745,8 @@ interface BrowseParams {
     url: string;
     /** Max characters in content (1-500000, default 10000). */
     maxLength?: number;
-    /** Crawl behavior: use BrowseLiveCrawl.NONE, .FALLBACK, or .FORCE. */
-    liveCrawl?: BrowseLiveCrawl;
+    /** Live crawl behavior: NONE, FALLBACK, or FORCE. */
+    liveCrawl?: LiveCrawlMode;
     /** Include outbound hyperlinks (default false). */
     includeWebLinks?: boolean;
     /** Enable JS rendering for dynamic content (default false). */
@@ -782,105 +782,6 @@ declare class BrowseResource {
     fetch(url: string, options?: BrowseFetchOptions): Promise<BrowseResponse>;
 }
 
-type QuerySignals = {
-    /**
-     * The original user query as received by the system.
-     */
-    originalQuery?: string | null;
-    /**
-     * The normalized version of the user query after processing (e.g., lowercasing, removing stop words).
-     */
-    normalizedQuery?: string | null;
-    /**
-     * Indicates whether the query is defensive
-     */
-    isDefensive?: boolean | null;
-    /**
-     * Indicates whether the query is flagged as adult query
-     */
-    isAdult?: boolean | null;
-    /**
-     * Indicates whether the query is navigational
-     */
-    isNav?: boolean | null;
-    /**
-     * Indicates whether the query is fresh
-     */
-    isFresh?: boolean | null;
-};
-
-type SearchClassicResponse = {
-    querySignals?: QuerySignals;
-    /**
-     * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
-     */
-    instrumentationClickBase?: string | null;
-    /**
-     * Base URL for LLM log ping requests. Append a DATA payload to form the full ping URL.
-     */
-    instrumentationCitationBase?: string | null;
-    /**
-     * Trace ID for debugging and tracking.
-     */
-    traceId?: string | null;
-    [key: string]: any;
-};
-
-/**
- * Classic search resource.
- */
-
-/**
- * Classic search request parameters.
- */
-interface ClassicSearchParams {
-    /** Search query string (1-1000 chars). */
-    query: string;
-    /** Max answer types to return (1-6, default 6). */
-    maxAnswerTypes?: number;
-    /** Language code (ISO 639-1/2 or BCP 47). */
-    language?: string;
-    /** 2-letter country/region code. */
-    region?: string;
-    /** Location in format 'lat:<float>;long:<float>'. */
-    location?: string;
-    /** Max web results to return (1-50, default 10). */
-    maxResultsWeb?: number;
-    /** Max characters in content (1-500000, default 10000). */
-    maxLength?: number;
-    /** Content format: use ContentFormat.PASSAGE, .TEXT, .HTML, or .MARKDOWN. */
-    contentFormat?: ContentFormat;
-    /** Time range filter ('day', 'week', 'month', 'year', or date range). */
-    freshness?: string;
-    /** List of answer types to include in response. */
-    responseFilter?: string[];
-    /** Safe search mode: use SafeSearch.OFF or .STRICT. */
-    safeSearch?: SafeSearch;
-    /** Per-request timeout in milliseconds (overrides client default). */
-    timeout?: number;
-    /** Caller-provided cancellation signal (see `WebSearchParams.signal`). */
-    signal?: AbortSignal;
-}
-/** Classic search options (query is passed separately). */
-type ClassicSearchOptions = Omit<ClassicSearchParams, 'query'>;
-/**
- * Classic search resource for the Web IQ API.
- * Given a query, searches and retrieves content from webpages, images, videos,
- * news, weather, sports, etc.
- */
-declare class ClassicResource {
-    private readonly transport;
-    constructor(transport: Transport);
-    /**
-     * Perform a classic search returning grouped results across multiple answer types.
-     *
-     * @param query - Search query string (1-1000 chars)
-     * @param options - Search options
-     * @returns SearchClassicResponse with querySignals, traceId, and additional answer types
-     */
-    search(query: string, options?: ClassicSearchOptions): Promise<SearchClassicResponse>;
-}
-
 /**
  * Configuration for request retry behavior.
  */
@@ -1051,8 +952,6 @@ declare class WebIQClient {
     readonly images: ImagesResource;
     /** Browse resource */
     readonly browse: BrowseResource;
-    /** Classic search resource */
-    readonly classic: ClassicResource;
     private readonly _transport;
     private readonly _auth;
     constructor(options: WebIQClientOptions);
@@ -1135,11 +1034,182 @@ declare class PermissionDeniedError extends APIStatusError {
     });
 }
 
-declare enum SafeSearchMode {
-    OFF = "off",
-    MODERATE = "moderate",
-    STRICT = "strict"
-}
+type ApiErrorResponse = {
+    errorCode?: string | null;
+    errorCategory?: string | null;
+    userMessage?: string | null;
+    technicalDetails?: string | null;
+    retryAfter?: string | null;
+    requestId?: string | null;
+    traceId?: string | null;
+};
+
+type BrowseRequest = {
+    /**
+     * The URL of the web page to browse.
+     */
+    url: string;
+    /**
+     * The maximum number of characters in the content field in response. Default value is 10000 characters, and maximum value is 500000 characters.
+     */
+    maxLength?: number | null;
+    liveCrawl?: LiveCrawlMode;
+    /**
+     * Include outbound hyperlinks from the page. Default is false.
+     */
+    includeWebLinks?: boolean | null;
+    /**
+     * Enable JavaScript rendering for dynamic content screenshot. Only works when liveCrawl is set to 'fallback' or 'force'. Default is false.
+     */
+    renderDynamicPages?: boolean | null;
+    /**
+     * Include image URLs from the page. Default is false.
+     */
+    includeImageLinks?: boolean | null;
+    /**
+     * The language code (2-letter ISO 639-1). Default is 'en'.
+     */
+    language?: string | null;
+    /**
+     * The region code (2-letter country/region code). Default is 'US'.
+     */
+    region?: string | null;
+    contentFormat?: BrowseContentFormat;
+};
+
+type ImagesRequest = {
+    /**
+     * A search query string
+     */
+    query: string;
+    /**
+     * Max number of results to return. Default is 30 and maximum value is 30.
+     */
+    maxResults?: number | null;
+    /**
+     * A 2-letter ISO 639-1 language code for interface language in the search results. Default: 'en'.
+     */
+    language?: string | null;
+    /**
+     * A 2-letter country/region code for where the results should come from (e.g. 'US', 'JP', 'CN'). Default is 'US'.
+     */
+    region?: string | null;
+    aspectRatio?: ImageAspectRatio;
+    color?: ImageColor;
+    safeSearch?: SafeSearch;
+    imageSize?: ImageSize;
+    /**
+     * Exclude images with watermark. Default is false.
+     */
+    watermarkFree?: boolean | null;
+    /**
+     * Maximum image height in pixels. Used with imageSize for custom bounds.
+     */
+    maxHeight?: number | null;
+    /**
+     * Minimum image height in pixels.
+     */
+    minHeight?: number | null;
+    /**
+     * Maximum image width in pixels.
+     */
+    maxWidth?: number | null;
+    /**
+     * Minimum image width in pixels.
+     */
+    minWidth?: number | null;
+};
+
+type NewsRequest = {
+    /**
+     * A search query for the news.
+     */
+    query: string;
+    /**
+     * Max number of results to return. Default is 10 and maximum value is 20.
+     */
+    maxResults?: number | null;
+    /**
+     * A 2-letter ISO 639-1 language code for interface language in the search results. Default: 'en'.
+     */
+    language?: string | null;
+    /**
+     * A 2-letter country/region code for where the results should come from (e.g. 'US', 'JP', 'CN'). Default is 'US'.
+     */
+    region?: string | null;
+    /**
+     * Location information in format 'lat:<float>;long:<float>', e.g. 'lat:40.753250;long:-74.003807'. If not specified, could infer location in query.
+     */
+    location?: string | null;
+    contentFormat?: ContentFormat;
+    /**
+     * The maximum number of characters in the content field in response. Default value is 10000 characters, and maximum value is 500000 characters.
+     */
+    maxLength?: number | null;
+};
+
+type VideosRequest = {
+    /**
+     * A search query string
+     */
+    query: string;
+    /**
+     * Max number of results to return. Default is 30 and maximum value is 30.
+     */
+    maxResults?: number | null;
+    /**
+     * A 2-letter ISO 639-1 language code for interface language in the search results. Default: 'en'.
+     */
+    language?: string | null;
+    /**
+     * A 2-letter country/region code for where the results should come from (e.g. 'US', 'JP', 'CN'). Default is 'US'.
+     */
+    region?: string | null;
+    /**
+     * Whether to include playlist results in response. Default is false.
+     */
+    enablePlaylist?: boolean | null;
+    /**
+     * The time range to filter results based on discovery date. Supports 'week', 'month', 'year' for relative time, or ISO 8601 date interval format: 'YYYY-MM-DD/YYYY-MM-DD' or 'YYYY-MM-DDTHH:mm:ssZ/YYYY-MM-DDTHH:mm:ssZ' for a date/datetime range, use .. to omit start or end date.
+     */
+    freshness?: string | null;
+    /**
+     * Filter videos by embedding capabilities. Allowed values: 'player' (has embeddable player). When not set, no filtering is applied.
+     */
+    embeddable?: Array<string> | null;
+    resolution?: VideoResolution;
+    safeSearch?: SafeSearch;
+    duration?: VideoDuration;
+};
+
+type WebRequest = {
+    /**
+     * A search query string. Supports 'site:' and '-site:' operators to include or exclude results from specific sites (e.g. 'query site:example.com'). Use these operators only when necessary, as they inherently reduce result relevance.
+     */
+    query: string;
+    /**
+     * Max number of results to return. Default is 10 and maximum value is 50.
+     */
+    maxResults?: number | null;
+    /**
+     * A 2-letter ISO 639-1 language code for interface language in the search results. Default: 'en'.
+     */
+    language?: string | null;
+    /**
+     * A 2-letter country/region code for where the results should come from (e.g. 'US', 'JP', 'CN'). Default is 'US'.
+     */
+    region?: string | null;
+    /**
+     * Location information in format 'lat:<float>;long:<float>'.
+     */
+    location?: string | null;
+    contentFormat?: ContentFormat;
+    /**
+     * The maximum number of characters in the content or passage field in response. Default value is 10000 characters, and maximum value is 500000 characters.
+     */
+    maxLength?: number | null;
+    safeSearch?: SafeSearch;
+};
 
 /**
  * HTTP transport implementation.
@@ -1183,4 +1253,4 @@ declare class HttpTransport implements Transport {
     close(): Promise<void>;
 }
 
-export { APIConnectionError, APIStatusError, ApiKeyAuth, type AuthProvider, AuthenticationError, BrowseContentFormat, type BrowseFetchOptions, BrowseLiveCrawl, type BrowseParams, BrowseResource, type BrowseResponse, ClassicResource, type ClassicSearchOptions, type ClassicSearchParams, ContentFormat, ContentTier, DEFAULT_SCOPE, DEFAULT_TIMEOUT, EntraIDAuth, type FetchFunction, HttpTransport, type HttpTransportOptions, ImageAspectRatio, ImageColor, type ImageItem, type ImageSearchOptions, ImageSize, ImagesResource, type ImagesResponse, type ImagesSearchParams, type NewsItem, NewsResource, type NewsResponse, type NewsSearchOptions, type NewsSearchParams, type NewsThumbnail, PermissionDeniedError, type PlaylistItem, type PlaylistVideo, type QuerySignals, RateLimitError, RetryPolicy, type RetryPolicyOptions, SafeSearch, SafeSearchMode, type SearchClassicResponse, type TelemetryEvent, type TelemetryHook, type TokenCredential, type Transport, type TransportRequestOptions, VideoDuration, type VideoItem, type VideoMoment, VideoResolution, type VideoSearchOptions, VideosResource, type VideosResponse, type VideosSearchParams, WebIQClient, type WebIQClientOptions, WebIQError, WebResource, type WebResponse, type WebResult, type WebSearchOptions, type WebSearchParams, createAuth, createClient, createTelemetryEvent, safeCall };
+export { APIConnectionError, APIStatusError, type ApiErrorResponse, ApiKeyAuth, type AuthProvider, AuthenticationError, BrowseContentFormat, type BrowseFetchOptions, type BrowseParams, type BrowseRequest, BrowseResource, type BrowseResponse, ContentFormat, ContentTier, DEFAULT_SCOPE, DEFAULT_TIMEOUT, EntraIDAuth, type FetchFunction, HttpTransport, type HttpTransportOptions, ImageAspectRatio, ImageColor, type ImageItem, type ImageSearchOptions, ImageSize, type ImagesRequest, ImagesResource, type ImagesResponse, type ImagesSearchParams, LiveCrawlMode, type NewsItem, type NewsRequest, NewsResource, type NewsResponse, type NewsSearchOptions, type NewsSearchParams, type NewsThumbnail, PermissionDeniedError, type PlaylistItem, type PlaylistVideo, RateLimitError, RetryPolicy, type RetryPolicyOptions, SafeSearch, type TelemetryEvent, type TelemetryHook, type TokenCredential, type Transport, type TransportRequestOptions, VideoDuration, type VideoItem, type VideoMoment, VideoResolution, type VideoSearchOptions, type VideosRequest, VideosResource, type VideosResponse, type VideosSearchParams, WebIQClient, type WebIQClientOptions, WebIQError, type WebRequest, WebResource, type WebResponse, type WebResult, type WebSearchOptions, type WebSearchParams, createAuth, createClient, createTelemetryEvent, safeCall };

package/dist/index.d.ts

@@ -692,7 +692,7 @@ declare enum BrowseContentFormat {
     MARKDOWN = "markdown"
 }
 
-declare enum BrowseLiveCrawl {
+declare enum LiveCrawlMode {
     NONE = "none",
     FALLBACK = "fallback",
     FORCE = "force"
@@ -745,8 +745,8 @@ interface BrowseParams {
     url: string;
     /** Max characters in content (1-500000, default 10000). */
     maxLength?: number;
-    /** Crawl behavior: use BrowseLiveCrawl.NONE, .FALLBACK, or .FORCE. */
-    liveCrawl?: BrowseLiveCrawl;
+    /** Live crawl behavior: NONE, FALLBACK, or FORCE. */
+    liveCrawl?: LiveCrawlMode;
     /** Include outbound hyperlinks (default false). */
     includeWebLinks?: boolean;
     /** Enable JS rendering for dynamic content (default false). */
@@ -782,105 +782,6 @@ declare class BrowseResource {
     fetch(url: string, options?: BrowseFetchOptions): Promise<BrowseResponse>;
 }
 
-type QuerySignals = {
-    /**
-     * The original user query as received by the system.
-     */
-    originalQuery?: string | null;
-    /**
-     * The normalized version of the user query after processing (e.g., lowercasing, removing stop words).
-     */
-    normalizedQuery?: string | null;
-    /**
-     * Indicates whether the query is defensive
-     */
-    isDefensive?: boolean | null;
-    /**
-     * Indicates whether the query is flagged as adult query
-     */
-    isAdult?: boolean | null;
-    /**
-     * Indicates whether the query is navigational
-     */
-    isNav?: boolean | null;
-    /**
-     * Indicates whether the query is fresh
-     */
-    isFresh?: boolean | null;
-};
-
-type SearchClassicResponse = {
-    querySignals?: QuerySignals;
-    /**
-     * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
-     */
-    instrumentationClickBase?: string | null;
-    /**
-     * Base URL for LLM log ping requests. Append a DATA payload to form the full ping URL.
-     */
-    instrumentationCitationBase?: string | null;
-    /**
-     * Trace ID for debugging and tracking.
-     */
-    traceId?: string | null;
-    [key: string]: any;
-};
-
-/**
- * Classic search resource.
- */
-
-/**
- * Classic search request parameters.
- */
-interface ClassicSearchParams {
-    /** Search query string (1-1000 chars). */
-    query: string;
-    /** Max answer types to return (1-6, default 6). */
-    maxAnswerTypes?: number;
-    /** Language code (ISO 639-1/2 or BCP 47). */
-    language?: string;
-    /** 2-letter country/region code. */
-    region?: string;
-    /** Location in format 'lat:<float>;long:<float>'. */
-    location?: string;
-    /** Max web results to return (1-50, default 10). */
-    maxResultsWeb?: number;
-    /** Max characters in content (1-500000, default 10000). */
-    maxLength?: number;
-    /** Content format: use ContentFormat.PASSAGE, .TEXT, .HTML, or .MARKDOWN. */
-    contentFormat?: ContentFormat;
-    /** Time range filter ('day', 'week', 'month', 'year', or date range). */
-    freshness?: string;
-    /** List of answer types to include in response. */
-    responseFilter?: string[];
-    /** Safe search mode: use SafeSearch.OFF or .STRICT. */
-    safeSearch?: SafeSearch;
-    /** Per-request timeout in milliseconds (overrides client default). */
-    timeout?: number;
-    /** Caller-provided cancellation signal (see `WebSearchParams.signal`). */
-    signal?: AbortSignal;
-}
-/** Classic search options (query is passed separately). */
-type ClassicSearchOptions = Omit<ClassicSearchParams, 'query'>;
-/**
- * Classic search resource for the Web IQ API.
- * Given a query, searches and retrieves content from webpages, images, videos,
- * news, weather, sports, etc.
- */
-declare class ClassicResource {
-    private readonly transport;
-    constructor(transport: Transport);
-    /**
-     * Perform a classic search returning grouped results across multiple answer types.
-     *
-     * @param query - Search query string (1-1000 chars)
-     * @param options - Search options
-     * @returns SearchClassicResponse with querySignals, traceId, and additional answer types
-     */
-    search(query: string, options?: ClassicSearchOptions): Promise<SearchClassicResponse>;
-}
-
 /**
  * Configuration for request retry behavior.
  */
@@ -1051,8 +952,6 @@ declare class WebIQClient {
     readonly images: ImagesResource;
     /** Browse resource */
     readonly browse: BrowseResource;
-    /** Classic search resource */
-    readonly classic: ClassicResource;
     private readonly _transport;
     private readonly _auth;
     constructor(options: WebIQClientOptions);
@@ -1135,11 +1034,182 @@ declare class PermissionDeniedError extends APIStatusError {
     });
 }
 
-declare enum SafeSearchMode {
-    OFF = "off",
-    MODERATE = "moderate",
-    STRICT = "strict"
-}
+type ApiErrorResponse = {
+    errorCode?: string | null;
+    errorCategory?: string | null;
+    userMessage?: string | null;
+    technicalDetails?: string | null;
+    retryAfter?: string | null;
+    requestId?: string | null;
+    traceId?: string | null;
+};
+
+type BrowseRequest = {
+    /**
+     * The URL of the web page to browse.
+     */
+    url: string;
+    /**
+     * The maximum number of characters in the content field in response. Default value is 10000 characters, and maximum value is 500000 characters.
+     */
+    maxLength?: number | null;
+    liveCrawl?: LiveCrawlMode;
+    /**
+     * Include outbound hyperlinks from the page. Default is false.
+     */
+    includeWebLinks?: boolean | null;
+    /**
+     * Enable JavaScript rendering for dynamic content screenshot. Only works when liveCrawl is set to 'fallback' or 'force'. Default is false.
+     */
+    renderDynamicPages?: boolean | null;
+    /**
+     * Include image URLs from the page. Default is false.
+     */
+    includeImageLinks?: boolean | null;
+    /**
+     * The language code (2-letter ISO 639-1). Default is 'en'.
+     */
+    language?: string | null;
+    /**
+     * The region code (2-letter country/region code). Default is 'US'.
+     */
+    region?: string | null;
+    contentFormat?: BrowseContentFormat;
+};
+
+type ImagesRequest = {
+    /**
+     * A search query string
+     */
+    query: string;
+    /**
+     * Max number of results to return. Default is 30 and maximum value is 30.
+     */
+    maxResults?: number | null;
+    /**
+     * A 2-letter ISO 639-1 language code for interface language in the search results. Default: 'en'.
+     */
+    language?: string | null;
+    /**
+     * A 2-letter country/region code for where the results should come from (e.g. 'US', 'JP', 'CN'). Default is 'US'.
+     */
+    region?: string | null;
+    aspectRatio?: ImageAspectRatio;
+    color?: ImageColor;
+    safeSearch?: SafeSearch;
+    imageSize?: ImageSize;
+    /**
+     * Exclude images with watermark. Default is false.
+     */
+    watermarkFree?: boolean | null;
+    /**
+     * Maximum image height in pixels. Used with imageSize for custom bounds.
+     */
+    maxHeight?: number | null;
+    /**
+     * Minimum image height in pixels.
+     */
+    minHeight?: number | null;
+    /**
+     * Maximum image width in pixels.
+     */
+    maxWidth?: number | null;
+    /**
+     * Minimum image width in pixels.
+     */
+    minWidth?: number | null;
+};
+
+type NewsRequest = {
+    /**
+     * A search query for the news.
+     */
+    query: string;
+    /**
+     * Max number of results to return. Default is 10 and maximum value is 20.
+     */
+    maxResults?: number | null;
+    /**
+     * A 2-letter ISO 639-1 language code for interface language in the search results. Default: 'en'.
+     */
+    language?: string | null;
+    /**
+     * A 2-letter country/region code for where the results should come from (e.g. 'US', 'JP', 'CN'). Default is 'US'.
+     */
+    region?: string | null;
+    /**
+     * Location information in format 'lat:<float>;long:<float>', e.g. 'lat:40.753250;long:-74.003807'. If not specified, could infer location in query.
+     */
+    location?: string | null;
+    contentFormat?: ContentFormat;
+    /**
+     * The maximum number of characters in the content field in response. Default value is 10000 characters, and maximum value is 500000 characters.
+     */
+    maxLength?: number | null;
+};
+
+type VideosRequest = {
+    /**
+     * A search query string
+     */
+    query: string;
+    /**
+     * Max number of results to return. Default is 30 and maximum value is 30.
+     */
+    maxResults?: number | null;
+    /**
+     * A 2-letter ISO 639-1 language code for interface language in the search results. Default: 'en'.
+     */
+    language?: string | null;
+    /**
+     * A 2-letter country/region code for where the results should come from (e.g. 'US', 'JP', 'CN'). Default is 'US'.
+     */
+    region?: string | null;
+    /**
+     * Whether to include playlist results in response. Default is false.
+     */
+    enablePlaylist?: boolean | null;
+    /**
+     * The time range to filter results based on discovery date. Supports 'week', 'month', 'year' for relative time, or ISO 8601 date interval format: 'YYYY-MM-DD/YYYY-MM-DD' or 'YYYY-MM-DDTHH:mm:ssZ/YYYY-MM-DDTHH:mm:ssZ' for a date/datetime range, use .. to omit start or end date.
+     */
+    freshness?: string | null;
+    /**
+     * Filter videos by embedding capabilities. Allowed values: 'player' (has embeddable player). When not set, no filtering is applied.
+     */
+    embeddable?: Array<string> | null;
+    resolution?: VideoResolution;
+    safeSearch?: SafeSearch;
+    duration?: VideoDuration;
+};
+
+type WebRequest = {
+    /**
+     * A search query string. Supports 'site:' and '-site:' operators to include or exclude results from specific sites (e.g. 'query site:example.com'). Use these operators only when necessary, as they inherently reduce result relevance.
+     */
+    query: string;
+    /**
+     * Max number of results to return. Default is 10 and maximum value is 50.
+     */
+    maxResults?: number | null;
+    /**
+     * A 2-letter ISO 639-1 language code for interface language in the search results. Default: 'en'.
+     */
+    language?: string | null;
+    /**
+     * A 2-letter country/region code for where the results should come from (e.g. 'US', 'JP', 'CN'). Default is 'US'.
+     */
+    region?: string | null;
+    /**
+     * Location information in format 'lat:<float>;long:<float>'.
+     */
+    location?: string | null;
+    contentFormat?: ContentFormat;
+    /**
+     * The maximum number of characters in the content or passage field in response. Default value is 10000 characters, and maximum value is 500000 characters.
+     */
+    maxLength?: number | null;
+    safeSearch?: SafeSearch;
+};
 
 /**
  * HTTP transport implementation.
@@ -1183,4 +1253,4 @@ declare class HttpTransport implements Transport {
     close(): Promise<void>;
 }
 
-export { APIConnectionError, APIStatusError, ApiKeyAuth, type AuthProvider, AuthenticationError, BrowseContentFormat, type BrowseFetchOptions, BrowseLiveCrawl, type BrowseParams, BrowseResource, type BrowseResponse, ClassicResource, type ClassicSearchOptions, type ClassicSearchParams, ContentFormat, ContentTier, DEFAULT_SCOPE, DEFAULT_TIMEOUT, EntraIDAuth, type FetchFunction, HttpTransport, type HttpTransportOptions, ImageAspectRatio, ImageColor, type ImageItem, type ImageSearchOptions, ImageSize, ImagesResource, type ImagesResponse, type ImagesSearchParams, type NewsItem, NewsResource, type NewsResponse, type NewsSearchOptions, type NewsSearchParams, type NewsThumbnail, PermissionDeniedError, type PlaylistItem, type PlaylistVideo, type QuerySignals, RateLimitError, RetryPolicy, type RetryPolicyOptions, SafeSearch, SafeSearchMode, type SearchClassicResponse, type TelemetryEvent, type TelemetryHook, type TokenCredential, type Transport, type TransportRequestOptions, VideoDuration, type VideoItem, type VideoMoment, VideoResolution, type VideoSearchOptions, VideosResource, type VideosResponse, type VideosSearchParams, WebIQClient, type WebIQClientOptions, WebIQError, WebResource, type WebResponse, type WebResult, type WebSearchOptions, type WebSearchParams, createAuth, createClient, createTelemetryEvent, safeCall };
+export { APIConnectionError, APIStatusError, type ApiErrorResponse, ApiKeyAuth, type AuthProvider, AuthenticationError, BrowseContentFormat, type BrowseFetchOptions, type BrowseParams, type BrowseRequest, BrowseResource, type BrowseResponse, ContentFormat, ContentTier, DEFAULT_SCOPE, DEFAULT_TIMEOUT, EntraIDAuth, type FetchFunction, HttpTransport, type HttpTransportOptions, ImageAspectRatio, ImageColor, type ImageItem, type ImageSearchOptions, ImageSize, type ImagesRequest, ImagesResource, type ImagesResponse, type ImagesSearchParams, LiveCrawlMode, type NewsItem, type NewsRequest, NewsResource, type NewsResponse, type NewsSearchOptions, type NewsSearchParams, type NewsThumbnail, PermissionDeniedError, type PlaylistItem, type PlaylistVideo, RateLimitError, RetryPolicy, type RetryPolicyOptions, SafeSearch, type TelemetryEvent, type TelemetryHook, type TokenCredential, type Transport, type TransportRequestOptions, VideoDuration, type VideoItem, type VideoMoment, VideoResolution, type VideoSearchOptions, type VideosRequest, VideosResource, type VideosResponse, type VideosSearchParams, WebIQClient, type WebIQClientOptions, WebIQError, type WebRequest, WebResource, type WebResponse, type WebResult, type WebSearchOptions, type WebSearchParams, createAuth, createClient, createTelemetryEvent, safeCall };

package/dist/index.js

@@ -307,62 +307,6 @@ var BrowseResource = class {
   }
 };
 
-// src/resources/classic.ts
-var ClassicResource = class {
-  constructor(transport) {
-    this.transport = transport;
-  }
-  transport;
-  /**
-   * Perform a classic search returning grouped results across multiple answer types.
-   *
-   * @param query - Search query string (1-1000 chars)
-   * @param options - Search options
-   * @returns SearchClassicResponse with querySignals, traceId, and additional answer types
-   */
-  async search(query, options) {
-    const payload = { query };
-    if (options?.language !== void 0) {
-      payload.language = options.language;
-    }
-    if (options?.region !== void 0) {
-      payload.region = options.region;
-    }
-    if (options?.maxAnswerTypes !== void 0) {
-      payload.maxAnswerTypes = options.maxAnswerTypes;
-    }
-    if (options?.location) {
-      payload.location = options.location;
-    }
-    if (options?.maxResultsWeb !== void 0) {
-      payload.maxResultsWeb = options.maxResultsWeb;
-    }
-    if (options?.maxLength !== void 0) {
-      payload.maxLength = options.maxLength;
-    }
-    if (options?.contentFormat !== void 0) {
-      payload.contentFormat = options.contentFormat;
-    }
-    if (options?.freshness !== void 0) {
-      payload.freshness = options.freshness;
-    }
-    if (options?.responseFilter !== void 0) {
-      payload.responseFilter = options.responseFilter;
-    }
-    if (options?.safeSearch !== void 0) {
-      payload.safeSearch = options.safeSearch;
-    }
-    const result = await this.transport.request({
-      method: "POST",
-      path: "/search/classic",
-      json: payload,
-      timeout: options?.timeout,
-      signal: options?.signal
-    });
-    return result;
-  }
-};
-
 // src/errors.ts
 var WebIQError = class _WebIQError extends Error {
   constructor(message, options) {
@@ -680,8 +624,6 @@ var WebIQClient = class {
   images;
   /** Browse resource */
   browse;
-  /** Classic search resource */
-  classic;
   _transport;
   _auth;
   constructor(options) {
@@ -708,7 +650,6 @@ var WebIQClient = class {
     this.videos = new VideosResource(this._transport);
     this.images = new ImagesResource(this._transport);
     this.browse = new BrowseResource(this._transport);
-    this.classic = new ClassicResource(this._transport);
   }
   /**
    * Close the client and release resources.
@@ -729,14 +670,6 @@ var BrowseContentFormat = /* @__PURE__ */ ((BrowseContentFormat2) => {
   return BrowseContentFormat2;
 })(BrowseContentFormat || {});
 
-// src/generated-otc/models/BrowseLiveCrawl.ts
-var BrowseLiveCrawl = /* @__PURE__ */ ((BrowseLiveCrawl2) => {
-  BrowseLiveCrawl2["NONE"] = "none";
-  BrowseLiveCrawl2["FALLBACK"] = "fallback";
-  BrowseLiveCrawl2["FORCE"] = "force";
-  return BrowseLiveCrawl2;
-})(BrowseLiveCrawl || {});
-
 // src/generated-otc/models/ContentFormat.ts
 var ContentFormat = /* @__PURE__ */ ((ContentFormat2) => {
   ContentFormat2["PASSAGE"] = "passage";
@@ -754,38 +687,6 @@ var ContentTier = /* @__PURE__ */ ((ContentTier2) => {
   return ContentTier2;
 })(ContentTier || {});
 
-// src/generated-otc/models/SafeSearch.ts
-var SafeSearch = /* @__PURE__ */ ((SafeSearch2) => {
-  SafeSearch2["OFF"] = "off";
-  SafeSearch2["STRICT"] = "strict";
-  return SafeSearch2;
-})(SafeSearch || {});
-
-// src/generated-otc/models/SafeSearchMode.ts
-var SafeSearchMode = /* @__PURE__ */ ((SafeSearchMode2) => {
-  SafeSearchMode2["OFF"] = "off";
-  SafeSearchMode2["MODERATE"] = "moderate";
-  SafeSearchMode2["STRICT"] = "strict";
-  return SafeSearchMode2;
-})(SafeSearchMode || {});
-
-// src/generated-otc/models/VideoDuration.ts
-var VideoDuration = /* @__PURE__ */ ((VideoDuration2) => {
-  VideoDuration2["SHORT"] = "short";
-  VideoDuration2["MEDIUM"] = "medium";
-  VideoDuration2["LONG"] = "long";
-  return VideoDuration2;
-})(VideoDuration || {});
-
-// src/generated-otc/models/VideoResolution.ts
-var VideoResolution = /* @__PURE__ */ ((VideoResolution2) => {
-  VideoResolution2["_360P"] = "360p";
-  VideoResolution2["_480P"] = "480p";
-  VideoResolution2["_720P"] = "720p";
-  VideoResolution2["_1080P"] = "1080p";
-  return VideoResolution2;
-})(VideoResolution || {});
-
 // src/generated-otc/models/ImageAspectRatio.ts
 var ImageAspectRatio = /* @__PURE__ */ ((ImageAspectRatio2) => {
   ImageAspectRatio2["SQUARE"] = "square";
@@ -810,14 +711,44 @@ var ImageSize = /* @__PURE__ */ ((ImageSize2) => {
   return ImageSize2;
 })(ImageSize || {});
 
+// src/generated-otc/models/LiveCrawlMode.ts
+var LiveCrawlMode = /* @__PURE__ */ ((LiveCrawlMode2) => {
+  LiveCrawlMode2["NONE"] = "none";
+  LiveCrawlMode2["FALLBACK"] = "fallback";
+  LiveCrawlMode2["FORCE"] = "force";
+  return LiveCrawlMode2;
+})(LiveCrawlMode || {});
+
+// src/generated-otc/models/SafeSearch.ts
+var SafeSearch = /* @__PURE__ */ ((SafeSearch2) => {
+  SafeSearch2["OFF"] = "off";
+  SafeSearch2["STRICT"] = "strict";
+  return SafeSearch2;
+})(SafeSearch || {});
+
+// src/generated-otc/models/VideoDuration.ts
+var VideoDuration = /* @__PURE__ */ ((VideoDuration2) => {
+  VideoDuration2["SHORT"] = "short";
+  VideoDuration2["MEDIUM"] = "medium";
+  VideoDuration2["LONG"] = "long";
+  return VideoDuration2;
+})(VideoDuration || {});
+
+// src/generated-otc/models/VideoResolution.ts
+var VideoResolution = /* @__PURE__ */ ((VideoResolution2) => {
+  VideoResolution2["_360P"] = "360p";
+  VideoResolution2["_480P"] = "480p";
+  VideoResolution2["_720P"] = "720p";
+  VideoResolution2["_1080P"] = "1080p";
+  return VideoResolution2;
+})(VideoResolution || {});
+
 exports.APIConnectionError = APIConnectionError;
 exports.APIStatusError = APIStatusError;
 exports.ApiKeyAuth = ApiKeyAuth;
 exports.AuthenticationError = AuthenticationError;
 exports.BrowseContentFormat = BrowseContentFormat;
-exports.BrowseLiveCrawl = BrowseLiveCrawl;
 exports.BrowseResource = BrowseResource;
-exports.ClassicResource = ClassicResource;
 exports.ContentFormat = ContentFormat;
 exports.ContentTier = ContentTier;
 exports.DEFAULT_SCOPE = DEFAULT_SCOPE;
@@ -828,12 +759,12 @@ exports.ImageAspectRatio = ImageAspectRatio;
 exports.ImageColor = ImageColor;
 exports.ImageSize = ImageSize;
 exports.ImagesResource = ImagesResource;
+exports.LiveCrawlMode = LiveCrawlMode;
 exports.NewsResource = NewsResource;
 exports.PermissionDeniedError = PermissionDeniedError;
 exports.RateLimitError = RateLimitError;
 exports.RetryPolicy = RetryPolicy;
 exports.SafeSearch = SafeSearch;
-exports.SafeSearchMode = SafeSearchMode;
 exports.VideoDuration = VideoDuration;
 exports.VideoResolution = VideoResolution;
 exports.VideosResource = VideosResource;

package/dist/index.mjs

@@ -305,62 +305,6 @@ var BrowseResource = class {
   }
 };
 
-// src/resources/classic.ts
-var ClassicResource = class {
-  constructor(transport) {
-    this.transport = transport;
-  }
-  transport;
-  /**
-   * Perform a classic search returning grouped results across multiple answer types.
-   *
-   * @param query - Search query string (1-1000 chars)
-   * @param options - Search options
-   * @returns SearchClassicResponse with querySignals, traceId, and additional answer types
-   */
-  async search(query, options) {
-    const payload = { query };
-    if (options?.language !== void 0) {
-      payload.language = options.language;
-    }
-    if (options?.region !== void 0) {
-      payload.region = options.region;
-    }
-    if (options?.maxAnswerTypes !== void 0) {
-      payload.maxAnswerTypes = options.maxAnswerTypes;
-    }
-    if (options?.location) {
-      payload.location = options.location;
-    }
-    if (options?.maxResultsWeb !== void 0) {
-      payload.maxResultsWeb = options.maxResultsWeb;
-    }
-    if (options?.maxLength !== void 0) {
-      payload.maxLength = options.maxLength;
-    }
-    if (options?.contentFormat !== void 0) {
-      payload.contentFormat = options.contentFormat;
-    }
-    if (options?.freshness !== void 0) {
-      payload.freshness = options.freshness;
-    }
-    if (options?.responseFilter !== void 0) {
-      payload.responseFilter = options.responseFilter;
-    }
-    if (options?.safeSearch !== void 0) {
-      payload.safeSearch = options.safeSearch;
-    }
-    const result = await this.transport.request({
-      method: "POST",
-      path: "/search/classic",
-      json: payload,
-      timeout: options?.timeout,
-      signal: options?.signal
-    });
-    return result;
-  }
-};
-
 // src/errors.ts
 var WebIQError = class _WebIQError extends Error {
   constructor(message, options) {
@@ -678,8 +622,6 @@ var WebIQClient = class {
   images;
   /** Browse resource */
   browse;
-  /** Classic search resource */
-  classic;
   _transport;
   _auth;
   constructor(options) {
@@ -706,7 +648,6 @@ var WebIQClient = class {
     this.videos = new VideosResource(this._transport);
     this.images = new ImagesResource(this._transport);
     this.browse = new BrowseResource(this._transport);
-    this.classic = new ClassicResource(this._transport);
   }
   /**
    * Close the client and release resources.
@@ -727,14 +668,6 @@ var BrowseContentFormat = /* @__PURE__ */ ((BrowseContentFormat2) => {
   return BrowseContentFormat2;
 })(BrowseContentFormat || {});
 
-// src/generated-otc/models/BrowseLiveCrawl.ts
-var BrowseLiveCrawl = /* @__PURE__ */ ((BrowseLiveCrawl2) => {
-  BrowseLiveCrawl2["NONE"] = "none";
-  BrowseLiveCrawl2["FALLBACK"] = "fallback";
-  BrowseLiveCrawl2["FORCE"] = "force";
-  return BrowseLiveCrawl2;
-})(BrowseLiveCrawl || {});
-
 // src/generated-otc/models/ContentFormat.ts
 var ContentFormat = /* @__PURE__ */ ((ContentFormat2) => {
   ContentFormat2["PASSAGE"] = "passage";
@@ -752,38 +685,6 @@ var ContentTier = /* @__PURE__ */ ((ContentTier2) => {
   return ContentTier2;
 })(ContentTier || {});
 
-// src/generated-otc/models/SafeSearch.ts
-var SafeSearch = /* @__PURE__ */ ((SafeSearch2) => {
-  SafeSearch2["OFF"] = "off";
-  SafeSearch2["STRICT"] = "strict";
-  return SafeSearch2;
-})(SafeSearch || {});
-
-// src/generated-otc/models/SafeSearchMode.ts
-var SafeSearchMode = /* @__PURE__ */ ((SafeSearchMode2) => {
-  SafeSearchMode2["OFF"] = "off";
-  SafeSearchMode2["MODERATE"] = "moderate";
-  SafeSearchMode2["STRICT"] = "strict";
-  return SafeSearchMode2;
-})(SafeSearchMode || {});
-
-// src/generated-otc/models/VideoDuration.ts
-var VideoDuration = /* @__PURE__ */ ((VideoDuration2) => {
-  VideoDuration2["SHORT"] = "short";
-  VideoDuration2["MEDIUM"] = "medium";
-  VideoDuration2["LONG"] = "long";
-  return VideoDuration2;
-})(VideoDuration || {});
-
-// src/generated-otc/models/VideoResolution.ts
-var VideoResolution = /* @__PURE__ */ ((VideoResolution2) => {
-  VideoResolution2["_360P"] = "360p";
-  VideoResolution2["_480P"] = "480p";
-  VideoResolution2["_720P"] = "720p";
-  VideoResolution2["_1080P"] = "1080p";
-  return VideoResolution2;
-})(VideoResolution || {});
-
 // src/generated-otc/models/ImageAspectRatio.ts
 var ImageAspectRatio = /* @__PURE__ */ ((ImageAspectRatio2) => {
   ImageAspectRatio2["SQUARE"] = "square";
@@ -808,4 +709,36 @@ var ImageSize = /* @__PURE__ */ ((ImageSize2) => {
   return ImageSize2;
 })(ImageSize || {});
 
-export { APIConnectionError, APIStatusError, ApiKeyAuth, AuthenticationError, BrowseContentFormat, BrowseLiveCrawl, BrowseResource, ClassicResource, ContentFormat, ContentTier, DEFAULT_SCOPE, DEFAULT_TIMEOUT, EntraIDAuth, HttpTransport, ImageAspectRatio, ImageColor, ImageSize, ImagesResource, NewsResource, PermissionDeniedError, RateLimitError, RetryPolicy, SafeSearch, SafeSearchMode, VideoDuration, VideoResolution, VideosResource, WebIQClient, WebIQError, WebResource, createAuth, createClient, createTelemetryEvent, safeCall };
+// src/generated-otc/models/LiveCrawlMode.ts
+var LiveCrawlMode = /* @__PURE__ */ ((LiveCrawlMode2) => {
+  LiveCrawlMode2["NONE"] = "none";
+  LiveCrawlMode2["FALLBACK"] = "fallback";
+  LiveCrawlMode2["FORCE"] = "force";
+  return LiveCrawlMode2;
+})(LiveCrawlMode || {});
+
+// src/generated-otc/models/SafeSearch.ts
+var SafeSearch = /* @__PURE__ */ ((SafeSearch2) => {
+  SafeSearch2["OFF"] = "off";
+  SafeSearch2["STRICT"] = "strict";
+  return SafeSearch2;
+})(SafeSearch || {});
+
+// src/generated-otc/models/VideoDuration.ts
+var VideoDuration = /* @__PURE__ */ ((VideoDuration2) => {
+  VideoDuration2["SHORT"] = "short";
+  VideoDuration2["MEDIUM"] = "medium";
+  VideoDuration2["LONG"] = "long";
+  return VideoDuration2;
+})(VideoDuration || {});
+
+// src/generated-otc/models/VideoResolution.ts
+var VideoResolution = /* @__PURE__ */ ((VideoResolution2) => {
+  VideoResolution2["_360P"] = "360p";
+  VideoResolution2["_480P"] = "480p";
+  VideoResolution2["_720P"] = "720p";
+  VideoResolution2["_1080P"] = "1080p";
+  return VideoResolution2;
+})(VideoResolution || {});
+
+export { APIConnectionError, APIStatusError, ApiKeyAuth, AuthenticationError, BrowseContentFormat, BrowseResource, ContentFormat, ContentTier, DEFAULT_SCOPE, DEFAULT_TIMEOUT, EntraIDAuth, HttpTransport, ImageAspectRatio, ImageColor, ImageSize, ImagesResource, LiveCrawlMode, NewsResource, PermissionDeniedError, RateLimitError, RetryPolicy, SafeSearch, VideoDuration, VideoResolution, VideosResource, WebIQClient, WebIQError, WebResource, createAuth, createClient, createTelemetryEvent, safeCall };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/webiq",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Web IQ API TypeScript SDK",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -24,6 +24,7 @@
     "format": "prettier --write \"src/**/*.ts\" \"*.md\" \"*.json\" --ignore-path ../../.prettierignore",
     "format:check": "prettier --check \"src/**/*.ts\" \"*.md\" \"*.json\" --ignore-path ../../.prettierignore",
     "typecheck": "tsc --noEmit",
+    "smoke:examples": "tsc --noEmit -p tsconfig.examples.json",
     "test": "vitest run",
     "test:watch": "vitest",
     "clean": "rimraf dist"