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

package/dist/commonjs/triggers/invokeTrigger.d.ts

@@ -0,0 +1,39 @@
+import { TriggerMetadata } from "@trigger.dev/core";
+import { TypeOf, ZodType, z } from "zod";
+import { Job } from "../job.js";
+import { TriggerClient } from "../triggerClient.js";
+import { EventSpecification, EventSpecificationExample, Trigger } from "../types.js";
+/** Configuration options for an InvokeTrigger */
+type InvokeTriggerOptions<TSchema extends ZodType = z.ZodTypeAny> = {
+    /** A [Zod](https://trigger.dev/docs/documentation/guides/zod) schema that defines the shape of the event payload.
+     * The default is `z.any()` which is `any`.
+     * */
+    schema?: TSchema;
+    examples?: EventSpecificationExample[];
+};
+export declare class InvokeTrigger<TSchema extends ZodType = z.ZodTypeAny> implements Trigger<EventSpecification<TypeOf<TSchema>, z.input<TSchema>>> {
+    #private;
+    constructor(options: InvokeTriggerOptions<TSchema>);
+    toJSON(): TriggerMetadata;
+    get event(): {
+        name: string;
+        title: string;
+        source: string;
+        examples: {
+            name: string;
+            id: string;
+            icon?: string | undefined;
+            payload?: any;
+        }[];
+        icon: string;
+        parsePayload: (rawPayload: unknown) => any;
+        parseInvokePayload: (rawPayload: unknown) => any;
+    };
+    attachToJob(triggerClient: TriggerClient, job: Job<Trigger<EventSpecification<ZodType<TSchema>>>, any>): void;
+    get preprocessRuns(): boolean;
+    verifyPayload(): Promise<{
+        success: true;
+    }>;
+}
+export declare function invokeTrigger<TSchema extends ZodType = z.ZodTypeAny>(options?: InvokeTriggerOptions<TSchema>): Trigger<EventSpecification<TypeOf<TSchema>, z.input<TSchema>>>;
+export {};

package/dist/commonjs/triggers/invokeTrigger.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvokeTrigger = void 0;
+exports.invokeTrigger = invokeTrigger;
+const errors_js_1 = require("../errors.js");
+const formatSchemaErrors_js_1 = require("../utils/formatSchemaErrors.js");
+class InvokeTrigger {
+    #options;
+    constructor(options) {
+        this.#options = options;
+    }
+    toJSON() {
+        return {
+            type: "invoke",
+        };
+    }
+    get event() {
+        return {
+            name: "invoke",
+            title: "Manual Invoke",
+            source: "trigger.dev",
+            examples: this.#options.examples ?? [],
+            icon: "trigger",
+            parsePayload: (rawPayload) => {
+                if (this.#options.schema) {
+                    const results = this.#options.schema.safeParse(rawPayload);
+                    if (!results.success) {
+                        throw new errors_js_1.ParsedPayloadSchemaError((0, formatSchemaErrors_js_1.formatSchemaErrors)(results.error.issues));
+                    }
+                    return results.data;
+                }
+                return rawPayload;
+            },
+            parseInvokePayload: (rawPayload) => {
+                if (this.#options.schema) {
+                    const results = this.#options.schema.safeParse(rawPayload);
+                    if (!results.success) {
+                        throw new errors_js_1.ParsedPayloadSchemaError((0, formatSchemaErrors_js_1.formatSchemaErrors)(results.error.issues));
+                    }
+                    return results.data;
+                }
+                return rawPayload;
+            },
+        };
+    }
+    attachToJob(triggerClient, job) { }
+    get preprocessRuns() {
+        return false;
+    }
+    async verifyPayload() {
+        return { success: true };
+    }
+}
+exports.InvokeTrigger = InvokeTrigger;
+function invokeTrigger(options) {
+    return new InvokeTrigger(options ?? {});
+}
+//# sourceMappingURL=invokeTrigger.js.map

