openshell

type Config struct {
	// Address is the gateway gRPC address, e.g. "openshell.openshell.svc:8080".
	Address string
	// Workspace is the gateway workspace sandboxes are created in.
	Workspace string
	// SandboxNamespace is the namespace the gateway creates sandbox pods in. The
	// router NetworkPolicy admits the run's supervisor pod from this namespace.
	SandboxNamespace string
	// CertFile, KeyFile and CAFile configure mTLS to the gateway.
	CertFile string
	KeyFile  string
	CAFile   string
	// TokenFile optionally holds a bearer token (OIDC gateways).
	TokenFile string
	// Insecure disables TLS verification. Development only.
	Insecure bool
}

type CredentialKey struct {
	// EnvVar is the workload env var holding the placeholder.
	EnvVar string
	// Header is the HTTP header the value goes in, and Prefix what precedes it.
	Header string
	Prefix string
	// SecretName and SecretKey locate the value in the tool's namespace.
	SecretName string
	SecretKey  string
}

type Decision struct {
	Time time.Time `json:"time"`
	// Kind is "net" (a connection) or "http" (a request on an allowed connection).
	Kind string `json:"kind"`
	// Activity is the OCSF activity, e.g. OPEN for a connection.
	Activity string `json:"activity,omitempty"`
	// Action is "allowed" or "denied" (lower-cased OCSF action).
	Action   string `json:"action"`
	Severity string `json:"severity,omitempty"`
	// Binary is the process that connected (without its pid).
	Binary string `json:"binary,omitempty"`
	// Destination is host:port for connections.
	Destination string `json:"destination,omitempty"`
	Method      string `json:"method,omitempty"`
	URL         string `json:"url,omitempty"`
	// Policy and Engine name the rule that decided.
	Policy string `json:"policy,omitempty"`
	Engine string `json:"engine,omitempty"`
	Reason string `json:"reason,omitempty"`
	// Raw is the original shorthand line.
	Raw string `json:"raw"`
}

type ExecOptions = osv1.ExecOptions

type ExecResult = osv1.ExecResult

type Executor interface {
	Exec(ctx context.Context, sandbox string, command []string, opts ExecOptions) (*ExecResult, error)
}

type Gateway interface {
	// Create creates a sandbox. It returns the existing sandbox when one with the
	// same name already exists, so a reconcile retry is idempotent.
	Create(ctx context.Context, name string, spec *osv1.SandboxSpec, labels map[string]string) (*osv1.Sandbox, error)
	// Get returns the sandbox, or an error satisfying osv1.IsNotFound.
	Get(ctx context.Context, name string) (*osv1.Sandbox, error)
	// Delete deletes the sandbox. A missing sandbox is not an error.
	Delete(ctx context.Context, name string) error
	// MainProcessLogs returns the tail of the workload's main-process output.
	MainProcessLogs(ctx context.Context, sb *osv1.Sandbox) (string, error)
	// SandboxNamespace is the Kubernetes namespace the gateway creates sandbox pods in.
	SandboxNamespace() string
	// EnsureProfile creates the provider profile, or updates it when its
	// declared credentials changed.
	EnsureProfile(ctx context.Context, profile *osv1.ProviderProfile) error
	// EnsureProvider creates the provider, or updates its credentials.
	EnsureProvider(ctx context.Context, provider *osv1.Provider) error
	// DeleteProviders deletes every provider carrying all of labels.
	DeleteProviders(ctx context.Context, labels map[string]string) error
	// PendingDrafts returns the sandbox's pending policy proposals: rules the
	// gateway drafted from connections its policy denied.
	PendingDrafts(ctx context.Context, sandbox string) ([]osv1.PolicyChunk, error)
	// ApproveDraft adds a proposal to the sandbox's live policy.
	ApproveDraft(ctx context.Context, sandbox, chunkID, reviewToken string) error
	// RejectDraft declines a proposal.
	RejectDraft(ctx context.Context, sandbox, chunkID, reason string) error
	// Decisions returns the network decisions the sandbox's supervisor logged
	// after since, oldest first.
	Decisions(ctx context.Context, sandbox string, since time.Time) ([]Decision, error)
	// Exec runs a command in the sandbox and returns once it exits. Long-running
	// work should be started with StartJob rather than held on an Exec call.
	Exec(ctx context.Context, sandbox string, command []string, opts ExecOptions) (*ExecResult, error)
}

type GitAccess struct {
	// Repositories are "owner/name" slugs.
	Repositories []string
	// Push allows git push (git-receive-pack) as well as clone and fetch.
	Push bool
	// Provider is the run's provider holding the token.
	Provider string
}

type JobPhase string

type JobStatus struct {
	Phase    JobPhase
	ExitCode int
	// Output is the tail of what the job printed, stdout and stderr together.
	Output string
}

type Outcome int

type Placement struct {
	NodeSelector      map[string]string   `json:"nodeSelector,omitempty"`
	Tolerations       []corev1.Toleration `json:"tolerations,omitempty"`
	RuntimeClassName  string              `json:"runtimeClassName,omitempty"`
	PriorityClassName string              `json:"priorityClassName,omitempty"`
}

type PodLogFunc func(ctx context.Context, namespace, pod, container string) (string, error)

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

type SpecInput struct {
	Agent *agentorcav1alpha1.Agent
	// RouterHost is the router Service hostname the workload's base URL names.
	RouterHost string
	// ExtraRouterHosts are further router Service hostnames the sandbox may
	// reach: a workflow's shared sandbox serves one router per agent step. Each
	// must be a literal name, since OpenShell resolves policy hosts ahead of time
	// and refuses names it has no mapping for.
	ExtraRouterHosts []string
	// Env is the agent process environment, including the router base URL and
	// the per-run router credential.
	Env map[string]string
	// Tools are the tool endpoints the agent may reach directly, already
	// filtered by spec.runtime.sandbox.tools and bound to credential providers.
	Tools []ToolEndpoint
	// Providers are the provider instances to attach to the sandbox.
	Providers []string
	// Placement chooses the sandbox pod's nodes (operator-wide).
	Placement Placement
	// Git, when set, grants git access to GitHub through a credential-bound
	// endpoint (see ApplyGitAccess).
	Git *GitAccess
}

type ToolCredential struct {
	// Source owns the credential: the MCPServer the tool was generated from, or
	// the tool itself. Tools from one MCPServer share one credential.
	Source string
	// Tool is the first tool (in spec.tools order) that declared the credential.
	Tool string
	// URL is the MCP server URL, and Host/Port its endpoint the credential binds to.
	URL  string
	Host string
	Port uint32
	Keys []CredentialKey
}

type ToolEndpoint struct {
	Tool string
	Host string
	Port uint32
	// CredentialProvider, when set, binds the named provider's static
	// credentials to this endpoint (see BindCredentials).
	CredentialProvider string
}