fix: Make nested objects show in typescript .d.ts file and in the doc…

[kpears201]

…umentation

[kpears201]

Currently in both the documentation and the .d.ts file that ships with the SDK a type that has an inline-nested object which might look like:

{
  "SectionIntent": {
    "description": "A Firebolt compliant representation of a user intention to navigate an app to a section not covered by `home`, `entity`, `player`, or `search`, and bring that app to the foreground if needed.",
    "title": "SectionIntent",
    "allOf": [
      {
        "$ref": "#/definitions/Intent"
      },
      {
        "$ref": "#/definitions/IntentProperties"
      },
      {
        "type": "object",
        "properties": {
          "action": {
            "const": "section"
          },
          "data": {
            "type": "object",
            "required": [
              "sectionName"
            ],
            "properties": {
              "sectionName": {
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "required": [
          "data"
        ]
      }
    ]
  }
}

Has generated typescript like this:

type SectionIntent = {
  action: 'section'
  data: object
  context: object
}

After this change it now looks like this:

type SectionIntent = {
    action: 'section'
    data: {
      sectionName: string
    }
    context: {
      source: string
    }
  }

This allows developers looking at the documentation to actually know all the fields that are a part of this schema.
It also makes it so when developing a typescript app in an IDE, it can autocomplete all the fields instead of just the root object.

This will fix it for many schemas, most the intents have nested inline objects and have this issue.

[kschrief]

🎉 This PR is included in version 3.2.0-next.10 🎉

The release is available on:

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

Your semantic-release bot 📦🚀