@trigger.dev/core 4.7.4 → 4.8.0-webhooks.20261020092920

package/dist/commonjs/v3/apiClient/index.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 import type { ApiClientConfiguration } from "../apiClientManager-api.js";
-import { type AddTagsRequestBody, type ApiDeploymentListOptions, type BatchItemNDJSON, type BatchTriggerTaskV3RequestBody, type CloseSessionRequestBody, type CompleteWaitpointTokenRequestBody, type CreateBatchRequestBody, type CreateEnvironmentVariableRequestBody, type CreateInputStreamWaitpointRequestBody, type CreatePromptOverrideRequestBody, type ListWebhookDeliveriesQuery, type SetWebhookEndpointSecretRequestBody, type CreateScheduleOptions, type CreateSessionRequestBody, type CreateSessionStreamWaitpointRequestBody, type CreateWaitpointTokenRequestBody, type EndAndContinueSessionRequestBody, type ListQueueOptions, type ListConcurrencyLimitOptions, type OverrideConcurrencyLimitBoundsBody, type OverrideConcurrencyLimitKeyBody, type ResetConcurrencyLimitRequestBody, type ListScheduleOptions, type ListSessionsOptions, type PromotePromptVersionRequestBody, type ReactivatePromptOverrideRequestBody, ReplayRunRequestBody, type RescheduleRunRequestBody, type ResolvePromptRequestBody, type RetrieveQueueParam, type TriggerTaskRequestBody, type UpdateEnvironmentVariableRequestBody, type UpdateMetadataRequestBody, type UpdatePromptOverrideRequestBody, type UpdateScheduleOptions, type UpdateSessionRequestBody, type WaitForDurationRequestBody, BulkActionObject, BatchTaskRunExecutionResult, CreateBatchResponse, CreateWaitpointTokenResponseBody, ListDashboardsResponseBody, ListRunResponseItem, ListedSessionItem, QueryExecuteResponseBody, QuerySchemaResponseBody, ReplayRunResponse, type ReportViewModel, StreamBatchItemsResponse, TaskRunExecutionResult, WaitpointTokenItem } from "../schemas/index.js";
+import { type AddTagsRequestBody, type ApiDeploymentListOptions, type BatchItemNDJSON, type BatchTriggerTaskV3RequestBody, type CloseSessionRequestBody, type CompleteWaitpointTokenRequestBody, type CreateBatchRequestBody, type CreateEnvironmentVariableRequestBody, type CreateInputStreamWaitpointRequestBody, type CreatePromptOverrideRequestBody, type ListWebhookDeliveriesQuery, type CreateWebhookWaiterRequestBody, type SetWebhookEndpointSecretRequestBody, type CreateScheduleOptions, type CreateSessionRequestBody, type CreateSessionStreamWaitpointRequestBody, type CreateWaitpointTokenRequestBody, type EndAndContinueSessionRequestBody, type ListQueueOptions, type ListConcurrencyLimitOptions, type OverrideConcurrencyLimitBoundsBody, type OverrideConcurrencyLimitKeyBody, type ResetConcurrencyLimitRequestBody, type ListScheduleOptions, type ListSessionsOptions, type PromotePromptVersionRequestBody, type ReactivatePromptOverrideRequestBody, ReplayRunRequestBody, type RescheduleRunRequestBody, type ResolvePromptRequestBody, type RetrieveQueueParam, type TriggerTaskRequestBody, type UpdateEnvironmentVariableRequestBody, type UpdateMetadataRequestBody, type UpdatePromptOverrideRequestBody, type UpdateScheduleOptions, type UpdateSessionRequestBody, type WaitForDurationRequestBody, BulkActionObject, BatchTaskRunExecutionResult, CreateBatchResponse, CreateWaitpointTokenResponseBody, ListDashboardsResponseBody, type AddDashboardWidgetRequestBody, type CreateDashboardRequestBody, type ReplaceDashboardRequestBody, type UpdateDashboardRequestBody, type UpdateDashboardWidgetRequestBody, ListRunResponseItem, ListedSessionItem, QueryExecuteResponseBody, QuerySchemaResponseBody, ReplayRunResponse, type ReportViewModel, StreamBatchItemsResponse, TaskRunExecutionResult, WaitpointTokenItem } from "../schemas/index.js";
 import { type ControlEvent } from "../sessionStreams/wireProtocol.js";
 import type { AsyncIterableStream } from "../streams/asyncIterableStream.js";
 import type { AnyRunTypes, TriggerJwtOptions } from "../types/tasks.js";
