apify-client 3.0.0-beta.4 → 3.0.0-beta.40

package/dist/http_compressors/brotli.js

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+import { runtime } from '#runtime';
+import { parseArgument } from '../utils.js';
+/** Lowest valid brotli quality, the fastest with the least compression. */
+const MIN_QUALITY = 0;
+/** Highest valid brotli quality, the slowest with the best compression. */
+const MAX_QUALITY = 11;
+/** Middle of the range, where brotli already beats gzip at a comparable CPU cost. */
+const DEFAULT_QUALITY = 6;
+const optionsSchema = z.strictObject({
+    quality: z.int().min(MIN_QUALITY).max(MAX_QUALITY).default(DEFAULT_QUALITY),
+});
+/**
+ * Compresses request bodies using brotli.
+ *
+ * Built on the `node:zlib` module, so it works wherever the client runs on Node.js.
+ *
+ * @example
+ * ```javascript
+ * import { ApifyClient, BrotliHttpCompressor } from 'apify-client';
+ *
+ * const client = new ApifyClient({ token: 'my-token', compression: new BrotliHttpCompressor({ quality: 11 }) });
+ * ```
+ */
+export class BrotliHttpCompressor {
+    contentEncoding = 'br';
+    #quality;
+    /**
+     * @param options - Compressor options.
+     * @throws {ArgumentValidationError} If `quality` is out of the valid range.
+     */
+    constructor(options = {}) {
+        const { quality } = parseArgument(options, optionsSchema, 'BrotliHttpCompressorOptions');
+        this.#quality = quality;
+    }
+    async compress(data) {
+        return runtime.compress(data, { algorithm: 'br', quality: this.#quality });
+    }
+}

package/dist/http_compressors/gzip.d.ts

@@ -0,0 +1,33 @@
+import type { HttpCompressor } from './base.js';
+/**
+ * Compresses request bodies using gzip.
+ *
+ * Built on the `node:zlib` module, so it works wherever the client runs on Node.js.
+ *
+ * @example
+ * ```javascript
+ * import { ApifyClient, GzipHttpCompressor } from 'apify-client';
+ *
+ * const client = new ApifyClient({ token: 'my-token', compression: new GzipHttpCompressor({ quality: 1 }) });
+ * ```
+ */
+export declare class GzipHttpCompressor implements HttpCompressor {
+    #private;
+    readonly contentEncoding = "gzip";
+    /**
+     * @param options - Compressor options.
+     * @throws {ArgumentValidationError} If `quality` is out of the valid range.
+     */
+    constructor(options?: GzipHttpCompressorOptions);
+    compress(data: Buffer): Promise<Buffer>;
+}
+/**
+ * Options for {@link GzipHttpCompressor}.
+ */
+export interface GzipHttpCompressorOptions {
+    /**
+     * Compression level, from `1` (the fastest) to `9` (the best compression).
+     * @default 6
+     */
+    quality?: number;
+}

package/dist/http_compressors/gzip.js

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+import { runtime } from '#runtime';
+import { parseArgument } from '../utils.js';
+/** Lowest valid gzip quality, the fastest with the least compression. */
+const MIN_QUALITY = 1;
+/** Highest valid gzip quality, the slowest with the best compression. */
+const MAX_QUALITY = 9;
+/** zlib's own default. The levels above it roughly double the CPU cost for about a percent fewer bytes. */
+const DEFAULT_QUALITY = 6;
+const optionsSchema = z.strictObject({
+    quality: z.int().min(MIN_QUALITY).max(MAX_QUALITY).default(DEFAULT_QUALITY),
+});
+/**
+ * Compresses request bodies using gzip.
+ *
+ * Built on the `node:zlib` module, so it works wherever the client runs on Node.js.
+ *
+ * @example
+ * ```javascript
+ * import { ApifyClient, GzipHttpCompressor } from 'apify-client';
+ *
+ * const client = new ApifyClient({ token: 'my-token', compression: new GzipHttpCompressor({ quality: 1 }) });
+ * ```
+ */
+export class GzipHttpCompressor {
+    contentEncoding = 'gzip';
+    #quality;
+    /**
+     * @param options - Compressor options.
+     * @throws {ArgumentValidationError} If `quality` is out of the valid range.
+     */
+    constructor(options = {}) {
+        const { quality } = parseArgument(options, optionsSchema, 'GzipHttpCompressorOptions');
+        this.#quality = quality;
+    }
+    async compress(data) {
+        return runtime.compress(data, { algorithm: 'gzip', quality: this.#quality });
+    }
+}

package/dist/http_compressors/index.d.ts

@@ -0,0 +1,6 @@
+export type { HttpCompressor } from './base.js';
+export { BrotliHttpCompressor } from './brotli.js';
+export type { BrotliHttpCompressorOptions } from './brotli.js';
+export { GzipHttpCompressor } from './gzip.js';
+export type { GzipHttpCompressorOptions } from './gzip.js';
+export type { HttpCompressionAlgorithm } from './resolve.js';

package/dist/http_compressors/index.js

@@ -0,0 +1,2 @@
+export { BrotliHttpCompressor } from './brotli.js';
+export { GzipHttpCompressor } from './gzip.js';

package/dist/http_compressors/resolve.d.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+import type { HttpCompressor } from './base.js';
+/**
+ * Compression algorithms the `compression` option of {@link ApifyClient} accepts by name. Each name selects the
+ * matching built-in compressor with its default quality: `'brotli'` a {@link BrotliHttpCompressor}, `'gzip'` a
+ * {@link GzipHttpCompressor}. The Apify API also accepts `deflate` and `identity`, which a custom
+ * {@link HttpCompressor} covers.
+ */
+export type HttpCompressionAlgorithm = 'brotli' | 'gzip';
+/**
+ * Schema of the `compression` option: an algorithm name or an {@link HttpCompressor}.
+ * @internal
+ */
+export declare const compressionSchema: z.ZodUnion<readonly [z.ZodEnum<{
+    brotli: "brotli";
+    gzip: "gzip";
+}>, z.ZodCustom<HttpCompressor, HttpCompressor>]>;
+/**
+ * Turns the `compression` option into a ready-to-use {@link HttpCompressor}: a name into the matching built-in
+ * compressor with its default quality, a compressor into itself.
+ * @internal
+ */
+export declare function resolveCompressor(compression: HttpCompressionAlgorithm | HttpCompressor): HttpCompressor;

package/dist/http_compressors/resolve.js

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+import { httpCompressorSchema } from './base.js';
+import { BrotliHttpCompressor } from './brotli.js';
+import { GzipHttpCompressor } from './gzip.js';
+/**
+ * Schema of the `compression` option: an algorithm name or an {@link HttpCompressor}.
+ * @internal
+ */
+export const compressionSchema = z.union([
+    z.enum(['brotli', 'gzip']),
+    httpCompressorSchema,
+]);
+/**
+ * Turns the `compression` option into a ready-to-use {@link HttpCompressor}: a name into the matching built-in
+ * compressor with its default quality, a compressor into itself.
+ * @internal
+ */
+export function resolveCompressor(compression) {
+    if (typeof compression !== 'string')
+        return compression;
+    switch (compression) {
+        case 'gzip':
+            return new GzipHttpCompressor();
+        case 'brotli':
+            return new BrotliHttpCompressor();
+    }
+}

package/dist/index.d.ts

@@ -28,5 +28,9 @@ export * from './resource_clients/webhook_dispatch.js';
 export * from './resource_clients/webhook_dispatch_collection.js';
 export * from './apify_api_error.js';
 export { ArgumentValidationError } from '@apify/validations';
-export { InvalidResponseBodyError } from './interceptors.js';
+export * from './response_validation_error.js';
+export * from './invalid_response_body_error.js';
+export * from './http_clients/index.js';
+export * from './http_compressors/index.js';
 export type { PaginatedList, Dictionary } from './utils.js';
+export type { Timeout, TimeoutOptions, TimeoutTier } from './timeouts.js';

package/dist/index.js

@@ -28,4 +28,7 @@ export * from './resource_clients/webhook_dispatch.js';
 export * from './resource_clients/webhook_dispatch_collection.js';
 export * from './apify_api_error.js';
 export { ArgumentValidationError } from '@apify/validations';
-export { InvalidResponseBodyError } from './interceptors.js';
+export * from './response_validation_error.js';
+export * from './invalid_response_body_error.js';
+export * from './http_clients/index.js';
+export * from './http_compressors/index.js';

package/dist/invalid_response_body_error.d.ts

@@ -0,0 +1,13 @@
+import type { HttpResponse } from './http_clients/base.js';
+/**
+ * Thrown when a response body does not parse as its content type claims, typically a JSON document cut short by a
+ * connection dropped mid-response. The client retries such requests, so the error surfaces once the retries are
+ * exhausted.
+ */
+export declare class InvalidResponseBodyError extends Error {
+    code: string;
+    /** The response whose body did not parse, with the body as the transport returned it. */
+    response: HttpResponse;
+    cause: Error;
+    constructor(response: HttpResponse, cause: Error);
+}

package/dist/invalid_response_body_error.js

@@ -0,0 +1,17 @@
+/**
+ * Thrown when a response body does not parse as its content type claims, typically a JSON document cut short by a
+ * connection dropped mid-response. The client retries such requests, so the error surfaces once the retries are
+ * exhausted.
+ */
+export class InvalidResponseBodyError extends Error {
+    code;
+    /** The response whose body did not parse, with the body as the transport returned it. */
+    response;
+    constructor(response, cause) {
+        super(`Response body could not be parsed.\nCause:${cause.message}`);
+        this.name = this.constructor.name;
+        this.code = 'invalid-response-body';
+        this.response = response;
+        this.cause = cause;
+    }
+}

package/dist/lazy_schema.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Wraps the construction of a zod schema so it runs on the first call and only once.
+ *
+ * The generated response schemas are exported this way: a couple of hundred `z.looseObject()` calls at import time
+ * would cost more than importing zod itself, so each schema is built by the first response validated against it and
+ * kept for the rest of the process.
+ */
+export declare function lazySchema<T>(build: () => T): () => T;

package/dist/lazy_schema.js

@@ -0,0 +1,11 @@
+/**
+ * Wraps the construction of a zod schema so it runs on the first call and only once.
+ *
+ * The generated response schemas are exported this way: a couple of hundred `z.looseObject()` calls at import time
+ * would cost more than importing zod itself, so each schema is built by the first response validated against it and
+ * kept for the rest of the process.
+ */
+export function lazySchema(build) {
+    let schema;
+    return () => (schema ??= build());
+}

package/dist/models.d.ts

@@ -48,6 +48,12 @@ export declare enum WebhookDispatchStatus {
     Succeeded = "SUCCEEDED",
     Failed = "FAILED"
 }
+/**
+ * Machine-readable type of an error returned by the Apify API, carried by `ApifyApiError.type`.
+ *
+ * Declared here, next to the other spec-derived types, and re-exported from `./apify_api_error`.
+ */
+export type ApifyApiErrorType = Schemas['ErrorType'];
 /**
  * Fields the API returns on a dataset that the OpenAPI spec does not describe yet.
  *
@@ -59,9 +65,9 @@ export interface DatasetSpecGaps {
 }
 export interface DatasetRePointed {
     stats?: DatasetStats;
+    generalAccess?: STORAGE_GENERAL_ACCESS | null;
 }
 export interface DatasetSpecNarrowings {
-    generalAccess?: STORAGE_GENERAL_ACCESS | null;
     consoleUrl?: string;
 }
 /**
@@ -145,8 +151,6 @@ export interface KeyValueStoreSpecGaps {
 }
 export interface KeyValueStoreRePointed {
     stats?: KeyValueStoreStats;
-}
-export interface KeyValueStoreSpecNarrowings {
     generalAccess?: STORAGE_GENERAL_ACCESS | null;
 }
 /**
@@ -155,7 +159,7 @@ export interface KeyValueStoreSpecNarrowings {
  * Key-value stores are used to store arbitrary data records or files. Each record is identified
  * by a unique key and can contain any data - JSON objects, strings, binary files, etc.
  */
-export interface KeyValueStore extends Omit<Schemas['KeyValueStore'], keyof KeyValueStoreRePointed | keyof KeyValueStoreSpecNarrowings>, KeyValueStoreRePointed, KeyValueStoreSpecNarrowings, KeyValueStoreSpecGaps {
+export interface KeyValueStore extends Omit<Schemas['KeyValueStore'], keyof KeyValueStoreRePointed>, KeyValueStoreRePointed, KeyValueStoreSpecGaps {
 }
 /** Statistics about Key-Value Store usage and storage. */
 export interface KeyValueStoreStats extends GeneratedKeyValueStoreStats {
@@ -215,7 +219,7 @@ export interface ActorVersionRePointed {
     envVars?: ActorEnvironmentVariable[] | null;
 }
 export interface ActorVersionClientNarrowings {
-    sourceType: ActorSourceType;
+    sourceType: `${ActorSourceType}`;
 }
 /**
  * Fields every Actor version carries, whatever its source type.
@@ -224,26 +228,26 @@ export interface ActorVersionClientNarrowings {
  * keeps a union discriminated on `sourceType` instead, because that narrows the source location down
  * to the single field which applies -- so the four are dropped here and reinstated per variant.
  */
-export interface BaseActorVersion<SourceType extends ActorSourceType> extends Omit<GeneratedVersion, keyof ActorVersionClientNarrowings | keyof ActorVersionRePointed | ActorVersionSourceLocation>, ActorVersionRePointed {
+export interface BaseActorVersion<SourceType extends `${ActorSourceType}`> extends Omit<GeneratedVersion, keyof ActorVersionClientNarrowings | keyof ActorVersionRePointed | ActorVersionSourceLocation>, ActorVersionRePointed {
     sourceType: SourceType;
 }
 /**
  * An Actor version whose source code is stored on the Apify platform.
  * @since Added in 2.6.1
  */
-export interface ActorVersionSourceFiles extends BaseActorVersion<ActorSourceType.SourceFiles> {
+export interface ActorVersionSourceFiles extends BaseActorVersion<`${ActorSourceType.SourceFiles}`> {
     sourceFiles: (ActorVersionSourceFile | ActorVersionSourceFolder)[];
 }
 /** An Actor version built from a Git repository. */
-export interface ActorVersionGitRepo extends BaseActorVersion<ActorSourceType.GitRepo> {
+export interface ActorVersionGitRepo extends BaseActorVersion<`${ActorSourceType.GitRepo}`> {
     gitRepoUrl: NonNullable<GeneratedVersion['gitRepoUrl']>;
 }
 /** An Actor version built from a downloadable tarball or ZIP archive. */
-export interface ActorVersionTarball extends BaseActorVersion<ActorSourceType.Tarball> {
+export interface ActorVersionTarball extends BaseActorVersion<`${ActorSourceType.Tarball}`> {
     tarballUrl: NonNullable<GeneratedVersion['tarballUrl']>;
 }
 /** An Actor version built from a GitHub Gist. */
-export interface ActorVersionGitHubGist extends BaseActorVersion<ActorSourceType.GitHubGist> {
+export interface ActorVersionGitHubGist extends BaseActorVersion<`${ActorSourceType.GitHubGist}`> {
     gitHubGistUrl: NonNullable<GeneratedVersion['gitHubGistUrl']>;
 }
 /**
@@ -252,7 +256,7 @@ export interface ActorVersionGitHubGist extends BaseActorVersion<ActorSourceType
  * It carries no source location of its own, so it adds nothing to `BaseActorVersion`; the variant
  * exists so that `SOURCE_CODE`, which both the spec and `@apify/consts` list, is representable.
  */
-export interface ActorVersionSourceCode extends BaseActorVersion<ActorSourceType.SourceCode> {
+export interface ActorVersionSourceCode extends BaseActorVersion<`${ActorSourceType.SourceCode}`> {
 }
 /** A version of an Actor, discriminated on where its source code comes from. */
 export type ActorVersion = ActorVersionSourceFiles | ActorVersionGitRepo | ActorVersionTarball | ActorVersionGitHubGist | ActorVersionSourceCode;
@@ -310,11 +314,7 @@ export interface ActorDefinitionSpecGaps {
      */
     output?: object | null;
 }
-export interface ActorDefinitionSpecNarrowings {
-    readme?: string | null;
-    input?: object | null;
-    changelog?: string | null;
-}
+type GeneratedActorDefinition = Schemas['ActorDefinition'];
 /**
  * Actor definition from the `.actor/actor.json` file.
  *
@@ -322,7 +322,7 @@ export interface ActorDefinitionSpecNarrowings {
  * @see https://docs.apify.com/platform/actors/development/actor-definition/actor-json
  * @since Added in 2.11.0
  */
-export interface ActorDefinition extends Omit<Schemas['ActorDefinition'], keyof ActorDefinitionSpecNarrowings>, ActorDefinitionSpecNarrowings, ActorDefinitionSpecGaps {
+export interface ActorDefinition extends GeneratedActorDefinition, ActorDefinitionSpecGaps {
 }
 export interface ActorChargeEventRePointed {
     eventTieredPricingUsd?: TieredPricingPerEvent;
@@ -571,6 +571,7 @@ export interface ActorRun extends Omit<Schemas['Run'], keyof ActorRunRePointed |
 }
 type GeneratedTaskStats = Schemas['TaskStats'];
 type GeneratedTaskOptions = Schemas['TaskOptions'];
+type GeneratedTaskPublicConfig = Schemas['TaskPublicConfig'];
 type GeneratedCurrentPricingInfo = Schemas['CurrentPricingInfo'];
 /** Statistics about Actor task usage. */
 export interface TaskStats extends GeneratedTaskStats {
@@ -586,39 +587,13 @@ export interface TaskOptions extends GeneratedTaskOptions {
  * {@apilink TaskClient.unpublish} to change the publication state.
  * @since Added in 2.25.0
  */
-export interface TaskPublicConfig {
-    publishedAt: Date | null;
-    seoTitle?: string | null;
-    seoDescription?: string | null;
-    categorization?: string | null;
-    inputSchemaFields?: string[] | null;
-    datasetName?: string | null;
-    datasetView?: string | null;
-}
-/**
- * Fields the API returns on a task that the OpenAPI spec does not describe yet.
- *
- * TODO: Remove once the spec covers it.
- */
-export interface TaskSpecGaps {
-    description?: string;
-    /**
-     * Whether the task is published on its public landing page. Derived from
-     * `publicConfig.publishedAt` -- set it on update to publish or unpublish the task.
-     * @since Added in 2.25.0
-     */
-    isPublic?: boolean;
-    /**
-     * @since Added in 2.25.0
-     */
-    publicConfig?: TaskPublicConfig | null;
+export interface TaskPublicConfig extends GeneratedTaskPublicConfig {
 }
 export interface TaskRePointed {
     stats?: TaskStats | null;
     options?: TaskOptions | null;
     actorStandby?: ActorStandby | null;
-}
-export interface TaskSpecNarrowings {
+    publicConfig?: TaskPublicConfig | null;
     input?: Dictionary | Dictionary[] | null;
 }
 /**
@@ -627,7 +602,7 @@ export interface TaskSpecNarrowings {
  * Tasks are saved Actor configurations with input and settings that can be executed
  * repeatedly without having to specify the full input each time.
  */
-export interface Task extends Omit<Schemas['Task'], keyof TaskRePointed | keyof TaskSpecNarrowings>, TaskRePointed, TaskSpecNarrowings, TaskSpecGaps {
+export interface Task extends Omit<Schemas['Task'], keyof TaskRePointed>, TaskRePointed {
 }
 export interface TaskListRePointed {
     stats?: TaskStats | null;
@@ -635,7 +610,7 @@ export interface TaskListRePointed {
 /**
  * Fields the API returns on a listed task that the OpenAPI spec does not describe yet.
  *
- * `description` is deliberately not here, although `TaskSpecGaps` claims it on the full resource: the
+ * `description` is deliberately not here, although the spec has it on the full `Task` resource: the
  * list endpoint publishes a smaller set of fields, and that is one of the fields it leaves out.
  *
  * TODO: Remove once the spec covers it.
@@ -756,7 +731,7 @@ export interface ScheduledActorRunInput extends GeneratedScheduleActionRunInput
 export interface ScheduledActorRunOptions extends GeneratedTaskOptions {
 }
 export interface ScheduleActionRunActorRePointed {
-    type: ScheduleActions.RunActor;
+    type: `${ScheduleActions.RunActor}`;
     runInput?: ScheduledActorRunInput | null;
     runOptions?: ScheduledActorRunOptions | null;
 }
@@ -764,13 +739,17 @@ export interface ScheduleActionRunActorRePointed {
 export interface ScheduleActionRunActor extends Omit<Schemas['ScheduleActionRunActor'], keyof ScheduleActionRunActorRePointed>, ScheduleActionRunActorRePointed {
 }
 export interface ScheduleActionRunActorTaskRePointed {
-    type: ScheduleActions.RunActorTask;
+    type: `${ScheduleActions.RunActorTask}`;
 }
 /** Scheduled action to run an Actor task. */
 export interface ScheduleActionRunActorTask extends Omit<Schemas['ScheduleActionRunActorTask'], keyof ScheduleActionRunActorTaskRePointed>, ScheduleActionRunActorTaskRePointed {
 }
 /** Union type representing all possible scheduled actions. */
 export type ScheduleAction = ScheduleActionRunActor | ScheduleActionRunActorTask;
+type GeneratedScheduleInvoked = Schemas['ScheduleInvoked'];
+/** One entry of a schedule's log: an invocation of the schedule and how it went. */
+export interface ScheduleInvoked extends GeneratedScheduleInvoked {
+}
 export interface ScheduleRePointed {
     actions: ScheduleAction[];
 }
@@ -850,11 +829,8 @@ export interface UserPlan extends Omit<Schemas['Plan'], keyof UserPlanRePointed>
 export interface UserRePointed {
     profile?: UserProfile;
     proxy?: UserProxy;
-}
-export interface UserSpecNarrowings {
     plan?: UserPlan;
     effectivePlatformFeatures?: EffectivePlatformFeatures;
-    isPaying?: boolean;
 }
 /**
  * A user account.
@@ -862,7 +838,7 @@ export interface UserSpecNarrowings {
  * The private fields are only populated for `GET /v2/users/me`, which needs a token; the public
  * endpoint returns the username and profile alone.
  */
-export interface User extends Omit<Schemas['UserPrivateInfo'], keyof UserRePointed | keyof UserSpecNarrowings>, UserRePointed, UserSpecNarrowings {
+export interface User extends Omit<Schemas['UserPrivateInfo'], keyof UserRePointed>, UserRePointed {
 }
 /**
  * The start and end of a billing cycle.
@@ -897,11 +873,8 @@ export interface ServiceUsage {
 export interface DailyServiceUsageRePointed {
     serviceUsage: ServiceUsage;
 }
-export interface DailyServiceUsageClientConversions {
-    date: Date;
-}
 /** A single day's usage within a monthly cycle. The spec names this schema `DailyServiceUsages`. */
-export interface DailyServiceUsage extends Omit<Schemas['DailyServiceUsages'], keyof DailyServiceUsageRePointed | keyof DailyServiceUsageClientConversions>, DailyServiceUsageRePointed, DailyServiceUsageClientConversions {
+export interface DailyServiceUsage extends Omit<Schemas['DailyServiceUsages'], keyof DailyServiceUsageRePointed>, DailyServiceUsageRePointed {
 }
 export interface MonthlyUsageRePointed {
     usageCycle: UsageCycle;
@@ -954,21 +927,20 @@ export interface RequestQueueStats extends GeneratedRequestQueueStats {
 /**
  * Fields the API returns on a request queue that the OpenAPI spec does not describe yet.
  *
- * The spec does carry `username` and `expireAt` on `RequestQueueShort`, the listing shape, and simply
- * omits both from the full `RequestQueue` schema. `title` is absent from either.
+ * The spec does carry `username` on `RequestQueueShort`, the listing shape, and simply omits it from the
+ * full `RequestQueue` schema. `title` is absent from either.
  *
  * TODO: Remove once the spec covers them.
  */
 export interface RequestQueueSpecGaps {
     title?: string;
     username?: string;
-    expireAt?: Date;
 }
 export interface RequestQueueRePointed {
     stats?: RequestQueueStats;
+    generalAccess?: STORAGE_GENERAL_ACCESS | null;
 }
 export interface RequestQueueSpecNarrowings {
-    generalAccess?: STORAGE_GENERAL_ACCESS | null;
     consoleUrl?: string;
 }
 /**