@agentxjs/ui 0.0.9 → 0.1.2

package/dist/hooks/useImages.d.ts

@@ -0,0 +1,84 @@
+import { AgentX, ImageListItem } from 'agentxjs';
+/**
+ * Return type of useImages hook
+ */
+export interface UseImagesResult {
+    /**
+     * All images (conversations) with online status
+     */
+    images: ImageListItem[];
+    /**
+     * Loading state
+     */
+    isLoading: boolean;
+    /**
+     * Error state
+     */
+    error: Error | null;
+    /**
+     * Refresh images from server
+     */
+    refresh: () => Promise<void>;
+    /**
+     * Create a new image (conversation)
+     * @returns The new image record
+     */
+    createImage: (config?: {
+        name?: string;
+        description?: string;
+        systemPrompt?: string;
+    }) => Promise<ImageListItem>;
+    /**
+     * Run an image - create or reuse an Agent
+     * @returns The agent ID and whether it was reused
+     */
+    runImage: (imageId: string) => Promise<{
+        agentId: string;
+        reused: boolean;
+    }>;
+    /**
+     * Stop an image - destroy the Agent but keep the Image
+     */
+    stopImage: (imageId: string) => Promise<void>;
+    /**
+     * Update image metadata
+     */
+    updateImage: (imageId: string, updates: {
+        name?: string;
+        description?: string;
+    }) => Promise<ImageListItem>;
+    /**
+     * Delete an image
+     */
+    deleteImage: (imageId: string) => Promise<void>;
+}
+/**
+ * Options for useImages hook
+ */
+export interface UseImagesOptions {
+    /**
+     * Container ID to filter images (optional)
+     */
+    containerId?: string;
+    /**
+     * Auto-load images on mount
+     * @default true
+     */
+    autoLoad?: boolean;
+    /**
+     * Callback when an image is run
+     */
+    onRun?: (imageId: string, agentId: string, reused: boolean) => void;
+    /**
+     * Callback when images list changes
+     */
+    onImagesChange?: (images: ImageListItem[]) => void;
+}
+/**
+ * React hook for Image management
+ *
+ * @param agentx - AgentX instance
+ * @param options - Optional configuration
+ * @returns Image state and operations
+ */
+export declare function useImages(agentx: AgentX | null, options?: UseImagesOptions): UseImagesResult;