@prismicio/vue 4.3.0 → 4.3.1

package/src/components/PrismicLink.ts

@@ -1,10 +1,10 @@
-import {
+import type {
 	LinkField,
 	LinkResolverFunction,
 	PrismicDocument,
-	asLink,
-} from "@prismicio/client";
-import {
+} from "@prismicio/client"
+import { asLink } from "@prismicio/client"
+import type {
 	AllowedComponentProps,
 	ComponentCustomProps,
 	ComputedRef,
@@ -13,35 +13,31 @@ import {
 	PropType,
 	Raw,
 	VNodeProps,
-	computed,
-	defineComponent,
-	h,
-	reactive,
-	unref,
-} from "vue";
+} from "vue"
+import { computed, defineComponent, h, reactive, unref } from "vue"
 
-import { getSlots } from "../lib/getSlots";
-import { isInternalURL } from "../lib/isInternalURL";
-import { simplyResolveComponent } from "../lib/simplyResolveComponent";
+import { getSlots } from "../lib/getSlots"
+import { isInternalURL } from "../lib/isInternalURL"
+import { simplyResolveComponent } from "../lib/simplyResolveComponent"
 
-import { VueUseOptions } from "../types";
+import type { VueUseOptions } from "../types"
 
-import { usePrismic } from "../usePrismic";
+import { usePrismic } from "../usePrismic"
 
 /**
  * The default component rendered for internal URLs.
  */
-const defaultInternalComponent = "router-link";
+const defaultInternalComponent = "router-link"
 
 /**
  * The default component rendered for external URLs.
  */
-const defaultExternalComponent = "a";
+const defaultExternalComponent = "a"
 
 /**
  * The default rel attribute rendered for blank target URLs.
  */
-const defaultBlankTargetRelAttribute = "noopener noreferrer";
+const defaultBlankTargetRelAttribute = "noopener noreferrer"
 
 /**
  * Props for `<PrismicLink />`.
@@ -50,7 +46,7 @@ export type PrismicLinkProps = {
 	/**
 	 * The Prismic link field or document to render.
 	 */
-	field: LinkField | PrismicDocument;
+	field: LinkField | PrismicDocument
 
 	/**
 	 * A link resolver function used to resolve links when not using the route
@@ -60,17 +56,17 @@ export type PrismicLinkProps = {
 	 *
 	 * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
 	 */
-	linkResolver?: LinkResolverFunction;
+	linkResolver?: LinkResolverFunction
 
 	/**
 	 * An explicit `target` attribute to apply to the rendered link.
 	 */
-	target?: string | null;
+	target?: string | null
 
 	/**
 	 * An explicit `rel` attribute to apply to the rendered link.
 	 */
-	rel?: string | null;
+	rel?: string | null
 
 	/**
 	 * Value of the `rel` attribute to use on links rendered with
@@ -78,7 +74,7 @@ export type PrismicLinkProps = {
 	 *
 	 * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"noopener noreferrer"` otherwise.
 	 */
-	blankTargetRelAttribute?: string | null;
+	blankTargetRelAttribute?: string | null
 
 	/**
 	 * An HTML tag name, a component, or a functional component used to render
@@ -90,9 +86,10 @@ export type PrismicLinkProps = {
 	 * @remarks
 	 * Components will be rendered using Vue Router {@link RouterLink} interface
 	 * (`to` props).
+	 *
 	 * @defaultValue The one provided to `@prismicio/vue` plugin if configured, {@link RouterLink} otherwise.
 	 */
-	internalComponent?: string | ConcreteComponent | Raw<DefineComponent>;
+	internalComponent?: string | ConcreteComponent | Raw<DefineComponent>
 
 	/**
 	 * An HTML tag name, a component, or a functional component used to render
@@ -104,15 +101,16 @@ export type PrismicLinkProps = {
 	 * @remarks
 	 * Components will be rendered using Vue Router {@link RouterLink} interface
 	 * (`to` props).
+	 *
 	 * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"a"` otherwise.
 	 */
-	externalComponent?: string | ConcreteComponent | Raw<DefineComponent>;
-};
+	externalComponent?: string | ConcreteComponent | Raw<DefineComponent>
+}
 
 /**
  * Options for {@link usePrismicLink}.
  */
-export type UsePrismicLinkOptions = VueUseOptions<PrismicLinkProps>;
+export type UsePrismicLinkOptions = VueUseOptions<PrismicLinkProps>
 
 /**
  * Return type of {@link usePrismicLink}.
@@ -121,28 +119,28 @@ export type UsePrismicLinkReturnType = {
 	/**
 	 * Suggested component to render for provided link field.
 	 */
