@spec clear_url_prefix_cache() :: :ok

Clears the cached URL prefix.

Call this if you change the url_prefix config at runtime (rare).

@spec default_locale() :: String.t()

Returns the default locale for the application.

Parent apps can override via config:

config :phoenix_kit,
  default_locale: "es-ES"

Defaults to "en-US" if not configured.

Examples

iex> PhoenixKit.Config.default_locale()
"en-US"

# With custom config:
iex> PhoenixKit.Config.default_locale()
"es-ES"

@spec get(atom()) :: {:ok, any()} | :not_found

Gets a specific configuration value.

Uses direct Application.get_env lookup for performance (avoids iterating all config keys on every call).

@spec get(atom(), any()) :: any()

Gets a specific configuration value with a default.

Examples

iex> PhoenixKit.Config.get(:mailer, PhoenixKit.Mailer)
MyApp.Mailer

iex> PhoenixKit.Config.get(:nonexistent, :default)
:default

@spec get_all() :: Keyword.t()

Gets all PhoenixKit configuration.

@spec get_base_url() :: String.t()

Gets configured host with an optional port or default value.

@spec get_boolean(atom(), boolean()) :: boolean()

Gets a configuration value as a boolean with type validation.

Examples

iex> PhoenixKit.Config.get_boolean(:enabled, false)
true

iex> PhoenixKit.Config.get_boolean(:nonexistent, true)
true

@spec get_dynamic_base_url() :: String.t()

Gets the base URL dynamically from the parent Phoenix Endpoint if available, otherwise falls back to the static configuration.

This function automatically detects the correct URL from the running Phoenix application, which is especially useful in development mode where the port might be different from the default configuration.

Examples

iex> PhoenixKit.Config.get_dynamic_base_url()
"http://localhost:4001"  # from Phoenix Endpoint

iex> PhoenixKit.Config.get_dynamic_base_url()
"http://localhost:4000"  # fallback to static config

@spec get_list(atom(), list()) :: list()

Gets a configuration value as a list with type validation.

Examples

iex> PhoenixKit.Config.get_list(:options, [])
[]

iex> PhoenixKit.Config.get_list(:nonexistent, [:default])
[:default]

@spec get_mailer() :: module()

Gets the configured mailer module.

Returns the configured mailer or falls back to PhoenixKit.Mailer.

Examples

iex> PhoenixKit.Config.get_mailer()
MyApp.Mailer

@spec get_parent_app() :: atom() | nil

Gets the parent application name that is using PhoenixKit.

This function attempts to detect the main application that has included PhoenixKit as a dependency.

@spec get_parent_app_config(atom(), any()) :: any()

Gets configuration from the parent application.

This is useful for accessing parent app mailer, endpoint, or other configurations that PhoenixKit needs to integrate with.

@spec get_parent_endpoint() :: {:ok, module()} | :error

Gets the parent application's Phoenix Endpoint module.

This function attempts to detect the main application's endpoint that is using PhoenixKit as a dependency.

Returns {:ok, endpoint_module} if found, :error otherwise.

@spec get_parent_endpoint_url() :: {:ok, String.t()} | :error

Gets the parent Phoenix Endpoint URL if the endpoint is available and running.

Returns {:ok, url} if successful, :error if the endpoint cannot be found or accessed.

@spec get_repo() :: module() | nil

Gets the configured repository module.

@spec get_repo!() :: module()

Gets the configured repository module, raising an error if not found.

Examples

iex> PhoenixKit.Config.get_repo!()
MyApp.Repo

iex> PhoenixKit.Config.get_repo!()
** (ArgumentError) PhoenixKit repository not configured. Please set config :phoenix_kit, repo: YourApp.Repo

@spec get_string(atom(), String.t()) :: String.t()

Gets a configuration value as a string with type validation.

Examples

iex> PhoenixKit.Config.get_string(:host, "localhost")
"example.com"

iex> PhoenixKit.Config.get_string(:nonexistent, "default")
"default"

@spec get_url_prefix() :: String.t()

Gets configured prefix for urls or default value.

This value is cached using :persistent_term for performance since it's called on every tab path match during dashboard renders.

@spec get_users_module() :: module()

Gets the configured users module.

@spec mailer_local?() :: boolean()

Checks if the configured mailer adapter is the local adapter.

Returns true if the mailer is configured to use Swoosh.Adapters.Local, which is typically used for development and testing environments where emails are stored locally rather than being sent to actual recipients.

Examples

iex> PhoenixKit.Config.mailer_local?
true  # when using Swoosh.Adapters.Local

iex> PhoenixKit.Config.mailer_local?
false  # when using a real mailer like SMTP or SendGrid

@spec pubsub_server() :: atom() | nil

Gets the configured PubSub server for broadcasting messages.

Returns the internal PhoenixKit PubSub server or configured custom server.

Examples

iex> PhoenixKit.Config.pubsub_server()
:phoenix_kit_internal_pubsub

@spec set(atom(), any()) :: :ok

Sets a configuration value.

Examples

iex> PhoenixKit.Config.set(:repo, MyApp.Repo)
:ok

iex> PhoenixKit.Config.set(:custom_option, "custom_value")
:ok

@spec user_dashboard_enabled?() :: boolean()

Gets the user dashboard enabled flag.

Returns true if the user dashboard is enabled, false otherwise. This can be used to conditionally show/hide dashboard routes and navigation.

Examples

iex> PhoenixKit.Config.user_dashboard_enabled?()
true

iex> PhoenixKit.Config.user_dashboard_enabled?()
false

Validates that required configuration is present.

Raises an exception if any required keys are missing.

Examples

PhoenixKit.Config.validate_required!([:repo, :secret_key_base])