@trigger.dev/sdk 3.0.12 → 3.1.0

package/dist/browser/v3/runs.js

@@ -0,0 +1,204 @@
+import { accessoryAttributes, apiClientManager, flattenAttributes, isRequestOptions, mergeRequestOptions, } from "@trigger.dev/core/v3";
+import { resolvePresignedPacketUrl } from "@trigger.dev/core/v3/utils/ioSerialization";
+import { tracer } from "./tracer.js";
+export const runs = {
+    replay: replayRun,
+    cancel: cancelRun,
+    retrieve: retrieveRun,
+    list: listRuns,
+    reschedule: rescheduleRun,
+    poll,
+    subscribeToRun,
+    subscribeToRunsWithTag,
+};
+function listRuns(paramsOrProjectRef, paramsOrOptions, requestOptions) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const $requestOptions = listRunsRequestOptions(paramsOrProjectRef, paramsOrOptions, requestOptions);
+    if (typeof paramsOrProjectRef === "string") {
+        if (isRequestOptions(paramsOrOptions)) {
+            return apiClient.listProjectRuns(paramsOrProjectRef, {}, $requestOptions);
+        }
+        else {
+            return apiClient.listProjectRuns(paramsOrProjectRef, paramsOrOptions, $requestOptions);
+        }
+    }
+    return apiClient.listRuns(paramsOrProjectRef, $requestOptions);
+}
+function listRunsRequestOptions(paramsOrProjectRef, paramsOrOptions, requestOptions) {
+    if (typeof paramsOrProjectRef === "string") {
+        if (isRequestOptions(paramsOrOptions)) {
+            return mergeRequestOptions({
+                tracer,
+                name: "runs.list()",
+                icon: "runs",
+                attributes: {
+                    projectRef: paramsOrProjectRef,
+                    ...accessoryAttributes({
+                        items: [
+                            {
+                                text: paramsOrProjectRef,
+                                variant: "normal",
+                            },
+                        ],
+                        style: "codepath",
+                    }),
+                },
+            }, paramsOrOptions);
+        }
+        else {
+            return mergeRequestOptions({
+                tracer,
+                name: "runs.list()",
+                icon: "runs",
+                attributes: {
+                    projectRef: paramsOrProjectRef,
+                    ...flattenAttributes(paramsOrOptions, "queryParams"),
+                    ...accessoryAttributes({
+                        items: [
+                            {
+                                text: paramsOrProjectRef,
+                                variant: "normal",
+                            },
+                        ],
+                        style: "codepath",
+                    }),
+                },
+            }, requestOptions);
+        }
+    }
+    return mergeRequestOptions({
+        tracer,
+        name: "runs.list()",
+        icon: "runs",
+        attributes: {
+            ...flattenAttributes(paramsOrProjectRef, "queryParams"),
+        },
+    }, isRequestOptions(paramsOrOptions) ? paramsOrOptions : requestOptions);
+}
+function retrieveRun(runId, requestOptions) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "runs.retrieve()",
+        icon: "runs",
+        attributes: {
+            runId: typeof runId === "string" ? runId : runId.id,
+            ...accessoryAttributes({
+                items: [
+                    {
+                        text: typeof runId === "string" ? runId : runId.id,
+                        variant: "normal",
+                    },
+                ],
+                style: "codepath",
+            }),
+        },
+    }, requestOptions);
+    const $runId = typeof runId === "string" ? runId : runId.id;
+    return apiClient.retrieveRun($runId, $requestOptions).then((retrievedRun) => {
+        return resolvePayloadAndOutputUrls(retrievedRun);
+    });
+}
+async function resolvePayloadAndOutputUrls(run) {
+    const resolvedRun = { ...run };
+    if (run.payloadPresignedUrl && run.outputPresignedUrl) {
+        const [payload, output] = await Promise.all([
+            resolvePresignedPacketUrl(run.payloadPresignedUrl, tracer),
+            resolvePresignedPacketUrl(run.outputPresignedUrl, tracer),
+        ]);
+        resolvedRun.payload = payload;
+        resolvedRun.output = output;
+    }
+    else if (run.payloadPresignedUrl) {
+        resolvedRun.payload = await resolvePresignedPacketUrl(run.payloadPresignedUrl, tracer);
+    }
+    else if (run.outputPresignedUrl) {
+        resolvedRun.output = await resolvePresignedPacketUrl(run.outputPresignedUrl, tracer);
+    }
+    return resolvedRun;
+}
+function replayRun(runId, requestOptions) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "runs.replay()",
+        icon: "runs",
+        attributes: {
+            runId,
+            ...accessoryAttributes({
+                items: [
+                    {
+                        text: runId,
+                        variant: "normal",
+                    },
+                ],
+                style: "codepath",
+            }),
+        },
+    }, requestOptions);
+    return apiClient.replayRun(runId, $requestOptions);
+}
+function cancelRun(runId, requestOptions) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "runs.cancel()",
+        icon: "runs",
+        attributes: {
+            runId,
+            ...accessoryAttributes({
+                items: [
+                    {
+                        text: runId,
+                        variant: "normal",
+                    },
+                ],
+                style: "codepath",
+            }),
+        },
+    }, requestOptions);
+    return apiClient.cancelRun(runId, $requestOptions);
+}
+function rescheduleRun(runId, body, requestOptions) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "runs.reschedule()",
+        icon: "runs",
+        attributes: {
+            runId,
+            ...accessoryAttributes({
+                items: [
+                    {
+                        text: runId,
+                        variant: "normal",
+                    },
+                ],
+                style: "codepath",
+            }),
+        },
+    }, requestOptions);
+    return apiClient.rescheduleRun(runId, body, $requestOptions);
+}
+const MAX_POLL_ATTEMPTS = 500;
+async function poll(runId, options, requestOptions) {
+    let attempts = 0;
+    while (attempts++ < MAX_POLL_ATTEMPTS) {
+        const run = await runs.retrieve(runId, requestOptions);
+        if (run.isCompleted) {
+            return run;
+        }
+        await new Promise((resolve) => setTimeout(resolve, options?.pollIntervalMs ?? 1000));
+    }
+    throw new Error(`Run ${typeof runId === "string" ? runId : runId.id} did not complete after ${MAX_POLL_ATTEMPTS} attempts`);
+}
+function subscribeToRun(runId) {
+    const $runId = typeof runId === "string" ? runId : runId.id;
+    const apiClient = apiClientManager.clientOrThrow();
+    return apiClient.subscribeToRun($runId);
+}
+function subscribeToRunsWithTag(tag) {
+    const apiClient = apiClientManager.clientOrThrow();
+    return apiClient.subscribeToRunsWithTag(tag);
+}
+//# sourceMappingURL=runs.js.map