package/dist/commonjs/triggers/invokeTrigger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invokeTrigger.js","sourceRoot":"","sources":["../../../src/triggers/invokeTrigger.ts"],"names":[],"mappings":";;;AAkFA,sCAIC;AApFD,4CAAwD;AAIxD,0EAAoE;AAWpE,MAAa,aAAa;IAGxB,QAAQ,CAAgC;IAExC,YAAY,OAAsC;QAChD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,QAAQ;SACf,CAAC;IACJ,CAAC;IAED,IAAI,KAAK;QACP,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,eAAe;YACtB,MAAM,EAAE,aAAa;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE;YACtC,IAAI,EAAE,SAAS;YACf,YAAY,EAAE,CAAC,UAAmB,EAAE,EAAE;gBACpC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACzB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;oBAE3D,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;wBACrB,MAAM,IAAI,oCAAwB,CAAC,IAAA,0CAAkB,EAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;oBAC/E,CAAC;oBAED,OAAO,OAAO,CAAC,IAAI,CAAC;gBACtB,CAAC;gBAED,OAAO,UAAiB,CAAC;YAC3B,CAAC;YACD,kBAAkB,EAAE,CAAC,UAAmB,EAAE,EAAE;gBAC1C,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACzB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;oBAE3D,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;wBACrB,MAAM,IAAI,oCAAwB,CAAC,IAAA,0CAAkB,EAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;oBAC/E,CAAC;oBAED,OAAO,OAAO,CAAC,IAAI,CAAC;gBACtB,CAAC;gBAED,OAAO,UAAiB,CAAC;YAC3B,CAAC;SACF,CAAC;IACJ,CAAC;IAED,WAAW,CACT,aAA4B,EAC5B,GAA4D,IACrD,CAAC;IAEV,IAAI,cAAc;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,OAAO,EAAE,OAAO,EAAE,IAAa,EAAE,CAAC;IACpC,CAAC;CACF;AA/DD,sCA+DC;AAED,SAAgB,aAAa,CAC3B,OAAuC;IAEvC,OAAO,IAAI,aAAa,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;AAC1C,CAAC"}

package/dist/commonjs/triggers/notifications.d.ts

@@ -0,0 +1,111 @@
+import { MissingConnectionNotificationPayload, MissingConnectionResolvedNotificationPayload, TriggerMetadata } from "@trigger.dev/core";
+import { TriggerIntegration } from "../integrations.js";
+import { Job } from "../job.js";
+import { TriggerClient } from "../triggerClient.js";
+import { EventSpecification, Trigger } from "../types.js";
+export declare function missingConnectionNotification(integrations: Array<TriggerIntegration>): MissingConnectionNotification;
+export declare function missingConnectionResolvedNotification(integrations: Array<TriggerIntegration>): MissingConnectionResolvedNotification;
+type MissingConnectionNotificationSpecification = EventSpecification<MissingConnectionNotificationPayload>;
+type MissingConnectionNotificationOptions = {
+    integrations: Array<TriggerIntegration>;
+};
+export declare class MissingConnectionNotification implements Trigger<MissingConnectionNotificationSpecification> {
+    private options;
+    constructor(options: MissingConnectionNotificationOptions);
+    get event(): {
+        name: string;
+        title: string;
+        source: string;
+        icon: string;
+        parsePayload: (data: unknown, params?: Partial<import("zod").ParseParams>) => {
+            type: "DEVELOPER";
+            id: string;
+            client: {
+                scopes: string[];
+                id: string;
+                title: string;
+                updatedAt: Date;
+                createdAt: Date;
+            };
+            authorizationUrl: string;
+        } | {
+            type: "EXTERNAL";
+            id: string;
+            account: {
+                id: string;
+                metadata?: any;
+            };
+            client: {
+                scopes: string[];
+                id: string;
+                title: string;
+                updatedAt: Date;
+                createdAt: Date;
+            };
+            authorizationUrl: string;
+        };
+        properties: {
+            label: string;
+            text: string;
+        }[];
+    };
+    attachToJob(triggerClient: TriggerClient, job: Job<Trigger<MissingConnectionNotificationSpecification>, any>): void;
+    get preprocessRuns(): boolean;
+    verifyPayload(payload: ReturnType<MissingConnectionNotificationSpecification["parsePayload"]>): Promise<{
+        success: true;
+    }>;
+    toJSON(): TriggerMetadata;
+}
+type MissingConnectionResolvedNotificationSpecification = EventSpecification<MissingConnectionResolvedNotificationPayload>;
+export declare class MissingConnectionResolvedNotification implements Trigger<MissingConnectionResolvedNotificationSpecification> {
+    private options;
+    constructor(options: MissingConnectionNotificationOptions);
+    get event(): {
+        name: string;
+        title: string;
+        source: string;
+        icon: string;
+        parsePayload: (data: unknown, params?: Partial<import("zod").ParseParams>) => {
+            type: "DEVELOPER";
+            id: string;
+            client: {
+                scopes: string[];
+                id: string;
+                title: string;
+                updatedAt: Date;
+                createdAt: Date;
+                integrationIdentifier: string;
+                integrationAuthMethod: string;
+            };
+            expiresAt: Date;
+        } | {
+            type: "EXTERNAL";
+            id: string;
+            account: {
+                id: string;
+                metadata?: any;
+            };
+            client: {
+                scopes: string[];
+                id: string;
+                title: string;
+                updatedAt: Date;
+                createdAt: Date;
+                integrationIdentifier: string;
+                integrationAuthMethod: string;
+            };
+            expiresAt: Date;
+        };
+        properties: {
+            label: string;
+            text: string;
+        }[];
+    };
+    attachToJob(triggerClient: TriggerClient, job: Job<Trigger<MissingConnectionResolvedNotificationSpecification>, any>): void;
+    get preprocessRuns(): boolean;
+    verifyPayload(payload: ReturnType<MissingConnectionResolvedNotificationSpecification["parsePayload"]>): Promise<{
+        success: true;
+    }>;
+    toJSON(): TriggerMetadata;
+}
+export {};

