@hachej/boring-workspace 0.1.63 → 0.1.65

package/dist/workspace.d.ts

@@ -8,7 +8,7 @@ import { DockviewPanelApi } from 'dockview-react';
 import { ErrorInfo } from 'react';
 import { Extension } from '@codemirror/state';
 import { FunctionComponentElement } from 'react';
-import { JSX } from 'react/jsx-runtime';
+import { JSX } from 'react';
 import { JSXElementConstructor } from 'react';
 import { LucideIcon } from 'lucide-react';
 import { MouseEvent as MouseEvent_2 } from 'react';
@@ -48,6 +48,11 @@ export declare interface AgentTool {
     execute(params: Record<string, unknown>, ctx: ToolExecContext): Promise<ToolResult>;
 }
 
+export declare interface AppLeftOverlayChromeValue {
+    headerInsetStart: boolean;
+    headerInsetEnd: boolean;
+}
+
 export declare interface ArtifactPanel {
     id: string;
     component: string;
@@ -80,6 +85,7 @@ export declare function bootstrap(options: BootstrapOptions): BootstrapResult;
 export declare interface BootstrapOptions {
     chatPanel: unknown;
     plugins?: BoringFrontFactoryWithId[];
+    capturedPlugins?: CapturedFrontPlugin[];
     defaults?: BoringFrontFactoryWithId[];
     excludeDefaults?: string[];
     registries: {
@@ -104,10 +110,27 @@ declare interface BoringFrontAPI {
     registerPanel<T = unknown>(registration: BoringFrontPanelRegistration<T>): void;
     registerWorkspaceSource<T = unknown>(registration: BoringFrontWorkspaceSourceRegistration<T>): void;
     registerPanelCommand(registration: BoringFrontPanelCommandRegistration): void;
+    registerAppLeftAction(registration: BoringFrontAppLeftActionRegistration): void;
     registerSurfaceResolver(registration: BoringFrontSurfaceResolverRegistration): void;
     registerToolRenderer(registration: BoringFrontToolRendererRegistration): void;
 }
 
+declare interface BoringFrontAppLeftActionRegistration {
+    id: string;
+    label: string;
+    icon?: ComponentType<{
+        className?: string;
+    }>;
+    trailing?: ComponentType;
+    overlay: ComponentType<BoringFrontAppLeftOverlayProps>;
+    order?: number;
+    emphasis?: boolean;
+}
+
+declare interface BoringFrontAppLeftOverlayProps {
+    onClose: () => void;
+}
+
 declare interface BoringFrontBindingRegistration {
     id: string;
     component: PluginBinding;
@@ -271,6 +294,7 @@ declare interface CapturedBoringFrontRegistrations {
     panels: BoringFrontPanelRegistration<any>[];
     workspaceSources: BoringFrontWorkspaceSourceRegistration<any>[];
     panelCommands: BoringFrontPanelCommandRegistration[];
+    appLeftActions: BoringFrontAppLeftActionRegistration[];
     surfaceResolvers: BoringFrontSurfaceResolverRegistration[];
     toolRenderers: BoringFrontToolRendererRegistration[];
 }
@@ -390,6 +414,8 @@ export declare interface ChatLayoutProps {
     center?: string;
     centerParams?: Record<string, unknown>;
     chatPanes?: ChatPaneDescriptor[];
+    /** Optional host actions rendered in the active chat pane header. */
+    chatTopActions?: ReactNode;
     activeChatPaneId?: string | null;
     onActiveChatPaneChange?: (id: string) => void;
     onCloseChatPane?: (id: string) => void;
@@ -533,24 +559,24 @@ export declare function createWorkspacePluginClient(apiBaseUrl: string, workspac
 export declare function createWorkspaceStore(options?: CreateWorkspaceStoreOptions): {
     (): WorkspaceStore;
     <U>(selector: (state: WorkspaceStore) => U): U;
-} & Omit<StoreApi_3<WorkspaceStore>, "setState" | "persist"> & {
+} & Omit< StoreApi_3<WorkspaceStore>, "setState" | "persist"> & {
     setState(partial: WorkspaceStore | Partial<WorkspaceStore> | ((state: WorkspaceStore) => WorkspaceStore | Partial<WorkspaceStore>), replace?: false | undefined): unknown;
     setState(state: WorkspaceStore | ((state: WorkspaceStore) => WorkspaceStore), replace: true): unknown;
     persist: {
-        setOptions: (options: Partial<PersistOptions<WorkspaceStore, {
-        layout: unknown;
-        sidebar: SidebarState;
-        panelSizes: Record<string, number>;
+        setOptions: (options: Partial< PersistOptions<WorkspaceStore, {
+            layout: unknown;
+            sidebar: SidebarState;
+            panelSizes: Record<string, number>;
         }, unknown>>) => void;
         clearStorage: () => void;
         rehydrate: () => Promise<void> | void;
         hasHydrated: () => boolean;
         onHydrate: (fn: (state: WorkspaceStore) => void) => () => void;
         onFinishHydration: (fn: (state: WorkspaceStore) => void) => () => void;
-        getOptions: () => Partial<PersistOptions<WorkspaceStore, {
-        layout: unknown;
-        sidebar: SidebarState;
-        panelSizes: Record<string, number>;
+        getOptions: () => Partial< PersistOptions<WorkspaceStore, {
+            layout: unknown;
+            sidebar: SidebarState;
+            panelSizes: Record<string, number>;
         }, unknown>>;
     };
 } & {
@@ -733,7 +759,7 @@ declare class FetchClient {
     private retryBaseMs;
     constructor(opts: FetchClientOptions);
     private request;
-    getTree(path: string, signal?: AbortSignal): Promise<FileEntry[]>;
+    getTree(path: string, signal?: AbortSignal, filesystem?: string): Promise<FileEntry[]>;
     getFile(path: string, signal?: AbortSignal, filesystem?: string): Promise<FileContent>;
     /**
      * Write file content. When `expectedMtimeMs` is supplied, the server
@@ -800,6 +826,8 @@ declare class FileConflictError extends Error {
 
 declare interface FileContent {
     content: string;
+    /** Access granted by the resolved filesystem binding, when the server exposes it. */
+    access?: "readonly" | "readwrite";
     /**
      * Server-stat'd modification time. Used as the OCC baseline for the
      * next write — the client sends it back as `expectedMtimeMs` so the
@@ -934,7 +962,7 @@ export declare interface FileTreeNode {
  * `<FileTreeView>`. Drop into a dockview registry as-is, or compose
  * `FileTreeView` directly when you want different chrome/search UX.
  */
-export declare function FileTreePane({ params, rootDir, searchQuery: controlledSearchQuery, panelApi, bridge, api, chromeless, className, }: FileTreePaneProps): JSX.Element;
+export declare function FileTreePane({ params, rootDir, searchQuery: controlledSearchQuery, panelApi, bridge, api, chromeless, filesystem, access, roots, className, }: FileTreePaneProps): JSX.Element;
 
 declare interface FileTreePaneParams extends LeftTabParams {
     rootDir?: string;
@@ -942,6 +970,9 @@ declare interface FileTreePaneParams extends LeftTabParams {
     query?: string;
     bridge?: unknown;
     chromeless?: boolean;
+    filesystem?: FilesystemId;
+    access?: "readonly" | "readwrite";
+    roots?: FileTreeRootConfig[];
     revealFileTreeRequest?: {
         path: string;
         seq: number;
@@ -954,6 +985,9 @@ export declare interface FileTreePaneProps extends Partial<PaneProps<FileTreePan
     panelApi?: DockviewPanelApi;
     bridge?: FileTreeBridge;
     chromeless?: boolean;
+    filesystem?: FilesystemId;
+    access?: "readonly" | "readwrite";
+    roots?: FileTreeRootConfig[];
     className?: string;
 }
 
@@ -982,6 +1016,14 @@ export declare interface FileTreeProps {
     className?: string;
 }
 
+declare interface FileTreeRootConfig {
+    filesystem: FilesystemId;
+    label: string;
+    rootDir?: string;
+    access?: "readonly" | "readwrite";
+    searchPlaceholder?: string;
+}
+
 /**
  * File tree with the full workbench actions: tracks container height,
  * routes selects through `bridge.openFile`, and provides a right-click
@@ -993,7 +1035,7 @@ export declare interface FileTreeProps {
  * want a "Files" panel; `WorkbenchLeftPane` uses this primitive directly to
  * share its search input with the Data tab.
  */
-export declare function FileTreeView({ rootDir, searchQuery, bridge, revealFileTreeRequest, ignoreNames, className, }: FileTreeViewProps): JSX.Element;
+export declare function FileTreeView({ rootDir, searchQuery, bridge, revealFileTreeRequest, filesystem, access, ignoreNames, className, }: FileTreeViewProps): JSX.Element;
 
 export declare interface FileTreeViewProps {
     rootDir?: string;
@@ -1004,6 +1046,8 @@ export declare interface FileTreeViewProps {
         path: string;
         seq: number;
     } | null;
+    filesystem?: FilesystemId;
+    access?: "readonly" | "readwrite";
     /**
      * Names (or regex patterns) to hide from the tree. Defaults to
      * `DEFAULT_TREE_IGNORE` (node_modules, .git, dist, …). Pass `[]` to
@@ -1083,7 +1127,7 @@ export declare interface LeftTabParams {
     } | null;
 }
 
-export declare function MarkdownEditor({ content, onChange, readOnly, placeholder, className, documentPath, }: MarkdownEditorProps): JSX.Element;
+export declare function MarkdownEditor({ content, onChange, readOnly, placeholder, className, documentPath, filesystem: rawFilesystem, }: MarkdownEditorProps): JSX.Element;
 
 export declare function MarkdownEditorPane({ params, api, className }: MarkdownEditorPaneProps): JSX.Element;
 
@@ -1101,6 +1145,8 @@ export declare interface MarkdownEditorProps {
     className?: string;
     /** Workspace-relative markdown file path, used to make uploaded image links relative. */
     documentPath?: string;
+    /** Filesystem identity for relative markdown links/assets. Defaults to user. */
+    filesystem?: FilesystemId;
 }
 
 export declare const MAX_PANELS = 50;
@@ -1140,7 +1186,9 @@ export declare function onFilesystemChanged(handler: (payload: FilesystemEventMe
     path: string;
 }) => void): () => void;
 
-export declare type OpenArtifactHandler = (path: string) => void;
+export declare type OpenArtifactHandler = (path: string, options?: {
+    filesystem?: FilesystemId;
+}) => void;
 
 export declare const openFileSchema: z.ZodObject<{
     path: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
@@ -1366,7 +1414,7 @@ export declare type PluginBinding = ComponentType<unknown>;
 export declare interface PluginContributionError {
     kind: "contribution";
     pluginId: string;
-    contributionKind: "panel" | "workspace-source" | "catalog-row" | "chat-suggestion";
+    contributionKind: "panel" | "workspace-source" | "catalog-row" | "chat-suggestion" | "app-left-action";
     contributionId?: string;
     error: Error;
     componentStack?: string | null;
@@ -1378,7 +1426,7 @@ export declare class PluginError extends Error {
 }
 
 export declare class PluginErrorBoundary extends Component<Props, State> {
-    static contextType: Context<PluginErrorContextValue | null>;
+    static contextType: Context< PluginErrorContextValue | null>;
     context: React.ContextType<typeof PluginErrorContext>;
     state: State;
     static getDerivedStateFromError(error: Error): State;
@@ -1415,7 +1463,7 @@ export declare function postUiCommand(command: UiCommand): void;
 
 declare interface Props {
     pluginId: string;
-    contributionKind: "panel" | "workspace-source" | "catalog-row" | "chat-suggestion";
+    contributionKind: "panel" | "workspace-source" | "catalog-row" | "chat-suggestion" | "app-left-action";
     contributionId?: string;
     children?: ReactNode;
     onError?: (error: Error, info: ErrorInfo) => void;
@@ -1763,6 +1811,8 @@ export declare function useActivePanels(): readonly PanelConfig[];
 
 export declare function useApiBaseUrl(): string;
 
+export declare function useAppLeftOverlayChrome(): AppLeftOverlayChromeValue;
+
 export declare function useArtifactPanels(surfaceApi: DockviewShellApi | null): UseArtifactPanelsReturn;
 
 export declare interface UseArtifactPanelsReturn {
@@ -1892,6 +1942,7 @@ export declare interface UseFilePaneReturn {
     error: Error | null;
     content: string | null;
     isDirty: boolean;
+    isReadonly: boolean;
     conflict: FileConflictError | null;
     onReloadFromServer: () => Promise<void>;
     onOverwrite: () => Promise<void>;
@@ -1944,7 +1995,7 @@ export declare function userMeta(): {
     ts: number;
 };
 
-export declare function useSetSidebar(): (sidebar: Partial<SidebarState>) => void;
+export declare function useSetSidebar(): (sidebar: Partial< SidebarState>) => void;
 
 export declare function useSidebarState(): SidebarState;
 
@@ -1992,6 +2043,8 @@ export declare function useWorkspacePluginClient(): WorkspacePluginClient;
 
 export declare function useWorkspaceRequestId(): string | null;
 
+export declare function useWorkspaceShellCapabilities(): WorkspaceShellCapabilities;
+
 export declare function useWorkspaceSourceRegistry(): WorkspaceSourceRegistry;
 
 export declare function WorkbenchLeftPane({ rootDir, bridge, defaultTab, activeTab: controlledActiveTab, activePanelId, onActiveTabChange, revealFileTreeRequest, onOpenPanel, onReloadAgentPlugins, onCollapse, onExpand, onCloseSourcePane, railOnly, className, }: WorkbenchLeftPaneProps): JSX.Element;
@@ -2083,6 +2136,16 @@ export declare type WorkspaceAttentionBlocker = {
     sessionId?: string;
     /** Optional generic session-row badge contributed by the plugin that owns this attention. */
     sessionBadge?: WorkspaceAttentionSessionBadge;
+    /**
+     * Remove this blocker once its workspace chat session disappears from the
+     * authoritative session list. Leave unset for external inbox items whose
+     * `sessionId` is a source/thread identifier rather than a local chat id.
+     */
+    pruneWhenSessionMissing?: boolean;
+    /** Explicit inbox projection metadata. New inbox-aware plugins should provide this instead of relying on reason parsing. */
+    inbox?: WorkspaceAttentionInboxMetadata;
+    /** Optional shell focus behavior requested by the plugin that owns this blocker. */
+    focus?: WorkspaceAttentionFocusMetadata;
     actions?: WorkspaceAttentionBlockerAction[];
 };
 
@@ -2097,6 +2160,27 @@ export declare interface WorkspaceAttentionContextValue {
     removeBlocker: (id: string) => void;
 }
 
+export declare type WorkspaceAttentionFocusMetadata = {
+    /** Close the workbench left pane when this blocker becomes active for the current session. */
+    closeWorkbenchLeftPane?: boolean;
+};
+
+declare type WorkspaceAttentionInboxMetadata = {
+    kind: "question" | "review" | "approval" | "notice";
+    sourceLabel: string;
+    createdAt?: string | number | Date;
+    updatedAt?: string | number | Date;
+    priority?: number;
+};
+
+export declare type WorkspaceAttentionProviderProps = {
+    children: ReactNode;
+    /** Authoritative set of existing chat sessions. Blockers that opt into pruning outside this set are stale and removed. */
+    knownSessionIds?: readonly string[];
+    /** Keep false while sessions are still loading/paginated so valid blockers are not pruned early. */
+    knownSessionsAuthoritative?: boolean;
+};
+
 export declare type WorkspaceAttentionSessionBadge = {
     /** Stable badge kind for data attributes and plugin-specific styling hooks. */
     kind: string;
@@ -2137,8 +2221,9 @@ export declare interface WorkspaceBridgeContextValue {
 
 export declare type WorkspaceChatPanelComponent = ComponentType<any>;
 
-export declare interface WorkspaceChatPanelProps extends PiChatPanelProps<WorkspaceAttentionBlocker> {
+export declare interface WorkspaceChatPanelProps extends Omit<PiChatPanelProps<WorkspaceAttentionBlocker>, "onOpenArtifact"> {
     sessionId: string;
+    onOpenArtifact?: OpenArtifactHandler;
     /** Endpoint base for agent → visible-workbench UI commands. */
     bridgeEndpoint?: string | null;
     /** Imperative handle getter for the visible workbench surface. */
@@ -2151,6 +2236,11 @@ export declare interface WorkspaceChatPanelProps extends PiChatPanelProps<Worksp
     openWorkbenchSources?: () => void;
     /** Closes the visible workbench surface after an ephemeral command finishes. */
     closeWorkbench?: () => void;
+    /** Host-injected composer blockers (for shell policies such as detached read-only chat). */
+    composerBlockers?: WorkspaceAttentionBlocker[];
+    onComposerStop?: () => void;
+    onComposerBlockerAction?: (blocker: WorkspaceAttentionBlocker, action: string) => void;
+    onData?: (part: unknown) => void;
 }
 
 export declare function workspaceComposerStopAppliesToSession(detail: unknown, sessionId: string, options?: WorkspaceComposerStopMatchOptions): boolean;
@@ -2172,6 +2262,7 @@ export declare function workspaceComposerStopTargetSessionId(detail: unknown, fa
 export declare interface WorkspaceContextValue {
     chatPanel: WorkspaceChatPanelComponent | null;
     registeredPlugins: RegisteredPluginMeta[];
+    workspaceId?: string;
     debug: boolean;
 }
 
@@ -2360,7 +2451,7 @@ export declare interface WorkspacePluginEventMap {
     };
 }
 
-export declare function WorkspaceProvider({ children, chatPanel, plugins, excludeDefaults, panels, commands, catalogs, capabilities, apiBaseUrl, authHeaders, apiTimeout, activeSessionId, openSessionIds, defaultTheme, onThemeChange, workspaceId, workspaceLabel, appTitle, storageKey, persistenceEnabled, manageDocumentTitle, bridgeEndpoint, onAuthError, onOpenFile, debug, frontPluginHotReload, fullPageBasePath, commandPaletteSessionSearch, }: WorkspaceProviderProps): JSX.Element;
+export declare function WorkspaceProvider({ children, chatPanel, plugins, capturedPlugins, excludeDefaults, panels, commands, catalogs, capabilities, apiBaseUrl, authHeaders, apiTimeout, activeSessionId, openSessionIds, attentionSessionIds, attentionSessionsAuthoritative, defaultTheme, onThemeChange, workspaceId, workspaceLabel, appTitle, storageKey, persistenceEnabled, manageDocumentTitle, bridgeEndpoint, onAuthError, onOpenFile, debug, frontPluginHotReload, fullPageBasePath, commandPaletteSessionSearch, }: WorkspaceProviderProps): JSX.Element;
 
 export declare interface WorkspaceProviderProps {
     children: ReactNode;
@@ -2370,6 +2461,7 @@ export declare interface WorkspaceProviderProps {
      * `@hachej/boring-workspace/plugin`.
      */
     plugins?: BoringFrontFactoryWithId[];
+    capturedPlugins?: CapturedFrontPlugin[];
     excludeDefaults?: string[];
     panels?: PanelConfig[];
     commands?: CommandConfig[];
@@ -2383,6 +2475,10 @@ export declare interface WorkspaceProviderProps {
     activeSessionId?: string | null;
     /** Session ids that are currently open in chat panes, for plugins that must avoid opening closed-session UI. */
     openSessionIds?: readonly string[];
+    /** Authoritative chat session ids used to drop stale session-scoped Inbox/attention entries. */
+    attentionSessionIds?: readonly string[];
+    /** False while session data is loading or paginated; prevents pruning valid off-page attention entries. */
+    attentionSessionsAuthoritative?: boolean;
     defaultTheme?: "light" | "dark" | undefined;
     onThemeChange?: (theme: "light" | "dark") => void;
     workspaceId?: string;
@@ -2406,6 +2502,48 @@ export declare interface WorkspaceProviderProps {
     commandPaletteSessionSearch?: CommandPaletteSessionSearchConfig;
 }
 
+export declare interface WorkspaceShellAnchorRect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+}
+
+export declare type WorkspaceShellArtifactTarget = {
+    type: "surface";
+    surfaceKind: string;
+    target?: string;
+    params?: Record<string, unknown>;
+} | {
+    type: "panel";
+    panelComponentId: string;
+    params?: Record<string, unknown>;
+};
+
+export declare interface WorkspaceShellCapabilities {
+    openArtifact(target: WorkspaceShellArtifactTarget | null, options?: {
+        sessionId?: string | null;
+        title?: string;
+        instanceId?: string;
+    }): WorkspaceShellCapabilityResult;
+    openDetachedChat(sessionId: string, options?: {
+        anchor?: WorkspaceShellAnchorRect;
+        title?: string;
+    }): WorkspaceShellCapabilityResult;
+}
+
+export declare type WorkspaceShellCapabilityResult = {
+    success: true;
+} | {
+    success: false;
+    reason: "no-artifact" | "open-failed" | "invalid-session" | "placement-failed";
+    message: string;
+};
+
 export declare interface WorkspaceSourceConfig<T = any> {
     id: string;
     title: string;
@@ -2504,3 +2642,8 @@ declare type WorkspaceStoreApi = {
 };
 
 export { }
+
+
+declare global {
+    var __BORING_RUNTIME_SINGLETONS__: Record<string, unknown> | undefined;
+}