enbypub

type Aggregator interface {
	Init(*Feed, *Generator) error
	AddText(*Text) error
	Close() error
}

type Aggregators []Aggregator

type AtomAggregator struct {
	MinPath *uint `yaml:",omitempty"`
	MaxPath *uint `yaml:",omitempty"`
}

type Attribute string

type ContentTypesExtraT struct {
	FromExtension map[string]string
}

type Feed struct {
	// Tags specifies the list of tags that will be scanned to add content to this Feed
	Tags []string `yaml:",omitempty"`

	// CanonicalPath specifies the location where a Text will be publicly reachable relative to a public root
	// If empty/nil, this feed does not produce output files
	CanonicalPath []PathComponent `yaml:",omitempty"`

	// MaximumCount, if specified, limits the feed to the MaximumCount most recent Texts according to their Created time
	// (not yet implemented)
	MaximumCount *uint `yaml:",omitempty"`

	// MaximumAge, if specified, limits the feed to the Texts with a Created time no older than MaximumAge
	// (not yet implemented)
	MaximumAge *time.Duration `yaml:",omitempty"`

	// Id is a randomly generated UUID for this Feed
	Id *uuid.UUID `yaml:",omitempty"`

	// Slug is a URL-friendly reference to this Feed
	Slug *string `yaml:",omitempty"`

	// Aggregators is a list of zero or more aggregation methods, like the Feed Index or RSS
	// (not yet implemented)
	Aggregators Aggregators `yaml:",omitempty"`

	// Index contains a list of every Text that is published to this Feed
	// Note that this list is not neccessarily orderd in any particular way; the Index must be sorted if that's desired
	Index []*Text `yaml:"-"`

	// DefaultTemplate set a default "Style" value for a Text if one is not set
	DefaultTemplate *string `yaml:",omitempty"`
	// contains filtered or unexported fields
}

type FeedStructure struct {
	// Segments is a map of each distinct path segment and the Texts under that segment
	Segments map[string][]*Text

	// Files is the generated final content path for each Text
	Files map[string]*Text
}

type Feeds map[uuid.UUID]*Feed

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

type Generator struct {
	Root      string
	Files     map[string]*File
	Templates *html.Template
}

type IndexAggregator struct {

	// Kind is always "index"
	Kind     string
	MinPath  *int    `yaml:",omitempty"`
	MaxPath  *int    `yaml:",omitempty"`
	Paginate *int    `yaml:",omitempty"` // TODO
	Filename *string `yaml:",omitempty"`
	Template *string `yaml:",omitempty"`
	Sort     *string `yaml:",omitempty"`
	// contains filtered or unexported fields
}

type IndexAggregatorContent struct {
	Meta  *MetaT
	Feed  *Feed
	Index []*Text
}

type MetaT struct {
	// Ver is the version of the enbypub package if available, or the main package
	Ver *string

	// Commit is either the abbreviated git sha-1 commit id, or the whole revision if it doesn't look like a git commit
	Commit *string

	// BuildTime is the reported build time of the main package
	BuildTime *time.Time

	// Package is the enbypub library package path
	Package string

	// MainPackage is the main package path (ie the repo importing this package)
	MainPackage string
}

type PathComponent struct {
	String *string    `yaml:",omitempty"`
	Attr   *Attribute `yaml:",omitempty"`
}

type RSSAggregator struct {

	// Kind is always "rss"
	Kind     string
	MinPath  *int    `yaml:",omitempty"`
	MaxPath  *int    `yaml:",omitempty"`
	Filename *string `yaml:",omitempty"`

	// Title, if provided, is used as the RSS feed title value. Otherwise a default is made from the Feed slug.
	Title *string `yaml:",omitempty"`

	// Description, if provided, is used as the RSS description. Otherwise a default is made from the Feed slug.
	Description *string `yaml:",omitempty"`

	// PublicBaseURL is used to calculate the public URLs in this feed.
	PublicBaseURL string

	// TTL is the minimum recommended refresh speed for consumers.
	TTL *time.Duration `yaml:",omitempty"`
	// contains filtered or unexported fields
}

type RSSAggregatorContent struct {
	Meta  *MetaT
	Feed  *Feed
	Index []*Text
}

type RSSDate time.Time

type RSSFeedDocument struct {
	XMLName xml.Name `xml:"rss"`
	NS      string   `xml:"xmlns:atom,attr"` // always "http://www.w3.org/2005/Atom"
	Version string   `xml:"version,attr"`    // always "2.0"

	LastBuildDate RSSDate `xml:"channel>lastBuildDate"`

	Title       string        `xml:"channel>title,omitempty"`
	Link        string        `xml:"channel>link,omitempty"`
	Description string        `xml:"channel>description,omitempty"`
	Language    *language.Tag `xml:"channel>language,omitempty"`
	PubDate     *RSSDate      `xml:"channel>pubDate,omitempty"`
	Docs        string        `xml:"channel>docs,omitempty"` // always "https://www.rssboard.org/rss-specification"
	TTL         int           `xml:"channel>ttl,omitempty"`  // minutes

	// advises clients when not to re-fetch
	SkipHours *[]int    `xml:"channel>skipHours>hour,omitempty"` // hour of day in GMT
	SkipDays  *[]string `xml:"channel>skipDays>day,omitempty"`   // day of week

	Items []*RSSFeedItem `xml:"channel>item,omitempty"`
	// contains filtered or unexported fields
}

type RSSFeedItem struct {
	Title       string     `xml:"title"`
	Link        string     `xml:"link"`
	Description string     `xml:"description,omitempty"`
	Author      string     `xml:"author,omitempty"`
	PubDate     *RSSDate   `xml:"pubDate,omitempty"`
	Id          *uuid.UUID `xml:"guid,omitempty"`
}

type RSSGUID struct {
	*uuid.UUID `xml:"guid"`
	PermaLink  bool `xml:"isPermaLink,attr"`
}

type RobotsExcludeAggregator struct {
	MinPath *uint `yaml:",omitempty"`
}

type SearchAggregator struct {
	IndexJSONPath     *string `yaml:",omitempty"`
	IndexHTMLPath     *string `yaml:",omitempty"`
	IndexHTMLTemplate *string `yaml:",omitempty"`
}

type SitemapAggregator struct {
}

type Text struct {

	// Title specifies the title of the Text
	Title *string `yaml:",omitempty"`

	// Slug is a generated URL-friendly string usually derived from the Title
	Slug *string `yaml:",omitempty"`

	// Created indicates the time this Text was first processed by enbypub
	Created *time.Time `yaml:",omitempty"`

	// Modified indicates the time this Text was most recently processed by enbypub
	Modified *time.Time `yaml:",omitempty"`

	// Id is the unique identifier assigned to this Text on first processing
	Id *uuid.UUID `yaml:",omitempty"`

	// Template specifies what template to use for rendering this Text
	Template *string `yaml:",omitempty"`

	// Tags specifies the distrubition of this Text
	Tags []string `yaml:",omitempty"`

	// Checksum determines whether the body of the Text has been changed since last processed
	Checksum *string `yaml:",omitempty"`
	// contains filtered or unexported fields
}

type Texts map[uuid.UUID]*Text