@prismicio/next 0.1.2 → 0.1.4

package/src/types.ts

@@ -1,6 +1,5 @@
-import { PreviewData, NextApiRequest, NextApiResponse } from "next";
-import { LinkResolverFunction } from "@prismicio/helpers";
-import { Client } from "@prismicio/client";
+import type { PreviewData, NextApiRequest } from "next";
+import type { ClientConfig } from "@prismicio/client";
 
 /**
  * Configuration for creating a Prismic client with automatic preview support in
@@ -21,49 +20,4 @@ export type CreateClientConfig = {
 	 * Pass a `req` object when using in a Next.js API endpoint.
 	 */
 	req?: NextApiRequest;
-};
-
-/**
- * Preview config for enabling previews with redirectToPreviewURL
- */
-export type PreviewConfig<
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	TLinkResolverFunction extends LinkResolverFunction<any> = LinkResolverFunction,
-> = {
-	/**
-	 * The `req` object from a Next.js API route. This is given as a parameter to
-	 * the API route.
-	 *
-	 * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}
-	 */
-	req: {
-		query: NextApiRequest["query"];
-	};
-
-	/**
-	 * The `res` object from a Next.js API route. This is given as a parameter to
-	 * the API route.
-	 *
-	 * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}
-	 */
-	res: {
-		redirect: NextApiResponse["redirect"];
-	};
-
-	/**
-	 * The Prismic client configured for the preview session's repository.
-	 */
-	client: Client;
-
-	/**
-	 * 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?: TLinkResolverFunction;
-
-	/**
-	 * The default redirect URL if a URL cannot be determined for the previewed document.
-	 */
-	defaultURL?: string;
-};
+} & ClientConfig;

package/dist/index.cjs

