@trigger.dev/sdk 4.7.4 → 4.7.5

package/dist/commonjs/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/commonjs/v3/query.js

@@ -42,7 +42,122 @@ function dateToISOString(date) {
     }
     return new Date(date).toISOString();
 }
+function dashboardRequestOptions(name, attributes, requestOptions) {
+    return (0, v3_1.mergeRequestOptions)({ tracer: tracer_js_1.tracer, name, icon: "query", attributes }, requestOptions);
+}
+/**
+ * Lists the built-in dashboards and your organization's custom dashboards, with their widgets.
+ */
+function listDashboards(requestOptions) {
+    return v3_1.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 v3_1.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 v3_1.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 v3_1.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 v3_1.apiClientManager
+        .clientOrThrow()
+        .replaceDashboard(dashboardId, body, dashboardRequestOptions("query.dashboards.replace()", { dashboardId }, requestOptions));
+}
+/**
+ * Deletes a custom dashboard.
+ */
+function deleteDashboard(dashboardId, requestOptions) {
+    return v3_1.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 v3_1.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 v3_1.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 v3_1.apiClientManager
+        .clientOrThrow()
+        .deleteDashboardWidget(dashboardId, widgetId, options, dashboardRequestOptions("query.dashboards.widgets.del()", { dashboardId, widgetId }, requestOptions));
+}
 exports.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/commonjs/v3/query.js.map

@@ -1 +1 @@
-{"version":3,"file":"query.js","sourceRoot":"","sources":["../../../src/v3/query.ts"],"names":[],"mappings":";;;AACA,6CAA6E;AAC7E,2CAAqC;AAqHrC,iBAAiB;AACjB,SAAS,OAAO,CACd,KAAa,EACb,OAAsB,EACtB,cAAkC;IAElC,MAAM,SAAS,GAAG,qBAAgB,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,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;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;AAEY,QAAA,KAAK,GAAG;IACnB,OAAO;CACR,CAAC"}
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../../../src/v3/query.ts"],"names":[],"mappings":";;;AASA,6CAA6E;AAC7E,2CAAqC;AA6HrC,iBAAiB;AACjB,SAAS,OAAO,CACd,KAAa,EACb,OAAsB,EACtB,cAAkC;IAElC,MAAM,SAAS,GAAG,qBAAgB,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,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;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,IAAA,wBAAmB,EAAC,EAAE,MAAM,EAAN,kBAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,cAAc,CAAC,CAAC;AAC1F,CAAC;AAED;;GAEG;AACH,SAAS,cAAc,CAAC,cAAkC;IACxD,OAAO,qBAAgB;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,qBAAgB;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,qBAAgB;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,qBAAgB;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,qBAAgB;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,qBAAgB;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,qBAAgB;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,qBAAgB;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,qBAAgB;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;AAEY,QAAA,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/commonjs/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = "4.7.4";
+exports.VERSION = "4.7.5";
 //# sourceMappingURL=version.js.map

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

@@ -33,6 +33,7 @@ type ChatTurnContext<TClientData = unknown> = {
     turn: number;
     continuation: boolean;
     clientData?: TClientData;
+    recordUserMessage?: boolean;
 };
 export { __readChatSnapshotProductionPathForTests, __setReadChatSnapshotImplForTests, __setWriteChatSnapshotImplForTests, __writeChatSnapshotProductionPathForTests, } from "./chatSnapshotIo.js";
 export { defaultStorage, memoryTranscriptStorage, reduceTranscriptChanges, snapshotTranscriptStorage, type LoadContextEvent, type MemoryTranscriptStorage, type TranscriptChange, type TranscriptChangeReason, type TranscriptChangeset, type TranscriptCursors, type TranscriptLoadOptions, type TranscriptLoadResult, type TranscriptScope, type TranscriptState, type TranscriptStorage, type TranscriptStorageContext, } from "./transcriptStorage.js";
@@ -1677,6 +1678,31 @@ export type ChatAgentOptions<TIdentifier extends string, TClientDataSchema exten
      * Ignored for sessions with no pin, and for sessions using `lockToVersion`.
      */
     versionSkew?: ChatVersionSkewPolicy;
