@lssm/example.workflow-system 0.0.0-canary-20251207013726 → 0.0.0-canary-20251207043720

package/dist/state-machine/index.d.ts

@@ -1,147 +0,0 @@
-//#region src/state-machine/index.d.ts
-/**
- * Workflow State Machine Engine
- *
- * Provides state machine logic for workflow transitions.
- * This is a spec-level abstraction that defines the interface
- * for workflow state transitions.
- */
-/**
- * Represents a transition definition in a workflow step.
- */
-interface TransitionDefinition {
-  /** The action that triggers this transition (e.g., "approve", "reject") */
-  action: string;
-  /** The target step key to transition to */
-  targetStepKey: string;
-  /** Optional condition expression for conditional transitions */
-  condition?: string;
-  /** Optional guard roles - only users with these roles can take this action */
-  allowedRoles?: string[];
-}
-/**
- * Step definition for state machine.
- */
-interface StateMachineStep {
-  key: string;
-  name: string;
-  type: 'START' | 'APPROVAL' | 'TASK' | 'CONDITION' | 'PARALLEL' | 'WAIT' | 'ACTION' | 'END';
-  /** Map of action -> transition definition */
-  transitions: Record<string, string | TransitionDefinition>;
-  /** For approval steps: how approvals are handled */
-  approvalMode?: 'ANY' | 'ALL' | 'MAJORITY' | 'SEQUENTIAL';
-  /** Roles that can approve/act on this step */
-  allowedRoles?: string[];
-  /** Timeout in seconds */
-  timeoutSeconds?: number;
-  /** Condition expression for CONDITION type */
-  conditionExpression?: string;
-}
-/**
- * Workflow state machine definition.
- */
-interface StateMachineDefinition {
-  key: string;
-  name: string;
-  version: number;
-  initialStepKey: string;
-  steps: Record<string, StateMachineStep>;
-}
-/**
- * Current state of an instance.
- */
-interface StateMachineState {
-  currentStepKey: string;
-  status: 'PENDING' | 'RUNNING' | 'WAITING' | 'PAUSED' | 'COMPLETED' | 'CANCELLED' | 'FAILED' | 'TIMEOUT';
-  contextData: Record<string, unknown>;
-  history: {
-    stepKey: string;
-    action: string;
-    timestamp: Date;
-    executedBy: string;
-  }[];
-}
-/**
- * Result of a transition attempt.
- */
-interface TransitionResult {
-  success: boolean;
-  previousStepKey: string;
-  currentStepKey: string | null;
-  status: StateMachineState['status'];
-  error?: string;
-}
-/**
- * Context for transition validation.
- */
-interface TransitionContext {
-  userId: string;
-  userRoles: string[];
-  data?: Record<string, unknown>;
-}
-/**
- * State machine engine interface.
- * Implementation should be provided at runtime.
- */
-interface IStateMachineEngine {
-  /**
-   * Validate that a transition is allowed.
-   */
-  canTransition(definition: StateMachineDefinition, state: StateMachineState, action: string, context: TransitionContext): {
-    allowed: boolean;
-    reason?: string;
-  };
-  /**
-   * Get available actions for the current step.
-   */
-  getAvailableActions(definition: StateMachineDefinition, state: StateMachineState, context: TransitionContext): string[];
-  /**
-   * Execute a transition.
-   */
-  transition(definition: StateMachineDefinition, state: StateMachineState, action: string, context: TransitionContext): TransitionResult;
-  /**
-   * Evaluate a condition expression.
-   */
-  evaluateCondition(expression: string, contextData: Record<string, unknown>): boolean;
-}
-/**
- * Basic state machine engine implementation.
- * This is a reference implementation for spec validation.
- */
-declare class BasicStateMachineEngine implements IStateMachineEngine {
-  canTransition(definition: StateMachineDefinition, state: StateMachineState, action: string, context: TransitionContext): {
-    allowed: boolean;
-    reason?: string;
-  };
-  getAvailableActions(definition: StateMachineDefinition, state: StateMachineState, context: TransitionContext): string[];
-  transition(definition: StateMachineDefinition, state: StateMachineState, action: string, context: TransitionContext): TransitionResult;
-  evaluateCondition(expression: string, contextData: Record<string, unknown>): boolean;
-}
-/**
- * Create a new state machine engine instance.
- */
-declare function createStateMachineEngine(): IStateMachineEngine;
-/**
- * Build a state machine definition from workflow entities.
- */
-declare function buildStateMachineDefinition(workflow: {
-  key: string;
-  name: string;
-  version: number;
-  initialStepId: string | null;
-}, steps: {
-  key: string;
-  name: string;
-  type: string;
-  transitions: Record<string, string | TransitionDefinition>;
-  approvalMode?: string;
-  approverRoles?: string[];
-  timeoutSeconds?: number;
-  conditionExpression?: string;
-}[]): StateMachineDefinition;
-/**
- * Create initial state for a new workflow instance.
- */
-declare function createInitialState(definition: StateMachineDefinition, contextData?: Record<string, unknown>): StateMachineState;
-//#endregion
-export { BasicStateMachineEngine, IStateMachineEngine, StateMachineDefinition, StateMachineState, StateMachineStep, TransitionContext, TransitionDefinition, TransitionResult, buildStateMachineDefinition, createInitialState, createStateMachineEngine };