maps

type Archive struct {
	Bucket string `json:"-"`
	Key    string `json:"-"`
	Size   int64  `json:"size_bytes"`
	// Build is the OpenStreetMap data the archive was built from, as the
	// source's metadata dates it (the replication time), or the source build's
	// name when it carries none.
	Build   string         `json:"build"`
	MinZoom int            `json:"min_zoom"`
	MaxZoom int            `json:"max_zoom"`
	Bounds  pmtiles.Bounds `json:"bounds"`
	ReadyAt time.Time      `json:"ready_at"`
}

type Bucket struct {
	Objects Objects
	Name    string
}

type Deps struct {
	DB       *sql.DB
	Settings SettingsStore
	Regions  RegionStore
	Open     OpenBucket
	// Client is the outbound client a fetch reads its source through.
	Client *http.Client
	// Changed is called after anything the maps knowledge page shows has
	// changed: the settings, or a region becoming ready or going away.
	Changed func(ctx context.Context)
	// Every is the wait between fetch passes on a replica no one woke.
	Every time.Duration
	// IndexURL and BuildURL locate the Protomaps builds; empty is Protomaps'.
	IndexURL string
	BuildURL string
	// RetryPause is the wait before a failed range read is tried again; nil
	// is 1s, 4s, 9s.
	RetryPause func(attempt int) time.Duration
}

type Estimate struct {
	SizeBytes int64          `json:"size_bytes"`
	Tiles     uint64         `json:"tiles"`
	Build     string         `json:"build"`
	MinZoom   int            `json:"min_zoom"`
	MaxZoom   int            `json:"max_zoom"`
	Bounds    pmtiles.Bounds `json:"bounds"`
}

type EstimateInput struct {
	Preset string          `json:"preset,omitempty" example:"united-states"`
	Bounds *pmtiles.Bounds `json:"bounds,omitempty"`
}

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

type Objects interface {
	PutObjectStream(ctx context.Context, bucket, key string, body io.Reader, contentType string) (int64, error)
	GetObjectRange(ctx context.Context, bucket, key string, offset, length int64) ([]byte, int64, error)
	DeleteObject(ctx context.Context, bucket, key string) error
	ListDirectory(ctx context.Context, bucket, prefix string) ([]s3adapter.ObjectEntry, bool, error)
}

type OpenBucket func(ctx context.Context, s Settings) (Bucket, error)

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

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

type Preset struct {
	ID     string         `json:"id"`
	Name   string         `json:"name"`
	Bounds pmtiles.Bounds `json:"bounds"`
}

type Reader struct {
	Settings SettingsStore
	Regions  RegionStore
}

type Ready struct {
	ID      string         `json:"id"`
	Name    string         `json:"name"`
	URL     string         `json:"url"`
	Bounds  pmtiles.Bounds `json:"bounds"`
	MinZoom int            `json:"min_zoom"`
	MaxZoom int            `json:"max_zoom"`
	Build   string         `json:"build"`
	Size    int64          `json:"size_bytes"`
}

type Region struct {
	ID      string         `json:"id"`
	Name    string         `json:"name"`
	Preset  string         `json:"preset,omitempty"`
	Origin  string         `json:"origin"`
	Bounds  pmtiles.Bounds `json:"bounds"`
	MaxZoom int            `json:"max_zoom"`
	// State is the last fetch's: queued, fetching, ready or failed. A failed
	// refresh of a region that was ready keeps serving Archive.
	State         string     `json:"state"`
	ProgressBytes int64      `json:"progress_bytes"`
	TotalBytes    int64      `json:"total_bytes"`
	Error         string     `json:"error,omitempty"`
	RequestedAt   time.Time  `json:"requested_at"`
	StartedAt     *time.Time `json:"started_at,omitempty"`
	FinishedAt    *time.Time `json:"finished_at,omitempty"`
	Archive       *Archive   `json:"archive,omitempty"`
	CreatedBy     string     `json:"created_by,omitempty"`
}

type RegionInput struct {
	Preset string          `json:"preset,omitempty" example:"united-states"`
	ID     string          `json:"id,omitempty" example:"bay-area"`
	Name   string          `json:"name,omitempty" example:"Bay Area"`
	Bounds *pmtiles.Bounds `json:"bounds,omitempty"`
}

type RegionStore interface {
	List(ctx context.Context) ([]Region, error)
	Get(ctx context.Context, id string) (*Region, error)
	Create(ctx context.Context, r Region) error
	Delete(ctx context.Context, id string) (*Region, error)
	Requeue(ctx context.Context, id string, maxZoom int) error
	ResetStale(ctx context.Context) error
	ClaimNext(ctx context.Context) (*Region, error)
	Progress(ctx context.Context, id string, done, total int64) error
	Finish(ctx context.Context, id string, a Archive) (previous *Archive, ok bool, err error)
	Fail(ctx context.Context, id, reason string) error
	PutUpload(ctx context.Context, r Region) error
	DeleteUploadsExcept(ctx context.Context, keep []string) ([]Region, error)
}

type ResolvedBucket func(s Settings) string

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

type Settings struct {
	// Enabled turns the maps surface on: the archive routes answer, the fetch
	// runs, and the knowledge page lists the regions. Off by default.
	Enabled bool `json:"enabled"`
	// S3Connection names the S3 connection archives are written to. Empty is
	// the managed-resources connection.
	S3Connection string `json:"s3_connection"`
	// Bucket is the bucket archives are written to. Empty is the
	// managed-resources bucket.
	Bucket string `json:"bucket"`
	// MaxZoom is the deepest zoom a fetch extracts.
	MaxZoom int `json:"max_zoom"`
	// SourceURL is the archive a fetch extracts from. Empty is the current
	// Protomaps daily build, resolved when each fetch starts.
	SourceURL string `json:"source_url"`

	UpdatedBy string    `json:"-"`
	UpdatedAt time.Time `json:"-"`
}

type SettingsInput struct {
	Enabled      bool   `json:"enabled"`
	S3Connection string `json:"s3_connection"`
	Bucket       string `json:"bucket"`
	MaxZoom      int    `json:"max_zoom" example:"14"`
	SourceURL    string `json:"source_url"`
}

type SettingsStore interface {
	Get(ctx context.Context) (Settings, error)
	Set(ctx context.Context, s Settings, author string) error
}

type SettingsView struct {
	Enabled      bool   `json:"enabled"`
	S3Connection string `json:"s3_connection"`
	Bucket       string `json:"bucket"`
	MaxZoom      int    `json:"max_zoom"`
	SourceURL    string `json:"source_url"`
	// ResolvedBucket is the bucket archives are written to: Bucket, or the
	// managed-resources bucket when that is empty.
	ResolvedBucket string     `json:"resolved_bucket"`
	UpdatedBy      string     `json:"updated_by,omitempty"`
	UpdatedAt      *time.Time `json:"updated_at,omitempty"`
}

type State struct {
	Enabled bool    `json:"enabled"`
	Regions []Ready `json:"regions"`
}

type View struct {
	Settings SettingsView `json:"settings"`
	Regions  []Region     `json:"regions"`
	Presets  []Preset     `json:"presets"`
	// UploadPrefix is where in the bucket an operator puts a .pmtiles file to
	// serve it without a fetch.
	UploadPrefix string `json:"upload_prefix"`
	// DefaultSource is the source a fetch reads when source_url is empty.
	DefaultSource string `json:"default_source"`
}