types

type Capability string

type Connection struct {
	// LastRefresh is the time when the auth context was last refreshed
	// +optional
	LastRefresh time.Time `json:"last_refresh"`

	// Data is an optional map of arbitrary data that can be used to store additional information about the connection,
	// such as credential file locations, etc.
	//
	// This data is exposed to the user in the UI under the settings panel for the namespace. If the data is sensitive,
	// it should be stored in the SensitiveData field.
	// +optional
	Data map[string]any `json:"data"`

	// Labels is a map of arbitrary key-value pairs that can be used to store additional information about the connection.
	// Users will likely use and modify these labels to help organize and categorize their connections.
	Labels map[string]any `json:"labels"`

	// ID is the unique identifier for the connection that makes sense to the plugin implementation.
	// +required
	ID string `json:"id"`

	// UID is an autogenerated unique identifier for the connection that the IDE will use to identify and track.
	UID string `json:"uid"`

	// Name is the readable name of the connection. Editable by the user.
	// +required
	Name string `json:"name"`

	// Description is an optional description of the connection. This is primarily for the user to customize
	// the visual representation of the connection.
	// +optional
	Description string `json:"description"`

	// Avatar is an optional image that can be used to represent the connection. This is primarily for the user to customize
	// the visual representation of the connection in the UI.
	// +optional
	Avatar string `json:"avatar"`

	// ExpiryTime is the amount of time before the connection expires.
	// +optional
	ExpiryTime time.Duration `json:"expiry_time"`

	// Client is a client structure that should be populated when the connection is created and used for connections
	Client any
	// contains filtered or unexported fields
}

type ConnectionContext Connection

type ConnectionOpts struct {
	// Data is an optional map of arbitrary data that can be used to store additional information about the namespace.
	Data map[string]any

	// SensitiveData is an optional map of arbitrary data that can be used to store additional information about the
	SensitiveData map[string]any

	// Labels is a map of arbitrary key-value pairs that can be used to store additional information about the namespace.
	Labels map[string]any

	// ID is the unique identifier for the authorization context that makes sense to the
	ID string

	// UID is an autogenerated unique identifier for the authorization context that the IDE.
	// will use to identify the authorization context.
	UID string

	// Name is the readable name of the namespace.
	Name string

	// Description is an optional description of the namespace. This is primarily for the user to customize
	Description string

	// Avatar is an optional image that can be used to represent the namespace. This is primarily for the user to customize
	Avatar string

	// ExpiryTime is the amount of time before the auth context expires
	ExpiryTime time.Duration
}

type ConnectionStatus struct {
	// Connection is the connection that the status is for.
	Connection *Connection `json:"connection"`
	// StatusCode is the status code of the connection status.
	Status ConnectionStatusCode `json:"status"`
	// Error is the error that occurred when checking the connection status.
	Error string `json:"error"`
	// Message is a human readable message that describes the status.
	Details string `json:"details"`
}

type ConnectionStatusCode string

type Plugin struct {
	ID           string              `json:"id"`
	Metadata     config.PluginMeta   `json:"metadata"`
	Config       config.PluginConfig `json:"-"`
	Enabled      bool                `json:"enabled"`
	Running      bool                `json:"running"`
	DevMode      bool                `json:"devMode"`
	DevPath      string              `json:"devPath"`
	Loading      bool                `json:"loading"`
	LoadError    string              `json:"loadError"`
	Phase        string              `json:"phase,omitempty"`
	Capabilities []PluginType        `json:"capabilities"`
	LastError    string              `json:"lastError,omitempty"`

	// Runtime fields — not serialized.
	RPCClient    interface{} `json:"-"`
	PluginClient interface{} `json:"-"`
}

type PluginContext struct {
	// Current context
	Context context.Context `json:"-"`

	// RequestOptions are the options that were set for the request.
	RequestOptions *RequestOptions `json:"request_options"`

	// Connection holds the identifier of the auth context for the plugin.
	Connection *Connection `json:"connection"`

	// The resource context for the request, if available
	ResourceContext *ResourceContext `json:"resource_context"`

	// The plugin settings for the request
	PluginConfig settings.Provider `json:"-"`

	// GlobalSettings are settings that are accessible to all plugins, taken
	// from the global settings in the IDE section
	GlobalConfig *config.GlobalConfig `json:"global_config"`

	// Unique ID for the request
	RequestID string `json:"request_id"`

	// The ID of the requester
	RequesterID string `json:"requester_id"`
}

type PluginInfo struct {
	ID           string            `json:"id"`
	Metadata     config.PluginMeta `json:"metadata"`
	Phase        string            `json:"phase"`
	Enabled      bool              `json:"enabled"`
	DevMode      bool              `json:"devMode"`
	DevPath      string            `json:"devPath,omitempty"`
	Capabilities []Capability      `json:"capabilities"`
	LastError    string            `json:"lastError,omitempty"`
}

type PluginType int

type RequestOptions struct {
	// The timeout for the request
	Timeout time.Duration `json:"timeout"`

	// The maximum number of retries for the request, if set
	MaxRetries int `json:"max_retries"`

	// The backoff interval for the request
	BackoffInterval time.Duration `json:"backoff_interval"`
}

type ResourceContext struct {
	// Key identifies the resource type being requested
	Key string `json:"key"`
}

type VisualComponentList struct {
	Resource []VisualResourceComponent `json:"resource"`
}

type VisualResourceComponent struct {
	ID        string   `json:"id"`
	Plugin    string   `json:"plugin"`
	Type      string   `json:"type"`
	Resources []string `json:"resources"`
}