@crawlee/core 3.0.3-beta.9 → 3.0.3

package/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,KAAK;CAAG;AAE/C;;GAEG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;CAAG;AAEvD;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,aAAa;CAAG"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,KAAK;CAAG;AAE/C;;GAEG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;CAAG;AAEvD;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,aAAa;CAAG;AAEvD;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,KAAK;gBAC5B,OAAO,CAAC,EAAE,MAAM;CAG/B"}

package/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MissingRouteError = exports.CriticalError = exports.NonRetryableError = void 0;
+exports.RetryRequestError = exports.MissingRouteError = exports.CriticalError = exports.NonRetryableError = void 0;
 /**
  * Errors of `NonRetryableError` type will never be retried by the crawler.
  */
@@ -19,4 +19,13 @@ exports.CriticalError = CriticalError;
 class MissingRouteError extends CriticalError {
 }
 exports.MissingRouteError = MissingRouteError;
+/**
+ * Indicates that the request should be retried (while still respecting the maximum number of retries).
+ */
+class RetryRequestError extends Error {
+    constructor(message) {
+        super(message ?? "Request is being retried at the user's request");
+    }
+}
+exports.RetryRequestError = RetryRequestError;
 //# sourceMappingURL=errors.js.map

package/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,iBAAkB,SAAQ,KAAK;CAAG;AAA/C,8CAA+C;AAE/C;;GAEG;AACH,MAAa,aAAc,SAAQ,iBAAiB;CAAG;AAAvD,sCAAuD;AAEvD;;GAEG;AACH,MAAa,iBAAkB,SAAQ,aAAa;CAAG;AAAvD,8CAAuD"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,iBAAkB,SAAQ,KAAK;CAAG;AAA/C,8CAA+C;AAE/C;;GAEG;AACH,MAAa,aAAc,SAAQ,iBAAiB;CAAG;AAAvD,sCAAuD;AAEvD;;GAEG;AACH,MAAa,iBAAkB,SAAQ,aAAa;CAAG;AAAvD,8CAAuD;AAEvD;;GAEG;AACH,MAAa,iBAAkB,SAAQ,KAAK;IACxC,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,IAAI,gDAAgD,CAAC,CAAC;IACvE,CAAC;CACJ;AAJD,8CAIC"}

package/index.mjs

@@ -31,6 +31,7 @@ export const REQUESTS_PERSISTENCE_KEY = mod.REQUESTS_PERSISTENCE_KEY;
 export const Request = mod.Request;
 export const RequestList = mod.RequestList;
 export const RequestQueue = mod.RequestQueue;
+export const RetryRequestError = mod.RetryRequestError;
 export const Router = mod.Router;
 export const STATE_PERSISTENCE_KEY = mod.STATE_PERSISTENCE_KEY;
 export const STORAGE_CONSISTENCY_DELAY_MILLIS = mod.STORAGE_CONSISTENCY_DELAY_MILLIS;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@crawlee/core",
