Packages

phoenix_kit

1.2.7
1.7.208 1.7.207 1.7.206 1.7.205 1.7.204 1.7.203 1.7.202 1.7.201 1.7.200 1.7.199 1.7.198 1.7.197 1.7.196 1.7.194 1.7.193 1.7.192 1.7.191 1.7.190 1.7.189 1.7.187 1.7.186 1.7.185 1.7.184 1.7.183 1.7.182 1.7.181 1.7.180 1.7.179 1.7.178 1.7.177 1.7.176 1.7.175 1.7.174 1.7.173 1.7.172 1.7.171 1.7.170 1.7.169 1.7.168 1.7.167 1.7.166 1.7.165 1.7.164 1.7.162 1.7.161 1.7.160 1.7.159 1.7.157 1.7.156 1.7.155 1.7.154 1.7.153 1.7.152 1.7.151 1.7.150 1.7.149 1.7.146 1.7.145 1.7.144 1.7.143 1.7.138 1.7.133 1.7.132 1.7.131 1.7.130 1.7.128 1.7.126 1.7.125 1.7.121 1.7.120 1.7.119 1.7.118 1.7.117 1.7.116 1.7.115 1.7.114 1.7.113 1.7.112 1.7.111 1.7.110 1.7.109 1.7.108 1.7.107 1.7.106 1.7.105 1.7.104 1.7.103 1.7.102 1.7.101 1.7.100 1.7.99 1.7.98 1.7.97 1.7.96 1.7.95 1.7.94 1.7.93 1.7.92 1.7.91 1.7.90 1.7.89 1.7.88 1.7.87 1.7.86 1.7.85 1.7.84 1.7.83 1.7.82 1.7.81 1.7.80 1.7.79 1.7.78 1.7.77 1.7.76 1.7.75 1.7.74 1.7.71 1.7.70 1.7.69 1.7.66 1.7.65 1.7.64 1.7.63 1.7.62 1.7.61 1.7.59 1.7.58 1.7.57 1.7.56 1.7.55 1.7.54 1.7.53 1.7.52 1.7.51 1.7.49 1.7.44 1.7.43 1.7.42 1.7.41 1.7.39 1.7.38 1.7.37 1.7.36 1.7.34 1.7.33 1.7.31 1.7.30 1.7.29 1.7.28 1.7.27 1.7.26 1.7.25 1.7.24 1.7.23 1.7.22 1.7.21 1.7.20 1.7.19 1.7.18 1.7.17 1.7.16 1.7.15 1.7.14 1.7.13 1.7.12 1.7.11 1.7.10 1.7.9 1.7.8 1.7.7 1.7.6 1.7.5 1.7.4 1.7.3 1.7.2 1.7.1 1.7.0 1.6.20 1.6.19 1.6.18 1.6.17 1.6.16 1.6.15 1.6.14 1.6.13 1.6.12 1.6.11 1.6.10 1.6.9 1.6.8 1.6.7 1.6.6 1.6.5 1.6.4 1.6.3 1.5.2 1.5.1 1.5.0 1.4.9 1.4.8 1.4.7 1.4.6 1.4.5 1.4.4 1.4.3 1.4.2 1.4.1 1.4.0 1.3.2 1.3.1 1.3.0 1.2.10 1.2.9 1.2.8 1.2.7 1.2.5 1.2.4 1.2.2 1.2.1 1.2.0 1.1.0 1.0.0

A foundation for building Elixir Phoenix apps — SaaS, social networks, ERP systems, marketplaces, and more

Current section

Files

Jump to
phoenix_kit lib phoenix_kit users auth.ex
Raw

lib/phoenix_kit/users/auth.ex

