ani-client 1.4.1 → 1.4.2

package/README.md

@@ -265,12 +265,21 @@ const result = await client.searchCharacters({ query: "Luffy", voiceActors: true
 
 | Method | Description |
 | --- | --- |
-| `getStaff(id)` | Fetch a staff member by ID |
+| `getStaff(id, include?)` | Fetch a staff member by ID (optionally with media) |
 | `searchStaff(options?)` | Search for staff members |
 
 ```ts
 const staff = await client.getStaff(95001);
 const results = await client.searchStaff({ query: "Miyazaki" });
+
+// With media the staff member worked on
+const staffWithMedia = await client.getStaff(95001, { media: true });
+staffWithMedia.staffMedia?.nodes.forEach((m) => {
+  console.log(m.title.romaji, m.format, m.averageScore);
+});
+
+// Customize the number of media returned
+const staffWith5Media = await client.getStaff(95001, { media: { perPage: 5 } });
 ```
 
 ### Users
@@ -566,6 +575,7 @@ import type {
   MediaEdge, MediaConnection, MediaCharacterEdge, MediaCharacterConnection,
   CharacterMediaEdge, CharacterIncludeOptions,
   MediaStaffEdge, MediaStaffConnection, MediaIncludeOptions,
+  StaffMediaNode, StaffIncludeOptions,
   StreamingEpisode, ExternalLink, MediaStats, MediaRecommendationNode,
   PageInfo, PagedResult,
   CacheAdapter, AniListHooks, AniListClientOptions,

package/dist/index.d.mts

@@ -303,6 +303,43 @@ interface StaffImage {
     large: string | null;
     medium: string | null;
 }
+/** A media node returned inside `Staff.staffMedia`. */
+interface StaffMediaNode {
+    id: number;
+    title: MediaTitle;
+    type: MediaType;
+    format: MediaFormat | null;
+    status: MediaStatus | null;
+    coverImage: MediaCoverImage;
+    bannerImage: string | null;
+    genres: string[];
+    averageScore: number | null;
+    meanScore: number | null;
+    popularity: number | null;
+    favourites: number | null;
+    episodes: number | null;
+    trending: number | null;
+    hashtag: string | null;
+    season: MediaSeason | null;
+    seasonYear: number | null;
+    startDate: FuzzyDate | null;
+    endDate: FuzzyDate | null;
+    nextAiringEpisode: {
+        id: number;
+        airingAt: number;
+        episode: number;
+        mediaId: number;
+        timeUntilAiring: number;
+    } | null;
+    studios: {
+        edges: {
+            node: {
+                name: string;
+            };
+        }[];
+    } | null;
+    siteUrl: string | null;
+}
 interface Staff {
     id: number;
     name: StaffName;
@@ -319,6 +356,19 @@ interface Staff {
     bloodType: string | null;
     favourites: number | null;
     siteUrl: string | null;
+    /** Media the staff member has worked on — only present when requested via include options. */
+    staffMedia?: {
+        nodes: StaffMediaNode[];
+    } | null;
+}
+/** Options to include additional related data when fetching a staff member by ID. */
+interface StaffIncludeOptions {
+    /** Include media the staff member has worked on.
+     *  `true` = 25 results sorted by popularity. Object form to customize. */
+    media?: boolean | {
+        perPage?: number;
+        sort?: boolean;
+    };
 }
 interface UserAvatar {
     large: string | null;
@@ -791,15 +841,20 @@ declare class AniListClient {
      * Fetch a staff member by AniList ID.
      *
      * @param id - The AniList staff ID
+     * @param include - Optional include options to fetch related data (e.g. media)
      * @returns The staff object
      *
      * @example
      * ```ts
      * const staff = await client.getStaff(95001);
      * console.log(staff.name.full);
+     *
+     * // With media the staff worked on
+     * const staff = await client.getStaff(95001, { media: true });
+     * staff.staffMedia?.nodes.forEach((m) => console.log(m.title.romaji));
      * ```
      */
-    getStaff(id: number): Promise<Staff>;
+    getStaff(id: number, include?: StaffIncludeOptions): Promise<Staff>;
     /**
      * Search for staff (voice actors, directors, etc.).
      *
@@ -1207,4 +1262,4 @@ declare class RateLimiter {
     private sleep;
 }
 
-export { type AiringSchedule, AiringSort, AniListClient, type AniListClientOptions, AniListError, type AniListHooks, type CacheAdapter, type CacheOptions, type Character, type CharacterImage, type CharacterIncludeOptions, type CharacterMediaEdge, type CharacterName, CharacterRole, CharacterSort, type ExternalLink, type FuzzyDate, type GetAiringOptions, type GetPlanningOptions, type GetRecentChaptersOptions, type GetRecommendationsOptions, type GetSeasonOptions, type GetUserMediaListOptions, type Media, type MediaCharacterConnection, type MediaCharacterEdge, type MediaConnection, type MediaCoverImage, type MediaEdge, MediaFormat, type MediaIncludeOptions, type MediaListEntry, MediaListSort, MediaListStatus, type MediaRecommendationNode, MediaRelationType, MediaSeason, MediaSort, type MediaStaffConnection, type MediaStaffEdge, type MediaStats, MediaStatus, type MediaTag, type MediaTitle, type MediaTrailer, MediaType, MemoryCache, type PageInfo, type PagedResult, type RateLimitOptions, RateLimiter, type Recommendation, RecommendationSort, RedisCache, type RedisCacheOptions, type RedisLikeClient, type ScoreDistribution, type SearchCharacterOptions, type SearchMediaOptions, type SearchStaffOptions, type SearchStudioOptions, type Staff, type StaffImage, type StaffName, type StatusDistribution, type StreamingEpisode, type Studio, type StudioConnection, type StudioDetail, type User, type UserAvatar, type UserStatistics, type VoiceActor };
+export { type AiringSchedule, AiringSort, AniListClient, type AniListClientOptions, AniListError, type AniListHooks, type CacheAdapter, type CacheOptions, type Character, type CharacterImage, type CharacterIncludeOptions, type CharacterMediaEdge, type CharacterName, CharacterRole, CharacterSort, type ExternalLink, type FuzzyDate, type GetAiringOptions, type GetPlanningOptions, type GetRecentChaptersOptions, type GetRecommendationsOptions, type GetSeasonOptions, type GetUserMediaListOptions, type Media, type MediaCharacterConnection, type MediaCharacterEdge, type MediaConnection, type MediaCoverImage, type MediaEdge, MediaFormat, type MediaIncludeOptions, type MediaListEntry, MediaListSort, MediaListStatus, type MediaRecommendationNode, MediaRelationType, MediaSeason, MediaSort, type MediaStaffConnection, type MediaStaffEdge, type MediaStats, MediaStatus, type MediaTag, type MediaTitle, type MediaTrailer, MediaType, MemoryCache, type PageInfo, type PagedResult, type RateLimitOptions, RateLimiter, type Recommendation, RecommendationSort, RedisCache, type RedisCacheOptions, type RedisLikeClient, type ScoreDistribution, type SearchCharacterOptions, type SearchMediaOptions, type SearchStaffOptions, type SearchStudioOptions, type Staff, type StaffImage, type StaffIncludeOptions, type StaffMediaNode, type StaffName, type StatusDistribution, type StreamingEpisode, type Studio, type StudioConnection, type StudioDetail, type User, type UserAvatar, type UserStatistics, type VoiceActor };

package/dist/index.d.ts

@@ -303,6 +303,43 @@ interface StaffImage {
     large: string | null;
     medium: string | null;
 }
+/** A media node returned inside `Staff.staffMedia`. */
+interface StaffMediaNode {
+    id: number;
+    title: MediaTitle;
+    type: MediaType;
+    format: MediaFormat | null;
+    status: MediaStatus | null;
+    coverImage: MediaCoverImage;
+    bannerImage: string | null;
+    genres: string[];
+    averageScore: number | null;
+    meanScore: number | null;
+    popularity: number | null;
+    favourites: number | null;
+    episodes: number | null;
+    trending: number | null;
+    hashtag: string | null;
+    season: MediaSeason | null;
+    seasonYear: number | null;
+    startDate: FuzzyDate | null;
+    endDate: FuzzyDate | null;
+    nextAiringEpisode: {
+        id: number;
+        airingAt: number;
+        episode: number;
+        mediaId: number;
+        timeUntilAiring: number;
+    } | null;
+    studios: {
+        edges: {
+            node: {
+                name: string;
+            };
+        }[];
+    } | null;
+    siteUrl: string | null;
+}
 interface Staff {
     id: number;
     name: StaffName;
@@ -319,6 +356,19 @@ interface Staff {
     bloodType: string | null;
     favourites: number | null;
     siteUrl: string | null;
+    /** Media the staff member has worked on — only present when requested via include options. */
+    staffMedia?: {
+        nodes: StaffMediaNode[];
+    } | null;
+}
+/** Options to include additional related data when fetching a staff member by ID. */
+interface StaffIncludeOptions {
+    /** Include media the staff member has worked on.
+     *  `true` = 25 results sorted by popularity. Object form to customize. */
+    media?: boolean | {
+        perPage?: number;
+        sort?: boolean;
+    };
 }
 interface UserAvatar {
     large: string | null;
@@ -791,15 +841,20 @@ declare class AniListClient {
      * Fetch a staff member by AniList ID.
      *
      * @param id - The AniList staff ID
+     * @param include - Optional include options to fetch related data (e.g. media)
      * @returns The staff object
      *
      * @example
      * ```ts
      * const staff = await client.getStaff(95001);
      * console.log(staff.name.full);
+     *
+     * // With media the staff worked on
+     * const staff = await client.getStaff(95001, { media: true });
+     * staff.staffMedia?.nodes.forEach((m) => console.log(m.title.romaji));
      * ```
      */
-    getStaff(id: number): Promise<Staff>;
+    getStaff(id: number, include?: StaffIncludeOptions): Promise<Staff>;
     /**
      * Search for staff (voice actors, directors, etc.).
      *
@@ -1207,4 +1262,4 @@ declare class RateLimiter {
     private sleep;
 }
 
-export { type AiringSchedule, AiringSort, AniListClient, type AniListClientOptions, AniListError, type AniListHooks, type CacheAdapter, type CacheOptions, type Character, type CharacterImage, type CharacterIncludeOptions, type CharacterMediaEdge, type CharacterName, CharacterRole, CharacterSort, type ExternalLink, type FuzzyDate, type GetAiringOptions, type GetPlanningOptions, type GetRecentChaptersOptions, type GetRecommendationsOptions, type GetSeasonOptions, type GetUserMediaListOptions, type Media, type MediaCharacterConnection, type MediaCharacterEdge, type MediaConnection, type MediaCoverImage, type MediaEdge, MediaFormat, type MediaIncludeOptions, type MediaListEntry, MediaListSort, MediaListStatus, type MediaRecommendationNode, MediaRelationType, MediaSeason, MediaSort, type MediaStaffConnection, type MediaStaffEdge, type MediaStats, MediaStatus, type MediaTag, type MediaTitle, type MediaTrailer, MediaType, MemoryCache, type PageInfo, type PagedResult, type RateLimitOptions, RateLimiter, type Recommendation, RecommendationSort, RedisCache, type RedisCacheOptions, type RedisLikeClient, type ScoreDistribution, type SearchCharacterOptions, type SearchMediaOptions, type SearchStaffOptions, type SearchStudioOptions, type Staff, type StaffImage, type StaffName, type StatusDistribution, type StreamingEpisode, type Studio, type StudioConnection, type StudioDetail, type User, type UserAvatar, type UserStatistics, type VoiceActor };
+export { type AiringSchedule, AiringSort, AniListClient, type AniListClientOptions, AniListError, type AniListHooks, type CacheAdapter, type CacheOptions, type Character, type CharacterImage, type CharacterIncludeOptions, type CharacterMediaEdge, type CharacterName, CharacterRole, CharacterSort, type ExternalLink, type FuzzyDate, type GetAiringOptions, type GetPlanningOptions, type GetRecentChaptersOptions, type GetRecommendationsOptions, type GetSeasonOptions, type GetUserMediaListOptions, type Media, type MediaCharacterConnection, type MediaCharacterEdge, type MediaConnection, type MediaCoverImage, type MediaEdge, MediaFormat, type MediaIncludeOptions, type MediaListEntry, MediaListSort, MediaListStatus, type MediaRecommendationNode, MediaRelationType, MediaSeason, MediaSort, type MediaStaffConnection, type MediaStaffEdge, type MediaStats, MediaStatus, type MediaTag, type MediaTitle, type MediaTrailer, MediaType, MemoryCache, type PageInfo, type PagedResult, type RateLimitOptions, RateLimiter, type Recommendation, RecommendationSort, RedisCache, type RedisCacheOptions, type RedisLikeClient, type ScoreDistribution, type SearchCharacterOptions, type SearchMediaOptions, type SearchStaffOptions, type SearchStudioOptions, type Staff, type StaffImage, type StaffIncludeOptions, type StaffMediaNode, type StaffName, type StatusDistribution, type StreamingEpisode, type Studio, type StudioConnection, type StudioDetail, type User, type UserAvatar, type UserStatistics, type VoiceActor };

package/dist/index.js

@@ -129,6 +129,46 @@ var STAFF_FIELDS = `
   favourites
   siteUrl
 `;
+var STAFF_MEDIA_FIELDS = `
+  staffMedia(perPage: $perPage, sort: [POPULARITY_DESC]) {
+    nodes {
+      id
+      title { romaji english native userPreferred }
+      type
+      format
+      status
+      coverImage { extraLarge large medium color }
+      bannerImage
+      genres
+      averageScore
+      meanScore
+      popularity
+      favourites
+      episodes
+      trending
+      hashtag
+      season
+      seasonYear
+      startDate { year month day }
+      endDate { year month day }
+      nextAiringEpisode {
+        id
+        airingAt
+        episode
+        mediaId
+        timeUntilAiring
+      }
+      studios {
+        edges {
+          node {
+            name
+          }
+        }
+      }
+      siteUrl
+    }
+  }
+`;
 var USER_FIELDS = `
   id
   name
@@ -230,6 +270,13 @@ query ($id: Int!) {
     ${STAFF_FIELDS}
   }
 }`;
+var QUERY_STAFF_BY_ID_WITH_MEDIA = `
+query ($id: Int!, $perPage: Int) {
+  Staff(id: $id) {
+    ${STAFF_FIELDS}
+    ${STAFF_MEDIA_FIELDS}
+  }
+}`;
 var QUERY_STAFF_SEARCH = `
 query ($search: String, $sort: [StaffSort], $page: Int, $perPage: Int) {
   Page(page: $page, perPage: $perPage) {
@@ -1051,15 +1098,26 @@ var AniListClient = class {
    * Fetch a staff member by AniList ID.
    *
    * @param id - The AniList staff ID
+   * @param include - Optional include options to fetch related data (e.g. media)
    * @returns The staff object
    *
    * @example
    * ```ts
    * const staff = await client.getStaff(95001);
    * console.log(staff.name.full);
+   *
+   * // With media the staff worked on
+   * const staff = await client.getStaff(95001, { media: true });
+   * staff.staffMedia?.nodes.forEach((m) => console.log(m.title.romaji));
    * ```
    */
-  async getStaff(id) {
+  async getStaff(id, include) {
+    if (include?.media) {
+      const opts = typeof include.media === "object" ? include.media : {};
+      const perPage = opts.perPage ?? 25;
+      const data2 = await this.request(QUERY_STAFF_BY_ID_WITH_MEDIA, { id, perPage });
+      return data2.Staff;
+    }
     const data = await this.request(QUERY_STAFF_BY_ID, { id });
     return data.Staff;
   }