protocol

type Document struct {
	ID      DocumentID
	Updated time.Time
	Title   string
	Text    string
	Alive   bool
}

type DocumentID string

type DocumentReference struct {
	ID      DocumentID
	Updated time.Time
}

type DocumentRequest struct {
	Space  string
	Wanted []DocumentID
}

type DocumentUpdate struct {
	Space     string
	Documents []Document
}

type IndexStatus struct {
	IndexID        string
	Version        string
	DocCount       uint64
	LastUpdate     time.Time
	ShardgroupSize uint16
	Shardgroup     uint16
	Status         IndexStatusCode
}

type IndexStatusCode uint8

type IndexUpdate struct {
	Space   string
	Updates []DocumentReference
}

type IndexUpdateRequest struct {
	Space         string
	FromTime      time.Time
	AfterDocument DocumentID
	Limit         uint16
}

type SearchHit struct {
	Space   string
	ID      DocumentID
	Snippet string
	Rank    float32
}

type SearchRequest struct {
	// Spaces to search
	Spaces []string
	// Query string in letarette syntax
	Query string
	// Maximum number of hits returned in one page
	PageLimit uint16
	// Zero-indexed page of hits to retrieve
	PageOffset uint16
	// When true, spelling mistakes are "fixed"
	// and the resulting query is automatically performed.
	// In either case, spell-fixed queries are returned
	// in the SearchResult Respelt field.
	Autocorrect bool
}

type SearchResponse struct {
	Result   SearchResult
	Duration float32
	Status   SearchStatusCode
}

type SearchResult struct {
	Hits []SearchHit
	// When true, the search was truncated
	// Capped results are only locally sorted by rank
	Capped bool
	// When not empty, the original query had no matches,
	// and this is a respelt version of the query
	Respelt string
	// The summed Levenshtein distance for all respelt terms
	RespeltDistance float32
	// The total number of hits to the given query
	TotalHits int
}

type SearchStatusCode uint8

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