provider

type ChangeList interface {
	// Iterate wil return an iterator that returns records that
	// match the given state. For example, when called like
	// `Iterate(Delete)` will only return records marked for
	// removal. The ChangeState can be combined to iterate
	// multiple states like `Iterate(Delete|Create)` which
	// will return all records that are marked delete or
	// as created.
	Iterate(state ChangeState) iter.Seq[*libdns.RR]
	// Creates will return a slice of records that are
	// marked for creating
	Creates() []*libdns.RR
	// Deletes will return a slice of records that are
	// marked for deleting
	Deletes() []*libdns.RR
	// GetList will return a slice of records that
	// represents the new dns list which can be used
	// to update the whole set for a zone
	GetList() []*libdns.RR
	// Has wil check if this list has records for
	// given state
	Has(state ChangeState) bool
	// contains filtered or unexported methods
}

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

type ChangeState uint8

type Client interface {
	// GetDNSList returns all DNS records available for the given zone.
	//
	// The returned records can be of the opaque RR type. If the provider supports
	// parsing, the records will be automatically parsed before being returned.
	GetDNSList(ctx context.Context, domain string) ([]libdns.Record, error)

	// SetDNSList processes a ChangeList and updates DNS records based on their state.
	//
	// This allows the client to focus only on handling the changes, while the provider
	// logic for appending, setting, and deleting records is centralized.
	//
	// Example: iterating through individual changes
	//
	//    // Remove records marked for deletion
	//    for remove := range change.Iterate(Delete) {
	//        // remove record
	//    }
	//
	//    // Create records marked for creation
	//    for create := range change.Iterate(Create) {
	//        // create record
	//    }
	//
	// Example: updating the whole zone at once
	//
	//    // Generate a filtered list of all changes
	//    updatedRecords := change.GetList()
	//
	//    // Use this list to update the entire zone file in a single call
	//    client.UpdateZone(ctx, domain, updatedRecords)
	//
	// Notes:
	//  - If the client API supports full-zone updates and returns the new record set,
	//    this can be returned. The provider uses this to validate records and skip
	//    extra API calls.
	//  - For clients that do not support full-zone updates or handle records individually,
	//    returning nil is fine.
	SetDNSList(ctx context.Context, domain string, change ChangeList) ([]libdns.Record, error)
}

type DebugAware interface {
	SetDebug(level OutputLevel, writer io.Writer)
}

type DebugConfig interface {
	DebugOutputLevel() OutputLevel
	DebugOutput() io.Writer
}

type DebugTransport struct {
	http.RoundTripper
	Config DebugConfig
}

type Domain interface {
	Name() string
}

type OutputLevel uint8

type ZoneAwareClient interface {
	Client
	Domains(ctx context.Context) ([]Domain, error)
}