apify-client 3.0.0-beta.70 → 3.0.0-beta.72

package/dist/schemas.d.ts

@@ -1,9 +1,9 @@
 /**
  * The schemas the resource clients validate API responses with.
  *
- * Today these are exactly the generated ones. The module still exists as the one place where a generated
- * schema is widened when the API is known to return something the specification does not describe, so a
- * documented deviation never sends a resource client reaching into `./generated` directly. An override
+ * Most of these are the generated ones. This module is the one place where a generated schema is widened
+ * when the API is known to return something the specification does not describe, so a documented deviation
+ * never sends a resource client reaching into `./generated` directly. An override
  * declared here shadows the generated export of the same name and takes the same form, a `lazySchema()` thunk
  * built on the generated schema it replaces. Every schema that embeds an overridden one has to be rebuilt on
  * top of it, and `spec_guards.ts` checks that each override still produces what the specification describes,
@@ -12,4 +12,201 @@
  * Spec gaps need no override: the generated objects are loose, so a field the specification omits passes
  * through. Neither do client narrowings: a schema only ever accepts more than the published type.
  */
+import { z } from 'zod';
 export * from './generated/schemas.js';
+/** The API returns `actVersion.buildTag` as `null` for some builds, which the specification types as a string. */
+export declare const Build: () => z.ZodObject<{
+    id: z.ZodString;
+    actId: z.ZodString;
+    userId: z.ZodString;
+    startedAt: z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>;
+    finishedAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>>>;
+    status: z.ZodUnion<[z.ZodEnum<{
+        ABORTED: "ABORTED";
+        ABORTING: "ABORTING";
+        FAILED: "FAILED";
+        READY: "READY";
+        RUNNING: "RUNNING";
+        SUCCEEDED: "SUCCEEDED";
+        "TIMED-OUT": "TIMED-OUT";
+        "TIMING-OUT": "TIMING-OUT";
+    }>, z.ZodString]>;
+    meta: z.ZodObject<{
+        origin: z.ZodUnion<[z.ZodEnum<{
+            ACTOR: "ACTOR";
+            API: "API";
+            CI: "CI";
+            CLI: "CLI";
+            DEVELOPMENT: "DEVELOPMENT";
+            MCP: "MCP";
+            SCHEDULER: "SCHEDULER";
+            STANDBY: "STANDBY";
+            TEST: "TEST";
+            WEB: "WEB";
+            WEBHOOK: "WEBHOOK";
+        }>, z.ZodString]>;
+        clientIp: z.ZodOptional<z.ZodString>;
+        userAgent: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>;
+    stats: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        durationMillis: z.ZodOptional<z.ZodInt>;
+        runTimeSecs: z.ZodOptional<z.ZodNumber>;
+        computeUnits: z.ZodOptional<z.ZodNumber>;
+        imageSizeBytes: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    }, z.core.$loose>>>;
+    options: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        useCache: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+        betaPackages: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+        memoryMbytes: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+        diskMbytes: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    }, z.core.$loose>>>;
+    usage: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        ACTOR_COMPUTE_UNITS: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$loose>>>;
+    usageTotalUsd: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    usageUsd: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        ACTOR_COMPUTE_UNITS: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$loose>>>;
+    inputSchema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    readme: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    buildNumber: z.ZodString;
+    imageDigest: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    actorDefinition: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        actorSpecification: z.ZodOptional<z.ZodLiteral<1>>;
+        name: z.ZodOptional<z.ZodString>;
+        version: z.ZodOptional<z.ZodString>;
+        buildTag: z.ZodOptional<z.ZodString>;
+        environmentVariables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        dockerfile: z.ZodOptional<z.ZodString>;
+        dockerContextDir: z.ZodOptional<z.ZodString>;
+        readme: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        input: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+        changelog: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        storages: z.ZodOptional<z.ZodObject<{
+            dataset: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, z.core.$loose>>;
+        defaultMemoryMbytes: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodInt]>>;
+        minMemoryMbytes: z.ZodOptional<z.ZodInt>;
+        maxMemoryMbytes: z.ZodOptional<z.ZodInt>;
+        usesStandbyMode: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$loose>>>;
+    actVersion: z.ZodOptional<z.ZodObject<{
+        sourceType: z.ZodOptional<z.ZodUnion<[z.ZodEnum<{
+            GITHUB_GIST: "GITHUB_GIST";
+            GIT_REPO: "GIT_REPO";
+            SOURCE_CODE: "SOURCE_CODE";
+            SOURCE_FILES: "SOURCE_FILES";
+            TARBALL: "TARBALL";
+        }>, z.ZodString]>>;
+        versionNumber: z.ZodOptional<z.ZodString>;
+        gitRepoUrl: z.ZodOptional<z.ZodString>;
+        sourceFiles: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            format: z.ZodOptional<z.ZodUnion<[z.ZodEnum<{
+                BASE64: "BASE64";
+                TEXT: "TEXT";
+            }>, z.ZodString]>>;
+            content: z.ZodOptional<z.ZodString>;
+            name: z.ZodString;
+        }, z.core.$loose>>>;
+        buildTag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+/** Response containing Actor build data. */
+export declare const BuildResponse: () => z.ZodObject<{
+    data: z.ZodObject<{
+        id: z.ZodString;
+        actId: z.ZodString;
+        userId: z.ZodString;
+        startedAt: z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>;
+        finishedAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>>>;
+        status: z.ZodUnion<[z.ZodEnum<{
+            ABORTED: "ABORTED";
+            ABORTING: "ABORTING";
+            FAILED: "FAILED";
+            READY: "READY";
+            RUNNING: "RUNNING";
+            SUCCEEDED: "SUCCEEDED";
+            "TIMED-OUT": "TIMED-OUT";
+            "TIMING-OUT": "TIMING-OUT";
+        }>, z.ZodString]>;
+        meta: z.ZodObject<{
+            origin: z.ZodUnion<[z.ZodEnum<{
+                ACTOR: "ACTOR";
+                API: "API";
+                CI: "CI";
+                CLI: "CLI";
+                DEVELOPMENT: "DEVELOPMENT";
+                MCP: "MCP";
+                SCHEDULER: "SCHEDULER";
+                STANDBY: "STANDBY";
+                TEST: "TEST";
+                WEB: "WEB";
+                WEBHOOK: "WEBHOOK";
+            }>, z.ZodString]>;
+            clientIp: z.ZodOptional<z.ZodString>;
+            userAgent: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>;
+        stats: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            durationMillis: z.ZodOptional<z.ZodInt>;
+            runTimeSecs: z.ZodOptional<z.ZodNumber>;
+            computeUnits: z.ZodOptional<z.ZodNumber>;
+            imageSizeBytes: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+        }, z.core.$loose>>>;
+        options: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            useCache: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+            betaPackages: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+            memoryMbytes: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+            diskMbytes: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+        }, z.core.$loose>>>;
+        usage: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            ACTOR_COMPUTE_UNITS: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        }, z.core.$loose>>>;
+        usageTotalUsd: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        usageUsd: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            ACTOR_COMPUTE_UNITS: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        }, z.core.$loose>>>;
+        inputSchema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        readme: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        buildNumber: z.ZodString;
+        imageDigest: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        actorDefinition: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            actorSpecification: z.ZodOptional<z.ZodLiteral<1>>;
+            name: z.ZodOptional<z.ZodString>;
+            version: z.ZodOptional<z.ZodString>;
+            buildTag: z.ZodOptional<z.ZodString>;
+            environmentVariables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            dockerfile: z.ZodOptional<z.ZodString>;
+            dockerContextDir: z.ZodOptional<z.ZodString>;
+            readme: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            input: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+            changelog: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            storages: z.ZodOptional<z.ZodObject<{
+                dataset: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            }, z.core.$loose>>;
+            defaultMemoryMbytes: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodInt]>>;
+            minMemoryMbytes: z.ZodOptional<z.ZodInt>;
+            maxMemoryMbytes: z.ZodOptional<z.ZodInt>;
+            usesStandbyMode: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$loose>>>;
+        actVersion: z.ZodOptional<z.ZodObject<{
+            sourceType: z.ZodOptional<z.ZodUnion<[z.ZodEnum<{
+                GITHUB_GIST: "GITHUB_GIST";
+                GIT_REPO: "GIT_REPO";
+                SOURCE_CODE: "SOURCE_CODE";
+                SOURCE_FILES: "SOURCE_FILES";
+                TARBALL: "TARBALL";
+            }>, z.ZodString]>>;
+            versionNumber: z.ZodOptional<z.ZodString>;
+            gitRepoUrl: z.ZodOptional<z.ZodString>;
+            sourceFiles: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                format: z.ZodOptional<z.ZodUnion<[z.ZodEnum<{
+                    BASE64: "BASE64";
+                    TEXT: "TEXT";
+                }>, z.ZodString]>>;
+                content: z.ZodOptional<z.ZodString>;
+                name: z.ZodString;
+            }, z.core.$loose>>>;
+            buildTag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$loose>>;
+    }, z.core.$loose>;
+}, z.core.$loose>;

