@trigger.dev/sdk 4.7.3 → 4.7.5

package/dist/esm/v3/query.d.ts

@@ -1,5 +1,6 @@
-import type { ApiRequestOptions, Prettify } from "@trigger.dev/core/v3";
+import type { AddDashboardWidgetRequestBody, ApiRequestOptions, CreateDashboardRequestBody, Prettify, ReplaceDashboardRequestBody, UpdateDashboardRequestBody, UpdateDashboardWidgetRequestBody } from "@trigger.dev/core/v3";
 export type { QueryTable, RunsTableRow, RunFriendlyStatus } from "@trigger.dev/core/v3";
+export type { DashboardObject, DashboardSummary, DashboardWidget, DashboardWidgetDisplay, DashboardWidgetInput, DashboardWidgetPosition, } from "@trigger.dev/core/v3";
 export type QueryScope = "environment" | "project" | "organization";
 export type QueryFormat = "json" | "csv";
 /**
@@ -107,6 +108,438 @@ declare function execute<TRow extends Record<string, any> = Record<string, any>>
     format: "json";
     results: Array<Prettify<TRow>>;
 }>;
+/**
+ * Lists the built-in dashboards and your organization's custom dashboards, with their widgets.
+ */
+declare function listDashboards(requestOptions?: ApiRequestOptions): Promise<{
+    dashboards: {
+        key: string;
+        title: string;
+        type?: "builtIn" | "custom" | undefined;
+        description?: string | undefined;
+        widgets: {
+            id: string;
+            title: string;
+            query: string;
+            type: "bignumber" | "chart" | "table" | "title";
+        }[];
+    }[];
+}>;
+/**
+ * Retrieves a custom dashboard, including every widget, its query and its grid position.
+ */
+declare function retrieveDashboard(dashboardId: string, requestOptions?: ApiRequestOptions): import("@trigger.dev/core/v3").ApiPromise<{
+    id: string;
+    title: string;
+    description: string;
+    revision: string;
+    createdAt: Date;
+    updatedAt: Date;
+    widgets: {
+        id: string;
+        title: string;
+        query: string;
+        display: {
+            type: "table";
+            prettyFormatting: boolean;
+            sorting: {
+                desc: boolean;
+                id: string;
+            }[];
+        } | {
+            chartType: "bar" | "line";
+            xAxisColumn: string | null;
+            yAxisColumns: string[];
+            groupByColumn: string | null;
+            stacked: boolean;
+            sortByColumn: string | null;
+            sortDirection: "asc" | "desc";
+            aggregation: "avg" | "count" | "max" | "min" | "sum";
+            seriesColors?: Record<string, string> | undefined;
+            type: "chart";
+        } | {
+            column: string;
+            aggregation: "avg" | "count" | "first" | "last" | "max" | "min" | "sum";
+            sortDirection?: "asc" | "desc" | undefined;
+            abbreviate: boolean;
+            prefix?: string | undefined;
+            suffix?: string | undefined;
+            type: "bignumber";
+        } | {
+            type: "title";
+        };
+        fillGaps?: boolean | undefined;
+        position: {
+            x: number;
+            y: number;
+            w: number;
+            h: number;
+        };
+    }[];
+}>;
+/**
+ * Creates a custom dashboard, optionally with its widgets.
+ *
+ * @example
+ * ```ts
+ * const dashboard = await query.dashboards.create({
+ *   title: "Email tasks",
+ *   widgets: [
+ *     {
+ *       title: "Runs per day",
+ *       query: "SELECT timeBucket(), count() AS runs FROM runs GROUP BY timeBucket ORDER BY timeBucket",
+ *       display: {
+ *         type: "chart",
+ *         chartType: "bar",
+ *         xAxisColumn: "timebucket",
+ *         yAxisColumns: ["runs"],
+ *         groupByColumn: null,
+ *         stacked: false,
+ *         sortByColumn: null,
+ *         sortDirection: "asc",
+ *         aggregation: "sum",
+ *       },
+ *     },
+ *   ],
+ * });
+ * ```
+ */
+declare function createDashboard(body: CreateDashboardRequestBody, requestOptions?: ApiRequestOptions): import("@trigger.dev/core/v3").ApiPromise<{
+    id: string;
+    title: string;
+    description: string;
+    revision: string;
+    createdAt: Date;
+    updatedAt: Date;
+    widgets: {
+        id: string;
+        title: string;
+        query: string;
+        display: {
+            type: "table";
+            prettyFormatting: boolean;
+            sorting: {
+                desc: boolean;
+                id: string;
+            }[];
+        } | {
+            chartType: "bar" | "line";
+            xAxisColumn: string | null;
+            yAxisColumns: string[];
+            groupByColumn: string | null;
+            stacked: boolean;
+            sortByColumn: string | null;
+            sortDirection: "asc" | "desc";
+            aggregation: "avg" | "count" | "max" | "min" | "sum";
+            seriesColors?: Record<string, string> | undefined;
+            type: "chart";
+        } | {
+            column: string;
+            aggregation: "avg" | "count" | "first" | "last" | "max" | "min" | "sum";
+            sortDirection?: "asc" | "desc" | undefined;
+            abbreviate: boolean;
+            prefix?: string | undefined;
+            suffix?: string | undefined;
+            type: "bignumber";
+        } | {
+            type: "title";
+        };
+        fillGaps?: boolean | undefined;
+        position: {
+            x: number;
+            y: number;
+            w: number;
+            h: number;
+        };
+    }[];
+}>;
+/**
+ * Renames a custom dashboard or changes its description.
+ */
+declare function updateDashboard(dashboardId: string, body: UpdateDashboardRequestBody, requestOptions?: ApiRequestOptions): import("@trigger.dev/core/v3").ApiPromise<{
+    id: string;
+    title: string;
+    description: string;
+    revision: string;
+    createdAt: Date;
+    updatedAt: Date;
+    widgets: {
+        id: string;
+        title: string;
+        query: string;
+        display: {
+            type: "table";
+            prettyFormatting: boolean;
+            sorting: {
+                desc: boolean;
+                id: string;
+            }[];
+        } | {
+            chartType: "bar" | "line";
+            xAxisColumn: string | null;
+            yAxisColumns: string[];
+            groupByColumn: string | null;
+            stacked: boolean;
+            sortByColumn: string | null;
+            sortDirection: "asc" | "desc";
+            aggregation: "avg" | "count" | "max" | "min" | "sum";
+            seriesColors?: Record<string, string> | undefined;
+            type: "chart";
+        } | {
+            column: string;
+            aggregation: "avg" | "count" | "first" | "last" | "max" | "min" | "sum";
+            sortDirection?: "asc" | "desc" | undefined;
+            abbreviate: boolean;
+            prefix?: string | undefined;
+            suffix?: string | undefined;
+            type: "bignumber";
+        } | {
+            type: "title";
+        };
+        fillGaps?: boolean | undefined;
+        position: {
+            x: number;
+            y: number;
+            w: number;
+            h: number;
+        };
+    }[];
+}>;
+/**
+ * Replaces every widget on a custom dashboard. A widget that already exists keeps its position
+ * unless you pass a new one; new widgets without a `position` are placed full width below the others,
+ * in order. Pass the `revision` you last read to reject the write if someone else changed the
+ * dashboard in the meantime.
+ */
+declare function replaceDashboard(dashboardId: string, body: ReplaceDashboardRequestBody, requestOptions?: ApiRequestOptions): import("@trigger.dev/core/v3").ApiPromise<{
+    id: string;
+    title: string;
+    description: string;
+    revision: string;
+    createdAt: Date;
+    updatedAt: Date;
+    widgets: {
+        id: string;
+        title: string;
+        query: string;
+        display: {
+            type: "table";
+            prettyFormatting: boolean;
+            sorting: {
+                desc: boolean;
+                id: string;
+            }[];
+        } | {
+            chartType: "bar" | "line";
+            xAxisColumn: string | null;
+            yAxisColumns: string[];
+            groupByColumn: string | null;
+            stacked: boolean;
+            sortByColumn: string | null;
+            sortDirection: "asc" | "desc";
+            aggregation: "avg" | "count" | "max" | "min" | "sum";
+            seriesColors?: Record<string, string> | undefined;
+            type: "chart";
+        } | {
+            column: string;
+            aggregation: "avg" | "count" | "first" | "last" | "max" | "min" | "sum";
+            sortDirection?: "asc" | "desc" | undefined;
+            abbreviate: boolean;
+            prefix?: string | undefined;
+            suffix?: string | undefined;
+            type: "bignumber";
+        } | {
+            type: "title";
+        };
+        fillGaps?: boolean | undefined;
+        position: {
+            x: number;
+            y: number;
+            w: number;
+            h: number;
+        };
+    }[];
+}>;
+/**
+ * Deletes a custom dashboard.
+ */
+declare function deleteDashboard(dashboardId: string, requestOptions?: ApiRequestOptions): import("@trigger.dev/core/v3").ApiPromise<{
+    id: string;
+}>;
+/**
+ * Adds a widget to a custom dashboard. Without a `position` it is placed full width at the bottom.
+ */
+declare function addDashboardWidget(dashboardId: string, body: AddDashboardWidgetRequestBody, requestOptions?: ApiRequestOptions): import("@trigger.dev/core/v3").ApiPromise<{
+    widgetId: string;
+    dashboard: {
+        id: string;
+        title: string;
+        description: string;
+        revision: string;
+        createdAt: Date;
+        updatedAt: Date;
+        widgets: {
+            id: string;
+            title: string;
+            query: string;
+            display: {
+                type: "table";
+                prettyFormatting: boolean;
+                sorting: {
+                    desc: boolean;
+                    id: string;
+                }[];
+            } | {
+                chartType: "bar" | "line";
+                xAxisColumn: string | null;
+                yAxisColumns: string[];
+                groupByColumn: string | null;
+                stacked: boolean;
+                sortByColumn: string | null;
+                sortDirection: "asc" | "desc";
+                aggregation: "avg" | "count" | "max" | "min" | "sum";
+                seriesColors?: Record<string, string> | undefined;
+                type: "chart";
+            } | {
+                column: string;
+                aggregation: "avg" | "count" | "first" | "last" | "max" | "min" | "sum";
+                sortDirection?: "asc" | "desc" | undefined;
+                abbreviate: boolean;
+                prefix?: string | undefined;
+                suffix?: string | undefined;
+                type: "bignumber";
+            } | {
+                type: "title";
+            };
+            fillGaps?: boolean | undefined;
+            position: {
+                x: number;
+                y: number;
+                w: number;
+                h: number;
+            };
+        }[];
+    };
+}>;
+/**
+ * Changes a widget's title, query, display, or position.
+ */
+declare function updateDashboardWidget(dashboardId: string, widgetId: string, body: UpdateDashboardWidgetRequestBody, requestOptions?: ApiRequestOptions): import("@trigger.dev/core/v3").ApiPromise<{
+    id: string;
+    title: string;
+    description: string;
+    revision: string;
+    createdAt: Date;
+    updatedAt: Date;
+    widgets: {
+        id: string;
+        title: string;
+        query: string;
+        display: {
+            type: "table";
+            prettyFormatting: boolean;
+            sorting: {
+                desc: boolean;
+                id: string;
+            }[];
+        } | {
+            chartType: "bar" | "line";
+            xAxisColumn: string | null;
+            yAxisColumns: string[];
+            groupByColumn: string | null;
+            stacked: boolean;
+            sortByColumn: string | null;
+            sortDirection: "asc" | "desc";
+            aggregation: "avg" | "count" | "max" | "min" | "sum";
+            seriesColors?: Record<string, string> | undefined;
+            type: "chart";
+        } | {
+            column: string;
+            aggregation: "avg" | "count" | "first" | "last" | "max" | "min" | "sum";
+            sortDirection?: "asc" | "desc" | undefined;
+            abbreviate: boolean;
+            prefix?: string | undefined;
+            suffix?: string | undefined;
+            type: "bignumber";
+        } | {
+            type: "title";
+        };
+        fillGaps?: boolean | undefined;
+        position: {
+            x: number;
+            y: number;
+            w: number;
+            h: number;
+        };
+    }[];
+}>;
+/**
+ * Removes a widget from a custom dashboard.
+ */
+declare function deleteDashboardWidget(dashboardId: string, widgetId: string, options?: {
+    revision?: string;
+}, requestOptions?: ApiRequestOptions): import("@trigger.dev/core/v3").ApiPromise<{
+    id: string;
+    title: string;
+    description: string;
+    revision: string;
+    createdAt: Date;
+    updatedAt: Date;
+    widgets: {
+        id: string;
+        title: string;
+        query: string;
+        display: {
+            type: "table";
+            prettyFormatting: boolean;
+            sorting: {
+                desc: boolean;
+                id: string;
+            }[];
+        } | {
+            chartType: "bar" | "line";
+            xAxisColumn: string | null;
+            yAxisColumns: string[];
+            groupByColumn: string | null;
+            stacked: boolean;
+            sortByColumn: string | null;
+            sortDirection: "asc" | "desc";
+            aggregation: "avg" | "count" | "max" | "min" | "sum";
+            seriesColors?: Record<string, string> | undefined;
+            type: "chart";
+        } | {
+            column: string;
+            aggregation: "avg" | "count" | "first" | "last" | "max" | "min" | "sum";
+            sortDirection?: "asc" | "desc" | undefined;
+            abbreviate: boolean;
+            prefix?: string | undefined;
+            suffix?: string | undefined;
+            type: "bignumber";
+        } | {
+            type: "title";
+        };
+        fillGaps?: boolean | undefined;
+        position: {
+            x: number;
+            y: number;
+            w: number;
+            h: number;
+        };
+    }[];
+}>;
 export declare const query: {
     execute: typeof execute;
+    dashboards: {
+        list: typeof listDashboards;
+        retrieve: typeof retrieveDashboard;
+        create: typeof createDashboard;
+        update: typeof updateDashboard;
+        replace: typeof replaceDashboard;
+        del: typeof deleteDashboard;
+        widgets: {
+            add: typeof addDashboardWidget;
+            update: typeof updateDashboardWidget;
+            del: typeof deleteDashboardWidget;
+        };
+    };
 };

