@sanity/client 4.0.0-alpha.esm.6 → 4.0.1-0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 - 2022 Sanity.io
+Copyright (c) 2023 Sanity.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -2,7 +2,7 @@
 
 [![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 needs a [Promise polyfill](https://www.sanity.io/help/js-client-promise-polyfill)).
+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)).
 
 ## Requirements
 
@@ -19,17 +19,19 @@ npm install -g @sanity/client
 ## API
 
 ```js
-import {createClient} from '@sanity/client'
-const client = createClient({
+const sanityClient = require('@sanity/client')
+const client = sanityClient({
   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 client
 ```
 
-`const client = createClient(options)`
+`const client = sanityClient(options)`
 
 Initializes a new Sanity Client. Required options are `projectId`, `dataset`, and `apiVersion`. Setting a value for `useCdn` is encouraged.
 
@@ -37,7 +39,7 @@ Initializes a new Sanity Client. Required options are `projectId`, `dataset`, an
 
 Sanity uses ISO dates (YYYY-MM-DD) in UTC timezone for versioning. The explanation for this can be found [in the documentation](http://sanity.io/docs/api-versioning)
 
-In general, unless you know what API version you want to use, you'll want to set it to today's UTC date. By doing this, you'll get all the latest bugfixes and features, while locking the API to prevent breaking changes.
+In general, unless you know what API version you want to use, you'll want to statically set it to today's UTC date when starting a new project. By doing this, you'll get all the latest bugfixes and features, while locking the API to prevent breaking changes.
 
 **Note**: Do not be tempted to use a dynamic value for the `apiVersion`. The reason for setting a static value is to prevent unexpected, breaking changes.
 
@@ -260,13 +262,11 @@ client
 The operations of appending and prepending to an array are so common that they have been given their own methods for better readability:
 
 ```js
-import {nanoid} from 'nanoid'
-
 client
   .patch('bike-123')
   .setIfMissing({reviews: []})
-  .append('reviews', [{_key: nanoid(), title: 'Great bike!', stars: 5}])
-  .commit()
+  .append('reviews', [{title: 'Great bike!', stars: 5}])
+  .commit({autoGenerateArrayKeys: true})
 ```
 
 ### Deleting an element from an array
@@ -372,27 +372,27 @@ A `patch` can be performed inline on a `transaction`.
 Transactions and patches can also be built outside the scope of a client:
 
 ```js
-import {SanityClient} from '@sanity/client'
-const client = new SanityClient({
+const sanityClient = require('@sanity/client')
+const client = sanityClient({
   projectId: 'your-project-id',
   dataset: 'bikeshop',
 })
 
 // Patches:
-const patch = new SanityClient.Patch('<documentId>')
+const patch = new sanityClient.Patch('<documentId>')
 client.mutate(patch.inc({count: 1}).unset(['visits']))
 
 // Transactions:
-const transaction = new SanityClient.Transaction()
+const transaction = new sanityClient.Transaction()
   .create({_id: '123', name: 'FooBike'})
   .delete('someDocId')
 
 client.mutate(transaction)
 ```
 
-`const patch = new SanityClient.Patch(docId)`
+`const patch = new sanityClient.Patch(docId)`
 
-`const transaction = new SanityClient.Transaction()`
+`const transaction = new sanityClient.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()`
 
@@ -404,7 +404,7 @@ Assets can be uploaded using the `client.assets.upload(...)` method.
 client.assets.upload(type: 'file' | image', body: File | Blob | Buffer | NodeStream, options = {}): Promise<AssetDocument>
 ```
 
-👉 Read more about [assets in Sanity](https://sanity.io/docs/http-api/assets)
+👉 Read more about [assets in Sanity](https://sanity.io/docs/assets)
 
 #### Examples: Uploading assets from Node.js
 
@@ -531,6 +531,13 @@ client.config({dataset: 'newDataset'})
 
 Set client configuration. Required options are `projectId` and `dataset`.
 
+## Release new version
+
+Run ["CI & Release" workflow](https://github.com/sanity-io/client/actions/workflows/ci.yml).
+Make sure to select the main branch and check "Release new version".
+
+Semantic release will only release on configured branches, so it is safe to run release on any branch.
+
 ## License
 
 MIT © [Sanity.io](https://www.sanity.io/)