next-sanity 13.0.0-cache-components.19 → 13.0.0-cache-components.20

package/dist/live/conditions/next-js/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["fetch","Live","SanityLiveClientComponent"],"sources":["../../../../src/live/conditions/next-js/defineLive.tsx"],"sourcesContent":["import type {DefinedFetchType, DefinedLiveProps, LiveOptions} from '#live/types'\n\nimport {DRAFT_SYNC_TAG_PREFIX, PUBLISHED_SYNC_TAG_PREFIX, revalidate} from '#live/constants'\nimport {SanityLive as SanityLiveClientComponent} from 'next-sanity/live/client-components'\nimport {actionLiveEvent, actionLiveEventIncludingDrafts} from 'next-sanity/live/server-actions'\nimport {cacheLife, cacheTag} from 'next/cache'\nimport {preconnect} from 'react-dom'\n\nimport type {DefinedSanityFetchType, DefinedSanityLiveProps} from '../react-server/defineLive'\n\nexport function defineLive(config: LiveOptions): {\n  sanityFetch: DefinedSanityFetchType\n  SanityLive: React.ComponentType<DefinedSanityLiveProps>\n} {\n  const {client: _client, serverToken, browserToken} = 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: true})\n  const {token: originalToken} = client.config()\n\n  const fetch: DefinedFetchType = async function fetch({\n    query,\n    params = {},\n    perspective = 'published',\n    stega = false,\n    tags: customCacheTags = [],\n    requestTag = 'next-loader.fetch.cache-components',\n  }) {\n    const useCdn = perspective === 'published'\n\n    const {result, resultSourceMap, syncTags} = await client.fetch(query, params, {\n      filterResponse: false,\n      returnQuery: false,\n      perspective,\n      useCdn,\n      stega,\n      cacheMode: useCdn ? 'noStale' : undefined,\n      tag: requestTag,\n      token: perspective === 'published' ? originalToken : serverToken || originalToken, // @TODO can pass undefined instead of config.token here?\n    })\n    const tags = [\n      ...customCacheTags,\n      ...(syncTags || []).map(\n        (tag) =>\n          `${perspective === 'published' ? PUBLISHED_SYNC_TAG_PREFIX : DRAFT_SYNC_TAG_PREFIX}${tag}`,\n      ),\n    ]\n    /**\n     * The tags used here, are expired later on in the `expireTags` Server Action with the `expireTag` function from `next/cache`\n     */\n    cacheTag(...tags)\n    /**\n     * Sanity Live handles on-demand revalidation, so the default 15min time based revalidation is too short,\n     * userland can still set a shorter revalidate time by calling `cacheLife` themselves.\n     */\n    cacheLife({revalidate})\n\n    return {data: result, sourceMap: resultSourceMap || null, tags}\n  }\n\n  const Live: React.ComponentType<DefinedLiveProps> = function Live(props) {\n    const {\n      includeDrafts = false,\n      onLiveEvent = actionLiveEvent,\n      onLiveEventIncludingDrafts = actionLiveEventIncludingDrafts,\n      refreshOnMount = false,\n      refreshOnFocus = false,\n      refreshOnReconnect = false,\n      requestTag = 'next-loader.live.cache-components',\n      onError,\n      onGoAway,\n      intervalOnGoAway,\n    } = props\n\n    const shouldIncludeDrafts = typeof browserToken === 'string' && includeDrafts\n\n    const {projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix} =\n      client.config()\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        onLiveEvent={onLiveEvent}\n        onLiveEventIncludingDrafts={onLiveEventIncludingDrafts}\n        requestTag={requestTag}\n        refreshOnMount={refreshOnMount}\n        refreshOnFocus={refreshOnFocus}\n        refreshOnReconnect={refreshOnReconnect}\n        onError={onError}\n        onGoAway={onGoAway}\n        intervalOnGoAway={intervalOnGoAway}\n      />\n    )\n  }\n  Live.displayName = 'SanityLiveServerComponent'\n\n  return {\n    sanityFetch: fetch,\n    SanityLive: Live,\n  }\n}\n"],"mappings":";;;;;;;;AAUA,SAAgB,WAAW,QAGzB;CACA,MAAM,EAAC,QAAQ,SAAS,aAAa,iBAAgB;AAErD,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;EAAK,CAAC;CAC1E,MAAM,EAAC,OAAO,kBAAiB,OAAO,QAAQ;CAE9C,MAAM,QAA0B,eAAeA,QAAM,EACnD,OACA,SAAS,EAAE,EACX,cAAc,aACd,QAAQ,OACR,MAAM,kBAAkB,EAAE,EAC1B,aAAa,wCACZ;EACD,MAAM,SAAS,gBAAgB;EAE/B,MAAM,EAAC,QAAQ,iBAAiB,aAAY,MAAM,OAAO,MAAM,OAAO,QAAQ;GAC5E,gBAAgB;GAChB,aAAa;GACb;GACA;GACA;GACA,WAAW,SAAS,YAAY,KAAA;GAChC,KAAK;GACL,OAAO,gBAAgB,cAAc,gBAAgB,eAAe;GACrE,CAAC;EACF,MAAM,OAAO,CACX,GAAG,iBACH,IAAI,YAAY,EAAE,EAAE,KACjB,QACC,GAAG,gBAAgB,cAAc,4BAA4B,wBAAwB,MACxF,CACF;AAID,WAAS,GAAG,KAAK;AAKjB,YAAU,EAAC,YAAW,CAAC;AAEvB,SAAO;GAAC,MAAM;GAAQ,WAAW,mBAAmB;GAAM;GAAK;;CAGjE,MAAM,OAA8C,SAASC,OAAK,OAAO;EACvE,MAAM,EACJ,gBAAgB,OAChB,cAAc,iBACd,6BAA6B,gCAC7B,iBAAiB,OACjB,iBAAiB,OACjB,qBAAqB,OACrB,aAAa,qCACb,SACA,UACA,qBACE;EAEJ,MAAM,sBAAsB,OAAO,iBAAiB,YAAY;EAEhE,MAAM,EAAC,WAAW,SAAS,SAAS,YAAY,oBAAoB,qBAClE,OAAO,QAAQ;EAGjB,MAAM,EAAC,WAAU,IAAI,IAAI,OAAO,OAAO,IAAI,MAAM,CAAC;AAClD,aAAW,OAAO;AAElB,SACE,oBAACC,YAAAA;GACC,QAAQ;IACN;IACA;IACA;IACA;IACA;IACA;IACA,OAAO,sBAAsB,eAAe,KAAA;IAC7C;GACD,eAAe;GACF;GACe;GAChB;GACI;GACA;GACI;GACX;GACC;GACQ;IAClB;;AAGN,MAAK,cAAc;AAEnB,QAAO;EACL,aAAa;EACb,YAAY;EACb"}
+{"version":3,"file":"index.js","names":["fetch","Live","SanityLiveClientComponent"],"sources":["../../../../src/live/conditions/next-js/defineLive.tsx"],"sourcesContent":["import type {DefinedFetchType, DefinedLiveProps, LiveOptions} from '#live/types'\n\nimport {DRAFT_SYNC_TAG_PREFIX, PUBLISHED_SYNC_TAG_PREFIX, revalidate} from '#live/constants'\nimport {SanityLive as SanityLiveClientComponent} from 'next-sanity/live/client-components'\nimport {actionRefresh, actionUpdateTags} from 'next-sanity/live/server-actions'\nimport {cacheLife, cacheTag} from 'next/cache'\nimport {preconnect} from 'react-dom'\n\nimport type {DefinedSanityFetchType} from '../react-server/defineLive'\n\nexport function defineLive(config: LiveOptions): {\n  sanityFetch: DefinedSanityFetchType\n  SanityLive: React.ComponentType<DefinedLiveProps>\n} {\n  const {client: _client, serverToken, browserToken} = 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: true})\n  const {token: originalToken} = client.config()\n\n  const fetch: DefinedFetchType = async function fetch({\n    query,\n    params = {},\n    perspective = 'published',\n    stega = false,\n    tags: customCacheTags = [],\n    requestTag = 'next-loader.fetch.cache-components',\n  }) {\n    const useCdn = perspective === 'published'\n\n    const {result, resultSourceMap, syncTags} = await client.fetch(query, params, {\n      filterResponse: false,\n      returnQuery: false,\n      perspective,\n      useCdn,\n      stega,\n      cacheMode: useCdn ? 'noStale' : undefined,\n      tag: requestTag,\n      token: perspective === 'published' ? originalToken : serverToken || originalToken, // @TODO can pass undefined instead of config.token here?\n    })\n    const tags = [\n      ...customCacheTags,\n      ...(syncTags || []).map(\n        (tag) =>\n          `${perspective === 'published' ? PUBLISHED_SYNC_TAG_PREFIX : DRAFT_SYNC_TAG_PREFIX}${tag}`,\n      ),\n    ]\n    /**\n     * The tags used here, are expired later on in the `expireTags` Server Action with the `expireTag` function from `next/cache`\n     */\n    cacheTag(...tags)\n    /**\n     * Sanity Live handles on-demand revalidation, so the default 15min time based revalidation is too short,\n     * userland can still set a shorter revalidate time by calling `cacheLife` themselves.\n     */\n    cacheLife({revalidate})\n\n    return {data: result, sourceMap: resultSourceMap || null, tags}\n  }\n\n  const Live: React.ComponentType<DefinedLiveProps> = function Live(props) {\n    const {\n      includeAllDocuments = false,\n      action = actionUpdateTags,\n      restartAction = actionRefresh,\n      reconnectAction = actionRefresh,\n      goAwayAction,\n      welcomeAction,\n      refreshOnMount = false,\n      refreshOnFocus = false,\n      refreshOnReconnect = false,\n      requestTag = 'next-loader.live.cache-components',\n    } = props\n\n    const shouldIncludeDrafts = typeof browserToken === 'string' && includeAllDocuments\n\n    const {projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix} =\n      client.config()\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        includeAllDocuments={shouldIncludeDrafts}\n        action={action}\n        reconnectAction={reconnectAction === false ? undefined : reconnectAction}\n        restartAction={restartAction === false ? undefined : restartAction}\n        welcomeAction={welcomeAction}\n        goAwayAction={goAwayAction}\n        requestTag={requestTag}\n        refreshOnMount={refreshOnMount}\n        refreshOnFocus={refreshOnFocus}\n        refreshOnReconnect={refreshOnReconnect}\n      />\n    )\n  }\n  Live.displayName = 'SanityLiveServerComponent'\n\n  return {\n    sanityFetch: fetch,\n    SanityLive: Live,\n  }\n}\n"],"mappings":";;;;;;;;AAUA,SAAgB,WAAW,QAGzB;CACA,MAAM,EAAC,QAAQ,SAAS,aAAa,iBAAgB;AAErD,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;EAAK,CAAC;CAC1E,MAAM,EAAC,OAAO,kBAAiB,OAAO,QAAQ;CAE9C,MAAM,QAA0B,eAAeA,QAAM,EACnD,OACA,SAAS,EAAE,EACX,cAAc,aACd,QAAQ,OACR,MAAM,kBAAkB,EAAE,EAC1B,aAAa,wCACZ;EACD,MAAM,SAAS,gBAAgB;EAE/B,MAAM,EAAC,QAAQ,iBAAiB,aAAY,MAAM,OAAO,MAAM,OAAO,QAAQ;GAC5E,gBAAgB;GAChB,aAAa;GACb;GACA;GACA;GACA,WAAW,SAAS,YAAY,KAAA;GAChC,KAAK;GACL,OAAO,gBAAgB,cAAc,gBAAgB,eAAe;GACrE,CAAC;EACF,MAAM,OAAO,CACX,GAAG,iBACH,IAAI,YAAY,EAAE,EAAE,KACjB,QACC,GAAG,gBAAgB,cAAc,4BAA4B,wBAAwB,MACxF,CACF;AAID,WAAS,GAAG,KAAK;AAKjB,YAAU,EAAC,YAAW,CAAC;AAEvB,SAAO;GAAC,MAAM;GAAQ,WAAW,mBAAmB;GAAM;GAAK;;CAGjE,MAAM,OAA8C,SAASC,OAAK,OAAO;EACvE,MAAM,EACJ,sBAAsB,OACtB,SAAS,kBACT,gBAAgB,eAChB,kBAAkB,eAClB,cACA,eACA,iBAAiB,OACjB,iBAAiB,OACjB,qBAAqB,OACrB,aAAa,wCACX;EAEJ,MAAM,sBAAsB,OAAO,iBAAiB,YAAY;EAEhE,MAAM,EAAC,WAAW,SAAS,SAAS,YAAY,oBAAoB,qBAClE,OAAO,QAAQ;EAGjB,MAAM,EAAC,WAAU,IAAI,IAAI,OAAO,OAAO,IAAI,MAAM,CAAC;AAClD,aAAW,OAAO;AAElB,SACE,oBAACC,YAAAA;GACC,QAAQ;IACN;IACA;IACA;IACA;IACA;IACA;IACA,OAAO,sBAAsB,eAAe,KAAA;IAC7C;GACD,qBAAqB;GACb;GACR,iBAAiB,oBAAoB,QAAQ,KAAA,IAAY;GACzD,eAAe,kBAAkB,QAAQ,KAAA,IAAY;GACtC;GACD;GACF;GACI;GACA;GACI;IACpB;;AAGN,MAAK,cAAc;AAEnB,QAAO;EACL,aAAa;EACb,YAAY;EACb"}

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

