@sanity/client 7.12.1 → 7.13.0

package/dist/stega.browser.d.cts

@@ -2130,22 +2130,41 @@ export declare function _listen<R extends Record<string, Any> = Record<string, A
  * @param options - Optional listener options
  * @public
  */
-export declare function _listen<R extends Record<string, Any> = Record<string, Any>>(
+export declare function _listen<
+  R extends Record<string, Any> = Record<string, Any>,
+  Opts extends ListenOptions = ListenOptions,
+>(
   this: SanityClient | ObservableSanityClient,
   query: string,
   params?: ListenParams,
-  options?: ListenOptions,
-): Observable<ListenEvent<R>>
+  options?: Opts,
+): Observable<ListenEventFromOptions<R, Opts>>
 
 /** @public */
 export declare type ListenEvent<R extends Record<string, Any>> =
   | MutationEvent<R>
-  | ChannelErrorEvent
-  | DisconnectEvent
   | ReconnectEvent
   | WelcomeEvent
   | OpenEvent
 
+/**
+ * Maps a ListenOptions object and returns the Listen events opted for, e.g:
+ * ```
+ * type Test = ListenEventFromOptions<Doc, {events: ['welcome', 'mutation']}>
+ *    // ^? WelcomeEvent | MutationEvent<Doc>
+ * ```
+ *
+ * @public
+ */
+declare type ListenEventFromOptions<
+  R extends Record<string, Any> = Record<string, Any>,
+  Opts extends ListenOptions | undefined = undefined,
+> = Opts extends ListenOptions
+  ? Opts['events'] extends ListenEventName[]
+    ? MapListenEventNamesToListenEvents<R, Opts['events']>
+    : ListenEvent<R>
+  : MutationEvent<R>
+
 /** @public */
 export declare type ListenEventName =
   /** A mutation was performed */
@@ -2154,6 +2173,11 @@ export declare type ListenEventName =
   | 'welcome'
   /** The listener has been disconnected, and a reconnect attempt is scheduled */
   | 'reconnect'
