@prismicio/next 0.0.1

package/dist/index.cjs

@@ -0,0 +1,112 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const React = require('react');
+const react = require('@prismicio/react');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+const React__default = /*#__PURE__*/_interopDefaultLegacy(React);
+
+async function setPreviewData({
+  req,
+  res
+}) {
+  if (req.query.token) {
+    const { token: ref } = req.query;
+    res.setPreviewData({ ref });
+  }
+}
+
+function exitPreview(config) {
+  const { req } = config;
+  config.res.clearPreviewData();
+  if (req.headers.referer) {
+    const url = new URL(req.headers.referer);
+    if (url.pathname !== "/api/exit-preview") {
+      config.res.redirect(req.headers.referer);
+      return;
+    }
+  }
+  config.res.redirect("/");
+}
+
+const isPrismicUpdateToolbarEvent = (event) => {
+  return "detail" in event && typeof event.detail.ref === "string";
+};
+function PrismicPreview({
+  repositoryName,
+  children,
+  updatePreviewURL = "/api/preview",
+  exitPreviewURL = "/api/exit-preview"
+}) {
+  React.useEffect(() => {
+    const prismicPreviewUpdate = async (event) => {
+      if (isPrismicUpdateToolbarEvent(event)) {
+        event.preventDefault();
+        await fetch(`${updatePreviewURL}?token=${event.detail.ref}`);
+        window.location.reload();
+      }
+    };
+    const prismicPreviewEnd = async (event) => {
+      event.preventDefault();
+      await fetch(exitPreviewURL);
+      window.location.reload();
+    };
+    if (window) {
+      window.addEventListener("prismicPreviewUpdate", prismicPreviewUpdate);
+      window.addEventListener("prismicPreviewEnd", prismicPreviewEnd);
+    }
+    return () => {
+      if (window) {
+        window.removeEventListener("prismicPreviewUpdate", prismicPreviewUpdate);
+        window.removeEventListener("prismicPreviewEnd", prismicPreviewEnd);
+      }
+    };
+  }, []);
+  return /* @__PURE__ */ React__default["default"].createElement(React__default["default"].Fragment, null, /* @__PURE__ */ React__default["default"].createElement(react.PrismicToolbar, {
+    repositoryName
+  }), children);
+}
+
+const isPrismicNextPreviewData = (previewData) => {
+  return typeof previewData === "object" && "ref" in previewData;
+};
+const enableAutoPreviews = (config) => {
+  if ("context" in config && config.context) {
+    const previewData = config.context.previewData;
+    if (isPrismicNextPreviewData(previewData) && previewData.ref) {
+      config.client.queryContentFromRef(previewData.ref);
+    }
+  } else if ("req" in config && config.req) {
+    config.client.enableAutoPreviewsFromReq(config.req);
+  }
+};
+
+const isPrismicNextQuery = (query) => typeof query.documentId === "string" && typeof query.token === "string";
+async function redirectToPreviewURL({
+  req,
+  res,
+  client,
+  linkResolver,
+  defaultURL = "/"
+}) {
+  if (isPrismicNextQuery(req.query)) {
+    const { documentId, token } = req.query;
+    const previewUrl = await client.resolvePreviewURL({
+      linkResolver,
+      defaultURL,
+      documentID: documentId,
+      previewToken: token
+    });
+    res.redirect(previewUrl);
+  }
+  res.redirect(defaultURL);
+}
+
+exports.PrismicPreview = PrismicPreview;
+exports.enableAutoPreviews = enableAutoPreviews;
+exports.exitPreview = exitPreview;
+exports.redirectToPreviewURL = redirectToPreviewURL;
+exports.setPreviewData = setPreviewData;

package/dist/index.d.ts

