@hachej/boring-workspace 0.1.71 → 0.1.72

package/dist/src/front/testing/renderPane.d.ts

@@ -0,0 +1,20 @@
+import { ReactElement } from 'react';
+import { RenderOptions, RenderResult } from '@testing-library/react';
+import { PanelRegistry } from '../registry/PanelRegistry';
+import { MockWorkspaceBridge } from './createMockBridge';
+import { MockDataFixtures } from './mockApi';
+export interface RenderPaneOptions extends Omit<RenderOptions, "wrapper"> {
+    fixtures?: MockDataFixtures;
+    bridge?: MockWorkspaceBridge;
+    registry?: PanelRegistry;
+    apiBaseUrl?: string;
+    authHeaders?: Record<string, string>;
+    defaultTheme?: "light" | "dark";
+    timeout?: number;
+    injectBridgeProp?: boolean;
+}
+export type RenderPaneResult = RenderResult & {
+    bridge: MockWorkspaceBridge;
+    registry: PanelRegistry;
+};
+export declare function renderPane(ui: ReactElement, options?: RenderPaneOptions): RenderPaneResult;

package/dist/src/front/theme/codemirror-theme.d.ts

@@ -0,0 +1,4 @@
+import { Extension } from '@codemirror/state';
+export declare function createShadcnTheme(options?: {
+    dark?: boolean;
+}): Extension[];

package/dist/src/front/theme/index.d.ts

@@ -0,0 +1 @@
+export { createShadcnTheme } from './codemirror-theme';

package/dist/src/front/toast/__tests__/toast.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/front/toast/index.d.ts

@@ -0,0 +1 @@
+export { Toaster, toast, dismissToast, subscribeToasts, getActiveToasts, clearToasts, type ToastApi, type ToastInput, type ToastRecord, type ToastVariant, type ToasterProps, } from '@hachej/boring-ui-kit';

package/dist/src/index.d.ts

