@prismicio/next 2.2.2 → 2.2.3-canary.1abb259

package/src/pages/index.ts

@@ -1,33 +1,30 @@
-export { PrismicNextLink } from "../PrismicNextLink";
-export { type PrismicNextLinkProps } from "../PrismicNextLink";
+export { PrismicNextLink } from "../PrismicNextLink"
+export { type PrismicNextLinkProps } from "../PrismicNextLink"
 
-export { PrismicNextImage } from "../PrismicNextImage";
-export { type PrismicNextImageProps } from "../PrismicNextImage";
+export { PrismicNextImage } from "../PrismicNextImage"
+export { type PrismicNextImageProps } from "../PrismicNextImage"
 
-export { SliceSimulator } from "./SliceSimulator";
-export type {
-	SliceSimulatorProps,
-	SliceSimulatorSliceZoneProps,
-} from "./SliceSimulator";
+export { SliceSimulator } from "./SliceSimulator"
+export type { SliceSimulatorProps, SliceSimulatorSliceZoneProps } from "./SliceSimulator"
 
-export { imgixLoader } from "../imgixLoader";
+export { imgixLoader } from "../imgixLoader"
 
-export { PrismicPreview } from "./PrismicPreview";
-export type { PrismicPreviewProps } from "./PrismicPreview";
+export { PrismicPreview } from "./PrismicPreview"
+export type { PrismicPreviewProps } from "./PrismicPreview"
 
-export { enableAutoPreviews } from "./enableAutoPreviews";
-export type { EnableAutoPreviewsConfig } from "./enableAutoPreviews";
+export { enableAutoPreviews } from "./enableAutoPreviews"
+export type { EnableAutoPreviewsConfig } from "./enableAutoPreviews"
 
-export { redirectToPreviewURL } from "./redirectToPreviewURL";
-export type { RedirectToPreviewURLConfig } from "./redirectToPreviewURL";
+export { redirectToPreviewURL } from "./redirectToPreviewURL"
+export type { RedirectToPreviewURLConfig } from "./redirectToPreviewURL"
 
-export { exitPreview } from "./exitPreview";
-export type { ExitPreviewAPIRouteConfig } from "./exitPreview";
+export { exitPreview } from "./exitPreview"
+export type { ExitPreviewAPIRouteConfig } from "./exitPreview"
 
-export { setPreviewData } from "./setPreviewData";
-export type { SetPreviewDataConfig } from "./setPreviewData";
+export { setPreviewData } from "./setPreviewData"
+export type { SetPreviewDataConfig } from "./setPreviewData"
 
-export type { CreateClientConfig } from "./types";
+export type { CreateClientConfig } from "./types"
 
-export { createLocaleRedirect } from "../createLocaleRedirect";
-export type { CreateLocaleRedirectConfig } from "../createLocaleRedirect";
+export { createLocaleRedirect } from "../createLocaleRedirect"
+export type { CreateLocaleRedirectConfig } from "../createLocaleRedirect"

package/src/pages/redirectToPreviewURL.ts

@@ -1,77 +1,66 @@
-import type { LinkResolverFunction, Client } from "@prismicio/client";
+import type { LinkResolverFunction, Client } from "@prismicio/client"
 
