apify-client 2.25.1-beta.8 → 3.0.0-beta.1

package/dist/resource_clients/key_value_store_collection.js

@@ -1,10 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyValueStoreCollectionClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
+const zod_1 = require("zod");
 const consts_1 = require("@apify/consts");
 const resource_collection_client_1 = require("../base/resource_collection_client");
+const utils_1 = require("../utils");
+const listOptionsSchema = zod_1.z.strictObject({
+    unnamed: zod_1.z.boolean().optional(),
+    ...utils_1.paginationOptionsShape,
+    desc: zod_1.z.boolean().optional(),
+    ownership: zod_1.z.enum(consts_1.STORAGE_OWNERSHIP_FILTER).optional(),
+});
+const nameSchema = zod_1.z.string().optional();
+const schemaSchema = utils_1.anyObjectSchema.optional();
 /**
  * Client for managing the collection of Key-value stores in your account.
  *
@@ -56,14 +64,8 @@ class KeyValueStoreCollectionClient extends resource_collection_client_1.Resourc
      * @see https://docs.apify.com/api/v2/key-value-stores-get
      */
     list(options = {}) {
-        (0, ow_1.default)(options, ow_1.default.object.exactShape({
-            unnamed: ow_1.default.optional.boolean,
-            limit: ow_1.default.optional.number.not.negative,
-            offset: ow_1.default.optional.number.not.negative,
-            desc: ow_1.default.optional.boolean,
-            ownership: ow_1.default.optional.string.oneOf(Object.values(consts_1.STORAGE_OWNERSHIP_FILTER)),
-        }));
-        return this._listPaginated(options);
+        const parsed = (0, utils_1.parseArgument)(options, listOptionsSchema, 'KeyValueStoreCollectionClientListOptions');
+        return this._listPaginated(parsed);
     }
     /**
      * Gets or creates a key-value store with the specified name.
@@ -74,8 +76,8 @@ class KeyValueStoreCollectionClient extends resource_collection_client_1.Resourc
      * @see https://docs.apify.com/api/v2/key-value-stores-post
      */
     async getOrCreate(name, options) {
-        (0, ow_1.default)(name, ow_1.default.optional.string);
-        (0, ow_1.default)(options?.schema, ow_1.default.optional.object); // TODO: Add schema validatioon
+        (0, utils_1.parseArgument)(name, nameSchema);
+        (0, utils_1.parseArgument)(options?.schema, schemaSchema); // TODO: Add schema validation
         return this._getOrCreate(name, options);
     }
 }

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 {};