@wave-av/workflow-sdk 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,173 @@
+import { RetryPolicy, WorkflowPhase, WorkflowConfig, WorkflowDefinition } from './types.mjs';
+export { AnyWorkflowEvent, ExecuteWorkflowRequest, ExecuteWorkflowRequestSchema, ExecuteWorkflowResponse, ExecutionCompletedEvent, ExecutionFailedEvent, ExecutionLog, ExecutionStartedEvent, ExecutionStatus, ListExecutionsRequest, ListExecutionsResponse, PhaseCompletedEvent, PhaseCondition, PhaseExecutionStatus, PhaseStartedEvent, WorkflowAgent, WorkflowAgentSchema, WorkflowConfigSchema, WorkflowDefinitionSchema, WorkflowEvent, WorkflowExecution, WorkflowPhaseSchema } from './types.mjs';
+export { WaveWorkflowClient, WaveWorkflowClientConfig, WorkflowClientEvents, createClient } from './client.mjs';
+import 'zod';
+import 'eventemitter3';
+
+/**
+ * WAVE Workflow Builder
+ *
+ * Fluent builder API for creating workflow definitions.
+ */
+
+/**
+ * Workflow Builder
+ *
+ * @example
+ * ```typescript
+ * const workflow = new WorkflowBuilder('my-workflow')
+ *   .name('My Workflow')
+ *   .description('Processes data through multiple stages')
+ *   .category('data-processing')
+ *   .version('1.0.0')
+ *   .phase('extract', (phase) =>
+ *     phase
+ *       .description('Extract data from source')
+ *       .agent('data-extractor', { source: 'api' })
+ *   )
+ *   .phase('transform', (phase) =>
+ *     phase
+ *       .description('Transform data')
+ *       .agent('data-transformer')
+ *   )
+ *   .phase('load', (phase) =>
+ *     phase
+ *       .description('Load data to destination')
+ *       .agent('data-loader', { destination: 'database' })
+ *   )
+ *   .config({
+ *     timeout_seconds: 3600,
+ *     checkpoint_enabled: true,
+ *   })
+ *   .build();
+ * ```
+ */
+declare class WorkflowBuilder {
+    private definition;
+    constructor(slug: string);
+    /**
+     * Set the workflow name
+     */
+    name(name: string): this;
+    /**
+     * Set the workflow description
+     */
+    description(description: string): this;
+    /**
+     * Set the workflow category
+     */
+    category(category: string): this;
+    /**
+     * Set the workflow version
+     */
+    version(version: string): this;
+    /**
+     * Add tags to the workflow
+     */
+    tags(...tags: string[]): this;
+    /**
+     * Add a phase to the workflow
+     */
+    phase(name: string, builder: (phase: PhaseBuilder) => PhaseBuilder): this;
+    /**
+     * Set workflow configuration
+     */
+    config(config: WorkflowConfig): this;
+    /**
+     * Set timeout in seconds
+     */
+    timeout(seconds: number): this;
+    /**
+     * Enable checkpointing
+     */
+    enableCheckpoints(): this;
+    /**
+     * Set max retries
+     */
+    maxRetries(retries: number): this;
+    /**
+     * Build and validate the workflow definition
+     */
+    build(): Omit<WorkflowDefinition, 'id' | 'organization_id' | 'created_by' | 'status' | 'created_at' | 'updated_at'>;
+    /**
+     * Export as JSON
+     */
+    toJSON(): string;
+}
+/**
+ * Phase Builder
+ */
+declare class PhaseBuilder {
+    private phase;
+    constructor(name: string, order: number);
+    /**
+     * Set phase description
+     */
+    description(description: string): this;
+    /**
+     * Add an agent to the phase
+     */
+    agent(type: string, config?: Record<string, unknown>): this;
+    /**
+     * Add an agent with full configuration
+     */
+    agentWithRetry(type: string, config: Record<string, unknown>, retryPolicy: RetryPolicy): this;
+    /**
+     * Set conditional execution based on expression
+     */
+    runIf(expression: string): this;
+    /**
+     * Set conditional execution based on previous phase status
+     */
+    runAfter(status: 'completed' | 'skipped'): this;
+    /**
+     * Set failure behavior
+     */
+    onFailure(behavior: 'fail' | 'skip' | 'retry'): this;
+    /**
+     * Build the phase
+     */
+    build(): WorkflowPhase;
+}
+
+/**
+ * WAVE Workflow SDK
+ *
+ * Official SDK for building and executing workflows on the WAVE platform.
+ *
+ * @packageDocumentation
+ * @module @wave/workflow-sdk
+ *
+ * @example
+ * ```typescript
+ * import { WaveWorkflowClient } from '@wave/workflow-sdk';
+ *
+ * const client = new WaveWorkflowClient({
+ *   apiKey: process.env.WAVE_API_KEY!,
+ *   organizationId: 'org_123',
+ * });
+ *
+ * // Execute a workflow
+ * const execution = await client.execute('my-workflow', {
+ *   input_params: { environment: 'production' },
+ * });
+ *
+ * // Wait for completion
+ * const result = await client.waitForCompletion(execution.id, {
+ *   onProgress: (exec) => console.log(`Status: ${exec.status}`),
+ * });
+ *
+ * console.log('Output:', result.output);
+ * ```
+ */
+
+/**
+ * SDK version
+ */
+declare const VERSION = "1.0.0";
+/**
+ * Default API base URL
+ */
+declare const DEFAULT_API_URL = "https://api.wave.online";
+
+export { DEFAULT_API_URL, RetryPolicy, VERSION, WorkflowBuilder, WorkflowConfig, WorkflowDefinition, WorkflowPhase };

