@tutkli/jikan-ts 0.5.2 → 0.5.4

package/src/constants/endpoints.constant.ts

@@ -1,29 +0,0 @@
-export 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}',
-  AnimeVideos = '/anime/{id}/videos',
-  AnimeVideosEpisodes = '/anime/{id}/videos/episodes',
-  AnimePictures = '/anime/{id}/pictures',
-  AnimeStatistics = '/anime/{id}/statistics',
-  AnimeRecommendations = '/anime/{id}/recommendations',
-}
-
-export enum MangaEndpoints {
-  MangaSearch = '/manga',
-  MangaFullById = '/manga/{id}/full',
-  MangaById = '/manga/{id}',
-  MangaCharacters = '/manga/{id}/characters',
-  MangaPictures = '/manga/{id}/pictures',
-  MangaStatistics = '/manga/{id}/statistics',
-  MangaRecommendations = '/manga/{id}/recommendations',
-}
-
-export enum TopEndpoints {
-  TopAnime = '/top/anime',
-  TopManga = '/top/manga',
-}

package/src/constants/index.ts

@@ -1,2 +0,0 @@
-export * from './base.constant';
-export * from './endpoints.constant';

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from './clients';
-export * from './config';
-export * from './constants';
-export * from './models';

package/src/models/Anime/anime-character.model.ts

@@ -1,11 +0,0 @@
-import { CommonCharacter } from '../Common/character.model';
-import { JikanPerson } from '../Common/person.model';
-
-export interface AnimeCharacter extends CommonCharacter {
-  voice_actors: AnimeCharacterVoiceActor[];
-}
-
-export interface AnimeCharacterVoiceActor {
-  person: JikanPerson;
-  language: string;
-}

package/src/models/Anime/anime-episode.model.ts

@@ -1,12 +0,0 @@
-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;
-}

package/src/models/Anime/anime-picture.model.ts

@@ -1,5 +0,0 @@
-import { JikanImages } from '../Common';
-
-export interface AnimePicture {
-  images: JikanImages;
-}

package/src/models/Anime/anime-staff.model.ts

@@ -1,6 +0,0 @@
-import { JikanPerson } from '../Common';
-
-export interface AnimeStaff {
-  person: JikanPerson;
-  positions: string[];
-}

package/src/models/Anime/anime-statistics.model.ts

@@ -1,6 +0,0 @@
-import { Statistics } from '../Common';
-
-export interface AnimeStatistics extends Statistics {
-  watching: number;
-  plan_to_watch: number;
-}

package/src/models/Anime/anime-video.model.ts

@@ -1,38 +0,0 @@
-import { JikanImages, JikanImagesCollection } from '../Common';
-
-export interface AnimeVideo {
-  promo: AnimeVideoPromo[];
-  episodes: AnimeVideoEpisode[];
-  music_videos: AnimeMusicVideo[];
-}
-
-export interface AnimeVideoPromo {
-  title: string;
-  trailer: AnimeYoutubeVideo;
-}
-
-export interface AnimeYoutubeVideo {
-  youtube_id: string;
-  url: string;
-  embed_url: string;
-  images?: JikanImagesCollection;
-}
-
-export interface AnimeVideoEpisode {
-  mal_id: number;
-  url: string;
-  title: string;
-  episode: string;
-  images: JikanImages;
-}
-
-export interface AnimeMusicVideo {
-  title: string;
-  video: AnimeYoutubeVideo;
-  meta: AnimeVideoMeta;
-}
-
-export interface AnimeVideoMeta {
-  title: string;
-  author: string;
-}

package/src/models/Anime/anime.model.ts

@@ -1,95 +0,0 @@
-import {
-  JikanImages,
-  JikanNamedResource,
-  JikanResourcePeriod,
-  JikanResourceRelation,
-  JikanResourceTitle,
-  JikanUniqueResource,
-} from '../Common';
-import { AnimeYoutubeVideo } from './anime-video.model';
-
-export interface Anime {
-  mal_id: string;
-  url: string;
-  images: JikanImages;
-  trailer: AnimeYoutubeVideo;
-  approved: boolean;
-  titles: JikanResourceTitle[];
-  title: string;
-  title_english: string;
-  title_japanese: string;
-  title_synonyms: string[];
-  type: AnimeType;
-  source: string;
-  episodes: number;
-  status: AnimeStatus;
-  airing: boolean;
-  aired: JikanResourcePeriod;
-  duration: string;
-  rating: AnimeRating;
-  score: number;
-  scored_by: number;
-  rank: number;
-  popularity: number;
-  members: number;
-  favorites: number;
-  synopsis: string;
-  background: string;
-  season?: AnimeSeason;
-  year: number;
-  broadcast: AnimeBroadcast;
-  producers: JikanUniqueResource[];
-  licensors: JikanUniqueResource[];
-  studio: JikanUniqueResource[];
-  genres: JikanUniqueResource[];
-  explicit_genres: JikanUniqueResource[];
-  themes: JikanUniqueResource[];
-  demographic: JikanUniqueResource[];
-  relations?: JikanResourceRelation[];
-  theme?: AnimeTheme;
-  external?: JikanNamedResource[];
-  streaming: JikanNamedResource[];
-}
-
-export interface AnimeBroadcast {
-  day: string;
-  time: string;
-  timezone: string;
-  string: string;
-}
-
-export interface AnimeTheme {
-  openings: string[];
-  endings: string[];
-}
-
-export enum AnimeType {
-  tv = 'TV',
-  movie = 'Movie',
-  ova = 'Ova',
-  special = 'Special',
-  ona = 'Ona',
-  music = 'Music',
-}
-
-export enum AnimeStatus {
-  finished = 'Finished Airing',
-  airing = 'Currently Airing',
-  complete = 'Complete',
-}
-
-export enum AnimeRating {
-  g = 'g',
-  pg = 'pg',
-  pg13 = 'pg13',
-  r17 = 'r17',
-  r = 'r',
-  rx = 'rx',
-}
-
-export enum AnimeSeason {
-  spring = 'spring',
-  summer = 'summer',
-  fall = 'fall',
-  winter = 'winter',
-}