package/dist/commonjs/triggers/notifications.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MissingConnectionResolvedNotification = exports.MissingConnectionNotification = void 0;
+exports.missingConnectionNotification = missingConnectionNotification;
+exports.missingConnectionResolvedNotification = missingConnectionResolvedNotification;
+const core_1 = require("@trigger.dev/core");
+function missingConnectionNotification(integrations) {
+    return new MissingConnectionNotification({ integrations });
+}
+function missingConnectionResolvedNotification(integrations) {
+    return new MissingConnectionResolvedNotification({ integrations });
+}
+class MissingConnectionNotification {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    get event() {
+        return {
+            name: core_1.MISSING_CONNECTION_NOTIFICATION,
+            title: "Missing Connection Notification",
+            source: "trigger.dev",
+            icon: "connection-alert",
+            parsePayload: core_1.MissingConnectionNotificationPayloadSchema.parse,
+            properties: [
+                {
+                    label: "Integrations",
+                    text: this.options.integrations.map((i) => i.id).join(", "),
+                },
+            ],
+        };
+    }
+    attachToJob(triggerClient, job) { }
+    get preprocessRuns() {
+        return false;
+    }
+    async verifyPayload(payload) {
+        return { success: true };
+    }
+    toJSON() {
+        return {
+            type: "static",
+            title: this.event.title,
+            rule: {
+                event: this.event.name,
+                source: "trigger.dev",
+                payload: {
+                    client: {
+                        id: this.options.integrations.map((i) => i.id),
+                    },
+                },
+            },
+        };
+    }
+}
+exports.MissingConnectionNotification = MissingConnectionNotification;
+class MissingConnectionResolvedNotification {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    get event() {
+        return {
+            name: core_1.MISSING_CONNECTION_RESOLVED_NOTIFICATION,
+            title: "Missing Connection Resolved Notification",
+            source: "trigger.dev",
+            icon: "connection-alert",
+            parsePayload: core_1.MissingConnectionResolvedNotificationPayloadSchema.parse,
+            properties: [
+                {
+                    label: "Integrations",
+                    text: this.options.integrations.map((i) => i.id).join(", "),
+                },
+            ],
+        };
+    }
+    attachToJob(triggerClient, job) { }
+    get preprocessRuns() {
+        return false;
+    }
+    async verifyPayload(payload) {
+        return { success: true };
+    }
+    toJSON() {
+        return {
+            type: "static",
+            title: this.event.title,
+            rule: {
+                event: this.event.name,
+                source: "trigger.dev",
+                payload: {
+                    client: {
+                        id: this.options.integrations.map((i) => i.id),
+                    },
+                },
+            },
+        };
+    }
+}
+exports.MissingConnectionResolvedNotification = MissingConnectionResolvedNotification;
+//# sourceMappingURL=notifications.js.map

