@principal-ade/panel-layouts 0.2.2 → 0.2.4

package/dist/index.d.ts

@@ -1,6 +1,8 @@
+import { AIFunctionDefinition } from '@principal-ade/panel-framework-core';
 import { default as default_2 } from 'react';
 import { EditableConfigurablePanelLayout } from '@principal-ade/panels';
 import { EditableConfigurablePanelLayoutProps } from '@principal-ade/panels';
+import { JsonSchema } from '@principal-ade/panel-framework-core';
 import { mapThemeToPanelVars } from '@principal-ade/panels';
 import { mapThemeToTabVars } from '@principal-ade/panels';
 import { PanelActions } from '@principal-ade/panel-framework-core';
@@ -13,17 +15,36 @@ import { PanelFocusEventPayload } from '@principal-ade/panel-framework-core';
 import { PanelGroup } from '@principal-ade/panels';
 import { PanelLayout } from '@principal-ade/panels';
 import { PanelSlot } from '@principal-ade/panels';
+import { PanelTool } from '@principal-ade/panel-framework-core';
+import { PanelToolRegistry } from '@principal-ade/panel-framework-core';
+import { RegisteredTool } from '@principal-ade/panel-framework-core';
 import { ResponsiveConfigurablePanelLayout } from '@principal-ade/panels';
 import { ResponsiveConfigurablePanelLayoutProps } from '@principal-ade/panels';
 import { TabsConfig } from '@principal-ade/panels';
 import { Theme } from '@principal-ade/panels';
 import { TilesConfig } from '@principal-ade/panels';
 
+/**
+ * Anthropic tool definition format
+ */
+export declare interface AnthropicTool {
+    name: string;
+    description: string;
+    input_schema: JsonSchema;
+}
+
 /**
  * Built-in workspace IDs
  */
 export declare type BuiltInWorkspaceId = 'project-management' | 'code-review' | 'documentation' | 'agent-work' | 'quality-check' | 'drawing' | 'old-school' | 'principal-office';
 
+/**
+ * Tool: Collapse All Panels
+ *
+ * Collapse both left and right panels to maximize the main content area.
+ */
+export declare const collapseAllPanelsTool: PanelTool;
+
 /**
  * Command definition for the command palette
  */
@@ -259,6 +280,12 @@ export declare class CommandRegistryService {
     private notifyListeners;
 }
 
+/**
+ * Creates a hook-like function that returns commands from a registry.
+ * Useful for dynamic command registration.
+ */
+export declare function createToolCommandsProvider(registry: PanelToolRegistry, config?: ToolCommandBridgeConfig): () => Command[];
+
 /**
  * Options for creating a new workspace
  */
@@ -281,6 +308,13 @@ export { EditableConfigurablePanelLayout }
 
 export { EditableConfigurablePanelLayoutProps }
 
+/**
+ * Tool: Expand All Panels
+ *
+ * Expand both left and right panels to show all content.
+ */
+export declare const expandAllPanelsTool: PanelTool;
+
 /**
  * Visual indicator that highlights the focused panel
  *
@@ -297,6 +331,53 @@ export declare interface FocusIndicatorProps {
     style?: default_2.CSSProperties;
 }
 
+/**
+ * Tool: Focus Panel
+ *
+ * Set keyboard/logical focus to a specific panel slot.
+ */
+export declare const focusPanelTool: PanelTool;
+
+/**
+ * Gemini function declaration format
+ */
+export declare interface GeminiFunctionDeclaration {
+    name: string;
+    description: string;
+    parameters: {
+        type: string;
+        properties: Record<string, GeminiPropertySchema>;
+        required: string[];
+    };
+}
+
+/**
+ * Gemini property schema (simplified)
+ */
+export declare interface GeminiPropertySchema {
+    type: string;
+    description?: string;
+    enum?: string[];
+}
+
+/**
+ * Gemini tools wrapper
+ */
+export declare interface GeminiTools {
+    functionDeclarations: GeminiFunctionDeclaration[];
+}
+
+/**
+ * Generate a system prompt section describing available tools.
+ *
+ * @param tools - Array of tools to describe
+ * @param options - Formatting options
+ */
+export declare function generateToolsSystemPrompt(tools: PanelTool[], options?: {
+    header?: string;
+    includeParameters?: boolean;
+}): string;
+
 /**
  * Get the global command registry instance
  * @returns Global CommandRegistryService instance
@@ -309,6 +390,44 @@ export declare function getGlobalCommandRegistry(): CommandRegistryService;
  */
 export declare function getPanelCommands(): Command[];
 
