@sanity/client 6.19.0 → 6.19.2

package/README.md

@@ -101,6 +101,15 @@ export async function updateDocumentTitle(_id, title) {
     - [2. Cancel a request by unsubscribing from the Observable](#2-cancel-a-request-by-unsubscribing-from-the-observable)
   - [Get client configuration](#get-client-configuration)
   - [Set client configuration](#set-client-configuration)
+  - [Server Side Actions](#server-side-actions)
+    - [Action options](#action-options)
+    - [Create Action](#create-action)
+    - [Delete Action](#delete-action)
+    - [Discard Action](#discard-action)
+    - [Edit Action](#edit-action)
+    - [Publish Action](#publish-action)
+    - [ReplaceDraft Action](#replacedraft-action)
+    - [Unpublish Action](#unpublish-action)
 - [License](#license)
 - [From `v5`](#from-v5)
   - [The default `useCdn` is changed to `true`](#the-default-usecdn-is-changed-to-true)
@@ -1148,6 +1157,176 @@ client.mutate(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()`
 
+### Server Side Actions
+
+The Server Side Actions API provides a new interface for creating, updating and publishing documents. It is a wrapper around the [Server Side Actions API](https://www.sanity.io/docs/http-actions).
+
+This API is only available from API version `v2024-05-23`.
+
+#### Action options
+
+The following options are available for actions, and can be applied as the second argument to `action()`.
+
+- `transactionId`: If set, this ID is as transaction ID for the action instead of using an autogenerated one.
+- `dryRun` (`true|false`) - default `false`. If true, the mutation will be a dry run - the response will be identical to the one returned had this property been omitted or false (including error responses) but no documents will be affected.
+- `skipCrossDatasetReferenceValidation` (`true|false`) - default `false`. If true, the mutation will be skipped validation of cross dataset references. This is useful when you are creating a document that references a document in a different dataset, and you want to skip the validation to avoid an error.
+
+#### Create Action
+
+A document draft can be created by specifying a create action type:
+
+```js
+client
+  .action(
+    {
+      actionType: 'sanity.action.document.create',
+      publishedId: 'bike-123',
+      attributes: {name: 'Sanity Tandem Extraordinaire', _type: 'bike', seats: 1},
+      ifExists: 'fail',
+    },
+    actionOptions,
+  )
+  .then(() => {
+    console.log('Bike draft created')
+  })
+  .catch((err) => {
+    console.error('Create draft failed: ', err.message)
+  })
+```
+
+#### Delete Action
+
+A published document can be deleted by specifying a delete action type, optionally including some drafts:
+
+```js
+client
+  .action(
+    {
+      actionType: 'sanity.action.document.delete',
+      publishedId: 'bike-123',
+      includeDrafts: ['draft.bike-123'],
+    },
+    actionOptions,
+  )
+  .then(() => {
+    console.log('Bike deleted')
+  })
+  .catch((err) => {
+    console.error('Delete failed: ', err.message)
+  })
+```
+
+#### Discard Action
+
+A draft document can be deleted by specifying a discard action type:
+
+```js
+client
+  .action(
+    {
+      actionType: 'sanity.action.document.discard',
+      draftId: 'draft.bike-123',
+    },
+    actionOptions,
+  )
+  .then(() => {
+    console.log('Bike draft deleted')
+  })
+  .catch((err) => {
+    console.error('Discard failed: ', err.message)
+  })
+```
+
+#### Edit Action
+
+A patch can be applied to an existing document draft or create a new one by specifying an edit action type:
+
+```js
+client
+  .action(
+    {
+      actionType: 'sanity.action.document.edit',
+      publishedId: 'bike-123',
+      attributes: {name: 'Sanity Tandem Extraordinaire', _type: 'bike', seats: 2},
+    },
+    actionOptions,
+  )
+  .then(() => {
+    console.log('Bike draft edited')
+  })
+  .catch((err) => {
+    console.error('Edit draft failed: ', err.message)
+  })
+```
+
+#### Publish Action
+
+A draft document can be published by specifying a publish action type, optionally with revision ID checks:
+
+```js
+client
+  .action(
+    {
+      actionType: 'sanity.action.document.publish',
+      draftId: 'draft.bike-123',
+      ifDraftRevisionId: '<previously-known-revision>',
+      publishedId: 'bike-123',
+      ifPublishedRevisionId: '<previously-known-revision>',
+    },
+    actionOptions,
+  )
+  .then(() => {
+    console.log('Bike draft published')
+  })
+  .catch((err) => {
+    console.error('Publish draft failed: ', err.message)
+  })
+```
+
+#### ReplaceDraft Action
+
+An existing document draft can be deleted and replaced by a new one by specifying a replaceDraft action type:
+
+```js
+client
+  .action(
+    {
+      actionType: 'sanity.action.document.replaceDraft',
+      publishedId: 'bike-123',
+      attributes: {name: 'Sanity Tandem Extraordinaire', _type: 'bike', seats: 1},
+    },
+    actionOptions,
+  )
+  .then(() => {
+    console.log('Bike draft replaced')
+  })
+  .catch((err) => {
+    console.error('Replace draft failed: ', err.message)
+  })
+```
+
+#### Unpublish Action
+
+A published document can be retracted by specifying an unpublish action type:
+
+```js
+client
+  .action(
+    {
+      actionType: 'sanity.action.document.unpublish',
+      draftId: 'draft.bike-123',
+      publishedId: 'bike-123',
+    },
+    actionOptions,
+  )
+  .then(() => {
+    console.log('Bike draft unpublished')
+  })
+  .catch((err) => {
+    console.error('Unpublish draft failed: ', err.message)
+  })
+```
+
 ### Uploading assets
 
 Assets can be uploaded using the `client.assets.upload(...)` method.

package/dist/index.browser.d.cts

@@ -598,7 +598,7 @@ export declare type DeleteAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -623,7 +623,7 @@ export declare type DiscardAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -1951,7 +1951,7 @@ export declare type PublishAction = {
   /**
    * Draft revision ID to match
    */
-  ifDraftRevisionId: string
+  ifDraftRevisionId?: string
   /**
    * Published document ID to replace
    */
@@ -1959,7 +1959,7 @@ export declare type PublishAction = {
   /**
    * Published revision ID to match
    */
-  ifPublishedRevisionId: string
+  ifPublishedRevisionId?: string
 }
 
 /** @public */
@@ -2065,10 +2065,6 @@ export declare type ReconnectEvent = {
  */
 export declare type ReplaceDraftAction = {
   actionType: 'sanity.action.document.replaceDraft'
-  /**
-   * Draft document ID to replace, if it exists.
-   */
-  draftId: string
   /**
    * Published document ID to create draft from, if draft does not exist
    */

package/dist/index.browser.d.ts

@@ -598,7 +598,7 @@ export declare type DeleteAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -623,7 +623,7 @@ export declare type DiscardAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -1951,7 +1951,7 @@ export declare type PublishAction = {
   /**
    * Draft revision ID to match
    */
-  ifDraftRevisionId: string
+  ifDraftRevisionId?: string
   /**
    * Published document ID to replace
    */
@@ -1959,7 +1959,7 @@ export declare type PublishAction = {
   /**
    * Published revision ID to match
    */
-  ifPublishedRevisionId: string
+  ifPublishedRevisionId?: string
 }
 
 /** @public */
@@ -2065,10 +2065,6 @@ export declare type ReconnectEvent = {
  */
 export declare type ReplaceDraftAction = {
   actionType: 'sanity.action.document.replaceDraft'
-  /**
-   * Draft document ID to replace, if it exists.
-   */
-  draftId: string
   /**
    * Published document ID to create draft from, if draft does not exist
    */

package/dist/index.cjs

@@ -1534,7 +1534,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var name = "@sanity/client", version = "6.19.0";
+var name = "@sanity/client", version = "6.19.2";
 const middleware = [
   middleware$1.debug({ verbose: !0, namespace: "sanity:client" }),
   middleware$1.headers({ "User-Agent": `${name} ${version}` }),

package/dist/index.d.cts

@@ -598,7 +598,7 @@ export declare type DeleteAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -623,7 +623,7 @@ export declare type DiscardAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -1951,7 +1951,7 @@ export declare type PublishAction = {
   /**
    * Draft revision ID to match
    */
-  ifDraftRevisionId: string
+  ifDraftRevisionId?: string
   /**
    * Published document ID to replace
    */
@@ -1959,7 +1959,7 @@ export declare type PublishAction = {
   /**
    * Published revision ID to match
    */
-  ifPublishedRevisionId: string
+  ifPublishedRevisionId?: string
 }
 
 /** @public */
@@ -2065,10 +2065,6 @@ export declare type ReconnectEvent = {
  */
 export declare type ReplaceDraftAction = {
   actionType: 'sanity.action.document.replaceDraft'
-  /**
-   * Draft document ID to replace, if it exists.
-   */
-  draftId: string
   /**
    * Published document ID to create draft from, if draft does not exist
    */

package/dist/index.d.ts

@@ -598,7 +598,7 @@ export declare type DeleteAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -623,7 +623,7 @@ export declare type DiscardAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -1951,7 +1951,7 @@ export declare type PublishAction = {
   /**
    * Draft revision ID to match
    */
-  ifDraftRevisionId: string
+  ifDraftRevisionId?: string
   /**
    * Published document ID to replace
    */
@@ -1959,7 +1959,7 @@ export declare type PublishAction = {
   /**
    * Published revision ID to match
    */
-  ifPublishedRevisionId: string
+  ifPublishedRevisionId?: string
 }
 
 /** @public */
@@ -2065,10 +2065,6 @@ export declare type ReconnectEvent = {
  */
 export declare type ReplaceDraftAction = {
   actionType: 'sanity.action.document.replaceDraft'
-  /**
-   * Draft document ID to replace, if it exists.
-   */
-  draftId: string
   /**
    * Published document ID to create draft from, if draft does not exist
    */

package/dist/index.js

@@ -1517,7 +1517,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var name = "@sanity/client", version = "6.19.0";
+var name = "@sanity/client", version = "6.19.2";
 const middleware = [
   debug({ verbose: !0, namespace: "sanity:client" }),
   headers({ "User-Agent": `${name} ${version}` }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.19.0",
+  "version": "6.19.2",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -118,7 +118,7 @@
   },
   "dependencies": {
     "@sanity/eventsource": "^5.0.2",
-    "get-it": "^8.5.0",
+    "get-it": "^8.6.0",
     "rxjs": "^7.0.0"
   },
   "devDependencies": {
@@ -126,11 +126,11 @@
     "@edge-runtime/vm": "^3.2.0",
     "@rollup/plugin-commonjs": "^25.0.8",
     "@rollup/plugin-node-resolve": "^15.2.3",
-    "@sanity/pkg-utils": "^6.8.18",
+    "@sanity/pkg-utils": "^6.9.3",
     "@types/json-diff": "^1.0.3",
     "@types/node": "^20.8.8",
-    "@typescript-eslint/eslint-plugin": "^7.10.0",
-    "@typescript-eslint/parser": "^7.10.0",
+    "@typescript-eslint/eslint-plugin": "^7.12.0",
+    "@typescript-eslint/parser": "^7.12.0",
     "@vercel/stega": "0.1.2",
     "@vitest/coverage-v8": "1.6.0",
     "eslint": "^8.57.0",
@@ -143,12 +143,12 @@
     "ls-engines": "^0.9.1",
     "next": "^14.2.3",
     "nock": "^13.5.4",
-    "prettier": "^3.2.5",
+    "prettier": "^3.3.1",
     "prettier-plugin-packagejson": "^2.5.0",
     "rimraf": "^5.0.1",
     "rollup": "^4.18.0",
     "sse-channel": "^4.0.0",
-    "terser": "^5.31.0",
+    "terser": "^5.31.1",
     "typescript": "5.4.5",
     "vitest": "1.6.0",
     "vitest-github-actions-reporter": "0.11.1"

package/src/types.ts

@@ -556,11 +556,6 @@ export type CreateAction = {
 export type ReplaceDraftAction = {
   actionType: 'sanity.action.document.replaceDraft'
 
-  /**
-   * Draft document ID to replace, if it exists.
-   */
-  draftId: string
-
   /**
    * Published document ID to create draft from, if draft does not exist
    */
@@ -621,7 +616,7 @@ export type DeleteAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -641,7 +636,7 @@ export type DiscardAction = {
   /**
    * Delete document history
    */
-  purge: boolean
+  purge?: boolean
 }
 
 /**
@@ -664,7 +659,7 @@ export type PublishAction = {
   /**
    * Draft revision ID to match
    */
-  ifDraftRevisionId: string
+  ifDraftRevisionId?: string
 
   /**
    * Published document ID to replace
@@ -674,7 +669,7 @@ export type PublishAction = {
   /**
    * Published revision ID to match
    */
-  ifPublishedRevisionId: string
+  ifPublishedRevisionId?: string
 }
 
 /**

package/umd/sanityClient.js

@@ -166,7 +166,7 @@
       typeof result[key] > "u" ? result[key] = value : isArray$3(result[key]) ? result[key].push(value) : result[key] = [result[key], value];
     }
     return result;
-  }, parseHeaders$1 = /* @__PURE__ */ getDefaultExportFromCjs$1(parseHeaders), __defProp$5 = Object.defineProperty, __defNormalProp$5 = (obj, key, value) => key in obj ? __defProp$5(obj, key, { enumerable: !0, configurable: !0, writable: !0, value }) : obj[key] = value, __publicField$5 = (obj, key, value) => (__defNormalProp$5(obj, typeof key != "symbol" ? key + "" : key, value), value), __accessCheck$8 = (obj, member, msg) => {
+  }, parseHeaders$1 = /* @__PURE__ */ getDefaultExportFromCjs$1(parseHeaders), __defProp$4 = Object.defineProperty, __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: !0, configurable: !0, writable: !0, value }) : obj[key] = value, __publicField$4 = (obj, key, value) => (__defNormalProp$4(obj, typeof key != "symbol" ? key + "" : key, value), value), __accessCheck$8 = (obj, member, msg) => {
     if (!member.has(obj))
       throw TypeError("Cannot " + msg);
   }, __privateGet$8 = (obj, member, getter) => (__accessCheck$8(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj)), __privateAdd$8 = (obj, member, value) => {
@@ -176,7 +176,7 @@
   }, __privateSet$8 = (obj, member, value, setter) => (__accessCheck$8(obj, member, "write to private field"), member.set(obj, value), value), _method, _url, _resHeaders, _headers, _controller, _init, _useAbortSignal;
   class FetchXhr {
     constructor() {
-      __publicField$5(this, "onabort"), __publicField$5(this, "onerror"), __publicField$5(this, "onreadystatechange"), __publicField$5(this, "ontimeout"), __publicField$5(this, "readyState", 0), __publicField$5(this, "response"), __publicField$5(this, "responseText", ""), __publicField$5(this, "responseType", ""), __publicField$5(this, "status"), __publicField$5(this, "statusText"), __publicField$5(this, "withCredentials"), __privateAdd$8(this, _method, void 0), __privateAdd$8(this, _url, void 0), __privateAdd$8(this, _resHeaders, void 0), __privateAdd$8(this, _headers, {}), __privateAdd$8(this, _controller, void 0), __privateAdd$8(this, _init, {}), __privateAdd$8(this, _useAbortSignal, void 0);
+      __publicField$4(this, "onabort"), __publicField$4(this, "onerror"), __publicField$4(this, "onreadystatechange"), __publicField$4(this, "ontimeout"), __publicField$4(this, "readyState", 0), __publicField$4(this, "response"), __publicField$4(this, "responseText", ""), __publicField$4(this, "responseType", ""), __publicField$4(this, "status"), __publicField$4(this, "statusText"), __publicField$4(this, "withCredentials"), __privateAdd$8(this, _method, void 0), __privateAdd$8(this, _url, void 0), __privateAdd$8(this, _resHeaders, void 0), __privateAdd$8(this, _headers, {}), __privateAdd$8(this, _controller, void 0), __privateAdd$8(this, _init, {}), __privateAdd$8(this, _useAbortSignal, void 0);
     }
     // eslint-disable-next-line @typescript-eslint/no-unused-vars -- _async is only declared for typings compatibility
     open(method, url, _async) {
@@ -697,10 +697,10 @@
       }
     };
   }
-  var __defProp$4 = Object.defineProperty, __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: !0, configurable: !0, writable: !0, value }) : obj[key] = value, __publicField$4 = (obj, key, value) => (__defNormalProp$4(obj, typeof key != "symbol" ? key + "" : key, value), value);
+  var __defProp$1$1 = Object.defineProperty, __defNormalProp$1$1 = (obj, key, value) => key in obj ? __defProp$1$1(obj, key, { enumerable: !0, configurable: !0, writable: !0, value }) : obj[key] = value, __publicField$1$1 = (obj, key, value) => (__defNormalProp$1$1(obj, typeof key != "symbol" ? key + "" : key, value), value);
   class Cancel {
     constructor(message) {
-      __publicField$4(this, "__CANCEL__", !0), __publicField$4(this, "message"), this.message = message;
+      __publicField$1$1(this, "__CANCEL__", !0), __publicField$1$1(this, "message"), this.message = message;
     }
     toString() {
       return `Cancel${this.message ? `: ${this.message}` : ""}`;
@@ -708,7 +708,7 @@
   }
   const _CancelToken = class {
     constructor(executor) {
-      if (__publicField$4(this, "promise"), __publicField$4(this, "reason"), typeof executor != "function")
+      if (__publicField$1$1(this, "promise"), __publicField$1$1(this, "reason"), typeof executor != "function")
         throw new TypeError("executor must be a function.");
       let resolvePromise = null;
       this.promise = new Promise((resolve) => {
@@ -718,7 +718,7 @@
       });
     }
   };
-  __publicField$4(_CancelToken, "source", () => {
+  __publicField$1$1(_CancelToken, "source", () => {
     let cancel;
     return {
       token: new _CancelToken((can) => {