package/dist/commonjs/triggers/notifications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../../../src/triggers/notifications.ts"],"names":[],"mappings":";;;AAcA,sEAEC;AAED,sFAEC;AApBD,4CAQ2B;AAM3B,SAAgB,6BAA6B,CAAC,YAAuC;IACnF,OAAO,IAAI,6BAA6B,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;AAC7D,CAAC;AAED,SAAgB,qCAAqC,CAAC,YAAuC;IAC3F,OAAO,IAAI,qCAAqC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;AACrE,CAAC;AASD,MAAa,6BAA6B;IAGpB;IAApB,YAAoB,OAA6C;QAA7C,YAAO,GAAP,OAAO,CAAsC;IAAG,CAAC;IAErE,IAAI,KAAK;QACP,OAAO;YACL,IAAI,EAAE,sCAA+B;YACrC,KAAK,EAAE,iCAAiC;YACxC,MAAM,EAAE,aAAa;YACrB,IAAI,EAAE,kBAAkB;YACxB,YAAY,EAAE,iDAA0C,CAAC,KAAK;YAC9D,UAAU,EAAE;gBACV;oBACE,KAAK,EAAE,cAAc;oBACrB,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC5D;aACF;SACF,CAAC;IACJ,CAAC;IAED,WAAW,CACT,aAA4B,EAC5B,GAAkE,IAC3D,CAAC;IAEV,IAAI,cAAc;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,OAA+E;QAE/E,OAAO,EAAE,OAAO,EAAE,IAAa,EAAE,CAAC;IACpC,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;YACvB,IAAI,EAAE;gBACJ,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;gBACtB,MAAM,EAAE,aAAa;gBACrB,OAAO,EAAE;oBACP,MAAM,EAAE;wBACN,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;qBAC/C;iBACF;aACF;SACF,CAAC;IACJ,CAAC;CACF;AAnDD,sEAmDC;AAKD,MAAa,qCAAqC;IAG5B;IAApB,YAAoB,OAA6C;QAA7C,YAAO,GAAP,OAAO,CAAsC;IAAG,CAAC;IAErE,IAAI,KAAK;QACP,OAAO;YACL,IAAI,EAAE,+CAAwC;YAC9C,KAAK,EAAE,0CAA0C;YACjD,MAAM,EAAE,aAAa;YACrB,IAAI,EAAE,kBAAkB;YACxB,YAAY,EAAE,yDAAkD,CAAC,KAAK;YACtE,UAAU,EAAE;gBACV;oBACE,KAAK,EAAE,cAAc;oBACrB,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC5D;aACF;SACF,CAAC;IACJ,CAAC;IAED,WAAW,CACT,aAA4B,EAC5B,GAA0E,IACnE,CAAC;IAEV,IAAI,cAAc;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,OAAuF;QAEvF,OAAO,EAAE,OAAO,EAAE,IAAa,EAAE,CAAC;IACpC,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;YACvB,IAAI,EAAE;gBACJ,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;gBACtB,MAAM,EAAE,aAAa;gBACrB,OAAO,EAAE;oBACP,MAAM,EAAE;wBACN,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;qBAC/C;iBACF;aACF;SACF,CAAC;IACJ,CAAC;CACF;AAnDD,sFAmDC"}

package/dist/commonjs/triggers/scheduled.d.ts

