@hachej/boring-workspace 0.1.23 → 0.1.26

package/dist/app-front.d.ts

@@ -70,6 +70,7 @@ declare interface BoringFrontPanelRegistration<T = unknown> {
     essential?: boolean;
     lazy?: boolean;
     chromeless?: boolean;
+    supportsFullPage?: boolean;
     source?: string;
 }
 
@@ -151,11 +152,13 @@ declare interface ChatLayoutProps {
     centerParams?: Record<string, unknown>;
     surface?: string | null;
     surfaceParams?: Record<string, unknown>;
+    surfaceOverlay?: ReactNode;
     sidebar?: string | null;
     sidebarParams?: Record<string, unknown>;
     storageKey?: string;
     onOpenNav?: () => void;
     onOpenSurface?: () => void;
+    surfaceButtonBottomOffset?: number;
     onOpenSidebar?: () => void;
     className?: string;
 }
@@ -179,12 +182,28 @@ export declare interface CreateLocalStorageSessionsOptions {
 
 declare type FrontPluginHotReloadMode = "vite" | false;
 
+export declare const FULL_PAGE_PANEL_INVALID_PARAMS_JSON = "FULL_PAGE_PANEL_INVALID_PARAMS_JSON";
+
+export declare const FULL_PAGE_PANEL_MISSING_COMPONENT = "FULL_PAGE_PANEL_MISSING_COMPONENT";
+
+export declare const FULL_PAGE_PANEL_NOT_SUPPORTED = "FULL_PAGE_PANEL_NOT_SUPPORTED";
+
+export declare const FULL_PAGE_PANEL_PARAMS_NOT_OBJECT = "FULL_PAGE_PANEL_PARAMS_NOT_OBJECT";
+
+export declare const FULL_PAGE_PANEL_RENDER_FAILED = "FULL_PAGE_PANEL_RENDER_FAILED";
+
+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;
+    revealFileTreeRequest?: {
+        path: string;
+        seq: number;
+    } | null;
 }
 
 declare type OpenArtifactHandler = (path: string) => void;