@@ -0,0 +1,90 @@
+export { bootstrap, PluginError, } from './shared/plugins';
+export type { PluginErrorKind, BootstrapOptions, BootstrapResult, PanelRegistryLike, WorkspaceSourceRegistryLike, CommandRegistryLike, CatalogRegistryLike, SurfaceResolverRegistryLike, } from './shared/plugins';
+export type { PluginBinding, CatalogAdapter, CatalogBadge, CatalogConfig, CatalogFacets, CatalogFacetsArgs, CatalogFacetConfig, CatalogFacetValue, CatalogRow, CatalogSearchArgs, CatalogSearchResult, LeftTabParams, LeftTabComponent, PluginProvider, PluginProviderProps, AgentTool, JSONSchema, ToolExecContext, ToolResult, } from './shared/plugins';
+export { CatalogRegistry } from './shared/plugins/CatalogRegistry';
+export type { CatalogRegistryOptions } from './shared/plugins/CatalogRegistry';
+export { useCommands, useActivePanels, useCatalogs, PluginErrorBoundary, PluginErrorProvider, usePluginErrors, WorkspacePluginClientProvider, createWorkspacePluginClient, useWorkspacePluginClient, } from './front/plugin';
+export type { PluginError as PluginContributionError, WorkspacePluginClient } from './front/plugin';
+export { filesystemPlugin, emitFilesystemAgentFileChange, useAutoOpenAgentFiles, onFilesystemChanged, useFilePane, } from './plugins/filesystemPlugin/front';
+export type { UseAutoOpenAgentFilesOptions, UseFilePaneOptions, UseFilePaneReturn, } from './plugins/filesystemPlugin/front';
+export { DataProvider as WorkspaceFilesProvider, readFileRecords, useApiBaseUrl, useHasDataClient as useHasWorkspaceFilesProvider, useWorkspaceRequestId, } from './plugins/filesystemPlugin/front/data';
+export type { FileRecordsFormat, FileRecordsResult, FileRecordsSource, ReadFileRecordsOptions, } from './plugins/filesystemPlugin/front/data';
+export { filesystemEvents } from './plugins/filesystemPlugin/shared/events';
+export type { FilesystemEventMap, FilesystemEventMeta } from './plugins/filesystemPlugin/shared/events';
+export { cn } from './front/lib/utils';
+export { PanelRegistry } from './front/registry/PanelRegistry';
+export { WorkspaceSourceRegistry } from './front/registry/WorkspaceSourceRegistry';
+export { CommandRegistry } from './shared/plugins/CommandRegistry';
+export { SurfaceResolverRegistry } from './shared/plugins/SurfaceResolverRegistry';
+export { RegistryProvider, useRegistry, useWorkspaceSourceRegistry, useCommandRegistry, useCatalogRegistry, useSurfaceResolverRegistry, WORKSPACE_OPEN_PATH_SURFACE_KIND, } from './front/registry';
+export { useAppLeftOverlayChrome } from './shared/plugins/appLeftOverlayChrome';
+export type { AppLeftOverlayChromeValue } from './shared/plugins/appLeftOverlayChrome';
+export { useWorkspaceShellCapabilities } from './shared/plugins/workspaceShellCapabilities';
+export type { WorkspaceShellAnchorRect, WorkspaceShellArtifactTarget, WorkspaceShellCapabilityResult, WorkspaceShellCapabilities, } from './shared/plugins/workspaceShellCapabilities';
+export { getFileIcon } from './front/registry';
+export type { PanelConfig, PanelRegistration, CommandConfig, PaneProps, WorkspaceSourceConfig, WorkspaceSourceOpenPanelConfig, WorkspaceSourceProps, WorkspaceSourceRegistration, SurfaceOpenRequest, SurfacePanelResolution, SurfaceResolverConfig, SurfaceResolverRegistration, } from './front/registry';
+export { DockviewShell, PanelChrome, useDockviewApi } from './front/dock';
+export type { LayoutConfig, GroupConfig, DockviewShellProps, DockviewShellApi, PanelLifecycleApi, SerializedLayout, } from './front/dock';
+export { IdeLayout, buildIdeLayout, ChatLayout, buildChatLayout, TopBar, ResponsiveDockviewShell, } from './front/layout';
+export type { IdeLayoutProps, ChatLayoutProps, TopBarProps, ResponsiveDockviewShellProps, } from './front/layout';
+export { useEditorLifecycle, type EditorLifecycleAdapter, type UseEditorLifecycleOptions, type UseEditorLifecycleReturn, } from './front/hooks';
+export { buildFullPagePanelHref, useFullPagePanelHref, usePanelRenderMode, useIsFullPagePanel, } from './front/fullPage';
+export type { BuildFullPagePanelHrefInput, PanelRenderMode } from './front/fullPage';
+export { useViewportBreakpoint } from './front/hooks';
+export { useResponsiveSidebarCollapse, type UseResponsiveSidebarCollapseOptions, } from './front/hooks';
+export { useArtifactPanels, type ArtifactPanel, type UseArtifactPanelsReturn, } from './front/hooks';
+export { useArtifactRouting, type UseArtifactRoutingOptions, type UseArtifactRoutingReturn, } from './front/hooks';
+export { useKeyboardShortcuts, formatShortcut, type ShortcutBinding, type UseKeyboardShortcutsOptions, } from './front/hooks';
+export { CommandPalette } from './front/components/CommandPalette';
+export type { CommandPaletteProps } from './front/components/CommandPalette';
+export { WorkspaceLoadingState } from './front/components/WorkspaceLoadingState';
+export type { WorkspaceLoadingStateProps } from './front/components/WorkspaceLoadingState';
+export { ArtifactSurfacePane } from './front/chrome/artifact-surface/ArtifactSurfacePane';
+export type { ArtifactSurfacePaneProps } from './front/chrome/artifact-surface/ArtifactSurfacePane';
+export { EmptyPane } from './front/chrome/empty-pane/EmptyPane';
+export type { EmptyPaneProps } from './front/chrome/empty-pane/EmptyPane';
+export { CodeEditorPane } from './plugins/filesystemPlugin/front/code-editor/CodeEditorPane';
+export type { CodeEditorPaneProps } from './plugins/filesystemPlugin/front/code-editor/CodeEditorPane';
+export { FileTreePane, FileTreeView, } from './plugins/filesystemPlugin/front/file-tree/FileTreeView';
+export type { FileTreePaneProps, FileTreeViewProps, } from './plugins/filesystemPlugin/front/file-tree/FileTreeView';
+export { MarkdownEditorPane } from './plugins/filesystemPlugin/front/markdown-editor/MarkdownEditorPane';
+export type { MarkdownEditorPaneProps } from './plugins/filesystemPlugin/front/markdown-editor/MarkdownEditorPane';
+export { definePanel } from './front/registry/types';
+export { createShadcnTheme } from './front/theme';
+export { events, useEvent, userMeta, agentMeta, emitAgentData, workspaceEvents, } from './front/events';
+export type { Origin, EventMeta, WorkspacePluginEventMap, WorkspaceEventMap, WorkspaceEventName, } from './front/events';
+export { toast, Toaster, dismissToast } from './front/toast';
+export type { ToastApi, ToastInput, ToastRecord, ToastVariant, ToasterProps, } from './front/toast';
+export { createBridge } from './front/bridge';
+export { createBridgeClient } from './front/bridge';
+export { postUiCommand, UI_COMMAND_EVENT, WORKSPACE_SURFACE_OPEN_SKIPPED_EVENT, WorkspaceLink, workspaceLinkCommand, workspaceLinkHref } from './front/bridge';
+export type { BridgeClient, BridgeClientOptions, UIStatePut, WorkspaceLinkProps, WorkspaceLinkTarget, } from './front/bridge';
+export type { DispatchContext, UiCommand, WorkspaceBridge, BridgeEventMap, CommandResult, DynamicPaneConfig, Unsubscribe, CausedBy, } from './front/bridge';
+export { openFileSchema, openPanelSchema, closePanelSchema, notificationSchema, navigateToLineSchema, expandToFileSchema, MAX_PANELS, } from './front/bridge';
+export { PanelErrorBoundary } from './front/components/PanelErrorBoundary';
+export type { PanelErrorBoundaryProps } from './front/components/PanelErrorBoundary';
+export { CodeEditor } from './plugins/filesystemPlugin/front/code-editor/CodeEditor';
+export type { CodeEditorProps } from './plugins/filesystemPlugin/front/code-editor/CodeEditor';
+export { FileTree } from './plugins/filesystemPlugin/front/file-tree/FileTree';
+export type { FileTreeProps, FileTreeNode, } from './plugins/filesystemPlugin/front/file-tree/FileTree';
+export { MarkdownEditor } from './plugins/filesystemPlugin/front/markdown-editor/MarkdownEditor';
+export type { MarkdownEditorProps } from './plugins/filesystemPlugin/front/markdown-editor/MarkdownEditor';
+export { SessionList } from './front/components/SessionList';
+export type { SessionListProps, SessionItem, } from './front/components/SessionList';
+export { SessionBrowser } from './front/chrome/session-list/SessionBrowser';
+export { SurfaceShell } from './front/chrome/artifact-surface/SurfaceShell';
+export { WorkbenchLeftPane } from './front/chrome/workbench-left/WorkbenchLeftPane';
+export { useWorkspaceLeftPaneActions } from './front/chrome/workbench-left/useWorkspaceLeftPaneActions';
+export type { SessionBrowserProps } from './front/chrome/session-list/SessionBrowser';
+export type { OpenArtifactHandler, WorkspaceChatPanelComponent, WorkspaceChatPanelProps, } from './front/chrome/chat/types';
+export { WORKSPACE_COMPOSER_STOP_EVENT, WORKSPACE_COMPOSER_STOP_REASONS, emitWorkspaceComposerStop, isWorkspaceComposerStopDetail, isWorkspaceComposerStopReason, workspaceComposerStopAppliesToSession, workspaceComposerStopTargetSessionId, } from './front/chrome/chat/composerStop';
+export type { WorkspaceComposerStopDetail, WorkspaceComposerStopMatchOptions, WorkspaceComposerStopReason, } from './front/chrome/chat/composerStop';
+export type { SurfaceShellProps, SurfaceShellApi, SurfaceShellSnapshot, SurfaceShellTab, OpenPanelConfig, } from './front/chrome/artifact-surface/SurfaceShell';
+export type { WorkbenchLeftPaneProps, WorkbenchLeftTabId, } from './front/chrome/workbench-left/WorkbenchLeftPane';
+export type { UseWorkspaceLeftPaneActionsOptions, WorkspaceLeftPaneAction, WorkspaceLeftPaneOpenPanelConfig, } from './front/chrome/workbench-left/useWorkspaceLeftPaneActions';
+export { WorkspaceProvider, ThemeProvider, useTheme, useWorkspaceBridge, useWorkspaceContext, useWorkspaceContextOptional, useWorkspaceChatPanel, WORKSPACE_ATTENTION_ACTION_EVENT, emitWorkspaceAttentionAction, useWorkspaceAttention, workspaceAttentionSessionBadgeForBlocker, } from './front/provider';
+export type { WorkspaceProviderProps, FrontPluginHotReloadMode, ThemeProviderProps, WorkspaceBridgeContextValue, WorkspaceContextValue, WorkspaceAttentionActionDetail, WorkspaceAttentionBlocker, WorkspaceAttentionBlockerAction, WorkspaceAttentionContextValue, WorkspaceAttentionProviderProps, WorkspaceAttentionSessionBadge, WorkspaceAttentionFocusMetadata, } from './front/provider';
+export { createWorkspaceStore } from './front/store';
+export type { CreateWorkspaceStoreOptions } from './front/store';
+export { bindStore, useActiveFile, useActivePanel, useSidebarState, useSetSidebar, useOpenPanels, useDirtyFiles, useThemePreference, useHydrationComplete, useResetLayout, } from './front/store/selectors';
+export type { WorkspaceState, WorkspaceActions, WorkspaceStore, PanelState, Notification, SidebarState, } from './front/store/types';

