@prismicio/vue 3.0.0 → 3.1.0

package/dist/index.d.ts

@@ -22,6 +22,7 @@ declare type ExtractSliceType<TSlice extends SliceLike> = TSlice extends SliceLi
  */
 declare type SliceLikeRestV2<TSliceType extends string = string> = {
     slice_type: Slice<TSliceType>["slice_type"];
+    id?: string;
 };
 /**
  * The minimum required properties to represent a Prismic Slice from the Prismic
@@ -1042,15 +1043,7 @@ declare type ClientComposableReturnType<TData = unknown> = {
  * @see Underlying `@prismicio/client` method {@link Client.get}
  */
 declare const usePrismicDocuments: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
  * A composable that queries content from the Prismic repository and returns
@@ -1068,15 +1061,7 @@ declare const usePrismicDocuments: <TDocument extends PrismicDocument<Record<str
  * @see Underlying `@prismicio/client` method {@link Client.getFirst}
  */
 declare const useFirstPrismicDocument: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
 /**
  * A composable that queries a document from the Prismic repository with a specific ID.
@@ -1094,15 +1079,7 @@ declare const useFirstPrismicDocument: <TDocument extends PrismicDocument<Record
  * @see Underlying `@prismicio/client` method {@link Client.getByID}
  */
 declare const usePrismicDocumentByID: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(id: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
 /**
  * A composable that queries documents from the Prismic repository with specific IDs.
@@ -1120,15 +1097,7 @@ declare const usePrismicDocumentByID: <TDocument extends PrismicDocument<Record<
  * @see Underlying `@prismicio/client` method {@link Client.getByIDs}
  */
 declare const usePrismicDocumentsByIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
  * A composable that queries all documents from the Prismic repository with specific IDs.
@@ -1148,15 +1117,7 @@ declare const usePrismicDocumentsByIDs: <TDocument extends PrismicDocument<Recor
 declare const useAllPrismicDocumentsByIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
     limit?: number | undefined;
 } & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
  * A composable that queries a document from the Prismic repository with a
@@ -1176,15 +1137,7 @@ declare const useAllPrismicDocumentsByIDs: <TDocument extends PrismicDocument<Re
  * @see Underlying `@prismicio/client` method {@link Client.getByUID}
  */
 declare const usePrismicDocumentByUID: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, uid: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
 /**
  * A composable that queries documents from the Prismic repository with specific UIDs.
@@ -1203,15 +1156,7 @@ declare const usePrismicDocumentByUID: <TDocument extends PrismicDocument<Record
  * @see Underlying `@prismicio/client` method {@link Client.getByIDs}
  */
 declare const usePrismicDocumentsByUIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, uids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
  * A composable that queries all documents from the Prismic repository with specific UIDs.
@@ -1232,15 +1177,7 @@ declare const usePrismicDocumentsByUIDs: <TDocument extends PrismicDocument<Reco
 declare const useAllPrismicDocumentsByUIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
     limit?: number | undefined;
 } & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
  * A composable that queries a singleton document from the Prismic repository
@@ -1259,15 +1196,7 @@ declare const useAllPrismicDocumentsByUIDs: <TDocument extends PrismicDocument<R
  * @see Underlying `@prismicio/client` method {@link Client.getSingle}
  */
 declare const useSinglePrismicDocument: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
 /**
  * A composable that queries documents from the Prismic repository for a
@@ -1286,15 +1215,7 @@ declare const useSinglePrismicDocument: <TDocument extends PrismicDocument<Recor
  * @see Underlying `@prismicio/client` method {@link Client.getByType}
  */
 declare const usePrismicDocumentsByType: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
  * A composable that queries all documents from the Prismic repository for a
@@ -1315,15 +1236,7 @@ declare const usePrismicDocumentsByType: <TDocument extends PrismicDocument<Reco
 declare const useAllPrismicDocumentsByType: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
     limit?: number | undefined;
 } & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
  * A composable that queries documents from the Prismic repository with a specific tag.
