refactor!: rename config htmlRichTextSerializer to serializer

src/helpers/asHTML.ts

@@ -213,7 +213,7 @@ type AsHTMLConfig = {
  /**
  * An optional Rich Text Serializer, unhandled cases will fallback to the default serializer
  */
- htmlRichTextSerializer?: HTMLRichTextSerializer | null;
+ serializer?: HTMLRichTextSerializer | null;
 };
 
 // TODO: Remove when we remove support for deprecated tuple-style configuration.
@@ -222,7 +222,7 @@ type AsHTMLConfig = {
  */
 type AsHTMLDeprecatedTupleConfig = [
  linkResolver?: LinkResolverFunction | null,
- htmlRichTextSerializer?: HTMLRichTextSerializer | null,
+ serializer?: HTMLRichTextSerializer | null,
 ];
 
 /**
@@ -253,7 +253,7 @@ export const asHTML: {
  * @param richTextField - A Rich Text or Title field from Prismic
  * @param linkResolver - An optional link resolver function to resolve links,
  * without it you're expected to use the `routes` options from the API
- * @param htmlRichTextSerializer - An optional Rich Text Serializer, unhandled cases will fallback
+ * @param serializer - An optional Rich Text Serializer, unhandled cases will fallback
  * to the default serializer
  *
  * @returns HTML equivalent of the provided Rich Text or Title field
@@ -264,8 +264,8 @@ export const asHTML: {
  * ```ts
  * asHTML(field);
  * asHTML(field, { linkResolver });
- * asHTML(field, { htmlRichTextSerializer });
- * asHTML(field, { linkResolver, htmlRichTextSerializer });
+ * asHTML(field, { serializer });
+ * asHTML(field, { linkResolver, serializer });
  * ```
  */
  <Field extends RichTextField | null | undefined>(
@@ -279,29 +279,28 @@ export const asHTML: {
 ): AsHTMLReturnType<Field> => {
  if (richTextField) {
  // TODO: Remove when we remove support for deprecated tuple-style configuration.
- const [configObjectOrLinkResolver, maybeHTMLRichTextSerializer] =
- configObjectOrTuple;
+ const [configObjectOrLinkResolver, maybeSerializer] = configObjectOrTuple;
  let config: AsHTMLConfig;
  if (
  typeof configObjectOrLinkResolver === "function" ||
  configObjectOrLinkResolver == null
  ) {
  config = {
  linkResolver: configObjectOrLinkResolver,
- htmlRichTextSerializer: maybeHTMLRichTextSerializer,
+ serializer: maybeSerializer,
  };
  } else {
  config = { ...configObjectOrLinkResolver };
  }
 
  let serializer: RichTextFunctionSerializer<string>;
- if (config.htmlRichTextSerializer) {
+ if (config.serializer) {
  serializer = composeSerializers(
- typeof config.htmlRichTextSerializer === "object"
- ? wrapMapSerializerWithStringChildren(config.htmlRichTextSerializer)
+ typeof config.serializer === "object"
+ ? wrapMapSerializerWithStringChildren(config.serializer)
  : (type, node, text, children, key) =>
  // TypeScript doesn't narrow the type correctly here since it is now in a callback function, so we have to cast it here.
- (config.htmlRichTextSerializer as HTMLRichTextFunctionSerializer)(
+ (config.serializer as HTMLRichTextFunctionSerializer)(
  type,
  node,
  text,

test/helpers-asHTML.test.ts

@@ -20,7 +20,7 @@ it("serializes with a custom function serializer", () => {
  expect(
  asHTML(richTextFixture.en, {
  linkResolver,
- htmlRichTextSerializer: htmlRichTextFunctionSerializer,
+ serializer: htmlRichTextFunctionSerializer,
  }),
  ).toMatchSnapshot();
 
@@ -30,7 +30,7 @@ it("serializes with a custom function serializer", () => {
  ).toBe(
  asHTML(richTextFixture.en, {
  linkResolver,
- htmlRichTextSerializer: htmlRichTextFunctionSerializer,
+ serializer: htmlRichTextFunctionSerializer,
  }),
  );
 });
@@ -39,7 +39,7 @@ it("serializes with a custom map serializer", () => {
  expect(
  asHTML(richTextFixture.en, {
  linkResolver,
- htmlRichTextSerializer: htmlRichTextMapSerializer,
+ serializer: htmlRichTextMapSerializer,
  }),
  ).toMatchSnapshot();
 
@@ -49,7 +49,7 @@ it("serializes with a custom map serializer", () => {
  ).toBe(
  asHTML(richTextFixture.en, {
  linkResolver,
- htmlRichTextSerializer: htmlRichTextMapSerializer,
+ serializer: htmlRichTextMapSerializer,
  }),
  );
 });