+/**
+ * Utility to extract parameter information for UI rendering.
+ */
+export declare function getToolParameterInfo(tool: RegisteredTool): ToolParameterInfo[];
+
+/**
+ * All layout tools exported as an array.
+ *
+ * Register these with PanelToolRegistry:
+ * ```typescript
+ * import { layoutTools } from '@principal-ade/panel-layouts';
+ * import { getGlobalToolRegistry } from '@principal-ade/panel-framework-core';
+ *
+ * const registry = getGlobalToolRegistry();
+ * registry.registerPanelTools({
+ *   id: 'panel-layouts',
+ *   name: 'Panel Layouts',
+ *   tools: layoutTools,
+ * });
+ * ```
+ */
+export declare const layoutTools: PanelTool[];
+
+/**
+ * Layout tools metadata for registration.
+ *
+ * Use this with PanelToolRegistry.registerPanelTools():
+ * ```typescript
+ * registry.registerPanelTools(layoutToolsMetadata);
+ * ```
+ */
+export declare const layoutToolsMetadata: {
+    id: string;
+    name: string;
+    description: string;
+    tools: PanelTool[];
+};
+
 /**
  * Default localStorage-based persistence adapter for web applications
  */
@@ -349,8 +468,55 @@ export { mapThemeToPanelVars }
 
 export { mapThemeToTabVars }
 
+/**
+ * OpenAI function definition format
+ */
+export declare interface OpenAIFunction {
+    name: string;
+    description: string;
+    parameters: JsonSchema;
+}
+
+/**
+ * OpenAI tool wrapper
+ */
+export declare interface OpenAITool {
+    type: 'function';
+    function: OpenAIFunction;
+}
+
 export { PanelBlurEventPayload }
 
+/**
+ * A button component for collapsing/expanding side panels.
+ *
+ * Shows appropriate icon based on panel state and side:
+ * - Left panel collapsed: PanelLeft icon (show panel)
+ * - Left panel expanded: PanelLeftClose icon (hide panel)
+ * - Right panel collapsed: PanelRight icon (show panel)
+ * - Right panel expanded: PanelRightClose icon (hide panel)
+ */
+export declare const PanelCollapseButton: default_2.FC<PanelCollapseButtonProps>;
+
+export declare interface PanelCollapseButtonProps {
+    /** Whether the panel is currently collapsed */
+    isCollapsed: boolean;
+    /** Callback when the button is clicked */
+    onToggle: () => void;
+    /** Which side the panel is on */
+    side?: 'left' | 'right';
+    /** Icon size in pixels */
+    iconSize?: number;
+    /** Additional inline styles */
+    style?: default_2.CSSProperties;
+    /** Keyboard shortcut hint to show in tooltip */
+    shortcutHint?: string;
+    /** Custom title/tooltip */
+    title?: string;
+    /** Custom class name */
+    className?: string;
+}
+
 /**
  * Collapsed state for panels
  */
