providers

type ErrProviderNotFoundBy struct {
	Name  string
	Trait string
}

type ProviderClassDefinition struct {
	Traits             []db.ProviderType
	AuthorizationFlows []db.AuthorizationFlow
}

type ProviderStore interface {
	// Create creates a new provider in the database
	Create(
		ctx context.Context, providerClass db.ProviderClass, name string, projectID uuid.UUID, config json.RawMessage,
	) (*db.Provider, error)
	// GetByID returns the provider identified by its UUID primary key.
	// This should only be used in places when it is certain that the requester
	// is authorized to access this provider.
	GetByID(ctx context.Context, providerID uuid.UUID) (*db.Provider, error)
	// GetByIDProject returns the provider identified by its UUID primary key.
	// ProjectID is also used in the query to prevent unauthorized access
	// when used in API endpoints
	GetByIDProject(ctx context.Context, providerID uuid.UUID, projectID uuid.UUID) (*db.Provider, error)
	// GetByName returns the provider instance in the database as
	// identified by its project ID and name. All parent projects of the
	// specified project are included in the search.
	GetByName(ctx context.Context, projectID uuid.UUID, name string) (*db.Provider, error)
	// GetByNameInSpecificProject returns the provider instance in the database as
	// identified by its project ID and name. Unlike `GetByName` it will only
	// search in the specified project, and ignore the project hierarchy.
	GetByNameInSpecificProject(ctx context.Context, projectID uuid.UUID, name string) (*db.Provider, error)
	// GetByTraitInHierarchy returns the providers in the project which match the
	// specified trait. All parent projects of the specified project are
	// included in the search. The providers are optionally filtered by name.
	// Note that if error is nil, there will always be at least one element
	// in the list of providers which is returned.
	GetByTraitInHierarchy(
		ctx context.Context,
		projectID uuid.UUID,
		name string,
		trait db.ProviderType,
	) ([]db.Provider, error)
	// Delete removes the provider configuration from the database
	Delete(ctx context.Context, providerID uuid.UUID, projectID uuid.UUID) error
}