@prismicio/vue 4.3.1 → 5.0.0-alpha.1

package/src/index.ts

@@ -1,75 +1,50 @@
-export { createPrismic } from "./createPrismic"
-export { usePrismic } from "./usePrismic"
+import PrismicRichText from "./PrismicRichText/PrismicRichText.vue"
+import SliceZone from "./SliceZone/SliceZone.vue"
+
+import PrismicEmbed from "./PrismicEmbed.vue"
+import PrismicImage from "./PrismicImage.vue"
+import PrismicLink from "./PrismicLink.vue"
+import PrismicText from "./PrismicText.vue"
+
+export type { SliceZoneProps } from "./SliceZone/SliceZone.vue"
+export type { PrismicRichTextProps } from "./PrismicRichText/PrismicRichText.vue"
+
+export type { PrismicEmbedProps } from "./PrismicEmbed.vue"
+export type { PrismicImageProps } from "./PrismicImage.vue"
+export type { PrismicLinkProps } from "./PrismicLink.vue"
+export type { PrismicTextProps } from "./PrismicText.vue"
 
 export {
-	// Composables
-	usePrismicImage,
-	usePrismicLink,
-	usePrismicText,
-	usePrismicRichText,
-	// Components
+	SliceZone,
 	PrismicEmbed,
 	PrismicImage,
 	PrismicLink,
 	PrismicText,
 	PrismicRichText,
-	// Slice Zone
-	getSliceComponentProps,
+}
+
+export { getRichTextComponentProps } from "./PrismicRichText"
+export type {
+	VueRichTextSerializer,
+	RichTextComponentProps,
+} from "./PrismicRichText"
+
+export {
 	TODOSliceComponent,
 	defineSliceZoneComponents,
-	SliceZone,
-} from "./components"
+	getSliceComponentProps,
+} from "./SliceZone"
 export type {
-	// Composables
-	UsePrismicImageOptions,
-	UsePrismicLinkOptions,
-	UsePrismicTextOptions,
-	UsePrismicRichTextOptions,
-	// Components
-	PrismicEmbedProps,
-	PrismicImageProps,
-	PrismicLinkProps,
-	PrismicTextProps,
-	PrismicRichTextProps,
-	// Slice Zone
-	DefineComponentSliceComponentProps,
 	SliceComponentProps,
 	SliceComponentType,
-	SliceLikeRestV2,
-	SliceLikeGraphQL,
 	SliceLike,
+	SliceLikeGraphQL,
+	SliceLikeRestV2,
 	SliceZoneComponents,
-	SliceZoneResolver,
 	SliceZoneLike,
-	SliceZoneProps,
-} from "./components"
+} from "./SliceZone"
 
-export {
-	useAllPrismicDocumentsByIDs,
-	useAllPrismicDocumentsByUIDs,
-	useAllPrismicDocumentsByTag,
-	useAllPrismicDocumentsByEveryTag,
-	useAllPrismicDocumentsBySomeTags,
-	useAllPrismicDocumentsByType,
-	useFirstPrismicDocument,
-	usePrismicDocumentByID,
-	usePrismicDocumentByUID,
-	usePrismicDocuments,
-	usePrismicDocumentsByIDs,
-	usePrismicDocumentsByUIDs,
-	usePrismicDocumentsByTag,
-	usePrismicDocumentsByEveryTag,
-	usePrismicDocumentsBySomeTags,
-	usePrismicDocumentsByType,
-	useSinglePrismicDocument,
-	dangerouslyUseAllPrismicDocuments,
-} from "./composables"
-
-export type { ClientComposableReturnType } from "./useStatefulPrismicClientMethod"
-
-export { PrismicClientComposableState } from "./types"
 export type { PrismicPluginOptions, PrismicPlugin } from "./types"
 
-export { prismicKey } from "./injectionSymbols"
-
-export * from "./globalExtensions"
+export { createPrismic } from "./createPrismic"
+export { usePrismic, prismicKey } from "./usePrismic"

package/src/lib/Wrapper.vue

@@ -0,0 +1,22 @@
+<script lang="ts" setup>
+import type { ComponentOrTagName } from "../types"
+
+defineProps<{
+	/**
+	 * An HTML tag name or a component used to wrap the output. Output is not
+	 * wrapped by default.
+	 *
+	 * @defaultValue `"template"` (no wrapper)
+	 */
+	wrapper?: ComponentOrTagName
+}>()
+</script>
+
+<template>
+	<component v-if="wrapper" :is="wrapper" v-bind="$attrs">
+		<slot />
+	</component>
+	<template v-else>
+		<slot />
+	</template>
+</template>

package/src/lib/devMsg.ts

@@ -0,0 +1,20 @@
+import { version } from "../../package.json"
+
+/**
+ * Returns a `prismic.dev/msg` URL for a given message slug.
+ *
+ * @example
+ *
+ * ```ts
+ * devMsg("missing-param")
+ * // => "https://prismic.dev/msg/svelte/v1.2.3/missing-param.md"
+ * ```
+ *
+ * @param slug - Slug for the message. This corresponds to a Markdown file in
+ *   the Git repository's `/messages` directory.
+ *
+ * @returns The `prismic.dev/msg` URL for the given slug.
+ */
+export const devMsg = (slug: string): string => {
+	return `https://prismic.dev/msg/vue/v${version}/${slug}`
+}

package/src/types.ts

@@ -1,4 +1,5 @@
 import type {
+	AsLinkAttrsConfig,
 	ClientConfig,
 	CreateClient,
 	HTMLRichTextFunctionSerializer,
@@ -18,18 +19,17 @@ import type {
 	isFilled,
 } from "@prismicio/client"
 import type { App, ConcreteComponent, DefineComponent, Raw, Ref } from "vue"
-
 /* eslint-disable @typescript-eslint/no-unused-vars */
 // Imports for @link references:
 import type { RouterLink } from "vue-router"
 
+import type { VueRichTextSerializer } from "./PrismicRichText/types"
+
 import type {
 	SliceComponentProps,
 	SliceComponentType,
 	TODOSliceComponent,
-} from "./components/SliceZone"
-
-import type { usePrismicDocuments } from "./composables"
+} from "./SliceZone"
 
 /* eslint-enable @typescript-eslint/no-unused-vars */
 
