@orbytautomation/engine 0.1.0

package/dist/core/EngineContext.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Engine Context
+ *
+ * Runtime context passed through the engine during workflow execution.
+ * Provides access to engine components and execution state.
+ *
+ * @module core
+ */
+import type { EventBus } from '../events/EventBus.js';
+import type { HookManager } from '../hooks/HookManager.js';
+import type { AdapterRegistry } from '../adapters/AdapterRegistry.js';
+import type { ExecutionEngine } from '../execution/ExecutionEngine.js';
+import type { StepExecutor } from '../execution/StepExecutor.js';
+import type { WorkflowExecutor } from '../execution/WorkflowExecutor.js';
+import type { OrbytEngineConfig } from './EngineConfig.js';
+/**
+ * Engine runtime context
+ *
+ * Provides access to engine internals during execution.
+ * This is the "global" context available to all components.
+ *
+ * Different from WorkflowHookContext or StepHookContext which are
+ * specific to individual workflow/step executions.
+ *
+ * @example
+ * ```ts
+ * // Inside a custom adapter
+ * async execute(step, context, engineContext) {
+ *   // Access engine components
+ *   engineContext.eventBus.emit(event);
+ *   const otherAdapter = engineContext.adapterRegistry.get('http');
+ * }
+ * ```
+ */
+export interface EngineContext {
+    /**
+     * Engine configuration
+     */
+    config: OrbytEngineConfig;
+    /**
+     * Event bus for emitting and listening to engine events
+     */
+    eventBus: EventBus;
+    /**
+     * Hook manager for lifecycle hooks
+     */
+    hookManager: HookManager;
+    /**
+     * Adapter registry - all registered adapters
+     */
+    adapterRegistry: AdapterRegistry;
+    /**
+     * Execution engine instance
+     */
+    executionEngine: ExecutionEngine;
+    /**
+     * Step executor instance
+     */
+    stepExecutor: StepExecutor;
+    /**
+     * Workflow executor instance
+     */
+    workflowExecutor: WorkflowExecutor;
+    /**
+     * Working directory for this engine instance
+     */
+    workingDirectory: string;
+    /**
+     * Engine start time
+     */
+    startedAt: Date;
+    /**
+     * Custom metadata
+     */
+    metadata?: Record<string, any>;
+}
+/**
+ * Create an engine context from components
+ *
+ * @param components - Engine components
+ * @returns Engine context
+ */
+export declare function createEngineContext(components: {
+    config: OrbytEngineConfig;
+    eventBus: EventBus;
+    hookManager: HookManager;
+    adapterRegistry: AdapterRegistry;
+    executionEngine: ExecutionEngine;
+    stepExecutor: StepExecutor;
+    workflowExecutor: WorkflowExecutor;
+    workingDirectory: string;
+    metadata?: Record<string, any>;
+}): EngineContext;
+//# sourceMappingURL=EngineContext.d.ts.map

package/dist/core/EngineContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EngineContext.d.ts","sourceRoot":"","sources":["../../src/core/EngineContext.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE3D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;IAEjC;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;IAEjC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE;IAC9C,MAAM,EAAE,iBAAiB,CAAC;IAC1B,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,eAAe,CAAC;IACjC,eAAe,EAAE,eAAe,CAAC;IACjC,YAAY,EAAE,YAAY,CAAC;IAC3B,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC,GAAG,aAAa,CAahB"}

package/dist/core/EngineContext.js

@@ -0,0 +1,29 @@
+/**
+ * Engine Context
+ *
+ * Runtime context passed through the engine during workflow execution.
+ * Provides access to engine components and execution state.
+ *
+ * @module core
+ */
+/**
+ * Create an engine context from components
+ *
+ * @param components - Engine components
+ * @returns Engine context
+ */
+export function createEngineContext(components) {
+    return {
+        config: components.config,
+        eventBus: components.eventBus,
+        hookManager: components.hookManager,
+        adapterRegistry: components.adapterRegistry,
+        executionEngine: components.executionEngine,
+        stepExecutor: components.stepExecutor,
+        workflowExecutor: components.workflowExecutor,
+        workingDirectory: components.workingDirectory,
+        startedAt: new Date(),
+        metadata: components.metadata,
+    };
+}
+//# sourceMappingURL=EngineContext.js.map

