engine

type CalendarDay struct {
	Period string `json:"period"`
	Amount int    `json:"amount"`
	Earned bool   `json:"earned"`
}

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

type Event struct {
	ID        int64          `json:"id"`
	Subject   string         `json:"subject"`
	Key       string         `json:"key"`
	Type      core.EventType `json:"type"`
	Period    string         `json:"period"`
	Count     int            `json:"count"`
	CreatedAt time.Time      `json:"created_at"`
}

type FreezesView struct {
	Available int `json:"available"`
	Max       int `json:"max"`
	// Progress / Needed track earning the next freeze (0/0 when disabled).
	Progress int `json:"progress"`
	Needed   int `json:"needed"`
}

type MilestoneView struct {
	Reached int `json:"reached"`
	Next    int `json:"next,omitempty"`
}

type Option func(*Engine)

type RecordReq struct {
	Subject string
	Key     string
	// At defaults to the engine clock. When set, it must land in the current
	// period (a short grace window covers boundary races for the previous,
	// not-yet-settled period).
	At time.Time
	// Amount defaults to 1; periods earn when the accumulated amount reaches
	// the config threshold.
	Amount int
	// IdempotencyKey memoizes the response: replays return the original
	// result without re-recording.
	IdempotencyKey string
	// Config creates the streak with this config on first activity instead of
	// a registered streak type.
	Config *core.Config
}

type StreakView struct {
	Key              string         `json:"key"`
	Count            int            `json:"count"`
	Longest          int            `json:"longest"`
	State            core.Liveness  `json:"state"`
	EarnedThisPeriod bool           `json:"earned_this_period"`
	CurrentPeriod    string         `json:"current_period"`
	AmountThisPeriod int            `json:"amount_this_period"`
	AmountNeeded     int            `json:"amount_needed"`
	LossAt           *time.Time     `json:"loss_at,omitempty"`
	SecondsUntilLoss int64          `json:"seconds_until_loss"`
	Freezes          FreezesView    `json:"freezes"`
	Milestone        *MilestoneView `json:"milestone,omitempty"`
	Target           *TargetView    `json:"target,omitempty"`
	Timezone         string         `json:"timezone"`
}

type TargetView struct {
	Goal int `json:"goal"`
	Done int `json:"done"`
}