package/dist/src/plugin.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @hachej/boring-workspace/plugin subpath
+ *
+ * Browser-safe authoring surface for package.json based plugins.
+ * A package uses `pi` for agent/Pi contributions and `boring` for workspace/UI
+ * contributions. Front entries default-export a BoringFrontFactory.
+ */
+export { captureFrontPlugin, createCapturingBoringFrontAPI, definePlugin, } from './shared/plugins/frontFactory';
+export type { BoringFrontAPI, BoringFrontFactory, BoringFrontFactoryWithId, BoringFrontSetup, BoringFrontBindingRegistration, BoringFrontPanelRegistration, BoringFrontPanelCommandRegistration, BoringFrontAppLeftActionRegistration, BoringFrontAppLeftOverlayProps, BoringFrontWorkspaceSourceRegistration, BoringFrontProviderRegistration, BoringFrontSurfaceResolverRegistration, CapturedBoringFrontRegistrations, CapturingBoringFrontAPIHandle, DefinePluginConfig, CapturedFrontPlugin, } from './shared/plugins/frontFactory';
+export { validateBoringPluginManifest, isSafePluginRelativePath, isValidBoringPluginId, } from './shared/plugins/manifest';
+export { WORKSPACE_OPEN_PATH_SURFACE_KIND } from './shared/types/surface';
+export { useAppLeftOverlayChrome } from './shared/plugins/appLeftOverlayChrome';
+export type { AppLeftOverlayChromeValue } from './shared/plugins/appLeftOverlayChrome';
+export { useWorkspaceShellCapabilities } from './shared/plugins/workspaceShellCapabilities';
+export type { WorkspaceShellAnchorRect, WorkspaceShellArtifactTarget, WorkspaceShellCapabilityResult, WorkspaceShellCapabilities, } from './shared/plugins/workspaceShellCapabilities';
+export { execWorkspaceUi, getWorkspaceUiBridge, notify, openPanel, NoWorkspaceUiBridgeError, } from './shared/plugins/uiBridgeRegistry';
+export type { OpenPanelArgs } from './shared/plugins/uiBridgeRegistry';
+export type { BoringPackageBoringField, BoringPackagePiField, BoringPackagePiSource, BoringPackagePiSourceObject, BoringPluginManifestErrorCode, BoringPluginManifestIssue, BoringPluginManifestValidationResult, BoringPluginPackageJson, } from './shared/plugins/manifest';
+export type { PaneProps, WorkspaceSourceProps, WorkspaceSourceOpenPanelConfig } from './shared/types/panel';

