mirror of
https://github.com/ash-project/ash_graphql.git
synced 2024-09-17 03:43:14 +12:00
90 lines
2.8 KiB
Elixir
90 lines
2.8 KiB
Elixir
defmodule AshGraphql.Type do
|
|
@moduledoc """
|
|
Callbacks used to enrich types with GraphQL-specific metadata.
|
|
"""
|
|
|
|
defmacro __using__(_) do
|
|
quote do
|
|
@behaviour AshGraphql.Type
|
|
end
|
|
end
|
|
|
|
@doc """
|
|
Sets the name of the graphql type for a given Ash type. For example: `:weekday`.
|
|
|
|
This will do different things depending on the type you're adding it to.
|
|
|
|
## Regular Types
|
|
|
|
This expresses that you will define a custom type for representing this in your graphql
|
|
|
|
## NewTypes
|
|
If it is a subtype of a union, or map/keyword with `fields` the type will be *created* with that name.
|
|
So you can use this to decide what it will be named. Otherwise, it behaves as stated above for
|
|
regular types.
|
|
"""
|
|
@callback graphql_type(Ash.Type.constraints()) :: atom
|
|
|
|
@doc """
|
|
Sets the name of the graphql input type for a given Ash type. For example: `:weekday`.
|
|
|
|
This will do different things depending on the type you're adding it to.
|
|
|
|
## Regular Types
|
|
|
|
This expresses that you will define a custom type for representing this input in your graphql
|
|
|
|
## NewTypes
|
|
If it is a subtype of a union, or map/keyword with `fields` the type will be *created* with that name.
|
|
So you can use this to decide what it will be named. Otherwise, it behaves as stated above for
|
|
regular types.
|
|
"""
|
|
@callback graphql_input_type(Ash.Type.constraints()) :: atom
|
|
|
|
@doc """
|
|
Used for `Ash.Type.Enum` to rename individual values. For example:
|
|
|
|
```elixir
|
|
defmodule MyEnum do
|
|
use Ash.Type.Enum, values: [:foo, :bar, :baz]
|
|
|
|
def graphql_rename_value(:baz), do: :buz
|
|
def graphql_rename_value(other), do: other
|
|
end
|
|
```
|
|
"""
|
|
@callback graphql_rename_value(Ash.Type.constraints()) :: String.t() | atom
|
|
|
|
@doc """
|
|
Used for map/embedded types embedded in unions, to avoid nesting them in a key by their name.
|
|
|
|
See [the unions guide](/documentation/topics/use-unions-with-graphql.md) for more.
|
|
"""
|
|
@callback graphql_unnested_unions(Ash.Type.constraints()) :: [atom()]
|
|
|
|
@doc """
|
|
Used for maps/enums/unions that *would* define a type automatically, to disable them.
|
|
"""
|
|
@callback graphql_define_type?(Ash.Type.constraints()) :: false
|
|
|
|
@doc """
|
|
Used for `Ash.Type.Enum` to provide a description for individual values. For example:
|
|
|
|
```elixir
|
|
defmodule MyEnum do
|
|
use Ash.Type.Enum, values: [:foo, :bar, :baz]
|
|
|
|
def graphql_describe_enum_value(:baz), do: "A baz"
|
|
def graphql_describe_enum_value(_), do: nil
|
|
end
|
|
```
|
|
"""
|
|
@callback graphql_describe_enum_value(atom) :: String.t() | nil
|
|
|
|
@optional_callbacks graphql_type: 1,
|
|
graphql_input_type: 1,
|
|
graphql_rename_value: 1,
|
|
graphql_unnested_unions: 1,
|
|
graphql_describe_enum_value: 1,
|
|
graphql_define_type?: 1
|
|
end
|