@prismicio/next 2.2.3-pr.136.19d76d2 → 2.2.3

package/src/SliceSimulator.tsx

@@ -1,34 +1,39 @@
-"use client"
+"use client";
 
-import { SimulatorManager, StateEventType, getDefaultMessage } from "@prismicio/simulator/kit"
-import type { SliceSimulatorProps as BaseSliceSimulatorProps } from "@prismicio/simulator/kit"
-import { compressToEncodedURIComponent } from "lz-string"
-import { useRouter } from "next/navigation"
-import { useEffect, useState } from "react"
-import type { FC, ReactNode } from "react"
+import { SliceSimulatorWrapper } from "./SliceSimulatorWrapper";
+import { getSlices } from "./getSlices";
+import {
+	SimulatorManager,
+	StateEventType,
+	getDefaultMessage,
+} from "@prismicio/simulator/kit";
+import type { SliceSimulatorProps as BaseSliceSimulatorProps } from "@prismicio/simulator/kit";
+import { compressToEncodedURIComponent } from "lz-string";
+import { useRouter } from "next/navigation";
+import { useEffect, useState } from "react";
+import type { FC, ReactNode } from "react";
 
-import { getSlices } from "./getSlices"
-import { SliceSimulatorWrapper } from "./SliceSimulatorWrapper"
+const STATE_PARAMS_KEY = "state";
 
-const STATE_PARAMS_KEY = "state"
+const simulatorManager = new SimulatorManager();
 
-const simulatorManager = new SimulatorManager()
-
-/** Parameters provided to the Slice Simulator page. */
+/**
+ * Parameters provided to the Slice Simulator page.
+ */
 export type SliceSimulatorParams = {
 	searchParams: Promise<{
-		state?: string
-	}>
-}
+		state?: string;
+	}>;
+};
 
 export type SliceSimulatorProps = BaseSliceSimulatorProps & {
-	children: ReactNode
-	className?: string
-}
+	children: ReactNode;
+	className?: string;
+};
 
 /**
- * Simulate slices in isolation. The slice simulator enables live slice development in Slice Machine
- * and live previews in the Page Builder.
+ * Simulate slices in isolation. The slice simulator enables live slice
+ * development in Slice Machine and live previews in the Page Builder.
  */
 export const SliceSimulator: FC<SliceSimulatorProps> = ({
 	children,
@@ -36,45 +41,45 @@ export const SliceSimulator: FC<SliceSimulatorProps> = ({
 	zIndex,
 	className,
 }) => {
-	const [message, setMessage] = useState(() => getDefaultMessage())
-	const router = useRouter()
+	const [message, setMessage] = useState(() => getDefaultMessage());
+	const router = useRouter();
 
 	const state =
 		typeof window !== "undefined"
 			? new URL(window.location.href).searchParams.get(STATE_PARAMS_KEY)
-			: undefined
-	const hasSlices = getSlices(state).length > 0
+			: undefined;
+	const hasSlices = getSlices(state).length > 0;
 
 	useEffect(() => {
 		simulatorManager.state.on(
 			StateEventType.Slices,
 			(newSlices) => {
-				const url = new URL(window.location.href)
+				const url = new URL(window.location.href);
 				url.searchParams.set(
 					STATE_PARAMS_KEY,
 					compressToEncodedURIComponent(JSON.stringify(newSlices)),
-				)
+				);
 
-				window.history.replaceState(null, "", url)
+				window.history.replaceState(null, "", url);
 				// Wait until the next tick to prevent URL state race conditions.
-				setTimeout(() => router.refresh(), 0)
+				setTimeout(() => router.refresh(), 0);
 			},
 			"simulator-slices",
-		)
+		);
 		simulatorManager.state.on(
 			StateEventType.Message,
 			(newMessage) => setMessage(newMessage),
 			"simulator-message",
-		)
+		);
 
-		simulatorManager.init()
+		simulatorManager.init();
 
 		return () => {
-			simulatorManager.state.off(StateEventType.Slices, "simulator-slices")
+			simulatorManager.state.off(StateEventType.Slices, "simulator-slices");
 
-			simulatorManager.state.off(StateEventType.Message, "simulator-message")
-		}
-	}, [router])
+			simulatorManager.state.off(StateEventType.Message, "simulator-message");
+		};
+	}, [router]);
 
 	return (
 		<SliceSimulatorWrapper
@@ -86,5 +91,5 @@ export const SliceSimulator: FC<SliceSimulatorProps> = ({
 		>
 			{children}
 		</SliceSimulatorWrapper>
-	)
-}
+	);
+};