@@ -1,3 +1,4 @@
 import { t as isCorsOriginError } from "../../../isCorsOriginError.js";
-import { c as PerspectiveType, i as defineLive, u as resolvePerspectiveFromCookies } from "../../../defineLive.js";
+import { r as PerspectiveType } from "../../../types.js";
+import { a as resolvePerspectiveFromCookies, r as defineLive } from "../../../defineLive.js";
 export { type PerspectiveType as LivePerspective, defineLive, isCorsOriginError, resolvePerspectiveFromCookies };

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

@@ -5,7 +5,7 @@ import { perspectiveCookieName } from "@sanity/preview-url-secret/constants";
 import { cookies, draftMode } from "next/headers";
 import { jsx } from "react/jsx-runtime";
 import { SanityLive } from "next-sanity/live/client-components";
-import { actionLiveEvent, actionLiveEventIncludingDrafts } from "next-sanity/live/server-actions";
+import { actionRefresh, actionUpdateTags } from "next-sanity/live/server-actions";
 import { preconnect } from "react-dom";
 function defineLive(config) {
 	const { client: _client, serverToken, browserToken, fetchOptions, stega: stegaEnabled = true } = config;
@@ -57,9 +57,9 @@ function defineLive(config) {
 		};
 	};
 	const SanityLive$1 = async function SanityLive$2(props) {
-		const { includeDrafts = (await draftMode()).isEnabled, onLiveEvent: onChange = actionLiveEvent, onLiveEventIncludingDrafts: onChangeIncludingDrafts = actionLiveEventIncludingDrafts, refreshOnMount, refreshOnFocus, refreshOnReconnect, requestTag = "next-loader.live", onError, onGoAway, intervalOnGoAway, perspective: _perspective } = props;
+		const { includeAllDocuments = (await draftMode()).isEnabled, action = actionUpdateTags, restartAction = actionRefresh, reconnectAction = actionRefresh, goAwayAction, welcomeAction, refreshOnMount, refreshOnFocus, refreshOnReconnect, requestTag = "next-loader.live" } = props;
 		const { projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix } = client.config();
-		const shouldIncludeDrafts = typeof browserToken === "string" && includeDrafts;
+		const shouldIncludeAllDocuments = typeof browserToken === "string" && includeAllDocuments;
 		const { origin } = new URL(client.getUrl("", false));
 		preconnect(origin);
 		return /* @__PURE__ */ jsx(SanityLive, {
@@ -70,18 +70,18 @@ function defineLive(config) {
 				apiVersion,
 				useProjectHostname,
 				requestTagPrefix,
-				token: shouldIncludeDrafts ? browserToken : void 0
+				token: shouldIncludeAllDocuments ? browserToken : void 0
 			},
-			includeDrafts: shouldIncludeDrafts,
-			onLiveEvent: onChange,
-			onLiveEventIncludingDrafts: onChangeIncludingDrafts,
+			includeAllDocuments: shouldIncludeAllDocuments,
+			action,
+			reconnectAction: reconnectAction === false ? void 0 : reconnectAction,
+			restartAction: restartAction === false ? void 0 : restartAction,
+			welcomeAction,
+			goAwayAction,
 			requestTag,
 			refreshOnMount,
 			refreshOnFocus,
-			refreshOnReconnect,
-			onError,
-			onGoAway,
-			intervalOnGoAway
+			refreshOnReconnect
 		});
 	};
 	SanityLive$1.displayName = "SanityLiveServerComponent";

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["sanityFetch","tag","SanityLive","SanityLiveClientComponent"],"sources":["../../../../src/live/conditions/react-server/defineLive.tsx"],"sourcesContent":["import type {DefinedLiveProps, PerspectiveType} from '#live/types'\n\nimport {sanitizePerspective} from '#live/sanitizePerspective'\nimport {\n  type ClientPerspective,\n  type ClientReturn,\n  type ContentSourceMap,\n  type QueryParams,\n  type SanityClient,\n} from '@sanity/client'\nimport {perspectiveCookieName} from '@sanity/preview-url-secret/constants'\nimport {SanityLive as SanityLiveClientComponent} from 'next-sanity/live/client-components'\nimport {actionLiveEvent, actionLiveEventIncludingDrafts} from 'next-sanity/live/server-actions'\nimport {cookies, draftMode} from 'next/headers'\nimport {preconnect} from 'react-dom'\n\n/**\n * @public\n */\nexport type DefinedSanityFetchType = <const QueryString extends string>(options: {\n  query: QueryString\n  params?: QueryParams | Promise<QueryParams>\n  /**\n   * Add custom `next.tags` to the underlying fetch request.\n   * @see https://nextjs.org/docs/app/api-reference/functions/fetch#optionsnexttags\n   * This can be used in conjunction with custom fallback revalidation strategies, as well as with custom Server Actions that mutate data and want to render with fresh data right away (faster than the Live Event latency).\n   * @defaultValue `['sanity']`\n   */\n  tags?: string[]\n  perspective?: Exclude<ClientPerspective, 'raw'>\n  stega?: boolean\n  /**\n   * This request tag is used to identify the request when viewing request logs from your Sanity Content Lake.\n   * @see https://www.sanity.io/docs/reference-api-request-tags\n   * @defaultValue 'next-loader.fetch'\n   */\n  requestTag?: string\n}) => Promise<{\n  data: ClientReturn<QueryString>\n  sourceMap: ContentSourceMap | null\n  tags: string[]\n}>\n\n/**\n * @public\n */\nexport interface DefinedSanityLiveProps extends DefinedLiveProps {\n  /**\n   * @defaultValue `automatically resolved`\n   */\n  perspective?: PerspectiveType\n}\n\n/**\n * @public\n */\nexport interface DefineSanityLiveOptions {\n  /**\n   * Required for `sanityFetch` and `SanityLive` to work\n   */\n  client: SanityClient\n  /**\n   * Optional. If provided then the token needs to have permissions to query documents with `drafts.` prefixes in order for `perspective: 'drafts'` to work.\n   * This token is not shared with the browser.\n   */\n  serverToken?: string | false\n  /**\n   * Optional. This token is shared with the browser, and should only have access to query published documents.\n   * It is used to setup a `Live Draft Content` EventSource connection, and enables live previewing drafts stand-alone, outside of Presentation Tool.\n   */\n  browserToken?: string | false\n  /**\n   * Fetch options used by `sanityFetch`\n   */\n  fetchOptions?: {\n    /**\n     * Optional, enables time based revalidation in addition to the EventSource connection.\n     * @defaultValue `false`\n     */\n    revalidate?: number | false\n  }\n  /**\n   * Optional. Include stega encoding when draft mode is enabled.\n   *  @defaultValue `true`\n   */\n  stega?: boolean\n}\n\nexport function defineLive(config: DefineSanityLiveOptions): {\n  /**\n   * @deprecated use `fetch` instead, and define your own `sanityFetch` function with logic for when to toggle `stega` and `perspective`\n   */\n  sanityFetch: DefinedSanityFetchType\n  /**\n   * @deprecated use `Live` instead, and define your own `SanityLive` component with logic for when to toggle `perspective`\n   */\n  SanityLive: React.ComponentType<DefinedSanityLiveProps>\n  // fetch: DefinedFetchType\n  // Live: React.ComponentType<DefinedLiveProps>\n} {\n  const {\n    client: _client,\n    serverToken,\n    browserToken,\n    fetchOptions,\n    stega: stegaEnabled = true,\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} = client.config()\n  const studioUrlDefined = typeof client.config().stega.studioUrl !== 'undefined'\n\n  const sanityFetch: DefinedSanityFetchType = async function sanityFetch<\n    const QueryString extends string,\n  >({\n    query,\n    params = {},\n    stega: _stega,\n    tags = ['sanity'],\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    const stega = _stega ?? (stegaEnabled && studioUrlDefined && (await draftMode()).isEnabled)\n    const perspective = _perspective ?? (await resolveCookiePerspective())\n    const useCdn = perspective === 'published'\n    const revalidate =\n      fetchOptions?.revalidate !== undefined\n        ? fetchOptions.revalidate\n        : process.env.NODE_ENV === 'production'\n          ? false\n          : undefined\n\n    // fetch the tags first, with revalidate to 1s to ensure we get the latest tags, eventually\n    const {syncTags} = await client.fetch(query, await params, {\n      filterResponse: false,\n      perspective: perspective as ClientPerspective,\n      stega: false,\n      returnQuery: false,\n      next: {revalidate, tags: [...tags, 'sanity:fetch-sync-tags']},\n      useCdn,\n      cacheMode: useCdn ? 'noStale' : undefined,\n      tag: [requestTag, 'fetch-sync-tags'].filter(Boolean).join('.'),\n    })\n\n    const cacheTags = [...tags, ...(syncTags?.map((tag) => `sanity:${tag}`) || [])]\n\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, tags: cacheTags},\n      useCdn,\n      cacheMode: useCdn ? 'noStale' : undefined,\n      tag: requestTag,\n    })\n    return {data: result, sourceMap: resultSourceMap || null, tags: cacheTags}\n  }\n\n  const SanityLive: React.ComponentType<DefinedSanityLiveProps> = async function SanityLive(props) {\n    const {\n      includeDrafts = (await draftMode()).isEnabled,\n      onLiveEvent: onChange = actionLiveEvent,\n      onLiveEventIncludingDrafts: onChangeIncludingDrafts = actionLiveEventIncludingDrafts,\n      refreshOnMount,\n      refreshOnFocus,\n      refreshOnReconnect,\n      requestTag = 'next-loader.live',\n      onError,\n      onGoAway,\n      intervalOnGoAway,\n      perspective: _perspective,\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        onLiveEvent={onChange}\n        onLiveEventIncludingDrafts={onChangeIncludingDrafts}\n        requestTag={requestTag}\n        refreshOnMount={refreshOnMount}\n        refreshOnFocus={refreshOnFocus}\n        refreshOnReconnect={refreshOnReconnect}\n        onError={onError}\n        onGoAway={onGoAway}\n        intervalOnGoAway={intervalOnGoAway}\n      />\n    )\n  }\n  SanityLive.displayName = 'SanityLiveServerComponent'\n\n  return {\n    sanityFetch,\n    SanityLive,\n  }\n}\n\nasync function resolveCookiePerspective(): 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    : 'published'\n}\n"],"mappings":";;;;;;;;;AAwFA,SAAgB,WAAW,QAWzB;CACA,MAAM,EACJ,QAAQ,SACR,aACA,cACA,cACA,OAAO,eAAe,SACpB;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,kBAAiB,OAAO,QAAQ;CAC9C,MAAM,mBAAmB,OAAO,OAAO,QAAQ,CAAC,MAAM,cAAc;CAEpE,MAAM,cAAsC,eAAeA,cAEzD,EACA,OACA,SAAS,EAAE,EACX,OAAO,QACP,OAAO,CAAC,SAAS,EACjB,aAAa,cACb,KACA,aAAa,OAAO,uBASnB;EACD,MAAM,QAAQ,WAAW,gBAAgB,qBAAqB,MAAM,WAAW,EAAE;EACjF,MAAM,cAAc,gBAAiB,MAAM,0BAA0B;EACrE,MAAM,SAAS,gBAAgB;EAC/B,MAAM,aACJ,cAAc,eAAe,KAAA,IACzB,aAAa,aACb,QAAQ,IAAI,aAAa,eACvB,QACA,KAAA;EAGR,MAAM,EAAC,aAAY,MAAM,OAAO,MAAM,OAAO,MAAM,QAAQ;GACzD,gBAAgB;GACH;GACb,OAAO;GACP,aAAa;GACb,MAAM;IAAC;IAAY,MAAM,CAAC,GAAG,MAAM,yBAAyB;IAAC;GAC7D;GACA,WAAW,SAAS,YAAY,KAAA;GAChC,KAAK,CAAC,YAAY,kBAAkB,CAAC,OAAO,QAAQ,CAAC,KAAK,IAAI;GAC/D,CAAC;EAEF,MAAM,YAAY,CAAC,GAAG,MAAM,GAAI,UAAU,KAAK,UAAQ,UAAUC,QAAM,IAAI,EAAE,CAAE;EAE/E,MAAM,EAAC,QAAQ,oBAAmB,MAAM,OAAO,MAAM,OAAO,MAAM,QAAQ;GACxE,gBAAgB;GACH;GACb;GACA,OAAO,gBAAgB,eAAe,cAAc,cAAc;GAClE,MAAM;IAAC;IAAY,MAAM;IAAU;GACnC;GACA,WAAW,SAAS,YAAY,KAAA;GAChC,KAAK;GACN,CAAC;AACF,SAAO;GAAC,MAAM;GAAQ,WAAW,mBAAmB;GAAM,MAAM;GAAU;;CAG5E,MAAMC,eAA0D,eAAeA,aAAW,OAAO;EAC/F,MAAM,EACJ,iBAAiB,MAAM,WAAW,EAAE,WACpC,aAAa,WAAW,iBACxB,4BAA4B,0BAA0B,gCACtD,gBACA,gBACA,oBACA,aAAa,oBACb,SACA,UACA,kBACA,aAAa,iBACX;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,YAAAA;GACC,QAAQ;IACN;IACA;IACA;IACA;IACA;IACA;IACA,OAAO,sBAAsB,eAAe,KAAA;IAC7C;GACD,eAAe;GACf,aAAa;GACb,4BAA4B;GAChB;GACI;GACA;GACI;GACX;GACC;GACQ;IAClB;;AAGN,cAAW,cAAc;AAEzB,QAAO;EACL;EACA,YAAA;EACD;;AAGH,eAAe,2BAAuE;AACpF,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":["sanityFetch","tag","SanityLive","SanityLiveClientComponent"],"sources":["../../../../src/live/conditions/react-server/defineLive.tsx"],"sourcesContent":["import type {DefinedLiveProps} from '#live/types'\n\nimport {sanitizePerspective} from '#live/sanitizePerspective'\nimport {\n  type ClientPerspective,\n  type ClientReturn,\n  type ContentSourceMap,\n  type QueryParams,\n  type SanityClient,\n} from '@sanity/client'\nimport {perspectiveCookieName} from '@sanity/preview-url-secret/constants'\nimport {SanityLive as SanityLiveClientComponent} from 'next-sanity/live/client-components'\nimport {actionRefresh, actionUpdateTags} from 'next-sanity/live/server-actions'\nimport {cookies, draftMode} from 'next/headers'\nimport {preconnect} from 'react-dom'\n\n/**\n * @public\n */\nexport type DefinedSanityFetchType = <const QueryString extends string>(options: {\n  query: QueryString\n  params?: QueryParams | Promise<QueryParams>\n  /**\n   * Add custom `next.tags` to the underlying fetch request.\n   * @see https://nextjs.org/docs/app/api-reference/functions/fetch#optionsnexttags\n   * This can be used in conjunction with custom fallback revalidation strategies, as well as with custom Server Actions that mutate data and want to render with fresh data right away (faster than the Live Event latency).\n   * @defaultValue `['sanity']`\n   */\n  tags?: string[]\n  perspective?: Exclude<ClientPerspective, 'raw'>\n  stega?: boolean\n  /**\n   * This request tag is used to identify the request when viewing request logs from your Sanity Content Lake.\n   * @see https://www.sanity.io/docs/reference-api-request-tags\n   * @defaultValue 'next-loader.fetch'\n   */\n  requestTag?: string\n}) => Promise<{\n  data: ClientReturn<QueryString>\n  sourceMap: ContentSourceMap | null\n  tags: string[]\n}>\n\n/**\n * @public\n */\nexport interface DefineSanityLiveOptions {\n  /**\n   * Required for `sanityFetch` and `SanityLive` to work\n   */\n  client: SanityClient\n  /**\n   * Optional. If provided then the token needs to have permissions to query documents with `drafts.` prefixes in order for `perspective: 'drafts'` to work.\n   * This token is not shared with the browser.\n   */\n  serverToken?: string | false\n  /**\n   * Optional. This token is shared with the browser, and should only have access to query published documents.\n   * It is used to setup a `Live Draft Content` EventSource connection, and enables live previewing drafts stand-alone, outside of Presentation Tool.\n   */\n  browserToken?: string | false\n  /**\n   * Fetch options used by `sanityFetch`\n   */\n  fetchOptions?: {\n    /**\n     * Optional, enables time based revalidation in addition to the EventSource connection.\n     * @defaultValue `false`\n     */\n    revalidate?: number | false\n  }\n  /**\n   * Optional. Include stega encoding when draft mode is enabled.\n   *  @defaultValue `true`\n   */\n  stega?: boolean\n}\n\nexport function defineLive(config: DefineSanityLiveOptions): {\n  /**\n   * @deprecated use `fetch` instead, and define your own `sanityFetch` function with logic for when to toggle `stega` and `perspective`\n   */\n  sanityFetch: DefinedSanityFetchType\n  /**\n   * @deprecated use `Live` instead, and define your own `SanityLive` component with logic for when to toggle `perspective`\n   */\n  SanityLive: React.ComponentType<DefinedLiveProps>\n  // fetch: DefinedFetchType\n  // Live: React.ComponentType<DefinedLiveProps>\n} {\n  const {\n    client: _client,\n    serverToken,\n    browserToken,\n    fetchOptions,\n    stega: stegaEnabled = true,\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} = client.config()\n  const studioUrlDefined = typeof client.config().stega.studioUrl !== 'undefined'\n\n  const sanityFetch: DefinedSanityFetchType = async function sanityFetch<\n    const QueryString extends string,\n  >({\n    query,\n    params = {},\n    stega: _stega,\n    tags = ['sanity'],\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    const stega = _stega ?? (stegaEnabled && studioUrlDefined && (await draftMode()).isEnabled)\n    const perspective = _perspective ?? (await resolveCookiePerspective())\n    const useCdn = perspective === 'published'\n    const revalidate =\n      fetchOptions?.revalidate !== undefined\n        ? fetchOptions.revalidate\n        : process.env.NODE_ENV === 'production'\n          ? false\n          : undefined\n\n    // fetch the tags first, with revalidate to 1s to ensure we get the latest tags, eventually\n    const {syncTags} = await client.fetch(query, await params, {\n      filterResponse: false,\n      perspective: perspective as ClientPerspective,\n      stega: false,\n      returnQuery: false,\n      next: {revalidate, tags: [...tags, 'sanity:fetch-sync-tags']},\n      useCdn,\n      cacheMode: useCdn ? 'noStale' : undefined,\n      tag: [requestTag, 'fetch-sync-tags'].filter(Boolean).join('.'),\n    })\n\n    const cacheTags = [...tags, ...(syncTags?.map((tag) => `sanity:${tag}`) || [])]\n\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, tags: cacheTags},\n      useCdn,\n      cacheMode: useCdn ? 'noStale' : undefined,\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    const {\n      includeAllDocuments = (await draftMode()).isEnabled,\n      action = actionUpdateTags,\n      restartAction = actionRefresh,\n      reconnectAction = actionRefresh,\n      goAwayAction,\n      welcomeAction,\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 shouldIncludeAllDocuments = typeof browserToken === 'string' && includeAllDocuments\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: shouldIncludeAllDocuments ? browserToken : undefined,\n        }}\n        includeAllDocuments={shouldIncludeAllDocuments}\n        action={action}\n        reconnectAction={reconnectAction === false ? undefined : reconnectAction}\n        restartAction={restartAction === false ? undefined : restartAction}\n        welcomeAction={welcomeAction}\n        goAwayAction={goAwayAction}\n        requestTag={requestTag}\n        refreshOnMount={refreshOnMount}\n        refreshOnFocus={refreshOnFocus}\n        refreshOnReconnect={refreshOnReconnect}\n      />\n    )\n  }\n  SanityLive.displayName = 'SanityLiveServerComponent'\n\n  return {\n    sanityFetch,\n    SanityLive,\n  }\n}\n\nasync function resolveCookiePerspective(): 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    : 'published'\n}\n"],"mappings":";;;;;;;;;AA8EA,SAAgB,WAAW,QAWzB;CACA,MAAM,EACJ,QAAQ,SACR,aACA,cACA,cACA,OAAO,eAAe,SACpB;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,kBAAiB,OAAO,QAAQ;CAC9C,MAAM,mBAAmB,OAAO,OAAO,QAAQ,CAAC,MAAM,cAAc;CAEpE,MAAM,cAAsC,eAAeA,cAEzD,EACA,OACA,SAAS,EAAE,EACX,OAAO,QACP,OAAO,CAAC,SAAS,EACjB,aAAa,cACb,KACA,aAAa,OAAO,uBASnB;EACD,MAAM,QAAQ,WAAW,gBAAgB,qBAAqB,MAAM,WAAW,EAAE;EACjF,MAAM,cAAc,gBAAiB,MAAM,0BAA0B;EACrE,MAAM,SAAS,gBAAgB;EAC/B,MAAM,aACJ,cAAc,eAAe,KAAA,IACzB,aAAa,aACb,QAAQ,IAAI,aAAa,eACvB,QACA,KAAA;EAGR,MAAM,EAAC,aAAY,MAAM,OAAO,MAAM,OAAO,MAAM,QAAQ;GACzD,gBAAgB;GACH;GACb,OAAO;GACP,aAAa;GACb,MAAM;IAAC;IAAY,MAAM,CAAC,GAAG,MAAM,yBAAyB;IAAC;GAC7D;GACA,WAAW,SAAS,YAAY,KAAA;GAChC,KAAK,CAAC,YAAY,kBAAkB,CAAC,OAAO,QAAQ,CAAC,KAAK,IAAI;GAC/D,CAAC;EAEF,MAAM,YAAY,CAAC,GAAG,MAAM,GAAI,UAAU,KAAK,UAAQ,UAAUC,QAAM,IAAI,EAAE,CAAE;EAE/E,MAAM,EAAC,QAAQ,oBAAmB,MAAM,OAAO,MAAM,OAAO,MAAM,QAAQ;GACxE,gBAAgB;GACH;GACb;GACA,OAAO,gBAAgB,eAAe,cAAc,cAAc;GAClE,MAAM;IAAC;IAAY,MAAM;IAAU;GACnC;GACA,WAAW,SAAS,YAAY,KAAA;GAChC,KAAK;GACN,CAAC;AACF,SAAO;GAAC,MAAM;GAAQ,WAAW,mBAAmB;GAAM,MAAM;GAAU;;CAG5E,MAAMC,eAAoD,eAAeA,aAAW,OAAO;EACzF,MAAM,EACJ,uBAAuB,MAAM,WAAW,EAAE,WAC1C,SAAS,kBACT,gBAAgB,eAChB,kBAAkB,eAClB,cACA,eACA,gBACA,gBACA,oBACA,aAAa,uBACX;EACJ,MAAM,EAAC,WAAW,SAAS,SAAS,YAAY,oBAAoB,qBAClE,OAAO,QAAQ;EACjB,MAAM,4BAA4B,OAAO,iBAAiB,YAAY;EAGtE,MAAM,EAAC,WAAU,IAAI,IAAI,OAAO,OAAO,IAAI,MAAM,CAAC;AAClD,aAAW,OAAO;AAElB,SACE,oBAACC,YAAAA;GACC,QAAQ;IACN;IACA;IACA;IACA;IACA;IACA;IACA,OAAO,4BAA4B,eAAe,KAAA;IACnD;GACD,qBAAqB;GACb;GACR,iBAAiB,oBAAoB,QAAQ,KAAA,IAAY;GACzD,eAAe,kBAAkB,QAAQ,KAAA,IAAY;GACtC;GACD;GACF;GACI;GACA;GACI;IACpB;;AAGN,cAAW,cAAc;AAEzB,QAAO;EACL;EACA,YAAA;EACD;;AAGH,eAAe,2BAAuE;AACpF,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

