@hachej/boring-workspace 0.1.16 → 0.1.18

package/dist/app-front.d.ts

@@ -5,33 +5,84 @@ import { JSX } from 'react/jsx-runtime';
 import { ReactNode } from 'react';
 import { SlashCommand } from '@hachej/boring-agent/front';
 
+declare interface BoringFrontAPI {
+    registerProvider(registration: BoringFrontProviderRegistration): void;
+    registerBinding(registration: BoringFrontBindingRegistration): void;
+    registerCatalog(registration: CatalogConfig): void;
+    registerPanel<T = unknown>(registration: BoringFrontPanelRegistration<T>): void;
+    registerPanelCommand(registration: BoringFrontPanelCommandRegistration): void;
+    registerLeftTab<T = LeftTabParams>(registration: BoringFrontLeftTabRegistration<T>): void;
+    registerSurfaceResolver(registration: BoringFrontSurfaceResolverRegistration): void;
+}
+
+declare interface BoringFrontBindingRegistration {
+    id: string;
+    component: PluginBinding;
+}
+
+declare type BoringFrontFactory = (api: BoringFrontAPI) => void | Promise<void>;
+
 /**
- * Structural tool contract accepted from workspace plugins and UI tool
- * factories. Kept agent-runtime-neutral so only the app integration layer
- * needs to import @hachej/boring-agent.
+ * A `BoringFrontFactory` that carries its own plugin id (and optional
+ * label) as static properties. Produced by `definePlugin({ ... })` and used
+ * directly by `WorkspaceProvider.plugins`.
  */