package/dist/index.d.ts

@@ -0,0 +1,173 @@
+import { RetryPolicy, WorkflowPhase, WorkflowConfig, WorkflowDefinition } from './types.js';
+export { AnyWorkflowEvent, ExecuteWorkflowRequest, ExecuteWorkflowRequestSchema, ExecuteWorkflowResponse, ExecutionCompletedEvent, ExecutionFailedEvent, ExecutionLog, ExecutionStartedEvent, ExecutionStatus, ListExecutionsRequest, ListExecutionsResponse, PhaseCompletedEvent, PhaseCondition, PhaseExecutionStatus, PhaseStartedEvent, WorkflowAgent, WorkflowAgentSchema, WorkflowConfigSchema, WorkflowDefinitionSchema, WorkflowEvent, WorkflowExecution, WorkflowPhaseSchema } from './types.js';
+export { WaveWorkflowClient, WaveWorkflowClientConfig, WorkflowClientEvents, createClient } from './client.js';
+import 'zod';
+import 'eventemitter3';
+
+/**
+ * WAVE Workflow Builder
+ *
+ * Fluent builder API for creating workflow definitions.
+ */
+
+/**
+ * Workflow Builder
+ *
+ * @example
+ * ```typescript
+ * const workflow = new WorkflowBuilder('my-workflow')
+ *   .name('My Workflow')
+ *   .description('Processes data through multiple stages')
+ *   .category('data-processing')
+ *   .version('1.0.0')
+ *   .phase('extract', (phase) =>
+ *     phase
+ *       .description('Extract data from source')
+ *       .agent('data-extractor', { source: 'api' })
+ *   )
+ *   .phase('transform', (phase) =>
+ *     phase
+ *       .description('Transform data')
+ *       .agent('data-transformer')
+ *   )
+ *   .phase('load', (phase) =>
+ *     phase
+ *       .description('Load data to destination')
+ *       .agent('data-loader', { destination: 'database' })
+ *   )
+ *   .config({
+ *     timeout_seconds: 3600,
+ *     checkpoint_enabled: true,
+ *   })
+ *   .build();
+ * ```
+ */
+declare class WorkflowBuilder {
+    private definition;
+    constructor(slug: string);
+    /**
+     * Set the workflow name
+     */
+    name(name: string): this;
+    /**
+     * Set the workflow description
+     */
+    description(description: string): this;
+    /**
+     * Set the workflow category
+     */
+    category(category: string): this;
+    /**
+     * Set the workflow version
+     */
+    version(version: string): this;
+    /**
+     * Add tags to the workflow
+     */
+    tags(...tags: string[]): this;
+    /**
+     * Add a phase to the workflow
+     */
+    phase(name: string, builder: (phase: PhaseBuilder) => PhaseBuilder): this;
+    /**
+     * Set workflow configuration
+     */
+    config(config: WorkflowConfig): this;
+    /**
+     * Set timeout in seconds
+     */
+    timeout(seconds: number): this;
+    /**
+     * Enable checkpointing
+     */
+    enableCheckpoints(): this;
+    /**
+     * Set max retries
+     */
+    maxRetries(retries: number): this;
+    /**
+     * Build and validate the workflow definition
+     */
+    build(): Omit<WorkflowDefinition, 'id' | 'organization_id' | 'created_by' | 'status' | 'created_at' | 'updated_at'>;
+    /**
+     * Export as JSON
+     */
+    toJSON(): string;
+}
+/**
+ * Phase Builder
+ */
+declare class PhaseBuilder {
+    private phase;
+    constructor(name: string, order: number);
+    /**
+     * Set phase description
+     */
+    description(description: string): this;
+    /**
+     * Add an agent to the phase
+     */
+    agent(type: string, config?: Record<string, unknown>): this;
+    /**
+     * Add an agent with full configuration
+     */
+    agentWithRetry(type: string, config: Record<string, unknown>, retryPolicy: RetryPolicy): this;
+    /**
+     * Set conditional execution based on expression
+     */
+    runIf(expression: string): this;
+    /**
+     * Set conditional execution based on previous phase status
+     */
+    runAfter(status: 'completed' | 'skipped'): this;
+    /**
+     * Set failure behavior
+     */
+    onFailure(behavior: 'fail' | 'skip' | 'retry'): this;
+    /**
+     * Build the phase
+     */
+    build(): WorkflowPhase;
+}
+
+/**
+ * WAVE Workflow SDK
+ *
+ * Official SDK for building and executing workflows on the WAVE platform.
+ *
+ * @packageDocumentation
+ * @module @wave/workflow-sdk
+ *
+ * @example
+ * ```typescript
+ * import { WaveWorkflowClient } from '@wave/workflow-sdk';
+ *
+ * const client = new WaveWorkflowClient({
+ *   apiKey: process.env.WAVE_API_KEY!,
+ *   organizationId: 'org_123',
+ * });
+ *
+ * // Execute a workflow
+ * const execution = await client.execute('my-workflow', {
+ *   input_params: { environment: 'production' },
+ * });
+ *
+ * // Wait for completion
+ * const result = await client.waitForCompletion(execution.id, {
+ *   onProgress: (exec) => console.log(`Status: ${exec.status}`),
+ * });
+ *
+ * console.log('Output:', result.output);
+ * ```
+ */
+
+/**
+ * SDK version
+ */
+declare const VERSION = "1.0.0";
+/**
+ * Default API base URL
+ */
+declare const DEFAULT_API_URL = "https://api.wave.online";
+
+export { DEFAULT_API_URL, RetryPolicy, VERSION, WorkflowBuilder, WorkflowConfig, WorkflowDefinition, WorkflowPhase };