@trigger.dev/core 0.0.0-python-preview-20250226140121 → 0.0.0-rc-4-8-0-20261021151928

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

@@ -0,0 +1,266 @@
+import { z } from "zod/v4";
+import { discriminatedUnion } from "../utils/zod.js";
+/**
+ * Request body schema for executing a query
+ */
+export const QueryExecuteRequestBody = z.object({
+    query: z.string(),
+    scope: z.enum(["organization", "project", "environment"]).default("environment"),
+    period: z.string().nullish(),
+    from: z.string().nullish(),
+    to: z.string().nullish(),
+    format: z.enum(["json", "csv"]).default("json"),
+});
+/**
+ * Response body schema for JSON format queries
+ */
+export const QueryExecuteJSONResponseBody = z.object({
+    format: z.literal("json"),
+    results: z.array(z.record(z.string(), z.any())),
+});
+/**
+ * Response body type for CSV format queries
+ */
+export const QueryExecuteCSVResponseBody = z.object({
+    format: z.literal("csv"),
+    results: z.string(),
+});
+export const QueryExecuteResponseBody = discriminatedUnion("format", [
+    QueryExecuteJSONResponseBody,
+    QueryExecuteCSVResponseBody,
+]);
+// ---------------------------------------------------------------------------
+// Query schema discovery types
+// ---------------------------------------------------------------------------
+/**
+ * Schema for a single column in the query schema response
+ */
+export const QuerySchemaColumn = z.object({
+    name: z.string(),
+    type: z.string(),
+    description: z.string().optional(),
+    example: z.string().optional(),
+    allowedValues: z.array(z.string()).optional(),
+    coreColumn: z.boolean().optional(),
+});
+/**
+ * Schema for a single table in the query schema response
+ */
+export const QuerySchemaTable = z.object({
+    name: z.string(),
+    description: z.string().optional(),
+    timeColumn: z.string().optional(),
+    columns: z.array(QuerySchemaColumn),
+});
+/**
+ * Response body for the query schema endpoint
+ */
+export const QuerySchemaResponseBody = z.object({
+    tables: z.array(QuerySchemaTable),
+});
+// ---------------------------------------------------------------------------
+// Dashboard types
+// ---------------------------------------------------------------------------
+/**
+ * Summary of a widget in a dashboard (for listing)
+ */
+export const DashboardWidgetSummary = z.object({
+    id: z.string(),
+    title: z.string(),
+    query: z.string(),
+    type: z.enum(["bignumber", "chart", "table", "title"]),
+});
+/**
+ * Summary of a dashboard (for listing)
+ */
+export const DashboardSummary = z.object({
+    key: z.string(),
+    title: z.string(),
+    /** `builtIn` dashboards are read-only; `custom` dashboards can be edited through the API */
+    type: z.enum(["builtIn", "custom"]).optional(),
+    description: z.string().optional(),
+    widgets: z.array(DashboardWidgetSummary),
+});
+/**
+ * Response body for listing dashboards
+ */
+export const ListDashboardsResponseBody = z.object({
+    dashboards: z.array(DashboardSummary),
+});
+export const DashboardChartType = z.enum(["bar", "line"]);
+export const DashboardSortDirection = z.enum(["asc", "desc"]);
+export const DashboardChartAggregation = z.enum(["sum", "avg", "count", "min", "max"]);
+export const DashboardBigNumberAggregation = z.enum([
+    "sum",
+    "avg",
+    "count",
+    "min",
+    "max",
+    "first",
+    "last",
+]);
+export const DashboardChartConfig = z.object({
+    chartType: DashboardChartType,
+    xAxisColumn: z.string().nullable(),
+    yAxisColumns: z.string().array(),
+    groupByColumn: z.string().nullable(),
+    stacked: z.boolean(),
+    sortByColumn: z.string().nullable(),
+    sortDirection: DashboardSortDirection,
+    aggregation: DashboardChartAggregation,
+    seriesColors: z.record(z.string(), z.string()).optional(),
+});
+export const DashboardBigNumberConfig = z.object({
+    column: z.string(),
+    aggregation: DashboardBigNumberAggregation,
+    sortDirection: DashboardSortDirection.optional(),
+    abbreviate: z.boolean().default(false),
+    prefix: z.string().optional(),
+    suffix: z.string().optional(),
+});
+/**
+ * How a dashboard widget renders its query results.
+ */
+export const DashboardWidgetDisplay = discriminatedUnion("type", [
+    z.object({
+        type: z.literal("table"),
+        prettyFormatting: z.boolean().default(true),
+        sorting: z.array(z.object({ desc: z.boolean(), id: z.string() })).default([]),
+    }),
+    DashboardChartConfig.extend({ type: z.literal("chart") }),
+    DashboardBigNumberConfig.extend({ type: z.literal("bignumber") }),
+    z.object({ type: z.literal("title") }),
+]);
+/**
+ * A widget's position on the dashboard's 12-column grid.
+ */
+export const DashboardLayoutItem = z.object({
+    i: z.string(),
+    x: z.number(),
+    y: z.number(),
+    w: z.number(),
+    h: z.number(),
+    minH: z.number().optional(),
+    maxH: z.number().optional(),
+});
+export const DashboardStoredWidget = z.object({
+    title: z.string(),
+    query: z.string().default(""),
+    display: DashboardWidgetDisplay,
+    /** Server-side gap fill: carry-forward for gauges, zero-fill for counters. */
+    fillGaps: z.boolean().optional(),
+});
+/**
+ * The stored definition of a dashboard: every widget and its grid position.
+ */
+export const DashboardDefinition = discriminatedUnion("version", [
+    z.object({
+        version: z.literal("1"),
+        layout: z.array(DashboardLayoutItem),
+        widgets: z.record(z.string(), DashboardStoredWidget),
+    }),
+]);
+export const DashboardWidgetPosition = z.object({
+    x: z.number().int().min(0).max(11),
+    y: z.number().int().min(0),
+    w: z.number().int().min(1).max(12),
+    h: z.number().int().min(1),
+});
+/**
+ * A widget as the dashboards API reads and writes it.
+ */
+export const DashboardWidget = z.object({
+    id: z.string(),
+    title: z.string(),
+    query: z.string(),
+    display: DashboardWidgetDisplay,
+    fillGaps: z.boolean().optional(),
+    position: DashboardWidgetPosition,
+});
+/**
+ * A custom dashboard as the dashboards API returns it.
+ */
+export const DashboardObject = z.object({
+    id: z.string(),
+    title: z.string(),
+    description: z.string(),
+    /** Changes on every write. Send it back as `revision` to reject a write that would overwrite someone else's change. */
+    revision: z.string(),
+    createdAt: z.coerce.date(),
+    updatedAt: z.coerce.date(),
+    widgets: z.array(DashboardWidget),
+});
+const DashboardWidgetTitle = z.string().trim().min(1).max(200);
+export const DashboardWidgetInput = z.strictObject({
+    /** Omit to generate one. Must be unique within the dashboard. */
+    id: z
+        .string()
+        .regex(/^[A-Za-z0-9_-]{1,64}$/, "id may only contain letters, numbers, _ and -")
+        .optional(),
+    title: DashboardWidgetTitle,
+    /** A TRQL query. Required unless `display.type` is `title`. */
+    query: z.string().default(""),
+    display: DashboardWidgetDisplay,
+    fillGaps: z.boolean().optional(),
+    /** Omit to place the widget full width below the existing widgets. */
+    position: DashboardWidgetPosition.optional(),
+});
+const DashboardTitle = z.string().trim().min(1).max(200);
+const DashboardDescription = z.string().max(2000);
+export const CreateDashboardRequestBody = z.strictObject({
+    title: DashboardTitle,
+    description: DashboardDescription.optional(),
+    widgets: z.array(DashboardWidgetInput).optional(),
+});
+export const UpdateDashboardRequestBody = z.strictObject({
+    title: DashboardTitle.optional(),
+    description: DashboardDescription.optional(),
+    revision: z.string().optional(),
+});
+export const ReplaceDashboardRequestBody = z.strictObject({
+    title: DashboardTitle.optional(),
+    description: DashboardDescription.optional(),
+    widgets: z.array(DashboardWidgetInput),
+    revision: z.string().optional(),
+});
+export const AddDashboardWidgetRequestBody = DashboardWidgetInput.extend({
+    revision: z.string().optional(),
+});
+export const UpdateDashboardWidgetRequestBody = z.strictObject({
+    title: DashboardWidgetTitle.optional(),
+    query: z.string().optional(),
+    display: DashboardWidgetDisplay.optional(),
+    fillGaps: z.boolean().optional(),
+    position: DashboardWidgetPosition.optional(),
+    revision: z.string().optional(),
+});
+export const AddDashboardWidgetResponseBody = z.object({
+    widgetId: z.string(),
+    dashboard: DashboardObject,
+});
+export const DeleteDashboardResponseBody = z.object({ id: z.string() });
+// ---------------------------------------------------------------------------
+// Query table row types
+// ---------------------------------------------------------------------------
+/**
+ * User-facing friendly run status values returned by the query system.
+ */
+export const runFriendlyStatus = [
+    "Delayed",
+    "Queued",
+    "Pending version",
+    "Dequeued",
+    "Executing",
+    "Waiting",
+    "Reattempting",
+    "Paused",
+    "Canceled",
+    "Interrupted",
+    "Completed",
+    "Failed",
+    "System failure",
+    "Crashed",
+    "Expired",
+    "Timed out",
+];
+//# sourceMappingURL=query.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../../../../src/v3/schemas/query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAC3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAIrD;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;IAChF,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IAC5B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IAC1B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IACxB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;CAChD,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACzB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;CAChD,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IACxB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,wBAAwB,GAAG,kBAAkB,CAAC,QAAQ,EAAE;IACnE,4BAA4B;IAC5B,2BAA2B;CAC5B,CAAC,CAAC;AAGH,8EAA8E;AAC9E,+BAA+B;AAC/B,8EAA8E;AAE9E;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC7C,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC;CACpC,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;CAClC,CAAC,CAAC;AAIH,8EAA8E;AAC9E,kBAAkB;AAClB,8EAA8E;AAE9E;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;CACvD,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,4FAA4F;IAC5F,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC9C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC;CACzC,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;CACtC,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AAG1D,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AAG9D,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;AAGvF,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,IAAI,CAAC;IAClD,KAAK;IACL,KAAK;IACL,OAAO;IACP,KAAK;IACL,KAAK;IACL,OAAO;IACP,MAAM;CACP,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,SAAS,EAAE,kBAAkB;IAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE;IAChC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,aAAa,EAAE,sBAAsB;IACrC,WAAW,EAAE,yBAAyB;IACtC,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC1D,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,WAAW,EAAE,6BAA6B;IAC1C,aAAa,EAAE,sBAAsB,CAAC,QAAQ,EAAE;IAChD,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACtC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,kBAAkB,CAAC,MAAM,EAAE;IAC/D,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QACxB,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;QAC3C,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;KAC9E,CAAC;IACF,oBAAoB,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;IACzD,wBAAwB,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;IACjE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;CACvC,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IACb,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IACb,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IACb,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IACb,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IACb,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC7B,OAAO,EAAE,sBAAsB;IAC/B,8EAA8E;IAC9E,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,SAAS,EAAE;IAC/D,CAAC,CAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;QACvB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC;QACpC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,qBAAqB,CAAC;KACrD,CAAC;CACH,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IAClC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1B,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IAClC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CAC3B,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,sBAAsB;IAC/B,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,QAAQ,EAAE,uBAAuB;CAClC,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,uHAAuH;IACvH,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE;IAC1B,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE;IAC1B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;CAClC,CAAC,CAAC;AAGH,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAE/D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,YAAY,CAAC;IACjD,iEAAiE;IACjE,EAAE,EAAE,CAAC;SACF,MAAM,EAAE;SACR,KAAK,CAAC,uBAAuB,EAAE,+CAA+C,CAAC;SAC/E,QAAQ,EAAE;IACb,KAAK,EAAE,oBAAoB;IAC3B,+DAA+D;IAC/D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC7B,OAAO,EAAE,sBAAsB;IAC/B,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,sEAAsE;IACtE,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC;AAGH,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACzD,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAElD,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,YAAY,CAAC;IACvD,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IAC5C,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,QAAQ,EAAE;CAClD,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,YAAY,CAAC;IACvD,KAAK,EAAE,cAAc,CAAC,QAAQ,EAAE;IAChC,WAAW,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IAC5C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,YAAY,CAAC;IACxD,KAAK,EAAE,cAAc,CAAC,QAAQ,EAAE;IAChC,WAAW,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IAC5C,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;IACtC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,6BAA6B,GAAG,oBAAoB,CAAC,MAAM,CAAC;IACvE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,YAAY,CAAC;IAC7D,KAAK,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IACtC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,OAAO,EAAE,sBAAsB,CAAC,QAAQ,EAAE;IAC1C,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,EAAE;IAC5C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,eAAe;CAC3B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAGxE,8EAA8E;AAC9E,wBAAwB;AACxB,8EAA8E;AAE9E;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,SAAS;IACT,QAAQ;IACR,iBAAiB;IACjB,UAAU;IACV,WAAW;IACX,SAAS;IACT,cAAc;IACd,QAAQ;IACR,UAAU;IACV,aAAa;IACb,WAAW;IACX,QAAQ;IACR,gBAAgB;IAChB,SAAS;IACT,SAAS;IACT,WAAW;CACH,CAAC"}

