@sefinek/random-emoji 1.4.6 → 2.0.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Sefinek
+Copyright (c) 2022-2023 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

@@ -1,6 +1,6 @@
 <div align="center">
-    <h1>🐱 About this package 🙀</h1>
-    <p>Returns a random emoticons (name, type) and kaomojis.</p>
+    <h1>😻 About this package 😼</h1>
+    <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">
@@ -11,45 +11,50 @@
 </div>
 
 ## 📥 • Installation
-> **$** npm install @sefinek/random-emoji
+```bash
+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) |
+
 
 ## 😼 • Examples
 ```js
 const random = require('@sefinek/random-emoji');
 
-// 1. A single emote
+// 1. A single emoji
 console.log(random.unicode());
-// > 🥰
+// Output: 🥰
 
 // 2. Random emoji with name and type
 const emoji = random.emojis();
 console.log(`Name: ${emoji.name}; Emoji: ${emoji.content};`);
-// > Name: jack-o-lantern; Emoji: 🎃;
+// Output: Name: jack-o-lantern; Emoji: 🎃;
 
 // 3. Random cat
 const cat = random.cats();
 console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
-// > Name: smiley_cat; Emoji: 😺;
+// Output: Name: smiley_cat; Emoji: 😺;
 ```
 
-## 😻 • Usage
-| Function                                                                                                        | Description                                                |
-|-----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|
-| [unicode](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L3)   | A single emote                                             |
-| [emojis](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L6)    | Random emoji with name and type                            |
-| [cats](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L10)     | Return random cat                                          |
-| [hearts](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L14)   | Return random heart                                        |
-| [foods](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L18)    | Return random food                                         |
-| [circles](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L22)  | Return random circle                                       |
-| [kaomojis](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L26) | Return random kaomojis from [API](https://api.sefinek.net) |
-
-## ⛩️ • Kaomoji
+
+## ⛩️ • Kaomojis
 ### » Async/await example
 ```js
 const random = require('@sefinek/random-emoji');
 
 (async () => {
-    const kaomoji = new random.kaomojis();
+    const kaomoji = new random.Kaomojis();
 
     const uwu = await kaomoji.uwu();
     console.log(`Random UwU: ${uwu.message}`);
@@ -59,9 +64,11 @@ const random = require('@sefinek/random-emoji');
 ### » Promise example
 ```js
 const random = require('@sefinek/random-emoji');
-const kaomoji = new random.kaomojis();
+const kaomoji = new random.Kaomojis();
 
 kaomoji.love().then(data => console.log(data));
+// or shorter
+kaomoji.love().then(console.log);
 ```
 
 ### » The returned object from [API](https://api.sefinek.net)
@@ -75,20 +82,30 @@ kaomoji.love().then(data => console.log(data));
 }
 ```
 
+
 ### » Kaomoji endpoints
-| Function                                              | Example   |
-|-------------------------------------------------------|-----------|
-| [cat](https://api.sefinek.net/api/v1/kaomoji/cat)   | (=^-ω-^=) |
-| [dog](https://api.sefinek.net/api/v1/kaomoji/dog)   | ଘ(∪・ﻌ・∪)ଓ |
-| [owo](https://api.sefinek.net/api/v1/kaomoji/owo)   | 𝓞𝔀𝓞    |
-| [uwu](https://api.sefinek.net/api/v1/kaomoji/uwu)   | 𝕌𝕨𝕌    |
-| [love](https://api.sefinek.net/api/v1/kaomoji/love) | ヽ(♡‿♡)ノ   |
+| 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) | ヽ(♡‿♡)ノ   |
 
+    
 ## 📝 • Changelog
-> https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md
+> [Click here](CHANGELOG.md)
+
 
 ## 🤝 • Help
-Open new [Issue](https://github.com/sefinek24/random-emoji/issues/new/choose) on GitHub.  
+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
-Give a [star](https://github.com/sefinek24/random-emoji) if you can on GitHub page.
+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.

package/{test.js → example.js}

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

package/index.d.ts

@@ -1,14 +1,39 @@
-export function unicode(): string;
-export function emojis(): Object;
-export function cats(): Object;
-export function hearts(): Object;
-export function foods(): Object;
-export function circles(): Object;
-
-export class kaomojis {
-    cat();
-    dog();
-    owo();
-    uwu();
-    love();
-}
+declare module '@sefinek/random-emoji' {
+    // Unicode
+    export function unicode(): string;
+
+
+    // Random emojis
+    export interface Emoji {
+        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;
+
+
+    // Kaomojis
+    export interface ApiResponse {
+        success: boolean;
+        status: number;
+        info: {
+            category: string;
+            endpoint: string;
+        };
+        message: string;
+    }
+    export class Kaomojis {
+        cat(): Promise<ApiResponse>;
+        owo(): Promise<ApiResponse>;
+        uwu(): Promise<ApiResponse>;
+        love(): Promise<ApiResponse>;
+    }
+
+
+    // Other
+    export const version: string;
+}

package/index.js

@@ -1,3 +1,4 @@
+const { get } = require('node:https');
 const emojis = require('./data/emoji/random.json');
 const unicode = require('./data/emoji/unicode.json');
 const cats = require('./data/emoji/cat.json');
@@ -5,18 +6,51 @@ const hearts = require('./data/emoji/heart.json');
 const foods = require('./data/emoji/food.json');
 const circles = require('./data/emoji/circle.json');
 const endpoints = require('./data/endpoints.json');
-const { get } = require('node:https');
+const { name, version } = require('./package.json');
+
+/**
+ * Configuration options for HTTP requests.
+ * @type {Object}
+ */
+const options = {
+	method: 'GET',
+	port: 443,
+	headers: {
+		'User-Agent': `${name}/${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',
+		'Referrer-Policy': 'strict-origin-when-cross-origin',
+		'X-Content-Type-Options': 'nosniff',
+		'X-Frame-Options': 'DENY',
+		'X-XSS-Protection': '1; mode=block',
+	},
+};
 
