@sanity/client 6.26.1 → 6.27.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.26.1",
+  "version": "6.27.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",

package/src/csm/applySourceDocuments.ts

@@ -1,4 +1,4 @@
-import {getDraftId, getPublishedId, isDraftId} from './draftUtils'
+import {createSourceDocumentResolver} from './createSourceDocumentResolver'
 import {parseJsonPath} from './jsonPath'
 import {resolveMapping} from './resolveMapping'
 import * as paths from './studioPath'
@@ -13,8 +13,6 @@ import type {
 } from './types'
 import {walkMap} from './walkMap'
 
-const defaultUpdateFunction = <T = unknown>(changed: T): T => changed
-
 /**
  * Optimistically applies source documents to a result, using the content source map to trace fields.
  * Can be used to apply mutations to documents being edited in a Studio, or any mutation on Content Lake, to a result with extremely low latency.
@@ -25,20 +23,21 @@ export function applySourceDocuments<Result = unknown>(
   resultSourceMap: ContentSourceMap | undefined,
   getCachedDocument: (
     sourceDocument: ContentSourceMapDocuments[number],
-  ) => Partial<SanityDocument> | null | undefined,
-  updateFn: ApplySourceDocumentsUpdateFunction = defaultUpdateFunction,
-  perspective: ClientPerspective = 'raw',
+  ) =>
+    | (Partial<SanityDocument> & Required<Pick<SanityDocument, '_id' | '_type'>>)
+    | null
+    | undefined,
+  updateFn: ApplySourceDocumentsUpdateFunction,
+  perspective: Exclude<ClientPerspective, 'raw'>,
 ): Result {
   if (!resultSourceMap) return result
 
-  if (perspective !== 'published' && perspective !== 'raw' && perspective !== 'previewDrafts') {
-    throw new Error(`Unknown perspective "${perspective}"`)
-  }
+  const resolveDocument = createSourceDocumentResolver(getCachedDocument, perspective)
+  const cachedDocuments = resultSourceMap.documents.map(resolveDocument)
 
   return walkMap(JSON.parse(JSON.stringify(result)), (value, path) => {
     const resolveMappingResult = resolveMapping(path, resultSourceMap)
     if (!resolveMappingResult) {
-      // console.warn('no mapping for path', path)
       return value
     }
 
@@ -57,36 +56,7 @@ export function applySourceDocuments<Result = unknown>(
     if (sourceDocument) {
       const parsedPath = parseJsonPath(sourcePath + pathSuffix)
       const stringifiedPath = paths.toString(parsedPath as Path)
-
-      // The _id is sometimes used used as `key` in lists, and should not be changed optimistically
-      if (stringifiedPath === '_id') {
-        return value
-      }
-
-      let cachedDocument: Partial<SanityDocument> | null | undefined
-      if (perspective === 'previewDrafts') {
-        cachedDocument = getCachedDocument(
-          isDraftId(sourceDocument._id)
-            ? sourceDocument
-            : {...sourceDocument, _id: getDraftId(sourceDocument._id)},
-        )
-        if (!cachedDocument) {
-          cachedDocument = getCachedDocument(
-            isDraftId(sourceDocument._id)
-              ? {...sourceDocument, _id: getPublishedId(sourceDocument._id)}
-              : sourceDocument,
-          )
-        }
-        if (cachedDocument) {
-          cachedDocument = {
-            ...cachedDocument,
-            _id: getPublishedId(sourceDocument._id),
-            _originalId: sourceDocument._id,
-          }
-        }
-      } else {
-        cachedDocument = getCachedDocument(sourceDocument)
-      }
+      const cachedDocument = cachedDocuments[mapping.source.document]
 
       if (!cachedDocument) {
         return value

package/src/csm/createSourceDocumentResolver.ts

@@ -0,0 +1,54 @@
+import {getDraftId, getPublishedId, getVersionId} from './draftUtils'
+import {resolvePerspectives} from './resolvePerspectives'
+import type {ClientPerspective, ContentSourceMapDocuments, SanityDocument} from './types'
+
+/** @internal */
+export type ResolvedDocument = Partial<SanityDocument> &
+  Required<Pick<SanityDocument, '_id' | '_type'>>
+
+/** @internal */
+export type MatchedDocument = Partial<SanityDocument> &
+  Required<Pick<SanityDocument, '_id' | '_type' | '_originalId'>>
+
+/** @internal */
+export function createSourceDocumentResolver(
+  getCachedDocument: (
+    sourceDocument: ContentSourceMapDocuments[number],
+  ) => ResolvedDocument | null | undefined,
+  _perspective: Exclude<ClientPerspective, 'raw'>,
+) {
+  const perspectives = resolvePerspectives(_perspective)
+  function findDocument(sourceDocument: ContentSourceMapDocuments[number]) {
+    for (const perspective of perspectives) {
+      let match: ReturnType<typeof getCachedDocument> = null
+      if (perspective.startsWith('r')) {
+        match = getCachedDocument({
+          ...sourceDocument,
+          _id: getVersionId(sourceDocument._id, perspective),
+        })
+      }
+      if (perspective === 'drafts') {
+        match = getCachedDocument({
+          ...sourceDocument,
+          _id: getDraftId(sourceDocument._id),
+        })
+      }
+      if (perspective === 'published') {
+        match = getCachedDocument({
+          ...sourceDocument,
+          _id: getPublishedId(sourceDocument._id),
+        })
+      }
+      if (match) {
+        return {...match, _id: getPublishedId(match._id), _originalId: match._id}
+      }
+    }
+    return null
+  }
+  // define resolver that loops over source documents and perspectives
+  return function resolveSourceDocument(
+    sourceDocument: ContentSourceMapDocuments[number],
+  ): MatchedDocument | null {
+    return findDocument(sourceDocument)
+  }
+}

package/src/csm/resolvePerspectives.ts

@@ -0,0 +1,29 @@
+import {validateApiPerspective} from '../config'
+import type {ReleaseId} from '../types'
+import type {ClientPerspective} from './types'
+
+/**
+ * This resolves the perspectives to how documents should be resolved when applying optimistic updates,
+ * like in `applySourceDocuments`.
+ * @internal
+ */
+export function resolvePerspectives(
+  perspective: Exclude<ClientPerspective, 'raw'>,
+): ('published' | 'drafts' | ReleaseId)[] {
+  validateApiPerspective(perspective)
+
+  if (Array.isArray(perspective)) {
+    if (!perspective.includes('published')) {
+      return [...perspective, 'published']
+    }
+    return perspective
+  }
+  switch (perspective) {
+    case 'previewDrafts':
+    case 'drafts':
+      return ['drafts', 'published']
+    case 'published':
+    default:
+      return ['published']
+  }
+}