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

package/dist/index.d.ts

@@ -243,82 +243,6 @@ declare type SliceZoneProps<TSlice extends SliceLike = SliceLike, TContext = unk
      */
     wrapper?: string | ConcreteComponent;
 };
-/**
- * `<SliceZone />` implementation.
- *
- * @internal
- */
-declare const SliceZoneImpl: DefineComponent<{
-    slices: {
-        type: PropType<SliceZoneLike<SliceLike<string>>>;
-        required: true;
-    };
-    components: {
-        type: PropType<SliceZoneComponents<SliceLike<string>, unknown>>;
-        default: undefined;
-        required: false;
-    };
-    resolver: {
-        type: PropType<SliceZoneResolver<SliceLike<string>, unknown>>;
-        default: undefined;
-        required: false;
-    };
-    context: {
-        type: null;
-        default: undefined;
-        required: false;
-    };
-    defaultComponent: {
-        type: PropType<SliceComponentType<SliceLike<string>, unknown>>;
-        default: undefined;
-        required: false;
-    };
-    wrapper: {
-        type: PropType<string | ConcreteComponent<{}, any, any, vue.ComputedOptions, vue.MethodOptions>>;
-        default: undefined;
-        required: false;
-    };
-}, (() => null) | (() => vue.VNode<vue.RendererNode, vue.RendererElement, {
-    [key: string]: any;
-}> | vue.VNode<vue.RendererNode, vue.RendererElement, {
-    [key: string]: any;
-}>[]), unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, Record<string, any>, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<vue.ExtractPropTypes<{
-    slices: {
-        type: PropType<SliceZoneLike<SliceLike<string>>>;
-        required: true;
-    };
-    components: {
-        type: PropType<SliceZoneComponents<SliceLike<string>, unknown>>;
-        default: undefined;
-        required: false;
-    };
-    resolver: {
-        type: PropType<SliceZoneResolver<SliceLike<string>, unknown>>;
-        default: undefined;
-        required: false;
-    };
-    context: {
-        type: null;
-        default: undefined;
-        required: false;
-    };
-    defaultComponent: {
-        type: PropType<SliceComponentType<SliceLike<string>, unknown>>;
-        default: undefined;
-        required: false;
-    };
-    wrapper: {
-        type: PropType<string | ConcreteComponent<{}, any, any, vue.ComputedOptions, vue.MethodOptions>>;
-        default: undefined;
-        required: false;
-    };
-}>>, {
-    wrapper: string | ConcreteComponent<{}, any, any, vue.ComputedOptions, vue.MethodOptions>;
-    context: any;
-    components: SliceZoneComponents<SliceLike<string>, unknown>;
-    resolver: SliceZoneResolver<SliceLike<string>, unknown>;
-    defaultComponent: SliceComponentType<SliceLike<string>, unknown>;
-}>;
 /**
  * Component to render a Prismic Slice Zone.
  *
@@ -375,6 +299,23 @@ declare type PrismicPluginComponentsOptions = {
      * @defaultValue `"img"`
      */
     imageComponent?: string | ConcreteComponent;
+    /**
+     * Default widths to use when rendering an image with `widths="defaults"`
+     *
+     * @remarks
+     * Consider configuring image widths within your content type definition and
+     * using `widths="auto"` instead to give content writers the ability to crop
+     * images in the editor.
+     * @defaultValue `@prismicio/helpers` defaults
+     */
+    imageWidthSrcSetDefaults?: number[];
+    /**
+     * Default pixel densities to use when rendering an image with
+     * `pixel-densities="defaults"`
+     *
+     * @defaultValue `@prismicio/helpers` defaults
+     */
+    imagePixelDensitySrcSetDefaults?: number[];
     /**
      * A component or a functional component rendered if a component mapping from
      * the `components` prop cannot be found.
@@ -740,7 +681,7 @@ declare type PrismicImageProps = {
      * coming from the API.
      * @remarks
      * A special value of `"defaults"` is accepted to automatically use image
-     * widths coming from `@prismicio/helpers`
+     * widths coming from the plugin configuration.
      * @remarks
      * This prop is not compatible with the `pixelDensities` prop. When both are
      * used the `pixelDensities` prop will be ignored.
@@ -751,7 +692,7 @@ declare type PrismicImageProps = {
      *
      * @remarks
      * A special value of `"defaults"` is accepted to automatically use image
-     * pixel densities coming from `@prismicio/helpers`
+     * pixel densities coming from the plugin configuration.
      * @remarks
      * This prop is not compatible with the `widths` prop. When both are used, the
      * `pixelDensities` prop will be ignored.
@@ -777,7 +718,7 @@ declare type UsePrismicImageReturnType = {
     /**
      * Resolved image `alt` value.
      */
-    alt: ComputedRef<string | null>;
+    alt: ComputedRef<string>;
     /**
      * Resolved image `copyright` value.
      */
@@ -1517,4 +1458,4 @@ declare module "@vue/runtime-core" {
     }
 }
 
