@prismicio/next 1.2.0 → 1.3.0-alpha.0

package/dist/exitPreview.js

@@ -1,6 +1,18 @@
+import { draftMode } from "next/headers";
 async function exitPreview(config) {
-  config.res.clearPreviewData();
-  config.res.status(205).json({ success: true });
+  if (config == null ? void 0 : config.res) {
+    config.res.clearPreviewData();
+    config.res.json({ success: true });
+    config.res.setHeader("Cache-Control", "no-store");
+    return;
+  } else {
+    draftMode().disable();
+    return new Response(JSON.stringify({ success: true }), {
+      headers: {
+        "Cache-Control": "no-store"
+      }
+    });
+  }
 }
 export {
   exitPreview

package/dist/exitPreview.js.map

@@ -1 +1 @@
-{"version":3,"file":"exitPreview.js","sources":["../../src/exitPreview.ts"],"sourcesContent":["import { NextResponse } from \"next/server\";\n\nimport { NextApiRequestLike, NextApiResponseLike } from \"./types\";\n\n/**\n * Configuration for `exitPreview`.\n */\nexport type ExitPreviewConfig = {\n\t/**\n\t * The `req` object from a Next.js API route.\n\t *\n\t * @see Next.js API route docs: \\<https://nextjs.org/docs/api-routes/introduction\\>\n\t */\n\treq: NextApiRequestLike;\n\n\t/**\n\t * The `res` object from a Next.js API route.\n\t *\n\t * @see Next.js API route docs: \\<https://nextjs.org/docs/api-routes/introduction\\>\n\t */\n\tres: NextApiResponseLike;\n};\n\n/**\n * **Only use this function in the Pages Directory (/pages).**\n *\n * Exits Next.js's Preview Mode from within a Next.js API route.\n */\nexport async function exitPreview(\n\tconfig: ExitPreviewConfig,\n): Promise<NextResponse | void> {\n\t// Exit the current user from Preview Mode.\n\tconfig.res.clearPreviewData();\n\n\t// 205 status is used to prevent CDN-level caching. The default 200\n\t// status code is typically treated as non-changing and cacheable.\n\tconfig.res.status(205).json({ success: true });\n}\n"],"names":[],"mappings":"AA4BA,eAAsB,YACrB,QAAyB;AAGzB,SAAO,IAAI;AAIJ,SAAA,IAAI,OAAO,GAAG,EAAE,KAAK,EAAE,SAAS,MAAM;AAC9C;"}
+{"version":3,"file":"exitPreview.js","sources":["../../src/exitPreview.ts"],"sourcesContent":["import { draftMode } from \"next/headers\";\n\nimport { NextApiRequestLike, NextApiResponseLike } from \"./types\";\n\n/**\n * Configuration for `exitPreview`.\n */\nexport type ExitPreviewConfig = {\n\t/**\n\t * **Only use this parameter in the Pages Directory (/pages).**\n\t *\n\t * The `req` object from a Next.js API route.\n\t *\n\t * @see Next.js API route docs: \\<https://nextjs.org/docs/api-routes/introduction\\>\n\t */\n\treq?: NextApiRequestLike;\n\n\t/**\n\t * **Only use this parameter in the Pages Directory (/pages).**\n\t *\n\t * The `res` object from a Next.js API route.\n\t *\n\t * @see Next.js API route docs: \\<https://nextjs.org/docs/api-routes/introduction\\>\n\t */\n\tres?: NextApiResponseLike;\n};\n\n/**\n * Ends a Prismic preview session within a Next.js app. This function should be\n * used in a Router Handler or an API Route, depending on which you are using\n * the App Router or Pages Router.\n *\n * `exitPreview()` assumes Draft Mode is being used unless a Pages Router API\n * Route `res` object is provided to the function.\n *\n * @example Usage within an App Router Route Handler.\n *\n * ```typescript\n * // src/app/exit-preview/route.js\n *\n * import { exitPreview } from \"@prismicio/next\";\n *\n * export async function GET() {\n * \tawait exitPreview();\n * }\n * ```\n *\n * @example Usage within a Pages Router API Route.\n *\n * ```typescript\n * // src/pages/api/exit-preview.js\n *\n * import { exitPreview } from \"@prismicio/next\";\n *\n * export default async function handler(req, res) {\n * \tawait exitPreview({ req, res });\n * }\n * ```\n */\nexport async function exitPreview(\n\tconfig?: ExitPreviewConfig,\n): Promise<Response | void> {\n\tif (config?.res) {\n\t\t// Assume Preview Mode is being used.\n\n\t\tconfig.res.clearPreviewData();\n\n\t\t// 205 status is used to prevent CDN-level caching. The default 200\n\t\t// status code is typically treated as non-changing and cacheable.\n\t\tconfig.res.json({ success: true });\n\t\tconfig.res.setHeader(\"Cache-Control\", \"no-store\");\n\n\t\treturn;\n\t} else {\n\t\t// Assume Draft Mode is being used.\n\n\t\tdraftMode().disable();\n\n\t\t// 205 status is used to prevent CDN-level caching. The default 200\n\t\t// status code is typically treated as non-changing and cacheable.\n\t\treturn new Response(JSON.stringify({ success: true }), {\n\t\t\theaders: {\n\t\t\t\t\"Cache-Control\": \"no-store\",\n\t\t\t},\n\t\t});\n\t}\n}\n"],"names":[],"mappings":";AA2DA,eAAsB,YACrB,QAA0B;AAE1B,MAAI,iCAAQ,KAAK;AAGhB,WAAO,IAAI;AAIX,WAAO,IAAI,KAAK,EAAE,SAAS,KAAM,CAAA;AAC1B,WAAA,IAAI,UAAU,iBAAiB,UAAU;AAEhD;AAAA,EAAA,OACM;AAGN,cAAA,EAAY;AAIL,WAAA,IAAI,SAAS,KAAK,UAAU,EAAE,SAAS,KAAA,CAAM,GAAG;AAAA,MACtD,SAAS;AAAA,QACR,iBAAiB;AAAA,MACjB;AAAA,IAAA,CACD;AAAA,EACD;AACF;"}

package/dist/index.d.ts

@@ -13,4 +13,4 @@ export type { RedirectToPreviewURLConfig } from "./redirectToPreviewURL";
 export { PrismicNextImage } from "./PrismicNextImage";
 export type { PrismicNextImageProps } from "./PrismicNextImage";
 export { imgixLoader } from "./imgixLoader";
-export type { CreateClientConfig } from "./types";
+export type { CreateClientConfig, PrismicPreviewData } from "./types";

package/dist/lib/getPreviewCookieRepositoryName.cjs

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const getPreviewCookieRepositoryName = (previewCookie) => {
-  return (decodeURIComponent(previewCookie).match(/"(.+).prismic.io"/) || [])[1];
+  return (decodeURIComponent(previewCookie).match(/,"(.+).prismic.io"/) || [])[1];
 };
 exports.getPreviewCookieRepositoryName = getPreviewCookieRepositoryName;
 //# sourceMappingURL=getPreviewCookieRepositoryName.cjs.map

package/dist/lib/getPreviewCookieRepositoryName.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"getPreviewCookieRepositoryName.cjs","sources":["../../../src/lib/getPreviewCookieRepositoryName.ts"],"sourcesContent":["/**\n * Extracts preview reference repo name from stringified Prismic preview cookie\n *\n * @param previewCookie - The Prismic preview cookie.\n *\n * @returns The repository name for the Prismic preview cookie. If the cookie\n *   represents an inactive preview session, `undefined` will be returned.\n */\nexport const getPreviewCookieRepositoryName = (\n\tpreviewCookie: string,\n): string | undefined => {\n\treturn (decodeURIComponent(previewCookie).match(/\"(.+).prismic.io\"/) ||\n\t\t[])[1];\n};\n"],"names":[],"mappings":";;AAQa,MAAA,iCAAiC,CAC7C,kBACuB;AACf,UAAA,mBAAmB,aAAa,EAAE,MAAM,mBAAmB,KAClE,CAAA,GAAI,CAAC;AACP;;"}
+{"version":3,"file":"getPreviewCookieRepositoryName.cjs","sources":["../../../src/lib/getPreviewCookieRepositoryName.ts"],"sourcesContent":["/**\n * Extracts preview reference repo name from stringified Prismic preview cookie\n *\n * @param previewCookie - The Prismic preview cookie.\n *\n * @returns The repository name for the Prismic preview cookie. If the cookie\n *   represents an inactive preview session, `undefined` will be returned.\n */\nexport const getPreviewCookieRepositoryName = (\n\tpreviewCookie: string,\n): string | undefined => {\n\treturn (decodeURIComponent(previewCookie).match(/,\"(.+).prismic.io\"/) ||\n\t\t[])[1];\n};\n"],"names":[],"mappings":";;AAQa,MAAA,iCAAiC,CAC7C,kBACuB;AACf,UAAA,mBAAmB,aAAa,EAAE,MAAM,oBAAoB,KACnE,CAAA,GAAI,CAAC;AACP;;"}

