next-sanity 13.0.0-cache-components.42 → 13.0.0-cache-components.43

package/dist/live/conditions/react-server/index.d.ts

@@ -1,17 +1,244 @@
 import { t as isCorsOriginError } from "../../../isCorsOriginError.js";
-import { d as StrictDefinedFetchType, f as StrictDefinedLiveProps, i as LivePerspective, n as DefinedFetchType, r as DefinedLiveProps, t as DefineLiveOptions } from "../../../types.js";
+import { a as SanityLiveAction, c as SanityLiveOnGoaway, d as SanityLiveOnWelcome, f as StrictDefinedFetchType, i as LivePerspective, l as SanityLiveOnReconnect, n as DefinedFetchType, o as SanityLiveActionContext, p as StrictDefinedLiveProps, r as DefinedLiveProps, s as SanityLiveOnError, t as DefineLiveOptions, u as SanityLiveOnRestart } from "../../../types.js";
 import { n as resolvePerspectiveFromCookies, t as parseTags } from "../../../parseTags.js";
+/**
+* Set up Sanity Live for Cache Components. `defineLive` returns `sanityFetch`
+* and `<SanityLive />`, which connect your Sanity client to the Live Content API
+* so cached pages can update in response to fine-grained content changes.
+*
+* With `strict: true`, `perspective` and `stega` become required
+* `sanityFetch` options, and `includeDrafts` becomes required on
+* `<SanityLive />`. Resolve dynamic values from `draftMode()` and `cookies()`
+* outside `'use cache'` boundaries, then pass them into cached components.
+*
+* @see [Live Content API](https://www.sanity.io/docs/content-lake/live-content-api)
+* @see [Sanity Live](https://www.sanity.io/live)
+*
+* @example
+* ```tsx
+* // sanity/live.ts
+* import {cookies, draftMode} from 'next/headers'
+* import {createClient} from 'next-sanity'
+* import {
+*   defineLive,
+*   resolvePerspectiveFromCookies,
+*   type LivePerspective,
+* } from 'next-sanity/live'
+*
+* const client = createClient({
+*   projectId: process.env.NEXT_PUBLIC_SANITY_PROJECT_ID,
+*   dataset: process.env.NEXT_PUBLIC_SANITY_DATASET,
+*   useCdn: true,
+*   perspective: 'published',
+* })
+* const token = process.env.SANITY_API_READ_TOKEN
+*
+* export const {sanityFetch, SanityLive} = defineLive({
+*   client,
+*   browserToken: token,
+*   serverToken: token,
+*   strict: true,
+* })
+*
+* export interface DynamicFetchOptions {
+*   perspective: LivePerspective
+*   stega: boolean
+* }
+*
+* // Resolve dynamic values outside 'use cache' boundaries.
+* export async function getDynamicFetchOptions(): Promise<DynamicFetchOptions> {
+*   const {isEnabled: isDraftMode} = await draftMode()
+*   if (!isDraftMode) {
+*     return {perspective: 'published', stega: false}
+*   }
+*
+*   const jar = await cookies()
+*   const perspective = await resolvePerspectiveFromCookies({cookies: jar})
+*   return {perspective: perspective ?? 'drafts', stega: true}
+* }
+* ```
+*
+* @example
+* ```tsx
+* // app/layout.tsx
+* import {draftMode} from 'next/headers'
+*
+* import {SanityLive} from '@/sanity/live'
+*
+* export default async function RootLayout({children}: {children: React.ReactNode}) {
+*   const {isEnabled: isDraftMode} = await draftMode()
+*
+*   return (
+*     <html lang="en">
+*       <body>
+*         {children}
+*         <SanityLive includeDrafts={isDraftMode} />
+*       </body>
+*     </html>
+*   )
+* }
+* ```
+*
+* @example
+* ```tsx
+* // app/[slug]/page.tsx
+* import {draftMode} from 'next/headers'
+* import {Suspense} from 'react'
+* import {defineQuery} from 'next-sanity'
+*
+* import {
+*   getDynamicFetchOptions,
+*   sanityFetch,
+*   type DynamicFetchOptions,
+* } from '@/sanity/live'
+*
+* const POSTS_SLUGS_QUERY = defineQuery(`
+*   *[_type == "post" && slug.current]{"slug": slug.current}
+* `)
+* const POST_QUERY = defineQuery(`
+*   *[_type == "post" && slug.current == $slug][0]
+* `)
+*
+* export async function generateStaticParams() {
+*   const {data} = await sanityFetch({
+*     query: POSTS_SLUGS_QUERY,
+*     perspective: 'published',
+*     stega: false,
+*   })
+*
+*   return data
+* }
+*
+* export default async function Page(props: PageProps<'/[slug]'>) {
+*   const {isEnabled: isDraftMode} = await draftMode()
+*   if (isDraftMode) {
+*     return (
+*       <Suspense fallback={<div>Loading...</div>}>
+*         <DynamicPage params={props.params} />
+*       </Suspense>
+*     )
+*   }
+*
+*   const {slug} = await props.params
+*   return <CachedPage slug={slug} perspective="published" stega={false} />
+* }
+*
+* async function DynamicPage(props: Pick<PageProps<'/[slug]'>, 'params'>) {
+*   const {slug} = await props.params
+*   const {perspective, stega} = await getDynamicFetchOptions()
+*
+*   return <CachedPage slug={slug} perspective={perspective} stega={stega} />
+* }
+*
+* async function CachedPage({
+*   slug,
+*   perspective,
+*   stega,
+* }: {slug: string} & DynamicFetchOptions) {
+*   'use cache'
+*
+*   const {data} = await sanityFetch({
+*     query: POST_QUERY,
+*     params: {slug},
+*     perspective,
+*     stega,
+*   })
+*
+*   return <pre>{JSON.stringify(data, null, 2)}</pre>
+* }
+* ```
+*
+* @public
+*/
 declare function defineLive(config: DefineLiveOptions & {
   strict: true;
 }): {
   sanityFetch: StrictDefinedFetchType;
   SanityLive: React.ComponentType<StrictDefinedLiveProps>;
 };
