@prismicio/next 2.0.2-pr.113.86a90db → 2.0.2-pr.114.50610a2

package/dist/cacheTagPrismicPages.cjs

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const cache = require("next/cache");
+const getPrismicCacheTags = require("./getPrismicCacheTags.cjs");
+function cacheTagPrismicPages(pages) {
+  cache.cacheTag(...getPrismicCacheTags.getPrismicCacheTags(pages));
+}
+exports.cacheTagPrismicPages = cacheTagPrismicPages;
+//# sourceMappingURL=cacheTagPrismicPages.cjs.map

package/dist/cacheTagPrismicPages.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"cacheTagPrismicPages.cjs","sources":["../src/cacheTagPrismicPages.ts"],"sourcesContent":["import { PrismicDocument } from \"@prismicio/client\";\nimport { cacheTag } from \"next/cache\";\nimport { getPrismicCacheTags } from \"./getPrismicCacheTags\";\n\nexport function cacheTagPrismicPages(pages: PrismicDocument[]) {\n\tcacheTag(...getPrismicCacheTags(pages));\n}\n"],"names":["cacheTag","getPrismicCacheTags"],"mappings":";;;;AAIM,SAAU,qBAAqB,OAAwB;AACnDA,iBAAA,GAAGC,wCAAoB,KAAK,CAAC;AACvC;;"}

package/dist/cacheTagPrismicPages.d.ts

@@ -0,0 +1,2 @@
+import { PrismicDocument } from "@prismicio/client";
+export declare function cacheTagPrismicPages(pages: PrismicDocument[]): void;

package/dist/getPrismicCacheTags.cjs

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const CACHE_TAG_PREFIX = "prismic/";
+function getPrismicCacheTags(pages) {
+  const ids = [...new Set(getPrismicDocumentIDs(pages))];
+  return ids.map((id) => buildPrismicCacheTag(id));
+}
+function buildPrismicCacheTag(id) {
+  return `${CACHE_TAG_PREFIX}${id}`;
+}
+function getPrismicDocumentIDs(input) {
+  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") {
+    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((input2) => getPrismicDocumentIDs(input2));
+}
+exports.buildPrismicCacheTag = buildPrismicCacheTag;
+exports.getPrismicCacheTags = getPrismicCacheTags;
+//# sourceMappingURL=getPrismicCacheTags.cjs.map