@@ -1,184 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const prismic = require('@prismicio/client');
-const React = require('react');
-const react = require('@prismicio/react');
-const router = require('next/router');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-function _interopNamespace(e) {
-	if (e && e.__esModule) return e;
-	const n = Object.create(null);
-	if (e) {
-		for (const k in e) {
-			if (k !== 'default') {
-				const d = Object.getOwnPropertyDescriptor(e, k);
-				Object.defineProperty(n, k, d.get ? d : {
-					enumerable: true,
-					get: function () { return e[k]; }
-				});
-			}
-		}
-	}
-	n["default"] = e;
-	return Object.freeze(n);
-}
-
-const prismic__namespace = /*#__PURE__*/_interopNamespace(prismic);
-const React__default = /*#__PURE__*/_interopDefaultLegacy(React);
-
-function setPreviewData({ req, res }) {
-  const ref = req.query.token || req.cookies[prismic__namespace.cookie.preview];
-  if (ref) {
-    res.setPreviewData({ ref });
-  }
-}
-
-function exitPreview(config) {
-  const { req } = config;
-  config.res.clearPreviewData();
-  if (req.headers.referer) {
-    const url = new URL(req.headers.referer);
-    if (url.pathname !== "/api/exit-preview") {
-      config.res.redirect(req.headers.referer);
-      return;
-    }
-  }
-  config.res.redirect("/");
-}
-
-const readValue = (value) => {
-  return value.replace(/%3B/g, ";");
-};
-const parse = (cookieString) => {
-  const result = {};
-  const cookies = cookieString.split("; ");
-  for (const cookie of cookies) {
-    const parts = cookie.split("=");
-    const value = parts.slice(1).join("=");
-    const name = readValue(parts[0]).replace(/%3D/g, "=");
-    result[name] = readValue(value);
-  }
-  return result;
-};
-const getAll = (cookieStore) => parse(cookieStore);
-const getCookie = (name, cookieStore) => getAll(cookieStore)[name];
-
-const extractFirstSubdomain = (host) => host.split(".")[0];
-const extractRepositoryNameFromObjectRef = (previewRef) => {
-  try {
-    const parsed = JSON.parse(decodeURIComponent(previewRef));
-    const keys = Object.keys(parsed);
-    const domainKey = keys.find((key) => /\.prismic\.io$/.test(key));
-    if (domainKey) {
-      return extractFirstSubdomain(domainKey);
-    } else {
-      return void 0;
-    }
-  } catch (e) {
-    return void 0;
-  }
-};
-const extractRepositoryNameFromURLRef = (previewRef) => {
-  try {
-    const url = new URL(previewRef);
-    return extractFirstSubdomain(url.host);
-  } catch (e) {
-    return void 0;
-  }
-};
-const extractPreviewRefRepositoryName = (previewRef) => {
-  return extractRepositoryNameFromObjectRef(previewRef) || extractRepositoryNameFromURLRef(previewRef);
-};
-
-const isPrismicUpdateToolbarEvent = (event) => {
-  return "detail" in event && typeof event.detail.ref === "string";
-};
-function PrismicPreview({
-  repositoryName,
-  children,
-  updatePreviewURL = "/api/preview",
-  exitPreviewURL = "/api/exit-preview"
-}) {
-  const router$1 = router.useRouter();
-  React.useEffect(() => {
-    const previewRefRepositoryName = extractPreviewRefRepositoryName(getCookie("io.prismic.preview", globalThis.document.cookie));
-    const startPreviewIfLoadedFromSharedLink = async () => {
-      if (previewRefRepositoryName === repositoryName && !router$1.isPreview) {
-        await fetch(updatePreviewURL);
-        window.location.reload();
-      }
-    };
-    startPreviewIfLoadedFromSharedLink();
-    const handlePrismicPreviewUpdate = async (event) => {
-      if (isPrismicUpdateToolbarEvent(event)) {
-        event.preventDefault();
-        await fetch(updatePreviewURL);
-        window.location.reload();
-      }
-    };
-    const handlePrismicPreviewEnd = async (event) => {
-      event.preventDefault();
-      await fetch(exitPreviewURL);
-      window.location.reload();
-    };
-    if (window) {
-      window.addEventListener("prismicPreviewUpdate", handlePrismicPreviewUpdate);
-      window.addEventListener("prismicPreviewEnd", handlePrismicPreviewEnd);
-    }
-    return () => {
-      if (window) {
-        window.removeEventListener("prismicPreviewUpdate", handlePrismicPreviewUpdate);
-        window.removeEventListener("prismicPreviewEnd", handlePrismicPreviewEnd);
-      }
-    };
-  }, []);
-  return /* @__PURE__ */ React__default["default"].createElement(React__default["default"].Fragment, null, /* @__PURE__ */ React__default["default"].createElement(react.PrismicToolbar, {
-    repositoryName
-  }), children);
-}
-
-const isPrismicNextPreviewData = (previewData) => {
-  return typeof previewData === "object" && "ref" in previewData;
-};
-const enableAutoPreviews = (config) => {
-  if ("previewData" in config && config.previewData) {
-    const { previewData } = config;
-    if (isPrismicNextPreviewData(previewData) && previewData.ref) {
-      config.client.queryContentFromRef(previewData.ref);
-    }
-  } else if ("req" in config && config.req) {
-    config.client.enableAutoPreviewsFromReq(config.req);
-  }
-};
-
-const isPrismicNextQuery = (query) => typeof query.documentId === "string" && typeof query.token === "string";
-async function redirectToPreviewURL({
-  req,
-  res,
-  client,
-  linkResolver,
-  defaultURL = "/"
-}) {
-  if (isPrismicNextQuery(req.query)) {
-    const { documentId, token } = req.query;
-    const previewUrl = await client.resolvePreviewURL({
-      linkResolver,
-      defaultURL,
-      documentID: documentId,
-      previewToken: token
-    });
-    res.redirect(previewUrl);
-    return;
-  }
-  res.redirect(defaultURL);
-}
-
-exports.PrismicPreview = PrismicPreview;
-exports.enableAutoPreviews = enableAutoPreviews;
-exports.exitPreview = exitPreview;
-exports.redirectToPreviewURL = redirectToPreviewURL;
-exports.setPreviewData = setPreviewData;

package/dist/index.js

