worlds

type CloneWorld struct {
	// The name of the World
	// required: false
	Name string `json:"name" validate:"omitempty,noforwardslash,min=3" form:"name"`
	// Optional Owner of the world. Must be a user or an org.
	// If not set, the current user will be used as owner
	Owner string `json:"owner" form:"owner"`
	// Optional privacy/visibility setting.
	Private *bool `json:"private" validate:"omitempty" form:"private"`
}

type CreateReport struct {
	Reason string `json:"reason" form:"reason"`
}

type CreateWorld struct {
	// The name of the World
	// required: true
	Name string `json:"name" validate:"required,noforwardslash,min=3" form:"name"`
	// Optional Owner of the world. Must be a user or an org.
	// If not set, the current user will be used as owner
	Owner string `json:"owner" form:"owner"`
	// License ID
	// required: true
	// minimum: 1
	License int `json:"license" validate:"required,gte=1" form:"license"`
	// The associated permissions. 0 for public, 1 for private.
	// enum: 0, 1
	Permission int `json:"permission" validate:"gte=0,lte=1" form:"permission"`
	// Optional description
	Description string `json:"description" form:"description"`
	// A comma separated list of tags
	Tags string `json:"tags" validate:"printascii" form:"tags"`
	// One or more files
	// required: true
	File string `json:"file" validate:"omitempty,gt=0" form:"-"`
	// Optional privacy/visibility setting.
	Private *bool `json:"private" validate:"omitempty" form:"private"`
}

type ModelInclude struct {
	// Override default GORM Model fields
	ID uint `gorm:"primary_key" json:"-"`
	// Owning world ID
	WorldID      uint `json:"-"`
	WorldVersion *int `json:"world_version"`
	// The owner name of the model
	ModelOwner *string `json:"model_owner,omitempty"`
	// The name of the model
	ModelName *string `json:"model_name,omitempty"`
	// The version of the model
	ModelVersion *int `json:"model_version,omitempty"`
	// The Include type, eg. full_url, model://, etc
	IncludeType *string `json:"type,omitempty"`
}

type ModelIncludes []ModelInclude

type Service struct{}

type UpdateWorld struct {
	// Optional description
	Description *string `json:"description" form:"description"`
	// Optional list of tags (comma separated)
	Tags *string `json:"tags" form:"tags"`
	// One or more files
	File string `json:"file" validate:"omitempty,gt=0" form:"-"`
	// Optional privacy/visibility setting.
	Private *bool `json:"private" validate:"omitempty" form:"private"`
}

type World struct {
	// Override default GORM Model fields
	ID        uint      `gorm:"primary_key" json:"-"`
	CreatedAt time.Time `gorm:"type:timestamp(3) NULL"`
	UpdatedAt time.Time
	// Added 2 milliseconds to DeletedAt field, and added it to the unique index
	// to help disambiguate when soft deleted rows are involved.
	DeletedAt *time.Time `gorm:"type:timestamp(2) NULL; unique_index:idx_world_owner" sql:"index"`

	// The name of the world
	Name *string `gorm:"unique_index:idx_world_owner" json:"name,omitempty"`

	// Unique identifier for the world
	UUID *string `json:"-"`

	// A description of the world (max 65,535 chars)
	// Interesting post about TEXT vs VARCHAR(30000) performance:
	// https://nicj.net/mysql-text-vs-varchar-performance/
	Description *string `gorm:"type:text" json:"description,omitempty"`

	// Number of likes
	Likes int `json:"likes,omitempty"`

	// Bytes of the world, when downloaded as a zip
	Filesize int `json:"filesize,omitempty"`

	// Number of downloads
	Downloads int `json:"downloads,omitempty"`

	// Date and time the world was first uploaded
	UploadDate *time.Time `json:"upload_date,omitempty"`

	// Modification Date and time
	ModifyDate *time.Time `json:"modify_date,omitempty"`

	// Tags associated to this world
	Tags models.Tags `gorm:"many2many:world_tags;" json:"tags,omitempty"`

	// Location of the world on disk
	Location *string `json:"-"`

	// The user who created this world
	Owner *string `gorm:"unique_index:idx_world_owner" json:"owner,omitempty"`

	// The username of the User that created this world (usually got from the JWT)
	Creator *string `json:"creator,omitempty"`

	// Permission - 0: public, 1: owner, (future: team, others)
	Permission int `json:"permission,omitempty"`

	// The license associated to this world
	License   license.License `json:"license,omitempty"`
	LicenseID int             `json:"lic_id,omitempty"`

	// Private - True to make this a private resource
	Private *bool `json:"private,omitempty"`
}

type WorldDownload struct {
	gorm.Model

	// The ID of the user that made the download
	UserID *uint
	// The ID of the world that was downloaded
	WorldID *uint
	// User-Agent sent in the http request (optional)
	UserAgent string
}

type WorldLike struct {
	// Override default GORM Model fields
	ID        uint      `gorm:"primary_key"`
	CreatedAt time.Time `gorm:"type:timestamp(3) NULL"`
	UpdatedAt time.Time

	// The ID of the user that made the like
	UserID *uint `gorm:"unique_index:idx_user_world_like"`

	// The ID of the world that was liked
	WorldID *uint `gorm:"unique_index:idx_user_world_like"`
}

type WorldReport struct {
	generics.Report

	// WorldID represents the world that was reported
	WorldID *uint `json:"world,omitempty"`
}

type Worlds []World