@sefinek/random-emoji 2.1.0 → 2.2.1

package/CHANGELOG.md

@@ -1,14 +1,35 @@
+## 📥・v2.2.1 (28.06.2026)
+1. Quality fixes.
+
+
+## 📥・v2.2.0 (06.12.2025)
+
+### ⚡ Performance
+1. Optimized code with arrow functions and `for...of` loops.
+2. Refactored Promise handling in `getContent()`.
+3. Added `getRandomElement()` helper function.
+
+### ✨ Changes
+1. Updated to `node:https` protocol.
+2. Improved error handling and JSON parsing.
+3. Rewritten TypeScript definitions with proper CommonJS export structure.
+4. Code quality improvements.
+
+### 🧪 Testing
+1. Added Jest test suite with 28 tests.
+
+
 ## 📥・v2.1.0 (20.12.2023)
 
 ### 🎉 Added
 1. New function `<random>.squares` for retrieving random squares.
-2. Added a new example ([examples/table.js](examples/table.js)) demonstrating the use of module functions in a table format.
+2. Added a new example ([examples/table.js](example/table.js)) demonstrating the use of module functions in a table format.
 
 ### ✨ Changes
 1. General code quality improvements.
 2. Enhanced type definitions in [`index.d.ts`](index.d.ts) and expanded documentation.
 3. Improved the emoji randomization mechanism.
-4. Updated example files in the [`examples`](examples) directory.
+4. Updated example files in the [`examples`](example) directory.
 
 
 ## 📥・v2.0.2/v2.0.3 (08.11.2023)
@@ -60,8 +81,8 @@
 
 ## 📥・v1.3.0 (13.05.2022)
 1. Updated README.md file.
