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

package/dist/apify_client.d.ts

@@ -401,7 +401,10 @@ export declare class ApifyClient {
  * Configuration options for ApifyClient.
  */
 export interface ApifyClientOptions {
-    /** @default https://api.apify.com */
+    /**
+     * URL of the Apify API, with or without the `/v2` version path, which is appended when missing.
+     * @default https://api.apify.com
+     */
     baseUrl?: string;
     /**
      * Compression of request bodies: the name of a built-in algorithm, or an {@link HttpCompressor} for a custom
@@ -416,6 +419,8 @@ export interface ApifyClientOptions {
      */
     headers?: Record<string, string>;
     /**
+     * Publicly accessible URL of the Apify API, used in the URLs the client generates. Like `baseUrl`, with or
+     * without the `/v2` version path.
      * @default https://api.apify.com
      * @since Added in 2.17.0
      */
@@ -456,9 +461,16 @@ export interface ApifyClientOptions {
  * on the HTTP client itself.
  */
 export interface ApifyClientCustomHttpClientOptions {
-    /** @default https://api.apify.com */
+    /**
+     * URL of the Apify API, with or without the `/v2` version path, which is appended when missing.
+     * @default https://api.apify.com
+     */
     baseUrl?: string;
-    /** @default https://api.apify.com */
+    /**
+     * Publicly accessible URL of the Apify API, used in the URLs the client generates. Like `baseUrl`, with or
+     * without the `/v2` version path.
+     * @default https://api.apify.com
+     */
     publicBaseUrl?: string;
     /** Set as the HTTP client's `Authorization` header, unless it already has one. */
     token?: string;

package/dist/apify_client.js

@@ -31,6 +31,13 @@ import { Statistics } from './statistics.js';
 import { DEFAULT_TIMEOUT_LONG_SECS, DEFAULT_TIMEOUT_MAX_SECS, DEFAULT_TIMEOUT_MEDIUM_SECS, DEFAULT_TIMEOUT_SHORT_SECS, } from './timeouts.js';
 import { getEnv, parseArgument } from './utils.js';
 const DEFAULT_API_URL = 'https://api.apify.com';
+const API_VERSION_PATH = '/v2';
+function toApiBaseUrl(url) {
+    const parsed = new URL(url);
+    const path = parsed.pathname.replace(/\/+$/, '');
+    parsed.pathname = path.endsWith(API_VERSION_PATH) ? path : `${path}${API_VERSION_PATH}`;
+    return parsed.href;
+}
 const clientOptionsSchema = z.strictObject({
     baseUrl: z.string().default(DEFAULT_API_URL),
     compression: compressionSchema.default('brotli'),
@@ -105,12 +112,8 @@ export class ApifyClient {
     constructor(options = {}) {
         const parsed = parseArgument(options, clientOptionsSchema, 'ApifyClientOptions');
         const { baseUrl, compression, headers, publicBaseUrl, maxRetries, minDelayBetweenRetriesMillis, timeoutShortSecs, timeoutMediumSecs, timeoutLongSecs, timeoutMaxSecs, token, } = parsed;
-        const tempBaseUrl = baseUrl.endsWith('/') ? baseUrl.slice(0, baseUrl.length - 1) : baseUrl;
-        this.baseUrl = `${tempBaseUrl}/v2`;
-        const tempPublicBaseUrl = publicBaseUrl.endsWith('/')
-            ? publicBaseUrl.slice(0, publicBaseUrl.length - 1)
-            : publicBaseUrl;
-        this.publicBaseUrl = `${tempPublicBaseUrl}/v2`;
+        this.baseUrl = toApiBaseUrl(baseUrl);
+        this.publicBaseUrl = toApiBaseUrl(publicBaseUrl);
         this.token = token;
         this.stats = new Statistics();
         this.logger = logger.child({ prefix: 'ApifyClient' });

package/dist/base/api_client.js

@@ -67,8 +67,8 @@ export class ApiClient {
             return Math.min(a, b);
         };
         // `chunkSize` only sizes this loop's requests; it is not an API parameter, so it must not reach
-        // `buildParams()` and the query string. The same goes for `timeoutSecs`, which callers take out before
-        // calling this, since it also picks the timeout of every page request.
+        // `buildParams()` and the query string. The same goes for `timeoutSecs` and `signal`, which callers take out
+        // before calling this, since they also apply to every page request.
         const { chunkSize, ...listOptions } = options;
         const paginatedListPromise = getPaginatedList({
             ...listOptions,

package/dist/base/resource_client.d.ts

@@ -18,13 +18,13 @@ export declare class ResourceClient extends ApiClient {
      * A 404 resolves to `undefined` only when the client names its resource by ID. A chained client without one, such
      * as `run.dataset()`, throws it instead (see `catchNotFoundForResourceOrThrow()`).
      */
-    protected getResource<T, R>(schema: z.ZodType, options: T, timeoutSecs: Timeout): Promise<R | undefined>;
-    protected updateResource<T, R>(schema: z.ZodType, newFields: T, timeoutSecs: Timeout): Promise<R>;
+    protected getResource<T, R>(schema: z.ZodType, options: T, timeoutSecs: Timeout, signal?: AbortSignal): Promise<R | undefined>;
+    protected updateResource<T, R>(schema: z.ZodType, newFields: T, timeoutSecs: Timeout, signal?: AbortSignal): Promise<R>;
     /**
      * A 404 is swallowed, keeping the DELETE idempotent, only when the client names its resource by ID. A chained client
      * without one throws it instead (see `catchNotFoundForResourceOrThrow()`).
      */
-    protected deleteResource(timeoutSecs: Timeout): Promise<void>;
+    protected deleteResource(timeoutSecs: Timeout, signal?: AbortSignal): Promise<void>;
     /**
      * This function is used in Build and Run endpoints so it's kept
      * here to stay DRY.

package/dist/base/resource_client.js

@@ -1,5 +1,5 @@
 import { ACT_JOB_TERMINAL_STATUSES } from '@apify/consts';
-import { catchNotFoundForResourceOrThrow, catchNotFoundOrThrow, parseResponse } from '../utils.js';
+import { catchNotFoundForResourceOrThrow, catchNotFoundOrThrow, parseResponse, sleep } from '../utils.js';
 import { ApiClient } from './api_client.js';
 /**
  * We need to supply some number for the API,
@@ -34,12 +34,13 @@ export class ResourceClient extends ApiClient {
      * A 404 resolves to `undefined` only when the client names its resource by ID. A chained client without one, such
      * as `run.dataset()`, throws it instead (see `catchNotFoundForResourceOrThrow()`).
      */
-    async getResource(schema, options, timeoutSecs) {
+    async getResource(schema, options, timeoutSecs, signal) {
         const requestOpts = {
             url: this.buildUrl(),
             method: 'GET',
             params: this.buildParams(options),
             timeoutSecs,
+            signal,
         };
         try {
             const response = await this.httpClient.call(requestOpts);
@@ -50,13 +51,14 @@ export class ResourceClient extends ApiClient {
         }
         return undefined;
     }
-    async updateResource(schema, newFields, timeoutSecs) {
+    async updateResource(schema, newFields, timeoutSecs, signal) {
         const response = await this.httpClient.call({
             url: this.buildUrl(),
             method: 'PUT',
             params: this.buildParams(),
             data: newFields,
             timeoutSecs,
+            signal,
         });
         return parseResponse(response, schema);
     }
@@ -64,13 +66,14 @@ export class ResourceClient extends ApiClient {
      * A 404 is swallowed, keeping the DELETE idempotent, only when the client names its resource by ID. A chained client
      * without one throws it instead (see `catchNotFoundForResourceOrThrow()`).
      */
-    async deleteResource(timeoutSecs) {
+    async deleteResource(timeoutSecs, signal) {
         try {
             await this.httpClient.call({
                 url: this.buildUrl(),
                 method: 'DELETE',
                 params: this.buildParams(),
                 timeoutSecs,
+                signal,
             });
         }
         catch (err) {
@@ -82,7 +85,7 @@ export class ResourceClient extends ApiClient {
      * here to stay DRY.
      */
     async waitForJobFinish(schema, options = {}) {
-        const { waitSecs = MAX_WAIT_FOR_FINISH, timeoutSecs = 'noTimeout' } = options;
+        const { waitSecs = MAX_WAIT_FOR_FINISH, timeoutSecs = 'noTimeout', signal } = options;
         const waitMillis = waitSecs * 1000;
         let job;
         const startedAt = Date.now();
@@ -102,6 +105,7 @@ export class ResourceClient extends ApiClient {
                 method: 'GET',
                 params: this.buildParams({ waitForFinish }),
                 timeoutSecs,
+                signal,
             };
             try {
                 const response = await this.httpClient.call(requestOpts);
@@ -113,10 +117,10 @@ export class ResourceClient extends ApiClient {
             }
             // It might take some time for database replicas to get up-to-date,
             // so getRun() might return null. Wait a little bit and try it again.
-            if (!job)
-                await new Promise((resolve) => {
-                    setTimeout(resolve, 250);
-                });
+            if (!job) {
+                await sleep(250, signal);
+                signal?.throwIfAborted();
+            }
         } while (shouldRepeat());
         if (!job) {
             const constructorName = this.constructor.name;

package/dist/base/resource_collection_client.d.ts

@@ -10,12 +10,13 @@ export declare class ResourceCollectionClient extends ApiClient {
     /**
      * @private
      */
-    protected listResources<T, R>(schema: z.ZodType, options: T | undefined, timeoutSecs: Timeout): Promise<R>;
+    protected listResources<T, R>(schema: z.ZodType, options: T | undefined, timeoutSecs: Timeout, signal?: AbortSignal): Promise<R>;
     /**
      * Returns async iterator to iterate through all items and Promise that can be awaited to get first page of results.
-     * `defaultTimeoutSecs` applies to every page request unless `options.timeoutSecs` overrides it.
+     * `defaultTimeoutSecs` applies to every page request unless `options.timeoutSecs` overrides it, and
+     * `options.signal` goes to every page request.
      */
     protected listResourcesPaginated<T extends PaginationOptions & TimeoutOptions, Data, R extends PaginatedResponse<Data>>(schema: z.ZodType, options: T, defaultTimeoutSecs: Timeout): AsyncIterable<Data> & Promise<R>;
-    protected createResource<D, R>(schema: z.ZodType, resource: D, timeoutSecs: Timeout): Promise<R>;
-    protected getOrCreateResource<D, R>(schema: z.ZodType, name: string | undefined, resource: D | undefined, timeoutSecs: Timeout): Promise<R>;
+    protected createResource<D, R>(schema: z.ZodType, resource: D, timeoutSecs: Timeout, signal?: AbortSignal): Promise<R>;
+    protected getOrCreateResource<D, R>(schema: z.ZodType, name: string | undefined, resource: D | undefined, timeoutSecs: Timeout, signal?: AbortSignal): Promise<R>;
 }

package/dist/base/resource_collection_client.js

@@ -8,41 +8,46 @@ export class ResourceCollectionClient extends ApiClient {
     /**
      * @private
      */
-    async listResources(schema, options, timeoutSecs) {
+    async listResources(schema, options, timeoutSecs, signal) {
         const response = await this.httpClient.call({
             url: this.buildUrl(),
             method: 'GET',
             params: this.buildParams(options),
             timeoutSecs,
+            signal,
         });
         return parseResponse(response, schema);
     }
     /**
      * Returns async iterator to iterate through all items and Promise that can be awaited to get first page of results.
-     * `defaultTimeoutSecs` applies to every page request unless `options.timeoutSecs` overrides it.
+     * `defaultTimeoutSecs` applies to every page request unless `options.timeoutSecs` overrides it, and
+     * `options.signal` goes to every page request.
      */
     listResourcesPaginated(schema, options, defaultTimeoutSecs) {
-        // `timeoutSecs` only times the page requests; it is not an API parameter, so it must not reach the query string.
-        const { timeoutSecs = defaultTimeoutSecs, ...listOptions } = options;
-        return this.listPaginatedFromCallback(async (pageOptions) => this.listResources(schema, pageOptions, timeoutSecs), listOptions);
+        // `timeoutSecs` and `signal` only apply to the page requests; they are not API parameters, so they must not
+        // reach the query string.
+        const { timeoutSecs = defaultTimeoutSecs, signal, ...listOptions } = options;
+        return this.listPaginatedFromCallback(async (pageOptions) => this.listResources(schema, pageOptions, timeoutSecs, signal), listOptions);
     }
-    async createResource(schema, resource, timeoutSecs) {
+    async createResource(schema, resource, timeoutSecs, signal) {
         const response = await this.httpClient.call({
             url: this.buildUrl(),
             method: 'POST',
             params: this.buildParams(),
             data: resource,
             timeoutSecs,
+            signal,
         });
         return parseResponse(response, schema);
     }
-    async getOrCreateResource(schema, name, resource, timeoutSecs) {
+    async getOrCreateResource(schema, name, resource, timeoutSecs, signal) {
         const response = await this.httpClient.call({
             url: this.buildUrl(),
             method: 'POST',
             params: this.buildParams({ name }),
             data: resource,
             timeoutSecs,
+            signal,
         });
         return parseResponse(response, schema);
     }