@isdk/web-searcher 0.1.1 → 0.1.3

package/docs/README.md

@@ -15,53 +15,57 @@ Building a robust search scraper involves more than just fetching a URL. You oft
 - **Data Cleaning**: Parse raw HTML and resolve redirect links.
 - **Flexibility**: Switch between HTTP (fast) and Browser (anti-bot) modes easily.
 
-This module encapsulates these patterns into a reusable `Searcher` class.
+This module encapsulates these patterns into a reusable `WebSearcher` class.
 
 ## 🚀 Quick Start
 
 ### 1. One-off Search
 
-Use the static `Searcher.search` method for quick, disposable tasks. It automatically creates a session, fetches results, and cleans up.
+> **⚠️ Note on `GoogleSearcher`**: The `GoogleSearcher` class used in these examples is a **demo implementation** included for educational purposes. It is not intended for production use.
+>
+> * It lacks advanced anti-bot handling (CAPTCHA solving, proxy rotation) required for scraping Google reliably at scale.
+> * The extracted data may be **inaccurate or misaligned** due to Google's frequent DOM changes and A/B testing.
+
+Use the static `WebSearcher.search` method for quick, disposable tasks. It automatically creates a session, fetches results, and cleans up.
 
 ```typescript
-import { Searcher } from '@isdk/web-fetcher/search';
-import { GoogleSearcher } from '@isdk/web-fetcher/search/engines/google';
+import { GoogleSearcher, WebSearcher } from '@isdk/web-fetcher';
 
 // Register the engine (only needs to be done once)
-Searcher.register(GoogleSearcher);
+WebSearcher.register(GoogleSearcher);
 
 // Search!
 // The 'limit' parameter ensures we fetch enough pages to get 20 results.
 // Note: The engine name is case-sensitive and derived from the class name (e.g., 'GoogleSearcher' -> 'Google')
-const results = await Searcher.search('Google', 'open source', { limit: 20 });
+const results = await WebSearcher.search('Google', 'open source', { limit: 20 });
 
 console.log(results);
 ```
 
 ### 2. Stateful Session
 
-Since `Searcher` extends `FetchSession`, you can instantiate it to keep cookies and storage alive across multiple requests. This is useful for authenticated searches or avoiding bot detection by behaving like a human.
+Since `WebSearcher` extends `FetchSession`, you can instantiate it to keep cookies and storage alive across multiple requests. This is useful for authenticated searches or avoiding bot detection by behaving like a human.
+
+### 🛡️ Core Principle: Template is Law
 
-**Configuration Precedence:**
-When creating a session, options are merged in the following order:
-1. **Template Default**: Defined in the Searcher class (highest priority for structural options).
-2. **User Options**: Passed to the constructor (can fill missing defaults or override if allowed).
+The `template` defined in the `WebSearcher` subclass acts as the authoritative "blueprint".
 
-*Note: If the template sets `engine: 'auto'` (default), user-provided `engine` option will be respected.*
+- **Template Priority**: If the template defines a property (e.g., `engine: 'browser'`, `headers`), that value is **locked** and cannot be overridden by user options. This ensures engine stability.
+- **User Flexibility**: Properties **not** explicitly defined in the template (such as `proxy`, `timeoutMs`, or custom variables) can be freely set by the user in the constructor or `search()` method.
 
 ```typescript
 // Create a persistent session
 const google = new GoogleSearcher({
-  headless: false, // Override default options (e.g., show browser)
+  headless: false, // Override if not locked in template
   proxy: 'http://my-proxy:8080',
-  timeoutMs: 30000 // Set a global timeout for requests
+  timeoutMs: 30000 // Set a global timeout (valid if template doesn't define it)
 });
 
 try {
   // First query
   // You can also pass runtime options to override session defaults or inject variables
   const results1 = await google.search('term A', {
-    timeoutMs: 60000, // Override timeout just for this search
+    timeoutMs: 60000, // Override session timeout just for this search
     extraParam: 'value' // Can be used in template as ${extraParam}
   });
 
@@ -75,11 +79,11 @@ try {
 
 ## 🛠️ Implementing a New Search Engine
 
-To support a new website, create a class that extends `Searcher`.
+To support a new website, create a class that extends `WebSearcher`.
 
 ### Step 1: Define the Template
 
-To support a new website, create a class that extends `Searcher`. The engine name is automatically derived from the class name (e.g., `MyBlogSearcher` -> `MyBlog`), but you can customize it and add aliases using static properties.
+To support a new website, create a class that extends `WebSearcher`. The engine name is automatically derived from the class name (e.g., `MyBlogSearcher` -> `MyBlog`), but you can customize it and add aliases using static properties.
 
 The `template` property defines the "Blueprint" for your search. It's a standard `FetcherOptions` object but supports **variable injection**.
 
@@ -91,10 +95,10 @@ Supported variables:
 - `${limit}`: The requested limit.
 
 ```typescript
