@prismicio/react 2.0.0-beta.3 → 2.0.0-beta.7

package/dist/index.d.ts

@@ -31,7 +31,7 @@ interface LinkProps {
 /**
  * Props for `<PrismicLink>`.
  */
-declare type PrismicLinkProps<InternalComponent extends string | React.ComponentType<LinkProps> = string | React.ComponentType<LinkProps>, ExternalComponent extends string | React.ComponentType<LinkProps> = string | React.ComponentType<LinkProps>, LinkResolverFunction extends prismicH.LinkResolverFunction<any> = prismicH.LinkResolverFunction> = ComponentProps<InternalComponent> & ComponentProps<ExternalComponent> & {
+declare type PrismicLinkProps<InternalComponent extends string | React.ComponentType<LinkProps> = string | React.ComponentType<LinkProps>, ExternalComponent extends string | React.ComponentType<LinkProps> = string | React.ComponentType<LinkProps>, LinkResolverFunction extends prismicH.LinkResolverFunction = prismicH.LinkResolverFunction> = Omit<ComponentProps<InternalComponent> & ComponentProps<ExternalComponent>, keyof LinkProps> & {
     /**
      * The Link Resolver used to resolve links.
      *
@@ -72,17 +72,17 @@ declare type PrismicLinkProps<InternalComponent extends string | React.Component
      *
      * @see Learn about Prismic Link fields {@link https://prismic.io/docs/core-concepts/link-content-relationship}
      */
-    field?: prismicT.LinkField;
+    field: prismicT.LinkField | null | undefined;
 } | {
     /**
      * The Prismic document to link.
      */
-    document?: prismicT.PrismicDocument;
+    document: prismicT.PrismicDocument | null | undefined;
 } | {
     /**
      * The URL to link.
      */
-    href?: string;
+    href: string | null | undefined;
 });
 /**
  * React component that renders a link from a Prismic Link field.
@@ -99,7 +99,7 @@ declare type PrismicLinkProps<InternalComponent extends string | React.Component
  * @returns The internal or external link component depending on whether the
  *   link is internal or external.
  */
-declare const PrismicLink: <InternalComponent extends string | React.ComponentType<LinkProps> = "a", ExternalComponent extends string | React.ComponentType<LinkProps> = "a", LinkResolverFunction extends prismicH.LinkResolverFunction<any> = prismicH.LinkResolverFunction<string>>(props: PrismicLinkProps<InternalComponent, ExternalComponent, LinkResolverFunction>) => JSX.Element | null;
+declare const PrismicLink: <InternalComponent extends string | React.ComponentType<LinkProps>, ExternalComponent extends string | React.ComponentType<LinkProps>, LinkResolverFunction extends prismicH.LinkResolverFunction<string>>(props: PrismicLinkProps<InternalComponent, ExternalComponent, LinkResolverFunction>) => JSX.Element | null;
 
 /**
  * A function mapping Rich Text block types to React Components. It is used to
@@ -233,12 +233,13 @@ declare type PrismicTextProps = {
  * @example Rendering a Rich Text field as plain text.
  *
  * ```jsx
- * <PrismicText field={document.data.content} />
+ * <PrismicText field={document.data.content} />;
  * ```
  *
  * @param props - Props for the component.
  *
  * @returns The Rich Text field's content as plain text.
+ *
  * @see Learn about Rich Text fields {@link https://prismic.io/docs/core-concepts/rich-text-title}
  */
 declare const PrismicText: (props: PrismicTextProps) => JSX.Element | null;
@@ -286,12 +287,12 @@ declare type PrismicRichTextProps = {
      *
      * ```jsx
      * (type, node, content, children) => {
-     *  switch (type) {
-     *    case 'heading1': {
-     *      return <Heading>{chidlren}</Heading>
-     *    }
-     *  }
-     * }
+     * 	switch (type) {
+     * 		case "heading1": {
+     * 			return <Heading>{chidlren}</Heading>;
+     * 		}
+     * 	}
+     * };
      * ```
      */
     components?: JSXMapSerializer | JSXFunctionSerializer;
@@ -327,23 +328,24 @@ declare type PrismicRichTextProps = {
  * @example Rendering a Rich Text field using the default HTMl elements.
  *
  * ```jsx
- * <PrismicRichText field={document.data.content} />
+ * <PrismicRichText field={document.data.content} />;
  * ```
  *
  * @example Rendering a Rich Text field using a custom set of React components.
  *
  * ```jsx
  * <PrismicRichText
- *   field={document.data.content}
- *   components={{
- * 	 heading1: ({ children }) => <Heading>{children}</Heading>
- *   }}
- * />
+ * 	field={document.data.content}
+ * 	components={{
+ * 		heading1: ({ children }) => <Heading>{children}</Heading>,
+ * 	}}
+ * />;
  * ```
  *
  * @param props - Props for the component.
  *
  * @returns The Rich Text field's content as React components.
+ *
  * @see Learn about Rich Text fields {@link https://prismic.io/docs/core-concepts/rich-text-title}
  * @see Learn about Rich Text serializers {@link https://prismic.io/docs/core-concepts/html-serializer}
  */
@@ -418,6 +420,35 @@ declare type SliceZoneComponents<TSlice extends SliceLike = SliceLike, TContext
  * cannot be found in `<SliceZone>`.
  */
 declare const TODOSliceComponent: <TSlice extends SliceLike<string>, TContext>({ slice, }: SliceComponentProps<TSlice, TContext>) => JSX.Element | null;
+/**
+ * Arguments for a `<SliceZone>` `resolver` function.
+ */
+declare type SliceZoneResolverArgs<TSlice extends SliceLike = SliceLike> = {
+    /**
+     * The Slice to resolve to a React component.
+     */
+    slice: TSlice;
+    /**
+     * The name of the Slice.
+     */
+    sliceName: TSlice["slice_type"];
+    /**
+     * The index of the Slice in the Slice Zone.
+     */
+    i: number;
+};
+/**
+ * A function that determines the rendered React component for each Slice in the
+ * Slice Zone. If a nullish value is returned, the component will fallback to
+ * the `components` or `defaultComponent` props to determine the rendered component.
+ *
+ * @deprecated Use the `components` prop instead.
+ *
+ * @param args - Arguments for the resolver function.
+ *
+ * @returns The React component to render for a Slice.
+ */
+declare type SliceZoneResolver<TSlice extends SliceLike = SliceLike, TContext = unknown> = (args: SliceZoneResolverArgs<TSlice>) => SliceComponentType<TSlice, TContext> | undefined | null;
 /**
  * React props for the `<SliceZone>` component.
  *
@@ -433,6 +464,17 @@ declare type SliceZoneProps<TSlice extends SliceLike = SliceLike, TContext = unk
      * A record mapping Slice types to React components.
      */
     components?: SliceZoneComponents<TSlice, TContext>;
+    /**
+     * A function that determines the rendered React component for each Slice in
+     * the Slice Zone.
+     *
+     * @deprecated Use the `components` prop instead.
+     *
+     * @param args - Arguments for the resolver function.
+     *
+     * @returns The React component to render for a Slice.
+     */
+    resolver?: SliceZoneResolver<TSlice, TContext>;
     /**
      * The React component rendered if a component mapping from the `components`
      * prop cannot be found.
@@ -453,10 +495,12 @@ declare type SliceZoneProps<TSlice extends SliceLike = SliceLike, TContext = unk
  *
  * @typeParam TSlice - The type(s) of a Slice in the Slice Zone.
  * @typeParam TContext - Arbitrary data made available to all Slice components.
+ *
  * @returns The Slice Zone's content as React components.
+ *
  * @see Learn about Prismic Slices and Slice Zones {@link https://prismic.io/docs/core-concepts/slices}
  */
-declare const SliceZone: <TSlice extends SliceLike<string>, TContext>({ slices, components, defaultComponent, context, }: SliceZoneProps<TSlice, TContext>) => JSX.Element;
+declare const SliceZone: <TSlice extends SliceLike<string>, TContext>({ slices, components, resolver, defaultComponent, context, }: SliceZoneProps<TSlice, TContext>) => JSX.Element;
 
 /**
  * Props for `<PrismicToolbar>`.
@@ -505,15 +549,62 @@ declare type ClientHookReturnType<TData = unknown> = [
     state: Pick<StateMachineState<TData>, "state" | "error">
 ];
 
+declare type UsePrismicPreviewResolverArgs = {
+    /**
+     * An optional `@prismicio/client` instance to override the Client provided to
+     * `<PrismicProvider>`
+     */
+    client?: _prismicio_client.Client;
+    /**
+     * A function that maps a Prismic document to a URL within your app.
+     */
+    linkResolver?: Parameters<_prismicio_client.Client["resolvePreviewURL"]>[0]["linkResolver"];
+    /**
+     * A fallback URL if the Link Resolver does not return a value.
+     */
+    defaultURL?: Parameters<_prismicio_client.Client["resolvePreviewURL"]>[0]["defaultURL"];
+    /**
+     * The preview token (also known as a ref) that will be used to query preview
+     * content from the Prismic repository.
+     */
+    previewToken?: Parameters<_prismicio_client.Client["resolvePreviewURL"]>[0]["previewToken"];
+    /**
+     * The previewed document that will be used to determine the destination URL.
+     */
+    documentID?: Parameters<_prismicio_client.Client["resolvePreviewURL"]>[0]["documentID"];
+    /**
+     * A function to automatically navigate to the resolved URL. If a function is
+     * not provded, `usePreviewResolver` will not navigate to the URL.
+     *
+     * @param url - The resolved preview URL.
+     */
+    navigate?: (url: string) => unknown;
+};
+/**
+ * Resolve a preview session's URL. The resolved URL can be used to redirect to
+ * the previewed document.
+ *
+ * If a `navigate` function is provided, the hook will automatically navigate to
+ * the previewed document's URL.
+ *
+ * @param args - Arguments to configure how a URL is resolved.
+ *
+ * @returns A tuple containing the resolved URL and the hook's state.
+ */
+declare const usePrismicPreviewResolver: (args?: UsePrismicPreviewResolverArgs) => ClientHookReturnType<string>;
+
 /**
  * A hook that queries content from the Prismic repository.
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of Prismic documents returned
+ *
  * @param params - Parameters to filter, sort, and paginate results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.get}
  */
 declare const usePrismicDocuments: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
@@ -523,10 +614,13 @@ declare const usePrismicDocuments: <TDocument extends prismicT.PrismicDocument<R
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of the Prismic document returned
+ *
  * @param params - Parameters to filter, sort, and paginate results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getFirst}
  */
 declare const useFirstPrismicDocument: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument>;
@@ -536,10 +630,13 @@ declare const useFirstPrismicDocument: <TDocument extends prismicT.PrismicDocume
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of Prismic documents returned
+ *
  * @param params - Parameters to filter and sort results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getAll}
  */
 declare const useAllPrismicDocumentsDangerously: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
@@ -550,11 +647,14 @@ declare const useAllPrismicDocumentsDangerously: <TDocument extends prismicT.Pri
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of the Prismic document returned
+ *
  * @param id - ID of the document
  * @param params - Parameters to filter, sort, and paginate results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getByID}
  */
 declare const usePrismicDocumentByID: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(id: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument>;
@@ -563,11 +663,14 @@ declare const usePrismicDocumentByID: <TDocument extends prismicT.PrismicDocumen
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of Prismic documents returned
+ *
  * @param ids - A list of document IDs
  * @param params - Parameters to filter, sort, and paginate results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getByIDs}
  */
 declare const usePrismicDocumentsByIDs: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(id: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
@@ -576,11 +679,14 @@ declare const usePrismicDocumentsByIDs: <TDocument extends prismicT.PrismicDocum
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of Prismic documents returned
+ *
  * @param ids - A list of document IDs
  * @param params - Parameters to filter and sort results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getAllByIDs}
  */
 declare const useAllPrismicDocumentsByIDs: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(id: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
@@ -590,12 +696,15 @@ declare const useAllPrismicDocumentsByIDs: <TDocument extends prismicT.PrismicDo
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of the Prismic document returned
+ *
  * @param documentType - The API ID of the document's Custom Type
  * @param uid - UID of the document
  * @param params - Parameters to filter, sort, and paginate results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getByUID}
  */
 declare const usePrismicDocumentByUID: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, uid: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument>;
@@ -605,12 +714,15 @@ declare const usePrismicDocumentByUID: <TDocument extends prismicT.PrismicDocume
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of the Prismic document returned
+ *
  * @param documentType - The API ID of the document's Custom Type
  * @param uids - A list of document UIDs.
  * @param params - Parameters to filter, sort, and paginate results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getByUID}
  */
 declare const usePrismicDocumentsByUIDs: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, uids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