package/dist/browser/v3/runs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runs.js","sourceRoot":"","sources":["../../../src/v3/runs.ts"],"names":[],"mappings":"AAcA,OAAO,EAOL,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAC;AAEvF,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAIrC,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,MAAM,EAAE,SAAS;IACjB,MAAM,EAAE,SAAS;IACjB,QAAQ,EAAE,WAAW;IACrB,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,aAAa;IACzB,IAAI;IACJ,cAAc;IACd,sBAAsB;CACvB,CAAC;AAaF,SAAS,QAAQ,CACf,kBAAiD,EACjD,eAAsF,EACtF,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,sBAAsB,CAC5C,kBAAkB,EAClB,eAAe,EACf,cAAc,CACf,CAAC;IAEF,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE,CAAC;QAC3C,IAAI,gBAAgB,CAAC,eAAe,CAAC,EAAE,CAAC;YACtC,OAAO,SAAS,CAAC,eAAe,CAAC,kBAAkB,EAAE,EAAE,EAAE,eAAe,CAAC,CAAC;QAC5E,CAAC;aAAM,CAAC;YACN,OAAO,SAAS,CAAC,eAAe,CAAC,kBAAkB,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,sBAAsB,CAC7B,kBAAiD,EACjD,eAAsF,EACtF,cAAkC;IAElC,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE,CAAC;QAC3C,IAAI,gBAAgB,CAAC,eAAe,CAAC,EAAE,CAAC;YACtC,OAAO,mBAAmB,CACxB;gBACE,MAAM;gBACN,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,MAAM;gBACZ,UAAU,EAAE;oBACV,UAAU,EAAE,kBAAkB;oBAC9B,GAAG,mBAAmB,CAAC;wBACrB,KAAK,EAAE;4BACL;gCACE,IAAI,EAAE,kBAAkB;gCACxB,OAAO,EAAE,QAAQ;6BAClB;yBACF;wBACD,KAAK,EAAE,UAAU;qBAClB,CAAC;iBACH;aACF,EACD,eAAe,CAChB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,mBAAmB,CACxB;gBACE,MAAM;gBACN,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,MAAM;gBACZ,UAAU,EAAE;oBACV,UAAU,EAAE,kBAAkB;oBAC9B,GAAG,iBAAiB,CAAC,eAA0C,EAAE,aAAa,CAAC;oBAC/E,GAAG,mBAAmB,CAAC;wBACrB,KAAK,EAAE;4BACL;gCACE,IAAI,EAAE,kBAAkB;gCACxB,OAAO,EAAE,QAAQ;6BAClB;yBACF;wBACD,KAAK,EAAE,UAAU;qBAClB,CAAC;iBACH;aACF,EACD,cAAc,CACf,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,mBAAmB,CACxB;QACE,MAAM;QACN,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,GAAG,iBAAiB,CAAC,kBAA6C,EAAE,aAAa,CAAC;SACnF;KACF,EACD,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,cAAc,CACrE,CAAC;AACJ,CAAC;AAWD,SAAS,WAAW,CAClB,KAAoB,EACpB,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,KAAK,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;YACnD,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;wBAClD,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;IAE5D,OAAO,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE;QAC1E,OAAO,2BAA2B,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC,CAA0C,CAAC;AAC9C,CAAC;AAED,KAAK,UAAU,2BAA2B,CAAC,GAAyB;IAClE,MAAM,WAAW,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;IAE/B,IAAI,GAAG,CAAC,mBAAmB,IAAI,GAAG,CAAC,kBAAkB,EAAE,CAAC;QACtD,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC1C,yBAAyB,CAAC,GAAG,CAAC,mBAAmB,EAAE,MAAM,CAAC;YAC1D,yBAAyB,CAAC,GAAG,CAAC,kBAAkB,EAAE,MAAM,CAAC;SAC1D,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC;QAC9B,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;IAC9B,CAAC;SAAM,IAAI,GAAG,CAAC,mBAAmB,EAAE,CAAC;QACnC,WAAW,CAAC,OAAO,GAAG,MAAM,yBAAyB,CAAC,GAAG,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACzF,CAAC;SAAM,IAAI,GAAG,CAAC,kBAAkB,EAAE,CAAC;QAClC,WAAW,CAAC,MAAM,GAAG,MAAM,yBAAyB,CAAC,GAAG,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IACvF,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,SAAS,CAChB,KAAa,EACb,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,KAAK;YACL,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,KAAK;wBACX,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,SAAS,CAChB,KAAa,EACb,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,KAAK;YACL,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,KAAK;wBACX,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,aAAa,CACpB,KAAa,EACb,IAA8B,EAC9B,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,KAAK;YACL,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,KAAK;wBACX,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC;AAC/D,CAAC;AAID,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAE9B,KAAK,UAAU,IAAI,CACjB,KAAoB,EACpB,OAAqC,EACrC,cAAkC;IAElC,IAAI,QAAQ,GAAG,CAAC,CAAC;IAEjB,OAAO,QAAQ,EAAE,GAAG,iBAAiB,EAAE,CAAC;QACtC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAEvD,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;YACpB,OAAO,GAAG,CAAC;QACb,CAAC;QAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC;IACvF,CAAC;IAED,MAAM,IAAI,KAAK,CACb,OACE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAC5C,2BAA2B,iBAAiB,WAAW,CACxD,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CACrB,KAAoB;IAEpB,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;IAE5D,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,OAAO,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC;AAED,SAAS,sBAAsB,CAC7B,GAAsB;IAEtB,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,OAAO,SAAS,CAAC,sBAAsB,CAAwB,GAAG,CAAC,CAAC;AACtE,CAAC"}

