@prismicio/vue 5.3.0 → 6.0.0

package/dist/createPrismic.d.cts

@@ -0,0 +1,76 @@
+import { ComponentOrTagName } from "./types.cjs";
+import { RichTextComponents } from "./PrismicRichText/types.cjs";
+import { TableComponents } from "./PrismicTable/types.cjs";
+import { App } from "vue";
+import { CreateClient, LinkResolverFunction, isFilled } from "@prismicio/client";
+
+//#region src/createPrismic.d.ts
+/** Components configuration. */
+type ComponentsConfig = {
+  /** The default component rendered for internal URLs. */
+  linkInternalComponent?: ComponentOrTagName;
+  /** The default component rendered for external URLs. */
+  linkExternalComponent?: ComponentOrTagName;
+  /**
+   * The default components or shorthand definitions for rich text and table
+   * components.
+   *
+   * @see {@link https://prismic.io/docs/fields/rich-text}
+   * @see {@link https://prismic.io/docs/fields/table}
+   */
+  richTextComponents?: RichTextComponents & TableComponents;
+};
+/** Prismic Vue plugin configuration. */
+type PrismicPluginConfig = {
+  /** A Prismic client instance to inject into the Vue app. */
+  client: ReturnType<CreateClient>;
+  /**
+   * A default link resolver used to resolve links when route resolvers cannot be used.
+   *
+   * @see {@link https://prismic.io/docs/routes}
+   */
+  linkResolver?: LinkResolverFunction;
+  /** Components configuration. */
+  components?: ComponentsConfig;
+};
+/**
+ * Prismic Vue plugin interface accessible through `usePrismic()` and
+ * `$prismic`.
+ */
+type PrismicPlugin = {
+  /** A Prismic client that can be used to query content from a repository. */
+  client: ReturnType<CreateClient>;
+  /** Helpers to determine if a field is filled. */
+  isFilled: typeof isFilled;
+  /**
+   * The default link resolver used to resolve links when route resolvers cannot be used.
+   *
+   * @see {@link https://prismic.io/docs/routes}
+   */
+  linkResolver?: LinkResolverFunction;
+  /** @internal */
+  readonly components: ComponentsConfig;
+  /** @internal */
+  install: (app: App) => void;
+};
+/** Creates a Prismic Vue plugin instance that can be used by a Vue app. */
+declare const createPrismic: (config: PrismicPluginConfig) => PrismicPlugin;
+/**
+ * Access the Prismic Vue plugin interface.
+ *
+ * @example
+ *
+ * ```typescript
+ * const { client, isFilled } = usePrismic()
+ * ```
+ */
+declare const usePrismic: () => PrismicPlugin;
+declare module "vue" {
+  interface ComponentCustomProperties {
+    /** The Prismic Vue plugin interface. */
+    $prismic: PrismicPlugin;
+  }
+}
+//#endregion
+export { PrismicPlugin, PrismicPluginConfig, createPrismic, usePrismic };
+//# sourceMappingURL=createPrismic.d.cts.map

package/dist/createPrismic.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPrismic.d.cts","names":[],"sources":["../src/createPrismic.ts"],"sourcesContent":[],"mappings":";;;;;;;;AAQqD,KAOhD,gBAAA,GAAgB;EAEI;EAGA,qBAAA,CAAA,EAHA,kBAGA;EASH;EAAqB,qBAAA,CAAA,EATlB,kBASkB;EAAe;AAI1D;;;;;;EAmBY,kBAAa,CAAA,EAvBH,kBAuBG,GAvBkB,eAuBlB;CAEL;;AAGF,KAxBN,mBAAA,GAwBM;EAOF;EAGM,MAAA,EAhCb,UAgCa,CAhCF,YAgCE,CAAA;EAGN;;AAIhB;AAqBA;AAEC;EAAA,YAAA,CAAA,EAvDe,oBAuDf;;EAKwB,UAAA,CAAA,EAzDX,gBAyDW;CAAA;;;;;KAlDb,aAAA;;UAEH,WAAW;;mBAGF;;;;;;iBAOF;;uBAGM;;iBAGN;;;cAIH,wBAAyB,wBAAsB;;;;;;;;;;cAqB/C,kBAAiB;;;;cAOlB"}

package/dist/index.cjs

