@prismicio/next 2.0.1 → 2.0.2-canary.6f580fa

package/dist/PrismicNextLink.d.ts

@@ -1,125 +0,0 @@
-import { ComponentProps } from "react";
-import Link from "next/link";
-import { AsLinkAttrsConfig, LinkField, LinkResolverFunction, PrismicDocument } from "@prismicio/client";
-export type PrismicNextLinkProps = Omit<ComponentProps<typeof Link>, "field" | "document" | "href" | "rel"> & {
-    linkResolver?: LinkResolverFunction;
-    rel?: string | AsLinkAttrsConfig["rel"];
-} & ({
-    field: LinkField | null | undefined;
-    document?: never;
-    href?: never;
-} | {
-    field?: never;
-    document: PrismicDocument | null | undefined;
-    href?: never;
-} | {
-    field?: never;
-    document?: never;
-    href: ComponentProps<typeof Link>["href"];
-});
-export declare const PrismicNextLink: import("react").ForwardRefExoticComponent<(Omit<Omit<Omit<import("react").AnchorHTMLAttributes<HTMLAnchorElement>, keyof {
-    href: string | import("url").UrlObject;
-    as?: string | import("url").UrlObject;
-    replace?: boolean;
-    scroll?: boolean;
-    shallow?: boolean;
-    passHref?: boolean;
-    prefetch?: boolean | null;
-    locale?: string | false;
-    legacyBehavior?: boolean;
-    onMouseEnter?: React.MouseEventHandler<HTMLAnchorElement>;
-    onTouchStart?: React.TouchEventHandler<HTMLAnchorElement>;
-    onClick?: React.MouseEventHandler<HTMLAnchorElement>;
-}> & {
-    href: string | import("url").UrlObject;
-    as?: string | import("url").UrlObject;
-    replace?: boolean;
-    scroll?: boolean;
-    shallow?: boolean;
-    passHref?: boolean;
-    prefetch?: boolean | null;
-    locale?: string | false;
-    legacyBehavior?: boolean;
-    onMouseEnter?: React.MouseEventHandler<HTMLAnchorElement>;
-    onTouchStart?: React.TouchEventHandler<HTMLAnchorElement>;
-    onClick?: React.MouseEventHandler<HTMLAnchorElement>;
-} & {
-    children?: React.ReactNode | undefined;
-} & import("react").RefAttributes<HTMLAnchorElement>, "rel" | "field" | "document" | "href"> & {
-    linkResolver?: LinkResolverFunction;
-    rel?: string | AsLinkAttrsConfig["rel"];
-} & {
-    field: LinkField | null | undefined;
-    document?: never;
-    href?: never;
-}, "ref"> | Omit<Omit<Omit<import("react").AnchorHTMLAttributes<HTMLAnchorElement>, keyof {
-    href: string | import("url").UrlObject;
-    as?: string | import("url").UrlObject;
-    replace?: boolean;
-    scroll?: boolean;
-    shallow?: boolean;
-    passHref?: boolean;
-    prefetch?: boolean | null;
-    locale?: string | false;
-    legacyBehavior?: boolean;
-    onMouseEnter?: React.MouseEventHandler<HTMLAnchorElement>;
-    onTouchStart?: React.TouchEventHandler<HTMLAnchorElement>;
-    onClick?: React.MouseEventHandler<HTMLAnchorElement>;
-}> & {
-    href: string | import("url").UrlObject;
-    as?: string | import("url").UrlObject;
-    replace?: boolean;
-    scroll?: boolean;
-    shallow?: boolean;
-    passHref?: boolean;
-    prefetch?: boolean | null;
-    locale?: string | false;
-    legacyBehavior?: boolean;
-    onMouseEnter?: React.MouseEventHandler<HTMLAnchorElement>;
-    onTouchStart?: React.TouchEventHandler<HTMLAnchorElement>;
-    onClick?: React.MouseEventHandler<HTMLAnchorElement>;
-} & {
-    children?: React.ReactNode | undefined;
-} & import("react").RefAttributes<HTMLAnchorElement>, "rel" | "field" | "document" | "href"> & {
-    linkResolver?: LinkResolverFunction;
-    rel?: string | AsLinkAttrsConfig["rel"];
-} & {
-    field?: never;
-    document: PrismicDocument | null | undefined;
-    href?: never;
-}, "ref"> | Omit<Omit<Omit<import("react").AnchorHTMLAttributes<HTMLAnchorElement>, keyof {
-    href: string | import("url").UrlObject;
-    as?: string | import("url").UrlObject;
-    replace?: boolean;
-    scroll?: boolean;
-    shallow?: boolean;
-    passHref?: boolean;
-    prefetch?: boolean | null;
-    locale?: string | false;
-    legacyBehavior?: boolean;
-    onMouseEnter?: React.MouseEventHandler<HTMLAnchorElement>;
-    onTouchStart?: React.TouchEventHandler<HTMLAnchorElement>;
-    onClick?: React.MouseEventHandler<HTMLAnchorElement>;
-}> & {
-    href: string | import("url").UrlObject;
-    as?: string | import("url").UrlObject;
-    replace?: boolean;
-    scroll?: boolean;
-    shallow?: boolean;
-    passHref?: boolean;
-    prefetch?: boolean | null;
-    locale?: string | false;
-    legacyBehavior?: boolean;
-    onMouseEnter?: React.MouseEventHandler<HTMLAnchorElement>;
-    onTouchStart?: React.TouchEventHandler<HTMLAnchorElement>;
-    onClick?: React.MouseEventHandler<HTMLAnchorElement>;
-} & {
-    children?: React.ReactNode | undefined;
-} & import("react").RefAttributes<HTMLAnchorElement>, "rel" | "field" | "document" | "href"> & {
-    linkResolver?: LinkResolverFunction;
-    rel?: string | AsLinkAttrsConfig["rel"];
-} & {
-    field?: never;
-    document?: never;
-    href: ComponentProps<typeof Link>["href"];
-}, "ref">) & import("react").RefAttributes<HTMLAnchorElement>>;

