@prismicio/next 0.1.1 → 0.1.4-alpha.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -7,11 +7,10 @@
 [![Conventional Commits][conventional-commits-src]][conventional-commits-href]
 [![License][license-src]][license-href]
 
-<!-- TODO: Replacing link to Prismic with [Prismic][prismic] is useful here -->
+Helpers to integrate Prismic into Next.js apps.
 
-A Next.js Integration with Prismic that makes it easier to take advantage of Next.js features.
-
-- 🎥 &nbsp;Easily set up Prismic Previews;
+- 👁️ &nbsp;Easily set up Prismic Preview
+- 🖼️ &nbsp;Render optimized images using [`next/image`][next-image] and Prismic's built-in [Imgix][imgix] integration
 
 ## Install
 
@@ -58,10 +57,12 @@ For more clarity on this project and its structure you can also check out the de
 <!-- Links -->
 
 [prismic]: https://prismic.io
+[imgix]: https://imgix.com/
+[next-image]: https://nextjs.org/docs/basic-features/image-optimization
 
 <!-- TODO: Replace link with a more useful one if available -->
 
-[prismic-docs]: https://prismic.io/docs
+[prismic-docs]: https://prismic.io/docs/technologies/nextjs
 [changelog]: ./CHANGELOG.md
 [contributing]: ./CONTRIBUTING.md
 

package/dist/PrismicNextImage.mjs

@@ -0,0 +1,60 @@
+import * as React from 'react';
+import Image from 'next/image';
+import { buildURL } from 'imgix-url-builder';
+import * as prismicH from '@prismicio/helpers';
+import { __PRODUCTION__ } from './lib/__PRODUCTION__.mjs';
+import { devMsg } from './lib/devMsg.mjs';
+
+const imgixLoader = (args) => {
+  const url = new URL(args.src);
+  const params = {
+    fit: url.searchParams.get("fit") || "max",
+    w: args.width,
+    h: void 0
+  };
+  if (args.quality) {
+    params.q = args.quality;
+  }
+  return buildURL(args.src, params);
+};
+const PrismicNextImage = ({
+  field,
+  imgixParams = {},
+  alt,
+  fallbackAlt,
+  layout,
+  ...restProps
+}) => {
+  if (!__PRODUCTION__) {
+    if (typeof alt === "string" && alt !== "") {
+      console.warn(
+        `[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(
+          "alt-must-be-an-empty-string"
+        )}`
+      );
+    }
+    if (typeof fallbackAlt === "string" && fallbackAlt !== "") {
+      console.warn(
+        `[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(
+          "alt-must-be-an-empty-string"
+        )}`
+      );
+    }
+  }
+  if (prismicH.isFilled.imageThumbnail(field)) {
+    const src = buildURL(field.url, imgixParams);
+    return /* @__PURE__ */ React.createElement(Image, {
+      src,
+      width: layout === "fill" ? void 0 : field.dimensions.width,
+      height: layout === "fill" ? void 0 : field.dimensions.height,
+      alt: alt ?? (field.alt || fallbackAlt),
+      loader: imgixLoader,
+      layout,
+      ...restProps
+    });
+  } else {
+    return null;
+  }
+};
+
+export { PrismicNextImage };

package/dist/PrismicPreview.mjs

