@isdk/web-searcher 0.1.2 → 0.1.4

package/docs/interfaces/SearchOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: SearchOptions
 
-Defined in: [web-searcher/src/types.ts:94](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L94)
+Defined in: [web-searcher/src/types.ts:120](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L120)
 
 Options provided when executing a search.
 
@@ -22,7 +22,7 @@ Any other custom variables to be injected into the template.
 
 > `optional` **category**: [`SearchCategory`](../type-aliases/SearchCategory.md)
 
-Defined in: [web-searcher/src/types.ts:108](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L108)
+Defined in: [web-searcher/src/types.ts:144](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L144)
 
 The category of results to return.
 Default: 'all' (web search)
@@ -33,7 +33,7 @@ Default: 'all' (web search)
 
 > `optional` **language**: `string`
 
-Defined in: [web-searcher/src/types.ts:118](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L118)
+Defined in: [web-searcher/src/types.ts:154](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L154)
 
 Language code (ISO 639-1) for the interface or results (e.g., 'en', 'zh-CN').
 
@@ -43,17 +43,32 @@ Language code (ISO 639-1) for the interface or results (e.g., 'en', 'zh-CN').
 
 > `optional` **limit**: `number`
 
-Defined in: [web-searcher/src/types.ts:96](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L96)
+Defined in: [web-searcher/src/types.ts:122](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L122)
 
 The maximum number of results to retrieve.
 
 ***
 
+### maxPages?
+
+> `optional` **maxPages**: `number`
+
+Defined in: [web-searcher/src/types.ts:132](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L132)
+
+The maximum number of pages (fetch cycles) allowed to reach the requested `limit`.
+
+This is a safety guard. If the `limit` is high but each page has few results, 
+the searcher will stop once this page count is reached.
+
+If not provided, it defaults to the value in `PaginationConfig` or 10.
+
+***
+
 ### region?
 
 > `optional` **region**: `string`
 
-Defined in: [web-searcher/src/types.ts:113](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L113)
+Defined in: [web-searcher/src/types.ts:149](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L149)
 
 Region code (ISO 3166-1 alpha-2) to bias results (e.g., 'US', 'CN', 'JP').
 
@@ -63,7 +78,7 @@ Region code (ISO 3166-1 alpha-2) to bias results (e.g., 'US', 'CN', 'JP').
 
 > `optional` **safeSearch**: [`SafeSearchLevel`](../type-aliases/SafeSearchLevel.md)
 
-Defined in: [web-searcher/src/types.ts:124](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L124)
+Defined in: [web-searcher/src/types.ts:160](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L160)
 
 Safe search filtering level.
 Default: engine dependent (usually 'moderate' or 'strict' by default).
@@ -74,7 +89,7 @@ Default: engine dependent (usually 'moderate' or 'strict' by default).
 
 > `optional` **timeRange**: [`SearchTimeRange`](../type-aliases/SearchTimeRange.md)
 
-Defined in: [web-searcher/src/types.ts:102](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L102)
+Defined in: [web-searcher/src/types.ts:138](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L138)
 
 Date range for the search results.
 Default: 'all'
@@ -85,7 +100,7 @@ Default: 'all'
 
 > `optional` **transform**: (`results`, `context`) => [`StandardSearchResult`](StandardSearchResult.md)[] \| `Promise`\<[`StandardSearchResult`](StandardSearchResult.md)[]\>
 
-Defined in: [web-searcher/src/types.ts:130](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L130)
+Defined in: [web-searcher/src/types.ts:166](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L166)
 
 A custom transform function to filter or modify results at runtime.
 This runs AFTER the engine-level transform.

package/docs/interfaces/StandardSearchResult.md

@@ -6,7 +6,7 @@
 
 # Interface: StandardSearchResult
 
-Defined in: [web-searcher/src/types.ts:5](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L5)
+Defined in: [web-searcher/src/types.ts:5](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L5)
 
 Interface representing a standardized search result item.
 This ensures consistency across different search engines.
@@ -15,35 +15,85 @@ This ensures consistency across different search engines.
 
 \[`key`: `string`\]: `any`
 
-Allows for engine-specific extra fields (e.g., rank, author, date).
+Allows for engine-specific extra fields (e.g., siteIcon, category).
 
 ## Properties
 
