ani-client 2.1.4 → 2.2.0

package/dist/index.d.mts

@@ -934,6 +934,7 @@ declare class NormalizedCache implements CacheAdapter {
     private _hits;
     private _misses;
     private _stales;
+    private gcTimeout?;
     constructor(options?: CacheOptions);
     static key(query: string, variables: Record<string, unknown>): string;
     /** Normalizes a GraphQL response, extracting entities and returning a tree of references. */
@@ -955,6 +956,7 @@ declare class NormalizedCache implements CacheAdapter {
         entitiesCount: number;
     };
     resetStats(): void;
+    private scheduleGc;
     /**
      * Garbage-collect orphaned entities that are no longer referenced by any query.
      * Called automatically on LRU eviction to prevent unbounded entity store growth.
@@ -1106,13 +1108,13 @@ declare class AniListClient implements ClientBase {
      * @param options - Search / filter parameters
      * @returns Paginated results with matching media
      */
-    searchMedia(options?: SearchMediaOptions): Promise<PagedResult<Media>>;
+    searchMedia(options?: SearchMediaOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /** Get currently trending anime or manga. */
-    getTrending(options?: GeneralMediaQueryOptions): Promise<PagedResult<Media>>;
+    getTrending(options?: GeneralMediaQueryOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /** Get the most popular anime or manga. */
-    getPopular(options?: GeneralMediaQueryOptions): Promise<PagedResult<Media>>;
+    getPopular(options?: GeneralMediaQueryOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /** Get the highest-rated anime or manga. */
-    getTopRated(options?: GeneralMediaQueryOptions): Promise<PagedResult<Media>>;
+    getTopRated(options?: GeneralMediaQueryOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /** Get recently aired anime episodes. */
     getAiredEpisodes(options?: GetAiringOptions): Promise<PagedResult<AiringSchedule>>;
     /**
@@ -1120,11 +1122,7 @@ declare class AniListClient implements ClientBase {
      *
      * @param options - Pagination parameters
      */
-    getRecentlyUpdatedManga(options?: GetRecentChaptersOptions): Promise<PagedResult<Media>>;
-    /**
-     * @deprecated Use `getRecentlyUpdatedManga()` instead. This alias will be removed in v3.
-     */
-    getAiredChapters(options?: GetRecentChaptersOptions): Promise<PagedResult<Media>>;
+    getRecentlyUpdatedManga(options?: GetRecentChaptersOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /**
      * Fetch a media entry by its MyAnimeList (MAL) ID.
      *
@@ -1135,11 +1133,11 @@ declare class AniListClient implements ClientBase {
     /** Get the detailed schedule for the current week, sorted by day. */
     getWeeklySchedule(date?: Date, idNotIn?: number[]): Promise<WeeklySchedule>;
     /** Get upcoming (not yet released) media. */
-    getPlanning(options?: GetPlanningOptions): Promise<PagedResult<Media>>;
+    getPlanning(options?: GetPlanningOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /** Get recommendations for a specific media. */
     getRecommendations(mediaId: number, options?: Omit<GetRecommendationsOptions, "mediaId">): Promise<PagedResult<Recommendation>>;
     /** Get anime (or manga) for a specific season and year. */
-    getMediaBySeason(options: GetSeasonOptions): Promise<PagedResult<Media>>;
+    getMediaBySeason(options: GetSeasonOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /** Fetch a character by AniList ID. Pass `{ voiceActors: true }` to include VA data. */
     getCharacter(id: number, include?: CharacterIncludeOptions): Promise<Character>;
     /** Search for characters by name. */
@@ -1249,6 +1247,23 @@ declare class AniListClient implements ClientBase {
     withSignal(signal: AbortSignal): AniListClient;
 }
 
+/**
+ * Represents a location in a GraphQL query where an error occurred.
+ */
+interface GraphQLErrorLocation {
+    line: number;
+    column: number;
+}
+/**
+ * Standard GraphQL error shape.
+ */
+interface GraphQLError {
+    message: string;
+    locations?: GraphQLErrorLocation[];
+    path?: (string | number)[];
+    extensions?: Record<string, unknown>;
+    [key: string]: unknown;
+}
 /**
  * Custom error class for AniList API errors.
  */
@@ -1256,8 +1271,8 @@ declare class AniListError extends Error {
     /** HTTP status code returned by the API */
     readonly status: number;
     /** Raw error body from the API response */
-    readonly errors: unknown[];
-    constructor(message: string, status: number, errors?: unknown[]);
+    readonly errors: GraphQLError[];
+    constructor(message: string, status: number, errors?: GraphQLError[] | unknown[]);
 }
 
 /**

package/dist/index.d.ts

@@ -934,6 +934,7 @@ declare class NormalizedCache implements CacheAdapter {
     private _hits;
     private _misses;
     private _stales;
+    private gcTimeout?;
     constructor(options?: CacheOptions);
     static key(query: string, variables: Record<string, unknown>): string;
     /** Normalizes a GraphQL response, extracting entities and returning a tree of references. */
@@ -955,6 +956,7 @@ declare class NormalizedCache implements CacheAdapter {
         entitiesCount: number;
     };
     resetStats(): void;
+    private scheduleGc;
     /**
      * Garbage-collect orphaned entities that are no longer referenced by any query.
      * Called automatically on LRU eviction to prevent unbounded entity store growth.
@@ -1106,13 +1108,13 @@ declare class AniListClient implements ClientBase {
      * @param options - Search / filter parameters
      * @returns Paginated results with matching media
      */
-    searchMedia(options?: SearchMediaOptions): Promise<PagedResult<Media>>;
+    searchMedia(options?: SearchMediaOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /** Get currently trending anime or manga. */
-    getTrending(options?: GeneralMediaQueryOptions): Promise<PagedResult<Media>>;
+    getTrending(options?: GeneralMediaQueryOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /** Get the most popular anime or manga. */
-    getPopular(options?: GeneralMediaQueryOptions): Promise<PagedResult<Media>>;
+    getPopular(options?: GeneralMediaQueryOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /** Get the highest-rated anime or manga. */
-    getTopRated(options?: GeneralMediaQueryOptions): Promise<PagedResult<Media>>;
+    getTopRated(options?: GeneralMediaQueryOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /** Get recently aired anime episodes. */
     getAiredEpisodes(options?: GetAiringOptions): Promise<PagedResult<AiringSchedule>>;
     /**
@@ -1120,11 +1122,7 @@ declare class AniListClient implements ClientBase {
      *
      * @param options - Pagination parameters
      */
-    getRecentlyUpdatedManga(options?: GetRecentChaptersOptions): Promise<PagedResult<Media>>;
-    /**
-     * @deprecated Use `getRecentlyUpdatedManga()` instead. This alias will be removed in v3.
-     */
-    getAiredChapters(options?: GetRecentChaptersOptions): Promise<PagedResult<Media>>;
+    getRecentlyUpdatedManga(options?: GetRecentChaptersOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /**
      * Fetch a media entry by its MyAnimeList (MAL) ID.
      *
@@ -1135,11 +1133,11 @@ declare class AniListClient implements ClientBase {
     /** Get the detailed schedule for the current week, sorted by day. */
     getWeeklySchedule(date?: Date, idNotIn?: number[]): Promise<WeeklySchedule>;
     /** Get upcoming (not yet released) media. */
-    getPlanning(options?: GetPlanningOptions): Promise<PagedResult<Media>>;
+    getPlanning(options?: GetPlanningOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /** Get recommendations for a specific media. */
     getRecommendations(mediaId: number, options?: Omit<GetRecommendationsOptions, "mediaId">): Promise<PagedResult<Recommendation>>;
     /** Get anime (or manga) for a specific season and year. */
-    getMediaBySeason(options: GetSeasonOptions): Promise<PagedResult<Media>>;
+    getMediaBySeason(options: GetSeasonOptions, include?: MediaIncludeOptions): Promise<PagedResult<Media>>;
     /** Fetch a character by AniList ID. Pass `{ voiceActors: true }` to include VA data. */
     getCharacter(id: number, include?: CharacterIncludeOptions): Promise<Character>;
     /** Search for characters by name. */
@@ -1249,6 +1247,23 @@ declare class AniListClient implements ClientBase {
     withSignal(signal: AbortSignal): AniListClient;
 }
 
+/**
+ * Represents a location in a GraphQL query where an error occurred.
+ */
+interface GraphQLErrorLocation {
+    line: number;
+    column: number;
+}
+/**
+ * Standard GraphQL error shape.
+ */
+interface GraphQLError {
+    message: string;
+    locations?: GraphQLErrorLocation[];
+    path?: (string | number)[];
+    extensions?: Record<string, unknown>;
+    [key: string]: unknown;
+}
 /**
  * Custom error class for AniList API errors.
  */
@@ -1256,8 +1271,8 @@ declare class AniListError extends Error {
     /** HTTP status code returned by the API */
     readonly status: number;
     /** Raw error body from the API response */
-    readonly errors: unknown[];
-    constructor(message: string, status: number, errors?: unknown[]);
+    readonly errors: GraphQLError[];
+    constructor(message: string, status: number, errors?: GraphQLError[] | unknown[]);
 }
 
 /**

package/dist/index.js

@@ -135,6 +135,7 @@ var NormalizedCache = class {
   _hits = 0;
   _misses = 0;
   _stales = 0;
+  gcTimeout;
   constructor(options = {}) {
     this.ttl = options.ttl ?? 24 * 60 * 60 * 1e3;
     this.maxSize = options.maxSize ?? 500;
@@ -246,8 +247,10 @@ var NormalizedCache = class {
     this.queryStore.delete(key);
     if (this.maxSize > 0 && this.queryStore.size >= this.maxSize) {
       const firstKey = this.queryStore.keys().next().value;
-      if (firstKey !== void 0) this.queryStore.delete(firstKey);
-      this.gc();
+      if (firstKey !== void 0) {
+        this.queryStore.delete(firstKey);
+      }
+      this.scheduleGc();
     }
     this.queryStore.set(key, { data: normalizedData, expiresAt: Date.now() + this.ttl });
   }
@@ -255,6 +258,10 @@ var NormalizedCache = class {
     return this.queryStore.delete(key);
   }
   clear() {
+    if (this.gcTimeout) {
+      clearTimeout(this.gcTimeout);
+      this.gcTimeout = void 0;
+    }
     this.queryStore.clear();
     this.entityStore.clear();
     this._hits = 0;
@@ -291,6 +298,16 @@ var NormalizedCache = class {
     this._misses = 0;
     this._stales = 0;
   }
+  scheduleGc() {
+    if (this.gcTimeout) return;
+    this.gcTimeout = setTimeout(() => {
+      this.gc();
+      this.gcTimeout = void 0;
+    }, 500);
+    if (typeof this.gcTimeout.unref === "function") {
+      this.gcTimeout.unref();
+    }
+  }
   /**
    * Garbage-collect orphaned entities that are no longer referenced by any query.
    * Called automatically on LRU eviction to prevent unbounded entity store growth.
@@ -1183,8 +1200,7 @@ query ($mediaId: Int!, $page: Int, $perPage: Int, $sort: [RecommendationSort]) {
 }`;
 
 // src/queries/builders.ts
-function buildMediaByIdQuery(include) {
-  if (!include) return QUERY_MEDIA_BY_ID;
+function buildMediaIncludeQuery(include) {
   const extra = [];
   if (include.relations !== false) {
     extra.push(RELATIONS_FIELDS);
@@ -1259,14 +1275,172 @@ function buildMediaByIdQuery(include) {
       statusDistribution { status amount }
     }`);
   }
+  return extra;
+}
+function buildMediaByIdQuery(include) {
+  if (!include) return QUERY_MEDIA_BY_ID;
   return `
 query ($id: Int!) {
   Media(id: $id) {
     ${MEDIA_FIELDS_BASE}
-    ${extra.join("\n")}
+    ${buildMediaIncludeQuery(include).join("\n")}
   }
 }`;
 }
+function buildSearchMediaQuery(include) {
+  if (!include) return QUERY_MEDIA_SEARCH;
+  return `
+  query (
+    $search: String,
+    $countryOfOrigin: CountryCode,
+    $type: MediaType,
+    $format: MediaFormat,
+    $format_in: [MediaFormat],
+    $status: MediaStatus,
+    $season: MediaSeason,
+    $seasonYear: Int,
+    $genre: String,
+    $tag: String,
+    $genre_in: [String],
+    $tag_in: [String],
+    $genre_not_in: [String],
+    $tag_not_in: [String],
+    $isAdult: Boolean,
+    $idNotIn: [Int],
+    $sort: [MediaSort],
+    $page: Int,
+    $perPage: Int
+  ) {
+    Page(page: $page, perPage: $perPage) {
+      pageInfo { total perPage currentPage lastPage hasNextPage }
+      media(
+        search: $search,
+        countryOfOrigin: $countryOfOrigin,
+        type: $type,
+        format: $format,
+        format_in: $format_in,
+        status: $status,
+        season: $season,
+        seasonYear: $seasonYear,
+        genre: $genre,
+        tag: $tag,
+        genre_in: $genre_in,
+        tag_in: $tag_in,
+        genre_not_in: $genre_not_in,
+        tag_not_in: $tag_not_in,
+        isAdult: $isAdult,
+        id_not_in: $idNotIn,
+        sort: $sort
+      ) {
+        ${MEDIA_FIELDS_BASE}
+        ${buildMediaIncludeQuery(include).join("\n")}
+      }
+    }
+  }`;
+}
+function buildGetTrendingQuery(include) {
+  if (!include) return QUERY_TRENDING;
+  return `
+  query (
+    $type: MediaType,
+    $isAdult: Boolean,
+    $idNotIn: [Int],
+    $page: Int,
+    $perPage: Int
+  ) {
+    Page(page: $page, perPage: $perPage) {
+      pageInfo { total perPage currentPage lastPage hasNextPage }
+      media(
+        type: $type,
+        isAdult: $isAdult,
+        id_not_in: $idNotIn,
+        sort: TRENDING_DESC
+      ) {
+        ${MEDIA_FIELDS_BASE}
+        ${buildMediaIncludeQuery(include).join("\n")}
+      }
+    }
+  }`;
+}
+function buildGetMediaBySeasonQuery(include) {
+  if (!include) return QUERY_MEDIA_BY_SEASON;
+  return `
+  query (
+    $season: MediaSeason!,
+    $seasonYear: Int!,
+    $type: MediaType,
+    $isAdult: Boolean,
+    $idNotIn: [Int],
+    $sort: [MediaSort],
+    $page: Int,
+    $perPage: Int
+  ) {
+    Page(page: $page, perPage: $perPage) {
+      pageInfo { total perPage currentPage lastPage hasNextPage }
+      media(
+        season: $season,
+        seasonYear: $seasonYear,
+        type: $type,
+        isAdult: $isAdult,
+        id_not_in: $idNotIn,
+        sort: $sort
+      ) {
+        ${MEDIA_FIELDS_BASE}
+        ${buildMediaIncludeQuery(include).join("\n")}
+      }
+    }
+  }`;
+}
+function buildGetRecentlyUpdatedMangaQuery(include) {
+  if (!include) return QUERY_RECENT_CHAPTERS;
+  return `
+  query (
+    $isAdult: Boolean,
+    $idNotIn: [Int],
+    $page: Int,
+    $perPage: Int
+  ) {
+    Page(page: $page, perPage: $perPage) {
+      pageInfo { total perPage currentPage lastPage hasNextPage }
+      media(
+        type: MANGA,
+        isAdult: $isAdult,
+        id_not_in: $idNotIn,
+        status: RELEASING,
+        sort: UPDATED_AT_DESC
+      ) {
+        ${MEDIA_FIELDS_BASE}
+        ${buildMediaIncludeQuery(include).join("\n")}
+      }
+    }
+  }`;
+}
+function buildGetPlanningQuery(include) {
+  if (!include) return QUERY_PLANNING;
+  return `
+  query (
+    $type: MediaType,
+    $isAdult: Boolean,
+    $idNotIn: [Int],
+    $sort: [MediaSort],
+    $page: Int,
+    $perPage: Int
+  ) {
+    Page(page: $page, perPage: $perPage) {
+      pageInfo { total perPage currentPage lastPage hasNextPage }
+      media(
+        type: $type,
+        isAdult: $isAdult,
+        id_not_in: $idNotIn,
+        status: NOT_YET_RELEASED,
+        sort: $sort
+      ) {
+        ${MEDIA_FIELDS_BASE}
+        ${buildMediaIncludeQuery(include).join("\n")}
+      }
+    }
+  }`;
+}
 function buildMediaCharactersQuery(options = {}) {
   const sortClause = options.sort === false ? "" : ", sort: [ROLE, RELEVANCE, ID]";
   const voiceActorBlock = options.voiceActors ? `
@@ -2068,7 +2242,7 @@ async function getMediaByMalId(client, malId, type) {
   });
   return data.Media;
 }
-async function searchMedia(client, options = {}) {
+async function searchMedia(client, options = {}, include) {
   const {
     query: search,
     page = 1,
@@ -2080,8 +2254,9 @@ async function searchMedia(client, options = {}) {
     format,
     ...filters
   } = options;
+  const query = buildSearchMediaQuery(include);
   return client.pagedRequest(
-    QUERY_MEDIA_SEARCH,
+    query,
     {
       search,
       ...filters,
@@ -2097,21 +2272,18 @@ async function searchMedia(client, options = {}) {
     "media"
   );
 }
-async function getTrending(client, options) {
+async function getTrending(client, options, include) {
   const { type = "ANIME" /* ANIME */, isAdult = false, idNotIn = [], page = 1, perPage = 20 } = options;
-  return client.pagedRequest(
-    QUERY_TRENDING,
-    { type, isAdult, idNotIn, page, perPage: clampPerPage(perPage) },
-    "media"
-  );
+  const query = buildGetTrendingQuery(include);
+  return client.pagedRequest(query, { type, isAdult, idNotIn, page, perPage: clampPerPage(perPage) }, "media");
 }
-async function getPopular(client, options) {
+async function getPopular(client, options, include) {
   const { type = "ANIME" /* ANIME */, isAdult = false, idNotIn = [], page = 1, perPage = 20 } = options;
-  return searchMedia(client, { type, isAdult, idNotIn, sort: ["POPULARITY_DESC" /* POPULARITY_DESC */], page, perPage });
+  return searchMedia(client, { type, isAdult, idNotIn, sort: ["POPULARITY_DESC" /* POPULARITY_DESC */], page, perPage }, include);
 }
-async function getTopRated(client, options) {
+async function getTopRated(client, options, include) {
   const { type = "ANIME" /* ANIME */, isAdult = false, idNotIn = [], page = 1, perPage = 20 } = options;
-  return searchMedia(client, { type, isAdult, idNotIn, sort: ["SCORE_DESC" /* SCORE_DESC */], page, perPage });
+  return searchMedia(client, { type, isAdult, idNotIn, sort: ["SCORE_DESC" /* SCORE_DESC */], page, perPage }, include);
 }
 async function getAiredEpisodes(client, options = {}) {
   const now = Math.floor(Date.now() / 1e3);
@@ -2128,9 +2300,10 @@ async function getAiredEpisodes(client, options = {}) {
     "airingSchedules"
   );
 }
-async function getRecentlyUpdatedManga(client, options = {}) {
+async function getRecentlyUpdatedManga(client, options = {}, include) {
+  const query = buildGetRecentlyUpdatedMangaQuery(include);
   return client.pagedRequest(
-    QUERY_RECENT_CHAPTERS,
+    query,
     {
       isAdult: options.isAdult ?? false,
       idNotIn: options.idNotIn ?? [],
@@ -2140,9 +2313,10 @@ async function getRecentlyUpdatedManga(client, options = {}) {
     "media"
   );
 }
-async function getPlanning(client, options = {}) {
+async function getPlanning(client, options = {}, include) {
+  const query = buildGetPlanningQuery(include);
   return client.pagedRequest(
-    QUERY_PLANNING,
+    query,
     {
       type: options.type,
       isAdult: options.isAdult ?? false,
@@ -2167,9 +2341,10 @@ async function getRecommendations(client, mediaId, options = {}) {
     results: data.Media.recommendations.nodes
   };
 }
-async function getMediaBySeason(client, options) {
+async function getMediaBySeason(client, options, include) {
+  const query = buildGetMediaBySeasonQuery(include);
   return client.pagedRequest(
-    QUERY_MEDIA_BY_SEASON,
+    query,
     {
       season: options.season,
       seasonYear: options.seasonYear,
@@ -2366,7 +2541,7 @@ function mapFavorites(fav) {
 
 // src/client/index.ts
 var DEFAULT_API_URL = "https://graphql.anilist.co";
-var LIB_VERSION = "2.1.4" ;
+var LIB_VERSION = "2.2.0" ;
 var AniListClient = class {
   apiUrl;
   headers;
@@ -2536,20 +2711,20 @@ var AniListClient = class {
    * @param options - Search / filter parameters
    * @returns Paginated results with matching media
    */
-  async searchMedia(options = {}) {
-    return searchMedia(this, options);
+  async searchMedia(options = {}, include) {
+    return searchMedia(this, options, include);
   }
   /** Get currently trending anime or manga. */
-  async getTrending(options = {}) {
-    return getTrending(this, options);
+  async getTrending(options = {}, include) {
+    return getTrending(this, options, include);
   }
   /** Get the most popular anime or manga. */
-  async getPopular(options = {}) {
-    return getPopular(this, options);
+  async getPopular(options = {}, include) {
+    return getPopular(this, options, include);
   }
   /** Get the highest-rated anime or manga. */
-  async getTopRated(options = {}) {
-    return getTopRated(this, options);
+  async getTopRated(options = {}, include) {
+    return getTopRated(this, options, include);
   }
   /** Get recently aired anime episodes. */
   async getAiredEpisodes(options = {}) {
@@ -2560,14 +2735,8 @@ var AniListClient = class {
    *
    * @param options - Pagination parameters
    */
-  async getRecentlyUpdatedManga(options = {}) {
-    return getRecentlyUpdatedManga(this, options);
-  }
-  /**
-   * @deprecated Use `getRecentlyUpdatedManga()` instead. This alias will be removed in v3.
-   */
-  async getAiredChapters(options = {}) {
-    return this.getRecentlyUpdatedManga(options);
+  async getRecentlyUpdatedManga(options = {}, include) {
+    return getRecentlyUpdatedManga(this, options, include);
   }
   /**
    * Fetch a media entry by its MyAnimeList (MAL) ID.
@@ -2583,16 +2752,16 @@ var AniListClient = class {
     return getWeeklySchedule(this, date, idNotIn);
   }
   /** Get upcoming (not yet released) media. */
-  async getPlanning(options = {}) {
-    return getPlanning(this, options);
+  async getPlanning(options = {}, include) {
+    return getPlanning(this, options, include);
   }
   /** Get recommendations for a specific media. */
   async getRecommendations(mediaId, options = {}) {
     return getRecommendations(this, mediaId, options);
   }
   /** Get anime (or manga) for a specific season and year. */
-  async getMediaBySeason(options) {
-    return getMediaBySeason(this, options);
+  async getMediaBySeason(options, include) {
+    return getMediaBySeason(this, options, include);
   }
   /** Fetch a character by AniList ID. Pass `{ voiceActors: true }` to include VA data. */
   async getCharacter(id, include) {