feat: cleanup

.env.test.example

@@ -1,2 +1,9 @@
+###############################################################################
+# The following environment variables are used to run Playwright tests.
+# Create a specific account for testing to avoid issues.
+###############################################################################
+
+# The email address for your Prismic account.
 PLAYWRIGHT_PRISMIC_EMAIL=
+# The password to your Prismic account.
 PLAYWRIGHT_PRISMIC_PASSWORD=

.prettierignore

@@ -1,8 +1,9 @@
 # custom
 dist
-example/**/package-lock.json
-example/**/.next
+examples/**/package-lock.json
+*.tgz
 CHANGELOG.md
+e2e-projects/**/.next
 
 # os
 .DS_Store
@@ -38,3 +39,8 @@ coverage
 !.vscode/tasks.json
 !.vscode/launch.json
 *.code-workspace
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
+/tests/.storage-state.json

README.md

@@ -9,8 +9,9 @@
 
 Helpers to integrate Prismic into Next.js apps.
 
-- 👁️  Easily set up Prismic Preview
-- 🖼️  Render optimized images using [`next/image`][next-image] and Prismic's built-in [Imgix][imgix] integration
+- 👁️  Easily set up Prismic previews
+- 👁️  Render Prismic links with [`next/link`][next-link]
+- 🖼️  Optimize Prismic images using [`next/image`][next-image] and Prismic's built-in [Imgix][imgix] integration
 
 ## Install
 
@@ -58,7 +59,8 @@ For more clarity on this project and its structure you can also check out the de
 
 [prismic]: https://prismic.io
 [imgix]: https://imgix.com/
-[next-image]: https://nextjs.org/docs/basic-features/image-optimization
+[next-link]: https://nextjs.org/docs/app/api-reference/components/link
+[next-image]: https://nextjs.org/docs/app/api-reference/components/image
 
 <!-- TODO: Replace link with a more useful one if available -->
 

messages/replace-createLocaleRedirect.md

@@ -33,9 +33,7 @@ The function should be removed from Next.js projects to ensure the best possible
    	"fr-fr": "fr",
    };
 
