Support for using the configured Sanity client in nuxt.config.js

[mornir]

When generating dynamic routes, I need the Sanity client to fetch all routes. Is there a way I can access the configured client in nuxt.config.js? Or do I need to import it and configure it again?

[danielroe]

This is an interesting idea. Would importing a createClient helper that returns an auto configured client (based on the settings in nuxt.config) suit your use-case?

Proposed use:

import { createClient } from '@nuxtjs/sanity'

const client = createClient()

export default {
  // ...
}

[mornir]

Yes, that would perfect for my use case 👍

[mornir]

I had a look at the code. Actually there's already a helper function exported. So I can do this:

import { createClient } from '@nuxtjs/sanity'
export const configSanity = {
  projectId: 'xxxxxxx',
  withCredentials: true,
  useCdn: false,
  minimal: true,
}
const client = createClient(configSanity)
export default { 
 // nuxt config....
   sanity: {
      ...configSanity,
    },
}

I see that only the main nuxtModule function has access to the moduleOptions. So I guess it's not that easy to export an auto-configured client? If I want to submit a contribution with this enhancement, where should I start in the code?

[arlenpeiffer]

+1 to this idea

[danielroe]

The createClient function will create a minimal client. The challenge is that a lot of the configuration of the client comes from the nuxt.config file and so using it within the file runs the risk of circular dependency. If you're happy to redefine the configuration it should be possible to do:

// for minimal client
import { createClient } from '@nuxtjs/sanity'
// for official Sanity client
import createClient from '@sanity/client'

const client = createClient({
  projectId: 'xxxxxxx',
  withCredentials: true,
  useCdn: false,
})

// ... use client

Do you think this is straightforward enough? It doesn't feel that inconvenient to me, but I'm open to being persuaded otherwise.

[mornir]

Yes, this is what I'm doing and it's perfectly fine 😉 I'll submit a pull request to document it.