@sefinek/random-emoji 2.0.4 → 2.1.0

package/CHANGELOG.md

@@ -0,0 +1,88 @@
+## 📥・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.
+
+### ✨ 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.
+
+
+## 📥・v2.0.2/v2.0.3 (08.11.2023)
+
+### 🎉 Added
+1. `<random>.version`
+
+### ✨ Changes
+1. Removed `README_PL.md`.
+2. Updated add added new types to `index.d.ts` file.
+3. Now this module uses only native module (like `https`).
+4. Added new headers for better safety etc.
+
+### 🌠 Migration
+1. Changed `new random.kaomojis()` to `new random.Kaomojis()`.
+
+
+## 📥・v1.4.6 (11.03.2023)
+1. Updated to **v2** release of API.
+
+
+## 📥・v1.4.5 (09.10.2022)
+1. Fixed URLs.
+
+
+## 📥・v1.4.4 (02.10.2022)
+1. Fixed URLs.
+
+
+## 📥・v1.4.3 (19.09.2022)
+1. Small changes in `index.d.ts` etc.
+
+
+## 📥・v1.4.2 (05.06.2022)
+1. Added typings.
+2. Small fixes in `README.md` and `README_PL.md`.
+
+
+## 📥・v1.4.1 (02.06.2022)
+1. Small changes.
+
+
+## 📥・v1.4.0 (15.05.2022)
+1. Added new function `foods()` with random foods.
+2. Fixes in `new kaomojis()`.
+3. Small fixes in README.md.
+4. Added Poland version of README.md file.
+
+
+## 📥・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.
+
+
+## 📥・v1.2.0 (12.05.2022)
+1. Updated CHANGELOG.md, README.md and package.json.
+2. Added new function `circles()` with random circles.
+3. Removed `.slashes`.
+
+
+## 📥・v1.1.1 (11.05.2022)
+1. Added new function `hearts()` with random hearts.
+
+
+## 📥・v1.0.1 (08.05.2022)
+1. Added new function `cats()` with random cat emojis.
+2. Added **CHANGELOG.md** file.
+3. Changes:
+    ```diff
+    - emoji()
+    + emojis()
+    ```
+
+
+## 📥・v0.1.0 (07.05.2022)
+First release.

package/README.md

@@ -17,15 +17,15 @@ npm install @sefinek/random-emoji
 
 
 ## 😻 • Usage
-| Function                                                                                                                   | Description                                                |
-|----------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|
-| [unicode](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L4)           | A single emoji                                             |
-| [emojis](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L7)            | Random emoji with name and type                            |
-| [cats](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L11)             | Return random cat                                          |
-| [hearts](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L14)           | Return random heart                                        |
-| [foods](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L18)            | Return random food                                         |
-| [circles](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L22)          | Return random circle                                       |
-| [**new** Kaomojis](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L28) | Return random kaomojis from [API](https://api.sefinek.net) |
+| 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) |
 
 
 ## 😼 • Examples
@@ -33,18 +33,17 @@ npm install @sefinek/random-emoji
 const random = require('@sefinek/random-emoji');
 
 // 1. A single emoji
-console.log(random.unicode());
-// Output: 🥰
+console.log(random.unicode()); // 🥰
 
-// 2. Random emoji with name and type
+// 2. Random emoji along with its visual representation, name, and category
 const emoji = random.emojis();
-console.log(`Name: ${emoji.name}; Emoji: ${emoji.content};`);
-// Output: Name: jack-o-lantern; Emoji: 🎃;
+console.log(`Emoji: ${emoji.content}; Name: ${emoji.name}; Type: ${emoji.type}`);
+// Emoji: 🐶; Name: Dog Face; Type: animal
 
 // 3. Random cat
 const cat = random.cats();
-console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
-// Output: Name: smiley_cat; Emoji: 😺;
+console.log(`Emoji: ${cat.content}; Name: ${cat.name}`);
+// Emoji: 😺; Name: smiley_cat
 ```
 
 
@@ -57,7 +56,7 @@ const random = require('@sefinek/random-emoji');
     const kaomoji = new random.Kaomojis();
 
     const uwu = await kaomoji.uwu();
-    console.log(`Random UwU: ${uwu.message}`);
+    console.log('Random UwU:', uwu.message);
 })();
 ```
 
@@ -66,9 +65,9 @@ const random = require('@sefinek/random-emoji');
 const random = require('@sefinek/random-emoji');
 const kaomoji = new random.Kaomojis();
 
