@prismicio/vue 3.0.0-alpha.1 → 3.0.0-alpha.5

package/dist/index.d.ts

@@ -1,9 +1,10 @@
 import * as vue from 'vue';
 import { App, Ref, ConcreteComponent, AllowedComponentProps, ComponentCustomProps, VNodeProps, ComputedRef, PropType, DefineComponent, FunctionalComponent, InjectionKey } from 'vue';
 import * as _prismicio_client from '@prismicio/client';
-import { Client, ClientConfig, predicate, cookie, PrismicError, ParsingError, ForbiddenError, Query } from '@prismicio/client';
-import { asText, asHTML, asLink, LinkResolverFunction, asDate, documentToLinkField, documentAsLink, HTMLFunctionSerializer, HTMLMapSerializer } from '@prismicio/helpers';
-import { EmbedField, ImageField, LinkField, PrismicDocument, RichTextField, Slice } from '@prismicio/types';
+import { Client, ClientConfig, predicate, cookie, PrismicError, ParsingError, ForbiddenError } from '@prismicio/client';
+import { asText, asHTML, asLink, LinkResolverFunction, asDate, documentToLinkField, HTMLFunctionSerializer, HTMLMapSerializer } from '@prismicio/helpers';
+import * as _prismicio_types from '@prismicio/types';
+import { EmbedField, ImageField, LinkField, PrismicDocument, RichTextField, Slice, Query } from '@prismicio/types';
 
 /**
  * Options used by `@prismicio/vue` components.
@@ -16,38 +17,47 @@ declare type PrismicPluginComponentsOptions = {
      */
     linkBlankTargetRelAttribute?: string;
     /**
-     * An HTML tag name, a component, or a functional component used to render internal links.
-     *
-     * @remarks HTML tag names will be rendered using the anchor tag interface (`href`, `target`, and `rel` attributes).
-     *
-     * @remarks Components will be rendered using Vue Router {@link RouterLink} interface (`to` props).
-     *
+     * An HTML tag name, a component, or a functional component used to render
+     * internal links.
+     *
+     * @remarks
+     * HTML tag names will be rendered using the anchor tag interface (`href`,
+     * `target`, and `rel` attributes).
+     * @remarks
+     * Components will be rendered using Vue Router {@link RouterLink} interface
+     * (`to` props).
      * @defaultValue {@link RouterLink}
      */
     linkInternalComponent?: string | ConcreteComponent;
     /**
-     * An HTML tag name, a component, or a functional component used to render external links.
-     *
-     * @remarks HTML tag names will be rendered using the anchor tag interface (`href`, `target`, and `rel` attributes).
-     *
-     * @remarks Components will be rendered using Vue Router {@link RouterLink} interface (`to` props).
-     *
+     * An HTML tag name, a component, or a functional component used to render
+     * external links.
+     *
+     * @remarks
+     * HTML tag names will be rendered using the anchor tag interface (`href`,
+     * `target`, and `rel` attributes).
+     * @remarks
+     * Components will be rendered using Vue Router {@link RouterLink} interface
+     * (`to` props).
      * @defaultValue `"a"`
      */
     linkExternalComponent?: string | ConcreteComponent;
     /**
      * An HTML tag name, a component, or a functional component used to render images.
      *
-     * @remarks HTML tag names and components will be rendered using the `img` tag interface (`src` and `alt` attribute). Components will also receive an additional `copyright` props.
-     *
+     * @remarks
+     * HTML tag names and components will be rendered using the `img` tag
+     * interface (`src` and `alt` attribute). Components will also receive an
+     * additional `copyright` props.
      * @defaultValue `"img"`
      */
     imageComponent?: string | ConcreteComponent;
     /**
-     * A component or a functional component rendered if a component mapping from the `components` prop cannot be found.
-     *
-     * @remarks Components will be rendered using the {@link SliceComponentProps} interface.
+     * A component or a functional component rendered if a component mapping from
+     * the `components` prop cannot be found.
      *
+     * @remarks
+     * Components will be rendered using the {@link SliceComponentProps} interface.
      * @defaultValue `null` when `process.env.NODE_ENV === "production"` else {@link TODOSliceComponent}
      */
     sliceZoneDefaultComponent?: string | ConcreteComponent;
