Packages

supabase_potion

0.6.1
1.0.0 0.8.0 0.7.2 0.7.1 0.7.0 0.6.2 0.6.1 retired 0.6.0 0.5.1 0.5.0 0.4.1 0.4.0 0.3.7 0.3.6 0.3.5 0.3.4 0.3.3 0.3.2 0.3.1 0.3.0 0.2.3 0.2.2 0.2.1 0.2.0 0.1.0 retired

Complete Elixir client for Supabase.

Retired package: Release invalid - Regression on not sending the x-api-key header on supabase requests
HexDocs

Current section

Files

Jump to
Readme
25 Versions
4 Dependencies
Dependants
Files
Activity
supabase_potion lib supabase client behaviour.ex
Raw

lib/supabase/client/behaviour.ex 

defmodule Supabase.Client.Behaviour do

  @moduledoc """

  The behaviour for the Supabase Client. This behaviour is used to define the API for a Supabase Client.



  If you're implementing a [Self Managed Client](https://github.com/zoedsoupe/supabase-ex?tab=readme-ov-file#self-managed-clients) as the [Supabase.Client](https://hexdocs.pm/supabase_potion/Supabase.Client.html), this behaviour is already implemented for you.



  If you're implementing a [One Off Client](https://github.com/zoedsoupe/supabase-ex?tab=readme-ov-file#one-off-clients) as the [Supabase.Client](https://hexdocs.pm/supabase_potion/Supabase.Client.html), you need to implement this behaviour in case you want to use the integration with [Supabase.GoTrue](https://hexdocs.pm/supabase_gotrue/readme.html) for [Plug](https://hexdocs.pm/plug) based application or [Phoenix.LiveView](https://hexdocs.pm/phoenix_live_view) applications.

  """



  alias Supabase.Client



  @callback init :: {:ok, Client.t()} | {:error, Ecto.Changeset.t()}

  @callback get_client :: {:ok, Client.t()} | {:error, :not_found}

  @callback get_client(pid | atom) :: {:ok, Client.t()} | {:error, :not_found}

  @callback set_auth(pid | atom, access_token :: String.t()) :: :ok



  @optional_callbacks get_client: 0, get_client: 1, set_auth: 2

end