stds3fx

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

type Config struct {
	// Buckets maps every bucket alias the code uses to the bucket name of the
	// environment, as alias:name pairs separated by commas.
	Buckets map[string]string `env:"BUCKETS,required"`
	// Endpoint is the URL of the S3 API, of AWS or an S3-compatible server. Its scheme
	// decides whether the client uses TLS.
	Endpoint string `env:"ENDPOINT" envDefault:"https://s3.amazonaws.com"`
	// PublicEndpoint is the URL clients send pre-signed requests to, when it is
	// not Endpoint. A signature covers the host, so a request signed for one
	// address fails at another. Leave it unset where both are the same.
	PublicEndpoint string `env:"PUBLIC_ENDPOINT"`
	// Region is the region the client signs for. Setting it spares the client
	// a bucket location lookup; most S3-compatible servers accept any region.
	Region string `env:"REGION" envDefault:"us-east-1"`
	// AccessKey and SecretKey are static credentials, such as those of an
	// S3-compatible server. Without them the client uses the AWS credential
	// sources.
	AccessKey string `env:"ACCESS_KEY"`
	SecretKey string `env:"SECRET_KEY"`
	// CreateAndUseRandomBuckets suffixes every bucket name with a random hex
	// string and creates the buckets on start, so parallel tests against one
	// server do not see each other's objects.
	CreateAndUseRandomBuckets bool `env:"CREATE_AND_USE_RANDOM_BUCKETS"`
	// AutoRemoveBuckets empties and deletes the random buckets on stop.
	AutoRemoveBuckets bool `env:"AUTO_REMOVE_BUCKETS"`
}

type Params struct {
	fx.In
	fx.Lifecycle

	Config Config
	Logs   *zap.Logger
}

type PostConditions struct {
	// ContentType, when set, is the only content type accepted.
	ContentType string
	// MinSize and MaxSize bound the object's size in bytes when MaxSize is
	// positive; set both to one size to require exactly it.
	MinSize, MaxSize int64
}

type PresignedRequest struct {
	Method string
	URL    string
	// Headers must be sent as they are; the signature covers them.
	Headers http.Header
	// Fields are the form fields of a POST, which a client sends as they are
	// in a multipart/form-data body, before the object in a "file" field. They
	// are empty for other methods.
	Fields    map[string]string
	ExpiresAt time.Time
}