@@ -620,12 +732,15 @@ declare const usePrismicDocumentsByUIDs: <TDocument extends prismicT.PrismicDocu
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of the Prismic document returned
+ *
  * @param documentType - The API ID of the document's Custom Type
  * @param uids - A list of document UIDs.
  * @param params - Parameters to filter, sort, and paginate results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getByUID}
  */
 declare const useAllPrismicDocumentsByUIDs: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, uids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
@@ -635,11 +750,14 @@ declare const useAllPrismicDocumentsByUIDs: <TDocument extends prismicT.PrismicD
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of the Prismic document returned
+ *
  * @param documentType - The API ID of the singleton Custom Type
  * @param params - Parameters to filter, sort, and paginate results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getSingle}
  */
 declare const useSinglePrismicDocument: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument>;
@@ -648,11 +766,14 @@ declare const useSinglePrismicDocument: <TDocument extends prismicT.PrismicDocum
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of Prismic documents returned
+ *
  * @param documentType - The API ID of the Custom Type
  * @param params - Parameters to filter, sort, and paginate results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getByType}
  */
 declare const usePrismicDocumentsByType: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
@@ -662,11 +783,14 @@ declare const usePrismicDocumentsByType: <TDocument extends prismicT.PrismicDocu
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of Prismic documents returned
+ *
  * @param documentType - The API ID of the Custom Type
  * @param params - Parameters to filter and sort results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getAllByType}
  */
 declare const useAllPrismicDocumentsByType: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
