schema

type Artwork struct {
	ETag ArtworkKey `json:"key"`
	ArtworkMeta
	CreatedAt time.Time `json:"created_at"`
}

type ArtworkInfo struct {
	ETag      ArtworkKey `json:"key"`
	Type      string     `json:"type"`
	Width     uint64     `json:"width"`
	Height    uint64     `json:"height"`
	CreatedAt time.Time  `json:"created_at"`
}

type ArtworkInfoKey ArtworkKey

type ArtworkKey string

type ArtworkMeta struct {
	Data   []byte `json:"data"`
	Type   string `json:"type"`
	Width  uint64 `json:"width"`
	Height uint64 `json:"height"`
}

type ArtworkUploadRequest struct {
	Data types.File `json:"data" validate:"required"`
}

type CreateObjectRequest struct {
	ObjectKey
	Body        io.Reader `json:"-"`
	IfNotExists bool      // if true, fail with ErrConflict when the object already exists
	ModTime     time.Time `json:"last-modified,omitzero"`
	ObjectMeta
}

type DeleteObjectRequest struct {
	ObjectKey
}

type DeleteObjectsRequest struct {
	ObjectKey
}

type DeleteObjectsResponse struct {
	Body []Object `json:"body,omitempty"` // list of deleted objects
}

type GetArtworkRequest struct {
	Key             ArtworkKey `json:"key" validate:"required"`
	IfModifiedSince *time.Time `json:"if_modified_since,omitempty"`
	IfNoneMatch     *string    `json:"if_none_match,omitempty"`
}

type GetObjectRequest struct {
	ObjectKey
}

type LLMProvider struct {
	LLMProviderCreate
	CreatedAt time.Time `json:"created_at,omitempty"`
}

type LLMProviderCreate struct {
	LLMProviderMeta
	Provider string `json:"provider,omitempty" enum:"anthropic,gemini,mistral,ollama,openai" arg:"" help:"Provider type"`
}

type LLMProviderList struct {
	LLMProviderListRequest
	Count uint64         `json:"count,omitempty"`
	Body  []*LLMProvider `json:"body,omitempty"`
}

type LLMProviderListRequest struct {
	pg.OffsetLimit
}

type LLMProviderMeta struct {
	Name       *string `json:"name,omitempty" help:"Provider name"`
	URL        *string `json:"url,omitempty" help:"Provider URL (only used for the ollama provider)"`
	Credential *string `json:"credential,omitempty" help:"Credential key for authentication (required for all providers except ollama)"`
}

type LLMProviderName string

type Meta struct {
	Key   string          `json:"key,omitempty"`
	Value json.RawMessage `json:"value,omitempty"`
}

type Metadata struct {
	Key       string    `json:"key,omitempty"`
	IndexedAt time.Time `json:"indexed_at,omitzero"`
	MetadataCreate
}

type MetadataCreate struct {
	Filename   string    `json:"filename,omitempty"`
	Etag       string    `json:"etag,omitempty"`
	Size       int64     `json:"size"`
	ModifiedAt time.Time `json:"modified_at,omitzero"`
	MetadataMeta
}

type MetadataKV struct {
	Metadata string          `json:"-"`
	Key      string          `json:"key,omitempty"`
	Value    json.RawMessage `json:"value,omitempty"`
}

type MetadataKey string

type MetadataList struct {
	MetadataListRequest
	Count uint64      `json:"count"`
	Body  []*Metadata `json:"body"`
}

type MetadataListRequest struct {
	Title *string `json:"title,omitempty" help:"filter by title"`
	Type  *string `json:"type,omitempty" help:"media type filter"`
	pg.OffsetLimit
}

type MetadataMeta struct {
	Title    string       `json:"title,omitempty"`
	Type     string       `json:"media_type,omitempty"`
	Summary  *string      `json:"summary,omitempty"`
	Tags     []string     `json:"tags,omitempty"`
	Metadata []MetadataKV `json:"metadata,omitempty"`
}

type MetadataQueryRequest struct {
	Query string  `json:"query,omitempty" arg:"" required:"" help:"full text search query"`
	Type  *string `json:"type,omitempty" help:"media type filter"`
	pg.OffsetLimit
}

