rpc

type ClickyLookupMeta struct {
	// Ref points at the reusable filter definition in
	// components.x-clicky-filters (e.g. "#/components/x-clicky-filters/users").
	Ref string `json:"$ref,omitempty"`
	// URL is the lookup endpoint (the owning entity's list path).
	URL string `json:"url,omitempty"`
	// Filter is the bound flag key, sent as __lookup_filter for server-side search.
	Filter string `json:"filter,omitempty"`
	// SearchParam is the query-string key for the search term (__lookup_q).
	SearchParam string `json:"searchParam,omitempty"`
	// Multi reports whether the control accepts multiple selections.
	Multi bool `json:"multi,omitempty"`
}

type ClickyOperationMeta = entity.ClickyOperationMeta

type ClickyParameterMeta struct {
	// Role tells the UI how to render this parameter. Empty means "no
	// special handling". Recognised values:
	//   - "filter"     — show as a filter pill in the DataTable's FilterBar
	//                    (entity .Filters(...) keys or any list-op query param
	//                    when the op declares SupportsLookup).
	//   - "limit"      — drives DataTable pagination's pageSize.
	//   - "offset"     — drives DataTable pagination's page.
	//   - "time-from"  — left edge of a time-range picker.
	//   - "time-to"    — right edge of a time-range picker.
	Role string `json:"role,omitempty"`
}

type ClickySpecMeta = entity.ClickySpecMeta

type ClickySurface = entity.ClickySurface

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

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

type Config = entity.Config

type ContextDataFunc = entity.ContextDataFunc

type ContextLookupFunc = entity.ContextLookupFunc

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

type DataFunc = entity.DataFunc

type EntityActionDTO struct {
	Name  string `json:"name"`
	Short string `json:"short,omitempty"`
}

type EntityDTO struct {
	Name        string               `json:"name"`
	Aliases     []string             `json:"aliases,omitempty"`
	Parent      string               `json:"parent,omitempty"`
	IsAdmin     bool                 `json:"is_admin,omitempty"`
	Operations  []EntityOperationDTO `json:"operations,omitempty"`
	Actions     []EntityActionDTO    `json:"actions,omitempty"`
	BulkActions []EntityActionDTO    `json:"bulk_actions,omitempty"`
}

type EntityOperationDTO struct {
	Verb string `json:"verb"`
}

type ExecutionRequest struct {
	Args  []string          `json:"args,omitempty"`  // Positional arguments
	Flags map[string]string `json:"flags,omitempty"` // Flag values

	// Context carries the request's context.Context to a ContextDataFunc. On the
	// HTTP path it is r.Context(); on the CLI path it is cmd.Context(). It is
	// never serialized — it is transport state, not part of the wire contract.
	Context context.Context `json:"-"`
}

type ExecutionResponse struct {
	Success  bool              `json:"success"`
	Message  string            `json:"message,omitempty"`
	Output   string            `json:"output,omitempty"` // Combined stdout+stderr for backward compatibility
	Stdout   string            `json:"stdout,omitempty"` // Standard output only
	Stderr   string            `json:"stderr,omitempty"` // Standard error only
	ExitCode int               `json:"exit_code"`        // Command exit code (0 = success)
	Error    string            `json:"error,omitempty"`  // Error description
	Input    *ExecutionRequest `json:"input,omitempty"`  // Processed input parameters (included on errors for debugging)
	CLI      string            `json:"cli,omitempty"`    // Equivalent CLI command to reproduce this execution

	// DataIsStructured is true when the operation returned data via a DataFunc
	// (entity list/get) rather than captured stdout. The HTTP layer uses it to
	// serialize the data payload directly for structured wire formats instead of
	// substituting this (output-less) envelope. Not serialized — it's transport
	// metadata, not part of the response contract.
	DataIsStructured bool `json:"-"`
}

type ExecutorConfig struct {
	Enabled    bool   // Enable dynamic command execution
	SkipPreRun bool   // Skip pre-run hooks during execution
	PathPrefix string // Path prefix for execution endpoints (defaults to /api/v1)
}

type HealthResponse struct {
	Status    string `json:"status"`
	Timestamp string `json:"timestamp"`
	Server    string `json:"server"`
	Version   string `json:"version"`
}