@@ -38,16 +38,15 @@ import type { usePrismicDocuments } from "./composables"
  */
 type PrismicPluginComponentsOptions = {
 	/**
-	 * Value of the `rel` attribute to use on links rendered with
-	 * `target="_blank"`
+	 * The `rel` attribute to apply on links. This prop can be provided a function
+	 * to use the link's metadata to determine the `rel` value.
 	 *
-	 * @defaultValue `"noopener noreferrer"`
+	 * @defaultValue `"noreferrer"` for external links.
 	 */
-	linkBlankTargetRelAttribute?: string
+	linkRel?: AsLinkAttrsConfig["rel"]
 
 	/**
-	 * An HTML tag name, a component, or a functional component used to render
-	 * internal links.
+	 * An HTML tag name or a component used to render internal links.
 	 *
 	 * @remarks
 	 * HTML tag names will be rendered using the anchor tag interface (`href`,
@@ -58,11 +57,10 @@ type PrismicPluginComponentsOptions = {
 	 *
 	 * @defaultValue {@link RouterLink}
 	 */
-	linkInternalComponent?: string | ConcreteComponent | Raw<DefineComponent>
+	linkInternalComponent?: ComponentOrTagName
 
 	/**
-	 * An HTML tag name, a component, or a functional component used to render
-	 * external links.
+	 * An HTML tag name or a component used to render external links.
 	 *
 	 * @remarks
 	 * HTML tag names will be rendered using the anchor tag interface (`href`,
@@ -73,20 +71,7 @@ type PrismicPluginComponentsOptions = {
 	 *
 	 * @defaultValue `"a"`
 	 */
-	linkExternalComponent?: string | ConcreteComponent | Raw<DefineComponent>
-
-	/**
-	 * An HTML tag name, a component, or a functional component used to render
-	 * images.
-	 *
-	 * @remarks
-	 * HTML tag names and components will be rendered using the `img` tag
-	 * interface (`src` and `alt` attribute). Components will also receive an
-	 * additional `copyright` props.
-	 *
-	 * @defaultValue `"img"`
-	 */
-	imageComponent?: string | ConcreteComponent | Raw<DefineComponent>
+	linkExternalComponent?: ComponentOrTagName
 
 	/**
 	 * Default widths to use when rendering an image with `widths="defaults"`
@@ -108,6 +93,14 @@ type PrismicPluginComponentsOptions = {
 	 */
 	imagePixelDensitySrcSetDefaults?: number[]
 
+	/**
+	 * An optional map of Rich Text block types to Vue Components. It is used to
+	 * render Rich Text or title fields.
+	 *
+	 * @see Templating Rich Text and title fields from Prismic {@link https://prismic.io/docs/rich-text}
+	 */
+	richTextComponents?: VueRichTextSerializer
+
 	/**
 	 * A component or a functional component rendered if a component mapping from
 	 * the `components` prop cannot be found.
@@ -137,23 +130,18 @@ type PrismicPluginOptionsBase = {
 	 * An optional HTML serializer to customize the way rich text fields are
 	 * rendered.
 	 *
+	 * @remarks
+	 * To provide global components for the `<PrismicRichText />` component, use
+	 * the `components.richTextComponents` option instead.
+	 *
+	 * @deprecated Use `components.richTextComponents` instead.
+	 *
 	 * @see HTML serializer documentation {@link https://prismic.io/docs/core-concepts/html-serializer}
 	 */
 	richTextSerializer?:
 		| HTMLRichTextFunctionSerializer
 		| HTMLRichTextMapSerializer
 
-	/**
-	 * An optional HTML serializer to customize the way rich text fields are
-	 * rendered.
-	 *
-	 * @deprecated Use `richTextSerializer` instead.
-	 *
-	 * @see HTML serializer documentation {@link https://prismic.io/docs/core-concepts/html-serializer}
-	 */
-	// TODO: Remove in v5
-	htmlSerializer?: HTMLRichTextFunctionSerializer | HTMLRichTextMapSerializer
-
 	/**
 	 * Whether or not to inject components globally.
 	 *
@@ -368,21 +356,21 @@ export type PrismicPluginHelpers = {
 	asDate: typeof asDate
 
 	/**
-	 * Returns the URL of an Image field with optional image transformations (via
+	 * Returns the URL of an image field with optional image transformations (via
 	 * Imgix URL parameters). This is `@prismicio/client` {@link asImageSrc}
 	 * function.
 	 */
 	asImageSrc: typeof asImageSrc
 
 	/**
-	 * Creates a width-based `srcset` from an Image field with optional image
+	 * Creates a width-based `srcset` from an image field with optional image
 	 * transformations (via Imgix URL parameters). This is `@prismicio/client`
 	 * {@link asImageWidthSrcSet} function.
 	 */
 	asImageWidthSrcSet: typeof asImageWidthSrcSet
 
 	/**
-	 * Creates a pixel-density-based `srcset` from an Image field with optional
+	 * Creates a pixel-density-based `srcset` from an image field with optional
 	 * image transformations (via Imgix URL parameters). This is
 	 * `@prismicio/client` {@link asImagePixelDensitySrcSet} function.
 	 */
@@ -424,31 +412,6 @@ export type PrismicPlugin = {
 } & PrismicPluginClient &
 	PrismicPluginHelpers
 
-/**
- * States of a `@prismicio/client` composable.
- */
-export const enum PrismicClientComposableState {
-	/**
-	 * The composable has not started fetching.
-	 */
-	Idle = "idle",
-
-	/**
-	 * The composable is fetching data.
-	 */
-	Pending = "pending",
-
-	/**
-	 * The composable sucessfully fetched data.
-	 */
-	Success = "success",
-
-	/**
-	 * The composable failed to fetch data.
-	 */
-	Error = "error",
-}
-
 // Helpers
 
 /**
@@ -469,3 +432,13 @@ export type VueUseOptions<T> = {
 export type VueUseParameters<T> = {
 	[K in keyof T]: T extends number ? Ref<T[K]> | T[K] : T[K]
 }
+
+/**
+ * A component or a tag name to be used as props.
+ *
+ * @internal
+ */
+export type ComponentOrTagName =
+	| string
+	| ConcreteComponent
+	| Raw<DefineComponent>

package/src/usePrismic.ts

@@ -1,8 +1,15 @@
+import type { InjectionKey } from "vue"
 import { inject } from "vue"
 
 import type { PrismicPlugin } from "./types"
 
-import { prismicKey } from "./injectionSymbols"
+/**
+ * `@prismicio/vue` plugin interface interface location used for
+ * {@link usePrismic}.
+ *
+ * @internal
+ */
+export const prismicKey = Symbol("prismic") as InjectionKey<PrismicPlugin>
 
 /**
  * Accesses `@prismicio/vue` plugin interface.

package/dist/components/PrismicEmbed.cjs

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const vue = require("vue");
-const simplyResolveComponent = require("../lib/simplyResolveComponent.cjs");
-const defaultWrapper = "div";
-const PrismicEmbedImpl = /* @__PURE__ */ vue.defineComponent({
-  name: "PrismicEmbed",
-  props: {
-    field: {
-      type: Object,
-      required: true
-    },
-    wrapper: {
-      type: [String, Object, Function],
-      default: void 0,
-      required: false
-    }
-  },
-  setup(props) {
-    if (!props.field) {
-      return () => null;
-    }
-    return () => {
-      return vue.h(simplyResolveComponent.simplyResolveComponent(props.wrapper || defaultWrapper), {
-        "data-oembed": props.field.embed_url,
-        "data-oembed-type": props.field.type,
-        "data-oembed-provider": props.field.provider_name,
-        innerHTML: props.field.html || null
-      });
-    };
-  }
-});
-const PrismicEmbed = PrismicEmbedImpl;
-exports.PrismicEmbed = PrismicEmbed;
-exports.PrismicEmbedImpl = PrismicEmbedImpl;
-//# sourceMappingURL=PrismicEmbed.cjs.map

package/dist/components/PrismicEmbed.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"PrismicEmbed.cjs","sources":["../../../src/components/PrismicEmbed.ts"],"sourcesContent":["import type { EmbedField } from \"@prismicio/client\"\nimport type {\n\tAllowedComponentProps,\n\tComponentCustomProps,\n\tConcreteComponent,\n\tDefineComponent,\n\tPropType,\n\tRaw,\n\tVNodeProps,\n} from \"vue\"\nimport { defineComponent, h } from \"vue\"\n\nimport { simplyResolveComponent } from \"../lib/simplyResolveComponent\"\n\n/**\n * The default component rendered to wrap the embed.\n */\nconst defaultWrapper = \"div\"\n\n/**\n * Props for `<PrismicEmbed />`.\n */\nexport type PrismicEmbedProps = {\n\t/**\n\t * The Prismic embed field to render.\n\t */\n\tfield: EmbedField\n\n\t/**\n\t * An HTML tag name, a component, or a functional component used to wrap the\n\t * output.\n\t *\n\t * @defaultValue `\"div\"`\n\t */\n\twrapper?: string | ConcreteComponent | Raw<DefineComponent>\n}\n\n/**\n * `<PrismicEmbed />` implementation.\n *\n * @internal\n */\nexport const PrismicEmbedImpl = /*#__PURE__*/ defineComponent({\n\tname: \"PrismicEmbed\",\n\tprops: {\n\t\tfield: {\n\t\t\ttype: Object as PropType<EmbedField>,\n\t\t\trequired: true,\n\t\t},\n\t\twrapper: {\n\t\t\ttype: [String, Object, Function] as PropType<\n\t\t\t\tstring | ConcreteComponent | Raw<DefineComponent>\n\t\t\t>,\n\t\t\tdefault: undefined,\n\t\t\trequired: false,\n\t\t},\n\t},\n\tsetup(props) {\n\t\t// Prevent fatal if user didn't check for field, throws `Invalid prop` warn\n\t\tif (!props.field) {\n\t\t\treturn () => null\n\t\t}\n\n\t\treturn () => {\n\t\t\treturn h(simplyResolveComponent(props.wrapper || defaultWrapper), {\n\t\t\t\t\"data-oembed\": props.field.embed_url,\n\t\t\t\t\"data-oembed-type\": props.field.type,\n\t\t\t\t\"data-oembed-provider\": props.field.provider_name,\n\t\t\t\tinnerHTML: props.field.html || null,\n\t\t\t})\n\t\t}\n\t},\n})\n\n// export the public type for h/tsx inference\n// also to avoid inline import() in generated d.ts files\n/**\n * Component to render a Prismic embed field.\n *\n * @see Component props {@link PrismicEmbedProps}\n * @see Templating embed fields {@link https://prismic.io/docs/technologies/vue-template-content#embeds}\n */\nexport const PrismicEmbed = PrismicEmbedImpl as unknown as {\n\tnew (): {\n\t\t$props: AllowedComponentProps &\n\t\t\tComponentCustomProps &\n\t\t\tVNodeProps &\n\t\t\tPrismicEmbedProps\n\t}\n}\n"],"names":["defineComponent","h","simplyResolveComponent"],"mappings":";;;;AAiBA,MAAM,iBAAiB;AAyBhB,MAAM,mBAAiDA,oBAAAA,gBAAA;AAAA,EAC7D,MAAM;AAAA,EACN,OAAO;AAAA,IACN,OAAO;AAAA,MACN,MAAM;AAAA,MACN,UAAU;AAAA,IACV;AAAA,IACD,SAAS;AAAA,MACR,MAAM,CAAC,QAAQ,QAAQ,QAAQ;AAAA,MAG/B,SAAS;AAAA,MACT,UAAU;AAAA,IAAA;AAAA,EAEX;AAAA,EACD,MAAM,OAAK;AAEN,QAAA,CAAC,MAAM,OAAO;AACjB,aAAO,MAAM;AAAA,IAAA;AAGd,WAAO,MAAK;AACX,aAAOC,IAAE,EAAAC,uBAAA,uBAAuB,MAAM,WAAW,cAAc,GAAG;AAAA,QACjE,eAAe,MAAM,MAAM;AAAA,QAC3B,oBAAoB,MAAM,MAAM;AAAA,QAChC,wBAAwB,MAAM,MAAM;AAAA,QACpC,WAAW,MAAM,MAAM,QAAQ;AAAA,MAAA,CAC/B;AAAA,IACF;AAAA,EAAA;AAED,CAAA;AAUM,MAAM,eAAe;;;"}

