sdk

type Client interface {
	VariableClient
	ConnectionClient
	XComClient
}

type Connection struct {
	ID string

	// The Connection type, as defined in Airflow
	Type string

	Host string
	Port int

	// Login/username of the connection. Optional, can be nil (nil is an indication of no login which is distinct from an empty login)
	Login *string
	// Password of the connection. Optional, can be nil.
	Password *string

	// The path. Called `Schema` in Airflow python code. For database connections this often contains the
	// database name.
	Path string

	Extra map[string]any
}

type ConnectionClient interface {
	// GetConnection returns the value of an Airflow Connection.
	//
	// If the conn is not found error will be a wrapped “ConnectionNotFound“:
	//
	//		conn, err := client.GetConnection(ctx, "my-db")
	//		if errors.Is(err, ConnectionNotFound) {
	//				// Handle not found, set default, return custom error etc
	//		} else {
	//				// Other errors here, such as http network timeouts etc.
	//		}
	GetConnection(ctx context.Context, connID string) (Connection, error)
}

type DagRun struct {
	DagID             string
	RunID             string
	LogicalDate       *time.Time
	DataIntervalStart *time.Time
	DataIntervalEnd   *time.Time
}

type TIRunContext interface {
	context.Context

	// TaskInstance identifies the task instance that is executing.
	TaskInstance() TaskInstance
	// DagRun identifies the Dag run the task instance belongs to.
	DagRun() DagRun
}

type TaskInstance struct {
	DagID  string
	RunID  string
	TaskID string
	// MapIndex is the index within a dynamically mapped task, or nil for an
	// unmapped (regular) task instance.
	MapIndex  *int
	TryNumber int
}

type VariableClient interface {
	// GetVariable returns the value of an Airflow Variable.
	//
	// It will first look in the os.environ for the appropriately named variable, and if not found there will
	// fallback to asking the API server
	//
	// If the variable is not found error will be a wrapped “VariableNotFound“:
	//
	//		val, err := client.GetVariable(ctx, "my-var")
	//		if errors.Is(err, VariableNotFound) {
	//				// Handle not found, set default, return custom error etc
	//		} else {
	//				// Other errors here, such as http network timeouts etc.
	//		}
	GetVariable(ctx context.Context, key string) (string, error)

	// UnmarshalJSONVariable fetches a variable and unmarshals its value into
	// pointer via json.Unmarshal. Use this when the variable was stored as a
	// JSON object, array, or number; for plain string variables call
	// GetVariable directly.
	//
	// pointer must be a non-nil pointer, as required by encoding/json.
	UnmarshalJSONVariable(ctx context.Context, key string, pointer any) error
}

type XComClient interface {
	// GetXCom returns the value stored under key by the task identified by
	// dagId/runId/taskId. For a mapped task instance pass its mapIndex,
	// otherwise pass nil. If no value exists the error wraps XComNotFound.
	//
	// value is reserved for future typed decoding and is currently ignored; the
	// stored value is returned as the first result instead.
	GetXCom(
		ctx context.Context,
		dagId, runId, taskId string,
		mapIndex *int,
		key string,
		value any,
	) (any, error)

	// PushXCom stores value under key for the given task instance ti.
	PushXCom(ctx context.Context, ti api.TaskInstance, key string, value any) error
}