@@ -1,153 +0,0 @@
-import * as prismic from '@prismicio/client';
-import React, { useEffect } from 'react';
-import { PrismicToolbar } from '@prismicio/react';
-import { useRouter } from 'next/router';
-
-function setPreviewData({ req, res }) {
-  const ref = req.query.token || req.cookies[prismic.cookie.preview];
-  if (ref) {
-    res.setPreviewData({ ref });
-  }
-}
-
-function exitPreview(config) {
-  const { req } = config;
-  config.res.clearPreviewData();
-  if (req.headers.referer) {
-    const url = new URL(req.headers.referer);
-    if (url.pathname !== "/api/exit-preview") {
-      config.res.redirect(req.headers.referer);
-      return;
-    }
-  }
-  config.res.redirect("/");
-}
-
-const readValue = (value) => {
-  return value.replace(/%3B/g, ";");
-};
-const parse = (cookieString) => {
-  const result = {};
-  const cookies = cookieString.split("; ");
-  for (const cookie of cookies) {
-    const parts = cookie.split("=");
-    const value = parts.slice(1).join("=");
-    const name = readValue(parts[0]).replace(/%3D/g, "=");
-    result[name] = readValue(value);
-  }
-  return result;
-};
-const getAll = (cookieStore) => parse(cookieStore);
-const getCookie = (name, cookieStore) => getAll(cookieStore)[name];
-
-const extractFirstSubdomain = (host) => host.split(".")[0];
-const extractRepositoryNameFromObjectRef = (previewRef) => {
-  try {
-    const parsed = JSON.parse(decodeURIComponent(previewRef));
-    const keys = Object.keys(parsed);
-    const domainKey = keys.find((key) => /\.prismic\.io$/.test(key));
-    if (domainKey) {
-      return extractFirstSubdomain(domainKey);
-    } else {
-      return void 0;
-    }
-  } catch (e) {
-    return void 0;
-  }
-};
-const extractRepositoryNameFromURLRef = (previewRef) => {
-  try {
-    const url = new URL(previewRef);
-    return extractFirstSubdomain(url.host);
-  } catch (e) {
-    return void 0;
-  }
-};
-const extractPreviewRefRepositoryName = (previewRef) => {
-  return extractRepositoryNameFromObjectRef(previewRef) || extractRepositoryNameFromURLRef(previewRef);
-};
-
-const isPrismicUpdateToolbarEvent = (event) => {
-  return "detail" in event && typeof event.detail.ref === "string";
-};
-function PrismicPreview({
-  repositoryName,
-  children,
-  updatePreviewURL = "/api/preview",
-  exitPreviewURL = "/api/exit-preview"
-}) {
-  const router = useRouter();
-  useEffect(() => {
-    const previewRefRepositoryName = extractPreviewRefRepositoryName(getCookie("io.prismic.preview", globalThis.document.cookie));
-    const startPreviewIfLoadedFromSharedLink = async () => {
-      if (previewRefRepositoryName === repositoryName && !router.isPreview) {
-        await fetch(updatePreviewURL);
-        window.location.reload();
-      }
-    };
-    startPreviewIfLoadedFromSharedLink();
-    const handlePrismicPreviewUpdate = async (event) => {
-      if (isPrismicUpdateToolbarEvent(event)) {
-        event.preventDefault();
-        await fetch(updatePreviewURL);
-        window.location.reload();
-      }
-    };
-    const handlePrismicPreviewEnd = async (event) => {
-      event.preventDefault();
-      await fetch(exitPreviewURL);
-      window.location.reload();
-    };
-    if (window) {
-      window.addEventListener("prismicPreviewUpdate", handlePrismicPreviewUpdate);
-      window.addEventListener("prismicPreviewEnd", handlePrismicPreviewEnd);
-    }
-    return () => {
-      if (window) {
-        window.removeEventListener("prismicPreviewUpdate", handlePrismicPreviewUpdate);
-        window.removeEventListener("prismicPreviewEnd", handlePrismicPreviewEnd);
-      }
-    };
-  }, []);
-  return /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement(PrismicToolbar, {
-    repositoryName
-  }), children);
-}
-
-const isPrismicNextPreviewData = (previewData) => {
-  return typeof previewData === "object" && "ref" in previewData;
-};
-const enableAutoPreviews = (config) => {
-  if ("previewData" in config && config.previewData) {
-    const { previewData } = config;
-    if (isPrismicNextPreviewData(previewData) && previewData.ref) {
-      config.client.queryContentFromRef(previewData.ref);
-    }
-  } else if ("req" in config && config.req) {
-    config.client.enableAutoPreviewsFromReq(config.req);
-  }
-};
-
-const isPrismicNextQuery = (query) => typeof query.documentId === "string" && typeof query.token === "string";
-async function redirectToPreviewURL({
-  req,
-  res,
-  client,
-  linkResolver,
-  defaultURL = "/"
-}) {
-  if (isPrismicNextQuery(req.query)) {
-    const { documentId, token } = req.query;
-    const previewUrl = await client.resolvePreviewURL({
-      linkResolver,
-      defaultURL,
-      documentID: documentId,
-      previewToken: token
-    });
-    res.redirect(previewUrl);
-    return;
-  }
-  res.redirect(defaultURL);
-}
-
-export { PrismicPreview, enableAutoPreviews, exitPreview, redirectToPreviewURL, setPreviewData };

