@sanity/sdk 2.11.0 → 2.11.1

package/src/document/processActions/edit.ts

@@ -0,0 +1,176 @@
+import {diffValue} from '@sanity/diff-patch'
+import {DocumentId, getDraftId, getPublishedId, getVersionId} from '@sanity/id-utils'
+import {type Mutation, type PatchOperations, type SanityDocument} from '@sanity/types'
+
+import {isReleasePerspective} from '../../releases/utils/isReleasePerspective'
+import {type EditDocumentAction} from '../actions'
+import {getId, processMutations} from '../processMutations'
+import {
+  ActionError,
+  type ActionHandlerContext,
+  type ActionHandlerResult,
+  checkGrant,
+  PermissionActionError,
+} from './shared'
+
+export function handleEdit(
+  action: EditDocumentAction,
+  ctx: ActionHandlerContext,
+): ActionHandlerResult {
+  const {transactionId, timestamp, grants, outgoingActions, outgoingMutations} = ctx
+  let {base, working} = ctx
+
+  const documentId = getId(action.documentId)
+
+  if (action.liveEdit) {
+    // Single-document mode (liveEdit or release perspective): edit directly without draft logic
+    const userPatches = action.patches?.map((patch) => ({patch: {id: documentId, ...patch}}))
+
+    // skip this action if there are no associated patches
+    if (!userPatches?.length) return {base, working}
+
+    if (!working[documentId] || !base[documentId]) {
+      throw new ActionError({
+        documentId,
+        transactionId,
+        message: `Cannot edit document because it does not exist.`,
+      })
+    }
+
+    const baseBefore = base[documentId] as SanityDocument
+    if (userPatches) {
+      base = processMutations({
+        documents: base,
+        transactionId,
+        mutations: userPatches,
+        timestamp,
+      })
+    }
+
+    const baseAfter = base[documentId] as SanityDocument
+    const patches = diffValue(baseBefore, baseAfter)
+
+    const workingBefore = working[documentId] as SanityDocument
+    if (!checkGrant(grants.update, workingBefore)) {
+      throw new PermissionActionError({
+        documentId,
+        transactionId,
+        message: `You do not have permission to edit document "${documentId}".`,
+      })
+    }
+
+    const workingMutations = patches.map((patch) => ({patch: {id: documentId, ...patch}}))
+
+    working = processMutations({
+      documents: working,
+      transactionId,
+      mutations: workingMutations,
+      timestamp,
+    })
+
+    // liveEdit documents use the mutation endpoint directly -- we don't send actions
+    outgoingMutations.push(...workingMutations)
+    return {base, working}
+  }
+
+  const versionId = isReleasePerspective(action.perspective)
+    ? getVersionId(DocumentId(documentId), action.perspective.releaseName)
+    : undefined
+  const draftId = getDraftId(DocumentId(documentId))
+  const publishedId = getPublishedId(DocumentId(documentId))
+  const patchDocumentId = isReleasePerspective(action.perspective) ? versionId! : draftId
+  const userPatches = action.patches?.map((patch) => ({
+    patch: {id: patchDocumentId, ...patch},
+  }))
+
+  // skip this action if there are no associated patches
+  if (!userPatches?.length) return {base, working}
+
+  if (isReleasePerspective(action.perspective)) {
+    if (!working[versionId!] && !base[versionId!]) {
+      throw new ActionError({
+        documentId,
+        transactionId,
+        message: `This document does not exist in the release. Please create it or add it to the release first.`,
+      })
+    }
+  } else if (
+    (!working[draftId] && !working[publishedId]) ||
+    (!base[draftId] && !base[publishedId])
+  ) {
+    throw new ActionError({
+      documentId,
+      transactionId,
+      message: `Cannot edit document because it does not exist in draft or published form.`,
+    })
+  }
+
+  const baseMutations: Mutation[] = []
+  // don't create a draft from the published version in a release perspective
+  if (!isReleasePerspective(action.perspective) && !base[draftId] && base[publishedId]) {
+    // otherwise make a draft from the published version
+    baseMutations.push({create: {...base[publishedId], _id: draftId}})
+  }
+
+  // the above statement and guards should make this never be null or undefined
+  const baseBefore = base[patchDocumentId] ?? base[publishedId]
+  if (userPatches) {
+    baseMutations.push(...userPatches)
+  }
+
+  base = processMutations({
+    documents: base,
+    transactionId,
+    mutations: baseMutations,
+    timestamp,
+  })
+  // this one will always be defined because a patch mutation will never
+  // delete an input document
+  const baseAfter = base[patchDocumentId] as SanityDocument
+  const patches = diffValue(baseBefore, baseAfter)
+
+  const workingMutations: Mutation[] = []
+  if (!isReleasePerspective(action.perspective) && !working[draftId] && working[publishedId]) {
+    const newDraftFromPublished = {...working[publishedId], _id: draftId}
+
+    if (!checkGrant(grants.create, newDraftFromPublished)) {
+      throw new PermissionActionError({
+        documentId,
+        transactionId,
+        message: `You do not have permission to create a draft for editing this document.`,
+      })
+    }
+
+    workingMutations.push({create: newDraftFromPublished})
+  }
+
+  // the first if statement should make this never be null or undefined
+  const workingBefore = working[patchDocumentId] ?? working[publishedId]
+  if (!checkGrant(grants.update, workingBefore!)) {
+    throw new PermissionActionError({
+      documentId,
+      transactionId,
+      message: `You do not have permission to edit document "${documentId}".`,
+    })
+  }
+  workingMutations.push(...patches.map((patch) => ({patch: {id: patchDocumentId, ...patch}})))
+
+  working = processMutations({
+    documents: working,
+    transactionId,
+    mutations: workingMutations,
+    timestamp,
+  })
+
+  outgoingMutations.push(...workingMutations)
+  outgoingActions.push(
+    ...patches.map((patch) => ({
+      actionType: 'sanity.action.document.edit' as const,
+      draftId: patchDocumentId,
+      publishedId,
+      patch: patch as PatchOperations,
+    })),
+  )
+
+  return {base, working}
+}

