@sanity/client 7.22.1 → 7.23.1

package/dist/index.browser.d.cts

@@ -914,11 +914,26 @@ export declare function connectEventSource<EventName extends string>(
 
 /**
  * @public
- * Thrown if the EventSource connection could not be established.
- * Note that ConnectionFailedErrors are rare, and disconnects will normally be handled by the EventSource instance itself and emitted as `reconnect` events.
+ * Thrown when the EventSource connection could not be established, or was rejected by the server.
+ * Transient failures (network drops, 5xx, 408, 429) are reconnected internally and emitted as
+ * `reconnect` events; a permanent rejection (any other 4xx, eg an expired token) errors the
+ * stream with this class so consumers can react — check `status` for the rejection code.
  */
 export declare class ConnectionFailedError extends Error {
   readonly name = 'ConnectionFailedError'
+  /**
+   * HTTP status code of the rejected connection attempt, if known.
+   * Only set when the EventSource implementation exposes it — the polyfill used in
+   * Node.js and when custom headers (eg authorization) are required does, while
+   * native EventSource implementations (browser and Node.js) do not.
+   */
+  readonly status?: number
+  constructor(
+    message?: string,
+    options?: ErrorOptions & {
+      status?: number
+    },
+  )
 }
 
 /**
@@ -3199,6 +3214,20 @@ export declare class ObservableSanityClient {
       tag?: string
     },
   ): Observable<(SanityDocument<R> | null)[]>
+  /**
+   * Convenient and bandwidth efficient method of checking wether a set of document IDs exists.
+   * Returns a set of the IDs that exist.
+   *
+   * @param ids - Document IDs to check
+   * @param options - Request options
+   */
+  documentsExists(
+    ids: string[],
+    options?: {
+      signal?: AbortSignal
+      tag?: string
+    },
+  ): Observable<Set<string>>
   /**
    * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
    * Returns an observable that resolves to the created document.
@@ -5110,6 +5139,20 @@ export declare class SanityClient {
       tag?: string
     },
   ): Promise<(SanityDocument<R> | null)[]>
+  /**
+   * Convenient and bandwidth efficient method of checking wether a set of document IDs exists.
+   * Returns a set of the IDs that exist.
+   *
+   * @param ids - Document IDs to check
+   * @param options - Request options
+   */
+  documentsExists(
+    ids: string[],
+    options?: {
+      signal?: AbortSignal
+      tag?: string
+    },
+  ): Promise<Set<string>>
   /**
    * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
    * Returns a promise that resolves to the created document.

package/dist/index.browser.d.ts

@@ -914,11 +914,26 @@ export declare function connectEventSource<EventName extends string>(
 
 /**
  * @public
- * Thrown if the EventSource connection could not be established.
- * Note that ConnectionFailedErrors are rare, and disconnects will normally be handled by the EventSource instance itself and emitted as `reconnect` events.
+ * Thrown when the EventSource connection could not be established, or was rejected by the server.
+ * Transient failures (network drops, 5xx, 408, 429) are reconnected internally and emitted as
+ * `reconnect` events; a permanent rejection (any other 4xx, eg an expired token) errors the
+ * stream with this class so consumers can react — check `status` for the rejection code.
  */
 export declare class ConnectionFailedError extends Error {
   readonly name = 'ConnectionFailedError'
+  /**
+   * HTTP status code of the rejected connection attempt, if known.
+   * Only set when the EventSource implementation exposes it — the polyfill used in
+   * Node.js and when custom headers (eg authorization) are required does, while
+   * native EventSource implementations (browser and Node.js) do not.
+   */
+  readonly status?: number
+  constructor(
+    message?: string,
+    options?: ErrorOptions & {
+      status?: number
+    },
+  )
 }
 
 /**
@@ -3199,6 +3214,20 @@ export declare class ObservableSanityClient {
       tag?: string
     },
   ): Observable<(SanityDocument<R> | null)[]>
+  /**
+   * Convenient and bandwidth efficient method of checking wether a set of document IDs exists.
+   * Returns a set of the IDs that exist.
+   *
+   * @param ids - Document IDs to check
+   * @param options - Request options
+   */
+  documentsExists(
+    ids: string[],
+    options?: {
+      signal?: AbortSignal
+      tag?: string
+    },
+  ): Observable<Set<string>>
   /**
    * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
    * Returns an observable that resolves to the created document.
@@ -5110,6 +5139,20 @@ export declare class SanityClient {
       tag?: string
     },
   ): Promise<(SanityDocument<R> | null)[]>
+  /**
+   * Convenient and bandwidth efficient method of checking wether a set of document IDs exists.
+   * Returns a set of the IDs that exist.
+   *
+   * @param ids - Document IDs to check
+   * @param options - Request options
+   */
+  documentsExists(
+    ids: string[],
+    options?: {
+      signal?: AbortSignal
+      tag?: string
+    },
+  ): Promise<Set<string>>
   /**
    * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
    * Returns a promise that resolves to the created document.

package/dist/index.browser.js

@@ -3,7 +3,7 @@ import { adapter, environment } from "get-it";
 import { retry, jsonRequest, jsonResponse, progress, observable } from "get-it/middleware";
 import { Observable, defer, isObservable, of, mergeMap, from, lastValueFrom, shareReplay, catchError, concat, timer, throwError, tap, finalize, share, merge, map as map$1, firstValueFrom } from "rxjs";
 import { isRecord, stegaClean } from "./_chunks-es/stegaClean.js";
-import { combineLatestWith, map, filter, finalize as finalize$1 } from "rxjs/operators";
+import { combineLatestWith, map, filter, concatMap, reduce, finalize as finalize$1 } from "rxjs/operators";
 import { getVersionFromId, isDraftId, getVersionId, getDraftId, isVersionId, getPublishedId } from "@sanity/client/csm";
 import { customAlphabet } from "nanoid";
 const NEWLINE = /\r\n|[\n\r\u2028\u2029]/;
@@ -405,6 +405,17 @@ const initConfig = (config, prevConfig) => {
 };
 class ConnectionFailedError extends Error {
   name = "ConnectionFailedError";
+  /**
+   * HTTP status code of the rejected connection attempt, if known.
+   * Only set when the EventSource implementation exposes it — the polyfill used in
+   * Node.js and when custom headers (eg authorization) are required does, while
+   * native EventSource implementations (browser and Node.js) do not.
+   */
+  status;
+  constructor(message, options = {}) {
+    const { status, ...errorOptions } = options;
+    super(message, errorOptions), this.status = status;
+  }
 }
 class DisconnectError extends Error {
   name = "DisconnectError";
@@ -448,6 +459,11 @@ function connectWithESInstance(es, events) {
         );
         return;
       }
