@prismicio/vue - npm Package Compare versions

Comparing version 3.1.0 to 3.1.1

dist/index.d.ts

@@ -47,3 +47,4 @@ import * as vue from 'vue';
 /**
- * A looser version of the `SliceZone` type from `@prismicio/types` using `SliceLike`.
+ * A looser version of the `SliceZone` type from `@prismicio/types` using
+ * `SliceLike`.
  *
@@ -78,3 +79,4 @@ * If using Prismic's REST API, use the `SliceZone` export from
     /**
-     * Arbitrary data passed to `<SliceZone />` and made available to all Slice components.
+     * Arbitrary data passed to `<SliceZone />` and made available to all Slice
+     * components.
      */
@@ -87,3 +89,3 @@ context: TContext;
  *
- * @typeParam TSlice - The type(s) of slices in the Slice Zone
+ * @typeParam TSlice - The Slice type
  * @typeParam TContext - Arbitrary data passed to `<SliceZone />` and made
@@ -135,3 +137,3 @@ *   available to all Slice components
  *
- * @typeParam TSlice - The type(s) of slices in the Slice Zone
+ * @typeParam TSlice - The Slice type
  * @typeParam TContext - Arbitrary data passed to `<SliceZone />` and made
@@ -145,3 +147,3 @@ *   available to all Slice components
  */
-declare const getSliceComponentProps: <TSlice extends SliceLike<string> = SliceLike<string>, TContext = unknown>(propsHint?: ["slice", "index", "slices", "context"]) => DefineComponentSliceComponentProps<TSlice, TContext>;
+declare const getSliceComponentProps: <TSlice extends SliceLike<string> = any, TContext = unknown>(propsHint?: ["slice", "index", "slices", "context"]) => DefineComponentSliceComponentProps<TSlice, TContext>;
 /**
@@ -155,3 +157,4 @@ * A Vue component to be rendered for each instance of its Slice.
 /**
- * This Slice component can be used as a reminder to provide a proper implementation.
+ * This Slice component can be used as a reminder to provide a proper
+ * implementation.
  *
@@ -227,3 +230,4 @@ * This is also the default Vue component rendered when a component mapping
  * Slice Zone. If a nullish value is returned, the component will fallback to
- * the `components` or `defaultComponent` props to determine the rendered component.
+ * the `components` or `defaultComponent` props to determine the rendered
+ * component.
  *
@@ -297,3 +301,4 @@ * @deprecated Use the `components` prop instead.
     /**
-     * Value of the `rel` attribute to use on links rendered with `target="_blank"`
+     * Value of the `rel` attribute to use on links rendered with
+     * `target="_blank"`
      *
@@ -330,3 +335,4 @@ * @defaultValue `"noopener noreferrer"`
     /**
-     * An HTML tag name, a component, or a functional component used to render images.
+     * An HTML tag name, a component, or a functional component used to render
+     * images.
      *
@@ -374,3 +380,4 @@ * @remarks
      * An optional link resolver function used to resolve links to Prismic
-     * documents when not using the route resolver parameter with `@prismicio/client`.
+     * documents when not using the route resolver parameter with
+     * `@prismicio/client`.
      *
@@ -381,3 +388,4 @@ * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
     /**
-     * An optional HTML serializer to customize the way rich text fields are rendered.
+     * An optional HTML serializer to customize the way rich text fields are
+     * rendered.
      *
@@ -505,3 +513,4 @@ * @see HTML serializer documentation {@link https://prismic.io/docs/core-concepts/html-serializer}
  * `@prismicio/client` related methods and properties exposed by
- * `@prismicio/vue` plugin and accessible through `this.$prismic` and `usePrismic()`.
+ * `@prismicio/vue` plugin and accessible through `this.$prismic` and
+ * `usePrismic()`.
  */
@@ -564,3 +573,4 @@ declare type PrismicPluginClient = {
      * Returns the URL of an Image field with optional image transformations (via
-     * Imgix URL parameters). This is `@prismicio/helpers` {@link asImageSrc} function.
+     * Imgix URL parameters). This is `@prismicio/helpers` {@link asImageSrc}
+     * function.
      */
