@isdk/web-fetcher 0.3.0 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.action.cn.md +77 -312
- package/README.action.extract.cn.md +263 -0
- package/README.action.extract.md +263 -0
- package/README.action.md +76 -311
- package/README.cn.md +12 -2
- package/README.engine.cn.md +22 -1
- package/README.engine.md +22 -1
- package/README.md +10 -1
- package/dist/index.d.mts +245 -1
- package/dist/index.d.ts +245 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +10 -1
- package/docs/_media/README.action.md +76 -311
- package/docs/_media/README.cn.md +12 -2
- package/docs/_media/README.engine.md +22 -1
- package/docs/classes/CheerioFetchEngine.md +312 -88
- package/docs/classes/ClickAction.md +23 -23
- package/docs/classes/EvaluateAction.md +23 -23
- package/docs/classes/ExtractAction.md +23 -23
- package/docs/classes/FetchAction.md +29 -23
- package/docs/classes/FetchEngine.md +286 -86
- package/docs/classes/FetchSession.md +13 -13
- package/docs/classes/FillAction.md +23 -23
- package/docs/classes/GetContentAction.md +23 -23
- package/docs/classes/GotoAction.md +23 -23
- package/docs/classes/KeyboardPressAction.md +533 -0
- package/docs/classes/KeyboardTypeAction.md +533 -0
- package/docs/classes/MouseClickAction.md +533 -0
- package/docs/classes/MouseMoveAction.md +533 -0
- package/docs/classes/MouseWheelAction.md +533 -0
- package/docs/classes/PauseAction.md +23 -23
- package/docs/classes/PlaywrightFetchEngine.md +472 -88
- package/docs/classes/ScrollIntoViewAction.md +533 -0
- package/docs/classes/SubmitAction.md +23 -23
- package/docs/classes/TrimAction.md +23 -23
- package/docs/classes/WaitForAction.md +23 -23
- package/docs/classes/WebFetcher.md +5 -5
- package/docs/enumerations/FetchActionResultStatus.md +4 -4
- package/docs/functions/fetchWeb.md +2 -2
- package/docs/functions/getRandomDelay.md +25 -0
- package/docs/globals.md +13 -0
- package/docs/interfaces/BaseFetchActionProperties.md +12 -12
- package/docs/interfaces/BaseFetchCollectorActionProperties.md +16 -16
- package/docs/interfaces/BaseFetcherProperties.md +31 -27
- package/docs/interfaces/Cookie.md +14 -14
- package/docs/interfaces/DispatchedEngineAction.md +4 -4
- package/docs/interfaces/EvaluateActionOptions.md +3 -3
- package/docs/interfaces/ExtractActionProperties.md +12 -12
- package/docs/interfaces/FetchActionInContext.md +15 -15
- package/docs/interfaces/FetchActionProperties.md +13 -13
- package/docs/interfaces/FetchActionResult.md +6 -6
- package/docs/interfaces/FetchContext.md +41 -37
- package/docs/interfaces/FetchEngineContext.md +36 -32
- package/docs/interfaces/FetchMetadata.md +5 -5
- package/docs/interfaces/FetchResponse.md +14 -14
- package/docs/interfaces/FetchReturnTypeRegistry.md +7 -7
- package/docs/interfaces/FetchSite.md +34 -30
- package/docs/interfaces/FetcherOptions.md +33 -29
- package/docs/interfaces/GotoActionOptions.md +14 -6
- package/docs/interfaces/KeyboardPressParams.md +25 -0
- package/docs/interfaces/KeyboardTypeParams.md +25 -0
- package/docs/interfaces/MouseClickParams.md +49 -0
- package/docs/interfaces/MouseMoveParams.md +41 -0
- package/docs/interfaces/MouseWheelParams.md +69 -0
- package/docs/interfaces/PendingEngineRequest.md +3 -3
- package/docs/interfaces/ScrollIntoViewParams.md +17 -0
- package/docs/interfaces/StorageOptions.md +5 -5
- package/docs/interfaces/SubmitActionOptions.md +2 -2
- package/docs/interfaces/TrimActionOptions.md +3 -3
- package/docs/interfaces/WaitForActionOptions.md +5 -5
- package/docs/type-aliases/BaseFetchActionOptions.md +1 -1
- package/docs/type-aliases/BaseFetchCollectorOptions.md +1 -1
- package/docs/type-aliases/BrowserEngine.md +1 -1
- package/docs/type-aliases/FetchActionCapabilities.md +1 -1
- package/docs/type-aliases/FetchActionCapabilityMode.md +1 -1
- package/docs/type-aliases/FetchActionOptions.md +1 -1
- package/docs/type-aliases/FetchEngineAction.md +2 -2
- package/docs/type-aliases/FetchEngineType.md +1 -1
- package/docs/type-aliases/FetchReturnType.md +1 -1
- package/docs/type-aliases/FetchReturnTypeFor.md +1 -1
- package/docs/type-aliases/OnFetchPauseCallback.md +1 -1
- package/docs/type-aliases/ResourceType.md +1 -1
- package/docs/type-aliases/TrimPreset.md +1 -1
- package/docs/variables/DefaultFetcherProperties.md +1 -1
- package/docs/variables/FetcherOptionKeys.md +1 -1
- package/docs/variables/TRIM_PRESETS.md +1 -1
- package/package.json +10 -10
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[**@isdk/web-fetcher**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/web-fetcher](../globals.md) / KeyboardTypeParams
|
|
6
|
+
|
|
7
|
+
# Interface: KeyboardTypeParams
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:4](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/keyboard.ts#L4)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### delay?
|
|
14
|
+
|
|
15
|
+
> `optional` **delay**: `number`
|
|
16
|
+
|
|
17
|
+
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:6](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/keyboard.ts#L6)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### text
|
|
22
|
+
|
|
23
|
+
> **text**: `string`
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/web-fetcher/src/action/definitions/keyboard.ts:5](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/keyboard.ts#L5)
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
[**@isdk/web-fetcher**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/web-fetcher](../globals.md) / MouseClickParams
|
|
6
|
+
|
|
7
|
+
# Interface: MouseClickParams
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:28](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L28)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### button?
|
|
14
|
+
|
|
15
|
+
> `optional` **button**: `"left"` \| `"right"` \| `"middle"`
|
|
16
|
+
|
|
17
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:31](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L31)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### clickCount?
|
|
22
|
+
|
|
23
|
+
> `optional` **clickCount**: `number`
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:32](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L32)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### delay?
|
|
30
|
+
|
|
31
|
+
> `optional` **delay**: `number`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:33](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L33)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### x?
|
|
38
|
+
|
|
39
|
+
> `optional` **x**: `number`
|
|
40
|
+
|
|
41
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:29](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L29)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### y?
|
|
46
|
+
|
|
47
|
+
> `optional` **y**: `number`
|
|
48
|
+
|
|
49
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:30](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L30)
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
[**@isdk/web-fetcher**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/web-fetcher](../globals.md) / MouseMoveParams
|
|
6
|
+
|
|
7
|
+
# Interface: MouseMoveParams
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:4](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L4)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### selector?
|
|
14
|
+
|
|
15
|
+
> `optional` **selector**: `string`
|
|
16
|
+
|
|
17
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:7](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L7)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### steps?
|
|
22
|
+
|
|
23
|
+
> `optional` **steps**: `number`
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:8](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L8)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### x?
|
|
30
|
+
|
|
31
|
+
> `optional` **x**: `number`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:5](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L5)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### y?
|
|
38
|
+
|
|
39
|
+
> `optional` **y**: `number`
|
|
40
|
+
|
|
41
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:6](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L6)
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
[**@isdk/web-fetcher**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/web-fetcher](../globals.md) / MouseWheelParams
|
|
6
|
+
|
|
7
|
+
# Interface: MouseWheelParams
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:74](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L74)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### deltaX?
|
|
14
|
+
|
|
15
|
+
> `optional` **deltaX**: `number`
|
|
16
|
+
|
|
17
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:90](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L90)
|
|
18
|
+
|
|
19
|
+
Horizontal scroll delta.
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### deltaY?
|
|
24
|
+
|
|
25
|
+
> `optional` **deltaY**: `number`
|
|
26
|
+
|
|
27
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:94](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L94)
|
|
28
|
+
|
|
29
|
+
Vertical scroll delta.
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### selector?
|
|
34
|
+
|
|
35
|
+
> `optional` **selector**: `string`
|
|
36
|
+
|
|
37
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:86](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L86)
|
|
38
|
+
|
|
39
|
+
Selector for the element to scroll. If provided, mouse will move to this element before scrolling.
|
|
40
|
+
|
|
41
|
+
***
|
|
42
|
+
|
|
43
|
+
### steps?
|
|
44
|
+
|
|
45
|
+
> `optional` **steps**: `number`
|
|
46
|
+
|
|
47
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:98](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L98)
|
|
48
|
+
|
|
49
|
+
Number of steps to split the scroll into for simulating human-like behavior.
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### x?
|
|
54
|
+
|
|
55
|
+
> `optional` **x**: `number`
|
|
56
|
+
|
|
57
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:78](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L78)
|
|
58
|
+
|
|
59
|
+
Target X coordinate for the mouse wheel event.
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
63
|
+
### y?
|
|
64
|
+
|
|
65
|
+
> `optional` **y**: `number`
|
|
66
|
+
|
|
67
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:82](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L82)
|
|
68
|
+
|
|
69
|
+
Target Y coordinate for the mouse wheel event.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PendingEngineRequest
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:271](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L271)
|
|
10
10
|
|
|
11
11
|
Represents a pending navigation request awaiting resolution.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Tracks navigation requests that have been queued but not yet processed by the re
|
|
|
20
20
|
|
|
21
21
|
> **reject**: (`reason?`) => `void`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
23
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:273](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L273)
|
|
24
24
|
|
|
25
25
|
#### Parameters
|
|
26
26
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:243](https://github.com/isd
|
|
|
38
38
|
|
|
39
39
|
> **resolve**: (`value`) => `void`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
41
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:272](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L272)
|
|
42
42
|
|
|
43
43
|
#### Parameters
|
|
44
44
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
[**@isdk/web-fetcher**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/web-fetcher](../globals.md) / ScrollIntoViewParams
|
|
6
|
+
|
|
7
|
+
# Interface: ScrollIntoViewParams
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:53](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L53)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### selector
|
|
14
|
+
|
|
15
|
+
> **selector**: `string`
|
|
16
|
+
|
|
17
|
+
Defined in: [packages/web-fetcher/src/action/definitions/mouse.ts:54](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/definitions/mouse.ts#L54)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: StorageOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:38](https://github.com/isdk/web-fetcher.js/blob/
|
|
9
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:38](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L38)
|
|
10
10
|
|
|
11
11
|
Storage configuration options for the fetch engine.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Controls how Crawlee's internal storage (RequestQueue, KeyValueStore, SessionPoo
|
|
|
20
20
|
|
|
21
21
|
> `optional` **config**: `Record`\<`string`, `any`\>
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:60](https://github.com/isdk/web-fetcher.js/blob/
|
|
23
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:60](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L60)
|
|
24
24
|
|
|
25
25
|
Additional Crawlee configuration options.
|
|
26
26
|
Allows fine-grained control over the underlying Crawlee instance.
|
|
@@ -31,7 +31,7 @@ Allows fine-grained control over the underlying Crawlee instance.
|
|
|
31
31
|
|
|
32
32
|
> `optional` **id**: `string`
|
|
33
33
|
|
|
34
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:44](https://github.com/isdk/web-fetcher.js/blob/
|
|
34
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:44](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L44)
|
|
35
35
|
|
|
36
36
|
Custom identifier for the storage.
|
|
37
37
|
If provided, multiple sessions can share the same storage by using the same ID.
|
|
@@ -43,7 +43,7 @@ If not provided, a unique session ID is used (strong isolation).
|
|
|
43
43
|
|
|
44
44
|
> `optional` **persist**: `boolean`
|
|
45
45
|
|
|
46
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:50](https://github.com/isdk/web-fetcher.js/blob/
|
|
46
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:50](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L50)
|
|
47
47
|
|
|
48
48
|
Whether to persist storage to disk.
|
|
49
49
|
If true, uses Crawlee's disk persistence. If false, data might be stored in memory or temporary directory.
|
|
@@ -55,7 +55,7 @@ Corresponds to Crawlee's `persistStorage` configuration.
|
|
|
55
55
|
|
|
56
56
|
> `optional` **purge**: `boolean`
|
|
57
57
|
|
|
58
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:55](https://github.com/isdk/web-fetcher.js/blob/
|
|
58
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:55](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L55)
|
|
59
59
|
|
|
60
60
|
Whether to delete the storage (RequestQueue and KeyValueStore) when the session is closed.
|
|
61
61
|
Defaults to true. Set to false if you want to keep data for future reuse with the same `id`.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: SubmitActionOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:107](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L107)
|
|
10
10
|
|
|
11
11
|
Options for the [FetchEngine.submit](../classes/FetchEngine.md#submit) action, configuring form submission behavior.
|
|
12
12
|
|
|
@@ -20,4 +20,4 @@ Specifies encoding type for form submissions, particularly relevant for JSON-bas
|
|
|
20
20
|
|
|
21
21
|
> `optional` **enctype**: `"application/x-www-form-urlencoded"` \| `"application/json"` \| `"multipart/form-data"`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
23
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:108](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L108)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: TrimActionOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:129](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L129)
|
|
10
10
|
|
|
11
11
|
Options for the [FetchEngine.trim](../classes/FetchEngine.md#trim) action, specifying which elements to remove from the DOM.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Options for the [FetchEngine.trim](../classes/FetchEngine.md#trim) action, speci
|
|
|
16
16
|
|
|
17
17
|
> `optional` **presets**: [`TrimPreset`](../type-aliases/TrimPreset.md) \| [`TrimPreset`](../type-aliases/TrimPreset.md)[]
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
19
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:131](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L131)
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
@@ -24,4 +24,4 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:130](https://github.com/isd
|
|
|
24
24
|
|
|
25
25
|
> `optional` **selectors**: `string` \| `string`[]
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
27
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:130](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L130)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: WaitForActionOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
9
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:94](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L94)
|
|
10
10
|
|
|
11
11
|
Options for the [FetchEngine.waitFor](../classes/FetchEngine.md#waitfor) action, specifying conditions to wait for before continuing.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Controls timing behavior for interactions, allowing waiting for elements, time i
|
|
|
20
20
|
|
|
21
21
|
> `optional` **failOnTimeout**: `boolean`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
23
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:98](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L98)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:97](https://github.com/isdk
|
|
|
28
28
|
|
|
29
29
|
> `optional` **ms**: `number`
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
31
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:95](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L95)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:94](https://github.com/isdk
|
|
|
36
36
|
|
|
37
37
|
> `optional` **networkIdle**: `boolean`
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
39
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:97](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L97)
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
@@ -44,4 +44,4 @@ Defined in: [packages/web-fetcher/src/engine/base.ts:96](https://github.com/isdk
|
|
|
44
44
|
|
|
45
45
|
> `optional` **selector**: `string`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
47
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:96](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L96)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **BaseFetchActionOptions** = `RequireAtLeastOne`\<[`BaseFetchActionProperties`](../interfaces/BaseFetchActionProperties.md), `"id"` \| `"name"` \| `"action"`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:64](https://github.com/isdk/web-fetcher.js/blob/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:64](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L64)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **BaseFetchCollectorOptions** = `RequireAtLeastOne`\<[`BaseFetchCollectorActionProperties`](../interfaces/BaseFetchCollectorActionProperties.md), `"id"` \| `"name"` \| `"action"`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:81](https://github.com/isdk/web-fetcher.js/blob/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:81](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L81)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **BrowserEngine** = `"playwright"` \| `"puppeteer"`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:21](https://github.com/isdk/web-fetcher.js/blob/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:21](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L21)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **FetchActionCapabilities** = `{ [mode in FetchEngineType]?: FetchActionCapabilityMode }`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:95](https://github.com/isdk/web-fetcher.js/blob/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:95](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L95)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **FetchActionCapabilityMode** = `"native"` \| `"simulate"` \| `"noop"`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:23](https://github.com/isdk/web-fetcher.js/blob/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:23](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L23)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **FetchActionOptions** = `RequireAtLeastOne`\<[`FetchActionProperties`](../interfaces/FetchActionProperties.md), `"id"` \| `"name"` \| `"action"`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:90](https://github.com/isdk/web-fetcher.js/blob/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/action/fetch-action.ts:90](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/action/fetch-action.ts#L90)
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
# Type Alias: FetchEngineAction
|
|
8
8
|
|
|
9
|
-
> **FetchEngineAction** = \{ `selector`: `string`; `type`: `"click"`; \} \| \{ `selector`: `string`; `type`: `"fill"`; `value`: `string`; \} \| \{ `options?`: [`WaitForActionOptions`](../interfaces/WaitForActionOptions.md); `type`: `"waitFor"`; \} \| \{ `options?`: [`SubmitActionOptions`](../interfaces/SubmitActionOptions.md); `selector?`: `any`; `type`: `"submit"`; \} \| \{ `type`: `"getContent"`; \} \| \{ `opts?`: [`GotoActionOptions`](../interfaces/GotoActionOptions.md); `type`: `"navigate"`; `url`: `string`; \} \| \{ `schema`: `ExtractSchema`; `type`: `"extract"`; \} \| \{ `message?`: `string`; `type`: `"pause"`; \} \| \{ `options`: [`TrimActionOptions`](../interfaces/TrimActionOptions.md); `type`: `"trim"`; \} \| \{ `params`: [`EvaluateActionOptions`](../interfaces/EvaluateActionOptions.md); `type`: `"evaluate"`; \} \| \{ `type`: `"dispose"`; \}
|
|
9
|
+
> **FetchEngineAction** = \{ `selector`: `string`; `type`: `"click"`; \} \| \{ `selector`: `string`; `type`: `"fill"`; `value`: `string`; \} \| \{ `params`: \{ `selector?`: `string`; `steps?`: `number`; `x?`: `number`; `y?`: `number`; \}; `type`: `"mouseMove"`; \} \| \{ `params`: \{ `button?`: `"left"` \| `"right"` \| `"middle"`; `clickCount?`: `number`; `delay?`: `number`; `steps?`: `number`; `x?`: `number`; `y?`: `number`; \}; `type`: `"mouseClick"`; \} \| \{ `params`: \{ `deltaX?`: `number`; `deltaY?`: `number`; `selector?`: `string`; `steps?`: `number`; `x?`: `number`; `y?`: `number`; \}; `type`: `"mouseWheel"`; \} \| \{ `params`: \{ `delay?`: `number`; `text`: `string`; \}; `type`: `"keyboardType"`; \} \| \{ `params`: \{ `delay?`: `number`; `key`: `string`; \}; `type`: `"keyboardPress"`; \} \| \{ `params`: \{ `selector`: `string`; \}; `type`: `"scrollIntoView"`; \} \| \{ `options?`: [`WaitForActionOptions`](../interfaces/WaitForActionOptions.md); `type`: `"waitFor"`; \} \| \{ `options?`: [`SubmitActionOptions`](../interfaces/SubmitActionOptions.md); `selector?`: `any`; `type`: `"submit"`; \} \| \{ `type`: `"getContent"`; \} \| \{ `opts?`: [`GotoActionOptions`](../interfaces/GotoActionOptions.md); `type`: `"navigate"`; `url`: `string`; \} \| \{ `schema`: `ExtractSchema`; `type`: `"extract"`; \} \| \{ `message?`: `string`; `type`: `"pause"`; \} \| \{ `options`: [`TrimActionOptions`](../interfaces/TrimActionOptions.md); `type`: `"trim"`; \} \| \{ `params`: [`EvaluateActionOptions`](../interfaces/EvaluateActionOptions.md); `type`: `"evaluate"`; \} \| \{ `type`: `"dispose"`; \}
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:210](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L210)
|
|
12
12
|
|
|
13
13
|
Union type representing all possible engine actions that can be dispatched.
|
|
14
14
|
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **FetchEngineType** = `"http"` \| `"browser"`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:20](https://github.com/isdk/web-fetcher.js/blob/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:20](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L20)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **FetchReturnType** = `"response"` \| `"context"` \| `"outputs"` \| `"any"` \| `"none"`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:5](https://github.com/isdk/web-fetcher.js/blob/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:5](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/fetch-return-type.ts#L5)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **FetchReturnTypeFor**\<`R`\> = `R` *extends* keyof [`FetchReturnTypeRegistry`](../interfaces/FetchReturnTypeRegistry.md) ? [`FetchReturnTypeRegistry`](../interfaces/FetchReturnTypeRegistry.md)\[`R`\] : `never`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:27](https://github.com/isdk/web-fetcher.js/blob/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/fetch-return-type.ts:27](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/fetch-return-type.ts#L27)
|
|
12
12
|
|
|
13
13
|
## Type Parameters
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **OnFetchPauseCallback** = (`options`) => `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:141](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L141)
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **ResourceType** = `"image"` \| `"stylesheet"` \| `"font"` \| `"script"` \| `"media"` \| `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:24](https://github.com/isdk/web-fetcher.js/blob/
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:24](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L24)
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **TrimPreset** = `"scripts"` \| `"styles"` \| `"svgs"` \| `"images"` \| `"comments"` \| `"hidden"` \| `"all"`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:117](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L117)
|
|
12
12
|
|
|
13
13
|
Predefined cleanup groups for the [FetchEngine.trim](../classes/FetchEngine.md#trim) action.
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **DefaultFetcherProperties**: [`BaseFetcherProperties`](../interfaces/BaseFetcherProperties.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:183](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L183)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **FetcherOptionKeys**: `string`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/core/types.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/core/types.ts:219](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/core/types.ts#L219)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **TRIM\_PRESETS**: `Record`\<`string`, `string`[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/web-fetcher/src/engine/base.ts:
|
|
11
|
+
Defined in: [packages/web-fetcher/src/engine/base.ts:134](https://github.com/isdk/web-fetcher.js/blob/ff2bf8a6938cad6b2dc7c85fb1380de226cb3724/src/engine/base.ts#L134)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@isdk/web-fetcher",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.2",
|
|
4
4
|
"description": "A powerful and flexible web automation and data extraction library featuring a dual-engine architecture (HTTP/Cheerio and Browser/Playwright) with declarative JSON action scripts.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Riceball LEE <snowyu.lee@gmail.com>",
|
|
@@ -20,15 +20,15 @@
|
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@isdk/common-error": "^0.2.0",
|
|
23
|
-
"camoufox-js": "^0.
|
|
24
|
-
"cheerio": "^1.
|
|
25
|
-
"crawlee": "^3.
|
|
26
|
-
"events-ex": "^2.
|
|
27
|
-
"jsdom": "^
|
|
28
|
-
"lodash-es": "^4.
|
|
29
|
-
"nanoid": "^5.1.
|
|
30
|
-
"playwright": "^1.
|
|
31
|
-
"util-ex": "^2.5.
|
|
23
|
+
"camoufox-js": "^0.10.2",
|
|
24
|
+
"cheerio": "^1.2.0",
|
|
25
|
+
"crawlee": "^3.16.0",
|
|
26
|
+
"events-ex": "^2.3.1",
|
|
27
|
+
"jsdom": "^29.1.1",
|
|
28
|
+
"lodash-es": "^4.18.1",
|
|
29
|
+
"nanoid": "^5.1.11",
|
|
30
|
+
"playwright": "^1.59.1",
|
|
31
|
+
"util-ex": "^2.5.2"
|
|
32
32
|
},
|
|
33
33
|
"devDependencies": {
|
|
34
34
|
"@antfu/eslint-config": "^6.7.3",
|