@sanity/client 5.0.0 → 5.2.0

package/README.md

@@ -48,7 +48,7 @@ export async function updateDocumentTitle(_id, title) {
 }
 ```
 
-# Table of contents<!-- omit in toc -->
+# Table of contents
 
 - [QuickStart](#quickstart)
 - [Requirements](#requirements)
@@ -88,6 +88,7 @@ export async function updateDocumentTitle(_id, title) {
     - [Examples: Specify image metadata to extract](#examples-specify-image-metadata-to-extract)
   - [Deleting an asset](#deleting-an-asset)
   - [Mutation options](#mutation-options)
+  - [Aborting a request](#aborting-a-request)
   - [Get client configuration](#get-client-configuration)
   - [Set client configuration](#set-client-configuration)
 - [Release new version](#release-new-version)
@@ -846,6 +847,49 @@ The following options are available for mutations, and can be applied either as
 - `dryRun` (`true|false`) - default `false`. If true, the mutation will be a dry run - the response will be identical to the one returned had this property been omitted or false (including error responses) but no documents will be affected.
 - `autoGenerateArrayKeys` (`true|false`) - default `false`. If true, the mutation API will automatically add `_key` attributes to objects in arrays that is missing them. This makes array operations more robust by having a unique key within the array available for selections, which helps prevent race conditions in real-time, collaborative editing.
 
+### Aborting a request
+
+Requests can be aborted (or cancelled) in two ways:
+
+#### 1. Abort a request by passing an [AbortSignal] with the request options
+
+Sanity Client supports the [AbortController] API and supports receiving an abort signal that can be used to cancel the request. Here's an example that will abort the request if it takes more than 200ms to complete:
+
+```js
+const abortController = new AbortController()
+
+// note the lack of await here
+const request = getClient().fetch('*[_type == "movie"]', {}, {signal: abortController.signal})
+
+// this will abort the request after 200ms
+setTimeout(() => abortController.abort(), 200)
+
+try {
+  const response = await request
+  //…
+} catch (error) {
+  if (error.name === 'AbortError') {
+    console.log('Request was aborted')
+  } else {
+    // rethrow in case of other errors
+    throw error
+  }
+}
+```
+
+#### 2. Cancel a request by unsubscribing from the Observable
+
+When using the Observable API (e.g. `client.observable.fetch()`), you can cancel the request by simply `unsubscribe` from the returned observable:
+
+```js
+const subscription = client.observable.fetch('*[_type == "movie"]').subscribe((result) => {
+  /* do something with the result */
+})
+
+// this will cancel the request
+subscription.unsubscribe()
+```
+
 ### Get client configuration
 
 ```js
