next-sanity 12.1.4 → 12.1.5

package/README.md

@@ -115,4 +115,4 @@ MIT-licensed. See [LICENSE][LICENSE].
 [sanity-reference-docs]: https://reference.sanity.io/next-sanity/
 [sanity-next-caching]: https://www.sanity.io/docs/nextjs/caching-and-revalidation-in-nextjs
 [next-queries]: https://www.sanity.io/docs/nextjs/query-content-nextjs
-[next-sanity-intro]: https://www.sanity.io/docs/nextjs/introduction
+[next-sanity-intro]: https://www.sanity.io/docs/nextjs/introduction

package/dist/live.js

@@ -21,7 +21,7 @@ function defineLive(config) {
 	});
 	const { token: originalToken } = client.config();
 	const studioUrlDefined = typeof client.config().stega.studioUrl !== "undefined";
-	const sanityFetch = async function sanityFetch({ query, params = {}, stega: _stega, tags = ["sanity"], perspective: _perspective, tag, requestTag = tag ?? "next-loader.fetch" }) {
+	const sanityFetch = async function sanityFetch({ query, params = {}, stega: _stega, tags = [], perspective: _perspective, tag, requestTag = tag ?? "next-loader.fetch" }) {
 		const stega = _stega ?? (stegaEnabled && studioUrlDefined && (await draftMode()).isEnabled);
 		const perspective = _perspective ?? await resolveCookiePerspective();
 		const useCdn = perspective === "published";

package/dist/live.js.map

@@ -1 +1 @@
-{"version":3,"file":"live.js","names":[],"sources":["../src/live/resolveCookiePerspective.ts","../src/live/defineLive.tsx"],"sourcesContent":["import type {ClientPerspective} from '@sanity/client'\nimport {perspectiveCookieName} from '@sanity/preview-url-secret/constants'\nimport {cookies, draftMode} from 'next/headers'\n\nimport {sanitizePerspective} from './utils'\n\n/**\n * @internal\n */\nexport async 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","import {\n  type ClientPerspective,\n  type ClientReturn,\n  type ContentSourceMap,\n  type LiveEventGoAway,\n  type QueryParams,\n  type SanityClient,\n  type SyncTag,\n} from '@sanity/client'\nimport SanityLiveClientComponent from 'next-sanity/live/client-components/live'\nimport SanityLiveStreamClientComponent from 'next-sanity/live/client-components/live-stream'\nimport {draftMode} from 'next/headers'\nimport {prefetchDNS, preconnect} from 'react-dom'\n\nimport {resolveCookiePerspective} from './resolveCookiePerspective'\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   * @deprecated use `requestTag` instead\n   */\n  tag?: never\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 type DefinedSanityLiveStreamType = <const QueryString extends string>(props: {\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   * @deprecated use `requestTag` instead\n   */\n  tag?: never\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.live-stream.fetch'\n   */\n  requestTag?: string\n  children: (result: {\n    data: ClientReturn<QueryString>\n    sourceMap: ContentSourceMap | null\n    tags: string[]\n  }) => Promise<Awaited<React.ReactNode>>\n  // @TODO follow up on this after React 19: https://github.com/vercel/next.js/discussions/67365#discussioncomment-9935377\n  // }) => Promise<Awaited<React.ReactNode>>\n}) => React.ReactNode\n\n/**\n * @public\n */\nexport interface DefinedSanityLiveProps {\n  /**\n   * Automatic refresh of RSC when the component <SanityLive /> is mounted.\n   * Note that this is different from revalidation, which is based on tags and causes `sanityFetch` calls to be re-fetched.\n   * @defaultValue `true`\n   */\n  refreshOnMount?: boolean\n  /**\n   * Automatically refresh when window gets focused\n   * Note that this is different from revalidation, which is based on tags and causes `sanityFetch` calls to be re-fetched.\n   * @defaultValue `false` if draftMode().isEnabled, otherwise `true` if not inside an iframe\n   */\n  refreshOnFocus?: boolean\n  /**\n   * Automatically refresh when the browser regains a network connection (via navigator.onLine)\n   * Note that this is different from revalidation, which is based on tags and causes `sanityFetch` calls to be re-fetched.\n   * @defaultValue `true`\n   */\n  refreshOnReconnect?: boolean\n  /**\n   * Automatically refresh on an interval when the Live Event API emits a `goaway` event, which indicates that the connection is rejected or closed.\n   * This typically happens if the connection limit is reached, or if the connection is idle for too long.\n   * To disable this long polling fallback behavior set `intervalOnGoAway` to `false` or `0`.\n   * You can also use `onGoAway` to handle the `goaway` event in your own way, and read the reason why the event was emitted.\n   * @defaultValue `30_000` 30 seconds interval\n   */\n  intervalOnGoAway?: number | false\n\n  /**\n   * @deprecated use `requestTag` instead\n   */\n  tag?: never\n\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.live'\n   */\n  requestTag?: string\n\n  /**\n   * Handle errors from the Live Events subscription.\n   * By default it's reported using `console.error`, you can override this prop to handle it in your own way.\n   */\n  onError?: (error: unknown) => void\n\n  /**\n   * Handle the `goaway` event if the connection is rejected/closed.\n   * `event.reason` will be a string of why the event was emitted, for example `'connection limit reached'`.\n   * When this happens the `<SanityLive />` will fallback to long polling with a default interval of 30 seconds, providing your own `onGoAway` handler does not change this behavior.\n   * If you want to disable long polling set `intervalOnGoAway` to `false` or `0`.\n   */\n  onGoAway?: (event: LiveEventGoAway, intervalOnGoAway: number | false) => void\n\n  /**\n   * Override how cache tags are invalidated, you need to pass a server action here.\n   * You can also pass a `use client` function here, and have `router.refresh()` be called if the promise resolves to `'refresh'`.\n   */\n  revalidateSyncTags?: (tags: SyncTag[]) => Promise<void | 'refresh'>\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\n// export type VerifyPreviewSecretType = (\n//   secret: string,\n// ) => Promise<{isValid: boolean; studioUrl: string | null}>\n\n/**\n * @public\n */\nexport function defineLive(config: DefineSanityLiveOptions): {\n  /**\n   * Use this function to fetch data from Sanity in your React Server Components.\n   * @public\n   */\n  sanityFetch: DefinedSanityFetchType\n  /**\n   * Render this in your root layout.tsx to make your page revalidate on new content live, automatically.\n   * @public\n   */\n  SanityLive: React.ComponentType<DefinedSanityLiveProps>\n  /**\n   * @alpha experimental, it may change or even be removed at any time\n   */\n  SanityLiveStream: DefinedSanityLiveStreamType\n  // verifyPreviewSecret: VerifyPreviewSecretType\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      // handleDraftModeAction = handleDraftModeActionMissing\n      refreshOnMount,\n      refreshOnFocus,\n      refreshOnReconnect,\n      tag,\n      requestTag = tag,\n      onError,\n      onGoAway,\n      intervalOnGoAway,\n      revalidateSyncTags,\n    } = props\n    const {projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix} =\n      client.config()\n    const {isEnabled: isDraftModeEnabled} = await draftMode()\n\n    // Preconnect to the Live Event API origin, or at least prefetch the DNS if preconenct is not supported\n    const {origin} = new URL(client.getUrl('', false))\n    preconnect(origin)\n    prefetchDNS(origin)\n\n    return (\n      <SanityLiveClientComponent\n        projectId={projectId}\n        dataset={dataset}\n        apiHost={apiHost}\n        apiVersion={apiVersion}\n        useProjectHostname={useProjectHostname}\n        requestTagPrefix={requestTagPrefix}\n        requestTag={requestTag}\n        token={typeof browserToken === 'string' && isDraftModeEnabled ? browserToken : undefined}\n        draftModeEnabled={isDraftModeEnabled}\n        // handleDraftModeAction={handleDraftModeAction}\n        draftModePerspective={await resolveCookiePerspective()}\n        refreshOnMount={refreshOnMount}\n        refreshOnFocus={refreshOnFocus}\n        refreshOnReconnect={refreshOnReconnect}\n        onError={onError}\n        onGoAway={onGoAway}\n        intervalOnGoAway={intervalOnGoAway}\n        revalidateSyncTags={revalidateSyncTags}\n      />\n    )\n  }\n\n  const SanityLiveStream: DefinedSanityLiveStreamType = async function SanityLiveStream(props) {\n    const {\n      query,\n      params,\n      perspective: _perspective,\n      stega: _stega,\n      tags,\n      children,\n      tag,\n      requestTag = tag ?? 'next-loader.live-stream.fetch',\n    } = props\n    const {\n      data,\n      sourceMap,\n      tags: cacheTags,\n    } = await sanityFetch({\n      query,\n      params,\n      tags,\n      perspective: _perspective,\n      stega: _stega,\n      requestTag,\n    })\n    const {isEnabled: isDraftModeEnabled} = await draftMode()\n\n    if (isDraftModeEnabled) {\n      const stega = _stega ?? (stegaEnabled && studioUrlDefined && (await draftMode()).isEnabled)\n      const perspective = _perspective ?? (await resolveCookiePerspective())\n      const {projectId, dataset} = client.config()\n      return (\n        <SanityLiveStreamClientComponent\n          projectId={projectId}\n          dataset={dataset}\n          query={query}\n          params={await params}\n          perspective={perspective}\n          stega={stega}\n          initial={children({data, sourceMap, tags: cacheTags})}\n          // oxlint-disable-next-line react/no-children-prop\n          children={\n            // oxlint-disable-next-line no-unsafe-type-assertion\n            children as unknown as any\n          }\n        />\n      )\n    }\n\n    return children({data, sourceMap, tags: cacheTags})\n  }\n\n  // const verifyPreviewSecret: VerifyPreviewSecretType = async (secret) => {\n  //   if (!serverToken) {\n  //     throw new Error(\n  //       '`serverToken` is required to verify a preview secrets and initiate draft mode',\n  //     )\n  //   }\n\n  //   if (typeof secret !== 'string') {\n  //     throw new TypeError('`secret` must be a string')\n  //   }\n  //   if (!secret.trim()) {\n  //     throw new Error('`secret` must not be an empty string')\n  //   }\n\n  //   const client = _client.withConfig({\n  //     // Use the token that is setup to query draft documents, it should also have permission to query for secrets\n  //     token: serverToken,\n  //     // Userland might be using an API version that's too old to use perspectives\n  //     apiVersion,\n  //     // We can't use the CDN, the secret is typically validated right after it's created\n  //     useCdn: false,\n  //     // Don't waste time returning a source map, we don't need it\n  //     resultSourceMap: false,\n  //     // Stega is not needed\n  //     stega: false,\n  //   })\n  //   const {isValid, studioUrl} = await validateSecret(client, secret, false)\n  //   return {isValid, studioUrl}\n  // }\n\n  return {\n    sanityFetch,\n    SanityLive,\n    SanityLiveStream,\n    // verifyPreviewSecret\n  }\n}\n"],"mappings":";;;;;;;;;AASA,eAAsB,2BAAuE;AAC3F,SAAQ,MAAM,WAAW,EAAE,aACtB,MAAM,SAAS,EAAE,IAAI,sBAAsB,GAC1C,qBAAqB,MAAM,SAAS,EAAE,IAAI,sBAAsB,EAAE,OAAO,SAAS,GAClF,WACF;;AC6KN,SAAgB,WAAW,QAgBzB;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,eAAe,YAEzD,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,QAAQ,UAAU,MAAM,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;;AAiI5E,QAAO;EACL;EACA,YAhI8D,eAAe,WAAW,OAAO;GAC/F,MAAM,EAEJ,gBACA,gBACA,oBACA,KACA,aAAa,KACb,SACA,UACA,kBACA,uBACE;GACJ,MAAM,EAAC,WAAW,SAAS,SAAS,YAAY,oBAAoB,qBAClE,OAAO,QAAQ;GACjB,MAAM,EAAC,WAAW,uBAAsB,MAAM,WAAW;GAGzD,MAAM,EAAC,WAAU,IAAI,IAAI,OAAO,OAAO,IAAI,MAAM,CAAC;AAClD,cAAW,OAAO;AAClB,eAAY,OAAO;AAEnB,UACE,oBAAC,2BAAA;IACY;IACF;IACA;IACG;IACQ;IACF;IACN;IACZ,OAAO,OAAO,iBAAiB,YAAY,qBAAqB,eAAe,KAAA;IAC/E,kBAAkB;IAElB,sBAAsB,MAAM,0BAA0B;IACtC;IACA;IACI;IACX;IACC;IACQ;IACE;KACpB;;EAuFJ,kBAnFoD,eAAe,iBAAiB,OAAO;GAC3F,MAAM,EACJ,OACA,QACA,aAAa,cACb,OAAO,QACP,MACA,UACA,KACA,aAAa,OAAO,oCAClB;GACJ,MAAM,EACJ,MACA,WACA,MAAM,cACJ,MAAM,YAAY;IACpB;IACA;IACA;IACA,aAAa;IACb,OAAO;IACP;IACD,CAAC;GACF,MAAM,EAAC,WAAW,uBAAsB,MAAM,WAAW;AAEzD,OAAI,oBAAoB;IACtB,MAAM,QAAQ,WAAW,gBAAgB,qBAAqB,MAAM,WAAW,EAAE;IACjF,MAAM,cAAc,gBAAiB,MAAM,0BAA0B;IACrE,MAAM,EAAC,WAAW,YAAW,OAAO,QAAQ;AAC5C,WACE,oBAAC,iCAAA;KACY;KACF;KACF;KACP,QAAQ,MAAM;KACD;KACN;KACP,SAAS,SAAS;MAAC;MAAM;MAAW,MAAM;MAAU,CAAC;KAInD;MAEF;;AAIN,UAAO,SAAS;IAAC;IAAM;IAAW,MAAM;IAAU,CAAC;;EAsCpD"}
+{"version":3,"file":"live.js","names":[],"sources":["../src/live/resolveCookiePerspective.ts","../src/live/defineLive.tsx"],"sourcesContent":["import type {ClientPerspective} from '@sanity/client'\nimport {perspectiveCookieName} from '@sanity/preview-url-secret/constants'\nimport {cookies, draftMode} from 'next/headers'\n\nimport {sanitizePerspective} from './utils'\n\n/**\n * @internal\n */\nexport async 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","import {\n  type ClientPerspective,\n  type ClientReturn,\n  type ContentSourceMap,\n  type LiveEventGoAway,\n  type QueryParams,\n  type SanityClient,\n  type SyncTag,\n} from '@sanity/client'\nimport SanityLiveClientComponent from 'next-sanity/live/client-components/live'\nimport SanityLiveStreamClientComponent from 'next-sanity/live/client-components/live-stream'\nimport {draftMode} from 'next/headers'\nimport {prefetchDNS, preconnect} from 'react-dom'\n\nimport {resolveCookiePerspective} from './resolveCookiePerspective'\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   * @deprecated use `requestTag` instead\n   */\n  tag?: never\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 type DefinedSanityLiveStreamType = <const QueryString extends string>(props: {\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   * @deprecated use `requestTag` instead\n   */\n  tag?: never\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.live-stream.fetch'\n   */\n  requestTag?: string\n  children: (result: {\n    data: ClientReturn<QueryString>\n    sourceMap: ContentSourceMap | null\n    tags: string[]\n  }) => Promise<Awaited<React.ReactNode>>\n  // @TODO follow up on this after React 19: https://github.com/vercel/next.js/discussions/67365#discussioncomment-9935377\n  // }) => Promise<Awaited<React.ReactNode>>\n}) => React.ReactNode\n\n/**\n * @public\n */\nexport interface DefinedSanityLiveProps {\n  /**\n   * Automatic refresh of RSC when the component <SanityLive /> is mounted.\n   * Note that this is different from revalidation, which is based on tags and causes `sanityFetch` calls to be re-fetched.\n   * @defaultValue `true`\n   */\n  refreshOnMount?: boolean\n  /**\n   * Automatically refresh when window gets focused\n   * Note that this is different from revalidation, which is based on tags and causes `sanityFetch` calls to be re-fetched.\n   * @defaultValue `false` if draftMode().isEnabled, otherwise `true` if not inside an iframe\n   */\n  refreshOnFocus?: boolean\n  /**\n   * Automatically refresh when the browser regains a network connection (via navigator.onLine)\n   * Note that this is different from revalidation, which is based on tags and causes `sanityFetch` calls to be re-fetched.\n   * @defaultValue `true`\n   */\n  refreshOnReconnect?: boolean\n  /**\n   * Automatically refresh on an interval when the Live Event API emits a `goaway` event, which indicates that the connection is rejected or closed.\n   * This typically happens if the connection limit is reached, or if the connection is idle for too long.\n   * To disable this long polling fallback behavior set `intervalOnGoAway` to `false` or `0`.\n   * You can also use `onGoAway` to handle the `goaway` event in your own way, and read the reason why the event was emitted.\n   * @defaultValue `30_000` 30 seconds interval\n   */\n  intervalOnGoAway?: number | false\n\n  /**\n   * @deprecated use `requestTag` instead\n   */\n  tag?: never\n\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.live'\n   */\n  requestTag?: string\n\n  /**\n   * Handle errors from the Live Events subscription.\n   * By default it's reported using `console.error`, you can override this prop to handle it in your own way.\n   */\n  onError?: (error: unknown) => void\n\n  /**\n   * Handle the `goaway` event if the connection is rejected/closed.\n   * `event.reason` will be a string of why the event was emitted, for example `'connection limit reached'`.\n   * When this happens the `<SanityLive />` will fallback to long polling with a default interval of 30 seconds, providing your own `onGoAway` handler does not change this behavior.\n   * If you want to disable long polling set `intervalOnGoAway` to `false` or `0`.\n   */\n  onGoAway?: (event: LiveEventGoAway, intervalOnGoAway: number | false) => void\n\n  /**\n   * Override how cache tags are invalidated, you need to pass a server action here.\n   * You can also pass a `use client` function here, and have `router.refresh()` be called if the promise resolves to `'refresh'`.\n   */\n  revalidateSyncTags?: (tags: SyncTag[]) => Promise<void | 'refresh'>\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\n// export type VerifyPreviewSecretType = (\n//   secret: string,\n// ) => Promise<{isValid: boolean; studioUrl: string | null}>\n\n/**\n * @public\n */\nexport function defineLive(config: DefineSanityLiveOptions): {\n  /**\n   * Use this function to fetch data from Sanity in your React Server Components.\n   * @public\n   */\n  sanityFetch: DefinedSanityFetchType\n  /**\n   * Render this in your root layout.tsx to make your page revalidate on new content live, automatically.\n   * @public\n   */\n  SanityLive: React.ComponentType<DefinedSanityLiveProps>\n  /**\n   * @alpha experimental, it may change or even be removed at any time\n   */\n  SanityLiveStream: DefinedSanityLiveStreamType\n  // verifyPreviewSecret: VerifyPreviewSecretType\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 = [],\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      // handleDraftModeAction = handleDraftModeActionMissing\n      refreshOnMount,\n      refreshOnFocus,\n      refreshOnReconnect,\n      tag,\n      requestTag = tag,\n      onError,\n      onGoAway,\n      intervalOnGoAway,\n      revalidateSyncTags,\n    } = props\n    const {projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix} =\n      client.config()\n    const {isEnabled: isDraftModeEnabled} = await draftMode()\n\n    // Preconnect to the Live Event API origin, or at least prefetch the DNS if preconenct is not supported\n    const {origin} = new URL(client.getUrl('', false))\n    preconnect(origin)\n    prefetchDNS(origin)\n\n    return (\n      <SanityLiveClientComponent\n        projectId={projectId}\n        dataset={dataset}\n        apiHost={apiHost}\n        apiVersion={apiVersion}\n        useProjectHostname={useProjectHostname}\n        requestTagPrefix={requestTagPrefix}\n        requestTag={requestTag}\n        token={typeof browserToken === 'string' && isDraftModeEnabled ? browserToken : undefined}\n        draftModeEnabled={isDraftModeEnabled}\n        // handleDraftModeAction={handleDraftModeAction}\n        draftModePerspective={await resolveCookiePerspective()}\n        refreshOnMount={refreshOnMount}\n        refreshOnFocus={refreshOnFocus}\n        refreshOnReconnect={refreshOnReconnect}\n        onError={onError}\n        onGoAway={onGoAway}\n        intervalOnGoAway={intervalOnGoAway}\n        revalidateSyncTags={revalidateSyncTags}\n      />\n    )\n  }\n\n  const SanityLiveStream: DefinedSanityLiveStreamType = async function SanityLiveStream(props) {\n    const {\n      query,\n      params,\n      perspective: _perspective,\n      stega: _stega,\n      tags,\n      children,\n      tag,\n      requestTag = tag ?? 'next-loader.live-stream.fetch',\n    } = props\n    const {\n      data,\n      sourceMap,\n      tags: cacheTags,\n    } = await sanityFetch({\n      query,\n      params,\n      tags,\n      perspective: _perspective,\n      stega: _stega,\n      requestTag,\n    })\n    const {isEnabled: isDraftModeEnabled} = await draftMode()\n\n    if (isDraftModeEnabled) {\n      const stega = _stega ?? (stegaEnabled && studioUrlDefined && (await draftMode()).isEnabled)\n      const perspective = _perspective ?? (await resolveCookiePerspective())\n      const {projectId, dataset} = client.config()\n      return (\n        <SanityLiveStreamClientComponent\n          projectId={projectId}\n          dataset={dataset}\n          query={query}\n          params={await params}\n          perspective={perspective}\n          stega={stega}\n          initial={children({data, sourceMap, tags: cacheTags})}\n          // oxlint-disable-next-line react/no-children-prop\n          children={\n            // oxlint-disable-next-line no-unsafe-type-assertion\n            children as unknown as any\n          }\n        />\n      )\n    }\n\n    return children({data, sourceMap, tags: cacheTags})\n  }\n\n  // const verifyPreviewSecret: VerifyPreviewSecretType = async (secret) => {\n  //   if (!serverToken) {\n  //     throw new Error(\n  //       '`serverToken` is required to verify a preview secrets and initiate draft mode',\n  //     )\n  //   }\n\n  //   if (typeof secret !== 'string') {\n  //     throw new TypeError('`secret` must be a string')\n  //   }\n  //   if (!secret.trim()) {\n  //     throw new Error('`secret` must not be an empty string')\n  //   }\n\n  //   const client = _client.withConfig({\n  //     // Use the token that is setup to query draft documents, it should also have permission to query for secrets\n  //     token: serverToken,\n  //     // Userland might be using an API version that's too old to use perspectives\n  //     apiVersion,\n  //     // We can't use the CDN, the secret is typically validated right after it's created\n  //     useCdn: false,\n  //     // Don't waste time returning a source map, we don't need it\n  //     resultSourceMap: false,\n  //     // Stega is not needed\n  //     stega: false,\n  //   })\n  //   const {isValid, studioUrl} = await validateSecret(client, secret, false)\n  //   return {isValid, studioUrl}\n  // }\n\n  return {\n    sanityFetch,\n    SanityLive,\n    SanityLiveStream,\n    // verifyPreviewSecret\n  }\n}\n"],"mappings":";;;;;;;;;AASA,eAAsB,2BAAuE;AAC3F,SAAQ,MAAM,WAAW,EAAE,aACtB,MAAM,SAAS,EAAE,IAAI,sBAAsB,GAC1C,qBAAqB,MAAM,SAAS,EAAE,IAAI,sBAAsB,EAAE,OAAO,SAAS,GAClF,WACF;;AC6KN,SAAgB,WAAW,QAgBzB;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,eAAe,YAEzD,EACA,OACA,SAAS,EAAE,EACX,OAAO,QACP,OAAO,EAAE,EACT,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,QAAQ,UAAU,MAAM,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;;AAiI5E,QAAO;EACL;EACA,YAhI8D,eAAe,WAAW,OAAO;GAC/F,MAAM,EAEJ,gBACA,gBACA,oBACA,KACA,aAAa,KACb,SACA,UACA,kBACA,uBACE;GACJ,MAAM,EAAC,WAAW,SAAS,SAAS,YAAY,oBAAoB,qBAClE,OAAO,QAAQ;GACjB,MAAM,EAAC,WAAW,uBAAsB,MAAM,WAAW;GAGzD,MAAM,EAAC,WAAU,IAAI,IAAI,OAAO,OAAO,IAAI,MAAM,CAAC;AAClD,cAAW,OAAO;AAClB,eAAY,OAAO;AAEnB,UACE,oBAAC,2BAAA;IACY;IACF;IACA;IACG;IACQ;IACF;IACN;IACZ,OAAO,OAAO,iBAAiB,YAAY,qBAAqB,eAAe,KAAA;IAC/E,kBAAkB;IAElB,sBAAsB,MAAM,0BAA0B;IACtC;IACA;IACI;IACX;IACC;IACQ;IACE;KACpB;;EAuFJ,kBAnFoD,eAAe,iBAAiB,OAAO;GAC3F,MAAM,EACJ,OACA,QACA,aAAa,cACb,OAAO,QACP,MACA,UACA,KACA,aAAa,OAAO,oCAClB;GACJ,MAAM,EACJ,MACA,WACA,MAAM,cACJ,MAAM,YAAY;IACpB;IACA;IACA;IACA,aAAa;IACb,OAAO;IACP;IACD,CAAC;GACF,MAAM,EAAC,WAAW,uBAAsB,MAAM,WAAW;AAEzD,OAAI,oBAAoB;IACtB,MAAM,QAAQ,WAAW,gBAAgB,qBAAqB,MAAM,WAAW,EAAE;IACjF,MAAM,cAAc,gBAAiB,MAAM,0BAA0B;IACrE,MAAM,EAAC,WAAW,YAAW,OAAO,QAAQ;AAC5C,WACE,oBAAC,iCAAA;KACY;KACF;KACF;KACP,QAAQ,MAAM;KACD;KACN;KACP,SAAS,SAAS;MAAC;MAAM;MAAW,MAAM;MAAU,CAAC;KAInD;MAEF;;AAIN,UAAO,SAAS;IAAC;IAAM;IAAW,MAAM;IAAU,CAAC;;EAsCpD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-sanity",
-  "version": "12.1.4",
+  "version": "12.1.5",
   "description": "Sanity.io toolkit for Next.js",
   "keywords": [
     "live",