+/**
+* Set up Sanity Live. `defineLive` returns `sanityFetch` and `<SanityLive />`,
+* which connect your Sanity client to the Live Content API so pages can serve
+* cached content and update in response to fine-grained content changes.
+*
+* @see [Live Content API](https://www.sanity.io/docs/content-lake/live-content-api)
+* @see [Sanity Live](https://www.sanity.io/live)
+*
+* @example
+* ```tsx
+* import {createClient} from 'next-sanity'
+* import {defineLive} from 'next-sanity/live'
+*
+* const client = createClient({
+*   projectId: process.env.NEXT_PUBLIC_SANITY_PROJECT_ID,
+*   dataset: process.env.NEXT_PUBLIC_SANITY_DATASET,
+*   useCdn: true,
+*   perspective: 'published',
+* })
+*
+* export const {sanityFetch, SanityLive} = defineLive({
+*   client,
+* })
+* ```
+*
+* @example
+* ```tsx
+* // app/layout.tsx
+* import {SanityLive} from '@/sanity/live'
+*
+* export default function RootLayout({children}: {children: React.ReactNode}) {
+*   return (
+*     <html lang="en">
+*       <body>
+*         {children}
+*         <SanityLive />
+*       </body>
+*     </html>
+*   )
+* }
+* ```
+*
+* @example
+* ```tsx
+* // app/[slug]/page.tsx
+* import {defineQuery} from 'next-sanity'
+* import {sanityFetch} from '@/sanity/live'
+*
+* const POSTS_SLUGS_QUERY = defineQuery(`
+*   *[_type == "post" && slug.current]{"slug": slug.current}
+* `)
+* const POST_QUERY = defineQuery(`
+*   *[_type == "post" && slug.current == $slug][0]
+* `)
+*
+* export async function generateStaticParams() {
+*   const {data} = await sanityFetch({
+*     query: POSTS_SLUGS_QUERY,
+*     perspective: 'published',
+*     stega: false,
+*   })
+*
+*   return data
+* }
+*
+* export default async function Page(props: PageProps<'/[slug]'>) {
+*   const {slug} = await props.params
+*   const {data} = await sanityFetch({
+*     query: POST_QUERY,
+*     params: {slug},
+*   })
+*
+*   return <pre>{JSON.stringify(data, null, 2)}</pre>
+* }
+* ```
+*
+* @public
+*/
 declare function defineLive(config: DefineLiveOptions & {
   strict?: false;
 }): {
   sanityFetch: DefinedFetchType;
   SanityLive: React.ComponentType<DefinedLiveProps>;
 };
-export { type LivePerspective, defineLive, isCorsOriginError, parseTags, resolvePerspectiveFromCookies };
+export { type DefineLiveOptions, type DefinedFetchType, type DefinedLiveProps, type LivePerspective, type SanityLiveAction, type SanityLiveActionContext, type SanityLiveOnError, type SanityLiveOnGoaway, type SanityLiveOnReconnect, type SanityLiveOnRestart, type SanityLiveOnWelcome, type StrictDefinedFetchType, type StrictDefinedLiveProps, defineLive, isCorsOriginError, parseTags, resolvePerspectiveFromCookies };
 //# sourceMappingURL=index.d.ts.map