package/src/document/processActions/processActions.ts

@@ -0,0 +1,168 @@
+import {type Mutation} from '@sanity/types'
+import {type ExprNode} from 'groq-js'
+
+import {type DocumentAction} from '../actions'
+import {type Grant} from '../permissions'
+import {type DocumentSet} from '../processMutations'
+import {type HttpAction} from '../reducers'
+import {handleCreate} from './create'
+import {handleDelete} from './delete'
+import {handleDiscard} from './discard'
+import {handleEdit} from './edit'
+import {handlePublish} from './publish'
+import {
+  ActionError,
+  type ActionHandlerContext,
+  type ActionHandlerResult,
+  PermissionActionError,
+} from './shared'
+import {handleUnpublish} from './unpublish'
+
+export {ActionError, PermissionActionError}
+
+interface ProcessActionsOptions {
+  /**
+   * The ID of this transaction. This will become the resulting `_rev` for all
+   * documents affected by changes derived from the current set of actions.
+   */
+  transactionId: string
+
+  /**
+   * The actions to apply to the given documents
+   */
+  actions: DocumentAction[]
+
+  /**
+   * The set of documents these actions were intended to be applied to. These
+   * set of documents should be captured right before a queued action is
+   * applied.
+   */
+  base: DocumentSet
+
+  /**
+   * The current "working" set of documents. A patch will be created by applying
+   * the actions to the base. This patch will then be applied to the working
+   * set for conflict resolution. Initially, this value should match the base
+   * set.
+   */
+  working: DocumentSet
+
+  /**
+   * The timestamp to use for `_updateAt` and other similar timestamps for this
+   * transaction
+   */
+  timestamp: string
+
+  /**
+   * the lookup with pre-parsed GROQ expressions
+   */
+  grants: Record<Grant, ExprNode>
+
+  // // TODO: implement initial values from the schema?
+  // initialValues?: {[TDocumentType in string]?: {_type: string}}
+}
+
+interface ProcessActionsResult {
+  /**
+   * The resulting document set after the actions have been applied. This is
+   * derived from the working documents.
+   */
+  working: DocumentSet
+  /**
+   * The document set before the actions have been applied. This is simply the
+   * input of the `working` document set.
+   */
+  previous: DocumentSet
+  /**
+   * The outgoing action that were collected when applying the actions. These
+   * are sent to the Actions HTTP API
+   */
+  outgoingActions: HttpAction[]
+  /**
+   * The outgoing mutations that were collected when applying the actions. These
+   * are here for debugging purposes.
+   */
+  outgoingMutations: Mutation[]
+  /**
+   * The previous revisions of the given documents before the actions were applied.
+   */
+  previousRevs: {[TDocumentId in string]?: string}
+}
+
+/**
+ * Applies the given set of actions to the working set of documents and converts
+ * high-level actions into lower-level outgoing mutations/actions that respect
+ * the current state of the working documents.
+ *
+ * Supports a "base" and "working" set of documents to allow actions to be
+ * applied on top of a different working set of documents in a 3-way merge
+ *
+ * Actions are applied to the base set of documents first. The difference
+ * between the base before and after is used to create a patch. This patch is
+ * then applied to the working set of documents and is set as the outgoing patch
+ * sent to the server.
+ */
+export function processActions({
+  actions,
+  transactionId,
+  working: initialWorking,
+  base: initialBase,
+  timestamp,
+  grants,
+}: ProcessActionsOptions): ProcessActionsResult {
+  let base: DocumentSet = {...initialBase}
+  let working: DocumentSet = {...initialWorking}
+
+  const outgoingActions: HttpAction[] = []
+  const outgoingMutations: Mutation[] = []
+
+  for (const action of actions) {
+    const result = dispatch(action, {
+      base,
+      working,
+      transactionId,
+      timestamp,
+      grants,
+      outgoingActions,
+      outgoingMutations,
+    })
+    base = result.base
+    working = result.working
+  }
+
+  const previousRevs = Object.fromEntries(
+    Object.entries(initialWorking).map(([id, doc]) => [id, doc?._rev]),
+  )
+
+  return {
+    working,
+    outgoingActions,
+    outgoingMutations,
+    previous: initialWorking,
+    previousRevs,
+  }
+}
+
+function dispatch(action: DocumentAction, ctx: ActionHandlerContext): ActionHandlerResult {
+  switch (action.type) {
+    case 'document.create':
+      return handleCreate(action, ctx)
+    case 'document.delete':
+      return handleDelete(action, ctx)
+    case 'document.discard':
+      return handleDiscard(action, ctx)
+    case 'document.edit':
+      return handleEdit(action, ctx)
+    case 'document.publish':
+      return handlePublish(action, ctx)
+    case 'document.unpublish':
+      return handleUnpublish(action, ctx)
+    default:
+      throw new Error(
+        `Unknown action type: "${
+          // @ts-expect-error invalid input
+          action.type
+        }". Please contact support if this issue persists.`,
+      )
+  }
+}

