feat(sanity): load release document error field

sanity-io · Feb 5, 2025 · be91a66 · be91a66
1 parent 4aa4dd5
commit be91a66
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/packages/sanity/src/core/releases/store/createReleaseStore.ts b/packages/sanity/src/core/releases/store/createReleaseStore.ts
@@ -49,6 +49,12 @@ const QUERY_PROJECTION = `{
     "title": "",
     "releaseType": "${DEFAULT_RELEASE_TYPE}",
   }),
+  // Content Lake initially encoded non-error states as {error: {message: ""}}. This projection
+  // ensures the error field only appears if the document has a non-empty error message.
+  ...select(
+    length(error.message) > 0 => { error },
+    {}
+  ),
 }`
 
 // Newest releases first

diff --git a/packages/sanity/src/core/releases/store/types.ts b/packages/sanity/src/core/releases/store/types.ts
@@ -38,6 +38,9 @@ export interface ReleaseDocument extends SanityDocument {
   _updatedAt: string
   _rev: string
   state: ReleaseState
+  error?: {
+    message: string
+  }
   finalDocumentStates?: ReleaseFinalDocumentState[]
   /**
    * If defined, it takes precedence over the intendedPublishAt, the state should be 'scheduled'