@crawlee/core 4.0.0-beta.14 → 4.0.0-beta.140

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.
Files changed (287) hide show
  1. package/README.md +14 -14
  2. package/autoscaling/autoscaled_pool.d.ts +67 -172
  3. package/autoscaling/autoscaled_pool.js +182 -329
  4. package/autoscaling/concurrency_system.d.ts +269 -0
  5. package/autoscaling/concurrency_system.js +365 -0
  6. package/autoscaling/cpu_load_signal.d.ts +43 -0
  7. package/autoscaling/cpu_load_signal.js +47 -0
  8. package/autoscaling/event_loop_load_signal.d.ts +51 -0
  9. package/autoscaling/event_loop_load_signal.js +60 -0
  10. package/autoscaling/index.d.ts +6 -1
  11. package/autoscaling/index.js +6 -1
  12. package/autoscaling/load_signal.d.ts +100 -0
  13. package/autoscaling/load_signal.js +105 -0
  14. package/autoscaling/memory_load_signal.d.ts +47 -0
  15. package/autoscaling/memory_load_signal.js +106 -0
  16. package/autoscaling/snapshotter.d.ts +58 -163
  17. package/autoscaling/snapshotter.js +45 -263
  18. package/autoscaling/storage_backend_load_signal.d.ts +56 -0
  19. package/autoscaling/storage_backend_load_signal.js +73 -0
  20. package/autoscaling/system_status.d.ts +67 -89
  21. package/autoscaling/system_status.js +92 -122
  22. package/autoscaling/weighted_avg.d.ts +5 -0
  23. package/autoscaling/weighted_avg.js +14 -0
  24. package/byte_utils.d.ts +17 -0
  25. package/byte_utils.js +42 -0
  26. package/configuration.d.ts +96 -223
  27. package/configuration.js +170 -222
  28. package/cookie_utils.d.ts +3 -2
  29. package/cookie_utils.js +18 -7
  30. package/crawlers/context_pipeline.d.ts +10 -1
  31. package/crawlers/context_pipeline.js +31 -8
  32. package/crawlers/crawler_commons.d.ts +90 -126
  33. package/crawlers/crawler_commons.js +1 -108
  34. package/crawlers/error_snapshotter.d.ts +2 -5
  35. package/crawlers/error_snapshotter.js +7 -8
  36. package/crawlers/error_tracker.d.ts +0 -1
  37. package/crawlers/error_tracker.js +0 -1
  38. package/crawlers/index.d.ts +1 -3
  39. package/crawlers/index.js +0 -3
  40. package/crawlers/internals/types.d.ts +0 -1
  41. package/crawlers/internals/types.js +0 -1
  42. package/crawlers/statistics.d.ts +187 -63
  43. package/crawlers/statistics.js +354 -164
  44. package/debug.d.ts +36 -0
  45. package/debug.js +70 -0
  46. package/enqueue_links/enqueue_links.d.ts +60 -153
  47. package/enqueue_links/enqueue_links.js +38 -229
  48. package/enqueue_links/index.d.ts +0 -1
  49. package/enqueue_links/index.js +0 -1
  50. package/enqueue_links/shared.d.ts +49 -30
  51. package/enqueue_links/shared.js +94 -68
  52. package/errors.d.ts +72 -4
  53. package/errors.js +89 -5
  54. package/events/event_manager.d.ts +35 -9
  55. package/events/event_manager.js +12 -13
  56. package/events/index.d.ts +0 -1
  57. package/events/index.js +0 -1
  58. package/events/local_event_manager.d.ts +15 -3
  59. package/events/local_event_manager.js +39 -13
  60. package/http.d.ts +9 -0
  61. package/http.js +28 -0
  62. package/index.d.ts +7 -5
  63. package/index.js +8 -4
  64. package/iterables.d.ts +79 -0
  65. package/iterables.js +134 -0
  66. package/log.d.ts +78 -1
  67. package/log.js +106 -1
  68. package/memory-storage/consts.d.ts +4 -0
  69. package/memory-storage/consts.js +4 -0
  70. package/memory-storage/index.d.ts +1 -0
  71. package/memory-storage/index.js +1 -0
  72. package/memory-storage/memory-storage.d.ts +44 -0
  73. package/memory-storage/memory-storage.js +160 -0
  74. package/memory-storage/resource-clients/common/base-client.d.ts +4 -0
  75. package/memory-storage/resource-clients/common/base-client.js +6 -0
  76. package/memory-storage/resource-clients/dataset.d.ts +40 -0
  77. package/memory-storage/resource-clients/dataset.js +106 -0
  78. package/memory-storage/resource-clients/key-value-store.d.ts +63 -0
  79. package/memory-storage/resource-clients/key-value-store.js +199 -0
  80. package/memory-storage/resource-clients/request-queue.d.ts +77 -0
  81. package/memory-storage/resource-clients/request-queue.js +407 -0
  82. package/memory-storage/utils.d.ts +16 -0
  83. package/memory-storage/utils.js +41 -0
  84. package/owned_or_injected.d.ts +58 -0
  85. package/owned_or_injected.js +98 -0
  86. package/package.json +13 -12
  87. package/proxy_configuration.d.ts +22 -128
  88. package/proxy_configuration.js +32 -144
  89. package/recoverable_state.d.ts +83 -51
  90. package/recoverable_state.js +163 -72
  91. package/request.d.ts +57 -16
  92. package/request.js +130 -69
  93. package/router.d.ts +193 -21
  94. package/router.js +188 -43
  95. package/serialization.d.ts +0 -1
  96. package/serialization.js +15 -15
  97. package/service_locator.d.ts +165 -0
  98. package/service_locator.js +253 -0
  99. package/session_pool/consts.d.ts +1 -2
  100. package/session_pool/consts.js +1 -2
  101. package/session_pool/errors.d.ts +0 -1
  102. package/session_pool/errors.js +0 -1
  103. package/session_pool/fingerprint.d.ts +9 -0
  104. package/session_pool/fingerprint.js +30 -0
  105. package/session_pool/index.d.ts +0 -2
  106. package/session_pool/index.js +0 -2
  107. package/session_pool/session.d.ts +35 -88
  108. package/session_pool/session.js +101 -159
  109. package/session_pool/session_pool.d.ts +74 -91
  110. package/session_pool/session_pool.js +175 -165
  111. package/storages/batched_adds.d.ts +37 -0
  112. package/storages/batched_adds.js +73 -0
  113. package/storages/dataset.d.ts +109 -56
  114. package/storages/dataset.js +283 -149
  115. package/storages/index.d.ts +9 -9
  116. package/storages/index.js +7 -9
  117. package/storages/key_value_store.d.ts +183 -48
  118. package/storages/key_value_store.js +445 -171
  119. package/storages/key_value_store_codec.d.ts +32 -0
  120. package/storages/key_value_store_codec.js +113 -0
  121. package/storages/request_dedup_cache.d.ts +22 -0
  122. package/storages/request_dedup_cache.js +48 -0
  123. package/storages/request_list.d.ts +52 -109
  124. package/storages/request_list.js +183 -152
  125. package/storages/request_loader.d.ts +101 -0
  126. package/storages/request_loader.js +1 -0
  127. package/storages/request_manager.d.ts +33 -0
  128. package/storages/request_manager.js +1 -0
  129. package/storages/request_manager_tandem.d.ts +48 -19
  130. package/storages/request_manager_tandem.js +118 -45
  131. package/storages/request_queue.d.ts +290 -47
  132. package/storages/request_queue.js +762 -216
  133. package/storages/{sitemap_request_list.d.ts → sitemap_request_loader.d.ts} +45 -89
  134. package/storages/sitemap_request_loader.js +438 -0
  135. package/storages/storage_instance_manager.d.ts +87 -0
  136. package/storages/storage_instance_manager.js +256 -0
  137. package/storages/storage_stats.d.ts +48 -0
  138. package/storages/storage_stats.js +29 -0
  139. package/storages/throttling_request_manager.d.ts +239 -0
  140. package/storages/throttling_request_manager.js +646 -0
  141. package/storages/transaction.d.ts +252 -0
  142. package/storages/transaction.js +251 -0
  143. package/storages/utils.d.ts +59 -11
  144. package/storages/utils.js +75 -15
  145. package/system-info/cpu-info.d.ts +67 -0
  146. package/system-info/cpu-info.js +216 -0
  147. package/system-info/memory-info.d.ts +31 -0
  148. package/system-info/memory-info.js +115 -0
  149. package/system-info/ps-tree.d.ts +17 -0
  150. package/system-info/ps-tree.js +144 -0
  151. package/system-info/runtime.d.ts +14 -0
  152. package/system-info/runtime.js +80 -0
  153. package/typedefs.d.ts +0 -6
  154. package/typedefs.js +0 -1
  155. package/url.d.ts +9 -0
  156. package/url.js +11 -0
  157. package/validators.d.ts +22 -18
  158. package/validators.js +13 -18
  159. package/autoscaling/autoscaled_pool.d.ts.map +0 -1
  160. package/autoscaling/autoscaled_pool.js.map +0 -1
  161. package/autoscaling/index.d.ts.map +0 -1
  162. package/autoscaling/index.js.map +0 -1
  163. package/autoscaling/snapshotter.d.ts.map +0 -1
  164. package/autoscaling/snapshotter.js.map +0 -1
  165. package/autoscaling/system_status.d.ts.map +0 -1
  166. package/autoscaling/system_status.js.map +0 -1
  167. package/configuration.d.ts.map +0 -1
  168. package/configuration.js.map +0 -1
  169. package/cookie_utils.d.ts.map +0 -1
  170. package/cookie_utils.js.map +0 -1
  171. package/crawlers/context_pipeline.d.ts.map +0 -1
  172. package/crawlers/context_pipeline.js.map +0 -1
  173. package/crawlers/crawler_commons.d.ts.map +0 -1
  174. package/crawlers/crawler_commons.js.map +0 -1
  175. package/crawlers/crawler_utils.d.ts +0 -10
  176. package/crawlers/crawler_utils.d.ts.map +0 -1
  177. package/crawlers/crawler_utils.js +0 -12
  178. package/crawlers/crawler_utils.js.map +0 -1
  179. package/crawlers/error_snapshotter.d.ts.map +0 -1
  180. package/crawlers/error_snapshotter.js.map +0 -1
  181. package/crawlers/error_tracker.d.ts.map +0 -1
  182. package/crawlers/error_tracker.js.map +0 -1
  183. package/crawlers/index.d.ts.map +0 -1
  184. package/crawlers/index.js.map +0 -1
  185. package/crawlers/internals/types.d.ts.map +0 -1
  186. package/crawlers/internals/types.js.map +0 -1
  187. package/crawlers/statistics.d.ts.map +0 -1
  188. package/crawlers/statistics.js.map +0 -1
  189. package/enqueue_links/enqueue_links.d.ts.map +0 -1
  190. package/enqueue_links/enqueue_links.js.map +0 -1
  191. package/enqueue_links/index.d.ts.map +0 -1
  192. package/enqueue_links/index.js.map +0 -1
  193. package/enqueue_links/shared.d.ts.map +0 -1
  194. package/enqueue_links/shared.js.map +0 -1
  195. package/errors.d.ts.map +0 -1
  196. package/errors.js.map +0 -1
  197. package/events/event_manager.d.ts.map +0 -1
  198. package/events/event_manager.js.map +0 -1
  199. package/events/index.d.ts.map +0 -1
  200. package/events/index.js.map +0 -1
  201. package/events/local_event_manager.d.ts.map +0 -1
  202. package/events/local_event_manager.js.map +0 -1
  203. package/http_clients/base-http-client.d.ts +0 -140
  204. package/http_clients/base-http-client.d.ts.map +0 -1
  205. package/http_clients/base-http-client.js +0 -40
  206. package/http_clients/base-http-client.js.map +0 -1
  207. package/http_clients/form-data-like.d.ts +0 -67
  208. package/http_clients/form-data-like.d.ts.map +0 -1
  209. package/http_clients/form-data-like.js +0 -5
  210. package/http_clients/form-data-like.js.map +0 -1
  211. package/http_clients/got-scraping-http-client.d.ts +0 -20
  212. package/http_clients/got-scraping-http-client.d.ts.map +0 -1
  213. package/http_clients/got-scraping-http-client.js +0 -85
  214. package/http_clients/got-scraping-http-client.js.map +0 -1
  215. package/http_clients/index.d.ts +0 -3
  216. package/http_clients/index.d.ts.map +0 -1
  217. package/http_clients/index.js +0 -3
  218. package/http_clients/index.js.map +0 -1
  219. package/index.d.ts.map +0 -1
  220. package/index.js.map +0 -1
  221. package/log.d.ts.map +0 -1
  222. package/log.js.map +0 -1
  223. package/proxy_configuration.d.ts.map +0 -1
  224. package/proxy_configuration.js.map +0 -1
  225. package/recoverable_state.d.ts.map +0 -1
  226. package/recoverable_state.js.map +0 -1
  227. package/request.d.ts.map +0 -1
  228. package/request.js.map +0 -1
  229. package/router.d.ts.map +0 -1
  230. package/router.js.map +0 -1
  231. package/serialization.d.ts.map +0 -1
  232. package/serialization.js.map +0 -1
  233. package/session_pool/consts.d.ts.map +0 -1
  234. package/session_pool/consts.js.map +0 -1
  235. package/session_pool/errors.d.ts.map +0 -1
  236. package/session_pool/errors.js.map +0 -1
  237. package/session_pool/events.d.ts +0 -3
  238. package/session_pool/events.d.ts.map +0 -1
  239. package/session_pool/events.js +0 -3
  240. package/session_pool/events.js.map +0 -1
  241. package/session_pool/index.d.ts.map +0 -1
  242. package/session_pool/index.js.map +0 -1
  243. package/session_pool/session.d.ts.map +0 -1
  244. package/session_pool/session.js.map +0 -1
  245. package/session_pool/session_pool.d.ts.map +0 -1
  246. package/session_pool/session_pool.js.map +0 -1
  247. package/storages/access_checking.d.ts +0 -13
  248. package/storages/access_checking.d.ts.map +0 -1
  249. package/storages/access_checking.js +0 -14
  250. package/storages/access_checking.js.map +0 -1
  251. package/storages/dataset.d.ts.map +0 -1
  252. package/storages/dataset.js.map +0 -1
  253. package/storages/index.d.ts.map +0 -1
  254. package/storages/index.js.map +0 -1
  255. package/storages/key_value_store.d.ts.map +0 -1
  256. package/storages/key_value_store.js.map +0 -1
  257. package/storages/request_list.d.ts.map +0 -1
  258. package/storages/request_list.js.map +0 -1
  259. package/storages/request_list_adapter.d.ts +0 -58
  260. package/storages/request_list_adapter.d.ts.map +0 -1
  261. package/storages/request_list_adapter.js +0 -81
  262. package/storages/request_list_adapter.js.map +0 -1
  263. package/storages/request_manager_tandem.d.ts.map +0 -1
  264. package/storages/request_manager_tandem.js.map +0 -1
  265. package/storages/request_provider.d.ts +0 -371
  266. package/storages/request_provider.d.ts.map +0 -1
  267. package/storages/request_provider.js +0 -585
  268. package/storages/request_provider.js.map +0 -1
  269. package/storages/request_queue.d.ts.map +0 -1
  270. package/storages/request_queue.js.map +0 -1
  271. package/storages/request_queue_v2.d.ts +0 -87
  272. package/storages/request_queue_v2.d.ts.map +0 -1
  273. package/storages/request_queue_v2.js +0 -438
  274. package/storages/request_queue_v2.js.map +0 -1
  275. package/storages/sitemap_request_list.d.ts.map +0 -1
  276. package/storages/sitemap_request_list.js +0 -430
  277. package/storages/sitemap_request_list.js.map +0 -1
  278. package/storages/storage_manager.d.ts +0 -58
  279. package/storages/storage_manager.d.ts.map +0 -1
  280. package/storages/storage_manager.js +0 -105
  281. package/storages/storage_manager.js.map +0 -1
  282. package/storages/utils.d.ts.map +0 -1
  283. package/storages/utils.js.map +0 -1
  284. package/typedefs.d.ts.map +0 -1
  285. package/typedefs.js.map +0 -1
  286. package/validators.d.ts.map +0 -1
  287. package/validators.js.map +0 -1
