@sanity/client 6.1.3-perspective.0 → 6.2.0-fetch.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.1.3-perspective.0",
+  "version": "6.2.0-fetch.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -71,6 +71,7 @@
     "prepublishOnly": "npm run build",
     "rollup": "NODE_ENV=production rollup -c rollup.config.cjs",
     "test": "vitest",
+    "type-check": "tsc --noEmit",
     "test:browser": "npm test -- --config ./vitest.browser.config.ts",
     "test:bun": "(cd runtimes/bun && bun wiptest)",
     "test:deno": "deno test --allow-read --allow-net --allow-env --fail-fast --import-map=runtimes/deno/import_map.json runtimes/deno",
@@ -91,7 +92,7 @@
   },
   "dependencies": {
     "@sanity/eventsource": "^5.0.0",
-    "get-it": "^8.1.0",
+    "get-it": "8.2.0-fetch.0",
     "rxjs": "^7.0.0"
   },
   "devDependencies": {

package/src/data/dataMethods.ts

@@ -69,8 +69,13 @@ export function _fetch<R, Q extends QueryParams>(
 ): Observable<RawQueryResponse<R> | R> {
   const mapResponse =
     options.filterResponse === false ? (res: Any) => res : (res: Any) => res.result
+  const {cache, next, ...opts} = options
+  const reqOpts =
+    typeof cache !== 'undefined' || typeof next !== 'undefined'
+      ? {...opts, fetch: {cache, next}}
+      : opts
 
-  return _dataRequest(client, httpRequest, 'query', {query, params}, options).pipe(map(mapResponse))
+  return _dataRequest(client, httpRequest, 'query', {query, params}, reqOpts).pipe(map(mapResponse))
 }
 
 /** @internal */
@@ -226,6 +231,7 @@ export function _dataRequest(
     tag,
     canUseCdn: isQuery,
     signal: options.signal,
+    fetch: options.fetch,
   }
 
   return _requestObservable(client, httpRequest, reqOptions).pipe(

package/src/types.ts

@@ -28,6 +28,9 @@ export interface RequestOptions {
   signal?: AbortSignal
 }
 
+/** @public */
+export type ClientPerspective = 'previewDrafts' | 'published' | 'raw'
+
 /** @public */
 export interface ClientConfig {
   projectId?: string
@@ -35,8 +38,7 @@ export interface ClientConfig {
   /** @defaultValue true */
   useCdn?: boolean
   token?: string
-  /** @defaultValue 'raw' */
-  perspective?: 'previewDrafts' | 'published' | 'raw'
+  perspective?: ClientPerspective
   apiHost?: string
   apiVersion?: string
   proxy?: string
@@ -483,12 +485,18 @@ export interface ListenOptions {
 }
 
 /** @public */
-export type FilteredResponseQueryOptions = RequestOptions & {
+export type ResponseQueryOptions<T = 'next'> = RequestOptions & {
+  cache?: RequestInit['cache']
+  next?: T extends keyof RequestInit ? RequestInit[T] : never
+}
+
+/** @public */
+export type FilteredResponseQueryOptions = ResponseQueryOptions & {
   filterResponse?: true
 }
 
 /** @public */
-export type UnfilteredResponseQueryOptions = RequestOptions & {
+export type UnfilteredResponseQueryOptions = ResponseQueryOptions & {
   filterResponse: false
 }
 

package/umd/sanityClient.js

@@ -8,10 +8,13 @@
   const defaultOptions$1 = {
     timeout: isReactNative ? 6e4 : 12e4
   };
-  function processOptions(opts) {
-    const options = typeof opts === "string" ? Object.assign({
-      url: opts
-    }, defaultOptions$1) : Object.assign({}, defaultOptions$1, opts);
+  const processOptions = function processOptions2(opts) {
+    const options = {
+      ...defaultOptions$1,
+      ...(typeof opts === "string" ? {
+        url: opts
+      } : opts)
+    };
     const url = new URL(options.url, "http://localhost");
     options.timeout = normalizeTimeout(options.timeout);
     if (options.query) {
@@ -30,7 +33,7 @@
     options.method = options.body && !options.method ? "POST" : (options.method || "GET").toUpperCase();
     options.url = url.origin === "http://localhost" ? "".concat(url.pathname, "?").concat(url.searchParams) : url.toString();
     return options;
-  }
+  };
   function normalizeTimeout(time) {
     if (time === false || time === 0) {
       return false;
@@ -48,11 +51,11 @@
     };
   }
   const validUrl = /^https?:\/\//i;
-  function validateOptions(options) {
+  const validateOptions = function validateOptions2(options) {
     if (!validUrl.test(options.url)) {
       throw new Error("\"".concat(options.url, "\" is not a valid URL"));
     }
-  }
+  };
 
   var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -95,23 +98,20 @@
 
   var parseHeaders$1 = /*@__PURE__*/getDefaultExportFromCjs(parseHeaders);
 
-  var middlewareReducer = middleware => {
-    const applyMiddleware = function (hook, defaultValue) {
-      const bailEarly = hook === "onError";
-      let value = defaultValue;
-      for (var _len = arguments.length, args = new Array(_len > 2 ? _len - 2 : 0), _key = 2; _key < _len; _key++) {
-        args[_key - 2] = arguments[_key];
-      }
-      for (let i = 0; i < middleware[hook].length; i++) {
-        const handler = middleware[hook][i];
-        value = handler(value, ...args);
-        if (bailEarly && !value) {
-          break;
-        }
+  const middlewareReducer = middleware => function applyMiddleware(hook, defaultValue) {
+    const bailEarly = hook === "onError";
+    let value = defaultValue;
+    for (var _len = arguments.length, args = new Array(_len > 2 ? _len - 2 : 0), _key = 2; _key < _len; _key++) {
+      args[_key - 2] = arguments[_key];
+    }
+    for (let i = 0; i < middleware[hook].length; i++) {
+      const handler = middleware[hook][i];
+      value = handler(value, ...args);
+      if (bailEarly && !value) {
+        break;
       }
-      return value;
-    };
-    return applyMiddleware;
+    }
+    return value;
   };
   function createPubSub() {
     const subscribers = /* @__PURE__ */Object.create(null);
@@ -143,8 +143,28 @@
     }, {
       processOptions: [processOptions],
       validateOptions: [validateOptions]
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
     });
+
     function request(opts) {
+      const onResponse = (reqErr, res, ctx) => {
+        let error = reqErr;
+        let response = res;
+        if (!error) {
+          try {
+            response = applyMiddleware("onResponse", res, ctx);
+          } catch (err) {
+            response = null;
+            error = err;
+          }
+        }
+        error = error && applyMiddleware("onError", error, ctx);
+        if (error) {
+          channels.error.publish(error);
+        } else if (response) {
+          channels.response.publish(response);
+        }
+      };
       const channels = channelNames.reduce((target, name) => {
         target[name] = createPubSub();
         return target;
@@ -157,7 +177,7 @@
         channels,
         applyMiddleware
       };
-      let ongoingRequest = null;
+      let ongoingRequest;
       const unsubscribe = channels.request.subscribe(ctx => {
         ongoingRequest = httpRequest(ctx, (err, res) => onResponse(err, res, ctx));
       });
@@ -172,24 +192,6 @@
         channels.request.publish(context);
       }
       return returnValue;
-      function onResponse(reqErr, res, ctx) {
-        let error = reqErr;
-        let response = res;
-        if (!error) {
-          try {
-            response = applyMiddleware("onResponse", res, ctx);
-          } catch (err) {
-            response = null;
-            error = err;
-          }
-        }
-        error = error && applyMiddleware("onError", error, ctx);
-        if (error) {
-          channels.error.publish(error);
-        } else if (response) {
-          channels.response.publish(response);
-        }
-      }
     }
     request.use = function use(newMiddleware) {
       if (!newMiddleware) {
@@ -209,9 +211,7 @@
       loadedMiddleware.push(newMiddleware);
       return request;
     };
-    request.clone = function clone() {
-      return createRequester(loadedMiddleware, httpRequest);
-    };
+    request.clone = () => createRequester(loadedMiddleware, httpRequest);
     initMiddleware.forEach(request.use);
     return request;
   }
@@ -317,7 +317,7 @@
   _controller = new WeakMap();
   const adapter = typeof XMLHttpRequest === "function" ? "xhr" : "fetch";
   const XmlHttpRequest = adapter === "xhr" ? XMLHttpRequest : FetchXhr;
-  var httpRequester = (context, callback) => {
+  const httpRequester = (context, callback) => {
     const opts = context.options;
     const options = context.applyMiddleware("finalizeOptions", opts);
     const timers = {};
@@ -1258,7 +1258,7 @@
       }
     }
   }
-  let actualGlobal;
+  let actualGlobal = {};
   if (typeof globalThis !== "undefined") {
     actualGlobal = globalThis;
   } else if (typeof window !== "undefined") {
@@ -1267,13 +1267,13 @@
     actualGlobal = global;
   } else if (typeof self !== "undefined") {
     actualGlobal = self;
-  } else {
-    actualGlobal = {};
   }
   var global$1 = actualGlobal;
   function observable$1() {
     let opts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    const Observable = opts.implementation || global$1.Observable;
+    const Observable =
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any -- @TODO consider dropping checking for a global Observable since it's not on a standards track
+    opts.implementation || global$1.Observable;
     if (!Observable) {
       throw new Error("`Observable` is not available in global scope, and no implementation was passed");
     }
@@ -1296,7 +1296,6 @@
   }
   function progress() {
     return {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       onRequest: evt => {
         if (evt.adapter !== "xhr") {
           return;
@@ -2090,12 +2089,26 @@
   }
 
   var envMiddleware = [];
+  var __defProp$3 = Object.defineProperty;
+  var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value
+  }) : obj[key] = value;
+  var __publicField$3 = (obj, key, value) => {
+    __defNormalProp$3(obj, typeof key !== "symbol" ? key + "" : key, value);
+    return value;
+  };
   const MAX_ITEMS_IN_ERROR_MESSAGE = 5;
   class ClientError extends Error {
     constructor(res) {
       const props = extractErrorProps(res);
       super(props.message);
-      this.statusCode = 400;
+      __publicField$3(this, "response");
+      __publicField$3(this, "statusCode", 400);
+      __publicField$3(this, "responseBody");
+      __publicField$3(this, "details");
       Object.assign(this, props);
     }
   }
@@ -2103,7 +2116,10 @@
     constructor(res) {
       const props = extractErrorProps(res);
       super(props.message);
-      this.statusCode = 500;
+      __publicField$3(this, "response");
+      __publicField$3(this, "statusCode", 500);
+      __publicField$3(this, "responseBody");
+      __publicField$3(this, "details");
       Object.assign(this, props);
     }
   }
@@ -2324,6 +2340,17 @@
     }
     return "?".concat(searchParams);
   };
+  var __defProp$2 = Object.defineProperty;
+  var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value
+  }) : obj[key] = value;
+  var __publicField$2 = (obj, key, value) => {
+    __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
+    return value;
+  };
   var __accessCheck$6 = (obj, member, msg) => {
     if (!member.has(obj)) throw TypeError("Cannot " + msg);
   };
@@ -2344,6 +2371,8 @@
   class BasePatch {
     constructor(selection) {
       let operations = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      __publicField$2(this, "selection");
+      __publicField$2(this, "operations");
       this.selection = selection;
       this.operations = operations;
     }
@@ -2497,7 +2526,7 @@
       return this._assign(op, props, false);
     }
   }
-  const _ObservablePatch = class extends BasePatch {
+  const _ObservablePatch = class _ObservablePatch extends BasePatch {
     constructor(selection, operations, client) {
       super(selection, operations);
       __privateAdd$6(this, _client$5, void 0);
@@ -2525,9 +2554,9 @@
       }, opts);
     }
   };
-  let ObservablePatch = _ObservablePatch;
   _client$5 = new WeakMap();
-  const _Patch = class extends BasePatch {
+  let ObservablePatch = _ObservablePatch;
+  const _Patch = class _Patch extends BasePatch {
     constructor(selection, operations, client) {
       super(selection, operations);
       __privateAdd$6(this, _client2$5, void 0);
@@ -2555,8 +2584,19 @@
       }, opts);
     }
   };
