@trigger.dev/sdk 0.0.0-prerelease-20241119135607 → 0.0.0-prerelease-20241128131418

package/dist/esm/triggerClient.d.ts

@@ -117,11 +117,7 @@ export declare class TriggerClient {
      */
     sendEvent(event: SendEvent, options?: SendEventOptions): Promise<{
         name: string;
-        payload: ((string | number | boolean | {
-            [key: string]: DeserializedJson;
-        } | DeserializedJson[]) & (string | number | boolean | {
-            [key: string]: DeserializedJson;
-        } | DeserializedJson[] | undefined)) | null;
+        payload: DeserializedJson;
         id: string;
         timestamp: Date;
         context?: DeserializedJson | undefined;
@@ -136,11 +132,7 @@ export declare class TriggerClient {
      */
     sendEvents(events: SendEvent[], options?: SendEventOptions): Promise<{
         name: string;
-        payload: ((string | number | boolean | {
-            [key: string]: DeserializedJson;
-        } | DeserializedJson[]) & (string | number | boolean | {
-            [key: string]: DeserializedJson;
-        } | DeserializedJson[] | undefined)) | null;
+        payload: DeserializedJson;
         id: string;
         timestamp: Date;
         context?: DeserializedJson | undefined;
@@ -150,11 +142,7 @@ export declare class TriggerClient {
     }[]>;
     cancelEvent(eventId: string): Promise<{
         name: string;
-        payload: ((string | number | boolean | {
-            [key: string]: DeserializedJson;
-        } | DeserializedJson[]) & (string | number | boolean | {
-            [key: string]: DeserializedJson;
-        } | DeserializedJson[] | undefined)) | null;
+        payload: DeserializedJson;
         id: string;
         timestamp: Date;
         context?: DeserializedJson | undefined;
@@ -174,8 +162,8 @@ export declare class TriggerClient {
             state?: "loading" | "success" | "failure" | undefined;
             data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
         }[];
-        data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
         state?: "loading" | "success" | "failure" | undefined;
+        data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
     }>;
     registerSchedule(id: string, key: string, schedule: ScheduleMetadata): Promise<{
         id: string;
@@ -184,15 +172,15 @@ export declare class TriggerClient {
                 cron: string;
             };
             type: "cron";
-            accountId?: string | undefined;
             metadata?: any;
+            accountId?: string | undefined;
         } | {
             options: {
                 seconds: number;
             };
             type: "interval";
-            accountId?: string | undefined;
             metadata?: any;
+            accountId?: string | undefined;
         };
         active: boolean;
         metadata?: any;
@@ -227,8 +215,8 @@ export declare class TriggerClient {
                 state?: "loading" | "success" | "failure" | undefined;
                 data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
             }[];
-            data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
             state?: "loading" | "success" | "failure" | undefined;
+            data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
         }[];
         output?: any;
         nextCursor?: string | undefined;
@@ -248,8 +236,8 @@ export declare class TriggerClient {
                 state?: "loading" | "success" | "failure" | undefined;
                 data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
             }[];
-            data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
             state?: "loading" | "success" | "failure" | undefined;
+            data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
         }[];
         output?: any;
         nextCursor?: string | undefined;
@@ -273,8 +261,8 @@ export declare class TriggerClient {
                 state?: "loading" | "success" | "failure" | undefined;
                 data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
             }[];
-            data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
             state?: "loading" | "success" | "failure" | undefined;
+            data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
         }[];
         run: {
             status: "PENDING" | "CANCELED" | "QUEUED" | "WAITING_ON_CONNECTIONS" | "PREPROCESSING" | "STARTED" | "SUCCESS" | "FAILURE" | "TIMED_OUT" | "ABORTED" | "UNRESOLVED_AUTH" | "INVALID_PAYLOAD" | "EXECUTING" | "WAITING_TO_CONTINUE" | "WAITING_TO_EXECUTE";

package/dist/esm/triggers/invokeTrigger.d.ts

@@ -22,8 +22,8 @@ export declare class InvokeTrigger<TSchema extends ZodType = z.ZodTypeAny> imple
         examples: {
             name: string;
             id: string;
-            icon?: string | undefined;
             payload?: any;
+            icon?: string | undefined;
         }[];
         icon: string;
         parsePayload: (rawPayload: unknown) => any;

package/dist/esm/triggers/scheduled.d.ts

@@ -119,15 +119,15 @@ export declare class DynamicSchedule implements Trigger<ScheduledEventSpecificat
                 cron: string;
             };
             type: "cron";
-            accountId?: string | undefined;
             metadata?: any;
+            accountId?: string | undefined;
         } | {
             options: {
                 seconds: number;
             };
             type: "interval";
-            accountId?: string | undefined;
             metadata?: any;
+            accountId?: string | undefined;
         };
         active: boolean;
         metadata?: any;

