next-sanity 13.0.0-cache-components.56 → 13.0.0-cache-components.57

package/dist/live/conditions/react-server/index.js

@@ -9,7 +9,7 @@ import { revalidateSyncTagsAction } from "next-sanity/live/server-actions";
 import { PHASE_PRODUCTION_BUILD } from "next/constants";
 import { preconnect } from "react-dom";
 function defineLive(config) {
-	const { client: _client, serverToken, browserToken, stega: stegaEnabled = true, strict = false } = config;
+	const { client: _client, serverToken, browserToken, strict = false } = config;
 	if (!_client) throw new Error("`client` is required for `defineLive` to function");
 	if (process.env.NODE_ENV !== "production" && !serverToken && serverToken !== false) console.warn("No `serverToken` provided to `defineLive`. This means that only published content will be fetched and respond to live events. You can silence this warning by setting `serverToken: false`.");
 	if (process.env.NODE_ENV !== "production" && !browserToken && browserToken !== false) console.warn("No `browserToken` provided to `defineLive`. This means that live previewing drafts will only work when using the Presentation Tool in your Sanity Studio. To support live previewing drafts stand-alone, provide a `browserToken`. It is shared with the browser so it should only have Viewer rights or lower. You can silence this warning by setting `browserToken: false`.");
@@ -24,7 +24,7 @@ function defineLive(config) {
 			perspective: _perspective,
 			stega: _stega
 		});
-		const stega = strict ? _stega : _stega ?? (stegaEnabled && studioUrlDefined && (await draftMode()).isEnabled);
+		const stega = strict ? _stega : _stega ?? (studioUrlDefined && (await draftMode()).isEnabled);
 		const perspective = strict ? _perspective : _perspective ?? await resolveCookiePerspective(originalPerspective === "raw" ? "published" : originalPerspective);
 		const useCdn = perspective === "published";
 		const isBuildPhase = process.env["NEXT_PHASE"] === PHASE_PRODUCTION_BUILD;