+    /**
+     * Controls which chat content the chat runtime records on its spans in the run trace.
+     *
+     * - `recordUserMessage` (default `true`) records the last user message as `chat.user_message`
+     *   and as the turn span's preview text, and messages sent mid-turn as `pending.messages`.
+     * - `recordClientData` (default `true`) records the raw `clientData` sent by the frontend as
+     *   `chat.client_data`.
+     *
+     * Set either to `false` to keep that content out of telemetry. Content recorded by the AI SDK's
+     * own spans is controlled separately, through `experimental_telemetry` on the model call.
+     *
+     * @example
+     * ```ts
+     * chat.agent({
+     *   id: "my-chat",
+     *   telemetry: { recordUserMessage: false, recordClientData: false },
+     *   run: async ({ messages, signal, streamText }) =>
+     *     streamText({ model, messages, abortSignal: signal }),
+     * });
+     * ```
+     */
+    telemetry?: {
+        recordUserMessage?: boolean;
+        recordClientData?: boolean;
+    };
     /**
      * Schema for validating `clientData` from the frontend.
      * Accepts Zod, ArkType, Valibot, or any supported schema library.

package/dist/esm/v3/ai.js

@@ -2867,7 +2867,6 @@ async function drainSteeringQueue(config, messages, steps, queueOverride) {
     // Span attributes describe the offered batch; the chunk and callback below
     // describe what was actually claimed and injected.
     const messageTexts = uiMessages.map(textOfUIMessage);
-    const _previewText = messageTexts.length === 1 ? messageTexts[0].slice(0, 80) : `${queue.length} messages`;
     return tracer.startActiveSpan("pending message injected", async () => {
         /**
          * Claim before transforming, and inject only what was claimed.
@@ -3006,7 +3005,7 @@ async function drainSteeringQueue(config, messages, steps, queueOverride) {
             [SemanticInternalAttributes.STYLE_ICON]: "tabler-message-forward",
             "pending.message_count": uiMessages.length,
             "pending.step_number": stepNumber,
-            "pending.messages": messageTexts,
+            ...(ctx?.recordUserMessage === false ? {} : { "pending.messages": messageTexts }),
             ...(ctx?.chatId ? { "pending.chat_id": ctx.chatId } : {}),
             ...(ctx?.turn != null ? { "pending.turn": ctx.turn } : {}),
             ...accessoryAttributes({
@@ -3845,7 +3844,9 @@ function chatCustomAgent(options) {
     return task;
 }
 function chatAgent(options) {
-    const { run: userRun, clientDataSchema, onBoot, onRecoveryBoot, onPreload, onChatStart, onValidateMessages, hydrateMessages, storage, actionSchema, onAction, onTurnStart, onBeforeTurnComplete, onCompacted, compaction, pendingMessages: pendingMessagesConfig, prepareMessages, tools: toolsOption, onTurnComplete, maxTurns = 100, turnTimeout = "1h", idleTimeoutInSeconds = 30, chatAccessTokenTTL = "1h", preloadIdleTimeoutInSeconds, preloadTimeout, uiMessageStreamOptions, onChatSuspend, onChatResume, exitAfterPreloadIdle = false, oomMachine, registry: promptRegistry, system: agentSystem, cacheControl: agentCacheControl, systemProviderOptions: agentSystemProviderOptions, versionSkew, ...restOptions } = options;
+    const { run: userRun, clientDataSchema, onBoot, onRecoveryBoot, onPreload, onChatStart, onValidateMessages, hydrateMessages, storage, actionSchema, onAction, onTurnStart, onBeforeTurnComplete, onCompacted, compaction, pendingMessages: pendingMessagesConfig, prepareMessages, tools: toolsOption, onTurnComplete, maxTurns = 100, turnTimeout = "1h", idleTimeoutInSeconds = 30, chatAccessTokenTTL = "1h", preloadIdleTimeoutInSeconds, preloadTimeout, uiMessageStreamOptions, onChatSuspend, onChatResume, exitAfterPreloadIdle = false, oomMachine, registry: promptRegistry, system: agentSystem, cacheControl: agentCacheControl, systemProviderOptions: agentSystemProviderOptions, versionSkew, telemetry: telemetryOptions, ...restOptions } = options;
+    const recordUserMessage = telemetryOptions?.recordUserMessage ?? true;
+    const recordClientData = telemetryOptions?.recordClientData ?? true;
     if (hydrateMessages) {
         if (storage) {
             throw new Error(`chat.agent: "${options.id}" sets both \`hydrateMessages\` and \`storage\`. ` +
@@ -4982,7 +4983,7 @@ function chatAgent(options) {
                                 : "tabler-message-chatbot",
                             [SemanticInternalAttributes.ENTITY_TYPE]: isAction ? "chat-action" : "chat-turn",
                         };
-                        if (lastUserMessage) {
+                        if (lastUserMessage && recordUserMessage) {
                             turnAttributes["chat.user_message"] = lastUserMessage;
                             // Show a truncated preview of the user message as an accessory
                             const preview = lastUserMessage.length > 80
@@ -4993,7 +4994,7 @@ function chatAgent(options) {
                                 style: "codepath",
                             }));
                         }
-                        if (wireMetadata !== undefined) {
+                        if (wireMetadata !== undefined && recordClientData) {
                             turnAttributes["chat.client_data"] =
                                 typeof wireMetadata === "string" ? wireMetadata : JSON.stringify(wireMetadata);
                         }
@@ -5018,6 +5019,7 @@ function chatAgent(options) {
                                 turn,
                                 continuation,
                                 clientData,
+                                recordUserMessage,
                             });
                             // Resolve the per-turn `tools` set now that turn context
                             // (incl. parsed clientData) exists, so every toModelMessages