@computekit/react 0.1.2 → 0.1.3

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import React, { ReactNode } from 'react';
-import { ComputeKitOptions, ComputeKit, ComputeProgress, ComputeOptions, PoolStats } from '@computekit/core';
+import { ComputeOptions, ComputeKitOptions, ComputeKit, ComputeProgress, PoolStats } from '@computekit/core';
 export { ComputeKit, ComputeKitOptions, ComputeOptions, ComputeProgress, PoolStats } from '@computekit/core';
 
 /**
@@ -7,6 +7,154 @@ export { ComputeKit, ComputeKitOptions, ComputeOptions, ComputeProgress, PoolSta
  * React hooks and utilities for ComputeKit
  */
 
+/** Status of a pipeline stage */
+type StageStatus = 'pending' | 'running' | 'completed' | 'failed' | 'skipped';
+/** Detailed information about a single pipeline stage */
+interface StageInfo<TInput = unknown, TOutput = unknown> {
+    /** Unique identifier for the stage */
+    id: string;
+    /** Display name for the stage */
+    name: string;
+    /** Name of the registered compute function to execute */
+    functionName: string;
+    /** Current status of this stage */
+    status: StageStatus;
+    /** Input data for this stage (set when stage starts) */
+    input?: TInput;
+    /** Output data from this stage (set when stage completes) */
+    output?: TOutput;
+    /** Error if stage failed */
+    error?: Error;
+    /** Start timestamp (ms since epoch) */
+    startedAt?: number;
+    /** End timestamp (ms since epoch) */
+    completedAt?: number;
+    /** Duration in milliseconds */
+    duration?: number;
+    /** Progress within this stage (0-100) */
+    progress?: number;
+    /** Number of retry attempts */
+    retryCount: number;
+    /** Compute options specific to this stage */
+    options?: ComputeOptions;
+}
+/** Configuration for a pipeline stage */
+interface StageConfig<TInput = unknown, TOutput = unknown> {
+    /** Unique identifier for the stage */
+    id: string;
+    /** Display name for the stage */
+    name: string;
+    /** Name of the registered compute function */
+    functionName: string;
+    /** Transform input before passing to compute function */
+    transformInput?: (input: TInput, previousResults: unknown[]) => unknown;
+    /** Transform output after compute function returns */
+    transformOutput?: (output: unknown) => TOutput;
+    /** Whether to skip this stage based on previous results */
+    shouldSkip?: (input: TInput, previousResults: unknown[]) => boolean;
+    /** Maximum retry attempts on failure (default: 0) */
+    maxRetries?: number;
+    /** Delay between retries in ms (default: 1000) */
+    retryDelay?: number;
+    /** Compute options for this stage */
+    options?: ComputeOptions;
+}
+/** Overall pipeline status */
+type PipelineStatus = 'idle' | 'running' | 'paused' | 'completed' | 'failed' | 'cancelled';
+/** Metrics for pipeline debugging and reporting */
+interface PipelineMetrics {
+    /** Total stages in pipeline */
+    totalStages: number;
+    /** Number of completed stages */
+    completedStages: number;
+    /** Number of failed stages */
+    failedStages: number;
+    /** Number of skipped stages */
+    skippedStages: number;
+    /** Total retry attempts across all stages */
+    totalRetries: number;
+    /** Slowest stage info */
+    slowestStage: {
+        id: string;
+        name: string;
+        duration: number;
+    } | null;
+    /** Fastest stage info */
+    fastestStage: {
+        id: string;
+        name: string;
+        duration: number;
+    } | null;
+    /** Average stage duration */
+    averageStageDuration: number;
+    /** Timestamp of each stage transition for timeline view */
+    timeline: Array<{
+        stageId: string;
+        stageName: string;
+        event: 'started' | 'completed' | 'failed' | 'skipped' | 'retry';
+        timestamp: number;
+        duration?: number;
+        error?: string;
+    }>;
+}
+/** Comprehensive pipeline state for debugging */
+interface PipelineState<TInput = unknown, TOutput = unknown> {
+    /** Overall pipeline status */
+    status: PipelineStatus;
+    /** All stage information */
+    stages: StageInfo[];
+    /** Index of currently executing stage (-1 if not running) */
+    currentStageIndex: number;
+    /** Current stage info (convenience) */
+    currentStage: StageInfo | null;
+    /** Overall progress percentage (0-100) */
+    progress: number;
+    /** Final output from the last stage */
+    output: TOutput | null;
+    /** Initial input that started the pipeline */
+    input: TInput | null;
+    /** Error that caused pipeline failure */
+    error: Error | null;
+    /** Pipeline start timestamp */
+    startedAt: number | null;
+    /** Pipeline completion timestamp */
+    completedAt: number | null;
+    /** Total duration in milliseconds */
+    totalDuration: number | null;
+    /** Results from each completed stage */
+    stageResults: unknown[];
+    /** Execution metrics for debugging */
+    metrics: PipelineMetrics;
+}
+/** Result of a single item in parallel batch */
+interface BatchItemResult<TOutput = unknown> {
+    /** Index of the item in original array */
+    index: number;
+    /** Whether this item succeeded */
+    success: boolean;
+    /** Result if successful */
+    data?: TOutput;
+    /** Error if failed */
+    error?: Error;
+    /** Duration in ms */
+    duration: number;
+}
+/** Aggregate result of parallel batch processing */
+interface ParallelBatchResult<TOutput = unknown> {
+    /** All individual results */
+    results: BatchItemResult<TOutput>[];
+    /** Successfully processed items */
+    successful: TOutput[];
+    /** Failed items with their errors */
+    failed: Array<{
+        index: number;
+        error: Error;
+    }>;
+    /** Total duration */
+    totalDuration: number;
+    /** Success rate (0-1) */
+    successRate: number;
+}
 /**
  * Props for ComputeKitProvider
  */
