Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions packages/common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

## Links

[audius-query docs](./src/audius-query/README.md)

## Usage

```
Expand Down
2 changes: 0 additions & 2 deletions packages/common/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
"./adapters": "./src/adapters/index.ts",
"./api": "./src/api/index.ts",
"./assets": "./src/assets/index.ts",
"./audius-query": "./src/audius-query/index.ts",
"./context": "./src/context/index.ts",
"./hooks": "./src/hooks/index.ts",
"./messages": "./src/messages/index.ts",
Expand Down Expand Up @@ -53,7 +52,6 @@
"hashids": "2.2.1",
"immer": "9.0.1",
"lodash": "4.17.21",
"normalizr": "3.6.2",
"numeral": "2.0.6",
"object-hash": "2.2.0",
"proxy-memoize": "3.0.1",
Expand Down
2 changes: 1 addition & 1 deletion packages/common/src/api/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,13 +108,13 @@ export * from './tan-query/users/useSupporters'
export * from './tan-query/users/useSupportedUsers'
export * from './tan-query/users/useTopArtists'
export * from './tan-query/users/useTopArtistsInGenre'
export * from './tan-query/users/useUser'
export * from './tan-query/users/useUserAlbums'
export * from './tan-query/users/useUserByHandle'
export * from './tan-query/users/useUserByParams'
export * from './tan-query/users/useUserCollectibles'
export * from './tan-query/users/useUserPlaylists'
export * from './tan-query/users/useUsers'
export * from './tan-query/users/useUser'
export * from './tan-query/users/useUserTracksByHandle'
export * from './tan-query/users/account/useResetPassword'
export * from './tan-query/users/account/useManagedAccounts'
Expand Down
12 changes: 6 additions & 6 deletions packages/common/src/api/tan-query/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,14 +192,14 @@ The `as unknown as QueryKey<MyData>` type cast is necessary for TanStack Query's
1. **Create the Hook:**

- Use the `useQuery` or `useInfiniteQuery` (paginated) hook from `@tanstack/react-query`.
- Use `useAudiusQueryContext` to get access to the `audiusSdk`.
- Use `useQueryContext` to get access to the `audiusSdk`.
- Implement the `queryFn` to call the relevant SDK method.
- Use the query key function defined in step 1.

```typescript
// useMyData.ts
import { useQuery } from '@tanstack/react-query'
import { useAudiusQueryContext } from '~/audius-query'
import { useQueryContext } from '~/api/tan-query/utils'
import { MyData } from '~/models'
import { SelectableQueryOptions } from './types'