@@ -675,11 +799,14 @@ declare const useAllPrismicDocumentsByType: <TDocument extends prismicT.PrismicD
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of Prismic documents returned
+ *
  * @param tag - The tag that must be included on a document
  * @param params - Parameters to filter, sort, and paginate results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getByTag}
  */
 declare const usePrismicDocumentsByTag: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
@@ -688,11 +815,14 @@ declare const usePrismicDocumentsByTag: <TDocument extends prismicT.PrismicDocum
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of Prismic documents returned
+ *
  * @param tag - The tag that must be included on a document
  * @param params - Parameters to filter and sort results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getAllByTag}
  */
 declare const useAllPrismicDocumentsByTag: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
@@ -702,11 +832,14 @@ declare const useAllPrismicDocumentsByTag: <TDocument extends prismicT.PrismicDo
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of Prismic documents returned
+ *
  * @param tags - A list of tags that must be included on a document
  * @param params - Parameters to filter, sort, and paginate results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getByTags}
  */
 declare const usePrismicDocumentsBySomeTags: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
@@ -716,11 +849,14 @@ declare const usePrismicDocumentsBySomeTags: <TDocument extends prismicT.Prismic
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of Prismic documents returned
+ *
  * @param tags - A list of tags that must be included on a document
  * @param params - Parameters to filter and sort results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getAllByTags}
  */
 declare const useAllPrismicDocumentsBySomeTags: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string[], params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