@@ -1,32 +1,31 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const PrismicRichText_vue_vue_type_script_setup_true_lang = require("./PrismicRichText/PrismicRichText.vue.cjs");
-const PrismicTable_vue_vue_type_script_setup_true_lang = require("./PrismicTable/PrismicTable.vue.cjs");
-const SliceZone_vue_vue_type_script_setup_true_lang = require("./SliceZone/SliceZone.vue.cjs");
-const PrismicEmbed_vue_vue_type_script_setup_true_lang = require("./PrismicEmbed.vue.cjs");
-const PrismicImage_vue_vue_type_script_setup_true_lang = require("./PrismicImage.vue.cjs");
-const PrismicLink_vue_vue_type_script_setup_true_lang = require("./PrismicLink.vue.cjs");
-const PrismicText_vue_vue_type_script_setup_true_lang = require("./PrismicText.vue.cjs");
-const createPrismic = require("./createPrismic.cjs");
-const usePrismic = require("./usePrismic.cjs");
-const getRichTextComponentProps = require("./PrismicRichText/getRichTextComponentProps.cjs");
-const getTableComponentProps = require("./PrismicTable/getTableComponentProps.cjs");
-const TODOSliceComponent = require("./SliceZone/TODOSliceComponent.cjs");
-const defineSliceZoneComponents = require("./SliceZone/defineSliceZoneComponents.cjs");
-const getSliceComponentProps = require("./SliceZone/getSliceComponentProps.cjs");
-exports.PrismicRichText = PrismicRichText_vue_vue_type_script_setup_true_lang;
-exports.PrismicTable = PrismicTable_vue_vue_type_script_setup_true_lang;
-exports.SliceZone = SliceZone_vue_vue_type_script_setup_true_lang;
-exports.PrismicEmbed = PrismicEmbed_vue_vue_type_script_setup_true_lang;
-exports.PrismicImage = PrismicImage_vue_vue_type_script_setup_true_lang;
-exports.PrismicLink = PrismicLink_vue_vue_type_script_setup_true_lang;
-exports.PrismicText = PrismicText_vue_vue_type_script_setup_true_lang;
-exports.createPrismic = createPrismic.createPrismic;
-exports.prismicKey = usePrismic.prismicKey;
-exports.usePrismic = usePrismic.usePrismic;
-exports.getRichTextComponentProps = getRichTextComponentProps.getRichTextComponentProps;
-exports.getTableComponentProps = getTableComponentProps;
-exports.TODOSliceComponent = TODOSliceComponent.TODOSliceComponent;
-exports.defineSliceZoneComponents = defineSliceZoneComponents.defineSliceZoneComponents;
-exports.getSliceComponentProps = getSliceComponentProps.getSliceComponentProps;
-//# sourceMappingURL=index.cjs.map
+const require_createPrismic = require('./src/createPrismic.cjs');
+const require_PrismicImage = require('./src/PrismicImage.cjs');
+const require_PrismicLink = require('./src/PrismicLink.cjs');
+const require_PrismicRichText = require('./src/PrismicRichText/PrismicRichText.cjs');
+const require_getRichTextComponentProps = require('./src/PrismicRichText/getRichTextComponentProps.cjs');
+const require_getTableComponentProps = require('./src/PrismicTable/getTableComponentProps.cjs');
+const require_PrismicTable = require('./src/PrismicTable/PrismicTable.cjs');
+const require_PrismicText = require('./src/PrismicText.cjs');
+const require_TODOSliceComponent = require('./src/SliceZone/TODOSliceComponent.cjs');
+const require_SliceZone = require('./src/SliceZone/SliceZone.cjs');
+const require_getSliceComponentProps = require('./src/SliceZone/getSliceComponentProps.cjs');
+const require_defineSliceZoneComponents = require('./src/SliceZone/defineSliceZoneComponents.cjs');
+
+exports.PrismicImage = require_PrismicImage;
+exports.PrismicLink = require_PrismicLink;
+exports.PrismicRichText = require_PrismicRichText;
+exports.PrismicTable = require_PrismicTable;
+exports.PrismicText = require_PrismicText;
+exports.SliceZone = require_SliceZone;
+exports.TODOSliceComponent = require_TODOSliceComponent.TODOSliceComponent;
+exports.createPrismic = require_createPrismic.createPrismic;
+exports.defineSliceZoneComponents = require_defineSliceZoneComponents.defineSliceZoneComponents;
+exports.getRichTextComponentProps = require_getRichTextComponentProps.getRichTextComponentProps;
+exports.getSliceComponentProps = require_getSliceComponentProps.getSliceComponentProps;
+Object.defineProperty(exports, 'getTableComponentProps', {
+  enumerable: true,
+  get: function () {
+    return require_getTableComponentProps.getTableComponentProps_exports;
+  }
+});
+exports.usePrismic = require_createPrismic.usePrismic;

package/dist/index.d.cts

@@ -0,0 +1,16 @@
+import { RichTextComponentProps, RichTextComponents } from "./PrismicRichText/types.cjs";
+import { PrismicRichTextProps, _default as _default$2 } from "./PrismicRichText/PrismicRichText.vue.cjs";
+import { getRichTextComponentProps } from "./PrismicRichText/getRichTextComponentProps.cjs";
+import { TableComponents } from "./PrismicTable/types.cjs";
+import { PrismicTableProps, _default as _default$3 } from "./PrismicTable/PrismicTable.vue.cjs";
+import { getTableComponentProps_d_exports } from "./PrismicTable/getTableComponentProps.cjs";
+import { PrismicImageProps, _default } from "./PrismicImage.vue.cjs";
+import { PrismicLinkProps, _default as _default$1 } from "./PrismicLink.vue.cjs";
+import { PrismicTextProps, _default as _default$4 } from "./PrismicText.vue.cjs";
+import { SliceComponentProps, SliceComponentType, SliceLike, SliceLikeGraphQL, SliceLikeRestV2, SliceZoneComponents, SliceZoneLike } from "./SliceZone/types.cjs";
+import { SliceZoneProps, _default as _default$5 } from "./SliceZone/SliceZone.vue.cjs";
+import { TODOSliceComponent } from "./SliceZone/TODOSliceComponent.cjs";
+import { getSliceComponentProps } from "./SliceZone/getSliceComponentProps.cjs";
+import { defineSliceZoneComponents } from "./SliceZone/defineSliceZoneComponents.cjs";
+import { PrismicPlugin, PrismicPluginConfig, createPrismic, usePrismic } from "./createPrismic.cjs";
+export { _default as PrismicImage, type PrismicImageProps, _default$1 as PrismicLink, type PrismicLinkProps, type PrismicPlugin, type PrismicPluginConfig, _default$2 as PrismicRichText, type PrismicRichTextProps, _default$3 as PrismicTable, type PrismicTableProps, _default$4 as PrismicText, type PrismicTextProps, type RichTextComponentProps, type RichTextComponents, type SliceComponentProps, type SliceComponentType, type SliceLike, type SliceLikeGraphQL, type SliceLikeRestV2, _default$5 as SliceZone, type SliceZoneComponents, type SliceZoneLike, type SliceZoneProps, TODOSliceComponent, type TableComponents, createPrismic, defineSliceZoneComponents, getRichTextComponentProps, getSliceComponentProps, getTableComponentProps_d_exports as getTableComponentProps, usePrismic };

