@sanity/client 5.0.0-esm.8 → 5.0.0

package/dist/index.js

@@ -1,11 +1,10 @@
 import { debug, headers, retry, jsonRequest, jsonResponse, progress, observable } from 'get-it/middleware';
 import { getIt } from 'get-it';
 import { Observable, lastValueFrom } from 'rxjs';
-import { BaseError } from 'make-error';
 import { map, filter } from 'rxjs/operators';
 import polyfilledEventSource from '@sanity/eventsource';
 var name = "@sanity/client";
-var version = "5.0.0-esm.8";
+var version = "5.0.0";
 const middleware = [debug({
   verbose: true,
   namespace: "sanity:client"
@@ -14,7 +13,7 @@ const middleware = [debug({
 }), retry({
   maxRetries: 3
 })];
-class ClientError extends BaseError {
+class ClientError extends Error {
   constructor(res) {
     const props = extractErrorProps(res);
     super(props.message);
@@ -22,7 +21,7 @@ class ClientError extends BaseError {
     Object.assign(this, props);
   }
 }
-class ServerError extends BaseError {
+class ServerError extends Error {
   constructor(res) {
     const props = extractErrorProps(res);
     super(props.message);
@@ -188,60 +187,50 @@ const requestTag = tag => {
   }
   return tag;
 };
-const enc = encodeURIComponent;
 var encodeQueryString = _ref => {
   let {
     query,
     params = {},
     options = {}
   } = _ref;
+  const searchParams = new URLSearchParams();
   const {
     tag,
     ...opts
   } = options;
-  const q = "query=".concat(enc(query));
-  const base = tag ? "?tag=".concat(enc(tag), "&").concat(q) : "?".concat(q);
-  const qString = Object.keys(params).reduce((qs, param) => "".concat(qs, "&").concat(enc("$".concat(param)), "=").concat(enc(JSON.stringify(params[param]))), base);
-  return Object.keys(opts).reduce((qs, option) => {
-    return options[option] ? "".concat(qs, "&").concat(enc(option), "=").concat(enc(options[option])) : qs;
-  }, qString);
+  if (tag) searchParams.set("tag", tag);
+  searchParams.set("query", query);
+  for (const [key, value] of Object.entries(params)) {
+    searchParams.set("$".concat(key), JSON.stringify(value));
+  }
+  for (const [key, value] of Object.entries(opts)) {
+    if (value) searchParams.set(key, "".concat(value));
+  }
+  return "?".concat(searchParams);
 };
-var __accessCheck$7 = (obj, member, msg) => {
+var __accessCheck$6 = (obj, member, msg) => {
   if (!member.has(obj)) throw TypeError("Cannot " + msg);
 };
-var __privateGet$7 = (obj, member, getter) => {
-  __accessCheck$7(obj, member, "read from private field");
+var __privateGet$6 = (obj, member, getter) => {
+  __accessCheck$6(obj, member, "read from private field");
   return getter ? getter.call(obj) : member.get(obj);
 };
-var __privateAdd$7 = (obj, member, value) => {
+var __privateAdd$6 = (obj, member, value) => {
   if (member.has(obj)) throw TypeError("Cannot add the same private member more than once");
   member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 };
-var __privateSet$7 = (obj, member, value, setter) => {
-  __accessCheck$7(obj, member, "write to private field");
+var __privateSet$6 = (obj, member, value, setter) => {
+  __accessCheck$6(obj, member, "write to private field");
   setter ? setter.call(obj, value) : member.set(obj, value);
   return value;
 };
-var _client$6, _client2$6;
+var _client$5, _client2$5;
 class BasePatch {
   constructor(selection) {
     let operations = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
     this.selection = selection;
     this.operations = operations;
   }
-  /**
-   * DEPRECATED: Don't use.
-   * The operation is added to the current patch, ready to be commited by `commit()`
-   *
-   * @deprecated - Don't use.
-   * @param attrs - Attributes to replace
-   */
-  replace(attrs) {
-    validateObject("replace", attrs);
-    return this._set("set", {
-      $: attrs
-    });
-  }
   /**
    * Sets the given attributes to the document. Does NOT merge objects.
    * The operation is added to the current patch, ready to be commited by `commit()`
@@ -395,8 +384,8 @@ class BasePatch {
 const _ObservablePatch = class extends BasePatch {
   constructor(selection, operations, client) {
     super(selection, operations);
-    __privateAdd$7(this, _client$6, void 0);
-    __privateSet$7(this, _client$6, client);
+    __privateAdd$6(this, _client$5, void 0);
+    __privateSet$6(this, _client$5, client);
   }
   /**
    * Clones the patch
@@ -404,10 +393,10 @@ const _ObservablePatch = class extends BasePatch {
   clone() {
     return new _ObservablePatch(this.selection, {
       ...this.operations
-    }, __privateGet$7(this, _client$6));
+    }, __privateGet$6(this, _client$5));
   }
   commit(options) {
-    if (!__privateGet$7(this, _client$6)) {
+    if (!__privateGet$6(this, _client$5)) {
       throw new Error("No `client` passed to patch, either provide one or pass the patch to a clients `mutate()` method");
     }
     const returnFirst = typeof this.selection === "string";
@@ -415,18 +404,18 @@ const _ObservablePatch = class extends BasePatch {
       returnFirst,
       returnDocuments: true
     }, options);
-    return __privateGet$7(this, _client$6).mutate({
+    return __privateGet$6(this, _client$5).mutate({
       patch: this.serialize()
     }, opts);
   }
 };
 let ObservablePatch = _ObservablePatch;
-_client$6 = new WeakMap();
+_client$5 = new WeakMap();
 const _Patch = class extends BasePatch {
   constructor(selection, operations, client) {
     super(selection, operations);
-    __privateAdd$7(this, _client2$6, void 0);
-    __privateSet$7(this, _client2$6, client);
+    __privateAdd$6(this, _client2$5, void 0);
+    __privateSet$6(this, _client2$5, client);
   }
   /**
    * Clones the patch
@@ -434,10 +423,10 @@ const _Patch = class extends BasePatch {
   clone() {
     return new _Patch(this.selection, {
       ...this.operations
-    }, __privateGet$7(this, _client2$6));
+    }, __privateGet$6(this, _client2$5));
   }
   commit(options) {
-    if (!__privateGet$7(this, _client2$6)) {
+    if (!__privateGet$6(this, _client2$5)) {
       throw new Error("No `client` passed to patch, either provide one or pass the patch to a clients `mutate()` method");
     }
     const returnFirst = typeof this.selection === "string";
@@ -445,30 +434,30 @@ const _Patch = class extends BasePatch {
       returnFirst,
       returnDocuments: true
     }, options);
-    return __privateGet$7(this, _client2$6).mutate({
+    return __privateGet$6(this, _client2$5).mutate({
       patch: this.serialize()
     }, opts);
   }
 };
 let Patch = _Patch;
-_client2$6 = new WeakMap();
-var __accessCheck$6 = (obj, member, msg) => {
+_client2$5 = new WeakMap();
+var __accessCheck$5 = (obj, member, msg) => {
   if (!member.has(obj)) throw TypeError("Cannot " + msg);
 };
-var __privateGet$6 = (obj, member, getter) => {
-  __accessCheck$6(obj, member, "read from private field");
+var __privateGet$5 = (obj, member, getter) => {
+  __accessCheck$5(obj, member, "read from private field");
   return getter ? getter.call(obj) : member.get(obj);
 };
-var __privateAdd$6 = (obj, member, value) => {
+var __privateAdd$5 = (obj, member, value) => {
   if (member.has(obj)) throw TypeError("Cannot add the same private member more than once");
   member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 };
-var __privateSet$6 = (obj, member, value, setter) => {
-  __accessCheck$6(obj, member, "write to private field");
+var __privateSet$5 = (obj, member, value, setter) => {
+  __accessCheck$5(obj, member, "write to private field");
   setter ? setter.call(obj, value) : member.set(obj, value);
   return value;
 };
-var _client$5, _client2$5;
+var _client$4, _client2$4;
 const defaultMutateOptions = {
   returnDocuments: false
 };
@@ -567,20 +556,20 @@ class BaseTransaction {
 const _Transaction = class extends BaseTransaction {
   constructor(operations, client, transactionId) {
     super(operations, transactionId);
-    __privateAdd$6(this, _client$5, void 0);
-    __privateSet$6(this, _client$5, client);
+    __privateAdd$5(this, _client$4, void 0);
+    __privateSet$5(this, _client$4, client);
   }
   /**
    * Clones the transaction
    */
   clone() {
-    return new _Transaction([...this.operations], __privateGet$6(this, _client$5), this.trxId);
+    return new _Transaction([...this.operations], __privateGet$5(this, _client$4), this.trxId);
   }
   commit(options) {
-    if (!__privateGet$6(this, _client$5)) {
+    if (!__privateGet$5(this, _client$4)) {
       throw new Error("No `client` passed to transaction, either provide one or pass the transaction to a clients `mutate()` method");
     }
-    return __privateGet$6(this, _client$5).mutate(this.serialize(), Object.assign({
+    return __privateGet$5(this, _client$4).mutate(this.serialize(), Object.assign({
       transactionId: this.trxId
     }, defaultMutateOptions, options || {}));
   }
@@ -593,7 +582,7 @@ const _Transaction = class extends BaseTransaction {
       });
     }
     if (isBuilder) {
-      const patch = patchOps(new Patch(patchOrDocumentId, {}, __privateGet$6(this, _client$5)));
+      const patch = patchOps(new Patch(patchOrDocumentId, {}, __privateGet$5(this, _client$4)));
       if (!(patch instanceof Patch)) {
         throw new Error("function passed to `patch()` must return the patch");
       }
@@ -610,24 +599,24 @@ const _Transaction = class extends BaseTransaction {
   }
 };
 let Transaction = _Transaction;
-_client$5 = new WeakMap();
+_client$4 = new WeakMap();
 const _ObservableTransaction = class extends BaseTransaction {
   constructor(operations, client, transactionId) {
     super(operations, transactionId);
-    __privateAdd$6(this, _client2$5, void 0);
-    __privateSet$6(this, _client2$5, client);
+    __privateAdd$5(this, _client2$4, void 0);
+    __privateSet$5(this, _client2$4, client);
   }
   /**
    * Clones the transaction
    */
   clone() {
-    return new _ObservableTransaction([...this.operations], __privateGet$6(this, _client2$5), this.trxId);
+    return new _ObservableTransaction([...this.operations], __privateGet$5(this, _client2$4), this.trxId);
   }
   commit(options) {
-    if (!__privateGet$6(this, _client2$5)) {
+    if (!__privateGet$5(this, _client2$4)) {
       throw new Error("No `client` passed to transaction, either provide one or pass the transaction to a clients `mutate()` method");
     }
-    return __privateGet$6(this, _client2$5).mutate(this.serialize(), Object.assign({
+    return __privateGet$5(this, _client2$4).mutate(this.serialize(), Object.assign({
       transactionId: this.trxId
     }, defaultMutateOptions, options || {}));
   }
@@ -640,7 +629,7 @@ const _ObservableTransaction = class extends BaseTransaction {
       });
     }
     if (isBuilder) {
-      const patch = patchOps(new ObservablePatch(patchOrDocumentId, {}, __privateGet$6(this, _client2$5)));
+      const patch = patchOps(new ObservablePatch(patchOrDocumentId, {}, __privateGet$5(this, _client2$4)));
       if (!(patch instanceof ObservablePatch)) {
         throw new Error("function passed to `patch()` must return the patch");
       }
@@ -657,7 +646,7 @@ const _ObservableTransaction = class extends BaseTransaction {
   }
 };
 let ObservableTransaction = _ObservableTransaction;
-_client2$5 = new WeakMap();
+_client2$4 = new WeakMap();
 const excludeFalsey = (param, defValue) => {
   const value = typeof param === "undefined" ? defValue : param;
   return param === false ? void 0 : value;
@@ -805,7 +794,9 @@ function _requestObservable(client, httpRequest, options) {
   const reqOptions = getRequestOptions(config, Object.assign({}, options, {
     url: _getUrl(client, uri, useCdn)
   }));
-  return new Observable(subscriber => httpRequest(reqOptions, config.requester).subscribe(subscriber));
+  return new Observable(subscriber =>
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- the typings thinks it's optional because it's not required to specify it when calling createClient, but it's always defined in practice since SanityClient provides a default
+  httpRequest(reqOptions, config.requester).subscribe(subscriber));
 }
 function _request(client, httpRequest, options) {
   const observable = _requestObservable(client, httpRequest, options).pipe(filter(event => event.type === "response"), map(event => event.body));
@@ -827,50 +818,50 @@ function _getUrl(client, uri) {
   const base = canUseCdn ? cdnUrl : url;
   return "".concat(base, "/").concat(uri.replace(/^\//, ""));
 }
-var __accessCheck$5 = (obj, member, msg) => {
+var __accessCheck$4 = (obj, member, msg) => {
   if (!member.has(obj)) throw TypeError("Cannot " + msg);
 };
-var __privateGet$5 = (obj, member, getter) => {
-  __accessCheck$5(obj, member, "read from private field");
+var __privateGet$4 = (obj, member, getter) => {
+  __accessCheck$4(obj, member, "read from private field");
   return getter ? getter.call(obj) : member.get(obj);
 };
-var __privateAdd$5 = (obj, member, value) => {
+var __privateAdd$4 = (obj, member, value) => {
   if (member.has(obj)) throw TypeError("Cannot add the same private member more than once");
   member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 };
-var __privateSet$5 = (obj, member, value, setter) => {
-  __accessCheck$5(obj, member, "write to private field");
+var __privateSet$4 = (obj, member, value, setter) => {
+  __accessCheck$4(obj, member, "write to private field");
   setter ? setter.call(obj, value) : member.set(obj, value);
   return value;
 };
-var _client$4, _httpRequest$5, _client2$4, _httpRequest2$5;
+var _client$3, _httpRequest$4, _client2$3, _httpRequest2$4;
 class ObservableAssetsClient {
   constructor(client, httpRequest) {
-    __privateAdd$5(this, _client$4, void 0);
-    __privateAdd$5(this, _httpRequest$5, void 0);
-    __privateSet$5(this, _client$4, client);
-    __privateSet$5(this, _httpRequest$5, httpRequest);
+    __privateAdd$4(this, _client$3, void 0);
+    __privateAdd$4(this, _httpRequest$4, void 0);
+    __privateSet$4(this, _client$3, client);
+    __privateSet$4(this, _httpRequest$4, httpRequest);
   }
   upload(assetType, body, options) {
-    return _upload(__privateGet$5(this, _client$4), __privateGet$5(this, _httpRequest$5), assetType, body, options);
+    return _upload(__privateGet$4(this, _client$3), __privateGet$4(this, _httpRequest$4), assetType, body, options);
   }
 }
-_client$4 = new WeakMap();
-_httpRequest$5 = new WeakMap();
+_client$3 = new WeakMap();
+_httpRequest$4 = new WeakMap();
 class AssetsClient {
   constructor(client, httpRequest) {
-    __privateAdd$5(this, _client2$4, void 0);
-    __privateAdd$5(this, _httpRequest2$5, void 0);
-    __privateSet$5(this, _client2$4, client);
-    __privateSet$5(this, _httpRequest2$5, httpRequest);
+    __privateAdd$4(this, _client2$3, void 0);
+    __privateAdd$4(this, _httpRequest2$4, void 0);
+    __privateSet$4(this, _client2$3, client);
+    __privateSet$4(this, _httpRequest2$4, httpRequest);
   }
   upload(assetType, body, options) {
-    const observable = _upload(__privateGet$5(this, _client2$4), __privateGet$5(this, _httpRequest2$5), assetType, body, options);
+    const observable = _upload(__privateGet$4(this, _client2$3), __privateGet$4(this, _httpRequest2$4), assetType, body, options);
     return lastValueFrom(observable.pipe(filter(event => event.type === "response"), map(event => event.body.document)));
   }
 }
-_client2$4 = new WeakMap();
-_httpRequest2$5 = new WeakMap();
+_client2$3 = new WeakMap();
+_httpRequest2$4 = new WeakMap();
 function _upload(client, httpRequest, assetType, body) {
   let opts = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
   validateAssetType(assetType);
@@ -924,78 +915,7 @@ function optionsFromFile(opts, file) {
     contentType: file.type
   }, opts);
 }
-var __accessCheck$4 = (obj, member, msg) => {
-  if (!member.has(obj)) throw TypeError("Cannot " + msg);
-};
-var __privateGet$4 = (obj, member, getter) => {
-  __accessCheck$4(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd$4 = (obj, member, value) => {
-  if (member.has(obj)) throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
-var __privateSet$4 = (obj, member, value, setter) => {
-  __accessCheck$4(obj, member, "write to private field");
-  setter ? setter.call(obj, value) : member.set(obj, value);
-  return value;
-};
-var _client$3, _httpRequest$4, _client2$3, _httpRequest2$4;
-class ObservableAuthClient {
-  constructor(client, httpRequest) {
-    __privateAdd$4(this, _client$3, void 0);
-    __privateAdd$4(this, _httpRequest$4, void 0);
-    __privateSet$4(this, _client$3, client);
-    __privateSet$4(this, _httpRequest$4, httpRequest);
-  }
-  /**
-   * Fetch available login providers
-   */
-  getLoginProviders() {
-    return _request(__privateGet$4(this, _client$3), __privateGet$4(this, _httpRequest$4), {
-      uri: "/auth/providers"
-    });
-  }
-  /**
-   * Revoke the configured session/token
-   */
-  logout() {
-    return _request(__privateGet$4(this, _client$3), __privateGet$4(this, _httpRequest$4), {
-      uri: "/auth/logout",
-      method: "POST"
-    });
-  }
-}
-_client$3 = new WeakMap();
-_httpRequest$4 = new WeakMap();
-class AuthClient {
-  constructor(client, httpRequest) {
-    __privateAdd$4(this, _client2$3, void 0);
-    __privateAdd$4(this, _httpRequest2$4, void 0);
-    __privateSet$4(this, _client2$3, client);
-    __privateSet$4(this, _httpRequest2$4, httpRequest);
-  }
-  /**
-   * Fetch available login providers
-   */
-  getLoginProviders() {
-    return lastValueFrom(_request(__privateGet$4(this, _client2$3), __privateGet$4(this, _httpRequest2$4), {
-      uri: "/auth/providers"
-    }));
-  }
-  /**
-   * Revoke the configured session/token
-   */
-  logout() {
-    return lastValueFrom(_request(__privateGet$4(this, _client2$3), __privateGet$4(this, _httpRequest2$4), {
-      uri: "/auth/logout",
-      method: "POST"
-    }));
-  }
-}
-_client2$3 = new WeakMap();
-_httpRequest2$4 = new WeakMap();
-const BASE_URL = "https://docs.sanity.io/help/";
+const BASE_URL = "https://www.sanity.io/help/";
 function generateHelpUrl(slug) {
   return BASE_URL + slug;
 }
@@ -1019,7 +939,7 @@ once(function () {
   }
   return console.warn(message.join(" "), ...args);
 });
-const printCdnWarning = createWarningPrinter(["You are not using the Sanity CDN. That means your data is always fresh, but the CDN is faster and", "cheaper. Think about it! For more info, see ".concat(generateHelpUrl("js-client-cdn-configuration"), "."), "To hide this warning, please set the `useCdn` option to either `true` or `false` when creating", "the client."]);
+const printCdnWarning = createWarningPrinter(["You are not using the Sanity CDN. That means your data is always fresh, but the CDN is faster and", "cheaper. Think about it! For more info, see ".concat(generateHelpUrl("js-client-cdn-configuration"), " "), "To hide this warning, please set the `useCdn` option to either `true` or `false` when creating", "the client."]);
 const printBrowserTokenWarning = createWarningPrinter(["You have configured Sanity client to use a token in the browser. This may cause unintentional security issues.", "See ".concat(generateHelpUrl("js-client-browser-token"), " for more information and how to hide this warning.")]);
 const printNoApiVersionSpecifiedWarning = createWarningPrinter(["Using the Sanity client without specifying an API version is deprecated.", "See ".concat(generateHelpUrl("js-client-api-version"))]);
 const defaultCdnHost = "apicdn.sanity.io";
@@ -1497,10 +1417,13 @@ const _ObservableSanityClient = class {
      */
     __privateAdd(this, _clientConfig, void 0);
     __privateAdd(this, _httpRequest, void 0);
+    /**
+     * Instance properties
+     */
+    this.listen = _listen;
     this.config(config);
     __privateSet(this, _httpRequest, httpRequest);
     this.assets = new ObservableAssetsClient(this, __privateGet(this, _httpRequest));
-    this.auth = new ObservableAuthClient(this, __privateGet(this, _httpRequest));
     this.datasets = new ObservableDatasetsClient(this, __privateGet(this, _httpRequest));
     this.projects = new ObservableProjectsClient(this, __privateGet(this, _httpRequest));
     this.users = new ObservableUsersClient(this, __privateGet(this, _httpRequest));
@@ -1551,7 +1474,7 @@ const _ObservableSanityClient = class {
    * Fetch multiple documents in one request.
    * Should be used sparingly - performing a query is usually a better option.
    * The order/position of documents is preserved based on the original array of IDs.
-   * If a any of the documents are missing, they will be replaced by a `null` entry in the returned array
+   * If any of the documents are missing, they will be replaced by a `null` entry in the returned array
    *
    * @param ids - Document IDs to fetch
    * @param options - Request options
@@ -1619,7 +1542,6 @@ const _SanityClient = class {
     this.config(config);
     __privateSet(this, _httpRequest2, httpRequest);
     this.assets = new AssetsClient(this, __privateGet(this, _httpRequest2));
-    this.auth = new AuthClient(this, __privateGet(this, _httpRequest2));
     this.datasets = new DatasetsClient(this, __privateGet(this, _httpRequest2));
     this.projects = new ProjectsClient(this, __privateGet(this, _httpRequest2));
     this.users = new UsersClient(this, __privateGet(this, _httpRequest2));
@@ -1674,7 +1596,7 @@ const _SanityClient = class {
    * Fetch multiple documents in one request.
    * Should be used sparingly - performing a query is usually a better option.
    * The order/position of documents is preserved based on the original array of IDs.
-   * If a any of the documents are missing, they will be replaced by a `null` entry in the returned array
+   * If any of the documents are missing, they will be replaced by a `null` entry in the returned array
    *
    * @param ids - Document IDs to fetch
    * @param options - Request options