config

type Adapters struct {
	// Hook provides the configuration for the Hook adapter.
	Hook HookConfig `toml:"hook"`

	// Test is for testing purposes only. Do not use.
	Test struct{}
}

type Config struct {
	// APIPort provides the port on which the core API is served.
	APIPort uint16 `toml:"api_port" validate:"nonempty"`

	// DataPath provides the path to the folder with raw EXD files (in CSV format)
	// containing game data.
	DataPath string `toml:"data_path" validate:"directory"`

	// AdminOTP provides a one time password that the admin can use to create an
	// admin token for the API.
	AdminOTP string `toml:"admin_otp" validate:"nonempty"`

	// DisableAuth allows starting the API server without requiring an auth
	// token for queries. CORS validation will still be enforced.
	DisableAuth bool `toml:"disable_auth"`

	// AllowOrigins allows the listed sites to bypass CORS validation without
	// having to register them. Note that scheme and subdomain must be provided.
	// Example: allow_sites = ["https://plugins.foo.com"]
	AllowOrigins []string `toml:"allow_origins"`

	// Maps provides the configuration for the Map endpoint of the API.
	Maps MapConfig `toml:"maps"`

	// Adapters contains the configuration for all the adapters enabled for
	// the core API.
	Adapters Adapters `toml:"adapters"`
}

type Duration time.Duration

type HookConfig struct {
	// Enabled toggles whether or not the Hook adapter is enabled.
	Enabled bool `toml:"enabled"`

	// DLLPath sets the path of the Hook DLL on the system.
	DLLPath string `toml:"dll_path" validate:"file"`

	// FFXIVProcess is the name of the exe file for the game.
	FFXIVProcess string `toml:"ffxiv_process" validate:"nonempty"`

	// DialRetryInterval controls how long to wait before retrying
	// failures to make a connection with the hook DLL.
	// Defaults to 500 milliseconds.
	DialRetryInterval Duration `toml:"dial_retry_interval"`

	// PingInterval controls the interval between liveness checks to
	// hook. Defaults to 1 second.
	PingInterval Duration `toml:"ping_interval"`
}

type MapConfig struct {
	// Cache provides the path of the maps on the local disk.
	Cache string `toml:"cache" validate:"directory"`

	// APIPath provides the URL of an xivapi environment serving the maps if the
	// map could not be found on the local disk. Defaults to https://xivapi.com.
	APIPath string `toml:"api_path"`
}

type SourceDirs struct {
	MapsDir string `toml:"maps_dir" validate:"directory"`
}