@microsoft/webiq 0.1.1 → 0.1.2

package/README.md

@@ -99,8 +99,11 @@ const results = await client.web.search(query, {
   location: 'lat:40.7;long:-74.0', // Optional
   contentFormat: ContentFormat.HTML, // PASSAGE, TEXT, HTML, MARKDOWN
   maxLength: 10000, // 1-500000
+  customSearchConfigId: 'my-config', // Optional custom search config
+  includeDomains: ['example.com'], // Optional allowlist (max 250)
+  excludeDomains: ['spam.example'], // Optional blocklist (max 250)
 });
-// results.webResults → [{title, url, content, lastUpdatedAt, crawledAt, language, isAdult}]
+// results.webResults → [{title, url, content, lastUpdatedAt, crawledAt, language, isAdult, contentTier}]
 ```
 
 ### News Search

package/dist/index.d.mts

@@ -84,6 +84,12 @@ declare enum ContentFormat {
     MARKDOWN = "markdown"
 }
 
+declare enum ContentTier {
+    STANDARD = "standard",
+    ENTITLED = "entitled",
+    PREMIUM = "premium"
+}
+
 type WebResult = {
     /**
      * The title of the webpage.
@@ -113,6 +119,7 @@ type WebResult = {
      * Indicates whether the result includes adult content.
      */
     isAdult?: boolean;
+    contentTier?: ContentTier;
     /**
      * Redirect URL that proxies through Bing. Only present when redirect is enabled.
      */
@@ -164,6 +171,18 @@ interface WebSearchParams {
     contentFormat?: ContentFormat;
     /** Max characters in content (1-500000, default 10000). */
     maxLength?: number;
+    /** Custom search configuration ID (configure at https://www.customsearch.ai/). */
+    customSearchConfigId?: string;
+    /**
+     * Domains to include in results (max 250). For allow-lists longer than ~20
+     * domains, use `customSearchConfigId` instead.
+     */
+    includeDomains?: string[];
+    /**
+     * Domains to exclude from results (max 250). For deny-lists longer than ~20
+     * domains, use `customSearchConfigId` instead.
+     */
+    excludeDomains?: string[];
     /** Per-request timeout in milliseconds (overrides client default). */
     timeout?: number;
     /**
@@ -1164,4 +1183,4 @@ declare class HttpTransport implements Transport {
     close(): Promise<void>;
 }
 
-export { APIConnectionError, APIStatusError, ApiKeyAuth, type AuthProvider, AuthenticationError, BrowseContentFormat, type BrowseFetchOptions, type BrowseParams, BrowseResource, type BrowseResponse, ClassicResource, type ClassicSearchOptions, type ClassicSearchParams, ContentFormat, 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, ApiKeyAuth, type AuthProvider, AuthenticationError, BrowseContentFormat, type BrowseFetchOptions, 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 };

package/dist/index.d.ts

@@ -84,6 +84,12 @@ declare enum ContentFormat {
     MARKDOWN = "markdown"
 }
 
+declare enum ContentTier {
+    STANDARD = "standard",
+    ENTITLED = "entitled",
+    PREMIUM = "premium"
+}
+
 type WebResult = {
     /**
      * The title of the webpage.
@@ -113,6 +119,7 @@ type WebResult = {
      * Indicates whether the result includes adult content.
      */
     isAdult?: boolean;
+    contentTier?: ContentTier;
     /**
      * Redirect URL that proxies through Bing. Only present when redirect is enabled.
      */
@@ -164,6 +171,18 @@ interface WebSearchParams {
     contentFormat?: ContentFormat;
     /** Max characters in content (1-500000, default 10000). */
     maxLength?: number;
+    /** Custom search configuration ID (configure at https://www.customsearch.ai/). */
+    customSearchConfigId?: string;
+    /**
+     * Domains to include in results (max 250). For allow-lists longer than ~20
+     * domains, use `customSearchConfigId` instead.
+     */
+    includeDomains?: string[];
+    /**
+     * Domains to exclude from results (max 250). For deny-lists longer than ~20
+     * domains, use `customSearchConfigId` instead.
+     */
+    excludeDomains?: string[];
     /** Per-request timeout in milliseconds (overrides client default). */
     timeout?: number;
     /**
@@ -1164,4 +1183,4 @@ declare class HttpTransport implements Transport {
     close(): Promise<void>;
 }
 
-export { APIConnectionError, APIStatusError, ApiKeyAuth, type AuthProvider, AuthenticationError, BrowseContentFormat, type BrowseFetchOptions, type BrowseParams, BrowseResource, type BrowseResponse, ClassicResource, type ClassicSearchOptions, type ClassicSearchParams, ContentFormat, 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, ApiKeyAuth, type AuthProvider, AuthenticationError, BrowseContentFormat, type BrowseFetchOptions, 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 };

package/dist/index.js

@@ -84,6 +84,15 @@ var WebResource = class {
     if (options?.maxLength !== void 0) {
       payload.maxLength = options.maxLength;
     }
+    if (options?.customSearchConfigId !== void 0) {
+      payload.customSearchConfigId = options.customSearchConfigId;
+    }
+    if (options?.includeDomains !== void 0) {
+      payload.includeDomains = options.includeDomains;
+    }
+    if (options?.excludeDomains !== void 0) {
+      payload.excludeDomains = options.excludeDomains;
+    }
     const result = await this.transport.request({
       method: "POST",
       path: "/search/web",
@@ -735,6 +744,14 @@ var ContentFormat = /* @__PURE__ */ ((ContentFormat2) => {
   return ContentFormat2;
 })(ContentFormat || {});
 
+// src/generated-otc/models/ContentTier.ts
+var ContentTier = /* @__PURE__ */ ((ContentTier2) => {
+  ContentTier2["STANDARD"] = "standard";
+  ContentTier2["ENTITLED"] = "entitled";
+  ContentTier2["PREMIUM"] = "premium";
+  return ContentTier2;
+})(ContentTier || {});
+
 // src/generated-otc/models/SafeSearch.ts
 var SafeSearch = /* @__PURE__ */ ((SafeSearch2) => {
   SafeSearch2["OFF"] = "off";
@@ -799,6 +816,7 @@ exports.BrowseContentFormat = BrowseContentFormat;
 exports.BrowseResource = BrowseResource;
 exports.ClassicResource = ClassicResource;
 exports.ContentFormat = ContentFormat;
+exports.ContentTier = ContentTier;
 exports.DEFAULT_SCOPE = DEFAULT_SCOPE;
 exports.DEFAULT_TIMEOUT = DEFAULT_TIMEOUT;
 exports.EntraIDAuth = EntraIDAuth;

package/dist/index.mjs

@@ -82,6 +82,15 @@ var WebResource = class {
     if (options?.maxLength !== void 0) {
       payload.maxLength = options.maxLength;
     }
+    if (options?.customSearchConfigId !== void 0) {
+      payload.customSearchConfigId = options.customSearchConfigId;
+    }
+    if (options?.includeDomains !== void 0) {
+      payload.includeDomains = options.includeDomains;
+    }
+    if (options?.excludeDomains !== void 0) {
+      payload.excludeDomains = options.excludeDomains;
+    }
     const result = await this.transport.request({
       method: "POST",
       path: "/search/web",
@@ -733,6 +742,14 @@ var ContentFormat = /* @__PURE__ */ ((ContentFormat2) => {
   return ContentFormat2;
 })(ContentFormat || {});
 
+// src/generated-otc/models/ContentTier.ts
+var ContentTier = /* @__PURE__ */ ((ContentTier2) => {
+  ContentTier2["STANDARD"] = "standard";
+  ContentTier2["ENTITLED"] = "entitled";
+  ContentTier2["PREMIUM"] = "premium";
+  return ContentTier2;
+})(ContentTier || {});
+
 // src/generated-otc/models/SafeSearch.ts
 var SafeSearch = /* @__PURE__ */ ((SafeSearch2) => {
   SafeSearch2["OFF"] = "off";
@@ -789,4 +806,4 @@ var ImageSize = /* @__PURE__ */ ((ImageSize2) => {
   return ImageSize2;
 })(ImageSize || {});
 
-export { APIConnectionError, APIStatusError, ApiKeyAuth, AuthenticationError, BrowseContentFormat, BrowseResource, ClassicResource, ContentFormat, 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 };
+export { APIConnectionError, APIStatusError, ApiKeyAuth, AuthenticationError, BrowseContentFormat, 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/webiq",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Web IQ API TypeScript SDK",
   "main": "dist/index.js",
   "module": "dist/index.mjs",