ipdb

type AllCheckpoints struct {
	// All checkpoints.
	// Key is the database name, value is the checkpoint.
	Checkpoints map[string]Checkpoint `json:"checkpoints"`
}

type Checkpoint struct {
	// When the database was last updated from source.
	// Unix epoch second timestamp.
	LastUpdatedUnix int64 `json:"last_updated_unix"`
}

type DataSource struct {
	// Urls are the URLs where the IP data is located.
	// Either Get or Urls must be provided; Get takes precedence over Urls.
	// Any URLs that cannot be fetched will result in an error log and be skipped.
	Urls []*url.URL

	// Get is a function to get the IP data.
	// Either Get or Url must be provided; Get takes precedence over Url.1
	Get func() (io.ReadCloser, error)

	// RefreshInterval is the interval between updating the data from the source.
	RefreshInterval time.Duration
}

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

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

type NoSuchDatabaseError struct {
	// The name of database that did not exist.
	Name string
}

type NotInitializedError struct {
	// The type of database that was not initialized.
	Name string

	// The message.
	Msg string
}

type Options struct {
	// The storage driver used to store cached databases and checkpoint information.
	// Unless you have a custom driver you want to use, you should most likely use FsStorageDriver.
	// Required.
	StorageDriver StorageDriver

	// By default, Ipdb uses slog.Default.
	// If Logger is specified, it will use it instead.
	Logger *slog.Logger

	// Overrides the default HTTP client if not nil.
	// If nil, uses a default HTTP client with a 10-second timeout.
	HttpClient *http.Client

	// If true, disables downloading from sources and only uses cached database files.
	//
	// Important: You must still provide sources for the databases you want to use, regardless of whether download is disabled.
	DisableDownload bool

	// If true, the Ipdb instance will be created without waiting for databases to be loaded.
	// The databases will be loaded asynchronously in the background.
	// This can be useful if you're developing and don't want database loading to block startup.
	// It is NOT recommended for production.
	//
	// Important: Any methods on Ipdb that require databases to be initialized will fail until the databases have loaded.
	LoadDatabasesInBackground bool

	// A mapping of database names to their underlying IP range sources.
	// Each source's URL must point to a file containing a newline-separated list of IP addresses and/or CIDR ranges.
	// Empty lines are ignored.
	RangeSources map[string]*DataSource

	// The source for the IPv4 country database.
	// The URL must point to a MaxMindDB (.mmdb) file, containing at least the fields provided by MaxMind's GeoLite2 database.
	// See: https://dev.maxmind.com/geoip/geolite2-free-geolocation-data/
	//
	// Resolving IPv4 country codes will be disabled if this field is nil.
	GeoIpv4Source *DataSource

	// The source for the IPv6 country database.
	// The URL must point to a MaxMindDB (.mmdb) file, containing at least the fields provided by MaxMind's GeoLite2 database.
	// See: https://dev.maxmind.com/geoip/geolite2-free-geolocation-data/
	//
	// Resolving IPv6 country codes will be disabled if this field is nil.
	GeoIpv6Source *DataSource
}

type StorageDriver interface {
	// WriteDatabase opens the database file with the specified name for writing.
	// The reader will be closed by the function regardless of whether an error occurs.
	WriteDatabase(name string, input io.ReadCloser) error

	// ReadDatabase opens the database file with the specified name for reading.
	// The caller is expected to close the reader.
	// If there is no cached database with the specified name, the function will return syscall.ENOENT.
	ReadDatabase(name string) (io.ReadCloser, error)

	// WriteCheckpoints writes all checkpoints.
	// Checkpoints must not be nil.
	WriteCheckpoints(checkpoints *AllCheckpoints) error

	// ReadCheckpoints reads and returns all checkpoints.
	// The returned checkpoints will never be nil if there is no error.
	// If checkpoints have not been saved yet, the function will return syscall.ENOENT.
	ReadCheckpoints() (*AllCheckpoints, error)
}