@sanity/client 6.17.2 → 6.17.3-canary.0

package/dist/index.browser.d.cts

@@ -775,6 +775,35 @@ export declare type ListenParams = {
   [key: string]: Any
 }
 
+/** @public */
+export declare function _live(
+  this: SanityClient | ObservableSanityClient,
+  opts?: LiveOptions,
+): Observable<LiveChangeEvent | LiveErrorEvent | LiveRestartEvent>
+
+/** @public */
+export declare interface LiveChangeEvent {
+  tags: `s1:${string}`[]
+  pos: string
+}
+
+/** @public */
+export declare interface LiveErrorEvent {
+  type: 'error'
+  status: number
+  message: string
+}
+
+/** @public */
+export declare interface LiveOptions {
+  start?: string
+}
+
+/** @public */
+export declare interface LiveRestartEvent {
+  type: 'restart'
+}
+
 /** @public */
 export declare type Logger =
   | typeof console
@@ -1123,6 +1152,7 @@ export declare class ObservableSanityClient {
    * Instance properties
    */
   listen: typeof _listen
+  live: typeof _live
   constructor(httpRequest: HttpRequest, config?: ClientConfig)
   /**
    * Clone the client - returns a new instance
@@ -1831,6 +1861,7 @@ export declare interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
+  syncTags?: `s1:${string}`[]
 }
 
 /** @internal */
@@ -1943,6 +1974,7 @@ export declare class SanityClient {
    * Instance properties
    */
   listen: typeof _listen
+  live: typeof _live
   constructor(httpRequest: HttpRequest, config?: ClientConfig)
   /**
    * Clone the client - returns a new instance

package/dist/index.browser.d.ts

@@ -775,6 +775,35 @@ export declare type ListenParams = {
   [key: string]: Any
 }
 
+/** @public */
+export declare function _live(
+  this: SanityClient | ObservableSanityClient,
+  opts?: LiveOptions,
+): Observable<LiveChangeEvent | LiveErrorEvent | LiveRestartEvent>
+
+/** @public */
+export declare interface LiveChangeEvent {
+  tags: `s1:${string}`[]
+  pos: string
+}
+
+/** @public */
+export declare interface LiveErrorEvent {
+  type: 'error'
+  status: number
+  message: string
+}
+
+/** @public */
+export declare interface LiveOptions {
+  start?: string
+}
+
+/** @public */
+export declare interface LiveRestartEvent {
+  type: 'restart'
+}
+
 /** @public */
 export declare type Logger =
   | typeof console
@@ -1123,6 +1152,7 @@ export declare class ObservableSanityClient {
    * Instance properties
    */
   listen: typeof _listen
+  live: typeof _live
   constructor(httpRequest: HttpRequest, config?: ClientConfig)
   /**
    * Clone the client - returns a new instance
@@ -1831,6 +1861,7 @@ export declare interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
+  syncTags?: `s1:${string}`[]
 }
 
 /** @internal */
@@ -1943,6 +1974,7 @@ export declare class SanityClient {
    * Instance properties
    */
   listen: typeof _listen
+  live: typeof _live
   constructor(httpRequest: HttpRequest, config?: ClientConfig)
   /**
    * Clone the client - returns a new instance

package/dist/index.browser.js

@@ -914,6 +914,57 @@ function cooerceError(err) {
 function extractErrorMessage(err) {
   return err.error ? err.error.description ? err.error.description : typeof err.error == "string" ? err.error : JSON.stringify(err.error, null, 2) : err.message || "Unknown listener error";
 }
+function _live(opts = {}) {
+  const path = _getDataUrl(this, "sync-tags"), url = new URL(this.getUrl(path, !1));
+  return opts.start && url.searchParams.append("start", opts.start), new Observable((observer) => {
+    const controller = new AbortController(), { signal } = controller;
+    return fetch(url, { signal }).then(async (res) => {
+      if (!res.body)
+        throw new TypeError("Response body is not readable");
+      const reader = res.body.pipeThrough(new TextDecoderStream()).pipeThrough(splitStream(`
+`)).pipeThrough(parseJSON()).getReader(), results = {
+        [Symbol.asyncIterator]() {
+          return {
+            next: () => reader.read()
+          };
+        }
+      };
+      for await (const chunk of results) {
+        if (signal.aborted)
+          break;
+        if (chunk.type === "error") {
+          observer.error(chunk);
+          break;
+        }
+        observer.next(chunk);
+      }
+    }).catch((err) => {
+      (err == null ? void 0 : err.name) !== "TimeoutError" && (err == null ? void 0 : err.name) !== "AbortError" && observer.error(err);
+    }), () => {
+      controller.abort();
+    };
+  });
+}
+function splitStream(splitOn) {
+  let buffer = "";
+  return new TransformStream({
+    transform(chunk, controller) {
+      buffer += chunk;
+      const parts = buffer.split(splitOn);
+      parts.slice(0, -1).forEach((part) => controller.enqueue(part)), buffer = parts[parts.length - 1];
+    },
+    flush(controller) {
+      buffer && controller.enqueue(buffer);
+    }
+  });
+}
+function parseJSON() {
+  return new TransformStream({
+    transform(chunk, controller) {
+      chunk && controller.enqueue(JSON.parse(chunk));
+    }
+  });
+}
 var __accessCheck$3 = (obj, member, msg) => {
   if (!member.has(obj))
     throw TypeError("Cannot " + msg);
@@ -1118,7 +1169,7 @@ var __defProp = Object.defineProperty, __defNormalProp = (obj, key, value) => ke
 }, __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), member.set(obj, value), value), _clientConfig, _httpRequest;
 const _ObservableSanityClient = class _ObservableSanityClient2 {
   constructor(httpRequest, config = defaultConfig) {
-    __publicField(this, "assets"), __publicField(this, "datasets"), __publicField(this, "projects"), __publicField(this, "users"), __privateAdd(this, _clientConfig, void 0), __privateAdd(this, _httpRequest, void 0), __publicField(this, "listen", _listen), this.config(config), __privateSet(this, _httpRequest, httpRequest), this.assets = new ObservableAssetsClient(this, __privateGet(this, _httpRequest)), this.datasets = new ObservableDatasetsClient(this, __privateGet(this, _httpRequest)), this.projects = new ObservableProjectsClient(this, __privateGet(this, _httpRequest)), this.users = new ObservableUsersClient(this, __privateGet(this, _httpRequest));
+    __publicField(this, "assets"), __publicField(this, "datasets"), __publicField(this, "projects"), __publicField(this, "users"), __privateAdd(this, _clientConfig, void 0), __privateAdd(this, _httpRequest, void 0), __publicField(this, "listen", _listen), __publicField(this, "live", _live), this.config(config), __privateSet(this, _httpRequest, httpRequest), this.assets = new ObservableAssetsClient(this, __privateGet(this, _httpRequest)), this.datasets = new ObservableDatasetsClient(this, __privateGet(this, _httpRequest)), this.projects = new ObservableProjectsClient(this, __privateGet(this, _httpRequest)), this.users = new ObservableUsersClient(this, __privateGet(this, _httpRequest));
   }
   /**
    * Clone the client - returns a new instance
@@ -1247,7 +1298,7 @@ let ObservableSanityClient = _ObservableSanityClient;
 var _clientConfig2, _httpRequest2;
 const _SanityClient = class _SanityClient2 {
   constructor(httpRequest, config = defaultConfig) {
-    __publicField(this, "assets"), __publicField(this, "datasets"), __publicField(this, "projects"), __publicField(this, "users"), __publicField(this, "observable"), __privateAdd(this, _clientConfig2, void 0), __privateAdd(this, _httpRequest2, void 0), __publicField(this, "listen", _listen), this.config(config), __privateSet(this, _httpRequest2, httpRequest), this.assets = new AssetsClient(this, __privateGet(this, _httpRequest2)), this.datasets = new DatasetsClient(this, __privateGet(this, _httpRequest2)), this.projects = new ProjectsClient(this, __privateGet(this, _httpRequest2)), this.users = new UsersClient(this, __privateGet(this, _httpRequest2)), this.observable = new ObservableSanityClient(httpRequest, config);
+    __publicField(this, "assets"), __publicField(this, "datasets"), __publicField(this, "projects"), __publicField(this, "users"), __publicField(this, "observable"), __privateAdd(this, _clientConfig2, void 0), __privateAdd(this, _httpRequest2, void 0), __publicField(this, "listen", _listen), __publicField(this, "live", _live), this.config(config), __privateSet(this, _httpRequest2, httpRequest), this.assets = new AssetsClient(this, __privateGet(this, _httpRequest2)), this.datasets = new DatasetsClient(this, __privateGet(this, _httpRequest2)), this.projects = new ProjectsClient(this, __privateGet(this, _httpRequest2)), this.users = new UsersClient(this, __privateGet(this, _httpRequest2)), this.observable = new ObservableSanityClient(httpRequest, config);
   }
   /**
    * Clone the client - returns a new instance