Props graph syntax

[tonyspiro]

As a user, I want to be able to use props more efficiently, currently it’s cumbersome and confusing for deeply nested props. For context on props, see the Cosmic docs for fetching Objects. For example:

This is not ideal:

const props = 'slug,title,created_at,metadata.author.title,metadata.author.metadata.favorite_places.title,metadata.author.metadata.favorite_places.metadata.image.url,metadata.vehicle.title,metadata.vehicle.created_at,metadata.vehicle.metadata.image.url'

const { object } = await cosmic.objects.findOne({
  type: "articles",
  slug: "lets-goo"
}).props(props)
.depth(3)

It would be better to have something like this:

const props = `{
  slug
  title
  created_at
  metadata {
    author {
      title
      metadata {
        favorite_places {
          title
          metadata {
            image {
              url
            }
          }
        }
      }
    }
    vehicle {
      title
      created_at
      metadata {
        image {
          url
        }
      }
    }
  }
}`

const { object } = await cosmic.objects.findOne({
  type: "articles",
  slug: "lets-goo"
}).props(props).depth(3)

This will give you the explicit shape of the data payload.