@sanity/client 5.0.0-esm.13 → 5.0.0-esm.15

package/README.md

@@ -98,7 +98,7 @@ export async function updateDocumentTitle(_id, title) {
 
 Sanity Client transpiles syntax for [modern browsers]. The JavaScript runtime must support ES6 features such as [class](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes), [rest parameters](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/rest_parameters), [spread syntax](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax) and more. Most modern web frameworks, [browsers][modern browsers], and developer tooling supports ES6 today.
 
-For legacy ES5 environments you'll need to transpile `@sanity/client` and its `dependencies` with your own bundler, and have a global ES6-compliant `Promise` available. If your runtime environment doesn't provide a spec compliant `Promise` implementation, we recommend using [native-promise-only](https://www.npmjs.com/package/native-promise-only), [es6-promise](https://www.npmjs.com/package/es6-promise) or another [spec-compliant](https://promisesaplus.com/implementations) implementation. See [this article](https://www.sanity.io/help/js-client-promise-polyfill) for more information.
+[For legacy ES5 environments we recommend v4.](https://github.com/sanity-io/client/tree/v4.0.0#sanityclient)
 
 ## Installation
 
@@ -1157,6 +1157,65 @@ client.createIfNotExists(doc, options)
 client.createOrReplace(doc, options)
 ```
 
+### `client.patch.replace` is removed, replace with `client.createOrReplace`<!-- omit in toc -->
+
+Before:
+
+```ts
+import createClient from '@sanity/client'
+const client = createClient()
+
+client.patch('tropic-hab').replace({name: 'Tropical Habanero', ingredients: []}).commit()
+```
+
+After:
+
+```ts
+import {createClient} from '@sanity/client'
+const client = createClient()
+
+client.createOrReplace({
+  _id: 'tropic-hab',
+  _type: 'hotsauce',
+  name: 'Tropical Habanero',
+  ingredients: [],
+})
+```
+
+### `client.auth` is removed, replace with `client.request`<!-- omit in toc -->
+
+Before:
+
+```ts
+import createClient from '@sanity/client'
+const client = createClient()
+
+/**
+ * Fetch available login providers
+ */
+const loginProviders = await client.auth.getLoginProviders()
+/**
+ * Revoke the configured session/token
+ */
+await client.auth.logout()
+```
+
+After:
+
+```ts
+import {createclient, type AuthProviderResponse} from '@sanity/client'
+const client = createClient()
+
+/**
+ * Fetch available login providers
+ */
+const loginProviders = await client.request<AuthProviderResponse>({uri: '/auth/providers'})
+/**
+ * Revoke the configured session/token
+ */
+await client.request<void>({uri: '/auth/logout', method: 'POST'})
+```
+
 [modern browsers]: https://browsersl.ist/#q=%3E+0.2%25+and+supports+es6-module+and+supports+es6-module-dynamic-import+and+not+dead+and+not+IE+11
 [Deno]: https://deno.land/
 [Edge Runtime]: https://edge-runtime.vercel.sh/

package/dist/index.browser.cjs

@@ -189,60 +189,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()`
@@ -396,8 +386,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
@@ -405,10 +395,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";
@@ -416,18 +406,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
@@ -435,10 +425,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";
@@ -446,30 +436,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
 };
@@ -568,20 +558,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 || {}));
   }
@@ -594,7 +584,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");
       }
@@ -611,24 +601,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 || {}));
   }
@@ -641,7 +631,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");
       }
@@ -658,7 +648,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;
@@ -830,50 +820,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 rxjs.lastValueFrom(observable.pipe(operators.filter(event => event.type === "response"), operators.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);
@@ -927,77 +917,6 @@ 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 rxjs.lastValueFrom(_request(__privateGet$4(this, _client2$3), __privateGet$4(this, _httpRequest2$4), {
-      uri: "/auth/providers"
-    }));
-  }
-  /**
-   * Revoke the configured session/token
-   */
-  logout() {
-    return rxjs.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://www.sanity.io/help/";
 function generateHelpUrl(slug) {
   return BASE_URL + slug;
@@ -1500,10 +1419,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));
@@ -1622,7 +1544,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));