AccrueAdmin.Queries.Behaviour behaviour (accrue_admin v1.0.0)

Shared contract and helpers for admin list queries.

Summary

filter()

opts()

row()

list(opts)

@type filter() :: map()

@type opts() :: keyword()

@type row() :: map()

@callback count_newer_than(opts()) :: non_neg_integer()

@callback decode_filter(map()) :: filter()

@callback encode_filter(filter()) :: map()

@callback list(opts()) :: {[row()], binary() | nil}

@spec apply_cursor(
  Ecto.Queryable.t(),
  atom(),
  AccrueAdmin.Queries.Cursor.value() | nil
) ::
  Ecto.Query.t()

@spec compact_filter(map()) :: map()

@spec count_newer(
  Ecto.Queryable.t(),
  atom(),
  AccrueAdmin.Queries.Cursor.value() | nil
) ::
  Ecto.Query.t()

@spec decode_cursor(keyword()) :: AccrueAdmin.Queries.Cursor.value() | nil

@spec normalize_limit(keyword()) :: pos_integer()

@spec normalize_string(term()) :: binary() | nil

@spec paginate([map()], pos_integer(), atom()) :: {[map()], binary() | nil}

@spec parse_boolean(term()) :: boolean() | nil