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

package/dist/resource_clients/dataset.d.ts

@@ -2,6 +2,7 @@ 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 { Dataset, DatasetStatistics } from '../models.js';
+import type { TimeoutOptions } from '../timeouts.js';
 import type { PaginatedIterator, PaginationOptions } from '../utils.js';
 export type { Dataset, DatasetStatistics, DatasetStats, FieldStatistics } from '../models.js';
 /**
@@ -34,6 +35,7 @@ export type { Dataset, DatasetStatistics, DatasetStats, FieldStatistics } from '
  * @see https://docs.apify.com/platform/storage/dataset
  */
 export declare class DatasetClient<Data extends Record<string | number, any> = Record<string | number, unknown>> extends ResourceClient {
+    #private;
     /**
      * @hidden
      */
@@ -41,24 +43,30 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
     /**
      * Gets the dataset object from the Apify API.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The Dataset object, or `undefined` if it does not exist
      * @see https://docs.apify.com/api/v2/dataset-get
      */
-    get(): Promise<Dataset | undefined>;
+    get(options?: TimeoutOptions): Promise<Dataset | undefined>;
     /**
      * Updates the dataset with specified fields.
      *
      * @param newFields - Fields to update in the dataset
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The updated Dataset object
      * @see https://docs.apify.com/api/v2/dataset-put
      */
-    update(newFields: DatasetClientUpdateOptions): Promise<Dataset>;
+    update(newFields: DatasetClientUpdateOptions, options?: TimeoutOptions): Promise<Dataset>;
     /**
      * Deletes the dataset.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @see https://docs.apify.com/api/v2/dataset-delete
      */
-    delete(): Promise<void>;
+    delete(options?: TimeoutOptions): Promise<void>;
     /**
      * Lists items in the dataset.
      *
@@ -79,6 +87,7 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
      * @param options.flatten - Array of field names to flatten. Nested objects are converted to dot notation (e.g., `obj.field`).
      * @param options.unwind - Field name or array of field names to unwind. Each array value creates a separate item.
      * @param options.view - Name of a predefined view to use for field selection.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'long'`.
      * @returns A paginated list with `items`, `total` count, `offset`, `count`, and `limit`
      * @see https://docs.apify.com/api/v2/dataset-items-get
      *
@@ -121,6 +130,7 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
      * @param options.xmlRow - Name of the XML element for each item. Default is `'item'`.
      * @param options.fields - Array of field names to include in the export.
      * @param options.omit - Array of field names to exclude from the export.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'long'`.
      * @returns Buffer containing the serialized data in the specified format
      * @see https://docs.apify.com/api/v2/dataset-items-get
      *
@@ -144,7 +154,7 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
      * });
      * ```
      */
-    downloadItems(format: DownloadItemsFormat, options?: DatasetClientDownloadItemsOptions): Promise<Buffer>;
+    downloadItems(format: `${DownloadItemsFormat}`, options?: DatasetClientDownloadItemsOptions): Promise<Buffer>;
     /**
      * Stores one or more items into the dataset.
      *
@@ -155,6 +165,8 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
      *
      * @param items - A single item (object or string) or an array of items to store.
      *                Objects are automatically stringified to JSON. Strings are stored as-is.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`.
      * @see https://docs.apify.com/api/v2/dataset-items-post
      *
      * @example
@@ -177,18 +189,20 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
      * await client.dataset('my-dataset').pushItems(['item1', 'item2', 'item3']);
      * ```
      */
-    pushItems(items: Data | Data[] | string | string[]): Promise<void>;
+    pushItems(items: Data | Data[] | string | string[], options?: TimeoutOptions): Promise<void>;
     /**
      * Gets statistical information about the dataset.
      *
      * Returns statistics for each field in the dataset, including information about
      * data types, null counts, and value ranges.
      *
-     * @returns Dataset statistics, or `undefined` if not available
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
+     * @returns Dataset statistics
      * @see https://docs.apify.com/api/v2/dataset-statistics-get
      * @since Added in 2.11.2
      */
-    getStatistics(): Promise<DatasetStatistics | undefined>;
+    getStatistics(options?: TimeoutOptions): Promise<DatasetStatistics>;
     /**
      * Generates a public URL for accessing dataset items.
      *
@@ -201,6 +215,7 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
      * @param options.fields - Array of field names to include in the response.
      * @param options.limit - Maximum number of items to return.
      * @param options.offset - Number of items to skip.
+     * @param options.timeoutSecs - Timeout for the API request that fetches the dataset. Default is `'long'`.
      * @returns A public URL string for accessing the dataset items
      *
      * @example
@@ -222,7 +237,6 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
      * @since Added in 2.13.0
      */
     createItemsPublicUrl(options?: DatasetClientCreateItemsUrlOptions): Promise<string>;
-    private _createPaginationList;
 }
 /**
  * Options for updating a dataset.
@@ -244,7 +258,7 @@ export interface DatasetClientUpdateOptions {
  * Provides various filtering, pagination, and transformation options to customize
  * the output format and content of retrieved items.
  */
