@sefinek/random-emoji 1.2.0 → 1.3.0

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 📥・v1.3.0 (13.05.2022)
+1. Updated README.md file.
+2. Added new function `new kaomojis()` with random kaomoji from my [API](https://api.skiffybot.pl). 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.

package/README.md

@@ -1,6 +1,6 @@
 <div align="center">
-    <h1>About this package</h1>
-    <p>Returns a random emoticon, its name and type. 🐱 🙀 ❤️</p>
+    <h1>🐱 About this package 🙀</h1>
+    <p>Returns a random emoticons (name, type) and 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">
@@ -44,18 +44,62 @@ console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
 ```
 
 ## 😻 • Usage
+| Function                                                                          | Description                                                  |
+|-----------------------------------------------------------------------------------|--------------------------------------------------------------|
+| [emojis](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis)           | Random emoji with name and type                              |
+| [unicode](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis)          | A single emote                                               |
+| [cats](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis)             | Return random cat                                            |
+| [hearts](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis)           | Return random heart                                          |
+| [circles](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis)          | Return random circle                                         |
+| [**new** kaomojis](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis) | Return random kaomojis from [API](https://api.skiffybot.xyz) |
+
+## ⛩️ • Kaomojis
+### » Async/await example
+```js
+const random = require('@sefinek/random-emoji');
+const kaomoji = new random.kaomojis();
+
+async function example() {
+    const uwu = await kaomoji.uwu();
+    console.log(uwu.message);
+}
+
+example(); // Execute function
+```
+
+### » Promise example
 ```js
-emojis()  // Random emoji with name and type
-unicode() // A single emote
-cats()    // Return random cat
-hearts()  // Return random heart
-circles() // Return random circle
+const random = require('@sefinek/random-emoji');
+const kaomoji = new random.kaomojis();
+
+kaomoji.love().then(data => console.log(data));
 ```
 
+### » The returned object from [API](https://api.skiffybot.xyz)
+```json
+{
+  "success": true,
+  "status": 200,
+  "category": "kaomoji",
+  "endpoint": "uwu",
+  "message": "🅤🅦🅤"
+}
+```
+
+### » Kaomoji endpoints
+| Function                                              | Example   |
+|-------------------------------------------------------|-----------|
+| [cat](https://api.skiffybot.xyz/api/v1/kaomoji/cat)   | (=^-ω-^=) |
+| [dog](https://api.skiffybot.xyz/api/v1/kaomoji/dog)   | ଘ(∪・ﻌ・∪)ଓ |
+| [owo](https://api.skiffybot.xyz/api/v1/kaomoji/owo)   | 𝓞𝔀𝓞    |
+| [uwu](https://api.skiffybot.xyz/api/v1/kaomoji/uwu)   | 𝕌𝕨𝕌    |
+| [love](https://api.skiffybot.xyz/api/v1/kaomoji/love) | ヽ(♡‿♡)ノ   |
+
 ## 📝 • Changelog
-> <a href="https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md" target="_blank" title="random-emoji/CHANGELOG.md at main · sefinek24/random-emoji">https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md</a>
+> https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md
 
 ## 🤝 • Help
-Open new <a href="https://github.com/sefinek24/random-emoji/issues/new/choose" target="_blank">Issue</a> on Github.  
+Open new [Issue](https://github.com/sefinek24/random-emoji/issues/new/choose) on GitHub.  
   
-### Thank you ❤️
+## ⭐ • Thank you
+Give a [star](https://github.com/sefinek24/random-emoji) if you can on GitHub page.

package/api/endpoints.json

@@ -0,0 +1 @@
+{"cat":"kaomoji/cat","dog":"kaomoji/dog","owo":"kaomoji/owo","uwu":"kaomoji/uwu","love":"kaomoji/love"}

package/index.js

@@ -3,9 +3,50 @@ const unicode = require('./json/unicode.json');
 const cats = require('./json/cats.json');
 const hearts = require('./json/hearts.json');
 const circles = require('./json/circles.json');
+const { get } = require('https');
+const { URL, URLSearchParams } = require('url');
+const endpoints = require('./api/endpoints.json');
 
-exports.emojis = () => emojis[Math.floor(Math.random() * emojis.length)];
-exports.unicode = () => unicode[Math.floor(Math.random() * unicode.length)];
-exports.cats = () => cats[Math.floor(Math.random() * cats.length)];
-exports.hearts = () => hearts[Math.floor(Math.random() * hearts.length)];
-exports.circles = () => circles[Math.floor(Math.random() * circles.length)];
+function getContent(url) {
+	return new Promise((resolve, reject) => {
+		get(url, res => {
+			const { statusCode } = res;
+			if (statusCode !== 200) {
+				res.resume();
+				reject(`Request failed with status code ${statusCode}.`);
+			}
+
+			res.setEncoding('utf8');
+			let rawData = '';
+			res.on('data', chunk => {rawData += chunk;});
+			res.on('end', () => {
+				try {
+					resolve(JSON.parse(rawData));
+				} catch (err) {
+					reject(err.message);
+				}
+			});
+		}).on('error', err => reject(err.message));
+	});
+}
+
+class SkiffyBOT {
+	constructor() {
+		Object.keys(endpoints).forEach(endpoint => {
+			this[endpoint] = async function(queryParams = '') {
+				const url = new URL(`https://api.skiffybot.xyz/api/v1/${endpoints[endpoint]}`);
+				queryParams !== '' ? url.search = new URLSearchParams(queryParams) : '';
+				return await getContent(url.toString());
+			};
+		});
+	}
+}
+
+module.exports = {
+	emojis: () => emojis[Math.floor(Math.random() * emojis.length)],
+	unicode: () => unicode[Math.floor(Math.random() * unicode.length)],
+	cats: () => cats[Math.floor(Math.random() * cats.length)],
+	hearts: () => hearts[Math.floor(Math.random() * hearts.length)],
+	circles: () => circles[Math.floor(Math.random() * circles.length)],
+	kaomojis: SkiffyBOT,
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sefinek/random-emoji",
-  "version": "1.2.0",
-  "description": "Returns a random emoticon, its name and type.",
+  "version": "1.3.0",
+  "description": "Returns a random emoticons (name, type) and kaomojis.",
   "main": "index.js",
   "scripts": {
     "test": "node test.js"

package/test.js

@@ -1,4 +1,4 @@
-const { unicode, emojis, cats, hearts, circles } = require('./index.js');
+const { unicode, emojis, cats, hearts, circles, kaomojis } = require('./index.js');
 
 // A single emote
 console.log(unicode());
@@ -17,4 +17,14 @@ console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
 
 // Random circles
 const circle = circles();
-console.log(`Name: ${circle.name}; Emoji: ${circle.content};`);
+console.log(`Name: ${circle.name}; Emoji: ${circle.content};`);
+
+// Random kaomoji
+(async () => {
+	const kaomoji = new kaomojis();
+	const kaoCat = await kaomoji.cat();
+	console.log(`Cat face: ${kaoCat.message}`);
+
+	const uwu = await kaomoji.uwu();
+	console.log(`Random UwU: ${uwu.message}`);
+})();