@@ -0,0 +1,81 @@
+import * as React from 'react';
+import { PrismicToolbar } from '@prismicio/react';
+import { useRouter } from 'next/router';
+import { getPrismicPreviewCookie } from './lib/getPrismicPreviewCookie.mjs';
+import { getPreviewCookieRepositoryName } from './lib/getPreviewCookieRepositoryName.mjs';
+
+function PrismicPreview({
+  repositoryName,
+  children,
+  updatePreviewURL = "/api/preview",
+  exitPreviewURL = "/api/exit-preview"
+}) {
+  const router = useRouter();
+  const resolvedUpdatePreviewURL = router.basePath + updatePreviewURL;
+  const resolvedExitPreviewURL = router.basePath + exitPreviewURL;
+  React.useEffect(() => {
+    const startPreviewMode = async () => {
+      const res = await globalThis.fetch(resolvedUpdatePreviewURL);
+      if (res.ok) {
+        globalThis.location.reload();
+      } else {
+        console.error(
+          `[<PrismicPreview>] Failed to start or update Preview Mode using the "${resolvedUpdatePreviewURL}" API endpoint. Does it exist?`
+        );
+      }
+    };
+    const handlePrismicPreviewUpdate = async (event) => {
+      event.preventDefault();
+      await startPreviewMode();
+    };
+    const handlePrismicPreviewEnd = async (event) => {
+      event.preventDefault();
+      const res = await globalThis.fetch(resolvedExitPreviewURL);
+      if (res.ok) {
+        globalThis.location.reload();
+      } else {
+        console.error(
+          `[<PrismicPreview>] Failed to exit Preview Mode using the "${resolvedExitPreviewURL}" API endpoint. Does it exist?`
+        );
+      }
+    };
+    if (router.isPreview) {
+      window.addEventListener(
+        "prismicPreviewUpdate",
+        handlePrismicPreviewUpdate
+      );
+      window.addEventListener("prismicPreviewEnd", handlePrismicPreviewEnd);
+    } else {
+      const prismicPreviewCookie = getPrismicPreviewCookie(
+        globalThis.document.cookie
+      );
+      if (prismicPreviewCookie) {
+        const locationIsDescendantOfBasePath = window.location.href.startsWith(
+          window.location.origin + router.basePath
+        );
+        const prismicPreviewCookieRepositoryName = getPreviewCookieRepositoryName(prismicPreviewCookie);
+        if (locationIsDescendantOfBasePath && prismicPreviewCookieRepositoryName === repositoryName) {
+          startPreviewMode();
+        }
+      }
+    }
+    return () => {
+      window.removeEventListener(
+        "prismicPreviewUpdate",
+        handlePrismicPreviewUpdate
+      );
+      window.removeEventListener("prismicPreviewEnd", handlePrismicPreviewEnd);
+    };
+  }, [
+    repositoryName,
+    resolvedExitPreviewURL,
+    resolvedUpdatePreviewURL,
+    router.isPreview,
+    router.basePath
+  ]);
+  return /* @__PURE__ */ React.createElement(React.Fragment, null, children, /* @__PURE__ */ React.createElement(PrismicToolbar, {
+    repositoryName
+  }));
+}
+
+export { PrismicPreview };

package/dist/enableAutoPreviews.mjs

@@ -0,0 +1,15 @@
+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);
+  }
+};
+
+export { enableAutoPreviews };

package/dist/exitPreview.mjs

@@ -0,0 +1,6 @@
+function exitPreview(config) {
+  config.res.clearPreviewData();
+  config.res.status(205).json({ success: true });
+}
+
+export { exitPreview };

package/dist/index.d.ts

@@ -1,7 +1,10 @@
 import { NextApiRequest, NextApiResponse, PreviewData } from 'next';
-import { Client, HttpRequestLike } from '@prismicio/client';
-import React from 'react';
+import * as React from 'react';
+import { Client, HttpRequestLike, ClientConfig } from '@prismicio/client';
 import { LinkResolverFunction } from '@prismicio/helpers';
+import { ImageProps } from 'next/image';
+import { ImgixURLParams } from 'imgix-url-builder';
+import * as prismicT from '@prismicio/types';
 
 /**
  * Configuration for `setPreviewData`.
@@ -30,43 +33,7 @@ declare type SetPreviewDataConfig = {
 /**
  * Set Prismic preview data for Next.js's Preview Mode.
  */
