Supabase

newtype UserId

Instances

• Newtype UserId _
• Show UserId
• Eq UserId
• Ord UserId
• WriteForeign UserId
• ReadForeign UserId

type User = { app_metadata :: Foreign, aud :: String, created_at :: Timestamp, email :: UserEmail, id :: UserId, role :: String, updated_at :: Timestamp, user_metadata :: Foreign }

type SignInWithOAuthOptions :: Row Typetype SignInWithOAuthOptions = (options :: { queryParams :: Foreign, redirectTo :: String, scopes :: String }, provider :: OAuthProvider)

type Session = { access_token :: AccessToken, expires_at :: Int, expires_in :: Int, refresh_token :: RefreshToken, token_type :: String, user :: User }

type FunctionResponse d = { data :: Maybe d, error :: Maybe { message :: String } }

type AuthResult = { session :: Maybe Session, user :: Maybe User }

type AuthResponse = { data :: AuthResult, error :: Maybe AuthError }

type AuthError = { message :: String, status :: Maybe Int }

verifyPhoneOtp :: { phone :: UserPhone, token :: OTPToken, type :: OTPType } -> Client -> Aff AuthResponse

verifyEmailOtp :: { email :: UserEmail, token :: OTPToken, type :: OTPType } -> Client -> Aff AuthResponse

updateUser :: forall r. WriteForeign (Record r) => Record r -> Client -> Aff AuthResponse

signUpWithPhone :: { password :: UserPassword, phone :: UserPhone } -> Client -> Aff AuthResponse

signUpWithEmail :: { email :: UserEmail, password :: UserPassword } -> Client -> Aff AuthResponse

signOut :: Client -> Aff { error :: Maybe AuthError }

signInWithSSO :: { domain :: SSODomain } -> Client -> Aff { data :: { url :: Maybe String }, error :: Maybe AuthError }

signInWithPhone :: { password :: UserPassword, phone :: UserPhone } -> Client -> Aff AuthResponse

signInWithOAuth :: forall opts thru. Union opts thru SignInWithOAuthOptions => WriteForeign (Record opts) => Record opts -> Client -> Aff { data :: { provider :: OAuthProvider, url :: Maybe String }, error :: Maybe AuthError }

signInWithIdToken :: { provider :: OAuthProvider, token :: IdToken } -> Client -> Aff AuthResponse

signInWithEmail :: { email :: UserEmail, password :: UserPassword } -> Client -> Aff AuthResponse

signInAnonymously :: Client -> Aff AuthResponse

setSession :: { access_token :: AccessToken, refresh_token :: RefreshToken } -> Client -> Aff AuthResponse

sendOtpToPhone :: { phone :: UserPhone } -> Client -> Aff AuthResponse

sendOtpToEmail :: { email :: UserEmail } -> Client -> Aff AuthResponse

resetPasswordForEmail :: UserEmail -> Client -> Aff { error :: Maybe AuthError }

removeChannel :: Channel -> Client -> Effect Unit

removeAllChannels :: Client -> Effect Unit

refreshSession :: Client -> Aff AuthResponse

reauthenticate :: Client -> Aff { error :: Maybe AuthError }

onAuthStateChange :: (Maybe Session -> Effect Unit) -> Client -> Effect { data :: { subscription :: { id :: String, unsubscribe :: Effect Unit } } }

invoke :: forall t body headers. ReadForeign t => WriteForeign body => WriteForeign headers => FunctionName -> body -> headers -> Client -> Aff (FunctionResponse t)

getUser :: Client -> Aff { data :: { user :: Maybe User }, error :: Maybe AuthError }

getSession :: Client -> Aff { data :: { session :: Maybe Session }, error :: Maybe AuthError }

getChannels :: Client -> Effect (Array Channel)

functionsSetAuth :: AccessToken -> Client -> Effect Unit

exchangeCodeForSession :: AuthCode -> Client -> Aff AuthResponse

channel :: ChannelName -> Client -> Effect Channel

type ClientOptions :: Row Type -> Typetype ClientOptions r = { cookieOptions :: Maybe CookieOptions, options :: Maybe Options, supabaseKey :: Maybe String, supabaseUrl :: Maybe String | r }

createClient :: SupabaseUrl -> SupabaseAnonKey -> Effect Client

createBrowserClientWithOptions :: forall r. WriteForeign (ClientOptions r) => ClientOptions r -> Effect Client

createBrowserClient :: SupabaseUrl -> SupabaseAnonKey -> Effect Client

newtype FilterOp

newtype Condition :: Row Type -> Typenewtype Condition (table :: Row Type)

class ToPostgrest a 

Instances

• ToPostgrest String
• ToPostgrest Int
• ToPostgrest Number
• ToPostgrest Boolean

