epub

type Book struct {
	Metadata Metadata      `json:"metadata"` // bibliographic metadata written to the OPF <metadata> element
	Items    []ContentItem `json:"items"`    // content files added to the manifest and stored in the ZIP
	Spine    []string      `json:"spine"`    // IDs of Items in reading order
}

type Container struct {
	// RootfilePath is the path within the ZIP to the root OPF document,
	// e.g. "OEBPS/content.opf".
	RootfilePath string `json:"rootfile_path"`
}

type ContentItem struct {
	ID         string `json:"id"`                   // manifest item id attribute; must be unique within the Book
	Href       string `json:"href"`                 // path relative to the OPF document, e.g. "chapter1.xhtml"
	MediaType  string `json:"media_type"`           // MIME type, e.g. "application/xhtml+xml"
	Properties string `json:"properties,omitempty"` // space-separated EPUB 3 properties, e.g. "nav"
	Content    []byte `json:"content"`              // raw file bytes written into the ZIP
}

type FileNotFoundError struct {
	Path string
}

type Item struct {
	ID        string `json:"id"`         // manifest item id attribute
	Href      string `json:"href"`       // relative to the OPF document's directory
	MediaType string `json:"media_type"` // e.g. "application/xhtml+xml", "image/jpeg"
	// Properties contains space-separated property values (EPUB 3 only, e.g. "nav", "cover-image").
	// Empty for EPUB 2 items.
	Properties string `json:"properties,omitempty"`
}

type ItemNotFoundError struct {
	ID   string // manifest item id attribute
	Href string // ZIP-relative path that was expected
}

type MalformedContainerError struct{}

type Metadata struct {
	Title           string   `json:"title"`                      // dc:title
	Authors         []string `json:"authors,omitempty"`          // dc:creator values, in document order
	Language        string   `json:"language"`                   // dc:language (BCP 47 tag, e.g. "en")
	Identifier      string   `json:"identifier"`                 // dc:identifier matching unique-identifier, or first dc:identifier
	PublicationDate string   `json:"publication_date,omitempty"` // "YYYY-MM-DD" or "YYYY" as written in the file; empty if absent
}

type MissingMetadataError struct {
	Field string
}

type MissingNavElementError struct{}

type MissingTOCError struct{}

type NavPoint struct {
	Title    string     `json:"title"`              // display text for the TOC entry
	Src      string     `json:"src"`                // ZIP-relative path, may include a fragment (e.g. "OEBPS/ch1.xhtml#sec1")
	Children []NavPoint `json:"children,omitempty"` // nested entries, nil if there are none
}

type Package struct {
	Version  string      `json:"version"`  // e.g. "2.0" or "3.0", as written in the OPF
	Metadata Metadata    `json:"metadata"` // bibliographic metadata from the OPF <metadata> element
	Manifest []Item      `json:"manifest"` // all items declared in the OPF <manifest>
	Spine    []SpineItem `json:"spine"`    // reading order declared in the OPF <spine>
}

type Reader struct {
	// Package is the parsed OPF document for the open EPUB.
	Package *Package
	// contains filtered or unexported fields
}

type SpineItem struct {
	IDRef  string `json:"id_ref"` // references a manifest item by its ID
	Linear bool   `json:"linear"` // false only when the OPF explicitly sets linear="no"
}

type UnsupportedVersionError struct {
	Version string // the version string from the OPF version attribute
	Path    string // path to the OPF document within the EPUB archive
}

type Violation struct {
	Code    ViolationCode `json:"code"`    // machine-readable rule identifier
	Message string        `json:"message"` // human-readable description of the violation
}

type ViolationCode string