host

type Directory interface {
	Person(ctx context.Context, id string) (Person, error)
	// People lists everyone who tracks time.
	People(ctx context.Context) ([]Person, error)
}

type Mailer interface {
	Send(ctx context.Context, m Message) error
}

type Message struct {
	To      string
	Subject string
	// Text is the body, in plain text.
	Text string
}

type Notification struct {
	// Kind names what it is about, such as "clock_running" or
	// "timesheet_due", so a platform can group or mute them.
	Kind  string
	Title string
	Body  string
	// Path is where in Timeclock it leads, relative to the base path.
	Path string
}

type Notifier interface {
	Notify(ctx context.Context, personID string, n Notification) error
}

type Person struct {
	// ID identifies the person for good; Timeclock keys their time on it.
	ID    string
	Name  string
	Email string
	// AvatarURL is the person's profile image, supplied by the host. Empty
	// uses initials. Use a same-origin path or an image URL allowed by the host's CSP.
	AvatarURL string
	// Admin runs payroll: they see everyone's time, approve anything, change
	// settings and export reports.
	Admin bool
	// Auditor reads History: every change to payroll data, and who made it.
	// It is the host's to grant, and apart from Admin: an admin is not an
	// auditor unless the host says so.
	Auditor bool
	// ManagerID is the person who approves this person's timesheets and time
	// off, when the platform knows. An admin can set it in Timeclock instead,
	// which takes precedence.
	ManagerID string
}

type Scheme struct {
	Interface ThemeSeed  `json:"interface"`
	Sidebar   *ThemeSeed `json:"sidebar,omitempty"`
}

type Theme struct {
	Light *Scheme `json:"light,omitempty"`
	Dark  *Scheme `json:"dark,omitempty"`
}

type ThemeSeed struct {
	// Accent is the color of what stands out, such as "#4b50d9".
	Accent string `json:"accent" example:"#4b50d9"`
	// Background is the color everything sits on, such as "#ffffff".
	Background string `json:"background" example:"#ffffff"`
	// Contrast is how far text and borders sit from the background: 1 is
	// normal, and 0.5 to 1.5 the range. Zero means 1.
	Contrast float64 `json:"contrast,omitempty"`
}