Polysemy.Account

Effects

data Accounts i p :: Effect

This effect provides common operations for account and password management.

The first parameter is the ID type for both accounts and authentication data, which might be UUID or Int.

The second parameter encodes an accounts basic privileges, mainly used for API authorization.

type AccountsP i = Accounts i [Privilege]

Convenience alias for Accounts using the default Privilege type.

authenticate :: forall i p r. Member (Accounts i p) r => AccountName -> RawPassword -> Sem r (Uid i (AccountAuth i))

Check credentials against the storage backend.

generatePassword :: forall i p r. Member (Accounts i p) r => i -> Maybe Datetime -> Sem r GeneratedPassword

Generate a fresh password.

create :: forall i p r. Member (Accounts i p) r => AccountName -> Sem r (Uid i (Account p))

Add an account to the storage backend, without authentication.

finalizeCreate :: forall i p r. Member (Accounts i p) r => i -> Sem r (Uid i (Account p))

Mark an account as fully created.

addPassword :: forall i p r. Member (Accounts i p) r => i -> RawPassword -> Maybe Datetime -> Sem r (Uid i (AccountAuth i))

Associate an account with a new password, with optional expiry time.

setStatus :: forall i p r. Member (Accounts i p) r => i -> AccountStatus -> Sem r ()

Update the status of an account.

byId :: forall i p r. Member (Accounts i p) r => i -> Sem r (Uid i (Account p))

Look up an account by its ID.

byName :: forall i p r. Member (Accounts i p) r => AccountName -> Sem r (Uid i (Account p))

Look up an account by its name.

update :: forall i p r. Member (Accounts i p) r => Uid i (Account p) -> Sem r ()

Overwrite an existing account.

privileges :: forall i p r. Member (Accounts i p) r => i -> Sem r p

Look up an account's privileges.

updatePrivileges :: forall i p r. Member (Accounts i p) r => i -> (p -> p) -> Sem r ()

Update an account's privileges.

all :: forall i p r. Member (Accounts i p) r => Sem r [Uid i (Account p)]

Fetch all accounts.

allAuths :: forall i p r. Member (Accounts i p) r => Sem r [Uid i (AccountAuth i)]

Fetch all auth records.

data Password :: Effect

This effect provides password hashing, validation, and generation.

hash :: forall r. Member Password r => RawPassword -> Sem r HashedPassword

Hash a clear text password.

check :: forall r. Member Password r => RawPassword -> HashedPassword -> Sem r Bool

Validate a password against a hash.

generate :: forall r. Member Password r => Word -> Sem r GeneratedPassword

Generate a new clear text password of the specified length.

Interpreters

interpretAccounts :: forall e i p r. Show e => Member (Query AccountByName (Maybe (Uid i (Account p))) !! e) r => Member (Query (AuthForAccount i) [Uid i (AccountAuth i)] !! e) r => Members [Password, Store i (Account p) !! e, Store i (AccountAuth i) !! e, Reader (AccountsConfig p) !! e, Id i] r => InterpreterFor (Accounts i p !! AccountsError) r

Interpret Accounts using Store and Query from Polysemy.Db as the storage backend.

interpretAccountsState :: forall i p r. Ord i => Show i => Members [Log, Id i, Embed IO] r => AccountsConfig p -> [Uid i (Account p)] -> [Uid i (AccountAuth i)] -> InterpretersFor [Accounts i p !! AccountsError, Password] r

Interpret Accounts and Password using AtomicState as storage backend.

interpretPassword :: Member (Embed IO) r => InterpreterFor Password r

Interpret Password using the Argon2 algorithm and Data.Elocrypt-generated passwords.

interpretPasswordId :: InterpreterFor Password r

Interpret Password trivially, not performing any hashing and generating sequences of asterisks.

Misc combinators

register :: Member (Accounts i p) r => AccountCredentials -> Sem r (AuthedAccount i p)

Register an account with the given credentials.

Create the account in the storage backend, hash the password and store it, then mark the account as created.

login :: Member (Accounts i p) r => AccountCredentials -> Sem r (AuthedAccount i p)

Authenticate the given credentials against the storage backend and return the matched account's information.

unlockAccountName :: Members [Accounts i p, Stop AccountsError] r => AccountName -> Sem r ()

Convenience function for unlocking the account matching the given name.