type Object struct {
	ObjectKey
	ObjectMeta
	ObjectAttr
	Artwork []ArtworkInfo `json:"artwork,omitempty"`
}

type ObjectArtwork struct {
	ObjectKey
	ArtworkKey ArtworkKey `json:"artwork_key"`
}

type ObjectAttr struct {
	Size    *int64    `json:"size,omitempty"`
	ETag    *string   `json:"etag,omitempty"`
	ModTime time.Time `json:"last-modified,omitzero"`
}

type ObjectCreate struct {
	ObjectKey
	ObjectMeta
	ObjectAttr
}

type ObjectKey struct {
	Volume string `json:"volume,omitempty" arg:"" required:"" help:"Volume name"`
	Path   string `json:"path,omitempty" arg:"" required:"" help:"Object path"`
}

type ObjectList struct {
	ObjectListRequest
	Count int       `json:"count,omitempty"` // total number of matching objects, before offset/limit
	Body  []*Object `json:"body,omitempty"`  // page of objects; nil when Limit==0 (count-only)
}

type ObjectListFilters struct {
	Path      *string `json:"path,omitempty"`                             //  Path prefix within the backend
	Recursive bool    `json:"recursive,omitempty" short:"r" negatable:""` // List all objects or directories recursively, otherwise list only immediate children
	Type      *string `json:"type,omitempty"`                             // optional content type to filter by. If text/directory, will return directories, rather than objects
}

type ObjectListIterator struct {
	Path      *string   `json:"path,omitempty"`                             // Path prefix within the backend
	Type      *string   `json:"type,omitempty"`                             // optional content type to filter by. If text/directory, will return directories, rather than objects
	Recursive bool      `json:"recursive,omitempty" short:"r" negatable:""` // List all objects or directories recursively, otherwise list only immediate children
	Token     any       `json:"-"`                                          // optional token to continue listing from a previous request
	Body      []*Object `json:"body,omitempty"`                             // page of objects or folders returned by the backend
}

type ObjectListRequest struct {
	Volume string `json:"volume" arg:"" required:""` // Volume name to filter by
	pg.OffsetLimit
	ObjectListFilters
}

type ObjectMeta struct {
	ContentType string `json:"type,omitempty"`
	Meta        []Meta `json:"meta,omitempty"`
}

type ObjectTouch ObjectKey

type PruneObjectsRequest struct {
	ObjectListRequest
	LastIndexed *time.Time `json:"last_indexed,omitempty"`
}

type ReadObjectRequest struct {
	ObjectKey
}

type SearchList struct {
	SearchListRequest
	Count uint64          `json:"count"`
	Body  []*SearchResult `json:"body"`
}

type SearchListRequest struct {
	Volumes []string `json:"volumes" help:"List of volumes to search"`
	Text    string   `json:"query" arg:"" name:"query" help:"Search query"`
	pg.OffsetLimit
}

type SearchResult struct {
	Title   string  `json:"title"`
	Summary string  `json:"summary"`
	Rank    float64 `json:"rank"`
	Object
}

type Volume struct {
	VolumeCreate
	Name                string     `json:"name,omitempty"`
	CreatedAt           time.Time  `json:"created_at,omitempty"`
	IndexedAt           *time.Time `json:"indexed_at,omitempty"`
	Objects             uint64     `json:"objects,omitempty"`
	LastIndexedObjectAt *time.Time `json:"last_indexed_object_at,omitempty"`
}

type VolumeCreate struct {
	URL string `json:"url,omitempty" arg:"" help:"URL of the volume to create"`
	VolumeMeta
}

type VolumeList struct {
	VolumeListRequest
	Count uint64    `json:"count,omitempty"`
	Body  []*Volume `json:"body,omitempty"`
}

type VolumeListRequest struct {
	Enabled *bool `json:"enabled,omitempty" help:"returns only enabled or disabled volumes" negatable:""`
	Stale   bool  `json:"stale,omitzero" help:"returns volumes that need to be re-indexed" negatable:""`
	pg.OffsetLimit
}

type VolumeMeta struct {
	Enabled    *bool          `json:"enabled,omitempty" negatable:""`
	IndexDelta *time.Duration `json:"delta,omitempty"` // if non-zero, forces a full re-index if the last index is older than this duration
}

type VolumeName string

type VolumeTouch string