+/**
+ * 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) => {
-		get(url, res => {
+		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);
+			res.on('data', (chunk) => {
+				rawData += chunk;
+			});
+
 			res.on('end', () => {
 				try {
 					resolve(JSON.parse(rawData));
@@ -24,24 +58,78 @@ function getContent(url) {
 					reject(err.message);
 				}
 			});
-		}).on('error', err => reject(err.message));
+		});
+
+		req.on('error', err => {
+			reject(err);
+		});
+
+		req.end();
 	});
 }
 
-class SkiffyAPI {
+/**
+ * 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]}`);
 		});
 	}
 }
 
 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)],
-	kaomojis: SkiffyAPI,
+
+	/**
+	 * Access various random content endpoints using the SefinekAPI class.
+	 */
+	Kaomojis: SefinekAPI,
+
+	/**
+	 * Get the module version.
+	 * @returns {string} - Returns the package version.
+	 */
+	version,
 };

package/package.json

@@ -1,37 +1,48 @@
-{
-  "name": "@sefinek/random-emoji",
-  "version": "1.4.6",
-  "description": "Returns a random emoticons (name, type) and kaomojis.",
-  "main": "index.js",
-  "scripts": {
-    "test": "node test.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sefinek24/random-emoji.git"
-  },
-  "keywords": [
-    "random",
-    "emoji",
-    "emojis",
-    "emoticon",
-    "unicode",
-    "cat",
-    "cats",
-    "heart",
-    "hearts",
-    "food",
-    "foods",
-    "circle",
-    "circles",
-    "name",
-    "type"
-  ],
-  "author": "Sefinek (https://sefinek.net)",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/sefinek24/random-emoji/issues"
-  },
-  "homepage": "https://github.com/sefinek24/random-emoji#readme",
-  "types": "./index.d.ts"
-}
+{
+  "name": "@sefinek/random-emoji",
+  "version": "2.0.3",
+  "description": "A module providing various random emoticons along with their names and types. Additionally, it also includes random kaomoji.",
+  "keywords": [
+    "random",
+    "emoji",
+    "emojis",
+    "emoticon",
+    "unicode",
+    "cat",
+    "cats",
+    "heart",
+    "hearts",
+    "food",
+    "foods",
+    "circle",
+    "circles",
+    "name",
+    "type"
+  ],
+  "homepage": "https://github.com/sefinek24/random-emoji#readme",
+  "bugs": {
+    "url": "https://github.com/sefinek24/random-emoji/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sefinek24/random-emoji.git"
+  },
+  "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"
+  ],
+  "scripts": {
+    "test": "node example.js"
+  }
+}

package/CHANGELOG.md

