provider

type Config map[string]any

type Credentials map[string]any

type Field struct {
	Name        string
	Label       string
	Type        FieldType
	Required    bool
	Help        string
	Placeholder string
	// Sensitive marks credential-bearing fields. The service refuses to log
	// or return these in API responses.
	Sensitive bool
}

type FieldType string

type Provider interface {
	// Name returns the stable identifier (e.g. "s3"). Must be unique across
	// providers and match the value persisted in backup_destinations.provider.
	Name() string

	// DisplayName returns a human-readable label (e.g. "Amazon S3").
	DisplayName() string

	// Description returns user-facing copy describing the provider.
	Description() string

	// ConfigSchema describes non-secret fields shown on the create form.
	ConfigSchema() []Field

	// CredentialSchema describes secret fields shown on the create form.
	CredentialSchema() []Field

	// Validate authenticates against the provider and verifies the supplied
	// config/credentials can perform a list-and-write operation against the
	// configured location. It MUST NOT mutate user data permanently; if
	// writing a probe is necessary, the probe must be cleaned up.
	Validate(ctx context.Context, cfg Config, creds Credentials) error

	// Upload streams a backup blob to the provider and returns the path.
	Upload(ctx context.Context, cfg Config, creds Credentials, in UploadInput) (*UploadResult, error)

	// List enumerates backups previously written by NinerLog to this
	// destination. Implementations should scope the listing to the
	// configured prefix and the well-known filename convention to avoid
	// returning unrelated objects.
	List(ctx context.Context, cfg Config, creds Credentials) ([]RemoteBackup, error)

	// Delete removes one object at path.
	Delete(ctx context.Context, cfg Config, creds Credentials, path string) error
}

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

type RemoteBackup struct {
	Path         string
	SizeBytes    int64
	LastModified time.Time
}

type UploadInput struct {
	// Reader yields the backup contents (gzipped JSON in the current
	// implementation, though the provider treats it as opaque bytes).
	Reader io.Reader
	// Size is the exact number of bytes in Reader; required for many SDKs.
	Size int64
	// Filename is a suggestion; the provider may prepend a prefix derived from
	// Config. Example: "ninerlog-backup-2025-11-19T03-00-00Z.json.gz".
	Filename string
	// ContentType describes the payload; typically "application/gzip" or
	// "application/json".
	ContentType string
}

type UploadResult struct {
	// RemotePath uniquely identifies the uploaded object within the destination.
	RemotePath string
}