type OpenAPIComponents struct {
	Schemas         map[string]*OpenAPISchema        `json:"schemas,omitempty"`
	Responses       map[string]OpenAPIResponse       `json:"responses,omitempty"`
	Parameters      map[string]OpenAPIParameter      `json:"parameters,omitempty"`
	RequestBodies   map[string]OpenAPIRequestBody    `json:"requestBodies,omitempty"`
	Headers         map[string]OpenAPIHeader         `json:"headers,omitempty"`
	SecuritySchemes map[string]OpenAPISecurityScheme `json:"securitySchemes,omitempty"`
	// ClickyFilters holds the reusable named-filter definitions referenced by
	// filter parameters' x-clicky-lookup.$ref, emitted under x-clicky-filters.
	ClickyFilters map[string]entity.FilterSpec `json:"x-clicky-filters,omitempty"`
}

type OpenAPIConfig struct {
	Title       string
	Description string
	Version     string
	Servers     []OpenAPIServer
	Contact     *OpenAPIContact
	License     *OpenAPILicense
	Tags        []OpenAPITag
}

type OpenAPIContact struct {
	Name  string `json:"name,omitempty"`
	URL   string `json:"url,omitempty"`
	Email string `json:"email,omitempty"`
}

type OpenAPIExample struct {
	Summary     string      `json:"summary,omitempty"`
	Description string      `json:"description,omitempty"`
	Value       interface{} `json:"value,omitempty"`
}

type OpenAPIExternalDocs struct {
	Description string `json:"description,omitempty"`
	URL         string `json:"url"`
}

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

type OpenAPIHeader struct {
	Description string         `json:"description,omitempty"`
	Required    bool           `json:"required,omitempty"`
	Schema      *OpenAPISchema `json:"schema,omitempty"`
}

type OpenAPIInfo struct {
	Title       string          `json:"title"`
	Description string          `json:"description,omitempty"`
	Version     string          `json:"version"`
	Contact     *OpenAPIContact `json:"contact,omitempty"`
	License     *OpenAPILicense `json:"license,omitempty"`
}

type OpenAPILicense struct {
	Name string `json:"name"`
	URL  string `json:"url,omitempty"`
}

type OpenAPIMediaType struct {
	Schema   *OpenAPISchema            `json:"schema,omitempty"`
	Example  interface{}               `json:"example,omitempty"`
	Examples map[string]OpenAPIExample `json:"examples,omitempty"`
}

type OpenAPIOAuthFlow struct {
	AuthorizationURL string            `json:"authorizationUrl,omitempty"`
	TokenURL         string            `json:"tokenUrl,omitempty"`
	RefreshURL       string            `json:"refreshUrl,omitempty"`
	Scopes           map[string]string `json:"scopes"`
}

type OpenAPIOAuthFlows struct {
	Implicit          *OpenAPIOAuthFlow `json:"implicit,omitempty"`
	Password          *OpenAPIOAuthFlow `json:"password,omitempty"`
	ClientCredentials *OpenAPIOAuthFlow `json:"clientCredentials,omitempty"`
	AuthorizationCode *OpenAPIOAuthFlow `json:"authorizationCode,omitempty"`
}

type OpenAPIOperation struct {
	Tags        []string                   `json:"tags,omitempty"`
	Summary     string                     `json:"summary,omitempty"`
	Description string                     `json:"description,omitempty"`
	OperationID string                     `json:"operationId,omitempty"`
	Parameters  []OpenAPIParameter         `json:"parameters,omitempty"`
	RequestBody *OpenAPIRequestBody        `json:"requestBody,omitempty"`
	Responses   map[string]OpenAPIResponse `json:"responses"`
	Security    []map[string][]string      `json:"security,omitempty"`
	Clicky      *ClickyOperationMeta       `json:"x-clicky,omitempty"`
}

type OpenAPIParameter struct {
	Name        string               `json:"name"`
	In          string               `json:"in"`
	Description string               `json:"description,omitempty"`
	Required    bool                 `json:"required,omitempty"`
	Schema      *OpenAPISchema       `json:"schema,omitempty"`
	Example     interface{}          `json:"example,omitempty"`
	Clicky      *ClickyParameterMeta `json:"x-clicky,omitempty"`
	Lookup      *ClickyLookupMeta    `json:"x-clicky-lookup,omitempty"`
}

