apify-client 2.23.5-beta.3 → 2.23.5-beta.30

package/dist/apify_api_error.js

@@ -21,11 +21,45 @@ const CLIENT_METHOD_REGEX = /at( async)? ([A-Za-z]+(Collection)?Client)\._?([A-Z
  * needed.
  */
 class ApifyApiError extends Error {
+    name;
+    /**
+     * The invoked resource client and the method. Known issue: Sometimes it displays
+     * as `unknown` because it can't be parsed from a stack trace.
+     */
+    clientMethod;
+    /**
+     * HTTP status code of the error.
+     */
+    statusCode;
+    /**
+     * The type of the error, as returned by the API.
+     */
+    type;
+    /**
+     * Number of the API call attempt.
+     */
+    attempt;
+    /**
+     * HTTP method of the API call.
+     */
+    httpMethod;
+    /**
+     * Full path of the API endpoint (URL excluding origin).
+     */
+    path;
+    /**
+     * Original stack trace of the exception. It is replaced
+     * by a more informative stack with API call information.
+     */
+    originalStack;
+    /**
+     * Additional data provided by the API about the error
+     */
+    data;
     /**
      * @hidden
      */
     constructor(response, attempt) {
-        var _a;
         let message;
         let type;
         let responseData = response.data;
@@ -57,92 +91,12 @@ class ApifyApiError extends Error {
             message = `Unexpected error: ${dataString}`;
         }
         super(message);
-        Object.defineProperty(this, "name", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The invoked resource client and the method. Known issue: Sometimes it displays
-         * as `unknown` because it can't be parsed from a stack trace.
-         */
-        Object.defineProperty(this, "clientMethod", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * HTTP status code of the error.
-         */
-        Object.defineProperty(this, "statusCode", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The type of the error, as returned by the API.
-         */
-        Object.defineProperty(this, "type", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * Number of the API call attempt.
-         */
-        Object.defineProperty(this, "attempt", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * HTTP method of the API call.
-         */
-        Object.defineProperty(this, "httpMethod", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * Full path of the API endpoint (URL excluding origin).
-         */
-        Object.defineProperty(this, "path", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * Original stack trace of the exception. It is replaced
-         * by a more informative stack with API call information.
-         */
-        Object.defineProperty(this, "originalStack", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * Additional data provided by the API about the error
-         */
-        Object.defineProperty(this, "data", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         this.name = this.constructor.name;
         this.clientMethod = this._extractClientAndMethodFromStack();
         this.statusCode = response.status;
         this.type = type;
         this.attempt = attempt;
-        this.httpMethod = (_a = response.config) === null || _a === void 0 ? void 0 : _a.method;
+        this.httpMethod = response.config?.method;
         this.path = this._safelyParsePathFromResponse(response);
         const stack = this.stack;
         this.originalStack = stack.slice(stack.indexOf('\n'));
@@ -150,8 +104,7 @@ class ApifyApiError extends Error {
         this.data = errorData;
     }
     _safelyParsePathFromResponse(response) {
-        var _a;
-        const urlString = (_a = response.config) === null || _a === void 0 ? void 0 : _a.url;
+        const urlString = response.config?.url;
         let url;
         try {
             url = new URL(urlString);

package/dist/apify_client.js

@@ -53,43 +53,13 @@ const DEFAULT_TIMEOUT_SECS = 360;
  * @see https://docs.apify.com/api/v2
  */
 class ApifyClient {
+    baseUrl;
+    publicBaseUrl;
+    token;
+    stats;
+    logger;
+    httpClient;
     constructor(options = {}) {
-        Object.defineProperty(this, "baseUrl", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "publicBaseUrl", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "token", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "stats", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "logger", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "httpClient", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
             baseUrl: ow_1.default.optional.string,
             publicBaseUrl: ow_1.default.optional.string,

package/dist/base/api_client.js

@@ -3,61 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiClient = void 0;
 /** @private */
 class ApiClient {
+    id;
+    safeId;
+    baseUrl;
+    publicBaseUrl;
+    resourcePath;
+    url;
+    apifyClient;
+    httpClient;
+    params;
     constructor(options) {
-        Object.defineProperty(this, "id", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "safeId", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "baseUrl", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "publicBaseUrl", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "resourcePath", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "url", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "apifyClient", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "httpClient", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "params", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         const { baseUrl, publicBaseUrl, apifyClient, httpClient, resourcePath, id, params = {} } = options;
         this.id = id;
         this.safeId = id && this._toSafeId(id);
@@ -116,10 +71,9 @@ class ApiClient {
             limit: minForLimitParam(options.limit, options.chunkSize),
         });
         async function* asyncGenerator() {
-            var _a;
             let currentPage = await paginatedListPromise;
             yield* currentPage.items;
-            const offset = (_a = options.offset) !== null && _a !== void 0 ? _a : 0;
+            const offset = options.offset ?? 0;
             const limit = Math.min(options.limit || currentPage.total, currentPage.total);
             let currentOffset = offset + currentPage.items.length;
             let remainingItems = Math.min(currentPage.total - offset, limit) - currentPage.items.length;

package/dist/bundle.js

@@ -13019,7 +13019,7 @@ class HttpClient {
         this.axios.defaults.httpsAgent = this.httpsAgent;
         // Works only in Node. Cannot be set in browser
         const isAtHome = !!process.env[_apify_consts__rspack_import_1.APIFY_ENV_VARS.IS_AT_HOME];
-        let userAgent = `ApifyClient/${version} (${os.type()}; Node/${process.version}); isAtHome/${isAtHome}`;
+        let userAgent = `ApifyClient/${version} (${os.platform()}; Node/${process.version}); isAtHome/${isAtHome}`;
         if (this.userAgentSuffix) {
             userAgent += `; ${(0,_utils__rspack_import_4.asArray)(this.userAgentSuffix).join('; ')}`;
         }
@@ -13221,13 +13221,13 @@ function ensureHeadersPrototype(config) {
         return typeof value === 'function' ? value.toString() : value;
     });
 }
-async function maybeGzipRequest(config) {
+async function maybeCompressRequest(config) {
     if (config.headers?.['content-encoding']) return config;
-    const maybeZippedData = await (0,_utils__rspack_import_2.maybeGzipValue)(config.data);
-    if (maybeZippedData) {
+    const maybeCompressed = await (0,_utils__rspack_import_2.maybeCompressValue)(config.data);
+    if (maybeCompressed) {
         config.headers ??= {};
-        config.headers['content-encoding'] = 'gzip';
-        config.data = maybeZippedData;
+        config.headers['content-encoding'] = maybeCompressed.encoding;
+        config.data = maybeCompressed.data;
     }
     return config;
 }
@@ -13253,7 +13253,7 @@ function parseResponseData(response) {
     return response;
 }
 const requestInterceptors = [
-    maybeGzipRequest,
+    maybeCompressRequest,
     serializeRequest,
     ensureHeadersPrototype
 ];
@@ -13419,9 +13419,6 @@ __webpack_require__.r(__webpack_exports__);
             params: this._params(params),
             // Apify internal property. Tells the request serialization interceptor
             // to stringify functions to JSON, instead of omitting them.
-            // TODO: remove this ts-expect-error once we migrate HttpClient to TS and define Apify
-            // extension of Axios configs
-            // @ts-expect-error Apify extension
             stringifyFunctions: true
         };
         if (options.contentType) {
@@ -13501,6 +13498,62 @@ __webpack_require__.r(__webpack_exports__);
             await streamedLog?.stop();
         });
     }
+    /**
+     * Validates the provided input for the Actor against its input schema.
+     *
+     * Sends the input to the API, which validates it against the Actor's input schema without
+     * starting a run. If the input is valid, the method resolves with `true`. If the input is
+     * invalid, the API responds with an error that is thrown as an `ApifyApiError` describing the
+     * validation problem.
+     *
+     * @param input - Input to validate against the Actor's input schema. Can be any JSON-serializable
+     *                value (object, array, string, number). If `contentType` is specified in options,
+     *                input should be a string or Buffer.
+     * @param options - Validation options
+     * @param options.build - Tag or number of the build whose input schema the input is validated against
+     *                         (e.g., `'latest'` or `'1.2.345'`). If not provided, uses the default build.
+     * @param options.contentType - Content type of the input. If specified, input must be a string or Buffer.
+     * @returns `true` if the input is valid. Invalid input causes the underlying API call to throw an `ApifyApiError`.
+     * @see https://docs.apify.com/api/v2/act-validate-input-post
+     *
+     * @example
+     * ```javascript
+     * // Validate input against the default build's input schema
+     * const isValid = await client.actor('my-actor').validateInput({ url: 'https://example.com' });
+     *
+     * // Validate against a specific build
+     * const isValid = await client.actor('my-actor').validateInput(
+     *   { url: 'https://example.com' },
+     *   { build: 'beta' },
+     * );
+     * ```
+     */ async validateInput(input) {
+        let options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
+        // input can be anything, so no point in validating it. E.g. if you set content-type to application/pdf
+        // then it will process input as a buffer.
+        ow__rspack_import_11_default()(options, ow__rspack_import_11_default().object.exactShape({
+            build: (ow__rspack_import_11_default().optional.string),
+            contentType: (ow__rspack_import_11_default().optional.string)
+        }));
+        const request = {
+            url: this._url('validate-input'),
+            method: 'POST',
+            data: input,
+            params: this._params({
+                build: options.build
+            }),
+            // Apify internal property. Tells the request serialization interceptor
+            // to stringify functions to JSON, instead of omitting them.
+            stringifyFunctions: true
+        };
+        if (options.contentType) {
+            request.headers = {
+                'content-type': options.contentType
+            };
+        }
+        const response = await this.httpClient.call(request);
+        return response.data.valid;
+    }
     /**
      * Builds the Actor.
      *
@@ -13606,7 +13659,7 @@ __webpack_require__.r(__webpack_exports__);
      */ lastRun() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__rspack_import_11_default()(options, ow__rspack_import_11_default().object.exactShape({
-            status: ow__rspack_import_11_default().optional.string.oneOf(Object.values(_apify_consts__rspack_import_0.ACT_JOB_STATUSES)),
+            status: ow__rspack_import_11_default().optional.string.oneOf(Object.values(_apify_consts__rspack_import_0.ACTOR_JOB_STATUSES)),
             origin: ow__rspack_import_11_default().optional.string.oneOf(Object.values(_apify_consts__rspack_import_0.META_ORIGINS))
         }));
         return new _run__rspack_import_8.RunClient(this._subResourceOptions({
@@ -17908,7 +17961,7 @@ let _computedKey;
 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_GZIP_BYTES = 1024;
+const MIN_COMPRESS_BYTES = 1024;
 /**
  * Returns object's 'data' property or throws if parameter is not an object,
  * or an object without a 'data' property.
@@ -17978,23 +18031,61 @@ const MIN_GZIP_BYTES = 1024;
 }
 let gzipPromisified;
 /**
- * Gzip provided value, otherwise returns undefined.
- */ async function maybeGzipValue(value) {
-    if (!isNode()) return;
-    if (typeof value !== 'string' && !Buffer.isBuffer(value)) return;
-    // Request compression is not that important so let's
-    // skip it instead of throwing for unsupported types.
-    const areDataLargeEnough = Buffer.byteLength(value) >= MIN_GZIP_BYTES;
-    if (areDataLargeEnough) {
-        if (!gzipPromisified) {
-            const { promisify } = await Promise.resolve(/* import() */).then(__webpack_require__.t.bind(__webpack_require__, 6029, 23));
-            const { gzip } = await Promise.resolve(/* import() */).then(__webpack_require__.t.bind(__webpack_require__, 1134, 23));
-            gzipPromisified = promisify(gzip);
+ * Gzip-compress the provided value.
+ */ async function gzipValue(value) {
+    if (!gzipPromisified) {
+        const { promisify } = await Promise.resolve(/* import() */).then(__webpack_require__.t.bind(__webpack_require__, 6029, 23));
+        const { gzip } = await Promise.resolve(/* import() */).then(__webpack_require__.t.bind(__webpack_require__, 1134, 23));
+        gzipPromisified = promisify(gzip);
+    }
+    return gzipPromisified(value);
+}
+// null = confirmed unavailable; undefined = not yet checked
+let brotliCompressPromisified;
+/**
+ * Brotli-compress the provided value, or return undefined if brotli is unavailable
+ * (Node.js < v10.16.0), this is a strict defensive guard.
+ */ async function maybeBrotliValue(value) {
+    if (brotliCompressPromisified === undefined) {
+        const { promisify } = await Promise.resolve(/* import() */).then(__webpack_require__.t.bind(__webpack_require__, 6029, 23));
+        const { brotliCompress, constants } = await Promise.resolve(/* import() */).then(__webpack_require__.t.bind(__webpack_require__, 1134, 23));
+        if (typeof brotliCompress === 'function') {
+            const compress = promisify(brotliCompress);
+            brotliCompressPromisified = async (value)=>compress(value, {
+                    params: {
+                        [constants.BROTLI_PARAM_QUALITY]: 6
+                    }
+                });
+        } else {
+            brotliCompressPromisified = null;
         }
-        return gzipPromisified(value);
+    }
+    if (brotliCompressPromisified !== null) {
+        return brotliCompressPromisified(value);
     }
     return undefined;
 }
+/**
+ * Compress the passed value using brotli if available or using gzip as a fallback. Returns undefined
+ * if the data is too small / wrong type.
+ */ async function maybeCompressValue(value) {
+    if (!isNode()) return undefined;
+    // Request compression is not that important so let's
+    // skip it instead of throwing for unsupported types.
+    if (typeof value !== 'string' && !Buffer.isBuffer(value)) return undefined;
+    const areDataLargeEnough = Buffer.byteLength(value) >= MIN_COMPRESS_BYTES;
+    if (!areDataLargeEnough) return undefined;
+    const brotli = await maybeBrotliValue(value);
+    if (brotli) return {
+        data: brotli,
+        encoding: 'br'
+    };
+    const gzipped = await gzipValue(value);
+    return {
+        data: gzipped,
+        encoding: 'gzip'
+    };
+}
 /**
  * Helper function slice the items from array to fit the max byte length.
  */ function sliceArrayByByteLength(array, maxByteLength, startIndex) {
@@ -18031,7 +18122,7 @@ function isStream(value) {
 function getVersionData() {
     if (true) {
         return {
-            version: "2.23.5-beta.3"
+            version: "2.23.5-beta.30"
         };
     }
     // eslint-disable-next-line
@@ -18126,7 +18217,7 @@ __webpack_require__.d(__webpack_exports__, {
   isBuffer: () => (isBuffer),
   isNode: () => (isNode),
   isStream: () => (isStream),
-  maybeGzipValue: () => (maybeGzipValue),
+  maybeCompressValue: () => (maybeCompressValue),
   parseDateFields: () => (parseDateFields),
   pluckData: () => (pluckData),
   sliceArrayByByteLength: () => (sliceArrayByByteLength),