apify-client 3.0.0-beta.0 → 3.0.0-beta.1

package/dist/resource_clients/build.d.ts

@@ -1,8 +1,8 @@
-import type { ACT_JOB_TERMINAL_STATUSES } from '@apify/consts';
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
-import type { ActorDefinition } from './actor';
+import type { Build } from '../models';
 import { LogClient } from './log';
+export type { Build, BuildMeta, BuildOptions, BuildStats, BuildUsage } from '../models';
 /**
  * Client for managing a specific Actor build.
  *
@@ -143,80 +143,6 @@ export interface BuildClientWaitForFinishOptions {
      */
     waitSecs?: number;
 }
-/**
- * Metadata about how a Build was initiated.
- */
-export interface BuildMeta {
-    origin: string;
-    clientIp: string;
-    userAgent: string;
-}
-/**
- * Represents an Actor build.
- *
- * Builds compile Actor source code and prepare it for execution. Each build has a unique ID
- * and can be tagged (e.g., 'latest', 'beta') for easy reference.
- */
-export interface Build {
-    id: string;
-    actId: string;
-    userId: string;
-    startedAt: Date;
-    finishedAt?: Date;
-    status: (typeof ACT_JOB_TERMINAL_STATUSES)[number];
-    meta: BuildMeta;
-    stats?: BuildStats;
-    options?: BuildOptions;
-    /**
-     * @deprecated This property is deprecated in favor of `actorDefinition.input`.
-     */
-    inputSchema?: string;
-    /**
-     * @deprecated This property is deprecated in favor of `actorDefinition.readme`.
-     */
-    readme?: string;
-    buildNumber: string;
-    /**
-     * @since Added in 2.7.2
-     */
-    usage?: BuildUsage;
-    /**
-     * @since Added in 2.7.2
-     */
-    usageTotalUsd?: number;
-    /**
-     * @since Added in 2.7.2
-     */
-    usageUsd?: BuildUsage;
-    /**
-     * @since Added in 2.11.0
-     */
-    actorDefinition?: ActorDefinition;
-}
-/**
- * Resource usage for an Actor build.
- * @since Added in 2.7.2
- */
-export interface BuildUsage {
-    ACTOR_COMPUTE_UNITS?: number;
-}
-/**
- * Runtime statistics for an Actor build.
- */
-export interface BuildStats {
-    durationMillis: number;
-    runTimeSecs: number;
-    computeUnits: number;
-}
-/**
- * Configuration options used for an Actor build.
- */
-export interface BuildOptions {
-    useCache?: boolean;
-    betaPackages?: boolean;
-    memoryMbytes?: number;
-    diskMbytes?: number;
-}
 /**
  * OpenAPI specification for an Actor.
  *
@@ -283,4 +209,3 @@ interface OpenApiOperation {
         };
     };
 }
-export {};

package/dist/resource_clients/build_collection.d.ts

@@ -1,7 +1,8 @@
 import type { ApiClientOptionsWithOptionalResourcePath } from '../base/api_client';
 import { ResourceCollectionClient } from '../base/resource_collection_client';
+import type { BuildCollectionClientListItem } from '../models';
 import type { PaginatedIterator, PaginatedList, PaginationOptions } from '../utils';
-import type { Build } from './build';
+export type { BuildCollectionClientListItem } from '../models';
 /**
  * Client for managing the collection of Actor builds.
  *
@@ -53,5 +54,4 @@ export declare class BuildCollectionClient extends ResourceCollectionClient {
 export interface BuildCollectionClientListOptions extends PaginationOptions {
     desc?: boolean;
 }
-export type BuildCollectionClientListItem = Required<Pick<Build, 'id' | 'status' | 'startedAt' | 'finishedAt'>> & Partial<Pick<Build, 'meta' | 'usageTotalUsd'>>;
 export type BuildCollectionClientListResult = PaginatedList<BuildCollectionClientListItem>;

package/dist/resource_clients/dataset.d.ts

@@ -1,7 +1,9 @@
 import type { STORAGE_GENERAL_ACCESS } from '@apify/consts';
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
+import type { Dataset, DatasetStatistics } from '../models';
 import type { PaginatedIterator, PaginationOptions } from '../utils';
+export type { Dataset, DatasetStatistics, DatasetStats, FieldStatistics } from '../models';
 /**
  * Client for managing a specific Dataset.
  *
@@ -222,55 +224,6 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
     createItemsPublicUrl(options?: DatasetClientCreateItemsUrlOptions): Promise<string>;
     private _createPaginationList;
 }
-/**
- * Represents a dataset storage on the Apify platform.
- *
- * Datasets store structured data as a sequence of items (records). Each item is a JSON object.
- * Datasets are useful for storing results from web scraping, crawling, or data processing tasks.
- */
-export interface Dataset {
-    id: string;
-    name?: string;
-    /**
-     * @since Added in 2.6.1
-     */
-    title?: string;
-    userId: string;
-    /**
-     * @since Added in 2.21.0
-     */
-    username?: string;
-    createdAt: Date;
-    modifiedAt: Date;
-    accessedAt: Date;
-    itemCount: number;
-    cleanItemCount: number;
-    actId?: string;
-    actRunId?: string;
-    stats: DatasetStats;
-    fields: string[];
-    /**
-     * @since Added in 2.12.2
-     */
-    generalAccess?: STORAGE_GENERAL_ACCESS | null;
-    /**
-     * @since Added in 2.13.0
-     */
-    urlSigningSecretKey?: string | null;
-    /**
-     * @since Added in 2.13.0
-     */
-    itemsPublicUrl: string;
-}
-/**
- * Statistics about dataset usage and storage.
- */
-export interface DatasetStats {
-    readCount?: number;
-    writeCount?: number;
-    deleteCount?: number;
-    storageBytes?: number;
-}
 /**
  * Options for updating a dataset.
  */
