trigger.dev/dist/esm/mcp/schemas.d.ts

A Command-Line Interface for Trigger.dev projects

import { ReportPeriodSchema } from "@trigger.dev/core/v3/schemas";
import { z } from "zod";
export declare const CreateProjectInOrgInput: z.ZodObject<{
    orgParam: z.ZodString;
    name: z.ZodString;
}, z.core.$strip>;
export type CreateProjectInOrgInput = z.output<typeof CreateProjectInOrgInput>;
export declare const InitializeProjectInput: z.ZodObject<{
    orgParam: z.ZodString;
    projectRef: z.ZodOptional<z.ZodString>;
    projectName: z.ZodString;
    cwd: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
export type InitializeProjectInput = z.output<typeof InitializeProjectInput>;
export declare const CommonProjectsInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
export type CommonProjectsInput = z.output<typeof CommonProjectsInput>;
export declare const TriggerTaskInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    taskId: z.ZodString;
    payload: z.ZodAny;
    options: z.ZodOptional<z.ZodObject<{
        queue: z.ZodOptional<z.ZodObject<{
            name: z.ZodString;
        }, z.core.$strip>>;
        delay: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodISODateTime]>>;
        idempotencyKey: z.ZodOptional<z.ZodString>;
        machine: z.ZodOptional<z.ZodEnum<{
            "large-1x": "large-1x";
            "large-2x": "large-2x";
            "medium-1x": "medium-1x";
            "medium-2x": "medium-2x";
            micro: "micro";
            "small-1x": "small-1x";
            "small-2x": "small-2x";
        }>>;
        maxAttempts: z.ZodOptional<z.ZodNumber>;
        maxDuration: z.ZodOptional<z.ZodNumber>;
        region: z.ZodOptional<z.ZodString>;
        tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
        ttl: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
    }, z.core.$strip>>;
}, z.core.$strip>;
export type TriggerTaskInput = z.output<typeof TriggerTaskInput>;
export declare const CommonRunsInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    runId: z.ZodString;
}, z.core.$strip>;
export type CommonRunsInput = z.output<typeof CommonRunsInput>;
export declare const ReplayRunInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    runId: z.ZodString;
    payload: z.ZodOptional<z.ZodAny>;
    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
    queue: z.ZodOptional<z.ZodString>;
    concurrencyKey: z.ZodOptional<z.ZodString>;
    machine: z.ZodOptional<z.ZodEnum<{
        "large-1x": "large-1x";
        "large-2x": "large-2x";
        "medium-1x": "medium-1x";
        "medium-2x": "medium-2x";
        micro: "micro";
        "small-1x": "small-1x";
        "small-2x": "small-2x";
    }>>;
    version: z.ZodOptional<z.ZodString>;
    region: z.ZodOptional<z.ZodString>;
    delay: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodISODateTime]>>;
    ttl: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
    idempotencyKey: z.ZodOptional<z.ZodString>;
    maxAttempts: z.ZodOptional<z.ZodNumber>;
    maxDuration: z.ZodOptional<z.ZodNumber>;
    priority: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>;
export type ReplayRunInput = z.output<typeof ReplayRunInput>;
export declare const WaitForRunInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    runId: z.ZodString;
    timeoutInSeconds: z.ZodDefault<z.ZodNumber>;
}, z.core.$strip>;
export type WaitForRunInput = z.output<typeof WaitForRunInput>;
export declare const GetRunDetailsInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    runId: z.ZodString;
    maxTraceLines: z.ZodDefault<z.ZodNumber>;
    cursor: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