package/dist/src/plugins/filesystemPlugin/front/ConflictBanner.d.ts

@@ -0,0 +1,14 @@
+import { FileConflictError } from './data/fetchClient';
+export interface ConflictBannerProps {
+    conflict: FileConflictError;
+    onReload: () => void | Promise<void>;
+    onOverwrite: () => void | Promise<void>;
+}
+/**
+ * Shared conflict banner for file panes.
+ *
+ * Shown when a file has been modified externally (OCC conflict).
+ * Offers two choices: reload from server (discard local changes) or
+ * overwrite server (force save local changes).
+ */
+export declare function ConflictBanner({ conflict, onReload, onOverwrite }: ConflictBannerProps): import("react").JSX.Element;

package/dist/src/plugins/filesystemPlugin/front/FilePaneShell.d.ts

@@ -0,0 +1,73 @@
+import { ReactNode } from 'react';
+import { FileConflictError } from './data/fetchClient';
+export interface FilePaneShellProps {
+    /** The file path being edited (for "no file selected" check). */
+    path: string;
+    /** The file content (null = loading). */
+    content: string | null;
+    /** Loading state from React Query. */
+    isLoading: boolean;
+    /** Error from React Query. */
+    error: Error | null;
+    /** Conflict state (if OCC check failed). */
+    conflict: FileConflictError | null;
+    /** Readonly panes disable mutation affordances by construction. */
+    readOnly?: boolean;
+    /** Handler for content changes. */
+    onChange: (content: string) => void;
+    /** Handler for reload from server. */
+    onReload: () => void | Promise<void>;
+    /** Handler for overwrite server. */
+    onOverwrite: () => void | Promise<void>;
+    /** The actual editor component to render. */
+    editorComponent: React.ComponentType<{
+        content: string;
+        onChange: (content: string) => void;
+        readOnly?: boolean;
+        className?: string;
+        [key: string]: unknown;
+    }>;
+    /** Additional props to pass to the editor component. */
+    editorProps?: Record<string, unknown>;
+    /** Custom loading fallback (optional). */
+    loadingFallback?: ReactNode;
+    /** Custom error message (optional). */
+    errorMessage?: string;
+    /** Filesystem identity for disclosure-safe governed filesystem error rendering. */
+    filesystem?: string;
+    /** Wrapper className for the root element. */
+    className?: string;
+}
+/**
+ * Shared shell for file-based editor panes.
+ *
+ * Handles:
+ * - "No file selected" state
+ * - Error display
+ * - Loading fallback
+ * - Conflict banner
+ * - Suspense boundary for lazy-loaded editors
+ *
+ * @example
+ * ```typescript
+ * function CodeEditorPane({ params }) {
+ *   const { content, isLoading, error, conflict, setContent, ... } = useFilePane({ path: params.path })
+ *
+ *   return (
+ *     <FilePaneShell
+ *       path={params.path}
+ *       content={content}
+ *       isLoading={isLoading}
+ *       error={error}
+ *       conflict={conflict}
+ *       onChange={setContent}
+ *       onReload={onReloadFromServer}
+ *       onOverwrite={onOverwrite}
+ *       editorComponent={CodeEditor}
+ *       editorProps={{ language: "typescript", wordWrap: true }}
+ *     />
+ *   )
+ * }
+ * ```
+ */
+export declare function FilePaneShell({ path, content, isLoading, error, conflict, readOnly, onChange, onReload, onOverwrite, editorComponent: Editor, editorProps, loadingFallback, errorMessage, filesystem, className, }: FilePaneShellProps): import("react").JSX.Element;

