Skip to content

The VS Code of video editing, built for agents.

TypeScript

Refactor tool environment references for consistency

konstantin-paulusb8ec5a39f77d
diff --git a/apps/desktop/src/dapi/server.ts b/apps/desktop/src/dapi/server.ts
index b37dfcc6..0536b7b3 100644
--- a/apps/desktop/src/dapi/server.ts
+++ b/apps/desktop/src/dapi/server.ts
@@ -47,7 +47,7 @@ export class DapiServer {
constructor(deps: DapiServerDeps) {
this.deps = deps;
for (const tool of tools) {
- if (tool.runsIn === "main" && !(tool.name in mainHandlers)) {
+ if (tool.environment === "main" && !(tool.name in mainHandlers)) {
throw new Error(`Main-process tool "${tool.name}" has no handler`);
}
}
@@ -129,7 +129,7 @@ export class DapiServer {
async (args, extra) => {
try {
const result =
- tool.runsIn === "main"
+ tool.environment === "main"
? await this.runInMain(tool.name as MainToolName, args, extra.signal)
: await this.renderer.call(tool.name, args, extra.signal);
return toCallToolResult(await present(tool.name as ToolName, args, result));
diff --git a/packages/dapi/src/catalog.test.ts b/packages/dapi/src/catalog.test.ts
index 844c286e..3f90c21e 100644
--- a/packages/dapi/src/catalog.test.ts
+++ b/packages/dapi/src/catalog.test.ts
@@ -35,8 +35,8 @@ describe("catalog", () => {
});
it("looks tools up by name", () => {
- expect(toolByName("capture").runsIn).toBe("renderer");
- expect(toolByName("fonts").runsIn).toBe("main");
+ expect(toolByName("capture").environment).toBe("renderer");
+ expect(toolByName("fonts").environment).toBe("main");
expect(isToolName("media_grab")).toBe(true);
expect(isToolName("media.frame")).toBe(false);
});
diff --git a/packages/dapi/src/index.ts b/packages/dapi/src/index.ts
index d6647796..83b45d5c 100644
--- a/packages/dapi/src/index.ts
+++ b/packages/dapi/src/index.ts
@@ -8,7 +8,7 @@
import type { z } from "zod";
export { defineTool } from "./tool";
-export type { Tool, GenericTool, RunsIn } from "./tool";
+export type { Tool, GenericTool, Environment } from "./tool";
export { catalog, tools, toolByName, isToolName } from "./catalog";
export type { AnyTool, ToolName, ToolByName, ToolInput, ToolArgs, ToolOutput, ToolResult } from "./catalog";
diff --git a/packages/dapi/src/tool.ts b/packages/dapi/src/tool.ts
index 6e2febdf..02466d9c 100644
--- a/packages/dapi/src/tool.ts
+++ b/packages/dapi/src/tool.ts
@@ -9,7 +9,7 @@ import type { z } from "zod";
* world, the engine, or browser media APIs; main tools need the file system
* or a child process and run without a window.
*/
-export type RunsIn = "renderer" | "main";
+export type Environment = "renderer" | "main";
export interface Tool<
Name extends string = string,
@@ -33,7 +33,7 @@ export interface Tool<
* as `output` when omitted.
*/
readonly result?: Result;
- readonly runsIn: RunsIn;
+ readonly environment: Environment;
}
/** A tool with its specifics erased, for code that iterates the catalog. */
diff --git a/packages/dapi/src/tools/capture.ts b/packages/dapi/src/tools/capture.ts
index 26b02d18..7b997a9e 100644
--- a/packages/dapi/src/tools/capture.ts
+++ b/packages/dapi/src/tools/capture.ts
@@ -27,5 +27,5 @@ export const capture = defineTool({
.superRefine(checkSheetOptions),
output: z.object({ images: z.array(ImageRef) }),
result: z.array(TimecodedImage),
- runsIn: "renderer",
+ environment: "renderer",
});
diff --git a/packages/dapi/src/tools/check.ts b/packages/dapi/src/tools/check.ts
index 74fe81d6..18996035 100644
--- a/packages/dapi/src/tools/check.ts
+++ b/packages/dapi/src/tools/check.ts
@@ -45,5 +45,5 @@ export const check = defineTool({
}),
issues: z.array(CheckIssue),
}),
- runsIn: "renderer",
+ environment: "renderer",
});
diff --git a/packages/dapi/src/tools/context.ts b/packages/dapi/src/tools/context.ts
index 7bb408fc..4f19f65e 100644
--- a/packages/dapi/src/tools/context.ts
+++ b/packages/dapi/src/tools/context.ts
@@ -42,7 +42,7 @@ export const context = defineTool({
.describe("families registered in the world drawing the project; the editor default is always among them"),
generations: z.array(GenerationRow),
}),
- runsIn: "renderer",
+ environment: "renderer",
});
export type GenerationRow = z.output<typeof GenerationRow>;
diff --git a/packages/dapi/src/tools/export.ts b/packages/dapi/src/tools/export.ts
index cf5cfc72..2e93ab7c 100644
--- a/packages/dapi/src/tools/export.ts
+++ b/packages/dapi/src/tools/export.ts
@@ -57,5 +57,5 @@ export const exportScene = defineTool({
"the settings the export was made with — the package.json entry (or the defaults), with the container the extension resolved to",
),
}),
- runsIn: "renderer",
+ environment: "renderer",
});
diff --git a/packages/dapi/src/tools/fetch.ts b/packages/dapi/src/tools/fetch.ts
index b628c542..d9a98f6b 100644
--- a/packages/dapi/src/tools/fetch.ts
+++ b/packages/dapi/src/tools/fetch.ts
@@ -18,5 +18,5 @@ export const fetchVideo = defineTool({
raw: z.array(z.string()).optional().describe('raw yt-dlp flags passed through, e.g. ["--sponsorblock-remove", "all"]'),
}),
output: z.object({ paths: z.array(z.string()) }),
- runsIn: "main",
+ environment: "main",
});
diff --git a/packages/dapi/src/tools/fonts.ts b/packages/dapi/src/tools/fonts.ts
index e725d0f2..0ba24884 100644
--- a/packages/dapi/src/tools/fonts.ts
+++ b/packages/dapi/src/tools/fonts.ts
@@ -30,5 +30,5 @@ export const fonts = defineTool({
limit: z.int().min(1).optional().describe("return at most this many families"),
}),
output: z.object({ families: z.array(FontFamily) }),
- runsIn: "main",
+ environment: "main",
});
diff --git a/packages/dapi/src/tools/logs.ts b/packages/dapi/src/tools/logs.ts
index a9e02d6e..25c509d5 100644
--- a/packages/dapi/src/tools/logs.ts
+++ b/packages/dapi/src/tools/logs.ts
@@ -16,5 +16,5 @@ export const logs = defineTool({
level: LogLevel.optional().describe("minimum level to include: debug, info, warning, or error"),
}),
output: z.object({ entries: z.array(LogEntry) }),
- runsIn: "main",
+ environment: "main",
});
diff --git a/packages/dapi/src/tools/media-filmstrip.ts b/packages/dapi/src/tools/media-filmstrip.ts
index 20321daf..c678df35 100644
--- a/packages/dapi/src/tools/media-filmstrip.ts
+++ b/packages/dapi/src/tools/media-filmstrip.ts
@@ -25,5 +25,5 @@ export const mediaFilmstrip = defineTool({
input: z.object({ path: AssetPath, ...previewFields }).superRefine(checkWindow),
output: z.looseObject({ path: z.string().describe("absolute path of the PNG") }),
result: z.looseObject({ png: Bytes }),
- runsIn: "renderer",
+ environment: "renderer",
});
diff --git a/packages/dapi/src/tools/media-grab.ts b/packages/dapi/src/tools/media-grab.ts
index 8b22144b..5a4ab3d0 100644
--- a/packages/dapi/src/tools/media-grab.ts
+++ b/packages/dapi/src/tools/media-grab.ts
@@ -73,5 +73,5 @@ export const mediaGrab = defineTool({
}),
output: z.object({ images: z.array(ImageRef) }),
result: z.array(TimecodedImage),
- runsIn: "renderer",
+ environment: "renderer",
});
diff --git a/packages/dapi/src/tools/media-listen.ts b/packages/dapi/src/tools/media-listen.ts
index f12c59e6..1c56b097 100644
--- a/packages/dapi/src/tools/media-listen.ts
+++ b/packages/dapi/src/tools/media-listen.ts
@@ -26,5 +26,5 @@ export const mediaListen = defineTool({
start: z.number().optional(),
end: z.number().optional(),
}),
- runsIn: "renderer",
+ environment: "renderer",
});
diff --git a/packages/dapi/src/tools/media-probe.ts b/packages/dapi/src/tools/media-probe.ts
index af6d0eec..c430f2ac 100644
--- a/packages/dapi/src/tools/media-probe.ts
+++ b/packages/dapi/src/tools/media-probe.ts
@@ -35,5 +35,5 @@ export const mediaProbe = defineTool({
tags: z.record(z.string(), z.unknown()).optional(),
tracks: z.array(Track),
}),
- runsIn: "renderer",
+ environment: "renderer",
});
diff --git a/packages/dapi/src/tools/media-transcribe.ts b/packages/dapi/src/tools/media-transcribe.ts
index c80917ea..7c1ece94 100644
--- a/packages/dapi/src/tools/media-transcribe.ts
+++ b/packages/dapi/src/tools/media-transcribe.ts
@@ -24,5 +24,5 @@ export const mediaTranscribe = defineTool({
"Transcribe the speech in a video or audio file and return the timed transcript, with word-level start/end times in seconds. Commonly useful for footage with speakers (talking head, interview), where the word times let you cut on a line. A transcript marks only speech; the gaps are not necessarily silent (music, score, applause).",
input: z.object({ path: AssetPath }),
output: z.object({ segments: z.array(TranscriptSegment) }),
- runsIn: "renderer",
+ environment: "renderer",
});
diff --git a/packages/dapi/src/tools/media-waveform.ts b/packages/dapi/src/tools/media-waveform.ts
index dd9f98ff..72faf05f 100644
--- a/packages/dapi/src/tools/media-waveform.ts
+++ b/packages/dapi/src/tools/media-waveform.ts
@@ -20,5 +20,5 @@ export const mediaWaveform = defineTool({
silences: Silences,
}),
result: z.looseObject({ png: Bytes, silences: Silences }),
- runsIn: "renderer",
+ environment: "renderer",
});
diff --git a/packages/dapi/src/tools/models.ts b/packages/dapi/src/tools/models.ts
index 74958e34..91ac7253 100644
--- a/packages/dapi/src/tools/models.ts
+++ b/packages/dapi/src/tools/models.ts
@@ -25,5 +25,5 @@ export const models = defineTool({
type: ModelType.optional().describe("filter to one kind of model, image, video, or audio (default: all three)"),
}),
output: z.object({ models: z.array(ModelInfo) }),
- runsIn: "renderer",
+ environment: "renderer",
});
diff --git a/packages/dapi/src/tools/open.ts b/packages/dapi/src/tools/open.ts
index 523fbba3..1b3cac7d 100644
--- a/packages/dapi/src/tools/open.ts
+++ b/packages/dapi/src/tools/open.ts
@@ -18,5 +18,5 @@ export const open = defineTool({
name: z.string().describe("display name"),
dir: z.string().describe("absolute path of the project folder"),
}),
- runsIn: "renderer",
+ environment: "renderer",
});
diff --git a/packages/dapi/src/tools/report.ts b/packages/dapi/src/tools/report.ts
index 6d0523c7..a8835e65 100644
--- a/packages/dapi/src/tools/report.ts
+++ b/packages/dapi/src/tools/report.ts
@@ -20,5 +20,5 @@ export const report = defineTool({
logs: z.int().min(0).optional().describe(`trailing app log entries to attach (0 to omit; default: ${ISSUE_LOG_TAIL})`),
}),
output: z.object({ url: z.string() }),
- runsIn: "main",
+ environment: "main",
});
diff --git a/packages/dapi/src/tools/screenshot.ts b/packages/dapi/src/tools/screenshot.ts
index 7cc1fa33..4463a31f 100644
--- a/packages/dapi/src/tools/screenshot.ts
+++ b/packages/dapi/src/tools/screenshot.ts
@@ -18,5 +18,5 @@ export const screenshot = defineTool({
height: z.number(),
}),
result: z.object({ png: Bytes, width: z.number(), height: z.number() }),
- runsIn: "renderer",
+ environment: "renderer",
});
diff --git a/packages/dapi/src/tools/voices.ts b/packages/dapi/src/tools/voices.ts
index 76d0f328..cb052805 100644
--- a/packages/dapi/src/tools/voices.ts
+++ b/packages/dapi/src/tools/voices.ts
@@ -17,5 +17,5 @@ export const voices = defineTool({
description: "List the speech voices available for `generate.voice` declarations in a project module.",
input: z.object({}),
output: z.object({ voices: z.array(VoiceInfo) }),
- runsIn: "renderer",
+ environment: "renderer",
});
diff --git a/packages/dapi/src/tools/whoami.ts b/packages/dapi/src/tools/whoami.ts
index 0aa6393a..d088db34 100644
--- a/packages/dapi/src/tools/whoami.ts
+++ b/packages/dapi/src/tools/whoami.ts
@@ -13,5 +13,5 @@ export const whoami = defineTool({
output: z.object({
user: z.object({ id: z.string(), email: z.string().optional() }).nullable(),
}),
- runsIn: "renderer",
+ environment: "renderer",
});