ex_ftp

# SPDX-License-Identifier: Apache-2.0
defmodule ExFTP.Auth.WebhookAuthConfig do
  @moduledoc """
  A module describing the **authenticator_config** value for `ExFTP.Auth.WebhookAuth`

  <!-- tabs-open -->

  #{ExFTP.Doc.related(["`ExFTP.Auth.WebhookAuth`", "`ExFTP.Authenticator`"])}

  #{ExFTP.Doc.resources()}

  <!-- tabs-close -->
  """
  import ExFTP.Auth.Common

  alias ExFTP.Auth.Common
  alias ExFTP.Auth.WebhookAuthConfig

  @typedoc """
  The **authenticator_config** value for `ExFTP.Auth.WebhookAuth`

  <!-- tabs-open -->
  ### 🏷️ Required Keys
    * **login_url** :: `t:ExFTP.Auth.Common.login_url/0`

  ### 🏷️ Optional Keys
    * **login_method** :: `t:ExFTP.Auth.Common.login_method/0`
    * **password_hash_type** :: `t:password_hash_type/0`
    * **authenticated_url** :: `t:ExFTP.Auth.Common.authenticated_url/0`
    * **authenticated_method** :: `t:ExFTP.Auth.Common.authenticated_url/0`
    * **authenticated_ttl_ms** :: `t:ExFTP.Auth.Common.authenticated_ttl_ms/0`

  <!-- tabs-open -->
  """
  @type t() :: %WebhookAuthConfig{
          authenticated_ttl_ms: Common.authenticated_ttl_ms(),
          login_url: Common.login_url(),
          login_method: Common.login_method(),
          authenticated_url: Common.authenticated_url() | nil,
          authenticated_method: Common.authenticated_method(),
          password_hash_type: password_hash_type()
        }

  @typedoc """
  A hash algorithm to use on the password supplied by the client.

  Used by `ExFTP.Auth.WebhookAuth.login/2`

  <!-- tabs-open -->

  #{ExFTP.Doc.related(["`ExFTP.Auth.WebhookAuth.login/2`"])}

  <!-- tabs-close -->
  """
  @type password_hash_type :: :crypto.hash_algorithm()

  @enforce_keys [:login_url]

  defstruct [
    :login_url,
    :authenticated_url,
    :authenticated_ttl_ms,
    login_method: :get,
    authenticated_method: :get,
    password_hash_type: :sha256
  ]

  @doc """
  Builds a `t:ExFTP.Auth.WebhookAuthConfig.t/0` from a map

  <!-- tabs-open -->

  ### 🏷️ Params
    * **m** :: A map to build into a `t:ExFTP.Auth.WebhookAuthConfig.t/0`

  <!-- tabs-close -->
  """
  @spec build(m :: map) :: WebhookAuthConfig.t()
  def build(m) do
    fields = prepare(m)

    struct(WebhookAuthConfig, fields)
  end
end