+### author?
+
+> `optional` **author**: `string`
+
+Defined in: [web-searcher/src/types.ts:22](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L22)
+
+The author or source name of the result.
+
+***
+
+### date?
+
+> `optional` **date**: `string` \| `Date`
+
+Defined in: [web-searcher/src/types.ts:19](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L19)
+
+The date the result was published or last updated.
+
+***
+
+### favicon?
+
+> `optional` **favicon**: `string`
+
+Defined in: [web-searcher/src/types.ts:25](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L25)
+
+The favicon URL of the source website.
+
+***
+
 ### image?
 
 > `optional` **image**: `string`
 
-Defined in: [web-searcher/src/types.ts:16](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L16)
+Defined in: [web-searcher/src/types.ts:16](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L16)
 
 An optional image URL associated with the result.
 
 ***
 
+### rank?
+
+> `optional` **rank**: `number`
+
+Defined in: [web-searcher/src/types.ts:28](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L28)
+
+The rank or position of the result (usually 1-indexed).
+
+***
+
 ### snippet?
 
 > `optional` **snippet**: `string`
 
-Defined in: [web-searcher/src/types.ts:13](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L13)
+Defined in: [web-searcher/src/types.ts:13](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L13)
 
 A brief snippet or description of the result.
 
 ***
 
+### source?
+
+> `optional` **source**: `string`
+
+Defined in: [web-searcher/src/types.ts:31](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L31)
+
+The source website name (e.g., 'GitHub', 'StackOverflow').
+
+***
+
 ### title
 
 > **title**: `string`
 
-Defined in: [web-searcher/src/types.ts:7](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L7)
+Defined in: [web-searcher/src/types.ts:7](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L7)
 
 The title of the search result.
 
@@ -53,6 +103,6 @@ The title of the search result.
 
 > **url**: `string`
 
-Defined in: [web-searcher/src/types.ts:10](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L10)
+Defined in: [web-searcher/src/types.ts:10](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L10)
 
 The URL of the search result.

package/docs/type-aliases/SafeSearchLevel.md

@@ -8,4 +8,4 @@
 
 > **SafeSearchLevel** = `"off"` \| `"moderate"` \| `"strict"`
 
-Defined in: [web-searcher/src/types.ts:89](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L89)
+Defined in: [web-searcher/src/types.ts:115](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L115)

package/docs/type-aliases/SearchCategory.md

@@ -8,4 +8,4 @@
 
 > **SearchCategory** = `"all"` \| `"images"` \| `"videos"` \| `"news"`
 
-Defined in: [web-searcher/src/types.ts:87](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L87)
+Defined in: [web-searcher/src/types.ts:113](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L113)

package/docs/type-aliases/SearchTimeRange.md

@@ -8,4 +8,4 @@
 
 > **SearchTimeRange** = [`SearchTimeRangePreset`](SearchTimeRangePreset.md) \| [`CustomTimeRange`](../interfaces/CustomTimeRange.md)
 
-Defined in: [web-searcher/src/types.ts:85](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L85)
+Defined in: [web-searcher/src/types.ts:111](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L111)

package/docs/type-aliases/SearchTimeRangePreset.md

@@ -6,6 +6,6 @@
 
 # Type Alias: SearchTimeRangePreset
 
-> **SearchTimeRangePreset** = `"all"` \| `"day"` \| `"week"` \| `"month"` \| `"year"`
+> **SearchTimeRangePreset** = `"all"` \| `"hour"` \| `"day"` \| `"week"` \| `"month"` \| `"year"`
 
-Defined in: [web-searcher/src/types.ts:76](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L76)
+Defined in: [web-searcher/src/types.ts:102](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L102)

package/docs/type-aliases/SearcherConstructor.md

@@ -8,7 +8,7 @@
 
 > **SearcherConstructor** = (`options?`) => [`WebSearcher`](../classes/WebSearcher.md)
 
-Defined in: [web-searcher/src/searcher.ts:10](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L10)
+Defined in: [web-searcher/src/searcher.ts:10](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L10)
 
 Constructor definition for Searcher subclasses.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isdk/web-searcher",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "A high-level framework for building search engine scrapers, supporting multi-page navigation, session persistence, and result standardization.",
   "license": "MIT",
   "author": "Riceball LEE <snowyu.lee@gmail.com>",