feat: use Contentful.EntryFields.RichText

[AndrewLeedham]

fixes: #10

Replaces CFRichTextTypes.Block | CFRichTextTypes.Inline with Contentful.EntryFields.RichText,

[marcolink]

Hi @AndrewLeedham, thanks again :)

I just have a little comment.

[AndrewLeedham]

@marcolink it seems that Contentful.EntryFields.RichText is not compatible with the type Document from @contentful/rich-text-types. It is throwing the following error:

This is occurring when using: https://github.com/contentful/rich-text/tree/master/packages/rich-text-react-renderer

So I am wondering which of the following is the best course of action:

1. Update the contentful.js RichText type to use @contentful/rich-text-types.
2. Update @contentful/rich-text-react-renderer to accept both types e.g string and enum.
3. Switch to using CFRichTextTypes.Document here.

[marcolink]

Hi @AndrewLeedham,
I feel this should be directly addressed in contentful.js. If you want - pull requests are always welcome :)

If the only incompatibility is the enum vs string problem, I wonder if a fix in @contentful/rich-text-react-renderer would be the better solution 🤔

[AndrewLeedham]

If the only incompatibility is the enum vs string problem

This playground link illustrates the issue.

I wonder if a fix in @contentful/rich-text-react-renderer would be the better solution 🤔

That would require using a union instead of an enum, which I think would be worse IMO (also a fairly big breaking change). Given @contentful/rich-text-react-renderer is already centralised, requiring it and relying on it in contentful.js makes the most sense to me?

[marcolink]

Hey @AndrewLeedham,

I'll discuss it next week, hopefully, I can post an update on it next week 🤞

[mbifulco]

Hi team - bumping an old issue here (sorry!) to see if there was a resolution to this discussion.

I've been using cf-content-types-generator in my project, and I'm looking for the right/accepted/recommended way to use @contentful/rich-text-react-renderer's documentToReactComponents with the types generated by this library.

If I use the types as generated, I get the following TypeScript error:

Argument of type 'Block | Inline' is not assignable to parameter of type 'Document'.

I tried manually changing the type on rich text fields to Contentful.EntryFields.RichText as well - ultimately I've had the best results so far if I cast the field I'm trying to render to a Document:

import { Document } from "@contentful/rich-text-types";

// ...

documentToReactComponents(inputField as Document, options);

I'm sure I'm missing something simple here, and would love some help!

[AndrewLeedham]

@mbifulco @marcolink updated this PR for the latest code based changes 👍

[marcolink]

Thanks @AndrewLeedham,
I think this is the right way for now 👍

[github-actions]

🎉 This PR is included in version 2.10.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[mbifulco]

Thank you!