-  let Patch = _Patch;
   _client2$5 = new WeakMap();
+  let Patch = _Patch;
+  var __defProp$1 = Object.defineProperty;
+  var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value
+  }) : obj[key] = value;
+  var __publicField$1 = (obj, key, value) => {
+    __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+    return value;
+  };
   var __accessCheck$5 = (obj, member, msg) => {
     if (!member.has(obj)) throw TypeError("Cannot " + msg);
   };
@@ -2581,6 +2621,8 @@
     constructor() {
       let operations = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
       let transactionId = arguments.length > 1 ? arguments[1] : undefined;
+      __publicField$1(this, "operations");
+      __publicField$1(this, "trxId");
       this.operations = operations;
       this.trxId = transactionId;
     }
@@ -2669,7 +2711,7 @@
       return this;
     }
   }
-  const _Transaction = class extends BaseTransaction {
+  const _Transaction = class _Transaction extends BaseTransaction {
     constructor(operations, client, transactionId) {
       super(operations, transactionId);
       __privateAdd$5(this, _client$4, void 0);
@@ -2714,9 +2756,9 @@
       });
     }
   };
-  let Transaction = _Transaction;
   _client$4 = new WeakMap();
-  const _ObservableTransaction = class extends BaseTransaction {
+  let Transaction = _Transaction;
+  const _ObservableTransaction = class _ObservableTransaction extends BaseTransaction {
     constructor(operations, client, transactionId) {
       super(operations, transactionId);
       __privateAdd$5(this, _client2$4, void 0);
@@ -2761,8 +2803,8 @@
       });
     }
   };
