model

type AggregateRating struct {
	ReviewCount int     `json:"reviewCount,omitempty"`
	RatingCount int     `json:"ratingCount,omitempty"`
	RatingValue float64 `json:"ratingValue,omitempty"`
	BestRating  int     `json:"bestRating,omitempty"`
	WorstRating int     `json:"worstRating,omitempty"`
}

type Allergen struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	TracesOf    bool   `json:"tracesOf,omitempty"`
}

type DataInput struct {
	Url            string
	Text           string
	RootNode       *html.Node           `json:"-"`
	Document       *goquery.Document    `json:"-"`
	Schemas        *microdata.Microdata `json:"-"`
	RequestOptions RequestOptions       `json:"-"`
}

type Feed struct {
	Url     string    `json:"url"`
	Entries []*Recipe `json:"entries"`
}

type FeedOptions struct {
	ScrapeOptions

	// When true, only the feed will be scraped, without scraping each entry's url
	Quick bool
	// Filter out recipes with fewer than this number of ingredients (0 = no filter)
	MinIngredients int
	// When true, filter out recipes without an image
	RequireImage bool
	// When true, filter out recipes without instructions
	RequireInstructions bool
}

type FeedScraper = func(data *DataInput, feed *Feed) error

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
	Get(url string) (*http.Response, error)
	Post(url, contentType string, body io.Reader) (*http.Response, error)
}

type HowToSection struct {
	HowToStep              // because it's optional to have a group, we have to embed `HowToStep` here
	Steps     []*HowToStep `json:"itemListElement,omitempty"`
}

type HowToStep struct {
	Name  string `json:"name,omitempty"`
	Text  string `json:"text,omitempty"`
	Url   string `json:"url,omitempty"`
	Image string `json:"image,omitempty"`
	Video string `json:"video,omitempty"`
}

type HowToTool struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	Url         string `json:"url,omitempty"`
	Image       string `json:"image,omitempty"`
	Quantity    string `json:"requiredQuantity,omitempty"`
}

type ImageObject struct {
	Url     string `json:"url,omitempty"`
	Width   int    `json:"width,omitempty"`
	Height  int    `json:"height,omitempty"`
	Caption string `json:"caption,omitempty"`
}

type NutritionInformation struct {
	ServingSize           string   `json:"servingSize,omitempty"`           // The serving size, in terms of the number of volume or mass.
	Calories              *float64 `json:"calories,omitempty"`              // The number of calories.
	CarbohydrateContent   *float64 `json:"carbohydrateContent,omitempty"`   // The number of grams of carbohydrates.
	CholesterolContent    *float64 `json:"cholesterolContent,omitempty"`    // The number of milligrams of cholesterol.
	FatContent            *float64 `json:"fatContent,omitempty"`            // The number of grams of fat.
	FiberContent          *float64 `json:"fiberContent,omitempty"`          // The number of grams of fiber.
	ProteinContent        *float64 `json:"proteinContent,omitempty"`        // The number of grams of protein.
	SaturatedFatContent   *float64 `json:"saturatedFatContent,omitempty"`   // The number of grams of saturated fat.
	SodiumContent         *float64 `json:"sodiumContent,omitempty"`         // The number of milligrams of sodium.
	SugarContent          *float64 `json:"sugarContent,omitempty"`          // The number of grams of sugar.
	TransFatContent       *float64 `json:"transFatContent,omitempty"`       // The number of grams of trans fat.
	UnsaturatedFatContent *float64 `json:"unsaturatedFatContent,omitempty"` // The number of grams of unsaturated fat.
	// other minerals commonly found in recipes, not covered by schema.org
	SaltContent      *float64 `json:"saltContent,omitempty"`      // The number of grams of salt.
	IronContent      *float64 `json:"ironContent,omitempty"`      // The number of milligrams of iron.
	PotassiumContent *float64 `json:"potassiumContent,omitempty"` // The number of milligrams of potassium.
	CalciumContent   *float64 `json:"calciumContent,omitempty"`   // The number of milligrams of calcium.
}

type Organization struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	Url         string `json:"url,omitempty"`
	Logo        string `json:"logo,omitempty"`
}

type Person struct {
	Name        string   `json:"name,omitempty"`
	JobTitle    string   `json:"jobTitle,omitempty"`
	Description string   `json:"description,omitempty"`
	KnowsAbout  []string `json:"knowsAbout,omitempty"`
	Url         string   `json:"url,omitempty"`
	Image       string   `json:"image,omitempty"`
}