package/dist/getPrismicCacheTags.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPrismicCacheTags.cjs","sources":["../src/getPrismicCacheTags.ts"],"sourcesContent":["import { PrismicDocument } from \"@prismicio/client\";\n\nconst CACHE_TAG_PREFIX = \"prismic/\";\n\n/**\n * Generates cache tags for a set of Prismic pages. Tags for linked pages (e.g.\n * a content relationship) are included to ensure all related content can be\n * revalidated.\n *\n * @param pages - A set of Prismic pages used to tag the function.\n *\n * @see {@link https://nextjs.org/docs/app/api-reference/functions/cacheTag}\n */\nexport function getPrismicCacheTags(pages: PrismicDocument[]): string[] {\n\tconst ids = [...new Set(getPrismicDocumentIDs(pages))];\n\treturn ids.map((id) => buildPrismicCacheTag(id));\n}\n\nexport function buildPrismicCacheTag(id: string): string {\n\treturn `${CACHE_TAG_PREFIX}${id}`;\n}\n\nfunction getPrismicDocumentIDs(input: unknown): string[] {\n\tif (typeof input !== \"object\" || input == null) return [];\n\n\tif (Array.isArray(input))\n\t\treturn input.flatMap((item) => getPrismicDocumentIDs(item));\n\n\tif (\"id\" in input && typeof input.id === \"string\") {\n\t\t// Document\n\t\t// Content relationship or link\n\t\tif (\n\t\t\t(\"href\" in input &&\n\t\t\t\ttypeof input.href === \"string\" &&\n\t\t\t\tinput.href.includes(\"/api/v2/documents/search?\")) ||\n\t\t\t(\"link_type\" in input && input.link_type === \"Document\")\n\t\t) {\n\t\t\tif (\n\t\t\t\t\"data\" in input &&\n\t\t\t\ttypeof input.data === \"object\" &&\n\t\t\t\tinput.data !== null\n\t\t\t) {\n\t\t\t\treturn [input.id, ...getPrismicDocumentIDs(input.data)];\n\t\t\t} else {\n\t\t\t\treturn [input.id];\n\t\t\t}\n\t\t}\n\t}\n\n\treturn Object.values(input).flatMap((input) => getPrismicDocumentIDs(input));\n}\n"],"names":["input"],"mappings":";;AAEA,MAAM,mBAAmB;AAWnB,SAAU,oBAAoB,OAAwB;AACrD,QAAA,MAAM,CAAC,GAAG,IAAI,IAAI,sBAAsB,KAAK,CAAC,CAAC;AACrD,SAAO,IAAI,IAAI,CAAC,OAAO,qBAAqB,EAAE,CAAC;AAChD;AAEM,SAAU,qBAAqB,IAAU;AACvC,SAAA,GAAG,gBAAgB,GAAG,EAAE;AAChC;AAEA,SAAS,sBAAsB,OAAc;AACxC,MAAA,OAAO,UAAU,YAAY,SAAS;AAAM,WAAO;AAEnD,MAAA,MAAM,QAAQ,KAAK;AACtB,WAAO,MAAM,QAAQ,CAAC,SAAS,sBAAsB,IAAI,CAAC;AAE3D,MAAI,QAAQ,SAAS,OAAO,MAAM,OAAO,UAAU;AAGlD,QACE,UAAU,SACV,OAAO,MAAM,SAAS,YACtB,MAAM,KAAK,SAAS,2BAA2B,KAC/C,eAAe,SAAS,MAAM,cAAc,YAC5C;AAEA,UAAA,UAAU,SACV,OAAO,MAAM,SAAS,YACtB,MAAM,SAAS,MACd;AACD,eAAO,CAAC,MAAM,IAAI,GAAG,sBAAsB,MAAM,IAAI,CAAC;AAAA,MAAA,OAChD;AACC,eAAA,CAAC,MAAM,EAAE;AAAA,MAAA;AAAA,IACjB;AAAA,EACD;AAGM,SAAA,OAAO,OAAO,KAAK,EAAE,QAAQ,CAACA,WAAU,sBAAsBA,MAAK,CAAC;AAC5E;;;"}

package/dist/getPrismicCacheTags.d.ts

@@ -0,0 +1,12 @@
+import { PrismicDocument } from "@prismicio/client";
+/**
+ * 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.
+ *
+ * @see {@link https://nextjs.org/docs/app/api-reference/functions/cacheTag}
+ */
+export declare function getPrismicCacheTags(pages: PrismicDocument[]): string[];
+export declare function buildPrismicCacheTag(id: string): string;

package/dist/index.cjs

@@ -8,6 +8,9 @@ const redirectToPreviewURL = require("./redirectToPreviewURL.cjs");
 const PrismicNextImage = require("./PrismicNextImage.cjs");
 const imgixLoader = require("./imgixLoader.cjs");
 const createLocaleRedirect = require("./createLocaleRedirect.cjs");
+const getPrismicCacheTags = require("./getPrismicCacheTags.cjs");
+const cacheTagPrismicPages = require("./cacheTagPrismicPages.cjs");
+const revalidatePrismicPages = require("./revalidatePrismicPages.cjs");
 exports.exitPreview = exitPreview.exitPreview;
 exports.PrismicPreview = PrismicPreview.PrismicPreview;
 exports.PrismicNextLink = PrismicNextLink.PrismicNextLink;
@@ -16,4 +19,7 @@ exports.redirectToPreviewURL = redirectToPreviewURL.redirectToPreviewURL;
 exports.PrismicNextImage = PrismicNextImage.PrismicNextImage;
 exports.imgixLoader = imgixLoader.imgixLoader;
 exports.createLocaleRedirect = createLocaleRedirect.createLocaleRedirect;