Data types

data Account p

A basic user account, consisting of a name, activation status, and an arbitrary privilege type.

Constructors

Account

Fields

• name :: AccountName
• status :: AccountStatus
• privileges :: p

Instances

FromJSON p => FromJSON (Account p)

Defined in Polysemy.Account.Data.Account

Methods

parseJSON :: Value -> Parser (Account p)

parseJSONList :: Value -> Parser [Account p]

ToJSON p => ToJSON (Account p)

Defined in Polysemy.Account.Data.Account

Methods

toJSON :: Account p -> Value

toEncoding :: Account p -> Encoding

toJSONList :: [Account p] -> Value

toEncodingList :: [Account p] -> Encoding

Generic (Account p)

Defined in Polysemy.Account.Data.Account

Associated Types

type Rep (Account p) :: Type -> Type

Methods

from :: Account p -> Rep (Account p) x

to :: Rep (Account p) x -> Account p

Show p => Show (Account p)

Defined in Polysemy.Account.Data.Account

Methods

showsPrec :: Int -> Account p -> ShowS

show :: Account p -> String

showList :: [Account p] -> ShowS

Eq p => Eq (Account p)

Defined in Polysemy.Account.Data.Account

Methods

(==) :: Account p -> Account p -> Bool

(/=) :: Account p -> Account p -> Bool

type Rep (Account p)

Defined in Polysemy.Account.Data.Account

