@isdk/web-searcher 0.1.5 → 0.1.6

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/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/engines/google.ts#L24)
+Defined in: [web-searcher/src/engines/google.ts:24](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/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:1171
+Defined in: web-fetcher/dist/index.d.ts:1172
 
 Creates a new FetchSession.
 
@@ -63,7 +63,7 @@ Configuration options for the fetcher.
 
 > `protected` **closed**: `boolean`
 
-Defined in: web-fetcher/dist/index.d.ts:1165
+Defined in: web-fetcher/dist/index.d.ts:1166
 
 #### Inherited from
 
@@ -75,7 +75,7 @@ Defined in: web-fetcher/dist/index.d.ts:1165
 
 > `readonly` **context**: `FetchContext`
 
-Defined in: web-fetcher/dist/index.d.ts:1164
+Defined in: web-fetcher/dist/index.d.ts:1165
 
 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:1160
+Defined in: web-fetcher/dist/index.d.ts:1161
 
 Unique identifier for the session.
 
@@ -103,7 +103,7 @@ Unique identifier for the session.
 
 > `protected` **options**: [`FetcherOptions`](../interfaces/FetcherOptions.md)
 
-Defined in: web-fetcher/dist/index.d.ts:1156
+Defined in: web-fetcher/dist/index.d.ts:1157
 
 #### Inherited from
 
@@ -111,11 +111,25 @@ Defined in: web-fetcher/dist/index.d.ts:1156
 
 ***
 
+### \_defaultOptions?
+
+> `static` `optional` **\_defaultOptions**: [`SearchOptions`](../interfaces/SearchOptions.md)
+
+Defined in: [web-searcher/src/searcher.ts:55](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L55)
+
+**`Internal`**
+
+#### Inherited from
+
+[`WebSearcher`](WebSearcher.md).[`_defaultOptions`](WebSearcher.md#_defaultoptions)
+
+***
+
 ### \_isFactory
 
 > `static` **\_isFactory**: `boolean` = `false`
 
-Defined in: [web-searcher/src/searcher.ts:34](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L34)
+Defined in: [web-searcher/src/searcher.ts:34](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L34)
 
 #### Inherited from
 
@@ -127,7 +141,7 @@ Defined in: [web-searcher/src/searcher.ts:34](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/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/engines/google.ts#L25)
+Defined in: [web-searcher/src/engines/google.ts:25](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/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 +156,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:85](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L85)
+Defined in: [web-searcher/src/searcher.ts:122](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L122)
 
 Creates an instance of the registered search engine.
 
@@ -176,7 +190,7 @@ An instance of the search engine.
 
 > `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)
+Defined in: [web-searcher/src/searcher.ts:52](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L52)
 
 Globally shared index for tracking the currently active instance (node) across sessions.
 
@@ -190,7 +204,7 @@ Globally shared index for tracking the currently active instance (node) across s
 
 > `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)
+Defined in: [web-searcher/src/searcher.ts:49](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L49)
 
 Default base URLs for engines that support multiple instances.
 
@@ -204,7 +218,7 @@ Default base URLs for engines that support multiple instances.
 
 > `static` **forEach**: (`cb`) => `void`
 
-Defined in: [web-searcher/src/searcher.ts:92](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L92)
+Defined in: [web-searcher/src/searcher.ts:129](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L129)
 
 Iterates over all registered engines.
 
@@ -230,7 +244,7 @@ Callback function to invoke for each registered engine.
 
 > `static` **get**: (`name`) => *typeof* [`WebSearcher`](WebSearcher.md)
 
-Defined in: [web-searcher/src/searcher.ts:76](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L76)
+Defined in: [web-searcher/src/searcher.ts:113](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L113)
 
 Retrieves a registered search engine class by name.
 
@@ -258,7 +272,7 @@ The search engine class constructor.
 
 > `static` `optional` **name**: `string`
 
-Defined in: [web-searcher/src/searcher.ts:41](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L41)
+Defined in: [web-searcher/src/searcher.ts:41](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L41)
 
 Custom engine name. If not provided, it is derived from the class name.
 For example, `GoogleSearcher` becomes `Google`.
@@ -273,7 +287,7 @@ For example, `GoogleSearcher` becomes `Google`.
 
 > `static` **register**: (`ctor`, `options?`) => `boolean`
 
-Defined in: [web-searcher/src/searcher.ts:61](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L61)
+Defined in: [web-searcher/src/searcher.ts:98](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L98)
 
 Registers a search engine class.
 
@@ -307,7 +321,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:100](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L100)
+Defined in: [web-searcher/src/searcher.ts:137](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L137)
 
 Sets aliases for a registered engine.
 
@@ -339,7 +353,7 @@ Aliases to add.
 
 > `static` **unregister**: (`name?`) => `void`
 
-Defined in: [web-searcher/src/searcher.ts:68](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L68)
+Defined in: [web-searcher/src/searcher.ts:105](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L105)
 
 Unregisters a search engine.
 
@@ -367,7 +381,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/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/engines/google.ts#L61)
+Defined in: [web-searcher/src/engines/google.ts:61](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/engines/google.ts#L61)
 
 Configures pagination for Google Search results.
 Uses the 'start' URL parameter, incrementing by 10 for each page.
@@ -388,7 +402,7 @@ Uses the 'start' URL parameter, incrementing by 10 for each page.
 
 > **get** **template**(): [`FetcherOptions`](../interfaces/FetcherOptions.md)
 
-Defined in: [web-searcher/src/engines/google.ts:32](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/engines/google.ts#L32)
+Defined in: [web-searcher/src/engines/google.ts:32](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/engines/google.ts#L32)
 
 Defines the fetch template for Google Search.
 
@@ -402,13 +416,98 @@ The fetcher configuration including the URL pattern and extraction rules.
 
 [`WebSearcher`](WebSearcher.md).[`template`](WebSearcher.md#template)
 
+***
+
+### defaultOptions
+
+#### Get Signature
+
+> **get** `static` **defaultOptions**(): [`SearchOptions`](../interfaces/SearchOptions.md)
+
+Defined in: [web-searcher/src/searcher.ts:61](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L61)
+
+Gets or sets the default search parameters for this specific engine class.
+This does not include settings from parent classes.
+
+##### Returns
+
+[`SearchOptions`](../interfaces/SearchOptions.md)
+
+#### Set Signature
+
+> **set** `static` **defaultOptions**(`options`): `void`
+
+Defined in: [web-searcher/src/searcher.ts:68](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L68)
+
+##### Parameters
+
+###### options
+
+[`SearchOptions`](../interfaces/SearchOptions.md)
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+[`WebSearcher`](WebSearcher.md).[`defaultOptions`](WebSearcher.md#defaultoptions)
+
 ## Methods
 
+### \_execute()
+
+> `protected` **\_execute**\<`R`\>(`actionOptions`, `context?`): `Promise`\<`FetchActionResult`\<`R`\>\>
+
+Defined in: web-fetcher/dist/index.d.ts:1187
+
+Executes a single action within the session.
+
+#### Type Parameters
+
+##### R
+
+`R` *extends* `FetchReturnType` = `"response"`
+
+The expected return type of the action.
+
+#### Parameters
+
+##### actionOptions
+
+`_RequireAtLeastOne`
+
+Configuration for the action to be executed.
+
+##### context?
+
+`FetchContext`
+
+Optional context override for this specific execution. Defaults to the session context.
+
+#### Returns
+
+`Promise`\<`FetchActionResult`\<`R`\>\>
+
+A promise that resolves to the result of the action.
+
+#### Example
+
+```ts
+await session.execute({ name: 'goto', params: { url: 'https://example.com' } });
+```
+
+#### Inherited from
+
+[`WebSearcher`](WebSearcher.md).[`_execute`](WebSearcher.md#_execute)
+
+***
+
 ### \_logDebug()
 
 > `protected` **\_logDebug**(`category`, ...`args`): `void`
 
-Defined in: web-fetcher/dist/index.d.ts:1172
+Defined in: web-fetcher/dist/index.d.ts:1173
 
 #### Parameters
 
@@ -434,7 +533,7 @@ Defined in: web-fetcher/dist/index.d.ts:1172
 
 > `protected` **createContext**(`options`): `FetchContext`
 
-Defined in: [web-searcher/src/searcher.ts:216](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L216)
+Defined in: [web-searcher/src/searcher.ts:254](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L254)
 
 #### Parameters
 
@@ -456,7 +555,7 @@ Defined in: [web-searcher/src/searcher.ts:216](https://github.com/isdk/web-searc
 
 > **dispose**(): `Promise`\<`void`\>
 
-Defined in: web-fetcher/dist/index.d.ts:1231
+Defined in: web-fetcher/dist/index.d.ts:1233
 
 Disposes of the session and its associated engine.
 
@@ -479,9 +578,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:1186
-
-Executes a single action within the session.
+Defined in: web-fetcher/dist/index.d.ts:1188
 
 #### Type Parameters
 
@@ -489,34 +586,20 @@ Executes a single action within the session.
 
 `R` *extends* `FetchReturnType` = `"response"`
 
-The expected return type of the action.
-
 #### Parameters
 
 ##### actionOptions
 
 `_RequireAtLeastOne`
 
-Configuration for the action to be executed.
-
 ##### context?
 
 `FetchContext`
 
-Optional context override for this specific execution. Defaults to the session context.
-
 #### Returns
 
 `Promise`\<`FetchActionResult`\<`R`\>\>
 
-A promise that resolves to the result of the action.
-
-#### Example
-
-```ts
-await session.execute({ name: 'goto', params: { url: 'https://example.com' } });
-```
-
 #### Inherited from
 
 [`WebSearcher`](WebSearcher.md).[`execute`](WebSearcher.md#execute)
@@ -527,7 +610,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:1203
+Defined in: web-fetcher/dist/index.d.ts:1205
 
 Executes a sequence of actions.
 
@@ -571,7 +654,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/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/engines/google.ts#L82)
+Defined in: [web-searcher/src/engines/google.ts:82](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/engines/google.ts#L82)
 
 Maps standard `SearchOptions` to Google's specific URL parameters.
 
@@ -605,7 +688,7 @@ A map of variables to inject into the URL template.
 
 > **getOutputs**(): `Record`\<`string`, `any`\>
 
-Defined in: web-fetcher/dist/index.d.ts:1214
+Defined in: web-fetcher/dist/index.d.ts:1216
 
 Retrieves all outputs accumulated during the session.
 
@@ -625,7 +708,7 @@ A record of stored output data.
 
 > **getState**(): `Promise`\<\{ `cookies`: `Cookie`[]; `sessionState?`: `any`; \} \| `undefined`\>
 
-Defined in: web-fetcher/dist/index.d.ts:1220
+Defined in: web-fetcher/dist/index.d.ts:1222
 
 Gets the current state of the session, including cookies and engine-specific state.
 
@@ -645,7 +728,7 @@ A promise resolving to the session state, or undefined if no engine is initializ
 
 > `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)
+Defined in: [web-searcher/src/searcher.ts:250](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L250)
 
 Dynamically retrieves the fetch template based on current variables and search options.
 
@@ -682,7 +765,7 @@ The fetcher configuration to be used for the current request.
 
 > **search**(`query`, `options`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
 
-Defined in: [web-searcher/src/searcher.ts:246](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L246)
+Defined in: [web-searcher/src/searcher.ts:284](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L284)
 
 Executes a search query.
 
@@ -719,7 +802,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/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/engines/google.ts#L145)
+Defined in: [web-searcher/src/engines/google.ts:145](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/engines/google.ts#L145)
 
 Cleans and normalizes the extracted results.
 Specifically, it unwraps Google's redirect URLs (starting with `/url?q=`).
@@ -748,7 +831,7 @@ An array of cleaned search results.
 
 > `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)
+Defined in: [web-searcher/src/searcher.ts:462](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L462)
 
 Hook for subclasses to validate fetched results before they are accepted.
 If this returns false, the instance manager will consider the fetch a failure
@@ -780,11 +863,30 @@ A promise resolving to true if valid, false otherwise.
 
 ***
 
+### getDefaultOptions()
+
+> `static` **getDefaultOptions**(): [`SearchOptions`](../interfaces/SearchOptions.md)
+
+Defined in: [web-searcher/src/searcher.ts:76](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L76)
+
+Retrieves the combined default search options by traversing the prototype chain.
+Priority: Current class > Parent class > WebSearcher base class.
+
+#### Returns
+
+[`SearchOptions`](../interfaces/SearchOptions.md)
+
+#### Inherited from
+
+[`WebSearcher`](WebSearcher.md).[`getDefaultOptions`](WebSearcher.md#getdefaultoptions)
+
+***
+
 ### search()
 
 > `static` **search**(`engineNames`, `query`, `options`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
 
-Defined in: [web-searcher/src/searcher.ts:113](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/searcher.ts#L113)
+Defined in: [web-searcher/src/searcher.ts:150](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/searcher.ts#L150)
 
 Static helper to execute a one-off search or a fallback chain.