@@ -730,11 +866,14 @@ declare const useAllPrismicDocumentsBySomeTags: <TDocument extends prismicT.Pris
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of Prismic documents returned
+ *
  * @param tags - A list of tags that must be included on a document
  * @param params - Parameters to filter, sort, and paginate results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getByTags}
  */
 declare const usePrismicDocumentsByEveryTag: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
@@ -744,13 +883,16 @@ declare const usePrismicDocumentsByEveryTag: <TDocument extends prismicT.Prismic
  *
  * @remarks
  * An additional `@prismicio/client` instance can be provided at `params.client`.
+ *
  * @typeParam TDocument - Type of Prismic documents returned
+ *
  * @param tags - A list of tags that must be included on a document
  * @param params - Parameters to filter and sort results
  *
  * @returns The composable payload {@link ClientHookReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link proto.getAllByTags}
  */
 declare const useAllPrismicDocumentsByEveryTag: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string[], params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
 
-export { JSXFunctionSerializer, JSXMapSerializer, LinkProps, PrismicClientHookState, PrismicContextValue, PrismicLink, PrismicLinkProps, PrismicProvider, PrismicProviderProps, PrismicRichText, PrismicRichTextProps, PrismicText, PrismicTextProps, PrismicToolbar, PrismicToolbarProps, SliceComponentProps, SliceComponentType, SliceLike, SliceZone, SliceZoneComponents, SliceZoneLike, SliceZoneProps, TODOSliceComponent, useAllPrismicDocumentsByEveryTag, useAllPrismicDocumentsByIDs, useAllPrismicDocumentsBySomeTags, useAllPrismicDocumentsByTag, useAllPrismicDocumentsByType, useAllPrismicDocumentsByUIDs, useAllPrismicDocumentsDangerously, useFirstPrismicDocument, usePrismicClient, usePrismicContext, usePrismicDocumentByID, usePrismicDocumentByUID, usePrismicDocuments, usePrismicDocumentsByEveryTag, usePrismicDocumentsByIDs, usePrismicDocumentsBySomeTags, usePrismicDocumentsByTag, usePrismicDocumentsByType, usePrismicDocumentsByUIDs, useSinglePrismicDocument };
+export { JSXFunctionSerializer, JSXMapSerializer, LinkProps, PrismicClientHookState, PrismicContextValue, PrismicLink, PrismicLinkProps, PrismicProvider, PrismicProviderProps, PrismicRichText, PrismicRichTextProps, PrismicText, PrismicTextProps, PrismicToolbar, PrismicToolbarProps, SliceComponentProps, SliceComponentType, SliceLike, SliceZone, SliceZoneComponents, SliceZoneLike, SliceZoneProps, SliceZoneResolver, TODOSliceComponent, UsePrismicPreviewResolverArgs, useAllPrismicDocumentsByEveryTag, useAllPrismicDocumentsByIDs, useAllPrismicDocumentsBySomeTags, useAllPrismicDocumentsByTag, useAllPrismicDocumentsByType, useAllPrismicDocumentsByUIDs, useAllPrismicDocumentsDangerously, useFirstPrismicDocument, usePrismicClient, usePrismicContext, usePrismicDocumentByID, usePrismicDocumentByUID, usePrismicDocuments, usePrismicDocumentsByEveryTag, usePrismicDocumentsByIDs, usePrismicDocumentsBySomeTags, usePrismicDocumentsByTag, usePrismicDocumentsByType, usePrismicDocumentsByUIDs, usePrismicPreviewResolver, useSinglePrismicDocument };