package/dist/schemas.js

@@ -1,9 +1,9 @@
 /**
  * The schemas the resource clients validate API responses with.
  *
- * Today these are exactly the generated ones. The module still exists as the one place where a generated
- * schema is widened when the API is known to return something the specification does not describe, so a
- * documented deviation never sends a resource client reaching into `./generated` directly. An override
+ * Most of these are the generated ones. This module is the one place where a generated schema is widened
+ * when the API is known to return something the specification does not describe, so a documented deviation
+ * never sends a resource client reaching into `./generated` directly. An override
  * declared here shadows the generated export of the same name and takes the same form, a `lazySchema()` thunk
  * built on the generated schema it replaces. Every schema that embeds an overridden one has to be rebuilt on
  * top of it, and `spec_guards.ts` checks that each override still produces what the specification describes,
@@ -12,4 +12,19 @@
  * Spec gaps need no override: the generated objects are loose, so a field the specification omits passes
  * through. Neither do client narrowings: a schema only ever accepts more than the published type.
  */
+import { z } from 'zod';
+import * as generated from './generated/schemas.js';
+import { lazySchema } from './lazy_schema.js';
 export * from './generated/schemas.js';
+/** The API returns `actVersion.buildTag` as `null` for some builds, which the specification types as a string. */
+export const Build = lazySchema(() => {
+    const generatedBuild = generated.Build();
+    return generatedBuild.extend({
+        actVersion: generatedBuild.shape.actVersion
+            .unwrap()
+            .extend({ buildTag: z.string().nullable().optional() })
+            .optional(),
+    });
+});
+/** Response containing Actor build data. */
+export const BuildResponse = lazySchema(() => generated.BuildResponse().extend({ data: Build() }));

