@prismicio/next 0.1.6-alpha.1 → 0.1.7

package/dist/enableAutoPreviews.d.ts

@@ -1,38 +1,38 @@
-import { PreviewData } from "next";
-import { Client, HttpRequestLike } from "@prismicio/client";
-/**
- * Configuration for `enableAutoPreviews`.
- *
- * @typeParam TPreviewData - Next.js preview data object.
- */
-export 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.
- */
-export declare const enableAutoPreviews: <TPreviewData extends PreviewData>(config: EnableAutoPreviewsConfig<TPreviewData>) => void;
+import { PreviewData } from "next";
+import { Client, HttpRequestLike } from "@prismicio/client";
+/**
+ * Configuration for `enableAutoPreviews`.
+ *
+ * @typeParam TPreviewData - Next.js preview data object.
+ */
+export 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.
+ */
+export declare const enableAutoPreviews: <TPreviewData extends PreviewData>(config: EnableAutoPreviewsConfig<TPreviewData>) => void;

package/dist/exitPreview.d.ts

@@ -1,34 +1,34 @@
-import type { NextApiResponse, NextApiRequest } from "next";
-/**
- * Configuration for `exitPreview`.
- */
-export declare type ExitPreviewConfig = {
-    /**
-     * 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: {
-        headers: NextApiRequest["headers"];
-    };
-    /**
-     * 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: {
-        clearPreviewData: NextApiResponse["clearPreviewData"];
-        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.
- */
-export declare function exitPreview(config: ExitPreviewConfig): void;
+import type { NextApiResponse, NextApiRequest } from "next";
+/**
+ * Configuration for `exitPreview`.
+ */
+export declare type ExitPreviewConfig = {
+    /**
+     * 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: {
+        headers: NextApiRequest["headers"];
+    };
+    /**
+     * 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: {
+        clearPreviewData: NextApiResponse["clearPreviewData"];
+        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.
+ */
+export declare function exitPreview(config: ExitPreviewConfig): void;

package/dist/index.d.ts

@@ -1,13 +1,13 @@
-export { setPreviewData } from "./setPreviewData";
-export type { SetPreviewDataConfig } from "./setPreviewData";
-export { exitPreview } from "./exitPreview";
-export type { ExitPreviewConfig } from "./exitPreview";
-export { PrismicPreview } from "./PrismicPreview";
-export type { PrismicPreviewProps } from "./PrismicPreview";
-export { enableAutoPreviews } from "./enableAutoPreviews";
-export type { EnableAutoPreviewsConfig } from "./enableAutoPreviews";
-export { redirectToPreviewURL } from "./redirectToPreviewURL";
-export type { RedirectToPreviewURLConfig } from "./redirectToPreviewURL";
-export { PrismicNextImage } from "./PrismicNextImage";
-export type { PrismicNextImageProps } from "./PrismicNextImage";
-export type { CreateClientConfig } from "./types";
+export { setPreviewData } from "./setPreviewData";
+export type { SetPreviewDataConfig } from "./setPreviewData";
+export { exitPreview } from "./exitPreview";
+export type { ExitPreviewConfig } from "./exitPreview";
+export { PrismicPreview } from "./PrismicPreview";
+export type { PrismicPreviewProps } from "./PrismicPreview";
+export { enableAutoPreviews } from "./enableAutoPreviews";
+export type { EnableAutoPreviewsConfig } from "./enableAutoPreviews";
+export { redirectToPreviewURL } from "./redirectToPreviewURL";
+export type { RedirectToPreviewURLConfig } from "./redirectToPreviewURL";
+export { PrismicNextImage } from "./PrismicNextImage";
+export type { PrismicNextImageProps } from "./PrismicNextImage";
+export type { CreateClientConfig } from "./types";

package/dist/lib/__PRODUCTION__.d.ts

@@ -1,7 +1,7 @@
-/**
- * `true` if in the production environment, `false` otherwise.
- *
- * This boolean can be used to perform actions only in development environments,
- * such as logging.
- */
-export declare const __PRODUCTION__: boolean;
+/**
+ * `true` if in the production environment, `false` otherwise.
+ *
+ * This boolean can be used to perform actions only in development environments,
+ * such as logging.
+ */
+export declare const __PRODUCTION__: boolean;

package/dist/lib/devMsg.d.ts

@@ -1,16 +1,16 @@
-/**
- * Returns a `prismic.dev/msg` URL for a given message slug.
- *
- * @example
- *
- * ```ts
- * devMsg("missing-param");
- * // => "https://prismic.dev/msg/next/v1.2.3/missing-param.md"
- * ```
- *
- * @param slug - Slug for the message. This corresponds to a Markdown file in
- *   the Git repository's `/messages` directory.
- *
- * @returns The `prismic.dev/msg` URL for the given slug.
- */
-export declare const devMsg: (slug: string) => string;
+/**
+ * Returns a `prismic.dev/msg` URL for a given message slug.
+ *
+ * @example
+ *
+ * ```ts
+ * devMsg("missing-param");
+ * // => "https://prismic.dev/msg/next/v1.2.3/missing-param.md"
+ * ```
+ *
+ * @param slug - Slug for the message. This corresponds to a Markdown file in
+ *   the Git repository's `/messages` directory.
+ *
+ * @returns The `prismic.dev/msg` URL for the given slug.
+ */
+export declare const devMsg: (slug: string) => string;

package/dist/lib/getPreviewCookieRepositoryName.d.ts

@@ -1,9 +1,9 @@
-/**
- * Extracts preview reference repo name from stringified Prismic preview cookie
- *
- * @param previewCookie - The Prismic preview cookie.
- *
- * @returns The repository name for the Prismic preview cookie. If the cookie
- *   represents an inactive preview session, `undefined` will be returned.
- */
-export declare const getPreviewCookieRepositoryName: (previewCookie: string) => string | undefined;
+/**
+ * Extracts preview reference repo name from stringified Prismic preview cookie
+ *
+ * @param previewCookie - The Prismic preview cookie.
+ *
+ * @returns The repository name for the Prismic preview cookie. If the cookie
+ *   represents an inactive preview session, `undefined` will be returned.
+ */
+export declare const getPreviewCookieRepositoryName: (previewCookie: string) => string | undefined;

package/dist/lib/getPrismicPreviewCookie.d.ts

@@ -1,9 +1,9 @@
-/**
- * Returns the value of a cookie from a given cookie store.
- *
- * @param cookieJar - The stringified cookie store from which to read the
- *   cookie.
- *
- * @returns The value of the cookie, if it exists.
- */
-export declare const getPrismicPreviewCookie: (cookieJar: string) => string | undefined;
+/**
+ * Returns the value of a cookie from a given cookie store.
+ *
+ * @param cookieJar - The stringified cookie store from which to read the
+ *   cookie.
+ *
+ * @returns The value of the cookie, if it exists.
+ */
+export declare const getPrismicPreviewCookie: (cookieJar: string) => string | undefined;

package/dist/package.cjs

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
-const version = "0.1.6-alpha.1";
+const version = "0.1.7";
 exports.version = version;
 //# sourceMappingURL=package.cjs.map

package/dist/package.js

@@ -1,4 +1,4 @@
-const version = "0.1.6-alpha.1";
+const version = "0.1.7";
 export {
   version
 };

package/dist/redirectToPreviewURL.d.ts

@@ -1,59 +1,59 @@
-import type { Client } from "@prismicio/client";
-import type { NextApiRequest, NextApiResponse } from "next";
-import type { LinkResolverFunction } from "@prismicio/helpers";
-/**
- * Preview config for enabling previews with redirectToPreviewURL
- */
-export 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.
-     *
-     * @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.
-     *
-     * **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.
- */
-export declare function redirectToPreviewURL<TLinkResolverFunction extends LinkResolverFunction<any>>(config: RedirectToPreviewURLConfig<TLinkResolverFunction>): Promise<void>;
+import type { Client } from "@prismicio/client";
+import type { NextApiRequest, NextApiResponse } from "next";
+import type { LinkResolverFunction } from "@prismicio/helpers";
+/**
+ * Preview config for enabling previews with redirectToPreviewURL
+ */
+export 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.
+     *
+     * @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.
+     *
+     * **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.
+ */
+export declare function redirectToPreviewURL<TLinkResolverFunction extends LinkResolverFunction<any>>(config: RedirectToPreviewURLConfig<TLinkResolverFunction>): Promise<void>;

package/dist/setPreviewData.d.ts

@@ -1,29 +1,29 @@
-import { NextApiResponse, NextApiRequest } from "next";
-/**
- * Configuration for `setPreviewData`.
- */
-export declare type SetPreviewDataConfig = {
-    /**
-     * 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"];
-        cookies: NextApiRequest["cookies"];
-    };
-    /**
-     * 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: {
-        setPreviewData: NextApiResponse["setPreviewData"];
-    };
-};
-/**
- * Set Prismic preview data for Next.js's Preview Mode.
- */
-export declare function setPreviewData({ req, res }: SetPreviewDataConfig): void;
+import { NextApiResponse, NextApiRequest } from "next";
+/**
+ * Configuration for `setPreviewData`.
+ */
+export declare type SetPreviewDataConfig = {
+    /**
+     * 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"];
+        cookies: NextApiRequest["cookies"];
+    };
+    /**
+     * 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: {
+        setPreviewData: NextApiResponse["setPreviewData"];
+    };
+};
+/**
+ * Set Prismic preview data for Next.js's Preview Mode.
+ */
+export declare function setPreviewData({ req, res }: SetPreviewDataConfig): void;

package/dist/types.d.ts

@@ -1,21 +1,21 @@
-import type { PreviewData, NextApiRequest } from "next";
-import type { ClientConfig } from "@prismicio/client";
-/**
- * Configuration for creating a Prismic client with automatic preview support in
- * Next.js apps.
- */
-export 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;
+import type { PreviewData, NextApiRequest } from "next";
+import type { ClientConfig } from "@prismicio/client";
+/**
+ * Configuration for creating a Prismic client with automatic preview support in
+ * Next.js apps.
+ */
+export 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;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/next",
-	"version": "0.1.6-alpha.1",
+	"version": "0.1.7",
 	"description": "Helpers to integrate Prismic into Next.js apps",
 	"keywords": [
 		"typescript",
@@ -46,9 +46,8 @@
 		"unit:watch": "vitest watch"
 	},
 	"dependencies": {
-		"@prismicio/client": "^6.0.0",
-		"@prismicio/helpers": "^2.3.3",
-		"@prismicio/react": "^2.5.0",
+		"@prismicio/client": "^6.7.1",
+		"@prismicio/helpers": "^2.3.5",
 		"@prismicio/types": "^0.2.3",
 		"imgix-url-builder": "^0.0.3"
 	},
@@ -56,16 +55,17 @@
 		"@prismicio/mock": "^0.1.1",
 		"@size-limit/preset-small-lib": "^8.1.0",
 		"@types/react-test-renderer": "^18.0.0",
-		"@typescript-eslint/eslint-plugin": "^5.36.2",
-		"@typescript-eslint/parser": "^5.36.2",
-		"@vitest/coverage-c8": "^0.23.1",
-		"eslint": "^8.23.0",
+		"@typescript-eslint/eslint-plugin": "^5.40.1",
+		"@typescript-eslint/parser": "^5.40.1",
+		"@vitejs/plugin-react": "^2.1.0",
+		"@vitest/coverage-c8": "^0.24.3",
+		"eslint": "^8.25.0",
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-plugin-prettier": "^4.2.1",
-		"eslint-plugin-react": "^7.31.7",
+		"eslint-plugin-react": "^7.31.10",
 		"eslint-plugin-react-hooks": "^4.6.0",
-		"eslint-plugin-tsdoc": "^0.2.16",
-		"happy-dom": "^6.0.4",
+		"eslint-plugin-tsdoc": "^0.2.17",
+		"happy-dom": "^7.5.13",
 		"next": "^12.1.4",
 		"nyc": "^15.1.0",
 		"prettier": "^2.7.1",
@@ -74,10 +74,10 @@
 		"react-test-renderer": "^18.2.0",
 		"size-limit": "^8.1.0",
 		"standard-version": "^9.5.0",
-		"typescript": "^4.8.3",
-		"vite": "^3.1.1",
-		"vite-plugin-sdk": "^0.0.2",
-		"vitest": "^0.23.1"
+		"typescript": "^4.8.4",
+		"vite": "^3.1.8",
+		"vite-plugin-sdk": "^0.0.3",
+		"vitest": "^0.24.3"
 	},
 	"peerDependencies": {
 		"@prismicio/client": "^6.0.0",