neqOp :: forall a. ToPostgrest a => a -> FilterOp

neqC :: forall @col colType filterType table rest. IsSymbol col => Cons col colType rest table => FilterVal colType filterType => ToPostgrest filterType => filterType -> Condition table

lteOp :: forall a. ToPostgrest a => a -> FilterOp

lteC :: forall @col colType filterType table rest. IsSymbol col => Cons col colType rest table => FilterVal colType filterType => ToPostgrest filterType => filterType -> Condition table

ltOp :: forall a. ToPostgrest a => a -> FilterOp

ltC :: forall @col colType filterType table rest. IsSymbol col => Cons col colType rest table => FilterVal colType filterType => ToPostgrest filterType => filterType -> Condition table

likeOp :: String -> FilterOp

likeC :: forall @col colType filterType table rest. IsSymbol col => Cons col colType rest table => FilterVal colType filterType => ToPostgrest filterType => filterType -> Condition table

isTrue :: FilterOp

isNullC :: forall @col colType table rest. IsSymbol col => Cons col colType rest table => Condition table

isNull :: FilterOp

isFalse :: FilterOp

ilikeOp :: String -> FilterOp

ilikeC :: forall @col colType filterType table rest. IsSymbol col => Cons col colType rest table => FilterVal colType filterType => ToPostgrest filterType => filterType -> Condition table

gteOp :: forall a. ToPostgrest a => a -> FilterOp

gteC :: forall @col colType filterType table rest. IsSymbol col => Cons col colType rest table => FilterVal colType filterType => ToPostgrest filterType => filterType -> Condition table

gtOp :: forall a. ToPostgrest a => a -> FilterOp

gtC :: forall @col colType filterType table rest. IsSymbol col => Cons col colType rest table => FilterVal colType filterType => ToPostgrest filterType => filterType -> Condition table

eqOp :: forall a. ToPostgrest a => a -> FilterOp

eqC :: forall @col colType filterType table rest. IsSymbol col => Cons col colType rest table => FilterVal colType filterType => ToPostgrest filterType => filterType -> Condition table

data RealtimeResponse

Constructors

• SendingOK
• SendingTimedOut
• SendingRateLimited

untrack :: Channel -> Aff RealtimeResponse

unsubscribe :: Channel -> Aff Unit

track :: forall payload. WriteForeign (Record payload) => Record payload -> Channel -> Aff RealtimeResponse

teardown :: Channel -> Aff Unit

subscribe :: Milliseconds -> (RealtimeSubscribeState -> Maybe Error -> Effect Unit) -> Channel -> Effect Unit

send :: forall i. WriteForeign (Record i) => Record i -> Channel -> Aff RealtimeResponse

presenceState :: Channel -> Effect Foreign

on :: forall f cbi. WriteForeign f => ReadForeign cbi => RealtimeListenType -> f -> (cbi -> Effect Unit) -> Channel -> Effect Unit

type CookieWithOptions = { name :: CookieName, options :: CookieOptions, value :: CookieValue }

type CookieOptions = { domain :: Maybe String, httpOnly :: Maybe Boolean, maxAge :: Maybe Seconds, path :: Maybe String, sameSite :: Maybe String, secure :: Maybe Boolean }

type CookieMethods = { getAll :: Effect (Array Cookie), setAll :: Array CookieWithOptions -> Effect Unit }

type Cookie = { name :: CookieName, value :: CookieValue }

serializeCookieHeader :: CookieName -> CookieValue -> CookieOptions -> Effect String

parseCookieHeader :: String -> Array Cookie

createServerClient :: SupabaseUrl -> SupabaseAnonKey -> CookieMethods -> Effect Client

data StorageBucket

data Storage

type ListOptionsR :: Row Typetype ListOptionsR = (limit :: Int, offset :: Int, sortBy :: { column :: String, order :: String })

type ListOptions = { limit :: Int, offset :: Int, sortBy :: { column :: String, order :: String } }

type FileOptions = { upsert :: Boolean }

upload :: StoragePath -> File -> FileOptions -> StorageBucket -> Aff (Response { path :: String })

storage :: Client -> Storage

remove :: Array StoragePath -> StorageBucket -> Aff { error :: Maybe ResultError }

move :: StoragePath -> StoragePath -> StorageBucket -> Aff { error :: Maybe ResultError }

list :: forall opts thru. WriteForeign (Record opts) => Union opts thru ListOptionsR => StoragePath -> Record opts -> StorageBucket -> Aff { data :: Maybe (Array { id :: Maybe String, name :: String }), error :: Maybe ResultError }

getPublicUrl :: StoragePath -> StorageBucket -> String

fromStorage :: BucketName -> Client -> StorageBucket