-export interface DatasetClientListItemOptions extends PaginationOptions {
+export interface DatasetClientListItemOptions extends PaginationOptions, TimeoutOptions {
     clean?: boolean;
     desc?: boolean;
     /**

package/dist/resource_clients/dataset.js

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 import { createStorageContentSignatureAsync } from '@apify/utilities';
-import { DEFAULT_TIMEOUT_MILLIS, MEDIUM_TIMEOUT_MILLIS, ResourceClient, SMALL_TIMEOUT_MILLIS, } from '../base/resource_client.js';
-import { anyObjectSchema, applyQueryParamsToUrl, cast, catchNotFoundOrThrow, isNonArrayObject, paginationOptionsShape, parseArgument, pluckData, } from '../utils.js';
+import { ResourceClient } from '../base/resource_client.js';
+import * as schemas from '../schemas.js';
+import { timeoutOptionsSchema, timeoutOptionsShape } from '../timeouts.js';
+import { anyObjectSchema, applyQueryParamsToUrl, cast, isNonArrayObject, paginationOptionsShape, parseArgument, parseResponse, SCANNED_COUNT, } from '../utils.js';
 // A predicate, not a `z.object()` arm, which would walk and copy every key of every pushed item.
 const itemSchema = z.custom(isNonArrayObject, 'Expected an object');
 const listItemsOptionsSchema = z.strictObject({
@@ -16,6 +18,7 @@ const listItemsOptionsSchema = z.strictObject({
     unwind: z.union([z.string(), z.array(z.string())]).optional(),
     view: z.string().optional(),
     signature: z.string().optional(),
+    ...timeoutOptionsShape,
 });
 // Spells out `limit` / `offset` instead of spreading `paginationOptionsShape`: a download is one
 // request, so `chunkSize` has nothing to size. The options type omits it to match.
@@ -38,10 +41,12 @@ const downloadItemsOptionsSchema = z.strictObject({
     xmlRoot: z.string().optional(),
     xmlRow: z.string().optional(),
     signature: z.string().optional(),
+    ...timeoutOptionsShape,
 });
 const pushItemsSchema = z.union([itemSchema, z.string(), z.array(z.union([itemSchema, z.string()]))]);
-// Every option becomes a query parameter of the generated URL, so `chunkSize` (client-side only) and
-// `signature` (which this method produces) are left out. The options type omits both to match.
+// Apart from `timeoutSecs` and `expiresInSecs`, every option becomes a query parameter of the generated URL, so
+// `chunkSize` (client-side only) and `signature` (which this method produces) are left out. The options type
+// omits both to match.
 const createItemsPublicUrlOptionsSchema = z.strictObject({
     clean: z.boolean().optional(),
     desc: z.boolean().optional(),
@@ -55,6 +60,7 @@ const createItemsPublicUrlOptionsSchema = z.strictObject({
     unwind: z.union([z.string(), z.array(z.string())]).optional(),
     view: z.string().optional(),
     expiresInSecs: z.number().optional(),
+    ...timeoutOptionsShape,
 });
 /**
  * Client for managing a specific Dataset.
@@ -98,30 +104,39 @@ export class DatasetClient extends ResourceClient {
     /**
      * Gets the dataset object from the Apify API.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The Dataset object, or `undefined` if it does not exist
      * @see https://docs.apify.com/api/v2/dataset-get
      */
-    async get() {
-        return this._get({}, SMALL_TIMEOUT_MILLIS);
+    async get(options = {}) {
+        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.getResource(schemas.Dataset(), {}, timeoutSecs);
     }
     /**
      * Updates the dataset with specified fields.
      *
      * @param newFields - Fields to update in the dataset
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The updated Dataset object
      * @see https://docs.apify.com/api/v2/dataset-put
      */
-    async update(newFields) {
+    async update(newFields, options = {}) {
         parseArgument(newFields, anyObjectSchema);
-        return this._update(newFields, SMALL_TIMEOUT_MILLIS);
+        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.updateResource(schemas.Dataset(), newFields, timeoutSecs);
     }
     /**
      * Deletes the dataset.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @see https://docs.apify.com/api/v2/dataset-delete
      */
-    async delete() {
-        return this._delete(SMALL_TIMEOUT_MILLIS);
+    async delete(options = {}) {
+        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.deleteResource(timeoutSecs);
     }
     /**
      * Lists items in the dataset.
@@ -143,6 +158,7 @@ export class DatasetClient extends ResourceClient {
      * @param options.flatten - Array of field names to flatten. Nested objects are converted to dot notation (e.g., `obj.field`).
      * @param options.unwind - Field name or array of field names to unwind. Each array value creates a separate item.
      * @param options.view - Name of a predefined view to use for field selection.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'long'`.
      * @returns A paginated list with `items`, `total` count, `offset`, `count`, and `limit`
      * @see https://docs.apify.com/api/v2/dataset-items-get
      *
@@ -168,17 +184,17 @@ export class DatasetClient extends ResourceClient {
      * ```
      */
     listItems(options = {}) {
-        const parsed = parseArgument(options, listItemsOptionsSchema, 'DatasetClientListItemOptions');
+        const { timeoutSecs = 'long', ...listOptions } = parseArgument(options, listItemsOptionsSchema, 'DatasetClientListItemOptions');
         const fetchItems = async (datasetListOptions = {}) => {
             const response = await this.httpClient.call({
-                url: this._url('items'),
+                url: this.buildUrl('items'),
                 method: 'GET',
-                params: this._params(datasetListOptions),
-                timeout: DEFAULT_TIMEOUT_MILLIS,
+                params: this.buildParams(datasetListOptions),
+                timeoutSecs,
             });
-            return this._createPaginationList(response, datasetListOptions.desc ?? false);
+            return this.#createPaginationList(response, datasetListOptions.desc ?? false);
         };
-        return this._listPaginatedFromCallback(fetchItems, parsed);
+        return this.listPaginatedFromCallback(fetchItems, listOptions);
     }
     /**
      * Downloads dataset items in a specific format.
@@ -197,6 +213,7 @@ export class DatasetClient extends ResourceClient {
      * @param options.xmlRow - Name of the XML element for each item. Default is `'item'`.
      * @param options.fields - Array of field names to include in the export.
      * @param options.omit - Array of field names to exclude from the export.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'long'`.
      * @returns Buffer containing the serialized data in the specified format
      * @see https://docs.apify.com/api/v2/dataset-items-get
      *
@@ -222,16 +239,16 @@ export class DatasetClient extends ResourceClient {
      */
     async downloadItems(format, options = {}) {
         parseArgument(format, itemFormatSchema);
-        const parsed = parseArgument(options, downloadItemsOptionsSchema, 'DatasetClientDownloadItemsOptions');
+        const { timeoutSecs = 'long', ...query } = parseArgument(options, downloadItemsOptionsSchema, 'DatasetClientDownloadItemsOptions');
         const { data } = await this.httpClient.call({
-            url: this._url('items'),
+            url: this.buildUrl('items'),
             method: 'GET',
-            params: this._params({
+            params: this.buildParams({
                 format,
-                ...parsed,
+                ...query,
             }),
             forceBuffer: true,
-            timeout: DEFAULT_TIMEOUT_MILLIS,
+            timeoutSecs,
         });
         return cast(data);
     }
@@ -245,6 +262,8 @@ export class DatasetClient extends ResourceClient {
      *
      * @param items - A single item (object or string) or an array of items to store.
      *                Objects are automatically stringified to JSON. Strings are stored as-is.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`.
      * @see https://docs.apify.com/api/v2/dataset-items-post
      *
      * @example
@@ -267,18 +286,19 @@ export class DatasetClient extends ResourceClient {
      * await client.dataset('my-dataset').pushItems(['item1', 'item2', 'item3']);
      * ```
      */
-    async pushItems(items) {
+    async pushItems(items, options = {}) {
         parseArgument(items, pushItemsSchema);
+        const { timeoutSecs = 'medium' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
         await this.httpClient.call({
-            url: this._url('items'),
+            url: this.buildUrl('items'),
             method: 'POST',
             headers: {
                 'content-type': 'application/json; charset=utf-8',
             },
             data: items,
-            params: this._params(),
-            doNotRetryTimeouts: true, // see timeout handling in http-client
-            timeout: MEDIUM_TIMEOUT_MILLIS,
+            params: this.buildParams(),
+            doNotRetryTimeouts: true, // see timeoutSecs handling in http-client
+            timeoutSecs,
         });
     }
     /**
@@ -287,25 +307,21 @@ export class DatasetClient extends ResourceClient {
      * Returns statistics for each field in the dataset, including information about
      * data types, null counts, and value ranges.
      *
-     * @returns Dataset statistics, or `undefined` if not available
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
+     * @returns Dataset statistics
      * @see https://docs.apify.com/api/v2/dataset-statistics-get
      * @since Added in 2.11.2
      */
-    async getStatistics() {
-        const requestOpts = {
-            url: this._url('statistics'),
+    async getStatistics(options = {}) {
+        const { timeoutSecs = 'short' } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        const response = await this.httpClient.call({
+            url: this.buildUrl('statistics'),
             method: 'GET',
-            params: this._params(),
-            timeout: SMALL_TIMEOUT_MILLIS,
-        };
-        try {
-            const response = await this.httpClient.call(requestOpts);
-            return cast(pluckData(response.data));
-        }
-        catch (err) {
-            catchNotFoundOrThrow(err);
-        }
-        return undefined;
+            params: this.buildParams(),
+            timeoutSecs,
+        });
+        return parseResponse(response, schemas.DatasetStatistics());
     }
     /**
      * Generates a public URL for accessing dataset items.
@@ -319,6 +335,7 @@ export class DatasetClient extends ResourceClient {
      * @param options.fields - Array of field names to include in the response.
      * @param options.limit - Maximum number of items to return.
      * @param options.offset - Number of items to skip.
+     * @param options.timeoutSecs - Timeout for the API request that fetches the dataset. Default is `'long'`.
      * @returns A public URL string for accessing the dataset items
      *
      * @example
@@ -340,10 +357,9 @@ export class DatasetClient extends ResourceClient {
      * @since Added in 2.13.0
      */
     async createItemsPublicUrl(options = {}) {
-        const parsed = parseArgument(options, createItemsPublicUrlOptionsSchema, 'DatasetClientCreateItemsUrlOptions');
-        const dataset = await this.get();
-        const { expiresInSecs, ...queryOptions } = parsed;
-        let createdItemsPublicUrl = new URL(this._publicUrl('items'));
+        const { timeoutSecs = 'long', expiresInSecs, ...queryOptions } = parseArgument(options, createItemsPublicUrlOptionsSchema, 'DatasetClientCreateItemsUrlOptions');
+        const dataset = await this.get({ timeoutSecs });
+        let createdItemsPublicUrl = new URL(this.buildPublicUrl('items'));
         if (dataset?.urlSigningSecretKey) {
             const signature = await createStorageContentSignatureAsync({
                 resourceId: dataset.id,
@@ -355,16 +371,22 @@ export class DatasetClient extends ResourceClient {
         createdItemsPublicUrl = applyQueryParamsToUrl(createdItemsPublicUrl, queryOptions);
         return createdItemsPublicUrl.toString();
     }
-    _createPaginationList(response, userProvidedDesc) {
-        return {
+    #createPaginationList(response, userProvidedDesc) {
+        const page = {
             items: response.data,
             total: Number(response.headers['x-apify-pagination-total']),
             offset: Number(response.headers['x-apify-pagination-offset']),
-            count: response.data.length, // because x-apify-pagination-count returns invalid values when hidden/empty items are skipped
+            // `x-apify-pagination-count` reports the rows scanned, which filters and `unwind` can leave above or below
+            // the items returned.
+            count: response.data.length,
             limit: Number(response.headers['x-apify-pagination-limit']), // API returns 999999999999 when no limit is used
             // TODO: Replace this once https://github.com/apify/apify-core/issues/3503 is solved
             desc: JSON.parse(response.headers['x-apify-pagination-desc'] ?? userProvidedDesc),
         };
+        // The offset iterator paginates by the scanned number, so it travels with the page outside its public shape.
+        return Object.defineProperty(page, SCANNED_COUNT, {
+            value: Number(response.headers['x-apify-pagination-count']) || 0,
+        });
     }
 }
 /**

package/dist/resource_clients/dataset_collection.d.ts

@@ -1,6 +1,7 @@
 import { STORAGE_OWNERSHIP_FILTER } from '@apify/consts';
 import type { ApiClientSubResourceOptions } from '../base/api_client.js';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import type { TimeoutOptions } from '../timeouts.js';
 import type { PaginatedList, PaginationOptions } from '../utils.js';
 import type { Dataset } from './dataset.js';
 /**
@@ -45,6 +46,7 @@ export declare class DatasetCollectionClient extends ResourceCollectionClient {
      * ```
      *
      * @param options - Pagination options.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns A paginated iterator of Datasets.
      * @see https://docs.apify.com/api/v2/datasets-get
      */
@@ -54,12 +56,14 @@ export declare class DatasetCollectionClient extends ResourceCollectionClient {
      *
      * @param name - Name of the dataset. If not provided, a default dataset is used.
      * @param options - Additional options like schema.
+     * @param options.schema - Schema of the dataset.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The dataset object.
      * @see https://docs.apify.com/api/v2/datasets-post
      */
     getOrCreate(name?: string, options?: DatasetCollectionClientGetOrCreateOptions): Promise<Dataset>;
 }
-export interface DatasetCollectionClientListOptions extends PaginationOptions {
+export interface DatasetCollectionClientListOptions extends PaginationOptions, TimeoutOptions {
     unnamed?: boolean;
     desc?: boolean;
     /**
@@ -71,7 +75,7 @@ export interface DatasetCollectionClientListOptions extends PaginationOptions {
 /**
  * @since Added in 2.3.0
  */
-export interface DatasetCollectionClientGetOrCreateOptions {
+export interface DatasetCollectionClientGetOrCreateOptions extends TimeoutOptions {
     schema?: Record<string, unknown>;
 }
 export type DatasetCollectionClientListResult = PaginatedList<Dataset> & {

package/dist/resource_clients/dataset_collection.js

@@ -1,12 +1,15 @@
 import { z } from 'zod';
 import { STORAGE_OWNERSHIP_FILTER } from '@apify/consts';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import * as schemas from '../schemas.js';
+import { optionalTimeoutSchema, timeoutOptionsShape } from '../timeouts.js';
 import { anyObjectSchema, paginationOptionsShape, parseArgument } from '../utils.js';
 const listOptionsSchema = z.strictObject({
     unnamed: z.boolean().optional(),
     ...paginationOptionsShape,
     desc: z.boolean().optional(),
     ownership: z.enum(STORAGE_OWNERSHIP_FILTER).optional(),
+    ...timeoutOptionsShape,
 });
 const nameSchema = z.string().optional();
 const schemaSchema = anyObjectSchema.optional();
@@ -57,24 +60,32 @@ export class DatasetCollectionClient extends ResourceCollectionClient {
      * ```
      *
      * @param options - Pagination options.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns A paginated iterator of Datasets.
      * @see https://docs.apify.com/api/v2/datasets-get
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'DatasetCollectionClientListOptions');
-        return this._listPaginated(parsed);
+        return this.listResourcesPaginated(schemas.ListOfDatasets(), parsed, 'medium');
     }
     /**
      * Gets or creates a dataset with the specified name.
      *
      * @param name - Name of the dataset. If not provided, a default dataset is used.
      * @param options - Additional options like schema.
+     * @param options.schema - Schema of the dataset.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The dataset object.
      * @see https://docs.apify.com/api/v2/datasets-post
      */
     async getOrCreate(name, options) {
         parseArgument(name, nameSchema);
         parseArgument(options?.schema, schemaSchema); // TODO: Add schema validation
-        return this._getOrCreate(name, options);
+        parseArgument(options?.timeoutSecs, optionalTimeoutSchema);
+        // `timeoutSecs` is not part of the resource, so the body carries only the rest, and stays absent when
+        // there is nothing else to send.
+        const { timeoutSecs = 'short', ...resource } = options ?? {};
+        const hasResource = Object.keys(resource).length > 0;
+        return this.getOrCreateResource(schemas.Dataset(), name, hasResource ? resource : undefined, timeoutSecs);
     }
 }