apify-client 3.0.0-beta.3 → 3.0.0-beta.5

package/dist/base/resource_client.d.ts

@@ -1,4 +1,5 @@
 import type { ACT_JOB_STATUSES } from '@apify/consts';
+import type { z } from 'zod';
 import { ApiClient } from './api_client.js';
 export declare const SMALL_TIMEOUT_MILLIS: number;
 export declare const MEDIUM_TIMEOUT_MILLIS: number;
@@ -8,8 +9,8 @@ export declare const DEFAULT_TIMEOUT_MILLIS: number;
  * @private
  */
 export declare class ResourceClient extends ApiClient {
-    protected _get<T, R>(options?: T, timeoutMillis?: number): Promise<R | undefined>;
-    protected _update<T, R>(newFields: T, timeoutMillis?: number): Promise<R>;
+    protected _get<T, R>(schema: z.ZodType, options?: T, timeoutMillis?: number): Promise<R | undefined>;
+    protected _update<T, R>(schema: z.ZodType, newFields: T, timeoutMillis?: number): Promise<R>;
     protected _delete(timeoutMillis?: number): Promise<void>;
     /**
      * This function is used in Build and Run endpoints so it's kept
@@ -17,7 +18,7 @@ export declare class ResourceClient extends ApiClient {
      */
     protected _waitForFinish<R extends {
         status: (typeof ACT_JOB_STATUSES)[keyof typeof ACT_JOB_STATUSES];
-    }>(options?: WaitForFinishOptions): Promise<R>;
+    }>(schema: z.ZodType, options?: WaitForFinishOptions): Promise<R>;
 }
 export interface WaitForFinishOptions {
     waitSecs?: number;

package/dist/base/resource_client.js

@@ -1,5 +1,5 @@
 import { ACT_JOB_TERMINAL_STATUSES } from '@apify/consts';
-import { catchNotFoundOrThrow, parseDateFields, pluckData } from '../utils.js';
+import { catchNotFoundOrThrow, parseResponse } from '../utils.js';
 import { ApiClient } from './api_client.js';
 /**
  * We need to supply some number for the API,
@@ -15,7 +15,7 @@ export const DEFAULT_TIMEOUT_MILLIS = 360 * 1000; // 6 minutes
  * @private
  */
 export class ResourceClient extends ApiClient {
-    async _get(options = {}, timeoutMillis) {
+    async _get(schema, options = {}, timeoutMillis) {
         const requestOpts = {
             url: this._url(),
             method: 'GET',
@@ -24,14 +24,14 @@ export class ResourceClient extends ApiClient {
         };
         try {
             const response = await this.httpClient.call(requestOpts);
-            return parseDateFields(pluckData(response.data));
+            return parseResponse(response, schema);
         }
         catch (err) {
             catchNotFoundOrThrow(err);
         }
         return undefined;
     }
-    async _update(newFields, timeoutMillis) {
+    async _update(schema, newFields, timeoutMillis) {
         const response = await this.httpClient.call({
             url: this._url(),
             method: 'PUT',
@@ -39,7 +39,7 @@ export class ResourceClient extends ApiClient {
             data: newFields,
             timeout: timeoutMillis,
         });
-        return parseDateFields(pluckData(response.data));
+        return parseResponse(response, schema);
     }
     async _delete(timeoutMillis) {
         try {
@@ -58,7 +58,7 @@ export class ResourceClient extends ApiClient {
      * This function is used in Build and Run endpoints so it's kept
      * here to stay DRY.
      */
-    async _waitForFinish(options = {}) {
+    async _waitForFinish(schema, options = {}) {
         const { waitSecs = MAX_WAIT_FOR_FINISH } = options;
         const waitMillis = waitSecs * 1000;
         let job;
@@ -81,7 +81,7 @@ export class ResourceClient extends ApiClient {
             };
             try {
                 const response = await this.httpClient.call(requestOpts);
-                job = parseDateFields(pluckData(response.data));
+                job = parseResponse(response, schema);
             }
             catch (err) {
                 catchNotFoundOrThrow(err);

package/dist/base/resource_collection_client.d.ts

@@ -1,3 +1,4 @@
+import type { z } from 'zod';
 import type { PaginatedResponse, PaginationOptions } from '../utils.js';
 import { ApiClient } from './api_client.js';
 /**
@@ -8,11 +9,11 @@ export declare class ResourceCollectionClient extends ApiClient {
     /**
      * @private
      */
-    protected _list<T, R>(options?: T): Promise<R>;
+    protected _list<T, R>(schema: z.ZodType, options?: T): Promise<R>;
     /**
      * Returns async iterator to iterate through all items and Promise that can be awaited to get first page of results.
      */
-    protected _listPaginated<T extends PaginationOptions, Data, R extends PaginatedResponse<Data>>(options?: T): AsyncIterable<Data> & Promise<R>;
-    protected _create<D, R>(resource: D): Promise<R>;
-    protected _getOrCreate<D, R>(name?: string, resource?: D): Promise<R>;
+    protected _listPaginated<T extends PaginationOptions, Data, R extends PaginatedResponse<Data>>(schema: z.ZodType, options?: T): AsyncIterable<Data> & Promise<R>;
+    protected _create<D, R>(schema: z.ZodType, resource: D): Promise<R>;
+    protected _getOrCreate<D, R>(schema: z.ZodType, name?: string, resource?: D): Promise<R>;
 }

package/dist/base/resource_collection_client.js

@@ -1,4 +1,4 @@
-import { parseDateFields, pluckData } from '../utils.js';
+import { parseResponse } from '../utils.js';
 import { ApiClient } from './api_client.js';
 /**
  * Resource collection client.
@@ -8,36 +8,36 @@ export class ResourceCollectionClient extends ApiClient {
     /**
      * @private
      */
-    async _list(options = {}) {
+    async _list(schema, options = {}) {
         const response = await this.httpClient.call({
             url: this._url(),
             method: 'GET',
             params: this._params(options),
         });
-        return parseDateFields(pluckData(response.data));
+        return parseResponse(response, schema);
     }
     /**
      * Returns async iterator to iterate through all items and Promise that can be awaited to get first page of results.
      */
-    _listPaginated(options = {}) {
-        return this._listPaginatedFromCallback((this._list.bind(this)), options);
+    _listPaginated(schema, options = {}) {
+        return this._listPaginatedFromCallback(async (listOptions) => this._list(schema, listOptions), options);
     }
-    async _create(resource) {
+    async _create(schema, resource) {
         const response = await this.httpClient.call({
             url: this._url(),
             method: 'POST',
             params: this._params(),
             data: resource,
         });
-        return parseDateFields(pluckData(response.data));
+        return parseResponse(response, schema);
     }
-    async _getOrCreate(name, resource) {
+    async _getOrCreate(schema, name, resource) {
         const response = await this.httpClient.call({
             url: this._url(),
             method: 'POST',
             params: this._params({ name }),
             data: resource,
         });
-        return parseDateFields(pluckData(response.data));
+        return parseResponse(response, schema);
     }
 }