@sefinek/random-emoji 1.0.1 → 1.3.0

package/CHANGELOG.md

@@ -1,11 +1,24 @@
-## 📥・Version v1.0.1 (STABLE)
-**1.** Added new function `cats()` with random cat emojis.  
-**2.** Added **CHANGELOG.md** file.  
-**2.** Changes:
+## 📥・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.
+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()
 ```
 
-## 📥・Version v0.1.0
+## 📥・v0.1.0 (07.05.2022)
 First release.

package/README.md

@@ -1,47 +1,105 @@
-## ⭐ • Information
-<p>Returns a random emoticon and its name and type. 🐈 🐱 🙀</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="npm 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/tokei/lines/github/sefinek24/random-emoji" alt="Total lines">
-</a>
-
-## 📥 • How to install?
+<div align="center">
+    <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">
+        <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/tokei/lines/github/sefinek24/random-emoji" alt="Total lines">
+    </a>
+</div>
+
+## 📥 • Installation
 > **$** npm install @sefinek/random-emoji
 
 ## 😼 • Examples
 ```js
 const random = require('@sefinek/random-emoji');
 
-// 1. Random emoji with name and type
+// 1. A single emote
+console.log(unicode());
+// > 🥰
+
+// 2. Random emoji with name and type
 const emoji = random.emojis();
-console.log(`Name: ${emoji.name}; Type: ${emoji.type}; Emoji: ${emoji.content};`);
-// Output » Name: Cat Face; Type: animal; Emoji: 🐱;
+console.log(`Name: ${emoji.name}; Emoji: ${emoji.content};`);
+// > Name: Cat Face; Type: animal; Emoji: 🐱;
 
-// 2. A single emote
-console.log(unicode());
-// Output » 🥰
+// 3. Random cat
+const cat = random.cats();
+console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
+// > Name: smiley_cat; Emoji: 😺;
+
+// 4. Random heart
+const heart = random.hearts();
+console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
+// > Name: blue_heart; Emoji: 💙;
 
-// 3. Random cats
-const cat = cats();
-console.log(`Name: ${cat.name}; Slashes: ${cat.slashes}; Emoji: ${cat.content};`);
-// Output » Name: smiley_cat; Slashes: \\😺; Emoji: 😺;
+// 5. Random circle
+const circle = random.circles();
+console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
+// > Name: blue_circle; Emoji: 🔵;
 ```
 
-## 😻 • Functions list
+## 😻 • 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
-emojis()  // Random emoji with name and type
-unicode() // A single emote
-cats()    // Return random cats
+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
+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">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

@@ -1,7 +1,52 @@
 const emojis = require('./json/emojis.json');
 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)];
+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/json/cats.json

@@ -1 +1 @@
-[{"content":"😺","slashes":"\\😺","name":"smiley_cat"},{"content":"😸","slashes":"\\😸","name":"smile_cat"},{"content":"😹","slashes":"\\😹","name":"joy_cat"},{"content":"😻","slashes":"\\😻","name":"heart_eyes_cat"},{"content":"😼","slashes":"\\😼","name":"smirk_cat"},{"content":"😽","slashes":"\\😽","name":"kissing_cat"},{"content":"🙀","slashes":"\\🙀","name":"scream_cat"},{"content":"😿","slashes":"\\😿","name":"crying_cat_face"},{"content":"😾","slashes":"\\😾","name":"pouting_cat"},{"content":"🐱","slashes":"\\🐱","name":"cat"},{"content":"🐈","slashes":"\\🐈","name":"cat2"},{"content":"🐈‍⬛","slashes":"\\🐈‍⬛","name":"black_cat"}]
+[{"content":"😺","name":"smiley_cat"},{"content":"😸","name":"smile_cat"},{"content":"😹","name":"joy_cat"},{"content":"😻","name":"heart_eyes_cat"},{"content":"😼","name":"smirk_cat"},{"content":"😽","name":"kissing_cat"},{"content":"🙀","name":"scream_cat"},{"content":"😿","name":"crying_cat_face"},{"content":"😾","name":"pouting_cat"},{"content":"🐱","name":"cat"},{"content":"🐈","name":"cat2"},{"content":"🐈‍⬛","name":"black_cat"}]

package/json/circles.json

@@ -0,0 +1 @@
+[{"content":"🔴","name":"red_circle"},{"content":"🟠","name":"orange_circle"},{"content":"🟡","name":"yellow_circle"},{"content":"🟢","name":"green_circle"},{"content":"🔵","name":"blue_circle"},{"content":"🟣","name":"purple_circle"},{"content":"🟤","name":"brown_circle"},{"content":"⚫","name":"black_circle"},{"content":"⚪","name":"white_circle"}]

package/json/hearts.json

@@ -0,0 +1 @@
+[{"content":"💌","name":"love_letter"},{"content":"💝","name":"gift_heart"},{"content":"❣️","name":"heart_exclamation"},{"content":"💔","name":"broken_heart"},{"content":"❤️‍🔥","name":"heart_on_fire"},{"content":"❤️‍🩹","name":"mending_heart"},{"content":"❤️","name":"heart"},{"content":"💛","name":"yellow_heart"},{"content":"💚","name":"green_heart"},{"content":"💙","name":"blue_heart"},{"content":"💜","name":"purple_heart"},{"content":"🤎","name":"brown_heart"},{"content":"🖤","name":"black_heart"},{"content":"🤍","name":"white_heart"},{"content":"🫀","name":"anatomical_heart"},{"content":"💒","name":"wedding"},{"content":"💘","name":"cupid"},{"content":"💗","name":"heartpulse"}]

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sefinek/random-emoji",
-  "version": "1.0.1",
-  "description": "Returns a random emoticon and 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"
@@ -13,14 +13,19 @@
   "keywords": [
     "random",
     "emoji",
+    "emojis",
     "emoticon",
     "unicode",
-    "cats",
     "cat",
+    "cats",
+    "heart",
+    "hearts",
+    "circle",
+    "circles",
     "name",
     "type"
   ],
-  "author": "Sefinek",
+  "author": "Sefinek (https://skiffybot.xyz)",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/sefinek24/random-emoji/issues"

package/test.js

@@ -1,12 +1,30 @@
-const { emojis, unicode, cats } = require('./index.js');
-
-// Random emoji with name and type
-const emoji = emojis();
-console.log(`Name: ${emoji.name}; Type: ${emoji.type}; Emoji: ${emoji.content};`);
+const { unicode, emojis, cats, hearts, circles, kaomojis } = require('./index.js');
 
 // A single emote
 console.log(unicode());
 
+// Random emoji with name and type
+const emoji = emojis();
+console.log(`Name: ${emoji.name}; Emoji: ${emoji.content};`);
+
 // Random cats
 const cat = cats();
-console.log(`Name: ${cat.name}; Slashes: ${cat.slashes}; Emoji: ${cat.content};`);
+console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
+
+// Random hearts
+const heart = hearts();
+console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
+
+// Random circles
+const circle = circles();
+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}`);
+})();