apify-client 3.0.0-beta.2 → 3.0.0-beta.20

package/dist/resource_clients/log.js

@@ -1,7 +1,10 @@
 import c from 'ansi-colors';
+import { z } from 'zod';
 import log, { Logger, LogLevel } from '@apify/log';
 import { ResourceClient } from '../base/resource_client.js';
-import { cast, catchNotFoundOrThrow } from '../utils.js';
+import { timeoutOptionsShape } from '../timeouts.js';
+import { cast, catchNotFoundForResourceOrThrow, parseArgument } from '../utils.js';
+const logOptionsSchema = z.strictObject({ raw: z.boolean().optional(), ...timeoutOptionsShape });
 /**
  * Client for accessing Actor run or build logs.
  *
@@ -39,21 +42,25 @@ export class LogClient extends ResourceClient {
      *
      * @param options - Log retrieval options.
      * @param options.raw - If `true`, returns raw log content without any processing. Default is `false`.
-     * @returns The log content as a string, or `undefined` if it does not exist.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'long'`.
+     * @returns The log content as a string, or `undefined` if it does not exist. A chained client such as
+     * `run.log()` throws an `ApifyApiError` on a 404, since the run itself may be what is missing.
      * @see https://docs.apify.com/api/v2/log-get
      */
     async get(options = {}) {
+        const { timeoutSecs = 'long', ...params } = parseArgument(options, logOptionsSchema, 'LogOptions');
         const requestOpts = {
-            url: this._url(),
+            url: this.buildUrl(),
             method: 'GET',
-            params: this._params(options),
+            params: this.buildParams(params),
+            timeoutSecs,
         };
         try {
             const response = await this.httpClient.call(requestOpts);
             return cast(response.data);
         }
         catch (err) {
-            catchNotFoundOrThrow(err);
+            catchNotFoundForResourceOrThrow(err, this.id);
         }
         return undefined;
     }