package/dist/index.d.ts

@@ -1,23 +1,19 @@
-import PrismicRichText from "./PrismicRichText/PrismicRichText.vue";
-import PrismicTable from "./PrismicTable/PrismicTable.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 { PrismicTableProps } from "./PrismicTable/PrismicTable.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 { SliceZone, PrismicEmbed, PrismicImage, PrismicLink, PrismicTable, PrismicText, PrismicRichText, };
-export { getRichTextComponentProps } from "./PrismicRichText";
-export type { VueRichTextSerializer, RichTextComponentProps, } from "./PrismicRichText";
-export { getTableComponentProps } from "./PrismicTable";
-export { TODOSliceComponent, defineSliceZoneComponents, getSliceComponentProps, } from "./SliceZone";
-export type { SliceComponentProps, SliceComponentType, SliceLike, SliceLikeGraphQL, SliceLikeRestV2, SliceZoneComponents, SliceZoneLike, } from "./SliceZone";
-export type { PrismicPluginOptions, PrismicPlugin } from "./types";
-export { createPrismic } from "./createPrismic";
-export { usePrismic, prismicKey } from "./usePrismic";
+import { RichTextComponentProps, RichTextComponents } from "./src/PrismicRichText/types.js";
+import { PrismicRichTextProps, _default as _default$2 } from "./src/PrismicRichText/PrismicRichText.vue.js";
+import { getRichTextComponentProps } from "./src/PrismicRichText/getRichTextComponentProps.js";
+import "./src/PrismicRichText/index.js";
+import { TableComponents } from "./src/PrismicTable/types.js";
+import { PrismicTableProps, _default as _default$3 } from "./src/PrismicTable/PrismicTable.vue.js";
+import { getTableComponentProps_d_exports } from "./src/PrismicTable/getTableComponentProps.js";
+import "./src/PrismicTable/index.js";
+import { PrismicImageProps, _default } from "./src/PrismicImage.vue.js";
+import { PrismicLinkProps, _default as _default$1 } from "./src/PrismicLink.vue.js";
+import { PrismicTextProps, _default as _default$4 } from "./src/PrismicText.vue.js";
+import { SliceComponentProps, SliceComponentType, SliceLike, SliceLikeGraphQL, SliceLikeRestV2, SliceZoneComponents, SliceZoneLike } from "./src/SliceZone/types.js";
+import { SliceZoneProps, _default as _default$5 } from "./src/SliceZone/SliceZone.vue.js";
+import { TODOSliceComponent } from "./src/SliceZone/TODOSliceComponent.js";
+import { getSliceComponentProps } from "./src/SliceZone/getSliceComponentProps.js";
+import { defineSliceZoneComponents } from "./src/SliceZone/defineSliceZoneComponents.js";
+import "./src/SliceZone/index.js";
+import { PrismicPlugin, PrismicPluginConfig, createPrismic, usePrismic } from "./src/createPrismic.js";
+export { _default as PrismicImage, type PrismicImageProps, _default$1 as PrismicLink, type PrismicLinkProps, type PrismicPlugin, type PrismicPluginConfig, _default$2 as PrismicRichText, type PrismicRichTextProps, _default$3 as PrismicTable, type PrismicTableProps, _default$4 as PrismicText, type PrismicTextProps, type RichTextComponentProps, type RichTextComponents, type SliceComponentProps, type SliceComponentType, type SliceLike, type SliceLikeGraphQL, type SliceLikeRestV2, _default$5 as SliceZone, type SliceZoneComponents, type SliceZoneLike, type SliceZoneProps, TODOSliceComponent, type TableComponents, createPrismic, defineSliceZoneComponents, getRichTextComponentProps, getSliceComponentProps, getTableComponentProps_d_exports as getTableComponentProps, usePrismic };

package/dist/index.js

