next-sanity 11.5.6 → 11.5.7-canary.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/experimental/live.d.ts +8 -15
  2. package/dist/experimental/live.js +24 -38
  3. package/dist/experimental/live.js.map +1 -1
  4. package/package.json +4 -4
  5. package/src/experimental/live.tsx +39 -66
package/dist/experimental/live.d.ts CHANGED
@@ -8,7 +8,7 @@ import { ClientPerspective, ClientReturn, ContentSourceMap, LiveEventGoAway, Que
8
8
  /**
9
9
  * @alpha CAUTION: This API does not follow semver and could have breaking changes in future minor releases.
10
10
  */
11
- declare function resolvePerspectiveFromCookie({
11
+ declare function resolvePerspectiveFromCookies({
12
12
  cookies: jar
13
13
  }: {
14
14
  cookies: Awaited<ReturnType<typeof cookies>>;
@@ -19,11 +19,13 @@ declare function resolvePerspectiveFromCookie({
19
19
  type DefinedSanityFetchType = <const QueryString extends string>(options: {
20
20
  query: QueryString;
21
21
  params?: QueryParams | Promise<QueryParams>;
22
+ /**
23
+ * @defaultValue 'published'
24
+ */
22
25
  perspective?: Exclude<ClientPerspective, "raw">;
23
26
  /**
24
- * Enables stega encoding of the data, this is typically only used in draft mode.
25
- * If `defineLive({..., stega: true})` is provided, then it defaults to `true` in Draft Mode.
26
- * If `defineLive({..., stega: false})` then it defaults to `false`.
27
+ * Enables stega encoding of the data, this is typically only used in draft mode in conjunction with `perspective: 'drafts'` and with `@sanity/visual-editing` setup.
28
+ * @defaultValue `false`
27
29
  */
28
30
  stega?: boolean;
29
31
  /**
@@ -33,7 +35,7 @@ type DefinedSanityFetchType = <const QueryString extends string>(options: {
33
35
  */
34
36
  requestTag?: string;
35
37
  /**
36
- * Custom cache tags that can be used with next's `revalidateTag` function for custom webhook on-demand revalidation.
38
+ * Custom cache tags that can be used with next's `revalidateTag` and `updateTag` functions for custom webhook on-demand revalidation.
37
39
  */
38
40
  tags?: string[];
39
41
  }) => Promise<{
@@ -44,10 +46,6 @@ type DefinedSanityFetchType = <const QueryString extends string>(options: {
44
46
  */
45
47
  sourceMap: ContentSourceMap | null;
46
48
  /**
47
- * The perspective used to fetch the data, useful for debugging.
48
- */
49
- perspective: Exclude<ClientPerspective, "raw">;
50
- /**
51
49
  * The cache tags used with `next/cache`, useful for debugging.
52
50
  */
53
51
  tags: string[];
@@ -125,11 +123,6 @@ interface DefineSanityLiveOptions {
125
123
  * It is used to setup a `Live Draft Content` EventSource connection, and enables live previewing drafts stand-alone, outside of Presentation Tool.
126
124
  */
127
125
  browserToken?: string | false;
128
- /**
129
- * Optional. Include stega encoding when draft mode is enabled.
130
- * @defaultValue `true` if the client configuration has the `stega.studioUrl` property set, otherwise `false`
131
- */
132
- stega?: boolean;
133
126
  }
134
127
  /**
135
128
  * @alpha CAUTION: This API does not follow semver and could have breaking changes in future minor releases.
@@ -145,5 +138,5 @@ declare function defineLive(config: DefineSanityLiveOptions): {
145
138
  SanityLive: React.ComponentType<DefinedSanityLiveProps>;
146
139
  };
147
140
  //#endregion
148
- export { DefineSanityLiveOptions, DefinedSanityFetchType, DefinedSanityLiveProps, defineLive, resolvePerspectiveFromCookie };
141
+ export { DefineSanityLiveOptions, DefinedSanityFetchType, DefinedSanityLiveProps, defineLive, resolvePerspectiveFromCookies };
149
142
  //# sourceMappingURL=live.d.ts.map
package/dist/experimental/live.js CHANGED
@@ -1,36 +1,37 @@
1
1
  import { t as sanitizePerspective } from "../utils.js";
2
2
  import { n as PUBLISHED_SYNC_TAG_PREFIX, t as DRAFT_SYNC_TAG_PREFIX } from "../constants.js";
3
- import { stegaEncodeSourceMap } from "@sanity/client/stega";
4
3
  import { preconnect } from "react-dom";
5
4
  import { cookies, draftMode } from "next/headers";
6
5
  import { perspectiveCookieName } from "@sanity/preview-url-secret/constants";
7
6
  import { jsx } from "react/jsx-runtime";
8
7
  import "server-only";
9
- import { createClient } from "next-sanity";
8
+ import "next-sanity";
10
9
  import SanityLiveClientComponent from "next-sanity/experimental/client-components/live";
11
- import { cacheTag, updateTag } from "next/cache";
12
- async function resolvePerspectiveFromCookie({ cookies: jar }) {
10
+ import { cacheLife, cacheTag, updateTag } from "next/cache";
11
+ async function resolvePerspectiveFromCookies({ cookies: jar }) {
13
12
  return jar.has(perspectiveCookieName) ? sanitizePerspective(jar.get(perspectiveCookieName)?.value, "drafts") : "drafts";
14
13
  }
15
- async function sanityCachedFetch(config, { query, params = {}, perspective, stega, requestTag, draftToken, customCacheTags = [] }) {
16
- "use cache";
17
- const client = createClient({
14
+ async function sanityCachedFetch(_client, config, { query, params = {}, perspective, stega, requestTag, draftToken, customCacheTags = [] }) {
15
+ "use cache: remote";
16
+ const client = _client.withConfig({
18
17
  ...config,
19
- useCdn: true
18
+ useCdn: true,
19
+ allowReconfigure: false
20
20
  });
21
21
  const useCdn = perspective === "published";
22
- const { result, resultSourceMap, syncTags } = await client.fetch(query, params, {
22
+ const { result, resultSourceMap, syncTags } = await client.fetch(query, await params, {
23
23
  filterResponse: false,
24
24
  returnQuery: false,
25
25
  perspective,
26
26
  useCdn,
27
- resultSourceMap: stega ? "withKeyArraySelector" : void 0,
27
+ stega,
28
28
  cacheMode: useCdn ? "noStale" : void 0,
29
29
  tag: requestTag,
30
30
  token: perspective === "published" ? config.token : draftToken || config.token
31
31
  });
32
32
  const tags = [...customCacheTags, ...(syncTags || []).map((tag) => `${perspective === "published" ? PUBLISHED_SYNC_TAG_PREFIX : DRAFT_SYNC_TAG_PREFIX}${tag}`)];
33
33
  cacheTag(...tags);
34
+ cacheLife({ revalidate: 3600 * 24 * 90 });
34
35
  return {
35
36
  data: result,
36
37
  sourceMap: resultSourceMap || null,
@@ -46,15 +47,10 @@ function defineLive(config) {
46
47
  allowReconfigure: false,
47
48
  useCdn: false
48
49
  });
49
- const { token: originalToken, stega: stegaConfig } = client.config();
50
- const studioUrlDefined = typeof client.config().stega.studioUrl !== "undefined";
51
- const { stega: stegaEnabled = typeof client.config().stega.studioUrl !== "undefined" } = config;
50
+ const { token: originalToken, apiHost, apiVersion, useProjectHostname, dataset, projectId, requestTagPrefix } = client.config();
52
51
  return {
53
- sanityFetch: async function sanityFetch({ query, params = {}, stega: _stega, tags: customCacheTags = [], perspective: _perspective, requestTag = "next-loader.fetch" }) {
54
- const stega = _stega ?? (stegaEnabled && studioUrlDefined && (await draftMode()).isEnabled);
55
- const perspective = _perspective ?? ((await draftMode()).isEnabled ? "drafts" : "published");
56
- const { apiHost, apiVersion, useProjectHostname, dataset, projectId, requestTagPrefix } = client.config();
57
- const { data: _data, sourceMap, tags } = await sanityCachedFetch({
52
+ sanityFetch: function sanityFetch({ query, params = {}, stega = false, perspective = "published", tags: customCacheTags = [], requestTag = "next-loader.fetch" }) {
53
+ return sanityCachedFetch(client, {
58
54
  apiHost,
59
55
  apiVersion,
60
56
  useProjectHostname,
@@ -64,36 +60,27 @@ function defineLive(config) {
64
60
  token: originalToken
65
61
  }, {
66
62
  query,
67
- params: await params,
63
+ params,
68
64
  perspective,
69
65
  stega,
70
66
  requestTag,
71
67
  draftToken: serverToken,
72
68
  customCacheTags
73
69
  });
74
- return {
75
- data: stega && sourceMap ? stegaEncodeSourceMap(_data, sourceMap, {
76
- ...stegaConfig,
77
- enabled: true
78
- }) : _data,
79
- sourceMap,
80
- tags,
81
- perspective
82
- };
83
70
  },
84
71
  SanityLive: function SanityLive(props) {
85
72
  const { refreshOnMount = false, refreshOnFocus = false, refreshOnReconnect = false, requestTag, onError, onGoAway, intervalOnGoAway, revalidateSyncTags = expireTags } = props;
86
- const { projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix } = client.config();
73
+ const { projectId: projectId$1, dataset: dataset$1, apiHost: apiHost$1, apiVersion: apiVersion$1, useProjectHostname: useProjectHostname$1, requestTagPrefix: requestTagPrefix$1 } = client.config();
87
74
  const { origin } = new URL(client.getUrl("", false));
88
75
  preconnect(origin);
89
76
  return /* @__PURE__ */ jsx(SanityLiveServerComponent, {
90
77
  config: {
91
- projectId,
92
- dataset,
93
- apiHost,
94
- apiVersion,
95
- useProjectHostname,
96
- requestTagPrefix
78
+ projectId: projectId$1,
79
+ dataset: dataset$1,
80
+ apiHost: apiHost$1,
81
+ apiVersion: apiVersion$1,
82
+ useProjectHostname: useProjectHostname$1,
83
+ requestTagPrefix: requestTagPrefix$1
97
84
  },
98
85
  requestTag,
99
86
  browserToken,
@@ -110,7 +97,6 @@ function defineLive(config) {
110
97
  };
111
98
  }
112
99
  const SanityLiveServerComponent = async function SanityLiveServerComponent$1(props) {
113
- "use cache";
114
100
  const { config, requestTag, intervalOnGoAway, onError, onGoAway, refreshOnFocus, refreshOnMount, refreshOnReconnect, revalidateSyncTags, browserToken, resolveDraftModePerspective: resolveDraftModePerspective$1 } = props;
115
101
  const { isEnabled: isDraftModeEnabled } = await draftMode();
116
102
  return /* @__PURE__ */ jsx(SanityLiveClientComponent, {
@@ -146,9 +132,9 @@ async function expireTags(_tags) {
146
132
  }
147
133
  async function resolveDraftModePerspective() {
148
134
  "use server";
149
- if ((await draftMode()).isEnabled) return resolvePerspectiveFromCookie({ cookies: await cookies() });
135
+ if ((await draftMode()).isEnabled) return resolvePerspectiveFromCookies({ cookies: await cookies() });
150
136
  return "published";
151
137
  }
152
- export { defineLive, resolvePerspectiveFromCookie };
138
+ export { defineLive, resolvePerspectiveFromCookies };
153
139
 
154
140
  //# sourceMappingURL=live.js.map
package/dist/experimental/live.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"live.js","names":["SanityLiveServerComponent: React.ComponentType<SanityLiveServerComponentProps>","SanityLiveServerComponent","resolveDraftModePerspective"],"sources":["../../src/experimental/live.tsx"],"sourcesContent":["// oxlint-disable-next-line no-unassigned-import\nimport 'server-only'\nimport {\n createClient,\n type ClientPerspective,\n type ClientReturn,\n type ContentSourceMap,\n type LiveEventGoAway,\n type QueryParams,\n type SanityClient,\n type SyncTag,\n} from 'next-sanity'\nimport {stegaEncodeSourceMap} from '@sanity/client/stega'\nimport SanityLiveClientComponent, {\n type SanityLiveProps,\n} from 'next-sanity/experimental/client-components/live'\nimport {cacheTag, updateTag} from 'next/cache'\nimport {draftMode, cookies} from 'next/headers'\nimport {preconnect} from 'react-dom'\nimport {perspectiveCookieName} from '@sanity/preview-url-secret/constants'\nimport {sanitizePerspective} from '../live/utils'\nimport type {SanityClientConfig} from './types'\nimport {DRAFT_SYNC_TAG_PREFIX, PUBLISHED_SYNC_TAG_PREFIX} from './constants'\n\n/**\n * @alpha CAUTION: This API does not follow semver and could have breaking changes in future minor releases.\n */\nexport async function resolvePerspectiveFromCookie({\n cookies: jar,\n}: {\n cookies: Awaited<ReturnType<typeof cookies>>\n}): Promise<Exclude<ClientPerspective, 'raw'>> {\n return jar.has(perspectiveCookieName)\n ? sanitizePerspective(jar.get(perspectiveCookieName)?.value, 'drafts')\n : 'drafts'\n}\n\nasync function sanityCachedFetch<const QueryString extends string>(\n config: SanityClientConfig,\n {\n query,\n params = {},\n perspective,\n stega,\n requestTag,\n draftToken,\n customCacheTags = [],\n }: {\n query: QueryString\n params?: QueryParams\n perspective: Exclude<ClientPerspective, 'raw'>\n stega: boolean\n requestTag: string\n draftToken?: string | false | undefined\n customCacheTags?: string[]\n },\n): Promise<{\n data: ClientReturn<QueryString, unknown>\n sourceMap: ContentSourceMap | null\n tags: string[]\n}> {\n 'use cache'\n\n const client = createClient({...config, useCdn: true})\n const useCdn = perspective === 'published'\n /**\n * The default cache profile isn't ideal for live content, as it has unnecessary time based background validation, as well as a too lazy client stale value\n * https://github.com/vercel/next.js/blob/8dd358002baf4244c0b2e38b5bda496daf60dacb/packages/next/cache.d.ts#L14-L26\n */\n // cacheLife({\n // stale: Infinity,\n // revalidate: Infinity,\n // expire: Infinity,\n // })\n\n const {result, resultSourceMap, syncTags} = await client.fetch(query, params, {\n filterResponse: false,\n returnQuery: false,\n perspective,\n useCdn,\n resultSourceMap: stega ? 'withKeyArraySelector' : undefined, // @TODO allow passing csm for non-stega use\n cacheMode: useCdn ? 'noStale' : undefined,\n tag: requestTag,\n token: perspective === 'published' ? config.token : draftToken || config.token, // @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 return {data: result, sourceMap: resultSourceMap || null, tags}\n}\n\n/**\n * @alpha CAUTION: This API does not follow semver and could have breaking changes in future minor releases.\n */\nexport type DefinedSanityFetchType = <const QueryString extends string>(options: {\n query: QueryString\n params?: QueryParams | Promise<QueryParams>\n perspective?: Exclude<ClientPerspective, 'raw'>\n /**\n * Enables stega encoding of the data, this is typically only used in draft mode.\n * If `defineLive({..., stega: true})` is provided, then it defaults to `true` in Draft Mode.\n * If `defineLive({..., stega: false})` then it defaults to `false`.\n */\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 /**\n * Custom cache tags that can be used with next's `revalidateTag` function for custom webhook on-demand revalidation.\n */\n tags?: string[]\n}) => Promise<{\n data: ClientReturn<QueryString, unknown>\n /**\n * The Content Source Map can be used for custom setups like `encodeSourceMap` for `data-sanity` attributes, or `stegaEncodeSourceMap` for stega encoding in your own way.\n * The Content Source Map is only fetched by default in draft mode, if `stega` is `true`. Otherwise your client configuration will need to have `resultSourceMap: 'withKeyArraySelector' | true`\n */\n sourceMap: ContentSourceMap | null\n /**\n * The perspective used to fetch the data, useful for debugging.\n */\n perspective: Exclude<ClientPerspective, 'raw'>\n /**\n * The cache tags used with `next/cache`, useful for debugging.\n */\n tags: string[]\n}>\n\n/**\n * @alpha CAUTION: This API does not follow semver and could have breaking changes in future minor releases.\n */\nexport interface DefinedSanityLiveProps {\n /**\n * Automatic refresh of RSC when the component <SanityLive /> is mounted.\n * @defaultValue `false`\n */\n refreshOnMount?: boolean\n /**\n * Automatically refresh when window gets focused\n * @defaultValue `false`\n */\n refreshOnFocus?: boolean\n /**\n * Automatically refresh when the browser regains a network connection (via navigator.onLine)\n * @defaultValue `false`\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 * 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 // @TODO remove, replace with onLiveEvent\n revalidateSyncTags?: (\n tags: `${typeof PUBLISHED_SYNC_TAG_PREFIX | typeof DRAFT_SYNC_TAG_PREFIX}${SyncTag}`[],\n ) => Promise<void | 'refresh'>\n\n // @TODO add\n // decide how to handle a live event coming in\n // onLiveEvent?: (event: LiveEvent, mode: 'production' | 'preview) => void\n\n /**\n * Control how the draft mode perspective is resolved, by default it resolves from the `sanity-preview-perspective` cookie.\n */\n resolveDraftModePerspective?: () => Promise<ClientPerspective>\n}\n\n/**\n * @alpha CAUTION: This API does not follow semver and could have breaking changes in future minor releases.\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 * Optional. Include stega encoding when draft mode is enabled.\n * @defaultValue `true` if the client configuration has the `stega.studioUrl` property set, otherwise `false`\n */\n stega?: boolean\n}\n\n/**\n * @alpha CAUTION: This API does not follow semver and could have breaking changes in future minor releases.\n */\nexport function defineLive(config: DefineSanityLiveOptions): {\n /**\n * Use this function to fetch data from Sanity in your React Server Components.\n */\n sanityFetch: DefinedSanityFetchType\n /**\n * Render this in your root layout.tsx to make your page revalidate on new content live, automatically.\n */\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 // eslint-disable-next-line no-console\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 // eslint-disable-next-line no-console\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, stega: stegaConfig} = client.config()\n const studioUrlDefined = typeof client.config().stega.studioUrl !== 'undefined'\n const {stega: stegaEnabled = typeof client.config().stega.studioUrl !== 'undefined'} = config\n\n const sanityFetch: DefinedSanityFetchType = async function sanityFetch<\n const QueryString extends string,\n >({\n query,\n params = {},\n stega: _stega,\n tags: customCacheTags = [],\n perspective: _perspective,\n requestTag = 'next-loader.fetch',\n }: {\n query: QueryString\n params?: QueryParams | Promise<QueryParams>\n stega?: boolean\n tags?: string[]\n perspective?: Exclude<ClientPerspective, 'raw'>\n requestTag?: string\n }) {\n const stega = _stega ?? (stegaEnabled && studioUrlDefined && (await draftMode()).isEnabled)\n const perspective = _perspective ?? ((await draftMode()).isEnabled ? 'drafts' : 'published')\n\n const {apiHost, apiVersion, useProjectHostname, dataset, projectId, requestTagPrefix} =\n client.config()\n const {\n data: _data,\n sourceMap,\n tags,\n } = await sanityCachedFetch(\n {\n apiHost,\n apiVersion,\n useProjectHostname,\n dataset,\n projectId,\n requestTagPrefix,\n token: originalToken,\n },\n {\n query,\n params: await params,\n perspective,\n stega,\n requestTag,\n draftToken: serverToken,\n customCacheTags,\n },\n )\n\n const data =\n stega && sourceMap\n ? stegaEncodeSourceMap(_data, sourceMap, {...stegaConfig, enabled: true})\n : _data\n\n return {data, sourceMap, tags, perspective}\n }\n\n const SanityLive: React.ComponentType<DefinedSanityLiveProps> = function SanityLive(props) {\n const {\n // perspective,\n refreshOnMount = false,\n refreshOnFocus = false,\n refreshOnReconnect = false,\n requestTag,\n onError,\n onGoAway,\n intervalOnGoAway,\n revalidateSyncTags = expireTags,\n } = props\n\n const {projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix} =\n client.config()\n const {origin} = new URL(client.getUrl('', false))\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 preconnect(origin)\n\n return (\n <SanityLiveServerComponent\n config={{projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix}}\n requestTag={requestTag}\n browserToken={browserToken}\n // origin={origin}\n refreshOnMount={refreshOnMount}\n refreshOnFocus={refreshOnFocus}\n refreshOnReconnect={refreshOnReconnect}\n onError={onError}\n onGoAway={onGoAway}\n intervalOnGoAway={intervalOnGoAway}\n revalidateSyncTags={revalidateSyncTags}\n resolveDraftModePerspective={\n props.resolveDraftModePerspective ?? resolveDraftModePerspective\n }\n />\n )\n }\n\n return {sanityFetch, SanityLive}\n}\n\ninterface SanityLiveServerComponentProps\n extends Omit<SanityLiveProps, 'draftModeEnabled' | 'token' | 'draftModePerspective'> {\n browserToken: string | false | undefined\n // origin: string\n // perspective?: Exclude<ClientPerspective, 'raw'>\n}\n\nconst SanityLiveServerComponent: React.ComponentType<SanityLiveServerComponentProps> =\n async function SanityLiveServerComponent(props) {\n 'use cache'\n // @TODO should this be 'max' instead?, or configured by changing the default cache profile?\n // cacheLife({\n // stale: Infinity,\n // revalidate: Infinity,\n // expire: Infinity,\n // })\n const {\n config,\n requestTag,\n intervalOnGoAway,\n onError,\n onGoAway,\n refreshOnFocus,\n refreshOnMount,\n refreshOnReconnect,\n revalidateSyncTags,\n browserToken,\n // origin,\n // perspective,\n resolveDraftModePerspective,\n } = props\n\n const {isEnabled: isDraftModeEnabled} = await draftMode()\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 // preconnect(origin)\n\n return (\n <SanityLiveClientComponent\n config={{\n ...config,\n token: typeof browserToken === 'string' && isDraftModeEnabled ? browserToken : undefined,\n }}\n requestTag={requestTag}\n draftModeEnabled={isDraftModeEnabled}\n refreshOnMount={refreshOnMount}\n refreshOnFocus={refreshOnFocus}\n refreshOnReconnect={refreshOnReconnect}\n onError={onError}\n onGoAway={onGoAway}\n intervalOnGoAway={intervalOnGoAway}\n revalidateSyncTags={revalidateSyncTags}\n resolveDraftModePerspective={resolveDraftModePerspective}\n />\n )\n }\n\n// @TODO expose parseTags function that returns the correct array of tags\n// we already have s1: prefixes, but they could change\n// use sp: for prod, sd: for draft, keep em short\nasync function expireTags(_tags: unknown): Promise<void> {\n 'use server'\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 console.log(`<SanityLive /> updated tags: ${tags.join(', ')}`)\n}\n\nasync function resolveDraftModePerspective(): Promise<ClientPerspective> {\n 'use server'\n if ((await draftMode()).isEnabled) {\n const jar = await cookies()\n return resolvePerspectiveFromCookie({cookies: jar})\n }\n return 'published'\n}\n\n/**\n * Add more stuff:\n * - sanityFetchMetadata: sanityFetch({query, params, stega: false, perspective: 'auto'})\n * - sanityFetchStaticParams: sanityFetch({query, params, stega: false, perspective: 'published', cacheMode: undefined})\n * - sanityFetchCached: sanityFetch({query, params, stega: 'opt-in',perspective: 'opt-in'}) useful for 'use cache' components, no unexpected magic, maybe this will be `sanityFetch` instead\n * - sanityFetchDynamic: sanityFetch({query, params, stega: 'auto', perspective: 'auto'}) just like sanityFetch of old, since `sanityFetch` will likely become opt-in\n */\n"],"mappings":";;;;;;;;;;;AA2BA,eAAsB,6BAA6B,EACjD,SAAS,OAGoC;AAC7C,QAAO,IAAI,IAAI,sBAAsB,GACjC,oBAAoB,IAAI,IAAI,sBAAsB,EAAE,OAAO,SAAS,GACpE;;AAGN,eAAe,kBACb,QACA,EACE,OACA,SAAS,EAAE,EACX,aACA,OACA,YACA,YACA,kBAAkB,EAAE,IAcrB;AACD;CAEA,MAAM,SAAS,aAAa;EAAC,GAAG;EAAQ,QAAQ;EAAK,CAAC;CACtD,MAAM,SAAS,gBAAgB;CAW/B,MAAM,EAAC,QAAQ,iBAAiB,aAAY,MAAM,OAAO,MAAM,OAAO,QAAQ;EAC5E,gBAAgB;EAChB,aAAa;EACb;EACA;EACA,iBAAiB,QAAQ,yBAAyB,KAAA;EAClD,WAAW,SAAS,YAAY,KAAA;EAChC,KAAK;EACL,OAAO,gBAAgB,cAAc,OAAO,QAAQ,cAAc,OAAO;EAC1E,CAAC;CACF,MAAM,OAAO,CACX,GAAG,iBACH,IAAI,YAAY,EAAE,EAAE,KACjB,QACC,GAAG,gBAAgB,cAAc,4BAA4B,wBAAwB,MACxF,CACF;AAID,UAAS,GAAG,KAAK;AAEjB,QAAO;EAAC,MAAM;EAAQ,WAAW,mBAAmB;EAAM;EAAK;;AA2IjE,SAAgB,WAAW,QASzB;CACA,MAAM,EAAC,QAAQ,SAAS,aAAa,iBAAgB;AAErD,KAAI,CAAC,QACH,OAAM,IAAI,MAAM,oDAAoD;AAGtE,KAAI,QAAQ,IAAI,aAAa,gBAAgB,CAAC,eAAe,gBAAgB,MAE3E,SAAQ,KACN,8LACD;AAGH,KAAI,QAAQ,IAAI,aAAa,gBAAgB,CAAC,gBAAgB,iBAAiB,MAE7E,SAAQ,KACN,iXACD;CAGH,MAAM,SAAS,QAAQ,WAAW;EAAC,kBAAkB;EAAO,QAAQ;EAAM,CAAC;CAC3E,MAAM,EAAC,OAAO,eAAe,OAAO,gBAAe,OAAO,QAAQ;CAClE,MAAM,mBAAmB,OAAO,OAAO,QAAQ,CAAC,MAAM,cAAc;CACpE,MAAM,EAAC,OAAO,eAAe,OAAO,OAAO,QAAQ,CAAC,MAAM,cAAc,gBAAe;AAiGvF,QAAO;EAAC,aA/FoC,eAAe,YAEzD,EACA,OACA,SAAS,EAAE,EACX,OAAO,QACP,MAAM,kBAAkB,EAAE,EAC1B,aAAa,cACb,aAAa,uBAQZ;GACD,MAAM,QAAQ,WAAW,gBAAgB,qBAAqB,MAAM,WAAW,EAAE;GACjF,MAAM,cAAc,kBAAkB,MAAM,WAAW,EAAE,YAAY,WAAW;GAEhF,MAAM,EAAC,SAAS,YAAY,oBAAoB,SAAS,WAAW,qBAClE,OAAO,QAAQ;GACjB,MAAM,EACJ,MAAM,OACN,WACA,SACE,MAAM,kBACR;IACE;IACA;IACA;IACA;IACA;IACA;IACA,OAAO;IACR,EACD;IACE;IACA,QAAQ,MAAM;IACd;IACA;IACA;IACA,YAAY;IACZ;IACD,CACF;AAOD,UAAO;IAAC,MAJN,SAAS,YACL,qBAAqB,OAAO,WAAW;KAAC,GAAG;KAAa,SAAS;KAAK,CAAC,GACvE;IAEQ;IAAW;IAAM;IAAY;;EA2CxB,YAxC2C,SAAS,WAAW,OAAO;GACzF,MAAM,EAEJ,iBAAiB,OACjB,iBAAiB,OACjB,qBAAqB,OACrB,YACA,SACA,UACA,kBACA,qBAAqB,eACnB;GAEJ,MAAM,EAAC,WAAW,SAAS,SAAS,YAAY,oBAAoB,qBAClE,OAAO,QAAQ;GACjB,MAAM,EAAC,WAAU,IAAI,IAAI,OAAO,OAAO,IAAI,MAAM,CAAC;AAGlD,cAAW,OAAO;AAElB,UACE,oBAAC,2BAAA;IACC,QAAQ;KAAC;KAAW;KAAS;KAAS;KAAY;KAAoB;KAAiB;IAC3E;IACE;IAEE;IACA;IACI;IACX;IACC;IACQ;IACE;IACpB,6BACE,MAAM,+BAA+B;KAEvC;;EAI0B;;AAUlC,MAAMA,4BACJ,eAAeC,4BAA0B,OAAO;AAC9C;CAOA,MAAM,EACJ,QACA,YACA,kBACA,SACA,UACA,gBACA,gBACA,oBACA,oBACA,cAGA,6BAAA,kCACE;CAEJ,MAAM,EAAC,WAAW,uBAAsB,MAAM,WAAW;AAKzD,QACE,oBAAC,2BAAA;EACC,QAAQ;GACN,GAAG;GACH,OAAO,OAAO,iBAAiB,YAAY,qBAAqB,eAAe,KAAA;GAChF;EACW;EACZ,kBAAkB;EACF;EACA;EACI;EACX;EACC;EACQ;EACE;EACpB,6BAA6BC;GAC7B;;AAOR,eAAe,WAAW,OAA+B;AACvD;AAIA,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;AAEhB,SAAQ,IAAI,gCAAgC,KAAK,KAAK,KAAK,GAAG;;AAGhE,eAAe,8BAA0D;AACvE;AACA,MAAK,MAAM,WAAW,EAAE,UAEtB,QAAO,6BAA6B,EAAC,SADzB,MAAM,SAAS,EACuB,CAAC;AAErD,QAAO"}
1
+ {"version":3,"file":"live.js","names":["SanityLiveServerComponent: React.ComponentType<SanityLiveServerComponentProps>","SanityLiveServerComponent","resolveDraftModePerspective"],"sources":["../../src/experimental/live.tsx"],"sourcesContent":["// oxlint-disable-next-line no-unassigned-import\nimport 'server-only'\nimport {\n type ClientPerspective,\n type ClientReturn,\n type ContentSourceMap,\n type LiveEventGoAway,\n type QueryParams,\n type SanityClient,\n type SyncTag,\n} from 'next-sanity'\nimport SanityLiveClientComponent, {\n type SanityLiveProps,\n} from 'next-sanity/experimental/client-components/live'\nimport {cacheTag, cacheLife, updateTag} from 'next/cache'\nimport {draftMode, cookies} from 'next/headers'\nimport {preconnect} from 'react-dom'\nimport {perspectiveCookieName} from '@sanity/preview-url-secret/constants'\nimport {sanitizePerspective} from '../live/utils'\nimport type {SanityClientConfig} from './types'\nimport {DRAFT_SYNC_TAG_PREFIX, PUBLISHED_SYNC_TAG_PREFIX} from './constants'\n\n/**\n * @alpha CAUTION: This API does not follow semver and could have breaking changes in future minor releases.\n */\nexport async function resolvePerspectiveFromCookies({\n cookies: jar,\n}: {\n cookies: Awaited<ReturnType<typeof cookies>>\n}): Promise<Exclude<ClientPerspective, 'raw'>> {\n return jar.has(perspectiveCookieName)\n ? sanitizePerspective(jar.get(perspectiveCookieName)?.value, 'drafts')\n : 'drafts'\n}\n\nasync function sanityCachedFetch<const QueryString extends string>(\n // opaque reference to the client, allows passing stega.filter and other non-serializable client options that won't be used as cache keys\n _client: SanityClient,\n // The parts of the client config that should be used as cache keys\n config: SanityClientConfig,\n {\n query,\n params = {},\n perspective,\n stega,\n requestTag,\n draftToken,\n customCacheTags = [],\n }: {\n query: QueryString\n params?: QueryParams | Promise<QueryParams>\n perspective: Exclude<ClientPerspective, 'raw'>\n stega: boolean\n requestTag: string\n draftToken?: string | false | undefined\n customCacheTags?: string[]\n },\n): Promise<{\n data: ClientReturn<QueryString, unknown>\n sourceMap: ContentSourceMap | null\n tags: string[]\n}> {\n 'use cache: remote'\n\n const client = _client.withConfig({...config, useCdn: true, allowReconfigure: false})\n const useCdn = perspective === 'published'\n\n const {result, resultSourceMap, syncTags} = await client.fetch(query, await params, {\n filterResponse: false,\n returnQuery: false,\n perspective,\n useCdn,\n // resultSourceMap: stega ? 'withKeyArraySelector' : undefined, // @TODO allow passing csm for non-stega use\n stega,\n cacheMode: useCdn ? 'noStale' : undefined,\n tag: requestTag,\n token: perspective === 'published' ? config.token : draftToken || config.token, // @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 */\n cacheLife({revalidate: 60 * 60 * 24 * 90})\n\n return {data: result, sourceMap: resultSourceMap || null, tags}\n}\n\n/**\n * @alpha CAUTION: This API does not follow semver and could have breaking changes in future minor releases.\n */\nexport type DefinedSanityFetchType = <const QueryString extends string>(options: {\n query: QueryString\n params?: QueryParams | Promise<QueryParams>\n /**\n * @defaultValue 'published'\n */\n perspective?: Exclude<ClientPerspective, 'raw'>\n /**\n * Enables stega encoding of the data, this is typically only used in draft mode in conjunction with `perspective: 'drafts'` and with `@sanity/visual-editing` setup.\n * @defaultValue `false`\n */\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 /**\n * Custom cache tags that can be used with next's `revalidateTag` and `updateTag` functions for custom webhook on-demand revalidation.\n */\n tags?: string[]\n}) => Promise<{\n data: ClientReturn<QueryString, unknown>\n /**\n * The Content Source Map can be used for custom setups like `encodeSourceMap` for `data-sanity` attributes, or `stegaEncodeSourceMap` for stega encoding in your own way.\n * The Content Source Map is only fetched by default in draft mode, if `stega` is `true`. Otherwise your client configuration will need to have `resultSourceMap: 'withKeyArraySelector' | true`\n */\n sourceMap: ContentSourceMap | null\n /**\n * The cache tags used with `next/cache`, useful for debugging.\n */\n tags: string[]\n}>\n\n/**\n * @alpha CAUTION: This API does not follow semver and could have breaking changes in future minor releases.\n */\nexport interface DefinedSanityLiveProps {\n /**\n * Automatic refresh of RSC when the component <SanityLive /> is mounted.\n * @defaultValue `false`\n */\n refreshOnMount?: boolean\n /**\n * Automatically refresh when window gets focused\n * @defaultValue `false`\n */\n refreshOnFocus?: boolean\n /**\n * Automatically refresh when the browser regains a network connection (via navigator.onLine)\n * @defaultValue `false`\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 * 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 // @TODO remove, replace with onLiveEvent\n revalidateSyncTags?: (\n tags: `${typeof PUBLISHED_SYNC_TAG_PREFIX | typeof DRAFT_SYNC_TAG_PREFIX}${SyncTag}`[],\n ) => Promise<void | 'refresh'>\n\n // @TODO add\n // decide how to handle a live event coming in\n // onLiveEvent?: (event: LiveEvent, mode: 'production' | 'preview) => void\n\n /**\n * Control how the draft mode perspective is resolved, by default it resolves from the `sanity-preview-perspective` cookie.\n */\n resolveDraftModePerspective?: () => Promise<ClientPerspective>\n}\n\n/**\n * @alpha CAUTION: This API does not follow semver and could have breaking changes in future minor releases.\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\n/**\n * @alpha CAUTION: This API does not follow semver and could have breaking changes in future minor releases.\n */\nexport function defineLive(config: DefineSanityLiveOptions): {\n /**\n * Use this function to fetch data from Sanity in your React Server Components.\n */\n sanityFetch: DefinedSanityFetchType\n /**\n * Render this in your root layout.tsx to make your page revalidate on new content live, automatically.\n */\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 // eslint-disable-next-line no-console\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 // eslint-disable-next-line no-console\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 {\n token: originalToken,\n apiHost,\n apiVersion,\n useProjectHostname,\n dataset,\n projectId,\n requestTagPrefix,\n } = client.config()\n\n const sanityFetch: DefinedSanityFetchType = function sanityFetch<\n const QueryString extends string,\n >({\n query,\n params = {},\n stega = false,\n perspective = 'published',\n tags: customCacheTags = [],\n requestTag = 'next-loader.fetch',\n }: {\n query: QueryString\n params?: QueryParams | Promise<QueryParams>\n stega?: boolean\n tags?: string[]\n perspective?: Exclude<ClientPerspective, 'raw'>\n requestTag?: string\n }) {\n return sanityCachedFetch(\n client,\n {\n apiHost,\n apiVersion,\n useProjectHostname,\n dataset,\n projectId,\n requestTagPrefix,\n token: originalToken,\n },\n {\n query,\n params,\n perspective,\n stega,\n requestTag,\n draftToken: serverToken,\n customCacheTags,\n },\n )\n }\n\n const SanityLive: React.ComponentType<DefinedSanityLiveProps> = function SanityLive(props) {\n const {\n // perspective,\n refreshOnMount = false,\n refreshOnFocus = false,\n refreshOnReconnect = false,\n requestTag,\n onError,\n onGoAway,\n intervalOnGoAway,\n revalidateSyncTags = expireTags,\n } = props\n\n const {projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix} =\n client.config()\n const {origin} = new URL(client.getUrl('', false))\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 preconnect(origin)\n\n return (\n <SanityLiveServerComponent\n config={{projectId, dataset, apiHost, apiVersion, useProjectHostname, requestTagPrefix}}\n requestTag={requestTag}\n browserToken={browserToken}\n // origin={origin}\n refreshOnMount={refreshOnMount}\n refreshOnFocus={refreshOnFocus}\n refreshOnReconnect={refreshOnReconnect}\n onError={onError}\n onGoAway={onGoAway}\n intervalOnGoAway={intervalOnGoAway}\n revalidateSyncTags={revalidateSyncTags}\n resolveDraftModePerspective={\n props.resolveDraftModePerspective ?? resolveDraftModePerspective\n }\n />\n )\n }\n\n return {sanityFetch, SanityLive}\n}\n\ninterface SanityLiveServerComponentProps\n extends Omit<SanityLiveProps, 'draftModeEnabled' | 'token' | 'draftModePerspective'> {\n browserToken: string | false | undefined\n // origin: string\n // perspective?: Exclude<ClientPerspective, 'raw'>\n}\n\nconst SanityLiveServerComponent: React.ComponentType<SanityLiveServerComponentProps> =\n async function SanityLiveServerComponent(props) {\n // 'use cache'\n // @TODO should this be 'max' instead?, or configured by changing the default cache profile?\n // cacheLife({\n // stale: Infinity,\n // revalidate: Infinity,\n // expire: Infinity,\n // })\n const {\n config,\n requestTag,\n intervalOnGoAway,\n onError,\n onGoAway,\n refreshOnFocus,\n refreshOnMount,\n refreshOnReconnect,\n revalidateSyncTags,\n browserToken,\n // origin,\n // perspective,\n resolveDraftModePerspective,\n } = props\n\n const {isEnabled: isDraftModeEnabled} = await draftMode()\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 // preconnect(origin)\n\n return (\n <SanityLiveClientComponent\n config={{\n ...config,\n token: typeof browserToken === 'string' && isDraftModeEnabled ? browserToken : undefined,\n }}\n requestTag={requestTag}\n draftModeEnabled={isDraftModeEnabled}\n refreshOnMount={refreshOnMount}\n refreshOnFocus={refreshOnFocus}\n refreshOnReconnect={refreshOnReconnect}\n onError={onError}\n onGoAway={onGoAway}\n intervalOnGoAway={intervalOnGoAway}\n revalidateSyncTags={revalidateSyncTags}\n resolveDraftModePerspective={resolveDraftModePerspective}\n />\n )\n }\n\n// @TODO expose parseTags function that returns the correct array of tags\n// we already have s1: prefixes, but they could change\n// use sp: for prod, sd: for draft, keep em short\nasync function expireTags(_tags: unknown): Promise<void> {\n 'use server'\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 console.log(`<SanityLive /> updated tags: ${tags.join(', ')}`)\n}\n\nasync function resolveDraftModePerspective(): Promise<ClientPerspective> {\n 'use server'\n if ((await draftMode()).isEnabled) {\n const jar = await cookies()\n return resolvePerspectiveFromCookies({cookies: jar})\n }\n return 'published'\n}\n"],"mappings":";;;;;;;;;;AAyBA,eAAsB,8BAA8B,EAClD,SAAS,OAGoC;AAC7C,QAAO,IAAI,IAAI,sBAAsB,GACjC,oBAAoB,IAAI,IAAI,sBAAsB,EAAE,OAAO,SAAS,GACpE;;AAGN,eAAe,kBAEb,SAEA,QACA,EACE,OACA,SAAS,EAAE,EACX,aACA,OACA,YACA,YACA,kBAAkB,EAAE,IAcrB;AACD;CAEA,MAAM,SAAS,QAAQ,WAAW;EAAC,GAAG;EAAQ,QAAQ;EAAM,kBAAkB;EAAM,CAAC;CACrF,MAAM,SAAS,gBAAgB;CAE/B,MAAM,EAAC,QAAQ,iBAAiB,aAAY,MAAM,OAAO,MAAM,OAAO,MAAM,QAAQ;EAClF,gBAAgB;EAChB,aAAa;EACb;EACA;EAEA;EACA,WAAW,SAAS,YAAY,KAAA;EAChC,KAAK;EACL,OAAO,gBAAgB,cAAc,OAAO,QAAQ,cAAc,OAAO;EAC1E,CAAC;CACF,MAAM,OAAO,CACX,GAAG,iBACH,IAAI,YAAY,EAAE,EAAE,KACjB,QACC,GAAG,gBAAgB,cAAc,4BAA4B,wBAAwB,MACxF,CACF;AAID,UAAS,GAAG,KAAK;AAIjB,WAAU,EAAC,YAAY,OAAU,KAAK,IAAG,CAAC;AAE1C,QAAO;EAAC,MAAM;EAAQ,WAAW,mBAAmB;EAAM;EAAK;;AAoIjE,SAAgB,WAAW,QASzB;CACA,MAAM,EAAC,QAAQ,SAAS,aAAa,iBAAgB;AAErD,KAAI,CAAC,QACH,OAAM,IAAI,MAAM,oDAAoD;AAGtE,KAAI,QAAQ,IAAI,aAAa,gBAAgB,CAAC,eAAe,gBAAgB,MAE3E,SAAQ,KACN,8LACD;AAGH,KAAI,QAAQ,IAAI,aAAa,gBAAgB,CAAC,gBAAgB,iBAAiB,MAE7E,SAAQ,KACN,iXACD;CAGH,MAAM,SAAS,QAAQ,WAAW;EAAC,kBAAkB;EAAO,QAAQ;EAAM,CAAC;CAC3E,MAAM,EACJ,OAAO,eACP,SACA,YACA,oBACA,SACA,WACA,qBACE,OAAO,QAAQ;AAkFnB,QAAO;EAAC,aAhFoC,SAAS,YAEnD,EACA,OACA,SAAS,EAAE,EACX,QAAQ,OACR,cAAc,aACd,MAAM,kBAAkB,EAAE,EAC1B,aAAa,uBAQZ;AACD,UAAO,kBACL,QACA;IACE;IACA;IACA;IACA;IACA;IACA;IACA,OAAO;IACR,EACD;IACE;IACA;IACA;IACA;IACA;IACA,YAAY;IACZ;IACD,CACF;;EA2CkB,YAxC2C,SAAS,WAAW,OAAO;GACzF,MAAM,EAEJ,iBAAiB,OACjB,iBAAiB,OACjB,qBAAqB,OACrB,YACA,SACA,UACA,kBACA,qBAAqB,eACnB;GAEJ,MAAM,EAAC,WAAA,aAAW,SAAA,WAAS,SAAA,WAAS,YAAA,cAAY,oBAAA,sBAAoB,kBAAA,uBAClE,OAAO,QAAQ;GACjB,MAAM,EAAC,WAAU,IAAI,IAAI,OAAO,OAAO,IAAI,MAAM,CAAC;AAGlD,cAAW,OAAO;AAElB,UACE,oBAAC,2BAAA;IACC,QAAQ;KAAC,WAAA;KAAW,SAAA;KAAS,SAAA;KAAS,YAAA;KAAY,oBAAA;KAAoB,kBAAA;KAAiB;IAC3E;IACE;IAEE;IACA;IACI;IACX;IACC;IACQ;IACE;IACpB,6BACE,MAAM,+BAA+B;KAEvC;;EAI0B;;AAUlC,MAAMA,4BACJ,eAAeC,4BAA0B,OAAO;CAQ9C,MAAM,EACJ,QACA,YACA,kBACA,SACA,UACA,gBACA,gBACA,oBACA,oBACA,cAGA,6BAAA,kCACE;CAEJ,MAAM,EAAC,WAAW,uBAAsB,MAAM,WAAW;AAKzD,QACE,oBAAC,2BAAA;EACC,QAAQ;GACN,GAAG;GACH,OAAO,OAAO,iBAAiB,YAAY,qBAAqB,eAAe,KAAA;GAChF;EACW;EACZ,kBAAkB;EACF;EACA;EACI;EACX;EACC;EACQ;EACE;EACpB,6BAA6BC;GAC7B;;AAOR,eAAe,WAAW,OAA+B;AACvD;AAIA,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;AAEhB,SAAQ,IAAI,gCAAgC,KAAK,KAAK,KAAK,GAAG;;AAGhE,eAAe,8BAA0D;AACvE;AACA,MAAK,MAAM,WAAW,EAAE,UAEtB,QAAO,8BAA8B,EAAC,SAD1B,MAAM,SAAS,EACwB,CAAC;AAEtD,QAAO"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "next-sanity",
3
- "version": "11.5.6",
3
+ "version": "11.5.7-canary.2",
4
4
  "description": "Sanity.io toolkit for Next.js",
5
5
  "keywords": [
6
6
  "sanity",
@@ -115,12 +115,12 @@
115
115
  "@types/react": "^19.1.8",
116
116
  "@types/react-dom": "^19.1.6",
117
117
  "@vitest/coverage-v8": "^3.2.4",
118
- "next": "^15.3.5",
119
- "publint": "^0.3.14",
118
+ "next": "^16.0.0",
119
+ "publint": "^0.3.15",
120
120
  "react": "^19.1.0",
121
121
  "react-dom": "^19.1.0",
122
122
  "styled-components": "^6.1.19",
123
- "tsdown": "0.15.7",
123
+ "tsdown": "0.15.9",
124
124
  "typescript": "5.9.3",
125
125
  "vite-tsconfig-paths": "^5.1.4",
126
126
  "vitest": "^3.2.4"
package/src/experimental/live.tsx CHANGED
@@ -1,7 +1,6 @@
1
1
  // oxlint-disable-next-line no-unassigned-import
2
2
  import 'server-only'
3
3
  import {
4
- createClient,
5
4
  type ClientPerspective,
6
5
  type ClientReturn,
7
6
  type ContentSourceMap,
@@ -10,11 +9,10 @@ import {
10
9
  type SanityClient,
11
10
  type SyncTag,
12
11
  } from 'next-sanity'
13
- import {stegaEncodeSourceMap} from '@sanity/client/stega'
14
12
  import SanityLiveClientComponent, {
15
13
  type SanityLiveProps,
16
14
  } from 'next-sanity/experimental/client-components/live'
17
- import {cacheTag, updateTag} from 'next/cache'
15
+ import {cacheTag, cacheLife, updateTag} from 'next/cache'
18
16
  import {draftMode, cookies} from 'next/headers'
19
17
  import {preconnect} from 'react-dom'
20
18
  import {perspectiveCookieName} from '@sanity/preview-url-secret/constants'
@@ -25,7 +23,7 @@ import {DRAFT_SYNC_TAG_PREFIX, PUBLISHED_SYNC_TAG_PREFIX} from './constants'
25
23
  /**
26
24
  * @alpha CAUTION: This API does not follow semver and could have breaking changes in future minor releases.
27
25
  */
28
- export async function resolvePerspectiveFromCookie({
26
+ export async function resolvePerspectiveFromCookies({
29
27
  cookies: jar,
30
28
  }: {
31
29
  cookies: Awaited<ReturnType<typeof cookies>>
@@ -36,6 +34,9 @@ export async function resolvePerspectiveFromCookie({
36
34
  }
37
35
 
38
36
  async function sanityCachedFetch<const QueryString extends string>(
37
+ // opaque reference to the client, allows passing stega.filter and other non-serializable client options that won't be used as cache keys
38
+ _client: SanityClient,
39
+ // The parts of the client config that should be used as cache keys
39
40
  config: SanityClientConfig,
40
41
  {
41
42
  query,
@@ -47,7 +48,7 @@ async function sanityCachedFetch<const QueryString extends string>(
47
48
  customCacheTags = [],
48
49
  }: {
49
50
  query: QueryString
50
- params?: QueryParams
51
+ params?: QueryParams | Promise<QueryParams>
51
52
  perspective: Exclude<ClientPerspective, 'raw'>
52
53
  stega: boolean
53
54
  requestTag: string
@@ -59,26 +60,18 @@ async function sanityCachedFetch<const QueryString extends string>(
59
60
  sourceMap: ContentSourceMap | null
60
61
  tags: string[]
61
62
  }> {
62
- 'use cache'
63
+ 'use cache: remote'
63
64
 
64
- const client = createClient({...config, useCdn: true})
65
+ const client = _client.withConfig({...config, useCdn: true, allowReconfigure: false})
65
66
  const useCdn = perspective === 'published'
66
- /**
67
- * The default cache profile isn't ideal for live content, as it has unnecessary time based background validation, as well as a too lazy client stale value
68
- * https://github.com/vercel/next.js/blob/8dd358002baf4244c0b2e38b5bda496daf60dacb/packages/next/cache.d.ts#L14-L26
69
- */
70
- // cacheLife({
71
- // stale: Infinity,
72
- // revalidate: Infinity,
73
- // expire: Infinity,
74
- // })
75
67
 
76
- const {result, resultSourceMap, syncTags} = await client.fetch(query, params, {
68
+ const {result, resultSourceMap, syncTags} = await client.fetch(query, await params, {
77
69
  filterResponse: false,
78
70
  returnQuery: false,
79
71
  perspective,
80
72
  useCdn,
81
- resultSourceMap: stega ? 'withKeyArraySelector' : undefined, // @TODO allow passing csm for non-stega use
73
+ // resultSourceMap: stega ? 'withKeyArraySelector' : undefined, // @TODO allow passing csm for non-stega use
74
+ stega,
82
75
  cacheMode: useCdn ? 'noStale' : undefined,
83
76
  tag: requestTag,
84
77
  token: perspective === 'published' ? config.token : draftToken || config.token, // @TODO can pass undefined instead of config.token here?
@@ -94,6 +87,10 @@ async function sanityCachedFetch<const QueryString extends string>(
94
87
  * The tags used here, are expired later on in the `expireTags` Server Action with the `expireTag` function from `next/cache`
95
88
  */
96
89
  cacheTag(...tags)
90
+ /**
91
+ * Sanity Live handles on-demand revalidation, so the default 15min time based revalidation is too short
92
+ */
93
+ cacheLife({revalidate: 60 * 60 * 24 * 90})
97
94
 
98
95
  return {data: result, sourceMap: resultSourceMap || null, tags}
99
96
  }
@@ -104,11 +101,13 @@ async function sanityCachedFetch<const QueryString extends string>(
104
101
  export type DefinedSanityFetchType = <const QueryString extends string>(options: {
105
102
  query: QueryString
106
103
  params?: QueryParams | Promise<QueryParams>
104
+ /**
105
+ * @defaultValue 'published'
106
+ */
107
107
  perspective?: Exclude<ClientPerspective, 'raw'>
108
108
  /**
109
- * Enables stega encoding of the data, this is typically only used in draft mode.
110
- * If `defineLive({..., stega: true})` is provided, then it defaults to `true` in Draft Mode.
111
- * If `defineLive({..., stega: false})` then it defaults to `false`.
109
+ * Enables stega encoding of the data, this is typically only used in draft mode in conjunction with `perspective: 'drafts'` and with `@sanity/visual-editing` setup.
110
+ * @defaultValue `false`
112
111
  */
113
112
  stega?: boolean
114
113
  /**
@@ -118,7 +117,7 @@ export type DefinedSanityFetchType = <const QueryString extends string>(options:
118
117
  */
119
118
  requestTag?: string
120
119
  /**
121
- * Custom cache tags that can be used with next's `revalidateTag` function for custom webhook on-demand revalidation.
120
+ * Custom cache tags that can be used with next's `revalidateTag` and `updateTag` functions for custom webhook on-demand revalidation.
122
121
  */
123
122
  tags?: string[]
124
123
  }) => Promise<{
@@ -128,10 +127,6 @@ export type DefinedSanityFetchType = <const QueryString extends string>(options:
128
127
  * The Content Source Map is only fetched by default in draft mode, if `stega` is `true`. Otherwise your client configuration will need to have `resultSourceMap: 'withKeyArraySelector' | true`
129
128
  */
130
129
  sourceMap: ContentSourceMap | null
131
- /**
132
- * The perspective used to fetch the data, useful for debugging.
133
- */
134
- perspective: Exclude<ClientPerspective, 'raw'>
135
130
  /**
136
131
  * The cache tags used with `next/cache`, useful for debugging.
137
132
  */
@@ -224,11 +219,6 @@ export interface DefineSanityLiveOptions {
224
219
  * It is used to setup a `Live Draft Content` EventSource connection, and enables live previewing drafts stand-alone, outside of Presentation Tool.
225
220
  */
226
221
  browserToken?: string | false
227
- /**
228
- * Optional. Include stega encoding when draft mode is enabled.
229
- * @defaultValue `true` if the client configuration has the `stega.studioUrl` property set, otherwise `false`
230
- */
231
- stega?: boolean
232
222
  }
233
223
 
234
224
  /**
@@ -265,18 +255,24 @@ export function defineLive(config: DefineSanityLiveOptions): {
265
255
  }
266
256
 
267
257
  const client = _client.withConfig({allowReconfigure: false, useCdn: false})
268
- const {token: originalToken, stega: stegaConfig} = client.config()
269
- const studioUrlDefined = typeof client.config().stega.studioUrl !== 'undefined'
270
- const {stega: stegaEnabled = typeof client.config().stega.studioUrl !== 'undefined'} = config
271
-
272
- const sanityFetch: DefinedSanityFetchType = async function sanityFetch<
258
+ const {
259
+ token: originalToken,
260
+ apiHost,
261
+ apiVersion,
262
+ useProjectHostname,
263
+ dataset,
264
+ projectId,
265
+ requestTagPrefix,
266
+ } = client.config()
267
+
268
+ const sanityFetch: DefinedSanityFetchType = function sanityFetch<
273
269
  const QueryString extends string,
274
270
  >({
275
271
  query,
276
272
  params = {},
277
- stega: _stega,
273
+ stega = false,
274
+ perspective = 'published',
278
275
  tags: customCacheTags = [],
279
- perspective: _perspective,
280
276
  requestTag = 'next-loader.fetch',
281
277
  }: {
282
278
  query: QueryString
@@ -286,16 +282,8 @@ export function defineLive(config: DefineSanityLiveOptions): {
286
282
  perspective?: Exclude<ClientPerspective, 'raw'>
287
283
  requestTag?: string
288
284
  }) {
289
- const stega = _stega ?? (stegaEnabled && studioUrlDefined && (await draftMode()).isEnabled)
290
- const perspective = _perspective ?? ((await draftMode()).isEnabled ? 'drafts' : 'published')
291
-
292
- const {apiHost, apiVersion, useProjectHostname, dataset, projectId, requestTagPrefix} =
293
- client.config()
294
- const {
295
- data: _data,
296
- sourceMap,
297
- tags,
298
- } = await sanityCachedFetch(
285
+ return sanityCachedFetch(
286
+ client,
299
287
  {
300
288
  apiHost,
301
289
  apiVersion,
@@ -307,7 +295,7 @@ export function defineLive(config: DefineSanityLiveOptions): {
307
295
  },
308
296
  {
309
297
  query,
310
- params: await params,
298
+ params,
311
299
  perspective,
312
300
  stega,
313
301
  requestTag,
@@ -315,13 +303,6 @@ export function defineLive(config: DefineSanityLiveOptions): {
315
303
  customCacheTags,
316
304
  },
317
305
  )
318
-
319
- const data =
320
- stega && sourceMap
321
- ? stegaEncodeSourceMap(_data, sourceMap, {...stegaConfig, enabled: true})
322
- : _data
323
-
324
- return {data, sourceMap, tags, perspective}
325
306
  }
326
307
 
327
308
  const SanityLive: React.ComponentType<DefinedSanityLiveProps> = function SanityLive(props) {
@@ -376,7 +357,7 @@ interface SanityLiveServerComponentProps
376
357
 
377
358
  const SanityLiveServerComponent: React.ComponentType<SanityLiveServerComponentProps> =
378
359
  async function SanityLiveServerComponent(props) {
379
- 'use cache'
360
+ // 'use cache'
380
361
  // @TODO should this be 'max' instead?, or configured by changing the default cache profile?
381
362
  // cacheLife({
382
363
  // stale: Infinity,
@@ -453,15 +434,7 @@ async function resolveDraftModePerspective(): Promise<ClientPerspective> {
453
434
  'use server'
454
435
  if ((await draftMode()).isEnabled) {
455
436
  const jar = await cookies()
456
- return resolvePerspectiveFromCookie({cookies: jar})
437
+ return resolvePerspectiveFromCookies({cookies: jar})
457
438
  }
458
439
  return 'published'
459
440
  }
460
-
461
- /**
462
- * Add more stuff:
463
- * - sanityFetchMetadata: sanityFetch({query, params, stega: false, perspective: 'auto'})
464
- * - sanityFetchStaticParams: sanityFetch({query, params, stega: false, perspective: 'published', cacheMode: undefined})
465
- * - sanityFetchCached: sanityFetch({query, params, stega: 'opt-in',perspective: 'opt-in'}) useful for 'use cache' components, no unexpected magic, maybe this will be `sanityFetch` instead
466
- * - sanityFetchDynamic: sanityFetch({query, params, stega: 'auto', perspective: 'auto'}) just like sanityFetch of old, since `sanityFetch` will likely become opt-in
467
- */