@@ -62,26 +69,30 @@ export class LogClient extends ResourceClient {
      *
      * @param options - Log retrieval options.
      * @param options.raw - If `true`, returns raw log content without any processing. Default is `false`.
-     * @returns The log content as a Readable stream, or `undefined` if it does not exist.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'long'`.
+     * @returns The log content as a Readable stream, or `undefined` if it does not exist. A chained client such as
+     * `run.log()` throws an `ApifyApiError` on a 404, since the run itself may be what is missing.
      * @see https://docs.apify.com/api/v2/log-get
      */
     async stream(options = {}) {
+        const { timeoutSecs = 'long', raw } = parseArgument(options, logOptionsSchema, 'LogOptions');
         const params = {
             stream: true,
-            raw: options.raw,
+            raw,
         };
         const requestOpts = {
-            url: this._url(),
+            url: this.buildUrl(),
             method: 'GET',
-            params: this._params(params),
+            params: this.buildParams(params),
             responseType: 'stream',
+            timeoutSecs,
         };
         try {
             const response = await this.httpClient.call(requestOpts);
             return cast(response.data);
         }
         catch (err) {
-            catchNotFoundOrThrow(err);
+            catchNotFoundForResourceOrThrow(err, this.id);
         }
         return undefined;
     }
@@ -119,39 +130,39 @@ export class LoggerActorRedirect extends Logger {
  * @since Added in 2.20.0
  */
 export class StreamedLog {
-    destinationLog;
-    streamBuffer = [];
-    splitMarker = /(?:\n|^)(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z)/g;
-    relevancyTimeLimit;
-    logClient;
-    streamingTask = null;
-    stopLogging = false;
+    #destinationLog;
+    #streamBuffer = [];
+    #splitMarker = /(?:\n|^)(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z)/g;
+    #relevancyTimeLimit;
+    #logClient;
+    #streamingTask = null;
+    #stopLogging = false;
     constructor(options) {
         const { toLog, logClient, fromStart = true } = options;
-        this.destinationLog = toLog;
-        this.logClient = logClient;
-        this.relevancyTimeLimit = fromStart ? null : new Date();
+        this.#destinationLog = toLog;
+        this.#logClient = logClient;
+        this.#relevancyTimeLimit = fromStart ? null : new Date();
     }
     /**
      * Start log redirection.
      */
     start() {
-        if (this.streamingTask) {
+        if (this.#streamingTask) {
             throw new Error('Streaming task already active');
         }
-        this.stopLogging = false;
-        this.streamingTask = this.streamLog();
+        this.#stopLogging = false;
+        this.#streamingTask = this.#streamLog();
     }
     /**
      * Stop log redirection.
      */
     async stop() {
-        if (!this.streamingTask) {
+        if (!this.#streamingTask) {
             throw new Error('Streaming task is not active');
         }
-        this.stopLogging = true;
+        this.#stopLogging = true;
         try {
-            await this.streamingTask;
+            await this.#streamingTask;
         }
         catch (err) {
             if (!(err instanceof Error && err.name === 'AbortError')) {
@@ -159,30 +170,30 @@ export class StreamedLog {
             }
         }
         finally {
-            this.streamingTask = null;
+            this.#streamingTask = null;
         }
     }
     /**
      * Get log stream from response and redirect it to another log.
      */
-    async streamLog() {
-        const logStream = await this.logClient.stream({ raw: true });
-        if (!logStream) {
-            return;
-        }
+    async #streamLog() {
         try {
-            const lastChunkRemainder = await this.logStreamChunks(logStream);
+            const logStream = await this.#logClient.stream({ raw: true });
+            if (!logStream) {
+                return;
+            }
+            const lastChunkRemainder = await this.#logStreamChunks(logStream);
             // Process whatever is left when exiting. Maybe it is incomplete, maybe it is last log without EOL.
             const lastMessage = Buffer.from(lastChunkRemainder).toString().trim();
             if (lastMessage.length) {
-                this.destinationLog.info(lastMessage);
+                this.#destinationLog.info(lastMessage);
             }
         }
         catch (err) {
             log.warning(`Log redirection stopped due to error`, err);
         }
     }
-    async logStreamChunks(logStream) {
+    async #logStreamChunks(logStream) {
         // Chunk may be incomplete. Keep remainder for next chunk.
         let previousChunkRemainder = new Uint8Array();
         for await (const chunk of logStream) {
@@ -194,10 +205,10 @@ export class StreamedLog {
             const lastCompleteMessageIndex = chunkWithPreviousRemainder.lastIndexOf(0x0a);
             previousChunkRemainder = chunkWithPreviousRemainder.slice(lastCompleteMessageIndex);
             // Push complete part of the chunk to the buffer
-            this.streamBuffer.push(Buffer.from(chunkWithPreviousRemainder.slice(0, lastCompleteMessageIndex)));
-            this.logBufferContent();
+            this.#streamBuffer.push(Buffer.from(chunkWithPreviousRemainder.slice(0, lastCompleteMessageIndex)));
+            this.#logBufferContent();
             // Keep processing the new data until stopped
-            if (this.stopLogging) {
+            if (this.#stopLogging) {
                 break;
             }
         }
@@ -206,26 +217,26 @@ export class StreamedLog {
     /**
      * Parse the buffer and log complete messages.
      */
-    logBufferContent() {
-        const allParts = Buffer.concat(this.streamBuffer).toString().split(this.splitMarker).slice(1);
+    #logBufferContent() {
+        const allParts = Buffer.concat(this.#streamBuffer).toString().split(this.#splitMarker).slice(1);
         // Parse the buffer parts into complete messages
         const messageMarkers = allParts.filter((_, i) => i % 2 === 0);
         const messageContents = allParts.filter((_, i) => i % 2 !== 0);
-        this.streamBuffer = [];
+        this.#streamBuffer = [];
         messageMarkers.forEach((marker, index) => {
             const decodedMarker = marker;
             const decodedContent = messageContents[index];
-            if (this.relevancyTimeLimit) {
+            if (this.#relevancyTimeLimit) {
                 // Log only relevant messages. Ignore too old log messages.
                 const logTime = new Date(decodedMarker);
-                if (logTime < this.relevancyTimeLimit) {
+                if (logTime < this.#relevancyTimeLimit) {
                     return;
                 }
             }
             const message = decodedMarker + decodedContent;
             // Original log level information is not available. Log all on info level. Log level could be guessed for
             // some logs, but for any multiline logs such guess would be probably correct only for the first line.
-            this.destinationLog.info(message.trim());
+            this.#destinationLog.info(message.trim());
         });
     }
 }

package/dist/resource_clients/request_queue.d.ts

@@ -2,6 +2,16 @@ import type { STORAGE_GENERAL_ACCESS } from '@apify/consts';
 import type { ApiClientSubResourceOptions } from '../base/api_client.js';
 import { ResourceClient } from '../base/resource_client.js';
 import type { RequestQueue, RequestQueueClientAddRequestResult, RequestQueueClientBatchDeleteRequestsResult, RequestQueueClientBatchRequestsOperationResult, RequestQueueClientListAndLockHeadResult, RequestQueueClientListHeadResult, RequestQueueClientListRequestsResult, RequestQueueClientProlongRequestLockResult, RequestQueueClientRequestSchema, RequestQueueClientRequestToAdd, RequestQueueClientRequestToUpdate, RequestQueueClientUnlockRequestsResult } from '../models.js';
+import type { TimeoutOptions } from '../timeouts.js';
+/**
+ * A request to add, serialized once up front: `byteLength` decides which batch it goes into, `json` is what the body of
+ * that batch is assembled from, and `request` is what the result bookkeeping needs.
+ */
+interface SerializedRequestToAdd {
+    request: RequestQueueClientRequestToAdd;
+    json: string;
+    byteLength: number;
+}
 export type { AllowedHttpMethods, RequestQueue, RequestQueueClientAddRequestResult, RequestQueueClientBatchDeleteRequestsResult, RequestQueueClientBatchRequestsOperationResult, RequestQueueClientListAndLockHeadResult, RequestQueueClientListHeadResult, RequestQueueClientListItem, RequestQueueClientListRequestsResult, RequestQueueClientLockedListItem, RequestQueueClientProlongRequestLockResult, RequestQueueClientRequestSchema, RequestQueueClientRequestToAdd, RequestQueueClientRequestToUpdate, RequestQueueClientUnlockRequestsResult, RequestQueueStats, } from '../models.js';
 /**
  * Client for managing a specific Request queue.
@@ -34,8 +44,7 @@ export type { AllowedHttpMethods, RequestQueue, RequestQueueClientAddRequestResu
  * @see https://docs.apify.com/platform/storage/request-queue
  */
 export declare class RequestQueueClient extends ResourceClient {
-    private clientKey?;
-    private timeoutMillis?;
+    #private;
     /**
      * @hidden
      */
@@ -43,24 +52,30 @@ export declare class RequestQueueClient extends ResourceClient {
     /**
      * Gets the Request queue object from the Apify API.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The RequestQueue object, or `undefined` if it does not exist
      * @see https://docs.apify.com/api/v2/request-queue-get
      */
-    get(): Promise<RequestQueue | undefined>;
+    get(options?: TimeoutOptions): Promise<RequestQueue | undefined>;
     /**
      * Updates the Request queue with specified fields.
      *
      * @param newFields - Fields to update in the Request queue
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The updated RequestQueue object
      * @see https://docs.apify.com/api/v2/request-queue-put
      */
-    update(newFields: RequestQueueClientUpdateOptions): Promise<RequestQueue>;
+    update(newFields: RequestQueueClientUpdateOptions, options?: TimeoutOptions): Promise<RequestQueue>;
     /**
      * Deletes the Request queue.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @see https://docs.apify.com/api/v2/request-queue-delete
      */
-    delete(): Promise<void>;
+    delete(options?: TimeoutOptions): Promise<void>;
     /**
      * Lists requests from the beginning of the queue (head).
      *
@@ -68,6 +83,8 @@ export declare class RequestQueueClient extends ResourceClient {
      * inspecting what requests are waiting to be processed.
      *
      * @param options - Options for listing (e.g., limit)
+     * @param options.limit - Maximum number of requests to return.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns List of requests from the queue head
      * @see https://docs.apify.com/api/v2/request-queue-head-get
      */
@@ -84,6 +101,7 @@ export declare class RequestQueueClient extends ResourceClient {
      * @param options - Lock configuration
      * @param options.lockSecs - **Required.** Duration in seconds to lock the requests. After this time, the locks expire and requests can be retrieved by other clients.
      * @param options.limit - Maximum number of requests to return. Default is 25.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`.
      * @returns Object containing `items` (locked requests), `queueModifiedAt`, `hadMultipleClients`, and lock information
      * @see https://docs.apify.com/api/v2/request-queue-head-lock-post
      *
@@ -122,6 +140,7 @@ export declare class RequestQueueClient extends ResourceClient {
      * @param request.payload - HTTP payload for POST/PUT requests (string).
      * @param options - Additional options
      * @param options.forefront - If `true`, adds the request to the beginning of the queue. Default is `false` (adds to the end).
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns Object with `requestId`, `wasAlreadyPresent`, and `wasAlreadyHandled` flags
      * @see https://docs.apify.com/api/v2/request-queue-requests-post
      *
@@ -150,8 +169,8 @@ export declare class RequestQueueClient extends ResourceClient {
      *
      * @private
      */
-    protected _batchAddRequests(requests: RequestQueueClientRequestToAdd[], options?: RequestQueueClientAddRequestOptions): Promise<RequestQueueClientBatchRequestsOperationResult>;
-    protected _batchAddRequestsWithRetries(requests: RequestQueueClientRequestToAdd[], options?: RequestQueueClientBatchAddRequestWithRetriesOptions): Promise<RequestQueueClientBatchRequestsOperationResult>;
+    protected addRequestBatch(requests: SerializedRequestToAdd[], options?: RequestQueueClientAddRequestOptions): Promise<RequestQueueClientBatchRequestsOperationResult>;
+    protected addRequestBatchWithRetries(requests: SerializedRequestToAdd[], options?: RequestQueueClientBatchAddRequestWithRetriesOptions): Promise<RequestQueueClientBatchRequestsOperationResult>;
     /**
      * Adds multiple requests to the queue in a single operation.
      *
@@ -167,6 +186,7 @@ export declare class RequestQueueClient extends ResourceClient {
      * @param options.maxUnprocessedRequestsRetries - Maximum number of retry attempts for rate-limited requests. Default is 3.
      * @param options.maxParallel - Maximum number of parallel batch API calls. Default is 5.
      * @param options.minDelayBetweenUnprocessedRequestsRetriesMillis - Minimum delay before retrying rate-limited requests. Default is 500ms.
+     * @param options.timeoutSecs - Timeout for each batch API request. Default is `'medium'`.
      * @returns Object with `processedRequests` (successfully added) and `unprocessedRequests` (failed after all retries)
      * @see https://docs.apify.com/api/v2/request-queue-requests-batch-post
      *
@@ -197,24 +217,30 @@ export declare class RequestQueueClient extends ResourceClient {
      * Requests can be identified by either their ID or unique key.
      *
      * @param requests - Array of requests to delete (by id or uniqueKey)
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns Result containing processed and unprocessed requests
      * @see https://docs.apify.com/api/v2/request-queue-requests-batch-delete
      * @since Added in 2.3.0
      */
-    batchDeleteRequests(requests: RequestQueueClientRequestToDelete[]): Promise<RequestQueueClientBatchDeleteRequestsResult>;
+    batchDeleteRequests(requests: RequestQueueClientRequestToDelete[], options?: TimeoutOptions): Promise<RequestQueueClientBatchDeleteRequestsResult>;
     /**
      * Gets a specific request from the queue by its ID.
      *
      * @param id - Request ID
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The request object, or `undefined` if not found
      * @see https://docs.apify.com/api/v2/request-queue-request-get
      */
-    getRequest(id: string): Promise<RequestQueueClientGetRequestResult | undefined>;
+    getRequest(id: string, options?: TimeoutOptions): Promise<RequestQueueClientGetRequestResult | undefined>;
     /**
      * Updates a request in the queue.
      *
      * @param request - The updated request object (must include id)
      * @param options - Update options such as whether to move to front
+     * @param options.forefront - If `true`, moves the request to the beginning of the queue. Default is `false`.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`.
      * @returns Information about the updated request
      * @see https://docs.apify.com/api/v2/request-queue-request-put
      */
@@ -223,8 +249,10 @@ export declare class RequestQueueClient extends ResourceClient {
      * Deletes a specific request from the queue.
      *
      * @param id - Request ID
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      */
-    deleteRequest(id: string): Promise<void>;
+    deleteRequest(id: string, options?: TimeoutOptions): Promise<void>;
     /**
      * Prolongs the lock on a request to prevent it from being returned to other clients.
      *
@@ -236,6 +264,7 @@ export declare class RequestQueueClient extends ResourceClient {
      * @param options - Lock extension options
      * @param options.lockSecs - **Required.** New lock duration in seconds from now.
      * @param options.forefront - If `true`, moves the request to the beginning of the queue when the lock expires. Default is `false`.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`.
      * @returns Object with new `lockExpiresAt` timestamp
      * @see https://docs.apify.com/api/v2/request-queue-request-lock-put
      *
@@ -259,6 +288,8 @@ export declare class RequestQueueClient extends ResourceClient {
      *
      * @param id - Request ID
      * @param options - Options such as whether to move to front
+     * @param options.forefront - If `true`, moves the request to the beginning of the queue. Default is `false`.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @see https://docs.apify.com/api/v2/request-queue-request-lock-delete
      * @since Added in 2.4.1
      */
@@ -270,6 +301,7 @@ export declare class RequestQueueClient extends ResourceClient {
      * queue contents.
      *
      * @param options - Pagination options
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns List of requests with pagination information
      * @see https://docs.apify.com/api/v2/request-queue-requests-get
      * @since Added in 2.5.1
@@ -281,11 +313,13 @@ export declare class RequestQueueClient extends ResourceClient {
      * This is useful for releasing all locks at once, for example when shutting down
      * a crawler gracefully.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'long'`.
      * @returns Number of requests that were unlocked
      * @see https://docs.apify.com/api/v2/request-queue-requests-unlock-post
      * @since Added in 2.12.5
      */
-    unlockRequests(): Promise<RequestQueueClientUnlockRequestsResult>;
+    unlockRequests(options?: TimeoutOptions): Promise<RequestQueueClientUnlockRequestsResult>;
     /**
      * Returns an async iterable for paginating through all requests in the queue.
      *
@@ -293,6 +327,7 @@ export declare class RequestQueueClient extends ResourceClient {
      * automatically handling pagination behind the scenes.
      *
      * @param options - Pagination options
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns An async iterable of request pages
      * @see https://docs.apify.com/api/v2/request-queue-requests-get
      *
@@ -312,6 +347,8 @@ export declare class RequestQueueClient extends ResourceClient {
 export interface RequestQueueUserOptions {
     clientKey?: string;
     /**
+     * Cap, in seconds, on the default timeout tier of every request this client sends. An explicit per-call
+     * `timeoutSecs` is not capped.
      * @since Added in 2.2.0
      */
     timeoutSecs?: number;
@@ -333,7 +370,7 @@ export interface RequestQueueClientUpdateOptions {
 /**
  * Options for listing requests from the queue head.
  */
-export interface RequestQueueClientListHeadOptions {
+export interface RequestQueueClientListHeadOptions extends TimeoutOptions {
     limit?: number;
 }
 /**
@@ -344,13 +381,8 @@ export type RequestQueueListRequestsFilter = 'locked' | 'pending';
  * Options for listing all requests in the queue.
  * @since Added in 2.5.1
  */
-export interface RequestQueueClientListRequestsOptions {
+export interface RequestQueueClientListRequestsOptions extends TimeoutOptions {
     limit?: number;
-    /**
-     * Using id of request that does not exist in request queue leads to unpredictable results.
-     * @deprecated Use `cursor` for pagination instead.
-     */
-    exclusiveStartId?: string;
     /**
      * @since Added in 2.23.2
      */
@@ -364,11 +396,9 @@ export interface RequestQueueClientListRequestsOptions {
  * Options for paginating through requests in the queue.
  * @since Added in 2.5.1
  */
-export interface RequestQueueClientPaginateRequestsOptions {
+export interface RequestQueueClientPaginateRequestsOptions extends TimeoutOptions {
     limit?: number;
     maxPageLimit?: number;
-    /** @deprecated Use `cursor` for pagination instead. */
-    exclusiveStartId?: string;
     /**
      * @since Added in 2.23.2
      */
@@ -382,30 +412,30 @@ export interface RequestQueueClientPaginateRequestsOptions {
  * Options for listing and locking requests from the queue head.
  * @since Added in 2.4.1
  */
-export interface RequestQueueClientListAndLockHeadOptions {
+export interface RequestQueueClientListAndLockHeadOptions extends TimeoutOptions {
     lockSecs: number;
     limit?: number;
 }
-export interface RequestQueueClientAddRequestOptions {
+export interface RequestQueueClientAddRequestOptions extends TimeoutOptions {
     forefront?: boolean;
 }
 /**
  * @since Added in 2.4.1
  */
-export interface RequestQueueClientProlongRequestLockOptions {
+export interface RequestQueueClientProlongRequestLockOptions extends TimeoutOptions {
     forefront?: boolean;
     lockSecs: number;
 }
 /**
  * @since Added in 2.4.1
  */
-export interface RequestQueueClientDeleteRequestLockOptions {
+export interface RequestQueueClientDeleteRequestLockOptions extends TimeoutOptions {
     forefront?: boolean;
 }
 /**
  * @since Added in 2.3.0
  */
-export interface RequestQueueClientBatchAddRequestWithRetriesOptions {
+export interface RequestQueueClientBatchAddRequestWithRetriesOptions extends TimeoutOptions {
     forefront?: boolean;
     maxUnprocessedRequestsRetries?: number;
     maxParallel?: number;