@audius/sdk 0.0.0

package/src/services/discoveryProvider/requests.ts

@@ -0,0 +1,629 @@
+/* eslint-disable @typescript-eslint/restrict-plus-operands */
+
+export const getUsers = (
+  limit = 100,
+  offset = 0,
+  idsArray?: string[],
+  walletAddress?: string,
+  handle?: string,
+  isCreator: boolean | null = null,
+  minBlockNumber?: number
+) => {
+  type QueryParams = {
+    limit: number
+    offset: number
+    is_creator?: boolean
+    handle?: string
+    wallet?: string
+    min_block_number?: number
+    id?: string[]
+  }
+
+  const queryParams: QueryParams = { limit: limit, offset: offset }
+  if (isCreator !== null) {
+    queryParams.is_creator = isCreator
+  }
+  if (handle) {
+    queryParams.handle = handle
+  }
+  if (walletAddress) {
+    queryParams.wallet = walletAddress
+  }
+  if (minBlockNumber) {
+    queryParams.min_block_number = minBlockNumber
+  }
+  if (idsArray != null) {
+    if (!Array.isArray(idsArray)) {
+      throw new Error('Expected integer array of user ids')
+    }
+    queryParams.id = idsArray
+  }
+
+  const req = { endpoint: 'users', queryParams }
+
+  return req
+}
+
+export const getTracks = (
+  limit = 100,
+  offset = 0,
+  idsArray?: string[],
+  targetUserId?: string,
+  sort?: boolean,
+  minBlockNumber?: number,
+  filterDeleted?: boolean,
+  withUsers = false
+) => {
+  type QueryParams = {
+    limit: number
+    offset: number
+    id?: string[]
+    min_block_number?: number
+    user_id?: string
+    sort?: boolean
+    filter_deleted?: boolean
+    with_users?: boolean
+  }
+
+  const queryParams: QueryParams = { limit: limit, offset: offset }
+
+  if (idsArray) {
+    if (!Array.isArray(idsArray)) {
+      throw new Error('Expected array of track ids')
+    }
+    queryParams.id = idsArray
+  }
+  if (minBlockNumber) {
+    queryParams.min_block_number = minBlockNumber
+  }
+  if (targetUserId) {
+    queryParams.user_id = targetUserId
+  }
+  if (sort) {
+    queryParams.sort = sort
+  }
+  if (typeof filterDeleted === 'boolean') {
+    queryParams.filter_deleted = filterDeleted
+  }
+  if (withUsers) {
+    queryParams.with_users = true
+  }
+
+  const req = { endpoint: 'tracks', queryParams }
+  return req
+}
+
+export const getTracksByHandleAndSlug = (handle: string, slug: string) => {
+  return {
+    endpoint: 'v1/tracks',
+    method: 'get',
+    queryParams: { handle, slug }
+  }
+}
+
+export const getTracksIncludingUnlisted = (
+  identifiers: string[],
+  withUsers = false
+) => {
+  const queryParams: { with_users?: boolean } = {}
+
+  if (withUsers) {
+    queryParams.with_users = true
+  }
+
+  const req = {
+    endpoint: 'tracks_including_unlisted',
+    method: 'post',
+    data: {
+      tracks: identifiers
+    },
+    queryParams
+  }
+
+  return req
+}
+
+export const getRandomTracks = (
+  genre: string,
+  limit: number,
+  exclusionList: number[],
+  time: string
+) => {
+  const req = {
+    endpoint: 'tracks/random',
+    queryParams: {
+      genre,
+      limit,
+      exclusionList,
+      time
+    }
+  }
+  return req
+}
+
+export const getStemsForTrack = (trackId: number) => {
+  const req = {
+    endpoint: `stems/${trackId}`,
+    queryParams: {
+      with_users: true
+    }
+  }
+  return req
+}
+
+export const getRemixesOfTrack = (
+  trackId: number,
+  limit: number | null = null,
+  offset: number | null = null
+) => {
+  const req = {
+    endpoint: `remixes/${trackId}/children`,
+    queryParams: {
+      with_users: true,
+      limit,
+      offset
+    }
+  }
+  return req
+}
+
+export const getRemixTrackParents = (
+  trackId: number,
+  limit: number | null = null,
+  offset: number | null = null
+) => {
+  const req = {
+    endpoint: `remixes/${trackId}/parents`,
+    queryParams: {
+      with_users: true,
+      limit,
+      offset
+    }
+  }
+  return req
+}
+
+export const getTrendingTracks = (
+  genre: string | null = null,
+  timeFrame: string | null = null,
+  idsArray: number[] | null = null,
+  limit: number | null = null,
+  offset: number | null = null,
+  withUsers = false
+) => {
+  let endpoint = '/trending/'
+
+  if (timeFrame != null) {
+    switch (timeFrame) {
+      case 'day':
+      case 'week':
+      case 'month':
+      case 'year':
+        break
+      default:
+        throw new Error('Invalid timeFrame value provided')
+    }
+    endpoint += `${endpoint}${timeFrame}`
+  }
+
+  const req = {
+    endpoint,
+    method: 'get',
+    queryParams: {
+      ...(idsArray !== null ? { id: idsArray } : {}),
+      ...(limit !== null ? { limit } : {}),
+      ...(offset !== null ? { offset } : {}),
+      ...(genre !== null ? { genre } : {}),
+      ...(withUsers ? { with_users: withUsers } : {})
+    }
+  }
+  return req
+}
+
+export const getPlaylists = (
+  limit = 100,
+  offset = 0,
+  idsArray = null,
+  targetUserId = null,
+  withUsers = false
+) => {
+  if (idsArray != null) {
+    if (!Array.isArray(idsArray)) {
+      throw new Error('Expected integer array of user ids')
+    }
+  }
+  return {
+    endpoint: 'playlists',
+    queryParams: {
+      limit,
+      offset,
+      ...(idsArray != null ? { playlist_id: idsArray } : {}),
+      ...(targetUserId ? { user_id: targetUserId } : {}),
+      ...(withUsers ? { with_users: true } : {})
+    }
+  }
+}
+
+export const getSocialFeed = (
+  filter: string,
+  limit = 100,
+  offset = 0,
+  withUsers = false,
+  tracksOnly = false
+) => {
+  return {
+    endpoint: 'feed',
+    queryParams: {
+      filter,
+      limit,
+      offset,
+      with_users: withUsers,
+      tracks_only: tracksOnly
+    }
+  }
+}
+
+export const getUserRepostFeed = (
+  userId: number,
+  limit = 100,
+  offset = 0,
+  withUsers = false
+) => {
+  return {
+    endpoint: 'feed',
+    urlParams: '/reposts/' + userId,
+    queryParams: { limit, offset, with_users: withUsers }
+  }
+}
+
+export const getFollowIntersectionUsers = (
+  limit = 100,
+  offset = 0,
+  followeeUserId: number,
+  followerUserId: number
+) => {
+  return {
+    endpoint: 'users',
+    urlParams: '/intersection/follow/' + followeeUserId + '/' + followerUserId,
+    queryParams: { limit, offset }
+  }
+}
+
+export const getTrackRepostIntersectionUsers = (
+  limit = 100,
+  offset = 0,
+  repostTrackId: number,
+  followerUserId: number
+) => {
+  return {
+    endpoint: 'users',
+    urlParams:
+      '/intersection/repost/track/' + repostTrackId + '/' + followerUserId,
+    queryParams: { limit: limit, offset: offset }
+  }
+}
+
+export const getPlaylistRepostIntersectionUsers = (
+  limit = 100,
+  offset = 0,
+  repostPlaylistId: number,
+  followerUserId: number
+) => {
+  return {
+    endpoint: 'users',
+    urlParams:
+      '/intersection/repost/playlist/' +
+      repostPlaylistId +
+      '/' +
+      followerUserId,
+    queryParams: { limit: limit, offset: offset }
+  }
+}
+
+export const getFollowersForUser = (
+  limit = 100,
+  offset = 0,
+  followeeUserId: number
+) => {
+  return {
+    endpoint: 'users',
+    urlParams: '/followers/' + followeeUserId,
+    queryParams: { limit: limit, offset: offset }
+  }
+}
+
+export const getFolloweesForUser = (
+  limit = 100,
+  offset = 0,
+  followerUserId: number
+) => {
+  return {
+    endpoint: 'users',
+    urlParams: '/followees/' + followerUserId,
+    queryParams: { limit: limit, offset: offset }
+  }
+}
+
+export const getRepostersForTrack = (
+  limit = 100,
+  offset = 0,
+  repostTrackId: number
+) => {
+  return {
+    endpoint: 'users',
+    urlParams: '/reposts/track/' + repostTrackId,
+    queryParams: { limit: limit, offset: offset }
+  }
+}
+
+export const getRepostersForPlaylist = (
+  limit = 100,
+  offset = 0,
+  repostPlaylistId: number
+) => {
+  return {
+    endpoint: 'users',
+    urlParams: '/reposts/playlist/' + repostPlaylistId,
+    queryParams: { limit: limit, offset: offset }
+  }
+}
+
+export const getSaversForTrack = (
+  limit = 100,
+  offset = 0,
+  saveTrackId: number
+) => {
+  return {
+    endpoint: 'users',
+    urlParams: '/saves/track/' + saveTrackId,
+    queryParams: { limit: limit, offset: offset }
+  }
+}
+
+export const getSaversForPlaylist = (
+  limit = 100,
+  offset = 0,
+  savePlaylistId: number
+) => {
+  return {
+    endpoint: 'users',
+    urlParams: '/saves/playlist/' + savePlaylistId,
+    queryParams: { limit: limit, offset: offset }
+  }
+}
+
+export const searchFull = (
+  text: string,
+  kind: string,
+  limit = 100,
+  offset = 0
+) => {
+  return {
+    endpoint: 'search/full',
+    queryParams: { query: text, kind, limit, offset }
+  }
+}
+
+export const searchAutocomplete = (text: string, limit = 100, offset = 0) => {
+  return {
+    endpoint: 'search/autocomplete',
+    queryParams: { query: text, limit: limit, offset: offset }
+  }
+}
+
+export const searchTags = (
+  text: string,
+  userTagCount = 2,
+  kind = 'all',
+  limit = 100,
+  offset = 0
+) => {
+  return {
+    endpoint: 'search/tags',
+    queryParams: {
+      query: text,
+      user_tag_count: userTagCount,
+      kind,
+      limit,
+      offset
+    }
+  }
+}
+
+export const getSavedPlaylists = (
+  limit = 100,
+  offset = 0,
+  withUsers = false
+) => {
+  return {
+    endpoint: 'saves/playlists',
+    queryParams: { limit: limit, offset: offset, with_users: withUsers }
+  }
+}
+
+export const getSavedAlbums = (limit = 100, offset = 0, withUsers = false) => {
+  return {
+    endpoint: 'saves/albums',
+    queryParams: { limit: limit, offset: offset, with_users: withUsers }
+  }
+}
+
+export const getSavedTracks = (limit = 100, offset = 0, withUsers = false) => {
+  return {
+    endpoint: 'saves/tracks',
+    queryParams: { limit: limit, offset: offset, with_users: withUsers }
+  }
+}
+
+/**
+ * Return user collections (saved & uploaded) along w/ users for those collections
+ */
+export const getUserAccount = (wallet: string) => {
+  if (wallet === undefined) {
+    throw new Error('Expected wallet to get user account')
+  }
+  return {
+    endpoint: 'users/account',
+    queryParams: { wallet }
+  }
+}
+
+export const getTopPlaylists = (
+  type: string,
+  limit: number,
+  mood: string,
+  filter: string,
+  withUsers = false
+) => {
+  return {
+    endpoint: `/top/${type}`,
+    queryParams: {
+      limit,
+      mood,
+      filter,
+      with_users: withUsers
+    }
+  }
+}
+
+export const getTopFolloweeWindowed = (
+  type: string,
+  window: string,
+  limit: string,
+  withUsers = false
+) => {
+  return {
+    endpoint: `/top_followee_windowed/${type}/${window}`,
+    queryParams: {
+      limit,
+      with_users: withUsers
+    }
+  }
+}
+
+export const getTopFolloweeSaves = (
+  type: string,
+  limit: string,
+  withUsers = false
+) => {
+  return {
+    endpoint: `/top_followee_saves/${type}`,
+    queryParams: {
+      limit,
+      with_users: withUsers
+    }
+  }
+}
+
+export const getLatest = (type: string) => {
+  return {
+    endpoint: `/latest/${type}`
+  }
+}
+
+export const getTopCreatorsByGenres = (
+  genres: string[],
+  limit = 30,
+  offset = 0,
+  withUsers = false
+) => {
+  return {
+    endpoint: 'users/genre/top',
+    queryParams: { genre: genres, limit, offset, with_users: withUsers }
+  }
+}
+
+export const getURSMContentNodes = (ownerWallet: string | null) => {
+  return {
+    endpoint: 'ursm_content_nodes',
+    queryParams: {
+      owner_wallet: ownerWallet
+    }
+  }
+}
+
+export const getNotifications = (
+  minBlockNumber: string,
+  trackIds: string[],
+  timeout: number
+) => {
+  return {
+    endpoint: 'notifications',
+    queryParams: {
+      min_block_number: minBlockNumber,
+      track_id: trackIds
+    },
+    timeout
+  }
+}
+
+export const getSolanaNotifications = (
+  minSlotNumber: number,
+  timeout: number
+) => {
+  return {
+    endpoint: 'solana_notifications',
+    queryParams: {
+      min_slot_number: minSlotNumber
+    },
+    timeout
+  }
+}
+
+export const getTrackListenMilestones = (timeout: number) => {
+  return {
+    endpoint: 'track_listen_milestones',
+    timeout
+  }
+}
+
+export const getChallengeAttestation = (
+  challengeId: string,
+  encodedUserId: string,
+  specifier: string,
+  oracleAddress: string
+) => {
+  return {
+    endpoint: `/v1/challenges/${challengeId}/attest`,
+    queryParams: {
+      user_id: encodedUserId,
+      specifier,
+      oracle: oracleAddress
+    }
+  }
+}
+
+export const getCreateSenderAttestation = (senderEthAddress: string) => {
+  return {
+    endpoint: '/v1/challenges/attest_sender',
+    queryParams: {
+      sender_eth_address: senderEthAddress
+    }
+  }
+}
+
+export const getUndisbursedChallenges = (
+  limit: number | null,
+  offset: number | null,
+  completedBlockNumber: string | null,
+  encodedUserId: number | null
+) => {
+  return {
+    endpoint: '/v1/challenges/undisbursed',
+    queryParams: {
+      limit,
+      offset,
+      completed_blocknumber: completedBlockNumber,
+      user_id: encodedUserId
+    }
+  }
+}
+
+export const verifyToken = (token: string) => {
+  return {
+    endpoint: '/v1/users/verify_token',
+    queryParams: {
+      token: token
+    }
+  }
+}