package sihl

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package sihl

sihl
- Sihl
sihl.authn
- Sihl_authn
  - Service
    
    Logs
    
    Make
    
    SessionService
    
    UserService
  - Sig
    
    SERVICE
sihl.authz
- Sihl_authz
sihl.core
- Sihl_core
  - App
  - Command
  - Configuration
  - Container
    
    Lifecycle
    
    Map
    
    Service
    
    Sig
  - Ctx
  - Log
  - Random
sihl.database
- Sihl_database
  - Id
  - Ql
    
    Filter
    
    Page
    
    Sort
  - Service
  - Sig
    
    SERVICE
  - View
    
    PartialCollection
sihl.email
- Sihl_email_core
  - Sig
    
    SERVICE
    
    Template
    
    TEMPLATE_REPO
    
    TEMPLATE_SERVICE
  - Template
    
    Data
sihl.http
- Sihl_http
  - Cookie
    
    Signer
  - Middleware
  - Request
  - Response
  - Route
  - Service
sihl.message
- Sihl_message
  - Entry
  - Service
    
    Entry
    
    Logs
    
    Make
    
    SessionService
  - Sig
    
    SERVICE
sihl.middleware
- Sihl_middleware
  - Authn
    
    Make
    
    AuthnService
    
    UserService
  - Clickjacking
    
    Make
  - Cookie
  - Csrf
    
    Logs
    
    Make
    
    SessionService
    
    TokenService
  - Error
  - Gzip
  - Message
    
    Logs
    
    Make
    
    MessageService
  - Security
  - Session
    
    Logs
    
    Make
    
    SessionService
  - Static
  - User
    
    Make
    
    UserService
sihl.migration
- Sihl_migration
  - Service
    
    Logs
    
    Make
    
    MigrationRepo
    
    Repo
    
    MakePostgreSql
    
    Database
    
    MariaDb
  - Sig
    
    REPO
    
    SERVICE
sihl.password-reset
- Sihl_password_reset
  - Service
    
    Logs
    
    Make
    
    TokenService
    
    UserService
    
    TokenData
    
    Fields
    
    Direct
  - Sig
    
    SERVICE
sihl.queue
- Sihl_queue_core
  - Job
    
    Fields
    
    Direct
  - JobInstance
    
    Fields
    
    Direct
    
    Status
  - Sig
    
    Job
    
    Fields
    
    Direct
    
    JobInstance
    
    Fields
    
    Direct
    
    Status
    
    REPO
    
    SERVICE
  - WorkableJob
    
    Fields
    
    Direct
sihl.repository
- Sihl_repository
  - Dynparam
  - Meta
    
    Fields
    
    Direct
  - Service
  - Sig
    
    REPO
    
    SERVICE
sihl.schedule
- Sihl_schedule
  - Service
  - Sig
    
    SERVICE
sihl.session
- Sihl_session
  - Map
  - Service
    
    Logs
    
    Make
    
    Repo
    
    Repo
    
    MakeMariaDb
    
    MigrationService
    
    MakePostgreSql
    
    MigrationService
  - Sig
    
    REPO
    
    SERVICE
sihl.storage
- Sihl_storage_core
  - File
    
    Fields
    
    Direct
  - Sig
    
    REPO
    
    SERVICE
  - StoredFile
    
    Fields
    
    Direct
sihl.token
- Sihl_token
  - Repo
    
    MariaDb
    
    MigrationService
  - Service
    
    Logs
    
    Make
    
    Repo
  - Sig
    
    REPOSITORY
    
    SERVICE
  - Status
sihl.user
- Sihl_user
  - Authz
  - Repo
    
    MakeMariaDb
    
    MigrationService
    
    MakePostgreSql
    
    MigrationService
  - Seed
    
    Make
    
    UserService
  - Service
    
    Logs
    
    Make
    
    Repo
    
    User
    
    Fields
    
    Direct
  - Sig
    
    REPOSITORY
    
    SERVICE
sihl.utils
- Sihl_utils
  - Encryption
  - Hashing
  - Json
  - Jwt
  - Regex
  - String
  - Time

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module TokenService : Token.Sig.SERVICE

module UserService : User.Sig.SERVICE

Signature

include Sihl_core.Container.Service.Sig

val lifecycle : Sihl_core.Container.Lifecycle.t

val create_reset_token : 
  Sihl_core.Ctx.t ->
  email:string ->
  Sihl_token.t option Lwt.t

Create and store a reset token.

Returns None if there is no user with email. The reset token can be used with reset_password to set the password without knowing the old password.

val reset_password : 
  Sihl_core.Ctx.t ->
  token:string ->
  password:string ->
  password_confirmation:string ->
  (unit, string) Stdlib.Result.t Lwt.t

Set the password of a user associated with the reset token.

val register : unit -> Sihl_core.Container.Service.t