package/dist/PrismicPreview.d.ts

@@ -1,31 +0,0 @@
-import type { FC, ReactNode } from "react";
-/** Props for `<PrismicPreview>`. */
-export type PrismicPreviewProps = {
-    /**
-     * The name of your Prismic repository. A Prismic Toolbar will be registered
-     * using this repository.
-     */
-    repositoryName: string;
-    /**
-     * The URL of your app's Prismic preview endpoint (default: `/api/preview`).
-     * This URL will be fetched on preview update events.
-     */
-    updatePreviewURL?: string;
-    /**
-     * The URL of your app's exit preview endpoint (default: `/api/exit-preview`).
-     * This URL will be fetched on preview exit events.
-     */
-    exitPreviewURL?: string;
-    /** Children to render adjacent to the Prismic Toolbar. */
-    children?: ReactNode;
-};
-/**
- * React component that sets up Prismic Previews using the Prismic Toolbar. When
- * the Prismic Toolbar send events to the browser, such as on preview updates
- * and exiting, this component will automatically refresh the page with the
- * changes.
- *
- * This component can be wrapped around your app or added anywhere in your app's
- * tree. It must be rendered on every page.
- */
-export declare const PrismicPreview: FC<PrismicPreviewProps>;

package/dist/PrismicPreviewClient.d.ts

@@ -1,9 +0,0 @@
-import { FC } from "react";
-type PrismicPreviewClientProps = {
-    repositoryName: string;
-    isDraftMode: boolean;
-    updatePreviewURL?: string;
-    exitPreviewURL?: string;
-};
-export declare const PrismicPreviewClient: FC<PrismicPreviewClientProps>;
-export {};

package/dist/createLocaleRedirect.d.ts