package/dist/browser/v3/schedules/api.d.ts

@@ -0,0 +1 @@
+export type { CreateScheduleOptions, ScheduledTaskPayload, ListScheduleOptions, UpdateScheduleOptions, } from "@trigger.dev/core/v3";

package/dist/browser/v3/schedules/api.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api.js.map

package/dist/browser/v3/schedules/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../../src/v3/schedules/api.ts"],"names":[],"mappings":""}

package/dist/browser/v3/schedules/index.d.ts

@@ -0,0 +1,87 @@
+import { ApiPromise, ApiRequestOptions, DeletedScheduleObject, InitOutput, OffsetLimitPagePromise, ScheduleObject } from "@trigger.dev/core/v3";
+import { Task, TaskOptions } from "../shared.js";
+import * as SchedulesAPI from "./api.js";
+export type ScheduleOptions<TIdentifier extends string, TOutput, TInitOutput extends InitOutput> = TaskOptions<TIdentifier, SchedulesAPI.ScheduledTaskPayload, TOutput, TInitOutput> & {
+    /** You can optionally specify a CRON schedule on your task. You can also dynamically add a schedule in the dashboard or using the SDK functions.
+     *
+     * 1. Pass a CRON pattern string
+     * ```ts
+     * "0 0 * * *"
+     * ```
+     *
+     * 2. Or an object with a pattern and an optional timezone (default is "UTC")
+     * ```ts
+     * {
+     *   pattern: "0 0 * * *",
+     *   timezone: "America/Los_Angeles"
+     * }
+     * ```
+     *
+     * @link https://trigger.dev/docs/v3/tasks-scheduled
+     */
+    cron?: string | {
+        pattern: string;
+        timezone?: string;
+    };
+};
+export declare function task<TIdentifier extends string, TOutput, TInitOutput extends InitOutput>(params: ScheduleOptions<TIdentifier, TOutput, TInitOutput>): Task<TIdentifier, SchedulesAPI.ScheduledTaskPayload, TOutput>;
+/**
+ * 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
+ */
+export declare function create(options: SchedulesAPI.CreateScheduleOptions, requestOptions?: ApiRequestOptions): ApiPromise<ScheduleObject>;
+/**
+ * Retrieves a schedule
+ * @param scheduleId - The ID of the schedule to retrieve
+ * @returns The retrieved schedule
+ */
+export declare function retrieve(scheduleId: string, requestOptions?: ApiRequestOptions): ApiPromise<ScheduleObject>;
+/**
+ * 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
+ */
+export declare function update(scheduleId: string, options: SchedulesAPI.UpdateScheduleOptions, requestOptions?: ApiRequestOptions): ApiPromise<ScheduleObject>;
+/**
+ * Deletes a schedule
+ * @param scheduleId - The ID of the schedule to delete
+ */
+export declare function del(scheduleId: string, requestOptions?: ApiRequestOptions): ApiPromise<DeletedScheduleObject>;
+/**
+ * Deactivates a schedule
+ * @param scheduleId - The ID of the schedule to deactivate
+ */
+export declare function deactivate(scheduleId: string, requestOptions?: ApiRequestOptions): ApiPromise<ScheduleObject>;
+/**
+ * Activates a schedule
+ * @param scheduleId - The ID of the schedule to activate
+ */
+export declare function activate(scheduleId: string, requestOptions?: ApiRequestOptions): ApiPromise<ScheduleObject>;
+/**
+ * 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
+ */
+export declare function list(options?: SchedulesAPI.ListScheduleOptions, requestOptions?: ApiRequestOptions): 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.
+ */
+export declare function timezones(options?: {
+    excludeUtc?: boolean;
+}): ApiPromise<{
+    timezones: string[];
+}>;

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