package/src/document/processActions/publish.ts

@@ -0,0 +1,120 @@
+import {DocumentId, getDraftId, getPublishedId} from '@sanity/id-utils'
+import {type Mutation, type Reference, type SanityDocument} from '@sanity/types'
+
+import {isReleasePerspective} from '../../releases/utils/isReleasePerspective'
+import {isDeepEqual} from '../../utils/object'
+import {type PublishDocumentAction} from '../actions'
+import {getId, processMutations} from '../processMutations'
+import {
+  ActionError,
+  type ActionHandlerContext,
+  type ActionHandlerResult,
+  checkGrant,
+  PermissionActionError,
+} from './shared'
+
+export function handlePublish(
+  action: PublishDocumentAction,
+  ctx: ActionHandlerContext,
+): ActionHandlerResult {
+  const {transactionId, timestamp, grants, outgoingActions, outgoingMutations} = ctx
+  let {base, working} = ctx
+
+  const documentId = getId(action.documentId)
+
+  if (action.liveEdit || isReleasePerspective(action.perspective)) {
+    throw new ActionError({
+      documentId,
+      transactionId,
+      message: `Cannot publish this document. Publishing is not supported for liveEdit or version (release) documents.`,
+    })
+  }
+
+  // Standard draft/published logic
+  const draftId = getDraftId(DocumentId(documentId))
+  const publishedId = getPublishedId(DocumentId(documentId))
+
+  const workingDraft = working[draftId]
+  const baseDraft = base[draftId]
+  if (!workingDraft || !baseDraft) {
+    throw new ActionError({
+      documentId,
+      transactionId,
+      message: `Cannot publish because no draft version was found for document "${documentId}".`,
+    })
+  }
+
+  // Before proceeding, verify that the working draft is identical to the base draft.
+  // TODO: is it enough just to check for the _rev or nah?
+  if (!isDeepEqual(workingDraft, baseDraft)) {
+    throw new ActionError({
+      documentId,
+      transactionId,
+      message: `Publish aborted: The document has changed elsewhere. Please try again.`,
+    })
+  }
+
+  const newPublishedFromDraft = {...strengthenOnPublish(workingDraft), _id: publishedId}
+
+  const mutations: Mutation[] = [{delete: {id: draftId}}, {createOrReplace: newPublishedFromDraft}]
+
+  if (working[draftId] && !checkGrant(grants.update, working[draftId])) {
+    throw new PermissionActionError({
+      documentId,
+      transactionId,
+      message: `Publish failed: You do not have permission to update the draft for "${documentId}".`,
+    })
+  }
+
+  if (working[publishedId] && !checkGrant(grants.update, newPublishedFromDraft)) {
+    throw new PermissionActionError({
+      documentId,
+      transactionId,
+      message: `Publish failed: You do not have permission to update the published version of "${documentId}".`,
+    })
+  } else if (!working[publishedId] && !checkGrant(grants.create, newPublishedFromDraft)) {
+    throw new PermissionActionError({
+      documentId,
+      transactionId,
+      message: `Publish failed: You do not have permission to publish a new version of "${documentId}".`,
+    })
+  }
+
+  base = processMutations({documents: base, transactionId, mutations, timestamp})
+  working = processMutations({documents: working, transactionId, mutations, timestamp})
+
+  outgoingMutations.push(...mutations)
+  outgoingActions.push({
+    actionType: 'sanity.action.document.publish',
+    draftId,
+    publishedId,
+  })
+  return {base, working}
+}
+
+function strengthenOnPublish(draft: SanityDocument): SanityDocument {
+  const isStrengthenReference = (
+    value: object,
+  ): value is Reference & Required<Pick<Reference, '_strengthenOnPublish'>> =>
+    '_strengthenOnPublish' in value
+
+  function strengthen(value: unknown): unknown {
+    if (typeof value !== 'object' || !value) return value
+
+    if (isStrengthenReference(value)) {
+      const {_strengthenOnPublish, _weak, ...rest} = value
+      return {
+        ...rest,
+        ...(_strengthenOnPublish.weak && {_weak: true}),
+      }
+    }
+
+    if (Array.isArray(value)) {
+      return value.map(strengthen)
+    }
+
+    return Object.fromEntries(Object.entries(value).map(([k, v]) => [k, strengthen(v)]))
+  }
+
+  return strengthen(draft) as SanityDocument
+}

