@sanity/client 5.0.0-esm.2 → 5.0.0-esm.4

package/README.md

@@ -1,26 +1,93 @@
-# @sanity/client
+# @sanity/client<!-- omit in toc -->
 
+[![npm stat](https://img.shields.io/npm/dm/@sanity/client.svg?style=flat-square)](https://npm-stat.com/charts.html?package=@sanity/client)
 [![npm version](https://img.shields.io/npm/v/@sanity/client.svg?style=flat-square)](https://www.npmjs.com/package/@sanity/client)
-
-Javascript client for Sanity. Works in node.js and modern browsers (older browsers need a [Promise polyfill](https://www.sanity.io/help/js-client-promise-polyfill)).
+[![gzip size][gzip-badge]][unpkg-dist]
+[![size][size-badge]][unpkg-dist]
+
+Javascript client for Sanity. Works in [Node.js](https://nodejs.org/en/), [Bun], [Deno], [Edge Runtime] and [modern browsers].
+
+## Table of contents<!-- omit in toc -->
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [API](#api)
+  - [Creating a client instance](#creating-a-client-instance)
+    - [ESM](#esm)
+    - [CommonJS](#commonjs)
+    - [TypeScript](#typescript)
+    - [Bun](#bun)
+  - [Specifying API version](#specifying-api-version)
+  - [Performing queries](#performing-queries)
+  - [Listening to queries](#listening-to-queries)
+  - [Fetch a single document](#fetch-a-single-document)
+  - [Fetch multiple documents in one go](#fetch-multiple-documents-in-one-go)
+  - [Creating documents](#creating-documents)
+  - [Creating/replacing documents](#creatingreplacing-documents)
+  - [Creating if not already present](#creating-if-not-already-present)
+  - [Patch/update a document](#patchupdate-a-document)
+  - [Setting a field only if not already present](#setting-a-field-only-if-not-already-present)
+  - [Removing/unsetting fields](#removingunsetting-fields)
+  - [Incrementing/decrementing numbers](#incrementingdecrementing-numbers)
+  - [Patch a document only if revision matches](#patch-a-document-only-if-revision-matches)
+  - [Adding elements to an array](#adding-elements-to-an-array)
+  - [Appending/prepending elements to an array](#appendingprepending-elements-to-an-array)
+  - [Deleting an element from an array](#deleting-an-element-from-an-array)
+  - [Delete documents](#delete-documents)
+  - [Multiple mutations in a transaction](#multiple-mutations-in-a-transaction)
+  - [Clientless patches \& transactions](#clientless-patches--transactions)
+  - [Uploading assets](#uploading-assets)
+    - [Examples: Uploading assets from Node.js](#examples-uploading-assets-from-nodejs)
+    - [Examples: Uploading assets from the Browser](#examples-uploading-assets-from-the-browser)
+    - [Examples: Specify image metadata to extract](#examples-specify-image-metadata-to-extract)
+  - [Deleting an asset](#deleting-an-asset)
+  - [Mutation options](#mutation-options)
+  - [Get client configuration](#get-client-configuration)
+  - [Set client configuration](#set-client-configuration)
+- [Migrate](#migrate)
+  - [From `v4`](#from-v4)
+    - [No longer shipping `ES5`](#no-longer-shipping-es5)
+    - [Node.js `v12` no longer supported](#nodejs-v12-no-longer-supported)
+    - [The `default` export is replaced with the named export `createClient`](#the-default-export-is-replaced-with-the-named-export-createclient)
+    - [`client.assets.delete` is removed](#clientassetsdelete-is-removed)
+    - [`client.assets.getImageUrl` is removed, replace with `@sanity/image-url`](#clientassetsgetimageurl-is-removed-replace-with-sanityimage-url)
+    - [`SanityClient` static properties moved to named exports](#sanityclient-static-properties-moved-to-named-exports)
+    - [`client.clientConfig` is removed, replace with `client.config()`](#clientclientconfig-is-removed-replace-with-clientconfig)
+    - [`client.getUrl()` is removed](#clientgeturl-is-removed)
+    - [`client.getDataUrl()` is removed](#clientgetdataurl-is-removed)
+    - [`client.isPromiseAPI()` is removed, replace with `instanceof` check](#clientispromiseapi-is-removed-replace-with-instanceof-check)
+    - [`client.observable.isObservableAPI()` is removed, replace with `instanceof` check](#clientobservableisobservableapi-is-removed-replace-with-instanceof-check)
+    - [`client._requestObservable` is removed, replace with `client.observable.request`](#client_requestobservable-is-removed-replace-with-clientobservablerequest)
+    - [`client._dataRequest` is removed, replace with `client.dataRequest`](#client_datarequest-is-removed-replace-with-clientdatarequest)
+    - [`client._create_` is removed, replace with one of `client.create`, `client.createIfNotExists` or `client.createOrReplace`](#client_create_-is-removed-replace-with-one-of-clientcreate-clientcreateifnotexists-or-clientcreateorreplace)
+- [Release new version](#release-new-version)
+- [License](#license)
 
 ## Requirements
 
-Sanity Client requires the JavaScript runtime to 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.
+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. For 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.
 
 ## Installation
 
 The client can be installed from npm:
 
 ```
-npm install -g @sanity/client
+npm install @sanity/client
 ```
 
 ## API
 
+### Creating a client instance
+
+`const client = createClient(options)`
+
+Initializes a new Sanity Client. Required options are `projectId`, `dataset`, and `apiVersion`. Setting a value for `useCdn` is encouraged.
+
+#### [ESM](https://hacks.mozilla.org/2018/03/es-modules-a-cartoon-deep-dive/)
+
 ```js
-const sanityClient = require('@sanity/client')
-const client = sanityClient({
+import {createClient} from '@sanity/client'
+const client = createClient({
   projectId: 'your-project-id',
   dataset: 'bikeshop',
   apiVersion: '2021-03-25', // use current UTC date - see "specifying API version"!
@@ -31,9 +98,56 @@ const client = sanityClient({
 export default client
 ```
 
-`const client = sanityClient(options)`
+#### [CommonJS](https://nodejs.org/api/modules.html#modules-commonjs-modules)
 
-Initializes a new Sanity Client. Required options are `projectId`, `dataset`, and `apiVersion`. Setting a value for `useCdn` is encouraged.
+```js
+const {createClient} = require('@sanity/client')
+const client = createClient({
+  projectId: 'your-project-id',
+  dataset: 'bikeshop',
+  apiVersion: '2021-03-25', // use current UTC date - see "specifying API version"!
+  token: 'sanity-auth-token', // or leave blank for unauthenticated usage
+  useCdn: true, // `false` if you want to ensure fresh data
+})
+
+module.exports = client
+```
+
+#### [TypeScript](https://www.typescriptlang.org/)
+
+```ts
+import {createClient, type ClientConfig} from '@sanity/client'
+
+const client: ClientConfig = {
+  projectId: 'your-project-id',
+  dataset: 'bikeshop',
+  apiVersion: '2021-03-25', // use current UTC date - see "specifying API version"!
+  token: 'sanity-auth-token', // or leave blank for unauthenticated usage
+  useCdn: true, // `false` if you want to ensure fresh data
+}
+
+export default createClient(config)
+```
+
+#### [Bun]
+
+```bash
+bun
+```
+
+```ts
+import {createClient, type ClientConfig} from '@sanity/client'
+
+const client: ClientConfig = {
+  projectId: 'your-project-id',
+  dataset: 'bikeshop',
+  apiVersion: '2021-03-25', // use current UTC date - see "specifying API version"!
+  token: 'sanity-auth-token', // or leave blank for unauthenticated usage
+  useCdn: true, // `false` if you want to ensure fresh data
+}
+
+export default createClient(config)
+```
 
 ### Specifying API version
 
@@ -372,27 +486,25 @@ A `patch` can be performed inline on a `transaction`.
 Transactions and patches can also be built outside the scope of a client:
 
 ```js
-const sanityClient = require('@sanity/client')
-const client = sanityClient({
+import {createClient, Patch, Transaction} from '@sanity/client'
+const client = createClient({
   projectId: 'your-project-id',
   dataset: 'bikeshop',
 })
 
 // Patches:
-const patch = new sanityClient.Patch('<documentId>')
+const patch = new Patch('<documentId>')
 client.mutate(patch.inc({count: 1}).unset(['visits']))
 
 // Transactions:
-const transaction = new sanityClient.Transaction()
-  .create({_id: '123', name: 'FooBike'})
-  .delete('someDocId')
+const transaction = new Transaction().create({_id: '123', name: 'FooBike'}).delete('someDocId')
 
 client.mutate(transaction)
 ```
 
-`const patch = new sanityClient.Patch(docId)`
+`const patch = new Patch(docId)`
 
-`const transaction = new sanityClient.Transaction()`
+`const transaction = new Transaction()`
 
 An important note on this approach is that you cannot call `commit()` on transactions or patches instantiated this way, instead you have to pass them to `client.mutate()`
 
@@ -531,6 +643,311 @@ client.config({dataset: 'newDataset'})
 
 Set client configuration. Required options are `projectId` and `dataset`.
 
+## Migrate
+
+### From `v4`
+
+#### 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
+
+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`
+
+Before:
+
+```ts
+import createClient from '@sanity/client'
+const client = createClient()
+```
+
+```ts
+import SanityClient from '@sanity/client'
+const client = new SanityClient()
+```
+
+After:
+
+```ts
+import {createClient} from '@sanity/client'
+const client = createClient()
+```
+
+---
+
+#### `client.assets.delete` is removed
+
+Before:
+
+```ts
+client.assets.delete('image', 'abc123_foobar-123x123-png')
+client.assets.delete('image', 'image-abc123_foobar-123x123-png')
+client.assets.delete({_id: 'image-abc123_foobar-123x123-png'})
+```
+
+After:
+
+```ts
+client.delete('image-abc123_foobar-123x123-png')
+```
+
+---
+
+#### `client.assets.getImageUrl` is removed, replace with [`@sanity/image-url`](https://github.com/sanity-io/image-url)
+
+Before:
+
+```ts
+import {createClient} from '@sanity/client'
+const client = createClient({projectId: 'abc123', dataset: 'foo'})
+
+client.assets.getImageUrl('image-abc123_foobar-123x123-png')
+client.assets.getImageUrl('image-abc123_foobar-123x123-png', {auto: 'format'})
+client.assets.getImageUrl({_ref: 'image-abc123_foobar-123x123-png'})
+client.assets.getImageUrl({_ref: 'image-abc123_foobar-123x123-png'}, {auto: 'format'})
+```
+
+After:
+
+```bash
+npm install @sanity/image-url
+```
+
+```ts
+import imageUrlBuilder from '@sanity/image-url'
+const builder = imageUrlBuilder({projectId: 'abc123', dataset: 'foo'})
+const urlFor = (source) => builder.image(source)
+
+urlFor('image-abc123_foobar-123x123-png').url()
+urlFor('image-abc123_foobar-123x123-png').auto('format').url()
+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
+
+Before:
+
+```ts
+import SanityClient from '@sanity/client'
+
+const {Patch, Transaction, ClientError, ServerError, requester} = SanityClient
+```
+
+After:
+
+```ts
+import {Patch, Transaction, ClientError, ServerError, requester} from '@sanity/client'
+```
+
+---
+
+#### `client.clientConfig` is removed, replace with `client.config()`
+
+Before:
+
+```ts
+import createClient from '@sanity/client'
+const client = createClient()
+
+console.log(client.clientConfig.projectId)
+```
+
+After:
+
+```ts
+import {createClient} from '@sanity/client'
+const client = createClient()
+
+console.log(client.config().projectId)
+```
+
+---
+
+#### `client.getUrl()` is removed
+
+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
+
+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 `instanceof` check
+
+Before:
+
+```ts
+import createClient from '@sanity/client'
+const client = createClient()
+
+console.log(client.isPromiseAPI())
+console.log(client.clientConfig.isPromiseAPI)
+console.log(client.config().isPromiseAPI)
+```
+
+After:
+
+```ts
+import {createClient, SanityClient} from '@sanity/client'
+const client = createClient()
+
+console.log(client instanceof SanityClient)
+```
+
+---
+
+#### `client.observable.isObservableAPI()` is removed, replace with `instanceof` check
+
+Before:
+
+```ts
+import createClient from '@sanity/client'
+const client = createClient()
+
+console.log(client.observable.isObservableAPI())
+```
+
+After:
+
+```ts
+import {createClient, ObservableSanityClient} from '@sanity/client'
+const client = createClient()
+
+console.log(client.observable instanceof ObservableSanityClient)
+```
+
+---
+
+#### `client._requestObservable` is removed, replace with `client.observable.request`
+
+Before:
+
+```ts
+import createClient from '@sanity/client'
+const client = createClient()
+
+client._requestObservable({uri: '/ping'}).subscribe()
+```
+
+After:
+
+```ts
+import {createClient} from '@sanity/client'
+const client = createClient()
+
+client.observable.request({uri: '/ping'}).subscribe()
+```
+
+---
+
+#### `client._dataRequest` is removed, replace with `client.dataRequest`
+
+Before:
+
+```ts
+import createClient from '@sanity/client'
+const client = createClient()
+
+client._dataRequest(endpoint, body, options)
+```
+
+After:
+
+```ts
+import {createClient} from '@sanity/client'
+const client = createClient()
+
+client.dataRequest(endpoint, body, options)
+```
+
+---
+
+#### `client._create_` is removed, replace with one of `client.create`, `client.createIfNotExists` or `client.createOrReplace`
+
+Before:
+
+```ts
+import createClient from '@sanity/client'
+const client = createClient()
+
+client._create(doc, 'create', options)
+client._create(doc, 'createIfNotExists', options)
+client._create(doc, 'createOrReplace', options)
+```
+
+After:
+
+```ts
+import {createClient} from '@sanity/client'
+const client = createClient()
+
+client.create(doc, options)
+client.createIfNotExists(doc, options)
+client.createOrReplace(doc, options)
+```
+
+---
+
 ## Release new version
 
 Run ["CI & Release" workflow](https://github.com/sanity-io/client/actions/workflows/ci.yml).
@@ -541,3 +958,11 @@ Semantic release will only release on configured branches, so it is safe to run
 ## License
 
 MIT © [Sanity.io](https://www.sanity.io/)
+
+[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/
+[Bun]: https://bun.sh/
+[gzip-badge]: https://img.shields.io/bundlephobia/minzip/@sanity/client?label=gzip%20size&style=flat-square
+[size-badge]: https://img.shields.io/bundlephobia/min/@sanity/client?label=size&style=flat-square
+[unpkg-dist]: https://unpkg.com/@sanity/client/umd/