export enum WorkflowStatus {
  /**
   * The workflow is still active and has not yet finished
   */
  Running = 'running',

  /**
   * The workflow has completed and will not receive further messages
   */
  Complete = 'complete',

  /**
   * A pseudo status to indicate that changes to the current state should not be persisted
   */
  Discard = 'discard'
}

/**
 * A base workflow state definition to model and persist the state of a workflow throughout
 * its lifespan.
 */
export abstract class WorkflowState {
  /**
   * Unique identifier of the workflow state
   */
  $workflowId: string

  /**
   * Used to manage concurrency when storing the workflow state. This value is incremented
   * each time the data is persisted which keeps locking of data low.
   */
  $version = 0

  /**
   * Marks if the workflow is currently running or has ended
   */
  $status: WorkflowStatus

  /**
   * A unique name for the workflow state. This should be formatted in a namespace style,
   * ie: 'company/application/workflow-name'
   * eg: $name = 'node-ts/bus-core/my-workflow'
   */
  abstract readonly $name: string
}

export type WorkflowStateConstructor<
  TWorkflowState extends WorkflowState = WorkflowState
> = new () => TWorkflowState