core

README

LumePetal

LumePetal is a core component of a web application designed for use in personal projects, allowing you to efficiently create user-based applications using MongoDB. The goals of this project are as follows

• Reduce development effort by standardizing the basic code.
• Improve security by hiding sensitive information such as TOTP secrets and tokens from higher level components.

Documentation

Index

• Variables
• type StoreKey
• type UserData
• type UserService
  • func InitUserService(dbUri string, userId string) (*UserService, error)
  • func (us *UserService) GetUser() UserData

Variables

var (
	ErrInvalidUserId             = errors.New("invalid user id")
	ErrCouldNotCloseDbConnection = errors.New("could not close db connection")
)

Types

type StoreKey

type StoreKey string

const (
	UserIdKey           StoreKey = "id"
	UserDisplayNameKey  StoreKey = "displayName"
	UserPasswordHashKey StoreKey = "passwordHash"
	UserStorageKey      StoreKey = "storage"
)

type UserData

type UserData struct {
	Id          string `bson:"-"`
	DisplayName string

	AllowPasswordLessLogin bool
	Storage                []interface{}
	// contains filtered or unexported fields
}

type UserService

type UserService struct {
	// contains filtered or unexported fields
}

func InitUserService

func InitUserService(dbUri string, userId string) (*UserService, error)

func (*UserService) GetUser

func (us *UserService) GetUser() UserData