@tutkli/jikan-ts 0.5.0

package/.editorconfig

@@ -0,0 +1,16 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.ts]
+quote_type = single
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

package/.eslintignore

@@ -0,0 +1,17 @@
+dist
+/*.js
+docs
+node_modules
+.github
+.husky
+.vscode
+resources
+
+*.scss
+*.html
+*.png
+*.ico
+*.md
+*.webp
+*.svg
+*.pdf

package/.eslintrc.json

@@ -0,0 +1,27 @@
+{
+  "env": {
+    "es2022": true,
+    "node": true
+  },
+  "parser": "@typescript-eslint/parser",
+  "extends": [
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "plugin:jest/recommended",
+    "prettier",
+    "plugin:prettier/recommended"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2022,
+    "sourceType": "module",
+    "project": "./tsconfig.eslint.json"
+  },
+  "rules": {
+    "prettier/prettier": [
+      "error",
+      {
+        "endOfLine": "auto"
+      }
+    ]
+  }
+}

package/.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "printWidth": 120,
+  "singleQuote": true,
+  "useTabs": false,
+  "tabWidth": 2,
+  "semi": true,
+  "bracketSpacing": true
+}

package/CHANGELOG.md

@@ -0,0 +1,30 @@
+# v0.5.0 (12/11/2022)
+
+### Test
+
+- Added Client tests
+
+<!-- CHANGELOG SPLIT MARKER -->
+
+# v0.4.0 (12/11/2022)
+
+### Clients
+
+- Added TopClient
+- Added search queryParams to AnimeClient, MangaClient and TopClient.
+
+### Docs
+
+- Improve models and clients documentation
+
+<!-- CHANGELOG SPLIT MARKER -->
+
+# v0.3.0 (12/11/2022)
+
+### Clients
+
+- More endpoints added to the MangaClient:
+  - getMangaCharacters
+  - getMangaPictures
+  - getMangaStatistics
+  - getMangaRecommendations

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Clara Castillo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# jikan-ts
+
+## What it is
+
+Node.js wrapper of the Jikan API with build-in typings.
+
+## Features
+
+- Built-in typings
+- Axios with Request Cache
+- Logging Configuration
+- Fully Tree-Shakable
+
+## Installation
+
+```bash
+npm install --save @tutkli/jikan-ts
+```
+
+## Basic Example
+
+Using a specific client, like AnimeClient:
+
+```js
+import { AnimeClient } from '@tutkli/jikan-ts';
+
+(async () => {
+  const api = new AnimeClient();
+
+  await api
+    .getAnimeById(1)
+    .then((jikanResponse) => console.log(jikanResponse.data.title)) // will output "Cowboy Bebob"
+    .catch((error) => console.error(error));
+})();
+```
+
+Or, using the JikanClient:
+
+```js
+import { JikanClient } from '@tutkli/jikan-ts';
+
+(async () => {
+  const api = new JikanClient();
+
+  await api.anime
+    .getAnimeById(1)
+    .then((jikanResponse) => console.log(jikanResponse.data.title)) // will output "Cowboy Bebob"
+    .catch((error) => console.error(error));
+})();
+```
+
+## Available Clients
+
+- AnimeClient
+- MangaClient
+- TopClient
+- JikanClient (Main client)
+
+## Leave you 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)
+- Want to contribute? [Submit a PR 📑](https://github.com/tutkli/jikan-ts/pulls)
+