@sanity/client 5.2.2 → 5.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "5.2.2",
+  "version": "5.3.1",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -88,38 +88,38 @@
     "singleQuote": true
   },
   "dependencies": {
-    "@sanity/eventsource": "^4",
-    "get-it": "^8",
-    "rxjs": "^7"
+    "@sanity/eventsource": "5",
+    "get-it": "8",
+    "rxjs": "7"
   },
   "devDependencies": {
-    "@edge-runtime/types": "^2.0.5",
-    "@edge-runtime/vm": "^2.0.5",
+    "@edge-runtime/types": "^2.0.8",
+    "@edge-runtime/vm": "^2.1.2",
     "@rollup/plugin-commonjs": "^24.0.1",
     "@rollup/plugin-node-resolve": "^15.0.1",
-    "@sanity/pkg-utils": "^2.2.5",
-    "@sanity/semantic-release-preset": "^4.0.0",
-    "@types/node": "^18.14.0",
-    "@typescript-eslint/eslint-plugin": "^5.53.0",
-    "@typescript-eslint/parser": "^5.53.0",
-    "@vitest/coverage-c8": "^0.28.5",
-    "eslint": "^8.34.0",
-    "eslint-config-prettier": "^8.6.0",
+    "@sanity/pkg-utils": "^2.2.13",
+    "@sanity/semantic-release-preset": "^4.0.1",
+    "@types/node": "^18.15.3",
+    "@typescript-eslint/eslint-plugin": "^5.56.0",
+    "@typescript-eslint/parser": "^5.56.0",
+    "@vitest/coverage-c8": "^0.29.5",
+    "eslint": "^8.36.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "faucet": "^0.0.4",
-    "happy-dom": "^8.6.0",
+    "happy-dom": "^8.9.0",
     "ls-engines": "^0.9.0",
     "nock": "^13.3.0",
-    "prettier": "^2.8.4",
+    "prettier": "^2.8.5",
     "prettier-plugin-packagejson": "^2.4.3",
-    "rimraf": "^4.1.2",
-    "rollup": "^3.17.2",
+    "rimraf": "^4.4.0",
+    "rollup": "^3.20.0",
     "sse-channel": "^4.0.0",
-    "terser": "^5.16.4",
-    "typescript": "^4.9.5",
-    "vitest": "^0.28.5",
-    "vitest-github-actions-reporter": "^0.9.0"
+    "terser": "^5.16.6",
+    "typescript": "^5.0.2",
+    "vitest": "^0.29.6",
+    "vitest-github-actions-reporter": "^0.10.0"
   },
   "engines": {
     "node": ">=14.18"

package/src/data/listen.ts

@@ -130,10 +130,10 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
     }
 
     function unsubscribe() {
-      es.removeEventListener('error', onError, false)
-      es.removeEventListener('channelError', onChannelError, false)
-      es.removeEventListener('disconnect', onDisconnect, false)
-      listenFor.forEach((type: string) => es.removeEventListener(type, onMessage, false))
+      es.removeEventListener('error', onError)
+      es.removeEventListener('channelError', onChannelError)
+      es.removeEventListener('disconnect', onDisconnect)
+      listenFor.forEach((type: string) => es.removeEventListener(type, onMessage))
       es.close()
     }
 
@@ -145,10 +145,10 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
 
     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: string) => evs.addEventListener(type, onMessage, false))
+      evs.addEventListener('error', onError)
+      evs.addEventListener('channelError', onChannelError)
+      evs.addEventListener('disconnect', onDisconnect)
+      listenFor.forEach((type: string) => evs.addEventListener(type, onMessage))
       return evs
     }
 

package/src/http/errors.ts

