@crawlee/core 4.0.0-beta.8 → 4.0.0-beta.81

package/proxy_configuration.d.ts

@@ -1,129 +1,45 @@
+import type { ProxyInfo } from '@crawlee/types';
 import type { Request } from './request.js';
 export interface ProxyConfigurationFunction {
-    (sessionId: string | number, options?: {
+    (options?: {
         request?: Request;
     }): string | null | Promise<string | null>;
 }
+type UrlList = (string | null)[];
 export interface ProxyConfigurationOptions {
     /**
      * An array of custom proxy URLs to be rotated.
      * Custom proxies are not compatible with Apify Proxy and an attempt to use both
      * configuration options will cause an error to be thrown on initialize.
      */
-    proxyUrls?: string[];
+    proxyUrls?: UrlList;
     /**
-     * Custom function that allows you to generate the new proxy URL dynamically. It gets the `sessionId` as a parameter and an optional parameter with the `Request` object when applicable.
+     * Custom function that allows you to generate the new proxy URL dynamically. It gets an optional parameter with the `Request` object when applicable.
      * Can return either stringified proxy URL or `null` if the proxy should not be used. Can be asynchronous.
      *
      * This function is used to generate the URL when {@link ProxyConfiguration.newUrl} or {@link ProxyConfiguration.newProxyInfo} is called.
      */
     newUrlFunction?: ProxyConfigurationFunction;
-    /**
-     * An array of custom proxy URLs to be rotated stratified in tiers.
-     * This is a more advanced version of `proxyUrls` that allows you to define a hierarchy of proxy URLs
-     * If everything goes well, all the requests will be sent through the first proxy URL in the list.
-     * Whenever the crawler encounters a problem with the current proxy on the given domain, it will switch to the higher tier for this domain.
-     * The crawler probes lower-level proxies at intervals to check if it can make the tier downshift.
-     *
-     * This feature is useful when you have a set of proxies with different performance characteristics (speed, price, antibot performance etc.) and you want to use the best one for each domain.
-     *
-     * Use `null` as a proxy URL to disable the proxy for the given tier.
-     */
-    tieredProxyUrls?: (string | null)[][];
-}
-export interface TieredProxy {
-    proxyUrl: string | null;
-    proxyTier?: number;
-}
-/**
- * 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}.
- *
- * **Example usage:**
- *
- * ```javascript
- * const proxyConfiguration = new ProxyConfiguration({
- *   proxyUrls: ['...', '...'] // List of Proxy URLs to rotate
- * });
- *
- * // Getting proxyInfo object by calling class method directly
- * const proxyInfo = await proxyConfiguration.newProxyInfo();
- *
- * // In crawler
- * const crawler = new CheerioCrawler({
- *   // ...
- *   proxyConfiguration,
- *   requestHandler({ proxyInfo }) {
- *      // Getting used proxy URL
- *       const proxyUrl = proxyInfo.url;
- *
- *      // Getting ID of used Session
- *       const sessionIdentifier = proxyInfo.sessionId;
- *   }
- * })
- *
- * ```
- */
-export interface ProxyInfo {
-    /**
-     * The identifier of used {@link Session}, if used.
-     */
-    sessionId?: string;
-    /**
-     * The URL of the proxy.
-     */
-    url: string;
-    /**
-     * Username for the proxy.
-     */
-    username?: string;
-    /**
-     * User's password for the proxy.
-     */
-    password: string;
-    /**
-     * Hostname of your proxy.
-     */
-    hostname: string;
-    /**
-     * Proxy port.
-     */
-    port: number | string;
-    /**
-     * Proxy tier for the current proxy, if applicable (only for `tieredProxyUrls`).
-     */
-    proxyTier?: number;
 }
-interface TieredProxyOptions {
+interface NewUrlOptions {
     request?: Request;
-    proxyTier?: number;
 }
 /**
- * Internal class for tracking the proxy tier history for a specific domain.
+ * Minimal contract that any object passed to a crawler as its `proxyConfiguration`
+ * option must satisfy.
+ *
+ * Implement this interface to plug a custom proxy-provisioning strategy into any Crawlee
+ * crawler — for example a remote proxy service or a thin wrapper around the built-in
+ * `ProxyConfiguration` with different rotation rules. *
  *
- * Predicts the best proxy tier for the next request based on the error history for different proxy tiers.
+ * @category Scaling
  */
-declare class ProxyTierTracker {
-    private histogram;
-    private currentTier;
-    constructor(tieredProxyUrls: (string | null)[][]);
+export interface IProxyConfiguration {
     /**
-     * Processes a single step of the algorithm and updates the current tier prediction based on the error history.
+     * Creates a new {@link ProxyInfo} object describing the proxy to use for the given
+     * request. Returns `undefined` when no proxy should be used.
      */
-    private processStep;
-    /**
-     * Increases the error score for the given proxy tier. This raises the chance of picking a different proxy tier for the subsequent requests.
-     *
-     * The error score is increased by 10 for the given tier. This means that this tier will be disadvantaged for the next 10 requests (every new request prediction decreases the error score by 1).
-     * @param tier The proxy tier to mark as problematic.
-     */
-    addError(tier: number): void;
-    /**
-     * Returns the best proxy tier for the next request based on the error history for different proxy tiers.
-     * @returns The proxy tier prediction
-     */
-    predictTier(): number;
+    newProxyInfo(options?: NewUrlOptions): Promise<ProxyInfo | undefined>;
 }
 /**
  * Configures connection to a proxy server with the provided options. Proxy servers are used to prevent target websites from blocking
@@ -153,16 +69,11 @@ declare class ProxyTierTracker {
  * ```
  * @category Scaling
  */
-export declare class ProxyConfiguration {
-    isManInTheMiddle: boolean;
-    protected nextCustomUrlIndex: number;
-    protected proxyUrls?: string[];
-    protected tieredProxyUrls?: (string | null)[][];
-    protected usedProxyUrls: Map<string, string>;
-    protected newUrlFunction?: ProxyConfigurationFunction;
-// @ts-ignore optional peer dependency or compatibility with es2022
-    protected log: import("@apify/log").Log;
-    protected domainTiers: Map<string, ProxyTierTracker>;
+export declare class ProxyConfiguration implements IProxyConfiguration {
+    readonly isManInTheMiddle = false;
+    private nextCustomUrlIndex;
+    private proxyUrls?;
+    private newUrlFunction?;
     /**
      * Creates a {@link 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
@@ -190,57 +101,23 @@ export declare class ProxyConfiguration {
      * 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}.
-     * @param [sessionId]
-     *  Represents the identifier of user {@link Session} that can be managed by the {@link 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.
      *
-     *  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).
-     *  The identifier must not be longer than 50 characters and include only the following: `0-9`, `a-z`, `A-Z`, `"."`, `"_"` and `"~"`.
      * @return Represents information about used proxy and its configuration.
      */
-    newProxyInfo(sessionId?: string | number, options?: TieredProxyOptions): Promise<ProxyInfo | undefined>;
-    /**
-     * Given a session identifier and a request / proxy tier, this function returns a new proxy URL based on the provided configuration options.
-     * @param _sessionId Session identifier
-     * @param options Options for the tiered proxy rotation
-     * @returns An object with the proxy URL and the proxy tier used.
-     */
-    protected _handleTieredUrl(_sessionId: string, options?: TieredProxyOptions): TieredProxy;
+    newProxyInfo(options?: NewUrlOptions): Promise<ProxyInfo | undefined>;
     /**
-     * Given a `Request` object, this function returns the tier of the proxy that should be used for the request.
+     * Returns a new proxy URL based on provided configuration options.
      *
-     * This returns `null` if `tieredProxyUrls` option is not set.
-     */
-    protected predictProxyTier(request: Request): number | null;
-    /**
-     * 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
-     *  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.
-     *
-     *  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).
-     *  The identifier must not be longer than 50 characters and include only the following: `0-9`, `a-z`, `A-Z`, `"."`, `"_"` and `"~"`.
      * @return A string with a proxy URL, including authentication credentials and port number.
      *  For example, `http://bob:password123@proxy.example.com:8000`
      */
-    newUrl(sessionId?: string | number, options?: TieredProxyOptions): Promise<string | undefined>;
-    /**
-     * Handles custom url rotation with session
-     */
-    protected _handleCustomUrl(sessionId?: string): string;
+    newUrl(options?: NewUrlOptions): Promise<string | undefined>;
+    private handleProxyUrlsList;
     /**
      * Calls the custom newUrlFunction and checks format of its return value
      */
-    protected _callNewUrlFunction(sessionId?: string, options?: {
-        request?: Request;
-    }): Promise<string | null>;
-    protected _throwCannotCombineCustomMethods(): never;
-    protected _throwNoOptionsProvided(): never;
+    private callNewUrlFunction;
+    private throwCannotCombineCustomMethods;
+    private throwNoOptionsProvided;
 }
 export {};
-//# sourceMappingURL=proxy_configuration.d.ts.map

package/proxy_configuration.js

@@ -1,55 +1,4 @@
 import ow from 'ow';
-import log from '@apify/log';
-import { cryptoRandomObjectId } from '@apify/utilities';
-/**
- * Internal class for tracking the proxy tier history for a specific domain.
- *
- * Predicts the best proxy tier for the next request based on the error history for different proxy tiers.
- */
-class ProxyTierTracker {
-    histogram;
-    currentTier;
-    constructor(tieredProxyUrls) {
-        this.histogram = tieredProxyUrls.map(() => 0);
-        this.currentTier = 0;
-    }
-    /**
-     * Processes a single step of the algorithm and updates the current tier prediction based on the error history.
-     */
-    processStep() {
-        this.histogram.forEach((x, i) => {
-            if (this.currentTier === i)
-                return;
-            if (x > 0)
-                this.histogram[i]--;
-        });
-        const left = this.currentTier > 0 ? this.histogram[this.currentTier - 1] : Infinity;
-        const right = this.currentTier < this.histogram.length - 1 ? this.histogram[this.currentTier + 1] : Infinity;
-        if (this.histogram[this.currentTier] > Math.min(left, right)) {
-            this.currentTier = left <= right ? this.currentTier - 1 : this.currentTier + 1;
-        }
-        else if (this.histogram[this.currentTier] === left) {
-            this.currentTier--;
-        }
-    }
-    /**
-     * Increases the error score for the given proxy tier. This raises the chance of picking a different proxy tier for the subsequent requests.
-     *
-     * The error score is increased by 10 for the given tier. This means that this tier will be disadvantaged for the next 10 requests (every new request prediction decreases the error score by 1).
-     * @param tier The proxy tier to mark as problematic.
-     */
-    addError(tier) {
-        this.histogram[tier] += 10;
-    }
-    /**
-     * Returns the best proxy tier for the next request based on the error history for different proxy tiers.
-     * @returns The proxy tier prediction
-     */
-    predictTier() {
-        this.processStep();
-        return this.currentTier;
-    }
-}
 /**
  * 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
@@ -82,11 +31,7 @@ export class ProxyConfiguration {
     isManInTheMiddle = false;
     nextCustomUrlIndex = 0;
     proxyUrls;
-    tieredProxyUrls;
-    usedProxyUrls = new Map();
     newUrlFunction;
-    log = log.child({ prefix: 'ProxyConfiguration' });
-    domainTiers = new Map();
     /**
      * Creates a {@link 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
@@ -109,19 +54,21 @@ export class ProxyConfiguration {
      */
     constructor(options = {}) {
         const { validateRequired, ...rest } = options;
+        if ('tieredProxyUrls' in rest) {
+            throw new Error('The `tieredProxyUrls` option has been removed in Crawlee v4. ' +
+                'See the v4 upgrading guide for the recommended migration to named sessions.');
+        }
         ow(rest, ow.object.exactShape({
-            proxyUrls: ow.optional.array.nonEmpty.ofType(ow.string.url),
+            proxyUrls: ow.optional.array.nonEmpty.ofType(ow.any(ow.string.url, ow.null)),
             newUrlFunction: ow.optional.function,
-            tieredProxyUrls: ow.optional.array.nonEmpty.ofType(ow.array.nonEmpty.ofType(ow.any(ow.string.url, ow.null))),
         }));
-        const { proxyUrls, newUrlFunction, tieredProxyUrls } = options;
-        if ([proxyUrls, newUrlFunction, tieredProxyUrls].filter((x) => x).length > 1)
-            this._throwCannotCombineCustomMethods();
+        const { proxyUrls, newUrlFunction } = options;
+        if (proxyUrls && newUrlFunction)
+            this.throwCannotCombineCustomMethods();
         if (!proxyUrls && !newUrlFunction && validateRequired)
-            this._throwNoOptionsProvided();
+            this.throwNoOptionsProvided();
         this.proxyUrls = proxyUrls;
         this.newUrlFunction = newUrlFunction;
-        this.tieredProxyUrls = tieredProxyUrls;
     }
     /**
      * This function creates a new {@link ProxyInfo} info object.
@@ -129,140 +76,42 @@ export class ProxyConfiguration {
      * 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}.
-     * @param [sessionId]
-     *  Represents the identifier of user {@link Session} that can be managed by the {@link 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.
      *
-     *  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).
-     *  The identifier must not be longer than 50 characters and include only the following: `0-9`, `a-z`, `A-Z`, `"."`, `"_"` and `"~"`.
      * @return Represents information about used proxy and its configuration.
      */
-    async newProxyInfo(sessionId, options) {
-        if (typeof sessionId === 'number')
-            sessionId = `${sessionId}`;
-        let url;
-        let tier;
-        if (this.tieredProxyUrls) {
-            const { proxyUrl, proxyTier } = this._handleTieredUrl(sessionId ?? cryptoRandomObjectId(6), options);
-            url = proxyUrl ?? undefined;
-            tier = proxyTier;
-        }
-        else {
-            url = await this.newUrl(sessionId, options);
-        }
+    async newProxyInfo(options) {
+        const url = await this.newUrl(options);
         if (!url)
             return undefined;
         const { username, password, port, hostname } = new URL(url);
         return {
-            sessionId,
             url,
             username: decodeURIComponent(username),
             password: decodeURIComponent(password),
             hostname,
             port: port,
-            proxyTier: tier,
         };
     }
     /**
-     * Given a session identifier and a request / proxy tier, this function returns a new proxy URL based on the provided configuration options.
-     * @param _sessionId Session identifier
-     * @param options Options for the tiered proxy rotation
-     * @returns An object with the proxy URL and the proxy tier used.
-     */
-    _handleTieredUrl(_sessionId, options) {
-        if (!this.tieredProxyUrls)
-            throw new Error('Tiered proxy URLs are not set');
-        if (!options || (!options?.request && options?.proxyTier === undefined)) {
-            const allProxyUrls = this.tieredProxyUrls.flat();
-            return {
-                proxyUrl: allProxyUrls[this.nextCustomUrlIndex++ % allProxyUrls.length],
-            };
-        }
-        let tierPrediction = options.proxyTier;
-        if (typeof tierPrediction !== 'number') {
-            tierPrediction = this.predictProxyTier(options.request);
-        }
-        const proxyTier = this.tieredProxyUrls[tierPrediction];
-        return {
-            proxyUrl: proxyTier[this.nextCustomUrlIndex++ % proxyTier.length],
-            proxyTier: tierPrediction,
-        };
-    }
-    /**
-     * Given a `Request` object, this function returns the tier of the proxy that should be used for the request.
-     *
-     * This returns `null` if `tieredProxyUrls` option is not set.
-     */
-    predictProxyTier(request) {
-        if (!this.tieredProxyUrls)
-            return null;
-        const domain = new URL(request.url).hostname;
-        if (!this.domainTiers.has(domain)) {
-            this.domainTiers.set(domain, new ProxyTierTracker(this.tieredProxyUrls));
-        }
-        request.userData.__crawlee ??= {};
-        const tracker = this.domainTiers.get(domain);
-        if (typeof request.userData.__crawlee.lastProxyTier === 'number') {
-            tracker.addError(request.userData.__crawlee.lastProxyTier);
-        }
-        const tierPrediction = tracker.predictTier();
-        if (typeof request.userData.__crawlee.lastProxyTier === 'number' &&
-            request.userData.__crawlee.lastProxyTier !== tierPrediction) {
-            log.debug(`Changing proxy tier for domain "${domain}" from ${request.userData.__crawlee.lastProxyTier} to ${tierPrediction}.`);
-        }
-        request.userData.__crawlee.lastProxyTier = tierPrediction;
-        request.userData.__crawlee.forefront = true;
-        return tierPrediction;
-    }
-    /**
-     * 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
-     *  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.
+     * Returns a new proxy URL based on provided configuration options.
      *
-     *  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).
-     *  The identifier must not be longer than 50 characters and include only the following: `0-9`, `a-z`, `A-Z`, `"."`, `"_"` and `"~"`.
      * @return A string with a proxy URL, including authentication credentials and port number.
      *  For example, `http://bob:password123@proxy.example.com:8000`
      */
-    async newUrl(sessionId, options) {
-        if (typeof sessionId === 'number')
-            sessionId = `${sessionId}`;
+    async newUrl(options) {
         if (this.newUrlFunction) {
-            return (await this._callNewUrlFunction(sessionId, { request: options?.request })) ?? undefined;
-        }
-        if (this.tieredProxyUrls) {
-            return this._handleTieredUrl(sessionId ?? cryptoRandomObjectId(6), options).proxyUrl ?? undefined;
+            return (await this.callNewUrlFunction({ request: options?.request })) ?? undefined;
         }
-        return this._handleCustomUrl(sessionId);
+        return this.handleProxyUrlsList() ?? undefined;
     }
-    /**
-     * Handles custom url rotation with session
-     */
-    _handleCustomUrl(sessionId) {
-        let customUrlToUse;
-        if (!sessionId) {
-            return this.proxyUrls[this.nextCustomUrlIndex++ % this.proxyUrls.length];
-        }
-        if (this.usedProxyUrls.has(sessionId)) {
-            customUrlToUse = this.usedProxyUrls.get(sessionId);
-        }
-        else {
-            customUrlToUse = this.proxyUrls[this.nextCustomUrlIndex++ % this.proxyUrls.length];
-            this.usedProxyUrls.set(sessionId, customUrlToUse);
-        }
-        return customUrlToUse;
+    handleProxyUrlsList() {
+        return this.proxyUrls[this.nextCustomUrlIndex++ % this.proxyUrls.length];
     }
     /**
      * Calls the custom newUrlFunction and checks format of its return value
      */
-    async _callNewUrlFunction(sessionId, options) {
-        const proxyUrl = await this.newUrlFunction(sessionId, options);
+    async callNewUrlFunction(options) {
+        const proxyUrl = await this.newUrlFunction(options);
         try {
             if (proxyUrl) {
                 new URL(proxyUrl); // eslint-disable-line no-new
@@ -273,11 +122,10 @@ export class ProxyConfiguration {
             throw new Error(`The provided newUrlFunction did not return a valid URL.\nCause: ${err.message}`);
         }
     }
-    _throwCannotCombineCustomMethods() {
+    throwCannotCombineCustomMethods() {
         throw new Error('Cannot combine custom proxies "options.proxyUrls" with custom generating function "options.newUrlFunction".');
     }
-    _throwNoOptionsProvided() {
+    throwNoOptionsProvided() {
         throw new Error('One of "options.proxyUrls" or "options.newUrlFunction" needs to be provided.');
     }
 }
-//# sourceMappingURL=proxy_configuration.js.map

package/recoverable_state.d.ts

@@ -0,0 +1,120 @@
+import type { Configuration, CrawleeLogger } from '@crawlee/core';
+export interface RecoverableStatePersistenceOptions {
+    /**
+     * The key under which the state is stored in the KeyValueStore
+     */
+    persistStateKey: string;
+    /**
+     * Flag to enable or disable state persistence
+     */
+    persistenceEnabled?: boolean;
+    /**
+     * The name of the KeyValueStore to use for persistence.
+     * If neither a name nor an id are supplied, the default store will be used.
+     */
+    persistStateKvsName?: string;
+    /**
+     * The identifier of the KeyValueStore to use for persistence.
+     * If neither a name nor an id are supplied, the default store will be used.
+     */
+    persistStateKvsId?: string;
+}
+/**
+ * Options for configuring the RecoverableState
+ */
+export interface RecoverableStateOptions<TStateModel = Record<string, unknown>> extends RecoverableStatePersistenceOptions {
+    /**
+     * The default state used if no persisted state is found.
+     * A deep copy is made each time the state is used.
+     */
+    defaultState: TStateModel;
+    /**
+     * A logger instance for logging operations related to state persistence
+     */
+    logger?: CrawleeLogger;
+    /**
+     * Configuration instance to use
+     */
+    config?: Configuration;
+    /**
+     * Optional function to transform the state to a JSON string before persistence.
+     * If not provided, JSON.stringify will be used.
+     */
+    serialize?: (state: TStateModel) => string;
+    /**
+     * Optional function to transform a JSON-serialized object back to the state model.
+     * If not provided, JSON.parse is used.
+     * It is advisable to perform validation in this function and to throw an exception if it fails.
+     */
+    deserialize?: (serializedState: string) => TStateModel;
+}
+/**
+ * A class for managing persistent recoverable state using a plain JavaScript object.
+ *
+ * This class facilitates state persistence to a `KeyValueStore`, allowing data to be saved and retrieved
+ * across migrations or restarts. It manages the loading, saving, and resetting of state data,
+ * with optional persistence capabilities.
+ *
+ * The state is represented by a plain JavaScript object that can be serialized to and deserialized from JSON.
+ * The class automatically hooks into the event system to persist state when needed.
+ */
+export declare class RecoverableState<TStateModel = Record<string, unknown>> {
+    private readonly defaultState;
+    private state;
+    private readonly persistenceEnabled;
+    private readonly persistStateKey;
+    private readonly persistStateKvsName?;
+    private readonly persistStateKvsId?;
+    private keyValueStore;
+    private readonly log;
+    private readonly serialize;
+    private readonly deserialize;
+    /**
+     * Initialize a new recoverable state object.
+     *
+     * @param options Configuration options for the recoverable state
+     */
+    constructor(options: RecoverableStateOptions<TStateModel>);
+    /**
+     * Initialize the recoverable state.
+     *
+     * This method must be called before using the recoverable state. It loads the saved state
+     * if persistence is enabled and registers the object to listen for PERSIST_STATE events.
+     *
+     * @returns The loaded state object
+     */
+    initialize(): Promise<TStateModel>;
+    /**
+     * Clean up resources used by the recoverable state.
+     *
+     * If persistence is enabled, this method deregisters the object from PERSIST_STATE events
+     * and persists the current state one last time.
+     */
+    teardown(): Promise<void>;
+    /**
+     * Get the current state.
+     */
+    get currentValue(): TStateModel;
+    /**
+     * Reset the state to the default values and clear any persisted state.
+     *
+     * Resets the current state to the default state and, if persistence is enabled,
+     * clears the persisted state from the KeyValueStore.
+     */
+    reset(): Promise<void>;
+    /**
+     * Persist the current state to the KeyValueStore.
+     *
+     * This method is typically called in response to a PERSIST_STATE event, but can also be called
+     * directly when needed.
+     *
+     * @param eventData Optional data associated with a PERSIST_STATE event
+     */
+    persistState(eventData?: {
+        isMigrating: boolean;
+    }): Promise<void>;
+    /**
+     * Load the saved state from the KeyValueStore
+     */
+    private loadSavedState;
+}