api

type Action = ActionType

type ActionResult struct {
	UnitID  uuid.UUID `description:"UUID of the Unit on which the action is performed"`
	SpaceID uuid.UUID `description:"UUID of the Space of the Unit on which the action is performed"`
	// OrganizationID comes from the worker
	// QueuedOperationID links this result back to the original operation request.
	QueuedOperationID uuid.UUID `description:"UUID of the operation corresponding to the action request"`
	ActionResultBaseMeta
	Data      []byte `` /* 130-byte string literal not displayed */
	LiveData  []byte `` /* 138-byte string literal not displayed */
	LiveState []byte `` /* 130-byte string literal not displayed */
	// ResourceStatuses contains per-resource sync and readiness status.
	// Key format: "apiVersion/kind#namespace/name" (e.g., "apps/v1/Deployment#default/my-app")
	ResourceStatuses ResourceStatusMap `json:",omitempty" description:"Per-resource sync and readiness status"`
}

type ActionResultBaseMeta struct {
	RevisionNum  int64
	Action       ActionType       `bun:",notnull" swaggertype:"string"`
	Result       ActionResultType `bun:",notnull,default:'None'" swaggertype:"string"`
	Status       ActionStatusType `bun:",notnull,default:'None'" swaggertype:"string"`
	Message      string           `bun:"type:text"`
	StartedAt    time.Time        `json:",omitempty" bun:"type:timestamptz"`
	TerminatedAt *time.Time       `json:",omitempty" bun:"type:timestamptz"`
}

type ActionResultMeta = ActionResultBaseMeta

type ActionResultType string

type ActionStatus = ActionStatusType

type ActionStatusType string

type ActionType string

type Bridge = BridgeWorker

type BridgeContext = BridgeWorkerContext

type BridgeInfo = BridgeWorkerInfo

type BridgeOption struct {
	Name        string           `description:"Name of the option in PascalCase"`
	Description string           `description:"Description of the option"`
	Required    bool             `description:"Whether the option is required"`
	DataType    funcapi.DataType `swaggertype:"string" description:"Data type of the option"`
	Example     string           `json:",omitempty" description:"Example value"`
}

type BridgePayload = BridgeWorkerPayload

type BridgeWorker interface {
	ID() BridgeWorkerID
	Info(InfoOptions) BridgeWorkerInfo
	Apply(BridgeWorkerContext, BridgeWorkerPayload) error
	Refresh(BridgeWorkerContext, BridgeWorkerPayload) error
	Import(BridgeWorkerContext, BridgeWorkerPayload) error
	Destroy(BridgeWorkerContext, BridgeWorkerPayload) error
	Finalize(BridgeWorkerContext, BridgeWorkerPayload) error
}

type BridgeWorkerContext interface {
	Context() context.Context
	GetServerURL() string
	GetWorkerID() string
	SendStatus(*ActionResult) error
}

type BridgeWorkerEventRequest struct {
	Action  ActionType `description:"The action requested"`
	Payload BridgeWorkerPayload
}

type BridgeWorkerID struct {
	ProviderType   ProviderType
	ToolchainTypes []workerapi.ToolchainType
}

type BridgeWorkerInfo struct {
	SupportedConfigTypes []*SupportedConfigType `json:",omitempty" description:"Configuration types of the bridges supported by the worker"`
}

type BridgeWorkerPayload struct {
	QueuedOperationID uuid.UUID               `description:"UUID of the operation corresponding to the requested action"`
	ToolchainType     workerapi.ToolchainType `description:"ToolchainType of the Unit on which the action was performed"`
	ProviderType      ProviderType            `description:"ProviderType of the Target attached to the Unit on which the action was performed"`
	BridgeHandle      string                  `` /* 127-byte string literal not displayed */

	// Keep relatively consistent with FunctionContext
	UnitSlug         string            `description:"Slug of the Unit on which the action was performed"`
	UnitID           uuid.UUID         `description:"UUID of the Unit on which the action was performed"`
	UnitLabels       map[string]string `description:"Labels of the Unit on which the action was performed"`
	UnitAnnotations  map[string]string `description:"Annotations of the Unit on which the action was performed"`
	SpaceSlug        string            `description:"Slug of the Space of the Unit on which the action was performed"`
	SpaceID          uuid.UUID         `description:"UUID of the Space of the Unit on which the action was performed"`
	SpaceLabels      map[string]string `description:"Labels of the Space of the Unit on which the action was performed"`
	SpaceAnnotations map[string]string `description:"Annotations of the Space of the Unit on which the action was performed"`
	OrganizationID   uuid.UUID         `description:"UUID of the Organization of the Unit on which the action was performed"`
	TargetID         uuid.UUID         `description:"UUID of the Target attached to the Unit on which the action was performed"`

	DryRun                  bool                    `description:"Whether the action is a dry run"`
	Data                    []byte                  `swaggertype:"string" format:"byte" description:"Configuration data of the Unit on which the action was performed"`
	LiveData                []byte                  `swaggertype:"string" format:"byte" description:"Live Data corresponding to the Unit"`
	LiveState               []byte                  `swaggertype:"string" format:"byte" description:"Live State corresponding to the Unit"`
	TargetOptions           map[string]string       `json:",omitempty" description:"Options from the matching ConfigType of the Target for the Unit's ToolchainType"`
	TargetParams            []byte                  `` /* 128-byte string literal not displayed */
	ExtraParams             []byte                  `swaggertype:"string" format:"byte" description:"Additional parameters associated with the action sent to the worker"`
	RevisionNum             int64                   `description:"Sequence number of the revision of the Unit on which the action was performed"`
	LiveRevisionNum         int64                   `description:"Sequence number of the current live revision of the Unit on which the action was performed"`
	DriftReconciliationMode DriftReconciliationMode `description:"The drift reconciliation mode for the unit at the time of the operation"`
}

