[PE-6063] Deprecate audius-query collection.ts

packages/common/src/api/index.ts

@@ -2,7 +2,6 @@
 // TODO: migrate all of these to tan-query
 export * from './account'
 export * from './authorizedApps'
-export * from './collection'
 export * from './developerApps'
 export * from './library'
 export * from './purchases'
@@ -22,6 +21,7 @@ export * from './tan-query/comments'
 
 // Collection
 export * from './tan-query/collection/useCollection'
+export * from './tan-query/collection/useCollections'
 export * from './tan-query/collection/useCollectionByPermalink'
 export * from './tan-query/collection/useCollectionFavorites'
 export * from './tan-query/collection/useCollectionReposts'

packages/common/src/api/reducer.ts

@@ -2,7 +2,6 @@ import { combineReducers } from 'redux'
 
 import { accountApiReducer } from './account'
 import { authorizedAppsApiReducer } from './authorizedApps'
-import { collectionApiReducer } from './collection'
 import { developerAppsApiReducer } from './developerApps'
 import { favoritesApiReducer } from './favorites'
 import { libraryApiReducer } from './library'
@@ -17,7 +16,6 @@ import { userApiReducer } from './user'
 export default combineReducers({
   accountApi: accountApiReducer,
   authorizedAppsApi: authorizedAppsApiReducer,
-  collectionApi: collectionApiReducer,
   developerAppsApi: developerAppsApiReducer,
   favoritesApi: favoritesApiReducer,
   libraryApi: libraryApiReducer,

packages/common/src/api/tan-query/collection/useCollections.ts

@@ -10,18 +10,12 @@ import { CommonState } from '~/store'
 
 import { getCollectionsBatcher } from '../batchers/getCollectionsBatcher'
 import { TQCollection } from '../models'
-import { QUERY_KEYS } from '../queryKeys'
-import { QueryKey, QueryOptions } from '../types'
+import { QueryOptions } from '../types'
 import { useCurrentUserId } from '../users/account/useCurrentUserId'
 import { combineQueryResults } from '../utils/combineQueryResults'
 import { useQueries } from '../utils/useQueries'
 
-export const getCollectionQueryKey = (collectionId: ID | null | undefined) => {
-  return [
-    QUERY_KEYS.collection,
-    collectionId
-  ] as unknown as QueryKey<TQCollection>
-}
+import { getCollectionQueryKey } from './useCollection'
 
 export const useCollections = (
   collectionIds: ID[] | null | undefined,

packages/common/src/hooks/chats/useChatBlastAudienceContent.ts

@@ -3,9 +3,9 @@ import { useMemo } from 'react'
 import { ChatBlast, ChatBlastAudience, OptionalHashId } from '@audius/sdk'
 
 import {
+  useCollection,
   useGetCurrentUser,
   useGetCurrentUserId,
-  useGetPlaylistById,
   useGetPurchasersCount,
   useRemixersCount,
   useTrack
@@ -34,12 +34,10 @@ export const useChatBlastAudienceContent = ({ chat }: { chat: ChatBlast }) => {
     enabled: !!decodedContentId && audienceContentType === 'track',
     select: (track) => track.title
   })
-  const { data: album } = useGetPlaylistById(
-    {
-      playlistId: decodedContentId!
-    },
-    { disabled: !decodedContentId || audienceContentType !== 'album' }
-  )
+  const { data: albumTitle } = useCollection(decodedContentId!, {
+    enabled: audienceContentType === 'album',
+    select: (collection) => collection.playlist_name
+  })
 
   const { data: purchasersCount } = useGetPurchasersCount(
     {
@@ -81,7 +79,7 @@ export const useChatBlastAudienceContent = ({ chat }: { chat: ChatBlast }) => {
   const contentTitle = audienceContentId
     ? audienceContentType === 'track'
       ? trackTitle
-      : album?.playlist_name
+      : albumTitle
     : undefined
 
   const chatBlastTitle = getChatBlastTitle(audience)

packages/common/src/hooks/chats/usePurchasersAudience.ts

@@ -3,8 +3,8 @@ import { useMemo } from 'react'
 import { keyBy } from 'lodash'
 
 import {
+  useCollections,
   useGetCurrentUserId,
-  useGetPlaylistsByIds,
   useGetPurchasersCount,
   useGetSalesAggegrate,
   useTracks
@@ -35,10 +35,9 @@ export const usePurchasersAudience = ({
   const { data: tracks } = useTracks(
     trackAggregates?.map((sale) => sale.contentId) ?? []
   )
-  const { data: albums } = useGetPlaylistsByIds({
-    ids: albumAggregates?.map((sale) => sale.contentId) ?? [],
-    currentUserId
-  })
+  const { data: albums } = useCollections(
+    albumAggregates?.map((sale) => sale.contentId) ?? []
+  )
   const tracksById = useMemo(() => keyBy(tracks, 'track_id'), [tracks])
   const albumsById = useMemo(() => keyBy(albums, 'playlist_id'), [albums])
 

packages/common/src/hooks/useCollectionMetadata.ts

@@ -1,7 +1,7 @@
+import { pick } from 'lodash'
 import { useSelector } from 'react-redux'
 
-import { useGetCurrentUserId } from '~/api/account'
-import { useGetPlaylistById } from '~/api/collection'
+import { useCollection } from '~/api'
 import { ID } from '~/models/Identifiers'
 import { getCollectionDuration } from '~/store/cache/collections/selectors'
 import { CommonState } from '~/store/commonStore'
@@ -32,24 +32,30 @@ type CollectionMetadataProps = {
 export const useCollectionMetadata = ({
   collectionId
 }: CollectionMetadataProps): CollectionMetadataInfo[] => {
-  const { data: currentUserId } = useGetCurrentUserId({})
-  const { data: collection } = useGetPlaylistById({
-    playlistId: collectionId,
-    currentUserId
+  const { data: collectionMetadata } = useCollection(collectionId, {
+    select: (playlist) =>
+      pick(playlist, [
+        'is_private',
+        'updated_at',
+        'release_date',
+        'created_at',
+        'playlist_contents'
+      ])
   })
   const duration = useSelector((state: CommonState) =>
     getCollectionDuration(state, { id: collectionId })
   )
 
-  if (!collection) return []
+  if (!collectionMetadata) return []
 
   const {
     is_private: isPrivate,
     updated_at: updatedAt,
     release_date: releaseDate,
-    created_at: createdAt
-  } = collection
-  const numTracks = collection.playlist_contents?.track_ids?.length ?? 0
+    created_at: createdAt,
+    playlist_contents: playlistContents
+  } = collectionMetadata
+  const numTracks = playlistContents?.track_ids?.length ?? 0
 
   const metadataItems = [
     {

packages/common/src/hooks/useGatedContent.ts

@@ -24,7 +24,10 @@ import {
 } from '~/store/cache'
 import { gatedContentSelectors } from '~/store/gated-content'
 import { CommonState } from '~/store/reducers'
-import { isContentCollection, isContentTrack } from '~/utils/contentTypeUtils'
+import {
+  isContentPartialCollection,
+  isContentPartialTrack
+} from '~/utils/contentTypeUtils'
 import { Nullable, removeNullable } from '~/utils/typeUtils'
 
 import { useFeatureFlag } from './useFeatureFlag'
@@ -64,25 +67,24 @@ export const useGatedCollectionAccess = (collectionId: ID) => {
   return { hasStreamAccess }
 }
 
+type PartialTrack = Pick<
+  Track,
+  | 'track_id'
+  | 'is_stream_gated'
+  | 'is_download_gated'
+  | 'access'
+  | 'stream_conditions'
+  | 'download_conditions'
+>
+
+type PartialCollection = Pick<
+  Collection,
+  'playlist_id' | 'is_stream_gated' | 'access' | 'stream_conditions'
+>
+
 // Returns whether user has access to given track.
 export const useGatedContentAccess = (
-  content:
-    | Nullable<
-        | Pick<
-            Track,
-            | 'track_id'
-            | 'is_stream_gated'
-            | 'is_download_gated'
-            | 'access'
-            | 'stream_conditions'
-            | 'download_conditions'
-          >
-        | Pick<
-            Collection,
-            'playlist_id' | 'is_stream_gated' | 'access' | 'stream_conditions'
-          >
-      >
-    | undefined
+  content: Nullable<PartialTrack> | Nullable<PartialCollection> | undefined
 ) => {
   const nftAccessSignatureMap = useSelector(getNftAccessSignatureMap)
   const hasAccount = useSelector(getHasAccount)
@@ -97,8 +99,9 @@ export const useGatedContentAccess = (
         }
       }
 
-      const isTrack = isContentTrack(content)
-      const isCollection = isContentCollection(content)
+      const isTrack = isContentPartialTrack<PartialTrack>(content)
+      const isCollection =
+        isContentPartialCollection<PartialCollection>(content)
       const trackId = isTrack
         ? content.track_id
         : isCollection

packages/common/src/utils/contentTypeUtils.ts

@@ -3,6 +3,16 @@ import { EntityType } from '~/store'
 
 import { Nullable } from './typeUtils'
 
+/** Typeguard for determining if content is a Track but can return as a subset of the Track type */
+export const isContentPartialTrack = <T extends Partial<Track>>(
+  content?: Nullable<Partial<Track | Collection>>
+): content is T => !!content && 'track_id' in content
+
+/** Typeguard for determining if content is a Collection but can return as a subset of the Collection type */
+export const isContentPartialCollection = <T extends Partial<Collection>>(
+  content?: Nullable<Partial<Track | Collection>>
+): content is T => !!content && 'playlist_id' in content
+
 /** Typeguard for determiniing if content is a Track */
 export const isContentTrack = (
   content?: Nullable<Partial<Track | Collection>>

packages/mobile/src/components/premium-content-purchase-drawer/PremiumContentPurchaseDrawer.tsx

@@ -1,8 +1,8 @@
 import { useCallback, type ReactNode, useEffect } from 'react'
 
 import {
+  useCollection,
   useCurrentUserId,
-  useGetPlaylistById,
   useGetUserById,
   useTrack
 } from '@audius/common/api'
@@ -453,10 +453,9 @@ export const PremiumContentPurchaseDrawer = () => {
   const isAlbum = contentType === PurchaseableContentType.ALBUM
   const { data: currentUserId } = useCurrentUserId()
   const { data: track, isPending: isTrackPending } = useTrack(contentId)
-  const { data: album } = useGetPlaylistById(
-    { playlistId: contentId!, currentUserId },
-    { disabled: !isAlbum || !contentId }
-  )
+  const { data: album } = useCollection(contentId, {
+    enabled: isAlbum
+  })
   const { data: user } = useGetUserById(
     {
       id: track?.owner_id ?? album?.playlist_owner_id ?? 0,