@trigger.dev/sdk 0.0.0-canary-20231129101350 → 0.0.0-cli-e2e-20240910161832

package/dist/commonjs/v3/schedules/index.js

@@ -0,0 +1,250 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.task = task;
+exports.create = create;
+exports.retrieve = retrieve;
+exports.update = update;
+exports.del = del;
+exports.deactivate = deactivate;
+exports.activate = activate;
+exports.list = list;
+exports.timezones = timezones;
+const v3_1 = require("@trigger.dev/core/v3");
+const zodfetch_1 = require("@trigger.dev/core/v3/zodfetch");
+const shared_js_1 = require("../shared.js");
+const tracer_js_1 = require("../tracer.js");
+function task(params) {
+    const task = (0, shared_js_1.createTask)(params);
+    const cron = params.cron
+        ? typeof params.cron === "string"
+            ? params.cron
+            : params.cron.pattern
+        : undefined;
+    const timezone = (params.cron && typeof params.cron !== "string" ? params.cron.timezone : "UTC") ?? "UTC";
+    v3_1.taskCatalog.updateTaskMetadata(task.id, {
+        triggerSource: "schedule",
+        schedule: cron
+            ? {
+                cron: cron,
+                timezone,
+            }
+            : undefined,
+    });
+    return task;
+}
+/**
+ * Creates a new schedule
+ * @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
+ */
+function create(options, requestOptions) {
+    const apiClient = v3_1.apiClientManager.client;
+    if (!apiClient) {
+        throw (0, shared_js_1.apiClientMissingError)();
+    }
+    const $requestOptions = (0, v3_1.mergeRequestOptions)({
+        tracer: tracer_js_1.tracer,
+        name: "schedules.create()",
+        icon: "clock",
+        attributes: {
+            ...(0, v3_1.accessoryAttributes)({
+                items: [
+                    {
+                        text: options.cron,
+                        variant: "normal",
+                    },
+                ],
+                style: "codepath",
+            }),
+        },
+    }, requestOptions);
+    return apiClient.createSchedule(options, $requestOptions);
+}
+/**
+ * Retrieves a schedule
+ * @param scheduleId - The ID of the schedule to retrieve
+ * @returns The retrieved schedule
+ */
+function retrieve(scheduleId, requestOptions) {
+    const apiClient = v3_1.apiClientManager.client;
+    if (!apiClient) {
+        throw (0, shared_js_1.apiClientMissingError)();
+    }
+    const $requestOptions = (0, v3_1.mergeRequestOptions)({
+        tracer: tracer_js_1.tracer,
+        name: "schedules.retrieve()",
+        icon: "clock",
+        attributes: {
+            scheduleId,
+            ...(0, v3_1.accessoryAttributes)({
+                items: [
+                    {
+                        text: scheduleId,
+                        variant: "normal",
+                    },
+                ],
+                style: "codepath",
+            }),
+        },
+    }, requestOptions);
+    return apiClient.retrieveSchedule(scheduleId, $requestOptions);
+}
+/**
+ * Updates a schedule
+ * @param scheduleId - The ID of the schedule to update
+ * @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
+ */
+function update(scheduleId, options, requestOptions) {
+    const apiClient = v3_1.apiClientManager.client;
+    if (!apiClient) {
+        throw (0, shared_js_1.apiClientMissingError)();
+    }
+    const $requestOptions = (0, v3_1.mergeRequestOptions)({
+        tracer: tracer_js_1.tracer,
+        name: "schedules.update()",
+        icon: "clock",
+        attributes: {
+            scheduleId,
+            ...(0, v3_1.accessoryAttributes)({
+                items: [
+                    {
+                        text: scheduleId,
+                        variant: "normal",
+                    },
+                ],
+                style: "codepath",
+            }),
+        },
+    }, requestOptions);
+    return apiClient.updateSchedule(scheduleId, options, $requestOptions);
+}
+/**
+ * Deletes a schedule
+ * @param scheduleId - The ID of the schedule to delete
+ */
+function del(scheduleId, requestOptions) {
+    const apiClient = v3_1.apiClientManager.client;
+    if (!apiClient) {
+        throw (0, shared_js_1.apiClientMissingError)();
+    }
+    const $requestOptions = (0, v3_1.mergeRequestOptions)({
+        tracer: tracer_js_1.tracer,
+        name: "schedules.delete()",
+        icon: "clock",
+        attributes: {
+            scheduleId,
+            ...(0, v3_1.accessoryAttributes)({
+                items: [
+                    {
+                        text: scheduleId,
+                        variant: "normal",
+                    },
+                ],
+                style: "codepath",
+            }),
+        },
+    }, requestOptions);
+    return apiClient.deleteSchedule(scheduleId, $requestOptions);
+}
+/**
+ * Deactivates a schedule
+ * @param scheduleId - The ID of the schedule to deactivate
+ */
+function deactivate(scheduleId, requestOptions) {
+    const apiClient = v3_1.apiClientManager.client;
+    if (!apiClient) {
+        throw (0, shared_js_1.apiClientMissingError)();
+    }
+    const $requestOptions = (0, v3_1.mergeRequestOptions)({
+        tracer: tracer_js_1.tracer,
+        name: "schedules.deactivate()",
+        icon: "clock",
+        attributes: {
+            scheduleId,
+            ...(0, v3_1.accessoryAttributes)({
+                items: [
+                    {
+                        text: scheduleId,
+                        variant: "normal",
+                    },
+                ],
+                style: "codepath",
+            }),
+        },
+    }, requestOptions);
+    return apiClient.deactivateSchedule(scheduleId, $requestOptions);
+}
+/**
+ * Activates a schedule
+ * @param scheduleId - The ID of the schedule to activate
+ */
+function activate(scheduleId, requestOptions) {
+    const apiClient = v3_1.apiClientManager.client;
+    if (!apiClient) {
+        throw (0, shared_js_1.apiClientMissingError)();
+    }
+    const $requestOptions = (0, v3_1.mergeRequestOptions)({
+        tracer: tracer_js_1.tracer,
+        name: "schedules.activate()",
+        icon: "clock",
+        attributes: {
+            scheduleId,
+            ...(0, v3_1.accessoryAttributes)({
+                items: [
+                    {
+                        text: scheduleId,
+                        variant: "normal",
+                    },
+                ],
+                style: "codepath",
+            }),
+        },
+    }, requestOptions);
+    return apiClient.activateSchedule(scheduleId, $requestOptions);
+}
+/**
+ * Lists schedules
+ * @param options - The list options
+ * @param options.page - The page number
+ * @param options.perPage - The number of schedules per page
+ * @returns The list of schedules
+ */
+function list(options, requestOptions) {
+    const apiClient = v3_1.apiClientManager.client;
+    if (!apiClient) {
+        throw (0, shared_js_1.apiClientMissingError)();
+    }
+    const $requestOptions = (0, v3_1.mergeRequestOptions)({
+        tracer: tracer_js_1.tracer,
+        name: "schedules.list()",
+        icon: "clock",
+    }, requestOptions);
+    return apiClient.listSchedules(options, $requestOptions);
+}
+/**
+ * Lists the possible timezones we support
+ * @param excludeUtc - By default "UTC" is included and is first. If true, "UTC" will be excluded.
+ */
+function timezones(options) {
+    const baseUrl = v3_1.apiClientManager.baseURL;
+    if (!baseUrl) {
+        throw (0, shared_js_1.apiClientMissingError)();
+    }
+    return (0, zodfetch_1.zodfetch)(v3_1.TimezonesResult, `${baseUrl}/api/v1/timezones${options?.excludeUtc === true ? "?excludeUtc=true" : ""}`, {
+        method: "GET",
+        headers: {
+            "Content-Type": "application/json",
+        },
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/commonjs/v3/schedules/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/v3/schedules/index.ts"],"names":[],"mappings":";;AAgDA,oBAwBC;AAYD,wBA+BC;AAOD,4BAgCC;AAYD,wBAiCC;AAMD,kBAgCC;AAMD,gCAgCC;AAMD,4BAgCC;AASD,oBAoBC;AAMD,8BAiBC;AA7WD,6CAY8B;AAC9B,4DAAyD;AACzD,4CAAoF;AAEpF,4CAAsC;AAgCtC,SAAgB,IAAI,CAClB,MAA0D;IAE1D,MAAM,IAAI,GAAG,IAAA,sBAAU,EAAC,MAAM,CAAC,CAAC;IAEhC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI;QACtB,CAAC,CAAC,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ;YAC/B,CAAC,CAAC,MAAM,CAAC,IAAI;YACb,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO;QACvB,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,QAAQ,GACZ,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;IAE3F,gBAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAAE;QACtC,aAAa,EAAE,UAAU;QACzB,QAAQ,EAAE,IAAI;YACZ,CAAC,CAAC;gBACE,IAAI,EAAE,IAAI;gBACV,QAAQ;aACT;YACH,CAAC,CAAC,SAAS;KACd,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,MAAM,CACpB,OAA2C,EAC3C,cAAkC;IAElC,MAAM,SAAS,GAAG,qBAAgB,CAAC,MAAM,CAAC;IAE1C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAA,iCAAqB,GAAE,CAAC;IAChC,CAAC;IAED,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,GAAG,IAAA,wBAAmB,EAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,OAAO,CAAC,IAAI;wBAClB,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AAC5D,CAAC;AAED;;;;GAIG;AACH,SAAgB,QAAQ,CACtB,UAAkB,EAClB,cAAkC;IAElC,MAAM,SAAS,GAAG,qBAAgB,CAAC,MAAM,CAAC;IAE1C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAA,iCAAqB,GAAE,CAAC;IAChC,CAAC;IAED,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,IAAA,wBAAmB,EAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,UAAU;wBAChB,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,gBAAgB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AACjE,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,MAAM,CACpB,UAAkB,EAClB,OAA2C,EAC3C,cAAkC;IAElC,MAAM,SAAS,GAAG,qBAAgB,CAAC,MAAM,CAAC;IAE1C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAA,iCAAqB,GAAE,CAAC;IAChC,CAAC;IAED,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,IAAA,wBAAmB,EAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,UAAU;wBAChB,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,cAAc,CAAC,UAAU,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC;AACxE,CAAC;AAED;;;GAGG;AACH,SAAgB,GAAG,CACjB,UAAkB,EAClB,cAAkC;IAElC,MAAM,SAAS,GAAG,qBAAgB,CAAC,MAAM,CAAC;IAE1C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAA,iCAAqB,GAAE,CAAC;IAChC,CAAC;IAED,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,IAAA,wBAAmB,EAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,UAAU;wBAChB,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,cAAc,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,SAAgB,UAAU,CACxB,UAAkB,EAClB,cAAkC;IAElC,MAAM,SAAS,GAAG,qBAAgB,CAAC,MAAM,CAAC;IAE1C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAA,iCAAqB,GAAE,CAAC;IAChC,CAAC;IAED,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,wBAAwB;QAC9B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,IAAA,wBAAmB,EAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,UAAU;wBAChB,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,kBAAkB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AACnE,CAAC;AAED;;;GAGG;AACH,SAAgB,QAAQ,CACtB,UAAkB,EAClB,cAAkC;IAElC,MAAM,SAAS,GAAG,qBAAgB,CAAC,MAAM,CAAC;IAE1C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAA,iCAAqB,GAAE,CAAC;IAChC,CAAC;IAED,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,IAAA,wBAAmB,EAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,UAAU;wBAChB,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,gBAAgB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AACjE,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,IAAI,CAClB,OAA0C,EAC1C,cAAkC;IAElC,MAAM,SAAS,GAAG,qBAAgB,CAAC,MAAM,CAAC;IAE1C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAA,iCAAqB,GAAE,CAAC;IAChC,CAAC;IAED,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,OAAO;KACd,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AAC3D,CAAC;AAED;;;GAGG;AACH,SAAgB,SAAS,CAAC,OAAkC;IAC1D,MAAM,OAAO,GAAG,qBAAgB,CAAC,OAAO,CAAC;IAEzC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAA,iCAAqB,GAAE,CAAC;IAChC,CAAC;IAED,OAAO,IAAA,mBAAQ,EACb,oBAAe,EACf,GAAG,OAAO,oBAAoB,OAAO,EAAE,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,EAAE,EACtF;QACE,MAAM,EAAE,KAAK;QACb,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;SACnC;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/commonjs/v3/shared.d.ts

@@ -0,0 +1,432 @@
+import { ApiRequestOptions, FailureFnParams, HandleErrorFnParams, HandleErrorResult, InitFnParams, InitOutput, MachineCpu, MachineMemory, MiddlewareFnParams, QueueOptions, RetryOptions, RunFnParams, RunTags, StartFnParams, SuccessFnParams, TaskRunContext } from "@trigger.dev/core/v3";
+import { IdempotencyKey } from "./idempotencyKeys.js";
+import { PollOptions, RetrieveRunResult } from "./runs.js";
+export type Context = TaskRunContext;
+type RequireOne<T, K extends keyof T> = {
+    [X in Exclude<keyof T, K>]?: T[X];
+} & {
+    [P in K]-?: T[P];
+};
+export type Queue = RequireOne<QueueOptions, "name">;
+export declare function queue(options: {
+    name: string;
+} & QueueOptions): Queue;
+export type TaskOptions<TIdentifier extends string, 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: TIdentifier;
+    /** The retry settings when an uncaught error is thrown.
+     *
+     * If omitted it will use the values in your `trigger.config.ts` file.
+     *
+     * @example
+     *
+     * ```
+     * export const taskWithRetries = task({
+        id: "task-with-retries",
+        retry: {
+          maxAttempts: 10,
+          factor: 1.8,
+          minTimeoutInMs: 500,
+          maxTimeoutInMs: 30_000,
+          randomize: false,
+        },
+        run: async ({ payload, ctx }) => {
+          //...
+        },
+      });
+     * ```
+     * */
+    retry?: RetryOptions;
+    /** Used to configure what should happen when more than one run is triggered at the same time.
+     *
+     * @example
+     * one at a time execution
+     *
+     * ```ts
+     * export const oneAtATime = task({
+        id: "one-at-a-time",
+        queue: {
+          concurrencyLimit: 1,
+        },
+        run: async ({ payload, ctx }) => {
+          //...
+        },
+      });
+     * ```
+     */
+    queue?: QueueOptions;
+    /** Configure the spec of the machine you want your task to run on.
+     *
+     * @example
+     *
+     * ```ts
+     * export const heavyTask = task({
+        id: "heavy-task",
+        machine: {
+          cpu: 2,
+          memory: 4,
+        },
+        run: async ({ payload, ctx }) => {
+          //...
+        },
+      });
+     * ```
+    */
+    machine?: {
+        /** vCPUs. The default is 0.5.
+         *
+         * Possible values:
+         * - 0.25
+         * - 0.5
+         * - 1
+         * - 2
+         * - 4
+         * @deprecated use preset instead
+         */
+        cpu?: MachineCpu;
+        /** In GBs of RAM. The default is 1.
+         *
+         * Possible values:
+         * - 0.25
+         * - 0.5
+         * - 1
+         * - 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.
+     *
+     * @param payload - The payload that is passed to your task when it's triggered. This must be JSON serializable.
+     * @param params - Metadata about the run.
+     */
+    run: (payload: TPayload, params: RunFnParams<TInitOutput>) => Promise<TOutput>;
+    /**
+     * init is called before the run function is called. It's useful for setting up any global state.
+     */
+    init?: (payload: TPayload, params: InitFnParams) => Promise<TInitOutput>;
+    /**
+     * cleanup is called after the run function has completed.
+     */
+    cleanup?: (payload: TPayload, params: RunFnParams<TInitOutput>) => Promise<void>;
+    /**
+     * handleError is called when the run function throws an error. It can be used to modify the error or return new retry options.
+     */
+    handleError?: (payload: TPayload, error: unknown, params: HandleErrorFnParams<TInitOutput>) => HandleErrorResult;
+    /**
+     * middleware allows you to run code "around" the run function. This can be useful for logging, metrics, or other cross-cutting concerns.
+     *
+     * When writing middleware, you should always call `next()` to continue the execution of the task:
+     *
+     * ```ts
+     * export const middlewareTask = task({
+     *  id: "middleware-task",
+     *  middleware: async (payload, { ctx, next }) => {
+     *   console.log("Before run");
+     *   await next();
+     *   console.log("After run");
+     *  },
+     *  run: async (payload, { ctx }) => {}
+     * });
+     * ```
+     */
+    middleware?: (payload: TPayload, params: MiddlewareFnParams) => Promise<void>;
+    /**
+     * onStart is called the first time a task is executed in a run (not before every retry)
+     */
+    onStart?: (payload: TPayload, params: StartFnParams) => Promise<void>;
+    /**
+     * onSuccess is called after the run function has successfully completed.
+     */
+    onSuccess?: (payload: TPayload, output: TOutput, params: SuccessFnParams<TInitOutput>) => Promise<void>;
+    /**
+     * onFailure is called after a task run has failed (meaning the run function threw an error and won't be retried anymore)
+     */
+    onFailure?: (payload: TPayload, error: unknown, params: FailureFnParams<TInitOutput>) => Promise<void>;
+};
+declare const __output: unique symbol;
+type BrandOutput<B> = {
+    [__output]: B;
+};
+export type BrandedOutput<T, B> = T & BrandOutput<B>;
+export type RunHandle<TOutput> = BrandedOutput<{
+    id: string;
+}, TOutput>;
+/**
+ * A BatchRunHandle can be used to retrieve the runs of a batch trigger in a typesafe manner.
+ */
+export type BatchRunHandle<TOutput> = BrandedOutput<{
+    batchId: string;
+    runs: Array<RunHandle<TOutput>>;
+}, TOutput>;
+export type RunHandleOutput<TRunHandle> = TRunHandle extends RunHandle<infer TOutput> ? TOutput : never;
+export type TaskRunResult<TOutput = any> = {
+    ok: true;
+    id: string;
+    output: TOutput;
+} | {
+    ok: false;
+    id: string;
+    error: unknown;
+};
+export type BatchResult<TOutput = any> = {
+    id: string;
+    runs: TaskRunResult<TOutput>[];
+};
+export type BatchItem<TInput> = TInput extends void ? {
+    payload?: TInput;
+    options?: TaskRunOptions;
+} : {
+    payload: TInput;
+    options?: TaskRunOptions;
+};
+export interface Task<TIdentifier extends string, TInput = void, TOutput = any> {
+    /**
+     * The id of the task.
+     */
+    id: TIdentifier;
+    /**
+     * 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 RunHandle
+     * - `id` - The id of the triggered task run.
+     */
+    trigger: (payload: TInput, options?: TaskRunOptions) => Promise<RunHandle<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
+     * @returns InvokeBatchHandle
+     * - `batchId` - The id of the triggered batch.
+     * - `runs` - The ids of the triggered task runs.
+     */
+    batchTrigger: (items: Array<BatchItem<TInput>>) => Promise<BatchRunHandle<TOutput>>;
+    /**
+     * 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>>;
+}
+export type AnyTask = Task<string, any, any>;
+export type TaskPayload<TTask extends AnyTask> = TTask extends Task<string, infer TInput, any> ? TInput : never;
+export type TaskOutput<TTask extends AnyTask> = TTask extends Task<string, any, infer TOutput> ? TOutput : never;
+export type TaskOutputHandle<TTask extends AnyTask> = TTask extends Task<string, any, infer TOutput> ? RunHandle<TOutput> : never;
+export type TaskBatchOutputHandle<TTask extends AnyTask> = TTask extends Task<string, any, infer TOutput> ? BatchRunHandle<TOutput> : never;
+export type TaskIdentifier<TTask extends AnyTask> = TTask extends Task<infer TIdentifier, any, any> ? TIdentifier : never;
+export type TaskRunOptions = {
+    /**
+     * A unique key that can be used to ensure that a task is only triggered once per key.
+     *
+     * You can use `idempotencyKeys.create` to create an idempotency key first, and then pass it to the task options.
+     *
+     * @example
+     *
+     * ```typescript
+     * import { idempotencyKeys, task } from "@trigger.dev/sdk/v3";
+     *
+     * export const myTask = task({
+     *  id: "my-task",
+     *  run: async (payload: any) => {
+     *   // scoped to the task run by default
+     *   const idempotencyKey = await idempotencyKeys.create("my-task-key");
+     *
+     *   // Use the idempotency key when triggering child tasks
+     *   await childTask.triggerAndWait(payload, { idempotencyKey });
+     *
+     *   // scoped globally, does not include the task run ID
+     *   const globalIdempotencyKey = await idempotencyKeys.create("my-task-key", { scope: "global" });
+     *
+     *   await childTask.triggerAndWait(payload, { idempotencyKey: globalIdempotencyKey });
+     *
+     *   // You can also pass a string directly, which is the same as a global idempotency key
+     *   await childTask.triggerAndWait(payload, { idempotencyKey: "my-very-unique-key" });
+     *  }
+     * });
+     * ```
+     *
+     * When triggering a task inside another task, we automatically inject the run ID into the key material.
+     *
+     * If you are triggering a task from your backend, ensure you include some sufficiently unique key material to prevent collisions.
+     *
+     * @example
+     *
+     * ```typescript
+     * import { idempotencyKeys, tasks } from "@trigger.dev/sdk/v3";
+     *
+     * // Somewhere in your backend
+     * const idempotencyKey = await idempotenceKeys.create(["my-task-trigger", "user-123"]);
+     * await tasks.trigger("my-task", { foo: "bar" }, { idempotencyKey });
+     * ```
+     *
+     */
+    idempotencyKey?: IdempotencyKey | string | string[];
+    maxAttempts?: number;
+    queue?: TaskRunConcurrencyOptions;
+    concurrencyKey?: string;
+    /**
+     * The delay before the task is executed. This can be a string like "1h" or a Date object.
+     *
+     * @example
+     * "1h" - 1 hour
+     * "30d" - 30 days
+     * "15m" - 15 minutes
+     * "2w" - 2 weeks
+     * "60s" - 60 seconds
+     * new Date("2025-01-01T00:00:00Z")
+     */
+    delay?: string | Date;
+    /**
+     * Set a time-to-live for this run. If the run is not executed within this time, it will be removed from the queue and never execute.
+     *
+     * @example
+     *
+     * ```ts
+     * await myTask.trigger({ foo: "bar" }, { ttl: "1h" });
+     * await myTask.trigger({ foo: "bar" }, { ttl: 60 * 60 }); // 1 hour
+     * ```
+     *
+     * The minimum value is 1 second. Setting the `ttl` to `0` will disable the TTL and the run will never expire.
+     *
+     * **Note:** Runs in development have a default `ttl` of 10 minutes. You can override this by setting the `ttl` option.
+     */
+    ttl?: string | number;
+    /**
+     * Tags to attach to the run. Tags can be used to filter runs in the dashboard and using the SDK.
+     *
+     * You can set up to 5 tags per run, they must be less than 64 characters each.
+     *
+     * We recommend prefixing tags with a namespace using an underscore or colon, like `user_1234567` or `org:9876543`.
+     *
+     * @example
+     *
+     * ```ts
+     * await myTask.trigger({ foo: "bar" }, { tags: ["user:1234567", "org:9876543"] });
+     * ```
+     */
+    tags?: RunTags;
+};
+type TaskRunConcurrencyOptions = Queue;
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+export type DynamicBaseOptions = {
+    id: string;
+};
+export declare function createTask<TIdentifier extends string, TInput = void, TOutput = unknown, TInitOutput extends InitOutput = any>(params: TaskOptions<TIdentifier, TInput, TOutput, TInitOutput>): Task<TIdentifier, TInput, TOutput>;
+/**
+ * Trigger a task by its identifier with the given payload. Returns a typesafe `RunHandle`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { tasks, runs } from "@trigger.dev/sdk/v3";
+ * import type { myTask } from "./myTasks"; // Import just the type of the task
+ *
+ * const handle = await tasks.trigger<typeof myTask>("my-task", { foo: "bar" }); // The id and payload are fully typesafe
+ * const run = await runs.retrieve(handle);
+ * console.log(run.output) // The output is also fully typed
+ * ```
+ *
+ * @returns {RunHandle} An object with the `id` of the run. Can be used to retrieve the completed run output in a typesafe manner.
+ */
+export declare function trigger<TTask extends AnyTask>(id: TaskIdentifier<TTask>, payload: TaskPayload<TTask>, options?: TaskRunOptions, requestOptions?: ApiRequestOptions): Promise<RunHandle<TaskOutput<TTask>>>;
+/**
+ * Trigger a task with the given payload, and wait for the result. Returns the result of the task run
+ * @param id - The id of the task to trigger
+ * @param payload
+ * @param options - Options for the task run
+ * @returns TaskRunResult
+ * @example
+ * ```ts
+ * import { tasks } from "@trigger.dev/sdk/v3";
+ * const result = await tasks.triggerAndWait("my-task", { foo: "bar" });
+ *
+ * if (result.ok) {
+ *  console.log(result.output);
+ * } else {
+ *  console.error(result.error);
+ * }
+ * ```
+ */
+export declare function triggerAndWait<TTask extends AnyTask>(id: TaskIdentifier<TTask>, payload: TaskPayload<TTask>, options?: TaskRunOptions, requestOptions?: ApiRequestOptions): Promise<TaskRunResult<TaskOutput<TTask>>>;
+/**
+ * Batch trigger multiple task runs with the given payloads, and wait for the results. Returns the results of the task runs.
+ * @param id - The id of the task to trigger
+ * @param items
+ * @returns BatchResult
+ * @example
+ *
+ * ```ts
+ * import { tasks } from "@trigger.dev/sdk/v3";
+ *
+ * const result = await tasks.batchTriggerAndWait("my-task", [
+ *  { payload: { foo: "bar" } },
+ *  { payload: { foo: "baz" } },
+ * ]);
+ *
+ * for (const run of result.runs) {
+ *  if (run.ok) {
+ *    console.log(run.output);
+ *  } else {
+ *    console.error(run.error);
+ *  }
+ * }
+ * ```
+ */
+export declare function batchTriggerAndWait<TTask extends AnyTask>(id: TaskIdentifier<TTask>, items: Array<BatchItem<TaskPayload<TTask>>>, requestOptions?: ApiRequestOptions): Promise<BatchResult<TaskOutput<TTask>>>;
+/**
+ * Trigger a task by its identifier with the given payload and poll until the run is completed.
+ *
+ * @example
+ *
+ * ```ts
+ * import { tasks, runs } from "@trigger.dev/sdk/v3";
+ * import type { myTask } from "./myTasks"; // Import just the type of the task
+ *
+ * const run = await tasks.triggerAndPoll<typeof myTask>("my-task", { foo: "bar" }); // The id and payload are fully typesafe
+ * console.log(run.output) // The output is also fully typed
+ * ```
+ *
+ * @returns {Run} The completed run, either successful or failed.
+ */
+export declare function triggerAndPoll<TTask extends AnyTask>(id: TaskIdentifier<TTask>, payload: TaskPayload<TTask>, options?: TaskRunOptions & PollOptions, requestOptions?: ApiRequestOptions): Promise<RetrieveRunResult<RunHandle<TaskOutput<TTask>>>>;
+export declare function batchTrigger<TTask extends AnyTask>(id: TaskIdentifier<TTask>, items: Array<BatchItem<TaskPayload<TTask>>>, requestOptions?: ApiRequestOptions): Promise<BatchRunHandle<TaskOutput<TTask>>>;
+export declare function apiClientMissingError(): "You need to set the TRIGGER_API_URL and TRIGGER_SECRET_KEY environment variables." | "You need to set the TRIGGER_API_URL environment variable." | "You need to set the TRIGGER_SECRET_KEY environment variable." | "Unknown error";
+export {};