Changed the SDK to be runs.replay and runs.cancel

Author: matt-aitken

docs/mint.json

@@ -588,13 +588,13 @@
           ]
         },
         {
-          "group": "REST API",
+          "group": "Management API",
           "pages": [
-            "v3/rest-start-run",
-            "v3/rest-get-run",
-            "v3/rest-get-runs",
-            "v3/rest-replay-run",
-            "v3/rest-cancel-run"
+            "v3/management-start-run",
+            "v3/management-get-run",
+            "v3/management-get-runs",
+            "v3/management-replay-run",
+            "v3/management-cancel-run"
           ]
         }
       ]

docs/v3-openapi.json

@@ -98,7 +98,7 @@
         "x-codeSamples": [
           {
             "lang": "typescript",
-            "source": "const handle = await replayRun(existingRun.id);"
+            "source": "const handle = await runs.replay(existingRun.id);"
           },
           {
             "lang": "sh",
@@ -193,7 +193,7 @@
         "x-codeSamples": [
           {
             "lang": "typescript",
-            "source": "await cancelRun(existingRun.id);"
+            "source": "await runs.cancel(existingRun.id);"
           },
           {
             "lang": "sh",

docs/v3/rest-cancel-run.mdx renamed to docs/v3/management-cancel-run.mdx

@@ -1,6 +1,5 @@
 ---
-title: "REST API: Get run"
-sidebarTitle: "Get run"
+title: "Get run"
 description: "Get a run using the Task id."
 ---
 

docs/v3/rest-get-run.mdx renamed to docs/v3/management-get-run.mdx

@@ -1,6 +1,5 @@
 ---
-title: "REST API: Get runs"
-sidebarTitle: "Get runs"
+title: "Get runs"
 description: "Get runs using a Task id."
 ---
 

docs/v3/rest-get-runs.mdx renamed to docs/v3/management-get-runs.mdx

@@ -1,6 +1,5 @@
 ---
-title: "REST API: Start run"
-sidebarTitle: "Start run"
+title: "Start run"
 description: "Start a run using the Task id, payload and options."
 ---
 

docs/v3/rest-replay-run.mdx renamed to docs/v3/management-replay-run.mdx

@@ -9,4 +9,4 @@ export type { Context };
 
 export { logger, type LogLevel } from "@trigger.dev/core/v3";
 
-export { replayRun, cancelRun } from "./management";
+export { runs } from "./management";

docs/v3/rest-start-run.mdx renamed to docs/v3/management-start-run.mdx

@@ -1,7 +1,12 @@
 import { CanceledRunResponse, ReplayRunResponse, apiClientManager } from "@trigger.dev/core/v3";
 import { apiClientMissingError } from "./shared";
 
-export async function replayRun(runId: string): Promise<ReplayRunResponse> {
+export const runs = {
+  replay: replayRun,
+  cancel: cancelRun,
+};
+
+async function replayRun(runId: string): Promise<ReplayRunResponse> {
   const apiClient = apiClientManager.client;
 
   if (!apiClient) {
@@ -17,7 +22,7 @@ export async function replayRun(runId: string): Promise<ReplayRunResponse> {
   return response.data;
 }
 
-export async function cancelRun(runId: string): Promise<CanceledRunResponse> {
+async function cancelRun(runId: string): Promise<CanceledRunResponse> {
   const apiClient = apiClientManager.client;
 
   if (!apiClient) {

packages/trigger-sdk/src/v3/index.ts

@@ -1,16 +1,18 @@
-import { cancelRun, replayRun } from "@trigger.dev/sdk/v3";
+import { runs } from "@trigger.dev/sdk/v3";
 import { simpleChildTask } from "./trigger/subtasks";
 import dotenv from "dotenv";
 
 dotenv.config();
 
 export async function run() {
   const run = await simpleChildTask.trigger({ payload: { message: "Hello, World!" } });
-  const canceled = await cancelRun(run.id);
+  const canceled = await runs.cancel(run.id);
   console.log("canceled run", canceled);
 
-  const replayed = await replayRun(run.id);
+  const replayed = await runs.replay(run.id);
   console.log("replayed run", replayed);
+
+  //todo runs.cancel();
 }
 
 run();