mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-04-25 00:51:20 +00:00
Add a plugin system that lets plugins add new tabs to the dashboard.
Plugins live in ~/.hermes/plugins/<name>/dashboard/ alongside any
existing CLI/gateway plugin code.
Plugin structure:
plugins/<name>/dashboard/
manifest.json # name, label, icon, tab config, entry point
dist/index.js # pre-built JS bundle (IIFE, uses SDK globals)
plugin_api.py # optional FastAPI router mounted at /api/plugins/<name>/
Backend (hermes_cli/web_server.py):
- Plugin discovery: scans plugins/*/dashboard/manifest.json from user,
bundled, and project plugin directories
- GET /api/dashboard/plugins — returns discovered plugin manifests
- GET /api/dashboard/plugins/rescan — force re-discovery
- GET /dashboard-plugins/<name>/<path> — serves plugin static assets
with path traversal protection
- Optional API route mounting: imports plugin_api.py and mounts its
router under /api/plugins/<name>/
- Plugin API routes bypass session token auth (localhost-only)
Frontend (web/src/plugins/):
- Plugin SDK exposed on window.__HERMES_PLUGIN_SDK__ — provides React,
hooks, UI components (Card, Badge, Button, etc.), API client,
fetchJSON, theme/i18n hooks, and utilities
- Plugin registry on window.__HERMES_PLUGINS__.register(name, Component)
- usePlugins() hook: fetches manifests, loads JS/CSS, resolves components
- App.tsx dynamically adds nav items and routes for discovered plugins
- Icon resolution via static map of 20 common Lucide icons (no tree-
shaking penalty — bundle only +5KB over baseline)
Example plugin (plugins/example-dashboard/):
- Demonstrates SDK usage: Card components, backend API call, SDK reference
- Backend route: GET /api/plugins/example/hello
Tested: plugin discovery, static serving, API routes, path traversal
blocking, unknown plugin 404, bundle size (400KB vs 394KB baseline).
131 lines
3.3 KiB
TypeScript
131 lines
3.3 KiB
TypeScript
/**
|
|
* Dashboard Plugin SDK + Registry
|
|
*
|
|
* Exposes React, UI components, hooks, and utilities on the window so
|
|
* that plugin bundles can use them without bundling their own copies.
|
|
*
|
|
* Plugins call window.__HERMES_PLUGINS__.register(name, Component)
|
|
* to register their tab component.
|
|
*/
|
|
|
|
import React, {
|
|
useState,
|
|
useEffect,
|
|
useCallback,
|
|
useMemo,
|
|
useRef,
|
|
useContext,
|
|
createContext,
|
|
} from "react";
|
|
import { api, fetchJSON } from "@/lib/api";
|
|
import { cn, timeAgo, isoTimeAgo } from "@/lib/utils";
|
|
import { Card, CardHeader, CardTitle, CardContent } from "@/components/ui/card";
|
|
import { Badge } from "@/components/ui/badge";
|
|
import { Button } from "@/components/ui/button";
|
|
import { Input } from "@/components/ui/input";
|
|
import { Label } from "@/components/ui/label";
|
|
import { Select, SelectOption } from "@/components/ui/select";
|
|
import { Separator } from "@/components/ui/separator";
|
|
import { Tabs, TabsList, TabsTrigger } from "@/components/ui/tabs";
|
|
import { useI18n } from "@/i18n";
|
|
import { useTheme } from "@/themes";
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Plugin registry — plugins call register() to add their component.
|
|
// ---------------------------------------------------------------------------
|
|
|
|
type RegistryListener = () => void;
|
|
|
|
const _registered: Map<string, React.ComponentType> = new Map();
|
|
const _listeners: Set<RegistryListener> = new Set();
|
|
|
|
function _notify() {
|
|
for (const fn of _listeners) {
|
|
try { fn(); } catch { /* ignore */ }
|
|
}
|
|
}
|
|
|
|
/** Register a plugin component. Called by plugin JS bundles. */
|
|
function registerPlugin(name: string, component: React.ComponentType) {
|
|
_registered.set(name, component);
|
|
_notify();
|
|
}
|
|
|
|
/** Get a registered component by plugin name. */
|
|
export function getPluginComponent(name: string): React.ComponentType | undefined {
|
|
return _registered.get(name);
|
|
}
|
|
|
|
/** Subscribe to registry changes (returns unsubscribe fn). */
|
|
export function onPluginRegistered(fn: RegistryListener): () => void {
|
|
_listeners.add(fn);
|
|
return () => _listeners.delete(fn);
|
|
}
|
|
|
|
/** Get current count of registered plugins. */
|
|
export function getRegisteredCount(): number {
|
|
return _registered.size;
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Expose SDK + registry on window
|
|
// ---------------------------------------------------------------------------
|
|
|
|
declare global {
|
|
interface Window {
|
|
__HERMES_PLUGIN_SDK__: unknown;
|
|
__HERMES_PLUGINS__: {
|
|
register: typeof registerPlugin;
|
|
};
|
|
}
|
|
}
|
|
|
|
export function exposePluginSDK() {
|
|
window.__HERMES_PLUGINS__ = {
|
|
register: registerPlugin,
|
|
};
|
|
|
|
window.__HERMES_PLUGIN_SDK__ = {
|
|
// React core — plugins use these instead of importing react
|
|
React,
|
|
hooks: {
|
|
useState,
|
|
useEffect,
|
|
useCallback,
|
|
useMemo,
|
|
useRef,
|
|
useContext,
|
|
createContext,
|
|
},
|
|
|
|
// Hermes API client
|
|
api,
|
|
// Raw fetchJSON for plugin-specific endpoints
|
|
fetchJSON,
|
|
|
|
// UI components (shadcn/ui primitives)
|
|
components: {
|
|
Card,
|
|
CardHeader,
|
|
CardTitle,
|
|
CardContent,
|
|
Badge,
|
|
Button,
|
|
Input,
|
|
Label,
|
|
Select,
|
|
SelectOption,
|
|
Separator,
|
|
Tabs,
|
|
TabsList,
|
|
TabsTrigger,
|
|
},
|
|
|
|
// Utilities
|
|
utils: { cn, timeAgo, isoTimeAgo },
|
|
|
|
// Hooks
|
|
useI18n,
|
|
useTheme,
|
|
};
|
|
}
|