@d34dman/flowdrop 0.0.14 → 0.0.16

package/README.md

@@ -7,10 +7,12 @@ A visual workflow editor component library built with Svelte 5 and @xyflow/svelt
 - **Visual Workflow Editor**: Drag-and-drop interface for building node-based workflows
 - **Svelte 5 Components**: Modern, reactive components with runes
 - **Configurable API Client**: Flexible endpoint configuration for backend integration
+- **Runtime Configuration**: Build once, deploy anywhere with environment variables
 - **Node System**: Extensible node types with customizable configuration
 - **Real-time Updates**: Live workflow state management with stores
 - **Framework Agnostic**: Can be integrated into any web application
 - **TypeScript Support**: Full type definitions included
+- **Docker Ready**: Production-ready Dockerfile and Docker Compose configuration
 
 ## 📦 Installation
 
@@ -325,6 +327,52 @@ MIT
 - Create an issue in the project repository
 - Review the examples in `src/lib/examples/`
 
+## 🚢 Deployment
+
+FlowDrop uses **runtime configuration** instead of build-time environment variables, allowing you to build once and deploy to multiple environments.
+
+### Quick Start with Docker
+
+```bash
+# Copy environment file
+cp env.example .env
+
+# Edit .env with your configuration
+# Set FLOWDROP_API_BASE_URL to your backend API URL
+
+# Start with Docker Compose
+docker-compose up -d
+```
+
+### Environment Variables
+
+**Production (Runtime):**
+- `FLOWDROP_API_BASE_URL` - Backend API URL
+- `FLOWDROP_THEME` - UI theme (light/dark/auto)
+- `FLOWDROP_TIMEOUT` - Request timeout in milliseconds
+- `FLOWDROP_AUTH_TYPE` - Authentication type (none/bearer/api_key/custom)
+- `FLOWDROP_AUTH_TOKEN` - Authentication token
+
+**Development (Build-time):**
+- `VITE_API_BASE_URL` - Dev API URL (used only during `npm run dev`)
+
+### Build for Production
+
+```bash
+# Install dependencies
+npm ci
+
+# Build the application
+npm run build
+
+# Set environment variables and start
+export FLOWDROP_API_BASE_URL=http://your-backend:8080/api/flowdrop
+node build
+```
+
+For detailed deployment instructions, see:
+- [DOCKER.md](./DOCKER.md) - Docker quick start
+
 ---
 
 **FlowDrop** - Visual workflow editing for modern web applications

package/dist/api/enhanced-client.d.ts

@@ -1,44 +1,160 @@
 /**
  * Enhanced API Client for FlowDrop
- * Uses configurable endpoints for all API actions
+ *
+ * Uses configurable endpoints and supports pluggable authentication providers.
+ *
+ * @module api/enhanced-client
  */
