Overview of the Feature Request
As a first iteration of this feature I think we should focus on creating/updating custom featured items and then we could move on to creating featured collections, datasets and files.

We need two API endpoints:

• To create/update the featured items.

• To get the featured items of a specific collection.

This could be the model of the objects returned by the endpoint 👇

type FeaturedItem = CustomFeaturedItem | DvObjectFeaturedItem

type CustomFeaturedItem = {
  id: string
  type: 'custom'
  order: number
  title: string
  content: string
  imageUrl?: string
}

type DvObjectFeaturedItem = {
  id: string
  type: DvObjectType // 'collection' | 'dataset' | 'file'
  order: number
  linkUrl: string
  title: string
  description?: string
}

About the create/update I was thinking about something like this, let's say the user adds 3 new featured items, only one contains a file, and one featured item already exists (last one), then from the SPA we would send a FormData doing the following for example:

  const formData = new FormData()

  const items = [
    { type: 'custom', order: 1, title: 'Title 1', content: 'Content 1' },
    { type: 'custom', order: 2, title: 'Title 2', content: 'Content 2', file: file.files[0] },
    { type: 'custom', order: 3, title: 'Title 3', content: 'Content 3' },
    { id: 'some-id', type: 'custom', order: 4, title: 'Title 4', content: 'Content 4' }
  ]

  items.forEach((item, index) => {
    if (item.id) {
      formData.append(`items[${index}][id]`, item.id)
    }
    formData.append(`items[${index}][type]`, item.type)
    formData.append(`items[${index}][order]`, item.order)
    formData.append(`items[${index}][title]`, item.title)
    formData.append(`items[${index}][content]`, item.content)

    if (item.file) {
      formData.append(`items[${index}][file]`, item.file)
    }
  })

Although I have a doubt, how could we handle the cases in which an existing featured item does not modify its image, only its title let's say, in that case what should we send to the endpoint? a property that says keepFile? this boolean could also be useful if the user removed the image.

What kind of user is the feature intended for?
API Users, SPA Users

What inspired the request?
Q4 Roadmap

What existing behavior do you want changed?
None

Any brand new behavior do you want to add to Dataverse?
Add the possibility to create featured items within a collection.

Any open or closed issues related to this feature request?
IQSS/dataverse-frontend#514