@sanity/client 5.0.0 → 5.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "5.0.0",
+  "version": "5.2.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -89,7 +89,6 @@
   },
   "dependencies": {
     "@sanity/eventsource": "^4",
-    "@types/node": "^18.11.18",
     "get-it": "^8",
     "rxjs": "^7"
   },
@@ -100,25 +99,26 @@
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@sanity/pkg-utils": "^2.2.3",
     "@sanity/semantic-release-preset": "^4.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.50.0",
-    "@typescript-eslint/parser": "^5.50.0",
-    "@vitest/coverage-c8": "^0.28.3",
+    "@types/node": "^18.13.0",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
+    "@vitest/coverage-c8": "^0.28.4",
     "eslint": "^8.33.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
-    "faucet": "^0.0.3",
-    "happy-dom": "^8.2.3",
+    "faucet": "^0.0.4",
+    "happy-dom": "^8.2.6",
     "ls-engines": "^0.9.0",
     "nock": "^13.3.0",
     "prettier": "^2.8.3",
     "prettier-plugin-packagejson": "^2.4.2",
     "rimraf": "^4.1.2",
-    "rollup": "^3.12.1",
+    "rollup": "^3.14.0",
     "sse-channel": "^4.0.0",
-    "terser": "^5.16.2",
+    "terser": "^5.16.3",
     "typescript": "^4.9.5",
-    "vitest": "^0.28.3",
+    "vitest": "^0.28.4",
     "vitest-github-actions-reporter": "^0.9.0"
   },
   "engines": {

package/src/SanityClient.ts

@@ -613,6 +613,26 @@ export class ObservableSanityClient {
   request<R = FIXME>(options: RawRequestOptions): Observable<R> {
     return dataMethods._request(this, 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: string, canUseCdn?: boolean): string {
+    return dataMethods._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: string, path?: string): string {
+    return dataMethods._getDataUrl(this, operation, path)
+  }
 }
 
 /** @public */
@@ -1210,4 +1230,24 @@ export class SanityClient {
   dataRequest(endpoint: string, body: unknown, options?: BaseMutationOptions): Promise<FIXME> {
     return lastValueFrom(dataMethods._dataRequest(this, this.#httpRequest, 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: string, canUseCdn?: boolean): string {
+    return dataMethods._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: string, path?: string): string {
+    return dataMethods._getDataUrl(this, operation, path)
+  }
 }

package/src/data/dataMethods.ts

@@ -1,4 +1,4 @@
-import {Observable} from 'rxjs'
+import {type MonoTypeOperatorFunction, Observable} from 'rxjs'
 import {filter, map} from 'rxjs/operators'
 
 import getRequestOptions from '../http/requestOptions'
@@ -224,6 +224,7 @@ export function _dataRequest(
     token,
     tag,
     canUseCdn: isQuery,
+    signal: options.signal,
   }
 
   return _requestObservable(client, httpRequest, reqOptions).pipe(
@@ -307,10 +308,12 @@ export function _requestObservable<R>(
     })
   ) as RequestOptions
 
-  return new Observable<HttpRequestEvent<R>>((subscriber) =>
+  const request = new Observable<HttpRequestEvent<R>>((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
 }
 
 /**
@@ -356,3 +359,50 @@ export function _getUrl(
   const base = canUseCdn ? cdnUrl : url
   return `${base}/${uri.replace(/^\//, '')}`
 }
+
+/**
+ * @internal
+ */
+function _withAbortSignal<T>(signal: AbortSignal): MonoTypeOperatorFunction<T> {
+  return (input) => {
+    return new 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()
+      }
+    })
+  }
+}
+// DOMException is supported on most modern browsers and Node.js 18+.
+// @see https://developer.mozilla.org/en-US/docs/Web/API/DOMException#browser_compatibility
+const isDomExceptionSupported = Boolean(globalThis.DOMException)
+
+/**
+ * @internal
+ * @param signal
+ * Original source copied from https://github.com/sindresorhus/ky/blob/740732c78aad97e9aec199e9871bdbf0ae29b805/source/errors/DOMException.ts
+ * TODO: When targeting Node.js 18, use `signal.throwIfAborted()` (https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/throwIfAborted)
+ */
+function _createAbortError(signal?: AbortSignal) {
+  /*
+  NOTE: Use DomException with AbortError name as specified in MDN docs (https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort)
+  > When abort() is called, the fetch() promise rejects with an Error of type DOMException, with name AbortError.
+  */
+  if (isDomExceptionSupported) {
+    return new DOMException(signal?.reason ?? 'The operation was aborted.', 'AbortError')
+  }
+
+  // DOMException not supported. Fall back to use of error and override name.
+  const error = new Error(signal?.reason ?? 'The operation was aborted.')
+  error.name = 'AbortError'
+
+  return error
+}

package/src/index.browser.ts

@@ -16,3 +16,5 @@ export const requester = httpRequest.defaultRequester
 
 /** @public */
 export const createClient = (config: ClientConfig) => new SanityClient(httpRequest, config)
+
+export {migrationNotice as default} from './migrationNotice'

package/src/index.ts

@@ -16,3 +16,5 @@ export const requester = httpRequest.defaultRequester
 
 /** @public */
 export const createClient = (config: ClientConfig) => new SanityClient(httpRequest, config)
+
+export {migrationNotice as default} from './migrationNotice'

package/src/migrationNotice.ts

@@ -0,0 +1,9 @@
+/**
+ * @public
+ * @deprecated Use the named export `createClient` instead of the `default` export
+ */
+export function migrationNotice() {
+  throw new TypeError(
+    'The default export of @sanity/client has been deprecated. Use the named export `createClient` instead'
+  )
+}

package/src/types.ts

@@ -15,6 +15,7 @@ export interface RequestOptions {
   method?: string
   query?: FIXME
   body?: FIXME
+  signal?: AbortSignal
 }
 
 /** @public */

package/umd/sanityClient.js

@@ -3840,7 +3840,8 @@
       headers,
       token,
       tag,
-      canUseCdn: isQuery
+      canUseCdn: isQuery,
+      signal: options.signal
     };
     return _requestObservable(client, httpRequest, reqOptions).pipe(filter(isResponse), map(getBody), map(res => {
       if (!isMutation) {
@@ -3887,9 +3888,10 @@
     const reqOptions = getRequestOptions(config, Object.assign({}, options, {
       url: _getUrl(client, uri, useCdn)
     }));
-    return new Observable(subscriber =>
+    const request = 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));
+    return options.signal ? request.pipe(_withAbortSignal(options.signal)) : request;
   }
   function _request(client, httpRequest, options) {
     const observable = _requestObservable(client, httpRequest, options).pipe(filter(event => event.type === "response"), map(event => event.body));
@@ -3911,6 +3913,33 @@
     const base = canUseCdn ? cdnUrl : url;
     return "".concat(base, "/").concat(uri.replace(/^\//, ""));
   }
+  function _withAbortSignal(signal) {
+    return input => {
+      return new 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);
   };
@@ -4616,6 +4645,24 @@
     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();
@@ -4749,10 +4796,31 @@
     dataRequest(endpoint, body, options) {
       return 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);
@@ -4768,6 +4836,9 @@
   exports.ServerError = ServerError;
   exports.Transaction = Transaction;
   exports.createClient = createClient;
+  exports.default = migrationNotice;
   exports.requester = requester;
 
+  Object.defineProperty(exports, '__esModule', { value: true });
+
 }));