rest

type CompiledEndpoint struct {
	Endpoint *Endpoint
	Url      string
	Path     string
	Type     RequestType
}

type Config struct {
	HttpClient      *http.Client
	RateLimiter     RateLimiter
	RateLimiterOpts []RateLimiterOpt
	ApiUrl          string
	FileUrl         string
}

type ConfigOpt func(config *Config)

type Endpoint struct {
	Method string
	Route  string
	Type   RequestType
}

type Form map[string]io.Reader

type QueryValues map[string]any

type RateLimiter interface {
	// MaxRetries is how many times should a request be retried
	// if it fails due to rate limiting?
	MaxRetries() int
	// Reset the rate limiter.
	Reset()
	// WaitBucket waits for the bucket to be available.
	// Returns true if this is the first time the bucket is used,
	// and so the lock must be held over the request.
	WaitBucket(context.Context, *CompiledEndpoint) (bool, error)
	// UnlockBucket unlocks the bucket after a request has been sent.
	// Takes in the boolean returned by WaitBucket.
	UnlockBucket(context.Context, *CompiledEndpoint, *http.Response, bool) error
}

type RateLimiterConfig struct {
	// MaxRetries is the maximum number of retries that can be performed
	// before giving up.
	MaxRetries int
	// CleanupInterval is the interval at which the rate limiter will
	// clean up old buckets.
	CleanupInterval time.Duration
}

type RateLimiterOpt func(config *RateLimiterConfig)

type RequestConfig struct {
	Ctx context.Context
}

type RequestOpt func(config *RequestConfig)

type RequestType int

type Rest interface {
	Request(endpoint *CompiledEndpoint, data any, response any, opts ...RequestOpt) (*http.Response, error)
	HttpClient() *http.Client
	RateLimiter() RateLimiter
	// Files
	UploadAttachment(file io.Reader, spoiler bool) (models.FileData, error)
	UploadFile(bucket string, fileData io.Reader, spoiler bool) (file models.FileData, err error)
	GetAttachment(id string) (io.ReadCloser, error)
	GetFile(bucket, id string) (io.ReadCloser, error)
	GetAttachmentData(id string) (models.FileData, error)
	GetFileData(bucket, id string) (fileData models.FileData, err error)
	GetStaticFile(name string) (io.ReadCloser, error)
	// Instance
	GetInstanceInfo() (info models.InstanceInfo, err error)
	// Messaging
	CreateMessage(messageCreate types.MessageCreate) (message models.Message, err error)
}