@sanity/client 5.2.2 → 5.3.1

package/dist/index.d.ts

@@ -21,6 +21,13 @@ export declare type AllDocumentsMutationOptions = BaseMutationOptions & {
  */
 export declare type Any = any
 
+/** @internal */
+export declare interface ApiError {
+  error: string
+  message: string
+  statusCode: number
+}
+
 /** @public */
 export declare type AssetMetadataType =
   | 'location'
@@ -538,6 +545,24 @@ export declare type Mutation<R extends Record<string, Any> = Record<string, Any>
       patch: PatchMutationOperation
     }
 
+/** @internal */
+export declare interface MutationError {
+  error: {
+    type: 'mutationError'
+    description: string
+    items?: MutationErrorItem[]
+  }
+}
+
+/** @internal */
+export declare interface MutationErrorItem {
+  error: {
+    type: string
+    description: string
+    value?: unknown
+  }
+}
+
 /** @public */
 declare type MutationEvent_2<R extends Record<string, Any> = Record<string, Any>> = {
   type: 'mutation'

package/dist/index.js

@@ -4,7 +4,7 @@ import { Observable, lastValueFrom } from 'rxjs';
 import { map, filter } from 'rxjs/operators';
 import polyfilledEventSource from '@sanity/eventsource';
 var name = "@sanity/client";
-var version = "5.2.2";
+var version = "5.3.1";
 const middleware = [debug({
   verbose: true,
   namespace: "sanity:client"
@@ -13,6 +13,7 @@ const middleware = [debug({
 }), retry({
   maxRetries: 3
 })];
+const MAX_ITEMS_IN_ERROR_MESSAGE = 5;
 class ClientError extends Error {
   constructor(res) {
     const props = extractErrorProps(res);
@@ -42,6 +43,20 @@ function extractErrorProps(res) {
     props.message = "".concat(body.error, " - ").concat(body.message);
     return props;
   }
+  if (isMutationError(body)) {
+    const allItems = body.error.items || [];
+    const items = allItems.slice(0, MAX_ITEMS_IN_ERROR_MESSAGE).map(item => {
+      var _a;
+      return (_a = item.error) == null ? void 0 : _a.description;
+    }).filter(Boolean);
+    let itemsStr = items.length ? ":\n- ".concat(items.join("\n- ")) : "";
+    if (allItems.length > MAX_ITEMS_IN_ERROR_MESSAGE) {
+      itemsStr += "\n...and ".concat(allItems.length - MAX_ITEMS_IN_ERROR_MESSAGE, " more");
+    }
+    props.message = "".concat(body.error.description).concat(itemsStr);
+    props.details = body.error;
+    return props;
+  }
   if (body.error && body.error.description) {
     props.message = body.error.description;
     props.details = body.error;
@@ -50,6 +65,12 @@ function extractErrorProps(res) {
   props.message = body.error || body.message || httpErrorMessage(res);
   return props;
 }
+function isMutationError(body) {
+  return isPlainObject(body) && isPlainObject(body.error) && body.error.type === "mutationError" && typeof body.error.description === "string";
+}
+function isPlainObject(obj) {
+  return typeof obj === "object" && obj !== null && !Array.isArray(obj);
+}
 function httpErrorMessage(res) {
   const statusMessage = res.statusMessage ? " ".concat(res.statusMessage) : "";
   return "".concat(res.method, "-request to ").concat(res.url, " resulted in HTTP ").concat(res.statusCode).concat(statusMessage);
@@ -152,7 +173,7 @@ const validateObject = (op, val) => {
   }
 };
 const validateDocumentId = (op, id) => {
-  if (typeof id !== "string" || !/^[a-z0-9_.-]+$/i.test(id)) {
+  if (typeof id !== "string" || !/^[a-z0-9_][a-z0-9_.-]{0,127}$/i.test(id) || id.includes("..")) {
     throw new Error("".concat(op, "(): \"").concat(id, "\" is not a valid document ID"));
   }
 };
@@ -1122,10 +1143,10 @@ function _listen(query, params) {
       observer.complete();
     }
     function unsubscribe() {
-      es.removeEventListener("error", onError, false);
-      es.removeEventListener("channelError", onChannelError, false);
-      es.removeEventListener("disconnect", onDisconnect, false);
-      listenFor.forEach(type => es.removeEventListener(type, onMessage, false));
+      es.removeEventListener("error", onError);
+      es.removeEventListener("channelError", onChannelError);
+      es.removeEventListener("disconnect", onDisconnect);
+      listenFor.forEach(type => es.removeEventListener(type, onMessage));
       es.close();
     }
     function emitReconnect() {
@@ -1137,10 +1158,10 @@ function _listen(query, params) {
     }
     function getEventSource() {
       const evs = new EventSource(uri, esOptions);
-      evs.addEventListener("error", onError, false);
-      evs.addEventListener("channelError", onChannelError, false);
-      evs.addEventListener("disconnect", onDisconnect, false);
-      listenFor.forEach(type => evs.addEventListener(type, onMessage, false));
+      evs.addEventListener("error", onError);
+      evs.addEventListener("channelError", onChannelError);
+      evs.addEventListener("disconnect", onDisconnect);
+      listenFor.forEach(type => evs.addEventListener(type, onMessage));
       return evs;
     }
     function open() {