@prismicio/vue 3.0.0-beta.1 → 3.0.0-beta.2

package/dist/index.d.ts

@@ -2,8 +2,7 @@ import * as vue from 'vue';
 import { PropType, DefineComponent, FunctionalComponent, VNodeProps, AllowedComponentProps, ComponentCustomProps, ConcreteComponent, App, Ref, ComputedRef, InjectionKey } from 'vue';
 import * as _prismicio_client from '@prismicio/client';
 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 { asText, asHTML, asLink, LinkResolverFunction, asDate, asImageSrc, asImageWidthSrcSet, asImagePixelDensitySrcSet, documentToLinkField, HTMLFunctionSerializer, HTMLMapSerializer } from '@prismicio/helpers';
 import { Slice, EmbedField, ImageField, LinkField, PrismicDocument, RichTextField, Query } from '@prismicio/types';
 
 /**
@@ -111,7 +110,7 @@ declare type DefineComponentSliceComponentProps<TSlice extends SliceLike = Slice
  *
  * @returns Props object to use with {@link defineComponent}
  */
-declare const getSliceComponentProps: <TSlice extends SliceLike<string> = SliceLike<string>, TContext = unknown>(propsHint?: string[] | undefined) => DefineComponentSliceComponentProps<TSlice, TContext>;
+declare const getSliceComponentProps: <TSlice extends SliceLike<string> = SliceLike<string>, TContext = unknown>(propsHint?: ["slice", "index", "slices", "context"] | undefined) => DefineComponentSliceComponentProps<TSlice, TContext>;
 /**
  * A Vue component to be rendered for each instance of its Slice.
  *
@@ -163,6 +162,7 @@ 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}
@@ -191,6 +191,7 @@ declare type SliceZoneResolverArgs<TSlice extends SliceLike = SliceLike> = {
  * 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 Vue component to render for a Slice.
@@ -216,6 +217,7 @@ declare type SliceZoneProps<TSlice extends SliceLike = SliceLike, TContext = unk
      * Slice Zone.
      *
      * @deprecated Use the `components` prop instead.
+     *
      * @param args - Arguments for the resolver function.
      *
      * @returns The Vue component to render for a Slice.
@@ -231,6 +233,7 @@ declare type SliceZoneProps<TSlice extends SliceLike = SliceLike, TContext = unk
      *
      * @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>;
@@ -279,22 +282,37 @@ declare const SliceZoneImpl: DefineComponent<{
     [key: string]: any;
 }> | vue.VNode<vue.RendererNode, vue.RendererElement, {
     [key: string]: any;
-}>[]), unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, Record<string, any>, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<{
-    slices?: unknown;
-    components?: unknown;
-    resolver?: unknown;
-    context?: unknown;
-    defaultComponent?: unknown;
-    wrapper?: unknown;
-} & {
-    slices: SliceZoneLike<SliceLike<string>>;
-} & {
-    wrapper?: string | ConcreteComponent<{}, any, any, vue.ComputedOptions, vue.MethodOptions> | undefined;
-    context?: any;
-    components?: SliceZoneComponents<SliceLike<string>, unknown> | undefined;
-    resolver?: SliceZoneResolver<SliceLike<string>, unknown> | undefined;
-    defaultComponent?: SliceComponentType<SliceLike<string>, unknown> | undefined;
-}>, {
+}>[]), unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, Record<string, any>, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<vue.ExtractPropTypes<{
+    slices: {
+        type: PropType<SliceZoneLike<SliceLike<string>>>;
+        required: true;
+    };
+    components: {
+        type: PropType<SliceZoneComponents<SliceLike<string>, unknown>>;
+        default: undefined;
+        required: false;
+    };
+    resolver: {
+        type: PropType<SliceZoneResolver<SliceLike<string>, unknown>>;
+        default: undefined;
+        required: false;
+    };
+    context: {
+        type: null;
+        default: undefined;
+        required: false;
+    };
+    defaultComponent: {
+        type: PropType<SliceComponentType<SliceLike<string>, unknown>>;
+        default: undefined;
+        required: false;
+    };
+    wrapper: {
+        type: PropType<string | ConcreteComponent<{}, any, any, vue.ComputedOptions, vue.MethodOptions>>;
+        default: undefined;
+        required: false;
+    };
+}>>, {
     wrapper: string | ConcreteComponent<{}, any, any, vue.ComputedOptions, vue.MethodOptions>;
     context: any;
     components: SliceZoneComponents<SliceLike<string>, unknown>;
@@ -363,6 +381,7 @@ declare type PrismicPluginComponentsOptions = {
      *
      * @remarks
      * Components will be rendered using the {@link SliceComponentProps} interface.
+     *
      * @defaultValue `null` when `process.env.NODE_ENV === "production"` else {@link TODOSliceComponent}
      */
     sliceZoneDefaultComponent?: SliceComponentType;