@@ -1,32 +1,14 @@
-import { default as default2 } from "./PrismicRichText/PrismicRichText.vue.js";
-import { default as default3 } from "./PrismicTable/PrismicTable.vue.js";
-import { default as default4 } from "./SliceZone/SliceZone.vue.js";
-import { default as default5 } from "./PrismicEmbed.vue.js";
-import { default as default6 } from "./PrismicImage.vue.js";
-import { default as default7 } from "./PrismicLink.vue.js";
-import { default as default8 } from "./PrismicText.vue.js";
-import { createPrismic } from "./createPrismic.js";
-import { prismicKey, usePrismic } from "./usePrismic.js";
-import { getRichTextComponentProps } from "./PrismicRichText/getRichTextComponentProps.js";
-import * as getTableComponentProps from "./PrismicTable/getTableComponentProps.js";
-import { TODOSliceComponent } from "./SliceZone/TODOSliceComponent.js";
-import { defineSliceZoneComponents } from "./SliceZone/defineSliceZoneComponents.js";
-import { getSliceComponentProps } from "./SliceZone/getSliceComponentProps.js";
-export {
-  default5 as PrismicEmbed,
-  default6 as PrismicImage,
-  default7 as PrismicLink,
-  default2 as PrismicRichText,
-  default3 as PrismicTable,
-  default8 as PrismicText,
-  default4 as SliceZone,
-  TODOSliceComponent,
-  createPrismic,
-  defineSliceZoneComponents,
-  getRichTextComponentProps,
-  getSliceComponentProps,
-  getTableComponentProps,
-  prismicKey,
-  usePrismic
-};
-//# sourceMappingURL=index.js.map
+import { createPrismic, usePrismic } from "./src/createPrismic.js";
+import PrismicImage_default from "./src/PrismicImage.js";
+import PrismicLink_default from "./src/PrismicLink.js";
+import PrismicRichText_default from "./src/PrismicRichText/PrismicRichText.js";
+import { getRichTextComponentProps } from "./src/PrismicRichText/getRichTextComponentProps.js";
+import { getTableComponentProps_exports } from "./src/PrismicTable/getTableComponentProps.js";
+import PrismicTable_default from "./src/PrismicTable/PrismicTable.js";
+import PrismicText_default from "./src/PrismicText.js";
+import { TODOSliceComponent } from "./src/SliceZone/TODOSliceComponent.js";
+import SliceZone_default from "./src/SliceZone/SliceZone.js";
+import { getSliceComponentProps } from "./src/SliceZone/getSliceComponentProps.js";
+import { defineSliceZoneComponents } from "./src/SliceZone/defineSliceZoneComponents.js";
+
+export { PrismicImage_default as PrismicImage, PrismicLink_default as PrismicLink, PrismicRichText_default as PrismicRichText, PrismicTable_default as PrismicTable, PrismicText_default as PrismicText, SliceZone_default as SliceZone, TODOSliceComponent, createPrismic, defineSliceZoneComponents, getRichTextComponentProps, getSliceComponentProps, getTableComponentProps_exports as getTableComponentProps, usePrismic };

package/dist/package.cjs

@@ -0,0 +1,12 @@
+
+//#region package.json
+var version = "6.0.0";
+
+//#endregion
+Object.defineProperty(exports, 'version', {
+  enumerable: true,
+  get: function () {
+    return version;
+  }
+});
+//# sourceMappingURL=package.cjs.map

package/dist/package.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.cjs","names":[],"sources":["../package.json"],"sourcesContent":[""],"mappings":""}

package/dist/package.js

@@ -0,0 +1,6 @@
+//#region package.json
+var version = "6.0.0";
+
+//#endregion
+export { version };
+//# sourceMappingURL=package.js.map

package/dist/package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.js","names":[],"sources":["../package.json"],"sourcesContent":[""],"mappings":""}

package/dist/src/PrismicImage.cjs

@@ -0,0 +1,8 @@
+const require_PrismicImage_vue_vue_type_script_setup_true_lang = require('./PrismicImage.vue_vue_type_script_setup_true_lang.cjs');
+
+//#region src/PrismicImage.vue
+var PrismicImage_default = require_PrismicImage_vue_vue_type_script_setup_true_lang.default;
+
+//#endregion
+exports.default = PrismicImage_default;
+//# sourceMappingURL=PrismicImage.cjs.map

