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

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,6 +27,16 @@ 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.

package/dist/utils.js

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 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;
@@ -23,6 +24,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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-client",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.5",
   "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": {
@@ -61,45 +61,45 @@
     "@apify/log": "^3.0.1",
     "@apify/utilities": "^3.0.1",
     "@apify/validations": "^1.1.0",
-    "@crawlee/types": "^3.3.0",
-    "ansi-colors": "^4.1.1",
+    "@crawlee/types": "^3.18.1",
+    "ansi-colors": "^4.1.3",
     "async-retry": "^1.3.3",
-    "axios": "^1.16.0",
+    "axios": "^1.20.0",
     "content-type": "^1.0.5",
     "proxy-agent": "^6.5.0",
-    "tslib": "^2.5.0",
-    "type-fest": "^4.0.0",
+    "tslib": "^2.8.1",
+    "type-fest": "^4.41.0",
     "zod": "^4.5.4"
   },
   "devDependencies": {
     "@apify/oxlint-config": "^0.3.0",
     "@apify/tsconfig": "^0.2.0",
     "@crawlee/puppeteer": "4.0.0-beta.165",
-    "@rsbuild/core": "^2.0.0",
-    "@rsbuild/plugin-node-polyfill": "^1.3.0",
-    "@rspack/cli": "^2.0.0",
-    "@rspack/core": "^2.0.0",
-    "@types/async-retry": "^1.4.5",
+    "@rsbuild/core": "^2.2.3",
+    "@rsbuild/plugin-node-polyfill": "^1.4.6",
+    "@rspack/cli": "^2.2.2",
+    "@rspack/core": "^2.2.2",
+    "@types/async-retry": "^1.4.9",
     "@types/compression": "^1.8.1",
-    "@types/content-type": "^1.1.5",
-    "@types/express": "^5.0.0",
-    "@types/node": "^24.0.0",
-    "ajv": "^8.17.1",
-    "body-parser": "^2.0.0",
-    "compression": "^1.7.4",
+    "@types/content-type": "^1.1.9",
+    "@types/express": "^5.0.6",
+    "@types/node": "^24.13.3",
+    "ajv": "^8.20.0",
+    "body-parser": "^2.3.0",
+    "compression": "^1.8.1",
     "esbuild": "0.28.2",
-    "express": "^5.0.0",
+    "express": "^5.2.1",
     "openapi-typescript": "7.13.0",
-    "oxfmt": "0.65.0",
-    "oxlint": "1.79.0",
+    "oxfmt": "0.66.0",
+    "oxlint": "1.81.0",
     "oxlint-tsgolint": "7.0.2001",
-    "puppeteer": "^25.0.0",
-    "rimraf": "^6.0.0",
-    "rolldown": "^1.0.0-rc.4",
-    "typescript": "^6.0.0",
-    "vitest": "^4.0.16",
-    "webpack": "^5.105.2",
-    "webpack-cli": "^7.0.0"
+    "puppeteer": "^25.10.0",
+    "rimraf": "^6.1.3",
+    "rolldown": "^1.2.7",
+    "typescript": "^6.0.3",
+    "vitest": "^5.0.0",
+    "webpack": "^5.110.3",
+    "webpack-cli": "^7.2.3"
   },
   "devEngines": {
     "packageManager": {
@@ -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"
   }
 }