workspace

type Change struct {
	Path  Path
	Value any
}

type Conflict struct {
	ID     string `json:"id"`
	Ref    Ref    `json:"ref"`
	Path   Path   `json:"path"`
	Source Source `json:"source"`
	Pinned bool   `json:"pinned,omitempty"`
	// Theirs (pinned only), TheirsGone when that side removed it.
	Theirs     any  `json:"theirs,omitempty"`
	TheirsGone bool `json:"theirsGone,omitempty"`
}

type Item struct {
	Ref
	Value any `json:"value"`
}

type LogEntry struct {
	Version int64     `json:"version"`
	At      time.Time `json:"at"`
	By      string    `json:"by"`
	// Op is what wrote it (edit, apply, update, merge, resolve, reset,
	// commit, checkpoint); Items what changed.
	Op    string `json:"op"`
	Items []Ref  `json:"items"`
	Note  string `json:"note,omitempty"`
}

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

type Note struct {
	Source string `json:"source"`
	By     string `json:"by"`
	Text   string `json:"text"`
}

type Open struct {
	Conflict
	Mine, TheirsValue any
}

type Path []Step

type Ref struct {
	Kind string `json:"kind"`
	Key  string `json:"key"`
}

type Schema struct {
	// Lists are the lists whose elements are keyed, by the pattern of their
	// elements ("fields[]"), with the property keying them ("name"); any
	// other list is one value.
	Lists map[string]string
	// Unset are the values whose zero (empty text, false, null) means unset,
	// equal to no value at all.
	Unset map[string]bool
}

type Snapshot []Item

type Source struct {
	Kind string `json:"kind"`
	// ID is the revision or draft; By who wrote, for a workspace write.
	ID string `json:"id,omitempty"`
	By string `json:"by,omitempty"`
}

type Step struct {
	Field   string `json:"field,omitempty"`
	Element string `json:"element,omitempty"`
}

type Store interface {
	// Workspace is username's workspace; false when none is kept.
	Workspace(ctx context.Context, username string) (Workspace, bool, error)
	// PutWorkspace writes w while the kept one is at version expected (0:
	// none), recording entry with the new version, in one transaction; it
	// returns w as written, or ErrChanged.
	PutWorkspace(ctx context.Context, w Workspace, expected int64, entry LogEntry) (Workspace, error)
	// WorkspaceLog is username's log, newest first; limit <= 0 is all.
	WorkspaceLog(ctx context.Context, username string, limit int) ([]LogEntry, error)
}

type ValueConflict struct {
	Path Path
	// Mine is the local value, kept; Missing when removed locally.
	Mine any
	// Theirs is the other side's value; Missing when removed there.
	Theirs any
}

type Workspace struct {
	Username string
	// Base is the revision it builds on; Items its content, nil the base's.
	Base      int64
	Items     Snapshot
	Conflicts []Conflict
	Notes     []Note
	// Taken are drafts taken in; Checkpoint the draft last saved from it,
	// at version CheckpointAt (the workspace holds it while still there).
	Taken        []int64
	Checkpoint   int64
	CheckpointAt int64
	Version      int64
	UpdatedAt    time.Time
	// UpdatedBy is who wrote last: the administrator or agent:<token name>.
	UpdatedBy string
}