model

Documentation

Overview

Package model defines common data structures used throughout the project.

The structs defined in this package are intended to be shared and referenced by multiple packages within the project. They represent common data entities, such as domain objects or data transfer objects, that are used across different layers or modules of the application. By centralizing these shared data structures in the model package, it helps to maintain consistency and reusability throughout the project.

Index

• type Errors
  • func (errs Errors) Error() string
• type Event
• type EventType
• type Session
• type User
  • func OmitPassword(user *User) *User

Types

type Errors

type Errors []error

Errors is a custom type created to enforce a specific set of values

func (Errors) Error

func (errs Errors) Error() string

type Event

type Event struct {
	ID        int64     `json:"id"`
	UUID      uuid.UUID `json:"uuid"`
	Type      EventType `json:"type"`
	Body      []byte    `json:"body"` // TODO change to map[string]interface{}?
	CreatedAt time.Time `json:"created_at"`
}

Event represents an immutable event that has occurred in the system.

type EventType

type EventType string

EventType is a custom type created to enforce a specific set of values that can be used to represent different types of events in the system.

const (
	LoggedIn       EventType = "logged_in"
	LoggedOut      EventType = "logged_out"
	LoggedOutAll   EventType = "logged_out_all"
	AccountCreated EventType = "account_created"
)

Values for EventType

type Session

type Session struct {
	ID        string    `json:"id"`
	UserID    uuid.UUID `json:"user_id"`
	CreatedAt time.Time `json:"created_at"`
}

Session represents a user session in the system.

type User

type User struct {
	ID       uuid.UUID `json:"id"`
	Username string    `json:"username"`
	Password string    `json:"password"`
}

User represents a user account.

func OmitPassword

func OmitPassword(user *User) *User

OmitPassword creates a copy of the user with the password field set to ""