package/dist/index.mjs

@@ -255,13 +255,24 @@ const TODOSliceComponent = __PRODUCTION__ ? () => null : ({
 const SliceZone = ({
   slices = [],
   components = {},
+  resolver,
   defaultComponent = TODOSliceComponent,
   context = {}
 }) => {
   const renderedSlices = React.useMemo(() => {
     return slices.map((slice, index) => {
-      const Comp = components[slice.slice_type] || defaultComponent;
-      const key = JSON.stringify(slice);
+      let Comp = components[slice.slice_type] || defaultComponent;
+      if (resolver) {
+        const resolvedComp = resolver({
+          slice,
+          sliceName: slice.slice_type,
+          i: index
+        });
+        if (resolvedComp) {
+          Comp = resolvedComp;
+        }
+      }
+      const key = `${index}-${JSON.stringify(slice)}`;
       return /* @__PURE__ */ React.createElement(Comp, {
         key,
         slice,
@@ -328,15 +339,15 @@ const getParamHookDependencies = (params) => {
 const isParams = (value) => {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 };
-const useStatefulPrismicClientMethod = (methodName, args) => {
+const useStatefulPrismicClientMethod = (methodName, args, explicitClient) => {
   const lastArg = args[args.length - 1];
   const {
-    client: explicitClient,
+    client: lastArgExplicitClient,
     skip,
     ...params
   } = isParams(lastArg) ? lastArg : {};
   const argsWithoutParams = isParams(lastArg) ? args.slice(0, -1) : args;
-  const client = usePrismicClient(explicitClient);
+  const client = usePrismicClient(explicitClient || lastArgExplicitClient);
   const [state, dispatch] = React.useReducer(reducer, initialState);
   React.useEffect(() => {
     if (state.state === "idle" && !skip) {
@@ -360,6 +371,25 @@ const useStatefulPrismicClientMethod = (methodName, args) => {
   ], [state]);
 };
 
+const usePrismicPreviewResolver = (args = {}) => {
+  const result = useStatefulPrismicClientMethod("resolvePreviewURL", [
+    {
+      linkResolver: args.linkResolver,
+      defaultURL: args.defaultURL || "/",
+      previewToken: args.previewToken,
+      documentID: args.documentID
+    }
+  ], args.client);
+  const [resolvedURL] = result;
+  const { navigate } = args;
+  React.useEffect(() => {
+    if (resolvedURL && navigate) {
+      navigate(resolvedURL);
+    }
+  }, [resolvedURL, navigate]);
+  return result;
+};
+
 const usePrismicDocuments = (...args) => useStatefulPrismicClientMethod("get", args);
 const useFirstPrismicDocument = (...args) => useStatefulPrismicClientMethod("getFirst", args);
 const useAllPrismicDocumentsDangerously = (...args) => useStatefulPrismicClientMethod("dangerouslyGetAll", args);
@@ -379,5 +409,5 @@ const useAllPrismicDocumentsBySomeTags = (...args) => useStatefulPrismicClientMe
 const usePrismicDocumentsByEveryTag = (...args) => useStatefulPrismicClientMethod("getByEveryTag", args);
 const useAllPrismicDocumentsByEveryTag = (...args) => useStatefulPrismicClientMethod("getAllByEveryTag", args);
 
-export { PrismicLink, PrismicProvider, PrismicRichText, PrismicText, PrismicToolbar, SliceZone, TODOSliceComponent, useAllPrismicDocumentsByEveryTag, useAllPrismicDocumentsByIDs, useAllPrismicDocumentsBySomeTags, useAllPrismicDocumentsByTag, useAllPrismicDocumentsByType, useAllPrismicDocumentsByUIDs, useAllPrismicDocumentsDangerously, useFirstPrismicDocument, usePrismicClient, usePrismicContext, usePrismicDocumentByID, usePrismicDocumentByUID, usePrismicDocuments, usePrismicDocumentsByEveryTag, usePrismicDocumentsByIDs, usePrismicDocumentsBySomeTags, usePrismicDocumentsByTag, usePrismicDocumentsByType, usePrismicDocumentsByUIDs, useSinglePrismicDocument };
+export { PrismicLink, PrismicProvider, PrismicRichText, PrismicText, PrismicToolbar, SliceZone, TODOSliceComponent, useAllPrismicDocumentsByEveryTag, useAllPrismicDocumentsByIDs, useAllPrismicDocumentsBySomeTags, useAllPrismicDocumentsByTag, useAllPrismicDocumentsByType, useAllPrismicDocumentsByUIDs, useAllPrismicDocumentsDangerously, useFirstPrismicDocument, usePrismicClient, usePrismicContext, usePrismicDocumentByID, usePrismicDocumentByUID, usePrismicDocuments, usePrismicDocumentsByEveryTag, usePrismicDocumentsByIDs, usePrismicDocumentsBySomeTags, usePrismicDocumentsByTag, usePrismicDocumentsByType, usePrismicDocumentsByUIDs, usePrismicPreviewResolver, useSinglePrismicDocument };
 //# sourceMappingURL=index.mjs.map