@@ -0,0 +1,206 @@
+import { NextApiRequest, NextApiResponse, PreviewData } from 'next';
+import { Client, HttpRequestLike } from '@prismicio/client';
+import { LinkResolverFunction } from '@prismicio/helpers';
+import React from 'react';
+
+/**
+ * Configuration for `setPreviewData`.
+ */
+declare type SetPreviewDataConfig = {
+    /**
+     * 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: {
+        setPreviewData: NextApiResponse["setPreviewData"];
+    };
+};
+/**
+ * Set Prismic preview data for Next.js's Preview Mode.
+ */
+declare function setPreviewData({ req, res, }: SetPreviewDataConfig): Promise<void>;
+
+/**
+ * Next.js context object from APIs supporting Preview Mode. This includes the
+ * context object from `getStaticProps` and `getServerSideProps`.
+ */
+declare type NextContextLike<TPreviewData extends PreviewData = PreviewData> = {
+    previewData?: TPreviewData;
+};
+/**
+ * Configuration for creating a Prismic client with automatic preview support in
+ * Next.js apps.
+ */
+declare type CreateClientConfig = {
+    /**
+     * A Next.js context object (such as the context object from `getStaticProps`
+     * or `getServerSideProps`).
+     *
+     * Pass a `context` when using outside a Next.js API endpoint.
+     */
+    context?: NextContextLike;
+    /**
+     * A Next.js API endpoint request object.
+     *
+     * Pass a `req` object when using in a Next.js API endpoint.
+     */
+    req?: NextApiRequest;
+};
+/**
+ * Preview config for enabling previews with redirectToPreviewURL
+ */
+declare 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;
+};
+
+/**
+ * Configuration for `enableAutoPreviews`.
+ *
+ * @typeParam TPreviewData - Next.js preview data object.
+ */
+declare type EnableAutoPreviewsConfig<TPreviewData extends PreviewData = PreviewData> = {
+    /**
+     * Prismic client with which automatic previews will be enabled.
+     */
+    client: Client;
+} & ({
+    /**
+     * A Next.js context object (such as the context object from
+     * `getStaticProps` or `getServerSideProps`).
+     *
+     * Pass a `context` object when using `enableAutoPreviews` outside a
+     * Next.js API endpoint.
+     */
+    context?: NextContextLike<TPreviewData>;
+} | {
+    /**
+     * A Next.js API endpoint request object.
+     *
+     * Pass a `req` object when using `enableAutoPreviews` in a Next.js API endpoint.
+     */
+    req?: HttpRequestLike;
+});
+/**
+ * Configures a Prismic client to automatically query draft content during a
+ * preview session. It either takes in a Next.js `getStaticProps` context object
+ * or a Next.js API endpoint request object.
+ *
+ * @param config - Configuration for the function.
+ */
+declare const enableAutoPreviews: <TPreviewData extends PreviewData = PreviewData>(config: EnableAutoPreviewsConfig<TPreviewData>) => void;
+
+/**
+ * Configuration for `exitPreview`.
+ */
+declare type ExitPreviewConfig = {
+    /**
+     * 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: {
+        headers: {
+            referer?: NextApiRequest["headers"]["referer"];
+        };
+    };
+    /**
+     * 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: {
+        clearPreviewData: NextApiResponse["clearPreviewData"];
+        redirect: NextApiResponse["redirect"];
+    };
+};
+/**
+ * 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.
+ */
+declare function exitPreview(config: ExitPreviewConfig): void;
+
+/**
+ * Props for `<PrismicPreview>`.
+ */
+declare type PrismicPreviewProps = {
+    /**
+     * The name of your Prismic repository. A Prismic Toolbar will be registered
+     * using this repository.
+     */
+    repositoryName: string;
+    /**
+     * The URL of your app's Prismic preview endpoint (default: `/api/preview`).
+     * This URL will be fetched on preview update events.
+     */
+    updatePreviewURL?: string;
+    /**
+     * The URL of your app's exit preview endpoint (default: `/api/exit-preview`).
+     * This URL will be fetched on preview exit events.
+     */
+    exitPreviewURL?: string;
+    children?: React.ReactNode;
+};
+/**
+ * React component that sets up Prismic Previews using the Prismic Toolbar. When
+ * the Prismic Toolbar send events to the browser, such as on preview updates
+ * and exiting, this component will automatically update the Next.js preview
+ * cookie and refresh the page.
+ *
+ * This component can be wrapped around your app or added anywhere in your app's
+ * tree. It must be rendered on every page.
+ */
+declare function PrismicPreview({ repositoryName, children, updatePreviewURL, exitPreviewURL, }: PrismicPreviewProps): JSX.Element;
+
+/**
+ * Redirects a user to the URL of a previewed Prismic document from within a
+ * Next.js API route.
+ */
+declare function redirectToPreviewURL({ req, res, client, linkResolver, defaultURL, }: PreviewConfig): Promise<void>;
+
+export { CreateClientConfig, EnableAutoPreviewsConfig, ExitPreviewConfig as ExitPreviewParams, NextContextLike, PreviewConfig, PrismicPreview, SetPreviewDataConfig, enableAutoPreviews, exitPreview, redirectToPreviewURL, setPreviewData };

package/dist/index.mjs

@@ -0,0 +1,100 @@
+import React, { useEffect } from 'react';
+import { PrismicToolbar } from '@prismicio/react';
+
+async function setPreviewData({
+  req,
+  res
+}) {
+  if (req.query.token) {
+    const { token: ref } = req.query;
+    res.setPreviewData({ ref });
+  }
+}
+
+function exitPreview(config) {
+  const { req } = config;
+  config.res.clearPreviewData();
+  if (req.headers.referer) {
+    const url = new URL(req.headers.referer);
+    if (url.pathname !== "/api/exit-preview") {
+      config.res.redirect(req.headers.referer);
+      return;
+    }
+  }
+  config.res.redirect("/");
+}
+
+const isPrismicUpdateToolbarEvent = (event) => {
+  return "detail" in event && typeof event.detail.ref === "string";
+};
+function PrismicPreview({
+  repositoryName,
+  children,
+  updatePreviewURL = "/api/preview",
+  exitPreviewURL = "/api/exit-preview"
+}) {
+  useEffect(() => {
+    const prismicPreviewUpdate = async (event) => {
+      if (isPrismicUpdateToolbarEvent(event)) {
+        event.preventDefault();
+        await fetch(`${updatePreviewURL}?token=${event.detail.ref}`);
+        window.location.reload();
+      }
+    };
+    const prismicPreviewEnd = async (event) => {
+      event.preventDefault();
+      await fetch(exitPreviewURL);
+      window.location.reload();
+    };
+    if (window) {
+      window.addEventListener("prismicPreviewUpdate", prismicPreviewUpdate);
+      window.addEventListener("prismicPreviewEnd", prismicPreviewEnd);
+    }
+    return () => {
+      if (window) {
+        window.removeEventListener("prismicPreviewUpdate", prismicPreviewUpdate);
+        window.removeEventListener("prismicPreviewEnd", prismicPreviewEnd);
+      }
+    };
+  }, []);
+  return /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement(PrismicToolbar, {
+    repositoryName
+  }), children);
+}
+
+const isPrismicNextPreviewData = (previewData) => {
+  return typeof previewData === "object" && "ref" in previewData;
+};
+const enableAutoPreviews = (config) => {
+  if ("context" in config && config.context) {
+    const previewData = config.context.previewData;
+    if (isPrismicNextPreviewData(previewData) && previewData.ref) {
+      config.client.queryContentFromRef(previewData.ref);
+    }
+  } else if ("req" in config && config.req) {
+    config.client.enableAutoPreviewsFromReq(config.req);
+  }
+};
+
+const isPrismicNextQuery = (query) => typeof query.documentId === "string" && typeof query.token === "string";
+async function redirectToPreviewURL({
+  req,
+  res,
+  client,
+  linkResolver,
+  defaultURL = "/"
+}) {
+  if (isPrismicNextQuery(req.query)) {
+    const { documentId, token } = req.query;
+    const previewUrl = await client.resolvePreviewURL({
+      linkResolver,
+      defaultURL,
+      documentID: documentId,
+      previewToken: token
+    });
+    res.redirect(previewUrl);
+  }
+  res.redirect(defaultURL);
+}
+
+export { PrismicPreview, enableAutoPreviews, exitPreview, redirectToPreviewURL, setPreviewData };