Expand All @@ -214,7 +214,7 @@ The `as unknown as QueryKey<MyData>` type cast is necessary for TanStack Query's
params: UseMyDataParams,
options?: SelectableQueryOptions<MyData, TResult>
) => {
const { audiusSdk } = useAudiusQueryContext()
const { audiusSdk } = useQueryContext()
const { param } = params

return useQuery({
Expand All @@ -238,7 +238,7 @@ The `as unknown as QueryKey<MyData>` type cast is necessary for TanStack Query's
2. **Create the Hook:**

- Use the `useMutation` hook from `@tanstack/react-query`.
- Use `useAudiusQueryContext` for the SDK and `useQueryClient` for cache interaction.
- Use `useQueryContext` for the SDK and `useQueryClient` for cache interaction.
- Implement the `mutationFn` to call the SDK method that performs the change.
- Implement `onMutate` for optimistic updates:
- Cancel relevant ongoing queries (`queryClient.cancelQueries`).
Expand All @@ -251,7 +251,7 @@ The `as unknown as QueryKey<MyData>` type cast is necessary for TanStack Query's
```typescript
// useMyMutation.ts
import { useMutation, useQueryClient } from '@tanstack/react-query'
import { useAudiusQueryContext } from '~/audius-query'
import { useQueryContext } from '~/api/tan-query/utils'
import { MyData } from '~/models'
import { QUERY_KEYS } from './queryKeys'

Expand All @@ -268,7 +268,7 @@ The `as unknown as QueryKey<MyData>` type cast is necessary for TanStack Query's
}

export const useMyMutation = () => {
const { audiusSdk } = useAudiusQueryContext()
const { audiusSdk } = useQueryContext()
const queryClient = useQueryClient()

return useMutation({
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { AuthorizedApp, Id } from '@audius/sdk'
import { useQuery } from '@tanstack/react-query'

import { useAudiusQueryContext } from '~/audius-query'
import { useQueryContext } from '~/api/tan-query/utils'
import { ID } from '~/models'
import { Nullable } from '~/utils/typeUtils'

Expand All @@ -18,7 +18,7 @@ export const getAuthorizedAppsQueryKey = (userId: Nullable<ID>) => {
export const useAuthorizedApps = <TResult = AuthorizedApp[]>(
options?: SelectableQueryOptions<AuthorizedApp[], TResult>
) => {
const { audiusSdk } = useAudiusQueryContext()
const { audiusSdk } = useQueryContext()
const { data: userId } = useCurrentUserId()

return useQuery({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { AuthorizedApp, Id } from '@audius/sdk'
import { useMutation, useQueryClient } from '@tanstack/react-query'
import { cloneDeep } from 'lodash'

import { useAudiusQueryContext } from '~/audius-query/AudiusQueryContext'
import { useQueryContext } from '~/api/tan-query/utils/QueryContext'
import { ID } from '~/models'

import { QUERY_KEYS } from '../queryKeys'
Expand All @@ -21,7 +21,7 @@ export const getRemoveAuthorizedAppQueryKey = (userId: ID) => {
}

export const useRemoveAuthorizedApp = () => {
const { audiusSdk } = useAudiusQueryContext()
const { audiusSdk } = useQueryContext()
const queryClient = useQueryClient()
const { data: currentUserId } = useCurrentUserId()

Expand Down
4 changes: 2 additions & 2 deletions packages/common/src/api/tan-query/collection/useCollection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { useMemo } from 'react'
import { useQuery, useQueryClient } from '@tanstack/react-query'
import { useDispatch } from 'react-redux'

import { useAudiusQueryContext } from '~/audius-query/AudiusQueryContext'
import { useQueryContext } from '~/api/tan-query/utils/QueryContext'
import { ID } from '~/models'

import { getCollectionsBatcher } from '../batchers/getCollectionsBatcher'
Expand All @@ -23,7 +23,7 @@ export const useCollection = <TResult = TQCollection>(
collectionId: ID | null | undefined,
options?: SelectableQueryOptions<TQCollection, TResult>
) => {
const { audiusSdk } = useAudiusQueryContext()
const { audiusSdk } = useQueryContext()
const { data: currentUserId } = useCurrentUserId()
const queryClient = useQueryClient()
const dispatch = useDispatch()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { pick } from 'lodash'
import { useDispatch } from 'react-redux'

import { userCollectionMetadataFromSDK } from '~/adapters/collection'
import { useAudiusQueryContext } from '~/audius-query'
import { useQueryContext } from '~/api/tan-query/utils'
import { ID } from '~/models/Identifiers'

import { TQCollection } from '../models'
Expand Down Expand Up @@ -42,7 +42,7 @@ export const useCollectionByPermalink = <TResult = TQCollection>(
permalink: string | undefined | null,
options?: SelectableQueryOptions<TQCollection, TResult>
) => {
const { audiusSdk } = useAudiusQueryContext()
const { audiusSdk } = useQueryContext()
const queryClient = useQueryClient()
const dispatch = useDispatch()
const { data: currentUserId } = useCurrentUserId()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
import { useDispatch } from 'react-redux'

import { userMetadataListFromSDK } from '~/adapters/user'
import { useAudiusQueryContext } from '~/audius-query'
import { useQueryContext } from '~/api/tan-query/utils'
import { ID } from '~/models/Identifiers'

import { QUERY_KEYS } from '../queryKeys'
Expand All @@ -34,7 +34,7 @@ export const useCollectionFavorites = (
{ collectionId, pageSize = DEFAULT_PAGE_SIZE }: UseCollectionFavoritesArgs,
options?: QueryOptions
) => {
const { audiusSdk } = useAudiusQueryContext()
const { audiusSdk } = useQueryContext()
const { data: currentUserId } = useCurrentUserId()
const queryClient = useQueryClient()
const dispatch = useDispatch()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
import { useDispatch } from 'react-redux'

import { userMetadataListFromSDK } from '~/adapters/user'
import { useAudiusQueryContext } from '~/audius-query'
import { useQueryContext } from '~/api/tan-query/utils'
import { ID } from '~/models/Identifiers'

import { QUERY_KEYS } from '../queryKeys'
Expand All @@ -34,7 +34,7 @@ export const useCollectionReposts = (
{ collectionId, pageSize = DEFAULT_PAGE_SIZE }: UseCollectionRepostsArgs,
options?: QueryOptions
) => {
const { audiusSdk } = useAudiusQueryContext()
const { audiusSdk } = useQueryContext()
const { data: currentUserId } = useCurrentUserId()
const queryClient = useQueryClient()
const dispatch = useDispatch()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { useQueryClient } from '@tanstack/react-query'
import { keyBy } from 'lodash'
import { useDispatch, useSelector } from 'react-redux'

import { useAudiusQueryContext } from '~/audius-query/AudiusQueryContext'
import { useQueryContext } from '~/api/tan-query/utils/QueryContext'
import { ID } from '~/models'
import { CommonState } from '~/store'

Expand All @@ -21,7 +21,7 @@ export const useCollections = (
collectionIds: ID[] | null | undefined,
options?: QueryOptions
) => {
const { audiusSdk } = useAudiusQueryContext()
const { audiusSdk } = useQueryContext()
const { data: currentUserId } = useCurrentUserId()
const queryClient = useQueryClient()
const dispatch = useDispatch()
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { useQuery } from '@tanstack/react-query'

import { useAudiusQueryContext } from '~/audius-query'
import { useQueryContext } from '~/api/tan-query/utils'
import { ID } from '~/models'

import { QUERY_KEYS } from '../queryKeys'
Expand Down Expand Up @@ -28,7 +28,7 @@ export const getExploreContentQueryKey = () => {
export const useExploreContent = <TResult = ExploreContent>(
options?: SelectableQueryOptions<ExploreContent, TResult>
) => {
const { env } = useAudiusQueryContext()
const { env } = useQueryContext()
const exploreContentUrl =
env.EXPLORE_CONTENT_URL ?? STATIC_EXPLORE_CONTENT_URL

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { useDispatch } from 'react-redux'

import { userCollectionMetadataFromSDK } from '~/adapters/collection'
import { transformAndCleanList } from '~/adapters/utils'
import { useAudiusQueryContext } from '~/audius-query'
import { useQueryContext } from '~/api/tan-query/utils'
import { ID } from '~/models/Identifiers'
import { CollectionType } from '~/store/saved-collections/types'

Expand Down Expand Up @@ -61,7 +61,7 @@ export const useLibraryCollections = (
}: UseLibraryCollectionsArgs,
options?: QueryOptions
) => {
const { audiusSdk } = useAudiusQueryContext()
const { audiusSdk } = useQueryContext()
const { data: currentUserId } = useCurrentUserId()
const queryClient = useQueryClient()
const dispatch = useDispatch()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ import { useDispatch, useSelector } from 'react-redux'

import { playlistMetadataForUpdateWithSDK } from '~/adapters/collection'
import { fileToSdk } from '~/adapters/track'
import { useAudiusQueryContext } from '~/audius-query'
import {
getCollectionQueryKey,
getTrackQueryKey,
useCurrentUserId
} from '~/api'
import { useQueryContext } from '~/api/tan-query/utils'
import { isContentUSDCPurchaseGated } from '~/models'
import { Collection } from '~/models/Collection'
import { ID } from '~/models/Identifiers'
Expand All @@ -16,11 +21,6 @@ import { EditCollectionValues } from '~/store/cache/collections/types'
import { removeNullable } from '~/utils'
import { updatePlaylistArtwork } from '~/utils/updatePlaylistArtwork'

import {
getCollectionQueryKey,
getTrackQueryKey,
useCurrentUserId
} from '../..'
import { TQCollection } from '../models'
import { primeCollectionData } from '../utils/primeCollectionData'

Expand All @@ -41,7 +41,7 @@ export const useUpdateCollection = () => {
const {
audiusSdk,
imageUtils: { generatePlaylistArtwork }
} = useAudiusQueryContext()
} = useQueryContext()
const queryClient = useQueryClient()
const account = useSelector(getAccountUser)
const dispatch = useDispatch()
Expand Down
4 changes: 2 additions & 2 deletions packages/common/src/api/tan-query/comments/useComment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import { useEffect } from 'react'
import { useQuery, useQueryClient } from '@tanstack/react-query'
import { useDispatch } from 'react-redux'

import { useAudiusQueryContext } from '~/audius-query'
import { useQueryContext } from '~/api/tan-query/utils'
import { Feature, ID } from '~/models'
import { toast } from '~/store/ui/toast/slice'

import { CommentOrReply, messages } from './types'
import { getCommentQueryKey } from './utils'

export const useComment = (commentId: ID) => {
const { reportToSentry } = useAudiusQueryContext()
const { reportToSentry } = useQueryContext()
const queryClient = useQueryClient()
const dispatch = useDispatch()

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { useInfiniteQuery, useQueryClient } from '@tanstack/react-query'
import { useDispatch } from 'react-redux'

import { replyCommentFromSDK, transformAndCleanList } from '~/adapters'
import { useAudiusQueryContext } from '~/audius-query'
import { useQueryContext } from '~/api/tan-query/utils'
import { Comment, Feature, ID } from '~/models'
import { toast } from '~/store/ui/toast/slice'

Expand All @@ -27,7 +27,7 @@ export const useCommentReplies = (
{ commentId, pageSize = COMMENT_REPLIES_PAGE_SIZE }: GetRepliesArgs,
options?: QueryOptions
) => {
const { audiusSdk, reportToSentry } = useAudiusQueryContext()
const { audiusSdk, reportToSentry } = useQueryContext()
const queryClient = useQueryClient()
const dispatch = useDispatch()
const startingLimit = 3 // comments will load in with 3 already so we don't start pagination at 0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { useMutation, useQueryClient } from '@tanstack/react-query'
import { cloneDeep } from 'lodash'
import { useDispatch } from 'react-redux'

import { useAudiusQueryContext } from '~/audius-query'
import { useQueryContext } from '~/api/tan-query/utils'
import { Comment, Feature, ID, ReplyComment } from '~/models'
import { toast } from '~/store/ui/toast/slice'

Expand All @@ -22,7 +22,7 @@ export type DeleteCommentArgs = {
}

export const useDeleteComment = () => {
const { audiusSdk, reportToSentry } = useAudiusQueryContext()
const { audiusSdk, reportToSentry } = useQueryContext()
const queryClient = useQueryClient()
const dispatch = useDispatch()
return useMutation({
Expand Down
4 changes: 2 additions & 2 deletions packages/common/src/api/tan-query/comments/useEditComment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { EntityType, CommentMention } from '@audius/sdk'
import { useMutation, useQueryClient } from '@tanstack/react-query'
import { useDispatch } from 'react-redux'

import { useAudiusQueryContext } from '~/audius-query'
import { useQueryContext } from '~/api/tan-query/utils'
import { Feature, ID } from '~/models'
import { toast } from '~/store/ui/toast/slice'

Expand All @@ -20,7 +20,7 @@ export type EditCommentArgs = {
}

export const useEditComment = () => {
const { audiusSdk, reportToSentry } = useAudiusQueryContext()
const { audiusSdk, reportToSentry } = useQueryContext()
const queryClient = useQueryClient()
const dispatch = useDispatch()
return useMutation({
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Id, TrackCommentNotificationResponse } from '@audius/sdk'
import { useQuery } from '@tanstack/react-query'

import { useAudiusQueryContext } from '~/audius-query'
import { useQueryContext } from '~/api/tan-query/utils'
import { ID } from '~/models'
import { Nullable } from '~/utils'

Expand All @@ -19,7 +19,7 @@ export const useGetTrackCommentNotificationSetting = (
trackId: ID,
currentUserId: Nullable<ID> | undefined
) => {
const { audiusSdk } = useAudiusQueryContext()
const { audiusSdk } = useQueryContext()

return useQuery({
queryKey: getTrackCommentNotificationSettingQueryKey(trackId),
Expand Down
Loading