@d34dman/flowdrop 0.0.23 → 0.0.25

package/dist/types/index.d.ts

@@ -87,6 +87,37 @@ export interface DynamicPort {
     /** Whether this port is required for execution */
     required?: boolean;
 }
+/**
+ * Branch configuration for gateway nodes
+ *
+ * Branches define conditional output paths in gateway/switch nodes.
+ * Each branch creates an output handle that can be connected to downstream nodes.
+ * Branches are stored in `config.branches` array and support dynamic addition/removal
+ * through the node configuration panel.
+ *
+ * @example
+ * ```typescript
+ * const branches: Branch[] = [
+ *   { name: "high", label: "High Priority", condition: "priority > 8" },
+ *   { name: "medium", label: "Medium Priority", condition: "priority >= 4" },
+ *   { name: "default", label: "Default", isDefault: true }
+ * ];
+ * ```
+ */
+export interface Branch {
+    /** Unique identifier for the branch (used as handle ID and for connections) */
+    name: string;
+    /** Display label shown in the UI (optional, defaults to name) */
+    label?: string;
+    /** Description of when this branch is activated */
+    description?: string;
+    /** Optional value associated with the branch (e.g., for Switch matching) */
+    value?: string;
+    /** Optional condition expression for this branch */
+    condition?: string;
+    /** Whether this is the default/fallback branch */
+    isDefault?: boolean;
+}
 /**
  * Convert a DynamicPort to a NodePort
  * @param port - The dynamic port configuration
@@ -180,6 +211,8 @@ export interface NodeMetadata {
     inputs: NodePort[];
     outputs: NodePort[];
     configSchema?: ConfigSchema;
+    /** Default configuration values for this node type */
+    config?: Record<string, unknown>;
     tags?: string[];
     /**
      * Custom extension properties for 3rd party integrations
@@ -314,13 +347,59 @@ export type SchemaProperty<T extends SchemaType> = T extends 'config' ? ConfigPr
 export type SchemaTypeMap<T extends SchemaType> = T extends 'config' ? ConfigSchema : T extends 'input' ? InputSchema : T extends 'output' ? OutputSchema : never;
 /**
  * Node configuration values
- * Key-value pairs of user-entered configuration values
+ *
+ * Key-value pairs of user-entered configuration values based on the node's configSchema.
+ * This is where all node-specific settings are stored, including:
+ *
+ * **Standard Properties:**
+ * - Any property defined in the node's `configSchema` (e.g., model, temperature, apiKey)
+ *
+ * **Special Properties (Dynamic Ports):**
+ * - `dynamicInputs`: Array of DynamicPort for user-defined input handles
+ * - `dynamicOutputs`: Array of DynamicPort for user-defined output handles
+ * - `branches`: Array of Branch for gateway node conditional output paths
+ *
+ * The backend uses this object to:
+ * - Store and retrieve node configuration
+ * - Pass configuration values to node processors during execution
+ * - Persist node state across sessions
+ *
+ * @example
+ * ```typescript
+ * const config: ConfigValues = {
+ *   // Standard configuration from configSchema
+ *   model: "gpt-4o-mini",
+ *   temperature: 0.7,
+ *   maxTokens: 1000,
+ *
+ *   // Dynamic input ports
+ *   dynamicInputs: [
+ *     { name: "extra_data", label: "Extra Data", dataType: "json" }
+ *   ],
+ *
+ *   // Gateway branches
+ *   branches: [
+ *     { name: "success", label: "Success", condition: "status === 200" },
+ *     { name: "error", label: "Error", isDefault: true }
+ *   ]
+ * };
+ * ```
  */
 export interface ConfigValues {
+    /** Dynamic input ports for user-defined input handles */
+    dynamicInputs?: DynamicPort[];
+    /** Dynamic output ports for user-defined output handles */
+    dynamicOutputs?: DynamicPort[];
+    /** Branches for gateway node conditional output paths */
+    branches?: Branch[];
+    /** Any other configuration properties defined in configSchema */
     [key: string]: unknown;
 }
 /**
  * Extended node type for workflows
+ *
+ * Represents a node instance in a workflow, containing position, display data,
+ * configuration values, and metadata from the node type definition.
  */
 export interface WorkflowNode extends Node {
     id: string;
@@ -328,11 +407,30 @@ export interface WorkflowNode extends Node {
     position: XYPosition;
     deletable?: boolean;
     data: {
+        /** Display label for the node instance */
         label: string;
+        /**
+         * Node configuration values
+         *
+         * Contains all user-configured settings for this node instance based on the
+         * node type's configSchema. This includes standard properties defined in the
+         * schema as well as special dynamic port configurations.
+         *
+         * The backend uses this object to:
+         * - Store and retrieve node configuration
+         * - Pass configuration values to node processors during execution
+         * - Persist node state across sessions
+         *
+         * @see ConfigValues for detailed documentation of available properties
+         */
         config: ConfigValues;
+        /** Node type metadata (inputs, outputs, configSchema, etc.) */
         metadata: NodeMetadata;
+        /** Whether the node is currently processing/executing */
         isProcessing?: boolean;
+        /** Error message if the node execution failed */
         error?: string;
+        /** Alternative node identifier */
         nodeId?: string;
         /** Node execution tracking information */
         executionInfo?: NodeExecutionInfo;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@d34dman/flowdrop",
   "license": "MIT",
   "private": false,
-  "version": "0.0.23",
+  "version": "0.0.25",
   "scripts": {
     "dev": "vite dev",
     "build": "vite build && npm run prepack",
@@ -104,6 +104,7 @@
     "@sveltejs/vite-plugin-svelte": "^5.0.0",
     "@types/marked": "^6.0.0",
     "@types/node": "^20",
+    "@types/uuid": "^10.0.0",
     "@vitest/browser": "^3.2.3",
     "eslint": "^9.18.0",
     "eslint-config-prettier": "^10.0.1",
@@ -125,8 +126,7 @@
     "vite": "^6.2.6",
     "vite-plugin-devtools-json": "^0.2.1",
     "vitest": "^3.2.3",
-    "vitest-browser-svelte": "^0.1.0",
-    "@types/uuid": "^10.0.0"
+    "vitest-browser-svelte": "^0.1.0"
   },
   "overrides": {
     "@sveltejs/kit": {
@@ -137,7 +137,13 @@
     "svelte"
   ],
   "dependencies": {
+    "@codemirror/autocomplete": "^6.20.0",
+    "@codemirror/lang-json": "^6.0.2",
+    "@codemirror/lint": "^6.9.2",
+    "@codemirror/theme-one-dark": "^6.1.3",
     "@xyflow/svelte": "~1.2",
+    "codemirror": "^6.0.2",
+    "easymde": "^2.20.0",
     "marked": "^16.1.1",
     "svelte-5-french-toast": "^2.0.6",
     "uuid": "^11.1.0"