schema

type BackendListResponse struct {
	Body map[string]string `json:"body"`
}

type CreateObjectRequest struct {
	Path        string
	Body        io.Reader  `json:"-"`
	ContentType string     // optional: MIME type of the object
	ModTime     time.Time  // optional: modification time (stored as metadata)
	Meta        ObjectMeta // optional: user-defined metadata
	IfNotExists bool       // if true, fail with ErrConflict when the object already exists
}

type DeleteObjectRequest struct {
	Path string
}

type DeleteObjectsRequest struct {
	Path      string `json:"path,omitempty"`
	Recursive bool   `json:"recursive,omitempty"` // if true, delete all objects recursively; if false, delete only immediate children
}

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

type GetObjectRequest struct {
	Path string
}

type ListObjectsRequest struct {
	Path      string `json:"path,omitempty"`      // optional path prefix within the backend
	Recursive bool   `json:"recursive,omitempty"` // if true, list all objects recursively; if false, list only immediate children
	Offset    int    `json:"offset,omitempty"`    // number of objects to skip before returning results (0-based)
	Limit     int    `json:"limit,omitempty"`     // max objects to return; 0 means count-only (Body will be nil)
}

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

type Object struct {
	Name        string     `json:"name,omitempty"`
	Path        string     `json:"path,omitempty"`
	Size        int64      `json:"size"`
	ModTime     time.Time  `json:"modtime,omitzero"`
	ContentType string     `json:"type,omitempty"`
	ETag        string     `json:"etag,omitempty"`
	Meta        ObjectMeta `json:"meta,omitempty"`
}

type ObjectMeta map[string]string

type ReadObjectRequest struct {
	GetObjectRequest
}

type UploadDone struct {
	// Files is the number of files successfully committed.
	Files int `json:"files"`

	// Bytes is the total number of bytes committed across all files.
	Bytes int64 `json:"bytes"`
}

type UploadError struct {
	// Index is the 0-based position of the file that failed.
	Index int `json:"index"`

	// Path is the destination object path that failed.
	Path string `json:"path"`

	// Message is the error description.
	Message string `json:"message"`
}

type UploadFile struct {
	// Index is the 0-based position of the file in the upload.
	Index int `json:"index"`

	// Path is the destination object path (normalised).
	Path string `json:"path"`

	// Written is the number of bytes transferred so far for this file.
	Written int64 `json:"written"`

	// Bytes is the declared size of this file in bytes, or 0 if unknown
	// (multipart parts rarely include Content-Length).
	Bytes int64 `json:"bytes,omitempty"`
}

type UploadStart struct {
	// Files is the number of files to be uploaded.
	Files int `json:"files"`

	// Bytes is the sum of declared part sizes in bytes, or 0 if unknown
	// (multipart parts rarely include Content-Length).
	Bytes int64 `json:"bytes,omitempty"`
}