@@ -0,0 +1,145 @@
+import { CronOptions, IntervalOptions, ScheduleMetadata, ScheduledPayload, TriggerMetadata } from "@trigger.dev/core";
+import { Job } from "../job.js";
+import { TriggerClient } from "../triggerClient.js";
+import { EventSpecification, Trigger } from "../types.js";
+type ScheduledEventSpecification = EventSpecification<ScheduledPayload>;
+export declare class IntervalTrigger implements Trigger<ScheduledEventSpecification> {
+    private options;
+    constructor(options: IntervalOptions);
+    get event(): {
+        name: string;
+        title: string;
+        source: string;
+        icon: string;
+        examples: {
+            id: string;
+            name: string;
+            icon: string;
+            payload: {
+                ts: string;
+                lastTimestamp: string;
+            };
+        }[];
+        parsePayload: (data: unknown, params?: Partial<import("zod").ParseParams>) => {
+            ts: Date;
+            lastTimestamp?: Date | undefined;
+        };
+        properties: {
+            label: string;
+            text: string;
+        }[];
+    };
+    attachToJob(triggerClient: TriggerClient, job: Job<Trigger<ScheduledEventSpecification>, any>): void;
+    get preprocessRuns(): boolean;
+    verifyPayload(payload: ReturnType<ScheduledEventSpecification["parsePayload"]>): Promise<{
+        success: true;
+    }>;
+    toJSON(): TriggerMetadata;
+}
+/** `intervalTrigger()` is set as a [Job's trigger](/sdk/job) to trigger a Job at a recurring interval.
+ * @param options An object containing options about the interval.
+ */
+export declare function intervalTrigger(options: IntervalOptions): IntervalTrigger;
+export declare class CronTrigger implements Trigger<ScheduledEventSpecification> {
+    private options;
+    constructor(options: CronOptions);
+    get event(): {
+        name: string;
+        title: string;
+        source: string;
+        icon: string;
+        examples: {
+            id: string;
+            name: string;
+            icon: string;
+            payload: {
+                ts: string;
+                lastTimestamp: string;
+            };
+        }[];
+        parsePayload: (data: unknown, params?: Partial<import("zod").ParseParams>) => {
+            ts: Date;
+            lastTimestamp?: Date | undefined;
+        };
+        properties: {
+            label: string;
+            text: string;
+        }[];
+    };
+    attachToJob(triggerClient: TriggerClient, job: Job<Trigger<ScheduledEventSpecification>, any>): void;
+    get preprocessRuns(): boolean;
+    verifyPayload(payload: ReturnType<ScheduledEventSpecification["parsePayload"]>): Promise<{
+        success: true;
+    }>;
+    toJSON(): TriggerMetadata;
+}
+/** `cronTrigger()` is set as a [Job's trigger](https://trigger.dev/docs/sdk/job) to trigger a Job on a recurring schedule using a CRON expression.
+ * @param options An object containing options about the CRON schedule.
+ */
+export declare function cronTrigger(options: CronOptions): CronTrigger;
+/** DynamicSchedule options
+ * @param id Used to uniquely identify a DynamicSchedule
+ */
+export type DynamicIntervalOptions = {
+    id: string;
+};
+/** DynamicSchedule` allows you to define a scheduled trigger that can be configured dynamically at runtime. */
+export declare class DynamicSchedule implements Trigger<ScheduledEventSpecification> {
+    private client;
+    private options;
+    /**
+     * @param client The `TriggerClient` instance to use for registering the trigger.
+     * @param options The options for the schedule.
+     */
+    constructor(client: TriggerClient, options: DynamicIntervalOptions);
+    get id(): string;
+    get event(): {
+        name: string;
+        title: string;
+        source: string;
+        icon: string;
+        examples: {
+            id: string;
+            name: string;
+            icon: string;
+            payload: {
+                ts: string;
+                lastTimestamp: string;
+            };
+        }[];
+        parsePayload: (data: unknown, params?: Partial<import("zod").ParseParams>) => {
+            ts: Date;
+            lastTimestamp?: Date | undefined;
+        };
+    };
+    register(key: string, metadata: ScheduleMetadata): Promise<{
+        id: string;
+        schedule: {
+            options: {
+                cron: string;
+            };
+            type: "cron";
+            accountId?: string | undefined;
+            metadata?: any;
+        } | {
+            options: {
+                seconds: number;
+            };
+            type: "interval";
+            accountId?: string | undefined;
+            metadata?: any;
+        };
+        active: boolean;
+        metadata?: any;
+    }>;
+    unregister(key: string): Promise<{
+        ok: boolean;
+    }>;
+    attachToJob(triggerClient: TriggerClient, job: Job<Trigger<ScheduledEventSpecification>, any>): void;
+    get preprocessRuns(): boolean;
+    verifyPayload(payload: ReturnType<ScheduledEventSpecification["parsePayload"]>): Promise<{
+        success: true;
+    }>;
+    toJSON(): TriggerMetadata;
+}
+export {};