-	type: ComputedRef<string | ConcreteComponent | Raw<DefineComponent>>;
+	type: ComputedRef<string | ConcreteComponent | Raw<DefineComponent>>
 
 	/**
 	 * Resolved anchor `href` value.
 	 */
-	href: ComputedRef<string>;
+	href: ComputedRef<string>
 
 	/**
 	 * Resolved anchor `target` value.
 	 */
-	target: ComputedRef<string | null>;
+	target: ComputedRef<string | null>
 
 	/**
 	 * Resolved anchor `rel` value.
 	 */
-	rel: ComputedRef<string | null>;
+	rel: ComputedRef<string | null>
 
 	/**
 	 * Resolved link text.
 	 */
-	text: ComputedRef<string | undefined>;
-};
+	text: ComputedRef<string | undefined>
+}
 
 /**
  * A low level composable that returns resolved information about a Prismic link
@@ -155,65 +153,65 @@ export type UsePrismicLinkReturnType = {
 export const usePrismicLink = (
 	props: UsePrismicLinkOptions,
 ): UsePrismicLinkReturnType => {
-	const { options } = usePrismic();
+	const { options } = usePrismic()
 
 	const type = computed(() => {
 		const internalComponent =
 			unref(props.internalComponent) ||
 			options.components?.linkInternalComponent ||
-			defaultInternalComponent;
+			defaultInternalComponent
 
 		const externalComponent =
 			unref(props.externalComponent) ||
 			options.components?.linkExternalComponent ||
-			defaultExternalComponent;
+			defaultExternalComponent
 
 		return href.value && isInternalURL(href.value) && !target.value
 			? internalComponent
-			: externalComponent;
-	});
+			: externalComponent
+	})
 	const href = computed(() => {
-		const field = unref(props.field);
-		const linkResolver = unref(props.linkResolver) ?? options.linkResolver;
+		const field = unref(props.field)
+		const linkResolver = unref(props.linkResolver) ?? options.linkResolver
 
-		return asLink(field, linkResolver) ?? "";
-	});
+		return asLink(field, linkResolver) ?? ""
+	})
 	const target = computed(() => {
-		const field = unref(props.field);
-		const target = unref(props.target);
+		const field = unref(props.field)
+		const target = unref(props.target)
 
 		if (typeof target !== "undefined") {
-			return target;
+			return target
 		} else {
-			return field && "target" in field && field.target ? field.target : null;
+			return field && "target" in field && field.target ? field.target : null
 		}
-	});
+	})
 	const rel = computed(() => {
-		const rel = unref(props.rel);
+		const rel = unref(props.rel)
 
 		if (typeof rel !== "undefined") {
-			return rel;
+			return rel
 		} else if (target.value === "_blank") {
-			const blankTargetRelAttribute = unref(props.blankTargetRelAttribute);
+			const blankTargetRelAttribute = unref(props.blankTargetRelAttribute)
 
 			if (typeof blankTargetRelAttribute !== "undefined") {
-				return blankTargetRelAttribute;
+				return blankTargetRelAttribute
 			} else {
 				return typeof options.components?.linkBlankTargetRelAttribute !==
 					"undefined"
 					? options.components.linkBlankTargetRelAttribute
-					: defaultBlankTargetRelAttribute;
+					: defaultBlankTargetRelAttribute
 			}
 		} else {
-			return null;
+			return null
 		}
-	});
+	})
 
 	const text = computed(() => {
-		const field = unref(props.field);
+		const field = unref(props.field)
 
-		return field && "text" in field ? field.text : undefined;
-	});
+		return field && "text" in field ? field.text : undefined
+	})
 
 	return {
 		type,
@@ -221,8 +219,8 @@ export const usePrismicLink = (
 		target,
 		rel,
 		text,
-	};
-};
+	}
+}
 
 /**
  * `<PrismicLink />` implementation.
@@ -274,20 +272,20 @@ export const PrismicLinkImpl = /*#__PURE__*/ defineComponent({
 	setup(props, { slots }) {
 		// Prevent fatal if user didn't check for field, throws `Invalid prop` warn
 		if (!props.field) {
-			return () => null;
+			return () => null
 		}
 
-		const { type, href, target, rel, text } = usePrismicLink(props);
+		const { type, href, target, rel, text } = usePrismicLink(props)
 
 		return () => {
 			const parent =
-				type.value === "a" ? "a" : simplyResolveComponent(type.value);
+				type.value === "a" ? "a" : simplyResolveComponent(type.value)
 			const computedSlots = getSlots(
 				parent,
 				slots,
 				reactive({ href: href.value, text: text.value }),
 				text.value,
-			);
+			)
 
 			if (typeof parent === "string") {
 				// Fitting anchor tag interface
@@ -295,18 +293,18 @@ export const PrismicLinkImpl = /*#__PURE__*/ defineComponent({
 					parent,
 					{ href: href.value, target: target.value, rel: rel.value },
 					computedSlots,
-				);
+				)
 			} else {
 				// Fitting Vue Router Link interface
 				return h(
 					parent,
 					{ to: href.value, target: target.value, rel: rel.value },
 					computedSlots,
-				);
+				)
 			}
-		};
+		}
 	},