defmodule PhoenixKit.Users.Auth do
@moduledoc """
The Auth context for user authentication and management.
This module provides functions for user registration, authentication, password management,
and email confirmation. It serves as the main interface for all user-related operations
in PhoenixKit.
## Core Functions
### User Registration and Authentication
- `register_user/1` - Register a new user with email and password
- `get_user_by_email_and_password/2` - Authenticate user credentials
- `get_user_by_email/1` - Find user by email address
### Password Management
- `change_user_password/2` - Update user password
- `reset_user_password/2` - Reset password with token
- `deliver_user_reset_password_instructions/1` - Send password reset email
### Email Confirmation
- `deliver_user_confirmation_instructions/1` - Send confirmation email
- `confirm_user/1` - Confirm user account with token
- `update_user_email/2` - Change user email with confirmation
### Session Management
- `generate_user_session_token/1` - Create session token for login
- `get_user_by_session_token/1` - Get user from session token
- `delete_user_session_token/1` - Logout user session
## Usage Examples
# Register a new user
{:ok, user} = PhoenixKit.Users.Auth.register_user(%{
email: "user@example.com",
password: "secure_password123"
})
# Authenticate user
case PhoenixKit.Users.Auth.get_user_by_email_and_password(email, password) do
%User{} = user -> {:ok, user}
nil -> {:error, :invalid_credentials}
end
# Send confirmation email
PhoenixKit.Users.Auth.deliver_user_confirmation_instructions(user)
## Security Features
- Passwords are hashed using bcrypt
- Email confirmation prevents unauthorized account creation
- Session tokens provide secure authentication
- Password reset tokens expire for security
- All sensitive operations are logged
"""
import Ecto.Query, warn: false
alias PhoenixKit.RepoHelper, as: Repo
# This module will be populated by mix phx.gen.auth
alias PhoenixKit.Admin.Events
alias PhoenixKit.Users.Auth.{User, UserNotifier, UserToken}
alias PhoenixKit.Users.Roles
## Database getters
@doc """
Gets a user by email.
## Examples
iex> get_user_by_email("foo@example.com")
%User{}
iex> get_user_by_email("unknown@example.com")
nil
"""
def get_user_by_email(email) when is_binary(email) do
Repo.get_by(User, email: email)
end
@doc """
Gets a user by email and password.
## Examples
iex> get_user_by_email_and_password("foo@example.com", "correct_password")
%User{}
iex> get_user_by_email_and_password("foo@example.com", "invalid_password")
nil
"""
def get_user_by_email_and_password(email, password)
when is_binary(email) and is_binary(password) do
user = Repo.get_by(User, email: email)
if User.valid_password?(user, password), do: user
end
@doc """
Gets a single user.
Raises `Ecto.NoResultsError` if the User does not exist.
## Examples
iex> get_user!(123)
%User{}
iex> get_user!(456)
** (Ecto.NoResultsError)
"""
def get_user!(id), do: Repo.get!(User, id)
## User registration
@doc """
Registers a user with automatic role assignment.
Role assignment is handled by Elixir application logic:
- First user receives Owner role
- Subsequent users receive User role
- Uses database transactions to prevent race conditions
## Examples
iex> register_user(%{field: value})
{:ok, %User{}}
iex> register_user(%{field: bad_value})
{:error, %Ecto.Changeset{}}
"""
def register_user(attrs) do
case %User{}
|> User.registration_changeset(attrs)
|> Repo.insert() do
{:ok, user} ->
# Safely assign Owner role to first user, User role to others
case Roles.ensure_first_user_is_owner(user) do
{:ok, role_type} ->
# Log successful role assignment for security audit
require Logger
Logger.info("PhoenixKit: User #{user.id} (#{user.email}) assigned #{role_type} role")
# Broadcast user creation event
Events.broadcast_user_created(user)
{:ok, user}
{:error, reason} ->
# Role assignment failed - this is critical
require Logger
Logger.error(
"PhoenixKit: Failed to assign role to user #{user.id}: #{inspect(reason)}"
)
# User was created but role assignment failed
# In production, you might want to delete the user or mark as needs_role_assignment
{:ok, user}
end
{:error, changeset} ->
{:error, changeset}
end
end
@doc """
Returns an `%Ecto.Changeset{}` for tracking user changes.
## Examples
iex> change_user_registration(user)
%Ecto.Changeset{data: %User{}}
"""
def change_user_registration(%User{} = user, attrs \\ %{}) do
User.registration_changeset(user, attrs, hash_password: false, validate_email: false)
end
## Settings
@doc """
Returns an `%Ecto.Changeset{}` for changing the user email.
## Examples
iex> change_user_email(user)
%Ecto.Changeset{data: %User{}}
"""
def change_user_email(user, attrs \\ %{}) do
User.email_changeset(user, attrs, validate_email: false)
end
@doc """
Emulates that the email will change without actually changing
it in the database.
## Examples
iex> apply_user_email(user, "valid password", %{email: ...})
{:ok, %User{}}
iex> apply_user_email(user, "invalid password", %{email: ...})
{:error, %Ecto.Changeset{}}
"""
def apply_user_email(user, password, attrs) do
user
|> User.email_changeset(attrs)
|> User.validate_current_password(password)
|> Ecto.Changeset.apply_action(:update)
end
@doc """
Updates the user email using the given token.
If the token matches, the user email is updated and the token is deleted.
The confirmed_at date is also updated to the current time.
"""
def update_user_email(user, token) do
context = "change:#{user.email}"
with {:ok, query} <- UserToken.verify_change_email_token_query(token, context),
%UserToken{sent_to: email} <- Repo.one(query),
{:ok, _} <- Repo.transaction(user_email_multi(user, email, context)) do
:ok
else
_ -> :error
end
end
defp user_email_multi(user, email, context) do
changeset =
user
|> User.email_changeset(%{email: email})
|> User.confirm_changeset()
multi = Ecto.Multi.new()
multi = Ecto.Multi.update(multi, :user, changeset)
Ecto.Multi.delete_all(multi, :tokens, UserToken.by_user_and_contexts_query(user, [context]))
end
@doc ~S"""
Delivers the update email instructions to the given user.
## Examples
iex> deliver_user_update_email_instructions(user, current_email, &PhoenixKit.Utils.Routes.url("/users/settings/confirm_email/#{&1}"))
{:ok, %{to: ..., body: ...}}
"""
def deliver_user_update_email_instructions(%User{} = user, current_email, update_email_url_fun)
when is_function(update_email_url_fun, 1) do
{encoded_token, user_token} = UserToken.build_email_token(user, "change:#{current_email}")
Repo.insert!(user_token)
UserNotifier.deliver_update_email_instructions(user, update_email_url_fun.(encoded_token))
end
@doc """
Returns an `%Ecto.Changeset{}` for changing the user password.
## Examples
iex> change_user_password(user)
%Ecto.Changeset{data: %User{}}
"""
def change_user_password(user, attrs \\ %{}) do
User.password_changeset(user, attrs, hash_password: false)
end
@doc """
Returns an `%Ecto.Changeset{}` for changing the user profile.
## Examples
iex> change_user_profile(user)
%Ecto.Changeset{data: %User{}}
"""
def change_user_profile(user, attrs \\ %{}) do
User.profile_changeset(user, attrs, validate_email: false)
end
@doc """
Updates the user password.
## Examples
iex> update_user_password(user, "valid password", %{password: ...})
{:ok, %User{}}
iex> update_user_password(user, "invalid password", %{password: ...})
{:error, %Ecto.Changeset{}}
"""
def update_user_password(user, password, attrs) do
changeset =
user
|> User.password_changeset(attrs)
|> User.validate_current_password(password)
multi = Ecto.Multi.new()
multi = Ecto.Multi.update(multi, :user, changeset)
Ecto.Multi.delete_all(multi, :tokens, UserToken.by_user_and_contexts_query(user, :all))
|> Repo.transaction()
|> case do
{:ok, %{user: user}} -> {:ok, user}
{:error, :user, changeset, _} -> {:error, changeset}
end
end
@doc """
Updates the user password as an admin (bypasses current password validation).
## Examples
iex> admin_update_user_password(user, %{password: "new_password", password_confirmation: "new_password"})
{:ok, %User{}}
iex> admin_update_user_password(user, %{password: "short"})
{:error, %Ecto.Changeset{}}
"""
def admin_update_user_password(user, attrs) do
changeset = User.password_changeset(user, attrs)
multi = Ecto.Multi.new()
multi = Ecto.Multi.update(multi, :user, changeset)
Ecto.Multi.delete_all(multi, :tokens, UserToken.by_user_and_contexts_query(user, :all))
|> Repo.transaction()
|> case do
{:ok, %{user: user}} -> {:ok, user}
{:error, :user, changeset, _} -> {:error, changeset}
end
end
## Session
@doc """
Generates a session token.
"""
def generate_user_session_token(user) do
{token, user_token} = UserToken.build_session_token(user)
inserted_token = Repo.insert!(user_token)
# Broadcast session creation event
token_info = %{
token_id: inserted_token.id,
created_at: inserted_token.inserted_at,
context: inserted_token.context
}
Events.broadcast_session_created(user, token_info)
token
end
@doc """
Gets the user with the given signed token.
"""
def get_user_by_session_token(token) do
{:ok, query} = UserToken.verify_session_token_query(token)
Repo.one(query)
end
@doc """
Deletes the signed token with the given context.
"""
def delete_user_session_token(token) do
Repo.delete_all(UserToken.by_token_and_context_query(token, "session"))
:ok
end
@doc """
Deletes all session tokens for the given user.
This function is useful when you need to force logout a user from all sessions,
for example when their roles change and they need fresh authentication.
"""
def delete_all_user_session_tokens(user) do
Repo.delete_all(UserToken.by_user_and_contexts_query(user, ["session"]))
:ok
end
@doc """
Gets all active session tokens for the given user.
This is useful for finding all active sessions to broadcast logout messages.
"""
def get_all_user_session_tokens(user) do
Repo.all(UserToken.by_user_and_contexts_query(user, ["session"]))
end
## Confirmation
@doc ~S"""
Delivers the confirmation email instructions to the given user.
## Examples
iex> deliver_user_confirmation_instructions(user, &PhoenixKit.Utils.Routes.url("/users/confirm/#{&1}"))
{:ok, %{to: ..., body: ...}}
iex> deliver_user_confirmation_instructions(confirmed_user, &PhoenixKit.Utils.Routes.url("/users/confirm/#{&1}"))
{:error, :already_confirmed}
"""
def deliver_user_confirmation_instructions(%User{} = user, confirmation_url_fun)
when is_function(confirmation_url_fun, 1) do
if user.confirmed_at do
{:error, :already_confirmed}
else
{encoded_token, user_token} = UserToken.build_email_token(user, "confirm")
Repo.insert!(user_token)
UserNotifier.deliver_confirmation_instructions(user, confirmation_url_fun.(encoded_token))
end
end
@doc """
Confirms a user by the given token.
If the token matches, the user account is marked as confirmed
and the token is deleted.
"""
def confirm_user(token) do
with {:ok, query} <- UserToken.verify_email_token_query(token, "confirm"),
%User{} = user <- Repo.one(query),
{:ok, %{user: updated_user}} <- Repo.transaction(confirm_user_multi(user)) do
# Broadcast confirmation event
alias PhoenixKit.Admin.Events
Events.broadcast_user_confirmed(updated_user)
{:ok, updated_user}
else
_ -> :error
end
end
defp confirm_user_multi(user) do
multi = Ecto.Multi.new()
multi = Ecto.Multi.update(multi, :user, User.confirm_changeset(user))
Ecto.Multi.delete_all(multi, :tokens, UserToken.by_user_and_contexts_query(user, ["confirm"]))
end
@doc """
Manually confirms a user account (admin function).
## Examples
iex> admin_confirm_user(user)
{:ok, %User{}}
iex> admin_confirm_user(invalid_user)
{:error, %Ecto.Changeset{}}
"""
def admin_confirm_user(%User{} = user) do
changeset = User.confirm_changeset(user)
case Repo.update(changeset) do
{:ok, updated_user} = result ->
alias PhoenixKit.Admin.Events
Events.broadcast_user_confirmed(updated_user)
result
error ->
error
end
end
@doc """
Manually unconfirms a user account (admin function).
## Examples
iex> admin_unconfirm_user(user)
{:ok, %User{}}
iex> admin_unconfirm_user(invalid_user)
{:error, %Ecto.Changeset{}}
"""
def admin_unconfirm_user(%User{} = user) do
changeset = User.unconfirm_changeset(user)
case Repo.update(changeset) do
{:ok, updated_user} = result ->
alias PhoenixKit.Admin.Events
Events.broadcast_user_unconfirmed(updated_user)
result
error ->
error
end
end
@doc """
Toggles user confirmation status (admin function).
## Examples
iex> toggle_user_confirmation(confirmed_user)
{:ok, %User{confirmed_at: nil}}
iex> toggle_user_confirmation(unconfirmed_user)
{:ok, %User{confirmed_at: ~N[2023-01-01 12:00:00]}}
"""
def toggle_user_confirmation(%User{confirmed_at: nil} = user) do
admin_confirm_user(user)
end
def toggle_user_confirmation(%User{} = user) do
admin_unconfirm_user(user)
end
## Reset password
@doc ~S"""
Delivers the reset password email to the given user.
## Examples
iex> deliver_user_reset_password_instructions(user, &PhoenixKit.Utils.Routes.url("/users/reset-password/#{&1}"))
{:ok, %{to: ..., body: ...}}
"""
def deliver_user_reset_password_instructions(%User{} = user, reset_password_url_fun)
when is_function(reset_password_url_fun, 1) do
{encoded_token, user_token} = UserToken.build_email_token(user, "reset_password")
Repo.insert!(user_token)
UserNotifier.deliver_reset_password_instructions(user, reset_password_url_fun.(encoded_token))
end
@doc """
Gets the user by reset password token.
## Examples
iex> get_user_by_reset_password_token("validtoken")
%User{}
iex> get_user_by_reset_password_token("invalidtoken")
nil
"""
def get_user_by_reset_password_token(token) do
with {:ok, query} <- UserToken.verify_email_token_query(token, "reset_password"),
%User{} = user <- Repo.one(query) do
user
else
_ -> nil
end
end
@doc """
Resets the user password.
## Examples
iex> reset_user_password(user, %{password: "new long password", password_confirmation: "new long password"})
{:ok, %User{}}
iex> reset_user_password(user, %{password: "valid", password_confirmation: "not the same"})
{:error, %Ecto.Changeset{}}
"""
def reset_user_password(user, attrs) do
multi = Ecto.Multi.new()
multi = Ecto.Multi.update(multi, :user, User.password_changeset(user, attrs))
Ecto.Multi.delete_all(multi, :tokens, UserToken.by_user_and_contexts_query(user, :all))
|> Repo.transaction()
|> case do
{:ok, %{user: user}} -> {:ok, user}
{:error, :user, changeset, _} -> {:error, changeset}
end
end
## Role Management Functions
@doc """
Assigns a role to a user.
## Examples
iex> assign_role(user, "Admin")
{:ok, %RoleAssignment{}}
iex> assign_role(user, "Admin", assigned_by_user)
{:ok, %RoleAssignment{}}
iex> assign_role(user, "NonexistentRole")
{:error, :role_not_found}
"""
defdelegate assign_role(user, role_name, assigned_by \\ nil), to: PhoenixKit.Users.Roles
@doc """
Removes a role from a user.
## Examples
iex> remove_role(user, "Admin")
{:ok, %RoleAssignment{}}
iex> remove_role(user, "NonexistentRole")
{:error, :assignment_not_found}
"""
defdelegate remove_role(user, role_name), to: PhoenixKit.Users.Roles
@doc """
Checks if a user has a specific role.
## Examples
iex> user_has_role?(user, "Admin")
true
iex> user_has_role?(user, "Owner")
false
"""
defdelegate user_has_role?(user, role_name), to: PhoenixKit.Users.Roles
@doc """
Gets all active roles for a user.
## Examples
iex> get_user_roles(user)
["Admin", "User"]
iex> get_user_roles(user_with_no_roles)
[]
"""
defdelegate get_user_roles(user), to: PhoenixKit.Users.Roles
@doc """
Gets all users who have a specific role.
## Examples
iex> users_with_role("Admin")
[%User{}, %User{}]
iex> users_with_role("NonexistentRole")
[]
"""
defdelegate users_with_role(role_name), to: PhoenixKit.Users.Roles
@doc """
Promotes a user to admin role.
## Examples
iex> promote_to_admin(user)
{:ok, %RoleAssignment{}}
iex> promote_to_admin(user, assigned_by_user)
{:ok, %RoleAssignment{}}
"""
defdelegate promote_to_admin(user, assigned_by \\ nil), to: PhoenixKit.Users.Roles
@doc """
Demotes an admin user to regular user role.
## Examples
iex> demote_to_user(user)
{:ok, %RoleAssignment{}}
"""
defdelegate demote_to_user(user), to: PhoenixKit.Users.Roles
@doc """
Gets role statistics for dashboard display.
## Examples
iex> get_role_stats()
%{
total_users: 10,
owner_count: 1,
admin_count: 2,
user_count: 7
}
"""
defdelegate get_role_stats(), to: PhoenixKit.Users.Roles
@doc """
Assigns roles to existing users who don't have any PhoenixKit roles.
This is useful for migration scenarios where PhoenixKit is installed
into an existing application with users.
## Examples
iex> assign_roles_to_existing_users()
{:ok, %{assigned_owner: 1, assigned_users: 5, total_processed: 6}}
"""
defdelegate assign_roles_to_existing_users(opts \\ []), to: PhoenixKit.Users.Roles
@doc """
Lists all roles.
## Examples
iex> list_roles()
[%Role{}, %Role{}, %Role{}]
"""
defdelegate list_roles(), to: PhoenixKit.Users.Roles
@doc """
Updates a user's profile information.
## Examples
iex> update_user_profile(user, %{first_name: "John", last_name: "Doe"})
{:ok, %User{}}
iex> update_user_profile(user, %{first_name: ""})
{:error, %Ecto.Changeset{}}
"""
def update_user_profile(%User{} = user, attrs) do
case user
|> User.profile_changeset(attrs)
|> Repo.update() do
{:ok, updated_user} ->
# Broadcast user profile update event
Events.broadcast_user_updated(updated_user)
{:ok, updated_user}
{:error, changeset} ->
{:error, changeset}
end
end
@doc """
Updates user status with Owner protection.
Prevents deactivation of the last Owner to maintain system security.
## Parameters
- `user`: User to update
- `attrs`: Status attributes (typically %{"is_active" => true/false})
## Examples
iex> update_user_status(user, %{"is_active" => false})
{:ok, %User{}}
iex> update_user_status(last_owner, %{"is_active" => false})
{:error, :cannot_deactivate_last_owner}
"""
def update_user_status(%User{} = user, attrs) do
# Check if this would deactivate the last owner
if attrs["is_active"] == false or attrs[:is_active] == false do
do_deactivate_user(user, attrs)
else
# Activation is always safe
do_update_user_status(user, attrs)
end
end
defp do_deactivate_user(user, attrs) do
case Roles.can_deactivate_user?(user) do
:ok ->
do_update_user_status(user, attrs)
{:error, :cannot_deactivate_last_owner} ->
require Logger
Logger.warning("PhoenixKit: Attempted to deactivate last Owner user #{user.id}")
{:error, :cannot_deactivate_last_owner}
end
end
defp do_update_user_status(user, attrs) do
case user
|> User.status_changeset(attrs)
|> Repo.update() do
{:ok, updated_user} ->
# Broadcast user status update event
Events.broadcast_user_updated(updated_user)
{:ok, updated_user}
{:error, changeset} ->
{:error, changeset}
end
end
@doc """
Gets a user by ID with preloaded roles.
## Examples
iex> get_user_with_roles(123)
%User{roles: [%Role{}, %Role{}]}
iex> get_user_with_roles(999)
nil
"""
def get_user_with_roles(id) when is_integer(id) do
from(u in User, where: u.id == ^id, preload: [:roles, :role_assignments])
|> Repo.one()
end
@doc """
Lists users with pagination and optional role filtering.
## Examples
iex> list_users_paginated(page: 1, page_size: 10)
%{users: [%User{}], total_count: 50, total_pages: 5}
iex> list_users_paginated(page: 1, page_size: 10, role: "Admin")
%{users: [%User{}], total_count: 3, total_pages: 1}
"""
def list_users_paginated(opts \\ []) do
page = Keyword.get(opts, :page, 1)
page_size = Keyword.get(opts, :page_size, 10)
role_filter = Keyword.get(opts, :role)
search_query = Keyword.get(opts, :search, "")
base_query = from(u in User, order_by: [desc: u.inserted_at])
query =
base_query
|> maybe_filter_by_role(role_filter)
|> maybe_filter_by_search(search_query)
total_count = PhoenixKit.RepoHelper.aggregate(query, :count, :id)
total_pages = div(total_count + page_size - 1, page_size)
users =
query
|> limit(^page_size)
|> offset(^((page - 1) * page_size))
|> preload([:roles, :role_assignments])
|> Repo.all()
%{
users: users,
total_count: total_count,
total_pages: total_pages,
current_page: page
}
end
defp maybe_filter_by_role(query, nil), do: query
defp maybe_filter_by_role(query, "all"), do: query
defp maybe_filter_by_role(query, role_name) when is_binary(role_name) do
from [u] in query,
join: assignment in assoc(u, :role_assignments),
join: role in assoc(assignment, :role),
where: role.name == ^role_name,
where: assignment.is_active == true,
distinct: u.id
end
defp maybe_filter_by_search(query, ""), do: query
defp maybe_filter_by_search(query, search_term) when is_binary(search_term) do
search_pattern = "%#{search_term}%"
from [u] in query,
where:
ilike(u.email, ^search_pattern) or
ilike(u.username, ^search_pattern) or
ilike(u.first_name, ^search_pattern) or
ilike(u.last_name, ^search_pattern)
end
@doc """
Searches users by email or name for selection interfaces.
Returns a list of users matching the search term, limited to 10 results
for performance. Useful for autocomplete/typeahead interfaces.
## Examples
iex> PhoenixKit.Users.Auth.search_users("john")
[%User{email: "john@example.com", first_name: "John"}, ...]
iex> PhoenixKit.Users.Auth.search_users("")
[]
"""
def search_users(search_term) when is_binary(search_term) do
case String.trim(search_term) do
"" ->
[]
trimmed_term when byte_size(trimmed_term) >= 2 ->
search_pattern = "%#{trimmed_term}%"
from(u in User,
where:
ilike(u.email, ^search_pattern) or
ilike(u.username, ^search_pattern) or
ilike(u.first_name, ^search_pattern) or
ilike(u.last_name, ^search_pattern),
order_by: [asc: u.email],
limit: 10,
select: %{
id: u.id,
email: u.email,
username: u.username,
first_name: u.first_name,
last_name: u.last_name
}
)
|> Repo.all()
_ ->
[]
end
end
@doc """
Gets a user by ID with minimal fields for selection interfaces.
Returns a user map with id, email, first_name, and last_name fields.
Returns nil if user is not found.
## Examples
iex> PhoenixKit.Users.Auth.get_user_for_selection(123)
%{id: 123, email: "user@example.com", first_name: "John", last_name: "Doe"}
iex> PhoenixKit.Users.Auth.get_user_for_selection(999)
nil
"""
def get_user_for_selection(user_id) when is_integer(user_id) do
from(u in User,
where: u.id == ^user_id,
select: %{
id: u.id,
email: u.email,
username: u.username,
first_name: u.first_name,
last_name: u.last_name
}
)
|> Repo.one()
end
end