config

type AdminSettings struct {
	// Username is the username for the admin user.
	Username string
	// Password is the password for the admin user.
	Password string
	// Email is the email address for the admin user.
	// This is used in jwt claims.
	Email string
}

type AuthSettings struct {
	// JWTSettings holds the configuration settings for JSON Web Tokens (JWT).
	JWTSettings JWTSettings
	// AdminSettings holds the configuration settings for admin authentication.
	AdminSettings AdminSettings
	// OAuthSettings holds the configuration settings for OAuth2 authentication.
	OAuthSettings *OAuthSettings
}

type DatabaseSettings struct {
	Type           DatabaseType
	Endpoints      []string
	ConnectTimeout time.Duration
	DatabaseName   string

	DDLAuto bool
}

type DatabaseType string

type EventProtocolType string

type EventSettings struct {
	// ProtocolType is the event protocol type.
	ProtocolType EventProtocolType

	// KafkaSettings represents the Kafka configuration.
	KafkaSettings KafkaSettings
}

type JWTSettings struct {
	SigningKey string
	Issuer     string
	Expiration time.Duration
	Audience   []string
}

type KafkaSettings struct {
	// Brokers is the list of Kafka broker addresses.
	Brokers []string
	// Topic is the Kafka topic name for events.
	Topic string
}

type LogFormat string

type LogSettings struct {
	// Enabled indicates whether logging is enabled.
	Enabled bool
	// Level specifies the log level.
	Level slog.Level
	// Format specifies the log format (e.g., text or json).
	Format LogFormat
}

type ManagementSettings struct {
	// Address is the address to bind the management server to.
	// e.g. ":9090" or "localhost:9090"
	Address string

	// ObservabilitySettings holds the settings for observability features.
	ObservabilitySettings ObservabilitySettings
}

type MetricSettings struct {
	// Enabled indicates whether metrics collection is enabled.
	Enabled bool

	// Type specifies the type of metrics to be used.
	Type MetricType

	// MetricsSettingsForPrometheus holds the settings specific to Prometheus metrics.
	MetricSettingsForPrometheus MetricSettingsForPrometheus

	// MetricsSettingsForOpenTelemetry holds the settings specific to OpenTelemetry metrics.
	MetricSettingsForOpenTelemetry MetricsSettingsForOpenTelemetry
}

type MetricSettingsForPrometheus struct {
	// Path specifies the path for metrics exposure.
	// This is the endpoint to expose metrics.
	// It should start with a '/' character.
	Path string
}

type MetricType string

type MetricsSettingsForOpenTelemetry struct {
	// Endpoint specifies the endpoint for metrics collection.
	// This is the endpoint to send metrics to.
	// It should be a valid URL or URI.
	Endpoint string
}

type OAuthSettings struct {
	// ClientID is the OAuth2 client ID for GitHub authentication.
	ClientID string
	// Secret is the OAuth2 client secret for GitHub authentication.
	Secret string
	// CallbackURL is the URL to which GitHub will redirect after authentication.
	CallbackURL string
	// JWTSettings holds the JWT configuration settings.
	// This is used for the state parameter in OAuth2 authentication.
	JWTSettings JWTSettings
}

type ObservabilitySettings struct {
	// ServiceName is the name of the service for which observability is configured.
	// It used for naming traces, metrics, and logs.
	ServiceName string

	Metric MetricSettings
	Log    LogSettings
	Trace  TraceSettings
}

type ServerID string

type ServerSettings struct {
	Address            string
	ServerID           ServerID
	DatabaseSettings   DatabaseSettings
	AuthSettings       AuthSettings
	ManagementSettings ManagementSettings
	EventSettings      EventSettings
}

type TraceCompressionAlgorithm string

type TraceProtocol string

type TraceSampler string

type TraceSettings struct {
	// Enabled indicates whether tracing is enabled.
	Enabled bool
	// Protocol specifies the protocol for tracing.
	Protocol TraceProtocol
	// Compression specifies the compression type for tracing.
	Compression bool
	// CompressionAlgorithm specifies the compression algorithm for tracing.
	CompressionAlgorithm TraceCompressionAlgorithm
	// Insecure indicates whether to use insecure connection for tracing.
	Insecure bool
	// Headers specifies the headers to be sent with tracing requests.
	Headers map[string]string
	// Endpoint specifies the endpoint for tracing.
	Endpoint string
	// Sampler specifies the sampling strategy for tracing.
	// Possible values are defined in the TraceSampler type (e.g., always, never, probability).
	Sampler TraceSampler
	// SamplerRatio is used when the Sampler is set to TraceSamplerProbability.
	// It should be a value between 0.0 and 1.0.
	SamplerRatio float64
}