apify-client 3.0.0-beta.8 → 3.0.0-beta.80

package/dist/resource_clients/webhook.js

@@ -1,6 +1,7 @@
 import { ResourceClient } from '../base/resource_client.js';
 import * as schemas from '../schemas.js';
-import { anyObjectSchema, catchNotFoundOrThrow, parseArgument, parseResponse } from '../utils.js';
+import { timeoutOptionsSchema } from '../timeouts.js';
+import { anyObjectSchema, parseArgument, parseResponse } from '../utils.js';
 import { WebhookDispatchCollectionClient } from './webhook_dispatch_collection.js';
 /**
  * Client for managing a specific webhook.
@@ -43,51 +44,58 @@ export class WebhookClient extends ResourceClient {
     /**
      * Retrieves the webhook.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The webhook object, or `undefined` if it does not exist.
      * @see https://docs.apify.com/api/v2/webhook-get
      */
-    async get() {
-        return this._get(schemas.Webhook());
+    async get(options = {}) {
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.getResource(schemas.WebhookResource(), {}, timeoutSecs, signal);
     }
     /**
      * Updates the webhook with the specified fields.
      *
      * @param newFields - Fields to update.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The updated webhook object.
      * @see https://docs.apify.com/api/v2/webhook-put
      */
-    async update(newFields) {
+    async update(newFields, options = {}) {
         parseArgument(newFields, anyObjectSchema);
-        return this._update(schemas.Webhook(), newFields);
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.updateResource(schemas.WebhookResource(), newFields, timeoutSecs, signal);
     }
     /**
      * Deletes the webhook.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @see https://docs.apify.com/api/v2/webhook-delete
      */
-    async delete() {
-        return this._delete();
+    async delete(options = {}) {
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.deleteResource(timeoutSecs, signal);
     }
     /**
      * Tests the webhook by dispatching a test event.
      *
-     * @returns The webhook dispatch object, or `undefined` if the test fails.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`.
+     * @returns The webhook dispatch object.
      * @see https://docs.apify.com/api/v2/webhook-test-post
      */
-    async test() {
-        const request = {
-            url: this._url('test'),
+    async test(options = {}) {
+        const { timeoutSecs = 'medium', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        const response = await this.httpClient.call({
+            url: this.buildUrl('test'),
             method: 'POST',
-            params: this._params(),
-        };
-        try {
-            const response = await this.httpClient.call(request);
-            return parseResponse(response, schemas.WebhookDispatch());
-        }
-        catch (err) {
-            catchNotFoundOrThrow(err);
-        }
-        return undefined;
+            params: this.buildParams(),
+            timeoutSecs,
+            signal,
+        });
+        return parseResponse(response, schemas.WebhookDispatch());
     }
     /**
      * Returns a client for the dispatches of this webhook.
@@ -96,7 +104,7 @@ export class WebhookClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/webhook-webhook-dispatches-get
      */
     dispatches() {
-        return new WebhookDispatchCollectionClient(this._subResourceOptions({
+        return new WebhookDispatchCollectionClient(this.subResourceOptions({
             resourcePath: 'dispatches',
         }));
     }

package/dist/resource_clients/webhook_collection.d.ts

@@ -1,7 +1,8 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client.js';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import type { TimeoutOptions } from '../timeouts.js';
 import type { PaginatedIterator, PaginationOptions } from '../utils.js';
-import type { Webhook, WebhookUpdateData } from './webhook.js';
+import type { WebhookResource, WebhookUpdateData } from './webhook.js';
 /**
  * Client for managing the collection of Webhooks.
  *
@@ -47,19 +48,22 @@ export declare class WebhookCollectionClient extends ResourceCollectionClient {
      * ```
      *
      * @param options - Pagination and sorting options.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns A paginated iterator of webhooks.
      * @see https://docs.apify.com/api/v2/webhooks-get
      */
-    list(options?: WebhookCollectionListOptions): PaginatedIterator<Omit<Webhook, 'payloadTemplate' | 'headersTemplate'>>;
+    list(options?: WebhookCollectionListOptions): PaginatedIterator<Omit<WebhookResource, 'payloadTemplate' | 'headersTemplate'>>;
     /**
      * Creates a new webhook.
      *
      * @param webhook - The webhook data.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The created webhook object.
      * @see https://docs.apify.com/api/v2/webhooks-post
      */
-    create(webhook?: WebhookUpdateData): Promise<Webhook>;
+    create(webhook?: WebhookUpdateData, options?: TimeoutOptions): Promise<WebhookResource>;
 }
-export interface WebhookCollectionListOptions extends PaginationOptions {
+export interface WebhookCollectionListOptions extends PaginationOptions, TimeoutOptions {
     desc?: boolean;
 }

package/dist/resource_clients/webhook_collection.js

@@ -1,10 +1,12 @@
 import { z } from 'zod';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
 import * as schemas from '../schemas.js';
+import { timeoutOptionsSchema, timeoutOptionsShape } from '../timeouts.js';
 import { anyObjectSchema, paginationOptionsShape, parseArgument } from '../utils.js';
 const listOptionsSchema = z.strictObject({
     ...paginationOptionsShape,
     desc: z.boolean().optional(),
+    ...timeoutOptionsShape,
 });
 const webhookCreateSchema = anyObjectSchema.optional();
 /**
@@ -57,22 +59,26 @@ export class WebhookCollectionClient extends ResourceCollectionClient {
      * ```
      *
      * @param options - Pagination and sorting options.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns A paginated iterator of webhooks.
      * @see https://docs.apify.com/api/v2/webhooks-get
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'WebhookCollectionListOptions');
-        return this._listPaginated(schemas.ListOfWebhooks(), parsed);
+        return this.listResourcesPaginated(schemas.ListOfWebhooks(), parsed, 'medium');
     }
     /**
      * Creates a new webhook.
      *
      * @param webhook - The webhook data.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The created webhook object.
      * @see https://docs.apify.com/api/v2/webhooks-post
      */
-    async create(webhook) {
+    async create(webhook, options = {}) {
         parseArgument(webhook, webhookCreateSchema);
-        return this._create(schemas.Webhook(), webhook);
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.createResource(schemas.WebhookResource(), webhook, timeoutSecs, signal);
     }
 }

package/dist/resource_clients/webhook_dispatch.d.ts

@@ -1,6 +1,7 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client.js';
 import { ResourceClient } from '../base/resource_client.js';
 import type { WebhookDispatch } from '../models.js';
+import type { TimeoutOptions } from '../timeouts.js';
 export type { WebhookDispatch, WebhookDispatchCall, WebhookDispatchEventData, WebhookDispatchWebhookSummary, } from '../models.js';
 export { WebhookDispatchStatus } from '../models.js';
 /**
@@ -29,8 +30,10 @@ export declare class WebhookDispatchClient extends ResourceClient {
     /**
      * Retrieves the webhook dispatch.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The webhook dispatch object, or `undefined` if it does not exist.
      * @see https://docs.apify.com/api/v2/webhook-dispatch-get
      */
-    get(): Promise<WebhookDispatch | undefined>;
+    get(options?: TimeoutOptions): Promise<WebhookDispatch | undefined>;
 }

package/dist/resource_clients/webhook_dispatch.js

@@ -1,5 +1,7 @@
 import { ResourceClient } from '../base/resource_client.js';
 import * as schemas from '../schemas.js';
+import { timeoutOptionsSchema } from '../timeouts.js';
+import { parseArgument } from '../utils.js';
 export { WebhookDispatchStatus } from '../models.js';
 /**
  * Client for managing a specific webhook dispatch.
@@ -32,10 +34,13 @@ export class WebhookDispatchClient extends ResourceClient {
     /**
      * Retrieves the webhook dispatch.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The webhook dispatch object, or `undefined` if it does not exist.
      * @see https://docs.apify.com/api/v2/webhook-dispatch-get
      */
-    async get() {
-        return this._get(schemas.WebhookDispatch());
+    async get(options = {}) {
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.getResource(schemas.WebhookDispatch(), {}, timeoutSecs, signal);
     }
 }

package/dist/resource_clients/webhook_dispatch_collection.d.ts

@@ -1,5 +1,6 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client.js';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import type { TimeoutOptions } from '../timeouts.js';
 import type { PaginatedIterator, PaginationOptions } from '../utils.js';
 import type { WebhookDispatch } from './webhook_dispatch.js';
 /**
@@ -42,11 +43,12 @@ export declare class WebhookDispatchCollectionClient extends ResourceCollectionC
      * ```
      *
      * @param options - Pagination and sorting options.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns A paginated iterator of webhook dispatches.
      * @see https://docs.apify.com/api/v2/webhook-dispatches-get
      */
     list(options?: WebhookDispatchCollectionListOptions): PaginatedIterator<WebhookDispatch>;
 }
-export interface WebhookDispatchCollectionListOptions extends PaginationOptions {
+export interface WebhookDispatchCollectionListOptions extends PaginationOptions, TimeoutOptions {
     desc?: boolean;
 }

package/dist/resource_clients/webhook_dispatch_collection.js

@@ -1,10 +1,12 @@
 import { z } from 'zod';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
 import * as schemas from '../schemas.js';
+import { timeoutOptionsShape } from '../timeouts.js';
 import { paginationOptionsShape, parseArgument } from '../utils.js';
 const listOptionsSchema = z.strictObject({
     ...paginationOptionsShape,
     desc: z.boolean().optional(),
+    ...timeoutOptionsShape,
 });
 /**
  * Client for managing the collection of webhook dispatches.
@@ -51,11 +53,12 @@ export class WebhookDispatchCollectionClient extends ResourceCollectionClient {
      * ```
      *
      * @param options - Pagination and sorting options.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns A paginated iterator of webhook dispatches.
      * @see https://docs.apify.com/api/v2/webhook-dispatches-get
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'WebhookDispatchCollectionListOptions');
-        return this._listPaginated(schemas.ListOfWebhookDispatches(), parsed);
+        return this.listResourcesPaginated(schemas.ListOfWebhookDispatches(), parsed, 'medium');
     }
 }

package/dist/response_validation_error.d.ts

@@ -1,4 +1,5 @@
 import type { z } from 'zod';
+import { ApifyClientError } from './apify_client_error.js';
 /**
  * Thrown when an API response does not match the schema the client expects for it.
  *
@@ -12,7 +13,7 @@ import type { z } from 'zod';
  * {@link https://zod.dev | zod} issues are available on `issues`, and the original `ZodError` on `cause`,
  * for programmatic inspection.
  */
-export declare class ResponseValidationError extends Error {
+export declare class ResponseValidationError extends ApifyClientError {
     /** Structured issues from the underlying schema check. */
     readonly issues: z.ZodError['issues'];
     /** HTTP method of the request whose response failed validation, upper-cased. */

package/dist/response_validation_error.js

@@ -1,4 +1,5 @@
 import { ArgumentValidationError } from '@apify/validations';
+import { ApifyClientError } from './apify_client_error.js';
 const REPORT_HINT = 'The API returned something its OpenAPI specification does not describe. ' +
     'Please report this at https://github.com/apify/apify-client-js/issues.';
 /**
@@ -14,7 +15,7 @@ const REPORT_HINT = 'The API returned something its OpenAPI specification does n
  * {@link https://zod.dev | zod} issues are available on `issues`, and the original `ZodError` on `cause`,
  * for programmatic inspection.
  */
-export class ResponseValidationError extends Error {
+export class ResponseValidationError extends ApifyClientError {
     /** Structured issues from the underlying schema check. */
     issues;
     /** HTTP method of the request whose response failed validation, upper-cased. */

package/dist/runtime/node.d.ts

@@ -0,0 +1,6 @@
+import type { Runtime } from './types.js';
+/**
+ * The Node.js implementation of {@link Runtime}. Deno and Bun resolve the `node` condition too and
+ * provide the built-ins it uses.
+ */
+export declare const runtime: Runtime;

package/dist/runtime/node.js

@@ -0,0 +1,80 @@
+import os from 'node:os';
+import { Readable } from 'node:stream';
+import { brotliCompress, constants, gzip } from 'node:zlib';
+/**
+ * The Node.js implementation of {@link Runtime}. Deno and Bun resolve the `node` condition too and
+ * provide the built-ins it uses.
+ */
+export const runtime = {
+    isNode: true,
+    platform: `${os.platform()}; Node/${process.version}`,
+    async compress(data, { algorithm, quality }) {
+        return new Promise((resolve, reject) => {
+            const done = (error, result) => (error ? reject(error) : resolve(result));
+            if (algorithm === 'br') {
+                brotliCompress(data, { params: { [constants.BROTLI_PARAM_QUALITY]: quality } }, done);
+            }
+            else {
+                gzip(data, { level: quality }, done);
+            }
+        });
+    },
+    async createHttpAgents({ timeoutMillis }) {
+        // Loaded on the first request rather than with the client: the proxy support pulls in a sizeable
+        // dependency tree that a client which never sends a request should not pay for.
+        const { ProxyAgent } = await import('proxy-agent');
+        // We want to keep sockets alive for better performance.
+        const agentOptions = {
+            keepAlive: true,
+            // Timeout for inactive sockets
+            // Prevents socket leaks from idle connections
+            timeout: timeoutMillis,
+            // Keep alive timeout for free sockets (15 seconds)
+            // Node.js will close unused sockets after this period
+            keepAliveMsecs: 15_000,
+            // Maximum number of sockets per host
+            maxSockets: 256,
+            maxFreeSockets: 256,
+            // LIFO scheduling - reuse most recently used sockets for better performance
+            scheduling: 'lifo',
+        };
+        // ProxyAgent picks the proxy up from the environment variables and supports CONNECT tunneling.
+        const agent = new ProxyAgent(agentOptions);
+        // Disable Nagle's algorithm for lower latency
+        // This sends data immediately instead of buffering small packets
+        agent.on('socket', (socket) => {
+            socket.setNoDelay(true);
+        });
+        return { httpAgent: agent, httpsAgent: agent };
+    },
+    openBlobBody(blob, onSourceError) {
+        return Readable.from(readBlob(blob, onSourceError), { objectMode: false });
+    },
+};
+/**
+ * Yields the bytes of a blob. Ending the iteration early, which destroying the `Readable` around it does, cancels
+ * the read and releases a file the blob reads from. Only a failing read is reported: an error the `Readable` is
+ * destroyed with is thrown in at the `yield` and belongs to the transport. A `for await` loop would surface both at
+ * the same place, so the loop calls `next()` itself to catch only the read.
+ */
+async function* readBlob(blob, onSourceError) {
+    const chunks = blob.stream()[Symbol.asyncIterator]();
+    try {
+        while (true) {
+            let chunk;
+            try {
+                chunk = await chunks.next();
+            }
+            catch (error) {
+                onSourceError(error);
+                throw error;
+            }
+            if (chunk.done)
+                return;
+            yield chunk.value;
+        }
+    }
+    finally {
+        await chunks.return?.();
+    }
+}

package/dist/runtime/types.d.ts

@@ -0,0 +1,60 @@
+import type http from 'node:http';
+import type https from 'node:https';
+import type { Readable } from 'node:stream';
+/**
+ * What to compress a request body with, as the built-in `HttpCompressor` implementations ask for it.
+ * @internal
+ */
+export interface CompressionOptions {
+    /** Algorithm to compress with, named by the `Content-Encoding` value it produces. */
+    algorithm: 'br' | 'gzip';
+    /** Compression level, in the range the algorithm defines. */
+    quality: number;
+}
+/**
+ * The agents axios's Node.js adapter sends requests through.
+ * @internal
+ */
+export interface HttpAgents {
+    httpAgent: http.Agent;
+    httpsAgent: https.Agent;
+}
+/**
+ * The runtime-specific part of the client. `#runtime` resolves to the Node.js implementation under the `node`
+ * condition and to the Web API one everywhere else (see the `imports` field of `package.json`), so a bundler
+ * targeting a browser or an edge runtime never sees the Node.js built-ins the Node.js one uses.
+ * @internal
+ */
+export interface Runtime {
+    /**
+     * Whether the Node.js implementation was selected, which the `node` condition settles when `#runtime` is
+     * resolved - so a Node.js application bundled for a browser or a neutral target reports `false`. Log
+     * streaming, the `stream` record option and request body compression are gated on it.
+     */
+    isNode: boolean;
+    /**
+     * The platform part of the `User-Agent` header, or `undefined` where the runtime does not let a client
+     * set that header (browsers).
+     */
+    platform: string | undefined;
+    /**
+     * Compresses a request body. The built-in compressors go through it, so a bundle for a browser or an edge
+     * runtime carries no `node:zlib`. Throws where the runtime has no compression, which the client never
+     * reaches, since it compresses only where {@link isNode} holds.
+     */
+    compress(data: Uint8Array, options: CompressionOptions): Promise<Buffer>;
+    /**
+     * Creates the agents axios's Node.js adapter sends requests through, or resolves to `undefined` where
+     * axios does not use agents.
+     */
+    createHttpAgents(options: {
+        timeoutMillis: number;
+    }): Promise<HttpAgents | undefined>;
+    /**
+     * Opens a `Blob` request body for one attempt. The Node.js implementation reads the blob into a `Readable` and
+     * reports an error the blob raises while it is read to `onSourceError` before the stream fails with it, so the
+     * pipeline can tell a failing source apart from a failing connection. The Web API one returns the blob itself,
+     * which `fetch` and `XMLHttpRequest` read on their own, and never calls `onSourceError`.
+     */
+    openBlobBody(blob: Blob, onSourceError: (error: unknown) => void): Readable | Blob;
+}

package/dist/runtime/types.js

@@ -0,0 +1 @@
+export {};

package/dist/runtime/web.d.ts

@@ -0,0 +1,5 @@
+import type { Runtime } from './types.js';
+/**
+ * The {@link Runtime} for browsers and edge runtimes, built on Web APIs only.
+ */
+export declare const runtime: Runtime;

package/dist/runtime/web.js

@@ -0,0 +1,21 @@
+/**
+ * The {@link Runtime} for browsers and edge runtimes, built on Web APIs only.
+ */
+export const runtime = {
+    isNode: false,
+    // Browsers do not let a page set the `User-Agent` header.
+    platform: undefined,
+    // No request compression: brotli and gzip have no Web API, and a `content-encoding` request header is not
+    // on the list of headers the Apify API allows in a cross-origin request, so a browser would fail the
+    // preflight. The client compresses in Node.js alone, so nothing reaches this.
+    async compress() {
+        throw new Error('Request body compression is only available in Node.js.');
+    },
+    // The XHR and fetch adapters of axios do not use agents.
+    async createHttpAgents() {
+        return undefined;
+    },
+    openBlobBody(blob) {
+        return blob;
+    },
+};