-export { ClientComposableReturnType, DefineComponentSliceComponentProps, PrismicClientComposableState, PrismicEmbed, PrismicEmbedProps, PrismicImage, PrismicImageProps, PrismicLink, PrismicLinkProps, PrismicPlugin, PrismicPluginOptions, PrismicRichText, PrismicRichTextProps, PrismicText, PrismicTextProps, SliceComponentProps, SliceComponentType, SliceLike, SliceZone, SliceZoneComponents, SliceZoneImpl, SliceZoneLike, SliceZoneProps, SliceZoneResolver, TODOSliceComponent, UsePrismicImageOptions, UsePrismicLinkOptions, UsePrismicRichTextOptions, UsePrismicTextOptions, createPrismic, dangerouslyUseAllPrismicDocuments, defineSliceZoneComponents, getSliceComponentProps, prismicKey, useAllPrismicDocumentsByEveryTag, useAllPrismicDocumentsByIDs, useAllPrismicDocumentsBySomeTags, useAllPrismicDocumentsByTag, useAllPrismicDocumentsByType, useAllPrismicDocumentsByUIDs, useFirstPrismicDocument, usePrismic, usePrismicDocumentByID, usePrismicDocumentByUID, usePrismicDocuments, usePrismicDocumentsByEveryTag, usePrismicDocumentsByIDs, usePrismicDocumentsBySomeTags, usePrismicDocumentsByTag, usePrismicDocumentsByType, usePrismicDocumentsByUIDs, usePrismicImage, usePrismicLink, usePrismicRichText, usePrismicText, useSinglePrismicDocument };
+export { ClientComposableReturnType, DefineComponentSliceComponentProps, PrismicClientComposableState, PrismicEmbed, PrismicEmbedProps, PrismicImage, PrismicImageProps, PrismicLink, PrismicLinkProps, PrismicPlugin, PrismicPluginOptions, PrismicRichText, PrismicRichTextProps, PrismicText, PrismicTextProps, SliceComponentProps, SliceComponentType, SliceLike, SliceZone, SliceZoneComponents, SliceZoneLike, SliceZoneProps, SliceZoneResolver, TODOSliceComponent, UsePrismicImageOptions, UsePrismicLinkOptions, UsePrismicRichTextOptions, UsePrismicTextOptions, createPrismic, dangerouslyUseAllPrismicDocuments, defineSliceZoneComponents, getSliceComponentProps, prismicKey, useAllPrismicDocumentsByEveryTag, useAllPrismicDocumentsByIDs, useAllPrismicDocumentsBySomeTags, useAllPrismicDocumentsByTag, useAllPrismicDocumentsByType, useAllPrismicDocumentsByUIDs, useFirstPrismicDocument, usePrismic, usePrismicDocumentByID, usePrismicDocumentByUID, usePrismicDocuments, usePrismicDocumentsByEveryTag, usePrismicDocumentsByIDs, usePrismicDocumentsBySomeTags, usePrismicDocumentsByTag, usePrismicDocumentsByType, usePrismicDocumentsByUIDs, usePrismicImage, usePrismicLink, usePrismicRichText, usePrismicText, useSinglePrismicDocument };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { getEndpoint, createClient, predicate, cookie } from '@prismicio/client';
+import { createClient, predicate, cookie } from '@prismicio/client';
 import { isFilled, asImageWidthSrcSet, asImagePixelDensitySrcSet, asImageSrc, asLink, asText, asHTML, asDate, documentToLinkField } from '@prismicio/helpers';
 import { resolveDynamicComponent, defineComponent, h, inject, computed, unref, reactive, ref, watch, nextTick, onBeforeUnmount, watchEffect, markRaw, shallowRef, isRef } from 'vue';
 import { routerKey } from 'vue-router';