package/dist/core/EngineContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EngineContext.js","sourceRoot":"","sources":["../../src/core/EngineContext.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAiFH;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAUnC;IACC,OAAO;QACL,MAAM,EAAE,UAAU,CAAC,MAAM;QACzB,QAAQ,EAAE,UAAU,CAAC,QAAQ;QAC7B,WAAW,EAAE,UAAU,CAAC,WAAW;QACnC,eAAe,EAAE,UAAU,CAAC,eAAe;QAC3C,eAAe,EAAE,UAAU,CAAC,eAAe;QAC3C,YAAY,EAAE,UAAU,CAAC,YAAY;QACrC,gBAAgB,EAAE,UAAU,CAAC,gBAAgB;QAC7C,gBAAgB,EAAE,UAAU,CAAC,gBAAgB;QAC7C,SAAS,EAAE,IAAI,IAAI,EAAE;QACrB,QAAQ,EAAE,UAAU,CAAC,QAAQ;KAC9B,CAAC;AACJ,CAAC"}

package/dist/core/OrbytEngine.d.ts

@@ -0,0 +1,234 @@
+/**
+ * Orbyt Engine - Main Public API
+ *
+ * User-facing engine class that provides a clean, intuitive API for running workflows.
+ * Wraps the internal ExecutionEngine with a simpler interface.
+ *
+ * @module core
+ */
+import type { OrbytEngineConfig } from './EngineConfig.js';
+import type { EngineContext } from './EngineContext.js';
+import { type ParsedWorkflow } from '../parser/WorkflowParser.js';
+import type { WorkflowResult } from '../execution/WorkflowExecutor.js';
+import { EventBus } from '../events/EventBus.js';
+import type { Adapter } from '@dev-ecosystem/core';
+import type { LifecycleHook } from '../hooks/LifecycleHooks.js';
+/**
+ * Workflow run options
+ * User-friendly options for running a workflow
+ */
+export interface WorkflowRunOptions {
+    /**
+     * Workflow input variables
+     */
+    variables?: Record<string, any>;
+    /**
+     * Environment variables for workflow execution
+     */
+    env?: Record<string, any>;
+    /**
+     * Secrets (will not be logged)
+     */
+    secrets?: Record<string, any>;
+    /**
+     * Additional execution context
+     */
+    context?: Record<string, any>;
+    /**
+     * Execution timeout in milliseconds
+     */
+    timeout?: number;
+    /**
+     * Continue execution even if steps fail
+     */
+    continueOnError?: boolean;
+    /**
+     * Dry run mode - validate and plan but don't execute
+     */
+    dryRun?: boolean;
+    /**
+     * Who/what triggered this execution
+     */
+    triggeredBy?: string;
+}
+/**
+ * Workflow load options
+ * Options for loading a workflow from file
+ */
+export interface WorkflowLoadOptions {
+    /**
+     * Base directory for resolving relative paths
+     */
+    baseDir?: string;
+    /**
+     * Variables to inject during parsing
+     */
+    variables?: Record<string, any>;
+}
+/**
+ * OrbytEngine - Main public API
+ *
+ * This is the primary interface for working with Orbyt workflows.
+ * Provides a clean, user-friendly API that abstracts internal complexity.
+ *
+ * @example
+ * ```ts
+ * // Basic usage
+ * const engine = new OrbytEngine();
+ * const result = await engine.run('./workflow.yaml');
+ *
+ * // With configuration
+ * const engine = new OrbytEngine({
+ *   logLevel: 'debug',
+ *   maxConcurrentWorkflows: 5,
+ *   adapters: [httpAdapter, shellAdapter],
+ *   hooks: [loggingHook]
+ * });
+ *
+ * // With options
+ * const result = await engine.run('./workflow.yaml', {
+ *   variables: { inputFile: './data.json' },
+ *   timeout: 60000,
+ *   dryRun: false
+ * });
+ * ```
+ */
+export declare class OrbytEngine {
+    private config;
+    private executionEngine;
+    private stepExecutor;
+    private workflowExecutor;
+    private eventBus;
+    private hookManager;
+    private adapterRegistry;
+    private context;
+    private isStarted;
+    constructor(config?: OrbytEngineConfig);
+    /**
+     * Wire engine components together
+     */
+    private setupComponents;
+    /**
+     * Register built-in adapters
+     * These are the core adapters shipped with Orbyt
+     */
+    private registerBuiltinAdapters;
+    /**
+     * Start the engine
+     * Must be called before running workflows if scheduler is enabled
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the engine
+     * Waits for running workflows to complete
+     */
+    stop(): Promise<void>;
+    /**
+     * Run a workflow
+     *
+     * Main method for executing workflows. Accepts either a file path or
+     * a parsed workflow object.
+     *
+     * @param workflow - Workflow file path, YAML string, or parsed workflow
+     * @param options - Execution options
+     * @returns Workflow execution result
+     *
+     * @example
+     * ```ts
+     * // Run from file
+     * const result = await engine.run('./workflow.yaml');
+     *
+     * // Run with options
+     * const result = await engine.run('./workflow.yaml', {
+     *   variables: { input: 'data.json' },
+     *   timeout: 30000
+     * });
+     *
+     * // Run from string
+     * const yaml = `
+     * name: my-workflow
+     * steps:
+     *   - id: step1
+     *     uses: shell.exec
+     *     with:
+     *       command: echo "Hello"
+     * `;
+     * const result = await engine.run(yaml);
+     * ```
+     */
+    run(workflow: string | ParsedWorkflow, options?: WorkflowRunOptions): Promise<WorkflowResult>;
+    /**
+     * Load a workflow from file
+     *
+     * @param filePath - Path to workflow file
+     * @param options - Load options
+     * @returns Parsed workflow
+     */
+    loadWorkflow(filePath: string, options?: WorkflowLoadOptions): Promise<ParsedWorkflow>;
+    /**
+     * Parse a workflow from YAML string
+     *
+     * @param yaml - YAML workflow definition
+     * @returns Parsed workflow
+     */
+    parseWorkflow(yaml: string): ParsedWorkflow;
+    /**
+     * Validate a workflow without executing it
+     *
+     * @param workflow - Workflow to validate
+     * @returns True if valid, throws if invalid
+     */
+    validate(workflow: string | ParsedWorkflow): Promise<boolean>;
+    /**
+     * Perform a dry run of a workflow
+     * Validates and plans execution without running steps
+     */
+    private dryRun;
+    /**
+     * Register an adapter
+     *
+     * @param adapter - Adapter to register
+     */
+    registerAdapter(adapter: Adapter): void;
+    /**
+     * Register multiple adapters
+     *
+     * @param adapters - Array of adapters
+     */
+    registerAdapters(adapters: Adapter[]): void;
+    /**
+     * Register a lifecycle hook
+     *
+     * @param hook - Hook to register
+     */
+    registerHook(hook: LifecycleHook): void;
+    /**
+     * Register multiple hooks
+     *
+     * @param hooks - Array of hooks
+     */
+    registerHooks(hooks: LifecycleHook[]): void;
+    /**
+     * Get the event bus for listening to engine events
+     *
+     * @returns Event bus instance
+     */
+    getEventBus(): EventBus;
+    /**
+     * Get the engine context
+     *
+     * @returns Engine context
+     */
+    getContext(): EngineContext;
+    /**
+     * Get engine configuration
+     *
+     * @returns Engine configuration
+     */
+    getConfig(): OrbytEngineConfig;
+    /**
+     * Internal logging method
+     */
+    private log;
+}
+//# sourceMappingURL=OrbytEngine.d.ts.map