package/package.json

@@ -0,0 +1,90 @@
+{
+	"name": "@prismicio/next",
+	"version": "0.0.1",
+	"description": "Integrate Prismic into a Next.js app",
+	"keywords": [
+		"typescript",
+		"prismic",
+		"next",
+		"vercel",
+		"preview"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/prismicio/prismic-next"
+	},
+	"license": "Apache-2.0",
+	"author": "Prismic <contact@prismic.io> (https://prismic.io)",
+	"type": "module",
+	"exports": {
+		".": {
+			"require": "./dist/index.cjs",
+			"import": "./dist/index.mjs"
+		},
+		"./package.json": "./package.json"
+	},
+	"main": "./dist/index.cjs",
+	"module": "dist/index.mjs",
+	"types": "dist/index.d.ts",
+	"files": [
+		"dist",
+		"src"
+	],
+	"scripts": {
+		"build": "siroc build",
+		"dev": "siroc build --watch",
+		"format": "prettier --write .",
+		"lint": "eslint --ext .js,.ts .",
+		"prepare": "npm run build",
+		"release": "npm run build && npm run test && standard-version && git push --follow-tags && npm run build && npm publish",
+		"release:alpha": "npm run build && npm run test && standard-version --release-as major --prerelease alpha && git push --follow-tags && npm run build && npm publish --tag alpha",
+		"release:alpha:dry": "standard-version --release-as major --prerelease alpha --dry-run",
+		"release:dry": "standard-version --dry-run",
+		"test": "npm run lint && npm run unit",
+		"unit": "nyc --reporter=lcovonly --reporter=text --exclude-after-remap=false ava"
+	},
+	"dependencies": {
+		"@prismicio/react": "^2.0.2"
+	},
+	"devDependencies": {
+		"@prismicio/client": "^6.0.0-beta.0",
+		"@prismicio/mock": "^0.0.6",
+		"@prismicio/types": "^0.1.13",
+		"@testing-library/react": "^12.1.2",
+		"@types/jsdom": "^16.2.13",
+		"@types/jsdom-global": "^3.0.2",
+		"@types/node-fetch": "^3.0.3",
+		"@types/sinon": "^10.0.6",
+		"@typescript-eslint/eslint-plugin": "^4.29.1",
+		"@typescript-eslint/parser": "^4.29.1",
+		"ava": "^3.15.0",
+		"eslint": "^7.32.0",
+		"eslint-config-prettier": "^8.3.0",
+		"eslint-plugin-prettier": "^3.4.0",
+		"eslint-plugin-tsdoc": "^0.2.14",
+		"jsdom": "^18.1.1",
+		"jsdom-global": "^3.0.2",
+		"msw": "^0.35.0",
+		"node-fetch": "^2.6.6",
+		"nyc": "^15.1.0",
+		"prettier": "^2.3.2",
+		"prettier-plugin-jsdoc": "^0.3.30",
+		"react-test-renderer": "^17.0.2",
+		"sinon": "^12.0.1",
+		"siroc": "^0.15.0",
+		"standard-version": "^9.3.1",
+		"ts-eager": "^2.0.2",
+		"typescript": "^4.3.5"
+	},
+	"peerDependencies": {
+		"@prismicio/client": "^6.0.0-beta.0",
+		"next": "^11 || ^12",
+		"react": "^17"
+	},
+	"engines": {
+		"node": ">=12.7.0"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}

package/src/PrismicPreview.tsx

@@ -0,0 +1,101 @@
+import React, { useEffect } from "react";
+import { PrismicToolbar } from "@prismicio/react";
+
+/**
+ * Props for `<PrismicPreview>`.
+ */
+type PrismicPreviewProps = {
+	/**
+	 * The name of your Prismic repository. A Prismic Toolbar will be registered
+	 * using this repository.
+	 */
+	repositoryName: string;
+
+	/**
+	 * The URL of your app's Prismic preview endpoint (default: `/api/preview`).
+	 * This URL will be fetched on preview update events.
+	 */
+	updatePreviewURL?: string;
+
+	/**
+	 * The URL of your app's exit preview endpoint (default: `/api/exit-preview`).
+	 * This URL will be fetched on preview exit events.
+	 */
+	exitPreviewURL?: string;
+
+	children?: React.ReactNode;
+};
+
+/**
+ * Determines if an Event object came from the Prismic Toolbar.
+ *
+ * @param event - Event to check.
+ *
+ * @returns `true` if `event` came from the Prismic Toolbar, `false` otherwise.
+ */
+const isPrismicUpdateToolbarEvent = (
+	event: Event,
+): event is CustomEvent<{ ref: string }> => {
+	return (
+		"detail" in event && typeof (event as CustomEvent).detail.ref === "string"
+	);
+};
+
+/**
+ * React component that sets up Prismic Previews using the Prismic Toolbar. When
+ * the Prismic Toolbar send events to the browser, such as on preview updates
+ * and exiting, this component will automatically update the Next.js preview
+ * cookie and refresh the page.
+ *
+ * This component can be wrapped around your app or added anywhere in your app's
+ * tree. It must be rendered on every page.
+ */
+export function PrismicPreview({
+	repositoryName,
+	children,
+	updatePreviewURL = "/api/preview",
+	exitPreviewURL = "/api/exit-preview",
+}: PrismicPreviewProps): JSX.Element {
+	useEffect(() => {
+		const prismicPreviewUpdate = async (event: Event) => {
+			if (isPrismicUpdateToolbarEvent(event)) {
+				// Prevent the toolbar from reloading the page.
+				event.preventDefault();
+				// Update the preview cookie.
+				await fetch(`${updatePreviewURL}?token=${event.detail.ref}`);
+
+				// Reload the page with the updated token.
+				window.location.reload();
+			}
+		};
+
+		const prismicPreviewEnd = async (event: Event) => {
+			event.preventDefault();
+			await fetch(exitPreviewURL);
+			window.location.reload();
+		};
+
+		if (window) {
+			window.addEventListener("prismicPreviewUpdate", prismicPreviewUpdate);
+
+			window.addEventListener("prismicPreviewEnd", prismicPreviewEnd);
+		}
+
+		return () => {
+			if (window) {
+				window.removeEventListener(
+					"prismicPreviewUpdate",
+					prismicPreviewUpdate,
+				);
+				window.removeEventListener("prismicPreviewEnd", prismicPreviewEnd);
+			}
+		};
+	}, []);
+
+	return (
+		<>
+			<PrismicToolbar repositoryName={repositoryName} />
+			{children}
+		</>
+	);
+}

package/src/enableAutoPreviews.ts

@@ -0,0 +1,81 @@
+import { PreviewData } from "next";
+import { Client, HttpRequestLike } from "@prismicio/client";
+import { NextContextLike } from "./types";
+
+interface PrismicNextPreviewData {
+	ref: string;
+}
+
+/**
+ * Determines if a Next.js preview data object contains Prismic preview data.
+ *
+ * @param previewData - The Next.js preview data object to check.
+ *
+ * @returns `true` if `previewData` contains Prismic preview data, `false` otherwise.
+ */
+const isPrismicNextPreviewData = (
+	previewData: PreviewData,
+): previewData is PrismicNextPreviewData => {
+	return typeof previewData === "object" && "ref" in previewData;
+};
+
+/**
+ * Configuration for `enableAutoPreviews`.
+ *
+ * @typeParam TPreviewData - Next.js preview data object.
+ */
+export type EnableAutoPreviewsConfig<
+	TPreviewData extends PreviewData = PreviewData,
+> = {
+	/**
+	 * Prismic client with which automatic previews will be enabled.
+	 */
+	client: Client;
+} & (
+	| {
+			/**
+			 * A Next.js context object (such as the context object from
+			 * `getStaticProps` or `getServerSideProps`).
+			 *
+			 * Pass a `context` object when using `enableAutoPreviews` outside a
+			 * Next.js API endpoint.
+			 */
+			context?: NextContextLike<TPreviewData>;
+	  }
+	| {
+			/**
+			 * A Next.js API endpoint request object.
+			 *
+			 * Pass a `req` object when using `enableAutoPreviews` in a Next.js API endpoint.
+			 */
+			req?: HttpRequestLike;
+	  }
+);
+/**
+ * Configures a Prismic client to automatically query draft content during a
+ * preview session. It either takes in a Next.js `getStaticProps` context object
+ * or a Next.js API endpoint request object.
+ *
+ * @param config - Configuration for the function.
+ */
+export const enableAutoPreviews = <
+	TPreviewData extends PreviewData = PreviewData,
+>(
+	config: EnableAutoPreviewsConfig<TPreviewData>,
+): void => {
+	/**
+	 * If preview data is being passed from Next Context then use queryContentFromRef
+	 */
+	if ("context" in config && config.context) {
+		const previewData = config.context.previewData;
+
+		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) {
+		config.client.enableAutoPreviewsFromReq(config.req);
+	}
+};

package/src/exitPreview.ts

@@ -0,0 +1,54 @@
+import { NextApiResponse, NextApiRequest } from "next";
+
+/**
+ * Configuration for `exitPreview`.
+ */
+export type ExitPreviewConfig = {
+	/**
+	 * 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: {
+		headers: {
+			referer?: NextApiRequest["headers"]["referer"];
+		};
+	};
+
+	/**
+	 * 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: {
+		clearPreviewData: NextApiResponse["clearPreviewData"];
+		redirect: NextApiResponse["redirect"];
+	};
+};
+
+/**
+ * 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.
+	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("/");
+}

package/src/index.ts

@@ -0,0 +1,13 @@
+export type { SetPreviewDataConfig } from "./setPreviewData";
+export type { EnableAutoPreviewsConfig } from "./enableAutoPreviews";
+export type { ExitPreviewConfig as ExitPreviewParams } from "./exitPreview";
+export { setPreviewData } from "./setPreviewData";
+export { exitPreview } from "./exitPreview";
+export { PrismicPreview } from "./PrismicPreview";
+export { enableAutoPreviews } from "./enableAutoPreviews";
+export { redirectToPreviewURL } from "./redirectToPreviewURL";
+export type {
+	NextContextLike,
+	CreateClientConfig,
+	PreviewConfig,
+} from "./types";

package/src/redirectToPreviewURL.ts

@@ -0,0 +1,46 @@
+import { NextApiRequest } from "next";
+import { PreviewConfig } from "./";
+
+type PrismicNextQuery = {
+	documentId: string;
+	token: string;
+};
+
+/**
+ * Determines if a query object from a Next.js API route request contains
+ * Prismic preview data.
+ *
+ * @param query - Query object to check.
+ *
+ * @returns `true` if `query` contains Prismic preview data, `false` otherwise.
+ */
+const isPrismicNextQuery = (
+	query: NextApiRequest["query"],
+): query is PrismicNextQuery =>
+	typeof query.documentId === "string" && typeof query.token === "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,
+			defaultURL,
+			documentID: documentId,
+			previewToken: token,
+		});
+
+		res.redirect(previewUrl);
+	}
+
+	res.redirect(defaultURL);
+}