package/src/lib/extractPreviewRefRepositoryName.ts

@@ -1,60 +0,0 @@
-/**
- * Returns the repository name from an object-style Prismic ref.
- *
- * @param host - Host string
- */
-const extractFirstSubdomain = (host: string): string => host.split(".")[0];
-
-/**
- * Parses ref object from cookie and returns proper preview link
- *
- * @param previewRef - Prismic Preview reference
- */
-const extractRepositoryNameFromObjectRef = (
-	previewRef: string,
-): string | undefined => {
-	try {
-		const parsed = JSON.parse(decodeURIComponent(previewRef));
-		const keys = Object.keys(parsed);
-		const domainKey = keys.find((key) => /\.prismic\.io$/.test(key));
-
-		if (domainKey) {
-			return extractFirstSubdomain(domainKey);
-		} else {
-			return undefined;
-		}
-	} catch {
-		return undefined;
-	}
-};
-
-/**
- * Returns the repository name from a URL-style Prismic ref.
- *
- * @param previewRef - Preview ref from getCookie()
- */
-const extractRepositoryNameFromURLRef = (
-	previewRef: string,
-): string | undefined => {
-	try {
-		const url = new URL(previewRef);
-
-		return extractFirstSubdomain(url.host);
-	} catch {
-		return undefined;
-	}
-};
-
-/**
- * Extracts preview reference repo name from stringified Prismic preview cookie
- *
- * @param previewRef - Preview Reference
- */
-export const extractPreviewRefRepositoryName = (
-	previewRef: string,
-): string | undefined => {
-	return (
-		extractRepositoryNameFromObjectRef(previewRef) ||
-		extractRepositoryNameFromURLRef(previewRef)
-	);
-};

package/src/lib/getCookie.ts

@@ -1,58 +0,0 @@
-/**
- * The following code is a modifed version of `es-cookie` taken from
- * https://github.com/theodorejb/es-cookie
- *
- * Copyright 2017 Theodore Brown
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.*
- */
-
-const readValue = (value: string): string => {
-	return value.replace(/%3B/g, ";");
-};
-
-export const parse = (cookieString: string): { [name: string]: string } => {
-	const result: { [name: string]: string } = {};
-	const cookies = cookieString.split("; ");
-
-	for (const cookie of cookies) {
-		const parts = cookie.split("=");
-		const value = parts.slice(1).join("=");
-		const name = readValue(parts[0]).replace(/%3D/g, "=");
-		result[name] = readValue(value);
-	}
-
-	return result;
-};
-
-const getAll = (cookieStore: string): { [name: string]: string } =>
-	parse(cookieStore);
-
-/**
- * Returns the value of a cookie from a given cookie store.
- *
- * @param name - Of the cookie.
- * @param cookieStore - The stringified cookie store from which to read the cookie.
- *
- * @returns The value of the cookie, if it exists.
- */
-export const getCookie = (
-	name: string,
-	cookieStore: string,
-): string | undefined => getAll(cookieStore)[name];