ani-client 2.0.3 → 2.1.0

package/dist/index.d.mts

@@ -603,7 +603,7 @@ declare enum MediaRelationType {
 }
 interface MediaEdge {
     relationType: MediaRelationType;
-    node: Pick<Media, "id" | "title" | "type" | "format" | "status" | "startDate" | "endDate" | "season" | "seasonYear" | "episodes" | "chapters" | "volumes" | "coverImage" | "genres" | "averageScore" | "studios" | "siteUrl" | "nextAiringEpisode">;
+    node: Pick<Media, "id" | "title" | "type" | "format" | "status" | "startDate" | "endDate" | "season" | "seasonYear" | "episodes" | "chapters" | "volumes" | "coverImage" | "genres" | "averageScore" | "meanScore" | "studios" | "siteUrl" | "nextAiringEpisode">;
 }
 interface MediaConnection {
     edges: MediaEdge[];
@@ -644,7 +644,7 @@ interface MediaStats {
 interface MediaRecommendationNode {
     id: number;
     rating: number | null;
-    mediaRecommendation: Pick<Media, "id" | "title" | "type" | "format" | "coverImage" | "averageScore" | "siteUrl">;
+    mediaRecommendation: Pick<Media, "id" | "title" | "type" | "format" | "coverImage" | "averageScore" | "meanScore" | "episodes" | "chapters" | "volumes" | "nextAiringEpisode" | "season" | "seasonYear" | "startDate" | "endDate" | "studios" | "genres" | "siteUrl">;
 }
 interface NextAiringEpisode {
     id: number;
@@ -727,6 +727,8 @@ interface SearchMediaOptions {
     tagsExclude?: string[];
     /** Include or Exclude explicit content (default: false) */
     isAdult?: boolean;
+    /** Exclude certain media entries by ID */
+    idNotIn?: number[];
     /** Sort order */
     sort?: MediaSort[];
     /** Page number */
@@ -739,6 +741,8 @@ interface GeneralMediaQueryOptions {
     type?: MediaType;
     /** Include or Exclude explicit content (default: false) */
     isAdult?: boolean;
+    /** Exclude certain media entries by ID */
+    idNotIn?: number[];
     /** Page number */
     page?: number;
     /** Results per page (max 50) */
@@ -749,8 +753,8 @@ interface GetAiringOptions {
     airingAtGreater?: number;
     /** Only show episodes that aired before this UNIX timestamp */
     airingAtLesser?: number;
-    /** Include or Exclude explicit content (default: false) */
-    isAdult?: boolean;
+    /** Exclude certain media entries by ID */
+    idNotIn?: number[];
     /** Sort order (default: TIME_DESC) */
     sort?: AiringSort[];
     /** Page number */
@@ -761,6 +765,8 @@ interface GetAiringOptions {
 interface GetRecentChaptersOptions {
     /** Include or Exclude explicit content (default: false) */
     isAdult?: boolean;
+    /** Exclude certain media entries by ID */
+    idNotIn?: number[];
     /** Page number (default: 1) */
     page?: number;
     /** Results per page (default: 20, max 50) */
@@ -771,6 +777,8 @@ interface GetPlanningOptions {
     type?: MediaType;
     /** Include or Exclude explicit content (default: false) */
     isAdult?: boolean;
+    /** Exclude certain media entries by ID */
+    idNotIn?: number[];
     /** Sort order (default: POPULARITY_DESC) */
     sort?: MediaSort[];
     /** Page number */
@@ -814,6 +822,8 @@ interface GetSeasonOptions {
     type?: MediaType;
     /** Allow or disallow explicit content (defaults to False) */
     isAdult?: boolean;
+    /** Exclude certain media entries by ID */
+    idNotIn?: number[];
     /** Sort order (default: POPULARITY_DESC) */
     sort?: MediaSort[];
     /** Page number */
@@ -942,6 +952,44 @@ interface SearchCharacterOptions {
     voiceActors?: boolean;
 }
 
+declare enum ReviewSort {
+    ID = "ID",
+    ID_DESC = "ID_DESC",
+    SCORE = "SCORE",
+    SCORE_DESC = "SCORE_DESC",
+    RATING = "RATING",
+    RATING_DESC = "RATING_DESC",
+    CREATED_AT = "CREATED_AT",
+    CREATED_AT_DESC = "CREATED_AT_DESC",
+    UPDATED_AT = "UPDATED_AT",
+    UPDATED_AT_DESC = "UPDATED_AT_DESC"
+}
+interface Review {
+    id: number;
+    userId: number;
+    mediaId: number;
+    mediaType: "ANIME" | "MANGA";
+    summary: string;
+    body: string;
+    rating: number;
+    ratingAmount: number;
+    userRating: "UP_VOTE" | "DOWN_VOTE" | "NO_VOTE";
+    score: number;
+    private: boolean;
+    siteUrl: string;
+    createdAt: number;
+    updatedAt: number;
+    user: User;
+    media: Media;
+}
+interface SearchReviewOptions {
+    mediaId?: number;
+    userId?: number;
+    sort?: ReviewSort[];
+    page?: number;
+    perPage?: number;
+}
+
 /** Represents a forum thread on AniList. */
 interface Thread {
     id: number;
@@ -1293,6 +1341,19 @@ declare class AniListClient {
      * ```
      */
     getUserFavorites(idOrName: number | string, options?: UserFavoritesOptions): Promise<UserFavorites>;
+    /**
+     * Fetch a review by its AniList ID.
+     *
+     * @param id - The AniList review ID
+     */
+    getReview(id: number): Promise<Review>;
+    /**
+     * Search for reviews with optional filters.
+     *
+     * @param options - Search and filter options
+     * @returns Paginated results with matching reviews
+     */
+    searchReviews(options?: SearchReviewOptions): Promise<PagedResult<Review>>;
     /**
      * Fetch a studio by its AniList ID.
      * Pass `include` to customise the number of media returned.
@@ -1412,4 +1473,4 @@ declare class RateLimiter {
 
 declare function parseAniListMarkdown(text: string): string;
 
-export { type AiringSchedule, AiringSort, AniListClient, type AniListClientOptions, AniListError, type AniListHooks, type CacheAdapter, type CacheOptions, type CacheStats, type Character, type CharacterImage, type CharacterIncludeOptions, type CharacterMediaEdge, type CharacterName, CharacterRole, CharacterSort, type DayOfWeek, type ExternalLink, type FavoriteCharacterNode, type FavoriteMediaNode, type FavoriteStaffNode, type FavoriteStudioNode, type FuzzyDate, type GetAiringOptions, type GetMediaCharactersOptions, type GetMediaStaffOptions, type GetPlanningOptions, type GetRecentChaptersOptions, type GetRecommendationsOptions, type GetSeasonOptions, type GetUserMediaListOptions, type Logger, type Media, type MediaCharacterConnection, type MediaCharacterEdge, type MediaConnection, type MediaCoverImage, type MediaEdge, MediaFormat, type MediaIncludeOptions, type MediaListEntry, MediaListSort, MediaListStatus, type MediaRecommendationNode, MediaRelationType, MediaSeason, MediaSort, MediaSource, type MediaStaffConnection, type MediaStaffEdge, type MediaStats, MediaStatus, type MediaTag, type MediaTitle, type MediaTrailer, MediaType, MemoryCache, type NextAiringEpisode, type PageInfo, type PagedResult, type RateLimitInfo, type RateLimitOptions, RateLimiter, type Recommendation, RecommendationSort, RedisCache, type RedisCacheOptions, type RedisLikeClient, type ResponseMeta, type ScoreDistribution, type SearchCharacterOptions, type SearchMediaOptions, type SearchStaffOptions, type SearchStudioOptions, type SearchThreadOptions, type SearchUserOptions, type Staff, type StaffImage, type StaffIncludeOptions, type StaffMediaNode, type StaffName, StaffSort, type StatusDistribution, type StreamingEpisode, type Studio, type StudioConnection, type StudioIncludeOptions, StudioSort, type Thread, type ThreadCategory, type ThreadMediaCategory, ThreadSort, type User, type UserAvatar, type UserFavorites, type UserFavoritesOptions, UserSort, type UserStatistics, type VoiceActor, type WeeklySchedule, parseAniListMarkdown };
+export { type AiringSchedule, AiringSort, AniListClient, type AniListClientOptions, AniListError, type AniListHooks, type CacheAdapter, type CacheOptions, type CacheStats, type Character, type CharacterImage, type CharacterIncludeOptions, type CharacterMediaEdge, type CharacterName, CharacterRole, CharacterSort, type DayOfWeek, type ExternalLink, type FavoriteCharacterNode, type FavoriteMediaNode, type FavoriteStaffNode, type FavoriteStudioNode, type FuzzyDate, type GetAiringOptions, type GetMediaCharactersOptions, type GetMediaStaffOptions, type GetPlanningOptions, type GetRecentChaptersOptions, type GetRecommendationsOptions, type GetSeasonOptions, type GetUserMediaListOptions, type Logger, type Media, type MediaCharacterConnection, type MediaCharacterEdge, type MediaConnection, type MediaCoverImage, type MediaEdge, MediaFormat, type MediaIncludeOptions, type MediaListEntry, MediaListSort, MediaListStatus, type MediaRecommendationNode, MediaRelationType, MediaSeason, MediaSort, MediaSource, type MediaStaffConnection, type MediaStaffEdge, type MediaStats, MediaStatus, type MediaTag, type MediaTitle, type MediaTrailer, MediaType, MemoryCache, type NextAiringEpisode, type PageInfo, type PagedResult, type RateLimitInfo, type RateLimitOptions, RateLimiter, type Recommendation, RecommendationSort, RedisCache, type RedisCacheOptions, type RedisLikeClient, type ResponseMeta, type Review, ReviewSort, type ScoreDistribution, type SearchCharacterOptions, type SearchMediaOptions, type SearchReviewOptions, type SearchStaffOptions, type SearchStudioOptions, type SearchThreadOptions, type SearchUserOptions, type Staff, type StaffImage, type StaffIncludeOptions, type StaffMediaNode, type StaffName, StaffSort, type StatusDistribution, type StreamingEpisode, type Studio, type StudioConnection, type StudioIncludeOptions, StudioSort, type Thread, type ThreadCategory, type ThreadMediaCategory, ThreadSort, type User, type UserAvatar, type UserFavorites, type UserFavoritesOptions, UserSort, type UserStatistics, type VoiceActor, type WeeklySchedule, parseAniListMarkdown };

package/dist/index.d.ts

@@ -603,7 +603,7 @@ declare enum MediaRelationType {
 }
 interface MediaEdge {
     relationType: MediaRelationType;
-    node: Pick<Media, "id" | "title" | "type" | "format" | "status" | "startDate" | "endDate" | "season" | "seasonYear" | "episodes" | "chapters" | "volumes" | "coverImage" | "genres" | "averageScore" | "studios" | "siteUrl" | "nextAiringEpisode">;
+    node: Pick<Media, "id" | "title" | "type" | "format" | "status" | "startDate" | "endDate" | "season" | "seasonYear" | "episodes" | "chapters" | "volumes" | "coverImage" | "genres" | "averageScore" | "meanScore" | "studios" | "siteUrl" | "nextAiringEpisode">;
 }
 interface MediaConnection {
     edges: MediaEdge[];
@@ -644,7 +644,7 @@ interface MediaStats {
 interface MediaRecommendationNode {
     id: number;
     rating: number | null;
-    mediaRecommendation: Pick<Media, "id" | "title" | "type" | "format" | "coverImage" | "averageScore" | "siteUrl">;
+    mediaRecommendation: Pick<Media, "id" | "title" | "type" | "format" | "coverImage" | "averageScore" | "meanScore" | "episodes" | "chapters" | "volumes" | "nextAiringEpisode" | "season" | "seasonYear" | "startDate" | "endDate" | "studios" | "genres" | "siteUrl">;
 }
 interface NextAiringEpisode {
     id: number;
@@ -727,6 +727,8 @@ interface SearchMediaOptions {
     tagsExclude?: string[];
     /** Include or Exclude explicit content (default: false) */
     isAdult?: boolean;
+    /** Exclude certain media entries by ID */
+    idNotIn?: number[];
     /** Sort order */
     sort?: MediaSort[];
     /** Page number */
@@ -739,6 +741,8 @@ interface GeneralMediaQueryOptions {
     type?: MediaType;
     /** Include or Exclude explicit content (default: false) */
     isAdult?: boolean;
+    /** Exclude certain media entries by ID */
+    idNotIn?: number[];
     /** Page number */
     page?: number;
     /** Results per page (max 50) */
@@ -749,8 +753,8 @@ interface GetAiringOptions {
     airingAtGreater?: number;
     /** Only show episodes that aired before this UNIX timestamp */
     airingAtLesser?: number;
-    /** Include or Exclude explicit content (default: false) */
-    isAdult?: boolean;
+    /** Exclude certain media entries by ID */
+    idNotIn?: number[];
     /** Sort order (default: TIME_DESC) */
     sort?: AiringSort[];
     /** Page number */
@@ -761,6 +765,8 @@ interface GetAiringOptions {
 interface GetRecentChaptersOptions {
     /** Include or Exclude explicit content (default: false) */
     isAdult?: boolean;
+    /** Exclude certain media entries by ID */
+    idNotIn?: number[];
     /** Page number (default: 1) */
     page?: number;
     /** Results per page (default: 20, max 50) */
@@ -771,6 +777,8 @@ interface GetPlanningOptions {
     type?: MediaType;
     /** Include or Exclude explicit content (default: false) */
     isAdult?: boolean;
+    /** Exclude certain media entries by ID */
+    idNotIn?: number[];
     /** Sort order (default: POPULARITY_DESC) */
     sort?: MediaSort[];
     /** Page number */
@@ -814,6 +822,8 @@ interface GetSeasonOptions {
     type?: MediaType;
     /** Allow or disallow explicit content (defaults to False) */
     isAdult?: boolean;
+    /** Exclude certain media entries by ID */
+    idNotIn?: number[];
     /** Sort order (default: POPULARITY_DESC) */
     sort?: MediaSort[];
     /** Page number */
@@ -942,6 +952,44 @@ interface SearchCharacterOptions {
     voiceActors?: boolean;
 }
 
+declare enum ReviewSort {
+    ID = "ID",
+    ID_DESC = "ID_DESC",
+    SCORE = "SCORE",
+    SCORE_DESC = "SCORE_DESC",
+    RATING = "RATING",
+    RATING_DESC = "RATING_DESC",
+    CREATED_AT = "CREATED_AT",
+    CREATED_AT_DESC = "CREATED_AT_DESC",
+    UPDATED_AT = "UPDATED_AT",
+    UPDATED_AT_DESC = "UPDATED_AT_DESC"
+}
+interface Review {
+    id: number;
+    userId: number;
+    mediaId: number;
+    mediaType: "ANIME" | "MANGA";
+    summary: string;
+    body: string;
+    rating: number;
+    ratingAmount: number;
+    userRating: "UP_VOTE" | "DOWN_VOTE" | "NO_VOTE";
+    score: number;
+    private: boolean;
+    siteUrl: string;
+    createdAt: number;
+    updatedAt: number;
+    user: User;
+    media: Media;
+}
+interface SearchReviewOptions {
+    mediaId?: number;
+    userId?: number;
+    sort?: ReviewSort[];
+    page?: number;
+    perPage?: number;
+}
+
 /** Represents a forum thread on AniList. */
 interface Thread {
     id: number;
@@ -1293,6 +1341,19 @@ declare class AniListClient {
      * ```
      */
     getUserFavorites(idOrName: number | string, options?: UserFavoritesOptions): Promise<UserFavorites>;
+    /**
+     * Fetch a review by its AniList ID.
+     *
+     * @param id - The AniList review ID
+     */
+    getReview(id: number): Promise<Review>;
+    /**
+     * Search for reviews with optional filters.
+     *
+     * @param options - Search and filter options
+     * @returns Paginated results with matching reviews
+     */
+    searchReviews(options?: SearchReviewOptions): Promise<PagedResult<Review>>;
     /**
      * Fetch a studio by its AniList ID.
      * Pass `include` to customise the number of media returned.
@@ -1412,4 +1473,4 @@ declare class RateLimiter {
 
 declare function parseAniListMarkdown(text: string): string;
 
-export { type AiringSchedule, AiringSort, AniListClient, type AniListClientOptions, AniListError, type AniListHooks, type CacheAdapter, type CacheOptions, type CacheStats, type Character, type CharacterImage, type CharacterIncludeOptions, type CharacterMediaEdge, type CharacterName, CharacterRole, CharacterSort, type DayOfWeek, type ExternalLink, type FavoriteCharacterNode, type FavoriteMediaNode, type FavoriteStaffNode, type FavoriteStudioNode, type FuzzyDate, type GetAiringOptions, type GetMediaCharactersOptions, type GetMediaStaffOptions, type GetPlanningOptions, type GetRecentChaptersOptions, type GetRecommendationsOptions, type GetSeasonOptions, type GetUserMediaListOptions, type Logger, type Media, type MediaCharacterConnection, type MediaCharacterEdge, type MediaConnection, type MediaCoverImage, type MediaEdge, MediaFormat, type MediaIncludeOptions, type MediaListEntry, MediaListSort, MediaListStatus, type MediaRecommendationNode, MediaRelationType, MediaSeason, MediaSort, MediaSource, type MediaStaffConnection, type MediaStaffEdge, type MediaStats, MediaStatus, type MediaTag, type MediaTitle, type MediaTrailer, MediaType, MemoryCache, type NextAiringEpisode, type PageInfo, type PagedResult, type RateLimitInfo, type RateLimitOptions, RateLimiter, type Recommendation, RecommendationSort, RedisCache, type RedisCacheOptions, type RedisLikeClient, type ResponseMeta, type ScoreDistribution, type SearchCharacterOptions, type SearchMediaOptions, type SearchStaffOptions, type SearchStudioOptions, type SearchThreadOptions, type SearchUserOptions, type Staff, type StaffImage, type StaffIncludeOptions, type StaffMediaNode, type StaffName, StaffSort, type StatusDistribution, type StreamingEpisode, type Studio, type StudioConnection, type StudioIncludeOptions, StudioSort, type Thread, type ThreadCategory, type ThreadMediaCategory, ThreadSort, type User, type UserAvatar, type UserFavorites, type UserFavoritesOptions, UserSort, type UserStatistics, type VoiceActor, type WeeklySchedule, parseAniListMarkdown };
+export { type AiringSchedule, AiringSort, AniListClient, type AniListClientOptions, AniListError, type AniListHooks, type CacheAdapter, type CacheOptions, type CacheStats, type Character, type CharacterImage, type CharacterIncludeOptions, type CharacterMediaEdge, type CharacterName, CharacterRole, CharacterSort, type DayOfWeek, type ExternalLink, type FavoriteCharacterNode, type FavoriteMediaNode, type FavoriteStaffNode, type FavoriteStudioNode, type FuzzyDate, type GetAiringOptions, type GetMediaCharactersOptions, type GetMediaStaffOptions, type GetPlanningOptions, type GetRecentChaptersOptions, type GetRecommendationsOptions, type GetSeasonOptions, type GetUserMediaListOptions, type Logger, type Media, type MediaCharacterConnection, type MediaCharacterEdge, type MediaConnection, type MediaCoverImage, type MediaEdge, MediaFormat, type MediaIncludeOptions, type MediaListEntry, MediaListSort, MediaListStatus, type MediaRecommendationNode, MediaRelationType, MediaSeason, MediaSort, MediaSource, type MediaStaffConnection, type MediaStaffEdge, type MediaStats, MediaStatus, type MediaTag, type MediaTitle, type MediaTrailer, MediaType, MemoryCache, type NextAiringEpisode, type PageInfo, type PagedResult, type RateLimitInfo, type RateLimitOptions, RateLimiter, type Recommendation, RecommendationSort, RedisCache, type RedisCacheOptions, type RedisLikeClient, type ResponseMeta, type Review, ReviewSort, type ScoreDistribution, type SearchCharacterOptions, type SearchMediaOptions, type SearchReviewOptions, type SearchStaffOptions, type SearchStudioOptions, type SearchThreadOptions, type SearchUserOptions, type Staff, type StaffImage, type StaffIncludeOptions, type StaffMediaNode, type StaffName, StaffSort, type StatusDistribution, type StreamingEpisode, type Studio, type StudioConnection, type StudioIncludeOptions, StudioSort, type Thread, type ThreadCategory, type ThreadMediaCategory, ThreadSort, type User, type UserAvatar, type UserFavorites, type UserFavoritesOptions, UserSort, type UserStatistics, type VoiceActor, type WeeklySchedule, parseAniListMarkdown };