apify-client 3.0.0-beta.27 → 3.0.0-beta.29

package/dist/resource_clients/user.js

@@ -49,8 +49,8 @@ export class UserClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/user-get
      */
     async get(options = {}) {
-        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
-        return this.getResource(schemas.UserPrivateInfo(), {}, timeoutSecs);
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.getResource(schemas.UserPrivateInfo(), {}, timeoutSecs, signal);
     }
     /**
      * Retrieves the user's monthly usage data.
@@ -62,12 +62,13 @@ export class UserClient extends ResourceClient {
      * @since Added in 2.9.2
      */
     async monthlyUsage(options = {}) {
-        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
         const response = await this.httpClient.call({
             url: this.buildUrl('usage/monthly'),
             method: 'GET',
             params: this.buildParams(),
             timeoutSecs,
+            signal,
         });
         return parseResponse(response, schemas.MonthlyUsage());
     }
@@ -81,12 +82,13 @@ export class UserClient extends ResourceClient {
      * @since Added in 2.9.2
      */
     async limits(options = {}) {
-        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
         const response = await this.httpClient.call({
             url: this.buildUrl('limits'),
             method: 'GET',
             params: this.buildParams(),
             timeoutSecs,
+            signal,
         });
         return parseResponse(response, schemas.AccountLimits());
     }
@@ -100,13 +102,14 @@ export class UserClient extends ResourceClient {
      * @since Added in 2.10.0
      */
     async updateLimits(newLimits, options = {}) {
-        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
         const requestOpts = {
             url: this.buildUrl('limits'),
             method: 'PUT',
             params: this.buildParams(),
             data: newLimits,
             timeoutSecs,
+            signal,
         };
         await this.httpClient.call(requestOpts);
     }

package/dist/resource_clients/webhook.js

@@ -50,8 +50,8 @@ export class WebhookClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/webhook-get
      */
     async get(options = {}) {
-        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
-        return this.getResource(schemas.Webhook(), {}, timeoutSecs);
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.getResource(schemas.Webhook(), {}, timeoutSecs, signal);
     }
     /**
      * Updates the webhook with the specified fields.
@@ -64,8 +64,8 @@ export class WebhookClient extends ResourceClient {
      */
     async update(newFields, options = {}) {
         parseArgument(newFields, anyObjectSchema);
-        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
-        return this.updateResource(schemas.Webhook(), newFields, timeoutSecs);
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.updateResource(schemas.Webhook(), newFields, timeoutSecs, signal);
     }
     /**
      * Deletes the webhook.
@@ -75,8 +75,8 @@ export class WebhookClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/webhook-delete
      */
     async delete(options = {}) {
-        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
-        return this.deleteResource(timeoutSecs);
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.deleteResource(timeoutSecs, signal);
     }
     /**
      * Tests the webhook by dispatching a test event.
@@ -87,12 +87,13 @@ export class WebhookClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/webhook-test-post
      */
     async test(options = {}) {
-        const { timeoutSecs = 'medium' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        const { timeoutSecs = 'medium', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
         const response = await this.httpClient.call({
             url: this.buildUrl('test'),
             method: 'POST',
             params: this.buildParams(),
             timeoutSecs,
+            signal,
         });
         return parseResponse(response, schemas.WebhookDispatch());
     }

package/dist/resource_clients/webhook_collection.js

@@ -78,7 +78,7 @@ export class WebhookCollectionClient extends ResourceCollectionClient {
      */
     async create(webhook, options = {}) {
         parseArgument(webhook, webhookCreateSchema);
-        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
-        return this.createResource(schemas.Webhook(), webhook, timeoutSecs);
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.createResource(schemas.Webhook(), webhook, timeoutSecs, signal);
     }
 }

package/dist/resource_clients/webhook_dispatch.js

@@ -40,7 +40,7 @@ export class WebhookDispatchClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/webhook-dispatch-get
      */
     async get(options = {}) {
-        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
-        return this.getResource(schemas.WebhookDispatch(), {}, timeoutSecs);
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.getResource(schemas.WebhookDispatch(), {}, timeoutSecs, signal);
     }
 }

package/dist/timeouts.d.ts

@@ -34,6 +34,11 @@ export interface TimeoutOptions {
      * `'noTimeout'`. Defaults to the tier the method is assigned, which its documentation names.
      */
     timeoutSecs?: Timeout;
+    /**
+     * Aborts the method. Once the signal aborts, the request in flight is ended, no retry or further poll
+     * follows, and the method rejects with the signal's `reason`.
+     */
+    signal?: AbortSignal;
 }
 /**
  * Schema of {@link Timeout}, optional, for the methods that validate `timeoutSecs` on its own.
@@ -45,6 +50,11 @@ export declare const optionalTimeoutSchema: z.ZodOptional<z.ZodUnion<readonly [z
     noTimeout: "noTimeout";
     short: "short";
 }>, z.ZodNumber]>>;
+/**
+ * Schema of {@link TimeoutOptions.signal}, for the methods that validate `signal` on its own.
+ * @internal
+ */
+export declare const optionalSignalSchema: z.ZodOptional<z.ZodInstanceOf<AbortSignal>>;
 /**
  * Schema shape of {@link TimeoutOptions}, to spread into the option schema of every method that sends a
  * request. One copy stops it drifting from the interface.
@@ -57,6 +67,7 @@ export declare const timeoutOptionsShape: {
         noTimeout: "noTimeout";
         short: "short";
     }>, z.ZodNumber]>>;
+    signal: z.ZodOptional<z.ZodInstanceOf<AbortSignal>>;
 };
 /**
  * Schema of {@link TimeoutOptions}, for the methods that take no other option.
@@ -69,4 +80,5 @@ export declare const timeoutOptionsSchema: z.ZodObject<{
         noTimeout: "noTimeout";
         short: "short";
     }>, z.ZodNumber]>>;
+    signal: z.ZodOptional<z.ZodInstanceOf<AbortSignal>>;
 }, z.core.$strict>;

package/dist/timeouts.js

@@ -16,6 +16,11 @@ const timeoutSchema = z.union([z.enum(['short', 'medium', 'long', 'noTimeout']),
  * @internal
  */
 export const optionalTimeoutSchema = timeoutSchema.optional();
+/**
+ * Schema of {@link TimeoutOptions.signal}, for the methods that validate `signal` on its own.
+ * @internal
+ */
+export const optionalSignalSchema = z.instanceof(AbortSignal).optional();
 /**
  * Schema shape of {@link TimeoutOptions}, to spread into the option schema of every method that sends a
  * request. One copy stops it drifting from the interface.
@@ -23,6 +28,7 @@ export const optionalTimeoutSchema = timeoutSchema.optional();
  */
 export const timeoutOptionsShape = {
     timeoutSecs: optionalTimeoutSchema,
+    signal: optionalSignalSchema,
 };
 /**
  * Schema of {@link TimeoutOptions}, for the methods that take no other option.

package/dist/utils.d.ts

@@ -238,3 +238,8 @@ export declare function toPathSegment(value: string): string;
  * `requests/batch` keep their separators; an array has each of its segments encoded individually.
  */
 export declare function toPath(path: string | string[]): string;
+/**
+ * Resolves after `millis`, or right away once `signal` aborts.
+ * @internal
+ */
+export declare function sleep(millis: number, signal?: AbortSignal): Promise<void>;

package/dist/utils.js

@@ -355,3 +355,24 @@ export function toPathSegment(value) {
 export function toPath(path) {
     return Array.isArray(path) ? path.map(toPathSegment).join('/') : path;
 }
+/**
+ * Resolves after `millis`, or right away once `signal` aborts.
+ * @internal
+ */
+export async function sleep(millis, signal) {
+    return new Promise((resolve) => {
+        if (signal?.aborted) {
+            resolve();
+            return;
+        }
+        const onAbort = () => {
+            clearTimeout(timer);
+            resolve();
+        };
+        const timer = setTimeout(() => {
+            signal?.removeEventListener('abort', onAbort);
+            resolve();
+        }, millis);
+        signal?.addEventListener('abort', onAbort, { once: true });
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-client",
-  "version": "3.0.0-beta.27",
+  "version": "3.0.0-beta.29",
   "description": "Apify API client for JavaScript",
   "engines": {
     "node": ">=22.0.0"
@@ -107,7 +107,7 @@
   "devEngines": {
     "packageManager": {
       "name": "pnpm",
-      "version": "10.33.4",
+      "version": "12.6.0",
       "onFail": "warn"
     }
   },