@@ -167,5 +315,196 @@ declare function usePoolStats(refreshInterval?: number): PoolStats;
  * Hook to check WASM support
  */
 declare function useWasmSupport(): boolean;
+/**
+ * Options for usePipeline hook
+ */
+interface UsePipelineOptions {
+    /** Stop pipeline on first stage failure (default: true) */
+    stopOnError?: boolean;
+    /** Global timeout for entire pipeline in ms */
+    timeout?: number;
+    /** Enable detailed timeline tracking (default: true) */
+    trackTimeline?: boolean;
+    /** Called when pipeline state changes */
+    onStateChange?: (state: PipelineState) => void;
+    /** Called when a stage starts */
+    onStageStart?: (stage: StageInfo) => void;
+    /** Called when a stage completes */
+    onStageComplete?: (stage: StageInfo) => void;
+    /** Called when a stage fails */
+    onStageError?: (stage: StageInfo, error: Error) => void;
+    /** Called when a stage is retried */
+    onStageRetry?: (stage: StageInfo, attempt: number) => void;
+    /** Automatically run pipeline on mount */
+    autoRun?: boolean;
+    /** Initial input for autoRun */
+    initialInput?: unknown;
+}
+/**
+ * Actions returned by usePipeline
+ */
+interface UsePipelineActions<TInput> {
+    /** Start the pipeline with input */
+    run: (input: TInput) => Promise<void>;
+    /** Cancel the running pipeline */
+    cancel: () => void;
+    /** Reset pipeline to initial state */
+    reset: () => void;
+    /** Pause the pipeline (if supported) */
+    pause: () => void;
+    /** Resume a paused pipeline */
+    resume: () => void;
+    /** Retry failed stages */
+    retry: () => Promise<void>;
+    /** Get a formatted report of the pipeline execution */
+    getReport: () => PipelineReport;
+}
+/**
+ * Formatted report for debugging
+ */
+interface PipelineReport {
+    /** Human-readable summary */
+    summary: string;
+    /** Detailed stage-by-stage breakdown */
+    stageDetails: Array<{
+        name: string;
+        status: StageStatus;
+        duration: string;
+        error?: string;
+    }>;
+    /** Timeline of events */
+    timeline: string[];
+    /** Performance insights */
+    insights: string[];
+    /** Raw metrics */
+    metrics: PipelineMetrics;
+}
+/**
+ * Return type for usePipeline
+ */
+type UsePipelineReturn<TInput, TOutput> = PipelineState<TInput, TOutput> & UsePipelineActions<TInput> & {
+    /** Whether pipeline is currently running */
+    isRunning: boolean;
+    /** Whether pipeline completed successfully */
+    isComplete: boolean;
+    /** Whether pipeline has failed */
+    isFailed: boolean;
+    /** Quick access to check if a specific stage is done */
+    isStageComplete: (stageId: string) => boolean;
+    /** Get a specific stage by ID */
+    getStage: (stageId: string) => StageInfo | undefined;
+};
+/**
+ * Hook for multi-stage pipeline processing
+ *
+ * Provides comprehensive debugging, progress tracking, and error handling
+ * for complex multi-stage compute workflows.
+ *
+ * @example
+ * ```tsx
+ * function FileProcessor() {
+ *   const pipeline = usePipeline<string[], ProcessedFiles>([
+ *     { id: 'download', name: 'Download Files', functionName: 'downloadFiles' },
+ *     { id: 'process', name: 'Process Files', functionName: 'processFiles' },
+ *     { id: 'compress', name: 'Compress Output', functionName: 'compressFiles' },
+ *   ]);
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={() => pipeline.run(urls)} disabled={pipeline.isRunning}>
+ *         Start Processing
+ *       </button>
+ *
+ *       <div>Status: {pipeline.status}</div>
+ *       <div>Progress: {pipeline.progress.toFixed(0)}%</div>
+ *
+ *       {pipeline.currentStage && (
+ *         <div>Current: {pipeline.currentStage.name}</div>
+ *       )}
+ *
+ *       {pipeline.stages.map(stage => (
+ *         <div key={stage.id}>
+ *           {stage.name}: {stage.status}
+ *           {stage.duration && ` (${stage.duration}ms)`}
+ *         </div>
+ *       ))}
+ *
+ *       {pipeline.isFailed && (
+ *         <button onClick={pipeline.retry}>Retry Failed</button>
+ *       )}
+ *
+ *       {pipeline.isComplete && (
+ *         <pre>{JSON.stringify(pipeline.getReport(), null, 2)}</pre>
+ *       )}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function usePipeline<TInput = unknown, TOutput = unknown>(stageConfigs: StageConfig[], options?: UsePipelineOptions): UsePipelineReturn<TInput, TOutput>;
+/**
+ * Result type for useParallelBatch
+ */
+interface UseParallelBatchReturn<TItem, TOutput> {
+    /** Execute batch processing */
+    run: (items: TItem[]) => Promise<ParallelBatchResult<TOutput>>;
+    /** Current batch result */
+    result: ParallelBatchResult<TOutput> | null;
+    /** Loading state */
+    loading: boolean;
+    /** Current progress (0-100) */
+    progress: number;
+    /** Number of completed items */
+    completedCount: number;
+    /** Total items in current batch */
+    totalCount: number;
+    /** Cancel batch processing */
+    cancel: () => void;
+    /** Reset state */
+    reset: () => void;
+}
+/**
+ * Hook for parallel batch processing
+ *
+ * Useful for processing multiple items in parallel within a pipeline stage.
+ *
+ * @example
+ * ```tsx
+ * function BatchProcessor() {
+ *   const batch = useParallelBatch<string, ProcessedFile>('processFile', {
+ *     concurrency: 4
+ *   });
+ *
+ *   return (
+ *     <div>
+ *       <button
+ *         onClick={() => batch.run(fileUrls)}
+ *         disabled={batch.loading}
+ *       >
+ *         Process {fileUrls.length} Files
+ *       </button>
+ *
+ *       {batch.loading && (
+ *         <div>
+ *           Processing: {batch.completedCount}/{batch.totalCount}
+ *           ({batch.progress.toFixed(0)}%)
+ *         </div>
+ *       )}
+ *
+ *       {batch.result && (
+ *         <div>
+ *           Success: {batch.result.successful.length}
+ *           Failed: {batch.result.failed.length}
+ *         </div>
+ *       )}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useParallelBatch<TItem = unknown, TOutput = unknown>(functionName: string, options?: {
+    concurrency?: number;
+    computeOptions?: ComputeOptions;
+}): UseParallelBatchReturn<TItem, TOutput>;
 
-export { ComputeKitProvider, type ComputeKitProviderProps, type ComputeStatus, type UseComputeActions, type UseComputeOptions, type UseComputeReturn, type UseComputeState, useCompute, useComputeCallback, useComputeFunction, useComputeKit, usePoolStats, useWasmSupport };
+export { type BatchItemResult, ComputeKitProvider, type ComputeKitProviderProps, type ComputeStatus, type ParallelBatchResult, type PipelineMetrics, type PipelineReport, type PipelineState, type PipelineStatus, type StageConfig, type StageInfo, type StageStatus, type UseComputeActions, type UseComputeOptions, type UseComputeReturn, type UseComputeState, type UseParallelBatchReturn, type UsePipelineActions, type UsePipelineOptions, type UsePipelineReturn, useCompute, useComputeCallback, useComputeFunction, useComputeKit, useParallelBatch, usePipeline, usePoolStats, useWasmSupport };