@@ -1,49 +0,0 @@
-## 📥・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.  
-2. Changes:
-```diff
-- emoji()
-+ emojis()
-```
-
-## 📥・v0.1.0 (07.05.2022)
-First release.

package/README_PL.md

@@ -1,94 +0,0 @@
-<div align="center">
-    <h1>🐱 O tym module 🙀</h1>
-    <p>Zwraca losowe emotikony (nazwa, typ) i kaomoji.</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="Liczba pobrań">
-        <img src="https://img.shields.io/github/issues/sefinek24/random-emoji" alt="Zgłoszone błędy">
-        <img src="https://img.shields.io/github/last-commit/sefinek24/random-emoji" alt="Ostatni commit">
-        <img src="https://img.shields.io/github/commit-activity/w/sefinek24/random-emoji" alt="Aktywność commitów">
-        <img src="https://img.shields.io/github/languages/code-size/sefinek24/random-emoji" alt="Rozmiar kodu">
-    </a>
-</div>
-
-## 📥 • Instalacja
-> **$** npm install @sefinek/random-emoji
-
-## 😼 • Przykłady
-```js
-const random = require('@sefinek/random-emoji');
-
-// 1. Podyńcza emotka
-console.log(random.unicode());
-// > 🥰
-
-// 2. Losowe emoji z nazwą i typem
-const emoji = random.emojis();
-console.log(`Nazwa: ${emoji.name}; Emoji: ${emoji.content};`);
-// > Nazwa: jack-o-lantern; Emoji: 🎃;
-
-// 3. Losowy kot
-const cat = random.cats();
-console.log(`Nazwa: ${cat.name}; Emoji: ${cat.content};`);
-// > Nazwa: smiley_cat; Emoji: 😺;
-```
-
-## 😻 • Użycie
-| Funkcja                                                                                                         | Opis                                                   |
-|-----------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
-| [unicode](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L3)   | Pojedyncza emotikona                                   |
-| [emojis](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L6)    | Losowe emoji z nazwą i typem                           |
-| [cats](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L10)     | Zwraca losowego kota                                   |
-| [hearts](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L14)   | Zwraca losowe serce                                    |
-| [foods](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L18)    | Zwraca losowe jedzenie                                 |
-| [circles](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L22)  | Zwraca losowe kółko                                    |
-| [kaomojis](https://github.com/sefinek24/random-emoji/blob/ab58b364710a4c7106721808e81ccdc7590c4965/test.js#L26) | Zwraca losowe kaomoji z [API](https://api.sefinek.net) |
-
-## ⛩️ • Kaomoji
-### » Przykład Async/await
-```js
-const random = require('@sefinek/random-emoji');
-
-(async () => {
-    const kaomoji = new random.kaomojis();
-
-    const uwu = await kaomoji.uwu();
-    console.log(`Random UwU: ${uwu.message}`);
-})();
-```
-
-### » Przykład obietnicy
-```js
-const random = require('@sefinek/random-emoji');
-const kaomoji = new random.kaomojis();
-
-kaomoji.love().then(data => console.log(data));
-```
-
-### » Zwrócony obiekt przez [API](https://api.sefinek.net)
-```json
-{
-  "success": true,
-  "status": 200,
-  "category": "kaomoji",
-  "endpoint": "uwu",
-  "message": "🅤🅦🅤"
-}
-```
-
-### » Punkty końcowe dla Kaomoji
-| Function                                            | Example   |
-|-----------------------------------------------------|-----------|
-| [cat](https://api.sefinek.net/api/v1/kaomoji/cat)   | (=^-ω-^=) |
-| [dog](https://api.sefinek.net/api/v1/kaomoji/dog)   | ଘ(∪・ﻌ・∪)ଓ |
-| [owo](https://api.sefinek.net/api/v1/kaomoji/owo)   | 𝓞𝔀𝓞    |
-| [uwu](https://api.sefinek.net/api/v1/kaomoji/uwu)   | 𝕌𝕨𝕌    |
-| [love](https://api.sefinek.net/api/v1/kaomoji/love) | ヽ(♡‿♡)ノ   |
-
-## 📝 • Lista zmian
-> https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md
-
-## 🤝 • Pomoc
-Otwórz nowy [Issue](https://github.com/sefinek24/random-emoji/issues/new/choose) na GitHubie.  
-  
-## ⭐ • Dzięki
-Daj [gwiazdkę](https://github.com/sefinek24/random-emoji), jeżeli możesz na stronie GitHub.