-declare function setPreviewData({ req, res, }: SetPreviewDataConfig): Promise<void>;
-
-/**
- * Configuration for `enableAutoPreviews`.
- *
- * @typeParam TPreviewData - Next.js preview data object.
- */
-declare type EnableAutoPreviewsConfig<TPreviewData extends PreviewData = PreviewData> = {
-    /**
-     * Prismic client with which automatic previews will be enabled.
-     */
-    client: Client;
-} & ({
-    /**
-     * A Next.js context object (such as the context object from
-     * `getStaticProps` or `getServerSideProps`).
-     *
-     * Pass a `context` object when using `enableAutoPreviews` outside a
-     * Next.js API endpoint.
-     */
-    previewData?: TPreviewData;
-} | {
-    /**
-     * A Next.js API endpoint request object.
-     *
-     * Pass a `req` object when using `enableAutoPreviews` in a Next.js API endpoint.
-     */
-    req?: HttpRequestLike;
-});
-/**
- * Configures a Prismic client to automatically query draft content during a
- * preview session. It either takes in a Next.js `getStaticProps` context object
- * or a Next.js API endpoint request object.
- *
- * @param config - Configuration for the function.
- */
-declare const enableAutoPreviews: <TPreviewData extends PreviewData>(config: EnableAutoPreviewsConfig<TPreviewData>) => void;
+declare function setPreviewData({ req, res }: SetPreviewDataConfig): void;
 
 /**
  * Configuration for `exitPreview`.
@@ -79,9 +46,7 @@ declare type ExitPreviewConfig = {
      * @see Next.js API route docs: {@link https://nextjs.org/docs/api-routes/introduction}
      */
     req: {
-        headers: {
-            referer?: NextApiRequest["headers"]["referer"];
-        };
+        headers: NextApiRequest["headers"];
     };
     /**
      * The `res` object from a Next.js API route. This is given as a parameter to
@@ -91,14 +56,16 @@ declare type ExitPreviewConfig = {
      */
     res: {
         clearPreviewData: NextApiResponse["clearPreviewData"];
-        redirect: NextApiResponse["redirect"];
+        status: NextApiResponse["status"];
+        json: NextApiResponse["json"];
     };
+    /**
+     * @deprecated - This property is no longer used. It can be deleted safely.
+     */
+    exitPreviewURL?: string;
 };
 /**
  * Exits Next.js's Preview Mode from within a Next.js API route.
- *
- * If the user was sent to the endpoint from a page, the user will be redirected
- * back to that page after exiting Preview Mode.
  */
 declare function exitPreview(config: ExitPreviewConfig): void;
 
@@ -114,13 +81,23 @@ declare type PrismicPreviewProps = {
     /**
      * The URL of your app's Prismic preview endpoint (default: `/api/preview`).
      * This URL will be fetched on preview update events.
+     *
+     * **Note**: If your `next.config.js` file contains a `basePath`, it is
+     * automatically included.
      */
     updatePreviewURL?: string;
     /**
      * The URL of your app's exit preview endpoint (default: `/api/exit-preview`).
      * This URL will be fetched on preview exit events.
+     *
+     * **Note**: If your `next.config.js` file contains a `basePath`, it is
+     * automatically included.
      */
     exitPreviewURL?: string;
+    /**
+     * Children to render adjacent to the Prismic Toolbar. The Prismic Toolbar
+     * will be rendered last.
+     */
     children?: React.ReactNode;
 };
 /**
@@ -135,34 +112,45 @@ declare type PrismicPreviewProps = {
 declare function PrismicPreview({ repositoryName, children, updatePreviewURL, exitPreviewURL, }: PrismicPreviewProps): JSX.Element;
 
 /**
- * Redirects a user to the URL of a previewed Prismic document from within a
- * Next.js API route.
- */
-declare function redirectToPreviewURL({ req, res, client, linkResolver, defaultURL, }: PreviewConfig): Promise<void>;
-
-/**
- * Configuration for creating a Prismic client with automatic preview support in
- * Next.js apps.
+ * Configuration for `enableAutoPreviews`.
+ *
+ * @typeParam TPreviewData - Next.js preview data object.
  */
-declare type CreateClientConfig = {
+declare type EnableAutoPreviewsConfig<TPreviewData extends PreviewData = PreviewData> = {
     /**
-     * Preview data coming from Next.js context object. This context object comes
-     * from `getStaticProps` or `getServerSideProps`.
+     * Prismic client with which automatic previews will be enabled.
+     */
+    client: Client;
+} & ({
+    /**
+     * A Next.js context object (such as the context object from
+     * `getStaticProps` or `getServerSideProps`).
      *
-     * Pass `previewData` when using outside a Next.js API endpoint.
+     * Pass a `context` object when using `enableAutoPreviews` outside a
+     * Next.js API endpoint.
      */
-    previewData?: PreviewData;
+    previewData?: TPreviewData;
+} | {
     /**
      * A Next.js API endpoint request object.
      *
-     * Pass a `req` object when using in a Next.js API endpoint.
+     * Pass a `req` object when using `enableAutoPreviews` in a Next.js API endpoint.
      */
-    req?: NextApiRequest;
-};
+    req?: HttpRequestLike;
+});
+/**
+ * Configures a Prismic client to automatically query draft content during a
+ * preview session. It either takes in a Next.js `getStaticProps` context object
+ * or a Next.js API endpoint request object.
+ *
+ * @param config - Configuration for the function.
+ */
+declare const enableAutoPreviews: <TPreviewData extends PreviewData>(config: EnableAutoPreviewsConfig<TPreviewData>) => void;
+
 /**
  * Preview config for enabling previews with redirectToPreviewURL
  */