package/dist/src/plugins/filesystemPlugin/front/__tests__/agentFileBridge.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/__tests__/filePanelBinding.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/__tests__/filesystemPlugin.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/__tests__/search.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/__tests__/useFilePane.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/agentFileBridge.d.ts

@@ -0,0 +1,12 @@
+import { FilesystemEventMeta } from '../shared/events';
+export declare function emitFilesystemAgentFileChange(part: unknown): void;
+export interface UseAutoOpenAgentFilesOptions {
+    skip?: (path: string) => boolean;
+    filesOnly?: boolean;
+}
+export declare function useAutoOpenAgentFiles(onOpen: (path: string) => void, options?: UseAutoOpenAgentFilesOptions): void;
+/** Subscribe to file-changed events. Returns the unsubscribe function. */
+export declare function onFilesystemChanged(handler: (payload: FilesystemEventMeta & {
+    path: string;
+}) => void): () => void;
+export declare function FilesystemAgentFileBridge(): null;

package/dist/src/plugins/filesystemPlugin/front/catalogs.d.ts

@@ -0,0 +1,9 @@
+import { CatalogConfig, CatalogRow } from '../../../shared/plugins/types';
+export interface FilesCatalogClient {
+    search(query: string, limit?: number, signal?: AbortSignal): Promise<string[]>;
+}
+export interface CreateFilesCatalogOptions {
+    client: FilesCatalogClient;
+    onSelect?: (path: string, row: CatalogRow) => void;
+}
+export declare function createFilesCatalog({ client, onSelect, }: CreateFilesCatalogOptions): CatalogConfig;

package/dist/src/plugins/filesystemPlugin/front/code-editor/CodeEditor.d.ts

@@ -0,0 +1,10 @@
+export interface CodeEditorProps {
+    content: string;
+    onChange?: (content: string) => void;
+    language?: string;
+    readOnly?: boolean;
+    lineNumbers?: boolean;
+    wordWrap?: boolean;
+    className?: string;
+}
+export declare function CodeEditor({ content, onChange, language, readOnly, lineNumbers, wordWrap, className, }: CodeEditorProps): import("react").JSX.Element;

package/dist/src/plugins/filesystemPlugin/front/code-editor/CodeEditorPane.d.ts

@@ -0,0 +1,8 @@
+import { FilesystemId } from '../../../../shared/types/filesystem';
+import { PaneProps } from '../../../../front/registry/types';
+export type CodeEditorPaneProps = PaneProps<{
+    path?: string;
+    filesystem?: FilesystemId;
+    mode?: "view" | "edit" | "diff";
+}>;
+export declare function CodeEditorPane({ params, api, className }: CodeEditorPaneProps): import("react").JSX.Element;

package/dist/src/plugins/filesystemPlugin/front/code-editor/__tests__/CodeEditor.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/code-editor/__tests__/CodeEditorPane.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/data/DataProvider.d.ts