@@ -1,3 +1,2 @@
1
1
  export * from './enqueue_links.js';
2
2
  export * from './shared.js';
3
- //# sourceMappingURL=index.d.ts.map
@@ -1,3 +1,2 @@
1
1
  export * from './enqueue_links.js';
2
2
  export * from './shared.js';
3
- //# sourceMappingURL=index.js.map
@@ -1,25 +1,27 @@
1
- import type { Awaitable } from '@crawlee/types';
1
+ import type { Awaitable, Dictionary } from '@crawlee/types';
2
+ import { z } from 'zod';
2
3
  import type { RequestOptions } from '../request.js';
3
- import { Request } from '../request.js';
4
- import type { EnqueueLinksOptions } from './enqueue_links.js';
5
- export { tryAbsoluteURL } from '@crawlee/utils';
6
- export type UrlPatternObject = {
4
+ import type { EnqueueStrategyOption } from './enqueue_links.js';
5
+ export interface UrlPatternObject {
7
6
  glob?: string;
8
7
  regexp?: RegExp;
9
- } & Pick<RequestOptions, 'method' | 'payload' | 'label' | 'userData' | 'headers'>;
10
- export type PseudoUrlObject = {
11
- purl: string;
12
- } & Pick<RequestOptions, 'method' | 'payload' | 'label' | 'userData' | 'headers'>;
13
- export type PseudoUrlInput = string | PseudoUrlObject;
14
- export type GlobObject = {
8
+ }
9
+ export interface GlobObject {
15
10
  glob: string;
16
- } & Pick<RequestOptions, 'method' | 'payload' | 'label' | 'userData' | 'headers'>;
11
+ }
17
12
  export type GlobInput = string | GlobObject;
