Add fetchTags()

Author: sefinek

README.md

@@ -73,7 +73,6 @@ const { NekosiaAPI } = require('nekosia.js');
 })();
 ```
 
-
 ### IP-based Sessions
 In this example, we used an IP-based session. What does this mean? Thanks to this solution, a user with a specific IP address will not encounter duplicate images when selecting them randomly.
 
@@ -115,6 +114,16 @@ const { NekosiaAPI } = require('nekosia.js');
 https://github.com/Nekosia-API/nekosia.js/tree/main/examples
 
 
+## Tags
+```js
+const { NekosiaAPI } = require('nekosia.js');
+
+(async () => {
+	console.log(await NekosiaAPI.fetchTags()); // Simply returns all available tags, etc.
+})();
+``` 
+
+
 ## Versions
 ```js
 const { NekosiaVersion } = require('nekosia.js');

examples/fetchTags.js

@@ -0,0 +1,6 @@
+const { NekosiaAPI } = require('../index.js');
+
+(async () => {
+	const json = await NekosiaAPI.fetchTags();
+	console.log(json);
+})();

index.js

@@ -43,7 +43,11 @@ class NekosiaAPI {
 
 	async fetchImages(options = {}) {
 		if (!Array.isArray(options.tags) || options.tags.length === 0) {
-			throw new Error('`tags` must be a non-empty array for the nothing category');
+			throw new Error('`tags` must be a non-empty array');
+		}
+
+		if (Array.isArray(options.blacklistedTags)) {
+			throw new Error('Unexpected `blacklistedTags` in `fetchImages()`, use `blacklist` instead');
 		}
 
 		return this.fetchCategoryImages('nothing', {
@@ -55,6 +59,10 @@ class NekosiaAPI {
 		});
 	}
 
+	async fetchTags() {
+		return this.makeHttpRequest(`${API_URL}/tags`);
+	}
+
 	async fetchById(id) {
 		if (!id) throw new Error('`id` parameter is required');
 

test/api.test.js

@@ -70,7 +70,7 @@ describe('NekosiaAPI (API Tests)', () => {
 		});
 
 		it('should throw an error if additionalTagsArray is empty', async () => {
-			await expect(NekosiaAPI.fetchImages([])).rejects.toThrow('`tags` must be a non-empty array for the nothing category');
+			await expect(NekosiaAPI.fetchImages([])).rejects.toThrow('`tags` must be a non-empty array');
 		});
 
 		it('should return an error response for invalid count parameter', async () => {

test/integration.test.js

@@ -58,7 +58,7 @@ describe('NekosiaAPI', () => {
 
 	describe('fetchImages', () => {
 		it('should throw an error if additionalTags is empty', async () => {
-			await expect(NekosiaAPI.fetchImages({})).rejects.toThrow('`tags` must be a non-empty array for the nothing category');
+			await expect(NekosiaAPI.fetchImages({})).rejects.toThrow('`tags` must be a non-empty array');
 		});
 
 		it('should correctly call fetchImages with additionalTags', async () => {

types/index.d.ts

@@ -371,6 +371,17 @@ declare module 'nekosia.js' {
         attribution: ImageAttribution;
     }
 
+    /**
+     * GET https://api.nekosia.cat/api/v1/tags
+     */
+    interface TagsResponse {
+        status: number,
+        success: boolean,
+        tags: string[],
+        anime: string[],
+        characters: string[]
+    }
+
     /**
      * Nekosia API class, containing methods for fetching images.
      * All methods are asynchronous and return a Promise resolving to an `ImageResponse`.
@@ -407,6 +418,12 @@ declare module 'nekosia.js' {
          */
         static fetchImages(options?: FetchImagesOptions): Promise<ImageResponse>;
 
+        /**
+         * Fetches the latest array with tags, anime titles, and characters
+         * @returns A Promise resolving to an `ImageResponse`.
+         */
+        static fetchTags(id: string): Promise<TagsResponse>;
+
         /**
          * Fetches an image by its identifier.
          * @param id - The image identifier (e.g., `66ae26a07886f165901e8a3f`).