@sanity/client 5.1.0 → 5.2.1

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)
@@ -925,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:
 
@@ -954,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:
 
@@ -970,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:
 
@@ -1001,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:
 
@@ -1017,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:
 
@@ -1037,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:
 
@@ -1116,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:
 
@@ -1136,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:
 
@@ -1156,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:
 
@@ -1176,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:
 
@@ -1200,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:
 
@@ -1225,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:
 

package/dist/index.browser.cjs

@@ -94,7 +94,7 @@ function defineHttpRequest(envMiddleware) {
   return httpRequest;
 }
 const projectHeader = "X-Sanity-Project-ID";
-var getRequestOptions = function (config) {
+function requestOptions(config) {
   let overrides = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   const headers = {};
   const token = overrides.token || config.token;
@@ -113,7 +113,7 @@ var getRequestOptions = function (config) {
     json: true,
     withCredentials
   });
-};
+}
 function getSelection(sel) {
   if (typeof sel === "string" || Array.isArray(sel)) {
     return {
@@ -189,7 +189,7 @@ const requestTag = tag => {
   }
   return tag;
 };
-var encodeQueryString = _ref => {
+const encodeQueryString = _ref => {
   let {
     query,
     params = {},
@@ -794,7 +794,7 @@ function _requestObservable(client, httpRequest, options) {
       ...options.query
     };
   }
-  const reqOptions = getRequestOptions(config, Object.assign({}, options, {
+  const reqOptions = requestOptions(config, Object.assign({}, options, {
     url: _getUrl(client, uri, useCdn)
   }));
   const request = new rxjs.Observable(subscriber =>
@@ -950,7 +950,7 @@ const BASE_URL = "https://www.sanity.io/help/";
 function generateHelpUrl(slug) {
   return BASE_URL + slug;
 }
-var once = fn => {
+function once(fn) {
   let didCall = false;
   let returnValue;
   return function () {
@@ -961,7 +961,7 @@ var once = fn => {
     didCall = true;
     return returnValue;
   };
-};
+}
 const createWarningPrinter = message =>
 // eslint-disable-next-line no-console
 once(function () {
@@ -973,6 +973,7 @@ once(function () {
 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 printNoDefaultExport = createWarningPrinter(["The default export of @sanity/client has been deprecated. Use the named export `createClient` instead"]);
 const defaultCdnHost = "apicdn.sanity.io";
 const defaultConfig = {
   apiHost: "https://api.sanity.io",
@@ -1042,7 +1043,7 @@ var defaults = (obj, defaults) => Object.keys(defaults).concat(Object.keys(obj))
   target[prop] = typeof obj[prop] === "undefined" ? defaults[prop] : obj[prop];
   return target;
 }, {});
-var pick = (obj, props) => props.reduce((selection, prop) => {
+const pick = (obj, props) => props.reduce((selection, prop) => {
   if (typeof obj[prop] === "undefined") {
     return selection;
   }
@@ -1554,6 +1555,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();
@@ -1687,16 +1706,35 @@ 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);
+function deprecatedCreateClient(config) {
+  printNoDefaultExport();
+  return new SanityClient(httpRequest, config);
+}
 exports.BasePatch = BasePatch;
 exports.BaseTransaction = BaseTransaction;
 exports.ClientError = ClientError;
@@ -1708,6 +1746,6 @@ exports.SanityClient = SanityClient;
 exports.ServerError = ServerError;
 exports.Transaction = Transaction;
 exports.createClient = createClient;
-exports.default = migrationNotice;
+exports.default = deprecatedCreateClient;
 exports.requester = requester;
 //# sourceMappingURL=index.browser.cjs.map