@trigger.dev/sdk 3.0.0-beta.37 → 3.0.0-beta.39

package/dist/v3/index.d.mts

@@ -1,7 +1,6 @@
-import { RetryOptions, FetchRetryOptions, TaskRunContext, QueueOptions, InitOutput, MachineCpu, MachineMemory, RunFnParams, InitFnParams, HandleErrorFnParams, HandleErrorResult, MiddlewareFnParams, StartFnParams, SuccessFnParams, FailureFnParams, ListProjectRunsQueryParams, ListRunResponseItem, ListRunsQueryParams, ApiPromise, ReplayRunResponse, CanceledRunResponse, RetrieveRunResponse, ScheduledTaskPayload, CreateScheduleOptions, ScheduleObject, UpdateScheduleOptions, DeletedScheduleObject, ListScheduleOptions, ImportEnvironmentVariablesParams, EnvironmentVariableResponseBody, EnvironmentVariables, CreateEnvironmentVariableParams, EnvironmentVariableValue, UpdateEnvironmentVariableParams, ApiClientConfiguration } from '@trigger.dev/core/v3';
+import { RetryOptions, FetchRetryOptions, TaskRunContext, QueueOptions, InitOutput, MachineCpu, MachineMemory, RunFnParams, InitFnParams, HandleErrorFnParams, HandleErrorResult, MiddlewareFnParams, StartFnParams, SuccessFnParams, FailureFnParams, ListProjectRunsQueryParams, CursorPagePromise, ListRunResponseItem, ListRunsQueryParams, ApiPromise, ReplayRunResponse, CanceledRunResponse, RetrieveRunResponse, ScheduledTaskPayload, CreateScheduleOptions, ScheduleObject, UpdateScheduleOptions, DeletedScheduleObject, ListScheduleOptions, OffsetLimitPagePromise, ImportEnvironmentVariablesParams, EnvironmentVariableResponseBody, EnvironmentVariables, CreateEnvironmentVariableParams, EnvironmentVariableValue, UpdateEnvironmentVariableParams, ApiClientConfiguration } from '@trigger.dev/core/v3';
 export { ApiClientConfiguration, ApiError, AuthenticationError, BadRequestError, ConflictError, HandleErrorArgs, HandleErrorFunction, ImportEnvironmentVariablesParams, InternalServerError, LogLevel, NotFoundError, PermissionDeniedError, RateLimitError, ResolveEnvironmentVariablesFunction, ResolveEnvironmentVariablesParams, ResolveEnvironmentVariablesResult, RetryOptions, ProjectConfig as TriggerConfig, UnprocessableEntityError, logger } from '@trigger.dev/core/v3';
 import { HttpHandler } from 'msw';