package/dist/esm/types.d.ts

@@ -118,13 +118,13 @@ export declare const EventSpecificationExampleSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     name: string;
     id: string;
-    icon?: string | undefined;
     payload?: any;
+    icon?: string | undefined;
 }, {
     name: string;
     id: string;
-    icon?: string | undefined;
     payload?: any;
+    icon?: string | undefined;
 }>;
 export type EventSpecificationExample = z.infer<typeof EventSpecificationExampleSchema>;
 export type TypedEventSpecificationExample<TEvent> = {

package/dist/esm/v3/batch.d.ts

@@ -0,0 +1,28 @@
+import { ApiPromise, ApiRequestOptions, RetrieveBatchResponse } from "@trigger.dev/core/v3";
+import { batchTriggerById, batchTriggerByIdAndWait, batchTriggerTasks, batchTriggerAndWaitTasks } from "./shared.js";
+export declare const batch: {
+    trigger: typeof batchTriggerById;
+    triggerAndWait: typeof batchTriggerByIdAndWait;
+    triggerByTask: typeof batchTriggerTasks;
+    triggerByTaskAndWait: typeof batchTriggerAndWaitTasks;
+    retrieve: typeof retrieveBatch;
+};
+/**
+ * Retrieves details about a specific batch by its ID.
+ *
+ * @param {string} batchId - The unique identifier of the batch to retrieve
+ * @param {ApiRequestOptions} [requestOptions] - Optional API request configuration options
+ * @returns {ApiPromise<RetrieveBatchResponse>} A promise that resolves with the batch details
+ *
+ * @example
+ * // First trigger a batch
+ * const response = await batch.trigger([
+ *   { id: "simple-task", payload: { message: "Hello, World!" } }
+ * ]);
+ *
+ * // Then retrieve the batch details
+ * const batchDetails = await batch.retrieve(response.batchId);
+ * console.log("batch", batchDetails);
+ */
+declare function retrieveBatch(batchId: string, requestOptions?: ApiRequestOptions): ApiPromise<RetrieveBatchResponse>;
+export {};

package/dist/esm/v3/batch.js

@@ -0,0 +1,49 @@
+import { accessoryAttributes, apiClientManager, mergeRequestOptions, } from "@trigger.dev/core/v3";
+import { batchTriggerById, batchTriggerByIdAndWait, batchTriggerTasks, batchTriggerAndWaitTasks, } from "./shared.js";
+import { tracer } from "./tracer.js";
+export const batch = {
+    trigger: batchTriggerById,
+    triggerAndWait: batchTriggerByIdAndWait,
+    triggerByTask: batchTriggerTasks,
+    triggerByTaskAndWait: batchTriggerAndWaitTasks,
+    retrieve: retrieveBatch,
+};
+/**
+ * Retrieves details about a specific batch by its ID.
+ *
+ * @param {string} batchId - The unique identifier of the batch to retrieve
+ * @param {ApiRequestOptions} [requestOptions] - Optional API request configuration options
+ * @returns {ApiPromise<RetrieveBatchResponse>} A promise that resolves with the batch details
+ *
+ * @example
+ * // First trigger a batch
+ * const response = await batch.trigger([
+ *   { id: "simple-task", payload: { message: "Hello, World!" } }
+ * ]);
+ *
+ * // Then retrieve the batch details
+ * const batchDetails = await batch.retrieve(response.batchId);
+ * console.log("batch", batchDetails);
+ */
+function retrieveBatch(batchId, requestOptions) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "batch.retrieve()",
+        icon: "batch",
+        attributes: {
+            batchId: batchId,
+            ...accessoryAttributes({
+                items: [
+                    {
+                        text: batchId,
+                        variant: "normal",
+                    },
+                ],
+                style: "codepath",
+            }),
+        },
+    }, requestOptions);
+    return apiClient.retrieveBatch(batchId, $requestOptions);
+}
+//# sourceMappingURL=batch.js.map