package/src/document/processActions/shared.ts

@@ -0,0 +1,47 @@
+import {type Mutation, type SanityDocument} from '@sanity/types'
+import {evaluateSync, type ExprNode} from 'groq-js'
+
+import {type Grant} from '../permissions'
+import {type DocumentSet} from '../processMutations'
+import {type HttpAction} from '../reducers'
+
+export interface ActionHandlerContext {
+  base: DocumentSet
+  working: DocumentSet
+  transactionId: string
+  timestamp: string
+  grants: Record<Grant, ExprNode>
+  outgoingActions: HttpAction[]
+  outgoingMutations: Mutation[]
+}
+
+export interface ActionHandlerResult {
+  base: DocumentSet
+  working: DocumentSet
+}
+
+export function checkGrant(grantExpr: ExprNode, document: SanityDocument): boolean {
+  const value = evaluateSync(grantExpr, {params: {document}})
+  return value.type === 'boolean' && value.data
+}
+
+interface ActionErrorOptions {
+  message: string
+  documentId: string
+  transactionId: string
+}
+
+/**
+ * Thrown when a precondition for an action failed.
+ */
+export class ActionError extends Error implements ActionErrorOptions {
+  documentId!: string
+  transactionId!: string
+
+  constructor(options: ActionErrorOptions) {
+    super(options.message)
+    Object.assign(this, options)
+  }
+}
+
+export class PermissionActionError extends ActionError {}