export type GetRunDetailsInput = z.output<typeof GetRunDetailsInput>;
export declare const GetSpanDetailsInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    runId: z.ZodString;
    spanId: z.ZodString;
}, z.core.$strip>;
export type GetSpanDetailsInput = z.output<typeof GetSpanDetailsInput>;
export declare const ListRunsInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    cursor: z.ZodOptional<z.ZodString>;
    limit: z.ZodOptional<z.ZodNumber>;
    status: z.ZodOptional<z.ZodEnum<{
        CANCELED: "CANCELED";
        COMPLETED: "COMPLETED";
        CRASHED: "CRASHED";
        DELAYED: "DELAYED";
        DEQUEUED: "DEQUEUED";
        EXECUTING: "EXECUTING";
        EXPIRED: "EXPIRED";
        FAILED: "FAILED";
        PENDING_VERSION: "PENDING_VERSION";
        QUEUED: "QUEUED";
        SYSTEM_FAILURE: "SYSTEM_FAILURE";
        TIMED_OUT: "TIMED_OUT";
        WAITING: "WAITING";
    }>>;
    taskIdentifier: z.ZodOptional<z.ZodString>;
    version: z.ZodOptional<z.ZodString>;
    tag: z.ZodOptional<z.ZodString>;
    from: z.ZodOptional<z.ZodString>;
    to: z.ZodOptional<z.ZodString>;
    period: z.ZodOptional<z.ZodString>;
    machine: z.ZodOptional<z.ZodEnum<{
        "large-1x": "large-1x";
        "large-2x": "large-2x";
        "medium-1x": "medium-1x";
        "medium-2x": "medium-2x";
        micro: "micro";
        "small-1x": "small-1x";
        "small-2x": "small-2x";
    }>>;
    region: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
export type ListRunsInput = z.output<typeof ListRunsInput>;
export declare const DeployInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    branch: z.ZodOptional<z.ZodString>;
    environment: z.ZodEnum<{
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>;
    skipPromotion: z.ZodOptional<z.ZodBoolean>;
    skipSyncEnvVars: z.ZodOptional<z.ZodBoolean>;
    skipUpdateCheck: z.ZodOptional<z.ZodBoolean>;
}, z.core.$strip>;
export type DeployInput = z.output<typeof DeployInput>;
export declare const ListDeploysInput: z.ZodObject<{
    from: z.ZodOptional<z.ZodString>;
    to: z.ZodOptional<z.ZodString>;
    period: z.ZodOptional<z.ZodString>;
    status: z.ZodOptional<z.ZodEnum<{
        BUILDING: "BUILDING";
        CANCELED: "CANCELED";
        DEPLOYED: "DEPLOYED";
        DEPLOYING: "DEPLOYING";
        FAILED: "FAILED";
        PENDING: "PENDING";
        TIMED_OUT: "TIMED_OUT";
    }>>;
    cursor: z.ZodOptional<z.ZodString>;
    limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    branch: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
}, z.core.$strip>;
export type ListDeploysInput = z.output<typeof ListDeploysInput>;
export declare const QueryInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    query: z.ZodString;
    scope: z.ZodDefault<z.ZodEnum<{
        environment: "environment";
        organization: "organization";
        project: "project";
    }>>;
    period: z.ZodOptional<z.ZodString>;
    from: z.ZodOptional<z.ZodString>;
    to: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