@@ -364,6 +530,102 @@ export declare interface PanelCollapsed {
  */
 export declare const panelCommands: Command[];
 
+/**
+ * A button component for opening panel configuration/layout settings.
+ */
+export declare const PanelConfigureButton: default_2.FC<PanelConfigureButtonProps>;
+
+export declare interface PanelConfigureButtonProps {
+    /** Callback when the button is clicked */
+    onConfigure: () => void;
+    /** Icon size in pixels */
+    iconSize?: number;
+    /** Additional inline styles */
+    style?: default_2.CSSProperties;
+    /** Custom title/tooltip */
+    title?: string;
+    /** Custom class name */
+    className?: string;
+}
+
+/**
+ * A unified panel controls component that provides buttons for:
+ * - Collapsing/expanding left and right sidebars
+ * - Switching/swapping panel positions
+ * - Opening panel configuration
+ *
+ * The buttons are rendered in order:
+ * 1. Left sidebar collapse button
+ * 2. Left-middle switch button
+ * 3. Configure panels button
+ * 4. Right-middle switch button
+ * 5. Right sidebar collapse button
+ *
+ * @example
+ * ```tsx
+ * <PanelControls
+ *   leftSidebarCollapsed={leftCollapsed}
+ *   onToggleLeftSidebar={() => setLeftCollapsed(!leftCollapsed)}
+ *   showLeftSidebarControl
+ *   rightSidebarCollapsed={rightCollapsed}
+ *   onToggleRightSidebar={() => setRightCollapsed(!rightCollapsed)}
+ *   showRightSidebarControl
+ *   onSwitchLeftMiddlePanels={handleSwitchLeftMiddle}
+ *   showSwitchLeftMiddle
+ *   onSwitchRightMiddlePanels={handleSwitchRightMiddle}
+ *   showSwitchRightMiddle
+ *   onConfigurePanels={() => setShowConfigModal(true)}
+ *   showConfigureButton
+ * />
+ * ```
+ */
+export declare const PanelControls: default_2.FC<PanelControlsProps>;
+
+export declare interface PanelControlsProps {
+    /** Left sidebar collapsed state */
+    leftSidebarCollapsed?: boolean;
+    /** Callback when left sidebar toggle is clicked */
+    onToggleLeftSidebar?: () => void;
+    /** Whether to show the left sidebar control */
+    showLeftSidebarControl?: boolean;
+    /** Right sidebar collapsed state */
+    rightSidebarCollapsed?: boolean;
+    /** Callback when right sidebar toggle is clicked */
+    onToggleRightSidebar?: () => void;
+    /** Whether to show the right sidebar control */
+    showRightSidebarControl?: boolean;
+    /** Callback when switch left-middle panels button is clicked */
+    onSwitchLeftMiddlePanels?: () => void;
+    /** Whether to show the switch left-middle button */
+    showSwitchLeftMiddle?: boolean;
+    /** Callback when switch right-middle panels button is clicked */
+    onSwitchRightMiddlePanels?: () => void;
+    /** Whether to show the switch right-middle button */
+    showSwitchRightMiddle?: boolean;
+    /** Callback when configure panels button is clicked */
+    onConfigurePanels?: () => void;
+    /** Whether to show the configure panels button */
+    showConfigureButton?: boolean;
+    /** Gap between buttons in pixels */
+    gap?: number;
+    /** Additional inline styles for the container */
+    style?: default_2.CSSProperties;
+    /** Custom class name for the container */
+    className?: string;
+    /** Icon size for all buttons */
+    iconSize?: number;
+    /** Props to pass to the left collapse button */
+    leftCollapseButtonProps?: Partial<Omit<PanelCollapseButtonProps, 'isCollapsed' | 'onToggle' | 'side'>>;
+    /** Props to pass to the right collapse button */
+    rightCollapseButtonProps?: Partial<Omit<PanelCollapseButtonProps, 'isCollapsed' | 'onToggle' | 'side'>>;
+    /** Props to pass to the left-middle switch button */
+    leftMiddleSwitchButtonProps?: Partial<Omit<PanelSwitchButtonProps, 'onSwitch' | 'variant'>>;
+    /** Props to pass to the right-middle switch button */
+    rightMiddleSwitchButtonProps?: Partial<Omit<PanelSwitchButtonProps, 'onSwitch' | 'variant'>>;
+    /** Props to pass to the configure button */
+    configureButtonProps?: Partial<Omit<PanelConfigureButtonProps, 'onConfigure'>>;
+}
+
 export { PanelDefinition }
 
 export { PanelDefinitionWithContent }
@@ -424,6 +686,29 @@ export { PanelSlot }
  */
 export declare type PanelSlotId = 'left' | 'middle' | 'right';
 
+/**
+ * A button component for switching/swapping panel positions.
+ *
+ * - left-middle: Shows ArrowLeftRight icon for swapping left and middle panels
+ * - right-middle: Shows ArrowRightLeft icon for swapping right and middle panels
+ */
+export declare const PanelSwitchButton: default_2.FC<PanelSwitchButtonProps>;
+
+export declare interface PanelSwitchButtonProps {
+    /** Callback when the button is clicked */
+    onSwitch: () => void;
+    /** Which panels are being switched */
+    variant?: 'left-middle' | 'right-middle';
+    /** Icon size in pixels */
+    iconSize?: number;
+    /** Additional inline styles */
+    style?: default_2.CSSProperties;
+    /** Custom title/tooltip */
+    title?: string;
+    /** Custom class name */
+    className?: string;
+}
+
 /**
  * Storage adapter interface for persisting panel state
  * Implementations can use localStorage, Electron IPC, or remote storage
@@ -478,10 +763,25 @@ export declare interface RepositoryWorkspaceState {
  */
 export declare function resetGlobalCommandRegistry(): void;
 
+/**
+ * Tool: Reset Layout
+ *
+ * Reset panel sizes to the default layout.
+ */
+export declare const resetLayoutTool: PanelTool;
+
 export { ResponsiveConfigurablePanelLayout }
 
 export { ResponsiveConfigurablePanelLayoutProps }
 
+/**
+ * Tool: Switch Panel
+ *
+ * Change which content is displayed in a panel slot.
+ * The available panels depend on the application.
+ */
+export declare const switchPanelTool: PanelTool;
+
 export { TabsConfig }
 
 export { Theme }
@@ -502,6 +802,92 @@ export declare interface ThreePanelPersistence {
 
 export { TilesConfig }
 
+/**
+ * Tool: Toggle Panel
+ *
+ * Collapse or expand a side panel (left or right).
+ */
+export declare const togglePanelTool: PanelTool;
+
+/**
+ * Configuration for the tool-to-command bridge
+ */
+export declare interface ToolCommandBridgeConfig {
+    /** Category prefix for tool commands (default: 'Panel Tools') */
+    categoryPrefix?: string;
+    /** Priority offset for tool commands (default: 50) */
+    basePriority?: number;
+    /** Whether to include panel ID in category (default: true) */
+    includePanelInCategory?: boolean;
+}
+
+/**
+ * Parameter information for UI rendering
+ */
+export declare interface ToolParameterInfo {
+    name: string;
+    type: string;
+    description: string;
+    required: boolean;
+    default?: unknown;
+    enum?: string[];
+}
+
+/**
+ * Convert an array of PanelTools to AIFunctionDefinition format.
+ */
+export declare function toolsToAIFunctions(tools: PanelTool[]): AIFunctionDefinition[];
+
+/**
+ * Convert an array of PanelTools to Anthropic tools format.
+ */
+export declare function toolsToAnthropicFormat(tools: PanelTool[]): AnthropicTool[];
+
+/**
+ * Converts all tools from a registry into commands.
+ */
+export declare function toolsToCommands(registry: PanelToolRegistry, config?: ToolCommandBridgeConfig): Command[];
+
+/**
+ * Convert an array of PanelTools to Gemini tools format.
+ */
+export declare function toolsToGeminiFormat(tools: PanelTool[]): GeminiTools;
+
+/**
+ * Convert an array of PanelTools to OpenAI tools format.
+ */
+export declare function toolsToOpenAIFormat(tools: PanelTool[]): OpenAITool[];
+
+/**
+ * Convert a PanelTool to the generic AIFunctionDefinition format.
+ * This is the format used by PanelToolRegistry.getToolsAsAIFunctions()
+ */
+export declare function toolToAIFunction(tool: PanelTool): AIFunctionDefinition;
+
+/**
+ * Convert a PanelTool to Anthropic tool format.
+ */
+export declare function toolToAnthropicFormat(tool: PanelTool): AnthropicTool;
+
+/**
+ * Converts a registered tool into a command palette command.
+ *
+ * For tools with no required parameters, the command executes immediately.
+ * For tools with required parameters, this is a placeholder - full
+ * implementation would need a parameter input UI.
+ */
+export declare function toolToCommand(tool: RegisteredTool, registry: PanelToolRegistry, config?: ToolCommandBridgeConfig): Command;
+
+/**
+ * Convert a PanelTool to Gemini function declaration format.
+ */
+export declare function toolToGeminiFunction(tool: PanelTool): GeminiFunctionDeclaration;
+
+/**
+ * Convert a PanelTool to OpenAI function format.
+ */
+export declare function toolToOpenAIFunction(tool: PanelTool): OpenAITool;
+
 /**
  * Return type for the usePanelPersistence hook (two-panel variant)
  */
@@ -735,6 +1121,12 @@ export declare interface UsePanelPersistenceOptions {
     adapter?: PersistenceAdapter;
 }
 
+/**
+ * Hook to use tool commands in React components.
+ * Subscribes to registry changes and updates commands accordingly.
+ */
+export declare function useToolCommands(registry: PanelToolRegistry, config?: ToolCommandBridgeConfig): Command[];
+
 export declare function useWorkspace(options?: UseWorkspaceOptions): UseWorkspaceReturn;
 
 export declare interface UseWorkspaceOptions {