package/dist/lib/getPreviewCookieRepositoryName.js

@@ -1,5 +1,5 @@
 const getPreviewCookieRepositoryName = (previewCookie) => {
-  return (decodeURIComponent(previewCookie).match(/"(.+).prismic.io"/) || [])[1];
+  return (decodeURIComponent(previewCookie).match(/,"(.+).prismic.io"/) || [])[1];
 };
 export {
   getPreviewCookieRepositoryName

package/dist/lib/getPreviewCookieRepositoryName.js.map

@@ -1 +1 @@
-{"version":3,"file":"getPreviewCookieRepositoryName.js","sources":["../../../src/lib/getPreviewCookieRepositoryName.ts"],"sourcesContent":["/**\n * Extracts preview reference repo name from stringified Prismic preview cookie\n *\n * @param previewCookie - The Prismic preview cookie.\n *\n * @returns The repository name for the Prismic preview cookie. If the cookie\n *   represents an inactive preview session, `undefined` will be returned.\n */\nexport const getPreviewCookieRepositoryName = (\n\tpreviewCookie: string,\n): string | undefined => {\n\treturn (decodeURIComponent(previewCookie).match(/\"(.+).prismic.io\"/) ||\n\t\t[])[1];\n};\n"],"names":[],"mappings":"AAQa,MAAA,iCAAiC,CAC7C,kBACuB;AACf,UAAA,mBAAmB,aAAa,EAAE,MAAM,mBAAmB,KAClE,CAAA,GAAI,CAAC;AACP;"}
+{"version":3,"file":"getPreviewCookieRepositoryName.js","sources":["../../../src/lib/getPreviewCookieRepositoryName.ts"],"sourcesContent":["/**\n * Extracts preview reference repo name from stringified Prismic preview cookie\n *\n * @param previewCookie - The Prismic preview cookie.\n *\n * @returns The repository name for the Prismic preview cookie. If the cookie\n *   represents an inactive preview session, `undefined` will be returned.\n */\nexport const getPreviewCookieRepositoryName = (\n\tpreviewCookie: string,\n): string | undefined => {\n\treturn (decodeURIComponent(previewCookie).match(/,\"(.+).prismic.io\"/) ||\n\t\t[])[1];\n};\n"],"names":[],"mappings":"AAQa,MAAA,iCAAiC,CAC7C,kBACuB;AACf,UAAA,mBAAmB,aAAa,EAAE,MAAM,oBAAoB,KACnE,CAAA,GAAI,CAAC;AACP;"}

package/dist/package.json.cjs

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const version = "1.2.0";
+const version = "1.3.0-alpha.0";
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.map

package/dist/package.json.js

@@ -1,4 +1,4 @@
-const version = "1.2.0";
+const version = "1.3.0-alpha.0";
 export {
   version
 };

package/dist/types.d.ts

@@ -5,6 +5,12 @@ declare module "@prismicio/client" {
         next?: RequestInit["next"];
     }
 }