@@ -1,4 +1,6 @@
-import type {Any, ErrorProps} from '../types'
+import type {Any, ErrorProps, MutationError} from '../types'
+
+const MAX_ITEMS_IN_ERROR_MESSAGE = 5
 
 /** @public */
 export class ClientError extends Error {
@@ -44,6 +46,22 @@ function extractErrorProps(res: Any): ErrorProps {
     return props
   }
 
+  // Mutation errors (specifically)
+  if (isMutationError(body)) {
+    const allItems = body.error.items || []
+    const items = allItems
+      .slice(0, MAX_ITEMS_IN_ERROR_MESSAGE)
+      .map((item) => item.error?.description)
+      .filter(Boolean)
+    let itemsStr = items.length ? `:\n- ${items.join('\n- ')}` : ''
+    if (allItems.length > MAX_ITEMS_IN_ERROR_MESSAGE) {
+      itemsStr += `\n...and ${allItems.length - MAX_ITEMS_IN_ERROR_MESSAGE} more`
+    }
+    props.message = `${body.error.description}${itemsStr}`
+    props.details = body.error
+    return props
+  }
+
   // Query/database errors ({error: {description, other, arb, props}})
   if (body.error && body.error.description) {
     props.message = body.error.description
@@ -56,6 +74,19 @@ function extractErrorProps(res: Any): ErrorProps {
   return props
 }
 
+function isMutationError(body: Any): body is MutationError {
+  return (
+    isPlainObject(body) &&
+    isPlainObject(body.error) &&
+    body.error.type === 'mutationError' &&
+    typeof body.error.description === 'string'
+  )
+}
+
+function isPlainObject(obj: Any): obj is Record<string, unknown> {
+  return typeof obj === 'object' && obj !== null && !Array.isArray(obj)
+}
+
 function httpErrorMessage(res: Any) {
   const statusMessage = res.statusMessage ? ` ${res.statusMessage}` : ''
   return `${res.method}-request to ${res.url} resulted in HTTP ${res.statusCode}${statusMessage}`

package/src/types.ts

@@ -566,3 +566,28 @@ export interface RawRequestOptions {
   body?: Any
   maxRedirects?: number
 }
+
+/** @internal */
+export interface ApiError {
+  error: string
+  message: string
+  statusCode: number
+}
+
+/** @internal */
+export interface MutationError {
+  error: {
+    type: 'mutationError'
+    description: string
+    items?: MutationErrorItem[]
+  }
+}
+
+/** @internal */
+export interface MutationErrorItem {
+  error: {
+    type: string
+    description: string
+    value?: unknown
+  }
+}

package/src/validators.ts

@@ -30,7 +30,7 @@ export const validateObject = (op: string, val: Any) => {
 }
 
 export const validateDocumentId = (op: string, id: string) => {
-  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(`${op}(): "${id}" is not a valid document ID`)
   }
 }

package/umd/sanityClient.js

@@ -1177,7 +1177,7 @@
     return Object.prototype.toString.call(o) === '[object Object]';
   }
 
-  function isPlainObject(o) {
+  function isPlainObject$1(o) {
     var ctor,prot;
 
     if (isObject(o) === false) return false;
@@ -1209,7 +1209,7 @@
           return options;
         }
         const isStream = typeof body.pipe === "function";
-        const shouldSerialize = !isStream && !isBuffer(body) && (serializeTypes.indexOf(typeof body) !== -1 || Array.isArray(body) || isPlainObject(body));
+        const shouldSerialize = !isStream && !isBuffer(body) && (serializeTypes.indexOf(typeof body) !== -1 || Array.isArray(body) || isPlainObject$1(body));
         if (!shouldSerialize) {
           return options;
         }
@@ -3084,13 +3084,12 @@
   	}(typeof globalThis === 'undefined' ? (typeof window !== 'undefined' ? window : typeof self !== 'undefined' ? self : commonjsGlobal) : globalThis));
   } (eventsource, eventsourceExports));
 
-  /* eslint-disable no-var */
+  var browser = eventsourceExports.EventSourcePolyfill;
 
-  var evs = eventsourceExports;
-
-  var browser = evs.EventSourcePolyfill;
+  var polyfilledEventSource = browser;
 
   var envMiddleware = [];
+  const MAX_ITEMS_IN_ERROR_MESSAGE = 5;
   class ClientError extends Error {
     constructor(res) {
       const props = extractErrorProps(res);
@@ -3120,6 +3119,20 @@
       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;
@@ -3128,6 +3141,12 @@
     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);
@@ -3230,7 +3249,7 @@
     }
   };
   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"));
     }
   };
@@ -4127,7 +4146,7 @@
     return selection;
   }, {});
   const MAX_URL_LENGTH = 16e3 - 1200;
-  const EventSource = browser;
+  const EventSource = polyfilledEventSource;
   const possibleOptions = ["includePreviousRevision", "includeResult", "visibility", "effectFormat", "tag"];
   const defaultOptions = {
     includeResult: true
@@ -4200,10 +4219,10 @@
         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() {
@@ -4215,10 +4234,10 @@
       }
       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() {