package/dist/esm/v3/schemas/queues.d.ts

@@ -0,0 +1,271 @@
+import { z } from "zod/v4";
+/**
+ * The type of queue, either "task" or "custom"
+ * "task" are created automatically for each task.
+ * "custom" are created by you explicitly in your code.
+ * */
+export declare const QueueType: z.ZodEnum<{
+    custom: "custom";
+    task: "task";
+}>;
+export type QueueType = z.infer<typeof QueueType>;
+export declare const RetrieveQueueType: z.ZodEnum<{
+    custom: "custom";
+    id: "id";
+    task: "task";
+}>;
+export type RetrieveQueueType = z.infer<typeof RetrieveQueueType>;
+/**
+ * The queue's `version` discriminates its shape. V1 queues carry their own
+ * concurrency limit (applied per key when runs pass a `concurrencyKey`, to the
+ * whole queue when they don't) and its override state. V2 queues are only the
+ * line runs wait in: concurrency is declared with the task `concurrency`
+ * option and read or overridden through `concurrencyLimits`. A response from a
+ * server that predates the discriminator has V1 semantics by definition, so a
+ * missing `version` defaults to "V1" rather than failing the parse.
+ */
+declare const QueueItemUnion: import("../utils/zod.js").CompatibleZodDiscriminatedUnion<readonly [z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodEnum<{
+        custom: "custom";
+        task: "task";
+    }>;
+    running: z.ZodNumber;
+    queued: z.ZodNumber;
+    paused: z.ZodBoolean;
+    concurrencyLimit: z.ZodNullable<z.ZodNumber>;
+    version: z.ZodLiteral<"V1">;
+    concurrency: z.ZodOptional<z.ZodObject<{
+        current: z.ZodNullable<z.ZodNumber>;
+        base: z.ZodNullable<z.ZodNumber>;
+        override: z.ZodNullable<z.ZodNumber>;
+        overriddenAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+        overriddenBy: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodEnum<{
+        custom: "custom";
+        task: "task";
+    }>;
+    running: z.ZodNumber;
+    queued: z.ZodNumber;
+    paused: z.ZodBoolean;
+    concurrencyLimit: z.ZodNullable<z.ZodNumber>;
+    version: z.ZodLiteral<"V2">;
+    concurrency: z.ZodOptional<z.ZodUndefined>;
+}, z.core.$strip>]>;
+export declare const QueueItem: z.ZodType<{
+    id: string;
+    name: string;
+    type: "custom" | "task";
+    running: number;
+    queued: number;
+    paused: boolean;
+    concurrencyLimit: number | null;
+    version: "V1";
+    concurrency?: {
+        current: number | null;
+        base: number | null;
+        override: number | null;
+        overriddenAt: Date | null;
+        overriddenBy: string | null;
+    } | undefined;
+} | {
+    id: string;
+    name: string;
+    type: "custom" | "task";
+    running: number;
+    queued: number;
+    paused: boolean;
+    concurrencyLimit: number | null;
+    version: "V2";
+    concurrency?: undefined;
+}, unknown, z.core.$ZodTypeInternals<{
+    id: string;
+    name: string;
+    type: "custom" | "task";
+    running: number;
+    queued: number;
+    paused: boolean;
+    concurrencyLimit: number | null;
+    version: "V1";
+    concurrency?: {
+        current: number | null;
+        base: number | null;
+        override: number | null;
+        overriddenAt: Date | null;
+        overriddenBy: string | null;
+    } | undefined;
+} | {
+    id: string;
+    name: string;
+    type: "custom" | "task";
+    running: number;
+    queued: number;
+    paused: boolean;
+    concurrencyLimit: number | null;
+    version: "V2";
+    concurrency?: undefined;
+}, unknown>>;
+export type QueueItem = z.infer<typeof QueueItemUnion>;
+export declare const ListQueueOptions: z.ZodObject<{
+    page: z.ZodOptional<z.ZodNumber>;
+    perPage: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type ListQueueOptions = z.infer<typeof ListQueueOptions>;
+export declare const QueueTypeName: z.ZodObject<{
+    type: z.ZodEnum<{
+        custom: "custom";
+        task: "task";
+    }>;
+    name: z.ZodString;
+}, z.core.$strip>;
+export type QueueTypeName = z.infer<typeof QueueTypeName>;
+/**
+ * When retrieving a queue you can either use the queue id,
+ * or the type and name.
+ *
+ * @example
+ *
+ * ```ts
+ * // Use a queue id (they start with queue_
+ * const q1 = await queues.retrieve("queue_12345");
+ *
+ * // Or use the type and name
+ * // The default queue for your "my-task-id"
+ * const q2 = await queues.retrieve({ type: "task", name: "my-task-id"});
+ *
+ * // The custom queue you defined in your code
+ * const q3 = await queues.retrieve({ type: "custom", name: "my-custom-queue" });
+ * ```
+ */
+export declare const RetrieveQueueParam: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+    type: z.ZodEnum<{
+        custom: "custom";
+        task: "task";
+    }>;
+    name: z.ZodString;
+}, z.core.$strip>]>;
+export type RetrieveQueueParam = z.infer<typeof RetrieveQueueParam>;
+/** One bound of a concurrency limit: the enforced value, the declared base, and
+ * any active override. `current` is the cap this bound enforces right now (the
+ * stored value clamped to the environment concurrency limit). Pausing an
+ * environment or queue stops dequeues without changing its configured bounds,
+ * so pause state is reported separately, never as a `current` of 0. */
+export declare const ConcurrencyLimitBound: z.ZodObject<{
+    current: z.ZodNullable<z.ZodNumber>;
+    base: z.ZodNullable<z.ZodNumber>;
+    override: z.ZodNullable<z.ZodNumber>;
+    overriddenAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+}, z.core.$strip>;
+export type ConcurrencyLimitBound = z.infer<typeof ConcurrencyLimitBound>;
+export declare const ConcurrencyLimitItem: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    perKey: z.ZodObject<{
+        current: z.ZodNullable<z.ZodNumber>;
+        base: z.ZodNullable<z.ZodNumber>;
+        override: z.ZodNullable<z.ZodNumber>;
+        overriddenAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    }, z.core.$strip>;
+    total: z.ZodObject<{
+        current: z.ZodNullable<z.ZodNumber>;
+        base: z.ZodNullable<z.ZodNumber>;
+        override: z.ZodNullable<z.ZodNumber>;
+        overriddenAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    }, z.core.$strip>;
+    running: z.ZodNumber;
+    queued: z.ZodNumber;
+    paused: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+export type ConcurrencyLimitItem = z.infer<typeof ConcurrencyLimitItem>;
+export declare const ListConcurrencyLimitOptions: z.ZodObject<{
+    page: z.ZodOptional<z.ZodNumber>;
+    perPage: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type ListConcurrencyLimitOptions = z.infer<typeof ListConcurrencyLimitOptions>;
+/** Changes only the given bounds of the limit itself. Zero blocks every run holding
+ * the limit, which is how a limit is paused; `reset` restores the declared values. */
+export declare const OverrideConcurrencyLimitBoundsBody: z.ZodObject<{
+    perKey: z.ZodOptional<z.ZodNumber>;
+    total: z.ZodOptional<z.ZodNumber>;
+    concurrencyKey: z.ZodOptional<z.ZodNever>;
+    ttl: z.ZodOptional<z.ZodNever>;
+}, z.core.$strip>;
+export type OverrideConcurrencyLimitBoundsBody = z.infer<typeof OverrideConcurrencyLimitBoundsBody>;
+/** A temporary per-key cap on this limit's `perKey` for one concurrencyKey: `0`
+ * blocks the key, and the override expires after `ttl` (a duration such as `"7d"`
+ * or a number of seconds; default 7 days, at most 30 days). `total` is not per key,
+ * so it cannot be given here. `reset` with the same `concurrencyKey` clears it. */
+export declare const OverrideConcurrencyLimitKeyBody: z.ZodObject<{
+    concurrencyKey: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>;
+    perKey: z.ZodNumber;
+    ttl: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    total: z.ZodOptional<z.ZodNever>;
+}, z.core.$strip>;
+export type OverrideConcurrencyLimitKeyBody = z.infer<typeof OverrideConcurrencyLimitKeyBody>;
+/** Either the limit's own bounds or a per-key cap, told apart by `concurrencyKey`.
+ * The output type is the union of the two shapes above, so `total` with a key, a key
+ * without `perKey`, and `ttl` without a key are type errors for SDK callers. Parsing
+ * goes through one flat object with cross-field checks rather than a `z.union`, so an
+ * HTTP caller gets a single message naming the field at fault instead of the failures
+ * of both branches. */
+export declare const OverrideConcurrencyLimitRequestBody: z.ZodPipe<z.ZodObject<{
+    perKey: z.ZodOptional<z.ZodNumber>;
+    total: z.ZodOptional<z.ZodNumber>;
+    concurrencyKey: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>>;
+    ttl: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+}, z.core.$strip>, z.ZodTransform<{
+    perKey?: number | undefined;
+    total?: number | undefined;
+    concurrencyKey?: undefined;
+    ttl?: undefined;
+} | {
+    concurrencyKey: string;
+    perKey: number;
+    ttl?: string | number | undefined;
+    total?: undefined;
+}, {
+    perKey?: number | undefined;
+    total?: number | undefined;
+    concurrencyKey?: string | undefined;
+    ttl?: string | number | undefined;
+}>>;
+export type OverrideConcurrencyLimitRequestBody = z.infer<typeof OverrideConcurrencyLimitRequestBody>;
+/** `reset` with a `concurrencyKey` clears that key's override and leaves the limit
+ * itself alone; without one it resets the limit's own override. */
+export declare const ResetConcurrencyLimitRequestBody: z.ZodObject<{
+    concurrencyKey: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>>;
+}, z.core.$strip>;
+export type ResetConcurrencyLimitRequestBody = z.infer<typeof ResetConcurrencyLimitRequestBody>;
+export declare const RetrieveConcurrencyLimitOptions: z.ZodObject<{
+    concurrencyKey: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>, z.ZodString>>;
+}, z.core.$strip>;
+export type RetrieveConcurrencyLimitOptions = z.infer<typeof RetrieveConcurrencyLimitOptions>;
+/** The per-key bound of a limit for one concurrencyKey: `base` is the limit's own
+ * `perKey` as enforced, `override` the key's temporary cap, `current` whichever
+ * applies right now (env-clamped). A paused limit still reports its bounds. */
+export declare const ConcurrencyLimitKeyBound: z.ZodObject<{
+    current: z.ZodNullable<z.ZodNumber>;
+    base: z.ZodNullable<z.ZodNumber>;
+    override: z.ZodNullable<z.ZodNumber>;
+    expiresAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+}, z.core.$strip>;
+export type ConcurrencyLimitKeyBound = z.infer<typeof ConcurrencyLimitKeyBound>;
+export declare const ConcurrencyLimitKeyItem: z.ZodObject<{
+    name: z.ZodString;
+    concurrencyKey: z.ZodString;
+    perKey: z.ZodObject<{
+        current: z.ZodNullable<z.ZodNumber>;
+        base: z.ZodNullable<z.ZodNumber>;
+        override: z.ZodNullable<z.ZodNumber>;
+        expiresAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    }, z.core.$strip>;
+    running: z.ZodNumber;
+    paused: z.ZodBoolean;
+}, z.core.$strip>;
+export type ConcurrencyLimitKeyItem = z.infer<typeof ConcurrencyLimitKeyItem>;
+export {};