package/dist/src/PrismicImage.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrismicImage.cjs","names":[],"sources":["../../src/PrismicImage.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport type { ImageField, asImageSrc } from \"@prismicio/client\"\nimport {\n\tasImagePixelDensitySrcSet,\n\tasImageWidthSrcSet,\n\tisFilled,\n} from \"@prismicio/client\"\nimport { DEV } from \"esm-env\"\nimport { computed, watchEffect } from \"vue\"\n\nimport { devMsg } from \"./lib/devMsg\"\n\n/** Props for `<PrismicImage />`. */\nexport type PrismicImageProps = {\n\t/** The Prismic image field or thumbnail to render. */\n\tfield: ImageField | ImageField<string>\n\n\t/**\n\t * An object of Imgix URL API parameters to transform the image.\n\t *\n\t * See: https://docs.imgix.com/apis/rendering\n\t */\n\timgixParams?: Parameters<typeof asImageSrc>[1]\n\n\t/**\n\t * Declare an image as decorative by providing `alt=\"\"`.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images\n\t */\n\talt?: \"\"\n\n\t/**\n\t * Declare an image as decorative only if the image field does not have\n\t * alternative text by providing `fallbackAlt=\"\"`.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images\n\t */\n\tfallbackAlt?: \"\"\n\n\t/**\n\t * The width attribute of the image element.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width\n\t */\n\twidth?: number | string\n\n\t/**\n\t * The height attribute of the image element.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height\n\t */\n\theight?: number | string\n} & (\n\t| {\n\t\t\t/**\n\t\t\t * Widths (in pixels) used to build a `srcset` value for the image field.\n\t\t\t *\n\t\t\t * If omitted or set to `\"defaults\"`, the following widths will be used:\n\t\t\t * 640, 750, 828, 1080, 1200, 1920, 2048, 3840.\n\t\t\t *\n\t\t\t * If the image field contains responsive views, each responsive view can\n\t\t\t * be used as a width in the resulting `srcset` by passing `\"thumbnails\"`\n\t\t\t * as the `widths` prop.\n\t\t\t */\n\t\t\twidths?:\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\tpixelDensities?: never\n\t  }\n\t| {\n\t\t\twidths?: never\n\t\t\t/**\n\t\t\t * Pixel densities used to build a `srcset` value for the image field.\n\t\t\t *\n\t\t\t * If a `pixelDensities` prop is passed `\"defaults\"`, the following pixel\n\t\t\t * densities will be used: 1, 2, 3.\n\t\t\t */\n\t\t\tpixelDensities:\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  }\n)\n\nconst props = defineProps<PrismicImageProps>()\ndefineOptions({ name: \"PrismicImage\" })\n\nif (DEV) {\n\twatchEffect(() => {\n\t\tif (typeof props.alt === \"string\" && props.alt !== \"\") {\n\t\t\tconsole.warn(\n\t\t\t\t`[PrismicImage] The \"alt\" prop can only be used to declare an image as decorative by passing an empty string (alt=\"\") but was provided a non-empty string. You can resolve this warning by removing the \"alt\" prop or changing it to alt=\"\". For more details, see ${devMsg(\n\t\t\t\t\t\"alt-must-be-an-empty-string\",\n\t\t\t\t)}`,\n\t\t\t)\n\t\t}\n\n\t\tif (typeof props.fallbackAlt === \"string\" && props.fallbackAlt !== \"\") {\n\t\t\tconsole.warn(\n\t\t\t\t`[PrismicImage] The \"fallbackAlt\" prop can only be used to declare an image as decorative by passing an empty string (fallbackAlt=\"\") but was provided a non-empty string. You can resolve this warning by removing the \"fallbackAlt\" prop or changing it to fallbackAlt=\"\". For more details, see ${devMsg(\n\t\t\t\t\t\"alt-must-be-an-empty-string\",\n\t\t\t\t)}`,\n\t\t\t)\n\t\t}\n\n\t\tif (props.widths && props.pixelDensities) {\n\t\t\tconsole.warn(\n\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)\n\t\t}\n\t})\n}\n\nconst castInt = (input: string | number | undefined): number | undefined => {\n\tif (typeof input === \"number\" || typeof input === \"undefined\") {\n\t\treturn input\n\t} else {\n\t\tconst parsed = Number.parseInt(input)\n\n\t\tif (Number.isNaN(parsed)) {\n\t\t\treturn undefined\n\t\t} else {\n\t\t\treturn parsed\n\t\t}\n\t}\n}\n\nconst image = computed(() => {\n\tif (!isFilled.imageThumbnail(props.field)) {\n\t\treturn\n\t}\n\n\tlet src: string | undefined\n\tlet srcSet: string | undefined\n\tif (props.widths || !props.pixelDensities) {\n\t\tconst res = asImageWidthSrcSet(props.field, {\n\t\t\t...props.imgixParams,\n\t\t\twidths: props.widths === \"defaults\" ? undefined : props.widths,\n\t\t})\n\n\t\tsrc = res.src\n\t\tsrcSet = res.srcset\n\t} else if (props.pixelDensities) {\n\t\tconst res = asImagePixelDensitySrcSet(props.field, {\n\t\t\t...props.imgixParams,\n\t\t\tpixelDensities:\n\t\t\t\tprops.pixelDensities === \"defaults\" ? undefined : props.pixelDensities,\n\t\t})\n\n\t\tsrc = res.src\n\t\tsrcSet = res.srcset\n\t}\n\n\tconst ar = props.field.dimensions.width / props.field.dimensions.height\n\n\tconst castedWidth = castInt(props.width)\n\tconst castedHeight = castInt(props.height)\n\n\tlet resolvedWidth = castedWidth ?? props.field.dimensions.width\n\tlet resolvedHeight = castedHeight ?? props.field.dimensions.height\n\n\tif (castedWidth != null && castedHeight == null) {\n\t\tresolvedHeight = castedWidth / ar\n\t} else if (castedWidth == null && castedHeight != null) {\n\t\tresolvedWidth = castedHeight * ar\n\t}\n\n\treturn {\n\t\tsrc,\n\t\tsrcSet,\n\t\talt: props.alt ?? (props.field.alt || props.fallbackAlt),\n\t\twidth: Math.round(resolvedWidth),\n\t\theight: Math.round(resolvedHeight),\n\t}\n})\n</script>\n\n<template>\n\t<img\n\t\tv-if=\"image\"\n\t\t:src=\"image.src\"\n\t\t:srcset=\"image.srcSet\"\n\t\t:alt=\"image.alt\"\n\t\t:width=\"image.width\"\n\t\t:height=\"image.height\"\n\t/>\n</template>\n"],"mappings":""}

package/dist/src/PrismicImage.js