-});
+})
 
 // export the public type for h/tsx inference
 // also to avoid inline import() in generated d.ts files
@@ -321,6 +319,6 @@ export const PrismicLink = PrismicLinkImpl as unknown as {
 		$props: AllowedComponentProps &
 			ComponentCustomProps &
 			VNodeProps &
-			PrismicLinkProps;
-	};
-};
+			PrismicLinkProps
+	}
+}

package/src/components/PrismicRichText.ts

@@ -1,12 +1,11 @@
-import {
+import type {
 	HTMLFunctionSerializer,
 	HTMLMapSerializer,
 	LinkResolverFunction,
 	RichTextField,
-	asHTML,
-	isFilled,
-} from "@prismicio/client";
-import {
+} from "@prismicio/client"
+import { asHTML, isFilled } from "@prismicio/client"
+import type {
 	AllowedComponentProps,
 	Component,
 	ComponentCustomProps,
@@ -16,6 +15,8 @@ import {
 	PropType,
 	Raw,
 	VNodeProps,
+} from "vue"
+import {
 	computed,
 	defineComponent,
 	h,
@@ -25,20 +26,20 @@ import {
 	ref,
 	unref,
 	watch,
-} from "vue";
-import { routerKey } from "vue-router";
+} from "vue"
+import { routerKey } from "vue-router"
 
-import { isInternalURL } from "../lib/isInternalURL";
-import { simplyResolveComponent } from "../lib/simplyResolveComponent";
+import { isInternalURL } from "../lib/isInternalURL"
+import { simplyResolveComponent } from "../lib/simplyResolveComponent"
 
-import { VueUseOptions } from "../types";
+import type { VueUseOptions } from "../types"
 
-import { usePrismic } from "../usePrismic";
+import { usePrismic } from "../usePrismic"
 
 /**
  * The default component rendered to wrap the HTML output.
  */
-const defaultWrapper = "div";
+const defaultWrapper = "div"
 
 /**
  * Props for `<PrismicRichText />`.
@@ -47,7 +48,7 @@ export type PrismicRichTextProps = {
 	/**
 	 * The Prismic rich text or title field to render.
 	 */
-	field: RichTextField | null | undefined;
+	field: RichTextField | null | undefined
 
 	/**
 	 * A link resolver function used to resolve link when not using the route
@@ -57,7 +58,7 @@ export type PrismicRichTextProps = {
 	 *
 	 * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
 	 */
-	linkResolver?: LinkResolverFunction;
+	linkResolver?: LinkResolverFunction
 
 	/**
 	 * An HTML serializer to customize the way rich text fields are rendered.
@@ -66,7 +67,7 @@ export type PrismicRichTextProps = {
 	 *
 	 * @see HTML serializer documentation {@link https://prismic.io/docs/core-concepts/html-serializer}
 	 */
-	serializer?: HTMLFunctionSerializer | HTMLMapSerializer;
+	serializer?: HTMLFunctionSerializer | HTMLMapSerializer
 
 	/**
 	 * An HTML serializer to customize the way rich text fields are rendered.
@@ -77,7 +78,7 @@ export type PrismicRichTextProps = {
 	 *
 	 * @see HTML serializer documentation {@link https://prismic.io/docs/core-concepts/html-serializer}
 	 */
-	htmlSerializer?: HTMLFunctionSerializer | HTMLMapSerializer;
+	htmlSerializer?: HTMLFunctionSerializer | HTMLMapSerializer
 
 	/**
 	 * An HTML tag name, a component, or a functional component used to wrap the
@@ -85,21 +86,21 @@ export type PrismicRichTextProps = {
 	 *
 	 * @defaultValue `"div"`
 	 */
-	wrapper?: string | ConcreteComponent | Raw<DefineComponent>;
+	wrapper?: string | ConcreteComponent | Raw<DefineComponent>
 
 	/**
 	 * The HTML value to be rendered when the field is empty. If a fallback is not
 	 * given, `""` (nothing) will be rendered.
 	 */
-	fallback?: string;
-};
+	fallback?: string
+}
 
 /**
  * Options for {@link usePrismicRichText}.
  */
 export type UsePrismicRichTextOptions = VueUseOptions<
 	Omit<PrismicRichTextProps, "wrapper">
