package sihl-user

You can search for identifiers within the package.

in-package search v0.2.0

package sihl-user

sihl-user
- Sihl_user
  - Logs
  - Make
    
    Repo
    
    Web
  - MariaDb
    
    Web
  - Password_reset
    
    MakeMariaDb
    
    TokenService
    
    MakePostgreSql
    
    TokenService
  - PostgreSql
    
    Web

Legend:
Library
Module
Module type
Parameter
Class
Class type

include module type of struct include Sihl.Contract.User end

type error =

| AlreadyRegistered
| IncorrectPassword
| InvalidPasswordProvided of string
| DoesNotExist

type t = {

id : string;
email : string;
username : string option;
password : string;
status : string;
admin : bool;
confirmed : bool;
created_at : Ptime.t;
updated_at : Ptime.t;

}

exception Exception of string

val name : string

module type Sig = Sihl.Contract.User.Sig

module Hashing = Sihl.Contract.User.Hashing

val to_sexp : t -> Sexplib0.Sexp.t

val pp : Format.formatter -> t -> unit

val of_yojson : Yojson__Safe.t -> t option

val to_yojson : 
  t ->
  [> `Assoc of (string * [> `Bool of bool | `Null | `String of string ]) list ]

val confirm : t -> t

val set_user_password : t -> string -> (t, string) result

val set_user_details : t -> email:string -> username:string option -> t

val is_admin : t -> bool

val is_owner : t -> String.t -> bool

val is_confirmed : t -> bool

val matches_password : string -> t -> bool

val default_password_policy : string -> (unit, string) result

val validate_new_password : 
  password:String.t ->
  password_confirmation:String.t ->
  password_policy:(String.t -> (unit, string) result) ->
  (unit, string) result

val validate_change_password : 
  t ->
  old_password:string ->
  new_password:String.t ->
  new_password_confirmation:String.t ->
  password_policy:(String.t -> (unit, string) result) ->
  (unit, string) result

val make : 
  email:string ->
  password:string ->
  username:string option ->
  admin:bool ->
  confirmed:bool ->
  (t, string) result

val log_src : Logs.src

module Logs : Logs.LOG

module Make (Repo : sig ... end) : Sihl.Contract.User.Sig

module PostgreSql : sig ... end

module MariaDb : sig ... end

module Password_reset : sig ... end