@@ -0,0 +1,8 @@
+import PrismicImage_vue_vue_type_script_setup_true_lang_default from "./PrismicImage.vue_vue_type_script_setup_true_lang.js";
+
+//#region src/PrismicImage.vue
+var PrismicImage_default = PrismicImage_vue_vue_type_script_setup_true_lang_default;
+
+//#endregion
+export { PrismicImage_default as default };
+//# sourceMappingURL=PrismicImage.js.map

package/dist/src/PrismicImage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrismicImage.js","names":[],"sources":["../../src/PrismicImage.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport type { ImageField, asImageSrc } from \"@prismicio/client\"\nimport {\n\tasImagePixelDensitySrcSet,\n\tasImageWidthSrcSet,\n\tisFilled,\n} from \"@prismicio/client\"\nimport { DEV } from \"esm-env\"\nimport { computed, watchEffect } from \"vue\"\n\nimport { devMsg } from \"./lib/devMsg\"\n\n/** Props for `<PrismicImage />`. */\nexport type PrismicImageProps = {\n\t/** The Prismic image field or thumbnail to render. */\n\tfield: ImageField | ImageField<string>\n\n\t/**\n\t * An object of Imgix URL API parameters to transform the image.\n\t *\n\t * See: https://docs.imgix.com/apis/rendering\n\t */\n\timgixParams?: Parameters<typeof asImageSrc>[1]\n\n\t/**\n\t * Declare an image as decorative by providing `alt=\"\"`.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images\n\t */\n\talt?: \"\"\n\n\t/**\n\t * Declare an image as decorative only if the image field does not have\n\t * alternative text by providing `fallbackAlt=\"\"`.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images\n\t */\n\tfallbackAlt?: \"\"\n\n\t/**\n\t * The width attribute of the image element.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width\n\t */\n\twidth?: number | string\n\n\t/**\n\t * The height attribute of the image element.\n\t *\n\t * See:\n\t * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height\n\t */\n\theight?: number | string\n} & (\n\t| {\n\t\t\t/**\n\t\t\t * Widths (in pixels) used to build a `srcset` value for the image field.\n\t\t\t *\n\t\t\t * If omitted or set to `\"defaults\"`, the following widths will be used:\n\t\t\t * 640, 750, 828, 1080, 1200, 1920, 2048, 3840.\n\t\t\t *\n\t\t\t * If the image field contains responsive views, each responsive view can\n\t\t\t * be used as a width in the resulting `srcset` by passing `\"thumbnails\"`\n\t\t\t * as the `widths` prop.\n\t\t\t */\n\t\t\twidths?:\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\tpixelDensities?: never\n\t  }\n\t| {\n\t\t\twidths?: never\n\t\t\t/**\n\t\t\t * Pixel densities used to build a `srcset` value for the image field.\n\t\t\t *\n\t\t\t * If a `pixelDensities` prop is passed `\"defaults\"`, the following pixel\n\t\t\t * densities will be used: 1, 2, 3.\n\t\t\t */\n\t\t\tpixelDensities:\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  }\n)\n\nconst props = defineProps<PrismicImageProps>()\ndefineOptions({ name: \"PrismicImage\" })\n\nif (DEV) {\n\twatchEffect(() => {\n\t\tif (typeof props.alt === \"string\" && props.alt !== \"\") {\n\t\t\tconsole.warn(\n\t\t\t\t`[PrismicImage] The \"alt\" prop can only be used to declare an image as decorative by passing an empty string (alt=\"\") but was provided a non-empty string. You can resolve this warning by removing the \"alt\" prop or changing it to alt=\"\". For more details, see ${devMsg(\n\t\t\t\t\t\"alt-must-be-an-empty-string\",\n\t\t\t\t)}`,\n\t\t\t)\n\t\t}\n\n\t\tif (typeof props.fallbackAlt === \"string\" && props.fallbackAlt !== \"\") {\n\t\t\tconsole.warn(\n\t\t\t\t`[PrismicImage] The \"fallbackAlt\" prop can only be used to declare an image as decorative by passing an empty string (fallbackAlt=\"\") but was provided a non-empty string. You can resolve this warning by removing the \"fallbackAlt\" prop or changing it to fallbackAlt=\"\". For more details, see ${devMsg(\n\t\t\t\t\t\"alt-must-be-an-empty-string\",\n\t\t\t\t)}`,\n\t\t\t)\n\t\t}\n\n\t\tif (props.widths && props.pixelDensities) {\n\t\t\tconsole.warn(\n\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)\n\t\t}\n\t})\n}\n\nconst castInt = (input: string | number | undefined): number | undefined => {\n\tif (typeof input === \"number\" || typeof input === \"undefined\") {\n\t\treturn input\n\t} else {\n\t\tconst parsed = Number.parseInt(input)\n\n\t\tif (Number.isNaN(parsed)) {\n\t\t\treturn undefined\n\t\t} else {\n\t\t\treturn parsed\n\t\t}\n\t}\n}\n\nconst image = computed(() => {\n\tif (!isFilled.imageThumbnail(props.field)) {\n\t\treturn\n\t}\n\n\tlet src: string | undefined\n\tlet srcSet: string | undefined\n\tif (props.widths || !props.pixelDensities) {\n\t\tconst res = asImageWidthSrcSet(props.field, {\n\t\t\t...props.imgixParams,\n\t\t\twidths: props.widths === \"defaults\" ? undefined : props.widths,\n\t\t})\n\n\t\tsrc = res.src\n\t\tsrcSet = res.srcset\n\t} else if (props.pixelDensities) {\n\t\tconst res = asImagePixelDensitySrcSet(props.field, {\n\t\t\t...props.imgixParams,\n\t\t\tpixelDensities:\n\t\t\t\tprops.pixelDensities === \"defaults\" ? undefined : props.pixelDensities,\n\t\t})\n\n\t\tsrc = res.src\n\t\tsrcSet = res.srcset\n\t}\n\n\tconst ar = props.field.dimensions.width / props.field.dimensions.height\n\n\tconst castedWidth = castInt(props.width)\n\tconst castedHeight = castInt(props.height)\n\n\tlet resolvedWidth = castedWidth ?? props.field.dimensions.width\n\tlet resolvedHeight = castedHeight ?? props.field.dimensions.height\n\n\tif (castedWidth != null && castedHeight == null) {\n\t\tresolvedHeight = castedWidth / ar\n\t} else if (castedWidth == null && castedHeight != null) {\n\t\tresolvedWidth = castedHeight * ar\n\t}\n\n\treturn {\n\t\tsrc,\n\t\tsrcSet,\n\t\talt: props.alt ?? (props.field.alt || props.fallbackAlt),\n\t\twidth: Math.round(resolvedWidth),\n\t\theight: Math.round(resolvedHeight),\n\t}\n})\n</script>\n\n<template>\n\t<img\n\t\tv-if=\"image\"\n\t\t:src=\"image.src\"\n\t\t:srcset=\"image.srcSet\"\n\t\t:alt=\"image.alt\"\n\t\t:width=\"image.width\"\n\t\t:height=\"image.height\"\n\t/>\n</template>\n"],"mappings":""}

