kronky

defmodule Kronky.ValidationMessage do
  @moduledoc """
  Stores validation message information.

  ## Fields

  ### :field
  The input field that the error applies to. The key can be used to
  identify which field the error message should be displayed next to in the
  presentation layer.

  If there are multiple errors to display for a key, multiple validation
  messages will be in the result.

  This field may be nil in cases where an error cannot be applied to a specific field.

  ### :message
  A friendly error message, appropriate for display to the end user.

  The message is interpolated to include the appropriate variables.

  Example: `"Username must be at least 10 characters"`

  ### :template
  A template used to generate the error message, with placeholders for option substiution.

  Example: `"Username must be at least %{count} characters"`

  ### :code
  A unique error code for the type of validation that failed. This field must be provided.

  See `Kronky.ChangesetParser.to_code/1` for built in codes corresponding to most Ecto validations.

  ### :options
  A Keyword List of substitutions to be applied to a validation message template.

  """
  @enforce_keys [:code]
  defstruct [key: nil, code: nil, options: [], template: "is invalid", message: "is invalid"]

end