teams

type CapFacts struct {
	Team     string  `json:"team"`
	Day      string  `json:"day"`
	CapUSD   float64 `json:"cap_usd"`
	SpentUSD float64 `json:"spent_usd"`
	RaiseTo  float64 `json:"raise_to"`
}

type ClosingReport struct {
	Done       string   `json:"done"`
	Left       string   `json:"left,omitempty"`
	Files      []string `json:"files,omitempty"`
	SpendUSD   float64  `json:"spend_usd,omitempty"`
	Incomplete bool     `json:"incomplete,omitempty"`
}

type Defaults struct {
	QuestionsUp bool    `json:"questions_up"`
	CapUSDDay   float64 `json:"cap_usd_day"`
	DepthLimit  int     `json:"depth_limit"`
	// SubShare is a fraction, the row's whole percentage over 100.
	SubShare float64 `json:"sub_share"`
	// Wake is whether team traffic wakes idle conversations.
	Wake bool `json:"wake"`
}

type Effective struct {
	QuestionsUp     bool    `json:"questions_up"`
	QuestionsUpFrom Origin  `json:"questions_up_from"`
	CapUSDDay       float64 `json:"cap_usd_day"`
	// CapFrom names the team whose cap this is. A cap is a POOL: a team's
	// spend counts every team under it ([TeamSpend]), so an inherited cap is
	// the ancestor's one pool, shared, and not a second allowance of the same
	// size; the spend to set beside it is CapFrom.Team's.
	CapFrom      Origin  `json:"cap_from"`
	DepthLimit   int     `json:"depth_limit"`
	DepthFrom    Origin  `json:"depth_from"`
	SubShare     float64 `json:"sub_share"`
	SubShareFrom Origin  `json:"sub_share_from"`
	// Wake is whether team traffic wakes the team's idle conversations: a
	// directive its member, a member's reply or event its manager.
	Wake     bool   `json:"wake"`
	WakeFrom Origin `json:"wake_from"`
}

type Entry struct {
	// ID is assigned by [AppendTraffic]; any ID given is replaced.
	ID string `json:"id"`
	// At is when it happened; [AppendTraffic] fills a zero one with now.
	At time.Time `json:"at"`
	// Kind is one of the Kind constants.
	Kind string `json:"kind"`
	// From is a member's handle, or manager, you or system.
	From string `json:"from"`
	// To is a member's handle, or everyone, manager or room, or several with
	// the handles in Handles.
	To   string `json:"to"`
	Text string `json:"text"`
	// Handles is who a message to several members is for, in the order the
	// sender named them; empty on every other entry (thread.go).
	Handles []string `json:"handles,omitempty"`
	// Answers is the id of the entry this one answers, which is what threads
	// the log: a member's reply names the manager's message it replies to, and
	// the events its turn raises name the same one. Empty on an entry that
	// answers nothing, and on every entry written before threads (thread.go).
	Answers string `json:"answers,omitempty"`
	// Files are paths the entry is about, when it is about any.
	Files []string `json:"files,omitempty"`
	// Member is the conversation key the entry concerns, when there is one.
	Member string `json:"member,omitempty"`
	// State is what a [KindEvent] says the member it concerns is now: one of
	// the State constants ([StateFinished], [StateFailed], [StateAsking],
	// [StateIdle] for a turn that was stopped, [StateRunning] for one that
	// carried on after its question was answered). It is empty on every other
	// kind but [KindPacket]. A reader colours by it rather than by reading Text, which is the
	// words a person reads.
	State string `json:"state,omitempty"`
	// Packet is the decision packet a [KindPacket] entry is about, and State
	// is then the packet's state after the change it records.
	Packet string `json:"packet,omitempty"`
	// Reply is the id of the [KindQuestion] entry a [KindAnswer] answers.
	Reply string `json:"reply,omitempty"`
	// Team is, on a [KindStart], the sub-team the started conversation is to
	// manage (a manager's `team_start` of kind team): the interface opens and
	// adds the member as for any start, and the new conversation, reading its
	// brief, makes itself that team's manager. It is empty on every other
	// start and every other kind.
	Team string `json:"team,omitempty"`
	// Approval is, on a [KindStart], the approval posture the started
	// conversation inherits from the manager unless overridden.
	Approval string `json:"approval,omitempty"`
}