package/dist/src/PrismicImage.vue.d.ts

@@ -0,0 +1,267 @@
+import * as vue6 from "vue";
+import { ImageField, asImagePixelDensitySrcSet, asImageSrc, asImageWidthSrcSet } from "@prismicio/client";
+
+//#region src/PrismicImage.vue.d.ts
+/** Props for `<PrismicImage />`. */
+type PrismicImageProps = {
+  /** The Prismic image field or thumbnail to render. */
+  field: ImageField | ImageField<string>;
+  /**
+   * An object of Imgix URL API parameters to transform the image.
+   *
+   * See: https://docs.imgix.com/apis/rendering
+   */
+  imgixParams?: Parameters<typeof asImageSrc>[1];
+  /**
+   * Declare an image as decorative by providing `alt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  alt?: "";
+  /**
+   * Declare an image as decorative only if the image field does not have
+   * alternative text by providing `fallbackAlt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  fallbackAlt?: "";
+  /**
+   * The width attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
+   */
+  width?: number | string;
+  /**
+   * The height attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
+   */
+  height?: number | string;
+} & ({
+  /**
+   * Widths (in pixels) used to build a `srcset` value for the image field.
+   *
+   * If omitted or set to `"defaults"`, the following widths will be used:
+   * 640, 750, 828, 1080, 1200, 1920, 2048, 3840.
+   *
+   * If the image field contains responsive views, each responsive view can
+   * be used as a width in the resulting `srcset` by passing `"thumbnails"`
+   * as the `widths` prop.
+   */
+  widths?: NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"] | "thumbnails" | "defaults";
+  pixelDensities?: never;
+} | {
+  widths?: never;
+  /**
+   * Pixel densities used to build a `srcset` value for the image field.
+   *
+   * If a `pixelDensities` prop is passed `"defaults"`, the following pixel
+   * densities will be used: 1, 2, 3.
+   */
+  pixelDensities: NonNullable<Parameters<typeof asImagePixelDensitySrcSet>[1]>["pixelDensities"] | "defaults";
+});
+declare const __VLS_export: vue6.DefineComponent<({
+  /** The Prismic image field or thumbnail to render. */
+  field: ImageField | ImageField<string>;
+  /**
+   * An object of Imgix URL API parameters to transform the image.
+   *
+   * See: https://docs.imgix.com/apis/rendering
+   */
+  imgixParams?: Parameters<typeof asImageSrc>[1];
+  /**
+   * Declare an image as decorative by providing `alt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  alt?: "";
+  /**
+   * Declare an image as decorative only if the image field does not have
+   * alternative text by providing `fallbackAlt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  fallbackAlt?: "";
+  /**
+   * The width attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
+   */
+  width?: number | string;
+  /**
+   * The height attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
+   */
+  height?: number | string;
+} & {
+  /**
+   * Widths (in pixels) used to build a `srcset` value for the image field.
+   *
+   * If omitted or set to `"defaults"`, the following widths will be used:
+   * 640, 750, 828, 1080, 1200, 1920, 2048, 3840.
+   *
+   * If the image field contains responsive views, each responsive view can
+   * be used as a width in the resulting `srcset` by passing `"thumbnails"`
+   * as the `widths` prop.
+   */
+  widths?: NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"] | "thumbnails" | "defaults";
+  pixelDensities?: never;
+}) | ({
+  /** The Prismic image field or thumbnail to render. */
+  field: ImageField | ImageField<string>;
+  /**
+   * An object of Imgix URL API parameters to transform the image.
+   *
+   * See: https://docs.imgix.com/apis/rendering
+   */
+  imgixParams?: Parameters<typeof asImageSrc>[1];
+  /**
+   * Declare an image as decorative by providing `alt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  alt?: "";
+  /**
+   * Declare an image as decorative only if the image field does not have
+   * alternative text by providing `fallbackAlt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  fallbackAlt?: "";
+  /**
+   * The width attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
+   */
+  width?: number | string;
+  /**
+   * The height attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
+   */
+  height?: number | string;
+} & {
+  widths?: never;
+  /**
+   * Pixel densities used to build a `srcset` value for the image field.
+   *
+   * If a `pixelDensities` prop is passed `"defaults"`, the following pixel
+   * densities will be used: 1, 2, 3.
+   */
+  pixelDensities: NonNullable<Parameters<typeof asImagePixelDensitySrcSet>[1]>["pixelDensities"] | "defaults";
+}), {}, {}, {}, {}, vue6.ComponentOptionsMixin, vue6.ComponentOptionsMixin, {}, string, vue6.PublicProps, Readonly<({
+  /** The Prismic image field or thumbnail to render. */
+  field: ImageField | ImageField<string>;
+  /**
+   * An object of Imgix URL API parameters to transform the image.
+   *
+   * See: https://docs.imgix.com/apis/rendering
+   */
+  imgixParams?: Parameters<typeof asImageSrc>[1];
+  /**
+   * Declare an image as decorative by providing `alt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  alt?: "";
+  /**
+   * Declare an image as decorative only if the image field does not have
+   * alternative text by providing `fallbackAlt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  fallbackAlt?: "";
+  /**
+   * The width attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
+   */
+  width?: number | string;
+  /**
+   * The height attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
+   */
+  height?: number | string;
+} & {
+  /**
+   * Widths (in pixels) used to build a `srcset` value for the image field.
+   *
+   * If omitted or set to `"defaults"`, the following widths will be used:
+   * 640, 750, 828, 1080, 1200, 1920, 2048, 3840.
+   *
+   * If the image field contains responsive views, each responsive view can
+   * be used as a width in the resulting `srcset` by passing `"thumbnails"`
+   * as the `widths` prop.
+   */
+  widths?: NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"] | "thumbnails" | "defaults";
+  pixelDensities?: never;
+}) | ({
+  /** The Prismic image field or thumbnail to render. */
+  field: ImageField | ImageField<string>;
+  /**
+   * An object of Imgix URL API parameters to transform the image.
+   *
+   * See: https://docs.imgix.com/apis/rendering
+   */
+  imgixParams?: Parameters<typeof asImageSrc>[1];
+  /**
+   * Declare an image as decorative by providing `alt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  alt?: "";
+  /**
+   * Declare an image as decorative only if the image field does not have
+   * alternative text by providing `fallbackAlt=""`.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+   */
+  fallbackAlt?: "";
+  /**
+   * The width attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/width
+   */
+  width?: number | string;
+  /**
+   * The height attribute of the image element.
+   *
+   * See:
+   * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/height
+   */
+  height?: number | string;
+} & {
+  widths?: never;
+  /**
+   * Pixel densities used to build a `srcset` value for the image field.
+   *
+   * If a `pixelDensities` prop is passed `"defaults"`, the following pixel
+   * densities will be used: 1, 2, 3.
+   */
+  pixelDensities: NonNullable<Parameters<typeof asImagePixelDensitySrcSet>[1]>["pixelDensities"] | "defaults";
+})> & Readonly<{}>, {}, {}, {}, {}, string, vue6.ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+//#endregion
+export { PrismicImageProps, _default };
+//# sourceMappingURL=PrismicImage.vue.d.ts.map