package/src/SliceSimulatorWrapper.tsx

@@ -4,18 +4,21 @@ import {
 	onClickHandler,
 	simulatorClass,
 	simulatorRootClass,
-} from "@prismicio/simulator/kit"
-import type { SliceSimulatorProps } from "@prismicio/simulator/kit"
-import type { FC, ReactNode } from "react"
+} from "@prismicio/simulator/kit";
+import type { SliceSimulatorProps } from "@prismicio/simulator/kit";
+import type { FC, ReactNode } from "react";
 
 type SliceSimulatorWrapperProps = SliceSimulatorProps & {
-	children: ReactNode
-	className?: string
-	message?: string
-	hasSlices: boolean
-}
+	children: ReactNode;
+	className?: string;
+	message?: string;
+	hasSlices: boolean;
+};
 
-/** A wrapper for the slice simulator that isolates the given children from the page's layout. */
+/**
+ * A wrapper for the slice simulator that isolates the given children from the
+ * page's layout.
+ */
 export const SliceSimulatorWrapper: FC<SliceSimulatorWrapperProps> = ({
 	className,
 	children,
@@ -24,13 +27,16 @@ export const SliceSimulatorWrapper: FC<SliceSimulatorWrapperProps> = ({
 	message,
 	hasSlices,
 }) => {
-	const defaultProps = getDefaultProps()
+	const defaultProps = getDefaultProps();
 
 	return (
 		<div
 			className={[simulatorClass, className].filter(Boolean).join(" ")}
 			style={{
-				zIndex: typeof zIndex === "undefined" ? defaultProps.zIndex : (zIndex ?? undefined),
+				zIndex:
+					typeof zIndex === "undefined"
+						? defaultProps.zIndex
+						: (zIndex ?? undefined),
 				position: "fixed",
 				top: 0,
 				left: 0,
@@ -38,7 +44,9 @@ export const SliceSimulatorWrapper: FC<SliceSimulatorWrapperProps> = ({
 				height: "100vh",
 				overflow: "auto",
 				background:
-					typeof background === "undefined" ? defaultProps.background : (background ?? undefined),
+					typeof background === "undefined"
+						? defaultProps.background
+						: (background ?? undefined),
 			}}
 		>
 			{message ? (
@@ -48,11 +56,13 @@ export const SliceSimulatorWrapper: FC<SliceSimulatorWrapperProps> = ({
 					id="root"
 					className={simulatorRootClass}
 					onClickCapture={onClickHandler as unknown as React.MouseEventHandler}
-					onSubmitCapture={disableEventHandler as unknown as React.FormEventHandler}
+					onSubmitCapture={
+						disableEventHandler as unknown as React.FormEventHandler
+					}
 				>
 					{children}
 				</div>
 			) : null}
 		</div>
-	)
-}
+	);
+};

package/src/createLocaleRedirect.ts

@@ -1,4 +1,4 @@
-import { devMsg } from "./lib/devMsg"
+import { devMsg } from "./lib/devMsg";
 
 /**
  * @deprecated `createLocaleRedirect()` has been removed due to performance
@@ -9,10 +9,10 @@ export function createLocaleRedirect(): never {
 		`createLocaleRedirect() has been removed due to performance issues. See ${devMsg(
 			"replace-createLocaleRedirect",
 		)} for more details.`,
-	)
+	);
 }
 /**
  * @deprecated `createLocaleRedirect()` has been removed due to performance
  *   issues.
  */
-export type CreateLocaleRedirectConfig = never
+export type CreateLocaleRedirectConfig = never;

package/src/enableAutoPreviews.ts

@@ -1,4 +1,4 @@
-import { type Client, cookie as prismicCookie } from "@prismicio/client"
+import { type Client, cookie as prismicCookie } from "@prismicio/client";
 
 /** Configuration for `enableAutoPreviews`. */
 export type EnableAutoPreviewsConfig = {
@@ -6,11 +6,12 @@ export type EnableAutoPreviewsConfig = {
 	// `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, "queryContentFromRef" | "enableAutoPreviewsFromReq">
-}
+	client: Pick<Client, "queryContentFromRef" | "enableAutoPreviewsFromReq">;
+};
 
 /**
- * Configures a Prismic client to automatically query draft content during a preview session.
+ * Configures a Prismic client to automatically query draft content during a
+ * preview session.
  *
  * @param config - Configuration for the function.
  */
@@ -21,32 +22,32 @@ export function enableAutoPreviews(config: EnableAutoPreviewsConfig): void {
 		// 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");
 
-		let isDraftModeEnabled = false
+		let isDraftModeEnabled = false;
 		try {
-			isDraftModeEnabled = (await draftMode()).isEnabled
+			isDraftModeEnabled = (await draftMode()).isEnabled;
 		} catch {
 			// `draftMode()` may have been called in a palce that
 			// does not have access to its async storage. This
 			// occurs in places like `generateStaticParams()`. We
 			// can ignore this case.
-			return
+			return;
 		}
 		if (!isDraftModeEnabled) {
-			return
+			return;
 		}
 
-		const cookie = (await cookies()).get(prismicCookie.preview)?.value
+		const cookie = (await cookies()).get(prismicCookie.preview)?.value;
 		if (!cookie) {
-			return
+			return;
 		}
 
-		const isActiveCookie = cookie.includes("websitePreviewId=")
+		const isActiveCookie = cookie.includes("websitePreviewId=");
 		if (!isActiveCookie) {
-			return
+			return;
 		}
 
-		return cookie
-	})
+		return cookie;
+	});
 }