+/**
+ * Prismic data saved in Next.js Preview Mode's object.
+ */
+export type PrismicPreviewData = {
+    ref: string;
+};
 /**
  * Configuration for creating a Prismic client with automatic preview support in
  * Next.js apps.
@@ -58,7 +64,7 @@ export type NextApiRequestLike = {
 export type NextApiResponseLike = {
     redirect(url: string): NextApiResponseLike;
     clearPreviewData(): NextApiResponseLike;
-    status(statusCode: number): NextApiResponseLike;
+    setHeader(name: string, value: string | string[]): NextApiResponseLike;
     json(body: any): void;
     setPreviewData(data: object | string): NextApiResponseLike;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/next",
-	"version": "1.2.0",
+	"version": "1.3.0-alpha.0",
 	"description": "Helpers to integrate Prismic into Next.js apps",
 	"keywords": [
 		"typescript",
@@ -18,8 +18,14 @@
 	"sideEffects": false,
 	"exports": {
 		".": {
-			"import": "./dist/index.js",
-			"require": "./dist/index.cjs"
+			"require": {
+				"types": "./dist/index.d.ts",
+				"default": "./dist/index.cjs"
+			},
+			"import": {
+				"types": "./dist/index.d.ts",
+				"default": "./dist/index.js"
+			}
 		},
 		"./package.json": "./package.json"
 	},
@@ -45,15 +51,11 @@
 		"size": "size-limit",
 		"test": "npm run lint && npm run types && npm run unit && npm run build && npm run size"
 	},
-	"bin": {
-		"prismic-next": "./bin/prismic-next.js"
-	},
 	"dependencies": {
-		"imgix-url-builder": "^0.0.3",
-		"mri": "^1.2.0"
+		"imgix-url-builder": "^0.0.3"
 	},
 	"devDependencies": {
-		"@prismicio/client": "^7.0.0-alpha.3",
+		"@prismicio/client": "^7.0.1",
 		"@prismicio/mock": "^0.2.0",
 		"@size-limit/preset-small-lib": "^8.2.4",
 		"@types/react-test-renderer": "^18.0.0",
@@ -69,7 +71,7 @@
 		"eslint-plugin-tsdoc": "^0.2.17",
 		"happy-dom": "^9.9.2",
 		"memfs": "^3.5.1",
-		"next": "^13.4.0",
+		"next": "^13.4.5-canary.9",
 		"node-fetch": "^3.3.1",
 		"prettier": "^2.8.8",
 		"prettier-plugin-jsdoc": "^0.4.2",

package/src/PrismicPreview.tsx

@@ -1,6 +1,7 @@
+import Script from "next/script";
+import { draftMode } from "next/headers";
 import * as React from "react";
 import * as prismic from "@prismicio/client";
-import Script from "next/script";
 
 import { PrismicPreviewClient } from "./PrismicPreviewClient";
 
@@ -51,11 +52,16 @@ export function PrismicPreview({
 	...props
 }: PrismicPreviewProps): JSX.Element {
 	const toolbarSrc = prismic.getToolbarSrc(repositoryName);
+	const isDraftMode = draftMode().isEnabled;
 
 	return (
 		<>
 			{children}
-			<PrismicPreviewClient repositoryName={repositoryName} {...props} />
+			<PrismicPreviewClient
+				repositoryName={repositoryName}
+				isDraftMode={isDraftMode}
+				{...props}
+			/>
 			<Script src={toolbarSrc} strategy="lazyOnload" />
 		</>
 	);

package/src/PrismicPreviewClient.tsx

@@ -9,15 +9,18 @@ import { getPreviewCookieRepositoryName } from "./lib/getPreviewCookieRepository
 
 import { PrismicPreviewProps } from "./PrismicPreview";
 
-type PrismicPreviewClientProps = Omit<PrismicPreviewProps, "children">;
+type PrismicPreviewClientProps = Omit<PrismicPreviewProps, "children"> & {
+	isDraftMode: boolean;
+};
 
 export function PrismicPreviewClient({
 	repositoryName,
 	updatePreviewURL = "/api/preview",
 	exitPreviewURL = "/api/exit-preview",
+	isDraftMode,
 }: PrismicPreviewClientProps): null {
+	let isPreviewActive = isDraftMode;
 	let isAppRouter = true;
-	let isPreviewMode = false;
 	let basePath = "";
 	let refresh: () => void;
 
@@ -27,7 +30,7 @@ export function PrismicPreviewClient({
 
 		isAppRouter = false;
 		basePath = router.basePath;
-		isPreviewMode = router.isPreview;
+		isPreviewActive ||= router.isPreview;
 		refresh = () => router.replace(router.asPath, undefined, { scroll: false });
 	} catch {
 		// Assume we are in App Router. Ignore the error.
@@ -77,30 +80,24 @@ export function PrismicPreviewClient({
 			// Prevent the toolbar from reloading the page.
 			event.preventDefault();
 
-			if (isAppRouter) {
+			const resolvedExitPreviewURL = basePath + exitPreviewURL;
+
+			// Exit Next.js Preview Mode via the given preview API endpoint.
+			const res = await globalThis.fetch(resolvedExitPreviewURL);
+
+			if (res.ok) {
 				refresh();
 			} else {
-				const resolvedExitPreviewURL = basePath + exitPreviewURL;
-
-				// Exit Next.js Preview Mode via the given preview API endpoint.
-				const res = await globalThis.fetch(resolvedExitPreviewURL);
-
-				if (res.ok) {
-					// TODO: Can we do better than a full page reload?
-					// globalThis.location.reload();
-					refresh();
-				} else {
-					console.error(
-						`[<PrismicPreview>] Failed to exit Preview Mode using the "${resolvedExitPreviewURL}" API endpoint. Does it exist?`,
-					);
-				}
+				console.error(
+					`[<PrismicPreview>] Failed to exit Preview Mode using the "${resolvedExitPreviewURL}" API endpoint. Does it exist?`,
+				);
 			}
 		};
 
 		window.addEventListener("prismicPreviewUpdate", handlePrismicPreviewUpdate);
 		window.addEventListener("prismicPreviewEnd", handlePrismicPreviewEnd);
 
-		if (!isPreviewMode) {
+		if (!isPreviewActive) {
 			const prismicPreviewCookie = getPrismicPreviewCookie(
 				globalThis.document.cookie,
 			);
@@ -149,7 +146,7 @@ export function PrismicPreviewClient({
 		basePath,
 		exitPreviewURL,
 		isAppRouter,
-		isPreviewMode,
+		isPreviewActive,
 		refresh,
 		repositoryName,
 		updatePreviewURL,

package/src/enableAutoPreviews.ts

@@ -1,8 +1,8 @@
 import { PreviewData } from "next";
-import { cookies } from "next/headers";
+import { cookies, draftMode } from "next/headers";
 import * as prismic from "@prismicio/client";
 
-import { NextApiRequestLike } from "./types";
+import { NextApiRequestLike, PrismicPreviewData } from "./types";
 
 /**
  * Configuration for `enableAutoPreviews`.
@@ -41,6 +41,10 @@ export type EnableAutoPreviewsConfig<
 	req?: NextApiRequestLike;
 };
 
+const isPrismicPreviewData = (input: unknown): input is PrismicPreviewData => {
+	return typeof input === "object" && input !== null && "ref" in input;
+};
+
 /**
  * Configures a Prismic client to automatically query draft content during a
  * preview session. It either takes in a Next.js `getStaticProps` context object
@@ -56,11 +60,7 @@ export const enableAutoPreviews = <TPreviewData extends PreviewData>(
 		// `getServerSideProps()` with active Preview Mode (`pages`
 		// directory).
 
-		if (
-			typeof config.previewData === "object" &&
-			"ref" in config.previewData &&
-			typeof config.previewData.ref === "string"
-		) {
+		if (isPrismicPreviewData(config.previewData)) {
 			config.client.queryContentFromRef(config.previewData.ref);
 		}
 	} else if ("req" in config && config.req) {
@@ -75,21 +75,30 @@ export const enableAutoPreviews = <TPreviewData extends PreviewData>(
 		// We use a function value so the cookie is checked on every
 		// request. We don't have a static value to read from.
 		config.client.queryContentFromRef(() => {
+			let isDraftModeEnabled = false;
+			try {
+				isDraftModeEnabled = draftMode().isEnabled;
+			} catch {
+				// This catch block may be reached if
+				// `draftMode()` is called in a place that does
+				// not have access to its async storage. We can
+				// ignore this case.
+
+				return;
+			}
+
 			let cookie: string | undefined;
 			try {
 				cookie = cookies().get(prismic.cookie.preview)?.value;
 			} catch {
-				// noop - We are probably in
-				// `getStaticProps()` or `getServerSideProps()`
-				// with inactive Preview Mode where `cookies()`
-				// does not work. We don't need to do any
-				// preview handling.
+				// We are probably in `getStaticProps()` or
+				// `getServerSideProps()` with inactive Preview
+				// Mode where `cookies()` does not work. We
+				// don't need to do any preview handling.
 
 				return;
 			}
 
-			// We are probably in App Router (`app` directory).
-
 			// We only return the cookie if a Prismic Preview session is active.
 			//
 			// An inactive cookie looks like this (URL encoded):
@@ -104,7 +113,7 @@ export const enableAutoPreviews = <TPreviewData extends PreviewData>(
 			// 			preview: "https://example-prismic-repo.prismic.io/previews/abc:123?websitePreviewId=xyz"
 			// 		}
 			// 	}
-			if (cookie && /\.prismic\.io/.test(cookie)) {
+			if (isDraftModeEnabled && cookie && /\.prismic\.io/.test(cookie)) {
 				return cookie;
 			}
 		});

package/src/exitPreview.ts

@@ -1,4 +1,4 @@
-import { NextResponse } from "next/server";
+import { draftMode } from "next/headers";
 
 import { NextApiRequestLike, NextApiResponseLike } from "./types";
 
@@ -7,32 +7,81 @@ import { NextApiRequestLike, NextApiResponseLike } from "./types";
  */
 export type ExitPreviewConfig = {
 	/**
+	 * **Only use this parameter in the Pages Directory (/pages).**
+	 *
 	 * The `req` object from a Next.js API route.
 	 *
 	 * @see Next.js API route docs: \<https://nextjs.org/docs/api-routes/introduction\>
 	 */
-	req: NextApiRequestLike;
+	req?: NextApiRequestLike;
 
 	/**
+	 * **Only use this parameter in the Pages Directory (/pages).**
+	 *
 	 * The `res` object from a Next.js API route.
 	 *
 	 * @see Next.js API route docs: \<https://nextjs.org/docs/api-routes/introduction\>
 	 */
-	res: NextApiResponseLike;
+	res?: NextApiResponseLike;
 };
 
 /**
- * **Only use this function in the Pages Directory (/pages).**
+ * Ends a Prismic preview session within a Next.js app. This function should be
+ * used in a Router Handler or an API Route, depending on which you are using
+ * the App Router or Pages Router.
+ *
+ * `exitPreview()` assumes Draft Mode is being used unless a Pages Router API
+ * Route `res` object is provided to the function.
+ *
+ * @example Usage within an App Router Route Handler.
+ *
+ * ```typescript
+ * // src/app/exit-preview/route.js
+ *
+ * import { exitPreview } from "@prismicio/next";
+ *
+ * export async function GET() {
+ * 	await exitPreview();
+ * }
+ * ```
+ *
+ * @example Usage within a Pages Router API Route.
  *
- * Exits Next.js's Preview Mode from within a Next.js API route.
+ * ```typescript
+ * // src/pages/api/exit-preview.js
+ *
+ * import { exitPreview } from "@prismicio/next";
+ *
+ * export default async function handler(req, res) {
+ * 	await exitPreview({ req, res });
+ * }
+ * ```
  */
 export async function exitPreview(
-	config: ExitPreviewConfig,
-): Promise<NextResponse | void> {
-	// Exit the current user from Preview Mode.
-	config.res.clearPreviewData();
-
-	// 205 status is used to prevent CDN-level caching. The default 200
-	// status code is typically treated as non-changing and cacheable.
-	config.res.status(205).json({ success: true });
+	config?: ExitPreviewConfig,
+): Promise<Response | void> {
+	if (config?.res) {
+		// Assume Preview Mode is being used.
+
+		config.res.clearPreviewData();
+
+		// 205 status is used to prevent CDN-level caching. The default 200
+		// status code is typically treated as non-changing and cacheable.
+		config.res.json({ success: true });
+		config.res.setHeader("Cache-Control", "no-store");
+
+		return;
+	} else {
+		// Assume Draft Mode is being used.
+
+		draftMode().disable();
+
+		// 205 status is used to prevent CDN-level caching. The default 200
+		// status code is typically treated as non-changing and cacheable.
+		return new Response(JSON.stringify({ success: true }), {
+			headers: {
+				"Cache-Control": "no-store",
+			},
+		});
+	}
 }