-import { Searcher } from '@isdk/web-fetcher/search';
+import { WebSearcher } from '@isdk/web-fetcher/search';
 import { FetcherOptions } from '@isdk/web-fetcher/types';
 
-export class MyBlogSearcher extends Searcher {
+export class MyBlogSearcher extends WebSearcher {
   static name = 'blog'; // Custom name (case-sensitive)
   static alias = ['myblog', 'news'];
 
@@ -124,7 +128,7 @@ export class MyBlogSearcher extends Searcher {
 
 ### Step 2: Configure Pagination
 
-Tell the `Searcher` how to navigate to the next page. Implement the `pagination` getter.
+Tell the `WebSearcher` how to navigate to the next page. Implement the `pagination` getter.
 
 #### Option A: URL Parameters (Offset/Page)
 
@@ -156,7 +160,7 @@ protected override get pagination() {
 
 ### Step 3: Transform & Clean Data
 
-Override `transform` to clean data. Since `Searcher` is a `FetchSession`, you can also make extra requests (like resolving redirects) using `this`.
+Override `transform` to clean data. Since `WebSearcher` is a `FetchSession`, you can also make extra requests (like resolving redirects) using `this`.
 
 ```typescript
 protected override async transform(outputs: Record<string, any>) {
@@ -171,24 +175,43 @@ protected override async transform(outputs: Record<string, any>) {
 }
 ```
 
-## 🧠 Advanced Concepts
+### 🧠 Advanced Concepts
+
+### Auto-Pagination: `limit` vs `maxPages`
+
+The `WebSearcher` is designed to be result-oriented. When you call `search()`, you specify how many results you want, and the searcher handles the pagination logic.
+
+- **`limit`**: Your target number of total results.
+- **`maxPages`**: The safety threshold. It limits how many pages (fetch cycles) the searcher is allowed to navigate to satisfy your `limit`.
 
-### Auto-Pagination & Filtering
+**Example Logic:**
+If you request `{ limit: 50 }` but each page only has 5 results:
 
-The `Searcher` is smart. If you request `limit: 10`, but the first page only returns 5 results (or if your `transform` filters out results), it will automatically fetch the next page until the limit is met.
+1. The searcher fetches page 1 (5 results).
+2. It sees `5 < 50`, so it fetches page 2.
+3. It continues until it has 50 results **OR** it reaches `maxPages` (default 10).
+
+This prevent infinite loops if the "Next" button selector is broken or if the search engine keeps returning the same results.
 
 ### User-defined Transforms
 
 Users can provide their own `transform` when calling `search`. This runs **after** the engine's built-in transform.
 
+This is extremely powerful for **filtering out ads** or irrelevant content. If the user filters out results, the auto-pagination logic will automatically kick in to fetch more pages to ensure the final result list meets your requested `limit` with only valid entries.
+
 ```typescript
 await google.search('test', {
-  transform: (results) => results.filter(r => r.url.endsWith('.pdf'))
+  limit: 20,
+  // Example: Filter out sponsored results and only keep PDFs
+  transform: (results) => {
+    return results.filter(r => {
+      const isAd = r.isSponsored || r.url.includes('googleadservices.com');
+      return !isAd && r.url.endsWith('.pdf');
+    });
+  }
 });
 ```
 
-If the user filters out results, the auto-pagination logic will kick in to fetch more pages to meet the requested limit.
-
 ### Standardized Search Options
 
 When calling `search()`, you can provide standardized options that the search engine will map to specific parameters:

package/docs/classes/GoogleSearcher.md

@@ -6,7 +6,7 @@
 
 # Class: GoogleSearcher
 
-Defined in: [web-searcher/src/engines/google.ts:24](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/engines/google.ts#L24)
+Defined in: [web-searcher/src/engines/google.ts:24](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/engines/google.ts#L24)
 
 A sample implementation of a Google Search scraper.
 
@@ -37,7 +37,7 @@ Use this class to understand:
 
 > **new GoogleSearcher**(`options?`): `GoogleSearcher`
 
-Defined in: web-fetcher/dist/index.d.ts:2192
+Defined in: web-fetcher/dist/index.d.ts:2275
 
 Creates a new FetchSession.
 
@@ -63,7 +63,7 @@ Configuration options for the fetcher.
 
 > `protected` **closed**: `boolean`
 
-Defined in: web-fetcher/dist/index.d.ts:2186
+Defined in: web-fetcher/dist/index.d.ts:2269
 
 #### Inherited from
 
@@ -75,7 +75,7 @@ Defined in: web-fetcher/dist/index.d.ts:2186
 
 > `readonly` **context**: `FetchContext`
 
-Defined in: web-fetcher/dist/index.d.ts:2185
+Defined in: web-fetcher/dist/index.d.ts:2268
 
 The execution context for this session, containing configurations, event bus, and shared state.
 
@@ -89,7 +89,7 @@ The execution context for this session, containing configurations, event bus, an
 
 > `readonly` **id**: `string`
 
-Defined in: web-fetcher/dist/index.d.ts:2181
+Defined in: web-fetcher/dist/index.d.ts:2264
 
 Unique identifier for the session.
 
@@ -103,7 +103,7 @@ Unique identifier for the session.
 
 > `protected` **options**: `FetcherOptions`
 
-Defined in: web-fetcher/dist/index.d.ts:2177
+Defined in: web-fetcher/dist/index.d.ts:2260
 
 #### Inherited from
 
@@ -115,7 +115,7 @@ Defined in: web-fetcher/dist/index.d.ts:2177
 
 > `static` **\_isFactory**: `boolean` = `false`
 
-Defined in: [web-searcher/src/searcher.ts:33](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L33)
+Defined in: [web-searcher/src/searcher.ts:33](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L33)
 
 #### Inherited from
 
@@ -127,7 +127,7 @@ Defined in: [web-searcher/src/searcher.ts:33](https://github.com/isdk/web-search
 
 > `static` **alias**: `string`[]
 
-Defined in: [web-searcher/src/engines/google.ts:25](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/engines/google.ts#L25)
+Defined in: [web-searcher/src/engines/google.ts:25](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/engines/google.ts#L25)
 
 Engine alias(es). Can be a single string or an array of strings.
 Useful for registering shorthand names (e.g., 'g' for 'Google').
@@ -142,7 +142,7 @@ Useful for registering shorthand names (e.g., 'g' for 'Google').
 
 > `static` **createObject**: (`name`, ...`args`) => [`WebSearcher`](WebSearcher.md)
 
-Defined in: [web-searcher/src/searcher.ts:78](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L78)
+Defined in: [web-searcher/src/searcher.ts:78](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L78)
 
 Creates an instance of the registered search engine.
 
@@ -176,7 +176,7 @@ An instance of the search engine.
 
 > `static` **forEach**: (`cb`) => `void`
 
-Defined in: [web-searcher/src/searcher.ts:85](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L85)
+Defined in: [web-searcher/src/searcher.ts:85](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L85)
 
 Iterates over all registered engines.
 
@@ -202,7 +202,7 @@ Callback function to invoke for each registered engine.
 
 > `static` **get**: (`name`) => *typeof* [`WebSearcher`](WebSearcher.md)
 
-Defined in: [web-searcher/src/searcher.ts:69](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L69)
+Defined in: [web-searcher/src/searcher.ts:69](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L69)
 
 Retrieves a registered search engine class by name.
 
@@ -230,7 +230,7 @@ The search engine class constructor.
 
 > `static` `optional` **name**: `string`
 
-Defined in: [web-searcher/src/searcher.ts:40](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L40)
+Defined in: [web-searcher/src/searcher.ts:40](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L40)
 
 Custom engine name. If not provided, it is derived from the class name.
 For example, `GoogleSearcher` becomes `Google`.
@@ -245,7 +245,7 @@ For example, `GoogleSearcher` becomes `Google`.
 
 > `static` **register**: (`ctor`, `options?`) => `boolean`
 
-Defined in: [web-searcher/src/searcher.ts:54](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L54)
+Defined in: [web-searcher/src/searcher.ts:54](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L54)
 
 Registers a search engine class.
 
@@ -279,7 +279,7 @@ Registration options. If a string is provided, it is used as the registered name
 
 > `static` **setAliases**: (`ctor`, ...`aliases`) => `void`
 
-Defined in: [web-searcher/src/searcher.ts:93](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L93)
+Defined in: [web-searcher/src/searcher.ts:93](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L93)
 
 Sets aliases for a registered engine.
 
@@ -311,7 +311,7 @@ Aliases to add.
 
 > `static` **unregister**: (`name?`) => `void`
 
-Defined in: [web-searcher/src/searcher.ts:61](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L61)
+Defined in: [web-searcher/src/searcher.ts:61](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L61)
 
 Unregisters a search engine.
 
@@ -339,7 +339,7 @@ The name or class to unregister.
 
 > **get** **pagination**(): [`PaginationConfig`](../interfaces/PaginationConfig.md)
 
-Defined in: [web-searcher/src/engines/google.ts:61](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/engines/google.ts#L61)
+Defined in: [web-searcher/src/engines/google.ts:61](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/engines/google.ts#L61)
 
 Configures pagination for Google Search results.
 Uses the 'start' URL parameter, incrementing by 10 for each page.
@@ -360,7 +360,7 @@ Uses the 'start' URL parameter, incrementing by 10 for each page.
 
 > **get** **template**(): `FetcherOptions`
 
-Defined in: [web-searcher/src/engines/google.ts:32](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/engines/google.ts#L32)
+Defined in: [web-searcher/src/engines/google.ts:32](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/engines/google.ts#L32)
 
 Defines the fetch template for Google Search.
 
@@ -380,7 +380,7 @@ The fetcher configuration including the URL pattern and extraction rules.
 
 > `protected` **createContext**(`options`): `FetchContext`
 
-Defined in: [web-searcher/src/searcher.ts:155](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L155)
+Defined in: [web-searcher/src/searcher.ts:155](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L155)
 
 #### Parameters
 
@@ -402,7 +402,7 @@ Defined in: [web-searcher/src/searcher.ts:155](https://github.com/isdk/web-searc
 
 > **dispose**(): `Promise`\<`void`\>
 
-Defined in: web-fetcher/dist/index.d.ts:2251
+Defined in: web-fetcher/dist/index.d.ts:2334
 
 Disposes of the session and its associated engine.
 
@@ -425,7 +425,7 @@ This method should be called when the session is no longer needed to free up res
 
 > **execute**\<`R`\>(`actionOptions`, `context?`): `Promise`\<`FetchActionResult`\<`R`\>\>
 
-Defined in: web-fetcher/dist/index.d.ts:2206
+Defined in: web-fetcher/dist/index.d.ts:2289
 
 Executes a single action within the session.
 
@@ -473,7 +473,7 @@ await session.execute({ name: 'goto', params: { url: 'https://example.com' } });
 
 > **executeAll**(`actions`, `options?`): `Promise`\<\{ `outputs`: `Record`\<`string`, `any`\>; `result`: `FetchResponse` \| `undefined`; \}\>
 
-Defined in: web-fetcher/dist/index.d.ts:2223
+Defined in: web-fetcher/dist/index.d.ts:2306
 
 Executes a sequence of actions.
 
@@ -517,7 +517,7 @@ const { result, outputs } = await session.executeAll([
 
 > `protected` **formatOptions**(`options`): `Record`\<`string`, `any`\>
 
-Defined in: [web-searcher/src/engines/google.ts:82](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/engines/google.ts#L82)
+Defined in: [web-searcher/src/engines/google.ts:82](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/engines/google.ts#L82)
 
 Maps standard `SearchOptions` to Google's specific URL parameters.
 
@@ -551,7 +551,7 @@ A map of variables to inject into the URL template.
 
 > **getOutputs**(): `Record`\<`string`, `any`\>
 
-Defined in: web-fetcher/dist/index.d.ts:2234
+Defined in: web-fetcher/dist/index.d.ts:2317
 
 Retrieves all outputs accumulated during the session.
 
@@ -571,7 +571,7 @@ A record of stored output data.
 
 > **getState**(): `Promise`\<\{ `cookies`: `Cookie`[]; `sessionState?`: `any`; \} \| `undefined`\>
 
-Defined in: web-fetcher/dist/index.d.ts:2240
+Defined in: web-fetcher/dist/index.d.ts:2323
 
 Gets the current state of the session, including cookies and engine-specific state.
 
@@ -591,7 +591,7 @@ A promise resolving to the session state, or undefined if no engine is initializ
 
 > **search**(`query`, `options`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
 
-Defined in: [web-searcher/src/searcher.ts:182](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L182)
+Defined in: [web-searcher/src/searcher.ts:182](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L182)
 
 Executes a search query.
 
@@ -628,7 +628,7 @@ A promise resolving to an array of standardized search results.
 
 > `protected` **transform**(`outputs`): `Promise`\<`any`[]\>
 
-Defined in: [web-searcher/src/engines/google.ts:144](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/engines/google.ts#L144)
+Defined in: [web-searcher/src/engines/google.ts:144](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/engines/google.ts#L144)
 
 Cleans and normalizes the extracted results.
 Specifically, it unwraps Google's redirect URLs (starting with `/url?q=`).
@@ -657,7 +657,7 @@ An array of cleaned search results.
 
 > `static` **search**(`engineName`, `query`, `options`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
 
-Defined in: [web-searcher/src/searcher.ts:106](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L106)
+Defined in: [web-searcher/src/searcher.ts:106](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L106)
 
 Static helper to execute a one-off search.
 

package/docs/classes/WebSearcher.md

@@ -6,7 +6,7 @@
 
 # Abstract Class: WebSearcher
 
-Defined in: [web-searcher/src/searcher.ts:31](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L31)
+Defined in: [web-searcher/src/searcher.ts:31](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L31)
 
 The abstract base class for all search engines.
 
@@ -41,7 +41,7 @@ WebSearcher.register(MySearcher);
 
 > **new WebSearcher**(`options?`): `WebSearcher`
 
-Defined in: web-fetcher/dist/index.d.ts:2192
+Defined in: web-fetcher/dist/index.d.ts:2275
 
 Creates a new FetchSession.
 
@@ -67,7 +67,7 @@ Configuration options for the fetcher.
 
 > `protected` **closed**: `boolean`
 
-Defined in: web-fetcher/dist/index.d.ts:2186
+Defined in: web-fetcher/dist/index.d.ts:2269
 
 #### Inherited from
 
@@ -79,7 +79,7 @@ Defined in: web-fetcher/dist/index.d.ts:2186
 
 > `readonly` **context**: `FetchContext`
 
-Defined in: web-fetcher/dist/index.d.ts:2185
+Defined in: web-fetcher/dist/index.d.ts:2268
 
 The execution context for this session, containing configurations, event bus, and shared state.
 
@@ -93,7 +93,7 @@ The execution context for this session, containing configurations, event bus, an
 
 > `readonly` **id**: `string`
 
-Defined in: web-fetcher/dist/index.d.ts:2181
+Defined in: web-fetcher/dist/index.d.ts:2264
 
 Unique identifier for the session.
 
@@ -107,7 +107,7 @@ Unique identifier for the session.
 
 > `protected` **options**: `FetcherOptions`
 
-Defined in: web-fetcher/dist/index.d.ts:2177
+Defined in: web-fetcher/dist/index.d.ts:2260
 
 #### Inherited from
 
@@ -119,7 +119,7 @@ Defined in: web-fetcher/dist/index.d.ts:2177
 
 > `static` **\_isFactory**: `boolean` = `false`
 
-Defined in: [web-searcher/src/searcher.ts:33](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L33)
+Defined in: [web-searcher/src/searcher.ts:33](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L33)
 
 ***
 
@@ -127,7 +127,7 @@ Defined in: [web-searcher/src/searcher.ts:33](https://github.com/isdk/web-search
 
 > `static` `optional` **alias**: `string` \| `string`[]
 
-Defined in: [web-searcher/src/searcher.ts:45](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L45)
+Defined in: [web-searcher/src/searcher.ts:45](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L45)
 
 Engine alias(es). Can be a single string or an array of strings.
 Useful for registering shorthand names (e.g., 'g' for 'Google').
@@ -138,7 +138,7 @@ Useful for registering shorthand names (e.g., 'g' for 'Google').
 
 > `static` **createObject**: (`name`, ...`args`) => `WebSearcher`
 
-Defined in: [web-searcher/src/searcher.ts:78](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L78)
+Defined in: [web-searcher/src/searcher.ts:78](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L78)
 
 Creates an instance of the registered search engine.
 
@@ -168,7 +168,7 @@ An instance of the search engine.
 
 > `static` **forEach**: (`cb`) => `void`
 
-Defined in: [web-searcher/src/searcher.ts:85](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L85)
+Defined in: [web-searcher/src/searcher.ts:85](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L85)
 
 Iterates over all registered engines.
 
@@ -190,7 +190,7 @@ Callback function to invoke for each registered engine.
 
 > `static` **get**: (`name`) => *typeof* `WebSearcher`
 
-Defined in: [web-searcher/src/searcher.ts:69](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L69)
+Defined in: [web-searcher/src/searcher.ts:69](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L69)
 
 Retrieves a registered search engine class by name.
 
@@ -214,7 +214,7 @@ The search engine class constructor.
 
 > `static` `optional` **name**: `string`
 
-Defined in: [web-searcher/src/searcher.ts:40](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L40)
+Defined in: [web-searcher/src/searcher.ts:40](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L40)
 
 Custom engine name. If not provided, it is derived from the class name.
 For example, `GoogleSearcher` becomes `Google`.
@@ -225,7 +225,7 @@ For example, `GoogleSearcher` becomes `Google`.
 
 > `static` **register**: (`ctor`, `options?`) => `boolean`
 
-Defined in: [web-searcher/src/searcher.ts:54](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L54)
+Defined in: [web-searcher/src/searcher.ts:54](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L54)
 
 Registers a search engine class.
 
@@ -255,7 +255,7 @@ Registration options. If a string is provided, it is used as the registered name
 
 > `static` **setAliases**: (`ctor`, ...`aliases`) => `void`
 
-Defined in: [web-searcher/src/searcher.ts:93](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L93)
+Defined in: [web-searcher/src/searcher.ts:93](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L93)
 
 Sets aliases for a registered engine.
 
@@ -283,7 +283,7 @@ Aliases to add.
 
 > `static` **unregister**: (`name?`) => `void`
 
-Defined in: [web-searcher/src/searcher.ts:61](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L61)
+Defined in: [web-searcher/src/searcher.ts:61](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L61)
 
 Unregisters a search engine.
 
@@ -307,7 +307,7 @@ The name or class to unregister.
 
 > **get** **pagination**(): [`PaginationConfig`](../interfaces/PaginationConfig.md) \| `undefined`
 
-Defined in: [web-searcher/src/searcher.ts:151](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L151)
+Defined in: [web-searcher/src/searcher.ts:151](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L151)
 
 Optional pagination configuration.
 Defines how the searcher navigates to subsequent pages.
@@ -326,7 +326,7 @@ If undefined, the searcher will only fetch the first page.
 
 > **get** `abstract` **template**(): `FetcherOptions`
 
-Defined in: [web-searcher/src/searcher.ts:143](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L143)
+Defined in: [web-searcher/src/searcher.ts:143](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L143)
 
 The declarative template for the fetch options.
 
@@ -356,7 +356,7 @@ get template() {
 
 > `protected` **createContext**(`options`): `FetchContext`
 
-Defined in: [web-searcher/src/searcher.ts:155](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L155)
+Defined in: [web-searcher/src/searcher.ts:155](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L155)
 
 #### Parameters
 
@@ -378,7 +378,7 @@ Defined in: [web-searcher/src/searcher.ts:155](https://github.com/isdk/web-searc
 
 > **dispose**(): `Promise`\<`void`\>
 
-Defined in: web-fetcher/dist/index.d.ts:2251
+Defined in: web-fetcher/dist/index.d.ts:2334
 
 Disposes of the session and its associated engine.
 
@@ -401,7 +401,7 @@ This method should be called when the session is no longer needed to free up res
 
 > **execute**\<`R`\>(`actionOptions`, `context?`): `Promise`\<`FetchActionResult`\<`R`\>\>
 
-Defined in: web-fetcher/dist/index.d.ts:2206
+Defined in: web-fetcher/dist/index.d.ts:2289
 
 Executes a single action within the session.
 
@@ -449,7 +449,7 @@ await session.execute({ name: 'goto', params: { url: 'https://example.com' } });
 
 > **executeAll**(`actions`, `options?`): `Promise`\<\{ `outputs`: `Record`\<`string`, `any`\>; `result`: `FetchResponse` \| `undefined`; \}\>
 
-Defined in: web-fetcher/dist/index.d.ts:2223
+Defined in: web-fetcher/dist/index.d.ts:2306
 
 Executes a sequence of actions.
 
@@ -493,7 +493,7 @@ const { result, outputs } = await session.executeAll([
 
 > `protected` **formatOptions**(`options`): `Record`\<`string`, `any`\>
 
-Defined in: [web-searcher/src/searcher.ts:308](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L308)
+Defined in: [web-searcher/src/searcher.ts:309](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L309)
 
 Transforms standard options into engine-specific template variables.
 
@@ -521,7 +521,7 @@ A dictionary of variables to be injected into the template.
 
 > **getOutputs**(): `Record`\<`string`, `any`\>
 
-Defined in: web-fetcher/dist/index.d.ts:2234
+Defined in: web-fetcher/dist/index.d.ts:2317
 
 Retrieves all outputs accumulated during the session.
 
@@ -541,7 +541,7 @@ A record of stored output data.
 
 > **getState**(): `Promise`\<\{ `cookies`: `Cookie`[]; `sessionState?`: `any`; \} \| `undefined`\>
 
-Defined in: web-fetcher/dist/index.d.ts:2240
+Defined in: web-fetcher/dist/index.d.ts:2323
 
 Gets the current state of the session, including cookies and engine-specific state.
 
@@ -561,7 +561,7 @@ A promise resolving to the session state, or undefined if no engine is initializ
 
 > **search**(`query`, `options`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
 
-Defined in: [web-searcher/src/searcher.ts:182](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L182)
+Defined in: [web-searcher/src/searcher.ts:182](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L182)
 
 Executes a search query.
 
@@ -594,7 +594,7 @@ A promise resolving to an array of standardized search results.
 
 > `protected` **transform**(`outputs`, `context`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
 
-Defined in: [web-searcher/src/searcher.ts:290](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L290)
+Defined in: [web-searcher/src/searcher.ts:291](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L291)
 
 Transform and clean the raw extracted results.
 
@@ -627,7 +627,7 @@ A promise resolving to an array of standardized search results.
 
 > `static` **search**(`engineName`, `query`, `options`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
 
-Defined in: [web-searcher/src/searcher.ts:106](https://github.com/isdk/web-searcher.js/blob/e9a6e5ec9526780489427743389b927a5c16db5c/src/searcher.ts#L106)
+Defined in: [web-searcher/src/searcher.ts:106](https://github.com/isdk/web-searcher.js/blob/e17f1bcb40984e389c2901da9e3b4886a969899a/src/searcher.ts#L106)
 
 Static helper to execute a one-off search.