package/src/models/Anime/index.ts

@@ -1,7 +0,0 @@
-export * from './anime.model';
-export * from './anime-character.model';
-export * from './anime-staff.model';
-export * from './anime-episode.model';
-export * from './anime-video.model';
-export * from './anime-picture.model';
-export * from './anime-statistics.model';

package/src/models/Common/character.model.ts

@@ -1,18 +0,0 @@
-import { JikanImages } from './image.model';
-
-export interface CommonCharacter {
-  character: CommonCharacterData;
-  role: CharacterRole;
-}
-
-export interface CommonCharacterData {
-  mal_id: number;
-  url: string;
-  images: JikanImages;
-  name: string;
-}
-
-export enum CharacterRole {
-  main = 'Main',
-  supporting = 'Supporting',
-}

package/src/models/Common/image.model.ts

@@ -1,12 +0,0 @@
-export interface JikanImages {
-  jpg: JikanImagesCollection;
-  webp?: JikanImagesCollection;
-}
-
-export interface JikanImagesCollection {
-  image_url: string;
-  small_image_url?: string;
-  medium_image_url?: string;
-  large_image_url?: string;
-  maximum_image_url?: string;
-}

package/src/models/Common/index.ts

@@ -1,6 +0,0 @@
-export * from './resource.model';
-export * from './image.model';
-export * from './character.model';
-export * from './person.model';
-export * from './recommendation.model';
-export * from './statistics.model';

package/src/models/Common/person.model.ts

@@ -1,8 +0,0 @@
-import { JikanImages } from './image.model';
-
-export interface JikanPerson {
-  mal_id: number;
-  url: string;
-  images: JikanImages;
-  name: string;
-}

package/src/models/Common/recommendation.model.ts

@@ -1,12 +0,0 @@
-import { JikanImages } from './image.model';
-
-export interface Recommendation {
-  entry: RecommendationEntry;
-}
-
-export interface RecommendationEntry {
-  mal_id: number;
-  url: string;
-  images: JikanImages;
-  title: string;
-}

package/src/models/Common/resource.model.ts

@@ -1,31 +0,0 @@
-export interface JikanUniqueResource {
-  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: JikanUniqueResource[];
-}

package/src/models/Common/statistics.model.ts

@@ -1,13 +0,0 @@
-export interface Statistics {
-  completed: number;
-  on_hold: number;
-  dropped: number;
-  total: number;
-  scores: StatisticsScore[];
-}
-
-export interface StatisticsScore {
-  score: number;
-  votes: number;
-  percentage: number;
-}

package/src/models/Manga/index.ts

@@ -1,2 +0,0 @@
-export * from './manga.model';
-export * from './manga-statistics.model';

package/src/models/Manga/manga-statistics.model.ts

@@ -1,6 +0,0 @@
-import { Statistics } from '../Common';
-
-export interface MangaStatistics extends Statistics {
-  reading: number;
-  plan_to_read: number;
-}

package/src/models/Manga/manga.model.ts

@@ -1,58 +0,0 @@
-import {
-  JikanImages,
-  JikanNamedResource,
-  JikanResourcePeriod,
-  JikanResourceRelation,
-  JikanResourceTitle,
-  JikanUniqueResource,
-} from '../Common';
-
-export interface Manga {
-  mal_id: number;
-  url: string;
-  images: JikanImages;
-  approved: boolean;
-  titles: JikanResourceTitle[];
-  title: string;
-  title_japanese: string;
-  title_synonyms?: string[];
-  type: MangaType;
-  chapters: number;
-  volumes: number;
-  status: MangaStatus;
-  publishing: boolean;
-  published: JikanResourcePeriod;
-  score: number;
-  scored_by: number;
-  rank: number;
-  popularity: number;
-  members: number;
-  favorites: number;
-  synopsis: string;
-  background: string;
-  authors: JikanUniqueResource[];
-  serializations: JikanUniqueResource[];
-  explicit_genres: JikanUniqueResource[];
-  themes: JikanUniqueResource[];
-  demographics: JikanUniqueResource[];
-  relations?: JikanResourceRelation[];
-  external?: JikanNamedResource[];
-}
-
-export enum MangaType {
-  manga = 'Manga',
-  novel = 'Novel',
-  lightnovel = 'Lightnovel',
-  oneshot = 'Oneshot',
-  doujin = 'Doujin',
-  manwha = 'Manwha',
-  manhua = 'Manhua',
-}
-
-export enum MangaStatus {
-  publishing = 'Publishing',
-  complete = 'Complete',
-  hiatus = 'Hiatus',
-  discontinued = 'Discontinued',
-  upcoming = 'Upcoming',
-}

