feat: consume schema title property

[P0lip]

General rules:

• given object type & present title, we enrich the type with name, i.e.

  {
  "title": "User",
  "type": "object",
  "properties": {
  "name": {
    "type": "string"
  }
  }
  }

  Before:

After:

• given array type with non-array items, we replace the subtype name with title, i.e.

  {
  "type": "array",
  "items": {
  "title": "User",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    }
  }
  }
  }

  Before:

After:

• given array type with no items

{
  "type": "array",
  "title": "Foo"
}

Before:

After:

• $refs - we try to retrieve the title from referenced property

{
  "type": "object",
  "properties": {
    "foo": {
      "$ref": "#/properties/user"
    },
    "user" : {
      "title": "User",
      "properties": {
        "name": {
          "type": "string"
        }
      }
    }
  }
}

Before (eager resolving enabled):

Before (eager resolving disabled):

After (eager resolving enabled):

After (eager resolving disabled):

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/properties/user"
      }
    },
    "user" : {
      "title": "User",
      "properties": {
        "name": {
          "type": "string"
        }
      }
    }
  }
}

Before (eager resolving enabled):

Before (eager resolving disabled):

After (eager resolving enabled): After (eager resolving disabled):

Remarks:

• we do not support combiners at all (on purpose)

  {
  "title": "test",
  "oneOf": [
  { "type": "string" }
  ]
  }

  

• we do not display types for primitive types (on purpose)

{
  "type": "string",
  "title": "foo"
}

{
  "type": "array",
  "items": {
    "title": "abc",
    "type": "string"
  }
}

• we do not display titles for mixed types (on purpose)

  {
  "type": "array",
  "items": {
  "title": "abc",
  "type": ["string", "object"]
  }
  }

  

• arrays with defined items

  {
  "title": "test",
  "type": "array",
  "items": [
  {
    "title": "foo",
    "type": "string"
  },
  {
    "title": "foo",
    "type": "number"
  }
  ]
  }

  

[marbemac]

This is 🔥.

One request - if you have not already, could you yalc this into platform v1 and manually inspect a wide variety of the sample-models in explorer to make sure that JSV:

a) does not crash for any of them b) handles the complex use cases represented in that repo nicely

---

The only thing I'm not sure about is object[User]. The [] kind of throws me off, since it's normally used for arrays. And it's not like when it is an array we show array[object[User]]. Maybe we just show User rather than object[User]?

[marbemac]

Also, I suggest that @mallachari does a pass on the code review.

[P0lip]

This might be unrelated here but I also don't understand why is there an extra level of indentation in one of these cases:

$refs have one extra level of nesting unless you enable eager $ref resolving (which we do have enabled in elements - studio, explorer, docs), so it's not that important.

Basically, when you don't resolve $refs upfront, we retain them in the document, to be resolved later once you expand the row.

Upon expansion

With eager resolving enabled, this is how it looks like

It's fairly transparent to user - the rendered schema looks like there was no $ref at all. Having said that, the extra nesting level is for the sake of consistency. In our case, however, the effect is rather none, given we have the eager resolving option enabled, so in our case the schema will look like the latter example.

[P0lip]

object - {name} looks tad weird, but hm, getting rid of object may be confusing for some. Don't have any preference. @marbemac what do you think about the proposal @mallachari posted?

[marbemac]

How about object{User} and array[User]? In this case would drop the extra {4} property counts, not sure how useful those really are in any case.

Or User and User[]?

[P0lip]

Or User and User[]?

This looks good to me, but what about other types, i.e strings? array[string]?

[P0lip]

I went with It feels really cool. No title:

[stoplight-bot]

:tada: This PR is included in version 3.0.0-beta.25 :tada:

The release is available on:

• npm package (@beta dist-tag)
• GitHub release

Your semantic-release bot :package::rocket:

[marbemac]

Looks great! The only small suggestion in the name of consistency might be object[], but we can visit this later - not a big deal.

[stoplight-bot]

:tada: This PR is included in version 3.0.0 :tada:

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot :package::rocket: