manifest

type A11y struct {
	ConformsTo            []A11yProfile             `json:"conformsTo,omitempty"`           // An established standard to which the described resource conforms.
	Certification         *A11yCertification        `json:"certification,omitempty"`        // Certification of accessible publications.
	Summary               string                    `json:"summary,omitempty"`              // A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
	AccessModes           []A11yAccessMode          `json:"accessMode,omitempty"`           // The human sensory perceptual system or cognitive faculty through which a person may process or perceive information.
	AccessModesSufficient [][]A11yPrimaryAccessMode `json:"accessModeSufficient,omitempty"` //  A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource.
	Features              []A11yFeature             `json:"feature,omitempty"`              // Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility.
	Hazards               []A11yHazard              `json:"hazard,omitempty"`               // A characteristic of the described resource that is physiologically dangerous to some users.
	Exemptions            []A11yExemption           `json:"exemption,omitempty"`            // Justifications for non-conformance based on exemptions in a given jurisdiction.
}

type A11yAccessMode string

type A11yCertification struct {
	CertifiedBy string `json:"certifiedBy,omitempty"` // Identifies a party responsible for the testing and certification of the accessibility of a Publication.
	Credential  string `json:"credential,omitempty"`  // Identifies a credential or badge that establishes the authority of the party identified in the associated `certifiedBy` property to certify content accessible.
	Report      string `json:"report,omitempty"`      // Provides a link to an accessibility report created by the party identified in the associated `certifiedBy` property.
}

type A11yExemption string

type A11yFeature string

type A11yHazard string

type A11yPrimaryAccessMode string

type A11yProfile string

type Collection = Contributor

type Collections = Contributors

type Contributor struct {
	LocalizedName   LocalizedString  `json:"name" validate:"required"` // The name of the contributor.
	LocalizedSortAs *LocalizedString `json:"sortAs,omitempty"`         // The string used to sort the name of the contributor.
	Identifier      string           `json:"identifier,omitempty"`     // An unambiguous reference to this contributor.
	Roles           Strings          `json:"role,omitempty"`           // The roles of the contributor in the making of the publication.
	Position        *float64         `json:"position,omitempty"`       // The position of the publication in this collection/series, when the contributor represents a collection. TODO validator
	Links           LinkList         `json:"links,omitempty"`          // Used to retrieve similar publications for the given contributor.
}

type Contributors []Contributor

type EPUBLayout string

type Encryption struct {
	Scheme         string `json:"scheme,omitempty"`
	Profile        string `json:"profile,omitempty"`
	Algorithm      string `json:"algorithm,omitempty"`
	Compression    string `json:"compression,omitempty"`
	OriginalLength int64  `json:"originalLength,omitempty"`
}

type Fit string // Suggested method for constraining a resource inside the viewport.

type GuidedNavigationDocument struct {
	Links  LinkList                 `json:"links,omitempty"` // References to other resources that are related to the current Guided Navigation Document.
	Guided []GuidedNavigationObject `json:"guided"`          // A sequence of resources and/or media fragments into these resources, meant to be presented sequentially to the user.
}

type GuidedNavigationObject struct {
	AudioRef string                   `json:"audioref,omitempty"` // References an audio resource or a fragment of it.
	ImgRef   string                   `json:"imgref,omitempty"`   // References an image or a fragment of it.
	TextRef  string                   `json:"textref,omitempty"`  // References a textual resource or a fragment of it.
	Text     string                   `json:"text,omitempty"`     // Textual equivalent of the resources or fragment of the resources referenced by the current Guided Navigation Object.
	Role     []string                 `json:"role,omitempty"`     // Convey the structural semantics of a publication
	Children []GuidedNavigationObject `json:"children,omitempty"` // Items that are children of the containing Guided Navigation Object.
}

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

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

type Link struct {
	Href       HREF                 `json:"href"`                 // URI or URI template of the linked resource.
	MediaType  *mediatype.MediaType `json:"type,omitempty"`       // MIME type of the linked resource.
	Title      string               `json:"title,omitempty"`      // Title of the linked resource.
	Rels       Strings              `json:"rel,omitempty"`        // Relation between the linked resource and its containing collection.
	Properties Properties           `json:"properties,omitempty"` // Properties associated to the linked resource.
	Height     uint                 `json:"height,omitempty"`     // Height of the linked resource in pixels.
	Width      uint                 `json:"width,omitempty"`      // Width of the linked resource in pixels.
	Bitrate    float64              `json:"bitrate,omitempty"`    // Bitrate of the linked resource in kbps.
	Duration   float64              `json:"duration,omitempty"`   // Length of the linked resource in seconds.
	Languages  Strings              `json:"language,omitempty"`   // Expected language of the linked resource (BCP 47 tag).
	Alternates LinkList             `json:"alternate,omitempty"`  // Alternate resources for the linked resource.
	Children   LinkList             `json:"children,omitempty"`   // Resources that are children of the linked resource, in the context of a given collection role.
}

type LinkList []Link

type LocalizedString struct {
	Translations map[string]string
}

type Locations struct {
	Fragments        []string               `json:"fragments,omitempty"`        // Contains one or more fragment in the resource referenced by the [Locator].
	Progression      *float64               `json:"progression,omitempty"`      // Progression in the resource expressed as a percentage (between 0 and 1).
	Position         *uint                  `json:"position,omitempty"`         // An index in the publication (>= 1).
	TotalProgression *float64               `json:"totalProgression,omitempty"` // Progression in the publication expressed as a percentage (between 0 and 1).
	OtherLocations   map[string]interface{} // Additional locations for extensions.
}

type Locator struct {
	Href      url.URL             `json:"href"`
	MediaType mediatype.MediaType `json:"type"`
	Title     string              `json:"title,omitempty"`
	Locations Locations           `json:"locations,omitempty"`
	Text      Text                `json:"text,omitempty"`
}