type Rep (Account p) = D1 ('MetaData "Account" "Polysemy.Account.Data.Account" "polysemy-account-0.2.0.0-JBrIF35CBfcBfeWmsi0YZS" 'False) (C1 ('MetaCons "Account" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AccountName) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AccountStatus) :*: S1 ('MetaSel ('Just "privileges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 p))))

data AuthedAccount i p

An account an the ID of the password used to authenticate it.

Constructors

AuthedAccount

Fields

• id :: i
• authId :: i
• name :: AccountName
• status :: AccountStatus
• privileges :: p

Instances

(FromJSON i, FromJSON p) => FromJSON (AuthedAccount i p)

Defined in Polysemy.Account.Data.AuthedAccount

Methods

parseJSON :: Value -> Parser (AuthedAccount i p)

parseJSONList :: Value -> Parser [AuthedAccount i p]

(ToJSON i, ToJSON p) => ToJSON (AuthedAccount i p)

Defined in Polysemy.Account.Data.AuthedAccount

Methods

toJSON :: AuthedAccount i p -> Value

toEncoding :: AuthedAccount i p -> Encoding

toJSONList :: [AuthedAccount i p] -> Value

toEncodingList :: [AuthedAccount i p] -> Encoding

Generic (AuthedAccount i p)

Defined in Polysemy.Account.Data.AuthedAccount

Associated Types

type Rep (AuthedAccount i p) :: Type -> Type

Methods

from :: AuthedAccount i p -> Rep (AuthedAccount i p) x

to :: Rep (AuthedAccount i p) x -> AuthedAccount i p

(Show i, Show p) => Show (AuthedAccount i p)

Defined in Polysemy.Account.Data.AuthedAccount

Methods

showsPrec :: Int -> AuthedAccount i p -> ShowS

show :: AuthedAccount i p -> String

showList :: [AuthedAccount i p] -> ShowS

(Eq i, Eq p) => Eq (AuthedAccount i p)

Defined in Polysemy.Account.Data.AuthedAccount

Methods

(==) :: AuthedAccount i p -> AuthedAccount i p -> Bool

(/=) :: AuthedAccount i p -> AuthedAccount i p -> Bool

type Rep (AuthedAccount i p)

Defined in Polysemy.Account.Data.AuthedAccount

type Rep (AuthedAccount i p) = D1 ('MetaData "AuthedAccount" "Polysemy.Account.Data.AuthedAccount" "polysemy-account-0.2.0.0-JBrIF35CBfcBfeWmsi0YZS" 'False) (C1 ('MetaCons "AuthedAccount" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 i) :*: S1 ('MetaSel ('Just "authId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 i)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AccountName) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AccountStatus) :*: S1 ('MetaSel ('Just "privileges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 p)))))

data AccountAuth i

A hashed password associated with an account.

Constructors

AccountAuth

Fields

• account :: i

  The account ID belonging to this password.

• description :: AccountAuthDescription

  A description of the password.

• password :: HashedPassword

  A password hash.

• expiry :: Maybe Datetime

  The date at which the password expires.

Instances

Generic (AccountAuth i)

Defined in Polysemy.Account.Data.AccountAuth

Associated Types

type Rep (AccountAuth i) :: Type -> Type

Methods

from :: AccountAuth i -> Rep (AccountAuth i) x

to :: Rep (AccountAuth i) x -> AccountAuth i

Show i => Show (AccountAuth i)

Defined in Polysemy.Account.Data.AccountAuth

Methods

showsPrec :: Int -> AccountAuth i -> ShowS

show :: AccountAuth i -> String

showList :: [AccountAuth i] -> ShowS

Eq i => Eq (AccountAuth i)

Defined in Polysemy.Account.Data.AccountAuth

Methods

(==) :: AccountAuth i -> AccountAuth i -> Bool

(/=) :: AccountAuth i -> AccountAuth i -> Bool

type Rep (AccountAuth i)

Defined in Polysemy.Account.Data.AccountAuth

type Rep (AccountAuth i) = D1 ('MetaData "AccountAuth" "Polysemy.Account.Data.AccountAuth" "polysemy-account-0.2.0.0-JBrIF35CBfcBfeWmsi0YZS" 'False) (C1 ('MetaCons "AccountAuth" 'PrefixI 'True) ((S1 ('MetaSel ('Just "account") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 i) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AccountAuthDescription)) :*: (S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashedPassword) :*: S1 ('MetaSel ('Just "expiry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Datetime)))))

data AccountsConfig p

The configuration for the interpreter for Accounts.

The defaults, when using Privilege, are:

• Length 20
• Don't activate accounts right away
• Web privileges

Constructors

AccountsConfig

Fields

• passwordLength :: Word

  Length of generated passwords.

• initActive :: Bool

  Whether new accounts should immediately be marked as active rather than pending, allowing login.

• defaultPrivileges :: p

  The privileges assigned to a new account.

Instances

FromJSON p => FromJSON (AccountsConfig p)

Defined in Polysemy.Account.Data.AccountsConfig

Methods

parseJSON :: Value -> Parser (AccountsConfig p)

parseJSONList :: Value -> Parser [AccountsConfig p]

ToJSON p => ToJSON (AccountsConfig p)

Defined in Polysemy.Account.Data.AccountsConfig

Methods

toJSON :: AccountsConfig p -> Value

toEncoding :: AccountsConfig p -> Encoding

toJSONList :: [AccountsConfig p] -> Value

toEncodingList :: [AccountsConfig p] -> Encoding

Generic (AccountsConfig p)

Defined in Polysemy.Account.Data.AccountsConfig

Associated Types

type Rep (AccountsConfig p) :: Type -> Type

Methods

from :: AccountsConfig p -> Rep (AccountsConfig p) x

to :: Rep (AccountsConfig p) x -> AccountsConfig p

Show p => Show (AccountsConfig p)

Defined in Polysemy.Account.Data.AccountsConfig

Methods

showsPrec :: Int -> AccountsConfig p -> ShowS

show :: AccountsConfig p -> String

showList :: [AccountsConfig p] -> ShowS

Default p => Default (AccountsConfig p)

Defined in Polysemy.Account.Data.AccountsConfig

Methods

def :: AccountsConfig p

Eq p => Eq (AccountsConfig p)

Defined in Polysemy.Account.Data.AccountsConfig

Methods

(==) :: AccountsConfig p -> AccountsConfig p -> Bool

(/=) :: AccountsConfig p -> AccountsConfig p -> Bool

type Rep (AccountsConfig p)

Defined in Polysemy.Account.Data.AccountsConfig

type Rep (AccountsConfig p) = D1 ('MetaData "AccountsConfig" "Polysemy.Account.Data.AccountsConfig" "polysemy-account-0.2.0.0-JBrIF35CBfcBfeWmsi0YZS" 'False) (C1 ('MetaCons "AccountsConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "passwordLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word) :*: (S1 ('MetaSel ('Just "initActive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "defaultPrivileges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 p))))

type AccountsConfigP = AccountsConfig [Privilege]

Convenience alias for using the default privilege type with AccountsConfig.

data AccountsError

Errors produced by the effect Accounts.

Constructors

Client AccountsClientError

Errors that indicate invalid client-supplied information.

Internal Text

Error indicating storage backend failure.

Instances

Show AccountsError

Defined in Polysemy.Account.Data.AccountsError

Methods

showsPrec :: Int -> AccountsError -> ShowS

show :: AccountsError -> String

showList :: [AccountsError] -> ShowS

Eq AccountsError

Defined in Polysemy.Account.Data.AccountsError

Methods

(==) :: AccountsError -> AccountsError -> Bool

(/=) :: AccountsError -> AccountsError -> Bool

data AccountsClientError

Errors that indicate invalid client-supplied information.

Constructors

NoAccountId

No account was found for the given ID.

InvalidAuth

Credentials did not match stored auth data.

NoAccountName

No account was found for the given name.

Conflict

Name given for registration already exists in storage.

Instances

FromJSON AccountsClientError

Defined in Polysemy.Account.Data.AccountsError

Methods

parseJSON :: Value -> Parser AccountsClientError

parseJSONList :: Value -> Parser [AccountsClientError]

ToJSON AccountsClientError

Defined in Polysemy.Account.Data.AccountsError

Methods

toJSON :: AccountsClientError -> Value

toEncoding :: AccountsClientError -> Encoding

toJSONList :: [AccountsClientError] -> Value

toEncodingList :: [AccountsClientError] -> Encoding

Show AccountsClientError

Defined in Polysemy.Account.Data.AccountsError

Methods

showsPrec :: Int -> AccountsClientError -> ShowS

show :: AccountsClientError -> String

showList :: [AccountsClientError] -> ShowS

Eq AccountsClientError

Defined in Polysemy.Account.Data.AccountsError

Methods

(==) :: AccountsClientError -> AccountsClientError -> Bool

(/=) :: AccountsClientError -> AccountsClientError -> Bool

data AccountCredentials

User-supplied credentials for login or registration.

Constructors

AccountCredentials

Fields

• username :: AccountName

  Account name.

• password :: RawPassword

  Account password.

Instances

FromJSON AccountCredentials

Defined in Polysemy.Account.Data.AccountCredentials

Methods

parseJSON :: Value -> Parser AccountCredentials

parseJSONList :: Value -> Parser [AccountCredentials]

ToJSON AccountCredentials

Defined in Polysemy.Account.Data.AccountCredentials

Methods

toJSON :: AccountCredentials -> Value

toEncoding :: AccountCredentials -> Encoding

toJSONList :: [AccountCredentials] -> Value

toEncodingList :: [AccountCredentials] -> Encoding

Show AccountCredentials

Defined in Polysemy.Account.Data.AccountCredentials

Methods

showsPrec :: Int -> AccountCredentials -> ShowS

show :: AccountCredentials -> String

showList :: [AccountCredentials] -> ShowS

Eq AccountCredentials

Defined in Polysemy.Account.Data.AccountCredentials

Methods

(==) :: AccountCredentials -> AccountCredentials -> Bool

(/=) :: AccountCredentials -> AccountCredentials -> Bool

newtype AccountName

The name of an account.

Constructors

AccountName

Fields

• unAccountName :: Text

Instances

FromJSON AccountName

Defined in Polysemy.Account.Data.AccountName

Methods

parseJSON :: Value -> Parser AccountName

parseJSONList :: Value -> Parser [AccountName]

ToJSON AccountName

Defined in Polysemy.Account.Data.AccountName

Methods

toJSON :: AccountName -> Value

toEncoding :: AccountName -> Encoding

toJSONList :: [AccountName] -> Value

toEncodingList :: [AccountName] -> Encoding

IsString AccountName

Defined in Polysemy.Account.Data.AccountName

Methods

fromString :: String -> AccountName

Generic AccountName

Defined in Polysemy.Account.Data.AccountName

Associated Types

type Rep AccountName :: Type -> Type

Methods

from :: AccountName -> Rep AccountName x

to :: Rep AccountName x -> AccountName

Show AccountName

Defined in Polysemy.Account.Data.AccountName

Methods

showsPrec :: Int -> AccountName -> ShowS

show :: AccountName -> String

showList :: [AccountName] -> ShowS

Eq AccountName

Defined in Polysemy.Account.Data.AccountName

Methods

(==) :: AccountName -> AccountName -> Bool

(/=) :: AccountName -> AccountName -> Bool

Ord AccountName

Defined in Polysemy.Account.Data.AccountName

Methods

compare :: AccountName -> AccountName -> Ordering

(<) :: AccountName -> AccountName -> Bool

(<=) :: AccountName -> AccountName -> Bool

(>) :: AccountName -> AccountName -> Bool

(>=) :: AccountName -> AccountName -> Bool

max :: AccountName -> AccountName -> AccountName

min :: AccountName -> AccountName -> AccountName

type Rep AccountName

Defined in Polysemy.Account.Data.AccountName

type Rep AccountName = D1 ('MetaData "AccountName" "Polysemy.Account.Data.AccountName" "polysemy-account-0.2.0.0-JBrIF35CBfcBfeWmsi0YZS" 'True) (C1 ('MetaCons "AccountName" 'PrefixI 'True) (S1 ('MetaSel ('Just "unAccountName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data RawPassword

A clear text password, supplied by the user or generated.

Instances

FromJSON RawPassword

Defined in Polysemy.Account.Data.RawPassword

Methods

parseJSON :: Value -> Parser RawPassword

parseJSONList :: Value -> Parser [RawPassword]

ToJSON RawPassword

Defined in Polysemy.Account.Data.RawPassword

Methods

toJSON :: RawPassword -> Value

toEncoding :: RawPassword -> Encoding

toJSONList :: [RawPassword] -> Value

toEncodingList :: [RawPassword] -> Encoding

Show RawPassword

Defined in Polysemy.Account.Data.RawPassword

Methods

showsPrec :: Int -> RawPassword -> ShowS

show :: RawPassword -> String

showList :: [RawPassword] -> ShowS

Eq RawPassword

Defined in Polysemy.Account.Data.RawPassword

Methods

(==) :: RawPassword -> RawPassword -> Bool

(/=) :: RawPassword -> RawPassword -> Bool

rawPassword :: Text -> RawPassword

Construct a 'RawPassword.

newtype GeneratedPassword

A password that was generated, intended to be shown to the user, and therefore permitted to be shown, as opposed to RawPassword.

Constructors

GeneratedPassword

Fields

• unGeneratedPassword :: Text

Instances

FromJSON GeneratedPassword

Defined in Polysemy.Account.Data.GeneratedPassword

Methods

parseJSON :: Value -> Parser GeneratedPassword

parseJSONList :: Value -> Parser [GeneratedPassword]

ToJSON GeneratedPassword

Defined in Polysemy.Account.Data.GeneratedPassword

Methods

toJSON :: GeneratedPassword -> Value

toEncoding :: GeneratedPassword -> Encoding

toJSONList :: [GeneratedPassword] -> Value

toEncodingList :: [GeneratedPassword] -> Encoding

IsString GeneratedPassword

Defined in Polysemy.Account.Data.GeneratedPassword

Methods

fromString :: String -> GeneratedPassword

Generic GeneratedPassword

Defined in Polysemy.Account.Data.GeneratedPassword

Associated Types

type Rep GeneratedPassword :: Type -> Type

Methods

from :: GeneratedPassword -> Rep GeneratedPassword x

to :: Rep GeneratedPassword x -> GeneratedPassword

Show GeneratedPassword

Defined in Polysemy.Account.Data.GeneratedPassword

Methods

showsPrec :: Int -> GeneratedPassword -> ShowS

show :: GeneratedPassword -> String

showList :: [GeneratedPassword] -> ShowS

Eq GeneratedPassword

Defined in Polysemy.Account.Data.GeneratedPassword

Methods

(==) :: GeneratedPassword -> GeneratedPassword -> Bool

(/=) :: GeneratedPassword -> GeneratedPassword -> Bool

Ord GeneratedPassword

Defined in Polysemy.Account.Data.GeneratedPassword

Methods

compare :: GeneratedPassword -> GeneratedPassword -> Ordering

(<) :: GeneratedPassword -> GeneratedPassword -> Bool

(<=) :: GeneratedPassword -> GeneratedPassword -> Bool

(>) :: GeneratedPassword -> GeneratedPassword -> Bool

(>=) :: GeneratedPassword -> GeneratedPassword -> Bool

max :: GeneratedPassword -> GeneratedPassword -> GeneratedPassword

min :: GeneratedPassword -> GeneratedPassword -> GeneratedPassword

type Rep GeneratedPassword

Defined in Polysemy.Account.Data.GeneratedPassword

type Rep GeneratedPassword = D1 ('MetaData "GeneratedPassword" "Polysemy.Account.Data.GeneratedPassword" "polysemy-account-0.2.0.0-JBrIF35CBfcBfeWmsi0YZS" 'True) (C1 ('MetaCons "GeneratedPassword" 'PrefixI 'True) (S1 ('MetaSel ('Just "unGeneratedPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data AccountStatus

Basic account status.

Constructors

Creating

The account was added to storage, but not processed fully.

Pending

The account was fully created, but not approved by an admin.

Active

The account is fully operational.

Locked

An admin has disabled the account.

Instances

FromJSON AccountStatus

Defined in Polysemy.Account.Data.AccountStatus

Methods

parseJSON :: Value -> Parser AccountStatus

parseJSONList :: Value -> Parser [AccountStatus]

ToJSON AccountStatus

Defined in Polysemy.Account.Data.AccountStatus

Methods

toJSON :: AccountStatus -> Value

toEncoding :: AccountStatus -> Encoding

toJSONList :: [AccountStatus] -> Value

toEncodingList :: [AccountStatus] -> Encoding

Generic AccountStatus

Defined in Polysemy.Account.Data.AccountStatus

Associated Types

type Rep AccountStatus :: Type -> Type

Methods

from :: AccountStatus -> Rep AccountStatus x

to :: Rep AccountStatus x -> AccountStatus

Show AccountStatus

Defined in Polysemy.Account.Data.AccountStatus

Methods

showsPrec :: Int -> AccountStatus -> ShowS

show :: AccountStatus -> String

showList :: [AccountStatus] -> ShowS

Eq AccountStatus

Defined in Polysemy.Account.Data.AccountStatus

Methods

(==) :: AccountStatus -> AccountStatus -> Bool

(/=) :: AccountStatus -> AccountStatus -> Bool

type Rep AccountStatus

Defined in Polysemy.Account.Data.AccountStatus

type Rep AccountStatus = D1 ('MetaData "AccountStatus" "Polysemy.Account.Data.AccountStatus" "polysemy-account-0.2.0.0-JBrIF35CBfcBfeWmsi0YZS" 'False) ((C1 ('MetaCons "Creating" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Pending" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Active" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Locked" 'PrefixI 'False) (U1 :: Type -> Type)))

data Privilege

The stock privilege type, used only for admin endpoint authorization in polysemy-account-api.

Constructors

Web

Api

Admin

Instances

FromJSON Privilege

Defined in Polysemy.Account.Data.Privilege

Methods

parseJSON :: Value -> Parser Privilege

parseJSONList :: Value -> Parser [Privilege]

ToJSON Privilege

Defined in Polysemy.Account.Data.Privilege

Methods

toJSON :: Privilege -> Value

toEncoding :: Privilege -> Encoding

toJSONList :: [Privilege] -> Value

toEncodingList :: [Privilege] -> Encoding

Generic Privilege

Defined in Polysemy.Account.Data.Privilege

Associated Types

type Rep Privilege :: Type -> Type

Methods

from :: Privilege -> Rep Privilege x

to :: Rep Privilege x -> Privilege

Show Privilege

Defined in Polysemy.Account.Data.Privilege

Methods

showsPrec :: Int -> Privilege -> ShowS

show :: Privilege -> String

showList :: [Privilege] -> ShowS

Eq Privilege

Defined in Polysemy.Account.Data.Privilege

Methods

(==) :: Privilege -> Privilege -> Bool

(/=) :: Privilege -> Privilege -> Bool

Default [Privilege]

Defined in Polysemy.Account.Data.Privilege

Methods

def :: [Privilege]

type Rep Privilege

Defined in Polysemy.Account.Data.Privilege

type Rep Privilege = D1 ('MetaData "Privilege" "Polysemy.Account.Data.Privilege" "polysemy-account-0.2.0.0-JBrIF35CBfcBfeWmsi0YZS" 'False) (C1 ('MetaCons "Web" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Api" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Admin" 'PrefixI 'False) (U1 :: Type -> Type)))

type AccountP = Account [Privilege]

Convenience alias for using the default privilege type with Account.

type AuthedAccountP i = AuthedAccount i [Privilege]

Convenience alias for using the default privilege type with AuthedAccount.

newtype AuthToken

An auth token, used by the JWT tools in polysemy-account-api.

Constructors

AuthToken

Fields

• unAuthToken :: Text

Instances

FromJSON AuthToken

Defined in Polysemy.Account.Data.AuthToken

Methods

parseJSON :: Value -> Parser AuthToken

parseJSONList :: Value -> Parser [AuthToken]

ToJSON AuthToken

Defined in Polysemy.Account.Data.AuthToken

Methods

toJSON :: AuthToken -> Value

toEncoding :: AuthToken -> Encoding

toJSONList :: [AuthToken] -> Value

toEncodingList :: [AuthToken] -> Encoding

Show AuthToken

Defined in Polysemy.Account.Data.AuthToken

Methods

showsPrec :: Int -> AuthToken -> ShowS

show :: AuthToken -> String

showList :: [AuthToken] -> ShowS

Eq AuthToken

Defined in Polysemy.Account.Data.AuthToken

Methods

(==) :: AuthToken -> AuthToken -> Bool

(/=) :: AuthToken -> AuthToken -> Bool

newtype Port

An API port, used by the Servant tools in polysemy-account-api.

Constructors

Port Word

Instances

FromJSON Port

Defined in Polysemy.Account.Data.Port

Methods

parseJSON :: Value -> Parser Port

parseJSONList :: Value -> Parser [Port]

ToJSON Port

Defined in Polysemy.Account.Data.Port

Methods

toJSON :: Port -> Value

toEncoding :: Port -> Encoding

toJSONList :: [Port] -> Value

toEncodingList :: [Port] -> Encoding

Enum Port

Defined in Polysemy.Account.Data.Port

Methods

succ :: Port -> Port

pred :: Port -> Port

toEnum :: Int -> Port

fromEnum :: Port -> Int

enumFrom :: Port -> [Port]

enumFromThen :: Port -> Port -> [Port]

enumFromTo :: Port -> Port -> [Port]

enumFromThenTo :: Port -> Port -> Port -> [Port]

Num Port

Defined in Polysemy.Account.Data.Port

Methods

(+) :: Port -> Port -> Port

(-) :: Port -> Port -> Port

(*) :: Port -> Port -> Port

negate :: Port -> Port

abs :: Port -> Port

signum :: Port -> Port

fromInteger :: Integer -> Port

Read Port

Defined in Polysemy.Account.Data.Port

Methods

readsPrec :: Int -> ReadS Port

readList :: ReadS [Port]

readPrec :: ReadPrec Port

readListPrec :: ReadPrec [Port]

Integral Port

Defined in Polysemy.Account.Data.Port

Methods

quot :: Port -> Port -> Port

rem :: Port -> Port -> Port

div :: Port -> Port -> Port

mod :: Port -> Port -> Port

quotRem :: Port -> Port -> (Port, Port)

divMod :: Port -> Port -> (Port, Port)

toInteger :: Port -> Integer

Real Port

Defined in Polysemy.Account.Data.Port

Methods

toRational :: Port -> Rational

Show Port

Defined in Polysemy.Account.Data.Port

Methods

showsPrec :: Int -> Port -> ShowS

show :: Port -> String

showList :: [Port] -> ShowS

Eq Port

Defined in Polysemy.Account.Data.Port

Methods

(==) :: Port -> Port -> Bool

(/=) :: Port -> Port -> Bool

Ord Port

Defined in Polysemy.Account.Data.Port

Methods

compare :: Port -> Port -> Ordering

(<) :: Port -> Port -> Bool

(<=) :: Port -> Port -> Bool

(>) :: Port -> Port -> Bool

(>=) :: Port -> Port -> Bool

max :: Port -> Port -> Port

min :: Port -> Port -> Port

type AuthQuery i p = [Query (AuthForAccount i) [Uid i (AccountAuth i)] !! DbError, Store i (AccountAuth i) !! DbError, AtomicState (PureStore i (AccountAuth i))]

The effects handled by interpretAuthForAccountState..

type AccountQuery i p = [Query AccountByName (Maybe (Uid i (Account p))) !! DbError, Store i (Account p) !! DbError, AtomicState (PureStore i (Account p))]

The effects handled by interpretAccountByNameState.