@sanity/client 5.0.0 → 5.2.0

package/dist/index.d.ts

@@ -503,6 +503,13 @@ export declare interface ListenOptions {
   tag?: string
 }
 
+/**
+ * @public
+ * @deprecated Use the named export `createClient` instead of the `default` export
+ */
+declare function migrationNotice(): void
+export default migrationNotice
+
 /** @internal */
 export declare interface MultipleMutationResult {
   transactionId: string
@@ -1171,6 +1178,20 @@ export declare class ObservableSanityClient {
    * @param options - Request options
    */
   request<R = FIXME>(options: RawRequestOptions): Observable<R>
+  /**
+   * 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
+  /**
+   * 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
 }
 
 /** @public */
@@ -1409,6 +1430,7 @@ export declare interface RequestOptions {
   method?: string
   query?: FIXME
   body?: FIXME
+  signal?: AbortSignal
 }
 
 /** @public */
@@ -1888,6 +1910,20 @@ export declare class SanityClient {
    * @param options - Request options
    */
   dataRequest(endpoint: string, body: unknown, options?: BaseMutationOptions): Promise<FIXME>
+  /**
+   * 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
+  /**
+   * 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
 }
 
 /** @internal */

package/dist/index.js

@@ -4,7 +4,7 @@ import { Observable, lastValueFrom } from 'rxjs';
 import { map, filter } from 'rxjs/operators';
 import polyfilledEventSource from '@sanity/eventsource';
 var name = "@sanity/client";
-var version = "5.0.0";
+var version = "5.2.0";
 const middleware = [debug({
   verbose: true,
   namespace: "sanity:client"
@@ -747,7 +747,8 @@ function _dataRequest(client, httpRequest, endpoint, body) {
     headers,
     token,
     tag,
-    canUseCdn: isQuery
+    canUseCdn: isQuery,
+    signal: options.signal
   };
   return _requestObservable(client, httpRequest, reqOptions).pipe(filter(isResponse), map(getBody), map(res => {
     if (!isMutation) {
@@ -794,9 +795,10 @@ function _requestObservable(client, httpRequest, options) {
   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));
@@ -818,6 +820,33 @@ function _getUrl(client, uri) {
   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);
 };
@@ -1523,6 +1552,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();
@@ -1656,12 +1703,33 @@ const _SanityClient = class {
   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(middleware);
 const requester = httpRequest.defaultRequester;
 const createClient = config => new SanityClient(httpRequest, config);
-export { BasePatch, BaseTransaction, ClientError, ObservablePatch, ObservableSanityClient, ObservableTransaction, Patch, SanityClient, ServerError, Transaction, createClient, requester };
+export { BasePatch, BaseTransaction, ClientError, ObservablePatch, ObservableSanityClient, ObservableTransaction, Patch, SanityClient, ServerError, Transaction, createClient, migrationNotice as default, requester };
 //# sourceMappingURL=index.js.map