@sanity/client 6.27.1 → 6.27.2-canary.0

package/dist/index.d.cts

@@ -993,13 +993,12 @@ export declare class LiveClient {
   #private
   constructor(client: SanityClient | ObservableSanityClient)
   /**
-   * Requires `apiVersion` to be `2021-03-26` or later.
+   * Requires `apiVersion` to be `2021-03-25` or later.
    */
   events({
     includeDrafts,
     tag: _tag,
   }?: {
-    /** @alpha this API is experimental and may change or even be removed */
     includeDrafts?: boolean
     /**
      * Optional request tag for the listener. Use to identify the request in logs.
@@ -1007,9 +1006,16 @@ export declare class LiveClient {
      * @defaultValue `undefined`
      */
     tag?: string
-  }): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome>
+  }): Observable<LiveEvent>
 }
 
+/** @public */
+export declare type LiveEvent =
+  | LiveEventRestart
+  | LiveEventReconnect
+  | LiveEventMessage
+  | LiveEventWelcome
+
 /** @public */
 export declare interface LiveEventMessage {
   type: 'message'
@@ -2177,7 +2183,7 @@ export declare interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
-  /** Requires `apiVersion` to be `2021-03-26` or later. */
+  /** Requires `apiVersion` to be `2021-03-25` or later. */
   syncTags?: SyncTag[]
 }
 

package/dist/index.d.ts

@@ -993,13 +993,12 @@ export declare class LiveClient {
   #private
   constructor(client: SanityClient | ObservableSanityClient)
   /**
-   * Requires `apiVersion` to be `2021-03-26` or later.
+   * Requires `apiVersion` to be `2021-03-25` or later.
    */
   events({
     includeDrafts,
     tag: _tag,
   }?: {
-    /** @alpha this API is experimental and may change or even be removed */
     includeDrafts?: boolean
     /**
      * Optional request tag for the listener. Use to identify the request in logs.
@@ -1007,9 +1006,16 @@ export declare class LiveClient {
      * @defaultValue `undefined`
      */
     tag?: string
-  }): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome>
+  }): Observable<LiveEvent>
 }
 
+/** @public */
+export declare type LiveEvent =
+  | LiveEventRestart
+  | LiveEventReconnect
+  | LiveEventMessage
+  | LiveEventWelcome
+
 /** @public */
 export declare interface LiveEventMessage {
   type: 'message'
@@ -2177,7 +2183,7 @@ export declare interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
-  /** Requires `apiVersion` to be `2021-03-26` or later. */
+  /** Requires `apiVersion` to be `2021-03-25` or later. */
   syncTags?: SyncTag[]
 }
 

package/dist/index.js

@@ -879,14 +879,14 @@ function _listen(query, params, opts = {}) {
     )
   );
 }
-const requiredApiVersion = "2021-03-26";
+const requiredApiVersion = "2021-03-25";
 class LiveClient {
   #client;
   constructor(client) {
     this.#client = client;
   }
   /**
-   * Requires `apiVersion` to be `2021-03-26` or later.
+   * Requires `apiVersion` to be `2021-03-25` or later.
    */
   events({
     includeDrafts = !1,
@@ -907,10 +907,6 @@ class LiveClient {
       throw new Error(
         "The live events API requires a token or withCredentials when 'includeDrafts: true'. Please update your client configuration. The token should have the lowest possible access role."
       );
-    if (includeDrafts && apiVersion !== "X")
-      throw new Error(
-        "The live events API requires API version X when 'includeDrafts: true'. This API is experimental and may change or even be removed."
-      );
     const path = _getDataUrl(this.#client, "live/events"), url = new URL(this.#client.getUrl(path, !1)), tag = _tag && requestTagPrefix ? [requestTagPrefix, _tag].join(".") : _tag;
     tag && url.searchParams.set("tag", tag), includeDrafts && url.searchParams.set("includeDrafts", "true");
     const esOptions = {};
@@ -1479,7 +1475,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var name = "@sanity/client", version = "6.27.1";
+var name = "@sanity/client", version = "6.27.2-canary.0";
 const middleware = [
   debug({ verbose: !0, namespace: "sanity:client" }),
   headers({ "User-Agent": `${name} ${version}` }),