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

package/dist/utils.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mutuallyExclusive = exports.RequestQueuePaginationIterator = void 0;
+exports.mutuallyExclusive = exports.paginationOptionsShape = exports.RequestQueuePaginationIterator = exports.anyObjectSchema = void 0;
+exports.parseArgument = parseArgument;
+exports.isNonArrayObject = isNonArrayObject;
 exports.pluckData = pluckData;
 exports.catchNotFoundOrThrow = catchNotFoundOrThrow;
 exports.parseDateFields = parseDateFields;
@@ -14,12 +16,49 @@ exports.getVersionData = getVersionData;
 exports.cast = cast;
 exports.asArray = asArray;
 exports.applyQueryParamsToUrl = applyQueryParamsToUrl;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
+exports.toPathSegment = toPathSegment;
+exports.toPath = toPath;
+const zod_1 = require("zod");
+const argument_validation_error_1 = require("./argument_validation_error");
 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;
+// 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 } = zod_1.z.locales.en();
+/**
+ * Parses `value` with `schema`, returning the typed result (with schema defaults applied).
+ * Throws {@link ArgumentValidationError} on failure.
+ *
+ * The optional `label` names the interface being validated and is appended to every error line
+ * (e.g. ``... at `memory` in `ActorStartOptions` ``).
+ * @internal
+ */
+function parseArgument(value, schema, label) {
+    const result = schema.safeParse(value, { error: localeError });
+    if (!result.success) {
+        throw new argument_validation_error_1.ArgumentValidationError(result.error, value, label);
+    }
+    return result.data;
+}
+/**
+ * Accepts any non-null, non-array object as a predicate for `z.custom()`.
+ * @internal
+ */
+function isNonArrayObject(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+/**
+ * Matches any plain object, letting unknown keys through - for payloads whose shape the API
+ * validates itself. A `z.custom()` predicate rather than an object schema, so parsing returns
+ * the value itself instead of a copy.
+ * @internal
+ */
+exports.anyObjectSchema = zod_1.z.custom(isNonArrayObject, {
+    error: 'Invalid input: expected an object',
+});
 /**
  * Returns object's 'data' property or throws if parameter is not an object,
  * or an object without a 'data' property.
@@ -53,10 +92,16 @@ function catchNotFoundOrThrow(err) {
  * If the field cannot be converted to Date, it is left as is.
  */
 function parseDateFields(input, shouldParseField = null, depth = 0) {
-    // Don't go too deep to avoid stack overflows (especially if there is a circular reference). The depth of 3
-    // corresponds to obj.data.someArrayField.[x].field and should be generally enough.
+    // Don't go too deep to avoid stack overflows (especially if there is a circular reference). The depth of 4
+    // corresponds to obj.items.[x].someArrayField.[y].field, which is what a list response looks like: it
+    // nests one level deeper than the single resource it wraps, because both the item array and the nested
+    // array spend a level.
+    //
+    // In a list response it also reaches one level into caller-owned blobs the API stores verbatim, so a
+    // listed request's `userData.foo.somethingAt` comes back as a `Date` rather than the string it was
+    // written as.
     // TODO: Consider removing this limitation. It might came across as an annoying surprise as it's not communicated.
-    if (depth > 3) {
+    if (depth > 4) {
         return input;
     }
     if (Array.isArray(input))
@@ -183,10 +228,20 @@ function isNode() {
     return !!(typeof process !== 'undefined' && process.versions && process.versions.node);
 }
 function isBuffer(value) {
-    return ow_1.default.isValid(value, ow_1.default.any(ow_1.default.buffer, ow_1.default.arrayBuffer, ow_1.default.typedArray));
+    // Tag checks rather than `instanceof`, to also match buffers from another realm. `isView()`
+    // additionally covers `DataView`, which is not raw binary content.
+    if (ArrayBuffer.isView(value))
+        return !isTagged(value, 'DataView');
+    return isTagged(value, 'ArrayBuffer');
+}
+function isTagged(value, tag) {
+    return Object.prototype.toString.call(value) === `[object ${tag}]`;
 }
 function isStream(value) {
-    return ow_1.default.isValid(value, ow_1.default.object.hasKeys('on', 'pipe'));
+    if (value === null || typeof value !== 'object')
+        return false;
+    const { on, pipe } = value;
+    return typeof on === 'function' && typeof pipe === 'function';
 }
 function getVersionData() {
     if (typeof BROWSER_BUILD !== 'undefined') {
@@ -239,6 +294,16 @@ class RequestQueuePaginationIterator {
     }
 }
 exports.RequestQueuePaginationIterator = RequestQueuePaginationIterator;
+/**
+ * Schema shape of {@link PaginationOptions}, to spread into every paginating client's list schema. One
+ * copy stops it drifting from the interface.
+ * @internal
+ */
+exports.paginationOptionsShape = {
+    limit: zod_1.z.number().min(0).optional(),
+    offset: zod_1.z.number().min(0).optional(),
+    chunkSize: zod_1.z.number().positive().optional(),
+};
 function cast(input) {
     return input;
 }
@@ -265,11 +330,34 @@ function applyQueryParamsToUrl(url, options) {
     }
     return url;
 }
-const mutuallyExclusive = (...keys) => (value) => {
-    const presentKeys = keys.filter((key) => typeof value[key] !== 'undefined');
-    return {
-        validator: presentKeys.length <= 1,
-        message: `At most one of the following fields is allowed: ${keys.join(', ')}`,
-    };
-};
+/**
+ * Builds a `[check, message]` pair to spread into `.refine()`, asserting that at most one of `keys`
+ * is present. Pass the options interface as `T`, so that a misspelled key is a type error.
+ * @internal
+ */
+const mutuallyExclusive = (...keys) => [
+    (value) => keys.filter((key) => typeof value[key] !== 'undefined').length <= 1,
+    `At most one of the following fields is allowed: ${keys.join(', ')}`,
+];
 exports.mutuallyExclusive = mutuallyExclusive;
+const pathSegmentSchema = zod_1.z
+    .string()
+    .nonempty()
+    .refine((v) => v !== '.' && v !== '..', { error: 'URL path must not contain dot segments' });
+/**
+ * Percent-encodes a caller-supplied URL path segment so it cannot restructure the request path.
+ *
+ * Empty strings and dot segments are rejected instead of encoded, because URL parsers resolve
+ * dot segments after decoding - `records/%2E%2E` collapses to the parent endpoint just like `records/..`.
+ */
+function toPathSegment(value) {
+    const valueParsed = parseArgument(value, pathSegmentSchema);
+    return encodeURIComponent(valueParsed);
+}
+/**
+ * Builds a URL path from segments. A plain string is used as-is, so literal paths such as
+ * `requests/batch` keep their separators; an array has each of its segments encoded individually.
+ */
+function toPath(path) {
+    return Array.isArray(path) ? path.map(toPathSegment).join('/') : path;
+}

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "apify-client",
-  "version": "2.25.1-beta.8",
+  "version": "3.0.0-beta.1",
   "description": "Apify API client for JavaScript",
+  "engines": {
+    "node": ">=22.0.0"
+  },
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -46,8 +49,14 @@
   "homepage": "https://docs.apify.com/api/client/js/",
   "files": [
     "dist",
-    "!dist/*.tsbuildinfo"
+    "!dist/*.tsbuildinfo",
+    "!dist/spec_guards.*"
   ],
+  "apify": {
+    "openapiSpec": {
+      "version": "v2-2026-08-03T111309Z"
+    }
+  },
   "dependencies": {
     "@apify/consts": "^2.50.0",
     "@apify/log": "^2.2.6",
@@ -57,10 +66,10 @@
     "async-retry": "^1.3.3",
     "axios": "^1.16.0",
     "content-type": "^1.0.5",
-    "ow": "^0.28.2",
     "proxy-agent": "^6.5.0",
     "tslib": "^2.5.0",
-    "type-fest": "^4.0.0"
+    "type-fest": "^4.0.0",
+    "zod": "^4.0.0"
   },
   "devDependencies": {
     "@apify/oxlint-config": "^0.3.0",
@@ -81,8 +90,9 @@
     "esbuild": "0.28.2",
     "express": "^5.0.0",
     "gen-esm-wrapper": "^1.1.2",
+    "openapi-typescript": "7.13.0",
     "oxfmt": "0.65.0",
-    "oxlint": "1.80.0",
+    "oxlint": "1.79.0",
     "oxlint-tsgolint": "7.0.2001",
     "puppeteer": "^25.0.0",
     "rimraf": "^6.0.0",
@@ -103,16 +113,21 @@
     "build": "pnpm clean && pnpm build:node && pnpm build:browser",
     "postbuild": "gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf dist tsconfig.tsbuildinfo",
-    "test": "pnpm build && vitest run",
+    "test": "pnpm build && vitest run --project unit",
+    "test:integration": "vitest run --project integration",
+    "test:all": "pnpm build && vitest run",
     "test:bundling": "pnpm build && pnpm --prefix=./test/bundling run bundle:all",
     "lint": "oxlint --type-aware",
     "lint:fix": "oxlint --type-aware --fix",
     "tsc-check-tests": "tsc --noEmit --project test/tsconfig.json",
+    "tsc-check-scripts": "tsc --noEmit --project tsconfig.scripts.json",
     "format": "oxfmt",
     "format:check": "oxfmt --check",
     "api:extract": "pnpm build && pnpm dlx github:apify/api-extractor-report --packages=. --extract-command='pnpm api:extract'",
     "api:check": "pnpm dlx github:apify/api-extractor-report --packages=. --extract-command='pnpm api:extract' --verify",
     "build:node": "tsc",
-    "build:browser": "rsbuild build"
+    "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"
   }
 }