Pax.Adapter behaviour (Pax v0.0.1-dev.20251023)

View Source

Summary

Types

adapter_module()
callback_module()
criteria()
lookup()
opts()
socket()

A Phoenix.LiveView socket

t()
unsigned_params()

Unsigned params from a Phoenix.LiveView handle_params/3

Callbacks

change_object(opts, object, unsigned_params, fields)
config_spec(opts)

A function that returns a valid Pax.Config spec for configuration keys and types accepted by the adapter.

count_objects(opts, criteria)
create_object(opts, object, t)
default_fields(opts)
field_type(opts, field_name)
get_object(opts, lookup, criteria, socket)
id_fields(opts)
init(callback_module, opts)

The adapter initialization function, must return a map of initialized adapter state.

list_objects(opts, criteria)
merge_config(opts, config, socket)

A function that merges any additional configuration options into the adapter's opts map.

new_object(opts, socket)
object_ids(opts, object)
object_name(opts, object)
plural_name(opts)
singular_name(opts)
update_object(opts, object, t)

Functions

adapter?(arg1)
change_object(adapter, object, params, fields)
config_spec(adapter)
count_objects(adapter, criteria)
create_object(adapter, object, changeset)
default_fields(adapter)
field_type!(adapter, field_name)
get_object(adapter, lookup, criteria, socket)
id_fields(adapter)
init(adapter_module, callback_module, opts \\ [])
list_objects(adapter, criteria)
merge_config(adapter, config, socket)
new_object(adapter, socket)
object_ids(adapter, object)
object_name(adapter, object)
plural_name(adapter)
singular_name(adapter)
update_object(adapter, object, changeset)

Types

adapter_module()

@type adapter_module() :: module()

callback_module()

@type callback_module() :: module()

criteria()

@type criteria() :: %{required(atom()) => any()}

lookup()

@type lookup() :: %{required(atom()) => any()}

opts()

@type opts() ::
  binary()
  | tuple()
  | atom()
  | integer()
  | float()
  | [opts()]
  | %{optional(opts()) => opts()}
  | MapSet.t()

socket()

@type socket() :: Phoenix.LiveView.Socket.t()

A Phoenix.LiveView socket

t()

@type t() :: %Pax.Adapter{module: term(), opts: term()}

unsigned_params()

@type unsigned_params() :: Phoenix.LiveView.unsigned_params()

Unsigned params from a Phoenix.LiveView handle_params/3

Callbacks

change_object(opts, object, unsigned_params, fields)

@callback change_object(
  opts(),
  Pax.Interface.object(),
  unsigned_params(),
  fields :: [Pax.Field.t()]
) ::
  Ecto.Changeset.t()

config_spec(opts)

@callback config_spec(opts()) :: map()

A function that returns a valid Pax.Config spec for configuration keys and types accepted by the adapter.

count_objects(opts, criteria)

@callback count_objects(opts(), criteria()) :: integer()

create_object(opts, object, t)

@callback create_object(opts(), Pax.Interface.object(), Ecto.Changeset.t()) ::
  {:ok, map()} | {:error, Ecto.Changeset.t()}

default_fields(opts)

@callback default_fields(opts()) :: Pax.Index.fields()

field_type(opts, field_name)

@callback field_type(opts(), field_name :: atom()) ::
  {:ok, atom() | module()} | {:error, term()}

get_object(opts, lookup, criteria, socket)

@callback get_object(opts(), lookup(), criteria(), socket()) :: Pax.Interface.object()

id_fields(opts)

@callback id_fields(opts()) :: [atom()] | nil

init(callback_module, opts)

@callback init(callback_module(), opts :: []) :: opts()

The adapter initialization function, must return a map of initialized adapter state.

list_objects(opts, criteria)

@callback list_objects(opts(), criteria()) :: [Pax.Interface.object()]

merge_config(opts, config, socket)

@callback merge_config(opts(), config :: map(), socket()) :: map()

A function that merges any additional configuration options into the adapter's opts map.

new_object(opts, socket)

@callback new_object(opts(), socket()) :: Pax.Interface.object()

object_ids(opts, object)

@callback object_ids(opts(), Pax.Interface.object()) :: [String.Chars.t()] | nil

object_name(opts, object)

@callback object_name(opts(), Pax.Interface.object()) :: String.t() | nil

plural_name(opts)

@callback plural_name(opts()) :: String.t()

singular_name(opts)

@callback singular_name(opts()) :: String.t()

update_object(opts, object, t)

@callback update_object(opts(), Pax.Interface.object(), Ecto.Changeset.t()) ::
  {:ok, map()} | {:error, Ecto.Changeset.t()}

Functions

adapter?(arg1)

@spec adapter?(term()) :: boolean()

change_object(adapter, object, params, fields)

@spec change_object(
  t(),
  Pax.Interface.object(),
  unsigned_params(),
  fields :: [Pax.Field.t()]
) ::
  Ecto.Changeset.t()

config_spec(adapter)

@spec config_spec(t()) :: map()

count_objects(adapter, criteria)

@spec count_objects(t(), criteria()) :: integer()

create_object(adapter, object, changeset)

default_fields(adapter)

@spec default_fields(t()) :: Pax.Index.fields()

field_type!(adapter, field_name)

@spec field_type!(t(), field_name :: atom()) :: atom()

get_object(adapter, lookup, criteria, socket)

@spec get_object(t(), lookup(), criteria(), socket()) :: Pax.Interface.object()

id_fields(adapter)

@spec id_fields(t()) :: [atom()] | nil

init(adapter_module, callback_module, opts \\ [])

list_objects(adapter, criteria)

@spec list_objects(t(), criteria()) :: [Pax.Interface.object()]

merge_config(adapter, config, socket)

new_object(adapter, socket)

@spec new_object(t(), socket()) :: Pax.Interface.object()

object_ids(adapter, object)

@spec object_ids(t(), Pax.Interface.object()) :: [String.Chars.t()]

object_name(adapter, object)

@spec object_name(t(), Pax.Interface.object()) :: String.t() | nil

plural_name(adapter)

@spec plural_name(t()) :: String.t() | nil

singular_name(adapter)

@spec singular_name(t()) :: String.t() | nil

update_object(adapter, object, changeset)

@spec update_object(t(), Pax.Interface.object(), Ecto.Changeset.t()) ::
  {:ok, any()} | {:error, Ecto.Changeset.t()}
@spec update_object(t(), Pax.Interface.object(), Ecto.Changeset.t()) ::
  {:ok, any()} | {:error, Ecto.Changeset.t()}