package/dist/live/conditions/react-server/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["SanityLive","SanityLiveClientComponent"],"sources":["../../../../src/live/conditions/react-server/defineLive.tsx"],"sourcesContent":["import {SanityLive as SanityLiveClientComponent} from 'next-sanity/live/client-components'\nimport {revalidateSyncTagsAction} from 'next-sanity/live/server-actions'\nimport {PHASE_PRODUCTION_BUILD} from 'next/constants'\nimport {cookies, draftMode} from 'next/headers'\nimport {preconnect} from 'react-dom'\n\nimport {cacheTagPrefix} from '#live/constants'\nimport {resolvePerspectiveFromCookies} from '#live/resolvePerspectiveFromCookies'\nimport {validateStrictFetchOptions, validateStrictSanityLiveProps} from '#live/strictValidation'\nimport type {\n  DefinedFetchType,\n  DefinedLiveProps,\n  DefineLiveOptions,\n  LivePerspective,\n  StrictDefinedFetchType,\n  StrictDefinedLiveProps,\n} from '#live/types'\n\n/**\n * Set up Sanity Live for Cache Components. `defineLive` returns `sanityFetch`\n * and `<SanityLive />`, which connect your Sanity client to the Live Content API\n * so cached pages can update in response to fine-grained content changes.\n *\n * With `strict: true`, `perspective` and `stega` become required\n * `sanityFetch` options, and `includeDrafts` becomes required on\n * `<SanityLive />`. Resolve dynamic values from `draftMode()` and `cookies()`\n * outside `'use cache'` boundaries, then pass them into cached components.\n *\n * @see [Live Content API](https://www.sanity.io/docs/content-lake/live-content-api)\n * @see [Sanity Live](https://www.sanity.io/live)\n *\n * @example\n * ```tsx\n * // sanity/live.ts\n * import {cookies, draftMode} from 'next/headers'\n * import {createClient} from 'next-sanity'\n * import {\n *   defineLive,\n *   resolvePerspectiveFromCookies,\n *   type LivePerspective,\n * } from 'next-sanity/live'\n *\n * const client = createClient({\n *   projectId: process.env.NEXT_PUBLIC_SANITY_PROJECT_ID,\n *   dataset: process.env.NEXT_PUBLIC_SANITY_DATASET,\n *   useCdn: true,\n *   perspective: 'published',\n * })\n * const token = process.env.SANITY_API_READ_TOKEN\n *\n * export const {sanityFetch, SanityLive} = defineLive({\n *   client,\n *   browserToken: token,\n *   serverToken: token,\n *   strict: true,\n * })\n *\n * export interface DynamicFetchOptions {\n *   perspective: LivePerspective\n *   stega: boolean\n * }\n *\n * // Resolve dynamic values outside 'use cache' boundaries.\n * export async function getDynamicFetchOptions(): Promise<DynamicFetchOptions> {\n *   const {isEnabled: isDraftMode} = await draftMode()\n *   if (!isDraftMode) {\n *     return {perspective: 'published', stega: false}\n *   }\n *\n *   const jar = await cookies()\n *   const perspective = await resolvePerspectiveFromCookies({cookies: jar})\n *   return {perspective: perspective ?? 'drafts', stega: true}\n * }\n * ```\n *\n * @example\n * ```tsx\n * // app/layout.tsx\n * import {draftMode} from 'next/headers'\n *\n * import {SanityLive} from '@/sanity/live'\n *\n * export default async function RootLayout({children}: {children: React.ReactNode}) {\n *   const {isEnabled: isDraftMode} = await draftMode()\n *\n *   return (\n *     <html lang=\"en\">\n *       <body>\n *         {children}\n *         <SanityLive includeDrafts={isDraftMode} />\n *       </body>\n *     </html>\n *   )\n * }\n * ```\n *\n * @example\n * ```tsx\n * // app/[slug]/page.tsx\n * import {draftMode} from 'next/headers'\n * import {Suspense} from 'react'\n * import {defineQuery} from 'next-sanity'\n *\n * import {\n *   getDynamicFetchOptions,\n *   sanityFetch,\n *   type DynamicFetchOptions,\n * } from '@/sanity/live'\n *\n * const POSTS_SLUGS_QUERY = defineQuery(`\n *   *[_type == \"post\" && slug.current]{\"slug\": slug.current}\n * `)\n * const POST_QUERY = defineQuery(`\n *   *[_type == \"post\" && slug.current == $slug][0]\n * `)\n *\n * export async function generateStaticParams() {\n *   const {data} = await sanityFetch({\n *     query: POSTS_SLUGS_QUERY,\n *     perspective: 'published',\n *     stega: false,\n *   })\n *\n *   return data\n * }\n *\n * export default async function Page(props: PageProps<'/[slug]'>) {\n *   const {isEnabled: isDraftMode} = await draftMode()\n *   if (isDraftMode) {\n *     return (\n *       <Suspense fallback={<div>Loading...</div>}>\n *         <DynamicPage params={props.params} />\n *       </Suspense>\n *     )\n *   }\n *\n *   const {slug} = await props.params\n *   return <CachedPage slug={slug} perspective=\"published\" stega={false} />\n * }\n *\n * async function DynamicPage(props: Pick<PageProps<'/[slug]'>, 'params'>) {\n *   const {slug} = await props.params\n *   const {perspective, stega} = await getDynamicFetchOptions()\n *\n *   return <CachedPage slug={slug} perspective={perspective} stega={stega} />\n * }\n *\n * async function CachedPage({\n *   slug,\n *   perspective,\n *   stega,\n * }: {slug: string} & DynamicFetchOptions) {\n *   'use cache'\n *\n *   const {data} = await sanityFetch({\n *     query: POST_QUERY,\n *     params: {slug},\n *     perspective,\n *     stega,\n *   })\n *\n *   return <pre>{JSON.stringify(data, null, 2)}</pre>\n * }\n * ```\n *\n * @public\n */\nexport function defineLive(config: DefineLiveOptions & {strict: true}): {\n  sanityFetch: StrictDefinedFetchType\n  SanityLive: React.ComponentType<StrictDefinedLiveProps>\n}\n/**\n * Set up Sanity Live. `defineLive` returns `sanityFetch` and `<SanityLive />`,\n * which connect your Sanity client to the Live Content API so pages can serve\n * cached content and update in response to fine-grained content changes.\n *\n * @see [Live Content API](https://www.sanity.io/docs/content-lake/live-content-api)\n * @see [Sanity Live](https://www.sanity.io/live)\n *\n * @example\n * ```tsx\n * import {createClient} from 'next-sanity'\n * import {defineLive} from 'next-sanity/live'\n *\n * const client = createClient({\n *   projectId: process.env.NEXT_PUBLIC_SANITY_PROJECT_ID,\n *   dataset: process.env.NEXT_PUBLIC_SANITY_DATASET,\n *   useCdn: true,\n *   perspective: 'published',\n * })\n * const token = process.env.SANITY_API_READ_TOKEN\n *\n * export const {sanityFetch, SanityLive} = defineLive({\n *   client,\n *   browserToken: token,\n *   serverToken: token,\n * })\n * ```\n *\n * @example\n * ```tsx\n * // app/layout.tsx\n * import {SanityLive} from '@/sanity/live'\n *\n * export default function RootLayout({children}: {children: React.ReactNode}) {\n *   return (\n *     <html lang=\"en\">\n *       <body>\n *         {children}\n *         <SanityLive />\n *       </body>\n *     </html>\n *   )\n * }\n * ```\n *\n * @example\n * ```tsx\n * // app/[slug]/page.tsx\n * import {defineQuery} from 'next-sanity'\n * import {sanityFetch} from '@/sanity/live'\n *\n * const POSTS_SLUGS_QUERY = defineQuery(`\n *   *[_type == \"post\" && slug.current]{\"slug\": slug.current}\n * `)\n * const POST_QUERY = defineQuery(`\n *   *[_type == \"post\" && slug.current == $slug][0]\n * `)\n *\n * export async function generateStaticParams() {\n *   const {data} = await sanityFetch({\n *     query: POSTS_SLUGS_QUERY,\n *     perspective: 'published',\n *     stega: false,\n *   })\n *\n *   return data\n * }\n *\n * export default async function Page(props: PageProps<'/[slug]'>) {\n *   const {slug} = await props.params\n *   const {data} = await sanityFetch({\n *     query: POST_QUERY,\n *     params: {slug},\n *   })\n *\n *   return <pre>{JSON.stringify(data, null, 2)}</pre>\n * }\n * ```\n *\n * @public\n */\nexport function defineLive(config: DefineLiveOptions & {strict?: false}): {\n  sanityFetch: DefinedFetchType\n  SanityLive: React.ComponentType<DefinedLiveProps>\n}\nexport function defineLive(config: DefineLiveOptions) {\n  const {\n    client: _client,\n    serverToken,\n    browserToken,\n    stega: stegaEnabled = true,\n    strict = false,\n  } = config\n\n  if (!_client) {\n    throw new Error('`client` is required for `defineLive` to function')\n  }\n\n  if (process.env.NODE_ENV !== 'production' && !serverToken && serverToken !== false) {\n    console.warn(\n      'No `serverToken` provided to `defineLive`. This means that only published content will be fetched and respond to live events. You can silence this warning by setting `serverToken: false`.',\n    )\n  }\n\n  if (process.env.NODE_ENV !== 'production' && !browserToken && browserToken !== false) {\n    console.warn(\n      'No `browserToken` provided to `defineLive`. This means that live previewing drafts will only work when using the Presentation Tool in your Sanity Studio. To support live previewing drafts stand-alone, provide a `browserToken`. It is shared with the browser so it should only have Viewer rights or lower. You can silence this warning by setting `browserToken: false`.',\n    )\n  }\n\n  const client = _client.withConfig({allowReconfigure: false, useCdn: false})\n  const {token: originalToken, perspective: originalPerspective = 'published'} = client.config()\n  const studioUrlDefined = typeof client.config().stega.studioUrl !== 'undefined'\n\n  const sanityFetch: DefinedFetchType = async function sanityFetch({\n    query,\n    params = {},\n    stega: _stega,\n    tags = [],\n    perspective: _perspective,\n    requestTag = 'next-loader.fetch',\n  }) {\n    if (strict) {\n      validateStrictFetchOptions({perspective: _perspective, stega: _stega})\n    }\n    const stega = strict\n      ? _stega!\n      : (_stega ?? (stegaEnabled && studioUrlDefined && (await draftMode()).isEnabled))\n    const perspective = strict\n      ? _perspective!\n      : (_perspective ??\n        (await resolveCookiePerspective(\n          originalPerspective === 'raw' ? 'published' : originalPerspective,\n        )))\n    const useCdn = perspective === 'published'\n    const isBuildPhase = process.env['NEXT_PHASE'] === PHASE_PRODUCTION_BUILD\n    const cacheMode = useCdn && !isBuildPhase ? 'noStale' : undefined\n\n    // 1. Fetch the tags first, with an uncached request, but that does not count towards the Sanity API quota\n    const {syncTags} = await client.fetch(query, await params, {\n      filterResponse: false,\n      perspective,\n      stega: false,\n      returnQuery: false,\n      useCdn,\n      cacheMode,\n      tag: [requestTag, 'fetch-sync-tags'].filter(Boolean).join('.'),\n    })\n\n    const cacheTags = [...tags, ...(syncTags?.map((tag) => `${cacheTagPrefix}${tag}`) || [])]\n\n    // 2. Then fetch the data, using the fetch cache with specified tags\n    const {result, resultSourceMap} = await client.fetch(query, await params, {\n      filterResponse: false,\n      perspective,\n      stega,\n      token: perspective !== 'published' && serverToken ? serverToken : originalToken,\n      next: {revalidate: false, tags: cacheTags},\n      useCdn,\n      cacheMode,\n      tag: requestTag,\n    })\n    return {data: result, sourceMap: resultSourceMap || null, tags: cacheTags}\n  }\n\n  const SanityLive: React.ComponentType<DefinedLiveProps> = async function SanityLive(props) {\n    if (strict) {\n      validateStrictSanityLiveProps(props)\n    }\n    const {\n      includeDrafts = (await draftMode()).isEnabled,\n      requestTag = 'next-loader.live',\n      waitFor,\n\n      action,\n      onError,\n      onWelcome,\n      onReconnect,\n      onRestart,\n      onGoAway,\n    } = props\n    const {projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix} =\n      client.config()\n\n    const shouldIncludeDrafts = typeof browserToken === 'string' && includeDrafts\n    const shouldWaitFor = waitFor === 'function' && !shouldIncludeDrafts ? waitFor : undefined\n\n    // Preconnect to the Live Event API origin early, as the Sanity API is almost always on a different origin than the app\n    const {origin} = new URL(client.getUrl('', false))\n    preconnect(origin)\n\n    return (\n      <SanityLiveClientComponent\n        config={{\n          projectId,\n          dataset,\n          apiHost,\n          apiVersion,\n          useProjectHostname,\n          requestTagPrefix,\n          token: shouldIncludeDrafts ? browserToken : undefined,\n        }}\n        includeDrafts={shouldIncludeDrafts ? true : undefined}\n        requestTag={requestTag}\n        waitFor={shouldWaitFor}\n        action={action ?? (shouldWaitFor === 'function' ? 'refresh' : revalidateSyncTagsAction)}\n        onError={onError}\n        onWelcome={onWelcome}\n        onReconnect={onReconnect}\n        onRestart={onRestart}\n        onGoAway={onGoAway}\n      />\n    )\n  }\n  SanityLive.displayName = 'SanityLiveServerComponent'\n\n  return {sanityFetch, SanityLive}\n}\n\nasync function resolveCookiePerspective(fallback: LivePerspective): Promise<LivePerspective> {\n  return (await draftMode()).isEnabled\n    ? await resolvePerspectiveFromCookies({cookies: await cookies()})\n    : fallback\n}\n"],"mappings":";;;;;;;;;;AAgQA,SAAgB,WAAW,QAA2B;CACpD,MAAM,EACJ,QAAQ,SACR,aACA,cACA,OAAO,eAAe,MACtB,SAAS,UACP;AAEJ,KAAI,CAAC,QACH,OAAM,IAAI,MAAM,oDAAoD;AAGtE,KAAI,QAAQ,IAAI,aAAa,gBAAgB,CAAC,eAAe,gBAAgB,MAC3E,SAAQ,KACN,8LACD;AAGH,KAAI,QAAQ,IAAI,aAAa,gBAAgB,CAAC,gBAAgB,iBAAiB,MAC7E,SAAQ,KACN,iXACD;CAGH,MAAM,SAAS,QAAQ,WAAW;EAAC,kBAAkB;EAAO,QAAQ;EAAM,CAAC;CAC3E,MAAM,EAAC,OAAO,eAAe,aAAa,sBAAsB,gBAAe,OAAO,QAAQ;CAC9F,MAAM,mBAAmB,OAAO,OAAO,QAAQ,CAAC,MAAM,cAAc;CAEpE,MAAM,cAAgC,eAAe,YAAY,EAC/D,OACA,SAAS,EAAE,EACX,OAAO,QACP,OAAO,EAAE,EACT,aAAa,cACb,aAAa,uBACZ;AACD,MAAI,OACF,4BAA2B;GAAC,aAAa;GAAc,OAAO;GAAO,CAAC;EAExE,MAAM,QAAQ,SACV,SACC,WAAW,gBAAgB,qBAAqB,MAAM,WAAW,EAAE;EACxE,MAAM,cAAc,SAChB,eACC,gBACA,MAAM,yBACL,wBAAwB,QAAQ,cAAc,oBAC/C;EACL,MAAM,SAAS,gBAAgB;EAC/B,MAAM,eAAe,QAAQ,IAAI,kBAAkB;EACnD,MAAM,YAAY,UAAU,CAAC,eAAe,YAAY,KAAA;EAGxD,MAAM,EAAC,aAAY,MAAM,OAAO,MAAM,OAAO,MAAM,QAAQ;GACzD,gBAAgB;GAChB;GACA,OAAO;GACP,aAAa;GACb;GACA;GACA,KAAK,CAAC,YAAY,kBAAkB,CAAC,OAAO,QAAQ,CAAC,KAAK,IAAI;GAC/D,CAAC;EAEF,MAAM,YAAY,CAAC,GAAG,MAAM,GAAI,UAAU,KAAK,QAAQ,UAAoB,MAAM,IAAI,EAAE,CAAE;EAGzF,MAAM,EAAC,QAAQ,oBAAmB,MAAM,OAAO,MAAM,OAAO,MAAM,QAAQ;GACxE,gBAAgB;GAChB;GACA;GACA,OAAO,gBAAgB,eAAe,cAAc,cAAc;GAClE,MAAM;IAAC,YAAY;IAAO,MAAM;IAAU;GAC1C;GACA;GACA,KAAK;GACN,CAAC;AACF,SAAO;GAAC,MAAM;GAAQ,WAAW,mBAAmB;GAAM,MAAM;GAAU;;CAG5E,MAAMA,eAAoD,eAAeA,aAAW,OAAO;AACzF,MAAI,OACF,+BAA8B,MAAM;EAEtC,MAAM,EACJ,iBAAiB,MAAM,WAAW,EAAE,WACpC,aAAa,oBACb,SAEA,QACA,SACA,WACA,aACA,WACA,aACE;EACJ,MAAM,EAAC,WAAW,SAAS,SAAS,YAAY,oBAAoB,qBAClE,OAAO,QAAQ;EAEjB,MAAM,sBAAsB,OAAO,iBAAiB,YAAY;EAChE,MAAM,gBAAgB,YAAY,cAAc,CAAC,sBAAsB,UAAU,KAAA;EAGjF,MAAM,EAAC,WAAU,IAAI,IAAI,OAAO,OAAO,IAAI,MAAM,CAAC;AAClD,aAAW,OAAO;AAElB,SACE,oBAACC,YAAD;GACE,QAAQ;IACN;IACA;IACA;IACA;IACA;IACA;IACA,OAAO,sBAAsB,eAAe,KAAA;IAC7C;GACD,eAAe,sBAAsB,OAAO,KAAA;GAChC;GACZ,SAAS;GACT,QAAQ,WAAW,kBAAkB,aAAa,YAAY;GACrD;GACE;GACE;GACF;GACD;GACV,CAAA;;AAGN,cAAW,cAAc;AAEzB,QAAO;EAAC;EAAa,YAAA;EAAW;;AAGlC,eAAe,yBAAyB,UAAqD;AAC3F,SAAQ,MAAM,WAAW,EAAE,YACvB,MAAM,8BAA8B,EAAC,SAAS,MAAM,SAAS,EAAC,CAAC,GAC/D"}
+{"version":3,"file":"index.js","names":["SanityLive","SanityLiveClientComponent"],"sources":["../../../../src/live/conditions/react-server/defineLive.tsx"],"sourcesContent":["import {SanityLive as SanityLiveClientComponent} from 'next-sanity/live/client-components'\nimport {revalidateSyncTagsAction} from 'next-sanity/live/server-actions'\nimport {PHASE_PRODUCTION_BUILD} from 'next/constants'\nimport {cookies, draftMode} from 'next/headers'\nimport {preconnect} from 'react-dom'\n\nimport {cacheTagPrefix} from '#live/constants'\nimport {resolvePerspectiveFromCookies} from '#live/resolvePerspectiveFromCookies'\nimport {validateStrictFetchOptions, validateStrictSanityLiveProps} from '#live/strictValidation'\nimport type {\n  DefinedFetchType,\n  DefinedLiveProps,\n  DefineLiveOptions,\n  LivePerspective,\n  StrictDefinedFetchType,\n  StrictDefinedLiveProps,\n} from '#live/types'\n\n/**\n * Set up Sanity Live for Cache Components. `defineLive` returns `sanityFetch`\n * and `<SanityLive />`, which connect your Sanity client to the Live Content API\n * so cached pages can update in response to fine-grained content changes.\n *\n * With `strict: true`, `perspective` and `stega` become required\n * `sanityFetch` options, and `includeDrafts` becomes required on\n * `<SanityLive />`. Resolve dynamic values from `draftMode()` and `cookies()`\n * outside `'use cache'` boundaries, then pass them into cached components.\n *\n * @see [Live Content API](https://www.sanity.io/docs/content-lake/live-content-api)\n * @see [Sanity Live](https://www.sanity.io/live)\n *\n * @example\n * ```tsx\n * // sanity/live.ts\n * import {cookies, draftMode} from 'next/headers'\n * import {createClient} from 'next-sanity'\n * import {\n *   defineLive,\n *   resolvePerspectiveFromCookies,\n *   type LivePerspective,\n * } from 'next-sanity/live'\n *\n * const client = createClient({\n *   projectId: process.env.NEXT_PUBLIC_SANITY_PROJECT_ID,\n *   dataset: process.env.NEXT_PUBLIC_SANITY_DATASET,\n *   useCdn: true,\n *   perspective: 'published',\n * })\n * const token = process.env.SANITY_API_READ_TOKEN\n *\n * export const {sanityFetch, SanityLive} = defineLive({\n *   client,\n *   browserToken: token,\n *   serverToken: token,\n *   strict: true,\n * })\n *\n * export interface DynamicFetchOptions {\n *   perspective: LivePerspective\n *   stega: boolean\n * }\n *\n * // Resolve dynamic values outside 'use cache' boundaries.\n * export async function getDynamicFetchOptions(): Promise<DynamicFetchOptions> {\n *   const {isEnabled: isDraftMode} = await draftMode()\n *   if (!isDraftMode) {\n *     return {perspective: 'published', stega: false}\n *   }\n *\n *   const jar = await cookies()\n *   const perspective = await resolvePerspectiveFromCookies({cookies: jar})\n *   return {perspective: perspective ?? 'drafts', stega: true}\n * }\n * ```\n *\n * @example\n * ```tsx\n * // app/layout.tsx\n * import {draftMode} from 'next/headers'\n *\n * import {SanityLive} from '@/sanity/live'\n *\n * export default async function RootLayout({children}: {children: React.ReactNode}) {\n *   const {isEnabled: isDraftMode} = await draftMode()\n *\n *   return (\n *     <html lang=\"en\">\n *       <body>\n *         {children}\n *         <SanityLive includeDrafts={isDraftMode} />\n *       </body>\n *     </html>\n *   )\n * }\n * ```\n *\n * @example\n * ```tsx\n * // app/[slug]/page.tsx\n * import {draftMode} from 'next/headers'\n * import {Suspense} from 'react'\n * import {defineQuery} from 'next-sanity'\n *\n * import {\n *   getDynamicFetchOptions,\n *   sanityFetch,\n *   type DynamicFetchOptions,\n * } from '@/sanity/live'\n *\n * const POSTS_SLUGS_QUERY = defineQuery(`\n *   *[_type == \"post\" && slug.current]{\"slug\": slug.current}\n * `)\n * const POST_QUERY = defineQuery(`\n *   *[_type == \"post\" && slug.current == $slug][0]\n * `)\n *\n * export async function generateStaticParams() {\n *   const {data} = await sanityFetch({\n *     query: POSTS_SLUGS_QUERY,\n *     perspective: 'published',\n *     stega: false,\n *   })\n *\n *   return data\n * }\n *\n * export default async function Page(props: PageProps<'/[slug]'>) {\n *   const {isEnabled: isDraftMode} = await draftMode()\n *   if (isDraftMode) {\n *     return (\n *       <Suspense fallback={<div>Loading...</div>}>\n *         <DynamicPage params={props.params} />\n *       </Suspense>\n *     )\n *   }\n *\n *   const {slug} = await props.params\n *   return <CachedPage slug={slug} perspective=\"published\" stega={false} />\n * }\n *\n * async function DynamicPage(props: Pick<PageProps<'/[slug]'>, 'params'>) {\n *   const {slug} = await props.params\n *   const {perspective, stega} = await getDynamicFetchOptions()\n *\n *   return <CachedPage slug={slug} perspective={perspective} stega={stega} />\n * }\n *\n * async function CachedPage({\n *   slug,\n *   perspective,\n *   stega,\n * }: {slug: string} & DynamicFetchOptions) {\n *   'use cache'\n *\n *   const {data} = await sanityFetch({\n *     query: POST_QUERY,\n *     params: {slug},\n *     perspective,\n *     stega,\n *   })\n *\n *   return <pre>{JSON.stringify(data, null, 2)}</pre>\n * }\n * ```\n *\n * @public\n */\nexport function defineLive(config: DefineLiveOptions & {strict: true}): {\n  sanityFetch: StrictDefinedFetchType\n  SanityLive: React.ComponentType<StrictDefinedLiveProps>\n}\n/**\n * Set up Sanity Live. `defineLive` returns `sanityFetch` and `<SanityLive />`,\n * which connect your Sanity client to the Live Content API so pages can serve\n * cached content and update in response to fine-grained content changes.\n *\n * @see [Live Content API](https://www.sanity.io/docs/content-lake/live-content-api)\n * @see [Sanity Live](https://www.sanity.io/live)\n *\n * @example\n * ```tsx\n * import {createClient} from 'next-sanity'\n * import {defineLive} from 'next-sanity/live'\n *\n * const client = createClient({\n *   projectId: process.env.NEXT_PUBLIC_SANITY_PROJECT_ID,\n *   dataset: process.env.NEXT_PUBLIC_SANITY_DATASET,\n *   useCdn: true,\n *   perspective: 'published',\n * })\n * const token = process.env.SANITY_API_READ_TOKEN\n *\n * export const {sanityFetch, SanityLive} = defineLive({\n *   client,\n *   browserToken: token,\n *   serverToken: token,\n * })\n * ```\n *\n * @example\n * ```tsx\n * // app/layout.tsx\n * import {SanityLive} from '@/sanity/live'\n *\n * export default function RootLayout({children}: {children: React.ReactNode}) {\n *   return (\n *     <html lang=\"en\">\n *       <body>\n *         {children}\n *         <SanityLive />\n *       </body>\n *     </html>\n *   )\n * }\n * ```\n *\n * @example\n * ```tsx\n * // app/[slug]/page.tsx\n * import {defineQuery} from 'next-sanity'\n * import {sanityFetch} from '@/sanity/live'\n *\n * const POSTS_SLUGS_QUERY = defineQuery(`\n *   *[_type == \"post\" && slug.current]{\"slug\": slug.current}\n * `)\n * const POST_QUERY = defineQuery(`\n *   *[_type == \"post\" && slug.current == $slug][0]\n * `)\n *\n * export async function generateStaticParams() {\n *   const {data} = await sanityFetch({\n *     query: POSTS_SLUGS_QUERY,\n *     perspective: 'published',\n *     stega: false,\n *   })\n *\n *   return data\n * }\n *\n * export default async function Page(props: PageProps<'/[slug]'>) {\n *   const {slug} = await props.params\n *   const {data} = await sanityFetch({\n *     query: POST_QUERY,\n *     params: {slug},\n *   })\n *\n *   return <pre>{JSON.stringify(data, null, 2)}</pre>\n * }\n * ```\n *\n * @public\n */\nexport function defineLive(config: DefineLiveOptions & {strict?: false}): {\n  sanityFetch: DefinedFetchType\n  SanityLive: React.ComponentType<DefinedLiveProps>\n}\nexport function defineLive(config: DefineLiveOptions) {\n  const {client: _client, serverToken, browserToken, strict = false} = config\n\n  if (!_client) {\n    throw new Error('`client` is required for `defineLive` to function')\n  }\n\n  if (process.env.NODE_ENV !== 'production' && !serverToken && serverToken !== false) {\n    console.warn(\n      'No `serverToken` provided to `defineLive`. This means that only published content will be fetched and respond to live events. You can silence this warning by setting `serverToken: false`.',\n    )\n  }\n\n  if (process.env.NODE_ENV !== 'production' && !browserToken && browserToken !== false) {\n    console.warn(\n      'No `browserToken` provided to `defineLive`. This means that live previewing drafts will only work when using the Presentation Tool in your Sanity Studio. To support live previewing drafts stand-alone, provide a `browserToken`. It is shared with the browser so it should only have Viewer rights or lower. You can silence this warning by setting `browserToken: false`.',\n    )\n  }\n\n  const client = _client.withConfig({allowReconfigure: false, useCdn: false})\n  const {token: originalToken, perspective: originalPerspective = 'published'} = client.config()\n  const studioUrlDefined = typeof client.config().stega.studioUrl !== 'undefined'\n\n  const sanityFetch: DefinedFetchType = async function sanityFetch({\n    query,\n    params = {},\n    stega: _stega,\n    tags = [],\n    perspective: _perspective,\n    requestTag = 'next-loader.fetch',\n  }) {\n    if (strict) {\n      validateStrictFetchOptions({perspective: _perspective, stega: _stega})\n    }\n    const stega = strict ? _stega! : (_stega ?? (studioUrlDefined && (await draftMode()).isEnabled))\n    const perspective = strict\n      ? _perspective!\n      : (_perspective ??\n        (await resolveCookiePerspective(\n          originalPerspective === 'raw' ? 'published' : originalPerspective,\n        )))\n    const useCdn = perspective === 'published'\n    const isBuildPhase = process.env['NEXT_PHASE'] === PHASE_PRODUCTION_BUILD\n    const cacheMode = useCdn && !isBuildPhase ? 'noStale' : undefined\n\n    // 1. Fetch the tags first, with an uncached request, but that does not count towards the Sanity API quota\n    const {syncTags} = await client.fetch(query, await params, {\n      filterResponse: false,\n      perspective,\n      stega: false,\n      returnQuery: false,\n      useCdn,\n      cacheMode,\n      tag: [requestTag, 'fetch-sync-tags'].filter(Boolean).join('.'),\n    })\n\n    const cacheTags = [...tags, ...(syncTags?.map((tag) => `${cacheTagPrefix}${tag}`) || [])]\n\n    // 2. Then fetch the data, using the fetch cache with specified tags\n    const {result, resultSourceMap} = await client.fetch(query, await params, {\n      filterResponse: false,\n      perspective,\n      stega,\n      token: perspective !== 'published' && serverToken ? serverToken : originalToken,\n      next: {revalidate: false, tags: cacheTags},\n      useCdn,\n      cacheMode,\n      tag: requestTag,\n    })\n    return {data: result, sourceMap: resultSourceMap || null, tags: cacheTags}\n  }\n\n  const SanityLive: React.ComponentType<DefinedLiveProps> = async function SanityLive(props) {\n    if (strict) {\n      validateStrictSanityLiveProps(props)\n    }\n    const {\n      includeDrafts = (await draftMode()).isEnabled,\n      requestTag = 'next-loader.live',\n      waitFor,\n\n      action,\n      onError,\n      onWelcome,\n      onReconnect,\n      onRestart,\n      onGoAway,\n    } = props\n    const {projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix} =\n      client.config()\n\n    const shouldIncludeDrafts = typeof browserToken === 'string' && includeDrafts\n    const shouldWaitFor = waitFor === 'function' && !shouldIncludeDrafts ? waitFor : undefined\n\n    // Preconnect to the Live Event API origin early, as the Sanity API is almost always on a different origin than the app\n    const {origin} = new URL(client.getUrl('', false))\n    preconnect(origin)\n\n    return (\n      <SanityLiveClientComponent\n        config={{\n          projectId,\n          dataset,\n          apiHost,\n          apiVersion,\n          useProjectHostname,\n          requestTagPrefix,\n          token: shouldIncludeDrafts ? browserToken : undefined,\n        }}\n        includeDrafts={shouldIncludeDrafts ? true : undefined}\n        requestTag={requestTag}\n        waitFor={shouldWaitFor}\n        action={action ?? (shouldWaitFor === 'function' ? 'refresh' : revalidateSyncTagsAction)}\n        onError={onError}\n        onWelcome={onWelcome}\n        onReconnect={onReconnect}\n        onRestart={onRestart}\n        onGoAway={onGoAway}\n      />\n    )\n  }\n  SanityLive.displayName = 'SanityLiveServerComponent'\n\n  return {sanityFetch, SanityLive}\n}\n\nasync function resolveCookiePerspective(fallback: LivePerspective): Promise<LivePerspective> {\n  return (await draftMode()).isEnabled\n    ? await resolvePerspectiveFromCookies({cookies: await cookies()})\n    : fallback\n}\n"],"mappings":";;;;;;;;;;AAgQA,SAAgB,WAAW,QAA2B;CACpD,MAAM,EAAC,QAAQ,SAAS,aAAa,cAAc,SAAS,UAAS;AAErE,KAAI,CAAC,QACH,OAAM,IAAI,MAAM,oDAAoD;AAGtE,KAAI,QAAQ,IAAI,aAAa,gBAAgB,CAAC,eAAe,gBAAgB,MAC3E,SAAQ,KACN,8LACD;AAGH,KAAI,QAAQ,IAAI,aAAa,gBAAgB,CAAC,gBAAgB,iBAAiB,MAC7E,SAAQ,KACN,iXACD;CAGH,MAAM,SAAS,QAAQ,WAAW;EAAC,kBAAkB;EAAO,QAAQ;EAAM,CAAC;CAC3E,MAAM,EAAC,OAAO,eAAe,aAAa,sBAAsB,gBAAe,OAAO,QAAQ;CAC9F,MAAM,mBAAmB,OAAO,OAAO,QAAQ,CAAC,MAAM,cAAc;CAEpE,MAAM,cAAgC,eAAe,YAAY,EAC/D,OACA,SAAS,EAAE,EACX,OAAO,QACP,OAAO,EAAE,EACT,aAAa,cACb,aAAa,uBACZ;AACD,MAAI,OACF,4BAA2B;GAAC,aAAa;GAAc,OAAO;GAAO,CAAC;EAExE,MAAM,QAAQ,SAAS,SAAW,WAAW,qBAAqB,MAAM,WAAW,EAAE;EACrF,MAAM,cAAc,SAChB,eACC,gBACA,MAAM,yBACL,wBAAwB,QAAQ,cAAc,oBAC/C;EACL,MAAM,SAAS,gBAAgB;EAC/B,MAAM,eAAe,QAAQ,IAAI,kBAAkB;EACnD,MAAM,YAAY,UAAU,CAAC,eAAe,YAAY,KAAA;EAGxD,MAAM,EAAC,aAAY,MAAM,OAAO,MAAM,OAAO,MAAM,QAAQ;GACzD,gBAAgB;GAChB;GACA,OAAO;GACP,aAAa;GACb;GACA;GACA,KAAK,CAAC,YAAY,kBAAkB,CAAC,OAAO,QAAQ,CAAC,KAAK,IAAI;GAC/D,CAAC;EAEF,MAAM,YAAY,CAAC,GAAG,MAAM,GAAI,UAAU,KAAK,QAAQ,UAAoB,MAAM,IAAI,EAAE,CAAE;EAGzF,MAAM,EAAC,QAAQ,oBAAmB,MAAM,OAAO,MAAM,OAAO,MAAM,QAAQ;GACxE,gBAAgB;GAChB;GACA;GACA,OAAO,gBAAgB,eAAe,cAAc,cAAc;GAClE,MAAM;IAAC,YAAY;IAAO,MAAM;IAAU;GAC1C;GACA;GACA,KAAK;GACN,CAAC;AACF,SAAO;GAAC,MAAM;GAAQ,WAAW,mBAAmB;GAAM,MAAM;GAAU;;CAG5E,MAAMA,eAAoD,eAAeA,aAAW,OAAO;AACzF,MAAI,OACF,+BAA8B,MAAM;EAEtC,MAAM,EACJ,iBAAiB,MAAM,WAAW,EAAE,WACpC,aAAa,oBACb,SAEA,QACA,SACA,WACA,aACA,WACA,aACE;EACJ,MAAM,EAAC,WAAW,SAAS,SAAS,YAAY,oBAAoB,qBAClE,OAAO,QAAQ;EAEjB,MAAM,sBAAsB,OAAO,iBAAiB,YAAY;EAChE,MAAM,gBAAgB,YAAY,cAAc,CAAC,sBAAsB,UAAU,KAAA;EAGjF,MAAM,EAAC,WAAU,IAAI,IAAI,OAAO,OAAO,IAAI,MAAM,CAAC;AAClD,aAAW,OAAO;AAElB,SACE,oBAACC,YAAD;GACE,QAAQ;IACN;IACA;IACA;IACA;IACA;IACA;IACA,OAAO,sBAAsB,eAAe,KAAA;IAC7C;GACD,eAAe,sBAAsB,OAAO,KAAA;GAChC;GACZ,SAAS;GACT,QAAQ,WAAW,kBAAkB,aAAa,YAAY;GACrD;GACE;GACE;GACF;GACD;GACV,CAAA;;AAGN,cAAW,cAAc;AAEzB,QAAO;EAAC;EAAa,YAAA;EAAW;;AAGlC,eAAe,yBAAyB,UAAqD;AAC3F,SAAQ,MAAM,WAAW,EAAE,YACvB,MAAM,8BAA8B,EAAC,SAAS,MAAM,SAAS,EAAC,CAAC,GAC/D"}