@@ -45,7 +45,9 @@ const usePrismic = () => {
 
 const defaultImageComponent = "img";
 const usePrismicImage = (props) => {
+  const { options } = usePrismic();
   const asImage = computed(() => {
+    var _a, _b;
     const field = unref(props.field);
     if (!isFilled.image(field)) {
       return {
@@ -66,13 +68,13 @@ const usePrismicImage = (props) => {
         const { url, dimensions, alt: alt2, copyright: copyright2 } = field;
         return asImageWidthSrcSet({ url, dimensions, alt: alt2, copyright: copyright2 }, {
           ...imgixParams,
-          widths: widths === "defaults" ? void 0 : widths
+          widths: widths === "defaults" ? (_a = options.components) == null ? void 0 : _a.imageWidthSrcSetDefaults : widths
         });
       }
     } else if (pixelDensities) {
       return asImagePixelDensitySrcSet(field, {
         ...imgixParams,
-        pixelDensities: pixelDensities === "defaults" ? void 0 : pixelDensities
+        pixelDensities: pixelDensities === "defaults" ? (_b = options.components) == null ? void 0 : _b.imagePixelDensitySrcSetDefaults : pixelDensities
       });
     } else {
       return {
@@ -88,7 +90,7 @@ const usePrismicImage = (props) => {
     return asImage.value.srcset;
   });
   const alt = computed(() => {
-    return unref(props.field).alt || null;
+    return unref(props.field).alt || "";
   });
   const copyright = computed(() => {
     return unref(props.field).copyright || null;
@@ -288,7 +290,7 @@ const PrismicLink = PrismicLinkImpl;
 const defaultWrapper$1 = "div";
 const usePrismicText = (props) => {
   const text = computed(() => {
-    return asText(unref(props.field), unref(props.separator)) || "";
+    return asText(unref(props.field), unref(props.separator));
   });
   return {
     text
@@ -334,7 +336,7 @@ const usePrismicRichText = (props) => {
     var _a, _b;
     const linkResolver = (_a = unref(props.linkResolver)) != null ? _a : options.linkResolver;
     const htmlSerializer = (_b = unref(props.htmlSerializer)) != null ? _b : options.htmlSerializer;
-    return asHTML(unref(props.field), linkResolver, htmlSerializer) || "";
+    return asHTML(unref(props.field), linkResolver, htmlSerializer);
   });
   return {
     html
@@ -437,7 +439,7 @@ const getSliceComponentProps = (propsHint) => ({
   }
 });
 const TODOSliceComponent = __PRODUCTION__ ? () => null : /* @__PURE__ */ defineComponent({
-  name: "TODOSliceCOmponent",
+  name: "TODOSliceComponent",
   props: getSliceComponentProps(),
   setup(props) {
     watchEffect(() => {
@@ -545,23 +547,18 @@ const createPrismic = (options) => {
   if (options.client) {
     client = options.client;
   } else {
-    const endpoint = /^(https?:)?\/\//gim.test(options.endpoint) ? options.endpoint : getEndpoint(options.endpoint);
-    if (options.clientConfig && typeof options.clientConfig.fetch === "function") {
-      client = createClient(endpoint, options.clientConfig);
-    } else {
-      client = createClient(endpoint, {
-        ...options.clientConfig,
-        fetch: async (endpoint2, options2) => {
-          let fetchFunction;
-          if (typeof globalThis.fetch === "function") {
-            fetchFunction = globalThis.fetch;
-          } else {
-            fetchFunction = (await import('isomorphic-unfetch')).default;
-          }
-          return await fetchFunction(endpoint2, options2);
+    client = createClient(options.endpoint, {
+      fetch: async (endpoint, options2) => {
+        let fetchFunction;
+        if (typeof globalThis.fetch === "function") {
+          fetchFunction = globalThis.fetch;
+        } else {
+          fetchFunction = (await import('isomorphic-unfetch')).default;
         }
-      });
-    }
+        return await fetchFunction(endpoint, options2);
+      },
+      ...options.clientConfig
+    });
   }
   const prismicClient = {
     client,
@@ -660,5 +657,5 @@ const usePrismicDocumentsBySomeTags = (...args) => useStatefulPrismicClientMetho
 const useAllPrismicDocumentsBySomeTags = (...args) => useStatefulPrismicClientMethod("getAllBySomeTags", args);
 const dangerouslyUseAllPrismicDocuments = (...args) => useStatefulPrismicClientMethod("dangerouslyGetAll", args);
 
-export { PrismicClientComposableState, PrismicEmbed, PrismicImage, PrismicLink, PrismicRichText, PrismicText, SliceZone, SliceZoneImpl, TODOSliceComponent, createPrismic, dangerouslyUseAllPrismicDocuments, defineSliceZoneComponents, getSliceComponentProps, prismicKey, useAllPrismicDocumentsByEveryTag, useAllPrismicDocumentsByIDs, useAllPrismicDocumentsBySomeTags, useAllPrismicDocumentsByTag, useAllPrismicDocumentsByType, useAllPrismicDocumentsByUIDs, useFirstPrismicDocument, usePrismic, usePrismicDocumentByID, usePrismicDocumentByUID, usePrismicDocuments, usePrismicDocumentsByEveryTag, usePrismicDocumentsByIDs, usePrismicDocumentsBySomeTags, usePrismicDocumentsByTag, usePrismicDocumentsByType, usePrismicDocumentsByUIDs, usePrismicImage, usePrismicLink, usePrismicRichText, usePrismicText, useSinglePrismicDocument };
+export { PrismicClientComposableState, PrismicEmbed, PrismicImage, PrismicLink, PrismicRichText, PrismicText, SliceZone, TODOSliceComponent, createPrismic, dangerouslyUseAllPrismicDocuments, defineSliceZoneComponents, getSliceComponentProps, prismicKey, useAllPrismicDocumentsByEveryTag, useAllPrismicDocumentsByIDs, useAllPrismicDocumentsBySomeTags, useAllPrismicDocumentsByTag, useAllPrismicDocumentsByType, useAllPrismicDocumentsByUIDs, useFirstPrismicDocument, usePrismic, usePrismicDocumentByID, usePrismicDocumentByUID, usePrismicDocuments, usePrismicDocumentsByEveryTag, usePrismicDocumentsByIDs, usePrismicDocumentsBySomeTags, usePrismicDocumentsByTag, usePrismicDocumentsByType, usePrismicDocumentsByUIDs, usePrismicImage, usePrismicLink, usePrismicRichText, usePrismicText, useSinglePrismicDocument };
 //# sourceMappingURL=index.js.map