@spec attribute_label(module(), atom()) :: String.t() | nil

The written label of a resource's attribute from its gettext block, or nil.

@spec attribute_labels(module()) :: [{atom(), String.t()}]

Every written attribute label of a resource, as {attribute, text}.

@spec gettext_backend(dsl_or_extended :: module() | map()) :: {:ok, atom()} | :error

The Gettext backend whose catalogs this domain translates against.

@spec gettext_backend!(dsl_or_extended :: module() | map()) :: atom() | no_return()

The Gettext backend whose catalogs this domain translates against.

@spec gettext_default_locale(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

The locale used when the resolver names a language the catalogs do not have.

@spec gettext_default_locale!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

The locale used when the resolver names a language the catalogs do not have.

@spec gettext_locale_resolver(dsl_or_extended :: module() | map()) ::
  {:ok, module()} | :error

Required. A module implementing AshGettext.Locale.Resolver. It reads the language from the action's actor. With no actor, Gettext's current process language is used.

@spec gettext_locale_resolver!(dsl_or_extended :: module() | map()) ::
  module() | no_return()

Required. A module implementing AshGettext.Locale.Resolver. It reads the language from the action's actor. With no actor, Gettext's current process language is used.

@spec gettext_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

gettext DSL options

Returns a map containing the and any configured or default values.

@spec gettext_require_resource_extension?(dsl_or_extended :: module() | map()) ::
  boolean()

When true, compiling the domain reports every resource in its resources block that lacks the AshGettext.Resource extension (a compiler warning, an error under --warnings-as-errors). Off by default on purpose: Ash extensions are opted into, never imposed.

@spec gettext_text_domain(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

The gettext text domain for everything Ash-derived: errors, enum labels, attribute names.

@spec gettext_text_domain!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

The gettext text domain for everything Ash-derived: errors, enum labels, attribute names.

@spec gettext_translate_errors?(dsl_or_extended :: module() | map()) :: boolean()

Whether resources in this domain translate their action errors.

@spec language(module() | map(), term()) :: {module(), String.t()} | nil

The {backend, locale} to use for actor, or nil for Gettext's current language.

Asks the domain's locale_resolver with the actor and fits the answer to the catalogs. nil when there is no actor or the resolver returns nil. Nothing here changes the process language.

@spec locale_settings(module() | map()) :: {:ok, settings()} | :error

The domain's gettext settings, whether or not error translation is on.

:error only when the domain has no gettext block. Used to find the backend, text domain and language rules for enums, attributes and the action's language.

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

The domain's translation settings, or :error when it does not translate.

Returns :error both for a domain without the AshGettext.Domain extension and for one that has explicitly set translate_errors? false, so a caller can treat "not configured" and "switched off" the same way — pass the value through untouched.