@@ -348,22 +301,3 @@ export interface DatasetClientDownloadItemsOptions extends Omit<DatasetClientLis
     xmlRoot?: string;
     xmlRow?: string;
 }
-/**
- * Statistical information about dataset fields.
- *
- * Provides insights into the data structure and content of the dataset.
- * @since Added in 2.11.2
- */
-export interface DatasetStatistics {
-    fieldStatistics: Record<string, FieldStatistics>;
-}
-/**
- * Statistics for a single field in a dataset.
- * @since Added in 2.11.2
- */
-export interface FieldStatistics {
-    min?: number;
-    max?: number;
-    nullCount?: number;
-    emptyCount?: number;
-}

package/dist/resource_clients/key_value_store.d.ts

@@ -3,6 +3,8 @@ import type { JsonValue } from 'type-fest';
 import type { STORAGE_GENERAL_ACCESS } from '@apify/consts';
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
+import type { KeyValueClientListKeysResult, KeyValueListItem, KeyValueStore } from '../models';
+export type { KeyValueClientListKeysResult, KeyValueListItem, KeyValueStore, KeyValueStoreStats } from '../models';
 /**
  * Client for managing a specific key-value store.
  *
@@ -231,53 +233,6 @@ export declare class KeyValueStoreClient extends ResourceClient {
      */
     deleteRecord(key: string): Promise<void>;
 }
-/**
- * Represents a Key-Value Store storage on the Apify platform.
- *
- * Key-value stores are used to store arbitrary data records or files. Each record is identified
- * by a unique key and can contain any data - JSON objects, strings, binary files, etc.
- */
-export interface KeyValueStore {
-    id: string;
-    name?: string;
-    /**
-     * @since Added in 2.6.1
-     */
-    title?: string;
-    userId: string;
-    /**
-     * @since Added in 2.21.0
-     */
-    username?: string;
-    createdAt: Date;
-    modifiedAt: Date;
-    accessedAt: Date;
-    actId?: string;
-    actRunId?: string;
-    stats?: KeyValueStoreStats;
-    /**
-     * @since Added in 2.12.2
-     */
-    generalAccess?: STORAGE_GENERAL_ACCESS | null;
-    /**
-     * @since Added in 2.13.0
-     */
-    urlSigningSecretKey?: string | null;
-    /**
-     * @since Added in 2.13.0
-     */
-    keysPublicUrl: string;
-}
-/**
- * Statistics about Key-Value Store usage and storage.
- */
-export interface KeyValueStoreStats {
-    readCount?: number;
-    writeCount?: number;
-    deleteCount?: number;
-    listCount?: number;
-    storageBytes?: number;
-}
 /**
  * Options for updating a Key-Value Store.
  */
