StackflowActions.ts

import type {
  PausedEvent,
  PoppedEvent,
  PushedEvent,
  ReplacedEvent,
  ResumedEvent,
  StepPoppedEvent,
  StepPushedEvent,
  StepReplacedEvent,
} from "../event-types";
import type { BaseDomainEvent } from "../event-types/_base";
import type { DispatchEvent } from "../event-utils";
import type { Stack } from "../Stack";

export type StackflowActions = {
  /**
   * Get current stack state
   */
  getStack: () => Stack;

  /**
   * Dispatch new event to the core without pre-effect hooks
   */
  dispatchEvent: DispatchEvent;

  /**
   * Push new activity
   */
  push: (params: Omit<PushedEvent, keyof BaseDomainEvent>) => void;

  /**
   * Push new activity in the top and remove current top activity when new activity is activated
   */
  replace: (params: Omit<ReplacedEvent, keyof BaseDomainEvent>) => void;

  /**
   * Remove top activity
   */
  pop: (params?: Omit<PoppedEvent, keyof BaseDomainEvent>) => void;

  /**
   * Push new step in current activity
   */
  stepPush: (params: Omit<StepPushedEvent, keyof BaseDomainEvent>) => void;

  /**
   * Replace current step in current activity
   */
  stepReplace: (params: Omit<StepReplacedEvent, keyof BaseDomainEvent>) => void;

  /**
   * Remove current step
   */
  stepPop: (params?: Omit<StepPoppedEvent, keyof BaseDomainEvent>) => void;

  /**
   * Pause stack change
   */
  pause: (params?: Omit<PausedEvent, keyof BaseDomainEvent>) => void;

  /**
   * Resume paused stack
   */
  resume: (params?: Omit<ResumedEvent, keyof BaseDomainEvent>) => void;

  /**
   * Clear past events and reconstruct state with active activities to release memory
   */
  prune: () => void;
};