package/dist/components/PrismicEmbed.d.ts

@@ -1,59 +0,0 @@
-import type { EmbedField } from "@prismicio/client";
-import type { AllowedComponentProps, ComponentCustomProps, ConcreteComponent, DefineComponent, PropType, Raw, VNodeProps } from "vue";
-/**
- * Props for `<PrismicEmbed />`.
- */
-export type PrismicEmbedProps = {
-    /**
-     * The Prismic embed field to render.
-     */
-    field: EmbedField;
-    /**
-     * An HTML tag name, a component, or a functional component used to wrap the
-     * output.
-     *
-     * @defaultValue `"div"`
-     */
-    wrapper?: string | ConcreteComponent | Raw<DefineComponent>;
-};
-/**
- * `<PrismicEmbed />` implementation.
- *
- * @internal
- */
-export declare const PrismicEmbedImpl: DefineComponent<import("vue").ExtractPropTypes<{
-    field: {
-        type: PropType<EmbedField>;
-        required: true;
-    };
-    wrapper: {
-        type: PropType<string | ConcreteComponent | Raw<DefineComponent>>;
-        default: undefined;
-        required: false;
-    };
-}>, (() => null) | (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
-    [key: string]: any;
-}>), {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    field: {
-        type: PropType<EmbedField>;
-        required: true;
-    };
-    wrapper: {
-        type: PropType<string | ConcreteComponent | Raw<DefineComponent>>;
-        default: undefined;
-        required: false;
-    };
-}>> & Readonly<{}>, {
-    wrapper: string | ConcreteComponent | Raw<DefineComponent>;
-}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
-/**
- * Component to render a Prismic embed field.
- *
- * @see Component props {@link PrismicEmbedProps}
- * @see Templating embed fields {@link https://prismic.io/docs/technologies/vue-template-content#embeds}
- */
-export declare const PrismicEmbed: {
-    new (): {
-        $props: AllowedComponentProps & ComponentCustomProps & VNodeProps & PrismicEmbedProps;
-    };
-};

