@spec connection_from_result({[any()], Flop.Meta.t()}, [Flop.option()]) ::
  connection()

Takes the query results returned by Flop.run/3, Flop.validate_and_run/3 or Flop.validate_and_run!/3 and turns them into the Relay connection format.

example

Example

iex> flop = %Flop{order_by: [:name]}
iex> meta = %Flop.Meta{flop: flop, start_cursor: "a", end_cursor: "b"}
iex> result = {[%Flop.Fruit{name: "Apple", family: "Rosaceae"}], meta}
iex> Flop.Relay.connection_from_result(result)
%{
  edges: [
    %{
      cursor: "g3QAAAABZAAEbmFtZW0AAAAFQXBwbGU=",
      node: %Flop.Fruit{family: "Rosaceae", id: nil, name: "Apple"}
    }
  ],
  page_info: %{
    end_cursor: "b",
    has_next_page: false,
    has_previous_page: false,
    start_cursor: "a"
  }
}

See Flop.Relay.edges_from_result/2 for an example of adding additional fields to the edge.

options

Options

• :cursor_value_func: 2-arity function that takes an item from the query result and the order_by fields and returns the unencoded cursor value.

@spec edges_from_result({[{any(), any()}] | [any()], Flop.Meta.t()}, [Flop.option()]) ::
  [edge()]

Turns a list of query results into Relay edges.

simple-queries

Simple queries

If your query returns a list of maps or structs, the function will return the a list of edges with :cursor and :node as only fields.

iex> flop = %Flop{order_by: [:name]}
iex> meta = %Flop.Meta{flop: flop}
iex> result = {[%Flop.Fruit{name: "Apple", family: "Rosaceae"}], meta}
iex> Flop.Relay.edges_from_result(result)
[
  %{
    cursor: "g3QAAAABZAAEbmFtZW0AAAAFQXBwbGU=",
    node: %Flop.Fruit{name: "Apple", family: "Rosaceae"}
  }
]

supplying-additional-edge-information

Supplying additional edge information

If the query result is a list of 2-tuples, this is interpreted as a tuple of the node information and the edge information. For example, if you have a query like this:

Group
|> where([g], g.id == ^group_id)
|> join(:left, [g], m in assoc(g, :members))
|> select([g, m], {m, map(m, [:role])})

Then your query result looks something like:

[{%Member{id: 242, name: "Carl"}, %{role: :owner}}]

In this case, the members are the nodes, and the maps with the roles is seen as edge information.

[
  %{
    cursor: "AE98RNSTNGN",
    node: %Member{id: 242, name: "Carl"},
    role: :owner
  }
]

Note that in this case, the whole tuple will be passed to the cursor value function, so that the cursor can be based on both node and edge fields.

Here's an example with fruit that overrides the cursor value function:

iex> flop = %Flop{order_by: [:name]}
iex> meta = %Flop.Meta{flop: flop}
iex> items = [{%Flop.Fruit{name: "Apple"}, %{preparation:  :grated}}]
iex> func = fn {fruit, _edge}, order_by -> Map.take(fruit, order_by) end
iex> Flop.Relay.edges_from_result(
...>   {items, meta},
...>   cursor_value_func: func
...> )
[
  %{
    cursor: "g3QAAAABZAAEbmFtZW0AAAAFQXBwbGU=",
    node: %Flop.Fruit{name: "Apple"},
    preparation: :grated
  }
]

options

Options

• :cursor_value_func: 2-arity function that takes an item from the query result and the order_by fields and returns the unencoded cursor value.

@spec page_info_from_meta(Flop.Meta.t()) :: page_info()

Takes a Flop.Meta struct and returns a map with the Relay page info.

example

Example

iex> Flop.Relay.page_info_from_meta(%Flop.Meta{
...>    has_previous_page?: true,
...>    has_next_page?: true,
...>    start_cursor: "a",
...>    end_cursor: "b"
...> })
%{
  has_previous_page: true,
  has_next_page: true,
  start_cursor: "a",
  end_cursor: "b"
}