@trigger.dev/sdk 3.0.0-beta.6 → 3.0.0

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"}