libraries

type CreateLibraryPayload struct {
	Name                  string   `json:"name" validate:"required,max=100"`
	OrganizeFileStructure *bool    `json:"organize_file_structure,omitempty"`
	CoverAspectRatio      string   `` /* 140-byte string literal not displayed */
	LibraryPaths          []string `json:"library_paths" validate:"required,min=1,max=50,dive"`
	TagNamespaces         []string `json:"tag_namespaces,omitempty" mod:"dive,trim" validate:"omitempty,max=20,dive,max=50"`
}

type LibrarySummary struct {
	ID                    int    `json:"id"`
	Name                  string `json:"name"`
	CoverAspectRatio      string `json:"cover_aspect_ratio" tstype:"CoverAspectRatio"`
	OrganizeFileStructure bool   `json:"organize_file_structure"`
	// TagNamespaces group the library's tags on the tags page, the tag
	// filter, and the book page.
	TagNamespaces []string `json:"tag_namespaces"`
}

type ListLibrariesOptions struct {
	Limit      *int
	Offset     *int
	LibraryIDs []int // If non-nil, only return libraries with these IDs; an empty slice returns none
	// WithoutPaths skips loading LibraryPaths for callers that never return
	// them, such as the user-scoped library summaries.
	WithoutPaths bool
	// contains filtered or unexported fields
}

type ListLibrariesQuery struct {
	Limit  int `query:"limit" json:"limit,omitempty" default:"10" validate:"min=1,max=100"`
	Offset int `query:"offset" json:"offset,omitempty" validate:"min=0"`
}

type ListLibrariesResponse struct {
	Items []*models.Library `json:"items" tstype:"Library[]"`
	Total int               `json:"total"`
}

type RegisterRoutesOptions struct {
	// OnLibraryChanged is called after a library is created, has its paths
	// updated, or is deleted. Used by the monitor to refresh filesystem watches.
	OnLibraryChanged func()
}

type RetrieveLibraryOptions struct {
	ID *int
}

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

type UpdateLibraryOptions struct {
	Columns            []string
	UpdateLibraryPaths bool
}

type UpdateLibraryPayload struct {
	Name                  *string  `json:"name,omitempty" validate:"omitempty,max=100"`
	OrganizeFileStructure *bool    `json:"organize_file_structure,omitempty"`
	CoverAspectRatio      *string  `` /* 151-byte string literal not displayed */
	LibraryPaths          []string `json:"library_paths,omitempty" validate:"omitempty,min=1,max=50,dive"`
	// TagNamespaces replaces the library's list when present; [] clears it.
	TagNamespaces []string `json:"tag_namespaces,omitempty" mod:"dive,trim" validate:"omitempty,max=20,dive,max=50"`
}