package/dist/components/PrismicEmbed.js

@@ -1,36 +0,0 @@
-import { defineComponent, h } from "vue";
-import { simplyResolveComponent } from "../lib/simplyResolveComponent.js";
-const defaultWrapper = "div";
-const PrismicEmbedImpl = /* @__PURE__ */ defineComponent({
-  name: "PrismicEmbed",
-  props: {
-    field: {
-      type: Object,
-      required: true
-    },
-    wrapper: {
-      type: [String, Object, Function],
-      default: void 0,
-      required: false
-    }
-  },
-  setup(props) {
-    if (!props.field) {
-      return () => null;
-    }
-    return () => {
-      return h(simplyResolveComponent(props.wrapper || defaultWrapper), {
-        "data-oembed": props.field.embed_url,
-        "data-oembed-type": props.field.type,
-        "data-oembed-provider": props.field.provider_name,
-        innerHTML: props.field.html || null
-      });
-    };
-  }
-});
-const PrismicEmbed = PrismicEmbedImpl;
-export {
-  PrismicEmbed,
-  PrismicEmbedImpl
-};
-//# sourceMappingURL=PrismicEmbed.js.map

package/dist/components/PrismicEmbed.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PrismicEmbed.js","sources":["../../../src/components/PrismicEmbed.ts"],"sourcesContent":["import type { EmbedField } from \"@prismicio/client\"\nimport type {\n\tAllowedComponentProps,\n\tComponentCustomProps,\n\tConcreteComponent,\n\tDefineComponent,\n\tPropType,\n\tRaw,\n\tVNodeProps,\n} from \"vue\"\nimport { defineComponent, h } from \"vue\"\n\nimport { simplyResolveComponent } from \"../lib/simplyResolveComponent\"\n\n/**\n * The default component rendered to wrap the embed.\n */\nconst defaultWrapper = \"div\"\n\n/**\n * Props for `<PrismicEmbed />`.\n */\nexport type PrismicEmbedProps = {\n\t/**\n\t * The Prismic embed field to render.\n\t */\n\tfield: EmbedField\n\n\t/**\n\t * An HTML tag name, a component, or a functional component used to wrap the\n\t * output.\n\t *\n\t * @defaultValue `\"div\"`\n\t */\n\twrapper?: string | ConcreteComponent | Raw<DefineComponent>\n}\n\n/**\n * `<PrismicEmbed />` implementation.\n *\n * @internal\n */\nexport const PrismicEmbedImpl = /*#__PURE__*/ defineComponent({\n\tname: \"PrismicEmbed\",\n\tprops: {\n\t\tfield: {\n\t\t\ttype: Object as PropType<EmbedField>,\n\t\t\trequired: true,\n\t\t},\n\t\twrapper: {\n\t\t\ttype: [String, Object, Function] as PropType<\n\t\t\t\tstring | ConcreteComponent | Raw<DefineComponent>\n\t\t\t>,\n\t\t\tdefault: undefined,\n\t\t\trequired: false,\n\t\t},\n\t},\n\tsetup(props) {\n\t\t// Prevent fatal if user didn't check for field, throws `Invalid prop` warn\n\t\tif (!props.field) {\n\t\t\treturn () => null\n\t\t}\n\n\t\treturn () => {\n\t\t\treturn h(simplyResolveComponent(props.wrapper || defaultWrapper), {\n\t\t\t\t\"data-oembed\": props.field.embed_url,\n\t\t\t\t\"data-oembed-type\": props.field.type,\n\t\t\t\t\"data-oembed-provider\": props.field.provider_name,\n\t\t\t\tinnerHTML: props.field.html || null,\n\t\t\t})\n\t\t}\n\t},\n})\n\n// export the public type for h/tsx inference\n// also to avoid inline import() in generated d.ts files\n/**\n * Component to render a Prismic embed field.\n *\n * @see Component props {@link PrismicEmbedProps}\n * @see Templating embed fields {@link https://prismic.io/docs/technologies/vue-template-content#embeds}\n */\nexport const PrismicEmbed = PrismicEmbedImpl as unknown as {\n\tnew (): {\n\t\t$props: AllowedComponentProps &\n\t\t\tComponentCustomProps &\n\t\t\tVNodeProps &\n\t\t\tPrismicEmbedProps\n\t}\n}\n"],"names":[],"mappings":";;AAiBA,MAAM,iBAAiB;AAyBhB,MAAM,mBAAiD,gCAAA;AAAA,EAC7D,MAAM;AAAA,EACN,OAAO;AAAA,IACN,OAAO;AAAA,MACN,MAAM;AAAA,MACN,UAAU;AAAA,IACV;AAAA,IACD,SAAS;AAAA,MACR,MAAM,CAAC,QAAQ,QAAQ,QAAQ;AAAA,MAG/B,SAAS;AAAA,MACT,UAAU;AAAA,IAAA;AAAA,EAEX;AAAA,EACD,MAAM,OAAK;AAEN,QAAA,CAAC,MAAM,OAAO;AACjB,aAAO,MAAM;AAAA,IAAA;AAGd,WAAO,MAAK;AACX,aAAO,EAAE,uBAAuB,MAAM,WAAW,cAAc,GAAG;AAAA,QACjE,eAAe,MAAM,MAAM;AAAA,QAC3B,oBAAoB,MAAM,MAAM;AAAA,QAChC,wBAAwB,MAAM,MAAM;AAAA,QACpC,WAAW,MAAM,MAAM,QAAQ;AAAA,MAAA,CAC/B;AAAA,IACF;AAAA,EAAA;AAED,CAAA;AAUM,MAAM,eAAe;"}