package/dist/esm/v3/batch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch.js","sourceRoot":"","sources":["../../../src/v3/batch.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,gBAAgB,EAGhB,mBAAmB,GAEpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EACvB,iBAAiB,EACjB,wBAAwB,GACzB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,OAAO,EAAE,gBAAgB;IACzB,cAAc,EAAE,uBAAuB;IACvC,aAAa,EAAE,iBAAiB;IAChC,oBAAoB,EAAE,wBAAwB;IAC9C,QAAQ,EAAE,aAAa;CACxB,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,SAAS,aAAa,CACpB,OAAe,EACf,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,OAAO,EAAE,OAAO;YAChB,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,OAAO;wBACb,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AAC3D,CAAC"}

package/dist/esm/v3/index.d.ts

@@ -3,6 +3,7 @@ export * from "./config.js";
 export { retry, type RetryOptions } from "./retry.js";
 export { queue } from "./shared.js";
 export * from "./tasks.js";
+export * from "./batch.js";
 export * from "./wait.js";
 export * from "./waitUntil.js";
 export * from "./usage.js";
@@ -16,7 +17,7 @@ import type { Context } from "./shared.js";
 import type { ApiClientConfiguration } from "@trigger.dev/core/v3";
 export type { ApiClientConfiguration };
 export { ApiError, AuthenticationError, BadRequestError, ConflictError, InternalServerError, NotFoundError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, AbortTaskRunError, logger, type LogLevel, } from "@trigger.dev/core/v3";
-export { runs, type RunShape, type AnyRunShape, type TaskRunShape, type RealtimeRun, type RetrieveRunResult, type AnyRetrieveRunResult, } from "./runs.js";
+export { runs, type RunShape, type AnyRunShape, type TaskRunShape, type RealtimeRun, type AnyRealtimeRun, type RetrieveRunResult, type AnyRetrieveRunResult, } from "./runs.js";
 export * as schedules from "./schedules/index.js";
 export * as envvars from "./envvars.js";
 export type { ImportEnvironmentVariablesParams } from "./envvars.js";

package/dist/esm/v3/index.js

@@ -3,6 +3,7 @@ export * from "./config.js";
 export { retry } from "./retry.js";
 export { queue } from "./shared.js";
 export * from "./tasks.js";
+export * from "./batch.js";
 export * from "./wait.js";
 export * from "./waitUntil.js";
 export * from "./usage.js";

package/dist/esm/v3/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v3/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAqB,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAS/B,OAAO,EACL,QAAQ,EACR,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,qBAAqB,EACrB,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EACjB,MAAM,GAEP,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,IAAI,GAOL,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AAGxC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v3/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAqB,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAS/B,OAAO,EACL,QAAQ,EACR,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,qBAAqB,EACrB,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EACjB,MAAM,GAEP,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,IAAI,GAQL,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AAGxC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC"}

package/dist/esm/v3/runs.d.ts

@@ -1,7 +1,7 @@
-import type { AnyRetrieveRunResult, AnyRunShape, ApiRequestOptions, InferRunTypes, ListProjectRunsQueryParams, ListRunsQueryParams, RescheduleRunRequestBody, RetrieveRunResult, RunShape, RealtimeRun, RunSubscription, TaskRunShape } from "@trigger.dev/core/v3";
+import type { AnyRetrieveRunResult, AnyRunShape, ApiRequestOptions, InferRunTypes, ListProjectRunsQueryParams, ListRunsQueryParams, RescheduleRunRequestBody, RetrieveRunResult, RunShape, RealtimeRun, AnyRealtimeRun, RunSubscription, TaskRunShape, AnyBatchedRunHandle } from "@trigger.dev/core/v3";
 import { ApiPromise, CanceledRunResponse, CursorPagePromise, ListRunResponseItem, ReplayRunResponse, RetrieveRunResponse } from "@trigger.dev/core/v3";
 import { AnyRunHandle, AnyTask } from "./shared.js";
