colortheme

Documentation

Index

• Constants
• Variables
• type API
  • func NewApi(store Store, logger zerolog.Logger) API
• type AggregationResult
  • func (r *AggregationResult) GetData() interface{}
  • func (r *AggregationResult) GetTotal() int64
• type BulkDeleteRequestItem
• type Colors
• type EditRequest
• type FilteredQuery
• type Response
• type Store
  • func NewStore(dbClient libmongo.DbClient, authorProvider author.Provider, ...) Store

Constants

const (
	Canopsis       = "canopsis"
	CanopsisDark   = "canopsis_dark"
	ColorBlind     = "color_blind"
	ColorBlindDark = "color_blind_dark"
)

Variables

var ErrCanopsisDefaultTheme = errors.New("can't modify or delete the default canopsis color theme")

var ErrDefaultTheme = errors.New("can't delete the default color theme")

Types

type API

type API interface {
	common.CrudAPI
	BulkDelete(c *gin.Context)
}

func NewApi

func NewApi(
	store Store,
	logger zerolog.Logger,
) API

type AggregationResult

type AggregationResult struct {
	Data       []Response `bson:"data" json:"data"`
	TotalCount int64      `bson:"total_count" json:"total_count"`
}

func (*AggregationResult) GetData

func (r *AggregationResult) GetData() interface{}

func (*AggregationResult) GetTotal

func (r *AggregationResult) GetTotal() int64

type BulkDeleteRequestItem

type BulkDeleteRequestItem struct {
	ID string `json:"_id" binding:"required"`
}

type Colors

type Colors struct {
	Main struct {
		Primary     string `bson:"primary" json:"primary" binding:"required,iscolor"`
		Secondary   string `bson:"secondary" json:"secondary" binding:"required,iscolor"`
		Accent      string `bson:"accent" json:"accent" binding:"required,iscolor"`
		Error       string `bson:"error" json:"error" binding:"required,iscolor"`
		Info        string `bson:"info" json:"info" binding:"required,iscolor"`
		Success     string `bson:"success" json:"success" binding:"required,iscolor"`
		Warning     string `bson:"warning" json:"warning" binding:"required,iscolor"`
		Background  string `bson:"background" json:"background" binding:"required,iscolor"`
		ActiveColor string `bson:"active_color" json:"active_color" binding:"required,iscolor"`
	} `bson:"main" json:"main"`
	Table struct {
		Background    string `bson:"background" json:"background" binding:"required,iscolor"`
		RowColor      string `bson:"row_color" json:"row_color" binding:"required,iscolor"`
		ShiftRowColor string `bson:"shift_row_color,omitempty" json:"shift_row_color,omitempty" binding:"iscolororempty"`
		HoverRowColor string `bson:"hover_row_color,omitempty" json:"hover_row_color,omitempty" binding:"iscolororempty"`
	} `bson:"table" json:"table"`
	State struct {
		OK       string `bson:"ok" json:"ok" binding:"required,iscolor"`
		Minor    string `bson:"minor" json:"minor" binding:"required,iscolor"`
		Major    string `bson:"major" json:"major" binding:"required,iscolor"`
		Critical string `bson:"critical" json:"critical" binding:"required,iscolor"`
	} `bson:"state" json:"state"`
}

type EditRequest

type EditRequest struct {
	ID       string `bson:"_id" json:"-"`
	Name     string `bson:"name" json:"name" binding:"required"`
	Colors   Colors `bson:"colors" json:"colors"`
	FontSize int    `bson:"font_size" json:"font_size" binding:"required,oneof=1 2 3"`

	Author    string           `bson:"author" json:"author" swaggerignore:"true"`
	Created   datetime.CpsTime `bson:"created,omitempty" json:"-" swaggerignore:"true"`
	Updated   datetime.CpsTime `bson:"updated,omitempty" json:"-" swaggerignore:"true"`
	Deletable bool             `bson:"deletable" json:"-" swaggerignore:"true"`
}

type FilteredQuery

type FilteredQuery struct {
	pagination.FilteredQuery
	SortBy string `json:"sort_by" form:"sort_by" binding:"oneoforempty=name updated"`
}

type Response

type Response struct {
	ID        string            `bson:"_id" json:"_id"`
	Name      string            `bson:"name" json:"name"`
	Colors    Colors            `bson:"colors" json:"colors"`
	FontSize  int               `bson:"font_size" json:"font_size"`
	Author    *author.Author    `bson:"author" json:"author"`
	Created   *datetime.CpsTime `bson:"created,omitempty" json:"created,omitempty" swaggertype:"integer"`
	Updated   *datetime.CpsTime `bson:"updated,omitempty" json:"updated,omitempty" swaggertype:"integer"`
	Deletable bool              `bson:"deletable" json:"deletable"`
}

type Store

type Store interface {
	Insert(ctx context.Context, r EditRequest) (*Response, error)
	GetByID(ctx context.Context, id string) (*Response, error)
	Find(ctx context.Context, query FilteredQuery) (*AggregationResult, error)
	Update(ctx context.Context, r EditRequest) (*Response, error)
	Delete(ctx context.Context, id, userID string) (bool, error)
}

func NewStore

func NewStore(
	dbClient libmongo.DbClient,
	authorProvider author.Provider,
	userInterfaceAdapter config.UserInterfaceAdapter,
) Store