@devite/nuxt-sanity 2.5.1 → 2.5.3

package/README.md

@@ -14,6 +14,29 @@ npx nuxi module add @devite/nuxt-sanity
 
 That's it! You can now use Sanity with your Nuxt app ✨
 
+## Configuration
+
+Further configuration can be done in the `nuxt.config.ts` file:
+
+```ts
+export default {
+  modules: [
+    '@devite/nuxt-sanity',
+    "@nuxt/image"
+  ],
+  sanity: {
+    projectId: 'YOUR_PROJECT_ID',
+    dataset: 'YOUR_DATASET',
+    ...
+  },
+  runtimeConfig: {
+    public: {
+      // Required for SanityPage component to set a correct "canonical" url
+      baseUrl: "https://www.example.com"
+    }
+  }
+};
+```
 
 ## Contribution
 
@@ -49,8 +72,10 @@ That's it! You can now use Sanity with your Nuxt app ✨
 </details>
 
 <!-- Links -->
+
 [nuxt-sanity]: https://github.com/nuxt-modules/sanity
 
 <!-- Badges -->
+
 [npm-version-src]: https://img.shields.io/npm/v/@devite/nuxt-sanity/latest.svg?style=flat&colorA=020420&colorB=00DC82
 [npm-version-href]: https://npmjs.com/package/@devite/nuxt-sanity

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@devite/nuxt-sanity",
-  "version": "2.5.1",
+  "version": "2.5.3",
   "configKey": "sanity",
   "builder": {
     "@nuxt/module-builder": "0.8.4",

package/dist/module.mjs

@@ -3,7 +3,7 @@ import { defineNuxtModule, createResolver, addPlugin, addServerHandler, addImpor
 import defu from 'defu';
 
 const name = "@devite/nuxt-sanity";
-const version = "2.5.1";
+const version = "2.5.3";
 
 const CONFIG_KEY = "sanity";
 const module = defineNuxtModule({

package/dist/runtime/components/SanityPage.vue

@@ -31,11 +31,11 @@ if (sanityData.value?._type === 'notFound' && import.meta.server) {
     setResponseStatus(event, 404)
 }
 
-const { baseURL } = useRuntimeConfig().public
+const { baseURL: baseUrl } = useRuntimeConfig().public
 const seo = computed(() => sanityData.value?.seo)
 const url = computed(
   () =>
-    ((baseURL as string) || '')
+    ((baseUrl as string) || '')
     + ((sanityData.value && ('slug' in sanityData.value ? sanityData.value.slug.current : null)) || '/'),
 )
 

package/dist/runtime/plugins/visual-editing.js

@@ -1,11 +1,6 @@
 import { useSanityVisualEditingState } from "../composables/useSanityVisualEditingState.js";
-import { useSanityLiveMode } from "../composables/useSanityLiveMode.js";
-import { useSanityVisualEditing } from "../composables/useSanityVisualEditing.js";
-import {
-  defineNuxtPlugin,
-  useCookie,
-  useRuntimeConfig
-} from "#imports";
+import useSanityClient from "../utils/useSanityClient.js";
+import { defineNuxtPlugin, useCookie, useRuntimeConfig } from "#imports";
 export default defineNuxtPlugin(async () => {
   const visualEditingState = useSanityVisualEditingState();
   const $config = useRuntimeConfig();
@@ -20,11 +15,14 @@ export default defineNuxtPlugin(async () => {
     switch (visualEditing?.mode) {
       case "live-visual-editing":
       case "visual-editing":
-        useSanityVisualEditing({
+        import("../utils/visualEditing/enableVisualEditing.js").then(({ enableVisualEditing }) => enableVisualEditing({
           refresh: visualEditing?.refresh,
           zIndex: visualEditing?.zIndex
-        });
-        if (visualEditing?.mode === "live-visual-editing") await useSanityLiveMode();
+        }));
+        if (visualEditing?.mode === "live-visual-editing") {
+          const client = await useSanityClient(true, "default", $config.public.sanity);
+          client.queryStore?.enableLiveMode({ client: client.client });
+        }
         break;
     }
   }

package/dist/runtime/utils/projections.js

@@ -19,5 +19,5 @@ export const IMAGE_WITH_PREVIEW_PROJECTION = groq`{
 export const LINK_PROJECTION = groq`{
   '_type': @._type,
   _type == 'linkExternal' => { url, newWindow },
-  _type == 'linkInternal' => { 'slug': coalesce(@.reference->slug.current, '/') }
+  _type == 'linkInternal' => { 'slug': '/' + coalesce(@.reference->slug.current, '') }
 }`;

package/dist/runtime/utils/resolveInternalLink.js

@@ -1,7 +1,7 @@
 import { useSanityQuery } from "#imports";
 export const resolveInternalLink = async (reference) => {
   return (await useSanityQuery(
-    `*[_id == $documentId][0] { '_type': 'linkInternal', 'slug': coalesce(slug.current, '/') }`,
+    `*[_id == $documentId][0] { '_type': 'linkInternal', 'slug': '/' + coalesce(slug.current, '') }`,
     { documentId: reference._ref }
   )).data;
 };

package/dist/runtime/{composables/useSanityVisualEditing.d.ts → utils/visualEditing/enableVisualEditing.d.ts}

@@ -5,4 +5,4 @@ export interface VisualEditingProps {
     zIndex?: VisualEditingOptions['zIndex'];
 }
 /** @return A function to disable visual editing */
-export declare const useSanityVisualEditing: (options?: VisualEditingProps) => DisableVisualEditing;
+export declare function enableVisualEditing(options?: VisualEditingProps): DisableVisualEditing;

package/dist/runtime/{composables/useSanityVisualEditing.js → utils/visualEditing/enableVisualEditing.js}

@@ -1,13 +1,12 @@
-import { enableVisualEditing } from "@sanity/visual-editing";
-import { onScopeDispose } from "vue";
+import { enableVisualEditing as enableSanityVisualEditing } from "@sanity/visual-editing";
 import { reloadNuxtApp, useRouter } from "#imports";
-export const useSanityVisualEditing = (options = {}) => {
+export function enableVisualEditing(options = {}) {
   const { refresh, zIndex } = options;
   let disable = () => {
   };
   if (import.meta.client) {
     const router = useRouter();
-    disable = enableVisualEditing({
+    disable = enableSanityVisualEditing({
       zIndex,
       refresh: (payload) => {
         function refreshDefault() {
@@ -39,6 +38,5 @@ export const useSanityVisualEditing = (options = {}) => {
       }
     });
   }
-  onScopeDispose(disable);
   return disable;
-};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devite/nuxt-sanity",
-  "version": "2.5.1",
+  "version": "2.5.3",
   "description": "Advanced Sanity integration for Nuxt.js.",
   "repository": "devite-io/nuxt-sanity",
   "license": "MIT",

package/dist/runtime/composables/useSanityLiveMode.d.ts

@@ -1 +0,0 @@
-export declare const useSanityLiveMode: () => Promise<() => void>;

package/dist/runtime/composables/useSanityLiveMode.js

@@ -1,12 +0,0 @@
-import useSanityClient from "../utils/useSanityClient.js";
-import { useRuntimeConfig } from "#imports";
-export const useSanityLiveMode = async () => {
-  if (import.meta.client) {
-    const client = await useSanityClient(true, "default", useRuntimeConfig().public.sanity);
-    if (client.queryStore) {
-      return client.queryStore.enableLiveMode({ client: client.client });
-    }
-  }
-  return () => {
-  };
-};