@prismicio/next 0.1.0 → 0.2.0-alpha.0

package/src/PrismicPreview.tsx

@@ -1,14 +1,15 @@
-import React, { useEffect } from "react";
+import * as React from "react";
+import * as prismic from "@prismicio/client";
 import { PrismicToolbar } from "@prismicio/react";
 import { useRouter } from "next/router";
 
-import { getCookie } from "../lib/getCookie";
-import { extractPreviewRefRepositoryName } from "../lib/extractPreviewRefRepositoryName";
+import { getCookie } from "./lib/getCookie";
+import { extractPreviewRefRepositoryName } from "./lib/extractPreviewRefRepositoryName";
 
 /**
  * Props for `<PrismicPreview>`.
  */
-type PrismicPreviewProps = {
+export type PrismicPreviewProps = {
 	/**
 	 * The name of your Prismic repository. A Prismic Toolbar will be registered
 	 * using this repository.
@@ -18,31 +19,65 @@ type PrismicPreviewProps = {
 	/**
 	 * The URL of your app's Prismic preview endpoint (default: `/api/preview`).
 	 * This URL will be fetched on preview update events.
+	 *
+	 * **Note**: If your `next.config.js` file contains a `basePath`, it is
+	 * automatically included.
 	 */
 	updatePreviewURL?: string;
 
 	/**
 	 * The URL of your app's exit preview endpoint (default: `/api/exit-preview`).
 	 * This URL will be fetched on preview exit events.
+	 *
+	 * **Note**: If your `next.config.js` file contains a `basePath`, it is
+	 * automatically included.
 	 */
 	exitPreviewURL?: string;
 
+	/**
+	 * Children to render adjacent to the Prismic Toolbar. The Prismic Toolbar
+	 * will be rendered last.
+	 */
 	children?: React.ReactNode;
 };
 
 /**
- * Determines if an Event object came from the Prismic Toolbar.
+ * Updates (or starts) Next.js Preview Mode using a given API endpoint and
+ * reloads the page.
  *
- * @param event - Event to check.
+ * @param updatePreviewURL - The API endpoint that sets Preview Mode data.
+ */
+const updatePreviewMode = async (updatePreviewURL: string): Promise<void> => {
+	// Start Next.js Preview Mode via the given preview API endpoint.
+	const res = await globalThis.fetch(updatePreviewURL);
+
+	if (res.ok) {
+		// Reload the page with an active Preview Mode.
+		window.location.reload();
+	} else {
+		console.error(
+			`[<PrismicPreview>] Failed to start or update Preview Mode using the "${updatePreviewURL}" API endpoint. Does it exist?`,
+		);
+	}
+};
+
+/**
+ * Exits Next.js Preview Mode using a given API endpoint and reloads the page.
  *
- * @returns `true` if `event` came from the Prismic Toolbar, `false` otherwise.
+ * @param exitPreviewURL - The API endpoint that exits Preview Mode.
  */
-const isPrismicUpdateToolbarEvent = (
-	event: Event,
-): event is CustomEvent<{ ref: string }> => {
-	return (
-		"detail" in event && typeof (event as CustomEvent).detail.ref === "string"
-	);
+const exitPreviewMode = async (exitPreviewURL: string): Promise<void> => {
+	// Exit Next.js Preview Mode via the given exit preview API endpoint.
+	const res = await globalThis.fetch(exitPreviewURL);
+
+	if (res.ok) {
+		// Reload the page with an inactive Preview Mode.
+		window.location.reload();
+	} else {
+		console.error(
+			`[<PrismicPreview>] Failed to exit Preview Mode using the "${exitPreviewURL}" API endpoint. Does it exist?`,
+		);
+	}
 };
 
 /**
@@ -56,78 +91,96 @@ const isPrismicUpdateToolbarEvent = (
  */
 export function PrismicPreview({
 	repositoryName,
-	children,
 	updatePreviewURL = "/api/preview",
 	exitPreviewURL = "/api/exit-preview",
+	children,
 }: PrismicPreviewProps): JSX.Element {
 	const router = useRouter();
 
-	useEffect(() => {
-		const previewRefRepositoryName = extractPreviewRefRepositoryName(
-			getCookie("io.prismic.preview", globalThis.document.cookie) as string,
+	const resolvedUpdatePreviewURL = router.basePath + updatePreviewURL;
+	const resolvedExitPreviewURL = router.basePath + exitPreviewURL;
+
+	React.useEffect(() => {
+		/**
+		 * The Prismic preview cookie.
+		 */
+		const previewCookie = getCookie(prismic.cookie.preview);
+
+		/**
+		 * Determines if the current Prismic preview session is for the repository
+		 * configured for this instance of `<PrismicPreview>`.
+		 */
+		const prismicPreviewSessionIsForThisRepo = Boolean(
+			previewCookie &&
+				extractPreviewRefRepositoryName(previewCookie) === repositoryName,
 		);
 
-		const startPreviewIfLoadedFromSharedLink = async () => {
-			if (previewRefRepositoryName === repositoryName && !router.isPreview) {
-				await fetch(updatePreviewURL);
-				window.location.reload();
-			}
-		};
+		/**
+		 * Determines if the current location is a descendant of the app's base path.
+		 *
+		 * This is used to prevent infinite refrehes; when `isDescendantOfBasePath`
+		 * is `false`, `router.isPreview` is also `false`.
+		 *
+		 * If the app does not have a base path, this should always be `true`.
+		 */
+		const locationIsDescendantOfBasePath = window.location.href.startsWith(
+			window.location.origin + router.basePath,
+		);
 
-		startPreviewIfLoadedFromSharedLink();
+		/**
+		 * Determines if the current user loaded the page from a share link.
+		 *
+		 * Currently, we can only deduce this by checking if router.isPreview is
+		 * false (i.e. Preview Mode is inactive) and a Prismic preview cookie is present.
+		 */
+		const loadedFromShareLink = !router.isPreview && previewCookie;
+
+		if (
+			prismicPreviewSessionIsForThisRepo &&
+			locationIsDescendantOfBasePath &&
+			loadedFromShareLink
+		) {
+			updatePreviewMode(resolvedUpdatePreviewURL);
+
+			return;
+		}
 
 		const handlePrismicPreviewUpdate = async (event: Event) => {
-			if (isPrismicUpdateToolbarEvent(event)) {
-				// Prevent the toolbar from reloading the page.
-				event.preventDefault();
-
-				// Start Next.js Preview Mode via the given preview API endpoint.
-				await fetch(updatePreviewURL);
-
-				// Reload the page with an active Preview Mode.
-				window.location.reload();
-			}
+			// Prevent the toolbar from reloading the page.
+			event.preventDefault();
+			await updatePreviewMode(resolvedUpdatePreviewURL);
 		};
 
 		const handlePrismicPreviewEnd = async (event: Event) => {
 			// Prevent the toolbar from reloading the page.
 			event.preventDefault();
-
-			// Exit Next.js Preview Mode via the given preview API endpoint.
-			await fetch(exitPreviewURL);
-
-			// Reload the page with an active Preview Mode.
-			window.location.reload();
+			await exitPreviewMode(resolvedExitPreviewURL);
 		};
 
 		// Register Prismic Toolbar event handlers.
-		if (window) {
-			window.addEventListener(
-				"prismicPreviewUpdate",
-				handlePrismicPreviewUpdate,
-			);
-			window.addEventListener("prismicPreviewEnd", handlePrismicPreviewEnd);
-		}
+		window.addEventListener("prismicPreviewUpdate", handlePrismicPreviewUpdate);
+		window.addEventListener("prismicPreviewEnd", handlePrismicPreviewEnd);
 
 		// On cleanup, unregister Prismic Toolbar event handlers.
 		return () => {
-			if (window) {
-				window.removeEventListener(
-					"prismicPreviewUpdate",
-					handlePrismicPreviewUpdate,
-				);
-				window.removeEventListener(
-					"prismicPreviewEnd",
-					handlePrismicPreviewEnd,
-				);
-			}
+			window.removeEventListener(
+				"prismicPreviewUpdate",
+				handlePrismicPreviewUpdate,
+			);
+			window.removeEventListener("prismicPreviewEnd", handlePrismicPreviewEnd);
 		};
-	}, []);
+	}, [
+		repositoryName,
+		resolvedUpdatePreviewURL,
+		resolvedExitPreviewURL,
+		router.isPreview,
+		router.basePath,
+	]);
 
 	return (
 		<>
-			<PrismicToolbar repositoryName={repositoryName} />
 			{children}
+			<PrismicToolbar repositoryName={repositoryName} />
 		</>
 	);
 }

package/src/enableAutoPreviews.ts

@@ -60,19 +60,17 @@ export type EnableAutoPreviewsConfig<
 export const enableAutoPreviews = <TPreviewData extends PreviewData>(
 	config: EnableAutoPreviewsConfig<TPreviewData>,
 ): void => {
-	/**
-	 * If preview data is being passed from Next Context then use queryContentFromRef
-	 */
 	if ("previewData" in config && config.previewData) {
+		// If preview data is being passed from Next Context then use queryContentFromRef
+
 		const { previewData } = config;
 
 		if (isPrismicNextPreviewData(previewData) && previewData.ref) {
 			config.client.queryContentFromRef(previewData.ref);
 		}
-		/**
-		 * If the req object is passed then use enableAutoPreviewsFromReq
-		 */
 	} else if ("req" in config && config.req) {
+		// If the req object is passed then use enableAutoPreviewsFromReq
+
 		config.client.enableAutoPreviewsFromReq(config.req);
 	}
 };

package/src/exitPreview.ts

@@ -1,4 +1,4 @@
-import { NextApiResponse, NextApiRequest } from "next";
+import type { NextApiRequest, NextApiResponse } from "next";
 
 /**
  * Configuration for `exitPreview`.
@@ -10,11 +10,17 @@ export type ExitPreviewConfig = {
 	 *
 	 * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}
 	 */
-	req: {
-		headers: {
-			referer?: NextApiRequest["headers"]["referer"];
-		};
-	};
+	// `req` is no longer used in `exitPreview()`. It previously would
+	// redirect the user to the referring URL, but it no longer has that
+	// behavior.
+	//
+	// `req` is retained as a parameter to make setting up an
+	// exit preview API route easier (this eliminates the awkward need to
+	// handle an unused `req` param).
+	//
+	// It is also retained in case it is needed in the future, such as
+	// reading headers or metadata about the request.
+	req: Pick<NextApiRequest, "headers">;
 
 	/**
 	 * The `res` object from a Next.js API route. This is given as a parameter to
@@ -22,33 +28,15 @@ export type ExitPreviewConfig = {
 	 *
 	 * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}
 	 */
-	res: {
-		clearPreviewData: NextApiResponse["clearPreviewData"];
-		redirect: NextApiResponse["redirect"];
-	};
+	res: Pick<NextApiResponse, "clearPreviewData" | "json">;
 };
 
 /**
  * Exits Next.js's Preview Mode from within a Next.js API route.
- *
- * If the user was sent to the endpoint from a page, the user will be redirected
- * back to that page after exiting Preview Mode.
  */
 export function exitPreview(config: ExitPreviewConfig): void {
-	const { req } = config;
-	// Exit the current user from "Preview Mode". This function accepts no args.
+	// Exit the current user from Preview Mode.
 	config.res.clearPreviewData();
 
-	if (req.headers.referer) {
-		const url = new URL(req.headers.referer);
-
-		if (url.pathname !== "/api/exit-preview") {
-			// Redirect the user to the referrer page.
-			config.res.redirect(req.headers.referer);
-
-			return;
-		}
-	}
-
-	config.res.redirect("/");
+	config.res.json({ success: true });
 }

package/src/index.ts

@@ -1,9 +1,16 @@
-export type { SetPreviewDataConfig } from "./setPreviewData";
-export type { EnableAutoPreviewsConfig } from "./enableAutoPreviews";
-export type { ExitPreviewConfig as ExitPreviewParams } from "./exitPreview";
 export { setPreviewData } from "./setPreviewData";
+export type { SetPreviewDataConfig } from "./setPreviewData";
+
 export { exitPreview } from "./exitPreview";
+export type { ExitPreviewConfig } from "./exitPreview";
+
 export { PrismicPreview } from "./PrismicPreview";
+export type { PrismicPreviewProps } from "./PrismicPreview";
+
 export { enableAutoPreviews } from "./enableAutoPreviews";
+export type { EnableAutoPreviewsConfig } from "./enableAutoPreviews";
+
 export { redirectToPreviewURL } from "./redirectToPreviewURL";
-export type { CreateClientConfig, PreviewConfig } from "./types";
+export type { RedirectToPreviewURLConfig } from "./redirectToPreviewURL";
+
+export type { CreateClientConfig } from "./types";

package/src/lib/extractPreviewRefRepositoryName.ts

@@ -0,0 +1,60 @@
+/**
+ * Returns the repository name from an object-style Prismic ref.
+ *
+ * @param host - Host string
+ */
+const extractFirstSubdomain = (host: string): string => host.split(".")[0];
+
+/**
+ * Parses ref object from cookie and returns proper preview link
+ *
+ * @param previewRef - Prismic Preview reference
+ */
+const extractRepositoryNameFromObjectRef = (
+	previewRef: string,
+): string | undefined => {
+	try {
+		const parsed = JSON.parse(decodeURIComponent(previewRef));
+		const keys = Object.keys(parsed);
+		const domainKey = keys.find((key) => /\.prismic\.io$/.test(key));
+
+		if (domainKey) {
+			return extractFirstSubdomain(domainKey);
+		} else {
+			return undefined;
+		}
+	} catch {
+		return undefined;
+	}
+};
+
+/**
+ * Returns the repository name from a URL-style Prismic ref.
+ *
+ * @param previewRef - Preview ref from getCookie()
+ */
+const extractRepositoryNameFromURLRef = (
+	previewRef: string,
+): string | undefined => {
+	try {
+		const url = new URL(previewRef);
+
+		return extractFirstSubdomain(url.host);
+	} catch {
+		return undefined;
+	}
+};
+
+/**
+ * Extracts preview reference repo name from stringified Prismic preview cookie
+ *
+ * @param previewRef - Preview Reference
+ */
+export const extractPreviewRefRepositoryName = (
+	previewRef: string,
+): string | undefined => {
+	return (
+		extractRepositoryNameFromObjectRef(previewRef) ||
+		extractRepositoryNameFromURLRef(previewRef)
+	);
+};

package/src/lib/getCookie.ts

@@ -0,0 +1,51 @@
+/**
+ * The following code is a modifed version of `es-cookie` taken from
+ * https://github.com/theodorejb/es-cookie
+ *
+ * It only contains a simplified version of `get()`.
+ *
+ * Copyright 2017 Theodore Brown
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.*
+ */
+
+const readValue = (value: string): string => {
+	return value.replace(/%3B/g, ";");
+};
+
+/**
+ * Returns the value of a cookie from a given cookie store.
+ *
+ * @param name - Of the cookie.
+ *
+ * @returns The value of the cookie, if it exists.
+ */
+export const getCookie = (name: string): string | undefined => {
+	const cookies = document.cookie.split("; ");
+
+	for (const cookie of cookies) {
+		const parts = cookie.split("=");
+		const value = parts.slice(1).join("=");
+		const thisName = readValue(parts[0]).replace(/%3D/g, "=");
+
+		if (thisName === name) {
+			return readValue(value);
+		}
+	}
+};

package/src/redirectToPreviewURL.ts

@@ -1,5 +1,6 @@
-import { NextApiRequest } from "next";
-import { PreviewConfig } from "./";
+import type { Client } from "@prismicio/client";
+import type { NextApiRequest, NextApiResponse } from "next";
+import type { LinkResolverFunction } from "@prismicio/helpers";
 
 type PrismicNextQuery = {
 	documentId: string;
@@ -16,33 +17,90 @@ type PrismicNextQuery = {
  */
 const isPrismicNextQuery = (
 	query: NextApiRequest["query"],
-): query is PrismicNextQuery =>
-	typeof query.documentId === "string" && typeof query.token === "string";
+): query is PrismicNextQuery => {
+	return (
+		typeof query.documentId === "string" && typeof query.token === "string"
+	);
+};
+
+/**
+ * Preview config for enabling previews with redirectToPreviewURL
+ */
+export type RedirectToPreviewURLConfig<
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	TLinkResolverFunction extends LinkResolverFunction<any> = LinkResolverFunction,
+> = {
+	/**
+	 * The `req` object from a Next.js API route. This is given as a parameter to
+	 * the API route.
+	 *
+	 * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}
+	 */
+	req: Pick<NextApiRequest, "query">;
+
+	/**
+	 * The `res` object from a Next.js API route. This is given as a parameter to
+	 * the API route.
+	 *
+	 * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}
+	 */
+	res: Pick<NextApiResponse, "redirect">;
+
+	/**
+	 * The Prismic client configured for the preview session's repository.
+	 */
+	client: Client;
+
+	/**
+	 * A Link Resolver used to resolve the previewed document's URL.
+	 *
+	 * @see To learn more about Link Resolver: {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver}
+	 */
+	linkResolver?: TLinkResolverFunction;
+
+	/**
+	 * The default redirect URL if a URL cannot be determined for the previewed document.
+	 *
+	 * **Note**: If your `next.config.js` file contains a `basePath`, you must
+	 * include the `basePath` as part of this option. `redirectToPreviewURL()`
+	 * cannot read your global `basePath`.
+	 */
+	defaultURL?: string;
+
+	/**
+	 * The `basePath` for the Next.js app as it is defined in `next.config.js`.
+	 * This option can be omitted if the app does not have a `basePath`.
+	 *
+	 * @remarks
+	 * The API route is unable to detect the app's `basePath` automatically. It
+	 * must be provided to `redirectToPreviewURL()` manually.
+	 */
+	basePath?: string;
+};
 
 /**
  * Redirects a user to the URL of a previewed Prismic document from within a
  * Next.js API route.
  */
-export async function redirectToPreviewURL({
-	req,
-	res,
-	client,
-	linkResolver,
-	defaultURL = "/",
-}: PreviewConfig): Promise<void> {
-	if (isPrismicNextQuery(req.query)) {
-		const { documentId, token } = req.query;
-		const previewUrl = await client.resolvePreviewURL({
-			linkResolver,
+export async function redirectToPreviewURL<
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	TLinkResolverFunction extends LinkResolverFunction<any>,
+>(config: RedirectToPreviewURLConfig<TLinkResolverFunction>): Promise<void> {
+	const defaultURL = config.defaultURL || "/";
+	const basePath = config.basePath || "";
+
+	if (isPrismicNextQuery(config.req.query)) {
+		const previewUrl = await config.client.resolvePreviewURL({
+			linkResolver: config.linkResolver,
 			defaultURL,
-			documentID: documentId,
-			previewToken: token,
+			documentID: config.req.query.documentId,
+			previewToken: config.req.query.token,
 		});
 
-		res.redirect(previewUrl);
+		config.res.redirect(basePath + previewUrl);
 
 		return;
 	}
 
-	res.redirect(defaultURL);
+	config.res.redirect(basePath + defaultURL);
 }

package/src/setPreviewData.ts

@@ -11,10 +11,7 @@ export type SetPreviewDataConfig = {
 	 *
 	 * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}
 	 */
-	req: {
-		query: NextApiRequest["query"];
-		cookies: NextApiRequest["cookies"];
-	};
+	req: Pick<NextApiRequest, "query" | "cookies">;
 
 	/**
 	 * The `res` object from a Next.js API route. This is given as a parameter to
@@ -22,18 +19,13 @@ export type SetPreviewDataConfig = {
 	 *
 	 * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}
 	 */
-	res: {
-		setPreviewData: NextApiResponse["setPreviewData"];
-	};
+	res: Pick<NextApiResponse, "setPreviewData">;
 };
 
 /**
  * Set Prismic preview data for Next.js's Preview Mode.
  */
-export async function setPreviewData({
-	req,
-	res,
-}: SetPreviewDataConfig): Promise<void> {
+export function setPreviewData({ req, res }: SetPreviewDataConfig): void {
 	const ref = req.query.token || req.cookies[prismic.cookie.preview];
 
 	if (ref) {

package/src/types.ts

@@ -1,6 +1,4 @@
-import { PreviewData, NextApiRequest, NextApiResponse } from "next";
-import { LinkResolverFunction } from "@prismicio/helpers";
-import { Client } from "@prismicio/client";
+import { PreviewData, NextApiRequest } from "next";
 
 /**
  * Configuration for creating a Prismic client with automatic preview support in
@@ -22,45 +20,3 @@ export type CreateClientConfig = {
 	 */
 	req?: NextApiRequest;
 };
-
-/**
- * Preview config for enabling previews with redirectToPreviewURL
- */
-export type PreviewConfig = {
-	/**
-	 * The `req` object from a Next.js API route. This is given as a parameter to
-	 * the API route.
-	 *
-	 * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}
-	 */
-	req: {
-		query: NextApiRequest["query"];
-	};
-
-	/**
-	 * The `res` object from a Next.js API route. This is given as a parameter to
-	 * the API route.
-	 *
-	 * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}
-	 */
-	res: {
-		redirect: NextApiResponse["redirect"];
-	};
-
-	/**
-	 * The Prismic client configured for the preview session's repository.
-	 */
-	client: Client;
-
-	/**
-	 * A Link Resolver used to resolve the previewed document's URL.
-	 *
-	 * @see To learn more about Link Resolver: {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver}
-	 */
-	linkResolver?: LinkResolverFunction;
-
-	/**
-	 * The default redirect URL if a URL cannot be determined for the previewed document.
-	 */
-	defaultURL?: string;
-};