next-sanity 4.3.0 → 4.3.2

package/README.md

@@ -14,6 +14,7 @@
 - [Installation](#installation)
 - [`next-sanity` Running groq queries](#next-sanity-running-groq-queries)
   - [`appDir`, React Server Components and caching](#appdir-react-server-components-and-caching)
+- [`next-sanity` Visual Editing with Content Source Maps](#next-sanity-visual-editing-with-content-source-maps)
 - [`next-sanity/preview` Live real-time preview](#next-sanitypreview-live-real-time-preview)
   - [Examples](#examples)
     - [Built-in Sanity auth](#built-in-sanity-auth)
@@ -64,22 +65,12 @@ pnpm install next-sanity @portabletext/react @sanity/image-url
 
 ### `next-sanity/studio` peer dependencies
 
-When using `npm` newer than `v7` you should end up with needed dependencies like `sanity` and `styled-components` when you `npm install next-sanity`. For other package managers you may need to do some extra steps.
-
-#### Yarn
+When using `npm` newer than `v7`, or `pnpm` newer than `v8`, you should end up with needed dependencies like `sanity` and `styled-components` when you `npm install next-sanity`. It also works in `yarn` `v1` using `install-peerdeps`:
 
 ```bash
 npx install-peerdeps --yarn next-sanity
 ```
 
-#### pnpm
-
-You can either setup [`auto-install-peers`](https://stackoverflow.com/questions/72468635/pnpm-peer-dependencies-auto-install/74835069#74835069) and `pnpm install next-sanity` is enough, or:
-
-```bash
-npx install-peerdeps --pnpm next-sanity
-```
-
 ## `next-sanity` Running groq queries
 
 ```ts
@@ -87,7 +78,7 @@ import {createClient, groq} from 'next-sanity'
 
 const projectId = process.env.NEXT_PUBLIC_SANITY_PROJECT_ID // "pv8y60vp"
 const dataset = process.env.NEXT_PUBLIC_SANITY_DATASET // "production"
-const apiVersion = process.env.NEXT_PUBLIC_SANITY_API_VERSION // "2022-11-16"
+const apiVersion = process.env.NEXT_PUBLIC_SANITY_API_VERSION // "2023-05-03"
 
 const client = createClient({
   projectId,
@@ -109,7 +100,7 @@ import {cache} from 'react'
 
 const projectId = process.env.NEXT_PUBLIC_SANITY_PROJECT_ID // "pv8y60vp"
 const dataset = process.env.NEXT_PUBLIC_SANITY_DATASET // "production"
-const apiVersion = process.env.NEXT_PUBLIC_SANITY_API_VERSION // "2022-11-16"
+const apiVersion = process.env.NEXT_PUBLIC_SANITY_API_VERSION // "2023-05-03"
 
 const client = createClient({
   projectId,
@@ -127,6 +118,33 @@ const data = await clientFetch(groq`*[]`)
 const total = await clientFetch<number>(groq`count*()`)
 ```
 
+## `next-sanity` Visual Editing with Content Source Maps
+
+> **Note**
+>
+> [Content Source Maps][content-source-maps-intro] are available [as an API][content-source-maps] for select [Sanity enterprise customers][enterprise-cta]. [Contact our sales team for more information.][sales-cta]
+
+The `createClient` method in `next-sanity` supports [visual editing][visual-editing-intro], it supports all the same options as [`@sanity/preview-kit/client`][preview-kit-client]. Add `studioUrl` to your client configuration and it'll automatically show up on Vercel Preview Deployments:
+
+```tsx
+import {createClient, groq} from 'next-sanity'
+
+const projectId = process.env.NEXT_PUBLIC_SANITY_PROJECT_ID // "pv8y60vp"
+const dataset = process.env.NEXT_PUBLIC_SANITY_DATASET // "production"
+const apiVersion = process.env.NEXT_PUBLIC_SANITY_API_VERSION // "2023-05-03"
+
+const client = createClient({
+  projectId,
+  dataset,
+  apiVersion, // https://www.sanity.io/docs/api-versioning
+  useCdn: true, // if you're using ISR or only static generation at build time then you can set this to `false` to guarantee no stale content
+  studioUrl: '/studio', // Or: 'https://my-cool-project.sanity.studio'
+  encodeSourceMap: true, // Optional. Default to: process.env.NEXT_PUBLIC_VERCEL_ENV === 'preview',
+})
+```
+
+[Our setup guide walks you through how to customize the experience.][visual-editing]
+
 ## `next-sanity/preview` Live real-time preview
 
 You can implement real-time client side preview using `definePreview`. It works by streaming the whole dataset to the browser, which it keeps updated using [listeners](https://www.sanity.io/docs/realtime-updates) and Mendoza patches. When it receives updates, then the query is run against the client-side datastore using [groq-js](https://github.com/sanity-io/groq-js).
@@ -195,7 +213,7 @@ import {createClient} from 'next-sanity'
 
 const projectId = process.env.NEXT_PUBLIC_SANITY_PROJECT_ID // "pv8y60vp"
 const dataset = process.env.NEXT_PUBLIC_SANITY_DATASET // "production"
-const apiVersion = process.env.NEXT_PUBLIC_SANITY_API_VERSION // "2022-11-16"
+const apiVersion = process.env.NEXT_PUBLIC_SANITY_API_VERSION // "2023-05-03"
 
 export const client = createClient({projectId, dataset, apiVersion})
 ```
@@ -372,7 +390,7 @@ import {createClient} from 'next-sanity'
 
 const projectId = process.env.NEXT_PUBLIC_SANITY_PROJECT_ID // "pv8y60vp"
 const dataset = process.env.NEXT_PUBLIC_SANITY_DATASET // "production"
-const apiVersion = process.env.NEXT_PUBLIC_SANITY_API_VERSION // "2022-11-16"
+const apiVersion = process.env.NEXT_PUBLIC_SANITY_API_VERSION // "2023-05-03"
 
 export const client = createClient({projectId, dataset, apiVersion})
 ```
@@ -897,3 +915,11 @@ Semantic release will only release on configured branches, so it is safe to run
 ## License
 
 MIT-licensed. See [LICENSE](LICENSE).
+
+[visual-editing]: https://www.sanity.io/docs/vercel-visual-editing?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch
+[visual-editing-intro]: https://www.sanity.io/blog/visual-editing-sanity-vercel?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch
+[content-source-maps]: https://www.sanity.io/docs/content-source-maps?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch
+[content-source-maps-intro]: https://www.sanity.io/blog/content-source-maps-announce?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch
+[preview-kit-client]: https://github.com/sanity-io/preview-kit#sanitypreview-kitclient
+[sales-cta]: https://www.sanity.io/contact/sales?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch
+[enterprise-cta]: https://www.sanity.io/enterprise?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../src/client.ts"],"sourcesContent":["import {\n  type ClientConfig as _ClientConfig,\n  createClient as _createClient,\n} from '@sanity/preview-kit/client'\n\nexport type * from '@sanity/preview-kit/client'\n\n/** @public */\nexport interface ClientConfig extends Omit<_ClientConfig, 'studioUrl' | 'encodeSourceMap'> {\n  /**\n   * Where the Studio is hosted.\n   * If it's embedded in the app, use the base path for example `/studio`.\n   * Otherwise provide the full URL to where the Studio is hosted, for example: `https://blog.sanity.studio`.\n   * @defaultValue process.env.NEXT_PUBLIC_SANITY_STUDIO_URL\n   * @alpha\n   */\n  studioUrl?: _ClientConfig['studioUrl']\n  /**\n   * If there's no `studioUrl` then the default value is `none` and the normal `@sanity/client` will be used. If `studioUrl` is set, then it's `auto` by default.\n   * @defaultValue process.env.MEXT_PUBLIC_SANITY_SOURCE_MAP || studioUrl ? 'auto' : 'none'\n   * @alpha\n   */\n  encodeSourceMap?: _ClientConfig['encodeSourceMap']\n}\n\n/**\n * @public\n */\nexport function createClient(config: ClientConfig): ReturnType<typeof _createClient> {\n  let {\n    // eslint-disable-next-line prefer-const, no-process-env\n    studioUrl = process.env.NEXT_PUBLIC_SANITY_STUDIO_URL! as _ClientConfig['studioUrl'],\n    encodeSourceMap = (studioUrl ? 'auto' : false) satisfies _ClientConfig['encodeSourceMap'],\n  } = config\n  // eslint-disable-next-line no-process-env\n  if (encodeSourceMap === 'auto' && process.env.NEXT_PUBLIC_VERCEL_ENV === 'preview') {\n    encodeSourceMap = true\n  }\n  return _createClient({...config, studioUrl, encodeSourceMap})\n}\n"],"names":["createClient","config","studioUrl","process","env","NEXT_PUBLIC_SANITY_STUDIO_URL","encodeSourceMap","NEXT_PUBLIC_VERCEL_ENV","_createClient"],"mappings":";;;;;;;;;;;;;AA4BO,SAASA,aAAaC,MAAwD,EAAA;EAC/E,IAAA;IAAA;IAEFC,SAAA,GAAYC,QAAQC,GAAI,CAAAC,6BAAA;IACxBC,eAAA,GAAmBJ,YAAY,MAAS,GAAA;EACtC,CAAA,GAAAD,MAAA;EAEJ,IAAIK,eAAoB,KAAA,MAAA,IAAUH,OAAQ,CAAAC,GAAA,CAAIG,2BAA2B,SAAW,EAAA;IAChED,eAAA,GAAA,IAAA;EACpB;EACA,OAAOE,MAAAA,CAAAA,aAAc;IAAC,GAAGP,MAAQ;IAAAC,SAAA;IAAWI;EAAgB,CAAA,CAAA;AAC9D;;;;;;;"}
+{"version":3,"file":"index.cjs","sources":["../src/client.ts"],"sourcesContent":["import {\n  type ClientConfig as _ClientConfig,\n  createClient as _createClient,\n} from '@sanity/preview-kit/client'\n\nexport type * from '@sanity/preview-kit/client'\n\n/** @public */\nexport interface ClientConfig extends Omit<_ClientConfig, 'studioUrl' | 'encodeSourceMap'> {\n  /**\n   * Where the Studio is hosted.\n   * If it's embedded in the app, use the base path for example `/studio`.\n   * Otherwise provide the full URL to where the Studio is hosted, for example: `https://blog.sanity.studio`.\n   * @defaultValue process.env.NEXT_PUBLIC_SANITY_STUDIO_URL\n   * @alpha\n   */\n  studioUrl?: _ClientConfig['studioUrl']\n  /**\n   * If there's no `studioUrl` then the default value is `none` and the normal `@sanity/client` will be used. If `studioUrl` is set, then it's `auto` by default.\n   * @defaultValue process.env.MEXT_PUBLIC_SANITY_SOURCE_MAP || studioUrl ? 'auto' : 'none'\n   * @alpha\n   */\n  encodeSourceMap?: _ClientConfig['encodeSourceMap']\n}\n\n/** @public */\nexport type SanityClient = ReturnType<typeof _createClient>\n\n/**\n * @public\n */\nexport function createClient(config: ClientConfig): SanityClient {\n  let {\n    // eslint-disable-next-line prefer-const, no-process-env\n    studioUrl = process.env.NEXT_PUBLIC_SANITY_STUDIO_URL! as _ClientConfig['studioUrl'],\n    encodeSourceMap = (studioUrl ? 'auto' : false) satisfies _ClientConfig['encodeSourceMap'],\n  } = config\n  // eslint-disable-next-line no-process-env\n  if (encodeSourceMap === 'auto' && process.env.NEXT_PUBLIC_VERCEL_ENV === 'preview') {\n    encodeSourceMap = true\n  }\n  return _createClient({...config, studioUrl, encodeSourceMap})\n}\n"],"names":["createClient","config","studioUrl","process","env","NEXT_PUBLIC_SANITY_STUDIO_URL","encodeSourceMap","NEXT_PUBLIC_VERCEL_ENV","_createClient"],"mappings":";;;;;;;;;;;;;AA+BO,SAASA,aAAaC,MAAoC,EAAA;EAC3D,IAAA;IAAA;IAEFC,SAAA,GAAYC,QAAQC,GAAI,CAAAC,6BAAA;IACxBC,eAAA,GAAmBJ,YAAY,MAAS,GAAA;EACtC,CAAA,GAAAD,MAAA;EAEJ,IAAIK,eAAoB,KAAA,MAAA,IAAUH,OAAQ,CAAAC,GAAA,CAAIG,2BAA2B,SAAW,EAAA;IAChED,eAAA,GAAA,IAAA;EACpB;EACA,OAAOE,MAAAA,CAAAA,aAAc;IAAC,GAAGP,MAAQ;IAAAC,SAAA;IAAWI;EAAgB,CAAA,CAAA;AAC9D;;;;;;;"}

package/dist/index.d.ts

@@ -24,10 +24,13 @@ export declare interface ClientConfig
 /**
  * @public
  */
-export declare function createClient(config: ClientConfig): ReturnType<typeof createClient_2>
+export declare function createClient(config: ClientConfig): SanityClient
 
 export {groq}
 
+/** @public */
+export declare type SanityClient = ReturnType<typeof createClient_2>
+
 export * from '@sanity/preview-kit/client'
 
 export {}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/client.ts"],"sourcesContent":["import {\n  type ClientConfig as _ClientConfig,\n  createClient as _createClient,\n} from '@sanity/preview-kit/client'\n\nexport type * from '@sanity/preview-kit/client'\n\n/** @public */\nexport interface ClientConfig extends Omit<_ClientConfig, 'studioUrl' | 'encodeSourceMap'> {\n  /**\n   * Where the Studio is hosted.\n   * If it's embedded in the app, use the base path for example `/studio`.\n   * Otherwise provide the full URL to where the Studio is hosted, for example: `https://blog.sanity.studio`.\n   * @defaultValue process.env.NEXT_PUBLIC_SANITY_STUDIO_URL\n   * @alpha\n   */\n  studioUrl?: _ClientConfig['studioUrl']\n  /**\n   * If there's no `studioUrl` then the default value is `none` and the normal `@sanity/client` will be used. If `studioUrl` is set, then it's `auto` by default.\n   * @defaultValue process.env.MEXT_PUBLIC_SANITY_SOURCE_MAP || studioUrl ? 'auto' : 'none'\n   * @alpha\n   */\n  encodeSourceMap?: _ClientConfig['encodeSourceMap']\n}\n\n/**\n * @public\n */\nexport function createClient(config: ClientConfig): ReturnType<typeof _createClient> {\n  let {\n    // eslint-disable-next-line prefer-const, no-process-env\n    studioUrl = process.env.NEXT_PUBLIC_SANITY_STUDIO_URL! as _ClientConfig['studioUrl'],\n    encodeSourceMap = (studioUrl ? 'auto' : false) satisfies _ClientConfig['encodeSourceMap'],\n  } = config\n  // eslint-disable-next-line no-process-env\n  if (encodeSourceMap === 'auto' && process.env.NEXT_PUBLIC_VERCEL_ENV === 'preview') {\n    encodeSourceMap = true\n  }\n  return _createClient({...config, studioUrl, encodeSourceMap})\n}\n"],"names":["createClient","config","studioUrl","process","env","NEXT_PUBLIC_SANITY_STUDIO_URL","encodeSourceMap","NEXT_PUBLIC_VERCEL_ENV","_createClient"],"mappings":";;AA4BO,SAASA,aAAaC,MAAwD,EAAA;EAC/E,IAAA;IAAA;IAEFC,SAAA,GAAYC,QAAQC,GAAI,CAAAC,6BAAA;IACxBC,eAAA,GAAmBJ,YAAY,MAAS,GAAA;EACtC,CAAA,GAAAD,MAAA;EAEJ,IAAIK,eAAoB,KAAA,MAAA,IAAUH,OAAQ,CAAAC,GAAA,CAAIG,2BAA2B,SAAW,EAAA;IAChED,eAAA,GAAA,IAAA;EACpB;EACA,OAAOE,eAAc;IAAC,GAAGP,MAAQ;IAAAC,SAAA;IAAWI;EAAgB,CAAA,CAAA;AAC9D;"}
+{"version":3,"file":"index.js","sources":["../src/client.ts"],"sourcesContent":["import {\n  type ClientConfig as _ClientConfig,\n  createClient as _createClient,\n} from '@sanity/preview-kit/client'\n\nexport type * from '@sanity/preview-kit/client'\n\n/** @public */\nexport interface ClientConfig extends Omit<_ClientConfig, 'studioUrl' | 'encodeSourceMap'> {\n  /**\n   * Where the Studio is hosted.\n   * If it's embedded in the app, use the base path for example `/studio`.\n   * Otherwise provide the full URL to where the Studio is hosted, for example: `https://blog.sanity.studio`.\n   * @defaultValue process.env.NEXT_PUBLIC_SANITY_STUDIO_URL\n   * @alpha\n   */\n  studioUrl?: _ClientConfig['studioUrl']\n  /**\n   * If there's no `studioUrl` then the default value is `none` and the normal `@sanity/client` will be used. If `studioUrl` is set, then it's `auto` by default.\n   * @defaultValue process.env.MEXT_PUBLIC_SANITY_SOURCE_MAP || studioUrl ? 'auto' : 'none'\n   * @alpha\n   */\n  encodeSourceMap?: _ClientConfig['encodeSourceMap']\n}\n\n/** @public */\nexport type SanityClient = ReturnType<typeof _createClient>\n\n/**\n * @public\n */\nexport function createClient(config: ClientConfig): SanityClient {\n  let {\n    // eslint-disable-next-line prefer-const, no-process-env\n    studioUrl = process.env.NEXT_PUBLIC_SANITY_STUDIO_URL! as _ClientConfig['studioUrl'],\n    encodeSourceMap = (studioUrl ? 'auto' : false) satisfies _ClientConfig['encodeSourceMap'],\n  } = config\n  // eslint-disable-next-line no-process-env\n  if (encodeSourceMap === 'auto' && process.env.NEXT_PUBLIC_VERCEL_ENV === 'preview') {\n    encodeSourceMap = true\n  }\n  return _createClient({...config, studioUrl, encodeSourceMap})\n}\n"],"names":["createClient","config","studioUrl","process","env","NEXT_PUBLIC_SANITY_STUDIO_URL","encodeSourceMap","NEXT_PUBLIC_VERCEL_ENV","_createClient"],"mappings":";;AA+BO,SAASA,aAAaC,MAAoC,EAAA;EAC3D,IAAA;IAAA;IAEFC,SAAA,GAAYC,QAAQC,GAAI,CAAAC,6BAAA;IACxBC,eAAA,GAAmBJ,YAAY,MAAS,GAAA;EACtC,CAAA,GAAAD,MAAA;EAEJ,IAAIK,eAAoB,KAAA,MAAA,IAAUH,OAAQ,CAAAC,GAAA,CAAIG,2BAA2B,SAAW,EAAA;IAChED,eAAA,GAAA,IAAA;EACpB;EACA,OAAOE,eAAc;IAAC,GAAGP,MAAQ;IAAAC,SAAA;IAAWI;EAAgB,CAAA,CAAA;AAC9D;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-sanity",
-  "version": "4.3.0",
+  "version": "4.3.2",
   "description": "Sanity.io toolkit for Next.js",
   "keywords": [
     "sanity",
@@ -181,7 +181,7 @@
     "@typescript-eslint/eslint-plugin": "^5.59.2",
     "autoprefixer": "^10.4.14",
     "eslint": "^8.39.0",
-    "eslint-config-next": "13.3.5-canary.5",
+    "eslint-config-next": "13.3.5-canary.6",
     "eslint-config-prettier": "^8.8.0",
     "eslint-config-sanity": "^6.0.0",
     "eslint-gitignore": "^0.1.0",
@@ -191,7 +191,7 @@
     "jest": "^29.5.0",
     "jest-environment-jsdom": "^29.5.0",
     "ls-engines": "^0.9.0",
-    "next": "13.3.5-canary.5",
+    "next": "13.3.5-canary.6",
     "postcss": "^8.4.23",
     "prettier": "^2.8.8",
     "prettier-plugin-packagejson": "^2.4.3",

package/src/client.ts

@@ -23,10 +23,13 @@ export interface ClientConfig extends Omit<_ClientConfig, 'studioUrl' | 'encodeS
   encodeSourceMap?: _ClientConfig['encodeSourceMap']
 }
 
+/** @public */
+export type SanityClient = ReturnType<typeof _createClient>
+
 /**
  * @public
  */
-export function createClient(config: ClientConfig): ReturnType<typeof _createClient> {
+export function createClient(config: ClientConfig): SanityClient {
   let {
     // eslint-disable-next-line prefer-const, no-process-env
     studioUrl = process.env.NEXT_PUBLIC_SANITY_STUDIO_URL! as _ClientConfig['studioUrl'],