jsonapi

type Error struct {
	// ID is a unique identifier for this particular occurrence of a problem.
	ID string `json:"id,omitempty"`
	// Title is a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
	Title string `json:"title,omitempty"`
	// Detail is a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
	Detail string `json:"detail,omitempty"`
	// Status is the HTTP status code applicable to this problem, expressed as a string value.
	Status string `json:"status,omitempty"`
	// Code is an application-specific error code, expressed as a string value.
	Code string `json:"code,omitempty"`
	// Meta is an object containing non-standard meta-information about the error.
	Meta map[string]interface{} `json:"meta,omitempty"`
}

type ErrorsPayload struct {
	JSONAPI map[string]interface{} `json:"jsonapi,omitempty"`
	Errors  []*Error               `json:"errors"`
}

type Link struct {
	Href string `json:"href"`
	Meta Meta   `json:"meta,omitempty"`
}

type LinkOptions struct {
	// Type defines link type.
	Type LinkType

	// BaseURL should be the common base url.
	BaseURL string
	// Collection is the link root collection name.
	Collection string
	// RootID is the root collection primary value.
	RootID string

	// RelatedField is the related field name used in the relationship link type.
	RelatedField string

	// PaginationLinks contains the query values for the pagination links like:
	// 'first', 'prev', 'next', 'last'. The values should be only the query values
	// without the '?' sign.
	PaginationLinks *PaginationLinks
}

type LinkType int

type Links map[string]interface{}

type ManyPayload struct {
	Links    *TopLinks `json:"links,omitempty"`
	Meta     *Meta     `json:"meta,omitempty"`
	Data     []*Node   `json:"data"`
	Included []*Node   `json:"included,omitempty"`
}

type MarshalOptions struct {
	Link LinkOptions

	RootCollection string `validate:"required"`
	RootID         string `validate:"required"`
	RelatedField   string `validate:"required"`

	Meta             map[string]interface{}
	RelationshipMeta map[string]Meta
}

type Meta map[string]interface{}

type Node struct {
	Type          string                 `json:"type"`
	ID            string                 `json:"id,omitempty"`
	Attributes    map[string]interface{} `json:"attributes,omitempty"`
	Relationships map[string]interface{} `json:"relationships,omitempty"`
	Links         *Links                 `json:"links,omitempty"`
	Meta          *Meta                  `json:"meta,omitempty"`
}

type PaginationLinks struct {
	// Self should be just a query too
	Self  string
	First string
	Prev  string
	Next  string
	Last  string

	Total int64
}

type Payloader interface {
	SetLinks(links *TopLinks)
	SetMeta(meta *Meta)
	SetIncluded(included []*Node)
}

type RelationshipManyNode struct {
	Data  []*Node `json:"data"`
	Links *Links  `json:"links,omitempty"`
	Meta  *Meta   `json:"meta,omitempty"`
}

type RelationshipOneNode struct {
	Data  *Node  `json:"data"`
	Links *Links `json:"links,omitempty"`
	Meta  *Meta  `json:"meta,omitempty"`
}

type SinglePayload struct {
	Links    *TopLinks `json:"links,omitempty"`
	Meta     *Meta     `json:"meta,omitempty"`
	Data     *Node     `json:"data"`
	Included []*Node   `json:"included,omitempty"`
}

type TopLinks struct {
	Self    string `json:"self,omitempty"`
	Related string `json:"related,omitempty"`

	First string `json:"first,omitempty"`
	Prev  string `json:"prev,omitempty"`
	Next  string `json:"next,omitempty"`
	Last  string `json:"last,omitempty"`
}

type UnmarshalOptions struct {
	StrictUnmarshalMode bool
}