-import type { NextApiRequestLike, NextApiResponseLike } from "./types";
+import type { NextApiRequestLike, NextApiResponseLike } from "./types"
 
 export type RedirectToPreviewURLConfig = {
 	/** The Prismic client configured for the preview session's repository. */
 	// `Pick` is used to use the smallest possible subset of
 	// `prismic.Client`. Doing this reduces the surface area for breaking
 	// type changes.
-	client: Pick<Client, "resolvePreviewURL">;
+	client: Pick<Client, "resolvePreviewURL">
 
 	/**
 	 * The `req` object from a Next.js API route.
 	 *
 	 * @see Next.js API route docs: \<https://nextjs.org/docs/pages/building-your-application/routing/api-routes\>
 	 */
-	req: NextApiRequestLike;
+	req: NextApiRequestLike
 
 	/**
 	 * The `res` object from a Next.js API route.
 	 *
 	 * @see Next.js API route docs: \<https://nextjs.org/docs/pages/building-your-application/routing/api-routes\>
 	 */
-	res: NextApiResponseLike;
+	res: NextApiResponseLike
 
 	/**
 	 * 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;
+	linkResolver?: LinkResolverFunction
 
 	/**
-	 * The default redirect URL if a URL cannot be determined for the previewed
-	 * document.
+	 * The default redirect URL if a URL cannot be determined for the previewed document.
 	 *
-	 * **Note**: If you `next.config.js` file contains a `basePath`, the
-	 * `defaultURL` option must _not_ include it. Instead, provide the `basePath`
-	 * property using the `basePath` option.
+	 * **Note**: If you `next.config.js` file contains a `basePath`, the `defaultURL` option must
+	 * _not_ include it. Instead, provide the `basePath` property using the `basePath` option.
 	 */
-	defaultURL?: string;
+	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`.
+	 * 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 Router Handler or API route is unable to detect the app's `basePath`
-	 * automatically. It must be provided to `redirectToPreviewURL()` manually.
+	 *   The Router Handler or API route is unable to detect the app's `basePath` automatically. It
+	 *   must be provided to `redirectToPreviewURL()` manually.
 	 */
-	basePath?: string;
-};
+	basePath?: string
+}
 
-export async function redirectToPreviewURL(
-	config: RedirectToPreviewURLConfig,
-): Promise<void> {
-	const {
-		client,
-		req,
-		res,
-		linkResolver,
-		defaultURL = "/",
-		basePath = "",
-	} = config;
+export async function redirectToPreviewURL(config: RedirectToPreviewURLConfig): Promise<void> {
+	const { client, req, res, linkResolver, defaultURL = "/", basePath = "" } = config
 
-	const previewToken = req.query.token?.toString();
+	const previewToken = req.query.token?.toString()
 
 	const previewURL = await client.resolvePreviewURL({
 		linkResolver,
 		defaultURL,
 		previewToken,
-	});
+	})
 
-	res.redirect(basePath + previewURL);
+	res.redirect(basePath + previewURL)
 
-	return;
+	return
 }

package/src/pages/setPreviewData.ts

@@ -1,6 +1,6 @@
-import { cookie } from "@prismicio/client";
+import { cookie } from "@prismicio/client"
 
-import type { NextApiRequestLike, NextApiResponseLike } from "./types";
+import type { NextApiRequestLike, NextApiResponseLike } from "./types"
 
 /** Configuration for `setPreviewData`. */
 export type SetPreviewDataConfig = {
@@ -9,21 +9,21 @@ export type SetPreviewDataConfig = {
 	 *
 	 * @see Next.js API route docs: \<https://nextjs.org/docs/api-routes/introduction\>
 	 */
-	req: NextApiRequestLike;
+	req: NextApiRequestLike
 
 	/**
 	 * 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
+}
 
 /** Set Prismic preview data for Next.js's Preview Mode. */
 export function setPreviewData({ req, res }: SetPreviewDataConfig): void {
-	const ref = req.query.token || req.cookies[cookie.preview];
+	const ref = req.query.token || req.cookies[cookie.preview]
 
 	if (ref) {
-		res.setPreviewData({ ref });
+		res.setPreviewData({ ref })
 	}
 }

package/src/pages/types.ts

@@ -1,35 +1,31 @@
-import type { EnableAutoPreviewsConfig } from "./enableAutoPreviews";
-import type { ClientConfig } from "@prismicio/client";
+import type { ClientConfig } from "@prismicio/client"
 
-/**
- * Configuration for creating a Prismic client with automatic preview support in
- * Next.js apps.
- */
+import type { EnableAutoPreviewsConfig } from "./enableAutoPreviews"
+
+/** Configuration for creating a Prismic client with automatic preview support in Next.js apps. */
 export type CreateClientConfig = ClientConfig &
-	Pick<EnableAutoPreviewsConfig, "previewData" | "req">;
+	Pick<EnableAutoPreviewsConfig, "previewData" | "req">
 
 /**
  * The minimal set of properties needed from `next`'s `NextApiRequest` type.
  *
- * This request type is only compatible with API routes defined in the `pages`
- * directory.
+ * This request type is only compatible with API routes defined in the `pages` directory.
  */
 export type NextApiRequestLike = {
-	query: Partial<Record<string, string | string[]>>;
-	cookies: Partial<Record<string, string>>;
-};
+	query: Partial<Record<string, string | string[]>>
+	cookies: Partial<Record<string, string>>
+}
 
 /**
  * The minimal set of properties needed from `next`'s `NextApiResponse` type.
  *
- * This request type is only compatible with API routes defined in the `pages`
- * directory.
+ * This request type is only compatible with API routes defined in the `pages` directory.
  */
 export type NextApiResponseLike = {
-	redirect(url: string): NextApiResponseLike;
-	clearPreviewData(): NextApiResponseLike;
-	setHeader(name: string, value: string | string[]): NextApiResponseLike;
+	redirect(url: string): NextApiResponseLike
+	clearPreviewData(): NextApiResponseLike
+	setHeader(name: string, value: string | string[]): NextApiResponseLike
 	// oxlint-disable-next-line no-explicit-any explicit-module-boundary-types
-	json(body: any): void;
-	setPreviewData(data: object | string): NextApiResponseLike;
-};
+	json(body: any): void
+	setPreviewData(data: object | string): NextApiResponseLike
+}

package/src/redirectToPreviewURL.ts

@@ -1,65 +1,56 @@
-import { redirect } from "next/navigation";
-import {
-	cookie as prismicCookie,
-	type Client,
-	type LinkResolverFunction,
-} from "@prismicio/client";
+import { cookie as prismicCookie, type Client, type LinkResolverFunction } from "@prismicio/client"
+import { redirect } from "next/navigation"
 
-import type { NextRequestLike } from "./types";
+import type { NextRequestLike } from "./types"
 
 export type RedirectToPreviewURLConfig = {
 	/** The Prismic client configured for the preview session's repository. */
 	// `Pick` is used to use the smallest possible subset of
 	// `prismic.Client`. Doing this reduces the surface area for breaking
 	// type changes.
-	client: Pick<Client, "resolvePreviewURL">;
+	client: Pick<Client, "resolvePreviewURL">
 
 	/**
 	 * The `request` object from a Next.js Route Handler.
 	 *
 	 * @see Next.js Route Handler docs: \<https://nextjs.org/docs/app/building-your-application/routing/route-handlers\>
 	 */
-	request: NextRequestLike;
+	request: NextRequestLike
 
 	/**
 	 * 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;
+	linkResolver?: LinkResolverFunction
 
 	/**
-	 * The default redirect URL if a URL cannot be determined for the previewed
-	 * document.
+	 * The default redirect URL if a URL cannot be determined for the previewed document.
 	 *
-	 * **Note**: If you `next.config.js` file contains a `basePath`, the
-	 * `defaultURL` option must _not_ include it. Instead, provide the `basePath`
-	 * property using the `basePath` option.
+	 * **Note**: If you `next.config.js` file contains a `basePath`, the `defaultURL` option must
+	 * _not_ include it. Instead, provide the `basePath` property using the `basePath` option.
 	 */
-	defaultURL?: string;
-};
+	defaultURL?: string
+}
 
-export async function redirectToPreviewURL(
-	config: RedirectToPreviewURLConfig,
-): Promise<never> {
-	const { client, request, linkResolver, defaultURL = "/" } = config;
+export async function redirectToPreviewURL(config: RedirectToPreviewURLConfig): Promise<never> {
+	const { client, request, linkResolver, defaultURL = "/" } = config
 
 	// Need this to avoid the following Next.js build-time error:
 	// You're importing a component that needs next/headers. That only works
 	// in a Server Component which is not supported in the pages/ directory.
-	const { cookies, draftMode } = await import("next/headers");
+	const { cookies, draftMode } = await import("next/headers")
 
-	const documentID =
-		request.nextUrl.searchParams.get("documentId") ?? undefined;
+	const documentID = request.nextUrl.searchParams.get("documentId") ?? undefined
 
 	// Set the initial preview cookie. Setting the cookie here is necessary
 	// to support unpublished previews. Without setting it here, the page
 	// will try to render without the preview cookie, leading to a
 	// PrismicNotFound error.
-	const previewToken = request.nextUrl.searchParams.get("token") ?? undefined;
+	const previewToken = request.nextUrl.searchParams.get("token") ?? undefined
 	if (previewToken) {
-		const cookieJar = await cookies();
-		cookieJar.set(prismicCookie.preview, previewToken);
+		const cookieJar = await cookies()
+		cookieJar.set(prismicCookie.preview, previewToken)
 	}
 
 	const previewURL = await client.resolvePreviewURL({
@@ -67,9 +58,9 @@ export async function redirectToPreviewURL(
 		previewToken,
 		defaultURL,
 		linkResolver,
-	});
+	})
 
-	(await draftMode()).enable();
+	;(await draftMode()).enable()
 
-	redirect(previewURL);
+	redirect(previewURL)
 }

package/src/types.ts

@@ -1,30 +1,29 @@
-import type { ClientConfig } from "@prismicio/client";
+import type { ClientConfig } from "@prismicio/client"
 
 // Add Next.js-specific fetchOptions to `@prismicio/client`.
 declare module "@prismicio/client" {
 	interface RequestInitLike {
-		next?: RequestInit["next"];
+		next?: RequestInit["next"]
 	}
 }
 
 /** @deprecated Use `@prismicio/client`'s `ClientConfig`. */
-export type CreateClientConfig = ClientConfig;
+export type CreateClientConfig = ClientConfig
 
 /**
  * The minimal set of properties needed from `next`'s `NextRequest` type.
  *
- * This request type is only compatible with Route Handlers defined in the `app`
- * directory.
+ * This request type is only compatible with Route Handlers defined in the `app` directory.
  */
 export type NextRequestLike = {
 	headers: {
-		get(name: string): string | null;
-	};
-	url: string;
+		get(name: string): string | null
+	}
+	url: string
 	nextUrl: {
-		pathname: string;
+		pathname: string
 		searchParams: {
-			get(name: string): string | null;
-		};
-	};
-};
+			get(name: string): string | null
+		}
+	}
+}