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

package/dist/utils.js

@@ -1,53 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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;
-exports.stringifyWebhooksToBase64 = stringifyWebhooksToBase64;
-exports.maybeCompressValue = maybeCompressValue;
-exports.sliceArrayByByteLength = sliceArrayByByteLength;
-exports.isNode = isNode;
-exports.isBuffer = isBuffer;
-exports.isStream = isStream;
-exports.getVersionData = getVersionData;
-exports.cast = cast;
-exports.asArray = asArray;
-exports.applyQueryParamsToUrl = applyQueryParamsToUrl;
-exports.toPathSegment = toPathSegment;
-exports.toPath = toPath;
-const zod_1 = require("zod");
-const argument_validation_error_1 = require("./argument_validation_error");
+import { z } from 'zod';
+import { parseArgument } from '@apify/validations';
+// @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;
-// 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;
-}
+export { parseArgument };
 /**
  * Accepts any non-null, non-array object as a predicate for `z.custom()`.
  * @internal
  */
-function isNonArrayObject(value) {
+export function isNonArrayObject(value) {
     return typeof value === 'object' && value !== null && !Array.isArray(value);
 }
 /**
@@ -56,14 +20,14 @@ function isNonArrayObject(value) {
  * the value itself instead of a copy.
  * @internal
  */
-exports.anyObjectSchema = zod_1.z.custom(isNonArrayObject, {
+export const anyObjectSchema = 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.
  */
-function pluckData(obj) {
+export function pluckData(obj) {
     if (typeof obj === 'object' && obj) {
         if (typeof obj.data !== 'undefined')
             return obj.data;
@@ -74,7 +38,7 @@ function pluckData(obj) {
  * If given HTTP error has NOT_FOUND_STATUS_CODE status code then returns undefined.
  * Otherwise rethrows error.
  */
-function catchNotFoundOrThrow(err) {
+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;
@@ -91,7 +55,7 @@ function catchNotFoundOrThrow(err) {
  *
  * If the field cannot be converted to Date, it is left as is.
  */
-function parseDateFields(input, shouldParseField = null, depth = 0) {
+export 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 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
@@ -131,7 +95,7 @@ function parseDateFields(input, shouldParseField = null, depth = 0) {
 /**
  * Helper function that converts array of webhooks to base64 string
  */
-function stringifyWebhooksToBase64(webhooks) {
+export function stringifyWebhooksToBase64(webhooks) {
     if (!webhooks)
         return;
     const webhooksJson = JSON.stringify(webhooks);
@@ -172,7 +136,7 @@ async function gzipValue(value) {
  * Compress the passed value using brotli, falling back to gzip. Returns undefined if the data is
  * too small / wrong type, or if neither algorithm is available.
  */
-async function maybeCompressValue(value) {
+export async function maybeCompressValue(value) {
     if (!isNode())
         return undefined;
     // Request compression is not that important so let's
@@ -201,7 +165,7 @@ async function maybeCompressValue(value) {
 /**
  * Helper function slice the items from array to fit the max byte length.
  */
-function sliceArrayByByteLength(array, maxByteLength, startIndex) {
+export function sliceArrayByByteLength(array, maxByteLength, startIndex) {
     const stringByteLength = (str) => (isNode() ? Buffer.byteLength(str) : new Blob([str]).size);
     const arrayByteLength = stringByteLength(JSON.stringify(array));
     if (arrayByteLength < maxByteLength)
@@ -222,12 +186,12 @@ function sliceArrayByByteLength(array, maxByteLength, startIndex) {
     }
     return slicedArray;
 }
-function isNode() {
+export function isNode() {
     if (typeof BROWSER_BUILD !== 'undefined')
         return false;
     return !!(typeof process !== 'undefined' && process.versions && process.versions.node);
 }
-function isBuffer(value) {
+export function isBuffer(value) {
     // 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))
@@ -237,23 +201,22 @@ function isBuffer(value) {
 function isTagged(value, tag) {
     return Object.prototype.toString.call(value) === `[object ${tag}]`;
 }
-function isStream(value) {
+export function isStream(value) {
     if (value === null || typeof value !== 'object')
         return false;
     const { on, pipe } = value;
     return typeof on === 'function' && typeof pipe === 'function';
 }
-function getVersionData() {
+export function getVersionData() {
     if (typeof BROWSER_BUILD !== 'undefined') {
         return { version: VERSION };
     }
-    // eslint-disable-next-line
-    return require('../package.json');
+    return packageJson;
 }
 /**
  * Helper class to create async iterators from paginated list endpoints with exclusive start key.
  */
-class RequestQueuePaginationIterator {
+export class RequestQueuePaginationIterator {
     maxPageLimit;
     getPage;
     limit;
@@ -293,21 +256,20 @@ 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(),
+export const paginationOptionsShape = {
+    limit: z.number().min(0).optional(),
+    offset: z.number().min(0).optional(),
+    chunkSize: z.number().positive().optional(),
 };
-function cast(input) {
+export function cast(input) {
     return input;
 }
-function asArray(value) {
+export function asArray(value) {
     if (Array.isArray(value)) {
         return value;
     }
@@ -316,7 +278,7 @@ function asArray(value) {
 /**
  * Adds query parameters to a given URL based on the provided options object.
  */
-function applyQueryParamsToUrl(url, options) {
+export function applyQueryParamsToUrl(url, options) {
     for (const [key, value] of Object.entries(options ?? {})) {
         // skip undefined values
         if (value === undefined)
@@ -335,12 +297,11 @@ function applyQueryParamsToUrl(url, options) {
  * is present. Pass the options interface as `T`, so that a misspelled key is a type error.
  * @internal
  */
-const mutuallyExclusive = (...keys) => [
+export 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
+const pathSegmentSchema = z
     .string()
     .nonempty()
     .refine((v) => v !== '.' && v !== '..', { error: 'URL path must not contain dot segments' });
@@ -350,7 +311,7 @@ const pathSegmentSchema = zod_1.z
  * 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) {
+export function toPathSegment(value) {
     const valueParsed = parseArgument(value, pathSegmentSchema);
     return encodeURIComponent(valueParsed);
 }
@@ -358,6 +319,6 @@ function toPathSegment(value) {
  * 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) {
+export function toPath(path) {
     return Array.isArray(path) ? path.map(toPathSegment).join('/') : path;
 }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "apify-client",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.3",
   "description": "Apify API client for JavaScript",
   "engines": {
     "node": ">=22.0.0"
   },
+  "type": "module",
   "main": "dist/index.js",
-  "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "browser": "dist/bundle.js",
   "unpkg": "dist/bundle.js",
@@ -14,10 +14,9 @@
     "./package.json": "./package.json",
     "./browser": "./dist/bundle.js",
     ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
       "types": "./dist/index.d.ts",
-      "browser": "./dist/bundle.js"
+      "browser": "./dist/bundle.js",
+      "default": "./dist/index.js"
     }
   },
   "keywords": [
@@ -58,9 +57,10 @@
     }
   },
   "dependencies": {
-    "@apify/consts": "^2.50.0",
-    "@apify/log": "^2.2.6",
-    "@apify/utilities": "^2.23.2",
+    "@apify/consts": "^3.0.1",
+    "@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",
     "async-retry": "^1.3.3",
@@ -69,12 +69,12 @@
     "proxy-agent": "^6.5.0",
     "tslib": "^2.5.0",
     "type-fest": "^4.0.0",
-    "zod": "^4.0.0"
+    "zod": "^4.5.4"
   },
   "devDependencies": {
     "@apify/oxlint-config": "^0.3.0",
     "@apify/tsconfig": "^0.2.0",
-    "@crawlee/puppeteer": "^3.2.2",
+    "@crawlee/puppeteer": "4.0.0-beta.165",
     "@rsbuild/core": "^2.0.0",
     "@rsbuild/plugin-node-polyfill": "^1.3.0",
     "@rspack/cli": "^2.0.0",
@@ -89,7 +89,6 @@
     "compression": "^1.7.4",
     "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.79.0",
@@ -111,7 +110,6 @@
   },
   "scripts": {
     "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 --project unit",
     "test:integration": "vitest run --project integration",

package/dist/argument_validation_error.d.ts

@@ -1,17 +0,0 @@
-import type { z } from 'zod';
-/**
- * Thrown when an argument fails schema validation.
- *
- * Its `message` is a human-readable sentence naming the offending field and the
- * value it received (rather than a raw JSON dump). The structured
- * {@link https://zod.dev | zod} issues are available on `issues`, and the
- * original `ZodError` on `cause`, for programmatic inspection.
- *
- * `apify-client` sits below `@crawlee/core` and the Apify SDK in the dependency
- * graph, so it defines its own error type rather than importing one from them.
- */
-export declare class ArgumentValidationError extends Error {
-    /** Structured issues from the underlying schema check. */
-    readonly issues: z.ZodError['issues'];
-    constructor(error: z.ZodError, value: unknown, label?: string);
-}

package/dist/argument_validation_error.js

@@ -1,157 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArgumentValidationError = void 0;
-/** Formats a zod issue path like `groups[0]` or `countryCode`. */
-function formatIssuePath(path) {
-    let out = '';
-    for (const key of path) {
-        if (typeof key === 'number')
-            out += `[${key}]`;
-        else
-            out += out ? `.${String(key)}` : String(key);
-    }
-    return out;
-}
-/** Reads the value at `path` from the validated input, to include in the error. */
-function valueAtPath(root, path) {
-    let current = root;
-    for (const key of path) {
-        if (current === null || typeof current !== 'object')
-            return undefined;
-        current = current[key];
-    }
-    return current;
-}
-/**
- * How much of a received string the message renders. A rejected argument can be arbitrarily large - a
- * whole JSON payload passed where an object was expected - and its full text would swamp the message.
- */
-const MAX_RECEIVED_STRING_LENGTH = 80;
-/** Renders a primitive received value for an error; skips objects/Dates (noisy). */
-function describeReceived(value) {
-    switch (typeof value) {
-        case 'string':
-            // An empty string would render as bare backticks - make it visible.
-            if (value === '')
-                return "''";
-            return value.length > MAX_RECEIVED_STRING_LENGTH
-                ? `${value.slice(0, MAX_RECEIVED_STRING_LENGTH)}...`
-                : value;
-        case 'number':
-        case 'boolean':
-            return String(value);
-        case 'bigint':
-            // Keep the `n` suffix, so a rejected bigint is not mistaken for a number.
-            return `${value}n`;
-        default:
-            return undefined;
-    }
-}
-/**
- * Renders the issue's own sentence, except where zod's contradicts itself: a value of the expected type
- * that fails that type's implicit constraint is still reported as the wrong *type*, giving "expected
- * number, received number" for `Infinity` / `NaN` and "expected date, received Date" for an invalid
- * `Date`. Name the constraint that actually failed instead.
- */
-function describeIssue(issue, value) {
-    if (issue.code === 'invalid_type') {
-        if (issue.expected === 'number' && typeof value === 'number') {
-            return 'Invalid input: expected a finite number';
-        }
-        // A tag check, not `instanceof`, so a `Date` from another realm is named too.
-        if (issue.expected === 'date' && Object.prototype.toString.call(value) === '[object Date]') {
-            return 'Invalid input: expected a valid date';
-        }
-    }
-    return issue.message;
-}
-/**
- * How many issue lines the message renders, before a closing "... and N more" line. Validating a
- * large array - a dataset push, a request batch - can fail on every element, and rendering all of
- * them would make the message megabytes long. The full set stays on `issues` either way.
- */
-const MAX_RENDERED_LINES = 10;
-/**
- * How deep into the value the lines for `issue` would sit, as a path length. Computed without
- * rendering anything, so a union can weigh its arms before any string is built.
- */
-function deepestIssueDepth(issue, baseDepth) {
-    const depth = baseDepth + issue.path.length;
-    if (issue.code === 'invalid_union') {
-        let deepest = -1;
-        for (const arm of issue.errors) {
-            for (const nested of arm)
-                deepest = Math.max(deepest, deepestIssueDepth(nested, depth));
-        }
-        return deepest;
-    }
-    return depth;
-}
-/** Collects one line per issue into `lines`; a union expands into a line per deepest-failing arm. */
-function collectIssueLines(issue, root, basePath, lines, counter) {
-    const path = [...basePath, ...issue.path];
-    // A union's own message is a bare "Invalid input" - the useful part is in `errors`,
-    // whose paths are relative to the union, hence passing `path` down as the base.
-    if (issue.code === 'invalid_union') {
-        // Only the arms that reached deepest are reported. An arm that failed nearer the root rejected a
-        // shape the value never had - for `[{ ok: 1 }, 2]` against `object | string | array`, the object
-        // and string arms fail on the whole array, and only the array arm can point at `[1]`. When every
-        // arm fails at the same depth, as for an argument of an outright wrong type, they are all kept.
-        const armDepths = issue.errors.map((arm) => arm.reduce((deepest, nested) => Math.max(deepest, deepestIssueDepth(nested, path.length)), -1));
-        const deepest = Math.max(...armDepths);
-        for (const [index, arm] of issue.errors.entries()) {
-            if (armDepths[index] !== deepest)
-                continue;
-            for (const nested of arm)
-                collectIssueLines(nested, root, path, lines, counter);
-        }
-        return;
-    }
-    counter.total += 1;
-    if (lines.length >= MAX_RENDERED_LINES)
-        return;
-    const location = path.length ? ` at \`${formatIssuePath(path)}\`` : '';
-    const value = valueAtPath(root, path);
-    const received = describeReceived(value);
-    const got = received === undefined ? '' : `, got \`${received}\``;
-    lines.push(`${describeIssue(issue, value)}${location}${got}`);
-}
-/**
- * Formats a `ZodError` as a plain, human-readable message that names the
- * offending field *and* the value it received (e.g. ``must match pattern
- * /^[A-Z]{2}$/ at `countryCode`, got `CZE` ``) - closer to the old `ow` errors
- * than zod's default, which omits the received value.
- */
-function formatZodError(error, root, label) {
-    const lines = [];
-    const counter = { total: 0 };
-    for (const issue of error.issues)
-        collectIssueLines(issue, root, [], lines, counter);
-    // The label names the validated interface, the way ow's errors ended with "in object `X`".
-    const rendered = label ? lines.map((line) => `${line} in \`${label}\``) : [...lines];
-    const hidden = counter.total - lines.length;
-    if (hidden > 0)
-        rendered.push(`... and ${hidden} more problem${hidden === 1 ? '' : 's'}`);
-    return rendered.join('\n');
-}
-/**
- * Thrown when an argument fails schema validation.
- *
- * Its `message` is a human-readable sentence naming the offending field and the
- * value it received (rather than a raw JSON dump). The structured
- * {@link https://zod.dev | zod} issues are available on `issues`, and the
- * original `ZodError` on `cause`, for programmatic inspection.
- *
- * `apify-client` sits below `@crawlee/core` and the Apify SDK in the dependency
- * graph, so it defines its own error type rather than importing one from them.
- */
-class ArgumentValidationError extends Error {
-    /** Structured issues from the underlying schema check. */
-    issues;
-    constructor(error, value, label) {
-        super(formatZodError(error, value, label), { cause: error });
-        this.name = 'ArgumentValidationError';
-        this.issues = error.issues;
-    }
-}
-exports.ArgumentValidationError = ArgumentValidationError;

package/dist/index.mjs

@@ -1,42 +0,0 @@
-import mod from "./index.js";
-
-export default mod;
-export const ActorClient = mod.ActorClient;
-export const ActorCollectionClient = mod.ActorCollectionClient;
-export const ActorEnvVarClient = mod.ActorEnvVarClient;
-export const ActorEnvVarCollectionClient = mod.ActorEnvVarCollectionClient;
-export const ActorListSortBy = mod.ActorListSortBy;
-export const ActorSourceType = mod.ActorSourceType;
-export const ActorVersionClient = mod.ActorVersionClient;
-export const ActorVersionCollectionClient = mod.ActorVersionCollectionClient;
-export const ApifyApiError = mod.ApifyApiError;
-export const ApifyClient = mod.ApifyClient;
-export const ArgumentValidationError = mod.ArgumentValidationError;
-export const BuildClient = mod.BuildClient;
-export const BuildCollectionClient = mod.BuildCollectionClient;
-export const DatasetClient = mod.DatasetClient;
-export const DatasetCollectionClient = mod.DatasetCollectionClient;
-export const DownloadItemsFormat = mod.DownloadItemsFormat;
-export const InvalidResponseBodyError = mod.InvalidResponseBodyError;
-export const KeyValueStoreClient = mod.KeyValueStoreClient;
-export const KeyValueStoreCollectionClient = mod.KeyValueStoreCollectionClient;
-export const LogClient = mod.LogClient;
-export const LoggerActorRedirect = mod.LoggerActorRedirect;
-export const PlatformFeature = mod.PlatformFeature;
-export const RequestQueueClient = mod.RequestQueueClient;
-export const RequestQueueCollectionClient = mod.RequestQueueCollectionClient;
-export const RunClient = mod.RunClient;
-export const RunCollectionClient = mod.RunCollectionClient;
-export const ScheduleActions = mod.ScheduleActions;
-export const ScheduleClient = mod.ScheduleClient;
-export const ScheduleCollectionClient = mod.ScheduleCollectionClient;
-export const StoreCollectionClient = mod.StoreCollectionClient;
-export const StreamedLog = mod.StreamedLog;
-export const TaskClient = mod.TaskClient;
-export const TaskCollectionClient = mod.TaskCollectionClient;
-export const UserClient = mod.UserClient;
-export const WebhookClient = mod.WebhookClient;
-export const WebhookCollectionClient = mod.WebhookCollectionClient;
-export const WebhookDispatchClient = mod.WebhookDispatchClient;
-export const WebhookDispatchCollectionClient = mod.WebhookDispatchCollectionClient;
-export const WebhookDispatchStatus = mod.WebhookDispatchStatus;