@prismicio/next 0.1.4 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/PrismicNextImage.mjs +1 -0
- package/dist/PrismicNextImage.mjs.map +1 -0
- package/dist/PrismicPreview.mjs +1 -0
- package/dist/PrismicPreview.mjs.map +1 -0
- package/dist/enableAutoPreviews.mjs +1 -0
- package/dist/enableAutoPreviews.mjs.map +1 -0
- package/dist/exitPreview.mjs +1 -0
- package/dist/exitPreview.mjs.map +1 -0
- package/dist/index.mjs +1 -0
- package/dist/index.mjs.map +1 -0
- package/dist/lib/__PRODUCTION__.mjs +1 -0
- package/dist/lib/__PRODUCTION__.mjs.map +1 -0
- package/dist/lib/devMsg.mjs +1 -0
- package/dist/lib/devMsg.mjs.map +1 -0
- package/dist/lib/getPreviewCookieRepositoryName.mjs +1 -0
- package/dist/lib/getPreviewCookieRepositoryName.mjs.map +1 -0
- package/dist/lib/getPrismicPreviewCookie.mjs +1 -0
- package/dist/lib/getPrismicPreviewCookie.mjs.map +1 -0
- package/dist/package.mjs +2 -1
- package/dist/package.mjs.map +1 -0
- package/dist/redirectToPreviewURL.mjs +1 -0
- package/dist/redirectToPreviewURL.mjs.map +1 -0
- package/dist/setPreviewData.mjs +1 -0
- package/dist/setPreviewData.mjs.map +1 -0
- package/package.json +5 -2
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PrismicNextImage.mjs","sources":["../src/PrismicNextImage.tsx"],"sourcesContent":["import * as React from \"react\";\nimport Image, { ImageProps, ImageLoaderProps } from \"next/image\";\nimport { buildURL, ImgixURLParams } from \"imgix-url-builder\";\nimport * as prismicH from \"@prismicio/helpers\";\nimport * as prismicT from \"@prismicio/types\";\n\nimport { __PRODUCTION__ } from \"./lib/__PRODUCTION__\";\nimport { devMsg } from \"./lib/devMsg\";\n\n/**\n * Creates a `next/image` loader for Imgix, which Prismic uses, with an optional\n * collection of default Imgix parameters.\n *\n * @see To learn about `next/image` loaders: https://nextjs.org/docs/api-reference/next/image#loader\n * @see To learn about Imgix's URL API: https://docs.imgix.com/apis/rendering\n */\nconst imgixLoader = (args: ImageLoaderProps): string => {\n\tconst url = new URL(args.src);\n\n\tconst params: ImgixURLParams = {\n\t\tfit: (url.searchParams.get(\"fit\") as ImgixURLParams[\"fit\"]) || \"max\",\n\t\tw: args.width,\n\t\th: undefined,\n\t};\n\n\tif (args.quality) {\n\t\tparams.q = args.quality;\n\t}\n\n\treturn buildURL(args.src, params);\n};\n\nexport type PrismicNextImageProps = Omit<\n\tImageProps,\n\t\"src\" | \"alt\" | \"width\" | \"height\"\n> & {\n\t/**\n\t * The Prismic Image field or thumbnail to render.\n\t */\n\tfield: prismicT.ImageFieldImage | null | undefined;\n\n\t/**\n\t * An object of Imgix URL API parameters to transform the image.\n\t *\n\t * @see https://docs.imgix.com/apis/rendering\n\t */\n\timgixParams?: ImgixURLParams;\n\n\t/**\n\t * Declare an image as decorative by providing `alt=\"\"`.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images\n\t */\n\talt?: \"\";\n\n\t/**\n\t * Declare an image as decorative only if the Image field does not have\n\t * alternative text by providing `fallbackAlt=\"\"`.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images\n\t */\n\tfallbackAlt?: \"\";\n};\n\n/**\n * React component that renders an image from a Prismic Image field or one of\n * its thumbnails using `next/image`. It will automatically set the `alt`\n * attribute using the Image field's `alt` property.\n *\n * It uses an Imgix URL-based loader by default. A custom loader can be provided\n * with the `loader` prop. If you would like to use the Next.js Image\n * Optimization API instead, set `loader={undefined}`.\n *\n * @param props - Props for the component.\n *\n * @returns A responsive image component using `next/image` for the given Image\n * field.\n *\n * @see To learn more about `next/image`, see: https://nextjs.org/docs/api-reference/next/image\n */\nexport const PrismicNextImage = ({\n\tfield,\n\timgixParams = {},\n\talt,\n\tfallbackAlt,\n\tlayout,\n\t...restProps\n}: PrismicNextImageProps) => {\n\tif (!__PRODUCTION__) {\n\t\tif (typeof alt === \"string\" && alt !== \"\") {\n\t\t\tconsole.warn(\n\t\t\t\t`[PrismicNextImage] The \"alt\" prop can only be used to declare an image as decorative by passing an empty string (alt=\"\") but was provided a non-empty string. You can resolve this warning by removing the \"alt\" prop or changing it to alt=\"\". For more details, see ${devMsg(\n\t\t\t\t\t\"alt-must-be-an-empty-string\",\n\t\t\t\t)}`,\n\t\t\t);\n\t\t}\n\n\t\tif (typeof fallbackAlt === \"string\" && fallbackAlt !== \"\") {\n\t\t\tconsole.warn(\n\t\t\t\t`[PrismicNextImage] The \"fallbackAlt\" prop can only be used to declare an image as decorative by passing an empty string (fallbackAlt=\"\") but was provided a non-empty string. You can resolve this warning by removing the \"fallbackAlt\" prop or changing it to fallbackAlt=\"\". For more details, see ${devMsg(\n\t\t\t\t\t\"alt-must-be-an-empty-string\",\n\t\t\t\t)}`,\n\t\t\t);\n\t\t}\n\t}\n\n\tif (prismicH.isFilled.imageThumbnail(field)) {\n\t\tconst src = buildURL(field.url, imgixParams);\n\n\t\treturn (\n\t\t\t<Image\n\t\t\t\tsrc={src}\n\t\t\t\twidth={layout === \"fill\" ? undefined : field.dimensions.width}\n\t\t\t\theight={layout === \"fill\" ? undefined : field.dimensions.height}\n\t\t\t\talt={alt ?? (field.alt || fallbackAlt)}\n\t\t\t\tloader={imgixLoader}\n\t\t\t\tlayout={layout}\n\t\t\t\t{...restProps}\n\t\t\t/>\n\t\t);\n\t} else {\n\t\treturn null;\n\t}\n};\n"],"names":[],"mappings":";;;;;;;AAgBA,MAAM,WAAA,GAAc,CAAC,IAAmC,KAAA;AACvD,EAAA,MAAM,GAAM,GAAA,IAAI,GAAI,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAE5B,EAAA,MAAM,MAAyB,GAAA;AAAA,IAC9B,GAAM,EAAA,GAAA,CAAI,YAAa,CAAA,GAAA,CAAI,KAAK,CAA+B,IAAA,KAAA;AAAA,IAC/D,GAAG,IAAK,CAAA,KAAA;AAAA,IACR,CAAG,EAAA,KAAA,CAAA;AAAA,GACJ,CAAA;AAEA,EAAA,IAAI,KAAK,OAAS,EAAA;AACjB,IAAA,MAAA,CAAO,IAAI,IAAK,CAAA,OAAA,CAAA;AAAA,GACjB;AAEA,EAAO,OAAA,QAAA,CAAS,IAAK,CAAA,GAAA,EAAK,MAAM,CAAA,CAAA;AACjC,CAAA,CAAA;AAoDO,MAAM,mBAAmB,CAAC;AAAA,EAChC,KAAA;AAAA,EACA,cAAc,EAAC;AAAA,EACf,GAAA;AAAA,EACA,WAAA;AAAA,EACA,MAAA;AAAA,EACG,GAAA,SAAA;AACJ,CAA6B,KAAA;AAC5B,EAAA,IAAI,CAAC,cAAgB,EAAA;AACpB,IAAA,IAAI,OAAO,GAAA,KAAQ,QAAY,IAAA,GAAA,KAAQ,EAAI,EAAA;AAC1C,MAAQ,OAAA,CAAA,IAAA;AAAA,QACP,CAAyQ,sQAAA,EAAA,MAAA;AAAA,UACxQ,6BAAA;AAAA,SACD,CAAA,CAAA;AAAA,OACD,CAAA;AAAA,KACD;AAEA,IAAA,IAAI,OAAO,WAAA,KAAgB,QAAY,IAAA,WAAA,KAAgB,EAAI,EAAA;AAC1D,MAAQ,OAAA,CAAA,IAAA;AAAA,QACP,CAAyS,sSAAA,EAAA,MAAA;AAAA,UACxS,6BAAA;AAAA,SACD,CAAA,CAAA;AAAA,OACD,CAAA;AAAA,KACD;AAAA,GACD;AAEA,EAAA,IAAI,QAAS,CAAA,QAAA,CAAS,cAAe,CAAA,KAAK,CAAG,EAAA;AAC5C,IAAA,MAAM,GAAM,GAAA,QAAA,CAAS,KAAM,CAAA,GAAA,EAAK,WAAW,CAAA,CAAA;AAE3C,IAAA,uBACE,GAAA,CAAA,KAAA,EAAA;AAAA,MACA,GAAA;AAAA,MACA,KAAO,EAAA,MAAA,KAAW,MAAS,GAAA,KAAA,CAAA,GAAY,MAAM,UAAW,CAAA,KAAA;AAAA,MACxD,MAAQ,EAAA,MAAA,KAAW,MAAS,GAAA,KAAA,CAAA,GAAY,MAAM,UAAW,CAAA,MAAA;AAAA,MACzD,GAAA,EAAK,GAAQ,KAAA,KAAA,CAAM,GAAO,IAAA,WAAA,CAAA;AAAA,MAC1B,MAAQ,EAAA,WAAA;AAAA,MACR,MAAA;AAAA,MACC,GAAG,SAAA;AAAA,KACL,CAAA,CAAA;AAAA,GAEK,MAAA;AACN,IAAO,OAAA,IAAA,CAAA;AAAA,GACR;AACD;;;;"}
|
package/dist/PrismicPreview.mjs
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PrismicPreview.mjs","sources":["../src/PrismicPreview.tsx"],"sourcesContent":["import * as React from \"react\";\nimport { PrismicToolbar } from \"@prismicio/react\";\nimport { useRouter } from \"next/router\";\n\nimport { getPrismicPreviewCookie } from \"./lib/getPrismicPreviewCookie\";\nimport { getPreviewCookieRepositoryName } from \"./lib/getPreviewCookieRepositoryName\";\n\n/**\n * Props for `<PrismicPreview>`.\n */\nexport type PrismicPreviewProps = {\n\t/**\n\t * The name of your Prismic repository. A Prismic Toolbar will be registered\n\t * using this repository.\n\t */\n\trepositoryName: string;\n\n\t/**\n\t * The URL of your app's Prismic preview endpoint (default: `/api/preview`).\n\t * This URL will be fetched on preview update events.\n\t *\n\t * **Note**: If your `next.config.js` file contains a `basePath`, it is\n\t * automatically included.\n\t */\n\tupdatePreviewURL?: string;\n\n\t/**\n\t * The URL of your app's exit preview endpoint (default: `/api/exit-preview`).\n\t * This URL will be fetched on preview exit events.\n\t *\n\t * **Note**: If your `next.config.js` file contains a `basePath`, it is\n\t * automatically included.\n\t */\n\texitPreviewURL?: string;\n\n\t/**\n\t * Children to render adjacent to the Prismic Toolbar. The Prismic Toolbar\n\t * will be rendered last.\n\t */\n\tchildren?: React.ReactNode;\n};\n\n/**\n * React component that sets up Prismic Previews using the Prismic Toolbar. When\n * the Prismic Toolbar send events to the browser, such as on preview updates\n * and exiting, this component will automatically update the Next.js preview\n * cookie and refresh the page.\n *\n * This component can be wrapped around your app or added anywhere in your app's\n * tree. It must be rendered on every page.\n */\nexport function PrismicPreview({\n\trepositoryName,\n\tchildren,\n\tupdatePreviewURL = \"/api/preview\",\n\texitPreviewURL = \"/api/exit-preview\",\n}: PrismicPreviewProps): JSX.Element {\n\tconst router = useRouter();\n\n\tconst resolvedUpdatePreviewURL = router.basePath + updatePreviewURL;\n\tconst resolvedExitPreviewURL = router.basePath + exitPreviewURL;\n\n\tReact.useEffect(() => {\n\t\t/**\n\t\t * Starts Preview Mode and refreshes the page's props.\n\t\t */\n\t\tconst startPreviewMode = async () => {\n\t\t\t// Start Next.js Preview Mode via the given preview API endpoint.\n\t\t\tconst res = await globalThis.fetch(resolvedUpdatePreviewURL);\n\n\t\t\tif (res.ok) {\n\t\t\t\tglobalThis.location.reload();\n\t\t\t} else {\n\t\t\t\tconsole.error(\n\t\t\t\t\t`[<PrismicPreview>] Failed to start or update Preview Mode using the \"${resolvedUpdatePreviewURL}\" API endpoint. Does it exist?`,\n\t\t\t\t);\n\t\t\t}\n\t\t};\n\n\t\tconst handlePrismicPreviewUpdate = async (event: Event) => {\n\t\t\t// Prevent the toolbar from reloading the page.\n\t\t\tevent.preventDefault();\n\n\t\t\tawait startPreviewMode();\n\t\t};\n\n\t\tconst handlePrismicPreviewEnd = async (event: Event) => {\n\t\t\t// Prevent the toolbar from reloading the page.\n\t\t\tevent.preventDefault();\n\n\t\t\t// Exit Next.js Preview Mode via the given preview API endpoint.\n\t\t\tconst res = await globalThis.fetch(resolvedExitPreviewURL);\n\n\t\t\tif (res.ok) {\n\t\t\t\tglobalThis.location.reload();\n\t\t\t} else {\n\t\t\t\tconsole.error(\n\t\t\t\t\t`[<PrismicPreview>] Failed to exit Preview Mode using the \"${resolvedExitPreviewURL}\" API endpoint. Does it exist?`,\n\t\t\t\t);\n\t\t\t}\n\t\t};\n\n\t\tif (router.isPreview) {\n\t\t\t// Register Prismic Toolbar event handlers.\n\t\t\twindow.addEventListener(\n\t\t\t\t\"prismicPreviewUpdate\",\n\t\t\t\thandlePrismicPreviewUpdate,\n\t\t\t);\n\t\t\twindow.addEventListener(\"prismicPreviewEnd\", handlePrismicPreviewEnd);\n\t\t} else {\n\t\t\tconst prismicPreviewCookie = getPrismicPreviewCookie(\n\t\t\t\tglobalThis.document.cookie,\n\t\t\t);\n\n\t\t\tif (prismicPreviewCookie) {\n\t\t\t\t// If a Prismic preview cookie is present, but Next.js Preview\n\t\t\t\t// Mode is not active, we must activate Preview Mode manually.\n\t\t\t\t//\n\t\t\t\t// This will happen when a visitor accesses the page using a\n\t\t\t\t// Prismic preview share link.\n\n\t\t\t\t/**\n\t\t\t\t * Determines if the current location is a descendant of the app's base\n\t\t\t\t * path.\n\t\t\t\t *\n\t\t\t\t * This is used to prevent infinite refrehes; when\n\t\t\t\t * `isDescendantOfBasePath` is `false`, `router.isPreview` is also\n\t\t\t\t * `false`.\n\t\t\t\t *\n\t\t\t\t * If the app does not have a base path, this should always be `true`.\n\t\t\t\t */\n\t\t\t\tconst locationIsDescendantOfBasePath = window.location.href.startsWith(\n\t\t\t\t\twindow.location.origin + router.basePath,\n\t\t\t\t);\n\n\t\t\t\tconst prismicPreviewCookieRepositoryName =\n\t\t\t\t\tgetPreviewCookieRepositoryName(prismicPreviewCookie);\n\n\t\t\t\tif (\n\t\t\t\t\tlocationIsDescendantOfBasePath &&\n\t\t\t\t\tprismicPreviewCookieRepositoryName === repositoryName\n\t\t\t\t) {\n\t\t\t\t\tstartPreviewMode();\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// On cleanup, unregister Prismic Toolbar event handlers.\n\t\treturn () => {\n\t\t\twindow.removeEventListener(\n\t\t\t\t\"prismicPreviewUpdate\",\n\t\t\t\thandlePrismicPreviewUpdate,\n\t\t\t);\n\t\t\twindow.removeEventListener(\"prismicPreviewEnd\", handlePrismicPreviewEnd);\n\t\t};\n\t}, [\n\t\trepositoryName,\n\t\tresolvedExitPreviewURL,\n\t\tresolvedUpdatePreviewURL,\n\t\trouter.isPreview,\n\t\trouter.basePath,\n\t]);\n\n\treturn (\n\t\t<>\n\t\t\t{children}\n\t\t\t<PrismicToolbar repositoryName={repositoryName} />\n\t\t</>\n\t);\n}\n"],"names":[],"mappings":";;;;;;;AAmDO,SAAS,cAAe,CAAA;AAAA,EAC9B,cAAA;AAAA,EACA,QAAA;AAAA,EACA,gBAAmB,GAAA,cAAA;AAAA,EACnB,cAAiB,GAAA,mBAAA;AAClB,CAAqC,EAAA;AACpC,EAAA,MAAM,SAAS,SAAU,EAAA,CAAA;AAEzB,EAAM,MAAA,wBAAA,GAA2B,OAAO,QAAW,GAAA,gBAAA,CAAA;AACnD,EAAM,MAAA,sBAAA,GAAyB,OAAO,QAAW,GAAA,cAAA,CAAA;AAEjD,EAAA,KAAA,CAAM,UAAU,MAAM;AAIrB,IAAA,MAAM,mBAAmB,YAAY;AAEpC,MAAA,MAAM,GAAM,GAAA,MAAM,UAAW,CAAA,KAAA,CAAM,wBAAwB,CAAA,CAAA;AAE3D,MAAA,IAAI,IAAI,EAAI,EAAA;AACX,QAAA,UAAA,CAAW,SAAS,MAAO,EAAA,CAAA;AAAA,OACrB,MAAA;AACN,QAAQ,OAAA,CAAA,KAAA;AAAA,UACP,CAAwE,qEAAA,EAAA,wBAAA,CAAA,8BAAA,CAAA;AAAA,SACzE,CAAA;AAAA,OACD;AAAA,KACD,CAAA;AAEA,IAAM,MAAA,0BAAA,GAA6B,OAAO,KAAiB,KAAA;AAE1D,MAAA,KAAA,CAAM,cAAe,EAAA,CAAA;AAErB,MAAA,MAAM,gBAAiB,EAAA,CAAA;AAAA,KACxB,CAAA;AAEA,IAAM,MAAA,uBAAA,GAA0B,OAAO,KAAiB,KAAA;AAEvD,MAAA,KAAA,CAAM,cAAe,EAAA,CAAA;AAGrB,MAAA,MAAM,GAAM,GAAA,MAAM,UAAW,CAAA,KAAA,CAAM,sBAAsB,CAAA,CAAA;AAEzD,MAAA,IAAI,IAAI,EAAI,EAAA;AACX,QAAA,UAAA,CAAW,SAAS,MAAO,EAAA,CAAA;AAAA,OACrB,MAAA;AACN,QAAQ,OAAA,CAAA,KAAA;AAAA,UACP,CAA6D,0DAAA,EAAA,sBAAA,CAAA,8BAAA,CAAA;AAAA,SAC9D,CAAA;AAAA,OACD;AAAA,KACD,CAAA;AAEA,IAAA,IAAI,OAAO,SAAW,EAAA;AAErB,MAAO,MAAA,CAAA,gBAAA;AAAA,QACN,sBAAA;AAAA,QACA,0BAAA;AAAA,OACD,CAAA;AACA,MAAO,MAAA,CAAA,gBAAA,CAAiB,qBAAqB,uBAAuB,CAAA,CAAA;AAAA,KAC9D,MAAA;AACN,MAAA,MAAM,oBAAuB,GAAA,uBAAA;AAAA,QAC5B,WAAW,QAAS,CAAA,MAAA;AAAA,OACrB,CAAA;AAEA,MAAA,IAAI,oBAAsB,EAAA;AAiBzB,QAAM,MAAA,8BAAA,GAAiC,MAAO,CAAA,QAAA,CAAS,IAAK,CAAA,UAAA;AAAA,UAC3D,MAAA,CAAO,QAAS,CAAA,MAAA,GAAS,MAAO,CAAA,QAAA;AAAA,SACjC,CAAA;AAEA,QAAM,MAAA,kCAAA,GACL,+BAA+B,oBAAoB,CAAA,CAAA;AAEpD,QACC,IAAA,8BAAA,IACA,uCAAuC,cACtC,EAAA;AACD,UAAiB,gBAAA,EAAA,CAAA;AAAA,SAClB;AAAA,OACD;AAAA,KACD;AAGA,IAAA,OAAO,MAAM;AACZ,MAAO,MAAA,CAAA,mBAAA;AAAA,QACN,sBAAA;AAAA,QACA,0BAAA;AAAA,OACD,CAAA;AACA,MAAO,MAAA,CAAA,mBAAA,CAAoB,qBAAqB,uBAAuB,CAAA,CAAA;AAAA,KACxE,CAAA;AAAA,GACE,EAAA;AAAA,IACF,cAAA;AAAA,IACA,sBAAA;AAAA,IACA,wBAAA;AAAA,IACA,MAAO,CAAA,SAAA;AAAA,IACP,MAAO,CAAA,QAAA;AAAA,GACP,CAAA,CAAA;AAED,EACC,uBAAA,IAAA,CAAA,QAAA,EAAA;AAAA,IACE,QAAA,EAAA;AAAA,MAAA,QAAA;AAAA,sBACA,GAAA,CAAA,cAAA,EAAA;AAAA,QAAe,cAAA;AAAA,OAAgC,CAAA;AAAA,KAAA;AAAA,GACjD,CAAA,CAAA;AAEF;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"enableAutoPreviews.mjs","sources":["../src/enableAutoPreviews.ts"],"sourcesContent":["import { PreviewData } from \"next\";\nimport { Client, HttpRequestLike } from \"@prismicio/client\";\n\ninterface PrismicNextPreviewData {\n\tref: string;\n}\n\n/**\n * Determines if a Next.js preview data object contains Prismic preview data.\n *\n * @param previewData - The Next.js preview data object to check.\n *\n * @returns `true` if `previewData` contains Prismic preview data, `false`\n * otherwise.\n */\nconst isPrismicNextPreviewData = (\n\tpreviewData: PreviewData,\n): previewData is PrismicNextPreviewData => {\n\treturn typeof previewData === \"object\" && \"ref\" in previewData;\n};\n\n/**\n * Configuration for `enableAutoPreviews`.\n *\n * @typeParam TPreviewData - Next.js preview data object.\n */\nexport type EnableAutoPreviewsConfig<\n\tTPreviewData extends PreviewData = PreviewData,\n> = {\n\t/**\n\t * Prismic client with which automatic previews will be enabled.\n\t */\n\tclient: Client;\n} & (\n\t| {\n\t\t\t/**\n\t\t\t * A Next.js context object (such as the context object from\n\t\t\t * `getStaticProps` or `getServerSideProps`).\n\t\t\t *\n\t\t\t * Pass a `context` object when using `enableAutoPreviews` outside a\n\t\t\t * Next.js API endpoint.\n\t\t\t */\n\t\t\tpreviewData?: TPreviewData;\n\t }\n\t| {\n\t\t\t/**\n\t\t\t * A Next.js API endpoint request object.\n\t\t\t *\n\t\t\t * Pass a `req` object when using `enableAutoPreviews` in a Next.js API\n\t\t\t * endpoint.\n\t\t\t */\n\t\t\treq?: HttpRequestLike;\n\t }\n);\n/**\n * Configures a Prismic client to automatically query draft content during a\n * preview session. It either takes in a Next.js `getStaticProps` context object\n * or a Next.js API endpoint request object.\n *\n * @param config - Configuration for the function.\n */\nexport const enableAutoPreviews = <TPreviewData extends PreviewData>(\n\tconfig: EnableAutoPreviewsConfig<TPreviewData>,\n): void => {\n\tif (\"previewData\" in config && config.previewData) {\n\t\t// If preview data is being passed from Next Context then use queryContentFromRef\n\n\t\tconst { previewData } = config;\n\n\t\tif (isPrismicNextPreviewData(previewData) && previewData.ref) {\n\t\t\tconfig.client.queryContentFromRef(previewData.ref);\n\t\t}\n\t} else if (\"req\" in config && config.req) {\n\t\t// If the req object is passed then use enableAutoPreviewsFromReq\n\n\t\tconfig.client.enableAutoPreviewsFromReq(config.req);\n\t}\n};\n"],"names":[],"mappings":"AAeA,MAAM,wBAAA,GAA2B,CAChC,WAC2C,KAAA;AAC3C,EAAO,OAAA,OAAO,WAAgB,KAAA,QAAA,IAAY,KAAS,IAAA,WAAA,CAAA;AACpD,CAAA,CAAA;AA0Ca,MAAA,kBAAA,GAAqB,CACjC,MACU,KAAA;AACV,EAAI,IAAA,aAAA,IAAiB,MAAU,IAAA,MAAA,CAAO,WAAa,EAAA;AAGlD,IAAM,MAAA,EAAE,aAAgB,GAAA,MAAA,CAAA;AAExB,IAAA,IAAI,wBAAyB,CAAA,WAAW,CAAK,IAAA,WAAA,CAAY,GAAK,EAAA;AAC7D,MAAO,MAAA,CAAA,MAAA,CAAO,mBAAoB,CAAA,WAAA,CAAY,GAAG,CAAA,CAAA;AAAA,KAClD;AAAA,GACU,MAAA,IAAA,KAAA,IAAS,MAAU,IAAA,MAAA,CAAO,GAAK,EAAA;AAGzC,IAAO,MAAA,CAAA,MAAA,CAAO,yBAA0B,CAAA,MAAA,CAAO,GAAG,CAAA,CAAA;AAAA,GACnD;AACD;;;;"}
|
package/dist/exitPreview.mjs
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"exitPreview.mjs","sources":["../src/exitPreview.ts"],"sourcesContent":["import type { NextApiResponse, NextApiRequest } from \"next\";\n\n/**\n * Configuration for `exitPreview`.\n */\nexport type ExitPreviewConfig = {\n\t/**\n\t * The `req` object from a Next.js API route. This is given as a parameter to\n\t * the API route.\n\t *\n\t * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}\n\t */\n\t// `req` is no longer used in `exitPreview()`. It previously would\n\t// redirect the user to the referring URL, but it no longer has that\n\t// behavior.\n\t//\n\t// `req` is retained as a parameter to make setting up an exit preview\n\t// API route easier (this eliminates the awkward need to handle an\n\t// unused `req` param).\n\t//\n\t// It is also retained in case it is needed in the future, such as\n\t// reading headers or metadata about the request.\n\treq: {\n\t\theaders: NextApiRequest[\"headers\"];\n\t};\n\n\t/**\n\t * The `res` object from a Next.js API route. This is given as a parameter to\n\t * the API route.\n\t *\n\t * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}\n\t */\n\tres: {\n\t\tclearPreviewData: NextApiResponse[\"clearPreviewData\"];\n\t\tstatus: NextApiResponse[\"status\"];\n\t\tjson: NextApiResponse[\"json\"];\n\t};\n\n\t/**\n\t * @deprecated - This property is no longer used. It can be deleted safely.\n\t */\n\texitPreviewURL?: string;\n};\n\n/**\n * Exits Next.js's Preview Mode from within a Next.js API route.\n */\nexport function exitPreview(config: ExitPreviewConfig): void {\n\t// Exit the current user from Preview Mode.\n\tconfig.res.clearPreviewData();\n\n\t// 205 status is used to prevent CDN-level caching. The default 200\n\t// status code is typically treated as non-changing and cacheable.\n\tconfig.res.status(205).json({ success: true });\n}\n"],"names":[],"mappings":"AA+CO,SAAS,YAAY,MAAiC,EAAA;AAE5D,EAAA,MAAA,CAAO,IAAI,gBAAiB,EAAA,CAAA;AAI5B,EAAO,MAAA,CAAA,GAAA,CAAI,OAAO,GAAG,CAAA,CAAE,KAAK,EAAE,OAAA,EAAS,MAAM,CAAA,CAAA;AAC9C;;;;"}
|
package/dist/index.mjs
CHANGED
|
@@ -4,3 +4,4 @@ export { PrismicPreview } from './PrismicPreview.mjs';
|
|
|
4
4
|
export { enableAutoPreviews } from './enableAutoPreviews.mjs';
|
|
5
5
|
export { redirectToPreviewURL } from './redirectToPreviewURL.mjs';
|
|
6
6
|
export { PrismicNextImage } from './PrismicNextImage.mjs';
|
|
7
|
+
//# sourceMappingURL=index.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"__PRODUCTION__.mjs","sources":["../../src/lib/__PRODUCTION__.ts"],"sourcesContent":["/**\n * `true` if in the production environment, `false` otherwise.\n *\n * This boolean can be used to perform actions only in development environments,\n * such as logging.\n */\nexport const __PRODUCTION__ = process.env.NODE_ENV === \"production\";\n"],"names":[],"mappings":"AAMa,MAAA,cAAA,GAAiB,OAAQ,CAAA,GAAA,CAAI,QAAa,KAAA;;;;"}
|
package/dist/lib/devMsg.mjs
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"devMsg.mjs","sources":["../../src/lib/devMsg.ts"],"sourcesContent":["import { version } from \"../../package.json\";\n\n/**\n * Returns a `prismic.dev/msg` URL for a given message slug.\n *\n * @example\n *\n * ```ts\n * devMsg(\"missing-param\");\n * // => \"https://prismic.dev/msg/next/v1.2.3/missing-param.md\"\n * ```\n *\n * @param slug - Slug for the message. This corresponds to a Markdown file in\n * the Git repository's `/messages` directory.\n *\n * @returns The `prismic.dev/msg` URL for the given slug.\n */\nexport const devMsg = (slug: string) => {\n\treturn `https://prismic.dev/msg/next/v${version}/${slug}`;\n};\n"],"names":[],"mappings":";;AAiBa,MAAA,MAAA,GAAS,CAAC,IAAiB,KAAA;AACvC,EAAA,OAAO,iCAAiC,OAAW,CAAA,CAAA,EAAA,IAAA,CAAA,CAAA,CAAA;AACpD;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getPreviewCookieRepositoryName.mjs","sources":["../../src/lib/getPreviewCookieRepositoryName.ts"],"sourcesContent":["/**\n * Extracts preview reference repo name from stringified Prismic preview cookie\n *\n * @param previewCookie - The Prismic preview cookie.\n *\n * @returns The repository name for the Prismic preview cookie. If the cookie\n * represents an inactive preview session, `undefined` will be returned.\n */\nexport const getPreviewCookieRepositoryName = (\n\tpreviewCookie: string,\n): string | undefined => {\n\treturn (decodeURIComponent(previewCookie).match(/\"(.+).prismic.io\"/) ||\n\t\t[])[1];\n};\n"],"names":[],"mappings":"AAQa,MAAA,8BAAA,GAAiC,CAC7C,aACwB,KAAA;AACxB,EAAA,OAAA,CAAQ,mBAAmB,aAAa,CAAA,CAAE,MAAM,mBAAmB,CAAA,IAClE,EAAI,EAAA,CAAA,CAAA,CAAA;AACN;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getPrismicPreviewCookie.mjs","sources":["../../src/lib/getPrismicPreviewCookie.ts"],"sourcesContent":["import * as prismic from \"@prismicio/client\";\n\nconst readValue = (value: string): string => {\n\treturn value.replace(/%3B/g, \";\");\n};\n\n/**\n * Returns the value of a cookie from a given cookie store.\n *\n * @param cookieJar - The stringified cookie store from which to read the\n * cookie.\n *\n * @returns The value of the cookie, if it exists.\n */\nexport const getPrismicPreviewCookie = (\n\tcookieJar: string,\n): string | undefined => {\n\tconst cookies = cookieJar.split(\"; \");\n\n\tlet value: string | undefined;\n\n\tfor (const cookie of cookies) {\n\t\tconst parts = cookie.split(\"=\");\n\t\tconst name = readValue(parts[0]).replace(/%3D/g, \"=\");\n\n\t\tif (name === prismic.cookie.preview) {\n\t\t\tvalue = readValue(parts.slice(1).join(\"=\"));\n\t\t\tcontinue;\n\t\t}\n\t}\n\n\treturn value;\n};\n"],"names":[],"mappings":";;AAEA,MAAM,SAAA,GAAY,CAAC,KAA0B,KAAA;AAC5C,EAAO,OAAA,KAAA,CAAM,OAAQ,CAAA,MAAA,EAAQ,GAAG,CAAA,CAAA;AACjC,CAAA,CAAA;AAUa,MAAA,uBAAA,GAA0B,CACtC,SACwB,KAAA;AACxB,EAAM,MAAA,OAAA,GAAU,SAAU,CAAA,KAAA,CAAM,IAAI,CAAA,CAAA;AAEpC,EAAI,IAAA,KAAA,CAAA;AAEJ,EAAA,KAAA,MAAW,UAAU,OAAS,EAAA;AAC7B,IAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,KAAA,CAAM,GAAG,CAAA,CAAA;AAC9B,IAAA,MAAM,OAAO,SAAU,CAAA,KAAA,CAAM,EAAE,CAAE,CAAA,OAAA,CAAQ,QAAQ,GAAG,CAAA,CAAA;AAEpD,IAAI,IAAA,IAAA,KAAS,OAAQ,CAAA,MAAA,CAAO,OAAS,EAAA;AACpC,MAAA,KAAA,GAAQ,UAAU,KAAM,CAAA,KAAA,CAAM,CAAC,CAAE,CAAA,IAAA,CAAK,GAAG,CAAC,CAAA,CAAA;AAC1C,MAAA,SAAA;AAAA,KACD;AAAA,GACD;AAEA,EAAO,OAAA,KAAA,CAAA;AACR;;;;"}
|
package/dist/package.mjs
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"package.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"redirectToPreviewURL.mjs","sources":["../src/redirectToPreviewURL.ts"],"sourcesContent":["import type { Client } from \"@prismicio/client\";\nimport type { NextApiRequest, NextApiResponse } from \"next\";\nimport type { LinkResolverFunction } from \"@prismicio/helpers\";\n\ntype PrismicNextQuery = {\n\tdocumentId: string;\n\ttoken: string;\n};\n\n/**\n * Determines if a query object from a Next.js API route request contains\n * Prismic preview data.\n *\n * @param query - Query object to check.\n *\n * @returns `true` if `query` contains Prismic preview data, `false` otherwise.\n */\nconst isPrismicNextQuery = (\n\tquery: NextApiRequest[\"query\"],\n): query is PrismicNextQuery => {\n\treturn (\n\t\ttypeof query.documentId === \"string\" && typeof query.token === \"string\"\n\t);\n};\n\n/**\n * Preview config for enabling previews with redirectToPreviewURL\n */\nexport type RedirectToPreviewURLConfig<\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tTLinkResolverFunction extends LinkResolverFunction<any> = LinkResolverFunction,\n> = {\n\t/**\n\t * The `req` object from a Next.js API route. This is given as a parameter to\n\t * the API route.\n\t *\n\t * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}\n\t */\n\treq: {\n\t\tquery: NextApiRequest[\"query\"];\n\t};\n\n\t/**\n\t * The `res` object from a Next.js API route. This is given as a parameter to\n\t * the API route.\n\t *\n\t * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}\n\t */\n\tres: {\n\t\tredirect: NextApiResponse[\"redirect\"];\n\t};\n\n\t/**\n\t * The Prismic client configured for the preview session's repository.\n\t */\n\tclient: Client;\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?: TLinkResolverFunction;\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 API route is unable to detect the app's `basePath` automatically. It\n\t * must be provided to `redirectToPreviewURL()` manually.\n\t */\n\tbasePath?: string;\n};\n\n/**\n * Redirects a user to the URL of a previewed Prismic document from within a\n * Next.js API route.\n */\nexport async function redirectToPreviewURL<\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tTLinkResolverFunction extends LinkResolverFunction<any>,\n>(config: RedirectToPreviewURLConfig<TLinkResolverFunction>): Promise<void> {\n\tconst defaultURL = config.defaultURL || \"/\";\n\tconst basePath = config.basePath || \"\";\n\n\tif (isPrismicNextQuery(config.req.query)) {\n\t\tconst previewUrl = await config.client.resolvePreviewURL({\n\t\t\tlinkResolver: config.linkResolver,\n\t\t\tdefaultURL,\n\t\t\tdocumentID: config.req.query.documentId,\n\t\t\tpreviewToken: config.req.query.token,\n\t\t});\n\n\t\tconfig.res.redirect(basePath + previewUrl);\n\n\t\treturn;\n\t}\n\n\tconfig.res.redirect(basePath + defaultURL);\n}\n"],"names":[],"mappings":"AAiBA,MAAM,kBAAA,GAAqB,CAC1B,KAC+B,KAAA;AAC/B,EAAA,OACC,OAAO,KAAM,CAAA,UAAA,KAAe,QAAY,IAAA,OAAO,MAAM,KAAU,KAAA,QAAA,CAAA;AAEjE,CAAA,CAAA;AAkEA,eAAsB,qBAGpB,MAA0E,EAAA;AAC3E,EAAM,MAAA,UAAA,GAAa,OAAO,UAAc,IAAA,GAAA,CAAA;AACxC,EAAM,MAAA,QAAA,GAAW,OAAO,QAAY,IAAA,EAAA,CAAA;AAEpC,EAAA,IAAI,kBAAmB,CAAA,MAAA,CAAO,GAAI,CAAA,KAAK,CAAG,EAAA;AACzC,IAAA,MAAM,UAAa,GAAA,MAAM,MAAO,CAAA,MAAA,CAAO,iBAAkB,CAAA;AAAA,MACxD,cAAc,MAAO,CAAA,YAAA;AAAA,MACrB,UAAA;AAAA,MACA,UAAA,EAAY,MAAO,CAAA,GAAA,CAAI,KAAM,CAAA,UAAA;AAAA,MAC7B,YAAA,EAAc,MAAO,CAAA,GAAA,CAAI,KAAM,CAAA,KAAA;AAAA,KAC/B,CAAA,CAAA;AAED,IAAO,MAAA,CAAA,GAAA,CAAI,QAAS,CAAA,QAAA,GAAW,UAAU,CAAA,CAAA;AAEzC,IAAA,OAAA;AAAA,GACD;AAEA,EAAO,MAAA,CAAA,GAAA,CAAI,QAAS,CAAA,QAAA,GAAW,UAAU,CAAA,CAAA;AAC1C;;;;"}
|
package/dist/setPreviewData.mjs
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"setPreviewData.mjs","sources":["../src/setPreviewData.ts"],"sourcesContent":["import { NextApiResponse, NextApiRequest } from \"next\";\nimport * as prismic from \"@prismicio/client\";\n\n/**\n * Configuration for `setPreviewData`.\n */\nexport type SetPreviewDataConfig = {\n\t/**\n\t * The `req` object from a Next.js API route. This is given as a parameter to\n\t * the API route.\n\t *\n\t * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}\n\t */\n\treq: {\n\t\tquery: NextApiRequest[\"query\"];\n\t\tcookies: NextApiRequest[\"cookies\"];\n\t};\n\n\t/**\n\t * The `res` object from a Next.js API route. This is given as a parameter to\n\t * the API route.\n\t *\n\t * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}\n\t */\n\tres: {\n\t\tsetPreviewData: NextApiResponse[\"setPreviewData\"];\n\t};\n};\n\n/**\n * Set Prismic preview data for Next.js's Preview Mode.\n */\nexport function setPreviewData({ req, res }: SetPreviewDataConfig): void {\n\tconst ref = req.query.token || req.cookies[prismic.cookie.preview];\n\n\tif (ref) {\n\t\tres.setPreviewData({ ref });\n\t}\n}\n"],"names":[],"mappings":";;AAgCO,SAAS,cAAe,CAAA,EAAE,GAAK,EAAA,GAAA,EAAmC,EAAA;AACxE,EAAA,MAAM,MAAM,GAAI,CAAA,KAAA,CAAM,SAAS,GAAI,CAAA,OAAA,CAAQ,QAAQ,MAAO,CAAA,OAAA,CAAA,CAAA;AAE1D,EAAA,IAAI,GAAK,EAAA;AACR,IAAI,GAAA,CAAA,cAAA,CAAe,EAAE,GAAA,EAAK,CAAA,CAAA;AAAA,GAC3B;AACD;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@prismicio/next",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.5",
|
|
4
4
|
"description": "Helpers to integrate Prismic into Next.js apps",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"typescript",
|
|
@@ -18,8 +18,11 @@
|
|
|
18
18
|
"sideEffects": false,
|
|
19
19
|
"type": "module",
|
|
20
20
|
"exports": {
|
|
21
|
-
".": "./dist/index.mjs"
|
|
21
|
+
".": "./dist/index.mjs",
|
|
22
|
+
"./package.json": "./package.json"
|
|
22
23
|
},
|
|
24
|
+
"main": "./dist/index.mjs",
|
|
25
|
+
"module": "./dist/index.mjs",
|
|
23
26
|
"types": "dist/index.d.ts",
|
|
24
27
|
"files": [
|
|
25
28
|
"dist",
|