@@ -57,7 +67,8 @@ declare type PrismicPluginComponentsOptions = {
  */
 declare type PrismicPluginOptionsBase = {
     /**
-     * An optional link resolver function used to resolve links to Prismic documents when not using the route resolver parameter with `@prismicio/client`.
+     * An optional link resolver function used to resolve links to Prismic
+     * documents when not using the route resolver parameter with `@prismicio/client`.
      *
      * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
      */
@@ -88,10 +99,13 @@ declare type PrismicPluginOptionsBase = {
  */
 declare type PrismicPluginOptionsWithClient = PrismicPluginOptionsBase & {
     /**
-     * A `@prismicio/client` instance used to fetch content from a Prismic repository to configure the plugin with.
-     *
-     * @remarks The client will be used by `@prismicio/vue` composables, such as {@link usePrismicDocuments} and exposed through `this.$prismic.client` and `usePrismic().client`.
+     * A `@prismicio/client` instance used to fetch content from a Prismic
+     * repository to configure the plugin with.
      *
+     * @remarks
+     * The client will be used by `@prismicio/vue` composables, such as
+     * {@link usePrismicDocuments} and exposed through `this.$prismic.client` and
+     * `usePrismic().client`.
      * @see Prismic client documentation {@link https://prismic.io/docs/technologies/javascript}
      */
     client: Client;
@@ -115,61 +129,56 @@ declare type PrismicPluginOptionsWithClient = PrismicPluginOptionsBase & {
  */
 declare type PrismicPluginOptionsWithEndpoint = PrismicPluginOptionsBase & {
     /**
-     * A Prismic repository endpoint to init the plugin's `@prismicio/client` instance used to fetch content from a Prismic repository with.
+     * A Prismic repository endpoint to init the plugin's `@prismicio/client`
+     * instance used to fetch content from a Prismic repository with.
      *
-     * @remarks Said client will be used by `@prismicio/vue` composables, such as {@link usePrismicDocuments} and exposed through `this.$prismic.client` and `usePrismic().client`.
+     * @remarks
+     * Said client will be used by `@prismicio/vue` composables, such as
+     * {@link usePrismicDocuments} and exposed through `this.$prismic.client` and
+     * `usePrismic().client`.
+     * @example A repository ID:
      *
-     * @see Prismic client documentation {@link https://prismic.io/docs/technologies/javascript}
-     *
-     * @example
-     * A repository ID:
+     *     "my-repo";
      *
-     * ```
-     * "my-repo"
-     * ```
+     * @example A full repository endpoint:
      *
-     * @example
-     * A full repository endpoint:
+     *     "https://my-repo.cdn.prismic.io/api/v2";
      *
-     * ```
-     * "https://my-repo.cdn.prismic.io/api/v2"
-     * ```
+     * @see Prismic client documentation {@link https://prismic.io/docs/technologies/javascript}
      */
     endpoint: string;
     /**
      * An optional object to configure `@prismicio/client` instance further.
      *
-     * @see Prismic client documentation {@link https://prismic.io/docs/technologies/javascript}
-     * @see Route resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#route-resolver}
-     *
-     * @example
-     * Accessing a private private repository:
+     * @example Accessing a private private repository:
      *
-     * ```
+     * ```javascript
      * {
-     *   accessToken: "abc",
+     * 	"accessToken": "abc"
      * }
      * ```
      *
-     * @example
-     * Using a route resolver:
+     * @example Using a route resolver:
      *
-     * ```
+     * ```javascript
      * {
-     *   defaultParams: {
-     *     routes: [
-     *       {
-     *         type: "page",
-     *         path: "/:uid"
-     *       },
-     *       {
-     *         type: "post",
-     *         path: "/blog/:uid"
-     *       }
-     *     ]
-     *   }
+     * 	"defaultParams": {
+     * 		"routes": [
+     * 			{
+     * 				"type": "page",
+     * 				"path": "/:uid"
+     * 			},
+     * 			{
+     * 				"type": "post",
+     * 				"path": "/blog/:uid"
+     * 			}
+     * 		]
+     * 	}
      * }
      * ```
+     *
+     * @see Prismic client documentation {@link https://prismic.io/docs/technologies/javascript}
+     * @see Route resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#route-resolver}
      */
     clientConfig?: ClientConfig;
     /**
@@ -187,63 +196,74 @@ declare type PrismicPluginOptionsWithEndpoint = PrismicPluginOptionsBase & {
  */
 declare type PrismicPluginOptions = PrismicPluginOptionsWithClient | PrismicPluginOptionsWithEndpoint;
 /**
- * `@prismicio/client` related methods and properties exposed by `@prismicio/vue` plugin and accessible through `this.$prismic` and `usePrismic()`.
+ * `@prismicio/client` related methods and properties exposed by
+ * `@prismicio/vue` plugin and accessible through `this.$prismic` and `usePrismic()`.
  */
 declare type PrismicPluginClient = {
-    /** A `@prismicio/client` instance. */
+    /**
+     * A `@prismicio/client` instance.
+     */
     client: Client;
-    /** Query predicates from `@prismicio/client`. */
+    /**
+     * Query predicates from `@prismicio/client`.
+     */
     predicate: typeof predicate;
-    /** Prismic cookies from `@prismicio/client`. */
+    /**
+     * Prismic cookies from `@prismicio/client`.
+     */
     cookie: typeof cookie;
 };
 /**
- * `@prismicio/helpers` related methods exposed by `@prismicio/vue` plugin and accessible through `this.$prismic` and `usePrismic()`.
+ * `@prismicio/helpers` related methods exposed by `@prismicio/vue` plugin and
+ * accessible through `this.$prismic` and `usePrismic()`.
  */
 declare type PrismicPluginHelpers = {
     /**
-     * Serializes a rich text or title field to a plain text string. This is `@prismicio/helpers` {@link asText} function.
+     * Serializes a rich text or title field to a plain text string. This is
+     * `@prismicio/helpers` {@link asText} function.
      *
      * @see Templating rich text and title fields {@link https://prismic.io/docs/technologies/vue-template-content#rich-text-and-titles}
      */
     asText: typeof asText;
     /**
-     * Serializes a rich text or title field to an HTML string. This is `@prismicio/helpers` {@link asHTML} function.
-     *
-     * @remarks If no `linkResolver` is provided the function will use the one provided to the plugin at {@link PrismicPluginOptions.linkResolver} if available.
-     *
-     * @remarks If no `htmlSerializer` is provided the function will use the one provided to the plugin at {@link PrismicPluginOptions.htmlSerializer} if available.
-     *
+     * Serializes a rich text or title field to an HTML string. This is
+     * `@prismicio/helpers` {@link asHTML} function.
+     *
+     * @remarks
+     * If no `linkResolver` is provided the function will use the one provided to
+     * the plugin at {@link PrismicPluginOptions.linkResolver} if available.
+     * @remarks
+     * If no `htmlSerializer` is provided the function will use the one provided
+     * to the plugin at {@link PrismicPluginOptions.htmlSerializer} if available.
      * @see Templating rich text and title fields {@link https://prismic.io/docs/technologies/vue-template-content#rich-text-and-titles}
      */
     asHTML: typeof asHTML;
     /**
-     * Resolves any type of link field to a URL. This is `@prismicio/helpers` {@link asLink} function.
-     *
-     * @remarks If no `linkResolver` is provided the function will use the one provided to the plugin at {@link PrismicPluginOptions.linkResolver} if available.
+     * Resolves any type of link field or document to a URL. This is
+     * `@prismicio/helpers` {@link asLink} function.
      *
+     * @remarks
+     * If no `linkResolver` is provided the function will use the one provided to
+     * the plugin at {@link PrismicPluginOptions.linkResolver} if available.
      * @see Templating link fields {@link https://prismic.io/docs/technologies/vue-template-content#links-and-content-relationships}
      */
     asLink: (linkField: Parameters<typeof asLink>[0], linkResolver?: LinkResolverFunction) => string | null;
     /**
-     * Transforms a date or timestamp field into a JavaScript Date object. This is `@prismicio/helpers` {@link asDate} function.
+     * Transforms a date or timestamp field into a JavaScript Date object. This is
+     * `@prismicio/helpers` {@link asDate} function.
      */
     asDate: typeof asDate;
     /**
-     * Converts a document into a link field. This is `@prismicio/helpers` {@link documentToLinkField} function.
-     */
-    documentToLinkField: typeof documentToLinkField;
-    /**
-     * Resolves a document to a URL. This is `@prismicio/helpers` {@link documentAsLink} function.
+     * Converts a document into a link field. This is `@prismicio/helpers`
+     * {@link documentToLinkField} function.
      *
-     * @remarks If no `linkResolver` is provided the function will use the one provided to the plugin at {@link PrismicPluginOptions.linkResolver} if available.
-     *
-     * @see Templating link fields {@link https://prismic.io/docs/technologies/vue-template-content#links-and-content-relationships}
+     * @internal
      */
-    documentAsLink: (prismicDocument: Parameters<typeof documentAsLink>[0], linkResolver?: LinkResolverFunction) => string | null;
+    documentToLinkField: typeof documentToLinkField;
 };
 /**
- * Methods and properties exposed by `@prismicio/vue` plugin and accessible through `this.$prismic` and `usePrismic()`.
+ * Methods and properties exposed by `@prismicio/vue` plugin and accessible
+ * through `this.$prismic` and `usePrismic()`.
  */
 declare type PrismicPlugin = {
     /**
@@ -263,18 +283,25 @@ declare type PrismicPlugin = {
  * States of a `@prismicio/client` composable.
  */
 declare const enum PrismicClientComposableState {
-    /** The composable has not started fetching. */
+    /**
+     * The composable has not started fetching.
+     */
     Idle = "idle",
-    /** The composable is fetching data. */
+    /**
+     * The composable is fetching data.
+     */
     Pending = "pending",
-    /** The composable sucessfully fetched data. */
+    /**
+     * The composable sucessfully fetched data.
+     */
     Success = "success",
-    /** The composable failed to fetch data. */
+    /**
+     * The composable failed to fetch data.
+     */
     Error = "error"
 }
 /**
- * Type to transform a static object into one that allows passing Refs as
- * values.
+ * Type to transform a static object into one that allows passing Refs as values.
  *
  * @internal
  */
@@ -288,7 +315,6 @@ declare type VueUseOptions<T> = {
  * @param options - {@link PrismicPluginOptions}
  *
  * @returns `@prismicio/vue` plugin instance {@link PrismicPlugin}
- *
  * @see Prismic Official Vue.js documentation: {@link https://prismic.io/docs/technologies/vuejs}
  * @see Plugin repository: {@link https://github.com/prismicio/prismic-vue}
  */
@@ -297,22 +323,21 @@ declare const createPrismic: (options: PrismicPluginOptions) => PrismicPlugin;
 /**
  * Accesses `@prismicio/vue` plugin interface.
  *
- * @returns The interface {@link PrismicPlugin}
- *
- * @example
- * With the composition API:
+ * @example With the composition API:
  *
- * ```
+ * ```javascript
  * import { usePrismic } from "@prismicio/vue";
  *
  * export default {
- *   setup() {
- *     const prismic = usePrismic();
+ * 	setup() {
+ * 		const prismic = usePrismic();
  *
- *     return {}
- *   },
+ * 		return {};
+ * 	},
  * };
  * ```
+ *
+ * @returns The interface {@link PrismicPlugin}
  */
 declare const usePrismic: () => PrismicPlugin;
 
@@ -320,7 +345,9 @@ declare const usePrismic: () => PrismicPlugin;
  * Props for `<PrismicEmbed />`.
  */
 declare type PrismicEmbedProps = {
-    /** The Prismic embed field to render. */
+    /**
+     * The Prismic embed field to render.
+     */
     field: EmbedField;
     /**
      * An HTML tag name, a component, or a functional component used to wrap the output.
@@ -343,33 +370,23 @@ declare const PrismicEmbed: new () => {
  * Props for `<PrismicImage />`.
  */
 declare type PrismicImageProps = {
-    /** The Prismic image field to render. */
-    field: ImageField;
     /**
-     * Ensures type union is a strict or.
-     *
-     * @internal
+     * The Prismic image field to render.
      */
-    imageComponent?: never;
-    /**
-     * Ensures type union is a strict or.
-     *
-     * @internal
-     */
-    imageComponentAdditionalProps?: never;
-} | {
-    /** The Prismic image field to render. */
     field: ImageField;
     /**
      * An HTML tag name, a component, or a functional component used to render images.
      *
-     * @remarks HTML tag names and components will be rendered using the `img` tag interface (`src` and `alt` attribute). Components will also receive an additional `copyright` props.
-     *
+     * @remarks
+     * HTML tag names and components will be rendered using the `img` tag
+     * interface (`src` and `alt` attribute). Components will also receive an
+     * additional `copyright` props.
      * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"img"` otherwise.
      */
-    imageComponent: string | ConcreteComponent;
+    imageComponent?: string | ConcreteComponent;
     /**
-     * A map of additional props to pass to the component used to render images when using one.
+     * A map of additional props to pass to the component used to render images
+     * when using one.
      */
     imageComponentAdditionalProps?: Record<string, unknown>;
 };
@@ -387,13 +404,15 @@ declare const PrismicImage: new () => {
  * Props for `<PrismicLink />`.
  */
 declare type PrismicLinkProps = {
-    /** The Prismic link field or document to render. */
+    /**
+     * The Prismic link field or document to render.
+     */
     field: LinkField | PrismicDocument;
     /**
-     * A link resolver function used to resolve links when not using the route resolver parameter with `@prismicio/client`.
+     * A link resolver function used to resolve links when not using the route
+     * resolver parameter with `@prismicio/client`.
      *
      * @defaultValue The link resolver provided to `@prismicio/vue` plugin if configured.
-     *
      * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
      */
     linkResolver?: LinkResolverFunction;
@@ -412,22 +431,28 @@ declare type PrismicLinkProps = {
      */
     blankTargetRelAttribute?: string;
     /**
-     * An HTML tag name, a component, or a functional component used to render internal links.
-     *
-     * @remarks HTML tag names will be rendered using the anchor tag interface (`href`, `target`, and `rel` attributes).
-     *
-     * @remarks Components will be rendered using Vue Router {@link RouterLink} interface (`to` props).
-     *
+     * An HTML tag name, a component, or a functional component used to render
+     * internal links.
+     *
+     * @remarks
+     * HTML tag names will be rendered using the anchor tag interface (`href`,
+     * `target`, and `rel` attributes).
+     * @remarks
+     * Components will be rendered using Vue Router {@link RouterLink} interface
+     * (`to` props).
      * @defaultValue The one provided to `@prismicio/vue` plugin if configured, {@link RouterLink} otherwise.
      */
     internalComponent?: string | ConcreteComponent;
     /**
-     * An HTML tag name, a component, or a functional component used to render external links.
-     *
-     * @remarks HTML tag names will be rendered using the anchor tag interface (`href`, `target`, and `rel` attributes).
-     *
-     * @remarks Components will be rendered using Vue Router {@link RouterLink} interface (`to` props).
-     *
+     * An HTML tag name, a component, or a functional component used to render
+     * external links.
+     *
+     * @remarks
+     * HTML tag names will be rendered using the anchor tag interface (`href`,
+     * `target`, and `rel` attributes).
+     * @remarks
+     * Components will be rendered using Vue Router {@link RouterLink} interface
+     * (`to` props).
      * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"a"` otherwise.
      */
     externalComponent?: string | ConcreteComponent;
@@ -440,13 +465,21 @@ declare type UsePrismicLinkOptions = VueUseOptions<PrismicLinkProps>;
  * Return type of {@link usePrismicLink}.
  */
 declare type UsePrismicLinkReturnType = {
-    /** Suggested component to render for provided link field. */
+    /**
+     * Suggested component to render for provided link field.
+     */
     type: ComputedRef<string | ConcreteComponent>;
-    /** Resolved anchor `href` value. */
+    /**
+     * Resolved anchor `href` value.
+     */
     href: ComputedRef<string>;
-    /** Resolved anchor `target` value. */
+    /**
+     * Resolved anchor `target` value.
+     */
     target: ComputedRef<string | null>;
-    /** Resolved anchor `rel` value. */
+    /**
+     * Resolved anchor `rel` value.
+     */
     rel: ComputedRef<string | null>;
 };
 /**
@@ -471,7 +504,9 @@ declare const PrismicLink: new () => {
  * Props for `<PrismicText />`.
  */
 declare type PrismicTextProps = {
-    /** The Prismic rich text or title field to render. */
+    /**
+     * The Prismic rich text or title field to render.
+     */
     field: RichTextField;
     /**
      * Separator used to join each element.
@@ -494,7 +529,9 @@ declare type UsePrismicTextOptions = VueUseOptions<Omit<PrismicTextProps, "wrapp
  * Return type of {@link usePrismicText}.
  */
 declare type UsePrismicTextReturnType = {
-    /** Serialized rich text field as plain text. */
+    /**
+     * Serialized rich text field as plain text.
+     */
     text: ComputedRef<string>;
 };
 /**
@@ -519,13 +556,15 @@ declare const PrismicText: new () => {
  * Props for `<PrismicRichText />`.
  */
 declare type PrismicRichTextProps = {
-    /** The Prismic rich text or title field to render. */
+    /**
+     * The Prismic rich text or title field to render.
+     */
     field: RichTextField;
     /**
-     * A link resolver function used to resolve link when not using the route resolver parameter with `@prismicio/client`.
+     * A link resolver function used to resolve link when not using the route
+     * resolver parameter with `@prismicio/client`.
      *
      * @defaultValue The link resolver provided to `@prismicio/vue` plugin if configured.
-     *
      * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
      */
     linkResolver?: LinkResolverFunction;
@@ -533,7 +572,6 @@ declare type PrismicRichTextProps = {
      * An HTML serializer to customize the way rich text fields are rendered.
      *
      * @defaultValue The HTML serializer provided to `@prismicio/vue` plugin if configured.
-     *
      * @see HTML serializer documentation {@link https://prismic.io/docs/core-concepts/html-serializer}
      */
     htmlSerializer?: HTMLFunctionSerializer | HTMLMapSerializer;
@@ -552,7 +590,9 @@ declare type UsePrismicRichTextOptions = VueUseOptions<Omit<PrismicRichTextProps
  * Return type of {@link usePrismicRichText}.
  */
 declare type UsePrismicRichTextReturnType = {
-    /** Serialized rich text field as HTML. */
+    /**
+     * Serialized rich text field as HTML.
+     */
     html: ComputedRef<string>;
 };
 /**
@@ -574,9 +614,11 @@ declare const PrismicRichText: new () => {
 };
 
 /**
- * The minimum required properties to represent a Prismic Slice for the `<SliceZone />` component.
+ * The minimum required properties to represent a Prismic Slice for the
+ * `<SliceZone />` component.
  *
- * If using Prismic's REST API, use the `Slice` export from `@prismicio/types` for a full interface.
+ * If using Prismic's REST API, use the `Slice` export from `@prismicio/types`
+ * for a full interface.
  *
  * @typeParam TSliceType - Type name of the Slice
  */
@@ -584,32 +626,45 @@ declare type SliceLike<TSliceType extends string = string> = Pick<Slice<TSliceTy
 /**
  * A looser version of the `SliceZone` type from `@prismicio/types` using `SliceLike`.
  *
- * If using Prismic's REST API, use the `SliceZone` export from `@prismicio/types` for the full type.
+ * If using Prismic's REST API, use the `SliceZone` export from
+ * `@prismicio/types` for the full type.
  *
  * @typeParam TSlice - The type(s) of slices in the Slice Zone
  */
 declare type SliceZoneLike<TSlice extends SliceLike> = readonly TSlice[];
 /**
- * Vue props for a component rendering content from a Prismic Slice using the `<SliceZone />` component.
+ * Vue props for a component rendering content from a Prismic Slice using the
+ * `<SliceZone />` component.
  *
  * @typeParam TSlice - The type(s) of slices in the Slice Zone
- * @typeParam TContext - Arbitrary data passed to `<SliceZone />` and made available to all Slice components
+ * @typeParam TContext - Arbitrary data passed to `<SliceZone />` and made
+ *   available to all Slice components
  */
 declare type SliceComponentProps<TSlice extends SliceLike = SliceLike, TContext = unknown> = {
-    /** Slice data for this component. */
+    /**
+     * Slice data for this component.
+     */
     slice: TSlice;
-    /** The index of the Slice in the Slice Zone. */
+    /**
+     * The index of the Slice in the Slice Zone.
+     */
     index: number;
-    /** All Slices from the Slice Zone to which the Slice belongs. */
+    /**
+     * All Slices from the Slice Zone to which the Slice belongs.
+     */
     slices: SliceZoneLike<SliceLike>;
-    /** Arbitrary data passed to `<SliceZone />` and made available to all Slice components. */
+    /**
+     * Arbitrary data passed to `<SliceZone />` and made available to all Slice components.
+     */
     context: TContext;
 };
 /**
- * Native Vue props for a component rendering content from a Prismic Slice using the `<SliceZone />` component.
+ * Native Vue props for a component rendering content from a Prismic Slice using
+ * the `<SliceZone />` component.
  *
  * @typeParam TSlice - The type(s) of slices in the Slice Zone
- * @typeParam TContext - Arbitrary data passed to `<SliceZone />` and made available to all Slice components
+ * @typeParam TContext - Arbitrary data passed to `<SliceZone />` and made
+ *   available to all Slice components
  */
 declare type DefineComponentSliceComponentProps<TSlice extends SliceLike = SliceLike, TContext = unknown> = {
     slice: {
@@ -630,25 +685,40 @@ declare type DefineComponentSliceComponentProps<TSlice extends SliceLike = Slice
     };
 };
 /**
- * Gets native Vue props for a component rendering content from a Prismic Slice using the `<SliceZone />` component.
- *
- * @returns Props object to use with {@link defineComponent}
+ * Gets native Vue props for a component rendering content from a Prismic Slice
+ * using the `<SliceZone />` component. Props are: `["slice", "index", "slices",
+ * "context"]`
  *
- * @typeParam TSlice - The type(s) of slices in the Slice Zone
- * @typeParam TContext - Arbitrary data passed to `<SliceZone />` and made available to all Slice components
+ * @example Defining a new slice component:
  *
- * @example
- * Defining a new slice component:
+ * ```javascript
+ * import { getSliceComponentProps } from "@prismicio/vue";
  *
+ * export default {
+ * 	props: getSliceComponentProps(),
+ * };
  * ```
+ *
+ * @example Defining a new slice component with visual hint:
+ *
+ * ```javascript
  * import { getSliceComponentProps } from "@prismicio/vue";
  *
  * export default {
- *   props: getSliceComponentProps(),
+ * 	props: getSliceComponentProps(["slice", "index", "slices", "context"]),
  * };
  * ```
+ *
+ * @typeParam TSlice - The type(s) of slices in the Slice Zone
+ * @typeParam TContext - Arbitrary data passed to `<SliceZone />` and made
+ *   available to all Slice components
+ * @param propsHint - An optional array of prop names used for the sole purpose
+ *   of having a visual hint of which props are made available to the slice,
+ *   this parameters doesn't have any effect
+ *
+ * @returns Props object to use with {@link defineComponent}
  */
-declare const getSliceComponentProps: <TSlice extends SliceLike<string> = SliceLike<string>, TContext = unknown>() => DefineComponentSliceComponentProps<TSlice, TContext>;
+declare const getSliceComponentProps: <TSlice extends SliceLike<string> = SliceLike<string>, TContext = unknown>(propsHint?: string[] | undefined) => DefineComponentSliceComponentProps<TSlice, TContext>;
 /**
  * A Vue component to be rendered for each instance of its Slice.
  *
@@ -659,21 +729,13 @@ declare type SliceComponentType<TSlice extends SliceLike = SliceLike, TContext =
 /**
  * This Slice component can be used as a reminder to provide a proper implementation.
  *
- * This is also the default Vue component rendered when a component mapping cannot be found in `<SliceZone />`.
+ * This is also the default Vue component rendered when a component mapping
+ * cannot be found in `<SliceZone />`.
  */
-declare const TODOSliceComponent: FunctionalComponent<SliceComponentProps<SliceLike<string>, unknown>, {}> | DefineComponent<SliceComponentProps<SliceLike<string>, unknown>, {}, {}, vue.ComputedOptions, vue.MethodOptions, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, Record<string, any>, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<{
-    slice?: unknown;
-    index?: unknown;
-    slices?: unknown;
-    context?: unknown;
-} & {} & {
-    slice?: SliceLike<string> | undefined;
-    index?: number | undefined;
-    slices?: SliceZoneLike<SliceLike<string>> | undefined;
-    context?: unknown;
-}> & {}, {}>;
+declare const TODOSliceComponent: FunctionalComponent<SliceComponentProps<SliceLike<string>, unknown>, {}> | DefineComponent<SliceComponentProps<SliceLike<string>, unknown>, {}, {}, vue.ComputedOptions, vue.MethodOptions, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<SliceComponentProps<SliceLike<string>, unknown>>, {}>;
 /**
- * A record of Slice types mapped to Vue components. Each components will be rendered for each instance of their Slice type.
+ * A record of Slice types mapped to Vue components. Each components will be
+ * rendered for each instance of their Slice type.
  *
  * @typeParam TSlice - The type(s) of slices in the Slice Zone
  * @typeParam TContext - Arbitrary data made available to all Slice components
@@ -682,21 +744,15 @@ declare type SliceZoneComponents<TSlice extends SliceLike = SliceLike, TContext
     [SliceType in keyof Record<TSlice["slice_type"], never>]: SliceComponentType<Extract<TSlice, SliceLike<SliceType>>, TContext> | string;
 };
 /**
- * Gets an optimized record of Slice types mapped to Vue components. Each components will be rendered for each instance of their Slice type.
- *
- * @param components - {@link SliceZoneComponents}
- *
- * @returns A new optimized record of {@link SliceZoneComponents}
- *
- * @typeParam TSlice - The type(s) of slices in the Slice Zone
- * @typeParam TContext - Arbitrary data made available to all Slice components
+ * Gets an optimized record of Slice types mapped to Vue components. Each
+ * components will be rendered for each instance of their Slice type.
  *
- * @remarks This is essentially an helper function to ensure {@link markRaw} is correctly applied on each components, improving performances.
+ * @remarks
+ * This is essentially an helper function to ensure {@link markRaw} is correctly
+ * applied on each components, improving performances.
+ * @example Defining a slice components:
  *
- * @example
- * Defining a slice components:
- *
- * ```
+ * ```javascript
  * import { getSliceZoneComponents } from "@prismicio/vue";
  *
  * export default {
@@ -711,6 +767,12 @@ declare type SliceZoneComponents<TSlice extends SliceLike = SliceLike, TContext
  *   }
  * };
  * ```
+ *
+ * @typeParam TSlice - The type(s) of slices in the Slice Zone
+ * @typeParam TContext - Arbitrary data made available to all Slice components
+ * @param components - {@link SliceZoneComponents}
+ *
+ * @returns A new optimized record of {@link SliceZoneComponents}
  */
 declare const getSliceZoneComponents: <TSlice extends SliceLike<string> = SliceLike<string>, TContext = unknown>(components: SliceZoneComponents<TSlice, TContext>) => SliceZoneComponents<TSlice, TContext>;
 /**
@@ -720,22 +782,30 @@ declare const getSliceZoneComponents: <TSlice extends SliceLike<string> = SliceL
  * @typeParam TContext - Arbitrary data made available to all Slice components
  */
 declare type SliceZoneProps<TSlice extends SliceLike = SliceLike, TContext = unknown> = {
-    /** List of Slice data from the Slice Zone. */
+    /**
+     * List of Slice data from the Slice Zone.
+     */
     slices: SliceZoneLike<TSlice>;
-    /** A record mapping Slice types to Vue components. */
+    /**
+     * A record mapping Slice types to Vue components.
+     */
     components: SliceZoneComponents;
-    /** Arbitrary data made available to all Slice components. */
+    /**
+     * Arbitrary data made available to all Slice components.
+     */
     context?: TContext;
     /**
-     * A component or a functional component rendered if a component mapping from the `components` prop cannot be found.
-     *
-     * @remarks Components will be rendered using the {@link SliceComponentProps} interface.
+     * A component or a functional component rendered if a component mapping from
+     * the `components` prop cannot be found.
      *
+     * @remarks
+     * Components will be rendered using the {@link SliceComponentProps} interface.
      * @defaultValue The Slice Zone default component provided to `@prismicio/vue` plugin if configured, otherwise `null` when `process.env.NODE_ENV === "production"` else {@link TODOSliceComponent}.
      */
     defaultComponent?: SliceComponentType<TSlice, TContext>;
     /**
-     * An HTML tag name, a component, or a functional component used to wrap the output. The Slice Zone is not wrapped by default.
+     * An HTML tag name, a component, or a functional component used to wrap the
+     * output. The Slice Zone is not wrapped by default.
      */
     wrapper?: string | ConcreteComponent;
 };
@@ -785,7 +855,7 @@ declare const SliceZoneImpl: DefineComponent<{
     wrapper?: string | ConcreteComponent<{}, any, any, vue.ComputedOptions, vue.MethodOptions> | undefined;
     context?: any;
     defaultComponent?: SliceComponentType<SliceLike<string>, unknown> | undefined;
-}> & {}, {
+}>, {
     wrapper: string | ConcreteComponent<{}, any, any, vue.ComputedOptions, vue.MethodOptions>;
     context: any;
     defaultComponent: SliceComponentType<SliceLike<string>, unknown>;
@@ -800,8 +870,10 @@ declare const SliceZone: new () => {
     $props: AllowedComponentProps & ComponentCustomProps & VNodeProps & SliceZoneProps;
 };
 
-declare type ClientError = PrismicError | ParsingError | ForbiddenError;
-/** @internal */
+declare type ClientError = PrismicError<unknown> | ParsingError | ForbiddenError;
+/**
+ * @internal
+ */
 declare type ComposableOnlyParameters = {
     client?: Ref<Client> | Client;
 };
@@ -811,226 +883,276 @@ declare type ComposableOnlyParameters = {
  * @typeParam TData - The expected format of the `data` property of the returned object
  */
 declare type ClientComposableReturnType<TData = unknown> = {
-    /** The current state of the composable's client method call. */
+    /**
+     * The current state of the composable's client method call.
+     */
     state: Ref<PrismicClientComposableState>;
-    /** Data returned by the client. */
+    /**
+     * Data returned by the client.
+     */
     data: Ref<TData | null>;
-    /** Error returned by the composable's client method call if in an errror state. */
-    error: Ref<ClientError | null>;
-    /** Perform the composable's client method call again. */
+    /**
+     * Error returned by the composable's client method call if in an errror state.
+     */
+    error: Ref<ClientError | Error | null>;
+    /**
+     * Perform the composable's client method call again.
+     */
     refresh: () => Promise<void>;
 };
 
 /**
  * A composable 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 ClientComposableReturnType}
- *
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
- *
  * @see Underlying `@prismicio/client` method {@link Client.get}
  */
-declare const usePrismicDocuments: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
+declare const usePrismicDocuments: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
- * A composable that queries content from the Prismic repository and returns only the first result, if any.
+ * A composable that queries content from the Prismic repository and returns
+ * only the first result, if any.
  *
+ * @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 ClientComposableReturnType}
- *
- * @typeParam TDocument - Type of the Prismic document returned
- *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
- *
  * @see Underlying `@prismicio/client` method {@link Client.getFirst}
  */
-declare const useFirstPrismicDocument: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
-/**
- * A composable that queries content from the Prismic repository and returns all matching content. If no predicates are provided, all documents will be fetched.
- *
- * @param params - Parameters to filter and sort results
- *
- * @returns The composable payload {@link ClientComposableReturnType}
- *
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
- *
- * @see Underlying `@prismicio/client` method {@link Client.getAll}
- */
-declare const useAllPrismicDocuments: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
-    limit?: number | undefined;
-} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
+declare const useFirstPrismicDocument: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
 /**
  * A composable that queries a document from the Prismic repository with a specific ID.
  *
+ * @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 ClientComposableReturnType}
- *
- * @typeParam TDocument - Type of the Prismic document returned
- *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
- *
  * @see Underlying `@prismicio/client` method {@link Client.getByID}
  */
-declare const usePrismicDocumentByID: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(id: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
+declare const usePrismicDocumentByID: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(id: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
 /**
  * A composable that queries documents from the Prismic repository with specific IDs.
  *
+ * @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 ClientComposableReturnType}
- *
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
- *
  * @see Underlying `@prismicio/client` method {@link Client.getByIDs}
  */
-declare const usePrismicDocumentsByIDs: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
+declare const usePrismicDocumentsByIDs: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
  * A composable that queries all documents from the Prismic repository with specific IDs.
  *
+ * @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 ClientComposableReturnType}
- *
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
- *
  * @see Underlying `@prismicio/client` method {@link Client.getAllByIDs}
  */
-declare const useAllPrismicDocumentsByIDs: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
+declare const useAllPrismicDocumentsByIDs: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
- * A composable that queries a document from the Prismic repository with a specific UID and Custom Type.
+ * A composable that queries a document from the Prismic repository with a
+ * specific UID and Custom Type.
  *
+ * @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 ClientComposableReturnType}
- *
- * @typeParam TDocument - Type of the Prismic document returned
- *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
- *
  * @see Underlying `@prismicio/client` method {@link Client.getByUID}
  */
-declare const usePrismicDocumentByUID: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(documentType: string, uid: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
+declare const usePrismicDocumentByUID: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(documentType: string, uid: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
 /**
- * A composable that queries a singleton document from the Prismic repository for a specific Custom Type.
+ * A composable that queries documents from the Prismic repository with specific UIDs.
  *
- * @param documentType - The API ID of the singleton Custom Type
+ * @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 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 ClientComposableReturnType}
+ * @see Underlying `@prismicio/client` method {@link Client.getByIDs}
+ */
+declare const usePrismicDocumentsByUIDs: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(documentType: string, uids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
+/**
+ * A composable that queries all documents from the Prismic repository with specific UIDs.
  *
- * @typeParam TDocument - Type of the Prismic document returned
- *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
+ * @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 document's Custom Type
+ * @param uids - A list of document UIDs
+ * @param params - Parameters to filter and sort results
  *
- * @see Underlying `@prismicio/client` method {@link Client.getSingle}
+ * @returns The composable payload {@link ClientComposableReturnType}
+ * @see Underlying `@prismicio/client` method {@link Client.getAllByIDs}
  */
-declare const useSinglePrismicDocument: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(documentType: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
+declare const useAllPrismicDocumentsByUIDs: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(documentType: string, ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
- * A composable that queries documents from the Prismic repository for a specific Custom Type.
+ * A composable that queries a singleton document from the Prismic repository
+ * for a specific Custom Type.
  *
- * @param documentType - The API ID of the Custom Type
+ * @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 ClientComposableReturnType}
+ * @see Underlying `@prismicio/client` method {@link Client.getSingle}
+ */
+declare const useSinglePrismicDocument: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(documentType: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
+/**
+ * A composable that queries documents from the Prismic repository for a
+ * specific Custom Type.
  *
+ * @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
  *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * @returns The composable payload {@link ClientComposableReturnType}
  * @see Underlying `@prismicio/client` method {@link Client.getByType}
  */
-declare const usePrismicDocumentsByType: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(documentType: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
+declare const usePrismicDocumentsByType: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(documentType: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
- * A composable that queries all documents from the Prismic repository for a specific Custom Type.
+ * A composable that queries all documents from the Prismic repository for a
+ * specific Custom Type.
  *
+ * @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 ClientComposableReturnType}
- *
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
- *
  * @see Underlying `@prismicio/client` method {@link Client.getAllByType}
  */
-declare const useAllPrismicDocumentsByType: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(documentType: string, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
+declare const useAllPrismicDocumentsByType: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(documentType: string, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
  * A composable that queries documents from the Prismic repository with a specific tag.
  *
+ * @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 ClientComposableReturnType}
- *
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
- *
  * @see Underlying `@prismicio/client` method {@link Client.getByTag}
  */
-declare const usePrismicDocumentsByTag: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(tag: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
+declare const usePrismicDocumentsByTag: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(tag: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
- * A composable that queries all documents from the Prismic repository with a specific tag.
+ * A composable that queries all documents from the Prismic repository with a
+ * specific tag.
  *
+ * @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 ClientComposableReturnType}
- *
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
- *
  * @see Underlying `@prismicio/client` method {@link Client.getAllByTag}
  */
-declare const useAllPrismicDocumentsByTag: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(tag: string, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
+declare const useAllPrismicDocumentsByTag: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(tag: string, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
- * A composable that queries documents from the Prismic repository with specific tags.
+ * A composable that queries documents from the Prismic repository with specific
+ * tags. A document must be tagged with all of the queried tags to be included.
  *
+ * @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 ClientComposableReturnType}
+ * @see Underlying `@prismicio/client` method {@link Client.getByTags}
+ */
+declare const usePrismicDocumentsByEveryTag: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(tags: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
+/**
+ * A composable that queries all documents from the Prismic repository with
+ * specific tags. A document must be tagged with all of the queried tags to be included.
  *
+ * @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 ClientComposableReturnType}
+ * @see Underlying `@prismicio/client` method {@link Client.getAllByTags}
+ */
+declare const useAllPrismicDocumentsByEveryTag: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(tags: string[], params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
+/**
+ * A composable that queries documents from the Prismic repository with specific
+ * tags. A document must be tagged with at least one of the queried tags to be included.
  *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
+ * @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 ClientComposableReturnType}
  * @see Underlying `@prismicio/client` method {@link Client.getByTags}
  */
-declare const usePrismicDocumentsByTags: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(tags: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
+declare const usePrismicDocumentsBySomeTags: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(tags: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
- * A composable that queries all documents from the Prismic repository with specific tags.
+ * A composable that queries all documents from the Prismic repository with
+ * specific tags. A document must be tagged with at least one of the queried
+ * tags to be included.
  *
+ * @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 ClientComposableReturnType}
+ * @see Underlying `@prismicio/client` method {@link Client.getAllByTags}
+ */
+declare const useAllPrismicDocumentsBySomeTags: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(tags: string[], params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
+/**
+ * **IMPORTANT**: Avoid using `dangerouslyUseAllPrismicDocuments` as it may be
+ * slower and require more resources than other composables. Prefer using other
+ * composables that filter by predicates such as `useAllPrismicDocumentsByType`.
  *
- * @typeParam TDocument - Type of Prismic documents returned
+ * A composable that queries content from the Prismic repository and returns all
+ * matching content. If no predicates are provided, all documents will be fetched.
  *
- * @remarks An additional `@prismicio/client` instance can be provided at `params.client`.
+ * @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
  *
- * @see Underlying `@prismicio/client` method {@link Client.getAllByTags}
+ * @returns The composable payload {@link ClientComposableReturnType}
+ * @see Underlying `@prismicio/client` method {@link Client.getAll}
  */
-declare const useAllPrismicDocumentsByTags: <TDocument extends PrismicDocument<Record<string, unknown>, string, string>>(tags: string[], params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
+declare const dangerouslyUseAllPrismicDocuments: <TDocument extends PrismicDocument<Record<string, _prismicio_types.AnyRegularField | _prismicio_types.GroupField<Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SliceZone<_prismicio_types.Slice<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>> | _prismicio_types.SharedSlice<string, _prismicio_types.SharedSliceVariation<string, Record<string, _prismicio_types.AnyRegularField>, Record<string, _prismicio_types.AnyRegularField>>>>>, string, string>>(params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
+    limit?: number | undefined;
+} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 
 /**
  * `@prismicio/vue` plugin interface interface location used for {@link usePrismic}.
@@ -1050,4 +1172,4 @@ declare module "@vue/runtime-core" {
     }
 }
 
-export { ClientComposableReturnType, DefineComponentSliceComponentProps, PrismicClientComposableState, PrismicEmbed, PrismicEmbedProps, PrismicImage, PrismicImageProps, PrismicLink, PrismicLinkProps, PrismicPlugin, PrismicPluginOptions, PrismicRichText, PrismicRichTextProps, PrismicText, PrismicTextProps, SliceComponentProps, SliceComponentType, SliceLike, SliceZone, SliceZoneComponents, SliceZoneImpl, SliceZoneLike, SliceZoneProps, TODOSliceComponent, UsePrismicLinkOptions, UsePrismicRichTextOptions, UsePrismicTextOptions, createPrismic, getSliceComponentProps, getSliceZoneComponents, prismicKey, useAllPrismicDocuments, useAllPrismicDocumentsByIDs, useAllPrismicDocumentsByTag, useAllPrismicDocumentsByTags, useAllPrismicDocumentsByType, useFirstPrismicDocument, usePrismic, usePrismicDocumentByID, usePrismicDocumentByUID, usePrismicDocuments, usePrismicDocumentsByIDs, usePrismicDocumentsByTag, usePrismicDocumentsByTags, usePrismicDocumentsByType, usePrismicLink, usePrismicRichText, usePrismicText, useSinglePrismicDocument };
+export { ClientComposableReturnType, DefineComponentSliceComponentProps, PrismicClientComposableState, PrismicEmbed, PrismicEmbedProps, PrismicImage, PrismicImageProps, PrismicLink, PrismicLinkProps, PrismicPlugin, PrismicPluginOptions, PrismicRichText, PrismicRichTextProps, PrismicText, PrismicTextProps, SliceComponentProps, SliceComponentType, SliceLike, SliceZone, SliceZoneComponents, SliceZoneImpl, SliceZoneLike, SliceZoneProps, TODOSliceComponent, UsePrismicLinkOptions, UsePrismicRichTextOptions, UsePrismicTextOptions, createPrismic, dangerouslyUseAllPrismicDocuments, getSliceComponentProps, getSliceZoneComponents, prismicKey, useAllPrismicDocumentsByEveryTag, useAllPrismicDocumentsByIDs, useAllPrismicDocumentsBySomeTags, useAllPrismicDocumentsByTag, useAllPrismicDocumentsByType, useAllPrismicDocumentsByUIDs, useFirstPrismicDocument, usePrismic, usePrismicDocumentByID, usePrismicDocumentByUID, usePrismicDocuments, usePrismicDocumentsByEveryTag, usePrismicDocumentsByIDs, usePrismicDocumentsBySomeTags, usePrismicDocumentsByTag, usePrismicDocumentsByType, usePrismicDocumentsByUIDs, usePrismicLink, usePrismicRichText, usePrismicText, useSinglePrismicDocument };