@microsoft/webiq 0.1.2 → 0.1.4

package/README.md

@@ -92,6 +92,8 @@ const client = new WebIQClient({
 ### Web Search
 
 ```typescript
+import { ContentFormat, SafeSearch } from '@microsoft/webiq';
+
 const results = await client.web.search(query, {
   maxResults: 10, // 1-50, default 10
   language: 'en', // ISO 639-1 code
@@ -99,6 +101,7 @@ 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
+  safeSearch: SafeSearch.STRICT, // OFF, STRICT
   customSearchConfigId: 'my-config', // Optional custom search config
   includeDomains: ['example.com'], // Optional allowlist (max 250)
   excludeDomains: ['spam.example'], // Optional blocklist (max 250)
@@ -117,7 +120,7 @@ const results = await client.news.search(query, {
   contentFormat: ContentFormat.TEXT,
   maxLength: 10000,
 });
-// results.newsResults → [{title, url, content, source, lastUpdatedAt, thumbnail, isAdult}]
+// results.newsResults → [{title, url, content, source, lastUpdatedAt, crawledAt, thumbnail, isAdult}]
 ```
 
 ### Video Search

package/dist/index.d.mts

@@ -84,6 +84,11 @@ declare enum ContentFormat {
     MARKDOWN = "markdown"
 }
 
+declare enum SafeSearch {
+    OFF = "off",
+    STRICT = "strict"
+}
+
 declare enum ContentTier {
     STANDARD = "standard",
     ENTITLED = "entitled",
@@ -171,18 +176,8 @@ 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[];
+    /** Safe search mode: use SafeSearch.OFF or .STRICT. */
+    safeSearch?: SafeSearch;
     /** Per-request timeout in milliseconds (overrides client default). */
     timeout?: number;
     /**
@@ -245,6 +240,10 @@ type NewsItem = {
      * The last updated date of the news, in UTC ISO8601 format.
      */
     lastUpdatedAt?: string | null;
+    /**
+     * The last crawled date of the news, follows ISO8601 format.
+     */
+    crawledAt?: string | null;
     /**
      * Publisher name, such as 'USA TODAY | MSN', 'CNN', etc.
      */
@@ -327,11 +326,6 @@ declare class NewsResource {
     search(query: string, options?: NewsSearchOptions): Promise<NewsResponse>;
 }
 
-declare enum SafeSearch {
-    OFF = "off",
-    STRICT = "strict"
-}
-
 declare enum VideoDuration {
     SHORT = "short",
     MEDIUM = "medium",

package/dist/index.d.ts

@@ -84,6 +84,11 @@ declare enum ContentFormat {
     MARKDOWN = "markdown"
 }
 
+declare enum SafeSearch {
+    OFF = "off",
+    STRICT = "strict"
+}
+
 declare enum ContentTier {
     STANDARD = "standard",
     ENTITLED = "entitled",
@@ -171,18 +176,8 @@ 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[];
+    /** Safe search mode: use SafeSearch.OFF or .STRICT. */
+    safeSearch?: SafeSearch;
     /** Per-request timeout in milliseconds (overrides client default). */
     timeout?: number;
     /**
@@ -245,6 +240,10 @@ type NewsItem = {
      * The last updated date of the news, in UTC ISO8601 format.
      */
     lastUpdatedAt?: string | null;
+    /**
+     * The last crawled date of the news, follows ISO8601 format.
+     */
+    crawledAt?: string | null;
     /**
      * Publisher name, such as 'USA TODAY | MSN', 'CNN', etc.
      */
@@ -327,11 +326,6 @@ declare class NewsResource {
     search(query: string, options?: NewsSearchOptions): Promise<NewsResponse>;
 }
 
-declare enum SafeSearch {
-    OFF = "off",
-    STRICT = "strict"
-}
-
 declare enum VideoDuration {
     SHORT = "short",
     MEDIUM = "medium",

package/dist/index.js

@@ -84,14 +84,8 @@ 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;
+    if (options?.safeSearch !== void 0) {
+      payload.safeSearch = options.safeSearch;
     }
     const result = await this.transport.request({
       method: "POST",

package/dist/index.mjs

@@ -82,14 +82,8 @@ 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;
+    if (options?.safeSearch !== void 0) {
+      payload.safeSearch = options.safeSearch;
     }
     const result = await this.transport.request({
       method: "POST",

package/package.json

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