@@ -882,15 +926,15 @@ MIT © [Sanity.io](https://www.sanity.io/)
 
 ## From `v4`
 
-### No longer shipping `ES5`<!-- omit in toc -->
+### No longer shipping `ES5`
 
 The target is changed to [modern browsers] that supports `ES6` `class`, `{...rest}` syntax and more. You may need to update your bundler to a recent major version. Or you could configure your bundler to transpile `@sanity/client`, and `get-it`, which is the engine that powers `@sanity/client` and uses the same output target.
 
-### Node.js `v12` no longer supported<!-- omit in toc -->
+### Node.js `v12` no longer supported
 
 Upgrade to the [LTS release, or one of the Maintenance releases](https://github.com/nodejs/release#release-schedule).
 
-### The `default` export is replaced with the named export `createClient`<!-- omit in toc -->
+### The `default` export is replaced with the named export `createClient`
 
 Before:
 
@@ -911,7 +955,7 @@ import {createClient} from '@sanity/client'
 const client = createClient()
 ```
 
-### `client.assets.delete` is removed<!-- omit in toc -->
+### `client.assets.delete` is removed
 
 Before:
 
@@ -927,7 +971,7 @@ After:
 client.delete('image-abc123_foobar-123x123-png')
 ```
 
-### `client.assets.getImageUrl` is removed, replace with [`@sanity/image-url`](https://github.com/sanity-io/image-url)<!-- omit in toc -->
+### `client.assets.getImageUrl` is removed, replace with [`@sanity/image-url`](https://github.com/sanity-io/image-url)
 
 Before:
 
@@ -958,7 +1002,7 @@ urlFor({_ref: 'image-abc123_foobar-123x123-png'}).url()
 urlFor({_ref: 'image-abc123_foobar-123x123-png'}).auto('format').url()
 ```
 
-### `SanityClient` static properties moved to named exports<!-- omit in toc -->
+### `SanityClient` static properties moved to named exports
 
 Before:
 
@@ -974,7 +1018,7 @@ After:
 import {Patch, Transaction, ClientError, ServerError, requester} from '@sanity/client'
 ```
 
-### `client.clientConfig` is removed, replace with `client.config()`<!-- omit in toc -->
+### `client.clientConfig` is removed, replace with `client.config()`
 
 Before:
 
@@ -994,64 +1038,7 @@ const client = createClient()
 console.log(client.config().projectId)
 ```
 
-### `client.getUrl()` is removed<!-- omit in toc -->
-
-Before:
-
-```ts
-import createClient from '@sanity/client'
-const client = createClient({projectId: 'abc123'})
-
-console.log(client.getUrl('/foo/bar') === 'https://abc123.api.sanity.io/v1/foo/bar')
-console.log(client.getUrl('/foo/bar', true) === 'https://abc123.apicdn.sanity.io/v1/foo/bar')
-```
-
-After:
-
-```ts
-import {createClient} from '@sanity/client'
-const client = createClient({projectId: 'abc123'})
-
-const getUrl = (uri: string, useCdn = false) => {
-  const config = client.config()
-  const base = useCdn ? config.cdnUrl : config.url
-  return `${base}/${uri.replace(/^\//, '')}`
-}
-
-console.log(getUrl('/foo/bar') === 'https://abc123.api.sanity.io/v1/foo/bar')
-console.log(getUrl('/foo/bar', true) === 'https://abc123.apicdn.sanity.io/v1/foo/bar')
-```
-
-### `client.getDataUrl()` is removed<!-- omit in toc -->
-
-Before:
-
-```ts
-import createClient from '@sanity/client'
-const client = createClient({dataset: 'bikeshop'})
-
-console.log(client.getDataUrl('doc') === '/data/doc/bikeshop')
-console.log(client.getDataUrl('doc', 'bike-123') === '/data/doc/bikeshop/bike-123')
-```
-
-After:
-
-```ts
-import {createClient} from '@sanity/client'
-const client = createClient({dataset: 'bikeshop'})
-
-const getDataUrl = (operation: string, path?: string) => {
-  const {dataset} = client.config()
-  const baseUri = `/${operation}/${dataset}`
-  const uri = path ? `${baseUri}/${path}` : baseUri
-  return `/data${uri}`.replace(/\/($|\?)/, '$1')
-}
-
-console.log(getDataUrl('doc') === '/data/doc/bikeshop')
-console.log(getDataUrl('doc', 'bike-123') === '/data/doc/bikeshop/bike-123')
-```
-
-### `client.isPromiseAPI()` is removed, replace with an `instanceof` check<!-- omit in toc -->
+### `client.isPromiseAPI()` is removed, replace with an `instanceof` check
 
 Before:
 
@@ -1073,7 +1060,7 @@ const client = createClient()
 console.log(client instanceof SanityClient)
 ```
 
-### `client.observable.isObservableAPI()` is removed, replace with an `instanceof` check<!-- omit in toc -->
+### `client.observable.isObservableAPI()` is removed, replace with an `instanceof` check
 
 Before:
 
@@ -1093,7 +1080,7 @@ const client = createClient()
 console.log(client.observable instanceof ObservableSanityClient)
 ```
 
-### `client._requestObservable` is removed, replace with `client.observable.request`<!-- omit in toc -->
+### `client._requestObservable` is removed, replace with `client.observable.request`
 
 Before:
 
@@ -1113,7 +1100,7 @@ const client = createClient()
 client.observable.request({uri: '/ping'}).subscribe()
 ```
 
-### `client._dataRequest` is removed, replace with `client.dataRequest`<!-- omit in toc -->
+### `client._dataRequest` is removed, replace with `client.dataRequest`
 
 Before:
 
@@ -1133,7 +1120,7 @@ const client = createClient()
 client.dataRequest(endpoint, body, options)
 ```
 
-### `client._create_` is removed, replace with one of `client.create`, `client.createIfNotExists` or `client.createOrReplace`<!-- omit in toc -->
+### `client._create_` is removed, replace with one of `client.create`, `client.createIfNotExists` or `client.createOrReplace`
 
 Before:
 
@@ -1157,7 +1144,7 @@ client.createIfNotExists(doc, options)
 client.createOrReplace(doc, options)
 ```
 
-### `client.patch.replace` is removed, replace with `client.createOrReplace`<!-- omit in toc -->
+### `client.patch.replace` is removed, replace with `client.createOrReplace`
 
 Before:
 
@@ -1182,7 +1169,7 @@ client.createOrReplace({
 })
 ```
 
-### `client.auth` is removed, replace with `client.request`<!-- omit in toc -->
+### `client.auth` is removed, replace with `client.request`
 
 Before:
 
@@ -1234,3 +1221,5 @@ await client.request<void>({uri: '/auth/logout', method: 'POST'})
 [api-versioning]: http://sanity.io/docs/api-versioning
 [zod]: https://zod.dev/
 [groqd]: https://github.com/FormidableLabs/groqd#readme
+[AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
+[AbortController]: https://developer.mozilla.org/en-US/docs/Web/API/AbortController

package/dist/index.browser.cjs

@@ -749,7 +749,8 @@ function _dataRequest(client, httpRequest, endpoint, body) {
     headers,
     token,
     tag,
-    canUseCdn: isQuery
+    canUseCdn: isQuery,
+    signal: options.signal
   };
   return _requestObservable(client, httpRequest, reqOptions).pipe(operators.filter(isResponse), operators.map(getBody), operators.map(res => {
     if (!isMutation) {
@@ -796,9 +797,10 @@ function _requestObservable(client, httpRequest, options) {
   const reqOptions = getRequestOptions(config, Object.assign({}, options, {
     url: _getUrl(client, uri, useCdn)
   }));
-  return new rxjs.Observable(subscriber =>
+  const request = new rxjs.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));
+  return options.signal ? request.pipe(_withAbortSignal(options.signal)) : request;
 }
 function _request(client, httpRequest, options) {
   const observable = _requestObservable(client, httpRequest, options).pipe(operators.filter(event => event.type === "response"), operators.map(event => event.body));
@@ -820,6 +822,33 @@ function _getUrl(client, uri) {
   const base = canUseCdn ? cdnUrl : url;
   return "".concat(base, "/").concat(uri.replace(/^\//, ""));
 }
+function _withAbortSignal(signal) {
+  return input => {
+    return new rxjs.Observable(observer => {
+      const abort = () => observer.error(_createAbortError(signal));
+      if (signal && signal.aborted) {
+        abort();
+        return;
+      }
+      const subscription = input.subscribe(observer);
+      signal.addEventListener("abort", abort);
+      return () => {
+        signal.removeEventListener("abort", abort);
+        subscription.unsubscribe();
+      };
+    });
+  };
+}
+const isDomExceptionSupported = Boolean(globalThis.DOMException);
+function _createAbortError(signal) {
+  var _a, _b;
+  if (isDomExceptionSupported) {
+    return new DOMException((_a = signal == null ? void 0 : signal.reason) != null ? _a : "The operation was aborted.", "AbortError");
+  }
+  const error = new Error((_b = signal == null ? void 0 : signal.reason) != null ? _b : "The operation was aborted.");
+  error.name = "AbortError";
+  return error;
+}
 var __accessCheck$4 = (obj, member, msg) => {
   if (!member.has(obj)) throw TypeError("Cannot " + msg);
 };
@@ -1525,6 +1554,24 @@ const _ObservableSanityClient = class {
   request(options) {
     return _request(this, __privateGet(this, _httpRequest), options);
   }
+  /**
+   * Get a Sanity API URL for the URI provided
+   *
+   * @param uri - URI/path to build URL for
+   * @param canUseCdn - Whether or not to allow using the API CDN for this route
+   */
+  getUrl(uri, canUseCdn) {
+    return _getUrl(this, uri, canUseCdn);
+  }
+  /**
+   * Get a Sanity API URL for the data operation and path provided
+   *
+   * @param operation - Data operation (eg `query`, `mutate`, `listen` or similar)
+   * @param path - Path to append after the operation
+   */
+  getDataUrl(operation, path) {
+    return _getDataUrl(this, operation, path);
+  }
 };
 let ObservableSanityClient = _ObservableSanityClient;
 _clientConfig = new WeakMap();
@@ -1658,10 +1705,31 @@ const _SanityClient = class {
   dataRequest(endpoint, body, options) {
     return rxjs.lastValueFrom(_dataRequest(this, __privateGet(this, _httpRequest2), endpoint, body, options));
   }
+  /**
+   * Get a Sanity API URL for the URI provided
+   *
+   * @param uri - URI/path to build URL for
+   * @param canUseCdn - Whether or not to allow using the API CDN for this route
+   */
+  getUrl(uri, canUseCdn) {
+    return _getUrl(this, uri, canUseCdn);
+  }
+  /**
+   * Get a Sanity API URL for the data operation and path provided
+   *
+   * @param operation - Data operation (eg `query`, `mutate`, `listen` or similar)
+   * @param path - Path to append after the operation
+   */
+  getDataUrl(operation, path) {
+    return _getDataUrl(this, operation, path);
+  }
 };
 let SanityClient = _SanityClient;
 _clientConfig2 = new WeakMap();
 _httpRequest2 = new WeakMap();
+function migrationNotice() {
+  throw new TypeError("The default export of @sanity/client has been deprecated. Use the named export `createClient` instead");
+}
 const httpRequest = defineHttpRequest(envMiddleware);
 const requester = httpRequest.defaultRequester;
 const createClient = config => new SanityClient(httpRequest, config);
@@ -1676,5 +1744,6 @@ exports.SanityClient = SanityClient;
 exports.ServerError = ServerError;
 exports.Transaction = Transaction;
 exports.createClient = createClient;
+exports.default = migrationNotice;
 exports.requester = requester;
 //# sourceMappingURL=index.browser.cjs.map