@tutkli/jikan-ts 1.0.1 → 1.2.0

package/.githooks/pre-commit

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+npx lint-staged --concurrent false --relative

package/.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+  "*.{js,ts,css,scss,html,json,md}": "prettier --write"
+}

package/README.md

@@ -2,7 +2,6 @@
 
 ![jikan-ts-890w](https://user-images.githubusercontent.com/49206247/207465731-9908e843-7c8d-4e05-838b-41bcd8c677f8.png)
 
-
 ![Language Shield](https://img.shields.io/badge/language-typescript-blue?style=for-the-badge)
 ![License Shield](https://img.shields.io/badge/license-mit-blueviolet?style=for-the-badge)
 ![Build Shield](https://img.shields.io/badge/build-passing-brightgreen?style=for-the-badge)
@@ -18,8 +17,6 @@
 - 📄 Logging
 - 📦 ESM with tree shaking support
 
-#### 📖 Check out the [documentation page](https://tutkli.github.io/jikan-ts/)!
-
 ## Installation
 
 ```bash
@@ -39,8 +36,10 @@ const animeClient = new AnimeClient();
 
 animeClient
   .getAnimeById(1)
-  .then((jikanResponse: JikanResponse<Anime>) => { /* ... */ })
-  .catch((error) => console.error(error));
+  .then((jikanResponse: JikanResponse<Anime>) => {
+    /* ... */
+  })
+  .catch(error => console.error(error));
 ```
 
 Or, using the **JikanClient**:
@@ -52,8 +51,10 @@ const jikanClient = new JikanClient();
 
 jikanClient.anime
   .getAnimeById(1)
-  .then((jikanResponse: JikanResponse<Anime>) => { /* ... */ })
-  .catch((error) => console.error(error));
+  .then((jikanResponse: JikanResponse<Anime>) => {
+    /* ... */
+  })
+  .catch(error => console.error(error));
 ```
 
 ## Client configuration
@@ -66,7 +67,7 @@ To use a specific configuration, pass the `cacheOptions` argument when instantia
 ```ts
 import { AnimeClient } from '@tutkli/jikan-ts';
 
-const animeClient = new AnimeClient({ 
+const animeClient = new AnimeClient({
     cacheOptions: { ... } // axios-cache-interceptor options
   }
 );
@@ -81,10 +82,9 @@ To enable logging, pass the `enableLogging` argument as `true`.
 ```ts
 import { AnimeClient } from '@tutkli/jikan-ts';
 
-const animeClient = new AnimeClient({ 
-    enableLogging: true,
-  }
-);
+const animeClient = new AnimeClient({
+  enableLogging: true,
+});
 ```
 
 ## Available Clients
@@ -103,4 +103,3 @@ const animeClient = new AnimeClient({
 - 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)
 - Want to contribute? [Submit a PR 📑](https://github.com/tutkli/jikan-ts/pulls)
-

package/dist/index.d.ts

@@ -1,81 +1,8 @@
-// Generated by dts-bundle-generator v8.0.1
-
-/// <reference types="node" />
+// Generated by dts-bundle-generator v9.3.1
 
 import { AxiosError } from 'axios';
-import { AxiosCacheInstance, CacheAxiosResponse, CacheOptions, CacheRequestConfig } from 'axios-cache-interceptor';
+import { CacheAxiosResponse, CacheOptions, InternalCacheRequestConfig } from 'axios-cache-interceptor';
 
-/**
- * **Client Args**
- *
- * Used to pass optional configuration for logging and cache to the clients.
- */
-export interface ClientArgs {
-	/**
-	 * **EnableLogging**
-	 * Enables logging request responses.
-	 */
-	enableLogging: boolean;
-	/**
-	 * **Axios Cache Options**
-	 * Options for cache.
-	 * @see https://axios-cache-interceptor.js.org/#/pages/configuration
-	 */
-	cacheOptions: Partial<CacheOptions>;
-	/**
-	 * **Base URL**
-	 * Location of the JikanAPI. Leave empty to use the official JikanAPI instance.
-	 */
-	baseURL: string;
-}
-/**
- * **Base Client**
- *
- * This client is responsible for creating an Axios Instance and the cache and logging configurations
- */
-export declare abstract class BaseClient {
-	api: AxiosCacheInstance;
-	constructor(clientOptions?: Partial<ClientArgs>);
-	protected replacePathParams(path: string, params: {
-		[key in string]: unknown;
-	}): string;
-	private addLoggingInterceptors;
-}
-export interface JikanResource {
-	mal_id: number;
-	type: string;
-	name: string;
-	url: string;
-}
-export interface JikanNamedResource {
-	name: string;
-	url: string;
-}
-export interface JikanResourceTitle {
-	type: string;
-	title: string;
-}
-export interface JikanResourcePeriod {
-	from: string;
-	to: string;
-	prop: {
-		form: {
-			day: number;
-			month: number;
-			year: number;
-		};
-		to: {
-			day: number;
-			month: number;
-			year: number;
-		};
-		string: string;
-	};
-}
-export interface JikanResourceRelation {
-	relation: string;
-	entry: JikanResource[];
-}
 export interface JikanImages {
 	jpg: JikanImagesCollection;
 	webp?: JikanImagesCollection;
@@ -112,6 +39,21 @@ export declare enum CharacterRole {
 	main = "Main",
 	supporting = "Supporting"
 }
+export interface JikanMoreInfo {
+	moreinfo: string;
+}
+export interface JikanNews {
+	mal_id: number;
+	url: string;
+	title: string;
+	date: string;
+	author_username: string;
+	author_url: string;
+	forum_url: string;
+	images: JikanImages;
+	comments: number;
+	excerpt: string;
+}
 export interface Recommendation {
 	entry: RecommendationEntry;
 }
@@ -121,6 +63,55 @@ export interface RecommendationEntry {
 	images: JikanImages;
 	title: string;
 }
+export interface JikanRelation {
+	relation: string;
+	entry: RelationEntry[];
+}
+export interface RelationEntry {
+	mal_id: number;
+	type: string;
+	name: string;
+	url: string;
+}
+export interface JikanResource {
+	mal_id: number;
+	type: string;
+	name: string;
+	url: string;
+}
+export interface JikanNamedResource {
+	name: string;
+	url: string;
+}
+export interface JikanResourceTitle {
+	type: string;
+	title: string;
+}
+export interface JikanResourcePeriod {
+	from: string;
+	to: string;
+	prop: {
+		form: {
+			day: number;
+			month: number;
+			year: number;
+		};
+		to: {
+			day: number;
+			month: number;
+			year: number;
+		};
+		string: string;
+	};
+}
+export interface JikanResourceRelation {
+	relation: string;
+	entry: JikanResource[];
+}
+export interface SeasonsListData {
+	year: number;
+	seasons: Array<keyof typeof AnimeSeason>;
+}
 export interface Statistics {
 	completed: number;
 	on_hold: number;
@@ -133,9 +124,47 @@ export interface StatisticsScore {
 	votes: number;
 	percentage: number;
 }
-export interface SeasonsListData {
-	year: number;
-	seasons: Array<keyof typeof AnimeSeason>;
+export interface AnimeCharacter extends CommonCharacter {
+	voice_actors: CharacterVoiceActor[];
+}
+export interface AnimeEpisode {
+	mal_id: number;
+	url: string;
+	title: string;
+	title_japanese: string;
+	title_romanji: string;
+	duration: number;
+	aired: string;
+	filler: boolean;
+	recap: boolean;
+	forum_url: string;
+}
+export interface AnimeForum {
+	mal_id: number;
+	url: string;
+	title: string;
+	date: string;
+	author_username: string;
+	author_url: string;
+	comments: number;
+	last_comment: {
+		url: string;
+		author_username: string;
+		author_url: string;
+		date: string;
+	};
+}
+export type AnimeForumFilter = "all" | "episode" | "other";
+export interface AnimePicture {
+	images: JikanImages;
+}
+export interface AnimeStaff {
+	person: JikanPerson;
+	positions: string[];
+}
+export interface AnimeStatistics extends Statistics {
+	watching: number;
+	plan_to_watch: number;
 }
 export interface AnimeVideos {
 	promo: AnimePromoVideo[];
@@ -248,31 +277,38 @@ export declare enum AnimeSeason {
 	fall = "fall",
 	winter = "winter"
 }
-export interface AnimeCharacter extends CommonCharacter {
-	voice_actors: CharacterVoiceActor[];
-}
-export interface AnimeStaff {
-	person: JikanPerson;
-	positions: string[];
-}
-export interface AnimeEpisode {
+export interface Character {
 	mal_id: number;
 	url: string;
-	title: string;
-	title_japanese: string;
-	title_romanji: string;
-	duration: number;
-	aired: string;
-	filler: boolean;
-	recap: boolean;
-	forum_url: string;
-}
-export interface AnimePicture {
 	images: JikanImages;
+	name: string;
+	name_kanji: string;
+	nicknames: string[];
+	favorites: number;
+	about: string;
+	anime: CharacterAnime[];
+	manga: CharacterManga[];
+	voices: CharacterVoiceActor[];
 }
-export interface AnimeStatistics extends Statistics {
-	watching: number;
-	plan_to_watch: number;
+export interface CharacterAnime {
+	role: CharacterRole;
+	anime: CommonCharacterData & {
+		title: string;
+	};
+}
+export interface CharacterManga {
+	role: CharacterRole;
+	manga: CommonCharacterData & {
+		title: string;
+	};
+}
+export interface Genre extends JikanNamedResource {
+	mal_id: number;
+	count: number;
+}
+export interface MangaStatistics extends Statistics {
+	reading: number;
+	plan_to_read: number;
 }
 export interface Manga {
 	mal_id: number;
@@ -322,24 +358,6 @@ export declare enum MangaStatus {
 	discontinued = "Discontinued",
 	upcoming = "Upcoming"
 }
-export interface MangaStatistics extends Statistics {
-	reading: number;
-	plan_to_read: number;
-}
-export interface JikanPagination {
-	last_visible_page: number;
-	has_next_page: boolean;
-	items?: JikanPaginationItems;
-}
-export interface JikanPaginationItems {
-	count: number;
-	total: number;
-	per_page: number;
-}
-export interface JikanResponse<T> {
-	data: T;
-	pagination?: JikanPagination;
-}
 export declare enum SortOptions {
 	asc = "asc",
 	desc = "desc"
@@ -416,23 +434,69 @@ export interface AnimeSearchParams extends JikanSearchParams {
 	rating?: AnimeRating | string;
 	order_by?: AnimeSearchOrder | SearchOrder | string;
 }
-export declare enum TopAnimeFilter {
-	airing = "airing",
-	upcoming = "upcoming",
-	bypopularity = "bypopularity",
-	favorite = "favorite"
+export interface CharactersSearchParams {
+	page?: number;
+	limit?: number;
+	q?: string;
+	order_by?: CharactersSearchOrder;
+	sort?: SortOptions;
+	letter?: string;
 }
-export declare enum TopMangaFilter {
-	publishing = "publishing",
-	upcoming = "upcoming",
-	bypopularity = "bypopularity",
-	favorite = "favorite"
+export declare enum CharactersSearchOrder {
+	mal_id = "mal_id",
+	name = "name",
+	favorites = "favorites"
 }
-export interface JikanTopParams {
+export declare enum GenresFilter {
+	genres = "genres",
+	explicit_genres = "explicit_genres",
+	theme = "themes",
+	demographics = "demographics"
+}
+export interface SchedulesParams {
 	page?: number;
 	limit?: number;
+	filter?: SchedulesFilter;
+	kids?: boolean;
+	sfw?: boolean;
+	unapproved?: boolean;
 }
-/**
+export declare enum SchedulesFilter {
+	monday = "monday",
+	tuesday = "tuesday",
+	wednesday = "wednesday",
+	thursday = "thursday",
+	friday = "friday",
+	unknown = "unknown",
+	other = "other"
+}
+export interface JikanSeasonsParams {
+	page?: number;
+	limit?: number;
+	filter?: AnimeType;
+}
+/**
+ * QueryParams used in **getSeasonNow** call
+ *
+ */
+export type SeasonNowParams = Omit<JikanSeasonsParams, "filter">;
+export declare enum TopAnimeFilter {
+	airing = "airing",
+	upcoming = "upcoming",
+	bypopularity = "bypopularity",
+	favorite = "favorite"
+}
+export declare enum TopMangaFilter {
+	publishing = "publishing",
+	upcoming = "upcoming",
+	bypopularity = "bypopularity",
+	favorite = "favorite"
+}
+export interface JikanTopParams {
+	page?: number;
+	limit?: number;
+}
+/**
  * QueryParams used in **getTopAnime** call
  *
  * See also: [Jikan API Documentation](https://docs.api.jikan.moe/#tag/top/operation/getTopAnime)
@@ -450,80 +514,58 @@ export interface MangaTopParams extends JikanTopParams {
 	type?: MangaType;
 	filter?: TopMangaFilter;
 }
-export interface JikanSeasonsParams {
-	page?: number;
-	limit?: number;
-	filter?: AnimeType;
+export interface JikanPagination {
+	last_visible_page: number;
+	has_next_page: boolean;
+	items?: JikanPaginationItems;
+}
+export interface JikanPaginationItems {
+	count: number;
+	total: number;
+	per_page: number;
+}
+export interface JikanResponse<T> {
+	data: T;
+	pagination?: JikanPagination;
 }
 /**
- * QueryParams used in **getSeasonNow** call
+ * **Client Args**
  *
+ * Used to pass optional configuration for logging and cache to the clients.
  */
-export type SeasonNowParams = Omit<JikanSeasonsParams, "filter">;
-export declare enum GenresFilter {
-	genres = "genres",
-	explicit_genres = "explicit_genres",
-	theme = "themes",
-	demographics = "demographics"
-}
-export interface CharactersSearchParams {
-	page?: number;
-	limit?: number;
-	q?: string;
-	order_by?: CharactersSearchOrder;
-	sort?: SortOptions;
-	letter?: string;
-}
-export declare enum CharactersSearchOrder {
-	mal_id = "mal_id",
-	name = "name",
-	favorites = "favorites"
-}
-export interface SchedulesParams {
-	page?: number;
-	limit?: number;
-	filter?: SchedulesFilter;
-	kids?: boolean;
-	sfw?: boolean;
-	unapproved?: boolean;
-}
-export declare enum SchedulesFilter {
-	monday = "monday",
-	tuesday = "tuesday",
-	wednesday = "wednesday",
-	thursday = "thursday",
-	friday = "friday",
-	unknown = "unknown",
-	other = "other"
-}
-export interface Character {
-	mal_id: number;
-	url: string;
-	images: JikanImages;
-	name: string;
-	name_kanji: string;
-	nicknames: string[];
-	favorites: number;
-	about: string;
-	anime: CharacterAnime[];
-	manga: CharacterManga[];
-	voices: CharacterVoiceActor[];
-}
-export interface CharacterAnime {
-	role: CharacterRole;
-	anime: CommonCharacterData & {
-		title: string;
-	};
-}
-export interface CharacterManga {
-	role: CharacterRole;
-	manga: CommonCharacterData & {
-		title: string;
-	};
+export interface ClientArgs {
+	/**
+	 * **EnableLogging**
+	 * Enables logging request responses.
+	 */
+	enableLogging: boolean;
+	/**
+	 * **Axios Cache Options**
+	 * Options for cache.
+	 * @see https://axios-cache-interceptor.js.org/#/pages/configuration
+	 */
+	cacheOptions: Partial<CacheOptions>;
+	/**
+	 * **Base URL**
+	 * Location of the JikanAPI. Leave empty to use the official JikanAPI instance.
+	 */
+	baseURL: string;
 }
-export interface Genre extends JikanNamedResource {
-	mal_id: number;
-	count: number;
+/**
+ * **Base Client**
+ *
+ * This client is responsible for creating an Axios Instance and the cache and logging configurations
+ */
+export declare abstract class BaseClient {
+	private api;
+	constructor(clientOptions?: Partial<ClientArgs>);
+	protected getResource<T>(endpoint: string, pathParams?: {
+		[key in string]: unknown;
+	}, params?: {
+		[key in string]: unknown;
+	}): Promise<T>;
+	private replacePathParams;
+	private addLoggingInterceptors;
 }
 /**
  * **Anime Client**
@@ -534,80 +576,161 @@ export interface Genre extends JikanNamedResource {
  */
 export declare class AnimeClient extends BaseClient {
 	/**
-	 * Get all the Animes within the given filter. Returns all the Animes if no filters are given.
-	 * @param searchParams Filter parameters
-	 * @returns JikanResponse with Anime array data
+	 * Get complete anime resource data
+	 * @param id anime id
 	 */
-	getAnimeSearch(searchParams?: Partial<AnimeSearchParams>): Promise<JikanResponse<Anime[]>>;
+	getAnimeFullById(id: number): Promise<JikanResponse<Anime>>;
 	/**
-	 * Get a complete Anime resource data
-	 * @param mal_id The Anime ID
-	 * @returns JikanResponse with Anime data
+	 * Get anime resource
+	 * @param id anime id
 	 */
-	getAnimeFullById(mal_id: number): Promise<JikanResponse<Anime>>;
+	getAnimeById(id: number): Promise<JikanResponse<Anime>>;
 	/**
-	 * Get Anime resource data
-	 * @param mal_id The Anime ID
-	 * @returns JikanResponse with Anime data
+	 * Get characters of a specific anime
+	 * @param id anime id
 	 */
-	getAnimeById(mal_id: number): Promise<JikanResponse<Anime>>;
+	getAnimeCharacters(id: number): Promise<JikanResponse<AnimeCharacter[]>>;
 	/**
-	 * Get Characters of a specific Anime
-	 * @param mal_id The Anime ID
-	 * @returns JikanResponse with AnimeCharacter array data
+	 * Get staff of a specific Anime
+	 * @param id anime id
 	 */
-	getAnimeCharacters(mal_id: number): Promise<JikanResponse<AnimeCharacter[]>>;
+	getAnimeStaff(id: number): Promise<JikanResponse<AnimeStaff[]>>;
 	/**
-	 * Get Staff of a specific Anime
-	 * @param mal_id The Anime ID
-	 * @returns JikanResponse with AnimeStaff array data
+	 * Get a list of all the episodes of a specific anime
+	 * @param id anime id
+	 * @param page page number
 	 */
-	getAnimeStaff(mal_id: number): Promise<JikanResponse<AnimeStaff[]>>;
+	getAnimeEpisodes(id: number, page?: number): Promise<JikanResponse<AnimeEpisode[]>>;
 	/**
-	 * Get a list of all the episodes of a specific Anime
-	 * @param mal_id The Anime ID
-	 * @param page The page number
-	 * @returns JikanResponse with AnimeEpisode array data
+	 * Get a single episode of a specific anime by its id
+	 * @param anime_id anime id
+	 * @param episode_id episode id
 	 */
-	getAnimeEpisodes(mal_id: number, page?: number): Promise<JikanResponse<AnimeEpisode[]>>;
+	getAnimeEpisodeById(anime_id: number, episode_id: number): Promise<JikanResponse<AnimeEpisode>>;
 	/**
-	 * Get a single Episode of a specific Anime by its ID
-	 * @param anime_mal_id The Anime ID
-	 * @param episode_mal_id The Episode ID
-	 * @returns JikanResponse with AnimeEpisode data
+	 * Get a list of news articles related to the anime
+	 * @param id anime id
+	 * @param page page number
 	 */
-	getAnimeEpisodeById(anime_mal_id: number, episode_mal_id: number): Promise<JikanResponse<AnimeEpisode>>;
+	getAnimeNews(id: number, page: number): Promise<JikanResponse<JikanNews>>;
 	/**
-	 * Get Videos related to a specific Anime
-	 * @param mal_id The Anime ID
-	 * @returns JikanResponse with AnimeVideo data
+	 * Get a list of forum topics related to the anime
+	 * @param id anime id
+	 * @param filter forum filter
 	 */
-	getAnimeVideos(mal_id: number): Promise<JikanResponse<AnimeVideos>>;
+	getAnimeForum(id: number, filter: AnimeForumFilter): Promise<JikanResponse<AnimeForum[]>>;
 	/**
-	 * Get Episode Videos related to a specific Anime
-	 * @param mal_id The Anime ID
-	 * @param page The page number
-	 * @returns JikanResponse with AnimeVideoEpisode array data
+	 * Get videos related to the anime
+	 * @param id anime id
 	 */
-	getAnimeEpisodeVideos(mal_id: number, page?: number): Promise<JikanResponse<AnimeEpisodeVideo[]>>;
+	getAnimeVideos(id: number): Promise<JikanResponse<AnimeVideos>>;
 	/**
-	 * Get Pictures related to a specific Anime
-	 * @param mal_id The Anime ID
-	 * @returns JikanResponse with AnimePicture array data
+	 * Get episode videos related to the anime
+	 * @param id anime id
+	 * @param page page number
 	 */
-	getAnimePictures(mal_id: number): Promise<JikanResponse<AnimePicture[]>>;
+	getAnimeEpisodeVideos(id: number, page?: number): Promise<JikanResponse<AnimeEpisodeVideo[]>>;
 	/**
-	 * Get Statistics related to a specific Anime
-	 * @param mal_id The Anime ID
-	 * @returns JikanResponse with AnimeStatistics data
+	 * Get pictures related to the Anime
+	 * @param id anime id
 	 */
-	getAnimeStatistics(mal_id: number): Promise<JikanResponse<AnimeStatistics>>;
+	getAnimePictures(id: number): Promise<JikanResponse<AnimePicture[]>>;
 	/**
-	 * Get Recommendations related to a specific Anime
-	 * @param mal_id The Anime ID
-	 * @returns JikanResponse with Recommendation array data
+	 * Get statistics related to the Anime
+	 * @param id anime id
+	 */
+	getAnimeStatistics(id: number): Promise<JikanResponse<AnimeStatistics>>;
+	/**
+	 * Get more info related to the anime
+	 * @param id anime id
+	 */
+	getAnimeMoreInfo(id: number): Promise<JikanResponse<JikanMoreInfo>>;
+	/**
+	 * Get recommendations based on the anime
+	 * @param id anime id
+	 */
+	getAnimeRecommendations(id: number): Promise<JikanResponse<Recommendation[]>>;
+	/**
+	 * Get anime relations
+	 * @param id anime id
+	 */
+	getAnimeRelations(id: number): Promise<JikanResponse<JikanRelation[]>>;
+	/**
+	 * Get all the Animes within the given filter. Returns all the Animes if no filters are given.
+	 * @param searchParams Filter parameters
+	 * @returns JikanResponse with Anime array data
+	 */
+	getAnimeSearch(searchParams?: Partial<AnimeSearchParams>): Promise<JikanResponse<Anime[]>>;
+}
+/**
+ * **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
+	 * @returns JikanResponse with Character data
+	 */
+	getCharacterFullById(id: number): Promise<JikanResponse<Character>>;
+	/**
+	 * Get Character data
+	 * @param id The Character ID
+	 * @returns JikanResponse with Character data
+	 */
+	getCharacterById(id: number): Promise<JikanResponse<Character>>;
+	/**
+	 * Get Character anime data
+	 * @param id The Character ID
+	 * @returns JikanResponse with CharacterAnime data
+	 */
+	getCharacterAnime(id: number): Promise<JikanResponse<CharacterAnime[]>>;
+	/**
+	 * Get Character manga data
+	 * @param id The Character ID
+	 * @returns JikanResponse with CharacterManga data
+	 */
+	getCharacterManga(id: number): Promise<JikanResponse<CharacterManga[]>>;
+	/**
+	 * Get Character voices data
+	 * @param id The Character ID
+	 * @returns JikanResponse with CharacterVoiceActor data
+	 */
+	getCharacterVoiceActors(id: number): Promise<JikanResponse<CharacterVoiceActor[]>>;
+	/**
+	 * Get Character pictures data
+	 * @param id The Character ID
+	 * @returns JikanResponse with JikanImagesCollection data
+	 */
+	getCharacterPictures(id: number): Promise<JikanResponse<JikanImagesCollection[]>>;
+	/**
+	 * Get all the Characters within the given filter. Returns all Characters if no filters are given.
+	 @param searchParams Filter parameters
+	 * @returns JikanResponse with Character array data
+	 */
+	getCharacterSearch(searchParams: Partial<CharactersSearchParams>): Promise<JikanResponse<Character[]>>;
+}
+/**
+ * **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<JikanResponse<Genre[]>>;
+	/**
+	 * Get Manga genres
+	 * @param filter Type of the desired genres
 	 */
-	getAnimeRecommendations(mal_id: number): Promise<JikanResponse<Recommendation[]>>;
+	getMangaGenres(filter?: GenresFilter): Promise<JikanResponse<Genre[]>>;
 }
 /**
  * **Manga Client**
@@ -617,69 +740,63 @@ export declare class AnimeClient extends BaseClient {
  * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
  */
 export declare class MangaClient extends BaseClient {
-	/**
-	 * Get all the filtered Mangas. Returns all the Mangas if no filters are given.
-	 * @param searchParams Filter parameters
-	 * @returns JikanResponse with Manga array data
-	 */
-	getMangaSearch(searchParams?: Partial<MangaSearchParams>): Promise<JikanResponse<Manga[]>>;
 	/**
 	 * Get a Manga with full information by its ID
-	 * @param mal_id The Manga ID
+	 * @param id The Manga ID
 	 * @returns JikanResponse with Manga data
 	 */
-	getMangaFullById(mal_id: number): Promise<JikanResponse<Manga>>;
+	getMangaFullById(id: number): Promise<JikanResponse<Manga>>;
 	/**
 	 * Get a Manga by its ID
-	 * @param mal_id The Manga ID
+	 * @param id The Manga ID
 	 * @returns JikanResponse with Manga data
 	 */
-	getMangaById(mal_id: number): Promise<JikanResponse<Manga>>;
+	getMangaById(id: number): Promise<JikanResponse<Manga>>;
 	/**
 	 * Get Characters of a specific Manga
-	 * @param mal_id The Manga ID
+	 * @param id The Manga ID
 	 * @returns JikanResponse with CommonCharacter array data
 	 */
-	getMangaCharacters(mal_id: number): Promise<JikanResponse<CommonCharacter[]>>;
+	getMangaCharacters(id: number): Promise<JikanResponse<CommonCharacter[]>>;
 	/**
 	 * Get Pictures related to a specific Manga
-	 * @param mal_id The Manga ID
+	 * @param id The Manga ID
 	 * @returns JikanResponse with JikanImages array data
 	 */
-	getMangaPictures(mal_id: number): Promise<JikanResponse<JikanImages[]>>;
+	getMangaPictures(id: number): Promise<JikanResponse<JikanImages[]>>;
 	/**
 	 * Get Statistics related to a specific Manga
-	 * @param mal_id The Manga ID
+	 * @param id The Manga ID
 	 * @returns JikanResponse with MangaStatistics data
 	 */
-	getMangaStatistics(mal_id: number): Promise<JikanResponse<MangaStatistics>>;
+	getMangaStatistics(id: number): Promise<JikanResponse<MangaStatistics>>;
 	/**
 	 * Get Recommendations related to a specific Manga
-	 * @param mal_id The Manga ID
+	 * @param id The Manga ID
 	 * @returns JikanResponse with Recommendation array data
 	 */
-	getMangaRecommendations(mal_id: number): Promise<JikanResponse<Recommendation[]>>;
+	getMangaRecommendations(id: number): Promise<JikanResponse<Recommendation[]>>;
+	/**
+	 * Get all the filtered Mangas. Returns all the Mangas if no filters are given.
+	 * @param searchParams Filter parameters
+	 * @returns JikanResponse with Manga array data
+	 */
+	getMangaSearch(searchParams?: Partial<MangaSearchParams>): Promise<JikanResponse<Manga[]>>;
 }
 /**
- * **Top Client**
+ * **Schedules Client**
  *
- * Client used to access the Top Endpoints:
+ * Client used to access the Schedules Endpoints
  *
  * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
  */
-export declare class TopClient extends BaseClient {
+export declare class SchedulesClient extends BaseClient {
 	/**
-	 * Get the top Animes
+	 * Returns weekly schedule
 	 * @param searchParams Filter parameters
 	 * @returns JikanResponse with Anime array data
 	 */
-	getTopAnime(searchParams?: Partial<AnimeTopParams>): Promise<JikanResponse<Anime[]>>;
-	/**
-	 * Get the top Mangas
-	 * @param searchParams Filter parameters
-	 * @returns JikanResponse with Manga array data
-	 */
-	getTopManga(searchParams?: Partial<MangaTopParams>): Promise<JikanResponse<Manga[]>>;
+	getSchedules(searchParams?: Partial<SchedulesParams>): Promise<JikanResponse<Anime[]>>;
 }
 /**
  * **Seasons Client**
@@ -716,89 +833,25 @@ export declare class SeasonsClient extends BaseClient {
 	getSeasonUpcoming(searchParams?: Partial<JikanSeasonsParams>): Promise<JikanResponse<Anime[]>>;
 }
 /**
- * **Anime Client**
- *
- * Client used to access the Anime 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<JikanResponse<Genre[]>>;
-	/**
-	 * Get Manga genres
-	 * @param filter Type of the desired genres
-	 */
-	getMangaGenres(filter?: GenresFilter): Promise<JikanResponse<Genre[]>>;
-}
-/**
- * **Characters Client**
+ * **Top Client**
  *
- * Client used to access the Character Endpoints:
+ * Client used to access the Top Endpoints:
  *
  * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
  */
-export declare class CharactersClient extends BaseClient {
-	/**
-	 * Get complete Character data
-	 * @param mal_id The Character ID
-	 * @returns JikanResponse with Character data
-	 */
-	getCharacterFullById(mal_id: number): Promise<JikanResponse<Character>>;
-	/**
-	 * Get Character data
-	 * @param mal_id The Character ID
-	 * @returns JikanResponse with Character data
-	 */
-	getCharacterById(mal_id: number): Promise<JikanResponse<Character>>;
-	/**
-	 * Get Character anime data
-	 * @param mal_id The Character ID
-	 * @returns JikanResponse with CharacterAnime data
-	 */
-	getCharacterAnime(mal_id: number): Promise<JikanResponse<CharacterAnime[]>>;
-	/**
-	 * Get Character manga data
-	 * @param mal_id The Character ID
-	 * @returns JikanResponse with CharacterManga data
-	 */
-	getCharacterManga(mal_id: number): Promise<JikanResponse<CharacterManga[]>>;
-	/**
-	 * Get Character voices data
-	 * @param mal_id The Character ID
-	 * @returns JikanResponse with CharacterVoiceActor data
-	 */
-	getCharacterVoiceActors(mal_id: number): Promise<JikanResponse<CharacterVoiceActor[]>>;
-	/**
-	 * Get Character pictures data
-	 * @param mal_id The Character ID
-	 * @returns JikanResponse with JikanImagesCollection data
-	 */
-	getCharacterPictures(mal_id: number): Promise<JikanResponse<JikanImagesCollection[]>>;
+export declare class TopClient extends BaseClient {
 	/**
-	 * Get all the Characters within the given filter. Returns all Characters if no filters are given.
-	 @param searchParams Filter parameters
-	 * @returns JikanResponse with Character array data
+	 * Get the top Animes
+	 * @param searchParams Filter parameters
+	 * @returns JikanResponse with Anime array data
 	 */
-	getCharacterSearch(searchParams: Partial<CharactersSearchParams>): Promise<JikanResponse<Character[]>>;
-}
-/**
- * **Schedules Client**
- *
- * Client used to access the Schedules Endpoints
- *
- * See also: [Jikan Documentation](https://docs.api.jikan.moe/)
- */
-export declare class SchedulesClient extends BaseClient {
+	getTopAnime(searchParams?: Partial<AnimeTopParams>): Promise<JikanResponse<Anime[]>>;
 	/**
-	 * Returns weekly schedule
+	 * Get the top Mangas
 	 * @param searchParams Filter parameters
-	 * @returns JikanResponse with Anime array data
+	 * @returns JikanResponse with Manga array data
 	 */
-	getSchedules(searchParams?: Partial<SchedulesParams>): Promise<JikanResponse<Anime[]>>;
+	getTopManga(searchParams?: Partial<MangaTopParams>): Promise<JikanResponse<Manga[]>>;
 }
 /**
  * **Jikan Client**
@@ -817,7 +870,7 @@ export declare class JikanClient {
 	seasons: SeasonsClient;
 	constructor(clientOptions?: Partial<ClientArgs>);
 }
-export declare const handleRequest: (requestConfig: CacheRequestConfig) => CacheRequestConfig;
+export declare const handleRequest: (requestConfig: InternalCacheRequestConfig) => InternalCacheRequestConfig;
 export declare const handleRequestError: (error: AxiosError) => Promise<AxiosError>;
 export declare const handleResponse: (response: CacheAxiosResponse) => CacheAxiosResponse;
 export declare const handleResponseError: (error: AxiosError) => Promise<AxiosError>;
@@ -825,18 +878,27 @@ export declare enum BaseURL {
 	REST = "https://api.jikan.moe/v4"
 }
 export declare enum AnimeEndpoints {
-	AnimeSearch = "/anime",
 	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",
-	AnimeRecommendations = "/anime/{id}/recommendations"
+	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"
 }
 export declare enum CharactersEndpoints {
 	CharacterFullById = "/characters/{id}/full",

package/dist/index.js

@@ -1 +1 @@
-import{setupCache as S}from"axios-cache-interceptor";import v from"axios";var A=(n=>(n.REST="https://api.jikan.moe/v4",n))(A||{});var k=(p=>(p.AnimeSearch="/anime",p.AnimeFullById="/anime/{id}/full",p.AnimeById="/anime/{id}",p.AnimeCharacters="/anime/{id}/characters",p.AnimeStaff="/anime/{id}/staff",p.AnimeEpisodes="/anime/{id}/episodes",p.AnimeEpisodeById="/anime/{id}/episodes/{episode}",p.AnimeVideos="/anime/{id}/videos",p.AnimeVideosEpisodes="/anime/{id}/videos/episodes",p.AnimePictures="/anime/{id}/pictures",p.AnimeStatistics="/anime/{id}/statistics",p.AnimeRecommendations="/anime/{id}/recommendations",p))(k||{});var J=(r=>(r.CharacterFullById="/characters/{id}/full",r.CharacterById="/characters/{id}",r.CharacterAnime="/characters/{id}/anime",r.CharactersManga="/characters/{id}/manga",r.CharacterVoiceActors="/characters/{id}/voices",r.CharacterPictures="/characters/{id}/pictures",r.CharacterSearch="/characters",r))(J||{});var P=(a=>(a.AnimeGenres="/genres/anime",a.MangaGenres="genres/manga",a))(P||{});var f=(r=>(r.MangaSearch="/manga",r.MangaFullById="/manga/{id}/full",r.MangaById="/manga/{id}",r.MangaCharacters="/manga/{id}/characters",r.MangaPictures="/manga/{id}/pictures",r.MangaStatistics="/manga/{id}/statistics",r.MangaRecommendations="/manga/{id}/recommendations",r))(f||{});var C=(s=>(s.Season="/seasons/{year}/{season}",s.SeasonNow="/seasons/now",s.SeasonsList="/seasons",s.SeasonUpcoming="/seasons/upcoming",s))(C||{});var b=(a=>(a.TopAnime="/top/anime",a.TopManga="/top/manga",a))(b||{});var y=t=>(console.info(`[Request] ${t.method?.toUpperCase()||""} | ${t.url||""}`),t),w=t=>{throw console.error(`[Request Error] CODE ${t.code||"UNKNOWN"} | ${t.message}`),t},E=t=>(console.info(`[Request Response] ${t.config.method?.toUpperCase()||""} | ${t.config.url||""}`,t.data),t),M=t=>{throw console.error(`[ Response Error ] CODE ${t.code||"UNKNOWN"} | ${t.message}`),t};var m=class{api;constructor(n={}){this.api=S(v.create({baseURL:n.baseURL??"https://api.jikan.moe/v4",headers:{"Content-Type":"application/json"}}),n.cacheOptions),n.enableLogging&&this.addLoggingInterceptors()}replacePathParams(n,a){for(let i of Object.keys(a)){if(!n.match(`{${i}}`))throw new Error(`Path does not contain "${i}" parameter.`);n=n.replace(`{${i}}`,String(a[i]))}return n}addLoggingInterceptors(){this.api.interceptors.request.use(n=>y(n),n=>w(n)),this.api.interceptors.response.use(n=>E(n),n=>M(n))}};var h=class extends m{async getAnimeSearch(n){return new Promise((a,i)=>{let s="/anime";this.api.get(s,{params:n}).then(e=>a(e.data)).catch(e=>i(e))})}async getAnimeFullById(n){return new Promise((a,i)=>{let s=this.replacePathParams("/anime/{id}/full",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getAnimeById(n){return new Promise((a,i)=>{let s=this.replacePathParams("/anime/{id}",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getAnimeCharacters(n){return new Promise((a,i)=>{let s=this.replacePathParams("/anime/{id}/characters",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getAnimeStaff(n){return new Promise((a,i)=>{let s=this.replacePathParams("/anime/{id}/staff",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getAnimeEpisodes(n,a=1){return new Promise((i,s)=>{let e=this.replacePathParams("/anime/{id}/episodes",{id:n});this.api.get(e,{params:{page:a}}).then(o=>i(o.data)).catch(o=>s(o))})}async getAnimeEpisodeById(n,a){return new Promise((i,s)=>{let e=this.replacePathParams("/anime/{id}/episodes/{episode}",{id:n,episode:a});this.api.get(e).then(o=>i(o.data)).catch(o=>s(o))})}async getAnimeVideos(n){return new Promise((a,i)=>{let s=this.replacePathParams("/anime/{id}/videos",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getAnimeEpisodeVideos(n,a=1){return new Promise((i,s)=>{let e=this.replacePathParams("/anime/{id}/videos/episodes",{id:n});this.api.get(e,{params:{page:a}}).then(o=>i(o.data)).catch(o=>s(o))})}async getAnimePictures(n){return new Promise((a,i)=>{let s=this.replacePathParams("/anime/{id}/pictures",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getAnimeStatistics(n){return new Promise((a,i)=>{let s=this.replacePathParams("/anime/{id}/statistics",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getAnimeRecommendations(n){return new Promise((a,i)=>{let s=this.replacePathParams("/anime/{id}/recommendations",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}};var g=class extends m{async getMangaSearch(n){return new Promise((a,i)=>{let s="/manga";this.api.get(s,{params:n}).then(e=>a(e.data)).catch(e=>i(e))})}async getMangaFullById(n){return new Promise((a,i)=>{let s=this.replacePathParams("/manga/{id}/full",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getMangaById(n){return new Promise((a,i)=>{let s=this.replacePathParams("/manga/{id}",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getMangaCharacters(n){return new Promise((a,i)=>{let s=this.replacePathParams("/manga/{id}/characters",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getMangaPictures(n){return new Promise((a,i)=>{let s=this.replacePathParams("/manga/{id}/pictures",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getMangaStatistics(n){return new Promise((a,i)=>{let s=this.replacePathParams("/manga/{id}/statistics",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getMangaRecommendations(n){return new Promise((a,i)=>{let s=this.replacePathParams("/manga/{id}/recommendations",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}};var u=class extends m{async getTopAnime(n){return new Promise((a,i)=>{let s="/top/anime";this.api.get(s,{params:n}).then(e=>a(e.data)).catch(e=>i(e))})}async getTopManga(n){return new Promise((a,i)=>{let s="/top/manga";this.api.get(s,{params:n}).then(e=>a(e.data)).catch(e=>i(e))})}};var d=class extends m{async getSeason(n,a,i){return new Promise((s,e)=>{let o=this.replacePathParams("/seasons/{year}/{season}",{year:n,season:a});this.api.get(o,{params:i}).then(r=>s(r.data)).catch(r=>e(r))})}async getSeasonNow(n){return new Promise((a,i)=>{let s="/seasons/now";this.api.get(s,{params:n}).then(e=>a(e.data)).catch(e=>i(e))})}async getSeasonsList(){return new Promise((n,a)=>{let i="/seasons";this.api.get(i).then(s=>n(s.data)).catch(s=>a(s))})}async getSeasonUpcoming(n){return new Promise((a,i)=>{let s="/seasons/upcoming";this.api.get(s,{params:n}).then(e=>a(e.data)).catch(e=>i(e))})}};var R=class extends m{async getAnimeGenres(n){return new Promise((a,i)=>{let s="/genres/anime";this.api.get(s,{params:{filter:n}}).then(e=>a(e.data)).catch(e=>i(e))})}async getMangaGenres(n){return new Promise((a,i)=>{let s="genres/manga";this.api.get(s,{params:{filter:n}}).then(e=>a(e.data)).catch(e=>i(e))})}};var l=class extends m{async getCharacterFullById(n){return new Promise((a,i)=>{let s=this.replacePathParams("/characters/{id}/full",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getCharacterById(n){return new Promise((a,i)=>{let s=this.replacePathParams("/characters/{id}",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getCharacterAnime(n){return new Promise((a,i)=>{let s=this.replacePathParams("/characters/{id}/anime",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getCharacterManga(n){return new Promise((a,i)=>{let s=this.replacePathParams("/characters/{id}/manga",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getCharacterVoiceActors(n){return new Promise((a,i)=>{let s=this.replacePathParams("/characters/{id}/voices",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getCharacterPictures(n){return new Promise((a,i)=>{let s=this.replacePathParams("/characters/{id}/pictures",{id:n});this.api.get(s).then(e=>a(e.data)).catch(e=>i(e))})}async getCharacterSearch(n){return new Promise((a,i)=>{let s="/characters";this.api.get(s,{params:n}).then(e=>a(e.data)).catch(e=>i(e))})}};var x=class extends m{async getSchedules(n){return new Promise((a,i)=>{let s="/schedules";this.api.get(s,{params:n}).then(e=>a(e.data)).catch(e=>i(e))})}};var I=class{anime;characters;genres;manga;top;schedules;seasons;constructor(n){this.anime=new h(n),this.characters=new l(n),this.genres=new R(n),this.manga=new g(n),this.top=new u(n),this.schedules=new x(n),this.seasons=new d(n)}};var _=(o=>(o.tv="TV",o.movie="Movie",o.ova="Ova",o.special="Special",o.ona="Ona",o.music="Music",o))(_||{}),B=(s=>(s.finished="Finished Airing",s.airing="Currently Airing",s.complete="Complete",s.upcoming="Not yet aired",s))(B||{}),V=(o=>(o.g="g",o.pg="pg",o.pg13="pg13",o.r17="r17",o.r="r",o.rx="rx",o))(V||{}),$=(s=>(s.spring="spring",s.summer="summer",s.fall="fall",s.winter="winter",s))($||{});var N=(a=>(a.main="Main",a.supporting="Supporting",a))(N||{});var L=(r=>(r.manga="Manga",r.novel="Novel",r.lightnovel="Lightnovel",r.oneshot="Oneshot",r.doujin="Doujin",r.manhwa="Manhwa",r.manhua="Manhua",r))(L||{}),T=(e=>(e.publishing="Publishing",e.complete="Complete",e.hiatus="On Hiatus",e.discontinued="Discontinued",e.upcoming="Upcoming",e))(T||{});var q=(a=>(a.asc="asc",a.desc="desc",a))(q||{}),G=(c=>(c.mal_id="mal_id",c.title="title",c.start_date="start_date",c.end_date="end_date",c.score="score",c.scored_by="scored_by",c.rank="rank",c.popularity="popularity",c.members="members",c.favorites="favorites",c))(G||{}),D=(i=>(i.type="type",i.rating="rating",i.episodes="episodes",i))(D||{}),U=(i=>(i.airing="airing",i.complete="complete",i.upcoming="upcoming",i))(U||{}),j=(a=>(a.chapters="chapters",a.volumes="volumes",a))(j||{}),z=(e=>(e.publishing="publishing",e.complete="complete",e.hiatus="hiatus",e.discontinued="discontinued",e.upcoming="upcoming",e))(z||{});var K=(s=>(s.airing="airing",s.upcoming="upcoming",s.bypopularity="bypopularity",s.favorite="favorite",s))(K||{}),W=(s=>(s.publishing="publishing",s.upcoming="upcoming",s.bypopularity="bypopularity",s.favorite="favorite",s))(W||{});var Y=(s=>(s.genres="genres",s.explicit_genres="explicit_genres",s.theme="themes",s.demographics="demographics",s))(Y||{});var H=(i=>(i.mal_id="mal_id",i.name="name",i.favorites="favorites",i))(H||{});var Q=(r=>(r.monday="monday",r.tuesday="tuesday",r.wednesday="wednesday",r.thursday="thursday",r.friday="friday",r.unknown="unknown",r.other="other",r))(Q||{});export{h as AnimeClient,k as AnimeEndpoints,V as AnimeRating,D as AnimeSearchOrder,U as AnimeSearchStatus,$ as AnimeSeason,B as AnimeStatus,_ as AnimeType,m as BaseClient,A as BaseURL,N as CharacterRole,l as CharactersClient,J as CharactersEndpoints,H as CharactersSearchOrder,R as GenresClient,P as GenresEndpoints,Y as GenresFilter,I as JikanClient,g as MangaClient,f as MangaEndpoints,j as MangaSearchOrder,z as MangaSearchStatus,T as MangaStatus,L as MangaType,x as SchedulesClient,Q as SchedulesFilter,G as SearchOrder,d as SeasonsClient,C as SeasonsEndpoints,q as SortOptions,K as TopAnimeFilter,u as TopClient,b as TopEndpoints,W as TopMangaFilter,y as handleRequest,w as handleRequestError,E as handleResponse,M as handleResponseError};
+var k=(e=>(e.REST="https://api.jikan.moe/v4",e))(k||{});var x=(a=>(a.AnimeFullById="/anime/{id}/full",a.AnimeById="/anime/{id}",a.AnimeCharacters="/anime/{id}/characters",a.AnimeStaff="/anime/{id}/staff",a.AnimeEpisodes="/anime/{id}/episodes",a.AnimeEpisodeById="/anime/{id}/episodes/{episode}",a.AnimeNews="/anime/{id}/news",a.AnimeForum="/anime/{id}/forum",a.AnimeVideos="/anime/{id}/videos",a.AnimeVideosEpisodes="/anime/{id}/videos/episodes",a.AnimePictures="/anime/{id}/pictures",a.AnimeStatistics="/anime/{id}/statistics",a.AnimeMoreInfo="/anime/{id}/moreinfo",a.AnimeRecommendations="/anime/{id}/recommendations",a.AnimeUserUpdates="/anime/{id}/userupdates",a.AnimeReviews="/anime/{id}/reviews",a.AnimeRelations="/anime/{id}/relations",a.AnimeThemes="/anime/{id}/themes",a.AnimeExternal="/anime/{id}/external",a.AnimeStreaming="/anime/{id}/streaming",a.AnimeSearch="/anime",a))(x||{});var b=(n=>(n.CharacterFullById="/characters/{id}/full",n.CharacterById="/characters/{id}",n.CharacterAnime="/characters/{id}/anime",n.CharactersManga="/characters/{id}/manga",n.CharacterVoiceActors="/characters/{id}/voices",n.CharacterPictures="/characters/{id}/pictures",n.CharacterSearch="/characters",n))(b||{});var J=(r=>(r.AnimeGenres="/genres/anime",r.MangaGenres="genres/manga",r))(J||{});var A=(n=>(n.MangaSearch="/manga",n.MangaFullById="/manga/{id}/full",n.MangaById="/manga/{id}",n.MangaCharacters="/manga/{id}/characters",n.MangaPictures="/manga/{id}/pictures",n.MangaStatistics="/manga/{id}/statistics",n.MangaRecommendations="/manga/{id}/recommendations",n))(A||{});var y=(s=>(s.Season="/seasons/{year}/{season}",s.SeasonNow="/seasons/now",s.SeasonsList="/seasons",s.SeasonUpcoming="/seasons/upcoming",s))(y||{});var P=(r=>(r.TopAnime="/top/anime",r.TopManga="/top/manga",r))(P||{});import _ from"axios";import{setupCache as S}from"axios-cache-interceptor";var C=i=>(console.info(`[Request] ${i.method?.toUpperCase()??""} | ${i.url??""}`),i),I=i=>{throw console.error(`[Request Error] CODE ${i.code??"UNKNOWN"} | ${i.message}`),i},M=i=>(console.info(`[Request Response] ${i.config.method?.toUpperCase()??""} | ${i.config.url??""}`,i.data),i),w=i=>{throw console.error(`[ Response Error ] CODE ${i.code??"UNKNOWN"} | ${i.message}`),i};var t=class{api;constructor(e={}){this.api=S(_.create({baseURL:e.baseURL??"https://api.jikan.moe/v4",headers:{"Content-Type":"application/json"}}),{...e.cacheOptions,cacheTakeover:!1}),e.enableLogging&&this.addLoggingInterceptors()}async getResource(e,r={},o={}){return(await this.api.get(this.replacePathParams(e,r),{params:o})).data}replacePathParams(e,r){for(let o of Object.keys(r)){if(!e.match(`{${o}}`))throw new Error(`Path does not contain "${o}" parameter.`);e=e.replace(`{${o}}`,String(r[o]))}return e}addLoggingInterceptors(){this.api.interceptors.request.use(e=>C(e),e=>I(e)),this.api.interceptors.response.use(e=>M(e),e=>w(e))}};var u=class extends t{async getAnimeFullById(e){return this.getResource("/anime/{id}/full",{id:e})}async getAnimeById(e){return this.getResource("/anime/{id}",{id:e})}async getAnimeCharacters(e){return this.getResource("/anime/{id}/characters",{id:e})}async getAnimeStaff(e){return this.getResource("/anime/{id}/staff",{id:e})}async getAnimeEpisodes(e,r=1){return this.getResource("/anime/{id}/episodes",{id:e},{page:r})}async getAnimeEpisodeById(e,r){return this.getResource("/anime/{id}/episodes/{episode}",{id:e,episode:r})}async getAnimeNews(e,r){return this.getResource("/anime/{id}/news",{id:e},{page:r})}async getAnimeForum(e,r){return this.getResource("/anime/{id}/news",{id:e},{filter:r})}async getAnimeVideos(e){return this.getResource("/anime/{id}/videos",{id:e})}async getAnimeEpisodeVideos(e,r=1){return this.getResource("/anime/{id}/videos/episodes",{id:e},{page:r})}async getAnimePictures(e){return this.getResource("/anime/{id}/pictures",{id:e})}async getAnimeStatistics(e){return this.getResource("/anime/{id}/statistics",{id:e})}async getAnimeMoreInfo(e){return this.getResource("/anime/{id}/moreinfo",{id:e})}async getAnimeRecommendations(e){return this.getResource("/anime/{id}/recommendations",{id:e})}async getAnimeRelations(e){return this.getResource("/anime/{id}/relations",{id:e})}async getAnimeSearch(e){return this.getResource("/anime",{},e)}};var g=class extends t{async getCharacterFullById(e){return this.getResource("/characters/{id}/full",{id:e})}async getCharacterById(e){return this.getResource("/characters/{id}",{id:e})}async getCharacterAnime(e){return this.getResource("/characters/{id}/anime",{id:e})}async getCharacterManga(e){return this.getResource("/characters/{id}/manga",{id:e})}async getCharacterVoiceActors(e){return this.getResource("/characters/{id}/voices",{id:e})}async getCharacterPictures(e){return this.getResource("/characters/{id}/pictures",{id:e})}async getCharacterSearch(e){return this.getResource("/characters/{id}/pictures",{},e)}};var l=class extends t{async getAnimeGenres(e){return this.getResource("/genres/anime",{},{filter:e})}async getMangaGenres(e){return this.getResource("genres/manga",{},{filter:e})}};var R=class extends t{async getMangaFullById(e){return this.getResource("/manga/{id}/full",{id:e})}async getMangaById(e){return this.getResource("/manga/{id}",{id:e})}async getMangaCharacters(e){return this.getResource("/manga/{id}/characters",{id:e})}async getMangaPictures(e){return this.getResource("/manga/{id}/pictures",{id:e})}async getMangaStatistics(e){return this.getResource("/manga/{id}/statistics",{id:e})}async getMangaRecommendations(e){return this.getResource("/manga/{id}/recommendations",{id:e})}async getMangaSearch(e){return this.getResource("/manga",{},e)}};var h=class extends t{async getSchedules(e){return this.getResource("/schedules",{},e)}};var d=class extends t{async getSeason(e,r,o){return this.getResource("/seasons/{year}/{season}",{year:e,season:r},o)}async getSeasonNow(e){return this.getResource("/seasons/now",{},e)}async getSeasonsList(){return this.getResource("/seasons")}async getSeasonUpcoming(e){return this.getResource("/seasons/upcoming",{},e)}};var f=class extends t{async getTopAnime(e){return this.getResource("/top/anime",{},e)}async getTopManga(e){return this.getResource("/top/manga",{},e)}};var v=class{anime;characters;genres;manga;top;schedules;seasons;constructor(e){this.anime=new u(e),this.characters=new g(e),this.genres=new l(e),this.manga=new R(e),this.top=new f(e),this.schedules=new h(e),this.seasons=new d(e)}};var B=(m=>(m.tv="TV",m.movie="Movie",m.ova="Ova",m.special="Special",m.ona="Ona",m.music="Music",m))(B||{}),N=(s=>(s.finished="Finished Airing",s.airing="Currently Airing",s.complete="Complete",s.upcoming="Not yet aired",s))(N||{}),V=(m=>(m.g="g",m.pg="pg",m.pg13="pg13",m.r17="r17",m.r="r",m.rx="rx",m))(V||{}),T=(s=>(s.spring="spring",s.summer="summer",s.fall="fall",s.winter="winter",s))(T||{});var L=(r=>(r.main="Main",r.supporting="Supporting",r))(L||{});var q=(n=>(n.manga="Manga",n.novel="Novel",n.lightnovel="Lightnovel",n.oneshot="Oneshot",n.doujin="Doujin",n.manhwa="Manhwa",n.manhua="Manhua",n))(q||{}),U=(c=>(c.publishing="Publishing",c.complete="Complete",c.hiatus="On Hiatus",c.discontinued="Discontinued",c.upcoming="Upcoming",c))(U||{});var $=(o=>(o.mal_id="mal_id",o.name="name",o.favorites="favorites",o))($||{});var G=(s=>(s.genres="genres",s.explicit_genres="explicit_genres",s.theme="themes",s.demographics="demographics",s))(G||{});var D=(n=>(n.monday="monday",n.tuesday="tuesday",n.wednesday="wednesday",n.thursday="thursday",n.friday="friday",n.unknown="unknown",n.other="other",n))(D||{});var j=(r=>(r.asc="asc",r.desc="desc",r))(j||{}),F=(p=>(p.mal_id="mal_id",p.title="title",p.start_date="start_date",p.end_date="end_date",p.score="score",p.scored_by="scored_by",p.rank="rank",p.popularity="popularity",p.members="members",p.favorites="favorites",p))(F||{}),z=(o=>(o.type="type",o.rating="rating",o.episodes="episodes",o))(z||{}),K=(o=>(o.airing="airing",o.complete="complete",o.upcoming="upcoming",o))(K||{}),W=(r=>(r.chapters="chapters",r.volumes="volumes",r))(W||{}),Y=(c=>(c.publishing="publishing",c.complete="complete",c.hiatus="hiatus",c.discontinued="discontinued",c.upcoming="upcoming",c))(Y||{});var H=(s=>(s.airing="airing",s.upcoming="upcoming",s.bypopularity="bypopularity",s.favorite="favorite",s))(H||{}),E=(s=>(s.publishing="publishing",s.upcoming="upcoming",s.bypopularity="bypopularity",s.favorite="favorite",s))(E||{});export{u as AnimeClient,x as AnimeEndpoints,V as AnimeRating,z as AnimeSearchOrder,K as AnimeSearchStatus,T as AnimeSeason,N as AnimeStatus,B as AnimeType,t as BaseClient,k as BaseURL,L as CharacterRole,g as CharactersClient,b as CharactersEndpoints,$ as CharactersSearchOrder,l as GenresClient,J as GenresEndpoints,G as GenresFilter,v as JikanClient,R as MangaClient,A as MangaEndpoints,W as MangaSearchOrder,Y as MangaSearchStatus,U as MangaStatus,q as MangaType,h as SchedulesClient,D as SchedulesFilter,F as SearchOrder,d as SeasonsClient,y as SeasonsEndpoints,j as SortOptions,H as TopAnimeFilter,f as TopClient,P as TopEndpoints,E as TopMangaFilter,C as handleRequest,I as handleRequestError,M as handleResponse,w as handleResponseError};

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@tutkli/jikan-ts",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Node.js wrapper for the Jikan API with built-in typings.",
   "source": "src/index.ts",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
   "scripts": {
+    "prepare": "git config core.hookspath .githooks",
     "prebuild": "rimraf dist",
     "build": "yarn run esbuild && yarn run build-types",
     "esbuild": "node ./esbuild.config.js",
@@ -15,9 +16,8 @@
     "test:coverage": "jest --coverage",
     "test:dev": "jest --verbose --colors --expand --maxWorkers=50% --detectOpenHandles --errorOnDeprecated --bail",
     "lint:fix": "npx eslint src/** --fix",
-    "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs",
-    "docs:preview": "vitepress preview docs"
+    "prettify": "prettier --write .",
+    "version": "auto-changelog -p -l false && git add CHANGELOG.md"
   },
   "repository": {
     "type": "git",
@@ -38,29 +38,33 @@
     "url": "https://github.com/tutkli/jikan-ts/issues"
   },
   "homepage": "https://github.com/tutkli/jikan-ts#readme",
-  "dependencies": {
-    "axios": "^0.27.2",
-    "axios-cache-interceptor": "^0.10.7"
+  "peerDependencies": {
+    "axios": "^1.6.7",
+    "axios-cache-interceptor": "^1.5.1"
   },
   "devDependencies": {
-    "@swc/core": "1.3.78",
-    "@swc/jest": "0.2.29",
-    "@types/jest": "29.5.3",
-    "@types/node": "20.5.1",
-    "@typescript-eslint/eslint-plugin": "6.4.1",
-    "@typescript-eslint/parser": "6.4.1",
-    "dts-bundle-generator": "8.0.1",
-    "esbuild": "0.19.2",
-    "esbuild-node-externals": "1.8.0",
-    "eslint": "8.47.0",
-    "eslint-config-prettier": "9.0.0",
-    "eslint-plugin-jest": "27.2.3",
+    "@swc/core": "1.4.0",
+    "@swc/jest": "0.2.36",
+    "@types/jest": "29.5.12",
+    "@types/node": "20.11.16",
+    "@typescript-eslint/eslint-plugin": "6.21.0",
+    "@typescript-eslint/parser": "6.21.0",
+    "auto-changelog": "^2.4.0",
+    "axios": "^1.6.7",
+    "axios-cache-interceptor": "^1.5.1",
+    "dts-bundle-generator": "9.3.1",
+    "esbuild": "0.20.0",
+    "esbuild-node-externals": "1.12.0",
+    "eslint": "8.56.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-jest": "27.6.3",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "5.0.0",
-    "jest": "29.6.3",
-    "prettier": "3.0.2",
-    "rimraf": "5.0.1",
-    "typescript": "5.1.6",
-    "vitepress": "^1.0.0-rc.4"
+    "eslint-plugin-prettier": "5.1.3",
+    "jest": "29.7.0",
+    "lint-staged": "^15.2.2",
+    "prettier": "3.2.5",
+    "prettier-plugin-organize-imports": "^3.2.4",
+    "rimraf": "5.0.5",
+    "typescript": "5.3.3"
   }
 }