package/dist/live/conditions/react-server/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../../../../src/live/conditions/react-server/defineLive.tsx"],"mappings":";;;iBAmBgB,UAAA,CAAW,MAAA,EAAQ,iBAAA;EAAqB,MAAA;AAAA;EACtD,WAAA,EAAa,sBAAA;EACb,UAAA,EAAY,KAAA,CAAM,aAAA,CAAc,sBAAA;AAAA;AAAA,iBAElB,UAAA,CAAW,MAAA,EAAQ,iBAAA;EAAqB,MAAA;AAAA;EACtD,WAAA,EAAa,gBAAA;EACb,UAAA,EAAY,KAAA,CAAM,aAAA,CAAc,gBAAA;AAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../../../src/live/conditions/react-server/defineLive.tsx"],"mappings":";;;;;;AAwKA;;;;;;;;;;;;;;;;;;;;AAkFA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAlFgB,UAAA,CAAW,MAAA,EAAQ,iBAAA;EAAqB,MAAA;AAAA;EACtD,WAAA,EAAa,sBAAA;EACb,UAAA,EAAY,KAAA,CAAM,aAAA,CAAc,sBAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgFlB,UAAA,CAAW,MAAA,EAAQ,iBAAA;EAAqB,MAAA;AAAA;EACtD,WAAA,EAAa,gBAAA;EACb,UAAA,EAAY,KAAA,CAAM,aAAA,CAAc,gBAAA;AAAA"}

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 {type ClientPerspective, type QueryParams} from '@sanity/client'\nimport {perspectiveCookieName} from '@sanity/preview-url-secret/constants'\nimport {SanityLive as SanityLiveClientComponent} from 'next-sanity/live/client-components'\nimport {refreshAction, 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 {cacheTagPrefixes} from '#live/constants'\nimport {sanitizePerspective} from '#live/sanitizePerspective'\nimport {validateStrictFetchOptions, validateStrictSanityLiveProps} from '#live/strictValidation'\nimport type {\n  DefinedFetchType,\n  DefinedLiveProps,\n  DefineLiveOptions,\n  StrictDefinedFetchType,\n  StrictDefinedLiveProps,\n} from '#live/types'\n\nexport function defineLive(config: DefineLiveOptions & {strict: true}): {\n  sanityFetch: StrictDefinedFetchType\n  SanityLive: React.ComponentType<StrictDefinedLiveProps>\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    const QueryString extends string,\n  >({\n    query,\n    params = {},\n    stega: _stega,\n    tags = [],\n    perspective: _perspective,\n    tag,\n    requestTag = tag ?? 'next-loader.fetch',\n  }: {\n    query: QueryString\n    params?: QueryParams | Promise<QueryParams>\n    stega?: boolean\n    tags?: string[]\n    perspective?: Exclude<ClientPerspective, 'raw'>\n    tag?: string\n    requestTag?: string\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    const cacheTagPrefix =\n      perspective === 'published' ? cacheTagPrefixes.published : cacheTagPrefixes.drafts\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: perspective as ClientPerspective,\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: perspective as ClientPerspective,\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      action = revalidateSyncTagsAction,\n      onReconnect = refreshAction,\n      onRestart = refreshAction,\n\n      onWelcome = false,\n      onError = false,\n      onGoAway = false,\n\n      refreshOnMount,\n      refreshOnFocus,\n      refreshOnReconnect,\n      requestTag = 'next-loader.live',\n    } = props\n    const {projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix} =\n      client.config()\n    const shouldIncludeDrafts = typeof browserToken === 'string' && includeDrafts\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}\n        action={action}\n        onReconnect={onReconnect}\n        onRestart={onRestart}\n        onWelcome={onWelcome}\n        onError={onError}\n        onGoAway={onGoAway}\n        requestTag={requestTag}\n        refreshOnMount={refreshOnMount}\n        refreshOnFocus={refreshOnFocus}\n        refreshOnReconnect={refreshOnReconnect}\n      />\n    )\n  }\n  SanityLive.displayName = 'SanityLiveServerComponent'\n\n  return {sanityFetch, SanityLive}\n}\n\nasync function resolveCookiePerspective(\n  fallback: Exclude<ClientPerspective, 'raw'>,\n): Promise<Exclude<ClientPerspective, 'raw'>> {\n  return (await draftMode()).isEnabled\n    ? (await cookies()).has(perspectiveCookieName)\n      ? sanitizePerspective((await cookies()).get(perspectiveCookieName)?.value, 'drafts')\n      : 'drafts'\n    : fallback\n}\n"],"mappings":";;;;;;;;;;;;;AA2BA,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,YAEnD,EACA,OACA,SAAS,EAAE,EACX,OAAO,QACP,OAAO,EAAE,EACT,aAAa,cACb,KACA,aAAa,OAAO,uBASnB;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;EACxD,MAAM,iBACJ,gBAAgB,cAAc,iBAAiB,YAAY,iBAAiB;EAG9E,MAAM,EAAC,aAAY,MAAM,OAAO,MAAM,OAAO,MAAM,QAAQ;GACzD,gBAAgB;GACH;GACb,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,GAAG,iBAAiB,MAAM,IAAI,EAAE,CAAE;EAGzF,MAAM,EAAC,QAAQ,oBAAmB,MAAM,OAAO,MAAM,OAAO,MAAM,QAAQ;GACxE,gBAAgB;GACH;GACb;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,SAAS,0BACT,cAAc,eACd,YAAY,eAEZ,YAAY,OACZ,UAAU,OACV,WAAW,OAEX,gBACA,gBACA,oBACA,aAAa,uBACX;EACJ,MAAM,EAAC,WAAW,SAAS,SAAS,YAAY,oBAAoB,qBAClE,OAAO,QAAQ;EACjB,MAAM,sBAAsB,OAAO,iBAAiB,YAAY;EAGhE,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;GACP;GACK;GACF;GACA;GACF;GACC;GACE;GACI;GACA;GACI;GACpB,CAAA;;AAGN,cAAW,cAAc;AAEzB,QAAO;EAAC;EAAa,YAAA;EAAW;;AAGlC,eAAe,yBACb,UAC4C;AAC5C,SAAQ,MAAM,WAAW,EAAE,aACtB,MAAM,SAAS,EAAE,IAAI,sBAAsB,GAC1C,qBAAqB,MAAM,SAAS,EAAE,IAAI,sBAAsB,EAAE,OAAO,SAAS,GAClF,WACF"}
+{"version":3,"file":"index.js","names":["SanityLive","SanityLiveClientComponent"],"sources":["../../../../src/live/conditions/react-server/defineLive.tsx"],"sourcesContent":["import {type ClientPerspective, type QueryParams} from '@sanity/client'\nimport {perspectiveCookieName} from '@sanity/preview-url-secret/constants'\nimport {SanityLive as SanityLiveClientComponent} from 'next-sanity/live/client-components'\nimport {refreshAction, 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 {cacheTagPrefixes} from '#live/constants'\nimport {sanitizePerspective} from '#live/sanitizePerspective'\nimport {validateStrictFetchOptions, validateStrictSanityLiveProps} from '#live/strictValidation'\nimport type {\n  DefinedFetchType,\n  DefinedLiveProps,\n  DefineLiveOptions,\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 *\n * export const {sanityFetch, SanityLive} = defineLive({\n *   client,\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    const QueryString extends string,\n  >({\n    query,\n    params = {},\n    stega: _stega,\n    tags = [],\n    perspective: _perspective,\n    tag,\n    requestTag = tag ?? 'next-loader.fetch',\n  }: {\n    query: QueryString\n    params?: QueryParams | Promise<QueryParams>\n    stega?: boolean\n    tags?: string[]\n    perspective?: Exclude<ClientPerspective, 'raw'>\n    tag?: string\n    requestTag?: string\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    const cacheTagPrefix =\n      perspective === 'published' ? cacheTagPrefixes.published : cacheTagPrefixes.drafts\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: perspective as ClientPerspective,\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: perspective as ClientPerspective,\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      action = revalidateSyncTagsAction,\n      onReconnect = refreshAction,\n      onRestart = refreshAction,\n\n      onWelcome = false,\n      onError = false,\n      onGoAway = false,\n\n      refreshOnMount,\n      refreshOnFocus,\n      refreshOnReconnect,\n      requestTag = 'next-loader.live',\n    } = props\n    const {projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix} =\n      client.config()\n    const shouldIncludeDrafts = typeof browserToken === 'string' && includeDrafts\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}\n        action={action}\n        onReconnect={onReconnect}\n        onRestart={onRestart}\n        onWelcome={onWelcome}\n        onError={onError}\n        onGoAway={onGoAway}\n        requestTag={requestTag}\n        refreshOnMount={refreshOnMount}\n        refreshOnFocus={refreshOnFocus}\n        refreshOnReconnect={refreshOnReconnect}\n      />\n    )\n  }\n  SanityLive.displayName = 'SanityLiveServerComponent'\n\n  return {sanityFetch, SanityLive}\n}\n\nasync function resolveCookiePerspective(\n  fallback: Exclude<ClientPerspective, 'raw'>,\n): Promise<Exclude<ClientPerspective, 'raw'>> {\n  return (await draftMode()).isEnabled\n    ? (await cookies()).has(perspectiveCookieName)\n      ? sanitizePerspective((await cookies()).get(perspectiveCookieName)?.value, 'drafts')\n      : 'drafts'\n    : fallback\n}\n"],"mappings":";;;;;;;;;;;;;AA8PA,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,YAEnD,EACA,OACA,SAAS,EAAE,EACX,OAAO,QACP,OAAO,EAAE,EACT,aAAa,cACb,KACA,aAAa,OAAO,uBASnB;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;EACxD,MAAM,iBACJ,gBAAgB,cAAc,iBAAiB,YAAY,iBAAiB;EAG9E,MAAM,EAAC,aAAY,MAAM,OAAO,MAAM,OAAO,MAAM,QAAQ;GACzD,gBAAgB;GACH;GACb,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,GAAG,iBAAiB,MAAM,IAAI,EAAE,CAAE;EAGzF,MAAM,EAAC,QAAQ,oBAAmB,MAAM,OAAO,MAAM,OAAO,MAAM,QAAQ;GACxE,gBAAgB;GACH;GACb;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,SAAS,0BACT,cAAc,eACd,YAAY,eAEZ,YAAY,OACZ,UAAU,OACV,WAAW,OAEX,gBACA,gBACA,oBACA,aAAa,uBACX;EACJ,MAAM,EAAC,WAAW,SAAS,SAAS,YAAY,oBAAoB,qBAClE,OAAO,QAAQ;EACjB,MAAM,sBAAsB,OAAO,iBAAiB,YAAY;EAGhE,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;GACP;GACK;GACF;GACA;GACF;GACC;GACE;GACI;GACA;GACI;GACpB,CAAA;;AAGN,cAAW,cAAc;AAEzB,QAAO;EAAC;EAAa,YAAA;EAAW;;AAGlC,eAAe,yBACb,UAC4C;AAC5C,SAAQ,MAAM,WAAW,EAAE,aACtB,MAAM,SAAS,EAAE,IAAI,sBAAsB,GAC1C,qBAAqB,MAAM,SAAS,EAAE,IAAI,sBAAsB,EAAE,OAAO,SAAS,GAClF,WACF"}

