@type rivet_config() :: %{
  app: String.t(),
  base: atom(),
  base_path: String.t(),
  models_root: String.t(),
  opts: Keyword.t(),
  tests_root: String.t()
}

@type rivet_error() :: {:error, String.t() | atom()}

@type rivet_migration_input_any() ::
  rivet_migration_input_include()
  | rivet_migration_input_external()
  | rivet_migration_input_model()

@type rivet_migration_input_external() :: %{
  external: String.t(),
  migrations: [rivet_migration_input_include()]
}

@type rivet_migration_input_include() :: %{include: module(), prefix: integer()}

@type rivet_migration_input_model() :: map()

@type rivet_migration_state() :: %{
  idx: %{required(integer()) => t()},
  mods: %{required(atom()) => list()}
}

@type rivet_migrations() :: [t()]

@type rivet_state_result() :: {:ok, rivet_migration_state()} | rivet_error()

@type t() :: %Rivet.Migration{
  base: boolean(),
  external: nil | String.t(),
  include: nil | module(),
  index: nil | String.t(),
  migrations: nil | list(),
  model: nil | module(),
  module: nil | module(),
  parent: nil | module(),
  path: nil | String.t(),
  prefix: nil | integer(),
  version: integer()
}