apps

type BotConnectorRef struct {
	ConnectorRef
	RegistryID string
	AppID      string
}

type BotDependencyRef struct {
	DependencyRef
	RegistryID string
	AppID      string
}

type ConnectorItem struct {
	Type         string
	Required     bool
	ConnectionID string
	// Connector is the bot's linked connection, nil until authorized.
	Connector *connectors.Connector
}

type ConnectorManager interface {
	Configured() bool
	List(ctx context.Context, botID string) ([]connectors.Connector, error)
	BeginOAuth(ctx context.Context, botID, connectorType, authMethod string) (connectsdk.OAuthAuthorization, error)
	CreateCredential(ctx context.Context, botID, connectorType, authMethod string, fields map[string]string) (connectors.Connector, error)
	Delete(ctx context.Context, botID, connectionID string) error
}

type ConnectorRef struct {
	InstallationID string
	ConnectorType  string
	ConnectionID   string
	Required       bool
}

type DependencyItem struct {
	ID string
	// Entry is the reconciled dependency, nil when the catalog does not
	// know the ID.
	Entry *workspacedeps.Entry
	// Shared is set when another installed App references the same
	// dependency on this target.
	Shared bool
}

type DependencyManager interface {
	List(ctx context.Context, botID string) (workspacedeps.ListResult, error)
	Refresh(ctx context.Context, botID string) (workspacedeps.ListResult, error)
	CheckUpdates(ctx context.Context, botID string) (workspacedeps.ListResult, error)
	Install(ctx context.Context, botID, depID, version string, sink workspacedeps.LogSink) (workspacedeps.OperationResult, error)
	Update(ctx context.Context, botID, depID, version string, sink workspacedeps.LogSink) (workspacedeps.OperationResult, error)
	Remove(ctx context.Context, botID, depID string, sink workspacedeps.LogSink) (workspacedeps.OperationResult, error)
	// EnsureRunning starts a stopped bot workspace before a mutating step.
	EnsureRunning(ctx context.Context, botID string) error
}

type DependencyRef struct {
	InstallationID string
	DependencyID   string
}

type Event struct {
	Type    string
	Kind    string
	ID      string
	Stream  string
	Data    string
	Status  string
	Version string
	Message string
}

type EventFunc func(Event)

type EventSink interface {
	Send(Event)
}

type InstallRequest struct {
	RegistryID string
	AppID      string
	Revision   string

	// Reason defaults to ReasonUser.
	Reason Reason
}

type Installation struct {
	ID    string
	BotID string

	RegistryID        string
	AppID             string
	Revision          string
	Version           string
	Status            Status
	Reason            Reason
	AvailableRevision string
	AvailableVersion  string
	LastCheckedAt     *time.Time
	LastError         string
	// Release is the immutable release document the installation
	// materialized; it lets the App view work without the Supermarket.
	Release     []byte
	InstalledAt time.Time
	UpdatedAt   time.Time
}

type Item struct {
	// Installation is nil for a discovered App.
	Installation *Installation
	RegistryID   string
	AppID        string
	Revision     string
	Version      string
	// Release is the materialized release; nil for discovered Apps and
	// for records whose cached release cannot be decoded.
	Release      *supermarket.AppDescriptor
	Discovered   bool
	Dependencies []DependencyItem
	Connectors   []ConnectorItem
}

type ListResult struct {
	Workspace              workspacedeps.WorkspaceState
	DataRoot               string
	DependencyCatalogStale bool
	Items                  []Item
}

type OperationResult struct {
	Installation Installation
	Steps        []StepResult
}

type Options struct {
	Store        Store
	Registry     RegistryClient
	Skills       SkillPublisher
	Dependencies DependencyManager
	Connectors   ConnectorManager
	Logger       *slog.Logger
	Now          func() time.Time
}

type Reason string

type RegistryClient interface {
	FetchRelease(ctx context.Context, registryID, appID, revision string) (supermarket.AppDescriptor, error)
	FetchCurrentApp(ctx context.Context, registryID, appID string) (supermarket.AppDescriptor, error)
}

type RemovalPreview struct {
	Installation Installation
	Dependencies []RemovalPreviewDependency
	Connectors   []RemovalPreviewConnector
	// RequiredApps are auto-installed Apps that no other App
	// would reference once this one is gone.
	RequiredApps []Installation
}

type RemovalPreviewConnector struct {
	Type         string
	ConnectionID string
	Action       string
	Reason       string
}

type RemovalPreviewDependency struct {
	ID     string
	Action string
	Reason string
}

type RemoveOptions struct {
	// RemoveUnreferencedRequired also removes the auto-installed Apps
	// listed by RemovalPreview.RequiredApps.
	RemoveUnreferencedRequired bool
}

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

type SkillPublisher interface {
	PublishSkills(ctx context.Context, botID string, pkg supermarket.AppDescriptor, expectedRevision string) (SkillTransaction, []supermarket.InstallSkillResponse, error)
	RemoveSkills(ctx context.Context, botID, registryID, appID, revision string) (SkillTransaction, error)
}

type SkillTransaction interface {
	Commit(ctx context.Context) error
	Rollback(ctx context.Context) error
}

type Status string

type StepResult struct {
	Kind    string
	ID      string
	Status  string
	Version string
	Error   string
}

type Store interface {
	Get(ctx context.Context, botID, registryID, appID string) (Installation, error)
	GetByID(ctx context.Context, botID, installationID string) (Installation, error)
	ListForBot(ctx context.Context, botID string) ([]Installation, error)
	Upsert(ctx context.Context, in UpsertInstallation) (Installation, error)
	SetStatus(ctx context.Context, botID, installationID string, status Status, lastError string) (Installation, error)
	SetRelease(ctx context.Context, botID, installationID, revision, version string, release []byte) (Installation, error)
	SetCheck(ctx context.Context, botID, installationID, availableRevision, availableVersion string, checkedAt time.Time) (Installation, error)
	Delete(ctx context.Context, botID, installationID string) (Installation, error)

	ListDependencyRefs(ctx context.Context, installationID string) ([]DependencyRef, error)
	ListBotDependencyRefs(ctx context.Context, botID string) ([]BotDependencyRef, error)
	AddDependencyRef(ctx context.Context, installationID, dependencyID string) error
	RemoveDependencyRef(ctx context.Context, installationID, dependencyID string) error

	ListConnectorRefs(ctx context.Context, installationID string) ([]ConnectorRef, error)
	ListBotConnectorRefs(ctx context.Context, botID string) ([]BotConnectorRef, error)
	UpsertConnectorRef(ctx context.Context, ref ConnectorRef) error
	SetConnectorRefConnection(ctx context.Context, installationID, connectorType, connectionID string) error
	ClearConnectorRefConnection(ctx context.Context, connectionID string) error
	RemoveConnectorRef(ctx context.Context, installationID, connectorType string) error
}

type UpdateRequest struct {
	RegistryID string
	AppID      string

	// Release moves the installation to the registry's current release.
	Release bool
	// Dependencies are updated to their latest version. Each must be one the
	// App references or, for a discovered canonical App, its own id.
	Dependencies []string
}

type UpsertInstallation struct {
	BotID string

	RegistryID string
	AppID      string
	Revision   string
	Version    string
	Status     Status
	Reason     Reason
	Release    []byte
}