@hachej/boring-workspace 0.1.59 → 0.1.61

package/dist/app-front.d.ts

@@ -11,8 +11,8 @@ declare interface BoringFrontAPI {
     registerBinding(registration: BoringFrontBindingRegistration): void;
     registerCatalog(registration: CatalogConfig): void;
     registerPanel<T = unknown>(registration: BoringFrontPanelRegistration<T>): void;
+    registerWorkspaceSource<T = unknown>(registration: BoringFrontWorkspaceSourceRegistration<T>): void;
     registerPanelCommand(registration: BoringFrontPanelCommandRegistration): void;
-    registerLeftTab<T = LeftTabParams>(registration: BoringFrontLeftTabRegistration<T>): void;
     registerSurfaceResolver(registration: BoringFrontSurfaceResolverRegistration): void;
     registerToolRenderer(registration: BoringFrontToolRendererRegistration): void;
 }
@@ -34,20 +34,6 @@ declare type BoringFrontFactoryWithId = BoringFrontFactory & {
     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 BoringFrontPanelCommandRegistration {
     id: string;
     title: string;
@@ -67,7 +53,7 @@ declare interface BoringFrontPanelRegistration<T = unknown> {
     icon?: ComponentType<{
         className?: string;
     }>;
-    placement?: string;
+    placement?: PanelConfig["placement"];
     requiresCapabilities?: string[];
     essential?: boolean;
     lazy?: boolean;
@@ -84,6 +70,11 @@ declare interface BoringFrontProviderRegistration {
 declare interface BoringFrontSurfaceResolverRegistration {
     id?: string;
     kind: string;
+    title?: string;
+    description?: string;
+    targetHint?: string;
+    examples?: SurfaceResolverExample[];
+    metaSchema?: Record<string, unknown>;
     source?: string;
     resolve: (request: SurfaceOpenRequest) => SurfacePanelResolution | null | undefined;
 }
@@ -95,6 +86,22 @@ declare interface BoringFrontToolRendererRegistration {
     render: BoringFrontToolRenderer;
 }
 
+declare interface BoringFrontWorkspaceSourceRegistration<T = unknown> {
+    id: string;
+    component: ComponentType<WorkspaceSourceProps<T>> | (() => Promise<{
+        default: ComponentType<WorkspaceSourceProps<T>>;
+    }>);
+    label?: string;
+    icon?: ComponentType<{
+        className?: string;
+    }>;
+    requiresCapabilities?: string[];
+    lazy?: boolean;
+    chromeless?: boolean;
+    defaultPanelId?: string;
+    source?: string;
+}
+
 declare type CatalogAdapter = {
     search(args: CatalogSearchArgs): Promise<CatalogSearchResult>;
     fetchFacets?(args: CatalogFacetsArgs): Promise<CatalogFacets>;
@@ -168,6 +175,10 @@ declare interface ChatLayoutProps {
     flashChatPaneId?: string | null;
     surface?: string | null;
     surfaceParams?: Record<string, unknown>;
+    /** Opaque overlay rendered over the full chat stage only (not over the workbench). */
+    chatOverlay?: ReactNode;
+    /** Called when shell chrome needs to dismiss the chat overlay before collapsing chat. */
+    onCloseChatOverlay?: () => void;
     surfaceOverlay?: ReactNode;
     sidebar?: string | null;
     sidebarParams?: Record<string, unknown>;
@@ -196,6 +207,22 @@ declare interface CommandConfig {
     pluginId?: string;
 }
 
+declare interface CommandPaletteSessionItem {
+    id: string;
+    title?: string | null;
+    updatedAt?: string | number;
+    turnCount?: number;
+}
+
+declare interface CommandPaletteSessionSearchConfig {
+    sessions: CommandPaletteSessionItem[];
+    activeId?: string | null;
+    openIds?: readonly string[];
+    search?: (sessions: readonly CommandPaletteSessionItem[], query: string) => CommandPaletteSessionItem[];
+    onSwitch: (id: string) => void;
+    onOpenAsTab: (id: string) => void;
+}
+
 export declare function createLocalStorageSessions(opts?: CreateLocalStorageSessionsOptions): WorkspaceLocalSessionsStore;
 
 export declare interface CreateLocalStorageSessionsOptions {
@@ -217,20 +244,6 @@ export declare const FULL_PAGE_PANEL_RENDER_FAILED = "FULL_PAGE_PANEL_RENDER_FAI
 
 export declare const FULL_PAGE_PANEL_UNKNOWN_COMPONENT = "FULL_PAGE_PANEL_UNKNOWN_COMPONENT";
 
-declare interface LeftTabParams {
-    rootDir?: string;
-    query?: string;
-    searchQuery?: string;
-    bridge?: unknown;
-    chromeless?: boolean;
-    /** Optional DOM target for left-tab toolbar actions owned by the pane. */
-    chromeActionsElement?: Element | null;
-    revealFileTreeRequest?: {
-        path: string;
-        seq: number;
-    } | null;
-}
-
 declare interface OpenPanelConfig {
     /** Panel instance id. If a panel with this id is already open, it's re-activated instead of duplicated. */
     id: string;
@@ -248,14 +261,12 @@ declare interface PanelConfig<T = any> {
     icon?: ComponentType<{
         className?: string;
     }>;
-    /** Placement hint: "left" | "center" | "right" | "bottom" | "left-tab" | "right-tab" */
-    placement?: string;
+    /** Placement hint. Public plugin placements: "workspace-page" | "shared-dockview". */
+    placement?: PanelPlacement | string;
     requiresCapabilities?: string[];
     essential?: boolean;
     chromeless?: boolean;
     supportsFullPage?: boolean;
-    /** Center-panel id opened when this config is used as a left-tab category. */
-    defaultPanelId?: string;
     /** Source: "builtin" | "app" */
     source?: string;
     pluginId?: string;
@@ -272,6 +283,8 @@ declare interface PanelConfig<T = any> {
     }>);
 }
 
+declare type PanelPlacement = "left" | "center" | "right" | "bottom" | "shared-dockview" | "workspace-page" | "right-tab";
+
 /**
  * Unified prop shape for panel components rendered inside DockviewShell.
  *
@@ -345,9 +358,17 @@ declare interface SurfacePanelResolution {
     score?: number;
 }
 
+declare interface SurfaceResolverExample {
+    target: string;
+    label?: string;
+    meta?: Record<string, unknown>;
+}
+
 declare interface SurfaceShellApi {
     /** Open a file in the workbench. Idempotent — re-activates an existing pane for the same path. */
-    openFile: (path: string) => void;
+    openFile: (path: string, opts?: {
+        mode?: "view" | "edit" | "diff";
+    }) => void;
     /** Open a plugin-defined surface target through the registered surface resolvers. */
     openSurface: (request: SurfaceOpenRequest) => void;
     /**
@@ -377,6 +398,8 @@ declare interface SurfaceShellProps {
     onChange?: (snapshot: SurfaceShellSnapshot) => void;
     /** Optional close action for hosts that model the workbench as collapsible. */
     onClose?: () => void;
+    /** Render the built-in top-right close affordance. Hosts can set false when they provide their own chrome. */
+    showCloseAction?: boolean;
     /**
      * Extra panel ids (registered via WorkspaceProvider's `panels` prop) that
      * this workbench is allowed to render. Defaults to the built-in
@@ -407,6 +430,8 @@ declare interface SurfaceShellSnapshot {
 
 declare interface SurfaceShellTab {
     id: string;
+    /** Registered panel component id for this tab. May differ from the tab instance id. */
+    component?: string;
     title: string;
     params?: Record<string, unknown>;
 }
@@ -422,9 +447,39 @@ export declare type UseWorkspaceAgentSessions<TSession extends WorkspaceAgentSes
     refreshKey?: unknown;
 }) => 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, debug, bridgeEndpoint, fullPageBasePath, onAuthError, sessions, activeSessionId, onSwitchSession, onCreateSession, onDeleteSession, onActiveSessionIdChange, appTitle, workspaceLabel, defaultSessionTitle, navEnabled, defaultNavOpen, defaultSurfaceOpen, defaultWorkbenchLeftTab, defaultWorkbenchLeftOpen, surfaceInitialPanels, topBarLeft, topBarRight, showThemeToggle, chatParams, externalPlugins, hotReloadEnabled, frontPluginHotReload, extraPanels, extraCommands, provisionWorkspace, bootPreloadPaths, onWorkspaceWarmupStatusChange, onOpenNav, onOpenSurface, surfaceButtonBottomOffset, className, }: WorkspaceAgentFrontProps<TSession>): JSX.Element;
+declare interface WorkspaceAgentAppLeftAction {
+    id: string;
+    label: string;
+    icon: ReactNode;
+    onClick: () => void;
+    trailing?: ReactNode;
+    emphasis?: boolean;
+}
+
+declare type WorkspaceAgentAppLeftHeaderMode = "full" | "workspace" | "hidden";
+
+declare type WorkspaceAgentAppLeftLayoutMode = "single-project" | "multi-project";
+
+declare interface WorkspaceAgentAppLeftProject {
+    id: string;
+    name: string;
+    available?: boolean;
+    sessionCount?: number;
+    blockedCount?: number;
+    sessions?: WorkspaceAgentAppLeftProjectSession[];
+    hasMoreSessions?: boolean;
+    loadingSessions?: boolean;
+}
+
+declare interface WorkspaceAgentAppLeftProjectSession {
+    id: string;
+    title?: string | null;
+    updatedAt?: string | number;
+}
+
+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, debug, bridgeEndpoint, fullPageBasePath, onAuthError, sessions, activeSessionId, onSwitchSession, onCreateSession, onDeleteSession, onActiveSessionIdChange, appTitle, workspaceLabel, workspaceSectionTitle, appLeftLayoutMode, appLeftHeaderMode, appLeftProjects, appLeftActiveProjectId, onSwitchAppLeftProject, onOpenAppLeftProjectSession, onShowMoreAppLeftProjectSessions, onCreateAppLeftProject, onOpenAppLeftProjectSettings, onOpenAppLeftProjectInNewTab, defaultSessionTitle, workspaceLayout, navEnabled, defaultNavOpen, defaultSurfaceOpen, defaultWorkbenchLeftTab, defaultWorkbenchLeftOpen, surfaceInitialPanels, topBarLeft, topBarRight, showThemeToggle, showSkills, showPlugins, appLeftActions, chatParams, externalPlugins, hotReloadEnabled, frontPluginHotReload, extraPanels, extraCommands, provisionWorkspace, bootPreloadPaths, onWorkspaceWarmupStatusChange, onOpenNav, onOpenSurface, surfaceButtonBottomOffset, 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" | "chatPanes" | "activeChatPaneId" | "onActiveChatPaneChange" | "onCloseChatPane" | "onCreateChatPaneAfter" | "onDropChatSession" | "flashChatPaneId" | "surface" | "surfaceParams" | "sidebar" | "sidebarParams" | "storageKey"> {
+export declare interface WorkspaceAgentFrontProps<TSession extends WorkspaceAgentSession = WorkspaceAgentSession> extends Omit<WorkspaceProviderProps, "children" | "workspaceId" | "storageKey" | "chatPanel" | "commandPaletteSessionSearch">, Omit<ChatLayoutProps, "nav" | "navParams" | "center" | "centerParams" | "chatPanes" | "activeChatPaneId" | "onActiveChatPaneChange" | "onCloseChatPane" | "onCreateChatPaneAfter" | "onDropChatSession" | "flashChatPaneId" | "surface" | "surfaceParams" | "sidebar" | "sidebarParams" | "storageKey"> {
     workspaceId: string;
     chatPanel?: ComponentType<WorkspaceChatPanelProps>;
     useSessions?: UseWorkspaceAgentSessions<TSession>;
@@ -436,7 +491,29 @@ export declare interface WorkspaceAgentFrontProps<TSession extends WorkspaceAgen
     afterShell?: ReactNode;
     appTitle?: string;
     workspaceLabel?: string;
+    /** App-left workspace/project section title. Defaults to "Workspaces". */
+    workspaceSectionTitle?: string;
+    /** App-left layout mode. single-project uses the workspace dropdown; multi-project renders workspaces inline. */
+    appLeftLayoutMode?: WorkspaceAgentAppLeftLayoutMode;
+    /** App-left header mode: full brand, workspace picker only, or hidden with collapse-button clearance. */
+    appLeftHeaderMode?: WorkspaceAgentAppLeftHeaderMode;
+    /** Optional cross-project overview rendered in the app-left workspace/project section. */
+    appLeftProjects?: WorkspaceAgentAppLeftProject[];
+    appLeftActiveProjectId?: string | null;
+    onSwitchAppLeftProject?: (projectId: string) => void;
+    onOpenAppLeftProjectSession?: (projectId: string, sessionId: string) => void;
+    onShowMoreAppLeftProjectSessions?: (projectId: string) => void;
+    onCreateAppLeftProject?: () => void;
+    /** Open a project's workspace settings (host wires routing — workspace pkg has no router). */
+    onOpenAppLeftProjectSettings?: (projectId: string) => void;
+    /** Open a project in a new browser tab (host builds the href). */
+    onOpenAppLeftProjectInNewTab?: (projectId: string) => void;
     defaultSessionTitle?: string;
+    /**
+     * Opt into the Phase 2 app/session left-pane shell. Defaults to the
+     * existing classic top-bar + session-drawer workspace layout.
+     */
+    workspaceLayout?: WorkspaceAgentLayout;
     navEnabled?: boolean;
     defaultNavOpen?: boolean;
     defaultSurfaceOpen?: boolean;
@@ -452,6 +529,12 @@ export declare interface WorkspaceAgentFrontProps<TSession extends WorkspaceAgen
      * UserMenu) should set this to false to avoid a duplicate control.
      */
     showThemeToggle?: boolean;
+    /** Show the plugin-tabs Skills action/overlay. Defaults to true. */
+    showSkills?: boolean;
+    /** Show the plugin-tabs Plugins action/overlay. Defaults to true. */
+    showPlugins?: boolean;
+    /** Extra actions inserted into the app-left primary action list before built-in management actions. */
+    appLeftActions?: readonly WorkspaceAgentAppLeftAction[];
     sessions?: Array<{
         id: string;
         title?: string | null;
@@ -484,6 +567,8 @@ export declare interface WorkspaceAgentFrontProps<TSession extends WorkspaceAgen
     onWorkspaceWarmupStatusChange?: (status: WorkspaceWarmupStatus) => void;
 }
 
+export declare type WorkspaceAgentLayout = "classic" | "plugin-tabs";
+
 export declare interface WorkspaceAgentSession {
     id: string;
     title?: string | null;
@@ -645,6 +730,7 @@ declare interface WorkspaceProviderProps {
      */
     frontPluginHotReload?: FrontPluginHotReloadMode;
     fullPageBasePath?: string;
+    commandPaletteSessionSearch?: CommandPaletteSessionSearchConfig;
 }
 
 declare type WorkspaceRuntimeDependenciesWarmupStatus = {
@@ -653,6 +739,24 @@ declare type WorkspaceRuntimeDependenciesWarmupStatus = {
     requirement?: string;
 };
 
+declare interface WorkspaceSourceOpenPanelConfig {
+    id: string;
+    component: string;
+    title?: string;
+    params?: Record<string, unknown>;
+}
+
+/**
+ * Props for workspace source panes hosted in the left workspace rail.
+ * These are not Dockview panels: they receive only source-pane params and
+ * the explicit actions that the source host supports.
+ */
+declare interface WorkspaceSourceProps<T = unknown> {
+    params: T;
+    className?: string;
+    openPanel?: (config: WorkspaceSourceOpenPanelConfig) => void;
+}
+
 export declare type WorkspaceWarmupStatus = {
     status: "preparing";
     requirement?: "workspace-fs" | "sandbox-exec" | "ui-bridge";