feat: allow nullish field in asHTML and asText

src/asHTML.ts

@@ -120,22 +120,26 @@ const wrapMapSerializerWithStringChildren = (
  * @see Templating rich text and title fields from Prismic {@link https://prismic.io/docs/technologies/templating-rich-text-and-title-fields-javascript}
  */
 export const asHTML = (
-	richTextField: RichTextField,
+	richTextField: RichTextField | null | undefined,
 	linkResolver?: LinkResolverFunction<string> | null,
 	htmlSerializer?: HTMLFunctionSerializer | HTMLMapSerializer | null,
-): string => {
-	let serializer: RichTextFunctionSerializer<string>;
-	if (htmlSerializer) {
-		serializer = composeSerializers(
-			typeof htmlSerializer === "object"
-				? wrapMapSerializerWithStringChildren(htmlSerializer)
-				: (type, node, text, children, key) =>
-						htmlSerializer(type, node, text, children.join(""), key),
-			createDefaultHTMLSerializer(linkResolver),
-		);
+): string | null => {
+	if (richTextField) {
+		let serializer: RichTextFunctionSerializer<string>;
+		if (htmlSerializer) {
+			serializer = composeSerializers(
+				typeof htmlSerializer === "object"
+					? wrapMapSerializerWithStringChildren(htmlSerializer)
+					: (type, node, text, children, key) =>
+							htmlSerializer(type, node, text, children.join(""), key),
+				createDefaultHTMLSerializer(linkResolver),
+			);
+		} else {
+			serializer = createDefaultHTMLSerializer(linkResolver);
+		}
+
+		return serialize(richTextField, serializer).join("");
 	} else {
-		serializer = createDefaultHTMLSerializer(linkResolver);
+		return null;
 	}
-
-	return serialize(richTextField, serializer).join("");
 };

src/asText.ts

@@ -0,0 +1,22 @@
+import { asText as baseAsText } from "@prismicio/richtext";
+import { RichTextField } from "@prismicio/types";
+
+/**
+ * Serializes a rich text or title field to a plain text string
+ *
+ * @param richTextField - A rich text or title field from Prismic
+ * @param separator - Separator used to join each element, defaults to a space
+ *
+ * @returns Plain text equivalent of the provided rich text or title field
+ * @see Templating rich text and title fields from Prismic {@link https://prismic.io/docs/technologies/templating-rich-text-and-title-fields-javascript}
+ */
+export const asText = (
+	richTextField: RichTextField | null | undefined,
+	separator?: string,
+): string | null => {
+	if (richTextField) {
+		return baseAsText(richTextField, separator);
+	} else {
+		return null;
+	}
+};

src/index.ts

@@ -1,6 +1,6 @@
 export { asDate } from "./asDate";
 export { asLink } from "./asLink";
-export { asText } from "@prismicio/richtext";
+export { asText } from "./asText";
 export { asHTML } from "./asHTML";
 
 export { documentToLinkField } from "./documentToLinkField";

test/asHTML.test.ts

@@ -22,3 +22,8 @@ test("serializes with a custom map serializer", (t) => {
 test("escapes external links to prevent XSS", (t) => {
 	t.snapshot(asHTML(richTextFixture.xss, linkResolver));
 });
+
+test("returns null for nullish inputs", (t) => {
+	t.is(asHTML(null), null);
+	t.is(asHTML(undefined), null);
+});

test/asText.test.ts

@@ -1,8 +1,18 @@
 import test from "ava";
 import * as prismicR from "@prismicio/richtext";
 
+import { richTextFixture } from "./__fixtures__/richText";
+
 import * as prismicH from "../src";
 
-test("is an alias for @prismicio/richtext's `asText` function", (t) => {
-	t.is(prismicH.asText, prismicR.asText);
+test("is an alias for @prismicio/richtext's `asText` function for non-nullish inputs", (t) => {
+	t.is(
+		prismicH.asText(richTextFixture.en),
+		prismicR.asText(richTextFixture.en),
+	);
+});
+
+test("returns null for nullish inputs", (t) => {
+	t.is(prismicH.asText(null), null);
+	t.is(prismicH.asText(undefined), null);
 });