package/dist/live/server-actions/{index.default.d.ts → index.d.ts}

@@ -8,4 +8,4 @@ declare function revalidateSyncTagsAction(unsafeTags: unknown): Promise<void>;
 */
 declare function refreshAction(): Promise<void>;
 export { refreshAction, revalidateSyncTagsAction };
-//# sourceMappingURL=index.default.d.ts.map
+//# sourceMappingURL=index.d.ts.map

package/dist/live/server-actions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../../src/live/server-actions/index.ts"],"mappings":"AAUA;;;AAAA,iBAAsB,wBAAA,CAAyB,UAAA,YAAsB,OAAA;;AAyBrE;;;iBAAsB,aAAA,CAAA,GAAiB,OAAA"}

package/dist/live/server-actions/{index.next-js.js → index.js}

@@ -24,4 +24,4 @@ async function refreshAction() {
 }
 export { refreshAction, revalidateSyncTagsAction };
 
-//# sourceMappingURL=index.next-js.js.map
+//# sourceMappingURL=index.js.map

package/dist/live/server-actions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../../src/live/server-actions/index.ts"],"sourcesContent":["'use server'\n\nimport {refresh, revalidateTag} from 'next/cache'\nimport {draftMode} from 'next/headers'\n\nimport {parseTags} from '#live/parseTags'\n\n/**\n * @alpha CAUTION: this is an internal action and does not follow semver. Using it directly is at your own risk.\n */\nexport async function revalidateSyncTagsAction(unsafeTags: unknown): Promise<void> {\n  const {tags, prefixType} = parseTags(unsafeTags)\n  if ((await draftMode()).isEnabled) {\n    console.warn(\n      `<SanityLive ${prefixType === 'drafts' ? 'includeDrafts ' : ''}/> action called in draft mode, cache is bypassed in draft mode so the refresh() function is called instead of updateTag()`,\n      {tags},\n    )\n    refresh()\n    return undefined\n  }\n\n  for (const tag of tags) {\n    revalidateTag(tag, 'max')\n  }\n\n  // oxlint-disable-next-line no-console\n  console.log(\n    `<SanityLive ${prefixType === 'drafts' ? 'includeDrafts ' : ''}/> revalidated tags: ${tags.join(', ')} with cache profile \"max\" `,\n  )\n}\n\n/**\n * Used by `<SanityLive onReconnect={refreshAction} onRestart={refreshAction} />`\n * @deprecated - refactor `onReconnect` and `onRestart` to support `() => 'refresh'`\n */\nexport async function refreshAction(): Promise<void> {\n  refresh()\n}\n"],"mappings":";;;;;;;AAUA,eAAsB,yBAAyB,YAAoC;CACjF,MAAM,EAAC,MAAM,eAAc,UAAU,WAAW;AAChD,MAAK,MAAM,WAAW,EAAE,WAAW;AACjC,UAAQ,KACN,eAAe,eAAe,WAAW,mBAAmB,GAAG,6HAC/D,EAAC,MAAK,CACP;AACD,WAAS;AACT;;AAGF,MAAK,MAAM,OAAO,KAChB,eAAc,KAAK,MAAM;AAI3B,SAAQ,IACN,eAAe,eAAe,WAAW,mBAAmB,GAAG,uBAAuB,KAAK,KAAK,KAAK,CAAC,4BACvG;;;;;;AAOH,eAAsB,gBAA+B;AACnD,UAAS"}

package/dist/types.d.ts

@@ -5,29 +5,47 @@ import { ClientPerspective, ClientReturn, ContentSourceMap, LiveEvent, QueryPara
 */
 type LivePerspective = Exclude<ClientPerspective, "raw">;
 /**
-* TODO: docs
+* Fetches data through the configured Sanity client and returns the result
+* together with the source map and cache tags that Sanity Live uses for
+* targeted revalidation.
+*
+* Returned by `defineLive({strict: false})` and `defineLive({strict: undefined})`.
 */
 type DefinedFetchType = <const QueryString extends string>(options: {
+  /**
+  * GROQ query to execute.
+  */
   query: QueryString;
+  /**
+  * Parameters used by the GROQ query.
+  */
   params?: QueryParams | Promise<QueryParams>;
   /**
-  * @defaultValue 'published'
+  * Content perspective used for the fetch.
+  *
+  * @defaultValue The configured client perspective, usually `'published'`.
   */
   perspective?: LivePerspective;
   /**
-  * Enables stega encoding of the data, this is typically only used in draft mode in conjunction with `perspective: 'drafts'` and with `@sanity/visual-editing` setup.
+  * Enables stega encoding of the data. This is typically only used in draft
+  * mode with `perspective: 'drafts'` and `@sanity/visual-editing`.
+  *
   * @defaultValue `false`
   */
   stega?: boolean;
   /**
-  * Custom cache tags that can be used with next's  `updateTag` functions for custom `read-your-write` server actions,
-  * for example a like button that uses client.mutate to update a document and then immediately shows the result.
+  * Additional cache tags to associate with this fetch.
+  *
+  * `sanityFetch` automatically adds Sanity Live sync tags for the query. Use
+  * this for custom tags that should also be invalidated by your own server
+  * actions, for example after a mutation that needs read-your-own-write UI.
   */
   tags?: string[];
   /**
-  * This request tag is used to identify the request when viewing request logs from your Sanity Content Lake.
+  * Request tag used to identify the request in Sanity Content Lake logs.
+  *
   * @see https://www.sanity.io/docs/reference-api-request-tags
-  * @defaultValue 'next-loader.fetch'
+  * @defaultValue `'next-loader.fetch'` or `'next-loader.fetch.cache-components'`
   */
   requestTag?: string;
 }) => Promise<{
@@ -36,125 +54,176 @@ type DefinedFetchType = <const QueryString extends string>(options: {
   tags: string[];
 }>;
 /**
-* TODO: docs
+* Context passed to Sanity Live event handlers.
 */
 interface SanityLiveActionContext {
+  /**
+  * Whether the current `<SanityLive />` connection includes draft and content
+  * release version events.
+  */
   includeDrafts: boolean;
 }
 /**
-* TODO: docs
-* Has a default implementation tailed the nextjs env and config
+* Server action invoked when Sanity Live receives a content-change message.
+*
+* The argument is the list of cache tags derived from the Live Content API
+* event. The default action revalidates those tags. Return `'refresh'` from a
+* custom action to also call `router.refresh()` in the browser.
 */
 type SanityLiveAction = (unsafeTags: unknown) => Promise<void | "refresh">;
 /**
-* TODO: docs
-* If not defined it'll throw the error during render instead, which will crash the react app
-* unless there's an <ErrorBoundary> surrounding the <SanityLive> component
+* Handles connection, parsing, and event-processing errors.
+*
+* If no handler is provided, the error is thrown during render so it can be
+* caught by the nearest React error boundary.
 */
 type SanityLiveOnError = (event: unknown, context: SanityLiveActionContext) => void | Promise<void>;
 /**
-* TODO: docs
-* Optional, logs console.info by default
+* Handles the Live Content API `welcome` event.
+*
+* This event fires when the EventSource connection is established. Some export
+* conditions log a connection message by default; pass `false` to
+* `<SanityLive onWelcome={false} />` to disable that behavior.
 */
 type SanityLiveOnWelcome = (event: Extract<LiveEvent, {
   type: "welcome";
 }>, context: SanityLiveActionContext) => void | Promise<void>;
 /**
-* TODO: docs
+* Handles the Live Content API `reconnect` event.
+*
+* The default behavior refreshes the route so Server Components can render with
+* fresh data after reconnecting.
 */
 type SanityLiveOnReconnect = (event: Extract<LiveEvent, {
   type: "reconnect";
 }>, context: SanityLiveActionContext) => void | Promise<void>;
 /**
-* TODO: docs
+* Handles the Live Content API `restart` event.
+*
+* The default behavior refreshes the route so Server Components can render with
+* fresh data after the Live Content API restarts.
 */
 type SanityLiveOnRestart = (event: Extract<LiveEvent, {
   type: "restart";
 }>, context: SanityLiveActionContext) => void | Promise<void>;
 /**
-* TODO: docs
-* This event is fired when the API has hit the limit of concurrent connections, and the API will not deliver live events, in this case long polling intervals is a possible fallback strategy.
-* By default a message will be logged to the console, that creates a refresh interval of 30 seconds.
-* If you set your own event handler make sure you call `setPollingInterval` if you want to activate long-polling, otherwise content goes stale.
+* Handles the Live Content API `goaway` event.
+*
+* This event means the API closed the live connection and will not deliver live
+* events. This can happen when connection limits are reached. A polling refresh
+* interval is the usual fallback; call `setPollingInterval()` from a custom
+* handler to keep content fresh.
 */
 type SanityLiveOnGoaway = (event: Extract<LiveEvent, {
   type: "goaway";
 }>, context: SanityLiveActionContext, setPollingInterval: (interval: number) => void) => void | Promise<void>;
 interface DefinedLiveProps {
   /**
-  * TODO: docs, settings this to `true` enables live events for draft content and requires `browserToken` to be set.
+  * Include draft and content release version events in the live connection.
+  *
+  * Set this to `true` when draft mode is enabled. A `browserToken` must be
+  * configured in `defineLive()` for draft events to be included.
+  *
+  * @defaultValue `false`
   */
   includeDrafts?: boolean;
   /**
-  * TODO: docs
+  * Server action called for each content-change message from the Live Content
+  * API.
+  *
+  * The default action revalidates the cache tags produced by `sanityFetch`.
   */
   action?: SanityLiveAction;
   /**
-  * TODO: docs
+  * Custom error handler. Pass `false` to disable custom handling and throw
+  * errors to the nearest React error boundary.
   */
   onError?: SanityLiveOnError | false;
   /**
-  * TODO: docs
+  * Custom handler for the `welcome` event. Pass `false` to disable the default
+  * connection log.
   */
   onWelcome?: SanityLiveOnWelcome | false;
   /**
-  * TODO: docs
+  * Custom handler for the `reconnect` event. Pass `false` to disable the
+  * default refresh behavior.
   */
   onReconnect?: SanityLiveOnReconnect | false;
   /**
-  * TODO: docs
+  * Custom handler for the `restart` event. Pass `false` to disable the default
+  * refresh behavior.
   */
   onRestart?: SanityLiveOnRestart | false;
   /**
-  *
+  * Custom handler for the `goaway` event. Pass `false` to disable the default
+  * long-polling fallback.
   */
   onGoAway?: SanityLiveOnGoaway | false;
   /**
-  * Automatic refresh of RSC when the component <SanityLive /> is mounted.
+  * Refresh Server Components once when `<SanityLive />` mounts.
+  *
+  * This can close the gap between the initial server render and the browser
+  * establishing the live EventSource connection.
+  *
   * @defaultValue `false`
   */
   refreshOnMount?: boolean;
   /**
-  * Automatically refresh when window gets focused
+  * Refresh Server Components when the page becomes visible or the window
+  * regains focus.
+  *
   * @defaultValue `false`
   */
   refreshOnFocus?: boolean;
   /**
-  * Automatically refresh when the browser regains a network connection (via navigator.onLine)
-  * @defaultValue `false`
+  * Refresh Server Components when the browser regains a network connection.
   */
   refreshOnReconnect?: boolean;
   /**
-  * This request tag is used to identify the request when viewing request logs from your Sanity Content Lake.
+  * Request tag used to identify the live EventSource request in Sanity Content
+  * Lake logs.
+  *
   * @see https://www.sanity.io/docs/reference-api-request-tags
-  * @defaultValue 'next-loader.live'|'next-loader.live.cache-components'
+  * @defaultValue `'next-loader.live'` or `'next-loader.live.cache-components'`
   */
   requestTag?: string;
 }
 interface DefineLiveOptions {
   /**
-  * Required for `fetch()` and `<Live>` to work
+  * Sanity client used by `sanityFetch()` and `<SanityLive />`.
   */
   client: SanityClient;
   /**
-  * Optional. If provided then the token needs to have permissions to query documents with `drafts.` prefixes in order for `perspective: 'drafts'` to work.
-  * This token is never shared with the browser, unless you reuse it in `browserToken`..
+  * Token used by the server to query drafts and content release versions.
+  *
+  * This token is never shared with the browser unless you also pass it as
+  * `browserToken`.
   */
   serverToken?: string | false;
   /**
-  * Optional. This token is shared with the browser when `<Live>` is given a `perspective` prop other than `"published"`, and should only have access to query published documents.
-  * It is used to setup a `Live Draft Content` EventSource connection, and enables live previewing drafts stand-alone, outside of Presentation Tool.
+  * Token shared with the browser when `<SanityLive includeDrafts />` opens a
+  * draft-capable live connection.
+  *
+  * Use a browser-safe token with the minimum read permissions needed for live
+  * previewing drafts outside Presentation Tool.
   */
   browserToken?: string | false;
   /**
-  * Optional. Include stega encoding when draft mode is enabled.
-  *  @deprecated This option is deprecated, as it does not have an effect when `cacheComponents: true`
-  *  @defaultValue `true`
+  * 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;
   /**
-  * When `true`, requires explicit `includeDrafts` on `<SanityLive>` and explicit `perspective`/`stega` on `sanityFetch`.
-  * Use this to prepare for migrating to `cacheComponents: true` while still using `cacheComponents: false`.
+  * Require explicit live-content options at every call site.
+  *
+  * When `true`, `includeDrafts` is required on `<SanityLive />` and
+  * `perspective`/`stega` are required on `sanityFetch()`. This matches the
+  * explicit data flow needed inside Cache Components, where `draftMode()` and
+  * `cookies()` must be resolved outside `'use cache'` boundaries.
+  *
   * @defaultValue `false`
   */
   strict?: boolean;
@@ -182,5 +251,5 @@ type StrictDefinedFetchType = <const QueryString extends string>(options: {
   sourceMap: ContentSourceMap | null;
   tags: string[];
 }>;
-export { SanityLiveAction as a, SanityLiveOnReconnect as c, StrictDefinedFetchType as d, StrictDefinedLiveProps as f, LivePerspective as i, SanityLiveOnRestart as l, DefinedFetchType as n, SanityLiveOnError as o, DefinedLiveProps as r, SanityLiveOnGoaway as s, DefineLiveOptions as t, SanityLiveOnWelcome as u };
+export { SanityLiveAction as a, SanityLiveOnGoaway as c, SanityLiveOnWelcome as d, StrictDefinedFetchType as f, LivePerspective as i, SanityLiveOnReconnect as l, DefinedFetchType as n, SanityLiveActionContext as o, StrictDefinedLiveProps as p, DefinedLiveProps as r, SanityLiveOnError as s, DefineLiveOptions as t, SanityLiveOnRestart as u };
 //# sourceMappingURL=types.d.ts.map

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;;AAKtC;;KAAY,gBAAA,sCAAsD,OAAA;EAChE,KAAA,EAAO,WAAA;EACP,MAAA,GAAS,WAAA,GAAc,OAAA,CAAQ,WAAA;;;;EAI/B,WAAA,GAAc,eAAA;;;;;EAKd,KAAA;;;;;EAKA,IAAA;;;;;;EAMA,UAAA;AAAA,MACI,OAAA;EACJ,IAAA,EAAM,YAAA,CAAa,WAAA;EACnB,SAAA,EAAW,gBAAA;EACX,IAAA;AAAA;;;;UAMe,uBAAA;EACf,aAAA;AAAA;AADF;;;;AAAA,KAQY,gBAAA,IAAoB,UAAA,cAAwB,OAAA;AAAxD;;;;;AAAA,KAMY,iBAAA,IACV,KAAA,WACA,OAAA,EAAS,uBAAA,YACC,OAAA;;;;;KAKA,mBAAA,IACV,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,uBAAA,YACC,OAAA;;;AAHZ;KAOY,qBAAA,IACV,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,uBAAA,YACC,OAAA;;;;KAIA,mBAAA,IACV,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,uBAAA,YACC,OAAA;;;;;;;KAOA,kBAAA,IACV,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,uBAAA,EACT,kBAAA,GAAqB,QAAA,6BACX,OAAA;AAAA,UAOK,gBAAA;;;;EAIf,aAAA;;;;EAIA,MAAA,GAAS,gBAAA;;;;EAIT,OAAA,GAAU,iBAAA;EAjCZ;;;EAqCE,SAAA,GAAY,mBAAA;;;;EAIZ,WAAA,GAAc,qBAAA;EAtCJ;;;EA0CV,SAAA,GAAY,mBAAA;;;;EAIZ,QAAA,GAAW,kBAAA;;;AAvCb;;EA6CE,cAAA;;;;;EAKA,cAAA;EA9CU;;;;EAmDV,kBAAA;;;;;;EAOA,UAAA;AAAA;AAAA,UAGe,iBAAA;EAtDA;;;EA0Df,MAAA,EAAQ,YAAA;;;;;EAKR,WAAA;EAnCW;;;;EAwCX,YAAA;;;;;;EAMA,KAAA;;;;;;EAMA,MAAA;AAAA;;;AA1BF;;UAiCiB,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"}
+{"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;EAiBF;;;;;AAeA;EAzBE,UAAA;AAAA,MACI,OAAA;EACJ,IAAA,EAAM,YAAA,CAAa,WAAA;EACnB,SAAA,EAAW,gBAAA;EACX,IAAA;AAAA;;;;UAMe,uBAAA;;;;;EAKf,aAAA;AAAA;;;;;;;;KAUU,gBAAA,IAAoB,UAAA,cAAwB,OAAA;;;;;;;KAO5C,iBAAA,IACV,KAAA,WACA,OAAA,EAAS,uBAAA,YACC,OAAA;;AAkBZ;;;;;;KAVY,mBAAA,IACV,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,uBAAA,YACC,OAAA;;;;;;;KAOA,qBAAA,IACV,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,uBAAA,YACC,OAAA;AAOZ;;;;;;AAAA,KAAY,mBAAA,IACV,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,uBAAA,YACC,OAAA;;;;;;;;;KASA,kBAAA,IACV,KAAA,EAAO,OAAA,CAAQ,SAAA;EAAY,IAAA;AAAA,IAC3B,OAAA,EAAS,uBAAA,EACT,kBAAA,GAAqB,QAAA,6BACX,OAAA;AAAA,UAOK,gBAAA;;;;;;;;;EASf,aAAA;;;;;AATF;;EAgBE,MAAA,GAAS,gBAAA;;;;;EAKT,OAAA,GAAU,iBAAA;;;;;EAKV,SAAA,GAAY,mBAAA;;;;;EAKZ,WAAA,GAAc,qBAAA;;;;;EAKd,SAAA,GAAY,mBAAA;;;;;EAKZ,QAAA,GAAW,kBAAA;;;AAiCb;;;;;;EAvBE,cAAA;;;;;;AAoEF;EA7DE,cAAA;;;;EAIA,kBAAA;;;;AAiEF;;;;EAxDE,UAAA;AAAA;AAAA,UAGe,iBAAA;;;;EAIf,MAAA,EAAQ,YAAA;;;;;;;EAOR,WAAA;;;;;;;;EAQA,YAAA;;;;;;;;EAQA,KAAA;;;;;;;;;;;EAWA,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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-sanity",
-  "version": "13.0.0-cache-components.42",
+  "version": "13.0.0-cache-components.43",
   "description": "Sanity.io toolkit for Next.js",
   "keywords": [
     "live",
@@ -48,10 +48,7 @@
     },
     "./live/cache-life": "./dist/live/cache-life.js",
     "./live/client-components": "./dist/live/client-components/index.js",
-    "./live/server-actions": {
-      "next-js": "./dist/live/server-actions/index.next-js.js",
-      "default": "./dist/live/server-actions/index.default.js"
-    },
+    "./live/server-actions": "./dist/live/server-actions/index.js",
     "./studio": "./dist/studio/index.js",
     "./studio/client-component": "./dist/studio/client-component/index.js",
     "./visual-editing": "./dist/visual-editing/index.js",

package/dist/live/server-actions/index.default.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.default.d.ts","names":[],"sources":["../../../src/live/server-actions/index.default.ts"],"mappings":"AAUA;;;AAAA,iBAAsB,wBAAA,CAAyB,UAAA,YAAsB,OAAA;;AAyBrE;;;iBAAsB,aAAA,CAAA,GAAiB,OAAA"}