+      const rawStatus = evt.status, status = typeof rawStatus == "number" ? rawStatus : void 0;
+      if (status !== void 0) {
+        observer.error(new ConnectionFailedError("EventSource connection failed", { status }));
+        return;
+      }
       es.readyState === es.CLOSED ? observer.error(new ConnectionFailedError("EventSource connection failed")) : emitReconnect && observer.next({ type: "reconnect" });
     }
     function onOpen() {
@@ -965,6 +981,35 @@ function _getDocuments(client, httpRequest, ids, opts = {}) {
     })
   );
 }
+const DOCUMENTS_EXISTS_BATCH_SIZE = 100;
+function _documentsExists(client, httpRequest, ids, opts = {}) {
+  if (ids.length === 0)
+    return of(/* @__PURE__ */ new Set());
+  const batches = [];
+  for (let i = 0; i < ids.length; i += DOCUMENTS_EXISTS_BATCH_SIZE)
+    batches.push(ids.slice(i, i + DOCUMENTS_EXISTS_BATCH_SIZE));
+  const fetchBatch = (batchIds) => _requestObservable(client, httpRequest, {
+    uri: _getDataUrl(client, "doc", batchIds.map(encodeURIComponent).join(",")),
+    tag: opts.tag,
+    signal: opts.signal,
+    query: { excludeContent: !0 }
+  }).pipe(
+    filter(isResponse),
+    map((event) => {
+      const missing = /* @__PURE__ */ new Set();
+      for (const omitted of event.body.omitted || [])
+        omitted.reason === "existence" && missing.add(omitted.id);
+      return new Set(batchIds.filter((id) => !missing.has(id)));
+    })
+  );
+  return from(batches).pipe(
+    concatMap(fetchBatch),
+    reduce((acc, set) => {
+      for (const id of set) acc.add(id);
+      return acc;
+    }, /* @__PURE__ */ new Set())
+  );
+}
 function _getReleaseDocuments(client, httpRequest, releaseId, opts = {}) {
   return _dataRequest(
     client,
@@ -1101,7 +1146,7 @@ const hasDataConfig = (client) => {
   return config.dataset !== void 0 && config.projectId !== void 0 || config.resource !== void 0;
 }, isQuery = (client, uri) => hasDataConfig(client) && uri.startsWith(_getDataUrl(client, "query")), isMutate = (client, uri) => hasDataConfig(client) && uri.startsWith(_getDataUrl(client, "mutate")), isDoc = (client, uri) => hasDataConfig(client) && uri.startsWith(_getDataUrl(client, "doc", "")), isListener = (client, uri) => hasDataConfig(client) && uri.startsWith(_getDataUrl(client, "listen")), isHistory = (client, uri) => hasDataConfig(client) && uri.startsWith(_getDataUrl(client, "history", "")), isData = (client, uri) => uri.startsWith("/data/") || isQuery(client, uri) || isMutate(client, uri) || isDoc(client, uri) || isListener(client, uri) || isHistory(client, uri);
 function _requestObservable(client, httpRequest, options) {
-  const uri = options.url || options.uri, config = client.config(), canUseCdn = typeof options.canUseCdn > "u" ? ["GET", "HEAD"].indexOf(options.method || "GET") >= 0 && isData(client, uri) : options.canUseCdn;
+  const callSiteStack = new Error(), uri = options.url || options.uri, config = client.config(), canUseCdn = typeof options.canUseCdn > "u" ? ["GET", "HEAD"].indexOf(options.method || "GET") >= 0 && isData(client, uri) : options.canUseCdn;
   let useCdn = (options.useCdn ?? config.useCdn) && canUseCdn;
   const tag = options.tag && config.requestTagPrefix ? [config.requestTagPrefix, options.tag].join(".") : options.tag || config.requestTagPrefix;
   if (tag && options.tag !== null && (options.query = { tag: requestTag(tag), ...options.query }), ["GET", "HEAD", "POST"].indexOf(options.method || "GET") >= 0 && isQuery(client, uri)) {
@@ -1117,7 +1162,8 @@ function _requestObservable(client, httpRequest, options) {
   const reqOptions = requestOptions(
     config,
     Object.assign({}, options, {
-      url: _getUrl(client, uri, useCdn)
+      url: _getUrl(client, uri, useCdn),
+      callSiteStack
     })
   ), request = new Observable(
     (subscriber) => httpRequest(reqOptions, config.requester).subscribe(subscriber)
@@ -1387,11 +1433,11 @@ var defaults = (obj, defaults2) => Object.keys(defaults2).concat(Object.keys(obj
 const pick = (obj, props) => props.reduce((selection, prop) => (typeof obj[prop] > "u" || (selection[prop] = obj[prop]), selection), {}), eventSourcePolyfill = defer(() => import("@sanity/eventsource")).pipe(
   map(({ default: EventSource2 }) => EventSource2),
   shareReplay(1)
-);
+), RETRYABLE_STATUSES = /* @__PURE__ */ new Set([408, 429]);
 function reconnectOnConnectionFailure() {
   return function(source) {
     return source.pipe(
-      catchError((err, caught) => err instanceof ConnectionFailedError ? concat(of({ type: "reconnect" }), timer(1e3).pipe(mergeMap(() => caught))) : throwError(() => err))
+      catchError((err, caught) => err instanceof ConnectionFailedError && (typeof err.status != "number" || err.status < 400 || err.status >= 500 || RETRYABLE_STATUSES.has(err.status)) ? concat(of({ type: "reconnect" }), timer(1e3).pipe(mergeMap(() => caught))) : throwError(() => err))
     );
   };
 }
@@ -2471,6 +2517,16 @@ class ObservableSanityClient {
   getDocuments(ids, options) {
     return _getDocuments(this, this.#httpRequest, ids, options);
   }
+  /**
+   * Convenient and bandwidth efficient method of checking wether a set of document IDs exists.
+   * Returns a set of the IDs that exist.
+   *
+   * @param ids - Document IDs to check
+   * @param options - Request options
+   */
+  documentsExists(ids, options) {
+    return _documentsExists(this, this.#httpRequest, ids, options);
+  }
   create(document, options) {
     return _create(this, this.#httpRequest, document, "create", options);
   }
@@ -2748,6 +2804,16 @@ class SanityClient {
   getDocuments(ids, options) {
     return lastValueFrom(_getDocuments(this, this.#httpRequest, ids, options));
   }
+  /**
+   * Convenient and bandwidth efficient method of checking wether a set of document IDs exists.
+   * Returns a set of the IDs that exist.
+   *
+   * @param ids - Document IDs to check
+   * @param options - Request options
+   */
+  documentsExists(ids, options) {
+    return lastValueFrom(_documentsExists(this, this.#httpRequest, ids, options));
+  }
   create(document, options) {
     return lastValueFrom(
       _create(this, this.#httpRequest, document, "create", options)