@@ -558,6 +577,23 @@ declare type PrismicPluginHelpers = {
      * `@prismicio/helpers` {@link asDate} function.
      */
     asDate: typeof asDate;
+    /**
+     * Returns the URL of an Image field with optional image transformations (via
+     * Imgix URL parameters). This is `@prismicio/helpers` {@link asImageSrc} function.
+     */
+    asImageSrc: typeof asImageSrc;
+    /**
+     * Creates a width-based `srcset` from an Image field with optional image
+     * transformations (via Imgix URL parameters). This is `@prismicio/helpers`
+     * {@link asImageWidthSrcSet} function.
+     */
+    asImageWidthSrcSet: typeof asImageWidthSrcSet;
+    /**
+     * Creates a pixel-density-based `srcset` from an Image field with optional
+     * image transformations (via Imgix URL parameters). This is
+     * `@prismicio/helpers` {@link asImagePixelDensitySrcSet} function.
+     */
+    asImagePixelDensitySrcSet: typeof asImagePixelDensitySrcSet;
     /**
      * Converts a document into a link field. This is `@prismicio/helpers`
      * {@link documentToLinkField} function.
@@ -620,6 +656,7 @@ 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}
  */
@@ -684,17 +721,76 @@ declare type PrismicImageProps = {
      *
      * @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.
+     * interface (`src`, `srcset`, 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;
     /**
-     * A map of additional props to pass to the component used to render images
-     * when using one.
+     * An object of Imgix URL API parameters.
+     *
+     * @see Imgix URL parameters reference: https://docs.imgix.com/apis/rendering
+     */
+    imgixParams?: Parameters<typeof asImageSrc>[1];
+    /**
+     * Adds an additional `srcset` attribute to the image following given widths.
+     *
+     * @remarks
+     * A special value of `"auto"` is accepted to automatically use image widths
+     * coming from the API.
+     * @remarks
+     * A special value of `"defaults"` is accepted to automatically use image
+     * widths coming from `@prismicio/helpers`
+     * @remarks
+     * This prop is not compatible with the `pixelDensities` prop. When both are
+     * used the `pixelDensities` prop will be ignored.
+     */
+    widths?: NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"] | "auto" | "defaults";
+    /**
+     * Adds an additional `srcset` attribute to the image following giving pixel densities.
+     *
+     * @remarks
+     * A special value of `"defaults"` is accepted to automatically use image
+     * pixel densities coming from `@prismicio/helpers`
+     * @remarks
+     * This prop is not compatible with the `widths` prop. When both are used, the
+     * `pixelDensities` prop will be ignored.
+     */
+    pixelDensities?: NonNullable<Parameters<typeof asImagePixelDensitySrcSet>[1]>["pixelDensities"] | "defaults";
+};
+/**
+ * Options for {@link usePrismicImage}.
+ */
+declare type UsePrismicImageOptions = VueUseOptions<Omit<PrismicImageProps, "imageComponent">>;
+/**
+ * Return type of {@link usePrismicImage}.
+ */
+declare type UsePrismicImageReturnType = {
+    /**
+     * Resolved image `src` value.
+     */
+    src: ComputedRef<string | null>;
+    /**
+     * Resolved image `srcset` value.
      */
-    imageComponentAdditionalProps?: Record<string, unknown>;
+    srcset: ComputedRef<string | null>;
+    /**
+     * Resolved image `alt` value.
+     */
+    alt: ComputedRef<string | null>;
+    /**
+     * Resolved image `copyright` value.
+     */
+    copyright: ComputedRef<string | null>;
 };
+/**
+ * A low level composable that returns a resolved information about a Prismic image field.
+ *
+ * @param props - {@link UsePrismicImageOptions}
+ *
+ * @returns - Resolved image information {@link UsePrismicImageReturnType}
+ */
+declare const usePrismicImage: (props: UsePrismicImageOptions) => UsePrismicImageReturnType;
 /**
  * Component to render a Prismic image field.
  *
@@ -718,6 +814,7 @@ declare type PrismicLinkProps = {
      * 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;
@@ -870,6 +967,7 @@ declare type PrismicRichTextProps = {
      * 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;
@@ -877,6 +975,7 @@ 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;
@@ -954,219 +1053,395 @@ declare type ClientComposableReturnType<TData = unknown> = {
  *
  * @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}
+ *
  * @see Underlying `@prismicio/client` method {@link Client.get}
  */
-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>>;
+declare const usePrismicDocuments: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
  * 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}
+ *
  * @see Underlying `@prismicio/client` method {@link Client.getFirst}
  */
-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>;
+declare const useFirstPrismicDocument: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & 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}
+ *
  * @see Underlying `@prismicio/client` method {@link Client.getByID}
  */
-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>;
+declare const usePrismicDocumentByID: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(id: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & 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}
+ *
  * @see Underlying `@prismicio/client` method {@link Client.getByIDs}
  */