@@ -1,10 +1,14 @@
+import { i as SanityLiveActionContext } from "../../types.js";
+import { LiveEvent } from "@sanity/client";
 /**
-* Used by `<SanityLive onLiveEvent={actionLiveEvent} />`
+* Used by `<SanityLive action={actionRevalidateTags} />`
 */
-declare function actionLiveEvent(_tags: unknown): Promise<void>;
+declare function actionUpdateTags(event: Extract<LiveEvent, {
+  type: "message";
+}>, context: SanityLiveActionContext): Promise<void>;
 /**
-* Used by `<SanityLive onLiveEventIncludingDrafts={actionLiveEventIncludingDrafts} />`
+* Used by `<SanityLive reconnectAction={actionRefresh} restartAction={actionRefresh} />`
 */
-declare function actionLiveEventIncludingDrafts(_tags: unknown): Promise<void>;
-export { actionLiveEvent, actionLiveEventIncludingDrafts };
+declare function actionRefresh(): Promise<void>;
+export { actionRefresh, actionUpdateTags };
 //# sourceMappingURL=index.default.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.default.d.ts","names":[],"sources":["../../../src/live/server-actions/index.default.ts"],"sourcesContent":[],"mappings":"AAQA;AAyBA;;iBAzBsB,eAAA,kBAAiC;;;;iBAyBjC,8BAAA,kBAAgD"}