package/src/document/processActions/unpublish.ts

@@ -0,0 +1,85 @@
+import {DocumentId, getDraftId, getPublishedId} from '@sanity/id-utils'
+import {type Mutation, type SanityDocument} from '@sanity/types'
+
+import {isReleasePerspective} from '../../releases/utils/isReleasePerspective'
+import {type UnpublishDocumentAction} from '../actions'
+import {getId, processMutations} from '../processMutations'
+import {
+  ActionError,
+  type ActionHandlerContext,
+  type ActionHandlerResult,
+  checkGrant,
+  PermissionActionError,
+} from './shared'
+
+export function handleUnpublish(
+  action: UnpublishDocumentAction,
+  ctx: ActionHandlerContext,
+): ActionHandlerResult {
+  const {transactionId, timestamp, grants, outgoingActions, outgoingMutations} = ctx
+  let {base, working} = ctx
+
+  const documentId = getId(action.documentId)
+
+  if (action.liveEdit || isReleasePerspective(action.perspective)) {
+    throw new ActionError({
+      documentId,
+      transactionId,
+      message: `Cannot unpublish this document. Unpublishing is not supported for liveEdit or version (release) documents.`,
+    })
+  }
+
+  // Standard draft/published or version logic
+  const draftId = getDraftId(DocumentId(documentId))
+  const publishedId = getPublishedId(DocumentId(documentId))
+
+  if (!working[publishedId] && !base[publishedId]) {
+    throw new ActionError({
+      documentId,
+      transactionId,
+      message: `Cannot unpublish because the document "${documentId}" is not currently published.`,
+    })
+  }
+
+  const sourceDoc = working[publishedId] ?? (base[publishedId] as SanityDocument)
+  const newDraftFromPublished = {...sourceDoc, _id: draftId}
+  const mutations: Mutation[] = [
+    {delete: {id: publishedId}},
+    {createIfNotExists: newDraftFromPublished},
+  ]
+
+  if (!checkGrant(grants.update, sourceDoc)) {
+    throw new PermissionActionError({
+      documentId,
+      transactionId,
+      message: `You do not have permission to unpublish the document "${documentId}".`,
+    })
+  }
+
+  if (!working[draftId] && !checkGrant(grants.create, newDraftFromPublished)) {
+    throw new PermissionActionError({
+      documentId,
+      transactionId,
+      message: `You do not have permission to create a draft from the published version of "${documentId}".`,
+    })
+  }
+
+  base = processMutations({
+    documents: base,
+    transactionId,
+    mutations: [
+      {delete: {id: publishedId}},
+      {createIfNotExists: {...(base[publishedId] ?? sourceDoc), _id: draftId}},
+    ],
+    timestamp,
+  })
+  working = processMutations({documents: working, transactionId, mutations, timestamp})
+
+  outgoingMutations.push(...mutations)
+  outgoingActions.push({
+    actionType: 'sanity.action.document.unpublish',
+    draftId,
+    publishedId,
+  })
+  return {base, working}
+}

package/src/document/processActions.test.ts

@@ -3,7 +3,7 @@ import {parse} from 'groq-js'
 import {describe, expect, it} from 'vitest'
 
 import {type DocumentAction} from './actions'
-import {ActionError, processActions} from './processActions'
+import {ActionError, processActions} from './processActions/processActions'
 import {type DocumentSet} from './processMutations'
 
 // Helper: Create a sample document that conforms to SanityDocument.

package/src/document/reducers.ts

@@ -11,7 +11,7 @@ import {type DocumentAction} from './actions'
 import {DOCUMENT_STATE_CLEAR_DELAY} from './documentConstants'
 import {type DocumentState, type DocumentStoreState} from './documentStore'
 import {type RemoteDocument} from './listen'
-import {ActionError, processActions} from './processActions'
+import {ActionError, processActions} from './processActions/processActions'
 import {type DocumentSet} from './processMutations'
 
 const EMPTY_REVISIONS: NonNullable<Required<DocumentState['unverifiedRevisions']>> = {}