@sanity/client 6.20.0-canary.0 → 6.20.1

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.cjs

@@ -506,7 +506,10 @@ function once(fn) {
 const createWarningPrinter = (message) => (
   // eslint-disable-next-line no-console
   once((...args) => console.warn(message.join(" "), ...args))
-), printCdnWarning = createWarningPrinter([
+), printCdnAndWithCredentialsWarning = createWarningPrinter([
+  "Because you set `withCredentials` to true, we will override your `useCdn`",
+  "setting to be false since (cookie-based) credentials are never set on the CDN"
+]), printCdnWarning = createWarningPrinter([
   "Since you haven't set a value for `useCdn`, we will deliver content using our",
   "global, edge-cached API-CDN. If you wish to have content delivered faster, set",
   "`useCdn: false` to use the Live API. Note: You may incur higher costs using the live API."
@@ -584,7 +587,7 @@ const validateApiPerspective = function(perspective) {
       `stega.studioUrl must be a string or a function, received ${newConfig.stega.studioUrl}`
     );
   const isBrowser = typeof window < "u" && window.location && window.location.hostname, isLocalhost = isBrowser && isLocal(window.location.hostname);
-  isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== !0 ? printBrowserTokenWarning() : typeof newConfig.useCdn > "u" && printCdnWarning(), projectBased && projectId(newConfig.projectId), newConfig.dataset && dataset(newConfig.dataset), "requestTagPrefix" in newConfig && (newConfig.requestTagPrefix = newConfig.requestTagPrefix ? requestTag(newConfig.requestTagPrefix).replace(/\.+$/, "") : void 0), newConfig.apiVersion = `${newConfig.apiVersion}`.replace(/^v/, ""), newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost, newConfig.useCdn = newConfig.useCdn !== !1 && !newConfig.withCredentials, validateApiVersion(newConfig.apiVersion);
+  isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== !0 ? printBrowserTokenWarning() : typeof newConfig.useCdn > "u" && printCdnWarning(), projectBased && projectId(newConfig.projectId), newConfig.dataset && dataset(newConfig.dataset), "requestTagPrefix" in newConfig && (newConfig.requestTagPrefix = newConfig.requestTagPrefix ? requestTag(newConfig.requestTagPrefix).replace(/\.+$/, "") : void 0), newConfig.apiVersion = `${newConfig.apiVersion}`.replace(/^v/, ""), newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost, newConfig.useCdn === !0 && newConfig.withCredentials && printCdnAndWithCredentialsWarning(), newConfig.useCdn = newConfig.useCdn !== !1 && !newConfig.withCredentials, validateApiVersion(newConfig.apiVersion);
   const hostParts = newConfig.apiHost.split("://", 2), protocol = hostParts[0], host = hostParts[1], cdnHost = newConfig.isDefaultApi ? defaultCdnHost : host;
   return newConfig.useProjectHostname ? (newConfig.url = `${protocol}://${newConfig.projectId}.${host}/v${newConfig.apiVersion}`, newConfig.cdnUrl = `${protocol}://${newConfig.projectId}.${cdnHost}/v${newConfig.apiVersion}`) : (newConfig.url = `${newConfig.apiHost}/v${newConfig.apiVersion}`, newConfig.cdnUrl = newConfig.url), newConfig;
 }, projectHeader = "X-Sanity-Project-ID";