Safe Haskell	Safe-Inferred
Language	GHC2021

WikiMusic.Model.Auth

Synopsis

data WikiMusicUser = WikiMusicUser {
- identifier :: UUID
- displayName :: Text
- emailAddress :: Text
- passwordHash :: Maybe Text
- authToken :: Maybe Text
- roles :: [UserRole]
}
data LoginRequest = LoginRequest {
- wikimusicEmail :: String
- wikimusicPassword :: String
}
data UserRole
- = SuperUser
- | Maintainer
- | LowRank
- | Demo
isAtLeastDemo :: [UserRole] -> Bool
isAtLeastMaintainer :: [UserRole] -> Bool
isAtLeastSuperUser :: [UserRole] -> Bool
isAtLeastLowRank :: [UserRole] -> Bool
doWithRoles :: Applicative f => t -> (t -> Bool) -> p -> f (Either p b) -> f (Either p b)
doWithRoles' :: Applicative f => WikiMusicUser -> ([UserRole] -> Bool) -> p -> f (Either p b) -> f (Either p b)
show :: Show a => a -> String
read :: Read a => String -> a

Documentation

data WikiMusicUser Source #

Constructors

WikiMusicUser
Fields identifier :: UUID displayName :: Text emailAddress :: Text passwordHash :: Maybe Text authToken :: Maybe Text roles :: [UserRole]

Instances

Instances details