type ConfigType struct {
	ProviderType  ProviderType            `swaggertype:"string" description:"Type identifying a bridge implementation supported by the worker"`
	ToolchainType workerapi.ToolchainType `swaggertype:"string" description:"Configuration toolchain and format implemented by this bridge of the worker"`
	LiveStateType workerapi.ToolchainType `` /* 172-byte string literal not displayed */
}

type ConfigTypeSignature struct {
	ConfigType
	Options []BridgeOption `json:",omitempty" description:"Supported bridge options"`
}

type DriftReconciliationMode string

type EventMessage struct {
	Event string
	Data  interface{}
}

type FunctionWorker interface {
	Info() FunctionWorkerInfo
	Invoke(FunctionWorkerContext, funcApi.FunctionInvocationRequest) (funcApi.FunctionInvocationResponse, error)
}

type FunctionWorkerContext interface {
	Context() context.Context
}

type FunctionWorkerEventRequest struct {
	// Action defines the operation the function worker should perform.
	Action ActionType `description:"Action defines the operation the function worker should perform."`

	// Payload contains the data required for the action, primarily the function invocation details.
	Payload FunctionWorkerPayload `description:"Payload contains the data required for the action, primarily the function invocation details."`
}

type FunctionWorkerInfo struct {
	ToolchainTypes     []workerapi.ToolchainType                                        `description:"Supported ToolchainTypes"`
	SupportedFunctions map[workerapi.ToolchainType]map[string]funcApi.FunctionSignature `description:"Signatures of supported functions by ToolchainType"`
}

type FunctionWorkerPayload struct {
	// QueuedOperationID is the identifier of the original queued operation request.
	QueuedOperationID uuid.UUID `description:"QueuedOperationID is the identifier of the original queued operation request."`

	// InvocationRequest encapsulates the full request for invoking one or more functions,
	// including context, configuration data, function calls, and execution options.
	// This structure is defined in the functions plugin's API package.
	InvocationRequest funcApi.FunctionInvocationRequest `` /* 175-byte string literal not displayed */
}

type InfoOptions struct {
	WorkerSlug string
}

type ProviderType string

type RefreshParams struct {
	BaseRevisionData []byte `description:"Data to diff with the live state for refresh"`
}

type ResourceInfo struct {
	ResourceName string `` /* 206-byte string literal not displayed */
	ResourceType string `` /* 214-byte string literal not displayed */
}

type ResourceReadinessType string

type ResourceStatus struct {
	// SyncStatus indicates whether config was pushed to the target
	SyncStatus ResourceSyncStatusType `json:",omitempty" description:"Whether config was pushed to the target (Synced or NotSynced)"`
	// Readiness indicates the health/ready state from kstatus
	Readiness ResourceReadinessType `json:",omitempty" description:"Health state from kstatus (Ready, InProgress, Failed, Unknown)"`
	// Message provides human-readable status details
	Message string `json:",omitempty" description:"Human-readable status details or error message"`
	// UpdatedAt is the timestamp when this resource status was last updated
	UpdatedAt time.Time `json:",omitempty" description:"Timestamp when this resource status was last updated"`
}

type ResourceStatusMap map[funcApi.ResourceTypeAndName]ResourceStatus

type ResourceSyncStatusType string

type SupportedConfigType struct {
	ConfigTypeSignature
	AvailableTargets []Target `json:",omitempty" description:"Targets known by the BridgeWorker. Optional."`
}

type Target struct {
	BridgeHandle string                 `` /* 127-byte string literal not displayed */
	Name         string                 `json:",omitempty" description:"Used to set the Slug and DisplayName of the Target created in ConfigHub. Optional."`
	Params       map[string]interface{} `json:",omitempty" description:"Deprecated. Used to set the Parameters of the Target created in ConfigHub"`
}

type Toolchain = workerapi.ToolchainType

type WatchableWorker interface {
	WatchForApply(BridgeWorkerContext, BridgeWorkerPayload) error
	WatchForDestroy(BridgeWorkerContext, BridgeWorkerPayload) error
}

type WorkerEventRequest struct {
	Action  ActionType `description:"The action requested"`
	Payload WorkerPayload
}

type WorkerInfo struct {
	BridgeWorkerInfo   BridgeWorkerInfo   `description:"BridgeWorker capabilities"`
	FunctionWorkerInfo FunctionWorkerInfo `description:"FunctionWorker capabilities"`
}

type WorkerPayload struct {
	Timestamp int64 `description:"Time the action was requested"`
}