+{"version":3,"file":"index.default.d.ts","names":[],"sources":["../../../src/live/server-actions/index.default.ts"],"sourcesContent":[],"mappings":";;;AAYA;;AACS,iBADa,gBAAA,CACb,KAAA,EAAA,OAAA,CAAQ,SAAR,EAAA;EACE,IAAA,EAAA,SAAA;CACR,CAAA,EAAA,OAAA,EADQ,uBACR,CAAA,EAAA,OAAA,CAAA,IAAA,CAAA;;AAsCH;;iBAAsB,aAAA,CAAA,GAAiB"}

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

@@ -1,35 +1,34 @@
 "use server";
 import { n as PUBLISHED_SYNC_TAG_PREFIX, t as DRAFT_SYNC_TAG_PREFIX } from "../../constants.js";
-import { revalidateTag, updateTag } from "next/cache";
-async function actionLiveEvent(_tags) {
-	if (!Array.isArray(_tags)) {
-		console.warn("<SanityLive /> `expireTags` called with non-array tags", _tags);
+import { draftMode } from "next/headers";
+import { refresh, revalidateTag, updateTag } from "next/cache";
+async function actionUpdateTags(event, context) {
+	if (!Array.isArray(event.tags)) {
+		console.warn(`<SanityLive ${context.includeAllDocuments ? "includeAllDocuments " : ""}/> action called with non-array tags`, event);
 		return;
 	}
-	const tags = _tags.filter((tag) => typeof tag === "string" && tag.startsWith(PUBLISHED_SYNC_TAG_PREFIX));
-	if (!tags.length) {
-		console.warn("<SanityLive /> `expireTags` called with no valid tags", _tags);
-		return;
-	}
-	revalidateTag("sanity:fetch-sync-tags", "max");
-	for (const tag of tags) {
-		revalidateTag(tag, { expire: 0 });
-		console.log(`<SanityLive /> revalidated tag: ${tag}`);
+	if (context.includeAllDocuments) {
+		if (!(await draftMode()).isEnabled) {
+			console.warn("<SanityLive includeAllDocuments /> action called in non-draft mode, ignoring", {
+				event,
+				context
+			});
+			return;
+		}
+		const tags = event.tags.map((tag) => `${DRAFT_SYNC_TAG_PREFIX}${tag}`);
+		for (const tag of tags) updateTag(tag);
+		console.log(`<SanityLive includeAllDocuments /> updated tags: ${tags.join(", ")}`);
+	} else {
+		revalidateTag("sanity:fetch-sync-tags", "max");
+		console.log(`<SanityLive /> revalidated tag: "sanity:fetch-sync-tags" with cache profile "max"`);
+		const tags = event.tags.map((tag) => `${PUBLISHED_SYNC_TAG_PREFIX}${tag}`);
+		for (const tag of tags) updateTag(tag);
+		console.log(`<SanityLive /> updated tags: ${tags.join(", ")}`);
 	}
 }
-async function actionLiveEventIncludingDrafts(_tags) {
-	if (!Array.isArray(_tags)) {
-		console.warn("<SanityLive /> `expireTags` called with non-array tags", _tags);
-		return;
-	}
-	const tags = _tags.filter((tag) => typeof tag === "string" && tag.startsWith(DRAFT_SYNC_TAG_PREFIX));
-	if (!tags.length) {
-		console.warn("<SanityLive /> `expireTags` called with no valid tags", _tags);
-		return;
-	}
-	for (const tag of tags) updateTag(tag);
-	console.log(`<SanityLive /> updated tags: ${tags.join(", ")}`);
+async function actionRefresh() {
+	refresh();
 }
-export { actionLiveEvent, actionLiveEventIncludingDrafts };
+export { actionRefresh, actionUpdateTags };
 
 //# sourceMappingURL=index.default.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.default.js","names":[],"sources":["../../../src/live/server-actions/index.default.ts"],"sourcesContent":["'use server'\n\nimport {DRAFT_SYNC_TAG_PREFIX, PUBLISHED_SYNC_TAG_PREFIX} from '#live/constants'\nimport {revalidateTag, updateTag} from 'next/cache'\n\n/**\n * Used by `<SanityLive onLiveEvent={actionLiveEvent} />`\n */\nexport async function actionLiveEvent(_tags: unknown): Promise<void> {\n  if (!Array.isArray(_tags)) {\n    console.warn('<SanityLive /> `expireTags` called with non-array tags', _tags)\n    return undefined\n  }\n  const tags = _tags.filter(\n    (tag) => typeof tag === 'string' && tag.startsWith(PUBLISHED_SYNC_TAG_PREFIX),\n  )\n  if (!tags.length) {\n    console.warn('<SanityLive /> `expireTags` called with no valid tags', _tags)\n    return undefined\n  }\n\n  revalidateTag('sanity:fetch-sync-tags', 'max')\n\n  for (const tag of tags) {\n    revalidateTag(tag, {expire: 0})\n    // oxlint-disable-next-line no-console\n    console.log(`<SanityLive /> revalidated tag: ${tag}`)\n  }\n}\n\n/**\n * Used by `<SanityLive onLiveEventIncludingDrafts={actionLiveEventIncludingDrafts} />`\n */\nexport async function actionLiveEventIncludingDrafts(_tags: unknown): Promise<void> {\n  // @TODO check draft mode before expiring tags\n  if (!Array.isArray(_tags)) {\n    console.warn('<SanityLive /> `expireTags` called with non-array tags', _tags)\n    return undefined\n  }\n  const tags = _tags.filter(\n    (tag) => typeof tag === 'string' && tag.startsWith(DRAFT_SYNC_TAG_PREFIX),\n  )\n  if (!tags.length) {\n    console.warn('<SanityLive /> `expireTags` called with no valid tags', _tags)\n    return undefined\n  }\n  for (const tag of tags) {\n    updateTag(tag)\n  }\n  // oxlint-disable-next-line no-console\n  console.log(`<SanityLive /> updated tags: ${tags.join(', ')}`)\n}\n"],"mappings":";;;AAQA,eAAsB,gBAAgB,OAA+B;AACnE,KAAI,CAAC,MAAM,QAAQ,MAAM,EAAE;AACzB,UAAQ,KAAK,0DAA0D,MAAM;AAC7E;;CAEF,MAAM,OAAO,MAAM,QAChB,QAAQ,OAAO,QAAQ,YAAY,IAAI,WAAW,0BAA0B,CAC9E;AACD,KAAI,CAAC,KAAK,QAAQ;AAChB,UAAQ,KAAK,yDAAyD,MAAM;AAC5E;;AAGF,eAAc,0BAA0B,MAAM;AAE9C,MAAK,MAAM,OAAO,MAAM;AACtB,gBAAc,KAAK,EAAC,QAAQ,GAAE,CAAC;AAE/B,UAAQ,IAAI,mCAAmC,MAAM;;;AAOzD,eAAsB,+BAA+B,OAA+B;AAElF,KAAI,CAAC,MAAM,QAAQ,MAAM,EAAE;AACzB,UAAQ,KAAK,0DAA0D,MAAM;AAC7E;;CAEF,MAAM,OAAO,MAAM,QAChB,QAAQ,OAAO,QAAQ,YAAY,IAAI,WAAW,sBAAsB,CAC1E;AACD,KAAI,CAAC,KAAK,QAAQ;AAChB,UAAQ,KAAK,yDAAyD,MAAM;AAC5E;;AAEF,MAAK,MAAM,OAAO,KAChB,WAAU,IAAI;AAGhB,SAAQ,IAAI,gCAAgC,KAAK,KAAK,KAAK,GAAG"}
+{"version":3,"file":"index.default.js","names":[],"sources":["../../../src/live/server-actions/index.default.ts"],"sourcesContent":["'use server'\n\nimport type {SanityLiveActionContext} from '#live/types'\nimport type {LiveEvent} from '@sanity/client'\n\nimport {DRAFT_SYNC_TAG_PREFIX, PUBLISHED_SYNC_TAG_PREFIX} from '#live/constants'\nimport {refresh, revalidateTag, updateTag} from 'next/cache'\nimport {draftMode} from 'next/headers'\n\n/**\n * Used by `<SanityLive action={actionRevalidateTags} />`\n */\nexport async function actionUpdateTags(\n  event: Extract<LiveEvent, {type: 'message'}>,\n  context: SanityLiveActionContext,\n): Promise<void> {\n  if (!Array.isArray(event.tags)) {\n    console.warn(\n      `<SanityLive ${context.includeAllDocuments ? 'includeAllDocuments ' : ''}/> action called with non-array tags`,\n      event,\n    )\n    return undefined\n  }\n  if (context.includeAllDocuments) {\n    if (!(await draftMode()).isEnabled) {\n      console.warn('<SanityLive includeAllDocuments /> action called in non-draft mode, ignoring', {\n        event,\n        context,\n      })\n      return undefined\n    }\n    const tags = event.tags.map((tag) => `${DRAFT_SYNC_TAG_PREFIX}${tag}`)\n    for (const tag of tags) {\n      updateTag(tag)\n    }\n    // oxlint-disable-next-line no-console\n    console.log(`<SanityLive includeAllDocuments /> updated tags: ${tags.join(', ')}`)\n  } else {\n    revalidateTag('sanity:fetch-sync-tags', 'max')\n    // oxlint-disable-next-line no-console\n    console.log(`<SanityLive /> revalidated tag: \"sanity:fetch-sync-tags\" with cache profile \"max\"`)\n    const tags = event.tags.map((tag) => `${PUBLISHED_SYNC_TAG_PREFIX}${tag}`)\n    for (const tag of tags) {\n      updateTag(tag)\n    }\n    // oxlint-disable-next-line no-console\n    console.log(`<SanityLive /> updated tags: ${tags.join(', ')}`)\n  }\n}\n\n/**\n * Used by `<SanityLive reconnectAction={actionRefresh} restartAction={actionRefresh} />`\n */\nexport async function actionRefresh(): Promise<void> {\n  refresh()\n}\n"],"mappings":";;;;AAYA,eAAsB,iBACpB,OACA,SACe;AACf,KAAI,CAAC,MAAM,QAAQ,MAAM,KAAK,EAAE;AAC9B,UAAQ,KACN,eAAe,QAAQ,sBAAsB,yBAAyB,GAAG,uCACzE,MACD;AACD;;AAEF,KAAI,QAAQ,qBAAqB;AAC/B,MAAI,EAAE,MAAM,WAAW,EAAE,WAAW;AAClC,WAAQ,KAAK,gFAAgF;IAC3F;IACA;IACD,CAAC;AACF;;EAEF,MAAM,OAAO,MAAM,KAAK,KAAK,QAAQ,GAAG,wBAAwB,MAAM;AACtE,OAAK,MAAM,OAAO,KAChB,WAAU,IAAI;AAGhB,UAAQ,IAAI,oDAAoD,KAAK,KAAK,KAAK,GAAG;QAC7E;AACL,gBAAc,0BAA0B,MAAM;AAE9C,UAAQ,IAAI,oFAAoF;EAChG,MAAM,OAAO,MAAM,KAAK,KAAK,QAAQ,GAAG,4BAA4B,MAAM;AAC1E,OAAK,MAAM,OAAO,KAChB,WAAU,IAAI;AAGhB,UAAQ,IAAI,gCAAgC,KAAK,KAAK,KAAK,GAAG;;;AAOlE,eAAsB,gBAA+B;AACnD,UAAS"}

package/dist/live/server-actions/index.next-js.d.ts

@@ -1,10 +1,14 @@
+import { i as SanityLiveActionContext } from "../../types.js";
+import { LiveEvent } from "@sanity/client";
 /**
-* Used by `<SanityLive onLiveEvent={actionLiveEvent} />`
+* Used by `<SanityLive action={actionRevalidateTags} />`
 */
-declare function actionLiveEvent(_tags: unknown): Promise<void>;
+declare function actionUpdateTags(event: Extract<LiveEvent, {
+  type: "message";
+}>, context: SanityLiveActionContext): Promise<void>;
 /**
-* Used by `<SanityLive onLiveEventIncludingDrafts={actionLiveEventIncludingDrafts} />`
+* Used by `<SanityLive reconnectAction={actionRefresh} restartAction={actionRefresh} />`
 */
-declare function actionLiveEventIncludingDrafts(tags: unknown): Promise<void>;
-export { actionLiveEvent, actionLiveEventIncludingDrafts };
+declare function actionRefresh(): Promise<void>;
+export { actionRefresh, actionUpdateTags };
 //# sourceMappingURL=index.next-js.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.next-js.d.ts","names":[],"sources":["../../../src/live/server-actions/index.next-js.ts"],"sourcesContent":[],"mappings":"AASA;AAyBA;;iBAzBsB,eAAA,kBAAiC;;;;iBAyBjC,8BAAA,iBAA+C"}
+{"version":3,"file":"index.next-js.d.ts","names":[],"sources":["../../../src/live/server-actions/index.next-js.ts"],"sourcesContent":[],"mappings":";;;AAYA;;AACS,iBADa,gBAAA,CACb,KAAA,EAAA,OAAA,CAAQ,SAAR,EAAA;EACE,IAAA,EAAA,SAAA;CACR,CAAA,EAAA,OAAA,EADQ,uBACR,CAAA,EAAA,OAAA,CAAA,IAAA,CAAA;;AAiCH;;iBAAsB,aAAA,CAAA,GAAiB"}

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

@@ -2,37 +2,26 @@
 import { n as PUBLISHED_SYNC_TAG_PREFIX, t as DRAFT_SYNC_TAG_PREFIX } from "../../constants.js";
 import { draftMode } from "next/headers";
 import { refresh, updateTag } from "next/cache";
-async function actionLiveEvent(_tags) {
-	if (!Array.isArray(_tags)) {
-		console.warn("<SanityLive /> `expireTags` called with non-array tags", _tags);
+async function actionUpdateTags(event, context) {
+	if (!Array.isArray(event.tags)) {
+		console.warn(`<SanityLive ${context.includeAllDocuments ? "includeAllDocuments " : ""}/> action called with non-array tags`, event);
 		return;
 	}
-	const tags = _tags.filter((tag) => typeof tag === "string" && tag.startsWith(PUBLISHED_SYNC_TAG_PREFIX));
-	if (!tags.length) {
-		console.warn("<SanityLive /> `expireTags` called with no valid tags", _tags);
+	if ((await draftMode()).isEnabled) {
+		console.warn(`<SanityLive ${context.includeAllDocuments ? "includeAllDocuments " : ""}/> action called in draft mode, cache is bypassed in draft mode so the refresh() function is called instead of updateTag()`, {
+			event,
+			context
+		});
+		refresh();
 		return;
 	}
+	const tags = event.tags.map((tag) => `${context.includeAllDocuments ? PUBLISHED_SYNC_TAG_PREFIX : DRAFT_SYNC_TAG_PREFIX}${tag}`);
 	for (const tag of tags) updateTag(tag);
-	console.log(`<SanityLive /> updated tags: ${tags.join(", ")}`);
+	console.log(`<SanityLive ${context.includeAllDocuments ? "includeAllDocuments " : ""}/> updated tags: ${tags.join(", ")}`);
 }
-async function actionLiveEventIncludingDrafts(tags) {
-	const { isEnabled } = await draftMode();
-	if (isEnabled) refresh();
-	else return expireDraftTags(tags);
+async function actionRefresh() {
+	refresh();
 }
-async function expireDraftTags(_tags) {
-	if (!Array.isArray(_tags)) {
-		console.warn("<SanityLive /> `expireTags` called with non-array tags", _tags);
-		return;
-	}
-	const tags = _tags.filter((tag) => typeof tag === "string" && tag.startsWith(DRAFT_SYNC_TAG_PREFIX));
-	if (!tags.length) {
-		console.warn("<SanityLive /> `expireTags` called with no valid tags", _tags);
-		return;
-	}
-	for (const tag of tags) updateTag(tag);
-	console.log(`<SanityLive /> updated tags: ${tags.join(", ")}`);
-}
-export { actionLiveEvent, actionLiveEventIncludingDrafts };
+export { actionRefresh, actionUpdateTags };
 
 //# sourceMappingURL=index.next-js.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.next-js.js","names":[],"sources":["../../../src/live/server-actions/index.next-js.ts"],"sourcesContent":["'use server'\n\nimport {DRAFT_SYNC_TAG_PREFIX, PUBLISHED_SYNC_TAG_PREFIX} from '#live/constants'\nimport {refresh, updateTag} from 'next/cache'\nimport {draftMode} from 'next/headers'\n\n/**\n * Used by `<SanityLive onLiveEvent={actionLiveEvent} />`\n */\nexport async function actionLiveEvent(_tags: unknown): Promise<void> {\n  // @TODO Draft Mode bypasses cache anyway so we don't bother with expiring tags for draft content\n  // const isDraftMode = (await draftMode()).isEnabled\n  // const tags = _tags.map((tag) => `${isDraftMode ? 'drafts' : 'sanity'}:${tag}`)\n  if (!Array.isArray(_tags)) {\n    console.warn('<SanityLive /> `expireTags` called with non-array tags', _tags)\n    return undefined\n  }\n  const tags = _tags.filter(\n    (tag) => typeof tag === 'string' && tag.startsWith(PUBLISHED_SYNC_TAG_PREFIX),\n  )\n  if (!tags.length) {\n    console.warn('<SanityLive /> `expireTags` called with no valid tags', _tags)\n    return undefined\n  }\n  for (const tag of tags) {\n    updateTag(tag)\n  }\n  // oxlint-disable-next-line no-console\n  console.log(`<SanityLive /> updated tags: ${tags.join(', ')}`)\n}\n\n/**\n * Used by `<SanityLive onLiveEventIncludingDrafts={actionLiveEventIncludingDrafts} />`\n */\nexport async function actionLiveEventIncludingDrafts(tags: unknown): Promise<void> {\n  const {isEnabled} = await draftMode()\n  if (isEnabled) {\n    // With cache components just refresh by default when in draft mode and assume bypass\n    refresh()\n  } else {\n    return expireDraftTags(tags)\n  }\n}\n\nasync function expireDraftTags(_tags: unknown): Promise<void> {\n  if (!Array.isArray(_tags)) {\n    console.warn('<SanityLive /> `expireTags` called with non-array tags', _tags)\n    return undefined\n  }\n  const tags = _tags.filter(\n    (tag) => typeof tag === 'string' && tag.startsWith(DRAFT_SYNC_TAG_PREFIX),\n  )\n  if (!tags.length) {\n    console.warn('<SanityLive /> `expireTags` called with no valid tags', _tags)\n    return undefined\n  }\n  for (const tag of tags) {\n    updateTag(tag)\n  }\n  // oxlint-disable-next-line no-console\n  console.log(`<SanityLive /> updated tags: ${tags.join(', ')}`)\n}\n"],"mappings":";;;;AASA,eAAsB,gBAAgB,OAA+B;AAInE,KAAI,CAAC,MAAM,QAAQ,MAAM,EAAE;AACzB,UAAQ,KAAK,0DAA0D,MAAM;AAC7E;;CAEF,MAAM,OAAO,MAAM,QAChB,QAAQ,OAAO,QAAQ,YAAY,IAAI,WAAW,0BAA0B,CAC9E;AACD,KAAI,CAAC,KAAK,QAAQ;AAChB,UAAQ,KAAK,yDAAyD,MAAM;AAC5E;;AAEF,MAAK,MAAM,OAAO,KAChB,WAAU,IAAI;AAGhB,SAAQ,IAAI,gCAAgC,KAAK,KAAK,KAAK,GAAG;;AAMhE,eAAsB,+BAA+B,MAA8B;CACjF,MAAM,EAAC,cAAa,MAAM,WAAW;AACrC,KAAI,UAEF,UAAS;KAET,QAAO,gBAAgB,KAAK;;AAIhC,eAAe,gBAAgB,OAA+B;AAC5D,KAAI,CAAC,MAAM,QAAQ,MAAM,EAAE;AACzB,UAAQ,KAAK,0DAA0D,MAAM;AAC7E;;CAEF,MAAM,OAAO,MAAM,QAChB,QAAQ,OAAO,QAAQ,YAAY,IAAI,WAAW,sBAAsB,CAC1E;AACD,KAAI,CAAC,KAAK,QAAQ;AAChB,UAAQ,KAAK,yDAAyD,MAAM;AAC5E;;AAEF,MAAK,MAAM,OAAO,KAChB,WAAU,IAAI;AAGhB,SAAQ,IAAI,gCAAgC,KAAK,KAAK,KAAK,GAAG"}
+{"version":3,"file":"index.next-js.js","names":[],"sources":["../../../src/live/server-actions/index.next-js.ts"],"sourcesContent":["'use server'\n\nimport type {SanityLiveActionContext} from '#live/types'\nimport type {LiveEvent} from '@sanity/client'\n\nimport {DRAFT_SYNC_TAG_PREFIX, PUBLISHED_SYNC_TAG_PREFIX} from '#live/constants'\nimport {refresh, updateTag} from 'next/cache'\nimport {draftMode} from 'next/headers'\n\n/**\n * Used by `<SanityLive action={actionRevalidateTags} />`\n */\nexport async function actionUpdateTags(\n  event: Extract<LiveEvent, {type: 'message'}>,\n  context: SanityLiveActionContext,\n): Promise<void> {\n  if (!Array.isArray(event.tags)) {\n    console.warn(\n      `<SanityLive ${context.includeAllDocuments ? 'includeAllDocuments ' : ''}/> action called with non-array tags`,\n      event,\n    )\n    return undefined\n  }\n  if ((await draftMode()).isEnabled) {\n    console.warn(\n      `<SanityLive ${context.includeAllDocuments ? 'includeAllDocuments ' : ''}/> action called in draft mode, cache is bypassed in draft mode so the refresh() function is called instead of updateTag()`,\n      {event, context},\n    )\n    refresh()\n    return undefined\n  }\n\n  const tags = event.tags.map(\n    (tag) =>\n      `${context.includeAllDocuments ? PUBLISHED_SYNC_TAG_PREFIX : DRAFT_SYNC_TAG_PREFIX}${tag}`,\n  )\n  for (const tag of tags) {\n    updateTag(tag)\n  }\n  // oxlint-disable-next-line no-console\n  console.log(\n    `<SanityLive ${context.includeAllDocuments ? 'includeAllDocuments ' : ''}/> updated tags: ${tags.join(', ')}`,\n  )\n}\n\n/**\n * Used by `<SanityLive reconnectAction={actionRefresh} restartAction={actionRefresh} />`\n */\nexport async function actionRefresh(): Promise<void> {\n  refresh()\n}\n"],"mappings":";;;;AAYA,eAAsB,iBACpB,OACA,SACe;AACf,KAAI,CAAC,MAAM,QAAQ,MAAM,KAAK,EAAE;AAC9B,UAAQ,KACN,eAAe,QAAQ,sBAAsB,yBAAyB,GAAG,uCACzE,MACD;AACD;;AAEF,MAAK,MAAM,WAAW,EAAE,WAAW;AACjC,UAAQ,KACN,eAAe,QAAQ,sBAAsB,yBAAyB,GAAG,6HACzE;GAAC;GAAO;GAAQ,CACjB;AACD,WAAS;AACT;;CAGF,MAAM,OAAO,MAAM,KAAK,KACrB,QACC,GAAG,QAAQ,sBAAsB,4BAA4B,wBAAwB,MACxF;AACD,MAAK,MAAM,OAAO,KAChB,WAAU,IAAI;AAGhB,SAAQ,IACN,eAAe,QAAQ,sBAAsB,yBAAyB,GAAG,mBAAmB,KAAK,KAAK,KAAK,GAC5G;;AAMH,eAAsB,gBAA+B;AACnD,UAAS"}

package/dist/types.d.ts

@@ -0,0 +1,75 @@
+import { ClientPerspective, LiveEvent, SanityClient } from "next-sanity";
+/**
+* Perspectives supported by Sanity Live.
+* Using the legacy `'raw'` perspective is not supported and leads to undefined behavior.
+*/
+type PerspectiveType = Exclude<ClientPerspective, "raw">;
+/**
+* TODO: docs
+*/
+interface SanityLiveActionContext {
+  includeAllDocuments: boolean;
+}
+interface DefinedLiveProps {
+  /**
+  * TODO: docs, settings this to `true` enables live events for draft content and requires `browserToken` to be set.
+  */
+  includeAllDocuments?: boolean;
+  /**
+  * TODO: docs
+  */
+  action?: (event: Extract<LiveEvent, {
+    type: "message";
+  }>, context: SanityLiveActionContext) => Promise<void>;
+  welcomeAction?: ((event: Extract<LiveEvent, {
+    type: "welcome";
+  }>, context: SanityLiveActionContext) => Promise<void>) | false;
+  goAwayAction?: ((event: Extract<LiveEvent, {
+    type: "goaway";
+  }>, context: SanityLiveActionContext) => Promise<number | false>) | false;
+  reconnectAction?: ((event: Extract<LiveEvent, {
+    type: "reconnect";
+  }>, context: SanityLiveActionContext) => Promise<void>) | false;
+  restartAction?: ((event: Extract<LiveEvent, {
+    type: "restart";
+  }>, context: SanityLiveActionContext) => Promise<void>) | false;
+  /**
+  * Automatic refresh of RSC when the component <SanityLive /> is mounted.
+  * @defaultValue `false`
+  */
+  refreshOnMount?: boolean;
+  /**
+  * Automatically refresh when window gets focused
+  * @defaultValue `false`
+  */
+  refreshOnFocus?: boolean;
+  /**
+  * Automatically refresh when the browser regains a network connection (via navigator.onLine)
+  * @defaultValue `false`
+  */
+  refreshOnReconnect?: boolean;
+  /**
+  * This request tag is used to identify the request when viewing request logs from your Sanity Content Lake.
+  * @see https://www.sanity.io/docs/reference-api-request-tags
+  * @defaultValue 'next-loader.live'
+  */
+  requestTag?: string;
+}
+interface LiveOptions {
+  /**
+  * Required for `fetch()` and `<Live>` to work
+  */
+  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`..
+  */
+  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.
+  */
+  browserToken?: string | false;
+}
+export { SanityLiveActionContext as i, LiveOptions as n, PerspectiveType as r, DefinedLiveProps as t };
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","names":[],"sources":["../src/live/shared/types.ts"],"sourcesContent":[],"mappings":";;AAcA;AAqCA;AASA;AASmB,KAvDP,eAAA,GAAkB,OAuDX,CAvDmB,iBAuDnB,EAAA,KAAA,CAAA;;;;UAlBF,uBAAA;;;UASA,gBAAA;;;;;;;;mBASN,QAAQ;;eACN,4BACN;2BAGQ,QAAQ;;eACN,4BACN;0BAII,QAAQ;;eACN,4BACN;6BAII,QAAQ;;eACN,4BACN;2BAII,QAAQ;;eACN,4BACN;;;;;;;;;;;;;;;;;;;;;;;UA2BM,WAAA;;;;UAIP"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-sanity",
-  "version": "13.0.0-cache-components.19",
+  "version": "13.0.0-cache-components.20",
   "description": "Sanity.io toolkit for Next.js",
   "keywords": [
     "live",
@@ -68,7 +68,7 @@
     "@sanity/preview-url-secret": "^4.0.2",
     "@sanity/visual-editing": "^5.1.0",
     "dequal": "^2.0.3",
-    "groq": "^5.3.0",
+    "groq": "^5.5.0",
     "history": "^5.3.0"
   },
   "devDependencies": {
@@ -76,17 +76,17 @@
     "@sanity/tsconfig": "^2.1.0",
     "@sanity/webhook": "4.0.4",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^24.10.8",
+    "@types/node": "^24.10.9",
     "@types/react": "^19.2.8",
     "@types/react-dom": "^19.2.3",
     "@vitejs/plugin-react": "^5.1.2",
     "@vitest/coverage-v8": "^4.0.17",
     "js-yaml": "^4.1.1",
-    "next": "16.1.1-canary.24",
+    "next": "16.1.1-canary.35",
     "publint": "^0.3.16",
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
-    "styled-components": "^6.3.1",
+    "styled-components": "^6.3.8",
     "tsdown": "0.19.0",
     "typescript": "5.9.3",
     "vitest": "^4.0.17",
@@ -97,7 +97,7 @@
     "next": "^16.0.0-0",
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
-    "sanity": "^5.3.0",
+    "sanity": "^5.5.0",
     "styled-components": "^6.1"
   },
   "browserslist": "extends @sanity/browserslist-config",

package/dist/LiveEvents.js

@@ -1,43 +0,0 @@
-import { n as PUBLISHED_SYNC_TAG_PREFIX } from "./constants.js";
-import { useRouter } from "next/navigation";
-import { useEffect, useEffectEvent, useState } from "react";
-function LiveEvents(props) {
-	const { client, onEvent, intervalOnGoAway = 3e4, requestTag, onError, onGoAway } = props;
-	const [longPollingInterval, setLongPollingInterval] = useState(false);
-	const router = useRouter();
-	const handleLiveEvent = useEffectEvent((event) => {
-		if (process.env.NODE_ENV !== "production" && event.type === "welcome") {
-			console.info("<SanityLive> is connected and listening for live events to published content");
-			setLongPollingInterval(false);
-		} else if (event.type === "message") onEvent(event.tags.map((tag) => `${PUBLISHED_SYNC_TAG_PREFIX}${tag}`)).then((result) => {
-			if (result === "refresh") router.refresh();
-		});
-		else if (event.type === "restart" || event.type === "reconnect") router.refresh();
-		else if (event.type === "goaway") {
-			onGoAway(event, intervalOnGoAway);
-			setLongPollingInterval(intervalOnGoAway);
-		}
-	});
-	useEffect(() => {
-		const subscription = client.live.events({ tag: requestTag }).subscribe({
-			next: handleLiveEvent,
-			error: onError
-		});
-		return () => subscription.unsubscribe();
-	}, [
-		client.live,
-		onError,
-		requestTag
-	]);
-	useEffect(() => {
-		if (!longPollingInterval) return;
-		const interval = setInterval(() => router.refresh(), longPollingInterval);
-		return () => clearInterval(interval);
-	}, [longPollingInterval, router]);
-	return null;
-}
-LiveEvents.displayName = "LiveEvents";
-var LiveEvents_default = LiveEvents;
-export { LiveEvents_default as default };
-
-//# sourceMappingURL=LiveEvents.js.map

package/dist/LiveEvents.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LiveEvents.js","names":[],"sources":["../src/live/client-components/LiveEvents.tsx"],"sourcesContent":["import type {LiveEvent, LiveEventGoAway, SanityClient, SyncTag} from '@sanity/client'\n\nimport {PUBLISHED_SYNC_TAG_PREFIX} from '#live/constants'\nimport {useRouter} from 'next/navigation'\nimport {useEffect, useState, useEffectEvent} from 'react'\n\ninterface LiveEventsProps {\n  client: SanityClient\n  onEvent: (tags: string[]) => Promise<void | 'refresh'>\n  requestTag: string\n  onError: (error: unknown) => void\n  intervalOnGoAway: number | false\n  onGoAway: (event: LiveEventGoAway, intervalOnGoAway: number | false) => void\n}\n\nfunction LiveEvents(props: LiveEventsProps): null {\n  const {client, onEvent, intervalOnGoAway = 30_000, requestTag, onError, onGoAway} = props\n\n  const [longPollingInterval, setLongPollingInterval] = useState<number | false>(false)\n\n  const router = useRouter()\n  const handleLiveEvent = useEffectEvent((event: LiveEvent) => {\n    if (process.env.NODE_ENV !== 'production' && event.type === 'welcome') {\n      // oxlint-disable-next-line no-console\n      console.info('<SanityLive> is connected and listening for live events to published content')\n      // Disable long polling when welcome event is received, this is a no-op if long polling is already disabled\n      setLongPollingInterval(false)\n    } else if (event.type === 'message') {\n      void onEvent(\n        event.tags.map((tag: SyncTag) => `${PUBLISHED_SYNC_TAG_PREFIX}${tag}` as const),\n      ).then((result) => {\n        if (result === 'refresh') router.refresh()\n      })\n    } else if (event.type === 'restart' || event.type === 'reconnect') {\n      router.refresh()\n    } else if (event.type === 'goaway') {\n      onGoAway(event, intervalOnGoAway)\n      setLongPollingInterval(intervalOnGoAway)\n    }\n  })\n  useEffect(() => {\n    const subscription = client.live.events({tag: requestTag}).subscribe({\n      next: handleLiveEvent,\n      error: onError,\n    })\n    return () => subscription.unsubscribe()\n  }, [client.live, onError, requestTag])\n\n  /**\n   * Handle switching to long polling when needed\n   */\n  useEffect(() => {\n    if (!longPollingInterval) return\n    const interval = setInterval(() => router.refresh(), longPollingInterval)\n    return () => clearInterval(interval)\n  }, [longPollingInterval, router])\n\n  return null\n}\n\nLiveEvents.displayName = 'LiveEvents'\n\nexport default LiveEvents\n"],"mappings":";;;AAeA,SAAS,WAAW,OAA8B;CAChD,MAAM,EAAC,QAAQ,SAAS,mBAAmB,KAAQ,YAAY,SAAS,aAAY;CAEpF,MAAM,CAAC,qBAAqB,0BAA0B,SAAyB,MAAM;CAErF,MAAM,SAAS,WAAW;CAC1B,MAAM,kBAAkB,gBAAgB,UAAqB;AAC3D,MAAI,QAAQ,IAAI,aAAa,gBAAgB,MAAM,SAAS,WAAW;AAErE,WAAQ,KAAK,+EAA+E;AAE5F,0BAAuB,MAAM;aACpB,MAAM,SAAS,UACnB,SACH,MAAM,KAAK,KAAK,QAAiB,GAAG,4BAA4B,MAAe,CAChF,CAAC,MAAM,WAAW;AACjB,OAAI,WAAW,UAAW,QAAO,SAAS;IAC1C;WACO,MAAM,SAAS,aAAa,MAAM,SAAS,YACpD,QAAO,SAAS;WACP,MAAM,SAAS,UAAU;AAClC,YAAS,OAAO,iBAAiB;AACjC,0BAAuB,iBAAiB;;GAE1C;AACF,iBAAgB;EACd,MAAM,eAAe,OAAO,KAAK,OAAO,EAAC,KAAK,YAAW,CAAC,CAAC,UAAU;GACnE,MAAM;GACN,OAAO;GACR,CAAC;AACF,eAAa,aAAa,aAAa;IACtC;EAAC,OAAO;EAAM;EAAS;EAAW,CAAC;AAKtC,iBAAgB;AACd,MAAI,CAAC,oBAAqB;EAC1B,MAAM,WAAW,kBAAkB,OAAO,SAAS,EAAE,oBAAoB;AACzE,eAAa,cAAc,SAAS;IACnC,CAAC,qBAAqB,OAAO,CAAC;AAEjC,QAAO;;AAGT,WAAW,cAAc;AAEzB,IAAA,qBAAe"}

package/dist/LiveEventsIncludingDrafts.js

@@ -1,46 +0,0 @@
-import { t as DRAFT_SYNC_TAG_PREFIX } from "./constants.js";
-import { useRouter } from "next/navigation";
-import { useEffect, useEffectEvent, useState } from "react";
-function LiveEventsIncludingDrafts(props) {
-	const { client, intervalOnGoAway, onError, onEvent, onGoAway, requestTag } = props;
-	const [longPollingInterval, setLongPollingInterval] = useState(false);
-	const router = useRouter();
-	const handleLiveEvent = useEffectEvent((event) => {
-		if (process.env.NODE_ENV !== "production" && event.type === "welcome") {
-			console.info("<SanityLive> is connected and listening for live events to all content including drafts and version documents in content releases");
-			setLongPollingInterval(false);
-		} else if (event.type === "message") onEvent(event.tags.map((tag) => `${DRAFT_SYNC_TAG_PREFIX}${tag}`)).then((result) => {
-			if (result === "refresh") router.refresh();
-		});
-		else if (event.type === "restart" || event.type === "reconnect") router.refresh();
-		else if (event.type === "goaway") {
-			onGoAway(event, intervalOnGoAway);
-			setLongPollingInterval(intervalOnGoAway);
-		}
-	});
-	useEffect(() => {
-		const subscription = client.live.events({
-			includeDrafts: true,
-			tag: requestTag
-		}).subscribe({
-			next: handleLiveEvent,
-			error: onError
-		});
-		return () => subscription.unsubscribe();
-	}, [
-		client.live,
-		onError,
-		requestTag
-	]);
-	useEffect(() => {
-		if (!longPollingInterval) return;
-		const interval = setInterval(() => router.refresh(), longPollingInterval);
-		return () => clearInterval(interval);
-	}, [longPollingInterval, router]);
-	return null;
-}
-LiveEventsIncludingDrafts.displayName = "LiveEventsIncludingDrafts";
-var LiveEventsIncludingDrafts_default = LiveEventsIncludingDrafts;
-export { LiveEventsIncludingDrafts_default as default };
-
-//# sourceMappingURL=LiveEventsIncludingDrafts.js.map

package/dist/LiveEventsIncludingDrafts.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LiveEventsIncludingDrafts.js","names":[],"sources":["../src/live/client-components/LiveEventsIncludingDrafts.tsx"],"sourcesContent":["import type {LiveEvent, LiveEventGoAway, SanityClient, SyncTag} from '@sanity/client'\n\nimport {DRAFT_SYNC_TAG_PREFIX} from '#live/constants'\nimport {useRouter} from 'next/navigation'\nimport {useEffect, useState, useEffectEvent} from 'react'\n\ninterface LiveEventsIncludingDraftsProps {\n  client: SanityClient\n  onEvent: (tags: string[]) => Promise<void | 'refresh'>\n  requestTag: string\n  onError: (error: unknown) => void\n  intervalOnGoAway: number | false\n  onGoAway: (event: LiveEventGoAway, intervalOnGoAway: number | false) => void\n}\n\nfunction LiveEventsIncludingDrafts(props: LiveEventsIncludingDraftsProps): null {\n  const {client, intervalOnGoAway, onError, onEvent, onGoAway, requestTag} = props\n\n  const [longPollingInterval, setLongPollingInterval] = useState<number | false>(false)\n\n  const router = useRouter()\n  const handleLiveEvent = useEffectEvent((event: LiveEvent) => {\n    if (process.env.NODE_ENV !== 'production' && event.type === 'welcome') {\n      // oxlint-disable-next-line no-console\n      console.info(\n        '<SanityLive> is connected and listening for live events to all content including drafts and version documents in content releases',\n      )\n      // Disable long polling when welcome event is received, this is a no-op if long polling is already disabled\n      setLongPollingInterval(false)\n    } else if (event.type === 'message') {\n      void onEvent(\n        event.tags.map((tag: SyncTag) => `${DRAFT_SYNC_TAG_PREFIX}${tag}` as const),\n      ).then((result) => {\n        if (result === 'refresh') router.refresh()\n      })\n    } else if (event.type === 'restart' || event.type === 'reconnect') {\n      router.refresh()\n    } else if (event.type === 'goaway') {\n      onGoAway(event, intervalOnGoAway)\n      setLongPollingInterval(intervalOnGoAway)\n    }\n  })\n  useEffect(() => {\n    const subscription = client.live.events({includeDrafts: true, tag: requestTag}).subscribe({\n      next: handleLiveEvent,\n      error: onError,\n    })\n    return () => subscription.unsubscribe()\n  }, [client.live, onError, requestTag])\n\n  useEffect(() => {\n    if (!longPollingInterval) return\n    const interval = setInterval(() => router.refresh(), longPollingInterval)\n    return () => clearInterval(interval)\n  }, [longPollingInterval, router])\n\n  return null\n}\n\nLiveEventsIncludingDrafts.displayName = 'LiveEventsIncludingDrafts'\n\nexport default LiveEventsIncludingDrafts\n"],"mappings":";;;AAeA,SAAS,0BAA0B,OAA6C;CAC9E,MAAM,EAAC,QAAQ,kBAAkB,SAAS,SAAS,UAAU,eAAc;CAE3E,MAAM,CAAC,qBAAqB,0BAA0B,SAAyB,MAAM;CAErF,MAAM,SAAS,WAAW;CAC1B,MAAM,kBAAkB,gBAAgB,UAAqB;AAC3D,MAAI,QAAQ,IAAI,aAAa,gBAAgB,MAAM,SAAS,WAAW;AAErE,WAAQ,KACN,oIACD;AAED,0BAAuB,MAAM;aACpB,MAAM,SAAS,UACnB,SACH,MAAM,KAAK,KAAK,QAAiB,GAAG,wBAAwB,MAAe,CAC5E,CAAC,MAAM,WAAW;AACjB,OAAI,WAAW,UAAW,QAAO,SAAS;IAC1C;WACO,MAAM,SAAS,aAAa,MAAM,SAAS,YACpD,QAAO,SAAS;WACP,MAAM,SAAS,UAAU;AAClC,YAAS,OAAO,iBAAiB;AACjC,0BAAuB,iBAAiB;;GAE1C;AACF,iBAAgB;EACd,MAAM,eAAe,OAAO,KAAK,OAAO;GAAC,eAAe;GAAM,KAAK;GAAW,CAAC,CAAC,UAAU;GACxF,MAAM;GACN,OAAO;GACR,CAAC;AACF,eAAa,aAAa,aAAa;IACtC;EAAC,OAAO;EAAM;EAAS;EAAW,CAAC;AAEtC,iBAAgB;AACd,MAAI,CAAC,oBAAqB;EAC1B,MAAM,WAAW,kBAAkB,OAAO,SAAS,EAAE,oBAAoB;AACzE,eAAa,cAAc,SAAS;IACnC,CAAC,qBAAqB,OAAO,CAAC;AAEjC,QAAO;;AAGT,0BAA0B,cAAc;AAExC,IAAA,oCAAe"}