@tutkli/jikan-ts 2.1.0 → 3.0.0

package/dist/clients/people.client.d.ts

@@ -0,0 +1,46 @@
+import type { JikanImages, PeopleSearchParams, Person, PersonAnimePosition, PersonFull, PersonMangaPosition, PersonVoiceActingRole } from '../models';
+import { BaseClient } from './base.client';
+/**
+ * **People Client**
+ *
+ * Client used to access the People Endpoints:
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class PeopleClient extends BaseClient {
+    /**
+     * Get complete person data
+     * @param id Person ID
+     */
+    getPersonFullById(id: number): Promise<import("../models").JikanResponse<PersonFull>>;
+    /**
+     * Get person by ID
+     * @param id Person ID
+     */
+    getPersonById(id: number): Promise<import("../models").JikanResponse<Person>>;
+    /**
+     * Get anime staff positions of a person
+     * @param id Person ID
+     */
+    getPersonAnime(id: number): Promise<import("../models").JikanResponse<PersonAnimePosition[]>>;
+    /**
+     * Get voice acting roles of a person
+     * @param id Person ID
+     */
+    getPersonVoices(id: number): Promise<import("../models").JikanResponse<PersonVoiceActingRole[]>>;
+    /**
+     * Get manga works of a person
+     * @param id Person ID
+     */
+    getPersonManga(id: number): Promise<import("../models").JikanResponse<PersonMangaPosition[]>>;
+    /**
+     * Get pictures of a person
+     * @param id Person ID
+     */
+    getPersonPictures(id: number): Promise<import("../models").JikanResponse<JikanImages[]>>;
+    /**
+     * Search people
+     * @param searchParams Search parameters
+     */
+    getPeopleSearch(searchParams?: Partial<PeopleSearchParams>): Promise<import("../models").JikanResponse<Person[]>>;
+}

package/dist/clients/producers.client.d.ts

@@ -0,0 +1,31 @@
+import type { JikanNamedResource, Producer, ProducerFull, ProducersSearchParams } from '../models';
+import { BaseClient } from './base.client';
+/**
+ * **Producers Client**
+ *
+ * Client used to access the Producers Endpoints:
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class ProducersClient extends BaseClient {
+    /**
+     * Get complete producer data
+     * @param id Producer ID
+     */
+    getProducerFullById(id: number): Promise<import("../models").JikanResponse<ProducerFull>>;
+    /**
+     * Get producer by ID
+     * @param id Producer ID
+     */
+    getProducerById(id: number): Promise<import("../models").JikanResponse<Producer>>;
+    /**
+     * Get producer external links
+     * @param id Producer ID
+     */
+    getProducerExternal(id: number): Promise<import("../models").JikanResponse<JikanNamedResource[]>>;
+    /**
+     * Search producers
+     * @param searchParams Search parameters
+     */
+    getProducersSearch(searchParams?: Partial<ProducersSearchParams>): Promise<import("../models").JikanResponse<Producer[]>>;
+}

package/dist/clients/random.client.d.ts

@@ -0,0 +1,27 @@
+import type { Anime, Character, Manga, Person } from '../models';
+import { BaseClient } from './base.client';
+/**
+ * **Random Client**
+ *
+ * Client used to access the Random Endpoints:
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class RandomClient extends BaseClient {
+    /**
+     * Get random anime
+     */
+    getRandomAnime(): Promise<import("../models").JikanResponse<Anime>>;
+    /**
+     * Get random manga
+     */
+    getRandomManga(): Promise<import("../models").JikanResponse<Manga>>;
+    /**
+     * Get a random character
+     */
+    getRandomCharacters(): Promise<import("../models").JikanResponse<Character>>;
+    /**
+     * Get random person
+     */
+    getRandomPerson(): Promise<import("../models").JikanResponse<Person>>;
+}

package/dist/clients/recommendations.client.d.ts

@@ -0,0 +1,21 @@
+import type { PaginationParams, RecentRecommendation } from '../models';
+import { BaseClient } from './base.client';
+/**
+ * **Recommendations Client**
+ *
+ * Client used to access the Recommendations Endpoints:
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class RecommendationsClient extends BaseClient {
+    /**
+     * Get recent anime recommendations
+     * @param params Pagination parameters
+     */
+    getRecentAnimeRecommendations(params?: Partial<PaginationParams>): Promise<import("../models").JikanResponse<RecentRecommendation[]>>;
+    /**
+     * Get recent manga recommendations
+     * @param params Pagination parameters
+     */
+    getRecentMangaRecommendations(params?: Partial<PaginationParams>): Promise<import("../models").JikanResponse<RecentRecommendation[]>>;
+}

package/dist/clients/reviews.client.d.ts

@@ -0,0 +1,21 @@
+import type { AnimeReview, MangaReview, ReviewsParams } from '../models';
+import { BaseClient } from './base.client';
+/**
+ * **Reviews Client**
+ *
+ * Client used to access the Reviews Endpoints:
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class ReviewsClient extends BaseClient {
+    /**
+     * Get recent anime reviews
+     * @param params Review parameters
+     */
+    getRecentAnimeReviews(params?: Partial<ReviewsParams>): Promise<import("../models").JikanResponse<AnimeReview[]>>;
+    /**
+     * Get recent manga reviews
+     * @param params Review parameters
+     */
+    getRecentMangaReviews(params?: Partial<ReviewsParams>): Promise<import("../models").JikanResponse<MangaReview[]>>;
+}

package/dist/clients/schedules.client.d.ts

@@ -0,0 +1,16 @@
+import type { Anime, SchedulesParams } from '../models';
+import { BaseClient } from './base.client';
+/**
+ * **Schedules Client**
+ *
+ * Client used to access the Schedules Endpoints
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class SchedulesClient extends BaseClient {
+    /**
+     * Returns weekly schedule
+     * @param searchParams Filter parameters
+     */
+    getSchedules(searchParams?: Partial<SchedulesParams>): Promise<import("../models").JikanResponse<Anime[]>>;
+}

package/dist/clients/seasons.client.d.ts

@@ -0,0 +1,32 @@
+import type { Anime, AnimeSeason, JikanSeasonsParams, SeasonNowParams, SeasonsListData } from '../models';
+import { BaseClient } from './base.client';
+/**
+ * **Seasons Client**
+ *
+ * Client used to access the Seasons Endpoints
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class SeasonsClient extends BaseClient {
+    /**
+     * Get the seasonal anime by year and season
+     * @param year Season year
+     * @param season Season value
+     * @param searchParams Filter parameters
+     */
+    getSeason(year: number, season: AnimeSeason, searchParams?: Partial<JikanSeasonsParams>): Promise<import("../models").JikanResponse<Anime[]>>;
+    /**
+     * Get current seasonal anime
+     * @param searchParams Filter parameters
+     */
+    getSeasonNow(searchParams?: Partial<SeasonNowParams>): Promise<import("../models").JikanResponse<Anime[]>>;
+    /**
+     * Get available list of seasons
+     */
+    getSeasonsList(): Promise<import("../models").JikanResponse<SeasonsListData[]>>;
+    /**
+     * Get upcoming season's anime
+     * @param searchParams Filter parameters
+     */
+    getSeasonUpcoming(searchParams?: Partial<JikanSeasonsParams>): Promise<import("../models").JikanResponse<Anime[]>>;
+}

package/dist/clients/top.client.d.ts

@@ -0,0 +1,36 @@
+import type { Anime, AnimeReview, AnimeTopParams, Character, JikanTopParams, Manga, MangaTopParams, Person } from '../models';
+import { BaseClient } from './base.client';
+/**
+ * **Top Client**
+ *
+ * Client used to access the Top Endpoints:
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class TopClient extends BaseClient {
+    /**
+     * Get the top Animes
+     * @param searchParams Filter parameters
+     */
+    getTopAnime(searchParams?: Partial<AnimeTopParams>): Promise<import("../models").JikanResponse<Anime[]>>;
+    /**
+     * Get the top Mangas
+     * @param searchParams Filter parameters
+     */
+    getTopManga(searchParams?: Partial<MangaTopParams>): Promise<import("../models").JikanResponse<Manga[]>>;
+    /**
+     * Get the top Characters
+     * @param searchParams Filter parameters
+     */
+    getTopCharacters(searchParams?: Partial<JikanTopParams>): Promise<import("../models").JikanResponse<Character[]>>;
+    /**
+     * Get top people
+     * @param params pagination params
+     */
+    getTopPeople(params?: Partial<JikanTopParams>): Promise<import("../models").JikanResponse<Person[]>>;
+    /**
+     * Get top reviews
+     * @param params pagination params
+     */
+    getTopReviews(params?: Partial<JikanTopParams>): Promise<import("../models").JikanResponse<AnimeReview[]>>;
+}

package/dist/clients/watch.client.d.ts

@@ -0,0 +1,27 @@
+import type { PaginationParams } from '../models';
+import type { WatchEpisode, WatchEpisodePromo } from '../models/watch/watch.model';
+import { BaseClient } from './base.client';
+/**
+ * **Watch Client**
+ *  Client used to access the Watch Endpoint:
+ *
+ *  See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class WatchClient extends BaseClient {
+    /**
+     * @returns Recently added episodes
+     */
+    getWatchRecentEpisodes(): Promise<import("../models").JikanResponse<WatchEpisode[]>>;
+    /**
+     * @returns Recently Popular episodes
+     */
+    getWatchPopularEpisodes(): Promise<import("../models").JikanResponse<WatchEpisode[]>>;
+    /**
+     * @returns Recently added promotional videos
+     */
+    getWatchRecentPromos(params?: Partial<PaginationParams>): Promise<import("../models").JikanResponse<WatchEpisodePromo[]>>;
+    /**
+     * @returns Popular promotional videos
+     */
+    getWatchPopularPromos(): Promise<import("../models").JikanResponse<WatchEpisodePromo[]>>;
+}

package/dist/config/cache.d.ts

@@ -0,0 +1,11 @@
+export interface CacheOptions {
+    /** TTL in milliseconds. Default: 5 minutes */
+    ttl: number;
+}
+export declare class ResponseCache {
+    private cache;
+    private ttl;
+    constructor(options?: Partial<CacheOptions>);
+    get<T>(key: string): T | undefined;
+    set(key: string, data: unknown): void;
+}

package/dist/config/ky.config.d.ts

@@ -0,0 +1,11 @@
+import type { KyInstance } from 'ky';
+import { type CacheOptions, ResponseCache } from './cache';
+export interface KyClientConfig {
+    enableLogging?: boolean;
+    cacheOptions?: Partial<CacheOptions>;
+    kyInstance?: KyInstance;
+}
+export declare function createKyInstance(config?: KyClientConfig): {
+    api: KyInstance;
+    cache: ResponseCache;
+};

package/dist/config/logging.config.d.ts

@@ -0,0 +1,4 @@
+import type { AfterResponseHook, BeforeErrorHook, BeforeRequestHook } from 'ky';
+export declare const loggingBeforeRequest: BeforeRequestHook;
+export declare const loggingAfterResponse: AfterResponseHook;
+export declare const loggingBeforeError: BeforeErrorHook;

package/dist/constants/base.const.d.ts

@@ -0,0 +1 @@
+export declare const BASE_URL = "https://api.jikan.moe/v4";

package/dist/endpoints/anime.endpoints.d.ts

@@ -0,0 +1,23 @@
+export declare const AnimeEndpoints: {
+    readonly animeFullById: "/anime/{id}/full";
+    readonly animeById: "/anime/{id}";
+    readonly animeCharacters: "/anime/{id}/characters";
+    readonly animeStaff: "/anime/{id}/staff";
+    readonly animeEpisodes: "/anime/{id}/episodes";
+    readonly animeEpisodeById: "/anime/{id}/episodes/{episode}";
+    readonly animeNews: "/anime/{id}/news";
+    readonly animeForum: "/anime/{id}/forum";
+    readonly animeVideos: "/anime/{id}/videos";
+    readonly animeVideosEpisodes: "/anime/{id}/videos/episodes";
+    readonly animePictures: "/anime/{id}/pictures";
+    readonly animeStatistics: "/anime/{id}/statistics";
+    readonly animeMoreInfo: "/anime/{id}/moreinfo";
+    readonly animeRecommendations: "/anime/{id}/recommendations";
+    readonly animeUserUpdates: "/anime/{id}/userupdates";
+    readonly animeReviews: "/anime/{id}/reviews";
+    readonly animeRelations: "/anime/{id}/relations";
+    readonly animeThemes: "/anime/{id}/themes";
+    readonly animeExternal: "/anime/{id}/external";
+    readonly animeStreaming: "/anime/{id}/streaming";
+    readonly animeSearch: "/anime";
+};

package/dist/endpoints/characters.endpoints.d.ts

@@ -0,0 +1,9 @@
+export declare const CharactersEndpoints: {
+    readonly characterFullById: "/characters/{id}/full";
+    readonly characterById: "/characters/{id}";
+    readonly characterAnime: "/characters/{id}/anime";
+    readonly charactersManga: "/characters/{id}/manga";
+    readonly characterVoiceActors: "/characters/{id}/voices";
+    readonly characterPictures: "/characters/{id}/pictures";
+    readonly characterSearch: "/characters";
+};

package/dist/endpoints/clubs.endpoints.d.ts

@@ -0,0 +1,7 @@
+export declare const ClubsEndpoints: {
+    readonly clubById: "/clubs/{id}";
+    readonly clubMembers: "/clubs/{id}/members";
+    readonly clubStaff: "/clubs/{id}/staff";
+    readonly clubRelations: "/clubs/{id}/relations";
+    readonly clubSearch: "/clubs";
+};

package/dist/endpoints/genres.endpoints.d.ts

@@ -0,0 +1,4 @@
+export declare const GenresEndpoints: {
+    readonly animeGenres: "/genres/anime";
+    readonly mangaGenres: "/genres/manga";
+};

package/dist/endpoints/magazines.endpoints.d.ts

@@ -0,0 +1,3 @@
+export declare const MagazinesEndpoints: {
+    readonly magazines: "/magazines";
+};

package/dist/endpoints/manga.endpoints.d.ts

@@ -0,0 +1,16 @@
+export declare const MangaEndpoints: {
+    readonly mangaSearch: "/manga";
+    readonly mangaFullById: "/manga/{id}/full";
+    readonly mangaById: "/manga/{id}";
+    readonly mangaCharacters: "/manga/{id}/characters";
+    readonly mangaNews: "/manga/{id}/news";
+    readonly mangaTopics: "/manga/{id}/forum";
+    readonly mangaPictures: "/manga/{id}/pictures";
+    readonly mangaStatistics: "/manga/{id}/statistics";
+    readonly mangaMoreInfo: "/manga/{id}/moreinfo";
+    readonly mangaRelations: "/manga/{id}/relations";
+    readonly mangaExternal: "/manga/{id}/external";
+    readonly mangaRecommendations: "/manga/{id}/recommendations";
+    readonly mangaUserUpdates: "/manga/{id}/userupdates";
+    readonly mangaReviews: "/manga/{id}/reviews";
+};

package/dist/endpoints/people.endpoints.d.ts

@@ -0,0 +1,9 @@
+export declare const PeopleEndpoints: {
+    readonly personFullById: "/people/{id}/full";
+    readonly personById: "/people/{id}";
+    readonly personAnime: "/people/{id}/anime";
+    readonly personVoices: "/people/{id}/voices";
+    readonly personManga: "/people/{id}/manga";
+    readonly personPictures: "/people/{id}/pictures";
+    readonly peopleSearch: "/people";
+};

package/dist/endpoints/producers.endpoints.d.ts

@@ -0,0 +1,6 @@
+export declare const ProducersEndpoints: {
+    readonly producerFullById: "/producers/{id}/full";
+    readonly producerById: "/producers/{id}";
+    readonly producerExternal: "/producers/{id}/external";
+    readonly producersSearch: "/producers";
+};

package/dist/endpoints/random.endpoints.d.ts

@@ -0,0 +1,7 @@
+export declare const RandomEndpoints: {
+    readonly randomAnime: "/random/anime";
+    readonly randomManga: "/random/manga";
+    readonly randomCharacters: "/random/characters";
+    readonly randomPeople: "/random/people";
+    readonly randomUsers: "/random/users";
+};

package/dist/endpoints/recommendations.endpoints.d.ts

@@ -0,0 +1,4 @@
+export declare const RecommendationsEndpoints: {
+    readonly recentAnimeRecommendations: "/recommendations/anime";
+    readonly recentMangaRecommendations: "/recommendations/manga";
+};

package/dist/endpoints/reviews.endpoints.d.ts

@@ -0,0 +1,4 @@
+export declare const ReviewsEndpoints: {
+    readonly animeReviews: "/reviews/anime";
+    readonly mangaReviews: "/reviews/manga";
+};

package/dist/endpoints/schedules.endpoints.d.ts

@@ -0,0 +1,3 @@
+export declare const SchedulesEndpoints: {
+    readonly schedules: "/schedules";
+};

package/dist/endpoints/seasons.endpoints.d.ts

@@ -0,0 +1,6 @@
+export declare const SeasonsEndpoints: {
+    readonly season: "/seasons/{year}/{season}";
+    readonly seasonNow: "/seasons/now";
+    readonly seasonsList: "/seasons";
+    readonly seasonUpcoming: "/seasons/upcoming";
+};

package/dist/endpoints/top.endpoints.d.ts

@@ -0,0 +1,7 @@
+export declare const TopEndpoints: {
+    readonly topAnime: "/top/anime";
+    readonly topManga: "/top/manga";
+    readonly topCharacters: "/top/characters";
+    readonly topPeople: "/top/people";
+    readonly topReviews: "/top/reviews";
+};

package/dist/endpoints/watch.endpoints.d.ts

@@ -0,0 +1,6 @@
+export declare const WatchEndpoints: {
+    readonly watchRecentEpisodes: "/watch/episodes";
+    readonly watchPopularEpisodes: "/watch/episodes/popular";
+    readonly watchRecentPromos: "/watch/promos";
+    readonly watchPopularPromos: "/watch/promos/popular";
+};