yaml-flow 1.0.0

package/dist/core/index.d.cts

@@ -0,0 +1,102 @@
+import { F as FlowConfig, i as StepHandler, E as EngineOptions, d as FlowResult, c as FlowEventType, b as FlowEventListener, f as FlowStore } from '../types-BoWndaAJ.cjs';
+export { C as CircuitBreakerConfig, a as FlowEvent, e as FlowSettings, R as RetryConfig, g as RunState, S as StepConfig, h as StepContext, j as StepInput, k as StepResult, T as TerminalStateConfig } from '../types-BoWndaAJ.cjs';
+
+/**
+ * yaml-flow - Core Flow Engine
+ *
+ * Isomorphic workflow engine that executes declarative flows.
+ * Works in both browser and Node.js environments.
+ */
+
+/**
+ * FlowEngine - The main workflow execution engine
+ */
+declare class FlowEngine {
+    private flow;
+    private handlers;
+    private store;
+    private components;
+    private options;
+    private listeners;
+    private aborted;
+    constructor(flow: FlowConfig, handlers: Record<string, StepHandler>, options?: EngineOptions);
+    /**
+     * Validate the flow configuration
+     */
+    private validateFlow;
+    /**
+     * Run the flow from the start
+     */
+    run(initialData?: Record<string, unknown>): Promise<FlowResult>;
+    /**
+     * Resume a paused or interrupted flow
+     */
+    resume(runId: string): Promise<FlowResult>;
+    /**
+     * Pause a running flow
+     */
+    pause(runId: string): Promise<void>;
+    /**
+     * Main execution loop
+     */
+    private executeLoop;
+    /**
+     * Execute a single step
+     */
+    private executeStep;
+    /**
+     * Extract data to return based on return_artifacts configuration
+     */
+    private extractReturnData;
+    /**
+     * Sleep helper
+     */
+    private sleep;
+    /**
+     * Subscribe to flow events
+     */
+    on(type: FlowEventType, listener: FlowEventListener): () => void;
+    /**
+     * Emit an event
+     */
+    private emit;
+    /**
+     * Get the current store instance
+     */
+    getStore(): FlowStore;
+}
+/**
+ * Create a flow engine instance
+ */
+declare function createEngine(flow: FlowConfig, handlers: Record<string, StepHandler>, options?: EngineOptions): FlowEngine;
+
+/**
+ * yaml-flow - Flow Loader
+ *
+ * Utilities for loading and validating flow configurations.
+ */
+
+/**
+ * Parse YAML string to FlowConfig
+ * Requires 'yaml' package to be installed
+ */
+declare function parseYaml(yamlString: string): Promise<FlowConfig>;
+/**
+ * Load flow from a URL (browser-friendly)
+ */
+declare function loadFlowFromUrl(url: string): Promise<FlowConfig>;
+/**
+ * Load flow from file path (Node.js only)
+ */
+declare function loadFlowFromFile(filePath: string): Promise<FlowConfig>;
+/**
+ * Validate a flow configuration
+ * Returns array of validation errors (empty if valid)
+ */
+declare function validateFlowConfig(flow: unknown): string[];
+/**
+ * Load and validate flow, throwing if invalid
+ */
+declare function loadFlow(source: string | FlowConfig): Promise<FlowConfig>;
+
+export { EngineOptions, FlowConfig, FlowEngine, FlowEventListener, FlowEventType, FlowResult, FlowStore, StepHandler, createEngine, loadFlow, loadFlowFromFile, loadFlowFromUrl, parseYaml, validateFlowConfig };

package/dist/core/index.d.ts

@@ -0,0 +1,102 @@
+import { F as FlowConfig, i as StepHandler, E as EngineOptions, d as FlowResult, c as FlowEventType, b as FlowEventListener, f as FlowStore } from '../types-BoWndaAJ.js';
+export { C as CircuitBreakerConfig, a as FlowEvent, e as FlowSettings, R as RetryConfig, g as RunState, S as StepConfig, h as StepContext, j as StepInput, k as StepResult, T as TerminalStateConfig } from '../types-BoWndaAJ.js';
+
+/**
+ * yaml-flow - Core Flow Engine
+ *
+ * Isomorphic workflow engine that executes declarative flows.
+ * Works in both browser and Node.js environments.
+ */
+
+/**
+ * FlowEngine - The main workflow execution engine
+ */
+declare class FlowEngine {
+    private flow;
+    private handlers;
+    private store;
+    private components;
+    private options;
+    private listeners;
+    private aborted;
+    constructor(flow: FlowConfig, handlers: Record<string, StepHandler>, options?: EngineOptions);
+    /**
+     * Validate the flow configuration
+     */
+    private validateFlow;
+    /**
+     * Run the flow from the start
+     */
+    run(initialData?: Record<string, unknown>): Promise<FlowResult>;
+    /**
+     * Resume a paused or interrupted flow
+     */
+    resume(runId: string): Promise<FlowResult>;
+    /**
+     * Pause a running flow
+     */
+    pause(runId: string): Promise<void>;
+    /**
+     * Main execution loop
+     */
+    private executeLoop;
+    /**
+     * Execute a single step
+     */
+    private executeStep;
+    /**
+     * Extract data to return based on return_artifacts configuration
+     */
+    private extractReturnData;
+    /**
+     * Sleep helper
+     */
+    private sleep;
+    /**
+     * Subscribe to flow events
+     */
+    on(type: FlowEventType, listener: FlowEventListener): () => void;
+    /**
+     * Emit an event
+     */
+    private emit;
+    /**
+     * Get the current store instance
+     */
+    getStore(): FlowStore;
+}
+/**
+ * Create a flow engine instance
+ */
+declare function createEngine(flow: FlowConfig, handlers: Record<string, StepHandler>, options?: EngineOptions): FlowEngine;
+
+/**
+ * yaml-flow - Flow Loader
+ *
+ * Utilities for loading and validating flow configurations.
+ */
+
+/**
+ * Parse YAML string to FlowConfig
+ * Requires 'yaml' package to be installed
+ */
+declare function parseYaml(yamlString: string): Promise<FlowConfig>;
+/**
+ * Load flow from a URL (browser-friendly)
+ */
+declare function loadFlowFromUrl(url: string): Promise<FlowConfig>;
+/**
+ * Load flow from file path (Node.js only)
+ */
+declare function loadFlowFromFile(filePath: string): Promise<FlowConfig>;
+/**
+ * Validate a flow configuration
+ * Returns array of validation errors (empty if valid)
+ */
+declare function validateFlowConfig(flow: unknown): string[];
+/**
+ * Load and validate flow, throwing if invalid
+ */
+declare function loadFlow(source: string | FlowConfig): Promise<FlowConfig>;
+
+export { EngineOptions, FlowConfig, FlowEngine, FlowEventListener, FlowEventType, FlowResult, FlowStore, StepHandler, createEngine, loadFlow, loadFlowFromFile, loadFlowFromUrl, parseYaml, validateFlowConfig };