@@ -1341,15 +1254,7 @@ declare const useAllPrismicDocumentsByType: <TDocument extends PrismicDocument<R
  * @see Underlying `@prismicio/client` method {@link Client.getByTag}
  */
 declare const usePrismicDocumentsByTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tag: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
  * A composable that queries all documents from the Prismic repository with a
@@ -1370,15 +1275,7 @@ declare const usePrismicDocumentsByTag: <TDocument extends PrismicDocument<Recor
 declare const useAllPrismicDocumentsByTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tag: string, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
     limit?: number | undefined;
 } & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
  * A composable that queries documents from the Prismic repository with specific
@@ -1397,15 +1294,7 @@ declare const useAllPrismicDocumentsByTag: <TDocument extends PrismicDocument<Re
  * @see Underlying `@prismicio/client` method {@link Client.getByTags}
  */
 declare const usePrismicDocumentsByEveryTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
  * A composable that queries all documents from the Prismic repository with
@@ -1426,15 +1315,7 @@ declare const usePrismicDocumentsByEveryTag: <TDocument extends PrismicDocument<
 declare const useAllPrismicDocumentsByEveryTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
     limit?: number | undefined;
 } & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
  * A composable that queries documents from the Prismic repository with specific
@@ -1453,15 +1334,7 @@ declare const useAllPrismicDocumentsByEveryTag: <TDocument extends PrismicDocume
  * @see Underlying `@prismicio/client` method {@link Client.getByTags}
  */
 declare const usePrismicDocumentsBySomeTags: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
 /**
  * A composable that queries all documents from the Prismic repository with
@@ -1483,15 +1356,7 @@ declare const usePrismicDocumentsBySomeTags: <TDocument extends PrismicDocument<
 declare const useAllPrismicDocumentsBySomeTags: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
     limit?: number | undefined;
 } & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 /**
  * **IMPORTANT**: Avoid using `dangerouslyUseAllPrismicDocuments` as it may be
@@ -1515,15 +1380,7 @@ declare const useAllPrismicDocumentsBySomeTags: <TDocument extends PrismicDocume
 declare const dangerouslyUseAllPrismicDocuments: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
     limit?: number | undefined;
 } & {
-    signal?: {
-        aborted: any;
-        addEventListener: any;
-        removeEventListener: any;
-        dispatchEvent: any;
-        onabort: any;
-        reason: any;
-        throwIfAborted: any;
-    } | undefined;
+    signal?: _prismicio_client.AbortSignalLike | undefined;
 } & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
 
 /**

package/dist/index.js

@@ -65,7 +65,10 @@ const usePrismicImage = (props) => {
     const pixelDensities = unref(props.pixelDensities);
     if (widths) {
       if (!__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);
+        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 asImageWidthSrcSet(field, {
         ...imgixParams,
@@ -276,9 +279,17 @@ const PrismicLinkImpl = /* @__PURE__ */ defineComponent({
     const { type, href, target, rel } = usePrismicLink(props);
     return () => {
       const parent = type.value === "a" ? "a" : simplyResolveComponent(type.value);
-      const computedSlots = getSlots(parent, slots, reactive({ href: href.value }));
+      const computedSlots = getSlots(
+        parent,
+        slots,
+        reactive({ href: href.value })
+      );
       if (typeof parent === "string") {
-        return h(parent, { href: href.value, target: target.value, rel: rel.value }, computedSlots);
+        return h(
+          parent,
+          { href: href.value, target: target.value, rel: rel.value },
+          computedSlots
+        );
       } else {
         return h(parent, { to: href.value }, computedSlots);
       }
@@ -409,13 +420,19 @@ const PrismicRichTextImpl = /* @__PURE__ */ defineComponent({
         }
       };
       const removeListeners = () => {
-        links.forEach(({ element, listener }) => element.removeEventListener("click", listener));
+        links.forEach(
+          ({ element, listener }) => element.removeEventListener("click", listener)
+        );
         links = [];
       };
-      watch(html, () => {
-        removeListeners();
-        nextTick(addListeners);
-      }, { immediate: true });
+      watch(
+        html,
+        () => {
+          removeListeners();
+          nextTick(addListeners);
+        },
+        { immediate: true }
+      );
       onBeforeUnmount(() => {
         removeListeners();
       });
@@ -452,15 +469,24 @@ const TODOSliceComponent = __PRODUCTION__ ? () => null : /* @__PURE__ */ defineC
   name: "TODOSliceComponent",
   props: getSliceComponentProps(),
   setup(props) {
-    const type = computed(() => "slice_type" in props.slice ? props.slice.slice_type : props.slice.type);
+    const type = computed(
+      () => "slice_type" in props.slice ? props.slice.slice_type : props.slice.type
+    );
     watchEffect(() => {
-      console.warn(`[SliceZone] Could not find a component for Slice type "${type.value}"`, props.slice);
+      console.warn(
+        `[SliceZone] Could not find a component for Slice type "${type.value}"`,
+        props.slice
+      );
     });
     return () => {
-      return h("section", {
-        "data-slice-zone-todo-component": "",
-        "data-slice-type": type.value
-      }, [`Could not find a component for Slice type "${type.value}"`]);
+      return h(
+        "section",
+        {
+          "data-slice-zone-todo-component": "",
+          "data-slice-type": type.value
+        },
+        [`Could not find a component for Slice type "${type.value}"`]
+      );
     };
   }
 });
@@ -469,7 +495,9 @@ const defineSliceZoneComponents = (components) => {
   let type;
   for (type in components) {
     const component = components[type];
-    result[type] = typeof component === "string" ? component : markRaw(component);
+    result[type] = typeof component === "string" ? component : markRaw(
+      component
+    );
   }
   return result;
 };
@@ -526,8 +554,9 @@ const SliceZoneImpl = /* @__PURE__ */ defineComponent({
             component = resolvedComponent;
           }
         }
+        const key = "id" in slice && slice.id ? slice.id : `${index}-${JSON.stringify(slice)}`;
         const p = {
-          key: `${index}-${JSON.stringify(slice)}`,
+          key,
           slice,
           index,
           context: props.context,
@@ -578,7 +607,11 @@ const createPrismic = (options) => {
   const prismicHelpers = {
     asText,
     asHTML: (richTextField, linkResolver, htmlSerializer) => {
-      return asHTML(richTextField, linkResolver || options.linkResolver, htmlSerializer || options.htmlSerializer);
+      return asHTML(
+        richTextField,
+        linkResolver || options.linkResolver,
+        htmlSerializer || options.htmlSerializer
+      );
     },
     asLink: (linkField, linkResolver) => {
       return asLink(linkField, linkResolver || options.linkResolver);
@@ -622,7 +655,9 @@ const isParams = (value) => {
 };
 const useStatefulPrismicClientMethod = (methodName, args) => {
   const { client } = usePrismic();
-  const state = ref(PrismicClientComposableState.Idle);
+  const state = ref(
+    PrismicClientComposableState.Idle
+  );
   const data = shallowRef(null);
   const error = ref(null);
   const refresh = async () => {
@@ -633,7 +668,10 @@ const useStatefulPrismicClientMethod = (methodName, args) => {
     data.value = null;
     error.value = null;
     try {
-      data.value = await (unref(explicitClient) || client)[methodName](...argsWithoutParams.map((arg) => unref(arg)), params);
+      data.value = await (unref(explicitClient) || client)[methodName](
+        ...argsWithoutParams.map((arg) => unref(arg)),
+        params
+      );
       state.value = PrismicClientComposableState.Success;
     } catch (err) {
       state.value = PrismicClientComposableState.Error;