type OpenAPIPath map[string]OpenAPIOperation

type OpenAPIRequestBody struct {
	Description string                      `json:"description,omitempty"`
	Content     map[string]OpenAPIMediaType `json:"content"`
	Required    bool                        `json:"required,omitempty"`
}

type OpenAPIResponse struct {
	Description string                      `json:"description"`
	Headers     map[string]OpenAPIHeader    `json:"headers,omitempty"`
	Content     map[string]OpenAPIMediaType `json:"content,omitempty"`
}

type OpenAPISchema struct {
	Ref                  string                    `json:"$ref,omitempty"`
	Type                 string                    `json:"type,omitempty"`
	Title                string                    `json:"title,omitempty"`
	Format               string                    `json:"format,omitempty"`
	Description          string                    `json:"description,omitempty"`
	Enum                 []interface{}             `json:"enum,omitempty"`
	Default              interface{}               `json:"default,omitempty"`
	Properties           map[string]*OpenAPISchema `json:"properties,omitempty"`
	Required             []string                  `json:"required,omitempty"`
	Items                *OpenAPISchema            `json:"items,omitempty"`
	AdditionalProperties *OpenAPISchema            `json:"additionalProperties,omitempty"`
	Nullable             bool                      `json:"nullable,omitempty"`
	Example              interface{}               `json:"example,omitempty"`
	// Extensions carries vendor keys (e.g. x-clicky-component, x-clicky-workload,
	// x-clicky-default-source, x-clicky-property) that are merged into the object
	// at marshal time. They never appear as their own JSON field.
	Extensions map[string]any `json:"-"`
}

type OpenAPISecurityScheme struct {
	Type         string             `json:"type"`
	Description  string             `json:"description,omitempty"`
	Name         string             `json:"name,omitempty"`
	In           string             `json:"in,omitempty"`
	Scheme       string             `json:"scheme,omitempty"`
	BearerFormat string             `json:"bearerFormat,omitempty"`
	Flows        *OpenAPIOAuthFlows `json:"flows,omitempty"`
}

type OpenAPIServer struct {
	URL         string                     `json:"url"`
	Description string                     `json:"description,omitempty"`
	Variables   map[string]OpenAPIVariable `json:"variables,omitempty"`
}

type OpenAPISpec struct {
	OpenAPI    string                 `json:"openapi"`
	Info       OpenAPIInfo            `json:"info"`
	Servers    []OpenAPIServer        `json:"servers,omitempty"`
	Paths      map[string]OpenAPIPath `json:"paths"`
	Components *OpenAPIComponents     `json:"components,omitempty"`
	Tags       []OpenAPITag           `json:"tags,omitempty"`
	Clicky     *ClickySpecMeta        `json:"x-clicky,omitempty"`
}

type OpenAPITag struct {
	Name         string               `json:"name"`
	Description  string               `json:"description,omitempty"`
	ExternalDocs *OpenAPIExternalDocs `json:"externalDocs,omitempty"`
}

type OpenAPIValidator struct{}

type OpenAPIVariable struct {
	Enum        []string `json:"enum,omitempty"`
	Default     string   `json:"default"`
	Description string   `json:"description,omitempty"`
}

type Property = entity.Property

type RPCOperation = entity.RPCOperation

type RPCParameter = entity.RPCParameter

type RPCService = entity.RPCService

type Schema = entity.Schema

type SchemaDescriber interface {
	JSONSchema() map[string]any
}

type ServeConfig struct {
	Host        string
	Port        int
	Title       string
	Description string
	Version     string
	AutoRefresh bool
	Open        bool
	SkipHealth  bool            // Skip registering /health (caller provides their own)
	Executor    *ExecutorConfig // Optional command execution configuration
}

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

type TemplateData struct {
	Title       string
	Description string
	Version     string
	Timestamp   string
	AutoRefresh bool
}

type ValidationError struct {
	Field   string
	Message string
}

type ValidationResult struct {
	Valid  bool
	Errors []ValidationError
}