@microsoft/webiq 0.1.7 → 0.1.8

package/dist/index.d.mts

@@ -89,21 +89,38 @@ declare enum SafeSearch {
     STRICT = "strict"
 }
 
+type WebQuerySignals = {
+    /**
+     * Indicates whether fresh documents should be prioritized over other documents for this query.
+     */
+    freshness?: boolean | null;
+};
+
 declare enum ContentTier {
     STANDARD = "standard",
     ENTITLED = "entitled",
     PREMIUM = "premium"
 }
 
+declare enum SourceQuality {
+    INSUFFICIENT = "insufficient",
+    ADEQUATE = "adequate",
+    PREFERRED = "preferred"
+}
+
 type WebResult = {
     /**
      * The title of the webpage.
      */
     title?: string | null;
     /**
-     * The source URL of the webpage.
+     * The source URL of the webpage. For China users with URL redirection enabled, this field instead contains the same redirect URL as clickUrl.
      */
     url?: string | null;
+    /**
+     * The destination host for the result. Returned only for China users with URL redirection enabled.
+     */
+    domain?: string | null;
     /**
      * The detailed content of the webpage.
      */
@@ -125,6 +142,7 @@ type WebResult = {
      */
     isAdult?: boolean;
     contentTier?: ContentTier;
+    sourceQuality?: SourceQuality;
     /**
      * Redirect URL that proxies through Bing. Only present when redirect is enabled.
      */
@@ -140,6 +158,7 @@ type WebResponse = {
      * List of web page results.
      */
     webResults?: Array<WebResult> | null;
+    querySignals?: WebQuerySignals;
     /**
      * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
      */
@@ -228,9 +247,13 @@ type NewsItem = {
      */
     title?: string | null;
     /**
-     * The source URL of the news.
+     * The source URL of the news article. For China users with URL redirection enabled, this field instead contains the same redirect URL as clickUrl.
      */
     url?: string | null;
+    /**
+     * The destination host for the result. Returned only for China users with URL redirection enabled.
+     */
+    domain?: string | null;
     /**
      * The detailed content of the news.
      */
@@ -244,6 +267,10 @@ type NewsItem = {
      * The last crawled date of the news, follows ISO8601 format.
      */
     crawledAt?: string | null;
+    /**
+     * The language of the news article, uses ISO 639-1 language code.
+     */
+    language?: string | null;
     /**
      * Publisher name, such as 'USA TODAY | MSN', 'CNN', etc.
      */
@@ -398,9 +425,13 @@ type VideoItem = {
      */
     title?: string | null;
     /**
-     * The video source URL.
+     * The source URL of the video. For China users with URL redirection enabled, this field instead contains the same redirect URL as clickUrl.
      */
     url?: string | null;
+    /**
+     * The destination host for the result. Returned only for China users with URL redirection enabled.
+     */
+    domain?: string | null;
     /**
      * Description of the video content. This is either given by video uploader or generated by LLM
      */
@@ -569,9 +600,13 @@ type ImageItem = {
      */
     title?: string | null;
     /**
-     * The source URL of the image.
+     * The source URL of the image. For China users with URL redirection enabled, this field instead contains the same redirect URL as clickUrl.
      */
     url?: string | null;
+    /**
+     * The destination host for the result. Returned only for China users with URL redirection enabled.
+     */
+    domain?: string | null;
     /**
      * The host page URL of the image.
      */
@@ -1253,4 +1288,4 @@ declare class HttpTransport implements Transport {
     close(): Promise<void>;
 }
 
-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 };
+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, SourceQuality, 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 WebQuerySignals, type WebRequest, WebResource, type WebResponse, type WebResult, type WebSearchOptions, type WebSearchParams, createAuth, createClient, createTelemetryEvent, safeCall };

package/dist/index.d.ts

@@ -89,21 +89,38 @@ declare enum SafeSearch {
     STRICT = "strict"
 }
 
+type WebQuerySignals = {
+    /**
+     * Indicates whether fresh documents should be prioritized over other documents for this query.
+     */
+    freshness?: boolean | null;
+};
+
 declare enum ContentTier {
     STANDARD = "standard",
     ENTITLED = "entitled",
     PREMIUM = "premium"
 }
 
+declare enum SourceQuality {
+    INSUFFICIENT = "insufficient",
+    ADEQUATE = "adequate",
+    PREFERRED = "preferred"
+}
+
 type WebResult = {
     /**
      * The title of the webpage.
      */
     title?: string | null;
     /**
-     * The source URL of the webpage.
+     * The source URL of the webpage. For China users with URL redirection enabled, this field instead contains the same redirect URL as clickUrl.
      */
     url?: string | null;
+    /**
+     * The destination host for the result. Returned only for China users with URL redirection enabled.
+     */
+    domain?: string | null;
     /**
      * The detailed content of the webpage.
      */
@@ -125,6 +142,7 @@ type WebResult = {
      */
     isAdult?: boolean;
     contentTier?: ContentTier;
+    sourceQuality?: SourceQuality;
     /**
      * Redirect URL that proxies through Bing. Only present when redirect is enabled.
      */
@@ -140,6 +158,7 @@ type WebResponse = {
      * List of web page results.
      */
     webResults?: Array<WebResult> | null;
+    querySignals?: WebQuerySignals;
     /**
      * Base URL for click ping requests. Append an instrumentationSuffix value from a result item to form the full ping URL.
      */
@@ -228,9 +247,13 @@ type NewsItem = {
      */
     title?: string | null;
     /**
-     * The source URL of the news.
+     * The source URL of the news article. For China users with URL redirection enabled, this field instead contains the same redirect URL as clickUrl.
      */
     url?: string | null;
+    /**
+     * The destination host for the result. Returned only for China users with URL redirection enabled.
+     */
+    domain?: string | null;
     /**
      * The detailed content of the news.
      */
@@ -244,6 +267,10 @@ type NewsItem = {
      * The last crawled date of the news, follows ISO8601 format.
      */
     crawledAt?: string | null;
+    /**
+     * The language of the news article, uses ISO 639-1 language code.
+     */
+    language?: string | null;
     /**
      * Publisher name, such as 'USA TODAY | MSN', 'CNN', etc.
      */
@@ -398,9 +425,13 @@ type VideoItem = {
      */
     title?: string | null;
     /**
-     * The video source URL.
+     * The source URL of the video. For China users with URL redirection enabled, this field instead contains the same redirect URL as clickUrl.
      */
     url?: string | null;
+    /**
+     * The destination host for the result. Returned only for China users with URL redirection enabled.
+     */
+    domain?: string | null;
     /**
      * Description of the video content. This is either given by video uploader or generated by LLM
      */
@@ -569,9 +600,13 @@ type ImageItem = {
      */
     title?: string | null;
     /**
-     * The source URL of the image.
+     * The source URL of the image. For China users with URL redirection enabled, this field instead contains the same redirect URL as clickUrl.
      */
     url?: string | null;
+    /**
+     * The destination host for the result. Returned only for China users with URL redirection enabled.
+     */
+    domain?: string | null;
     /**
      * The host page URL of the image.
      */
@@ -1253,4 +1288,4 @@ declare class HttpTransport implements Transport {
     close(): Promise<void>;
 }
 
-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 };
+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, SourceQuality, 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 WebQuerySignals, type WebRequest, WebResource, type WebResponse, type WebResult, type WebSearchOptions, type WebSearchParams, createAuth, createClient, createTelemetryEvent, safeCall };

package/dist/index.js

@@ -726,6 +726,14 @@ var SafeSearch = /* @__PURE__ */ ((SafeSearch2) => {
   return SafeSearch2;
 })(SafeSearch || {});
 
+// src/generated-otc/models/SourceQuality.ts
+var SourceQuality = /* @__PURE__ */ ((SourceQuality2) => {
+  SourceQuality2["INSUFFICIENT"] = "insufficient";
+  SourceQuality2["ADEQUATE"] = "adequate";
+  SourceQuality2["PREFERRED"] = "preferred";
+  return SourceQuality2;
+})(SourceQuality || {});
+
 // src/generated-otc/models/VideoDuration.ts
 var VideoDuration = /* @__PURE__ */ ((VideoDuration2) => {
   VideoDuration2["SHORT"] = "short";
@@ -765,6 +773,7 @@ exports.PermissionDeniedError = PermissionDeniedError;
 exports.RateLimitError = RateLimitError;
 exports.RetryPolicy = RetryPolicy;
 exports.SafeSearch = SafeSearch;
+exports.SourceQuality = SourceQuality;
 exports.VideoDuration = VideoDuration;
 exports.VideoResolution = VideoResolution;
 exports.VideosResource = VideosResource;

package/dist/index.mjs

@@ -724,6 +724,14 @@ var SafeSearch = /* @__PURE__ */ ((SafeSearch2) => {
   return SafeSearch2;
 })(SafeSearch || {});
 
+// src/generated-otc/models/SourceQuality.ts
+var SourceQuality = /* @__PURE__ */ ((SourceQuality2) => {
+  SourceQuality2["INSUFFICIENT"] = "insufficient";
+  SourceQuality2["ADEQUATE"] = "adequate";
+  SourceQuality2["PREFERRED"] = "preferred";
+  return SourceQuality2;
+})(SourceQuality || {});
+
 // src/generated-otc/models/VideoDuration.ts
 var VideoDuration = /* @__PURE__ */ ((VideoDuration2) => {
   VideoDuration2["SHORT"] = "short";
@@ -741,4 +749,4 @@ var VideoResolution = /* @__PURE__ */ ((VideoResolution2) => {
   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 };
+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, SourceQuality, VideoDuration, VideoResolution, VideosResource, WebIQClient, WebIQError, WebResource, createAuth, createClient, createTelemetryEvent, safeCall };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/webiq",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "Web IQ API TypeScript SDK",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -19,8 +19,8 @@
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
-    "lint": "eslint src --ext .ts",
-    "lint:fix": "eslint src --ext .ts --fix",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
     "format": "prettier --write \"src/**/*.ts\" \"*.md\" \"*.json\" --ignore-path ../../.prettierignore",
     "format:check": "prettier --check \"src/**/*.ts\" \"*.md\" \"*.json\" --ignore-path ../../.prettierignore",
     "typecheck": "tsc --noEmit",
@@ -36,7 +36,7 @@
   "author": "Microsoft <webiqsdk@microsoft.com>",
   "license": "MIT",
   "engines": {
-    "node": ">=22",
+    "node": "^22.13.0 || >=24",
     "npm": ">=10"
   },
   "publishConfig": {
@@ -45,9 +45,10 @@
   "sideEffects": false,
   "devDependencies": {
     "@azure/identity": ">=4.13.1",
+    "@eslint/js": "^10.0.1",
     "@types/js-yaml": "^4.0.9",
     "@types/node": "^20.10.0",
-    "eslint": "^8.56.0",
+    "eslint": "^10.8.0",
     "js-yaml": "^5.2.0",
     "openapi-typescript-codegen": "^0.30.0",
     "prettier": "^3.5.3",
@@ -55,6 +56,7 @@
     "tsup": "^8.0.0",
     "tsx": "^4.21.0",
     "typescript": "^5.3.0",
+    "typescript-eslint": "^8.68.0",
     "vitest": "^4.0.18"
   },
   "peerDependencies": {