@@ -0,0 +1,16 @@
+import { ReactNode } from 'react';
+import { FetchClient } from './fetchClient';
+interface DataProviderProps {
+    apiBaseUrl: string;
+    authHeaders?: Record<string, string>;
+    onAuthError?: (statusCode: number) => void;
+    timeout?: number;
+    client?: FetchClient;
+    children: ReactNode;
+}
+export declare function useDataClient(): FetchClient;
+export declare function useHasDataClient(): boolean;
+export declare function useApiBaseUrl(): string;
+export declare function useWorkspaceRequestId(): string | null;
+export declare function DataProvider({ apiBaseUrl, authHeaders, onAuthError, timeout, client: providedClient, children, }: DataProviderProps): import("react").JSX.Element;
+export {};

package/dist/src/plugins/filesystemPlugin/front/data/__tests__/fetchClient.integration.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/data/__tests__/fetchClient.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/data/__tests__/fileRecords.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/data/__tests__/hooks.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/data/__tests__/useFileEventInvalidation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/data/__tests__/useFileEventStream.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/data/__tests__/useFileUpload.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/filesystemPlugin/front/data/fetchClient.d.ts

@@ -0,0 +1,63 @@
+import { FetchClientOptions, FileContent, FileEntry, FileStat, GitUrlMetadata } from './types';
+export declare class FetchClient {
+    private baseUrl;
+    private headers;
+    private onAuthError?;
+    private onTimeout?;
+    private timeout;
+    private maxRetries;
+    private retryBaseMs;
+    constructor(opts: FetchClientOptions);
+    private request;
+    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
+     * runs an optimistic-concurrency check and returns 409 if the file
+     * has been modified since that mtime — surfaced here as a typed
+     * `FileConflictError` so the editor can ask the user to reload or
+     * force-overwrite. The returned `mtimeMs` is the server's stat
+     * after the write; callers use it as the OCC baseline for the
+     * next save. Set `returnMtimeMs: false` only for writes that do
+     * not need a fresh OCC baseline (for example, creating an empty
+     * file before immediately opening/refetching it). That lets remote
+     * sandboxes skip an expensive post-write stat.
+     */
+    writeFile(path: string, content: string, opts?: {
+        expectedMtimeMs?: number;
+        returnMtimeMs?: boolean;
+        filesystem?: string;
+    }): Promise<{
+        mtimeMs?: number;
+    }>;
+    deleteFile(path: string, options?: {
+        filesystem?: string;
+    }): Promise<void>;
+    stat(path: string, signal?: AbortSignal, filesystem?: string): Promise<FileStat>;
+    getGitUrlMetadata(path: string, signal?: AbortSignal): Promise<GitUrlMetadata>;
+    search(query: string, limit?: number, signal?: AbortSignal): Promise<string[]>;
+    createDir(path: string, options?: {
+        filesystem?: string;
+    }): Promise<void>;
+    moveFile(from: string, to: string, options?: {
+        filesystem?: string;
+    }): Promise<void>;
+}
+export declare class FetchError extends Error {
+    readonly status: number;
+    readonly body?: unknown | undefined;
+    constructor(status: number, message: string, body?: unknown | undefined);
+}
+/**
+ * Thrown by `writeFile` when the server returns 409 because the file
+ * has been modified since the client's last read. Carries the
+ * server's current mtime so the editor can show the user a
+ * Reload-vs-Overwrite choice with the actual conflict context.
+ */
+export declare class FileConflictError extends Error {
+    readonly path: string;
+    readonly currentMtimeMs: number | null;
+    readonly expectedMtimeMs: number | null;
+    constructor(path: string, currentMtimeMs: number | null, expectedMtimeMs: number | null);
+    static from(err: FetchError, path: string): FileConflictError;
+}

package/dist/src/plugins/filesystemPlugin/front/data/fileRecords.d.ts

@@ -0,0 +1,34 @@
+export type FileRecordsFormat = "json-array" | "ndjson" | "csv";
+export interface FileRecordsSource {
+    kind: "file";
+    path: string;
+    format: FileRecordsFormat;
+    recordSet?: string;
+}
+export interface FileRecordsResult {
+    source: FileRecordsSource;
+    path: string;
+    format: FileRecordsFormat;
+    columns: {
+        name: string;
+        type: string;
+    }[];
+    rows: Record<string, unknown>[];
+    total: number;
+    hasMore: boolean;
+    offset: number;
+    limit: number;
+    mtimeMs?: number;
+}
+export interface ReadFileRecordsOptions {
+    path: string;
+    recordSet?: string;
+    offset?: number;
+    limit?: number;
+    q?: string;
+    apiBaseUrl?: string;
+    headers?: Record<string, string>;
+    workspaceId?: string;
+    signal?: AbortSignal;
+}
+export declare function readFileRecords(options: ReadFileRecordsOptions): Promise<FileRecordsResult>;