-export type { AnyRetrieveRunResult, AnyRunShape, RetrieveRunResult, RunShape, TaskRunShape, RealtimeRun, };
+export type { AnyRetrieveRunResult, AnyRunShape, RetrieveRunResult, RunShape, TaskRunShape, RealtimeRun, AnyRealtimeRun, };
 export declare const runs: {
     replay: typeof replayRun;
     cancel: typeof cancelRun;
@@ -11,12 +11,13 @@ export declare const runs: {
     poll: typeof poll;
     subscribeToRun: typeof subscribeToRun;
     subscribeToRunsWithTag: typeof subscribeToRunsWithTag;
+    subscribeToBatch: typeof subscribeToRunsInBatch;
 };
 export type ListRunsItem = ListRunResponseItem;
 declare function listRuns(projectRef: string, params?: ListProjectRunsQueryParams, requestOptions?: ApiRequestOptions): CursorPagePromise<typeof ListRunResponseItem>;
 declare function listRuns(params?: ListRunsQueryParams, requestOptions?: ApiRequestOptions): CursorPagePromise<typeof ListRunResponseItem>;
-type RunId<TRunId> = TRunId extends AnyRunHandle ? TRunId : TRunId extends AnyTask ? string : TRunId extends string ? TRunId : never;
-declare function retrieveRun<TRunId extends AnyRunHandle | AnyTask | string>(runId: RunId<TRunId>, requestOptions?: ApiRequestOptions): ApiPromise<RetrieveRunResult<TRunId>>;
+type RunId<TRunId> = TRunId extends AnyRunHandle | AnyBatchedRunHandle ? TRunId : TRunId extends AnyTask ? string : TRunId extends string ? TRunId : never;
+declare function retrieveRun<TRunId extends AnyRunHandle | AnyBatchedRunHandle | AnyTask | string>(runId: RunId<TRunId>, requestOptions?: ApiRequestOptions): ApiPromise<RetrieveRunResult<TRunId>>;
 declare function replayRun(runId: string, requestOptions?: ApiRequestOptions): ApiPromise<ReplayRunResponse>;
 declare function cancelRun(runId: string, requestOptions?: ApiRequestOptions): ApiPromise<CanceledRunResponse>;
 declare function rescheduleRun(runId: string, body: RescheduleRunRequestBody, requestOptions?: ApiRequestOptions): ApiPromise<RetrieveRunResponse>;
@@ -26,27 +27,20 @@ export type PollOptions = {
 declare function poll<TRunId extends AnyRunHandle | AnyTask | string>(runId: RunId<TRunId>, options?: {
     pollIntervalMs?: number;
 }, requestOptions?: ApiRequestOptions): Promise<{
-    taskIdentifier: string;
-    status: "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "COMPLETED" | "CANCELED" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED" | "TIMED_OUT";
+    status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
     id: string;
-    idempotencyKey?: string | undefined;
-    createdAt: Date;
-    updatedAt: Date;
     startedAt?: Date | undefined;
-    expiredAt?: Date | undefined;
+    tags: string[];
     isTest: boolean;
+    createdAt: Date;
+    idempotencyKey?: string | undefined;
+    durationMs: number;
     costInCents: number;
     baseCostInCents: number;
-    ttl?: string | undefined;
-    metadata?: Record<string, any> | undefined;
-    error?: {
-        message: string;
-        name?: string | undefined;
-        stackTrace?: string | undefined;
-    } | undefined;
-    tags: string[];
-    durationMs: number;
     version?: string | undefined;
+    metadata?: Record<string, any> | undefined;
+    ttl?: string | undefined;
+    taskIdentifier: string;
     schedule?: {
         id: string;
         generator: {
@@ -57,124 +51,220 @@ declare function poll<TRunId extends AnyRunHandle | AnyTask | string>(runId: Run
         externalId?: string | undefined;
         deduplicationKey?: string | undefined;
     } | undefined;
+    batchId?: string | undefined;
+    error?: {
+        message: string;
+        name?: string | undefined;
+        stackTrace?: string | undefined;
+    } | undefined;
+    depth: number;
+    triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
+    isQueued: boolean;
+    isExecuting: boolean;
+    isCompleted: boolean;
+    isSuccess: boolean;
+    isFailed: boolean;
+    isCancelled: boolean;
+    updatedAt: Date;
+    finishedAt?: Date | undefined;
+    delayedUntil?: Date | undefined;
+    expiredAt?: Date | undefined;
     payloadPresignedUrl?: string | undefined;
     outputPresignedUrl?: string | undefined;
     relatedRuns: {
         root?: {
-            taskIdentifier: string;
-            status: "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "COMPLETED" | "CANCELED" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED" | "TIMED_OUT";
+            status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
             id: string;
-            createdAt: Date;
-            updatedAt: Date;
+            tags: string[];
             isTest: boolean;
+            createdAt: Date;
+            durationMs: number;
             costInCents: number;
             baseCostInCents: number;
-            tags: string[];
-            durationMs: number;
+            taskIdentifier: string;
             depth: number;
-            triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
+            triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
             isQueued: boolean;
             isExecuting: boolean;
             isCompleted: boolean;
             isSuccess: boolean;
             isFailed: boolean;
             isCancelled: boolean;
-            batchId?: string | undefined;
+            updatedAt: Date;
+            startedAt?: Date | undefined;
             idempotencyKey?: string | undefined;
             version?: string | undefined;
-            startedAt?: Date | undefined;
+            metadata?: Record<string, any> | undefined;
+            ttl?: string | undefined;
+            batchId?: string | undefined;
             finishedAt?: Date | undefined;
             delayedUntil?: Date | undefined;
-            ttl?: string | undefined;
             expiredAt?: Date | undefined;
-            metadata?: Record<string, any> | undefined;
         } | undefined;
         parent?: {
-            taskIdentifier: string;
-            status: "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "COMPLETED" | "CANCELED" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED" | "TIMED_OUT";
+            status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
             id: string;
-            createdAt: Date;
-            updatedAt: Date;
+            tags: string[];
             isTest: boolean;
+            createdAt: Date;
+            durationMs: number;
             costInCents: number;
             baseCostInCents: number;
-            tags: string[];
-            durationMs: number;
+            taskIdentifier: string;
             depth: number;
-            triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
+            triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
             isQueued: boolean;
             isExecuting: boolean;
             isCompleted: boolean;
             isSuccess: boolean;
             isFailed: boolean;
             isCancelled: boolean;
-            batchId?: string | undefined;
+            updatedAt: Date;
+            startedAt?: Date | undefined;
             idempotencyKey?: string | undefined;
             version?: string | undefined;
-            startedAt?: Date | undefined;
+            metadata?: Record<string, any> | undefined;
+            ttl?: string | undefined;
+            batchId?: string | undefined;
             finishedAt?: Date | undefined;
             delayedUntil?: Date | undefined;
-            ttl?: string | undefined;
             expiredAt?: Date | undefined;
-            metadata?: Record<string, any> | undefined;
         } | undefined;
         children?: {
-            taskIdentifier: string;
-            status: "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "COMPLETED" | "CANCELED" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED" | "TIMED_OUT";
+            status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
             id: string;
-            createdAt: Date;
-            updatedAt: Date;
+            tags: string[];
             isTest: boolean;
+            createdAt: Date;
+            durationMs: number;
             costInCents: number;
             baseCostInCents: number;
-            tags: string[];
-            durationMs: number;
+            taskIdentifier: string;
             depth: number;
-            triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
+            triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
             isQueued: boolean;
             isExecuting: boolean;
             isCompleted: boolean;
             isSuccess: boolean;
             isFailed: boolean;
             isCancelled: boolean;
-            batchId?: string | undefined;
+            updatedAt: Date;
+            startedAt?: Date | undefined;
             idempotencyKey?: string | undefined;
             version?: string | undefined;
-            startedAt?: Date | undefined;
+            metadata?: Record<string, any> | undefined;
+            ttl?: string | undefined;
+            batchId?: string | undefined;
             finishedAt?: Date | undefined;
             delayedUntil?: Date | undefined;
-            ttl?: string | undefined;
             expiredAt?: Date | undefined;
-            metadata?: Record<string, any> | undefined;
         }[] | undefined;
     };
-    depth: number;
-    triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
-    batchId?: string | undefined;
-    isQueued: boolean;
-    isExecuting: boolean;
-    isCompleted: boolean;
-    isSuccess: boolean;
-    isFailed: boolean;
-    isCancelled: boolean;
-    finishedAt?: Date | undefined;
-    delayedUntil?: Date | undefined;
     attempts: ({
-        status: "EXECUTING" | "COMPLETED" | "CANCELED" | "FAILED" | "PENDING" | "PAUSED";
+        status: "PENDING" | "CANCELED" | "COMPLETED" | "FAILED" | "EXECUTING" | "PAUSED";
         id: string;
         createdAt: Date;
         updatedAt: Date;
         startedAt?: Date | undefined;
-        completedAt?: Date | undefined;
         error?: {
             message: string;
             name?: string | undefined;
             stackTrace?: string | undefined;
         } | undefined;
+        completedAt?: Date | undefined;
     } | undefined)[];
     attemptCount: number;
     output?: InferRunTypes<TRunId>["output"] | undefined;
     payload?: InferRunTypes<TRunId>["payload"] | undefined;
 }>;
+/**
+ * Subscribes to real-time updates for a specific run.
+ *
+ * This function allows you to receive real-time updates whenever a run changes, including:
+ * - Status changes in the run lifecycle
+ * - Tag additions or removals
+ * - Metadata updates
+ *
+ * @template TRunId - The type parameter extending AnyRunHandle, AnyTask, or string
+ * @param {RunId<TRunId>} runId - The ID of the run to subscribe to. Can be a string ID, RunHandle, or Task
+ * @returns {RunSubscription<InferRunTypes<TRunId>>} An async iterator that yields updated run objects
+ *
+ * @example
+ * ```ts
+ * // Subscribe using a run handle
+ * const handle = await tasks.trigger("my-task", { some: "data" });
+ * for await (const run of runs.subscribeToRun(handle.id)) {
+ *   console.log("Run updated:", run);
+ * }
+ *
+ * // Subscribe with type safety
+ * for await (const run of runs.subscribeToRun<typeof myTask>(runId)) {
+ *   console.log("Payload:", run.payload.some);
+ *   if (run.output) {
+ *     console.log("Output:", run.output);
+ *   }
+ * }
+ * ```
+ */
 declare function subscribeToRun<TRunId extends AnyRunHandle | AnyTask | string>(runId: RunId<TRunId>): RunSubscription<InferRunTypes<TRunId>>;
+/**
+ * Subscribes to real-time updates for all runs that have specific tags.
+ *
+ * This function allows you to monitor multiple runs simultaneously by filtering on tags.
+ * You'll receive updates whenever any run with the specified tag(s) changes.
+ *
+ * @template TTasks - The type parameter extending AnyTask for type-safe payload and output
+ * @param {string | string[]} tag - A single tag or array of tags to filter runs
+ * @returns {RunSubscription<InferRunTypes<TTasks>>} An async iterator that yields updated run objects
+ *
+ * @example
+ * ```ts
+ * // Subscribe to runs with a single tag
+ * for await (const run of runs.subscribeToRunsWithTag("user:1234")) {
+ *   console.log("Run updated:", run);
+ * }
+ *
+ * // Subscribe with multiple tags and type safety
+ * for await (const run of runs.subscribeToRunsWithTag<typeof myTask | typeof otherTask>(["tag1", "tag2"])) {
+ *   switch (run.taskIdentifier) {
+ *     case "my-task":
+ *       console.log("MyTask output:", run.output.foo);
+ *       break;
+ *     case "other-task":
+ *       console.log("OtherTask output:", run.output.bar);
+ *       break;
+ *   }
+ * }
+ * ```
+ */
 declare function subscribeToRunsWithTag<TTasks extends AnyTask>(tag: string | string[]): RunSubscription<InferRunTypes<TTasks>>;
+/**
+ * Subscribes to real-time updates for all runs within a specific batch.
+ *
+ * Use this function when you've triggered multiple runs using `batchTrigger` and want
+ * to monitor all runs in that batch. You'll receive updates whenever any run in the batch changes.
+ *
+ * @template TTasks - The type parameter extending AnyTask for type-safe payload and output
+ * @param {string} batchId - The ID of the batch to subscribe to
+ * @returns {RunSubscription<InferRunTypes<TTasks>>} An async iterator that yields updated run objects
+ *
+ * @example
+ * ```ts
+ * // Subscribe to all runs in a batch
+ * for await (const run of runs.subscribeToRunsInBatch("batch-123")) {
+ *   console.log("Batch run updated:", run);
+ * }
+ *
+ * // Subscribe with type safety
+ * for await (const run of runs.subscribeToRunsInBatch<typeof myTask>("batch-123")) {
+ *   console.log("Run payload:", run.payload);
+ *   if (run.output) {
+ *     console.log("Run output:", run.output);
+ *   }
+ * }
+ * ```
+ *
+ * @note The run objects received will include standard fields like id, status, payload, output,
+ * createdAt, updatedAt, tags, and more. See the Run object documentation for full details.
+ */
+declare function subscribeToRunsInBatch<TTasks extends AnyTask>(batchId: string): RunSubscription<InferRunTypes<TTasks>>;