"""
end
defp email_text_layout_content do
"""
<%= @inner_content %>
---
This email was sent by Your Company Name
To unsubscribe, visit: [unsubscribe link]
"""
end
# ============================================
# Phoenix Integration
# ============================================
defp maybe_setup_phoenix(igniter, false, _otp_app, _app_module), do: igniter
defp maybe_setup_phoenix(igniter, true, otp_app, app_module) do
web_module = detect_web_module(igniter, app_module)
if web_module do
igniter
|> create_user_channel(web_module)
|> create_inbox_controller(web_module, otp_app)
|> add_inbox_routes(web_module)
|> configure_counter_broadcast(otp_app, web_module)
else
Igniter.add_notice(
igniter,
"""
⚠️ Phoenix web module not detected. Skipping channel setup.
You can manually create a UserChannel for real-time notifications.
See: https://ash-dispatch-docs.pages.dev/phoenix-integration
"""
)
end
end
defp create_user_channel(igniter, web_module) do
channel_module = Module.concat(web_module, UserChannel)
web_module_str = inspect(web_module) |> String.replace_prefix("Elixir.", "")
content = """
defmodule #{inspect(channel_module)} do
@moduledoc \"\"\"
Phoenix channel for real-time user notifications and counter updates.
Generated by `mix ash_dispatch.install`.
\"\"\"
use Phoenix.Channel
alias AshDispatch.Helpers.ChannelState
@doc \"\"\"
Join the user's personal channel.
\"\"\"
def join("user:" <> user_id, _params, socket) do
if authorized?(socket, user_id) do
send(self(), :after_join)
{:ok, socket}
else
{:error, %{reason: "unauthorized"}}
end
end
@doc \"\"\"
Send initial state after joining.
\"\"\"
def handle_info(:after_join, socket) do
user_id = socket.assigns.user_id
# Load all counters and recent notifications
initial_state = ChannelState.build(user_id)
push(socket, "initial_state", initial_state)
{:noreply, socket}
end
@doc \"\"\"
Broadcast a counter update to the user's channel.
Called by AshDispatch when counters change.
\"\"\"
def broadcast_counter(user_id, counter_name, value) do
#{web_module_str}.Endpoint.broadcast(
"user:\#{user_id}",
"counter_update",
%{counter: counter_name, value: value}
)
end
defp authorized?(socket, user_id) do
# Verify the user can access this channel
socket.assigns[:user_id] == user_id
end
end
"""
Igniter.Project.Module.create_module(igniter, channel_module, content)
end
defp create_inbox_controller(igniter, web_module, _otp_app) do
controller_module = Module.concat(web_module, InboxApiController)
web_module_str = inspect(web_module) |> String.replace_prefix("Elixir.", "")
content = """
defmodule #{inspect(controller_module)} do
@moduledoc \"\"\"
API controller for inbox-related endpoints.
Generated by `mix ash_dispatch.install`.
\"\"\"
use #{web_module_str}, :controller
@doc \"\"\"
Generate a socket token for the current user.
Used by the frontend to authenticate Phoenix channel connections.
\"\"\"
def socket_token(conn, _params) do
user = conn.assigns[:current_user]
if user do
token = Phoenix.Token.sign(#{web_module_str}.Endpoint, "user socket", user.id)
json(conn, %{success: true, data: %{token: token}})
else
conn
|> put_status(:unauthorized)
|> json(%{success: false, error: "Not authenticated"})
end
end
end
"""
Igniter.Project.Module.create_module(igniter, controller_module, content)
end
defp add_inbox_routes(igniter, web_module) do
route_code = """
# AshDispatch inbox API
get "/api/inbox/socket-token", InboxApiController, :socket_token
"""
Igniter.Libs.Phoenix.append_to_scope(igniter, "/", route_code,
arg2: web_module,
placement: :after
)
rescue
_ ->
Igniter.add_notice(
igniter,
"""
⚠️ Could not automatically add inbox routes.
Please add manually to your router:
get "/api/inbox/socket-token", InboxApiController, :socket_token
"""
)
end
defp configure_counter_broadcast(igniter, _otp_app, web_module) do
channel_module = Module.concat(web_module, UserChannel)
Igniter.Project.Config.configure_new(
igniter,
"config.exs",
:ash_dispatch,
[:counter_broadcast_fn],
{channel_module, :broadcast_counter}
)
end
# ============================================
# Email Configuration
# ============================================
defp maybe_configure_email(igniter, false, _otp_app, _app_module), do: igniter
defp maybe_configure_email(igniter, true, _otp_app, app_module) do
mailer_module = Module.concat(app_module, Mailer)
# Check if mailer exists
{mailer_exists?, igniter} = Igniter.Project.Module.module_exists(igniter, mailer_module)
if mailer_exists? do
igniter
|> Igniter.Project.Config.configure_new(
"config.exs",
:ash_dispatch,
[:email_backend],
AshDispatch.EmailBackend.Swoosh
)
|> Igniter.Project.Config.configure_new(
"config.exs",
:ash_dispatch,
[:swoosh_mailer],
mailer_module
)
else
Igniter.add_notice(
igniter,
"""
⚠️ Mailer module #{inspect(mailer_module)} not found.
To enable email notifications, configure Swoosh:
config :ash_dispatch,
email_backend: AshDispatch.EmailBackend.Swoosh,
swoosh_mailer: #{inspect(mailer_module)}
"""
)
end
end
# ============================================
# TypeScript SDK
# ============================================
defp maybe_run_typescript(igniter, false), do: igniter
defp maybe_run_typescript(igniter, true) do
# Check if ash_typescript is actually being used in the project
# by checking if any domain has the AshTypescript.Rpc extension
if ash_typescript_in_use?() do
Igniter.add_task(igniter, "ash_dispatch.gen")
else
# ash_typescript not in use - just skip silently (it's optional)
# User can run `mix ash_dispatch.gen` later if they set it up
igniter
end
end
defp ash_typescript_in_use? do
# Check if AshTypescript.Rpc module exists
if Code.ensure_loaded?(AshTypescript.Rpc) do
# Check if any domain uses the AshTypescript.Rpc extension
otp_app = Mix.Project.config()[:app]
domains = Application.get_env(otp_app, :ash_domains, [])
Enum.any?(domains, fn domain ->
Code.ensure_loaded?(domain) and
function_exported?(domain, :spark_dsl_config, 0) and
has_ash_typescript_extension?(domain)
end)
else
false
end
end
defp has_ash_typescript_extension?(domain) do
try do
extensions = Spark.extensions(domain)
AshTypescript.Rpc in extensions
rescue
_ -> false
end
end
# ============================================
# Helpers
# ============================================
defp detect_user_resource(igniter, app_module) do
# Common user resource locations
candidates = [
Module.concat([app_module, Accounts, User]),
Module.concat([app_module, Users, User]),
Module.concat([app_module, User])
]
Enum.find(candidates, fn module ->
{exists?, _} = Igniter.Project.Module.module_exists(igniter, module)
exists?
end)
end
defp detect_web_module(igniter, app_module) do
# Common web module patterns
candidates = [
Module.concat(app_module, Web),
Module.concat([app_module |> to_string() |> Kernel.<>("Web") |> String.to_atom()])
]
Enum.find(candidates, fn module ->
{exists?, _} = Igniter.Project.Module.module_exists(igniter, module)
exists?
end)
end
# ============================================
# Final Notice
# ============================================
defp add_final_notice(igniter, _otp_app, app_module, user_resource) do
user_notice =
if user_resource do
""
else
"""
⚠️ User resource not detected. Update your Notification resource:
use AshDispatch.Notification,
user_resource: YourApp.Accounts.User,
...
"""
end
notice = """
🎉 AshDispatch has been installed!
Created:
- #{inspect(Module.concat([app_module, Notifications, Notification]))}
- #{inspect(Module.concat(app_module, Notifications))} (domain)
- #{inspect(Module.concat([app_module, Deliveries, DeliveryReceipt]))}
- #{inspect(Module.concat(app_module, Deliveries))} (domain)
- priv/ash_dispatch/layouts/email.html.heex
- priv/ash_dispatch/layouts/email.text.eex
#{user_notice}
Next Steps:
1. Run migrations:
mix ash.codegen add_ash_dispatch
mix ash.migrate
2. Add events to your resources:
defmodule #{inspect(app_module)}.Orders.Order do
use Ash.Resource,
extensions: [AshDispatch.Resource]
dispatch do
event :created,
trigger_on: :create,
channels: [
[transport: :in_app, audience: :user]
],
content: [
notification_title: "Order Created",
notification_message: "Your order #\{\{id\}\} was created"
]
end
end
3. Generate email templates (if using email channel):
mix ash.codegen
4. (Optional) Generate TypeScript SDK:
mix ash_dispatch.gen
📚 Documentation: https://ash-dispatch-docs.pages.dev
"""
Igniter.add_notice(igniter, notice)
end
end
else
defmodule Mix.Tasks.AshDispatch.Install do
@shortdoc "#{__MODULE__.Docs.short_doc()} | Install `igniter` to use"
@moduledoc __MODULE__.Docs.long_doc()
use Mix.Task
def run(_argv) do
Mix.shell().error("""
The task 'ash_dispatch.install' requires igniter. Please install igniter and try again.
For more information, see: https://hexdocs.pm/igniter/readme.html#installation
""")
exit({:shutdown, 1})
end
end
end