package/src/index.ts

@@ -21,4 +21,4 @@ export type { PrismicNextImageProps } from "./PrismicNextImage";
 
 export { imgixLoader } from "./imgixLoader";
 
-export type { CreateClientConfig } from "./types";
+export type { CreateClientConfig, PrismicPreviewData } from "./types";

package/src/lib/getPreviewCookieRepositoryName.ts

@@ -9,6 +9,6 @@
 export const getPreviewCookieRepositoryName = (
 	previewCookie: string,
 ): string | undefined => {
-	return (decodeURIComponent(previewCookie).match(/"(.+).prismic.io"/) ||
+	return (decodeURIComponent(previewCookie).match(/,"(.+).prismic.io"/) ||
 		[])[1];
 };

package/src/types.ts

@@ -8,6 +8,13 @@ declare module "@prismicio/client" {
 	}
 }
 
+/**
+ * Prismic data saved in Next.js Preview Mode's object.
+ */
+export type PrismicPreviewData = {
+	ref: string;
+};
+
 /**
  * Configuration for creating a Prismic client with automatic preview support in
  * Next.js apps.
@@ -65,7 +72,7 @@ export type NextApiRequestLike = {
 export type NextApiResponseLike = {
 	redirect(url: string): NextApiResponseLike;
 	clearPreviewData(): NextApiResponseLike;
-	status(statusCode: number): NextApiResponseLike;
+	setHeader(name: string, value: string | string[]): NextApiResponseLike;
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	json(body: any): void;
 	setPreviewData(data: object | string): NextApiResponseLike;

package/bin/prismic-next.js

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-
-import("../dist/cli.cjs").then((mod) => mod.run(process.argv));

package/dist/cli/index.d.ts

@@ -1 +0,0 @@
-export declare function run(argv: string[]): Promise<void>;

package/dist/cli.cjs

@@ -1,123 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const mri = require("mri");
-const path = require("node:path");
-const fs = require("node:fs/promises");
-const tty = require("node:tty");
-const node_buffer = require("node:buffer");
-const _package = require("./package.json.cjs");
-function _interopNamespaceDefault(e) {
-  const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
-  if (e) {
-    for (const k in e) {
-      if (k !== "default") {
-        const d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: () => e[k]
-        });
-      }
-    }
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
-const path__namespace = /* @__PURE__ */ _interopNamespaceDefault(path);
-const fs__namespace = /* @__PURE__ */ _interopNamespaceDefault(fs);
-const tty__namespace = /* @__PURE__ */ _interopNamespaceDefault(tty);
-async function pathExists(filePath) {
-  try {
-    await fs__namespace.access(filePath);
-    return true;
-  } catch {
-    return false;
-  }
-}
-function color(colorCode, string) {
-  return tty__namespace.WriteStream.prototype.hasColors() ? "\x1B[" + colorCode + "m" + string + "\x1B[39m" : string;
-}
-function warn(string) {
-  return console.warn(`${color(33, "warn")}  - ${string}`);
-}
-function info(string) {
-  return console.info(`${color(35, "info")}  - ${string}`);
-}
-async function run(argv) {
-  const args = mri(argv.slice(2), {
-    boolean: ["help", "version"],
-    alias: {
-      help: "h",
-      version: "v"
-    },
-    default: {
-      help: false,
-      version: false
-    }
-  });
-  const command = args._[0];
-  switch (command) {
-    case "clear-cache": {
-      warn("`prismic-next clear-cache` is an experimental utility. It may be replaced with a different solution in the future.");
-      async function getAppRootDir() {
-        let currentDir = process.cwd();
-        while (!await pathExists(path__namespace.join(currentDir, ".next")) && !await pathExists(path__namespace.join(currentDir, "package.json"))) {
-          if (currentDir === path__namespace.resolve("/")) {
-            break;
-          }
-          currentDir = path__namespace.join(currentDir, "..");
-        }
-        if (await pathExists(path__namespace.join(currentDir, ".next")) || await pathExists(path__namespace.join(currentDir, "package.json"))) {
-          return currentDir;
-        }
-      }
-      const appRootDir = await getAppRootDir();
-      if (!appRootDir) {
-        warn("Could not find the Next.js app root. Run `prismic-next clear-cache` in a Next.js project with a `.next` directory or `package.json` file.");
-        return;
-      }
-      const fetchCacheDir = path__namespace.join(appRootDir, ".next", "cache", "fetch-cache");
-      if (!await pathExists(fetchCacheDir)) {
-        info("No Next.js fetch cache directory found. You are good to go!");
-        return;
-      }
-      const cacheEntries = await fs__namespace.readdir(fetchCacheDir);
-      await Promise.all(cacheEntries.map(async (entry) => {
-        try {
-          const contents = await fs__namespace.readFile(path__namespace.join(fetchCacheDir, entry), "utf8");
-          const payload = JSON.parse(contents);
-          if (payload.kind !== "FETCH") {
-            return;
-          }
-          const bodyPayload = JSON.parse(node_buffer.Buffer.from(payload.data.body, "base64").toString());
-          if (/\.prismic\.io\/auth$/.test(bodyPayload.oauth_initiate)) {
-            await fs__namespace.unlink(path__namespace.join(fetchCacheDir, entry));
-            info(`Prismic /api/v2 request cache cleared: ${entry}`);
-          }
-        } catch (e) {
-        }
-      }));
-      info("The Prismic request cache has been cleared. Uncached requests will begin on the next Next.js server start-up.");
-      return;
-    }
-    default: {
-      if (command && (!args.version || !args.help)) {
-        warn("Invalid command.\n");
-      }
-      if (args.version) {
-        console.info(_package.version);
-        return;
-      }
-      console.info(`
-Usage:
-    prismic-next <command> [options...]
-Available commands:
-    clear-cache
-Options:
-    --help, -h     Show help text
-    --version, -v  Show version
-`.trim());
-    }
-  }
-}
-exports.run = run;
-//# sourceMappingURL=cli.cjs.map

