nekosia.js 0.1.4 → 0.2.0

package/README.md

@@ -3,10 +3,10 @@
 </div>
 
 Nekosia.js is a Node.js module that provides easy access to the Nekosia API, a rich source of anime-themed images.
-The API offers a wide range of categories, allowing you to quickly and flexibly search for images according to your preferences and needs.
-You decide what images you want to retrieve, which makes our API stand out from others.
+The API offers a wide range of categories, allowing you to quickly and flexibly search for images based on your preferences and needs.
+You have full control over the images you retrieve, which sets our API apart from others.
 
-But that's not all! The API also supports sessions (based on user ID or IP address), helping to avoid repeated images.
+But that's not all! The API also supports sessions (based on user ID or IP address), helping to prevent repeated images.
 
 <div align="center">
     <a href="https://www.npmjs.com/package/nekosia.js">
@@ -24,18 +24,18 @@ But that's not all! The API also supports sessions (based on user ID or IP addre
 
 
 ## 🔍 Key Features of the API
-- **Wide range of categories:** Nekosia API offers [virtually every kind of anime graphic](https://nekosia.cat/documentation?page=api-endpoints#main-categories), not limited to neko images.
-- **High image quality:** All images are carefully selected and checked for quality and appropriateness.
-- **Sessions:** The API supports sessions (based on ID or IP address), which helps avoid duplicate images.
+- **Wide range of categories:** Nekosia API offers [virtually every kind of anime graphic](https://nekosia.cat/documentation?page=api-endpoints#main-categories), not just neko images.
+- **High image quality:** All images are carefully selected and checked for both quality and appropriateness.
+- **Sessions:** The API supports sessions (based on ID or IP address), helping to avoid duplicate images.
 - **Dominant colors:** The API returns a palette of dominant colors for each image.
-- **Image compression:** JSON responses include a link to a compressed image that is much smaller than the original. This can be useful if you want images to load quickly on client devices without sacrificing quality.
-- **Security:** Nekosia API ensures that all provided content is free from NSFW material, making it one of the most trusted sources of anime-themed images.
+- **Image compression:** JSON responses include a link to a compressed image with a significantly reduced file size compared to the original. This ensures faster load times on client devices without sacrificing quality.
+- **Security:** Nekosia API guarantees that all content is free from NSFW material, making it one of the most trusted sources for anime-themed images.
 
 ...and that’s not all!
 
 
 ## 📘 Best Anime Booru
-Nekosia also offers its own [Booru](https://nekosia.cat/booru), allowing you to browse images returned by the API.
+Nekosia also offers its own [Booru](https://nekosia.cat/booru), allowing you to browse images returned by the API.  
 Users can edit image information, such as tags, which are crucial for us.
 
 
@@ -47,7 +47,7 @@ Check out the [official documentation](https://nekosia.cat/documentation) to lea
 To install the Nekosia.js module, use the following command:
 
 ```bash
-npm install neksosia.js
+npm install nekosia.js
 ```
 
 
@@ -63,20 +63,24 @@ The full list of tags is available [on the Booru site](https://nekosia.cat/booru
 const { NekosiaAPI } = require('nekosia.js');
 
 (async () => {
-	const response = await NekosiaAPI.fetchImages('catgirl');
-	console.log(response); // Sample response: https://nekosia.cat/documentation?page=api-endpoints#example-response
+	const response1 = await NekosiaAPI.fetchCategoryImages('catgirl');
+	console.log(response1);
+	
+	const response2 = await NekosiaAPI.fetchImages({ session: 'ip', count: 1, tags: ['cute', 'blue-hair'], blacklist: ['yellow-hair'] });
+	console.log(response2);
+	
+	// https://nekosia.cat/documentation?page=api-endpoints#example-response
 })();
 ```
 
-
 ### 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 duplicates when randomly selecting images.
+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.
 
 ```js
 const { NekosiaAPI } = require('nekosia.js');
 
 (async () => {
-	const response = await NekosiaAPI.fetchImages('catgirl', {
+	const response = await NekosiaAPI.fetchCategoryImages('catgirl', {
 		session: 'ip',
 		count: 1,
 		additionalTags: [],
@@ -88,13 +92,13 @@ const { NekosiaAPI } = require('nekosia.js');
 ```
 
 ### ID-based Sessions
-You can also use `id`, but this will require providing a user identifier (e.g., from Discord). Pass this information in `id` as a string.
+You can also use `id`, but this requires providing a user identifier (e.g., from Discord). Pass this information in `id` as a string.
 
 ```js
 const { NekosiaAPI } = require('nekosia.js');
 
 (async () => {
-	const response = await NekosiaAPI.fetchImages('catgirl', {
+	const response = await NekosiaAPI.fetchCategoryImages('catgirl', {
 		session: 'id',
 		id: '561621386765971781',
 		count: 1,
@@ -110,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');
@@ -122,8 +136,8 @@ const { NekosiaVersion } = require('nekosia.js');
 
 
 ## ⭐ » Thanks
-If you find the API or this module useful, consider giving a star to the [repository](https://github.com/sefinek24/nekosia.js).
-If you have questions or issues, create a new [Issue](https://github.com/Nekosia-API/nekosia.js/issues/new) or join the [Discord server](https://discord.gg/pba76vJhcP).
+If you find the API or this module useful, consider giving a star to the [repository](https://github.com/Nekosia-API/nekosia.js).  
+If you have any questions or issues, create a new [Issue](https://github.com/Nekosia-API/nekosia.js/issues/new) or join the [Discord server](https://discord.gg/pba76vJhcP).
 
 
 ## 📑 » MIT License

package/examples/dynamicCategoryFetch.js

@@ -2,7 +2,7 @@ const { NekosiaAPI } = require('../index.js');
 
 const fetchImages = async (category, options = {}) => {
 	try {
-		const response = await NekosiaAPI.fetchImages(category, options);
+		const response = await NekosiaAPI.fetchCategoryImages(category, options);
 		console.log(`${category.toUpperCase()}:`, response);
 	} catch (err) {
 		console.error(`Error fetching ${category} images:`, err);
@@ -12,4 +12,5 @@ const fetchImages = async (category, options = {}) => {
 (async () => {
 	await fetchImages('catgirl');
 	await fetchImages('foxgirl', { session: 'id', id: 'user123', count: 2 });
+	await fetchImages('catgirl', { tags: 'animal-ears' });
 })();

package/examples/{basicUsage.js → fetchCategoryImages.js}

@@ -1,11 +1,11 @@
 const { NekosiaAPI } = require('../index.js');
 
 (async () => {
-	const response = await NekosiaAPI.fetchImages('foxgirl', {
+	const response = await NekosiaAPI.fetchCategoryImages('foxgirl', {
 		session: 'ip',
 		count: 1,
 		additionalTags: ['cute', 'sakura', 'cherry-blossom'],
-		blacklistedTags: ['beret']
+		blacklistedTags: ['beret'],
 	});
 
 	console.log(response);

package/examples/fetchImages.js

@@ -0,0 +1,6 @@
+const { NekosiaAPI } = require('../index.js');
+
+(async () => {
+	const response = await NekosiaAPI.fetchImages({ session: 'ip', count: 1, tags: ['cute', 'blue-hair'], blacklist: ['yellow-hair'] });
+	console.log(response);
+})();

package/examples/fetchTags.js

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

package/examples/version.js

@@ -1,6 +1,8 @@
 const { NekosiaVersion } = require('../index.js');
 
 (async () => {
-	console.log(NekosiaVersion.module);
-	console.log(await NekosiaVersion.api());
+	console.log(`Nekosia.js: v${NekosiaVersion.module}`);
+
+	const data = await NekosiaVersion.api();
+	console.log(`API: v${data.version}`);
 })();

package/index.js

@@ -25,9 +25,9 @@ class NekosiaAPI {
 		}
 	}
 
-	async fetchImages(category, options = {}) {
+	async fetchCategoryImages(category, options = {}) {
 		if (!category) {
-			throw new Error('The image category is required. For example, use fetchImages(\'catgirl\').');
+			throw new Error('The image category is required. For example, use fetchCategoryImages(\'catgirl\').');
 		}
 
 		if (options.session && !['id', 'ip'].includes(options.session)) {
@@ -38,24 +38,29 @@ class NekosiaAPI {
 			throw new Error('`id` is not required if the session is `null` or `undefined`');
 		}
 
-		const queryString = this.buildQueryParams({
-			session: null,
-			id: null,
-			count: 1,
-			additionalTags: [],
-			blacklistedTags: [],
-			...options
-		});
-
-		return this.makeHttpRequest(`${API_URL}/images/${category}?${queryString}`);
+		return this.makeHttpRequest(`${API_URL}/images/${category}?${this.buildQueryParams(options)}`);
 	}
 
-	async fetchShadowImages(options = {}) {
-		if (!Array.isArray(options.additionalTags) || options.additionalTags.length === 0) {
-			throw new Error('`additionalTags` must be a non-empty array for the shadow category');
+	async fetchImages(options = {}) {
+		if (!Array.isArray(options.tags) || options.tags.length === 0) {
+			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.fetchImages('shadow', options);
+		return this.fetchCategoryImages('nothing', {
+			session: options.session,
+			id: options.id,
+			count: options.count,
+			additionalTags: options.tags,
+			blacklistedTags: options.blacklist,
+		});
+	}
+
+	async fetchTags() {
+		return this.makeHttpRequest(`${API_URL}/tags`);
 	}
 
 	async fetchById(id) {
@@ -67,12 +72,10 @@ class NekosiaAPI {
 
 const NekosiaVersion = {
 	module: https.version,
-	api: async () => {
-		return await https.get(BASE_URL);
-	}
+	api: async () => https.get(BASE_URL),
 };
 
 module.exports = {
 	NekosiaAPI: new NekosiaAPI(),
-	NekosiaVersion
+	NekosiaVersion,
 };

package/package.json

@@ -1,60 +1,64 @@
-{
-  "name": "nekosia.js",
-  "version": "0.1.4",
-  "description": "A simple wrapper for the Nekosia API that provides easy access to random anime images. Enhance your projects with the magic of anime and a touch of feline charm meow~~! Discover why switching to Nekosia is the purrfect choice!",
-  "keywords": [
-    "anime api",
-    "anime art",
-    "anime characters",
-    "anime gifs",
-    "anime images",
-    "anime library",
-    "anime wallpaper",
-    "anime",
-    "anime-api",
-    "api wrapper",
-    "cat ears",
-    "cat",
-    "catgirl",
-    "catgirls",
-    "cute-animals",
-    "feline",
-    "image api",
-    "japan",
-    "javascript",
-    "js library",
-    "kawaii",
-    "manga",
-    "moe",
-    "neko girls",
-    "neko",
-    "nekos",
-    "nekosia api",
-    "nekosia",
-    "otaku",
-    "random-anime",
-    "typescript",
-    "waifu"
-  ],
-  "homepage": "https://nekosia.cat",
-  "bugs": {
-    "url": "https://github.com/Nekosia-API/nekosia.js/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Nekosia-API/nekosia.js.git"
-  },
-  "license": "ISC",
-  "author": "Sefinek <contact@sefinek.net> (https://sefinek.net)",
-  "main": "index.js",
-  "typings": "types/index.d.ts",
-  "scripts": {
-    "test": "jest",
-    "up": "ncu -u && npm install && npm update && npm audit fix"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.10.0",
-    "globals": "^15.9.0",
-    "jest": "^29.7.0"
-  }
-}
+{
+  "name": "nekosia.js",
+  "version": "0.2.0",
+  "description": "A simple wrapper for the Nekosia API that offers seamless access to random anime images. Add a touch of anime magic and feline charm to your projects, meow~~! Find out why Nekosia is the purrfect choice!",
+  "keywords": [
+    "anime api",
+    "anime art",
+    "anime catgirls",
+    "anime characters",
+    "anime gifs",
+    "anime images",
+    "anime library",
+    "anime nekos",
+    "anime wallpaper",
+    "anime",
+    "anime-api",
+    "api wrapper",
+    "api-wrapper",
+    "cat ears",
+    "cat",
+    "catgirl",
+    "catgirls",
+    "cute animals",
+    "cute nekos",
+    "feline",
+    "girl",
+    "girls",
+    "image api",
+    "javascript",
+    "js library",
+    "kawaii",
+    "manga",
+    "moe",
+    "neko girls",
+    "neko",
+    "nekos",
+    "nekosia api",
+    "nekosia",
+    "otaku",
+    "random anime",
+    "waifu"
+  ],
+  "homepage": "https://nekosia.cat",
+  "bugs": {
+    "url": "https://github.com/Nekosia-API/nekosia.js/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Nekosia-API/nekosia.js.git"
+  },
+  "license": "MIT",
+  "author": "Sefinek <contact@sefinek.net> (https://sefinek.net)",
+  "main": "index.js",
+  "types": "types/index.d.ts",
+  "scripts": {
+    "test": "jest",
+    "up": "ncu -u && npm install && npm update && npm audit fix"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.17.0",
+    "globals": "^15.13.0",
+    "jest": "^29.7.0"
+  }
+}

package/services/https.js

@@ -7,39 +7,43 @@ const headers = {
 	'Content-Type': 'application/json',
 	'Cache-Control': 'no-cache',
 	'Connection': 'keep-alive',
-	'DNT': '1'
+	'DNT': '1',
 };
 
-const makeRequest = url => new Promise((resolve, reject) => {
-	const req = https.get(url, { headers, timeout: 9000 }, res => {
-		let data = '';
+const timeout = 25000;
 
-		res.on('data', chunk => {
-			data += chunk;
-		});
+const get = async url => {
+	if (!url || typeof url !== 'string') throw new Error('Missing URL, expected a string.');
 
-		res.on('end', () => {
-			if ((res.statusCode < 200 || res.statusCode >= 300) && res.statusCode !== 400) {
-				return reject(new Error(`HTTP Status Code: ${res.statusCode}`));
+	return new Promise((resolve, reject) => {
+		const req = https.get(url, { headers, timeout }, res => {
+			const { statusCode } = res;
+			if ((statusCode < 200 || statusCode >= 300) && statusCode !== 400) {
+				req.destroy();
+				return reject(new Error(`Unexpected HTTP Status Code: ${statusCode || 'unknown'}`));
 			}
 
-			try {
-				const parsedData = JSON.parse(data);
-				resolve(parsedData);
-			} catch (err) {
-				reject(new Error(`Failed to parse JSON: ${err.message}. Response: ${data}`));
-			}
+			let data = '';
+			res.on('data', chunk => data += chunk);
+			res.on('end', () => {
+				try {
+					resolve(JSON.parse(data));
+				} catch (err) {
+					reject(err);
+				}
+			});
 		});
-	});
 
-	req.on('error', err => reject(new Error(`Request error: ${err.message}`)));
+		req.on('error', err => {
+			req.destroy();
+			reject(err);
+		});
 
-	req.on('timeout', () => {
-		req.destroy();
-		reject(new Error('Timeout error'));
+		req.on('timeout', () => {
+			req.destroy();
+			reject(new Error(`Request timed out after ${timeout} ms.`));
+		});
 	});
+};
 
-	req.end();
-});
-
-module.exports = { get: makeRequest, version };
+module.exports = { get, version };

package/test/api.test.js

@@ -2,9 +2,9 @@ const { NekosiaAPI } = require('../index.js');
 
 describe('NekosiaAPI (API Tests)', () => {
 
-	describe('fetchImages', () => {
+	describe('fetchCategoryImages', () => {
 		it('should fetch images for the given category', async () => {
-			const res = await NekosiaAPI.fetchImages('catgirl', { count: 1 });
+			const res = await NekosiaAPI.fetchCategoryImages('catgirl', { count: 1 });
 
 			expect(res).toBeInstanceOf(Object);
 			expect(res.success).toBe(true);
@@ -43,48 +43,47 @@ describe('NekosiaAPI (API Tests)', () => {
 		});
 
 		it('should return an error for an invalid category', async () => {
-			const res = await NekosiaAPI.fetchImages('invalid-category', { count: 1 });
+			const res = await NekosiaAPI.fetchCategoryImages('invalid-category', { count: 1 });
 
 			expect(res.success).toBe(false);
 			expect(res.status).toBe(400);
 		});
 
 		it('should return a specified number of images', async () => {
-			const res = await NekosiaAPI.fetchImages('catgirl', { count: 3 });
+			const res = await NekosiaAPI.fetchCategoryImages('catgirl', { count: 3 });
 
 			expect(res).toBeInstanceOf(Object);
 			expect(res.success).toBe(true);
 			expect(res.status).toBe(200);
-			expect(res.count).toBe(3);
 			expect(res).toHaveProperty('images');
 			expect(res.images).toBeInstanceOf(Array);
 			expect(res.images.length).toBe(3);
 		});
 	});
 
-	describe('fetchShadowImages', () => {
-		it('should handle no images found for shadow category with additional tags', async () => {
-			const res = await NekosiaAPI.fetchShadowImages({ count: 1, additionalTags: ['wTbf8J0TirS6a4fO5uyKcRazZOlO5h6o', 'xX9f9pwDAgsM3Li1LwsJ3tXQfGKW4WA0'] });
+	describe('fetchImages', () => {
+		it('should handle no images found for nothing category with additional tags', async () => {
+			const res = await NekosiaAPI.fetchImages({ count: 1, tags: ['wTbf8J0TirS6a4fO5uyKcRazZOlO5h6o', 'xX9f9pwDAgsM3Li1LwsJ3tXQfGKW4WA0'] });
 
 			expect(res.success).toBe(false);
 			expect(res.status).toBe(400);
 		});
 
 		it('should throw an error if additionalTagsArray is empty', async () => {
-			await expect(NekosiaAPI.fetchShadowImages([])).rejects.toThrow('`additionalTags` must be a non-empty array for the shadow 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 () => {
-			const res = await NekosiaAPI.fetchImages('catgirl', { count: 'invalid' });
+			const res = await NekosiaAPI.fetchCategoryImages('catgirl', { count: 'invalid' });
 			expect(res.success).toBe(false);
 			expect(res.status).toBe(400);
-			expect(res.message).toBe('Invalid count parameter. Expected a number between 1 and 48.');
+			expect(res.message).toBe('Invalid count parameter. Expected a number between 1 and 48 (>48).');
 		});
 	});
 
 	describe('fetchById', () => {
 		it('should fetch an image by ID if it exists', async () => {
-			const res = await NekosiaAPI.fetchImages('catgirl', { count: 1 });
+			const res = await NekosiaAPI.fetchCategoryImages('catgirl', { count: 1 });
 
 			if (res.success && res.id) {
 				const id = res.id;
@@ -100,10 +99,10 @@ describe('NekosiaAPI (API Tests)', () => {
 		});
 
 		it('should return an error response for invalid ID format', async () => {
-			const res = await NekosiaAPI.fetchById('12345');
+			const res = await NekosiaAPI.fetchCategoryImages('12345');
 			expect(res.success).toBe(false);
 			expect(res.status).toBe(400);
-			expect(res.message).toBe('The image with the provided identifier was not found.');
+			expect(res.message).toBe('No images matching the specified criteria were found. See https://nekosia.cat/documentation?page=api-endpoints#tags-and-categories');
 		});
 	});
 

package/test/integration.test.js

@@ -43,30 +43,30 @@ describe('NekosiaAPI', () => {
 		});
 	});
 
-	describe('fetchImages', () => {
+	describe('fetchCategoryImages', () => {
 		it('should build correct endpoint and make request for given category', async () => {
 			const mockResponse = { data: { results: [] } };
 			https.get.mockResolvedValue(mockResponse);
 
 			const expectedEndpoint = 'https://api.nekosia.cat/api/v1/images/catgirl?count=2&additionalTags=cute';
-			const res = await NekosiaAPI.fetchImages('catgirl', { count: 2, additionalTags: 'cute' });
+			const res = await NekosiaAPI.fetchCategoryImages('catgirl', { count: 2, additionalTags: 'cute' });
 
 			expect(res).toEqual(mockResponse);
 			expect(https.get).toHaveBeenCalledWith(expectedEndpoint);
 		});
 	});
 
-	describe('fetchShadowImages', () => {
+	describe('fetchImages', () => {
 		it('should throw an error if additionalTags is empty', async () => {
-			await expect(NekosiaAPI.fetchShadowImages({})).rejects.toThrow('`additionalTags` must be a non-empty array for the shadow category');
+			await expect(NekosiaAPI.fetchImages({})).rejects.toThrow('`tags` must be a non-empty array');
 		});
 
 		it('should correctly call fetchImages with additionalTags', async () => {
 			const mockResponse = { data: { results: [] } };
 			https.get.mockResolvedValue(mockResponse);
 
-			const expectedEndpoint = 'https://api.nekosia.cat/api/v1/images/shadow?count=1&additionalTags=dark,shadow';
-			const res = await NekosiaAPI.fetchShadowImages({ count: 1, additionalTags: ['dark', 'shadow'] });
+			const expectedEndpoint = 'https://api.nekosia.cat/api/v1/images/nothing?count=1&additionalTags=dark,shadow';
+			const res = await NekosiaAPI.fetchImages({ count: 1, tags: ['dark', 'shadow'] });
 
 			expect(res).toEqual(mockResponse);
 			expect(https.get).toHaveBeenCalledWith(expectedEndpoint);

package/types/index.d.ts

@@ -5,43 +5,48 @@ declare module 'nekosia.js' {
     type AllTagsList = typeof TAGS[number];
 
     /**
-     * Configuration options for the `fetchImages` function.
+     * Configuration options for the `fetchCategoryImages` function.
      */
-    interface FetchImagesOptions {
+    interface FetchImagesCategoryOptions {
         /**
          * Session type:
-         * - `id` - Session identified by the `id` value (requires the `id` field to be set).
+         * - `id` - Session identified by its `id` value (requires the `id` field to be set).
          * - `ip` - Session identified by the user's IP address.
+         * @type String
          * @default undefined
          */
         session?: 'id' | 'ip';
 
         /**
          * Identifier of the fetched image.
-         * @example 66ae26a07886f165901e8a3f
+         * @type String
+         * @example "66ae26a07886f165901e8a3f"
          */
         id?: string;
 
         /**
-         * The number of images to fetch. WARNING! The higher the number, the more data the server will need to process, which will result in a longer response time.
+         * The number of images to fetch. WARNING! The higher the number, the more data the server will need to process, leading to longer response times.
          *
          * - Minimum - 1
          * - Maximum - 48
+         * @type Number
          * @default 1
          */
         count?: number;
 
         /**
          * Additional tags to include in the image search.
-         * This can be a single string with one tag or an array of strings with multiple tags.
+         * This can be a single string representing one tag or an array of strings for multiple tags.
+         * @type Array
          * @example ["cute", "sakura", "cherry-blossom"]
          * @default []
          */
         additionalTags?: AllTagsList | AllTagsList[];
 
         /**
-         * Tags to exclude during the image search.
-         * This can be a single string with one tag or an array of strings with multiple tags.
+         * Tags to exclude from the image search.
+         * This can be a single string representing one tag or an array of strings for multiple tags.
+         * @type Array
          * @example ["beret", "hat", "short-hair"]
          * @default []
          */
@@ -53,10 +58,76 @@ declare module 'nekosia.js' {
          *
          * Possible values:
          * - `safe`: Suitable for all audiences, contains no explicit or questionable content.
-         * - `questionable`: Contains content that may be sensitive or inappropriate for younger audiences, but not explicit.
+         * - `questionable`: May contain content sensitive or inappropriate for younger audiences, but not explicit.
          * - `nsfw`: Contains explicit content, not safe for work (NSFW).
          *
          * The default value is ALWAYS `safe`.
+         * @type String
+         * @example safe
+         * @default safe
+         */
+        rating?: 'safe' | 'questionable' | 'nsfw';
+    }
+
+    /**
+     * Configuration options for the `fetchImages` function.
+     */
+    interface FetchImagesOptions {
+        /**
+         * Session type:
+         * - `id` - Session identified by its `id` value (requires the `id` field to be set).
+         * - `ip` - Session identified by the user's IP address.
+         * @type String
+         * @default undefined
+         */
+        session?: 'id' | 'ip';
+
+        /**
+         * Identifier of the fetched image.
+         * @type String
+         * @example "66ae26a07886f165901e8a3f"
+         */
+        id?: string;
+
+        /**
+         * The number of images to fetch. WARNING! The higher the number, the more data the server will need to process, leading to longer response times.
+         *
+         * - Minimum - 1
+         * - Maximum - 48
+         * @type Number
+         * @default 1
+         */
+        count?: number;
+
+        /**
+         * Additional tags to include in the image search.
+         * This can be a single string representing one tag or an array of strings for multiple tags.
+         * @type Array
+         * @example ["cute", "sakura", "cherry-blossom"]
+         * @default []
+         */
+        tags?: AllTagsList | AllTagsList[];
+
+        /**
+         * Tags to exclude from the image search.
+         * This can be a single string representing one tag or an array of strings for multiple tags.
+         * @type Array
+         * @example ["beret", "hat", "short-hair"]
+         * @default []
+         */
+        blacklist?: AllTagsList | AllTagsList[];
+
+        /**
+         * Defines the content rating of an image.
+         * The rating indicates the appropriateness of the content, specifying whether the image is suitable for all audiences or contains content that may be sensitive or inappropriate for certain viewers.
+         *
+         * Possible values:
+         * - `safe`: Suitable for all audiences, contains no explicit or questionable content.
+         * - `questionable`: May contain content sensitive or inappropriate for younger audiences, but not explicit.
+         * - `nsfw`: Contains explicit content, not safe for work (NSFW).
+         *
+         * The default value is ALWAYS `safe`.
+         * @type String
          * @example safe
          * @default safe
          */
@@ -68,14 +139,16 @@ declare module 'nekosia.js' {
      */
     interface ImageDetails {
         /**
-         * URL leading to the image.
+         * URL of the image.
+         * @type String
          * @example https://cdn.nekosia.cat/images/maid-uniform/66bc6b7481a59a1cf2c79db5.png
          */
         url: string;
 
         /**
          * Image file extension.
-         * @example `png` or `jpg`, etc.
+         * @type String
+         * @example `png`, `jpg`, etc.
          */
         extension: string;
     }
@@ -86,38 +159,44 @@ declare module 'nekosia.js' {
     interface ImageMetadata {
         /**
          * Image width in pixels.
+         * @type Number
          * @example 1447
          */
         width: number;
 
         /**
          * Image height in pixels.
+         * @type Number
          * @example 2046
          */
         height: number;
 
         /**
          * Image size in bytes.
+         * @type Number
          * @example 1001991
          */
         size: number;
 
         /**
          * Image file extension.
-         * @example jpeg
+         * @type String
+         * @example png
          */
         extension: string;
     }
 
     interface ImageColors {
         /**
-         * Main dominant color of the image in hexadecimal format.
+         * The main dominant color of the image in hexadecimal format.
+         * @type String
          * @example #00FF00
          */
         main: HexColor;
 
         /**
-         * Palette of the 14 most dominant colors in the image, presented in hexadecimal format.
+         * A palette of the 14 most dominant colors in the image, represented in hexadecimal format.
+         * @type Array
          * @example ["#9D78CD", "#454FC0", "#909AEB", "#F5E3F0", "#94498B", "#BEC1EE", "#CD7D67", "#CC98D5", "#E2AE9E", "#F0B4DB", "#2B1C3E", "#4E8DCB", "#F2DABF", "#5CB6C0"]
          */
         palette: HexColor[];
@@ -126,37 +205,43 @@ declare module 'nekosia.js' {
     interface ImageAnime {
         /**
          * The title of the anime from which the image originates. `null` if not applicable.
-         * @example Satsuriku no Tenshi
+         * @type String
+         * @example "Satsuriku no Tenshi"
          */
         title: string | null;
 
         /**
          * The name of the character depicted in the image. `null` if not applicable.
-         * @example Rachel Gardner
+         * @type String
+         * @example "Rachel Gardner"
          */
         character: string | null;
     }
 
     interface ImageSource {
         /**
-         * URL of the source page where the image originates. `null` if not applicable.
+         * The URL of the source page where the image originates. `null` if not applicable.
+         * @type String
          */
         url: string | null;
 
         /**
-         * Direct link to the image. `null` if not applicable.
+         * The direct link to the image. `null` if not applicable.
+         * @type String
          */
         direct: string | null;
     }
 
     interface ArtistDetails {
         /**
-         * Artist's username. `null` if not applicable.
+         * The artist's username. `null` if not applicable.
+         * @type String
          */
         username: string | null;
 
         /**
-         * Link to the artist's profile. `null` if not applicable.
+         * The link to the artist's profile. `null` if not applicable.
+         * @type String
          */
         profile: string | null;
     }
@@ -164,11 +249,13 @@ declare module 'nekosia.js' {
     interface ImageAttribution {
         /**
          * Information about the artist.
+         * @type Object
          */
         artist: ArtistDetails;
 
         /**
-         * Copyright of the artwork. `null` if not applicable.
+         * The copyright of the artwork. `null` if not applicable.
+         * @type String
          */
         copyright: string | null;
     }
@@ -179,99 +266,125 @@ declare module 'nekosia.js' {
     interface ImageResponse {
         /**
          * Indicates whether the operation was successful.
+         * @type Boolean
          * @example true
          */
         success: boolean;
 
         /**
          * HTTP status code of the response.
+         * @type Number
          * @example 200
          */
         status: number;
 
         /**
          * Session key, if applicable, otherwise `null`.
+         * @type String
          */
         key: string | null;
 
         /**
          * Number of images included in the response.
+         * @type Number
          */
         count: number;
 
         /**
-         * Image identifier.
+         * Unique identifier for the image.
+         * @type String
          */
         id: string;
 
         /**
-         * Structure containing the dominant colors of the fetched image.
+         * Object containing the dominant colors of the fetched image.
+         * @type Object
          */
         colors: ImageColors;
 
         /**
-         * Structure containing details about the original and compressed images.
+         * Object containing details about both the original and compressed images.
          */
         image: {
             /**
-             * Original uncompressed image. The file includes EXIF data to acknowledge the artist's work.
+             * The original uncompressed image. Includes EXIF data to credit the artist.
+             * @type Object
              */
             original: ImageDetails;
 
             /**
-             * Compressed image with a smaller size, without quality loss. The file includes EXIF data to acknowledge the artist's work.
+             * The compressed version of the image, reduced in size without quality loss. Includes EXIF data to credit the artist.
+             * @type Object
              */
             compressed: ImageDetails;
         };
 
         /**
-         * Metadata about the original and compressed images.
+         * Metadata for both the original and compressed images.
+         * @type Object
          */
-        metadata: { original: ImageMetadata; compressed: ImageMetadata; };
+        metadata: { original: ImageMetadata; compressed: ImageMetadata };
 
         /**
-         * Category to which the image belongs.
-         * @example catgirl
+         * The category the image belongs to.
+         * @type String
+         * @example "catgirl"
          */
         category: string;
 
         /**
-         * Tags assigned to the image.
+         * Tags associated with the image.
+         * @type Array
          */
         tags: string[];
 
         /**
          * Content rating of the image.
          *
-         * `safe` - Image safe to display in any situation.
+         * `safe` - Image safe for all audiences.
          *
-         * `questionable` - Image may contain content inappropriate for some viewers.
+         * `questionable` - Image may contain content unsuitable for some viewers.
          *
-         * `nsfw` - Image contains content intended for adults only (Not Safe For Work).
+         * `nsfw` - Image contains adult content (Not Safe For Work).
          *
+         * @type String
          * @output 'safe' | 'questionable' | 'nsfw'
          */
         rating: 'safe' | 'questionable' | 'nsfw';
 
         /**
-         * Information about the anime (not necessarily an anime) to which the image may belong.
+         * Information about the anime (or related media) the image may be associated with.
+         * @type Object
          */
         anime: ImageAnime;
 
         /**
-         * Information about the source of the image.
+         * Details about the source of the image.
+         * @type Object
          */
         source: ImageSource;
 
         /**
-         * Structure containing information about the artist and associated copyright of the image.
+         * Information about the artist and the associated copyright of the image.
+         * @type Object
          */
         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 with an `ImageResponse`.
+     * All methods are asynchronous and return a Promise resolving to an `ImageResponse`.
      */
     export class NekosiaAPI {
         /**
@@ -280,73 +393,88 @@ declare module 'nekosia.js' {
          * @param options - Configuration options for the request (optional).
          * @example
          * const { NekosiaAPI } = require('nekosia.js');
-         * await NekosiaAPI.fetchImages('catgirl', {
+         * await NekosiaAPI.fetchCategoryImages('catgirl', {
          *      count: 1,
          *      additionalTags: ['cute', 'sakura', 'cherry-blossom'],
          *      blacklistedTags: ['beret']
          * });
-         * @returns Promise with an `ImageResponse`.
+         * @type Object
+         * @returns A Promise resolving to an `ImageResponse`.
          */
-        fetchImages(category: AllTagsList, options?: FetchImagesOptions): Promise<ImageResponse>;
+        static fetchCategoryImages(category: AllTagsList, options?: FetchImagesCategoryOptions): Promise<ImageResponse>;
 
         /**
          * Fetches images based solely on the tags provided by the user. The main category does not affect the image selection as it is not provided here.
          * @param options - Configuration options for the request (optional).
          * @example
          * const { NekosiaAPI } = require('nekosia.js');
-         * await NekosiaAPI.fetchShadowImages({
+         * await NekosiaAPI.fetchImages({
          *      count: 1,
-         *      additionalTags: ['catgirl', 'foxgirl'],
-         *      blacklistedTags: ['dog-girl']
+         *      tags: ['catgirl', 'foxgirl'],
+         *      blacklist: ['dog-girl']
          * });
-         * @returns Promise with an `ImageResponse`.
+         * @type Object
+         * @returns A Promise resolving to an `ImageResponse`.
+         */
+        static fetchImages(options?: FetchImagesOptions): Promise<ImageResponse>;
+
+        /**
+         * Fetches the latest array with tags, anime titles, and characters
+         * @returns A Promise resolving to an `ImageResponse`.
          */
-        fetchShadowImages(options?: FetchImagesOptions): Promise<ImageResponse>;
+        static fetchTags(id: string): Promise<TagsResponse>;
 
         /**
          * Fetches an image by its identifier.
          * @param id - The image identifier (e.g., `66ae26a07886f165901e8a3f`).
-         * @returns Promise with an `ImageResponse`.
+         * @type Object
+         * @returns A Promise resolving to an `ImageResponse`.
          */
-        fetchById(id: string): Promise<ImageResponse>;
+        static fetchById(id: string): Promise<ImageResponse>;
     }
 
     /**
-     * JSON object response from the API regarding the current version of the API and related information.
+     * JSON object response from the API containing information about the current version and related details.
      */
     interface APIVersion {
         /**
          * HTTP status code of the response.
+         * @type Number
          * @example 200
          */
         status: number;
 
         /**
          * Indicates whether the request was successful.
+         * @type Boolean
          * @example true
          */
         success: boolean;
 
         /**
          * The current version of the API.
-         * @example 1.0.0
+         * @type String
+         * @example "1.0.0"
          */
         version: string;
 
         /**
          * URL to the API documentation.
-         * @example https://nekosia.cat/documentation
+         * @type String
+         * @example "https://nekosia.cat/documentation"
          */
         documentation: string;
 
         /**
-         * Contact email.
-         * @example contact@nekosia.cat
+         * Contact email for inquiries.
+         * @type String
+         * @example "contact@nekosia.cat"
          */
         contact: string;
 
         /**
-         * List of available API numbers.
+         * List of available API versions.
+         * @type Array
          * @example [1]
          */
         apis: number[];
@@ -357,15 +485,17 @@ declare module 'nekosia.js' {
      */
     export const NekosiaVersion: {
         /**
-         * Get the current version of the module.
-         * @example 1.1.0
-         * @returns String with the module version.
+         * Retrieves the current version of the module.
+         * @example "1.1.0"
+         * @type String
+         * @returns A string representing the module version.
          */
         module: string;
 
         /**
-         * Get the current API version and related information.
-         * @returns Promise that resolves to an `APIVersion` object.
+         * Fetches the current API version and related information.
+         * @type Object
+         * @returns A Promise that resolves to an `APIVersion` object.
          */
         api(): Promise<APIVersion>;
     };

package/types/tags.ts

@@ -1,3 +1,3 @@
-export const TAGS = [
-    'absolute-territory', 'after-the-rain', 'afternoon-tea', 'ahoge', 'air-comiket', 'ajitani-hifumi', 'akazukin', 'aksktrpg', 'akura', 'alice-in-wonderland', 'alice-margatroid', 'alice-tendou', 'alllisso', 'alluring-face', 'alone', 'amamine', 'amamineko-cafe', 'amashiro-natsuki', 'ame-nochi-yuki', 'ameto-yuki', 'angel', 'angry', 'angry-face', 'apex', 'apple', 'apple-pie', 'apron-dress', 'aqua', 'aquarium', 'areola-slip', 'aria-tsukushi', 'arknights', 'arknights-battle-illustration-contest', 'armed-girls', 'armpits', 'ashen-hair', 'ass', 'assault-rifle', 'autumn', 'autumn-leaves', 'axillary-costume', 'azki', 'azkiart', 'azur-lane', 'azur-lane-fleet', 'baby-face', 'babydoll', 'background', 'balloon', 'balloons', 'bandages', 'bandaid', 'bangtail', 'bare-feet', 'bare-soles', 'barefoot', 'barefoot-school-uniform', 'basketball', 'basketball-uniform', 'bath-time', 'bath-towel', 'beach', 'beach-ball', 'beast-girl', 'beautiful', 'beautiful-breasts', 'beautiful-reimu', 'bed', 'bed-hair', 'bedroom', 'belly', 'belly-glimpse', 'bellybutton', 'bench', 'beret', 'bewitching-thighs', 'big-breasts', 'bikini', 'bikini-top', 'birthday', 'black-and-white', 'black-bikini', 'black-dress', 'black-hair', 'black-hair-with-red-eyes', 'black-knee-high-socks', 'black-ribbon', 'black-sailor-uniform', 'black-shoes', 'black-stockings', 'black-thigh-high-socks', 'black-thigh-highs', 'black-tights', 'black-twintails', 'blazer', 'blonde', 'bloomers', 'blue', 'blue-archive', 'blue-eues', 'blue-eyes', 'blue-hair', 'blue-ribbon', 'blue-ribbono', 'blue-shoes', 'blue-skirt', 'blue-sky', 'bluearchive', 'blushing', 'bocchi-chan', 'botamochi', 'bottomless', 'bouquet', 'boy-cut', 'bra', 'braid', 'breast-hold', 'breasts', 'bride', 'brown-hair', 'bubble-tea', 'bubblegum', 'bue-eyes', 'bunny-ears', 'bunny-girl', 'butterfly', 'by-the-window', 'cable-knitting', 'cake', 'cameltoe', 'camisole', 'camisole-dress', 'canal', 'candy', 'candy-apple', 'car', 'cardigan', 'cardigan-uniform', 'casual-wear', 'cat', 'cat-and-girl', 'cat-ears', 'cat-ears-hat', 'cat-ears-headphones', 'cat-ears-hoodie', 'cat-ears-maid', 'cat-lingerie', 'cat-mouth', 'cat-pose', 'cat-tail', 'catgirl', 'celia-claire', 'celica', 'cheeks', 'cheerleader', 'chericot-rozel', 'cherry', 'cherry-blossom', 'cherry-petals', 'chest-outline', 'chibi', 'chihuahua', 'chin-resting', 'china-dress', 'chinese-lolita', 'chinese-style', 'chino', 'chino-kafuu', 'chitosezaka-suzu', 'chiyu', 'chocolate', 'chocolate-mint', 'choker', 'christmas', 'chuuni', 'classroom', 'cloak', 'closed-eyes', 'clouds', 'coffee', 'collar', 'collarbone', 'comic-treasure', 'confused', 'cookie', 'corset', 'cosmos', 'costume-change', 'crossed-legs', 'crying', 'cuite', 'cutaway-shoulder', 'cute', 'cute-cat', 'cuteness-is-justice', 'cyber', 'dakimakura-cover', 'dango', 'detexted', 'dnf', 'dog-and-girl', 'dog-ears', 'dog-girl', 'doggirl', 'donut', 'doujin', 'drawers', 'drawing-a-sword', 'dress', 'dress-shirt', 'dungeon-fighter-online', 'dvdart', 'ear-cleaning', 'elementary-school-student', 'elevator', 'enticing-brassiere', 'epic-seven', 'epic-seven-fan-art-illustration-contest', 'exposed-back', 'eye-mask', 'eyepatch', 'fairy-eye', 'fairy-tale', 'fallenshadow', 'fan-work', 'fantasy', 'fantasy-girl', 'feather-ears', 'feet', 'felicia-lulufleur', 'festival-of-white', 'fishnets', 'flare-skirt', 'flared-bikini', 'flat-chest', 'flower', 'flowers-and-girls', 'footwear', 'forest', 'fox-ears', 'fox-mask', 'fox-shrine-maiden', 'foxgirl', 'frills', 'fubuki-shiragami', 'fubuki-shiragami-fanart', 'futaba-sharo', 'fuwamoco', 'fuwawa', 'fuwawa-abyssgard', 'fuyoyo', 'fuzzy', 'fwmcpix', 'game', 'game-pad', 'gamer', 'gamer-girl', 'ganbare-ganbare', 'garter', 'garter-ring', 'garter-stockings', 'garterbelt', 'gawr-gura', 'gawrgura', 'gawrt', 'genshin-impact', 'gensokyo-in-spring', 'getting-dressed', 'gijinka', 'girl', 'girls', 'girls-frontline', 'glasses', 'gloves', 'gothic-lolita', 'greek-foot', 'green-eyes', 'green-hair', 'green-ribbon', 'guildcq', 'guitar', 'gun', 'gym-uniform', 'hairdressing', 'hairpin', 'hairstyle-change', 'hakui-koyori', 'half-pants', 'half-pigtails', 'half-up-hairstyle', 'halloween', 'halo', 'hamico', 'hammann', 'han-costume', 'hanami', 'hand-held-pigtails', 'hand-on-crotch', 'handcuffs', 'hands-forming-a-heart', 'harness', 'haruhara-shun', 'hayate-hisakawa', 'hazakura-chikori', 'headband', 'headboard-angle', 'headdress', 'headphone', 'headphones', 'headset', 'heart', 'heart-eyes', 'heartbreak', 'hearts', 'hedgehog', 'heels', 'heterochromia', 'hibiki', 'hibiscus', 'high-angle', 'high-leg-panties', 'high-school-girl', 'high-waisted-skirt', 'hiiro', 'hikaru', 'himura-moritaka', 'hirakata-kana', 'hizuki-miu', 'hizuki-rurufu', 'holding-hands-with-fingers-interlocked', 'holding-ice-in-mouth', 'holoadvent', 'hololive', 'hololive-en', 'hololive-english', 'hololiveen', 'holox', 'hong', 'hood', 'hoodie', 'hoshi', 'hoshino', 'hoshizora-no-memoria', 'hot-pants', 'hot-spring', 'houzuki-michiru', 'hu-tao', 'hutao', 'hyerang', 'ice-cream', 'ichigori-ena', 'idol', 'illumination', 'in-the-train', 'incredibly-cute', 'indie-virtual-youtuber', 'infamous-left-foot-defense', 'inflatable-pool', 'inner-color', 'inugami-korone', 'iochi-mari', 'itigori-ena', 'itou-yuna', 'izayoi-nonomi', 'jagged-sclera', 'japanese-clothes', 'japanese-maid', 'japanese-style', 'japanese-style-maid', 'japanese-umbrella', 'jersey', 'jk', 'joint-work', 'jumper-skirt', 'just-woke-up', 'kabashima-hana', 'kamiko-kana', 'kamioka-chiroru', 'kamisato-ayaka', 'kamiyama-shiki', 'kancolle', 'kantai-collection', 'kanzaki-ririka', 'karyl', 'katana', 'katcolle', 'kazari-rua', 'kigurumi', 'kimono', 'kimono-dress', 'kindergarten-pupil', 'kingdom', 'kirakira-monstars', 'kiryuu-kikyou', 'kitchen', 'knee-high-socks', 'kneeling', 'knockout-knockers', 'koahri', 'kohaku-nene', 'koharu', 'koiko-irori', 'koito-amuno', 'kokoro-amamiya', 'korie-riko', 'korone', 'koyori-hakui', 'koyori-sketch', 'kuda-izuna', 'kuro-namako', 'kuromi-serika', 'kuroneko', 'kurose-kiri', 'kyaru', 'lancat', 'lanmewko', 'lap-pillow', 'laplus-darkness', 'large-breasts', 'lattice-tower', 'leaning-forward', 'left-foot-shield', 'legato', 'leggings', 'lemon', 'leo', 'lifted-clothing', 'lily-of-the-valley', 'lime', 'lingerie', 'little-devil', 'lolicon-bait', 'lolipop-complete', 'lolita', 'lolita-fashion', 'lollipop', 'long-black-hair', 'long-blond-hair', 'long-gloves', 'long-hair', 'long-pink-hair', 'long-red-hair', 'long-white-gloves', 'long-white-hair', 'loungewear', 'lying-down', 'lying-on-one-side', 'macaron', 'machikaze-fuuna', 'mad', 'magical-girl', 'mahiro-oyama', 'maid', 'maid-bikini', 'maid-day', 'maid-uniform', 'makeup', 'mari-iochi', 'marie', 'marine-day', 'marine-look', 'maruro', 'mascot', 'matsumiya-kiseri', 'mayoi-shigure', 'mea-kagura', 'medium-hair', 'metaljelly', 'mf-bunko-j', 'middle-school-student', 'midriff', 'mihoshi-mei', 'miike-chan', 'mika', 'mika-misono', 'mikeneko', 'mikeneko-fanart', 'miko', 'minami-kotone', 'mini-hakama', 'miniskirt', 'miniskirt-miko', 'mirror', 'miu-channel', 'miu-hizuki', 'mizuki', 'mizukiart', 'mococo', 'mococo-abyssgard', 'mofumies', 'mole-under-the-eye', 'moon', 'msi', 'murasaki-shion', 'myoya', 'nachoneko', 'nagi-hisakawa', 'nail-polish', 'naked-navel', 'nap', 'natori-sana', 'navel-piercing', 'necktie', 'necomi', 'needs-to-be-appreciated-more', 'negligee', 'nekoha-shizuku', 'nekokobushi', 'nekomata-okayu', 'new-year', 'newsboy-cap', 'night', 'night-sky', 'nijisanji', 'nikke', 'nine-tailed', 'nkshoujo', 'no-game-no-life', 'noire', 'nolan', 'nonaka-yuu', 'not-wearing-any-panties', 'nurse', 'off-shoulder', 'off-shoulder-dress', 'okomeillust', 'okusora-ayane', 'old-fashioned-school-swimsuit', 'older-girl', 'omochi-box', 'omochi-monaka', 'one-eye-covered', 'one-piece', 'one-piece-swimsuit', 'ookami-mio', 'open-shirt', 'orange-ribbon', 'otokonoko', 'overalls', 'overly-long-sleeves', 'pajama', 'pajamas', 'panchira', 'panties', 'pantsu', 'panty-peek', 'pantyhose', 'parasol', 'parfait', 'patting', 'paw-pads', 'peace-sign', 'pee-holding', 'pekora-usada-fanart', 'personification-of-drinks', 'photo-editing', 'photoshop', 'piink', 'pillow', 'pinching-garments', 'pink', 'pink-eyes', 'pink-hair', 'pink-ribbon', 'pink-shoes', 'pink-skirt', 'pink-sweater', 'pink-twintails', 'plaid-pattern', 'plaid-skirt', 'plastic-bottle', 'platform', 'playing-cards', 'plump-thighs', 'plushie', 'pocky-day', 'pointy-ears', 'ponytail', 'pool', 'pool-at-night', 'porch', 'present', 'princess-connect', 'prone-position', 'psycho', 'purple-ears', 'purple-eyes', 'purple-hair', 'purple-ribbon', 'queen-of-hearts', 'rabbit-girl', 'ragna-doll', 'railroad-crossing', 'railway', 'rain', 'rainy-season', 'ramune', 'randoseru', 'rawr', 're-oekaki', 'red-and-blue', 'red-eyes', 'red-hair', 'red-pigtails', 'red-ribbon', 'red-shoes', 'red-skirt', 'reflected-glare', 'reimu-hakurei', 'remilia-scarlet', 'remiliacn', 'rena-yorumi', 'reverse-sitting', 'rhodes', 'ribbed-fabric', 'ribbon', 'ribbonos', 'ribbons', 'ringo-chan', 'roar', 'rocket-launcher', 'roxanne', 'rribbon', 'rubbib', 'rucaco', 'rukako', 'ruki-roki', 'rumi', 'runa-shinomiya', 'rushia-uruha', 'sad', 'saekiya-sabou', 'saiba-midori', 'saiba-momoi', 'sailor', 'sailor-dress', 'sailor-one-piece', 'sailor-swimsuit', 'sailor-uniform', 'sakamata-chloe', 'sakura', 'sakura-miko', 'sakuraba-moeka', 'sakurai-hana', 'sand', 'sandals', 'santa', 'santa-cosplay', 'sassy-loli', 'scared', 'scarf', 'scenery', 'sch', 'school-girl', 'school-swimsuit', 'school-uniform', 'school-uniform-cardigan', 'school-uniform-hoodie', 'schoolgirl', 'sea', 'see-through', 'selfie', 'serena-hanazono', 'setokane', 'shano-hiyori', 'shanoa-asmr', 'shigure', 'shimapan', 'shiori', 'shirakami-fubuki', 'shirakawa-yumea', 'shirasu-azusa', 'shiroko-terror', 'shiromichan', 'short-boots', 'short-haircut', 'short-pants', 'short-white-hair', 'shouu-kun', 'showgirl', 'side-string-bikini', 'side-tie-panty', 'silver-hair', 'silver-long-hair', 'singer', 'sisters', 'sitting', 'sitting-on-feet', 'sitting-with-hands-around-knees', 'skirt', 'skirt-lift', 'sleep', 'sleep-wear', 'sleeping-face', 'sleepy', 'sleepy-face', 'sleeveless', 'sleeveless-dress', 'sleeveless-parka', 'small-breasts', 'small-fangs', 'smile', 'snack-nili', 'snow', 'snow-leopard', 'snowman', 'socks', 'sofa', 'sole', 'somna', 'sotis', 'spiked-bat', 'spiral-eyes', 'splashes', 'spring', 'squirrel', 'stairs', 'standing-picture', 'starlight-stage', 'starry-sky', 'starry-sky-dress', 'steamed-bun-with-meat-filling', 'stirrup-leggings', 'stockings', 'straight-fringe', 'strap-shoes', 'strapless', 'straw-hat', 'strawberries', 'strawberry', 'string-ribbon', 'striped-bikini', 'striped-knee-highs', 'striped-thigh-high-socks', 'subculture', 'sukumizu', 'summer', 'summer-dress', 'summer-kimono', 'summer-pockets', 'summer-sky', 'sunaookami-shiroko', 'sunflower', 'sunflowers', 'sunglasses', 'sunohara-kokona', 'sunset', 'supine', 'suspender-skirt', 'suzuho-hotaru', 'sweat', 'sweater', 'swim-ring', 'swimsuit', 'swimsuit-parka', 'swimwear', 'sword', 't-shirt', 'tail', 'tail-from-under-skirt', 'tail-with-ribbon', 'taiwan', 'takanashi-hoshino', 'tattoo', 'tea', 'tea-time', 'tears', 'teary-eyed', 'teary-eyes', 'teketi', 'telephone', 'tenshinoikenie', 'the-person-behind', 'the-soles-of-feet-in-socks', 'theriantrope', 'thick-eyebrows', 'thigh-high-socks', 'thigh-highs', 'thighhighs', 'thighs', 'tie-side-bikini', 'tiger', 'tight', 'tired', 'toes', 'tokoshibyra', 'tongue-out', 'touhou', 'touhou-project', 'towel', 'transparency', 'tropical-fish', 'tsugiri-noa', 'tsurara', 'twin-pig-tails', 'twin-ponytails', 'twins', 'twintails', 'two-shot', 'uise-iu', 'umbrella', 'underwater', 'uniform', 'upwards-gaze', 'uruha-rushia-fanart', 'usada-pekora', 'usagigo', 'valentine', 'vampire', 'vdonburi', 'verslll', 'virtual', 'virtual-esports-project', 'vrchat', 'vtuber', 'w-sitting', 'waitress', 'wallpaper', 'water', 'water-surface', 'watermelon', 'wearing-only-a-shirt', 'wedding-dress', 'wet', 'wet-see-through', 'what-is-this-cuteness', 'white', 'white-bikini', 'white-cat', 'white-day', 'white-dress', 'white-hair', 'white-hairpin', 'white-high-socks', 'white-knee-high-socks', 'white-ribbon', 'white-sailor-uniform', 'white-school-swimsuit', 'white-socks', 'white-stockings', 'white-swimsuit', 'white-thigh-high-socks', 'white-tiger', 'white-tights', 'wide-brim-hat', 'wind-chime', 'winer', 'wings', 'wink', 'winter', 'witch', 'wolf-ears', 'wolf-girl', 'women-in-parka', 'yandere', 'yawn', 'year-of-the-tiger', 'yellow-bikini', 'yellow-eyes', 'yellow-hair', 'yellow-ribbon', 'yoko', 'young-girl', 'youtuber', 'yozuki-mofu', 'yuika-shiina', 'yukata', 'yukihana-lamy', 'yukikaze', 'yutori-natsu'
-] as const;
+export const TAGS = ['absolute-territory','after-the-rain','afternoon-tea','ahoge','ajitani-hifumi','akazukin','aksktrpg','akura','alice-in-wonderland','alice-margatroid','alice-tendou','alllisso','alluring-face','alona','alone','amamine','amamineko-cafe','amashiro-natsuki','ame-nochi-yuki','ameto-yuki','angel','angry-face','animal-ears','apex','apple','apple-caramel','apple-pie','apron-dress','aqua','aquarium','areola-slip','aria-tsukushi','arknights','arknights-battle-illustration-contest','armed-girls','armpits','ashen-hair','assault-rifle','autumn','autumn-leaves','axillary-costume','azki','azkiart','azur-lane','babydoll','back-alley','background','balloon','balloons','bandages','bandaid','bangtail','bare-feet','bare-soles','barefoot','basketball','basketball-uniform','bath-time','bath-towel','beach','beach-ball','bear-ears','beargirl','beast-girl','beautiful','beautiful-reimu','bed','bed-hair','bedroom','belly','belly-glimpse','bellybutton','bench','beret','bewitching-thighs','bikini','bikini-top','birthday','black-and-white','black-bikini','black-dress','black-hair','black-hair-with-red-eyes','black-knee-high-socks','black-ribbon','black-sailor-uniform','black-shoes','black-skirt','black-stockings','black-thigh-high-socks','black-thigh-highs','black-tights','blazer','blonde','bloomers','blue-archive','blue-eues','blue-eyes','blue-hair','blue-ribbon','blue-shoes','blue-skirt','blue-sky','blushing','bocchi-chan','bondage','botamochi','bottomless','boy-cut','bra','braid','breast-hold','breasts','bride','brown-hair','bubble-tea','bunny-ears','bunny-girl','butterfly','by-the-window','cable-knitting','cake','cameltoe','camisole','camisole-dress','canal','candy','candy-apple','car','cardigan','cardigan-uniform','casual-wear','cat','cat-and-girl','cat-ears','cat-ears-hat','cat-ears-headphones','cat-ears-hoodie','cat-ears-maid','cat-mouth','cat-paws','cat-pose','cat-tail','catboy','catgirl','cats','celia-claire','celica','cheeks','cheerleader','chericot-rozel','cherry','cherry-blossom','cherry-petals','chess','chest-outline','chibi','chihuahua','chin-resting','chinese-lolita','chinese-style','chino','chino-kafuu','chitosezaka-suzu','chiyu','chocolate','chocolate-mint','choker','christmas','chuuni','classroom','cloak','closed-eyes','clouds','cocoa-hoto','coffee','collar','comic-treasure','confused','cookie','corset','cosmos','costume-change','cross-halter-bikini','crossed-legs','crying','cuite','cutaway-shoulder','cute','cute-cat','cuteness-is-justice','dakimakura-cover','dango','detexted','dog-and-girl','dog-ears','dog-girl','doll','donut','doujin','drawers','drawmei','dress','dress-shirt','dvdart','elementary-school-student','elevator','enticing-brassiere','epic-seven','exposed-back','eye-mask','eyepatch','fairy-eye','fairy-tale','fallenshadow','fantasy','fantasy-girl','feather-ears','feet','felicia-lulufleur','festival-of-white','firefly','fishnets','flare-skirt','flared-bikini','flat-chest','floral-playing-cards','flower','flowers-and-girls','forest','fox','fox-ears','fox-mask','fox-shrine-maiden','foxgirl','frills','fubuki-shiragami','fubuki-shiragami-fanart','fuwamoco','fuwawa-abyssgard','fuyoyo','fuzzy','fwmcpix','game','game-pad','gamer','gamer-girl','ganbare-ganbare','garter','garterbelt','gawr-gura','genshin-impact','gensokyo-in-spring','getting-dressed','gijinka','girl','girls','girls-frontline','glasses','gloves','gothic-lolita','greek-foot','green-eyes','green-hair','green-ribbon','guildcq','guitar','gun','gym-uniform','hairdressing','hairpin','hairstyle-change','hajime-todoroki','hakui-koyori','half-pants','half-pigtails','half-up-hairstyle','halloween','halo','hamico','hammock','han-costume','hanami','hands-forming-a-heart','harness','haruhara-shun','hayate-hisakawa','hazakura-chikori','headband','headboard-angle','headdress','headphone','headphones','headset','heart','heart-eyes','heartbreak','hearts','hedgehog','heels','herta','heterochromia','hibiki','hibiscus','high-angle','high-school-girl','high-waisted-skirt','hiiro','hikaru','himura-moritaka','hizuki-miu','hizuki-rurufu','holding-hands-with-fingers-interlocked','holding-ice-in-mouth','hololive','hololive-en','hololive-english','hololiveen','holox','hong','honkaistarrail','hood','hoodie','hoshi','hoshino','hoshitsuki-neiro','hoshizora-no-memoria','hot-spring','houzuki-michiru','hu-tao','hutao','hydrangea','ice-cream','ichigo','ichigori-ena','idol','illumination','in-the-train','incredibly-cute','indie-virtual-youtuber','indie-vtuber','indoor-shoes','infamous-left-foot-defense','inflatable-pool','inner-color','inugami-korone','itigori-ena','itou-yuna','izayoi-nonomi','jagged-sclera','japanese-clothes','japanese-maid','japanese-style','japanese-style-maid','japanese-umbrella','jersey','jk','jumper-skirt','jumpy','just-woke-up','kabashima-hana','kamiko-kana','kamioka-chiroru','kamisato-ayaka','kamiyama-shiki','kanade-otonose','kancolle','kantai-collection','kanzaki-ririka','karin','karyl','katana','katcolle','kazari-rua','kazueru','kazusa-kyoyama','kigurumi','kimono','kimono-dress','kindergarten-pupil','kingdom','kirakira-monstars','kiryuu-kikyou','kitchen','klee','knee-high-socks','kneeling','knockout-knockers','kohaku-nene','koharu','koiko-irori','koito-amuno','kokoro-amamiya','korie-riko','koyori-hakui','koyori-sketch','kuda-izuna','kuro-namako','kuromi-serika','kuroneko','kyaru','kyouyama-kazusa','lancat','lanmewko','lap-pillow','laplus-darkness','large-breasts','lattice-tower','left-foot-shield','legato','leggings','legs','lemon','leo','lily-of-the-valley','lime','lingerie','little-devil','lolipop-complete','lolita','lolita-fashion','lollipop','long-black-hair','long-blond-hair','long-gloves','long-hair','long-pink-hair','long-red-hair','long-white-gloves','long-white-hair','loungewear','lying-down','lying-on-one-side','macaron','machikaze-fuuna','mad','magical-girl','maid','maid-bikini','maid-uniform','makeup','mari-iochi','marie','marine','marine-day','marine-look','maruro','mascot','matsumiya-kiseri','mayoi-shigure','mea-kagura','medium-hair','mf-bunko-j','middle-school-student','midori-matsukaze','midriff','mihoshi-mei','miike-chan','mika','mika-misono','mikeneko','miko','miku-maekawa','minami-kotone','minato-aqua','mini-hakama','miniskirt','miniskirt-miko','mint','mirror','miu-channel','miu-hizuki','mizukiart','mococo','mococo-abyssgard','mole-under-the-eye','moon','murasaki-shion','muryo','myoya','nachoneko','nagi-hisakawa','nahida','nail-polish','nanashi-mumei','nap','natori-sana','necktie','necomi','needs-to-be-appreciated-more','negligee','nekoha-shizuku','nekomata-okayu','nene-kusanagi','new-year','newsboy-cap','night','night-sky','nijisanji','nikke','nine-tailed','nintendo-switch','nintendoswitch','no-game-no-life','noire','nolan','nonaka-yuu','nurse','off-shoulder','off-shoulder-dress','okomeillust','okusora-ayane','old-fashioned-school-swimsuit','older-girl','omochi-box','omochi-monaka','one-eye-covered','one-piece','one-piece-swimsuit','ookami-mio','open-shirt','orange-hair','orange-ribbon','otokonoko','overalls','overly-long-sleeves','pajamas','panchira','panda-ears','panties','pants','parasol','park','patting','paw-pads','peace-sign','pekora-usada-fanart','personification-of-drinks','photo-editing','pigtails','pillow','pinching-garments','pink','pink-eyes','pink-hair','pink-ribbon','pink-shoes','pink-skirt','pink-sweater','pink-twintails','plaid-pattern','plaid-skirt','plastic-bottle','platform','playing-cards','plump-thighs','plushie','pocky','pointy-ears','polar-bear','ponytail','pool','pool-at-night','porch','present','princess-connect','project-sekai','prone-position','psycho','pu-ht','purple-ears','purple-eyes','purple-hair','purple-ribbon','purple-skirt','queen-of-hearts','rabbit-girl','ragna-doll','railroad-crossing','railway','rain','rainy-season','ramune','randoseru','rawr','re-oekaki','red-and-blue','red-eyes','red-hair','red-pigtails','red-ribbon','red-ribbons','red-skirt','reflected-glare','regloss','reimu-hakurei','reisa-uzawa','remilia-scarlet','rena-yorumi','reverse-sitting','rhodes','ribbed-fabric','ribbon','ribbonos','ribbons','ringo-chan','roar','rocket-launcher','roxanne','rribbon','rubbib','rucaco','rukako','ruki-roki','rumi','runa-shinomiya','rurudo','rurudo-lion','rushia-uruha','sad','saekiya-sabou','saiba-midori','saiba-momoi','sailor','sailor-dress','sailor-one-piece','sailor-swimsuit','sailor-uniform','sakamata-chloe','sakura','sakura-miko','sakuraba-moeka','sakurada-hane','sakuradahane','sakurai-hana','sand','santa','santa-cosplay','sassy-loli','scared','scarf','scenery','school-swimsuit','school-uniform','school-uniform-cardigan','school-uniform-hoodie','schoolgirl','scornful-eyes','sea','see-through','selfie','setokane','shano-hiyori','shanoa-asmr','shigure','shiori','shirai-tanuki','shirakami-fubuki','shirakawa-yumea','shirasu-azusa','shiroko','shiroko-terror','shiromichan','shooting-star','short-boots','short-haircut','short-pants','short-white-hair','shouu-kun','showgirl','shy','side-string-bikini','side-tie-panty','silver-hair','silver-long-hair','singer','sisters','sitting','sitting-on-feet','sitting-with-hands-around-knees','skirt','skirt-lift','skirtm','sleep','sleep-wear','sleeping-face','sleepy','sleepy-face','sleeveless','sleeveless-dress','sleeveless-parka','small-breasts','small-fangs','smile','snack-nili','sneakers','snow','snow-leopard','snowman','snowy-landscape','socks','sofa','sole','somna','sorasaki-hina','spiral-eyes','splashes','spring','squirrel','stairs','standing-picture','starlight-stage','starry-sky','starry-sky-dress','steamed-bun-with-meat-filling','stockings','straight-fringe','strap-shoes','straw-hat','strawberries','strawberry','streaked-hair','string-ribbon','striped-bikini','striped-thigh-high-socks','sukumizu','summer','summer-dress','summer-kimono','summer-pockets','sunaookami-shiroko','sunflowers','sunglasses','sunohara-kokona','sunset','supine','suspender-skirt','suzuho-hotaru','sweat','sweater','sweets','swim-ring','swimsuit','swimsuit-parka','swimwear','swing','sword','t-shirt','tail','tail-from-under-skirt','tail-holding','tail-with-ribbon','taiwan','takanashi','takanashi-hoshino','tattoo','tea','tea-time','tears','teary-eyed','teary-eyes','telephone','tenshinoikenie','test','the-person-behind','the-soles-of-feet-in-socks','theriantrope','thick-eyebrows','thigh-high-socks','thigh-highs','thighhighs','thighs','tie-side-bikini','tiered-dress','tiger','tights','tired','tobu-railway','toes','tokoshibyra','tongue-out','touhou','touhou-project','towel','transparency','trick-or-treat','tropical-fish','tsugiri-noa','twins','twintails','uise-iu','umbrella','underwater','uniform','upwards-gaze','uruha-rushia-fanart','usada-pekora','usagigo','valentine','vampire','vdonburi','vrchat','vtuber','w-sitting','wa-lolita','waitress','wallpaper','water','water-surface','watermelon','weapon','wearing-only-a-shirt','wedding-dress','wet','wet-see-through','white-bikini','white-cat','white-day','white-dress','white-hair','white-hairpin','white-hait','white-high-socks','white-knee-high-socks','white-ribbon','white-sailor-uniform','white-school-swimsuit','white-skirt','white-socks','white-stockings','white-swimsuit','white-thigh-high-socks','white-tiger','white-tights','white-twintails','wings','wink','winter','witch','wolf-ears','wolf-girl','yandere','yaoyao','yawn','yellow-eyes','yellow-hair','yellow-ribbon','yoko','young-boy','young-girl','yuika-shiina','yukata','yukihana-lamy','yukinoshita-peo','yutori-natsu','yuuki-sakuna'] as const;
+
+// https://api.nekosia.cat/api/v1/tags

package/examples/fetchShadowImages.js

@@ -1,6 +0,0 @@
-const { NekosiaAPI } = require('../index.js');
-
-(async () => {
-	const response = await NekosiaAPI.fetchShadowImages({ session: 'ip', count: 1, additionalTags: ['cute', 'blue-hair'] });
-	console.log(response);
-})();