-kaomoji.love().then(data => console.log(data));
+kaomoji.uwu().then(data => console.log(data));
 // or shorter
-kaomoji.love().then(console.log);
+kaomoji.uwu().then(console.log);
 ```
 
 ### » The returned object from [API](https://api.sefinek.net)
@@ -76,21 +75,23 @@ kaomoji.love().then(console.log);
 {
   "success": true,
   "status": 200,
-  "category": "kaomoji",
-  "endpoint": "uwu",
-  "message": "🅤🅦🅤"
+  "info": {
+    "category": "kaomoji",
+    "endpoint": "uwu"
+  },
+  "message": "ＵｗＵ"
 }
 ```
 
 
-### » Kaomoji endpoints
-| Function                                            | Example   |
-|-----------------------------------------------------|-----------|
-| [cat](https://api.sefinek.net/api/v2/kaomoji/cat)   | (=^-ω-^=) |
-| [dog](https://api.sefinek.net/api/v2/kaomoji/dog)   | ଘ(∪・ﻌ・∪)ଓ |
-| [owo](https://api.sefinek.net/api/v2/kaomoji/owo)   | 𝓞𝔀𝓞    |
-| [uwu](https://api.sefinek.net/api/v2/kaomoji/uwu)   | 𝕌𝕨𝕌    |
-| [love](https://api.sefinek.net/api/v2/kaomoji/love) | ヽ(♡‿♡)ノ   |
+### <div id="kaomoji-endpoints">» Kaomoji endpoints</div>
+| Function | Link to the API                                           | Version | Example   |
+|----------|:----------------------------------------------------------|:--------|-----------|
+| `cat()`  | [Click here](https://api.sefinek.net/api/v2/kaomoji/cat)  | v2      | (=^-ω-^=) |
+| `dog()`  | [Click here](https://api.sefinek.net/api/v2/kaomoji/dog)  | v2      | ଘ(∪・ﻌ・∪)ଓ |
+| `owo()`  | [Click here](https://api.sefinek.net/api/v2/kaomoji/owo)  | v2      | 𝓞𝔀𝓞    |
+| `uwu()`  | [Click here](https://api.sefinek.net/api/v2/kaomoji/uwu)  | v2      | 𝕌𝕨𝕌    |
+| `love()` | [Click here](https://api.sefinek.net/api/v2/kaomoji/love) | v2      | ヽ(♡‿♡)ノ   |
 
     
 ## 📝 • Changelog

package/data/emoji/square.json

@@ -0,0 +1 @@
+[{"content":"🟥","name":"red_square"},{"content":"🟧","name":"orange_square"},{"content":"🟨","name":"yellow_square"},{"content":"🟩","name":"green_square"},{"content":"🟦","name":"blue_square"},{"content":"🟪","name":"purple_square"},{"content":"🟫","name":"brown_square"},{"content":"⬛","name":"black_large_square"},{"content":"⬜","name":"white_large_square"}]

package/examples/main.js

@@ -0,0 +1,44 @@
+const random = require('../index.js'); // Change to @sefinek/random-emoji
+
+// Get a single random Unicode emoji.
+console.log(`Single Emoji     : ${random.unicode()}`);
+
+// Retrieves a random emoji with its name, visual representation, and type
+const emoji = random.emojis();
+console.log(`Random Emoji     : ${emoji.content}; ${emoji.name}; ${emoji.type}`);
+
+// Get a random cat emoji
+const cat = random.cats();
+console.log(`Cat Emoji        : ${cat.content}; ${cat.name}`);
+
+// Get a random heart emoji
+const heart = random.hearts();
+console.log(`Heart Emoji      : ${heart.content}; ${heart.name}`);
+
+// Retrieves a random food emoji
+const food = random.foods();
+console.log(`Food Emoji       : ${food.content}; ${food.name}`);
+
+// Gets a random circle emoji
+const circle = random.circles();
+console.log(`Circle Emoji     : ${circle.content}; ${circle.name}`);
+
+// Gets a random squares emoji
+const squares = random.squares();
+console.log(`Square Emoji     : ${squares.content}; ${squares.name}`);
+
+// Fetches and displays random kaomojis using async/await syntax
+(async () => {
+	const kaomojis = new random.Kaomojis();
+
+	// Retrieves and displays a cat face kaomoji
+	const kaoCat = await kaomojis.cat();
+	console.log(`Kaomoji Cat Face : ${kaoCat.message}`);
+
+	// Fetches and displays a random UwU kaomoji
+	const uwu = await kaomojis.uwu();
+	console.log(`Kaomoji UwU      : ${uwu.message}`);
+})();
+
+// Displays the current version of the module
+console.log(`Module version   : v${random.version}`);

package/examples/table.js

@@ -0,0 +1,53 @@
+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);
+}

package/index.d.ts

@@ -1,22 +1,71 @@
 declare module '@sefinek/random-emoji' {
-    // Unicode
-    export function unicode(): string;
-
-
-    // Random emojis
-    export interface 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;
     }
-    export function emojis(): Emoji;
-    export function cats(): Emoji;
-    export function hearts(): Emoji;
-    export function foods(): Emoji;
-    export function circles(): Emoji;
 
+    /**
+     * 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;
 
-    // Kaomojis
+    /**
+     * 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;
@@ -26,14 +75,24 @@ declare module '@sefinek/random-emoji' {
         };
         message: string;
     }
+
+    /**
+     * Kaomojis class for accessing various random content endpoints.
+     * Allows fetching of random kaomojis from specified endpoints.
+     */
     export class Kaomojis {
-        cat(): Promise<ApiResponse>;
-        owo(): Promise<ApiResponse>;
-        uwu(): Promise<ApiResponse>;
-        love(): Promise<ApiResponse>;
-    }
+        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>;
+    }
 
-    // Other
+    /**
+     * The current version of the module.
+     */
     export const version: string;
-}
+}

package/index.js

@@ -1,26 +1,22 @@
 const { get } = require('https');
-const emojis = require('./data/emoji/random.json');
-const unicode = require('./data/emoji/unicode.json');
-const cats = require('./data/emoji/cat.json');
-const hearts = require('./data/emoji/heart.json');
-const foods = require('./data/emoji/food.json');
-const circles = require('./data/emoji/circle.json');
+const emojis = {
+	emojis: require('./data/emoji/collection/big.json'),
+	cats: require('./data/emoji/cat.json'),
+	foods: require('./data/emoji/food.json'),
+	hearts: require('./data/emoji/heart.json'),
+	circles: require('./data/emoji/circle.json'),
+	squares: require('./data/emoji/square.json'),
+	unicode: require('./data/emoji/collection/single.json'),
+};
 const endpoints = require('./data/endpoints.json');
 const { version } = require('./package.json');
 
-/**
- * Configuration options for HTTP requests.
- * @type {Object}
- */
-const options = {
+const httpOptions = {
 	method: 'GET',
-	port: 443,
 	headers: {
-		'User-Agent': `random-emoji/${version} (+https://github.com/sefinek24/random-emoji)`,
+		'User-Agent': `Mozilla/5.0 (compatible; random-emoji/${version}; +https://github.com/sefinek24/random-emoji)`,
 		'Accept': 'application/json',
 		'Cache-Control': 'no-cache',
-		'CF-IPCountry': 'false',
-		'CF-Visitor': '{"scheme":"https"}',
 		'Connection': 'keep-alive',
 		'DNT': '1',
 		'Pragma': 'no-cache',
@@ -31,105 +27,39 @@ const options = {
 	},
 };
 
-/**
- * Fetch content from a given URL using HTTP GET.
- * @param {string} url - The URL to fetch content from.
- * @returns {Promise} - A Promise that resolves with the fetched JSON data or rejects with an error.
- */
-function getContent(url) {
-	return new Promise((resolve, reject) => {
-		const req = get(url, options, res => {
-			if (res.statusCode !== 200) {
-				reject(`Request failed with status code ${res.statusCode}.`);
-				return;
-			}
-
-			res.setEncoding('utf8');
 
-			let rawData = '';
-			res.on('data', chunk => {
-				rawData += chunk;
-			});
+async function getContent(url) {
+	const res = await new Promise((resolve, reject) => {
+		const req = get(url, httpOptions, resolve);
+		req.on('error', reject);
+		req.end();
+	});
 
-			res.on('end', () => {
-				try {
-					resolve(JSON.parse(rawData));
-				} catch (err) {
-					reject(err.message);
-				}
-			});
-		});
+	if (res.statusCode !== 200) {
+		throw new Error(`Request failed with status code ${res.statusCode}`);
+	}
 
-		req.on('error', err => {
-			reject(err);
-		});
+	res.setEncoding('utf8');
+	let rawData = '';
+	for await (const chunk of res) {
+		rawData += chunk;
+	}
 
-		req.end();
-	});
+	return JSON.parse(rawData);
 }
 
-/**
- * SefinekAPI class for accessing various random content endpoints.
- * @class
- */
 class SefinekAPI {
 	constructor() {
-		Object.keys(endpoints).forEach(endpoint => {
-			/**
-			 * Access a specific random content endpoint.
-			 * @method
-			 * @returns {Promise} - A Promise that resolves with the fetched content or rejects with an error.
-			 */
-			this[endpoint] = () => getContent(`https://api.sefinek.net/api/v2/random/${endpoints[endpoint]}`);
+		Object.entries(endpoints).forEach(([key, endpoint]) => {
+			this[key] = () => getContent(`https://api.sefinek.net/api/v2/random/${endpoint}`);
 		});
 	}
 }
 
 module.exports = {
-	/**
-	 * Get a random Unicode emoji.
-	 * @returns {string} - A random Unicode emoji.
-	 */
-	unicode: () => unicode[Math.floor(Math.random() * unicode.length)],
-
-	/**
-	 * Get a random emoji.
-	 * @returns {object} - A random emoji.
-	 */
-	emojis: () => emojis[Math.floor(Math.random() * emojis.length)],
-
-	/**
-	 * Get a random cat emoji.
-	 * @returns {object} - A random cat emoji.
-	 */
-	cats: () => cats[Math.floor(Math.random() * cats.length)],
-
-	/**
-	 * Get a random heart emoji.
-	 * @returns {object} - A random heart emoji.
-	 */
-	hearts: () => hearts[Math.floor(Math.random() * hearts.length)],
-
-	/**
-	 * Get a random food emoji.
-	 * @returns {object} - A random food emoji.
-	 */
-	foods: () => foods[Math.floor(Math.random() * foods.length)],
-
-	/**
-	 * Get a random circle emoji.
-	 * @returns {object} - A random circle emoji.
-	 */
-	circles: () => circles[Math.floor(Math.random() * circles.length)],
-
-	/**
-	 * Access various random content endpoints using the SefinekAPI class.
-	 */
+	...Object.fromEntries(Object.entries(emojis).map(([key, value]) => [
+		key, () => value[Math.floor(Math.random() * value.length)],
+	])),
 	Kaomojis: SefinekAPI,
-
-	/**
-	 * Get the module version.
-	 * @returns {string} - Returns the package version.
-	 */
 	version,
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sefinek/random-emoji",
-  "version": "2.0.4",
-  "description": "A module providing various random emoticons along with their names and types. Additionally, it also includes random kaomoji.",
+  "version": "2.1.0",
+  "description": "A module offering a range of random emoticons, complete with their names and categories. Additionally, it also includes random kaomoji.",
   "keywords": [
     "random",
     "emoji",
@@ -30,19 +30,8 @@
   "license": "MIT",
   "author": "Sefinek <contact@sefinek.net> (https://sefinek.net)",
   "main": "index.js",
-  "types": "./index.d.ts",
-  "directories": {
-    "data": "data"
-  },
-  "files": [
-    "data/",
-    "example.js",
-    "index.d.ts",
-    "index.js",
-    "LICENSE",
-    "README.md"
-  ],
+  "typings": "./index.d.ts",
   "scripts": {
-    "test": "node example.js"
+    "test": "node examples/main.js"
   }
 }

package/example.js

@@ -1,38 +0,0 @@
-const random = require('./index.js'); // Change to @sefinek/random-emoji
-
-// A single emoji
-console.log(random.unicode());
-
-// Random emoji with name and type
-const emoji = random.emojis();
-console.log(`Name: ${emoji.name}; Emoji: ${emoji.content};`);
-
-// Random cat
-const cat = random.cats();
-console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
-
-// Random heart
-const heart = random.hearts();
-console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
-
-// Random food
-const food = random.foods();
-console.log(`Name: ${food.name}; Emoji: ${food.content};`);
-
-// Random circle
-const circle = random.circles();
-console.log(`Name: ${circle.name}; Emoji: ${circle.content};`);
-
-// Random kaomoji
-(async () => {
-	const kaomojis = new random.Kaomojis();
-
-	const kaoCat = await kaomojis.cat();
-	console.log(`Cat face: ${kaoCat.message}`);
-
-	const uwu = await kaomojis.uwu();
-	console.log(`Random UwU: ${uwu.message}`);
-})();
-
-// Version
-console.log(`Module version: ${random.version}`);