type File struct {
	Version int
	Teams   []Team
}

type Hop struct {
	From   string    `json:"from"`
	To     string    `json:"to"`
	By     string    `json:"by"`
	Reason string    `json:"reason,omitempty"`
	At     time.Time `json:"at"`
}

type HueSpec struct {
	Hue  float64
	Tier int
}

type JudgeMove struct {
	Team          string
	Before, After string
}

type Member struct {
	Key   string `json:"key"`
	File  string `json:"file"`
	Where string `json:"where"`
	Word  string `json:"word"`
	// Handle is the member's short name inside this team (handle.go). It is
	// empty only while the member has no title to derive one from.
	Handle string `json:"handle,omitempty"`
	// Home marks the one membership, among all of this conversation's, that
	// names the manager it reports to (home.go): the nearest manager up this
	// team's chain. At most one membership of a key carries it, and only one
	// with a manager somewhere up its chain. [File.SetHome] moves it; tidy
	// picks it when there is none and never moves a valid one.
	Home bool `json:"home,omitempty"`
	// Started says this membership was made by the team manager's team_start
	// (a [KindStart] the interface carried out), which is the second rule a
	// home is picked by.
	Started bool `json:"started,omitempty"`
	// HandleBy is who chose Handle: [HandleByWords] for the word list's
	// instant guess, [HandleByModel] for the title model's word, and
	// [HandleByTyped] for a handle a person or the manager gave. "" is a
	// handle written before this was kept, and is read as the word list's
	// ([Member.HandleDerived]).
	HandleBy string `json:"handle_by,omitempty"`
}

type MemberState struct {
	// State is one of the State constants.
	State string
	// SinceActive is how long ago the member last did anything; 0 is not
	// known.
	SinceActive time.Duration
	// Question is the question the member is waiting on a person for, if any.
	Question string
	// Files are the files the member has touched.
	Files []string
	// ReportsTo is the name of the team whose manager this member reports to
	// when that is not this team (home.go): a shared member, which this
	// team's manager may read and send a note to, and not direct. A shared
	// member that is running is drawn busy for that team.
	ReportsTo string
}

type MoveBlock struct {
	Kind      string
	Team      string
	Name      string
	Depth     int
	Need      int
	Limit     int
	LimitFrom Origin
}

type MoveEffect struct {
	Reports []ReportMove
	Pools   []PoolMove
	Judges  []JudgeMove
}

type MoveNotice struct {
	Team  string
	Entry Entry
}

type Option struct {
	ID          string `json:"id"`
	Label       string `json:"label"`
	Consequence string `json:"consequence"`
}

type Origin struct {
	Kind string `json:"kind"`
	Team string `json:"team,omitempty"`
	Name string `json:"name,omitempty"`
}

type Packet struct {
	// ID is minted by [Raise].
	ID string `json:"id"`
	// Team is who decides it now: a team id, whose manager decides, or
	// [Person].
	Team string `json:"team"`
	// Origin is the team it was raised from, whose file holds it.
	Origin string `json:"origin"`
	// Kind is one of the Packet kinds.
	Kind string `json:"kind"`
	// RaisedBy is the raiser's handle, or [FromManager] or [Person].
	RaisedBy string `json:"raised_by"`
	// Parties are the sides, each with its own context. A question or a
	// judgement may have one.
	Parties  []Party  `json:"parties,omitempty"`
	Question string   `json:"question"`
	Options  []Option `json:"options,omitempty"`
	// Recommendation is optional; when there is one it names an option.
	Recommendation *Recommendation `json:"recommendation,omitempty"`
	// Report is a closing packet's report, and nil on every other kind.
	Report *ClosingReport `json:"report,omitempty"`
	// Cap is a cap packet's facts, and nil on every other kind.
	Cap *CapFacts `json:"cap,omitempty"`
	// State is one of the Packet states.
	State string `json:"state"`
	// DecidedBy is the deciding manager's handle, or [Person].
	DecidedBy string `json:"decided_by,omitempty"`
	// Decision is the chosen option's id, or the person's own words when none
	// fitted.
	Decision string `json:"decision,omitempty"`
	// Told records that the raiser was handed a decided answer.
	Told bool `json:"told,omitempty"`
	// Reason is the decider's reason, or the last escalation's.
	Reason string `json:"reason,omitempty"`
	// Trail is every escalation, oldest first.
	Trail []Hop `json:"trail,omitempty"`
	// Raised is when it was raised, At when it last changed.
	Raised time.Time `json:"raised"`
	At     time.Time `json:"at"`
}

