better-trakt/src/media/methods.ts

A Trakt.tv client with native Typescript support and quality of life features

import { ApiConfig } from '../client';
import {
  Alias,
  Comment,
  CommentSortByMedia,
  List,
  ListQueryByType,
  MediaRating,
  MovieStats,
  TraktApiContent,
  UpdatedIDs,
  UpdatedStartDate,
  UserProfile,
} from '../trakt';
import { RecommendedPeriod } from '../trakt/media/recommended';
import { Pagination, Filters, fetch } from '../utils';

/**
 *
 * @param ApiConfig
 * @param type
 * @returns
 * @internal
 */
export async function getTrendingMedia<T>(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  {
    pagination,
    filters,
  }: {
    pagination: Pagination;
    filters?: Filters;
  },
) {
  const url = `${apiUrl}/${type}/trending`;
  const response = await fetch<T>(client, url, { pagination, filters });

  return response;
}

/**
 *
 * @param ApiConfig
 * @param type
 * @returns
 * @internal
 */
export async function getPopularMedia(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  {
    pagination,
    filters,
  }: {
    pagination: Pagination;
    filters?: Filters;
  },
) {
  const url = `${apiUrl}/${type}/popular`;
  const response = await fetch<TraktApiContent[]>(client, url, { pagination, filters });

  return response;
}

/**
 * Gets recommended media for shows and movies
 * @param ApiConfig
 * @param type
 * @param options
 * @returns
 */
export async function getRecommendedMedia<T>(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  {
    pagination,
    filters,
    period,
  }: {
    pagination: Pagination;
    filters?: Filters;
    period?: RecommendedPeriod;
  },
) {
  const url = `${apiUrl}/${type}/recommended`;
  const response = await fetch<T>(client, url, { pagination, filters, period });

  return response;
}

/**
 * Gets most played media for shows and movies
 * @param ApiConfig
 * @param type
 * @param options
 * @returns
 */
export async function getPlayedMedia<T>(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  {
    pagination,
    filters,
    period,
  }: {
    pagination: Pagination;
    filters?: Filters;
    period?: RecommendedPeriod;
  },
) {
  const url = `${apiUrl}/${type}/played`;
  const response = await fetch<T>(client, url, { pagination, filters, period });

  return response;
}

/**
 * Gets recently updated media
 * @param ApiConfig
 * @param type
 * @param options
 * @returns
 */
export async function getUpdatesMedia<T>(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  {
    pagination,
    startDate,
  }: {
    pagination: Pagination;
    startDate?: UpdatedStartDate;
  },
) {
  const url = `${apiUrl}/${type}/updates`;
  const response = await fetch<T>(client, url, { pagination, startDate });

  return response;
}

/**
 * Gets recently updated ids of media
 * @param ApiConfig
 * @param type
 * @param options
 * @returns
 */
export async function getUpdatedIDsMedia(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  {
    pagination,
    startDate,
  }: {
    pagination: Pagination;
    startDate?: UpdatedStartDate;
  },
) {
  const url = `${apiUrl}/${type}/updates/id`;
  const response = await fetch<UpdatedIDs>(client, url, { pagination, startDate });

  return response;
}

/**
 * Gets all title aliases for media
 * @param ApiConfig
 * @param type
 * @param options
 * @returns
 */
export async function getAliasesMedia(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  {
    mediaID,
  }: {
    mediaID: string;
  },
) {
  const url = `${apiUrl}/${type}/${mediaID}/aliases`;
  const response = await fetch<Alias[]>(client, url);

  return response;
}

/**
 * Gets most anticipated media for shows and movies
 * @param ApiConfig
 * @param type
 * @param options
 * @returns
 */
export async function getAnticipatedMedia<T>(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  {
    pagination,
    filters,
  }: {
    pagination: Pagination;
    filters?: Filters;
  },
) {
  const url = `${apiUrl}/${type}/anticipated`;
  const response = await fetch<T>(client, url, { pagination, filters });

  return response;
}

