@isdk/web-searcher 0.1.4 → 0.1.5

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/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/engines/google.ts#L24)
+Defined in: [web-searcher/src/engines/google.ts:24](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/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:2287
+Defined in: web-fetcher/dist/index.d.ts:1171
 
 Creates a new FetchSession.
 
@@ -45,7 +45,7 @@ Creates a new FetchSession.
 
 ##### options?
 
-`FetcherOptions`
+[`FetcherOptions`](../interfaces/FetcherOptions.md)
 
 Configuration options for the fetcher.
 
@@ -63,7 +63,7 @@ Configuration options for the fetcher.
 
 > `protected` **closed**: `boolean`
 
-Defined in: web-fetcher/dist/index.d.ts:2281
+Defined in: web-fetcher/dist/index.d.ts:1165
 
 #### Inherited from
 
@@ -75,7 +75,7 @@ Defined in: web-fetcher/dist/index.d.ts:2281
 
 > `readonly` **context**: `FetchContext`
 
-Defined in: web-fetcher/dist/index.d.ts:2280
+Defined in: web-fetcher/dist/index.d.ts:1164
 
 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:2276
+Defined in: web-fetcher/dist/index.d.ts:1160
 
 Unique identifier for the session.
 
@@ -101,9 +101,9 @@ Unique identifier for the session.
 
 ### options
 
-> `protected` **options**: `FetcherOptions`
+> `protected` **options**: [`FetcherOptions`](../interfaces/FetcherOptions.md)
 
-Defined in: web-fetcher/dist/index.d.ts:2272
+Defined in: web-fetcher/dist/index.d.ts:1156
 
 #### Inherited from
 
@@ -115,7 +115,7 @@ Defined in: web-fetcher/dist/index.d.ts:2272
 
 > `static` **\_isFactory**: `boolean` = `false`
 
-Defined in: [web-searcher/src/searcher.ts:33](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L33)
+Defined in: [web-searcher/src/searcher.ts:34](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L34)
 
 #### 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/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/engines/google.ts#L25)
+Defined in: [web-searcher/src/engines/google.ts:25](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/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/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L78)
+Defined in: [web-searcher/src/searcher.ts:85](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L85)
 
 Creates an instance of the registered search engine.
 
@@ -172,11 +172,39 @@ An instance of the search engine.
 
 ***
 
+### currentInstanceIndex?
+
+> `static` `optional` **currentInstanceIndex**: `number`
+
+Defined in: [web-searcher/src/searcher.ts:52](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L52)
+
+Globally shared index for tracking the currently active instance (node) across sessions.
+
+#### Inherited from
+
+[`WebSearcher`](WebSearcher.md).[`currentInstanceIndex`](WebSearcher.md#currentinstanceindex)
+
+***
+
+### defaultBaseUrls?
+
+> `static` `optional` **defaultBaseUrls**: `string`[]
+
+Defined in: [web-searcher/src/searcher.ts:49](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L49)
+
+Default base URLs for engines that support multiple instances.
+
+#### Inherited from
+
+[`WebSearcher`](WebSearcher.md).[`defaultBaseUrls`](WebSearcher.md#defaultbaseurls)
+
+***
+
 ### forEach()
 
 > `static` **forEach**: (`cb`) => `void`
 
-Defined in: [web-searcher/src/searcher.ts:85](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L85)
+Defined in: [web-searcher/src/searcher.ts:92](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L92)
 
 Iterates over all registered engines.
 
@@ -202,7 +230,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/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L69)
+Defined in: [web-searcher/src/searcher.ts:76](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L76)
 
 Retrieves a registered search engine class by name.
 
@@ -230,7 +258,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/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L40)
+Defined in: [web-searcher/src/searcher.ts:41](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L41)
 
 Custom engine name. If not provided, it is derived from the class name.
 For example, `GoogleSearcher` becomes `Google`.
@@ -245,7 +273,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/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L54)
+Defined in: [web-searcher/src/searcher.ts:61](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L61)
 
 Registers a search engine class.
 
@@ -279,7 +307,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/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L93)
+Defined in: [web-searcher/src/searcher.ts:100](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L100)
 
 Sets aliases for a registered engine.
 
@@ -311,7 +339,7 @@ Aliases to add.
 
 > `static` **unregister**: (`name?`) => `void`
 
