@sanity/client 6.18.2 → 6.19.0

package/README.md

@@ -1260,7 +1260,7 @@ The following options are available for mutations, and can be applied either as
   - `async`: request will return immediately when the changes have been committed, but it might still be a second or more until changes are reflected in a query. Unless you are immediately re-querying for something that includes the mutated data, this is the preferred choice.
   - `deferred`: fastest way to write - bypasses real-time indexing completely, and should be used in cases where you are bulk importing/mutating a large number of documents and don't need to see that data in a query for tens of seconds.
 - `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.
-- `autoGenerateArrayKeys` (`true|false`) - default `false`. If true, the mutation API will automatically add `_key` attributes to objects in arrays that is missing them. This makes array operations more robust by having a unique key within the array available for selections, which helps prevent race conditions in real-time, collaborative editing.
+- `autoGenerateArrayKeys` (`true|false`) - default `false`. If true, the mutation API will automatically add `_key` attributes to objects in arrays that are missing them. This makes array operations more robust by having a unique key within the array available for selections, which helps prevent race conditions in real-time, collaborative editing.
 
 ### Aborting a request
 

package/dist/index.browser.cjs

@@ -42,7 +42,7 @@ function extractErrorProps(res) {
   };
   if (body.error && body.message)
     return props.message = `${body.error} - ${body.message}`, props;
-  if (isMutationError(body)) {
+  if (isMutationError(body) || isActionError(body)) {
     const allItems = body.error.items || [], items = allItems.slice(0, 5).map((item) => {
       var _a;
       return (_a = item.error) == null ? void 0 : _a.description;
@@ -58,6 +58,9 @@ function extractErrorProps(res) {
 function isMutationError(body) {
   return isPlainObject(body) && isPlainObject(body.error) && body.error.type === "mutationError" && typeof body.error.description == "string";
 }
+function isActionError(body) {
+  return isPlainObject(body) && isPlainObject(body.error) && body.error.type === "actionError" && typeof body.error.description == "string";
+}
 function isPlainObject(obj) {
   return typeof obj == "object" && obj !== null && !Array.isArray(obj);
 }
@@ -691,8 +694,18 @@ function _mutate(client, httpRequest, mutations, options) {
   const muts = Array.isArray(mut) ? mut : [mut], transactionId = options && options.transactionId || void 0;
   return _dataRequest(client, httpRequest, "mutate", { mutations: muts, transactionId }, options);
 }
+function _action(client, httpRequest, actions, options) {
+  const acts = Array.isArray(actions) ? actions : [actions], transactionId = options && options.transactionId || void 0, skipCrossDatasetReferenceValidation = options && options.skipCrossDatasetReferenceValidation || void 0, dryRun = options && options.dryRun || void 0;
+  return _dataRequest(
+    client,
+    httpRequest,
+    "actions",
+    { actions: acts, transactionId, skipCrossDatasetReferenceValidation, dryRun },
+    options
+  );
+}
 function _dataRequest(client, httpRequest, endpoint, body, options = {}) {
-  const isMutation = endpoint === "mutate", isQuery = endpoint === "query", strQuery = isMutation ? "" : encodeQueryString(body), useGet = !isMutation && strQuery.length < getQuerySizeLimit, stringQuery = useGet ? strQuery : "", returnFirst = options.returnFirst, { timeout, token, tag, headers, returnQuery, lastLiveEventId } = options, uri = _getDataUrl(client, endpoint, stringQuery), reqOptions = {
+  const isMutation = endpoint === "mutate", isAction = endpoint === "actions", isQuery = endpoint === "query", strQuery = isMutation || isAction ? "" : encodeQueryString(body), useGet = !isMutation && !isAction && strQuery.length < getQuerySizeLimit, stringQuery = useGet ? strQuery : "", returnFirst = options.returnFirst, { timeout, token, tag, headers, returnQuery, lastLiveEventId } = options, uri = _getDataUrl(client, endpoint, stringQuery), reqOptions = {
     method: useGet ? "GET" : "POST",
     uri,
     json: !0,
@@ -1304,6 +1317,15 @@ const _ObservableSanityClient = class _ObservableSanityClient2 {
   transaction(operations) {
     return new ObservableTransaction(operations, this);
   }
+  /**
+   * Perform action operations against the configured dataset
+   *
+   * @param operations - Action operation(s) to execute
+   * @param options - Action options
+   */
+  action(operations, options) {
+    return _action(this, __privateGet(this, _httpRequest), operations, options);
+  }
   /**
    * Perform an HTTP request against the Sanity API
    *
@@ -1441,6 +1463,16 @@ const _SanityClient = class _SanityClient2 {
   transaction(operations) {
     return new Transaction(operations, this);
   }
+  /**
+   * Perform action operations against the configured dataset
+   * Returns a promise that resolves to the transaction result
+   *
+   * @param operations - Action operation(s) to execute
+   * @param options - Action options
+   */
+  action(operations, options) {
+    return rxjs.lastValueFrom(_action(this, __privateGet(this, _httpRequest2), operations, options));
+  }
   /**
    * Perform a request against the Sanity API
    * NOTE: Only use this for Sanity API endpoints, not for your own APIs!