apify-client 3.0.0-beta.4 → 3.0.0-beta.6

package/dist/schemas.js

@@ -0,0 +1,15 @@
+/**
+ * The schemas the resource clients validate API responses with.
+ *
+ * Today these are exactly the generated ones. The module still exists as the one place where a generated
+ * schema is widened when the API is known to return something the specification does not describe, so a
+ * documented deviation never sends a resource client reaching into `./generated` directly. An override
+ * declared here shadows the generated export of the same name and takes the same form, a `lazySchema()` thunk
+ * built on the generated schema it replaces. Every schema that embeds an overridden one has to be rebuilt on
+ * top of it, and `spec_guards.ts` checks that each override still accepts what the specification describes,
+ * so one cannot narrow by accident.
+ *
+ * Spec gaps need no override: the generated objects are loose, so a field the specification omits passes
+ * through. Neither do client narrowings: a schema only ever accepts more than the published type.
+ */
+export * from './generated/schemas.js';

package/dist/utils.d.ts

@@ -3,6 +3,7 @@ import type { JsonValue, TypedArray } from 'type-fest';
 import { z } from 'zod';
 import type { ApifyApiError } from './apify_api_error.js';
 import { parseArgument } from '@apify/validations';
+import type { ApifyResponse } from './http_client.js';
 import type { RequestQueueClientListRequestsOptions, RequestQueueClientListRequestsResult } from './resource_clients/request_queue.js';
 import type { WebhookUpdateData } from './resource_clients/webhook.js';
 export { parseArgument };
@@ -26,14 +27,23 @@ export declare const anyObjectSchema: z.ZodCustom<Record<string, unknown>, Recor
 export interface MaybeData<R> {
     data?: R;
 }
+/**
+ * Turns a JSON API response into the value a resource method returns: unwraps the `data` envelope, converts the
+ * date fields and validates the result against `schema`, one of the schemas generated from the OpenAPI
+ * specification. The validated copy is what callers get, so it is exactly what the schema accepted -- unknown
+ * fields and unknown enum values included, since the schemas let both through.
+ *
+ * Throws {@link ResponseValidationError} when the response does not match the specification.
+ * @internal
+ */
+export declare function parseResponse<R>(response: ApifyResponse, schema: z.ZodType, shouldParseField?: ((key: string) => boolean) | null): R;
 /**
  * Returns object's 'data' property or throws if parameter is not an object,
  * or an object without a 'data' property.
  */
 export declare function pluckData<R>(obj: MaybeData<R>): R;
 /**
- * If given HTTP error has NOT_FOUND_STATUS_CODE status code then returns undefined.
- * Otherwise rethrows error.
+ * Swallows a 404 Not Found API error and rethrows anything else.
  */
 export declare function catchNotFoundOrThrow(err: ApifyApiError): void;
 type ReturnJsonValue = string | number | boolean | null | Date | ReturnJsonObject | ReturnJsonArray;

package/dist/utils.js

@@ -1,10 +1,9 @@
 import { z } from 'zod';
+import { NotFoundError } from './apify_api_error.js';
 import { parseArgument } from '@apify/validations';
+import { ResponseValidationError } from './response_validation_error.js';
 // @ts-ignore if we enable `resolveJsonModule`, we end up with a `src` folder in `dist`
 import packageJson from '../package.json' with { type: 'json' };
-const NOT_FOUND_STATUS_CODE = 404;
-const RECORD_NOT_FOUND_TYPE = 'record-not-found';
-const RECORD_OR_TOKEN_NOT_FOUND_TYPE = 'record-or-token-not-found';
 const MIN_COMPRESS_BYTES = 1024;
 export { parseArgument };
 /**
@@ -23,6 +22,28 @@ export function isNonArrayObject(value) {
 export const anyObjectSchema = z.custom(isNonArrayObject, {
     error: 'Invalid input: expected an object',
 });
+// Zod installs its English locale as a module-level side effect but ships `"sideEffects": false`, so
+// any tree-shaking bundler drops it and every message degrades to a bare "Invalid input". Passing it
+// in per parse keeps them intact without reaching into the zod config the whole process shares.
+const { localeError } = z.locales.en();
+/**
+ * Turns a JSON API response into the value a resource method returns: unwraps the `data` envelope, converts the
+ * date fields and validates the result against `schema`, one of the schemas generated from the OpenAPI
+ * specification. The validated copy is what callers get, so it is exactly what the schema accepted -- unknown
+ * fields and unknown enum values included, since the schemas let both through.
+ *
+ * Throws {@link ResponseValidationError} when the response does not match the specification.
+ * @internal
+ */
+export function parseResponse(response, schema, shouldParseField = null) {
+    const data = parseDateFields(pluckData(response.data), shouldParseField);
+    const result = schema.safeParse(data, { error: localeError });
+    if (!result.success) {
+        const { method = 'GET', url = '' } = response.config;
+        throw new ResponseValidationError(result.error, data, { method, url });
+    }
+    return result.data;
+}
 /**
  * Returns object's 'data' property or throws if parameter is not an object,
  * or an object without a 'data' property.
@@ -35,14 +56,10 @@ export function pluckData(obj) {
     throw new Error(`Expected response object with a "data" property, but received: ${obj}`);
 }
 /**
- * If given HTTP error has NOT_FOUND_STATUS_CODE status code then returns undefined.
- * Otherwise rethrows error.
+ * Swallows a 404 Not Found API error and rethrows anything else.
  */
 export function catchNotFoundOrThrow(err) {
-    const isNotFoundStatus = err.statusCode === NOT_FOUND_STATUS_CODE;
-    const isNotFoundMessage = err.type === RECORD_NOT_FOUND_TYPE || err.type === RECORD_OR_TOKEN_NOT_FOUND_TYPE || err.httpMethod === 'head';
-    const isNotFoundError = isNotFoundStatus && isNotFoundMessage;
-    if (!isNotFoundError)
+    if (!(err instanceof NotFoundError))
         throw err;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-client",
-  "version": "3.0.0-beta.4",
+  "version": "3.0.0-beta.6",
   "description": "Apify API client for JavaScript",
   "engines": {
     "node": ">=22.0.0"
@@ -53,7 +53,7 @@
   ],
   "apify": {
     "openapiSpec": {
-      "version": "v2-2026-08-03T111309Z"
+      "version": "v2-2026-08-31T125154Z"
     }
   },
   "dependencies": {
@@ -126,6 +126,6 @@
     "build:node": "tsc",
     "build:browser": "rsbuild build",
     "spec:fetch": "node scripts/openapi_spec.mts fetch",
-    "generate:types": "node scripts/openapi_spec.mts fetch && node scripts/generate_types.mts && node scripts/openapi_spec.mts record-version"
+    "generate:models": "node scripts/openapi_spec.mts fetch && node scripts/generate_types.mts && node scripts/generate_schemas.mts && node scripts/openapi_spec.mts record-version"
   }
 }