package/dist/utils.d.ts

@@ -101,6 +101,11 @@ export declare function splitIntoJsonArrayBatches<T extends {
     maxByteLength: number;
 }): T[][];
 export declare function isBuffer(value: unknown): value is Buffer | ArrayBuffer | TypedArray;
+/**
+ * Whether a value is a `Blob`, a `File` included. Unlike a stream, a blob can be read again for every attempt of a
+ * request, so a request with a blob body can be retried.
+ */
+export declare function isBlob(value: unknown): value is Blob;
 export declare function isStream(value: unknown): value is Readable;
 /**
  * Helper class to create async iterators from paginated list endpoints.

package/dist/utils.js

@@ -236,6 +236,13 @@ export function isBuffer(value) {
         return !isTagged(value, 'DataView');
     return isTagged(value, 'ArrayBuffer');
 }
+/**
+ * Whether a value is a `Blob`, a `File` included. Unlike a stream, a blob can be read again for every attempt of a
+ * request, so a request with a blob body can be retried.
+ */
+export function isBlob(value) {
+    return isTagged(value, 'Blob') || isTagged(value, 'File');
+}
 function isTagged(value, tag) {
     return Object.prototype.toString.call(value) === `[object ${tag}]`;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-client",
-  "version": "3.0.0-beta.70",
+  "version": "3.0.0-beta.72",
   "description": "Apify API client for JavaScript",
   "engines": {
     "node": ">=22.13.0"