zenrows 2.0.3 → 2.1.1

package/README.md

@@ -17,6 +17,7 @@ SDK to access [Zenrows](https://www.zenrows.com/) API directly from Node.js. Zen
   - [POST Requests](#post-requests)
   - [Extract](#extract)
   - [Batch](#batch)
+    - [Failed runs and extensible values](#failed-runs-and-extensible-values)
     - [Extract in a batch](#extract-in-a-batch)
   - [Concurrency](#concurrency)
     - [An important note about Promise.allSettled() on TypeScript](#an-important-note-about-promiseallsettled-on-typescript)
@@ -226,6 +227,17 @@ const apiKey = "YOUR-API-KEY";
 
 `client.batch` also exposes `listJobs()`, `deleteJob()`, `stopRun()`, `rerun()`, `listRuns()`, `getRun()`, `deleteRun()`, and `getTaskContent()` (returns the scraped page's raw content as a string, not JSON — the endpoint can return HTML or plain text depending on what the target page served). Scheduling, webhook config, HMAC key rotation, CSV task uploads, and results exports aren't wrapped yet — call the [Batch API](https://docs.zenrows.com) directly for those.
 
+#### Failed runs and extensible values
+
+A run the server auto-fails carries `failure_reason` and a human-readable `failure_detail`. Starting, rerunning or resuming a job whose API key hit one of its credit caps throws a `ZenRowsBatchError` with `status` 402 and `code` `"api_key_cap_reached"`; `error.problem.detail` names the cap and when it resets (UTC).
+
+```js
+const run = await client.batch.getRun(jobId, runId);
+if (run.data.failure_reason === "api_key_cap_reached") console.log(run.data.failure_detail);
+```
+
+Enum-valued fields on responses (run, job, task and export `status`, `ingest_status`, `failure_reason`) are typed `Extensible<...>`: the known values plus any `string`, because the server may add values. The exported named types (`RunStatus`, `JobStatus`, `TaskStatus`, `ExportStatus`, `IngestStatus`, `RunFailureReason`) stay closed, so they still work as request input. Give switches on these fields a default branch; an exhaustive `switch` that assigns the leftover to `never` no longer compiles.
+
 #### Extract in a batch
 
 Set `extract` in the batch params to run tasks through Extract — structured data instead of raw HTML. It works job-wide or per task, and per-task values win on collision.

package/dist/index.cjs

@@ -73,7 +73,7 @@ var import_fetch_retry = __toESM(require("fetch-retry"), 1);
 // package.json
 var package_default = {
   name: "zenrows",
-  version: "2.0.2",
+  version: "2.1.1",
   description: "ZenRows Node SDK",
   main: "./dist/index.cjs",
   module: "./dist/index.js",
@@ -95,7 +95,15 @@ var package_default = {
     format: "biome format --write .",
     check: "biome check ."
   },
-  keywords: ["sdk", "zenrows", "scraping"],
+  keywords: [
+    "sdk",
+    "zenrows",
+    "scraping",
+    "proxy",
+    "data extraction",
+    "web scraping",
+    "web scraping api"
+  ],
   author: "ZenRows",
   repository: {
     type: "git",
@@ -839,7 +847,7 @@ async function pollUntil(fetch2, {
 
 // src/batch/client.ts
 var DEFAULT_BATCH_API_URL = "https://async.api.zenrows.com/v1";
-var TERMINAL_RUN_STATUSES = /* @__PURE__ */ new Set(["completed", "stopped", "deleted"]);
+var TERMINAL_RUN_STATUSES = /* @__PURE__ */ new Set(["completed", "stopped", "failed", "deleted"]);
 var TERMINAL_EXPORT_STATUSES = /* @__PURE__ */ new Set(["completed", "failed"]);
 function coerceUrl(item) {
   return typeof item === "string" ? { url: item } : item;
@@ -1202,7 +1210,8 @@ var ZenRowsBatchClient = class {
       return this._getRunData(jobId, options.runId);
     };
     return pollUntil(fetchRun, {
-      isDone: (run) => run !== void 0 && target.has(run.status),
+      // A status the caller named as a failure throws, even when it is also a target.
+      isDone: (run) => run !== void 0 && target.has(run.status) && !options.failureStatuses?.has(run.status),
       isFailure: (run) => run !== void 0 && Boolean(options.failureStatuses?.has(run.status)),
       timeout: options.timeout ?? 300,
       initialInterval: options.pollInterval ?? 2,

package/dist/index.d.cts

@@ -1,14 +1,29 @@
 import * as fetch_retry from 'fetch-retry';
 import fastq from 'fastq';
 
+/**
+ * A server-extensible string enum: the listed values autocomplete, but the server may
+ * return values not listed (the Batch API marks these `x-extensible-enum`). Response fields
+ * use `Extensible<...>`, so callers must handle an unknown value. The named types stay closed
+ * so they keep working as request input.
+ */
+type Extensible<T extends string> = T | (string & {});
 type JobType = "regular" | "scheduled";
 type JobStatus = "open" | "closed" | "deleted";
 type ScheduleState = "active" | "paused";
 type RunStatus = "pending" | "running" | "completed" | "failed" | "stopped" | "deleted";
-type TaskStatus = "pending" | "successful" | "failed";
+type TaskStatus = "pending" | "processing" | "successful" | "failed";
 type PauseState = "active" | "paused";
 type IngestStatus = "pending" | "done";
 type ExportStatus = "pending" | "running" | "completed" | "failed";
+/**
+ * Why a run auto-failed (`status == "failed"`).
+ * - `insufficient_credits` — the account is out of credits.
+ * - `subscription_inactive` — the subscription is not active.
+ * - `api_key_cap_reached` — the job's API key reached one of its credit caps; resolves when
+ *   that cap's window resets or the cap is raised. `Run.failure_detail` says which.
+ */
+type RunFailureReason = "insufficient_credits" | "subscription_inactive" | "api_key_cap_reached";
 interface Spend {
     credits: number;
     cost: number;
@@ -53,19 +68,21 @@ interface Run {
     run_id: string;
     job_id: string;
     run_sequence: number;
-    status: RunStatus;
+    status: Extensible<RunStatus>;
     stats: RunStats;
     last_batch_received?: boolean;
     pause_state?: PauseState;
-    ingest_status?: IngestStatus;
-    failure_reason?: "insufficient_credits" | "subscription_inactive";
+    ingest_status?: Extensible<IngestStatus>;
+    failure_reason?: Extensible<RunFailureReason>;
+    /** Human-readable explanation of `failure_reason` (e.g. which cap, and when it resets, UTC). */
+    failure_detail?: string | null;
     created_at?: string;
     updated_at?: string;
 }
 interface Job {
     job_id: string;
     type: JobType;
-    status: JobStatus;
+    status: Extensible<JobStatus>;
     format?: string;
     zenrows_params?: Record<string, string>;
     external_id?: string;
@@ -89,19 +106,19 @@ interface ListJobRunsResponse {
 }
 interface SubmitJobResponse {
     job_id: string;
-    status: JobStatus;
+    status: Extensible<JobStatus>;
     latest_run?: Run;
     accepted_tasks: number;
     webhook?: WebhookConfig;
 }
 interface AddTasksResponse {
     accepted_tasks: number;
-    job_status: JobStatus;
+    job_status: Extensible<JobStatus>;
     latest_run: Run;
 }
 interface RerunJobResponse {
     job_id: string;
-    status: JobStatus;
+    status: Extensible<JobStatus>;
     latest_run: Run;
     rerun_of?: string;
     retried_tasks: number;
@@ -122,7 +139,7 @@ interface TaskResult {
     url: string;
     metadata?: Record<string, string>;
     method?: "GET" | "POST";
-    status: TaskStatus;
+    status: Extensible<TaskStatus>;
     type?: string;
     result_url?: string;
     error?: ProblemJson;
@@ -145,13 +162,13 @@ interface TaskHistoryResponse {
 }
 interface StartExportResponse {
     export_id: string;
-    status: ExportStatus;
+    status: Extensible<ExportStatus>;
     created_at: string;
     expires_at: string;
 }
 interface Export {
     export_id: string;
-    status: ExportStatus;
+    status: Extensible<ExportStatus>;
     error?: string;
     download_url?: string;
     created_at: string;
@@ -350,7 +367,7 @@ declare class RunRef {
 declare class RunHandle extends RunRef {
     readonly data: Run;
     constructor(client: ZenRowsBatchClient, jobId: string, runId: string, data: Run);
-    get status(): RunStatus;
+    get status(): Extensible<RunStatus>;
     get stats(): RunStats;
 }
 declare class ExportRef {
@@ -372,7 +389,7 @@ declare class ExportRef {
 declare class ExportHandle extends ExportRef {
     readonly data: Export;
     constructor(client: ZenRowsBatchClient, jobId: string, runId: string, exportId: string, data: Export, startResponse?: StartExportResponse);
-    get status(): ExportStatus;
+    get status(): Extensible<ExportStatus>;
 }
 /** Operations on a job's CURRENT run, reached via `job.run`. */
 declare class CurrentRun {
@@ -431,7 +448,7 @@ declare class JobRef {
     /** Operations on the schedule — pause/resume/update (scheduled jobs only). */
     get schedule(): ScheduleControls;
     /** The job status from the submit response — only known on refs from a `submit*` call. */
-    get status(): JobStatus | undefined;
+    get status(): Extensible<JobStatus> | undefined;
     get acceptedTasks(): number | undefined;
     load(): Promise<JobHandle>;
     close(): Promise<JobHandle>;
@@ -449,7 +466,7 @@ declare class JobRef {
         lastBatch?: boolean;
     }): Promise<{
         accepted_tasks: number;
-        job_status: JobStatus;
+        job_status: Extensible<JobStatus>;
         latest_run: Run;
     }>;
     runs(pageSize?: number): AsyncGenerator<RunHandle>;
@@ -475,7 +492,7 @@ declare class JobRef {
 declare class JobHandle extends JobRef {
     readonly data: Job;
     constructor(client: ZenRowsBatchClient, jobId: string, data: Job, submitResponse?: SubmitJobResponse);
-    get status(): JobStatus;
+    get status(): Extensible<JobStatus>;
 }
 
 interface BatchClientConfig {
@@ -531,7 +548,16 @@ interface GetResultsOptions {
 }
 interface WaitForRunOptions {
     runId?: string;
+    /**
+     * Statuses that resolve the wait. Defaults to every terminal status (`completed`,
+     * `stopped`, `failed`, `deleted`), so an auto-failed run resolves with its
+     * `failure_reason` / `failure_detail` instead of polling until `timeout`.
+     */
     targetStatuses?: Set<string>;
+    /**
+     * Statuses that reject with `WaiterFailureError`. Takes precedence over `targetStatuses`,
+     * so `new Set(["failed"])` makes a failed run throw. Empty by default.
+     */
     failureStatuses?: Set<string>;
     timeout?: number;
     pollInterval?: number;
@@ -541,6 +567,8 @@ type TaskInput = string | {
     url: string;
     external_id?: string;
     metadata?: Record<string, unknown>;
+    /** Per-task scrape params, merged over the job-level `zenrowsParams` (task wins). */
+    zenrows_params?: Record<string, unknown>;
 };
 /**
  * Client for the Zenrows Batch API (async, job/run/task model). Usable standalone
@@ -816,4 +844,4 @@ declare class ZenRows {
     private worker;
 }
 
-export { AUTO_MAX_CREDITS, AUTO_MIN_CREDITS, type AddTasksResponse, At, BASE_CREDITS, type BatchClientConfig, type BatchTask, type BatchWebhookConfig, type Cadence, Calendar, type CostEstimate, type CostLine, type CreateJobInputResponse, CurrentRun, DEFAULT_MAX_BYTES_PER_FILE, DEFAULT_MAX_COUNT_IN_MEMORY, DEFAULT_MAX_FILES, DEFAULT_MAX_TOTAL_BYTES_IN_MEMORY, Daily, type DownloadToDirOptions, type DownloadToMemoryOptions, type DownloadedResult, type EstimateTask, type Export, ExportHandle, ExportRef, type ExportStatus, type ExtractMode, type FileInputUploadTarget, type GetResultsOptions, type HMACKeyCreated, type HMACKeyFinalized, type HMACKeyList, type HMACKeyMeta, type IngestStatus, JS_AND_PROXY_CREDITS, JS_CREDITS, type Job, JobHandle, JobRef, type JobSchedule, type JobStatus, type JobType, type ListJobRunsResponse, type ListJobsOptions, type ListJobsResponse, type ListResultsResponse, Monthly, PREMIUM_PROXY_CREDITS, type ParamMap, type ParamValue, type PauseState, type PollUntilOptions, type ProblemJson, Rate, type RerunJobResponse, type Run, RunHandle, RunRef, type RunStats, type RunStatus, type Schedule, type ScheduleState, type Spend, type StartExportResponse, type SubmitJobOptions, type SubmitJobResponse, type SubmitTypedOptions, type TaskHistoryEvent, type TaskHistoryResponse, type TaskLike, type TaskResult, type TaskSpend, type TaskStatus, type TestWebhookResponse, type Tier, type WaitForRunOptions, WaiterFailureError, WaiterTimeoutError, type WebhookConfig, Weekly, ZenRows, ZenRowsBatchClient, ZenRowsBatchError, type ZenRowsConfig, downloadTaskToFile, downloadTaskToMemory, downloadToDir, downloadToMemory, estimateCost, parseProblem, pollUntil };
+export { AUTO_MAX_CREDITS, AUTO_MIN_CREDITS, type AddTasksResponse, At, BASE_CREDITS, type BatchClientConfig, type BatchTask, type BatchWebhookConfig, type Cadence, Calendar, type CostEstimate, type CostLine, type CreateJobInputResponse, CurrentRun, DEFAULT_MAX_BYTES_PER_FILE, DEFAULT_MAX_COUNT_IN_MEMORY, DEFAULT_MAX_FILES, DEFAULT_MAX_TOTAL_BYTES_IN_MEMORY, Daily, type DownloadToDirOptions, type DownloadToMemoryOptions, type DownloadedResult, type EstimateTask, type Export, ExportHandle, ExportRef, type ExportStatus, type Extensible, type ExtractMode, type FileInputUploadTarget, type GetResultsOptions, type HMACKeyCreated, type HMACKeyFinalized, type HMACKeyList, type HMACKeyMeta, type IngestStatus, JS_AND_PROXY_CREDITS, JS_CREDITS, type Job, JobHandle, JobRef, type JobSchedule, type JobStatus, type JobType, type ListJobRunsResponse, type ListJobsOptions, type ListJobsResponse, type ListResultsResponse, Monthly, PREMIUM_PROXY_CREDITS, type ParamMap, type ParamValue, type PauseState, type PollUntilOptions, type ProblemJson, Rate, type RerunJobResponse, type Run, type RunFailureReason, RunHandle, RunRef, type RunStats, type RunStatus, type Schedule, type ScheduleState, type Spend, type StartExportResponse, type SubmitJobOptions, type SubmitJobResponse, type SubmitTypedOptions, type TaskHistoryEvent, type TaskHistoryResponse, type TaskLike, type TaskResult, type TaskSpend, type TaskStatus, type TestWebhookResponse, type Tier, type WaitForRunOptions, WaiterFailureError, WaiterTimeoutError, type WebhookConfig, Weekly, ZenRows, ZenRowsBatchClient, ZenRowsBatchError, type ZenRowsConfig, downloadTaskToFile, downloadTaskToMemory, downloadToDir, downloadToMemory, estimateCost, parseProblem, pollUntil };

package/dist/index.d.ts

@@ -1,14 +1,29 @@
 import * as fetch_retry from 'fetch-retry';
 import fastq from 'fastq';
 
+/**
+ * A server-extensible string enum: the listed values autocomplete, but the server may
+ * return values not listed (the Batch API marks these `x-extensible-enum`). Response fields
+ * use `Extensible<...>`, so callers must handle an unknown value. The named types stay closed
+ * so they keep working as request input.
+ */
+type Extensible<T extends string> = T | (string & {});
 type JobType = "regular" | "scheduled";
 type JobStatus = "open" | "closed" | "deleted";
 type ScheduleState = "active" | "paused";
 type RunStatus = "pending" | "running" | "completed" | "failed" | "stopped" | "deleted";
-type TaskStatus = "pending" | "successful" | "failed";
+type TaskStatus = "pending" | "processing" | "successful" | "failed";
 type PauseState = "active" | "paused";
 type IngestStatus = "pending" | "done";
 type ExportStatus = "pending" | "running" | "completed" | "failed";
+/**
+ * Why a run auto-failed (`status == "failed"`).
+ * - `insufficient_credits` — the account is out of credits.
+ * - `subscription_inactive` — the subscription is not active.
+ * - `api_key_cap_reached` — the job's API key reached one of its credit caps; resolves when
+ *   that cap's window resets or the cap is raised. `Run.failure_detail` says which.
+ */
+type RunFailureReason = "insufficient_credits" | "subscription_inactive" | "api_key_cap_reached";
 interface Spend {
     credits: number;
     cost: number;
@@ -53,19 +68,21 @@ interface Run {
     run_id: string;
     job_id: string;
     run_sequence: number;
-    status: RunStatus;
+    status: Extensible<RunStatus>;
     stats: RunStats;
     last_batch_received?: boolean;
     pause_state?: PauseState;
-    ingest_status?: IngestStatus;
-    failure_reason?: "insufficient_credits" | "subscription_inactive";
+    ingest_status?: Extensible<IngestStatus>;
+    failure_reason?: Extensible<RunFailureReason>;
+    /** Human-readable explanation of `failure_reason` (e.g. which cap, and when it resets, UTC). */
+    failure_detail?: string | null;
     created_at?: string;
     updated_at?: string;
 }
 interface Job {
     job_id: string;
     type: JobType;
-    status: JobStatus;
+    status: Extensible<JobStatus>;
     format?: string;
     zenrows_params?: Record<string, string>;
     external_id?: string;
@@ -89,19 +106,19 @@ interface ListJobRunsResponse {
 }
 interface SubmitJobResponse {
     job_id: string;
-    status: JobStatus;
+    status: Extensible<JobStatus>;
     latest_run?: Run;
     accepted_tasks: number;
     webhook?: WebhookConfig;
 }
 interface AddTasksResponse {
     accepted_tasks: number;
-    job_status: JobStatus;
+    job_status: Extensible<JobStatus>;
     latest_run: Run;
 }
 interface RerunJobResponse {
     job_id: string;
-    status: JobStatus;
+    status: Extensible<JobStatus>;
     latest_run: Run;
     rerun_of?: string;
     retried_tasks: number;
@@ -122,7 +139,7 @@ interface TaskResult {
     url: string;
     metadata?: Record<string, string>;
     method?: "GET" | "POST";
-    status: TaskStatus;
+    status: Extensible<TaskStatus>;
     type?: string;
     result_url?: string;
     error?: ProblemJson;
@@ -145,13 +162,13 @@ interface TaskHistoryResponse {
 }
 interface StartExportResponse {
     export_id: string;
-    status: ExportStatus;
+    status: Extensible<ExportStatus>;
     created_at: string;
     expires_at: string;
 }
 interface Export {
     export_id: string;
-    status: ExportStatus;
+    status: Extensible<ExportStatus>;
     error?: string;
     download_url?: string;
     created_at: string;
@@ -350,7 +367,7 @@ declare class RunRef {
 declare class RunHandle extends RunRef {
     readonly data: Run;
     constructor(client: ZenRowsBatchClient, jobId: string, runId: string, data: Run);
-    get status(): RunStatus;
+    get status(): Extensible<RunStatus>;
     get stats(): RunStats;
 }
 declare class ExportRef {
@@ -372,7 +389,7 @@ declare class ExportRef {
 declare class ExportHandle extends ExportRef {
     readonly data: Export;
     constructor(client: ZenRowsBatchClient, jobId: string, runId: string, exportId: string, data: Export, startResponse?: StartExportResponse);
-    get status(): ExportStatus;
+    get status(): Extensible<ExportStatus>;
 }
 /** Operations on a job's CURRENT run, reached via `job.run`. */
 declare class CurrentRun {
@@ -431,7 +448,7 @@ declare class JobRef {
     /** Operations on the schedule — pause/resume/update (scheduled jobs only). */
     get schedule(): ScheduleControls;
     /** The job status from the submit response — only known on refs from a `submit*` call. */
-    get status(): JobStatus | undefined;
+    get status(): Extensible<JobStatus> | undefined;
     get acceptedTasks(): number | undefined;
     load(): Promise<JobHandle>;
     close(): Promise<JobHandle>;
@@ -449,7 +466,7 @@ declare class JobRef {
         lastBatch?: boolean;
     }): Promise<{
         accepted_tasks: number;
-        job_status: JobStatus;
+        job_status: Extensible<JobStatus>;
         latest_run: Run;
     }>;
     runs(pageSize?: number): AsyncGenerator<RunHandle>;
@@ -475,7 +492,7 @@ declare class JobRef {
 declare class JobHandle extends JobRef {
     readonly data: Job;
     constructor(client: ZenRowsBatchClient, jobId: string, data: Job, submitResponse?: SubmitJobResponse);
-    get status(): JobStatus;
+    get status(): Extensible<JobStatus>;
 }
 
 interface BatchClientConfig {
@@ -531,7 +548,16 @@ interface GetResultsOptions {
 }
 interface WaitForRunOptions {
     runId?: string;
+    /**
+     * Statuses that resolve the wait. Defaults to every terminal status (`completed`,
+     * `stopped`, `failed`, `deleted`), so an auto-failed run resolves with its
+     * `failure_reason` / `failure_detail` instead of polling until `timeout`.
+     */
     targetStatuses?: Set<string>;
+    /**
+     * Statuses that reject with `WaiterFailureError`. Takes precedence over `targetStatuses`,
+     * so `new Set(["failed"])` makes a failed run throw. Empty by default.
+     */
     failureStatuses?: Set<string>;
     timeout?: number;
     pollInterval?: number;
@@ -541,6 +567,8 @@ type TaskInput = string | {
     url: string;
     external_id?: string;
     metadata?: Record<string, unknown>;
+    /** Per-task scrape params, merged over the job-level `zenrowsParams` (task wins). */
+    zenrows_params?: Record<string, unknown>;
 };
 /**
  * Client for the Zenrows Batch API (async, job/run/task model). Usable standalone
@@ -816,4 +844,4 @@ declare class ZenRows {
     private worker;
 }
 
-export { AUTO_MAX_CREDITS, AUTO_MIN_CREDITS, type AddTasksResponse, At, BASE_CREDITS, type BatchClientConfig, type BatchTask, type BatchWebhookConfig, type Cadence, Calendar, type CostEstimate, type CostLine, type CreateJobInputResponse, CurrentRun, DEFAULT_MAX_BYTES_PER_FILE, DEFAULT_MAX_COUNT_IN_MEMORY, DEFAULT_MAX_FILES, DEFAULT_MAX_TOTAL_BYTES_IN_MEMORY, Daily, type DownloadToDirOptions, type DownloadToMemoryOptions, type DownloadedResult, type EstimateTask, type Export, ExportHandle, ExportRef, type ExportStatus, type ExtractMode, type FileInputUploadTarget, type GetResultsOptions, type HMACKeyCreated, type HMACKeyFinalized, type HMACKeyList, type HMACKeyMeta, type IngestStatus, JS_AND_PROXY_CREDITS, JS_CREDITS, type Job, JobHandle, JobRef, type JobSchedule, type JobStatus, type JobType, type ListJobRunsResponse, type ListJobsOptions, type ListJobsResponse, type ListResultsResponse, Monthly, PREMIUM_PROXY_CREDITS, type ParamMap, type ParamValue, type PauseState, type PollUntilOptions, type ProblemJson, Rate, type RerunJobResponse, type Run, RunHandle, RunRef, type RunStats, type RunStatus, type Schedule, type ScheduleState, type Spend, type StartExportResponse, type SubmitJobOptions, type SubmitJobResponse, type SubmitTypedOptions, type TaskHistoryEvent, type TaskHistoryResponse, type TaskLike, type TaskResult, type TaskSpend, type TaskStatus, type TestWebhookResponse, type Tier, type WaitForRunOptions, WaiterFailureError, WaiterTimeoutError, type WebhookConfig, Weekly, ZenRows, ZenRowsBatchClient, ZenRowsBatchError, type ZenRowsConfig, downloadTaskToFile, downloadTaskToMemory, downloadToDir, downloadToMemory, estimateCost, parseProblem, pollUntil };
+export { AUTO_MAX_CREDITS, AUTO_MIN_CREDITS, type AddTasksResponse, At, BASE_CREDITS, type BatchClientConfig, type BatchTask, type BatchWebhookConfig, type Cadence, Calendar, type CostEstimate, type CostLine, type CreateJobInputResponse, CurrentRun, DEFAULT_MAX_BYTES_PER_FILE, DEFAULT_MAX_COUNT_IN_MEMORY, DEFAULT_MAX_FILES, DEFAULT_MAX_TOTAL_BYTES_IN_MEMORY, Daily, type DownloadToDirOptions, type DownloadToMemoryOptions, type DownloadedResult, type EstimateTask, type Export, ExportHandle, ExportRef, type ExportStatus, type Extensible, type ExtractMode, type FileInputUploadTarget, type GetResultsOptions, type HMACKeyCreated, type HMACKeyFinalized, type HMACKeyList, type HMACKeyMeta, type IngestStatus, JS_AND_PROXY_CREDITS, JS_CREDITS, type Job, JobHandle, JobRef, type JobSchedule, type JobStatus, type JobType, type ListJobRunsResponse, type ListJobsOptions, type ListJobsResponse, type ListResultsResponse, Monthly, PREMIUM_PROXY_CREDITS, type ParamMap, type ParamValue, type PauseState, type PollUntilOptions, type ProblemJson, Rate, type RerunJobResponse, type Run, type RunFailureReason, RunHandle, RunRef, type RunStats, type RunStatus, type Schedule, type ScheduleState, type Spend, type StartExportResponse, type SubmitJobOptions, type SubmitJobResponse, type SubmitTypedOptions, type TaskHistoryEvent, type TaskHistoryResponse, type TaskLike, type TaskResult, type TaskSpend, type TaskStatus, type TestWebhookResponse, type Tier, type WaitForRunOptions, WaiterFailureError, WaiterTimeoutError, type WebhookConfig, Weekly, ZenRows, ZenRowsBatchClient, ZenRowsBatchError, type ZenRowsConfig, downloadTaskToFile, downloadTaskToMemory, downloadToDir, downloadToMemory, estimateCost, parseProblem, pollUntil };

package/dist/index.js

@@ -5,7 +5,7 @@ import fetchRetry from "fetch-retry";
 // package.json
 var package_default = {
   name: "zenrows",
-  version: "2.0.2",
+  version: "2.1.1",
   description: "ZenRows Node SDK",
   main: "./dist/index.cjs",
   module: "./dist/index.js",
@@ -27,7 +27,15 @@ var package_default = {
     format: "biome format --write .",
     check: "biome check ."
   },
-  keywords: ["sdk", "zenrows", "scraping"],
+  keywords: [
+    "sdk",
+    "zenrows",
+    "scraping",
+    "proxy",
+    "data extraction",
+    "web scraping",
+    "web scraping api"
+  ],
   author: "ZenRows",
   repository: {
     type: "git",
@@ -771,7 +779,7 @@ async function pollUntil(fetch2, {
 
 // src/batch/client.ts
 var DEFAULT_BATCH_API_URL = "https://async.api.zenrows.com/v1";
-var TERMINAL_RUN_STATUSES = /* @__PURE__ */ new Set(["completed", "stopped", "deleted"]);
+var TERMINAL_RUN_STATUSES = /* @__PURE__ */ new Set(["completed", "stopped", "failed", "deleted"]);
 var TERMINAL_EXPORT_STATUSES = /* @__PURE__ */ new Set(["completed", "failed"]);
 function coerceUrl(item) {
   return typeof item === "string" ? { url: item } : item;
@@ -1134,7 +1142,8 @@ var ZenRowsBatchClient = class {
       return this._getRunData(jobId, options.runId);
     };
     return pollUntil(fetchRun, {
-      isDone: (run) => run !== void 0 && target.has(run.status),
+      // A status the caller named as a failure throws, even when it is also a target.
+      isDone: (run) => run !== void 0 && target.has(run.status) && !options.failureStatuses?.has(run.status),
       isFailure: (run) => run !== void 0 && Boolean(options.failureStatuses?.has(run.status)),
       timeout: options.timeout ?? 300,
       initialInterval: options.pollInterval ?? 2,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zenrows",
-  "version": "2.0.3",
+  "version": "2.1.1",
   "description": "ZenRows Node SDK",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -25,7 +25,11 @@
   "keywords": [
     "sdk",
     "zenrows",
-    "scraping"
+    "scraping",
+    "proxy",
+    "data extraction",
+    "web scraping",
+    "web scraping api"
   ],
   "author": "ZenRows",
   "repository": {

package/tsconfig.test.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler"
+  },
+  "include": ["src", "tests"]
+}

package/vitest.config.ts

@@ -6,6 +6,8 @@ export default defineConfig({
     globals: true,
     include: ["tests/**/*.test.ts"],
     setupFiles: ["tests/_setup.ts"],
+    // Type-level assertions (expectTypeOf) only run under typecheck.
+    typecheck: { enabled: true, tsconfig: "./tsconfig.test.json", include: ["tests/**/*.test.ts"] },
     coverage: {
       include: ["src/**"],
       exclude: ["examples/**"],