@spec action_label(module(), AshDispatch.Context.t(), AshDispatch.Channel.t()) ::
  String.t() | nil

Get action label for in-app notifications.

@spec action_required?(module(), AshDispatch.Context.t()) :: boolean()

Check if the event requires action from the user.

@spec action_url(module(), AshDispatch.Context.t(), AshDispatch.Channel.t()) ::
  String.t() | nil

Get action URL for in-app notifications.

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

Get all registered event modules as a list of {event_id, module} tuples.

Uses the EventRegistry which auto-discovers events from configured domains.

@spec applicable_for_user?(module(), any()) :: boolean()

Check if the event is applicable for a specific user.

@spec body_html(module(), AshDispatch.Context.t(), AshDispatch.Channel.t()) ::
  String.t() | nil

Get HTML body for email (for test modules without templates). Returns nil if callback not exported.

@spec body_text(module(), AshDispatch.Context.t(), AshDispatch.Channel.t()) ::
  String.t() | nil

Get text body for email (for test modules without templates). Returns nil if callback not exported.

@spec build_sample_context(String.t(), module()) :: AshDispatch.Context.t()

Build a sample context for previews and testing.

Uses the module's sample_data/0 callback if available.

@spec call_if_exported(module(), atom(), list(), keyword()) :: any()

Call a function on the module if it's exported, with error handling.

Options

• :default - Value to return if function not exported or raises (default: nil)

Examples

# Returns result or default
value = EventResolver.call_if_exported(module, :domain, [], default: :unknown)

# With arguments
subject = EventResolver.call_if_exported(module, :subject, [context, channel])

@spec category(module(), AshDispatch.Context.t()) :: atom() | nil

Get the event category for preferences.

@spec counters(module(), AshDispatch.Context.t(), AshDispatch.Channel.t()) :: [atom()]

Get counters for broadcasting.

@spec data_key(module()) :: atom() | nil

Get the data key from an event module.

@spec domain(module()) :: atom() | nil

Get the domain from an event module.

@spec event_id(module()) :: String.t() | nil

Get the event ID from a module, if it implements id/0.

@spec exports?(module(), atom(), non_neg_integer()) :: boolean()

Check if a module exports a specific function.

@spec find_module(String.t()) :: {:ok, module()} | {:error, :not_found}

Find an event module by its event ID.

Returns

• {:ok, module} if found
• {:error, :not_found} if no event with that ID exists

@spec from(module(), AshDispatch.Context.t(), AshDispatch.Channel.t()) ::
  {String.t(), String.t()} | nil

Get the from address for a channel.

@spec generate_send_variables(module(), AshDispatch.Context.t(), map()) ::
  {:ok, map()} | {:error, term()}

Generate send variables for actual delivery.

@spec has_body_callbacks?(module()) :: boolean()

Check if module exports both body_html and body_text callbacks. Used to determine if we should use callbacks instead of templates.

@spec notification_message(module(), AshDispatch.Context.t(), AshDispatch.Channel.t()) ::
  String.t() | nil

Get notification message for in-app notifications.

Falls back to DSL content from the registry if the module returns the default value.

@spec notification_title(module(), AshDispatch.Context.t(), AshDispatch.Channel.t()) ::
  String.t() | nil

Get notification title for in-app notifications.

Falls back to DSL content from the registry if the module returns the default value.

@spec notification_type(module(), AshDispatch.Context.t()) :: atom()

Get the notification type from an event module.

@spec prepare_data(module(), Ash.Changeset.t(), any()) :: map()

Prepare data from changeset (for resource-triggered events).

@spec prepare_template_assigns(
  module(),
  AshDispatch.Context.t(),
  AshDispatch.Channel.t()
) :: map()

Prepare template assigns for a channel.

@spec recipients(module(), AshDispatch.Context.t(), AshDispatch.Channel.t()) :: [
  String.t()
]

Get recipients for a channel.

@spec required_resources(module()) :: keyword()

Get required resources for manual trigger.

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

Get the resource from an event module.

@spec sample_data(module()) :: map()

Get sample data from an event module.

@spec source_url(module(), AshDispatch.Context.t(), AshDispatch.Channel.t()) ::
  String.t() | nil

Get source URL for linking receipts to source resources.

@spec subject(module(), AshDispatch.Context.t(), AshDispatch.Channel.t(), keyword()) ::
  String.t() | nil

Get the email subject for a channel.

Falls back to DSL content from the registry if the module returns the default value.

@spec template_variant(module(), AshDispatch.Context.t(), AshDispatch.Channel.t()) ::
  String.t() | nil

Get the template variant for a channel.

@spec user_configurable?(module(), AshDispatch.Context.t()) :: boolean()

Check if the event is user configurable.