package/src/models/Params/index.ts

@@ -1,2 +0,0 @@
-export * from './search-params.model';
-export * from './top-params.model';

package/src/models/Params/search-params.model.ts

@@ -1,72 +0,0 @@
-import { MangaStatus, MangaType } from '../Manga';
-import { AnimeRating, AnimeStatus, AnimeType } from '../Anime';
-
-export enum SortOptions {
-  asc = 'asc',
-  desc = 'desc',
-}
-
-export enum SearchOrder {
-  mal_id = 'mal_id',
-  title = 'title',
-  start_date = 'start_date',
-  end_date = 'end_date',
-  score = 'score',
-  scored_by = 'scored_by',
-  rank = 'rank',
-  popularity = 'popularity',
-  members = 'members',
-  favorites = 'favorites',
-}
-
-export enum AnimeSearchOrder {
-  type = 'type',
-  rating = 'rating',
-  episodes = 'episodes',
-}
-
-export enum MangaSearchOrder {
-  chapters = 'chapters',
-  volumes = 'volumes',
-}
-
-export interface JikanSearchParams {
-  q?: string;
-  page?: number;
-  limit?: number;
-  score?: number;
-  min_score?: number;
-  max_score?: number;
-  sfw?: boolean;
-  genres?: string;
-  genres_exclude?: string;
-  sort?: SortOptions | string;
-  letter?: string;
-  producers?: string;
-  start_date?: string;
-  end_date?: string;
-}
-
-/**
- * QueryParams used in **getMangaSearch** call
- *
- * See also: [Jikan API Documentation](https://docs.api.jikan.moe/#tag/manga/operation/getMangaSearch)
- */
-export interface MangaSearchParams extends JikanSearchParams {
-  type?: MangaType | string;
-  status?: MangaStatus | string;
-  order_by?: MangaSearchOrder | SearchOrder | string;
-  magazines?: string;
-}
-
-/**
- * QueryParams used in **getAnimeSearch** call
- *
- * See also: [Jikan API Documentation](https://docs.api.jikan.moe/#tag/anime/operation/getAnimeSearch)
- */
-export interface AnimeSearchParams extends JikanSearchParams {
-  type?: AnimeType | string;
-  status?: AnimeStatus | string;
-  rating?: AnimeRating | string;
-  order_by?: AnimeSearchOrder | SearchOrder | string;
-}

package/src/models/Params/top-params.model.ts

@@ -1,41 +0,0 @@
-import { AnimeType } from '../Anime';
-import { MangaType } from '../Manga';
-
-export enum TopAnimeFilter {
-  airing = 'airing',
-  upcoming = 'upcoming',
-  bypopularity = 'bypopularity',
-  favorite = 'favorite',
-}
-
-export 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)
- */
-export interface AnimeTopParams extends JikanTopParams {
-  type?: AnimeType;
-  filter?: TopAnimeFilter;
-}
-
-/**
- * QueryParams used in **getTopManga** call
- *
- * See also: [Jikan API Documentation](https://docs.api.jikan.moe/#tag/top/operation/getTopManga)
- */
-export interface MangaTopParams extends JikanTopParams {
-  type?: MangaType;
-  filter: TopMangaFilter;
-}

package/src/models/Response/index.ts

@@ -1 +0,0 @@
-export * from './response.model';

package/src/models/Response/response.model.ts

@@ -1,21 +0,0 @@
-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 interface JikanUniqueResponse<T> {
-  data: T;
-  pagination?: JikanPagination;
-}

package/src/models/index.ts

@@ -1,5 +0,0 @@
-export * from './Anime';
-export * from './Common';
-export * from './Manga';
-export * from './Response';
-export * from './Params';

package/tsconfig.eslint.json

@@ -1,5 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "include": ["src/**/*", "jest.config.ts"],
-  "exclude": ["node_modules", "dist"]
-}

package/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2022",
-    "allowJs": true,
-    "skipLibCheck": false,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "declaration": true,
-    "esModuleInterop": true,
-    "module": "es2022",
-    "moduleResolution": "node",
-    "typeRoots": ["./node_modules/@types"],
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "importHelpers": true,
-    "rootDir": "./src",
-    "outDir": "./dist"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist", "**/*.spec.ts", "**/*.test.ts"]
-}