@heyanon/sdk 2.3.10 → 2.4.1

package/dist/utils/workflow-retry.d.ts

@@ -0,0 +1,439 @@
+/**
+ * Custom error class for breaking workflow execution
+ */
+export declare class WorkflowBreakError extends Error {
+    /**
+     * The reason for breaking the workflow
+     */
+    readonly breakReason: unknown;
+    /**
+     * Create a new WorkflowBreakError
+     * @param breakReason Optional reason for breaking the workflow
+     */
+    constructor(breakReason?: unknown);
+}
+/**
+ * Options for configuring a workflow action
+ * @template T The type of the action's result
+ */
+export interface ActionOptions<T> {
+    /**
+     * Name of the action
+     */
+    name: string;
+    /**
+     * Number of retry attempts
+     * @default 1
+     */
+    attempts?: number;
+    /**
+     * Delay between retries in milliseconds
+     * @default 0
+     */
+    delayMs?: number;
+    /**
+     * Function to execute
+     * @param context The workflow context
+     * @returns Promise with the action's result
+     */
+    action: (context: WorkflowContext) => Promise<T>;
+    /**
+     * Optional function to execute before each retry
+     * @param attempt Current attempt number (1-based)
+     * @param error The error that triggered the retry
+     * @param context The workflow context
+     */
+    onRetry?: (attempt: number, error: Error, context: WorkflowContext) => Promise<void>;
+    /**
+     * Optional function to execute when action succeeds
+     * @param result The action's result
+     * @param context The workflow context
+     */
+    onSuccess?: (attempt: number, result: T, context: WorkflowContext) => Promise<void>;
+    /**
+     * Optional function to execute when action fails
+     * @param error The error that caused the failure
+     * @param context The workflow context
+     */
+    onFailed?: (attempt: number, error: Error, context: WorkflowContext) => Promise<void>;
+}
+/**
+ * Options for configuring a workflow
+ */
+export interface WorkflowOptions {
+    /**
+     * Number of retry attempts
+     * @default 1
+     */
+    attempts?: number;
+    /**
+     * Delay between retries in milliseconds
+     * @default 0
+     */
+    delayMs?: number;
+    /**
+     * Optional callback to execute when workflow is broken
+     * @param reason The reason for breaking the workflow
+     * @param context The workflow context
+     */
+    onBreak?: (reason: any, context: WorkflowContext) => Promise<void>;
+    /**
+     * Optional callback to execute when workflow is retried
+     * @param error The error that caused the retry
+     * @param context The workflow context
+     */
+    onRetry?: (error: Error, context: WorkflowContext) => Promise<void>;
+    /**
+     * Optional callback to execute when workflow completes successfully
+     * @param context The workflow context
+     */
+    onSuccess?: (context: WorkflowContext) => Promise<void>;
+    /**
+     * Optional callback to execute when workflow fails
+     * @param error The error that caused the failure
+     * @param context The workflow context
+     */
+    onFailed?: (error: Error, context: WorkflowContext) => Promise<void>;
+}
+/**
+ * Class representing a workflow action that can be executed with retry logic
+ * @template T The type of the action's result
+ */
+export declare class WorkflowAction<T> {
+    /**
+     * Name of the action
+     */
+    private readonly name;
+    /**
+     * Current attempt number
+     */
+    private currentAttempt;
+    /**
+     * Number of retry attempts
+     */
+    private attempts;
+    /**
+     * Delay between retries in milliseconds
+     */
+    private delayMs;
+    /**
+     * Function to execute
+     */
+    private readonly action;
+    /**
+     * Optional function to execute before each retry
+     */
+    private readonly onRetry?;
+    /**
+     * Optional function to execute when action succeeds
+     */
+    private readonly onSuccess?;
+    /**
+     * Optional function to execute when action fails
+     */
+    private readonly onFailed?;
+    /**
+     * Create a new WorkflowAction
+     * @param options Action configuration
+     */
+    constructor(options: ActionOptions<T>);
+    /**
+     * Get the name of the action
+     * @returns The name of the action
+     */
+    getName(): string;
+    /**
+     * Private retry method for action execution
+     * @param fn The function to retry
+     * @param context The workflow context
+     * @returns Promise with the result of the function
+     * @throws {Error} If all retry attempts fail
+     */
+    private retry;
+    /**
+     * Execute the action with retry logic
+     * @param context The workflow context containing results from previous actions
+     * @returns Promise with the result of the action
+     * @throws {Error} If all retry attempts fail
+     * @throws {WorkflowBreakError} If the workflow is broken
+     */
+    execute(context: WorkflowContext): Promise<T>;
+}
+/**
+ * Context object passed to each action, containing results from previous actions
+ */
+export declare class WorkflowContext {
+    /**
+     * Results from previous actions, stored by name
+     */
+    private resultsByName;
+    /**
+     * Results from previous actions, stored by index
+     */
+    private resultsByIndex;
+    /**
+     * Reference to the workflow instance
+     */
+    private workflow;
+    /**
+     * Current attempt number
+     */
+    private currentAttempt;
+    /**
+     * Current action name
+     */
+    private currentActionName;
+    /**
+     * Create a new WorkflowContext
+     * @param workflow The workflow instance
+     */
+    constructor(workflow: WorkflowRetry);
+    /**
+     * Get the current attempt number
+     * @returns The current attempt number (1-based)
+     */
+    getAttempt(): number;
+    /**
+     * Set the current attempt number
+     * @param attempt The attempt number to set
+     */
+    setAttempt(attempt: number): void;
+    /**
+     * Get the current action name
+     * @returns The name of the currently executed action
+     */
+    getActionName(): string;
+    /**
+     * Set the current action name
+     * @param name The name of the action to set
+     */
+    setActionName(name: string): void;
+    /**
+     * Get the result of a specific action by name
+     * @param name The name of the action result to retrieve
+     * @returns The result of the action with the specified name
+     * @throws {Error} If no result is available with the specified name
+     */
+    getResultByName<T>(name: string): T;
+    /**
+     * Get all results from previous actions
+     * @returns Array of all results
+     */
+    getAllResults(): any[];
+    /**
+     * Add a result to the context
+     * @param name The name of the action
+     * @param result The result to add
+     */
+    addResult(name: string, result: any): void;
+    /**
+     * Get the results by name
+     * @returns Map of results by name
+     */
+    getResultsByName(): Map<string, any>;
+    /**
+     * Get the workflow instance
+     * @returns The workflow instance
+     */
+    getWorkflow(): WorkflowRetry;
+}
+/**
+ * Class representing the result of a workflow execution
+ */
+export declare class WorkflowResult {
+    /**
+     * Results from actions, stored by name
+     */
+    private readonly resultsByName;
+    /**
+     * Results from actions, stored by index
+     */
+    private readonly resultsByIndex;
+    /**
+     * Failures from actions, stored by action name and attempt number
+     */
+    private readonly failuresByAction;
+    /**
+     * Create a new WorkflowResult
+     * @param results Array of results from actions
+     * @param actionNames Array of action names corresponding to the results
+     */
+    constructor(results?: any[], actionNames?: string[]);
+    /**
+     * Add a result to the workflow result
+     * @param name The name of the action
+     * @param result The result to add
+     */
+    addResult(name: string, result: any): void;
+    /**
+     * Add a failure to the workflow result
+     * @param name The name of the action that failed
+     * @param attempt The attempt number
+     * @param reason The reason for the failure
+     */
+    addFailure(name: string, attempt: number, reason: any): void;
+    /**
+     * Get all failures for a specific action
+     * @param name The name of the action
+     * @returns Map of attempt numbers to failure reasons
+     */
+    getFailuresByAction(name: string): Map<number, any>;
+    /**
+     * Get all failures across all actions
+     * @returns Map of action names to maps of attempt numbers to failure reasons
+     */
+    getAllFailures(): Map<string, Map<number, any>>;
+    /**
+     * Check if an action failed in a specific attempt
+     * @param name The name of the action
+     * @param attempt The attempt number
+     * @returns True if the action failed in the specified attempt
+     */
+    hasFailure(name: string, attempt: number): boolean;
+    /**
+     * Get the failure reason for an action in a specific attempt
+     * @param name The name of the action
+     * @param attempt The attempt number
+     * @returns The failure reason or undefined if no failure occurred
+     */
+    getFailure(name: string, attempt: number): any;
+    /**
+     * Get all attempts when an action failed
+     * @param name The name of the action
+     * @returns Array of attempt numbers
+     */
+    getFailureAttempts(name: string): number[];
+    /**
+     * Get all actions that failed
+     * @returns Array of action names
+     */
+    getFailedActions(): string[];
+    /**
+     * Get all actions that failed with a specific reason
+     * @param reason The failure reason to search for
+     * @returns Array of action names
+     */
+    getActionsFailedWithReason(reason: any): string[];
+    /**
+     * Compare two reasons for equality
+     * @param reason1 First reason
+     * @param reason2 Second reason
+     * @returns True if the reasons are equal
+     * @private
+     */
+    private areReasonsEqual;
+    /**
+     * Get the result of a specific action by name
+     * @param name The name of the action
+     * @returns The result of the action with the specified name
+     * @throws {Error} If no result is available with the specified name
+     */
+    getResult<T>(name: string): T;
+    /**
+     * Get the result of the last action in the workflow
+     * @returns The result of the last action
+     * @throws {Error} If no results are available
+     */
+    getLastActionResult<T>(): T;
+    /**
+     * Get all results from the workflow
+     * @returns Array of all results
+     */
+    getAllResults(): any[];
+    /**
+     * Get the number of results
+     * @returns The number of results
+     */
+    getResultCount(): number;
+}
+/**
+ * Class for handling workflow retries with configurable attempts and delay
+ */
+export declare class WorkflowRetry {
+    /**
+     * List of actions to execute in the workflow
+     */
+    private readonly actions;
+    /**
+     * Number of retry attempts
+     */
+    private readonly attempts;
+    /**
+     * Delay between retries in milliseconds
+     */
+    private readonly delayMs;
+    /**
+     * Flag indicating if the workflow was broken
+     */
+    private isBroken;
+    /**
+     * Reason for breaking the workflow
+     */
+    private breakReason;
+    /**
+     * Optional callback to execute when workflow is retried
+     * @param error The error that caused the retry
+     * @param context The workflow context
+     */
+    private readonly onRetry?;
+    /**
+     * Optional callback to execute when workflow is broken
+     * @param reason The reason for breaking the workflow
+     * @param context The workflow context
+     */
+    private readonly onBreak?;
+    /**
+     * Optional callback to execute when workflow completes successfully
+     * @param context The workflow context
+     */
+    private readonly onSuccess?;
+    /**
+     * Optional callback to execute when workflow fails
+     * @param error The error that caused the failure
+     * @param context The workflow context
+     */
+    private readonly onFailed?;
+    /**
+     * Create a new WorkflowRetry instance
+     * @param options Configuration options for the workflow and actions
+     */
+    constructor(options?: WorkflowOptions);
+    /**
+     * Break the workflow execution with an error
+     * @param reason Optional reason for breaking the workflow
+     * @param customError Optional custom error to throw instead of WorkflowBreakError
+     * @throws {WorkflowBreakError} Always throws to break the workflow
+     */
+    break(reason?: unknown): never;
+    /**
+     * Check if the workflow was broken
+     * @returns True if the workflow was broken
+     */
+    wasBroken(): boolean;
+    /**
+     * Get the reason for breaking the workflow
+     * @returns The reason for breaking the workflow
+     */
+    getBreakReason(): unknown;
+    /**
+     * Add an action to the workflow
+     * @param options Action options including the action function and retry configuration
+     * @returns The WorkflowRetry instance for method chaining
+     */
+    addAction<T>(options: ActionOptions<T>): WorkflowRetry;
+    /**
+     * Private retry method for workflow execution
+     * @param fn The function to retry
+     * @param context The workflow context
+     * @returns Promise with the result of the function
+     * @throws {Error} If all retry attempts fail
+     */
+    private retry;
+    /**
+     * Execute all actions in the workflow with retry logic
+     * @returns Promise with a WorkflowResult object containing the results
+     * @throws {Error} If any action fails after all retry attempts
+     * @throws {WorkflowBreakError} If the workflow is broken
+     */
+    execute(): Promise<WorkflowResult>;
+}

package/dist/utils/workflow-retry.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heyanon/sdk",
-  "version": "2.3.10",
+  "version": "2.4.1",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -50,7 +50,7 @@
     "@ton/ton": "15.2.0",
     "ccxt": "4.4.78",
     "openai": "5.12.1",
-    "viem": "2.22.9",
+    "viem": "2.41.2",
     "vitest": "^2.1.8"
   }
 }