utils

Documentation

Index

• Constants
• func DecodeAndValidate[T DbModel](r *http.Request) (T, error)
• func Encode[T any](w http.ResponseWriter, r *http.Request, status int, v T) error
• func IntPathValue(r *http.Request, key string) int
• func IntQueryValue(r *http.Request, key string) int
• func RegisterValidations(db *gorm.DB)
• func Validate(instance any) error
• type ActionForbiddenError
• type AnyMap
• type AppError
  • func (e AppError) Error() string
• type AppValidationError
• type AuthHeaderMissingError
• type ContextKey
• type DbModel
• type ErrorsResponse
• type HandlerWithError
  • func (f HandlerWithError) ServeHTTP(w http.ResponseWriter, r *http.Request) error
• type InternalError
• type InvalidAuthHeaderError
• type InvalidJwtClaimsError
• type InvalidUserError
• type JwtTokenExpiredError
• type JwtTokenParsingError
• type LoginError
• type PaginatedResponse
  • func BuildPaginatedResponse(responseRecords []any, totalCount int64, paginationParams *PaginationParams) *PaginatedResponse
• type PaginationInfo
• type PaginationParams
  • func BuildPaginationParams(r *http.Request) *PaginationParams
• type RecordNotFoundError
• type UserNotFoundError
• type ValidationResponseItem
  • func AppValidationErrorDetails(err AppValidationError) []ValidationResponseItem
  • func ValidationErrorDetails(errors validator.ValidationErrors) []ValidationResponseItem

Constants

const AdminRole = "admin"

const DbContextKey = ContextKey(1)

const DefaultOrderBy = "id"

const DefaultPageNumber = 1

const DefaultPageSize = 20

const OnlyCurrentUserContextKey = ContextKey(4)

const OnlyCurrentUserPath = "/users/me"

const OrganizerRole = "organizer"

const RecordIdContextKey = ContextKey(3)

const UserContextKey = ContextKey(0)

const UserRole = "user"

const WorkersContextKey = ContextKey(2)

Functions

func DecodeAndValidate

func DecodeAndValidate[T DbModel](r *http.Request) (T, error)

func Encode

func Encode[T any](w http.ResponseWriter, r *http.Request, status int, v T) error

func IntPathValue

func IntPathValue(r *http.Request, key string) int

func IntQueryValue

func IntQueryValue(r *http.Request, key string) int

func RegisterValidations

func RegisterValidations(db *gorm.DB)

func Validate

func Validate(instance any) error

validates the instance of a struct using defined tags on its fields

Types

type ActionForbiddenError

type ActionForbiddenError struct {
	AppError
}

type AnyMap

type AnyMap map[string]any

type AppError

type AppError struct {
	Message string
}

func (AppError) Error

func (e AppError) Error() string

type AppValidationError

type AppValidationError struct {
	AppError
	FieldPath string
}

type AuthHeaderMissingError

type AuthHeaderMissingError struct {
	AppError
}

type ContextKey

type ContextKey uint

type DbModel

type DbModel interface {
	GetID() uint
	Validate(*http.Request) error
	BeforeCreateCtx(context.Context, *gorm.DB) error
	AfterCreateCtx(context.Context, *gorm.DB) error
	BeforeUpdateCtx(context.Context, *gorm.DB) error
	AfterUpdateCtx(context.Context, *gorm.DB) error
	BeforeDeleteCtx(context.Context, *gorm.DB) error
	AfterDeleteCtx(context.Context, *gorm.DB) error
	GetAllQuery(*gorm.DB, *http.Request) *gorm.DB
	GetQuery(*gorm.DB, *http.Request) *gorm.DB
	UpdateQuery(*gorm.DB, *http.Request) *gorm.DB
	DeleteQuery(*gorm.DB, *http.Request) *gorm.DB
	BuildResponse() any
}

type ErrorsResponse

type ErrorsResponse struct {
	ErrorType string `json:"error_type"`
	Details   any    `json:"details"` // should be of type: string, utils.AnyMap
}

type HandlerWithError

type HandlerWithError func(http.ResponseWriter, *http.Request) error

func (HandlerWithError) ServeHTTP

func (f HandlerWithError) ServeHTTP(w http.ResponseWriter, r *http.Request) error

type InternalError

type InternalError struct {
	AppError
}

type InvalidAuthHeaderError

type InvalidAuthHeaderError struct {
	AppError
}

type InvalidJwtClaimsError

type InvalidJwtClaimsError struct {
	AppError
}

type InvalidUserError

type InvalidUserError struct {
	AppError
}

type JwtTokenExpiredError

type JwtTokenExpiredError struct {
	AppError
}

type JwtTokenParsingError

type JwtTokenParsingError struct {
	AppError
}

type LoginError

type LoginError struct {
	AppError
}

type PaginatedResponse

type PaginatedResponse struct {
	Data           interface{}    `json:"data"`
	PaginationInfo PaginationInfo `json:"pagination_info"`
}

func BuildPaginatedResponse

func BuildPaginatedResponse(responseRecords []any, totalCount int64, paginationParams *PaginationParams) *PaginatedResponse

type PaginationInfo

type PaginationInfo struct {
	Count            int  `json:"count"`
	TotalCount       int  `json:"total_count"`
	TotalPages       int  `json:"total_pages"`
	CurrentPage      int  `json:"current_page"`
	NextPage         *int `json:"next_page"`
	PrevPage         *int `json:"prev_page"`
	IsFirstPage      bool `json:"is_first_page"`
	IsLastPage       bool `json:"is_last_page"`
	IsOutOfRangePage bool `json:"is_out_of_range_page"`
}

type PaginationParams

type PaginationParams struct {
	PageNo         int
	PerPage        int
	OrderBy        string
	OrderDirection string
}

func BuildPaginationParams

func BuildPaginationParams(r *http.Request) *PaginationParams

type RecordNotFoundError

type RecordNotFoundError struct {
	AppError
}

type UserNotFoundError

type UserNotFoundError struct {
	AppError
}

type ValidationResponseItem

type ValidationResponseItem struct {
	ErrorsResponse
	Path []string `json:"path"`
}

func AppValidationErrorDetails

func AppValidationErrorDetails(err AppValidationError) []ValidationResponseItem

func ValidationErrorDetails

func ValidationErrorDetails(errors validator.ValidationErrors) []ValidationResponseItem