-  let ObservableTransaction = _ObservableTransaction;
   _client2$4 = new WeakMap();
+  let ObservableTransaction = _ObservableTransaction;
   const excludeFalsey = (param, defValue) => {
     const value = typeof param === "undefined" ? defValue : param;
     return param === false ? void 0 : value;
@@ -2788,10 +2830,22 @@
   function _fetch(client, httpRequest, query, params) {
     let options = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
     const mapResponse = options.filterResponse === false ? res => res : res => res.result;
+    const {
+      cache,
+      next,
+      ...opts
+    } = options;
+    const reqOpts = typeof cache !== "undefined" || typeof next !== "undefined" ? {
+      ...opts,
+      fetch: {
+        cache,
+        next
+      }
+    } : opts;
     return _dataRequest(client, httpRequest, "query", {
       query,
       params
-    }, options).pipe(map(mapResponse));
+    }, reqOpts).pipe(map(mapResponse));
   }
   function _getDocument(client, httpRequest, id) {
     let opts = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
@@ -2873,7 +2927,8 @@
       token,
       tag,
       canUseCdn: isQuery,
-      signal: options.signal
+      signal: options.signal,
+      fetch: options.fetch
     };
     return _requestObservable(client, httpRequest, reqOptions).pipe(filter(isResponse), map(getBody), map(res => {
       if (!isMutation) {
@@ -3575,6 +3630,17 @@
   }
   _client2 = new WeakMap();
   _httpRequest2$1 = new WeakMap();
+  var __defProp = Object.defineProperty;
+  var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value
+  }) : obj[key] = value;
+  var __publicField = (obj, key, value) => {
+    __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+    return value;
+  };
   var __accessCheck = (obj, member, msg) => {
     if (!member.has(obj)) throw TypeError("Cannot " + msg);
   };
@@ -3592,9 +3658,13 @@
     return value;
   };
   var _clientConfig, _httpRequest, _clientConfig2, _httpRequest2;
