apify 4.0.0-beta.31 → 4.0.0-beta.32

package/dist/charging.d.ts

@@ -54,20 +54,7 @@ export declare function mergeChargeResults(a: ChargeResult, b: ChargeResult): Ch
  * Handles pay-per-event charging.
  */
 export declare class ChargingManager {
-    private configuration;
-    private readonly LOCAL_CHARGING_LOG_DATASET_NAME;
-    private readonly PLATFORM_CHARGING_LOG_DATASET_ID_KEY;
-    private maxTotalChargeUsd;
-    private isAtHome;
-    private actorRunId?;
-    private pricingModel?;
-    private purgeChargingLogDataset;
-    private useChargingLogDataset;
-    private notPpeWarningPrinted;
-    private pricingInfo;
-    private chargingState?;
-    private chargingLogDataset?;
-    private apifyClient;
+    #private;
     constructor(configuration: Configuration, apifyClient: ApifyClient);
     private get isPayPerEvent();
     private fetchPricingInfo;

package/dist/charging.js

@@ -15,45 +15,45 @@ export function mergeChargeResults(a, b) {
  * Handles pay-per-event charging.
  */
 export class ChargingManager {
-    configuration;
-    LOCAL_CHARGING_LOG_DATASET_NAME = 'charging_log';
-    PLATFORM_CHARGING_LOG_DATASET_ID_KEY = 'CHARGING_LOG_DATASET_ID';
-    maxTotalChargeUsd;
-    isAtHome;
-    actorRunId;
-    pricingModel;
-    purgeChargingLogDataset;
-    useChargingLogDataset;
-    notPpeWarningPrinted = false;
-    pricingInfo = {};
-    chargingState;
-    chargingLogDataset;
-    apifyClient;
+    #LOCAL_CHARGING_LOG_DATASET_NAME = 'charging_log';
+    #PLATFORM_CHARGING_LOG_DATASET_ID_KEY = 'CHARGING_LOG_DATASET_ID';
+    #maxTotalChargeUsd;
+    #isAtHome;
+    #actorRunId;
+    #pricingModel;
+    #purgeChargingLogDataset;
+    #useChargingLogDataset;
+    #notPpeWarningPrinted = false;
+    #pricingInfo = {};
+    #chargingState;
+    #chargingLogDataset;
+    #apifyClient;
+    #configuration;
     constructor(configuration, apifyClient) {
-        this.configuration = configuration;
-        this.maxTotalChargeUsd = configuration.maxTotalChargeUsd || Infinity; // convert `0` to `Infinity` in case the value is an empty string
-        this.isAtHome = configuration.isAtHome;
-        this.actorRunId = configuration.actorRunId;
-        this.purgeChargingLogDataset = configuration.purgeOnStart;
-        this.useChargingLogDataset = configuration.useChargingLogDataset;
-        this.apifyClient = apifyClient;
+        this.#configuration = configuration;
+        this.#maxTotalChargeUsd = configuration.maxTotalChargeUsd || Infinity; // convert `0` to `Infinity` in case the value is an empty string
+        this.#isAtHome = configuration.isAtHome;
+        this.#actorRunId = configuration.actorRunId;
+        this.#purgeChargingLogDataset = configuration.purgeOnStart;
+        this.#useChargingLogDataset = configuration.useChargingLogDataset;
+        this.#apifyClient = apifyClient;
     }
     get isPayPerEvent() {
-        return this.pricingModel === 'PAY_PER_EVENT';
+        return this.#pricingModel === 'PAY_PER_EVENT';
     }
     async fetchPricingInfo() {
-        if (this.configuration.actorPricingInfo && this.configuration.chargedEventCounts) {
+        if (this.#configuration.actorPricingInfo && this.#configuration.chargedEventCounts) {
             return {
-                pricingInfo: JSON.parse(this.configuration.actorPricingInfo),
-                chargedEventCounts: JSON.parse(this.configuration.chargedEventCounts),
-                maxTotalChargeUsd: this.configuration.maxTotalChargeUsd || Infinity,
+                pricingInfo: JSON.parse(this.#configuration.actorPricingInfo),
+                chargedEventCounts: JSON.parse(this.#configuration.chargedEventCounts),
+                maxTotalChargeUsd: this.#configuration.maxTotalChargeUsd || Infinity,
             };
         }
-        if (this.isAtHome) {
-            if (this.actorRunId === undefined) {
+        if (this.#isAtHome) {
+            if (this.#actorRunId === undefined) {
                 throw new Error('Actor run ID not found even though the Actor is running on Apify');
             }
-            const run = await this.apifyClient.run(this.actorRunId).get();
+            const run = await this.#apifyClient.run(this.#actorRunId).get();
             if (run === undefined) {
                 throw new Error('Actor run not found');
             }
@@ -66,7 +66,7 @@ export class ChargingManager {
         return {
             pricingInfo: undefined,
             chargedEventCounts: {},
-            maxTotalChargeUsd: this.configuration.maxTotalChargeUsd || Infinity,
+            maxTotalChargeUsd: this.#configuration.maxTotalChargeUsd || Infinity,
         };
     }
     /**
@@ -74,63 +74,63 @@ export class ChargingManager {
      */
     async init() {
         // Validate config - it may have changed since the instantiation
-        if (this.useChargingLogDataset && this.isAtHome) {
+        if (this.#useChargingLogDataset && this.#isAtHome) {
             throw new Error('Using the ACTOR_USE_CHARGING_LOG_DATASET environment variable is only supported in a local development environment');
         }
-        if (this.configuration.testPayPerEvent) {
-            if (this.isAtHome) {
+        if (this.#configuration.testPayPerEvent) {
+            if (this.#isAtHome) {
                 throw new Error('Using the ACTOR_TEST_PAY_PER_EVENT environment variable is only supported in a local development environment');
             }
         }
         // Retrieve pricing information
         const { pricingInfo, chargedEventCounts, maxTotalChargeUsd } = await this.fetchPricingInfo();
-        if (this.configuration.testPayPerEvent) {
-            this.pricingModel = 'PAY_PER_EVENT';
+        if (this.#configuration.testPayPerEvent) {
+            this.#pricingModel = 'PAY_PER_EVENT';
         }
         else {
-            this.pricingModel ??= pricingInfo?.pricingModel;
+            this.#pricingModel ??= pricingInfo?.pricingModel;
         }
         // Load per-event pricing information
         if (pricingInfo?.pricingModel === 'PAY_PER_EVENT') {
             for (const [eventName, eventPricing] of Object.entries(pricingInfo.pricingPerEvent.actorChargeEvents)) {
-                this.pricingInfo[eventName] = {
+                this.#pricingInfo[eventName] = {
                     price: eventPricing.eventPriceUsd,
                     title: eventPricing.eventTitle,
                 };
             }
-            this.maxTotalChargeUsd = maxTotalChargeUsd;
+            this.#maxTotalChargeUsd = maxTotalChargeUsd;
         }
-        this.chargingState = {};
+        this.#chargingState = {};
         for (const [eventName, chargeCount] of Object.entries(chargedEventCounts ?? {})) {
-            this.chargingState[eventName] = {
+            this.#chargingState[eventName] = {
                 chargeCount,
-                totalChargedAmount: chargeCount * (this.pricingInfo[eventName]?.price ?? 0),
+                totalChargedAmount: chargeCount * (this.#pricingInfo[eventName]?.price ?? 0),
             };
         }
-        if (!this.isPayPerEvent || !this.useChargingLogDataset) {
+        if (!this.isPayPerEvent || !this.#useChargingLogDataset) {
             return;
         }
         // Set up charging log dataset
-        if (this.isAtHome) {
+        if (this.#isAtHome) {
             const datasetId = await this.ensureChargingLogDatasetOnPlatform();
-            this.chargingLogDataset = await Dataset.open(datasetId);
+            this.#chargingLogDataset = await Dataset.open(datasetId);
         }
         else {
-            if (this.purgeChargingLogDataset) {
-                const dataset = await Dataset.open(this.LOCAL_CHARGING_LOG_DATASET_NAME);
+            if (this.#purgeChargingLogDataset) {
+                const dataset = await Dataset.open(this.#LOCAL_CHARGING_LOG_DATASET_NAME);
                 await dataset.drop();
             }
-            this.chargingLogDataset = await Dataset.open(this.LOCAL_CHARGING_LOG_DATASET_NAME);
+            this.#chargingLogDataset = await Dataset.open(this.#LOCAL_CHARGING_LOG_DATASET_NAME);
         }
     }
     async ensureChargingLogDatasetOnPlatform() {
         const defaultStore = await KeyValueStore.open();
-        const storedDatasetId = await defaultStore.getValue(this.PLATFORM_CHARGING_LOG_DATASET_ID_KEY);
+        const storedDatasetId = await defaultStore.getValue(this.#PLATFORM_CHARGING_LOG_DATASET_ID_KEY);
         if (storedDatasetId !== null) {
             return storedDatasetId;
         }
-        const dataset = await this.apifyClient.datasets().getOrCreate();
-        await defaultStore.setValue(this.PLATFORM_CHARGING_LOG_DATASET_ID_KEY, dataset.id);
+        const dataset = await this.#apifyClient.datasets().getOrCreate();
+        await defaultStore.setValue(this.#PLATFORM_CHARGING_LOG_DATASET_ID_KEY, dataset.id);
         return dataset.id;
     }
     /**
@@ -138,20 +138,20 @@ export class ChargingManager {
      * {@link ChargingManager.getPricingInfo}) require an initialized manager.
      */
     get isInitialized() {
-        return this.chargingState !== undefined;
+        return this.#chargingState !== undefined;
     }
     /**
      * Get information about the pricing for this Actor.
      */
     getPricingInfo() {
-        if (this.chargingState === undefined) {
+        if (this.#chargingState === undefined) {
             throw new Error('ChargingManager is not initialized');
         }
         return {
-            pricingModel: this.pricingModel,
+            pricingModel: this.#pricingModel,
             isPayPerEvent: this.isPayPerEvent,
-            maxTotalChargeUsd: this.maxTotalChargeUsd,
-            perEventPrices: Object.fromEntries(Object.entries(this.pricingInfo).map(([eventName, { price }]) => [eventName, price])),
+            maxTotalChargeUsd: this.#maxTotalChargeUsd,
+            perEventPrices: Object.fromEntries(Object.entries(this.#pricingInfo).map(([eventName, { price }]) => [eventName, price])),
         };
     }
     /**
@@ -171,11 +171,14 @@ export class ChargingManager {
      * @param options The name of the event to charge for and the number of events to be charged.
      */
     async charge({ eventName, count = 1 }) {
-        const calculateChargeableWithinLimit = () => Object.fromEntries(Object.keys(this.pricingInfo).map((name) => [name, this.calculateMaxEventChargeCountWithinLimit(name)]));
+        const calculateChargeableWithinLimit = () => Object.fromEntries(Object.keys(this.#pricingInfo).map((name) => [
+            name,
+            this.calculateMaxEventChargeCountWithinLimit(name),
+        ]));
         if (!this.isPayPerEvent) {
-            if (!this.notPpeWarningPrinted) {
+            if (!this.#notPpeWarningPrinted) {
                 log.warning('Ignored attempt to charge for an event - the Actor does not use the pay-per-event pricing');
-                this.notPpeWarningPrinted = true;
+                this.#notPpeWarningPrinted = true;
             }
             return {
                 eventChargeLimitReached: false,
@@ -183,7 +186,7 @@ export class ChargingManager {
                 chargeableWithinLimit: calculateChargeableWithinLimit(),
             };
         }
-        if (this.chargingState === undefined) {
+        if (this.#chargingState === undefined) {
             throw new Error('ChargingManager is not initialized');
         }
         /* START OF CRITICAL SECTION - no awaits here */
@@ -195,7 +198,7 @@ export class ChargingManager {
             // If the caller tries to charge more than the budget allows, overcharge by one event
             // so that the Actor is detected by the platform and terminated.
             // But don't do this if already strictly over the budget - no point piling on charges.
-            if (this.calculateTotalChargedAmount() <= this.maxTotalChargeUsd) {
+            if (this.calculateTotalChargedAmount() <= this.#maxTotalChargeUsd) {
                 return maxEventChargeCount + 1;
             }
             return 0;
@@ -207,32 +210,32 @@ export class ChargingManager {
                 chargeableWithinLimit: calculateChargeableWithinLimit(),
             };
         }
-        const pricingInfo = this.pricingInfo[eventName] ?? {
-            price: this.isAtHome ? 0 : 1, // Use a nonzero price for local development so that the maximum budget can be reached
+        const pricingInfo = this.#pricingInfo[eventName] ?? {
+            price: this.#isAtHome ? 0 : 1, // Use a nonzero price for local development so that the maximum budget can be reached
             title: `Unknown event '${eventName}'`,
         };
-        this.chargingState[eventName] ??= {
+        this.#chargingState[eventName] ??= {
             chargeCount: 0,
             totalChargedAmount: 0,
         };
-        this.chargingState[eventName].chargeCount += chargedCount;
-        this.chargingState[eventName].totalChargedAmount += chargedCount * pricingInfo.price;
+        this.#chargingState[eventName].chargeCount += chargedCount;
+        this.#chargingState[eventName].totalChargedAmount += chargedCount * pricingInfo.price;
         /* END OF CRITICAL SECTION */
-        if (this.isAtHome) {
+        if (this.#isAtHome) {
             if (eventName.startsWith('apify-')) {
                 // Synthetic events (e.g. apify-default-dataset-item) are tracked locally only,
                 // the platform handles them automatically based on dataset writes.
             }
-            else if (this.pricingInfo[eventName] !== undefined) {
-                await this.apifyClient.run(this.actorRunId).charge({ eventName, count: chargedCount });
+            else if (this.#pricingInfo[eventName] !== undefined) {
+                await this.#apifyClient.run(this.#actorRunId).charge({ eventName, count: chargedCount });
             }
             else {
                 log.warning(`Attempting to charge for an unknown event '${eventName}'`);
             }
         }
         const timestamp = new Date().toISOString();
-        if (this.chargingLogDataset !== undefined) {
-            await this.chargingLogDataset.pushData({
+        if (this.#chargingLogDataset !== undefined) {
+            await this.#chargingLogDataset.pushData({
                 eventName,
                 eventTitle: pricingInfo.title,
                 eventPriceUsd: pricingInfo.price,
@@ -254,25 +257,25 @@ export class ChargingManager {
      * Get the number of events with given name that the Actor has charged for so far.
      */
     getChargedEventCount(eventName) {
-        if (this.chargingState === undefined) {
+        if (this.#chargingState === undefined) {
             throw new Error('ChargingManager is not initialized');
         }
-        return this.chargingState[eventName]?.chargeCount ?? 0;
+        return this.#chargingState[eventName]?.chargeCount ?? 0;
     }
     /**
      * Get the maximum amount of money that the Actor is allowed to charge.
      */
     getMaxTotalChargeUsd() {
-        if (this.chargingState === undefined) {
+        if (this.#chargingState === undefined) {
             throw new Error('ChargingManager is not initialized');
         }
-        return this.maxTotalChargeUsd;
+        return this.#maxTotalChargeUsd;
     }
     calculateTotalChargedAmount() {
-        if (this.chargingState === undefined) {
+        if (this.#chargingState === undefined) {
             throw new Error('ChargingManager is not initialized');
         }
-        const result = Object.values(this.chargingState)
+        const result = Object.values(this.#chargingState)
             .map(({ totalChargedAmount }) => totalChargedAmount)
             .reduce((sum, inc) => sum + inc, 0);
         // Keeping float precision issues at bay
@@ -283,7 +286,7 @@ export class ChargingManager {
      * If the event is not registered, returns Infinity (free of charge)
      */
     calculateMaxEventChargeCountWithinLimit(eventName) {
-        if (this.chargingState === undefined) {
+        if (this.#chargingState === undefined) {
             throw new Error('ChargingManager is not initialized');
         }
         const price = this.calculateEventPrice(eventName);
@@ -293,11 +296,11 @@ export class ChargingManager {
         return this.calculateMaxChargesByPrice(price);
     }
     calculateEventPrice(eventName) {
-        return this.isAtHome ? this.pricingInfo[eventName]?.price : 1; // Use a nonzero price for local development so that the maximum budget can be reached
+        return this.#isAtHome ? this.#pricingInfo[eventName]?.price : 1; // Use a nonzero price for local development so that the maximum budget can be reached
     }
     calculateMaxChargesByPrice(price) {
         // The raw number of events allowed by the budget
-        const unroundedResult = (this.maxTotalChargeUsd - this.calculateTotalChargedAmount()) / price;
+        const unroundedResult = (this.#maxTotalChargeUsd - this.calculateTotalChargedAmount()) / price;
         // First round as Math.floor(4.9999999999999999) will incorrectly return 5
         const roundedResult = Math.floor(Number(unroundedResult.toFixed(4)));
         return Math.max(0, roundedResult);
@@ -307,7 +310,7 @@ export class ChargingManager {
      * Returns the limited items and count to charge.
      */
     calculatePushDataLimits({ items, eventName, isDefaultDataset, }) {
-        if (this.chargingState === undefined) {
+        if (this.#chargingState === undefined) {
             throw new Error('ChargingManager is not initialized');
         }
         const itemsArray = Array.isArray(items) ? items : [items];
@@ -329,7 +332,7 @@ export class ChargingManager {
             // But don't do this if already strictly over the budget - no point piling on charges.
             if (itemsArray.length > 0 &&
                 maxChargedCount === 0 &&
-                this.calculateTotalChargedAmount() <= this.maxTotalChargeUsd) {
+                this.calculateTotalChargedAmount() <= this.#maxTotalChargeUsd) {
                 return 1;
             }
             return maxChargedCount;

package/dist/platform_event_manager.d.ts

@@ -39,9 +39,8 @@ import { Configuration } from './configuration.js';
  *   you can achieve the same effect using `setInterval()` and listening for the `migrating` event.
  */
 export declare class PlatformEventManager extends EventManager {
+    #private;
     readonly configuration: Configuration;
-    /** Websocket connection to Actor events. */
-    private eventsWs?;
     constructor(configuration?: Configuration);
     /**
      * Initializes `Actor.events` event emitter by creating a connection to a websocket that provides them.

package/dist/platform_event_manager.js

@@ -44,7 +44,7 @@ import { Configuration } from './configuration.js';
 export class PlatformEventManager extends EventManager {
     configuration;
     /** Websocket connection to Actor events. */
-    eventsWs;
+    #eventsWs;
     constructor(configuration = Configuration.getGlobalConfiguration()) {
         super({
             persistStateIntervalMillis: configuration.persistStateIntervalMillis,
@@ -69,8 +69,8 @@ export class PlatformEventManager extends EventManager {
         this.createWebSocketConnection(eventsWsUrl);
     }
     createWebSocketConnection(eventsWsUrl) {
-        this.eventsWs = new WebSocket(eventsWsUrl);
-        this.eventsWs.on('message', (message) => {
+        this.#eventsWs = new WebSocket(eventsWsUrl);
+        this.#eventsWs.on('message', (message) => {
             if (!message)
                 return;
             try {
@@ -87,15 +87,15 @@ export class PlatformEventManager extends EventManager {
                 this.log.exception(err, 'Cannot parse Actor event');
             }
         });
-        this.eventsWs.on('error', (err) => {
+        this.#eventsWs.on('error', (err) => {
             // Don't print this error as this happens in the case of very short Actor.main().
             if (err.message === 'WebSocket was closed before the connection was established')
                 return;
             this.log.exception(err, 'web socket connection failed');
         });
-        this.eventsWs.on('close', () => {
+        this.#eventsWs.on('close', () => {
             this.log.debug('web socket has been closed');
-            this.eventsWs = undefined;
+            this.#eventsWs = undefined;
         });
     }
     /**
@@ -108,6 +108,6 @@ export class PlatformEventManager extends EventManager {
             return;
         }
         await super.close();
-        this.eventsWs?.close();
+        this.#eventsWs?.close();
     }
 }

package/dist/proxy_configuration.d.ts

@@ -151,14 +151,8 @@ export interface ProxyInfo extends CoreProxyInfo {
  * @category Scaling
  */
 export declare class ProxyConfiguration extends CoreProxyConfiguration {
+    #private;
     readonly configuration: Configuration;
-    private groups;
-    private countryCode?;
-    private subdivisionCode?;
-    private password?;
-    private hostname;
-    private port?;
-    private usesApifyProxy?;
     protected readonly log: import("@apify/log").Log;
     /**
      * @internal
@@ -190,22 +184,22 @@ export declare class ProxyConfiguration extends CoreProxyConfiguration {
     /**
      * Returns proxy username.
      */
-    protected _getUsername(sessionId: string): string;
+    protected getUsername(sessionId: string): string;
     protected composeDefaultUrl(sessionId: string): string;
     /**
      * Fetch & set the proxy password from Apify API if an Apify token is provided.
      */
-    protected _setPasswordIfToken(): Promise<void>;
+    private setPasswordIfToken;
     /**
      * Checks whether the user has access to the proxies specified in the provided ProxyConfigurationOptions.
      * If the check can not be made, it only prints a warning and allows the program to continue. This is to
      * prevent program crashes caused by short downtimes of Proxy.
      */
-    protected _checkAccess(): Promise<boolean>;
+    protected checkAccess(): Promise<boolean>;
     /**
      * Apify Proxy can be down for a second or a minute, but this should not crash processes.
      */
-    protected _fetchStatus(): Promise<ProxyStatus | undefined>;
+    protected fetchStatus(): Promise<ProxyStatus | undefined>;
     /**
      * Fetches the Apify Proxy status endpoint once, *through* the proxy, so the
      * response reports on this exact connection (auth + man-in-the-middle).
@@ -214,16 +208,11 @@ export declare class ProxyConfiguration extends CoreProxyConfiguration {
      * plus a `Proxy-Authorization` header — so no proxy-agent dependency is
      * needed. The status endpoint (`http://proxy.apify.com`) is plain HTTP.
      */
-    protected _requestStatus(statusUrl: string, proxyUrl: string): Promise<ProxyStatus>;
+    protected requestStatus(statusUrl: string, proxyUrl: string): Promise<ProxyStatus>;
     /**
      * Throws cannot combine custom proxies with Apify Proxy
      * @internal
      */
-    protected _throwCannotCombineCustomWithApify(): void;
-    /**
-     * Throws cannot combine custom proxies with custom generating function
-     * @internal
-     */
-    protected _throwCannotCombineCustomMethods(): void;
+    protected throwCannotCombineCustomWithApify(): void;
 }
 export {};