-import type { NodeMetadata, Workflow, ExecutionResult } from '../types/index.js';
-import type { EndpointConfig } from '../config/endpoints.js';
+import type { NodeMetadata, Workflow, ExecutionResult } from "../types/index.js";
+import type { EndpointConfig } from "../config/endpoints.js";
+import type { AuthProvider } from "../types/auth.js";
+/**
+ * API error with additional context
+ */
+export declare class ApiError extends Error {
+    /** HTTP status code */
+    readonly status: number;
+    /** Original error data from API */
+    readonly errorData: Record<string, unknown>;
+    /** Operation that was being performed */
+    readonly operation: string;
+    constructor(message: string, status: number, operation: string, errorData?: Record<string, unknown>);
+}
 /**
  * Enhanced HTTP API client for FlowDrop with configurable endpoints
+ *
+ * Supports pluggable authentication via AuthProvider interface.
+ *
+ * @example
+ * ```typescript
+ * // With AuthProvider
+ * const client = new EnhancedFlowDropApiClient(config, authProvider);
+ *
+ * // Backward compatible (uses config.auth)
+ * const client = new EnhancedFlowDropApiClient(config);
+ * ```
  */
 export declare class EnhancedFlowDropApiClient {
     private config;
-    constructor(config: EndpointConfig);
+    private authProvider;
     /**
-     * Make HTTP request with error handling and retry logic
+     * Create a new EnhancedFlowDropApiClient
+     *
+     * @param config - Endpoint configuration
+     * @param authProvider - Optional authentication provider (if not provided, uses config.auth)
+     */
+    constructor(config: EndpointConfig, authProvider?: AuthProvider);
+    /**
+     * Make HTTP request with error handling, retry logic, and auth support
+     *
+     * @param endpointKey - Key identifying the endpoint (for method/header lookup)
+     * @param endpointPath - The endpoint path template
+     * @param params - URL parameters to substitute
+     * @param options - Additional fetch options
+     * @param operation - Description of the operation (for error messages)
      */
     private request;
+    /**
+     * Update the auth provider
+     *
+     * Useful for updating auth after token refresh in parent application.
+     * Note: Per specification, this should rarely be needed as auth is typically
+     * set at mount time and requires remount to change.
+     *
+     * @param authProvider - New authentication provider
+     */
+    setAuthProvider(authProvider: AuthProvider): void;
+    /**
+     * Get current auth provider
+     *
+     * @returns The current AuthProvider instance
+     */
+    getAuthProvider(): AuthProvider;
+    /**
+     * Fetch all available node types
+     */
     getAvailableNodes(): Promise<NodeMetadata[]>;
+    /**
+     * Fetch nodes filtered by category
+     */
     getNodesByCategory(category: string): Promise<NodeMetadata[]>;
+    /**
+     * Fetch metadata for a specific node type
+     */
     getNodeMetadata(nodeId: string): Promise<NodeMetadata>;
+    /**
+     * Save a new workflow
+     */
     saveWorkflow(workflow: Workflow): Promise<Workflow>;
+    /**
+     * Update an existing workflow
+     */
     updateWorkflow(workflowId: string, workflow: Partial<Workflow>): Promise<Workflow>;
+    /**
+     * Load a workflow by ID
+     */
     loadWorkflow(workflowId: string): Promise<Workflow>;
+    /**
+     * List all workflows
+     */
     listWorkflows(): Promise<Workflow[]>;
+    /**
+     * Delete a workflow
+     */
     deleteWorkflow(workflowId: string): Promise<void>;
+    /**
+     * Validate a workflow
+     */
     validateWorkflow(workflow: Workflow): Promise<{
         valid: boolean;
         errors: string[];
     }>;
+    /**
+     * Export a workflow as JSON string
+     */
     exportWorkflow(workflowId: string): Promise<string>;
+    /**
+     * Import a workflow from JSON
+     */
     importWorkflow(workflowJson: string): Promise<Workflow>;
+    /**
+     * Execute a workflow
+     */
     executeWorkflow(workflowId: string, inputs?: Record<string, unknown>): Promise<ExecutionResult>;
+    /**
+     * Get execution status
+     */
     getExecutionStatus(executionId: string): Promise<ExecutionResult>;
+    /**
+     * Cancel a running execution
+     */
     cancelExecution(executionId: string): Promise<void>;
+    /**
+     * Get execution logs
+     */
     getExecutionLogs(executionId: string): Promise<string[]>;
+    /**
+     * List available templates
+     */
     listTemplates(): Promise<Workflow[]>;
+    /**
+     * Get a template by ID
+     */
     getTemplate(templateId: string): Promise<Workflow>;
+    /**
+     * Get system health status
+     */
     getSystemHealth(): Promise<{
         status: string;
         timestamp: number;
     }>;
+    /**
+     * Get system configuration
+     */
     getSystemConfig(): Promise<Record<string, unknown>>;
+    /**
+     * Get system version information
+     */
     getSystemVersion(): Promise<{
         version: string;
         build: string;