@sanity/client 7.22.0 → 7.23.0

package/dist/index.d.cts

@@ -1039,9 +1039,9 @@ export declare interface ContentSourceMapValueMapping {
 
 /** @public */
 export declare class CorsOriginError extends Error {
-  projectId: string
+  projectId?: string
   addOriginUrl?: URL
-  constructor({projectId}: {projectId: string})
+  constructor({projectId, credentials}?: {projectId?: string; credentials?: boolean})
 }
 
 /**
@@ -3191,6 +3191,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.
@@ -5102,6 +5116,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.d.ts

@@ -1039,9 +1039,9 @@ export declare interface ContentSourceMapValueMapping {
 
 /** @public */
 export declare class CorsOriginError extends Error {
-  projectId: string
+  projectId?: string
   addOriginUrl?: URL
-  constructor({projectId}: {projectId: string})
+  constructor({projectId, credentials}?: {projectId?: string; credentials?: boolean})
 }
 
 /**
@@ -3191,6 +3191,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.
@@ -5102,6 +5116,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.js

@@ -4,7 +4,7 @@ import { retry, jsonRequest, jsonResponse, progress, observable, debug, headers,
 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 } from "./_chunks-es/isRecord.js";
 import { 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";
 import { validateObject, validateInsert, requireDocumentId, validateDocumentId, requireDocumentType, printCreateVersionWithBaseIdWarning, resourceConfig, hasDataset, requestTag, printPreviewDraftsDeprecationWarning, validateApiPerspective, printCdnPreviewDraftsWarning, validateAssetType, resourceGuard, dataset, validateVersionIdMatch, defaultConfig, initConfig, printNoDefaultExport } from "./_chunks-es/config.js";
@@ -176,14 +176,11 @@ function sliceWithEllipsis(str, max) {
 class CorsOriginError extends Error {
   projectId;
   addOriginUrl;
-  constructor({ projectId }) {
-    super("CorsOriginError"), this.name = "CorsOriginError", this.projectId = projectId;
-    const url = new URL(`https://sanity.io/manage/project/${projectId}/api`);
-    if (typeof location < "u") {
-      const { origin } = location;
-      url.searchParams.set("cors", "add"), url.searchParams.set("origin", origin), this.addOriginUrl = url, this.message = `The current origin is not allowed to connect to the Live Content API. Add it here: ${url}`;
-    } else
-      this.message = `The current origin is not allowed to connect to the Live Content API. Change your configuration here: ${url}`;
+  constructor({ projectId, credentials } = {}) {
+    if (super("CorsOriginError"), this.name = "CorsOriginError", this.projectId = projectId, projectId && typeof location < "u") {
+      const url = new URL(`https://sanity.io/manage/project/${projectId}/api`), { origin } = location;
+      url.searchParams.set("cors", "add"), url.searchParams.set("origin", origin), credentials && url.searchParams.set("credentials", ""), this.addOriginUrl = url, this.message = `The current origin is not allowed to connect to the Live Content API. Add it here: ${url}`;
+    } else projectId ? this.message = `The current origin is not allowed to connect to the Live Content API. Change your configuration here: https://sanity.io/manage/project/${projectId}/api` : this.message = "The current origin is not allowed to connect to the Live Content API.";
   }
 }
 const httpError = {
@@ -786,6 +783,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,
@@ -922,7 +948,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)) {
@@ -938,7 +964,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)
@@ -1316,19 +1343,14 @@ class LiveClient {
       "welcome",
       "reconnect",
       "goaway"
-    ]), checkCors = fetchObservable(url, {
-      method: "OPTIONS",
-      mode: "cors",
-      credentials: esOptions.withCredentials ? "include" : "omit",
-      headers: esOptions.headers
-    }).pipe(
-      catchError(() => {
-        throw new CorsOriginError({ projectId });
-      })
+    ]), checkCors = checkCorsObservable(
+      new URL(this.#client.getUrl("/check/cors", !1)),
+      projectId,
+      esOptions.withCredentials === !0
     ), observable2 = events.pipe(
       reconnectOnConnectionFailure(),
       mergeMap((event) => event.type === "reconnect" ? checkCors.pipe(mergeMap(() => of(event))) : of(event)),
-      catchError((err) => checkCors.pipe(
+      catchError((err) => err instanceof CorsOriginError ? throwError(() => err) : checkCors.pipe(
         mergeMap(() => {
           throw err;
         })
@@ -1349,17 +1371,27 @@ class LiveClient {
     return eventsCache.set(key, observable2), observable2;
   }
 }
-function fetchObservable(url, init) {
+function checkCorsObservable(url, projectId, requireCredentials) {
   return new Observable((observer) => {
-    const controller = new AbortController(), signal = controller.signal;
-    return fetch(url, { ...init, signal: controller.signal }).then(
-      (response) => {
-        observer.next(response), observer.complete();
-      },
-      (err) => {
-        signal.aborted || observer.error(err);
+    const controller = new AbortController(), { signal } = controller;
+    return fetch(url, { method: "GET", mode: "cors", credentials: "omit", signal }).then((response) => {
+      if (!(signal.aborted || !response.ok))
+        return response.json();
+    }).then((body) => {
+      if (!signal.aborted) {
+        if (requireCredentials && body?.result?.withCredentials === !1) {
+          observer.error(new CorsOriginError({ projectId, credentials: !0 }));
+          return;
+        }
+        if (body?.result?.allowed === !1) {
+          observer.error(new CorsOriginError({ projectId, credentials: requireCredentials }));
+          return;
+        }
+        observer.next(), observer.complete();
       }
-    ), () => controller.abort();
+    }).catch(() => {
+      signal.aborted || observer.closed || (observer.next(), observer.complete());
+    }), () => controller.abort();
   });
 }
 const eventsCache = /* @__PURE__ */ new Map();
@@ -2287,6 +2319,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);
   }
@@ -2564,6 +2606,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)
@@ -2786,7 +2838,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var name = "@sanity/client", version = "7.22.0";
+var name = "@sanity/client", version = "7.23.0";
 const middleware = [
   debug({ verbose: !0, namespace: "sanity:client" }),
   headers({ "User-Agent": `${name} ${version}` }),