export type QueryInput = z.output<typeof QueryInput>;
export declare const QuerySchemaInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    table: z.ZodString;
}, z.core.$strip>;
export type QuerySchemaInput = z.output<typeof QuerySchemaInput>;
export declare const ListDashboardsInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
export type ListDashboardsInput = z.output<typeof ListDashboardsInput>;
export declare const CreateDashboardInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    title: z.ZodString;
    description: z.ZodOptional<z.ZodString>;
    widgets: z.ZodOptional<z.ZodArray<z.ZodObject<{
        id: z.ZodOptional<z.ZodString>;
        title: z.ZodString;
        query: z.ZodDefault<z.ZodString>;
        display: import("@trigger.dev/core/v3/schemas").CompatibleZodDiscriminatedUnion<readonly [z.ZodObject<{
            type: z.ZodLiteral<"table">;
            prettyFormatting: z.ZodDefault<z.ZodBoolean>;
            sorting: z.ZodDefault<z.ZodArray<z.ZodObject<{
                desc: z.ZodBoolean;
                id: z.ZodString;
            }, z.core.$strip>>>;
        }, z.core.$strip>, z.ZodObject<{
            chartType: z.ZodEnum<{
                bar: "bar";
                line: "line";
            }>;
            xAxisColumn: z.ZodNullable<z.ZodString>;
            yAxisColumns: z.ZodArray<z.ZodString>;
            groupByColumn: z.ZodNullable<z.ZodString>;
            stacked: z.ZodBoolean;
            sortByColumn: z.ZodNullable<z.ZodString>;
            sortDirection: z.ZodEnum<{
                asc: "asc";
                desc: "desc";
            }>;
            aggregation: z.ZodEnum<{
                avg: "avg";
                count: "count";
                max: "max";
                min: "min";
                sum: "sum";
            }>;
            seriesColors: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
            type: z.ZodLiteral<"chart">;
        }, z.core.$strip>, z.ZodObject<{
            column: z.ZodString;
            aggregation: z.ZodEnum<{
                avg: "avg";
                count: "count";
                first: "first";
                last: "last";
                max: "max";
                min: "min";
                sum: "sum";
            }>;
            sortDirection: z.ZodOptional<z.ZodEnum<{
                asc: "asc";
                desc: "desc";
            }>>;
            abbreviate: z.ZodDefault<z.ZodBoolean>;
            prefix: z.ZodOptional<z.ZodString>;
            suffix: z.ZodOptional<z.ZodString>;
            type: z.ZodLiteral<"bignumber">;
        }, z.core.$strip>, z.ZodObject<{
            type: z.ZodLiteral<"title">;
        }, z.core.$strip>]>;
        fillGaps: z.ZodOptional<z.ZodBoolean>;
        position: z.ZodOptional<z.ZodObject<{
            x: z.ZodNumber;
            y: z.ZodNumber;
            w: z.ZodNumber;
            h: z.ZodNumber;
        }, z.core.$strip>>;
    }, z.core.$strict>>>;
}, z.core.$strip>;
export type CreateDashboardInput = z.output<typeof CreateDashboardInput>;
export declare const SetDashboardWidgetsInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    dashboardId: z.ZodString;
    title: z.ZodOptional<z.ZodString>;
    widgets: z.ZodArray<z.ZodObject<{
        id: z.ZodOptional<z.ZodString>;
        title: z.ZodString;
        query: z.ZodDefault<z.ZodString>;
        display: import("@trigger.dev/core/v3/schemas").CompatibleZodDiscriminatedUnion<readonly [z.ZodObject<{
            type: z.ZodLiteral<"table">;
            prettyFormatting: z.ZodDefault<z.ZodBoolean>;
            sorting: z.ZodDefault<z.ZodArray<z.ZodObject<{
                desc: z.ZodBoolean;
                id: z.ZodString;
            }, z.core.$strip>>>;
        }, z.core.$strip>, z.ZodObject<{
            chartType: z.ZodEnum<{
                bar: "bar";
                line: "line";
            }>;
            xAxisColumn: z.ZodNullable<z.ZodString>;
            yAxisColumns: z.ZodArray<z.ZodString>;
            groupByColumn: z.ZodNullable<z.ZodString>;
            stacked: z.ZodBoolean;
            sortByColumn: z.ZodNullable<z.ZodString>;
            sortDirection: z.ZodEnum<{
                asc: "asc";
                desc: "desc";
            }>;
            aggregation: z.ZodEnum<{
                avg: "avg";
                count: "count";
                max: "max";
                min: "min";
                sum: "sum";
            }>;
            seriesColors: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
            type: z.ZodLiteral<"chart">;
        }, z.core.$strip>, z.ZodObject<{
            column: z.ZodString;
            aggregation: z.ZodEnum<{
                avg: "avg";
                count: "count";
                first: "first";
                last: "last";
                max: "max";
                min: "min";
                sum: "sum";
            }>;
            sortDirection: z.ZodOptional<z.ZodEnum<{
                asc: "asc";
                desc: "desc";
            }>>;
            abbreviate: z.ZodDefault<z.ZodBoolean>;
            prefix: z.ZodOptional<z.ZodString>;
            suffix: z.ZodOptional<z.ZodString>;
            type: z.ZodLiteral<"bignumber">;
        }, z.core.$strip>, z.ZodObject<{
            type: z.ZodLiteral<"title">;
        }, z.core.$strip>]>;
        fillGaps: z.ZodOptional<z.ZodBoolean>;
        position: z.ZodOptional<z.ZodObject<{
            x: z.ZodNumber;
            y: z.ZodNumber;
            w: z.ZodNumber;
            h: z.ZodNumber;
        }, z.core.$strip>>;
    }, z.core.$strict>>;
}, z.core.$strip>;
export type SetDashboardWidgetsInput = z.output<typeof SetDashboardWidgetsInput>;
export { ReportPeriodSchema };
export declare const GetReportInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    key: z.ZodEnum<{
        health: "health";
    }>;
    period: z.ZodOptional<z.ZodString>;
    color: z.ZodOptional<z.ZodBoolean>;
}, z.core.$strip>;
export type GetReportInput = z.output<typeof GetReportInput>;
export declare const RunDashboardQueryInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    dashboardKey: z.ZodString;
    widgetId: z.ZodString;
    period: z.ZodOptional<z.ZodString>;
    from: z.ZodOptional<z.ZodString>;
    to: z.ZodOptional<z.ZodString>;
    scope: z.ZodDefault<z.ZodEnum<{
        environment: "environment";
        organization: "organization";
        project: "project";
    }>>;
}, z.core.$strip>;
export type RunDashboardQueryInput = z.output<typeof RunDashboardQueryInput>;
export declare const ListPreviewBranchesInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
export type ListPreviewBranchesInput = z.output<typeof ListPreviewBranchesInput>;
export declare const ListAlertCapabilitiesInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    area: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
export type ListAlertCapabilitiesInput = z.output<typeof ListAlertCapabilitiesInput>;
export declare const ListAlertsInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    lifecycle: z.ZodOptional<z.ZodEnum<{
        active: "active";
        completed: "completed";
        expired: "expired";
        stopped: "stopped";
    }>>;
    attention: z.ZodOptional<z.ZodEnum<{
        clear: "clear";
        needs_attention: "needs_attention";
    }>>;
}, z.core.$strip>;
export type ListAlertsInput = z.output<typeof ListAlertsInput>;
export declare const CreateAlertInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    capabilityKey: z.ZodString;
    params: z.ZodObject<{
        scope: z.ZodOptional<z.ZodObject<{
            type: z.ZodEnum<{
                all: "all";
                errorGroup: "errorGroup";
                queue: "queue";
                queuePattern: "queuePattern";
                task: "task";
            }>;
            queue: z.ZodOptional<z.ZodString>;
            pattern: z.ZodOptional<z.ZodString>;
            taskIdentifier: z.ZodOptional<z.ZodString>;
            fingerprint: z.ZodOptional<z.ZodString>;
        }, z.core.$strip>>;
        windowSec: z.ZodOptional<z.ZodNumber>;
    }, z.core.$strip>;
    condition: z.ZodDiscriminatedUnion<[z.ZodObject<{
        kind: z.ZodLiteral<"threshold">;
        operator: z.ZodEnum<{
            "<": "<";
            ">": ">";
        }>;
        value: z.ZodNumber;
        windowSec: z.ZodNumber;
        holdSec: z.ZodOptional<z.ZodNumber>;
    }, z.core.$strip>, z.ZodObject<{
        kind: z.ZodLiteral<"state">;
        stateKey: z.ZodString;
        holdSec: z.ZodOptional<z.ZodNumber>;
        params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
    }, z.core.$strip>, z.ZodObject<{
        kind: z.ZodLiteral<"occurrence">;
    }, z.core.$strip>, z.ZodObject<{
        kind: z.ZodLiteral<"absence">;
        quietWindowSec: z.ZodNumber;
    }, z.core.$strip>], "kind">;
    behavior: z.ZodObject<{
        expiresAt: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>;
    notifiers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
        type: z.ZodLiteral<"channel">;
        channelId: z.ZodString;
    }, z.core.$strip>, z.ZodObject<{
        type: z.ZodLiteral<"chat">;
        chatId: z.ZodString;
        userId: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>], "type">>;
    name: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
export type CreateAlertInput = z.output<typeof CreateAlertInput>;
export declare const ResolveAlertInput: z.ZodObject<{
    projectRef: z.ZodOptional<z.ZodString>;
    configPath: z.ZodOptional<z.ZodString>;
    environment: z.ZodDefault<z.ZodEnum<{
        dev: "dev";
        preview: "preview";
        prod: "prod";
        staging: "staging";
    }>>;
    branch: z.ZodOptional<z.ZodString>;
    alertId: z.ZodString;
}, z.core.$strip>;
export type ResolveAlertInput = z.output<typeof ResolveAlertInput>;