@orbytautomation/engine 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,67 @@
+# @orbytautomation/engine
+
+Universal workflow automation engine for executing YAML-based workflows with an adapter-driven architecture.
+
+## Installation
+
+```bash
+npm install @orbytautomation/engine
+```
+
+## Quick Start
+
+```typescript
+import { OrbytEngine } from '@orbytautomation/engine';
+
+// Create engine instance
+const engine = new OrbytEngine();
+
+// Run a workflow
+const result = await engine.run('./workflow.yaml');
+
+console.log('Workflow completed:', result.status);
+```
+
+## Features
+
+- 🚀 **YAML Workflow Definitions** - Define workflows in human-readable YAML
+- 🔌 **Universal Adapter System** - Extensible adapter framework for any action type
+- 📊 **DAG Execution** - Automatic dependency resolution with parallel execution
+- 🔄 **Retry Logic** - Configurable retry strategies (fixed, linear, exponential backoff)
+- ⏱️ **Timeout Management** - Step and workflow-level timeout enforcement
+- 🪝 **Lifecycle Hooks** - User-defined hooks at workflow and step events
+- 📡 **Event Bus** - Internal pub/sub system for observability
+- 🧩 **Context Engine** - Variable interpolation and runtime context
+- 🧪 **Dry-run Mode** - Validate and plan without execution
+
+## Basic Usage
+
+### Simple Workflow Execution
+
+```typescript
+import { OrbytEngine } from '@orbytautomation/engine';
+
+const engine = new OrbytEngine({
+  logLevel: 'info',
+  maxConcurrentWorkflows: 5
+});
+
+const result = await engine.run('./workflow.yaml', {
+  variables: {
+    inputFile: './data.json',
+    outputDir: './output'
+  }
+});
+
+if (result.status === 'success') {
+  console.log('✓ Workflow completed successfully');
+} else {
+  console.error('✗ Workflow failed:', result.error);
+}
+```
+
+## Links
+
+- [GitHub Repository](https://github.com/0xshariq/orbyt)
+- [Documentation](https://github.com/0xshariq/orbyt#readme)
+- [Issues](https://github.com/0xshariq/orbyt/issues)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orbytautomation/engine",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Orbyt - Automation Engine Framework",
   "type": "module",
   "main": "./dist/index.js",
@@ -16,7 +16,11 @@
     "clean": "rm -rf dist"
   },
   "keywords": [
-    "automation", "cron", "scheduler", "engine", "automation-engine"
+    "automation",
+    "cron",
+    "scheduler",
+    "engine",
+    "automation-engine"
   ],
   "author": {
     "name": "0xshariq",