package/dist/esm/v3/query.js

@@ -39,7 +39,122 @@ function dateToISOString(date) {
     }
     return new Date(date).toISOString();
 }
+function dashboardRequestOptions(name, attributes, requestOptions) {
+    return mergeRequestOptions({ tracer, name, icon: "query", attributes }, requestOptions);
+}
+/**
+ * Lists the built-in dashboards and your organization's custom dashboards, with their widgets.
+ */
+function listDashboards(requestOptions) {
+    return apiClientManager
+        .clientOrThrow()
+        .listDashboards(dashboardRequestOptions("query.dashboards.list()", {}, requestOptions));
+}
+/**
+ * Retrieves a custom dashboard, including every widget, its query and its grid position.
+ */
+function retrieveDashboard(dashboardId, requestOptions) {
+    return apiClientManager
+        .clientOrThrow()
+        .retrieveDashboard(dashboardId, dashboardRequestOptions("query.dashboards.retrieve()", { dashboardId }, requestOptions));
+}
+/**
+ * Creates a custom dashboard, optionally with its widgets.
+ *
+ * @example
+ * ```ts
+ * const dashboard = await query.dashboards.create({
+ *   title: "Email tasks",
+ *   widgets: [
+ *     {
+ *       title: "Runs per day",
+ *       query: "SELECT timeBucket(), count() AS runs FROM runs GROUP BY timeBucket ORDER BY timeBucket",
+ *       display: {
+ *         type: "chart",
+ *         chartType: "bar",
+ *         xAxisColumn: "timebucket",
+ *         yAxisColumns: ["runs"],
+ *         groupByColumn: null,
+ *         stacked: false,
+ *         sortByColumn: null,
+ *         sortDirection: "asc",
+ *         aggregation: "sum",
+ *       },
+ *     },
+ *   ],
+ * });
+ * ```
+ */
+function createDashboard(body, requestOptions) {
+    return apiClientManager
+        .clientOrThrow()
+        .createDashboard(body, dashboardRequestOptions("query.dashboards.create()", { title: body.title }, requestOptions));
+}
+/**
+ * Renames a custom dashboard or changes its description.
+ */
+function updateDashboard(dashboardId, body, requestOptions) {
+    return apiClientManager
+        .clientOrThrow()
+        .updateDashboard(dashboardId, body, dashboardRequestOptions("query.dashboards.update()", { dashboardId }, requestOptions));
+}
+/**
+ * Replaces every widget on a custom dashboard. A widget that already exists keeps its position
+ * unless you pass a new one; new widgets without a `position` are placed full width below the others,
+ * in order. Pass the `revision` you last read to reject the write if someone else changed the
+ * dashboard in the meantime.
+ */
+function replaceDashboard(dashboardId, body, requestOptions) {
+    return apiClientManager
+        .clientOrThrow()
+        .replaceDashboard(dashboardId, body, dashboardRequestOptions("query.dashboards.replace()", { dashboardId }, requestOptions));
+}
+/**
+ * Deletes a custom dashboard.
+ */
+function deleteDashboard(dashboardId, requestOptions) {
+    return apiClientManager
+        .clientOrThrow()
+        .deleteDashboard(dashboardId, dashboardRequestOptions("query.dashboards.del()", { dashboardId }, requestOptions));
+}
+/**
+ * Adds a widget to a custom dashboard. Without a `position` it is placed full width at the bottom.
+ */
+function addDashboardWidget(dashboardId, body, requestOptions) {
+    return apiClientManager
+        .clientOrThrow()
+        .addDashboardWidget(dashboardId, body, dashboardRequestOptions("query.dashboards.widgets.add()", { dashboardId }, requestOptions));
+}
+/**
+ * Changes a widget's title, query, display, or position.
+ */
+function updateDashboardWidget(dashboardId, widgetId, body, requestOptions) {
+    return apiClientManager
+        .clientOrThrow()
+        .updateDashboardWidget(dashboardId, widgetId, body, dashboardRequestOptions("query.dashboards.widgets.update()", { dashboardId, widgetId }, requestOptions));
+}
+/**
+ * Removes a widget from a custom dashboard.
+ */
+function deleteDashboardWidget(dashboardId, widgetId, options, requestOptions) {
+    return apiClientManager
+        .clientOrThrow()
+        .deleteDashboardWidget(dashboardId, widgetId, options, dashboardRequestOptions("query.dashboards.widgets.del()", { dashboardId, widgetId }, requestOptions));
+}
 export const query = {
     execute,
+    dashboards: {
+        list: listDashboards,
+        retrieve: retrieveDashboard,
+        create: createDashboard,
+        update: updateDashboard,
+        replace: replaceDashboard,
+        del: deleteDashboard,
+        widgets: {
+            add: addDashboardWidget,
+            update: updateDashboardWidget,
+            del: deleteDashboardWidget,
+        },
+    },
 };
 //# sourceMappingURL=query.js.map