FromJSON WikiMusicUser Source #
Instance details Defined in WikiMusic.Model.Auth Methods parseJSON :: Value -> Parser WikiMusicUser # parseJSONList :: Value -> Parser [WikiMusicUser] # omittedField :: Maybe WikiMusicUser #
ToJSON WikiMusicUser Source #
Instance details Defined in WikiMusic.Model.Auth Methods toJSON :: WikiMusicUser -> Value # toEncoding :: WikiMusicUser -> Encoding # toJSONList :: [WikiMusicUser] -> Value # toEncodingList :: [WikiMusicUser] -> Encoding # omitField :: WikiMusicUser -> Bool #
Generic WikiMusicUser Source #
Instance details Defined in WikiMusic.Model.Auth Associated Types type Rep WikiMusicUser :: Type -> Type # Methods from :: WikiMusicUser -> Rep WikiMusicUser x # to :: Rep WikiMusicUser x -> WikiMusicUser #
Read WikiMusicUser Source #
Instance details Defined in WikiMusic.Model.Auth Methods readsPrec :: Int -> ReadS WikiMusicUser # readList :: ReadS [WikiMusicUser] # readPrec :: ReadPrec WikiMusicUser # readListPrec :: ReadPrec [WikiMusicUser] #
Show WikiMusicUser Source #
Instance details Defined in WikiMusic.Model.Auth Methods showsPrec :: Int -> WikiMusicUser -> ShowS # show :: WikiMusicUser -> String # showList :: [WikiMusicUser] -> ShowS #
Eq WikiMusicUser Source #
Instance details Defined in WikiMusic.Model.Auth Methods (==) :: WikiMusicUser -> WikiMusicUser -> Bool # (/=) :: WikiMusicUser -> WikiMusicUser -> Bool #
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "authToken" k WikiMusicUser WikiMusicUser a b Source #
Instance details Defined in WikiMusic.Model.Auth Methods labelOptic :: Optic k NoIx WikiMusicUser WikiMusicUser a b #
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "displayName" k WikiMusicUser WikiMusicUser a b Source #
Instance details Defined in WikiMusic.Model.Auth Methods labelOptic :: Optic k NoIx WikiMusicUser WikiMusicUser a b #
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "emailAddress" k WikiMusicUser WikiMusicUser a b Source #
Instance details Defined in WikiMusic.Model.Auth Methods labelOptic :: Optic k NoIx WikiMusicUser WikiMusicUser a b #
(k ~ A_Lens, a ~ UUID, b ~ UUID) => LabelOptic "identifier" k WikiMusicUser WikiMusicUser a b Source #
Instance details Defined in WikiMusic.Model.Auth Methods labelOptic :: Optic k NoIx WikiMusicUser WikiMusicUser a b #
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "passwordHash" k WikiMusicUser WikiMusicUser a b Source #
Instance details Defined in WikiMusic.Model.Auth Methods labelOptic :: Optic k NoIx WikiMusicUser WikiMusicUser a b #
(k ~ A_Lens, a ~ [UserRole], b ~ [UserRole]) => LabelOptic "roles" k WikiMusicUser WikiMusicUser a b Source #
Instance details Defined in WikiMusic.Model.Auth Methods labelOptic :: Optic k NoIx WikiMusicUser WikiMusicUser a b #
type Rep WikiMusicUser Source #
Instance details Defined in WikiMusic.Model.Auth type Rep WikiMusicUser = D1 ('MetaData "WikiMusicUser" "WikiMusic.Model.Auth" "wikimusic-model-hs-1.2.0.0-2AFmU6Rx8U3ctQHH6pLAk" 'False) (C1 ('MetaCons "WikiMusicUser" 'PrefixI 'True) ((S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UUID) :: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :: (S1 ('MetaSel ('Just "passwordHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "authToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UserRole])))))

data LoginRequest Source #

Constructors

LoginRequest
Fields wikimusicEmail :: String wikimusicPassword :: String

Instances

Instances details

FromJSON LoginRequest Source #
Instance details Defined in WikiMusic.Model.Auth Methods parseJSON :: Value -> Parser LoginRequest # parseJSONList :: Value -> Parser [LoginRequest] # omittedField :: Maybe LoginRequest #
ToJSON LoginRequest Source #
Instance details Defined in WikiMusic.Model.Auth Methods toJSON :: LoginRequest -> Value # toEncoding :: LoginRequest -> Encoding # toJSONList :: [LoginRequest] -> Value # toEncodingList :: [LoginRequest] -> Encoding # omitField :: LoginRequest -> Bool #
Generic LoginRequest Source #
Instance details Defined in WikiMusic.Model.Auth Associated Types type Rep LoginRequest :: Type -> Type # Methods from :: LoginRequest -> Rep LoginRequest x # to :: Rep LoginRequest x -> LoginRequest #
Read LoginRequest Source #
Instance details Defined in WikiMusic.Model.Auth Methods readsPrec :: Int -> ReadS LoginRequest # readList :: ReadS [LoginRequest] # readPrec :: ReadPrec LoginRequest # readListPrec :: ReadPrec [LoginRequest] #
Show LoginRequest Source #
Instance details Defined in WikiMusic.Model.Auth Methods showsPrec :: Int -> LoginRequest -> ShowS # show :: LoginRequest -> String # showList :: [LoginRequest] -> ShowS #
Eq LoginRequest Source #
Instance details Defined in WikiMusic.Model.Auth Methods (==) :: LoginRequest -> LoginRequest -> Bool # (/=) :: LoginRequest -> LoginRequest -> Bool #
ToSchema LoginRequest Source #
Instance details Defined in WikiMusic.Model.Auth Methods declareNamedSchema :: Proxy LoginRequest -> Declare (Definitions Schema) NamedSchema #
(k ~ A_Lens, a ~ String, b ~ String) => LabelOptic "wikimusicEmail" k LoginRequest LoginRequest a b Source #
Instance details Defined in WikiMusic.Model.Auth Methods labelOptic :: Optic k NoIx LoginRequest LoginRequest a b #
(k ~ A_Lens, a ~ String, b ~ String) => LabelOptic "wikimusicPassword" k LoginRequest LoginRequest a b Source #
Instance details Defined in WikiMusic.Model.Auth Methods labelOptic :: Optic k NoIx LoginRequest LoginRequest a b #
type Rep LoginRequest Source #
Instance details Defined in WikiMusic.Model.Auth type Rep LoginRequest = D1 ('MetaData "LoginRequest" "WikiMusic.Model.Auth" "wikimusic-model-hs-1.2.0.0-2AFmU6Rx8U3ctQHH6pLAk" 'False) (C1 ('MetaCons "LoginRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "wikimusicEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "wikimusicPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

data UserRole Source #

Constructors

SuperUser
Maintainer
LowRank
Demo

Instances

Instances details

FromJSON UserRole Source #
Instance details Defined in WikiMusic.Model.Auth Methods parseJSON :: Value -> Parser UserRole # parseJSONList :: Value -> Parser [UserRole] # omittedField :: Maybe UserRole #
ToJSON UserRole Source #
Instance details Defined in WikiMusic.Model.Auth Methods toJSON :: UserRole -> Value # toEncoding :: UserRole -> Encoding # toJSONList :: [UserRole] -> Value # toEncodingList :: [UserRole] -> Encoding # omitField :: UserRole -> Bool #
Generic UserRole Source #
Instance details Defined in WikiMusic.Model.Auth Associated Types type Rep UserRole :: Type -> Type # Methods from :: UserRole -> Rep UserRole x # to :: Rep UserRole x -> UserRole #
Read UserRole Source #
Instance details Defined in WikiMusic.Model.Auth Methods readsPrec :: Int -> ReadS UserRole # readList :: ReadS [UserRole] # readPrec :: ReadPrec UserRole # readListPrec :: ReadPrec [UserRole] #
Show UserRole Source #
Instance details Defined in WikiMusic.Model.Auth Methods showsPrec :: Int -> UserRole -> ShowS # show :: UserRole -> String # showList :: [UserRole] -> ShowS #
Eq UserRole Source #
Instance details Defined in WikiMusic.Model.Auth Methods (==) :: UserRole -> UserRole -> Bool # (/=) :: UserRole -> UserRole -> Bool #
ToSchema UserRole Source #
Instance details Defined in WikiMusic.Model.Auth Methods declareNamedSchema :: Proxy UserRole -> Declare (Definitions Schema) NamedSchema #
type Rep UserRole Source #
Instance details Defined in WikiMusic.Model.Auth type Rep UserRole = D1 ('MetaData "UserRole" "WikiMusic.Model.Auth" "wikimusic-model-hs-1.2.0.0-2AFmU6Rx8U3ctQHH6pLAk" 'False) ((C1 ('MetaCons "SuperUser" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Maintainer" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "LowRank" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Demo" 'PrefixI 'False) (U1 :: Type -> Type)))

isAtLeastDemo :: [UserRole] -> Bool Source #

isAtLeastMaintainer :: [UserRole] -> Bool Source #

isAtLeastSuperUser :: [UserRole] -> Bool Source #

isAtLeastLowRank :: [UserRole] -> Bool Source #

doWithRoles :: Applicative f => t -> (t -> Bool) -> p -> f (Either p b) -> f (Either p b) Source #

doWithRoles' :: Applicative f => WikiMusicUser -> ([UserRole] -> Bool) -> p -> f (Either p b) -> f (Either p b) Source #

show :: Show a => a -> String #

A specialised variant of showsPrec, using precedence context zero, and returning an ordinary String.

read :: Read a => String -> a #

The read function reads input from a string, which must be completely consumed by the input process. read fails with an error if the parse is unsuccessful, and it is therefore discouraged from being used in real applications. Use readMaybe or readEither for safe alternatives.

>>> read "123" :: Int
123

>>> read "hello" :: Int
*** Exception: Prelude.read: no parse