-declare interface AgentTool {
-    name: string;
-    description: string;
-    promptSnippet?: string;
-    parameters: JSONSchema;
-    execute(params: Record<string, unknown>, ctx: ToolExecContext): Promise<ToolResult>;
+declare type BoringFrontFactoryWithId = BoringFrontFactory & {
+    pluginId: string;
+    pluginLabel?: string;
+};
+
+declare interface BoringFrontLeftTabRegistration<T = LeftTabParams> {
+    id: string;
+    title: string;
+    panelId: string;
+    icon?: ComponentType<{
+        className?: string;
+    }>;
+    component?: PanelConfig<T>["component"];
+    lazy?: boolean;
+    chromeless?: boolean;
+    requiresCapabilities?: string[];
+    source?: string;
 }
 
-declare interface AgentToolOutput {
-    /**
-     * @deprecated Executable agent tools should be contributed by server
-     * plugins. This output remains for migration only.
-     */
-    type: "agent-tool";
+declare interface BoringFrontPanelCommandRegistration {
+    id: string;
+    title: string;
+    panelId?: string;
+    run?: () => void;
+    keywords?: string[];
+    shortcut?: string;
+    when?: () => boolean;
+}
+
+declare interface BoringFrontPanelRegistration<T = unknown> {
     id: string;
-    tool: AgentTool;
+    component: ComponentType<PaneProps<T>> | (() => Promise<{
+        default: ComponentType<PaneProps<T>>;
+    }>);
+    label?: string;
+    icon?: ComponentType<{
+        className?: string;
+    }>;
+    placement?: string;
+    requiresCapabilities?: string[];
+    essential?: boolean;
+    lazy?: boolean;
+    chromeless?: boolean;
+    source?: string;
 }
 
-declare interface BindingOutput {
-    type: "binding";
+declare interface BoringFrontProviderRegistration {
     id: string;
-    component: PluginBinding;
+    component: PluginProvider;
+}
+
+declare interface BoringFrontSurfaceResolverRegistration {
+    id?: string;
+    kind: string;
+    source?: string;
+    resolve: (request: SurfaceOpenRequest) => SurfacePanelResolution | null | undefined;
 }
 
 declare type CatalogAdapter = {
@@ -65,11 +116,6 @@ declare type CatalogFacetValue = {
     count: number;
 };
 
-declare interface CatalogOutput {
-    type: "catalog";
-    catalog: CatalogConfig;
-}
-
 declare type CatalogRow = {
     id: string;
     title: string;
@@ -124,11 +170,6 @@ declare interface CommandConfig {
     pluginId?: string;
 }
 
-declare interface CommandOutput {
-    type: "command";
-    command: CommandConfig;
-}
-
 export declare function createLocalStorageSessions(opts?: CreateLocalStorageSessionsOptions): WorkspaceLocalSessionsStore;
 
 export declare interface CreateLocalStorageSessionsOptions {
@@ -136,19 +177,7 @@ export declare interface CreateLocalStorageSessionsOptions {
     initial?: () => WorkspaceLocalSessionsState;
 }
 
-declare type JSONSchema = Record<string, unknown>;
-
-declare interface LeftTabOutput<T = LeftTabParams> {
-    type: "left-tab";
-    id: string;
-    title: string;
-    icon?: PanelConfig<T>["icon"];
-    component: PanelConfig<T>["component"];
-    lazy?: PanelConfig<T>["lazy"];
-    requiresCapabilities?: PanelConfig<T>["requiresCapabilities"];
-    source?: PanelConfig<T>["source"];
-    chromeless?: PanelConfig<T>["chromeless"];
-}
+declare type FrontPluginHotReloadMode = "vite" | false;
 
 declare interface LeftTabParams {
     rootDir?: string;
@@ -196,11 +225,6 @@ declare interface PanelConfig<T = any> {
     }>);
 }
 
-declare interface PanelOutput<T = any> {
-    type: "panel";
-    panel: PanelConfig<T>;
-}
-
 /**
  * Unified prop shape for panel components rendered inside DockviewShell.
  *
@@ -231,8 +255,6 @@ declare interface PaneProps<T = unknown> {
 
 declare type PluginBinding = ComponentType<unknown>;
 
-declare type PluginOutput = LeftTabOutput | PanelOutput | CommandOutput | CatalogOutput | BindingOutput | ProviderOutput | SurfaceResolverOutput | AgentToolOutput;
-
 declare type PluginProvider = ComponentType<PluginProviderProps>;
 
 declare interface PluginProviderProps {
@@ -243,12 +265,6 @@ declare interface PluginProviderProps {
     children: ReactNode;
 }
 
-declare interface ProviderOutput {
-    type: "provider";
-    id: string;
-    component: PluginProvider;
-}
-
 declare interface SessionItem {
     id: string;
     title: string;
@@ -269,18 +285,6 @@ declare interface SurfacePanelResolution {
     score?: number;
 }
 
-declare interface SurfaceResolverConfig {
-    id: string;
-    resolve: (request: SurfaceOpenRequest) => SurfacePanelResolution | undefined;
-    source?: string;
-    pluginId?: string;
-}
-
-declare interface SurfaceResolverOutput {
-    type: "surface-resolver";
-    resolver: SurfaceResolverConfig;
-}
-
 declare interface SurfaceShellApi {
     /** Open a file in the workbench. Idempotent — re-activates an existing pane for the same path. */
     openFile: (path: string) => void;
@@ -310,23 +314,6 @@ declare interface SurfaceShellTab {
     params?: Record<string, unknown>;
 }
 
-declare interface ToolExecContext {
-    abortSignal: AbortSignal;
-    toolCallId: string;
-    onUpdate?: (partial: string) => void;
-    /** Agent chat/session id executing this tool, when known. */
-    sessionId?: string;
-}
-
-declare interface ToolResult {
-    content: Array<{
-        type: "text";
-        text: string;
-    }>;
-    isError?: boolean;
-    details?: unknown;
-}
-
 export declare function useLocalStorageSessions(store: WorkspaceLocalSessionsStore): WorkspaceLocalSessionsState;
 
 export declare type UseWorkspaceAgentSessions<TSession extends WorkspaceAgentSession = WorkspaceAgentSession> = (options: {
@@ -334,7 +321,7 @@ export declare type UseWorkspaceAgentSessions<TSession extends WorkspaceAgentSes
     storageKey: string;
 }) => WorkspaceAgentSessionsApi<TSession>;
 
-export declare function WorkspaceAgentFront<TSession extends WorkspaceAgentSession = WorkspaceAgentSession>({ workspaceId, chatPanel: chatPanelProp, useSessions: useSessionsProp, requestHeaders, sessionStorageKey, providerStorageKey, surfaceStorageKey, beforeShell, afterShell, panels, commands, catalogs, plugins, excludeDefaults, capabilities, apiBaseUrl, authHeaders, apiTimeout, defaultTheme, onThemeChange, persistenceEnabled, bridgeEndpoint, onAuthError, sessions, activeSessionId, onSwitchSession, onCreateSession, onDeleteSession, onActiveSessionIdChange, appTitle, defaultSessionTitle, topBarLeft, topBarRight, chatParams, extraPanels, extraCommands, onOpenNav, onOpenSurface, className, }: WorkspaceAgentFrontProps<TSession>): JSX.Element;
+export declare function WorkspaceAgentFront<TSession extends WorkspaceAgentSession = WorkspaceAgentSession>({ workspaceId, chatPanel: chatPanelProp, useSessions: useSessionsProp, requestHeaders, sessionStorageKey, providerStorageKey, surfaceStorageKey, beforeShell, afterShell, panels, commands, catalogs, plugins, excludeDefaults, capabilities, apiBaseUrl, authHeaders, apiTimeout, defaultTheme, onThemeChange, persistenceEnabled, bridgeEndpoint, onAuthError, sessions, activeSessionId, onSwitchSession, onCreateSession, onDeleteSession, onActiveSessionIdChange, appTitle, defaultSessionTitle, defaultSurfaceOpen, defaultWorkbenchLeftTab, topBarLeft, topBarRight, chatParams, hotReloadEnabled, frontPluginHotReload, extraPanels, extraCommands, onOpenNav, onOpenSurface, className, }: WorkspaceAgentFrontProps<TSession>): JSX.Element;
 
 export declare interface WorkspaceAgentFrontProps<TSession extends WorkspaceAgentSession = WorkspaceAgentSession> extends Omit<WorkspaceProviderProps, "children" | "workspaceId" | "storageKey" | "chatPanel">, Omit<ChatLayoutProps, "nav" | "navParams" | "center" | "centerParams" | "surface" | "surfaceParams" | "sidebar" | "sidebarParams" | "storageKey"> {
     workspaceId: string;
@@ -348,6 +335,8 @@ export declare interface WorkspaceAgentFrontProps<TSession extends WorkspaceAgen
     afterShell?: ReactNode;
     appTitle?: string;
     defaultSessionTitle?: string;
+    defaultSurfaceOpen?: boolean;
+    defaultWorkbenchLeftTab?: string;
     topBarLeft?: ReactNode;
     topBarRight?: ReactNode;
     sessions?: Array<{
@@ -361,6 +350,13 @@ export declare interface WorkspaceAgentFrontProps<TSession extends WorkspaceAgen
     onDeleteSession?: (id: string) => void;
     onActiveSessionIdChange?: (sessionId: string) => void;
     chatParams?: Record<string, unknown>;
+    /**
+     * Forward to ChatPanel — when `false`, the `/reload` slash command is
+     * hidden and the PluginUpdateStatus banner above the composer is
+     * suppressed. Production apps that don't ship live plugin editing
+     * should pass `false`. Defaults to `true` (dev/playground default).
+     */
+    hotReloadEnabled?: boolean;
     extraPanels?: string[];
     extraCommands?: SlashCommand[];
 }
@@ -437,27 +433,6 @@ declare interface WorkspaceChatPanelProps {
     [key: string]: unknown;
 }
 
-declare interface WorkspaceFrontPlugin {
-    id: string;
-    label?: string;
-    /**
-     * Context prepended to the agent's system prompt at boot. Concatenated
-     * across all registered plugins (in registration order) and joined with
-     * double-newlines. Plain Markdown. ~200-500 chars recommended.
-     */
-    systemPrompt?: string;
-    panels?: PanelConfig[];
-    commands?: CommandConfig[];
-    catalogs?: CatalogConfig[];
-    bindings?: PluginBinding[];
-    /**
-     * @deprecated Executable agent tools should be contributed by server
-     * plugins. This field remains for migration only.
-     */
-    agentTools?: AgentTool[];
-    outputs?: PluginOutput[];
-}
-
 export declare interface WorkspaceLocalSessionsState {
     sessions: SessionItem[];
     activeId: string;
@@ -474,7 +449,11 @@ export declare interface WorkspaceLocalSessionsStore {
 declare interface WorkspaceProviderProps {
     children: ReactNode;
     chatPanel?: WorkspaceChatPanelComponent;
-    plugins?: WorkspaceFrontPlugin[];
+    /**
+     * Front plugin entries produced by `definePlugin({ id, ... })` from
+     * `@hachej/boring-workspace/plugin`.
+     */
+    plugins?: BoringFrontFactoryWithId[];
     excludeDefaults?: string[];
     panels?: PanelConfig[];
     commands?: CommandConfig[];
@@ -492,6 +471,14 @@ declare interface WorkspaceProviderProps {
     bridgeEndpoint?: string | null;
     onAuthError?: (statusCode: number) => void;
     onOpenFile?: (path: string) => void;
+    debug?: boolean;
+    /**
+     * Hot-load dynamically discovered front plugin modules. The current
+     * implementation relies on Vite's /@fs transform endpoint, so it defaults to
+     * dev-only. Production hosts should keep this false until they provide their
+     * own module asset endpoint.
+     */
+    frontPluginHotReload?: FrontPluginHotReloadMode;
 }
 
 export { }