@trigger.dev/core 3.2.2 → 3.3.0

package/dist/esm/v3/types/tasks.d.ts

@@ -22,10 +22,10 @@ export declare class SubtaskUnwrapError extends Error {
     readonly cause?: unknown;
     constructor(taskId: string, runId: string, subtaskError: unknown);
 }
-export declare class TaskRunPromise<T> extends Promise<TaskRunResult<T>> {
+export declare class TaskRunPromise<TIdentifier extends string, TOutput> extends Promise<TaskRunResult<TIdentifier, TOutput>> {
     private readonly taskId;
-    constructor(executor: (resolve: (value: TaskRunResult<T> | PromiseLike<TaskRunResult<T>>) => void, reject: (reason?: any) => void) => void, taskId: string);
-    unwrap(): Promise<T>;
+    constructor(executor: (resolve: (value: TaskRunResult<TIdentifier, TOutput> | PromiseLike<TaskRunResult<TIdentifier, TOutput>>) => void, reject: (reason?: any) => void) => void, taskId: TIdentifier);
+    unwrap(): Promise<TOutput>;
 }
 export type InitOutput = Record<string, any> | void | undefined;
 export type RunFnParams<TInitOutput extends InitOutput> = Prettify<{
@@ -245,34 +245,84 @@ export type RunHandle<TTaskIdentifier extends string, TPayload, TOutput> = Brand
     taskIdentifier: TTaskIdentifier;
 }, TPayload, TOutput>;
 export type AnyRunHandle = RunHandle<string, any, any>;
+export type BatchedRunHandle<TTaskIdentifier extends string, TPayload, TOutput> = BrandedRun<{
+    id: string;
+    taskIdentifier: TTaskIdentifier;
+    isCached: boolean;
+    idempotencyKey?: string;
+}, TPayload, TOutput>;
+export type AnyBatchedRunHandle = BatchedRunHandle<string, any, any>;
 /**
  * A BatchRunHandle can be used to retrieve the runs of a batch trigger in a typesafe manner.
  */
 export type BatchRunHandle<TTaskIdentifier extends string, TPayload, TOutput> = BrandedRun<{
     batchId: string;
-    runs: Array<RunHandle<TTaskIdentifier, TPayload, TOutput>>;
+    isCached: boolean;
+    idempotencyKey?: string;
+    runs: Array<BatchedRunHandle<TTaskIdentifier, TPayload, TOutput>>;
     publicAccessToken: string;
-    taskIdentifier: TTaskIdentifier;
 }, TOutput, TPayload>;
 export type RunHandleOutput<TRunHandle> = TRunHandle extends RunHandle<string, any, infer TOutput> ? TOutput : never;
 export type RunHandlePayload<TRunHandle> = TRunHandle extends RunHandle<string, infer TPayload, any> ? TPayload : never;
 export type RunHandleTaskIdentifier<TRunHandle> = TRunHandle extends RunHandle<infer TTaskIdentifier, any, any> ? TTaskIdentifier : never;
-export type TaskRunResult<TOutput = any> = {
+export type TaskRunResult<TIdentifier extends string, TOutput = any> = {
     ok: true;
     id: string;
+    taskIdentifier: TIdentifier;
     output: TOutput;
 } | {
     ok: false;
     id: string;
+    taskIdentifier: TIdentifier;
     error: unknown;
 };
-export type BatchResult<TOutput = any> = {
+export type AnyTaskRunResult = TaskRunResult<string, any>;
+export type TaskRunResultFromTask<TTask extends AnyTask> = TTask extends Task<infer TIdentifier, any, infer TOutput> ? TaskRunResult<TIdentifier, TOutput> : never;
+export type BatchResult<TIdentifier extends string, TOutput = any> = {
     id: string;
-    runs: TaskRunResult<TOutput>[];
+    runs: TaskRunResult<TIdentifier, TOutput>[];
 };
+export type BatchByIdResult<TTask extends AnyTask> = {
+    id: string;
+    runs: Array<TaskRunResultFromTask<TTask>>;
+};
+export type BatchByTaskResult<TTasks extends readonly AnyTask[]> = {
+    id: string;
+    runs: {
+        [K in keyof TTasks]: TaskRunResultFromTask<TTasks[K]>;
+    };
+};
+/**
+ * A BatchRunHandle can be used to retrieve the runs of a batch trigger in a typesafe manner.
+ */
+export type BatchTasksResult<TTasks extends readonly AnyTask[]> = BatchTasksRunHandle<TTasks>;
 export type BatchItem<TInput> = {
     payload: TInput;
-    options?: TaskRunOptions;
+    options?: TriggerOptions;
+};
+export type BatchTriggerAndWaitItem<TInput> = {
+    payload: TInput;
+    options?: TriggerAndWaitOptions;
+};
+export type BatchByIdItem<TRunTypes extends AnyRunTypes> = {
+    id: TRunTypes["taskIdentifier"];
+    payload: TRunTypes["payload"];
+    options?: TriggerOptions;
+};
+export type BatchByIdAndWaitItem<TRunTypes extends AnyRunTypes> = {
+    id: TRunTypes["taskIdentifier"];
+    payload: TRunTypes["payload"];
+    options?: TriggerAndWaitOptions;
+};
+export type BatchByTaskItem<TTask extends AnyTask> = {
+    task: TTask;
+    payload: TaskPayload<TTask>;
+    options?: TriggerOptions;
+};
+export type BatchByTaskAndWaitItem<TTask extends AnyTask> = {
+    task: TTask;
+    payload: TaskPayload<TTask>;
+    options?: TriggerAndWaitOptions;
 };
 export interface Task<TIdentifier extends string, TInput = void, TOutput = any> {
     /**
@@ -287,7 +337,7 @@ export interface Task<TIdentifier extends string, TInput = void, TOutput = any>
      * @returns RunHandle
      * - `id` - The id of the triggered task run.
      */
-    trigger: (payload: TInput, options?: TaskRunOptions, requestOptions?: TriggerApiRequestOptions) => Promise<RunHandle<TIdentifier, TInput, TOutput>>;
+    trigger: (payload: TInput, options?: TriggerOptions, requestOptions?: TriggerApiRequestOptions) => Promise<RunHandle<TIdentifier, TInput, TOutput>>;
     /**
      * Batch trigger multiple task runs with the given payloads, and continue without waiting for the results. If you want to wait for the results, use `batchTriggerAndWait`. Returns the id of the triggered batch.
      * @param items
@@ -295,7 +345,7 @@ export interface Task<TIdentifier extends string, TInput = void, TOutput = any>
      * - `batchId` - The id of the triggered batch.
      * - `runs` - The ids of the triggered task runs.
      */
-    batchTrigger: (items: Array<BatchItem<TInput>>, requestOptions?: TriggerApiRequestOptions) => Promise<BatchRunHandle<TIdentifier, TInput, TOutput>>;
+    batchTrigger: (items: Array<BatchItem<TInput>>, options?: BatchTriggerOptions, requestOptions?: TriggerApiRequestOptions) => Promise<BatchRunHandle<TIdentifier, TInput, TOutput>>;
     /**
      * Trigger a task with the given payload, and wait for the result. Returns the result of the task run
      * @param payload
@@ -312,7 +362,7 @@ export interface Task<TIdentifier extends string, TInput = void, TOutput = any>
      * }
      * ```
      */
-    triggerAndWait: (payload: TInput, options?: TaskRunOptions) => TaskRunPromise<TOutput>;
+    triggerAndWait: (payload: TInput, options?: TriggerAndWaitOptions) => TaskRunPromise<TIdentifier, TOutput>;
     /**
      * Batch trigger multiple task runs with the given payloads, and wait for the results. Returns the results of the task runs.
      * @param items
@@ -333,7 +383,7 @@ export interface Task<TIdentifier extends string, TInput = void, TOutput = any>
      * }
      * ```
      */
-    batchTriggerAndWait: (items: Array<BatchItem<TInput>>) => Promise<BatchResult<TOutput>>;
+    batchTriggerAndWait: (items: Array<BatchTriggerAndWaitItem<TInput>>) => Promise<BatchResult<TIdentifier, TOutput>>;
 }
 export interface TaskWithSchema<TIdentifier extends string, TSchema extends TaskSchema | undefined = undefined, TOutput = any> extends Task<TIdentifier, inferSchemaIn<TSchema>, TOutput> {
     schema?: TSchema;
@@ -351,6 +401,9 @@ export type TaskOutput<TTask extends AnyTask> = TTask extends Task<string, any,
 export type TaskOutputHandle<TTask extends AnyTask> = TTask extends Task<infer TIdentifier, infer TInput, infer TOutput> ? RunHandle<TIdentifier, TOutput, TInput> : never;
 export type TaskBatchOutputHandle<TTask extends AnyTask> = TTask extends Task<infer TIdentifier, infer TInput, infer TOutput> ? BatchRunHandle<TIdentifier, TOutput, TInput> : never;
 export type TaskIdentifier<TTask extends AnyTask> = TTask extends Task<infer TIdentifier, any, any> ? TIdentifier : never;
+export type TaskFromIdentifier<TTask extends AnyTask, TIdentifier extends TTask["id"]> = TTask extends {
+    id: TIdentifier;
+} ? TTask : never;
 export type TriggerJwtOptions = {
     /**
      * The expiration time of the JWT. This can be a string like "1h" or a Date object.
@@ -359,7 +412,7 @@ export type TriggerJwtOptions = {
      */
     expirationTime?: number | Date | string;
 };
-export type TaskRunOptions = {
+export type TriggerOptions = {
     /**
      * A unique key that can be used to ensure that a task is only triggered once per key.
      *
@@ -406,6 +459,12 @@ export type TaskRunOptions = {
      *
      */
     idempotencyKey?: IdempotencyKey | string | string[];
+    /**
+     * The time-to-live for the idempotency key. Once the TTL has passed, the key can be used again.
+     *
+     * Specify a duration string like "1h", "10s", "30m", etc.
+     */
+    idempotencyKeyTTL?: string;
     maxAttempts?: number;
     queue?: TaskRunConcurrencyOptions;
     concurrencyKey?: string;
@@ -463,6 +522,11 @@ export type TaskRunOptions = {
      */
     maxDuration?: number;
 };
+export type TriggerAndWaitOptions = Omit<TriggerOptions, "idempotencyKey" | "idempotencyKeyTTL">;
+export type BatchTriggerOptions = {
+    idempotencyKey?: IdempotencyKey | string | string[];
+    idempotencyKeyTTL?: string;
+};
 export type TaskMetadataWithFunctions = TaskMetadata & {
     fns: {
         run: (payload: any, params: RunFnParams<any>) => Promise<any>;
@@ -482,6 +546,19 @@ export type RunTypes<TTaskIdentifier extends string, TPayload, TOutput> = {
     taskIdentifier: TTaskIdentifier;
 };
 export type AnyRunTypes = RunTypes<string, any, any>;
-export type InferRunTypes<T> = T extends RunHandle<infer TTaskIdentifier, infer TPayload, infer TOutput> ? RunTypes<TTaskIdentifier, TPayload, TOutput> : T extends Task<infer TTaskIdentifier, infer TPayload, infer TOutput> ? RunTypes<TTaskIdentifier, TPayload, TOutput> : AnyRunTypes;
+export type InferRunTypes<T> = T extends RunHandle<infer TTaskIdentifier, infer TPayload, infer TOutput> ? RunTypes<TTaskIdentifier, TPayload, TOutput> : T extends BatchedRunHandle<infer TTaskIdentifier, infer TPayload, infer TOutput> ? RunTypes<TTaskIdentifier, TPayload, TOutput> : T extends Task<infer TTaskIdentifier, infer TPayload, infer TOutput> ? RunTypes<TTaskIdentifier, TPayload, TOutput> : AnyRunTypes;
 export type RunHandleFromTypes<TRunTypes extends AnyRunTypes> = RunHandle<TRunTypes["taskIdentifier"], TRunTypes["payload"], TRunTypes["output"]>;
-export type BatchRunHandleFromTypes<TRunTypes extends AnyRunTypes> = BatchRunHandle<TRunTypes["taskIdentifier"], TRunTypes["payload"], TRunTypes["output"]>;
+export type BatchRunHandleFromTypes<TRunTypes extends AnyRunTypes> = TRunTypes extends AnyRunTypes ? BatchRunHandle<TRunTypes["taskIdentifier"], TRunTypes["payload"], TRunTypes["output"]> : never;
+/**
+ * A BatchRunHandle can be used to retrieve the runs of a batch trigger in a typesafe manner.
+ */
+export type BatchTasksRunHandle<TTasks extends readonly AnyTask[]> = BrandedRun<{
+    batchId: string;
+    isCached: boolean;
+    idempotencyKey?: string;
+    runs: {
+        [K in keyof TTasks]: BatchedRunHandle<TaskIdentifier<TTasks[K]>, TaskPayload<TTasks[K]>, TaskOutput<TTasks[K]>>;
+    };
+    publicAccessToken: string;
+}, any, any>;
+export type BatchTasksRunHandleFromTypes<TTasks extends readonly AnyTask[]> = BatchTasksRunHandle<TTasks>;

package/dist/esm/v3/types/tasks.js.map

@@ -1 +1 @@
-{"version":3,"file":"tasks.js","sourceRoot":"","sources":["../../../../src/v3/types/tasks.ts"],"names":[],"mappings":"AA8BA,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3B,MAAM,CAAS;IACf,KAAK,CAAS;IACd,KAAK,CAAW;IAEhC,YAAY,MAAc,EAAE,KAAa,EAAE,YAAqB;QAC9D,IAAI,YAAY,YAAY,KAAK,EAAE,CAAC;YAClC,KAAK,CAAC,YAAY,MAAM,KAAK,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;YACrD,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC;YAC1B,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,YAAY,MAAM,EAAE,CAAC,CAAC;YAC5B,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;YACjC,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC;QAC5B,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED,MAAM,OAAO,cAAkB,SAAQ,OAAyB;IAM3C;IALnB,YACE,QAGS,EACQ,MAAc;QAE/B,KAAK,CAAC,QAAQ,CAAC,CAAC;QAFC,WAAM,GAAN,MAAM,CAAQ;IAGjC,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1B,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,OAAO,MAAM,CAAC,MAAM,CAAC;YACvB,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YACrE,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"tasks.js","sourceRoot":"","sources":["../../../../src/v3/types/tasks.ts"],"names":[],"mappings":"AA8BA,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3B,MAAM,CAAS;IACf,KAAK,CAAS;IACd,KAAK,CAAW;IAEhC,YAAY,MAAc,EAAE,KAAa,EAAE,YAAqB;QAC9D,IAAI,YAAY,YAAY,KAAK,EAAE,CAAC;YAClC,KAAK,CAAC,YAAY,MAAM,KAAK,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;YACrD,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC;YAC1B,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,YAAY,MAAM,EAAE,CAAC,CAAC;YAC5B,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;YACjC,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC;QAC5B,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED,MAAM,OAAO,cAAoD,SAAQ,OAExE;IAUoB;IATnB,YACE,QAOS,EACQ,MAAmB;QAEpC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAFC,WAAM,GAAN,MAAM,CAAa;IAGtC,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1B,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,OAAO,MAAM,CAAC,MAAM,CAAC;YACvB,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YACrE,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/version.js

@@ -1,2 +1,2 @@
-export const VERSION = "3.2.2";
+export const VERSION = "3.3.0";
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trigger.dev/core",
-  "version": "3.2.2",
+  "version": "3.3.0",
   "description": "Core code used across the Trigger.dev SDK and platform",
   "license": "MIT",
   "publishConfig": {