package/dist/components/PrismicImage.cjs

@@ -1,122 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const client = require("@prismicio/client");
-const vue = require("vue");
-const __PRODUCTION__ = require("../lib/__PRODUCTION__.cjs");
-const simplyResolveComponent = require("../lib/simplyResolveComponent.cjs");
-const usePrismic = require("../usePrismic.cjs");
-const defaultImageComponent = "img";
-const usePrismicImage = (props) => {
-  const { options } = usePrismic.usePrismic();
-  const asImage = vue.computed(() => {
-    var _a, _b;
-    const field = vue.unref(props.field);
-    if (!client.isFilled.image(field)) {
-      return {
-        src: null,
-        srcset: null
-      };
-    }
-    const imgixParams = vue.unref(props.imgixParams);
-    const widths = vue.unref(props.widths);
-    const pixelDensities = vue.unref(props.pixelDensities);
-    if (widths) {
-      if (!__PRODUCTION__.__PRODUCTION__ && pixelDensities) {
-        console.warn("[PrismicImage] Only one of `widths` or `pixelDensities` props can be provided. You can resolve this warning by removing either the `widths` or `pixelDensities` prop. `widths` will be used in this case.", props);
-      }
-      return client.asImageWidthSrcSet(field, {
-        ...imgixParams,
-        widths: widths === "defaults" ? (_a = options.components) == null ? void 0 : _a.imageWidthSrcSetDefaults : widths
-      });
-    } else if (pixelDensities) {
-      return client.asImagePixelDensitySrcSet(field, {
-        ...imgixParams,
-        pixelDensities: pixelDensities === "defaults" ? (_b = options.components) == null ? void 0 : _b.imagePixelDensitySrcSetDefaults : pixelDensities
-      });
-    } else {
-      return {
-        src: client.asImageSrc(field, imgixParams),
-        srcset: null
-      };
-    }
-  });
-  const src = vue.computed(() => {
-    return asImage.value.src;
-  });
-  const srcset = vue.computed(() => {
-    return asImage.value.srcset;
-  });
-  const alt = vue.computed(() => {
-    return vue.unref(props.field).alt || "";
-  });
-  const copyright = vue.computed(() => {
-    return vue.unref(props.field).copyright || null;
-  });
-  return {
-    src,
-    srcset,
-    alt,
-    copyright
-  };
-};
-const PrismicImageImpl = /* @__PURE__ */ vue.defineComponent({
-  name: "PrismicImage",
-  props: {
-    field: {
-      type: Object,
-      required: true
-    },
-    imageComponent: {
-      type: [String, Object],
-      default: void 0,
-      required: false
-    },
-    imgixParams: {
-      type: Object,
-      default: void 0,
-      required: false
-    },
-    widths: {
-      type: [String, Object],
-      default: void 0,
-      required: false
-    },
-    pixelDensities: {
-      type: [String, Object],
-      default: void 0,
-      required: false
-    }
-  },
-  setup(props) {
-    if (!props.field) {
-      return () => null;
-    }
-    const { options } = usePrismic.usePrismic();
-    const type = vue.computed(() => {
-      var _a;
-      return props.imageComponent || ((_a = options.components) == null ? void 0 : _a.imageComponent) || defaultImageComponent;
-    });
-    const { src, srcset, alt, copyright } = usePrismicImage(props);
-    return () => {
-      const attributes = {
-        src: src.value,
-        srcset: srcset.value,
-        alt: alt.value
-      };
-      switch (type.value) {
-        case "img":
-          return vue.h("img", attributes);
-        default:
-          return vue.h(simplyResolveComponent.simplyResolveComponent(type.value), {
-            ...attributes,
-            copyright: copyright.value
-          });
-      }
-    };
-  }
-});
-const PrismicImage = PrismicImageImpl;
-exports.PrismicImage = PrismicImage;
-exports.PrismicImageImpl = PrismicImageImpl;
-exports.usePrismicImage = usePrismicImage;
-//# sourceMappingURL=PrismicImage.cjs.map

