Add resolvePerspectiveFromCookies export

Author: stipsan

.changeset/yummy-bears-juggle.md

@@ -0,0 +1,5 @@
+---
+"next-sanity": minor
+---
+
+Add `resolvePerspectiveFromCookies` export

packages/next-sanity/package.json

@@ -42,13 +42,13 @@
     "./live/client-components/live": "./src/live/client-components/live/index.ts",
     "./live/client-components/live-stream": "./src/live/client-components/live-stream/index.ts",
     "./live/server-actions": "./src/live/server-actions/index.ts",
-    "./package.json": "./package.json",
     "./studio": "./src/studio/index.ts",
     "./studio/client-component": "./src/studio/client-component/index.ts",
     "./visual-editing": "./src/visual-editing/index.ts",
     "./visual-editing/client-component": "./src/visual-editing/client-component/index.ts",
     "./visual-editing/server-actions": "./src/visual-editing/server-actions/index.ts",
-    "./webhook": "./src/webhook/index.ts"
+    "./webhook": "./src/webhook/index.ts",
+    "./package.json": "./package.json"
   },
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",

packages/next-sanity/src/live.next-js.tsx

@@ -9,5 +9,6 @@ export {
   type DefinedSanityLiveProps,
   type SanityFetchOptions,
   defineLive,
-  resolvePerspectiveFromCookies,
 } from './experimental/live'
+
+export {resolvePerspectiveFromCookies} from '#live/resolvePerspectiveFromCookies'

packages/next-sanity/src/live.react-server.tsx

@@ -11,3 +11,5 @@ export {
   type DefinedSanityLiveStreamType,
   defineLive,
 } from './live/defineLive'
+
+export {resolvePerspectiveFromCookies} from '#live/resolvePerspectiveFromCookies'

packages/next-sanity/src/live.tsx

@@ -21,7 +21,7 @@ export function defineLive(_config: DefineSanityLiveOptions): {
   SanityLive: React.ComponentType<DefinedSanityLiveProps>
   SanityLiveStream: DefinedSanityLiveStreamType
 } {
-  throw new Error('defineLive can only be used in React Server Components')
+  throw new Error(`defineLive can't be imported by a client component`)
 }
 
 /**
@@ -33,3 +33,13 @@ export type {
   DefinedSanityLiveProps,
   DefinedSanityLiveStreamType,
 }
+
+import type {ResolvePerspectiveFromCookies} from '#live/resolvePerspectiveFromCookies'
+
+/**
+ * Resolves the perspective from the cookie that is set by `import { defineEnableDraftMode } from "next-sanity/draft-mode"`
+ * @public
+ */
+export const resolvePerspectiveFromCookies: ResolvePerspectiveFromCookies = async () => {
+  throw new Error(`resolvePerspectiveFromCookies can't be imported by a client component`)
+}

packages/next-sanity/src/shared/live/resolvePerspectiveFromCookies.ts

@@ -4,11 +4,25 @@ import type {cookies} from 'next/headers'
 import {sanitizePerspective} from '#live/sanitizePerspective'
 import {perspectiveCookieName} from '@sanity/preview-url-secret/constants'
 
+export type ResolvePerspectiveFromCookies = (options: {
+  /**
+   * You must await the cookies() function from next/headers
+   * and pass it here.
+   * Example:
+   * ```ts
+   * import { cookies } from 'next/headers'
+   *
+   * const perspective = await resolvePerspectiveFromCookies({cookies: await cookies()})
+   * ```
+   */
+  cookies: Awaited<ReturnType<typeof cookies>>
+}) => Promise<Exclude<ClientPerspective, 'raw'>>
+
 /**
  * Resolves the perspective from the cookie that is set by `import { defineEnableDraftMode } from "next-sanity/draft-mode"`
  * @public
  */
-export async function resolvePerspectiveFromCookies({
+export const resolvePerspectiveFromCookies = async function resolvePerspectiveFromCookies({
   cookies: jar,
 }: {
   cookies: Awaited<ReturnType<typeof cookies>>