@weavelogic/knowledge-graph-agent 0.3.0 → 0.4.0

package/dist/workflow/services/workflow-service.d.ts

@@ -0,0 +1,318 @@
+/**
+ * Workflow Service
+ *
+ * Main service that orchestrates workflow execution with
+ * Workflow DevKit, GOAP planning, and webhook handling.
+ *
+ * This service provides a unified interface for:
+ * - Starting and managing workflows
+ * - GOAP-based planning for task generation
+ * - File watching and webhook handling
+ * - Status monitoring and metrics
+ *
+ * @module workflow/services/workflow-service
+ *
+ * @example
+ * ```typescript
+ * import { createWorkflowService } from './workflow-service.js';
+ *
+ * const service = createWorkflowService({
+ *   inactivityTimeout: 5 * 60 * 1000,
+ *   autoStartThreshold: 0.7,
+ *   watchPaths: ['./docs'],
+ * });
+ *
+ * await service.start();
+ *
+ * // Start a collaboration workflow
+ * const result = await service.startCollaborationWorkflow(
+ *   'graph-123',
+ *   './docs/spec.md'
+ * );
+ *
+ * // Get service status
+ * const status = service.getStatus();
+ * console.log(`Active workflows: ${status.activeWorkflows.length}`);
+ *
+ * await service.stop();
+ * ```
+ */
+import { type WorkflowConfig } from '../config.js';
+import type { GOAPPlan, TaskSpec, GapAnalysis, WorkflowRunMetadata, ReadinessEvaluation } from '../types.js';
+import { GOAPAdapter } from '../adapters/goap-adapter.js';
+import { type WebhookRegistry, type WorkflowTriggerEvent } from '../handlers/webhook-handlers.js';
+/**
+ * Workflow service configuration options
+ */
+export interface WorkflowServiceConfig {
+    /** Workflow DevKit configuration */
+    workflow?: WorkflowConfig;
+    /** Inactivity timeout in ms (default: 5 minutes) */
+    inactivityTimeout?: number;
+    /** Auto-start development threshold (default: 0.7) */
+    autoStartThreshold?: number;
+    /** Paths to watch for changes */
+    watchPaths?: string[];
+    /** Enable debug logging */
+    debug?: boolean;
+    /** Webhook secret for validation */
+    webhookSecret?: string;
+    /** Maximum payload size for webhooks */
+    maxPayloadSize?: number;
+}
+/**
+ * Workflow execution result
+ */
+export interface WorkflowExecutionResult {
+    /** Whether workflow completed successfully */
+    success: boolean;
+    /** Unique workflow run identifier */
+    workflowId: string;
+    /** When the workflow started */
+    startedAt: Date;
+    /** When the workflow completed (if finished) */
+    completedAt?: Date;
+    /** Outcome of the workflow */
+    outcome?: 'completed' | 'failed' | 'timeout' | 'cancelled';
+    /** Artifacts produced by the workflow */
+    artifacts?: string[];
+    /** Error message if failed */
+    error?: string;
+}
+/**
+ * Service status information
+ */
+export interface WorkflowServiceStatus {
+    /** Whether the service is currently running */
+    isRunning: boolean;
+    /** List of active workflow runs */
+    activeWorkflows: WorkflowRunMetadata[];
+    /** Paths being watched for changes */
+    watchedPaths: string[];
+    /** Timestamp of last activity */
+    lastActivity?: Date;
+    /** Execution statistics */
+    stats: WorkflowExecutionStats;
+}
+/**
+ * Execution statistics
+ */
+export interface WorkflowExecutionStats {
+    /** Total number of workflow executions */
+    totalExecutions: number;
+    /** Number of successful executions */
+    successfulExecutions: number;
+    /** Number of failed executions */
+    failedExecutions: number;
+    /** Average execution duration in ms */
+    averageDuration: number;
+}
+/**
+ * Workflow Service
+ *
+ * Orchestrates the entire workflow system including:
+ * - GOAP planning for intelligent task generation
+ * - File watching for automatic workflow triggers
+ * - Webhook handling for external integrations
+ * - Execution tracking and metrics collection
+ */
+export declare class WorkflowService {
+    private config;
+    private goapAdapter;
+    private webhookRegistry;
+    private fileWatcher;
+    private isRunning;
+    private activeWorkflows;
+    private lastActivity?;
+    private executionStats;
+    /**
+     * Create a new workflow service
+     *
+     * @param config - Service configuration options
+     */
+    constructor(config?: WorkflowServiceConfig);
+    /**
+     * Resolve configuration with defaults
+     */
+    private resolveConfig;
+    /**
+     * Setup event handlers for workflow triggers
+     */
+    private setupEventHandlers;
+    /**
+     * Start the workflow service
+     *
+     * Begins watching configured paths and processing events.
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the workflow service
+     *
+     * Stops watching all paths and cleans up resources.
+     */
+    stop(): Promise<void>;
+    /**
+     * Handle document change event
+     *
+     * Analyzes the changed document for gaps and potentially
+     * starts development if completeness threshold is met.
+     */
+    private onDocumentChange;
+    /**
+     * Handle inactivity timeout
+     *
+     * Checks for incomplete documentation and generates
+     * missing content when idle.
+     */
+    private onInactivityTimeout;
+    /**
+     * Start a collaboration workflow for a graph/document
+     *
+     * @param graphId - Knowledge graph identifier
+     * @param docPath - Path to the document
+     * @returns Workflow execution result
+     */
+    startCollaborationWorkflow(graphId: string, docPath: string): Promise<WorkflowExecutionResult>;
+    /**
+     * Initialize world state from a document
+     *
+     * @param docPath - Path to the document
+     * @returns Initial world state for planning
+     */
+    private initializeWorldState;
+    /**
+     * Create a GOAP plan for a goal
+     *
+     * @param goal - Goal identifier
+     * @returns Generated plan
+     */
+    createPlan(goal: string): Promise<GOAPPlan>;
+    /**
+     * Evaluate readiness for development
+     *
+     * @param docPath - Path to the document
+     * @returns Readiness evaluation
+     */
+    evaluateReadiness(docPath: string): Promise<ReadinessEvaluation>;
+    /**
+     * Analyze document for gaps
+     *
+     * @param docPath - Path to analyze
+     * @returns Gap analysis result
+     */
+    analyzeGaps(docPath: string): Promise<GapAnalysis>;
+    /**
+     * Generate task specification from documentation
+     *
+     * @param docPath - Path to the source document
+     * @param analysis - Gap analysis results
+     * @returns Generated task specification
+     */
+    generateTaskSpec(docPath: string, analysis: GapAnalysis): Promise<TaskSpec>;
+    /**
+     * Generate missing documentation
+     *
+     * @param docPath - Path to the document
+     * @param analysis - Gap analysis results
+     * @returns List of generated content
+     */
+    generateMissingDocs(docPath: string, analysis: GapAnalysis): Promise<string[]>;
+    /**
+     * Generate a unique workflow ID
+     */
+    private generateWorkflowId;
+    /**
+     * Extract filename from path
+     */
+    private extractFilename;
+    /**
+     * Determine priority based on completeness
+     */
+    private determinePriority;
+    /**
+     * Estimate complexity from analysis
+     */
+    private estimateComplexity;
+    /**
+     * Extract requirements from analysis
+     */
+    private extractRequirements;
+    /**
+     * Generate acceptance criteria from analysis
+     */
+    private generateAcceptanceCriteria;
+    /**
+     * Add a path to watch
+     *
+     * @param path - Path to watch for changes
+     */
+    watch(path: string): void;
+    /**
+     * Stop watching a path
+     *
+     * @param path - Path to stop watching
+     */
+    unwatch(path: string): void;
+    /**
+     * Get the webhook registry for external event handling
+     *
+     * @returns Webhook registry instance
+     */
+    getWebhookRegistry(): WebhookRegistry;
+    /**
+     * Get the GOAP adapter for direct planning access
+     *
+     * @returns GOAP adapter instance
+     */
+    getGOAPAdapter(): GOAPAdapter;
+    /**
+     * Emit a workflow trigger event
+     *
+     * @param event - Event to emit
+     */
+    emitEvent(event: WorkflowTriggerEvent): Promise<void>;
+    /**
+     * Get service status
+     *
+     * @returns Current service status
+     */
+    getStatus(): WorkflowServiceStatus;
+    /**
+     * Get workflow configuration
+     *
+     * @returns Copy of the current configuration
+     */
+    getConfig(): WorkflowServiceConfig;
+    /**
+     * Get a specific workflow run by ID
+     *
+     * @param workflowId - Workflow run identifier
+     * @returns Workflow metadata or undefined
+     */
+    getWorkflow(workflowId: string): WorkflowRunMetadata | undefined;
+    /**
+     * Cancel a running workflow
+     *
+     * @param workflowId - Workflow to cancel
+     * @returns Whether the workflow was cancelled
+     */
+    cancelWorkflow(workflowId: string): boolean;
+}
+/**
+ * Create a workflow service instance
+ *
+ * @param config - Service configuration options
+ * @returns Configured workflow service
+ *
+ * @example
+ * ```typescript
+ * const service = createWorkflowService({
+ *   watchPaths: ['./docs', './specs'],
+ *   autoStartThreshold: 0.8,
+ * });
+ *
+ * await service.start();
+ * ```
+ */
+export declare function createWorkflowService(config?: WorkflowServiceConfig): WorkflowService;
+//# sourceMappingURL=workflow-service.d.ts.map

