fix(core): rename BundleDocumentResult to DocumentInBundleResult

sanity-io · Aug 2, 2024 · f5bb295 · f5bb295
1 parent 960fc19
commit f5bb295
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 17 deletions.
diff --git a/...s/sanity/src/core/releases/components/ReleasePublishAllButton/ReleasePublishAllButton.tsx b/...s/sanity/src/core/releases/components/ReleasePublishAllButton/ReleasePublishAllButton.tsx
@@ -5,12 +5,12 @@ import {type BundleDocument} from 'sanity'
 
 import {Button, Dialog} from '../../../../ui-components'
 import {useBundleOperations} from '../../../store/bundles/useBundleOperations'
-import {type BundleDocumentResult} from '../../tool/detail/useBundleDocuments'
+import {type DocumentInBundleResult} from '../../tool/detail/useBundleDocuments'
 import {useObserveDocumentRevisions} from './useObserveDocumentRevisions'
 
 interface ReleasePublishAllButtonProps {
   bundle: BundleDocument
-  bundleDocuments: BundleDocumentResult[]
+  bundleDocuments: DocumentInBundleResult[]
   disabled?: boolean
 }
 

diff --git a/packages/sanity/src/core/releases/tool/detail/ReleaseReview.tsx b/packages/sanity/src/core/releases/tool/detail/ReleaseReview.tsx
@@ -6,7 +6,7 @@ import {styled} from 'styled-components'
 import {type BundleDocument} from '../../../store/bundles/types'
 import {type DocumentHistory} from './documentTable/useReleaseHistory'
 import {DocumentDiffContainer} from './review/DocumentDiffContainer'
