Merge pull request #630 from contember/pr/allow-richtext-renderer-rea…

…donly-props

Allow richtext renderer readonly props

build/api/react-client.api.md

@@ -196,7 +196,7 @@ export interface RichTextAnchorElement<CustomElements extends RichTextElement =
 }
 
 // @public (undocumented)
-export type RichTextBlock = Record<string, unknown>;
+export type RichTextBlock = Readonly<Record<string, unknown>>;
 
 // @public (undocumented)
 export interface RichTextBoldLeaf extends RichTextLeaf {
@@ -312,7 +312,7 @@ export const RichTextRenderer: <CustomElements extends RichTextElement<never, ne
 // @public (undocumented)
 export interface RichTextRendererBlockProps<CustomElements extends RichTextElement = never, CustomLeaves extends RichTextLeaf = never> {
     // (undocumented)
-    blocks: RichTextBlock[];
+    blocks: readonly RichTextBlock[];
     // (undocumented)
     referenceDiscriminationField?: string;
     // (undocumented)

packages/react-client/src/components/RichTextRenderer/RichTextBlock.ts

@@ -1 +1 @@
-export type RichTextBlock = Record<string, unknown>
+export type RichTextBlock = Readonly<Record<string, unknown>>

packages/react-client/src/components/RichTextRenderer/RichTextRenderer.tsx

@@ -21,7 +21,7 @@ export interface RichTextRendererBlockProps<
 	CustomElements extends RichTextElement = never,
 	CustomLeaves extends RichTextLeaf = never,
 > {
-	blocks: RichTextBlock[]
+	blocks: readonly RichTextBlock[]
 	referenceRenderers?: Record<string, ReferenceRenderer<any, CustomElements, CustomLeaves>>
 	sourceField?: string
 	referencesField?: string
@@ -60,9 +60,9 @@ export const RichTextRenderer = memo(function RichTextRenderer<
 					content: sourceProps.source
 						? deserialize(sourceProps.source)
 						: {
-								formatVersion: 0,
-								children: [],
-						  },
+							formatVersion: 0,
+							children: [],
+						},
 					id: undefined,
 					referencesField: undefined,
 					referenceDiscriminationField: undefined,
@@ -80,10 +80,10 @@ export const RichTextRenderer = memo(function RichTextRenderer<
 				if (!(sourceField in block)) {
 					throw new RichTextRendererError(
 						`Found a block without a '${sourceField}' field. ` +
-							(sourceProps.sourceField === undefined
-								? `The 'sourceField' prop has not been supplied, and so '${sourceField}' was used as a default.`
-								: `That is what the 'sourceField' prop has been set to, and so either this is a typo, ` +
-								  `or the data supplied is invalid.`),
+						(sourceProps.sourceField === undefined
+							? `The 'sourceField' prop has not been supplied, and so '${sourceField}' was used as a default.`
+							: `That is what the 'sourceField' prop has been set to, and so either this is a typo, ` +
+							`or the data supplied is invalid.`),
 					)
 				}
 				const source = block[sourceField]
@@ -94,8 +94,8 @@ export const RichTextRenderer = memo(function RichTextRenderer<
 				if (sourceProps.referencesField !== undefined && !(referencesField in block)) {
 					throw new RichTextRendererError(
 						`The 'referencesField' prop is set to '${referencesField}' but a block without such field ` +
-							`has been encountered. Unless this is just a typo, ` +
-							`if you do not wish to use references, avoid supplying the 'referencesField' prop.`,
+						`has been encountered. Unless this is just a typo, ` +
+						`if you do not wish to use references, avoid supplying the 'referencesField' prop.`,
 					)
 				}
 				const references = block[referencesField]
@@ -114,11 +114,11 @@ export const RichTextRenderer = memo(function RichTextRenderer<
 						if (!(referenceDiscriminationField in reference)) {
 							throw new RichTextRendererError(
 								`Found a reference without a '${referenceDiscriminationField}' field. ` +
-									(sourceProps.referenceDiscriminationField === undefined
-										? `The 'referenceDiscriminationField' prop has not been supplied, ` +
-										  `and so '${referenceDiscriminationField}' was used as a default.`
-										: `That is what the 'referenceDiscriminationField' prop has been set to, ` +
-										  `and so either this is a typo, or the data supplied is invalid.`),
+								(sourceProps.referenceDiscriminationField === undefined
+									? `The 'referenceDiscriminationField' prop has not been supplied, ` +
+									`and so '${referenceDiscriminationField}' was used as a default.`
+									: `That is what the 'referenceDiscriminationField' prop has been set to, ` +
+									`and so either this is a typo, or the data supplied is invalid.`),
 							)
 						}
 						normalizedReferences.set(reference.id, reference)
@@ -152,12 +152,12 @@ export const RichTextRenderer = memo(function RichTextRenderer<
 				>
 					{createElement(
 						renderBlock, {
-							block,
-						}, renderChildren(block.content.children, {
-							renderLeaf,
-							renderElement,
-							attributeNamePrefix,
-						}),
+						block,
+					}, renderChildren(block.content.children, {
+						renderLeaf,
+						renderElement,
+						attributeNamePrefix,
+					}),
 					)}
 				</RichTextRenderMetadataContext.Provider>
 			))}