package/dist/workflow/services/workflow-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-service.d.ts","sourceRoot":"","sources":["../../../src/workflow/services/workflow-service.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AAEH,OAAO,EAAwB,KAAK,cAAc,EAAE,MAAM,cAAc,CAAC;AACzE,OAAO,KAAK,EAEV,QAAQ,EACR,QAAQ,EACR,WAAW,EAEX,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAqB,MAAM,6BAA6B,CAAC;AAC7E,OAAO,EAGL,KAAK,eAAe,EAEpB,KAAK,oBAAoB,EAC1B,MAAM,iCAAiC,CAAC;AASzC;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,oCAAoC;IACpC,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sDAAsD;IACtD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,oCAAoC;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wCAAwC;IACxC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAmBD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,8CAA8C;IAC9C,OAAO,EAAE,OAAO,CAAC;IACjB,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,gCAAgC;IAChC,SAAS,EAAE,IAAI,CAAC;IAChB,gDAAgD;IAChD,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,8BAA8B;IAC9B,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;IAC3D,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,8BAA8B;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,+CAA+C;IAC/C,SAAS,EAAE,OAAO,CAAC;IACnB,mCAAmC;IACnC,eAAe,EAAE,mBAAmB,EAAE,CAAC;IACvC,sCAAsC;IACtC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,iCAAiC;IACjC,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,2BAA2B;IAC3B,KAAK,EAAE,sBAAsB,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,0CAA0C;IAC1C,eAAe,EAAE,MAAM,CAAC;IACxB,sCAAsC;IACtC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,kCAAkC;IAClC,gBAAgB,EAAE,MAAM,CAAC;IACzB,uCAAuC;IACvC,eAAe,EAAE,MAAM,CAAC;CACzB;AAMD;;;;;;;;GAQG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,WAAW,CAAyB;IAE5C,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,eAAe,CAA+C;IACtE,OAAO,CAAC,YAAY,CAAC,CAAO;IAC5B,OAAO,CAAC,cAAc,CAKpB;IAEF;;;;OAIG;gBACS,MAAM,GAAE,qBAA0B;IAc9C;;OAEG;IACH,OAAO,CAAC,aAAa;IAYrB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA2C1B;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAsB5B;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAsB3B;;;;;OAKG;YACW,gBAAgB;IA4B9B;;;;;OAKG;YACW,mBAAmB;IA6BjC;;;;;;OAMG;IACG,0BAA0B,CAC9B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,uBAAuB,CAAC;IAgGnC;;;;;OAKG;YACW,oBAAoB;IAiBlC;;;;;OAKG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAKjD;;;;;OAKG;IACG,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAgBtE;;;;;OAKG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAuCxD;;;;;;OAMG;IACG,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAwBjF;;;;;;OAMG;IACG,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAsBpF;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAM1B;;OAEG;IACH,OAAO,CAAC,eAAe;IAKvB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IASzB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAQ1B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAQ3B;;OAEG;IACH,OAAO,CAAC,0BAA0B;IAkBlC;;;;OAIG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAMzB;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAS3B;;;;OAIG;IACH,kBAAkB,IAAI,eAAe;IAIrC;;;;OAIG;IACH,cAAc,IAAI,WAAW;IAI7B;;;;OAIG;IACG,SAAS,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAK3D;;;;OAIG;IACH,SAAS,IAAI,qBAAqB;IAoBlC;;;;OAIG;IACH,SAAS,IAAI,qBAAqB;IAUlC;;;;;OAKG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS;IAIhE;;;;;OAKG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;CAU5C;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,eAAe,CAErF"}