package/dist/commonjs/triggers/scheduled.js

@@ -0,0 +1,208 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamicSchedule = exports.CronTrigger = exports.IntervalTrigger = void 0;
+exports.intervalTrigger = intervalTrigger;
+exports.cronTrigger = cronTrigger;
+const core_1 = require("@trigger.dev/core");
+const cronstrue_1 = __importDefault(require("cronstrue"));
+const runLocalStorage_js_1 = require("../runLocalStorage.js");
+const examples = [
+    {
+        id: "now",
+        name: "Now",
+        icon: "clock",
+        payload: {
+            ts: core_1.currentDate.marker,
+            lastTimestamp: core_1.currentDate.marker,
+        },
+    },
+];
+class IntervalTrigger {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    get event() {
+        return {
+            name: "trigger.scheduled",
+            title: "Schedule",
+            source: "trigger.dev",
+            icon: "schedule-interval",
+            examples,
+            parsePayload: core_1.ScheduledPayloadSchema.parse,
+            properties: [
+                {
+                    label: "Interval",
+                    text: `${this.options.seconds}s`,
+                },
+            ],
+        };
+    }
+    attachToJob(triggerClient, job) { }
+    get preprocessRuns() {
+        return false;
+    }
+    async verifyPayload(payload) {
+        return { success: true };
+    }
+    toJSON() {
+        return {
+            type: "scheduled",
+            schedule: {
+                type: "interval",
+                options: {
+                    seconds: this.options.seconds,
+                },
+            },
+        };
+    }
+}
+exports.IntervalTrigger = IntervalTrigger;
+/** `intervalTrigger()` is set as a [Job's trigger](/sdk/job) to trigger a Job at a recurring interval.
+ * @param options An object containing options about the interval.
+ */
+function intervalTrigger(options) {
+    return new IntervalTrigger(options);
+}
+class CronTrigger {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    get event() {
+        /**
+         * We need to concat `(UTC)` string at the end of the human readable string to avoid confusion
+         * with execution time/last run of a job in the UI dashboard which is displayed in local time.
+         */
+        const humanReadable = cronstrue_1.default
+            .toString(this.options.cron, {
+            throwExceptionOnParseError: false,
+        })
+            .concat(" (UTC)");
+        return {
+            name: "trigger.scheduled",
+            title: "Cron Schedule",
+            source: "trigger.dev",
+            icon: "schedule-cron",
+            examples,
+            parsePayload: core_1.ScheduledPayloadSchema.parse,
+            properties: [
+                {
+                    label: "cron",
+                    text: this.options.cron,
+                },
+                {
+                    label: "Schedule",
+                    text: humanReadable,
+                },
+            ],
+        };
+    }
+    attachToJob(triggerClient, job) { }
+    get preprocessRuns() {
+        return false;
+    }
+    async verifyPayload(payload) {
+        return { success: true };
+    }
+    toJSON() {
+        return {
+            type: "scheduled",
+            schedule: {
+                type: "cron",
+                options: {
+                    cron: this.options.cron,
+                },
+            },
+        };
+    }
+}
+exports.CronTrigger = CronTrigger;
+/** `cronTrigger()` is set as a [Job's trigger](https://trigger.dev/docs/sdk/job) to trigger a Job on a recurring schedule using a CRON expression.
+ * @param options An object containing options about the CRON schedule.
+ */
+function cronTrigger(options) {
+    return new CronTrigger(options);
+}
+/** DynamicSchedule` allows you to define a scheduled trigger that can be configured dynamically at runtime. */
+class DynamicSchedule {
+    client;
+    options;
+    /**
+     * @param client The `TriggerClient` instance to use for registering the trigger.
+     * @param options The options for the schedule.
+     */
+    constructor(client, options) {
+        this.client = client;
+        this.options = options;
+        client.attachDynamicSchedule(this.options.id);
+    }
+    get id() {
+        return this.options.id;
+    }
+    get event() {
+        return {
+            name: "trigger.scheduled",
+            title: "Dynamic Schedule",
+            source: "trigger.dev",
+            icon: "schedule-dynamic",
+            examples,
+            parsePayload: core_1.ScheduledPayloadSchema.parse,
+        };
+    }
+    async register(key, metadata) {
+        const runStore = runLocalStorage_js_1.runLocalStorage.getStore();
+        if (!runStore) {
+            return this.client.registerSchedule(this.id, key, metadata);
+        }
+        const { io } = runStore;
+        return await io.runTask([key, "register"], async (task) => {
+            return this.client.registerSchedule(this.id, key, metadata);
+        }, {
+            name: "Register Schedule",
+            icon: metadata.type === "cron" ? "schedule-cron" : "schedule-interval",
+            properties: [
+                { label: "Dynamic Schedule", text: this.id },
+                { label: "Schedule ID", text: key },
+            ],
+            params: metadata,
+        });
+    }
+    async unregister(key) {
+        const runStore = runLocalStorage_js_1.runLocalStorage.getStore();
+        if (!runStore) {
+            return this.client.unregisterSchedule(this.id, key);
+        }
+        const { io } = runStore;
+        return await io.runTask([key, "unregister"], async (task) => {
+            return this.client.unregisterSchedule(this.id, key);
+        }, {
+            name: "Unregister Schedule",
+            icon: "schedule",
+            properties: [
+                { label: "Dynamic Schedule", text: this.id },
+                { label: "Schedule ID", text: key },
+            ],
+        });
+    }
+    attachToJob(triggerClient, job) {
+        triggerClient.attachDynamicScheduleToJob(this.options.id, job);
+    }
+    get preprocessRuns() {
+        return false;
+    }
+    async verifyPayload(payload) {
+        return { success: true };
+    }
+    toJSON() {
+        return {
+            type: "dynamic",
+            id: this.options.id,
+        };
+    }
+}
+exports.DynamicSchedule = DynamicSchedule;
+//# sourceMappingURL=scheduled.js.map

