feat: support visual editing

[rdunk]

This PR provides a method for implementing Sanity visual editing in Nuxt applications.

Current Progress

• Support visual editing using useSanityQuery and CSM
• Support "basic" visual editing using useAsyncData and client.fetch
• Update playground
• Update tests
• Update documentation

[netlify]

✅ Deploy Preview for nuxt-sanity-module ready!

Name	Link
🔨 Latest commit	85a654f
🔍 Latest deploy log	https://app.netlify.com/sites/nuxt-sanity-module/deploys/65e8bbbefeab54000855ca11
😎 Deploy Preview	https://deploy-preview-949--nuxt-sanity-module.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[rdunk]

Looks like the type tests are failing, the generated RuntimeConfig and PublicRuntimeConfig override those declared in index.d.ts.

Potentially relevant issue: nuxt/nuxt#20379

[danielroe]

This PR is great! Thank you so much for the phenomenal work here.

Sorry to have just pushed changes - mostly a result of my lack of time.

If you have a chance to review, would you see if I've unwittingly undone something you set for a good reason? 🙏

[blowsie]

refs #934

[rdunk]

Think this is good to go pending documentation.

[nuxt-studio]

✅ Live Preview ready!

Name	Edit	Preview	Latest Commit
Sanity	Edit on Studio ↗︎	View Live Preview	85a654f

[rdunk]

Some minimal docs are up, I figured best to get this shipped and adjust and improve those accordingly. Let me know if you'd like them structured differently. Also snuck in a few last minute changes to the configuration based on some internal conversations. Ready for a final review!

(Can I leave merge/release up to you @danielroe?)

[danielroe]

Perfect!

[timbenniks]

Hey all, I'm super excited about this feature, when will there be a release to NPM in which I can use visual editing?

[danielroe]

There's a beta release at @nuxtjs/sanity@beta you can try out. There's currently a few niggles with Vite + the newer sanity dependencies that will require us to handle optimizeDeps (probably?)

[timbenniks]

You are correct. I just had a look with beta 1.9.0 but I can't get it to run.

I have this in my Nuxt config:

vite: {
  optimizeDeps: { exclude: ["parse-headers"] }
},

[danielroe]

You probably need to include it. But you will find a rabbit hole down there. If you get a chance and get something working, do let me know. One main issue is that in order for optimising deps with shamefully-hoist=false, they have to be explicitly installed. (And these are sub deps of sub deps which makes it a real pain.)

One avenue to explore is that this is not an issue in the module repository which suggests that something about the config (maybe another package being installed?) avoids the issue. But I need to make some time to investigate.

[timbenniks]

The deeper I dive, the weirder it gets!

I try this to see if i can get any further: https://www.sanity.io/docs/nuxt-loader

[rdunk]

@timbenniks Best not to go down the @sanity/nuxt-loader path! We will be deprecating that package in favour of this module as soon as we have a stable release.

[danielroe]

Released! Please do let me know if you encounter any niggles. 🙏

[timbenniks]

Hey all, using "@nuxtjs/sanity": "^1.10.1" I still get similar issues as described above.

[blowsie]

Hey all, using "@nuxtjs/sanity": "^1.10.1" I still get similar issues as described above.

Im not familiar with the issue you are encountering, but this may help you get started
https://github.com/sanity-io/sanity-template-nuxt-clean