A macro that calls the add_perms(bool?, bool?) DB function

Examples

iex> import Bonfire.Boundaries.Queries
iex> query = from(p in Summary, select: add_perms(p.read, p.write))

A macro that calls the agg_perms(bool?) aggregate DB function for combining permissions.

Examples

iex> import Bonfire.Boundaries.Queries
iex> query = from(p in Summary, group_by: p.object_id, having: agg_perms(p.value))

A macro to apply boundary checks to a query.

Examples

iex> import Bonfire.Boundaries.Queries
iex> query_visible_posts = from(p in Post)
                          |> boundarise(p.id, current_user: user)

iex> query_editable_posts = from(p in Post)
                          |> boundarise(p.id, verbs: [:edit], current_user: user)

Applies boundary checks to a query for a specific object.

Examples

iex> query = from(p in Post)
iex> Bonfire.Boundaries.Queries.object_boundarised(query, current_user: user)

Queries for all permitted objects for a user.

Examples

iex> user_id = "user123"
iex> Bonfire.Boundaries.Queries.permitted(user_id)

Queries for permitted objects for a user with specific verbs.

Examples

iex> user_id = "user123"
iex> Bonfire.Boundaries.Queries.permitted(user_id, [:read, :write])

Creates a subquery to filter results based on user permissions.

Filters out results that the current user is not permitted to perform all of the specified verbs on.

Parameters

• user: The current user or their ID
• verbs: A list of verbs to check permissions for (default: [:see, :read])
• query: An initial query on Summary to filter objects (optional)

Examples

iex> user_id = "user123"
iex> Bonfire.Boundaries.Queries.query_with_summary(user_id, [:read, :write])

Checks if boundary checks should be skipped based on the provided options and object.

Examples

iex> Bonfire.Boundaries.Queries.skip_boundary_check?([skip_boundary_check: true])
true

iex> Bonfire.Boundaries.Queries.skip_boundary_check?([], %{id: "user123"})
false

iex> Bonfire.Boundaries.Queries.skip_boundary_check?([current_user: %{id: "user123"}], %{id: "user123"})
true