@@ -1281,6 +1281,7 @@ export declare class ApiClient {
         closeOnComplete?: boolean;
         onFetchError?: (error: Error) => void;
         skipColumns?: string[];
+        fetchClient?: typeof fetch;
     }): RunSubscription<TRunTypes>;
     subscribeToRunsWithTag<TRunTypes extends AnyRunTypes>(tag: string | string[], filters?: {
         createdAt?: string;
@@ -1288,11 +1289,13 @@ export declare class ApiClient {
     }, options?: {
         signal?: AbortSignal;
         onFetchError?: (error: Error) => void;
+        fetchClient?: typeof fetch;
     }): RunSubscription<TRunTypes>;
     subscribeToBatch<TRunTypes extends AnyRunTypes>(batchId: string, options?: {
         signal?: AbortSignal;
         onFetchError?: (error: Error) => void;
         skipColumns?: string[];
+        fetchClient?: typeof fetch;
     }): RunSubscription<TRunTypes>;
     listDeployments(options?: ApiDeploymentListOptions, requestOptions?: ZodFetchOptions): CursorPagePromise<z.ZodObject<{
         id: z.ZodString;
@@ -1406,6 +1409,357 @@ export declare class ApiClient {
     }, requestOptions?: ZodFetchOptions): Promise<QueryExecuteResponseBody>;
     getQuerySchema(requestOptions?: ZodFetchOptions): Promise<QuerySchemaResponseBody>;
     listDashboards(requestOptions?: ZodFetchOptions): Promise<ListDashboardsResponseBody>;
+    retrieveDashboard(dashboardId: string, requestOptions?: ZodFetchOptions): 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;
+            };
+        }[];
+    }>;
+    createDashboard(body: CreateDashboardRequestBody, requestOptions?: ZodFetchOptions): 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;
+            };
+        }[];
+    }>;
+    updateDashboard(dashboardId: string, body: UpdateDashboardRequestBody, requestOptions?: ZodFetchOptions): 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;
+            };
+        }[];
+    }>;
+    replaceDashboard(dashboardId: string, body: ReplaceDashboardRequestBody, requestOptions?: ZodFetchOptions): 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;
+            };
+        }[];
+    }>;
+    deleteDashboard(dashboardId: string, requestOptions?: ZodFetchOptions): ApiPromise<{
+        id: string;
+    }>;
+    addDashboardWidget(dashboardId: string, body: AddDashboardWidgetRequestBody, requestOptions?: ZodFetchOptions): 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;
+                };
+            }[];
+        };
+    }>;
+    updateDashboardWidget(dashboardId: string, widgetId: string, body: UpdateDashboardWidgetRequestBody, requestOptions?: ZodFetchOptions): 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;
+            };
+        }[];
+    }>;
+    deleteDashboardWidget(dashboardId: string, widgetId: string, options?: {
+        revision?: string;
+    }, requestOptions?: ZodFetchOptions): 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;
+            };
+        }[];
+    }>;
     /**
      * `format: "json"` returns a `ReportViewModel`; "markdown" (default) and "ansi" return a rendered
      * string. `period` is a shorthand like "1h" or "7d", capped at 90d. Seconds are not accepted.
@@ -1430,6 +1784,17 @@ export declare class ApiClient {
             config?: Record<string, unknown> | null | undefined;
         };
     }>;
+    createWebhookWaiter(endpointId: string, body: CreateWebhookWaiterRequestBody, requestOptions?: ZodFetchOptions): ApiPromise<{
+        id: string;
+        url?: string | undefined;
+        expiresAt: Date;
+        isCached: boolean;
+    }>;
+    cancelWebhookWaiter(waiterId: string, requestOptions?: ZodFetchOptions): ApiPromise<{
+        cancelled: boolean;
+        reason?: "too_late" | undefined;
+        deliveryId?: string | undefined;
+    }>;
     listWebhookEndpoints(requestOptions?: ZodFetchOptions): ApiPromise<{
         data: {
             id: string;

package/dist/commonjs/v3/apiClient/index.js

@@ -1063,6 +1063,7 @@ class ApiClient {
             client: this,
             signal: options?.signal,
             onFetchError: options?.onFetchError,
+            fetchClient: options?.fetchClient,
         });
     }
     subscribeToRunsWithTag(tag, filters, options) {
@@ -1078,6 +1079,7 @@ class ApiClient {
             client: this,
             signal: options?.signal,
             onFetchError: options?.onFetchError,
+            fetchClient: options?.fetchClient,
         });
     }
     subscribeToBatch(batchId, options) {
@@ -1092,6 +1094,7 @@ class ApiClient {
             client: this,
             signal: options?.signal,
             onFetchError: options?.onFetchError,
+            fetchClient: options?.fetchClient,
         });
     }
     listDeployments(options, requestOptions) {
@@ -1233,6 +1236,62 @@ class ApiClient {
             headers: this.#getHeaders(false),
         }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
     }
+    retrieveDashboard(dashboardId, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.DashboardObject, `${this.baseUrl}/api/v1/query/dashboards/${encodeURIComponent(dashboardId)}`, {
+            method: "GET",
+            headers: this.#getHeaders(false),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    createDashboard(body, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.DashboardObject, `${this.baseUrl}/api/v1/query/dashboards`, {
+            method: "POST",
+            headers: this.#getHeaders(false),
+            body: JSON.stringify(body),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    updateDashboard(dashboardId, body, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.DashboardObject, `${this.baseUrl}/api/v1/query/dashboards/${encodeURIComponent(dashboardId)}`, {
+            method: "PATCH",
+            headers: this.#getHeaders(false),
+            body: JSON.stringify(body),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    replaceDashboard(dashboardId, body, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.DashboardObject, `${this.baseUrl}/api/v1/query/dashboards/${encodeURIComponent(dashboardId)}`, {
+            method: "PUT",
+            headers: this.#getHeaders(false),
+            body: JSON.stringify(body),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    deleteDashboard(dashboardId, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.DeleteDashboardResponseBody, `${this.baseUrl}/api/v1/query/dashboards/${encodeURIComponent(dashboardId)}`, {
+            method: "DELETE",
+            headers: this.#getHeaders(false),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    addDashboardWidget(dashboardId, body, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.AddDashboardWidgetResponseBody, `${this.baseUrl}/api/v1/query/dashboards/${encodeURIComponent(dashboardId)}/widgets`, {
+            method: "POST",
+            headers: this.#getHeaders(false),
+            body: JSON.stringify(body),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    updateDashboardWidget(dashboardId, widgetId, body, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.DashboardObject, `${this.baseUrl}/api/v1/query/dashboards/${encodeURIComponent(dashboardId)}/widgets/${encodeURIComponent(widgetId)}`, {
+            method: "PATCH",
+            headers: this.#getHeaders(false),
+            body: JSON.stringify(body),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    deleteDashboardWidget(dashboardId, widgetId, options, requestOptions) {
+        const search = options?.revision
+            ? `?${new URLSearchParams({ revision: options.revision }).toString()}`
+            : "";
+        return (0, core_js_1.zodfetch)(index_js_1.DashboardObject, `${this.baseUrl}/api/v1/query/dashboards/${encodeURIComponent(dashboardId)}/widgets/${encodeURIComponent(widgetId)}${search}`, {
+            method: "DELETE",
+            headers: this.#getHeaders(false),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
     async getReport(key, options) {
         const searchParams = new URLSearchParams({ format: options?.format ?? "markdown" });
         if (options?.period) {
@@ -1309,6 +1368,12 @@ class ApiClient {
             body: JSON.stringify(body),
         }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
     }
+    createWebhookWaiter(endpointId, body, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.CreateWebhookWaiterResponseBody, `${this.baseUrl}/api/v1/webhooks/endpoints/${encodeURIComponent(endpointId)}/waiters`, { method: "POST", headers: this.#getHeaders(false), body: JSON.stringify(body) }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    cancelWebhookWaiter(waiterId, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.CancelWebhookWaiterResponseBody, `${this.baseUrl}/api/v1/webhooks/waiters/${encodeURIComponent(waiterId)}/cancel`, { method: "POST", headers: this.#getHeaders(false) }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
     listWebhookEndpoints(requestOptions) {
         return (0, core_js_1.zodfetch)(index_js_1.ListWebhookEndpointsResponse, `${this.baseUrl}/api/v1/webhooks/endpoints`, { method: "GET", headers: this.#getHeaders(false) }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
     }