package/dist/commonjs/triggers/scheduled.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduled.js","sourceRoot":"","sources":["../../../src/triggers/scheduled.ts"],"names":[],"mappings":";;;;;;AA8EA,0CAEC;AAiED,kCAEC;AAnJD,4CAQ2B;AAI3B,0DAAkC;AAClC,8DAAwD;AAIxD,MAAM,QAAQ,GAAG;IACf;QACE,EAAE,EAAE,KAAK;QACT,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,OAAO;QACb,OAAO,EAAE;YACP,EAAE,EAAE,kBAAW,CAAC,MAAM;YACtB,aAAa,EAAE,kBAAW,CAAC,MAAM;SAClC;KACF;CACF,CAAC;AAEF,MAAa,eAAe;IACN;IAApB,YAAoB,OAAwB;QAAxB,YAAO,GAAP,OAAO,CAAiB;IAAG,CAAC;IAEhD,IAAI,KAAK;QACP,OAAO;YACL,IAAI,EAAE,mBAAmB;YACzB,KAAK,EAAE,UAAU;YACjB,MAAM,EAAE,aAAa;YACrB,IAAI,EAAE,mBAAmB;YACzB,QAAQ;YACR,YAAY,EAAE,6BAAsB,CAAC,KAAK;YAC1C,UAAU,EAAE;gBACV;oBACE,KAAK,EAAE,UAAU;oBACjB,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG;iBACjC;aACF;SACF,CAAC;IACJ,CAAC;IAED,WAAW,CACT,aAA4B,EAC5B,GAAmD,IAC5C,CAAC;IAEV,IAAI,cAAc;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAgE;QAClF,OAAO,EAAE,OAAO,EAAE,IAAa,EAAE,CAAC;IACpC,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE;gBACR,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE;oBACP,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;iBAC9B;aACF;SACF,CAAC;IACJ,CAAC;CACF;AA5CD,0CA4CC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,OAAwB;IACtD,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;AACtC,CAAC;AAED,MAAa,WAAW;IACF;IAApB,YAAoB,OAAoB;QAApB,YAAO,GAAP,OAAO,CAAa;IAAG,CAAC;IAE5C,IAAI,KAAK;QACP;;;WAGG;QACH,MAAM,aAAa,GAAG,mBAAS;aAC5B,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;YAC3B,0BAA0B,EAAE,KAAK;SAClC,CAAC;aACD,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEpB,OAAO;YACL,IAAI,EAAE,mBAAmB;YACzB,KAAK,EAAE,eAAe;YACtB,MAAM,EAAE,aAAa;YACrB,IAAI,EAAE,eAAe;YACrB,QAAQ;YACR,YAAY,EAAE,6BAAsB,CAAC,KAAK;YAC1C,UAAU,EAAE;gBACV;oBACE,KAAK,EAAE,MAAM;oBACb,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;iBACxB;gBACD;oBACE,KAAK,EAAE,UAAU;oBACjB,IAAI,EAAE,aAAa;iBACpB;aACF;SACF,CAAC;IACJ,CAAC;IAED,WAAW,CACT,aAA4B,EAC5B,GAAmD,IAC5C,CAAC;IAEV,IAAI,cAAc;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAgE;QAClF,OAAO,EAAE,OAAO,EAAE,IAAa,EAAE,CAAC;IACpC,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE;gBACR,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE;oBACP,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;iBACxB;aACF;SACF,CAAC;IACJ,CAAC;CACF;AA1DD,kCA0DC;AAED;;GAEG;AACH,SAAgB,WAAW,CAAC,OAAoB;IAC9C,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAOD,+GAA+G;AAC/G,MAAa,eAAe;IAMhB;IACA;IANV;;;OAGG;IACH,YACU,MAAqB,EACrB,OAA+B;QAD/B,WAAM,GAAN,MAAM,CAAe;QACrB,YAAO,GAAP,OAAO,CAAwB;QAEvC,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,KAAK;QACP,OAAO;YACL,IAAI,EAAE,mBAAmB;YACzB,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE,aAAa;YACrB,IAAI,EAAE,kBAAkB;YACxB,QAAQ;YACR,YAAY,EAAE,6BAAsB,CAAC,KAAK;SAC3C,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAW,EAAE,QAA0B;QACpD,MAAM,QAAQ,GAAG,oCAAe,CAAC,QAAQ,EAAE,CAAC;QAE5C,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,EAAE,EAAE,EAAE,GAAG,QAAQ,CAAC;QAExB,OAAO,MAAM,EAAE,CAAC,OAAO,CACrB,CAAC,GAAG,EAAE,UAAU,CAAC,EACjB,KAAK,EAAE,IAAI,EAAE,EAAE;YACb,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC9D,CAAC,EACD;YACE,IAAI,EAAE,mBAAmB;YACzB,IAAI,EAAE,QAAQ,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,mBAAmB;YACtE,UAAU,EAAE;gBACV,EAAE,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;gBAC5C,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,GAAG,EAAE;aACpC;YACD,MAAM,EAAE,QAAQ;SACjB,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAW;QAC1B,MAAM,QAAQ,GAAG,oCAAe,CAAC,QAAQ,EAAE,CAAC;QAE5C,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,EAAE,EAAE,EAAE,GAAG,QAAQ,CAAC;QAExB,OAAO,MAAM,EAAE,CAAC,OAAO,CACrB,CAAC,GAAG,EAAE,YAAY,CAAC,EACnB,KAAK,EAAE,IAAI,EAAE,EAAE;YACb,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACtD,CAAC,EACD;YACE,IAAI,EAAE,qBAAqB;YAC3B,IAAI,EAAE,UAAU;YAChB,UAAU,EAAE;gBACV,EAAE,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;gBAC5C,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,GAAG,EAAE;aACpC;SACF,CACF,CAAC;IACJ,CAAC;IAED,WAAW,CACT,aAA4B,EAC5B,GAAmD;QAEnD,aAAa,CAAC,0BAA0B,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAgE;QAClF,OAAO,EAAE,OAAO,EAAE,IAAa,EAAE,CAAC;IACpC,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,SAAS;YACf,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE;SACpB,CAAC;IACJ,CAAC;CACF;AAnGD,0CAmGC"}