+exports.getPrismicCacheTags = getPrismicCacheTags.getPrismicCacheTags;
+exports.cacheTagPrismicPages = cacheTagPrismicPages.cacheTagPrismicPages;
+exports.revalidatePrismicPages = revalidatePrismicPages.revalidatePrismicPages;
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -13,3 +13,6 @@ export { imgixLoader } from "./imgixLoader";
 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/dist/package.json.cjs

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const version = "2.0.2-pr.113.86a90db";
+const version = "2.0.2-pr.114.50610a2";
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.map

package/dist/revalidatePrismicPages.cjs

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const cache = require("next/cache");
+const getPrismicCacheTags = require("./getPrismicCacheTags.cjs");
+function revalidatePrismicPages(ids) {
+  for (const id of ids) {
+    const tag = getPrismicCacheTags.buildPrismicCacheTag(id);
+    cache.revalidateTag(tag, { expire: 0 });
+  }
+}
+exports.revalidatePrismicPages = revalidatePrismicPages;
+//# sourceMappingURL=revalidatePrismicPages.cjs.map

package/dist/revalidatePrismicPages.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"revalidatePrismicPages.cjs","sources":["../src/revalidatePrismicPages.ts"],"sourcesContent":["import { revalidateTag } from \"next/cache\";\nimport { buildPrismicCacheTag } from \"./getPrismicCacheTags\";\n\n/**\n * Immediately revalidates a set of Prismic pages given a list of their IDs. The\n * list of IDs typically comes from a Prismic webhook triggered when publishing\n * content.\n *\n * @param ids - A list of Prismic page IDs to revalidate.\n *\n * @see {@link https://nextjs.org/docs/app/api-reference/functions/revalidateTag}\n */\nexport function revalidatePrismicPages(ids: string[]): void {\n\tfor (const id of ids) {\n\t\tconst tag = buildPrismicCacheTag(id);\n\t\trevalidateTag(tag, { expire: 0 });\n\t}\n}\n"],"names":["buildPrismicCacheTag","revalidateTag"],"mappings":";;;;AAYM,SAAU,uBAAuB,KAAa;AACnD,aAAW,MAAM,KAAK;AACf,UAAA,MAAMA,yCAAqB,EAAE;AACnCC,UAAAA,cAAc,KAAK,EAAE,QAAQ,EAAA,CAAG;AAAA,EAAA;AAElC;;"}

package/dist/revalidatePrismicPages.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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.
+ *
+ * @see {@link https://nextjs.org/docs/app/api-reference/functions/revalidateTag}
+ */
+export declare function revalidatePrismicPages(ids: string[]): void;

package/package.json

@@ -4,7 +4,7 @@
 		"e2e-projects/*"
 	],
 	"name": "@prismicio/next",
-	"version": "2.0.2-pr.113.86a90db",
+	"version": "2.0.2-pr.114.50610a2",
 	"description": "Helpers to integrate Prismic into Next.js apps",
 	"keywords": [
 		"typescript",
@@ -68,7 +68,7 @@
 	"devDependencies": {
 		"@eslint/js": "^9.17.0",
 		"@playwright/test": "^1.49.1",
-		"@prismicio/client": "^7.12.0",
+		"@prismicio/client": "^7.21.0",
 		"@prismicio/types-internal": "^3.3.0",
 		"@rollup/plugin-typescript": "^12.1.2",
 		"@size-limit/preset-small-lib": "^11.1.6",

package/src/cacheTagPrismicPages.ts

@@ -0,0 +1,7 @@
+import { PrismicDocument } from "@prismicio/client";
+import { cacheTag } from "next/cache";
+import { getPrismicCacheTags } from "./getPrismicCacheTags";
+
+export function cacheTagPrismicPages(pages: PrismicDocument[]) {
+	cacheTag(...getPrismicCacheTags(pages));
+}

package/src/getPrismicCacheTags.ts

@@ -0,0 +1,51 @@
+import { 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.
+ *
+ * @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/index.ts

@@ -21,3 +21,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/revalidatePrismicPages.ts

@@ -0,0 +1,18 @@
+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.
+ *
+ * @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 });
+	}
+}