->;
+>
 
 /**
  * Return type of {@link usePrismicRichText}.
@@ -108,8 +109,8 @@ export type UsePrismicRichTextReturnType = {
 	/**
 	 * Serialized rich text field as HTML.
 	 */
-	html: ComputedRef<string>;
-};
+	html: ComputedRef<string>
+}
 
 /**
  * A low level composable that returns a serialized rich text field as HTML.
@@ -122,29 +123,29 @@ export type UsePrismicRichTextReturnType = {
 export const usePrismicRichText = (
 	props: UsePrismicRichTextOptions,
 ): UsePrismicRichTextReturnType => {
-	const { options } = usePrismic();
+	const { options } = usePrismic()
 
 	const html = computed(() => {
-		const field = unref(props.field);
+		const field = unref(props.field)
 
 		if (!isFilled.richText(field)) {
-			return unref(props.fallback) ?? "";
+			return unref(props.fallback) ?? ""
 		}
 
-		const linkResolver = unref(props.linkResolver) ?? options.linkResolver;
+		const linkResolver = unref(props.linkResolver) ?? options.linkResolver
 		const serializer =
 			unref(props.serializer) ??
 			unref(props.htmlSerializer) ??
 			options.richTextSerializer ??
-			options.htmlSerializer;
+			options.htmlSerializer
 
-		return asHTML(unref(field), linkResolver, serializer);
-	});
+		return asHTML(unref(field), linkResolver, serializer)
+	})
 
 	return {
 		html,
-	};
-};
+	}
+}
 
 /**
  * `<PrismicRichText />` implementation.
@@ -192,77 +193,77 @@ export const PrismicRichTextImpl = /*#__PURE__*/ defineComponent({
 		},
 	},
 	setup(props) {
-		const { html } = usePrismicRichText(props);
+		const { html } = usePrismicRichText(props)
 
-		const root = ref<HTMLElement | Comment | Component | null>(null);
+		const root = ref<HTMLElement | Comment | Component | null>(null)
 
-		const maybeRouter = inject(routerKey, null);
+		const maybeRouter = inject(routerKey, null)
 		if (maybeRouter) {
 			type InternalLink = {
-				element: HTMLAnchorElement;
-				listener: EventListener;
-			};
-			let links: InternalLink[] = [];
+				element: HTMLAnchorElement
+				listener: EventListener
+			}
+			let links: InternalLink[] = []
 
 			const navigate: EventListener = function (
 				this: { href: string },
 				event: Event,
 			) {
-				event.preventDefault();
-				maybeRouter.push(this.href);
-			};
+				event.preventDefault()
+				maybeRouter.push(this.href)
+			}
 
 			const addListeners = () => {
 				const node: HTMLElement | Comment | null =
-					root.value && "$el" in root.value ? root.value.$el : root.value;
+					root.value && "$el" in root.value ? root.value.$el : root.value
 				if (node && "querySelectorAll" in node) {
 					// Get all internal link tags and add listeners on them
 					links = Array.from(node.querySelectorAll("a"))
 						.map((element) => {
-							const href = element.getAttribute("href");
+							const href = element.getAttribute("href")
 
 							if (href && isInternalURL(href)) {
-								const listener = navigate.bind({ href });
-								element.addEventListener("click", listener);
+								const listener = navigate.bind({ href })
+								element.addEventListener("click", listener)
 
-								return { element, listener };
+								return { element, listener }
 							} else {
-								return false;
+								return false
 							}
 						})
-						.filter((link): link is InternalLink => link as boolean);
+						.filter((link): link is InternalLink => link as boolean)
 				}
-			};
+			}
 
 			const removeListeners = () => {
 				links.forEach(({ element, listener }) =>
 					element.removeEventListener("click", listener),
-				);
-				links = [];
-			};
+				)
+				links = []
+			}
 
 			watch(
 				html,
 				() => {
-					removeListeners();
-					nextTick(addListeners);
+					removeListeners()
+					nextTick(addListeners)
 				},
 				{ immediate: true },
-			);
+			)
 
 			onBeforeUnmount(() => {
-				removeListeners();
-			});
+				removeListeners()
+			})
 		}
 
 		return () => {
 			return h(simplyResolveComponent(props.wrapper || defaultWrapper), {
 				innerHTML: html.value,
 				ref: root,
-			});
-		};
+			})
+		}
 	},
-});
+})
 
 // export the public type for h/tsx inference
 // also to avoid inline import() in generated d.ts files
@@ -277,6 +278,6 @@ export const PrismicRichText = PrismicRichTextImpl as unknown as {
 		$props: AllowedComponentProps &
 			ComponentCustomProps &
 			VNodeProps &
-			PrismicRichTextProps;
-	};
-};
+			PrismicRichTextProps
+	}
+}