@@ -211,6 +230,7 @@ declare interface PanelConfig<T = any> {
     requiresCapabilities?: string[];
     essential?: boolean;
     chromeless?: boolean;
+    supportsFullPage?: boolean;
     /** Source: "builtin" | "app" */
     source?: string;
     pluginId?: string;
@@ -253,6 +273,17 @@ declare interface PaneProps<T = unknown> {
     className?: string;
 }
 
+export declare interface ParsedFullPagePanelLocation {
+    componentId: string | null;
+    params: Record<string, unknown>;
+    error?: {
+        code: WorkspaceFullPageRouteErrorCode;
+        message: string;
+    };
+}
+
+export declare function parseFullPagePanelLocation(search: string): ParsedFullPagePanelLocation;
+
 declare type PluginBinding = ComponentType<unknown>;
 
 declare type PluginProvider = ComponentType<PluginProviderProps>;
@@ -299,10 +330,46 @@ declare interface SurfaceShellApi {
     openPanel: (config: OpenPanelConfig) => void;
     /** Hide the workbench's left sources/files pane while leaving the workbench open. */
     closeWorkbenchLeftPane: () => void;
+    /** Reveal/select a file-tree path without opening an editor pane. */
+    expandToFile: (path: string) => void;
     /** Current snapshot of open tabs + active tab. */
     getSnapshot: () => SurfaceShellSnapshot;
 }
 
+declare interface SurfaceShellProps {
+    rootDir?: string;
+    sidebarDefaultWidth?: number;
+    sidebarMinWidth?: number;
+    sidebarMaxWidth?: number;
+    storageKey?: string;
+    /** Called once when the surface dockview becomes ready, with an imperative handle. */
+    onReady?: (api: SurfaceShellApi) => void;
+    /** Called on every panel add/remove/active-change with the current snapshot. */
+    onChange?: (snapshot: SurfaceShellSnapshot) => void;
+    /** Optional close action for hosts that model the workbench as collapsible. */
+    onClose?: () => void;
+    /**
+     * Extra panel ids (registered via WorkspaceProvider's `panels` prop) that
+     * this workbench is allowed to render. Defaults to the built-in
+     * editor/viewer panels only. Pass app-specific pane ids here so calls
+     * like `surface.openPanel({ component: "chart-canvas" })` actually
+     * instantiate — without this, dockview's components map filters them
+     * out and you get an empty tab. Two-layer defense: SurfaceShell.openPanel
+     * validates against the registry (loud throw on unknown), AND the
+     * dockview allowlist below filters which registered panels can mount
+     * inside THIS surface (so a host can gate panels per shell instance).
+     */
+    extraPanels?: string[];
+    defaultLeftTab?: string;
+    initialPanels?: Array<{
+        id: string;
+        component: string;
+        title?: string;
+        params?: Record<string, unknown>;
+    }>;
+    className?: string;
+}
+
 declare interface SurfaceShellSnapshot {
     openTabs: SurfaceShellTab[];
     activeTab: string | null;
@@ -319,9 +386,11 @@ export declare function useLocalStorageSessions(store: WorkspaceLocalSessionsSto
 export declare type UseWorkspaceAgentSessions<TSession extends WorkspaceAgentSession = WorkspaceAgentSession> = (options: {
     requestHeaders: Record<string, string>;
     storageKey: string;
+    enabled?: boolean;
+    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, 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 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, fullPageBasePath, onAuthError, sessions, activeSessionId, onSwitchSession, onCreateSession, onDeleteSession, onActiveSessionIdChange, appTitle, defaultSessionTitle, navEnabled, defaultNavOpen, defaultSurfaceOpen, defaultWorkbenchLeftTab, surfaceInitialPanels, topBarLeft, topBarRight, chatParams, 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" | "surface" | "surfaceParams" | "sidebar" | "sidebarParams" | "storageKey"> {
     workspaceId: string;
@@ -335,8 +404,11 @@ export declare interface WorkspaceAgentFrontProps<TSession extends WorkspaceAgen
     afterShell?: ReactNode;
     appTitle?: string;
     defaultSessionTitle?: string;
+    navEnabled?: boolean;
+    defaultNavOpen?: boolean;
     defaultSurfaceOpen?: boolean;
     defaultWorkbenchLeftTab?: string;
+    surfaceInitialPanels?: SurfaceShellProps["initialPanels"];
     topBarLeft?: ReactNode;
     topBarRight?: ReactNode;
     sessions?: Array<{
@@ -359,6 +431,9 @@ export declare interface WorkspaceAgentFrontProps<TSession extends WorkspaceAgen
     hotReloadEnabled?: boolean;
     extraPanels?: string[];
     extraCommands?: SlashCommand[];
+    provisionWorkspace?: boolean;
+    bootPreloadPaths?: string[];
+    onWorkspaceWarmupStatusChange?: (status: WorkspaceWarmupStatus) => void;
 }
 
 export declare interface WorkspaceAgentSession {
@@ -370,6 +445,7 @@ export declare interface WorkspaceAgentSession {
 export declare interface WorkspaceAgentSessionsApi<TSession extends WorkspaceAgentSession = WorkspaceAgentSession> {
     sessions: TSession[];
     loading: boolean;
+    error?: Error | null;
     activeSessionId?: string | null;
     activeSession?: TSession | null;
     switch: (id: string) => void;
@@ -394,13 +470,25 @@ declare type WorkspaceAttentionBlockerAction = {
     label: string;
 };
 
-export declare function WorkspaceBootGate({ workspaceId, requestHeaders, apiBaseUrl, preloadPaths, loadingFallback, errorFallback, children, }: WorkspaceBootGateProps): JSX.Element;
+export declare function WorkspaceBackgroundBoot({ workspaceId, requestHeaders, apiBaseUrl, preloadPaths, provisionWorkspace, onStatusChange, }: WorkspaceBackgroundBootProps): null;
+
+export declare interface WorkspaceBackgroundBootProps {
+    workspaceId: string;
+    requestHeaders?: Record<string, string>;
+    apiBaseUrl?: string | null;
+    preloadPaths?: string[];
+    provisionWorkspace?: boolean;
+    onStatusChange?: (status: WorkspaceWarmupStatus) => void;
+}
+
+export declare function WorkspaceBootGate({ workspaceId, requestHeaders, apiBaseUrl, preloadPaths, provisionWorkspace, loadingFallback, errorFallback, children, }: WorkspaceBootGateProps): JSX.Element;
 
 export declare interface WorkspaceBootGateProps {
     workspaceId: string;
     requestHeaders?: Record<string, string>;
     apiBaseUrl?: string | null;
     preloadPaths?: string[];
+    provisionWorkspace?: boolean;
     loadingFallback?: ReactNode | ((status: string) => ReactNode);
     errorFallback?: ReactNode | ((message: string) => ReactNode);
     children: ReactNode;
@@ -422,6 +510,8 @@ declare interface WorkspaceChatPanelProps {
     isWorkbenchOpen?: () => boolean;
     /** Opens the visible workbench surface before dispatching a command. */
     openWorkbench?: () => void;
+    /** Opens the visible workbench sources/file-tree pane before dispatching a reveal. */
+    openWorkbenchSources?: () => void;
     /** Closes the visible workbench surface after an ephemeral command finishes. */
     closeWorkbench?: () => void;
     /** Generic workspace blockers that should prevent submitting new chat turns. */
@@ -433,6 +523,15 @@ declare interface WorkspaceChatPanelProps {
     [key: string]: unknown;
 }
 
+export declare function WorkspaceFullPagePanel({ componentId, params }: WorkspaceFullPagePanelProps): JSX.Element;
+
+export declare interface WorkspaceFullPagePanelProps {
+    componentId: string;
+    params?: Record<string, unknown>;
+}
+
+export declare type WorkspaceFullPageRouteErrorCode = typeof FULL_PAGE_PANEL_MISSING_COMPONENT | typeof FULL_PAGE_PANEL_INVALID_PARAMS_JSON | typeof FULL_PAGE_PANEL_PARAMS_NOT_OBJECT | typeof FULL_PAGE_PANEL_UNKNOWN_COMPONENT | typeof FULL_PAGE_PANEL_NOT_SUPPORTED | typeof FULL_PAGE_PANEL_RENDER_FAILED;
+
 export declare interface WorkspaceLocalSessionsState {
     sessions: SessionItem[];
     activeId: string;
@@ -479,6 +578,19 @@ declare interface WorkspaceProviderProps {
      * own module asset endpoint.
      */
     frontPluginHotReload?: FrontPluginHotReloadMode;
+    fullPageBasePath?: string;
 }
 
+export declare type WorkspaceWarmupStatus = {
+    status: "preparing";
+    requirement?: "workspace-fs" | "sandbox-exec" | "ui-bridge";
+    message?: string;
+} | {
+    status: "ready";
+} | {
+    status: "failed";
+    message: string;
+    requirement?: "workspace-fs" | "sandbox-exec" | "ui-bridge";
+};
+
 export { }