package/dist/esm/v3/query.js.map

@@ -1 +1 @@
-{"version":3,"file":"query.js","sourceRoot":"","sources":["../../../src/v3/query.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAqHrC,iBAAiB;AACjB,SAAS,OAAO,CACd,KAAa,EACb,OAAsB,EACtB,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5C,MAAM,EAAE,GAAG,eAAe,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAExC,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,aAAa;YACtC,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,MAAM;YACjC,KAAK;YACL,MAAM,EAAE,OAAO,EAAE,MAAM;YACvB,IAAI;YACJ,EAAE;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS;SACb,YAAY,CACX,KAAK,EACL;QACE,KAAK,EAAE,OAAO,EAAE,KAAK;QACrB,MAAM,EAAE,OAAO,EAAE,MAAM;QACvB,IAAI;QACJ,EAAE;QACF,MAAM,EAAE,OAAO,EAAE,MAAM;KACxB,EACD,eAAe,CAChB;SACA,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACjB,OAAO,QAAQ,CAAC;IAClB,CAAC,CAA2F,CAAC;AACjG,CAAC;AAED,SAAS,eAAe,CAAC,IAA+B;IACtD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,IAAI,YAAY,IAAI,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;AACtC,CAAC;AAED,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,OAAO;CACR,CAAC"}
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../../../src/v3/query.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AA6HrC,iBAAiB;AACjB,SAAS,OAAO,CACd,KAAa,EACb,OAAsB,EACtB,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5C,MAAM,EAAE,GAAG,eAAe,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAExC,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,aAAa;YACtC,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,MAAM;YACjC,KAAK;YACL,MAAM,EAAE,OAAO,EAAE,MAAM;YACvB,IAAI;YACJ,EAAE;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS;SACb,YAAY,CACX,KAAK,EACL;QACE,KAAK,EAAE,OAAO,EAAE,KAAK;QACrB,MAAM,EAAE,OAAO,EAAE,MAAM;QACvB,IAAI;QACJ,EAAE;QACF,MAAM,EAAE,OAAO,EAAE,MAAM;KACxB,EACD,eAAe,CAChB;SACA,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACjB,OAAO,QAAQ,CAAC;IAClB,CAAC,CAA2F,CAAC;AACjG,CAAC;AAED,SAAS,eAAe,CAAC,IAA+B;IACtD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,IAAI,YAAY,IAAI,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;AACtC,CAAC;AAED,SAAS,uBAAuB,CAC9B,IAAY,EACZ,UAA8C,EAC9C,cAAkC;IAElC,OAAO,mBAAmB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,cAAc,CAAC,CAAC;AAC1F,CAAC;AAED;;GAEG;AACH,SAAS,cAAc,CAAC,cAAkC;IACxD,OAAO,gBAAgB;SACpB,aAAa,EAAE;SACf,cAAc,CAAC,uBAAuB,CAAC,yBAAyB,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED;;GAEG;AACH,SAAS,iBAAiB,CAAC,WAAmB,EAAE,cAAkC;IAChF,OAAO,gBAAgB;SACpB,aAAa,EAAE;SACf,iBAAiB,CAChB,WAAW,EACX,uBAAuB,CAAC,6BAA6B,EAAE,EAAE,WAAW,EAAE,EAAE,cAAc,CAAC,CACxF,CAAC;AACN,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAS,eAAe,CAAC,IAAgC,EAAE,cAAkC;IAC3F,OAAO,gBAAgB;SACpB,aAAa,EAAE;SACf,eAAe,CACd,IAAI,EACJ,uBAAuB,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,EAAE,cAAc,CAAC,CAC5F,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CACtB,WAAmB,EACnB,IAAgC,EAChC,cAAkC;IAElC,OAAO,gBAAgB;SACpB,aAAa,EAAE;SACf,eAAe,CACd,WAAW,EACX,IAAI,EACJ,uBAAuB,CAAC,2BAA2B,EAAE,EAAE,WAAW,EAAE,EAAE,cAAc,CAAC,CACtF,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CACvB,WAAmB,EACnB,IAAiC,EACjC,cAAkC;IAElC,OAAO,gBAAgB;SACpB,aAAa,EAAE;SACf,gBAAgB,CACf,WAAW,EACX,IAAI,EACJ,uBAAuB,CAAC,4BAA4B,EAAE,EAAE,WAAW,EAAE,EAAE,cAAc,CAAC,CACvF,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CAAC,WAAmB,EAAE,cAAkC;IAC9E,OAAO,gBAAgB;SACpB,aAAa,EAAE;SACf,eAAe,CACd,WAAW,EACX,uBAAuB,CAAC,wBAAwB,EAAE,EAAE,WAAW,EAAE,EAAE,cAAc,CAAC,CACnF,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CACzB,WAAmB,EACnB,IAAmC,EACnC,cAAkC;IAElC,OAAO,gBAAgB;SACpB,aAAa,EAAE;SACf,kBAAkB,CACjB,WAAW,EACX,IAAI,EACJ,uBAAuB,CAAC,gCAAgC,EAAE,EAAE,WAAW,EAAE,EAAE,cAAc,CAAC,CAC3F,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAS,qBAAqB,CAC5B,WAAmB,EACnB,QAAgB,EAChB,IAAsC,EACtC,cAAkC;IAElC,OAAO,gBAAgB;SACpB,aAAa,EAAE;SACf,qBAAqB,CACpB,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,uBAAuB,CACrB,mCAAmC,EACnC,EAAE,WAAW,EAAE,QAAQ,EAAE,EACzB,cAAc,CACf,CACF,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAS,qBAAqB,CAC5B,WAAmB,EACnB,QAAgB,EAChB,OAA+B,EAC/B,cAAkC;IAElC,OAAO,gBAAgB;SACpB,aAAa,EAAE;SACf,qBAAqB,CACpB,WAAW,EACX,QAAQ,EACR,OAAO,EACP,uBAAuB,CACrB,gCAAgC,EAChC,EAAE,WAAW,EAAE,QAAQ,EAAE,EACzB,cAAc,CACf,CACF,CAAC;AACN,CAAC;AAED,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,OAAO;IACP,UAAU,EAAE;QACV,IAAI,EAAE,cAAc;QACpB,QAAQ,EAAE,iBAAiB;QAC3B,MAAM,EAAE,eAAe;QACvB,MAAM,EAAE,eAAe;QACvB,OAAO,EAAE,gBAAgB;QACzB,GAAG,EAAE,eAAe;QACpB,OAAO,EAAE;YACP,GAAG,EAAE,kBAAkB;YACvB,MAAM,EAAE,qBAAqB;YAC7B,GAAG,EAAE,qBAAqB;SAC3B;KACF;CACF,CAAC"}

package/dist/esm/v3/runs.d.ts

@@ -1,4 +1,4 @@
-import type { AnyRetrieveRunResult, AnyRunShape, ApiRequestOptions, CreateBulkCancelActionOptions, CreateBulkReplayActionOptions, InferRunTypes, ListBulkActionsQueryParams, ListProjectRunsQueryParams, ListRunsQueryParams, RescheduleRunRequestBody, RetrieveRunResult, RunShape, RealtimeRun, AnyRealtimeRun, RunSubscription, TaskRunShape, AnyBatchedRunHandle, AsyncIterableStream, ApiPromise, RealtimeRunSkipColumns, AbortBulkActionResponseBody, BulkActionObject, CanceledRunResponse, CreateBulkActionResponseBody, CursorPagePromise, ListRunResponseItem, ReplayRunResponse, RetrieveRunResponse } from "@trigger.dev/core/v3";
+import type { AnyRetrieveRunResult, AnyRunShape, ApiRequestOptions, CreateBulkCancelActionOptions, CreateBulkReplayActionOptions, InferRunTypes, ListBulkActionsQueryParams, ListProjectRunsQueryParams, ListRunsQueryParams, RescheduleRunRequestBody, RetrieveRunResult, RunShape, RealtimeRun, AnyRealtimeRun, RunSubscription, TaskRunShape, AnyBatchedRunHandle, AsyncIterableStream, ApiPromise, RealtimeRunSkipColumns, AbortBulkActionResponseBody, BulkActionObject, CanceledRunResponse, CreateBulkActionResponseBody, CursorPagePromise, IdempotencyKey, ListRunResponseItem, ReplayRunResponse, RetrieveRunResponse, TriggerOptions } from "@trigger.dev/core/v3";
 import type { AnyRunHandle, AnyTask } from "./shared.js";
 export type { AnyRetrieveRunResult, AnyRunShape, RetrieveRunResult, RunShape, TaskRunShape, RealtimeRun, AnyRealtimeRun, };
 export declare const runs: {
@@ -26,6 +26,27 @@ declare function listRuns(projectRef: string, params?: ListProjectRunsQueryParam
 declare function listRuns(params?: ListRunsQueryParams, requestOptions?: ApiRequestOptions): CursorPagePromise<typeof ListRunResponseItem>;
 type RunId<TRunId> = TRunId extends AnyRunHandle | AnyBatchedRunHandle ? TRunId : TRunId extends AnyTask ? string : TRunId extends string ? TRunId : never;
 declare function retrieveRun<TRunId extends AnyRunHandle | AnyBatchedRunHandle | AnyTask | string>(runId: RunId<TRunId>, requestOptions?: ApiRequestOptions): ApiPromise<RetrieveRunResult<TRunId>>;
+export type ReplayRunOptions = Pick<TriggerOptions, "metadata" | "tags" | "queue" | "concurrencyKey" | "machine" | "version" | "region" | "delay" | "ttl" | "idempotencyKeyTTL" | "maxAttempts" | "maxDuration" | "priority"> & {
+    /**
+     * The payload for the new run. Omit it to reuse the original run's payload.
+     */
+    payload?: unknown;
+    /**
+     * An idempotency key for the new run. A plain string is used as-is: unlike `trigger()`, it is
+     * not scoped to the current run. Use `idempotencyKeys.create()` for a scoped key.
+     */
+    idempotencyKey?: IdempotencyKey | string;
+};
+/**
+ * Replays a run: creates a new run of the same task from the original run's payload and options.
+ * Pass `options` to override any of them for the new run.
+ *
+ * @example
+ * ```ts
+ * const { id } = await runs.replay("run_1234", { payload: { userId: "123" }, delay: "1h" });
+ * ```
+ */
+declare function replayRun(runId: string, options?: ReplayRunOptions, requestOptions?: ApiRequestOptions): ApiPromise<ReplayRunResponse>;
 declare function replayRun(runId: string, requestOptions?: ApiRequestOptions): ApiPromise<ReplayRunResponse>;
 declare function cancelRun(runId: string, requestOptions?: ApiRequestOptions): ApiPromise<CanceledRunResponse>;
 declare function bulkCancelRuns(options: CreateBulkCancelActionOptions, requestOptions?: ApiRequestOptions): ApiPromise<CreateBulkActionResponseBody>;

package/dist/esm/v3/runs.js

@@ -126,8 +126,11 @@ async function resolvePayloadAndOutputUrls(run) {
     }
     return resolvedRun;
 }
-function replayRun(runId, requestOptions) {
+function replayRun(runId, optionsOrRequestOptions, requestOptions) {
     const apiClient = apiClientManager.clientOrThrow();
+    const options = isRequestOptions(optionsOrRequestOptions)
+        ? undefined
+        : optionsOrRequestOptions;
     const $requestOptions = mergeRequestOptions({
         tracer,
         name: "runs.replay()",
@@ -144,8 +147,8 @@ function replayRun(runId, requestOptions) {
                 style: "codepath",
             }),
         },
-    }, requestOptions);
-    return apiClient.replayRun(runId, $requestOptions);
+    }, isRequestOptions(optionsOrRequestOptions) ? optionsOrRequestOptions : requestOptions);
+    return apiClient.replayRun(runId, options, $requestOptions);
 }
 function cancelRun(runId, requestOptions) {
     const apiClient = apiClientManager.clientOrThrow();