apify-client 3.0.0-beta.7 → 3.0.0-beta.71
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -2
- package/dist/apify_api_error.d.ts +13 -27
- package/dist/apify_api_error.js +33 -23
- package/dist/apify_client.d.ts +125 -10
- package/dist/apify_client.js +133 -48
- package/dist/apify_client_error.d.ts +10 -0
- package/dist/apify_client_error.js +10 -0
- package/dist/base/api_client.d.ts +7 -7
- package/dist/base/api_client.js +36 -36
- package/dist/base/resource_client.d.ts +21 -8
- package/dist/base/resource_client.js +67 -33
- package/dist/base/resource_collection_client.d.ts +12 -4
- package/dist/base/resource_collection_client.js +34 -11
- package/dist/body_parser.d.ts +3 -4
- package/dist/body_parser.js +19 -26
- package/dist/bundle.js +27 -22
- package/dist/bundle.js.map +1 -1
- package/dist/generated/api.d.ts +918 -372
- package/dist/generated/schemas.d.ts +889 -871
- package/dist/generated/schemas.js +234 -209
- package/dist/http_clients/axios.d.ts +60 -0
- package/dist/http_clients/axios.js +117 -0
- package/dist/http_clients/base.d.ts +331 -0
- package/dist/http_clients/base.js +563 -0
- package/dist/http_clients/index.d.ts +4 -0
- package/dist/http_clients/index.js +2 -0
- package/dist/http_compressors/base.d.ts +40 -0
- package/dist/http_compressors/base.js +9 -0
- package/dist/http_compressors/brotli.d.ts +33 -0
- package/dist/http_compressors/brotli.js +39 -0
- package/dist/http_compressors/gzip.d.ts +33 -0
- package/dist/http_compressors/gzip.js +39 -0
- package/dist/http_compressors/index.d.ts +6 -0
- package/dist/http_compressors/index.js +2 -0
- package/dist/http_compressors/resolve.d.ts +23 -0
- package/dist/http_compressors/resolve.js +27 -0
- package/dist/index.d.ts +5 -1
- package/dist/index.js +4 -1
- package/dist/invalid_response_body_error.d.ts +14 -0
- package/dist/invalid_response_body_error.js +18 -0
- package/dist/models.d.ts +167 -194
- package/dist/models.js +6 -4
- package/dist/resource_clients/actor.d.ts +74 -34
- package/dist/resource_clients/actor.js +87 -56
- package/dist/resource_clients/actor_collection.d.ts +18 -12
- package/dist/resource_clients/actor_collection.js +11 -3
- package/dist/resource_clients/actor_env_var.d.ts +11 -4
- package/dist/resource_clients/actor_env_var.js +16 -6
- package/dist/resource_clients/actor_env_var_collection.d.ts +9 -4
- package/dist/resource_clients/actor_env_var_collection.js +11 -4
- package/dist/resource_clients/actor_version.d.ts +20 -5
- package/dist/resource_clients/actor_version.js +19 -9
- package/dist/resource_clients/actor_version_collection.d.ts +11 -4
- package/dist/resource_clients/actor_version_collection.js +13 -4
- package/dist/resource_clients/build.d.ts +20 -7
- package/dist/resource_clients/build.js +35 -15
- package/dist/resource_clients/build_collection.d.ts +7 -5
- package/dist/resource_clients/build_collection.js +4 -1
- package/dist/resource_clients/dataset.d.ts +81 -36
- package/dist/resource_clients/dataset.js +109 -120
- package/dist/resource_clients/dataset_collection.d.ts +10 -6
- package/dist/resource_clients/dataset_collection.js +13 -2
- package/dist/resource_clients/key_value_store.d.ts +101 -23
- package/dist/resource_clients/key_value_store.js +121 -45
- package/dist/resource_clients/key_value_store_collection.d.ts +10 -6
- package/dist/resource_clients/key_value_store_collection.js +13 -2
- package/dist/resource_clients/log.d.ts +40 -21
- package/dist/resource_clients/log.js +144 -66
- package/dist/resource_clients/request_queue.d.ts +76 -31
- package/dist/resource_clients/request_queue.js +178 -93
- package/dist/resource_clients/request_queue_collection.d.ts +9 -5
- package/dist/resource_clients/request_queue_collection.js +9 -3
- package/dist/resource_clients/run.d.ts +119 -28
- package/dist/resource_clients/run.js +190 -49
- package/dist/resource_clients/run_collection.d.ts +5 -3
- package/dist/resource_clients/run_collection.js +4 -1
- package/dist/resource_clients/schedule.d.ts +16 -7
- package/dist/resource_clients/schedule.js +30 -22
- package/dist/resource_clients/schedule_collection.d.ts +6 -2
- package/dist/resource_clients/schedule_collection.js +9 -3
- package/dist/resource_clients/store_collection.d.ts +6 -4
- package/dist/resource_clients/store_collection.js +4 -1
- package/dist/resource_clients/task.d.ts +36 -13
- package/dist/resource_clients/task.js +79 -46
- package/dist/resource_clients/task_collection.d.ts +9 -5
- package/dist/resource_clients/task_collection.js +9 -3
- package/dist/resource_clients/user.d.ts +19 -10
- package/dist/resource_clients/user.js +42 -38
- package/dist/resource_clients/webhook.d.ts +17 -8
- package/dist/resource_clients/webhook.js +30 -22
- package/dist/resource_clients/webhook_collection.d.ts +8 -4
- package/dist/resource_clients/webhook_collection.js +9 -3
- package/dist/resource_clients/webhook_dispatch.d.ts +4 -1
- package/dist/resource_clients/webhook_dispatch.js +7 -2
- package/dist/resource_clients/webhook_dispatch_collection.d.ts +3 -1
- package/dist/resource_clients/webhook_dispatch_collection.js +4 -1
- package/dist/response_validation_error.d.ts +2 -1
- package/dist/response_validation_error.js +2 -1
- package/dist/runtime/node.d.ts +6 -0
- package/dist/runtime/node.js +49 -0
- package/dist/runtime/types.d.ts +52 -0
- package/dist/runtime/types.js +1 -0
- package/dist/runtime/web.d.ts +5 -0
- package/dist/runtime/web.js +18 -0
- package/dist/schemas.d.ts +201 -4
- package/dist/schemas.js +19 -4
- package/dist/statistics.d.ts +1 -6
- package/dist/statistics.js +2 -2
- package/dist/timeouts.d.ts +84 -0
- package/dist/timeouts.js +37 -0
- package/dist/timezones.d.ts +1 -1
- package/dist/utils.d.ts +88 -57
- package/dist/utils.js +219 -157
- package/dist/wait_for_resources.d.ts +8 -0
- package/dist/wait_for_resources.js +39 -0
- package/package.json +32 -29
- package/dist/http_client.d.ts +0 -88
- package/dist/http_client.js +0 -255
- package/dist/interceptors.d.ts +0 -19
- package/dist/interceptors.js +0 -105
package/dist/utils.js
CHANGED
|
@@ -4,7 +4,61 @@ import { parseArgument } from '@apify/validations';
|
|
|
4
4
|
import { ResponseValidationError } from './response_validation_error.js';
|
|
5
5
|
// @ts-ignore if we enable `resolveJsonModule`, we end up with a `src` folder in `dist`
|
|
6
6
|
import packageJson from '../package.json' with { type: 'json' };
|
|
7
|
-
|
|
7
|
+
/**
|
|
8
|
+
* Smallest request body, in bytes, that is worth compressing. A smaller body already fits in a single network
|
|
9
|
+
* packet, so compressing it costs CPU time without saving a round trip, and the compression format itself can
|
|
10
|
+
* make it larger.
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
export const MIN_COMPRESS_BYTES = 1024;
|
|
14
|
+
const textEncoder = new TextEncoder();
|
|
15
|
+
// Only the version, so a bundler can drop the rest of the manifest.
|
|
16
|
+
export const { version } = packageJson;
|
|
17
|
+
/** Media type prefixes whose payloads carry their own compression, so compressing the request body is wasted work. */
|
|
18
|
+
const ALREADY_COMPRESSED_MEDIA_TYPE_PREFIXES = ['audio/', 'image/', 'video/'];
|
|
19
|
+
/** Exact media types whose payloads carry their own compression. */
|
|
20
|
+
const ALREADY_COMPRESSED_MEDIA_TYPES = new Set([
|
|
21
|
+
'application/epub+zip',
|
|
22
|
+
'application/gzip',
|
|
23
|
+
'application/java-archive',
|
|
24
|
+
'application/vnd.android.package-archive',
|
|
25
|
+
'application/vnd.openxmlformats-officedocument.presentationml.presentation',
|
|
26
|
+
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
|
|
27
|
+
'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
|
|
28
|
+
'application/vnd.rar',
|
|
29
|
+
'application/x-7z-compressed',
|
|
30
|
+
'application/x-bzip',
|
|
31
|
+
'application/x-bzip2',
|
|
32
|
+
'application/x-gzip',
|
|
33
|
+
'application/x-rar-compressed',
|
|
34
|
+
'application/x-xz',
|
|
35
|
+
'application/x-zip-compressed',
|
|
36
|
+
'application/zip',
|
|
37
|
+
'application/zstd',
|
|
38
|
+
'font/woff',
|
|
39
|
+
'font/woff2',
|
|
40
|
+
]);
|
|
41
|
+
/** Uncompressed media types that sit under an already-compressed prefix, so compressing them still pays off. */
|
|
42
|
+
const COMPRESSIBLE_MEDIA_TYPES = new Set([
|
|
43
|
+
'audio/aiff',
|
|
44
|
+
'audio/basic',
|
|
45
|
+
'audio/l16',
|
|
46
|
+
'audio/l24',
|
|
47
|
+
'audio/midi',
|
|
48
|
+
'audio/vnd.wave',
|
|
49
|
+
'audio/wav',
|
|
50
|
+
'audio/wave',
|
|
51
|
+
'audio/x-aiff',
|
|
52
|
+
'audio/x-wav',
|
|
53
|
+
'image/bmp',
|
|
54
|
+
'image/tiff',
|
|
55
|
+
'image/vnd.adobe.photoshop',
|
|
56
|
+
'image/vnd.microsoft.icon',
|
|
57
|
+
'image/x-icon',
|
|
58
|
+
'image/x-ms-bmp',
|
|
59
|
+
]);
|
|
60
|
+
/** Structured syntax suffixes marking a media type as text even under an already-compressed prefix (`image/svg+xml`). */
|
|
61
|
+
const COMPRESSIBLE_MEDIA_TYPE_SUFFIXES = ['+json', '+xml'];
|
|
8
62
|
export { parseArgument };
|
|
9
63
|
/**
|
|
10
64
|
* Accepts any non-null, non-array object as a predicate for `z.custom()`.
|
|
@@ -26,35 +80,30 @@ export const anyObjectSchema = z.custom(isNonArrayObject, {
|
|
|
26
80
|
// any tree-shaking bundler drops it and every message degrades to a bare "Invalid input". Passing it
|
|
27
81
|
// in per parse keeps them intact without reaching into the zod config the whole process shares.
|
|
28
82
|
const { localeError } = z.locales.en();
|
|
83
|
+
const RESPONSE_ENVELOPE_SCHEMA = z.object({ data: z.unknown() });
|
|
29
84
|
/**
|
|
30
|
-
* Turns a JSON API response into the value a resource method returns: unwraps the `data` envelope
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* fields and
|
|
85
|
+
* Turns a JSON API response into the value a resource method returns: unwraps the `data` envelope and validates the
|
|
86
|
+
* result against `schema`, one of the schemas generated from the OpenAPI specification. The validated copy is what
|
|
87
|
+
* callers get, so it is the schema's output -- unknown fields and unknown enum values included, since the schemas let
|
|
88
|
+
* both through, date-time fields turned into `Date` objects, and URL fields normalized, since `z.url()` hands back the
|
|
89
|
+
* parsed URL's serialization.
|
|
34
90
|
*
|
|
35
91
|
* Throws {@link ResponseValidationError} when the response does not match the specification.
|
|
36
92
|
* @internal
|
|
37
93
|
*/
|
|
38
|
-
export function parseResponse(response, schema
|
|
39
|
-
const
|
|
94
|
+
export function parseResponse(response, schema) {
|
|
95
|
+
const { method = 'GET', url = '' } = response.config;
|
|
96
|
+
const envelope = RESPONSE_ENVELOPE_SCHEMA.safeParse(response.data, { error: localeError });
|
|
97
|
+
if (!envelope.success) {
|
|
98
|
+
throw new ResponseValidationError(envelope.error, response.data, { method, url });
|
|
99
|
+
}
|
|
100
|
+
const { data } = envelope.data;
|
|
40
101
|
const result = schema.safeParse(data, { error: localeError });
|
|
41
102
|
if (!result.success) {
|
|
42
|
-
const { method = 'GET', url = '' } = response.config;
|
|
43
103
|
throw new ResponseValidationError(result.error, data, { method, url });
|
|
44
104
|
}
|
|
45
105
|
return result.data;
|
|
46
106
|
}
|
|
47
|
-
/**
|
|
48
|
-
* Returns object's 'data' property or throws if parameter is not an object,
|
|
49
|
-
* or an object without a 'data' property.
|
|
50
|
-
*/
|
|
51
|
-
export function pluckData(obj) {
|
|
52
|
-
if (typeof obj === 'object' && obj) {
|
|
53
|
-
if (typeof obj.data !== 'undefined')
|
|
54
|
-
return obj.data;
|
|
55
|
-
}
|
|
56
|
-
throw new Error(`Expected response object with a "data" property, but received: ${obj}`);
|
|
57
|
-
}
|
|
58
107
|
/**
|
|
59
108
|
* Swallows a 404 Not Found API error and rethrows anything else.
|
|
60
109
|
*/
|
|
@@ -63,51 +112,16 @@ export function catchNotFoundOrThrow(err) {
|
|
|
63
112
|
throw err;
|
|
64
113
|
}
|
|
65
114
|
/**
|
|
66
|
-
*
|
|
67
|
-
* "createdAt").
|
|
68
|
-
*
|
|
69
|
-
* If you want parse other fields as well, you can provide a custom matcher function shouldParseField(). This
|
|
70
|
-
* admittedly awkward approach allows this function to be reused for various purposes without introducing potential
|
|
71
|
-
* breaking changes.
|
|
115
|
+
* Like `catchNotFoundOrThrow()`, but swallows the 404 only when the client names its resource by ID.
|
|
72
116
|
*
|
|
73
|
-
*
|
|
117
|
+
* A chained client without an ID, such as `run.dataset()` or `run.log()`, requests a path where a 404 can mean either
|
|
118
|
+
* the parent or the default sub-resource is missing. The response cannot tell the two apart, so the error propagates.
|
|
119
|
+
* @internal
|
|
74
120
|
*/
|
|
75
|
-
export function
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
// array spend a level.
|
|
80
|
-
//
|
|
81
|
-
// In a list response it also reaches one level into caller-owned blobs the API stores verbatim, so a
|
|
82
|
-
// listed request's `userData.foo.somethingAt` comes back as a `Date` rather than the string it was
|
|
83
|
-
// written as.
|
|
84
|
-
// TODO: Consider removing this limitation. It might came across as an annoying surprise as it's not communicated.
|
|
85
|
-
if (depth > 4) {
|
|
86
|
-
return input;
|
|
87
|
-
}
|
|
88
|
-
if (Array.isArray(input))
|
|
89
|
-
return input.map((child) => parseDateFields(child, shouldParseField, depth + 1));
|
|
90
|
-
if (!input || typeof input !== 'object')
|
|
91
|
-
return input;
|
|
92
|
-
return Object.entries(input).reduce((output, [k, v]) => {
|
|
93
|
-
const isValObject = !!v && typeof v === 'object';
|
|
94
|
-
if (k.endsWith('At') || (shouldParseField && shouldParseField(k))) {
|
|
95
|
-
if (v) {
|
|
96
|
-
const d = new Date(v);
|
|
97
|
-
output[k] = Number.isNaN(d.getTime()) ? v : d;
|
|
98
|
-
}
|
|
99
|
-
else {
|
|
100
|
-
output[k] = v;
|
|
101
|
-
}
|
|
102
|
-
}
|
|
103
|
-
else if (isValObject || Array.isArray(v)) {
|
|
104
|
-
output[k] = parseDateFields(v, shouldParseField, depth + 1);
|
|
105
|
-
}
|
|
106
|
-
else {
|
|
107
|
-
output[k] = v;
|
|
108
|
-
}
|
|
109
|
-
return output;
|
|
110
|
-
}, {});
|
|
121
|
+
export function catchNotFoundForResourceOrThrow(err, resourceId) {
|
|
122
|
+
if (!resourceId)
|
|
123
|
+
throw err;
|
|
124
|
+
catchNotFoundOrThrow(err);
|
|
111
125
|
}
|
|
112
126
|
/**
|
|
113
127
|
* Helper function that converts array of webhooks to base64 string
|
|
@@ -115,98 +129,105 @@ export function parseDateFields(input, shouldParseField = null, depth = 0) {
|
|
|
115
129
|
export function stringifyWebhooksToBase64(webhooks) {
|
|
116
130
|
if (!webhooks)
|
|
117
131
|
return;
|
|
118
|
-
|
|
119
|
-
if (isNode()) {
|
|
120
|
-
return Buffer.from(webhooksJson, 'utf8').toString('base64');
|
|
121
|
-
}
|
|
122
|
-
const encoder = new TextEncoder();
|
|
123
|
-
const uint8Array = encoder.encode(webhooksJson);
|
|
124
|
-
return btoa(String.fromCharCode(...uint8Array));
|
|
132
|
+
return bytesToBase64(textEncoder.encode(JSON.stringify(webhooks)));
|
|
125
133
|
}
|
|
126
|
-
let brotliCompressPromisified;
|
|
127
134
|
/**
|
|
128
|
-
*
|
|
135
|
+
* Encodes bytes as base64. `btoa()` takes a binary string, and the bytes are turned into one in slices,
|
|
136
|
+
* because spreading them all into a single `String.fromCharCode()` call overflows the argument limit on
|
|
137
|
+
* inputs of a few tens of kilobytes.
|
|
129
138
|
*/
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
const options = { params: { [constants.BROTLI_PARAM_QUALITY]: 6 } };
|
|
136
|
-
brotliCompressPromisified = async (input) => compress(input, options);
|
|
139
|
+
export function bytesToBase64(bytes) {
|
|
140
|
+
const SLICE_LENGTH = 0x8000;
|
|
141
|
+
let binary = '';
|
|
142
|
+
for (let i = 0; i < bytes.length; i += SLICE_LENGTH) {
|
|
143
|
+
binary += String.fromCharCode(...bytes.subarray(i, i + SLICE_LENGTH));
|
|
137
144
|
}
|
|
138
|
-
return
|
|
145
|
+
return btoa(binary);
|
|
139
146
|
}
|
|
140
|
-
let gzipPromisified;
|
|
141
147
|
/**
|
|
142
|
-
*
|
|
148
|
+
* Concatenates byte chunks into one array.
|
|
143
149
|
*/
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
150
|
+
export function concatBytes(chunks) {
|
|
151
|
+
const result = new Uint8Array(chunks.reduce((length, chunk) => length + chunk.length, 0));
|
|
152
|
+
let offset = 0;
|
|
153
|
+
for (const chunk of chunks) {
|
|
154
|
+
result.set(chunk, offset);
|
|
155
|
+
offset += chunk.length;
|
|
149
156
|
}
|
|
150
|
-
return
|
|
157
|
+
return result;
|
|
151
158
|
}
|
|
152
159
|
/**
|
|
153
|
-
*
|
|
154
|
-
*
|
|
160
|
+
* Views a request body as bytes: a string is UTF-8 encoded, binary values are viewed in place. Anything else
|
|
161
|
+
* - a stream, a `Blob`, form data - is `undefined`.
|
|
162
|
+
* @internal
|
|
155
163
|
*/
|
|
156
|
-
export
|
|
157
|
-
if (
|
|
164
|
+
export function toBytes(value) {
|
|
165
|
+
if (typeof value === 'string')
|
|
166
|
+
return textEncoder.encode(value);
|
|
167
|
+
if (!isBuffer(value))
|
|
158
168
|
return undefined;
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
return
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
169
|
+
return ArrayBuffer.isView(value)
|
|
170
|
+
? new Uint8Array(value.buffer, value.byteOffset, value.byteLength)
|
|
171
|
+
: new Uint8Array(value);
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Decides whether a request body with the given content type is worth compressing.
|
|
175
|
+
*
|
|
176
|
+
* Images, audio, video and archives already carry their own compression. Running them through brotli or gzip
|
|
177
|
+
* burns CPU, holds a second full copy of the body in memory, and usually produces output slightly larger than
|
|
178
|
+
* the input. Formats that are raw despite such a media type, for example `image/bmp` or `audio/wav`, are still
|
|
179
|
+
* compressed. A body with no content type is assumed to be compressible.
|
|
180
|
+
* @internal
|
|
181
|
+
*/
|
|
182
|
+
export function isCompressibleContentType(contentType) {
|
|
183
|
+
if (!contentType)
|
|
184
|
+
return true;
|
|
185
|
+
// `Content-Type` is case-insensitive and may carry parameters, for example `text/plain; charset=utf-8`.
|
|
186
|
+
const mediaType = contentType.split(';', 1)[0].trim().toLowerCase();
|
|
187
|
+
if (COMPRESSIBLE_MEDIA_TYPES.has(mediaType))
|
|
188
|
+
return true;
|
|
189
|
+
if (COMPRESSIBLE_MEDIA_TYPE_SUFFIXES.some((suffix) => mediaType.endsWith(suffix)))
|
|
190
|
+
return true;
|
|
191
|
+
if (ALREADY_COMPRESSED_MEDIA_TYPES.has(mediaType))
|
|
192
|
+
return false;
|
|
193
|
+
return !ALREADY_COMPRESSED_MEDIA_TYPE_PREFIXES.some((prefix) => mediaType.startsWith(prefix));
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* Reads an environment variable, on runtimes that have them.
|
|
197
|
+
*/
|
|
198
|
+
export function getEnv(name) {
|
|
199
|
+
return typeof process !== 'undefined' ? process.env?.[name] : undefined;
|
|
181
200
|
}
|
|
182
201
|
/**
|
|
183
|
-
*
|
|
202
|
+
* Returns the UTF-8 byte length of a string.
|
|
184
203
|
*/
|
|
185
|
-
export function
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
204
|
+
export function utf8ByteLength(value) {
|
|
205
|
+
return textEncoder.encode(value).byteLength;
|
|
206
|
+
}
|
|
207
|
+
/**
|
|
208
|
+
* Splits JSON-serialized items into consecutive batches of at most `maxCount` items, each of which fits into a JSON
|
|
209
|
+
* array body - the items joined by commas between brackets - of at most `maxByteLength` bytes. The `byteLength` of an
|
|
210
|
+
* item is the UTF-8 byte length of its serialization. An item too large for a body of its own still gets one, so a
|
|
211
|
+
* caller that cannot send such an item has to reject it beforehand.
|
|
212
|
+
*/
|
|
213
|
+
export function splitIntoJsonArrayBatches(items, { maxCount, maxByteLength }) {
|
|
214
|
+
const batches = [];
|
|
215
|
+
let batch = [];
|
|
216
|
+
// One byte for the opening bracket; each item then adds its own bytes plus one for the comma or the closing
|
|
217
|
+
// bracket that follows it.
|
|
218
|
+
let byteLength = 1;
|
|
219
|
+
for (const item of items) {
|
|
220
|
+
if (batch.length > 0 && (batch.length >= maxCount || byteLength + item.byteLength + 1 > maxByteLength)) {
|
|
221
|
+
batches.push(batch);
|
|
222
|
+
batch = [];
|
|
223
|
+
byteLength = 1;
|
|
198
224
|
}
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
byteLength += itemByteSize;
|
|
202
|
-
slicedArray.push(item);
|
|
225
|
+
batch.push(item);
|
|
226
|
+
byteLength += item.byteLength + 1;
|
|
203
227
|
}
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
if (typeof BROWSER_BUILD !== 'undefined')
|
|
208
|
-
return false;
|
|
209
|
-
return !!(typeof process !== 'undefined' && process.versions && process.versions.node);
|
|
228
|
+
if (batch.length > 0)
|
|
229
|
+
batches.push(batch);
|
|
230
|
+
return batches;
|
|
210
231
|
}
|
|
211
232
|
export function isBuffer(value) {
|
|
212
233
|
// Tag checks rather than `instanceof`, to also match buffers from another realm. `isView()`
|
|
@@ -224,34 +245,28 @@ export function isStream(value) {
|
|
|
224
245
|
const { on, pipe } = value;
|
|
225
246
|
return typeof on === 'function' && typeof pipe === 'function';
|
|
226
247
|
}
|
|
227
|
-
export function getVersionData() {
|
|
228
|
-
if (typeof BROWSER_BUILD !== 'undefined') {
|
|
229
|
-
return { version: VERSION };
|
|
230
|
-
}
|
|
231
|
-
return packageJson;
|
|
232
|
-
}
|
|
233
248
|
/**
|
|
234
249
|
* Helper class to create async iterators from paginated list endpoints.
|
|
235
250
|
*/
|
|
236
251
|
export class RequestQueuePaginationIterator {
|
|
237
|
-
maxPageLimit;
|
|
238
|
-
getPage;
|
|
239
|
-
limit;
|
|
240
|
-
cursor;
|
|
252
|
+
#maxPageLimit;
|
|
253
|
+
#getPage;
|
|
254
|
+
#limit;
|
|
255
|
+
#cursor;
|
|
241
256
|
constructor(options) {
|
|
242
|
-
this
|
|
243
|
-
this
|
|
244
|
-
this
|
|
245
|
-
this
|
|
257
|
+
this.#maxPageLimit = options.maxPageLimit;
|
|
258
|
+
this.#limit = options.limit;
|
|
259
|
+
this.#cursor = options.cursor;
|
|
260
|
+
this.#getPage = options.getPage;
|
|
246
261
|
}
|
|
247
262
|
async *[Symbol.asyncIterator]() {
|
|
248
|
-
let nextCursor = this
|
|
263
|
+
let nextCursor = this.#cursor;
|
|
249
264
|
let iterateItemCount = 0;
|
|
250
265
|
while (true) {
|
|
251
|
-
const pageLimit = this
|
|
252
|
-
? Math.min(this
|
|
253
|
-
: this
|
|
254
|
-
const page = await this
|
|
266
|
+
const pageLimit = this.#limit
|
|
267
|
+
? Math.min(this.#maxPageLimit, this.#limit - iterateItemCount)
|
|
268
|
+
: this.#maxPageLimit;
|
|
269
|
+
const page = await this.#getPage({
|
|
255
270
|
limit: pageLimit,
|
|
256
271
|
cursor: nextCursor,
|
|
257
272
|
});
|
|
@@ -261,12 +276,28 @@ export class RequestQueuePaginationIterator {
|
|
|
261
276
|
yield page;
|
|
262
277
|
iterateItemCount += page.items.length;
|
|
263
278
|
// Limit reached stopping to iterate
|
|
264
|
-
if ((this
|
|
279
|
+
if ((this.#limit && iterateItemCount >= this.#limit) || !page.nextCursor)
|
|
265
280
|
return;
|
|
266
281
|
nextCursor = page.nextCursor;
|
|
267
282
|
}
|
|
268
283
|
}
|
|
269
284
|
}
|
|
285
|
+
/**
|
|
286
|
+
* The smaller of two page limits, for the `limit` query parameter. The API treats a `limit` of 0 as unset, so 0 here
|
|
287
|
+
* means no limit and loses to any other value.
|
|
288
|
+
* @internal
|
|
289
|
+
*/
|
|
290
|
+
export function minForLimitParam(a, b) {
|
|
291
|
+
if (a === 0)
|
|
292
|
+
a = undefined;
|
|
293
|
+
if (b === 0)
|
|
294
|
+
b = undefined;
|
|
295
|
+
if (a === undefined)
|
|
296
|
+
return b;
|
|
297
|
+
if (b === undefined)
|
|
298
|
+
return a;
|
|
299
|
+
return Math.min(a, b);
|
|
300
|
+
}
|
|
270
301
|
/**
|
|
271
302
|
* Schema shape of {@link PaginationOptions}, to spread into every paginating client's list schema. One
|
|
272
303
|
* copy stops it drifting from the interface.
|
|
@@ -277,6 +308,16 @@ export const paginationOptionsShape = {
|
|
|
277
308
|
offset: z.number().min(0).optional(),
|
|
278
309
|
chunkSize: z.number().positive().optional(),
|
|
279
310
|
};
|
|
311
|
+
/**
|
|
312
|
+
* Key under which a page of dataset items carries the number of rows the API scanned to produce it, as a
|
|
313
|
+
* non-enumerable property that stays out of the page's public shape. The API applies `offset` and `limit` to the
|
|
314
|
+
* dataset's rows first and shapes the result afterwards: filters (`clean`, `skipEmpty`, `skipHidden`) drop items and
|
|
315
|
+
* `unwind` splits or drops them, so `items.length` can land on either side of the rows scanned. The
|
|
316
|
+
* `x-apify-pagination-count` header reports the scanned number, and the offset iterator advances and terminates by it
|
|
317
|
+
* alone. A page without the property falls back to `items.length`.
|
|
318
|
+
* @internal
|
|
319
|
+
*/
|
|
320
|
+
export const SCANNED_COUNT = Symbol('scannedCount');
|
|
280
321
|
export function cast(input) {
|
|
281
322
|
return input;
|
|
282
323
|
}
|
|
@@ -324,3 +365,24 @@ export function toPathSegment(value) {
|
|
|
324
365
|
export function toPath(path) {
|
|
325
366
|
return Array.isArray(path) ? path.map(toPathSegment).join('/') : path;
|
|
326
367
|
}
|
|
368
|
+
/**
|
|
369
|
+
* Resolves after `millis`, or right away once `signal` aborts.
|
|
370
|
+
* @internal
|
|
371
|
+
*/
|
|
372
|
+
export async function sleep(millis, signal) {
|
|
373
|
+
return new Promise((resolve) => {
|
|
374
|
+
if (signal?.aborted) {
|
|
375
|
+
resolve();
|
|
376
|
+
return;
|
|
377
|
+
}
|
|
378
|
+
const onAbort = () => {
|
|
379
|
+
clearTimeout(timer);
|
|
380
|
+
resolve();
|
|
381
|
+
};
|
|
382
|
+
const timer = setTimeout(() => {
|
|
383
|
+
signal?.removeEventListener('abort', onAbort);
|
|
384
|
+
resolve();
|
|
385
|
+
}, millis);
|
|
386
|
+
signal?.addEventListener('abort', onAbort, { once: true });
|
|
387
|
+
});
|
|
388
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { Log } from '@apify/log';
|
|
2
|
+
/**
|
|
3
|
+
* Makes the `start` request, retrying it every {@link WAIT_FOR_RESOURCES_COOLDOWN_MILLIS} while it fails with one of
|
|
4
|
+
* {@link RESOURCE_LIMIT_ERROR_TYPES}. `true` retries until the request succeeds, a number of seconds bounds the
|
|
5
|
+
* retrying, after which the last error is thrown. Any other error is thrown right away.
|
|
6
|
+
* @internal
|
|
7
|
+
*/
|
|
8
|
+
export declare function startWaitingForResources<T>(start: () => Promise<T>, waitForResources: boolean | number | undefined, logger: Log, signal?: AbortSignal): Promise<T>;
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { ApifyApiError } from './apify_api_error.js';
|
|
2
|
+
import { sleep } from './utils.js';
|
|
3
|
+
/**
|
|
4
|
+
* Error types the API rejects a run start with while the account has no free memory or concurrent-run slot for it.
|
|
5
|
+
* Both clear as other runs or builds finish.
|
|
6
|
+
*/
|
|
7
|
+
const RESOURCE_LIMIT_ERROR_TYPES = new Set([
|
|
8
|
+
'actor-memory-limit-exceeded',
|
|
9
|
+
'concurrent-runs-limit-exceeded',
|
|
10
|
+
]);
|
|
11
|
+
/** Cooldown between two attempts to start a run that was rejected for lack of resources. */
|
|
12
|
+
const WAIT_FOR_RESOURCES_COOLDOWN_MILLIS = 10_000;
|
|
13
|
+
/**
|
|
14
|
+
* Makes the `start` request, retrying it every {@link WAIT_FOR_RESOURCES_COOLDOWN_MILLIS} while it fails with one of
|
|
15
|
+
* {@link RESOURCE_LIMIT_ERROR_TYPES}. `true` retries until the request succeeds, a number of seconds bounds the
|
|
16
|
+
* retrying, after which the last error is thrown. Any other error is thrown right away.
|
|
17
|
+
* @internal
|
|
18
|
+
*/
|
|
19
|
+
export async function startWaitingForResources(start, waitForResources, logger, signal) {
|
|
20
|
+
if (!waitForResources)
|
|
21
|
+
return start();
|
|
22
|
+
const deadline = waitForResources === true ? Infinity : Date.now() + waitForResources * 1000;
|
|
23
|
+
for (;;) {
|
|
24
|
+
try {
|
|
25
|
+
return await start();
|
|
26
|
+
}
|
|
27
|
+
catch (err) {
|
|
28
|
+
if (!(err instanceof ApifyApiError) || !RESOURCE_LIMIT_ERROR_TYPES.has(err.type ?? ''))
|
|
29
|
+
throw err;
|
|
30
|
+
const remainingMillis = deadline - Date.now();
|
|
31
|
+
if (remainingMillis <= 0)
|
|
32
|
+
throw err;
|
|
33
|
+
const delayMillis = Math.min(WAIT_FOR_RESOURCES_COOLDOWN_MILLIS, remainingMillis);
|
|
34
|
+
logger.info(`Not enough resources to start the run, retrying in ${Number((delayMillis / 1000).toPrecision(3))}s: ${err.message}`);
|
|
35
|
+
await sleep(delayMillis, signal);
|
|
36
|
+
signal?.throwIfAborted();
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
}
|
package/package.json
CHANGED
|
@@ -1,15 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "apify-client",
|
|
3
|
-
"version": "3.0.0-beta.
|
|
3
|
+
"version": "3.0.0-beta.71",
|
|
4
4
|
"description": "Apify API client for JavaScript",
|
|
5
5
|
"engines": {
|
|
6
|
-
"node": ">=22.
|
|
6
|
+
"node": ">=22.13.0"
|
|
7
7
|
},
|
|
8
8
|
"type": "module",
|
|
9
9
|
"main": "dist/index.js",
|
|
10
10
|
"types": "dist/index.d.ts",
|
|
11
11
|
"browser": "dist/bundle.js",
|
|
12
12
|
"unpkg": "dist/bundle.js",
|
|
13
|
+
"imports": {
|
|
14
|
+
"#runtime": {
|
|
15
|
+
"node": "./dist/runtime/node.js",
|
|
16
|
+
"default": "./dist/runtime/web.js"
|
|
17
|
+
}
|
|
18
|
+
},
|
|
13
19
|
"exports": {
|
|
14
20
|
"./package.json": "./package.json",
|
|
15
21
|
"./browser": "./dist/bundle.js",
|
|
@@ -53,58 +59,54 @@
|
|
|
53
59
|
],
|
|
54
60
|
"apify": {
|
|
55
61
|
"openapiSpec": {
|
|
56
|
-
"version": "v2-2026-
|
|
62
|
+
"version": "v2-2026-10-08T073338Z"
|
|
57
63
|
}
|
|
58
64
|
},
|
|
59
65
|
"dependencies": {
|
|
60
66
|
"@apify/consts": "^3.0.1",
|
|
61
67
|
"@apify/log": "^3.0.1",
|
|
62
|
-
"@apify/utilities": "^3.0
|
|
63
|
-
"@apify/validations": "^1.1.
|
|
64
|
-
"@crawlee/types": "^3.18.1",
|
|
68
|
+
"@apify/utilities": "^3.1.0",
|
|
69
|
+
"@apify/validations": "^1.1.1",
|
|
65
70
|
"ansi-colors": "^4.1.3",
|
|
66
|
-
"async-retry": "^1.3.3",
|
|
67
71
|
"axios": "^1.20.0",
|
|
68
|
-
"content-type": "^1.
|
|
69
|
-
"proxy-agent": "^
|
|
72
|
+
"content-type": "^3.1.1",
|
|
73
|
+
"proxy-agent": "^8.0.2",
|
|
70
74
|
"tslib": "^2.8.1",
|
|
71
|
-
"type-fest": "^
|
|
72
|
-
"zod": "^4.5
|
|
75
|
+
"type-fest": "^5.10.0",
|
|
76
|
+
"zod": "^4.6.5"
|
|
73
77
|
},
|
|
74
78
|
"devDependencies": {
|
|
75
79
|
"@apify/oxlint-config": "^0.3.0",
|
|
76
80
|
"@apify/tsconfig": "^0.2.0",
|
|
77
|
-
"@crawlee/puppeteer": "4.0.0-
|
|
78
|
-
"@rsbuild/core": "^2.2.
|
|
81
|
+
"@crawlee/puppeteer": "4.0.0-rc.1",
|
|
82
|
+
"@rsbuild/core": "^2.2.10",
|
|
79
83
|
"@rsbuild/plugin-node-polyfill": "^1.4.6",
|
|
80
|
-
"@rspack/cli": "^2.2.
|
|
81
|
-
"@rspack/core": "^2.2.
|
|
82
|
-
"@types/async-retry": "^1.4.9",
|
|
84
|
+
"@rspack/cli": "^2.2.8",
|
|
85
|
+
"@rspack/core": "^2.2.8",
|
|
83
86
|
"@types/compression": "^1.8.1",
|
|
84
|
-
"@types/content-type": "^1.1.9",
|
|
85
87
|
"@types/express": "^5.0.6",
|
|
86
|
-
"@types/node": "^24.
|
|
88
|
+
"@types/node": "^24.19.0",
|
|
87
89
|
"ajv": "^8.20.0",
|
|
88
90
|
"body-parser": "^2.3.0",
|
|
89
|
-
"compression": "^1.8.
|
|
91
|
+
"compression": "^1.8.2",
|
|
90
92
|
"esbuild": "0.28.2",
|
|
91
93
|
"express": "^5.2.1",
|
|
92
|
-
"
|
|
93
|
-
"
|
|
94
|
-
"oxlint": "
|
|
95
|
-
"
|
|
96
|
-
"puppeteer": "^25.10.0",
|
|
94
|
+
"oxfmt": "0.73.0",
|
|
95
|
+
"oxlint": "1.88.0",
|
|
96
|
+
"oxlint-tsgolint": "7.0.2004",
|
|
97
|
+
"puppeteer": "^25.12.0",
|
|
97
98
|
"rimraf": "^6.1.3",
|
|
98
|
-
"rolldown": "^1.2.
|
|
99
|
-
"typescript": "^
|
|
100
|
-
"
|
|
101
|
-
"
|
|
99
|
+
"rolldown": "^1.2.11",
|
|
100
|
+
"typescript": "^7.0.2",
|
|
101
|
+
"typescript-v6": "npm:typescript@^6.0.3",
|
|
102
|
+
"vitest": "^5.0.2",
|
|
103
|
+
"webpack": "^5.111.1",
|
|
102
104
|
"webpack-cli": "^7.2.3"
|
|
103
105
|
},
|
|
104
106
|
"devEngines": {
|
|
105
107
|
"packageManager": {
|
|
106
108
|
"name": "pnpm",
|
|
107
|
-
"version": "
|
|
109
|
+
"version": "12.14.0",
|
|
108
110
|
"onFail": "warn"
|
|
109
111
|
}
|
|
110
112
|
},
|
|
@@ -119,6 +121,7 @@
|
|
|
119
121
|
"lint:fix": "oxlint --type-aware --fix",
|
|
120
122
|
"tsc-check-tests": "tsc --noEmit --project test/tsconfig.json",
|
|
121
123
|
"tsc-check-scripts": "tsc --noEmit --project tsconfig.scripts.json",
|
|
124
|
+
"tsc-check-docs": "tsc --noEmit --project docs/tsconfig.json",
|
|
122
125
|
"format": "oxfmt",
|
|
123
126
|
"format:check": "oxfmt --check",
|
|
124
127
|
"api:extract": "pnpm build && pnpm dlx github:apify/api-extractor-report --packages=. --extract-command='pnpm api:extract'",
|