exists :: StoragePath -> StorageBucket -> Aff { data :: Boolean, error :: Maybe ResultError }

download :: StoragePath -> StorageBucket -> Aff (Response Blob)

createSignedUrls :: Array StoragePath -> Seconds -> StorageBucket -> Aff (Response (Array { error :: Maybe String, path :: String, signedUrl :: String }))

createSignedUrl :: StoragePath -> Seconds -> StorageBucket -> Aff (Response { signedUrl :: String })

copy :: StoragePath -> StoragePath -> StorageBucket -> Aff { error :: Maybe ResultError }

data TextSearchType

Constructors

• Plain
• Phrase
• Websearch

type StatusR :: Row Type -> Row Typetype StatusR r = (status :: Int | r)

type ResultError = { code :: Maybe String, details :: Maybe String, message :: String }

type Response d = Record (DataR d) + ErrorR + StatusR + ()

data QueryBuilder :: Row Type -> Row Type -> Typedata QueryBuilder t0 t1

type OrderOptions = { ascending :: Boolean, nullsFirst :: Boolean }

data IsValue

Constructors

• IsNull
• IsTrue
• IsFalse

data FilterBuilder :: Row Type -> Row Type -> Typedata FilterBuilder t0 t1

type ErrorR :: Row Type -> Row Typetype ErrorR r = (error :: Maybe ResultError | r)

type DataR :: Type -> Row Type -> Row Typetype DataR d r = (data :: Maybe d | r)

type CountResponse t = Record (DataR t) + ErrorR + CountR + StatusR + ()

type CountR :: Row Type -> Row Typetype CountR r = (count :: Int | r)

data Count

Constructors

• Exact
• Planned
• Estimated

upsertWith :: forall row rels d rest. WriteForeign (Record d) => Union d rest row => Record d -> UpsertOptions -> QueryBuilder row rels -> FilterBuilder row row

upsert :: forall row rels @d rest. WriteForeign (Record d) => Union d rest row => Record d -> QueryBuilder row rels -> FilterBuilder row row

update :: forall row rels d rest. WriteForeign (Record d) => Union d rest row => Record d -> QueryBuilder row rels -> FilterBuilder row row

textSearch :: forall @col colType filterType table result rest. IsSymbol col => Cons col colType rest table => FilterType colType filterType => WriteForeign filterType => filterType -> { config :: String, type :: TextSearchType } -> FilterBuilder table result -> FilterBuilder table result

singleWith :: forall @t table result. ReadForeign t => FilterBuilder table result -> Aff (Response t)

single :: forall table result. ReadForeign (Record result) => FilterBuilder table result -> Aff (Response (Record result))

selectColumnsWithCount :: forall @cols row rels result. IsSymbol cols => ParseSelect cols row rels result => Count -> QueryBuilder row rels -> FilterBuilder row result

selectColumns :: forall @cols row rels result. IsSymbol cols => ParseSelect cols row rels result => QueryBuilder row rels -> FilterBuilder row result

select :: forall row rels. QueryBuilder row rels -> FilterBuilder row row

schema :: SchemaName -> Client -> Client

runWith :: forall @t table result. ReadForeign t => FilterBuilder table result -> Aff (Response t)

run :: forall table result. ReadForeign (Record result) => FilterBuilder table result -> Aff (Response (Array (Record result)))

range :: forall table result. ReadForeign (Record result) => { from :: Int, to :: Int } -> FilterBuilder table result -> Aff (Response (Array (Record result)))

overlaps :: forall @col colType filterType table result rest. IsSymbol col => Cons col colType rest table => FilterType colType filterType => WriteForeign filterType => filterType -> FilterBuilder table result -> FilterBuilder table result

orderWith :: forall @col val table result rest. IsSymbol col => Cons col val rest table => OrderOptions -> FilterBuilder table result -> FilterBuilder table result

order :: forall @col val table result rest. IsSymbol col => Cons col val rest table => FilterBuilder table result -> FilterBuilder table result

or :: forall table result. NonEmptyArray (Condition table) -> FilterBuilder table result -> FilterBuilder table result

not_ :: forall @col colType table result rest. IsSymbol col => Cons col colType rest table => FilterOp -> FilterBuilder table result -> FilterBuilder table result

neq :: forall @col colType filterType table result rest. IsSymbol col => Cons col colType rest table => FilterType colType filterType => WriteForeign filterType => filterType -> FilterBuilder table result -> FilterBuilder table result

maybeSingleWith :: forall @t table result. ReadForeign t => FilterBuilder table result -> Aff (Response t)

maybeSingle :: forall table result. ReadForeign (Record result) => FilterBuilder table result -> Aff (Response (Record result))

lte :: forall @col colType filterType table result rest. IsSymbol col => Cons col colType rest table => FilterType colType filterType => WriteForeign filterType => filterType -> FilterBuilder table result -> FilterBuilder table result