@@ -628,3 +638,4 @@ asImageSrc: typeof asImageSrc;
 /**
- * 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.
  *
@@ -679,3 +690,4 @@ * @internal
     /**
-     * An HTML tag name, a component, or a functional component used to wrap the output.
+     * An HTML tag name, a component, or a functional component used to wrap the
+     * output.
      *
@@ -705,3 +717,4 @@ * @defaultValue `"div"`
     /**
-     * An HTML tag name, a component, or a functional component used to render images.
+     * An HTML tag name, a component, or a functional component used to render
+     * images.
      *
@@ -736,3 +749,4 @@ * @remarks
     /**
-     * Adds an additional `srcset` attribute to the image following giving pixel densities.
+     * Adds an additional `srcset` attribute to the image following giving pixel
+     * densities.
      *
@@ -774,3 +788,4 @@ * @remarks
 /**
- * A low level composable that returns a resolved information about a Prismic image field.
+ * A low level composable that returns a resolved information about a Prismic
+ * image field.
  *
@@ -818,3 +833,4 @@ * @param props - {@link UsePrismicImageOptions}
     /**
-     * Value of the `rel` attribute to use on links rendered with `target="_blank"`.
+     * Value of the `rel` attribute to use on links rendered with
+     * `target="_blank"`.
      *
@@ -877,3 +893,4 @@ * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"noopener noreferrer"` otherwise.
 /**
- * A low level composable that returns resolved information about a Prismic link field.
+ * A low level composable that returns resolved information about a Prismic link
+ * field.
  *
@@ -910,3 +927,4 @@ * @param props - {@link UsePrismicLinkOptions}
     /**
-     * An HTML tag name, a component, or a functional component used to wrap the output.
+     * An HTML tag name, a component, or a functional component used to wrap the
+     * output.
      *
@@ -936,7 +954,9 @@ * @defaultValue `"div"`
 /**
- * A low level composable that returns a serialized rich text field as plain text.
+ * A low level composable that returns a serialized rich text field as plain
+ * text.
  *
  * @param props - {@link UsePrismicTextOptions}
  *
- * @returns - Serialized rich text field as plain text {@link UsePrismicTextReturnType}
+ * @returns - Serialized rich text field as plain text
+ *   {@link UsePrismicTextReturnType}
  */
@@ -980,3 +1000,4 @@ declare const usePrismicText: (props: UsePrismicTextOptions) => UsePrismicTextReturnType;
     /**
-     * An HTML tag name, a component, or a functional component used to wrap the output.
+     * An HTML tag name, a component, or a functional component used to wrap the
+     * output.
      *
@@ -1010,3 +1031,4 @@ * @defaultValue `"div"`
  *
- * @returns - Serialized rich text field as HTML {@link UsePrismicRichTextReturnType}
+ * @returns - Serialized rich text field as HTML
+ *   {@link UsePrismicRichTextReturnType}
  */
@@ -1034,3 +1056,4 @@ declare const usePrismicRichText: (props: UsePrismicRichTextOptions) => UsePrismicRichTextReturnType;
  *
- * @typeParam TData - The expected format of the `data` property of the returned object
+ * @typeParam TData - The expected format of the `data` property of the returned
+ *   object
  */