-import {type BundleDocumentResult} from './useBundleDocuments'
+import {type DocumentInBundleResult} from './useBundleDocuments'
 
 const InputContainer = styled(Container)`
   margin: 0;
@@ -16,7 +16,7 @@ export function ReleaseReview({
   release,
   documentsHistory,
 }: {
-  documents: BundleDocumentResult[]
+  documents: DocumentInBundleResult[]
   release: BundleDocument
   documentsHistory: Record<string, DocumentHistory>
 }) {

diff --git a/packages/sanity/src/core/releases/tool/detail/ReleaseSummary.tsx b/packages/sanity/src/core/releases/tool/detail/ReleaseSummary.tsx
@@ -15,15 +15,15 @@ import {Table} from '../../components/Table/Table'
 import {DocumentActions} from './documentTable/DocumentActions'
 import {getDocumentTableColumnDefs} from './documentTable/DocumentTableColumnDefs'
 import {type DocumentHistory} from './documentTable/useReleaseHistory'
-import {type BundleDocumentResult} from './useBundleDocuments'
+import {type DocumentInBundleResult} from './useBundleDocuments'
 
-export type DocumentWithHistory = BundleDocumentResult & {
+export type DocumentWithHistory = DocumentInBundleResult & {
   history: DocumentHistory | undefined
 }
 export type BundleDocumentRow = DocumentWithHistory
 
 export interface ReleaseSummaryProps {
-  documents: BundleDocumentResult[]
+  documents: DocumentInBundleResult[]
   documentsHistory: Record<string, DocumentHistory>
   collaborators: string[]
   release: BundleDocument

diff --git a/packages/sanity/src/core/releases/tool/detail/__tests__/ReleaseReview.test.tsx b/packages/sanity/src/core/releases/tool/detail/__tests__/ReleaseReview.test.tsx
@@ -7,7 +7,7 @@ import {createWrapper} from '../../../../../../test/testUtils/createWrapper'
 import {useObserveDocument} from '../../../../preview/useObserveDocument'
 import {releasesUsEnglishLocaleBundle} from '../../../i18n'
 import {ReleaseReview} from '../ReleaseReview'
-import {type BundleDocumentResult} from '../useBundleDocuments'
+import {type DocumentInBundleResult} from '../useBundleDocuments'
 
 const BASE_DOCUMENTS_MOCKS = {
   doc1: {
@@ -34,7 +34,7 @@ const BASE_DOCUMENTS_MOCKS = {
   },
 } as const
 
-const MOCKED_DOCUMENTS: BundleDocumentResult[] = [
+const MOCKED_DOCUMENTS: DocumentInBundleResult[] = [
   {
     document: {
       _rev: 'FvEfB9CaLlljeKWNkQgpz9',

diff --git a/packages/sanity/src/core/releases/tool/detail/__tests__/ReleaseSummary.test.tsx b/packages/sanity/src/core/releases/tool/detail/__tests__/ReleaseSummary.test.tsx
@@ -7,7 +7,7 @@ import {getAllByDataUi, getByDataUi} from '../../../../../../test/setup/customQu
 import {createWrapper} from '../../../../../../test/testUtils/createWrapper'
 import {type DocumentHistory} from '../documentTable/useReleaseHistory'
 import {ReleaseSummary, type ReleaseSummaryProps} from '../ReleaseSummary'
-import {type BundleDocumentResult} from '../useBundleDocuments'
+import {type DocumentInBundleResult} from '../useBundleDocuments'
 
 jest.mock('../../../../studio/addonDataset/useAddonDataset', () => ({
   useAddonDataset: jest.fn().mockReturnValue({client: {}}),
@@ -24,7 +24,7 @@ jest.mock('../../../../user-color', () => ({
 
 const timeNow = new Date()
 
-const releaseDocuments: BundleDocumentResult[] = [
+const releaseDocuments: DocumentInBundleResult[] = [
   {
     document: {
       _id: '123',

diff --git a/packages/sanity/src/core/releases/tool/detail/review/DocumentDiffContainer.tsx b/packages/sanity/src/core/releases/tool/detail/review/DocumentDiffContainer.tsx
@@ -8,7 +8,7 @@ import {type BundleDocument} from '../../../../store/bundles/types'
 import {getPublishedId} from '../../../../util/draftUtils'
 import {type DocumentHistory} from '../documentTable/useReleaseHistory'
 import {DocumentReviewHeader} from '../review/DocumentReviewHeader'
-import {type BundleDocumentResult} from '../useBundleDocuments'
+import {type DocumentInBundleResult} from '../useBundleDocuments'
 import {DocumentDiff} from './DocumentDiff'
 
 export function DocumentDiffContainer({
@@ -20,9 +20,9 @@ export function DocumentDiffContainer({
 }: {
   release: BundleDocument
   history?: DocumentHistory
-  document: BundleDocumentResult['document']
-  validation?: BundleDocumentResult['validation']
-  previewValues: BundleDocumentResult['previewValues']
+  document: DocumentInBundleResult['document']
+  validation?: DocumentInBundleResult['validation']
+  previewValues: DocumentInBundleResult['previewValues']
 }) {
   const publishedId = getPublishedId(document._id, true)
   const schema = useSchema()

diff --git a/packages/sanity/src/core/releases/tool/detail/useBundleDocuments.ts b/packages/sanity/src/core/releases/tool/detail/useBundleDocuments.ts
@@ -15,15 +15,15 @@ export interface DocumentValidationStatus extends ValidationStatus {
   hasError: boolean
 }
 
-export interface BundleDocumentResult {
+export interface DocumentInBundleResult {
   document: SanityDocument
   validation: DocumentValidationStatus
   previewValues: {isLoading: boolean; values: ReturnType<typeof prepareForPreview>}
 }
 
 export function useBundleDocuments(bundle: string): {
   loading: boolean
-  results: BundleDocumentResult[]
+  results: DocumentInBundleResult[]
 } {
   const groqFilter = `defined(_version) &&  _id in path("${bundle}.*")`
   const documentPreviewStore = useDocumentPreviewStore()