-declare type PreviewConfig = {
+declare type RedirectToPreviewURLConfig<TLinkResolverFunction extends LinkResolverFunction<any> = LinkResolverFunction> = {
     /**
      * The `req` object from a Next.js API route. This is given as a parameter to
      * the API route.
@@ -190,11 +178,93 @@ declare type PreviewConfig = {
      *
      * @see To learn more about Link Resolver: {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver}
      */
-    linkResolver?: LinkResolverFunction;
+    linkResolver?: TLinkResolverFunction;
     /**
      * 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 API route is unable to detect the app's `basePath` automatically. It
+     * must be provided to `redirectToPreviewURL()` manually.
+     */
+    basePath?: string;
+};
+/**
+ * Redirects a user to the URL of a previewed Prismic document from within a
+ * Next.js API route.
+ */
+declare function redirectToPreviewURL<TLinkResolverFunction extends LinkResolverFunction<any>>(config: RedirectToPreviewURLConfig<TLinkResolverFunction>): Promise<void>;
+
+declare type PrismicNextImageProps = Omit<ImageProps, "src" | "alt" | "width" | "height"> & {
+    /**
+     * The Prismic Image field or thumbnail to render.
+     */
+    field: prismicT.ImageFieldImage | null | undefined;
+    /**
+     * An object of Imgix URL API parameters to transform the image.
+     *
+     * @see https://docs.imgix.com/apis/rendering
+     */
+    imgixParams?: ImgixURLParams;
+    /**
+     * Declare an image as decorative by providing `alt=""`.
+     *
+     * See:
+     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+     */
+    alt?: "";
+    /**
+     * Declare an image as decorative only if the Image field does not have
+     * alternative text by providing `fallbackAlt=""`.
+     *
+     * See:
+     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+     */
+    fallbackAlt?: "";
 };
+/**
+ * React component that renders an image from a Prismic Image field or one of
+ * its thumbnails using `next/image`. It will automatically set the `alt`
+ * attribute using the Image field's `alt` property.
+ *
+ * It uses an Imgix URL-based loader by default. A custom loader can be provided
+ * with the `loader` prop. If you would like to use the Next.js Image
+ * Optimization API instead, set `loader={undefined}`.
+ *
+ * @param props - Props for the component.
+ *
+ * @returns A responsive image component using `next/image` for the given Image field.
+ *
+ * @see To learn more about `next/image`, see: https://nextjs.org/docs/api-reference/next/image
+ */
+declare const PrismicNextImage: ({ field, imgixParams, alt, fallbackAlt, layout, ...restProps }: PrismicNextImageProps) => JSX.Element | null;
+
+/**
+ * Configuration for creating a Prismic client with automatic preview support in
+ * Next.js apps.
+ */
+declare type CreateClientConfig = {
+    /**
+     * Preview data coming from Next.js context object. This context object comes
+     * from `getStaticProps` or `getServerSideProps`.
+     *
+     * Pass `previewData` when using outside a Next.js API endpoint.
+     */
+    previewData?: PreviewData;
+    /**
+     * A Next.js API endpoint request object.
+     *
+     * Pass a `req` object when using in a Next.js API endpoint.
+     */
+    req?: NextApiRequest;
+} & ClientConfig;
 
-export { CreateClientConfig, EnableAutoPreviewsConfig, ExitPreviewConfig as ExitPreviewParams, PreviewConfig, PrismicPreview, PrismicPreviewProps, SetPreviewDataConfig, enableAutoPreviews, exitPreview, redirectToPreviewURL, setPreviewData };
+export { CreateClientConfig, EnableAutoPreviewsConfig, ExitPreviewConfig, PrismicNextImage, PrismicNextImageProps, PrismicPreview, PrismicPreviewProps, RedirectToPreviewURLConfig, SetPreviewDataConfig, enableAutoPreviews, exitPreview, redirectToPreviewURL, setPreviewData };