@sanity/client 6.18.2 → 6.19.0

package/dist/index.browser.d.cts

@@ -12,6 +12,35 @@ import {StudioUrl} from '@sanity/client/csm'
 import {adapter as unstable__adapter} from 'get-it'
 import {environment as unstable__environment} from 'get-it'
 
+/** @public */
+export declare type Action =
+  | CreateAction
+  | ReplaceDraftAction
+  | EditAction
+  | DeleteAction
+  | DiscardAction
+  | PublishAction
+  | UnpublishAction
+
+/** @internal */
+export declare interface ActionError {
+  error: {
+    type: 'actionError'
+    description: string
+    items?: ActionErrorItem[]
+  }
+}
+
+/** @internal */
+export declare interface ActionErrorItem {
+  error: {
+    type: string
+    description: string
+    value?: unknown
+  }
+  index: number
+}
+
 /** @internal */
 export declare type AllDocumentIdsMutationOptions = BaseMutationOptions & {
   returnFirst: false
@@ -106,6 +135,13 @@ export declare type AuthProviderResponse = {
   providers: AuthProvider[]
 }
 
+/** @internal */
+export declare type BaseActionOptions = RequestOptions & {
+  transactionId?: string
+  skipCrossDatasetReferenceValidation?: boolean
+  dryRun?: boolean
+}
+
 /** @internal */
 export declare type BaseMutationOptions = RequestOptions & {
   visibility?: 'sync' | 'async' | 'deferred'
@@ -444,6 +480,29 @@ export declare interface ContentSourceMapValueMapping {
   source: ContentSourceMapSource
 }
 
+/**
+ * Creates a new draft document. The published version of the document must not already exist.
+ * If the draft version of the document already exists the action will fail by default, but
+ * this can be adjusted to instead leave the existing document in place.
+ *
+ * @public
+ */
+export declare type CreateAction = {
+  actionType: 'sanity.action.document.create'
+  /**
+   * ID of the published document to create a draft for.
+   */
+  publishedId: string
+  /**
+   * Document to create. Requires a `_type` property.
+   */
+  attributes: IdentifiedSanityDocumentStub
+  /**
+   * ifExists controls what to do if the draft already exists
+   */
+  ifExists: 'fail' | 'ignore'
+}
+
 /** @public */
 export declare const createClient: (config: ClientConfig) => SanityClient
 
@@ -519,6 +578,29 @@ export declare type DatasetsResponse = {
   tags: string[]
 }[]
 
+/**
+ * Deletes the published version of a document and optionally some (likely all known) draft versions.
+ * If any draft version exists that is not specified for deletion this is an error.
+ * If the purge flag is set then the document history is also deleted.
+ *
+ * @public
+ */
+export declare type DeleteAction = {
+  actionType: 'sanity.action.document.delete'
+  /**
+   * Published document ID to delete
+   */
+  publishedId: string
+  /**
+   * Draft document ID to delete
+   */
+  includeDrafts: string[]
+  /**
+   * Delete document history
+   */
+  purge: boolean
+}
+
 /**
  * @public
  * @deprecated Use the named export `createClient` instead of the `default` export
@@ -526,6 +608,24 @@ export declare type DatasetsResponse = {
 declare const deprecatedCreateClient: (config: ClientConfig) => SanityClient
 export default deprecatedCreateClient
 
+/**
+ * Delete the draft version of a document.
+ * It is an error if it does not exist. If the purge flag is set, the document history is also deleted.
+ *
+ * @public
+ */
+export declare type DiscardAction = {
+  actionType: 'sanity.action.document.discard'
+  /**
+   * Draft document ID to delete
+   */
+  draftId: string
+  /**
+   * Delete document history
+   */
+  purge: boolean
+}
+
 /**
  * The listener has been told to explicitly disconnect and not reconnect.
  * This is a rare situation, but may occur if the API knows reconnect attempts will fail,
@@ -540,6 +640,29 @@ export declare type DisconnectEvent = {
   reason: string
 }
 
+/**
+ * Modifies an existing draft document.
+ * It applies the given patch to the document referenced by draftId.
+ * If there is no such document then one is created using the current state of the published version and then that is updated accordingly.
+ *
+ * @public
+ */
+export declare type EditAction = {
+  actionType: 'sanity.action.document.edit'
+  /**
+   * Draft document ID to edit
+   */
+  draftId: string
+  /**
+   * Published document ID to create draft from, if draft does not exist
+   */
+  publishedId: string
+  /**
+   * Patch operations to apply
+   */
+  patch: PatchOperations
+}
+
 /** @public */
 export declare interface ErrorProps {
   message: string
@@ -803,6 +926,11 @@ export declare type Logger =
       Pick<typeof console, 'debug' | 'error' | 'groupCollapsed' | 'groupEnd' | 'log' | 'table'>
     >
 
+/** @internal */
+export declare interface MultipleActionResult {
+  transactionId: string
+}
+
 /** @internal */
 export declare interface MultipleMutationResult {
   transactionId: string
@@ -1592,6 +1720,16 @@ export declare class ObservableSanityClient {
   transaction<R extends Record<string, Any> = Record<string, Any>>(
     operations?: Mutation<R>[],
   ): ObservableTransaction
+  /**
+   * Perform action operations against the configured dataset
+   *
+   * @param operations - Action operation(s) to execute
+   * @param options - Action options
+   */
+  action(
+    operations: Action | Action[],
+    options?: BaseActionOptions,
+  ): Observable<SingleActionResult | MultipleActionResult>
   /**
    * Perform an HTTP request against the Sanity API
    *
@@ -1795,6 +1933,35 @@ export declare class ProjectsClient {
   getById(projectId: string): Promise<SanityProject>
 }
 
+/**
+ * Publishes a draft document.
+ * If a published version of the document already exists this is replaced by the current draft document.
+ * In either case the draft document is deleted.
+ * The optional revision id parameters can be used for optimistic locking to ensure
+ * that the draft and/or published versions of the document have not been changed by another client.
+ *
+ * @public
+ */
+export declare type PublishAction = {
+  actionType: 'sanity.action.document.publish'
+  /**
+   * Draft document ID to publish
+   */
+  draftId: string
+  /**
+   * Draft revision ID to match
+   */
+  ifDraftRevisionId: string
+  /**
+   * Published document ID to replace
+   */
+  publishedId: string
+  /**
+   * Published revision ID to match
+   */
+  ifPublishedRevisionId: string
+}
+
 /** @public */
 export declare type QueryOptions =
   | FilteredResponseQueryOptions
@@ -1890,6 +2057,28 @@ export declare type ReconnectEvent = {
   type: 'reconnect'
 }
 
+/**
+ * Replaces an existing draft document.
+ * At least one of the draft or published versions of the document must exist.
+ *
+ * @public
+ */
+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
+   */
+  publishedId: string
+  /**
+   * Document to create if it does not already exist. Requires `_id` and `_type` properties.
+   */
+  attributes: IdentifiedSanityDocumentStub
+}
+
 /** @public */
 export declare const requester: Requester
 
@@ -2421,6 +2610,17 @@ export declare class SanityClient {
   transaction<R extends Record<string, Any> = Record<string, Any>>(
     operations?: Mutation<R>[],
   ): Transaction
+  /**
+   * 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: Action | Action[],
+    options?: BaseActionOptions,
+  ): Promise<SingleActionResult | MultipleActionResult>
   /**
    * Perform a request against the Sanity API
    * NOTE: Only use this for Sanity API endpoints, not for your own APIs!
@@ -2577,6 +2777,11 @@ export declare class ServerError extends Error {
   constructor(res: Any)
 }
 
+/** @internal */
+export declare interface SingleActionResult {
+  transactionId: string
+}
+
 /** @internal */
 export declare interface SingleMutationResult {
   transactionId: string
@@ -2741,6 +2946,25 @@ export declare interface UnfilteredResponseWithoutQuery extends ResponseQueryOpt
   returnQuery: false
 }
 
+/**
+ * Retract a published document.
+ * If there is no draft version then this is created from the published version.
+ * In either case the published version is deleted.
+ *
+ * @public
+ */
+export declare type UnpublishAction = {
+  actionType: 'sanity.action.document.unpublish'
+  /**
+   * Draft document ID to replace the published document with
+   */
+  draftId: string
+  /**
+   * Published document ID to delete
+   */
+  publishedId: string
+}
+
 export {unstable__adapter}
 
 export {unstable__environment}

package/dist/index.browser.d.ts

@@ -12,6 +12,35 @@ import {StudioUrl} from '@sanity/client/csm'
 import {adapter as unstable__adapter} from 'get-it'
 import {environment as unstable__environment} from 'get-it'
 
+/** @public */
+export declare type Action =
+  | CreateAction
+  | ReplaceDraftAction
+  | EditAction
+  | DeleteAction
+  | DiscardAction
+  | PublishAction
+  | UnpublishAction
+
+/** @internal */
+export declare interface ActionError {
+  error: {
+    type: 'actionError'
+    description: string
+    items?: ActionErrorItem[]
+  }
+}
+
+/** @internal */
+export declare interface ActionErrorItem {
+  error: {
+    type: string
+    description: string
+    value?: unknown
+  }
+  index: number
+}
+
 /** @internal */
 export declare type AllDocumentIdsMutationOptions = BaseMutationOptions & {
   returnFirst: false
@@ -106,6 +135,13 @@ export declare type AuthProviderResponse = {
   providers: AuthProvider[]
 }
 
+/** @internal */
+export declare type BaseActionOptions = RequestOptions & {
+  transactionId?: string
+  skipCrossDatasetReferenceValidation?: boolean
+  dryRun?: boolean
+}
+
 /** @internal */
 export declare type BaseMutationOptions = RequestOptions & {
   visibility?: 'sync' | 'async' | 'deferred'
@@ -444,6 +480,29 @@ export declare interface ContentSourceMapValueMapping {
   source: ContentSourceMapSource
 }
 
+/**
+ * Creates a new draft document. The published version of the document must not already exist.
+ * If the draft version of the document already exists the action will fail by default, but
+ * this can be adjusted to instead leave the existing document in place.
+ *
+ * @public
+ */
+export declare type CreateAction = {
+  actionType: 'sanity.action.document.create'
+  /**
+   * ID of the published document to create a draft for.
+   */
+  publishedId: string
+  /**
+   * Document to create. Requires a `_type` property.
+   */
+  attributes: IdentifiedSanityDocumentStub
+  /**
+   * ifExists controls what to do if the draft already exists
+   */
+  ifExists: 'fail' | 'ignore'
+}
+
 /** @public */
 export declare const createClient: (config: ClientConfig) => SanityClient
 
@@ -519,6 +578,29 @@ export declare type DatasetsResponse = {
   tags: string[]
 }[]
 
+/**
+ * Deletes the published version of a document and optionally some (likely all known) draft versions.
+ * If any draft version exists that is not specified for deletion this is an error.
+ * If the purge flag is set then the document history is also deleted.
+ *
+ * @public
+ */
+export declare type DeleteAction = {
+  actionType: 'sanity.action.document.delete'
+  /**
+   * Published document ID to delete
+   */
+  publishedId: string
+  /**
+   * Draft document ID to delete
+   */
+  includeDrafts: string[]
+  /**
+   * Delete document history
+   */
+  purge: boolean
+}
+
 /**
  * @public
  * @deprecated Use the named export `createClient` instead of the `default` export
@@ -526,6 +608,24 @@ export declare type DatasetsResponse = {
 declare const deprecatedCreateClient: (config: ClientConfig) => SanityClient
 export default deprecatedCreateClient
 
+/**
+ * Delete the draft version of a document.
+ * It is an error if it does not exist. If the purge flag is set, the document history is also deleted.
+ *
+ * @public
+ */
+export declare type DiscardAction = {
+  actionType: 'sanity.action.document.discard'
+  /**
+   * Draft document ID to delete
+   */
+  draftId: string
+  /**
+   * Delete document history
+   */
+  purge: boolean
+}
+
 /**
  * The listener has been told to explicitly disconnect and not reconnect.
  * This is a rare situation, but may occur if the API knows reconnect attempts will fail,
@@ -540,6 +640,29 @@ export declare type DisconnectEvent = {
   reason: string
 }
 
+/**
+ * Modifies an existing draft document.
+ * It applies the given patch to the document referenced by draftId.
+ * If there is no such document then one is created using the current state of the published version and then that is updated accordingly.
+ *
+ * @public
+ */
+export declare type EditAction = {
+  actionType: 'sanity.action.document.edit'
+  /**
+   * Draft document ID to edit
+   */
+  draftId: string
+  /**
+   * Published document ID to create draft from, if draft does not exist
+   */
+  publishedId: string
+  /**
+   * Patch operations to apply
+   */
+  patch: PatchOperations
+}
+
 /** @public */
 export declare interface ErrorProps {
   message: string
@@ -803,6 +926,11 @@ export declare type Logger =
       Pick<typeof console, 'debug' | 'error' | 'groupCollapsed' | 'groupEnd' | 'log' | 'table'>
     >
 
+/** @internal */
+export declare interface MultipleActionResult {
+  transactionId: string
+}
+
 /** @internal */
 export declare interface MultipleMutationResult {
   transactionId: string
@@ -1592,6 +1720,16 @@ export declare class ObservableSanityClient {
   transaction<R extends Record<string, Any> = Record<string, Any>>(
     operations?: Mutation<R>[],
   ): ObservableTransaction
+  /**
+   * Perform action operations against the configured dataset
+   *
+   * @param operations - Action operation(s) to execute
+   * @param options - Action options
+   */
+  action(
+    operations: Action | Action[],
+    options?: BaseActionOptions,
+  ): Observable<SingleActionResult | MultipleActionResult>
   /**
    * Perform an HTTP request against the Sanity API
    *
@@ -1795,6 +1933,35 @@ export declare class ProjectsClient {
   getById(projectId: string): Promise<SanityProject>
 }
 
+/**
+ * Publishes a draft document.
+ * If a published version of the document already exists this is replaced by the current draft document.
+ * In either case the draft document is deleted.
+ * The optional revision id parameters can be used for optimistic locking to ensure
+ * that the draft and/or published versions of the document have not been changed by another client.
+ *
+ * @public
+ */
+export declare type PublishAction = {
+  actionType: 'sanity.action.document.publish'
+  /**
+   * Draft document ID to publish
+   */
+  draftId: string
+  /**
+   * Draft revision ID to match
+   */
+  ifDraftRevisionId: string
+  /**
+   * Published document ID to replace
+   */
+  publishedId: string
+  /**
+   * Published revision ID to match
+   */
+  ifPublishedRevisionId: string
+}
+
 /** @public */
 export declare type QueryOptions =
   | FilteredResponseQueryOptions
@@ -1890,6 +2057,28 @@ export declare type ReconnectEvent = {
   type: 'reconnect'
 }
 
+/**
+ * Replaces an existing draft document.
+ * At least one of the draft or published versions of the document must exist.
+ *
+ * @public
+ */
+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
+   */
+  publishedId: string
+  /**
+   * Document to create if it does not already exist. Requires `_id` and `_type` properties.
+   */
+  attributes: IdentifiedSanityDocumentStub
+}
+
 /** @public */
 export declare const requester: Requester
 
@@ -2421,6 +2610,17 @@ export declare class SanityClient {
   transaction<R extends Record<string, Any> = Record<string, Any>>(
     operations?: Mutation<R>[],
   ): Transaction
+  /**
+   * 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: Action | Action[],
+    options?: BaseActionOptions,
+  ): Promise<SingleActionResult | MultipleActionResult>
   /**
    * Perform a request against the Sanity API
    * NOTE: Only use this for Sanity API endpoints, not for your own APIs!
@@ -2577,6 +2777,11 @@ export declare class ServerError extends Error {
   constructor(res: Any)
 }
 
+/** @internal */
+export declare interface SingleActionResult {
+  transactionId: string
+}
+
 /** @internal */
 export declare interface SingleMutationResult {
   transactionId: string
@@ -2741,6 +2946,25 @@ export declare interface UnfilteredResponseWithoutQuery extends ResponseQueryOpt
   returnQuery: false
 }
 
+/**
+ * Retract a published document.
+ * If there is no draft version then this is created from the published version.
+ * In either case the published version is deleted.
+ *
+ * @public
+ */
+export declare type UnpublishAction = {
+  actionType: 'sanity.action.document.unpublish'
+  /**
+   * Draft document ID to replace the published document with
+   */
+  draftId: string
+  /**
+   * Published document ID to delete
+   */
+  publishedId: string
+}
+
 export {unstable__adapter}
 
 export {unstable__environment}

package/dist/index.browser.js

@@ -27,7 +27,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;
@@ -43,6 +43,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);
 }
@@ -674,8 +677,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,
@@ -1287,6 +1300,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
    *
@@ -1424,6 +1446,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 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!