package/dist/components/PrismicImage.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"PrismicImage.cjs","sources":["../../../src/components/PrismicImage.ts"],"sourcesContent":["import type { ImageField } from \"@prismicio/client\"\nimport {\n\tasImagePixelDensitySrcSet,\n\tasImageSrc,\n\tasImageWidthSrcSet,\n\tisFilled,\n} from \"@prismicio/client\"\nimport type {\n\tAllowedComponentProps,\n\tComponentCustomProps,\n\tComputedRef,\n\tConcreteComponent,\n\tDefineComponent,\n\tPropType,\n\tRaw,\n\tVNodeProps,\n} from \"vue\"\nimport { computed, defineComponent, h, unref } from \"vue\"\n\nimport { __PRODUCTION__ } from \"../lib/__PRODUCTION__\"\nimport { simplyResolveComponent } from \"../lib/simplyResolveComponent\"\n\nimport type { VueUseOptions } from \"../types\"\n\nimport { usePrismic } from \"../usePrismic\"\n\n/**\n * The default component rendered for images.\n */\nconst defaultImageComponent = \"img\"\n\n/**\n * Props for `<PrismicImage />`.\n */\nexport type PrismicImageProps = {\n\t/**\n\t * The Prismic image field to render.\n\t */\n\tfield: ImageField | ImageField<string>\n\n\t/**\n\t * An HTML tag name, a component, or a functional component used to render\n\t * images.\n\t *\n\t * @remarks\n\t * HTML tag names and components will be rendered using the `img` tag\n\t * interface (`src`, `srcset`, and `alt` attribute). Components will also\n\t * receive an additional `copyright` props.\n\t *\n\t * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `\"img\"` otherwise.\n\t */\n\timageComponent?: string | ConcreteComponent | Raw<DefineComponent>\n\n\t/**\n\t * An object of Imgix URL API parameters.\n\t *\n\t * @see Imgix URL parameters reference: https://docs.imgix.com/apis/rendering\n\t */\n\timgixParams?: Parameters<typeof asImageSrc>[1]\n\n\t/**\n\t * Adds an additional `srcset` attribute to the image following given widths.\n\t *\n\t * @remarks\n\t * A special value of `\"thumbnails\"` is accepted to automatically use image\n\t * widths coming from the API.\n\t * @remarks\n\t * A special value of `\"defaults\"` is accepted to automatically use image\n\t * widths coming from the plugin configuration.\n\t * @remarks\n\t * This prop is not compatible with the `pixelDensities` prop. When both are\n\t * used the `pixelDensities` prop will be ignored.\n\t */\n\twidths?:\n\t\t| NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>[\"widths\"]\n\t\t| \"thumbnails\"\n\t\t| \"defaults\"\n\n\t/**\n\t * Adds an additional `srcset` attribute to the image following giving pixel\n\t * densities.\n\t *\n\t * @remarks\n\t * A special value of `\"defaults\"` is accepted to automatically use image\n\t * pixel densities coming from the plugin configuration.\n\t * @remarks\n\t * This prop is not compatible with the `widths` prop. When both are used, the\n\t * `pixelDensities` prop will be ignored.\n\t */\n\tpixelDensities?:\n\t\t| NonNullable<\n\t\t\t\tParameters<typeof asImagePixelDensitySrcSet>[1]\n\t\t  >[\"pixelDensities\"]\n\t\t| \"defaults\"\n}\n\n/**\n * Options for {@link usePrismicImage}.\n */\nexport type UsePrismicImageOptions = VueUseOptions<\n\tOmit<PrismicImageProps, \"imageComponent\">\n>\n\n/**\n * Return type of {@link usePrismicImage}.\n */\nexport type UsePrismicImageReturnType = {\n\t/**\n\t * Resolved image `src` value.\n\t */\n\tsrc: ComputedRef<string | null>\n\n\t/**\n\t * Resolved image `srcset` value.\n\t */\n\tsrcset: ComputedRef<string | null>\n\n\t/**\n\t * Resolved image `alt` value.\n\t */\n\talt: ComputedRef<string>\n\n\t/**\n\t * Resolved image `copyright` value.\n\t */\n\tcopyright: ComputedRef<string | null>\n}\n\n/**\n * A low level composable that returns a resolved information about a Prismic\n * image field.\n *\n * @param props - {@link UsePrismicImageOptions}\n *\n * @returns - Resolved image information {@link UsePrismicImageReturnType}\n */\nexport const usePrismicImage = (\n\tprops: UsePrismicImageOptions,\n): UsePrismicImageReturnType => {\n\tconst { options } = usePrismic()\n\n\tconst asImage = computed(() => {\n\t\tconst field = unref(props.field)\n\n\t\tif (!isFilled.image(field)) {\n\t\t\treturn {\n\t\t\t\tsrc: null,\n\t\t\t\tsrcset: null,\n\t\t\t}\n\t\t}\n\n\t\tconst imgixParams = unref(props.imgixParams)\n\t\tconst widths = unref(props.widths)\n\t\tconst pixelDensities = unref(props.pixelDensities)\n\n\t\tif (widths) {\n\t\t\tif (!__PRODUCTION__ && pixelDensities) {\n\t\t\t\tconsole.warn(\n\t\t\t\t\t\"[PrismicImage] Only one of `widths` or `pixelDensities` props can be provided. You can resolve this warning by removing either the `widths` or `pixelDensities` prop. `widths` will be used in this case.\",\n\t\t\t\t\tprops,\n\t\t\t\t)\n\t\t\t}\n\n\t\t\treturn asImageWidthSrcSet(field, {\n\t\t\t\t...imgixParams,\n\t\t\t\twidths:\n\t\t\t\t\twidths === \"defaults\"\n\t\t\t\t\t\t? options.components?.imageWidthSrcSetDefaults\n\t\t\t\t\t\t: widths,\n\t\t\t})\n\t\t} else if (pixelDensities) {\n\t\t\treturn asImagePixelDensitySrcSet(field, {\n\t\t\t\t...imgixParams,\n\t\t\t\tpixelDensities:\n\t\t\t\t\tpixelDensities === \"defaults\"\n\t\t\t\t\t\t? options.components?.imagePixelDensitySrcSetDefaults\n\t\t\t\t\t\t: pixelDensities,\n\t\t\t})\n\t\t} else {\n\t\t\treturn {\n\t\t\t\tsrc: asImageSrc(field, imgixParams),\n\t\t\t\tsrcset: null,\n\t\t\t}\n\t\t}\n\t})\n\n\tconst src = computed(() => {\n\t\treturn asImage.value.src\n\t})\n\tconst srcset = computed(() => {\n\t\treturn asImage.value.srcset\n\t})\n\tconst alt = computed(() => {\n\t\treturn unref(props.field).alt || \"\"\n\t})\n\tconst copyright = computed(() => {\n\t\treturn unref(props.field).copyright || null\n\t})\n\n\treturn {\n\t\tsrc,\n\t\tsrcset,\n\t\talt,\n\t\tcopyright,\n\t}\n}\n\n/**\n * `<PrismicImage />` implementation.\n *\n * @internal\n */\nexport const PrismicImageImpl = /*#__PURE__*/ defineComponent({\n\tname: \"PrismicImage\",\n\tprops: {\n\t\tfield: {\n\t\t\ttype: Object as PropType<ImageField | ImageField<string>>,\n\t\t\trequired: true,\n\t\t},\n\t\timageComponent: {\n\t\t\ttype: [String, Object] as PropType<\n\t\t\t\tstring | ConcreteComponent | Raw<DefineComponent>\n\t\t\t>,\n\t\t\tdefault: undefined,\n\t\t\trequired: false,\n\t\t},\n\t\timgixParams: {\n\t\t\ttype: Object as PropType<Parameters<typeof asImageSrc>[1]>,\n\t\t\tdefault: undefined,\n\t\t\trequired: false,\n\t\t},\n\t\twidths: {\n\t\t\ttype: [String, Object] as PropType<\n\t\t\t\t| NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>[\"widths\"]\n\t\t\t\t| \"thumbnails\"\n\t\t\t\t| \"defaults\"\n\t\t\t>,\n\t\t\tdefault: undefined,\n\t\t\trequired: false,\n\t\t},\n\t\tpixelDensities: {\n\t\t\ttype: [String, Object] as PropType<\n\t\t\t\t| NonNullable<\n\t\t\t\t\t\tParameters<typeof asImagePixelDensitySrcSet>[1]\n\t\t\t\t  >[\"pixelDensities\"]\n\t\t\t\t| \"defaults\"\n\t\t\t>,\n\t\t\tdefault: undefined,\n\t\t\trequired: false,\n\t\t},\n\t},\n\tsetup(props) {\n\t\t// Prevent fatal if user didn't check for field, throws `Invalid prop` warn\n\t\tif (!props.field) {\n\t\t\treturn () => null\n\t\t}\n\n\t\tconst { options } = usePrismic()\n\n\t\tconst type = computed(() => {\n\t\t\treturn (\n\t\t\t\tprops.imageComponent ||\n\t\t\t\toptions.components?.imageComponent ||\n\t\t\t\tdefaultImageComponent\n\t\t\t)\n\t\t})\n\n\t\tconst { src, srcset, alt, copyright } = usePrismicImage(props)\n\n\t\treturn () => {\n\t\t\tconst attributes = {\n\t\t\t\tsrc: src.value,\n\t\t\t\tsrcset: srcset.value,\n\t\t\t\talt: alt.value,\n\t\t\t}\n\n\t\t\tswitch (type.value) {\n\t\t\t\tcase \"img\":\n\t\t\t\t\t// Fitting img tag interface\n\t\t\t\t\treturn h(\"img\", attributes)\n\n\t\t\t\tdefault:\n\t\t\t\t\treturn h(simplyResolveComponent(type.value), {\n\t\t\t\t\t\t...attributes,\n\t\t\t\t\t\tcopyright: copyright.value,\n\t\t\t\t\t})\n\t\t\t}\n\t\t}\n\t},\n})\n\n// export the public type for h/tsx inference\n// also to avoid inline import() in generated d.ts files\n/**\n * Component to render a Prismic image field.\n *\n * @see Component props {@link PrismicImageProps}\n * @see Templating image fields {@link https://prismic.io/docs/technologies/vue-template-content#images}\n */\nexport const PrismicImage = PrismicImageImpl as unknown as {\n\tnew (): {\n\t\t$props: AllowedComponentProps &\n\t\t\tComponentCustomProps &\n\t\t\tVNodeProps &\n\t\t\tPrismicImageProps\n\t}\n}\n"],"names":["usePrismic","computed","unref","isFilled","__PRODUCTION__","asImageWidthSrcSet","asImagePixelDensitySrcSet","asImageSrc","defineComponent","h","simplyResolveComponent"],"mappings":";;;;;;;AA6BA,MAAM,wBAAwB;AA2GjB,MAAA,kBAAkB,CAC9B,UAC8B;AACxB,QAAA,EAAE,QAAO,IAAKA;AAEd,QAAA,UAAUC,IAAAA,SAAS,MAAK;;AACvB,UAAA,QAAQC,IAAAA,MAAM,MAAM,KAAK;AAE/B,QAAI,CAACC,OAAA,SAAS,MAAM,KAAK,GAAG;AACpB,aAAA;AAAA,QACN,KAAK;AAAA,QACL,QAAQ;AAAA;;AAIJ,UAAA,cAAcD,IAAAA,MAAM,MAAM,WAAW;AACrC,UAAA,SAASA,IAAAA,MAAM,MAAM,MAAM;AAC3B,UAAA,iBAAiBA,IAAAA,MAAM,MAAM,cAAc;AAEjD,QAAI,QAAQ;AACP,UAAA,CAACE,iCAAkB,gBAAgB;AAC9B,gBAAA,KACP,6MACA,KAAK;AAAA,MAAA;AAIP,aAAOC,OAAAA,mBAAmB,OAAO;AAAA,QAChC,GAAG;AAAA,QACH,QACC,WAAW,cACR,aAAQ,eAAR,mBAAoB,2BACpB;AAAA,MAAA,CACJ;AAAA,eACS,gBAAgB;AAC1B,aAAOC,OAAAA,0BAA0B,OAAO;AAAA,QACvC,GAAG;AAAA,QACH,gBACC,mBAAmB,cAChB,aAAQ,eAAR,mBAAoB,kCACpB;AAAA,MAAA,CACJ;AAAA,IAAA,OACK;AACC,aAAA;AAAA,QACN,KAAKC,OAAAA,WAAW,OAAO,WAAW;AAAA,QAClC,QAAQ;AAAA;;EAEV,CACA;AAEK,QAAA,MAAMN,IAAAA,SAAS,MAAK;AACzB,WAAO,QAAQ,MAAM;AAAA,EAAA,CACrB;AACK,QAAA,SAASA,IAAAA,SAAS,MAAK;AAC5B,WAAO,QAAQ,MAAM;AAAA,EAAA,CACrB;AACK,QAAA,MAAMA,IAAAA,SAAS,MAAK;AACzB,WAAOC,IAAM,MAAA,MAAM,KAAK,EAAE,OAAO;AAAA,EAAA,CACjC;AACK,QAAA,YAAYD,IAAAA,SAAS,MAAK;AAC/B,WAAOC,IAAM,MAAA,MAAM,KAAK,EAAE,aAAa;AAAA,EAAA,CACvC;AAEM,SAAA;AAAA,IACN;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA;AAEF;AAOO,MAAM,mBAAiDM,oBAAAA,gBAAA;AAAA,EAC7D,MAAM;AAAA,EACN,OAAO;AAAA,IACN,OAAO;AAAA,MACN,MAAM;AAAA,MACN,UAAU;AAAA,IACV;AAAA,IACD,gBAAgB;AAAA,MACf,MAAM,CAAC,QAAQ,MAAM;AAAA,MAGrB,SAAS;AAAA,MACT,UAAU;AAAA,IACV;AAAA,IACD,aAAa;AAAA,MACZ,MAAM;AAAA,MACN,SAAS;AAAA,MACT,UAAU;AAAA,IACV;AAAA,IACD,QAAQ;AAAA,MACP,MAAM,CAAC,QAAQ,MAAM;AAAA,MAKrB,SAAS;AAAA,MACT,UAAU;AAAA,IACV;AAAA,IACD,gBAAgB;AAAA,MACf,MAAM,CAAC,QAAQ,MAAM;AAAA,MAMrB,SAAS;AAAA,MACT,UAAU;AAAA,IAAA;AAAA,EAEX;AAAA,EACD,MAAM,OAAK;AAEN,QAAA,CAAC,MAAM,OAAO;AACjB,aAAO,MAAM;AAAA,IAAA;AAGR,UAAA,EAAE,QAAO,IAAKR;AAEd,UAAA,OAAOC,IAAAA,SAAS,MAAK;;AAC1B,aACC,MAAM,oBACN,aAAQ,eAAR,mBAAoB,mBACpB;AAAA,IAAA,CAED;AAED,UAAM,EAAE,KAAK,QAAQ,KAAK,UAAS,IAAK,gBAAgB,KAAK;AAE7D,WAAO,MAAK;AACX,YAAM,aAAa;AAAA,QAClB,KAAK,IAAI;AAAA,QACT,QAAQ,OAAO;AAAA,QACf,KAAK,IAAI;AAAA;AAGV,cAAQ,KAAK,OAAO;AAAA,QACnB,KAAK;AAEG,iBAAAQ,IAAA,EAAE,OAAO,UAAU;AAAA,QAE3B;AACC,iBAAOA,MAAEC,uBAAAA,uBAAuB,KAAK,KAAK,GAAG;AAAA,YAC5C,GAAG;AAAA,YACH,WAAW,UAAU;AAAA,UAAA,CACrB;AAAA,MAAA;AAAA,IAEJ;AAAA,EAAA;AAED,CAAA;AAUM,MAAM,eAAe;;;;"}