package/dist/types.d.ts

@@ -136,14 +136,6 @@ interface DefineLiveOptions {
   */
   browserToken?: string | false;
   /**
-  * Include stega encoding automatically when draft mode is enabled.
-  *
-  * @deprecated This option does not affect the `next-js` export condition used
-  * with `cacheComponents: true`. Pass `stega` to `sanityFetch()` instead.
-  * @defaultValue `true`
-  */
-  stega?: boolean;
-  /**
   * Require explicit live-content options at every call site.
   *
   * When `true`, `includeDrafts` is required on `<SanityLive />` and

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","names":[],"sources":["../src/live/shared/types.ts"],"mappings":";;AAcA;;;KAAY,eAAA,GAAkB,OAAA,CAAQ,iBAAA;;AAStC;;;;;;KAAY,gBAAA,sCAAsD,OAAA;;;;EAIhE,KAAA,EAAO,WAAA;;;;EAIP,MAAA,GAAS,WAAA,GAAc,OAAA,CAAQ,WAAA;;;;;;EAM/B,WAAA,GAAc,eAAA;;;;;;;EAOd,KAAA;;;;;;;;EAQA,IAAA;EAkBF;;;;;;EAXE,UAAA;AAAA,MACI,OAAA;EACJ,IAAA,EAAM,YAAA,CAAa,WAAA;EACnB,SAAA,EAAW,gBAAA;EACX,IAAA;AAAA;;;;;UAOe,gBAAA;;;;;;;;;EASf,aAAA;;;AAkDF;;;;;EA1CE,UAAA;;;;;;;AAuFF;EA/EE,OAAA;;;;;;;EAOA,MAAA,GAAS,gBAAA;EAgFX;;;EA5EE,OAAA,GAAU,iBAAA;;;;;EAKV,SAAA,GAAY,mBAAA;;;;;EAKZ,WAAA,GAAc,qBAAA;;;;;EAKd,SAAA,GAAY,mBAAA;;;;;EAKZ,QAAA,GAAW,kBAAA;AAAA;AAAA,UAGI,iBAAA;;;;EAIf,MAAA,EAAQ,YAAA;;;;;;;EAOR,WAAA;EAuDe;;;;AAcjB;;;EA7DE,YAAA;EAsEA;AAiBF;;;;;AAOA;EAtFE,KAAA;;;;;;;;AA8FF;;;EAnFE,MAAA;AAAA;;;;;UAOe,sBAAA,SAA+B,IAAA,CAAK,gBAAA;EACnD,aAAA;AAAA;;;;;KAOU,sBAAA,sCAA4D,OAAA;EACtE,KAAA,EAAO,WAAA;EACP,MAAA,GAAS,WAAA,GAAc,OAAA,CAAQ,WAAA;EAC/B,WAAA,EAAa,eAAA;EACb,KAAA;EACA,IAAA;EACA,UAAA;AAAA,MACI,OAAA;EACJ,IAAA,EAAM,YAAA,CAAa,WAAA;EACnB,SAAA,EAAW,gBAAA;EACX,IAAA;AAAA;AAAA,UAGe,kBAAA,SAA2B,IAAA,CAC1C,uBAAA;;;;UAae,iBAAA;;;;AA+DjB;EA1DE,aAAA;;;;EAIA,OAAA;AAAA;;;;;;;;;;;;AAoEF;;;KAnDY,gBAAA,KAAqB,UAAA,cAAwB,OAAA;;;;;;;KAO7C,iBAAA,IAAqB,KAAA,WAAgB,OAAA,EAAS,iBAAA;;;;;;;;KAQ9C,mBAAA,IACV,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,iBAAA,YACC,OAAA;;;;;;;KAOA,qBAAA,KAEN,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,iBAAA,YACC,OAAA;;;;;;;KAQJ,mBAAA,KAEN,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,iBAAA,YACC,OAAA;;;;;;;;;KAUJ,kBAAA,IACV,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,iBAAA,EACT,kBAAA,GAAqB,QAAA,6BACX,OAAA"}
+{"version":3,"file":"types.d.ts","names":[],"sources":["../src/live/shared/types.ts"],"mappings":";;AAcA;;;KAAY,eAAA,GAAkB,OAAA,CAAQ,iBAAA;;AAStC;;;;;;KAAY,gBAAA,sCAAsD,OAAA;;;;EAIhE,KAAA,EAAO,WAAA;;;;EAIP,MAAA,GAAS,WAAA,GAAc,OAAA,CAAQ,WAAA;;;;;;EAM/B,WAAA,GAAc,eAAA;;;;;;;EAOd,KAAA;;;;;;;;EAQA,IAAA;EAkBF;;;;;;EAXE,UAAA;AAAA,MACI,OAAA;EACJ,IAAA,EAAM,YAAA,CAAa,WAAA;EACnB,SAAA,EAAW,gBAAA;EACX,IAAA;AAAA;;;;;UAOe,gBAAA;;;;;;;;;EASf,aAAA;;;AAkDF;;;;;EA1CE,UAAA;;;;;;AA+EF;;EAvEE,OAAA;EAuE8C;;;;;;EAhE9C,MAAA,GAAS,gBAAA;EAwEC;;;EApEV,OAAA,GAAU,iBAAA;;;;;EAKV,SAAA,GAAY,mBAAA;;;;;EAKZ,WAAA,GAAc,qBAAA;;;;;EAKd,SAAA,GAAY,mBAAA;;;;;EAKZ,QAAA,GAAW,kBAAA;AAAA;AAAA,UAGI,iBAAA;;;;EAIf,MAAA,EAAQ,YAAA;;;;;;AAsDV;EA/CE,WAAA;;;;AA6DF;;;;EArDE,YAAA;EA+EF;;;;;AAOA;;;;;EA3EE,MAAA;AAAA;;;AAmFF;;UA5EiB,sBAAA,SAA+B,IAAA,CAAK,gBAAA;EACnD,aAAA;AAAA;;;;;KAOU,sBAAA,sCAA4D,OAAA;EACtE,KAAA,EAAO,WAAA;EACP,MAAA,GAAS,WAAA,GAAc,OAAA,CAAQ,WAAA;EAC/B,WAAA,EAAa,eAAA;EACb,KAAA;EACA,IAAA;EACA,UAAA;AAAA,MACI,OAAA;EACJ,IAAA,EAAM,YAAA,CAAa,WAAA;EACnB,SAAA,EAAW,gBAAA;EACX,IAAA;AAAA;AAAA,UAGe,kBAAA,SAA2B,IAAA,CAC1C,uBAAA;;;;UAae,iBAAA;EAuDD;;;;EAlDd,aAAA;;;;EAIA,OAAA;AAAA;AAsDF;;;;;;;;;;;;;;AAAA,KArCY,gBAAA,KAAqB,UAAA,cAAwB,OAAA;;;;AAmDzD;;;KA5CY,iBAAA,IAAqB,KAAA,WAAgB,OAAA,EAAS,iBAAA;;;;;;;;KAQ9C,mBAAA,IACV,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,iBAAA,YACC,OAAA;;;;;;;KAOA,qBAAA,KAEN,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,iBAAA,YACC,OAAA;;;;;;;KAQJ,mBAAA,KAEN,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,iBAAA,YACC,OAAA;;;;;;;;;KAUJ,kBAAA,IACV,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,iBAAA,EACT,kBAAA,GAAqB,QAAA,6BACX,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-sanity",
-  "version": "13.0.0-cache-components.56",
+  "version": "13.0.0-cache-components.57",
   "description": "Sanity.io toolkit for Next.js",
   "keywords": [
     "live",
@@ -70,7 +70,7 @@
   "devDependencies": {
     "@sanity/tsconfig": "^2.1.0",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^24.12.3",
+    "@types/node": "^24.12.4",
     "@types/react": "^19.2.14",
     "@types/react-dom": "^19.2.3",
     "@vitejs/plugin-react": "^6.0.1",