configversion

type Client struct {
	internal.JSONAPIClient
}

type ConfigUploader interface {
	// Upload uploads the config tarball and returns a status indicating success
	// or failure.
	Upload(ctx context.Context, config []byte) (ConfigurationStatus, error)
	// SetErrored sets the config version status to 'errored' in the store.
	SetErrored(ctx context.Context) error
}

type ConfigurationSource string

type ConfigurationStatus string

type ConfigurationVersion struct {
	ID                string
	CreatedAt         time.Time
	AutoQueueRuns     bool
	Source            ConfigurationSource
	Speculative       bool
	Status            ConfigurationStatus
	StatusTimestamps  []ConfigurationVersionStatusTimestamp
	WorkspaceID       string
	IngressAttributes *IngressAttributes
}

type ConfigurationVersionCreateOptions struct {
	AutoQueueRuns *bool
	Speculative   *bool
	*IngressAttributes
}

type ConfigurationVersionGetOptions struct {
	// ID of config version to retrieve
	ID *string

	// Get latest config version for this workspace ID
	WorkspaceID *string

	// A list of relations to include
	Include *string `schema:"include"`
}

type ConfigurationVersionListOptions struct {
	// A list of relations to include
	Include *string `schema:"include"`

	resource.PageOptions
}

type ConfigurationVersionService = Service

type ConfigurationVersionStatusTimestamp struct {
	Status    ConfigurationStatus
	Timestamp time.Time
}

type IngressAttributes struct {
	// ID     string
	Branch string
	// CloneURL          string
	// CommitMessage     string
	CommitSHA string
	CommitURL string
	// CompareURL        string
	Repo              string
	IsPullRequest     bool
	OnDefaultBranch   bool
	PullRequestNumber int
	PullRequestURL    string
	PullRequestTitle  string
	// PullRequestBody   string
	Tag             string
	SenderUsername  string
	SenderAvatarURL string
	SenderHTMLURL   string
}

type Options struct {
	logr.Logger

	WorkspaceAuthorizer internal.Authorizer

	internal.Cache
	*sql.DB
	*surl.Signer
}

type Service interface {
	CreateConfigurationVersion(ctx context.Context, workspaceID string, opts ConfigurationVersionCreateOptions) (*ConfigurationVersion, error)
	GetConfigurationVersion(ctx context.Context, id string) (*ConfigurationVersion, error)
	GetLatestConfigurationVersion(ctx context.Context, workspaceID string) (*ConfigurationVersion, error)
	ListConfigurationVersions(ctx context.Context, workspaceID string, opts ConfigurationVersionListOptions) (*resource.Page[*ConfigurationVersion], error)

	// Upload handles verification and upload of the config tarball, updating
	// the config version upon success or failure.
	UploadConfig(ctx context.Context, id string, config []byte) error

	// Download retrieves the config tarball for the given config version ID.
	DownloadConfig(ctx context.Context, id string) ([]byte, error)

	DeleteConfigurationVersion(ctx context.Context, cvID string) error
}