@prismicio/next 2.2.0 → 2.2.1-pr.130.87623c1

package/dist/pages/redirectToPreviewURL.d.ts

@@ -0,0 +1,48 @@
+import { NextApiRequestLike, NextApiResponseLike } from "./types.js";
+import { Client, LinkResolverFunction } from "@prismicio/client";
+
+//#region src/pages/redirectToPreviewURL.d.ts
+type RedirectToPreviewURLConfig = {
+  /** The Prismic client configured for the preview session's repository. */
+  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;
+  /**
+   * 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;
+  /**
+   * 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;
+  /**
+   * 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.
+   */
+  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`.
+   *
+   * @remarks
+   * The Router Handler or API route is unable to detect the app's `basePath`
+   * automatically. It must be provided to `redirectToPreviewURL()` manually.
+   */
+  basePath?: string;
+};
+declare function redirectToPreviewURL(config: RedirectToPreviewURLConfig): Promise<void>;
+//#endregion
+export { RedirectToPreviewURLConfig, redirectToPreviewURL };
+//# sourceMappingURL=redirectToPreviewURL.d.ts.map

package/dist/pages/redirectToPreviewURL.js

@@ -0,0 +1,15 @@
+//#region src/pages/redirectToPreviewURL.ts
+async function redirectToPreviewURL(config) {
+	const { client, req, res, linkResolver, defaultURL = "/", basePath = "" } = config;
+	const previewToken = req.query.token?.toString();
+	const previewURL = await client.resolvePreviewURL({
+		linkResolver,
+		defaultURL,
+		previewToken
+	});
+	res.redirect(basePath + previewURL);
+}
+
+//#endregion
+export { redirectToPreviewURL };
+//# sourceMappingURL=redirectToPreviewURL.js.map

package/dist/pages/redirectToPreviewURL.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirectToPreviewURL.js","names":[],"sources":["../../src/pages/redirectToPreviewURL.ts"],"sourcesContent":["import type { LinkResolverFunction, Client } from \"@prismicio/client\";\n\nimport type { NextApiRequestLike, NextApiResponseLike } from \"./types\";\n\nexport type RedirectToPreviewURLConfig = {\n\t/** The Prismic client configured for the preview session's repository. */\n\t// `Pick` is used to use the smallest possible subset of\n\t// `prismic.Client`. Doing this reduces the surface area for breaking\n\t// type changes.\n\tclient: Pick<Client, \"resolvePreviewURL\">;\n\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/pages/building-your-application/routing/api-routes\\>\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/pages/building-your-application/routing/api-routes\\>\n\t */\n\tres: NextApiResponseLike;\n\n\t/**\n\t * A Link Resolver used to resolve the previewed document's URL.\n\t *\n\t * @see To learn more about Link Resolver: {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver}\n\t */\n\tlinkResolver?: LinkResolverFunction;\n\n\t/**\n\t * The default redirect URL if a URL cannot be determined for the previewed\n\t * document.\n\t *\n\t * **Note**: If you `next.config.js` file contains a `basePath`, the\n\t * `defaultURL` option must _not_ include it. Instead, provide the `basePath`\n\t * property using the `basePath` option.\n\t */\n\tdefaultURL?: string;\n\n\t/**\n\t * The `basePath` for the Next.js app as it is defined in `next.config.js`.\n\t * This option can be omitted if the app does not have a `basePath`.\n\t *\n\t * @remarks\n\t * The Router Handler or API route is unable to detect the app's `basePath`\n\t * automatically. It must be provided to `redirectToPreviewURL()` manually.\n\t */\n\tbasePath?: string;\n};\n\nexport async function redirectToPreviewURL(\n\tconfig: RedirectToPreviewURLConfig,\n): Promise<void> {\n\tconst {\n\t\tclient,\n\t\treq,\n\t\tres,\n\t\tlinkResolver,\n\t\tdefaultURL = \"/\",\n\t\tbasePath = \"\",\n\t} = config;\n\n\tconst previewToken = req.query.token?.toString();\n\n\tconst previewURL = await client.resolvePreviewURL({\n\t\tlinkResolver,\n\t\tdefaultURL,\n\t\tpreviewToken,\n\t});\n\n\tres.redirect(basePath + previewURL);\n\n\treturn;\n}\n"],"mappings":";AAqDA,eAAsB,qBACrB,QACgB;CAChB,MAAM,EACL,QACA,KACA,KACA,cACA,aAAa,KACb,WAAW,OACR;CAEJ,MAAM,eAAe,IAAI,MAAM,OAAO,UAAU;CAEhD,MAAM,aAAa,MAAM,OAAO,kBAAkB;EACjD;EACA;EACA;EACA,CAAC;AAEF,KAAI,SAAS,WAAW,WAAW"}

package/dist/pages/setPreviewData.d.ts

@@ -0,0 +1,26 @@
+import { NextApiRequestLike, NextApiResponseLike } from "./types.js";
+
+//#region src/pages/setPreviewData.d.ts
+/** Configuration for `setPreviewData`. */
+type SetPreviewDataConfig = {
+  /**
+   * The `req` object from a Next.js API route.
+   *
+   * @see Next.js API route docs: \<https://nextjs.org/docs/api-routes/introduction\>
+   */
+  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;
+};
+/** Set Prismic preview data for Next.js's Preview Mode. */
+declare function setPreviewData({
+  req,
+  res
+}: SetPreviewDataConfig): void;
+//#endregion
+export { SetPreviewDataConfig, setPreviewData };
+//# sourceMappingURL=setPreviewData.d.ts.map

package/dist/pages/setPreviewData.js

@@ -0,0 +1,12 @@
+import { cookie } from "@prismicio/client";
+
+//#region src/pages/setPreviewData.ts
+/** Set Prismic preview data for Next.js's Preview Mode. */
+function setPreviewData({ req, res }) {
+	const ref = req.query.token || req.cookies[cookie.preview];
+	if (ref) res.setPreviewData({ ref });
+}
+
+//#endregion
+export { setPreviewData };
+//# sourceMappingURL=setPreviewData.js.map

package/dist/pages/setPreviewData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setPreviewData.js","names":[],"sources":["../../src/pages/setPreviewData.ts"],"sourcesContent":["import { cookie } from \"@prismicio/client\";\n\nimport type { NextApiRequestLike, NextApiResponseLike } from \"./types\";\n\n/** Configuration for `setPreviewData`. */\nexport type SetPreviewDataConfig = {\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/** Set Prismic preview data for Next.js's Preview Mode. */\nexport function setPreviewData({ req, res }: SetPreviewDataConfig): void {\n\tconst ref = req.query.token || req.cookies[cookie.preview];\n\n\tif (ref) {\n\t\tres.setPreviewData({ ref });\n\t}\n}\n"],"mappings":";;;;AAsBA,SAAgB,eAAe,EAAE,KAAK,OAAmC;CACxE,MAAM,MAAM,IAAI,MAAM,SAAS,IAAI,QAAQ,OAAO;AAElD,KAAI,IACH,KAAI,eAAe,EAAE,KAAK,CAAC"}

package/dist/pages/types.d.ts

@@ -0,0 +1,36 @@
+import { EnableAutoPreviewsConfig } from "./enableAutoPreviews.js";
+import { ClientConfig } from "@prismicio/client";
+
+//#region src/pages/types.d.ts
+
+/**
+ * Configuration for creating a Prismic client with automatic preview support in
+ * Next.js apps.
+ */
+type CreateClientConfig = ClientConfig & 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.
+ */
+type NextApiRequestLike = {
+  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.
+ */
+type NextApiResponseLike = {
+  redirect(url: string): NextApiResponseLike;
+  clearPreviewData(): NextApiResponseLike;
+  setHeader(name: string, value: string | string[]): NextApiResponseLike;
+  json(body: any): void;
+  setPreviewData(data: object | string): NextApiResponseLike;
+};
+//#endregion
+export { CreateClientConfig, NextApiRequestLike, NextApiResponseLike };
+//# sourceMappingURL=types.d.ts.map

package/dist/pages.d.ts

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

package/dist/pages.js

@@ -0,0 +1,12 @@
+import { PrismicNextLink } from "./PrismicNextLink.js";
+import { imgixLoader } from "./imgixLoader.js";
+import { PrismicNextImage } from "./PrismicNextImage.js";
+import { createLocaleRedirect } from "./createLocaleRedirect.js";
+import { SliceSimulator } from "./pages/SliceSimulator.js";
+import { PrismicPreview } from "./pages/PrismicPreview.js";
+import { enableAutoPreviews } from "./pages/enableAutoPreviews.js";
+import { redirectToPreviewURL } from "./pages/redirectToPreviewURL.js";
+import { exitPreview } from "./pages/exitPreview.js";
+import { setPreviewData } from "./pages/setPreviewData.js";
+
+export { PrismicNextImage, PrismicNextLink, PrismicPreview, SliceSimulator, createLocaleRedirect, enableAutoPreviews, exitPreview, imgixLoader, redirectToPreviewURL, setPreviewData };

package/dist/redirectToPreviewURL.d.ts

@@ -0,0 +1,33 @@
+import { NextRequestLike } from "./types.js";
+import { Client, LinkResolverFunction } from "@prismicio/client";
+
+//#region src/redirectToPreviewURL.d.ts
+type RedirectToPreviewURLConfig = {
+  /** The Prismic client configured for the preview session's repository. */
+  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;
+  /**
+   * 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;
+  /**
+   * 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.
+   */
+  defaultURL?: string;
+};
+declare function redirectToPreviewURL(config: RedirectToPreviewURLConfig): Promise<never>;
+//#endregion
+export { RedirectToPreviewURLConfig, redirectToPreviewURL };
+//# sourceMappingURL=redirectToPreviewURL.d.ts.map

package/dist/redirectToPreviewURL.js

@@ -0,0 +1,23 @@
+import { cookie } from "@prismicio/client";
+import { redirect } from "next/navigation";
+
+//#region src/redirectToPreviewURL.ts
+async function redirectToPreviewURL(config) {
+	const { client, request, linkResolver, defaultURL = "/" } = config;
+	const { cookies, draftMode } = await import("next/headers");
+	const documentID = request.nextUrl.searchParams.get("documentId") ?? void 0;
+	const previewToken = request.nextUrl.searchParams.get("token") ?? void 0;
+	if (previewToken) (await cookies()).set(cookie.preview, previewToken);
+	const previewURL = await client.resolvePreviewURL({
+		documentID,
+		previewToken,
+		defaultURL,
+		linkResolver
+	});
+	(await draftMode()).enable();
+	redirect(previewURL);
+}
+
+//#endregion
+export { redirectToPreviewURL };
+//# sourceMappingURL=redirectToPreviewURL.js.map

package/dist/redirectToPreviewURL.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirectToPreviewURL.js","names":["prismicCookie"],"sources":["../src/redirectToPreviewURL.ts"],"sourcesContent":["import { redirect } from \"next/navigation\";\nimport {\n\tcookie as prismicCookie,\n\ttype Client,\n\ttype LinkResolverFunction,\n} from \"@prismicio/client\";\n\nimport type { NextRequestLike } from \"./types\";\n\nexport type RedirectToPreviewURLConfig = {\n\t/** The Prismic client configured for the preview session's repository. */\n\t// `Pick` is used to use the smallest possible subset of\n\t// `prismic.Client`. Doing this reduces the surface area for breaking\n\t// type changes.\n\tclient: Pick<Client, \"resolvePreviewURL\">;\n\n\t/**\n\t * The `request` object from a Next.js Route Handler.\n\t *\n\t * @see Next.js Route Handler docs: \\<https://nextjs.org/docs/app/building-your-application/routing/route-handlers\\>\n\t */\n\trequest: NextRequestLike;\n\n\t/**\n\t * A Link Resolver used to resolve the previewed document's URL.\n\t *\n\t * @see To learn more about Link Resolver: {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver}\n\t */\n\tlinkResolver?: LinkResolverFunction;\n\n\t/**\n\t * The default redirect URL if a URL cannot be determined for the previewed\n\t * document.\n\t *\n\t * **Note**: If you `next.config.js` file contains a `basePath`, the\n\t * `defaultURL` option must _not_ include it. Instead, provide the `basePath`\n\t * property using the `basePath` option.\n\t */\n\tdefaultURL?: string;\n};\n\nexport async function redirectToPreviewURL(\n\tconfig: RedirectToPreviewURLConfig,\n): Promise<never> {\n\tconst { client, request, linkResolver, defaultURL = \"/\" } = config;\n\n\t// Need this to avoid the following Next.js build-time error:\n\t// You're importing a component that needs next/headers. That only works\n\t// in a Server Component which is not supported in the pages/ directory.\n\tconst { cookies, draftMode } = await import(\"next/headers\");\n\n\tconst documentID =\n\t\trequest.nextUrl.searchParams.get(\"documentId\") ?? undefined;\n\n\t// Set the initial preview cookie. Setting the cookie here is necessary\n\t// to support unpublished previews. Without setting it here, the page\n\t// will try to render without the preview cookie, leading to a\n\t// PrismicNotFound error.\n\tconst previewToken = request.nextUrl.searchParams.get(\"token\") ?? undefined;\n\tif (previewToken) {\n\t\tconst cookieJar = await cookies();\n\t\tcookieJar.set(prismicCookie.preview, previewToken);\n\t}\n\n\tconst previewURL = await client.resolvePreviewURL({\n\t\tdocumentID,\n\t\tpreviewToken,\n\t\tdefaultURL,\n\t\tlinkResolver,\n\t});\n\n\t(await draftMode()).enable();\n\n\tredirect(previewURL);\n}\n"],"mappings":";;;;AAyCA,eAAsB,qBACrB,QACiB;CACjB,MAAM,EAAE,QAAQ,SAAS,cAAc,aAAa,QAAQ;CAK5D,MAAM,EAAE,SAAS,cAAc,MAAM,OAAO;CAE5C,MAAM,aACL,QAAQ,QAAQ,aAAa,IAAI,aAAa,IAAI;CAMnD,MAAM,eAAe,QAAQ,QAAQ,aAAa,IAAI,QAAQ,IAAI;AAClE,KAAI,aAEH,EADkB,MAAM,SAAS,EACvB,IAAIA,OAAc,SAAS,aAAa;CAGnD,MAAM,aAAa,MAAM,OAAO,kBAAkB;EACjD;EACA;EACA;EACA;EACA,CAAC;AAEF,EAAC,MAAM,WAAW,EAAE,QAAQ;AAE5B,UAAS,WAAW"}

package/dist/types.d.ts

@@ -0,0 +1,31 @@
+import { ClientConfig } from "@prismicio/client";
+
+//#region src/types.d.ts
+declare module "@prismicio/client" {
+  interface RequestInitLike {
+    next?: RequestInit["next"];
+  }
+}
+/** @deprecated Use `@prismicio/client`'s `ClientConfig`. */
+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.
+ */
+type NextRequestLike = {
+  headers: {
+    get(name: string): string | null;
+  };
+  url: string;
+  nextUrl: {
+    pathname: string;
+    searchParams: {
+      get(name: string): string | null;
+    };
+  };
+};
+//#endregion
+export { CreateClientConfig, NextRequestLike };
+//# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/next",
-	"version": "2.2.0",
+	"version": "2.2.1-pr.130.87623c1",
 	"description": "Helpers to integrate Prismic into Next.js apps",
 	"keywords": [
 		"typescript",
@@ -18,23 +18,18 @@
 	"sideEffects": false,
 	"type": "module",
 	"exports": {
-		".": "./dist/index.cjs",
-		"./pages": "./dist/pages.cjs",
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.cjs"
+		},
+		"./pages": {
+			"types": "./dist/pages.d.ts",
+			"default": "./dist/pages.cjs"
+		},
 		"./package.json": "./package.json"
 	},
 	"main": "./dist/index.cjs",
-	"module": "./dist/index.js",
-	"types": "./dist/index.d.cts",
-	"typesVersions": {
-		"*": {
-			"*": [
-				"./dist/index.d.ts"
-			],
-			"pages": [
-				"./dist/pages/index.d.ts"
-			]
-		}
-	},
+	"types": "./dist/index.d.ts",
 	"files": [
 		"dist",
 		"src"