-  const _ObservableSanityClient = class {
+  const _ObservableSanityClient = class _ObservableSanityClient {
     constructor(httpRequest) {
       let config = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : defaultConfig;
+      __publicField(this, "assets");
+      __publicField(this, "datasets");
+      __publicField(this, "projects");
+      __publicField(this, "users");
       /**
        * Private properties
        */
@@ -3603,7 +3673,7 @@
       /**
        * Instance properties
        */
-      this.listen = _listen;
+      __publicField(this, "listen", _listen);
       this.config(config);
       __privateSet(this, _httpRequest, httpRequest);
       this.assets = new ObservableAssetsClient(this, __privateGet(this, _httpRequest));
@@ -3725,12 +3795,20 @@
       return _getDataUrl(this, operation, path);
     }
   };
-  let ObservableSanityClient = _ObservableSanityClient;
   _clientConfig = new WeakMap();
   _httpRequest = new WeakMap();
-  const _SanityClient = class {
+  let ObservableSanityClient = _ObservableSanityClient;
+  const _SanityClient = class _SanityClient {
     constructor(httpRequest) {
       let config = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : defaultConfig;
+      __publicField(this, "assets");
+      __publicField(this, "datasets");
+      __publicField(this, "projects");
+      __publicField(this, "users");
+      /**
+       * Observable version of the Sanity client, with the same configuration as the promise-based one
+       */
+      __publicField(this, "observable");
       /**
        * Private properties
        */
@@ -3739,7 +3817,7 @@
       /**
        * Instance properties
        */
-      this.listen = _listen;
+      __publicField(this, "listen", _listen);
       this.config(config);
       __privateSet(this, _httpRequest2, httpRequest);
       this.assets = new AssetsClient(this, __privateGet(this, _httpRequest2));
@@ -3879,9 +3957,9 @@
       return _getDataUrl(this, operation, path);
     }
   };
-  let SanityClient = _SanityClient;
   _clientConfig2 = new WeakMap();
   _httpRequest2 = new WeakMap();
+  let SanityClient = _SanityClient;
   const httpRequest = defineHttpRequest(envMiddleware, {});
   const requester = httpRequest.defaultRequester;
   const createClient = config => new SanityClient(defineHttpRequest(envMiddleware, {