@prismicio/next 2.2.4 → 2.3.0-canary.d1640ef

package/src/getPreviewRef.ts

@@ -0,0 +1,51 @@
+import { cookie as prismicCookie } from "@prismicio/client"
+
+/**
+ * Reads the Prismic preview ref for the current request when an active preview session exists.
+ *
+ * This is the read-side counterpart to `redirectToPreviewURL`, which writes the preview cookie. Use
+ * it with Next.js Cache Components to read the ref _outside_ a cached function and pass it _in_ as
+ * an argument so it becomes part of the cache key:
+ *
+ * @example
+ * 	;```typescript
+ * 	import { getPreviewRef } from "@prismicio/next"
+ *
+ * 	const page = await fetchPage(uid, await getPreviewRef())
+ * 	```
+ *
+ * @returns The active preview ref, or `undefined` if no preview session is active.
+ * @experimental
+ */
+export async function getPreviewRef(): Promise<string | undefined> {
+	// 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")
+
+	let isDraftModeEnabled = false
+	try {
+		isDraftModeEnabled = (await draftMode()).isEnabled
+	} catch {
+		// `draftMode()` may have been called in a place that
+		// does not have access to its async storage. This
+		// occurs in places like `generateStaticParams()`. We
+		// can ignore this case.
+		return
+	}
+	if (!isDraftModeEnabled) {
+		return
+	}
+
+	const cookie = (await cookies()).get(prismicCookie.preview)?.value
+	if (!cookie) {
+		return
+	}
+
+	const isActiveCookie = cookie.includes("websitePreviewId=")
+	if (!isActiveCookie) {
+		return
+	}
+
+	return cookie
+}

package/src/getPrismicCacheTags.ts

@@ -0,0 +1,46 @@
+import type { PrismicDocument } from "@prismicio/client"
+
+const CACHE_TAG_PREFIX = "prismic/"
+
+/**
+ * Generates cache tags for a set of Prismic pages. Tags for linked pages (e.g. a content
+ * relationship) are included to ensure all related content can be revalidated.
+ *
+ * @param pages - A set of Prismic pages used to tag the function.
+ * @experimental
+ *
+ * @see {@link https://nextjs.org/docs/app/api-reference/functions/cacheTag}
+ */
+export function getPrismicCacheTags(pages: PrismicDocument[]): string[] {
+	const ids = [...new Set(getPrismicDocumentIDs(pages))]
+	return ids.map((id) => buildPrismicCacheTag(id))
+}
+
+export function buildPrismicCacheTag(id: string): string {
+	return `${CACHE_TAG_PREFIX}${id}`
+}
+
+function getPrismicDocumentIDs(input: unknown): string[] {
+	if (typeof input !== "object" || input == null) return []
+
+	if (Array.isArray(input)) return input.flatMap((item) => getPrismicDocumentIDs(item))
+
+	if ("id" in input && typeof input.id === "string") {
+		// Document
+		// Content relationship or link
+		if (
+			("href" in input &&
+				typeof input.href === "string" &&
+				input.href.includes("/api/v2/documents/search?")) ||
+			("link_type" in input && input.link_type === "Document")
+		) {
+			if ("data" in input && typeof input.data === "object" && input.data !== null) {
+				return [input.id, ...getPrismicDocumentIDs(input.data)]
+			} else {
+				return [input.id]
+			}
+		}
+	}
+
+	return Object.values(input).flatMap((input) => getPrismicDocumentIDs(input))
+}

package/src/getSlices.ts

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

package/src/index.ts

@@ -9,6 +9,8 @@ export type { PrismicNextLinkProps } from "./PrismicNextLink"
 export { enableAutoPreviews } from "./enableAutoPreviews"
 export type { EnableAutoPreviewsConfig } from "./enableAutoPreviews"
 
+export { getPreviewRef } from "./getPreviewRef"
+
 export { redirectToPreviewURL } from "./redirectToPreviewURL"
 export type { RedirectToPreviewURLConfig } from "./redirectToPreviewURL"
 
@@ -26,3 +28,9 @@ export type { CreateClientConfig } from "./types"
 
 export { createLocaleRedirect } from "./createLocaleRedirect"
 export type { CreateLocaleRedirectConfig } from "./createLocaleRedirect"
+
+export { getPrismicCacheTags } from "./getPrismicCacheTags"
+
+export { cacheTagPrismicPages } from "./cacheTagPrismicPages"
+
+export { revalidatePrismicPages } from "./revalidatePrismicPages"

package/src/redirectToPreviewURL.ts

@@ -1,5 +1,4 @@
 import { cookie as prismicCookie, type Client, type LinkResolverFunction } from "@prismicio/client"
-import { redirect } from "next/navigation"
 
 import type { NextRequestLike } from "./types"
 
@@ -41,6 +40,10 @@ export async function redirectToPreviewURL(config: RedirectToPreviewURLConfig):
 	// in a Server Component which is not supported in the pages/ directory.
 	const { cookies, draftMode } = await import("next/headers")
 
+	// Dynamic so Node.js can load this module: the bare specifier (kept by
+	// tsdown.config.ts for Next.js's server alias) is not resolvable by Node.js.
+	const { redirect } = await import("next/navigation")
+
 	const documentID = request.nextUrl.searchParams.get("documentId") ?? undefined
 
 	// Set the initial preview cookie. Setting the cookie here is necessary
@@ -62,5 +65,5 @@ export async function redirectToPreviewURL(config: RedirectToPreviewURLConfig):
 
 	;(await draftMode()).enable()
 
-	redirect(previewURL)
+	return redirect(previewURL)
 }

package/src/revalidatePrismicPages.ts

@@ -0,0 +1,19 @@
+import { revalidateTag } from "next/cache"
+
+import { buildPrismicCacheTag } from "./getPrismicCacheTags"
+
+/**
+ * Immediately revalidates a set of Prismic pages given a list of their IDs. The list of IDs
+ * typically comes from a Prismic webhook triggered when publishing content.
+ *
+ * @param ids - A list of Prismic page IDs to revalidate.
+ * @experimental
+ *
+ * @see {@link https://nextjs.org/docs/app/api-reference/functions/revalidateTag}
+ */
+export function revalidatePrismicPages(ids: string[]): void {
+	for (const id of ids) {
+		const tag = buildPrismicCacheTag(id)
+		revalidateTag(tag, { expire: 0 })
+	}
+}