+  /**
+   * The listener connection has been established
+   * note: it's usually a better option to use the 'welcome' event
+   */
+  | 'open'
 
 /** @public */
 export declare interface ListenOptions {
@@ -2295,6 +2319,30 @@ declare type Logger_2 =
       Pick<typeof console, 'debug' | 'error' | 'groupCollapsed' | 'groupEnd' | 'log' | 'table'>
     >
 
+/**
+ * Maps an array of listen events names to their corresponding listen event type, e.g:
+ * ```
+ * type Test = MapListenEventNamesToListenEvents<Doc, ['welcome']>
+ *    // ^? WelcomeEvent
+ * ```
+ *
+ * @public
+ */
+declare type MapListenEventNamesToListenEvents<
+  R extends Record<string, Any> = Record<string, Any>,
+  Events extends ListenEventName[] = ListenEventName[],
+> = Events extends (infer E)[]
+  ? E extends 'welcome'
+    ? WelcomeEvent
+    : E extends 'mutation'
+      ? MutationEvent<R>
+      : E extends 'reconnect'
+        ? ReconnectEvent
+        : E extends 'open'
+          ? OpenEvent
+          : never
+  : never
+
 /** @public */
 export declare type MediaLibraryAssetInstanceIdentifier = string | SanityReference
 

package/dist/stega.browser.d.ts

@@ -2130,22 +2130,41 @@ export declare function _listen<R extends Record<string, Any> = Record<string, A
  * @param options - Optional listener options
  * @public
  */
-export declare function _listen<R extends Record<string, Any> = Record<string, Any>>(
+export declare function _listen<
+  R extends Record<string, Any> = Record<string, Any>,
+  Opts extends ListenOptions = ListenOptions,
+>(
   this: SanityClient | ObservableSanityClient,
   query: string,
   params?: ListenParams,
-  options?: ListenOptions,
-): Observable<ListenEvent<R>>
+  options?: Opts,
+): Observable<ListenEventFromOptions<R, Opts>>
 
 /** @public */
 export declare type ListenEvent<R extends Record<string, Any>> =
   | MutationEvent<R>
-  | ChannelErrorEvent
-  | DisconnectEvent
   | ReconnectEvent
   | WelcomeEvent
   | OpenEvent
 
+/**
+ * Maps a ListenOptions object and returns the Listen events opted for, e.g:
+ * ```
+ * type Test = ListenEventFromOptions<Doc, {events: ['welcome', 'mutation']}>
+ *    // ^? WelcomeEvent | MutationEvent<Doc>
+ * ```
+ *
+ * @public
+ */
+declare type ListenEventFromOptions<
+  R extends Record<string, Any> = Record<string, Any>,
+  Opts extends ListenOptions | undefined = undefined,
+> = Opts extends ListenOptions
+  ? Opts['events'] extends ListenEventName[]
+    ? MapListenEventNamesToListenEvents<R, Opts['events']>
+    : ListenEvent<R>
+  : MutationEvent<R>
+
 /** @public */
 export declare type ListenEventName =
   /** A mutation was performed */
@@ -2154,6 +2173,11 @@ export declare type ListenEventName =
   | 'welcome'
   /** The listener has been disconnected, and a reconnect attempt is scheduled */
   | 'reconnect'
+  /**
+   * The listener connection has been established
+   * note: it's usually a better option to use the 'welcome' event
+   */
+  | 'open'
 
 /** @public */
 export declare interface ListenOptions {
@@ -2295,6 +2319,30 @@ declare type Logger_2 =
       Pick<typeof console, 'debug' | 'error' | 'groupCollapsed' | 'groupEnd' | 'log' | 'table'>
     >
 
+/**
+ * Maps an array of listen events names to their corresponding listen event type, e.g:
+ * ```
+ * type Test = MapListenEventNamesToListenEvents<Doc, ['welcome']>
+ *    // ^? WelcomeEvent
+ * ```
+ *
+ * @public
+ */
+declare type MapListenEventNamesToListenEvents<
+  R extends Record<string, Any> = Record<string, Any>,
+  Events extends ListenEventName[] = ListenEventName[],
+> = Events extends (infer E)[]
+  ? E extends 'welcome'
+    ? WelcomeEvent
+    : E extends 'mutation'
+      ? MutationEvent<R>
+      : E extends 'reconnect'
+        ? ReconnectEvent
+        : E extends 'open'
+          ? OpenEvent
+          : never
+  : never
+
 /** @public */
 export declare type MediaLibraryAssetInstanceIdentifier = string | SanityReference
 

package/dist/stega.d.cts

@@ -2130,22 +2130,41 @@ export declare function _listen<R extends Record<string, Any> = Record<string, A
  * @param options - Optional listener options
  * @public
  */
-export declare function _listen<R extends Record<string, Any> = Record<string, Any>>(
+export declare function _listen<
+  R extends Record<string, Any> = Record<string, Any>,
+  Opts extends ListenOptions = ListenOptions,
+>(
   this: SanityClient | ObservableSanityClient,
   query: string,
   params?: ListenParams,
-  options?: ListenOptions,
-): Observable<ListenEvent<R>>
+  options?: Opts,
+): Observable<ListenEventFromOptions<R, Opts>>
 
 /** @public */
 export declare type ListenEvent<R extends Record<string, Any>> =
   | MutationEvent<R>
-  | ChannelErrorEvent
-  | DisconnectEvent
   | ReconnectEvent
   | WelcomeEvent
   | OpenEvent
 
+/**
+ * Maps a ListenOptions object and returns the Listen events opted for, e.g:
+ * ```
+ * type Test = ListenEventFromOptions<Doc, {events: ['welcome', 'mutation']}>
+ *    // ^? WelcomeEvent | MutationEvent<Doc>
+ * ```
+ *
+ * @public
+ */
+declare type ListenEventFromOptions<
+  R extends Record<string, Any> = Record<string, Any>,
+  Opts extends ListenOptions | undefined = undefined,
+> = Opts extends ListenOptions
+  ? Opts['events'] extends ListenEventName[]
+    ? MapListenEventNamesToListenEvents<R, Opts['events']>
+    : ListenEvent<R>
+  : MutationEvent<R>
+
 /** @public */
 export declare type ListenEventName =
   /** A mutation was performed */
@@ -2154,6 +2173,11 @@ export declare type ListenEventName =
   | 'welcome'
   /** The listener has been disconnected, and a reconnect attempt is scheduled */
   | 'reconnect'
+  /**
+   * The listener connection has been established
+   * note: it's usually a better option to use the 'welcome' event
+   */
+  | 'open'
 
 /** @public */
 export declare interface ListenOptions {
@@ -2295,6 +2319,30 @@ declare type Logger_2 =
       Pick<typeof console, 'debug' | 'error' | 'groupCollapsed' | 'groupEnd' | 'log' | 'table'>
     >
 
+/**
+ * Maps an array of listen events names to their corresponding listen event type, e.g:
+ * ```
+ * type Test = MapListenEventNamesToListenEvents<Doc, ['welcome']>
+ *    // ^? WelcomeEvent
+ * ```
+ *
+ * @public
+ */
+declare type MapListenEventNamesToListenEvents<
+  R extends Record<string, Any> = Record<string, Any>,
+  Events extends ListenEventName[] = ListenEventName[],
+> = Events extends (infer E)[]
+  ? E extends 'welcome'
+    ? WelcomeEvent
+    : E extends 'mutation'
+      ? MutationEvent<R>
+      : E extends 'reconnect'
+        ? ReconnectEvent
+        : E extends 'open'
+          ? OpenEvent
+          : never
+  : never
+
 /** @public */
 export declare type MediaLibraryAssetInstanceIdentifier = string | SanityReference
 

package/dist/stega.d.ts

@@ -2130,22 +2130,41 @@ export declare function _listen<R extends Record<string, Any> = Record<string, A
  * @param options - Optional listener options
  * @public
  */
-export declare function _listen<R extends Record<string, Any> = Record<string, Any>>(
+export declare function _listen<
+  R extends Record<string, Any> = Record<string, Any>,
+  Opts extends ListenOptions = ListenOptions,
+>(
   this: SanityClient | ObservableSanityClient,
   query: string,
   params?: ListenParams,
-  options?: ListenOptions,
-): Observable<ListenEvent<R>>
+  options?: Opts,
+): Observable<ListenEventFromOptions<R, Opts>>
 
 /** @public */
 export declare type ListenEvent<R extends Record<string, Any>> =
   | MutationEvent<R>
-  | ChannelErrorEvent
-  | DisconnectEvent
   | ReconnectEvent
   | WelcomeEvent
   | OpenEvent
 
+/**
+ * Maps a ListenOptions object and returns the Listen events opted for, e.g:
+ * ```
+ * type Test = ListenEventFromOptions<Doc, {events: ['welcome', 'mutation']}>
+ *    // ^? WelcomeEvent | MutationEvent<Doc>
+ * ```
+ *
+ * @public
+ */
+declare type ListenEventFromOptions<
+  R extends Record<string, Any> = Record<string, Any>,
+  Opts extends ListenOptions | undefined = undefined,
+> = Opts extends ListenOptions
+  ? Opts['events'] extends ListenEventName[]
+    ? MapListenEventNamesToListenEvents<R, Opts['events']>
+    : ListenEvent<R>
+  : MutationEvent<R>
+
 /** @public */
 export declare type ListenEventName =
   /** A mutation was performed */
@@ -2154,6 +2173,11 @@ export declare type ListenEventName =
   | 'welcome'
   /** The listener has been disconnected, and a reconnect attempt is scheduled */
   | 'reconnect'
+  /**
+   * The listener connection has been established
+   * note: it's usually a better option to use the 'welcome' event
+   */
+  | 'open'
 
 /** @public */
 export declare interface ListenOptions {
@@ -2295,6 +2319,30 @@ declare type Logger_2 =
       Pick<typeof console, 'debug' | 'error' | 'groupCollapsed' | 'groupEnd' | 'log' | 'table'>
     >
 
+/**
+ * Maps an array of listen events names to their corresponding listen event type, e.g:
+ * ```
+ * type Test = MapListenEventNamesToListenEvents<Doc, ['welcome']>
+ *    // ^? WelcomeEvent
+ * ```
+ *
+ * @public
+ */
+declare type MapListenEventNamesToListenEvents<
+  R extends Record<string, Any> = Record<string, Any>,
+  Events extends ListenEventName[] = ListenEventName[],
+> = Events extends (infer E)[]
+  ? E extends 'welcome'
+    ? WelcomeEvent
+    : E extends 'mutation'
+      ? MutationEvent<R>
+      : E extends 'reconnect'
+        ? ReconnectEvent
+        : E extends 'open'
+          ? OpenEvent
+          : never
+  : never
+
 /** @public */
 export declare type MediaLibraryAssetInstanceIdentifier = string | SanityReference
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "7.12.1",
+  "version": "7.13.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -18,7 +18,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com/sanity-io/client.git"
+    "url": "git+https://github.com/sanity-io/client.git"
   },
   "license": "MIT",
   "author": "Sanity.io <hello@sanity.io>",
@@ -163,6 +163,7 @@
     "msw": "^2.7.3",
     "next": "^15.3.0",
     "nock": "^13.5.6",
+    "pkg-pr-new": "^0.0.60",
     "prettier": "^3.5.3",
     "prettier-plugin-packagejson": "^2.5.10",
     "rimraf": "^5.0.7",

package/src/data/listen.ts

@@ -5,9 +5,13 @@ import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import {
   type Any,
   type ListenEvent,
+  type ListenEventName,
   type ListenOptions,
   type ListenParams,
   type MutationEvent,
+  type OpenEvent,
+  type ReconnectEvent,
+  type WelcomeEvent,
 } from '../types'
 import defaults from '../util/defaults'
 import {pick} from '../util/pick'
@@ -36,6 +40,49 @@ const defaultOptions = {
   includeResult: true,
 }
 
+/**
+ * Maps an array of listen events names to their corresponding listen event type, e.g:
+ * ```
+ * type Test = MapListenEventNamesToListenEvents<Doc, ['welcome']>
+ *    // ^? WelcomeEvent
+ * ```
+ *
+ * @public
+ */
+export type MapListenEventNamesToListenEvents<
+  R extends Record<string, Any> = Record<string, Any>,
+  Events extends ListenEventName[] = ListenEventName[],
+> = Events extends (infer E)[]
+  ? E extends 'welcome'
+    ? WelcomeEvent
+    : E extends 'mutation'
+      ? MutationEvent<R>
+      : E extends 'reconnect'
+        ? ReconnectEvent
+        : E extends 'open'
+          ? OpenEvent
+          : never
+  : never
+
+/**
+ * Maps a ListenOptions object and returns the Listen events opted for, e.g:
+ * ```
+ * type Test = ListenEventFromOptions<Doc, {events: ['welcome', 'mutation']}>
+ *    // ^? WelcomeEvent | MutationEvent<Doc>
+ * ```
+ *
+ * @public
+ */
+export type ListenEventFromOptions<
+  R extends Record<string, Any> = Record<string, Any>,
+  Opts extends ListenOptions | undefined = undefined,
+> = Opts extends ListenOptions
+  ? Opts['events'] extends ListenEventName[]
+    ? MapListenEventNamesToListenEvents<R, Opts['events']>
+    : // fall back to ListenEvent if opts events is present, but we can't infer the literal event names
+      ListenEvent<R>
+  : MutationEvent<R>
+
 /**
  * Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.
  *
@@ -57,19 +104,25 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
  * @param options - Optional listener options
  * @public
  */
-export function _listen<R extends Record<string, Any> = Record<string, Any>>(
+export function _listen<
+  R extends Record<string, Any> = Record<string, Any>,
+  Opts extends ListenOptions = ListenOptions,
+>(
   this: SanityClient | ObservableSanityClient,
   query: string,
   params?: ListenParams,
-  options?: ListenOptions,
-): Observable<ListenEvent<R>>
+  options?: Opts,
+): Observable<ListenEventFromOptions<R, Opts>>
 /** @public */
-export function _listen<R extends Record<string, Any> = Record<string, Any>>(
+export function _listen<
+  R extends Record<string, Any> = Record<string, Any>,
+  Opts extends ListenOptions = ListenOptions,
+>(
   this: SanityClient | ObservableSanityClient,
   query: string,
   params?: ListenParams,
-  opts: ListenOptions = {},
-): Observable<MutationEvent<R> | ListenEvent<R>> {
+  opts: Opts = {} as Opts,
+): Observable<ListenEventFromOptions<R, Opts>> {
   const {url, token, withCredentials, requestTagPrefix, headers: configHeaders} = this.config()
   const tag = opts.tag && requestTagPrefix ? [requestTagPrefix, opts.tag].join('.') : opts.tag
   const options = {...defaults(opts, defaultOptions), tag}
@@ -81,7 +134,7 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
     return throwError(() => new Error('Query too large for listener'))
   }
 
-  const listenFor = options.events ? options.events : ['mutation']
+  const listenFor = (options.events ? options.events : ['mutation']) satisfies Opts['events']
 
   const esOptions: EventSourceInit & {headers?: Record<string, string>} = {}
   if (withCredentials) {
@@ -110,12 +163,9 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
   return connectEventSource(initEventSource, listenFor).pipe(
     reconnectOnConnectionFailure(),
     filter((event) => listenFor.includes(event.type)),
-    map(
-      (event) =>
-        ({
-          type: event.type,
-          ...('data' in event ? (event.data as object) : {}),
-        }) as MutationEvent<R> | ListenEvent<R>,
-    ),
-  )
+    map((event) => ({
+      type: event.type,
+      ...('data' in event ? (event.data as object) : {}),
+    })),
+  ) as Observable<ListenEventFromOptions<R, Opts>>
 }

package/src/types.ts

@@ -1142,8 +1142,6 @@ export type WelcomeEvent = {
 /** @public */
 export type ListenEvent<R extends Record<string, Any>> =
   | MutationEvent<R>
-  | ChannelErrorEvent
-  | DisconnectEvent
   | ReconnectEvent
   | WelcomeEvent
   | OpenEvent
@@ -1156,6 +1154,11 @@ export type ListenEventName =
   | 'welcome'
   /** The listener has been disconnected, and a reconnect attempt is scheduled */
   | 'reconnect'
+  /**
+   * The listener connection has been established
+   * note: it's usually a better option to use the 'welcome' event
+   */
+  | 'open'
 
 /** @public */
 export type ListenParams = {[key: string]: Any}

package/umd/sanityClient.js

@@ -3360,12 +3360,10 @@ ${selectionOpts}`);
     ), listenFor).pipe(
       reconnectOnConnectionFailure(),
       filter((event) => listenFor.includes(event.type)),
-      map(
-        (event) => ({
-          type: event.type,
-          ..."data" in event ? event.data : {}
-        })
-      )
+      map((event) => ({
+        type: event.type,
+        ..."data" in event ? event.data : {}
+      }))
     );
   }
   function shareReplayLatest(configOrPredicate, config) {