-    "version": "3.0.3-beta.9",
+    "version": "3.0.3",
     "description": "The scalable web crawling and scraping library for JavaScript/Node.js. Enables development of data extraction and web automation jobs (not only) with headless Chrome and Puppeteer.",
     "engines": {
         "node": ">=16.0.0"
@@ -58,9 +58,9 @@
         "@apify/pseudo_url": "^2.0.0",
         "@apify/timeout": "^0.3.0",
         "@apify/utilities": "^2.0.0",
-        "@crawlee/memory-storage": "^3.0.3-beta.9",
-        "@crawlee/types": "^3.0.3-beta.9",
-        "@crawlee/utils": "^3.0.3-beta.9",
+        "@crawlee/memory-storage": "^3.0.3",
+        "@crawlee/types": "^3.0.3",
+        "@crawlee/utils": "^3.0.3",
         "@types/tough-cookie": "^4.0.2",
         "@vladfrangu/async_event_emitter": "^2.0.0",
         "fs-extra": "^10.1.0",

package/proxy_configuration.d.ts

@@ -11,14 +11,14 @@ export interface ProxyConfigurationOptions {
     /**
      * Custom function that allows you to generate the new proxy URL dynamically. It gets the `sessionId` as a parameter
      * and should always return stringified proxy URL. Can be asynchronous.
-     * This function is used to generate the URL when {@link ProxyConfiguration.newUrl} or {@link ProxyConfiguration.newProxyInfo} is called.
+     * This function is used to generate the URL when {@apilink ProxyConfiguration.newUrl} or {@apilink ProxyConfiguration.newProxyInfo} is called.
      */
     newUrlFunction?: ProxyConfigurationFunction;
 }
 /**
  * The main purpose of the ProxyInfo object is to provide information
  * about the current proxy connection used by the crawler for the request.
- * Outside of crawlers, you can get this object by calling {@link ProxyConfiguration.newProxyInfo}.
+ * Outside of crawlers, you can get this object by calling {@apilink ProxyConfiguration.newProxyInfo}.
  *
  * **Example usage:**
  *
@@ -47,7 +47,7 @@ export interface ProxyConfigurationOptions {
  */
 export interface ProxyInfo {
     /**
-     * The identifier of used {@link Session}, if used.
+     * The identifier of used {@apilink Session}, if used.
      */
     sessionId?: string;
     /**
@@ -75,9 +75,9 @@ export interface ProxyInfo {
  * Configures connection to a proxy server with the provided options. Proxy servers are used to prevent target websites from blocking
  * your crawlers based on IP address rate limits or blacklists. Setting proxy configuration in your crawlers automatically configures
  * them to use the selected proxies for all connections. You can get information about the currently used proxy by inspecting
- * the {@link ProxyInfo} property in your crawler's page function. There, you can inspect the proxy's URL and other attributes.
+ * the {@apilink ProxyInfo} property in your crawler's page function. There, you can inspect the proxy's URL and other attributes.
  *
- * If you want to use your own proxies, use the {@link ProxyConfigurationOptions.proxyUrls} option. Your list of proxy URLs will
+ * If you want to use your own proxies, use the {@apilink ProxyConfigurationOptions.proxyUrls} option. Your list of proxy URLs will
  * be rotated by the configuration if this option is provided.
  *
  * **Example usage:**
@@ -107,7 +107,7 @@ export declare class ProxyConfiguration {
     protected newUrlFunction?: ProxyConfigurationFunction;
     protected log: import("@apify/log").Log;
     /**
-     * Creates a {@link ProxyConfiguration} instance based on the provided options. Proxy servers are used to prevent target websites from
+     * Creates a {@apilink ProxyConfiguration} instance based on the provided options. Proxy servers are used to prevent target websites from
      * blocking your crawlers based on IP address rate limits or blacklists. Setting proxy configuration in your crawlers automatically configures
      * them to use the selected proxies for all connections.
      *
@@ -128,16 +128,16 @@ export declare class ProxyConfiguration {
      */
     constructor(options?: ProxyConfigurationOptions);
     /**
-     * This function creates a new {@link ProxyInfo} info object.
+     * This function creates a new {@apilink ProxyInfo} info object.
      * It is used by CheerioCrawler and PuppeteerCrawler to generate proxy URLs and also to allow the user to inspect
      * the currently used proxy via the requestHandler parameter `proxyInfo`.
      * Use it if you want to work with a rich representation of a proxy URL.
-     * If you need the URL string only, use {@link ProxyConfiguration.newUrl}.
+     * If you need the URL string only, use {@apilink ProxyConfiguration.newUrl}.
      * @param [sessionId]
-     *  Represents the identifier of user {@link Session} that can be managed by the {@link SessionPool} or
+     *  Represents the identifier of user {@apilink Session} that can be managed by the {@apilink SessionPool} or
      *  you can use the Apify Proxy [Session](https://docs.apify.com/proxy#sessions) identifier.
      *  When the provided sessionId is a number, it's converted to a string. Property sessionId of
-     *  {@link ProxyInfo} is always returned as a type string.
+     *  {@apilink ProxyInfo} is always returned as a type string.
      *
      *  All the HTTP requests going through the proxy with the same session identifier
      *  will use the same target proxy server (i.e. the same IP address).
@@ -148,7 +148,7 @@ export declare class ProxyConfiguration {
     /**
      * Returns a new proxy URL based on provided configuration options and the `sessionId` parameter.
      * @param [sessionId]
-     *  Represents the identifier of user {@link Session} that can be managed by the {@link SessionPool} or
+     *  Represents the identifier of user {@apilink Session} that can be managed by the {@apilink SessionPool} or
      *  you can use the Apify Proxy [Session](https://docs.apify.com/proxy#sessions) identifier.
      *  When the provided sessionId is a number, it's converted to a string.
      *

package/proxy_configuration.js

@@ -8,9 +8,9 @@ const log_1 = tslib_1.__importDefault(require("@apify/log"));
  * Configures connection to a proxy server with the provided options. Proxy servers are used to prevent target websites from blocking
  * your crawlers based on IP address rate limits or blacklists. Setting proxy configuration in your crawlers automatically configures
  * them to use the selected proxies for all connections. You can get information about the currently used proxy by inspecting
- * the {@link ProxyInfo} property in your crawler's page function. There, you can inspect the proxy's URL and other attributes.
+ * the {@apilink ProxyInfo} property in your crawler's page function. There, you can inspect the proxy's URL and other attributes.
  *
- * If you want to use your own proxies, use the {@link ProxyConfigurationOptions.proxyUrls} option. Your list of proxy URLs will
+ * If you want to use your own proxies, use the {@apilink ProxyConfigurationOptions.proxyUrls} option. Your list of proxy URLs will
  * be rotated by the configuration if this option is provided.
  *
  * **Example usage:**
@@ -34,7 +34,7 @@ const log_1 = tslib_1.__importDefault(require("@apify/log"));
  */
 class ProxyConfiguration {
     /**
-     * Creates a {@link ProxyConfiguration} instance based on the provided options. Proxy servers are used to prevent target websites from
+     * Creates a {@apilink ProxyConfiguration} instance based on the provided options. Proxy servers are used to prevent target websites from
      * blocking your crawlers based on IP address rate limits or blacklists. Setting proxy configuration in your crawlers automatically configures
      * them to use the selected proxies for all connections.
      *
@@ -104,16 +104,16 @@ class ProxyConfiguration {
         this.newUrlFunction = newUrlFunction;
     }
     /**
-     * This function creates a new {@link ProxyInfo} info object.
+     * This function creates a new {@apilink ProxyInfo} info object.
      * It is used by CheerioCrawler and PuppeteerCrawler to generate proxy URLs and also to allow the user to inspect
      * the currently used proxy via the requestHandler parameter `proxyInfo`.
      * Use it if you want to work with a rich representation of a proxy URL.
-     * If you need the URL string only, use {@link ProxyConfiguration.newUrl}.
+     * If you need the URL string only, use {@apilink ProxyConfiguration.newUrl}.
      * @param [sessionId]
-     *  Represents the identifier of user {@link Session} that can be managed by the {@link SessionPool} or
+     *  Represents the identifier of user {@apilink Session} that can be managed by the {@apilink SessionPool} or
      *  you can use the Apify Proxy [Session](https://docs.apify.com/proxy#sessions) identifier.
      *  When the provided sessionId is a number, it's converted to a string. Property sessionId of
-     *  {@link ProxyInfo} is always returned as a type string.
+     *  {@apilink ProxyInfo} is always returned as a type string.
      *
      *  All the HTTP requests going through the proxy with the same session identifier
      *  will use the same target proxy server (i.e. the same IP address).
@@ -137,7 +137,7 @@ class ProxyConfiguration {
     /**
      * Returns a new proxy URL based on provided configuration options and the `sessionId` parameter.
      * @param [sessionId]
-     *  Represents the identifier of user {@link Session} that can be managed by the {@link SessionPool} or
+     *  Represents the identifier of user {@apilink Session} that can be managed by the {@apilink SessionPool} or
      *  you can use the Apify Proxy [Session](https://docs.apify.com/proxy#sessions) identifier.
      *  When the provided sessionId is a number, it's converted to a string.
      *

package/request.d.ts

@@ -10,7 +10,7 @@ import type { AllowedHttpMethods } from './typedefs';
  * Each `Request` instance has the `uniqueKey` property, which can be either specified
  * manually in the constructor or generated automatically from the URL. Two requests with the same `uniqueKey`
  * are considered as pointing to the same web resource. This behavior applies to all Apify SDK classes,
- * such as {@link RequestList}, {@link RequestQueue}, {@link PuppeteerCrawler} or {@link PlaywrightCrawler}.
+ * such as {@apilink RequestList}, {@apilink RequestQueue}, {@apilink PuppeteerCrawler} or {@apilink PlaywrightCrawler}.
  *
  * Example use:
  *
@@ -40,7 +40,7 @@ export declare class Request<UserData extends Dictionary = Dictionary> {
      * An actually loaded URL after redirects, if present. HTTP redirects are guaranteed
      * to be included.
      *
-     * When using {@link PuppeteerCrawler} or {@link PlaywrightCrawler}, meta tag and JavaScript redirects may,
+     * When using {@apilink PuppeteerCrawler} or {@apilink PlaywrightCrawler}, meta tag and JavaScript redirects may,
      * or may not be included, depending on their nature. This generally means that redirects,
      * which happen immediately will most likely be included, but delayed redirects will not.
      */
@@ -100,7 +100,7 @@ export declare class Request<UserData extends Dictionary = Dictionary> {
     protected _hashPayload(payload: BinaryLike): string;
 }
 /**
- * Specifies required and optional fields for constructing a {@link Request}.
+ * Specifies required and optional fields for constructing a {@apilink Request}.
  */
 export interface RequestOptions<UserData extends Dictionary = Dictionary> {
     /** URL of the web page to crawl. It must be a non-empty string. */

package/request.js

@@ -34,7 +34,7 @@ const requestOptionalPredicates = {
  * Each `Request` instance has the `uniqueKey` property, which can be either specified
  * manually in the constructor or generated automatically from the URL. Two requests with the same `uniqueKey`
  * are considered as pointing to the same web resource. This behavior applies to all Apify SDK classes,
- * such as {@link RequestList}, {@link RequestQueue}, {@link PuppeteerCrawler} or {@link PlaywrightCrawler}.
+ * such as {@apilink RequestList}, {@apilink RequestQueue}, {@apilink PuppeteerCrawler} or {@apilink PlaywrightCrawler}.
  *
  * Example use:
  *
@@ -78,7 +78,7 @@ class Request {
          * An actually loaded URL after redirects, if present. HTTP redirects are guaranteed
          * to be included.
          *
-         * When using {@link PuppeteerCrawler} or {@link PlaywrightCrawler}, meta tag and JavaScript redirects may,
+         * When using {@apilink PuppeteerCrawler} or {@apilink PlaywrightCrawler}, meta tag and JavaScript redirects may,
          * or may not be included, depending on their nature. This generally means that redirects,
          * which happen immediately will most likely be included, but delayed redirects will not.
          */

package/session_pool/session.d.ts

@@ -5,7 +5,7 @@ import type { IncomingMessage } from 'node:http';
 import type { Cookie } from 'tough-cookie';
 import { CookieJar } from 'tough-cookie';
 /**
- * Persistable {@link Session} state.
+ * Persistable {@apilink Session} state.
  */
 export interface SessionState {
     id: string;

package/session_pool/session_pool.d.ts

@@ -7,7 +7,7 @@ import type { SessionOptions } from './session';
 import { Session } from './session';
 import type { EventManager } from '../events/event_manager';
 /**
- * Factory user-function which creates customized {@link Session} instances.
+ * Factory user-function which creates customized {@apilink Session} instances.
  */
 export interface CreateSession {
     /**
@@ -24,7 +24,7 @@ export interface SessionPoolOptions {
      * @default 1000
      */
     maxPoolSize?: number;
-    /** The configuration options for {@link Session} instances. */
+    /** The configuration options for {@apilink Session} instances. */
     sessionOptions?: SessionOptions;
     /** Name or Id of `KeyValueStore` where is the `SessionPool` state stored. */
     persistStateKeyValueStoreId?: string;
@@ -50,11 +50,11 @@ export interface SessionPoolOptions {
 }
 /**
  * Handles the rotation, creation and persistence of user-like sessions.
- * Creates a pool of {@link Session} instances, that are randomly rotated.
+ * Creates a pool of {@apilink Session} instances, that are randomly rotated.
  * When some session is marked as blocked, it is removed and new one is created instead (the pool never returns an unusable session).
  * Learn more in the [Session management guide](../../../docs/guides/session-management).
  *
- * You can create one by calling the {@link SessionPool.open} function.
+ * You can create one by calling the {@apilink SessionPool.open} function.
  *
  * Session pool is already integrated into crawlers, and it can significantly improve your scraper
  * performance with just 2 lines of code.
@@ -69,10 +69,10 @@ export interface SessionPoolOptions {
  * })
  * ```
  *
- * You can configure the pool with many options. See the {@link SessionPoolOptions}.
- * Session pool is by default persisted in default {@link KeyValueStore}.
+ * You can configure the pool with many options. See the {@apilink SessionPoolOptions}.
+ * Session pool is by default persisted in default {@apilink KeyValueStore}.
  * If you want to have one pool for all runs you have to specify
- * {@link SessionPoolOptions.persistStateKeyValueStoreId}.
+ * {@apilink SessionPoolOptions.persistStateKeyValueStoreId}.
  *
  * **Advanced usage:**
  *
@@ -133,8 +133,8 @@ export declare class SessionPool extends EventEmitter {
      */
     get retiredSessionsCount(): number;
     /**
-     * Starts periodic state persistence and potentially loads SessionPool state from {@link KeyValueStore}.
-     * It is called automatically by the {@link SessionPool.open} function.
+     * Starts periodic state persistence and potentially loads SessionPool state from {@apilink KeyValueStore}.
+     * It is called automatically by the {@apilink SessionPool.open} function.
      */
     initialize(): Promise<void>;
     /**
@@ -165,7 +165,7 @@ export declare class SessionPool extends EventEmitter {
         sessions: import("./session").SessionState[];
     };
     /**
-     * Persists the current state of the `SessionPool` into the default {@link KeyValueStore}.
+     * Persists the current state of the `SessionPool` into the default {@apilink KeyValueStore}.
      * The state is persisted automatically in regular intervals.
      */
     persistState(): Promise<void>;
@@ -222,9 +222,9 @@ export declare class SessionPool extends EventEmitter {
     protected _maybeLoadSessionPool(): Promise<void>;
     /**
      * Opens a SessionPool and returns a promise resolving to an instance
-     * of the {@link SessionPool} class that is already initialized.
+     * of the {@apilink SessionPool} class that is already initialized.
      *
-     * For more details and code examples, see the {@link SessionPool} class.
+     * For more details and code examples, see the {@apilink SessionPool} class.
      */
     static open(options?: SessionPoolOptions): Promise<SessionPool>;
 }

package/session_pool/session_pool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"session_pool.d.ts","sourceRoot":"","sources":["../../src/session_pool/session_pool.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG3C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAG5D;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;;OAGG;IACH,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACzG;AAED,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,+DAA+D;IAC/D,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,6EAA6E;IAC7E,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,aAAa,CAAC;IAEtC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE9B,gBAAgB;IAChB,GAAG,CAAC,EAAE,GAAG,CAAC;CACb;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,qBAAa,WAAY,SAAQ,YAAY;IAiBK,QAAQ,CAAC,MAAM;IAhB7D,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC;IACnB,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,qBAAqB,EAAE,aAAa,CAAC;IAC/C,SAAS,CAAC,aAAa,EAAG,aAAa,CAAC;IACxC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAM;IACnC,SAAS,CAAC,UAAU,uBAA8B;IAClD,SAAS,CAAC,cAAc,EAAE,cAAc,CAAC;IACzC,SAAS,CAAC,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAC/C,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAClC,SAAS,CAAC,SAAS,EAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC;IAC/B,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAEhD;;OAEG;gBACS,OAAO,GAAE,kBAAuB,EAAW,MAAM,gBAAkC;IA6C/F;;OAEG;IACH,IAAI,mBAAmB,IAAI,MAAM,CAEhC;IAED;;OAEG;IACH,IAAI,oBAAoB,IAAI,MAAM,CAEjC;IAED;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBjC;;;;;OAKG;IACG,UAAU,CAAC,OAAO,GAAE,OAAO,GAAG,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBvE;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IAEpC;;OAEG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA8BrD;;;OAGG;IACH,QAAQ;;;;;IAQR;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAQnC;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAK/B;;OAEG;IACH,SAAS,CAAC,sBAAsB;IAIhC;;OAEG;IACH,SAAS,CAAC,sBAAsB;IAWhC;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO;IAKzC;;OAEG;IACH,SAAS,CAAC,eAAe,IAAI,MAAM;IAInC;;;;;;OAMG;IACH,SAAS,CAAC,6BAA6B,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,GAAE;QAAE,cAAc,CAAC,EAAE,cAAc,CAAA;KAAO,GAAG,OAAO;IAU7H;;;OAGG;cACa,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAQlD;;OAEG;IACH,SAAS,CAAC,mBAAmB,IAAI,OAAO;IAIxC;;;OAGG;IACH,SAAS,CAAC,YAAY,IAAI,OAAO;IAIjC;;;OAGG;cACa,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBtD;;;;;OAKG;WACU,IAAI,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;CAKxE"}
+{"version":3,"file":"session_pool.d.ts","sourceRoot":"","sources":["../../src/session_pool/session_pool.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG3C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAG5D;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;;OAGG;IACH,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACzG;AAED,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,kEAAkE;IAClE,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,6EAA6E;IAC7E,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,aAAa,CAAC;IAEtC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE9B,gBAAgB;IAChB,GAAG,CAAC,EAAE,GAAG,CAAC;CACb;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,qBAAa,WAAY,SAAQ,YAAY;IAiBK,QAAQ,CAAC,MAAM;IAhB7D,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC;IACnB,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,qBAAqB,EAAE,aAAa,CAAC;IAC/C,SAAS,CAAC,aAAa,EAAG,aAAa,CAAC;IACxC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAM;IACnC,SAAS,CAAC,UAAU,uBAA8B;IAClD,SAAS,CAAC,cAAc,EAAE,cAAc,CAAC;IACzC,SAAS,CAAC,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAC/C,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAClC,SAAS,CAAC,SAAS,EAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC;IAC/B,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAEhD;;OAEG;gBACS,OAAO,GAAE,kBAAuB,EAAW,MAAM,gBAAkC;IA6C/F;;OAEG;IACH,IAAI,mBAAmB,IAAI,MAAM,CAEhC;IAED;;OAEG;IACH,IAAI,oBAAoB,IAAI,MAAM,CAEjC;IAED;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBjC;;;;;OAKG;IACG,UAAU,CAAC,OAAO,GAAE,OAAO,GAAG,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBvE;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IAEpC;;OAEG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA8BrD;;;OAGG;IACH,QAAQ;;;;;IAQR;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAQnC;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAK/B;;OAEG;IACH,SAAS,CAAC,sBAAsB;IAIhC;;OAEG;IACH,SAAS,CAAC,sBAAsB;IAWhC;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO;IAKzC;;OAEG;IACH,SAAS,CAAC,eAAe,IAAI,MAAM;IAInC;;;;;;OAMG;IACH,SAAS,CAAC,6BAA6B,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,GAAE;QAAE,cAAc,CAAC,EAAE,cAAc,CAAA;KAAO,GAAG,OAAO;IAU7H;;;OAGG;cACa,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAQlD;;OAEG;IACH,SAAS,CAAC,mBAAmB,IAAI,OAAO;IAIxC;;;OAGG;IACH,SAAS,CAAC,YAAY,IAAI,OAAO;IAIjC;;;OAGG;cACa,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBtD;;;;;OAKG;WACU,IAAI,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;CAKxE"}

package/session_pool/session_pool.js

@@ -10,11 +10,11 @@ const key_value_store_1 = require("../storages/key_value_store");
 const session_1 = require("./session");
 /**
  * Handles the rotation, creation and persistence of user-like sessions.
- * Creates a pool of {@link Session} instances, that are randomly rotated.
+ * Creates a pool of {@apilink Session} instances, that are randomly rotated.
  * When some session is marked as blocked, it is removed and new one is created instead (the pool never returns an unusable session).
  * Learn more in the [Session management guide](../../../docs/guides/session-management).
  *
- * You can create one by calling the {@link SessionPool.open} function.
+ * You can create one by calling the {@apilink SessionPool.open} function.
  *
  * Session pool is already integrated into crawlers, and it can significantly improve your scraper
  * performance with just 2 lines of code.
@@ -29,10 +29,10 @@ const session_1 = require("./session");
  * })
  * ```
  *
- * You can configure the pool with many options. See the {@link SessionPoolOptions}.
- * Session pool is by default persisted in default {@link KeyValueStore}.
+ * You can configure the pool with many options. See the {@apilink SessionPoolOptions}.
+ * Session pool is by default persisted in default {@apilink KeyValueStore}.
  * If you want to have one pool for all runs you have to specify
- * {@link SessionPoolOptions.persistStateKeyValueStoreId}.
+ * {@apilink SessionPoolOptions.persistStateKeyValueStoreId}.
  *
  * **Advanced usage:**
  *
@@ -191,8 +191,8 @@ class SessionPool extends node_events_1.EventEmitter {
         return this.sessions.filter((session) => !session.isUsable()).length;
     }
     /**
-     * Starts periodic state persistence and potentially loads SessionPool state from {@link KeyValueStore}.
-     * It is called automatically by the {@link SessionPool.open} function.
+     * Starts periodic state persistence and potentially loads SessionPool state from {@apilink KeyValueStore}.
+     * It is called automatically by the {@apilink SessionPool.open} function.
      */
     async initialize() {
         this.keyValueStore = await key_value_store_1.KeyValueStore.open(this.persistStateKeyValueStoreId, { config: this.config });
@@ -266,7 +266,7 @@ class SessionPool extends node_events_1.EventEmitter {
         };
     }
     /**
-     * Persists the current state of the `SessionPool` into the default {@link KeyValueStore}.
+     * Persists the current state of the `SessionPool` into the default {@apilink KeyValueStore}.
      * The state is persisted automatically in regular intervals.
      */
     async persistState() {
@@ -382,9 +382,9 @@ class SessionPool extends node_events_1.EventEmitter {
     }
     /**
      * Opens a SessionPool and returns a promise resolving to an instance
-     * of the {@link SessionPool} class that is already initialized.
+     * of the {@apilink SessionPool} class that is already initialized.
      *
-     * For more details and code examples, see the {@link SessionPool} class.
+     * For more details and code examples, see the {@apilink SessionPool} class.
      */
     static async open(options) {
         const sessionPool = new SessionPool(options);

package/storages/dataset.d.ts

@@ -90,7 +90,7 @@ export interface DatasetIteratorOptions extends Omit<DatasetDataOptions, 'offset
  * Typically it is used to store crawling results.
  *
  * Do not instantiate this class directly, use the
- * {@link Dataset.open} function instead.
+ * {@apilink Dataset.open} function instead.
  *
  * `Dataset` stores its data either on local disk or in the Apify cloud,
  * depending on whether the `APIFY_LOCAL_STORAGE_DIR` or `APIFY_TOKEN` environment variables are set.
@@ -107,7 +107,7 @@ export interface DatasetIteratorOptions extends Omit<DatasetDataOptions, 'offset
  * If the `APIFY_TOKEN` environment variable is set but `APIFY_LOCAL_STORAGE_DIR` not, the data is stored in the
  * [Apify Dataset](https://docs.apify.com/storage/dataset)
  * cloud storage. Note that you can force usage of the cloud storage also by passing the `forceCloud`
- * option to {@link Dataset.open} function,
+ * option to {@apilink Dataset.open} function,
  * even if the `APIFY_LOCAL_STORAGE_DIR` variable is set.
  *
  * **Example usage:**
@@ -166,7 +166,7 @@ export declare class Dataset<Data extends Dictionary = Dictionary> {
      */
     pushData(data: Data | Data[]): Promise<void>;
     /**
-     * Returns {@link DatasetContent} object holding the items in the dataset based on the provided parameters.
+     * Returns {@apilink DatasetContent} object holding the items in the dataset based on the provided parameters.
      */
     getData(options?: DatasetDataOptions): Promise<PaginatedList<Data>>;
     /**
@@ -245,13 +245,13 @@ export declare class Dataset<Data extends Dictionary = Dictionary> {
      */
     drop(): Promise<void>;
     /**
-     * Opens a dataset and returns a promise resolving to an instance of the {@link Dataset} class.
+     * Opens a dataset and returns a promise resolving to an instance of the {@apilink Dataset} class.
      *
      * Datasets are used to store structured data where each object stored has the same attributes,
      * such as online store products or real estate offers.
      * The actual data is stored either on the local filesystem or in the cloud.
      *
-     * For more details and code examples, see the {@link Dataset} class.
+     * For more details and code examples, see the {@apilink Dataset} class.
      *
      * @param [datasetIdOrName]
      *   ID or name of the dataset to be opened. If `null` or `undefined`,
@@ -260,9 +260,9 @@ export declare class Dataset<Data extends Dictionary = Dictionary> {
      */
     static open<Data extends Dictionary = Dictionary>(datasetIdOrName?: string | null, options?: StorageManagerOptions): Promise<Dataset<Data>>;
     /**
-     * Stores an object or an array of objects to the default {@link Dataset} of the current crawler run.
+     * Stores an object or an array of objects to the default {@apilink Dataset} of the current crawler run.
      *
-     * This is just a convenient shortcut for {@link Dataset.pushData}.
+     * This is just a convenient shortcut for {@apilink Dataset.pushData}.
      * For example, calling the following code:
      * ```javascript
      * await Dataset.pushData({ myValue: 123 });
@@ -274,7 +274,7 @@ export declare class Dataset<Data extends Dictionary = Dictionary> {
      * await dataset.pushData({ myValue: 123 });
      * ```
      *
-     * For more information, see {@link Dataset.open} and {@link Dataset.pushData}
+     * For more information, see {@apilink Dataset.open} and {@apilink Dataset.pushData}
      *
      * **IMPORTANT**: Make sure to use the `await` keyword when calling `pushData()`,
      * otherwise the crawler process might finish before the data are stored!
@@ -290,8 +290,8 @@ export declare class Dataset<Data extends Dictionary = Dictionary> {
  */
 export interface DatasetConsumer<Data> {
     /**
-     * @param item Current {@link Dataset} entry being processed.
-     * @param index Position of current {@link Dataset} entry.
+     * @param item Current {@apilink Dataset} entry being processed.
+     * @param index Position of current {@apilink Dataset} entry.
      */
     (item: Data, index: number): Awaitable<void>;
 }
@@ -301,8 +301,8 @@ export interface DatasetConsumer<Data> {
 export interface DatasetMapper<Data, R> {
     /**
      * User-function used in the `Dataset.map()` API.
-     * @param item Current {@link Dataset} entry being processed.
-     * @param index Position of current {@link Dataset} entry.
+     * @param item Current {@apilink Dataset} entry being processed.
+     * @param index Position of current {@apilink Dataset} entry.
      */
     (item: Data, index: number): Awaitable<R>;
 }
@@ -312,8 +312,8 @@ export interface DatasetMapper<Data, R> {
 export interface DatasetReducer<T, Data> {
     /**
      * @param memo Previous state of the reduction.
-     * @param item Current {@link Dataset} entry being processed.
-     * @param index Position of current {@link Dataset} entry.
+     * @param item Current {@apilink Dataset} entry being processed.
+     * @param index Position of current {@apilink Dataset} entry.
      */
     (memo: T, item: Data, index: number): Awaitable<T>;
 }

package/storages/dataset.js

@@ -87,7 +87,7 @@ exports.chunkBySize = chunkBySize;
  * Typically it is used to store crawling results.
  *
  * Do not instantiate this class directly, use the
- * {@link Dataset.open} function instead.
+ * {@apilink Dataset.open} function instead.
  *
  * `Dataset` stores its data either on local disk or in the Apify cloud,
  * depending on whether the `APIFY_LOCAL_STORAGE_DIR` or `APIFY_TOKEN` environment variables are set.
@@ -104,7 +104,7 @@ exports.chunkBySize = chunkBySize;
  * If the `APIFY_TOKEN` environment variable is set but `APIFY_LOCAL_STORAGE_DIR` not, the data is stored in the
  * [Apify Dataset](https://docs.apify.com/storage/dataset)
  * cloud storage. Note that you can force usage of the cloud storage also by passing the `forceCloud`
- * option to {@link Dataset.open} function,
+ * option to {@apilink Dataset.open} function,
  * even if the `APIFY_LOCAL_STORAGE_DIR` variable is set.
  *
  * **Example usage:**
@@ -208,7 +208,7 @@ class Dataset {
         }
     }
     /**
-     * Returns {@link DatasetContent} object holding the items in the dataset based on the provided parameters.
+     * Returns {@apilink DatasetContent} object holding the items in the dataset based on the provided parameters.
      */
     async getData(options = {}) {
         try {
@@ -343,13 +343,13 @@ class Dataset {
         manager.closeStorage(this);
     }
     /**
-     * Opens a dataset and returns a promise resolving to an instance of the {@link Dataset} class.
+     * Opens a dataset and returns a promise resolving to an instance of the {@apilink Dataset} class.
      *
      * Datasets are used to store structured data where each object stored has the same attributes,
      * such as online store products or real estate offers.
      * The actual data is stored either on the local filesystem or in the cloud.
      *
-     * For more details and code examples, see the {@link Dataset} class.
+     * For more details and code examples, see the {@apilink Dataset} class.
      *
      * @param [datasetIdOrName]
      *   ID or name of the dataset to be opened. If `null` or `undefined`,
@@ -367,9 +367,9 @@ class Dataset {
         return manager.openStorage(datasetIdOrName, options.config.getStorageClient());
     }
     /**
-     * Stores an object or an array of objects to the default {@link Dataset} of the current crawler run.
+     * Stores an object or an array of objects to the default {@apilink Dataset} of the current crawler run.
      *
-     * This is just a convenient shortcut for {@link Dataset.pushData}.
+     * This is just a convenient shortcut for {@apilink Dataset.pushData}.
      * For example, calling the following code:
      * ```javascript
      * await Dataset.pushData({ myValue: 123 });
@@ -381,7 +381,7 @@ class Dataset {
      * await dataset.pushData({ myValue: 123 });
      * ```
      *
-     * For more information, see {@link Dataset.open} and {@link Dataset.pushData}
+     * For more information, see {@apilink Dataset.open} and {@apilink Dataset.pushData}
      *
      * **IMPORTANT**: Make sure to use the `await` keyword when calling `pushData()`,
      * otherwise the crawler process might finish before the data are stored!