package/dist/src/PrismicImage.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrismicImage.vue.d.ts","names":[],"sources":["../../src/PrismicImage.vue"],"sourcesContent":[],"mappings":";;;;;KAgNY,iBAAA;EAAA;EAEJ,KAAA,EAAA,UAAA,GAAa,UAAb,CAAA,MAAA,CAAA;EAAa;;;;;EAsDf,WAAA,CAAA,EA/CS,UA+CT,CAAA,OA/C2B,UA+C3B,CAAA,CAAA,CAAA,CAAA;EAekB;;;;AAIvB;;EAzEoB,GAAA,CAAA,EAAA,EAAA;EAOY;;;;;;;EAAA,WAAA,CAAA,EAAA,EAAA;EAAlB;;;;;;;EAPP;;;;;;EAsDF,MAAA,CAAA,EAAA,MAAA,GAAA,MAAA;CAtDE,GAAA,CAAA;EAAa;;;;;;;;;;EAsMH,MAAA,CAAA,EAhJZ,WAgJY,CAhJA,UAgJA,CAAA,OAhJkB,kBAgJlB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,QAAA,CAAA,GAAA,YAAA,GAAA,UAAA;EAAA,cAGsB,CAAA,EAAA,KAAZ;;;;;;;;;kBArItB,YACA,kBAAkB;;cAiIlB,mBAAY;;SAtMV,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+C3B,YAAY,kBAAkB;;;;SAtD5B,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA6D3B,YACA,kBAAkB;oBADP,IAAA,CAAA,qBAAA;;SApET,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+C3B,YAAY,kBAAkB;;;;SAtD5B,aAAa;;;;;;gBAON,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA6D3B,YACA,kBAAkB;;cAiIN,iBAGU"}