@sanity/client 7.12.1 → 7.13.1

package/dist/index.d.cts

@@ -1965,22 +1965,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 */
@@ -1989,6 +2008,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 {
@@ -2123,6 +2147,30 @@ export declare type Logger =
       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/index.d.ts

@@ -1965,22 +1965,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 */
@@ -1989,6 +2008,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 {
@@ -2123,6 +2147,30 @@ export declare type Logger =
       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/index.js

@@ -1217,12 +1217,10 @@ function _listen(query, params, opts = {}) {
   ), 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) {
@@ -2670,7 +2668,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var name = "@sanity/client", version = "7.12.1";
+var name = "@sanity/client", version = "7.13.1";
 const middleware = [
   debug({ verbose: !0, namespace: "sanity:client" }),
   headers({ "User-Agent": `${name} ${version}` }),