package/src/setPreviewData.ts

@@ -0,0 +1,39 @@
+import { NextApiResponse, NextApiRequest } from "next";
+
+/**
+ * Configuration for `setPreviewData`.
+ */
+export type SetPreviewDataConfig = {
+	/**
+	 * 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: {
+		setPreviewData: NextApiResponse["setPreviewData"];
+	};
+};
+
+/**
+ * Set Prismic preview data for Next.js's Preview Mode.
+ */
+export async function setPreviewData({
+	req,
+	res,
+}: SetPreviewDataConfig): Promise<void> {
+	if (req.query.token) {
+		const { token: ref } = req.query;
+		res.setPreviewData({ ref });
+	}
+}

package/src/types.ts

@@ -0,0 +1,74 @@
+import { PreviewData, NextApiRequest, NextApiResponse } from "next";
+import { LinkResolverFunction } from "@prismicio/helpers";
+import { Client } from "@prismicio/client";
+
+/**
+ * Next.js context object from APIs supporting Preview Mode. This includes the
+ * context object from `getStaticProps` and `getServerSideProps`.
+ */
+export type NextContextLike<TPreviewData extends PreviewData = PreviewData> = {
+	previewData?: TPreviewData;
+};
+
+/**
+ * Configuration for creating a Prismic client with automatic preview support in
+ * Next.js apps.
+ */
+export type CreateClientConfig = {
+	/**
+	 * A Next.js context object (such as the context object from `getStaticProps`
+	 * or `getServerSideProps`).
+	 *
+	 * Pass a `context` when using outside a Next.js API endpoint.
+	 */
+	context?: NextContextLike;
+
+	/**
+	 * A Next.js API endpoint request object.
+	 *
+	 * Pass a `req` object when using in a Next.js API endpoint.
+	 */
+	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;
+};