@@ -318,30 +273,6 @@ export interface KeyValueClientListKeysOptions {
 export interface KeyValueClientCreateKeysUrlOptions extends Omit<KeyValueClientListKeysOptions, 'signature'> {
     expiresInSecs?: number;
 }
-/**
- * Result of listing keys in a Key-Value Store.
- *
- * Contains paginated list of keys with metadata and pagination information.
- */
-export interface KeyValueClientListKeysResult {
-    count: number;
-    limit: number;
-    exclusiveStartKey: string;
-    isTruncated: boolean;
-    nextExclusiveStartKey: string;
-    items: KeyValueListItem[];
-}
-/**
- * Metadata about a single key in a Key-Value Store.
- */
-export interface KeyValueListItem {
-    key: string;
-    size: number;
-    /**
-     * @since Added in 2.15.1
-     */
-    recordPublicUrl: string;
-}
 /**
  * Options for retrieving a record from a Key-Value Store.
  */

package/dist/resource_clients/key_value_store.js

@@ -168,7 +168,9 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
             yield* currentPage.items;
             let remainingItems = parsed.limit ? parsed.limit - currentPage.items.length : undefined;
             while (currentPage.items.length > 0 && // Continue only if at least some items were returned in the last page.
-                currentPage.nextExclusiveStartKey !== null && // Continue only if there is some next key.
+                // Continue only if there is some next key. The API answers with `null` on the last page and
+                // omits the field entirely for a listing that was not truncated.
+                currentPage.nextExclusiveStartKey != null &&
                 (remainingItems === undefined || remainingItems > 0) // Continue only if the limit was not exceeded.
             ) {
                 const newOptions = {

package/dist/resource_clients/request_queue.d.ts

@@ -1,6 +1,8 @@
 import type { STORAGE_GENERAL_ACCESS } from '@apify/consts';
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
+import type { RequestQueue, RequestQueueClientAddRequestResult, RequestQueueClientBatchDeleteRequestsResult, RequestQueueClientBatchRequestsOperationResult, RequestQueueClientListAndLockHeadResult, RequestQueueClientListHeadResult, RequestQueueClientListRequestsResult, RequestQueueClientProlongRequestLockResult, RequestQueueClientRequestSchema, RequestQueueClientRequestToAdd, RequestQueueClientRequestToUpdate, RequestQueueClientUnlockRequestsResult } from '../models';
+export type { AllowedHttpMethods, RequestQueue, RequestQueueClientAddRequestResult, RequestQueueClientBatchDeleteRequestsResult, RequestQueueClientBatchRequestsOperationResult, RequestQueueClientListAndLockHeadResult, RequestQueueClientListHeadResult, RequestQueueClientListItem, RequestQueueClientListRequestsResult, RequestQueueClientLockedListItem, RequestQueueClientProlongRequestLockResult, RequestQueueClientRequestSchema, RequestQueueClientRequestToAdd, RequestQueueClientRequestToUpdate, RequestQueueClientUnlockRequestsResult, RequestQueueStats, } from '../models';
 /**
  * Client for managing a specific Request queue.
  *
@@ -20,12 +22,12 @@ import { ResourceClient } from '../base/resource_client';
  * });
  *
  * // Get the next request from the queue
- * const request = await queueClient.listHead();
+ * const { items: [request] } = await queueClient.listHead({ limit: 1 });
  *
  * // Mark request as handled
  * await queueClient.updateRequest({
  *   id: request.id,
- *   handledAt: new Date().toISOString()
+ *   handledAt: new Date()
  * });
  * ```
  *
@@ -142,14 +144,14 @@ export declare class RequestQueueClient extends ResourceClient {
      * );
      * ```
      */
-    addRequest(request: Omit<RequestQueueClientRequestSchema, 'id'>, options?: RequestQueueClientAddRequestOptions): Promise<RequestQueueClientAddRequestResult>;
+    addRequest(request: RequestQueueClientRequestToAdd, options?: RequestQueueClientAddRequestOptions): Promise<RequestQueueClientAddRequestResult>;
     /**
      * Writes requests to Request queue in batch.
      *
      * @private
      */
-    protected _batchAddRequests(requests: Omit<RequestQueueClientRequestSchema, 'id'>[], options?: RequestQueueClientAddRequestOptions): Promise<RequestQueueClientBatchRequestsOperationResult>;
-    protected _batchAddRequestsWithRetries(requests: Omit<RequestQueueClientRequestSchema, 'id'>[], options?: RequestQueueClientBatchAddRequestWithRetriesOptions): Promise<RequestQueueClientBatchRequestsOperationResult>;
+    protected _batchAddRequests(requests: RequestQueueClientRequestToAdd[], options?: RequestQueueClientAddRequestOptions): Promise<RequestQueueClientBatchRequestsOperationResult>;
+    protected _batchAddRequestsWithRetries(requests: RequestQueueClientRequestToAdd[], options?: RequestQueueClientBatchAddRequestWithRetriesOptions): Promise<RequestQueueClientBatchRequestsOperationResult>;
     /**
      * Adds multiple requests to the queue in a single operation.
      *
@@ -188,7 +190,7 @@ export declare class RequestQueueClient extends ResourceClient {
      * ```
      * @since Added in 2.1.0
      */
-    batchAddRequests(requests: Omit<RequestQueueClientRequestSchema, 'id'>[], options?: RequestQueueClientBatchAddRequestWithRetriesOptions): Promise<RequestQueueClientBatchRequestsOperationResult>;
+    batchAddRequests(requests: RequestQueueClientRequestToAdd[], options?: RequestQueueClientBatchAddRequestWithRetriesOptions): Promise<RequestQueueClientBatchRequestsOperationResult>;
     /**
      * Deletes multiple requests from the queue in a single operation.
      *
@@ -199,7 +201,7 @@ export declare class RequestQueueClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/request-queue-requests-batch-delete
      * @since Added in 2.3.0
      */
-    batchDeleteRequests(requests: RequestQueueClientRequestToDelete[]): Promise<RequestQueueClientBatchRequestsOperationResult>;
+    batchDeleteRequests(requests: RequestQueueClientRequestToDelete[]): Promise<RequestQueueClientBatchDeleteRequestsResult>;
     /**
      * Gets a specific request from the queue by its ID.
      *
@@ -216,7 +218,7 @@ export declare class RequestQueueClient extends ResourceClient {
      * @returns Information about the updated request
      * @see https://docs.apify.com/api/v2/request-queue-request-put
      */
-    updateRequest(request: RequestQueueClientRequestSchema, options?: RequestQueueClientAddRequestOptions): Promise<RequestQueueClientAddRequestResult>;
+    updateRequest(request: RequestQueueClientRequestToUpdate, options?: RequestQueueClientAddRequestOptions): Promise<RequestQueueClientAddRequestResult>;
     /**
      * Deletes a specific request from the queue.
      *
@@ -314,50 +316,6 @@ export interface RequestQueueUserOptions {
      */
     timeoutSecs?: number;
 }
-/**
- * Represents a Request Queue storage on the Apify platform.
- *
- * Request queues store URLs (requests) to be processed by web crawlers. They provide
- * automatic deduplication, request locking for parallel processing, and persistence.
- */
-export interface RequestQueue {
-    id: string;
-    name?: string;
-    /**
-     * @since Added in 2.6.1
-     */
-    title?: string;
-    userId: string;
-    /**
-     * @since Added in 2.21.0
-     */
-    username?: string;
-    createdAt: Date;
-    modifiedAt: Date;
-    accessedAt: Date;
-    expireAt?: string;
-    totalRequestCount: number;
-    handledRequestCount: number;
-    pendingRequestCount: number;
-    actId?: string;
-    actRunId?: string;
-    hadMultipleClients: boolean;
-    stats: RequestQueueStats;
-    /**
-     * @since Added in 2.12.2
-     */
-    generalAccess?: STORAGE_GENERAL_ACCESS | null;
-}
-/**
- * Statistics about Request Queue usage and storage.
- */
-export interface RequestQueueStats {
-    readCount?: number;
-    writeCount?: number;
-    deleteCount?: number;
-    headItemReadCount?: number;
-    storageBytes?: number;
-}
 /**
  * Options for updating a Request Queue.
  */
@@ -378,15 +336,6 @@ export interface RequestQueueClientUpdateOptions {
 export interface RequestQueueClientListHeadOptions {
     limit?: number;
 }
-/**
- * Result of listing requests from the queue head.
- */
-export interface RequestQueueClientListHeadResult {
-    limit: number;
-    queueModifiedAt: Date;
-    hadMultipleClients: boolean;
-    items: RequestQueueClientListItem[];
-}
 /**
  * @since Added in 2.23.2
  */
@@ -429,24 +378,6 @@ export interface RequestQueueClientPaginateRequestsOptions {
      */
     filter?: readonly RequestQueueListRequestsFilter[];
 }
-/**
- * Result of listing all requests in the queue.
- * @since Added in 2.5.1
- */
-export interface RequestQueueClientListRequestsResult {
-    limit: number;
-    /** @deprecated Use `cursor` for pagination instead. */
-    exclusiveStartId?: string;
-    /**
-     * @since Added in 2.23.2
-     */
-    cursor?: string;
-    /**
-     * @since Added in 2.23.2
-     */
-    nextCursor?: string;
-    items: RequestQueueClientRequestSchema[];
-}
 /**
  * Options for listing and locking requests from the queue head.
  * @since Added in 2.4.1
@@ -455,37 +386,6 @@ export interface RequestQueueClientListAndLockHeadOptions {
     lockSecs: number;
     limit?: number;
 }
-/**
- * Result of listing and locking requests from the queue head.
- *
- * Extends {@link RequestQueueClientListHeadResult} with lock information.
- * @since Added in 2.4.1
- */
-export interface RequestQueueClientListAndLockHeadResult extends RequestQueueClientListHeadResult {
-    lockSecs: number;
-    /**
-     * @since Added in 2.11.0
-     */
-    queueHasLockedRequests: boolean;
-    /**
-     * @since Added in 2.11.0
-     */
-    clientKey: string;
-}
-/**
- * Simplified request information used in list results.
- */
-export interface RequestQueueClientListItem {
-    id: string;
-    retryCount: number;
-    uniqueKey: string;
-    url: string;
-    method: AllowedHttpMethods;
-    /**
-     * @since Added in 2.4.1
-     */
-    lockExpiresAt?: Date;
-}
 export interface RequestQueueClientAddRequestOptions {
     forefront?: boolean;
 }
@@ -502,12 +402,6 @@ export interface RequestQueueClientProlongRequestLockOptions {
 export interface RequestQueueClientDeleteRequestLockOptions {
     forefront?: boolean;
 }
-/**
- * @since Added in 2.4.1
- */
-export interface RequestQueueClientProlongRequestLockResult {
-    lockExpiresAt: Date;
-}
 /**
  * @since Added in 2.3.0
  */
@@ -520,71 +414,18 @@ export interface RequestQueueClientBatchAddRequestWithRetriesOptions {
      */
     minDelayBetweenUnprocessedRequestsRetriesMillis?: number;
 }
-/**
- * Complete schema for a request in the queue.
- *
- * Represents a URL to be crawled along with its metadata, retry information, and custom data.
- */
-export interface RequestQueueClientRequestSchema {
-    id: string;
-    uniqueKey: string;
-    url: string;
-    method?: AllowedHttpMethods;
-    payload?: string;
-    retryCount?: number;
-    errorMessages?: string[];
-    headers?: Record<string, string>;
-    userData?: Record<string, unknown>;
-    handledAt?: string;
-    noRetry?: boolean;
-    loadedUrl?: string;
-}
-/**
- * Result of adding a request to the queue.
- */
-export interface RequestQueueClientAddRequestResult {
-    requestId: string;
-    wasAlreadyPresent: boolean;
-    wasAlreadyHandled: boolean;
-}
-interface ProcessedRequest {
-    uniqueKey: string;
-    requestId: string;
-    wasAlreadyPresent: boolean;
-    wasAlreadyHandled: boolean;
-}
-interface UnprocessedRequest {
-    uniqueKey: string;
-    url: string;
-    method?: AllowedHttpMethods;
-}
-/**
- * @since Added in 2.12.5
- */
-export interface RequestQueueClientUnlockRequestsResult {
-    unlockedCount: number;
-}
-/**
- * Result of a batch operation on requests.
- *
- * Contains lists of successfully processed and unprocessed requests.
- * @since Added in 2.3.0
- */
-export interface RequestQueueClientBatchRequestsOperationResult {
-    processedRequests: ProcessedRequest[];
-    unprocessedRequests: UnprocessedRequest[];
-}
 /**
  * @since Added in 2.3.0
  */
 export type RequestQueueClientRequestToDelete = Pick<RequestQueueClientRequestSchema, 'id'> | Pick<RequestQueueClientRequestSchema, 'uniqueKey'>;
-export type RequestQueueClientGetRequestResult = Omit<RequestQueueClientListItem, 'retryCount'>;
 /**
- * HTTP methods supported by Request Queue requests.
+ * Result of getting a single request from the queue.
+ *
+ * `GET /v2/request-queues/{queueId}/requests/{requestId}` answers with the whole request rather than
+ * a queue-head projection.
  */
-export type AllowedHttpMethods = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'OPTIONS' | 'CONNECT' | 'PATCH';
+export type RequestQueueClientGetRequestResult = RequestQueueClientRequestSchema;
 /**
  * @since Added in 2.5.1
  */
 export type RequestQueueRequestsAsyncIterable<T> = AsyncIterable<T>;
-export {};

package/dist/resource_clients/request_queue.js

@@ -73,12 +73,12 @@ const paginateRequestsOptionsSchema = zod_1.z
  * });
  *
  * // Get the next request from the queue
- * const request = await queueClient.listHead();
+ * const { items: [request] } = await queueClient.listHead({ limit: 1 });
  *
  * // Mark request as handled
  * await queueClient.updateRequest({
  *   id: request.id,
- *   handledAt: new Date().toISOString()
+ *   handledAt: new Date()
  * });
  * ```
  *