ani-client 1.1.0 → 1.2.0

package/dist/index.js

@@ -33,6 +33,20 @@ var MEDIA_FIELDS = `
   trending
   tags { id name description category rank isMediaSpoiler }
   studios { nodes { id name isAnimationStudio siteUrl } }
+  relations {
+    edges {
+      relationType(version: 2)
+      node {
+        id
+        title { romaji english native userPreferred }
+        type
+        format
+        status
+        coverImage { large medium }
+        siteUrl
+      }
+    }
+  }
   isAdult
   siteUrl
 `;
@@ -215,6 +229,124 @@ query ($type: MediaType, $sort: [MediaSort], $page: Int, $perPage: Int) {
     }
   }
 }`;
+var QUERY_MEDIA_BY_SEASON = `
+query ($season: MediaSeason!, $seasonYear: Int!, $type: MediaType, $sort: [MediaSort], $page: Int, $perPage: Int) {
+  Page(page: $page, perPage: $perPage) {
+    pageInfo { total perPage currentPage lastPage hasNextPage }
+    media(season: $season, seasonYear: $seasonYear, type: $type, sort: $sort) {
+      ${MEDIA_FIELDS}
+    }
+  }
+}`;
+var MEDIA_LIST_FIELDS = `
+  id
+  mediaId
+  status
+  score(format: POINT_100)
+  progress
+  progressVolumes
+  repeat
+  priority
+  private
+  notes
+  startedAt { year month day }
+  completedAt { year month day }
+  updatedAt
+  createdAt
+  media {
+    ${MEDIA_FIELDS}
+  }
+`;
+var QUERY_RECOMMENDATIONS = `
+query ($mediaId: Int!, $page: Int, $perPage: Int, $sort: [RecommendationSort]) {
+  Media(id: $mediaId) {
+    recommendations(page: $page, perPage: $perPage, sort: $sort) {
+      pageInfo { total perPage currentPage lastPage hasNextPage }
+      nodes {
+        id
+        rating
+        userRating
+        mediaRecommendation {
+          id
+          idMal
+          title { romaji english native userPreferred }
+          type
+          format
+          status
+          coverImage { extraLarge large medium color }
+          bannerImage
+          genres
+          averageScore
+          meanScore
+          popularity
+          favourites
+          siteUrl
+        }
+        user {
+          id
+          name
+          avatar { large medium }
+        }
+      }
+    }
+  }
+}`;
+var QUERY_USER_MEDIA_LIST = `
+query ($userId: Int, $userName: String, $type: MediaType!, $status: MediaListStatus, $sort: [MediaListSort], $page: Int, $perPage: Int) {
+  Page(page: $page, perPage: $perPage) {
+    pageInfo { total perPage currentPage lastPage hasNextPage }
+    mediaList(userId: $userId, userName: $userName, type: $type, status: $status, sort: $sort) {
+      ${MEDIA_LIST_FIELDS}
+    }
+  }
+}`;
+var STUDIO_FIELDS = `
+  id
+  name
+  isAnimationStudio
+  siteUrl
+  favourites
+  media(page: 1, perPage: 25, sort: POPULARITY_DESC) {
+    pageInfo { total perPage currentPage lastPage hasNextPage }
+    nodes {
+      id
+      title { romaji english native userPreferred }
+      type
+      format
+      coverImage { large medium }
+      siteUrl
+    }
+  }
+`;
+var QUERY_STUDIO_BY_ID = `
+query ($id: Int!) {
+  Studio(id: $id) {
+    ${STUDIO_FIELDS}
+  }
+}`;
+var QUERY_STUDIO_SEARCH = `
+query ($search: String, $page: Int, $perPage: Int) {
+  Page(page: $page, perPage: $perPage) {
+    pageInfo { total perPage currentPage lastPage hasNextPage }
+    studios(search: $search) {
+      ${STUDIO_FIELDS}
+    }
+  }
+}`;
+var QUERY_GENRES = `
+query {
+  GenreCollection
+}`;
+var QUERY_TAGS = `
+query {
+  MediaTagCollection {
+    id
+    name
+    description
+    category
+    isAdult
+  }
+}`;
 
 // src/errors/index.ts
 var AniListError = class extends Error {
@@ -551,6 +683,195 @@ var AniListClient = class {
     const data = await this.request(QUERY_PLANNING, variables);
     return { pageInfo: data.Page.pageInfo, results: data.Page.media };
   }
+  /**
+   * Get recommendations for a specific media.
+   *
+   * Returns other anime/manga that users have recommended based on the given media.
+   *
+   * @param mediaId - The AniList media ID
+   * @param options - Optional sort / pagination parameters
+   * @returns Paginated list of recommendations
+   *
+   * @example
+   * ```ts
+   * // Get recommendations for Cowboy Bebop
+   * const recs = await client.getRecommendations(1);
+   * recs.results.forEach((r) =>
+   *   console.log(`${r.mediaRecommendation.title.romaji} (rating: ${r.rating})`)
+   * );
+   * ```
+   */
+  async getRecommendations(mediaId, options = {}) {
+    const variables = {
+      mediaId,
+      sort: options.sort ?? ["RATING_DESC"],
+      page: options.page ?? 1,
+      perPage: options.perPage ?? 20
+    };
+    const data = await this.request(QUERY_RECOMMENDATIONS, variables);
+    return {
+      pageInfo: data.Media.recommendations.pageInfo,
+      results: data.Media.recommendations.nodes
+    };
+  }
+  /**
+   * Get anime (or manga) for a specific season and year.
+   *
+   * @param options - Season, year and optional filter / pagination parameters
+   * @returns Paginated list of media for the given season
+   *
+   * @example
+   * ```ts
+   * import { MediaSeason } from "ani-client";
+   *
+   * const winter2026 = await client.getMediaBySeason({
+   *   season: MediaSeason.WINTER,
+   *   seasonYear: 2026,
+   *   perPage: 10,
+   * });
+   * ```
+   */
+  async getMediaBySeason(options) {
+    const variables = {
+      season: options.season,
+      seasonYear: options.seasonYear,
+      type: options.type ?? "ANIME",
+      sort: options.sort ?? ["POPULARITY_DESC"],
+      page: options.page ?? 1,
+      perPage: options.perPage ?? 20
+    };
+    const data = await this.request(QUERY_MEDIA_BY_SEASON, variables);
+    return { pageInfo: data.Page.pageInfo, results: data.Page.media };
+  }
+  /**
+   * Get a user's anime or manga list.
+   *
+   * Provide either `userId` or `userName` to identify the user.
+   * Requires `type` (ANIME or MANGA). Optionally filter by list status.
+   *
+   * @param options - User identifier, media type, and optional filters
+   * @returns Paginated list of media list entries
+   *
+   * @example
+   * ```ts
+   * import { MediaType, MediaListStatus } from "ani-client";
+   *
+   * // Get a user's completed anime list
+   * const list = await client.getUserMediaList({
+   *   userName: "AniList",
+   *   type: MediaType.ANIME,
+   *   status: MediaListStatus.COMPLETED,
+   * });
+   * list.results.forEach((entry) =>
+   *   console.log(`${entry.media.title.romaji} — ${entry.score}/100`)
+   * );
+   * ```
+   */
+  async getUserMediaList(options) {
+    if (!options.userId && !options.userName) {
+      throw new Error("Either userId or userName must be provided");
+    }
+    const variables = {
+      userId: options.userId,
+      userName: options.userName,
+      type: options.type,
+      status: options.status,
+      sort: options.sort,
+      page: options.page ?? 1,
+      perPage: options.perPage ?? 20
+    };
+    const data = await this.request(QUERY_USER_MEDIA_LIST, variables);
+    return { pageInfo: data.Page.pageInfo, results: data.Page.mediaList };
+  }
+  /**
+   * Fetch a studio by its AniList ID.
+   *
+   * Returns studio details along with its most popular productions.
+   *
+   * @param id - The AniList studio ID
+   */
+  async getStudio(id) {
+    const data = await this.request(QUERY_STUDIO_BY_ID, { id });
+    return data.Studio;
+  }
+  /**
+   * Search for studios by name.
+   *
+   * @param options - Search / pagination parameters
+   * @returns Paginated list of studios
+   *
+   * @example
+   * ```ts
+   * const studios = await client.searchStudios({ query: "MAPPA" });
+   * ```
+   */
+  async searchStudios(options = {}) {
+    const variables = {
+      search: options.query,
+      page: options.page ?? 1,
+      perPage: options.perPage ?? 20
+    };
+    const data = await this.request(QUERY_STUDIO_SEARCH, variables);
+    return { pageInfo: data.Page.pageInfo, results: data.Page.studios };
+  }
+  /**
+   * Get all available genres on AniList.
+   *
+   * @returns Array of genre strings (e.g. "Action", "Adventure", ...)
+   */
+  async getGenres() {
+    const data = await this.request(QUERY_GENRES);
+    return data.GenreCollection;
+  }
+  /**
+   * Get all available media tags on AniList.
+   *
+   * @returns Array of tag objects with id, name, description, category, isAdult
+   */
+  async getTags() {
+    const data = await this.request(QUERY_TAGS);
+    return data.MediaTagCollection;
+  }
+  /**
+   * Auto-paginating async iterator.
+   *
+   * Wraps any paginated method and yields individual items across all pages.
+   * Stops when `hasNextPage` is `false` or `maxPages` is reached.
+   *
+   * @param fetchPage - A function that takes a page number and returns a `PagedResult<T>`
+   * @param maxPages - Maximum number of pages to fetch (default: Infinity)
+   * @returns An async iterable iterator of individual items
+   *
+   * @example
+   * ```ts
+   * // Iterate over all search results
+   * for await (const anime of client.paginate((page) =>
+   *   client.searchMedia({ query: "Naruto", page, perPage: 10 })
+   * )) {
+   *   console.log(anime.title.romaji);
+   * }
+   *
+   * // Limit to 3 pages
+   * for await (const anime of client.paginate(
+   *   (page) => client.getTrending(MediaType.ANIME, page, 20),
+   *   3,
+   * )) {
+   *   console.log(anime.title.romaji);
+   * }
+   * ```
+   */
+  async *paginate(fetchPage, maxPages = Infinity) {
+    let page = 1;
+    let hasNext = true;
+    while (hasNext && page <= maxPages) {
+      const result = await fetchPage(page);
+      for (const item of result.results) {
+        yield item;
+      }
+      hasNext = result.pageInfo.hasNextPage === true;
+      page++;
+    }
+  }
   /**
    * Clear the entire response cache.
    */
@@ -637,17 +958,86 @@ var CharacterSort = /* @__PURE__ */ ((CharacterSort2) => {
   CharacterSort2["FAVOURITES"] = "FAVOURITES";
   return CharacterSort2;
 })(CharacterSort || {});
+var MediaRelationType = /* @__PURE__ */ ((MediaRelationType2) => {
+  MediaRelationType2["ADAPTATION"] = "ADAPTATION";
+  MediaRelationType2["PREQUEL"] = "PREQUEL";
+  MediaRelationType2["SEQUEL"] = "SEQUEL";
+  MediaRelationType2["PARENT"] = "PARENT";
+  MediaRelationType2["SIDE_STORY"] = "SIDE_STORY";
+  MediaRelationType2["CHARACTER"] = "CHARACTER";
+  MediaRelationType2["SUMMARY"] = "SUMMARY";
+  MediaRelationType2["ALTERNATIVE"] = "ALTERNATIVE";
+  MediaRelationType2["SPIN_OFF"] = "SPIN_OFF";
+  MediaRelationType2["OTHER"] = "OTHER";
+  MediaRelationType2["SOURCE"] = "SOURCE";
+  MediaRelationType2["COMPILATION"] = "COMPILATION";
+  MediaRelationType2["CONTAINS"] = "CONTAINS";
+  return MediaRelationType2;
+})(MediaRelationType || {});
+var RecommendationSort = /* @__PURE__ */ ((RecommendationSort2) => {
+  RecommendationSort2["ID"] = "ID";
+  RecommendationSort2["ID_DESC"] = "ID_DESC";
+  RecommendationSort2["RATING"] = "RATING";
+  RecommendationSort2["RATING_DESC"] = "RATING_DESC";
+  return RecommendationSort2;
+})(RecommendationSort || {});
+var MediaListStatus = /* @__PURE__ */ ((MediaListStatus2) => {
+  MediaListStatus2["CURRENT"] = "CURRENT";
+  MediaListStatus2["PLANNING"] = "PLANNING";
+  MediaListStatus2["COMPLETED"] = "COMPLETED";
+  MediaListStatus2["DROPPED"] = "DROPPED";
+  MediaListStatus2["PAUSED"] = "PAUSED";
+  MediaListStatus2["REPEATING"] = "REPEATING";
+  return MediaListStatus2;
+})(MediaListStatus || {});
+var MediaListSort = /* @__PURE__ */ ((MediaListSort2) => {
+  MediaListSort2["MEDIA_ID"] = "MEDIA_ID";
+  MediaListSort2["MEDIA_ID_DESC"] = "MEDIA_ID_DESC";
+  MediaListSort2["SCORE"] = "SCORE";
+  MediaListSort2["SCORE_DESC"] = "SCORE_DESC";
+  MediaListSort2["STATUS"] = "STATUS";
+  MediaListSort2["STATUS_DESC"] = "STATUS_DESC";
+  MediaListSort2["PROGRESS"] = "PROGRESS";
+  MediaListSort2["PROGRESS_DESC"] = "PROGRESS_DESC";
+  MediaListSort2["PROGRESS_VOLUMES"] = "PROGRESS_VOLUMES";
+  MediaListSort2["PROGRESS_VOLUMES_DESC"] = "PROGRESS_VOLUMES_DESC";
+  MediaListSort2["REPEAT"] = "REPEAT";
+  MediaListSort2["REPEAT_DESC"] = "REPEAT_DESC";
+  MediaListSort2["PRIORITY"] = "PRIORITY";
+  MediaListSort2["PRIORITY_DESC"] = "PRIORITY_DESC";
+  MediaListSort2["STARTED_ON"] = "STARTED_ON";
+  MediaListSort2["STARTED_ON_DESC"] = "STARTED_ON_DESC";
+  MediaListSort2["FINISHED_ON"] = "FINISHED_ON";
+  MediaListSort2["FINISHED_ON_DESC"] = "FINISHED_ON_DESC";
+  MediaListSort2["ADDED_TIME"] = "ADDED_TIME";
+  MediaListSort2["ADDED_TIME_DESC"] = "ADDED_TIME_DESC";
+  MediaListSort2["UPDATED_TIME"] = "UPDATED_TIME";
+  MediaListSort2["UPDATED_TIME_DESC"] = "UPDATED_TIME_DESC";
+  MediaListSort2["MEDIA_TITLE_ROMAJI"] = "MEDIA_TITLE_ROMAJI";
+  MediaListSort2["MEDIA_TITLE_ROMAJI_DESC"] = "MEDIA_TITLE_ROMAJI_DESC";
+  MediaListSort2["MEDIA_TITLE_ENGLISH"] = "MEDIA_TITLE_ENGLISH";
+  MediaListSort2["MEDIA_TITLE_ENGLISH_DESC"] = "MEDIA_TITLE_ENGLISH_DESC";
+  MediaListSort2["MEDIA_TITLE_NATIVE"] = "MEDIA_TITLE_NATIVE";
+  MediaListSort2["MEDIA_TITLE_NATIVE_DESC"] = "MEDIA_TITLE_NATIVE_DESC";
+  MediaListSort2["MEDIA_POPULARITY"] = "MEDIA_POPULARITY";
+  MediaListSort2["MEDIA_POPULARITY_DESC"] = "MEDIA_POPULARITY_DESC";
+  return MediaListSort2;
+})(MediaListSort || {});
 
 exports.AiringSort = AiringSort;
 exports.AniListClient = AniListClient;
 exports.AniListError = AniListError;
 exports.CharacterSort = CharacterSort;
 exports.MediaFormat = MediaFormat;
+exports.MediaListSort = MediaListSort;
+exports.MediaListStatus = MediaListStatus;
+exports.MediaRelationType = MediaRelationType;
 exports.MediaSeason = MediaSeason;
 exports.MediaSort = MediaSort;
 exports.MediaStatus = MediaStatus;
 exports.MediaType = MediaType;
 exports.MemoryCache = MemoryCache;
 exports.RateLimiter = RateLimiter;
+exports.RecommendationSort = RecommendationSort;
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map