Feature/adding renderRichtext option

package.json

@@ -25,6 +25,7 @@
         "dev": "tsc -w"
     },
     "dependencies": {
+        "@contentful/rich-text-html-renderer": "^15.11.1",
         "@nascentdigital/scribe": "^0.11.2",
         "contentful": "^9.1.3",
         "contentful-management": "^7.44.2",

src/Contentfully.ts

@@ -17,7 +17,7 @@ import {IContentfulClient} from './contentful'
 import {ContentModel, RichText} from './entities'
 import {MediaTransform, QueryOptions} from './QueryOptions'
 import {QueryResult} from './QueryResult'
-
+import { documentToHtmlString } from '@contentful/rich-text-html-renderer';
 
 // constants
 export const DEFAULT_OPTIONS: Readonly<ContentfullyOptions> = {
@@ -61,13 +61,15 @@ export class Contentfully {
 
   public readonly contentfulClient: IContentfulClient
   public readonly options: Readonly<Partial<ContentfullyOptions>>
+  public renderRichtext: boolean
 
 
   public constructor(client: IContentfulClient, options: Readonly<Partial<ContentfullyOptions>> = DEFAULT_OPTIONS) {
 
     // initialize instance variables
     this.contentfulClient = client
     this.options = options
+    this.renderRichtext = false
   }
 
   public async getEntry<T extends KeyValueMap & ContentModel>(
@@ -104,6 +106,9 @@ export class Contentfully {
     // parse includes
     const links = await this._createLinks(entries, multiLocale, options.mediaTransform)
 
+    if(options.renderRichtext) {
+      this.renderRichtext = options.renderRichtext
+    }
     // parse core entries
     let items = this._parseEntries(entries.items, links, multiLocale)
 
@@ -388,7 +393,7 @@ export class Contentfully {
     return this._dereferenceLink(value, links, locale)
   }
 
-  private _parseRichTextValue(value: EntryFields.RichText, links: any, locale?: string): RichText[] | undefined {
+  private _parseRichTextValue(value: any, links: any, locale?: string): RichText[] | undefined | string{
 
     // resolve content list
     const {content} = value
@@ -398,6 +403,10 @@ export class Contentfully {
       return undefined
     }
 
+    if(this.renderRichtext) {
+      return documentToHtmlString(value)
+    }
+
     return this._parseRichTextContent(content, links, locale)
   }
 

src/QueryOptions.ts

@@ -7,4 +7,5 @@ export type MediaTransform = (media: Media) => Promise<Media>
 export interface QueryOptions {
   mediaTransform?: MediaTransform
   flatten?: boolean
+  renderRichtext?: boolean
 }