-2. Added `new kaomojis()` with random kaomoji from my [API](https://api.sefinek.net). See examples: [[1](https://github.com/sefinek24/random-emoji/blob/main/test.js)] [[2](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis)]
-3. Other changes to [index.js](https://github.com/sefinek24/random-emoji/blob/main/index.js) file.
+2. Added `new kaomojis()` with random kaomoji from my [API](https://api.sefinek.net). See examples: [[1](https://github.com/sefinek/random-emoji/blob/main/test.js)] [[2](https://github.com/sefinek/random-emoji#%EF%B8%8F--kaomojis)]
+3. Other changes to [index.js](https://github.com/sefinek/random-emoji/blob/main/index.js) file.
 
 
 ## 📥・v1.2.0 (12.05.2022)

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2023 Sefinek
+Copyright (c) 2022-2025 Sefinek
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -3,13 +3,20 @@
     <p>Constantly supported Node.js module providing random emojis, including their names and categories. The module also offers random Japanese kaomojis.</p>
     <a href="https://www.npmjs.com/package/@sefinek/random-emoji" target="_blank" title="random-emoji - npm" style="text-decoration:none">
         <img src="https://img.shields.io/npm/dt/@sefinek/random-emoji.svg?maxAge=3600" alt="The number of downloads">
-        <img src="https://img.shields.io/github/issues/sefinek24/random-emoji" alt="Issues">
-        <img src="https://img.shields.io/github/last-commit/sefinek24/random-emoji" alt="Last commit">
-        <img src="https://img.shields.io/github/commit-activity/w/sefinek24/random-emoji" alt="Commit activity">
-        <img src="https://img.shields.io/github/languages/code-size/sefinek24/random-emoji" alt="Code size">
+        <img src="https://img.shields.io/github/issues/sefinek/random-emoji" alt="Issues">
+        <img src="https://img.shields.io/github/last-commit/sefinek/random-emoji" alt="Last commit">
+        <img src="https://img.shields.io/github/commit-activity/w/sefinek/random-emoji" alt="Commit activity">
+        <img src="https://img.shields.io/github/languages/code-size/sefinek/random-emoji" alt="Code size">
     </a>
 </div>
 
+Do you have any questions or want to receive notifications about important changes or new features in my repositories?
+Join my [Discord server](https://discord.gg/S7NDzCzQTg)! If you don't use Discord, you can also open an issue on GitHub.
+
+The project is released under the [MIT license](LICENSE) — you can do whatever you want with it.  
+If you like this repository, leave a star ⭐. Thank you!
+
+
 ## 📥 • Installation
 ```bash
 npm install @sefinek/random-emoji
@@ -17,15 +24,16 @@ npm install @sefinek/random-emoji
 
 
 ## 😻 • Usage
-| Function                                                                                                          | Description                                                 |
-|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
-| [unicode](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L4)  | Get a single emoji                                          |
-| [emojis](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L7)   | Get a random emoji with its name and type                   |
-| [cats](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L11)    | Get a random cat                                            |
-| [hearts](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L14)  | Get a random heart                                          |
-| [foods](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L18)   | Get a random food                                           |
-| [circles](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L22) | Get a random circle                                         |
-| [**new** Kaomojis](#kaomoji-endpoints)                                                                            | Get random kaomojis from the [API](https://api.sefinek.net) |
+| Function                                                                    | Description                                                 |
+|-----------------------------------------------------------------------------|-------------------------------------------------------------|
+| [unicode](https://github.com/sefinek/random-emoji/blob/main/example.js#L4)  | Get a single emoji                                          |
+| [emojis](https://github.com/sefinek/random-emoji/blob/main/example.js#L7)   | Get a random emoji with its name and type                   |
+| [cats](https://github.com/sefinek/random-emoji/blob/main/example.js#L11)    | Get a random cat emoji                                      |
+| [hearts](https://github.com/sefinek/random-emoji/blob/main/example.js#L15)  | Get a random heart emoji                                    |
+| [foods](https://github.com/sefinek/random-emoji/blob/main/example.js#L19)   | Get a random food emoji                                     |
+| [circles](https://github.com/sefinek/random-emoji/blob/main/example.js#L23) | Get a random circle emoji                                   |
+| [squares](https://github.com/sefinek/random-emoji/blob/main/example.js#L27) | Get a random square emoji                                   |
+| [Kaomojis](#kaomoji-endpoints)                                              | Get random kaomojis from the [API](https://api.sefinek.net) |
 
 
 ## 😼 • Examples
@@ -95,18 +103,4 @@ kaomoji.uwu().then(console.log);
 
     
 ## 📝 • Changelog
-> [Click here](CHANGELOG.md)
-
-
-## 🤝 • Help
-Need assistance or have questions about this module? Don't hesitate to open a new [Issue](https://github.com/sefinek24/random-emoji/issues/new) on our GitHub repository.
-Our community is ready to help and provide answers to your inquiries.
-  
-
-## ⭐ • Thank you
-If you use the Random Emoji module and appreciate my work, I'd be grateful if you could give it a star on our [GitHub page](https://github.com/sefinek24/random-emoji).
-Your support helps me continue to develop this project and provide new and fun emojis to every user.
-
-
-## 🎓 • [MIT License](LICENSE)
-Copyright 2023 © by [Sefinek](https://sefinek.net). All Rights Reserved.
+[Click here](CHANGELOG.md)

package/index.d.ts

@@ -1,98 +1,108 @@
-declare module '@sefinek/random-emoji' {
-    /**
-     * Interface representing an emoji with a name, content, and type.
-     * Used in the emoji collection to provide more detailed information about each emoji.
-     */
-    export interface EmojisCollection {
-        content: string;
-        name: string;
-        type: string;
-    }
-
-    /**
-     * Interface representing an emoji with a name and content.
-     * Used for simpler emoji categories like cats, hearts, etc.
-     */
-    export interface Emojis {
-        content: string;
-        name: string;
-    }
-
-    /**
-     * Returns a random emoji from a large collection.
-     * Each emoji includes its name and type.
-     * @returns {EmojisCollection} A random emoji from the collection.
-     */
-    export function emojis(): EmojisCollection;
-
-    /**
-     * Returns a random cat emoji.
-     * @returns {Emojis} A random cat emoji.
-     */
-    export function cats(): Emojis;
-
-    /**
-     * Returns a random circle emoji.
-     * @returns {Emojis} A random circle emoji.
-     */
-    export function circles(): Emojis;
-
-    /**
-     * Returns a random food emoji.
-     * @returns {Emojis} A random food emoji.
-     */
-    export function foods(): Emojis;
-
-    /**
-     * Returns a random heart emoji.
-     * @returns {Emojis} A random heart emoji.
-     */
-    export function hearts(): Emojis;
-
-    /**
-     * Returns a random square emoji.
-     * @returns {Emojis} A random square emoji.
-     */
-    export function squares(): Emojis;
-
-
-    /**
-     * Returns a random Unicode emoji character.
-     * @returns {string} A random Unicode emoji character.
-     */
-    export function unicode(): string;
-
-    /**
-     * Interface representing the response from an API endpoint.
-     * Includes information about the success status, API category, and response message.
-     */
-    export interface ApiResponse {
-        success: boolean;
-        status: number;
-        info: {
-            category: string;
-            endpoint: string;
-        };
-        message: string;
-    }
-
-    /**
-     * Kaomojis class for accessing various random content endpoints.
-     * Allows fetching of random kaomojis from specified endpoints.
-     */
-    export class Kaomojis {
-        constructor();
-
-        /**
-         * Dynamically generated methods for accessing random content endpoints.
-         * Each method returns a Promise that resolves to an ApiResponse.
-         * @returns {Promise<ApiResponse>} A promise resolving to the API response.
-         */
-        [endpoint: string]: () => Promise<ApiResponse>;
-    }
-
-    /**
-     * The current version of the module.
-     */
-    export const version: string;
-}
+/**
+ * Interface representing an emoji with a name, content, and type.
+ */
+interface EmojisCollection {
+	content: string;
+	name: string;
+	type: string;
+}
+
+/**
+ * Interface representing an emoji with a name and content.
+ */
+interface Emojis {
+	content: string;
+	name: string;
+}
+
+/**
+ * Interface representing the response from an API endpoint.
+ */
+interface ApiResponse {
+	success: boolean;
+	status: number;
+	info: {
+		category: string;
+		endpoint: string;
+	};
+	message: string;
+}
+
+/**
+ * Kaomojis class for accessing random kaomoji endpoints.
+ */
+declare class Kaomojis {
+	constructor();
+
+	/**
+	 * Get a random cat kaomoji.
+	 */
+	cat(): Promise<ApiResponse>;
+
+	/**
+	 * Get a random dog kaomoji.
+	 */
+	dog(): Promise<ApiResponse>;
+
+	/**
+	 * Get a random OwO kaomoji.
+	 */
+	owo(): Promise<ApiResponse>;
+
+	/**
+	 * Get a random UwU kaomoji.
+	 */
+	uwu(): Promise<ApiResponse>;
+
+	/**
+	 * Get a random love kaomoji.
+	 */
+	love(): Promise<ApiResponse>;
+}
+
+declare namespace RandomEmoji {
+	/**
+	 * Returns a random emoji from a large collection.
+	 * Each emoji includes its name and type.
+	 */
+	function emojis(): EmojisCollection;
+
+	/**
+	 * Returns a random cat emoji.
+	 */
+	function cats(): Emojis;
+
+	/**
+	 * Returns a random circle emoji.
+	 */
+	function circles(): Emojis;
+
+	/**
+	 * Returns a random food emoji.
+	 */
+	function foods(): Emojis;
+
+	/**
+	 * Returns a random heart emoji.
+	 */
+	function hearts(): Emojis;
+
+	/**
+	 * Returns a random square emoji.
+	 */
+	function squares(): Emojis;
+
+	/**
+	 * Returns a random Unicode emoji character.
+	 */
+	function unicode(): string;
+
+	/**
+	 * The current version of the module.
+	 */
+	const version: string;
+
+	export { Kaomojis };
+}
+
+export = RandomEmoji;

package/index.js

@@ -1,4 +1,5 @@
-const { get } = require('https');
+const { get } = require('node:https');
+
 const emojis = {
 	emojis: require('./data/emoji/collection/big.json'),
 	cats: require('./data/emoji/cat.json'),
@@ -9,57 +10,61 @@ const emojis = {
 	unicode: require('./data/emoji/collection/single.json'),
 };
 const endpoints = require('./data/endpoints.json');
-const { version } = require('./package.json');
+const { name, version, devDependencies } = require('./package.json');
 
 const httpOptions = {
 	method: 'GET',
 	headers: {
-		'User-Agent': `Mozilla/5.0 (compatible; random-emoji/${version}; +https://github.com/sefinek24/random-emoji)`,
-		'Accept': 'application/json',
-		'Cache-Control': 'no-cache',
-		'Connection': 'keep-alive',
-		'DNT': '1',
-		'Pragma': 'no-cache',
-		'Referrer-Policy': 'strict-origin-when-cross-origin',
-		'X-Content-Type-Options': 'nosniff',
-		'X-Frame-Options': 'DENY',
-		'X-XSS-Protection': '1; mode=block',
+		'User-Agent': `${name}/${version} (+https://github.com/sefinek/geoip2-api)${process.env.JEST_WORKER_ID && devDependencies?.jest ? ` jest/${devDependencies.jest.replace(/^[^0-9]*/, '')}` : ''}`,
 	},
 };
 
+const getContent = url => new Promise((resolve, reject) => {
+	const req = get(url, httpOptions, res => {
+		if (res.statusCode !== 200) {
+			res.resume();
+			return reject(new Error(`Request failed with status code ${res.statusCode}`));
+		}
 
-async function getContent(url) {
-	const res = await new Promise((resolve, reject) => {
-		const req = get(url, httpOptions, resolve);
-		req.on('error', reject);
-		req.end();
-	});
+		res.setEncoding('utf8');
+		let rawData = '';
 
-	if (res.statusCode !== 200) {
-		throw new Error(`Request failed with status code ${res.statusCode}`);
-	}
+		res.on('data', chunk => {
+			rawData += chunk;
+		});
 
-	res.setEncoding('utf8');
-	let rawData = '';
-	for await (const chunk of res) {
-		rawData += chunk;
-	}
+		res.on('end', () => {
+			try {
+				resolve(JSON.parse(rawData));
+			} catch (err) {
+				reject(new Error(`Failed to parse JSON: ${err.message}`));
+			}
+		});
 
-	return JSON.parse(rawData);
-}
+		res.on('error', reject);
+	});
+
+	req.on('error', reject);
+	req.end();
+});
 
 class SefinekAPI {
 	constructor() {
-		Object.entries(endpoints).forEach(([key, endpoint]) => {
+		for (const [key, endpoint] of Object.entries(endpoints)) {
 			this[key] = () => getContent(`https://api.sefinek.net/api/v2/random/${endpoint}`);
-		});
+		}
 	}
 }
 
+const getRandomElement = arr => arr[Math.floor(Math.random() * arr.length)];
+
+const emojiGetters = {};
+for (const [key, value] of Object.entries(emojis)) {
+	emojiGetters[key] = () => getRandomElement(value);
+}
+
 module.exports = {
-	...Object.fromEntries(Object.entries(emojis).map(([key, value]) => [
-		key, () => value[Math.floor(Math.random() * value.length)],
-	])),
+	...emojiGetters,
 	Kaomojis: SefinekAPI,
 	version,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sefinek/random-emoji",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "A module offering a range of random emoticons, complete with their names and categories. Additionally, it also includes random kaomoji.",
   "keywords": [
     "random",
@@ -19,19 +19,44 @@
     "name",
     "type"
   ],
-  "homepage": "https://github.com/sefinek24/random-emoji#readme",
+  "homepage": "https://github.com/sefinek/random-emoji#readme",
   "bugs": {
-    "url": "https://github.com/sefinek24/random-emoji/issues"
+    "url": "https://github.com/sefinek/random-emoji/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/sefinek24/random-emoji.git"
+    "url": "git+https://github.com/sefinek/random-emoji.git"
   },
   "license": "MIT",
   "author": "Sefinek <contact@sefinek.net> (https://sefinek.net)",
+  "type": "commonjs",
   "main": "index.js",
-  "typings": "./index.d.ts",
+  "types": "index.d.ts",
+  "directories": {
+    "example": "example",
+    "test": "test"
+  },
+  "files": [
+    "data",
+    "example",
+    "AUTHORS",
+    "CHANGELOG.md",
+    "index.d.ts",
+    "index.js",
+    "LICENSE",
+    "README.md"
+  ],
   "scripts": {
-    "test": "node examples/main.js"
+    "m": "ncu -u && npm install && npm update",
+    "test": "jest test"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@jest/globals": "^30.4.1",
+    "globals": "^17.7.0",
+    "jest": "^30.4.2"
+  },
+  "allowScripts": {
+    "unrs-resolver@1.12.2": true
   }
 }

package/examples/table.js

@@ -1,53 +0,0 @@
-const random = require('../index.js'); // Change to @sefinek/random-emoji
-const data = [];
-
-async function displayEmojiData() {
-	// Get a single random Unicode emoji
-	data.push({ Function: 'unicode()', Emoji: random.unicode().trim() });
-
-	// Retrieves a random emoji, including its visual representation, name, and category
-	const emoji = random.emojis();
-	data.push({ Function: 'emojis()', Emoji: emoji.content.trim(), Name: emoji.name, Type: emoji.type });
-
-	// Get a random cat emoji
-	const cat = random.cats();
-	data.push({ Function: 'cats()', Emoji: cat.content.trim(), Name: cat.name });
-
-	// Get a random heart emoji
-	const heart = random.hearts();
-	data.push({ Function: 'hearts()', Emoji: heart.content.trim(), Name: heart.name });
-
-	// Retrieves a random food emoji
-	const food = random.foods();
-	data.push({ Function: 'foods()', Emoji: food.content.trim(), Name: food.name });
-
-	// Gets a random circle emoji
-	const circle = random.circles();
-	data.push({ Function: 'circles()', Emoji: circle.content.trim(), Name: circle.name });
-
-	// Gets a random squares emoji
-	const squares = random.squares();
-	data.push({ Function: 'squares()', Emoji: squares.content.trim(), Name: squares.name });
-
-
-	// Fetches random kaomojis
-	const kaomojis = new random.Kaomojis();
-	const kaoCat = await kaomojis.cat();
-	data.push({ Function: 'cat()', Emoji: kaoCat.message.trim(), Name: 'Cat face' });
-
-	const uwu = await kaomojis.uwu();
-	data.push({ Function: 'uwu()', Emoji: uwu.message.trim(), Name: 'UwU' });
-
-
-	// Displays the table
-	console.table(data);
-}
-
-try {
-	displayEmojiData().then(() => {
-		// Displays the current version of the module
-		console.log(`Module version: v${random.version}`);
-	});
-} catch (err) {
-	throw new Error(err);
-}