@@ -1,10 +0,0 @@
-/**
- * @deprecated `createLocaleRedirect()` has been removed due to performance
- *   issues.
- */
-export declare function createLocaleRedirect(): void;
-/**
- * @deprecated `createLocaleRedirect()` has been removed due to performance
- *   issues.
- */
-export type CreateLocaleRedirectConfig = never;

package/dist/enableAutoPreviews.d.ts

@@ -1,13 +0,0 @@
-import { type Client } from "@prismicio/client";
-/** Configuration for `enableAutoPreviews`. */
-export type EnableAutoPreviewsConfig = {
-    /** Prismic client with which automatic previews will be enabled. */
-    client: Pick<Client, "queryContentFromRef" | "enableAutoPreviewsFromReq">;
-};
-/**
- * Configures a Prismic client to automatically query draft content during a
- * preview session.
- *
- * @param config - Configuration for the function.
- */
-export declare function enableAutoPreviews(config: EnableAutoPreviewsConfig): void;

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,15 +0,0 @@
-export { exitPreview } from "./exitPreview";
-export { PrismicPreview } from "./PrismicPreview";
-export type { PrismicPreviewProps } from "./PrismicPreview";
-export { PrismicNextLink } from "./PrismicNextLink";
-export type { PrismicNextLinkProps } from "./PrismicNextLink";
-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 { imgixLoader } from "./imgixLoader";
-export type { CreateClientConfig } from "./types";
-export { createLocaleRedirect } from "./createLocaleRedirect";
-export type { CreateLocaleRedirectConfig } from "./createLocaleRedirect";