type Party struct {
	Key     string `json:"key"`
	Handle  string `json:"handle,omitempty"`
	Team    string `json:"team,omitempty"`
	Context string `json:"context,omitempty"`
}

type PoolMove struct {
	Team                string
	Before, After       string
	BeforeCap, AfterCap float64
}

type Recommendation struct {
	Option string `json:"option"`
	Reason string `json:"reason"`
}

type Report struct {
	// Via is the team of the membership the line runs through.
	Via string `json:"via"`
	// Team is the managed team whose manager this is: Via itself or an
	// ancestor of it.
	Team string `json:"team"`
	// Manager is that manager's conversation key.
	Manager string `json:"manager"`
	// Distance is how many levels up from Via the manager's team is.
	Distance int `json:"distance"`
}

type ReportMove struct {
	Key           string
	Before, After Report
	Had, Has      bool
}

type Settings struct {
	QuestionsUp *bool    `json:"questions_up,omitempty"`
	CapUSDDay   *float64 `json:"cap_usd_day,omitempty"`
	DepthLimit  *int     `json:"depth_limit,omitempty"`
	SubShare    *float64 `json:"sub_share,omitempty"`
	// Wake is stored as "wake". A file from before wake was inheritable wrote
	// only "wake": false (on was written as nothing), and that spelling reads
	// here unchanged as an override to off.
	Wake *bool `json:"wake,omitempty"`
}

type Spend struct {
	Team  string  `json:"team"`
	Day   string  `json:"day"`
	USD   float64 `json:"usd"`
	Calls int     `json:"calls"`
	// ByMember is each counted conversation's share, by conversation key.
	ByMember map[string]float64 `json:"by_member,omitempty"`
}

type Team struct {
	// ID is random and minted once ([NewID]).
	ID   string
	Name string
	// Parent is the id of the team this one sits under, "" at the top level.
	Parent string
	// Members are the conversations, in the order the person stored them.
	Members []Member
	// Manager is the conversation key of the member that manages the team, ""
	// for none. It is always one of Members.
	Manager string
	// Hue and Tier are the team's colour (hue.go).
	Hue  float64
	Tier int
	Made time.Time
	// State is [TeamOpen] or [TeamClosed] (lifecycle.go); the empty string a
	// file from before the lifecycle wrote reads as open. ClosedAt is when it
	// closed, ClosedWith the id of the team whose close closed it (itself, or
	// the ancestor a cascade came from), and Report the id of its closing
	// report packet, "" for a team closed without one.
	State      string
	ClosedAt   time.Time
	ClosedWith string
	Report     string
	// Root marks the one team that holds every other (root.go): the `All
	// teams` row, made when the person gives it a manager.
	Root bool
	// Settings are the team's own delegation overrides (teamsettings.go),
	// each unset field inheriting from the parent chain and then the
	// profile's `teams.` defaults. They are stored flat on the team.
	Settings Settings
	// Wrap is a wrap-up in progress (wrap.go): when it started and how long
	// it was given. Nil is none, which is also what a file from before the
	// field was kept reads as.
	Wrap *Wrap
	// contains filtered or unexported fields
}

type Thread struct {
	// Root is the message the thread began with.
	Root Entry
	// Replies is everything that answers it, oldest first.
	Replies []Entry
	// Latest is the id of the newest entry in the thread, which is what orders
	// threads by activity.
	Latest string
}

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

type Wrap struct {
	// Started is when the wrap-up began.
	Started time.Time `json:"started"`
	// Bound is how long it was given. It is stored as a number of nanoseconds,
	// which is how a duration is written in JSON, so an old reader that does
	// not know the field still leaves it alone.
	Bound time.Duration `json:"bound"`
}