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

package/dist/resource_clients/user.js

@@ -1,5 +1,7 @@
 import { ResourceClient } from '../base/resource_client.js';
-import { cast, catchNotFoundOrThrow, parseDateFields, pluckData } from '../utils.js';
+import * as schemas from '../schemas.js';
+import { timeoutOptionsSchema } from '../timeouts.js';
+import { parseArgument, parseResponse } from '../utils.js';
 export { PlatformFeature } from '../models.js';
 /**
  * Client for managing user account information.
@@ -41,71 +43,70 @@ export class UserClient extends ResourceClient {
      * Depending on whether ApifyClient was created with a token,
      * the method will either return public or private user data.
      *
-     * @returns The user object.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
+     * @returns The user object, or `undefined` if it does not exist.
      * @see https://docs.apify.com/api/v2/user-get
      */
-    async get() {
-        return this._get();
+    async get(options = {}) {
+        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.getResource(schemas.UserPrivateInfo(), {}, timeoutSecs);
     }
     /**
      * Retrieves the user's monthly usage data.
      *
-     * @returns The monthly usage object, or `undefined` if it does not exist.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
+     * @returns The monthly usage object.
      * @see https://docs.apify.com/api/v2/users-me-usage-monthly-get
      * @since Added in 2.9.2
      */
-    async monthlyUsage() {
-        const requestOpts = {
-            url: this._url('usage/monthly'),
+    async monthlyUsage(options = {}) {
+        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        const response = await this.httpClient.call({
+            url: this.buildUrl('usage/monthly'),
             method: 'GET',
-            params: this._params(),
-        };
-        try {
-            const response = await this.httpClient.call(requestOpts);
-            return cast(parseDateFields(pluckData(response.data), 
-            // Convert  monthlyUsage.dailyServiceUsages[].date to Date (by default it's ignored by parseDateFields)
-            /* shouldParseField = */ (key) => key === 'date'));
-        }
-        catch (err) {
-            catchNotFoundOrThrow(err);
-        }
-        return undefined;
+            params: this.buildParams(),
+            timeoutSecs,
+        });
+        return parseResponse(response, schemas.MonthlyUsage());
     }
     /**
      * Retrieves the user's account and usage limits.
      *
-     * @returns The account and usage limits object, or `undefined` if it does not exist.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
+     * @returns The account and usage limits object.
      * @see https://docs.apify.com/api/v2/users-me-limits-get
      * @since Added in 2.9.2
      */
-    async limits() {
-        const requestOpts = {
-            url: this._url('limits'),
+    async limits(options = {}) {
+        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        const response = await this.httpClient.call({
+            url: this.buildUrl('limits'),
             method: 'GET',
-            params: this._params(),
-        };
-        try {
-            const response = await this.httpClient.call(requestOpts);
-            return cast(parseDateFields(pluckData(response.data)));
-        }
-        catch (err) {
-            catchNotFoundOrThrow(err);
-        }
-        return undefined;
+            params: this.buildParams(),
+            timeoutSecs,
+        });
+        return parseResponse(response, schemas.AccountLimits());
     }
     /**
      * Updates the user's account and usage limits.
      *
-     * @param options - The new limits to set.
+     * @param newLimits - The new limits to set.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @see https://docs.apify.com/api/v2/users-me-limits-put
      * @since Added in 2.10.0
      */
-    async updateLimits(options) {
+    async updateLimits(newLimits, options = {}) {
+        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
         const requestOpts = {
-            url: this._url('limits'),
+            url: this.buildUrl('limits'),
             method: 'PUT',
-            params: this._params(),
-            data: options,
+            params: this.buildParams(),
+            data: newLimits,
+            timeoutSecs,
         };
         await this.httpClient.call(requestOpts);
     }

package/dist/resource_clients/webhook.d.ts

@@ -1,6 +1,7 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client.js';
 import { ResourceClient } from '../base/resource_client.js';
 import type { Webhook, WebhookEventType } from '../models.js';
+import type { TimeoutOptions } from '../timeouts.js';
 import type { WebhookDispatch } from './webhook_dispatch.js';
 import { WebhookDispatchCollectionClient } from './webhook_dispatch_collection.js';
 export type { Webhook, WebhookAnyRunOfActorCondition, WebhookAnyRunOfActorTaskCondition, WebhookCertainRunCondition, WebhookCondition, WebhookEventType, WebhookLastDispatch, WebhookStats, } from '../models.js';
@@ -40,31 +41,39 @@ export declare 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
      */
-    get(): Promise<Webhook | undefined>;
+    get(options?: TimeoutOptions): Promise<Webhook | undefined>;
     /**
      * 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
      */
-    update(newFields: WebhookUpdateData): Promise<Webhook>;
+    update(newFields: WebhookUpdateData, options?: TimeoutOptions): Promise<Webhook>;
     /**
      * 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
      */
-    delete(): Promise<void>;
+    delete(options?: TimeoutOptions): Promise<void>;
     /**
      * 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
      */
-    test(): Promise<WebhookDispatch | undefined>;
+    test(options?: TimeoutOptions): Promise<WebhookDispatch>;
     /**
      * Returns a client for the dispatches of this webhook.
      *

package/dist/resource_clients/webhook.js

@@ -1,5 +1,7 @@
 import { ResourceClient } from '../base/resource_client.js';
-import { anyObjectSchema, cast, catchNotFoundOrThrow, parseArgument, parseDateFields, pluckData } from '../utils.js';
+import * as schemas from '../schemas.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.
@@ -42,51 +44,57 @@ 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();
+    async get(options = {}) {
+        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.getResource(schemas.Webhook(), {}, timeoutSecs);
     }
     /**
      * 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(newFields);
+        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.updateResource(schemas.Webhook(), newFields, timeoutSecs);
     }
     /**
      * 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' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.deleteResource(timeoutSecs);
     }
     /**
      * 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' } = 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 cast(parseDateFields(pluckData(response.data)));
-        }
-        catch (err) {
-            catchNotFoundOrThrow(err);
-        }
-        return undefined;
+            params: this.buildParams(),
+            timeoutSecs,
+        });
+        return parseResponse(response, schemas.WebhookDispatch());
     }
     /**
      * Returns a client for the dispatches of this webhook.
@@ -95,7 +103,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,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 { Webhook, WebhookUpdateData } from './webhook.js';
 /**
@@ -47,6 +48,7 @@ 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
      */
@@ -55,11 +57,13 @@ export declare class WebhookCollectionClient extends ResourceCollectionClient {
      * 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<Webhook>;
 }
-export interface WebhookCollectionListOptions extends PaginationOptions {
+export interface WebhookCollectionListOptions extends PaginationOptions, TimeoutOptions {
     desc?: boolean;
 }

package/dist/resource_clients/webhook_collection.js

@@ -1,9 +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();
 /**
@@ -56,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(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(webhook);
+        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.createResource(schemas.Webhook(), webhook, timeoutSecs);
     }
 }

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,4 +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.
@@ -31,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();
+    async get(options = {}) {
+        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.getResource(schemas.WebhookDispatch(), {}, timeoutSecs);
     }
 }

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,9 +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.
@@ -50,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(parsed);
+        return this.listResourcesPaginated(schemas.ListOfWebhookDispatches(), parsed, 'medium');
     }
 }

package/dist/response_validation_error.d.ts

@@ -0,0 +1,26 @@
+import type { z } from 'zod';
+/**
+ * Thrown when an API response does not match the schema the client expects for it.
+ *
+ * The schemas are generated from the Apify OpenAPI specification, so this error means the API returned
+ * something the specification does not describe -- a missing required field, a different type, a value
+ * outside the documented range. Unknown fields and unknown enum values are not errors: the schemas let
+ * both through, so the client keeps working when the API grows.
+ *
+ * The `message` names the request and every offending field with the value it received, and ends by asking for
+ * a bug report: the mismatch is in the API or its specification, not in the caller's code. The structured
+ * {@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 {
+    /** Structured issues from the underlying schema check. */
+    readonly issues: z.ZodError['issues'];
+    /** HTTP method of the request whose response failed validation, upper-cased. */
+    readonly method: string;
+    /** URL of the request whose response failed validation, without its query string. */
+    readonly url: string;
+    constructor(error: z.ZodError, value: unknown, request: {
+        method: string;
+        url: string;
+    });
+}

package/dist/response_validation_error.js

@@ -0,0 +1,37 @@
+import { ArgumentValidationError } from '@apify/validations';
+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.';
+/**
+ * Thrown when an API response does not match the schema the client expects for it.
+ *
+ * The schemas are generated from the Apify OpenAPI specification, so this error means the API returned
+ * something the specification does not describe -- a missing required field, a different type, a value
+ * outside the documented range. Unknown fields and unknown enum values are not errors: the schemas let
+ * both through, so the client keeps working when the API grows.
+ *
+ * The `message` names the request and every offending field with the value it received, and ends by asking for
+ * a bug report: the mismatch is in the API or its specification, not in the caller's code. The structured
+ * {@link https://zod.dev | zod} issues are available on `issues`, and the original `ZodError` on `cause`,
+ * for programmatic inspection.
+ */
+export class ResponseValidationError extends Error {
+    /** Structured issues from the underlying schema check. */
+    issues;
+    /** HTTP method of the request whose response failed validation, upper-cased. */
+    method;
+    /** URL of the request whose response failed validation, without its query string. */
+    url;
+    constructor(error, value, request) {
+        const method = request.method.toUpperCase();
+        // `@apify/validations` keeps its zod error formatter private, so the issue lines come from the
+        // message of the error class it does export.
+        const details = new ArgumentValidationError(error, value).message;
+        super(`Response from ${method} ${request.url} does not match the API schema:\n${details}\n${REPORT_HINT}`, {
+            cause: error,
+        });
+        this.name = 'ResponseValidationError';
+        this.issues = error.issues;
+        this.method = method;
+        this.url = request.url;
+    }
+}

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,58 @@
+import os from 'node:os';
+import { promisify } from 'node:util';
+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) {
+        try {
+            // `promisify()` belongs inside the fallback chain: a partial `node:zlib` can export
+            // `brotliCompress` without implementing it, and `promisify(undefined)` throws. At module scope
+            // that would fail the whole import instead of falling through to gzip.
+            const options = { params: { [constants.BROTLI_PARAM_QUALITY]: 6 } };
+            return { data: await promisify(brotliCompress)(data, options), encoding: 'br' };
+        }
+        catch {
+            // Runtimes that only provide a partial `node:zlib` (Node.js compatibility shims) may not implement
+            // brotli, but usually do implement gzip.
+        }
+        try {
+            return { data: await promisify(gzip)(data), encoding: 'gzip' };
+        }
+        catch {
+            return undefined;
+        }
+    },
+    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 };
+    },
+};

package/dist/runtime/types.d.ts

@@ -0,0 +1,50 @@
+import type http from 'node:http';
+import type https from 'node:https';
+/**
+ * A request body compressed for transport, with the `content-encoding` value that declares it.
+ * @internal
+ */
+export interface CompressedValue {
+    data: Uint8Array;
+    encoding: 'br' | 'gzip';
+}
+/**
+ * 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`. The
+     * features that need a Node.js `Readable` response - log streaming and the `stream` record option - 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, or resolves to `undefined` where compression is not available. Compression
+     * is a best-effort optimization, so it never throws.
+     */
+    compress(data: Uint8Array): Promise<CompressedValue | undefined>;
+    /**
+     * 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>;
+}

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,17 @@
+/**
+ * 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 has 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.
+    async compress() {
+        return undefined;
+    },
+    // The XHR and fetch adapters of axios do not use agents.
+    async createHttpAgents() {
+        return undefined;
+    },
+};