-import { CursorPagePromise, OffsetLimitPagePromise } from '@trigger.dev/core/v3/apiClient/core';
 
 type CacheMetadata = {
     createdTime: number;
@@ -129,6 +128,7 @@ type TaskOptions<TPayload = void, TOutput = unknown, TInitOutput extends InitOut
          * - 1
          * - 2
          * - 4
+         * @deprecated use preset instead
          */
         cpu?: MachineCpu;
         /** In GBs of RAM. The default is 1.
@@ -140,8 +140,11 @@ type TaskOptions<TPayload = void, TOutput = unknown, TInitOutput extends InitOut
          * - 2
          * - 4
          * - 8
+         * * @deprecated use preset instead
          */
         memory?: MachineMemory;
+        /** Preset to use for the machine. Defaults to small-1x */
+        preset?: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
     };
     /** This gets called when a task is triggered. It's where you put the code you want to execute.
      *
@@ -332,6 +335,84 @@ declare const wait: {
     }) => Promise<void>;
 };
 
+type ComputeUsage = {
+    costInCents: number;
+    durationMs: number;
+};
+type CurrentUsage = {
+    compute: {
+        attempt: ComputeUsage;
+        total: ComputeUsage;
+    };
+    baseCostInCents: number;
+    totalCostInCents: number;
+};
+declare const usage: {
+    /**
+     * Get the current running usage of this task run.
+     *
+     * @example
+     *
+     * ```typescript
+     * import { usage, task } from "@trigger.dev/sdk/v3";
+     *
+     * export const myTask = task({
+     *  id: "my-task",
+     *  run: async (payload, { ctx }) => {
+     *   // ... Do a bunch of work
+     *
+     *   const currentUsage = usage.getCurrent();
+     *
+     *   // You have access to the current compute cost and duration up to this point
+     *   console.log("Current attempt compute cost and duration", {
+     *     cost: currentUsage.compute.attempt.costInCents,
+     *     duration: currentUsage.compute.attempt.durationMs,
+     *   });
+     *
+     *   // You also can see the total compute cost and duration up to this point in the run, across all attempts
+     *   console.log("Current total compute cost and duration", {
+     *     cost: currentUsage.compute.total.costInCents,
+     *     duration: currentUsage.compute.total.durationMs,
+     *   });
+     *
+     *   // You can see the base cost of the run, which is the cost of the run before any compute costs
+     *   console.log("Total cost", {
+     *     cost: currentUsage.totalCostInCents,
+     *     baseCost: currentUsage.baseCostInCents,
+     *   });
+     *  },
+     * });
+     * ```
+     */
+    getCurrent: () => CurrentUsage;
+    /**
+     * Measure the cost and duration of a function.
+     *
+     * @example
+     *
+     * ```typescript
+     * import { usage } from "@trigger.dev/sdk/v3";
+     *
+     * export const myTask = task({
+     *  id: "my-task",
+     *  run: async (payload, { ctx }) => {
+     *    const { result, compute } = await usage.measure(async () => {
+     *      // Do some work
+     *      return "result";
+     *    });
+     *
+     *    console.log("Result", result);
+     *    console.log("Cost and duration", { cost: compute.costInCents, duration: compute.durationMs });
+     *  },
+     * });
+     * ```
+     */
+    measure: <T>(cb: () => Promise<T>) => Promise<{
+        result: T;
+        compute: ComputeUsage;
+    }>;
+};
+
 type RetrieveRunResult = RetrieveRunResponse;
 declare const runs: {
     replay: typeof replayRun;
@@ -351,6 +432,7 @@ declare function task<TOutput, TInitOutput extends InitOutput>(params: TaskOptio
  * @param options
  * @param options.task - The identifier of the task to be scheduled (Must already exist and be a scheduled task)
  * @param options.cron - The cron expression for the schedule (e.g. `0 0 * * *`)
+ * @param options.timezone - An optional timezone for the schedule in the IANA format (e.g. `America/Los_Angeles`). Defaults to "UTC".
  * @param options.externalId - An optional external identifier for the schedule
  * @param options.deduplicationKey - An optional deduplication key for the schedule
  * @returns The created schedule
@@ -368,6 +450,7 @@ declare function retrieve$1(scheduleId: string): ApiPromise<ScheduleObject>;
  * @param options - The updated schedule options
  * @param options.task - The identifier of the task to be scheduled (Must already exist and be a scheduled task)
  * @param options.cron - The cron expression for the schedule (e.g. `0 0 * * *`)
+ * @param options.timezone - An optional timezone for the schedule in the IANA format (e.g. `America/Los_Angeles`). Defaults to "UTC".
  * @param options.externalId - An optional external identifier for the schedule
  * @returns The updated schedule
  */
@@ -395,12 +478,22 @@ declare function activate(scheduleId: string): ApiPromise<ScheduleObject>;
  * @returns The list of schedules
  */
 declare function list$1(options?: ListScheduleOptions): OffsetLimitPagePromise<typeof ScheduleObject>;
+/**
+ * Lists the possible timezones we support
+ * @param excludeUtc - By default "UTC" is included and is first. If true, "UTC" will be excluded.
+ */
+declare function timezones(options?: {
+    excludeUtc?: boolean;
+}): ApiPromise<{
+    timezones: string[];
+}>;
 
 declare const index_activate: typeof activate;
 declare const index_deactivate: typeof deactivate;
 declare const index_task: typeof task;
+declare const index_timezones: typeof timezones;
 declare namespace index {
-  export { index_activate as activate, create$1 as create, index_deactivate as deactivate, del$1 as del, list$1 as list, retrieve$1 as retrieve, index_task as task, update$1 as update };
+  export { index_activate as activate, create$1 as create, index_deactivate as deactivate, del$1 as del, list$1 as list, retrieve$1 as retrieve, index_task as task, index_timezones as timezones, update$1 as update };
 }
 
 declare function upload(projectRef: string, slug: string, params: ImportEnvironmentVariablesParams): ApiPromise<EnvironmentVariableResponseBody>;
@@ -447,4 +540,4 @@ declare namespace envvars {
  */
 declare function configure(options: ApiClientConfiguration): void;
 
-export { type CacheEntry, type CacheFunction, type CacheMetadata, type CacheStore, type Context, type Eventually, InMemoryCache, type Task, type TaskOptions, type WaitOptions, configure, createCache, envvars, queue, retry, runs, index as schedules, task$1 as task, wait };
+export { type CacheEntry, type CacheFunction, type CacheMetadata, type CacheStore, type ComputeUsage, type Context, type CurrentUsage, type Eventually, InMemoryCache, type Task, type TaskOptions, type WaitOptions, configure, createCache, envvars, queue, retry, runs, index as schedules, task$1 as task, usage, wait };

package/dist/v3/index.d.ts

@@ -1,7 +1,6 @@
-import { RetryOptions, FetchRetryOptions, TaskRunContext, QueueOptions, InitOutput, MachineCpu, MachineMemory, RunFnParams, InitFnParams, HandleErrorFnParams, HandleErrorResult, MiddlewareFnParams, StartFnParams, SuccessFnParams, FailureFnParams, ListProjectRunsQueryParams, ListRunResponseItem, ListRunsQueryParams, ApiPromise, ReplayRunResponse, CanceledRunResponse, RetrieveRunResponse, ScheduledTaskPayload, CreateScheduleOptions, ScheduleObject, UpdateScheduleOptions, DeletedScheduleObject, ListScheduleOptions, ImportEnvironmentVariablesParams, EnvironmentVariableResponseBody, EnvironmentVariables, CreateEnvironmentVariableParams, EnvironmentVariableValue, UpdateEnvironmentVariableParams, ApiClientConfiguration } from '@trigger.dev/core/v3';
+import { RetryOptions, FetchRetryOptions, TaskRunContext, QueueOptions, InitOutput, MachineCpu, MachineMemory, RunFnParams, InitFnParams, HandleErrorFnParams, HandleErrorResult, MiddlewareFnParams, StartFnParams, SuccessFnParams, FailureFnParams, ListProjectRunsQueryParams, CursorPagePromise, ListRunResponseItem, ListRunsQueryParams, ApiPromise, ReplayRunResponse, CanceledRunResponse, RetrieveRunResponse, ScheduledTaskPayload, CreateScheduleOptions, ScheduleObject, UpdateScheduleOptions, DeletedScheduleObject, ListScheduleOptions, OffsetLimitPagePromise, ImportEnvironmentVariablesParams, EnvironmentVariableResponseBody, EnvironmentVariables, CreateEnvironmentVariableParams, EnvironmentVariableValue, UpdateEnvironmentVariableParams, ApiClientConfiguration } from '@trigger.dev/core/v3';
 export { ApiClientConfiguration, ApiError, AuthenticationError, BadRequestError, ConflictError, HandleErrorArgs, HandleErrorFunction, ImportEnvironmentVariablesParams, InternalServerError, LogLevel, NotFoundError, PermissionDeniedError, RateLimitError, ResolveEnvironmentVariablesFunction, ResolveEnvironmentVariablesParams, ResolveEnvironmentVariablesResult, RetryOptions, ProjectConfig as TriggerConfig, UnprocessableEntityError, logger } from '@trigger.dev/core/v3';
 import { HttpHandler } from 'msw';
-import { CursorPagePromise, OffsetLimitPagePromise } from '@trigger.dev/core/v3/apiClient/core';
 
 type CacheMetadata = {
     createdTime: number;
@@ -129,6 +128,7 @@ type TaskOptions<TPayload = void, TOutput = unknown, TInitOutput extends InitOut
          * - 1
          * - 2
          * - 4
+         * @deprecated use preset instead
          */
         cpu?: MachineCpu;
         /** In GBs of RAM. The default is 1.
@@ -140,8 +140,11 @@ type TaskOptions<TPayload = void, TOutput = unknown, TInitOutput extends InitOut
          * - 2
          * - 4
          * - 8
+         * * @deprecated use preset instead
          */
         memory?: MachineMemory;
+        /** Preset to use for the machine. Defaults to small-1x */
+        preset?: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
     };
     /** This gets called when a task is triggered. It's where you put the code you want to execute.
      *
@@ -332,6 +335,84 @@ declare const wait: {
     }) => Promise<void>;
 };
 
+type ComputeUsage = {
+    costInCents: number;
+    durationMs: number;
+};
+type CurrentUsage = {
+    compute: {
+        attempt: ComputeUsage;
+        total: ComputeUsage;
+    };
+    baseCostInCents: number;
+    totalCostInCents: number;
+};
+declare const usage: {
+    /**
+     * Get the current running usage of this task run.
+     *
+     * @example
+     *
+     * ```typescript
+     * import { usage, task } from "@trigger.dev/sdk/v3";
+     *
+     * export const myTask = task({
+     *  id: "my-task",
+     *  run: async (payload, { ctx }) => {
+     *   // ... Do a bunch of work
+     *
+     *   const currentUsage = usage.getCurrent();
+     *
+     *   // You have access to the current compute cost and duration up to this point
+     *   console.log("Current attempt compute cost and duration", {
+     *     cost: currentUsage.compute.attempt.costInCents,
+     *     duration: currentUsage.compute.attempt.durationMs,
+     *   });
+     *
+     *   // You also can see the total compute cost and duration up to this point in the run, across all attempts
+     *   console.log("Current total compute cost and duration", {
+     *     cost: currentUsage.compute.total.costInCents,
+     *     duration: currentUsage.compute.total.durationMs,
+     *   });
+     *
+     *   // You can see the base cost of the run, which is the cost of the run before any compute costs
+     *   console.log("Total cost", {
+     *     cost: currentUsage.totalCostInCents,
+     *     baseCost: currentUsage.baseCostInCents,
+     *   });
+     *  },
+     * });
+     * ```
+     */
+    getCurrent: () => CurrentUsage;
+    /**
+     * Measure the cost and duration of a function.
+     *
+     * @example
+     *
+     * ```typescript
+     * import { usage } from "@trigger.dev/sdk/v3";
+     *
+     * export const myTask = task({
+     *  id: "my-task",
+     *  run: async (payload, { ctx }) => {
+     *    const { result, compute } = await usage.measure(async () => {
+     *      // Do some work
+     *      return "result";
+     *    });
+     *
+     *    console.log("Result", result);
+     *    console.log("Cost and duration", { cost: compute.costInCents, duration: compute.durationMs });
+     *  },
+     * });
+     * ```
+     */
+    measure: <T>(cb: () => Promise<T>) => Promise<{
+        result: T;
+        compute: ComputeUsage;
+    }>;
+};
+
 type RetrieveRunResult = RetrieveRunResponse;
 declare const runs: {
     replay: typeof replayRun;
@@ -351,6 +432,7 @@ declare function task<TOutput, TInitOutput extends InitOutput>(params: TaskOptio
  * @param options
  * @param options.task - The identifier of the task to be scheduled (Must already exist and be a scheduled task)
  * @param options.cron - The cron expression for the schedule (e.g. `0 0 * * *`)
+ * @param options.timezone - An optional timezone for the schedule in the IANA format (e.g. `America/Los_Angeles`). Defaults to "UTC".
  * @param options.externalId - An optional external identifier for the schedule
  * @param options.deduplicationKey - An optional deduplication key for the schedule
  * @returns The created schedule
@@ -368,6 +450,7 @@ declare function retrieve$1(scheduleId: string): ApiPromise<ScheduleObject>;
  * @param options - The updated schedule options
  * @param options.task - The identifier of the task to be scheduled (Must already exist and be a scheduled task)
  * @param options.cron - The cron expression for the schedule (e.g. `0 0 * * *`)
+ * @param options.timezone - An optional timezone for the schedule in the IANA format (e.g. `America/Los_Angeles`). Defaults to "UTC".
  * @param options.externalId - An optional external identifier for the schedule
  * @returns The updated schedule
  */
@@ -395,12 +478,22 @@ declare function activate(scheduleId: string): ApiPromise<ScheduleObject>;
  * @returns The list of schedules
  */
 declare function list$1(options?: ListScheduleOptions): OffsetLimitPagePromise<typeof ScheduleObject>;
+/**
+ * Lists the possible timezones we support
+ * @param excludeUtc - By default "UTC" is included and is first. If true, "UTC" will be excluded.
+ */
+declare function timezones(options?: {
+    excludeUtc?: boolean;
+}): ApiPromise<{
+    timezones: string[];
+}>;
 
 declare const index_activate: typeof activate;
 declare const index_deactivate: typeof deactivate;
 declare const index_task: typeof task;
+declare const index_timezones: typeof timezones;
 declare namespace index {
-  export { index_activate as activate, create$1 as create, index_deactivate as deactivate, del$1 as del, list$1 as list, retrieve$1 as retrieve, index_task as task, update$1 as update };
+  export { index_activate as activate, create$1 as create, index_deactivate as deactivate, del$1 as del, list$1 as list, retrieve$1 as retrieve, index_task as task, index_timezones as timezones, update$1 as update };
 }
 
 declare function upload(projectRef: string, slug: string, params: ImportEnvironmentVariablesParams): ApiPromise<EnvironmentVariableResponseBody>;
@@ -447,4 +540,4 @@ declare namespace envvars {
  */
 declare function configure(options: ApiClientConfiguration): void;
 
-export { type CacheEntry, type CacheFunction, type CacheMetadata, type CacheStore, type Context, type Eventually, InMemoryCache, type Task, type TaskOptions, type WaitOptions, configure, createCache, envvars, queue, retry, runs, index as schedules, task$1 as task, wait };
+export { type CacheEntry, type CacheFunction, type CacheMetadata, type CacheStore, type ComputeUsage, type Context, type CurrentUsage, type Eventually, InMemoryCache, type Task, type TaskOptions, type WaitOptions, configure, createCache, envvars, queue, retry, runs, index as schedules, task$1 as task, usage, wait };

package/dist/v3/index.js

@@ -4,6 +4,7 @@ var v3 = require('@trigger.dev/core/v3');
 var api = require('@opentelemetry/api');
 var semanticConventions = require('@opentelemetry/semantic-conventions');
 var node_async_hooks = require('node:async_hooks');
+var zodfetch = require('@trigger.dev/core/v3/zodfetch');
 
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
@@ -18,7 +19,7 @@ var __publicField = (obj, key, value) => {
 };
 
 // package.json
-var version = "3.0.0-beta.37";
+var version = "3.0.0-beta.39";
 
 // src/v3/tracer.ts
 var tracer = new v3.TriggerTracer({
@@ -931,6 +932,116 @@ function calculateDurationInMs(options) {
   throw new Error("Invalid options");
 }
 __name(calculateDurationInMs, "calculateDurationInMs");
+var usage = {
+  /**
+  * Get the current running usage of this task run.
+  *
+  * @example
+  *
+  * ```typescript
+  * import { usage, task } from "@trigger.dev/sdk/v3";
+  *
+  * export const myTask = task({
+  *  id: "my-task",
+  *  run: async (payload, { ctx }) => {
+  *   // ... Do a bunch of work
+  *
+  *   const currentUsage = usage.getCurrent();
+  *
+  *   // You have access to the current compute cost and duration up to this point
+  *   console.log("Current attempt compute cost and duration", {
+  *     cost: currentUsage.compute.attempt.costInCents,
+  *     duration: currentUsage.compute.attempt.durationMs,
+  *   });
+  *
+  *   // You also can see the total compute cost and duration up to this point in the run, across all attempts
+  *   console.log("Current total compute cost and duration", {
+  *     cost: currentUsage.compute.total.costInCents,
+  *     duration: currentUsage.compute.total.durationMs,
+  *   });
+  *
+  *   // You can see the base cost of the run, which is the cost of the run before any compute costs
+  *   console.log("Total cost", {
+  *     cost: currentUsage.totalCostInCents,
+  *     baseCost: currentUsage.baseCostInCents,
+  *   });
+  *  },
+  * });
+  * ```
+  */
+  getCurrent: () => {
+    const sample = v3.usage.sample();
+    const machine = v3.taskContext.ctx?.machine;
+    const run = v3.taskContext.ctx?.run;
+    if (!sample) {
+      return {
+        compute: {
+          attempt: {
+            costInCents: 0,
+            durationMs: 0
+          },
+          total: {
+            costInCents: run?.costInCents ?? 0,
+            durationMs: run?.durationMs ?? 0
+          }
+        },
+        baseCostInCents: run?.baseCostInCents ?? 0,
+        totalCostInCents: (run?.costInCents ?? 0) + (run?.baseCostInCents ?? 0)
+      };
+    }
+    const currentCostInCents = machine?.centsPerMs ? sample.cpuTime * machine.centsPerMs : 0;
+    return {
+      compute: {
+        attempt: {
+          costInCents: currentCostInCents,
+          durationMs: sample.cpuTime
+        },
+        total: {
+          costInCents: (run?.costInCents ?? 0) + currentCostInCents,
+          durationMs: (run?.durationMs ?? 0) + sample.cpuTime
+        }
+      },
+      baseCostInCents: run?.baseCostInCents ?? 0,
+      totalCostInCents: (run?.costInCents ?? 0) + currentCostInCents + (run?.baseCostInCents ?? 0)
+    };
+  },
+  /**
+  * Measure the cost and duration of a function.
+  *
+  * @example
+  *
+  * ```typescript
+  * import { usage } from "@trigger.dev/sdk/v3";
+  *
+  * export const myTask = task({
+  *  id: "my-task",
+  *  run: async (payload, { ctx }) => {
+  *    const { result, compute } = await usage.measure(async () => {
+  *      // Do some work
+  *      return "result";
+  *    });
+  *
+  *    console.log("Result", result);
+  *    console.log("Cost and duration", { cost: compute.costInCents, duration: compute.durationMs });
+  *  },
+  * });
+  * ```
+  */
+  measure: async (cb) => {
+    const measurement = v3.usage.start();
+    const result = await cb();
+    const sample = v3.usage.stop(measurement);
+    const machine = v3.taskContext.ctx?.machine;
+    const costInCents = machine?.centsPerMs ? sample.cpuTime * machine.centsPerMs : 0;
+    return {
+      result,
+      compute: {
+        costInCents,
+        durationMs: sample.cpuTime
+      }
+    };
+  }
+};
 var runs = {
   replay: replayRun,
   cancel: cancelRun,
@@ -983,6 +1094,7 @@ __export(schedules_exports, {
   list: () => list,
   retrieve: () => retrieve,
   task: () => task2,
+  timezones: () => timezones,
   update: () => update
 });
 function task2(params) {
@@ -1049,6 +1161,19 @@ function list(options) {
   return apiClient.listSchedules(options);
 }
 __name(list, "list");
+function timezones(options) {
+  const baseUrl = v3.apiClientManager.baseURL;
+  if (!baseUrl) {
+    throw apiClientMissingError();
+  }
+  return zodfetch.zodfetch(v3.TimezonesResult, `${baseUrl}/api/v1/timezones${options?.excludeUtc === true ? "?excludeUtc=true" : ""}`, {
+    method: "GET",
+    headers: {
+      "Content-Type": "application/json"
+    }
+  });
+}
+__name(timezones, "timezones");
 
 // src/v3/envvars.ts
 var envvars_exports = {};
@@ -1302,6 +1427,7 @@ exports.retry = retry;
 exports.runs = runs;
 exports.schedules = schedules_exports;
 exports.task = task;
+exports.usage = usage;
 exports.wait = wait;
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.js.map