-   /**
-    * Creates a redirect with an auto-detected locale prepended to the URL.
-    */
+   /** Creates a redirect with an auto-detected locale prepended to the URL. */
    export function createLocaleRedirect(request: NextRequest): Response {
    	const headers = {
    		"accept-language": request.headers.get("accept-language"),
@@ -49,9 +47,7 @@ The function should be removed from Next.js projects to ensure the best possible
    	return Response.redirect(request.nextUrl);
    }
 
-   /**
-    * Determines if a pathname has a locale as its first segment.
-    */
+   /** Determines if a pathname has a locale as its first segment. */
    export function pathnameHasLocale(request: NextRequest): boolean {
    	const regexp = new RegExp(`^/(${Object.values(LOCALES).join("|")})(\/|$)`);
 

package.json

@@ -57,7 +57,7 @@
 		"release:alpha:dry": "standard-version --release-as minor --prerelease alpha --dry-run",
 		"release:dry": "standard-version --dry-run",
 		"size": "size-limit",
-		"test": "npm run lint && npm run types && npm run build && npm run size && npm run e2e",
+		"test": "npm run lint && npm run types && npm run build && npm run e2e && npm run size && npm run e2e",
 		"types": "tsc --noEmit",
 		"e2e": "playwright test",
 		"e2e:ui": "npm run e2e -- --ui"

src/PrismicNextImage.tsx

@@ -1,14 +1,14 @@
 "use client";
 
+import { ReactElement } from "react";
 import Image, { ImageProps } from "next/image";
 import { buildURL, ImgixURLParams } from "imgix-url-builder";
-import * as prismic from "@prismicio/client";
+import { ImageFieldImage, isFilled } from "@prismicio/client";
 import { DEV } from "esm-env";
 
 import { devMsg } from "./lib/devMsg.js";
 
 import { imgixLoader } from "./imgixLoader.js";
-import { ReactElement } from "react";
 
 const castInt = (input: string | number | undefined): number | undefined => {
 	if (typeof input === "number" || typeof input === "undefined") {
@@ -29,7 +29,7 @@ export type PrismicNextImageProps = Omit<
 	"src" | "alt" | "loader"
 > & {
 	/** The Prismic Image field or thumbnail to render. */
-	field: prismic.ImageFieldImage | null | undefined;
+	field: ImageFieldImage | null | undefined;
 
 	/**
 	 * An object of Imgix URL API parameters to transform the image.
@@ -110,7 +110,7 @@ export const PrismicNextImage = ({
 		}
 	}
 
-	if (prismic.isFilled.imageThumbnail(field)) {
+	if (isFilled.imageThumbnail(field)) {
 		const resolvedImgixParams = imgixParams;
 		for (const x in imgixParams) {
 			if (resolvedImgixParams[x as keyof typeof resolvedImgixParams] === null) {

src/PrismicNextLink.tsx

@@ -1,41 +1,47 @@
-import * as React from "react";
-import * as prismic from "@prismicio/client";
+import { ComponentProps, ReactElement, forwardRef } from "react";
 import Link from "next/link";
+import {
+	AsLinkAttrsConfig,
+	LinkField,
+	LinkResolverFunction,
+	PrismicDocument,
+	asLinkAttrs,
+} from "@prismicio/client";
 
 export type PrismicNextLinkProps = Omit<
-	React.ComponentProps<typeof Link>,
+	ComponentProps<typeof Link>,
 	"field" | "document" | "href" | "rel"
 > & {
-	linkResolver?: prismic.LinkResolverFunction;
-	rel?: string | prismic.AsLinkAttrsConfig["rel"];
+	linkResolver?: LinkResolverFunction;
+	rel?: string | AsLinkAttrsConfig["rel"];
 } & (
 		| {
-				field: prismic.LinkField | null | undefined;
+				field: LinkField | null | undefined;
 				document?: never;
 				href?: never;
 		  }
 		| {
 				field?: never;
-				document: prismic.PrismicDocument | null | undefined;
+				document: PrismicDocument | null | undefined;
 				href?: never;
 		  }
 		| {
 				field?: never;
 				document?: never;
-				href: React.ComponentProps<typeof Link>["href"];
+				href: ComponentProps<typeof Link>["href"];
 		  }
 	);
 
-export const PrismicNextLink = React.forwardRef<
+export const PrismicNextLink = forwardRef<
 	HTMLAnchorElement,
 	PrismicNextLinkProps
->(function PrismicNextLink(props, ref): React.ReactElement | null {
+>(function PrismicNextLink(props, ref): ReactElement | null {
 	const { field, document, linkResolver, children, ...restProps } = props;
 	const {
 		href: computedHref,
 		rel: computedRel,
 		...attrs
-	} = prismic.asLinkAttrs(field ?? document, {
+	} = asLinkAttrs(field ?? document, {
 		linkResolver,
 		rel: typeof restProps.rel === "function" ? restProps.rel : undefined,
 	});

src/index.ts

@@ -19,5 +19,5 @@ export { imgixLoader } from "./imgixLoader.js";
 
 export type { CreateClientConfig } from "./types.js";
 
-export { createLocaleRedirect } from "./removed.js";
-export type { CreateLocaleRedirectConfig } from "./removed.js";
+export { createLocaleRedirect } from "./createLocaleRedirect.js";
+export type { CreateLocaleRedirectConfig } from "./createLocaleRedirect.js";

src/pages/index.ts

@@ -23,5 +23,5 @@ export type { SetPreviewDataConfig } from "./setPreviewData.js";
 
 export type { CreateClientConfig } from "./types.js";
 
-export { createLocaleRedirect } from "../removed.js";
-export type { CreateLocaleRedirectConfig } from "../removed.js";
+export { createLocaleRedirect } from "../createLocaleRedirect.js";
+export type { CreateLocaleRedirectConfig } from "../createLocaleRedirect.js";