asl-validator/src/types.ts

Amazon States Language validator

export type State = Record<string, unknown>;
export type States = Record<string, State>;
export type StateMachine = {
  QueryLanguage?: string | null;
  States: States;
};
export enum StateMachineErrorCode {
  BranchOutboundTransitionTarget = "BRANCH_OUTBOUND_TRANSITION_TARGET",
  DuplicateStateNames = "DUPLICATE_STATE_NAMES",
  DuplicateFieldName = "DUPLICATE_FIELD_NAME",
  InvalidJsonPath = "INVALID_JSON_PATH",
  MapOutboundTransitionTarget = "MAP_OUTBOUND_TRANSITION_TARGET",
  MissingTerminalState = "MISSING_TERMINAL_STATE",
  MissingTransitionTarget = "MISSING_TRANSITION_TARGET",
  SchemaValidationFailed = "SCHEMA_VALIDATION_FAILED",
  TerminalStateWithNextError = "TERMINAL_STATE_WITH_NEXT",
  WaitDurationError = "WAIT_DURATION",
  TaskTimeoutError = "TASK_TIMEOUT",
  TaskHeartbeatError = "TASK_HEARTBEAT",
  MapItemProcessorError = "MAP_ITEM_PROCESSOR",
  MapItemSelectorError = "MAP_ITEM_SELECTOR",
  MapItemBatcherError = "MAP_ITEM_BATCHER",
  MapToleratedFailureError = "MAP_TOLERATED_FAILURE",
  MapMaxConcurrencyError = "MAP_CONCURRENCY_ERROR",
  MapItemReaderMaxItemsError = "MAP_ITEMREADER_MAXITEM",
  FailCauseProperty = "FAIL_CAUSE_PROPERTY",
  FailErrorProperty = "FAIL_ERROR_PROPERTY",
  QueryLanguageFieldError = "QUERY_LANGUAGE_FIELD",
}
export type StateMachineError = {
  "Error code": StateMachineErrorCode;
  Message: string;
  schemaError?: {
    instancePath: string;
    schemaPath: string;
  };
};

export interface ValidationOptions {
  readonly checkPaths: boolean;
  readonly checkArn: boolean;
}

export type AslChecker = (
  definition: StateMachine,
  options: ValidationOptions
) => StateMachineError[];