ani-client 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,461 @@
+declare enum MediaType {
+    ANIME = "ANIME",
+    MANGA = "MANGA"
+}
+declare enum MediaFormat {
+    TV = "TV",
+    TV_SHORT = "TV_SHORT",
+    MOVIE = "MOVIE",
+    SPECIAL = "SPECIAL",
+    OVA = "OVA",
+    ONA = "ONA",
+    MUSIC = "MUSIC",
+    MANGA = "MANGA",
+    NOVEL = "NOVEL",
+    ONE_SHOT = "ONE_SHOT"
+}
+declare enum MediaStatus {
+    FINISHED = "FINISHED",
+    RELEASING = "RELEASING",
+    NOT_YET_RELEASED = "NOT_YET_RELEASED",
+    CANCELLED = "CANCELLED",
+    HIATUS = "HIATUS"
+}
+declare enum MediaSeason {
+    WINTER = "WINTER",
+    SPRING = "SPRING",
+    SUMMER = "SUMMER",
+    FALL = "FALL"
+}
+declare enum MediaSort {
+    ID = "ID",
+    TITLE_ROMAJI = "TITLE_ROMAJI",
+    TITLE_ENGLISH = "TITLE_ENGLISH",
+    TITLE_NATIVE = "TITLE_NATIVE",
+    TYPE = "TYPE",
+    FORMAT = "FORMAT",
+    START_DATE = "START_DATE",
+    END_DATE = "END_DATE",
+    SCORE = "SCORE",
+    POPULARITY = "POPULARITY",
+    TRENDING = "TRENDING",
+    EPISODES = "EPISODES",
+    DURATION = "DURATION",
+    STATUS = "STATUS",
+    FAVOURITES = "FAVOURITES",
+    UPDATED_AT = "UPDATED_AT",
+    SEARCH_MATCH = "SEARCH_MATCH"
+}
+declare enum CharacterSort {
+    ID = "ID",
+    ROLE = "ROLE",
+    SEARCH_MATCH = "SEARCH_MATCH",
+    FAVOURITES = "FAVOURITES"
+}
+interface MediaTitle {
+    romaji: string | null;
+    english: string | null;
+    native: string | null;
+    userPreferred: string | null;
+}
+interface MediaCoverImage {
+    extraLarge: string | null;
+    large: string | null;
+    medium: string | null;
+    color: string | null;
+}
+interface FuzzyDate {
+    year: number | null;
+    month: number | null;
+    day: number | null;
+}
+interface MediaTrailer {
+    id: string | null;
+    site: string | null;
+    thumbnail: string | null;
+}
+interface MediaTag {
+    id: number;
+    name: string;
+    description: string | null;
+    category: string | null;
+    rank: number | null;
+    isMediaSpoiler: boolean | null;
+}
+interface Studio {
+    id: number;
+    name: string;
+    isAnimationStudio: boolean;
+    siteUrl: string | null;
+}
+interface StudioConnection {
+    nodes: Studio[];
+}
+interface CharacterName {
+    first: string | null;
+    middle: string | null;
+    last: string | null;
+    full: string | null;
+    native: string | null;
+    alternative: string[];
+}
+interface CharacterImage {
+    large: string | null;
+    medium: string | null;
+}
+interface Media {
+    id: number;
+    idMal: number | null;
+    title: MediaTitle;
+    type: MediaType;
+    format: MediaFormat | null;
+    status: MediaStatus | null;
+    description: string | null;
+    startDate: FuzzyDate | null;
+    endDate: FuzzyDate | null;
+    season: MediaSeason | null;
+    seasonYear: number | null;
+    episodes: number | null;
+    duration: number | null;
+    chapters: number | null;
+    volumes: number | null;
+    countryOfOrigin: string | null;
+    isLicensed: boolean | null;
+    source: string | null;
+    hashtag: string | null;
+    trailer: MediaTrailer | null;
+    coverImage: MediaCoverImage;
+    bannerImage: string | null;
+    genres: string[];
+    synonyms: string[];
+    averageScore: number | null;
+    meanScore: number | null;
+    popularity: number | null;
+    favourites: number | null;
+    trending: number | null;
+    tags: MediaTag[];
+    studios: StudioConnection;
+    isAdult: boolean | null;
+    siteUrl: string | null;
+}
+interface Character {
+    id: number;
+    name: CharacterName;
+    image: CharacterImage;
+    description: string | null;
+    gender: string | null;
+    dateOfBirth: FuzzyDate | null;
+    age: string | null;
+    bloodType: string | null;
+    favourites: number | null;
+    siteUrl: string | null;
+    media: {
+        nodes: Pick<Media, "id" | "title" | "type" | "coverImage" | "siteUrl">[];
+    } | null;
+}
+interface StaffName {
+    first: string | null;
+    middle: string | null;
+    last: string | null;
+    full: string | null;
+    native: string | null;
+}
+interface StaffImage {
+    large: string | null;
+    medium: string | null;
+}
+interface Staff {
+    id: number;
+    name: StaffName;
+    language: string | null;
+    image: StaffImage;
+    description: string | null;
+    primaryOccupations: string[];
+    gender: string | null;
+    dateOfBirth: FuzzyDate | null;
+    dateOfDeath: FuzzyDate | null;
+    age: number | null;
+    yearsActive: number[];
+    homeTown: string | null;
+    bloodType: string | null;
+    favourites: number | null;
+    siteUrl: string | null;
+}
+interface UserAvatar {
+    large: string | null;
+    medium: string | null;
+}
+interface UserStatistics {
+    count: number;
+    meanScore: number;
+    minutesWatched: number;
+    episodesWatched: number;
+    chaptersRead: number;
+    volumesRead: number;
+}
+interface User {
+    id: number;
+    name: string;
+    about: string | null;
+    avatar: UserAvatar;
+    bannerImage: string | null;
+    isFollowing: boolean | null;
+    isFollower: boolean | null;
+    donatorTier: number | null;
+    donatorBadge: string | null;
+    createdAt: number | null;
+    siteUrl: string | null;
+    statistics: {
+        anime: UserStatistics;
+        manga: UserStatistics;
+    } | null;
+}
+interface PageInfo {
+    total: number | null;
+    perPage: number | null;
+    currentPage: number | null;
+    lastPage: number | null;
+    hasNextPage: boolean | null;
+}
+interface SearchMediaOptions {
+    query?: string;
+    type?: MediaType;
+    format?: MediaFormat;
+    status?: MediaStatus;
+    season?: MediaSeason;
+    seasonYear?: number;
+    genre?: string;
+    tag?: string;
+    isAdult?: boolean;
+    sort?: MediaSort[];
+    page?: number;
+    perPage?: number;
+}
+interface SearchCharacterOptions {
+    query?: string;
+    sort?: CharacterSort[];
+    page?: number;
+    perPage?: number;
+}
+interface SearchStaffOptions {
+    query?: string;
+    page?: number;
+    perPage?: number;
+}
+interface PagedResult<T> {
+    pageInfo: PageInfo;
+    results: T[];
+}
+interface AniListClientOptions {
+    /** Optional AniList OAuth token for authenticated requests */
+    token?: string;
+    /** Custom API endpoint (defaults to https://graphql.anilist.co) */
+    apiUrl?: string;
+    /** Cache configuration (enabled by default, 24h TTL) */
+    cache?: {
+        /** Time-to-live in milliseconds (default: 86 400 000 = 24h) */
+        ttl?: number;
+        /** Maximum number of cached entries (default: 500, 0 = unlimited) */
+        maxSize?: number;
+        /** Set to false to disable caching entirely */
+        enabled?: boolean;
+    };
+    /** Rate limiter configuration (enabled by default, 85 req/min) */
+    rateLimit?: {
+        /** Max requests per window (default: 85) */
+        maxRequests?: number;
+        /** Window size in ms (default: 60 000) */
+        windowMs?: number;
+        /** Max retries on 429 (default: 3) */
+        maxRetries?: number;
+        /** Retry delay in ms when Retry-After header is absent (default: 2000) */
+        retryDelayMs?: number;
+        /** Set to false to disable rate limiting entirely */
+        enabled?: boolean;
+    };
+}
+
+/**
+ * Lightweight AniList GraphQL client with built-in caching and rate limiting.
+ *
+ * @example
+ * ```ts
+ * import { AniListClient } from "ani-client";
+ *
+ * const client = new AniListClient();
+ * const anime = await client.getMedia(1); // Cowboy Bebop
+ * console.log(anime.title.romaji);
+ *
+ * // Custom cache & rate limit options
+ * const client2 = new AniListClient({
+ *   cache: { ttl: 1000 * 60 * 60 }, // 1 hour cache
+ *   rateLimit: { maxRequests: 60 },
+ * });
+ * ```
+ */
+declare class AniListClient {
+    private readonly apiUrl;
+    private readonly headers;
+    private readonly cache;
+    private readonly rateLimiter;
+    constructor(options?: AniListClientOptions);
+    /**
+     * @internal
+     */
+    private request;
+    /**
+     * Fetch a single media entry by its AniList ID.
+     *
+     * @param id - The AniList media ID
+     * @returns The media object
+     */
+    getMedia(id: number): Promise<Media>;
+    /**
+     * Search for anime or manga.
+     *
+     * @param options - Search / filter parameters
+     * @returns Paginated results with matching media
+     *
+     * @example
+     * ```ts
+     * const results = await client.searchMedia({
+     *   query: "Naruto",
+     *   type: MediaType.ANIME,
+     *   perPage: 5,
+     * });
+     * ```
+     */
+    searchMedia(options?: SearchMediaOptions): Promise<PagedResult<Media>>;
+    /**
+     * Get currently trending anime or manga.
+     *
+     * @param type - `MediaType.ANIME` or `MediaType.MANGA` (defaults to ANIME)
+     * @param page - Page number (default 1)
+     * @param perPage - Results per page (default 20, max 50)
+     */
+    getTrending(type?: MediaType, page?: number, perPage?: number): Promise<PagedResult<Media>>;
+    /**
+     * Fetch a character by AniList ID.
+     */
+    getCharacter(id: number): Promise<Character>;
+    /**
+     * Search for characters by name.
+     */
+    searchCharacters(options?: SearchCharacterOptions): Promise<PagedResult<Character>>;
+    /**
+     * Fetch a staff member by AniList ID.
+     */
+    getStaff(id: number): Promise<Staff>;
+    /**
+     * Search for staff (voice actors, directors, etc.).
+     */
+    searchStaff(options?: SearchStaffOptions): Promise<PagedResult<Staff>>;
+    /**
+     * Fetch a user by AniList ID.
+     */
+    getUser(id: number): Promise<User>;
+    /**
+     * Fetch a user by username.
+     */
+    getUserByName(name: string): Promise<User>;
+    /**
+     * Execute an arbitrary GraphQL query against the AniList API.
+     * Useful for advanced use-cases not covered by the built-in methods.
+     *
+     * @param query - A valid GraphQL query string
+     * @param variables - Optional variables object
+     */
+    raw<T = unknown>(query: string, variables?: Record<string, unknown>): Promise<T>;
+    /**
+     * Clear the entire response cache.
+     */
+    clearCache(): void;
+    /**
+     * Number of entries currently in the cache.
+     */
+    get cacheSize(): number;
+}
+
+/**
+ * Custom error class for AniList API errors.
+ */
+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[]);
+}
+
+/**
+ * Simple in-memory cache with configurable TTL.
+ * Used internally by AniListClient to avoid redundant API calls.
+ */
+interface CacheOptions {
+    /** Time-to-live in milliseconds (default: 24 hours) */
+    ttl?: number;
+    /** Maximum number of entries to keep (default: 500, 0 = unlimited) */
+    maxSize?: number;
+    /** Disable caching entirely (default: false) */
+    enabled?: boolean;
+}
+declare class MemoryCache {
+    private readonly ttl;
+    private readonly maxSize;
+    private readonly enabled;
+    private readonly store;
+    constructor(options?: CacheOptions);
+    /** Build a deterministic cache key from a query + variables pair. */
+    static key(query: string, variables: Record<string, unknown>): string;
+    /** Retrieve a cached value, or `undefined` if missing / expired. */
+    get<T>(key: string): T | undefined;
+    /** Store a value in the cache. */
+    set<T>(key: string, data: T): void;
+    /** Remove a specific entry. */
+    delete(key: string): boolean;
+    /** Clear the entire cache. */
+    clear(): void;
+    /** Number of entries currently stored. */
+    get size(): number;
+}
+
+/**
+ * Rate limiter with automatic retry for AniList API.
+ *
+ * AniList allows 90 requests per minute.
+ * When a 429 (Too Many Requests) is received, the client
+ * waits for the Retry-After header and retries automatically.
+ */
+interface RateLimitOptions {
+    /** Max requests per window (default: 85, conservative under AniList's 90/min) */
+    maxRequests?: number;
+    /** Window size in milliseconds (default: 60 000 = 1 minute) */
+    windowMs?: number;
+    /** Max number of retries on 429 responses (default: 3) */
+    maxRetries?: number;
+    /** Default retry delay in ms when Retry-After header is missing (default: 2000) */
+    retryDelayMs?: number;
+    /** Disable rate limiting entirely (default: false) */
+    enabled?: boolean;
+}
+declare class RateLimiter {
+    private readonly maxRequests;
+    private readonly windowMs;
+    private readonly maxRetries;
+    private readonly retryDelayMs;
+    private readonly enabled;
+    /** @internal */
+    private timestamps;
+    constructor(options?: RateLimitOptions);
+    /**
+     * Wait until it's safe to make a request (respects rate limit window).
+     */
+    acquire(): Promise<void>;
+    /**
+     * Execute a fetch with automatic retry on 429 responses.
+     */
+    fetchWithRetry(url: string, init: RequestInit): Promise<Response>;
+    private sleep;
+}
+
+export { AniListClient, type AniListClientOptions, AniListError, type CacheOptions, type Character, type CharacterImage, type CharacterName, CharacterSort, type FuzzyDate, type Media, type MediaCoverImage, MediaFormat, MediaSeason, MediaSort, MediaStatus, type MediaTag, type MediaTitle, type MediaTrailer, MediaType, MemoryCache, type PageInfo, type PagedResult, type RateLimitOptions, RateLimiter, type SearchCharacterOptions, type SearchMediaOptions, type SearchStaffOptions, type Staff, type StaffImage, type StaffName, type Studio, type StudioConnection, type User, type UserAvatar, type UserStatistics };