application

type AccessTokenClaims struct {
	jwt.StandardClaims
	Scope string   `json:"scope"`
	Roles []string `json:"roles"`
}

type AuthService interface {
	// AuthenticateUserByCredentials tries to authenticate the user using the
	// given username and password and returns a new access token in case the
	// credentials are valid.
	AuthenticateUserByCredentials(username, password string) (*Token, error)

	// AuthenicateUserByRefreshToken tries to authenticate the user using the
	// given refresh token and returns a new access token in case the
	// provided refresh token is valid.
	AuthenicateUserByRefreshToken(token string) (*Token, error)

	// SignAccessToken signs the given token and returns the access token
	// encoded as a JWT.
	SignAccessToken(token *Token) (string, error)

	// SignRefreshToken signs the given token and returns the refresh token
	// encoded as a JWT.
	SignRefreshToken(token *Token) (string, error)

	// ExtractScopes extracts the token scopes from the given set of claims.
	ExtractScopes(claims jwt.MapClaims) []string

	// ExtractUsername extracts the username from the given set of claims.
	ExtractUsername(claims jwt.MapClaims) *string

	// ExtractRoles extracts the user's roles from the given set of claims.
	ExtractRoles(claims jwt.MapClaims) []string
}

type DocumentService interface {
	// GetUserDocuments returns the given user's documents with respect to the
	// given page request.
	GetUserDocuments(username string, pr domain.PageRequest) ([]domain.Document, int64, error)

	// SearchUserDocuments returns all documents matching the given query with respect to the given page request.
	SearchUserDocuments(username, query string, pr domain.PageRequest) ([]domain.DocumentSearchResult, int64, error)

	// GetUserDocumentByDocumentNumber returns the document with the given document number owned by the given user.
	GetUserDocumentByDocumentNumber(username string, documentNumber uint) (*domain.Document, error)

	// CreateNewDocument creates the given new document owned by the user with the given username.
	CreateNewDocument(username string, document *domain.Document) (*domain.Document, error)

	// GetUserDocumentPagesByDocumentNumber returns the document pages for the document with the given document number with respect to the given
	// username and page request.
	GetUserDocumentPagesByDocumentNumber(username string, documentNumber uint, pr domain.PageRequest) ([]domain.DocumentPage, int64, error)

	// GetUserDocumentPageByDocumentNumberAndPageNumber returns the page with the given page number for the document with the given document number,
	// accessible by the user with the given username.
	GetUserDocumentPageByDocumentNumberAndPageNumber(username string, documentNumber uint, pageNumber uint) (*domain.DocumentPage, error)

	// AddPagesToUserDocument adds the given pages to the document with the given ID.
	AddPagesToUserDocument(username string, documentNumber uint, files []*multipart.FileHeader) ([]domain.DocumentPage, error)

	// GetUserDocumentPageContent returns a reader to a document pages content, if present.
	GetUserDocumentPageContent(username string, documentNumber uint, pageNumber uint) (io.ReadCloser, error)
}

type ErrorType string

type RefreshTokenClaims struct {
	jwt.StandardClaims
	Scope string `json:"scope"`
}

type Token struct {
	Username       string
	Roles          []string
	Expires        time.Time
	RefreshExpires time.Time
}

type TokenKeyResolver = func(token *jwt.Token) (interface{}, error)

type UserService interface {
	// GetUserByUsername returns the user with the given username or
	// an error in case no such user exists.
	GetUserByUsername(username string) (*domain.User, error)

	// GetUsers finds and returns users with respect to the given page request.
	GetUsers(pr domain.PageRequest) ([]domain.User, int64, error)

	// Creates the given new user with the desired password as clear-text.
	CreateNewUser(user *domain.User, password string) (*domain.User, error)

	// Update user updates all possible field of the given user.
	UpdateUser(user *domain.User, password *string) (*domain.User, error)

	// DeleteUser deletes the user with the given ID.
	DeleteUser(username string) error

	// UpdateUserPassword updates the password of the user with the given ID.
	UpdateUserPassword(username string, currentPassword, newPassword string) error
}