type Manifest struct {
	Context         Strings                  `json:"@context,omitempty"`
	Metadata        Metadata                 `json:"metadata"`
	Links           LinkList                 `json:"links"`
	ReadingOrder    LinkList                 `json:"readingOrder,omitempty"`
	Resources       LinkList                 `json:"resources,omitempty"` //Replaces the manifest but less redundant
	TableOfContents LinkList                 `json:"toc,omitempty"`
	Subcollections  PublicationCollectionMap `json:"-"` //Extension point for collections that shouldn't show up in the manifest
}

type ManifestTransformer interface {
	TransformManifest(manifest Manifest) Manifest
	TransformMetadata(metadata Metadata) Metadata
	TransformLink(link Link) Link
	TransformHREF(href HREF) HREF
}

type MediaOverlay struct {
	ActiveClass         string `json:"activeClass,omitempty"`         // Author-defined CSS class name to apply to the currently-playing EPUB Content Document element.
	PlaybackActiveClass string `json:"playbackActiveClass,omitempty"` // Author-defined CSS class name to apply to the EPUB Content Document's document element when playback is active.
}

type Metadata struct {
	Identifier         string                 `json:"identifier,omitempty"`
	Type               string                 `json:"@type,omitempty"`
	ConformsTo         Profiles               `json:"conformsTo,omitempty"`
	LocalizedTitle     LocalizedString        `json:"title" validate:"required"`
	LocalizedSubtitle  *LocalizedString       `json:"subtitle,omitempty"`
	LocalizedSortAs    *LocalizedString       `json:"sortAs,omitempty"`
	Accessibility      *A11y                  `json:"accessibility,omitempty"`
	Modified           *time.Time             `json:"modified,omitempty"`
	Published          *time.Time             `json:"published,omitempty"`
	Languages          Strings                `json:"language,omitempty" validate:"BCP47"` // TODO validator
	Subjects           []Subject              `json:"subject,omitempty"`
	Authors            Contributors           `json:"author,omitempty"`
	Translators        Contributors           `json:"translator,omitempty"`
	Editors            Contributors           `json:"editor,omitempty"`
	Artists            Contributors           `json:"artist,omitempty"`
	Illustrators       Contributors           `json:"illustrator,omitempty"`
	Letterers          Contributors           `json:"letterer,omitempty"`
	Pencilers          Contributors           `json:"penciler,omitempty"`
	Colorists          Contributors           `json:"colorist,omitempty"`
	Inkers             Contributors           `json:"inker,omitempty"`
	Narrators          Contributors           `json:"narrator,omitempty"`
	Contributors       Contributors           `json:"contributor,omitempty"`
	Publishers         Contributors           `json:"publisher,omitempty"`
	Imprints           Contributors           `json:"imprint,omitempty"`
	ReadingProgression ReadingProgression     `json:"readingProgression,omitempty" validate:"readingProgression"` // TODO validator.
	Description        string                 `json:"description,omitempty"`
	Duration           *float64               `json:"duration,omitempty" validator:"positive"` // TODO validator
	NumberOfPages      *uint                  `json:"numberOfPages,omitempty"`
	BelongsTo          map[string]Collections `json:"belongsTo,omitempty"`
	Presentation       *Presentation          `json:"presentation,omitempty"`
	MediaOverlay       *MediaOverlay          `json:"mediaOverlay,omitempty"`

	OtherMetadata map[string]interface{} `json:"-"` // Extension point for other metadata.
}

type Orientation string // Suggested orientation for the device when displaying the linked resource.

type Overflow string // Suggested method for handling overflow while displaying the linked resource.

type Page string // Indicates how the linked resource should be displayed in a reading environment that displays synthetic spreads.

type Presentation struct {
	Clipped     *bool        `json:"clipped,omitempty"`     // Specifies whether or not the parts of a linked resource that flow out of the viewport are clipped.
	Continuous  *bool        `json:"continuous,omitempty"`  // Indicates how the progression between resources from the [readingOrder] should be handled.
	Fit         *Fit         `json:"fit,omitempty"`         // Suggested method for constraining a resource inside the viewport.
	Orientation *Orientation `json:"orientation,omitempty"` // Suggested orientation for the device when displaying the linked resource.
	Overflow    *Overflow    `json:"overflow,omitempty"`    // Suggested method for handling overflow while displaying the linked resource.
	Spread      *Spread      `json:"spread,omitempty"`      // Indicates the condition to be met for the linked resource to be rendered within a synthetic spread.
	Layout      *EPUBLayout  `json:"layout,omitempty"`      // Hints how the layout of the resource should be presented (EPUB extension).
}

type Profile string

type Profiles []Profile

type Properties map[string]interface{}

type PublicationCollection struct {
	Metadata       map[string]interface{}   `json:"metadata,omitempty"`
	Links          LinkList                 `json:"links,omitempty"`
	Subcollections PublicationCollectionMap `json:"-"`
}

type PublicationCollectionMap map[string][]PublicationCollection

type ReadingProgression string

type Spread string // Indicates the condition to be met for the linked resource to be rendered within a synthetic spread.

type Strings []string

type Subject struct {
	LocalizedName   LocalizedString  `json:"name" validate:"required"`
	LocalizedSortAs *LocalizedString `json:"sortAs,omitempty"`
	Scheme          string           `json:"scheme,omitempty"`
	Code            string           `json:"code,omitempty"`
	Links           LinkList         `json:"links,omitempty"`
}

type Text struct {
	Before    string `json:"before,omitempty"`    // The text before the locator.
	Highlight string `json:"highlight,omitempty"` // The text at the locator.
	After     string `json:"after,omitempty"`     // The text after the locator.
}