lt :: forall @col colType filterType table result rest. IsSymbol col => Cons col colType rest table => FilterType colType filterType => WriteForeign filterType => filterType -> FilterBuilder table result -> FilterBuilder table result

limit :: forall table result. Int -> FilterBuilder table result -> FilterBuilder table result

like :: forall @col colType filterType table result rest. IsSymbol col => Cons col colType rest table => FilterType colType filterType => WriteForeign filterType => filterType -> FilterBuilder table result -> FilterBuilder table result

is :: forall @col colType table result rest. IsSymbol col => Cons col colType rest table => IsValue -> FilterBuilder table result -> FilterBuilder table result

insertInto :: forall row required rels @d rest reqRest. WriteForeign (Record d) => Union d rest row => Union required reqRest d => Table row required rels -> Record d -> Client -> FilterBuilder row row

insert :: forall row rels @d rest. WriteForeign (Record d) => Union d rest row => Record d -> QueryBuilder row rels -> FilterBuilder row row

in_ :: forall @col colType filterType table result rest. IsSymbol col => Cons col colType rest table => FilterType colType filterType => WriteForeign filterType => NonEmptyArray filterType -> FilterBuilder table result -> FilterBuilder table result

ilike :: forall @col colType filterType table result rest. IsSymbol col => Cons col colType rest table => FilterType colType filterType => WriteForeign filterType => filterType -> FilterBuilder table result -> FilterBuilder table result

gte :: forall @col colType filterType table result rest. IsSymbol col => Cons col colType rest table => FilterType colType filterType => WriteForeign filterType => filterType -> FilterBuilder table result -> FilterBuilder table result

gt :: forall @col colType filterType table result rest. IsSymbol col => Cons col colType rest table => FilterType colType filterType => WriteForeign filterType => filterType -> FilterBuilder table result -> FilterBuilder table result

from :: forall row required rels. Table row required rels -> Client -> QueryBuilder row rels

eq_ :: forall @col colType filterType table result rest. IsSymbol col => Cons col colType rest table => FilterType colType filterType => WriteForeign filterType => filterType -> FilterBuilder table result -> FilterBuilder table result

delete :: forall row rels. QueryBuilder row rels -> FilterBuilder row row

csv :: forall table result. FilterBuilder table result -> FilterBuilder table result

contains :: forall @col colType filterType table result rest. IsSymbol col => Cons col colType rest table => FilterType colType filterType => WriteForeign filterType => filterType -> FilterBuilder table result -> FilterBuilder table result

containedBy :: forall @col colType filterType table result rest. IsSymbol col => Cons col colType rest table => FilterType colType filterType => WriteForeign filterType => filterType -> FilterBuilder table result -> FilterBuilder table result

callRpcWith :: forall params result. WriteForeign (Record params) => Rpc params result -> Record params -> Client -> FilterBuilder result result

callRpc :: forall params result. Rpc params result -> Client -> FilterBuilder result result

newtype Table :: Row Type -> Row Type -> Row Type -> Typenewtype Table row required relations

newtype SupabaseUrl

Constructors

• SupabaseUrl String

Instances

• Newtype SupabaseUrl _
• Eq SupabaseUrl
• Show SupabaseUrl

newtype SupabaseAnonKey

Constructors

• SupabaseAnonKey String

Instances

• Newtype SupabaseAnonKey _
• Eq SupabaseAnonKey
• Show SupabaseAnonKey

newtype StoragePath

Constructors

• StoragePath String

Instances

• Newtype StoragePath _
• Eq StoragePath
• Show StoragePath

newtype SchemaName

Instances

• Newtype SchemaName _
• Eq SchemaName
• Show SchemaName

newtype Rpc :: Row Type -> Row Type -> Typenewtype Rpc params result

data Rel :: Row Type -> Row Type -> Typedata Rel row rels

newtype FunctionName

Instances

• Newtype FunctionName _
• Eq FunctionName
• Show FunctionName

data Client

newtype ChannelName

Instances

• Newtype ChannelName _
• Eq ChannelName
• Show ChannelName

newtype BucketName

Instances

• Newtype BucketName _
• Eq BucketName
• Show BucketName

mkTable :: forall row required relations. String -> Table row required relations

mkRpc :: forall params result. String -> Rpc params result

newtype UUID

Instances

• Newtype UUID _
• Eq UUID
• Ord UUID
• Show UUID
• WriteForeign UUID
• ReadForeign UUID

toError :: NonEmptyList ForeignError -> Error

fromJSON :: forall json m. MonadThrow Error m => ReadForeign json => Foreign -> m json

fromEither :: forall t m. MonadThrow Error m => Either Error t -> m t