Add schema customisation to gatsby-source-contentful

[wardpeet]

Summary

Enable schema customization for contentful data. Contentful gives us all the information we need to create typings.

Rich Text is the hardest one because it contains a JSON blob. In my opinion, it should stay that way. I'm not certain how we handle it currently in the plugin, so it might become a breaking change.

Schema customization gives us faster type creation and also better error messaging when not all content is present yet.

Rich Text preview:

{
  "fields": [
    {
      "id": "title",
      "name": "Title",
      "type": "Symbol",
      "localized": false,
      "required": false,
      "validations": [],
      "disabled": false,
      "omitted": false
    },
    {
      "id": "test",
      "name": "test",
      "type": "RichText",
      "localized": false,
      "required": false,
      "validations": [
        {
          "nodes": {}
        },
        {
          "enabledMarks": [
            "bold",
            "italic",
            "underline"
          ],
          "message": "Only bold, italic, and underline marks are allowed"
        }
      ],
      "disabled": false,
      "omitted": false
    }
  ],
}

An entry with one reference:

{
  "fields": [
    {
      "id": "parentPage",
      "name": "Parent Page",
      "type": "Link",
      "localized": false,
      "required": false,
      "validations": [
        {
          "linkContentType": [
            "page"
          ]
        }
      ],
      "disabled": false,
      "omitted": false,
      "linkType": "Entry"
    },
  ]
}

An entry with multiple references:

{
  "fields": [
    {
      "id": "associatedPage",
      "name": "Associated Page",
      "type": "Link",
      "localized": false,
      "required": false,
      "validations": [
        {
          "linkContentType": [
            "jobsBlock",
            "keyvisual",
            "page"
          ]
        }
      ],
      "disabled": false,
      "omitted": false,
      "linkType": "Entry"
    },
  ]
}

Todo

• create an option in gatsby-contentful-plugin to enable schema customization
• Setup schema customization

Prior art: #12816

[github-actions]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.
If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

[github-actions]

Hey again!

It’s been 30 days since anything happened on this issue, so our friendly neighborhood robot (that’s me!) is going to close it.
Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m HUMAN_EMOTION_SORRY. Please feel free to reopen this issue or create a new one if you need anything else.
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks again for being part of the Gatsby community! 💪💜