/**
 * Gets most watched (unique users) media for shows and movies
 * @param ApiConfig
 * @param type
 * @param options
 * @returns
 */
export async function getWatchedMedia<T>(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  {
    pagination,
    filters,
    period,
  }: {
    pagination: Pagination;
    filters?: Filters;
    period?: RecommendedPeriod;
  },
) {
  const url = `${apiUrl}/${type}/watched`;
  const response = await fetch<T>(client, url, { pagination, filters, period });

  return response;
}

/**
 * Gets the media with the biggest box office revenue
 * @param ApiConfig
 * @param type
 * @returns
 */
export async function getBoxOfficeMedia<T>({ client, apiUrl }: ApiConfig, type: 'movies' | 'shows') {
  const url = `${apiUrl}/${type}/boxoffice`;
  const response = await fetch<T>(client, url);

  return response;
}

/**
 * Gets most collected (unique users) media for shows and movies
 * @param ApiConfig
 * @param type
 * @param options
 * @returns
 */
export async function getCollectedMedia<T>(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  {
    pagination,
    filters,
    period,
  }: {
    pagination: Pagination;
    filters?: Filters;
    period?: RecommendedPeriod;
  },
) {
  const url = `${apiUrl}/${type}/collected`;
  const response = await fetch<T>(client, url, { pagination, filters, period });

  return response;
}

/**
 *
 * @param ApiConfig
 * @param movieId
 * @returns
 * @internal
 */
export async function getMediaPeople<T>({ client, apiUrl }: ApiConfig, movieId: string) {
  const url = `${apiUrl}/${movieId}/people`;
  const response = await fetch<T>(client, url);

  return response;
}

/**
 *
 * @param ApiConfig
 * @param showId
 * @returns
 * @internal
 */
export async function getMediaSummary_Full<T>({ client, apiUrl }: ApiConfig, showId: string) {
  const url = `${apiUrl}/${showId}?extended=full`;
  const response = await fetch<T>(client, url);

  return response;
}

export async function getMediaTranslations<T>(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  mediaId: string,
  language?: string,
) {
  const url = `${apiUrl}/${type}/${mediaId}/translations`;
  const response = await fetch<T>(client, url, { language });

  return response;
}

export async function getMediaComments(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  mediaId: string,
  {
    pagination,
    sort,
  }: {
    pagination: Pagination;
    sort?: CommentSortByMedia;
  },
) {
  const url = `${apiUrl}/${type}/${mediaId}/translations`;
  const response = await fetch<Comment[]>(client, url, { pagination, sort });

  return response;
}

export async function getListsWithMedia(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  mediaId: string,
  {
    pagination,
    type: listType,
    sort,
  }: {
    pagination: Pagination;
    type?: ListQueryByType;
    sort?: CommentSortByMedia;
  },
) {
  const url = `${apiUrl}/${type}/${mediaId}/lists`;
  const response = await fetch<List[]>(client, url, { pagination, sort, type: listType });

  return response;
}

export async function getMediaRating({ client, apiUrl }: ApiConfig, type: 'movies' | 'shows', mediaId: string) {
  const url = `${apiUrl}/${type}/${mediaId}/ratings`;
  const response = await fetch<MediaRating>(client, url);

  return response;
}

export async function getRelatedMedia(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  mediaId: string,
  {
    pagination,
  }: {
    pagination: Pagination;
  },
) {
  const url = `${apiUrl}/${type}/${mediaId}/related`;
  const response = await fetch<TraktApiContent[]>(client, url, { pagination });

  return response;
}

export async function getMediaStats<T extends MovieStats>(
  { client, apiUrl }: ApiConfig,
  type: 'movies' | 'shows',
  mediaId: string,
) {
  const url = `${apiUrl}/${type}/${mediaId}/stats`;
  const response = await fetch<T>(client, url);

  return response;
}

export async function getWatchingMedia({ client, apiUrl }: ApiConfig, type: 'movies' | 'shows', mediaId: string) {
  const url = `${apiUrl}/${type}/${mediaId}/watching`;
  const response = await fetch<UserProfile[]>(client, url);

  return response;
}