@tutkli/jikan-ts 0.5.0

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

@@ -0,0 +1,72 @@
+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

@@ -0,0 +1,41 @@
+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

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

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

@@ -0,0 +1,21 @@
+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

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

package/tsconfig.eslint.json

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

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "allowJs": true,
+    "skipLibCheck": false,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "module": "CommonJS",
+    "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"]
+}