package/dist/lib/devMsg.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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"
- * ```
- *
- * @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/resolveDefaultExport.d.ts

@@ -1,18 +0,0 @@
-/**
- * Resolves a module's default export. The module may provide its default export
- * as a `default` property on an object. This happens when named and default
- * exports are mixed in modules.
- *
- * In ES Modules, mixing is fine since the module resolver can distinguish
- * default and named exports. In transpiled modules, however, all exports are
- * put into a single object, and the default export is provided at a property
- * called `default`.
- *
- * This helper is needed by Next.js uses CJS files with named and default
- * exports.
- *
- * This helper _should_ be a temporary hack until Next.js and Node.js resolve
- * their ESM difficulties. This will likely not be removed any time soon,
- * unfortunately.
- */
-export declare function resolveDefaultExport<T>(mod: T): T;

package/dist/package.json.cjs

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const version = "2.0.1";
-exports.version = version;
-//# sourceMappingURL=package.json.cjs.map

package/dist/package.json.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"package.json.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

package/dist/pages/PrismicPreview.d.ts

@@ -1,31 +0,0 @@
-import { type ReactNode, FC } from "react";
-/** Props for `<PrismicPreview>`. */
-export type PrismicPreviewProps = {
-    /**
-     * The name of your Prismic repository. A Prismic Toolbar will be registered
-     * using this repository.
-     */
-    repositoryName: string;
-    /**
-     * The URL of your app's Prismic preview endpoint (default: `/api/preview`).
-     * This URL will be fetched on preview update events.
-     */
-    updatePreviewURL?: string;
-    /**
-     * The URL of your app's exit preview endpoint (default: `/api/exit-preview`).
-     * This URL will be fetched on preview exit events.
-     */
-    exitPreviewURL?: string;
-    /** Children to render adjacent to the Prismic Toolbar. */
-    children?: ReactNode;
-};
-/**
- * React component that sets up Prismic Previews using the Prismic Toolbar. When
- * the Prismic Toolbar send events to the browser, such as on preview updates
- * and exiting, this component will automatically refresh the page with the
- * changes.
- *
- * This component can be wrapped around your app or added anywhere in your app's
- * tree. It must be rendered on every page.
- */
-export declare const PrismicPreview: FC<PrismicPreviewProps>;

package/dist/pages/enableAutoPreviews.d.ts

@@ -1,31 +0,0 @@
-import type { PreviewData } from "next";
-import type { Client } from "@prismicio/client";
-import type { NextApiRequestLike } from "./types";
-/**
- * Configuration for `enableAutoPreviews`.
- *
- * @typeParam TPreviewData - Next.js preview data object.
- */
-export type EnableAutoPreviewsConfig = {
-    /** Prismic client with which automatic previews will be enabled. */
-    client: Pick<Client, "queryContentFromRef" | "enableAutoPreviewsFromReq">;
-    /**
-     * The `previewData` object provided in the `getStaticProps()` or
-     * `getServerSideProps()` context object.
-     */
-    previewData?: PreviewData;
-    /**
-     * The `req` object from a Next.js API route.
-     *
-     * @see Next.js API route docs: \<https://nextjs.org/docs/api-routes/introduction\>
-     */
-    req?: NextApiRequestLike;
-};
-/**
- * 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 function enableAutoPreviews(config: EnableAutoPreviewsConfig): void;

package/dist/pages/exitPreview.d.ts

@@ -1,33 +0,0 @@
-import type { NextApiRequestLike, NextApiResponseLike } from "./types";
-/** Configuration for `exitPreview()`. */
-export type ExitPreviewAPIRouteConfig = {
-    /**
-     * The `req` object from a Next.js API route.
-     *
-     * @see Next.js API route docs: \<https://nextjs.org/docs/api-routes/introduction\>
-     */
-    req?: NextApiRequestLike;
-    /**
-     * The `res` object from a Next.js API route.
-     *
-     * @see Next.js API route docs: \<https://nextjs.org/docs/api-routes/introduction\>
-     */
-    res: NextApiResponseLike;
-};
-/**
- * Ends a Prismic preview session within a Next.js app. This function should be
- * used in an API route.
- *
- * @example
- *
- * ```typescript
- * // src/pages/api/exit-preview.js
- *
- * import { exitPreview } from "@prismicio/next";
- *
- * export default function handler(_req, res) {
- * 	return exitPreview({ res });
- * }
- * ```
- */
-export declare function exitPreview(config: ExitPreviewAPIRouteConfig): void;

package/dist/pages/index.d.ts

@@ -1,18 +0,0 @@
-export { PrismicNextLink } from "../PrismicNextLink";
-export { type PrismicNextLinkProps } from "../PrismicNextLink";
-export { PrismicNextImage } from "../PrismicNextImage";
-export { type PrismicNextImageProps } from "../PrismicNextImage";
-export { imgixLoader } from "../imgixLoader";
-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 { exitPreview } from "./exitPreview";
-export type { ExitPreviewAPIRouteConfig } from "./exitPreview";
-export { setPreviewData } from "./setPreviewData";
-export type { SetPreviewDataConfig } from "./setPreviewData";
-export type { CreateClientConfig } from "./types";
-export { createLocaleRedirect } from "../createLocaleRedirect";
-export type { CreateLocaleRedirectConfig } from "../createLocaleRedirect";

package/dist/pages/redirectToPreviewURL.d.ts

@@ -1,43 +0,0 @@
-import type { LinkResolverFunction, Client } from "@prismicio/client";
-import type { NextApiRequestLike, NextApiResponseLike } from "./types";
-export type RedirectToPreviewURLConfig = {
-    /** The Prismic client configured for the preview session's repository. */
-    client: Pick<Client, "resolvePreviewURL">;
-    /**
-     * The `req` object from a Next.js API route.
-     *
-     * @see Next.js API route docs: \<https://nextjs.org/docs/pages/building-your-application/routing/api-routes\>
-     */
-    req: NextApiRequestLike;
-    /**
-     * The `res` object from a Next.js API route.
-     *
-     * @see Next.js API route docs: \<https://nextjs.org/docs/pages/building-your-application/routing/api-routes\>
-     */
-    res: NextApiResponseLike;
-    /**
-     * 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?: LinkResolverFunction;
-    /**
-     * 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 Router Handler or API route is unable to detect the app's `basePath`
-     * automatically. It must be provided to `redirectToPreviewURL()` manually.
-     */
-    basePath?: string;
-};
-export declare function redirectToPreviewURL(config: RedirectToPreviewURLConfig): Promise<void>;

package/dist/pages/setPreviewData.d.ts

@@ -1,18 +0,0 @@
-import type { NextApiRequestLike, NextApiResponseLike } from "./types";
-/** Configuration for `setPreviewData`. */
-export type SetPreviewDataConfig = {
-    /**
-     * The `req` object from a Next.js API route.
-     *
-     * @see Next.js API route docs: \<https://nextjs.org/docs/api-routes/introduction\>
-     */
-    req: NextApiRequestLike;
-    /**
-     * The `res` object from a Next.js API route.
-     *
-     * @see Next.js API route docs: \<https://nextjs.org/docs/api-routes/introduction\>
-     */
-    res: NextApiResponseLike;
-};
-/** Set Prismic preview data for Next.js's Preview Mode. */
-export declare function setPreviewData({ req, res }: SetPreviewDataConfig): void;

package/dist/pages/types.d.ts

@@ -1,30 +0,0 @@
-import type { ClientConfig } from "@prismicio/client";
-import { EnableAutoPreviewsConfig } from "./enableAutoPreviews";
-/**
- * Configuration for creating a Prismic client with automatic preview support in
- * Next.js apps.
- */
-export type CreateClientConfig = ClientConfig & Pick<EnableAutoPreviewsConfig, "previewData" | "req">;
-/**
- * The minimal set of properties needed from `next`'s `NextApiRequest` type.
- *
- * This request type is only compatible with API routes defined in the `pages`
- * directory.
- */
-export type NextApiRequestLike = {
-    query: Partial<Record<string, string | string[]>>;
-    cookies: Partial<Record<string, string>>;
-};
-/**
- * The minimal set of properties needed from `next`'s `NextApiResponse` type.
- *
- * This request type is only compatible with API routes defined in the `pages`
- * directory.
- */
-export type NextApiResponseLike = {
-    redirect(url: string): NextApiResponseLike;
-    clearPreviewData(): NextApiResponseLike;
-    setHeader(name: string, value: string | string[]): NextApiResponseLike;
-    json(body: any): void;
-    setPreviewData(data: object | string): NextApiResponseLike;
-};

package/dist/pages.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"pages.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;"}

package/dist/redirectToPreviewURL.d.ts

@@ -1,28 +0,0 @@
-import { type Client, type LinkResolverFunction } from "@prismicio/client";
-import { NextRequestLike } from "./types";
-export type RedirectToPreviewURLConfig = {
-    /** The Prismic client configured for the preview session's repository. */
-    client: Pick<Client, "resolvePreviewURL">;
-    /**
-     * The `request` object from a Next.js Route Handler.
-     *
-     * @see Next.js Route Handler docs: \<https://nextjs.org/docs/app/building-your-application/routing/route-handlers\>
-     */
-    request: NextRequestLike;
-    /**
-     * 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?: LinkResolverFunction;
-    /**
-     * 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;
-};
-export declare function redirectToPreviewURL(config: RedirectToPreviewURLConfig): Promise<never>;

package/dist/types.d.ts

@@ -1,26 +0,0 @@
-import type { ClientConfig } from "@prismicio/client";
-declare module "@prismicio/client" {
-    interface RequestInitLike {
-        next?: RequestInit["next"];
-    }
-}
-/** @deprecated Use `@prismicio/client`'s `ClientConfig`. */
-export type CreateClientConfig = ClientConfig;
-/**
- * The minimal set of properties needed from `next`'s `NextRequest` type.
- *
- * This request type is only compatible with Route Handlers defined in the `app`
- * directory.
- */
-export type NextRequestLike = {
-    headers: {
-        get(name: string): string | null;
-    };
-    url: string;
-    nextUrl: {
-        pathname: string;
-        searchParams: {
-            get(name: string): string | null;
-        };
-    };
-};