@@ -1047,3 +1070,4 @@ declare type ClientComposableReturnType<TData = unknown> = {
     /**
-     * Error returned by the composable's client method call if in an errror state.
+     * Error returned by the composable's client method call if in an errror
+     * state.
      */
@@ -1061,4 +1085,4 @@ error: Ref<ClientError | Error | null>;
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1073,3 +1097,3 @@ *
 declare const usePrismicDocuments: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
@@ -1081,4 +1105,4 @@ /**
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of the Prismic document returned
@@ -1093,10 +1117,11 @@ *
 declare const useFirstPrismicDocument: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
 /**
- * A composable that queries a document from the Prismic repository with a specific ID.
+ * 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`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of the Prismic document returned
@@ -1112,10 +1137,11 @@ *
 declare const usePrismicDocumentByID: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(id: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
 /**
- * A composable that queries documents from the Prismic repository with specific IDs.
+ * A composable that queries documents from the Prismic repository with specific
+ * IDs.
  *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1131,10 +1157,11 @@ *
 declare const usePrismicDocumentsByIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
- * A composable that queries all documents from the Prismic repository with specific IDs.
+ * 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`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1152,3 +1179,3 @@ *
 } & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
@@ -1160,4 +1187,4 @@ /**
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of the Prismic document returned
@@ -1174,10 +1201,11 @@ *
 declare const usePrismicDocumentByUID: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, uid: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
 /**
- * A composable that queries documents from the Prismic repository with specific UIDs.
+ * A composable that queries documents from the Prismic repository with specific
+ * UIDs.
  *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1194,10 +1222,11 @@ *
 declare const usePrismicDocumentsByUIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, uids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
- * A composable that queries all documents from the Prismic repository with specific UIDs.
+ * 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`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1216,3 +1245,3 @@ *
 } & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
@@ -1224,4 +1253,4 @@ /**
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of the Prismic document returned
@@ -1237,3 +1266,3 @@ *
 declare const useSinglePrismicDocument: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
@@ -1245,4 +1274,4 @@ /**
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1258,3 +1287,3 @@ *
 declare const usePrismicDocumentsByType: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
@@ -1266,4 +1295,4 @@ /**
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1281,10 +1310,11 @@ *
 } & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
- * A composable that queries documents from the Prismic repository with a specific tag.
+ * 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`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1300,3 +1330,3 @@ *
 declare const usePrismicDocumentsByTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tag: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
@@ -1308,4 +1338,4 @@ /**
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1323,3 +1353,3 @@ *
 } & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
@@ -1331,4 +1361,4 @@ /**
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1344,11 +1374,12 @@ *
 declare const usePrismicDocumentsByEveryTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & 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.
+ * 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`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1366,11 +1397,12 @@ *
 } & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & 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.
+ * 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`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1386,3 +1418,3 @@ *
 declare const usePrismicDocumentsBySomeTags: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
@@ -1395,4 +1427,4 @@ /**
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1410,3 +1442,3 @@ *
 } & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
@@ -1416,10 +1448,12 @@ /**
  * slower and require more resources than other composables. Prefer using other
- * composables that filter by predicates such as `useAllPrismicDocumentsByType`.
+ * composables that filter by predicates such as
+ * `useAllPrismicDocumentsByType`.
  *
  * A composable that queries content from the Prismic repository and returns all
- * matching content. If no predicates are provided, all documents will be fetched.
+ * matching content. If no predicates are provided, all documents will be
+ * fetched.
  *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -1436,7 +1470,8 @@ *
 } & {
-    signal?: _prismicio_client.AbortSignalLike | undefined;
+    signal?: any;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 
 /**
- * `@prismicio/vue` plugin interface interface location used for {@link usePrismic}.
+ * `@prismicio/vue` plugin interface interface location used for
+ * {@link usePrismic}.
  *
@@ -1443,0 +1478,0 @@ * @internal

package.json

 {
 	"name": "@prismicio/vue",
-	"version": "3.1.0",
+	"version": "3.1.1",
 	"description": "Vue plugin, components, and composables to fetch and present Prismic content",
@@ -53,36 +53,36 @@ "keywords": [
 	"dependencies": {
-		"@prismicio/client": "^6.7.0",
-		"@prismicio/helpers": "^2.3.3",
+		"@prismicio/client": "^6.7.1",
+		"@prismicio/helpers": "^2.3.5",
 		"@prismicio/types": "^0.2.3",
 		"isomorphic-unfetch": "^3.1.0",
-		"vue-router": "^4.1.4"
+		"vue-router": "^4.1.5"
 	},
 	"devDependencies": {
 		"@prismicio/mock": "^0.1.1",
-		"@size-limit/preset-small-lib": "^8.0.1",
+		"@size-limit/preset-small-lib": "^8.1.0",
 		"@types/escape-html": "^1.0.2",
-		"@types/jsdom-global": "^3.0.3",
-		"@typescript-eslint/eslint-plugin": "~5.33.0",
-		"@typescript-eslint/parser": "^5.34.0",
-		"@vitejs/plugin-vue": "^3.0.3",
-		"@vitest/coverage-c8": "0.22.1",
-		"@vue/compiler-sfc": "^3.2.37",
-		"@vue/eslint-config-typescript": "^11.0.0",
-		"@vue/test-utils": "^2.0.2",
-		"eslint": "^8.22.0",
+		"@types/jsdom-global": "^3.0.4",
+		"@typescript-eslint/eslint-plugin": "^5.39.0",
+		"@typescript-eslint/parser": "^5.39.0",
+		"@vitejs/plugin-vue": "^3.1.2",
+		"@vitest/coverage-c8": "^0.23.4",
+		"@vue/compiler-sfc": "^3.2.40",
+		"@vue/eslint-config-typescript": "^11.0.2",
+		"@vue/test-utils": "^2.1.0",
+		"eslint": "^8.24.0",
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-plugin-prettier": "^4.2.1",
-		"eslint-plugin-tsdoc": "^0.2.16",
-		"eslint-plugin-vue": "^9.4.0",
-		"jsdom": "^20.0.0",
+		"eslint-plugin-tsdoc": "^0.2.17",
+		"eslint-plugin-vue": "^9.6.0",
+		"jsdom": "^20.0.1",
 		"jsdom-global": "^3.0.2",
 		"prettier": "^2.7.1",
-		"prettier-plugin-jsdoc": "^0.3.38",
+		"prettier-plugin-jsdoc": "^0.4.2",
 		"siroc": "^0.16.0",
-		"size-limit": "^8.0.1",
+		"size-limit": "^8.1.0",
 		"standard-version": "^9.5.0",
-		"typescript": "^4.7.4",
-		"vite": "^3.0.9",
-		"vitest": "^0.22.1",
-		"vue": "^3.2.37"
+		"typescript": "^4.8.4",
+		"vite": "^3.1.4",
+		"vitest": "^0.23.4",
+		"vue": "^3.2.40"
 	},
@@ -89,0 +89,0 @@ "peerDependencies": {

src/components/PrismicEmbed.ts

@@ -29,3 +29,4 @@ import {
 	/**
-	 * An HTML tag name, a component, or a functional component used to wrap the output.
+	 * An HTML tag name, a component, or a functional component used to wrap the
+	 * output.
 	 *
@@ -32,0 +33,0 @@ * @defaultValue `"div"`

src/components/PrismicImage.ts

@@ -42,3 +42,4 @@ import {
 	/**
-	 * An HTML tag name, a component, or a functional component used to render images.
+	 * An HTML tag name, a component, or a functional component used to render
+	 * images.
 	 *
@@ -79,3 +80,4 @@ * @remarks
 	/**
-	 * Adds an additional `srcset` attribute to the image following giving pixel densities.
+	 * Adds an additional `srcset` attribute to the image following giving pixel
+	 * densities.
 	 *
@@ -129,3 +131,4 @@ * @remarks
 /**
- * A low level composable that returns a resolved information about a Prismic image field.
+ * A low level composable that returns a resolved information about a Prismic
+ * image field.
  *
@@ -132,0 +135,0 @@ * @param props - {@link UsePrismicImageOptions}

src/components/PrismicLink.ts

@@ -69,3 +69,4 @@ import {
 	/**
-	 * Value of the `rel` attribute to use on links rendered with `target="_blank"`.
+	 * Value of the `rel` attribute to use on links rendered with
+	 * `target="_blank"`.
 	 *
@@ -136,3 +137,4 @@ * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"noopener noreferrer"` otherwise.
 /**
- * A low level composable that returns resolved information about a Prismic link field.
+ * A low level composable that returns resolved information about a Prismic link
+ * field.
  *
@@ -139,0 +141,0 @@ * @param props - {@link UsePrismicLinkOptions}

src/components/PrismicRichText.ts

@@ -69,3 +69,4 @@ import {
 	/**
-	 * An HTML tag name, a component, or a functional component used to wrap the output.
+	 * An HTML tag name, a component, or a functional component used to wrap the
+	 * output.
 	 *
@@ -105,3 +106,4 @@ * @defaultValue `"div"`
  *
- * @returns - Serialized rich text field as HTML {@link UsePrismicRichTextReturnType}
+ * @returns - Serialized rich text field as HTML
+ *   {@link UsePrismicRichTextReturnType}
  */
@@ -108,0 +110,0 @@ export const usePrismicRichText = (

src/components/PrismicText.ts

@@ -42,3 +42,4 @@ import {
 	/**
-	 * An HTML tag name, a component, or a functional component used to wrap the output.
+	 * An HTML tag name, a component, or a functional component used to wrap the
+	 * output.
 	 *
@@ -74,7 +75,9 @@ * @defaultValue `"div"`
 /**
- * A low level composable that returns a serialized rich text field as plain text.
+ * A low level composable that returns a serialized rich text field as plain
+ * text.
  *
  * @param props - {@link UsePrismicTextOptions}
  *
- * @returns - Serialized rich text field as plain text {@link UsePrismicTextReturnType}
+ * @returns - Serialized rich text field as plain text
+ *   {@link UsePrismicTextReturnType}
  */
@@ -81,0 +84,0 @@ export const usePrismicText = (

src/components/SliceZone.ts

@@ -71,3 +71,4 @@ import {
 /**
- * A looser version of the `SliceZone` type from `@prismicio/types` using `SliceLike`.
+ * A looser version of the `SliceZone` type from `@prismicio/types` using
+ * `SliceLike`.
  *
@@ -115,3 +116,4 @@ * If using Prismic's REST API, use the `SliceZone` export from
 	/**
-	 * Arbitrary data passed to `<SliceZone />` and made available to all Slice components.
+	 * Arbitrary data passed to `<SliceZone />` and made available to all Slice
+	 * components.
 	 */
@@ -125,3 +127,3 @@ context: TContext;
  *
- * @typeParam TSlice - The type(s) of slices in the Slice Zone
+ * @typeParam TSlice - The Slice type
  * @typeParam TContext - Arbitrary data passed to `<SliceZone />` and made
@@ -178,3 +180,3 @@ *   available to all Slice components
  *
- * @typeParam TSlice - The type(s) of slices in the Slice Zone
+ * @typeParam TSlice - The Slice type
  * @typeParam TContext - Arbitrary data passed to `<SliceZone />` and made
@@ -189,3 +191,4 @@ *   available to all Slice components
 export const getSliceComponentProps = <
-	TSlice extends SliceLike = SliceLike,
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	TSlice extends SliceLike = any,
 	TContext = unknown,
@@ -231,3 +234,4 @@ >(
 /**
- * This Slice component can be used as a reminder to provide a proper implementation.
+ * This Slice component can be used as a reminder to provide a proper
+ * implementation.
  *
@@ -376,3 +380,4 @@ * This is also the default Vue component rendered when a component mapping
  * Slice Zone. If a nullish value is returned, the component will fallback to
- * the `components` or `defaultComponent` props to determine the rendered component.
+ * the `components` or `defaultComponent` props to determine the rendered
+ * component.
  *
@@ -379,0 +384,0 @@ * @deprecated Use the `components` prop instead.

src/composables.ts

@@ -24,4 +24,4 @@ /* eslint-disable @typescript-eslint/no-unused-vars */
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -47,4 +47,4 @@ *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of the Prismic document returned
@@ -66,7 +66,8 @@ *
 /**
- * A composable that queries a document from the Prismic repository with a specific ID.
+ * 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`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of the Prismic document returned
@@ -90,7 +91,8 @@ *
 /**
- * A composable that queries documents from the Prismic repository with specific IDs.
+ * A composable that queries documents from the Prismic repository with specific
+ * IDs.
  *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -114,7 +116,8 @@ *
 /**
- * A composable that queries all documents from the Prismic repository with specific IDs.
+ * 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`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -143,4 +146,4 @@ *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of the Prismic document returned
@@ -166,7 +169,8 @@ *
 /**
- * A composable that queries documents from the Prismic repository with specific UIDs.
+ * A composable that queries documents from the Prismic repository with specific
+ * UIDs.
  *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -192,7 +196,8 @@ *
 /**
- * A composable that queries all documents from the Prismic repository with specific UIDs.
+ * 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`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -223,4 +228,4 @@ *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of the Prismic document returned
@@ -248,4 +253,4 @@ *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -273,4 +278,4 @@ *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -295,7 +300,8 @@ *
 /**
- * A composable that queries documents from the Prismic repository with a specific tag.
+ * 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`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -323,4 +329,4 @@ *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -349,4 +355,4 @@ *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -374,7 +380,8 @@ *
  * 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.
+ * 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`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -402,7 +409,8 @@ *
  * 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.
+ * 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`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -434,4 +442,4 @@ *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -460,10 +468,12 @@ *
  * slower and require more resources than other composables. Prefer using other
- * composables that filter by predicates such as `useAllPrismicDocumentsByType`.
+ * composables that filter by predicates such as
+ * `useAllPrismicDocumentsByType`.
  *
  * A composable that queries content from the Prismic repository and returns all
- * matching content. If no predicates are provided, all documents will be fetched.
+ * matching content. If no predicates are provided, all documents will be
+ * fetched.
  *
  * @remarks
- * An additional `@prismicio/client` instance can be provided at `params.client`.
- *
+ * An additional `@prismicio/client` instance can be provided at
+ * `params.client`.
  * @typeParam TDocument - Type of Prismic documents returned
@@ -470,0 +480,0 @@ *

src/injectionSymbols.ts

@@ -14,3 +14,4 @@ import type { InjectionKey } from "vue";
 /**
- * `@prismicio/vue` plugin interface interface location used for {@link usePrismic}.
+ * `@prismicio/vue` plugin interface interface location used for
+ * {@link usePrismic}.
  *
@@ -17,0 +18,0 @@ * @internal

src/types.ts

@@ -44,3 +44,4 @@ import type { App, ConcreteComponent, Ref } from "vue";
 	/**
-	 * Value of the `rel` attribute to use on links rendered with `target="_blank"`
+	 * Value of the `rel` attribute to use on links rendered with
+	 * `target="_blank"`
 	 *
@@ -80,3 +81,4 @@ * @defaultValue `"noopener noreferrer"`
 	/**
-	 * An HTML tag name, a component, or a functional component used to render images.
+	 * An HTML tag name, a component, or a functional component used to render
+	 * images.
 	 *
@@ -128,3 +130,4 @@ * @remarks
 	 * An optional link resolver function used to resolve links to Prismic
-	 * documents when not using the route resolver parameter with `@prismicio/client`.
+	 * documents when not using the route resolver parameter with
+	 * `@prismicio/client`.
 	 *
@@ -136,3 +139,4 @@ * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
 	/**
-	 * An optional HTML serializer to customize the way rich text fields are rendered.
+	 * An optional HTML serializer to customize the way rich text fields are
+	 * rendered.
 	 *
@@ -272,3 +276,4 @@ * @see HTML serializer documentation {@link https://prismic.io/docs/core-concepts/html-serializer}
  * `@prismicio/client` related methods and properties exposed by
- * `@prismicio/vue` plugin and accessible through `this.$prismic` and `usePrismic()`.
+ * `@prismicio/vue` plugin and accessible through `this.$prismic` and
+ * `usePrismic()`.
  */
@@ -341,3 +346,4 @@ export type PrismicPluginClient = {
 	 * Returns the URL of an Image field with optional image transformations (via
-	 * Imgix URL parameters). This is `@prismicio/helpers` {@link asImageSrc} function.
+	 * Imgix URL parameters). This is `@prismicio/helpers` {@link asImageSrc}
+	 * function.
 	 */
@@ -418,3 +424,4 @@ asImageSrc: typeof asImageSrc;
 /**
- * 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.
  *
@@ -421,0 +428,0 @@ * @internal

src/useStatefulPrismicClientMethod.ts

@@ -48,3 +48,4 @@ import { isRef, ref, Ref, shallowRef, unref, watch } from "vue";
  *
- * @typeParam TData - The expected format of the `data` property of the returned object
+ * @typeParam TData - The expected format of the `data` property of the returned
+ *   object
  */
@@ -63,3 +64,4 @@ export type ClientComposableReturnType<TData = unknown> = {
 	/**
-	 * Error returned by the composable's client method call if in an errror state.
+	 * Error returned by the composable's client method call if in an errror
+	 * state.
 	 */
@@ -79,3 +81,4 @@ error: Ref<ClientError | Error | null>;
  *
- * @returns `true` if `value` is a `@prismicio/client` params object, `false` otherwise
+ * @returns `true` if `value` is a `@prismicio/client` params object, `false`
+ *   otherwise
  */
@@ -82,0 +85,0 @@ const isParams = (

No alert changes

Improved metrics

Lines of code

5873

increased by1.24%

Worsened metrics

Total package byte prevSize

432483

decreased by-0.03%

Dependency changes

• Updated@prismicio/client@^6.7.1

• Updated@prismicio/helpers@^2.3.5

• Updatedvue-router@^4.1.5