Documentation is not compatible with Typescript

Expected Behavior

As a developer I expect the documentation to contain working snippets/guides.

Actual Behavior

Several guides and snippets are incompatible with the typings.

Possible Solution

One of the points listed could resolve this issue.

• Documentation should reflect the actual API
• Typescript should have a better documentation
• Typings should handle required and optional properties correctly

Ugly workaround

The only way to use the API is to fool typescript via as.

space.createContentType({
    name: "Foo",
    fields: [],
} as Omit<ContentTypeProps, "sys">)

Steps to Reproduce

The example below is just one of several cases. In general it seems like several methods are not typed correctly, making this library incompatible with typescript environments.

1. Go to https://www.contentful.com/developers/docs/references/content-management-api/#/reference/content-types/content-type-collection/create-a-content-type/console/js
2. Go to: https://github.com/contentful/contentful-management.js/blob/c4a7e33eda7c2dea6fd3357420ec0be5652e9de8/lib/create-environment-api.ts#L272
3. The examples or typings are wrong (See: code comments and contentful.com/docs)

displayType and description are required in ContentTypeProps since only sys is omitted via:

Omit<ContentTypeProps, "sys">

As mentioned there are likely several of these issues.

Context

The library is incompatible with typescript.

Environment

• Language Version: v12.15.0
• Package Manager Version: yarn 1.22.4
• Browser Version:
• Operating System: Darwin Kernel Version 19.4.0: Wed Mar 4 22:28:40 PST 2020; root:xnu-6153.101.6~15/RELEASE_X86_64 x86_64
• Package Version: 5.27.1
• Which API are you using?: Management

[pixelass]

@suevalov you are right about ContentFields, I missed the extends Item, I still had an error in that section, will report back tomorrow.

[phoebeschmidt]

🎉 This issue has been resolved in version 5.27.3 🎉

The release is available on:

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

Your semantic-release bot 📦🚀