-Defined in: [web-searcher/src/searcher.ts:61](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L61)
+Defined in: [web-searcher/src/searcher.ts:68](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L68)
 
 Unregisters a search engine.
 
@@ -339,7 +367,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/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/engines/google.ts#L61)
+Defined in: [web-searcher/src/engines/google.ts:61](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/engines/google.ts#L61)
 
 Configures pagination for Google Search results.
 Uses the 'start' URL parameter, incrementing by 10 for each page.
@@ -358,15 +386,15 @@ Uses the 'start' URL parameter, incrementing by 10 for each page.
 
 #### Get Signature
 
-> **get** **template**(): `FetcherOptions`
+> **get** **template**(): [`FetcherOptions`](../interfaces/FetcherOptions.md)
 
-Defined in: [web-searcher/src/engines/google.ts:32](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/engines/google.ts#L32)
+Defined in: [web-searcher/src/engines/google.ts:32](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/engines/google.ts#L32)
 
 Defines the fetch template for Google Search.
 
 ##### Returns
 
-`FetcherOptions`
+[`FetcherOptions`](../interfaces/FetcherOptions.md)
 
 The fetcher configuration including the URL pattern and extraction rules.
 
@@ -376,17 +404,43 @@ The fetcher configuration including the URL pattern and extraction rules.
 
 ## Methods
 
+### \_logDebug()
+
+> `protected` **\_logDebug**(`category`, ...`args`): `void`
+
+Defined in: web-fetcher/dist/index.d.ts:1172
+
+#### Parameters
+
+##### category
+
+`string`
+
+##### args
+
+...`any`[]
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`WebSearcher`](WebSearcher.md).[`_logDebug`](WebSearcher.md#_logdebug)
+
+***
+
 ### createContext()
 
 > `protected` **createContext**(`options`): `FetchContext`
 
-Defined in: [web-searcher/src/searcher.ts:155](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L155)
+Defined in: [web-searcher/src/searcher.ts:216](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L216)
 
 #### Parameters
 
 ##### options
 
-`FetcherOptions` = `...`
+[`FetcherOptions`](../interfaces/FetcherOptions.md) = `...`
 
 #### Returns
 
@@ -402,7 +456,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:2346
+Defined in: web-fetcher/dist/index.d.ts:1231
 
 Disposes of the session and its associated engine.
 
@@ -425,7 +479,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:2301
+Defined in: web-fetcher/dist/index.d.ts:1186
 
 Executes a single action within the session.
 
@@ -473,7 +527,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:2318
+Defined in: web-fetcher/dist/index.d.ts:1203
 
 Executes a sequence of actions.
 
@@ -481,13 +535,13 @@ Executes a sequence of actions.
 
 ##### actions
 
-`_RequireAtLeastOne`\<`FetchActionProperties`, `"id"` \| `"name"` \| `"action"`\>[]
+`_RequireAtLeastOne`\<`FetchActionProperties`, `"name"` \| `"id"` \| `"action"`\>[]
 
 An array of action options to be executed in order.
 
 ##### options?
 
-`Partial`\<`FetcherOptions`\> & `object`
+`Partial`\<[`FetcherOptions`](../interfaces/FetcherOptions.md)\> & `object`
 
 Optional temporary configuration overrides (e.g., timeoutMs, headers) for this batch of actions.
                  These overrides do not affect the main session context.
@@ -517,7 +571,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/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/engines/google.ts#L82)
+Defined in: [web-searcher/src/engines/google.ts:82](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/engines/google.ts#L82)
 
 Maps standard `SearchOptions` to Google's specific URL parameters.
 
@@ -551,7 +605,7 @@ A map of variables to inject into the URL template.
 
 > **getOutputs**(): `Record`\<`string`, `any`\>
 
-Defined in: web-fetcher/dist/index.d.ts:2329
+Defined in: web-fetcher/dist/index.d.ts:1214
 
 Retrieves all outputs accumulated during the session.
 
@@ -571,7 +625,7 @@ A record of stored output data.
 
 > **getState**(): `Promise`\<\{ `cookies`: `Cookie`[]; `sessionState?`: `any`; \} \| `undefined`\>
 
-Defined in: web-fetcher/dist/index.d.ts:2335
+Defined in: web-fetcher/dist/index.d.ts:1220
 
 Gets the current state of the session, including cookies and engine-specific state.
 
@@ -587,16 +641,53 @@ A promise resolving to the session state, or undefined if no engine is initializ
 
 ***
 
+### getTemplate()
+
+> `protected` **getTemplate**(`variables`, `options`): [`FetcherOptions`](../interfaces/FetcherOptions.md)
+
+Defined in: [web-searcher/src/searcher.ts:212](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L212)
+
+Dynamically retrieves the fetch template based on current variables and search options.
+
+Subclasses can override this method to return different extraction rules (actions)
+or URL patterns based on the search category, region, or other parameters.
+
+#### Parameters
+
+##### variables
+
+`Record`\<`string`, `any`\>
+
+The calculated variables (from formatOptions, pagination, etc.).
+
+##### options
+
+[`SearchOptions`](../interfaces/SearchOptions.md)
+
+The original search options provided by the user.
+
+#### Returns
+
+[`FetcherOptions`](../interfaces/FetcherOptions.md)
+
+The fetcher configuration to be used for the current request.
+
+#### Inherited from
+
+[`WebSearcher`](WebSearcher.md).[`getTemplate`](WebSearcher.md#gettemplate)
+
+***
+
 ### search()
 
 > **search**(`query`, `options`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
 
-Defined in: [web-searcher/src/searcher.ts:182](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L182)
+Defined in: [web-searcher/src/searcher.ts:246](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L246)
 
 Executes a search query.
 
-This method handles the pagination loop, variable injection, fetching,
-and result transformation.
+This method handles the pagination loop, multi-instance failover, variable injection,
+fetching, and result transformation.
 
 #### Parameters
 
@@ -628,7 +719,7 @@ A promise resolving to an array of standardized search results.
 
 > `protected` **transform**(`outputs`): `Promise`\<`any`[]\>
 
-Defined in: [web-searcher/src/engines/google.ts:145](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/engines/google.ts#L145)
+Defined in: [web-searcher/src/engines/google.ts:145](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/engines/google.ts#L145)
 
 Cleans and normalizes the extracted results.
 Specifically, it unwraps Google's redirect URLs (starting with `/url?q=`).
@@ -653,24 +744,60 @@ An array of cleaned search results.
 
 ***
 
+### validateFetchResult()
+
+> `protected` **validateFetchResult**(`results`, `context`): `Promise`\<`boolean`\>
+
+Defined in: [web-searcher/src/searcher.ts:421](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L421)
+
+Hook for subclasses to validate fetched results before they are accepted.
+If this returns false, the instance manager will consider the fetch a failure
+and automatically switch to the next available baseUrl (if any).
+
+#### Parameters
+
+##### results
+
+[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]
+
+The extracted results.
+
+##### context
+
+[`SearchContext`](../interfaces/SearchContext.md)
+
+Context including the current baseUrl and page.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+A promise resolving to true if valid, false otherwise.
+
+#### Inherited from
+
+[`WebSearcher`](WebSearcher.md).[`validateFetchResult`](WebSearcher.md#validatefetchresult)
+
+***
+
 ### search()
 
-> `static` **search**(`engineName`, `query`, `options`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
+> `static` **search**(`engineNames`, `query`, `options`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
 
-Defined in: [web-searcher/src/searcher.ts:106](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L106)
+Defined in: [web-searcher/src/searcher.ts:113](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L113)
 
-Static helper to execute a one-off search.
+Static helper to execute a one-off search or a fallback chain.
 
-It creates an instance of the specified engine, executes the search, and then
-automatically disposes of the session.
+It creates an instance of the specified engine(s), executes the search, and automatically
+falls back to the next engine in the list if the current one fails or is exhausted.
 
 #### Parameters
 
-##### engineName
+##### engineNames
 
-`string`
+The name(s) of the engine(s) to use (e.g., 'Google' or ['SearXNG', 'Google']).
 
-The name of the engine to use (e.g., 'Google').
+`string` | `string`[]
 
 ##### query
 
@@ -680,7 +807,7 @@ The search query string.
 
 ##### options
 
-[`SearchOptions`](../interfaces/SearchOptions.md) & `FetcherOptions` = `{}`
+[`SearchOptions`](../interfaces/SearchOptions.md) & [`FetcherOptions`](../interfaces/FetcherOptions.md) = `{}`
 
 Combined search options and fetcher options.