Packages
ash_graphql
1.7.13
1.9.4
1.9.3
1.9.2
1.9.1
1.9.0
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
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.0
1.5.1
1.5.0
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.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.1
1.2.0
1.1.1
1.1.0
1.0.1
1.0.0
1.0.0-rc.5
1.0.0-rc.4
retired
1.0.0-rc.3
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.28.1
0.28.0
0.27.1
0.27.0
0.26.9
0.26.8
0.26.7
0.26.6
0.26.5
0.26.4
0.26.3
0.26.2
0.26.0
0.25.13
0.25.12
0.25.10
0.25.9
0.25.8
0.25.7
0.25.6
0.25.5
0.25.4
0.25.3
0.25.2
0.25.1
0.25.0
0.24.1
0.24.0
0.23.3
0.23.2
0.23.1
0.23.0
0.22.13
0.22.12
0.22.11
0.22.10
0.22.9
0.22.8
0.22.7
0.22.6
0.22.4
0.22.3
0.22.2
0.22.1
0.22.0
0.21.0
retired
0.20.5
0.20.4
0.20.3
0.20.2
0.20.1
0.20.0-rc.3
0.20.0-rc.2
0.20.0-rc.1
0.20.0-rc.0
0.19.0
0.18.0-rc0
0.17.5
0.17.5-rc0
0.17.4
0.17.2
0.17.1
0.17.0
0.16.28
0.16.27
0.16.26
0.16.25
0.16.24
0.16.23
0.16.22
0.16.21
0.16.20
0.16.18-rc5
0.16.18-rc4
0.16.18-rc3
0.16.18-rc2
0.16.18-rc1
0.16.18-rc0
0.16.17
0.16.16
0.16.15
0.16.14
0.16.13
0.16.12
0.16.11
0.16.10
0.16.9
0.16.8
0.16.7
0.16.6
0.16.5
0.16.4
0.16.3
0.16.2
0.16.1
0.16.0
0.15.10
0.15.9
0.15.8
0.15.7
0.15.6
0.15.5
0.15.4
0.15.3
0.15.2
0.15.1
0.15.0
0.14.1
0.14.0
0.13.1
0.13.0
0.12.5
0.12.4
0.12.3
0.12.1
0.12.0
0.10.0
0.9.5
0.9.4
0.9.3
0.9.2
0.9.1
0.9.0
0.8.0
0.7.5
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.3
0.6.2
0.6.1
0.6.0
0.5.0
0.4.0
0.3.2
0.3.1
0.3.0
0.2.1
0.2.0
0.1.3
0.1.2
The extension for building GraphQL APIs with Ash
Current section
Files
Jump to
Current section
Files
lib/resource/info.ex
defmodule AshGraphql.Resource.Info do
@moduledoc "Introspection helpers for AshGraphql.Resource"
alias Spark.Dsl.Extension
@doc "The queries exposed for the resource"
def queries(resource, domain_or_domains \\ []) do
module =
if is_atom(resource) do
resource
else
Spark.Dsl.Extension.get_persisted(resource, :module)
end
domain_or_domains
|> List.wrap()
|> Enum.flat_map(&AshGraphql.Domain.Info.queries/1)
|> Enum.filter(&(&1.resource == module))
|> Enum.concat(Extension.get_entities(resource, [:graphql, :queries]))
end
@doc "The mutations exposed for the resource"
def mutations(resource, domain_or_domains \\ []) do
module =
if is_atom(resource) do
resource
else
Spark.Dsl.Extension.get_persisted(resource, :module)
end
domain_or_domains
|> List.wrap()
|> Enum.flat_map(&AshGraphql.Domain.Info.mutations/1)
|> Enum.filter(&(&1.resource == module))
|> Enum.concat(Extension.get_entities(resource, [:graphql, :mutations]) || [])
end
@doc "The subscriptions exposed for the resource"
def subscriptions(resource, domain_or_domains \\ []) do
module =
if is_atom(resource) do
resource
else
Spark.Dsl.Extension.get_persisted(resource, :module)
end
domain_or_domains
|> List.wrap()
|> Enum.flat_map(&AshGraphql.Domain.Info.subscriptions/1)
|> Enum.filter(&(&1.resource == module))
|> Enum.concat(Extension.get_entities(resource, [:graphql, :subscriptions]) || [])
end
@doc "The pubsub module used for subscriptions"
def subscription_pubsub(resource) do
Extension.get_opt(resource, [:graphql, :subscriptions], :pubsub)
end
@doc "Wether or not to encode the primary key as a single `id` field when reading and getting"
def encode_primary_key?(resource) do
Extension.get_opt(resource, [:graphql], :encode_primary_key?, true)
end
@doc "The managed_relationship configurations"
def managed_relationships(resource) do
Extension.get_entities(resource, [:graphql, :managed_relationships]) || []
end
def managed_relationships_auto?(resource) do
Extension.get_opt(resource, [:graphql, :managed_relationships], :auto?, true)
end
@doc "The managed_relationshi configuration for a given action/argument"
def managed_relationship(resource, action, argument) do
resource
|> Extension.get_entities([:graphql, :managed_relationships])
|> List.wrap()
|> Enum.find(fn managed_relationship ->
managed_relationship.argument == argument.name and
managed_relationship.action == action.name
end)
|> then(fn managed_relationship ->
if managed_relationship && managed_relationship.ignore? do
nil
else
if managed_relationships_auto?(resource) do
managed_relationship || default_managed_relationship(action, argument)
else
managed_relationship
end
end
end)
end
defp default_managed_relationship(action, argument) do
if Enum.any?(Map.get(action, :changes, []), fn
%{change: {Ash.Resource.Change.ManageRelationship, opts}} ->
opts[:argument] == argument.name
_ ->
nil
end) && map_type?(argument.type) do
%AshGraphql.Resource.ManagedRelationship{
argument: argument.name,
action: action,
types: [],
type_name: nil,
lookup_with_primary_key?: true,
lookup_identities: []
}
end
end
defp map_type?({:array, type}), do: map_type?(type)
defp map_type?(Ash.Type.Map), do: true
defp map_type?(:map), do: true
defp map_type?(_), do: false
@doc "The graphql type of the resource"
def type(resource) do
Extension.get_opt(resource, [:graphql], :type, nil)
end
@doc "Wether or not to derive a filter input for the resource automatically"
def derive_filter?(resource) do
Extension.get_opt(resource, [:graphql], :derive_filter?, true)
end
@doc "Wether or not to derive a sort input for the resource automatically"
def derive_sort?(resource) do
Extension.get_opt(resource, [:graphql], :derive_sort?, true)
end
@doc "Graphql type overrides for the resource"
def attribute_types(resource) do
Extension.get_opt(resource, [:graphql], :attribute_types, [])
end
@doc "Graphql nullability overrides for the resource"
def nullable_fields(resource) do
Extension.get_opt(resource, [:graphql], :nullable_fields, [])
end
@doc "The field name to place the keyset of a result in"
def keyset_field(resource) do
Extension.get_opt(resource, [:graphql], :keyset_field, nil)
end
@doc "Graphql field name (attribute/relationship/calculation/arguments) overrides for the resource"
def field_names(resource) do
Extension.get_opt(resource, [:graphql], :field_names, [])
end
@doc "Fields to hide from the graphql domain"
def hide_fields(resource) do
Extension.get_opt(resource, [:graphql], :hide_fields, [])
end
@doc "Fields to show in the graphql domain"
def show_fields(resource) do
Extension.get_opt(resource, [:graphql], :show_fields, nil)
end
@doc "Wether or not a given field will be shown"
def show_field?(resource, field) do
hide_fields = hide_fields(resource)
show_fields = show_fields(resource) || [field]
field not in hide_fields and field in show_fields
end
@doc "Which relationships should be included in the generated type"
def relationships(resource) do
Extension.get_opt(resource, [:graphql], :relationships, nil) ||
resource |> Ash.Resource.Info.public_relationships() |> Enum.map(& &1.name)
end
@doc "Pagination configuration for list relationships"
def paginate_relationship_with(resource) do
Extension.get_opt(resource, [:graphql], :paginate_relationship_with, [])
end
@doc "Graphql argument name overrides for the resource"
def argument_names(resource) do
Extension.get_opt(resource, [:graphql], :argument_names, [])
end
@doc "Graphql attribute input type overrides for the resource"
def attribute_input_types(resource) do
Extension.get_opt(resource, [:graphql], :attribute_input_types, [])
end
@doc "Graphql argument type overrides for the resource"
def argument_input_types(resource) do
Extension.get_opt(resource, [:graphql], :argument_input_types, [])
end
@doc "The delimiter for a resource with a composite primary key"
def primary_key_delimiter(resource) do
Extension.get_opt(resource, [:graphql], :primary_key_delimiter, "-")
end
@doc "Wether or not an object should be generated, or if one with the type name for this resource should be used."
def generate_object?(resource) do
Extension.get_opt(resource, [:graphql], :generate_object?, true)
end
@doc "Fields that may be filtered on"
def filterable_fields(resource) do
Extension.get_opt(resource, [:graphql], :filterable_fields, nil)
end
@doc "May the specified field be filtered on?"
def filterable_field?(resource, field_name) do
filterable_fields = AshGraphql.Resource.Info.filterable_fields(resource)
is_nil(filterable_fields) or field_name in filterable_fields
end
@doc "An error handler for errors produced by the resource"
def error_handler(resource) do
if resource,
do:
Extension.get_opt(
resource,
[:graphql],
:error_handler,
nil,
true
)
end
@doc "The complexity callback `{mod, fun}` for this type"
def complexity(resource) do
Extension.get_opt(resource, [:graphql], :complexity, nil)
end
end