@trigger.dev/sdk 0.0.0-prerelease-20241023140846 → 0.0.0-prerelease-20241119135607

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

@@ -1,215 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,90 +0,0 @@
-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>>>;