configmanager

type Config struct {
	Key   string
	Value string
	// UpdatedBy is the user who updated the configuration. It will taken from header (X-User-Id) of the request. it will be empty if header is not present.
	UpdatedBy string
	UpdatedAt int64
	CreatedAt int64
}

type ConfigManager interface {
	// It will register the config in manager, it will save the config in repo if not already present with default values.
	RegisterConfig(ctx context.Context, cfg config) error
	// RegisterRoute will register the necesory endpoints for the configuration manager. using the provided RouteRegistrar.
	RegisterRoute(ctx context.Context, registerFunc RouteRegistrar) error
	// Get will return the configuration for the given key. It will return an error if the configuration is not found. It expects the pointer to the config object which implements config interface.
	Get(ctx context.Context, cfg config) error
}

type ConfigManagerConfig struct {
	ServiceName         string `name:"service_name" type:"string" description:"service name" required:"true"`
	CacheTimeoutMinutes int    `name:"cache_timeout_minutes" type:"number" description:"cache timeout in minutes for config manager" required:"true"`
}

type ConfigObject struct {
	Name        string         `json:"name"`
	Type        ConfigType     `json:"type"`
	Description string         `json:"description"`
	Required    bool           `json:"required"`
	Choices     []string       `json:"choices,omitempty"`
	Value       any            `json:"value"`
	Childrens   []ConfigObject `json:"children"`
}

type ConfigTag string

type ConfigType string

type Repository interface {
	// GetConfig will return the value of the configuration for the given key. It will return nil if the configuration is not found.
	// it will return an error if there is an issue with the repository.
	GetConfig(ctx context.Context, key string) (*Config, error)
	// SaveConfig will save the configuration with the given key and value. It will return an error if there is an issue with the repository.
	SaveConfig(ctx context.Context, cfg *Config) error
}

type RouteRegistrar func(method, path string, handler http.HandlerFunc) error