@sanity/client 6.17.2 → 6.17.3-canary.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.17.2",
+  "version": "6.17.3-canary.1",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",

package/src/SanityClient.ts

@@ -4,6 +4,7 @@ import {AssetsClient, ObservableAssetsClient} from './assets/AssetsClient'
 import {defaultConfig, initConfig} from './config'
 import * as dataMethods from './data/dataMethods'
 import {_listen} from './data/listen'
+import {_live} from './data/live'
 import {ObservablePatch, Patch} from './data/patch'
 import {ObservableTransaction, Transaction} from './data/transaction'
 import {DatasetsClient, ObservableDatasetsClient} from './datasets/DatasetsClient'
@@ -41,6 +42,7 @@ import {ObservableUsersClient, UsersClient} from './users/UsersClient'
 
 export type {
   _listen,
+  _live,
   AssetsClient,
   DatasetsClient,
   ObservableAssetsClient,
@@ -68,6 +70,7 @@ export class ObservableSanityClient {
    * Instance properties
    */
   listen = _listen
+  live = _live
 
   constructor(httpRequest: HttpRequest, config: ClientConfig = defaultConfig) {
     this.config(config)
@@ -713,6 +716,7 @@ export class SanityClient {
    * Instance properties
    */
   listen = _listen
+  live = _live
 
   constructor(httpRequest: HttpRequest, config: ClientConfig = defaultConfig) {
     this.config(config)

package/src/data/dataMethods.ts

@@ -67,9 +67,11 @@ export function _fetch<R, Q>(
   httpRequest: HttpRequest,
   _stega: InitializedStegaConfig,
   query: string,
-  _params: Q = {} as Q,
+  __params: Q = {} as Q,
   options: QueryOptions = {},
 ): Observable<RawQueryResponse<R> | R> {
+  const _params = options.refresh ? {...__params, _: options.refresh} : __params
+
   const stega =
     'stega' in options
       ? {

package/src/data/live.ts

@@ -0,0 +1,83 @@
+import {Observable} from 'rxjs'
+
+import type {ObservableSanityClient, SanityClient} from '../SanityClient'
+import type {LiveChangeEvent, LiveErrorEvent, LiveOptions, LiveRestartEvent} from '../types'
+import {_getDataUrl} from './dataMethods'
+
+/** @public */
+export function _live(
+  this: SanityClient | ObservableSanityClient,
+  opts: LiveOptions = {},
+): Observable<LiveChangeEvent | LiveErrorEvent | LiveRestartEvent> {
+  const path = _getDataUrl(this, 'sync-tags')
+  const url = new URL(this.getUrl(path, false))
+  if (opts.start) {
+    url.searchParams.append('start', opts.start)
+  }
+
+  return new Observable((observer) => {
+    const controller = new AbortController()
+    const {signal} = controller
+    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('\n'))
+          .pipeThrough(parseJSON())
+          .getReader()
+
+        const 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) => {
+        if (err?.name !== 'TimeoutError' && err?.name !== 'AbortError') {
+          observer.error(err)
+        }
+      })
+    return () => {
+      controller.abort()
+    }
+  })
+}
+
+function splitStream(splitOn: string) {
+  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) {
+      if (buffer) controller.enqueue(buffer)
+    },
+  })
+}
+
+function parseJSON() {
+  return new TransformStream({
+    transform(chunk, controller) {
+      if (!chunk) return
+      controller.enqueue(JSON.parse(chunk))
+    },
+  })
+}

package/src/types.ts

@@ -479,6 +479,8 @@ export interface QueryParams {
   token?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   useCdn?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  refresh?: never
   /* eslint-enable @typescript-eslint/no-explicit-any */
 }
 
@@ -743,6 +745,7 @@ export interface ResponseQueryOptions extends RequestOptions {
   // The `cache` and `next` options are specific to the Next.js App Router integration
   cache?: 'next' extends keyof RequestInit ? RequestInit['cache'] : never
   next?: ('next' extends keyof RequestInit ? RequestInit : never)['next']
+  refresh?: string
 }
 
 /** @public */
@@ -785,6 +788,7 @@ export interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
+  syncTags?: `s1:${string}`[]
 }
 
 /** @public */
@@ -999,6 +1003,26 @@ export interface ContentSourceMap {
   paths: ContentSourceMapPaths
 }
 
+/** @public */
+export interface LiveOptions {
+  start?: string
+}
+/** @public */
+export interface LiveErrorEvent {
+  type: 'error'
+  status: number
+  message: string
+}
+/** @public */
+export interface LiveRestartEvent {
+  type: 'restart'
+}
+/** @public */
+export interface LiveChangeEvent {
+  tags: `s1:${string}`[]
+  pos: string
+}
+
 export type {
   ContentSourceMapParsedPath,
   ContentSourceMapParsedPathKeyedSegment,

package/umd/sanityClient.js

@@ -2415,8 +2415,8 @@ ${selectionOpts}`);
     autoGenerateArrayKeys: options.autoGenerateArrayKeys,
     skipCrossDatasetReferenceValidation: options.skipCrossDatasetReferenceValidation
   }), isResponse = (event) => event.type === "response", getBody = (event) => event.body, indexBy = (docs, attr) => docs.reduce((indexed, doc) => (indexed[attr(doc)] = doc, indexed), /* @__PURE__ */ Object.create(null)), getQuerySizeLimit = 11264;
-  function _fetch(client, httpRequest, _stega, query, _params = {}, options = {}) {
-    const stega = "stega" in options ? {
+  function _fetch(client, httpRequest, _stega, query, __params = {}, options = {}) {
+    const _params = options.refresh ? { ...__params, _: options.refresh } : __params, stega = "stega" in options ? {
       ..._stega || {},
       ...typeof options.stega == "boolean" ? { enabled: options.stega } : options.stega || {}
     } : _stega, params = stega.enabled ? stegaClean(_params) : _params, mapResponse = options.filterResponse === !1 ? (res) => res : (res) => res.result, { cache, next, ...opts } = {
@@ -2726,6 +2726,57 @@ ${selectionOpts}`);
   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);
@@ -2930,7 +2981,7 @@ ${selectionOpts}`);
   }, __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
@@ -3059,7 +3110,7 @@ ${selectionOpts}`);
   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