package/src/exitPreview.ts

@@ -1,30 +1,31 @@
 /**
- * Ends a Prismic preview session within a Next.js app. This function should be used in a Router
- * Handler.
+ * Ends a Prismic preview session within a Next.js app. This function should be
+ * used in a Router Handler.
  *
  * @example
- * 	```typescript
- * 	// src/app/api/exit-preview/route.js
  *
- * 	import { exitPreview } from "@prismicio/next"
+ * ```typescript
+ * // src/app/api/exit-preview/route.js
  *
- * 	export async function GET() {
- * 		return await exitPreview()
- * 	}
- * 	```
+ * import { exitPreview } from "@prismicio/next";
+ *
+ * export async function GET() {
+ * 	return await exitPreview();
+ * }
+ * ```
  */
 export async function exitPreview(): Promise<Response> {
 	// 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 { draftMode } = await import("next/headers")
+	const { draftMode } = await import("next/headers");
 
-	;(await draftMode()).disable()
+	(await draftMode()).disable();
 
 	// `Cache-Control` header is used to prevent CDN-level caching.
 	return new Response(JSON.stringify({ success: true }), {
 		headers: {
 			"Cache-Control": "no-store",
 		},
-	})
+	});
 }

package/src/getSlices.ts

@@ -1,7 +1,11 @@
-import { getDefaultSlices } from "@prismicio/simulator/kit"
-import type { StateEvents, StateEventType } from "@prismicio/simulator/kit"
-import { decompressFromEncodedURIComponent } from "lz-string"
+import { getDefaultSlices } from "@prismicio/simulator/kit";
+import type { StateEvents, StateEventType } from "@prismicio/simulator/kit";
+import { decompressFromEncodedURIComponent } from "lz-string";
 
-export const getSlices = (state: string | null | undefined): StateEvents[StateEventType.Slices] => {
-	return state ? JSON.parse(decompressFromEncodedURIComponent(state)) : getDefaultSlices()
-}
+export const getSlices = (
+	state: string | null | undefined,
+): StateEvents[StateEventType.Slices] => {
+	return state
+		? JSON.parse(decompressFromEncodedURIComponent(state))
+		: getDefaultSlices();
+};

package/src/imgixLoader.ts

@@ -1,26 +1,26 @@
-import type { ImgixURLParams } from "imgix-url-builder"
-import { buildURL } from "imgix-url-builder"
-import type { ImageLoaderProps } from "next/image"
+import type { ImageLoaderProps } from "next/image";
+import type { ImgixURLParams } from "imgix-url-builder";
+import { buildURL } from "imgix-url-builder";
 
 /**
- * A `next/image` loader for Imgix, which Prismic uses, with an optional collection of default Imgix
- * parameters.
+ * A `next/image` loader for Imgix, which Prismic uses, with an optional
+ * collection of default Imgix parameters.
  *
  * @see To learn about `next/image` loaders: https://nextjs.org/docs/api-reference/next/image#loader
  * @see To learn about Imgix's URL API: https://docs.imgix.com/apis/rendering
  */
 export const imgixLoader = (args: ImageLoaderProps): string => {
-	const url = new URL(args.src)
+	const url = new URL(args.src);
 
 	const params: ImgixURLParams = {
 		fit: (url.searchParams.get("fit") as ImgixURLParams["fit"]) || "max",
 		w: args.width,
 		h: undefined,
-	}
+	};
 
 	if (args.quality) {
-		params.q = args.quality
+		params.q = args.quality;
 	}
 