18
- export type RegExpObject = {
13
+ export interface RegExpObject {
19
14
  regexp: RegExp;
20
- } & Pick<RequestOptions, 'method' | 'payload' | 'label' | 'userData' | 'headers'>;
15
+ }
21
16
  export type RegExpInput = RegExp | RegExpObject;
22
- export type SkippedRequestReason = 'robotsTxt' | 'limit' | 'enqueueLimit' | 'filters' | 'redirect' | 'depth';
17
+ /** Unified URL pattern input accepts glob strings, glob objects, RegExp instances, or regexp objects. */
18
+ export type UrlPatternInput = GlobInput | RegExpInput;
19
+ /**
20
+ * Accepts one {@link UrlPatternInput} — a glob string, a RegExp instance, or a `{ glob }` / `{ regexp }` object.
21
+ * @internal
22
+ */
23
+ export declare const urlPatternSchema: z.ZodType<UrlPatternInput>;
24
+ export type SkippedRequestReason = 'robotsTxt' | 'limit' | 'enqueueLimit' | 'filters' | 'transform' | 'redirect' | 'depth';
23
25
  export type SkippedRequestCallback = (args: {
24
26
  url: string;
25
27
  reason: SkippedRequestReason;
@@ -27,13 +29,7 @@ export type SkippedRequestCallback = (args: {
27
29
  /**
28
30
  * @ignore
29
31
  */
30
- export declare function updateEnqueueLinksPatternCache(item: GlobInput | RegExpInput | PseudoUrlInput, pattern: RegExpObject | GlobObject): void;
31
- /**
32
- * Helper factory used in the `enqueueLinks()` and enqueueLinksByClickingElements() function
33
- * to construct RegExps from PseudoUrl strings.
34
- * @ignore
35
- */
36
- export declare function constructRegExpObjectsFromPseudoUrls(pseudoUrls: readonly PseudoUrlInput[]): RegExpObject[];
32
+ export declare function updateEnqueueLinksPatternCache(item: GlobInput | RegExpInput, pattern: RegExpObject | GlobObject): void;
37
33
  /**
38
34
  * Helper factory used in the `enqueueLinks()` and enqueueLinksByClickingElements() function
39
35
  * to construct Glob objects from Glob pattern strings.
@@ -51,23 +47,46 @@ export declare function validateGlobPattern(glob: string): string;
51
47
  */
52
48
  export declare function constructRegExpObjectsFromRegExps(regexps: readonly RegExpInput[]): RegExpObject[];
53
49
  /**
50
+ * Helper factory used in the `enqueueLinks()` function to construct UrlPatternObjects
51
+ * from a mixed array of glob strings, glob objects, RegExp instances, and regexp objects.
52
+ * @ignore
53
+ */
54
+ export declare function constructUrlPatternObjects(patterns: readonly UrlPatternInput[]): UrlPatternObject[];
55
+ /**
56
+ * Filters request options by URL patterns.
57
+ *
58
+ * When `includePatterns` is empty/undefined, all options pass through (only exclude filtering applies).
54
59
  * @ignore
55
60
  */
56
- export declare function createRequests(requestOptions: (string | RequestOptions)[], urlPatternObjects?: UrlPatternObject[], excludePatternObjects?: UrlPatternObject[], strategy?: EnqueueLinksOptions['strategy'], onSkippedUrl?: (url: string) => void): Request[];
57
- export declare function filterRequestsByPatterns(requests: Request[], patterns?: UrlPatternObject[], onSkippedUrl?: (url: string) => void): Request[];
61
+ export declare function filterRequestOptionsByPatterns(requestOptions: RequestOptions[], includePatterns: UrlPatternObject[] | undefined, excludePatterns?: UrlPatternObject[], strategy?: EnqueueStrategyOption, onSkippedUrl?: (url: string) => void): RequestOptions[];
58
62
  /**
59
63
  * @ignore
60
64
  */
61
- export declare function createRequestOptions(sources: readonly (string | Record<string, unknown>)[], options?: Pick<EnqueueLinksOptions, 'label' | 'userData' | 'baseUrl' | 'skipNavigation' | 'strategy'>): RequestOptions[];
65
+ export declare function createRequestOptions(sources: readonly (string | Record<string, unknown>)[], options?: {
66
+ label?: string;
67
+ userData?: Dictionary;
68
+ baseUrl?: string;
69
+ skipNavigation?: boolean;
70
+ sessionId?: string;
71
+ strategy?: EnqueueStrategyOption;
72
+ }): RequestOptions[];
62
73
  /**
63
- * Takes an Apify {@link RequestOptions} object and changes its attributes in a desired way. This user-function is used
64
- * {@link enqueueLinks} to modify requests before enqueuing them.
74
+ * Takes a {@link RequestOptions} object and changes its attributes in a desired way. This user-function is used
75
+ * by {@link enqueueLinks} to modify request options before they are converted to {@link Request} instances.
65
76
  */
66
77
  export interface RequestTransform {
67
78
  /**
68
79
  * @param original Request options to be modified.
69
- * @returns The modified request options to enqueue.
80
+ * @returns The modified request options to enqueue, `'unchanged'` to keep the original options as-is,
81
+ * or a falsy value / `'skip'` to exclude the request from the queue.
70
82
  */
71
- (original: RequestOptions): RequestOptions | false | undefined | null;
83
+ (original: RequestOptions): RequestOptions | false | undefined | null | 'skip' | 'unchanged';
72
84
  }
73
- //# sourceMappingURL=shared.d.ts.map
85
+ /**
86
+ * Applies a {@link RequestTransform} function to a list of request options.
87
+ * Options for which the transform returns a falsy value are removed from the list.
88
+ * @param onSkipped Called with the original request options when the transform returns a falsy value (i.e. the request is skipped).
89
+ * @ignore
90
+ * @internal
91
+ */
92
+ export declare function applyRequestTransform(requestOptions: RequestOptions[], transformFn: RequestTransform, onSkipped?: (requestOptions: RequestOptions) => void): RequestOptions[];
@@ -1,16 +1,24 @@
1
1
  import { URL } from 'node:url';
2
2
  import { Minimatch } from 'minimatch';
3
- import { purlToRegExp } from '@apify/pseudo_url';
4
- import { Request } from '../request.js';
5
- export { tryAbsoluteURL } from '@crawlee/utils';
3
+ import { z } from 'zod';
4
+ import { schemas } from '../validators.js';
6
5
  const MAX_ENQUEUE_LINKS_CACHE_SIZE = 1000;
7
6
  /**
8
- * To enable direct use of the Actor UI `globs`/`regexps`/`pseudoUrls` output while keeping high performance,
9
- * all the regexps from the output are only constructed once and kept in a cache
10
- * by the `enqueueLinks()` function.
7
+ * To keep high performance when the same patterns are passed on every `enqueueLinks()` call,
8
+ * each glob/regexp is only compiled once and then kept in a cache.
11
9
  * @ignore
12
10
  */
13
11
  const enqueueLinksPatternCache = new Map();
12
+ /**
13
+ * Accepts one {@link UrlPatternInput} — a glob string, a RegExp instance, or a `{ glob }` / `{ regexp }` object.
14
+ * @internal
15
+ */
16
+ export const urlPatternSchema = z.union([
17
+ z.string(),
18
+ z.instanceof(RegExp),
19
+ schemas.objectWithKeys(['glob']),
20
+ schemas.objectWithKeys(['regexp']),
21
+ ]);
14
22
  /**
15
23
  * @ignore
16
24
  */
@@ -21,28 +29,6 @@ export function updateEnqueueLinksPatternCache(item, pattern) {
21
29
  enqueueLinksPatternCache.delete(key);
22
30
  }
23
31
  }
24
- /**
25
- * Helper factory used in the `enqueueLinks()` and enqueueLinksByClickingElements() function
26
- * to construct RegExps from PseudoUrl strings.
27
- * @ignore
28
- */
29
- export function constructRegExpObjectsFromPseudoUrls(pseudoUrls) {
30
- return pseudoUrls.map((item) => {
31
- // Get pseudoUrl object from cache.
32
- let regexpObject = enqueueLinksPatternCache.get(item);
33
- if (regexpObject)
34
- return regexpObject;
35
- if (typeof item === 'string') {
36
- regexpObject = { regexp: purlToRegExp(item) };
37
- }
38
- else {
39
- const { purl, ...requestOptions } = item;
40
- regexpObject = { regexp: purlToRegExp(purl), ...requestOptions };
41
- }
42
- updateEnqueueLinksPatternCache(item, regexpObject);
43
- return regexpObject;
44
- });
45
- }
46
32
  /**
47
33
  * Helper factory used in the `enqueueLinks()` and enqueueLinksByClickingElements() function
48
34
  * to construct Glob objects from Glob pattern strings.
@@ -72,8 +58,7 @@ export function constructGlobObjectsFromGlobs(globs) {
72
58
  globObject = { glob: validateGlobPattern(item) };
73
59
  }
74
60
  else {
75
- const { glob, ...requestOptions } = item;
76
- globObject = { glob: validateGlobPattern(glob), ...requestOptions };
61
+ globObject = { glob: validateGlobPattern(item.glob) };
77
62
  }
78
63
  updateEnqueueLinksPatternCache(item, globObject);
79
64
  return globObject;
@@ -103,62 +88,70 @@ export function constructRegExpObjectsFromRegExps(regexps) {
103
88
  regexpObject = { regexp: item };
104
89
  }
105
90
  else {
106
- regexpObject = item;
91
+ regexpObject = { regexp: item.regexp };
107
92
  }
108
93
  updateEnqueueLinksPatternCache(item, regexpObject);
109
94
  return regexpObject;
110
95
  });
111
96
  }
112
97
  /**
98
+ * Helper factory used in the `enqueueLinks()` function to construct UrlPatternObjects
99
+ * from a mixed array of glob strings, glob objects, RegExp instances, and regexp objects.
100
+ * @ignore
101
+ */
102
+ export function constructUrlPatternObjects(patterns) {
103
+ const result = [];
104
+ for (const item of patterns) {
105
+ if (typeof item === 'string' || 'glob' in item) {
106
+ result.push(...constructGlobObjectsFromGlobs([item]));
107
+ }
108
+ else if (item instanceof RegExp || 'regexp' in item) {
109
+ result.push(...constructRegExpObjectsFromRegExps([item]));
110
+ }
111
+ }
112
+ return result;
113
+ }
114
+ /**
115
+ * Filters request options by URL patterns.
116
+ *
117
+ * When `includePatterns` is empty/undefined, all options pass through (only exclude filtering applies).
113
118
  * @ignore
114
119
  */
115
- export function createRequests(requestOptions, urlPatternObjects, excludePatternObjects = [], strategy, onSkippedUrl) {
116
- const excludePatternObjectMatchers = excludePatternObjects.map(createPatternObjectMatcher);
117
- const urlPatternObjectMatchers = urlPatternObjects?.map(createPatternObjectMatcher);
120
+ export function filterRequestOptionsByPatterns(requestOptions, includePatterns, excludePatterns = [], strategy, onSkippedUrl) {
121
+ const excludeMatchers = excludePatterns.map(createPatternObjectMatcher);
122
+ const includeMatchers = includePatterns?.length ? includePatterns.map(createPatternObjectMatcher) : undefined;
118
123
  return requestOptions
119
- .map((opts) => ({ url: typeof opts === 'string' ? opts : opts.url, opts }))
120
124
  .filter(({ url }) => {
121
- const matchesExcludePatterns = excludePatternObjectMatchers.some(({ match }) => match(url));
122
- if (matchesExcludePatterns) {
125
+ const matchesExclude = excludeMatchers.some(({ match }) => match(url));
126
+ if (matchesExclude) {
123
127
  onSkippedUrl?.(url);
124
128
  }
125
- return !matchesExcludePatterns;
129
+ return !matchesExclude;
126
130
  })
127
- .map(({ url, opts }) => {
128
- if (!urlPatternObjectMatchers || !urlPatternObjectMatchers.length) {
129
- return new Request(typeof opts === 'string' ? { url: opts, enqueueStrategy: strategy } : { ...opts });
130
- }
131
- for (const urlPatternObject of urlPatternObjectMatchers) {
132
- const { match, glob, regexp, ...requestRegExpOptions } = urlPatternObject;
133
- if (match(url)) {
134
- const request = typeof opts === 'string'
135
- ? { url: opts, ...requestRegExpOptions, enqueueStrategy: strategy }
136
- : { ...opts, ...requestRegExpOptions, enqueueStrategy: strategy };
137
- return new Request(request);
131
+ .map((opts) => {
132
+ if (!includeMatchers) {
133
+ return { ...opts, enqueueStrategy: strategy };
134
+ }
135
+ for (const { match } of includeMatchers) {
136
+ if (match(opts.url)) {
137
+ return { ...opts, enqueueStrategy: strategy };
138
138
  }
139
139
  }
140
140
  // didn't match any positive pattern
141
- onSkippedUrl?.(url);
141
+ onSkippedUrl?.(opts.url);
142
142
  return null;
143
143
  })
144
- .filter((request) => request);
144
+ .filter((opts) => opts !== null);
145
145
  }
146
- export function filterRequestsByPatterns(requests, patterns, onSkippedUrl) {
147
- if (!patterns?.length) {
148
- return requests;
146
+ function isAbsoluteUrl(url) {
147
+ try {
148
+ // eslint-disable-next-line no-new
149
+ new URL(url);
150
+ return true;
149
151
  }
150
- const filtered = [];
151
- const patternMatchers = patterns?.map(createPatternObjectMatcher);
152
- for (const request of requests) {
153
- const matchingPattern = patternMatchers.find(({ match }) => match(request.url));
154
- if (matchingPattern !== undefined) {
155
- filtered.push(request);
156
- }
157
- else {
158
- onSkippedUrl?.(request.url);
159
- }
152
+ catch {
153
+ return false;
160
154
  }
161
- return filtered;
162
155
  }
163
156
  /**
164
157
  * @ignore
@@ -177,7 +170,12 @@ export function createRequestOptions(sources, options = {}) {
177
170
  }
178
171
  })
179
172
  .map((requestOptions) => {
180
- requestOptions.url = new URL(requestOptions.url, options.baseUrl).href;
173
+ // Leave already-absolute URLs untouched - re-deriving them via `new URL()` would normalize them
174
+ // (e.g. adding a trailing slash to a bare domain), which is surprising for URLs that didn't need
175
+ // resolving against `baseUrl` in the first place.
176
+ if (!isAbsoluteUrl(requestOptions.url)) {
177
+ requestOptions.url = new URL(requestOptions.url, options.baseUrl).href;
178
+ }
181
179
  requestOptions.userData ??= options.userData ?? {};
182
180
  if (typeof options.label === 'string') {
183
181
  requestOptions.userData = {
@@ -188,6 +186,9 @@ export function createRequestOptions(sources, options = {}) {
188
186
  if (options.skipNavigation) {
189
187
  requestOptions.skipNavigation = true;
190
188
  }
189
+ if (options.sessionId) {
190
+ requestOptions.sessionId = options.sessionId;
191
+ }
191
192
  return requestOptions;
192
193
  });
193
194
  }
@@ -207,6 +208,31 @@ function createPatternObjectMatcher(urlPatternObject) {
207
208
  else {
208
209
  match = () => false;
209
210
  }
210
- return { ...urlPatternObject, match };
211
+ return { match };
212
+ }
213
+ /**
214
+ * Applies a {@link RequestTransform} function to a list of request options.
215
+ * Options for which the transform returns a falsy value are removed from the list.
216
+ * @param onSkipped Called with the original request options when the transform returns a falsy value (i.e. the request is skipped).
217
+ * @ignore
218
+ * @internal
219
+ */
220
+ export function applyRequestTransform(requestOptions, transformFn, onSkipped) {
221
+ return requestOptions
222
+ .map((opts) => {
223
+ const transformed = transformFn(opts);
224
+ if (transformed === 'skip') {
225
+ onSkipped?.(opts);
226
+ return null;
227
+ }
228
+ if (transformed === 'unchanged') {
229
+ return opts;
230
+ }
231
+ if (!transformed) {
232
+ onSkipped?.(opts);
233
+ return null;
234
+ }
235
+ return transformed;
236
+ })
237
+ .filter((r) => r !== null);
211
238
  }
212
- //# sourceMappingURL=shared.js.map
package/errors.d.ts CHANGED
@@ -14,6 +14,37 @@ export declare class CriticalError extends NonRetryableError {
14
14
  */
15
15
  export declare class MissingRouteError extends CriticalError {
16
16
  }
17
+ /**
18
+ * A schema validation issue, structurally compatible with `StandardSchemaV1.Issue`. Declared here so that
19
+ * error types do not have to depend on `@standard-schema/spec`.
20
+ */
21
+ export interface SchemaIssue {
22
+ readonly message: string;
23
+ readonly path?: readonly (PropertyKey | {
24
+ key: PropertyKey;
25
+ })[];
26
+ }
27
+ /**
28
+ * Thrown when a request's `userData` does not match the {@link RouteSchemas|Standard Schema} registered for its label.
29
+ *
30
+ * As the `userData` does not change between attempts, this error is non-retryable.
31
+ */
32
+ export declare class RequestValidationError extends NonRetryableError {
33
+ readonly label: string | symbol;
34
+ readonly issues: readonly SchemaIssue[];
35
+ constructor(label: string | symbol, issues: readonly SchemaIssue[]);
36
+ }
37
+ /**
38
+ * Thrown by {@link RecoverableState} when a persisted state record does not match its `stateSchema`.
39
+ *
40
+ * Whether a corrupt record should abort the run or be discarded in favour of the defaults depends on what the
41
+ * state is for, so {@link RecoverableState.initialize} always throws and leaves the choice to the caller.
42
+ */
43
+ export declare class StateValidationError extends Error {
44
+ readonly persistStateKey: string;
45
+ readonly issues: readonly SchemaIssue[];
46
+ constructor(persistStateKey: string, issues: readonly SchemaIssue[]);
47
+ }
17
48
  /**
18
49
  * Errors of `RetryRequestError` type will always be retried by the crawler.
19
50
  *
@@ -23,13 +54,39 @@ export declare class RetryRequestError extends Error {
23
54
  constructor(message?: string);
24
55
  }
25
56
  /**
26
- * Errors of `SessionError` type will trigger a session rotation.
57
+ * Thrown when a domain has rate-limited us and the request should simply be attempted again later.
27
58
  *
28
- * This error doesn't respect the `maxRequestRetries` option and has a separate limit of `maxSessionRotations`.
59
+ * The request is reclaimed without recording a failure: it costs neither a retry nor session reputation, because
60
+ * nothing about the request or the session was at fault. A {@link ThrottlingRequestManager} holds it back until
61
+ * the domain's backoff expires, so retries are paced rather than immediate.
29
62
  */
30
- export declare class SessionError extends RetryRequestError {
63
+ export declare class RequestThrottledError extends RetryRequestError {
31
64
  constructor(message?: string);
32
65
  }
66
+ /**
67
+ * Thrown when a domain has rate-limited us for so long that no request has got through, and the crawl is
68
+ * abandoned rather than kept waiting.
69
+ *
70
+ * Waiting longer will not help: at this point the concurrency is too high for the domain, or it has blocked us.
71
+ * The affected requests are deliberately left in their queue, so re-running the crawl without purging storages
72
+ * resumes them once the domain recovers.
73
+ */
74
+ export declare class PersistentRateLimitError extends CriticalError {
75
+ }
76
+ /**
77
+ * Errors of `SessionError` type retire the session associated with the request and trigger a regular retry.
78
+ *
79
+ * The retry counts towards the `maxRequestRetries` limit, just like any other error.
80
+ */
81
+ export declare class SessionError extends Error {
82
+ constructor(message?: string);
83
+ }
84
+ /**
85
+ * Thrown when a requested session is not found in the referenced SessionPool.
86
+ */
87
+ export declare class MissingSessionError extends Error {
88
+ constructor(sessionId?: string);
89
+ }
33
90
  export declare class ContextPipelineInterruptedError extends Error {
34
91
  constructor(message?: string);
35
92
  }
@@ -42,4 +99,15 @@ export declare class ContextPipelineCleanupError extends CriticalError {
42
99
  export declare class RequestHandlerError extends Error {
43
100
  constructor(error: unknown, options?: ErrorOptions);
44
101
  }
45
- //# sourceMappingURL=errors.d.ts.map
102
+ /**
103
+ * Thrown when attempting to set a different service instance after one has already been retrieved.
104
+ */
105
+ export declare class ServiceConflictError extends Error {
106
+ constructor(serviceName: string, newValue: unknown, existingValue: unknown);
107
+ }
108
+ /**
109
+ * Thrown by crawlers when `skipNavigation` is used on a request.
110
+ * Subclasses can catch this error to skip their own navigation-dependent logic.
111
+ */
112
+ export declare class NavigationSkippedError extends NonRetryableError {
113
+ }
package/errors.js CHANGED
@@ -1,3 +1,4 @@
1
+ import { inspectValue } from './debug.js';
1
2
  /**
2
3
  * Errors of `NonRetryableError` type will never be retried by the crawler.
3
4
  */
@@ -14,6 +15,45 @@ export class CriticalError extends NonRetryableError {
14
15
  */
15
16
  export class MissingRouteError extends CriticalError {
16
17
  }
18
+ function formatIssues(issues) {
19
+ return issues
20
+ .map((issue) => {
21
+ const path = (issue.path ?? [])
22
+ .map((segment) => (typeof segment === 'object' ? segment.key : segment))
23
+ .join('.');
24
+ return `- ${path ? `${path}: ` : ''}${issue.message}`;
25
+ })
26
+ .join('\n');
27
+ }
28
+ /**
29
+ * Thrown when a request's `userData` does not match the {@link RouteSchemas|Standard Schema} registered for its label.
30
+ *
31
+ * As the `userData` does not change between attempts, this error is non-retryable.
32
+ */
33
+ export class RequestValidationError extends NonRetryableError {
34
+ label;
35
+ issues;
36
+ constructor(label, issues) {
37
+ super(`Request userData for label '${String(label)}' failed schema validation:\n${formatIssues(issues)}`);
38
+ this.label = label;
39
+ this.issues = issues;
40
+ }
41
+ }
42
+ /**
43
+ * Thrown by {@link RecoverableState} when a persisted state record does not match its `stateSchema`.
44
+ *
45
+ * Whether a corrupt record should abort the run or be discarded in favour of the defaults depends on what the
46
+ * state is for, so {@link RecoverableState.initialize} always throws and leaves the choice to the caller.
47
+ */
48
+ export class StateValidationError extends Error {
49
+ persistStateKey;
50
+ issues;
51
+ constructor(persistStateKey, issues) {
52
+ super(`State persisted under key '${persistStateKey}' failed schema validation:\n${formatIssues(issues)}`);
53
+ this.persistStateKey = persistStateKey;
54
+ this.issues = issues;
55
+ }
56
+ }
17
57
  /**
18
58
  * Errors of `RetryRequestError` type will always be retried by the crawler.
19
59
  *
@@ -25,13 +65,43 @@ export class RetryRequestError extends Error {
25
65
  }
26
66
  }
27
67
  /**
28
- * Errors of `SessionError` type will trigger a session rotation.
68
+ * Thrown when a domain has rate-limited us and the request should simply be attempted again later.
69
+ *
70
+ * The request is reclaimed without recording a failure: it costs neither a retry nor session reputation, because
71
+ * nothing about the request or the session was at fault. A {@link ThrottlingRequestManager} holds it back until
72
+ * the domain's backoff expires, so retries are paced rather than immediate.
73
+ */
74
+ export class RequestThrottledError extends RetryRequestError {
75
+ constructor(message) {
76
+ super(message ?? 'Request is being retried later because its domain is rate-limiting us');
77
+ }
78
+ }
79
+ /**
80
+ * Thrown when a domain has rate-limited us for so long that no request has got through, and the crawl is
81
+ * abandoned rather than kept waiting.
82
+ *
83
+ * Waiting longer will not help: at this point the concurrency is too high for the domain, or it has blocked us.
84
+ * The affected requests are deliberately left in their queue, so re-running the crawl without purging storages
85
+ * resumes them once the domain recovers.
86
+ */
87
+ export class PersistentRateLimitError extends CriticalError {
88
+ }
89
+ /**
90
+ * Errors of `SessionError` type retire the session associated with the request and trigger a regular retry.
29
91
  *
30
- * This error doesn't respect the `maxRequestRetries` option and has a separate limit of `maxSessionRotations`.
92
+ * The retry counts towards the `maxRequestRetries` limit, just like any other error.
31
93
  */
32
- export class SessionError extends RetryRequestError {
94
+ export class SessionError extends Error {
33
95
  constructor(message) {
34
- super(`Detected a session error, rotating session... ${message ? `\n${message}` : ''}`);
96
+ super(`Detected a session error, retiring session... ${message ? `\n${message}` : ''}`);
97
+ }
98
+ }
99
+ /**
100
+ * Thrown when a requested session is not found in the referenced SessionPool.
101
+ */
102
+ export class MissingSessionError extends Error {
103
+ constructor(sessionId) {
104
+ super(`The current SessionPool instance couldn't find a valid session${sessionId ? ` for the following id: ${sessionId}.` : '.'}`);
35
105
  }
36
106
  }
37
107
  export class ContextPipelineInterruptedError extends Error {
@@ -54,4 +124,18 @@ export class RequestHandlerError extends Error {
54
124
  super(undefined, { cause: error, ...options });
55
125
  }
56
126
  }
57
- //# sourceMappingURL=errors.js.map
127
+ /**
128
+ * Thrown when attempting to set a different service instance after one has already been retrieved.
129
+ */
130
+ export class ServiceConflictError extends Error {
131
+ constructor(serviceName, newValue, existingValue) {
132
+ super(`Service ${serviceName} is already in use. ` +
133
+ `Existing value: ${inspectValue(existingValue)}, attempted new value: ${inspectValue(newValue)}.`);
134
+ }
135
+ }
136
+ /**
137
+ * Thrown by crawlers when `skipNavigation` is used on a request.
138
+ * Subclasses can catch this error to skip their own navigation-dependent logic.
139
+ */
140
+ export class NavigationSkippedError extends NonRetryableError {
141
+ }
@@ -1,28 +1,55 @@
1
1
  import { AsyncEventEmitter } from '@vladfrangu/async_event_emitter';
2
2
  import type { BetterIntervalID } from '@apify/utilities';
3
- import { Configuration } from '../configuration.js';
4
- export declare const enum EventType {
3
+ export interface EventManagerOptions {
4
+ /** Interval between emitted `persistState` events in milliseconds. */
5
+ persistStateIntervalMillis: number;
6
+ }
7
+ export declare enum EventType {
5
8
  PERSIST_STATE = "persistState",
6
9
  SYSTEM_INFO = "systemInfo",
7
10
  MIGRATING = "migrating",
8
11
  ABORTING = "aborting",
9
- EXIT = "exit"
12
+ EXIT = "exit",
13
+ STATUS_MESSAGE = "statusMessage"
14
+ }
15
+ export type EventTypeName = EventType | 'systemInfo' | 'persistState' | 'migrating' | 'aborting' | 'exit' | 'statusMessage';
16
+ /**
17
+ * Payload emitted with the {@link EventType.STATUS_MESSAGE|`statusMessage`} event.
18
+ *
19
+ * The crawler broadcasts these whenever it wants to report its progress (e.g. periodically, or on
20
+ * start/finish). Consumers such as the Apify SDK can listen for the event and propagate the message
21
+ * to the platform. This keeps the crawler decoupled from any specific status-reporting backend.
22
+ */
23
+ export interface EventStatusMessageData {
24
+ /**
25
+ * Identifies the crawler that emitted the message.
26
+ *
27
+ * Either the user-provided `id` from the crawler options, or a randomly generated one.
28
+ * Since a single event manager may be shared by multiple crawlers, consumers can use this
29
+ * to attribute the message to a specific crawler instance.
30
+ */
31
+ crawlerId: string;
32
+ /** The human-readable status message. */
33
+ message: string;
34
+ /** Whether this is the final status message of the run. */
35
+ isStatusMessageTerminal?: boolean;
36
+ /** The log level the message was logged with. */
37
+ level?: 'DEBUG' | 'INFO' | 'WARNING' | 'ERROR';
10
38
  }
11
- export type EventTypeName = EventType | 'systemInfo' | 'persistState' | 'migrating' | 'aborting' | 'exit';
12
39
  interface Intervals {
13
40
  persistState?: BetterIntervalID;
14
41
  systemInfo?: BetterIntervalID;
15
42
  }
16
43
  export declare abstract class EventManager {
17
- readonly config: Configuration;
44
+ #private;
18
45
  protected events: AsyncEventEmitter<{}>;
19
46
  protected initialized: boolean;
20
47
  protected intervals: Intervals;
21
48
  // @ts-ignore optional peer dependency or compatibility with es2022
22
- protected log: import("@apify/log").Log;
23
- constructor(config?: Configuration);
49
+ protected log: import("@crawlee/types").CrawleeLogger;
50
+ constructor(options: EventManagerOptions);
24
51
  /**
25
- * Initializes the event manager by creating the `persistState` event interval.
52
+ * Initializes the event manager by starting the `persistState` event interval.
26
53
  * This is automatically called at the beginning of `crawler.run()`.
27
54
  */
28
55
  init(): Promise<void>;
@@ -49,4 +76,3 @@ export declare abstract class EventManager {
49
76
  waitForAllListenersToComplete(): Promise<boolean>;
50
77
  }
51
78
  export {};
52
- //# sourceMappingURL=event_manager.d.ts.map