package/dist/core/OrbytEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrbytEngine.d.ts","sourceRoot":"","sources":["../../src/core/OrbytEngine.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,OAAO,KAAK,EAAE,iBAAiB,EAAY,MAAM,mBAAmB,CAAC;AAErE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAKxD,OAAO,EAAkB,KAAK,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClF,OAAO,KAAK,EAAE,cAAc,EAAoB,MAAM,kCAAkC,CAAC;AACzF,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAGjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAIhE;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEhC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAyC;IACvD,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,gBAAgB,CAAmB;IAC3C,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,SAAS,CAAkB;gBAEvB,MAAM,GAAE,iBAAsB;IA0D1C;;OAEG;IACH,OAAO,CAAC,eAAe;IAgBvB;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAU/B;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB5B;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,GAAG,CACP,QAAQ,EAAE,MAAM,GAAG,cAAc,EACjC,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,cAAc,CAAC;IAiD1B;;;;;;OAMG;IACG,YAAY,CAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,cAAc,CAAC;IAkB1B;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc;IAgB3C;;;;;OAKG;IACG,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAoBnE;;;OAGG;YACW,MAAM;IAsCpB;;;;OAIG;IACH,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAMvC;;;;OAIG;IACH,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI;IAM3C;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;IAKvC;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,aAAa,EAAE,GAAG,IAAI;IAK3C;;;;OAIG;IACH,WAAW,IAAI,QAAQ;IAIvB;;;;OAIG;IACH,UAAU,IAAI,aAAa;IAI3B;;;;OAIG;IACH,SAAS,IAAI,iBAAiB;IAI9B;;OAEG;IACH,OAAO,CAAC,GAAG;CAkBZ"}