package/dist/src/plugins/filesystemPlugin/front/data/filesystemErrorRedaction.d.ts

@@ -0,0 +1,2 @@
+export declare function shouldRedactFilesystemError(filesystem: string | undefined, status: number): boolean;
+export declare function redactedFilesystemErrorMessage(filesystem: string | undefined, status: number, fallback: string): string;

package/dist/src/plugins/filesystemPlugin/front/data/hooks.d.ts

@@ -0,0 +1,48 @@
+import { UseQueryResult, UseMutationResult } from '@tanstack/react-query';
+import { FilesystemId } from '../../../../shared/types/filesystem';
+import { FileContent, FileEntry, FileStat, GitUrlMetadata } from './types';
+export interface UseFileContentOptions {
+    /** Filesystem identity for cache/event separation. Data transport remains provider-owned. */
+    filesystem?: FilesystemId;
+    /** Create the file with this content when the initial read returns 404. */
+    createIfMissing?: string;
+}
+export declare function useFileContent(path: string | null, options?: UseFileContentOptions): UseQueryResult<FileContent>;
+export declare function useFileList(dir: string | null, filesystem?: FilesystemId): UseQueryResult<FileEntry[]>;
+export declare function useStat(path: string | null, filesystem?: FilesystemId): UseQueryResult<FileStat>;
+export declare function useGitUrlMetadata(path: string | null): UseQueryResult<GitUrlMetadata>;
+export declare function useFileSearch(query: string, limit?: number): UseQueryResult<string[]>;
+export interface FileWriteVariables {
+    filesystem?: FilesystemId;
+    path: string;
+    content: string;
+    /**
+     * Read-time mtime baseline for optimistic concurrency. When
+     * supplied, the server returns 409 (surfaced as `FileConflictError`)
+     * if the file has changed since. Omit to force-overwrite.
+     */
+    expectedMtimeMs?: number;
+    /**
+     * Set false for writes that do not need a fresh server mtime. Keeps
+     * remote-sandbox creates fast by avoiding an immediate post-write stat.
+     */
+    returnMtimeMs?: boolean;
+}
+export interface FileWriteResult {
+    /** Server stat after the write — the next save's OCC baseline. */
+    mtimeMs?: number;
+}
+export declare function useFileWrite(): UseMutationResult<FileWriteResult, Error, FileWriteVariables>;
+export declare function useCreateDir(): UseMutationResult<void, Error, {
+    path: string;
+    filesystem?: string;
+}>;
+export declare function useMoveFile(): UseMutationResult<void, Error, {
+    from: string;
+    to: string;
+    filesystem?: string;
+}>;
+export declare function useDeleteFile(): UseMutationResult<void, Error, {
+    path: string;
+    filesystem?: string;
+}>;

package/dist/src/plugins/filesystemPlugin/front/data/index.d.ts

@@ -0,0 +1,9 @@
+export { DataProvider, useDataClient, useHasDataClient, useApiBaseUrl, useWorkspaceRequestId, } from './DataProvider';
+export { FetchClient, FetchError } from './fetchClient';
+export { readFileRecords } from './fileRecords';
+export { useFileContent, useFileContent as useFileData, useFileList, useStat, useGitUrlMetadata, useFileSearch, useFileWrite, useCreateDir, useMoveFile, useDeleteFile, } from './hooks';
+export { getPreloadedTreeEntries, setPreloadedTreeEntries, } from './treePreloadCache';
+export type { FileEntry, FileContent, FileStat, FetchClientOptions, GitUrlMetadata } from './types';
+export type { FileRecordsFormat, FileRecordsResult, FileRecordsSource, ReadFileRecordsOptions } from './fileRecords';
+export { useFileUpload } from './useFileUpload';
+export type { UseFileUploadOptions, UseFileUploadResult } from './useFileUpload';

package/dist/src/plugins/filesystemPlugin/front/data/treePreloadCache.d.ts

@@ -0,0 +1,3 @@
+import { FileEntry } from './types';
+export declare function setPreloadedTreeEntries(apiBaseUrl: string | null | undefined, workspaceId: string | null | undefined, dir: string | null | undefined, entries: FileEntry[]): void;
+export declare function getPreloadedTreeEntries(apiBaseUrl: string | null | undefined, workspaceId: string | null | undefined, dir: string | null | undefined): FileEntry[] | undefined;

package/dist/src/plugins/filesystemPlugin/front/data/types.d.ts

