@trigger.dev/sdk 3.0.0-beta.13 → 3.0.0-beta.15

package/dist/v3/index.d.mts

@@ -12,7 +12,7 @@ type Queue = RequireOne<QueueOptions, "name">;
 declare function queue(options: {
     name: string;
 } & QueueOptions): Queue;
-type TaskOptions<TPayload, TOutput = any, TInitOutput extends InitOutput = any> = {
+type TaskOptions<TPayload = void, TOutput = unknown, TInitOutput extends InitOutput = any> = {
     /** An id for your task. This must be unique inside your project and not change between versions.  */
     id: string;
     /** The retry settings when an uncaught error is thrown.
@@ -122,36 +122,78 @@ type TaskRunResult<TOutput = any> = {
 } | {
     ok: false;
     id: string;
-    error: any;
+    error: unknown;
 };
 type BatchResult<TOutput = any> = {
     id: string;
     runs: TaskRunResult<TOutput>[];
 };
-interface Task<TInput, TOutput = any> {
+type BatchItem<TInput> = TInput extends void ? {
+    payload?: TInput;
+    options?: TaskRunOptions;
+} : {
+    payload: TInput;
+    options?: TaskRunOptions;
+};
+interface Task<TInput = void, TOutput = any> {
+    /**
+     * The id of the task.
+     */
     id: string;
-    trigger: (params: {
-        payload: TInput;
-        options?: TaskRunOptions;
-    }) => Promise<InvokeHandle>;
-    batchTrigger: (params: {
-        items: {
-            payload: TInput;
-            options?: TaskRunOptions;
-        }[];
-        batchOptions?: BatchRunOptions;
-    }) => Promise<InvokeBatchHandle>;
-    triggerAndWait: (params: {
-        payload: TInput;
-        options?: TaskRunOptions;
-    }) => Promise<TOutput>;
-    batchTriggerAndWait: (params: {
-        items: {
-            payload: TInput;
-            options?: TaskRunOptions;
-        }[];
-        batchOptions?: BatchRunOptions;
-    }) => Promise<BatchResult<TOutput>>;
+    /**
+     * Trigger a task with the given payload, and continue without waiting for the result. If you want to wait for the result, use `triggerAndWait`. Returns the id of the triggered task run.
+     * @param payload
+     * @param options
+     * @returns InvokeHandle
+     * - `id` - The id of the triggered task run.
+     */
+    trigger: (payload: TInput, options?: TaskRunOptions) => Promise<InvokeHandle>;
+    /**
+     * 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
+     * @returns InvokeBatchHandle
+     * - `batchId` - The id of the triggered batch.
+     * - `runs` - The ids of the triggered task runs.
+     */
+    batchTrigger: (items: Array<BatchItem<TInput>>) => Promise<InvokeBatchHandle>;
+    /**
+     * Trigger a task with the given payload, and wait for the result. Returns the result of the task run
+     * @param payload
+     * @param options - Options for the task run
+     * @returns TaskRunResult
+     * @example
+     * ```
+     * const result = await task.triggerAndWait({ foo: "bar" });
+     *
+     * if (result.ok) {
+     *  console.log(result.output);
+     * } else {
+     *  console.error(result.error);
+     * }
+     * ```
+     */
+    triggerAndWait: (payload: TInput, options?: TaskRunOptions) => Promise<TaskRunResult<TOutput>>;
+    /**
+     * Batch trigger multiple task runs with the given payloads, and wait for the results. Returns the results of the task runs.
+     * @param items
+     * @returns BatchResult
+     * @example
+     * ```
+     * const result = await task.batchTriggerAndWait([
+     *  { payload: { foo: "bar" } },
+     *  { payload: { foo: "baz" } },
+     * ]);
+     *
+     * for (const run of result.runs) {
+     *  if (run.ok) {
+     *    console.log(run.output);
+     *  } else {
+     *    console.error(run.error);
+     *  }
+     * }
+     * ```
+     */
+    batchTriggerAndWait: (items: Array<BatchItem<TInput>>) => Promise<BatchResult<TOutput>>;
 }
 type TaskRunOptions = {
     idempotencyKey?: string;
@@ -162,9 +204,6 @@ type TaskRunOptions = {
     concurrencyKey?: string;
 };
 type TaskRunConcurrencyOptions = Queue;
-type BatchRunOptions = TaskRunOptions & {
-    maxConcurrency?: number;
-};
 
 /** Creates a task that can be triggered
  * @param options - Task options
@@ -184,7 +223,7 @@ type BatchRunOptions = TaskRunOptions & {
  *
  * @returns A task that can be triggered
  */
-declare function task$1<TInput, TOutput = any, TInitOutput extends InitOutput = any>(options: TaskOptions<TInput, TOutput, TInitOutput>): Task<TInput, TOutput>;
+declare function task$1<TInput = void, TOutput = unknown, TInitOutput extends InitOutput = any>(options: TaskOptions<TInput, TOutput, TInitOutput>): Task<TInput, TOutput>;
 
 type WaitOptions = {
     seconds: number;

package/dist/v3/index.d.ts

@@ -12,7 +12,7 @@ type Queue = RequireOne<QueueOptions, "name">;
 declare function queue(options: {
     name: string;
 } & QueueOptions): Queue;
-type TaskOptions<TPayload, TOutput = any, TInitOutput extends InitOutput = any> = {
+type TaskOptions<TPayload = void, TOutput = unknown, TInitOutput extends InitOutput = any> = {
     /** An id for your task. This must be unique inside your project and not change between versions.  */
     id: string;
     /** The retry settings when an uncaught error is thrown.
@@ -122,36 +122,78 @@ type TaskRunResult<TOutput = any> = {
 } | {
     ok: false;
     id: string;
-    error: any;
+    error: unknown;
 };
 type BatchResult<TOutput = any> = {
     id: string;
     runs: TaskRunResult<TOutput>[];
 };
-interface Task<TInput, TOutput = any> {
+type BatchItem<TInput> = TInput extends void ? {
+    payload?: TInput;
+    options?: TaskRunOptions;
+} : {
+    payload: TInput;
+    options?: TaskRunOptions;
+};
+interface Task<TInput = void, TOutput = any> {
+    /**
+     * The id of the task.
+     */
     id: string;
-    trigger: (params: {
-        payload: TInput;
-        options?: TaskRunOptions;
-    }) => Promise<InvokeHandle>;
-    batchTrigger: (params: {
-        items: {
-            payload: TInput;
-            options?: TaskRunOptions;
-        }[];
-        batchOptions?: BatchRunOptions;
-    }) => Promise<InvokeBatchHandle>;
-    triggerAndWait: (params: {
-        payload: TInput;
-        options?: TaskRunOptions;
-    }) => Promise<TOutput>;
-    batchTriggerAndWait: (params: {
-        items: {
-            payload: TInput;
-            options?: TaskRunOptions;
-        }[];
-        batchOptions?: BatchRunOptions;
-    }) => Promise<BatchResult<TOutput>>;
+    /**
+     * Trigger a task with the given payload, and continue without waiting for the result. If you want to wait for the result, use `triggerAndWait`. Returns the id of the triggered task run.
+     * @param payload
+     * @param options
+     * @returns InvokeHandle
+     * - `id` - The id of the triggered task run.
+     */
+    trigger: (payload: TInput, options?: TaskRunOptions) => Promise<InvokeHandle>;
+    /**
+     * 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
+     * @returns InvokeBatchHandle
+     * - `batchId` - The id of the triggered batch.
+     * - `runs` - The ids of the triggered task runs.
+     */
+    batchTrigger: (items: Array<BatchItem<TInput>>) => Promise<InvokeBatchHandle>;
+    /**
+     * Trigger a task with the given payload, and wait for the result. Returns the result of the task run
+     * @param payload
+     * @param options - Options for the task run
+     * @returns TaskRunResult
+     * @example
+     * ```
+     * const result = await task.triggerAndWait({ foo: "bar" });
+     *
+     * if (result.ok) {
+     *  console.log(result.output);
+     * } else {
+     *  console.error(result.error);
+     * }
+     * ```
+     */
+    triggerAndWait: (payload: TInput, options?: TaskRunOptions) => Promise<TaskRunResult<TOutput>>;
+    /**
+     * Batch trigger multiple task runs with the given payloads, and wait for the results. Returns the results of the task runs.
+     * @param items
+     * @returns BatchResult
+     * @example
+     * ```
+     * const result = await task.batchTriggerAndWait([
+     *  { payload: { foo: "bar" } },
+     *  { payload: { foo: "baz" } },
+     * ]);
+     *
+     * for (const run of result.runs) {
+     *  if (run.ok) {
+     *    console.log(run.output);
+     *  } else {
+     *    console.error(run.error);
+     *  }
+     * }
+     * ```
+     */
+    batchTriggerAndWait: (items: Array<BatchItem<TInput>>) => Promise<BatchResult<TOutput>>;
 }
 type TaskRunOptions = {
     idempotencyKey?: string;
@@ -162,9 +204,6 @@ type TaskRunOptions = {
     concurrencyKey?: string;
 };
 type TaskRunConcurrencyOptions = Queue;
-type BatchRunOptions = TaskRunOptions & {
-    maxConcurrency?: number;
-};
 
 /** Creates a task that can be triggered
  * @param options - Task options
@@ -184,7 +223,7 @@ type BatchRunOptions = TaskRunOptions & {
  *
  * @returns A task that can be triggered
  */
-declare function task$1<TInput, TOutput = any, TInitOutput extends InitOutput = any>(options: TaskOptions<TInput, TOutput, TInitOutput>): Task<TInput, TOutput>;
+declare function task$1<TInput = void, TOutput = unknown, TInitOutput extends InitOutput = any>(options: TaskOptions<TInput, TOutput, TInitOutput>): Task<TInput, TOutput>;
 
 type WaitOptions = {
     seconds: number;

package/dist/v3/index.js

@@ -18,7 +18,7 @@ var __publicField = (obj, key, value) => {
 };
 
 // package.json
-var version = "3.0.0-beta.13";
+var version = "3.0.0-beta.15";
 var tracer = new v3.TriggerTracer({
   name: "@trigger.dev/sdk",
   version
@@ -32,7 +32,7 @@ __name(queue, "queue");
 function createTask(params) {
   const task3 = {
     id: params.id,
-    trigger: async ({ payload, options }) => {
+    trigger: async (payload, options) => {
       const apiClient = v3.apiClientManager.client;
       if (!apiClient) {
         throw apiClientMissingError();
@@ -61,7 +61,6 @@ function createTask(params) {
           [v3.SemanticInternalAttributes.STYLE_ICON]: "trigger",
           ["messaging.client_id"]: v3.taskContextManager.worker?.id,
           [semanticConventions.SEMATTRS_MESSAGING_DESTINATION]: params.queue?.name ?? params.id,
-          ["messaging.message.body.size"]: JSON.stringify(payload).length,
           [semanticConventions.SEMATTRS_MESSAGING_SYSTEM]: "trigger.dev",
           ...taskMetadata ? v3.accessoryAttributes({
             items: [
@@ -76,7 +75,7 @@ function createTask(params) {
       });
       return handle;
     },
-    batchTrigger: async ({ items }) => {
+    batchTrigger: async (items) => {
       const apiClient = v3.apiClientManager.client;
       if (!apiClient) {
         throw apiClientMissingError();
@@ -109,7 +108,6 @@ function createTask(params) {
           ["messaging.batch.message_count"]: items.length,
           ["messaging.client_id"]: v3.taskContextManager.worker?.id,
           [semanticConventions.SEMATTRS_MESSAGING_DESTINATION]: params.queue?.name ?? params.id,
-          ["messaging.message.body.size"]: items.map((item) => JSON.stringify(item.payload)).join("").length,
           [semanticConventions.SEMATTRS_MESSAGING_SYSTEM]: "trigger.dev",
           [v3.SemanticInternalAttributes.STYLE_ICON]: "trigger",
           ...taskMetadata ? v3.accessoryAttributes({
@@ -125,7 +123,7 @@ function createTask(params) {
       });
       return response;
     },
-    triggerAndWait: async ({ payload, options }) => {
+    triggerAndWait: async (payload, options) => {
       const ctx = v3.taskContextManager.ctx;
       if (!ctx) {
         throw new Error("triggerAndWait can only be used from inside a task.run()");
@@ -150,15 +148,21 @@ function createTask(params) {
           }
         });
         span.setAttribute("messaging.message.id", response.id);
+        if (options?.idempotencyKey) {
+          const result2 = await apiClient.getRunResult(response.id);
+          if (result2) {
+            v3.logger.log(`Result reused from previous task run with idempotency key '${options.idempotencyKey}'.`, {
+              runId: response.id,
+              idempotencyKey: options.idempotencyKey
+            });
+            return await handleTaskRunExecutionResult(result2);
+          }
+        }
         const result = await v3.runtime.waitForTask({
           id: response.id,
           ctx
         });
-        const runResult = await handleTaskRunExecutionResult(result);
-        if (!runResult.ok) {
-          throw runResult.error;
-        }
-        return runResult.output;
+        return await handleTaskRunExecutionResult(result);
       }, {
         kind: api.SpanKind.PRODUCER,
         attributes: {
@@ -179,7 +183,7 @@ function createTask(params) {
         }
       });
     },
-    batchTriggerAndWait: async ({ items }) => {
+    batchTriggerAndWait: async (items) => {
       const ctx = v3.taskContextManager.ctx;
       if (!ctx) {
         throw new Error("batchTriggerAndWait can only be used from inside a task.run()");
@@ -208,12 +212,47 @@ function createTask(params) {
           dependentAttempt: ctx.attempt.id
         });
         span.setAttribute("messaging.message.id", response.batchId);
+        const getBatchResults = /* @__PURE__ */ __name(async () => {
+          const hasIdempotencyKey = items.some((item) => item.options?.idempotencyKey);
+          if (hasIdempotencyKey) {
+            const results = await apiClient.getBatchResults(response.batchId);
+            if (results) {
+              return results;
+            }
+          }
+          return {
+            id: response.batchId,
+            items: []
+          };
+        }, "getBatchResults");
+        const existingResults = await getBatchResults();
+        const incompleteRuns = response.runs.filter((runId) => !existingResults.items.some((item) => item.id === runId));
+        if (incompleteRuns.length === 0) {
+          v3.logger.log(`Results reused from previous task runs because of the provided idempotency keys.`);
+          const runs3 = await handleBatchTaskRunExecutionResult(existingResults.items);
+          return {
+            id: existingResults.id,
+            runs: runs3
+          };
+        }
         const result = await v3.runtime.waitForBatch({
           id: response.batchId,
-          runs: response.runs,
+          runs: incompleteRuns,
           ctx
         });
-        const runs2 = await handleBatchTaskRunExecutionResult(result.items);
+        const combinedItems = [];
+        for (const runId of response.runs) {
+          const existingItem = existingResults.items.find((item) => item.id === runId);
+          if (existingItem) {
+            combinedItems.push(existingItem);
+          } else {
+            const newItem = result.items.find((item) => item.id === runId);
+            if (newItem) {
+              combinedItems.push(newItem);
+            }
+          }
+        }
+        const runs2 = await handleBatchTaskRunExecutionResult(combinedItems);
         return {
           id: result.id,
           runs: runs2
@@ -225,7 +264,6 @@ function createTask(params) {
           ["messaging.batch.message_count"]: items.length,
           ["messaging.client_id"]: v3.taskContextManager.worker?.id,
           [semanticConventions.SEMATTRS_MESSAGING_DESTINATION]: params.queue?.name ?? params.id,
-          ["messaging.message.body.size"]: items.map((item) => JSON.stringify(item.payload)).join("").length,
           [semanticConventions.SEMATTRS_MESSAGING_SYSTEM]: "trigger.dev",
           [v3.SemanticInternalAttributes.STYLE_ICON]: "trigger",
           ...taskMetadata ? v3.accessoryAttributes({