@sanity/client 3.3.0 → 3.3.3-next.0

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
 
@@ -260,13 +260,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
-const {nanoid} = require('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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "3.3.0",
+  "version": "3.3.3-next.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "main": "lib/sanityClient.js",
   "umd": "umd/sanityClient.min.js",
@@ -26,30 +26,30 @@
     "node": ">=12"
   },
   "dependencies": {
-    "@sanity/eventsource": "^3.0.2",
+    "@sanity/eventsource": "^4.0.0",
     "@sanity/generate-help-url": "^3.0.0",
-    "get-it": "^6.0.1",
+    "get-it": "^6.1.1",
     "make-error": "^1.3.0",
     "object-assign": "^4.1.1",
     "rxjs": "^6.0.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.17.6",
-    "@babel/core": "^7.17.7",
-    "@babel/preset-env": "^7.11.5",
+    "@babel/cli": "^7.18.10",
+    "@babel/core": "^7.18.10",
+    "@babel/preset-env": "^7.18.10",
     "browserify": "^17.0.0",
     "envify": "^4.0.0",
-    "eslint": "^8.11.0",
+    "eslint": "^8.21.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-config-sanity": "^5.1.0",
-    "nock": "^13.2.4",
+    "eslint-config-sanity": "^6.0.0",
+    "nock": "^13.2.9",
     "nyc": "^15.1.0",
-    "prettier": "^2.6.0",
+    "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
     "sse-channel": "^4.0.0",
-    "tape": "^5.5.2",
+    "tape": "^5.5.3",
     "terser": "^5.12.1",
-    "uglifyify": "^5.0.1",
+    "uglifyify": "^5.0.0",
     "xtend": "4.0.2"
   },
   "repository": {

package/sanityClient.d.ts

@@ -12,6 +12,7 @@ export type AssetMetadataType =
 export type DatasetAclMode = 'public' | 'private' | 'custom'
 export type ListenVisibility = 'sync' | 'async' | 'query'
 export type ListenEventName = 'mutation' | 'welcome' | 'reconnect'
+export type MutationOperation = 'create' | 'delete' | 'update' | 'none'
 
 export interface ResponseEvent<T = unknown> {
   type: 'response'
@@ -214,13 +215,13 @@ export type Mutation<R = any> =
 export interface SingleMutationResult {
   transactionId: string
   documentId: string
-  results: {id: string}[]
+  results: {id: string; operation: MutationOperation}[]
 }
 
 export interface MultipleMutationResult {
   transactionId: string
   documentIds: string[]
-  results: {id: string}[]
+  results: {id: string; operation: MutationOperation}[]
 }
 
 export class Patch {
@@ -379,6 +380,48 @@ export class Patch {
   reset(): this
 }
 
+export class ObservablePatch extends Patch {
+  /**
+   * Clones the patch
+   */
+  clone(): ObservablePatch
+
+  /**
+   * Commit the patch, returning an observable that produces the first patched document
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R = any>(options: FirstDocumentMutationOptions): Observable<SanityDocument<R>>
+
+  /**
+   * Commit the patch, returning an observable that produces an array of the mutated documents
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R = any>(options: AllDocumentsMutationOptions): Observable<SanityDocument<R>[]>
+
+  /**
+   * Commit the patch, returning an observable that produces a mutation result object
+   *
+   * @param options Options for the mutation operation
+   */
+  commit(options: FirstDocumentIdMutationOptions): Observable<SingleMutationResult>
+
+  /**
+   * Commit the patch, returning an observable that produces a mutation result object
+   *
+   * @param options Options for the mutation operation
+   */
+  commit(options: AllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
+
+  /**
+   * Commit the patch, returning an observable that produces the first patched document
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R = any>(options?: BaseMutationOptions): Observable<SanityDocument<R>>
+}
+
 export class Transaction {
   constructor(operations?: Mutation[], client?: SanityClient, transactionId?: string)
   clone(): Transaction
@@ -492,6 +535,45 @@ export class Transaction {
   reset(): this
 }
 
+export class ObservableTransaction extends Transaction {
+  clone(): ObservableTransaction
+
+  /**
+   * Commit the transaction, returning an observable that produces the first mutated document
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R>(options: TransactionFirstDocumentMutationOptions): Observable<SanityDocument<R>>
+
+  /**
+   * Commit the transaction, returning an observable that produces an array of the mutated documents
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R>(options: TransactionAllDocumentsMutationOptions): Observable<SanityDocument<R>[]>
+
+  /**
+   * Commit the transaction, returning an observable that produces a mutation result object
+   *
+   * @param options Options for the mutation operation
+   */
+  commit(options: TransactionFirstDocumentIdMutationOptions): Observable<SingleMutationResult>
+
+  /**
+   * Commit the transaction, returning an observable that produces a mutation result object
+   *
+   * @param options Options for the mutation operation
+   */
+  commit(options: TransactionAllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
+
+  /**
+   * Commit the transaction, returning an observable that produces a mutation result object
+   *
+   * @param options Options for the mutation operation
+   */
+  commit(options?: BaseMutationOptions): Observable<MultipleMutationResult>
+}
+
 export interface ClientConfig {
   projectId?: string
   dataset?: string
@@ -1384,14 +1466,14 @@ export class ObservableSanityClient {
    * @param documentId Document ID to patch
    * @param operations Optional object of patch operations to initialize the patch instance with
    */
-  patch(documentId: string | MutationSelection, operations?: PatchOperations): Patch
+  patch(documentId: string | MutationSelection, operations?: PatchOperations): ObservablePatch
 
   /**
    * Create a new transaction of mutations
    *
    * @param operations Optional array of mutation operations to initialize the transaction instance with
    */
-  transaction<R = any>(operations?: Mutation<R>[]): Transaction
+  transaction<R = any>(operations?: Mutation<R>[]): ObservableTransaction
 
   // "Internals", should generally not be used externally
   /**

package/test/listen.test.js

@@ -14,7 +14,7 @@ const getClient = (options) =>
       {
         dataset: 'prod',
         namespace: 'beerns',
-        apiHost: `http://localhost:${options.port}`,
+        apiHost: `http://127.0.0.1:${options.port}`,
         useProjectHostname: false,
         useCdn: false,
         apiVersion: '1',