@microsoft/webiq 0.1.4 → 0.1.5

package/README.md

@@ -140,9 +140,11 @@ const results = await client.videos.search(query, {
 ### Browse
 
 ```typescript
+import { BrowseContentFormat, BrowseLiveCrawl } from '@microsoft/webiq';
+
 const page = await client.browse.fetch(url, {
   maxLength: 10000, // 1-500000
-  liveCrawl: 'fallback', // "none" (default) | "fallback" | "force"
+  liveCrawl: BrowseLiveCrawl.FALLBACK, // NONE (default), FALLBACK, FORCE
   includeWebLinks: true,
   includeImageLinks: true,
   renderDynamicPages: false,
@@ -173,7 +175,7 @@ const results = await client.images.search(query, {
 Given a query, classic search will search and retrieve content from webpages, images, videos, news, weather, sports, etc.
 
 ```typescript
-import { ContentFormat, SafeSearchMode } from '@microsoft/webiq';
+import { ContentFormat, SafeSearch } from '@microsoft/webiq';
 
 const response = await client.classic.search(query, {
   maxAnswerTypes: 6, // 1-6, default 6
@@ -185,7 +187,7 @@ const response = await client.classic.search(query, {
   contentFormat: ContentFormat.HTML,
   freshness: 'month', // day, week, month, year, or date range
   responseFilter: ['webResults', 'newsResults'], // Answer types to include
-  safeSearch: SafeSearchMode.MODERATE, // OFF, MODERATE, STRICT
+  safeSearch: SafeSearch.STRICT, // OFF, STRICT
 });
 // response.querySignals → {originalQuery, normalizedQuery, isDefensive, isAdult, isNav, isFresh}
 // response.traceId → string

package/dist/index.d.mts

@@ -692,6 +692,12 @@ declare enum BrowseContentFormat {
     MARKDOWN = "markdown"
 }
 
+declare enum BrowseLiveCrawl {
+    NONE = "none",
+    FALLBACK = "fallback",
+    FORCE = "force"
+}
+
 type BrowseResponse = {
     /**
      * The URL of the web page.
@@ -739,8 +745,8 @@ interface BrowseParams {
     url: string;
     /** Max characters in content (1-500000, default 10000). */
     maxLength?: number;
-    /** Crawl behavior ('none', 'fallback', or 'force', default 'none'). */
-    liveCrawl?: 'none' | 'fallback' | 'force';
+    /** Crawl behavior: use BrowseLiveCrawl.NONE, .FALLBACK, or .FORCE. */
+    liveCrawl?: BrowseLiveCrawl;
     /** Include outbound hyperlinks (default false). */
     includeWebLinks?: boolean;
     /** Enable JS rendering for dynamic content (default false). */
@@ -776,12 +782,6 @@ declare class BrowseResource {
     fetch(url: string, options?: BrowseFetchOptions): Promise<BrowseResponse>;
 }
 
-declare enum SafeSearchMode {
-    OFF = "off",
-    MODERATE = "moderate",
-    STRICT = "strict"
-}
-
 type QuerySignals = {
     /**
      * The original user query as received by the system.
@@ -854,8 +854,8 @@ interface ClassicSearchParams {
     freshness?: string;
     /** List of answer types to include in response. */
     responseFilter?: string[];
-    /** Safe search mode: use SafeSearchMode.OFF, .MODERATE, or .STRICT. */
-    safeSearch?: SafeSearchMode;
+    /** 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`). */
@@ -1135,6 +1135,12 @@ declare class PermissionDeniedError extends APIStatusError {
     });
 }
 
+declare enum SafeSearchMode {
+    OFF = "off",
+    MODERATE = "moderate",
+    STRICT = "strict"
+}
+
 /**
  * HTTP transport implementation.
  */
@@ -1177,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, 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, 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 };

package/dist/index.d.ts

@@ -692,6 +692,12 @@ declare enum BrowseContentFormat {
     MARKDOWN = "markdown"
 }
 
+declare enum BrowseLiveCrawl {
+    NONE = "none",
+    FALLBACK = "fallback",
+    FORCE = "force"
+}
+
 type BrowseResponse = {
     /**
      * The URL of the web page.
@@ -739,8 +745,8 @@ interface BrowseParams {
     url: string;
     /** Max characters in content (1-500000, default 10000). */
     maxLength?: number;
-    /** Crawl behavior ('none', 'fallback', or 'force', default 'none'). */
-    liveCrawl?: 'none' | 'fallback' | 'force';
+    /** Crawl behavior: use BrowseLiveCrawl.NONE, .FALLBACK, or .FORCE. */
+    liveCrawl?: BrowseLiveCrawl;
     /** Include outbound hyperlinks (default false). */
     includeWebLinks?: boolean;
     /** Enable JS rendering for dynamic content (default false). */
@@ -776,12 +782,6 @@ declare class BrowseResource {
     fetch(url: string, options?: BrowseFetchOptions): Promise<BrowseResponse>;
 }
 
-declare enum SafeSearchMode {
-    OFF = "off",
-    MODERATE = "moderate",
-    STRICT = "strict"
-}
-
 type QuerySignals = {
     /**
      * The original user query as received by the system.
@@ -854,8 +854,8 @@ interface ClassicSearchParams {
     freshness?: string;
     /** List of answer types to include in response. */
     responseFilter?: string[];
-    /** Safe search mode: use SafeSearchMode.OFF, .MODERATE, or .STRICT. */
-    safeSearch?: SafeSearchMode;
+    /** 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`). */
@@ -1135,6 +1135,12 @@ declare class PermissionDeniedError extends APIStatusError {
     });
 }
 
+declare enum SafeSearchMode {
+    OFF = "off",
+    MODERATE = "moderate",
+    STRICT = "strict"
+}
+
 /**
  * HTTP transport implementation.
  */
@@ -1177,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, 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, 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 };

package/dist/index.js

@@ -729,6 +729,14 @@ 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";
@@ -807,6 +815,7 @@ exports.APIStatusError = APIStatusError;
 exports.ApiKeyAuth = ApiKeyAuth;
 exports.AuthenticationError = AuthenticationError;
 exports.BrowseContentFormat = BrowseContentFormat;
+exports.BrowseLiveCrawl = BrowseLiveCrawl;
 exports.BrowseResource = BrowseResource;
 exports.ClassicResource = ClassicResource;
 exports.ContentFormat = ContentFormat;

package/dist/index.mjs

@@ -727,6 +727,14 @@ 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";
@@ -800,4 +808,4 @@ var ImageSize = /* @__PURE__ */ ((ImageSize2) => {
   return ImageSize2;
 })(ImageSize || {});
 
-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 };
+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 };

package/package.json

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