-	return buildURL(args.src, params)
-}
+	return buildURL(args.src, params);
+};

package/src/index.ts

@@ -1,28 +1,31 @@
-export { exitPreview } from "./exitPreview"
+export { exitPreview } from "./exitPreview";
 
-export { PrismicPreview } from "./PrismicPreview"
-export type { PrismicPreviewProps } from "./PrismicPreview"
+export { PrismicPreview } from "./PrismicPreview";
+export type { PrismicPreviewProps } from "./PrismicPreview";
 
-export { PrismicNextLink } from "./PrismicNextLink"
-export type { PrismicNextLinkProps } from "./PrismicNextLink"
+export { PrismicNextLink } from "./PrismicNextLink";
+export type { PrismicNextLinkProps } from "./PrismicNextLink";
 
-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 { PrismicNextImage } from "./PrismicNextImage"
-export type { PrismicNextImageProps } from "./PrismicNextImage"
+export { PrismicNextImage } from "./PrismicNextImage";
+export type { PrismicNextImageProps } from "./PrismicNextImage";
 
-export { SliceSimulator } from "./SliceSimulator"
-export type { SliceSimulatorProps, SliceSimulatorParams } from "./SliceSimulator"
+export { SliceSimulator } from "./SliceSimulator";
+export type {
+	SliceSimulatorProps,
+	SliceSimulatorParams,
+} from "./SliceSimulator";
 
-export { getSlices } from "./getSlices"
+export { getSlices } from "./getSlices";
 
-export { imgixLoader } from "./imgixLoader"
+export { imgixLoader } from "./imgixLoader";
 
-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/lib/devMsg.ts

@@ -1,18 +1,20 @@
-import { version } from "../../package.json"
+import { version } from "../../package.json";
 
 /**
  * Returns a `prismic.dev/msg` URL for a given message slug.
  *
  * @example
- * 	```ts
- * 	devMsg("missing-param")
- * 	// => "https://prismic.dev/msg/next/v1.2.3/missing-param"
- * 	```
  *
- * @param slug - Slug for the message. This corresponds to a Markdown file in the Git repository's
- *   `/messages` directory.
+ * ```ts
+ * devMsg("missing-param");
+ * // => "https://prismic.dev/msg/next/v1.2.3/missing-param"
+ * ```
+ *
+ * @param slug - Slug for the message. This corresponds to a Markdown file in
+ *   the Git repository's `/messages` directory.
+ *
  * @returns The `prismic.dev/msg` URL for the given slug.
  */
 export const devMsg = (slug: string): string => {
-	return `https://prismic.dev/msg/next/v${version}/${slug}`
-}
+	return `https://prismic.dev/msg/next/v${version}/${slug}`;
+};

package/src/lib/resolveDefaultExport.ts

@@ -1,17 +1,21 @@
 /**
- * Resolves a module's default export. The module may provide its default export as a `default`
- * property on an object. This happens when named and default exports are mixed in modules.
+ * Resolves a module's default export. The module may provide its default export
+ * as a `default` property on an object. This happens when named and default
+ * exports are mixed in modules.
  *
- * In ES Modules, mixing is fine since the module resolver can distinguish default and named
- * exports. In transpiled modules, however, all exports are put into a single object, and the
- * default export is provided at a property called `default`.
+ * In ES Modules, mixing is fine since the module resolver can distinguish
+ * default and named exports. In transpiled modules, however, all exports are
+ * put into a single object, and the default export is provided at a property
+ * called `default`.
  *
- * This helper is needed by Next.js uses CJS files with named and default exports.
+ * This helper is needed by Next.js uses CJS files with named and default
+ * exports.
  *
- * This helper _should_ be a temporary hack until Next.js and Node.js resolve their ESM
- * difficulties. This will likely not be removed any time soon, unfortunately.
+ * This helper _should_ be a temporary hack until Next.js and Node.js resolve
+ * their ESM difficulties. This will likely not be removed any time soon,
+ * unfortunately.
  */
 export function resolveDefaultExport<T>(mod: T): T {
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	return "default" in (mod as any) ? (mod as any).default : mod
+	return "default" in (mod as any) ? (mod as any).default : mod;
 }