package/dist/cli.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"cli.cjs","sources":["../../src/cli/index.ts"],"sourcesContent":["import mri from \"mri\";\nimport * as path from \"node:path\";\nimport * as fs from \"node:fs/promises\";\nimport * as tty from \"node:tty\";\nimport { Buffer } from \"node:buffer\";\n\nimport * as pkg from \"../../package.json\";\n\nasync function pathExists(filePath: string) {\n\ttry {\n\t\tawait fs.access(filePath);\n\n\t\treturn true;\n\t} catch {\n\t\treturn false;\n\t}\n}\n\nfunction color(colorCode: number, string: string) {\n\treturn tty.WriteStream.prototype.hasColors()\n\t\t? \"\\u001B[\" + colorCode + \"m\" + string + \"\\u001B[39m\"\n\t\t: string;\n}\n\nfunction warn(string: string) {\n\t// Yellow\n\treturn console.warn(`${color(33, \"warn\")}  - ${string}`);\n}\n\nfunction info(string: string) {\n\t// Magenta\n\treturn console.info(`${color(35, \"info\")}  - ${string}`);\n}\n\ntype Args = {\n\thelp: boolean;\n\tversion: boolean;\n};\n\nexport async function run(argv: string[]) {\n\tconst args = mri<Args>(argv.slice(2), {\n\t\tboolean: [\"help\", \"version\"],\n\t\talias: {\n\t\t\thelp: \"h\",\n\t\t\tversion: \"v\",\n\t\t},\n\t\tdefault: {\n\t\t\thelp: false,\n\t\t\tversion: false,\n\t\t},\n\t});\n\n\tconst command = args._[0];\n\n\tswitch (command) {\n\t\tcase \"clear-cache\": {\n\t\t\twarn(\n\t\t\t\t\"`prismic-next clear-cache` is an experimental utility. It may be replaced with a different solution in the future.\",\n\t\t\t);\n\n\t\t\tasync function getAppRootDir() {\n\t\t\t\tlet currentDir = process.cwd();\n\n\t\t\t\twhile (\n\t\t\t\t\t!(await pathExists(path.join(currentDir, \".next\"))) &&\n\t\t\t\t\t!(await pathExists(path.join(currentDir, \"package.json\")))\n\t\t\t\t) {\n\t\t\t\t\tif (currentDir === path.resolve(\"/\")) {\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\n\t\t\t\t\tcurrentDir = path.join(currentDir, \"..\");\n\t\t\t\t}\n\n\t\t\t\tif (\n\t\t\t\t\t(await pathExists(path.join(currentDir, \".next\"))) ||\n\t\t\t\t\t(await pathExists(path.join(currentDir, \"package.json\")))\n\t\t\t\t) {\n\t\t\t\t\treturn currentDir;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tconst appRootDir = await getAppRootDir();\n\n\t\t\tif (!appRootDir) {\n\t\t\t\twarn(\n\t\t\t\t\t\"Could not find the Next.js app root. Run `prismic-next clear-cache` in a Next.js project with a `.next` directory or `package.json` file.\",\n\t\t\t\t);\n\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tconst fetchCacheDir = path.join(\n\t\t\t\tappRootDir,\n\t\t\t\t\".next\",\n\t\t\t\t\"cache\",\n\t\t\t\t\"fetch-cache\",\n\t\t\t);\n\n\t\t\tif (!(await pathExists(fetchCacheDir))) {\n\t\t\t\tinfo(\"No Next.js fetch cache directory found. You are good to go!\");\n\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tconst cacheEntries = await fs.readdir(fetchCacheDir);\n\n\t\t\tawait Promise.all(\n\t\t\t\tcacheEntries.map(async (entry) => {\n\t\t\t\t\ttry {\n\t\t\t\t\t\tconst contents = await fs.readFile(\n\t\t\t\t\t\t\tpath.join(fetchCacheDir, entry),\n\t\t\t\t\t\t\t\"utf8\",\n\t\t\t\t\t\t);\n\t\t\t\t\t\tconst payload = JSON.parse(contents);\n\n\t\t\t\t\t\tif (payload.kind !== \"FETCH\") {\n\t\t\t\t\t\t\treturn;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\tconst bodyPayload = JSON.parse(\n\t\t\t\t\t\t\tBuffer.from(payload.data.body, \"base64\").toString(),\n\t\t\t\t\t\t);\n\n\t\t\t\t\t\t// Delete `/api/v2` requests.\n\t\t\t\t\t\tif (/\\.prismic\\.io\\/auth$/.test(bodyPayload.oauth_initiate)) {\n\t\t\t\t\t\t\tawait fs.unlink(path.join(fetchCacheDir, entry));\n\n\t\t\t\t\t\t\tinfo(`Prismic /api/v2 request cache cleared: ${entry}`);\n\t\t\t\t\t\t}\n\t\t\t\t\t} catch (e) {\n\t\t\t\t\t\t// noop\n\t\t\t\t\t}\n\t\t\t\t}),\n\t\t\t);\n\n\t\t\tinfo(\n\t\t\t\t\"The Prismic request cache has been cleared. Uncached requests will begin on the next Next.js server start-up.\",\n\t\t\t);\n\n\t\t\treturn;\n\t\t}\n\n\t\tdefault: {\n\t\t\tif (command && (!args.version || !args.help)) {\n\t\t\t\twarn(\"Invalid command.\\n\");\n\t\t\t}\n\n\t\t\tif (args.version) {\n\t\t\t\tconsole.info(pkg.version);\n\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tconsole.info(\n\t\t\t\t`\nUsage:\n    prismic-next <command> [options...]\nAvailable commands:\n    clear-cache\nOptions:\n    --help, -h     Show help text\n    --version, -v  Show version\n`.trim(),\n\t\t\t);\n\t\t}\n\t}\n}\n"],"names":["fs","tty","path","Buffer","pkg.version"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,eAAe,WAAW,UAAgB;AACrC,MAAA;AACG,UAAAA,cAAG,OAAO,QAAQ;AAEjB,WAAA;AAAA,EAAA,QACN;AACM,WAAA;AAAA,EACP;AACF;AAEA,SAAS,MAAM,WAAmB,QAAc;AACxC,SAAAC,eAAI,YAAY,UAAU,cAC9B,UAAY,YAAY,MAAM,SAAS,aACvC;AACJ;AAEA,SAAS,KAAK,QAAc;AAE3B,SAAO,QAAQ,KAAK,GAAG,MAAM,IAAI,MAAM,QAAQ,QAAQ;AACxD;AAEA,SAAS,KAAK,QAAc;AAE3B,SAAO,QAAQ,KAAK,GAAG,MAAM,IAAI,MAAM,QAAQ,QAAQ;AACxD;AAOA,eAAsB,IAAI,MAAc;AACvC,QAAM,OAAO,IAAU,KAAK,MAAM,CAAC,GAAG;AAAA,IACrC,SAAS,CAAC,QAAQ,SAAS;AAAA,IAC3B,OAAO;AAAA,MACN,MAAM;AAAA,MACN,SAAS;AAAA,IACT;AAAA,IACD,SAAS;AAAA,MACR,MAAM;AAAA,MACN,SAAS;AAAA,IACT;AAAA,EAAA,CACD;AAEK,QAAA,UAAU,KAAK,EAAE,CAAC;AAExB,UAAQ,SAAS;AAAA,IAChB,KAAK,eAAe;AACnB,WACC,oHAAoH;AAGrH,qBAAe,gBAAa;AACvB,YAAA,aAAa,QAAQ;AAEzB,eACC,CAAE,MAAM,WAAWC,gBAAK,KAAK,YAAY,OAAO,CAAC,KACjD,CAAE,MAAM,WAAWA,gBAAK,KAAK,YAAY,cAAc,CAAC,GACvD;AACD,cAAI,eAAeA,gBAAK,QAAQ,GAAG,GAAG;AACrC;AAAA,UACA;AAEY,uBAAAA,gBAAK,KAAK,YAAY,IAAI;AAAA,QACvC;AAED,YACE,MAAM,WAAWA,gBAAK,KAAK,YAAY,OAAO,CAAC,KAC/C,MAAM,WAAWA,gBAAK,KAAK,YAAY,cAAc,CAAC,GACtD;AACM,iBAAA;AAAA,QACP;AAAA,MACF;AAEM,YAAA,aAAa,MAAM;AAEzB,UAAI,CAAC,YAAY;AAChB,aACC,2IAA2I;AAG5I;AAAA,MACA;AAED,YAAM,gBAAgBA,gBAAK,KAC1B,YACA,SACA,SACA,aAAa;AAGd,UAAI,CAAE,MAAM,WAAW,aAAa,GAAI;AACvC,aAAK,6DAA6D;AAElE;AAAA,MACA;AAED,YAAM,eAAe,MAAMF,cAAG,QAAQ,aAAa;AAEnD,YAAM,QAAQ,IACb,aAAa,IAAI,OAAO,UAAS;AAC5B,YAAA;AACG,gBAAA,WAAW,MAAMA,cAAG,SACzBE,gBAAK,KAAK,eAAe,KAAK,GAC9B,MAAM;AAED,gBAAA,UAAU,KAAK,MAAM,QAAQ;AAE/B,cAAA,QAAQ,SAAS,SAAS;AAC7B;AAAA,UACA;AAEK,gBAAA,cAAc,KAAK,MACxBC,YAAO,OAAA,KAAK,QAAQ,KAAK,MAAM,QAAQ,EAAE,SAAU,CAAA;AAIpD,cAAI,uBAAuB,KAAK,YAAY,cAAc,GAAG;AAC5D,kBAAMH,cAAG,OAAOE,gBAAK,KAAK,eAAe,KAAK,CAAC;AAE/C,iBAAK,0CAA0C,OAAO;AAAA,UACtD;AAAA,iBACO;QAER;AAAA,MACD,CAAA,CAAC;AAGH,WACC,+GAA+G;AAGhH;AAAA,IACA;AAAA,IAED,SAAS;AACR,UAAI,YAAY,CAAC,KAAK,WAAW,CAAC,KAAK,OAAO;AAC7C,aAAK,oBAAoB;AAAA,MACzB;AAED,UAAI,KAAK,SAAS;AACT,gBAAA,KAAKE,SAAAA,OAAW;AAExB;AAAA,MACA;AAED,cAAQ,KACP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQF,KAAM,CAAA;AAAA,IAEL;AAAA,EACD;AACF;;"}