@@ -0,0 +1,37 @@
+export interface FileEntry {
+    name: string;
+    kind: "file" | "dir";
+    path: string;
+}
+export 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
+     * server can return 409 if the file changed underneath. Optional
+     * because not every workspace impl can stat cheaply (sandbox
+     * impl is best-effort).
+     */
+    mtimeMs?: number;
+}
+export interface FileStat {
+    size: number;
+    mtimeMs: number;
+    kind: "file" | "dir";
+}
+export interface GitUrlMetadata {
+    enabled: boolean;
+    reason?: string;
+    url?: string;
+}
+export interface FetchClientOptions {
+    apiBaseUrl: string;
+    authHeaders?: Record<string, string>;
+    onAuthError?: (statusCode: number) => void;
+    onTimeout?: (route: string) => void;
+    timeout?: number;
+    maxRetries?: number;
+    retryBaseMs?: number;
+}

package/dist/src/plugins/filesystemPlugin/front/data/useFileEventInvalidation.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Single source of truth for translating workspace bus `filesystem:file.*` events
+ * into React Query invalidation. Mounted once inside `DataProvider`.
+ *
+ * Why centralized:
+ *   - Prior version had `useFileChangeStream` in `@hachej/boring-agent` doing
+ *     its own invalidation with the wrong key shape (`['file', path]`
+ *     vs the workspace's `[base, "files", path]`). Editor never
+ *     refreshed on agent edits.
+ *   - Now: agent SSE chunks → ChatPanelHost forwards via
+ *     filesystem agent-data bridge → filesystem bus event → THIS hook → invalidate.
+ *     User actions (`useFileWrite`, etc.) emit onto the same bus →
+ *     same invalidator. One path, one bug surface.
+ *
+ * Granular invalidation per event kind so a content-only change
+ * doesn't nuke tree/search caches:
+ *   filesystem:file.changed      → files(path) + stat(path)
+ *   filesystem:file.created file → tree(parent) + files(path) + stat(path)
+ *   filesystem:file.created dir  → tree(parent)       (no file content, no stat fetch)
+ *   filesystem:file.moved        → tree(parents of from+to) + files(from+to) + stat(from+to)
+ *                                  + everything cached under from/ (dir moves) + search
+ *   filesystem:file.deleted      → tree(parent) + files(path) + stat(path) + search
+ *
+ * Tree invalidation targets the changed path's PARENT listing, not the
+ * whole `tree` prefix — during event storms (large dir moves, builds)
+ * a prefix invalidation refetched every mounted listing per batch.
+ */
+export declare function useFileEventInvalidation(): void;

package/dist/src/plugins/filesystemPlugin/front/data/useFileEventStream.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Subscribes to the server-side `/api/v1/fs/events` SSE stream and
+ * fans events out onto the workspace event bus with `cause: "remote"`.
+ *
+ * Wire format (per server contract, see fsEvents.ts):
+ *   - `event: change` → `{ eventId, seq, ts, change: WorkspaceChangeEvent }`
+ *   - `event: unsupported` → server can't observe changes, fall back
+ *   - `event: resync-required` → reconnected with a stale Last-Event-ID,
+ *      server's ring buffer can't fill the gap. Drop everything.
+ *
+ * Reliability:
+ *   - EventSource auto-handles reconnect + `Last-Event-ID` header.
+ *   - Client dedupes by `eventId` against a tiny LRU.
+ *   - On `resync-required`, we invalidate ALL React Query caches the
+ *     hook touches (files / tree / stat / search) so consumers refetch
+ *     on next read. No need to re-subscribe — EventSource keeps going,
+ *     and the server starts feeding live events again immediately.
+ *
+ * Self-echo handling stays at the data layer: the bus subscriber
+ * invalidates queries, and `useEditorLifecycle`'s monotonic mtime
+ * check inside `MarkdownEditorPane` means re-fetched-but-identical
+ * content is a no-op for the editor. Step 3b adds eventId dedup but
+ * intentionally does NOT add per-client UX suppression — that's a
+ * future concern (toasts, badges) once we have actual UX surfaces
+ * that fire on file changes.
+ */
+export declare function useFileEventStream(): void;

package/dist/src/plugins/filesystemPlugin/front/data/useFileUpload.d.ts

@@ -0,0 +1,12 @@
+import { UploadFileResult } from '@hachej/boring-agent/front';
+export interface UseFileUploadOptions {
+    directory?: string;
+}
+export interface UseFileUploadResult {
+    upload: (file: File, opts?: {
+        sourcePath?: string;
+        directory?: string;
+    }) => Promise<UploadFileResult>;
+    uploading: boolean;
+}
+export declare function useFileUpload(opts?: UseFileUploadOptions): UseFileUploadResult;