tuicontract

package
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 24, 2026 License: MIT Imports: 1 Imported by: 0

Documentation

Overview

Package tuicontract defines the product-owned offline browse boundary.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Data

type Data struct {
	Repositories   []Item            `json:"repositories"`
	Threads        []Item            `json:"threads"`
	Clusters       []Item            `json:"clusters"`
	Investigations []Item            `json:"investigations"`
	Opportunities  []Item            `json:"opportunities"`
	Windows        map[string]Window `json:"windows,omitempty"`
}

Data is the offline dataset loaded by the reader.

type Facet

type Facet struct {
	Name     string `json:"name"`
	Present  bool   `json:"present"`
	Complete bool   `json:"complete"`
	AsOf     string `json:"as_of,omitempty"`
}

Facet describes coverage for one data facet.

type Item

type Item struct {
	Kind     string  `json:"kind"`
	ID       string  `json:"id"`
	Ref      string  `json:"ref"`
	Title    string  `json:"title"`
	Subtitle string  `json:"subtitle,omitempty"`
	Detail   string  `json:"detail,omitempty"`
	Source   string  `json:"source,omitempty"`
	AsOf     string  `json:"as_of,omitempty"`
	Coverage []Facet `json:"coverage,omitempty"`
}

Item is one browsable record.

type Reader

type Reader interface {
	Load(ctx context.Context) (Data, error)
}

Reader is a narrow local data source. Implementations must not perform network I/O.

type Window

type Window struct {
	Total     int  `json:"total"`
	Truncated bool `json:"truncated"`
}

Window distinguishes the loaded browse window from its source population.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL