@tutkli/jikan-ts 2.1.0 → 3.0.0

package/README.md

@@ -4,118 +4,121 @@
 
 <p align="center">
 
-  ![Language Shield](https://img.shields.io/badge/language-typescript-blue?style=for-the-badge)
-  ![GitHub License](https://img.shields.io/github/license/tutkli/jikan-ts?style=for-the-badge&color=blueviolet)
-  ![Code Style Shield](https://img.shields.io/badge/code%20style-Biome-60A5FA?style=for-the-badge&logo=biome)
-  ![NPM Downloads](https://img.shields.io/npm/dt/%40tutkli%2Fjikan-ts?style=for-the-badge&color=red&logo=npm&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40tutkli%2Fjikan-ts)
-  ![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40tutkli%2Fjikan-ts?style=for-the-badge&color=darkgreen&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40tutkli%2Fjikan-ts)
+![Language Shield](https://img.shields.io/badge/language-typescript-blue?style=for-the-badge)
+![GitHub License](https://img.shields.io/github/license/tutkli/jikan-ts?style=for-the-badge&color=blueviolet)
+![Code Style Shield](https://img.shields.io/badge/code%20style-Oxfmt-60A5FA?style=for-the-badge)
+![NPM Downloads](https://img.shields.io/npm/dt/%40tutkli%2Fjikan-ts?style=for-the-badge&color=red&logo=npm&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40tutkli%2Fjikan-ts)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40tutkli%2Fjikan-ts?style=for-the-badge&color=darkgreen&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40tutkli%2Fjikan-ts)
 
 </p>
 
-> Jikan API wrapper for Typescript and Node.js with built-in typings.
+> Jikan API wrapper for TypeScript and Node.js with built-in typing.
 
 ## Features
 
 - 💅 Fully typed
-- ♻ Http Request Cache
-- 📄 Logging
+- ♻ Built-in in-memory response cache (TTL-based)
+- 📄 Request logging
 - 📦 ESM with tree shaking support
 
 ## Installation
 
+### Full client (with ky)
+
 ```bash
-npm install --save @tutkli/jikan-ts axios axios-cache-interceptor
-# or
-yarn add @tutkli/jikan-ts axios axios-cache-interceptor
+npm install @tutkli/jikan-ts ky
+```
+
+### Types only (zero runtime dependencies)
+
+If you want to use the types and endpoint constants to build your own HTTP client:
+
+```bash
+npm install @tutkli/jikan-ts
 ```
 
 ## Example
 
-Using a specific client, like **AnimeClient**:
+### Using the types-only import
 
 ```ts
-import { AnimeClient, JikanResponse, Anime } from '@tutkli/jikan-ts';
+import type { Anime, JikanResponse } from '@tutkli/jikan-ts/types'
+import { AnimeEndpoints, BASE_URL } from '@tutkli/jikan-ts/types'
+
+// Build your own HTTP client using the provided types and endpoints
+const response = await fetch(
+	`${BASE_URL}${AnimeEndpoints.AnimeById.replace('{id}', '1')}`
+)
+const data: JikanResponse<Anime> = await response.json()
+```
 
-const animeClient = new AnimeClient();
+### Using a specific client, like **AnimeClient**
 
-animeClient
-  .getAnimeById(1)
-  .then((response: JikanResponse<Anime>) => {
-    /* ... */
-  })
+```ts
+import { AnimeClient, JikanResponse, Anime } from '@tutkli/jikan-ts'
+
+const animeClient = new AnimeClient()
+
+animeClient.getAnimeById(1).then((response: JikanResponse<Anime>) => {
+	/* ... */
+})
 ```
 
-Or, using the **JikanClient**:
+### Using the **JikanClient**
 
 ```ts
-import { JikanClient, JikanResponse, Anime } from '@tutkli/jikan-ts';
+import { JikanClient, JikanResponse, Anime } from '@tutkli/jikan-ts'
 
-const jikanClient = new JikanClient();
+const jikanClient = new JikanClient()
 
-jikanClient.anime
-  .getAnimeById(1)
-  .then((response: JikanResponse<Anime>) => {
-    /* ... */
-  })
+jikanClient.anime.getAnimeById(1).then((response: JikanResponse<Anime>) => {
+	/* ... */
+})
 ```
 
 ## Client configuration
 
 ### Cache Configuration
 
-Jikan-ts uses `axios-cache-interceptor` to store request results.
-To use a specific configuration, pass the `cacheOptions` argument when instantiating a client:
+Jikan-ts uses a built-in in-memory cache with TTL-based expiry (default: 5 minutes).
+To customize the cache, pass the `cacheOptions` argument when instantiating a client:
 
 ```ts
-import { AnimeClient } from '@tutkli/jikan-ts';
+import { AnimeClient } from '@tutkli/jikan-ts'
 
 const animeClient = new AnimeClient({
-    cacheOptions: { ... } // axios-cache-interceptor options
-  }
-);
+	cacheOptions: { ttl: 10 * 60 * 1000 } // 10 minutes
+})
 ```
 
-### Custom Axios instance
+### Custom Ky Instance
 
-Jikan uses `axios` as an `http` client and if you are not satisfied with the default client settings, then you can build your instance by passing it to the optional `axiosInstance` argument
+Jikan-ts uses [Ky](https://github.com/sindresorhus/ky) as its HTTP client. You can provide your own Ky instance via the optional `kyInstance` argument:
 
 ```ts
-import { AnimeClient } from '@tutkli/jikan-ts';
-import Axios from 'axios';
+import { AnimeClient } from '@tutkli/jikan-ts'
+import ky from 'ky'
 
 const animeClient = new AnimeClient({
-    axiosInstance: Axios.create({ ... })
-  }
-);
+	kyInstance: ky.create({
+		/* ... */
+	})
+})
 ```
 
-For more information, check out the [axios-cache-interceptor Documentation](https://axios-cache-interceptor.js.org/).
-
 ### Logging
 
 To enable logging, pass the `enableLogging` argument as `true`.
 
 ```ts
-import { AnimeClient } from '@tutkli/jikan-ts';
+import { AnimeClient } from '@tutkli/jikan-ts'
 
 const animeClient = new AnimeClient({
-  enableLogging: true,
-});
+	enableLogging: true
+})
 ```
 
-## Available Clients
-
-- AnimeClient
-- CharactersClient
-- GenresClient
-- MangaClient
-- TopClient
-- SchedulesClient
-- SeasonsClient
-- RandomClient
-- JikanClient (Main client)
-
-## Leave you feedback
+## Leave your feedback
 
 - Did you find this project useful? [Leave a ⭐](https://github.com/tutkli/jikan-ts)
 - Found a problem? [Create an issue 🔎](https://github.com/tutkli/jikan-ts/issues)

package/dist/chunk-b9f01kcn.js

@@ -0,0 +1 @@
+import{A as R,B as K,C as D,D as Q,E as S,F as v,G as o,H as V,I as k,J as X,u as U,v as c,w as N,x as j,y as F,z as l}from"./chunk-ygw2424n.js";import p from"ky";class Z{cache=new Map;ttl;constructor($={}){this.ttl=$.ttl??300000}get($){let x=this.cache.get($);if(!x)return;if(Date.now()>x.expiry){this.cache.delete($);return}return x.data}set($,x){this.cache.set($,{data:x,expiry:Date.now()+this.ttl})}}var E=($)=>{console.info(`[Request] ${$.method.toUpperCase()} | ${$.url}`)},h=($,x,I)=>{if(I.ok)console.info(`[Request Response] ${$.method.toUpperCase()} | ${$.url}`);else console.error(`[Response Error] CODE ${I.status} | ${I.statusText}`)},m=($)=>{return console.error(`[Request Error] CODE ${$.response?.status??"UNKNOWN"} | ${$.message}`),$};function Y($={}){let x=new Z($.cacheOptions);if($.kyInstance)return{api:$.kyInstance,cache:x};return{api:p.create({prefixUrl:c,headers:{"Content-Type":"application/json"},retry:0,hooks:$.enableLogging?{beforeRequest:[E],afterResponse:[h],beforeError:[m]}:{}}),cache:x}}class H{api;cache;constructor($={}){if($._cache&&$.kyInstance)this.api=$.kyInstance,this.cache=$._cache;else{let{api:x,cache:I}=Y({enableLogging:$.enableLogging,cacheOptions:$.cacheOptions,kyInstance:$.kyInstance});this.api=x,this.cache=I}}async getResource($,x={},I={}){let q=this.replacePathParams($,x),L=this.buildCacheKey(q,I),g=this.cache.get(L);if(g)return g;let r=q.startsWith("/")?q.slice(1):q,C=this.cleanParams(I),P=await this.api.get(r,{searchParams:Object.keys(C).length>0?C:void 0}).json();return this.cache.set(L,P),P}buildCacheKey($,x){let I=Object.entries(x).filter(([,q])=>q!==void 0).sort(([q],[L])=>q.localeCompare(L)).map(([q,L])=>`${q}=${L}`).join("&");return I?`${$}?${I}`:$}cleanParams($){return Object.fromEntries(Object.entries($).filter(([,x])=>x!==void 0))}replacePathParams($,x){let I=$;for(let q of Object.keys(x)){if(!RegExp(`{${q}}`).exec(I))throw Error(`Path does not contain "${q}" parameter.`);I=I.replace(`{${q}}`,String(x[q]))}return I}}class _ extends H{getAnimeFullById($){return this.getResource(U.animeFullById,{id:$})}getAnimeById($){return this.getResource(U.animeById,{id:$})}getAnimeCharacters($){return this.getResource(U.animeCharacters,{id:$})}getAnimeStaff($){return this.getResource(U.animeStaff,{id:$})}getAnimeEpisodes($,x=1){return this.getResource(U.animeEpisodes,{id:$},{page:x})}getAnimeEpisodeById($,x){return this.getResource(U.animeEpisodeById,{id:$,episode:x})}getAnimeNews($,x){return this.getResource(U.animeNews,{id:$},{page:x})}getAnimeForum($,x){return this.getResource(U.animeForum,{id:$},x?{filter:x}:void 0)}getAnimeVideos($){return this.getResource(U.animeVideos,{id:$})}getAnimeEpisodeVideos($,x=1){return this.getResource(U.animeVideosEpisodes,{id:$},{page:x})}getAnimePictures($){return this.getResource(U.animePictures,{id:$})}getAnimeStatistics($){return this.getResource(U.animeStatistics,{id:$})}getAnimeMoreInfo($){return this.getResource(U.animeMoreInfo,{id:$})}getAnimeRecommendations($){return this.getResource(U.animeRecommendations,{id:$})}getAnimeRelations($){return this.getResource(U.animeRelations,{id:$})}getAnimeExternal($){return this.getResource(U.animeExternal,{id:$})}getAnimeStreaming($){return this.getResource(U.animeStreaming,{id:$})}getAnimeThemes($){return this.getResource(U.animeThemes,{id:$})}getAnimeUserUpdates($,x=1){return this.getResource(U.animeUserUpdates,{id:$},{page:x})}getAnimeReviews($,x){return this.getResource(U.animeReviews,{id:$},x)}getAnimeSearch($){return this.getResource(U.animeSearch,{},$)}}class f extends H{getCharacterFullById($){return this.getResource(N.characterFullById,{id:$})}getCharacterById($){return this.getResource(N.characterById,{id:$})}getCharacterAnime($){return this.getResource(N.characterAnime,{id:$})}getCharacterManga($){return this.getResource(N.charactersManga,{id:$})}getCharacterVoiceActors($){return this.getResource(N.characterVoiceActors,{id:$})}getCharacterPictures($){return this.getResource(N.characterPictures,{id:$})}getCharacterSearch($){return this.getResource(N.characterSearch,{},$)}}class y extends H{getClubsById($){return this.getResource(j.clubById,{id:$})}getClubMembers($,x={}){return this.getResource(j.clubMembers,{id:$},x)}getClubStaff($){return this.getResource(j.clubStaff,{id:$})}getClubRelations($){return this.getResource(j.clubRelations,{id:$})}getClubSearch($={}){return this.getResource(j.clubSearch,{},$)}}class J extends H{getAnimeGenres($){return this.getResource(F.animeGenres,{},{filter:$})}getMangaGenres($){return this.getResource(F.mangaGenres,{},{filter:$})}}class z extends H{getMagazines($={}){return this.getResource(l.magazines,{},$)}}class W extends H{getMangaFullById($){return this.getResource(R.mangaFullById,{id:$})}getMangaById($){return this.getResource(R.mangaById,{id:$})}getMangaCharacters($){return this.getResource(R.mangaCharacters,{id:$})}getMangaNews($){return this.getResource(R.mangaNews,{id:$})}getMangaTopics($,x){return this.getResource(R.mangaTopics,{id:$},x?{filter:x}:void 0)}getMangaPictures($){return this.getResource(R.mangaPictures,{id:$})}getMangaStatistics($){return this.getResource(R.mangaStatistics,{id:$})}getMangaMoreInfo($){return this.getResource(R.mangaMoreInfo,{id:$})}getMangaRecommendations($){return this.getResource(R.mangaRecommendations,{id:$})}getMangaRelations($){return this.getResource(R.mangaRelations,{id:$})}getMangaExternal($){return this.getResource(R.mangaExternal,{id:$})}getMangaUserUpdates($,x=1){return this.getResource(R.mangaUserUpdates,{id:$},{page:x})}getMangaReviews($,x){return this.getResource(R.mangaReviews,{id:$},x)}getMangaSearch($){return this.getResource(R.mangaSearch,{},$)}}class B extends H{getPersonFullById($){return this.getResource(K.personFullById,{id:$})}getPersonById($){return this.getResource(K.personById,{id:$})}getPersonAnime($){return this.getResource(K.personAnime,{id:$})}getPersonVoices($){return this.getResource(K.personVoices,{id:$})}getPersonManga($){return this.getResource(K.personManga,{id:$})}getPersonPictures($){return this.getResource(K.personPictures,{id:$})}getPeopleSearch($){return this.getResource(K.peopleSearch,{},$)}}class T extends H{getProducerFullById($){return this.getResource(D.producerFullById,{id:$})}getProducerById($){return this.getResource(D.producerById,{id:$})}getProducerExternal($){return this.getResource(D.producerExternal,{id:$})}getProducersSearch($){return this.getResource(D.producersSearch,{},$)}}class G extends H{getRandomAnime(){return this.getResource(Q.randomAnime)}getRandomManga(){return this.getResource(Q.randomManga)}getRandomCharacters(){return this.getResource(Q.randomCharacters)}getRandomPerson(){return this.getResource(Q.randomPeople)}}class w extends H{getRecentAnimeRecommendations($){return this.getResource(S.recentAnimeRecommendations,{},$)}getRecentMangaRecommendations($){return this.getResource(S.recentMangaRecommendations,{},$)}}class A extends H{getRecentAnimeReviews($){return this.getResource(v.animeReviews,{},$)}getRecentMangaReviews($){return this.getResource(v.mangaReviews,{},$)}}class u extends H{getSchedules($){return this.getResource(o.schedules,{},$)}}class M extends H{getSeason($,x,I){return this.getResource(V.season,{year:$,season:x},I)}getSeasonNow($){return this.getResource(V.seasonNow,{},$)}getSeasonsList(){return this.getResource(V.seasonsList)}getSeasonUpcoming($){return this.getResource(V.seasonUpcoming,{},$)}}class b extends H{getTopAnime($){return this.getResource(k.topAnime,{},$)}getTopManga($){return this.getResource(k.topManga,{},$)}getTopCharacters($){return this.getResource(k.topCharacters,{},$)}getTopPeople($){return this.getResource(k.topPeople,{},$)}getTopReviews($){return this.getResource(k.topReviews,{},$)}}class O extends H{getWatchRecentEpisodes(){return this.getResource(X.watchRecentEpisodes)}getWatchPopularEpisodes(){return this.getResource(X.watchPopularEpisodes)}getWatchRecentPromos($={}){return this.getResource(X.watchRecentPromos,{},$)}getWatchPopularPromos(){return this.getResource(X.watchPopularPromos)}}class d{anime;characters;clubs;genres;magazines;manga;people;producers;top;schedules;seasons;random;recommendations;reviews;watch;constructor($={}){let{api:x,cache:I}=Y({enableLogging:$.enableLogging,cacheOptions:$.cacheOptions,kyInstance:$.kyInstance}),q={...$,kyInstance:x,_cache:I};this.anime=new _(q),this.characters=new f(q),this.clubs=new y(q),this.genres=new J(q),this.magazines=new z(q),this.manga=new W(q),this.people=new B(q),this.producers=new T(q),this.top=new b(q),this.schedules=new u(q),this.seasons=new M(q),this.random=new G(q),this.recommendations=new w(q),this.reviews=new A(q),this.watch=new O(q)}}export{E as a,h as b,m as c,H as d,_ as e,f,y as g,J as h,z as i,W as j,B as k,T as l,G as m,w as n,A as o,u as p,M as q,b as r,O as s,d as t};

package/dist/chunk-ygw2424n.js

@@ -0,0 +1 @@
+var e="https://api.jikan.moe/v4";var n={animeFullById:"/anime/{id}/full",animeById:"/anime/{id}",animeCharacters:"/anime/{id}/characters",animeStaff:"/anime/{id}/staff",animeEpisodes:"/anime/{id}/episodes",animeEpisodeById:"/anime/{id}/episodes/{episode}",animeNews:"/anime/{id}/news",animeForum:"/anime/{id}/forum",animeVideos:"/anime/{id}/videos",animeVideosEpisodes:"/anime/{id}/videos/episodes",animePictures:"/anime/{id}/pictures",animeStatistics:"/anime/{id}/statistics",animeMoreInfo:"/anime/{id}/moreinfo",animeRecommendations:"/anime/{id}/recommendations",animeUserUpdates:"/anime/{id}/userupdates",animeReviews:"/anime/{id}/reviews",animeRelations:"/anime/{id}/relations",animeThemes:"/anime/{id}/themes",animeExternal:"/anime/{id}/external",animeStreaming:"/anime/{id}/streaming",animeSearch:"/anime"};var a={characterFullById:"/characters/{id}/full",characterById:"/characters/{id}",characterAnime:"/characters/{id}/anime",charactersManga:"/characters/{id}/manga",characterVoiceActors:"/characters/{id}/voices",characterPictures:"/characters/{id}/pictures",characterSearch:"/characters"};var o={clubById:"/clubs/{id}",clubMembers:"/clubs/{id}/members",clubStaff:"/clubs/{id}/staff",clubRelations:"/clubs/{id}/relations",clubSearch:"/clubs"};var m={animeGenres:"/genres/anime",mangaGenres:"/genres/manga"};var l={magazines:"/magazines"};var u={mangaSearch:"/manga",mangaFullById:"/manga/{id}/full",mangaById:"/manga/{id}",mangaCharacters:"/manga/{id}/characters",mangaNews:"/manga/{id}/news",mangaTopics:"/manga/{id}/forum",mangaPictures:"/manga/{id}/pictures",mangaStatistics:"/manga/{id}/statistics",mangaMoreInfo:"/manga/{id}/moreinfo",mangaRelations:"/manga/{id}/relations",mangaExternal:"/manga/{id}/external",mangaRecommendations:"/manga/{id}/recommendations",mangaUserUpdates:"/manga/{id}/userupdates",mangaReviews:"/manga/{id}/reviews"};var d={personFullById:"/people/{id}/full",personById:"/people/{id}",personAnime:"/people/{id}/anime",personVoices:"/people/{id}/voices",personManga:"/people/{id}/manga",personPictures:"/people/{id}/pictures",peopleSearch:"/people"};var x={producerFullById:"/producers/{id}/full",producerById:"/producers/{id}",producerExternal:"/producers/{id}/external",producersSearch:"/producers"};var h={randomAnime:"/random/anime",randomManga:"/random/manga",randomCharacters:"/random/characters",randomPeople:"/random/people",randomUsers:"/random/users"};var R={recentAnimeRecommendations:"/recommendations/anime",recentMangaRecommendations:"/recommendations/manga"};var _={animeReviews:"/reviews/anime",mangaReviews:"/reviews/manga"};var C={schedules:"/schedules"};var v={season:"/seasons/{year}/{season}",seasonNow:"/seasons/now",seasonsList:"/seasons",seasonUpcoming:"/seasons/upcoming"};var A={topAnime:"/top/anime",topManga:"/top/manga",topCharacters:"/top/characters",topPeople:"/top/people",topReviews:"/top/reviews"};var w={watchRecentEpisodes:"/watch/episodes",watchPopularEpisodes:"/watch/episodes/popular",watchRecentPromos:"/watch/promos",watchPopularPromos:"/watch/promos/popular"};export{n as u,e as v,a as w,o as x,m as y,l as z,u as A,d as B,x as C,h as D,R as E,_ as F,C as G,v as H,A as I,w as J};

package/dist/client.d.ts

@@ -0,0 +1,19 @@
+export * from './clients/anime.client';
+export * from './clients/base.client';
+export * from './clients/characters.client';
+export * from './clients/clubs.client';
+export * from './clients/genres.client';
+export * from './clients/jikan.client';
+export * from './clients/magazines.client';
+export * from './clients/manga.client';
+export * from './clients/people.client';
+export * from './clients/producers.client';
+export * from './clients/random.client';
+export * from './clients/recommendations.client';
+export * from './clients/reviews.client';
+export * from './clients/schedules.client';
+export * from './clients/seasons.client';
+export * from './clients/top.client';
+export * from './clients/watch.client';
+export * from './config/logging.config';
+export * from './types';

package/dist/client.js

@@ -0,0 +1 @@
+import{a as c,b as d,c as e,d as f,e as g,f as i,g as k,h as m,i as o,j as q,k as s,l as u,m as w,n as y,o as A,p as C,q as E,r as G,s as I,t as J}from"./chunk-b9f01kcn.js";import{A as p,B as r,C as t,D as v,E as x,F as z,G as B,H as D,I as F,J as H,u as a,v as b,w as h,x as j,y as l,z as n}from"./chunk-ygw2424n.js";export{c as loggingBeforeRequest,e as loggingBeforeError,d as loggingAfterResponse,H as WatchEndpoints,I as WatchClient,F as TopEndpoints,G as TopClient,D as SeasonsEndpoints,E as SeasonsClient,B as SchedulesEndpoints,C as SchedulesClient,z as ReviewsEndpoints,A as ReviewsClient,x as RecommendationsEndpoints,y as RecommendationsClient,v as RandomEndpoints,w as RandomClient,t as ProducersEndpoints,u as ProducersClient,r as PeopleEndpoints,s as PeopleClient,p as MangaEndpoints,q as MangaClient,n as MagazinesEndpoints,o as MagazinesClient,J as JikanClient,l as GenresEndpoints,m as GenresClient,j as ClubsEndpoints,k as ClubsClient,h as CharactersEndpoints,i as CharactersClient,f as BaseClient,b as BASE_URL,a as AnimeEndpoints,g as AnimeClient};

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

@@ -0,0 +1,123 @@
+import type { Anime, AnimeCharacter, AnimeEpisode, AnimeEpisodeVideo, AnimePicture, AnimeReview, AnimeSearchParams, AnimeStaff, AnimeStatistics, AnimeTheme, AnimeUserUpdate, AnimeVideos, ForumFilter, JikanExternalLink, JikanForum, JikanMoreInfo, JikanNews, JikanRelation, Recommendation, ReviewsParams } from '../models';
+import { BaseClient } from './base.client';
+/**
+ * **Anime Client**
+ *
+ * Client used to access the Anime Endpoints:
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class AnimeClient extends BaseClient {
+    /**
+     * Get complete anime resource data
+     * @param id anime id
+     */
+    getAnimeFullById(id: number): Promise<import("../models").JikanResponse<Anime>>;
+    /**
+     * Get anime resource
+     * @param id anime id
+     */
+    getAnimeById(id: number): Promise<import("../models").JikanResponse<Anime>>;
+    /**
+     * Get characters of a specific anime
+     * @param id anime id
+     */
+    getAnimeCharacters(id: number): Promise<import("../models").JikanResponse<AnimeCharacter[]>>;
+    /**
+     * Get staff of a specific Anime
+     * @param id anime id
+     */
+    getAnimeStaff(id: number): Promise<import("../models").JikanResponse<AnimeStaff[]>>;
+    /**
+     * Get a list of all the episodes of a specific anime
+     * @param id anime id
+     * @param page page number
+     */
+    getAnimeEpisodes(id: number, page?: number): Promise<import("../models").JikanResponse<AnimeEpisode[]>>;
+    /**
+     * Get a single episode of a specific anime by its id
+     * @param anime_id anime id
+     * @param episode_id episode id
+     */
+    getAnimeEpisodeById(anime_id: number, episode_id: number): Promise<import("../models").JikanResponse<AnimeEpisode>>;
+    /**
+     * Get a list of news articles related to the anime
+     * @param id anime id
+     * @param page page number
+     */
+    getAnimeNews(id: number, page: number): Promise<import("../models").JikanResponse<JikanNews[]>>;
+    /**
+     * Get a list of forum topics related to the anime
+     * @param id anime id
+     * @param filter filter topics
+     */
+    getAnimeForum(id: number, filter?: ForumFilter): Promise<import("../models").JikanResponse<JikanForum[]>>;
+    /**
+     * Get videos related to the anime
+     * @param id anime id
+     */
+    getAnimeVideos(id: number): Promise<import("../models").JikanResponse<AnimeVideos>>;
+    /**
+     * Get episode videos related to the anime
+     * @param id anime id
+     * @param page page number
+     */
+    getAnimeEpisodeVideos(id: number, page?: number): Promise<import("../models").JikanResponse<AnimeEpisodeVideo[]>>;
+    /**
+     * Get pictures related to the Anime
+     * @param id anime id
+     */
+    getAnimePictures(id: number): Promise<import("../models").JikanResponse<AnimePicture[]>>;
+    /**
+     * Get statistics related to the Anime
+     * @param id anime id
+     */
+    getAnimeStatistics(id: number): Promise<import("../models").JikanResponse<AnimeStatistics>>;
+    /**
+     * Get more info related to the anime
+     * @param id anime id
+     */
+    getAnimeMoreInfo(id: number): Promise<import("../models").JikanResponse<JikanMoreInfo>>;
+    /**
+     * Get recommendations based on the anime
+     * @param id anime id
+     */
+    getAnimeRecommendations(id: number): Promise<import("../models").JikanResponse<Recommendation[]>>;
+    /**
+     * Get anime relations
+     * @param id anime id
+     */
+    getAnimeRelations(id: number): Promise<import("../models").JikanResponse<JikanRelation[]>>;
+    /**
+     * Get anime external links
+     * @param id anime id
+     */
+    getAnimeExternal(id: number): Promise<import("../models").JikanResponse<JikanExternalLink[]>>;
+    /**
+     * Get anime streaming links
+     * @param id anime id
+     */
+    getAnimeStreaming(id: number): Promise<import("../models").JikanResponse<JikanExternalLink[]>>;
+    /**
+     * Get anime themes (openings and endings)
+     * @param id anime id
+     */
+    getAnimeThemes(id: number): Promise<import("../models").JikanResponse<AnimeTheme>>;
+    /**
+     * Get user updates for the anime
+     * @param id anime id
+     * @param page page number
+     */
+    getAnimeUserUpdates(id: number, page?: number): Promise<import("../models").JikanResponse<AnimeUserUpdate[]>>;
+    /**
+     * Get reviews for the anime
+     * @param id anime id
+     * @param params review parameters
+     */
+    getAnimeReviews(id: number, params?: Partial<ReviewsParams>): Promise<import("../models").JikanResponse<AnimeReview[]>>;
+    /**
+     * Get all the Animes within the given filter. Returns all the Animes if no filters are given.
+     * @param searchParams Filter parameters
+     */
+    getAnimeSearch(searchParams?: Partial<AnimeSearchParams>): Promise<import("../models").JikanResponse<Anime[]>>;
+}

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

@@ -0,0 +1,45 @@
+import type { KyInstance } from 'ky';
+import type { CacheOptions, ResponseCache } from '../config/cache';
+import type { JikanResponse } from '../models';
+/**
+ * **Client Args**
+ *
+ * Used to pass optional configuration for logging and cache to the clients.
+ */
+export interface ClientArgs {
+    /**
+     * **EnableLogging**
+     * Enables logging request responses.
+     */
+    enableLogging: boolean;
+    /**
+     * **Cache Options**
+     * Options for cache.
+     */
+    cacheOptions: Partial<CacheOptions>;
+    /**
+     * **Ky Instance**
+     * The ability to build your own ky instance if you need it
+     */
+    kyInstance?: KyInstance;
+    /** @internal Used to share cache between JikanClient sub-clients */
+    _cache?: ResponseCache;
+}
+/**
+ * **Base Client**
+ *
+ * This client is responsible for creating a Ky Instance and the cache and logging configurations
+ */
+export declare abstract class BaseClient {
+    private api;
+    private cache;
+    constructor(clientOptions?: Partial<ClientArgs>);
+    protected getResource<T>(endpoint: string, pathParams?: {
+        [key in string]: unknown;
+    }, params?: {
+        [key in string]: unknown;
+    }): Promise<JikanResponse<T>>;
+    private buildCacheKey;
+    private cleanParams;
+    private replacePathParams;
+}

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

@@ -0,0 +1,46 @@
+import type { Character, CharacterAnime, CharacterFull, CharacterManga, CharactersSearchParams, CharacterVoiceActor, JikanImagesCollection } from '../models';
+import { BaseClient } from './base.client';
+/**
+ * **Characters Client**
+ *
+ * Client used to access the Character Endpoints:
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class CharactersClient extends BaseClient {
+    /**
+     * Get complete Character data
+     * @param id The Character ID
+     */
+    getCharacterFullById(id: number): Promise<import("../models").JikanResponse<CharacterFull>>;
+    /**
+     * Get Character data
+     * @param id The Character ID
+     */
+    getCharacterById(id: number): Promise<import("../models").JikanResponse<Character>>;
+    /**
+     * Get Character anime data
+     * @param id The Character ID
+     */
+    getCharacterAnime(id: number): Promise<import("../models").JikanResponse<CharacterAnime[]>>;
+    /**
+     * Get Character manga data
+     * @param id The Character ID
+     */
+    getCharacterManga(id: number): Promise<import("../models").JikanResponse<CharacterManga[]>>;
+    /**
+     * Get Character voices data
+     * @param id The Character ID
+     */
+    getCharacterVoiceActors(id: number): Promise<import("../models").JikanResponse<CharacterVoiceActor[]>>;
+    /**
+     * Get Character pictures data
+     * @param id The Character ID
+     */
+    getCharacterPictures(id: number): Promise<import("../models").JikanResponse<JikanImagesCollection[]>>;
+    /**
+     * Get all the Characters within the given filter. Returns all Characters if no filters are given.
+     * @param searchParams Filter parameters
+     */
+    getCharacterSearch(searchParams: Partial<CharactersSearchParams>): Promise<import("../models").JikanResponse<Character[]>>;
+}

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

@@ -0,0 +1,39 @@
+import type { PaginationParams } from '../models';
+import type { ClubSearchParams } from '../models/clubs/clubs-params.model';
+import type { Club, ClubMember, ClubRelations, ClubStaff } from '../models/clubs/clubs.model';
+import { BaseClient } from './base.client';
+/**
+ * **Club Client**
+ *
+ * Client used to access the Club Endpoints.
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class ClubsClient extends BaseClient {
+    /**
+     * @returns Club resource
+     * @param id Club ID
+     */
+    getClubsById(id: number): Promise<import("../models").JikanResponse<Club>>;
+    /**
+     * @returns Club members resource
+     * @param id Club ID
+     * @param params
+     */
+    getClubMembers(id: number, params?: Partial<PaginationParams>): Promise<import("../models").JikanResponse<ClubMember[]>>;
+    /**
+     * @returns Club staff
+     * @param id Club ID
+     */
+    getClubStaff(id: number): Promise<import("../models").JikanResponse<ClubStaff[]>>;
+    /**
+     * @returns Club relations
+     * @param id Club ID
+     */
+    getClubRelations(id: number): Promise<import("../models").JikanResponse<ClubRelations>>;
+    /**
+     * @returns Search results for Clubs
+     * @param params
+     */
+    getClubSearch(params?: Partial<ClubSearchParams>): Promise<import("../models").JikanResponse<Club[]>>;
+}

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

@@ -0,0 +1,21 @@
+import type { Genre, GenresFilter } from '../models';
+import { BaseClient } from './base.client';
+/**
+ * **Genres Client**
+ *
+ * Client used to access the Genres Endpoints:
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class GenresClient extends BaseClient {
+    /**
+     * Get Anime genres
+     * @param filter Type of the desired genres
+     */
+    getAnimeGenres(filter?: GenresFilter): Promise<import("../models").JikanResponse<Genre[]>>;
+    /**
+     * Get Manga genres
+     * @param filter Type of the desired genres
+     */
+    getMangaGenres(filter?: GenresFilter): Promise<import("../models").JikanResponse<Genre[]>>;
+}

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

@@ -0,0 +1,41 @@
+import type { ClientArgs } from './base.client';
+import { AnimeClient } from './anime.client';
+import { CharactersClient } from './characters.client';
+import { ClubsClient } from './clubs.client';
+import { GenresClient } from './genres.client';
+import { MagazinesClient } from './magazines.client';
+import { MangaClient } from './manga.client';
+import { PeopleClient } from './people.client';
+import { ProducersClient } from './producers.client';
+import { RandomClient } from './random.client';
+import { RecommendationsClient } from './recommendations.client';
+import { ReviewsClient } from './reviews.client';
+import { SchedulesClient } from './schedules.client';
+import { SeasonsClient } from './seasons.client';
+import { TopClient } from './top.client';
+import { WatchClient } from './watch.client';
+/**
+ * **Jikan Client**
+ *
+ * The main client used to access all the Jikan Endpoints:
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class JikanClient {
+    anime: AnimeClient;
+    characters: CharactersClient;
+    clubs: ClubsClient;
+    genres: GenresClient;
+    magazines: MagazinesClient;
+    manga: MangaClient;
+    people: PeopleClient;
+    producers: ProducersClient;
+    top: TopClient;
+    schedules: SchedulesClient;
+    seasons: SeasonsClient;
+    random: RandomClient;
+    recommendations: RecommendationsClient;
+    reviews: ReviewsClient;
+    watch: WatchClient;
+    constructor(clientOptions?: Partial<ClientArgs>);
+}

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

@@ -0,0 +1,9 @@
+import type { Magazine, MagazineSearchParams } from '../models/magazine/magazine.model';
+import { BaseClient } from './base.client';
+export declare class MagazinesClient extends BaseClient {
+    /**
+     * @returns Magazines collection
+     * @param params
+     */
+    getMagazines(params?: Partial<MagazineSearchParams>): Promise<import("..").JikanResponse<Magazine[]>>;
+}

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

@@ -0,0 +1,84 @@
+import type { CommonCharacter, ForumFilter, JikanExternalLink, JikanForum, JikanImages, JikanMoreInfo, JikanNews, JikanRelation, Manga, MangaReview, MangaSearchParams, MangaStatistics, MangaUserUpdate, Recommendation, ReviewsParams } from '../models';
+import { BaseClient } from './base.client';
+/**
+ * **Manga Client**
+ *
+ * Client used to access the Manga Endpoints:
+ *
+ * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
+ */
+export declare class MangaClient extends BaseClient {
+    /**
+     * Get a Manga with full information by its ID
+     * @param id The Manga ID
+     */
+    getMangaFullById(id: number): Promise<import("../models").JikanResponse<Manga>>;
+    /**
+     * Get a Manga by its ID
+     * @param id The Manga ID
+     */
+    getMangaById(id: number): Promise<import("../models").JikanResponse<Manga>>;
+    /**
+     * Get Characters of a specific Manga
+     * @param id The Manga ID
+     */
+    getMangaCharacters(id: number): Promise<import("../models").JikanResponse<CommonCharacter[]>>;
+    /**
+     * Get a list of manga news
+     * @param id The Manga ID
+     */
+    getMangaNews(id: number): Promise<import("../models").JikanResponse<JikanNews[]>>;
+    /**
+     * Get a list og manga forum topics
+     * @param id The manga ID
+     * @param filter Filter topics
+     */
+    getMangaTopics(id: number, filter?: ForumFilter): Promise<import("../models").JikanResponse<JikanForum[]>>;
+    /**
+     * Get Pictures related to a specific Manga
+     * @param id The Manga ID
+     */
+    getMangaPictures(id: number): Promise<import("../models").JikanResponse<JikanImages[]>>;
+    /**
+     * Get Statistics related to a specific Manga
+     * @param id The Manga ID
+     */
+    getMangaStatistics(id: number): Promise<import("../models").JikanResponse<MangaStatistics>>;
+    /**
+     * Get more info related to the manga
+     * @param id manga id
+     */
+    getMangaMoreInfo(id: number): Promise<import("../models").JikanResponse<JikanMoreInfo>>;
+    /**
+     * Get Recommendations related to a specific Manga
+     * @param id The Manga ID
+     */
+    getMangaRecommendations(id: number): Promise<import("../models").JikanResponse<Recommendation[]>>;
+    /**
+     * Get anime Relations
+     * @param id manga id
+     */
+    getMangaRelations(id: number): Promise<import("../models").JikanResponse<JikanRelation[]>>;
+    /**
+     * Get manga external links
+     * @param id manga id
+     */
+    getMangaExternal(id: number): Promise<import("../models").JikanResponse<JikanExternalLink[]>>;
+    /**
+     * Get user updates for the manga
+     * @param id manga id
+     * @param page page number
+     */
+    getMangaUserUpdates(id: number, page?: number): Promise<import("../models").JikanResponse<MangaUserUpdate[]>>;
+    /**
+     * Get reviews for the manga
+     * @param id manga id
+     * @param params review parameters
+     */
+    getMangaReviews(id: number, params?: Partial<ReviewsParams>): Promise<import("../models").JikanResponse<MangaReview[]>>;
+    /**
+     * Get all the filtered Mangas. Returns all the Mangas if no filters are given.
+     * @param searchParams Filter parameters
+     */
+    getMangaSearch(searchParams?: Partial<MangaSearchParams>): Promise<import("../models").JikanResponse<Manga[]>>;
+}