@sanity/client 6.19.0 → 6.20.0-canary.0

package/dist/index.browser.d.cts

@@ -598,7 +598,7 @@ export declare type DeleteAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -623,7 +623,7 @@ export declare type DiscardAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -899,22 +899,25 @@ export declare type ListenParams = {
 }
 
 /**
- * @alpha this API is experimental and may change or even be removed
+ * @public
  */
 export declare class LiveClient {
   #private
   constructor(client: SanityClient | ObservableSanityClient)
+  /**
+   * Requires `apiVersion` to be `2021-03-26` or later.
+   */
   events(): Observable<LiveEventMessage | LiveEventRestart>
 }
 
-/** @alpha this API is experimental and may change or even be removed */
+/** @public */
 export declare interface LiveEventMessage {
   type: 'message'
   id: string
   tags: SyncTag[]
 }
 
-/** @alpha this API is experimental and may change or even be removed */
+/** @public */
 export declare interface LiveEventRestart {
   type: 'restart'
 }
@@ -1951,7 +1954,7 @@ export declare type PublishAction = {
   /**
    * Draft revision ID to match
    */
-  ifDraftRevisionId: string
+  ifDraftRevisionId?: string
   /**
    * Published document ID to replace
    */
@@ -1959,7 +1962,7 @@ export declare type PublishAction = {
   /**
    * Published revision ID to match
    */
-  ifPublishedRevisionId: string
+  ifPublishedRevisionId?: string
 }
 
 /** @public */
@@ -2022,7 +2025,7 @@ export declare interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
-  /** @alpha this API is experimental and may change or even be removed */
+  /** Requires `apiVersion` to be `2021-03-26` or later. */
   syncTags?: SyncTag[]
 }
 
@@ -2065,10 +2068,6 @@ export declare type ReconnectEvent = {
  */
 export declare type ReplaceDraftAction = {
   actionType: 'sanity.action.document.replaceDraft'
-  /**
-   * Draft document ID to replace, if it exists.
-   */
-  draftId: string
   /**
    * Published document ID to create draft from, if draft does not exist
    */
@@ -2092,7 +2091,6 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
-  /** @alpha this API is experimental and may change or even be removed */
   lastLiveEventId?: string
 }
 
@@ -2130,7 +2128,6 @@ export declare interface ResponseQueryOptions extends RequestOptions {
   stega?: boolean | StegaConfig
   cache?: 'next' extends keyof RequestInit ? RequestInit['cache'] : never
   next?: ('next' extends keyof RequestInit ? RequestInit : never)['next']
-  /** @alpha this API is experimental and may change or even be removed */
   lastLiveEventId?: string | string[] | null
 }
 
@@ -2831,7 +2828,7 @@ export {StudioBaseUrl}
 
 export {StudioUrl}
 
-/** @alpha this API is experimental and may change or even be removed */
+/** @public */
 export declare type SyncTag = `s1:${string}`
 
 /** @public */

package/dist/index.browser.d.ts

@@ -598,7 +598,7 @@ export declare type DeleteAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -623,7 +623,7 @@ export declare type DiscardAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -899,22 +899,25 @@ export declare type ListenParams = {
 }
 
 /**
- * @alpha this API is experimental and may change or even be removed
+ * @public
  */
 export declare class LiveClient {
   #private
   constructor(client: SanityClient | ObservableSanityClient)
+  /**
+   * Requires `apiVersion` to be `2021-03-26` or later.
+   */
   events(): Observable<LiveEventMessage | LiveEventRestart>
 }
 
-/** @alpha this API is experimental and may change or even be removed */
+/** @public */
 export declare interface LiveEventMessage {
   type: 'message'
   id: string
   tags: SyncTag[]
 }
 
-/** @alpha this API is experimental and may change or even be removed */
+/** @public */
 export declare interface LiveEventRestart {
   type: 'restart'
 }
@@ -1951,7 +1954,7 @@ export declare type PublishAction = {
   /**
    * Draft revision ID to match
    */
-  ifDraftRevisionId: string
+  ifDraftRevisionId?: string
   /**
    * Published document ID to replace
    */
@@ -1959,7 +1962,7 @@ export declare type PublishAction = {
   /**
    * Published revision ID to match
    */
-  ifPublishedRevisionId: string
+  ifPublishedRevisionId?: string
 }
 
 /** @public */
@@ -2022,7 +2025,7 @@ export declare interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
-  /** @alpha this API is experimental and may change or even be removed */
+  /** Requires `apiVersion` to be `2021-03-26` or later. */
   syncTags?: SyncTag[]
 }
 
@@ -2065,10 +2068,6 @@ export declare type ReconnectEvent = {
  */
 export declare type ReplaceDraftAction = {
   actionType: 'sanity.action.document.replaceDraft'
-  /**
-   * Draft document ID to replace, if it exists.
-   */
-  draftId: string
   /**
    * Published document ID to create draft from, if draft does not exist
    */
@@ -2092,7 +2091,6 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
-  /** @alpha this API is experimental and may change or even be removed */
   lastLiveEventId?: string
 }
 
@@ -2130,7 +2128,6 @@ export declare interface ResponseQueryOptions extends RequestOptions {
   stega?: boolean | StegaConfig
   cache?: 'next' extends keyof RequestInit ? RequestInit['cache'] : never
   next?: ('next' extends keyof RequestInit ? RequestInit : never)['next']
-  /** @alpha this API is experimental and may change or even be removed */
   lastLiveEventId?: string | string[] | null
 }
 
@@ -2831,7 +2828,7 @@ export {StudioBaseUrl}
 
 export {StudioUrl}
 
-/** @alpha this API is experimental and may change or even be removed */
+/** @public */
 export declare type SyncTag = `s1:${string}`
 
 /** @public */

package/dist/index.browser.js

@@ -935,12 +935,22 @@ var __accessCheck$4 = (obj, member, msg) => {
   if (member.has(obj))
     throw TypeError("Cannot add the same private member more than once");
   member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-}, __privateSet$4 = (obj, member, value, setter) => (__accessCheck$4(obj, member, "write to private field"), member.set(obj, value), value), _client$3;
+}, __privateSet$4 = (obj, member, value, setter) => (__accessCheck$4(obj, member, "write to private field"), member.set(obj, value), value);
+const requiredApiVersion = "2021-03-26";
+var _client$3;
 class LiveClient {
   constructor(client) {
     __privateAdd$4(this, _client$3, void 0), __privateSet$4(this, _client$3, client);
   }
+  /**
+   * Requires `apiVersion` to be `2021-03-26` or later.
+   */
   events() {
+    const apiVersion = __privateGet$4(this, _client$3).config().apiVersion.replace(/^v/, "");
+    if (apiVersion !== "X" && apiVersion < requiredApiVersion)
+      throw new Error(
+        `The live events API requires API version ${requiredApiVersion} or later. The current API version is ${apiVersion}. Please update your API version to use this feature.`
+      );
     const path = _getDataUrl(__privateGet$4(this, _client$3), "live/events"), url = new URL(__privateGet$4(this, _client$3).getUrl(path, !1)), listenFor = ["restart", "message"];
     return new Observable((observer) => {
       let es, reconnectTimer, stopped = !1, unsubscribed = !1;