@@ -0,0 +1,215 @@
+import { TimezonesResult, accessoryAttributes, apiClientManager, mergeRequestOptions, taskCatalog, } from "@trigger.dev/core/v3";
+import { zodfetch } from "@trigger.dev/core/v3/zodfetch";
+import { createTask } from "../shared.js";
+import { tracer } from "../tracer.js";
+export function task(params) {
+    const task = 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";
+    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
+ */
+export function create(options, requestOptions) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "schedules.create()",
+        icon: "clock",
+        attributes: {
+            ...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
+ */
+export function retrieve(scheduleId, requestOptions) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "schedules.retrieve()",
+        icon: "clock",
+        attributes: {
+            scheduleId,
+            ...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
+ */
+export function update(scheduleId, options, requestOptions) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "schedules.update()",
+        icon: "clock",
+        attributes: {
+            scheduleId,
+            ...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
+ */
+export function del(scheduleId, requestOptions) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "schedules.delete()",
+        icon: "clock",
+        attributes: {
+            scheduleId,
+            ...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
+ */
+export function deactivate(scheduleId, requestOptions) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "schedules.deactivate()",
+        icon: "clock",
+        attributes: {
+            scheduleId,
+            ...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
+ */
+export function activate(scheduleId, requestOptions) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "schedules.activate()",
+        icon: "clock",
+        attributes: {
+            scheduleId,
+            ...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
+ */
+export function list(options, requestOptions) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const $requestOptions = mergeRequestOptions({
+        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.
+ */
+export function timezones(options) {
+    const baseUrl = apiClientManager.baseURL;
+    return zodfetch(TimezonesResult, `${baseUrl}/api/v1/timezones${options?.excludeUtc === true ? "?excludeUtc=true" : ""}`, {
+        method: "GET",
+        headers: {
+            "Content-Type": "application/json",
+        },
+    });
+}
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/v3/schedules/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,GACZ,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAqB,UAAU,EAAE,MAAM,cAAc,CAAC;AAE7D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAgCtC,MAAM,UAAU,IAAI,CAClB,MAA0D;IAE1D,MAAM,IAAI,GAAG,UAAU,CAAC,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,WAAW,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,MAAM,UAAU,MAAM,CACpB,OAA2C,EAC3C,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,GAAG,mBAAmB,CAAC;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,MAAM,UAAU,QAAQ,CACtB,UAAkB,EAClB,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,mBAAmB,CAAC;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,MAAM,UAAU,MAAM,CACpB,UAAkB,EAClB,OAA2C,EAC3C,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,mBAAmB,CAAC;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,MAAM,UAAU,GAAG,CACjB,UAAkB,EAClB,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,mBAAmB,CAAC;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,MAAM,UAAU,UAAU,CACxB,UAAkB,EAClB,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,wBAAwB;QAC9B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,mBAAmB,CAAC;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,MAAM,UAAU,QAAQ,CACtB,UAAkB,EAClB,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,mBAAmB,CAAC;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,MAAM,UAAU,IAAI,CAClB,OAA0C,EAC1C,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;KACd,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AAC3D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,OAAkC;IAC1D,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC;IAEzC,OAAO,QAAQ,CACb,eAAe,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/browser/v3/shared.d.ts

@@ -0,0 +1,90 @@
+import { SerializableJson } from "@trigger.dev/core";
+import { ApiRequestOptions, InitOutput, Queue, QueueOptions, SubtaskUnwrapError, TaskRunContext, TaskRunPromise } from "@trigger.dev/core/v3";
+import { PollOptions } from "./runs.js";
+import type { AnyRunHandle, AnyTask, BatchItem, BatchResult, BatchRunHandle, BatchRunHandleFromTypes, InferRunTypes, inferSchemaIn, RetrieveRunResult, RunHandle, RunHandleFromTypes, RunHandleOutput, RunHandlePayload, Task, TaskBatchOutputHandle, TaskIdentifier, TaskOptions, TaskOutput, TaskOutputHandle, TaskPayload, TaskRunOptions, TaskRunResult, TaskSchema, TaskWithSchemaOptions, TriggerApiRequestOptions } from "@trigger.dev/core/v3";
+export type { AnyRunHandle, AnyTask, BatchItem, BatchResult, BatchRunHandle, Queue, RunHandle, RunHandleOutput, RunHandlePayload, SerializableJson, Task, TaskBatchOutputHandle, TaskIdentifier, TaskOptions, TaskOutput, TaskOutputHandle, TaskPayload, TaskRunOptions, TaskRunResult, };
+export { SubtaskUnwrapError, TaskRunPromise };
+export type Context = TaskRunContext;
+export declare function queue(options: {
+    name: string;
+} & QueueOptions): Queue;
+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>;
+export declare function createSchemaTask<TIdentifier extends string, TSchema extends TaskSchema | undefined = undefined, TOutput = unknown, TInitOutput extends InitOutput = any>(params: TaskWithSchemaOptions<TIdentifier, TSchema, TOutput, TInitOutput>): Task<TIdentifier, inferSchemaIn<TSchema>, 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?: TriggerApiRequestOptions): Promise<RunHandleFromTypes<InferRunTypes<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): TaskRunPromise<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?: TriggerApiRequestOptions): Promise<RetrieveRunResult<TTask>>;
+export declare function batchTrigger<TTask extends AnyTask>(id: TaskIdentifier<TTask>, items: Array<BatchItem<TaskPayload<TTask>>>, requestOptions?: TriggerApiRequestOptions): Promise<BatchRunHandleFromTypes<InferRunTypes<TTask>>>;