-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>>;
+declare const usePrismicDocumentsByIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & 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}
+ *
  * @see Underlying `@prismicio/client` method {@link Client.getAllByIDs}
  */
-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[]>;
+declare const useAllPrismicDocumentsByIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
  * 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}
+ *
  * @see Underlying `@prismicio/client` method {@link Client.getByUID}
  */
-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>;
+declare const usePrismicDocumentByUID: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: string, uid: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
 /**
  * A composable that queries documents from the Prismic repository with specific UIDs.
  *
  * @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>>;
+declare const usePrismicDocumentsByUIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: string, uids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
  * A composable that queries all documents from the Prismic repository with specific UIDs.
  *
  * @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
  *
  * @returns The composable payload {@link ClientComposableReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link Client.getAllByIDs}
  */
-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[]>;
+declare const useAllPrismicDocumentsByUIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: string, ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
  * A composable that queries a singleton document 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 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>;
+declare const useSinglePrismicDocument: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & 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
  *
  * @returns The composable payload {@link ClientComposableReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link Client.getByType}
  */
-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>>;
+declare const usePrismicDocumentsByType: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
  * 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}
+ *
  * @see Underlying `@prismicio/client` method {@link Client.getAllByType}
  */
-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[]>;
+declare const useAllPrismicDocumentsByType: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: string, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & 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}
+ *
  * @see Underlying `@prismicio/client` method {@link Client.getByTag}
  */
-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>>;
+declare const usePrismicDocumentsByTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tag: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
  * 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}
+ *
  * @see Underlying `@prismicio/client` method {@link Client.getAllByTag}
  */
-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[]>;
+declare const useAllPrismicDocumentsByTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tag: string, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
  * 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>>;
+declare const usePrismicDocumentsByEveryTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & 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[]>;
+declare const useAllPrismicDocumentsByEveryTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & 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`.
+ *
  * @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 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>>;
+declare const usePrismicDocumentsBySomeTags: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
  * 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
@@ -1174,14 +1449,25 @@ declare const usePrismicDocumentsBySomeTags: <TDocument extends PrismicDocument<
  *
  * @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[]>;
+declare const useAllPrismicDocumentsBySomeTags: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
+} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
  * **IMPORTANT**: Avoid using `dangerouslyUseAllPrismicDocuments` as it may be
  * slower and require more resources than other composables. Prefer using other
@@ -1192,14 +1478,25 @@ declare const useAllPrismicDocumentsBySomeTags: <TDocument extends 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 ClientComposableReturnType}
+ *
  * @see Underlying `@prismicio/client` method {@link Client.getAll}
  */
-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">> & {
+declare const dangerouslyUseAllPrismicDocuments: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
     limit?: number | undefined;
+} & {
+    signal?: {
+        aborted: any;
+        addEventListener: any;
+        removeEventListener: any;
+        dispatchEvent: any;
+        onabort: any;
+    } | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 
 /**
@@ -1220,4 +1517,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, SliceZoneResolver, TODOSliceComponent, UsePrismicLinkOptions, UsePrismicRichTextOptions, UsePrismicTextOptions, createPrismic, dangerouslyUseAllPrismicDocuments, defineSliceZoneComponents, getSliceComponentProps, prismicKey, useAllPrismicDocumentsByEveryTag, useAllPrismicDocumentsByIDs, useAllPrismicDocumentsBySomeTags, useAllPrismicDocumentsByTag, useAllPrismicDocumentsByType, useAllPrismicDocumentsByUIDs, useFirstPrismicDocument, usePrismic, usePrismicDocumentByID, usePrismicDocumentByUID, usePrismicDocuments, usePrismicDocumentsByEveryTag, usePrismicDocumentsByIDs, usePrismicDocumentsBySomeTags, usePrismicDocumentsByTag, usePrismicDocumentsByType, usePrismicDocumentsByUIDs, 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, SliceZoneResolver, TODOSliceComponent, UsePrismicImageOptions, UsePrismicLinkOptions, UsePrismicRichTextOptions, UsePrismicTextOptions, createPrismic, dangerouslyUseAllPrismicDocuments, defineSliceZoneComponents, getSliceComponentProps, prismicKey, useAllPrismicDocumentsByEveryTag, useAllPrismicDocumentsByIDs, useAllPrismicDocumentsBySomeTags, useAllPrismicDocumentsByTag, useAllPrismicDocumentsByType, useAllPrismicDocumentsByUIDs, useFirstPrismicDocument, usePrismic, usePrismicDocumentByID, usePrismicDocumentByUID, usePrismicDocuments, usePrismicDocumentsByEveryTag, usePrismicDocumentsByIDs, usePrismicDocumentsBySomeTags, usePrismicDocumentsByTag, usePrismicDocumentsByType, usePrismicDocumentsByUIDs, usePrismicImage, usePrismicLink, usePrismicRichText, usePrismicText, useSinglePrismicDocument };