type PropertyValue struct {
	Value       string `json:"value,omitempty"` // The quantitative value of the property, e.g. "2", "1/2", "a pinch"
	MaxValue    string `json:"maxValue,omitempty"`
	MinValue    string `json:"minValue,omitempty"`
	UnitText    string `json:"unitText,omitempty"` // The unit of measurement, e.g. "g", "cup", "teaspoon"
	UnitCode    string `json:"unitCode,omitempty"`
	Name        string `json:"name,omitempty"` // The name of the property, e.g. "sugar", "flour", "salt"
	Image       string `json:"image,omitempty"`
	Url         string `json:"url,omitempty"`
	Description string `json:"description,omitempty"`
	// extra fields not covered by schema.org
	Category      string      `json:"category,omitempty"`
	Pantry        bool        `json:"pantry,omitempty"`
	EstimatedCost string      `json:"estimatedCost,omitempty"`
	Allergens     []*Allergen `json:"allergens,omitempty"`
}

type Recipe struct {
	Url           string                `json:"url,omitempty"`
	Name          string                `json:"name,omitempty"`
	Description   string                `json:"description,omitempty"`
	Language      string                `json:"inLanguage,omitempty"`
	Images        []*ImageObject        `json:"image,omitempty"`
	Author        *Person               `json:"author,omitempty"`
	Publisher     *Organization         `json:"publisher,omitempty"`
	Text          string                `json:"text,omitempty"`
	PrepTime      string                `json:"prepTime,omitempty"`
	CookTime      string                `json:"cookTime,omitempty"` // alias `performTime`
	TotalTime     string                `json:"totalTime,omitempty"`
	Difficulty    string                `json:"educationalLevel,omitempty"` // `difficulty` is not a part of Recipe schema https://github.com/schemaorg/schemaorg/issues/3130
	CookingMethod string                `json:"cookingMethod,omitempty"`
	Diets         []string              `json:"suitableForDiet,omitempty"`
	Categories    []string              `json:"recipeCategory,omitempty"`
	Cuisines      []string              `json:"recipeCuisine,omitempty"`
	Keywords      []string              `json:"keywords,omitempty"`
	Yield         string                `json:"recipeYield,omitempty"`        // alias `yield`
	Ingredients   []*PropertyValue      `json:"recipeIngredient,omitempty"`   // alias `supply`
	Equipment     []*HowToTool          `json:"tool,omitempty"`               // alias `tool`, `recipeEquipment` is not a part of Recipe schema https://github.com/schemaorg/schemaorg/issues/3132
	Instructions  []*HowToSection       `json:"recipeInstructions,omitempty"` // alias `step`
	Nutrition     *NutritionInformation `json:"nutrition,omitempty"`
	Rating        *AggregateRating      `json:"aggregateRating,omitempty"`
	CommentCount  int                   `json:"commentCount,omitempty"`
	Video         *VideoObject          `json:"video,omitempty"`
	Links         []string              `json:"sameAs,omitempty"` // maybe not the cleanest name, but we can store additional links here
	EstimatedCost string                `json:"estimatedCost,omitempty"`
	Allergens     []*Allergen           `json:"allergens,omitempty"` // not a part of Recipe schema
	DateModified  *time.Time            `json:"dateModified,omitempty"`
	DatePublished *time.Time            `json:"datePublished,omitempty"`
}

type RequestOptions struct {
	// Context for cancellation. If nil, context.Background() is used.
	Context context.Context
	// Headers to merge with defaults. Custom values take priority.
	Headers http.Header
	// HttpClient to use. If nil, a default 30s-timeout client is used.
	HttpClient HTTPClient
}

type ScrapeOptions struct {
	RequestOptions

	// When true, skip scraping the URL from meta tags and rely on the input URL.
	SkipMetaUrl bool
	// When true, skip parsing microdata and rely on other sources. It is a main source of data.
	SkipMicrodata bool
}

type Scraper = func(data *DataInput, recipe *Recipe) error

type VideoObject struct {
	Name         string     `json:"name,omitempty"`
	Description  string     `json:"description,omitempty"`
	Duration     string     `json:"duration,omitempty"`
	EmbedUrl     string     `json:"embedUrl,omitempty"`
	ContentUrl   string     `json:"contentUrl,omitempty"`
	ThumbnailUrl string     `json:"thumbnailUrl,omitempty"`
	UploadDate   *time.Time `json:"uploadDate,omitempty"`
}