trigger.dev 0.0.0-v3-prerelease-20250108142426 → 0.0.0-v4-prerelease-20250916125920

package/README.md

@@ -1,10 +1,30 @@
+<div align="center">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/a45d1fa2-0ae8-4a39-4409-f4f934bfae00/public">
+  <source media="(prefers-color-scheme: light)" srcset="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/3f5ad4c1-c4c8-4277-b622-290e7f37bd00/public">
+  <img alt="Trigger.dev logo" src="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/a45d1fa2-0ae8-4a39-4409-f4f934bfae00/public">
+</picture>
+
+[![npm version](https://img.shields.io/npm/v/trigger.dev.svg)](https://www.npmjs.com/package/trigger.dev)
+[![npm downloads](https://img.shields.io/npm/dm/trigger.dev.svg)](https://www.npmjs.com/package/trigger.dev)
+[![GitHub stars](https://img.shields.io/github/stars/triggerdotdev/trigger.dev?style=social)](https://github.com/triggerdotdev/trigger.dev)
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
+[![License: ](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Open Source](https://img.shields.io/badge/Open%20Source-%E2%9D%A4-red)](https://github.com/triggerdotdev/trigger.dev)
+
+[Discord](https://trigger.dev/discord) | [Website](https://trigger.dev) | [Issues](https://github.com/triggerdotdev/trigger.dev/issues) | [Docs](https://trigger.dev/docs) | [Examples](https://trigger.dev/docs/examples)
+
+</div>
+
 # Trigger.dev CLI
 
 A CLI that allows you to create, run locally and deploy Trigger.dev background tasks.
 
 Note: this only works with Trigger.dev v3 projects and later. For older projects use the [@trigger.dev/cli](https://www.npmjs.com/package/@trigger.dev/cli) package.
 
-Trigger.dev is an open source platform that makes it easy to create event-driven background tasks directly in your existing project.
+## About Trigger.dev
+
+Trigger.dev is an open source platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with full observability, managed queues, and elastic infrastructure which handles the horizontal scaling.
 
 ## Commands
 
@@ -17,8 +37,15 @@ Trigger.dev is an open source platform that makes it easy to create event-driven
 | [whoami](https://trigger.dev/docs/cli-whoami-commands)               | Display the current logged in user and project details.            |
 | [logout](https://trigger.dev/docs/cli-logout-commands)               | Logout of Trigger.dev.                                             |
 | [list-profiles](https://trigger.dev/docs/cli-list-profiles-commands) | List all of your CLI profiles.                                     |
+| [preview archive](https://trigger.dev/docs/cli-preview-archive)      | Archive a preview branch.                                          |
+| [promote](https://trigger.dev/docs/cli-promote-commands)             | Promote a previously deployed version to the current version.      |
+| [switch](https://trigger.dev/docs/cli-switch)                        | Switch between CLI profiles.                                       |
 | [update](https://trigger.dev/docs/cli-update-commands)               | Updates all `@trigger.dev/*` packages to match the CLI version.    |
 
+## CLI documentation
+
+For more information on the CLI, please refer to our [docs](https://trigger.dev/docs/cli-introduction).
+
 ## Support
 
 If you have any questions, please reach out to us on [Discord](https://trigger.dev/discord) and we'll be happy to help.

package/dist/esm/apiClient.d.ts

@@ -1,8 +1,13 @@
-import { CreateBackgroundWorkerRequestBody, InitializeDeploymentRequestBody, StartDeploymentIndexingRequestBody, ImportEnvironmentVariablesRequestBody, FailDeploymentRequestBody, FinalizeDeploymentRequestBody } from "@trigger.dev/core/v3";
+import { CreateBackgroundWorkerRequestBody, DevConfigResponseBody, DevDequeueRequestBody, DevDequeueResponseBody, FailDeploymentRequestBody, FailDeploymentResponseBody, FinalizeDeploymentRequestBody, ImportEnvironmentVariablesRequestBody, InitializeDeploymentRequestBody, StartDeploymentIndexingRequestBody, TriggerTaskRequestBody, UpsertBranchRequestBody, WorkersCreateRequestBody, CreateProjectRequestBody, GetJWTRequestBody } from "@trigger.dev/core/v3";
+import { WorkloadDebugLogRequestBody, WorkloadHeartbeatRequestBody, WorkloadHeartbeatResponseBody, WorkloadRunAttemptCompleteRequestBody, WorkloadRunAttemptCompleteResponseBody, WorkloadRunAttemptStartResponseBody, WorkloadRunLatestSnapshotResponseBody } from "@trigger.dev/core/v3/workers";
+import { ApiResult } from "@trigger.dev/core/v3/zodfetch";
+import { EventSource } from "eventsource";
 export declare class CliApiClient {
     readonly apiURL: string;
     readonly accessToken?: string | undefined;
-    constructor(apiURL: string, accessToken?: string | undefined);
+    readonly branch?: string | undefined;
+    private engineURL;
+    constructor(apiURL: string, accessToken?: string | undefined, branch?: string | undefined);
     createAuthorizationCode(): Promise<ApiResult<{
         url: string;
         authorizationCode: string;
@@ -13,10 +18,15 @@ export declare class CliApiClient {
             obfuscatedToken: string;
         } | null;
     }>>;
-    whoAmI(): Promise<ApiResult<{
+    whoAmI(projectRef?: string): Promise<ApiResult<{
         userId: string;
         email: string;
         dashboardUrl: string;
+        project?: {
+            url: string;
+            name: string;
+            orgTitle: string;
+        } | undefined;
     }>>;
     retrieveExternals(): Promise<ApiResult<{
         externals: string[];
@@ -47,72 +57,55 @@ export declare class CliApiClient {
         };
         externalRef: string;
     }[]>>;
-    createBackgroundWorker(projectRef: string, body: CreateBackgroundWorkerRequestBody): Promise<ApiResult<{
+    getOrgs(): Promise<ApiResult<{
         id: string;
-        version: string;
-        contentHash: string;
-    }>>;
-    createTaskRunAttempt(runFriendlyId: string): Promise<ApiResult<{
-        task: {
-            id: string;
-            filePath: string;
-            exportName: string;
-        };
-        attempt: {
-            number: number;
-            status: string;
-            id: string;
-            startedAt: Date;
-            backgroundWorkerId: string;
-            backgroundWorkerTaskId: string;
-        };
-        run: {
-            payload: string;
+        createdAt: Date;
+        slug: string;
+        title: string;
+    }[]>>;
+    createProject(orgParam: string, body: CreateProjectRequestBody): Promise<ApiResult<{
+        name: string;
+        id: string;
+        createdAt: Date;
+        slug: string;
+        organization: {
             id: string;
-            payloadType: string;
-            tags: string[];
-            isTest: boolean;
             createdAt: Date;
-            startedAt: Date;
-            durationMs: number;
-            costInCents: number;
-            baseCostInCents: number;
-            metadata?: Record<string, import("@trigger.dev/core/schemas").DeserializedJson> | undefined;
-            context?: any;
-            idempotencyKey?: string | undefined;
-            maxAttempts?: number | undefined;
-            version?: string | undefined;
-            maxDuration?: number | undefined;
-        };
-        queue: {
-            name: string;
-            id: string;
-        };
-        environment: {
-            type: "PRODUCTION" | "STAGING" | "DEVELOPMENT" | "PREVIEW";
-            id: string;
             slug: string;
+            title: string;
         };
-        organization: {
-            name: string;
+        externalRef: string;
+    }>>;
+    getWorkerByTag(projectRef: string, envName: string, tagName?: string): Promise<ApiResult<{
+        worker: {
             id: string;
-            slug: string;
+            version: string;
+            tasks: {
+                id: string;
+                createdAt: Date;
+                filePath: string;
+                slug: string;
+                triggerSource: string;
+                payloadSchema?: any;
+            }[];
+            engine?: string | null | undefined;
+            sdkVersion?: string | null | undefined;
+            cliVersion?: string | null | undefined;
         };
-        project: {
-            name: string;
-            id: string;
-            slug: string;
-            ref: string;
+        urls: {
+            runs: string;
         };
-        batch?: {
-            id: string;
-        } | undefined;
-        machine?: {
-            cpu: number;
-            memory: number;
-            name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
-            centsPerMs: number;
-        } | undefined;
+    }>>;
+    getJWT(projectRef: string, envName: string, body: GetJWTRequestBody): Promise<ApiResult<{
+        token: string;
+    }>>;
+    getDevStatus(projectRef: string): Promise<ApiResult<{
+        isConnected: boolean;
+    }>>;
+    createBackgroundWorker(projectRef: string, body: CreateBackgroundWorkerRequestBody): Promise<ApiResult<{
+        id: string;
+        version: string;
+        contentHash: string;
     }>>;
     getProjectEnv({ projectRef, env }: {
         projectRef: string;
@@ -123,6 +116,24 @@ export declare class CliApiClient {
         apiUrl: string;
         projectId: string;
     }>>;
+    upsertBranch(projectRef: string, body: UpsertBranchRequestBody): Promise<ApiResult<{
+        id: string;
+    }>>;
+    archiveBranch(projectRef: string, branch: string): Promise<ApiResult<{
+        branch: {
+            id: string;
+        };
+    }>>;
+    listBranches(projectRef: string): Promise<ApiResult<{
+        branches: {
+            name: string;
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            isPaused: boolean;
+            git?: Record<string, any> | undefined;
+        }[];
+    }>>;
     getEnvironmentVariables(projectRef: string): Promise<ApiResult<{
         variables: Record<string, string>;
     }>>;
@@ -132,15 +143,15 @@ export declare class CliApiClient {
     initializeDeployment(body: InitializeDeploymentRequestBody): Promise<ApiResult<{
         id: string;
         version: string;
+        shortCode: string;
         contentHash: string;
         imageTag: string;
-        shortCode: string;
+        imagePlatform: string;
         externalBuildData?: {
             projectId: string;
             buildId: string;
             buildToken: string;
         } | null | undefined;
-        registryHost?: string | undefined;
     }>>;
     createDeploymentBackgroundWorker(deploymentId: string, body: CreateBackgroundWorkerRequestBody): Promise<ApiResult<{
         id: string;
@@ -150,8 +161,11 @@ export declare class CliApiClient {
     failDeployment(id: string, body: FailDeploymentRequestBody): Promise<ApiResult<{
         id: string;
     }>>;
-    finalizeDeployment(id: string, body: FinalizeDeploymentRequestBody): Promise<ApiResult<{
+    finalizeDeployment(id: string, body: FinalizeDeploymentRequestBody, onLog?: (message: string) => void): Promise<ApiResult<FailDeploymentResponseBody>>;
+    promoteDeployment(version: string): Promise<ApiResult<{
         id: string;
+        version: string;
+        shortCode: string;
     }>>;
     startDeploymentIndexing(deploymentId: string, body: StartDeploymentIndexingRequestBody): Promise<ApiResult<{
         id: string;
@@ -161,19 +175,25 @@ export declare class CliApiClient {
         status: "CANCELED" | "FAILED" | "TIMED_OUT" | "PENDING" | "BUILDING" | "DEPLOYING" | "DEPLOYED";
         id: string;
         version: string;
-        contentHash: string;
         shortCode: string;
+        contentHash: string;
+        imagePlatform: string;
         worker?: {
             id: string;
             version: string;
             tasks: {
                 id: string;
                 filePath: string;
-                exportName: string;
                 slug: string;
+                exportName?: string | undefined;
             }[];
         } | undefined;
         imageReference?: string | null | undefined;
+        externalBuildData?: {
+            projectId: string;
+            buildId: string;
+            buildToken: string;
+        } | null | undefined;
         errorData?: {
             message: string;
             name: string;
@@ -181,12 +201,76 @@ export declare class CliApiClient {
             stderr?: string | undefined;
         } | null | undefined;
     }>>;
+    triggerTaskRun(taskId: string, body?: TriggerTaskRequestBody): Promise<ApiResult<{
+        id: string;
+        isCached?: boolean | undefined;
+    }>>;
+    get dev(): {
+        readonly config: () => Promise<ApiResult<DevConfigResponseBody>>;
+        readonly presenceConnection: () => EventSource;
+        readonly dequeue: (body: DevDequeueRequestBody) => Promise<ApiResult<DevDequeueResponseBody>>;
+        readonly sendDebugLog: (runId: string, body: WorkloadDebugLogRequestBody) => Promise<ApiResult<unknown>>;
+        readonly getRunExecutionData: (runId: string) => Promise<ApiResult<WorkloadRunLatestSnapshotResponseBody>>;
+        readonly heartbeatRun: (runId: string, snapshotId: string, body: WorkloadHeartbeatRequestBody) => Promise<ApiResult<WorkloadHeartbeatResponseBody>>;
+        readonly startRunAttempt: (runId: string, snapshotId: string) => Promise<ApiResult<WorkloadRunAttemptStartResponseBody>>;
+        readonly completeRunAttempt: (runId: string, snapshotId: string, body: WorkloadRunAttemptCompleteRequestBody) => Promise<ApiResult<WorkloadRunAttemptCompleteResponseBody>>;
+        readonly setEngineURL: (engineURL: string) => void;
+    };
+    get workers(): {
+        list: () => Promise<ApiResult<{
+            type: string;
+            name: string;
+            updatedAt: Date;
+            isDefault: boolean;
+            description?: string | null | undefined;
+            latestVersion?: string | null | undefined;
+            lastHeartbeatAt?: string | null | undefined;
+        }[]>>;
+        create: (options: WorkersCreateRequestBody) => Promise<ApiResult<{
+            token: {
+                plaintext: string;
+            };
+            workerGroup: {
+                name: string;
+                description?: string | null | undefined;
+            };
+        }>>;
+    };
+    get deployments(): {
+        unmanaged: {
+            latest: () => Promise<ApiResult<{
+                status: "CANCELED" | "FAILED" | "TIMED_OUT" | "PENDING" | "BUILDING" | "DEPLOYING" | "DEPLOYED";
+                id: string;
+                version: string;
+                shortCode: string;
+                contentHash: string;
+                imagePlatform: string;
+                imageReference?: string | null | undefined;
+                externalBuildData?: {
+                    projectId: string;
+                    buildId: string;
+                    buildToken: string;
+                } | null | undefined;
+                errorData?: {
+                    message: string;
+                    name: string;
+                    stack?: string | undefined;
+                    stderr?: string | undefined;
+                } | null | undefined;
+            }>>;
+        };
+    };
+    private getLatestUnmanagedDeployment;
+    private listWorkers;
+    private createWorker;
+    private devConfig;
+    private devPresenceConnection;
+    private devDequeue;
+    private devSendDebugLog;
+    private devGetRunExecutionData;
+    private devHeartbeatRun;
+    private devStartRunAttempt;
+    private devCompleteRunAttempt;
+    private setEngineURL;
+    private getHeaders;
 }
-type ApiResult<TSuccessResult> = {
-    success: true;
-    data: TSuccessResult;
-} | {
-    success: false;
-    error: string;
-};
-export {};