./schema/lastfm/user

index.ts

import { gql } from "apollo-server";
import { DocumentNode } from "graphql";

const UserDefs: DocumentNode = gql`
  extend type LastFM {
    users(
      "The user to fetch info for."
      user: String!
    ): User
  }
  
  "Last.fm 'period' enum"
  enum LASTFM_PERIOD {
    overall
    7day
    1month
    3month
    6month
    12month
  }

  "Last.fm user resource"
  type User {
    info: UserInfo
    tracks: UserTracks

    "Last.fm user's top resources"
    top(
      """
      The time period over which to retrieve top albums for.
      Available options: overall | 7day | 1month | 3month | 6month | 12month
      """
      period: LASTFM_PERIOD!

      "The number of results to fetch per page. Defaults to 50."
      limit: Int

      "The page number to fetch. Defaults to first page."
      page: Int
    ): UserTops

    "Last.fm user charts"
    charts: UserCharts
  }

  "Last.fm user charts resource"
  type UserCharts {
    """
    Get a list of available charts for this user, expressed as date ranges which can be sent to the chart services.
    """
    list: [UserChartList]

    """
    Get an album chart for a user profile, for a given date range. If no date range is supplied, it will return the most recent album chart for this user.
    """
    weeklyAlbums(from: String, to: String): [UserWeeklyAlbum]

    """
    Get an artist chart for a user profile, for a given date range. If no date range is supplied, it will return the most recent artist chart for this user.
    """
    weeklyArtists(from: String, to: String): [UserWeeklyArtist]

    """
    Get a track chart for a user profile, for a given date range. If no date range is supplied, it will return the most recent track chart for this user.
    """
    weeklyTracks(from: String, to: String): [UserWeeklyTrack]
  }

  "Last.fm user tracks resources"
  type UserTracks {
    "User's recent tracks"
    recent(
      "The number of results to fetch per page. Defaults to 50. Maximum is 200."
      limit: Int

      "The page number to fetch. Defaults to first page."
      page: Int

      """
      Beginning timestamp of a range
      only display scrobbles after this time, in UNIX timestamp format (integer number of seconds since 00:00:00, January 1st 1970 UTC).
      This must be in the UTC time zone.
      """
      from: String

      """
      End timestamp of a range
      only display scrobbles before this time, in UNIX timestamp format (integer number of seconds since 00:00:00, January 1st 1970 UTC).
      This must be in the UTC time zone.
      """
      to: String

      "Includes extended data in each artist, and whether or not the user has loved each track"
      extended: Boolean = 1
    ): [Track]

    "User's loved tracks"
    loved(
      "The number of results to fetch per page. Defaults to 50."
      limit: Int

      "The page number to fetch. Defaults to first page."
      page: Int
    ): [Track]
  }

  "Last.fm user tops resources"
  type UserTops {
    "User's top albums"
    albums: [Album]

    "User's top artists"
    artists: [Artist]

    "User's top tracks"
    tracks: [Track]
  }

  "Last.fm user info"
  type UserInfo {
    playlists: Int!
    playcount: Int!
    gender: String!
    name: String!
    subscriber: Int!
    url: String!
    country: String!
    images: [Image]!
    age: Int!
    realname: String!
  }

  type UserChartList {
    from: String!
    to: String!
  }

  type UserWeeklyAlbum {
    artist: UserWeeklyArtist
    rank: Int!
    mbid: String
    playcount: Int!
    name: String!
    url: String!
  }

  type UserWeeklyTrack {
    artist: UserWeeklyArtist
    rank: Int!
    mbid: String
    url: String!
    image: [Image]
    name: String!
    playcount: Int!
  }

  type UserWeeklyArtist {
    name: String!
    mbid: String
    playcount: Int
    url: String
    rank: Int
  }
`;

export { UserDefs };