Skip to content

The VS Code of video editing, built for agents.

TypeScript

Refactor Electron context to use Editor API and enhance type safety

konstantin-paulusdbd1a7393b3a
diff --git a/apps/cli/src/cli-client.ts b/apps/cli/src/cli-client.ts
index fe1da25d..0779cf61 100644
--- a/apps/cli/src/cli-client.ts
+++ b/apps/cli/src/cli-client.ts
@@ -11,7 +11,7 @@ import type { TRPCLink } from "@trpc/client";
import { observable } from "@trpc/server/observable";
import { SOCKET_PATH } from "./protocol";
import type { CliHandshake, CliHandshakeReply, CliReply, CliRequest } from "./protocol";
-import type { AppRouter } from "../../web/src/context/electron/router";
+import type { AppRouter } from "../../web/src/context/editor-api";
const DEFAULT_TIMEOUT_MS = 60000;
export const GENERATE_TIMEOUT_MS = 600000;
diff --git a/apps/cli/src/open-folder.ts b/apps/cli/src/open-folder.ts
index 4aef5306..e6e455ba 100644
--- a/apps/cli/src/open-folder.ts
+++ b/apps/cli/src/open-folder.ts
@@ -99,7 +99,7 @@ async function collectSupportedAssets(folderPath: string) {
return results;
}
-async function ensureFolder(segments: string[], cache: Map<string, string>) {
+async function ensureFolder(segments: string[], cache: Map<string, string>): Promise<string | undefined> {
if (segments.length === 0) return undefined; // the library root
const key = segments.join("/");
const cached = cache.get(key);
diff --git a/apps/web/src/components/sidebar-left/sidebar-left.tsx b/apps/web/src/components/sidebar-left/sidebar-left.tsx
index 7f4d0ba6..503f3270 100644
--- a/apps/web/src/components/sidebar-left/sidebar-left.tsx
+++ b/apps/web/src/components/sidebar-left/sidebar-left.tsx
@@ -4,7 +4,7 @@
import { Assets } from "./assets";
import { useLayout } from "@/context/layout";
-import { useElectron } from "@/context/electron";
+import { useEditorApi } from "@/context/editor-api";
import { createSignal, Show } from "solid-js";
import { Button } from "../ui/button";
import { Icon } from "../ui/icon";
@@ -26,7 +26,7 @@ export function SidebarLeft() {
}
export function ElectronHeader() {
- const { isDesktop, isFullscreen } = useElectron();
+ const { isDesktop, isFullscreen } = useEditorApi();
const { toggleTimeline, toggleUI } = useLayout();
return (
@@ -111,7 +111,7 @@ export function ProjectHeader(props: ProjectHeaderProps) {
}
export function FloatingProjectHeader() {
- const { isDesktop } = useElectron();
+ const { isDesktop } = useEditorApi();
const { toggleUI } = useLayout();
return (
diff --git a/apps/web/src/context/editor-api/api.tsx b/apps/web/src/context/editor-api/api.tsx
new file mode 100644
index 00000000..af8f7f5a
--- /dev/null
+++ b/apps/web/src/context/editor-api/api.tsx
@@ -0,0 +1,152 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+import { createEffect, createContext, useContext, onCleanup, createResource } from "solid-js";
+import { useSearchParams } from "@solidjs/router";
+import { useEngine } from '@/context/engine';
+import { useAuth } from '@/context/auth';
+import { t, q, m, q0, m0 } from "@/lib/cli-rpc";
+import { handleContextGet } from "./context";
+import { handleAssetsAdd, handleAssetsList, handleAssetTree, handleAssetsDelete, handleAssetsMove, handleAssetsExport, handleAssetProbe, handleAssetFrame, handleAssetTranscribe, handleAssetVisualize, handleAssetAnalyze } from "./assets";
+import { handleFoldersList, handleFolderCreate, handleFolderRename, handleFoldersMove, handleFoldersDelete } from "./folders";
+import { handleSelectionFocus, handleSelectionList, handleSelectionSet } from "./selection";
+import { handleNodeList, handleNodeTree, handleNodeGrep, handleNodeScreenshot, handleNodeDelete, handleNodePatch, handleNodeDuplicate, handleNodeRender } from "./node";
+import { handleMount, handleNodeInsert } from "./mount";
+import { handleProjectActive, handleProjectList, handleProjectCreate, handleProjectDelete, handleProjectOpen } from "./project";
+import { handleModels } from "./models";
+import { handleVoices } from "./voices";
+import { cliBridge, mainBridge } from '@/lib/ipc';
+import { createRouterCaller } from '@/lib/cli-rpc';
+import { MAIN_CHANNELS } from '@desktop/main-channels';
+import { assert } from "@/utils/common";
+import { handleGetFullscreenState, handleWindowFullscreenChange } from "./window";
+
+import type { JSX, Accessor } from 'solid-js';
+import type { User } from '@supabase/supabase-js';
+import type { Engine } from '@/components/engine';
+
+type EditorApiProviderProps = {
+ children: JSX.Element;
+};
+
+type EditorApiContextValue = {
+ isFullscreen: Accessor<boolean>;
+ isDesktop: boolean;
+};
+
+const EditorApiContext = createContext<EditorApiContextValue>();
+
+export function EditorApiProvider(props: EditorApiProviderProps) {
+ const engine = useEngine();
+ const auth = useAuth();
+ const [, setParams] = useSearchParams();
+ const [isFullscreen, { mutate }] = createResource(handleGetFullscreenState, { initialValue: false });
+
+ const requireAuth = <I, O>(fn: (data: I) => Promise<O>) => (data: I) => {
+ assert(auth.isAuthenticated(), "Sign in required: AI generation needs a Diffusion Studio account.");
+ return fn(data);
+ };
+
+ const getUser = () => {
+ const user = auth.user();
+ assert(user, "User not found");
+ return user;
+ };
+
+ const getEngine = () => engine;
+
+ createEffect(() => {
+ if (!window.desktop) return;
+
+ const router = createAppRouter({ getEngine, getUser, requireAuth, setParams });
+ const unsubRouter = cliBridge.register(createRouterCaller(router));
+ const unsubScreenChange = mainBridge.handle(MAIN_CHANNELS.WINDOW_FULLSCREEN_CHANGE, handleWindowFullscreenChange(mutate));
+
+ onCleanup(() => {
+ unsubRouter();
+ unsubScreenChange();
+ });
+ });
+
+ return (
+ <EditorApiContext.Provider
+ value={{
+ isFullscreen,
+ isDesktop: !!window.desktop,
+ }}
+ >
+ {props.children}
+ </EditorApiContext.Provider>
+ );
+}
+
+
+type AppRouterDeps = {
+ getEngine: () => Engine;
+ getUser: () => User;
+ requireAuth: <I, O>(fn: (data: I) => Promise<O>) => (data: I) => Promise<O>;
+ setParams: ReturnType<typeof useSearchParams>[1];
+};
+
+function createAppRouter({ getEngine, getUser, requireAuth, setParams }: AppRouterDeps) {
+ return t.router({
+ ping: t.procedure.query(() => {}),
+ whoami: t.procedure.query(() => getUser()),
+ context: q0(handleContextGet(getEngine)),
+ mount: m(handleMount(getEngine)),
+ models: q(handleModels()),
+ voices: q0(handleVoices()),
+ asset: t.router({
+ add: m(handleAssetsAdd(getEngine)),
+ list: q(handleAssetsList(getEngine)),
+ tree: q(handleAssetTree(getEngine)),
+ delete: m(handleAssetsDelete(getEngine)),
+ move: m(handleAssetsMove(getEngine)),
+ export: m(handleAssetsExport(getEngine)),
+ probe: q(handleAssetProbe(getEngine)),
+ frame: q(handleAssetFrame(getEngine)),
+ transcribe: q(handleAssetTranscribe(getEngine)),
+ visualize: q(handleAssetVisualize(getEngine)),
+ analyze: q(requireAuth(handleAssetAnalyze(getEngine))),
+ }),
+ folder: t.router({
+ list: q(handleFoldersList(getEngine)),
+ create: m(handleFolderCreate(getEngine)),
+ rename: m(handleFolderRename(getEngine)),
+ move: m(handleFoldersMove(getEngine)),
+ delete: m(handleFoldersDelete(getEngine)),
+ }),
+ selection: t.router({
+ list: q0(handleSelectionList(getEngine)),
+ set: m(handleSelectionSet(getEngine)),
+ focus: m0(handleSelectionFocus(getEngine)),
+ }),
+ node: t.router({
+ list: q(handleNodeList(getEngine)),
+ tree: q(handleNodeTree(getEngine)),
+ grep: q(handleNodeGrep(getEngine)),
+ screenshot: q(handleNodeScreenshot(getEngine)),
+ insert: m(handleNodeInsert(getEngine)),
+ delete: m(handleNodeDelete(getEngine)),
+ patch: m(handleNodePatch(getEngine)),
+ duplicate: m(handleNodeDuplicate(getEngine)),
+ render: m(handleNodeRender(getEngine)),
+ }),
+ project: t.router({
+ active: q0(handleProjectActive(getEngine)),
+ list: q0(handleProjectList()),
+ create: m(handleProjectCreate(getEngine, setParams)),
+ delete: m(handleProjectDelete(getEngine, setParams)),
+ open: m(handleProjectOpen(getEngine, setParams)),
+ }),
+ });
+}
+
+export type AppRouter = ReturnType<typeof createAppRouter>;
+
+export function useEditorApi() {
+ const ctx = useContext(EditorApiContext);
+ assert(ctx, "useEditorApi must be used within EditorApiProvider");
+ return ctx;
+}
diff --git a/apps/web/src/context/electron/assets.ts b/apps/web/src/context/editor-api/assets.ts
similarity index 100%
rename from apps/web/src/context/electron/assets.ts
rename to apps/web/src/context/editor-api/assets.ts
diff --git a/apps/web/src/context/electron/context.ts b/apps/web/src/context/editor-api/context.ts
similarity index 100%
rename from apps/web/src/context/electron/context.ts
rename to apps/web/src/context/editor-api/context.ts
diff --git a/apps/web/src/context/electron/folders.ts b/apps/web/src/context/editor-api/folders.ts
similarity index 100%
rename from apps/web/src/context/electron/folders.ts
rename to apps/web/src/context/editor-api/folders.ts
diff --git a/apps/web/src/context/electron/index.ts b/apps/web/src/context/editor-api/index.ts
similarity index 88%
rename from apps/web/src/context/electron/index.ts
rename to apps/web/src/context/editor-api/index.ts
index 44cc87d1..b86dc190 100644
--- a/apps/web/src/context/electron/index.ts
+++ b/apps/web/src/context/editor-api/index.ts
@@ -2,4 +2,4 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
-export * from './electron';
+export * from './api';
diff --git a/apps/web/src/context/electron/models.ts b/apps/web/src/context/editor-api/models.ts
similarity index 100%
rename from apps/web/src/context/electron/models.ts
rename to apps/web/src/context/editor-api/models.ts
diff --git a/apps/web/src/context/electron/mount.ts b/apps/web/src/context/editor-api/mount.ts
similarity index 100%
rename from apps/web/src/context/electron/mount.ts
rename to apps/web/src/context/editor-api/mount.ts
diff --git a/apps/web/src/context/electron/node.ts b/apps/web/src/context/editor-api/node.ts
similarity index 100%
rename from apps/web/src/context/electron/node.ts
rename to apps/web/src/context/editor-api/node.ts
diff --git a/apps/web/src/context/electron/project.ts b/apps/web/src/context/editor-api/project.ts
similarity index 100%
rename from apps/web/src/context/electron/project.ts
rename to apps/web/src/context/editor-api/project.ts
diff --git a/apps/web/src/context/electron/selection.ts b/apps/web/src/context/editor-api/selection.ts
similarity index 100%
rename from apps/web/src/context/electron/selection.ts
rename to apps/web/src/context/editor-api/selection.ts
diff --git a/apps/web/src/context/electron/voices.ts b/apps/web/src/context/editor-api/voices.ts
similarity index 100%
rename from apps/web/src/context/electron/voices.ts
rename to apps/web/src/context/editor-api/voices.ts
diff --git a/apps/web/src/context/electron/window.ts b/apps/web/src/context/editor-api/window.ts
similarity index 100%
rename from apps/web/src/context/electron/window.ts
rename to apps/web/src/context/editor-api/window.ts
diff --git a/apps/web/src/context/electron/electron.tsx b/apps/web/src/context/electron/electron.tsx
deleted file mode 100644
index 8e365536..00000000
--- a/apps/web/src/context/electron/electron.tsx
+++ /dev/null
@@ -1,80 +0,0 @@
-/* This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
-
-import { createEffect, createContext, useContext, onCleanup, createResource } from "solid-js";
-import { useSearchParams } from "@solidjs/router";
-import { useEngine } from '@/context/engine';
-import { useAuth } from '@/context/auth';
-
-import { cliBridge, mainBridge } from '@/lib/ipc';
-import { createRouterCaller } from '@/lib/cli-rpc';
-import { MAIN_CHANNELS } from '@desktop/main-channels';
-import { assert } from "@/utils/common";
-import { createAppRouter } from "./router";
-import { handleGetFullscreenState, handleWindowFullscreenChange } from "./window";
-
-import type { JSX, Accessor } from 'solid-js';
-
-
-type ElectronProviderProps = {
- children: JSX.Element;
-};
-
-type ElectronContextValue = {
- isFullscreen: Accessor<boolean>;
- isDesktop: boolean;
-};
-
-const ElectronContext = createContext<ElectronContextValue>();
-
-export function ElectronProvider(props: ElectronProviderProps) {
- const engine = useEngine();
- const auth = useAuth();
- const [, setParams] = useSearchParams();
- const [isFullscreen, { mutate }] = createResource(handleGetFullscreenState, { initialValue: false });
-
- createEffect(() => {
- if (!window.desktop) return;
-
- const router = createAppRouter({
- engine: () => engine,
- setParams,
- isAuthenticated: () => auth.isAuthenticated(),
- getUser: () => {
- const user = auth.user();
- if (!user) return null;
- return {
- id: user.id,
- email: user.email ?? "",
- provider: user.app_metadata?.provider ?? "unknown",
- };
- },
- });
- const unsubRouter = cliBridge.register(createRouterCaller(router));
- const unsubScreenChange = mainBridge.handle(MAIN_CHANNELS.WINDOW_FULLSCREEN_CHANGE, handleWindowFullscreenChange(mutate));
-
- onCleanup(() => {
- unsubRouter();
- unsubScreenChange();
- });
- });
-
- return (
- <ElectronContext.Provider
- value={{
- isFullscreen,
- isDesktop: !!window.desktop,
- }}
- >
- {props.children}
- </ElectronContext.Provider>
- );
-}
-
-
-export function useElectron() {
- const ctx = useContext(ElectronContext);
- assert(ctx, "useElectron must be used within ElectronProvider");
- return ctx;
-}
diff --git a/apps/web/src/context/electron/router.ts b/apps/web/src/context/electron/router.ts
deleted file mode 100644
index 77ae2964..00000000
--- a/apps/web/src/context/electron/router.ts
+++ /dev/null
@@ -1,91 +0,0 @@
-/* This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
-
-import { t, q, m, q0, m0 } from "@/lib/cli-rpc";
-import { assert } from "@/utils/common";
-import { handleContextGet } from "./context";
-import { handleAssetsAdd, handleAssetsList, handleAssetTree, handleAssetsDelete, handleAssetsMove, handleAssetsExport, handleAssetProbe, handleAssetFrame, handleAssetTranscribe, handleAssetVisualize, handleAssetAnalyze } from "./assets";
-import { handleFoldersList, handleFolderCreate, handleFolderRename, handleFoldersMove, handleFoldersDelete } from "./folders";
-import { handleSelectionFocus, handleSelectionList, handleSelectionSet } from "./selection";
-import { handleNodeList, handleNodeTree, handleNodeGrep, handleNodeScreenshot, handleNodeDelete, handleNodePatch, handleNodeDuplicate, handleNodeRender } from "./node";
-import { handleMount, handleNodeInsert } from "./mount";
-import { handleProjectActive, handleProjectList, handleProjectCreate, handleProjectDelete, handleProjectOpen } from "./project";
-import { handleModels } from "./models";
-import { handleVoices } from "./voices";
-
-import type { Accessor } from "solid-js";
-import type { Engine } from "@/components/engine";
-import type { useSearchParams } from "@solidjs/router";
-
-type AppRouterDeps = {
- engine: Accessor<Engine>;
- setParams: ReturnType<typeof useSearchParams>[1];
- isAuthenticated: () => boolean;
- getUser: () => { id: string; email: string; provider: string } | null;
-};
-
-// The complete CLI surface. Registered by ElectronProvider, which mounts
-// whenever a project is open (sign-in not required); requests arriving
-// earlier are held by the CLI bridge until then. `ping` answers
-// `waitForCliSocket` probes.
-export function createAppRouter({ engine, setParams, isAuthenticated, getUser }: AppRouterDeps) {
- const requireAuth = <I, O>(fn: (data: I) => Promise<O>) => (data: I) => {
- assert(isAuthenticated(), "Sign in required: AI generation needs a Diffusion Studio account.");
- return fn(data);
- };
-
- return t.router({
- ping: t.procedure.query(() => {}),
- whoami: t.procedure.query(() => getUser()),
- context: q0(handleContextGet(engine)),
- mount: m(handleMount(engine)),
- models: q(handleModels()),
- voices: q0(handleVoices()),
- asset: t.router({
- add: m(handleAssetsAdd(engine)),
- list: q(handleAssetsList(engine)),
- tree: q(handleAssetTree(engine)),
- delete: m(handleAssetsDelete(engine)),
- move: m(handleAssetsMove(engine)),
- export: m(handleAssetsExport(engine)),
- probe: q(handleAssetProbe(engine)),
- frame: q(handleAssetFrame(engine)),
- transcribe: q(handleAssetTranscribe(engine)),
- visualize: q(handleAssetVisualize(engine)),
- analyze: q(requireAuth(handleAssetAnalyze(engine))),
- }),
- folder: t.router({
- list: q(handleFoldersList(engine)),
- create: m(handleFolderCreate(engine)),
- rename: m(handleFolderRename(engine)),
- move: m(handleFoldersMove(engine)),
- delete: m(handleFoldersDelete(engine)),
- }),
- selection: t.router({
- list: q0(handleSelectionList(engine)),
- set: m(handleSelectionSet(engine)),
- focus: m0(handleSelectionFocus(engine)),
- }),
- node: t.router({
- list: q(handleNodeList(engine)),
- tree: q(handleNodeTree(engine)),
- grep: q(handleNodeGrep(engine)),
- screenshot: q(handleNodeScreenshot(engine)),
- insert: m(handleNodeInsert(engine)),
- delete: m(handleNodeDelete(engine)),
- patch: m(handleNodePatch(engine)),
- duplicate: m(handleNodeDuplicate(engine)),
- render: m(handleNodeRender(engine)),
- }),
- project: t.router({
- active: q0(handleProjectActive(engine)),
- list: q0(handleProjectList()),
- create: m(handleProjectCreate(engine, setParams)),
- delete: m(handleProjectDelete(engine, setParams)),
- open: m(handleProjectOpen(engine, setParams)),
- }),
- });
-}
-
-export type AppRouter = ReturnType<typeof createAppRouter>;
diff --git a/apps/web/src/pages/editor.tsx b/apps/web/src/pages/editor.tsx
index ebfdbf10..f569280c 100644
--- a/apps/web/src/pages/editor.tsx
+++ b/apps/web/src/pages/editor.tsx
@@ -8,13 +8,13 @@ import { Timeline, Layers } from "@/components/timeline";
import { Soundboard, Inspector } from "@/components/sidebar-right";
import { FloatingProjectHeader, SidebarLeft } from "@/components/sidebar-left";
import { useLayout, MIN_TIMELINE_HEIGHT } from "@/context/layout";
-import { useElectron } from "@/context/electron";
+import { useEditorApi } from "@/context/editor-api";
const MIN_CANVAS_HEIGHT = 200;
export function EditorPage() {
const { sidebarsVisible, timelineVisible, timelineHeight, setTimelineHeight } = useLayout();
- const { isDesktop, isFullscreen } = useElectron();
+ const { isDesktop, isFullscreen } = useEditorApi();
const [resizing, setResizing] = createSignal(false);
const timelineStyles = createMemo(() => {
diff --git a/apps/web/src/pages/home.tsx b/apps/web/src/pages/home.tsx
index cbdd41db..3938efa5 100644
--- a/apps/web/src/pages/home.tsx
+++ b/apps/web/src/pages/home.tsx
@@ -8,7 +8,7 @@ import { LayoutProvider } from "@/context/layout";
import { Dashboard } from '@/components/dashboard';
import { PromptInputProvider } from "@/context/prompt-input";
import { EngineProvider } from '@/context/engine';
-import { ElectronProvider } from '@/context/electron';
+import { EditorApiProvider } from '@/context/editor-api';
import { ExportProvider } from '@/context/export';
import { useProjectId } from '@/hooks/use-project-id';
import { useSearchParams } from '@solidjs/router';
@@ -26,7 +26,7 @@ export function HomePage() {
<Show when={projectId()} keyed>
{(id) => (
<EngineProvider projectId={id}>
- <ElectronProvider>
+ <EditorApiProvider>
<TimelineProvider>
<ECSProvider>
<ExportProvider>
@@ -41,7 +41,7 @@ export function HomePage() {
</ExportProvider>
</ECSProvider>
</TimelineProvider>
- </ElectronProvider>
+ </EditorApiProvider>
</EngineProvider>
)}
</Show>