apify-client 2.23.5-beta.24 → 2.23.5-beta.26

package/dist/http_client.js

@@ -122,7 +122,7 @@ class HttpClient {
         this.axios.defaults.httpsAgent = this.httpsAgent;
         // Works only in Node. Cannot be set in browser
         const isAtHome = !!process.env[consts_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_1.asArray)(this.userAgentSuffix).join('; ')}`;
         }

package/dist/interceptors.js

@@ -69,14 +69,14 @@ function stringifyWithFunctions(obj) {
         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_1.maybeGzipValue)(config.data);
-    if (maybeZippedData) {
+    const maybeCompressed = await (0, utils_1.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;
 }
@@ -103,7 +103,7 @@ function parseResponseData(response) {
     return response;
 }
 exports.requestInterceptors = [
-    maybeGzipRequest,
+    maybeCompressRequest,
     serializeRequest,
     ensureHeadersPrototype,
 ];

package/dist/resource_clients/actor.d.ts

@@ -149,7 +149,7 @@ export declare class ActorClient extends ResourceClient {
      *                         (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-input-validate-post
+     * @see https://docs.apify.com/api/v2/act-validate-input-post
      *
      * @example
      * ```javascript

package/dist/resource_clients/actor.js

@@ -234,7 +234,7 @@ class ActorClient extends resource_client_1.ResourceClient {
      *                         (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-input-validate-post
+     * @see https://docs.apify.com/api/v2/act-validate-input-post
      *
      * @example
      * ```javascript

package/dist/utils.d.ts

@@ -41,10 +41,15 @@ export declare function parseDateFields(input: JsonValue, shouldParseField?: ((k
  * Helper function that converts array of webhooks to base64 string
  */
 export declare function stringifyWebhooksToBase64(webhooks: WebhookUpdateData[]): string | undefined;
+export interface CompressedValue {
+    data: Buffer;
+    encoding: 'br' | 'gzip';
+}
 /**
- * Gzip provided value, otherwise returns 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.
  */
-export declare function maybeGzipValue(value: unknown): Promise<Buffer | undefined>;
+export declare function maybeCompressValue(value: unknown): Promise<CompressedValue | undefined>;
 /**
  * Helper function slice the items from array to fit the max byte length.
  */

package/dist/utils.js

@@ -5,7 +5,7 @@ exports.pluckData = pluckData;
 exports.catchNotFoundOrThrow = catchNotFoundOrThrow;
 exports.parseDateFields = parseDateFields;
 exports.stringifyWebhooksToBase64 = stringifyWebhooksToBase64;
-exports.maybeGzipValue = maybeGzipValue;
+exports.maybeCompressValue = maybeCompressValue;
 exports.sliceArrayByByteLength = sliceArrayByByteLength;
 exports.isNode = isNode;
 exports.isBuffer = isBuffer;
@@ -19,7 +19,7 @@ const ow_1 = tslib_1.__importDefault(require("ow"));
 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.
@@ -99,26 +99,59 @@ function stringifyWebhooksToBase64(webhooks) {
 }
 let gzipPromisified;
 /**
- * Gzip provided value, otherwise returns undefined.
+ * Gzip-compress the provided value.
  */
-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 import('node:util');
-            const { gzip } = await import('node:zlib');
-            gzipPromisified = promisify(gzip);
+async function gzipValue(value) {
+    if (!gzipPromisified) {
+        const { promisify } = await import('node:util');
+        const { gzip } = await import('node:zlib');
+        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 import('node:util');
+        const { brotliCompress, constants } = await import('node:zlib');
+        if (typeof brotliCompress === 'function') {
+            const compress = promisify(brotliCompress);
+            brotliCompressPromisified = async (value) => compress(value, { params: { [constants.BROTLI_PARAM_QUALITY]: 6 } });
         }
-        return gzipPromisified(value);
+        else {
+            brotliCompressPromisified = null;
+        }
+    }
+    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.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-client",
-  "version": "2.23.5-beta.24",
+  "version": "2.23.5-beta.26",
   "description": "Apify API client for JavaScript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",