@prismicio/vue 3.1.0 → 3.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/vue",
-	"version": "3.1.0",
+	"version": "3.1.1",
 	"description": "Vue plugin, components, and composables to fetch and present Prismic content",
 	"keywords": [
 		"typescript",
@@ -50,40 +50,40 @@
 		"unit:watch": "vitest watch"
 	},
 	"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"
 	},
 	"peerDependencies": {
 		"vue": "^3.0.0"

package/src/components/PrismicEmbed.ts

@@ -26,7 +26,8 @@ export type PrismicEmbedProps = {
 	field: EmbedField;
 
 	/**
-	 * 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.
 	 *
 	 * @defaultValue `"div"`
 	 */

package/src/components/PrismicImage.ts

@@ -39,7 +39,8 @@ export type PrismicImageProps = {
 	field: ImageField;
 
 	/**
-	 * 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.
 	 *
 	 * @remarks
 	 * HTML tag names and components will be rendered using the `img` tag
@@ -75,7 +76,8 @@ export type PrismicImageProps = {
 		| "defaults";
 
 	/**
-	 * Adds an additional `srcset` attribute to the image following giving pixel densities.
+	 * Adds an additional `srcset` attribute to the image following giving pixel
+	 * densities.
 	 *
 	 * @remarks
 	 * A special value of `"defaults"` is accepted to automatically use image
@@ -124,7 +126,8 @@ export type UsePrismicImageReturnType = {
 };
 
 /**
- * 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.
  *
  * @param props - {@link UsePrismicImageOptions}
  *

package/src/components/PrismicLink.ts

@@ -66,7 +66,8 @@ export type PrismicLinkProps = {
 	rel?: string | null;
 
 	/**
-	 * 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"`.
 	 *
 	 * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"noopener noreferrer"` otherwise.
 	 */
@@ -132,7 +133,8 @@ export type UsePrismicLinkReturnType = {
 };
 
 /**
- * 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.
  *
  * @param props - {@link UsePrismicLinkOptions}
  *

package/src/components/PrismicRichText.ts

@@ -66,7 +66,8 @@ export type PrismicRichTextProps = {
 	htmlSerializer?: HTMLFunctionSerializer | HTMLMapSerializer;
 
 	/**
-	 * 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.
 	 *
 	 * @defaultValue `"div"`
 	 */
@@ -101,7 +102,8 @@ export type UsePrismicRichTextReturnType = {
  *
  * @param props - {@link UsePrismicRichTextOptions}
  *
- * @returns - Serialized rich text field as HTML {@link UsePrismicRichTextReturnType}
+ * @returns - Serialized rich text field as HTML
+ *   {@link UsePrismicRichTextReturnType}
  */
 export const usePrismicRichText = (
 	props: UsePrismicRichTextOptions,

package/src/components/PrismicText.ts

@@ -39,7 +39,8 @@ export type PrismicTextProps = {
 	separator?: string;
 
 	/**
-	 * 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.
 	 *
 	 * @defaultValue `"div"`
 	 */
@@ -70,11 +71,13 @@ export type UsePrismicTextReturnType = {
 };
 
 /**
- * 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}
  */
 export const usePrismicText = (
 	props: UsePrismicTextOptions,

package/src/components/SliceZone.ts

@@ -68,7 +68,8 @@ export type SliceLike<TSliceType extends string = string> =
 	| SliceLikeGraphQL<TSliceType>;
 
 /**
- * A looser version of the `SliceZone` type from `@prismicio/types` using `SliceLike`.
+ * 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.
@@ -111,7 +112,8 @@ export type SliceComponentProps<
 	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;
 };
@@ -120,7 +122,7 @@ export type SliceComponentProps<
  * 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 TSlice - The Slice type
  * @typeParam TContext - Arbitrary data passed to `<SliceZone />` and made
  *   available to all Slice components
  */
@@ -172,7 +174,7 @@ export type DefineComponentSliceComponentProps<
  * };
  * ```
  *
- * @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
  *   available to all Slice components
  * @param propsHint - An optional array of prop names used for the sole purpose
@@ -182,7 +184,8 @@ export type DefineComponentSliceComponentProps<
  * @returns Props object to use with {@link defineComponent}
  */
 export const getSliceComponentProps = <
-	TSlice extends SliceLike = SliceLike,
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	TSlice extends SliceLike = any,
 	TContext = unknown,
 >(
 	// eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -223,7 +226,8 @@ export type SliceComponentType<
 	| FunctionalComponent<SliceComponentProps<TSlice, TContext>>;
 
 /**
- * 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.
  *
  * This is also the default Vue component rendered when a component mapping
  * cannot be found in `<SliceZone />`.
@@ -367,7 +371,8 @@ export type SliceZoneResolverArgs<TSlice extends SliceLike = SliceLike> = {
 /**
  * A function that determines the rendered Vue component for each Slice in the
  * Slice Zone. If a nullish value is returned, the component will fallback to
- * the `components` or `defaultComponent` props to determine the rendered component.
+ * the `components` or `defaultComponent` props to determine the rendered
+ * component.
  *
  * @deprecated Use the `components` prop instead.
  *

package/src/composables.ts

@@ -21,8 +21,8 @@ import {
  * A composable that queries content from the Prismic repository.
  *
  * @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
  *
  * @param params - Parameters to filter, sort, and paginate results
@@ -43,8 +43,8 @@ export const usePrismicDocuments = <TDocument extends PrismicDocument>(
  * only the first result, if any.
  *
  * @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
  *
  * @param params - Parameters to filter, sort, and paginate results
@@ -61,11 +61,12 @@ export const useFirstPrismicDocument = <TDocument extends PrismicDocument>(
 	useStatefulPrismicClientMethod("getFirst", args);
 
 /**
- * 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
  *
  * @param id - ID of the document
@@ -84,11 +85,12 @@ export const usePrismicDocumentByID = <TDocument extends PrismicDocument>(
 	useStatefulPrismicClientMethod("getByID", args);
 
 /**
- * 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
  *
  * @param ids - A list of document IDs
@@ -107,11 +109,12 @@ export const usePrismicDocumentsByIDs = <TDocument extends PrismicDocument>(
 	useStatefulPrismicClientMethod("getByIDs", args);
 
 /**
- * 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
  *
  * @param ids - A list of document IDs
@@ -135,8 +138,8 @@ export const useAllPrismicDocumentsByIDs = <TDocument extends PrismicDocument>(
  * specific UID and Custom Type.
  *
  * @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
  *
  * @param documentType - The API ID of the document's Custom Type
@@ -157,11 +160,12 @@ export const usePrismicDocumentByUID = <TDocument extends PrismicDocument>(
 	useStatefulPrismicClientMethod("getByUID", args);
 
 /**
- * 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
  *
  * @param documentType - The API ID of the document's Custom Type
@@ -182,11 +186,12 @@ export const usePrismicDocumentsByUIDs = <TDocument extends PrismicDocument>(
 	useStatefulPrismicClientMethod("getByUIDs", args);
 
 /**
- * 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
  *
  * @param documentType - The API ID of the document's Custom Type
@@ -212,8 +217,8 @@ export const useAllPrismicDocumentsByUIDs = <TDocument extends PrismicDocument>(
  * for a specific Custom Type.
  *
  * @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
  *
  * @param documentType - The API ID of the singleton Custom Type
@@ -236,8 +241,8 @@ export const useSinglePrismicDocument = <TDocument extends PrismicDocument>(
  * specific Custom Type.
  *
  * @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
  *
  * @param documentType - The API ID of the Custom Type
@@ -260,8 +265,8 @@ export const usePrismicDocumentsByType = <TDocument extends PrismicDocument>(
  * specific Custom Type.
  *
  * @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
  *
  * @param documentType - The API ID of the Custom Type
@@ -281,11 +286,12 @@ export const useAllPrismicDocumentsByType = <TDocument extends PrismicDocument>(
 	useStatefulPrismicClientMethod("getAllByType", args);
 
 /**
- * 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
  *
  * @param tag - The tag that must be included on a document
@@ -308,8 +314,8 @@ export const usePrismicDocumentsByTag = <TDocument extends PrismicDocument>(
  * 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
  *
  * @param tag - The tag that must be included on a document
@@ -333,8 +339,8 @@ export const useAllPrismicDocumentsByTag = <TDocument extends PrismicDocument>(
  * 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
  *
  * @param tags - A list of tags that must be included on a document
@@ -357,11 +363,12 @@ export const usePrismicDocumentsByEveryTag = <
 
 /**
  * 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
  *
  * @param tags - A list of tags that must be included on a document
@@ -384,11 +391,12 @@ export const useAllPrismicDocumentsByEveryTag = <
 
 /**
  * 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
  *
  * @param tags - A list of tags that must be included on a document
@@ -415,8 +423,8 @@ export const usePrismicDocumentsBySomeTags = <
  * 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
  *
  * @param tags - A list of tags that must be included on a document
@@ -440,14 +448,16 @@ export const useAllPrismicDocumentsBySomeTags = <
 /**
  * **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`.
+ * 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
  *
  * @param params - Parameters to filter and sort results

package/src/injectionSymbols.ts

@@ -11,7 +11,8 @@ import type { usePrismic } from "./usePrismic";
 /* eslint-enable @typescript-eslint/no-unused-vars */
 
 /**
- * `@prismicio/vue` plugin interface interface location used for {@link usePrismic}.
+ * `@prismicio/vue` plugin interface interface location used for
+ * {@link usePrismic}.
  *
  * @internal
  */

package/src/types.ts

@@ -41,7 +41,8 @@ import type { usePrismicDocuments } from "./composables";
  */
 type PrismicPluginComponentsOptions = {
 	/**
-	 * 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"`
 	 *
 	 * @defaultValue `"noopener noreferrer"`
 	 */
@@ -76,7 +77,8 @@ type PrismicPluginComponentsOptions = {
 	linkExternalComponent?: string | ConcreteComponent;
 
 	/**
-	 * 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.
 	 *
 	 * @remarks
 	 * HTML tag names and components will be rendered using the `img` tag
@@ -123,14 +125,16 @@ type PrismicPluginComponentsOptions = {
 type PrismicPluginOptionsBase = {
 	/**
 	 * 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`.
 	 *
 	 * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
 	 */
 	linkResolver?: LinkResolverFunction;
 
 	/**
-	 * 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.
 	 *
 	 * @see HTML serializer documentation {@link https://prismic.io/docs/core-concepts/html-serializer}
 	 */
@@ -265,7 +269,8 @@ export type PrismicPluginOptions =
 
 /**
  * `@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()`.
  */
 export type PrismicPluginClient = {
 	/**
@@ -333,7 +338,8 @@ export type PrismicPluginHelpers = {
 
 	/**
 	 * 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.
 	 */
 	asImageSrc: typeof asImageSrc;
 
@@ -409,7 +415,8 @@ export const enum PrismicClientComposableState {
 // Helpers
 
 /**
- * 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
  */

package/src/useStatefulPrismicClientMethod.ts

@@ -45,7 +45,8 @@ export type ComposableOnlyParameters = {
 /**
  * The return type of a `@prismicio/client` Vue composable.
  *
- * @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
  */
 export type ClientComposableReturnType<TData = unknown> = {
 	/**
@@ -59,7 +60,8 @@ export type ClientComposableReturnType<TData = unknown> = {
 	data: Ref<TData | null>;
 
 	/**
-	 * 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.
 	 */
 	error: Ref<ClientError | Error | null>;
 
@@ -74,7 +76,8 @@ export type ClientComposableReturnType<TData = unknown> = {
  *
  * @param value - The value to check
  *
- * @returns `true` if `value` is a `@prismicio/client` params object, `false` otherwise
+ * @returns `true` if `value` is a `@prismicio/client` params object, `false`
+ *   otherwise
  */
 const isParams = (
 	value: unknown,